Class: DatadogAPIClient::V2::FeatureFlagsAPI

Inherits:
Object
  • Object
show all
Defined in:
lib/datadog_api_client/v2/api/feature_flags_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = DatadogAPIClient::APIClient.default) ⇒ FeatureFlagsAPI

Returns a new instance of FeatureFlagsAPI.



22
23
24
 
# File 'lib/datadog_api_client/v2/api/feature_flags_api.rb', line 22

def initialize(api_client = DatadogAPIClient::APIClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



20
21
22
 
# File 'lib/datadog_api_client/v2/api/feature_flags_api.rb', line 20

def api_client
  @api_client
end

Instance Method Details

#archive_feature_flag(feature_flag_id, opts = {}) ⇒ Object

Archive a feature flag.

See Also:



29
30
31
32
 
# File 'lib/datadog_api_client/v2/api/feature_flags_api.rb', line 29

def archive_feature_flag(feature_flag_id, opts = {})
  data, _status_code, _headers = archive_feature_flag_with_http_info(feature_flag_id, opts)
  data
end

#archive_feature_flag_with_http_info(feature_flag_id, opts = {}) ⇒ Array<(FeatureFlagResponse, Integer, Hash)>

Archive a feature flag.

Archives a feature flag. Archived flags are hidden from the main list but remain accessible and can be unarchived.

Parameters:

  • feature_flag_id (UUID) —

    The ID of the feature flag.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(FeatureFlagResponse, Integer, Hash)>) —

    FeatureFlagResponse data, response status code and response headers



42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/datadog_api_client/v2/api/feature_flags_api.rb', line 42

