launchdarkly_api 5.4.0 → 6.0.0

data/docs/DependentFlagEnvironmentLinks.md

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

data/docs/DependentFlagLinks.md

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

data/docs/DependentFlagsLinks.md

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

data/docs/DestinationAmazonKinesis.md

@@ -1,10 +0,0 @@
-# LaunchDarklyApi::DestinationAmazonKinesis
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**region** | **String** |  | [optional] 
-**role_arn** | **String** |  | [optional] 
-**stream_name** | **String** |  | [optional] 
-
-

data/docs/DestinationBody.md

@@ -1,11 +0,0 @@
-# LaunchDarklyApi::DestinationBody
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**name** | **String** | A human-readable name for your data export destination. | 
-**kind** | **String** | The data export destination type. Available choices are kinesis, google-pubsub, mparticle, or segment. | 
-**config** | **Object** | destination-specific configuration. | 
-**on** | **BOOLEAN** | Whether the data export destination is on or not. | [optional] 
-
-

data/docs/DestinationGooglePubSub.md

@@ -1,9 +0,0 @@
-# LaunchDarklyApi::DestinationGooglePubSub
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**project** | **String** |  | [optional] 
-**topic** | **String** |  | [optional] 
-
-

data/docs/DestinationMParticle.md

@@ -1,11 +0,0 @@
-# LaunchDarklyApi::DestinationMParticle
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**api_key** | **String** |  | [optional] 
-**secret** | **String** |  | [optional] 
-**user_identity** | **String** |  | [optional] 
-**environment** | **String** |  | [optional] 
-
-

data/docs/DestinationSegment.md

@@ -1,8 +0,0 @@
-# LaunchDarklyApi::DestinationSegment
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**write_key** | **String** |  | [optional] 
-
-

data/docs/EnvironmentApprovalSettings.md

@@ -1,13 +0,0 @@
-# LaunchDarklyApi::EnvironmentApprovalSettings
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**service_kind** | **String** | The approvals system used. | [optional] 
-**required** | **BOOLEAN** | Whether any changes to flags in this environment will require approval. You may only set required or requiredApprovalTags, not both. | [optional] 
-**can_review_own_request** | **BOOLEAN** | Whether requesters can approve or decline their own request. They may always comment. | [optional] 
-**min_num_approvals** | **Integer** | The number of approvals required before an approval request can be applied. | [optional] 
-**can_apply_declined_changes** | **BOOLEAN** | Whether changes can be applied as long as minNumApprovals is met, regardless of if any reviewers have declined a request. | [optional] 
-**required_approval_tags** | **Array<String>** | An array of tags used to specify which flags with those tags require approval. You may only set requiredApprovalTags or required, not both. | [optional] 
-
-

data/docs/EvaluationUsageError.md

@@ -1,9 +0,0 @@
-# LaunchDarklyApi::EvaluationUsageError
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**code** | **String** |  | [optional] 
-**message** | **String** |  | [optional] 
-
-

data/docs/Events.md

@@ -1,8 +0,0 @@
-# LaunchDarklyApi::Events
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**links** | [**UsageLinks**](UsageLinks.md) |  | [optional] 
-
-

data/docs/Fallthrough.md

@@ -1,9 +0,0 @@
-# LaunchDarklyApi::Fallthrough
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**variation** | **Integer** |  | [optional] 
-**rollout** | [**Rollout**](Rollout.md) |  | [optional] 
-
-

data/docs/FeatureFlagCopyBody.md

@@ -1,12 +0,0 @@
-# LaunchDarklyApi::FeatureFlagCopyBody
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**source** | [**FeatureFlagCopyObject**](FeatureFlagCopyObject.md) |  | [optional] 
-**target** | [**FeatureFlagCopyObject**](FeatureFlagCopyObject.md) |  | [optional] 
-**comment** | **String** | comment will be included in audit log item for change. | [optional] 
-**included_actions** | [**Array<CopyActions>**](CopyActions.md) | Define the parts of the flag configuration that will be copied. | [optional] 
-**excluded_actions** | [**Array<CopyActions>**](CopyActions.md) | Define the parts of the flag configuration that will not be copied. | [optional] 
-
-

