zyphr 0.1.34 → 0.1.36

data/lib/zyphr/api/auth_email_otp_api.rb

@@ -0,0 +1,351 @@
+=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 AuthEmailOTPApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Check email OTP availability
+    # Check if numeric email OTP authentication is available for this application. Requires a verified sending domain on the project.
+    # @param [Hash] opts the optional parameters
+    # @return [PhoneAuthAvailabilityResponse]
+    def check_email_otp_availability(opts = {})
+      data, _status_code, _headers = check_email_otp_availability_with_http_info(opts)
+      data
+    end
+
+    # Check email OTP availability
+    # Check if numeric email OTP authentication is available for this application. Requires a verified sending domain on the project.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(PhoneAuthAvailabilityResponse, Integer, Hash)>] PhoneAuthAvailabilityResponse data, response status code and response headers
+    def check_email_otp_availability_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AuthEmailOTPApi.check_email_otp_availability ...'
+      end
+      # resource path
+      local_var_path = '/auth/email-otp/available'
+
+      # 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] || 'PhoneAuthAvailabilityResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApplicationPublicKey']
+
+      new_options = opts.merge(
+        :operation => :"AuthEmailOTPApi.check_email_otp_availability",
+        :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: AuthEmailOTPApi#check_email_otp_availability\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Send email OTP for login
+    # Send a numeric verification code to an existing user's email address for login.
+    # @param send_email_otp_registration_request [SendEmailOtpRegistrationRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [PhoneOtpSentResponse]
+    def send_email_otp_login(send_email_otp_registration_request, opts = {})
+      data, _status_code, _headers = send_email_otp_login_with_http_info(send_email_otp_registration_request, opts)
+      data
+    end
+
+    # Send email OTP for login
+    # Send a numeric verification code to an existing user&#39;s email address for login.
+    # @param send_email_otp_registration_request [SendEmailOtpRegistrationRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(PhoneOtpSentResponse, Integer, Hash)>] PhoneOtpSentResponse data, response status code and response headers
+    def send_email_otp_login_with_http_info(send_email_otp_registration_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AuthEmailOTPApi.send_email_otp_login ...'
+      end
+      # verify the required parameter 'send_email_otp_registration_request' is set
+      if @api_client.config.client_side_validation && send_email_otp_registration_request.nil?
+        fail ArgumentError, "Missing the required parameter 'send_email_otp_registration_request' when calling AuthEmailOTPApi.send_email_otp_login"
+      end
+      # resource path
+      local_var_path = '/auth/email-otp/login/send'
+
+      # 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(send_email_otp_registration_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'PhoneOtpSentResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApplicationSecret', 'ApplicationPublicKey']
+
+      new_options = opts.merge(
+        :operation => :"AuthEmailOTPApi.send_email_otp_login",
+        :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: AuthEmailOTPApi#send_email_otp_login\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Send email OTP for registration
+    # Send a numeric verification code to an email address for new user registration.
+    # @param send_email_otp_registration_request [SendEmailOtpRegistrationRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [PhoneOtpSentResponse]
+    def send_email_otp_registration(send_email_otp_registration_request, opts = {})
+      data, _status_code, _headers = send_email_otp_registration_with_http_info(send_email_otp_registration_request, opts)
+      data
+    end
+
+    # Send email OTP for registration
+    # Send a numeric verification code to an email address for new user registration.
+    # @param send_email_otp_registration_request [SendEmailOtpRegistrationRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(PhoneOtpSentResponse, Integer, Hash)>] PhoneOtpSentResponse data, response status code and response headers
+    def send_email_otp_registration_with_http_info(send_email_otp_registration_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AuthEmailOTPApi.send_email_otp_registration ...'
+      end
+      # verify the required parameter 'send_email_otp_registration_request' is set
+      if @api_client.config.client_side_validation && send_email_otp_registration_request.nil?
+        fail ArgumentError, "Missing the required parameter 'send_email_otp_registration_request' when calling AuthEmailOTPApi.send_email_otp_registration"
+      end
+      # resource path
+      local_var_path = '/auth/email-otp/register/send'
+
+      # 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(send_email_otp_registration_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'PhoneOtpSentResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApplicationSecret', 'ApplicationPublicKey']
+
+      new_options = opts.merge(
+        :operation => :"AuthEmailOTPApi.send_email_otp_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: AuthEmailOTPApi#send_email_otp_registration\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Verify email OTP login
+    # Verify the numeric code and login an existing user. If MFA is enabled, returns mfa_required with a challenge token.
+    # @param verify_email_otp_login_request [VerifyEmailOtpLoginRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [AuthLoginResponse]
+    def verify_email_otp_login(verify_email_otp_login_request, opts = {})
+      data, _status_code, _headers = verify_email_otp_login_with_http_info(verify_email_otp_login_request, opts)
+      data
+    end
+
+    # Verify email OTP login
+    # Verify the numeric code and login an existing user. If MFA is enabled, returns mfa_required with a challenge token.
+    # @param verify_email_otp_login_request [VerifyEmailOtpLoginRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(AuthLoginResponse, Integer, Hash)>] AuthLoginResponse data, response status code and response headers
+    def verify_email_otp_login_with_http_info(verify_email_otp_login_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AuthEmailOTPApi.verify_email_otp_login ...'
+      end
+      # verify the required parameter 'verify_email_otp_login_request' is set
+      if @api_client.config.client_side_validation && verify_email_otp_login_request.nil?
+        fail ArgumentError, "Missing the required parameter 'verify_email_otp_login_request' when calling AuthEmailOTPApi.verify_email_otp_login"
+      end
+      # resource path
+      local_var_path = '/auth/email-otp/login/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(verify_email_otp_login_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 => :"AuthEmailOTPApi.verify_email_otp_login",
+        :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: AuthEmailOTPApi#verify_email_otp_login\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Verify email OTP registration
+    # Verify the numeric code and create a new user account with the email address.
+    # @param verify_email_otp_registration_request [VerifyEmailOtpRegistrationRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [AuthResultResponse]
+    def verify_email_otp_registration(verify_email_otp_registration_request, opts = {})
+      data, _status_code, _headers = verify_email_otp_registration_with_http_info(verify_email_otp_registration_request, opts)
+      data
+    end
+
+    # Verify email OTP registration
+    # Verify the numeric code and create a new user account with the email address.
+    # @param verify_email_otp_registration_request [VerifyEmailOtpRegistrationRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(AuthResultResponse, Integer, Hash)>] AuthResultResponse data, response status code and response headers
+    def verify_email_otp_registration_with_http_info(verify_email_otp_registration_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AuthEmailOTPApi.verify_email_otp_registration ...'
+      end
+      # verify the required parameter 'verify_email_otp_registration_request' is set
+      if @api_client.config.client_side_validation && verify_email_otp_registration_request.nil?
+        fail ArgumentError, "Missing the required parameter 'verify_email_otp_registration_request' when calling AuthEmailOTPApi.verify_email_otp_registration"
+      end
+      # resource path
+      local_var_path = '/auth/email-otp/register/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(verify_email_otp_registration_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 => :"AuthEmailOTPApi.verify_email_otp_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: AuthEmailOTPApi#verify_email_otp_registration\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/zyphr/models/send_email_otp_registration_request.rb

@@ -0,0 +1,237 @@
+=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 'date'
+require 'time'
+
+module Zyphr
+  class SendEmailOtpRegistrationRequest
+    attr_accessor :email
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'email' => :'email'
+      }
+    end
+
+    # Returns attribute mapping this model knows about
+    def self.acceptable_attribute_map
+      attribute_map
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      acceptable_attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'email' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `Zyphr::SendEmailOtpRegistrationRequest` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      acceptable_attribute_map = self.class.acceptable_attribute_map
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!acceptable_attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Zyphr::SendEmailOtpRegistrationRequest`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'email')
+        self.email = attributes[:'email']
+      else
+        self.email = nil
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      invalid_properties = Array.new
+      if @email.nil?
+        invalid_properties.push('invalid value for "email", email cannot be nil.')
+      end
+
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      return false if @email.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] email Value to be assigned
+    def email=(email)
+      if email.nil?
+        fail ArgumentError, 'email cannot be nil'
+      end
+
+      @email = email
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          email == o.email
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [email].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = nil
+        elsif type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
+      end
+      new(transformed_hash)
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def self._deserialize(type, value)
+      case type.to_sym
+      when :Time
+        Time.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        # models (e.g. Pet) or oneOf
+        klass = Zyphr.const_get(type)
+        klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+
+end