Class: Onfido::Check

Inherits:
Object
  • Object
show all
Defined in:
lib/onfido/models/check.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Check

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
207
208
209
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
 
# File 'lib/onfido/models/check.rb', line 154

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

  if attributes.key?(:'applicant_id')
    self.applicant_id = attributes[:'applicant_id']
  else
    self.applicant_id = nil
  end

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

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

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

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

  if attributes.key?(:'id')
    self.id = attributes[:'id']
  else
    self.id = nil
  end

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#applicant_id ⇒ Object

The ID of the applicant to do the check on.



22
23
24
 
# File 'lib/onfido/models/check.rb', line 22

def applicant_id
  @applicant_id
end

#applicant_provides_data ⇒ Object

Send an applicant form to applicant to complete to proceed with check. Defaults to false.



25
26
27
 
# File 'lib/onfido/models/check.rb', line 25

def applicant_provides_data
  @applicant_provides_data
end

#created_at ⇒ Object

The date and time when this check was created.



39
40
41
 
# File 'lib/onfido/models/check.rb', line 39

def created_at
  @created_at
end

#form_uri ⇒ Object

A link to the applicant form, if ‘applicant_provides_data` is `true`.



50
51
52
 
# File 'lib/onfido/models/check.rb', line 50

def form_uri
  @form_uri
end

#href ⇒ Object

The uri of this resource.



42
43
44
 
# File 'lib/onfido/models/check.rb', line 42

def href
  @href
end

#id ⇒ Object

The unique identifier for the check.



36
37
38
 
# File 'lib/onfido/models/check.rb', line 36

def id
  @id
end

#paused ⇒ Object

Returns the value of attribute paused.



61
62
63
 
# File 'lib/onfido/models/check.rb', line 61

def paused
  @paused
end

#privacy_notices_read_consent_given ⇒ Object

Returns the value of attribute privacy_notices_read_consent_given.



33
34
35
 
# File 'lib/onfido/models/check.rb', line 33

def privacy_notices_read_consent_given
  @privacy_notices_read_consent_given
end

#redirect_uri ⇒ Object

For checks where ‘applicant_provides_data` is `true`, redirect to this URI when the applicant has submitted their data.



31
32
33
 
# File 'lib/onfido/models/check.rb', line 31

def redirect_uri
  @redirect_uri
end

#report_ids ⇒ Object

An array of report ids.



56
57
58
 
# File 'lib/onfido/models/check.rb', line 56

def report_ids
  @report_ids
end

#result ⇒ Object

The overall result of the check, based on the results of the constituent reports.



47
48
49
 
# File 'lib/onfido/models/check.rb', line 47

def result
  @result
end

#results_uri ⇒ Object

A link to the corresponding results page on the Onfido dashboard.



53
54
55
 
# File 'lib/onfido/models/check.rb', line 53

def results_uri
  @results_uri
end

#sandbox ⇒ Object

Indicates whether the object was created in the sandbox or not.



59
60
61
 
# File 'lib/onfido/models/check.rb', line 59

def sandbox
  @sandbox
end

#status ⇒ Object

Returns the value of attribute status.



44
45
46
 
# File 'lib/onfido/models/check.rb', line 44

def status
  @status
end

#tags ⇒ Object

Array of tags being assigned to this check.



28
29
30
 
# File 'lib/onfido/models/check.rb', line 28

def tags
  @tags
end

#version ⇒ Object

Returns the value of attribute version.



63
64
65
 
# File 'lib/onfido/models/check.rb', line 63

def version
  @version
end

#webhook_ids ⇒ Object

An array of webhook ids describing which webhooks to trigger for this check.



19
20
21
 
# File 'lib/onfido/models/check.rb', line 19

def webhook_ids
  @webhook_ids
end

Class Method Details

._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



346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
 
# File 'lib/onfido/models/check.rb', line 346

def self._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 = Onfido.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



111
112
113
 
# File 'lib/onfido/models/check.rb', line 111

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/onfido/models/check.rb', line 88