def archive_feature_flag_with_http_info(feature_flag_id, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FeatureFlagsAPI.archive_feature_flag ...'
  end
  # verify the required parameter 'feature_flag_id' is set
  if @api_client.config.client_side_validation && feature_flag_id.nil?
    fail ArgumentError, "Missing the required parameter 'feature_flag_id' when calling FeatureFlagsAPI.archive_feature_flag"
  end
  # resource path
  local_var_path = '/api/v2/feature-flags/{feature_flag_id}/archive'.sub('{feature_flag_id}', CGI.escape(feature_flag_id.to_s).gsub('%2F', '/'))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'FeatureFlagResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]

  new_options = opts.merge(
    :operation => :archive_feature_flag,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Post, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FeatureFlagsAPI#archive_feature_flag\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_feature_flag(body, opts = {}) ⇒ Object

Create a feature flag.

See Also:



95
96
97
98
 
# File 'lib/datadog_api_client/v2/api/feature_flags_api.rb', line 95

def create_feature_flag(body, opts = {})
  data, _status_code, _headers = create_feature_flag_with_http_info(body, opts)
  data
end

#create_feature_flag_with_http_info(body, opts = {}) ⇒ Array<(FeatureFlagResponse, Integer, Hash)>

Create a feature flag.

Creates a new feature flag with variants.

Parameters:

Returns:

  • (Array<(FeatureFlagResponse, Integer, Hash)>) —

    FeatureFlagResponse data, response status code and response headers



107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/datadog_api_client/v2/api/feature_flags_api.rb', line 107

def create_feature_flag_with_http_info(body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FeatureFlagsAPI.create_feature_flag ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling FeatureFlagsAPI.create_feature_flag"
  end
  # resource path
  local_var_path = '/api/v2/feature-flags'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)

  # return_type
  return_type = opts[:debug_return_type] || 'FeatureFlagResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]

  new_options = opts.merge(
    :operation => :create_feature_flag,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Post, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FeatureFlagsAPI#create_feature_flag\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_feature_flags_environment(body, opts = {}) ⇒ Object

Create an environment.

See Also:



162
163
164
165
 
# File 'lib/datadog_api_client/v2/api/feature_flags_api.rb', line 162

def create_feature_flags_environment(body, opts = {})
  data, _status_code, _headers = create_feature_flags_environment_with_http_info(body, opts)
  data
end

#create_feature_flags_environment_with_http_info(body, opts = {}) ⇒ Array<(EnvironmentResponse, Integer, Hash)>

Create an environment.

Creates a new environment for organizing feature flags.

Parameters:

Returns:

  • (Array<(EnvironmentResponse, Integer, Hash)>) —

    EnvironmentResponse data, response status code and response headers



174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
 
# File 'lib/datadog_api_client/v2/api/feature_flags_api.rb', line 174

def create_feature_flags_environment_with_http_info(body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FeatureFlagsAPI.create_feature_flags_environment ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling FeatureFlagsAPI.create_feature_flags_environment"
  end
  # resource path
  local_var_path = '/api/v2/feature-flags/environments'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)

  # return_type
  return_type = opts[:debug_return_type] || 'EnvironmentResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]

  new_options = opts.merge(
    :operation => :create_feature_flags_environment,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Post, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FeatureFlagsAPI#create_feature_flags_environment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_feature_flags_environment(environment_id, opts = {}) ⇒ Object

Delete an environment.

See Also:



229
230
231
232
 
# File 'lib/datadog_api_client/v2/api/feature_flags_api.rb', line 229

def delete_feature_flags_environment(environment_id, opts = {})
  delete_feature_flags_environment_with_http_info(environment_id, opts)
  nil
end

#delete_feature_flags_environment_with_http_info(environment_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete an environment.

Deletes an environment. This operation cannot be undone.

Parameters:

  • environment_id (UUID) —

    The ID of the environment.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
 
# File 'lib/datadog_api_client/v2/api/feature_flags_api.rb', line 241

def delete_feature_flags_environment_with_http_info(environment_id, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FeatureFlagsAPI.delete_feature_flags_environment ...'
  end
  # verify the required parameter 'environment_id' is set
  if @api_client.config.client_side_validation && environment_id.nil?
    fail ArgumentError, "Missing the required parameter 'environment_id' when calling FeatureFlagsAPI.delete_feature_flags_environment"
  end
  # resource path
  local_var_path = '/api/v2/feature-flags/environments/{environment_id}'.sub('{environment_id}', CGI.escape(environment_id.to_s).gsub('%2F', '/'))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]

  new_options = opts.merge(
    :operation => :delete_feature_flags_environment,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Delete, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FeatureFlagsAPI#delete_feature_flags_environment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#disable_feature_flag_environment(feature_flag_id, environment_id, opts = {}) ⇒ Object

Disable a feature flag in an environment.

See Also:



294
295
296
297
 
# File 'lib/datadog_api_client/v2/api/feature_flags_api.rb', line 294

def disable_feature_flag_environment(feature_flag_id, environment_id, opts = {})
  disable_feature_flag_environment_with_http_info(feature_flag_id, environment_id, opts)
  nil
end

#disable_feature_flag_environment_with_http_info(feature_flag_id, environment_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Disable a feature flag in an environment.

Disable a feature flag in a specific environment.

Parameters:

  • feature_flag_id (UUID) —

    The ID of the feature flag.

  • environment_id (UUID) —

    The ID of the environment.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
 
# File 'lib/datadog_api_client/v2/api/feature_flags_api.rb', line 307

def disable_feature_flag_environment_with_http_info(feature_flag_id, environment_id, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FeatureFlagsAPI.disable_feature_flag_environment ...'
  end
  # verify the required parameter 'feature_flag_id' is set
  if @api_client.config.client_side_validation && feature_flag_id.nil?
    fail ArgumentError, "Missing the required parameter 'feature_flag_id' when calling FeatureFlagsAPI.disable_feature_flag_environment"
  end
  # verify the required parameter 'environment_id' is set
  if @api_client.config.client_side_validation && environment_id.nil?
    fail ArgumentError, "Missing the required parameter 'environment_id' when calling FeatureFlagsAPI.disable_feature_flag_environment"
  end
  # resource path
  local_var_path = '/api/v2/feature-flags/{feature_flag_id}/environments/{environment_id}/disable'.sub('{feature_flag_id}', CGI.escape(feature_flag_id.to_s).gsub('%2F', '/')).sub('{environment_id}', CGI.escape(environment_id.to_s).gsub('%2F', '/'))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]

  new_options = opts.merge(
    :operation => :disable_feature_flag_environment,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Post, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FeatureFlagsAPI#disable_feature_flag_environment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#enable_feature_flag_environment(feature_flag_id, environment_id, opts = {}) ⇒ Object

Enable a feature flag in an environment.

See Also:



364
365
366
367
 
# File 'lib/datadog_api_client/v2/api/feature_flags_api.rb', line 364

def enable_feature_flag_environment(feature_flag_id, environment_id, opts = {})
  enable_feature_flag_environment_with_http_info(feature_flag_id, environment_id, opts)
  nil
end

#enable_feature_flag_environment_with_http_info(feature_flag_id, environment_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Enable a feature flag in an environment.

Enable a feature flag in a specific environment.

Parameters:

  • feature_flag_id (UUID) —

    The ID of the feature flag.

  • environment_id (UUID) —

    The ID of the environment.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
 
# File 'lib/datadog_api_client/v2/api/feature_flags_api.rb', line 377

def enable_feature_flag_environment_with_http_info(feature_flag_id, environment_id, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FeatureFlagsAPI.enable_feature_flag_environment ...'
  end
  # verify the required parameter 'feature_flag_id' is set
  if @api_client.config.client_side_validation && feature_flag_id.nil?
    fail ArgumentError, "Missing the required parameter 'feature_flag_id' when calling FeatureFlagsAPI.enable_feature_flag_environment"
  end
  # verify the required parameter 'environment_id' is set
  if @api_client.config.client_side_validation && environment_id.nil?
    fail ArgumentError, "Missing the required parameter 'environment_id' when calling FeatureFlagsAPI.enable_feature_flag_environment"
  end
  # resource path
  local_var_path = '/api/v2/feature-flags/{feature_flag_id}/environments/{environment_id}/enable'.sub('{feature_flag_id}', CGI.escape(feature_flag_id.to_s).gsub('%2F', '/')).sub('{environment_id}', CGI.escape(environment_id.to_s).gsub('%2F', '/'))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]

  new_options = opts.merge(
    :operation => :enable_feature_flag_environment,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Post, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FeatureFlagsAPI#enable_feature_flag_environment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_feature_flag(feature_flag_id, opts = {}) ⇒ Object

Get a feature flag.

See Also:



434
435
436
437
 
# File 'lib/datadog_api_client/v2/api/feature_flags_api.rb', line 434

def get_feature_flag(feature_flag_id, opts = {})
  data, _status_code, _headers = get_feature_flag_with_http_info(feature_flag_id, opts)
  data
end

#get_feature_flag_with_http_info(feature_flag_id, opts = {}) ⇒ Array<(FeatureFlagResponse, Integer, Hash)>

Get a feature flag.

Returns the details of a specific feature flag including variants and environment status.

Parameters:

  • feature_flag_id (UUID) —

    The ID of the feature flag.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(FeatureFlagResponse, Integer, Hash)>) —

    FeatureFlagResponse data, response status code and response headers



447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
 
# File 'lib/datadog_api_client/v2/api/feature_flags_api.rb', line 447

def get_feature_flag_with_http_info(feature_flag_id, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FeatureFlagsAPI.get_feature_flag ...'
  end
  # verify the required parameter 'feature_flag_id' is set
  if @api_client.config.client_side_validation && feature_flag_id.nil?
    fail ArgumentError, "Missing the required parameter 'feature_flag_id' when calling FeatureFlagsAPI.get_feature_flag"
  end
  # resource path
  local_var_path = '/api/v2/feature-flags/{feature_flag_id}'.sub('{feature_flag_id}', CGI.escape(feature_flag_id.to_s).gsub('%2F', '/'))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'FeatureFlagResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]

  new_options = opts.merge(
    :operation => :get_feature_flag,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Get, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FeatureFlagsAPI#get_feature_flag\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_feature_flags_environment(environment_id, opts = {}) ⇒ Object

Get an environment.

See Also:



500
501
502
503
 
# File 'lib/datadog_api_client/v2/api/feature_flags_api.rb', line 500

def get_feature_flags_environment(environment_id, opts = {})
  data, _status_code, _headers = get_feature_flags_environment_with_http_info(environment_id, opts)
  data
end

#get_feature_flags_environment_with_http_info(environment_id, opts = {}) ⇒ Array<(EnvironmentResponse, Integer, Hash)>

Get an environment.

Returns the details of a specific environment.

Parameters:

  • environment_id (UUID) —

    The ID of the environment.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(EnvironmentResponse, Integer, Hash)>) —

    EnvironmentResponse data, response status code and response headers



512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
 
# File 'lib/datadog_api_client/v2/api/feature_flags_api.rb', line 512

def get_feature_flags_environment_with_http_info(environment_id, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FeatureFlagsAPI.get_feature_flags_environment ...'
  end
  # verify the required parameter 'environment_id' is set
  if @api_client.config.client_side_validation && environment_id.nil?
    fail ArgumentError, "Missing the required parameter 'environment_id' when calling FeatureFlagsAPI.get_feature_flags_environment"
  end
  # resource path
  local_var_path = '/api/v2/feature-flags/environments/{environment_id}'.sub('{environment_id}', CGI.escape(environment_id.to_s).gsub('%2F', '/'))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'EnvironmentResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]

  new_options = opts.merge(
    :operation => :get_feature_flags_environment,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Get, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FeatureFlagsAPI#get_feature_flags_environment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_feature_flags(opts = {}) ⇒ Object

List feature flags.

See Also:



565
566
567
568
 
# File 'lib/datadog_api_client/v2/api/feature_flags_api.rb', line 565

def list_feature_flags(opts = {})
  data, _status_code, _headers = list_feature_flags_with_http_info(opts)
  data
end

#list_feature_flags_environments(opts = {}) ⇒ Object

List environments.

See Also:



643
644
645
646
 
# File 'lib/datadog_api_client/v2/api/feature_flags_api.rb', line 643

def list_feature_flags_environments(opts = {})
  data, _status_code, _headers = list_feature_flags_environments_with_http_info(opts)
  data
end

#list_feature_flags_environments_with_http_info(opts = {}) ⇒ Array<(ListEnvironmentsResponse, Integer, Hash)>

List environments.

Returns a list of environments for the organization. Supports filtering by name and key.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :name (String) —

    Filter environments by name (partial matching).

  • :key (String) —

    Filter environments by key (partial matching).

  • :limit (Integer) —

    Maximum number of results to return.

  • :offset (Integer) —

    Number of results to skip.

Returns:

  • (Array<(ListEnvironmentsResponse, Integer, Hash)>) —

    ListEnvironmentsResponse data, response status code and response headers



659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
 
# File 'lib/datadog_api_client/v2/api/feature_flags_api.rb', line 659

def list_feature_flags_environments_with_http_info(opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FeatureFlagsAPI.list_feature_flags_environments ...'
  end
  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling FeatureFlagsAPI.list_feature_flags_environments, must be smaller than or equal to 1000.'
  end
  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling FeatureFlagsAPI.list_feature_flags_environments, must be greater than or equal to 1.'
  end
  if @api_client.config.client_side_validation && !opts[:'offset'].nil? && opts[:'offset'] < 0
    fail ArgumentError, 'invalid value for "opts[:"offset"]" when calling FeatureFlagsAPI.list_feature_flags_environments, must be greater than or equal to 0.'
  end
  # resource path
  local_var_path = '/api/v2/feature-flags/environments'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'name'] = opts[:'name'] if !opts[:'name'].nil?
  query_params[:'key'] = opts[:'key'] if !opts[:'key'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'ListEnvironmentsResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]

  new_options = opts.merge(
    :operation => :list_feature_flags_environments,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Get, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FeatureFlagsAPI#list_feature_flags_environments\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_feature_flags_with_http_info(opts = {}) ⇒ Array<(ListFeatureFlagsResponse, Integer, Hash)>

List feature flags.

Returns a list of feature flags for the organization. Supports filtering by key and archived status.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :key (String) —

    Filter feature flags by key (partial matching).

  • :is_archived (Boolean) —

    Filter by archived status.

  • :limit (Integer) —

    Maximum number of results to return.

  • :offset (Integer) —

    Number of results to skip.

Returns:

  • (Array<(ListFeatureFlagsResponse, Integer, Hash)>) —

    ListFeatureFlagsResponse data, response status code and response headers



581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
 
# File 'lib/datadog_api_client/v2/api/feature_flags_api.rb', line 581

def list_feature_flags_with_http_info(opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FeatureFlagsAPI.list_feature_flags ...'
  end
  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling FeatureFlagsAPI.list_feature_flags, must be smaller than or equal to 1000.'
  end
  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling FeatureFlagsAPI.list_feature_flags, must be greater than or equal to 1.'
  end
  if @api_client.config.client_side_validation && !opts[:'offset'].nil? && opts[:'offset'] < 0
    fail ArgumentError, 'invalid value for "opts[:"offset"]" when calling FeatureFlagsAPI.list_feature_flags, must be greater than or equal to 0.'
  end
  # resource path
  local_var_path = '/api/v2/feature-flags'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'key'] = opts[:'key'] if !opts[:'key'].nil?
  query_params[:'is_archived'] = opts[:'is_archived'] if !opts[:'is_archived'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'ListFeatureFlagsResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]

  new_options = opts.merge(
    :operation => :list_feature_flags,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Get, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FeatureFlagsAPI#list_feature_flags\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#unarchive_feature_flag(feature_flag_id, opts = {}) ⇒ Object

Unarchive a feature flag.

See Also:



721
722
723
724
 
# File 'lib/datadog_api_client/v2/api/feature_flags_api.rb', line 721

def unarchive_feature_flag(feature_flag_id, opts = {})
  data, _status_code, _headers = unarchive_feature_flag_with_http_info(feature_flag_id, opts)
  data
end

#unarchive_feature_flag_with_http_info(feature_flag_id, opts = {}) ⇒ Array<(FeatureFlagResponse, Integer, Hash)>

Unarchive a feature flag.

Unarchives a previously archived feature flag, making it visible in the main list again.

Parameters:

  • feature_flag_id (UUID) —

    The ID of the feature flag.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(FeatureFlagResponse, Integer, Hash)>) —

    FeatureFlagResponse data, response status code and response headers



734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
 
# File 'lib/datadog_api_client/v2/api/feature_flags_api.rb', line 734

def unarchive_feature_flag_with_http_info(feature_flag_id, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FeatureFlagsAPI.unarchive_feature_flag ...'
  end
  # verify the required parameter 'feature_flag_id' is set
  if @api_client.config.client_side_validation && feature_flag_id.nil?
    fail ArgumentError, "Missing the required parameter 'feature_flag_id' when calling FeatureFlagsAPI.unarchive_feature_flag"
  end
  # resource path
  local_var_path = '/api/v2/feature-flags/{feature_flag_id}/unarchive'.sub('{feature_flag_id}', CGI.escape(feature_flag_id.to_s).gsub('%2F', '/'))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'FeatureFlagResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]

  new_options = opts.merge(
    :operation => :unarchive_feature_flag,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Post, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FeatureFlagsAPI#unarchive_feature_flag\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_feature_flag(feature_flag_id, body, opts = {}) ⇒ Object

Update a feature flag.

See Also:



787
788
789
790
 
# File 'lib/datadog_api_client/v2/api/feature_flags_api.rb', line 787

def update_feature_flag(feature_flag_id, body, opts = {})
  data, _status_code, _headers = update_feature_flag_with_http_info(feature_flag_id, body, opts)
  data
end

#update_feature_flag_with_http_info(feature_flag_id, body, opts = {}) ⇒ Array<(FeatureFlagResponse, Integer, Hash)>

Update a feature flag.

Updates an existing feature flag's metadata such as name and description. Does not modify targeting rules or allocations.

Parameters:

  • feature_flag_id (UUID) —

    The ID of the feature flag.

  • body (UpdateFeatureFlagRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(FeatureFlagResponse, Integer, Hash)>) —

    FeatureFlagResponse data, response status code and response headers



801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
 
# File 'lib/datadog_api_client/v2/api/feature_flags_api.rb', line 801

def update_feature_flag_with_http_info(feature_flag_id, body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FeatureFlagsAPI.update_feature_flag ...'
  end
  # verify the required parameter 'feature_flag_id' is set
  if @api_client.config.client_side_validation && feature_flag_id.nil?
    fail ArgumentError, "Missing the required parameter 'feature_flag_id' when calling FeatureFlagsAPI.update_feature_flag"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling FeatureFlagsAPI.update_feature_flag"
  end
  # resource path
  local_var_path = '/api/v2/feature-flags/{feature_flag_id}'.sub('{feature_flag_id}', CGI.escape(feature_flag_id.to_s).gsub('%2F', '/'))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)

  # return_type
  return_type = opts[:debug_return_type] || 'FeatureFlagResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]

  new_options = opts.merge(
    :operation => :update_feature_flag,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Put, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FeatureFlagsAPI#update_feature_flag\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_feature_flags_environment(environment_id, body, opts = {}) ⇒ Object

Update an environment.

See Also:



860
861
862
863
 
# File 'lib/datadog_api_client/v2/api/feature_flags_api.rb', line 860

def update_feature_flags_environment(environment_id, body, opts = {})
  data, _status_code, _headers = update_feature_flags_environment_with_http_info(environment_id, body, opts)
  data
end

#update_feature_flags_environment_with_http_info(environment_id, body, opts = {}) ⇒ Array<(EnvironmentResponse, Integer, Hash)>

Update an environment.

Updates an existing environment's metadata such as name and description.

Parameters:

  • environment_id (UUID) —

    The ID of the environment.

  • body (UpdateEnvironmentRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(EnvironmentResponse, Integer, Hash)>) —

    EnvironmentResponse data, response status code and response headers



874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
 
# File 'lib/datadog_api_client/v2/api/feature_flags_api.rb', line 874

def update_feature_flags_environment_with_http_info(environment_id, body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FeatureFlagsAPI.update_feature_flags_environment ...'
  end
  # verify the required parameter 'environment_id' is set
  if @api_client.config.client_side_validation && environment_id.nil?
    fail ArgumentError, "Missing the required parameter 'environment_id' when calling FeatureFlagsAPI.update_feature_flags_environment"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling FeatureFlagsAPI.update_feature_flags_environment"
  end
  # resource path
  local_var_path = '/api/v2/feature-flags/environments/{environment_id}'.sub('{environment_id}', CGI.escape(environment_id.to_s).gsub('%2F', '/'))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)

  # return_type
  return_type = opts[:debug_return_type] || 'EnvironmentResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]

  new_options = opts.merge(
    :operation => :update_feature_flags_environment,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Put, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FeatureFlagsAPI#update_feature_flags_environment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end