launchdarkly_api 3.5.0 → 3.6.0

data/docs/FeatureFlagScheduledChanges.md

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

data/docs/FeatureFlagScheduledChangesConflicts.md

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

data/docs/FeatureFlagScheduledChangesConflictsInstructions.md

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

@@ -0,0 +1,15 @@
+# LaunchDarklyApi::RelayProxyConfig
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**_id** | [**Id**](Id.md) |  | 
+**_creator** | [**Member**](Member.md) |  | 
+**name** | **String** | A human-friendly name for the relay proxy configuration | 
+**policy** | [**Array<Policy>**](Policy.md) |  | 
+**full_key** | **String** | Full secret key. Only included if creating or resetting the relay proxy configuration | [optional] 
+**display_key** | **String** | The last 4 digits of the unique secret key for this relay proxy configuration | 
+**creation_date** | **Integer** | A unix epoch time in milliseconds specifying the creation time of this relay proxy configuration | 
+**last_modified** | **Integer** | A unix epoch time in milliseconds specifying the last time this relay proxy configuration was modified | 
+
+

data/docs/RelayProxyConfigBody.md

@@ -0,0 +1,9 @@
+# LaunchDarklyApi::RelayProxyConfigBody
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | A human-friendly name for the relay proxy configuration | [optional] 
+**policy** | [**Array<Policy>**](Policy.md) |  | [optional] 
+
+

data/docs/RelayProxyConfigs.md

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

data/docs/RelayProxyConfigurationsApi.md

