launchdarkly_api 3.7.1 → 3.8.0

data/docs/Integration.md

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

data/docs/IntegrationLinks.md

@@ -0,0 +1,8 @@
+# LaunchDarklyApi::IntegrationLinks
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**_self** | [**Link**](Link.md) |  | [optional] 
+
+

data/docs/IntegrationSubscription.md

@@ -0,0 +1,16 @@
+# LaunchDarklyApi::IntegrationSubscription
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**_links** | [**HierarchicalLinks**](HierarchicalLinks.md) |  | [optional] 
+**_id** | [**Id**](Id.md) |  | [optional] 
+**kind** | **String** | The type of integration associated with this configuration. | [optional] 
+**name** | **String** | The user-defined name associated with this configuration. | [optional] 
+**config** | **Object** | A key-value mapping of configuration fields. | [optional] 
+**statements** | [**Array<Statement>**](Statement.md) |  | [optional] 
+**on** | **BOOLEAN** | Whether or not the integration is currently active. | [optional] 
+**tags** | **Array<String>** | An array of tags for this integration configuration. | [optional] 
+**_status** | [**IntegrationSubscriptionStatus**](IntegrationSubscriptionStatus.md) |  | [optional] 
+
+

data/docs/IntegrationSubscriptionStatus.md

@@ -0,0 +1,10 @@
+# LaunchDarklyApi::IntegrationSubscriptionStatus
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**success_count** | **Integer** |  | [optional] 
+**last_success** | **Integer** | A unix epoch time in milliseconds specifying the last time this integration was successfully used. | [optional] 
+**error_count** | **Integer** |  | [optional] 
+
+

data/docs/Integrations.md

@@ -0,0 +1,9 @@
+# LaunchDarklyApi::Integrations
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**_links** | **Object** | A mapping of integration types to their respective API endpoints. | [optional] 
+**items** | [**Array<IntegrationSubscription>**](IntegrationSubscription.md) |  | [optional] 
+
+

data/docs/IntegrationsApi.md

