Class: Trulioo::Business

Inherits:
Object
  • Object
show all
Defined in:
lib/trulioo_sdk/models/business.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Business

Initializes the object

Parameters:

  • (defaults to: {})

    Model attributes in the form of hash



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
 
# File 'lib/trulioo_sdk/models/business.rb', line 89

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Trulioo::Business` 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::Business`. 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?(:'business_registration_number')
    self.business_registration_number = attributes[:'business_registration_number']
  end

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

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

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

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

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

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

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

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

Instance Attribute Details

#business_name ⇒ Object

Name of the business to be verified



15
16
17
 
# File 'lib/trulioo_sdk/models/business.rb', line 15

def business_name
  @business_name
end

#business_registration_number ⇒ Object

Registration number of business to be verified



18
19
20
 
# File 'lib/trulioo_sdk/models/business.rb', line 18

def business_registration_number
  @business_registration_number
end

#day_of_incorporation ⇒ Object

Day of incorporation of the business to be verified



21
22
23
 
# File 'lib/trulioo_sdk/models/business.rb', line 21

def day_of_incorporation
  @day_of_incorporation
end

#duns_number ⇒ Object

Duns Number



39
40
41
 
# File 'lib/trulioo_sdk/models/business.rb', line 39

def duns_number
  @duns_number
end

#entities ⇒ Object

Whether or not to retrieve entity detail



42
43
44
 
# File 'lib/trulioo_sdk/models/business.rb', line 42

def entities
  @entities
end

#financial_information_document ⇒ Object

Whether or not to retrieve financial information document



36
37
38
 
# File 'lib/trulioo_sdk/models/business.rb', line 36

def financial_information_document
  @financial_information_document
end

#jurisdiction_of_incorporation ⇒ Object

Jurisdiction Of Incorporation of the business to be verified



30
31
32
 
# File 'lib/trulioo_sdk/models/business.rb', line 30

def jurisdiction_of_incorporation
  @jurisdiction_of_incorporation
end

#month_of_incorporation ⇒ Object

Month of incorporation of the business to be verified



24
25
26
 
# File 'lib/trulioo_sdk/models/business.rb', line 24

def month_of_incorporation
  @month_of_incorporation
end

#shareholder_list_document ⇒ Object

Whether or not to retrieve shareholderList document



33
34
35
 
# File 'lib/trulioo_sdk/models/business.rb', line 33

def shareholder_list_document
  @shareholder_list_document
end

#year_of_incorporation ⇒ Object

Year of incorporation of the business to be verified



27
28
29
 
# File 'lib/trulioo_sdk/models/business.rb', line 27

def year_of_incorporation
  @year_of_incorporation
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



61
62
63
 
# File 'lib/trulioo_sdk/models/business.rb', line 61

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



45
46
47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/trulioo_sdk/models/business.rb', line 45

def self.attribute_map
  {
    :'business_name' => :'BusinessName',
    :'business_registration_number' => :'BusinessRegistrationNumber',
    :'day_of_incorporation' => :'DayOfIncorporation',
    :'month_of_incorporation' => :'MonthOfIncorporation',
    :'year_of_incorporation' => :'YearOfIncorporation',
    :'jurisdiction_of_incorporation' => :'JurisdictionOfIncorporation',
    :'shareholder_list_document' => :'ShareholderListDocument',
    :'financial_information_document' => :'FinancialInformationDocument',
    :'duns_number' => :'DunsNumber',
    :'entities' => :'Entities'
  }
end

.build_from_hash(attributes) ⇒ Object

:nocov: Builds the object from hash

Parameters:

  • Model attributes in the form of hash

Returns:

  • Returns the model itself



189
190
191
 
# File 'lib/trulioo_sdk/models/business.rb', line 189

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



82
83
84
85
 
# File 'lib/trulioo_sdk/models/business.rb', line 82

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/trulioo_sdk/models/business.rb', line 66

def self.openapi_types
  {
    :'business_name' => :'String',
    :'business_registration_number' => :'String',
    :'day_of_incorporation' => :'Integer',
    :'month_of_incorporation' => :'Integer',
    :'year_of_incorporation' => :'Integer',
    :'jurisdiction_of_incorporation' => :'String',
    :'shareholder_list_document' => :'Boolean',
    :'financial_information_document' => :'Boolean',
    :'duns_number' => :'String',
    :'entities' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • to be compared



158
159
160
161
162
163
164
165
166
167
168
169
170
171
 
# File 'lib/trulioo_sdk/models/business.rb', line 158

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      business_name == o.business_name &&
      business_registration_number == o.business_registration_number &&
      day_of_incorporation == o.day_of_incorporation &&
      month_of_incorporation == o.month_of_incorporation &&
      year_of_incorporation == o.year_of_incorporation &&
      jurisdiction_of_incorporation == o.jurisdiction_of_incorporation &&
      shareholder_list_document == o.shareholder_list_document &&
      financial_information_document == o.financial_information_document &&
      duns_number == o.duns_number &&
      entities == o.entities
end

#_deserialize(type, value) ⇒ Object

:nocov: Deserializes the data based on type

Parameters:

  • type Data type

  • value Value to be deserialized

Returns:

  • Deserialized data



223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
 
# File 'lib/trulioo_sdk/models/business.rb', line 223

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) ⇒ Hash

:nocov: Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • Any valid value

Returns:

  • Returns the value in the form of hash



302
303
304
305
306
307
308
309
310
311
312
313
314
 
# File 'lib/trulioo_sdk/models/business.rb', line 302

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) ⇒ Object

:nocov: Builds the object from hash

Parameters:

  • Model attributes in the form of hash

Returns:

  • Returns the model itself



198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
 
# File 'lib/trulioo_sdk/models/business.rb', line 198

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

#eql?(o) ⇒ Boolean

Parameters:

  • to be compared

Returns:

See Also:

  • `==` method


175
176
177
 
# File 'lib/trulioo_sdk/models/business.rb', line 175

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • Hash code



181
182
183
 
# File 'lib/trulioo_sdk/models/business.rb', line 181

def hash
  [business_name, business_registration_number, day_of_incorporation, month_of_incorporation, year_of_incorporation, jurisdiction_of_incorporation, shareholder_list_document, financial_information_document, duns_number, entities].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



145
146
147
148
 
# File 'lib/trulioo_sdk/models/business.rb', line 145

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_body ⇒ Hash

:nocov: to_body is an alias to to_hash (backward compatibility)

Returns:

  • Returns the object in the form of hash



274
275
276
 
# File 'lib/trulioo_sdk/models/business.rb', line 274

def to_body
  to_hash
end

#to_hash ⇒ Hash

:nocov: Returns the object in the form of hash

Returns:

  • Returns the object in the form of hash



282
283
284
285
286
287
288
289
290
291
292
293
294
 
# File 'lib/trulioo_sdk/models/business.rb', line 282

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 ⇒ String

:nocov: Returns the string representation of the object

Returns:

  • String presentation of the object



266
267
268
 
# File 'lib/trulioo_sdk/models/business.rb', line 266

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • true if the model is valid



152
153
154
 
# File 'lib/trulioo_sdk/models/business.rb', line 152

def valid?
  true
end