@@ -0,0 +1,326 @@
+# LaunchDarklyApi::RelayProxyConfigurationsApi
+
+All URIs are relative to *https://app.launchdarkly.com/api/v2*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**delete_relay_proxy_config**](RelayProxyConfigurationsApi.md#delete_relay_proxy_config) | **DELETE** /account/relay-auto-configs/{id} | Delete a relay proxy configuration by ID.
+[**get_relay_proxy_config**](RelayProxyConfigurationsApi.md#get_relay_proxy_config) | **GET** /account/relay-auto-configs/{id} | Get a single relay proxy configuration by ID.
+[**get_relay_proxy_configs**](RelayProxyConfigurationsApi.md#get_relay_proxy_configs) | **GET** /account/relay-auto-configs | Returns a list of relay proxy configurations in the account.
+[**patch_relay_proxy_config**](RelayProxyConfigurationsApi.md#patch_relay_proxy_config) | **PATCH** /account/relay-auto-configs/{id} | Modify a relay proxy configuration by ID.
+[**post_relay_auto_config**](RelayProxyConfigurationsApi.md#post_relay_auto_config) | **POST** /account/relay-auto-configs | Create a new relay proxy config.
+[**reset_relay_proxy_config**](RelayProxyConfigurationsApi.md#reset_relay_proxy_config) | **POST** /account/relay-auto-configs/{id}/reset | Reset a relay proxy configuration's secret key with an optional expiry time for the old key.
+
+
+# **delete_relay_proxy_config**
+> delete_relay_proxy_config(id)
+
+Delete a relay proxy configuration 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::RelayProxyConfigurationsApi.new
+
+id = 'id_example' # String | The relay proxy configuration ID
+
+
+begin
+  #Delete a relay proxy configuration by ID.
+  api_instance.delete_relay_proxy_config(id)
+rescue LaunchDarklyApi::ApiError => e
+  puts "Exception when calling RelayProxyConfigurationsApi->delete_relay_proxy_config: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**| The relay proxy configuration ID | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[Token](../README.md#Token)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_relay_proxy_config**
+> RelayProxyConfig get_relay_proxy_config(id)
+
+Get a single relay proxy configuration 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::RelayProxyConfigurationsApi.new
+
+id = 'id_example' # String | The relay proxy configuration ID
+
+
+begin
+  #Get a single relay proxy configuration by ID.
+  result = api_instance.get_relay_proxy_config(id)
+  p result
+rescue LaunchDarklyApi::ApiError => e
+  puts "Exception when calling RelayProxyConfigurationsApi->get_relay_proxy_config: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**| The relay proxy configuration ID | 
+
+### Return type
+
+[**RelayProxyConfig**](RelayProxyConfig.md)
+
+### Authorization
+
+[Token](../README.md#Token)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_relay_proxy_configs**
+> RelayProxyConfigs get_relay_proxy_configs
+
+Returns a list of relay proxy configurations in the 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::RelayProxyConfigurationsApi.new
+
+begin
+  #Returns a list of relay proxy configurations in the account.
+  result = api_instance.get_relay_proxy_configs
+  p result
+rescue LaunchDarklyApi::ApiError => e
+  puts "Exception when calling RelayProxyConfigurationsApi->get_relay_proxy_configs: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**RelayProxyConfigs**](RelayProxyConfigs.md)
+
+### Authorization
+
+[Token](../README.md#Token)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **patch_relay_proxy_config**
+> RelayProxyConfig patch_relay_proxy_config(idpatch_delta)
+
+Modify a relay proxy configuration 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::RelayProxyConfigurationsApi.new
+
+id = 'id_example' # String | The relay proxy configuration 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 a relay proxy configuration by ID.
+  result = api_instance.patch_relay_proxy_config(idpatch_delta)
+  p result
+rescue LaunchDarklyApi::ApiError => e
+  puts "Exception when calling RelayProxyConfigurationsApi->patch_relay_proxy_config: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**| The relay proxy configuration 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
+
+[**RelayProxyConfig**](RelayProxyConfig.md)
+
+### Authorization
+
+[Token](../README.md#Token)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **post_relay_auto_config**
+> RelayProxyConfig post_relay_auto_config(relay_proxy_config_body)
+
+Create a new relay proxy config.
+
+### 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::RelayProxyConfigurationsApi.new
+
+relay_proxy_config_body = LaunchDarklyApi::RelayProxyConfigBody.new # RelayProxyConfigBody | Create a new relay proxy configuration
+
+
+begin
+  #Create a new relay proxy config.
+  result = api_instance.post_relay_auto_config(relay_proxy_config_body)
+  p result
+rescue LaunchDarklyApi::ApiError => e
+  puts "Exception when calling RelayProxyConfigurationsApi->post_relay_auto_config: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **relay_proxy_config_body** | [**RelayProxyConfigBody**](RelayProxyConfigBody.md)| Create a new relay proxy configuration | 
+
+### Return type
+
+[**RelayProxyConfig**](RelayProxyConfig.md)
+
+### Authorization
+
+[Token](../README.md#Token)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **reset_relay_proxy_config**
+> RelayProxyConfig reset_relay_proxy_config(id, opts)
+
+Reset a relay proxy configuration's secret key with an optional expiry time for the old 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::RelayProxyConfigurationsApi.new
+
+id = 'id_example' # String | The relay proxy configuration ID
+
+opts = { 
+  expiry: 789 # Integer | An expiration time for the old relay proxy configuration key, expressed as a Unix epoch time in milliseconds. By default, the relay proxy configuration will expire immediately
+}
+
+begin
+  #Reset a relay proxy configuration's secret key with an optional expiry time for the old key.
+  result = api_instance.reset_relay_proxy_config(id, opts)
+  p result
+rescue LaunchDarklyApi::ApiError => e
+  puts "Exception when calling RelayProxyConfigurationsApi->reset_relay_proxy_config: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**| The relay proxy configuration ID | 
+ **expiry** | **Integer**| An expiration time for the old relay proxy configuration key, expressed as a Unix epoch time in milliseconds. By default, the relay proxy configuration will expire immediately | [optional] 
+
+### Return type
+
+[**RelayProxyConfig**](RelayProxyConfig.md)
+
+### Authorization
+
+[Token](../README.md#Token)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/ScheduledChangesFeatureFlagConflict.md

@@ -0,0 +1,9 @@
+# LaunchDarklyApi::ScheduledChangesFeatureFlagConflict
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**_id** | **String** | Feature flag scheduled change id this change will conflict with | [optional] 
+**reason** | **String** | Feature flag scheduled change conflict reason | [optional] 
+
+

data/docs/SemanticPatchInstruction.md

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

data/docs/{SemanticPatchOperationInstructions.md → SemanticPatchInstructionInner.md}

@@ -1,4 +1,4 @@
-# LaunchDarklyApi::SemanticPatchOperationInstructions
+# LaunchDarklyApi::SemanticPatchInstructionInner
 
 ## Properties
 Name | Type | Description | Notes

data/docs/SemanticPatchOperation.md

@@ -4,6 +4,6 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **comment** | **String** |  | [optional] 
-**instructions** | [**Array<SemanticPatchOperationInstructions>**](SemanticPatchOperationInstructions.md) |  | 
+**instructions** | [**SemanticPatchInstruction**](SemanticPatchInstruction.md) |  | 
 
 

data/docs/UnboundedSegmentTargetChanges.md

@@ -0,0 +1,9 @@
+# LaunchDarklyApi::UnboundedSegmentTargetChanges
+
+## 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/UnboundedSegmentTargetsBody.md

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