turnkey_client 0.0.18 → 0.0.19

data/lib/turnkey_client/models/init_otp_intent_v3.rb

@@ -0,0 +1,336 @@
+=begin
+#API Reference
+
+#Review our [API Introduction](../api-introduction) to get started.
+
+OpenAPI spec version: 1.0
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+=end
+
+require 'date'
+
+module TurnkeyClient
+  class InitOtpIntentV3
+    # Whether to send OTP via SMS or email. Possible values: OTP_TYPE_SMS, OTP_TYPE_EMAIL
+    attr_accessor :otp_type
+
+    # Email or phone number to send the OTP code to
+    attr_accessor :contact
+
+    # The name of the application.
+    attr_accessor :app_name
+
+    # Optional length of the OTP code. Default = 9
+    attr_accessor :otp_length
+
+    attr_accessor :email_customization
+
+    attr_accessor :sms_customization
+
+    # Optional client-generated user identifier to enable per-user rate limiting for SMS auth. We recommend using a hash of the client-side IP address.
+    attr_accessor :user_identifier
+
+    # Optional custom email address from which to send the OTP email
+    attr_accessor :send_from_email_address
+
+    # Optional flag to specify if the OTP code should be alphanumeric (Crockford’s Base32). If set to false, OTP code will only be numeric. Default = true
+    attr_accessor :alphanumeric
+
+    # Optional custom sender name for use with sendFromEmailAddress; if left empty, will default to 'Notifications'
+    attr_accessor :send_from_email_sender_name
+
+    # Expiration window (in seconds) indicating how long the OTP is valid for. If not provided, a default of 5 minutes will be used. Maximum value is 600 seconds (10 minutes)
+    attr_accessor :expiration_seconds
+
+    # Optional custom email address to use as reply-to
+    attr_accessor :reply_to_email_address
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'otp_type' => :'otpType',
+        :'contact' => :'contact',
+        :'app_name' => :'appName',
+        :'otp_length' => :'otpLength',
+        :'email_customization' => :'emailCustomization',
+        :'sms_customization' => :'smsCustomization',
+        :'user_identifier' => :'userIdentifier',
+        :'send_from_email_address' => :'sendFromEmailAddress',
+        :'alphanumeric' => :'alphanumeric',
+        :'send_from_email_sender_name' => :'sendFromEmailSenderName',
+        :'expiration_seconds' => :'expirationSeconds',
+        :'reply_to_email_address' => :'replyToEmailAddress'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'otp_type' => :'Object',
+        :'contact' => :'Object',
+        :'app_name' => :'Object',
+        :'otp_length' => :'Object',
+        :'email_customization' => :'Object',
+        :'sms_customization' => :'Object',
+        :'user_identifier' => :'Object',
+        :'send_from_email_address' => :'Object',
+        :'alphanumeric' => :'Object',
+        :'send_from_email_sender_name' => :'Object',
+        :'expiration_seconds' => :'Object',
+        :'reply_to_email_address' => :'Object'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'otp_length',
+        :'user_identifier',
+        :'send_from_email_address',
+        :'alphanumeric',
+        :'send_from_email_sender_name',
+        :'expiration_seconds',
+        :'reply_to_email_address'
+      ])
+    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 `TurnkeyClient::InitOtpIntentV3` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `TurnkeyClient::InitOtpIntentV3`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'otp_type')
+        self.otp_type = attributes[:'otp_type']
+      end
+
+      if attributes.key?(:'contact')
+        self.contact = attributes[:'contact']
+      end
+
+      if attributes.key?(:'app_name')
+        self.app_name = attributes[:'app_name']
+      end
+
+      if attributes.key?(:'otp_length')
+        self.otp_length = attributes[:'otp_length']
+      end
+
+      if attributes.key?(:'email_customization')
+        self.email_customization = attributes[:'email_customization']
+      end
+
+      if attributes.key?(:'sms_customization')
+        self.sms_customization = attributes[:'sms_customization']
+      end
+
+      if attributes.key?(:'user_identifier')
+        self.user_identifier = attributes[:'user_identifier']
+      end
+
+      if attributes.key?(:'send_from_email_address')
+        self.send_from_email_address = attributes[:'send_from_email_address']
+      end
+
+      if attributes.key?(:'alphanumeric')
+        self.alphanumeric = attributes[:'alphanumeric']
+      end
+
+      if attributes.key?(:'send_from_email_sender_name')
+        self.send_from_email_sender_name = attributes[:'send_from_email_sender_name']
+      end
+
+      if attributes.key?(:'expiration_seconds')
+        self.expiration_seconds = attributes[:'expiration_seconds']
+      end
+
+      if attributes.key?(:'reply_to_email_address')
+        self.reply_to_email_address = attributes[:'reply_to_email_address']
+      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
+      invalid_properties = Array.new
+      if @otp_type.nil?
+        invalid_properties.push('invalid value for "otp_type", otp_type cannot be nil.')
+      end
+
+      if @contact.nil?
+        invalid_properties.push('invalid value for "contact", contact cannot be nil.')
+      end
+
+      if @app_name.nil?
+        invalid_properties.push('invalid value for "app_name", app_name 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?
+      return false if @otp_type.nil?
+      return false if @contact.nil?
+      return false if @app_name.nil?
+      true
+    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 &&
+          otp_type == o.otp_type &&
+          contact == o.contact &&
+          app_name == o.app_name &&
+          otp_length == o.otp_length &&
+          email_customization == o.email_customization &&
+          sms_customization == o.sms_customization &&
+          user_identifier == o.user_identifier &&
+          send_from_email_address == o.send_from_email_address &&
+          alphanumeric == o.alphanumeric &&
+          send_from_email_sender_name == o.send_from_email_sender_name &&
+          expiration_seconds == o.expiration_seconds &&
+          reply_to_email_address == o.reply_to_email_address
+    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
+      [otp_type, contact, app_name, otp_length, email_customization, sms_customization, user_identifier, send_from_email_address, alphanumeric, send_from_email_sender_name, expiration_seconds, reply_to_email_address].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)
+      new.build_from_hash(attributes)
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.openapi_types.each_pair do |key, type|
+        if 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[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        elsif attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
+          self.send("#{key}=", nil)
+        end
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.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
+        TurnkeyClient.const_get(type).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

data/lib/turnkey_client/models/init_otp_request.rb

@@ -138,7 +138,7 @@ module TurnkeyClient
     # @return true if the model is valid
     def valid?
       return false if @type.nil?
-      type_validator = EnumAttributeValidator.new('Object', ['ACTIVITY_TYPE_INIT_OTP_V2'])
+      type_validator = EnumAttributeValidator.new('Object', ['ACTIVITY_TYPE_INIT_OTP_V3'])
       return false unless type_validator.valid?(@type)
       return false if @timestamp_ms.nil?
       return false if @organization_id.nil?
@@ -149,7 +149,7 @@ module TurnkeyClient
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] type Object to be assigned
     def type=(type)
