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`

Defined Under Namespace

Classes: EnumAttributeValidator

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



281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
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
342
343
344
345
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
384
385
386
387
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
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
 
# File 'lib/plaid/models/link_token_create_request.rb', line 281

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?(:'required_if_supported_products')
    if (value = attributes[:'required_if_supported_products']).is_a?(Array)
      self.required_if_supported_products = value
    end
  end

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

  if attributes.key?(:'additional_consented_products')
    if (value = attributes[:'additional_consented_products']).is_a?(Array)
      self.additional_consented_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?(:'access_tokens')
    if (value = attributes[:'access_tokens']).is_a?(Array)
      self.access_tokens = value
    end
  end

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

  if attributes.key?(:'appearance_mode')
    self.appearance_mode = attributes[:'appearance_mode']
  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?(:'card_switch')
    self.card_switch = attributes[:'card_switch']
  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_configuration')
    self.payment_configuration = attributes[:'payment_configuration']
  end

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

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

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

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

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

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

  if attributes.key?(:'consumer_report_permissible_purpose')
    self.consumer_report_permissible_purpose = attributes[:'consumer_report_permissible_purpose']
  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?(:'identity_verification')
    self.identity_verification = attributes[:'identity_verification']
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#access_token ⇒ Object

The ‘access_token` associated with the Item to update or reference, used when updating, modifying, or accessing 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 for a returning user as part of the Transfer UI flow.



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

def access_token
  @access_token
end

#access_tokens ⇒ Object

