Class: LaunchDarklyApi::EnvironmentsApi
- Inherits:
-
Object
- Object
- LaunchDarklyApi::EnvironmentsApi
- Defined in:
- lib/launchdarkly_api/api/environments_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#delete_environment(project_key, environment_key, opts = {}) ⇒ nil
Delete environment Delete a environment by key.
-
#delete_environment_with_http_info(project_key, environment_key, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Delete environment Delete a environment by key.
-
#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_environment_with_http_info(project_key, environment_key, opts = {}) ⇒ Array<(Environment, Integer, Hash)>
Get environment > ### Approval settings > > The `approvalSettings` key is only returned when the Flag Approvals feature is enabled.
-
#initialize(api_client = ApiClient.default) ⇒ EnvironmentsApi
constructor
A new instance of EnvironmentsApi.
-
#patch_environment(project_key, environment_key, patch_operation, opts = {}) ⇒ Environment
Update environment Update an environment.
-
#patch_environment_with_http_info(project_key, environment_key, patch_operation, opts = {}) ⇒ Array<(Environment, Integer, Hash)>
Update environment Update an environment.
-
#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.
-
#post_environment_with_http_info(project_key, environment_post, opts = {}) ⇒ Array<(Environment, Integer, Hash)>
Create environment > ### Approval settings > > The `approvalSettings` key is only returned when the Flag Approvals feature is enabled.
-
#reset_environment_mobile_key(project_key, env_key, opts = {}) ⇒ Environment
Reset environment mobile SDK key Reset an environment’s mobile key.
-
#reset_environment_mobile_key_with_http_info(project_key, env_key, opts = {}) ⇒ Array<(Environment, Integer, Hash)>
Reset environment mobile SDK key Reset an environment's mobile key.
-
#reset_environment_sdk_key(project_key, env_key, opts = {}) ⇒ Environment
Reset environment SDK key Reset an environment’s SDK key with an optional expiry time for the old key.
-
#reset_environment_sdk_key_with_http_info(project_key, env_key, opts = {}) ⇒ Array<(Environment, Integer, Hash)>
Reset environment SDK key Reset an environment's SDK key with an optional expiry time for the old key.
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.
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.
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'] = 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, ) 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.
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 > ### Approval settings > > The `approvalSettings` key is only returned when the Flag Approvals feature is enabled. Get an environment given a project and key.
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'] = 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, ) 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_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. Only customers on a Pro or Enterprise plan can require approval for flag updates by either mechanism.
167 168 169 170 |
# File 'lib/launchdarkly_api/api/environments_api.rb', line 167 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 `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. Only customers on a Pro or Enterprise plan can require approval for flag updates by either mechanism.
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 225 226 227 228 229 230 231 232 233 234 235 236 237 238 |
# File 'lib/launchdarkly_api/api/environments_api.rb', line 179 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'] = 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, ) 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.
246 247 248 249 |
# File 'lib/launchdarkly_api/api/environments_api.rb', line 246 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 > ### 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.
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 |
# File 'lib/launchdarkly_api/api/environments_api.rb', line 257 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'] = 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, ) 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, env_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.
320 321 322 323 |
# File 'lib/launchdarkly_api/api/environments_api.rb', line 320 def reset_environment_mobile_key(project_key, env_key, opts = {}) data, _status_code, _headers = reset_environment_mobile_key_with_http_info(project_key, env_key, opts) data end |
#reset_environment_mobile_key_with_http_info(project_key, env_key, opts = {}) ⇒ Array<(Environment, Integer, Hash)>
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.
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 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 |
# File 'lib/launchdarkly_api/api/environments_api.rb', line 331 def reset_environment_mobile_key_with_http_info(project_key, env_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 'env_key' is set if @api_client.config.client_side_validation && env_key.nil? fail ArgumentError, "Missing the required parameter 'env_key' when calling EnvironmentsApi.reset_environment_mobile_key" end # resource path local_var_path = '/api/v2/projects/{projectKey}/environments/{envKey}/mobileKey'.sub('{' + 'projectKey' + '}', CGI.escape(project_key.to_s)).sub('{' + 'envKey' + '}', CGI.escape(env_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'] = 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, ) 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, env_key, opts = {}) ⇒ Environment
Reset environment SDK key Reset an environment’s SDK key with an optional expiry time for the old key.
390 391 392 393 |
# File 'lib/launchdarkly_api/api/environments_api.rb', line 390 def reset_environment_sdk_key(project_key, env_key, opts = {}) data, _status_code, _headers = reset_environment_sdk_key_with_http_info(project_key, env_key, opts) data end |
#reset_environment_sdk_key_with_http_info(project_key, env_key, opts = {}) ⇒ Array<(Environment, Integer, Hash)>
Reset environment SDK key Reset an environment's SDK key with an optional expiry time for the old key.
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 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 |
# File 'lib/launchdarkly_api/api/environments_api.rb', line 402 def reset_environment_sdk_key_with_http_info(project_key, env_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 'env_key' is set if @api_client.config.client_side_validation && env_key.nil? fail ArgumentError, "Missing the required parameter 'env_key' when calling EnvironmentsApi.reset_environment_sdk_key" end # resource path local_var_path = '/api/v2/projects/{projectKey}/environments/{envKey}/apiKey'.sub('{' + 'projectKey' + '}', CGI.escape(project_key.to_s)).sub('{' + 'envKey' + '}', CGI.escape(env_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'] = 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, ) 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 |