data/docs/FeatureFlagCopyObject.md

@@ -1,9 +0,0 @@
-# LaunchDarklyApi::FeatureFlagCopyObject
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**key** | **String** | The environment key to be used. | 
-**current_version** | **Integer** | If the latest version of the flag matches provided version it will copy, otherwise it will return a conflict. | [optional] 
-
-

data/docs/FeatureFlagScheduledChangesConflicts.md

@@ -1,8 +0,0 @@
-# LaunchDarklyApi::FeatureFlagScheduledChangesConflicts
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**instructions** | [**Array<FeatureFlagScheduledChangesConflictsInstructions>**](FeatureFlagScheduledChangesConflictsInstructions.md) |  | [optional] 
-
-

data/docs/FeatureFlagScheduledChangesConflictsInstructions.md

@@ -1,9 +0,0 @@
-# LaunchDarklyApi::FeatureFlagScheduledChangesConflictsInstructions
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**kind** | **String** | The name of the modification you would like to perform on a resource. | [optional] 
-**conflicts** | [**Array<ScheduledChangesFeatureFlagConflict>**](ScheduledChangesFeatureFlagConflict.md) |  | [optional] 
-
-

data/docs/FeatureFlagStatusForQueriedEnvironment.md

@@ -1,10 +0,0 @@
-# LaunchDarklyApi::FeatureFlagStatusForQueriedEnvironment
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**name** | **String** | | Name     | Description | | --------:| ----------- | | new      | the feature flag was created within the last 7 days, and has not been requested yet | | active   | the feature flag was requested by your servers or clients within the last 7 days | | inactive | the feature flag was created more than 7 days ago, and hasn't been requested by your servers or clients within the past 7 days | | launched | one variation of the feature flag has been rolled out to all your users for at least 7 days |  | [optional] 
-**last_requested** | **String** |  | [optional] 
-**default** | **Object** |  | [optional] 
-
-

data/docs/FeatureFlagStatusLinks.md

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

data/docs/FlagConfigScheduledChangesConflictsBody.md

@@ -1,9 +0,0 @@
-# LaunchDarklyApi::FlagConfigScheduledChangesConflictsBody
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**execution_date** | **Integer** | A unix epoch time in milliseconds specifying the date the scheduled changes will be applied | [optional] 
-**instructions** | [**SemanticPatchInstruction**](SemanticPatchInstruction.md) |  | [optional] 
-
-

data/docs/FlagConfigScheduledChangesPatchBody.md

@@ -1,9 +0,0 @@
-# LaunchDarklyApi::FlagConfigScheduledChangesPatchBody
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**comment** | **String** | Used to describe the scheduled changes. | [optional] 
-**instructions** | [**SemanticPatchInstruction**](SemanticPatchInstruction.md) |  | [optional] 
-
-

data/docs/FlagConfigScheduledChangesPostBody.md

@@ -1,10 +0,0 @@
-# LaunchDarklyApi::FlagConfigScheduledChangesPostBody
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**comment** | **String** | Used to describe the scheduled changes. | [optional] 
-**execution_date** | **Integer** | A unix epoch time in milliseconds specifying the date the scheduled changes will be applied | [optional] 
-**instructions** | [**SemanticPatchInstruction**](SemanticPatchInstruction.md) |  | [optional] 
-
-

data/docs/FlagListItem.md

@@ -1,11 +0,0 @@
-# LaunchDarklyApi::FlagListItem
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**name** | **String** |  | [optional] 
-**key** | **String** |  | [optional] 
-**_links** | [**Links**](Links.md) |  | [optional] 
-**_site** | [**Site**](Site.md) |  | [optional] 
-
-

data/docs/HierarchicalLinks.md

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

data/docs/Id.md

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

data/docs/Integration.md

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

data/docs/IntegrationSubscription.md

