class Trulioo::BusinessSearchRequestBusinessSearchModel

Business Object

Attributes

business_name[RW]

Name of the business to be verified

duns_number[RW]

DUNS number of the business to be verified

jurisdiction_of_incorporation[RW]

Jurisdiction Of Incorporation of the business to be verified

location[RW]
website[RW]

Website of the business

Public Class Methods

acceptable_attributes() click to toggle source

Returns all the JSON keys this model knows about

# File lib/trulioo_sdk/models/business_search_request_business_search_model.rb, line 41
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/trulioo_sdk/models/business_search_request_business_search_model.rb, line 30
def self.attribute_map
  {
    :'business_name' => :'BusinessName',
    :'website' => :'Website',
    :'jurisdiction_of_incorporation' => :'JurisdictionOfIncorporation',
    :'duns_number' => :'DUNSNumber',
    :'location' => :'Location'
  }
end
build_from_hash(attributes) click to toggle source

:nocov: Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/trulioo_sdk/models/business_search_request_business_search_model.rb, line 235
def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end
new(attributes = {}) click to toggle source

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

# File lib/trulioo_sdk/models/business_search_request_business_search_model.rb, line 64
def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Trulioo::BusinessSearchRequestBusinessSearchModel` 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 `Trulioo::BusinessSearchRequestBusinessSearchModel`. 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?(:'business_name')
    self.business_name = attributes[:'business_name']
  end

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

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

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

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

List of attributes with nullable: true

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

Attribute type mapping.

# File lib/trulioo_sdk/models/business_search_request_business_search_model.rb, line 46
def self.openapi_types
  {
    :'business_name' => :'String',
    :'website' => :'String',
    :'jurisdiction_of_incorporation' => :'String',
    :'duns_number' => :'String',
    :'location' => :'Location'
  }
end

Public Instance Methods

==(o) click to toggle source

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

# File lib/trulioo_sdk/models/business_search_request_business_search_model.rb, line 209
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      business_name == o.business_name &&
      website == o.website &&
      jurisdiction_of_incorporation == o.jurisdiction_of_incorporation &&
      duns_number == o.duns_number &&
      location == o.location
end
_deserialize(type, value) click to toggle source

:nocov: Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data

# File lib/trulioo_sdk/models/business_search_request_business_search_model.rb, line 269
def _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 = Trulioo.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end
_to_hash(value) click to toggle source

:nocov: 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/trulioo_sdk/models/business_search_request_business_search_model.rb, line 348
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

:nocov: Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/trulioo_sdk/models/business_search_request_business_search_model.rb, line 244
def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{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[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
  end

  self
end
business_name=(business_name) click to toggle source

Custom attribute writer method with validation @param [Object] business_name Value to be assigned

# File lib/trulioo_sdk/models/business_search_request_business_search_model.rb, line 153
def business_name=(business_name)
  if !business_name.nil? && business_name.to_s.length > 250
    fail ArgumentError, 'invalid value for "business_name", the character length must be smaller than or equal to 250.'
  end

  if !business_name.nil? && business_name.to_s.length < 0
    fail ArgumentError, 'invalid value for "business_name", the character length must be great than or equal to 0.'
  end

  @business_name = business_name
end
duns_number=(duns_number) click to toggle source

Custom attribute writer method with validation @param [Object] duns_number Value to be assigned

# File lib/trulioo_sdk/models/business_search_request_business_search_model.rb, line 195
def duns_number=(duns_number)
  if !duns_number.nil? && duns_number.to_s.length > 250
    fail ArgumentError, 'invalid value for "duns_number", the character length must be smaller than or equal to 250.'
  end

  if !duns_number.nil? && duns_number.to_s.length < 0
    fail ArgumentError, 'invalid value for "duns_number", the character length must be great than or equal to 0.'
  end

  @duns_number = duns_number
end
eql?(o) click to toggle source

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

# File lib/trulioo_sdk/models/business_search_request_business_search_model.rb, line 221
def eql?(o)
  self == o
end
hash() click to toggle source

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

# File lib/trulioo_sdk/models/business_search_request_business_search_model.rb, line 227
def hash
  [business_name, website, jurisdiction_of_incorporation, duns_number, location].hash
end
jurisdiction_of_incorporation=(jurisdiction_of_incorporation) click to toggle source

Custom attribute writer method with validation @param [Object] jurisdiction_of_incorporation Value to be assigned

# File lib/trulioo_sdk/models/business_search_request_business_search_model.rb, line 181
def jurisdiction_of_incorporation=(jurisdiction_of_incorporation)
  if !jurisdiction_of_incorporation.nil? && jurisdiction_of_incorporation.to_s.length > 250
    fail ArgumentError, 'invalid value for "jurisdiction_of_incorporation", the character length must be smaller than or equal to 250.'
  end

  if !jurisdiction_of_incorporation.nil? && jurisdiction_of_incorporation.to_s.length < 0
    fail ArgumentError, 'invalid value for "jurisdiction_of_incorporation", the character length must be great than or equal to 0.'
  end

  @jurisdiction_of_incorporation = jurisdiction_of_incorporation
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/trulioo_sdk/models/business_search_request_business_search_model.rb, line 100
def list_invalid_properties
  invalid_properties = Array.new
  if !@business_name.nil? && @business_name.to_s.length > 250
    invalid_properties.push('invalid value for "business_name", the character length must be smaller than or equal to 250.')
  end

  if !@business_name.nil? && @business_name.to_s.length < 0
    invalid_properties.push('invalid value for "business_name", the character length must be great than or equal to 0.')
  end

  if !@website.nil? && @website.to_s.length > 250
    invalid_properties.push('invalid value for "website", the character length must be smaller than or equal to 250.')
  end

  if !@website.nil? && @website.to_s.length < 0
    invalid_properties.push('invalid value for "website", the character length must be great than or equal to 0.')
  end

  if !@jurisdiction_of_incorporation.nil? && @jurisdiction_of_incorporation.to_s.length > 250
    invalid_properties.push('invalid value for "jurisdiction_of_incorporation", the character length must be smaller than or equal to 250.')
  end

  if !@jurisdiction_of_incorporation.nil? && @jurisdiction_of_incorporation.to_s.length < 0
    invalid_properties.push('invalid value for "jurisdiction_of_incorporation", the character length must be great than or equal to 0.')
  end

  if !@duns_number.nil? && @duns_number.to_s.length > 250
    invalid_properties.push('invalid value for "duns_number", the character length must be smaller than or equal to 250.')
  end

  if !@duns_number.nil? && @duns_number.to_s.length < 0
    invalid_properties.push('invalid value for "duns_number", the character length must be great than or equal to 0.')
  end

  invalid_properties
end
to_body() click to toggle source

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

# File lib/trulioo_sdk/models/business_search_request_business_search_model.rb, line 320
def to_body
  to_hash
end
to_hash() click to toggle source

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

# File lib/trulioo_sdk/models/business_search_request_business_search_model.rb, line 328
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

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

# File lib/trulioo_sdk/models/business_search_request_business_search_model.rb, line 312
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/trulioo_sdk/models/business_search_request_business_search_model.rb, line 139
def valid?
  return false if !@business_name.nil? && @business_name.to_s.length > 250
  return false if !@business_name.nil? && @business_name.to_s.length < 0
  return false if !@website.nil? && @website.to_s.length > 250
  return false if !@website.nil? && @website.to_s.length < 0
  return false if !@jurisdiction_of_incorporation.nil? && @jurisdiction_of_incorporation.to_s.length > 250
  return false if !@jurisdiction_of_incorporation.nil? && @jurisdiction_of_incorporation.to_s.length < 0
  return false if !@duns_number.nil? && @duns_number.to_s.length > 250
  return false if !@duns_number.nil? && @duns_number.to_s.length < 0
  true
end
website=(website) click to toggle source

Custom attribute writer method with validation @param [Object] website Value to be assigned

# File lib/trulioo_sdk/models/business_search_request_business_search_model.rb, line 167
def website=(website)
  if !website.nil? && website.to_s.length > 250
    fail ArgumentError, 'invalid value for "website", the character length must be smaller than or equal to 250.'
  end

  if !website.nil? && website.to_s.length < 0
    fail ArgumentError, 'invalid value for "website", the character length must be great than or equal to 0.'
  end

  @website = website
end