Class: Plaid::IdentityVerificationCreateRequest

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

Overview

Request schema for ‘/identity_verification/create’

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ IdentityVerificationCreateRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



90
91
92
93
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
135
136
137
138
139
140
 
# File 'lib/plaid/models/identity_verification_create_request.rb', line 90

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

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

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

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

  if attributes.key?(:'gave_consent')
    self.gave_consent = attributes[:'gave_consent']
  else
    self.gave_consent = false
  end

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

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

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

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

Instance Attribute Details

#client_id ⇒ Object

Your Plaid API ‘client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body.



37
38
39
 
# File 'lib/plaid/models/identity_verification_create_request.rb', line 37

def client_id
  @client_id
end

#client_user_id ⇒ Object

A unique ID that identifies the end user in your system. This ID can also be used to associate user-specific data from other Plaid products. Financial Account Matching requires this field and the ‘/link/token/create` `client_user_id` to be consistent. Personally identifiable information, such as an email address or phone number, should not be used in the `client_user_id`.



20
21
22
 
# File 'lib/plaid/models/identity_verification_create_request.rb', line 20

def client_user_id
  @client_user_id
end

#gave_consent ⇒ Object

A flag specifying whether the end user has already agreed to a privacy policy specifying that their data will be shared with Plaid for verification purposes. If ‘gave_consent` is set to `true`, the `accept_tos` step will be marked as `skipped` and the end user’s session will start at the next step requirement.



32
33
34
 
# File 'lib/plaid/models/identity_verification_create_request.rb', line 32

def gave_consent
  @gave_consent
end

#is_idempotent ⇒ Object

An optional flag specifying how you would like Plaid to handle attempts to create an Identity Verification when an Identity Verification already exists for the provided ‘client_user_id` and `template_id`. If idempotency is enabled, Plaid will return the existing Identity Verification. If idempotency is disabled, Plaid will reject the request with a `400 Bad Request` status code if an Identity Verification already exists for the supplied `client_user_id` and `template_id`.



43
44
45
 
# File 'lib/plaid/models/identity_verification_create_request.rb', line 43

def is_idempotent
  @is_idempotent
end

#is_shareable ⇒ Object

A flag specifying whether you would like Plaid to expose a shareable URL for the verification being created.



26
27
28
 
# File 'lib/plaid/models/identity_verification_create_request.rb', line 26

def is_shareable
  @is_shareable
end

#secret ⇒ Object

Your Plaid API ‘secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.



40
41
42
 
# File 'lib/plaid/models/identity_verification_create_request.rb', line 40

def secret
  @secret
end

#template_id ⇒ Object

ID of the associated Identity Verification template.



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

def template_id
  @template_id
end

#user ⇒ Object

Returns the value of attribute user.



34
35
36
 
# File 'lib/plaid/models/identity_verification_create_request.rb', line 34

def user
  @user
end

#user_id ⇒ Object

A unique ‘user_id` generated by Plaid for the client-provided `client_user_id`. This field is currently in beta.



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

def user_id
  @user_id
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



61
62
63
 
# File 'lib/plaid/models/identity_verification_create_request.rb', line 61

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



46
47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/plaid/models/identity_verification_create_request.rb', line 46

def self.attribute_map
  {
    :'client_user_id' => :'client_user_id',
    :'user_id' => :'user_id',
    :'is_shareable' => :'is_shareable',
    :'template_id' => :'template_id',
    :'gave_consent' => :'gave_consent',
    :'user' => :'user',
    :'client_id' => :'client_id',
    :'secret' => :'secret',
    :'is_idempotent' => :'is_idempotent'
  }
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



201
202
203
 
# File 'lib/plaid/models/identity_verification_create_request.rb', line 201

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



81
82
83
84
85
86
 
# File 'lib/plaid/models/identity_verification_create_request.rb', line 81

def self.openapi_nullable
  Set.new([
    :'user',
    :'is_idempotent'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/plaid/models/identity_verification_create_request.rb', line 66

def self.openapi_types
  {
    :'client_user_id' => :'String',
    :'user_id' => :'String',
    :'is_shareable' => :'Boolean',
    :'template_id' => :'String',
    :'gave_consent' => :'Boolean',
    :'user' => :'IdentityVerificationCreateRequestUser',
    :'client_id' => :'String',
    :'secret' => :'String',
    :'is_idempotent' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      client_user_id == o.client_user_id &&
      user_id == o.user_id &&
      is_shareable == o.is_shareable &&
      template_id == o.template_id &&
      gave_consent == o.gave_consent &&
      user == o.user &&
      client_id == o.client_id &&
      secret == o.secret &&
      is_idempotent == o.is_idempotent
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



232
233
234
235
236
237
238
239
240
241
242
243
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
 
# File 'lib/plaid/models/identity_verification_create_request.rb', line 232

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



303
304
305
306
307
308
309
310
311
312
313
314
315
 
# File 'lib/plaid/models/identity_verification_create_request.rb', line 303

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



208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
 
# File 'lib/plaid/models/identity_verification_create_request.rb', line 208

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


188
189
190
 
# File 'lib/plaid/models/identity_verification_create_request.rb', line 188

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



194
195
196
 
# File 'lib/plaid/models/identity_verification_create_request.rb', line 194

def hash
  [client_user_id, user_id, is_shareable, template_id, gave_consent, user, client_id, secret, is_idempotent].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



144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
 
# File 'lib/plaid/models/identity_verification_create_request.rb', line 144

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

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

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



279
280
281
 
# File 'lib/plaid/models/identity_verification_create_request.rb', line 279

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



285
286
287
288
289
290
291
292
293
294
295
296
297
 
# File 'lib/plaid/models/identity_verification_create_request.rb', line 285

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



273
274
275
 
# File 'lib/plaid/models/identity_verification_create_request.rb', line 273

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



163
164
165
166
167
168
 
# File 'lib/plaid/models/identity_verification_create_request.rb', line 163

def valid?
  return false if @is_shareable.nil?
  return false if @template_id.nil?
  return false if @gave_consent.nil?
  true
end