launchdarkly_api 2.0.10 → 2.0.27

data/docs/DataExportDestinationsApi.md

@@ -0,0 +1,293 @@
+# LaunchDarklyApi::DataExportDestinationsApi
+
+All URIs are relative to *https://app.launchdarkly.com/api/v2*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**delete_destination**](DataExportDestinationsApi.md#delete_destination) | **DELETE** /destinations/{projectKey}/{environmentKey}/{destinationId} | Get a single data export destination by ID
+[**get_destination**](DataExportDestinationsApi.md#get_destination) | **GET** /destinations/{projectKey}/{environmentKey}/{destinationId} | Get a single data export destination by ID
+[**get_destinations**](DataExportDestinationsApi.md#get_destinations) | **GET** /destinations | Returns a list of all data export destinations.
+[**patch_destination**](DataExportDestinationsApi.md#patch_destination) | **PATCH** /destinations/{projectKey}/{environmentKey}/{destinationId} | Perform a partial update to a data export destination.
+[**post_destination**](DataExportDestinationsApi.md#post_destination) | **POST** /destinations/{projectKey}/{environmentKey} | Create a new data export destination
+
+
+# **delete_destination**
+> delete_destination(project_key, environment_key, destination_id, )
+
+Get a single data export destination 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::DataExportDestinationsApi.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.
+
+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.
+
+destination_id = 'destination_id_example' # String | The data export destination ID.
+
+
+begin
+  #Get a single data export destination by ID
+  api_instance.delete_destination(project_key, environment_key, destination_id, )
+rescue LaunchDarklyApi::ApiError => e
+  puts "Exception when calling DataExportDestinationsApi->delete_destination: #{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. | 
+ **environment_key** | **String**| The environment key, used to tie together flag configuration and users under one environment so they can be managed together. | 
+ **destination_id** | **String**| The data export destination ID. | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[Token](../README.md#Token)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_destination**
+> Destination get_destination(project_key, environment_key, destination_id, )
+
+Get a single data export destination 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::DataExportDestinationsApi.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.
+
+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.
+
+destination_id = 'destination_id_example' # String | The data export destination ID.
+
+
+begin
+  #Get a single data export destination by ID
+  result = api_instance.get_destination(project_key, environment_key, destination_id, )
+  p result
+rescue LaunchDarklyApi::ApiError => e
+  puts "Exception when calling DataExportDestinationsApi->get_destination: #{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. | 
+ **environment_key** | **String**| The environment key, used to tie together flag configuration and users under one environment so they can be managed together. | 
+ **destination_id** | **String**| The data export destination ID. | 
+
+### Return type
+
+[**Destination**](Destination.md)
+
+### Authorization
+
+[Token](../README.md#Token)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_destinations**
+> Destinations get_destinations
+
+Returns a list of all data export destinations.
+
+### 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::DataExportDestinationsApi.new
+
+begin
+  #Returns a list of all data export destinations.
+  result = api_instance.get_destinations
+  p result
+rescue LaunchDarklyApi::ApiError => e
+  puts "Exception when calling DataExportDestinationsApi->get_destinations: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**Destinations**](Destinations.md)
+
+### Authorization
+
+[Token](../README.md#Token)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **patch_destination**
+> Destination patch_destination(project_key, environment_key, destination_id, patch_only)
+
+Perform a partial update to a data export destination.
+
+### 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::DataExportDestinationsApi.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.
+
+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.
+
+destination_id = 'destination_id_example' # String | The data export destination ID.
+
+patch_only = [LaunchDarklyApi::PatchOperation.new] # Array<PatchOperation> | Requires a JSON Patch representation of the desired changes to the project. 'http://jsonpatch.com/' Feature flag patches also support JSON Merge Patch format. 'https://tools.ietf.org/html/rfc7386' The addition of comments is also supported.
+
+
+begin
+  #Perform a partial update to a data export destination.
+  result = api_instance.patch_destination(project_key, environment_key, destination_id, patch_only)
+  p result
+rescue LaunchDarklyApi::ApiError => e
+  puts "Exception when calling DataExportDestinationsApi->patch_destination: #{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. | 
+ **environment_key** | **String**| The environment key, used to tie together flag configuration and users under one environment so they can be managed together. | 
+ **destination_id** | **String**| The data export destination ID. | 
+ **patch_only** | [**Array&lt;PatchOperation&gt;**](PatchOperation.md)| Requires a JSON Patch representation of the desired changes to the project. &#39;http://jsonpatch.com/&#39; Feature flag patches also support JSON Merge Patch format. &#39;https://tools.ietf.org/html/rfc7386&#39; The addition of comments is also supported. | 
+
+### Return type
+
+[**Destination**](Destination.md)
+
+### Authorization
+
+[Token](../README.md#Token)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **post_destination**
+> Destination post_destination(project_key, environment_key, destination_body)
+
+Create a new data export destination
+
+### 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::DataExportDestinationsApi.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.
+
+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.
+
+destination_body = LaunchDarklyApi::DestinationBody.new # DestinationBody | Create a new data export destination.
+
+
+begin
+  #Create a new data export destination
+  result = api_instance.post_destination(project_key, environment_key, destination_body)
+  p result
+rescue LaunchDarklyApi::ApiError => e
+  puts "Exception when calling DataExportDestinationsApi->post_destination: #{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. | 
+ **environment_key** | **String**| The environment key, used to tie together flag configuration and users under one environment so they can be managed together. | 
+ **destination_body** | [**DestinationBody**](DestinationBody.md)| Create a new data export destination. | 
+
+### Return type
+
+[**Destination**](Destination.md)
+
+### Authorization
+
+[Token](../README.md#Token)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/Destination.md

@@ -0,0 +1,14 @@
+# LaunchDarklyApi::Destination
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**_links** | [**Links**](Links.md) |  | [optional] 
+**_id** | **String** | Unique destination ID. | [optional] 
+**name** | **String** | The destination name | [optional] 
+**kind** | **String** | Destination type (\"google-pubsub\", \"kinesis\", \"mparticle\", or \"segment\") | [optional] 
+**config** | **Object** | destination-specific configuration. | [optional] 
+**on** | **BOOLEAN** | Whether the data export destination is on or not. | [optional] 
+**version** | **Integer** |  | [optional] 
+
+

data/docs/DestinationAmazonKinesis.md

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

data/docs/DestinationBody.md

@@ -0,0 +1,11 @@
+# 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

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

data/docs/DestinationMParticle.md

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

data/docs/{CustomRoleKeyOrId.md → DestinationSegment.md}

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

data/docs/Destinations.md

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

data/docs/Environment.md

@@ -14,5 +14,7 @@ Name | Type | Description | Notes
 **secure_mode** | **BOOLEAN** | Determines if this environment is in safe mode. | [optional] 
 **default_track_events** | **BOOLEAN** | Set to true to send detailed event information for new flags. | [optional] 
 **tags** | **Array<String>** | An array of tags for this environment. | [optional] 
+**require_comments** | **BOOLEAN** | Determines if this environment requires comments for flag and segment changes. | [optional] 
+**confirm_changes** | **BOOLEAN** | Determines if this environment requires confirmation for flag and segment changes. | [optional] 
 
 

data/docs/EnvironmentPost.md

@@ -7,5 +7,10 @@ Name | Type | Description | Notes
 **key** | **String** | A project-unique key for the new environment. | 
 **color** | **String** | A color swatch (as an RGB hex value with no leading '#', e.g. C8C8C8). | 
 **default_ttl** | **Float** | The default TTL for the new environment. | [optional] 
+**secure_mode** | **BOOLEAN** | Determines whether the environment is in secure mode. | [optional] 
+**default_track_events** | **BOOLEAN** | Set to true to send detailed event information for newly created flags. | [optional] 
+**tags** | **Array<String>** | An array of tags for this environment. | [optional] 
+**require_comments** | **BOOLEAN** | Determines if this environment requires comments for flag and segment changes. | [optional] 
+**confirm_changes** | **BOOLEAN** | Determines if this environment requires confirmation for flag and segment changes. | [optional] 
 
 

data/docs/EnvironmentsApi.md

@@ -29,9 +29,9 @@ end
 
 api_instance = LaunchDarklyApi::EnvironmentsApi.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.
+project_key = 'project_key_example' # String | The project key, used to tie the flags together under one project so they can be managed together.
 
-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.
+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
@@ -83,9 +83,9 @@ end
 
 api_instance = LaunchDarklyApi::EnvironmentsApi.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.
+project_key = 'project_key_example' # String | The project key, used to tie the flags together under one project so they can be managed together.
 
-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.
+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
@@ -138,9 +138,9 @@ end
 
 api_instance = LaunchDarklyApi::EnvironmentsApi.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.
+project_key = 'project_key_example' # String | The project key, used to tie the flags together under one project so they can be managed together.
 
-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.
+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.
 
 patch_delta = [LaunchDarklyApi::PatchOperation.new] # Array<PatchOperation> | Requires a JSON Patch representation of the desired changes to the project. 'http://jsonpatch.com/'
 
@@ -178,7 +178,7 @@ Name | Type | Description  | Notes
 
 
 # **post_environment**
-> post_environment(project_key, environment_body)
+> Environment post_environment(project_key, environment_body)
 
 Create a new environment in a specified project with a given name, key, and swatch color.
 
@@ -196,14 +196,15 @@ end
 
 api_instance = LaunchDarklyApi::EnvironmentsApi.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.
+project_key = 'project_key_example' # String | The project key, used to tie the flags together under one project so they can be managed together.
 
 environment_body = LaunchDarklyApi::EnvironmentPost.new # EnvironmentPost | New environment.
 
 
 begin
   #Create a new environment in a specified project with a given name, key, and swatch color.
-  api_instance.post_environment(project_key, environment_body)
+  result = api_instance.post_environment(project_key, environment_body)
+  p result
 rescue LaunchDarklyApi::ApiError => e
   puts "Exception when calling EnvironmentsApi->post_environment: #{e}"
 end
@@ -218,7 +219,7 @@ Name | Type | Description  | Notes
 
 ### Return type
 
-nil (empty response body)
+[**Environment**](Environment.md)
 
 ### Authorization
 

data/docs/EvaluationUsageError.md

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

data/docs/Events.md

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

data/docs/FeatureFlag.md

@@ -13,10 +13,13 @@ Name | Type | Description | Notes
 **maintainer_id** | **String** | The ID of the member that should maintain this flag. | [optional] 
 **tags** | **Array<String>** | An array of tags for this feature flag. | [optional] 
 **variations** | [**Array<Variation>**](Variation.md) | The variations for this feature flag. | [optional] 
+**goal_ids** | **Array<String>** | An array goals from all environments associated with this feature flag | [optional] 
 **_version** | **Integer** |  | [optional] 
-**custom_properties** | [**CustomProperties**](CustomProperties.md) |  | [optional] 
+**custom_properties** | [**Hash<String, CustomProperty>**](CustomProperty.md) | A mapping of keys to CustomProperty entries. | [optional] 
 **_links** | [**Links**](Links.md) |  | [optional] 
 **_maintainer** | [**Member**](Member.md) |  | [optional] 
 **environments** | [**Hash<String, FeatureFlagConfig>**](FeatureFlagConfig.md) |  | [optional] 
+**archived_date** | **Float** | A unix epoch time in milliseconds specifying the archived time of this flag. | [optional] 
+**archived** | **BOOLEAN** | Whether or not this flag is archived. | [optional] 
 
 

data/docs/FeatureFlagConfig.md

@@ -10,7 +10,6 @@ Name | Type | Description | Notes
 **last_modified** | **Integer** |  | [optional] 
 **version** | **Integer** |  | [optional] 
 **targets** | [**Array<Target>**](Target.md) |  | [optional] 
-**goal_ids** | **Array<String>** |  | [optional] 
 **rules** | [**Array<Rule>**](Rule.md) |  | [optional] 
 **fallthrough** | [**Fallthrough**](Fallthrough.md) |  | [optional] 
 **off_variation** | **Integer** |  | [optional] 

data/docs/FeatureFlagCopyBody.md

@@ -0,0 +1,12 @@
+# 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

@@ -0,0 +1,9 @@
+# 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/FeatureFlagStatus.md

@@ -3,9 +3,9 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**_links** | [**Links**](Links.md) |  | [optional] 
 **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] 
+**_links** | [**Links**](Links.md) |  | [optional] 
 
 

data/docs/FeatureFlagStatusAcrossEnvironments.md

@@ -0,0 +1,10 @@
+# LaunchDarklyApi::FeatureFlagStatusAcrossEnvironments
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**_links** | [**Links**](Links.md) |  | [optional] 
+**key** | **String** |  | [optional] 
+**environments** | [**Hash<String, FeatureFlagStatusForQueriedEnvironment>**](FeatureFlagStatusForQueriedEnvironment.md) |  | [optional] 
+
+

data/docs/FeatureFlagStatusForQueriedEnvironment.md

@@ -0,0 +1,10 @@
+# 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] 
+
+