=begin #Bandwidth #Bandwidth's Communication APIs The version of the OpenAPI document: 1.0.0 Contact: letstalk@bandwidth.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 7.0.0 =end require 'date' require 'time' module Bandwidth class VerifyCodeRequest # The phone number to send the mfa code to. attr_accessor :to # An optional field to denote what scope or action the mfa code is addressing. If not supplied, defaults to \"2FA\". attr_accessor :scope # The time period, in minutes, to validate the mfa code. By setting this to 3 minutes, it will mean any code generated within the last 3 minutes are still valid. The valid range for expiration time is between 0 and 15 minutes, exclusively and inclusively, respectively. attr_accessor :expiration_time_in_minutes # The generated mfa code to check if valid. attr_accessor :code # Attribute mapping from ruby-style variable name to JSON key. def self.attribute_map { :'to' => :'to', :'scope' => :'scope', :'expiration_time_in_minutes' => :'expirationTimeInMinutes', :'code' => :'code' } end # Returns all the JSON keys this model knows about def self.acceptable_attributes attribute_map.values end # Attribute type mapping. def self.openapi_types { :'to' => :'String', :'scope' => :'String', :'expiration_time_in_minutes' => :'Float', :'code' => :'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 `Bandwidth::VerifyCodeRequest` 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 `Bandwidth::VerifyCodeRequest`. 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?(:'to') self.to = attributes[:'to'] else self.to = nil end if attributes.key?(:'scope') self.scope = attributes[:'scope'] end if attributes.key?(:'expiration_time_in_minutes') self.expiration_time_in_minutes = attributes[:'expiration_time_in_minutes'] else self.expiration_time_in_minutes = nil end if attributes.key?(:'code') self.code = attributes[:'code'] else self.code = 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 @to.nil? invalid_properties.push('invalid value for "to", to cannot be nil.') end pattern = Regexp.new(/^\+[1-9]\d{1,14}$/) if @to !~ pattern invalid_properties.push("invalid value for \"to\", must conform to the pattern #{pattern}.") end if @expiration_time_in_minutes.nil? invalid_properties.push('invalid value for "expiration_time_in_minutes", expiration_time_in_minutes cannot be nil.') end if @expiration_time_in_minutes > 15 invalid_properties.push('invalid value for "expiration_time_in_minutes", must be smaller than or equal to 15.') end if @expiration_time_in_minutes < 1 invalid_properties.push('invalid value for "expiration_time_in_minutes", must be greater than or equal to 1.') end if @code.nil? invalid_properties.push('invalid value for "code", code cannot be nil.') end if @code.to_s.length > 8 invalid_properties.push('invalid value for "code", the character length must be smaller than or equal to 8.') end if @code.to_s.length < 4 invalid_properties.push('invalid value for "code", the character length must be great than or equal to 4.') 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 @to.nil? return false if @to !~ Regexp.new(/^\+[1-9]\d{1,14}$/) return false if @expiration_time_in_minutes.nil? return false if @expiration_time_in_minutes > 15 return false if @expiration_time_in_minutes < 1 return false if @code.nil? return false if @code.to_s.length > 8 return false if @code.to_s.length < 4 true end # Custom attribute writer method with validation # @param [Object] to Value to be assigned def to=(to) if to.nil? fail ArgumentError, 'to cannot be nil' end pattern = Regexp.new(/^\+[1-9]\d{1,14}$/) if to !~ pattern fail ArgumentError, "invalid value for \"to\", must conform to the pattern #{pattern}." end @to = to end # Custom attribute writer method with validation # @param [Object] expiration_time_in_minutes Value to be assigned def expiration_time_in_minutes=(expiration_time_in_minutes) if expiration_time_in_minutes.nil? fail ArgumentError, 'expiration_time_in_minutes cannot be nil' end if expiration_time_in_minutes > 15 fail ArgumentError, 'invalid value for "expiration_time_in_minutes", must be smaller than or equal to 15.' end if expiration_time_in_minutes < 1 fail ArgumentError, 'invalid value for "expiration_time_in_minutes", must be greater than or equal to 1.' end @expiration_time_in_minutes = expiration_time_in_minutes end # Custom attribute writer method with validation # @param [Object] code Value to be assigned def code=(code) if code.nil? fail ArgumentError, 'code cannot be nil' end if code.to_s.length > 8 fail ArgumentError, 'invalid value for "code", the character length must be smaller than or equal to 8.' end if code.to_s.length < 4 fail ArgumentError, 'invalid value for "code", the character length must be great than or equal to 4.' end @code = code 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 && to == o.to && scope == o.scope && expiration_time_in_minutes == o.expiration_time_in_minutes && code == o.code 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 [to, scope, expiration_time_in_minutes, code].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<(?.+)>\z/ inner_type = Regexp.last_match[:inner_type] value.map { |v| _deserialize(inner_type, v) } when /\AHash<(?.+?), (?.+)>\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 = Bandwidth.const_get(type) 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