launchdarkly_api 2.0.3

data/docs/CustomRolesApi.md

@@ -0,0 +1,268 @@
+# LaunchDarklyApi::CustomRolesApi
+
+All URIs are relative to *https://app.launchdarkly.com/api/v2*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**delete_custom_role**](CustomRolesApi.md#delete_custom_role) | **DELETE** /roles/{customRoleKey} | Delete a custom role by key.
+[**get_custom_role**](CustomRolesApi.md#get_custom_role) | **GET** /roles/{customRoleKey} | Get one custom role by key.
+[**get_custom_roles**](CustomRolesApi.md#get_custom_roles) | **GET** /roles | Return a complete list of custom roles.
+[**patch_custom_role**](CustomRolesApi.md#patch_custom_role) | **PATCH** /roles/{customRoleKey} | Modify a custom role by key.
+[**post_custom_role**](CustomRolesApi.md#post_custom_role) | **POST** /roles | Create a new custom role.
+
+
+# **delete_custom_role**
+> delete_custom_role(custom_role_key, )
+
+Delete a custom role by 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::CustomRolesApi.new
+
+custom_role_key = "custom_role_key_example" # String | The custom role key.
+
+
+begin
+  #Delete a custom role by key.
+  api_instance.delete_custom_role(custom_role_key, )
+rescue LaunchDarklyApi::ApiError => e
+  puts "Exception when calling CustomRolesApi->delete_custom_role: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **custom_role_key** | **String**| The custom role key. | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[Token](../README.md#Token)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_custom_role**
+> CustomRole get_custom_role(custom_role_key, )
+
+Get one custom role by 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::CustomRolesApi.new
+
+custom_role_key = "custom_role_key_example" # String | The custom role key.
+
+
+begin
+  #Get one custom role by key.
+  result = api_instance.get_custom_role(custom_role_key, )
+  p result
+rescue LaunchDarklyApi::ApiError => e
+  puts "Exception when calling CustomRolesApi->get_custom_role: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **custom_role_key** | **String**| The custom role key. | 
+
+### Return type
+
+[**CustomRole**](CustomRole.md)
+
+### Authorization
+
+[Token](../README.md#Token)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_custom_roles**
+> CustomRoles get_custom_roles
+
+Return a complete list of custom roles.
+
+### 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::CustomRolesApi.new
+
+begin
+  #Return a complete list of custom roles.
+  result = api_instance.get_custom_roles
+  p result
+rescue LaunchDarklyApi::ApiError => e
+  puts "Exception when calling CustomRolesApi->get_custom_roles: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**CustomRoles**](CustomRoles.md)
+
+### Authorization
+
+[Token](../README.md#Token)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **patch_custom_role**
+> CustomRole patch_custom_role(custom_role_key, patch_delta)
+
+Modify a custom role by 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::CustomRolesApi.new
+
+custom_role_key = "custom_role_key_example" # String | The custom role key.
+
+patch_delta = [LaunchDarklyApi::PatchOperation.new] # Array<PatchOperation> | Requires a JSON Patch representation of the desired changes to the project. 'http://jsonpatch.com/'
+
+
+begin
+  #Modify a custom role by key.
+  result = api_instance.patch_custom_role(custom_role_key, patch_delta)
+  p result
+rescue LaunchDarklyApi::ApiError => e
+  puts "Exception when calling CustomRolesApi->patch_custom_role: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **custom_role_key** | **String**| The custom role key. | 
+ **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
+
+[**CustomRole**](CustomRole.md)
+
+### Authorization
+
+[Token](../README.md#Token)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **post_custom_role**
+> post_custom_role(custom_role_body)
+
+Create a new custom role.
+
+### 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::CustomRolesApi.new
+
+custom_role_body = LaunchDarklyApi::CustomRoleBody.new # CustomRoleBody | New role or roles to create.
+
+
+begin
+  #Create a new custom role.
+  api_instance.post_custom_role(custom_role_body)
+rescue LaunchDarklyApi::ApiError => e
+  puts "Exception when calling CustomRolesApi->post_custom_role: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **custom_role_body** | [**CustomRoleBody**](CustomRoleBody.md)| New role or roles to create. | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[Token](../README.md#Token)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/Environment.md

@@ -0,0 +1,17 @@
+# LaunchDarklyApi::Environment
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**_links** | [**Links**](Links.md) |  | [optional] 
+**_id** | [**Id**](Id.md) |  | [optional] 
+**key** | **String** | The key for the environment. | [optional] 
+**name** | **String** | The name of the environment. | [optional] 
+**api_key** | **String** | The SDK key for backend LaunchDarkly SDKs. | [optional] 
+**mobile_key** | **String** | The SDK key for mobile LaunchDarkly SDKs. | [optional] 
+**color** | **String** | The swatch color for the environment. | [optional] 
+**default_ttl** | **Float** | The default TTL. | [optional] 
+**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] 
+
+

data/docs/EnvironmentBody.md

@@ -0,0 +1,11 @@
+# LaunchDarklyApi::EnvironmentBody
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | The name of the new environment. | 
+**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] 
+
+

data/docs/EnvironmentsApi.md

@@ -0,0 +1,233 @@
+# LaunchDarklyApi::EnvironmentsApi
+
+All URIs are relative to *https://app.launchdarkly.com/api/v2*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**delete_environment**](EnvironmentsApi.md#delete_environment) | **DELETE** /projects/{projectKey}/environments/{environmentKey} | Delete an environment in a specific project.
+[**get_environment**](EnvironmentsApi.md#get_environment) | **GET** /projects/{projectKey}/environments/{environmentKey} | Get an environment given a project and key.
+[**patch_environment**](EnvironmentsApi.md#patch_environment) | **PATCH** /projects/{projectKey}/environments/{environmentKey} | Modify an environment by ID.
+[**post_environment**](EnvironmentsApi.md#post_environment) | **POST** /projects/{projectKey}/environments | Create a new environment in a specified project with a given name, key, and swatch color.
+
+
+# **delete_environment**
+> delete_environment(project_key, environment_key, )
+
+Delete an environment in a specific project.
+
+### 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::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.
+
+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
+  #Delete an environment in a specific project.
+  api_instance.delete_environment(project_key, environment_key, )
+rescue LaunchDarklyApi::ApiError => e
+  puts "Exception when calling EnvironmentsApi->delete_environment: #{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. | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[Token](../README.md#Token)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_environment**
+> Environment get_environment(project_key, environment_key, )
+
+Get an environment given a project and 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::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.
+
+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 an environment given a project and key.
+  result = api_instance.get_environment(project_key, environment_key, )
+  p result
+rescue LaunchDarklyApi::ApiError => e
+  puts "Exception when calling EnvironmentsApi->get_environment: #{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. | 
+
+### Return type
+
+[**Environment**](Environment.md)
+
+### Authorization
+
+[Token](../README.md#Token)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **patch_environment**
+> Environment patch_environment(project_key, environment_key, patch_delta)
+
+Modify an environment 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::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.
+
+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/'
+
+
+begin
+  #Modify an environment by ID.
+  result = api_instance.patch_environment(project_key, environment_key, patch_delta)
+  p result
+rescue LaunchDarklyApi::ApiError => e
+  puts "Exception when calling EnvironmentsApi->patch_environment: #{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. | 
+ **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
+
+[**Environment**](Environment.md)
+
+### Authorization
+
+[Token](../README.md#Token)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **post_environment**
+> post_environment(project_key, environment_body)
+
+Create a new environment in a specified project with a given name, key, and swatch color.
+
+### 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::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.
+
+environment_body = LaunchDarklyApi::EnvironmentBody.new # EnvironmentBody | 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)
+rescue LaunchDarklyApi::ApiError => e
+  puts "Exception when calling EnvironmentsApi->post_environment: #{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_body** | [**EnvironmentBody**](EnvironmentBody.md)| New environment. | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[Token](../README.md#Token)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/Fallthrough.md

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

data/docs/FeatureFlag.md

@@ -0,0 +1,20 @@
+# LaunchDarklyApi::FeatureFlag
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**key** | **String** |  | [optional] 
+**name** | **String** | Name of the feature flag. | [optional] 
+**description** | **String** | Description of the feature flag. | [optional] 
+**kind** | **String** | Whether the feature flag is a boolean flag or multivariate. | [optional] 
+**creation_date** | **Float** | A unix epoch time in milliseconds specifying the creation time of this flag. | [optional] 
+**include_in_snippet** | **BOOLEAN** |  | [optional] 
+**temporary** | **BOOLEAN** | Whether or not this flag is temporary. | [optional] 
+**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] 
+**_links** | [**Links**](Links.md) |  | [optional] 
+**_maintainer** | [**Member**](Member.md) |  | [optional] 
+**environments** | [**Hash<String, FeatureFlagConfig>**](FeatureFlagConfig.md) |  | [optional] 
+
+

data/docs/FeatureFlagBody.md

@@ -0,0 +1,13 @@
+# LaunchDarklyApi::FeatureFlagBody
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | A human-friendly name for the feature flag. Remember to note if this flag is intended to be temporary or permanent. | 
+**key** | **String** | A unique key that will be used to reference the flag in your code. | 
+**variations** | [**Array<Variation>**](Variation.md) | An array of possible variations for the flag. | 
+**temporary** | **BOOLEAN** | Whether or not the flag is a temporary flag. | [optional] 
+**tags** | **Array<String>** | Tags for the feature flag. | [optional] 
+**include_in_snippet** | **BOOLEAN** | Whether or not this flag should be made available to the client-side JavaScript SDK. | [optional] 
+
+

data/docs/FeatureFlagConfig.md

@@ -0,0 +1,19 @@
+# LaunchDarklyApi::FeatureFlagConfig
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**on** | **BOOLEAN** |  | [optional] 
+**archived** | **BOOLEAN** |  | [optional] 
+**salt** | **String** |  | [optional] 
+**sel** | **String** |  | [optional] 
+**last_modified** | **Integer** |  | [optional] 
+**version** | **Integer** |  | [optional] 
+**targets** | [**Array<Target>**](Target.md) |  | [optional] 
+**rules** | [**Array<Rule>**](Rule.md) |  | [optional] 
+**fallthrough** | [**Fallthrough**](Fallthrough.md) |  | [optional] 
+**off_variation** | **Integer** |  | [optional] 
+**prerequisites** | [**Array<Prerequisite>**](Prerequisite.md) |  | [optional] 
+**track_events** | **BOOLEAN** | Set to true to send detailed event information for this flag. | [optional] 
+
+

data/docs/FeatureFlagStatus.md

@@ -0,0 +1,11 @@
+# LaunchDarklyApi::FeatureFlagStatus
+
+## 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** | **BOOLEAN** |  | [optional] 
+
+

data/docs/FeatureFlagStatuses.md

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

data/docs/FeatureFlags.md

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