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 an environment in a specific project.

Parameters:

  • project_key —

    The project key, used to tie the flags together under one project so they can be managed together.

  • environment_key —

    The environment key, used to tie together flag configuration and users under one environment so they can be managed together.

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

    the optional parameters

Returns:

  • (nil) 


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

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, Fixnum, Hash)>

Delete an environment in a specific project.

Parameters:

  • project_key —

    The project key, used to tie the flags together under one project so they can be managed together.

  • environment_key —

    The environment key, used to tie together flag configuration and users under one environment so they can be managed together.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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

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 = '/projects/{projectKey}/environments/{environmentKey}'.sub('{' + 'projectKey' + '}', project_key.to_s).sub('{' + 'environmentKey' + '}', environment_key.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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 = {}

  # http body (model)
  post_body = nil
  auth_names = ['Token']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  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 an environment given a project and key.

Parameters:

  • project_key —

    The project key, used to tie the flags together under one project so they can be managed together.

  • environment_key —

    The environment key, used to tie together flag configuration and users under one environment so they can be managed together.

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

    the optional parameters

Returns:



84
85
86
87
 
# File 'lib/launchdarkly_api/api/environments_api.rb', line 84

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, Fixnum, Hash)>

Get an environment given a project and key.

Parameters:

  • project_key —

    The project key, used to tie the flags together under one project so they can be managed together.

  • environment_key —

    The environment key, used to tie together flag configuration and users under one environment so they can be managed together.

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

    the optional parameters

Returns:

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

    Environment data, response status code and response headers



94
95
96
97
98
99
100
101
102
103
104
105
106
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
 
