Class: CybridApiBank::PostIdentityVerificationBankModel

Inherits:
Object
  • Object
show all
Defined in:
lib/cybrid_api_bank_ruby/models/post_identity_verification_bank_model.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PostIdentityVerificationBankModel

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'lib/cybrid_api_bank_ruby/models/post_identity_verification_bank_model.rb', line 138

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#address ⇒ Object

Returns the value of attribute address.



35
36
37
 
# File 'lib/cybrid_api_bank_ruby/models/post_identity_verification_bank_model.rb', line 35

def address
  @address
end

#counterparty_guid ⇒ Object

The counterparty’s identifier.



28
29
30
 
# File 'lib/cybrid_api_bank_ruby/models/post_identity_verification_bank_model.rb', line 28

def counterparty_guid
  @counterparty_guid
end

#country_code ⇒ Object

The ISO 3166 country 2-Alpha country the customer is being verified in; required when method is set to ‘id_and_selfie’. If not present, will default to the Bank’s configured country code.



31
32
33
 
# File 'lib/cybrid_api_bank_ruby/models/post_identity_verification_bank_model.rb', line 31

def country_code
  @country_code
end

#customer_guid ⇒ Object

The customer’s identifier.



25
26
27
 
# File 'lib/cybrid_api_bank_ruby/models/post_identity_verification_bank_model.rb', line 25

def customer_guid
  @customer_guid
end

#date_of_birth ⇒ Object

The customer’s date of birth; required when type is set to ‘kyc’ and method is set to ‘attested’.



38
39
40
 
# File 'lib/cybrid_api_bank_ruby/models/post_identity_verification_bank_model.rb', line 38

def date_of_birth
  @date_of_birth
end

#email_address ⇒ Object

The customer’s email address.



44
45
46
 
# File 'lib/cybrid_api_bank_ruby/models/post_identity_verification_bank_model.rb', line 44

def email_address
  @email_address
end

#expected_behaviours ⇒ Object

The optional expected behaviour to simulate.



53
54
55
 
# File 'lib/cybrid_api_bank_ruby/models/post_identity_verification_bank_model.rb', line 53

def expected_behaviours
  @expected_behaviours
end

#external_bank_account_guid ⇒ Object

The external bank account’s identifier. Required for ‘bank_account’ type.



50
51
52
 
# File 'lib/cybrid_api_bank_ruby/models/post_identity_verification_bank_model.rb', line 50

def 
  @external_bank_account_guid
end

#identification_numbers ⇒ Object

The customer’s identification numbers; required when type is set to ‘kyc’ and method is set to ‘attested’.



47
48
49
 
# File 'lib/cybrid_api_bank_ruby/models/post_identity_verification_bank_model.rb', line 47

def identification_numbers
  @identification_numbers
end

#method ⇒ Object

The identity verification method.



22
23
24
 
# File 'lib/cybrid_api_bank_ruby/models/post_identity_verification_bank_model.rb', line 22

def method
  @method
end

#name ⇒ Object

Returns the value of attribute name.



33
34
35
 
# File 'lib/cybrid_api_bank_ruby/models/post_identity_verification_bank_model.rb', line 33

def name
  @name
end

#phone_number ⇒ Object

The customer’s phone number.



41
42
43
 
# File 'lib/cybrid_api_bank_ruby/models/post_identity_verification_bank_model.rb', line 41

def phone_number
  @phone_number
end

#type ⇒ Object

The type of identity verification.



19
20
21
 
# File 'lib/cybrid_api_bank_ruby/models/post_identity_verification_bank_model.rb', line 19

def type
  @type
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



97
98
99
 
# File 'lib/cybrid_api_bank_ruby/models/post_identity_verification_bank_model.rb', line 97

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/cybrid_api_bank_ruby/models/post_identity_verification_bank_model.rb', line 78

