class NucleusApi::Document

Document Object

Attributes

account_id[RW]

accountId

business_id[RW]

businessId

client_id[RW]

clientId

country_of_issue[RW]
create_date[RW]
doc_file[RW]
doc_image_back[RW]
doc_image_front[RW]
doc_name[RW]
doc_number[RW]
doc_size[RW]
doc_type[RW]
expiry_date[RW]
id[RW]
is_active[RW]
is_sensitive[RW]
is_verified[RW]
issue_date[RW]
metadata[RW]

metadata

secondary_id[RW]
state_of_issue[RW]
update_date[RW]
url_path[RW]

Public Class Methods

attribute_map() click to toggle source

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

# File lib/nucleus_api/models/document.rb, line 84
def self.attribute_map
  {
    :'account_id' => :'account_id',
    :'business_id' => :'business_id',
    :'client_id' => :'client_id',
    :'country_of_issue' => :'country_of_issue',
    :'create_date' => :'create_date',
    :'doc_file' => :'doc_file',
    :'doc_image_back' => :'doc_image_back',
    :'doc_image_front' => :'doc_image_front',
    :'doc_name' => :'doc_name',
    :'doc_number' => :'doc_number',
    :'doc_size' => :'doc_size',
    :'doc_type' => :'doc_type',
    :'expiry_date' => :'expiry_date',
    :'id' => :'id',
    :'is_active' => :'is_active',
    :'is_sensitive' => :'is_sensitive',
    :'is_verified' => :'is_verified',
    :'issue_date' => :'issue_date',
    :'metadata' => :'metadata',
    :'secondary_id' => :'secondary_id',
    :'state_of_issue' => :'state_of_issue',
    :'update_date' => :'update_date',
    :'url_path' => :'url_path'
  }
end
new(attributes = {}) click to toggle source

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

# File lib/nucleus_api/models/document.rb, line 143
def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  if attributes.has_key?(:'account_id')
    self.account_id = attributes[:'account_id']
  end

  if attributes.has_key?(:'business_id')
    self.business_id = attributes[:'business_id']
  end

  if attributes.has_key?(:'client_id')
    self.client_id = attributes[:'client_id']
  end

  if attributes.has_key?(:'country_of_issue')
    self.country_of_issue = attributes[:'country_of_issue']
  end

  if attributes.has_key?(:'create_date')
    self.create_date = attributes[:'create_date']
  end

  if attributes.has_key?(:'doc_file')
    self.doc_file = attributes[:'doc_file']
  end

  if attributes.has_key?(:'doc_image_back')
    self.doc_image_back = attributes[:'doc_image_back']
  end

  if attributes.has_key?(:'doc_image_front')
    self.doc_image_front = attributes[:'doc_image_front']
  end

  if attributes.has_key?(:'doc_name')
    self.doc_name = attributes[:'doc_name']
  end

  if attributes.has_key?(:'doc_number')
    self.doc_number = attributes[:'doc_number']
  end

  if attributes.has_key?(:'doc_size')
    self.doc_size = attributes[:'doc_size']
  end

  if attributes.has_key?(:'doc_type')
    self.doc_type = attributes[:'doc_type']
  end

  if attributes.has_key?(:'expiry_date')
    self.expiry_date = attributes[:'expiry_date']
  end

  if attributes.has_key?(:'id')
    self.id = attributes[:'id']
  end

  if attributes.has_key?(:'is_active')
    self.is_active = attributes[:'is_active']
  end

  if attributes.has_key?(:'is_sensitive')
    self.is_sensitive = attributes[:'is_sensitive']
  end

  if attributes.has_key?(:'is_verified')
    self.is_verified = attributes[:'is_verified']
  end

  if attributes.has_key?(:'issue_date')
    self.issue_date = attributes[:'issue_date']
  end

  if attributes.has_key?(:'metadata')
    if (value = attributes[:'metadata']).is_a?(Hash)
      self.metadata = value
    end
  end

  if attributes.has_key?(:'secondary_id')
    self.secondary_id = attributes[:'secondary_id']
  end

  if attributes.has_key?(:'state_of_issue')
    self.state_of_issue = attributes[:'state_of_issue']
  end

  if attributes.has_key?(:'update_date')
    self.update_date = attributes[:'update_date']
  end

  if attributes.has_key?(:'url_path')
    self.url_path = attributes[:'url_path']
  end
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/nucleus_api/models/document.rb, line 113
def self.swagger_types
  {
    :'account_id' => :'String',
    :'business_id' => :'String',
    :'client_id' => :'String',
    :'country_of_issue' => :'String',
    :'create_date' => :'DateTime',
    :'doc_file' => :'String',
    :'doc_image_back' => :'String',
    :'doc_image_front' => :'String',
    :'doc_name' => :'String',
    :'doc_number' => :'String',
    :'doc_size' => :'Integer',
    :'doc_type' => :'String',
    :'expiry_date' => :'Date',
    :'id' => :'String',
    :'is_active' => :'BOOLEAN',
    :'is_sensitive' => :'BOOLEAN',
    :'is_verified' => :'BOOLEAN',
    :'issue_date' => :'Date',
    :'metadata' => :'Hash<String, String>',
    :'secondary_id' => :'String',
    :'state_of_issue' => :'String',
    :'update_date' => :'DateTime',
    :'url_path' => :'String'
  }