A list of access tokens associated with the items to update in Link update mode for the Assets product. Using this instead of the ‘access_token` field allows the updating of multiple items at once. This feature is in closed beta, please contact your account manager for more info.



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

def access_tokens
  @access_tokens
end

#account_filters ⇒ Object

Returns the value of attribute account_filters.



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

def 
  @account_filters
end

#additional_consented_products ⇒ Object

List of additional Plaid product(s) you wish to collect consent for to support your use case. These products will not be billed until you start using them by calling the relevant endpoints. ‘balance` is not a valid value, the Balance product does not require explicit initialization and will automatically have consent collected. Institutions that do not support these products will still be shown in Link. There should be no overlap between this array and the `products` or `required_if_supported_products` arrays. If you include `signal` in `additional_consented_products`, you will need to call [`/signal/prepare`](plaid.com/docs/api/products/signal/#signalprepare) before calling `/signal/evaluate` for the first time on an Item in order to get the most accurate results. For more details, see [`/signal/prepare`](plaid.com/docs/api/products/signal/#signalprepare).



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

def additional_consented_products
  @additional_consented_products
end

#android_package_name ⇒ Object

The name of your app’s Android package. Required if using the ‘link_token` to initialize Link on Android. 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). When creating a `link_token` for initializing Link on other platforms, `android_package_name` must be left blank and `redirect_uri` should be used instead.



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

def android_package_name
  @android_package_name
end

#appearance_mode ⇒ Object

Returns the value of attribute appearance_mode.



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

def appearance_mode
  @appearance_mode
end

#auth ⇒ Object

Returns the value of attribute auth.



95
96
97
 
# File 'lib/plaid/models/link_token_create_request.rb', line 95

def auth
  @auth
end

#base_report ⇒ Object

Returns the value of attribute base_report.



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

def base_report
  @base_report
end

#card_switch ⇒ Object

Returns the value of attribute card_switch.



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

def card_switch
  @card_switch
end

#cashflow_report ⇒ Object

Returns the value of attribute cashflow_report.



119
120
121
 
# File 'lib/plaid/models/link_token_create_request.rb', line 119

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

#consumer_report_permissible_purpose ⇒ Object

Returns the value of attribute consumer_report_permissible_purpose.



93
94
95
 
# File 'lib/plaid/models/link_token_create_request.rb', line 93

def consumer_report_permissible_purpose
  @consumer_report_permissible_purpose
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. For a complete mapping of supported products by country, see plaid.com/global/. By default, access is granted to US and CA. For Production or Limited Production access to other countries, [contact Sales](plaid.com/contact/) or your account manager. If using Identity Verification, ‘country_codes` should be set to the country where your company is based, not the country where your user is located. For all other products, `country_codes` represents the location of your user’s financial institution. If Link is launched with multiple country codes, only products that you are enabled for in all countries will be used by Link. While all countries are enabled by default in Sandbox, in Production only the countries you have requested access for are shown. To request access to additional countries, [file a product access Support ticket](dashboard.plaid.com/support/new/product-and-development/product-troubleshooting/request-product-access) via the Plaid dashboard. If using a Link customization, make sure the country codes in the customization match those specified in ‘country_codes`, or the customization may not be applied. If using the Auth features Instant Match, Instant Micro-deposits, Same-day Micro-deposits, Automated Micro-deposits, or Database Auth, `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

#cra_enabled ⇒ Object

If ‘true`, request a CRA connection. Defaults to `false`.



122
123
124
 
# File 'lib/plaid/models/link_token_create_request.rb', line 122

def cra_enabled
  @cra_enabled
end

#cra_options ⇒ Object

Returns the value of attribute cra_options.



91
92
93
 
# File 'lib/plaid/models/link_token_create_request.rb', line 91

def cra_options
  @cra_options
end

#credit_partner_insights ⇒ Object

Returns the value of attribute credit_partner_insights.



89
90
91
 
# File 'lib/plaid/models/link_token_create_request.rb', line 89

def credit_partner_insights
  @credit_partner_insights
end

#employment ⇒ Object

Returns the value of attribute employment.



83
84
85
 
# File 'lib/plaid/models/link_token_create_request.rb', line 83

def employment
  @employment
end

#enable_multi_item_link ⇒ Object

If ‘true`, enable linking multiple items in the same Link session. Defaults to `false`.



130
131
132
 
# File 'lib/plaid/models/link_token_create_request.rb', line 130

def enable_multi_item_link
  @enable_multi_item_link
end

#eu_config ⇒ Object

Returns the value of attribute eu_config.



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

def eu_config
  @eu_config
end

#financekit_supported ⇒ Object

If ‘true`, indicates that client supports linking FinanceKit / AppleCard items. Defaults to `false`.



127
128
129
 
# File 'lib/plaid/models/link_token_create_request.rb', line 127

def financekit_supported
  @financekit_supported
end

#hosted_link ⇒ Object

Returns the value of attribute hosted_link.



115
116
117
 
# File 'lib/plaid/models/link_token_create_request.rb', line 115

def hosted_link
  @hosted_link
end

#identity ⇒ Object

Returns the value of attribute identity.



124
125
126
 
# File 'lib/plaid/models/link_token_create_request.rb', line 124

def identity
  @identity
end

#identity_verification ⇒ Object

Returns the value of attribute identity_verification.



101
102
103
 
# File 'lib/plaid/models/link_token_create_request.rb', line 101

def identity_verification
  @identity_verification
end

#income_verification ⇒ Object

Returns the value of attribute income_verification.



85
86
87
 
# File 'lib/plaid/models/link_token_create_request.rb', line 85

def income_verification
  @income_verification
end

#institution_data ⇒ Object

Returns the value of attribute institution_data.



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

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.



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

def institution_id
  @institution_id
end

#investments ⇒ Object

Returns the value of attribute investments.



111
112
113
 
# File 'lib/plaid/models/link_token_create_request.rb', line 111

def investments
  @investments
end

#investments_auth ⇒ Object

Returns the value of attribute investments_auth.



113
114
115
 
# File 'lib/plaid/models/link_token_create_request.rb', line 113

def investments_auth
  @investments_auth
end

#language ⇒ Object

The language that Link should be displayed in. When initializing with Identity Verification, this field is not used; for more details, see [Identity Verification supported languages](plaid.com/docs/identity-verification/#supported-languages). Supported languages are: - Danish (‘’da’‘) - Dutch (`’nl’‘) - English (`’en’‘) - Estonian (`’et’‘) - French (`’fr’‘) - German (`’de’‘) - Hindi (`’hi’‘) - Italian (`’it’‘) - Latvian (`’lv’‘) - Lithuanian (`’lt’‘) - Norwegian (`’no’‘) - Polish (`’pl’‘) - Portuguese (`’pt’‘) - Romanian (`’ro’‘) - Spanish (`’es’‘) - Swedish (`’sv’‘) - Vietnamese (`’vi’‘) 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`.



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

def link_customization_name
  @link_customization_name
end

#optional_products ⇒ Object

List of Plaid product(s) that will enhance the consumer’s use case, but that your app can function without. Plaid will attempt to fetch data for these products on a best-effort basis, and failure to support these products will not affect Item creation. There should be no overlap between this array and the ‘products`, `required_if_supported_products`, or `additional_consented_products` arrays. The `products` array must have at least one product. For more details on using this feature, see [Optional Products](plaid.com/docs/link/initializing-products/#optional-products).



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

def optional_products
  @optional_products
end

#payment_configuration ⇒ Object

Returns the value of attribute payment_configuration.



79
80
81
 
# File 'lib/plaid/models/link_token_create_request.rb', line 79

def payment_configuration
  @payment_configuration
end

#payment_initiation ⇒ Object

Returns the value of attribute payment_initiation.



81
82
83
 
# File 'lib/plaid/models/link_token_create_request.rb', line 81

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 (unless you are using update mode to add Income or Assets to an Item); 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. If launching Link with CRA products, `cra_base_reports` is required and must be included in the `products` array. The products specified here will determine which institutions will be available to your users in Link. Only institutions that support all requested products can be selected; if a user attempts to select an institution that does not support a listed product, a "Connectivity not supported" error message will appear in Link. To maximize the number of institutions available, initialize Link with the minimal product set required for your use case. Additional products can be included via the [`optional_products`](plaid.com/docs/api/link/#link-token-create-request-optional-products) or [`required_if_supported_products`](plaid.com/docs/api/link/#link-token-create-request-required-if-supported-products) fields. Products can also be initialized by calling the endpoint after obtaining an access token; this may require the product to be listed in the [`additional_consented_products`](plaid.com/docs/api/link/#link-token-create-request-additional-consented-products) array. For details, see [Choosing when to initialize products](plaid.com/docs/link/initializing-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 another app. The ‘redirect_uri` should not contain any query parameters. When used in Production, must be an https URI. To specify any subdomain, use `*` as a wildcard character, e.g. `*.example.com/oauth.html`. Note that any redirect URI must also be added to the Allowed redirect URIs list in the [developer dashboard](dashboard.plaid.com/team/api). If initializing on Android, `android_package_name` must be specified instead and `redirect_uri` should be left blank.



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

def redirect_uri
  @redirect_uri
end

#required_if_supported_products ⇒ Object

List of Plaid product(s) you wish to use only if the institution and account(s) selected by the user support the product. Institutions that do not support these products will still be shown in Link. The products will only be extracted and billed if the user selects an institution and account type that supports them. There should be no overlap between this array and the ‘products`, `optional_products`, or `additional_consented_products` arrays. The `products` array must have at least one product. For more details on using this feature, see [Required if Supported Products](plaid.com/docs/link/initializing-products/#required-if-supported-products).



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

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

#statements ⇒ Object

Returns the value of attribute statements.



103
104
105
 
# File 'lib/plaid/models/link_token_create_request.rb', line 103

def statements
  @statements
end

#third_party_user_token ⇒ Object

A third party user token associated with the current user.



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

def third_party_user_token
  @third_party_user_token
end

#transactions ⇒ Object

Returns the value of attribute transactions.



117
118
119
 
# File 'lib/plaid/models/link_token_create_request.rb', line 117

def transactions
  @transactions
end

#transfer ⇒ Object

Returns the value of attribute transfer.



97
98
99
 
# File 'lib/plaid/models/link_token_create_request.rb', line 97

def transfer
  @transfer
end

#update ⇒ Object

Returns the value of attribute update.



99
100
101
 
# File 'lib/plaid/models/link_token_create_request.rb', line 99

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

Returns the value of attribute user_id.



132
133
134
 
# File 'lib/plaid/models/link_token_create_request.rb', line 132

def user_id
  @user_id
end

#user_token ⇒ Object

A user token generated using ‘/user/create`. Any Item created during the Link session will be associated with the user.



106
107
108
 
# File 'lib/plaid/models/link_token_create_request.rb', line 106

def user_token
  @user_token
end

#webhook ⇒ Object

The destination URL to which any webhooks should be sent. Note that webhooks for Payment Initiation (e-wallet transactions only), Transfer, Bank Transfer (including Auth micro-deposit notification webhooks), Monitor, and Identity Verification are configured via the Dashboard instead. In update mode, this field will not have an effect; to update the webhook receiver endpoint for an existing Item, use ‘/item/webhook/update` instead.



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

def webhook
  @webhook
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



210
211
212
 
# File 'lib/plaid/models/link_token_create_request.rb', line 210

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'client_id' => :'client_id',
    :'secret' => :'secret',
    :'client_name' => :'client_name',
    :'language' => :'language',
    :'country_codes' => :'country_codes',
    :'user' => :'user',
    :'products' => :'products',
    :'required_if_supported_products' => :'required_if_supported_products',
    :'optional_products' => :'optional_products',
    :'additional_consented_products' => :'additional_consented_products',
    :'webhook' => :'webhook',
    :'access_token' => :'access_token',
    :'access_tokens' => :'access_tokens',
    :'link_customization_name' => :'link_customization_name',
    :'appearance_mode' => :'appearance_mode',
    :'redirect_uri' => :'redirect_uri',
    :'android_package_name' => :'android_package_name',
    :'institution_data' => :'institution_data',
    :'card_switch' => :'card_switch',
    :'account_filters' => :'account_filters',
    :'eu_config' => :'eu_config',
    :'institution_id' => :'institution_id',
    :'payment_configuration' => :'payment_configuration',
    :'payment_initiation' => :'payment_initiation',
    :'employment' => :'employment',
    :'income_verification' => :'income_verification',
    :'base_report' => :'base_report',
    :'credit_partner_insights' => :'credit_partner_insights',
    :'cra_options' => :'cra_options',
    :'consumer_report_permissible_purpose' => :'consumer_report_permissible_purpose',
    :'auth' => :'auth',
    :'transfer' => :'transfer',
    :'update' => :'update',
    :'identity_verification' => :'identity_verification',
    :'statements' => :'statements',
    :'user_token' => :'user_token',
    :'third_party_user_token' => :'third_party_user_token',
    :'investments' => :'investments',
    :'investments_auth' => :'investments_auth',
    :'hosted_link' => :'hosted_link',
    :'transactions' => :'transactions',
    :'cashflow_report' => :'cashflow_report',
    :'cra_enabled' => :'cra_enabled',
    :'identity' => :'identity',
    :'financekit_supported' => :'financekit_supported',
    :'enable_multi_item_link' => :'enable_multi_item_link',
    :'user_id' => :'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



672
673
674
 
# File 'lib/plaid/models/link_token_create_request.rb', line 672

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



268
269
270
271
272
273
274
275
276
277
 
# File 'lib/plaid/models/link_token_create_request.rb', line 268

def self.openapi_nullable
  Set.new([
    :'products',
    :'required_if_supported_products',
    :'optional_products',
    :'additional_consented_products',
    :'access_token',
    :'appearance_mode',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



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
258
259
260
261
262
263
264
265
 
# File 'lib/plaid/models/link_token_create_request.rb', line 215

def self.openapi_types
  {
    :'client_id' => :'String',
    :'secret' => :'String',
    :'client_name' => :'String',
    :'language' => :'String',
    :'country_codes' => :'Array<CountryCode>',
    :'user' => :'LinkTokenCreateRequestUser',
    :'products' => :'Array<Products>',
    :'required_if_supported_products' => :'Array<Products>',
    :'optional_products' => :'Array<Products>',
    :'additional_consented_products' => :'Array<Products>',
    :'webhook' => :'String',
    :'access_token' => :'String',
    :'access_tokens' => :'Array<String>',
    :'link_customization_name' => :'String',
    :'appearance_mode' => :'LinkTokenCreateRequestAppearanceMode',
    :'redirect_uri' => :'String',
    :'android_package_name' => :'String',
    :'institution_data' => :'LinkTokenCreateInstitutionData',
    :'card_switch' => :'LinkTokenCreateCardSwitch',
    :'account_filters' => :'LinkTokenAccountFilters',
    :'eu_config' => :'LinkTokenEUConfig',
    :'institution_id' => :'String',
    :'payment_configuration' => :'LinkTokenCreateRequestPaymentConfiguration',
    :'payment_initiation' => :'LinkTokenCreateRequestPaymentInitiation',
    :'employment' => :'LinkTokenCreateRequestEmployment',
    :'income_verification' => :'LinkTokenCreateRequestIncomeVerification',
    :'base_report' => :'LinkTokenCreateRequestBaseReport',
    :'credit_partner_insights' => :'LinkTokenCreateRequestCreditPartnerInsights',
    :'cra_options' => :'LinkTokenCreateRequestCraOptions',
    :'consumer_report_permissible_purpose' => :'ConsumerReportPermissiblePurpose',
    :'auth' => :'LinkTokenCreateRequestAuth',
    :'transfer' => :'LinkTokenCreateRequestTransfer',
    :'update' => :'LinkTokenCreateRequestUpdate',
    :'identity_verification' => :'LinkTokenCreateRequestIdentityVerification',
    :'statements' => :'LinkTokenCreateRequestStatements',
    :'user_token' => :'String',
    :'third_party_user_token' => :'String',
    :'investments' => :'LinkTokenInvestments',
    :'investments_auth' => :'LinkTokenInvestmentsAuth',
    :'hosted_link' => :'LinkTokenCreateHostedLink',
    :'transactions' => :'LinkTokenTransactions',
    :'cashflow_report' => :'LinkTokenCashflowReport',
    :'cra_enabled' => :'Boolean',
    :'identity' => :'LinkTokenCreateIdentity',
    :'financekit_supported' => :'Boolean',
    :'enable_multi_item_link' => :'Boolean',
    :'user_id' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
 
# File 'lib/plaid/models/link_token_create_request.rb', line 605

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 &&
      required_if_supported_products == o.required_if_supported_products &&
      optional_products == o.optional_products &&
      additional_consented_products == o.additional_consented_products &&
      webhook == o.webhook &&
      access_token == o.access_token &&
      access_tokens == o.access_tokens &&
      link_customization_name == o.link_customization_name &&
      appearance_mode == o.appearance_mode &&
      redirect_uri == o.redirect_uri &&
      android_package_name == o.android_package_name &&
      institution_data == o.institution_data &&
      card_switch == o.card_switch &&
       == o. &&
      eu_config == o.eu_config &&
      institution_id == o.institution_id &&
      payment_configuration == o.payment_configuration &&
      payment_initiation == o.payment_initiation &&
      employment == o.employment &&
      income_verification == o.income_verification &&
      base_report == o.base_report &&
      credit_partner_insights == o.credit_partner_insights &&
      cra_options == o.cra_options &&
      consumer_report_permissible_purpose == o.consumer_report_permissible_purpose &&
      auth == o.auth &&
      transfer == o.transfer &&
      update == o.update &&
      identity_verification == o.identity_verification &&
      statements == o.statements &&
      user_token == o.user_token &&
      third_party_user_token == o.third_party_user_token &&
      investments == o.investments &&
      investments_auth == o.investments_auth &&
      hosted_link == o.hosted_link &&
      transactions == o.transactions &&
      cashflow_report == o.cashflow_report &&
      cra_enabled == o.cra_enabled &&
      identity == o.identity &&
      financekit_supported == o.financekit_supported &&
      enable_multi_item_link == o.enable_multi_item_link &&
      user_id == o.user_id
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



703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
 
# File 'lib/plaid/models/link_token_create_request.rb', line 703

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



774
775
776
777
778
779
780
781
782
783
784
785
786
 
# File 'lib/plaid/models/link_token_create_request.rb', line 774

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



679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
 
# File 'lib/plaid/models/link_token_create_request.rb', line 679

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


659
660
661
 
# File 'lib/plaid/models/link_token_create_request.rb', line 659

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



665
666
667
 
# File 'lib/plaid/models/link_token_create_request.rb', line 665

def hash
  [client_id, secret, client_name, language, country_codes, user, products, required_if_supported_products, optional_products, additional_consented_products, webhook, access_token, access_tokens, link_customization_name, appearance_mode, redirect_uri, android_package_name, institution_data, card_switch, , eu_config, institution_id, payment_configuration, payment_initiation, employment, income_verification, base_report, credit_partner_insights, cra_options, consumer_report_permissible_purpose, auth, transfer, update, identity_verification, statements, user_token, third_party_user_token, investments, investments_auth, hosted_link, transactions, cashflow_report, cra_enabled, identity, financekit_supported, enable_multi_item_link, 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



497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
 
# File 'lib/plaid/models/link_token_create_request.rb', line 497

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 @client_name.to_s.length < 1
    invalid_properties.push('invalid value for "client_name", the character length must be great than or equal to 1.')
  end


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

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



750
751
752
 
# File 'lib/plaid/models/link_token_create_request.rb', line 750

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



756
757
758
759
760
761
762
763
764
765
766
767
768
 
# File 'lib/plaid/models/link_token_create_request.rb', line 756

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



744
745
746
 
# File 'lib/plaid/models/link_token_create_request.rb', line 744

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



536
537
538
539
540
541
542
543
544
545
 
# File 'lib/plaid/models/link_token_create_request.rb', line 536

def valid?
  return false if @client_name.nil?
  return false if @client_name.to_s.length < 1
  return false if @language.nil?
  return false if @language.to_s.length < 1
  return false if @country_codes.nil?
  return false if @country_codes.length < 1
  return false if !@access_token.nil? && @access_token.to_s.length < 1
  true
end