qsafe-sdk 1.0.4

data/lib/qsafe/api/api_keys_api.rb

@@ -0,0 +1,430 @@
+=begin
+#QSafe PQC API
+
+#Post-quantum cryptography SaaS API supporting ML-KEM (Kyber) and ML-DSA (Dilithium) algorithms. Provides keypair management and cryptographic operations (encrypt, decrypt, sign, verify).  ## Authentication - **JWT Bearer Token** — user-based auth, obtained from `/auth/login` or `/auth/register` - **API Key (header)** — programmatic access via `X-API-Key` header - **API Key (query)** — programmatic access via `?api_key=` query parameter  ## Quick Start 1. Register → `POST /auth/register` 2. Login → `POST /auth/login` → copy `data.token` 3. Generate keypair → `POST /generate-keypair` 4. Encrypt / Sign with the keypair ID 
+
+The version of the OpenAPI document: 1.0.0
+Contact: rushikesh.n.kakadiya@gmail.com
+Generated by: https://openapi-generator.tech
+Generator version: 7.9.0
+
+=end
+
+require 'cgi'
+
+module QSafe
+  class APIKeysApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Create API key (JWT only)
+    # @param create_api_key_request [CreateApiKeyRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [CreateApiKey201Response]
+    def create_api_key(create_api_key_request, opts = {})
+      data, _status_code, _headers = create_api_key_with_http_info(create_api_key_request, opts)
+      data
+    end
+
+    # Create API key (JWT only)
+    # @param create_api_key_request [CreateApiKeyRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(CreateApiKey201Response, Integer, Hash)>] CreateApiKey201Response data, response status code and response headers
+    def create_api_key_with_http_info(create_api_key_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: APIKeysApi.create_api_key ...'
+      end
+      # verify the required parameter 'create_api_key_request' is set
+      if @api_client.config.client_side_validation && create_api_key_request.nil?
+        fail ArgumentError, "Missing the required parameter 'create_api_key_request' when calling APIKeysApi.create_api_key"
+      end
+      # resource path
+      local_var_path = '/api-keys'
+
+      # 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']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(create_api_key_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'CreateApiKey201Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['BearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"APIKeysApi.create_api_key",
+        :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#create_api_key\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get API key details (JWT only)
+    # @param key_id [String] API key identifier
+    # @param [Hash] opts the optional parameters
+    # @return [GetApiKey200Response]
+    def get_api_key(key_id, opts = {})
+      data, _status_code, _headers = get_api_key_with_http_info(key_id, opts)
+      data
+    end
+
+    # Get API key details (JWT only)
+    # @param key_id [String] API key identifier
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(GetApiKey200Response, Integer, Hash)>] GetApiKey200Response data, response status code and response headers
+    def get_api_key_with_http_info(key_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: APIKeysApi.get_api_key ...'
+      end
+      # verify the required parameter 'key_id' is set
+      if @api_client.config.client_side_validation && key_id.nil?
+        fail ArgumentError, "Missing the required parameter 'key_id' when calling APIKeysApi.get_api_key"
+      end
+      # resource path
+      local_var_path = '/api-keys/{keyId}'.sub('{' + 'keyId' + '}', CGI.escape(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] || 'GetApiKey200Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['BearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"APIKeysApi.get_api_key",
+        :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#get_api_key\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get API key usage stats (JWT only)
+    # @param key_id [String] API key identifier
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :time_range  (default to '24h')
+    # @return [GetApiKeyUsage200Response]
+    def get_api_key_usage(key_id, opts = {})
+      data, _status_code, _headers = get_api_key_usage_with_http_info(key_id, opts)
+      data
+    end
+
+    # Get API key usage stats (JWT only)
+    # @param key_id [String] API key identifier
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :time_range  (default to '24h')
+    # @return [Array<(GetApiKeyUsage200Response, Integer, Hash)>] GetApiKeyUsage200Response data, response status code and response headers
+    def get_api_key_usage_with_http_info(key_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: APIKeysApi.get_api_key_usage ...'
+      end
+      # verify the required parameter 'key_id' is set
+      if @api_client.config.client_side_validation && key_id.nil?
+        fail ArgumentError, "Missing the required parameter 'key_id' when calling APIKeysApi.get_api_key_usage"
+      end
+      allowable_values = ["1h", "24h", "7d", "30d"]
+      if @api_client.config.client_side_validation && opts[:'time_range'] && !allowable_values.include?(opts[:'time_range'])
+        fail ArgumentError, "invalid value for \"time_range\", must be one of #{allowable_values}"
+      end
+      # resource path
+      local_var_path = '/api-keys/{keyId}/usage'.sub('{' + 'keyId' + '}', CGI.escape(key_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'timeRange'] = opts[:'time_range'] if !opts[:'time_range'].nil?
+
+      # 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] || 'GetApiKeyUsage200Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['BearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"APIKeysApi.get_api_key_usage",
+        :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#get_api_key_usage\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List API keys (JWT only)
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :page  (default to 1)
+    # @option opts [Integer] :limit  (default to 10)
+    # @option opts [String] :status 
+    # @return [ListApiKeys200Response]
+    def list_api_keys(opts = {})
+      data, _status_code, _headers = list_api_keys_with_http_info(opts)
+      data
+    end
+
+    # List API keys (JWT only)
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :page  (default to 1)
+    # @option opts [Integer] :limit  (default to 10)
+    # @option opts [String] :status 
+    # @return [Array<(ListApiKeys200Response, Integer, Hash)>] ListApiKeys200Response data, response status code and response headers
+    def list_api_keys_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: APIKeysApi.list_api_keys ...'
+      end
+      if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
+        fail ArgumentError, 'invalid value for "opts[:"page"]" when calling APIKeysApi.list_api_keys, must be greater than or equal to 1.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 100
+        fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling APIKeysApi.list_api_keys, must be smaller than or equal to 100.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
+        fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling APIKeysApi.list_api_keys, must be greater than or equal to 1.'
+      end
+
+      allowable_values = ["active", "revoked", "expired"]
+      if @api_client.config.client_side_validation && opts[:'status'] && !allowable_values.include?(opts[:'status'])
+        fail ArgumentError, "invalid value for \"status\", must be one of #{allowable_values}"
+      end
+      # resource path
+      local_var_path = '/api-keys'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
+      query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
+      query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil?
+
+      # 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] || 'ListApiKeys200Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['BearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"APIKeysApi.list_api_keys",
+        :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#list_api_keys\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Rotate API key — generates new key value (JWT only)
+    # @param key_id [String] API key identifier
+    # @param [Hash] opts the optional parameters
+    # @return [RotateApiKey200Response]
+    def rotate_api_key(key_id, opts = {})
+      data, _status_code, _headers = rotate_api_key_with_http_info(key_id, opts)
+      data
+    end
+
+    # Rotate API key — generates new key value (JWT only)
+    # @param key_id [String] API key identifier
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(RotateApiKey200Response, Integer, Hash)>] RotateApiKey200Response data, response status code and response headers
+    def rotate_api_key_with_http_info(key_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: APIKeysApi.rotate_api_key ...'
+      end
+      # verify the required parameter 'key_id' is set
+      if @api_client.config.client_side_validation && key_id.nil?
+        fail ArgumentError, "Missing the required parameter 'key_id' when calling APIKeysApi.rotate_api_key"
+      end
+      # resource path
+      local_var_path = '/api-keys/{keyId}/rotate'.sub('{' + 'keyId' + '}', CGI.escape(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] || 'RotateApiKey200Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['BearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"APIKeysApi.rotate_api_key",
+        :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#rotate_api_key\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Update API key (JWT only)
+    # @param key_id [String] API key identifier
+    # @param update_api_key_request [UpdateApiKeyRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [GetApiKey200Response]
+    def update_api_key(key_id, update_api_key_request, opts = {})
+      data, _status_code, _headers = update_api_key_with_http_info(key_id, update_api_key_request, opts)
+      data
+    end
+
+    # Update API key (JWT only)
+    # @param key_id [String] API key identifier
+    # @param update_api_key_request [UpdateApiKeyRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(GetApiKey200Response, Integer, Hash)>] GetApiKey200Response data, response status code and response headers
+    def update_api_key_with_http_info(key_id, update_api_key_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: APIKeysApi.update_api_key ...'
+      end
+      # verify the required parameter 'key_id' is set
+      if @api_client.config.client_side_validation && key_id.nil?
+        fail ArgumentError, "Missing the required parameter 'key_id' when calling APIKeysApi.update_api_key"
+      end
+      # verify the required parameter 'update_api_key_request' is set
+      if @api_client.config.client_side_validation && update_api_key_request.nil?
+        fail ArgumentError, "Missing the required parameter 'update_api_key_request' when calling APIKeysApi.update_api_key"
+      end
+      # resource path
+      local_var_path = '/api-keys/{keyId}'.sub('{' + 'keyId' + '}', CGI.escape(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']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(update_api_key_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'GetApiKey200Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['BearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"APIKeysApi.update_api_key",
+        :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#update_api_key\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end