end

Public Instance Methods

==(o) click to toggle source

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

# File lib/nucleus_api/models/document.rb, line 264
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      account_id == o.account_id &&
      business_id == o.business_id &&
      client_id == o.client_id &&
      country_of_issue == o.country_of_issue &&
      create_date == o.create_date &&
      doc_file == o.doc_file &&
      doc_image_back == o.doc_image_back &&
      doc_image_front == o.doc_image_front &&
      doc_name == o.doc_name &&
      doc_number == o.doc_number &&
      doc_size == o.doc_size &&
      doc_type == o.doc_type &&
      expiry_date == o.expiry_date &&
      id == o.id &&
      is_active == o.is_active &&
      is_sensitive == o.is_sensitive &&
      is_verified == o.is_verified &&
      issue_date == o.issue_date &&
      metadata == o.metadata &&
      secondary_id == o.secondary_id &&
      state_of_issue == o.state_of_issue &&
      update_date == o.update_date &&
      url_path == o.url_path
end
_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/nucleus_api/models/document.rb, line 326
def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    (value)
  when :Date
    (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
    temp_model = NucleusApi.const_get(type).new
    temp_model.build_from_hash(value)
  end
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/nucleus_api/models/document.rb, line 392
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
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/nucleus_api/models/document.rb, line 307
def build_from_hash(attributes)
  self.class.swagger_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]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end
eql?(o) click to toggle source

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

# File lib/nucleus_api/models/document.rb, line 294
def eql?(o)
  self == o
end
hash() click to toggle source

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

# File lib/nucleus_api/models/document.rb, line 300
def hash
  [account_id, business_id, client_id, country_of_issue, create_date, doc_file, doc_image_back, doc_image_front, doc_name, doc_number, doc_size, doc_type, expiry_date, id, is_active, is_sensitive, is_verified, issue_date, metadata, secondary_id, state_of_issue, update_date, url_path].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/nucleus_api/models/document.rb, line 246
def list_invalid_properties
  invalid_properties = Array.new
  if @doc_name.nil?
    invalid_properties.push('invalid value for "doc_name", doc_name cannot be nil.')
  end

  invalid_properties
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/nucleus_api/models/document.rb, line 373
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/nucleus_api/models/document.rb, line 379
def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    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/nucleus_api/models/document.rb, line 367
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/nucleus_api/models/document.rb, line 257
def valid?
  return false if @doc_name.nil?
  true
end