launchdarkly_api 8.0.0 → 10.0.0

data/docs/ExperimentsBetaApi.md

@@ -4,17 +4,410 @@ All URIs are relative to *https://app.launchdarkly.com*
 
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |
-| [**get_experiment**](ExperimentsBetaApi.md#get_experiment) | **GET** /api/v2/flags/{projectKey}/{featureFlagKey}/experiments/{environmentKey}/{metricKey} | Get experiment results |
+| [**create_experiment**](ExperimentsBetaApi.md#create_experiment) | **POST** /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments | Create experiment |
+| [**create_iteration**](ExperimentsBetaApi.md#create_iteration) | **POST** /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments/{experimentKey}/iterations | Create iteration |
+| [**get_experiment**](ExperimentsBetaApi.md#get_experiment) | **GET** /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments/{experimentKey} | Get experiment |
+| [**get_experiment_results**](ExperimentsBetaApi.md#get_experiment_results) | **GET** /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments/{experimentKey}/metrics/{metricKey}/results | Get experiment results |
+| [**get_experiments**](ExperimentsBetaApi.md#get_experiments) | **GET** /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments | Get experiments |
+| [**get_legacy_experiment_results**](ExperimentsBetaApi.md#get_legacy_experiment_results) | **GET** /api/v2/flags/{projectKey}/{featureFlagKey}/experiments/{environmentKey}/{metricKey} | Get legacy experiment results (deprecated) |
+| [**patch_experiment**](ExperimentsBetaApi.md#patch_experiment) | **PATCH** /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments/{experimentKey} | Patch experiment |
 | [**reset_experiment**](ExperimentsBetaApi.md#reset_experiment) | **DELETE** /api/v2/flags/{projectKey}/{featureFlagKey}/experiments/{environmentKey}/{metricKey}/results | Reset experiment results |
 
 
+## create_experiment
+
+> <Experiment> create_experiment(project_key, environment_key, experiment_post)
+
+Create experiment
+
+Create an experiment. To learn more, read [Creating experiments](https://docs.launchdarkly.com/home/creating-experiments).
+
+### 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::ExperimentsBetaApi.new
+project_key = 'project_key_example' # String | The project key
+environment_key = 'environment_key_example' # String | The environment key
+experiment_post = LaunchDarklyApi::ExperimentPost.new({name: 'name_example', maintainer_id: 'maintainer_id_example', key: 'key_example', iteration: LaunchDarklyApi::IterationInput.new({hypothesis: 'hypothesis_example', metrics: [LaunchDarklyApi::MetricInput.new({key: 'key_example', primary: false})], treatments: [LaunchDarklyApi::TreatmentInput.new({name: 'name_example', baseline: false, allocation_percent: 'allocation_percent_example', parameters: [LaunchDarklyApi::TreatmentParameterInput.new({flag_key: 'flag_key_example', variation_id: 'variation_id_example'})]})], flags: { key: LaunchDarklyApi::FlagInput.new({rule_id: 'rule_id_example', flag_config_version: 37})}})}) # ExperimentPost | 
+
+begin
+  # Create experiment
+  result = api_instance.create_experiment(project_key, environment_key, experiment_post)
+  p result
+rescue LaunchDarklyApi::ApiError => e
+  puts "Error when calling ExperimentsBetaApi->create_experiment: #{e}"
+end
+```
+
+#### Using the create_experiment_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Experiment>, Integer, Hash)> create_experiment_with_http_info(project_key, environment_key, experiment_post)
+
+```ruby
+begin
+  # Create experiment
+  data, status_code, headers = api_instance.create_experiment_with_http_info(project_key, environment_key, experiment_post)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Experiment>
+rescue LaunchDarklyApi::ApiError => e
+  puts "Error when calling ExperimentsBetaApi->create_experiment_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **project_key** | **String** | The project key |  |
+| **environment_key** | **String** | The environment key |  |
+| **experiment_post** | [**ExperimentPost**](ExperimentPost.md) |  |  |
+
+### Return type
+
+[**Experiment**](Experiment.md)
+
+### Authorization
+
+[ApiKey](../README.md#ApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## create_iteration
+
+> <IterationRep> create_iteration(project_key, environment_key, experiment_key, iteration_input)
+
+Create iteration
+
+Create an experiment iteration. Experiment iterations let you record experiments in discrete blocks of time. To learn more, read [Starting experiment iterations](https://docs.launchdarkly.com/home/creating-experiments#starting-experiment-iterations).
+
+### 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::ExperimentsBetaApi.new
+project_key = 'project_key_example' # String | The project key
+environment_key = 'environment_key_example' # String | The environment key
+experiment_key = 'experiment_key_example' # String | The experiment key
+iteration_input = LaunchDarklyApi::IterationInput.new({hypothesis: 'hypothesis_example', metrics: [LaunchDarklyApi::MetricInput.new({key: 'key_example', primary: false})], treatments: [LaunchDarklyApi::TreatmentInput.new({name: 'name_example', baseline: false, allocation_percent: 'allocation_percent_example', parameters: [LaunchDarklyApi::TreatmentParameterInput.new({flag_key: 'flag_key_example', variation_id: 'variation_id_example'})]})], flags: { key: LaunchDarklyApi::FlagInput.new({rule_id: 'rule_id_example', flag_config_version: 37})}}) # IterationInput | 
+
+begin
+  # Create iteration
+  result = api_instance.create_iteration(project_key, environment_key, experiment_key, iteration_input)
+  p result
+rescue LaunchDarklyApi::ApiError => e
+  puts "Error when calling ExperimentsBetaApi->create_iteration: #{e}"
+end
+```
+
+#### Using the create_iteration_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<IterationRep>, Integer, Hash)> create_iteration_with_http_info(project_key, environment_key, experiment_key, iteration_input)
+
+```ruby
+begin
+  # Create iteration
+  data, status_code, headers = api_instance.create_iteration_with_http_info(project_key, environment_key, experiment_key, iteration_input)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <IterationRep>
+rescue LaunchDarklyApi::ApiError => e
+  puts "Error when calling ExperimentsBetaApi->create_iteration_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **project_key** | **String** | The project key |  |
+| **environment_key** | **String** | The environment key |  |
+| **experiment_key** | **String** | The experiment key |  |
+| **iteration_input** | [**IterationInput**](IterationInput.md) |  |  |
+
+### Return type
+
+[**IterationRep**](IterationRep.md)
+
+### Authorization
+
+[ApiKey](../README.md#ApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
 ## get_experiment
 
-> <ExperimentResultsRep> get_experiment(project_key, feature_flag_key, environment_key, metric_key, opts)
+> <Experiment> get_experiment(project_key, environment_key, experiment_key)
+
+Get experiment
+
+Get details about an experiment.
+
+### 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::ExperimentsBetaApi.new
+project_key = 'project_key_example' # String | The project key
+environment_key = 'environment_key_example' # String | The environment key
+experiment_key = 'experiment_key_example' # String | The experiment key
+
+begin
+  # Get experiment
+  result = api_instance.get_experiment(project_key, environment_key, experiment_key)
+  p result
+rescue LaunchDarklyApi::ApiError => e
+  puts "Error when calling ExperimentsBetaApi->get_experiment: #{e}"
+end
+```
+
+#### Using the get_experiment_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Experiment>, Integer, Hash)> get_experiment_with_http_info(project_key, environment_key, experiment_key)
+
+```ruby
+begin
+  # Get experiment
+  data, status_code, headers = api_instance.get_experiment_with_http_info(project_key, environment_key, experiment_key)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Experiment>
+rescue LaunchDarklyApi::ApiError => e
+  puts "Error when calling ExperimentsBetaApi->get_experiment_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **project_key** | **String** | The project key |  |
+| **environment_key** | **String** | The environment key |  |
+| **experiment_key** | **String** | The experiment key |  |
+
+### Return type
+
+[**Experiment**](Experiment.md)
+
+### Authorization
+
+[ApiKey](../README.md#ApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_experiment_results
+
+> <ExperimentBayesianResultsRep> get_experiment_results(project_key, environment_key, experiment_key, metric_key)
 
 Get experiment results
 
-Get detailed experiment result data
+Get results from an experiment for a particular metric.
+
+### 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::ExperimentsBetaApi.new
+project_key = 'project_key_example' # String | The project key
+environment_key = 'environment_key_example' # String | The environment key
+experiment_key = 'experiment_key_example' # String | The experiment key
+metric_key = 'metric_key_example' # String | The metric key
+
+begin
+  # Get experiment results
+  result = api_instance.get_experiment_results(project_key, environment_key, experiment_key, metric_key)
+  p result
+rescue LaunchDarklyApi::ApiError => e
+  puts "Error when calling ExperimentsBetaApi->get_experiment_results: #{e}"
+end
+```
+
+#### Using the get_experiment_results_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ExperimentBayesianResultsRep>, Integer, Hash)> get_experiment_results_with_http_info(project_key, environment_key, experiment_key, metric_key)
+
+```ruby
+begin
+  # Get experiment results
+  data, status_code, headers = api_instance.get_experiment_results_with_http_info(project_key, environment_key, experiment_key, metric_key)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ExperimentBayesianResultsRep>
+rescue LaunchDarklyApi::ApiError => e
+  puts "Error when calling ExperimentsBetaApi->get_experiment_results_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **project_key** | **String** | The project key |  |
+| **environment_key** | **String** | The environment key |  |
+| **experiment_key** | **String** | The experiment key |  |
+| **metric_key** | **String** | The metric key |  |
+
+### Return type
+
+[**ExperimentBayesianResultsRep**](ExperimentBayesianResultsRep.md)
+
+### Authorization
+
+[ApiKey](../README.md#ApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_experiments
+
+> <ExperimentCollectionRep> get_experiments(project_key, environment_key, opts)
+
+Get experiments
+
+Get details about all experiments in an environment.  ### Filtering experiments  LaunchDarkly supports the `filter` query param for filtering, with the following fields:  - `flagKey` filters for only experiments that use the flag with the given key. - `metricKey` filters for only experiments that use the metric with the given key. - `status` filters for only experiments with an iteration with the given status. An iteration can have the status `not_started`, `running` or `stopped`.  For example, `filter=flagKey:my-flag,status:running,metricKey:page-load-ms` filters for experiments for the given flag key and the given metric key which have a currently running iteration.  ### Expanding the experiments response LaunchDarkly supports four fields for expanding the \"List experiments\" response. By default, these fields are **not** included in the response.  To expand the response, append the `expand` query parameter and add a comma-separated list with any of the following fields:  - `previousIterations` includes all iterations prior to the current iteration.  By default only the current iteration will be included in the response. - `draftIteration` includes a draft of an iteration which has not been started yet, if any. - `secondaryMetrics` includes secondary metrics.  By default only the primary metric is included in the response. - `treatments` includes all treatment and parameter details.  By default treatment data will not be included in the response.  For example, `expand=draftIteration,treatments` includes the `draftIteration` and `treatments` fields in the response. 
+
+### 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::ExperimentsBetaApi.new
+project_key = 'project_key_example' # String | The project key
+environment_key = 'environment_key_example' # String | The environment key
+opts = {
+  limit: 789, # Integer | The maximum number of experiments to return. Defaults to 20
+  offset: 789, # Integer | Where to start in the list. Use this 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`. Supported fields are explained above.
+  expand: 'expand_example' # String | A comma-separated list of properties that can reveal additional information in the response. Supported fields are explained above.
+}
+
+begin
+  # Get experiments
+  result = api_instance.get_experiments(project_key, environment_key, opts)
+  p result
+rescue LaunchDarklyApi::ApiError => e
+  puts "Error when calling ExperimentsBetaApi->get_experiments: #{e}"
+end
+```
+
+#### Using the get_experiments_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ExperimentCollectionRep>, Integer, Hash)> get_experiments_with_http_info(project_key, environment_key, opts)
+
+```ruby
+begin
+  # Get experiments
+  data, status_code, headers = api_instance.get_experiments_with_http_info(project_key, environment_key, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ExperimentCollectionRep>
+rescue LaunchDarklyApi::ApiError => e
+  puts "Error when calling ExperimentsBetaApi->get_experiments_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **project_key** | **String** | The project key |  |
+| **environment_key** | **String** | The environment key |  |
+| **limit** | **Integer** | The maximum number of experiments to return. Defaults to 20 | [optional] |
+| **offset** | **Integer** | Where to start in the list. Use this 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;. Supported fields are explained above. | [optional] |
+| **expand** | **String** | A comma-separated list of properties that can reveal additional information in the response. Supported fields are explained above. | [optional] |
+
+### Return type
+
+[**ExperimentCollectionRep**](ExperimentCollectionRep.md)
+
+### Authorization
+
+[ApiKey](../README.md#ApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_legacy_experiment_results
+
+> <ExperimentResults> get_legacy_experiment_results(project_key, feature_flag_key, environment_key, metric_key, opts)
+
+Get legacy experiment results (deprecated)
+
+Get detailed experiment result data for legacy experiments.
 
 ### Examples
 
@@ -40,29 +433,29 @@ opts = {
 }
 
 begin
-  # Get experiment results
-  result = api_instance.get_experiment(project_key, feature_flag_key, environment_key, metric_key, opts)
+  # Get legacy experiment results (deprecated)
+  result = api_instance.get_legacy_experiment_results(project_key, feature_flag_key, environment_key, metric_key, opts)
   p result
 rescue LaunchDarklyApi::ApiError => e
-  puts "Error when calling ExperimentsBetaApi->get_experiment: #{e}"
+  puts "Error when calling ExperimentsBetaApi->get_legacy_experiment_results: #{e}"
 end
 ```
 
-#### Using the get_experiment_with_http_info variant
+#### Using the get_legacy_experiment_results_with_http_info variant
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<ExperimentResultsRep>, Integer, Hash)> get_experiment_with_http_info(project_key, feature_flag_key, environment_key, metric_key, opts)
+> <Array(<ExperimentResults>, Integer, Hash)> get_legacy_experiment_results_with_http_info(project_key, feature_flag_key, environment_key, metric_key, opts)
 
 ```ruby
 begin
-  # Get experiment results
-  data, status_code, headers = api_instance.get_experiment_with_http_info(project_key, feature_flag_key, environment_key, metric_key, opts)
+  # Get legacy experiment results (deprecated)
+  data, status_code, headers = api_instance.get_legacy_experiment_results_with_http_info(project_key, feature_flag_key, environment_key, metric_key, opts)
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => <ExperimentResultsRep>
+  p data # => <ExperimentResults>
 rescue LaunchDarklyApi::ApiError => e
-  puts "Error when calling ExperimentsBetaApi->get_experiment_with_http_info: #{e}"
+  puts "Error when calling ExperimentsBetaApi->get_legacy_experiment_results_with_http_info: #{e}"
 end
 ```
 
@@ -79,7 +472,7 @@ end
 
 ### Return type
 
-[**ExperimentResultsRep**](ExperimentResultsRep.md)
+[**ExperimentResults**](ExperimentResults.md)
 
 ### Authorization
 
@@ -91,13 +484,90 @@ end
 - **Accept**: application/json
 
 
+## patch_experiment
+
+> <Experiment> patch_experiment(project_key, environment_key, experiment_key, experiment_patch_input)
+
+Patch experiment
+
+Update an experiment. Updating an experiment uses the semantic patch format.  To make a semantic patch request, you must append `domain-model=launchdarkly.semanticpatch` to your `Content-Type` header. To learn more, read [Updates using semantic patch](/reference#updates-using-semantic-patch).  ### Instructions  Semantic patch requests support the following `kind` instructions for updating experiments.  #### updateName  Updates the experiment name.  ##### Parameters  - `value`: The new name.  #### updateDescription  Updates the experiment description.  ##### Parameters  - `value`: The new description.  #### startIteration  Starts a new iteration for this experiment.  #### stopIteration  Stops the current iteration for this experiment. 
+
+### 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::ExperimentsBetaApi.new
+project_key = 'project_key_example' # String | The project key
+environment_key = 'environment_key_example' # String | The environment key
+experiment_key = 'experiment_key_example' # String | The experiment key
+experiment_patch_input = LaunchDarklyApi::ExperimentPatchInput.new({instructions: [{ key: 3.56}]}) # ExperimentPatchInput | 
+
+begin
+  # Patch experiment
+  result = api_instance.patch_experiment(project_key, environment_key, experiment_key, experiment_patch_input)
+  p result
+rescue LaunchDarklyApi::ApiError => e
+  puts "Error when calling ExperimentsBetaApi->patch_experiment: #{e}"
+end
+```
+
+#### Using the patch_experiment_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Experiment>, Integer, Hash)> patch_experiment_with_http_info(project_key, environment_key, experiment_key, experiment_patch_input)
+
+```ruby
+begin
+  # Patch experiment
+  data, status_code, headers = api_instance.patch_experiment_with_http_info(project_key, environment_key, experiment_key, experiment_patch_input)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Experiment>
+rescue LaunchDarklyApi::ApiError => e
+  puts "Error when calling ExperimentsBetaApi->patch_experiment_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **project_key** | **String** | The project key |  |
+| **environment_key** | **String** | The environment key |  |
+| **experiment_key** | **String** | The experiment key |  |
+| **experiment_patch_input** | [**ExperimentPatchInput**](ExperimentPatchInput.md) |  |  |
+
+### Return type
+
+[**Experiment**](Experiment.md)
+
+### Authorization
+
+[ApiKey](../README.md#ApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
 ## reset_experiment
 
 > reset_experiment(project_key, feature_flag_key, environment_key, metric_key)
 
 Reset experiment results
 
-Reset all experiment results by deleting all existing data for an experiment
+Reset all experiment results by deleting all existing data for an experiment.
 
 ### Examples
 

data/docs/FeatureFlag.md

@@ -10,11 +10,10 @@
 | **key** | **String** | A unique key used to reference the flag in your code |  |
 | **_version** | **Integer** | Version of the feature flag |  |
 | **creation_date** | **Integer** |  |  |
-| **include_in_snippet** | **Boolean** | Deprecated, use clientSideAvailability. Whether or not this flag should be made available to the client-side JavaScript SDK | [optional] |
+| **include_in_snippet** | **Boolean** | Deprecated, use <code>clientSideAvailability</code>. Whether this flag should be made available to the client-side JavaScript SDK | [optional] |
 | **client_side_availability** | [**ClientSideAvailability**](ClientSideAvailability.md) |  | [optional] |
 | **variations** | [**Array<Variation>**](Variation.md) | An array of possible variations for the flag |  |
-| **variation_json_schema** | **Object** |  | [optional] |
-| **temporary** | **Boolean** | Whether or not the flag is a temporary flag |  |
+| **temporary** | **Boolean** | Whether the flag is a temporary flag |  |
 | **tags** | **Array<String>** | Tags for the feature flag |  |
 | **_links** | [**Hash<String, Link>**](Link.md) |  |  |
 | **maintainer_id** | **String** | Associated maintainerId for the feature flag | [optional] |
@@ -35,16 +34,15 @@ require 'launchdarkly_api'
 instance = LaunchDarklyApi::FeatureFlag.new(
   name: My Flag,
   kind: boolean,
-  description: null,
+  description: This flag controls the example widgets,
   key: my-flag,
   _version: 1,
   creation_date: null,
   include_in_snippet: true,
   client_side_availability: null,
   variations: [{"_id":"e432f62b-55f6-49dd-a02f-eb24acf39d05","value":true},{"_id":"a00bf58d-d252-476c-b915-15a74becacb4","value":false}],
-  variation_json_schema: null,
-  temporary: null,
-  tags: [],
+  temporary: true,
+  tags: ["example-tag"],
   _links: {"parent":{"href":"/api/v2/flags/my-project","type":"application/json"},"self":{"href":"/api/v2/flags/my-project/my-flag","type":"application/json"}},
   maintainer_id: 569f183514f4432160000007,
   _maintainer: null,

data/docs/FeatureFlagBody.md

@@ -5,13 +5,12 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **name** | **String** | A human-friendly name for the feature flag |  |
-| **key** | **String** | A unique key to reference the flag in your code |  |
+| **key** | **String** | A unique key used to reference the flag in your code |  |
 | **description** | **String** | Description of the feature flag | [optional] |
-| **include_in_snippet** | **Boolean** | Deprecated, use clientSideAvailability. Whether or not this flag should be made available to the client-side JavaScript SDK | [optional] |
+| **include_in_snippet** | **Boolean** | Deprecated, use <code>clientSideAvailability</code>. Whether this flag should be made available to the client-side JavaScript SDK. | [optional] |
 | **client_side_availability** | [**ClientSideAvailabilityPost**](ClientSideAvailabilityPost.md) |  | [optional] |
 | **variations** | [**Array<Variation>**](Variation.md) | An array of possible variations for the flag. The variation values must be unique. | [optional] |
-| **variation_json_schema** | **Object** |  | [optional] |
-| **temporary** | **Boolean** | Whether or not the flag is a temporary flag | [optional] |
+| **temporary** | **Boolean** | Whether the flag is a temporary flag. Defaults to true. | [optional] |
 | **tags** | **Array<String>** | Tags for the feature flag | [optional] |
 | **custom_properties** | [**Hash<String, CustomProperty>**](CustomProperty.md) |  | [optional] |
 | **defaults** | [**Defaults**](Defaults.md) |  | [optional] |
@@ -22,15 +21,14 @@
 require 'launchdarkly_api'
 
 instance = LaunchDarklyApi::FeatureFlagBody.new(
-  name: null,
-  key: null,
-  description: null,
+  name: My flag,
+  key: my-flag,
+  description: This flag controls the example widgets,
   include_in_snippet: null,
   client_side_availability: null,
-  variations: null,
-  variation_json_schema: null,
-  temporary: null,
-  tags: null,
+  variations: [{"value":true},{"value":false}],
+  temporary: false,
+  tags: ["example-tag"],
   custom_properties: null,
   defaults: null
 )

data/docs/FeatureFlagConfig.md

@@ -10,11 +10,11 @@
 | **sel** | **String** |  |  |
 | **last_modified** | **Integer** |  |  |
 | **version** | **Integer** |  |  |
-| **targets** | [**Array<Target>**](Target.md) |  |  |
-| **rules** | [**Array<Rule>**](Rule.md) |  |  |
-| **fallthrough** | [**VariationOrRolloutRep**](VariationOrRolloutRep.md) |  |  |
+| **targets** | [**Array<Target>**](Target.md) |  | [optional] |
+| **rules** | [**Array<Rule>**](Rule.md) |  | [optional] |
+| **fallthrough** | [**VariationOrRolloutRep**](VariationOrRolloutRep.md) |  | [optional] |
 | **off_variation** | **Integer** |  | [optional] |
-| **prerequisites** | [**Array<Prerequisite>**](Prerequisite.md) |  |  |
+| **prerequisites** | [**Array<Prerequisite>**](Prerequisite.md) |  | [optional] |
 | **_site** | [**Link**](Link.md) |  |  |
 | **_access** | [**Access**](Access.md) |  | [optional] |
 | **_environment_name** | **String** |  |  |

data/docs/FeatureFlagScheduledChange.md

@@ -6,12 +6,12 @@
 | ---- | ---- | ----------- | ----- |
 | **_id** | **String** |  |  |
 | **_creation_date** | **Integer** |  |  |
-| **_maintainer_id** | **String** |  |  |
-| **_version** | **Integer** |  |  |
+| **_maintainer_id** | **String** | The ID of the scheduled change maintainer |  |
+| **_version** | **Integer** | Version of the scheduled change |  |
 | **execution_date** | **Integer** |  |  |
 | **instructions** | **Array<Hash>** |  |  |
-| **conflicts** | **Object** |  | [optional] |
-| **_links** | [**Hash<String, Link>**](Link.md) |  | [optional] |
+| **conflicts** | **Object** | Details on any conflicting scheduled changes | [optional] |
+| **_links** | [**Hash<String, Link>**](Link.md) | Links to other resources within the API. Includes the URL and content type of those resources. | [optional] |
 
 ## Example
 
@@ -21,8 +21,8 @@ require 'launchdarkly_api'
 instance = LaunchDarklyApi::FeatureFlagScheduledChange.new(
   _id: null,
   _creation_date: null,
-  _maintainer_id: null,
-  _version: null,
+  _maintainer_id: 12ab3c45de678910abc12345,
+  _version: 1,
   execution_date: null,
   instructions: null,
   conflicts: null,