launchdarkly_api 3.7.1 → 3.10.0

data/docs/FeatureFlagChangeRequest.md

@@ -0,0 +1,19 @@
+# LaunchDarklyApi::FeatureFlagChangeRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**_id** | [**Id**](Id.md) |  | [optional] 
+**_version** | **Integer** |  | [optional] 
+**creation_date** | **Integer** | A unix epoch time in milliseconds specifying the date the change request was requested | [optional] 
+**requestor_id** | **String** | The id of the member that requested the change | [optional] 
+**review_status** | [**FeatureFlagChangeRequestReviewStatus**](FeatureFlagChangeRequestReviewStatus.md) |  | [optional] 
+**status** | **String** | | Name     | Description | | --------:| ----------- | | pending  | the feature flag change request has not been applied yet | | completed| the feature flag change request has been applied successfully | | failed   | the feature flag change request has been applied but the changes were not applied successfully |  | [optional] 
+**applied_by_member_id** | **String** | The id of the member that applied the change request | [optional] 
+**applied_date** | **Integer** | A unix epoch time in milliseconds specifying the date the change request was applied | [optional] 
+**current_reviews_by_member_id** | [**FeatureFlagChangeRequestReview**](FeatureFlagChangeRequestReview.md) |  | [optional] 
+**all_reviews** | [**Array<FeatureFlagChangeRequestReview>**](FeatureFlagChangeRequestReview.md) |  | [optional] 
+**notify_member_ids** | **Array<String>** |  | [optional] 
+**instructions** | [**SemanticPatchInstruction**](SemanticPatchInstruction.md) |  | [optional] 
+
+

data/docs/FeatureFlagChangeRequestApplyConfigBody.md

@@ -0,0 +1,8 @@
+# LaunchDarklyApi::FeatureFlagChangeRequestApplyConfigBody
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**comment** | **String** | comment will be included in audit log item for change. | [optional] 
+
+

data/docs/FeatureFlagChangeRequestConfigBody.md

@@ -0,0 +1,11 @@
+# LaunchDarklyApi::FeatureFlagChangeRequestConfigBody
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**description** | **String** | A name that describes the changes you would like to apply to a feature flag configuration | 
+**instructions** | [**SemanticPatchInstruction**](SemanticPatchInstruction.md) |  | 
+**notify_member_ids** | **Array<String>** |  | 
+**comment** | **String** | comment will be included in audit log item for change. | [optional] 
+
+

data/docs/FeatureFlagChangeRequestReview.md

@@ -0,0 +1,11 @@
+# LaunchDarklyApi::FeatureFlagChangeRequestReview
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**creation_date** | **Integer** | A unix epoch time in milliseconds specifying the date the change request was reviewed | [optional] 
+**kind** | [**FeatureFlagChangeRequestReviewStatus**](FeatureFlagChangeRequestReviewStatus.md) |  | [optional] 
+**member_id** | [**Id**](Id.md) |  | [optional] 
+**_id** | [**Id**](Id.md) |  | [optional] 
+
+

data/docs/FeatureFlagChangeRequestReviewConfigBody.md

@@ -0,0 +1,9 @@
+# LaunchDarklyApi::FeatureFlagChangeRequestReviewConfigBody
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**kind** | **String** | Either approve or decline change request | 
+**comment** | **String** | comment will be included in audit log item for change. | [optional] 
+
+

data/docs/FeatureFlagChangeRequestReviewStatus.md

@@ -0,0 +1,7 @@
+# LaunchDarklyApi::FeatureFlagChangeRequestReviewStatus
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+

data/docs/FeatureFlagChangeRequests.md

@@ -0,0 +1,9 @@
+# LaunchDarklyApi::FeatureFlagChangeRequests
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**_links** | [**Links**](Links.md) |  | [optional] 
+**items** | [**Array<FeatureFlagChangeRequest>**](FeatureFlagChangeRequest.md) |  | [optional] 
+
+

data/docs/FeatureFlagConfig.md

@@ -16,5 +16,7 @@ Name | Type | Description | Notes
 **prerequisites** | [**Array<Prerequisite>**](Prerequisite.md) |  | [optional] 
 **track_events** | **BOOLEAN** | Set to true to send detailed event information for this flag. | [optional] 
 **track_events_fallthrough** | **BOOLEAN** | Set to true to send detailed event information when targeting is enabled but no individual targeting rule is matched. | [optional] 
+**_site** | [**Site**](Site.md) |  | [optional] 
+**_environment_name** | **String** |  | [optional] 
 
 

data/docs/FeatureFlagsApi.md

