launchdarkly_api 2.0.3

data/docs/ProjectsApi.md

@@ -0,0 +1,268 @@
+# LaunchDarklyApi::ProjectsApi
+
+All URIs are relative to *https://app.launchdarkly.com/api/v2*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**delete_project**](ProjectsApi.md#delete_project) | **DELETE** /projects/{projectKey} | Delete a project by key. Caution-- deleting a project will delete all associated environments and feature flags. You cannot delete the last project in an account.
+[**get_project**](ProjectsApi.md#get_project) | **GET** /projects/{projectKey} | Fetch a single project by key.
+[**get_projects**](ProjectsApi.md#get_projects) | **GET** /projects | Returns a list of all projects in the account.
+[**patch_project**](ProjectsApi.md#patch_project) | **PATCH** /projects/{projectKey} | Modify a project by ID.
+[**post_project**](ProjectsApi.md#post_project) | **POST** /projects | Create a new project with the given key and name.
+
+
+# **delete_project**
+> delete_project(project_key, )
+
+Delete a project by key. Caution-- deleting a project will delete all associated environments and feature flags. You cannot delete the last project in an account.
+
+### Example
+```ruby
+# load the gem
+require 'launchdarkly_api'
+# setup authorization
+LaunchDarklyApi.configure do |config|
+  # Configure API key authorization: Token
+  config.api_key['Authorization'] = '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['Authorization'] = 'Bearer'
+end
+
+api_instance = LaunchDarklyApi::ProjectsApi.new
+
+project_key = "project_key_example" # String | The project key, used to tie the flags together under one project so they can be managed together.
+
+
+begin
+  #Delete a project by key. Caution-- deleting a project will delete all associated environments and feature flags. You cannot delete the last project in an account.
+  api_instance.delete_project(project_key, )
+rescue LaunchDarklyApi::ApiError => e
+  puts "Exception when calling ProjectsApi->delete_project: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **project_key** | **String**| The project key, used to tie the flags together under one project so they can be managed together. | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[Token](../README.md#Token)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_project**
+> Project get_project(project_key, )
+
+Fetch a single project by key.
+
+### Example
+```ruby
+# load the gem
+require 'launchdarkly_api'
+# setup authorization
+LaunchDarklyApi.configure do |config|
+  # Configure API key authorization: Token
+  config.api_key['Authorization'] = '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['Authorization'] = 'Bearer'
+end
+
+api_instance = LaunchDarklyApi::ProjectsApi.new
+
+project_key = "project_key_example" # String | The project key, used to tie the flags together under one project so they can be managed together.
+
+
+begin
+  #Fetch a single project by key.
+  result = api_instance.get_project(project_key, )
+  p result
+rescue LaunchDarklyApi::ApiError => e
+  puts "Exception when calling ProjectsApi->get_project: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **project_key** | **String**| The project key, used to tie the flags together under one project so they can be managed together. | 
+
+### Return type
+
+[**Project**](Project.md)
+
+### Authorization
+
+[Token](../README.md#Token)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_projects**
+> Projects get_projects
+
+Returns a list of all projects in the account.
+
+### Example
+```ruby
+# load the gem
+require 'launchdarkly_api'
+# setup authorization
+LaunchDarklyApi.configure do |config|
+  # Configure API key authorization: Token
+  config.api_key['Authorization'] = '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['Authorization'] = 'Bearer'
+end
+
+api_instance = LaunchDarklyApi::ProjectsApi.new
+
+begin
+  #Returns a list of all projects in the account.
+  result = api_instance.get_projects
+  p result
+rescue LaunchDarklyApi::ApiError => e
+  puts "Exception when calling ProjectsApi->get_projects: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**Projects**](Projects.md)
+
+### Authorization
+
+[Token](../README.md#Token)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **patch_project**
+> Project patch_project(project_key, patch_delta)
+
+Modify a project by ID.
+
+### Example
+```ruby
+# load the gem
+require 'launchdarkly_api'
+# setup authorization
+LaunchDarklyApi.configure do |config|
+  # Configure API key authorization: Token
+  config.api_key['Authorization'] = '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['Authorization'] = 'Bearer'
+end
+
+api_instance = LaunchDarklyApi::ProjectsApi.new
+
+project_key = "project_key_example" # String | The project key, used to tie the flags together under one project so they can be managed together.
+
+patch_delta = [LaunchDarklyApi::PatchOperation.new] # Array<PatchOperation> | Requires a JSON Patch representation of the desired changes to the project. 'http://jsonpatch.com/'
+
+
+begin
+  #Modify a project by ID.
+  result = api_instance.patch_project(project_key, patch_delta)
+  p result
+rescue LaunchDarklyApi::ApiError => e
+  puts "Exception when calling ProjectsApi->patch_project: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **project_key** | **String**| The project key, used to tie the flags together under one project so they can be managed together. | 
+ **patch_delta** | [**Array&lt;PatchOperation&gt;**](PatchOperation.md)| Requires a JSON Patch representation of the desired changes to the project. &#39;http://jsonpatch.com/&#39; | 
+
+### Return type
+
+[**Project**](Project.md)
+
+### Authorization
+
+[Token](../README.md#Token)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **post_project**
+> post_project(project_body)
+
+Create a new project with the given key and name.
+
+### Example
+```ruby
+# load the gem
+require 'launchdarkly_api'
+# setup authorization
+LaunchDarklyApi.configure do |config|
+  # Configure API key authorization: Token
+  config.api_key['Authorization'] = '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['Authorization'] = 'Bearer'
+end
+
+api_instance = LaunchDarklyApi::ProjectsApi.new
+
+project_body = LaunchDarklyApi::ProjectBody.new # ProjectBody | Project keys must be unique within an account.
+
+
+begin
+  #Create a new project with the given key and name.
+  api_instance.post_project(project_body)
+rescue LaunchDarklyApi::ApiError => e
+  puts "Exception when calling ProjectsApi->post_project: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **project_body** | [**ProjectBody**](ProjectBody.md)| Project keys must be unique within an account. | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[Token](../README.md#Token)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/Resource.md

@@ -0,0 +1,7 @@
+# LaunchDarklyApi::Resource
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+

data/docs/Resources.md

@@ -0,0 +1,7 @@
+# LaunchDarklyApi::Resources
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+

data/docs/Role.md

@@ -0,0 +1,7 @@
+# LaunchDarklyApi::Role
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+

data/docs/Rollout.md

@@ -0,0 +1,8 @@
+# LaunchDarklyApi::Rollout
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**variations** | [**Array<WeightedVariation>**](WeightedVariation.md) |  | [optional] 
+
+

data/docs/RootApi.md

@@ -0,0 +1,56 @@
+# LaunchDarklyApi::RootApi
+
+All URIs are relative to *https://app.launchdarkly.com/api/v2*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_root**](RootApi.md#get_root) | **GET** / | 
+
+
+# **get_root**
+> Links get_root
+
+
+
+You can issue a GET request to the root resource to find all of the resource categories supported by the API.
+
+### Example
+```ruby
+# load the gem
+require 'launchdarkly_api'
+# setup authorization
+LaunchDarklyApi.configure do |config|
+  # Configure API key authorization: Token
+  config.api_key['Authorization'] = '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['Authorization'] = 'Bearer'
+end
+
+api_instance = LaunchDarklyApi::RootApi.new
+
+begin
+  result = api_instance.get_root
+  p result
+rescue LaunchDarklyApi::ApiError => e
+  puts "Exception when calling RootApi->get_root: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**Links**](Links.md)
+
+### Authorization
+
+[Token](../README.md#Token)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/Rule.md

@@ -0,0 +1,10 @@
+# LaunchDarklyApi::Rule
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**variation** | **Integer** |  | [optional] 
+**rollout** | [**Rollout**](Rollout.md) |  | [optional] 
+**clauses** | [**Array<Clause>**](Clause.md) |  | [optional] 
+
+

data/docs/Statement.md

@@ -0,0 +1,12 @@
+# LaunchDarklyApi::Statement
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**resources** | [**Resources**](Resources.md) |  | [optional] 
+**notresources** | [**Resources**](Resources.md) | Targeted resource will be those resources NOT in this list. The \"resources`\" field must be empty to use this field. | [optional] 
+**actions** | [**Actions**](Actions.md) |  | [optional] 
+**notactions** | [**Actions**](Actions.md) | Targeted actions will be those actions NOT in this list. The \"actions\" field must be empty to use this field. | [optional] 
+**effect** | **String** |  | [optional] 
+
+

data/docs/Statements.md

@@ -0,0 +1,7 @@
+# LaunchDarklyApi::Statements
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+

data/docs/Target.md

@@ -0,0 +1,9 @@
+# LaunchDarklyApi::Target
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**values** | **Array<String>** |  | [optional] 
+**variation** | **Integer** |  | [optional] 
+
+

data/docs/TeamMembersApi.md

@@ -0,0 +1,268 @@
+# LaunchDarklyApi::TeamMembersApi
+
+All URIs are relative to *https://app.launchdarkly.com/api/v2*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**delete_member**](TeamMembersApi.md#delete_member) | **DELETE** /members/{memberId} | Delete a team member by ID.
+[**get_member**](TeamMembersApi.md#get_member) | **GET** /members/{memberId} | Get a single team member by ID.
+[**get_members**](TeamMembersApi.md#get_members) | **GET** /members | Returns a list of all members in the account.
+[**patch_member**](TeamMembersApi.md#patch_member) | **PATCH** /members/{memberId} | Modify a team member by ID.
+[**post_members**](TeamMembersApi.md#post_members) | **POST** /members | Invite new members.
+
+
+# **delete_member**
+> delete_member(member_id, )
+
+Delete a team member by ID.
+
+### Example
+```ruby
+# load the gem
+require 'launchdarkly_api'
+# setup authorization
+LaunchDarklyApi.configure do |config|
+  # Configure API key authorization: Token
+  config.api_key['Authorization'] = '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['Authorization'] = 'Bearer'
+end
+
+api_instance = LaunchDarklyApi::TeamMembersApi.new
+
+member_id = "member_id_example" # String | The member ID.
+
+
+begin
+  #Delete a team member by ID.
+  api_instance.delete_member(member_id, )
+rescue LaunchDarklyApi::ApiError => e
+  puts "Exception when calling TeamMembersApi->delete_member: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **member_id** | **String**| The member ID. | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[Token](../README.md#Token)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_member**
+> Member get_member(member_id, )
+
+Get a single team member by ID.
+
+### Example
+```ruby
+# load the gem
+require 'launchdarkly_api'
+# setup authorization
+LaunchDarklyApi.configure do |config|
+  # Configure API key authorization: Token
+  config.api_key['Authorization'] = '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['Authorization'] = 'Bearer'
+end
+
+api_instance = LaunchDarklyApi::TeamMembersApi.new
+
+member_id = "member_id_example" # String | The member ID.
+
+
+begin
+  #Get a single team member by ID.
+  result = api_instance.get_member(member_id, )
+  p result
+rescue LaunchDarklyApi::ApiError => e
+  puts "Exception when calling TeamMembersApi->get_member: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **member_id** | **String**| The member ID. | 
+
+### Return type
+
+[**Member**](Member.md)
+
+### Authorization
+
+[Token](../README.md#Token)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_members**
+> Members get_members
+
+Returns a list of all members in the account.
+
+### Example
+```ruby
+# load the gem
+require 'launchdarkly_api'
+# setup authorization
+LaunchDarklyApi.configure do |config|
+  # Configure API key authorization: Token
+  config.api_key['Authorization'] = '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['Authorization'] = 'Bearer'
+end
+
+api_instance = LaunchDarklyApi::TeamMembersApi.new
+
+begin
+  #Returns a list of all members in the account.
+  result = api_instance.get_members
+  p result
+rescue LaunchDarklyApi::ApiError => e
+  puts "Exception when calling TeamMembersApi->get_members: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**Members**](Members.md)
+
+### Authorization
+
+[Token](../README.md#Token)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **patch_member**
+> Member patch_member(member_id, patch_delta)
+
+Modify a team member by ID.
+
+### Example
+```ruby
+# load the gem
+require 'launchdarkly_api'
+# setup authorization
+LaunchDarklyApi.configure do |config|
+  # Configure API key authorization: Token
+  config.api_key['Authorization'] = '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['Authorization'] = 'Bearer'
+end
+
+api_instance = LaunchDarklyApi::TeamMembersApi.new
+
+member_id = "member_id_example" # String | The member ID.
+
+patch_delta = [LaunchDarklyApi::PatchOperation.new] # Array<PatchOperation> | Requires a JSON Patch representation of the desired changes to the project. 'http://jsonpatch.com/'
+
+
+begin
+  #Modify a team member by ID.
+  result = api_instance.patch_member(member_id, patch_delta)
+  p result
+rescue LaunchDarklyApi::ApiError => e
+  puts "Exception when calling TeamMembersApi->patch_member: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **member_id** | **String**| The member ID. | 
+ **patch_delta** | [**Array&lt;PatchOperation&gt;**](PatchOperation.md)| Requires a JSON Patch representation of the desired changes to the project. &#39;http://jsonpatch.com/&#39; | 
+
+### Return type
+
+[**Member**](Member.md)
+
+### Authorization
+
+[Token](../README.md#Token)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **post_members**
+> post_members(members_body)
+
+Invite new members.
+
+### Example
+```ruby
+# load the gem
+require 'launchdarkly_api'
+# setup authorization
+LaunchDarklyApi.configure do |config|
+  # Configure API key authorization: Token
+  config.api_key['Authorization'] = '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['Authorization'] = 'Bearer'
+end
+
+api_instance = LaunchDarklyApi::TeamMembersApi.new
+
+members_body = [LaunchDarklyApi::MembersBody.new] # Array<MembersBody> | New members to invite.
+
+
+begin
+  #Invite new members.
+  api_instance.post_members(members_body)
+rescue LaunchDarklyApi::ApiError => e
+  puts "Exception when calling TeamMembersApi->post_members: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **members_body** | [**Array&lt;MembersBody&gt;**](MembersBody.md)| New members to invite. | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[Token](../README.md#Token)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/User.md

@@ -0,0 +1,18 @@
+# LaunchDarklyApi::User
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**key** | **String** |  | [optional] 
+**secondary** | **String** |  | [optional] 
+**ip** | **String** |  | [optional] 
+**country** | **String** |  | [optional] 
+**email** | **String** |  | [optional] 
+**first_name** | **String** |  | [optional] 
+**last_name** | **String** |  | [optional] 
+**avatar** | **String** |  | [optional] 
+**name** | **String** |  | [optional] 
+**anonymous** | **BOOLEAN** |  | [optional] 
+**custom** | **Object** |  | [optional] 
+
+

data/docs/UserFlagSetting.md

@@ -0,0 +1,10 @@
+# LaunchDarklyApi::UserFlagSetting
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**_links** | [**Links**](Links.md) |  | [optional] 
+**_value** | **BOOLEAN** | The most important attribute in the response. The _value is the current setting for the user. For a boolean feature toggle, this will be true, false, or null if there is no defined fallthrough value. | [optional] 
+**setting** | **BOOLEAN** | The setting attribute indicates whether you've explicitly targeted this user to receive a particular variation. For example, if you have explicitly turned off a feature toggle for a user, setting will be false. A setting of null means that you haven't assigned that user to a specific variation. | [optional] 
+
+