Class: CybridApiBank::IdentityVerificationBankModel

Inherits:
Object
  • Object
show all
Defined in:
lib/cybrid_api_bank_ruby/models/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 = {}) ⇒ IdentityVerificationBankModel

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
142
143
144
145
146
147
148
149
150
151
152
153
 
# File 'lib/cybrid_api_bank_ruby/models/identity_verification_bank_model.rb', line 107

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

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

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

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

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

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

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

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

Instance Attribute Details

#created_at ⇒ Object

ISO8601 datetime the customer was created at.



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

def created_at
  @created_at
end

#customer_guid ⇒ Object

The customer’s identifier.



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

def customer_guid
  @customer_guid
end

#failure_codes ⇒ Object

The reason codes explaining the outcome.



40
41
42
 
# File 'lib/cybrid_api_bank_ruby/models/identity_verification_bank_model.rb', line 40

def failure_codes
  @failure_codes
end

#guid ⇒ Object

Auto-generated unique identifier for the identity verification.



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

def guid
  @guid
end

#method ⇒ Object

The identity verification method.



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

def method
  @method
end

#outcome ⇒ Object

The outcome of the verification process.



37
38
39
 
# File 'lib/cybrid_api_bank_ruby/models/identity_verification_bank_model.rb', line 37

def outcome
  @outcome
end

#state ⇒ Object

The state of the verification process.



34
35
36
 
# File 'lib/cybrid_api_bank_ruby/models/identity_verification_bank_model.rb', line 34

def state
  @state
end

#type ⇒ Object

The type of identity verification.



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

def type
  @type
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



79
80
81
 
# File 'lib/cybrid_api_bank_ruby/models/identity_verification_bank_model.rb', line 79

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/cybrid_api_bank_ruby/models/identity_verification_bank_model.rb', line 65

def self.attribute_map
  {
    :'guid' => :'guid',
    :'customer_guid' => :'customer_guid',
    :'type' => :'type',
    :'method' => :'method',
    :'created_at' => :'created_at',
    :'state' => :'state',
    :'outcome' => :'outcome',
    :'failure_codes' => :'failure_codes'
  }
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



294
295
296
 
# File 'lib/cybrid_api_bank_ruby/models/identity_verification_bank_model.rb', line 294

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



98
99
100
101
102
103
 
# File 'lib/cybrid_api_bank_ruby/models/identity_verification_bank_model.rb', line 98

def self.openapi_nullable
  Set.new([
    :'outcome',
    :'failure_codes'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/cybrid_api_bank_ruby/models/identity_verification_bank_model.rb', line 84

def self.openapi_types
  {
    :'guid' => :'String',
    :'customer_guid' => :'String',
    :'type' => :'String',
    :'method' => :'String',
    :'created_at' => :'Time',
    :'state' => :'String',
    :'outcome' => :'String',
    :'failure_codes' => :'Array<String>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



266
267
268
269
270
271
272
273
274
275
276
277
 
# File 'lib/cybrid_api_bank_ruby/models/identity_verification_bank_model.rb', line 266

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      guid == o.guid &&
      customer_guid == o.customer_guid &&
      type == o.type &&
      method == o.method &&
      created_at == o.created_at &&
      state == o.state &&
      outcome == o.outcome &&
      failure_codes == o.failure_codes
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



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
353
354
355
356
357
358
359
360
361
362
 
# File 'lib/cybrid_api_bank_ruby/models/identity_verification_bank_model.rb', line 325

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



396
397
398
399
400
401
402
403
404
405
406
407
408
 
# File 'lib/cybrid_api_bank_ruby/models/identity_verification_bank_model.rb', line 396

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



301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
 
# File 'lib/cybrid_api_bank_ruby/models/identity_verification_bank_model.rb', line 301

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


281
282
283
 
# File 'lib/cybrid_api_bank_ruby/models/identity_verification_bank_model.rb', line 281

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



287
288
289
 
# File 'lib/cybrid_api_bank_ruby/models/identity_verification_bank_model.rb', line 287

def hash
  [guid, customer_guid, type, method, created_at, state, outcome, failure_codes].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



157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
 
# File 'lib/cybrid_api_bank_ruby/models/identity_verification_bank_model.rb', line 157

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

  if !@guid.nil? && @guid.to_s.length < 32
    invalid_properties.push('invalid value for "guid", the character length must be great 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 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

  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



372
373
374
 
# File 'lib/cybrid_api_bank_ruby/models/identity_verification_bank_model.rb', line 372

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



378
379
380
381
382
383
384
385
386
387
388
389
390
 
# File 'lib/cybrid_api_bank_ruby/models/identity_verification_bank_model.rb', line 378

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



366
367
368
 
# File 'lib/cybrid_api_bank_ruby/models/identity_verification_bank_model.rb', line 366

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



180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
 
# File 'lib/cybrid_api_bank_ruby/models/identity_verification_bank_model.rb', line 180

def valid?
  return false if !@guid.nil? && @guid.to_s.length > 32
  return false if !@guid.nil? && @guid.to_s.length < 32
  return false if !@customer_guid.nil? && @customer_guid.to_s.length > 32
  return false if !@customer_guid.nil? && @customer_guid.to_s.length < 32
  type_validator = EnumAttributeValidator.new('String', ["kyc", "bank_account"])
  return false unless type_validator.valid?(@type)
  method_validator = EnumAttributeValidator.new('String', ["id_and_selfie", "attested", "plaid_identity_match"])
  return false unless method_validator.valid?(@method)
  state_validator = EnumAttributeValidator.new('String', ["storing", "waiting", "expired", "completed"])
  return false unless state_validator.valid?(@state)
  outcome_validator = EnumAttributeValidator.new('String', ["passed", "failed"])
  return false unless outcome_validator.valid?(@outcome)
  true
end