launchdarkly_api 2.0.3

data/docs/UserFlagSettings.md

@@ -0,0 +1,9 @@
+# LaunchDarklyApi::UserFlagSettings
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**_links** | [**Links**](Links.md) |  | [optional] 
+**items** | **Object** |  | [optional] 
+
+

data/docs/UserRecord.md

@@ -0,0 +1,12 @@
+# LaunchDarklyApi::UserRecord
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**last_ping** | **String** |  | [optional] 
+**environment_id** | **String** |  | [optional] 
+**owner_id** | [**Id**](Id.md) |  | [optional] 
+**user** | [**User**](User.md) |  | [optional] 
+**avatar** | **String** |  | [optional] 
+
+

data/docs/UserSegment.md

@@ -0,0 +1,17 @@
+# LaunchDarklyApi::UserSegment
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**key** | **String** | Unique identifier for the user segment. | 
+**name** | **String** | Name of the user segment. | 
+**description** | **String** | Description of the user segment. | [optional] 
+**tags** | **Array<String>** | An array of tags for this user segment. | [optional] 
+**creation_date** | **Float** | A unix epoch time in milliseconds specifying the creation time of this flag. | 
+**included** | **Array<String>** | An array of user keys that are included in this segment. | [optional] 
+**excluded** | **Array<String>** | An array of user keys that should not be included in this segment, unless they are also listed in \"included\". | [optional] 
+**rules** | [**Array<UserSegmentRule>**](UserSegmentRule.md) | An array of rules that can cause a user to be included in this segment. | [optional] 
+**version** | **Integer** |  | [optional] 
+**_links** | [**Links**](Links.md) |  | [optional] 
+
+

data/docs/UserSegmentBody.md

@@ -0,0 +1,11 @@
+# LaunchDarklyApi::UserSegmentBody
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | A human-friendly name for the user segment. | 
+**key** | **String** | A unique key that will be used to reference the user segment in feature flags. | 
+**description** | **String** | A description for the user segment. | [optional] 
+**tags** | **Array<String>** | Tags for the user segment. | [optional] 
+
+

data/docs/UserSegmentRule.md

@@ -0,0 +1,10 @@
+# LaunchDarklyApi::UserSegmentRule
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**clauses** | [**Array<Clause>**](Clause.md) |  | [optional] 
+**weight** | **Integer** |  | [optional] 
+**bucket_by** | **String** |  | [optional] 
+
+

data/docs/UserSegments.md

@@ -0,0 +1,9 @@
+# LaunchDarklyApi::UserSegments
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**_links** | [**Links**](Links.md) |  | [optional] 
+**items** | [**Array<UserSegment>**](UserSegment.md) |  | [optional] 
+
+

data/docs/UserSegmentsApi.md