# File 'lib/launchdarkly_api/api/environments_api.rb', line 94

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 = '/projects/{projectKey}/environments/{environmentKey}'.sub('{' + 'projectKey' + '}', project_key.to_s).sub('{' + 'environmentKey' + '}', environment_key.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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 = {}

  # http body (model)
  post_body = nil
  auth_names = ['Token']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Environment')
  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

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

Modify an environment by ID.

Parameters:

  • project_key —

    The project key, used to tie the flags together under one project so they can be managed together.

  • environment_key —

    The environment key, used to tie together flag configuration and users under one environment so they can be managed together.

  • patch_delta —

    Requires a JSON Patch representation of the desired changes to the project. &#39;jsonpatch.com/&#39;

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

    the optional parameters

Returns:



143
144
145
146
 
# File 'lib/launchdarkly_api/api/environments_api.rb', line 143

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

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

Modify an environment by ID.

Parameters:

  • project_key —

    The project key, used to tie the flags together under one project so they can be managed together.

  • environment_key —

    The environment key, used to tie together flag configuration and users under one environment so they can be managed together.

  • patch_delta —

    Requires a JSON Patch representation of the desired changes to the project. &#39;jsonpatch.com/&#39;

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

    the optional parameters

Returns:

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

    Environment data, response status code and response headers



154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
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
 
# File 'lib/launchdarkly_api/api/environments_api.rb', line 154

def patch_environment_with_http_info(project_key, environment_key, patch_delta, 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_delta' is set
  if @api_client.config.client_side_validation && patch_delta.nil?
    fail ArgumentError, "Missing the required parameter 'patch_delta' when calling EnvironmentsApi.patch_environment"
  end
  # resource path
  local_var_path = '/projects/{projectKey}/environments/{environmentKey}'.sub('{' + 'projectKey' + '}', project_key.to_s).sub('{' + 'environmentKey' + '}', environment_key.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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 = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(patch_delta)
  auth_names = ['Token']
  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Environment')
  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_body, opts = {}) ⇒ Environment

Create a new environment in a specified project with a given name, key, and swatch color.

Parameters:

  • project_key —

    The project key, used to tie the flags together under one project so they can be managed together.

  • environment_body —

    New environment.

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

    the optional parameters

Returns:



206
207
208
209
 
# File 'lib/launchdarkly_api/api/environments_api.rb', line 206

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

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

Create a new environment in a specified project with a given name, key, and swatch color.

Parameters:

  • project_key —

    The project key, used to tie the flags together under one project so they can be managed together.

  • environment_body —

    New environment.

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

    the optional parameters

Returns:

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

    Environment data, response status code and response headers



216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
 
# File 'lib/launchdarkly_api/api/environments_api.rb', line 216

def post_environment_with_http_info(project_key, environment_body, 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_body' is set
  if @api_client.config.client_side_validation && environment_body.nil?
    fail ArgumentError, "Missing the required parameter 'environment_body' when calling EnvironmentsApi.post_environment"
  end
  # resource path
  local_var_path = '/projects/{projectKey}/environments'.sub('{' + 'projectKey' + '}', project_key.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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 = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(environment_body)
  auth_names = ['Token']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Environment')
  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 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 —

    The project key, used to tie the flags together under one project so they can be managed together.

  • environment_key —

    The environment key, used to tie together flag configuration and users under one environment so they can be managed together.

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

    the optional parameters

Options Hash (opts):

  • :expiry (Integer) —

    The expiry parameter is deprecated for this endpoint, so the old mobile key will always expire immediately. This parameter will be removed in an upcoming major API client version.

Returns:



265
266
267
268
 
# File 'lib/launchdarkly_api/api/environments_api.rb', line 265

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, Fixnum, Hash)>

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 —

    The project key, used to tie the flags together under one project so they can be managed together.

  • environment_key —

    The environment key, used to tie together flag configuration and users under one environment so they can be managed together.

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

    the optional parameters

Options Hash (opts):

  • :expiry (Integer) —

    The expiry parameter is deprecated for this endpoint, so the old mobile key will always expire immediately. This parameter will be removed in an upcoming major API client version.

Returns:

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

    Environment data, response status code and response headers



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
314
315
316
317
318
319
 
# File 'lib/launchdarkly_api/api/environments_api.rb', line 276

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 = '/projects/{projectKey}/environments/{environmentKey}/mobileKey'.sub('{' + 'projectKey' + '}', project_key.to_s).sub('{' + 'environmentKey' + '}', environment_key.to_s)

  # query parameters
  query_params = {}
  query_params[:'expiry'] = opts[:'expiry'] if !opts[:'expiry'].nil?

  # header parameters
  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 = {}

  # http body (model)
  post_body = nil
  auth_names = ['Token']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Environment')
  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 an environment’s SDK key with an optional expiry time for the old key.

Parameters:

  • project_key —

    The project key, used to tie the flags together under one project so they can be managed together.

  • environment_key —

    The environment key, used to tie together flag configuration and users under one environment so they can be managed together.

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

    the optional parameters

Options Hash (opts):

  • :expiry (Integer) —

    An expiration time for the old environment SDK key, expressed as a Unix epoch time in milliseconds. By default, the key will expire immediately.

Returns:



326
327
328
329
 
# File 'lib/launchdarkly_api/api/environments_api.rb', line 326

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, Fixnum, Hash)>

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

Parameters:

  • project_key —

    The project key, used to tie the flags together under one project so they can be managed together.

  • environment_key —

    The environment key, used to tie together flag configuration and users under one environment so they can be managed together.

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

    the optional parameters

Options Hash (opts):

  • :expiry (Integer) —

    An expiration time for the old environment SDK key, expressed as a Unix epoch time in milliseconds. By default, the key will expire immediately.

Returns:

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

    Environment data, response status code and response headers



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

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 = '/projects/{projectKey}/environments/{environmentKey}/apiKey'.sub('{' + 'projectKey' + '}', project_key.to_s).sub('{' + 'environmentKey' + '}', environment_key.to_s)

  # query parameters
  query_params = {}
  query_params[:'expiry'] = opts[:'expiry'] if !opts[:'expiry'].nil?

  # header parameters
  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 = {}

  # http body (model)
  post_body = nil
  auth_names = ['Token']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Environment')
  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