@@ -8,13 +8,18 @@ Method | HTTP request | Description
 [**delete_feature_flag**](FeatureFlagsApi.md#delete_feature_flag) | **DELETE** /flags/{projectKey}/{featureFlagKey} | Delete a feature flag in all environments. Be careful-- only delete feature flags that are no longer being used by your application.
 [**get_expiring_user_targets**](FeatureFlagsApi.md#get_expiring_user_targets) | **GET** /flags/{projectKey}/{featureFlagKey}/expiring-user-targets/{environmentKey} | Get expiring user targets for feature flag
 [**get_feature_flag**](FeatureFlagsApi.md#get_feature_flag) | **GET** /flags/{projectKey}/{featureFlagKey} | Get a single feature flag by key.
+[**get_feature_flag_change_request**](FeatureFlagsApi.md#get_feature_flag_change_request) | **GET** /projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/approval-requests/{featureFlagChangeRequestId} | Get a single change request for a feature flag
+[**get_feature_flag_change_requests**](FeatureFlagsApi.md#get_feature_flag_change_requests) | **GET** /{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/approval-requests | Get all change requests for a feature flag
 [**get_feature_flag_status**](FeatureFlagsApi.md#get_feature_flag_status) | **GET** /flag-statuses/{projectKey}/{environmentKey}/{featureFlagKey} | Get the status for a particular feature flag.
 [**get_feature_flag_status_across_environments**](FeatureFlagsApi.md#get_feature_flag_status_across_environments) | **GET** /flag-status/{projectKey}/{featureFlagKey} | Get the status for a particular feature flag across environments
 [**get_feature_flag_statuses**](FeatureFlagsApi.md#get_feature_flag_statuses) | **GET** /flag-statuses/{projectKey}/{environmentKey} | Get a list of statuses for all feature flags. The status includes the last time the feature flag was requested, as well as the state of the flag.
 [**get_feature_flags**](FeatureFlagsApi.md#get_feature_flags) | **GET** /flags/{projectKey} | Get a list of all features in the given project.
 [**patch_expiring_user_targets**](FeatureFlagsApi.md#patch_expiring_user_targets) | **PATCH** /flags/{projectKey}/{featureFlagKey}/expiring-user-targets/{environmentKey} | Update, add, or delete expiring user targets on feature flag
 [**patch_feature_flag**](FeatureFlagsApi.md#patch_feature_flag) | **PATCH** /flags/{projectKey}/{featureFlagKey} | Perform a partial update to a feature.
+[**post_apply_feature_flag_change_request**](FeatureFlagsApi.md#post_apply_feature_flag_change_request) | **POST** /projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/approval-requests/{featureFlagChangeRequestId}/apply | Apply change request for a feature flag
 [**post_feature_flag**](FeatureFlagsApi.md#post_feature_flag) | **POST** /flags/{projectKey} | Creates a new feature flag.
+[**post_feature_flag_change_request**](FeatureFlagsApi.md#post_feature_flag_change_request) | **POST** /{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/approval-requests | 
+[**post_review_feature_flag_change_request**](FeatureFlagsApi.md#post_review_feature_flag_change_request) | **POST** /projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/approval-requests/{featureFlagChangeRequestId}/review | Review change request for a feature flag
 
 
 # **copy_feature_flag**
@@ -246,6 +251,125 @@ Name | Type | Description  | Notes
 
 
 
+# **get_feature_flag_change_request**
+> FeatureFlagChangeRequests get_feature_flag_change_request(project_key, feature_flag_key, environment_key, feature_flag_change_request_id, )
+
+Get a single change request for a feature flag
+
+### Example
+```ruby
+# load the gem
+require 'launchdarkly_api'
+# setup authorization
+LaunchDarklyApi.configure do |config|
+  # Configure API key authorization: Token
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = LaunchDarklyApi::FeatureFlagsApi.new
+
+project_key = 'project_key_example' # String | The project key, used to tie the flags together under one project so they can be managed together.
+
+feature_flag_key = 'feature_flag_key_example' # String | The feature flag's key. The key identifies the flag in your code.
+
+environment_key = 'environment_key_example' # String | The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
+
+feature_flag_change_request_id = 'feature_flag_change_request_id_example' # String | The feature flag change request ID
+
+
+begin
+  #Get a single change request for a feature flag
+  result = api_instance.get_feature_flag_change_request(project_key, feature_flag_key, environment_key, feature_flag_change_request_id, )
+  p result
+rescue LaunchDarklyApi::ApiError => e
+  puts "Exception when calling FeatureFlagsApi->get_feature_flag_change_request: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **project_key** | **String**| The project key, used to tie the flags together under one project so they can be managed together. | 
+ **feature_flag_key** | **String**| The feature flag's key. The key identifies the flag in your code. | 
+ **environment_key** | **String**| The environment key, used to tie together flag configuration and users under one environment so they can be managed together. | 
+ **feature_flag_change_request_id** | **String**| The feature flag change request ID | 
+
+### Return type
+
+[**FeatureFlagChangeRequests**](FeatureFlagChangeRequests.md)
+
+### Authorization
+
+[Token](../README.md#Token)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_feature_flag_change_requests**
+> FeatureFlagChangeRequests get_feature_flag_change_requests(project_key, feature_flag_key, environment_key, )
+
+Get all change requests for a feature flag
+
+### Example
+```ruby
+# load the gem
+require 'launchdarkly_api'
+# setup authorization
+LaunchDarklyApi.configure do |config|
+  # Configure API key authorization: Token
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = LaunchDarklyApi::FeatureFlagsApi.new
+
+project_key = 'project_key_example' # String | The project key, used to tie the flags together under one project so they can be managed together.
+
+feature_flag_key = 'feature_flag_key_example' # String | The feature flag's key. The key identifies the flag in your code.
+
+environment_key = 'environment_key_example' # String | The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
+
+
+begin
+  #Get all change requests for a feature flag
+  result = api_instance.get_feature_flag_change_requests(project_key, feature_flag_key, environment_key, )
+  p result
+rescue LaunchDarklyApi::ApiError => e
+  puts "Exception when calling FeatureFlagsApi->get_feature_flag_change_requests: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **project_key** | **String**| The project key, used to tie the flags together under one project so they can be managed together. | 
+ **feature_flag_key** | **String**| The feature flag's key. The key identifies the flag in your code. | 
+ **environment_key** | **String**| The environment key, used to tie together flag configuration and users under one environment so they can be managed together. | 
+
+### Return type
+
+[**FeatureFlagChangeRequests**](FeatureFlagChangeRequests.md)
+
+### Authorization
+
+[Token](../README.md#Token)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 # **get_feature_flag_status**
 > FeatureFlagStatus get_feature_flag_status(project_key, environment_key, feature_flag_key, )
 
@@ -603,6 +727,70 @@ Name | Type | Description  | Notes
 
 
 
+# **post_apply_feature_flag_change_request**
+> FeatureFlagChangeRequests post_apply_feature_flag_change_request(project_key, feature_flag_key, environment_key, feature_flag_change_request_id, feature_flag_change_request_apply_config_body)
+
+Apply change request for a feature flag
+
+### Example
+```ruby
+# load the gem
+require 'launchdarkly_api'
+# setup authorization
+LaunchDarklyApi.configure do |config|
+  # Configure API key authorization: Token
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = LaunchDarklyApi::FeatureFlagsApi.new
+
+project_key = 'project_key_example' # String | The project key, used to tie the flags together under one project so they can be managed together.
+
+feature_flag_key = 'feature_flag_key_example' # String | The feature flag's key. The key identifies the flag in your code.
+
+environment_key = 'environment_key_example' # String | The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
+
+feature_flag_change_request_id = 'feature_flag_change_request_id_example' # String | The feature flag change request ID
+
+feature_flag_change_request_apply_config_body = LaunchDarklyApi::FeatureFlagChangeRequestApplyConfigBody.new # FeatureFlagChangeRequestApplyConfigBody | Apply a new feature flag change request
+
+
+begin
+  #Apply change request for a feature flag
+  result = api_instance.post_apply_feature_flag_change_request(project_key, feature_flag_key, environment_key, feature_flag_change_request_id, feature_flag_change_request_apply_config_body)
+  p result
+rescue LaunchDarklyApi::ApiError => e
+  puts "Exception when calling FeatureFlagsApi->post_apply_feature_flag_change_request: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **project_key** | **String**| The project key, used to tie the flags together under one project so they can be managed together. | 
+ **feature_flag_key** | **String**| The feature flag's key. The key identifies the flag in your code. | 
+ **environment_key** | **String**| The environment key, used to tie together flag configuration and users under one environment so they can be managed together. | 
+ **feature_flag_change_request_id** | **String**| The feature flag change request ID | 
+ **feature_flag_change_request_apply_config_body** | [**FeatureFlagChangeRequestApplyConfigBody**](FeatureFlagChangeRequestApplyConfigBody.md)| Apply a new feature flag change request | 
+
+### Return type
+
+[**FeatureFlagChangeRequests**](FeatureFlagChangeRequests.md)
+
+### Authorization
+
+[Token](../README.md#Token)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 # **post_feature_flag**
 > FeatureFlag post_feature_flag(project_key, feature_flag_body, opts)
 
@@ -662,3 +850,128 @@ Name | Type | Description  | Notes
 
 
 
+# **post_feature_flag_change_request**
+> FeatureFlagChangeRequest post_feature_flag_change_request(project_key, feature_flag_key, environment_key, , opts)
+
+
+
+### Example
+```ruby
+# load the gem
+require 'launchdarkly_api'
+# setup authorization
+LaunchDarklyApi.configure do |config|
+  # Configure API key authorization: Token
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = LaunchDarklyApi::FeatureFlagsApi.new
+
+project_key = 'project_key_example' # String | The project key, used to tie the flags together under one project so they can be managed together.
+
+feature_flag_key = 'feature_flag_key_example' # String | The feature flag's key. The key identifies the flag in your code.
+
+environment_key = 'environment_key_example' # String | The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
+
+opts = { 
+  feature_flag_change_request_config_body: LaunchDarklyApi::FeatureFlagChangeRequestConfigBody.new # FeatureFlagChangeRequestConfigBody | Create a new feature flag change request
+}
+
+begin
+  result = api_instance.post_feature_flag_change_request(project_key, feature_flag_key, environment_key, , opts)
+  p result
+rescue LaunchDarklyApi::ApiError => e
+  puts "Exception when calling FeatureFlagsApi->post_feature_flag_change_request: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **project_key** | **String**| The project key, used to tie the flags together under one project so they can be managed together. | 
+ **feature_flag_key** | **String**| The feature flag's key. The key identifies the flag in your code. | 
+ **environment_key** | **String**| The environment key, used to tie together flag configuration and users under one environment so they can be managed together. | 
+ **feature_flag_change_request_config_body** | [**FeatureFlagChangeRequestConfigBody**](FeatureFlagChangeRequestConfigBody.md)| Create a new feature flag change request | [optional] 
+
+### Return type
+
+[**FeatureFlagChangeRequest**](FeatureFlagChangeRequest.md)
+
+### Authorization
+
+[Token](../README.md#Token)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **post_review_feature_flag_change_request**
+> FeatureFlagChangeRequests post_review_feature_flag_change_request(project_key, feature_flag_key, environment_key, feature_flag_change_request_id, feature_flag_change_request_review_config_body)
+
+Review change request for a feature flag
+
+### Example
+```ruby
+# load the gem
+require 'launchdarkly_api'
+# setup authorization
+LaunchDarklyApi.configure do |config|
+  # Configure API key authorization: Token
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = LaunchDarklyApi::FeatureFlagsApi.new
+
+project_key = 'project_key_example' # String | The project key, used to tie the flags together under one project so they can be managed together.
+
+feature_flag_key = 'feature_flag_key_example' # String | The feature flag's key. The key identifies the flag in your code.
+
+environment_key = 'environment_key_example' # String | The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
+
+feature_flag_change_request_id = 'feature_flag_change_request_id_example' # String | The feature flag change request ID
+
+feature_flag_change_request_review_config_body = LaunchDarklyApi::FeatureFlagChangeRequestReviewConfigBody.new # FeatureFlagChangeRequestReviewConfigBody | Review a feature flag change request
+
+
+begin
+  #Review change request for a feature flag
+  result = api_instance.post_review_feature_flag_change_request(project_key, feature_flag_key, environment_key, feature_flag_change_request_id, feature_flag_change_request_review_config_body)
+  p result
+rescue LaunchDarklyApi::ApiError => e
+  puts "Exception when calling FeatureFlagsApi->post_review_feature_flag_change_request: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **project_key** | **String**| The project key, used to tie the flags together under one project so they can be managed together. | 
+ **feature_flag_key** | **String**| The feature flag's key. The key identifies the flag in your code. | 
+ **environment_key** | **String**| The environment key, used to tie together flag configuration and users under one environment so they can be managed together. | 
+ **feature_flag_change_request_id** | **String**| The feature flag change request ID | 
+ **feature_flag_change_request_review_config_body** | [**FeatureFlagChangeRequestReviewConfigBody**](FeatureFlagChangeRequestReviewConfigBody.md)| Review a feature flag change request | 
+
+### Return type
+
+[**FeatureFlagChangeRequests**](FeatureFlagChangeRequests.md)
+
+### Authorization
+
+[Token](../README.md#Token)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/HierarchicalLinks.md

@@ -0,0 +1,9 @@
+# LaunchDarklyApi::HierarchicalLinks
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**parent** | [**Link**](Link.md) |  | [optional] 
+**_self** | [**Link**](Link.md) |  | [optional] 
+
+

data/docs/Integration.md

@@ -0,0 +1,9 @@
+# LaunchDarklyApi::Integration
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**_links** | [**IntegrationLinks**](IntegrationLinks.md) |  | [optional] 
+**items** | [**Array<IntegrationSubscription>**](IntegrationSubscription.md) |  | [optional] 
+
+