@@ -1,16 +0,0 @@
-# LaunchDarklyApi::IntegrationSubscription
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**_links** | [**HierarchicalLinks**](HierarchicalLinks.md) |  | [optional] 
-**_id** | [**Id**](Id.md) |  | [optional] 
-**kind** | **String** | The type of integration associated with this configuration. | [optional] 
-**name** | **String** | The user-defined name associated with this configuration. | [optional] 
-**config** | **Object** | A key-value mapping of configuration fields. | [optional] 
-**statements** | [**Array<Statement>**](Statement.md) |  | [optional] 
-**on** | **BOOLEAN** | Whether or not the integration is currently active. | [optional] 
-**tags** | **Array<String>** | An array of tags for this integration configuration. | [optional] 
-**_status** | [**IntegrationSubscriptionStatus**](IntegrationSubscriptionStatus.md) |  | [optional] 
-
-

data/docs/IntegrationSubscriptionStatus.md

@@ -1,10 +0,0 @@
-# LaunchDarklyApi::IntegrationSubscriptionStatus
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**success_count** | **Integer** |  | [optional] 
-**last_success** | **Integer** | A unix epoch time in milliseconds specifying the last time this integration was successfully used. | [optional] 
-**error_count** | **Integer** |  | [optional] 
-
-

data/docs/Integrations.md

@@ -1,9 +0,0 @@
-# LaunchDarklyApi::Integrations
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**_links** | **Object** | A mapping of integration types to their respective API endpoints. | [optional] 
-**items** | [**Array<IntegrationSubscription>**](IntegrationSubscription.md) |  | [optional] 
-
-

data/docs/IntegrationsApi.md