-      validator = EnumAttributeValidator.new('Object', ['ACTIVITY_TYPE_INIT_OTP_V2'])
+      validator = EnumAttributeValidator.new('Object', ['ACTIVITY_TYPE_INIT_OTP_V3'])
       unless validator.valid?(type)
         fail ArgumentError, "invalid value for \"type\", must be one of #{validator.allowable_values}."
       end

data/lib/turnkey_client/models/init_otp_result_v2.rb

@@ -0,0 +1,226 @@
+=begin
+#API Reference
+
+#Review our [API Introduction](../api-introduction) to get started.
+
+OpenAPI spec version: 1.0
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+=end
+
+require 'date'
+
+module TurnkeyClient
+  class InitOtpResultV2
+    # Unique identifier for an OTP flow
+    attr_accessor :otp_id
+
+    # Signed bundle containing a target encryption key to use when submitting OTP codes.
+    attr_accessor :otp_encryption_target_bundle
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'otp_id' => :'otpId',
+        :'otp_encryption_target_bundle' => :'otpEncryptionTargetBundle'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'otp_id' => :'Object',
+        :'otp_encryption_target_bundle' => :'Object'
+      }
+    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 `TurnkeyClient::InitOtpResultV2` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `TurnkeyClient::InitOtpResultV2`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'otp_id')
+        self.otp_id = attributes[:'otp_id']
+      end
+
+      if attributes.key?(:'otp_encryption_target_bundle')
+        self.otp_encryption_target_bundle = attributes[:'otp_encryption_target_bundle']
+      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
+      invalid_properties = Array.new
+      if @otp_id.nil?
+        invalid_properties.push('invalid value for "otp_id", otp_id cannot be nil.')
+      end
+
+      if @otp_encryption_target_bundle.nil?
+        invalid_properties.push('invalid value for "otp_encryption_target_bundle", otp_encryption_target_bundle 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?
+      return false if @otp_id.nil?
+      return false if @otp_encryption_target_bundle.nil?
+      true
+    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 &&
+          otp_id == o.otp_id &&
+          otp_encryption_target_bundle == o.otp_encryption_target_bundle
+    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
+      [otp_id, otp_encryption_target_bundle].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)
+      new.build_from_hash(attributes)
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.openapi_types.each_pair do |key, type|
+        if 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[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        elsif attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
+          self.send("#{key}=", nil)
+        end
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.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
+        TurnkeyClient.const_get(type).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