launchdarkly_api 5.4.0 → 6.0.0

data/docs/ApprovalRequest.md

@@ -1,21 +0,0 @@
-# LaunchDarklyApi::ApprovalRequest
-
-## 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 approval request was requested | [optional] 
-**requestor_id** | **String** | The id of the member that requested the change | [optional] 
-**review_status** | [**ApprovalRequestReviewStatus**](ApprovalRequestReviewStatus.md) |  | [optional] 
-**status** | **String** | | Name      | Description | | ---------:| ----------- | | pending   | the approval request has not been applied yet | | completed | the approval request has been applied successfully | | scheduled | the approval request for a scheduled change has been applied successfully | | failed    | the approval 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 approval request | [optional] 
-**applied_date** | **Integer** | A unix epoch time in milliseconds specifying the date the approval request was applied | [optional] 
-**all_reviews** | [**Array<ApprovalRequestReview>**](ApprovalRequestReview.md) |  | [optional] 
-**notify_member_ids** | **Array<String>** |  | [optional] 
-**instructions** | [**SemanticPatchInstruction**](SemanticPatchInstruction.md) |  | [optional] 
-**execution_date** | **Integer** | Timestamp for when instructions will be executed | [optional] 
-**operating_on_id** | **String** | ID of scheduled change to edit or delete | [optional] 
-**source** | [**Source**](Source.md) |  | [optional] 
-
-

data/docs/ApprovalRequestApplyConfigBody.md

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

data/docs/ApprovalRequestConfigBody.md

@@ -1,13 +0,0 @@
-# LaunchDarklyApi::ApprovalRequestConfigBody
-
-## 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] 
-**execution_date** | **Integer** | Timestamp for when instructions will be executed | [optional] 
-**operating_on_id** | **String** | ID of scheduled change to edit or delete | [optional] 
-
-

data/docs/ApprovalRequestFlagConfigCopyBody.md

@@ -1,13 +0,0 @@
-# LaunchDarklyApi::ApprovalRequestFlagConfigCopyBody
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**description** | **String** | A name that describes the changes you would like to apply to a feature flag configuration | 
-**notify_member_ids** | **Array<String>** |  | 
-**source** | [**Source**](Source.md) |  | 
-**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/ApprovalRequestReview.md

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

data/docs/ApprovalRequestReviewConfigBody.md

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

data/docs/ApprovalRequestReviewStatus.md

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

data/docs/ApprovalRequests.md

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

data/docs/AuditLogEntries.md

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

data/docs/AuditLogEntry.md

@@ -1,19 +0,0 @@
-# LaunchDarklyApi::AuditLogEntry
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**_links** | [**Links**](Links.md) |  | [optional] 
-**_id** | [**Id**](Id.md) |  | [optional] 
-**date** | **Integer** |  | [optional] 
-**kind** | **String** |  | [optional] 
-**name** | **String** |  | [optional] 
-**description** | **String** |  | [optional] 
-**short_description** | **String** |  | [optional] 
-**comment** | **String** |  | [optional] 
-**member** | [**Member**](Member.md) |  | [optional] 
-**title_verb** | **String** |  | [optional] 
-**title** | **String** |  | [optional] 
-**target** | [**AuditLogEntryTarget**](AuditLogEntryTarget.md) |  | [optional] 
-
-

data/docs/AuditLogEntryTarget.md

@@ -1,10 +0,0 @@
-# LaunchDarklyApi::AuditLogEntryTarget
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**_links** | [**Links**](Links.md) |  | [optional] 
-**name** | **String** |  | [optional] 
-**resources** | **Array<String>** |  | [optional] 
-
-

data/docs/BigSegmentTargetChanges.md

@@ -1,9 +0,0 @@
-# LaunchDarklyApi::BigSegmentTargetChanges
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**add** | **Array<String>** | Users to add to this list of targets | [optional] 
-**remove** | **Array<String>** | Users to remove from this list of targets | [optional] 
-
-

data/docs/BigSegmentTargetsBody.md

@@ -1,9 +0,0 @@
-# LaunchDarklyApi::BigSegmentTargetsBody
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**included** | [**BigSegmentTargetChanges**](BigSegmentTargetChanges.md) |  | [optional] 
-**excluded** | [**BigSegmentTargetChanges**](BigSegmentTargetChanges.md) |  | [optional] 
-
-

data/docs/CopyActions.md

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

data/docs/CustomPropertyValues.md

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

data/docs/CustomRoleBody.md

@@ -1,11 +0,0 @@
-# LaunchDarklyApi::CustomRoleBody
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**name** | **String** | Name of the custom role. | 
-**description** | **String** | Description of the custom role. | [optional] 
-**key** | **String** | The 20-hexdigit id or the key for a custom role. | 
-**policy** | [**Array<Policy>**](Policy.md) |  | 
-
-

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