Class: Plaid::LinkTokenCreateRequest

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

Overview

LinkTokenCreateRequest defines the request schema for ‘/link/token/create`

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ LinkTokenCreateRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
245
246
247
248
249
250
251
252
253
254
255
256
257
 
# File 'lib/plaid/models/link_token_create_request.rb', line 149

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#access_token ⇒ Object

The ‘access_token` associated with the Item to update, used when updating or modifying an existing `access_token`. Used when launching Link in update mode, when completing the Same-day (manual) Micro-deposit flow, or (optionally) when initializing Link as part of the Payment Initiation (UK and Europe) flow.



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

def access_token
  @access_token
end

#account_filters ⇒ Object

Returns the value of attribute account_filters.



56
57
58
 
# File 'lib/plaid/models/link_token_create_request.rb', line 56

def 
  @account_filters
end

#android_package_name ⇒ Object

The name of your app’s Android package. Required if using the ‘link_token` to initialize Link on Android. When creating a `link_token` for initializing Link on other platforms, this field must be left blank. Any package name specified here must also be added to the Allowed Android package names setting on the [developer dashboard](dashboard.plaid.com/team/api).



52
53
54
 
# File 'lib/plaid/models/link_token_create_request.rb', line 52

def android_package_name
  @android_package_name
end

#auth ⇒ Object

Returns the value of attribute auth.



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

def auth
  @auth
end

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



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

def client_id
  @client_id
end

#client_name ⇒ Object

The name of your application, as it should be displayed in Link. Maximum length of 30 characters. If a value longer than 30 characters is provided, Link will display "This Application" instead.



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

def client_name
  @client_name
end

#country_codes ⇒ Object

Specify an array of Plaid-supported country codes using the ISO-3166-1 alpha-2 country code standard. Institutions from all listed countries will be shown. Supported country codes are: ‘US`, `CA`, `DE`, `ES`, `FR`, `GB`, `IE`, `IT`, `NL`. For a complete mapping of supported products by country, see plaid.com/global/. If Link is launched with multiple country codes, only products that you are enabled for in all countries will be used by Link. Note that while all countries are enabled by default in Sandbox and Development, in Production only US and Canada are enabled by default. To gain access to European institutions in the Production environment, [file a product access Support ticket](dashboard.plaid.com/support/new/product-and-development/product-troubleshooting/request-product-access) via the Plaid dashboard. If you initialize with a European country code, your users will see the European consent panel during the Link flow. If using a Link customization, make sure the country codes in the customization match those specified in `country_codes`. If both `country_codes` and a Link customization are used, the value in `country_codes` may override the value in the customization. If using the Auth features Instant Match, Same-day Micro-deposits, or Automated Micro-deposits, `country_codes` must be set to `[’US’]‘.



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

def country_codes
  @country_codes
end

#deposit_switch ⇒ Object

Returns the value of attribute deposit_switch.



65
66
67
 
# File 'lib/plaid/models/link_token_create_request.rb', line 65

def deposit_switch
  @deposit_switch
end

#eu_config ⇒ Object

Returns the value of attribute eu_config.



58
59
60
 
# File 'lib/plaid/models/link_token_create_request.rb', line 58

def eu_config
  @eu_config
end

#income_verification ⇒ Object

Returns the value of attribute income_verification.



67
68
69
 
# File 'lib/plaid/models/link_token_create_request.rb', line 67

def income_verification
  @income_verification
end

#institution_data ⇒ Object

Returns the value of attribute institution_data.



54
55
56
 
# File 'lib/plaid/models/link_token_create_request.rb', line 54

def institution_data
  @institution_data
end

#institution_id ⇒ Object

Used for certain Europe-only configurations, as well as certain legacy use cases in other regions.



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

def institution_id
  @institution_id
end

#language ⇒ Object

The language that Link should be displayed in. Supported languages are: - English (‘’en’‘) - French (`’fr’‘) - Spanish (`’es’‘) - Dutch (`’nl’‘) - German(`’de’‘) When using a Link customization, the language configured here must match the setting in the customization, or the customization will not be applied.



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

def language
  @language
end

#link_customization_name ⇒ Object

The name of the Link customization from the Plaid Dashboard to be applied to Link. If not specified, the ‘default` customization will be used. When using a Link customization, the language in the customization must match the language selected via the `language` parameter, and the countries in the customization should match the country codes selected via `country_codes`.



46
47
48
 
# File 'lib/plaid/models/link_token_create_request.rb', line 46

def link_customization_name
  @link_customization_name
end

#payment_initiation ⇒ Object

Returns the value of attribute payment_initiation.



63
64
65
 
# File 'lib/plaid/models/link_token_create_request.rb', line 63

def payment_initiation
  @payment_initiation
end

#products ⇒ Object

List of Plaid product(s) you wish to use. If launching Link in update mode, should be omitted; required otherwise. ‘balance` is not a valid value, the Balance product does not require explicit initialization and will automatically be initialized when any other product is initialized. Only institutions that support all requested products will be shown in Link; to maximize the number of institutions listed, it is recommended to initialize Link with the minimal product set required for your use case. Additional products can be added after Link initialization by calling the relevant endpoints. For details and exceptions, see [Choosing when to initialize products](plaid.com/docs/link/best-practices/#choosing-when-to-initialize-products). Note that, unless you have opted to disable Instant Match support, institutions that support Instant Match will also be shown in Link if `auth` is specified as a product, even though these institutions do not contain `auth` in their product array. In Production, you will be billed for each product that you specify when initializing Link. Note that a product cannot be removed from an Item once the Item has been initialized with that product. To stop billing on an Item for subscription-based products, such as Liabilities, Investments, and Transactions, remove the Item via `/item/remove`.



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

def products
  @products
end

#redirect_uri ⇒ Object

A URI indicating the destination where a user should be forwarded after completing the Link flow; used to support OAuth authentication flows when launching Link in the browser or via a webview. The ‘redirect_uri` should not contain any query parameters. When used in Production or Development, must be an https URI. To specify any subdomain, use `*` as a wildcard character, e.g. `*.example.com/oauth.html`. If `android_package_name` is specified, this field should be left blank. Note that any redirect URI must also be added to the Allowed redirect URIs list in the [developer dashboard](dashboard.plaid.com/team/api).



49
50
51
 
# File 'lib/plaid/models/link_token_create_request.rb', line 49

def redirect_uri
  @redirect_uri
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.



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

def secret
  @secret
end

#transfer ⇒ Object

Returns the value of attribute transfer.



71
72
73
 
# File 'lib/plaid/models/link_token_create_request.rb', line 71

def transfer
  @transfer
end

#update ⇒ Object

Returns the value of attribute update.



73
74
75
 
# File 'lib/plaid/models/link_token_create_request.rb', line 73

def update
  @update
end

#user ⇒ Object

Returns the value of attribute user.



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

def user
  @user
end

#user_token ⇒ Object

A user token generated using /user/create. Any item created during the link session will be associated with the user.



76
77
78
 
# File 'lib/plaid/models/link_token_create_request.rb', line 76

def user_token
  @user_token
end

#webhook ⇒ Object

The destination URL to which any webhooks should be sent.



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

def webhook
  @webhook
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



108
109
110
 
# File 'lib/plaid/models/link_token_create_request.rb', line 108

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/plaid/models/link_token_create_request.rb', line 79

def self.attribute_map
  {
    :'client_id' => :'client_id',
    :'secret' => :'secret',
    :'client_name' => :'client_name',
    :'language' => :'language',
    :'country_codes' => :'country_codes',
    :'user' => :'user',
    :'products' => :'products',
    :'webhook' => :'webhook',
    :'access_token' => :'access_token',
    :'link_customization_name' => :'link_customization_name',
    :'redirect_uri' => :'redirect_uri',
    :'android_package_name' => :'android_package_name',
    :'institution_data' => :'institution_data',
    :'account_filters' => :'account_filters',
    :'eu_config' => :'eu_config',
    :'institution_id' => :'institution_id',
    :'payment_initiation' => :'payment_initiation',
    :'deposit_switch' => :'deposit_switch',
    :'income_verification' => :'income_verification',
    :'auth' => :'auth',
    :'transfer' => :'transfer',
    :'update' => :'update',
    :'user_token' => :'user_token'
  }
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



358
359
360
 
# File 'lib/plaid/models/link_token_create_request.rb', line 358

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



142
143
144
145
 
# File 'lib/plaid/models/link_token_create_request.rb', line 142

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

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'client_id' => :'String',
    :'secret' => :'String',
    :'client_name' => :'String',
    :'language' => :'String',
    :'country_codes' => :'Array<CountryCode>',
    :'user' => :'LinkTokenCreateRequestUser',
    :'products' => :'Array<Products>',
    :'webhook' => :'String',
    :'access_token' => :'String',
    :'link_customization_name' => :'String',
    :'redirect_uri' => :'String',
    :'android_package_name' => :'String',
    :'institution_data' => :'LinkTokenCreateInstitutionData',
    :'account_filters' => :'LinkTokenAccountFilters',
    :'eu_config' => :'LinkTokenEUConfig',
    :'institution_id' => :'String',
    :'payment_initiation' => :'LinkTokenCreateRequestPaymentInitiation',
    :'deposit_switch' => :'LinkTokenCreateRequestDepositSwitch',
    :'income_verification' => :'LinkTokenCreateRequestIncomeVerification',
    :'auth' => :'LinkTokenCreateRequestAuth',
    :'transfer' => :'LinkTokenCreateRequestTransfer',
    :'update' => :'LinkTokenCreateRequestUpdate',
    :'user_token' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
 
# File 'lib/plaid/models/link_token_create_request.rb', line 315

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      client_id == o.client_id &&
      secret == o.secret &&
      client_name == o.client_name &&
      language == o.language &&
      country_codes == o.country_codes &&
      user == o.user &&
      products == o.products &&
      webhook == o.webhook &&
      access_token == o.access_token &&
      link_customization_name == o.link_customization_name &&
      redirect_uri == o.redirect_uri &&
      android_package_name == o.android_package_name &&
      institution_data == o.institution_data &&
       == o. &&
      eu_config == o.eu_config &&
      institution_id == o.institution_id &&
      payment_initiation == o.payment_initiation &&
      deposit_switch == o.deposit_switch &&
      income_verification == o.income_verification &&
      auth == o.auth &&
      transfer == o.transfer &&
      update == o.update &&
      user_token == o.user_token
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



388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
 
# File 'lib/plaid/models/link_token_create_request.rb', line 388

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



459
460
461
462
463
464
465
466
467
468
469
470
471
 
# File 'lib/plaid/models/link_token_create_request.rb', line 459

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



365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
 
# File 'lib/plaid/models/link_token_create_request.rb', line 365

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  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


345
346
347
 
# File 'lib/plaid/models/link_token_create_request.rb', line 345

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



351
352
353
 
# File 'lib/plaid/models/link_token_create_request.rb', line 351

def hash
  [client_id, secret, client_name, language, country_codes, user, products, webhook, access_token, link_customization_name, redirect_uri, android_package_name, institution_data, , eu_config, institution_id, payment_initiation, deposit_switch, income_verification, auth, transfer, update, user_token].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



261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
 
# File 'lib/plaid/models/link_token_create_request.rb', line 261

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

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

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


  if @country_codes.length < 1
    invalid_properties.push('invalid value for "country_codes", number of items must be greater than or equal to 1.')
  end

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



435
436
437
 
# File 'lib/plaid/models/link_token_create_request.rb', line 435

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



441
442
443
444
445
446
447
448
449
450
451
452
453
 
# File 'lib/plaid/models/link_token_create_request.rb', line 441

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



429
430
431
 
# File 'lib/plaid/models/link_token_create_request.rb', line 429

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



289
290
291
292
293
294
295
296
 
# File 'lib/plaid/models/link_token_create_request.rb', line 289

def valid?
  return false if @client_name.nil?
  return false if @language.nil?
  return false if @country_codes.nil?
  return false if @country_codes.length < 1
  return false if @user.nil?
  true
end