Class: LaunchDarklyApi::ApplicationsBetaApi
- Inherits:
-
Object
- Object
- LaunchDarklyApi::ApplicationsBetaApi
- Defined in:
- lib/launchdarkly_api/api/applications_beta_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#delete_application(application_key, opts = {}) ⇒ nil
Delete application Delete an application.
-
#delete_application_version(application_key, version_key, opts = {}) ⇒ nil
Delete application version Delete an application version.
-
#delete_application_version_with_http_info(application_key, version_key, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Delete application version Delete an application version.
-
#delete_application_with_http_info(application_key, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Delete application Delete an application.
-
#get_application(application_key, opts = {}) ⇒ ApplicationRep
Get application by key Retrieve an application by the application key.
-
#get_application_versions(application_key, opts = {}) ⇒ ApplicationVersionsCollectionRep
Get application versions by application key Get a list of versions for a specific application in an account.
-
#get_application_versions_with_http_info(application_key, opts = {}) ⇒ Array<(ApplicationVersionsCollectionRep, Integer, Hash)>
Get application versions by application key Get a list of versions for a specific application in an account.
-
#get_application_with_http_info(application_key, opts = {}) ⇒ Array<(ApplicationRep, Integer, Hash)>
Get application by key Retrieve an application by the application key.
-
#get_applications(opts = {}) ⇒ ApplicationCollectionRep
Get applications Get a list of applications.
-
#get_applications_with_http_info(opts = {}) ⇒ Array<(ApplicationCollectionRep, Integer, Hash)>
Get applications Get a list of applications.
-
#initialize(api_client = ApiClient.default) ⇒ ApplicationsBetaApi
constructor
A new instance of ApplicationsBetaApi.
-
#patch_application(application_key, patch_operation, opts = {}) ⇒ ApplicationRep
Update application Update an application.
-
#patch_application_version(application_key, version_key, patch_operation, opts = {}) ⇒ ApplicationVersionRep
Update application version Update an application version.
-
#patch_application_version_with_http_info(application_key, version_key, patch_operation, opts = {}) ⇒ Array<(ApplicationVersionRep, Integer, Hash)>
Update application version Update an application version.
-
#patch_application_with_http_info(application_key, patch_operation, opts = {}) ⇒ Array<(ApplicationRep, Integer, Hash)>
Update application Update an application.
Constructor Details
#initialize(api_client = ApiClient.default) ⇒ ApplicationsBetaApi
Returns a new instance of ApplicationsBetaApi.
19 20 21 |
# File 'lib/launchdarkly_api/api/applications_beta_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/applications_beta_api.rb', line 17 def api_client @api_client end |
Instance Method Details
#delete_application(application_key, opts = {}) ⇒ nil
Delete application Delete an application.
27 28 29 30 |
# File 'lib/launchdarkly_api/api/applications_beta_api.rb', line 27 def delete_application(application_key, opts = {}) delete_application_with_http_info(application_key, opts) nil end |
#delete_application_version(application_key, version_key, opts = {}) ⇒ nil
Delete application version Delete an application version.
91 92 93 94 |
# File 'lib/launchdarkly_api/api/applications_beta_api.rb', line 91 def delete_application_version(application_key, version_key, opts = {}) delete_application_version_with_http_info(application_key, version_key, opts) nil end |
#delete_application_version_with_http_info(application_key, version_key, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Delete application version Delete an application version.
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 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 |
# File 'lib/launchdarkly_api/api/applications_beta_api.rb', line 102 def delete_application_version_with_http_info(application_key, version_key, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ApplicationsBetaApi.delete_application_version ...' end # verify the required parameter 'application_key' is set if @api_client.config.client_side_validation && application_key.nil? fail ArgumentError, "Missing the required parameter 'application_key' when calling ApplicationsBetaApi.delete_application_version" end # verify the required parameter 'version_key' is set if @api_client.config.client_side_validation && version_key.nil? fail ArgumentError, "Missing the required parameter 'version_key' when calling ApplicationsBetaApi.delete_application_version" end # resource path local_var_path = '/api/v2/applications/{applicationKey}/versions/{versionKey}'.sub('{' + 'applicationKey' + '}', CGI.escape(application_key.to_s)).sub('{' + 'versionKey' + '}', CGI.escape(version_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 => :"ApplicationsBetaApi.delete_application_version", :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: ApplicationsBetaApi#delete_application_version\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#delete_application_with_http_info(application_key, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Delete application Delete an application.
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 79 80 81 82 83 |
# File 'lib/launchdarkly_api/api/applications_beta_api.rb', line 37 def delete_application_with_http_info(application_key, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ApplicationsBetaApi.delete_application ...' end # verify the required parameter 'application_key' is set if @api_client.config.client_side_validation && application_key.nil? fail ArgumentError, "Missing the required parameter 'application_key' when calling ApplicationsBetaApi.delete_application" end # resource path local_var_path = '/api/v2/applications/{applicationKey}'.sub('{' + 'applicationKey' + '}', CGI.escape(application_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 => :"ApplicationsBetaApi.delete_application", :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: ApplicationsBetaApi#delete_application\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_application(application_key, opts = {}) ⇒ ApplicationRep
Get application by key
Retrieve an application by the application key. ### Expanding the application response LaunchDarkly supports expanding the \"Get application\" response to include additional fields. To expand the response, append the `expand` query parameter and include the following: * `flags` includes details on the flags that have been evaluated by the application For example, use `?expand=flags` to include the `flags` field in the response. By default, this field is **not** included in the response.
160 161 162 163 |
# File 'lib/launchdarkly_api/api/applications_beta_api.rb', line 160 def get_application(application_key, opts = {}) data, _status_code, _headers = get_application_with_http_info(application_key, opts) data end |
#get_application_versions(application_key, opts = {}) ⇒ ApplicationVersionsCollectionRep
Get application versions by application key Get a list of versions for a specific application in an account.
229 230 231 232 |
# File 'lib/launchdarkly_api/api/applications_beta_api.rb', line 229 def get_application_versions(application_key, opts = {}) data, _status_code, _headers = get_application_versions_with_http_info(application_key, opts) data end |
#get_application_versions_with_http_info(application_key, opts = {}) ⇒ Array<(ApplicationVersionsCollectionRep, Integer, Hash)>
Get application versions by application key Get a list of versions for a specific application in an account.
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 290 291 292 293 |
# File 'lib/launchdarkly_api/api/applications_beta_api.rb', line 243 def get_application_versions_with_http_info(application_key, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ApplicationsBetaApi.get_application_versions ...' end # verify the required parameter 'application_key' is set if @api_client.config.client_side_validation && application_key.nil? fail ArgumentError, "Missing the required parameter 'application_key' when calling ApplicationsBetaApi.get_application_versions" end # resource path local_var_path = '/api/v2/applications/{applicationKey}/versions'.sub('{' + 'applicationKey' + '}', CGI.escape(application_key.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil? query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil? query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].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] || 'ApplicationVersionsCollectionRep' # auth_names auth_names = opts[:debug_auth_names] || ['ApiKey'] = opts.merge( :operation => :"ApplicationsBetaApi.get_application_versions", :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: ApplicationsBetaApi#get_application_versions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_application_with_http_info(application_key, opts = {}) ⇒ Array<(ApplicationRep, Integer, Hash)>
Get application by key
Retrieve an application by the application key. ### Expanding the application response LaunchDarkly supports expanding the \"Get application\" response to include additional fields. To expand the response, append the `expand` query parameter and include the following: * `flags` includes details on the flags that have been evaluated by the application For example, use `?expand=flags` to include the `flags` field in the response. By default, this field is **not** included in the response.
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 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 |
# File 'lib/launchdarkly_api/api/applications_beta_api.rb', line 171 def get_application_with_http_info(application_key, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ApplicationsBetaApi.get_application ...' end # verify the required parameter 'application_key' is set if @api_client.config.client_side_validation && application_key.nil? fail ArgumentError, "Missing the required parameter 'application_key' when calling ApplicationsBetaApi.get_application" end # resource path local_var_path = '/api/v2/applications/{applicationKey}'.sub('{' + 'applicationKey' + '}', CGI.escape(application_key.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].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] || 'ApplicationRep' # auth_names auth_names = opts[:debug_auth_names] || ['ApiKey'] = opts.merge( :operation => :"ApplicationsBetaApi.get_application", :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: ApplicationsBetaApi#get_application\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_applications(opts = {}) ⇒ ApplicationCollectionRep
Get applications
Get a list of applications. ### Expanding the applications response LaunchDarkly supports expanding the \"Get applications\" response to include additional fields. To expand the response, append the `expand` query parameter and include the following: * `flags` includes details on the flags that have been evaluated by the application For example, use `?expand=flags` to include the `flags` field in the response. By default, this field is **not** included in the response.
304 305 306 307 |
# File 'lib/launchdarkly_api/api/applications_beta_api.rb', line 304 def get_applications(opts = {}) data, _status_code, _headers = get_applications_with_http_info(opts) data end |
#get_applications_with_http_info(opts = {}) ⇒ Array<(ApplicationCollectionRep, Integer, Hash)>
Get applications
Get a list of applications. ### Expanding the applications response LaunchDarkly supports expanding the \"Get applications\" response to include additional fields. To expand the response, append the `expand` query parameter and include the following: * `flags` includes details on the flags that have been evaluated by the application For example, use `?expand=flags` to include the `flags` field in the response. By default, this field is **not** included in the response.
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 360 361 362 363 364 365 |
# File 'lib/launchdarkly_api/api/applications_beta_api.rb', line 318 def get_applications_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ApplicationsBetaApi.get_applications ...' end # resource path local_var_path = '/api/v2/applications' # query parameters query_params = opts[:query_params] || {} query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil? query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil? query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil? query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil? query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].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] || 'ApplicationCollectionRep' # auth_names auth_names = opts[:debug_auth_names] || ['ApiKey'] = opts.merge( :operation => :"ApplicationsBetaApi.get_applications", :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: ApplicationsBetaApi#get_applications\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#patch_application(application_key, patch_operation, opts = {}) ⇒ ApplicationRep
Update application Update an application. You can update the ‘description` and `kind` fields. Requires a [JSON patch](datatracker.ietf.org/doc/html/rfc6902) representation of the desired changes to the application. To learn more, read [Updates](/#section/Overview/Updates).
373 374 375 376 |
# File 'lib/launchdarkly_api/api/applications_beta_api.rb', line 373 def patch_application(application_key, patch_operation, opts = {}) data, _status_code, _headers = patch_application_with_http_info(application_key, patch_operation, opts) data end |
#patch_application_version(application_key, version_key, patch_operation, opts = {}) ⇒ ApplicationVersionRep
Update application version Update an application version. You can update the ‘supported` field. Requires a [JSON patch](datatracker.ietf.org/doc/html/rfc6902) representation of the desired changes to the application version. To learn more, read [Updates](/#section/Overview/Updates).
448 449 450 451 |
# File 'lib/launchdarkly_api/api/applications_beta_api.rb', line 448 def patch_application_version(application_key, version_key, patch_operation, opts = {}) data, _status_code, _headers = patch_application_version_with_http_info(application_key, version_key, patch_operation, opts) data end |
#patch_application_version_with_http_info(application_key, version_key, patch_operation, opts = {}) ⇒ Array<(ApplicationVersionRep, Integer, Hash)>
Update application version Update an application version. You can update the `supported` field. Requires a [JSON patch](datatracker.ietf.org/doc/html/rfc6902) representation of the desired changes to the application version. To learn more, read [Updates](/#section/Overview/Updates).
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 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 |
# File 'lib/launchdarkly_api/api/applications_beta_api.rb', line 460 def patch_application_version_with_http_info(application_key, version_key, patch_operation, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ApplicationsBetaApi.patch_application_version ...' end # verify the required parameter 'application_key' is set if @api_client.config.client_side_validation && application_key.nil? fail ArgumentError, "Missing the required parameter 'application_key' when calling ApplicationsBetaApi.patch_application_version" end # verify the required parameter 'version_key' is set if @api_client.config.client_side_validation && version_key.nil? fail ArgumentError, "Missing the required parameter 'version_key' when calling ApplicationsBetaApi.patch_application_version" 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 ApplicationsBetaApi.patch_application_version" end # resource path local_var_path = '/api/v2/applications/{applicationKey}/versions/{versionKey}'.sub('{' + 'applicationKey' + '}', CGI.escape(application_key.to_s)).sub('{' + 'versionKey' + '}', CGI.escape(version_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] || 'ApplicationVersionRep' # auth_names auth_names = opts[:debug_auth_names] || ['ApiKey'] = opts.merge( :operation => :"ApplicationsBetaApi.patch_application_version", :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: ApplicationsBetaApi#patch_application_version\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#patch_application_with_http_info(application_key, patch_operation, opts = {}) ⇒ Array<(ApplicationRep, Integer, Hash)>
Update application Update an application. You can update the `description` and `kind` fields. Requires a [JSON patch](datatracker.ietf.org/doc/html/rfc6902) representation of the desired changes to the application. To learn more, read [Updates](/#section/Overview/Updates).
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 430 431 432 433 434 435 436 437 438 439 |
# File 'lib/launchdarkly_api/api/applications_beta_api.rb', line 384 def patch_application_with_http_info(application_key, patch_operation, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ApplicationsBetaApi.patch_application ...' end # verify the required parameter 'application_key' is set if @api_client.config.client_side_validation && application_key.nil? fail ArgumentError, "Missing the required parameter 'application_key' when calling ApplicationsBetaApi.patch_application" 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 ApplicationsBetaApi.patch_application" end # resource path local_var_path = '/api/v2/applications/{applicationKey}'.sub('{' + 'applicationKey' + '}', CGI.escape(application_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] || 'ApplicationRep' # auth_names auth_names = opts[:debug_auth_names] || ['ApiKey'] = opts.merge( :operation => :"ApplicationsBetaApi.patch_application", :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: ApplicationsBetaApi#patch_application\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |