launchdarkly_api 3.3.2 → 3.4.0

data/docs/FeatureFlagsApi.md

@@ -438,7 +438,7 @@ project_key = 'project_key_example' # String | The project key, used to tie the
 opts = { 
   env: ['env_example'] # Array<String> | By default, each feature will include configurations for each environment. You can filter environments with the env query parameter. For example, setting env=[\"production\"] will restrict the returned configurations to just your production environment.
   summary: true, # BOOLEAN | By default in api version >= 1, flags will _not_ include their list of prerequisites, targets or rules.  Set summary=0 to include these fields for each flag returned.
-  archived: true, # BOOLEAN | When set to 1, archived flags will be included in the list of flags returned.  By default, archived flags are not included in the list of flags.
+  archived: true, # BOOLEAN | When set to 1, only archived flags will be included in the list of flags returned.  By default, archived flags are not included in the list of flags.
   limit: 8.14, # Float | The number of objects to return. Defaults to -1, which returns everything.
   offset: 8.14, # Float | Where to start in the list. This is for use with pagination. For example, an offset of 10 would skip the first 10 items and then return the next limit items.
   filter: 'filter_example', # String | A comma-separated list of filters. Each filter is of the form field:value.
@@ -462,7 +462,7 @@ 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. | 
  **env** | [**Array&lt;String&gt;**](String.md)| By default, each feature will include configurations for each environment. You can filter environments with the env query parameter. For example, setting env&#x3D;[\&quot;production\&quot;] will restrict the returned configurations to just your production environment. | [optional] 
  **summary** | **BOOLEAN**| By default in api version &gt;&#x3D; 1, flags will _not_ include their list of prerequisites, targets or rules.  Set summary&#x3D;0 to include these fields for each flag returned. | [optional] 
- **archived** | **BOOLEAN**| When set to 1, archived flags will be included in the list of flags returned.  By default, archived flags are not included in the list of flags. | [optional] 
+ **archived** | **BOOLEAN**| When set to 1, only archived flags will be included in the list of flags returned.  By default, archived flags are not included in the list of flags. | [optional] 
  **limit** | **Float**| The number of objects to return. Defaults to -1, which returns everything. | [optional] 
  **offset** | **Float**| Where to start in the list. This is for use with pagination. For example, an offset of 10 would skip the first 10 items and then return the next limit items. | [optional] 
  **filter** | **String**| A comma-separated list of filters. Each filter is of the form field:value. | [optional] 

data/docs/Token.md

@@ -0,0 +1,22 @@
+# LaunchDarklyApi::Token
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**_links** | [**Links**](Links.md) |  | [optional] 
+**_id** | [**Id**](Id.md) |  | [optional] 
+**owner_id** | [**Id**](Id.md) |  | [optional] 
+**member_id** | [**Id**](Id.md) |  | [optional] 
+**_member** | [**Member**](Member.md) |  | [optional] 
+**creation_date** | **Integer** | A unix epoch time in milliseconds specifying the creation time of this access token. | [optional] 
+**last_modified** | **Integer** | A unix epoch time in milliseconds specifying the last time this access token was modified. | [optional] 
+**last_used** | **Integer** | A unix epoch time in milliseconds specifying the last time this access token was used to authorize access to the LaunchDarkly REST API. | [optional] 
+**token** | **String** | The last 4 digits of the unique secret key for this access token. If creating or resetting the token, this will be the full token secret. | [optional] 
+**name** | **String** | A human-friendly name for the access token | [optional] 
+**role** | **String** | The name of a built-in role for the token | [optional] 
+**custom_role_ids** | **Array<String>** | A list of custom role IDs to use as access limits for the access token | [optional] 
+**inline_role** | [**Array<Statement>**](Statement.md) |  | [optional] 
+**service_token** | **BOOLEAN** | Whether the token will be a service token https://docs.launchdarkly.com/home/account-security/api-access-tokens#service-tokens | [optional] 
+**default_api_version** | **Integer** | The default API version for this token | [optional] 
+
+

data/docs/TokenBody.md

@@ -0,0 +1,13 @@
+# LaunchDarklyApi::TokenBody
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | A human-friendly name for the access token | [optional] 
+**role** | **String** | The name of a built-in role for the token | [optional] 
+**custom_role_ids** | **Array<String>** | A list of custom role IDs to use as access limits for the access token | [optional] 
+**inline_role** | [**Array<Statement>**](Statement.md) |  | [optional] 
+**service_token** | **BOOLEAN** | Whether the token will be a service token https://docs.launchdarkly.com/home/account-security/api-access-tokens#service-tokens | [optional] 
+**default_api_version** | **Integer** | The default API version for this token | [optional] 
+
+

data/docs/Tokens.md

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

data/launchdarkly_api.gemspec

@@ -5,7 +5,7 @@
 
 #Build custom integrations with the LaunchDarkly REST API
 
-OpenAPI spec version: 3.3.2
+OpenAPI spec version: 3.4.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.3.2
+OpenAPI spec version: 3.4.0
 Contact: support@launchdarkly.com
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 2.4.8
@@ -87,6 +87,9 @@ require 'launchdarkly_api/models/stream_usage_metadata'
 require 'launchdarkly_api/models/stream_usage_series'
 require 'launchdarkly_api/models/streams'
 require 'launchdarkly_api/models/target'
+require 'launchdarkly_api/models/token'
+require 'launchdarkly_api/models/token_body'
+require 'launchdarkly_api/models/tokens'
 require 'launchdarkly_api/models/usage'
 require 'launchdarkly_api/models/usage_error'
 require 'launchdarkly_api/models/usage_links'
@@ -112,6 +115,7 @@ require 'launchdarkly_api/models/webhooks'
 require 'launchdarkly_api/models/weighted_variation'
 
 # APIs
+require 'launchdarkly_api/api/access_tokens_api'
 require 'launchdarkly_api/api/audit_log_api'
 require 'launchdarkly_api/api/custom_roles_api'
 require 'launchdarkly_api/api/customer_metrics_api'

data/lib/launchdarkly_api/api/access_tokens_api.rb

@@ -0,0 +1,340 @@
+=begin
+#LaunchDarkly REST API
+
+#Build custom integrations with the LaunchDarkly REST API
+
+OpenAPI spec version: 3.4.0
+Contact: support@launchdarkly.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.8
+
+=end
+
+require 'uri'
+
+module LaunchDarklyApi
+  class AccessTokensApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Delete an access token by ID.
+    # @param token_id The access token ID.
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def delete_token(token_id, opts = {})
+      delete_token_with_http_info(token_id, opts)
+      nil
+    end
+
+    # Delete an access token by ID.
+    # @param token_id The access token ID.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
+    def delete_token_with_http_info(token_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AccessTokensApi.delete_token ...'
+      end
+      # verify the required parameter 'token_id' is set
+      if @api_client.config.client_side_validation && token_id.nil?
+        fail ArgumentError, "Missing the required parameter 'token_id' when calling AccessTokensApi.delete_token"
+      end
+      # resource path
+      local_var_path = '/tokens/{tokenId}'.sub('{' + 'tokenId' + '}', token_id.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(:DELETE, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AccessTokensApi#delete_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # Get a single access token by ID.
+    # @param token_id The access token ID.
+    # @param [Hash] opts the optional parameters
+    # @return [Token]
+    def get_token(token_id, opts = {})
+      data, _status_code, _headers = get_token_with_http_info(token_id, opts)
+      data
+    end
+
+    # Get a single access token by ID.
+    # @param token_id The access token ID.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Token, Fixnum, Hash)>] Token data, response status code and response headers
+    def get_token_with_http_info(token_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AccessTokensApi.get_token ...'
+      end
+      # verify the required parameter 'token_id' is set
+      if @api_client.config.client_side_validation && token_id.nil?
+        fail ArgumentError, "Missing the required parameter 'token_id' when calling AccessTokensApi.get_token"
+      end
+      # resource path
+      local_var_path = '/tokens/{tokenId}'.sub('{' + 'tokenId' + '}', token_id.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 => 'Token')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AccessTokensApi#get_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # Returns a list of tokens in the account.
+    # @param [Hash] opts the optional parameters
+    # @option opts [BOOLEAN] :show_all If set to true, and the authentication access token has the \&quot;Admin\&quot; role, personal access tokens for all members will be retrieved.
+    # @return [Tokens]
+    def get_tokens(opts = {})
+      data, _status_code, _headers = get_tokens_with_http_info(opts)
+      data
+    end
+
+    # Returns a list of tokens in the account.
+    # @param [Hash] opts the optional parameters
+    # @option opts [BOOLEAN] :show_all If set to true, and the authentication access token has the \&quot;Admin\&quot; role, personal access tokens for all members will be retrieved.
+    # @return [Array<(Tokens, Fixnum, Hash)>] Tokens data, response status code and response headers
+    def get_tokens_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AccessTokensApi.get_tokens ...'
+      end
+      # resource path
+      local_var_path = '/tokens'
+
+      # query parameters
+      query_params = {}
+      query_params[:'showAll'] = opts[:'show_all'] if !opts[:'show_all'].nil?
+
+      # 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 => 'Tokens')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AccessTokensApi#get_tokens\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # Modify an access tokenby ID.
+    # @param token_id The access token ID.
+    # @param patch_delta Requires a JSON Patch representation of the desired changes to the project. &#39;http://jsonpatch.com/&#39;
+    # @param [Hash] opts the optional parameters
+    # @return [Token]
+    def patch_token(token_id, patch_delta, opts = {})
+      data, _status_code, _headers = patch_token_with_http_info(token_id, patch_delta, opts)
+      data
+    end
+
+    # Modify an access tokenby ID.
+    # @param token_id The access token ID.
+    # @param patch_delta Requires a JSON Patch representation of the desired changes to the project. &#39;http://jsonpatch.com/&#39;
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Token, Fixnum, Hash)>] Token data, response status code and response headers
+    def patch_token_with_http_info(token_id, patch_delta, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AccessTokensApi.patch_token ...'
+      end
+      # verify the required parameter 'token_id' is set
+      if @api_client.config.client_side_validation && token_id.nil?
+        fail ArgumentError, "Missing the required parameter 'token_id' when calling AccessTokensApi.patch_token"
+      end
+      # verify the required parameter 'patch_delta' is set
+      if @api_client.config.client_side_validation && patch_delta.nil?
+        fail ArgumentError, "Missing the required parameter 'patch_delta' when calling AccessTokensApi.patch_token"
+      end
+      # resource path
+      local_var_path = '/tokens/{tokenId}'.sub('{' + 'tokenId' + '}', token_id.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_delta)
+      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 => 'Token')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AccessTokensApi#patch_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # Create a new token.
+    # @param token_body Create a new access token.
+    # @param [Hash] opts the optional parameters
+    # @return [Token]
+    def post_token(token_body, opts = {})
+      data, _status_code, _headers = post_token_with_http_info(token_body, opts)
+      data
+    end
+
+    # Create a new token.
+    # @param token_body Create a new access token.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Token, Fixnum, Hash)>] Token data, response status code and response headers
+    def post_token_with_http_info(token_body, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AccessTokensApi.post_token ...'
+      end
+      # verify the required parameter 'token_body' is set
+      if @api_client.config.client_side_validation && token_body.nil?
+        fail ArgumentError, "Missing the required parameter 'token_body' when calling AccessTokensApi.post_token"
+      end
+      # resource path
+      local_var_path = '/tokens'
+
+      # 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(token_body)
+      auth_names = ['Token']
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'Token')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AccessTokensApi#post_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # Reset an access token's secret key with an optional expiry time for the old key.
+    # @param token_id The access token ID.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :expiry An expiration time for the old token key, expressed as a Unix epoch time in milliseconds. By default, the token will expire immediately.
+    # @return [Token]
+    def reset_token(token_id, opts = {})
+      data, _status_code, _headers = reset_token_with_http_info(token_id, opts)
+      data
+    end
+
+    # Reset an access token&#39;s secret key with an optional expiry time for the old key.
+    # @param token_id The access token ID.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :expiry An expiration time for the old token key, expressed as a Unix epoch time in milliseconds. By default, the token will expire immediately.
+    # @return [Array<(Token, Fixnum, Hash)>] Token data, response status code and response headers
+    def reset_token_with_http_info(token_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AccessTokensApi.reset_token ...'
+      end
+      # verify the required parameter 'token_id' is set
+      if @api_client.config.client_side_validation && token_id.nil?
+        fail ArgumentError, "Missing the required parameter 'token_id' when calling AccessTokensApi.reset_token"
+      end
+      # resource path
+      local_var_path = '/tokens/{tokenId}/reset'.sub('{' + 'tokenId' + '}', token_id.to_s)
+
+      # query parameters
+      query_params = {}
+      query_params[:'expiry'] = opts[:'expiry'] if !opts[:'expiry'].nil?
+
+      # 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(:POST, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'Token')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AccessTokensApi#reset_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

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.3.2
+OpenAPI spec version: 3.4.0
 Contact: support@launchdarkly.com
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 2.4.8