Class: Trulioo::BusinessRegistrationNumber

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ BusinessRegistrationNumber

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
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
 
# File 'lib/trulioo_sdk/models/business_registration_number.rb', line 74

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

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

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

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

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

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

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

Instance Attribute Details

#country ⇒ Object

Country to which the business registration number applies



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

def country
  @country
end

#description ⇒ Object

Brief description of the business registration number



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

def description
  @description
end

#jurisdiction ⇒ Object

Optional jurisdiction to which the business registration number applies



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

def jurisdiction
  @jurisdiction
end

#masks ⇒ Object

The mask(s) describing this business registration number



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

def masks
  @masks
end

#name ⇒ Object

The name of the business registration number



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

def name
  @name
end

#supported ⇒ Object

Whether the business registration number is supported by Trulioo’s systems



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

def supported
  @supported
end

#type ⇒ Object

The specified type of this business registration number



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

def type
  @type
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



49
50
51
 
# File 'lib/trulioo_sdk/models/business_registration_number.rb', line 49

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



36
37
38
39
40
41
42
43
44
45
46
 
# File 'lib/trulioo_sdk/models/business_registration_number.rb', line 36

def self.attribute_map
  {
    :'name' => :'Name',
    :'description' => :'Description',
    :'country' => :'Country',
    :'jurisdiction' => :'Jurisdiction',
    :'supported' => :'Supported',
    :'type' => :'Type',
    :'masks' => :'Masks'
  }
end

.build_from_hash(attributes) ⇒ Object

:nocov: Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



281
282
283
 
# File 'lib/trulioo_sdk/models/business_registration_number.rb', line 281

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



67
68
69
70
 
# File 'lib/trulioo_sdk/models/business_registration_number.rb', line 67

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

.openapi_types ⇒ Object

Attribute type mapping.



54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/trulioo_sdk/models/business_registration_number.rb', line 54

def self.openapi_types
  {
    :'name' => :'String',
    :'description' => :'String',
    :'country' => :'String',
    :'jurisdiction' => :'String',
    :'supported' => :'Boolean',
    :'type' => :'String',
    :'masks' => :'Array<BusinessRegistrationNumberMask>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



253
254
255
256
257
258
259
260
261
262
263
 
# File 'lib/trulioo_sdk/models/business_registration_number.rb', line 253

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      name == o.name &&
      description == o.description &&
      country == o.country &&
      jurisdiction == o.jurisdiction &&
      supported == o.supported &&
      type == o.type &&
      masks == o.masks
end

#_deserialize(type, value) ⇒ Object

:nocov: Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
 
# File 'lib/trulioo_sdk/models/business_registration_number.rb', line 315

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:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



394
395
396
397
398
399
400
401
402
403
404
405
406
 
# File 'lib/trulioo_sdk/models/business_registration_number.rb', line 394

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:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
 
# File 'lib/trulioo_sdk/models/business_registration_number.rb', line 290

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:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


267
268
269
 
# File 'lib/trulioo_sdk/models/business_registration_number.rb', line 267

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



273
274
275
 
# File 'lib/trulioo_sdk/models/business_registration_number.rb', line 273

def hash
  [name, description, country, jurisdiction, supported, type, masks].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



120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
 
# File 'lib/trulioo_sdk/models/business_registration_number.rb', line 120

def list_invalid_properties
  invalid_properties = Array.new
  if !@name.nil? && @name.to_s.length > 512
    invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 512.')
  end

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

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

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

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

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

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

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

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

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

  invalid_properties
end

#to_body ⇒ Hash

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

Returns:

  • (Hash) —

    Returns the object in the form of hash



366
367
368
 
# File 'lib/trulioo_sdk/models/business_registration_number.rb', line 366

def to_body
  to_hash
end

#to_hash ⇒ Hash

:nocov: Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



374
375
376
377
378
379
380
381
382
383
384
385
386
 
# File 'lib/trulioo_sdk/models/business_registration_number.rb', line 374

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) —

    String presentation of the object



358
359
360
 
# File 'lib/trulioo_sdk/models/business_registration_number.rb', line 358

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

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

Returns:

  • (Boolean) —

    true if the model is valid



167
168
169
170
171
172
173
174
175
176
177
178
179
 
# File 'lib/trulioo_sdk/models/business_registration_number.rb', line 167

def valid?
  return false if !@name.nil? && @name.to_s.length > 512
  return false if !@name.nil? && @name.to_s.length < 0
  return false if !@description.nil? && @description.to_s.length > 512
  return false if !@description.nil? && @description.to_s.length < 0
  return false if !@country.nil? && @country.to_s.length > 512
  return false if !@country.nil? && @country.to_s.length < 0
  return false if !@jurisdiction.nil? && @jurisdiction.to_s.length > 512
  return false if !@jurisdiction.nil? && @jurisdiction.to_s.length < 0
  return false if !@type.nil? && @type.to_s.length > 512
  return false if !@type.nil? && @type.to_s.length < 0
  true
end