launchdarkly_api 3.0.0 → 3.1.0

data/docs/UserSettingsApi.md

@@ -4,11 +4,71 @@ All URIs are relative to *https://app.launchdarkly.com/api/v2*
 
 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.
 
 
+# **get_expiring_user_targets_for_user**
+> UserTargetingExpirationOnFlagsForUser get_expiring_user_targets_for_user(project_key, environment_key, user_key, )
+
+Get expiring dates on flags for user
+
+### 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
+  #Get expiring dates on flags for user
+  result = api_instance.get_expiring_user_targets_for_user(project_key, environment_key, user_key, )
+  p result
+rescue LaunchDarklyApi::ApiError => e
+  puts "Exception when calling UserSettingsApi->get_expiring_user_targets_for_user: #{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
+
+[**UserTargetingExpirationOnFlagsForUser**](UserTargetingExpirationOnFlagsForUser.md)
+
+### Authorization
+
+[Token](../README.md#Token)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 # **get_user_flag_setting**
 > UserFlagSetting get_user_flag_setting(project_key, environment_key, user_key, feature_flag_key, )
 
@@ -128,6 +188,67 @@ Name | Type | Description  | Notes
 
 
 
+# **patch_expiring_user_targets_for_flags**
+> UserTargetingExpirationOnFlagsForUser patch_expiring_user_targets_for_flags(project_key, environment_key, user_key, patch_comment)
+
+Update, add, or delete expiring user targets for a single user on all flags
+
+### 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.
+
+patch_comment = LaunchDarklyApi::PatchComment.new # PatchComment | Requires a JSON Patch representation of the desired changes to the project, and an optional comment. '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
+  #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, patch_comment)
+  p result
+rescue LaunchDarklyApi::ApiError => e
+  puts "Exception when calling UserSettingsApi->patch_expiring_user_targets_for_flags: #{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. | 
+ **patch_comment** | [**PatchComment**](PatchComment.md)| Requires a JSON Patch representation of the desired changes to the project, and an optional comment. '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. | 
+
+### Return type
+
+[**UserTargetingExpirationOnFlagsForUser**](UserTargetingExpirationOnFlagsForUser.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)
 

data/docs/UserTargetingExpirationForFlag.md

@@ -0,0 +1,14 @@
+# LaunchDarklyApi::UserTargetingExpirationForFlag
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**expiration_date** | **Integer** | Date scheduled for expiration | [optional] 
+**variation_id** | **String** | the ID of the variation that the user is targeted on a flag | [optional] 
+**user_key** | **String** | Unique identifier for the user | [optional] 
+**_id** | **String** |  | [optional] 
+**_resource_id** | [**UserTargetingExpirationResourceIdForFlag**](UserTargetingExpirationResourceIdForFlag.md) |  | [optional] 
+**_links** | [**Links**](Links.md) |  | [optional] 
+**_version** | **Integer** |  | [optional] 
+
+

data/docs/UserTargetingExpirationForFlags.md

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

data/docs/UserTargetingExpirationOnFlagsForUser.md

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

data/docs/UserTargetingExpirationResourceIdForFlag.md

@@ -0,0 +1,12 @@
+# LaunchDarklyApi::UserTargetingExpirationResourceIdForFlag
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**kind** | **String** |  | [optional] 
+**project_key** | **String** |  | [optional] 
+**environment_key** | **String** |  | [optional] 
+**flag_key** | **String** |  | [optional] 
+**key** | **String** |  | [optional] 
+
+

data/launchdarkly_api.gemspec

@@ -5,7 +5,7 @@
 
 #Build custom integrations with the LaunchDarkly REST API
 
-OpenAPI spec version: 3.0.0
+OpenAPI spec version: 3.1.0
 Contact: support@launchdarkly.com
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 2.4.8

data/lib/launchdarkly_api.rb

@@ -3,7 +3,7 @@
 
 #Build custom integrations with the LaunchDarkly REST API
 
-OpenAPI spec version: 3.0.0
+OpenAPI spec version: 3.1.0
 Contact: support@launchdarkly.com
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 2.4.8
@@ -97,6 +97,10 @@ require 'launchdarkly_api/models/user_segment_body'
 require 'launchdarkly_api/models/user_segment_rule'
 require 'launchdarkly_api/models/user_segments'
 require 'launchdarkly_api/models/user_settings_body'
+require 'launchdarkly_api/models/user_targeting_expiration_for_flag'
+require 'launchdarkly_api/models/user_targeting_expiration_for_flags'
+require 'launchdarkly_api/models/user_targeting_expiration_on_flags_for_user'
+require 'launchdarkly_api/models/user_targeting_expiration_resource_id_for_flag'
 require 'launchdarkly_api/models/users'
 require 'launchdarkly_api/models/variation'
 require 'launchdarkly_api/models/webhook'

data/lib/launchdarkly_api/api/audit_log_api.rb

@@ -3,7 +3,7 @@
 
 #Build custom integrations with the LaunchDarkly REST API
 
-OpenAPI spec version: 3.0.0
+OpenAPI spec version: 3.1.0
 Contact: support@launchdarkly.com
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 2.4.8

data/lib/launchdarkly_api/api/custom_roles_api.rb

@@ -3,7 +3,7 @@
 
 #Build custom integrations with the LaunchDarkly REST API
 
-OpenAPI spec version: 3.0.0
+OpenAPI spec version: 3.1.0
 Contact: support@launchdarkly.com
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 2.4.8

data/lib/launchdarkly_api/api/customer_metrics_api.rb

@@ -3,7 +3,7 @@
 
 #Build custom integrations with the LaunchDarkly REST API
 
-OpenAPI spec version: 3.0.0
+OpenAPI spec version: 3.1.0
 Contact: support@launchdarkly.com
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 2.4.8

data/lib/launchdarkly_api/api/data_export_destinations_api.rb

@@ -3,7 +3,7 @@
 
 #Build custom integrations with the LaunchDarkly REST API
 
-OpenAPI spec version: 3.0.0
+OpenAPI spec version: 3.1.0
 Contact: support@launchdarkly.com
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 2.4.8

data/lib/launchdarkly_api/api/environments_api.rb

@@ -3,7 +3,7 @@
 
 #Build custom integrations with the LaunchDarkly REST API
 
-OpenAPI spec version: 3.0.0
+OpenAPI spec version: 3.1.0
 Contact: support@launchdarkly.com
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 2.4.8

data/lib/launchdarkly_api/api/feature_flags_api.rb

@@ -3,7 +3,7 @@
 
 #Build custom integrations with the LaunchDarkly REST API
 
-OpenAPI spec version: 3.0.0
+OpenAPI spec version: 3.1.0
 Contact: support@launchdarkly.com
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 2.4.8
@@ -140,6 +140,70 @@ module LaunchDarklyApi
       end
       return data, status_code, headers
     end
+    # Get expiring user targets for feature flag
+    # @param project_key The project key, used to tie the flags together under one project so they can be managed together.
+    # @param environment_key The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
+    # @param feature_flag_key The feature flag's key. The key identifies the flag in your code.
+    # @param [Hash] opts the optional parameters
+    # @return [UserTargetingExpirationForFlags]
+    def get_expiring_user_targets(project_key, environment_key, feature_flag_key, opts = {})
+      data, _status_code, _headers = get_expiring_user_targets_with_http_info(project_key, environment_key, feature_flag_key, opts)
+      data
+    end
+
+    # Get expiring user targets for feature flag
+    # @param project_key The project key, used to tie the flags together under one project so they can be managed together.
+    # @param environment_key The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
+    # @param feature_flag_key The feature flag's key. The key identifies the flag in your code.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(UserTargetingExpirationForFlags, Fixnum, Hash)>] UserTargetingExpirationForFlags data, response status code and response headers
+    def get_expiring_user_targets_with_http_info(project_key, environment_key, feature_flag_key, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: FeatureFlagsApi.get_expiring_user_targets ...'
+      end
+      # verify the required parameter 'project_key' is set
+      if @api_client.config.client_side_validation && project_key.nil?
+        fail ArgumentError, "Missing the required parameter 'project_key' when calling FeatureFlagsApi.get_expiring_user_targets"
+      end
+      # verify the required parameter 'environment_key' is set
+      if @api_client.config.client_side_validation && environment_key.nil?
+        fail ArgumentError, "Missing the required parameter 'environment_key' when calling FeatureFlagsApi.get_expiring_user_targets"
+      end
+      # verify the required parameter 'feature_flag_key' is set
+      if @api_client.config.client_side_validation && feature_flag_key.nil?
+        fail ArgumentError, "Missing the required parameter 'feature_flag_key' when calling FeatureFlagsApi.get_expiring_user_targets"
+      end
+      # resource path
+      local_var_path = '/flags/{projectKey}/{featureFlagKey}/expiring-user-targets/{environmentKey}'.sub('{' + 'projectKey' + '}', project_key.to_s).sub('{' + 'environmentKey' + '}', environment_key.to_s).sub('{' + 'featureFlagKey' + '}', feature_flag_key.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['Token']
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'UserTargetingExpirationForFlags')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: FeatureFlagsApi#get_expiring_user_targets\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
     # Get a single feature flag by key.
     # @param project_key The project key, used to tie the flags together under one project so they can be managed together.
     # @param feature_flag_key The feature flag&#39;s key. The key identifies the flag in your code.
@@ -457,6 +521,76 @@ module LaunchDarklyApi
       end
       return data, status_code, headers
     end
+    # Update, add, or delete expiring user targets on feature flag
+    # @param project_key The project key, used to tie the flags together under one project so they can be managed together.
+    # @param environment_key The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
+    # @param feature_flag_key The feature flag&#39;s key. The key identifies the flag in your code.
+    # @param patch_comment Requires a JSON Patch representation of the desired changes to the project, and an optional comment. &#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.
+    # @param [Hash] opts the optional parameters
+    # @return [UserTargetingExpirationForFlags]
+    def patch_expiring_user_targets(project_key, environment_key, feature_flag_key, patch_comment, opts = {})
+      data, _status_code, _headers = patch_expiring_user_targets_with_http_info(project_key, environment_key, feature_flag_key, patch_comment, opts)
+      data
+    end
+
+    # Update, add, or delete expiring user targets on feature flag
+    # @param project_key The project key, used to tie the flags together under one project so they can be managed together.
+    # @param environment_key The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
+    # @param feature_flag_key The feature flag&#39;s key. The key identifies the flag in your code.
+    # @param patch_comment Requires a JSON Patch representation of the desired changes to the project, and an optional comment. &#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.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(UserTargetingExpirationForFlags, Fixnum, Hash)>] UserTargetingExpirationForFlags data, response status code and response headers
+    def patch_expiring_user_targets_with_http_info(project_key, environment_key, feature_flag_key, patch_comment, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: FeatureFlagsApi.patch_expiring_user_targets ...'
+      end
+      # verify the required parameter 'project_key' is set
+      if @api_client.config.client_side_validation && project_key.nil?
+        fail ArgumentError, "Missing the required parameter 'project_key' when calling FeatureFlagsApi.patch_expiring_user_targets"
+      end
+      # verify the required parameter 'environment_key' is set
+      if @api_client.config.client_side_validation && environment_key.nil?
+        fail ArgumentError, "Missing the required parameter 'environment_key' when calling FeatureFlagsApi.patch_expiring_user_targets"
+      end
+      # verify the required parameter 'feature_flag_key' is set
+      if @api_client.config.client_side_validation && feature_flag_key.nil?
+        fail ArgumentError, "Missing the required parameter 'feature_flag_key' when calling FeatureFlagsApi.patch_expiring_user_targets"
+      end
+      # verify the required parameter 'patch_comment' is set
+      if @api_client.config.client_side_validation && patch_comment.nil?
+        fail ArgumentError, "Missing the required parameter 'patch_comment' when calling FeatureFlagsApi.patch_expiring_user_targets"
+      end
+      # resource path
+      local_var_path = '/flags/{projectKey}/{featureFlagKey}/expiring-user-targets/{environmentKey}'.sub('{' + 'projectKey' + '}', project_key.to_s).sub('{' + 'environmentKey' + '}', environment_key.to_s).sub('{' + 'featureFlagKey' + '}', feature_flag_key.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = @api_client.object_to_http_body(patch_comment)
+      auth_names = ['Token']
+      data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'UserTargetingExpirationForFlags')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: FeatureFlagsApi#patch_expiring_user_targets\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
     # Perform a partial update to a feature.
     # @param project_key The project key, used to tie the flags together under one project so they can be managed together.
     # @param feature_flag_key The feature flag&#39;s key. The key identifies the flag in your code.

data/lib/launchdarkly_api/api/projects_api.rb

@@ -3,7 +3,7 @@
 
 #Build custom integrations with the LaunchDarkly REST API
 
-OpenAPI spec version: 3.0.0
+OpenAPI spec version: 3.1.0
 Contact: support@launchdarkly.com
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 2.4.8

data/lib/launchdarkly_api/api/root_api.rb

@@ -3,7 +3,7 @@
 
 #Build custom integrations with the LaunchDarkly REST API
 
-OpenAPI spec version: 3.0.0
+OpenAPI spec version: 3.1.0
 Contact: support@launchdarkly.com
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 2.4.8