def self.attribute_map
  {
    :'type' => :'type',
    :'method' => :'method',
    :'customer_guid' => :'customer_guid',
    :'counterparty_guid' => :'counterparty_guid',
    :'country_code' => :'country_code',
    :'name' => :'name',
    :'address' => :'address',
    :'date_of_birth' => :'date_of_birth',
    :'phone_number' => :'phone_number',
    :'email_address' => :'email_address',
    :'identification_numbers' => :'identification_numbers',
    :'external_bank_account_guid' => :'external_bank_account_guid',
    :'expected_behaviours' => :'expected_behaviours'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



386
387
388
 
# File 'lib/cybrid_api_bank_ruby/models/post_identity_verification_bank_model.rb', line 386

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



121
122
123
124
125
126
127
128
129
130
131
132
133
134
 
# File 'lib/cybrid_api_bank_ruby/models/post_identity_verification_bank_model.rb', line 121

def self.openapi_nullable
  Set.new([
    :'customer_guid',
    :'counterparty_guid',
    :'country_code',
    :'name',
    :'address',
    :'date_of_birth',
    :'phone_number',
    :'email_address',
    :'identification_numbers',
    :'external_bank_account_guid',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/cybrid_api_bank_ruby/models/post_identity_verification_bank_model.rb', line 102

def self.openapi_types
  {
    :'type' => :'String',
    :'method' => :'String',
    :'customer_guid' => :'String',
    :'counterparty_guid' => :'String',
    :'country_code' => :'String',
    :'name' => :'PostIdentityVerificationNameBankModel',
    :'address' => :'PostIdentityVerificationAddressBankModel',
    :'date_of_birth' => :'Date',
    :'phone_number' => :'String',
    :'email_address' => :'String',
    :'identification_numbers' => :'Array<PostIdentificationNumberBankModel>',
    :'external_bank_account_guid' => :'String',
    :'expected_behaviours' => :'Array<String>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
 
# File 'lib/cybrid_api_bank_ruby/models/post_identity_verification_bank_model.rb', line 353

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      type == o.type &&
      method == o.method &&
      customer_guid == o.customer_guid &&
      counterparty_guid == o.counterparty_guid &&
      country_code == o.country_code &&
      name == o.name &&
      address == o.address &&
      date_of_birth == o.date_of_birth &&
      phone_number == o.phone_number &&
      email_address == o.email_address &&
      identification_numbers == o.identification_numbers &&
       == o. &&
      expected_behaviours == o.expected_behaviours
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
 
# File 'lib/cybrid_api_bank_ruby/models/post_identity_verification_bank_model.rb', line 417

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 = CybridApiBank.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

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



488
489
490
491
492
493
494
495
496
497
498
499
500
 
# File 'lib/cybrid_api_bank_ruby/models/post_identity_verification_bank_model.rb', line 488

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

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
 
# File 'lib/cybrid_api_bank_ruby/models/post_identity_verification_bank_model.rb', line 393

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  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


373
374
375
 
# File 'lib/cybrid_api_bank_ruby/models/post_identity_verification_bank_model.rb', line 373

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



379
380
381
 
# File 'lib/cybrid_api_bank_ruby/models/post_identity_verification_bank_model.rb', line 379

def hash
  [type, method, customer_guid, counterparty_guid, country_code, name, address, date_of_birth, phone_number, email_address, identification_numbers, , expected_behaviours].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



210
211
212
213
214
215
216
217
218
219
220
221
222
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
 
# File 'lib/cybrid_api_bank_ruby/models/post_identity_verification_bank_model.rb', line 210

def list_invalid_properties
  invalid_properties = Array.new
  if @type.nil?
    invalid_properties.push('invalid value for "type", type cannot be nil.')
  end

  if @method.nil?
    invalid_properties.push('invalid value for "method", method cannot be nil.')
  end

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

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

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

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

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

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

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

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

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



464
465
466
 
# File 'lib/cybrid_api_bank_ruby/models/post_identity_verification_bank_model.rb', line 464

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



470
471
472
473
474
475
476
477
478
479
480
481
482
 
# File 'lib/cybrid_api_bank_ruby/models/post_identity_verification_bank_model.rb', line 470

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

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



458
459
460
 
# File 'lib/cybrid_api_bank_ruby/models/post_identity_verification_bank_model.rb', line 458

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



257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
 
# File 'lib/cybrid_api_bank_ruby/models/post_identity_verification_bank_model.rb', line 257

def valid?
  return false if @type.nil?
  type_validator = EnumAttributeValidator.new('String', ["kyc", "bank_account", "counterparty"])
  return false unless type_validator.valid?(@type)
  return false if @method.nil?
  method_validator = EnumAttributeValidator.new('String', ["attested", "document_submission", "id_and_selfie", "tax_id_and_selfie", "business_registration", "plaid_identity_match", "attested_ownership", "account_ownership", "watchlists"])
  return false unless method_validator.valid?(@method)
  return false if !@customer_guid.nil? && @customer_guid.to_s.length > 32
  return false if !@customer_guid.nil? && @customer_guid.to_s.length < 32
  return false if !@counterparty_guid.nil? && @counterparty_guid.to_s.length > 32
  return false if !@counterparty_guid.nil? && @counterparty_guid.to_s.length < 32
  return false if !@country_code.nil? && @country_code.to_s.length > 2
  return false if !@country_code.nil? && @country_code.to_s.length < 2
  return false if !@external_bank_account_guid.nil? && @external_bank_account_guid.to_s.length > 32
  return false if !@external_bank_account_guid.nil? && @external_bank_account_guid.to_s.length < 32
  true
end