Class: CybridApiBank::IdentityVerificationWithDetailsBankModel

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ IdentityVerificationWithDetailsBankModel

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
# File 'lib/cybrid_api_bank_ruby/models/identity_verification_with_details_bank_model.rb', line 126

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

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

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

Instance Attribute Details

#created_atObject

ISO8601 datetime the customer was created at.



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

def created_at
  @created_at
end

#customer_guidObject

The customer’s identifier.



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

def customer_guid
  @customer_guid
end

#failure_codesObject

The reason codes explaining the outcome.



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

def failure_codes
  @failure_codes
end

#guidObject

Auto-generated unique identifier for the identity verification.



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

def guid
  @guid
end

#methodObject

The identity verification method.



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

def method
  @method
end

#outcomeObject

The outcome of the verification process.



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

def outcome
  @outcome
end

#persona_inquiry_idObject

The Persona identifier of the backing inquiry.



43
44
45
# File 'lib/cybrid_api_bank_ruby/models/identity_verification_with_details_bank_model.rb', line 43

def persona_inquiry_id
  @persona_inquiry_id
end

#persona_stateObject

The Persona state of the backing inquiry.



46
47
48
# File 'lib/cybrid_api_bank_ruby/models/identity_verification_with_details_bank_model.rb', line 46

def persona_state
  @persona_state
end

#stateObject

The state of the verification process.



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

def state
  @state
end

#typeObject

The type of identity verification.



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

def type
  @type
end

Class Method Details

.acceptable_attributesObject

Returns all the JSON keys this model knows about



87
88
89
# File 'lib/cybrid_api_bank_ruby/models/identity_verification_with_details_bank_model.rb', line 87

def self.acceptable_attributes
  attribute_map.values
end

.attribute_mapObject

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



71
72
73
74
75
76
77
78
79
80
81
82
83
84
# File 'lib/cybrid_api_bank_ruby/models/identity_verification_with_details_bank_model.rb', line 71

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',
    :'persona_inquiry_id' => :'persona_inquiry_id',
    :'persona_state' => :'persona_state'
  }
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



335
336
337
# File 'lib/cybrid_api_bank_ruby/models/identity_verification_with_details_bank_model.rb', line 335

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

.openapi_all_ofObject

List of class defined in allOf (OpenAPI v3)



117
118
119
120
121
122
# File 'lib/cybrid_api_bank_ruby/models/identity_verification_with_details_bank_model.rb', line 117

def self.openapi_all_of
  [
  :'IdentityVerificationBankModel',
  :'IdentityVerificationWithDetailsAllOfBankModel'
  ]
end

.openapi_nullableObject

List of attributes with nullable: true



108
109
110
111
112
113
114
# File 'lib/cybrid_api_bank_ruby/models/identity_verification_with_details_bank_model.rb', line 108

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

.openapi_typesObject

Attribute type mapping.



92
93
94
95
96
97
98
99
100
101
102
103
104
105
# File 'lib/cybrid_api_bank_ruby/models/identity_verification_with_details_bank_model.rb', line 92

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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



305
306
307
308
309
310
311
312
313
314
315
316
317
318
# File 'lib/cybrid_api_bank_ruby/models/identity_verification_with_details_bank_model.rb', line 305

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 &&
      persona_inquiry_id == o.persona_inquiry_id &&
      persona_state == o.persona_state
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



366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
# File 'lib/cybrid_api_bank_ruby/models/identity_verification_with_details_bank_model.rb', line 366

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



437
438
439
440
441
442
443
444
445
446
447
448
449
# File 'lib/cybrid_api_bank_ruby/models/identity_verification_with_details_bank_model.rb', line 437

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



342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
# File 'lib/cybrid_api_bank_ruby/models/identity_verification_with_details_bank_model.rb', line 342

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


322
323
324
# File 'lib/cybrid_api_bank_ruby/models/identity_verification_with_details_bank_model.rb', line 322

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code



328
329
330
# File 'lib/cybrid_api_bank_ruby/models/identity_verification_with_details_bank_model.rb', line 328

def hash
  [guid, customer_guid, type, method, created_at, state, outcome, failure_codes, persona_inquiry_id, persona_state].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons



184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
# File 'lib/cybrid_api_bank_ruby/models/identity_verification_with_details_bank_model.rb', line 184

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_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



413
414
415
# File 'lib/cybrid_api_bank_ruby/models/identity_verification_with_details_bank_model.rb', line 413

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



419
420
421
422
423
424
425
426
427
428
429
430
431
# File 'lib/cybrid_api_bank_ruby/models/identity_verification_with_details_bank_model.rb', line 419

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



407
408
409
# File 'lib/cybrid_api_bank_ruby/models/identity_verification_with_details_bank_model.rb', line 407

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



207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
# File 'lib/cybrid_api_bank_ruby/models/identity_verification_with_details_bank_model.rb', line 207

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"])
  return false unless type_validator.valid?(@type)
  method_validator = EnumAttributeValidator.new('String', ["id_and_selfie", "attested"])
  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)
  persona_state_validator = EnumAttributeValidator.new('String', ["waiting", "pending", "reviewing", "processing", "expired", "completed", "unknown"])
  return false unless persona_state_validator.valid?(@persona_state)
  true
end