launchdarkly_api 7.1.1 → 8.0.0

data/docs/IntegrationDeliveryConfigurationsBetaApi.md

@@ -0,0 +1,541 @@
+# LaunchDarklyApi::IntegrationDeliveryConfigurationsBetaApi
+
+All URIs are relative to *https://app.launchdarkly.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**create_integration_delivery_configuration**](IntegrationDeliveryConfigurationsBetaApi.md#create_integration_delivery_configuration) | **POST** /api/v2/integration-capabilities/featureStore/{projectKey}/{environmentKey}/{integrationKey} | Create delivery configuration |
+| [**delete_integration_delivery_configuration**](IntegrationDeliveryConfigurationsBetaApi.md#delete_integration_delivery_configuration) | **DELETE** /api/v2/integration-capabilities/featureStore/{projectKey}/{environmentKey}/{integrationKey}/{id} | Delete delivery configuration |
+| [**get_integration_delivery_configuration_by_environment**](IntegrationDeliveryConfigurationsBetaApi.md#get_integration_delivery_configuration_by_environment) | **GET** /api/v2/integration-capabilities/featureStore/{projectKey}/{environmentKey} | Get delivery configurations by environment |
+| [**get_integration_delivery_configuration_by_id**](IntegrationDeliveryConfigurationsBetaApi.md#get_integration_delivery_configuration_by_id) | **GET** /api/v2/integration-capabilities/featureStore/{projectKey}/{environmentKey}/{integrationKey}/{id} | Get delivery configuration by ID |
+| [**get_integration_delivery_configurations**](IntegrationDeliveryConfigurationsBetaApi.md#get_integration_delivery_configurations) | **GET** /api/v2/integration-capabilities/featureStore | List all delivery configurations |
+| [**patch_integration_delivery_configuration**](IntegrationDeliveryConfigurationsBetaApi.md#patch_integration_delivery_configuration) | **PATCH** /api/v2/integration-capabilities/featureStore/{projectKey}/{environmentKey}/{integrationKey}/{id} | Update delivery configuration |
+| [**validate_integration_delivery_configuration**](IntegrationDeliveryConfigurationsBetaApi.md#validate_integration_delivery_configuration) | **POST** /api/v2/integration-capabilities/featureStore/{projectKey}/{environmentKey}/{integrationKey}/{id}/validate | Validate delivery configuration |
+
+
+## create_integration_delivery_configuration
+
+> <IntegrationDeliveryConfiguration> create_integration_delivery_configuration(project_key, environment_key, integration_key, integration_delivery_configuration_post)
+
+Create delivery configuration
+
+Create a delivery configuration.
+
+### Examples
+
+```ruby
+require 'time'
+require 'launchdarkly_api'
+# setup authorization
+LaunchDarklyApi.configure do |config|
+  # Configure API key authorization: ApiKey
+  config.api_key['ApiKey'] = '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['ApiKey'] = 'Bearer'
+end
+
+api_instance = LaunchDarklyApi::IntegrationDeliveryConfigurationsBetaApi.new
+project_key = 'project_key_example' # String | The project key
+environment_key = 'environment_key_example' # String | The environment key
+integration_key = 'integration_key_example' # String | The integration key
+integration_delivery_configuration_post = LaunchDarklyApi::IntegrationDeliveryConfigurationPost.new({config: { key: 3.56}}) # IntegrationDeliveryConfigurationPost | 
+
+begin
+  # Create delivery configuration
+  result = api_instance.create_integration_delivery_configuration(project_key, environment_key, integration_key, integration_delivery_configuration_post)
+  p result
+rescue LaunchDarklyApi::ApiError => e
+  puts "Error when calling IntegrationDeliveryConfigurationsBetaApi->create_integration_delivery_configuration: #{e}"
+end
+```
+
+#### Using the create_integration_delivery_configuration_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<IntegrationDeliveryConfiguration>, Integer, Hash)> create_integration_delivery_configuration_with_http_info(project_key, environment_key, integration_key, integration_delivery_configuration_post)
+
+```ruby
+begin
+  # Create delivery configuration
+  data, status_code, headers = api_instance.create_integration_delivery_configuration_with_http_info(project_key, environment_key, integration_key, integration_delivery_configuration_post)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <IntegrationDeliveryConfiguration>
+rescue LaunchDarklyApi::ApiError => e
+  puts "Error when calling IntegrationDeliveryConfigurationsBetaApi->create_integration_delivery_configuration_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **project_key** | **String** | The project key |  |
+| **environment_key** | **String** | The environment key |  |
+| **integration_key** | **String** | The integration key |  |
+| **integration_delivery_configuration_post** | [**IntegrationDeliveryConfigurationPost**](IntegrationDeliveryConfigurationPost.md) |  |  |
+
+### Return type
+
+[**IntegrationDeliveryConfiguration**](IntegrationDeliveryConfiguration.md)
+
+### Authorization
+
+[ApiKey](../README.md#ApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## delete_integration_delivery_configuration
+
+> delete_integration_delivery_configuration(project_key, environment_key, integration_key, id)
+
+Delete delivery configuration
+
+Delete a delivery configuration
+
+### Examples
+
+```ruby
+require 'time'
+require 'launchdarkly_api'
+# setup authorization
+LaunchDarklyApi.configure do |config|
+  # Configure API key authorization: ApiKey
+  config.api_key['ApiKey'] = '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['ApiKey'] = 'Bearer'
+end
+
+api_instance = LaunchDarklyApi::IntegrationDeliveryConfigurationsBetaApi.new
+project_key = 'project_key_example' # String | The project key
+environment_key = 'environment_key_example' # String | The environment key
+integration_key = 'integration_key_example' # String | The integration key
+id = 'id_example' # String | The configuration ID
+
+begin
+  # Delete delivery configuration
+  api_instance.delete_integration_delivery_configuration(project_key, environment_key, integration_key, id)
+rescue LaunchDarklyApi::ApiError => e
+  puts "Error when calling IntegrationDeliveryConfigurationsBetaApi->delete_integration_delivery_configuration: #{e}"
+end
+```
+
+#### Using the delete_integration_delivery_configuration_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> <Array(nil, Integer, Hash)> delete_integration_delivery_configuration_with_http_info(project_key, environment_key, integration_key, id)
+
+```ruby
+begin
+  # Delete delivery configuration
+  data, status_code, headers = api_instance.delete_integration_delivery_configuration_with_http_info(project_key, environment_key, integration_key, id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue LaunchDarklyApi::ApiError => e
+  puts "Error when calling IntegrationDeliveryConfigurationsBetaApi->delete_integration_delivery_configuration_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **project_key** | **String** | The project key |  |
+| **environment_key** | **String** | The environment key |  |
+| **integration_key** | **String** | The integration key |  |
+| **id** | **String** | The configuration ID |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[ApiKey](../README.md#ApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_integration_delivery_configuration_by_environment
+
+> <IntegrationDeliveryConfigurationCollection> get_integration_delivery_configuration_by_environment(project_key, environment_key)
+
+Get delivery configurations by environment
+
+Get delivery configurations by environment.
+
+### Examples
+
+```ruby
+require 'time'
+require 'launchdarkly_api'
+# setup authorization
+LaunchDarklyApi.configure do |config|
+  # Configure API key authorization: ApiKey
+  config.api_key['ApiKey'] = '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['ApiKey'] = 'Bearer'
+end
+
+api_instance = LaunchDarklyApi::IntegrationDeliveryConfigurationsBetaApi.new
+project_key = 'project_key_example' # String | The project key
+environment_key = 'environment_key_example' # String | The environment key
+
+begin
+  # Get delivery configurations by environment
+  result = api_instance.get_integration_delivery_configuration_by_environment(project_key, environment_key)
+  p result
+rescue LaunchDarklyApi::ApiError => e
+  puts "Error when calling IntegrationDeliveryConfigurationsBetaApi->get_integration_delivery_configuration_by_environment: #{e}"
+end
+```
+
+#### Using the get_integration_delivery_configuration_by_environment_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<IntegrationDeliveryConfigurationCollection>, Integer, Hash)> get_integration_delivery_configuration_by_environment_with_http_info(project_key, environment_key)
+
+```ruby
+begin
+  # Get delivery configurations by environment
+  data, status_code, headers = api_instance.get_integration_delivery_configuration_by_environment_with_http_info(project_key, environment_key)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <IntegrationDeliveryConfigurationCollection>
+rescue LaunchDarklyApi::ApiError => e
+  puts "Error when calling IntegrationDeliveryConfigurationsBetaApi->get_integration_delivery_configuration_by_environment_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **project_key** | **String** | The project key |  |
+| **environment_key** | **String** | The environment key |  |
+
+### Return type
+
+[**IntegrationDeliveryConfigurationCollection**](IntegrationDeliveryConfigurationCollection.md)
+
+### Authorization
+
+[ApiKey](../README.md#ApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_integration_delivery_configuration_by_id
+
+> <IntegrationDeliveryConfiguration> get_integration_delivery_configuration_by_id(project_key, environment_key, integration_key, id)
+
+Get delivery configuration by ID
+
+Get delivery configuration by ID.
+
+### Examples
+
+```ruby
+require 'time'
+require 'launchdarkly_api'
+# setup authorization
+LaunchDarklyApi.configure do |config|
+  # Configure API key authorization: ApiKey
+  config.api_key['ApiKey'] = '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['ApiKey'] = 'Bearer'
+end
+
+api_instance = LaunchDarklyApi::IntegrationDeliveryConfigurationsBetaApi.new
+project_key = 'project_key_example' # String | The project key
+environment_key = 'environment_key_example' # String | The environment key
+integration_key = 'integration_key_example' # String | The integration key
+id = 'id_example' # String | The configuration ID
+
+begin
+  # Get delivery configuration by ID
+  result = api_instance.get_integration_delivery_configuration_by_id(project_key, environment_key, integration_key, id)
+  p result
+rescue LaunchDarklyApi::ApiError => e
+  puts "Error when calling IntegrationDeliveryConfigurationsBetaApi->get_integration_delivery_configuration_by_id: #{e}"
+end
+```
+
+#### Using the get_integration_delivery_configuration_by_id_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<IntegrationDeliveryConfiguration>, Integer, Hash)> get_integration_delivery_configuration_by_id_with_http_info(project_key, environment_key, integration_key, id)
+
+```ruby
+begin
+  # Get delivery configuration by ID
+  data, status_code, headers = api_instance.get_integration_delivery_configuration_by_id_with_http_info(project_key, environment_key, integration_key, id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <IntegrationDeliveryConfiguration>
+rescue LaunchDarklyApi::ApiError => e
+  puts "Error when calling IntegrationDeliveryConfigurationsBetaApi->get_integration_delivery_configuration_by_id_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **project_key** | **String** | The project key |  |
+| **environment_key** | **String** | The environment key |  |
+| **integration_key** | **String** | The integration key |  |
+| **id** | **String** | The configuration ID |  |
+
+### Return type
+
+[**IntegrationDeliveryConfiguration**](IntegrationDeliveryConfiguration.md)
+
+### Authorization
+
+[ApiKey](../README.md#ApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_integration_delivery_configurations
+
+> <IntegrationDeliveryConfigurationCollection> get_integration_delivery_configurations
+
+List all delivery configurations
+
+List all delivery configurations.
+
+### Examples
+
+```ruby
+require 'time'
+require 'launchdarkly_api'
+# setup authorization
+LaunchDarklyApi.configure do |config|
+  # Configure API key authorization: ApiKey
+  config.api_key['ApiKey'] = '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['ApiKey'] = 'Bearer'
+end
+
+api_instance = LaunchDarklyApi::IntegrationDeliveryConfigurationsBetaApi.new
+
+begin
+  # List all delivery configurations
+  result = api_instance.get_integration_delivery_configurations
+  p result
+rescue LaunchDarklyApi::ApiError => e
+  puts "Error when calling IntegrationDeliveryConfigurationsBetaApi->get_integration_delivery_configurations: #{e}"
+end
+```
+
+#### Using the get_integration_delivery_configurations_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<IntegrationDeliveryConfigurationCollection>, Integer, Hash)> get_integration_delivery_configurations_with_http_info
+
+```ruby
+begin
+  # List all delivery configurations
+  data, status_code, headers = api_instance.get_integration_delivery_configurations_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <IntegrationDeliveryConfigurationCollection>
+rescue LaunchDarklyApi::ApiError => e
+  puts "Error when calling IntegrationDeliveryConfigurationsBetaApi->get_integration_delivery_configurations_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**IntegrationDeliveryConfigurationCollection**](IntegrationDeliveryConfigurationCollection.md)
+
+### Authorization
+
+[ApiKey](../README.md#ApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## patch_integration_delivery_configuration
+
+> <IntegrationDeliveryConfiguration> patch_integration_delivery_configuration(project_key, environment_key, integration_key, id, patch_operation)
+
+Update delivery configuration
+
+Update an integration delivery configuration.
+
+### Examples
+
+```ruby
+require 'time'
+require 'launchdarkly_api'
+# setup authorization
+LaunchDarklyApi.configure do |config|
+  # Configure API key authorization: ApiKey
+  config.api_key['ApiKey'] = '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['ApiKey'] = 'Bearer'
+end
+
+api_instance = LaunchDarklyApi::IntegrationDeliveryConfigurationsBetaApi.new
+project_key = 'project_key_example' # String | The project key
+environment_key = 'environment_key_example' # String | The environment key
+integration_key = 'integration_key_example' # String | The integration key
+id = 'id_example' # String | The configuration ID
+patch_operation = [LaunchDarklyApi::PatchOperation.new({op: 'replace', path: '/exampleField', value: new example value})] # Array<PatchOperation> | 
+
+begin
+  # Update delivery configuration
+  result = api_instance.patch_integration_delivery_configuration(project_key, environment_key, integration_key, id, patch_operation)
+  p result
+rescue LaunchDarklyApi::ApiError => e
+  puts "Error when calling IntegrationDeliveryConfigurationsBetaApi->patch_integration_delivery_configuration: #{e}"
+end
+```
+
+#### Using the patch_integration_delivery_configuration_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<IntegrationDeliveryConfiguration>, Integer, Hash)> patch_integration_delivery_configuration_with_http_info(project_key, environment_key, integration_key, id, patch_operation)
+
+```ruby
+begin
+  # Update delivery configuration
+  data, status_code, headers = api_instance.patch_integration_delivery_configuration_with_http_info(project_key, environment_key, integration_key, id, patch_operation)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <IntegrationDeliveryConfiguration>
+rescue LaunchDarklyApi::ApiError => e
+  puts "Error when calling IntegrationDeliveryConfigurationsBetaApi->patch_integration_delivery_configuration_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **project_key** | **String** | The project key |  |
+| **environment_key** | **String** | The environment key |  |
+| **integration_key** | **String** | The integration key |  |
+| **id** | **String** | The configuration ID |  |
+| **patch_operation** | [**Array&lt;PatchOperation&gt;**](PatchOperation.md) |  |  |
+
+### Return type
+
+[**IntegrationDeliveryConfiguration**](IntegrationDeliveryConfiguration.md)
+
+### Authorization
+
+[ApiKey](../README.md#ApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## validate_integration_delivery_configuration
+
+> <IntegrationDeliveryConfigurationResponse> validate_integration_delivery_configuration(project_key, environment_key, integration_key, id)
+
+Validate delivery configuration
+
+Validate the saved delivery configuration.
+
+### Examples
+
+```ruby
+require 'time'
+require 'launchdarkly_api'
+# setup authorization
+LaunchDarklyApi.configure do |config|
+  # Configure API key authorization: ApiKey
+  config.api_key['ApiKey'] = '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['ApiKey'] = 'Bearer'
+end
+
+api_instance = LaunchDarklyApi::IntegrationDeliveryConfigurationsBetaApi.new
+project_key = 'project_key_example' # String | The project key
+environment_key = 'environment_key_example' # String | The environment key
+integration_key = 'integration_key_example' # String | The integration key
+id = 'id_example' # String | The configuration ID
+
+begin
+  # Validate delivery configuration
+  result = api_instance.validate_integration_delivery_configuration(project_key, environment_key, integration_key, id)
+  p result
+rescue LaunchDarklyApi::ApiError => e
+  puts "Error when calling IntegrationDeliveryConfigurationsBetaApi->validate_integration_delivery_configuration: #{e}"
+end
+```
+
+#### Using the validate_integration_delivery_configuration_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<IntegrationDeliveryConfigurationResponse>, Integer, Hash)> validate_integration_delivery_configuration_with_http_info(project_key, environment_key, integration_key, id)
+
+```ruby
+begin
+  # Validate delivery configuration
+  data, status_code, headers = api_instance.validate_integration_delivery_configuration_with_http_info(project_key, environment_key, integration_key, id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <IntegrationDeliveryConfigurationResponse>
+rescue LaunchDarklyApi::ApiError => e
+  puts "Error when calling IntegrationDeliveryConfigurationsBetaApi->validate_integration_delivery_configuration_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **project_key** | **String** | The project key |  |
+| **environment_key** | **String** | The environment key |  |
+| **integration_key** | **String** | The integration key |  |
+| **id** | **String** | The configuration ID |  |
+
+### Return type
+
+[**IntegrationDeliveryConfigurationResponse**](IntegrationDeliveryConfigurationResponse.md)
+
+### Authorization
+
+[ApiKey](../README.md#ApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/{MemberImportItemRep.md → MemberImportItem.md}

@@ -1,4 +1,4 @@
-# LaunchDarklyApi::MemberImportItemRep
+# LaunchDarklyApi::MemberImportItem
 
 ## Properties
 
@@ -13,7 +13,7 @@
 ```ruby
 require 'launchdarkly_api'
 
-instance = LaunchDarklyApi::MemberImportItemRep.new(
+instance = LaunchDarklyApi::MemberImportItem.new(
   message: null,
   status: null,
   value: null

data/docs/{MemberSummaryRep.md → MemberSummary.md}

@@ -1,4 +1,4 @@
-# LaunchDarklyApi::MemberSummaryRep
+# LaunchDarklyApi::MemberSummary
 
 ## Properties
 
@@ -16,7 +16,7 @@
 ```ruby
 require 'launchdarkly_api'
 
-instance = LaunchDarklyApi::MemberSummaryRep.new(
+instance = LaunchDarklyApi::MemberSummary.new(
   _links: {"self":{"href":"/api/v2/members/569f183514f4432160000007","type":"application/json"}},
   _id: 569f183514f4432160000007,
   first_name: An,

data/docs/MetricListingRep.md

@@ -11,12 +11,12 @@
 | **_attached_flag_count** | **Integer** |  | [optional] |
 | **_links** | [**Hash<String, Link>**](Link.md) |  |  |
 | **_site** | [**Link**](Link.md) |  | [optional] |
-| **_access** | [**AccessRep**](AccessRep.md) |  | [optional] |
+| **_access** | [**Access**](Access.md) |  | [optional] |
 | **tags** | **Array<String>** |  |  |
 | **_creation_date** | **Integer** |  |  |
 | **last_modified** | [**Modification**](Modification.md) |  | [optional] |
 | **maintainer_id** | **String** |  | [optional] |
-| **_maintainer** | [**MemberSummaryRep**](MemberSummaryRep.md) |  | [optional] |
+| **_maintainer** | [**MemberSummary**](MemberSummary.md) |  | [optional] |
 | **description** | **String** |  | [optional] |
 | **is_numeric** | **Boolean** |  | [optional] |
 | **success_criteria** | **String** |  | [optional] |

data/docs/MetricRep.md

@@ -11,12 +11,12 @@
 | **_attached_flag_count** | **Integer** |  | [optional] |
 | **_links** | [**Hash<String, Link>**](Link.md) |  |  |
 | **_site** | [**Link**](Link.md) |  | [optional] |
-| **_access** | [**AccessRep**](AccessRep.md) |  | [optional] |
+| **_access** | [**Access**](Access.md) |  | [optional] |
 | **tags** | **Array<String>** |  |  |
 | **_creation_date** | **Integer** |  |  |
 | **last_modified** | [**Modification**](Modification.md) |  | [optional] |
 | **maintainer_id** | **String** |  | [optional] |
-| **_maintainer** | [**MemberSummaryRep**](MemberSummaryRep.md) |  | [optional] |
+| **_maintainer** | [**MemberSummary**](MemberSummary.md) |  | [optional] |
 | **description** | **String** |  | [optional] |
 | **is_numeric** | **Boolean** |  | [optional] |
 | **success_criteria** | **String** |  | [optional] |