class Onfido::Document

Attributes

applicant_id[RW]

The ID of the applicant whose document is being uploaded.

created_at[RW]

The date and time at which the document was uploaded

download_href[RW]

The uri that can be used to download the document

file_name[RW]

The name of the uploaded file

file_size[RW]

The size of the file in bytes

file_type[RW]

The file type of the uploaded file

href[RW]

The uri of this resource

id[RW]

The unique identifier for the document

issuing_country[RW]

The issuing country of the document, a 3-letter ISO code.

side[RW]

The side of the document, if applicable. The possible values are front and back

type[RW]

The type of document

Public Class Methods

_deserialize(type, value) click to toggle source

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.rb, line 289
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
acceptable_attributes() click to toggle source

Returns all the JSON keys this model knows about

# File lib/onfido/models/document.rb, line 91
def self.acceptable_attributes
  attribute_map.values
end
attribute_map() click to toggle source

Attribute mapping from ruby-style variable name to JSON key.

# File lib/onfido/models/document.rb, line 74
def self.attribute_map
  {
    :'file_type' => :'file_type',
    :'type' => :'type',
    :'side' => :'side',
    :'issuing_country' => :'issuing_country',
    :'applicant_id' => :'applicant_id',
    :'id' => :'id',
    :'created_at' => :'created_at',
    :'href' => :'href',
    :'download_href' => :'download_href',
    :'file_name' => :'file_name',
    :'file_size' => :'file_size'
  }
end
build_from_hash(attributes) click to toggle source

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.rb, line 265
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
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# File lib/onfido/models/document.rb, line 128
def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Onfido::Document` 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::Document`. 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

  if attributes.key?(:'id')
    self.id = attributes[:'id']
  else
    self.id = nil
  end

  if attributes.key?(:'created_at')
    self.created_at = attributes[:'created_at']
  end

  if attributes.key?(:'href')
    self.href = attributes[:'href']
  end

  if attributes.key?(:'download_href')
    self.download_href = attributes[:'download_href']
  end

  if attributes.key?(:'file_name')
    self.file_name = attributes[:'file_name']
  end

  if attributes.key?(:'file_size')
    self.file_size = attributes[:'file_size']
  end
end
openapi_all_of() click to toggle source

List of class defined in allOf (OpenAPI v3)

# File lib/onfido/models/document.rb, line 119
def self.openapi_all_of
  [
  :'DocumentResponse',
  :'DocumentShared'
  ]
end
openapi_nullable() click to toggle source

List of attributes with nullable: true

# File lib/onfido/models/document.rb, line 113
def self.openapi_nullable
  Set.new([
  ])
end
openapi_types() click to toggle source

Attribute type mapping.

# File lib/onfido/models/document.rb, line 96
def self.openapi_types
  {
    :'file_type' => :'String',
    :'type' => :'DocumentTypes',
    :'side' => :'String',
    :'issuing_country' => :'CountryCodes',
    :'applicant_id' => :'String',
    :'id' => :'String',
    :'created_at' => :'Time',
    :'href' => :'String',
    :'download_href' => :'String',
    :'file_name' => :'String',
    :'file_size' => :'Integer'
  }
end

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# File lib/onfido/models/document.rb, line 234
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 &&
      id == o.id &&
      created_at == o.created_at &&
      href == o.href &&
      download_href == o.download_href &&
      file_name == o.file_name &&
      file_size == o.file_size
end
_to_hash(value) click to toggle source

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.rb, line 360
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
eql?(o) click to toggle source

@see the ‘==` method @param [Object] Object to be compared

# File lib/onfido/models/document.rb, line 252
def eql?(o)
  self == o
end
file_type=(file_type) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] file_type Object to be assigned

# File lib/onfido/models/document.rb, line 214
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
hash() click to toggle source

Calculates hash code according to all attributes. @return [Integer] Hash code

# File lib/onfido/models/document.rb, line 258
def hash
  [file_type, type, side, issuing_country, applicant_id, id, created_at, href, download_href, file_name, file_size].hash
end
list_invalid_properties() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

# File lib/onfido/models/document.rb, line 190
def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @id.nil?
    invalid_properties.push('invalid value for "id", id cannot be nil.')
  end

  invalid_properties
end
side=(side) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] side Object to be assigned

# File lib/onfido/models/document.rb, line 224
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
to_body() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/onfido/models/document.rb, line 336
def to_body
  to_hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/onfido/models/document.rb, line 342
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
to_s() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/onfido/models/document.rb, line 330
def to_s
  to_hash.to_s
end
valid?() click to toggle source

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.rb, line 202
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)
  return false if @id.nil?
  true
end