launchdarkly_api 7.0.0 → 8.0.0

data/docs/SegmentsBetaApi.md

@@ -0,0 +1,313 @@
+# LaunchDarklyApi::SegmentsBetaApi
+
+All URIs are relative to *https://app.launchdarkly.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**create_big_segment_export**](SegmentsBetaApi.md#create_big_segment_export) | **POST** /api/v2/segments/{projectKey}/{environmentKey}/{segmentKey}/exports | Create Big Segment export |
+| [**create_big_segment_import**](SegmentsBetaApi.md#create_big_segment_import) | **POST** /api/v2/segments/{projectKey}/{environmentKey}/{segmentKey}/imports | Create Big Segment import |
+| [**get_big_segment_export**](SegmentsBetaApi.md#get_big_segment_export) | **GET** /api/v2/segments/{projectKey}/{environmentKey}/{segmentKey}/exports/{exportID} | Get Big Segment export |
+| [**get_big_segment_import**](SegmentsBetaApi.md#get_big_segment_import) | **GET** /api/v2/segments/{projectKey}/{environmentKey}/{segmentKey}/imports/{importID} | Get Big Segment import |
+
+
+## create_big_segment_export
+
+> create_big_segment_export(project_key, environment_key, segment_key)
+
+Create Big Segment export
+
+Starts a new export process for a Big Segment
+
+### 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::SegmentsBetaApi.new
+project_key = 'project_key_example' # String | The project key
+environment_key = 'environment_key_example' # String | The environment key
+segment_key = 'segment_key_example' # String | The segment key
+
+begin
+  # Create Big Segment export
+  api_instance.create_big_segment_export(project_key, environment_key, segment_key)
+rescue LaunchDarklyApi::ApiError => e
+  puts "Error when calling SegmentsBetaApi->create_big_segment_export: #{e}"
+end
+```
+
+#### Using the create_big_segment_export_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)> create_big_segment_export_with_http_info(project_key, environment_key, segment_key)
+
+```ruby
+begin
+  # Create Big Segment export
+  data, status_code, headers = api_instance.create_big_segment_export_with_http_info(project_key, environment_key, segment_key)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue LaunchDarklyApi::ApiError => e
+  puts "Error when calling SegmentsBetaApi->create_big_segment_export_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **project_key** | **String** | The project key |  |
+| **environment_key** | **String** | The environment key |  |
+| **segment_key** | **String** | The segment key |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[ApiKey](../README.md#ApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## create_big_segment_import
+
+> create_big_segment_import(project_key, environment_key, segment_key)
+
+Create Big Segment import
+
+Starts a new import process for a Big Segment
+
+### 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::SegmentsBetaApi.new
+project_key = 'project_key_example' # String | The project key
+environment_key = 'environment_key_example' # String | The environment key
+segment_key = 'segment_key_example' # String | The segment key
+
+begin
+  # Create Big Segment import
+  api_instance.create_big_segment_import(project_key, environment_key, segment_key)
+rescue LaunchDarklyApi::ApiError => e
+  puts "Error when calling SegmentsBetaApi->create_big_segment_import: #{e}"
+end
+```
+
+#### Using the create_big_segment_import_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)> create_big_segment_import_with_http_info(project_key, environment_key, segment_key)
+
+```ruby
+begin
+  # Create Big Segment import
+  data, status_code, headers = api_instance.create_big_segment_import_with_http_info(project_key, environment_key, segment_key)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue LaunchDarklyApi::ApiError => e
+  puts "Error when calling SegmentsBetaApi->create_big_segment_import_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **project_key** | **String** | The project key |  |
+| **environment_key** | **String** | The environment key |  |
+| **segment_key** | **String** | The segment key |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[ApiKey](../README.md#ApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_big_segment_export
+
+> <Export> get_big_segment_export(project_key, environment_key, segment_key, export_id)
+
+Get Big Segment export
+
+Returns info about a Big Segment export process.
+
+### 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::SegmentsBetaApi.new
+project_key = 'project_key_example' # String | The project key
+environment_key = 'environment_key_example' # String | The environment key
+segment_key = 'segment_key_example' # String | The segment key
+export_id = 'export_id_example' # String | The export ID
+
+begin
+  # Get Big Segment export
+  result = api_instance.get_big_segment_export(project_key, environment_key, segment_key, export_id)
+  p result
+rescue LaunchDarklyApi::ApiError => e
+  puts "Error when calling SegmentsBetaApi->get_big_segment_export: #{e}"
+end
+```
+
+#### Using the get_big_segment_export_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Export>, Integer, Hash)> get_big_segment_export_with_http_info(project_key, environment_key, segment_key, export_id)
+
+```ruby
+begin
+  # Get Big Segment export
+  data, status_code, headers = api_instance.get_big_segment_export_with_http_info(project_key, environment_key, segment_key, export_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Export>
+rescue LaunchDarklyApi::ApiError => e
+  puts "Error when calling SegmentsBetaApi->get_big_segment_export_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **project_key** | **String** | The project key |  |
+| **environment_key** | **String** | The environment key |  |
+| **segment_key** | **String** | The segment key |  |
+| **export_id** | **String** | The export ID |  |
+
+### Return type
+
+[**Export**](Export.md)
+
+### Authorization
+
+[ApiKey](../README.md#ApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_big_segment_import
+
+> <Import> get_big_segment_import(project_key, environment_key, segment_key, import_id)
+
+Get Big Segment import
+
+Returns info about a Big Segment import process.
+
+### 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::SegmentsBetaApi.new
+project_key = 'project_key_example' # String | The project key
+environment_key = 'environment_key_example' # String | The environment key
+segment_key = 'segment_key_example' # String | The segment key
+import_id = 'import_id_example' # String | The import ID
+
+begin
+  # Get Big Segment import
+  result = api_instance.get_big_segment_import(project_key, environment_key, segment_key, import_id)
+  p result
+rescue LaunchDarklyApi::ApiError => e
+  puts "Error when calling SegmentsBetaApi->get_big_segment_import: #{e}"
+end
+```
+
+#### Using the get_big_segment_import_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Import>, Integer, Hash)> get_big_segment_import_with_http_info(project_key, environment_key, segment_key, import_id)
+
+```ruby
+begin
+  # Get Big Segment import
+  data, status_code, headers = api_instance.get_big_segment_import_with_http_info(project_key, environment_key, segment_key, import_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Import>
+rescue LaunchDarklyApi::ApiError => e
+  puts "Error when calling SegmentsBetaApi->get_big_segment_import_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **project_key** | **String** | The project key |  |
+| **environment_key** | **String** | The environment key |  |
+| **segment_key** | **String** | The segment key |  |
+| **import_id** | **String** | The import ID |  |
+
+### Return type
+
+[**Import**](Import.md)
+
+### Authorization
+
+[ApiKey](../README.md#ApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/SourceEnv.md

@@ -0,0 +1,20 @@
+# LaunchDarklyApi::SourceEnv
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **key** | **String** | The key of the source environment to clone from | [optional] |
+| **version** | **Integer** | (Optional) The version number of the source environment to clone from. Used for optimistic locking | [optional] |
+
+## Example
+
+```ruby
+require 'launchdarkly_api'
+
+instance = LaunchDarklyApi::SourceEnv.new(
+  key: null,
+  version: null
+)
+```
+

data/docs/Statement.md

@@ -5,9 +5,9 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **resources** | **Array<String>** | Resource specifier strings | [optional] |
-| **not_resources** | **Array<String>** | Targeted resources are the resources NOT in this list. The \"resources\" field must be empty to use this field. | [optional] |
+| **not_resources** | **Array<String>** | Targeted resources are the resources NOT in this list. The \"resources\" and \"notActions\" fields must be empty to use this field. | [optional] |
 | **actions** | **Array<String>** | Actions to perform on a resource | [optional] |
-| **not_actions** | **Array<String>** | Targeted actions are the actions NOT in this list. The \"actions\" field must be empty to use this field. | [optional] |
+| **not_actions** | **Array<String>** | Targeted actions are the actions NOT in this list. The \"actions\" and \"notResources\" fields must be empty to use this field. | [optional] |
 | **effect** | **String** |  |  |
 
 ## Example

data/docs/StatementPost.md

@@ -4,9 +4,9 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **resources** | **Array<String>** | Resource specifier strings |  |
+| **resources** | **Array<String>** | Resource specifier strings | [optional] |
 | **not_resources** | **Array<String>** | Targeted resources are the resources NOT in this list. The \"resources\" field must be empty to use this field. | [optional] |
-| **actions** | **Array<String>** | Actions to perform on a resource |  |
+| **actions** | **Array<String>** | Actions to perform on a resource | [optional] |
 | **not_actions** | **Array<String>** | Targeted actions are the actions NOT in this list. The \"actions\" field must be empty to use this field. | [optional] |
 | **effect** | **String** |  |  |
 

data/docs/StatementPostData.md

@@ -4,9 +4,9 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **resources** | **Array<String>** | Resource specifier strings |  |
+| **resources** | **Array<String>** | Resource specifier strings | [optional] |
 | **not_resources** | **Array<String>** | Targeted resources are the resources NOT in this list. The \"resources\" field must be empty to use this field. | [optional] |
-| **actions** | **Array<String>** | Actions to perform on a resource |  |
+| **actions** | **Array<String>** | Actions to perform on a resource | [optional] |
 | **not_actions** | **Array<String>** | Targeted actions are the actions NOT in this list. The \"actions\" field must be empty to use this field. | [optional] |
 | **effect** | **String** |  |  |
 

data/docs/SubscriptionPost.md

@@ -0,0 +1,30 @@
+# LaunchDarklyApi::SubscriptionPost
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | A human-friendly name for your audit log subscription. |  |
+| **statements** | [**Array<StatementPost>**](StatementPost.md) |  | [optional] |
+| **on** | **Boolean** | Whether or not you want your subscription to actively send events. | [optional] |
+| **tags** | **Array<String>** |  | [optional] |
+| **config** | **Hash<String, Object>** | The unique set of fields required to configure an audit log subscription integration of this type. Refer to the \"formVariables\" field in the corresponding manifest.json  at https://github.com/launchdarkly/integration-framework/tree/master/integrations for a full list of fields for the integration you wish to configure. |  |
+| **url** | **String** | Slack webhook receiver URL. Only necessary for legacy Slack webhook integrations. | [optional] |
+| **api_key** | **String** | Datadog API key. Only necessary for legacy Datadog webhook subscriptions. | [optional] |
+
+## Example
+
+```ruby
+require 'launchdarkly_api'
+
+instance = LaunchDarklyApi::SubscriptionPost.new(
+  name: null,
+  statements: null,
+  on: null,
+  tags: null,
+  config: null,
+  url: null,
+  api_key: null
+)
+```
+

data/docs/TagCollection.md

@@ -0,0 +1,22 @@
+# LaunchDarklyApi::TagCollection
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **items** | **Array<String>** | List of tags |  |
+| **_links** | [**Hash<String, Link>**](Link.md) |  |  |
+| **total_count** | **Integer** | The total number of tags | [optional] |
+
+## Example
+
+```ruby
+require 'launchdarkly_api'
+
+instance = LaunchDarklyApi::TagCollection.new(
+  items: ["ops","pro"],
+  _links: null,
+  total_count: 103
+)
+```
+

data/docs/TagsApi.md

@@ -0,0 +1,83 @@
+# LaunchDarklyApi::TagsApi
+
+All URIs are relative to *https://app.launchdarkly.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get_tags**](TagsApi.md#get_tags) | **GET** /api/v2/tags | List tags |
+
+
+## get_tags
+
+> <TagCollection> get_tags(opts)
+
+List tags
+
+Get a list of tags.
+
+### 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::TagsApi.new
+opts = {
+  kind: 'kind_example', # String | Fetch tags associated with the specified resource type. Options are `flag`, `project`, `environment`, `segment`. Returns all types by default.
+  pre: 'pre_example' # String | Return tags with the specified prefix
+}
+
+begin
+  # List tags
+  result = api_instance.get_tags(opts)
+  p result
+rescue LaunchDarklyApi::ApiError => e
+  puts "Error when calling TagsApi->get_tags: #{e}"
+end
+```
+
+#### Using the get_tags_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<TagCollection>, Integer, Hash)> get_tags_with_http_info(opts)
+
+```ruby
+begin
+  # List tags
+  data, status_code, headers = api_instance.get_tags_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <TagCollection>
+rescue LaunchDarklyApi::ApiError => e
+  puts "Error when calling TagsApi->get_tags_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **kind** | **String** | Fetch tags associated with the specified resource type. Options are &#x60;flag&#x60;, &#x60;project&#x60;, &#x60;environment&#x60;, &#x60;segment&#x60;. Returns all types by default. | [optional] |
+| **pre** | **String** | Return tags with the specified prefix | [optional] |
+
+### Return type
+
+[**TagCollection**](TagCollection.md)
+
+### Authorization
+
+[ApiKey](../README.md#ApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/Team.md

@@ -0,0 +1,32 @@
+# LaunchDarklyApi::Team
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **description** | **String** |  | [optional] |
+| **key** | **String** |  | [optional] |
+| **name** | **String** |  | [optional] |
+| **_access** | [**Access**](Access.md) |  | [optional] |
+| **_creation_date** | **Integer** |  | [optional] |
+| **_links** | [**Hash<String, Link>**](Link.md) |  | [optional] |
+| **_last_modified** | **Integer** |  | [optional] |
+| **_version** | **Integer** |  | [optional] |
+
+## Example
+
+```ruby
+require 'launchdarkly_api'
+
+instance = LaunchDarklyApi::Team.new(
+  description: null,
+  key: null,
+  name: null,
+  _access: null,
+  _creation_date: null,
+  _links: null,
+  _last_modified: null,
+  _version: null
+)
+```
+

data/docs/TeamCustomRole.md

@@ -0,0 +1,24 @@
+# LaunchDarklyApi::TeamCustomRole
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **key** | **String** |  | [optional] |
+| **name** | **String** |  | [optional] |
+| **projects** | [**TeamProjects**](TeamProjects.md) |  | [optional] |
+| **applied_on** | **Integer** |  | [optional] |
+
+## Example
+
+```ruby
+require 'launchdarkly_api'
+
+instance = LaunchDarklyApi::TeamCustomRole.new(
+  key: null,
+  name: null,
+  projects: null,
+  applied_on: null
+)
+```
+

data/docs/TeamCustomRoles.md

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

data/docs/TeamImportsRep.md

@@ -0,0 +1,18 @@
+# LaunchDarklyApi::TeamImportsRep
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **items** | [**Array<MemberImportItem>**](MemberImportItem.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'launchdarkly_api'
+
+instance = LaunchDarklyApi::TeamImportsRep.new(
+  items: null
+)
+```
+

data/docs/TeamMaintainers.md

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

data/docs/TeamProjects.md

@@ -0,0 +1,20 @@
+# LaunchDarklyApi::TeamProjects
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **total_count** | **Integer** |  | [optional] |
+| **items** | [**Array<ProjectSummary>**](ProjectSummary.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'launchdarkly_api'
+
+instance = LaunchDarklyApi::TeamProjects.new(
+  total_count: null,
+  items: null
+)
+```
+

data/docs/{TeamCollectionRep.md → Teams.md}

@@ -1,10 +1,10 @@
-# LaunchDarklyApi::TeamCollectionRep
+# LaunchDarklyApi::Teams
 
 ## Properties
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **items** | [**Array<TeamRep>**](TeamRep.md) |  | [optional] |
+| **items** | [**Array<Team>**](Team.md) |  | [optional] |
 | **_links** | [**Hash<String, Link>**](Link.md) |  | [optional] |
 | **total_count** | **Integer** |  | [optional] |
 
@@ -13,7 +13,7 @@
 ```ruby
 require 'launchdarkly_api'
 
-instance = LaunchDarklyApi::TeamCollectionRep.new(
+instance = LaunchDarklyApi::Teams.new(
   items: null,
   _links: null,
   total_count: null