launchdarkly_api 8.0.0 → 9.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4ee2a7a1e68f1b7e050b9e5735168d20c893ac1e9152fb271bfc1a5c0dac866a
-  data.tar.gz: 27bbda3548a6fca8bd80c803a213f53f3221524f748b5caf5a2b6108e09f8213
+  metadata.gz: 7d847a35d28e7d6871c5314be0fc41c658a90251e5cf455d379a17a94b7386c3
+  data.tar.gz: 4999fc457cbfdd5cc6f8cdd5bf16b056f66fadf7e55683eda48d563ee4c1c821
 SHA512:
-  metadata.gz: ad559050fcf6f77289566fdbee4418454900e378131fb8cfcf244e14416b98ac0b15fac72c129a406812a9344c5463005e383379e4a1ace91c952099b6dda2fd
-  data.tar.gz: 913f8d75d3acf954afe80b0d2952a0142f3e7ecbed5a7250ac1dc047307ccf6cf7fd37801d74533653cf72eae9a8b6130bf4ae84d7f391fdd08277d101bb713f
+  metadata.gz: 466b1fa7b426f5f5b404c1df1f133530b0ea18b76fe53ea1a409e0d4a9e7a48288e2a8826c7f9356d4bdd416a7e21c2062fecdf7ee45fa9fe7965bc01030694e
+  data.tar.gz: 8d8633c24642311c2b45b5e78eb9f013f237d4e1a4f6dce33f814e4b760e625a9063cf447909497973ec54a4acdcf861ed137ecbb2f7cb70c5d32c796e975071

data/README.md

@@ -61,10 +61,12 @@ In addition, request bodies for `PUT`, `POST`, `REPORT` and `PATCH` requests mus
 
 ### Summary and detailed representations
 
-When you fetch a list of resources, the response includes only the most important attributes of each resource. This is a _summary representation_ of the resource. When you fetch an individual resource (for example, a single feature flag), you receive a _detailed representation_ containing all of the attributes of the resource.
+When you fetch a list of resources, the response includes only the most important attributes of each resource. This is a _summary representation_ of the resource. When you fetch an individual resource, such as a single feature flag, you receive a _detailed representation_ of the resource.
 
 The best way to find a detailed representation is to follow links. Every summary representation includes a link to its detailed representation.
 
+In most cases, the detailed representation contains all of the attributes of the resource. In a few cases, the detailed representation contains many, but not all, of the attributes of the resource. Typically this happens when an attribute of the requested resource is itself paginated. You can request that the response include a particular attribute by using the `expand` request parameter.
+
 ### Links and addressability
 
 The best way to navigate the API is by following links. These are attributes in representations that link to other resources. The API always uses the same format for links:
@@ -99,6 +101,12 @@ Collections are always represented as a JSON object with an `items` attribute co
 
 Paginated collections include `first`, `last`, `next`, and `prev` links containing a URL with the respective set of elements in the collection.
 
