spartera_api_sdk 1.0.58

data/lib/spartera_api_sdk/api/api_keys_api.rb

@@ -0,0 +1,345 @@
+=begin
+#Spartera API Documentation
+
+#Auto-generated API documentation for REST services of the Spartera platform
+
+The version of the OpenAPI document: 0.0.0
+Contact: support@spartera.com
+Generated by: https://openapi-generator.tech
+Generator version: 7.13.0
+
+=end
+
+require 'cgi'
+
+module SparteraApiSdk
+  class APIKeysApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Get single API key by ID
+    # @param company_id [String] 
+    # @param api_key_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Object]
+    def companies_company_id_api_keys_api_key_id_get(company_id, api_key_id, opts = {})
+      data, _status_code, _headers = companies_company_id_api_keys_api_key_id_get_with_http_info(company_id, api_key_id, opts)
+      data
+    end
+
+    # Get single API key by ID
+    # @param company_id [String] 
+    # @param api_key_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
+    def companies_company_id_api_keys_api_key_id_get_with_http_info(company_id, api_key_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: APIKeysApi.companies_company_id_api_keys_api_key_id_get ...'
+      end
+      # verify the required parameter 'company_id' is set
+      if @api_client.config.client_side_validation && company_id.nil?
+        fail ArgumentError, "Missing the required parameter 'company_id' when calling APIKeysApi.companies_company_id_api_keys_api_key_id_get"
+      end
+      # verify the required parameter 'api_key_id' is set
+      if @api_client.config.client_side_validation && api_key_id.nil?
+        fail ArgumentError, "Missing the required parameter 'api_key_id' when calling APIKeysApi.companies_company_id_api_keys_api_key_id_get"
+      end
+      # resource path
+      local_var_path = '/companies/{company_id}/api-keys/{api_key_id}'.sub('{' + 'company_id' + '}', CGI.escape(company_id.to_s)).sub('{' + 'api_key_id' + '}', CGI.escape(api_key_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Object'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"APIKeysApi.companies_company_id_api_keys_api_key_id_get",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: APIKeysApi#companies_company_id_api_keys_api_key_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Update an existing API key by ID
+    # @param company_id [String] 
+    # @param api_key_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Object]
+    def companies_company_id_api_keys_api_key_id_patch(company_id, api_key_id, opts = {})
+      data, _status_code, _headers = companies_company_id_api_keys_api_key_id_patch_with_http_info(company_id, api_key_id, opts)
+      data
+    end
+
+    # Update an existing API key by ID
+    # @param company_id [String] 
+    # @param api_key_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
+    def companies_company_id_api_keys_api_key_id_patch_with_http_info(company_id, api_key_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: APIKeysApi.companies_company_id_api_keys_api_key_id_patch ...'
+      end
+      # verify the required parameter 'company_id' is set
+      if @api_client.config.client_side_validation && company_id.nil?
+        fail ArgumentError, "Missing the required parameter 'company_id' when calling APIKeysApi.companies_company_id_api_keys_api_key_id_patch"
+      end
+      # verify the required parameter 'api_key_id' is set
+      if @api_client.config.client_side_validation && api_key_id.nil?
+        fail ArgumentError, "Missing the required parameter 'api_key_id' when calling APIKeysApi.companies_company_id_api_keys_api_key_id_patch"
+      end
+      # resource path
+      local_var_path = '/companies/{company_id}/api-keys/{api_key_id}'.sub('{' + 'company_id' + '}', CGI.escape(company_id.to_s)).sub('{' + 'api_key_id' + '}', CGI.escape(api_key_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Object'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"APIKeysApi.companies_company_id_api_keys_api_key_id_patch",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: APIKeysApi#companies_company_id_api_keys_api_key_id_patch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get all API keys
+    # @param company_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Object]
+    def companies_company_id_api_keys_get(company_id, opts = {})
+      data, _status_code, _headers = companies_company_id_api_keys_get_with_http_info(company_id, opts)
+      data
+    end
+
+    # Get all API keys
+    # @param company_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
+    def companies_company_id_api_keys_get_with_http_info(company_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: APIKeysApi.companies_company_id_api_keys_get ...'
+      end
+      # verify the required parameter 'company_id' is set
+      if @api_client.config.client_side_validation && company_id.nil?
+        fail ArgumentError, "Missing the required parameter 'company_id' when calling APIKeysApi.companies_company_id_api_keys_get"
+      end
+      # resource path
+      local_var_path = '/companies/{company_id}/api-keys'.sub('{' + 'company_id' + '}', CGI.escape(company_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Object'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"APIKeysApi.companies_company_id_api_keys_get",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: APIKeysApi#companies_company_id_api_keys_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Create single API key
+    # @param company_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Object]
+    def companies_company_id_api_keys_post(company_id, opts = {})
+      data, _status_code, _headers = companies_company_id_api_keys_post_with_http_info(company_id, opts)
+      data
+    end
+
+    # Create single API key
+    # @param company_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
+    def companies_company_id_api_keys_post_with_http_info(company_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: APIKeysApi.companies_company_id_api_keys_post ...'
+      end
+      # verify the required parameter 'company_id' is set
+      if @api_client.config.client_side_validation && company_id.nil?
+        fail ArgumentError, "Missing the required parameter 'company_id' when calling APIKeysApi.companies_company_id_api_keys_post"
+      end
+      # resource path
+      local_var_path = '/companies/{company_id}/api-keys'.sub('{' + 'company_id' + '}', CGI.escape(company_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Object'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"APIKeysApi.companies_company_id_api_keys_post",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: APIKeysApi#companies_company_id_api_keys_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Delete single API key by token
+    # @param company_id [String] 
+    # @param token [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Object]
+    def companies_company_id_api_keys_token_delete(company_id, token, opts = {})
+      data, _status_code, _headers = companies_company_id_api_keys_token_delete_with_http_info(company_id, token, opts)
+      data
+    end
+
+    # Delete single API key by token
+    # @param company_id [String] 
+    # @param token [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
+    def companies_company_id_api_keys_token_delete_with_http_info(company_id, token, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: APIKeysApi.companies_company_id_api_keys_token_delete ...'
+      end
+      # verify the required parameter 'company_id' is set
+      if @api_client.config.client_side_validation && company_id.nil?
+        fail ArgumentError, "Missing the required parameter 'company_id' when calling APIKeysApi.companies_company_id_api_keys_token_delete"
+      end
+      # verify the required parameter 'token' is set
+      if @api_client.config.client_side_validation && token.nil?
+        fail ArgumentError, "Missing the required parameter 'token' when calling APIKeysApi.companies_company_id_api_keys_token_delete"
+      end
+      # resource path
+      local_var_path = '/companies/{company_id}/api-keys/{token}'.sub('{' + 'company_id' + '}', CGI.escape(company_id.to_s)).sub('{' + 'token' + '}', CGI.escape(token.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Object'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"APIKeysApi.companies_company_id_api_keys_token_delete",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: APIKeysApi#companies_company_id_api_keys_token_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end