Class: Onfido::WebhookEventPayloadResource

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

Overview

The resource affected by this event.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ WebhookEventPayloadResource

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
 
# File 'lib/onfido/models/webhook_event_payload_resource.rb', line 125

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#applicant_id ⇒ Object

The unique identifier for the Applicant.



23
24
25
 
# File 'lib/onfido/models/webhook_event_payload_resource.rb', line 23

def applicant_id
  @applicant_id
end

#created_at ⇒ Object

The date and time when the resource was created.



26
27
28
 
# File 'lib/onfido/models/webhook_event_payload_resource.rb', line 26

def created_at
  @created_at
end

#customer_user_id ⇒ Object

Customer-provided user identifier.



64
65
66
 
# File 'lib/onfido/models/webhook_event_payload_resource.rb', line 64

def customer_user_id
  @customer_user_id
end

#dashboard_url ⇒ Object

The URL for viewing the resource on Onfido Dashboard.



32
33
34
 
# File 'lib/onfido/models/webhook_event_payload_resource.rb', line 32

def dashboard_url
  @dashboard_url
end

#error ⇒ Object

Error object that details why a Workflow Run is in Error status.



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

def error
  @error
end

#id ⇒ Object

The identifier of the resource.



20
21
22
 
# File 'lib/onfido/models/webhook_event_payload_resource.rb', line 20

def id
  @id
end

#input ⇒ Object

Input object with the fields used by the Task execution.



49
50
51
 
# File 'lib/onfido/models/webhook_event_payload_resource.rb', line 49

def input
  @input
end

#link ⇒ Object

Object for the configuration of the Workflow Run link.



58
59
60
 
# File 'lib/onfido/models/webhook_event_payload_resource.rb', line 58

def link
  @link
end

#output ⇒ Object

Value field (it can be an Object, List, etc.) with the fields produced by the Task execution.



52
53
54
 
# File 'lib/onfido/models/webhook_event_payload_resource.rb', line 52

def output
  @output
end

#reasons ⇒ Object

The reasons the Workflow Run outcome was reached. Configurable when creating the Workflow Version.



55
56
57
 
# File 'lib/onfido/models/webhook_event_payload_resource.rb', line 55

def reasons
  @reasons
end

#task_def_id ⇒ Object

The identifier for the Task Definition.



43
44
45
 
# File 'lib/onfido/models/webhook_event_payload_resource.rb', line 43

def task_def_id
  @task_def_id
end

#task_def_version ⇒ Object

The task definition version.



46
47
48
 
# File 'lib/onfido/models/webhook_event_payload_resource.rb', line 46

def task_def_version
  @task_def_version
end

#updated_at ⇒ Object

The date and time when the resource was last updated.



29
30
31
 
# File 'lib/onfido/models/webhook_event_payload_resource.rb', line 29

def updated_at
  @updated_at
end

#workflow_id ⇒ Object

The unique identifier for the Workflow.



35
36
37
 
# File 'lib/onfido/models/webhook_event_payload_resource.rb', line 35

def workflow_id
  @workflow_id
end

#workflow_run_id ⇒ Object

Returns the value of attribute workflow_run_id.



37
38
39
 
# File 'lib/onfido/models/webhook_event_payload_resource.rb', line 37

def workflow_run_id
  @workflow_run_id
end

#workflow_version_id ⇒ Object

The identifier for the Workflow version.



40
41
42
 
# File 'lib/onfido/models/webhook_event_payload_resource.rb', line 40

def workflow_version_id
  @workflow_version_id
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



322
323
324
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
 
# File 'lib/onfido/models/webhook_event_payload_resource.rb', line 322

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



89
90
91
 
# File 'lib/onfido/models/webhook_event_payload_resource.rb', line 89

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/onfido/models/webhook_event_payload_resource.rb', line 67

