launchdarkly_api 7.1.1 → 8.0.0

data/docs/FeatureFlagsBetaApi.md

@@ -4,13 +4,13 @@ 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**](FeatureFlagsBetaApi.md#get_dependent_flags) | **GET** /api/v2/flags/{projectKey}/{featureFlagKey}/dependent-flags | List dependent feature flags |
+| [**get_dependent_flags_by_env**](FeatureFlagsBetaApi.md#get_dependent_flags_by_env) | **GET** /api/v2/flags/{projectKey}/{environmentKey}/{featureFlagKey}/dependent-flags | List dependent feature flags by environment |
 
 
 ## get_dependent_flags
 
-> <MultiEnvironmentDependentFlags> get_dependent_flags(proj_key, flag_key)
+> <MultiEnvironmentDependentFlags> get_dependent_flags(project_key, feature_flag_key)
 
 List dependent feature flags
 
@@ -30,12 +30,12 @@ LaunchDarklyApi.configure do |config|
 end
 
 api_instance = LaunchDarklyApi::FeatureFlagsBetaApi.new
-proj_key = 'proj_key_example' # String | The project key
-flag_key = 'flag_key_example' # String | The flag key
+project_key = 'project_key_example' # String | The project key
+feature_flag_key = 'feature_flag_key_example' # String | The feature flag key
 
 begin
   # List dependent feature flags
-  result = api_instance.get_dependent_flags(proj_key, flag_key)
+  result = api_instance.get_dependent_flags(project_key, feature_flag_key)
   p result
 rescue LaunchDarklyApi::ApiError => e
   puts "Error when calling FeatureFlagsBetaApi->get_dependent_flags: #{e}"
@@ -46,12 +46,12 @@ end
 
 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)
+> <Array(<MultiEnvironmentDependentFlags>, Integer, Hash)> get_dependent_flags_with_http_info(project_key, feature_flag_key)
 
 ```ruby
 begin
   # List dependent feature flags
-  data, status_code, headers = api_instance.get_dependent_flags_with_http_info(proj_key, flag_key)
+  data, status_code, headers = api_instance.get_dependent_flags_with_http_info(project_key, feature_flag_key)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <MultiEnvironmentDependentFlags>
@@ -64,8 +64,8 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **proj_key** | **String** | The project key |  |
-| **flag_key** | **String** | The flag key |  |
+| **project_key** | **String** | The project key |  |
+| **feature_flag_key** | **String** | The feature flag key |  |
 
 ### Return type
 
@@ -83,7 +83,7 @@ end
 
 ## get_dependent_flags_by_env
 
-> <DependentFlagsByEnvironment> get_dependent_flags_by_env(proj_key, env_key, flag_key)
+> <DependentFlagsByEnvironment> get_dependent_flags_by_env(project_key, environment_key, feature_flag_key)
 
 List dependent feature flags by environment
 
@@ -103,13 +103,13 @@ LaunchDarklyApi.configure do |config|
 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
+project_key = 'project_key_example' # String | The project key
+environment_key = 'environment_key_example' # String | The environment key
+feature_flag_key = 'feature_flag_key_example' # String | The feature flag key
 
 begin
   # List dependent feature flags by environment
-  result = api_instance.get_dependent_flags_by_env(proj_key, env_key, flag_key)
+  result = api_instance.get_dependent_flags_by_env(project_key, environment_key, feature_flag_key)
   p result
 rescue LaunchDarklyApi::ApiError => e
   puts "Error when calling FeatureFlagsBetaApi->get_dependent_flags_by_env: #{e}"
@@ -120,12 +120,12 @@ end
 
 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)
+> <Array(<DependentFlagsByEnvironment>, Integer, Hash)> get_dependent_flags_by_env_with_http_info(project_key, environment_key, feature_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)
+  data, status_code, headers = api_instance.get_dependent_flags_by_env_with_http_info(project_key, environment_key, feature_flag_key)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <DependentFlagsByEnvironment>
@@ -138,9 +138,9 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **proj_key** | **String** | The project key |  |
-| **env_key** | **String** | The environment key |  |
-| **flag_key** | **String** | The flag key |  |
+| **project_key** | **String** | The project key |  |
+| **environment_key** | **String** | The environment key |  |
+| **feature_flag_key** | **String** | The feature flag key |  |
 
 ### Return type
 

data/docs/FileRep.md

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

data/docs/FlagGlobalAttributesRep.md

@@ -18,7 +18,7 @@
 | **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] |
+| **_maintainer** | [**MemberSummary**](MemberSummary.md) |  | [optional] |
 | **goal_ids** | **Array<String>** |  | [optional] |
 | **experiments** | [**ExperimentInfoRep**](ExperimentInfoRep.md) |  |  |
 | **custom_properties** | [**Hash<String, CustomProperty>**](CustomProperty.md) |  |  |

data/docs/FlagLinkCollectionRep.md

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

data/docs/FlagLinkMember.md

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

data/docs/FlagLinkPost.md

@@ -0,0 +1,30 @@
+# LaunchDarklyApi::FlagLinkPost
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **key** | **String** |  | [optional] |
+| **integration_key** | **String** |  | [optional] |
+| **timestamp** | **Integer** |  | [optional] |
+| **deep_link** | **String** |  | [optional] |
+| **title** | **String** |  | [optional] |
+| **description** | **String** |  | [optional] |
+| **metadata** | **Hash<String, String>** |  | [optional] |
+
+## Example
+
+```ruby
+require 'launchdarkly_api'
+
+instance = LaunchDarklyApi::FlagLinkPost.new(
+  key: null,
+  integration_key: null,
+  timestamp: null,
+  deep_link: null,
+  title: null,
+  description: null,
+  metadata: null
+)
+```
+

data/docs/FlagLinkRep.md

@@ -0,0 +1,38 @@
+# LaunchDarklyApi::FlagLinkRep
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **_links** | [**Hash<String, Link>**](Link.md) |  |  |
+| **_key** | **String** |  | [optional] |
+| **_integration_key** | **String** |  | [optional] |
+| **_id** | **String** |  |  |
+| **_deep_link** | **String** |  |  |
+| **_timestamp** | [**TimestampRep**](TimestampRep.md) |  |  |
+| **title** | **String** |  | [optional] |
+| **description** | **String** |  | [optional] |
+| **_metadata** | **Hash<String, String>** |  | [optional] |
+| **_created_at** | **Integer** |  |  |
+| **_member** | [**FlagLinkMember**](FlagLinkMember.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'launchdarkly_api'
+
+instance = LaunchDarklyApi::FlagLinkRep.new(
+  _links: null,
+  _key: null,
+  _integration_key: null,
+  _id: null,
+  _deep_link: null,
+  _timestamp: null,
+  title: null,
+  description: null,
+  _metadata: null,
+  _created_at: null,
+  _member: null
+)
+```
+

data/docs/FlagLinksBetaApi.md

@@ -0,0 +1,310 @@
+# LaunchDarklyApi::FlagLinksBetaApi
+
+All URIs are relative to *https://app.launchdarkly.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**create_flag_link**](FlagLinksBetaApi.md#create_flag_link) | **POST** /api/v2/flag-links/projects/{projectKey}/flags/{featureFlagKey} | Create flag link |
+| [**delete_flag_link**](FlagLinksBetaApi.md#delete_flag_link) | **DELETE** /api/v2/flag-links/projects/{projectKey}/flags/{featureFlagKey}/{id} | Delete flag link |
+| [**get_flag_links**](FlagLinksBetaApi.md#get_flag_links) | **GET** /api/v2/flag-links/projects/{projectKey}/flags/{featureFlagKey} | List flag links |
+| [**update_flag_link**](FlagLinksBetaApi.md#update_flag_link) | **PATCH** /api/v2/flag-links/projects/{projectKey}/flags/{featureFlagKey}/{id} | Update flag link |
+
+
+## create_flag_link
+
+> <FlagLinkRep> create_flag_link(project_key, feature_flag_key, flag_link_post)
+
+Create flag link
+
+Create a new flag link. Flag links let you reference external resources and associate them with your flags.
+
+### 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::FlagLinksBetaApi.new
+project_key = 'project_key_example' # String | The project key
+feature_flag_key = 'feature_flag_key_example' # String | The feature flag key
+flag_link_post = LaunchDarklyApi::FlagLinkPost.new # FlagLinkPost | 
+
+begin
+  # Create flag link
+  result = api_instance.create_flag_link(project_key, feature_flag_key, flag_link_post)
+  p result
+rescue LaunchDarklyApi::ApiError => e
+  puts "Error when calling FlagLinksBetaApi->create_flag_link: #{e}"
+end
+```
+
+#### Using the create_flag_link_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<FlagLinkRep>, Integer, Hash)> create_flag_link_with_http_info(project_key, feature_flag_key, flag_link_post)
+
+```ruby
+begin
+  # Create flag link
+  data, status_code, headers = api_instance.create_flag_link_with_http_info(project_key, feature_flag_key, flag_link_post)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <FlagLinkRep>
+rescue LaunchDarklyApi::ApiError => e
+  puts "Error when calling FlagLinksBetaApi->create_flag_link_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **project_key** | **String** | The project key |  |
+| **feature_flag_key** | **String** | The feature flag key |  |
+| **flag_link_post** | [**FlagLinkPost**](FlagLinkPost.md) |  |  |
+
+### Return type
+
+[**FlagLinkRep**](FlagLinkRep.md)
+
+### Authorization
+
+[ApiKey](../README.md#ApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## delete_flag_link
+
+> delete_flag_link(project_key, feature_flag_key, id)
+
+Delete flag link
+
+Delete a flag link by ID or Key.
+
+### 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::FlagLinksBetaApi.new
+project_key = 'project_key_example' # String | The project key
+feature_flag_key = 'feature_flag_key_example' # String | The feature flag key
+id = 'id_example' # String | The flag link ID or Key
+
+begin
+  # Delete flag link
+  api_instance.delete_flag_link(project_key, feature_flag_key, id)
+rescue LaunchDarklyApi::ApiError => e
+  puts "Error when calling FlagLinksBetaApi->delete_flag_link: #{e}"
+end
+```
+
+#### Using the delete_flag_link_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_link_with_http_info(project_key, feature_flag_key, id)
+
+```ruby
+begin
+  # Delete flag link
+  data, status_code, headers = api_instance.delete_flag_link_with_http_info(project_key, feature_flag_key, id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue LaunchDarklyApi::ApiError => e
+  puts "Error when calling FlagLinksBetaApi->delete_flag_link_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **project_key** | **String** | The project key |  |
+| **feature_flag_key** | **String** | The feature flag key |  |
+| **id** | **String** | The flag link ID or Key |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[ApiKey](../README.md#ApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_flag_links
+
+> <FlagLinkCollectionRep> get_flag_links(project_key, feature_flag_key)
+
+List flag links
+
+Get a list of all flag links.
+
+### 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::FlagLinksBetaApi.new
+project_key = 'project_key_example' # String | The project key
+feature_flag_key = 'feature_flag_key_example' # String | The feature flag key
+
+begin
+  # List flag links
+  result = api_instance.get_flag_links(project_key, feature_flag_key)
+  p result
+rescue LaunchDarklyApi::ApiError => e
+  puts "Error when calling FlagLinksBetaApi->get_flag_links: #{e}"
+end
+```
+
+#### Using the get_flag_links_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<FlagLinkCollectionRep>, Integer, Hash)> get_flag_links_with_http_info(project_key, feature_flag_key)
+
+```ruby
+begin
+  # List flag links
+  data, status_code, headers = api_instance.get_flag_links_with_http_info(project_key, feature_flag_key)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <FlagLinkCollectionRep>
+rescue LaunchDarklyApi::ApiError => e
+  puts "Error when calling FlagLinksBetaApi->get_flag_links_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **project_key** | **String** | The project key |  |
+| **feature_flag_key** | **String** | The feature flag key |  |
+
+### Return type
+
+[**FlagLinkCollectionRep**](FlagLinkCollectionRep.md)
+
+### Authorization
+
+[ApiKey](../README.md#ApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## update_flag_link
+
+> <FlagLinkRep> update_flag_link(project_key, feature_flag_key, id, patch_operation)
+
+Update flag link
+
+Update a flag link. The request body must be a valid JSON patch document. To learn more, read [Updates](/#section/Overview/Updates).
+
+### 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::FlagLinksBetaApi.new
+project_key = 'project_key_example' # String | The project key
+feature_flag_key = 'feature_flag_key_example' # String | The feature flag key
+id = 'id_example' # String | The flag link ID
+patch_operation = [LaunchDarklyApi::PatchOperation.new({op: 'replace', path: '/exampleField', value: new example value})] # Array<PatchOperation> | 
+
+begin
+  # Update flag link
+  result = api_instance.update_flag_link(project_key, feature_flag_key, id, patch_operation)
+  p result
+rescue LaunchDarklyApi::ApiError => e
+  puts "Error when calling FlagLinksBetaApi->update_flag_link: #{e}"
+end
+```
+
+#### Using the update_flag_link_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<FlagLinkRep>, Integer, Hash)> update_flag_link_with_http_info(project_key, feature_flag_key, id, patch_operation)
+
+```ruby
+begin
+  # Update flag link
+  data, status_code, headers = api_instance.update_flag_link_with_http_info(project_key, feature_flag_key, id, patch_operation)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <FlagLinkRep>
+rescue LaunchDarklyApi::ApiError => e
+  puts "Error when calling FlagLinksBetaApi->update_flag_link_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **project_key** | **String** | The project key |  |
+| **feature_flag_key** | **String** | The feature flag key |  |
+| **id** | **String** | The flag link ID |  |
+| **patch_operation** | [**Array&lt;PatchOperation&gt;**](PatchOperation.md) |  |  |
+
+### Return type
+
+[**FlagLinkRep**](FlagLinkRep.md)
+
+### Authorization
+
+[ApiKey](../README.md#ApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+