launchdarkly_api 5.4.0 → 6.0.0

data/docs/RepositoryCollectionRep.md

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

data/docs/RepositoryPost.md

@@ -0,0 +1,28 @@
+# LaunchDarklyApi::RepositoryPost
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** |  |  |
+| **source_link** | **String** |  | [optional] |
+| **commit_url_template** | **String** |  | [optional] |
+| **hunk_url_template** | **String** |  | [optional] |
+| **type** | **String** | Optionally specify a repository type. The default value is <code>custom</code> | [optional] |
+| **default_branch** | **String** | The default branch, if not specified, is <code>master</code> | [optional] |
+
+## Example
+
+```ruby
+require 'launchdarkly_api'
+
+instance = LaunchDarklyApi::RepositoryPost.new(
+  name: null,
+  source_link: null,
+  commit_url_template: null,
+  hunk_url_template: null,
+  type: null,
+  default_branch: null
+)
+```
+

data/docs/RepositoryRep.md

@@ -0,0 +1,38 @@
+# LaunchDarklyApi::RepositoryRep
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** |  |  |
+| **source_link** | **String** |  | [optional] |
+| **commit_url_template** | **String** |  | [optional] |
+| **hunk_url_template** | **String** |  | [optional] |
+| **type** | **String** |  |  |
+| **default_branch** | **String** |  |  |
+| **enabled** | **Boolean** |  |  |
+| **version** | **Integer** |  |  |
+| **branches** | [**Array<BranchRep>**](BranchRep.md) |  | [optional] |
+| **_links** | **Hash<String, Object>** |  |  |
+| **_access** | [**AccessRep**](AccessRep.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'launchdarkly_api'
+
+instance = LaunchDarklyApi::RepositoryRep.new(
+  name: null,
+  source_link: null,
+  commit_url_template: null,
+  hunk_url_template: null,
+  type: null,
+  default_branch: null,
+  enabled: null,
+  version: null,
+  branches: null,
+  _links: null,
+  _access: null
+)
+```
+

data/docs/ResourceAccess.md

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

data/docs/ResourceIDResponse.md

@@ -0,0 +1,26 @@
+# LaunchDarklyApi::ResourceIDResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **kind** | **String** |  | [optional] |
+| **project_key** | **String** |  | [optional] |
+| **environment_key** | **String** |  | [optional] |
+| **flag_key** | **String** |  | [optional] |
+| **key** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'launchdarkly_api'
+
+instance = LaunchDarklyApi::ResourceIDResponse.new(
+  kind: null,
+  project_key: null,
+  environment_key: null,
+  flag_key: null,
+  key: null
+)
+```
+

data/docs/ReviewResponse.md

@@ -0,0 +1,26 @@
+# LaunchDarklyApi::ReviewResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **_id** | **String** | The approval request id |  |
+| **kind** | **String** | The type of review action to take. Either \"approve\", \"decline\" or \"comment\" |  |
+| **creation_date** | **Integer** |  | [optional] |
+| **comment** | **String** | A comment describing the approval response | [optional] |
+| **member_id** | **String** | ID of account member that reviewed request | [optional] |
+
+## Example
+
+```ruby
+require 'launchdarkly_api'
+
+instance = LaunchDarklyApi::ReviewResponse.new(
+  _id: null,
+  kind: null,
+  creation_date: null,
+  comment: null,
+  member_id: null
+)
+```
+

data/docs/Rollout.md

@@ -1,9 +1,24 @@
 # LaunchDarklyApi::Rollout
 
 ## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**bucket_by** | **String** |  | [optional] 
-**variations** | [**Array<WeightedVariation>**](WeightedVariation.md) |  | [optional] 
 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **variations** | [**Array<WeightedVariation>**](WeightedVariation.md) |  |  |
+| **experiment_allocation** | [**ExperimentAllocationRep**](ExperimentAllocationRep.md) |  | [optional] |
+| **seed** | **Integer** |  | [optional] |
+| **bucket_by** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'launchdarkly_api'
+
+instance = LaunchDarklyApi::Rollout.new(
+  variations: null,
+  experiment_allocation: null,
+  seed: null,
+  bucket_by: null
+)
+```
 

data/docs/Rule.md

@@ -1,13 +1,28 @@
 # LaunchDarklyApi::Rule
 
 ## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**_id** | **String** |  | [optional] 
-**variation** | **Integer** |  | [optional] 
-**track_events** | **BOOLEAN** |  | [optional] 
-**rollout** | [**Rollout**](Rollout.md) |  | [optional] 
-**clauses** | [**Array<Clause>**](Clause.md) |  | [optional] 
-**description** | **String** |  | [optional] 
 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **_id** | **String** |  | [optional] |
+| **variation** | **Integer** |  | [optional] |
+| **rollout** | [**Rollout**](Rollout.md) |  | [optional] |
+| **clauses** | [**Array<Clause>**](Clause.md) |  |  |
+| **track_events** | **Boolean** |  |  |
+| **description** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'launchdarkly_api'
+
+instance = LaunchDarklyApi::Rule.new(
+  _id: null,
+  variation: null,
+  rollout: null,
+  clauses: null,
+  track_events: null,
+  description: null
+)
+```
 

data/docs/ScheduledChangesApi.md

@@ -0,0 +1,404 @@
+# LaunchDarklyApi::ScheduledChangesApi
+
+All URIs are relative to *https://app.launchdarkly.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**delete_flag_config_scheduled_changes**](ScheduledChangesApi.md#delete_flag_config_scheduled_changes) | **DELETE** /api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/scheduled-changes/{id} | Delete scheduled changes workflow |
+| [**get_feature_flag_scheduled_change**](ScheduledChangesApi.md#get_feature_flag_scheduled_change) | **GET** /api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/scheduled-changes/{id} | Get a scheduled change |
+| [**get_flag_config_scheduled_changes**](ScheduledChangesApi.md#get_flag_config_scheduled_changes) | **GET** /api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/scheduled-changes | List scheduled changes |
+| [**patch_flag_config_scheduled_change**](ScheduledChangesApi.md#patch_flag_config_scheduled_change) | **PATCH** /api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/scheduled-changes/{id} | Update scheduled changes workflow |
+| [**post_flag_config_scheduled_changes**](ScheduledChangesApi.md#post_flag_config_scheduled_changes) | **POST** /api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/scheduled-changes | Create scheduled changes workflow |
+
+
+## delete_flag_config_scheduled_changes
+
+> delete_flag_config_scheduled_changes(project_key, feature_flag_key, environment_key, id)
+
+Delete scheduled changes workflow
+
+Delete a scheduled changes workflow
+
+### 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::ScheduledChangesApi.new
+project_key = 'project_key_example' # String | The project key
+feature_flag_key = 'feature_flag_key_example' # String | The feature flag's key
+environment_key = 'environment_key_example' # String | The environment key
+id = 'id_example' # String | The scheduled change id
+
+begin
+  # Delete scheduled changes workflow
+  api_instance.delete_flag_config_scheduled_changes(project_key, feature_flag_key, environment_key, id)
+rescue LaunchDarklyApi::ApiError => e
+  puts "Error when calling ScheduledChangesApi->delete_flag_config_scheduled_changes: #{e}"
+end
+```
+
+#### Using the delete_flag_config_scheduled_changes_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_flag_config_scheduled_changes_with_http_info(project_key, feature_flag_key, environment_key, id)
+
+```ruby
+begin
+  # Delete scheduled changes workflow
+  data, status_code, headers = api_instance.delete_flag_config_scheduled_changes_with_http_info(project_key, feature_flag_key, environment_key, id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue LaunchDarklyApi::ApiError => e
+  puts "Error when calling ScheduledChangesApi->delete_flag_config_scheduled_changes_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **project_key** | **String** | The project key |  |
+| **feature_flag_key** | **String** | The feature flag&#39;s key |  |
+| **environment_key** | **String** | The environment key |  |
+| **id** | **String** | The scheduled change id |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[ApiKey](../README.md#ApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+
+
+## get_feature_flag_scheduled_change
+
+> <FeatureFlagScheduledChange> get_feature_flag_scheduled_change(project_key, feature_flag_key, environment_key, id)
+
+Get a scheduled change
+
+Get a scheduled change that will be applied to the feature flag 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::ScheduledChangesApi.new
+project_key = 'project_key_example' # String | The project key
+feature_flag_key = 'feature_flag_key_example' # String | The feature flag's key
+environment_key = 'environment_key_example' # String | The environment key
+id = 'id_example' # String | The scheduled change id
+
+begin
+  # Get a scheduled change
+  result = api_instance.get_feature_flag_scheduled_change(project_key, feature_flag_key, environment_key, id)
+  p result
+rescue LaunchDarklyApi::ApiError => e
+  puts "Error when calling ScheduledChangesApi->get_feature_flag_scheduled_change: #{e}"
+end
+```
+
+#### Using the get_feature_flag_scheduled_change_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<FeatureFlagScheduledChange>, Integer, Hash)> get_feature_flag_scheduled_change_with_http_info(project_key, feature_flag_key, environment_key, id)
+
+```ruby
+begin
+  # Get a scheduled change
+  data, status_code, headers = api_instance.get_feature_flag_scheduled_change_with_http_info(project_key, feature_flag_key, environment_key, id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <FeatureFlagScheduledChange>
+rescue LaunchDarklyApi::ApiError => e
+  puts "Error when calling ScheduledChangesApi->get_feature_flag_scheduled_change_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **project_key** | **String** | The project key |  |
+| **feature_flag_key** | **String** | The feature flag&#39;s key |  |
+| **environment_key** | **String** | The environment key |  |
+| **id** | **String** | The scheduled change id |  |
+
+### Return type
+
+[**FeatureFlagScheduledChange**](FeatureFlagScheduledChange.md)
+
+### Authorization
+
+[ApiKey](../README.md#ApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_flag_config_scheduled_changes
+
+> <FeatureFlagScheduledChanges> get_flag_config_scheduled_changes(project_key, feature_flag_key, environment_key)
+
+List scheduled changes
+
+Get a list of scheduled changes that will be applied to the feature flag.
+
+### 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::ScheduledChangesApi.new
+project_key = 'project_key_example' # String | The project key
+feature_flag_key = 'feature_flag_key_example' # String | The feature flag's key
+environment_key = 'environment_key_example' # String | The environment key
+
+begin
+  # List scheduled changes
+  result = api_instance.get_flag_config_scheduled_changes(project_key, feature_flag_key, environment_key)
+  p result
+rescue LaunchDarklyApi::ApiError => e
+  puts "Error when calling ScheduledChangesApi->get_flag_config_scheduled_changes: #{e}"
+end
+```
+
+#### Using the get_flag_config_scheduled_changes_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<FeatureFlagScheduledChanges>, Integer, Hash)> get_flag_config_scheduled_changes_with_http_info(project_key, feature_flag_key, environment_key)
+
+```ruby
+begin
+  # List scheduled changes
+  data, status_code, headers = api_instance.get_flag_config_scheduled_changes_with_http_info(project_key, feature_flag_key, environment_key)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <FeatureFlagScheduledChanges>
+rescue LaunchDarklyApi::ApiError => e
+  puts "Error when calling ScheduledChangesApi->get_flag_config_scheduled_changes_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **project_key** | **String** | The project key |  |
+| **feature_flag_key** | **String** | The feature flag&#39;s key |  |
+| **environment_key** | **String** | The environment key |  |
+
+### Return type
+
+[**FeatureFlagScheduledChanges**](FeatureFlagScheduledChanges.md)
+
+### Authorization
+
+[ApiKey](../README.md#ApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## patch_flag_config_scheduled_change
+
+> <FeatureFlagScheduledChange> patch_flag_config_scheduled_change(project_key, feature_flag_key, environment_key, id, flag_scheduled_changes_input, opts)
+
+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)
+
+### 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::ScheduledChangesApi.new
+project_key = 'project_key_example' # String | The project key
+feature_flag_key = 'feature_flag_key_example' # String | The feature flag's key
+environment_key = 'environment_key_example' # String | The environment key
+id = 'id_example' # String | The scheduled change ID
+flag_scheduled_changes_input = LaunchDarklyApi::FlagScheduledChangesInput.new({instructions: [{ key: 3.56}]}) # FlagScheduledChangesInput | 
+opts = {
+  ignore_conflicts: true # Boolean | Whether or not to succeed or fail when the new instructions conflict with existing scheduled changes
+}
+
+begin
+  # Update scheduled changes workflow
+  result = api_instance.patch_flag_config_scheduled_change(project_key, feature_flag_key, environment_key, id, flag_scheduled_changes_input, opts)
+  p result
+rescue LaunchDarklyApi::ApiError => e
+  puts "Error when calling ScheduledChangesApi->patch_flag_config_scheduled_change: #{e}"
+end
+```
+
+#### Using the patch_flag_config_scheduled_change_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<FeatureFlagScheduledChange>, Integer, Hash)> patch_flag_config_scheduled_change_with_http_info(project_key, feature_flag_key, environment_key, id, flag_scheduled_changes_input, opts)
+
+```ruby
+begin
+  # Update scheduled changes workflow
+  data, status_code, headers = api_instance.patch_flag_config_scheduled_change_with_http_info(project_key, feature_flag_key, environment_key, id, flag_scheduled_changes_input, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <FeatureFlagScheduledChange>
+rescue LaunchDarklyApi::ApiError => e
+  puts "Error when calling ScheduledChangesApi->patch_flag_config_scheduled_change_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **project_key** | **String** | The project key |  |
+| **feature_flag_key** | **String** | The feature flag&#39;s key |  |
+| **environment_key** | **String** | The environment key |  |
+| **id** | **String** | The scheduled change ID |  |
+| **flag_scheduled_changes_input** | [**FlagScheduledChangesInput**](FlagScheduledChangesInput.md) |  |  |
+| **ignore_conflicts** | **Boolean** | Whether or not to succeed or fail when the new instructions conflict with existing scheduled changes | [optional] |
+
+### Return type
+
+[**FeatureFlagScheduledChange**](FeatureFlagScheduledChange.md)
+
+### Authorization
+
+[ApiKey](../README.md#ApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## post_flag_config_scheduled_changes
+
+> <FeatureFlagScheduledChange> post_flag_config_scheduled_changes(project_key, feature_flag_key, environment_key, post_flag_scheduled_changes_input, opts)
+
+Create scheduled changes workflow
+
+Create scheduled changes for a feature flag. If the ignoreConficts query parameter is false and the new instructions would conflict with the current state of the feature flag or any existing scheduled changes, the request will fail. If the parameter is true and there are conflicts, the request will succeed as normal.
+
+### 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::ScheduledChangesApi.new
+project_key = 'project_key_example' # String | The project key
+feature_flag_key = 'feature_flag_key_example' # String | The feature flag's key
+environment_key = 'environment_key_example' # String | The environment key
+post_flag_scheduled_changes_input = LaunchDarklyApi::PostFlagScheduledChangesInput.new({execution_date: 3.56, instructions: [{ key: 3.56}]}) # PostFlagScheduledChangesInput | 
+opts = {
+  ignore_conflicts: true # Boolean | Whether or not to succeed or fail when the new instructions conflict with existing scheduled changes
+}
+
+begin
+  # Create scheduled changes workflow
+  result = api_instance.post_flag_config_scheduled_changes(project_key, feature_flag_key, environment_key, post_flag_scheduled_changes_input, opts)
+  p result
+rescue LaunchDarklyApi::ApiError => e
+  puts "Error when calling ScheduledChangesApi->post_flag_config_scheduled_changes: #{e}"
+end
+```
+
+#### Using the post_flag_config_scheduled_changes_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<FeatureFlagScheduledChange>, Integer, Hash)> post_flag_config_scheduled_changes_with_http_info(project_key, feature_flag_key, environment_key, post_flag_scheduled_changes_input, opts)
+
+```ruby
+begin
+  # Create scheduled changes workflow
+  data, status_code, headers = api_instance.post_flag_config_scheduled_changes_with_http_info(project_key, feature_flag_key, environment_key, post_flag_scheduled_changes_input, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <FeatureFlagScheduledChange>
+rescue LaunchDarklyApi::ApiError => e
+  puts "Error when calling ScheduledChangesApi->post_flag_config_scheduled_changes_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **project_key** | **String** | The project key |  |
+| **feature_flag_key** | **String** | The feature flag&#39;s key |  |
+| **environment_key** | **String** | The environment key |  |
+| **post_flag_scheduled_changes_input** | [**PostFlagScheduledChangesInput**](PostFlagScheduledChangesInput.md) |  |  |
+| **ignore_conflicts** | **Boolean** | Whether or not to succeed or fail when the new instructions conflict with existing scheduled changes | [optional] |
+
+### Return type
+
+[**FeatureFlagScheduledChange**](FeatureFlagScheduledChange.md)
+
+### Authorization
+
+[ApiKey](../README.md#ApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+