def self.attribute_map
  {
    :'id' => :'id',
    :'applicant_id' => :'applicant_id',
    :'created_at' => :'created_at',
    :'updated_at' => :'updated_at',
    :'dashboard_url' => :'dashboard_url',
    :'workflow_id' => :'workflow_id',
    :'workflow_run_id' => :'workflow_run_id',
    :'workflow_version_id' => :'workflow_version_id',
    :'task_def_id' => :'task_def_id',
    :'task_def_version' => :'task_def_version',
    :'input' => :'input',
    :'output' => :'output',
    :'reasons' => :'reasons',
    :'link' => :'link',
    :'error' => :'error',
    :'customer_user_id' => :'customer_user_id'
  }
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



298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
 
# File 'lib/onfido/models/webhook_event_payload_resource.rb', line 298

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_nullable ⇒ Object

List of attributes with nullable: true



116
117
118
119
120
121
 
# File 'lib/onfido/models/webhook_event_payload_resource.rb', line 116

def self.openapi_nullable
  Set.new([
    :'task_def_version',
    :'output',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/onfido/models/webhook_event_payload_resource.rb', line 94

def self.openapi_types
  {
    :'id' => :'String',
    :'applicant_id' => :'String',
    :'created_at' => :'Time',
    :'updated_at' => :'Time',
    :'dashboard_url' => :'String',
    :'workflow_id' => :'String',
    :'workflow_run_id' => :'String',
    :'workflow_version_id' => :'Integer',
    :'task_def_id' => :'String',
    :'task_def_version' => :'String',
    :'input' => :'Object',
    :'output' => :'Object',
    :'reasons' => :'Array<String>',
    :'link' => :'WorkflowRunLink',
    :'error' => :'WorkflowRunError',
    :'customer_user_id' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
 
# File 'lib/onfido/models/webhook_event_payload_resource.rb', line 262

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      applicant_id == o.applicant_id &&
      created_at == o.created_at &&
      updated_at == o.updated_at &&
      dashboard_url == o.dashboard_url &&
      workflow_id == o.workflow_id &&
      workflow_run_id == o.workflow_run_id &&
      workflow_version_id == o.workflow_version_id &&
      task_def_id == o.task_def_id &&
      task_def_version == o.task_def_version &&
      input == o.input &&
      output == o.output &&
      reasons == o.reasons &&
      link == o.link &&
      error == o.error &&
      customer_user_id == o.customer_user_id
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



393
394
395
396
397
398
399
400
401
402
403
404
405
 
# File 'lib/onfido/models/webhook_event_payload_resource.rb', line 393

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


285
286
287
 
# File 'lib/onfido/models/webhook_event_payload_resource.rb', line 285

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



291
292
293
 
# File 'lib/onfido/models/webhook_event_payload_resource.rb', line 291

def hash
  [id, applicant_id, created_at, updated_at, dashboard_url, workflow_id, workflow_run_id, workflow_version_id, task_def_id, task_def_version, input, output, reasons, link, error, customer_user_id].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



207
208
209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'lib/onfido/models/webhook_event_payload_resource.rb', line 207

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  pattern = Regexp.new(/^[0-9a-z_-]+$/)
  if !@task_def_id.nil? && @task_def_id !~ pattern
    invalid_properties.push("invalid value for \"task_def_id\", must conform to the pattern #{pattern}.")
  end

  if !@customer_user_id.nil? && @customer_user_id.to_s.length > 256
    invalid_properties.push('invalid value for "customer_user_id", the character length must be smaller than or equal to 256.')
  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



369
370
371
 
# File 'lib/onfido/models/webhook_event_payload_resource.rb', line 369

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



375
376
377
378
379
380
381
382
383
384
385
386
387
 
# File 'lib/onfido/models/webhook_event_payload_resource.rb', line 375

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



363
364
365
 
# File 'lib/onfido/models/webhook_event_payload_resource.rb', line 363

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



224
225
226
227
228
229
 
# File 'lib/onfido/models/webhook_event_payload_resource.rb', line 224

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if !@task_def_id.nil? && @task_def_id !~ Regexp.new(/^[0-9a-z_-]+$/)
  return false if !@customer_user_id.nil? && @customer_user_id.to_s.length > 256
  true
end