launchdarkly_api 5.3.0 → 7.0.0

data/docs/UserSettingsApi.md

@@ -1,119 +1,153 @@
 # LaunchDarklyApi::UserSettingsApi
 
-All URIs are relative to *https://app.launchdarkly.com/api/v2*
+All URIs are relative to *https://app.launchdarkly.com*
 
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**get_expiring_user_targets_for_user**](UserSettingsApi.md#get_expiring_user_targets_for_user) | **GET** /users/{projectKey}/{userKey}/expiring-user-targets/{environmentKey} | Get expiring dates on flags for user
-[**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.
-[**patch_expiring_user_targets_for_flags**](UserSettingsApi.md#patch_expiring_user_targets_for_flags) | **PATCH** /users/{projectKey}/{userKey}/expiring-user-targets/{environmentKey} | Update, add, or delete expiring user targets for a single user on all flags
-[**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.
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get_expiring_flags_for_user**](UserSettingsApi.md#get_expiring_flags_for_user) | **GET** /api/v2/users/{projKey}/{userKey}/expiring-user-targets/{envKey} | Get expiring dates on flags for user |
+| [**get_user_flag_setting**](UserSettingsApi.md#get_user_flag_setting) | **GET** /api/v2/users/{projKey}/{envKey}/{key}/flags/{featureKey} | Get flag setting for user |
+| [**get_user_flag_settings**](UserSettingsApi.md#get_user_flag_settings) | **GET** /api/v2/users/{projKey}/{envKey}/{key}/flags | List flag settings for user |
+| [**patch_expiring_flags_for_user**](UserSettingsApi.md#patch_expiring_flags_for_user) | **PATCH** /api/v2/users/{projKey}/{userKey}/expiring-user-targets/{envKey} | Update expiring user target for flags |
+| [**put_flag_setting**](UserSettingsApi.md#put_flag_setting) | **PUT** /api/v2/users/{projKey}/{envKey}/{key}/flags/{featureKey} | Update flag settings for user |
 
 
-# **get_expiring_user_targets_for_user**
-> UserTargetingExpirationOnFlagsForUser get_expiring_user_targets_for_user(project_key, environment_key, user_key, )
+## get_expiring_flags_for_user
+
+> <ExpiringUserTargetGetResponse> get_expiring_flags_for_user(proj_key, user_key, env_key)
 
 Get expiring dates on flags for user
 
-### Example
+Get a list of flags for which the given user is scheduled for removal.
+
+### Examples
+
 ```ruby
-# load the gem
+require 'time'
 require 'launchdarkly_api'
 # setup authorization
 LaunchDarklyApi.configure do |config|
-  # Configure API key authorization: Token
-  config.api_key['Authorization'] = 'YOUR API KEY'
+  # 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['Authorization'] = 'Bearer'
+  # config.api_key_prefix['ApiKey'] = 'Bearer'
 end
 
 api_instance = LaunchDarklyApi::UserSettingsApi.new
+proj_key = 'proj_key_example' # String | The project key.
+user_key = 'user_key_example' # String | The user key.
+env_key = 'env_key_example' # String | The environment key.
 
-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
+  # Get expiring dates on flags for user
+  result = api_instance.get_expiring_flags_for_user(proj_key, user_key, env_key)
+  p result
+rescue LaunchDarklyApi::ApiError => e
+  puts "Error when calling UserSettingsApi->get_expiring_flags_for_user: #{e}"
+end
+```
 
-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.
+#### Using the get_expiring_flags_for_user_with_http_info variant
 
-user_key = 'user_key_example' # String | The user's key.
+This returns an Array which contains the response data, status code and headers.
 
+> <Array(<ExpiringUserTargetGetResponse>, Integer, Hash)> get_expiring_flags_for_user_with_http_info(proj_key, user_key, env_key)
 
+```ruby
 begin
-  #Get expiring dates on flags for user
-  result = api_instance.get_expiring_user_targets_for_user(project_key, environment_key, user_key, )
-  p result
+  # Get expiring dates on flags for user
+  data, status_code, headers = api_instance.get_expiring_flags_for_user_with_http_info(proj_key, user_key, env_key)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ExpiringUserTargetGetResponse>
 rescue LaunchDarklyApi::ApiError => e
-  puts "Exception when calling UserSettingsApi->get_expiring_user_targets_for_user: #{e}"
+  puts "Error when calling UserSettingsApi->get_expiring_flags_for_user_with_http_info: #{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&#39;s key. | 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **proj_key** | **String** | The project key. |  |
+| **user_key** | **String** | The user key. |  |
+| **env_key** | **String** | The environment key. |  |
 
 ### Return type
 
-[**UserTargetingExpirationOnFlagsForUser**](UserTargetingExpirationOnFlagsForUser.md)
+[**ExpiringUserTargetGetResponse**](ExpiringUserTargetGetResponse.md)
 
 ### Authorization
 
-[Token](../README.md#Token)
+[ApiKey](../README.md#ApiKey)
 
 ### HTTP request headers
 
- - **Content-Type**: application/json
- - **Accept**: application/json
+- **Content-Type**: Not defined
+- **Accept**: application/json
 
 
+## get_user_flag_setting
 
-# **get_user_flag_setting**
-> UserFlagSetting get_user_flag_setting(project_key, environment_key, user_key, feature_flag_key, )
+> <UserFlagSetting> get_user_flag_setting(proj_key, env_key, key, feature_key)
 
-Fetch a single flag setting for a user by key.
+Get flag setting for user
+
+Get a single flag setting for a user by key. The most important attribute in the response is the `_value`. The `_value` is the current setting that the user sees. For a boolean feature toggle, this is `true`, `false`, or `null`. `null` returns if there is no defined fallback value. The example response indicates that the user `Abbie_Braun` has the `sort.order` flag enabled.<br /><br />The setting attribute indicates whether you've explicitly targeted a user to receive a particular variation. For example, if you have turned off a feature flag for a user, this setting will be `false`. A setting of `null` means that you haven't assigned that user to a specific variation.
+
+### Examples
 
-### Example
 ```ruby
-# load the gem
+require 'time'
 require 'launchdarkly_api'
 # setup authorization
 LaunchDarklyApi.configure do |config|
-  # Configure API key authorization: Token
-  config.api_key['Authorization'] = 'YOUR API KEY'
+  # 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['Authorization'] = 'Bearer'
+  # config.api_key_prefix['ApiKey'] = 'Bearer'
 end
 
 api_instance = LaunchDarklyApi::UserSettingsApi.new
+proj_key = 'proj_key_example' # String | The project key
+env_key = 'env_key_example' # String | The environment key
+key = 'key_example' # String | The user key
+feature_key = 'feature_key_example' # String | The feature flag key
 
-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.
+begin
+  # Get flag setting for user
+  result = api_instance.get_user_flag_setting(proj_key, env_key, key, feature_key)
+  p result
+rescue LaunchDarklyApi::ApiError => e
+  puts "Error when calling UserSettingsApi->get_user_flag_setting: #{e}"
+end
+```
 
-user_key = 'user_key_example' # String | The user's key.
+#### Using the get_user_flag_setting_with_http_info variant
 
-feature_flag_key = 'feature_flag_key_example' # String | The feature flag's key. The key identifies the flag in your code.
+This returns an Array which contains the response data, status code and headers.
 
+> <Array(<UserFlagSetting>, Integer, Hash)> get_user_flag_setting_with_http_info(proj_key, env_key, key, feature_key)
 
+```ruby
 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
+  # Get flag setting for user
+  data, status_code, headers = api_instance.get_user_flag_setting_with_http_info(proj_key, env_key, key, feature_key)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <UserFlagSetting>
 rescue LaunchDarklyApi::ApiError => e
-  puts "Exception when calling UserSettingsApi->get_user_flag_setting: #{e}"
+  puts "Error when calling UserSettingsApi->get_user_flag_setting_with_http_info: #{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&#39;s key. | 
- **feature_flag_key** | **String**| The feature flag&#39;s key. The key identifies the flag in your code. | 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **proj_key** | **String** | The project key |  |
+| **env_key** | **String** | The environment key |  |
+| **key** | **String** | The user key |  |
+| **feature_key** | **String** | The feature flag key |  |
 
 ### Return type
 
@@ -121,57 +155,74 @@ Name | Type | Description  | Notes
 
 ### Authorization
 
-[Token](../README.md#Token)
+[ApiKey](../README.md#ApiKey)
 
 ### HTTP request headers
 
- - **Content-Type**: application/json
- - **Accept**: application/json
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_user_flag_settings
 
+> <UserFlagSettings> get_user_flag_settings(proj_key, env_key, key)
 
+List flag settings for user
 
-# **get_user_flag_settings**
-> UserFlagSettings get_user_flag_settings(project_key, environment_key, user_key, )
+Get the current flag settings for a given user. The most important attribute in the response is the `_value`. The `_value` is the setting that the user sees. For a boolean feature toggle, this is `true`, `false`, or `null`. `null` returns if there is no defined fallthrough value. The example response indicates that the user `Abbie_Braun` has the `sort.order` flag enabled and the `alternate.page` flag disabled.<br /><br />The setting attribute indicates whether you've explicitly targeted a user to receive a particular variation. For example, if you have turned off a feature flag for a user, this setting will be `false`. A setting of `null` means that you haven't assigned that user to a specific variation.
 
-Fetch a single flag setting for a user by key.
+### Examples
 
-### Example
 ```ruby
-# load the gem
+require 'time'
 require 'launchdarkly_api'
 # setup authorization
 LaunchDarklyApi.configure do |config|
-  # Configure API key authorization: Token
-  config.api_key['Authorization'] = 'YOUR API KEY'
+  # 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['Authorization'] = 'Bearer'
+  # config.api_key_prefix['ApiKey'] = 'Bearer'
 end
 
 api_instance = LaunchDarklyApi::UserSettingsApi.new
+proj_key = 'proj_key_example' # String | The project key
+env_key = 'env_key_example' # String | The environment key
+key = 'key_example' # String | The user key
 
-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
+  # List flag settings for user
+  result = api_instance.get_user_flag_settings(proj_key, env_key, key)
+  p result
+rescue LaunchDarklyApi::ApiError => e
+  puts "Error when calling UserSettingsApi->get_user_flag_settings: #{e}"
+end
+```
 
-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.
+#### Using the get_user_flag_settings_with_http_info variant
 
-user_key = 'user_key_example' # String | The user's key.
+This returns an Array which contains the response data, status code and headers.
 
+> <Array(<UserFlagSettings>, Integer, Hash)> get_user_flag_settings_with_http_info(proj_key, env_key, key)
 
+```ruby
 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
+  # List flag settings for user
+  data, status_code, headers = api_instance.get_user_flag_settings_with_http_info(proj_key, env_key, key)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <UserFlagSettings>
 rescue LaunchDarklyApi::ApiError => e
-  puts "Exception when calling UserSettingsApi->get_user_flag_settings: #{e}"
+  puts "Error when calling UserSettingsApi->get_user_flag_settings_with_http_info: #{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&#39;s key. | 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **proj_key** | **String** | The project key |  |
+| **env_key** | **String** | The environment key |  |
+| **key** | **String** | The user key |  |
 
 ### Return type
 
@@ -179,123 +230,154 @@ Name | Type | Description  | Notes
 
 ### Authorization
 
-[Token](../README.md#Token)
+[ApiKey](../README.md#ApiKey)
 
 ### HTTP request headers
 
- - **Content-Type**: application/json
- - **Accept**: application/json
+- **Content-Type**: Not defined
+- **Accept**: application/json
 
 
+## patch_expiring_flags_for_user
 
-# **patch_expiring_user_targets_for_flags**
-> UserTargetingExpirationOnFlagsForUser patch_expiring_user_targets_for_flags(project_key, environment_key, user_key, semantic_patch_with_comment)
+> <ExpiringUserTargetPatchResponse> patch_expiring_flags_for_user(proj_key, user_key, env_key, patch_with_comment)
 
-Update, add, or delete expiring user targets for a single user on all flags
+Update expiring user target for flags
+
+Schedule the specified user for removal from individual user targeting on one or more flags. You can only schedule a user for removal on a single variation per flag.  To learn more about semantic patches, read [Updates](/#section/Updates).  If you previously patched the flag, and the patch included the user's data, LaunchDarkly continues to use that data. If LaunchDarkly has never encountered the user's key before, it calculates the flag values based on the user key alone. 
+
+### Examples
 
-### Example
 ```ruby
-# load the gem
+require 'time'
 require 'launchdarkly_api'
 # setup authorization
 LaunchDarklyApi.configure do |config|
-  # Configure API key authorization: Token
-  config.api_key['Authorization'] = 'YOUR API KEY'
+  # 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['Authorization'] = 'Bearer'
+  # config.api_key_prefix['ApiKey'] = 'Bearer'
 end
 
 api_instance = LaunchDarklyApi::UserSettingsApi.new
+proj_key = 'proj_key_example' # String | The project key.
+user_key = 'user_key_example' # String | The user key.
+env_key = 'env_key_example' # String | The environment key.
+patch_with_comment = LaunchDarklyApi::PatchWithComment.new({patch: [LaunchDarklyApi::PatchOperation.new({op: 'replace', path: '/biscuits', value: Chocolate Digestive})]}) # PatchWithComment | 
 
-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.
+begin
+  # Update expiring user target for flags
+  result = api_instance.patch_expiring_flags_for_user(proj_key, user_key, env_key, patch_with_comment)
+  p result
+rescue LaunchDarklyApi::ApiError => e
+  puts "Error when calling UserSettingsApi->patch_expiring_flags_for_user: #{e}"
+end
+```
 
-user_key = 'user_key_example' # String | The user's key.
+#### Using the patch_expiring_flags_for_user_with_http_info variant
 
-semantic_patch_with_comment = nil # Object | Requires a Semantic Patch representation of the desired changes to the resource. 'https://apidocs.launchdarkly.com/reference#updates-via-semantic-patches'. The addition of comments is also supported.
+This returns an Array which contains the response data, status code and headers.
 
+> <Array(<ExpiringUserTargetPatchResponse>, Integer, Hash)> patch_expiring_flags_for_user_with_http_info(proj_key, user_key, env_key, patch_with_comment)
 
+```ruby
 begin
-  #Update, add, or delete expiring user targets for a single user on all flags
-  result = api_instance.patch_expiring_user_targets_for_flags(project_key, environment_key, user_key, semantic_patch_with_comment)
-  p result
+  # Update expiring user target for flags
+  data, status_code, headers = api_instance.patch_expiring_flags_for_user_with_http_info(proj_key, user_key, env_key, patch_with_comment)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ExpiringUserTargetPatchResponse>
 rescue LaunchDarklyApi::ApiError => e
-  puts "Exception when calling UserSettingsApi->patch_expiring_user_targets_for_flags: #{e}"
+  puts "Error when calling UserSettingsApi->patch_expiring_flags_for_user_with_http_info: #{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&#39;s key. | 
- **semantic_patch_with_comment** | **Object**| Requires a Semantic Patch representation of the desired changes to the resource. &#39;https://apidocs.launchdarkly.com/reference#updates-via-semantic-patches&#39;. The addition of comments is also supported. | 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **proj_key** | **String** | The project key. |  |
+| **user_key** | **String** | The user key. |  |
+| **env_key** | **String** | The environment key. |  |
+| **patch_with_comment** | [**PatchWithComment**](PatchWithComment.md) |  |  |
 
 ### Return type
 
-[**UserTargetingExpirationOnFlagsForUser**](UserTargetingExpirationOnFlagsForUser.md)
+[**ExpiringUserTargetPatchResponse**](ExpiringUserTargetPatchResponse.md)
 
 ### Authorization
 
-[Token](../README.md#Token)
+[ApiKey](../README.md#ApiKey)
 
 ### HTTP request headers
 
- - **Content-Type**: application/json
- - **Accept**: application/json
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## put_flag_setting
 
+> put_flag_setting(proj_key, env_key, key, feature_key, value_put)
 
+Update flag settings for user
 
-# **put_flag_setting**
-> put_flag_setting(project_key, environment_key, user_key, feature_flag_key, user_settings_body)
+Enable or disable a feature flag for a user based on their key.  To change the setting, send a `PUT` request to this URL with a request body containing the flag value. For example, to disable the sort.order flag for the user `test@test.com`, send a `PUT` to `https://app.launchdarkly.com/api/v2/users/default/production/test@test.com/flags/sort.order` with the following body:  ```json {   \"setting\": false } ```  Omitting the setting attribute, or a setting of null, in your `PUT` \"clears\" the current setting for a user.  If you previously patched the flag, and the patch included the user's data, LaunchDarkly continues to use that data. If LaunchDarkly has never encountered the user's key before, it calculates the flag values based on the user key alone. 
 
-Specifically enable or disable a feature flag for a user based on their key.
+### Examples
 
-### Example
 ```ruby
-# load the gem
+require 'time'
 require 'launchdarkly_api'
 # setup authorization
 LaunchDarklyApi.configure do |config|
-  # Configure API key authorization: Token
-  config.api_key['Authorization'] = 'YOUR API KEY'
+  # 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['Authorization'] = 'Bearer'
+  # config.api_key_prefix['ApiKey'] = 'Bearer'
 end
 
 api_instance = LaunchDarklyApi::UserSettingsApi.new
+proj_key = 'proj_key_example' # String | The project key
+env_key = 'env_key_example' # String | The environment key
+key = 'key_example' # String | The user key
+feature_key = 'feature_key_example' # String | The feature flag key
+value_put = LaunchDarklyApi::ValuePut.new # ValuePut | 
 
-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
+  # Update flag settings for user
+  api_instance.put_flag_setting(proj_key, env_key, key, feature_key, value_put)
+rescue LaunchDarklyApi::ApiError => e
+  puts "Error when calling UserSettingsApi->put_flag_setting: #{e}"
+end
+```
 
-feature_flag_key = 'feature_flag_key_example' # String | The feature flag's key. The key identifies the flag in your code.
+#### Using the put_flag_setting_with_http_info variant
 
-user_settings_body = LaunchDarklyApi::UserSettingsBody.new # UserSettingsBody | 
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
 
+> <Array(nil, Integer, Hash)> put_flag_setting_with_http_info(proj_key, env_key, key, feature_key, value_put)
 
+```ruby
 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)
+  # Update flag settings for user
+  data, status_code, headers = api_instance.put_flag_setting_with_http_info(proj_key, env_key, key, feature_key, value_put)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
 rescue LaunchDarklyApi::ApiError => e
-  puts "Exception when calling UserSettingsApi->put_flag_setting: #{e}"
+  puts "Error when calling UserSettingsApi->put_flag_setting_with_http_info: #{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&#39;s key. | 
- **feature_flag_key** | **String**| The feature flag&#39;s key. The key identifies the flag in your code. | 
- **user_settings_body** | [**UserSettingsBody**](UserSettingsBody.md)|  | 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **proj_key** | **String** | The project key |  |
+| **env_key** | **String** | The environment key |  |
+| **key** | **String** | The user key |  |
+| **feature_key** | **String** | The feature flag key |  |
+| **value_put** | [**ValuePut**](ValuePut.md) |  |  |
 
 ### Return type
 
@@ -303,12 +385,10 @@ nil (empty response body)
 
 ### Authorization
 
-[Token](../README.md#Token)
+[ApiKey](../README.md#ApiKey)
 
 ### HTTP request headers
 
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
+- **Content-Type**: application/json
+- **Accept**: application/json
 

data/docs/Users.md

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