Class: Plaid::IdentityVerificationStepSummary

Inherits:
Object
  • Object
show all
Defined in:
lib/plaid/models/identity_verification_step_summary.rb

Overview

Each step will be one of the following values: ‘active` - This step is the user’s current step. They are either in the process of completing this step, or they recently closed their Identity Verification attempt while in the middle of this step. Only one step will be marked as ‘active` at any given point. `success` - The Identity Verification attempt has completed this step. `failed` - The user failed this step. This can either call the user to fail the session as a whole, or cause them to fallback to another step depending on how the Identity Verification template is configured. A failed step does not imply a failed session. `waiting_for_prerequisite` - The user needs to complete another step first, before they progress to this step. This step may never run, depending on if the user fails an earlier step or if the step is only run as a fallback. `not_applicable` - This step will not be run for this session. `skipped` - The retry instructions that created this Identity Verification attempt specified that this step should be skipped. `expired` - This step had not yet been completed when the Identity Verification attempt as a whole expired. `canceled` - The Identity Verification attempt was canceled before the user completed this step. `pending_review` - The Identity Verification attempt template was configured to perform a screening that had one or more hits needing review. `manually_approved` - The step was manually overridden to pass by a team member in the dashboard. `manually_rejected` - The step was manually overridden to fail by a team member in the dashboard.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ IdentityVerificationStepSummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/plaid/models/identity_verification_step_summary.rb', line 94

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

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

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

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

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

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

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

Instance Attribute Details

#accept_tos ⇒ Object

Returns the value of attribute accept_tos.



19
20
21
 
# File 'lib/plaid/models/identity_verification_step_summary.rb', line 19

def accept_tos
  @accept_tos
end

#documentary_verification ⇒ Object

Returns the value of attribute documentary_verification.



25
26
27
 
# File 'lib/plaid/models/identity_verification_step_summary.rb', line 25

def documentary_verification
  @documentary_verification
end

#kyc_check ⇒ Object

Returns the value of attribute kyc_check.



23
24
25
 
# File 'lib/plaid/models/identity_verification_step_summary.rb', line 23

def kyc_check
  @kyc_check
end

#risk_check ⇒ Object

Returns the value of attribute risk_check.



31
32
33
 
# File 'lib/plaid/models/identity_verification_step_summary.rb', line 31

def risk_check
  @risk_check
end

#selfie_check ⇒ Object

Returns the value of attribute selfie_check.



27
28
29
 
# File 'lib/plaid/models/identity_verification_step_summary.rb', line 27

def selfie_check
  @selfie_check
end

#verify_sms ⇒ Object

Returns the value of attribute verify_sms.



21
22
23
 
# File 'lib/plaid/models/identity_verification_step_summary.rb', line 21

def verify_sms
  @verify_sms
end

#watchlist_screening ⇒ Object

Returns the value of attribute watchlist_screening.



29
30
31
 
# File 'lib/plaid/models/identity_verification_step_summary.rb', line 29

def watchlist_screening
  @watchlist_screening
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



69
70
71
 
# File 'lib/plaid/models/identity_verification_step_summary.rb', line 69

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/plaid/models/identity_verification_step_summary.rb', line 56

def self.attribute_map
  {
    :'accept_tos' => :'accept_tos',
    :'verify_sms' => :'verify_sms',
    :'kyc_check' => :'kyc_check',
    :'documentary_verification' => :'documentary_verification',
    :'selfie_check' => :'selfie_check',
    :'watchlist_screening' => :'watchlist_screening',
    :'risk_check' => :'risk_check'
  }
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



213
214
215
 
# File 'lib/plaid/models/identity_verification_step_summary.rb', line 213

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



87
88
89
90
 
# File 'lib/plaid/models/identity_verification_step_summary.rb', line 87

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

.openapi_types ⇒ Object

Attribute type mapping.



74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/plaid/models/identity_verification_step_summary.rb', line 74

def self.openapi_types
  {
    :'accept_tos' => :'IdentityVerificationStepStatus',
    :'verify_sms' => :'IdentityVerificationStepStatus',
    :'kyc_check' => :'IdentityVerificationStepStatus',
    :'documentary_verification' => :'IdentityVerificationStepStatus',
    :'selfie_check' => :'IdentityVerificationStepStatus',
    :'watchlist_screening' => :'IdentityVerificationStepStatus',
    :'risk_check' => :'IdentityVerificationStepStatus'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



186
187
188
189
190
191
192
193
194
195
196
 
# File 'lib/plaid/models/identity_verification_step_summary.rb', line 186

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      accept_tos == o.accept_tos &&
      verify_sms == o.verify_sms &&
      kyc_check == o.kyc_check &&
      documentary_verification == o.documentary_verification &&
      selfie_check == o.selfie_check &&
      watchlist_screening == o.watchlist_screening &&
      risk_check == o.risk_check
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



244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
 
# File 'lib/plaid/models/identity_verification_step_summary.rb', line 244

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 = Plaid.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



315
316
317
318
319
320
321
322
323
324
325
326
327
 
# File 'lib/plaid/models/identity_verification_step_summary.rb', line 315

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



220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
 
# File 'lib/plaid/models/identity_verification_step_summary.rb', line 220

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


200
201
202
 
# File 'lib/plaid/models/identity_verification_step_summary.rb', line 200

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



206
207
208
 
# File 'lib/plaid/models/identity_verification_step_summary.rb', line 206

def hash
  [accept_tos, verify_sms, kyc_check, documentary_verification, selfie_check, watchlist_screening, risk_check].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



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
 
# File 'lib/plaid/models/identity_verification_step_summary.rb', line 138

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

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

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

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

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

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

  if @risk_check.nil?
    invalid_properties.push('invalid value for "risk_check", risk_check cannot be nil.')
  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



291
292
293
 
# File 'lib/plaid/models/identity_verification_step_summary.rb', line 291

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



297
298
299
300
301
302
303
304
305
306
307
308
309
 
# File 'lib/plaid/models/identity_verification_step_summary.rb', line 297

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



285
286
287
 
# File 'lib/plaid/models/identity_verification_step_summary.rb', line 285

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



173
174
175
176
177
178
179
180
181
182
 
# File 'lib/plaid/models/identity_verification_step_summary.rb', line 173

def valid?
  return false if @accept_tos.nil?
  return false if @verify_sms.nil?
  return false if @kyc_check.nil?
  return false if @documentary_verification.nil?
  return false if @selfie_check.nil?
  return false if @watchlist_screening.nil?
  return false if @risk_check.nil?
  true
end