@@ -0,0 +1,305 @@
+# LaunchDarklyApi::UserSegmentsApi
+
+All URIs are relative to *https://app.launchdarkly.com/api/v2*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**delete_user_segment**](UserSegmentsApi.md#delete_user_segment) | **DELETE** /segments/{projectKey}/{environmentKey}/{userSegmentKey} | Delete a user segment.
+[**get_user_segment**](UserSegmentsApi.md#get_user_segment) | **GET** /segments/{projectKey}/{environmentKey}/{userSegmentKey} | Get a single user segment by key.
+[**get_user_segments**](UserSegmentsApi.md#get_user_segments) | **GET** /segments/{projectKey}/{environmentKey} | Get a list of all user segments in the given project.
+[**patch_user_segment**](UserSegmentsApi.md#patch_user_segment) | **PATCH** /segments/{projectKey}/{environmentKey}/{userSegmentKey} | Perform a partial update to a user segment.
+[**post_user_segment**](UserSegmentsApi.md#post_user_segment) | **POST** /segments/{projectKey}/{environmentKey} | Creates a new user segment.
+
+
+# **delete_user_segment**
+> delete_user_segment(project_key, environment_key, user_segment_key, )
+
+Delete a user segment.
+
+### 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::UserSegmentsApi.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.
+
+environment_key = "environment_key_example" # String | The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
+
+user_segment_key = "user_segment_key_example" # String | The user segment's key. The key identifies the user segment in your code.
+
+
+begin
+  #Delete a user segment.
+  api_instance.delete_user_segment(project_key, environment_key, user_segment_key, )
+rescue LaunchDarklyApi::ApiError => e
+  puts "Exception when calling UserSegmentsApi->delete_user_segment: #{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. | 
+ **environment_key** | **String**| The environment key, used to tie together flag configuration and users under one environment so they can be managed together. | 
+ **user_segment_key** | **String**| The user segment's key. The key identifies the user segment in your code. | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[Token](../README.md#Token)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_user_segment**
+> UserSegment get_user_segment(project_key, environment_key, user_segment_key, )
+
+Get a single user segment 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::UserSegmentsApi.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.
+
+environment_key = "environment_key_example" # String | The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
+
+user_segment_key = "user_segment_key_example" # String | The user segment's key. The key identifies the user segment in your code.
+
+
+begin
+  #Get a single user segment by key.
+  result = api_instance.get_user_segment(project_key, environment_key, user_segment_key, )
+  p result
+rescue LaunchDarklyApi::ApiError => e
+  puts "Exception when calling UserSegmentsApi->get_user_segment: #{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. | 
+ **environment_key** | **String**| The environment key, used to tie together flag configuration and users under one environment so they can be managed together. | 
+ **user_segment_key** | **String**| The user segment's key. The key identifies the user segment in your code. | 
+
+### Return type
+
+[**UserSegment**](UserSegment.md)
+
+### Authorization
+
+[Token](../README.md#Token)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_user_segments**
+> UserSegments get_user_segments(project_key, environment_key, , opts)
+
+Get a list of all user segments in the given project.
+
+### 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::UserSegmentsApi.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.
+
+environment_key = "environment_key_example" # String | The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
+
+opts = { 
+  tag: "tag_example" # String | Filter by tag. A tag can be used to group flags across projects.
+}
+
+begin
+  #Get a list of all user segments in the given project.
+  result = api_instance.get_user_segments(project_key, environment_key, , opts)
+  p result
+rescue LaunchDarklyApi::ApiError => e
+  puts "Exception when calling UserSegmentsApi->get_user_segments: #{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. | 
+ **environment_key** | **String**| The environment key, used to tie together flag configuration and users under one environment so they can be managed together. | 
+ **tag** | **String**| Filter by tag. A tag can be used to group flags across projects. | [optional] 
+
+### Return type
+
+[**UserSegments**](UserSegments.md)
+
+### Authorization
+
+[Token](../README.md#Token)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **patch_user_segment**
+> UserSegment patch_user_segment(project_key, environment_key, user_segment_key, patch_only)
+
+Perform a partial update to a user segment.
+
+### 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::UserSegmentsApi.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.
+
+environment_key = "environment_key_example" # String | The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
+
+user_segment_key = "user_segment_key_example" # String | The user segment's key. The key identifies the user segment in your code.
+
+patch_only = [LaunchDarklyApi::PatchOperation.new] # Array<PatchOperation> | Requires a JSON Patch representation of the desired changes to the project. 'http://jsonpatch.com/' Feature flag patches also support JSON Merge Patch format. 'https://tools.ietf.org/html/rfc7386' The addition of comments is also supported.
+
+
+begin
+  #Perform a partial update to a user segment.
+  result = api_instance.patch_user_segment(project_key, environment_key, user_segment_key, patch_only)
+  p result
+rescue LaunchDarklyApi::ApiError => e
+  puts "Exception when calling UserSegmentsApi->patch_user_segment: #{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. | 
+ **environment_key** | **String**| The environment key, used to tie together flag configuration and users under one environment so they can be managed together. | 
+ **user_segment_key** | **String**| The user segment&#39;s key. The key identifies the user segment in your code. | 
+ **patch_only** | [**Array&lt;PatchOperation&gt;**](PatchOperation.md)| Requires a JSON Patch representation of the desired changes to the project. &#39;http://jsonpatch.com/&#39; Feature flag patches also support JSON Merge Patch format. &#39;https://tools.ietf.org/html/rfc7386&#39; The addition of comments is also supported. | 
+
+### Return type
+
+[**UserSegment**](UserSegment.md)
+
+### Authorization
+
+[Token](../README.md#Token)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **post_user_segment**
+> post_user_segment(project_key, environment_key, user_segment_body)
+
+Creates a new user segment.
+
+### 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::UserSegmentsApi.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.
+
+environment_key = "environment_key_example" # String | The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
+
+user_segment_body = LaunchDarklyApi::UserSegmentBody.new # UserSegmentBody | Create a new user segment.
+
+
+begin
+  #Creates a new user segment.
+  api_instance.post_user_segment(project_key, environment_key, user_segment_body)
+rescue LaunchDarklyApi::ApiError => e
+  puts "Exception when calling UserSegmentsApi->post_user_segment: #{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. | 
+ **environment_key** | **String**| The environment key, used to tie together flag configuration and users under one environment so they can be managed together. | 
+ **user_segment_body** | [**UserSegmentBody**](UserSegmentBody.md)| Create a new user segment. | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[Token](../README.md#Token)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/UserSettingsApi.md

@@ -0,0 +1,193 @@
+# LaunchDarklyApi::UserSettingsApi
+
+All URIs are relative to *https://app.launchdarkly.com/api/v2*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_user_flag_setting**](UserSettingsApi.md#get_user_flag_setting) | **GET** /users/{projectKey}/{environmentKey}/{userKey}/flags/{featureFlagKey} | Fetch a single flag setting for a user by key.
+[**get_user_flag_settings**](UserSettingsApi.md#get_user_flag_settings) | **GET** /users/{projectKey}/{environmentKey}/{userKey}/flags | Fetch a single flag setting for a user by key.
+[**put_flag_setting**](UserSettingsApi.md#put_flag_setting) | **PUT** /users/{projectKey}/{environmentKey}/{userKey}/flags/{featureFlagKey} | Specifically enable or disable a feature flag for a user based on their key.
+
+
+# **get_user_flag_setting**
+> UserFlagSetting get_user_flag_setting(project_key, environment_key, user_key, feature_flag_key, )
+
+Fetch a single flag setting for a user 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::UserSettingsApi.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.
+
+environment_key = "environment_key_example" # String | The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
+
+user_key = "user_key_example" # String | The user's key.
+
+feature_flag_key = "feature_flag_key_example" # String | The feature flag's key. The key identifies the flag in your code.
+
+
+begin
+  #Fetch a single flag setting for a user by key.
+  result = api_instance.get_user_flag_setting(project_key, environment_key, user_key, feature_flag_key, )
+  p result
+rescue LaunchDarklyApi::ApiError => e
+  puts "Exception when calling UserSettingsApi->get_user_flag_setting: #{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. | 
+ **environment_key** | **String**| The environment key, used to tie together flag configuration and users under one environment so they can be managed together. | 
+ **user_key** | **String**| The user's key. | 
+ **feature_flag_key** | **String**| The feature flag's key. The key identifies the flag in your code. | 
+
+### Return type
+
+[**UserFlagSetting**](UserFlagSetting.md)
+
+### Authorization
+
+[Token](../README.md#Token)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_user_flag_settings**
+> UserFlagSettings get_user_flag_settings(project_key, environment_key, user_key, )
+
+Fetch a single flag setting for a user 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::UserSettingsApi.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.
+
+environment_key = "environment_key_example" # String | The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
+
+user_key = "user_key_example" # String | The user's key.
+
+
+begin
+  #Fetch a single flag setting for a user by key.
+  result = api_instance.get_user_flag_settings(project_key, environment_key, user_key, )
+  p result
+rescue LaunchDarklyApi::ApiError => e
+  puts "Exception when calling UserSettingsApi->get_user_flag_settings: #{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. | 
+ **environment_key** | **String**| The environment key, used to tie together flag configuration and users under one environment so they can be managed together. | 
+ **user_key** | **String**| The user's key. | 
+
+### Return type
+
+[**UserFlagSettings**](UserFlagSettings.md)
+
+### Authorization
+
+[Token](../README.md#Token)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **put_flag_setting**
+> put_flag_setting(project_key, environment_key, user_key, feature_flag_key, user_settings_body)
+
+Specifically enable or disable a feature flag for a user based on their 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::UserSettingsApi.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.
+
+environment_key = "environment_key_example" # String | The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
+
+user_key = "user_key_example" # String | The user's key.
+
+feature_flag_key = "feature_flag_key_example" # String | The feature flag's key. The key identifies the flag in your code.
+
+user_settings_body = LaunchDarklyApi::UserSettingsBody.new # UserSettingsBody | 
+
+
+begin
+  #Specifically enable or disable a feature flag for a user based on their key.
+  api_instance.put_flag_setting(project_key, environment_key, user_key, feature_flag_key, user_settings_body)
+rescue LaunchDarklyApi::ApiError => e
+  puts "Exception when calling UserSettingsApi->put_flag_setting: #{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. | 
+ **environment_key** | **String**| The environment key, used to tie together flag configuration and users under one environment so they can be managed together. | 
+ **user_key** | **String**| The user's key. | 
+ **feature_flag_key** | **String**| The feature flag's key. The key identifies the flag in your code. | 
+ **user_settings_body** | [**UserSettingsBody**](UserSettingsBody.md)|  | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[Token](../README.md#Token)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/UserSettingsBody.md

@@ -0,0 +1,8 @@
+# LaunchDarklyApi::UserSettingsBody
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**setting** | **BOOLEAN** | The variation value to set for the user. Must match the variation type of the flag.  | [optional] 
+
+

data/docs/Users.md

@@ -0,0 +1,10 @@
+# LaunchDarklyApi::Users
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**_links** | [**Links**](Links.md) |  | [optional] 
+**total_count** | **Float** |  | [optional] 
+**items** | [**Array<UserRecord>**](UserRecord.md) |  | [optional] 
+
+