class Onfido::CheckResponse

Attributes

created_at[RW]

The date and time when this check was created.

form_uri[RW]

A link to the applicant form, if ‘applicant_provides_data` is `true`.

href[RW]

The uri of this resource.

id[RW]

The unique identifier for the check.

paused[RW]
report_ids[RW]

An array of report ids.

result[RW]

The overall result of the check, based on the results of the constituent reports.

results_uri[RW]

A link to the corresponding results page on the Onfido dashboard.

sandbox[RW]

Indicates whether the object was created in the sandbox or not.

status[RW]
version[RW]

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/check_response.rb, line 268
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/check_response.rb, line 88
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/check_response.rb, line 71
def self.attribute_map
  {
    :'id' => :'id',
    :'created_at' => :'created_at',
    :'href' => :'href',
    :'status' => :'status',
    :'result' => :'result',
    :'form_uri' => :'form_uri',
    :'results_uri' => :'results_uri',
    :'report_ids' => :'report_ids',
    :'sandbox' => :'sandbox',
    :'paused' => :'paused',
    :'version' => :'version'
  }
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/check_response.rb, line 244
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/check_response.rb, line 117
def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Onfido::CheckResponse` 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::CheckResponse`. 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?(:'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?(:'status')
    self.status = attributes[:'status']
  end

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

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

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

  if attributes.key?(:'report_ids')
    if (value = attributes[:'report_ids']).is_a?(Array)
      self.report_ids = value
    end
  end

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

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

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

List of attributes with nullable: true

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

Attribute type mapping.

# File lib/onfido/models/check_response.rb, line 93
def self.openapi_types
  {
    :'id' => :'String',
    :'created_at' => :'Time',
    :'href' => :'String',
    :'status' => :'CheckStatus',
    :'result' => :'String',
    :'form_uri' => :'String',
    :'results_uri' => :'String',
    :'report_ids' => :'Array<String>',
    :'sandbox' => :'Boolean',
    :'paused' => :'Boolean',
    :'version' => :'String'
  }
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/check_response.rb, line 213
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      created_at == o.created_at &&
      href == o.href &&
      status == o.status &&
      result == o.result &&
      form_uri == o.form_uri &&
      results_uri == o.results_uri &&
      report_ids == o.report_ids &&
      sandbox == o.sandbox &&
      paused == o.paused &&
      version == o.version
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/check_response.rb, line 339
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/check_response.rb, line 231
def eql?(o)
  self == o
end
hash() click to toggle source

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

# File lib/onfido/models/check_response.rb, line 237
def hash
  [id, created_at, href, status, result, form_uri, results_uri, report_ids, sandbox, paused, version].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/check_response.rb, line 181
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
result=(result) click to toggle source

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

# File lib/onfido/models/check_response.rb, line 203
def result=(result)
  validator = EnumAttributeValidator.new('String', ["clear", "consider", "unknown_default_open_api"])
  unless validator.valid?(result)
    fail ArgumentError, "invalid value for \"result\", must be one of #{validator.allowable_values}."
  end
  @result = result
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/check_response.rb, line 315
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/check_response.rb, line 321
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/check_response.rb, line 309
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/check_response.rb, line 193
def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @id.nil?
  result_validator = EnumAttributeValidator.new('String', ["clear", "consider", "unknown_default_open_api"])
  return false unless result_validator.valid?(@result)
  true
end