+### Expanding responses
+
+Sometimes the detailed representation of a resource does not include all of the attributes of the resource by default. If this is the case, the request method will clearly document this and describe which attributes you can include in an expanded response.
+
+To include the additional attributes, append the `expand` request parameter to your request and add a comma-separated list of the attributes to include. For example, when you append `?expand=members,roles` to the [Get team](/tag/Teams-(beta)#operation/getTeam) endpoint, the expanded response includes both of these attributes.
+
 ## Updates
 
 Resources that accept partial updates use the `PATCH` verb, and support the [JSON Patch](https://datatracker.ietf.org/doc/html/rfc6902) format. Some resources also support the [JSON Merge Patch](https://datatracker.ietf.org/doc/html/rfc7386) format. In addition, some resources support optional comments that can be submitted with updates. Comments appear in outgoing webhooks, the audit log, and other integrations.
@@ -396,7 +404,7 @@ We mark beta resources with a \"Beta\" callout in our documentation, pictured be
 
 > ### This feature is in beta
 >
-> To use this feature, pass in a header including the `LD-API-Version` key with value set to `beta`. Use this header with each call. To learn more, read [Beta resources](/#section/Beta-resources).
+> To use this feature, pass in a header including the `LD-API-Version` key with value set to `beta`. Use this header with each call. To learn more, read [Beta resources](/#section/Overview/Beta-resources).
 
 ### Using beta resources
 
@@ -450,7 +458,7 @@ If you would like to upgrade your integration to use a new API version, you can
 This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: 2.0
-- Package version: 8.0.0
+- Package version: 9.0.0
 - Build package: org.openapitools.codegen.languages.RubyClientCodegen
 For more information, please visit [https://support.launchdarkly.com](https://support.launchdarkly.com)
 
@@ -467,16 +475,16 @@ gem build launchdarkly_api.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./launchdarkly_api-8.0.0.gem
+gem install ./launchdarkly_api-9.0.0.gem
 ```
 
-(for development, run `gem install --dev ./launchdarkly_api-8.0.0.gem` to install the development dependencies)
+(for development, run `gem install --dev ./launchdarkly_api-9.0.0.gem` to install the development dependencies)
 
 or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
 
 Finally add this to the Gemfile:
 
-    gem 'launchdarkly_api', '~> 8.0.0'
+    gem 'launchdarkly_api', '~> 9.0.0'
 
 ### Install from Git
 
@@ -584,7 +592,13 @@ Class | Method | HTTP request | Description
 *LaunchDarklyApi::EnvironmentsApi* | [**post_environment**](docs/EnvironmentsApi.md#post_environment) | **POST** /api/v2/projects/{projectKey}/environments | Create environment
 *LaunchDarklyApi::EnvironmentsApi* | [**reset_environment_mobile_key**](docs/EnvironmentsApi.md#reset_environment_mobile_key) | **POST** /api/v2/projects/{projectKey}/environments/{environmentKey}/mobileKey | Reset environment mobile SDK key
 *LaunchDarklyApi::EnvironmentsApi* | [**reset_environment_sdk_key**](docs/EnvironmentsApi.md#reset_environment_sdk_key) | **POST** /api/v2/projects/{projectKey}/environments/{environmentKey}/apiKey | Reset environment SDK key
-*LaunchDarklyApi::ExperimentsBetaApi* | [**get_experiment**](docs/ExperimentsBetaApi.md#get_experiment) | **GET** /api/v2/flags/{projectKey}/{featureFlagKey}/experiments/{environmentKey}/{metricKey} | Get experiment results
+*LaunchDarklyApi::ExperimentsBetaApi* | [**create_experiment**](docs/ExperimentsBetaApi.md#create_experiment) | **POST** /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments | Create experiment
+*LaunchDarklyApi::ExperimentsBetaApi* | [**create_iteration**](docs/ExperimentsBetaApi.md#create_iteration) | **POST** /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments/{experimentKey}/iterations | Create iteration
+*LaunchDarklyApi::ExperimentsBetaApi* | [**get_experiment**](docs/ExperimentsBetaApi.md#get_experiment) | **GET** /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments/{experimentKey} | Get experiment
+*LaunchDarklyApi::ExperimentsBetaApi* | [**get_experiment_results**](docs/ExperimentsBetaApi.md#get_experiment_results) | **GET** /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments/{experimentKey}/metrics/{metricKey}/results | Get experiment results
+*LaunchDarklyApi::ExperimentsBetaApi* | [**get_experiments**](docs/ExperimentsBetaApi.md#get_experiments) | **GET** /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments | Get experiments
+*LaunchDarklyApi::ExperimentsBetaApi* | [**get_legacy_experiment_results**](docs/ExperimentsBetaApi.md#get_legacy_experiment_results) | **GET** /api/v2/flags/{projectKey}/{featureFlagKey}/experiments/{environmentKey}/{metricKey} | Get legacy experiment results (deprecated)
+*LaunchDarklyApi::ExperimentsBetaApi* | [**patch_experiment**](docs/ExperimentsBetaApi.md#patch_experiment) | **PATCH** /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments/{experimentKey} | Patch experiment
 *LaunchDarklyApi::ExperimentsBetaApi* | [**reset_experiment**](docs/ExperimentsBetaApi.md#reset_experiment) | **DELETE** /api/v2/flags/{projectKey}/{featureFlagKey}/experiments/{environmentKey}/{metricKey}/results | Reset experiment results
 *LaunchDarklyApi::FeatureFlagsApi* | [**copy_feature_flag**](docs/FeatureFlagsApi.md#copy_feature_flag) | **POST** /api/v2/flags/{projectKey}/{featureFlagKey}/copy | Copy feature flag
 *LaunchDarklyApi::FeatureFlagsApi* | [**delete_feature_flag**](docs/FeatureFlagsApi.md#delete_feature_flag) | **DELETE** /api/v2/flags/{projectKey}/{featureFlagKey} | Delete feature flag
@@ -730,6 +744,7 @@ Class | Method | HTTP request | Description
  - [LaunchDarklyApi::CustomWorkflowOutputRep](docs/CustomWorkflowOutputRep.md)
  - [LaunchDarklyApi::CustomWorkflowStageMeta](docs/CustomWorkflowStageMeta.md)
  - [LaunchDarklyApi::CustomWorkflowsListingOutputRep](docs/CustomWorkflowsListingOutputRep.md)
+ - [LaunchDarklyApi::Decimal](docs/Decimal.md)
  - [LaunchDarklyApi::DefaultClientSideAvailabilityPost](docs/DefaultClientSideAvailabilityPost.md)
  - [LaunchDarklyApi::Defaults](docs/Defaults.md)
  - [LaunchDarklyApi::DependentFlag](docs/DependentFlag.md)
@@ -740,14 +755,18 @@ Class | Method | HTTP request | Description
  - [LaunchDarklyApi::Destinations](docs/Destinations.md)
  - [LaunchDarklyApi::Environment](docs/Environment.md)
  - [LaunchDarklyApi::EnvironmentPost](docs/EnvironmentPost.md)
+ - [LaunchDarklyApi::EvaluationReason](docs/EvaluationReason.md)
  - [LaunchDarklyApi::ExecutionOutputRep](docs/ExecutionOutputRep.md)
  - [LaunchDarklyApi::ExperimentAllocationRep](docs/ExperimentAllocationRep.md)
+ - [LaunchDarklyApi::ExperimentCollectionRep](docs/ExperimentCollectionRep.md)
  - [LaunchDarklyApi::ExperimentEnabledPeriodRep](docs/ExperimentEnabledPeriodRep.md)
  - [LaunchDarklyApi::ExperimentEnvironmentSettingRep](docs/ExperimentEnvironmentSettingRep.md)
  - [LaunchDarklyApi::ExperimentInfoRep](docs/ExperimentInfoRep.md)
  - [LaunchDarklyApi::ExperimentMetadataRep](docs/ExperimentMetadataRep.md)
+ - [LaunchDarklyApi::ExperimentPatchInput](docs/ExperimentPatchInput.md)
+ - [LaunchDarklyApi::ExperimentPost](docs/ExperimentPost.md)
  - [LaunchDarklyApi::ExperimentRep](docs/ExperimentRep.md)
- - [LaunchDarklyApi::ExperimentResultsRep](docs/ExperimentResultsRep.md)
+ - [LaunchDarklyApi::ExperimentResults](docs/ExperimentResults.md)
  - [LaunchDarklyApi::ExperimentStatsRep](docs/ExperimentStatsRep.md)
  - [LaunchDarklyApi::ExperimentTimeSeriesSlice](docs/ExperimentTimeSeriesSlice.md)
  - [LaunchDarklyApi::ExperimentTimeSeriesVariationSlice](docs/ExperimentTimeSeriesVariationSlice.md)
@@ -774,11 +793,13 @@ Class | Method | HTTP request | Description
  - [LaunchDarklyApi::FlagCopyConfigEnvironment](docs/FlagCopyConfigEnvironment.md)
  - [LaunchDarklyApi::FlagCopyConfigPost](docs/FlagCopyConfigPost.md)
  - [LaunchDarklyApi::FlagGlobalAttributesRep](docs/FlagGlobalAttributesRep.md)
+ - [LaunchDarklyApi::FlagInput](docs/FlagInput.md)
  - [LaunchDarklyApi::FlagLinkCollectionRep](docs/FlagLinkCollectionRep.md)
  - [LaunchDarklyApi::FlagLinkMember](docs/FlagLinkMember.md)
  - [LaunchDarklyApi::FlagLinkPost](docs/FlagLinkPost.md)
  - [LaunchDarklyApi::FlagLinkRep](docs/FlagLinkRep.md)
  - [LaunchDarklyApi::FlagListingRep](docs/FlagListingRep.md)
+ - [LaunchDarklyApi::FlagRep](docs/FlagRep.md)
  - [LaunchDarklyApi::FlagScheduledChangesInput](docs/FlagScheduledChangesInput.md)
  - [LaunchDarklyApi::FlagStatusRep](docs/FlagStatusRep.md)
  - [LaunchDarklyApi::FlagSummary](docs/FlagSummary.md)
@@ -801,6 +822,9 @@ Class | Method | HTTP request | Description
  - [LaunchDarklyApi::Integrations](docs/Integrations.md)
  - [LaunchDarklyApi::InvalidRequestErrorRep](docs/InvalidRequestErrorRep.md)
  - [LaunchDarklyApi::IpList](docs/IpList.md)
+ - [LaunchDarklyApi::IterationExpandableProperties](docs/IterationExpandableProperties.md)
+ - [LaunchDarklyApi::IterationInput](docs/IterationInput.md)
+ - [LaunchDarklyApi::IterationRep](docs/IterationRep.md)
  - [LaunchDarklyApi::LastSeenMetadata](docs/LastSeenMetadata.md)
  - [LaunchDarklyApi::Link](docs/Link.md)
  - [LaunchDarklyApi::Member](docs/Member.md)
@@ -813,6 +837,7 @@ Class | Method | HTTP request | Description
  - [LaunchDarklyApi::Members](docs/Members.md)
  - [LaunchDarklyApi::MethodNotAllowedErrorRep](docs/MethodNotAllowedErrorRep.md)
  - [LaunchDarklyApi::MetricCollectionRep](docs/MetricCollectionRep.md)
+ - [LaunchDarklyApi::MetricInput](docs/MetricInput.md)
  - [LaunchDarklyApi::MetricListingRep](docs/MetricListingRep.md)
  - [LaunchDarklyApi::MetricPost](docs/MetricPost.md)
  - [LaunchDarklyApi::MetricRep](docs/MetricRep.md)
@@ -822,6 +847,8 @@ Class | Method | HTTP request | Description
  - [LaunchDarklyApi::MultiEnvironmentDependentFlags](docs/MultiEnvironmentDependentFlags.md)
  - [LaunchDarklyApi::NewMemberForm](docs/NewMemberForm.md)
  - [LaunchDarklyApi::NotFoundErrorRep](docs/NotFoundErrorRep.md)
+ - [LaunchDarklyApi::NullDecimal](docs/NullDecimal.md)
+ - [LaunchDarklyApi::ParameterRep](docs/ParameterRep.md)
  - [LaunchDarklyApi::ParentResourceRep](docs/ParentResourceRep.md)
  - [LaunchDarklyApi::PatchFailedErrorRep](docs/PatchFailedErrorRep.md)
  - [LaunchDarklyApi::PatchOperation](docs/PatchOperation.md)
@@ -901,6 +928,9 @@ Class | Method | HTTP request | Description
  - [LaunchDarklyApi::Token](docs/Token.md)
  - [LaunchDarklyApi::TokenDataRep](docs/TokenDataRep.md)
  - [LaunchDarklyApi::Tokens](docs/Tokens.md)
+ - [LaunchDarklyApi::TreatmentInput](docs/TreatmentInput.md)
+ - [LaunchDarklyApi::TreatmentParameterInput](docs/TreatmentParameterInput.md)
+ - [LaunchDarklyApi::TreatmentRep](docs/TreatmentRep.md)
  - [LaunchDarklyApi::TriggerPost](docs/TriggerPost.md)
  - [LaunchDarklyApi::TriggerWorkflowCollectionRep](docs/TriggerWorkflowCollectionRep.md)
  - [LaunchDarklyApi::TriggerWorkflowRep](docs/TriggerWorkflowRep.md)

data/docs/ActionOutputRep.md

@@ -5,7 +5,7 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **kind** | **String** |  |  |
-| **instructions** | **Array<Hash>** |  |  |
+| **instructions** | **Array<Object>** |  |  |
 
 ## Example
 

data/docs/ApprovalsApi.md

@@ -266,7 +266,7 @@ api_instance = LaunchDarklyApi::ApprovalsApi.new
 project_key = 'project_key_example' # String | The project key
 feature_flag_key = 'feature_flag_key_example' # String | The feature flag key
 environment_key = 'environment_key_example' # String | The environment key
-create_flag_config_approval_request_request = LaunchDarklyApi::CreateFlagConfigApprovalRequestRequest.new({description: 'description_example', instructions: [{ key: 3.56}], notify_member_ids: ['notify_member_ids_example']}) # CreateFlagConfigApprovalRequestRequest | 
+create_flag_config_approval_request_request = LaunchDarklyApi::CreateFlagConfigApprovalRequestRequest.new({description: 'description_example', instructions: [3.56], notify_member_ids: ['notify_member_ids_example']}) # CreateFlagConfigApprovalRequestRequest | 
 
 begin
   # Create approval request

data/docs/Conflict.md

@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **instruction** | **Hash<String, Object>** |  | [optional] |
+| **instruction** | **Object** |  | [optional] |
 | **reason** | **String** | Reason why the conflict exists | [optional] |
 
 ## Example

data/docs/CreateFlagConfigApprovalRequestRequest.md

@@ -6,7 +6,7 @@
 | ---- | ---- | ----------- | ----- |
 | **comment** | **String** | A comment describing the approval request | [optional] |
 | **description** | **String** | A human-friendly name for the approval request |  |
-| **instructions** | **Array<Hash>** |  |  |
+| **instructions** | **Array<Object>** |  |  |
 | **notify_member_ids** | **Array<String>** | An array of member IDs. These members are notified to review the approval request |  |
 | **execution_date** | **Integer** |  | [optional] |
 | **operating_on_id** | **String** | ID of scheduled change to edit or delete | [optional] |

data/docs/Decimal.md

@@ -0,0 +1,20 @@
+# LaunchDarklyApi::Decimal
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **value** | **Object** |  | [optional] |
+| **exp** | **Integer** |  | [optional] |
+
+## Example
+
+```ruby
+require 'launchdarkly_api'
+
+instance = LaunchDarklyApi::Decimal.new(
+  value: null,
+  exp: null
+)
+```
+

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/ExperimentCollectionRep.md

@@ -0,0 +1,22 @@
+# LaunchDarklyApi::ExperimentCollectionRep
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **items** | [**Array<ExperimentRep>**](ExperimentRep.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/ExperimentPatchInput.md

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

data/docs/ExperimentPost.md

@@ -0,0 +1,26 @@
+# LaunchDarklyApi::ExperimentPost
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** |  |  |
+| **description** | **String** |  |  |
+| **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,