launchdarkly_api 8.0.0 → 10.0.0

data/docs/DataExportDestinationsApi.md

@@ -8,7 +8,7 @@ All URIs are relative to *https://app.launchdarkly.com*
 | [**get_destination**](DataExportDestinationsApi.md#get_destination) | **GET** /api/v2/destinations/{projectKey}/{environmentKey}/{id} | Get destination |
 | [**get_destinations**](DataExportDestinationsApi.md#get_destinations) | **GET** /api/v2/destinations | List destinations |
 | [**patch_destination**](DataExportDestinationsApi.md#patch_destination) | **PATCH** /api/v2/destinations/{projectKey}/{environmentKey}/{id} | Update Data Export destination |
-| [**post_destination**](DataExportDestinationsApi.md#post_destination) | **POST** /api/v2/destinations/{projectKey}/{environmentKey} | Create data export destination |
+| [**post_destination**](DataExportDestinationsApi.md#post_destination) | **POST** /api/v2/destinations/{projectKey}/{environmentKey} | Create Data Export destination |
 
 
 ## delete_destination
@@ -17,7 +17,7 @@ All URIs are relative to *https://app.launchdarkly.com*
 
 Delete Data Export destination
 
-Delete Data Export destination by ID
+Delete a Data Export destination by ID.
 
 ### Examples
 
@@ -91,7 +91,7 @@ nil (empty response body)
 
 Get destination
 
-Get a single Data Export destination by ID
+Get a single Data Export destination by ID.
 
 ### Examples
 
@@ -309,9 +309,9 @@ end
 
 > <Destination> post_destination(project_key, environment_key, destination_post)
 
-Create data export destination
+Create Data Export destination
 
-Create a new destination. The `config` body parameter represents the configuration parameters required for a destination type.
+ Create a new Data Export destination.  In the `config` request body parameter, the fields required depend on the type of Data Export destination.  <details> <summary>Click to expand <code>config</code> parameter details</summary>  #### Azure Event Hubs  To create a Data Export destination with a `kind` of `azure-event-hubs`, the `config` object requires the following fields:  * `namespace`: The Event Hub Namespace name * `name`: The Event Hub name * `policyName`: The shared access signature policy name. You can find your policy name in the settings of your Azure Event Hubs Namespace. * `policyKey`: The shared access signature key. You can find your policy key in the settings of your Azure Event Hubs Namespace.  #### Google Cloud Pub/Sub  To create a Data Export destination with a `kind` of `google-pubsub`, the `config` object requires the following fields:  * `project`: The Google PubSub project ID for the project to publish to * `topic`: The Google PubSub topic ID for the topic to publish to  #### Amazon Kinesis  To create a Data Export destination with a `kind` of `kinesis`, the `config` object requires the following fields:  * `region`: The Kinesis stream's AWS region key * `roleArn`: The Amazon Resource Name (ARN) of the AWS role that will be writing to Kinesis * `streamName`: The name of the Kinesis stream that LaunchDarkly is sending events to. This is not the ARN of the stream.  #### mParticle  To create a Data Export destination with a `kind` of `mparticle`, the `config` object requires the following fields:  * `apiKey`: The mParticle API key * `secret`: The mParticle API secret * `userIdentity`: The type of identifier you use to identify your users in mParticle * `anonymousUserIdentity`: The type of identifier you use to identify your anonymous users in mParticle  #### Segment  To create a Data Export destination with a `kind` of `segment`, the `config` object requires the following fields:  * `writeKey`: The Segment write key. This is used to authenticate LaunchDarkly's calls to Segment.  </details> 
 
 ### Examples
 
@@ -332,7 +332,7 @@ environment_key = 'environment_key_example' # String | The environment key
 destination_post = LaunchDarklyApi::DestinationPost.new # DestinationPost | 
 
 begin
-  # Create data export destination
+  # Create Data Export destination
   result = api_instance.post_destination(project_key, environment_key, destination_post)
   p result
 rescue LaunchDarklyApi::ApiError => e
@@ -348,7 +348,7 @@ This returns an Array which contains the response data, status code and headers.
 
 ```ruby
 begin
-  # Create data export destination
+  # Create Data Export destination
   data, status_code, headers = api_instance.post_destination_with_http_info(project_key, environment_key, destination_post)
   p status_code # => 2xx
   p headers # => { ... }

data/docs/DefaultClientSideAvailabilityPost.md

@@ -4,8 +4,8 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **using_environment_id** | **Boolean** |  |  |
-| **using_mobile_key** | **Boolean** |  |  |
+| **using_environment_id** | **Boolean** | Whether to enable availability for client-side SDKs. |  |
+| **using_mobile_key** | **Boolean** | Whether to enable availability for mobile SDKs. |  |
 
 ## Example
 
@@ -13,8 +13,8 @@
 require 'launchdarkly_api'
 
 instance = LaunchDarklyApi::DefaultClientSideAvailabilityPost.new(
-  using_environment_id: null,
-  using_mobile_key: null
+  using_environment_id: true,
+  using_mobile_key: true
 )
 ```
 

data/docs/Defaults.md

@@ -4,8 +4,8 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **on_variation** | **Integer** |  |  |
-| **off_variation** | **Integer** |  |  |
+| **on_variation** | **Integer** | The index, from the array of variations for this flag, of the variation to serve by default when targeting is on. |  |
+| **off_variation** | **Integer** | The index, from the array of variations for this flag, of the variation to serve by default when targeting is off. |  |
 
 ## Example
 
@@ -13,8 +13,8 @@
 require 'launchdarkly_api'
 
 instance = LaunchDarklyApi::Defaults.new(
-  on_variation: null,
-  off_variation: null
+  on_variation: 0,
+  off_variation: 1
 )
 ```
 

data/docs/Destination.md

@@ -4,13 +4,13 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **_id** | **String** |  | [optional] |
-| **_links** | [**Hash<String, Link>**](Link.md) |  | [optional] |
-| **name** | **String** |  | [optional] |
-| **kind** | **String** |  | [optional] |
+| **_id** | **String** | The ID of this Data Export destination | [optional] |
+| **_links** | [**Hash<String, Link>**](Link.md) | Links to other resources within the API. Includes the URL and content type of those resources. | [optional] |
+| **name** | **String** | A human-readable name for your Data Export destination | [optional] |
+| **kind** | **String** | The type of Data Export destination | [optional] |
 | **version** | **Float** |  | [optional] |
-| **config** | **Object** |  | [optional] |
-| **on** | **Boolean** |  | [optional] |
+| **config** | **Object** | An object with the configuration parameters required for the destination type | [optional] |
+| **on** | **Boolean** | Whether the export is on, that is, the status of the integration | [optional] |
 | **_access** | [**Access**](Access.md) |  | [optional] |
 
 ## Example
@@ -21,11 +21,11 @@ require 'launchdarkly_api'
 instance = LaunchDarklyApi::Destination.new(
   _id: 610addeadbeefaa86ec9a7d4,
   _links: {"parent":{"href":"/api/v2/destinations","type":"application/json"},"self":{"href":"/api/v2/destinations/my-project/my-environment/610addeadbeefaa86ec9a7d4","type":"application/json"}},
-  name: null,
+  name: example-destination,
   kind: google-pubsub,
   version: 1,
   config: {"project":"test-prod","topic":"ld-pubsub-test-192301"},
-  on: null,
+  on: true,
   _access: null
 )
 ```

data/docs/DestinationPost.md

@@ -4,10 +4,10 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **name** | **String** | A human-readable name for your data export destination. | [optional] |
-| **kind** | **String** |  | [optional] |
-| **config** | **Object** |  | [optional] |
-| **on** | **Boolean** |  | [optional] |
+| **name** | **String** | A human-readable name for your Data Export destination | [optional] |
+| **kind** | **String** | The type of Data Export destination | [optional] |
+| **config** | **Object** | An object with the configuration parameters required for the destination type | [optional] |
+| **on** | **Boolean** | Whether the export is on. Displayed as the integration status in the LaunchDarkly UI. | [optional] |
 
 ## Example
 
@@ -15,10 +15,10 @@
 require 'launchdarkly_api'
 
 instance = LaunchDarklyApi::DestinationPost.new(
-  name: null,
-  kind: null,
-  config: null,
-  on: null
+  name: example-destination,
+  kind: google-pubsub,
+  config: {"project":"test-prod","topic":"ld-pubsub-test-192301"},
+  on: true
 )
 ```
 

data/docs/Destinations.md

@@ -4,8 +4,8 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **_links** | [**Hash<String, Link>**](Link.md) |  | [optional] |
-| **items** | [**Array<Destination>**](Destination.md) |  | [optional] |
+| **_links** | [**Hash<String, Link>**](Link.md) | Links to other resources within the API. Includes the URL and content type of those resources. | [optional] |
+| **items** | [**Array<Destination>**](Destination.md) | An array of Data Export destinations | [optional] |
 
 ## Example
 

data/docs/Environments.md

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

data/docs/EnvironmentsApi.md

@@ -6,6 +6,7 @@ All URIs are relative to *https://app.launchdarkly.com*
 | ------ | ------------ | ----------- |
 | [**delete_environment**](EnvironmentsApi.md#delete_environment) | **DELETE** /api/v2/projects/{projectKey}/environments/{environmentKey} | Delete environment |
 | [**get_environment**](EnvironmentsApi.md#get_environment) | **GET** /api/v2/projects/{projectKey}/environments/{environmentKey} | Get environment |
+| [**get_environments_by_project**](EnvironmentsApi.md#get_environments_by_project) | **GET** /api/v2/projects/{projectKey}/environments | List environments |
 | [**patch_environment**](EnvironmentsApi.md#patch_environment) | **PATCH** /api/v2/projects/{projectKey}/environments/{environmentKey} | Update environment |
 | [**post_environment**](EnvironmentsApi.md#post_environment) | **POST** /api/v2/projects/{projectKey}/environments | Create environment |
 | [**reset_environment_mobile_key**](EnvironmentsApi.md#reset_environment_mobile_key) | **POST** /api/v2/projects/{projectKey}/environments/{environmentKey}/mobileKey | Reset environment mobile SDK key |
@@ -157,13 +158,94 @@ end
 - **Accept**: application/json
 
 
+## get_environments_by_project
+
+> <Environments> get_environments_by_project(project_key, opts)
+
+List environments
+
+Return a list of environments for the specified project.  By default, this returns the first 20 environments. Page through this list with the `limit` parameter and by following the `first`, `prev`, `next`, and `last` links in the `_links` field that returns. If those links do not appear, the pages they refer to don't exist. For example, the `first` and `prev` links will be missing from the response on the first page, because there is no previous page and you cannot return to the first page when you are already on the first page.  ### Filtering environments  LaunchDarkly supports two fields for filters: - `query` is a string that matches against the environments' names and keys. It is not case sensitive. - `tags` is a `+` separate list of environment tags. It filters the list of environments that have all of the tags in the list.  For example, the filter `query:abc,tags:tag-1+tag-2` matches environments with the string `abc` in their name or key and also are tagged with `tag-1` and `tag-2`. The filter is not case-sensitive.  ### Sorting environments  LaunchDarkly supports two fields for sorting: - `name` sorts by environment name. - `createdOn` sorts by the creation date of the environment.  For example, `sort=name` sorts the response by environment name in ascending order. 
+
+### 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::EnvironmentsApi.new
+project_key = 'project_key_example' # String | The project key
+opts = {
+  limit: 789, # Integer | The number of environments to return in the response. Defaults to 20.
+  offset: 789, # Integer | Where to start in the list. This is for use with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`.
+  filter: 'filter_example', # String | A comma-separated list of filters. Each filter is of the form `field:value`.
+  sort: 'sort_example' # String | A comma-separated list of fields to sort by. Fields prefixed by a dash ( - ) sort in descending order.
+}
+
+begin
+  # List environments
+  result = api_instance.get_environments_by_project(project_key, opts)
+  p result
+rescue LaunchDarklyApi::ApiError => e
+  puts "Error when calling EnvironmentsApi->get_environments_by_project: #{e}"
+end
+```
+
+#### Using the get_environments_by_project_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Environments>, Integer, Hash)> get_environments_by_project_with_http_info(project_key, opts)
+
+```ruby
+begin
+  # List environments
+  data, status_code, headers = api_instance.get_environments_by_project_with_http_info(project_key, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Environments>
+rescue LaunchDarklyApi::ApiError => e
+  puts "Error when calling EnvironmentsApi->get_environments_by_project_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **project_key** | **String** | The project key |  |
+| **limit** | **Integer** | The number of environments to return in the response. Defaults to 20. | [optional] |
+| **offset** | **Integer** | Where to start in the list. This is for use with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query &#x60;limit&#x60;. | [optional] |
+| **filter** | **String** | A comma-separated list of filters. Each filter is of the form &#x60;field:value&#x60;. | [optional] |
+| **sort** | **String** | A comma-separated list of fields to sort by. Fields prefixed by a dash ( - ) sort in descending order. | [optional] |
+
+### Return type
+
+[**Environments**](Environments.md)
+
+### Authorization
+
+[ApiKey](../README.md#ApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## patch_environment
 
 > <Environment> patch_environment(project_key, environment_key, patch_operation)
 
 Update environment
 
- Update an environment. Requires a [JSON Patch](https://datatracker.ietf.org/doc/html/rfc6902) representation of the desired changes to the environment.  To update fields in the environment object that are arrays, set the `path` to the name of the field and then append `/<array index>`. Using `/0` appends to the beginning of the array.  ### Approval settings  This request only returns the `approvalSettings` key if the [Flag Approvals](https://docs.launchdarkly.com/home/feature-workflows/approvals) feature is enabled.  Only the `canReviewOwnRequest`, `canApplyDeclinedChanges`, `minNumApprovals`, `required` and `requiredApprovalTagsfields` are editable.  If you try to patch the environment by setting both `required` and `requiredApprovalTags`, the request fails and an error appears. You can specify either required approvals for all flags in an environment or those with specific tags, but not both. Only customers on a Pro or Enterprise plan can require approval for flag updates by either mechanism. 
+ Update an environment. Requires a [JSON Patch](https://datatracker.ietf.org/doc/html/rfc6902) representation of the desired changes to the environment.  To update fields in the environment object that are arrays, set the `path` to the name of the field and then append `/<array index>`. Using `/0` appends to the beginning of the array.  ### Approval settings  This request only returns the `approvalSettings` key if the [Flag Approvals](https://docs.launchdarkly.com/home/feature-workflows/approvals) feature is enabled.  Only the `canReviewOwnRequest`, `canApplyDeclinedChanges`, `minNumApprovals`, `required` and `requiredApprovalTagsfields` are editable.  If you try to patch the environment by setting both `required` and `requiredApprovalTags`, the request fails and an error appears. You can specify either required approvals for all flags in an environment or those with specific tags, but not both. 
 
 ### Examples
 

data/docs/EvaluationReason.md

@@ -0,0 +1,28 @@
+# LaunchDarklyApi::EvaluationReason
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **kind** | **String** | Describes the general reason that LaunchDarkly selected this variation. |  |
+| **rule_index** | **Integer** | The positional index of the matching rule if the kind is 'RULE_MATCH'. The index is 0-based. | [optional] |
+| **rule_id** | **String** | The unique identifier of the matching rule if the kind is 'RULE_MATCH'. | [optional] |
+| **prerequisite_key** | **String** | The key of the flag that failed if the kind is 'PREREQUISITE_FAILED'. | [optional] |
+| **in_experiment** | **Boolean** | Indicates whether the user was evaluated as part of an experiment. | [optional] |
+| **error_kind** | **String** | The specific error type if the kind is 'ERROR'. | [optional] |
+
+## Example
+
+```ruby
+require 'launchdarkly_api'
+
+instance = LaunchDarklyApi::EvaluationReason.new(
+  kind: OFF,
+  rule_index: 3,
+  rule_id: 1234567890,
+  prerequisite_key: someotherflagkey,
+  in_experiment: true,
+  error_kind: USER_NOT_SPECIFIED
+)
+```
+

data/docs/Experiment.md

@@ -0,0 +1,36 @@
+# LaunchDarklyApi::Experiment
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **_id** | **String** |  | [optional] |
+| **key** | **String** |  |  |
+| **name** | **String** |  |  |
+| **description** | **String** |  | [optional] |
+| **_maintainer_id** | **String** |  |  |
+| **_creation_date** | **Integer** |  |  |
+| **_links** | [**Hash<String, Link>**](Link.md) |  |  |
+| **current_iteration** | [**IterationRep**](IterationRep.md) |  | [optional] |
+| **draft_iteration** | [**IterationRep**](IterationRep.md) |  | [optional] |
+| **previous_iterations** | [**Array<IterationRep>**](IterationRep.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'launchdarkly_api'
+
+instance = LaunchDarklyApi::Experiment.new(
+  _id: null,
+  key: null,
+  name: null,
+  description: null,
+  _maintainer_id: null,
+  _creation_date: null,
+  _links: {"parent":{"href":"/api/v2/projects/my-project/environments/my-environment","type":"application/json"},"self":{"href":"/api/v2/projects/my-project/environments/my-environment/experiments/my-experiment","type":"application/json"}},
+  current_iteration: null,
+  draft_iteration: null,
+  previous_iterations: null
+)
+```
+

data/docs/ExperimentBayesianResultsRep.md

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

data/docs/ExperimentCollectionRep.md

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

data/docs/ExperimentExpandableProperties.md

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

data/docs/ExperimentInfoRep.md

@@ -5,7 +5,7 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **baseline_idx** | **Integer** |  |  |
-| **items** | [**Array<ExperimentRep>**](ExperimentRep.md) |  |  |
+| **items** | [**Array<LegacyExperimentRep>**](LegacyExperimentRep.md) |  |  |
 
 ## Example
 

data/docs/ExperimentPatchInput.md

@@ -0,0 +1,20 @@
+# LaunchDarklyApi::ExperimentPatchInput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **comment** | **String** | Optional comment describing the update | [optional] |
+| **instructions** | **Array<Hash>** |  |  |
+
+## Example
+
+```ruby
+require 'launchdarkly_api'
+
+instance = LaunchDarklyApi::ExperimentPatchInput.new(
+  comment: Optional comment,
+  instructions: null
+)
+```
+

data/docs/ExperimentPost.md

@@ -0,0 +1,26 @@
+# LaunchDarklyApi::ExperimentPost
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** |  |  |
+| **description** | **String** |  | [optional] |
+| **maintainer_id** | **String** |  |  |
+| **key** | **String** |  |  |
+| **iteration** | [**IterationInput**](IterationInput.md) |  |  |
+
+## Example
+
+```ruby
+require 'launchdarkly_api'
+
+instance = LaunchDarklyApi::ExperimentPost.new(
+  name: null,
+  description: null,
+  maintainer_id: null,
+  key: null,
+  iteration: null
+)
+```
+

data/docs/{ExperimentResultsRep.md → ExperimentResults.md}

@@ -1,4 +1,4 @@
-# LaunchDarklyApi::ExperimentResultsRep
+# LaunchDarklyApi::ExperimentResults
 
 ## Properties
 
@@ -17,7 +17,7 @@
 ```ruby
 require 'launchdarkly_api'
 
-instance = LaunchDarklyApi::ExperimentResultsRep.new(
+instance = LaunchDarklyApi::ExperimentResults.new(
   _links: null,
   metadata: null,
   totals: null,