launchdarkly_api 5.4.0 → 7.1.0

data/docs/CustomerMetricsApi.md

@@ -1,511 +0,0 @@
-# LaunchDarklyApi::CustomerMetricsApi
-
-All URIs are relative to *https://app.launchdarkly.com/api/v2*
-
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**get_evaluations**](CustomerMetricsApi.md#get_evaluations) | **GET** /usage/evaluations/{envId}/{flagKey} | Get events usage by event id and the feature flag key.
-[**get_event**](CustomerMetricsApi.md#get_event) | **GET** /usage/events/{type} | Get events usage by event type.
-[**get_events**](CustomerMetricsApi.md#get_events) | **GET** /usage/events | Get events usage endpoints.
-[**get_mau**](CustomerMetricsApi.md#get_mau) | **GET** /usage/mau | Get monthly active user data.
-[**get_mau_by_category**](CustomerMetricsApi.md#get_mau_by_category) | **GET** /usage/mau/bycategory | Get monthly active user data by category.
-[**get_stream**](CustomerMetricsApi.md#get_stream) | **GET** /usage/streams/{source} | Get a stream endpoint and return timeseries data.
-[**get_stream_by_sdk**](CustomerMetricsApi.md#get_stream_by_sdk) | **GET** /usage/streams/{source}/bysdkversion | Get a stream timeseries data by source show sdk version metadata.
-[**get_stream_sdk_version**](CustomerMetricsApi.md#get_stream_sdk_version) | **GET** /usage/streams/{source}/sdkversions | Get a stream timeseries data by source and show all sdk version associated.
-[**get_streams**](CustomerMetricsApi.md#get_streams) | **GET** /usage/streams | Returns a list of all streams.
-[**get_usage**](CustomerMetricsApi.md#get_usage) | **GET** /usage | Returns of the usage endpoints available.
-
-
-# **get_evaluations**
-> StreamSDKVersion get_evaluations(env_id, flag_key)
-
-Get events usage by event id and the feature flag key.
-
-### 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::CustomerMetricsApi.new
-
-env_id = 'env_id_example' # String | The environment id for the flag evaluations in question.
-
-flag_key = 'flag_key_example' # String | The key of the flag we want metrics for.
-
-
-begin
-  #Get events usage by event id and the feature flag key.
-  result = api_instance.get_evaluations(env_id, flag_key)
-  p result
-rescue LaunchDarklyApi::ApiError => e
-  puts "Exception when calling CustomerMetricsApi->get_evaluations: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **env_id** | **String**| The environment id for the flag evaluations in question. | 
- **flag_key** | **String**| The key of the flag we want metrics for. | 
-
-### Return type
-
-[**StreamSDKVersion**](StreamSDKVersion.md)
-
-### Authorization
-
-[Token](../README.md#Token)
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-
-# **get_event**
-> StreamSDKVersion get_event(type)
-
-Get events usage by event type.
-
-### 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::CustomerMetricsApi.new
-
-type = 'type_example' # String | The type of event we would like to track.
-
-
-begin
-  #Get events usage by event type.
-  result = api_instance.get_event(type)
-  p result
-rescue LaunchDarklyApi::ApiError => e
-  puts "Exception when calling CustomerMetricsApi->get_event: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **type** | **String**| The type of event we would like to track. | 
-
-### Return type
-
-[**StreamSDKVersion**](StreamSDKVersion.md)
-
-### Authorization
-
-[Token](../README.md#Token)
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-
-# **get_events**
-> Events get_events
-
-Get events usage endpoints.
-
-### 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::CustomerMetricsApi.new
-
-begin
-  #Get events usage endpoints.
-  result = api_instance.get_events
-  p result
-rescue LaunchDarklyApi::ApiError => e
-  puts "Exception when calling CustomerMetricsApi->get_events: #{e}"
-end
-```
-
-### Parameters
-This endpoint does not need any parameter.
-
-### Return type
-
-[**Events**](Events.md)
-
-### Authorization
-
-[Token](../README.md#Token)
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-
-# **get_mau**
-> MAU get_mau
-
-Get monthly active user data.
-
-### 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::CustomerMetricsApi.new
-
-begin
-  #Get monthly active user data.
-  result = api_instance.get_mau
-  p result
-rescue LaunchDarklyApi::ApiError => e
-  puts "Exception when calling CustomerMetricsApi->get_mau: #{e}"
-end
-```
-
-### Parameters
-This endpoint does not need any parameter.
-
-### Return type
-
-[**MAU**](MAU.md)
-
-### Authorization
-
-[Token](../README.md#Token)
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-
-# **get_mau_by_category**
-> MAUbyCategory get_mau_by_category
-
-Get monthly active user data by category.
-
-### 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::CustomerMetricsApi.new
-
-begin
-  #Get monthly active user data by category.
-  result = api_instance.get_mau_by_category
-  p result
-rescue LaunchDarklyApi::ApiError => e
-  puts "Exception when calling CustomerMetricsApi->get_mau_by_category: #{e}"
-end
-```
-
-### Parameters
-This endpoint does not need any parameter.
-
-### Return type
-
-[**MAUbyCategory**](MAUbyCategory.md)
-
-### Authorization
-
-[Token](../README.md#Token)
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-
-# **get_stream**
-> Stream get_stream(source)
-
-Get a stream endpoint and return timeseries data.
-
-### 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::CustomerMetricsApi.new
-
-source = 'source_example' # String | The source of where the stream comes from.
-
-
-begin
-  #Get a stream endpoint and return timeseries data.
-  result = api_instance.get_stream(source)
-  p result
-rescue LaunchDarklyApi::ApiError => e
-  puts "Exception when calling CustomerMetricsApi->get_stream: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **source** | **String**| The source of where the stream comes from. | 
-
-### Return type
-
-[**Stream**](Stream.md)
-
-### Authorization
-
-[Token](../README.md#Token)
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-
-# **get_stream_by_sdk**
-> StreamBySDK get_stream_by_sdk(source)
-
-Get a stream timeseries data by source show sdk version metadata.
-
-### 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::CustomerMetricsApi.new
-
-source = 'source_example' # String | The source of where the stream comes from.
-
-
-begin
-  #Get a stream timeseries data by source show sdk version metadata.
-  result = api_instance.get_stream_by_sdk(source)
-  p result
-rescue LaunchDarklyApi::ApiError => e
-  puts "Exception when calling CustomerMetricsApi->get_stream_by_sdk: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **source** | **String**| The source of where the stream comes from. | 
-
-### Return type
-
-[**StreamBySDK**](StreamBySDK.md)
-
-### Authorization
-
-[Token](../README.md#Token)
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-
-# **get_stream_sdk_version**
-> StreamSDKVersion get_stream_sdk_version(source)
-
-Get a stream timeseries data by source and show all sdk version associated.
-
-### 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::CustomerMetricsApi.new
-
-source = 'source_example' # String | The source of where the stream comes from.
-
-
-begin
-  #Get a stream timeseries data by source and show all sdk version associated.
-  result = api_instance.get_stream_sdk_version(source)
-  p result
-rescue LaunchDarklyApi::ApiError => e
-  puts "Exception when calling CustomerMetricsApi->get_stream_sdk_version: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **source** | **String**| The source of where the stream comes from. | 
-
-### Return type
-
-[**StreamSDKVersion**](StreamSDKVersion.md)
-
-### Authorization
-
-[Token](../README.md#Token)
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-
-# **get_streams**
-> Streams get_streams
-
-Returns a list of all streams.
-
-### 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::CustomerMetricsApi.new
-
-begin
-  #Returns a list of all streams.
-  result = api_instance.get_streams
-  p result
-rescue LaunchDarklyApi::ApiError => e
-  puts "Exception when calling CustomerMetricsApi->get_streams: #{e}"
-end
-```
-
-### Parameters
-This endpoint does not need any parameter.
-
-### Return type
-
-[**Streams**](Streams.md)
-
-### Authorization
-
-[Token](../README.md#Token)
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-
-# **get_usage**
-> Usage get_usage
-
-Returns of the usage endpoints available.
-
-### 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::CustomerMetricsApi.new
-
-begin
-  #Returns of the usage endpoints available.
-  result = api_instance.get_usage
-  p result
-rescue LaunchDarklyApi::ApiError => e
-  puts "Exception when calling CustomerMetricsApi->get_usage: #{e}"
-end
-```
-
-### Parameters
-This endpoint does not need any parameter.
-
-### Return type
-
-[**Usage**](Usage.md)
-
-### Authorization
-
-[Token](../README.md#Token)
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-

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] 
-
-