Class: LaunchDarklyApi::EnvironmentsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/launchdarkly_api/api/environments_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ EnvironmentsApi

Returns a new instance of EnvironmentsApi.



19
20
21
 
# File 'lib/launchdarkly_api/api/environments_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/launchdarkly_api/api/environments_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#delete_environment(project_key, environment_key, opts = {}) ⇒ nil

Delete environment Delete a environment by key.

Parameters:

  • project_key (String) —

    The project key

  • environment_key (String) —

    The environment key

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

    the optional parameters

Returns:

  • (nil) 


28
29
30
31
 
# File 'lib/launchdarkly_api/api/environments_api.rb', line 28

def delete_environment(project_key, environment_key, opts = {})
  delete_environment_with_http_info(project_key, environment_key, opts)
  nil
end

#delete_environment_with_http_info(project_key, environment_key, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete environment Delete a environment by key.

Parameters:

  • project_key (String) —

    The project key

  • environment_key (String) —

    The environment key

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



39
40
41
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
 
# File 'lib/launchdarkly_api/api/environments_api.rb', line 39

def delete_environment_with_http_info(project_key, environment_key, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EnvironmentsApi.delete_environment ...'
  end
  # verify the required parameter 'project_key' is set
  if @api_client.config.client_side_validation && project_key.nil?
    fail ArgumentError, "Missing the required parameter 'project_key' when calling EnvironmentsApi.delete_environment"
  end
  # verify the required parameter 'environment_key' is set
  if @api_client.config.client_side_validation && environment_key.nil?
    fail ArgumentError, "Missing the required parameter 'environment_key' when calling EnvironmentsApi.delete_environment"
  end
  # resource path
  local_var_path = '/api/v2/projects/{projectKey}/environments/{environmentKey}'.sub('{' + 'projectKey' + '}', CGI.escape(project_key.to_s)).sub('{' + 'environmentKey' + '}', CGI.escape(environment_key.to_s))

  # 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]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKey']

  new_options = opts.merge(
    :operation => :"EnvironmentsApi.delete_environment",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

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

#get_environment(project_key, environment_key, opts = {}) ⇒ Environment

Get environment > ### Approval settings > > The ‘approvalSettings` key is only returned when the Flag Approvals feature is enabled. Get an environment given a project and key.

Parameters:

  • project_key (String) —

    The project key

  • environment_key (String) —

    The environment key

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

    the optional parameters

Returns:



97
98
99
100
 
# File 'lib/launchdarkly_api/api/environments_api.rb', line 97

def get_environment(project_key, environment_key, opts = {})
  data, _status_code, _headers = get_environment_with_http_info(project_key, environment_key, opts)
  data
end

#get_environment_with_http_info(project_key, environment_key, opts = {}) ⇒ Array<(Environment, Integer, Hash)>

Get environment &gt; ### Approval settings &gt; &gt; The &#x60;approvalSettings&#x60; key is only returned when the Flag Approvals feature is enabled. Get an environment given a project and key.

Parameters:

  • project_key (String) —

    The project key

  • environment_key (String) —

    The environment key

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

    the optional parameters

Returns:

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

    Environment data, response status code and response headers



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
158
 
# File 'lib/launchdarkly_api/api/environments_api.rb', line 108

def get_environment_with_http_info(project_key, environment_key, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EnvironmentsApi.get_environment ...'
  end
  # verify the required parameter 'project_key' is set
  if @api_client.config.client_side_validation && project_key.nil?
    fail ArgumentError, "Missing the required parameter 'project_key' when calling EnvironmentsApi.get_environment"
  end
  # verify the required parameter 'environment_key' is set
  if @api_client.config.client_side_validation && environment_key.nil?
    fail ArgumentError, "Missing the required parameter 'environment_key' when calling EnvironmentsApi.get_environment"
  end
  # resource path
  local_var_path = '/api/v2/projects/{projectKey}/environments/{environmentKey}'.sub('{' + 'projectKey' + '}', CGI.escape(project_key.to_s)).sub('{' + 'environmentKey' + '}', CGI.escape(environment_key.to_s))

  # 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] || 'Environment'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKey']

  new_options = opts.merge(
    :operation => :"EnvironmentsApi.get_environment",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

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

#get_environments_by_project(project_key, opts = {}) ⇒ Environments

List environments Return a list of environments for the specified project. By default, this returns the first 20 environments. Page through this list with the ‘limit` parameter and by following the `first`, `prev`, `next`, and `last` links in the `_links` field that returns. If those links do not appear, the pages they refer to don’t exist. For example, the ‘first` and `prev` links will be missing from the response on the first page, because there is no previous page and you cannot return to the first page when you are already on the first page. ### Filtering environments LaunchDarkly supports two fields for filters: - `query` is a string that matches against the environments’ names and keys. It is not case sensitive. - ‘tags` is a `+` separate list of environment tags. It filters the list of environments that have all of the tags in the list. For example, the filter `query:abc,tags:tag-1+tag-2` matches environments with the string `abc` in their name or key and also are tagged with `tag-1` and `tag-2`. The filter is not case-sensitive. ### Sorting environments LaunchDarkly supports two fields for sorting: - `name` sorts by environment name. - `createdOn` sorts by the creation date of the environment. For example, `sort=name` sorts the response by environment name in ascending order.

Parameters:

  • project_key (String) —

    The project key

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    The number of environments to return in the response. Defaults to 20.

  • :offset (Integer) —

    Where to start in the list. This is for use with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query &#x60;limit&#x60;.

  • :filter (String) —

    A comma-separated list of filters. Each filter is of the form &#x60;field:value&#x60;.

  • :sort (String) —

    A comma-separated list of fields to sort by. Fields prefixed by a dash ( - ) sort in descending order.

Returns:



169
170
171
172
 
# File 'lib/launchdarkly_api/api/environments_api.rb', line 169

def get_environments_by_project(project_key, opts = {})
  data, _status_code, _headers = get_environments_by_project_with_http_info(project_key, opts)
  data
end

#get_environments_by_project_with_http_info(project_key, opts = {}) ⇒ Array<(Environments, Integer, Hash)>

List environments Return a list of environments for the specified project. By default, this returns the first 20 environments. Page through this list with the &#x60;limit&#x60; parameter and by following the &#x60;first&#x60;, &#x60;prev&#x60;, &#x60;next&#x60;, and &#x60;last&#x60; links in the &#x60;_links&#x60; field that returns. If those links do not appear, the pages they refer to don&#39;t exist. For example, the &#x60;first&#x60; and &#x60;prev&#x60; links will be missing from the response on the first page, because there is no previous page and you cannot return to the first page when you are already on the first page. ### Filtering environments LaunchDarkly supports two fields for filters: - &#x60;query&#x60; is a string that matches against the environments&#39; names and keys. It is not case sensitive. - &#x60;tags&#x60; is a &#x60;+&#x60; separate list of environment tags. It filters the list of environments that have all of the tags in the list. For example, the filter &#x60;query:abc,tags:tag-1+tag-2&#x60; matches environments with the string &#x60;abc&#x60; in their name or key and also are tagged with &#x60;tag-1&#x60; and &#x60;tag-2&#x60;. The filter is not case-sensitive. ### Sorting environments LaunchDarkly supports two fields for sorting: - &#x60;name&#x60; sorts by environment name. - &#x60;createdOn&#x60; sorts by the creation date of the environment. For example, &#x60;sort&#x3D;name&#x60; sorts the response by environment name in ascending order.

Parameters:

  • project_key (String) —

    The project key

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    The number of environments to return in the response. Defaults to 20.

  • :offset (Integer) —

    Where to start in the list. This is for use with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query &#x60;limit&#x60;.

  • :filter (String) —

    A comma-separated list of filters. Each filter is of the form &#x60;field:value&#x60;.

  • :sort (String) —

    A comma-separated list of fields to sort by. Fields prefixed by a dash ( - ) sort in descending order.

Returns:

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

    Environments data, response status code and response headers



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
225
226
227
228
229
230
231
232
233
 
# File 'lib/launchdarkly_api/api/environments_api.rb', line 183

def get_environments_by_project_with_http_info(project_key, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EnvironmentsApi.get_environments_by_project ...'
  end
  # verify the required parameter 'project_key' is set
  if @api_client.config.client_side_validation && project_key.nil?
    fail ArgumentError, "Missing the required parameter 'project_key' when calling EnvironmentsApi.get_environments_by_project"
  end
  # resource path
  local_var_path = '/api/v2/projects/{projectKey}/environments'.sub('{' + 'projectKey' + '}', CGI.escape(project_key.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].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] || 'Environments'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKey']

  new_options = opts.merge(
    :operation => :"EnvironmentsApi.get_environments_by_project",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

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

#patch_environment(project_key, environment_key, patch_operation, opts = {}) ⇒ Environment

Update environment

Update an environment. Requires a [JSON Patch](https://datatracker.ietf.org/doc/html/rfc6902) representation of the desired changes to the environment.  To update fields in the environment object that are arrays, set the `path` to the name of the field and then append `/<array index>`. Using `/0` appends to the beginning of the array.  ### Approval settings  This request only returns the `approvalSettings` key if the [Flag Approvals](https://docs.launchdarkly.com/home/feature-workflows/approvals) feature is enabled.  Only the `canReviewOwnRequest`, `canApplyDeclinedChanges`, `minNumApprovals`, `required` and `requiredApprovalTagsfields` are editable.  If you try to patch the environment by setting both `required` and `requiredApprovalTags`, the request fails and an error appears. You can specify either required approvals for all flags in an environment or those with specific tags, but not both.

Parameters:

  • project_key (String) —

    The project key

  • environment_key (String) —

    The environment key

  • patch_operation (Array<PatchOperation>)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



242
243
244
245
 
# File 'lib/launchdarkly_api/api/environments_api.rb', line 242

def patch_environment(project_key, environment_key, patch_operation, opts = {})
  data, _status_code, _headers = patch_environment_with_http_info(project_key, environment_key, patch_operation, opts)
  data
end

#patch_environment_with_http_info(project_key, environment_key, patch_operation, opts = {}) ⇒ Array<(Environment, Integer, Hash)>

Update environment

Update an environment. Requires a [JSON Patch](https://datatracker.ietf.org/doc/html/rfc6902) representation of the desired changes to the environment.  To update fields in the environment object that are arrays, set the &#x60;path&#x60; to the name of the field and then append &#x60;/&lt;array index&gt;&#x60;. Using &#x60;/0&#x60; appends to the beginning of the array.  ### Approval settings  This request only returns the &#x60;approvalSettings&#x60; key if the [Flag Approvals](https://docs.launchdarkly.com/home/feature-workflows/approvals) feature is enabled.  Only the &#x60;canReviewOwnRequest&#x60;, &#x60;canApplyDeclinedChanges&#x60;, &#x60;minNumApprovals&#x60;, &#x60;required&#x60; and &#x60;requiredApprovalTagsfields&#x60; are editable.  If you try to patch the environment by setting both &#x60;required&#x60; and &#x60;requiredApprovalTags&#x60;, the request fails and an error appears. You can specify either required approvals for all flags in an environment or those with specific tags, but not both.

Parameters:

  • project_key (String) —

    The project key

  • environment_key (String) —

    The environment key

  • patch_operation (Array<PatchOperation>)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    Environment data, response status code and response headers



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
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
 
# File 'lib/launchdarkly_api/api/environments_api.rb', line 254

def patch_environment_with_http_info(project_key, environment_key, patch_operation, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EnvironmentsApi.patch_environment ...'
  end
  # verify the required parameter 'project_key' is set
  if @api_client.config.client_side_validation && project_key.nil?
    fail ArgumentError, "Missing the required parameter 'project_key' when calling EnvironmentsApi.patch_environment"
  end
  # verify the required parameter 'environment_key' is set
  if @api_client.config.client_side_validation && environment_key.nil?
    fail ArgumentError, "Missing the required parameter 'environment_key' when calling EnvironmentsApi.patch_environment"
  end
  # verify the required parameter 'patch_operation' is set
  if @api_client.config.client_side_validation && patch_operation.nil?
    fail ArgumentError, "Missing the required parameter 'patch_operation' when calling EnvironmentsApi.patch_environment"
  end
  # resource path
  local_var_path = '/api/v2/projects/{projectKey}/environments/{environmentKey}'.sub('{' + 'projectKey' + '}', CGI.escape(project_key.to_s)).sub('{' + 'environmentKey' + '}', CGI.escape(environment_key.to_s))

  # 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'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKey']

  new_options = opts.merge(
    :operation => :"EnvironmentsApi.patch_environment",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

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

#post_environment(project_key, environment_post, opts = {}) ⇒ Environment

Create environment > ### Approval settings > > The ‘approvalSettings` key is only returned when the Flag Approvals feature is enabled. > > You cannot update approval settings when creating new environments. Update approval settings with the PATCH Environment API. Create a new environment in a specified project with a given name, key, swatch color, and default TTL.

Parameters:

  • project_key (String) —

    The project key

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

    the optional parameters

Returns:



321
322
323
324
 
# File 'lib/launchdarkly_api/api/environments_api.rb', line 321

def post_environment(project_key, environment_post, opts = {})
  data, _status_code, _headers = post_environment_with_http_info(project_key, environment_post, opts)
  data
end

#post_environment_with_http_info(project_key, environment_post, opts = {}) ⇒ Array<(Environment, Integer, Hash)>

Create environment &gt; ### Approval settings &gt; &gt; The &#x60;approvalSettings&#x60; key is only returned when the Flag Approvals feature is enabled. &gt; &gt; You cannot update approval settings when creating new environments. Update approval settings with the PATCH Environment API. Create a new environment in a specified project with a given name, key, swatch color, and default TTL.

Parameters:

  • project_key (String) —

    The project key

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

    the optional parameters

Returns:

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

    Environment data, response status code and response headers



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
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
 
# File 'lib/launchdarkly_api/api/environments_api.rb', line 332

def post_environment_with_http_info(project_key, environment_post, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EnvironmentsApi.post_environment ...'
  end
  # verify the required parameter 'project_key' is set
  if @api_client.config.client_side_validation && project_key.nil?
    fail ArgumentError, "Missing the required parameter 'project_key' when calling EnvironmentsApi.post_environment"
  end
  # verify the required parameter 'environment_post' is set
  if @api_client.config.client_side_validation && environment_post.nil?
    fail ArgumentError, "Missing the required parameter 'environment_post' when calling EnvironmentsApi.post_environment"
  end
  # resource path
  local_var_path = '/api/v2/projects/{projectKey}/environments'.sub('{' + 'projectKey' + '}', CGI.escape(project_key.to_s))

  # 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'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKey']

  new_options = opts.merge(
    :operation => :"EnvironmentsApi.post_environment",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

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

#reset_environment_mobile_key(project_key, environment_key, opts = {}) ⇒ Environment

Reset environment mobile SDK key Reset an environment’s mobile key. The optional expiry for the old key is deprecated for this endpoint, so the old key will always expire immediately.

Parameters:

  • project_key (String) —

    The project key

  • environment_key (String) —

    The environment key

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

    the optional parameters

Returns:



395
396
397
398
 
# File 'lib/launchdarkly_api/api/environments_api.rb', line 395

def reset_environment_mobile_key(project_key, environment_key, opts = {})
  data, _status_code, _headers = reset_environment_mobile_key_with_http_info(project_key, environment_key, opts)
  data
end

#reset_environment_mobile_key_with_http_info(project_key, environment_key, opts = {}) ⇒ Array<(Environment, Integer, Hash)>

Reset environment mobile SDK key Reset an environment&#39;s mobile key. The optional expiry for the old key is deprecated for this endpoint, so the old key will always expire immediately.

Parameters:

  • project_key (String) —

    The project key

  • environment_key (String) —

    The environment key

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

    the optional parameters

Returns:

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

    Environment data, response status code and response headers



406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
 
# File 'lib/launchdarkly_api/api/environments_api.rb', line 406

def reset_environment_mobile_key_with_http_info(project_key, environment_key, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EnvironmentsApi.reset_environment_mobile_key ...'
  end
  # verify the required parameter 'project_key' is set
  if @api_client.config.client_side_validation && project_key.nil?
    fail ArgumentError, "Missing the required parameter 'project_key' when calling EnvironmentsApi.reset_environment_mobile_key"
  end
  # verify the required parameter 'environment_key' is set
  if @api_client.config.client_side_validation && environment_key.nil?
    fail ArgumentError, "Missing the required parameter 'environment_key' when calling EnvironmentsApi.reset_environment_mobile_key"
  end
  # resource path
  local_var_path = '/api/v2/projects/{projectKey}/environments/{environmentKey}/mobileKey'.sub('{' + 'projectKey' + '}', CGI.escape(project_key.to_s)).sub('{' + 'environmentKey' + '}', CGI.escape(environment_key.to_s))

  # 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] || 'Environment'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKey']

  new_options = opts.merge(
    :operation => :"EnvironmentsApi.reset_environment_mobile_key",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

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

#reset_environment_sdk_key(project_key, environment_key, opts = {}) ⇒ Environment

Reset environment SDK key Reset an environment’s SDK key with an optional expiry time for the old key.

Parameters:

  • project_key (String) —

    The project key

  • environment_key (String) —

    The environment key

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

    the optional parameters

Options Hash (opts):

  • :expiry (Integer) —

    The time at which you want the old SDK key to expire, in UNIX milliseconds. By default, the key expires immediately.

Returns:



465
466
467
468
 
# File 'lib/launchdarkly_api/api/environments_api.rb', line 465

def reset_environment_sdk_key(project_key, environment_key, opts = {})
  data, _status_code, _headers = reset_environment_sdk_key_with_http_info(project_key, environment_key, opts)
  data
end

#reset_environment_sdk_key_with_http_info(project_key, environment_key, opts = {}) ⇒ Array<(Environment, Integer, Hash)>

Reset environment SDK key Reset an environment&#39;s SDK key with an optional expiry time for the old key.

Parameters:

  • project_key (String) —

    The project key

  • environment_key (String) —

    The environment key

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

    the optional parameters

Options Hash (opts):

  • :expiry (Integer) —

    The time at which you want the old SDK key to expire, in UNIX milliseconds. By default, the key expires immediately.

Returns:

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

    Environment data, response status code and response headers



477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
 
# File 'lib/launchdarkly_api/api/environments_api.rb', line 477

def reset_environment_sdk_key_with_http_info(project_key, environment_key, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EnvironmentsApi.reset_environment_sdk_key ...'
  end
  # verify the required parameter 'project_key' is set
  if @api_client.config.client_side_validation && project_key.nil?
    fail ArgumentError, "Missing the required parameter 'project_key' when calling EnvironmentsApi.reset_environment_sdk_key"
  end
  # verify the required parameter 'environment_key' is set
  if @api_client.config.client_side_validation && environment_key.nil?
    fail ArgumentError, "Missing the required parameter 'environment_key' when calling EnvironmentsApi.reset_environment_sdk_key"
  end
  # resource path
  local_var_path = '/api/v2/projects/{projectKey}/environments/{environmentKey}/apiKey'.sub('{' + 'projectKey' + '}', CGI.escape(project_key.to_s)).sub('{' + 'environmentKey' + '}', CGI.escape(environment_key.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'expiry'] = opts[:'expiry'] if !opts[:'expiry'].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] || 'Environment'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKey']

  new_options = opts.merge(
    :operation => :"EnvironmentsApi.reset_environment_sdk_key",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

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