@@ -0,0 +1,334 @@
+# LaunchDarklyApi::IntegrationsApi
+
+All URIs are relative to *https://app.launchdarkly.com/api/v2*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**delete_integration_subscription**](IntegrationsApi.md#delete_integration_subscription) | **DELETE** /integrations/{integrationKey}/{integrationId} | Delete an integration subscription by ID.
+[**get_integration_subscription**](IntegrationsApi.md#get_integration_subscription) | **GET** /integrations/{integrationKey}/{integrationId} | Get a single integration subscription by ID.
+[**get_integration_subscriptions**](IntegrationsApi.md#get_integration_subscriptions) | **GET** /integrations/{integrationKey} | Get a list of all configured integrations of a given kind.
+[**get_integrations**](IntegrationsApi.md#get_integrations) | **GET** /integrations | Get a list of all configured audit log event integrations associated with this account.
+[**patch_integration_subscription**](IntegrationsApi.md#patch_integration_subscription) | **PATCH** /integrations/{integrationKey}/{integrationId} | Modify an integration subscription by ID.
+[**post_integration_subscription**](IntegrationsApi.md#post_integration_subscription) | **POST** /integrations/{integrationKey} | Create a new integration subscription of a given kind.
+
+
+# **delete_integration_subscription**
+> delete_integration_subscription(integration_key, integration_id, )
+
+Delete an integration subscription 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::IntegrationsApi.new
+
+integration_key = 'integration_key_example' # String | The key used to specify the integration kind.
+
+integration_id = 'integration_id_example' # String | The integration ID.
+
+
+begin
+  #Delete an integration subscription by ID.
+  api_instance.delete_integration_subscription(integration_key, integration_id, )
+rescue LaunchDarklyApi::ApiError => e
+  puts "Exception when calling IntegrationsApi->delete_integration_subscription: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **integration_key** | **String**| The key used to specify the integration kind. | 
+ **integration_id** | **String**| The integration ID. | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[Token](../README.md#Token)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_integration_subscription**
+> IntegrationSubscription get_integration_subscription(integration_key, integration_id, )
+
+Get a single integration subscription 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::IntegrationsApi.new
+
+integration_key = 'integration_key_example' # String | The key used to specify the integration kind.
+
+integration_id = 'integration_id_example' # String | The integration ID.
+
+
+begin
+  #Get a single integration subscription by ID.
+  result = api_instance.get_integration_subscription(integration_key, integration_id, )
+  p result
+rescue LaunchDarklyApi::ApiError => e
+  puts "Exception when calling IntegrationsApi->get_integration_subscription: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **integration_key** | **String**| The key used to specify the integration kind. | 
+ **integration_id** | **String**| The integration ID. | 
+
+### Return type
+
+[**IntegrationSubscription**](IntegrationSubscription.md)
+
+### Authorization
+
+[Token](../README.md#Token)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_integration_subscriptions**
+> Integration get_integration_subscriptions(integration_key, )
+
+Get a list of all configured integrations of a given kind.
+
+### 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::IntegrationsApi.new
+
+integration_key = 'integration_key_example' # String | The key used to specify the integration kind.
+
+
+begin
+  #Get a list of all configured integrations of a given kind.
+  result = api_instance.get_integration_subscriptions(integration_key, )
+  p result
+rescue LaunchDarklyApi::ApiError => e
+  puts "Exception when calling IntegrationsApi->get_integration_subscriptions: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **integration_key** | **String**| The key used to specify the integration kind. | 
+
+### Return type
+
+[**Integration**](Integration.md)
+
+### Authorization
+
+[Token](../README.md#Token)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_integrations**
+> Integrations get_integrations
+
+Get a list of all configured audit log event integrations associated with this 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::IntegrationsApi.new
+
+begin
+  #Get a list of all configured audit log event integrations associated with this account.
+  result = api_instance.get_integrations
+  p result
+rescue LaunchDarklyApi::ApiError => e
+  puts "Exception when calling IntegrationsApi->get_integrations: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**Integrations**](Integrations.md)
+
+### Authorization
+
+[Token](../README.md#Token)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **patch_integration_subscription**
+> IntegrationSubscription patch_integration_subscription(integration_key, integration_id, patch_delta)
+
+Modify an integration subscription 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::IntegrationsApi.new
+
+integration_key = 'integration_key_example' # String | The key used to specify the integration kind.
+
+integration_id = 'integration_id_example' # String | The integration 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 an integration subscription by ID.
+  result = api_instance.patch_integration_subscription(integration_key, integration_id, patch_delta)
+  p result
+rescue LaunchDarklyApi::ApiError => e
+  puts "Exception when calling IntegrationsApi->patch_integration_subscription: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **integration_key** | **String**| The key used to specify the integration kind. | 
+ **integration_id** | **String**| The integration 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
+
+[**IntegrationSubscription**](IntegrationSubscription.md)
+
+### Authorization
+
+[Token](../README.md#Token)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **post_integration_subscription**
+> IntegrationSubscription post_integration_subscription(integration_key, subscription_body)
+
+Create a new integration subscription of a given kind.
+
+### 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::IntegrationsApi.new
+
+integration_key = 'integration_key_example' # String | The key used to specify the integration kind.
+
+subscription_body = LaunchDarklyApi::SubscriptionBody.new # SubscriptionBody | Create a new integration subscription.
+
+
+begin
+  #Create a new integration subscription of a given kind.
+  result = api_instance.post_integration_subscription(integration_key, subscription_body)
+  p result
+rescue LaunchDarklyApi::ApiError => e
+  puts "Exception when calling IntegrationsApi->post_integration_subscription: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **integration_key** | **String**| The key used to specify the integration kind. | 
+ **subscription_body** | [**SubscriptionBody**](SubscriptionBody.md)| Create a new integration subscription. | 
+
+### Return type
+
+[**IntegrationSubscription**](IntegrationSubscription.md)
+
+### Authorization
+
+[Token](../README.md#Token)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/SubscriptionBody.md

@@ -0,0 +1,12 @@
+# LaunchDarklyApi::SubscriptionBody
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | A human-readable name for your subscription configuration. | 
+**statements** | [**Array<Statement>**](Statement.md) |  | [optional] 
+**config** | **Object** | Integration-specific configuration fields. | 
+**on** | **BOOLEAN** | Whether the integration subscription is active or not. | [optional] 
+**tags** | **Array<String>** | Tags for the integration subscription. | [optional] 
+
+

data/launchdarkly_api.gemspec

@@ -5,7 +5,7 @@
 
 #Build custom integrations with the LaunchDarkly REST API
 
-OpenAPI spec version: 3.7.1
+OpenAPI spec version: 3.8.0
 Contact: support@launchdarkly.com
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 2.4.8

data/lib/launchdarkly_api.rb

@@ -3,7 +3,7 @@
 
 #Build custom integrations with the LaunchDarkly REST API
 
-OpenAPI spec version: 3.7.1
+OpenAPI spec version: 3.8.0
 Contact: support@launchdarkly.com
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 2.4.8
@@ -56,7 +56,13 @@ require 'launchdarkly_api/models/feature_flag_status_for_queried_environment'
 require 'launchdarkly_api/models/feature_flag_statuses'
 require 'launchdarkly_api/models/feature_flags'
 require 'launchdarkly_api/models/flag_list_item'
+require 'launchdarkly_api/models/hierarchical_links'
 require 'launchdarkly_api/models/id'
+require 'launchdarkly_api/models/integration'
+require 'launchdarkly_api/models/integration__links'
+require 'launchdarkly_api/models/integration_subscription'
+require 'launchdarkly_api/models/integration_subscription__status'
+require 'launchdarkly_api/models/integrations'
 require 'launchdarkly_api/models/link'
 require 'launchdarkly_api/models/links'
 require 'launchdarkly_api/models/mau'
@@ -96,6 +102,7 @@ require 'launchdarkly_api/models/stream_usage_links'
 require 'launchdarkly_api/models/stream_usage_metadata'
 require 'launchdarkly_api/models/stream_usage_series'
 require 'launchdarkly_api/models/streams'
+require 'launchdarkly_api/models/subscription_body'
 require 'launchdarkly_api/models/target'
 require 'launchdarkly_api/models/token'
 require 'launchdarkly_api/models/token_body'
@@ -134,6 +141,7 @@ require 'launchdarkly_api/api/customer_metrics_api'
 require 'launchdarkly_api/api/data_export_destinations_api'
 require 'launchdarkly_api/api/environments_api'
 require 'launchdarkly_api/api/feature_flags_api'
+require 'launchdarkly_api/api/integrations_api'
 require 'launchdarkly_api/api/projects_api'
 require 'launchdarkly_api/api/relay_proxy_configurations_api'
 require 'launchdarkly_api/api/root_api'