def self.attribute_map
  {
    :'webhook_ids' => :'webhook_ids',
    :'applicant_id' => :'applicant_id',
    :'applicant_provides_data' => :'applicant_provides_data',
    :'tags' => :'tags',
    :'redirect_uri' => :'redirect_uri',
    :'privacy_notices_read_consent_given' => :'privacy_notices_read_consent_given',
    :'id' => :'id',
    :'created_at' => :'created_at',
    :'href' => :'href',
    :'status' => :'status',
    :'result' => :'result',
    :'form_uri' => :'form_uri',
    :'results_uri' => :'results_uri',
    :'report_ids' => :'report_ids',
    :'sandbox' => :'sandbox',
    :'paused' => :'paused',
    :'version' => :'version'
  }
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



322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
 
# File 'lib/onfido/models/check.rb', line 322

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{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[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



145
146
147
148
149
150
 
# File 'lib/onfido/models/check.rb', line 145

def self.openapi_all_of
  [
  :'CheckResponse',
  :'CheckShared'
  ]
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



139
140
141
142
 
# File 'lib/onfido/models/check.rb', line 139

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

.openapi_types ⇒ Object

Attribute type mapping.



116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
 
# File 'lib/onfido/models/check.rb', line 116

def self.openapi_types
  {
    :'webhook_ids' => :'Array<String>',
    :'applicant_id' => :'String',
    :'applicant_provides_data' => :'Boolean',
    :'tags' => :'Array<String>',
    :'redirect_uri' => :'String',
    :'privacy_notices_read_consent_given' => :'Boolean',
    :'id' => :'String',
    :'created_at' => :'Time',
    :'href' => :'String',
    :'status' => :'CheckStatus',
    :'result' => :'String',
    :'form_uri' => :'String',
    :'results_uri' => :'String',
    :'report_ids' => :'Array<String>',
    :'sandbox' => :'Boolean',
    :'paused' => :'Boolean',
    :'version' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
 
# File 'lib/onfido/models/check.rb', line 285

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      webhook_ids == o.webhook_ids &&
      applicant_id == o.applicant_id &&
      applicant_provides_data == o.applicant_provides_data &&
      tags == o.tags &&
      redirect_uri == o.redirect_uri &&
      privacy_notices_read_consent_given == o.privacy_notices_read_consent_given &&
      id == o.id &&
      created_at == o.created_at &&
      href == o.href &&
      status == o.status &&
      result == o.result &&
      form_uri == o.form_uri &&
      results_uri == o.results_uri &&
      report_ids == o.report_ids &&
      sandbox == o.sandbox &&
      paused == o.paused &&
      version == o.version
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



417
418
419
420
421
422
423
424
425
426
427
428
429
 
# File 'lib/onfido/models/check.rb', line 417

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


309
310
311
 
# File 'lib/onfido/models/check.rb', line 309

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



315
316
317
 
# File 'lib/onfido/models/check.rb', line 315

def hash
  [webhook_ids, applicant_id, applicant_provides_data, tags, redirect_uri, privacy_notices_read_consent_given, id, created_at, href, status, result, form_uri, results_uri, report_ids, sandbox, paused, version].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



248
249
250
251
252
253
254
255
256
257
258
259
260
 
# File 'lib/onfido/models/check.rb', line 248

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @applicant_id.nil?
    invalid_properties.push('invalid value for "applicant_id", applicant_id cannot be nil.')
  end

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



393
394
395
 
# File 'lib/onfido/models/check.rb', line 393

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



399
400
401
402
403
404
405
406
407
408
409
410
411
 
# File 'lib/onfido/models/check.rb', line 399

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



387
388
389
 
# File 'lib/onfido/models/check.rb', line 387

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



264
265
266
267
268
269
270
271
 
# File 'lib/onfido/models/check.rb', line 264

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @applicant_id.nil?
  return false if @id.nil?
  result_validator = EnumAttributeValidator.new('String', ["clear", "consider", "unknown_default_open_api"])
  return false unless result_validator.valid?(@result)
  true
end