@@ -1,334 +0,0 @@
-# LaunchDarklyApi::IntegrationsApi
-
-All URIs are relative to *https://app.launchdarkly.com/api/v2*
-
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**delete_integration_subscription**](IntegrationsApi.md#delete_integration_subscription) | **DELETE** /integrations/{integrationKey}/{integrationId} | Delete an integration subscription by ID.
-[**get_integration_subscription**](IntegrationsApi.md#get_integration_subscription) | **GET** /integrations/{integrationKey}/{integrationId} | Get a single integration subscription by ID.
-[**get_integration_subscriptions**](IntegrationsApi.md#get_integration_subscriptions) | **GET** /integrations/{integrationKey} | Get a list of all configured integrations of a given kind.
-[**get_integrations**](IntegrationsApi.md#get_integrations) | **GET** /integrations | Get a list of all configured audit log event integrations associated with this account.
-[**patch_integration_subscription**](IntegrationsApi.md#patch_integration_subscription) | **PATCH** /integrations/{integrationKey}/{integrationId} | Modify an integration subscription by ID.
-[**post_integration_subscription**](IntegrationsApi.md#post_integration_subscription) | **POST** /integrations/{integrationKey} | Create a new integration subscription of a given kind.
-
-
-# **delete_integration_subscription**
-> delete_integration_subscription(integration_key, integration_id, )
-
-Delete an integration subscription by ID.
-
-### 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::IntegrationsApi.new
-
-integration_key = 'integration_key_example' # String | The key used to specify the integration kind.
-
-integration_id = 'integration_id_example' # String | The integration ID.
-
-
-begin
-  #Delete an integration subscription by ID.
-  api_instance.delete_integration_subscription(integration_key, integration_id, )
-rescue LaunchDarklyApi::ApiError => e
-  puts "Exception when calling IntegrationsApi->delete_integration_subscription: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **integration_key** | **String**| The key used to specify the integration kind. | 
- **integration_id** | **String**| The integration ID. | 
-
-### Return type
-
-nil (empty response body)
-
-### Authorization
-
-[Token](../README.md#Token)
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-
-# **get_integration_subscription**
-> IntegrationSubscription get_integration_subscription(integration_key, integration_id, )
-
-Get a single integration subscription by ID.
-
-### 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::IntegrationsApi.new
-
-integration_key = 'integration_key_example' # String | The key used to specify the integration kind.
-
-integration_id = 'integration_id_example' # String | The integration ID.
-
-
-begin
-  #Get a single integration subscription by ID.
-  result = api_instance.get_integration_subscription(integration_key, integration_id, )
-  p result
-rescue LaunchDarklyApi::ApiError => e
-  puts "Exception when calling IntegrationsApi->get_integration_subscription: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **integration_key** | **String**| The key used to specify the integration kind. | 
- **integration_id** | **String**| The integration ID. | 
-
-### Return type
-
-[**IntegrationSubscription**](IntegrationSubscription.md)
-
-### Authorization
-
-[Token](../README.md#Token)
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-
-# **get_integration_subscriptions**
-> Integration get_integration_subscriptions(integration_key, )
-
-Get a list of all configured integrations of a given kind.
-
-### 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::IntegrationsApi.new
-
-integration_key = 'integration_key_example' # String | The key used to specify the integration kind.
-
-
-begin
-  #Get a list of all configured integrations of a given kind.
-  result = api_instance.get_integration_subscriptions(integration_key, )
-  p result
-rescue LaunchDarklyApi::ApiError => e
-  puts "Exception when calling IntegrationsApi->get_integration_subscriptions: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **integration_key** | **String**| The key used to specify the integration kind. | 
-
-### Return type
-
-[**Integration**](Integration.md)
-
-### Authorization
-
-[Token](../README.md#Token)
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-
-# **get_integrations**
-> Integrations get_integrations
-
-Get a list of all configured audit log event integrations associated with this account.
-
-### 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::IntegrationsApi.new
-
-begin
-  #Get a list of all configured audit log event integrations associated with this account.
-  result = api_instance.get_integrations
-  p result
-rescue LaunchDarklyApi::ApiError => e
-  puts "Exception when calling IntegrationsApi->get_integrations: #{e}"
-end
-```
-
-### Parameters
-This endpoint does not need any parameter.
-
-### Return type
-
-[**Integrations**](Integrations.md)
-
-### Authorization
-
-[Token](../README.md#Token)
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-
-# **patch_integration_subscription**
-> IntegrationSubscription patch_integration_subscription(integration_key, integration_id, patch_delta)
-
-Modify an integration subscription by ID.
-
-### 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::IntegrationsApi.new
-
-integration_key = 'integration_key_example' # String | The key used to specify the integration kind.
-
-integration_id = 'integration_id_example' # String | The integration ID.
-
-patch_delta = [LaunchDarklyApi::PatchOperation.new] # Array<PatchOperation> | Requires a JSON Patch representation of the desired changes to the project. 'http://jsonpatch.com/'
-
-
-begin
-  #Modify an integration subscription by ID.
-  result = api_instance.patch_integration_subscription(integration_key, integration_id, patch_delta)
-  p result
-rescue LaunchDarklyApi::ApiError => e
-  puts "Exception when calling IntegrationsApi->patch_integration_subscription: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **integration_key** | **String**| The key used to specify the integration kind. | 
- **integration_id** | **String**| The integration ID. | 
- **patch_delta** | [**Array&lt;PatchOperation&gt;**](PatchOperation.md)| Requires a JSON Patch representation of the desired changes to the project. &#39;http://jsonpatch.com/&#39; | 
-
-### Return type
-
-[**IntegrationSubscription**](IntegrationSubscription.md)
-
-### Authorization
-
-[Token](../README.md#Token)
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-
-# **post_integration_subscription**
-> IntegrationSubscription post_integration_subscription(integration_key, subscription_body)
-
-Create a new integration subscription of a given kind.
-
-### 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::IntegrationsApi.new
-
-integration_key = 'integration_key_example' # String | The key used to specify the integration kind.
-
-subscription_body = LaunchDarklyApi::SubscriptionBody.new # SubscriptionBody | Create a new integration subscription.
-
-
-begin
-  #Create a new integration subscription of a given kind.
-  result = api_instance.post_integration_subscription(integration_key, subscription_body)
-  p result
-rescue LaunchDarklyApi::ApiError => e
-  puts "Exception when calling IntegrationsApi->post_integration_subscription: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **integration_key** | **String**| The key used to specify the integration kind. | 
- **subscription_body** | [**SubscriptionBody**](SubscriptionBody.md)| Create a new integration subscription. | 
-
-### Return type
-
-[**IntegrationSubscription**](IntegrationSubscription.md)
-
-### Authorization
-
-[Token](../README.md#Token)
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-