launchdarkly_api 7.0.0 → 7.1.0

data/docs/IntegrationAuditLogSubscriptionsApi.md

@@ -0,0 +1,376 @@
+# LaunchDarklyApi::IntegrationAuditLogSubscriptionsApi
+
+All URIs are relative to *https://app.launchdarkly.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**create_subscription**](IntegrationAuditLogSubscriptionsApi.md#create_subscription) | **POST** /api/v2/integrations/{integrationKey} | Create audit log subscription |
+| [**delete_subscription**](IntegrationAuditLogSubscriptionsApi.md#delete_subscription) | **DELETE** /api/v2/integrations/{integrationKey}/{id} | Delete audit log subscription |
+| [**get_subscription_by_id**](IntegrationAuditLogSubscriptionsApi.md#get_subscription_by_id) | **GET** /api/v2/integrations/{integrationKey}/{id} | Get audit log subscription by ID |
+| [**get_subscriptions**](IntegrationAuditLogSubscriptionsApi.md#get_subscriptions) | **GET** /api/v2/integrations/{integrationKey} | Get audit log subscriptions by integration |
+| [**update_subscription**](IntegrationAuditLogSubscriptionsApi.md#update_subscription) | **PATCH** /api/v2/integrations/{integrationKey}/{id} | Update audit log subscription |
+
+
+## create_subscription
+
+> <Integration> create_subscription(integration_key, subscription_post)
+
+Create audit log subscription
+
+Create an audit log subscription.
+
+### 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::IntegrationAuditLogSubscriptionsApi.new
+integration_key = 'integration_key_example' # String | The integration key
+subscription_post = LaunchDarklyApi::SubscriptionPost.new({name: 'name_example', config: { key: 3.56}}) # SubscriptionPost | 
+
+begin
+  # Create audit log subscription
+  result = api_instance.create_subscription(integration_key, subscription_post)
+  p result
+rescue LaunchDarklyApi::ApiError => e
+  puts "Error when calling IntegrationAuditLogSubscriptionsApi->create_subscription: #{e}"
+end
+```
+
+#### Using the create_subscription_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Integration>, Integer, Hash)> create_subscription_with_http_info(integration_key, subscription_post)
+
+```ruby
+begin
+  # Create audit log subscription
+  data, status_code, headers = api_instance.create_subscription_with_http_info(integration_key, subscription_post)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Integration>
+rescue LaunchDarklyApi::ApiError => e
+  puts "Error when calling IntegrationAuditLogSubscriptionsApi->create_subscription_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **integration_key** | **String** | The integration key |  |
+| **subscription_post** | [**SubscriptionPost**](SubscriptionPost.md) |  |  |
+
+### Return type
+
+[**Integration**](Integration.md)
+
+### Authorization
+
+[ApiKey](../README.md#ApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## delete_subscription
+
+> delete_subscription(integration_key, id)
+
+Delete audit log subscription
+
+Delete an audit log subscription.
+
+### 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::IntegrationAuditLogSubscriptionsApi.new
+integration_key = 'integration_key_example' # String | The integration key
+id = 'id_example' # String | The subscription ID
+
+begin
+  # Delete audit log subscription
+  api_instance.delete_subscription(integration_key, id)
+rescue LaunchDarklyApi::ApiError => e
+  puts "Error when calling IntegrationAuditLogSubscriptionsApi->delete_subscription: #{e}"
+end
+```
+
+#### Using the delete_subscription_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_subscription_with_http_info(integration_key, id)
+
+```ruby
+begin
+  # Delete audit log subscription
+  data, status_code, headers = api_instance.delete_subscription_with_http_info(integration_key, id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue LaunchDarklyApi::ApiError => e
+  puts "Error when calling IntegrationAuditLogSubscriptionsApi->delete_subscription_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **integration_key** | **String** | The integration key |  |
+| **id** | **String** | The subscription ID |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[ApiKey](../README.md#ApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_subscription_by_id
+
+> <Integration> get_subscription_by_id(integration_key, id)
+
+Get audit log subscription by ID
+
+Get an audit log subscription 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::IntegrationAuditLogSubscriptionsApi.new
+integration_key = 'integration_key_example' # String | The integration key
+id = 'id_example' # String | The subscription ID
+
+begin
+  # Get audit log subscription by ID
+  result = api_instance.get_subscription_by_id(integration_key, id)
+  p result
+rescue LaunchDarklyApi::ApiError => e
+  puts "Error when calling IntegrationAuditLogSubscriptionsApi->get_subscription_by_id: #{e}"
+end
+```
+
+#### Using the get_subscription_by_id_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Integration>, Integer, Hash)> get_subscription_by_id_with_http_info(integration_key, id)
+
+```ruby
+begin
+  # Get audit log subscription by ID
+  data, status_code, headers = api_instance.get_subscription_by_id_with_http_info(integration_key, id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Integration>
+rescue LaunchDarklyApi::ApiError => e
+  puts "Error when calling IntegrationAuditLogSubscriptionsApi->get_subscription_by_id_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **integration_key** | **String** | The integration key |  |
+| **id** | **String** | The subscription ID |  |
+
+### Return type
+
+[**Integration**](Integration.md)
+
+### Authorization
+
+[ApiKey](../README.md#ApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_subscriptions
+
+> <Integrations> get_subscriptions(integration_key)
+
+Get audit log subscriptions by integration
+
+Get all audit log subscriptions associated with a given integration.
+
+### 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::IntegrationAuditLogSubscriptionsApi.new
+integration_key = 'integration_key_example' # String | The integration key
+
+begin
+  # Get audit log subscriptions by integration
+  result = api_instance.get_subscriptions(integration_key)
+  p result
+rescue LaunchDarklyApi::ApiError => e
+  puts "Error when calling IntegrationAuditLogSubscriptionsApi->get_subscriptions: #{e}"
+end
+```
+
+#### Using the get_subscriptions_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Integrations>, Integer, Hash)> get_subscriptions_with_http_info(integration_key)
+
+```ruby
+begin
+  # Get audit log subscriptions by integration
+  data, status_code, headers = api_instance.get_subscriptions_with_http_info(integration_key)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Integrations>
+rescue LaunchDarklyApi::ApiError => e
+  puts "Error when calling IntegrationAuditLogSubscriptionsApi->get_subscriptions_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **integration_key** | **String** | The integration key |  |
+
+### Return type
+
+[**Integrations**](Integrations.md)
+
+### Authorization
+
+[ApiKey](../README.md#ApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## update_subscription
+
+> <Integration> update_subscription(integration_key, id, patch_operation)
+
+Update audit log subscription
+
+Update an audit log subscription configuration. Requires a [JSON Patch](https://datatracker.ietf.org/doc/html/rfc6902) representation of the desired changes to the audit log subscription.
+
+### 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::IntegrationAuditLogSubscriptionsApi.new
+integration_key = 'integration_key_example' # String | The integration key
+id = 'id_example' # String | The ID of the audit log subscription
+patch_operation = [LaunchDarklyApi::PatchOperation.new({op: 'replace', path: '/biscuits', value: Chocolate Digestive})] # Array<PatchOperation> | 
+
+begin
+  # Update audit log subscription
+  result = api_instance.update_subscription(integration_key, id, patch_operation)
+  p result
+rescue LaunchDarklyApi::ApiError => e
+  puts "Error when calling IntegrationAuditLogSubscriptionsApi->update_subscription: #{e}"
+end
+```
+
+#### Using the update_subscription_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Integration>, Integer, Hash)> update_subscription_with_http_info(integration_key, id, patch_operation)
+
+```ruby
+begin
+  # Update audit log subscription
+  data, status_code, headers = api_instance.update_subscription_with_http_info(integration_key, id, patch_operation)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Integration>
+rescue LaunchDarklyApi::ApiError => e
+  puts "Error when calling IntegrationAuditLogSubscriptionsApi->update_subscription_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **integration_key** | **String** | The integration key |  |
+| **id** | **String** | The ID of the audit log subscription |  |
+| **patch_operation** | [**Array&lt;PatchOperation&gt;**](PatchOperation.md) |  |  |
+
+### Return type
+
+[**Integration**](Integration.md)
+
+### Authorization
+
+[ApiKey](../README.md#ApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/IntegrationStatusRep.md

@@ -0,0 +1,22 @@
+# LaunchDarklyApi::IntegrationStatusRep
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **status_code** | **Integer** |  | [optional] |
+| **response_body** | **String** |  | [optional] |
+| **timestamp** | **Integer** |  | [optional] |
+
+## Example
+
+```ruby
+require 'launchdarkly_api'
+
+instance = LaunchDarklyApi::IntegrationStatusRep.new(
+  status_code: null,
+  response_body: null,
+  timestamp: null
+)
+```
+

data/docs/IntegrationSubscriptionStatusRep.md

@@ -0,0 +1,26 @@
+# LaunchDarklyApi::IntegrationSubscriptionStatusRep
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **success_count** | **Integer** |  | [optional] |
+| **last_success** | **Integer** |  | [optional] |
+| **last_error** | **Integer** |  | [optional] |
+| **error_count** | **Integer** |  | [optional] |
+| **errors** | [**Array<IntegrationStatusRep>**](IntegrationStatusRep.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'launchdarkly_api'
+
+instance = LaunchDarklyApi::IntegrationSubscriptionStatusRep.new(
+  success_count: null,
+  last_success: null,
+  last_error: null,
+  error_count: null,
+  errors: null
+)
+```
+

data/docs/Integrations.md

@@ -0,0 +1,22 @@
+# LaunchDarklyApi::Integrations
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **_links** | [**Hash<String, Link>**](Link.md) |  | [optional] |
+| **items** | [**Array<Integration>**](Integration.md) |  | [optional] |
+| **key** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'launchdarkly_api'
+
+instance = LaunchDarklyApi::Integrations.new(
+  _links: null,
+  items: null,
+  key: null
+)
+```
+

data/docs/MemberImportItemRep.md

@@ -0,0 +1,22 @@
+# LaunchDarklyApi::MemberImportItemRep
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **message** | **String** |  | [optional] |
+| **status** | **String** |  |  |
+| **value** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'launchdarkly_api'
+
+instance = LaunchDarklyApi::MemberImportItemRep.new(
+  message: null,
+  status: null,
+  value: null
+)
+```
+

data/docs/MemberTeamsFormPost.md

@@ -0,0 +1,18 @@
+# LaunchDarklyApi::MemberTeamsFormPost
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **team_keys** | **Array<String>** | List of team keys |  |
+
+## Example
+
+```ruby
+require 'launchdarkly_api'
+
+instance = LaunchDarklyApi::MemberTeamsFormPost.new(
+  team_keys: null
+)
+```
+

data/docs/MetricListingRep.md

@@ -19,7 +19,7 @@
 | **_maintainer** | [**MemberSummaryRep**](MemberSummaryRep.md) |  | [optional] |
 | **description** | **String** |  | [optional] |
 | **is_numeric** | **Boolean** |  | [optional] |
-| **success_criteria** | **Integer** |  | [optional] |
+| **success_criteria** | **String** |  | [optional] |
 | **unit** | **String** |  | [optional] |
 | **event_key** | **String** |  | [optional] |
 

data/docs/MetricPost.md

@@ -14,7 +14,7 @@
 | **is_numeric** | **Boolean** |  | [optional] |
 | **unit** | **String** |  | [optional] |
 | **event_key** | **String** | Required for custom metrics | [optional] |
-| **success_criteria** | **Integer** |  | [optional] |
+| **success_criteria** | **String** |  | [optional] |
 | **tags** | **Array<String>** |  | [optional] |
 
 ## Example

data/docs/MetricRep.md

@@ -19,7 +19,7 @@
 | **_maintainer** | [**MemberSummaryRep**](MemberSummaryRep.md) |  | [optional] |
 | **description** | **String** |  | [optional] |
 | **is_numeric** | **Boolean** |  | [optional] |
-| **success_criteria** | **Integer** |  | [optional] |
+| **success_criteria** | **String** |  | [optional] |
 | **unit** | **String** |  | [optional] |
 | **event_key** | **String** |  | [optional] |
 | **is_active** | **Boolean** |  | [optional] |

data/docs/MetricSeen.md

@@ -5,7 +5,7 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **ever** | **Boolean** |  | [optional] |
-| **minutes_ago** | **Integer** |  | [optional] |
+| **timestamp** | **Integer** |  | [optional] |
 
 ## Example
 
@@ -14,7 +14,7 @@ require 'launchdarkly_api'
 
 instance = LaunchDarklyApi::MetricSeen.new(
   ever: null,
-  minutes_ago: null
+  timestamp: null
 )
 ```
 

data/docs/PutBranch.md

@@ -9,6 +9,7 @@
 | **update_sequence_id** | **Integer** | An optional ID used to prevent older data from overwriting newer data. If no sequence ID is included, the newly submitted data will always be saved. | [optional] |
 | **sync_time** | **Integer** |  |  |
 | **references** | [**Array<ReferenceRep>**](ReferenceRep.md) | An array of flag references found on the branch | [optional] |
+| **commit_time** | **Integer** |  | [optional] |
 
 ## Example
 
@@ -20,7 +21,8 @@ instance = LaunchDarklyApi::PutBranch.new(
   head: a94a8fe5ccb19ba61c4c0873d391e987982fbbd3,
   update_sequence_id: 25,
   sync_time: null,
-  references: null
+  references: null,
+  commit_time: null
 )
 ```
 

data/docs/RecentTriggerBody.md

@@ -0,0 +1,20 @@
+# LaunchDarklyApi::RecentTriggerBody
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **timestamp** | **Integer** |  | [optional] |
+| **json_body** | **Hash<String, Object>** |  | [optional] |
+
+## Example
+
+```ruby
+require 'launchdarkly_api'
+
+instance = LaunchDarklyApi::RecentTriggerBody.new(
+  timestamp: null,
+  json_body: null
+)
+```
+

data/docs/Rule.md

@@ -10,6 +10,7 @@
 | **clauses** | [**Array<Clause>**](Clause.md) |  |  |
 | **track_events** | **Boolean** |  |  |
 | **description** | **String** |  | [optional] |
+| **ref** | **String** |  | [optional] |
 
 ## Example
 
@@ -22,7 +23,8 @@ instance = LaunchDarklyApi::Rule.new(
   rollout: null,
   clauses: null,
   track_events: null,
-  description: null
+  description: null,
+  ref: null
 )
 ```
 

data/docs/ScheduledChangesApi.md

@@ -245,7 +245,7 @@ end
 
 Update scheduled changes workflow
 
-Update a scheduled change, overriding existing instructions with the new ones.<br /><br />Requires a semantic patch representation of the desired changes to the resource. To learn more about semantic patches, read [Updates](/#section/Updates/Updates-via-semantic-patches)
+Update a scheduled change, overriding existing instructions with the new ones.<br /><br />Requires a semantic patch representation of the desired changes to the resource. To learn more about semantic patches, read [Updates](/reference#updates-via-semantic-patches).
 
 ### Examples
 

data/docs/SegmentsApi.md

@@ -395,7 +395,7 @@ end
 
 Update expiring user targets for segment
 
-Update the list of a segment's user targets that are scheduled for removal<br /><br />Requires a semantic patch representation of the desired changes to the resource. To learn more about semantic patches, read [Updates](/#section/Updates/Updates-via-semantic-patches).<br /><br />If the request is well-formed but any of its instructions failed to process, this operation returns status code `200`. In this case, the response `errors` array will be non-empty.
+Update the list of a segment's user targets that are scheduled for removal<br /><br />Requires a semantic patch representation of the desired changes to the resource. To learn more about semantic patches, read [Updates](/reference#updates-via-semantic-patches).<br /><br />If the request is well-formed but any of its instructions failed to process, this operation returns status code `200`. In this case, the response `errors` array will be non-empty.
 
 ### Examples
 
@@ -472,7 +472,7 @@ end
 
 Patch segment
 
-Update a user segment. The request body must be a valid JSON patch or JSON merge patch document. To learn more about semantic patches, read [Updates](/#section/Updates).
+Update a user segment. The request body must be a valid JSON patch or JSON merge patch document. To learn more about semantic patches, read [Updates](/#section/Overview/Updates).
 
 ### Examples
 

data/docs/SubscriptionPost.md

@@ -0,0 +1,30 @@
+# LaunchDarklyApi::SubscriptionPost
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | A human-friendly name for your audit log subscription. |  |
+| **statements** | [**Array<StatementPost>**](StatementPost.md) |  | [optional] |
+| **on** | **Boolean** | Whether or not you want your subscription to actively send events. | [optional] |
+| **tags** | **Array<String>** |  | [optional] |
+| **config** | **Hash<String, Object>** | The unique set of fields required to configure an audit log subscription integration of this type. Refer to the \"formVariables\" field in the corresponding manifest.json  at https://github.com/launchdarkly/integration-framework/tree/master/integrations for a full list of fields for the integration you wish to configure. |  |
+| **url** | **String** | Slack webhook receiver URL. Only necessary for legacy Slack webhook integrations. | [optional] |
+| **api_key** | **String** | Datadog API key. Only necessary for legacy Datadog webhook subscriptions. | [optional] |
+
+## Example
+
+```ruby
+require 'launchdarkly_api'
+
+instance = LaunchDarklyApi::SubscriptionPost.new(
+  name: null,
+  statements: null,
+  on: null,
+  tags: null,
+  config: null,
+  url: null,
+  api_key: null
+)
+```
+

data/docs/TeamImportsRep.md

@@ -0,0 +1,18 @@
+# LaunchDarklyApi::TeamImportsRep
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **items** | [**Array<MemberImportItemRep>**](MemberImportItemRep.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'launchdarkly_api'
+
+instance = LaunchDarklyApi::TeamImportsRep.new(
+  items: null
+)
+```
+