zyphr 0.1.0

data/lib/zyphr/api/auth_web_authn_api.rb

@@ -0,0 +1,537 @@
+=begin
+#Zyphr API
+
+#Zyphr is a multi-channel notification platform that enables developers to send emails, push notifications, SMS, and in-app messages through a unified API.  ## Authentication  All API requests require authentication using an API key. Include your API key in the `X-API-Key` header:  ``` X-API-Key: zy_live_xxxxxxxxxxxx ```  API keys can be created in the Zyphr Dashboard. Use `zy_test_*` keys for testing and `zy_live_*` keys for production.  ## Rate Limiting  The API implements rate limiting to ensure fair usage. Rate limit information is included in response headers:  - `X-RateLimit-Limit`: Maximum requests per window - `X-RateLimit-Remaining`: Remaining requests in current window - `X-RateLimit-Reset`: Unix timestamp when the window resets  ## Errors  All errors follow a consistent format:  ```json {   \"error\": {     \"code\": \"error_code\",     \"message\": \"Human readable message\",     \"details\": {}   },   \"meta\": {     \"request_id\": \"req_xxxx\"   } } ```
+
+The version of the OpenAPI document: 1.0.0
+Contact: support@zyphr.dev
+Generated by: https://openapi-generator.tech
+Generator version: 7.12.0
+
+=end
+
+require 'cgi'
+
+module Zyphr
+  class AuthWebAuthnApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Delete a WebAuthn credential
+    # Delete a WebAuthn credential by ID.
+    # @param id [String] Credential ID
+    # @param [Hash] opts the optional parameters
+    # @return [SuccessResult]
+    def delete_web_authn_credential(id, opts = {})
+      data, _status_code, _headers = delete_web_authn_credential_with_http_info(id, opts)
+      data
+    end
+
+    # Delete a WebAuthn credential
+    # Delete a WebAuthn credential by ID.
+    # @param id [String] Credential ID
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(SuccessResult, Integer, Hash)>] SuccessResult data, response status code and response headers
+    def delete_web_authn_credential_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AuthWebAuthnApi.delete_web_authn_credential ...'
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling AuthWebAuthnApi.delete_web_authn_credential"
+      end
+      # resource path
+      local_var_path = '/auth/webauthn/credentials/{id}'.sub('{' + 'id' + '}', CGI.escape(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] || 'SuccessResult'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['EndUserToken', 'ApplicationPublicKey']
+
+      new_options = opts.merge(
+        :operation => :"AuthWebAuthnApi.delete_web_authn_credential",
+        :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: AuthWebAuthnApi#delete_web_authn_credential\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get WebAuthn status
+    # Check if WebAuthn is enabled for the authenticated user and get the credential count.
+    # @param [Hash] opts the optional parameters
+    # @return [WebAuthnStatusResponse]
+    def get_web_authn_status(opts = {})
+      data, _status_code, _headers = get_web_authn_status_with_http_info(opts)
+      data
+    end
+
+    # Get WebAuthn status
+    # Check if WebAuthn is enabled for the authenticated user and get the credential count.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(WebAuthnStatusResponse, Integer, Hash)>] WebAuthnStatusResponse data, response status code and response headers
+    def get_web_authn_status_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AuthWebAuthnApi.get_web_authn_status ...'
+      end
+      # resource path
+      local_var_path = '/auth/webauthn/status'
+
+      # 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] || 'WebAuthnStatusResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['EndUserToken', 'ApplicationPublicKey']
+
+      new_options = opts.merge(
+        :operation => :"AuthWebAuthnApi.get_web_authn_status",
+        :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: AuthWebAuthnApi#get_web_authn_status\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List WebAuthn credentials
+    # List all WebAuthn credentials for the authenticated user.
+    # @param [Hash] opts the optional parameters
+    # @return [WebAuthnCredentialListResponse]
+    def list_web_authn_credentials(opts = {})
+      data, _status_code, _headers = list_web_authn_credentials_with_http_info(opts)
+      data
+    end
+
+    # List WebAuthn credentials
+    # List all WebAuthn credentials for the authenticated user.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(WebAuthnCredentialListResponse, Integer, Hash)>] WebAuthnCredentialListResponse data, response status code and response headers
+    def list_web_authn_credentials_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AuthWebAuthnApi.list_web_authn_credentials ...'
+      end
+      # resource path
+      local_var_path = '/auth/webauthn/credentials'
+
+      # 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] || 'WebAuthnCredentialListResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['EndUserToken', 'ApplicationPublicKey']
+
+      new_options = opts.merge(
+        :operation => :"AuthWebAuthnApi.list_web_authn_credentials",
+        :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: AuthWebAuthnApi#list_web_authn_credentials\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Rename a WebAuthn credential
+    # Rename a WebAuthn credential by ID.
+    # @param id [String] Credential ID
+    # @param rename_web_authn_credential_request [RenameWebAuthnCredentialRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [WebAuthnCredentialResponse]
+    def rename_web_authn_credential(id, rename_web_authn_credential_request, opts = {})
+      data, _status_code, _headers = rename_web_authn_credential_with_http_info(id, rename_web_authn_credential_request, opts)
+      data
+    end
+
+    # Rename a WebAuthn credential
+    # Rename a WebAuthn credential by ID.
+    # @param id [String] Credential ID
+    # @param rename_web_authn_credential_request [RenameWebAuthnCredentialRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(WebAuthnCredentialResponse, Integer, Hash)>] WebAuthnCredentialResponse data, response status code and response headers
+    def rename_web_authn_credential_with_http_info(id, rename_web_authn_credential_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AuthWebAuthnApi.rename_web_authn_credential ...'
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling AuthWebAuthnApi.rename_web_authn_credential"
+      end
+      # verify the required parameter 'rename_web_authn_credential_request' is set
+      if @api_client.config.client_side_validation && rename_web_authn_credential_request.nil?
+        fail ArgumentError, "Missing the required parameter 'rename_web_authn_credential_request' when calling AuthWebAuthnApi.rename_web_authn_credential"
+      end
+      # resource path
+      local_var_path = '/auth/webauthn/credentials/{id}'.sub('{' + 'id' + '}', CGI.escape(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(rename_web_authn_credential_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'WebAuthnCredentialResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['EndUserToken', 'ApplicationPublicKey']
+
+      new_options = opts.merge(
+        :operation => :"AuthWebAuthnApi.rename_web_authn_credential",
+        :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: AuthWebAuthnApi#rename_web_authn_credential\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Start WebAuthn authentication
+    # Start the WebAuthn authentication flow. Returns options to pass to navigator.credentials.get().
+    # @param [Hash] opts the optional parameters
+    # @option opts [WebAuthnStartAuthRequest] :web_authn_start_auth_request 
+    # @return [WebAuthnStartAuthResponse]
+    def start_web_authn_authentication(opts = {})
+      data, _status_code, _headers = start_web_authn_authentication_with_http_info(opts)
+      data
+    end
+
+    # Start WebAuthn authentication
+    # Start the WebAuthn authentication flow. Returns options to pass to navigator.credentials.get().
+    # @param [Hash] opts the optional parameters
+    # @option opts [WebAuthnStartAuthRequest] :web_authn_start_auth_request 
+    # @return [Array<(WebAuthnStartAuthResponse, Integer, Hash)>] WebAuthnStartAuthResponse data, response status code and response headers
+    def start_web_authn_authentication_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AuthWebAuthnApi.start_web_authn_authentication ...'
+      end
+      # resource path
+      local_var_path = '/auth/webauthn/authentication/start'
+
+      # 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(opts[:'web_authn_start_auth_request'])
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'WebAuthnStartAuthResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApplicationSecret', 'ApplicationPublicKey']
+
+      new_options = opts.merge(
+        :operation => :"AuthWebAuthnApi.start_web_authn_authentication",
+        :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: AuthWebAuthnApi#start_web_authn_authentication\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Start WebAuthn registration
+    # Start WebAuthn credential registration for an authenticated user. Returns options to pass to navigator.credentials.create().
+    # @param [Hash] opts the optional parameters
+    # @option opts [WebAuthnStartRegistrationRequest] :web_authn_start_registration_request 
+    # @return [WebAuthnStartRegistrationResponse]
+    def start_web_authn_registration(opts = {})
+      data, _status_code, _headers = start_web_authn_registration_with_http_info(opts)
+      data
+    end
+
+    # Start WebAuthn registration
+    # Start WebAuthn credential registration for an authenticated user. Returns options to pass to navigator.credentials.create().
+    # @param [Hash] opts the optional parameters
+    # @option opts [WebAuthnStartRegistrationRequest] :web_authn_start_registration_request 
+    # @return [Array<(WebAuthnStartRegistrationResponse, Integer, Hash)>] WebAuthnStartRegistrationResponse data, response status code and response headers
+    def start_web_authn_registration_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AuthWebAuthnApi.start_web_authn_registration ...'
+      end
+      # resource path
+      local_var_path = '/auth/webauthn/registration/start'
+
+      # 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(opts[:'web_authn_start_registration_request'])
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'WebAuthnStartRegistrationResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApplicationSecret', 'EndUserToken', 'ApplicationPublicKey']
+
+      new_options = opts.merge(
+        :operation => :"AuthWebAuthnApi.start_web_authn_registration",
+        :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: AuthWebAuthnApi#start_web_authn_registration\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Verify WebAuthn authentication
+    # Complete WebAuthn authentication and issue tokens. If MFA is enabled, returns mfa_required with a challenge token.
+    # @param web_authn_verify_auth_request [WebAuthnVerifyAuthRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [AuthLoginResponse]
+    def verify_web_authn_authentication(web_authn_verify_auth_request, opts = {})
+      data, _status_code, _headers = verify_web_authn_authentication_with_http_info(web_authn_verify_auth_request, opts)
+      data
+    end
+
+    # Verify WebAuthn authentication
+    # Complete WebAuthn authentication and issue tokens. If MFA is enabled, returns mfa_required with a challenge token.
+    # @param web_authn_verify_auth_request [WebAuthnVerifyAuthRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(AuthLoginResponse, Integer, Hash)>] AuthLoginResponse data, response status code and response headers
+    def verify_web_authn_authentication_with_http_info(web_authn_verify_auth_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AuthWebAuthnApi.verify_web_authn_authentication ...'
+      end
+      # verify the required parameter 'web_authn_verify_auth_request' is set
+      if @api_client.config.client_side_validation && web_authn_verify_auth_request.nil?
+        fail ArgumentError, "Missing the required parameter 'web_authn_verify_auth_request' when calling AuthWebAuthnApi.verify_web_authn_authentication"
+      end
+      # resource path
+      local_var_path = '/auth/webauthn/authentication/verify'
+
+      # 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(web_authn_verify_auth_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'AuthLoginResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApplicationSecret', 'ApplicationPublicKey']
+
+      new_options = opts.merge(
+        :operation => :"AuthWebAuthnApi.verify_web_authn_authentication",
+        :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: AuthWebAuthnApi#verify_web_authn_authentication\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Verify WebAuthn registration
+    # Complete WebAuthn credential registration. Stores the credential for future authentication.
+    # @param web_authn_verify_registration_request [WebAuthnVerifyRegistrationRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [WebAuthnVerifyRegistrationResponse]
+    def verify_web_authn_registration(web_authn_verify_registration_request, opts = {})
+      data, _status_code, _headers = verify_web_authn_registration_with_http_info(web_authn_verify_registration_request, opts)
+      data
+    end
+
+    # Verify WebAuthn registration
+    # Complete WebAuthn credential registration. Stores the credential for future authentication.
+    # @param web_authn_verify_registration_request [WebAuthnVerifyRegistrationRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(WebAuthnVerifyRegistrationResponse, Integer, Hash)>] WebAuthnVerifyRegistrationResponse data, response status code and response headers
+    def verify_web_authn_registration_with_http_info(web_authn_verify_registration_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AuthWebAuthnApi.verify_web_authn_registration ...'
+      end
+      # verify the required parameter 'web_authn_verify_registration_request' is set
+      if @api_client.config.client_side_validation && web_authn_verify_registration_request.nil?
+        fail ArgumentError, "Missing the required parameter 'web_authn_verify_registration_request' when calling AuthWebAuthnApi.verify_web_authn_registration"
+      end
+      # resource path
+      local_var_path = '/auth/webauthn/registration/verify'
+
+      # 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(web_authn_verify_registration_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'WebAuthnVerifyRegistrationResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApplicationSecret', 'EndUserToken', 'ApplicationPublicKey']
+
+      new_options = opts.merge(
+        :operation => :"AuthWebAuthnApi.verify_web_authn_registration",
+        :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: AuthWebAuthnApi#verify_web_authn_registration\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end