launchdarkly_api 5.0.3 → 6.0.0

data/docs/FeatureFlagsBetaApi.md

@@ -0,0 +1,157 @@
+# LaunchDarklyApi::FeatureFlagsBetaApi
+
+All URIs are relative to *https://app.launchdarkly.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get_dependent_flags**](FeatureFlagsBetaApi.md#get_dependent_flags) | **GET** /api/v2/flags/{projKey}/{flagKey}/dependent-flags | List dependent feature flags |
+| [**get_dependent_flags_by_env**](FeatureFlagsBetaApi.md#get_dependent_flags_by_env) | **GET** /api/v2/flags/{projKey}/{envKey}/{flagKey}/dependent-flags | List dependent feature flags by environment |
+
+
+## get_dependent_flags
+
+> <MultiEnvironmentDependentFlags> get_dependent_flags(proj_key, flag_key)
+
+List dependent feature flags
+
+List dependent flags across all environments for the flag specified in the path parameters. A dependent flag is a flag that uses another flag as a prerequisite.
+
+### 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::FeatureFlagsBetaApi.new
+proj_key = 'proj_key_example' # String | The project key
+flag_key = 'flag_key_example' # String | The flag key
+
+begin
+  # List dependent feature flags
+  result = api_instance.get_dependent_flags(proj_key, flag_key)
+  p result
+rescue LaunchDarklyApi::ApiError => e
+  puts "Error when calling FeatureFlagsBetaApi->get_dependent_flags: #{e}"
+end
+```
+
+#### Using the get_dependent_flags_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<MultiEnvironmentDependentFlags>, Integer, Hash)> get_dependent_flags_with_http_info(proj_key, flag_key)
+
+```ruby
+begin
+  # List dependent feature flags
+  data, status_code, headers = api_instance.get_dependent_flags_with_http_info(proj_key, flag_key)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <MultiEnvironmentDependentFlags>
+rescue LaunchDarklyApi::ApiError => e
+  puts "Error when calling FeatureFlagsBetaApi->get_dependent_flags_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **proj_key** | **String** | The project key |  |
+| **flag_key** | **String** | The flag key |  |
+
+### Return type
+
+[**MultiEnvironmentDependentFlags**](MultiEnvironmentDependentFlags.md)
+
+### Authorization
+
+[ApiKey](../README.md#ApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_dependent_flags_by_env
+
+> <DependentFlagsByEnvironment> get_dependent_flags_by_env(proj_key, env_key, flag_key)
+
+List dependent feature flags by environment
+
+List dependent flags across all environments for the flag specified in the path parameters. A dependent flag is a flag that uses another flag as a prerequisite.
+
+### 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::FeatureFlagsBetaApi.new
+proj_key = 'proj_key_example' # String | The project key
+env_key = 'env_key_example' # String | The environment key
+flag_key = 'flag_key_example' # String | The flag key
+
+begin
+  # List dependent feature flags by environment
+  result = api_instance.get_dependent_flags_by_env(proj_key, env_key, flag_key)
+  p result
+rescue LaunchDarklyApi::ApiError => e
+  puts "Error when calling FeatureFlagsBetaApi->get_dependent_flags_by_env: #{e}"
+end
+```
+
+#### Using the get_dependent_flags_by_env_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<DependentFlagsByEnvironment>, Integer, Hash)> get_dependent_flags_by_env_with_http_info(proj_key, env_key, flag_key)
+
+```ruby
+begin
+  # List dependent feature flags by environment
+  data, status_code, headers = api_instance.get_dependent_flags_by_env_with_http_info(proj_key, env_key, flag_key)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <DependentFlagsByEnvironment>
+rescue LaunchDarklyApi::ApiError => e
+  puts "Error when calling FeatureFlagsBetaApi->get_dependent_flags_by_env_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **proj_key** | **String** | The project key |  |
+| **env_key** | **String** | The environment key |  |
+| **flag_key** | **String** | The flag key |  |
+
+### Return type
+
+[**DependentFlagsByEnvironment**](DependentFlagsByEnvironment.md)
+
+### Authorization
+
+[ApiKey](../README.md#ApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/FlagConfigApprovalRequestResponse.md

@@ -0,0 +1,54 @@
+# LaunchDarklyApi::FlagConfigApprovalRequestResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **_id** | **String** |  |  |
+| **_version** | **Integer** |  |  |
+| **creation_date** | **Integer** |  |  |
+| **service_kind** | **String** |  |  |
+| **requestor_id** | **String** |  | [optional] |
+| **description** | **String** | A human-friendly name for the approval request | [optional] |
+| **review_status** | **String** |  |  |
+| **all_reviews** | [**Array<ReviewResponse>**](ReviewResponse.md) |  |  |
+| **notify_member_ids** | **Array<String>** | An array of member IDs. These members are notified to review the approval request. |  |
+| **applied_date** | **Integer** |  | [optional] |
+| **applied_by_member_id** | **String** |  | [optional] |
+| **status** | **String** |  |  |
+| **instructions** | **Array<Hash>** |  |  |
+| **conflicts** | [**Array<Conflict>**](Conflict.md) |  |  |
+| **_links** | [**Hash<String, Link>**](Link.md) |  |  |
+| **execution_date** | **Integer** |  | [optional] |
+| **operating_on_id** | **String** | ID of scheduled change to edit or delete | [optional] |
+| **integration_metadata** | [**IntegrationMetadata**](IntegrationMetadata.md) |  | [optional] |
+| **source** | [**CopiedFromEnv**](CopiedFromEnv.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'launchdarkly_api'
+
+instance = LaunchDarklyApi::FlagConfigApprovalRequestResponse.new(
+  _id: null,
+  _version: null,
+  creation_date: null,
+  service_kind: null,
+  requestor_id: null,
+  description: null,
+  review_status: null,
+  all_reviews: null,
+  notify_member_ids: null,
+  applied_date: null,
+  applied_by_member_id: null,
+  status: null,
+  instructions: null,
+  conflicts: null,
+  _links: null,
+  execution_date: null,
+  operating_on_id: null,
+  integration_metadata: null,
+  source: null
+)
+```
+

data/docs/FlagConfigApprovalRequestsResponse.md

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

data/docs/FlagCopyConfigEnvironment.md

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

data/docs/FlagCopyConfigPost.md

@@ -0,0 +1,26 @@
+# LaunchDarklyApi::FlagCopyConfigPost
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **source** | [**FlagCopyConfigEnvironment**](FlagCopyConfigEnvironment.md) |  |  |
+| **target** | [**FlagCopyConfigEnvironment**](FlagCopyConfigEnvironment.md) |  |  |
+| **comment** | **String** |  | [optional] |
+| **included_actions** | **Array<String>** |  | [optional] |
+| **excluded_actions** | **Array<String>** |  | [optional] |
+
+## Example
+
+```ruby
+require 'launchdarkly_api'
+
+instance = LaunchDarklyApi::FlagCopyConfigPost.new(
+  source: null,
+  target: null,
+  comment: null,
+  included_actions: null,
+  excluded_actions: null
+)
+```
+

data/docs/FlagGlobalAttributesRep.md

@@ -0,0 +1,58 @@
+# LaunchDarklyApi::FlagGlobalAttributesRep
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | A human-friendly name for the feature flag |  |
+| **kind** | **String** | Kind of feature flag |  |
+| **description** | **String** | Description of the feature flag | [optional] |
+| **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] |
+| **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 |  |
+| **tags** | **Array<String>** | Tags for the feature flag |  |
+| **_links** | [**Hash<String, Link>**](Link.md) |  |  |
+| **maintainer_id** | **String** | Associated maintainerId for the feature flag | [optional] |
+| **_maintainer** | [**MemberSummaryRep**](MemberSummaryRep.md) |  | [optional] |
+| **goal_ids** | **Array<String>** |  | [optional] |
+| **experiments** | [**ExperimentInfoRep**](ExperimentInfoRep.md) |  |  |
+| **custom_properties** | [**Hash<String, CustomProperty>**](CustomProperty.md) |  |  |
+| **archived** | **Boolean** | Boolean indicating if the feature flag is archived |  |
+| **archived_date** | **Integer** |  | [optional] |
+| **defaults** | [**Defaults**](Defaults.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'launchdarkly_api'
+
+instance = LaunchDarklyApi::FlagGlobalAttributesRep.new(
+  name: My Flag,
+  kind: boolean,
+  description: null,
+  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: [],
+  _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,
+  goal_ids: [],
+  experiments: null,
+  custom_properties: null,
+  archived: false,
+  archived_date: null,
+  defaults: null
+)
+```
+

data/docs/FlagListingRep.md

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

data/docs/FlagScheduledChangesInput.md

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

data/docs/FlagStatusRep.md

@@ -0,0 +1,24 @@
+# LaunchDarklyApi::FlagStatusRep
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **_links** | [**Hash<String, Link>**](Link.md) |  |  |
+| **name** | **String** | Status of the flag | [optional] |
+| **last_requested** | **Time** | Timestamp of last time flag was requested | [optional] |
+| **default** | **Object** | Default value seen from code | [optional] |
+
+## Example
+
+```ruby
+require 'launchdarkly_api'
+
+instance = LaunchDarklyApi::FlagStatusRep.new(
+  _links: {"parent":{"href":"/api/v2/flags/my-project/my-flag","type":"application/json"},"self":{"href":"/api/v2/flag-statuses/my-project/my-flag","type":"application/json"}},
+  name: inactive,
+  last_requested: 2020-02-05T18:17:01.514Z,
+  default: null
+)
+```
+

data/docs/FlagSummary.md

@@ -0,0 +1,18 @@
+# LaunchDarklyApi::FlagSummary
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **prerequisites** | **Integer** |  |  |
+
+## Example
+
+```ruby
+require 'launchdarkly_api'
+
+instance = LaunchDarklyApi::FlagSummary.new(
+  prerequisites: null
+)
+```
+

data/docs/HunkRep.md

@@ -0,0 +1,26 @@
+# LaunchDarklyApi::HunkRep
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **starting_line_number** | **Integer** |  | [optional] |
+| **lines** | **String** |  | [optional] |
+| **proj_key** | **String** |  | [optional] |
+| **flag_key** | **String** |  | [optional] |
+| **aliases** | **Array<String>** |  | [optional] |
+
+## Example
+
+```ruby
+require 'launchdarkly_api'
+
+instance = LaunchDarklyApi::HunkRep.new(
+  starting_line_number: null,
+  lines: null,
+  proj_key: null,
+  flag_key: null,
+  aliases: null
+)
+```
+