class Onfido::DocumentShared
Attributes
The ID of the applicant whose document is being uploaded.
The file type of the uploaded file
The issuing country of the document, a 3-letter ISO code.
The side of the document, if applicable. The possible values are front and back
The type of document
Public Class Methods
Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data
# File lib/onfido/models/document_shared.rb, line 214 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 = Onfido.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 all the JSON keys this model knows about
# File lib/onfido/models/document_shared.rb, line 67 def self.acceptable_attributes attribute_map.values end
Attribute mapping from ruby-style variable name to JSON key.
# File lib/onfido/models/document_shared.rb, line 56 def self.attribute_map { :'file_type' => :'file_type', :'type' => :'type', :'side' => :'side', :'issuing_country' => :'issuing_country', :'applicant_id' => :'applicant_id' } end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/onfido/models/document_shared.rb, line 190 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
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/onfido/models/document_shared.rb, line 90 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `Onfido::DocumentShared` 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 `Onfido::DocumentShared`. 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?(:'file_type') self.file_type = attributes[:'file_type'] end if attributes.key?(:'type') self.type = attributes[:'type'] end if attributes.key?(:'side') self.side = attributes[:'side'] end if attributes.key?(:'issuing_country') self.issuing_country = attributes[:'issuing_country'] end if attributes.key?(:'applicant_id') self.applicant_id = attributes[:'applicant_id'] end end
List of attributes with nullable: true
# File lib/onfido/models/document_shared.rb, line 83 def self.openapi_nullable Set.new([ ]) end
Attribute type mapping.
# File lib/onfido/models/document_shared.rb, line 72 def self.openapi_types { :'file_type' => :'String', :'type' => :'DocumentTypes', :'side' => :'String', :'issuing_country' => :'CountryCodes', :'applicant_id' => :'String' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/onfido/models/document_shared.rb, line 165 def ==(o) return true if self.equal?(o) self.class == o.class && file_type == o.file_type && type == o.type && side == o.side && issuing_country == o.issuing_country && applicant_id == o.applicant_id 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
# File lib/onfido/models/document_shared.rb, line 285 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
@see the ‘==` method @param [Object] Object to be compared
# File lib/onfido/models/document_shared.rb, line 177 def eql?(o) self == o end
Custom attribute writer method checking allowed values (enum). @param [Object] file_type
Object to be assigned
# File lib/onfido/models/document_shared.rb, line 145 def file_type=(file_type) validator = EnumAttributeValidator.new('String', ["jpg", "jpeg", "png", "pdf", "unknown_default_open_api"]) unless validator.valid?(file_type) fail ArgumentError, "invalid value for \"file_type\", must be one of #{validator.allowable_values}." end @file_type = file_type end
Calculates hash code according to all attributes. @return [Integer] Hash code
# File lib/onfido/models/document_shared.rb, line 183 def hash [file_type, type, side, issuing_country, applicant_id].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
# File lib/onfido/models/document_shared.rb, line 126 def list_invalid_properties warn '[DEPRECATED] the `list_invalid_properties` method is obsolete' invalid_properties = Array.new invalid_properties end
Custom attribute writer method checking allowed values (enum). @param [Object] side Object to be assigned
# File lib/onfido/models/document_shared.rb, line 155 def side=(side) validator = EnumAttributeValidator.new('String', ["front", "back", "unknown_default_open_api"]) unless validator.valid?(side) fail ArgumentError, "invalid value for \"side\", must be one of #{validator.allowable_values}." end @side = side end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/onfido/models/document_shared.rb, line 267 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
Returns the string representation of the object @return [String] String presentation of the object
# File lib/onfido/models/document_shared.rb, line 255 def to_s to_hash.to_s end
Check
to see if the all the properties in the model are valid @return true if the model is valid
# File lib/onfido/models/document_shared.rb, line 134 def valid? warn '[DEPRECATED] the `valid?` method is obsolete' file_type_validator = EnumAttributeValidator.new('String', ["jpg", "jpeg", "png", "pdf", "unknown_default_open_api"]) return false unless file_type_validator.valid?(@file_type) side_validator = EnumAttributeValidator.new('String', ["front", "back", "unknown_default_open_api"]) return false unless side_validator.valid?(@side) true end