zyphr 0.1.0

data/lib/zyphr/api/auth_mfa_api.rb

@@ -0,0 +1,493 @@
+=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 AuthMFAApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Disable MFA for a user
+    # Disables MFA for a user after verifying their identity with a TOTP code or backup code. Removes the TOTP secret and all backup codes. 
+    # @param mfa_disable_request [MfaDisableRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [MfaDisableResponse]
+    def disable_mfa(mfa_disable_request, opts = {})
+      data, _status_code, _headers = disable_mfa_with_http_info(mfa_disable_request, opts)
+      data
+    end
+
+    # Disable MFA for a user
+    # Disables MFA for a user after verifying their identity with a TOTP code or backup code. Removes the TOTP secret and all backup codes. 
+    # @param mfa_disable_request [MfaDisableRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(MfaDisableResponse, Integer, Hash)>] MfaDisableResponse data, response status code and response headers
+    def disable_mfa_with_http_info(mfa_disable_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AuthMFAApi.disable_mfa ...'
+      end
+      # verify the required parameter 'mfa_disable_request' is set
+      if @api_client.config.client_side_validation && mfa_disable_request.nil?
+        fail ArgumentError, "Missing the required parameter 'mfa_disable_request' when calling AuthMFAApi.disable_mfa"
+      end
+      # resource path
+      local_var_path = '/auth/mfa/disable'
+
+      # 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(mfa_disable_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'MfaDisableResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApplicationSecret', 'ApplicationPublicKey']
+
+      new_options = opts.merge(
+        :operation => :"AuthMFAApi.disable_mfa",
+        :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: AuthMFAApi#disable_mfa\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get MFA status for a user
+    # Returns the current MFA enrollment status for a user, including whether MFA is enabled, the enrollment status, when it was enabled, and the number of remaining backup codes. 
+    # @param user_id [String] The end user&#39;s ID
+    # @param [Hash] opts the optional parameters
+    # @return [MfaStatusResponse]
+    def get_mfa_status(user_id, opts = {})
+      data, _status_code, _headers = get_mfa_status_with_http_info(user_id, opts)
+      data
+    end
+
+    # Get MFA status for a user
+    # Returns the current MFA enrollment status for a user, including whether MFA is enabled, the enrollment status, when it was enabled, and the number of remaining backup codes. 
+    # @param user_id [String] The end user&#39;s ID
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(MfaStatusResponse, Integer, Hash)>] MfaStatusResponse data, response status code and response headers
+    def get_mfa_status_with_http_info(user_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AuthMFAApi.get_mfa_status ...'
+      end
+      # verify the required parameter 'user_id' is set
+      if @api_client.config.client_side_validation && user_id.nil?
+        fail ArgumentError, "Missing the required parameter 'user_id' when calling AuthMFAApi.get_mfa_status"
+      end
+      # resource path
+      local_var_path = '/auth/mfa/status/{userId}'.sub('{' + 'userId' + '}', CGI.escape(user_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] || 'MfaStatusResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApplicationSecret', 'ApplicationPublicKey']
+
+      new_options = opts.merge(
+        :operation => :"AuthMFAApi.get_mfa_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: AuthMFAApi#get_mfa_status\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Regenerate MFA backup codes
+    # Generates a new set of one-time backup codes for a user, invalidating all previous codes. Requires a valid TOTP code to authorize the regeneration. 
+    # @param mfa_regenerate_backup_codes_request [MfaRegenerateBackupCodesRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [MfaBackupCodesResponse]
+    def regenerate_backup_codes(mfa_regenerate_backup_codes_request, opts = {})
+      data, _status_code, _headers = regenerate_backup_codes_with_http_info(mfa_regenerate_backup_codes_request, opts)
+      data
+    end
+
+    # Regenerate MFA backup codes
+    # Generates a new set of one-time backup codes for a user, invalidating all previous codes. Requires a valid TOTP code to authorize the regeneration. 
+    # @param mfa_regenerate_backup_codes_request [MfaRegenerateBackupCodesRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(MfaBackupCodesResponse, Integer, Hash)>] MfaBackupCodesResponse data, response status code and response headers
+    def regenerate_backup_codes_with_http_info(mfa_regenerate_backup_codes_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AuthMFAApi.regenerate_backup_codes ...'
+      end
+      # verify the required parameter 'mfa_regenerate_backup_codes_request' is set
+      if @api_client.config.client_side_validation && mfa_regenerate_backup_codes_request.nil?
+        fail ArgumentError, "Missing the required parameter 'mfa_regenerate_backup_codes_request' when calling AuthMFAApi.regenerate_backup_codes"
+      end
+      # resource path
+      local_var_path = '/auth/mfa/regenerate-backup-codes'
+
+      # 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(mfa_regenerate_backup_codes_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'MfaBackupCodesResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApplicationSecret', 'ApplicationPublicKey']
+
+      new_options = opts.merge(
+        :operation => :"AuthMFAApi.regenerate_backup_codes",
+        :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: AuthMFAApi#regenerate_backup_codes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Start MFA enrollment
+    # Begins TOTP-based MFA enrollment for a user. Returns the TOTP secret, a QR code data URL for scanning with an authenticator app, and a set of one-time backup codes. 
+    # @param mfa_enroll_request [MfaEnrollRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [MfaEnrollmentResponse]
+    def start_mfa_enrollment(mfa_enroll_request, opts = {})
+      data, _status_code, _headers = start_mfa_enrollment_with_http_info(mfa_enroll_request, opts)
+      data
+    end
+
+    # Start MFA enrollment
+    # Begins TOTP-based MFA enrollment for a user. Returns the TOTP secret, a QR code data URL for scanning with an authenticator app, and a set of one-time backup codes. 
+    # @param mfa_enroll_request [MfaEnrollRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(MfaEnrollmentResponse, Integer, Hash)>] MfaEnrollmentResponse data, response status code and response headers
+    def start_mfa_enrollment_with_http_info(mfa_enroll_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AuthMFAApi.start_mfa_enrollment ...'
+      end
+      # verify the required parameter 'mfa_enroll_request' is set
+      if @api_client.config.client_side_validation && mfa_enroll_request.nil?
+        fail ArgumentError, "Missing the required parameter 'mfa_enroll_request' when calling AuthMFAApi.start_mfa_enrollment"
+      end
+      # resource path
+      local_var_path = '/auth/mfa/enroll'
+
+      # 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(mfa_enroll_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'MfaEnrollmentResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApplicationSecret', 'ApplicationPublicKey']
+
+      new_options = opts.merge(
+        :operation => :"AuthMFAApi.start_mfa_enrollment",
+        :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: AuthMFAApi#start_mfa_enrollment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Verify MFA challenge with TOTP code
+    # Verifies a TOTP code against an MFA challenge token issued during login. On success, completes the authentication flow and returns user data with access and refresh tokens. 
+    # @param mfa_verify_request [MfaVerifyRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [AuthResultResponse]
+    def verify_mfa_challenge(mfa_verify_request, opts = {})
+      data, _status_code, _headers = verify_mfa_challenge_with_http_info(mfa_verify_request, opts)
+      data
+    end
+
+    # Verify MFA challenge with TOTP code
+    # Verifies a TOTP code against an MFA challenge token issued during login. On success, completes the authentication flow and returns user data with access and refresh tokens. 
+    # @param mfa_verify_request [MfaVerifyRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(AuthResultResponse, Integer, Hash)>] AuthResultResponse data, response status code and response headers
+    def verify_mfa_challenge_with_http_info(mfa_verify_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AuthMFAApi.verify_mfa_challenge ...'
+      end
+      # verify the required parameter 'mfa_verify_request' is set
+      if @api_client.config.client_side_validation && mfa_verify_request.nil?
+        fail ArgumentError, "Missing the required parameter 'mfa_verify_request' when calling AuthMFAApi.verify_mfa_challenge"
+      end
+      # resource path
+      local_var_path = '/auth/mfa/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(mfa_verify_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'AuthResultResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApplicationSecret', 'ApplicationPublicKey']
+
+      new_options = opts.merge(
+        :operation => :"AuthMFAApi.verify_mfa_challenge",
+        :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: AuthMFAApi#verify_mfa_challenge\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Verify MFA challenge with backup code
+    # Verifies a one-time backup code against an MFA challenge token issued during login. On success, completes the authentication flow and returns user data, tokens, and the count of remaining backup codes. 
+    # @param mfa_verify_backup_request [MfaVerifyBackupRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [MfaVerifyBackupResponse]
+    def verify_mfa_challenge_with_backup_code(mfa_verify_backup_request, opts = {})
+      data, _status_code, _headers = verify_mfa_challenge_with_backup_code_with_http_info(mfa_verify_backup_request, opts)
+      data
+    end
+
+    # Verify MFA challenge with backup code
+    # Verifies a one-time backup code against an MFA challenge token issued during login. On success, completes the authentication flow and returns user data, tokens, and the count of remaining backup codes. 
+    # @param mfa_verify_backup_request [MfaVerifyBackupRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(MfaVerifyBackupResponse, Integer, Hash)>] MfaVerifyBackupResponse data, response status code and response headers
+    def verify_mfa_challenge_with_backup_code_with_http_info(mfa_verify_backup_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AuthMFAApi.verify_mfa_challenge_with_backup_code ...'
+      end
+      # verify the required parameter 'mfa_verify_backup_request' is set
+      if @api_client.config.client_side_validation && mfa_verify_backup_request.nil?
+        fail ArgumentError, "Missing the required parameter 'mfa_verify_backup_request' when calling AuthMFAApi.verify_mfa_challenge_with_backup_code"
+      end
+      # resource path
+      local_var_path = '/auth/mfa/verify-backup'
+
+      # 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(mfa_verify_backup_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'MfaVerifyBackupResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApplicationSecret', 'ApplicationPublicKey']
+
+      new_options = opts.merge(
+        :operation => :"AuthMFAApi.verify_mfa_challenge_with_backup_code",
+        :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: AuthMFAApi#verify_mfa_challenge_with_backup_code\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Verify MFA enrollment
+    # Completes MFA enrollment by verifying a TOTP code from the user's authenticator app. On success, MFA is permanently enabled for the user. 
+    # @param mfa_verify_enrollment_request [MfaVerifyEnrollmentRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [MfaVerifyEnrollmentResponse]
+    def verify_mfa_enrollment(mfa_verify_enrollment_request, opts = {})
+      data, _status_code, _headers = verify_mfa_enrollment_with_http_info(mfa_verify_enrollment_request, opts)
+      data
+    end
+
+    # Verify MFA enrollment
+    # Completes MFA enrollment by verifying a TOTP code from the user&#39;s authenticator app. On success, MFA is permanently enabled for the user. 
+    # @param mfa_verify_enrollment_request [MfaVerifyEnrollmentRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(MfaVerifyEnrollmentResponse, Integer, Hash)>] MfaVerifyEnrollmentResponse data, response status code and response headers
+    def verify_mfa_enrollment_with_http_info(mfa_verify_enrollment_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AuthMFAApi.verify_mfa_enrollment ...'
+      end
+      # verify the required parameter 'mfa_verify_enrollment_request' is set
+      if @api_client.config.client_side_validation && mfa_verify_enrollment_request.nil?
+        fail ArgumentError, "Missing the required parameter 'mfa_verify_enrollment_request' when calling AuthMFAApi.verify_mfa_enrollment"
+      end
+      # resource path
+      local_var_path = '/auth/mfa/verify-enrollment'
+
+      # 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(mfa_verify_enrollment_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'MfaVerifyEnrollmentResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApplicationSecret', 'ApplicationPublicKey']
+
+      new_options = opts.merge(
+        :operation => :"AuthMFAApi.verify_mfa_enrollment",
+        :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: AuthMFAApi#verify_mfa_enrollment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end