launchdarkly_api 6.0.0 → 6.0.1

data/docs/CodeReferencesApi.md

@@ -11,7 +11,7 @@ All URIs are relative to *https://app.launchdarkly.com*
 | [**get_extinctions**](CodeReferencesApi.md#get_extinctions) | **GET** /api/v2/code-refs/extinctions | List extinctions |
 | [**get_repositories**](CodeReferencesApi.md#get_repositories) | **GET** /api/v2/code-refs/repositories | List repositories |
 | [**get_repository**](CodeReferencesApi.md#get_repository) | **GET** /api/v2/code-refs/repositories/{repo} | Get repository |
-| [**get_root_statistic**](CodeReferencesApi.md#get_root_statistic) | **GET** /api/v2/code-refs/statistics | Get number of code references for flags |
+| [**get_root_statistic**](CodeReferencesApi.md#get_root_statistic) | **GET** /api/v2/code-refs/statistics | Get links to code reference repositories for each project |
 | [**get_statistics**](CodeReferencesApi.md#get_statistics) | **GET** /api/v2/code-refs/statistics/{projKey} | Get number of code references for flags |
 | [**patch_repository**](CodeReferencesApi.md#patch_repository) | **PATCH** /api/v2/code-refs/repositories/{repo} | Update repository |
 | [**post_extinction**](CodeReferencesApi.md#post_extinction) | **POST** /api/v2/code-refs/repositories/{repo}/branches/{branch} | Create extinction |
@@ -544,7 +544,7 @@ end
 
 > <StatisticsRoot> get_root_statistic
 
-Get number of code references for flags
+Get links to code reference repositories for each project
 
 Get links for all projects that have Code References.
 
@@ -564,7 +564,7 @@ end
 api_instance = LaunchDarklyApi::CodeReferencesApi.new
 
 begin
-  # Get number of code references for flags
+  # Get links to code reference repositories for each project
   result = api_instance.get_root_statistic
   p result
 rescue LaunchDarklyApi::ApiError => e
@@ -580,7 +580,7 @@ This returns an Array which contains the response data, status code and headers.
 
 ```ruby
 begin
-  # Get number of code references for flags
+  # Get links to code reference repositories for each project
   data, status_code, headers = api_instance.get_root_statistic_with_http_info
   p status_code # => 2xx
   p headers # => { ... }

data/docs/CustomWorkflowMeta.md

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

data/docs/CustomWorkflowStageMeta.md

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

data/docs/FeatureFlagsApi.md

@@ -715,7 +715,7 @@ end
 
 Update feature flag
 
-Perform a partial update to a feature
+Perform a partial update to a feature flag.  ## Using JSON Patches on a feature flag  When using the update feature flag endpoint to add individual users to a specific variation, there are two different patch documents, depending on whether users are already being individually targeted for the variation.  If a flag variation already has users individually targeted, the path for the JSON Patch operation is:  ```json {   \"op\": \"add\",   \"path\": \"/environments/devint/targets/0/values/-\",   \"value\": \"TestClient10\" } ```  If a flag variation does not already have users individually targeted, the path for the JSON Patch operation is:  ```json [   {     \"op\": \"add\",     \"path\": \"/environments/devint/targets/-\",     \"value\": { \"variation\": 0, \"values\": [\"TestClient10\"] }   } ] ```  ## Using semantic patches on a feature flag  To use a [semantic patch](/#section/Updates/Updates-via-semantic-patches) on a feature flag resource, you must include a header in the request. If you call a semantic patch resource without this header, you receive a `400` response as your semantic patch will be interpreted as a JSON patch.  Use this header:  ``` Content-Type: application/json; domain-model=launchdarkly.semanticpatch ```  The body of a semantic patch request takes the following three properties:  1. comment `string`: (Optional) A description of the update. 1. environmentKey `string`: (Required) The key of the LaunchDarkly environment. 1. instructions `array`: (Required) The action or list of actions to be performed by the update. Each update action in the list must be an object/hash table with a `kind` property, although depending on the action, other properties may be necessary. Read below for more information on the specific supported semantic patch instructions.  If any instruction in the patch encounters an error, the error will be returned and the flag will not be changed. In general, instructions will silently do nothing if the flag is already in the state requested by the patch instruction. For example, `removeUserTargets` does nothing when the targets have already been removed). They will generally error if a parameter refers to something that does not exist, like a variation ID that doesn't correspond to a variation on the flag or a rule ID that doesn't belong to a rule on the flag. Other specific error conditions are noted in the instruction descriptions.  ### Instructions  #### `turnFlagOn`  Sets the flag's targeting state to on.  #### `turnFlagOff`  Sets the flag's targeting state to off.  #### `addUserTargets`  Adds the user keys in `values` to the individual user targets for the variation specified by `variationId`. Returns an error if this causes the same user key to be targeted in multiple variations.  ##### Parameters  - `values`: list of user keys - `variationId`: ID of a variation on the flag  #### `removeUserTargets`  Removes the user keys in `values` to the individual user targets for the variation specified by `variationId`. Does nothing if the user keys are not targeted.  ##### Parameters  - `values`: list of user keys - `variationId`: ID of a variation on the flag  #### `replaceUserTargets`  Completely replaces the existing set of user targeting. All variations must be provided. Example:  ```json {   \"kind\": \"replaceUserTargets\",   \"targets\": [     {       \"variationId\": \"variation-1\",       \"values\": [\"blah\", \"foo\", \"bar\"]     },     {       \"variationId\": \"variation-2\",       \"values\": [\"abc\", \"def\"]     }   ] } ```  ##### Parameters  - `targets`: a list of user targeting  #### `clearUserTargets`  Removes all individual user targets from the variation specified by `variationId`  ##### Parameters  - `variationId`: ID of a variation on the flag  #### `addPrerequisite`  Adds the flag indicated by `key` with variation `variationId` as a prerequisite to the flag.  ##### Parameters  - `key`: flag key of another flag - `variationId`: ID of a variation of the flag with key `key`  #### `removePrerequisite`  Removes the prerequisite indicated by `key`. Does nothing if this prerequisite does not exist.  ##### Parameters  - `key`: flag key of an existing prerequisite  #### `updatePrerequisite`  Changes the prerequisite with flag key `key` to the variation indicated by `variationId`. Returns an error if this prerequisite does not exist.  ##### Parameters  - `key`: flag key of an existing prerequisite - `variationId`: ID of a variation of the flag with key `key`  #### `replacePrerequisites`  Completely replaces the existing set of prerequisites for a given flag. Example:  ```json {   \"kind\": \"replacePrerequisites\",   \"prerequisites\": [     {       \"key\": \"flag-key\",       \"variationId\": \"variation-1\"     },     {       \"key\": \"another-flag\",       \"variationId\": \"variation-2\"     }   ] } ```  ##### Parameters  - `prerequisites`: a list of prerequisites  #### `addRule`  Adds a new rule to the flag with the given `clauses` which serves the variation indicated by `variationId` or the percent rollout indicated by `rolloutWeights` and `rolloutBucketBy`. If `beforeRuleId` is set, the rule will be added in the list of rules before the indicated rule. Otherwise, the rule will be added to the end of the list.  ##### Parameters  - `clauses`: Array of clauses (see `addClauses`) - `beforeRuleId`: Optional ID of a rule in the flag - `variationId`: ID of a variation of the flag - `rolloutWeights`: Map of variationId to weight in thousandths of a percent (0-100000) - `rolloutBucketBy`: Optional user attribute  #### `removeRule`  Removes the targeting rule specified by `ruleId`. Does nothing if the rule does not exist.  ##### Parameters  - `ruleId`: ID of a rule in the flag  #### `replaceRules`  Completely replaces the existing rules for a given flag. Example:  ```json {   \"kind\": \"replaceRules\",   \"rules\": [     {       \"variationId\": \"variation-1\",       \"description\": \"myRule\",       \"clauses\": [         {           \"attribute\": \"segmentMatch\",           \"op\": \"segmentMatch\",           \"values\": [\"test\"]         }       ],       \"trackEvents\": true     }   ] } ```  ##### Parameters  - `rules`: a list of rules  #### `addClauses`  Adds the given clauses to the rule indicated by `ruleId`.  ##### Parameters  - `ruleId`: ID of a rule in the flag - `clauses`: Array of clause objects, with `attribute` (string), `op` (string), and `values` (array of strings, numbers, or dates) properties.  #### `removeClauses`  Removes the clauses specified by `clauseIds` from the rule indicated by `ruleId`.  #### Parameters  - `ruleId`: ID of a rule in the flag - `clauseIds`: Array of IDs of clauses in the rule  #### `updateClause`  Replaces the clause indicated by `ruleId` and `clauseId` with `clause`.  ##### Parameters  - `ruleId`: ID of a rule in the flag - `clauseId`: ID of a clause in that rule - `clause`: Clause object  #### `addValuesToClause`  Adds `values` to the values of the clause indicated by `ruleId` and `clauseId`.  ##### Parameters  - `ruleId`: ID of a rule in the flag - `clauseId`: ID of a clause in that rule - `values`: Array of strings  #### `removeValuesFromClause`  Removes `values` from the values of the clause indicated by `ruleId` and `clauseId`.  ##### Parameters  `ruleId`: ID of a rule in the flag `clauseId`: ID of a clause in that rule `values`: Array of strings  #### `reorderRules`  Rearranges the rules to match the order given in `ruleIds`. Will return an error if `ruleIds` does not match the current set of rules on the flag.  ##### Parameters  - `ruleIds`: Array of IDs of all rules in the flag  #### `updateRuleVariationOrRollout`  Updates what the rule indicated by `ruleId` serves if its clauses evaluate to true. Can either be a fixed variation indicated by `variationId` or a percent rollout indicated by `rolloutWeights` and `rolloutBucketBy`.  ##### Parameters  - `ruleId`: ID of a rule in the flag - `variationId`: ID of a variation of the flag   or - `rolloutWeights`: Map of variationId to weight in thousandths of a percent (0-100000) - `rolloutBucketBy`: Optional user attribute  #### `updateFallthroughVariationOrRollout`  Updates the flag's fallthrough, which is served if none of the targeting rules match. Can either be a fixed variation indicated by `variationId` or a percent rollout indicated by `rolloutWeights` and `rolloutBucketBy`.  ##### Parameters  `variationId`: ID of a variation of the flag or `rolloutWeights`: Map of variationId to weight in thousandths of a percent (0-100000) `rolloutBucketBy`: Optional user attribute  #### `updateOffVariation`  Updates the variation served when the flag's targeting is off to the variation indicated by `variationId`.  ##### Parameters  `variationId`: ID of a variation of the flag  ### Example  ```json {   \"environmentKey\": \"production\",   \"instructions\": [     {       \"kind\": \"turnFlagOn\"     },     {       \"kind\": \"turnFlagOff\"     },     {       \"kind\": \"addUserTargets\",       \"variationId\": \"8bfb304e-d516-47e5-8727-e7f798e8992d\",       \"values\": [\"userId\", \"userId2\"]     },     {       \"kind\": \"removeUserTargets\",       \"variationId\": \"8bfb304e-d516-47e5-8727-e7f798e8992d\",       \"values\": [\"userId3\", \"userId4\"]     },     {       \"kind\": \"updateFallthroughVariationOrRollout\",       \"rolloutWeights\": {         \"variationId\": 50000,         \"variationId2\": 50000       },       \"rolloutBucketBy\": null     },     {       \"kind\": \"addRule\",       \"clauses\": [         {           \"attribute\": \"segmentMatch\",           \"negate\": false,           \"values\": [\"test-segment\"]         }       ],       \"variationId\": null,       \"rolloutWeights\": {         \"variationId\": 50000,         \"variationId2\": 50000       },       \"rolloutBucketBy\": \"key\"     },     {       \"kind\": \"removeRule\",       \"ruleId\": \"99f12464-a429-40fc-86cc-b27612188955\"     },     {       \"kind\": \"reorderRules\",       \"ruleIds\": [\"2f72974e-de68-4243-8dd3-739582147a1f\", \"8bfb304e-d516-47e5-8727-e7f798e8992d\"]     },     {       \"kind\": \"addClauses\",       \"ruleId\": \"1134\",       \"clauses\": [         {           \"attribute\": \"email\",           \"op\": \"in\",           \"negate\": false,           \"values\": [\"test@test.com\"]         }       ]     },     {       \"kind\": \"removeClauses\",       \"ruleId\": \"1242529\",       \"clauseIds\": [\"8bfb304e-d516-47e5-8727-e7f798e8992d\"]     },     {       \"kind\": \"updateClause\",       \"ruleId\": \"2f72974e-de68-4243-8dd3-739582147a1f\",       \"clauseId\": \"309845\",       \"clause\": {         \"attribute\": \"segmentMatch\",         \"negate\": false,         \"values\": [\"test-segment\"]       }     },     {       \"kind\": \"updateRuleVariationOrRollout\",       \"ruleId\": \"2342\",       \"rolloutWeights\": null,       \"rolloutBucketBy\": null     },     {       \"kind\": \"updateOffVariation\",       \"variationId\": \"3242453\"     },     {       \"kind\": \"addPrerequisite\",       \"variationId\": \"234235\",       \"key\": \"flagKey2\"     },     {       \"kind\": \"updatePrerequisite\",       \"variationId\": \"234235\",       \"key\": \"flagKey2\"     },     {       \"kind\": \"removePrerequisite\",       \"key\": \"flagKey\"     }   ] } ```  ## Using JSON patches on a feature flag  If you do not include the header described above, you can use [JSON patch](/#section/Updates/Updates-via-JSON-Patch). 
 
 ### Examples
 

data/docs/FlagConfigApprovalRequestResponse.md

@@ -23,6 +23,7 @@
 | **operating_on_id** | **String** | ID of scheduled change to edit or delete | [optional] |
 | **integration_metadata** | [**IntegrationMetadata**](IntegrationMetadata.md) |  | [optional] |
 | **source** | [**CopiedFromEnv**](CopiedFromEnv.md) |  | [optional] |
+| **custom_workflow_meta_data** | [**CustomWorkflowMeta**](CustomWorkflowMeta.md) |  | [optional] |
 
 ## Example
 
@@ -48,7 +49,8 @@ instance = LaunchDarklyApi::FlagConfigApprovalRequestResponse.new(
   execution_date: null,
   operating_on_id: null,
   integration_metadata: null,
-  source: null
+  source: null,
+  custom_workflow_meta_data: null
 )
 ```
 

data/docs/PermissionGrantInput.md

@@ -0,0 +1,22 @@
+# LaunchDarklyApi::PermissionGrantInput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **member_ids** | **Array<String>** |  | [optional] |
+| **actions** | **Array<String>** |  | [optional] |
+| **action_set** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'launchdarkly_api'
+
+instance = LaunchDarklyApi::PermissionGrantInput.new(
+  member_ids: null,
+  actions: null,
+  action_set: null
+)
+```
+

data/docs/PermissionGrantRep.md

@@ -0,0 +1,24 @@
+# LaunchDarklyApi::PermissionGrantRep
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **action_set** | **String** |  | [optional] |
+| **actions** | **Array<String>** |  | [optional] |
+| **member_ids** | **Array<String>** |  | [optional] |
+| **resource** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'launchdarkly_api'
+
+instance = LaunchDarklyApi::PermissionGrantRep.new(
+  action_set: null,
+  actions: null,
+  member_ids: null,
+  resource: null
+)
+```
+

data/docs/SegmentsApi.md

@@ -245,7 +245,7 @@ end
 
 Get Big Segment membership for user
 
-Returns the membership status (included/excluded) for a given user in this segment. Note this operation
+Returns the membership status (included/excluded) for a given user in this segment. This operation does not support basic Segments.
 
 ### Examples
 

data/docs/TeamCollectionRep.md

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

data/docs/TeamPatchInput.md

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

data/docs/TeamPostInput.md

@@ -0,0 +1,28 @@
+# LaunchDarklyApi::TeamPostInput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **custom_role_keys** | **Array<String>** |  | [optional] |
+| **description** | **String** |  | [optional] |
+| **key** | **String** |  | [optional] |
+| **member_ids** | **Array<String>** |  | [optional] |
+| **name** | **String** |  | [optional] |
+| **permission_grants** | [**Array<PermissionGrantInput>**](PermissionGrantInput.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'launchdarkly_api'
+
+instance = LaunchDarklyApi::TeamPostInput.new(
+  custom_role_keys: null,
+  description: null,
+  key: null,
+  member_ids: null,
+  name: null,
+  permission_grants: null
+)
+```
+

data/docs/TeamRep.md

@@ -0,0 +1,40 @@
+# LaunchDarklyApi::TeamRep
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **custom_role_keys** | **Array<String>** |  | [optional] |
+| **description** | **String** |  | [optional] |
+| **key** | **String** |  | [optional] |
+| **member_ids** | **Array<String>** |  | [optional] |
+| **name** | **String** |  | [optional] |
+| **permission_grants** | [**Array<PermissionGrantRep>**](PermissionGrantRep.md) |  | [optional] |
+| **project_keys** | **Array<String>** |  | [optional] |
+| **_access** | [**AccessRep**](AccessRep.md) |  | [optional] |
+| **_created_at** | **Integer** |  | [optional] |
+| **_links** | [**Hash<String, Link>**](Link.md) |  | [optional] |
+| **_updated_at** | **Integer** |  | [optional] |
+| **_version** | **Integer** |  | [optional] |
+
+## Example
+
+```ruby
+require 'launchdarkly_api'
+
+instance = LaunchDarklyApi::TeamRep.new(
+  custom_role_keys: null,
+  description: null,
+  key: null,
+  member_ids: null,
+  name: null,
+  permission_grants: null,
+  project_keys: null,
+  _access: null,
+  _created_at: null,
+  _links: null,
+  _updated_at: null,
+  _version: null
+)
+```
+

data/docs/TeamsBetaApi.md

@@ -0,0 +1,365 @@
+# LaunchDarklyApi::TeamsBetaApi
+
+All URIs are relative to *https://app.launchdarkly.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**delete_team**](TeamsBetaApi.md#delete_team) | **DELETE** /api/v2/teams/{key} | Delete team by key |
+| [**get_team**](TeamsBetaApi.md#get_team) | **GET** /api/v2/teams/{key} | Get team by key |
+| [**get_teams**](TeamsBetaApi.md#get_teams) | **GET** /api/v2/teams | Get all teams |
+| [**patch_team**](TeamsBetaApi.md#patch_team) | **PATCH** /api/v2/teams/{key} | Patch team by key |
+| [**post_team**](TeamsBetaApi.md#post_team) | **POST** /api/v2/teams | Create team |
+
+
+## delete_team
+
+> delete_team(key)
+
+Delete team by key
+
+Delete a team by 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::TeamsBetaApi.new
+key = 'key_example' # String | The team key
+
+begin
+  # Delete team by key
+  api_instance.delete_team(key)
+rescue LaunchDarklyApi::ApiError => e
+  puts "Error when calling TeamsBetaApi->delete_team: #{e}"
+end
+```
+
+#### Using the delete_team_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_team_with_http_info(key)
+
+```ruby
+begin
+  # Delete team by key
+  data, status_code, headers = api_instance.delete_team_with_http_info(key)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue LaunchDarklyApi::ApiError => e
+  puts "Error when calling TeamsBetaApi->delete_team_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **key** | **String** | The team key |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[ApiKey](../README.md#ApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+
+
+## get_team
+
+> <TeamRep> get_team(key)
+
+Get team by key
+
+Fetch a team by 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::TeamsBetaApi.new
+key = 'key_example' # String | The team key
+
+begin
+  # Get team by key
+  result = api_instance.get_team(key)
+  p result
+rescue LaunchDarklyApi::ApiError => e
+  puts "Error when calling TeamsBetaApi->get_team: #{e}"
+end
+```
+
+#### Using the get_team_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<TeamRep>, Integer, Hash)> get_team_with_http_info(key)
+
+```ruby
+begin
+  # Get team by key
+  data, status_code, headers = api_instance.get_team_with_http_info(key)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <TeamRep>
+rescue LaunchDarklyApi::ApiError => e
+  puts "Error when calling TeamsBetaApi->get_team_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **key** | **String** | The team key |  |
+
+### Return type
+
+[**TeamRep**](TeamRep.md)
+
+### Authorization
+
+[ApiKey](../README.md#ApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_teams
+
+> <TeamCollectionRep> get_teams
+
+Get all teams
+
+Fetch all teams.
+
+### 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::TeamsBetaApi.new
+
+begin
+  # Get all teams
+  result = api_instance.get_teams
+  p result
+rescue LaunchDarklyApi::ApiError => e
+  puts "Error when calling TeamsBetaApi->get_teams: #{e}"
+end
+```
+
+#### Using the get_teams_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<TeamCollectionRep>, Integer, Hash)> get_teams_with_http_info
+
+```ruby
+begin
+  # Get all teams
+  data, status_code, headers = api_instance.get_teams_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <TeamCollectionRep>
+rescue LaunchDarklyApi::ApiError => e
+  puts "Error when calling TeamsBetaApi->get_teams_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**TeamCollectionRep**](TeamCollectionRep.md)
+
+### Authorization
+
+[ApiKey](../README.md#ApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## patch_team
+
+> <TeamCollectionRep> patch_team(key, team_patch_input)
+
+Patch team by key
+
+Perform a partial update to a team.  The body of a semantic patch request takes the following three properties:  1. comment `string`: (Optional) A description of the update. 1. environmentKey `string`: (Required) The key of the LaunchDarkly environment. 1. instructions `array`: (Required) The action or list of actions to be performed by the update. Each update action in the list must be an object/hash table with a `kind` property, although depending on the action, other properties may be necessary. Read below for more information on the specific supported semantic patch instructions.  If any instruction in the patch encounters an error, the error will be returned and the flag will not be changed. In general, instructions will silently do nothing if the flag is already in the state requested by the patch instruction. They will generally error if a parameter refers to something that does not exist. Other specific error conditions are noted in the instruction descriptions.  ### Instructions  #### `addCustomRoles`  Adds custom roles to the team. Team members will have these custom roles granted to them.  ##### Parameters  - `values`: list of custom role keys  #### `removeCustomRoles`  Removes the custom roles on the team. Team members will no longer have these custom roles granted to them.  ##### Parameters  - `values`: list of custom role keys  #### `addMembers`  Adds members to the team.  ##### Parameters  - `values`: list of member IDs  #### `removeMembers`  Removes members from the team.  ##### Parameters  - `values`: list of member IDs  #### `addPermissionGrants`  Adds permission grants to members for the team, allowing them to, for example, act as a team maintainer. A permission grant may have either an `actionSet` or a list of `actions` but not both at the same time. The members do not have to be team members to have a permission grant for the team.  ##### Parameters  - `actionSet`: name of the action set - `actions`: list of actions - `memberIDs`: list of member IDs  #### `removePermissionGrants`  Removes permission grants from members for the team. The `actionSet` and `actions` must match an existing permission grant.  ##### Parameters  - `actionSet`: name of the action set - `actions`: list of actions - `memberIDs`: list of member IDs  #### `updateDescription`  Updates the team's description.  ##### Parameters  - `value`: the team's new description  #### `updateName`  Updates the team's name.  ##### Parameters  - `value`: the team's new name 
+
+### 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::TeamsBetaApi.new
+key = 'key_example' # String | The team key
+team_patch_input = LaunchDarklyApi::TeamPatchInput.new # TeamPatchInput | 
+
+begin
+  # Patch team by key
+  result = api_instance.patch_team(key, team_patch_input)
+  p result
+rescue LaunchDarklyApi::ApiError => e
+  puts "Error when calling TeamsBetaApi->patch_team: #{e}"
+end
+```
+
+#### Using the patch_team_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<TeamCollectionRep>, Integer, Hash)> patch_team_with_http_info(key, team_patch_input)
+
+```ruby
+begin
+  # Patch team by key
+  data, status_code, headers = api_instance.patch_team_with_http_info(key, team_patch_input)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <TeamCollectionRep>
+rescue LaunchDarklyApi::ApiError => e
+  puts "Error when calling TeamsBetaApi->patch_team_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **key** | **String** | The team key |  |
+| **team_patch_input** | [**TeamPatchInput**](TeamPatchInput.md) |  |  |
+
+### Return type
+
+[**TeamCollectionRep**](TeamCollectionRep.md)
+
+### Authorization
+
+[ApiKey](../README.md#ApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## post_team
+
+> <TeamRep> post_team(team_post_input)
+
+Create team
+
+Create a team.
+
+### 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::TeamsBetaApi.new
+team_post_input = LaunchDarklyApi::TeamPostInput.new # TeamPostInput | 
+
+begin
+  # Create team
+  result = api_instance.post_team(team_post_input)
+  p result
+rescue LaunchDarklyApi::ApiError => e
+  puts "Error when calling TeamsBetaApi->post_team: #{e}"
+end
+```
+
+#### Using the post_team_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<TeamRep>, Integer, Hash)> post_team_with_http_info(team_post_input)
+
+```ruby
+begin
+  # Create team
+  data, status_code, headers = api_instance.post_team_with_http_info(team_post_input)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <TeamRep>
+rescue LaunchDarklyApi::ApiError => e
+  puts "Error when calling TeamsBetaApi->post_team_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **team_post_input** | [**TeamPostInput**](TeamPostInput.md) |  |  |
+
+### Return type
+
+[**TeamRep**](TeamRep.md)
+
+### Authorization
+
+[ApiKey](../README.md#ApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+