plaid 14.0.0.beta.3 → 14.0.0.beta.4

Sign up to get free protection for your applications and to get access to all the features.
Files changed (406) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +4 -0
  3. data/Gemfile.lock +1 -1
  4. data/Makefile +1 -20
  5. data/PUBLISH.md +1 -2
  6. data/docs/AccountAssets.md +1 -1
  7. data/docs/AccountBase.md +1 -1
  8. data/docs/AccountIdentity.md +1 -1
  9. data/docs/AccountsBalanceGetRequest.md +2 -2
  10. data/docs/AccountsGetRequest.md +2 -2
  11. data/docs/AssetReportAuditCopyCreateRequest.md +2 -2
  12. data/docs/AssetReportAuditCopyGetRequest.md +2 -2
  13. data/docs/AssetReportAuditCopyRemoveRequest.md +2 -2
  14. data/docs/AssetReportCreateRequest.md +2 -2
  15. data/docs/AssetReportFilterRequest.md +2 -2
  16. data/docs/AssetReportGetRequest.md +2 -2
  17. data/docs/AssetReportPDFGetRequest.md +2 -2
  18. data/docs/AssetReportRefreshRequest.md +2 -2
  19. data/docs/AssetReportRemoveRequest.md +2 -2
  20. data/docs/AuthGetRequest.md +2 -2
  21. data/docs/BankTransferBalanceGetRequest.md +2 -2
  22. data/docs/BankTransferCancelRequest.md +2 -2
  23. data/docs/BankTransferCreateRequest.md +2 -2
  24. data/docs/BankTransferEventListRequest.md +2 -2
  25. data/docs/BankTransferEventSyncRequest.md +2 -2
  26. data/docs/BankTransferGetRequest.md +2 -2
  27. data/docs/BankTransferListRequest.md +2 -2
  28. data/docs/BankTransferMigrateAccountRequest.md +2 -2
  29. data/docs/BankTransfersEventsUpdateWebhook.md +20 -0
  30. data/docs/DepositSwitchAltCreateRequest.md +2 -2
  31. data/docs/DepositSwitchCreateRequest.md +2 -2
  32. data/docs/DepositSwitchGetRequest.md +2 -2
  33. data/docs/DepositSwitchTokenCreateRequest.md +2 -2
  34. data/docs/EmployersSearchRequest.md +2 -2
  35. data/docs/IdentityGetRequest.md +2 -2
  36. data/docs/IncomeVerificationCreateRequest.md +2 -2
  37. data/docs/IncomeVerificationDocumentsDownloadRequest.md +2 -2
  38. data/docs/IncomeVerificationPaystubGetRequest.md +2 -2
  39. data/docs/IncomeVerificationSummaryGetRequest.md +2 -2
  40. data/docs/InstitutionsGetByIdRequest.md +2 -2
  41. data/docs/InstitutionsGetRequest.md +2 -2
  42. data/docs/InstitutionsGetRequestOptions.md +1 -1
  43. data/docs/InstitutionsGetResponse.md +1 -1
  44. data/docs/InstitutionsSearchRequest.md +2 -2
  45. data/docs/InstitutionsSearchRequestOptions.md +1 -3
  46. data/docs/InvestmentTransaction.md +1 -1
  47. data/docs/InvestmentsHoldingsGetRequest.md +2 -2
  48. data/docs/InvestmentsTransactionsGetRequest.md +2 -2
  49. data/docs/ItemAccessTokenInvalidateRequest.md +2 -2
  50. data/docs/ItemGetRequest.md +2 -2
  51. data/docs/ItemImportRequest.md +2 -2
  52. data/docs/ItemPublicTokenCreateRequest.md +2 -2
  53. data/docs/ItemPublicTokenExchangeRequest.md +2 -2
  54. data/docs/ItemRemoveRequest.md +2 -2
  55. data/docs/ItemWebhookUpdateRequest.md +2 -2
  56. data/docs/LiabilitiesGetRequest.md +2 -2
  57. data/docs/LiabilityOverride.md +3 -3
  58. data/docs/LinkTokenCreateRequest.md +7 -3
  59. data/docs/LinkTokenCreateRequestAuth.md +18 -0
  60. data/docs/LinkTokenGetRequest.md +2 -2
  61. data/docs/PaymentInitiationPaymentCreateRequest.md +2 -2
  62. data/docs/PaymentInitiationPaymentGetRequest.md +2 -2
  63. data/docs/PaymentInitiationPaymentListRequest.md +2 -2
  64. data/docs/PaymentInitiationPaymentTokenCreateRequest.md +2 -2
  65. data/docs/PaymentInitiationRecipientCreateRequest.md +2 -2
  66. data/docs/PaymentInitiationRecipientGetRequest.md +2 -2
  67. data/docs/PaymentInitiationRecipientListRequest.md +2 -2
  68. data/docs/PlaidApi.md +492 -412
  69. data/docs/ProcessorApexProcessorTokenCreateRequest.md +2 -2
  70. data/docs/ProcessorAuthGetRequest.md +2 -2
  71. data/docs/ProcessorBalanceGetRequest.md +2 -2
  72. data/docs/ProcessorIdentityGetRequest.md +2 -2
  73. data/docs/ProcessorStripeBankAccountTokenCreateRequest.md +2 -2
  74. data/docs/ProcessorTokenCreateRequest.md +2 -2
  75. data/docs/SandboxBankTransferFireWebhookRequest.md +22 -0
  76. data/docs/SandboxBankTransferFireWebhookResponse.md +18 -0
  77. data/docs/SandboxBankTransferSimulateRequest.md +2 -2
  78. data/docs/SandboxItemFireWebhookRequest.md +2 -2
  79. data/docs/SandboxItemResetLoginRequest.md +2 -2
  80. data/docs/SandboxItemSetVerificationStatusRequest.md +2 -2
  81. data/docs/SandboxProcessorTokenCreateRequest.md +2 -2
  82. data/docs/SandboxPublicTokenCreateRequest.md +2 -2
  83. data/docs/StudentLoan.md +1 -1
  84. data/docs/TransactionOverride.md +4 -4
  85. data/docs/TransactionsGetRequest.md +2 -2
  86. data/docs/TransactionsRefreshRequest.md +2 -2
  87. data/docs/WebhookVerificationKeyGetRequest.md +2 -2
  88. data/lib/plaid.rb +6 -2
  89. data/lib/plaid/api/plaid_api.rb +81 -12
  90. data/lib/plaid/api_client.rb +2 -2
  91. data/lib/plaid/api_error.rb +2 -2
  92. data/lib/plaid/configuration.rb +2 -2
  93. data/lib/plaid/models/account_assets.rb +3 -3
  94. data/lib/plaid/models/account_assets_all_of.rb +2 -2
  95. data/lib/plaid/models/account_balance.rb +2 -2
  96. data/lib/plaid/models/account_base.rb +3 -3
  97. data/lib/plaid/models/account_filters_response.rb +2 -2
  98. data/lib/plaid/models/account_identity.rb +3 -3
  99. data/lib/plaid/models/account_identity_all_of.rb +2 -2
  100. data/lib/plaid/models/account_subtype.rb +2 -2
  101. data/lib/plaid/models/account_type.rb +2 -2
  102. data/lib/plaid/models/accounts_balance_get_request.rb +4 -4
  103. data/lib/plaid/models/accounts_balance_get_request_options.rb +2 -2
  104. data/lib/plaid/models/accounts_get_request.rb +4 -4
  105. data/lib/plaid/models/accounts_get_request_options.rb +2 -2
  106. data/lib/plaid/models/accounts_get_response.rb +2 -2
  107. data/lib/plaid/models/ach_class.rb +2 -2
  108. data/lib/plaid/models/address.rb +2 -2
  109. data/lib/plaid/models/address_data.rb +2 -2
  110. data/lib/plaid/models/amount.rb +2 -2
  111. data/lib/plaid/models/apr.rb +2 -2
  112. data/lib/plaid/models/asset_report.rb +2 -2
  113. data/lib/plaid/models/asset_report_audit_copy_create_request.rb +4 -4
  114. data/lib/plaid/models/asset_report_audit_copy_create_response.rb +2 -2
  115. data/lib/plaid/models/asset_report_audit_copy_get_request.rb +4 -4
  116. data/lib/plaid/models/asset_report_audit_copy_remove_request.rb +4 -4
  117. data/lib/plaid/models/asset_report_audit_copy_remove_response.rb +2 -2
  118. data/lib/plaid/models/asset_report_create_request.rb +28 -4
  119. data/lib/plaid/models/asset_report_create_request_options.rb +2 -2
  120. data/lib/plaid/models/asset_report_create_response.rb +2 -2
  121. data/lib/plaid/models/asset_report_filter_request.rb +4 -4
  122. data/lib/plaid/models/asset_report_filter_response.rb +2 -2
  123. data/lib/plaid/models/asset_report_get_request.rb +4 -4
  124. data/lib/plaid/models/asset_report_get_response.rb +2 -2
  125. data/lib/plaid/models/asset_report_item.rb +2 -2
  126. data/lib/plaid/models/asset_report_pdf_get_request.rb +4 -4
  127. data/lib/plaid/models/asset_report_refresh_request.rb +6 -4
  128. data/lib/plaid/models/asset_report_refresh_request_options.rb +2 -2
  129. data/lib/plaid/models/asset_report_refresh_response.rb +2 -2
  130. data/lib/plaid/models/asset_report_remove_request.rb +4 -4
  131. data/lib/plaid/models/asset_report_remove_response.rb +2 -2
  132. data/lib/plaid/models/asset_report_transaction.rb +2 -2
  133. data/lib/plaid/models/asset_report_transaction_all_of.rb +2 -2
  134. data/lib/plaid/models/asset_report_user.rb +2 -2
  135. data/lib/plaid/models/assets_error_webhook.rb +2 -2
  136. data/lib/plaid/models/assets_product_ready_webhook.rb +2 -2
  137. data/lib/plaid/models/auth_get_numbers.rb +2 -2
  138. data/lib/plaid/models/auth_get_request.rb +4 -4
  139. data/lib/plaid/models/auth_get_request_options.rb +2 -2
  140. data/lib/plaid/models/auth_get_response.rb +2 -2
  141. data/lib/plaid/models/automatically_verified_webhook.rb +2 -2
  142. data/lib/plaid/models/bank_transfer.rb +11 -2
  143. data/lib/plaid/models/bank_transfer_balance.rb +2 -2
  144. data/lib/plaid/models/bank_transfer_balance_get_request.rb +4 -4
  145. data/lib/plaid/models/bank_transfer_balance_get_response.rb +2 -2
  146. data/lib/plaid/models/bank_transfer_cancel_request.rb +4 -4
  147. data/lib/plaid/models/bank_transfer_cancel_response.rb +2 -2
  148. data/lib/plaid/models/bank_transfer_create_request.rb +19 -4
  149. data/lib/plaid/models/bank_transfer_create_response.rb +2 -2
  150. data/lib/plaid/models/bank_transfer_direction.rb +2 -2
  151. data/lib/plaid/models/bank_transfer_event.rb +4 -2
  152. data/lib/plaid/models/bank_transfer_event_list_request.rb +8 -4
  153. data/lib/plaid/models/bank_transfer_event_list_response.rb +2 -2
  154. data/lib/plaid/models/bank_transfer_event_sync_request.rb +8 -4
  155. data/lib/plaid/models/bank_transfer_event_sync_response.rb +2 -2
  156. data/lib/plaid/models/bank_transfer_event_type.rb +2 -2
  157. data/lib/plaid/models/bank_transfer_failure.rb +2 -2
  158. data/lib/plaid/models/bank_transfer_get_request.rb +4 -4
  159. data/lib/plaid/models/bank_transfer_get_response.rb +2 -2
  160. data/lib/plaid/models/bank_transfer_list_request.rb +8 -4
  161. data/lib/plaid/models/bank_transfer_list_response.rb +2 -2
  162. data/lib/plaid/models/bank_transfer_migrate_account_request.rb +4 -4
  163. data/lib/plaid/models/bank_transfer_migrate_account_response.rb +2 -2
  164. data/lib/plaid/models/bank_transfer_network.rb +2 -2
  165. data/lib/plaid/models/bank_transfer_receiver_details.rb +2 -2
  166. data/lib/plaid/models/bank_transfer_status.rb +2 -2
  167. data/lib/plaid/models/bank_transfer_type.rb +2 -2
  168. data/lib/plaid/models/bank_transfer_user.rb +2 -2
  169. data/lib/plaid/models/bank_transfers_events_update_webhook.rb +240 -0
  170. data/lib/plaid/models/categories_get_response.rb +2 -2
  171. data/lib/plaid/models/category.rb +2 -2
  172. data/lib/plaid/models/cause.rb +2 -2
  173. data/lib/plaid/models/country_code.rb +2 -2
  174. data/lib/plaid/models/credit_card_liability.rb +2 -2
  175. data/lib/plaid/models/credit_filter.rb +2 -2
  176. data/lib/plaid/models/default_update_webhook.rb +2 -2
  177. data/lib/plaid/models/deposit_switch_address_data.rb +2 -2
  178. data/lib/plaid/models/deposit_switch_alt_create_request.rb +4 -4
  179. data/lib/plaid/models/deposit_switch_alt_create_response.rb +2 -2
  180. data/lib/plaid/models/deposit_switch_create_request.rb +4 -4
  181. data/lib/plaid/models/deposit_switch_create_response.rb +2 -2
  182. data/lib/plaid/models/deposit_switch_get_request.rb +4 -4
  183. data/lib/plaid/models/deposit_switch_get_response.rb +2 -2
  184. data/lib/plaid/models/deposit_switch_target_account.rb +2 -2
  185. data/lib/plaid/models/deposit_switch_target_user.rb +2 -2
  186. data/lib/plaid/models/deposit_switch_token_create_request.rb +4 -4
  187. data/lib/plaid/models/deposit_switch_token_create_response.rb +2 -2
  188. data/lib/plaid/models/depository_filter.rb +2 -2
  189. data/lib/plaid/models/email.rb +2 -2
  190. data/lib/plaid/models/employee.rb +2 -2
  191. data/lib/plaid/models/employee_income_summary_field_string.rb +2 -2
  192. data/lib/plaid/models/employer.rb +2 -2
  193. data/lib/plaid/models/employer_income_summary_field_string.rb +2 -2
  194. data/lib/plaid/models/employers_search_request.rb +4 -4
  195. data/lib/plaid/models/employers_search_response.rb +2 -2
  196. data/lib/plaid/models/error.rb +2 -2
  197. data/lib/plaid/models/external_payment_schedule.rb +2 -2
  198. data/lib/plaid/models/external_payment_schedule_get.rb +2 -2
  199. data/lib/plaid/models/health_incident.rb +2 -2
  200. data/lib/plaid/models/historical_balance.rb +2 -2
  201. data/lib/plaid/models/historical_update_webhook.rb +2 -2
  202. data/lib/plaid/models/holding.rb +2 -2
  203. data/lib/plaid/models/holdings_default_update_webhook.rb +2 -2
  204. data/lib/plaid/models/identity_get_request.rb +4 -4
  205. data/lib/plaid/models/identity_get_request_options.rb +2 -2
  206. data/lib/plaid/models/identity_get_response.rb +2 -2
  207. data/lib/plaid/models/incident_update.rb +2 -2
  208. data/lib/plaid/models/income_breakdown.rb +2 -2
  209. data/lib/plaid/models/income_summary.rb +2 -2
  210. data/lib/plaid/models/income_summary_field_number.rb +2 -2
  211. data/lib/plaid/models/income_summary_field_string.rb +2 -2
  212. data/lib/plaid/models/income_verification_create_request.rb +4 -4
  213. data/lib/plaid/models/income_verification_create_response.rb +2 -2
  214. data/lib/plaid/models/income_verification_documents_download_request.rb +4 -4
  215. data/lib/plaid/models/income_verification_documents_download_response.rb +2 -2
  216. data/lib/plaid/models/income_verification_paystub_get_request.rb +4 -4
  217. data/lib/plaid/models/income_verification_paystub_get_response.rb +2 -2
  218. data/lib/plaid/models/income_verification_status_webhook.rb +2 -2
  219. data/lib/plaid/models/income_verification_summary_get_request.rb +4 -4
  220. data/lib/plaid/models/income_verification_summary_get_response.rb +2 -2
  221. data/lib/plaid/models/income_verification_webhook_status.rb +2 -2
  222. data/lib/plaid/models/inflow_model.rb +2 -2
  223. data/lib/plaid/models/initial_update_webhook.rb +2 -2
  224. data/lib/plaid/models/institution.rb +2 -2
  225. data/lib/plaid/models/institution_status.rb +2 -2
  226. data/lib/plaid/models/institutions_get_by_id_request.rb +4 -4
  227. data/lib/plaid/models/institutions_get_by_id_request_options.rb +2 -2
  228. data/lib/plaid/models/institutions_get_by_id_response.rb +2 -2
  229. data/lib/plaid/models/institutions_get_request.rb +27 -4
  230. data/lib/plaid/models/institutions_get_request_options.rb +3 -3
  231. data/lib/plaid/models/institutions_get_response.rb +3 -3
  232. data/lib/plaid/models/institutions_search_account_filter.rb +2 -2
  233. data/lib/plaid/models/institutions_search_request.rb +25 -4
  234. data/lib/plaid/models/institutions_search_request_options.rb +6 -15
  235. data/lib/plaid/models/institutions_search_response.rb +2 -2
  236. data/lib/plaid/models/investment_filter.rb +2 -2
  237. data/lib/plaid/models/investment_holdings_get_request_options.rb +2 -2
  238. data/lib/plaid/models/investment_transaction.rb +3 -2
  239. data/lib/plaid/models/investments_default_update_webhook.rb +2 -2
  240. data/lib/plaid/models/investments_holdings_get_request.rb +4 -4
  241. data/lib/plaid/models/investments_holdings_get_response.rb +2 -2
  242. data/lib/plaid/models/investments_transactions_get_request.rb +4 -4
  243. data/lib/plaid/models/investments_transactions_get_request_options.rb +6 -2
  244. data/lib/plaid/models/investments_transactions_get_response.rb +2 -2
  245. data/lib/plaid/models/item.rb +2 -2
  246. data/lib/plaid/models/item_access_token_invalidate_request.rb +4 -4
  247. data/lib/plaid/models/item_access_token_invalidate_response.rb +2 -2
  248. data/lib/plaid/models/item_error_webhook.rb +2 -2
  249. data/lib/plaid/models/item_get_request.rb +4 -4
  250. data/lib/plaid/models/item_get_response.rb +2 -2
  251. data/lib/plaid/models/item_import_request.rb +25 -4
  252. data/lib/plaid/models/item_import_request_options.rb +2 -2
  253. data/lib/plaid/models/item_import_request_user_auth.rb +2 -2
  254. data/lib/plaid/models/item_import_response.rb +2 -2
  255. data/lib/plaid/models/item_product_ready_webhook.rb +2 -2
  256. data/lib/plaid/models/item_public_token_create_request.rb +4 -4
  257. data/lib/plaid/models/item_public_token_create_response.rb +2 -2
  258. data/lib/plaid/models/item_public_token_exchange_request.rb +4 -4
  259. data/lib/plaid/models/item_public_token_exchange_response.rb +2 -2
  260. data/lib/plaid/models/item_remove_request.rb +4 -4
  261. data/lib/plaid/models/item_remove_response.rb +2 -2
  262. data/lib/plaid/models/item_status.rb +2 -2
  263. data/lib/plaid/models/item_webhook_update_request.rb +4 -4
  264. data/lib/plaid/models/item_webhook_update_response.rb +2 -2
  265. data/lib/plaid/models/jwk_public_key.rb +2 -2
  266. data/lib/plaid/models/jwt_header.rb +2 -2
  267. data/lib/plaid/models/liabilities_get_request.rb +4 -4
  268. data/lib/plaid/models/liabilities_get_request_options.rb +2 -2
  269. data/lib/plaid/models/liabilities_get_response.rb +2 -2
  270. data/lib/plaid/models/liabilities_object.rb +2 -2
  271. data/lib/plaid/models/liability_override.rb +5 -7
  272. data/lib/plaid/models/link_token_account_filters.rb +2 -2
  273. data/lib/plaid/models/link_token_create_request.rb +47 -8
  274. data/lib/plaid/models/link_token_create_request_account_subtypes.rb +2 -2
  275. data/lib/plaid/models/link_token_create_request_auth.rb +259 -0
  276. data/lib/plaid/models/link_token_create_request_deposit_switch.rb +2 -2
  277. data/lib/plaid/models/link_token_create_request_income_verification.rb +2 -2
  278. data/lib/plaid/models/link_token_create_request_payment_initiation.rb +2 -2
  279. data/lib/plaid/models/link_token_create_request_user.rb +2 -2
  280. data/lib/plaid/models/link_token_create_response.rb +2 -2
  281. data/lib/plaid/models/link_token_get_metadata_response.rb +2 -2
  282. data/lib/plaid/models/link_token_get_request.rb +4 -4
  283. data/lib/plaid/models/link_token_get_response.rb +2 -2
  284. data/lib/plaid/models/loan_filter.rb +2 -2
  285. data/lib/plaid/models/location.rb +2 -2
  286. data/lib/plaid/models/meta.rb +2 -2
  287. data/lib/plaid/models/mfa.rb +2 -2
  288. data/lib/plaid/models/mortgage_interest_rate.rb +2 -2
  289. data/lib/plaid/models/mortgage_liability.rb +2 -2
  290. data/lib/plaid/models/mortgage_property_address.rb +2 -2
  291. data/lib/plaid/models/nullable_access_token.rb +2 -2
  292. data/lib/plaid/models/nullable_address.rb +2 -2
  293. data/lib/plaid/models/nullable_address_data.rb +2 -2
  294. data/lib/plaid/models/nullable_item_status.rb +2 -2
  295. data/lib/plaid/models/nullable_numbers_ach.rb +2 -2
  296. data/lib/plaid/models/nullable_numbers_bacs.rb +2 -2
  297. data/lib/plaid/models/nullable_numbers_eft.rb +2 -2
  298. data/lib/plaid/models/nullable_numbers_international.rb +2 -2
  299. data/lib/plaid/models/nullable_recipient_bacs.rb +2 -2
  300. data/lib/plaid/models/numbers.rb +2 -2
  301. data/lib/plaid/models/numbers_ach.rb +2 -2
  302. data/lib/plaid/models/numbers_bacs.rb +2 -2
  303. data/lib/plaid/models/numbers_eft.rb +2 -2
  304. data/lib/plaid/models/numbers_international.rb +2 -2
  305. data/lib/plaid/models/override_accounts.rb +2 -2
  306. data/lib/plaid/models/owner.rb +2 -2
  307. data/lib/plaid/models/owner_override.rb +2 -2
  308. data/lib/plaid/models/pay_frequency.rb +2 -2
  309. data/lib/plaid/models/pay_period_details.rb +2 -2
  310. data/lib/plaid/models/payment_amount.rb +2 -2
  311. data/lib/plaid/models/payment_initiation_address.rb +19 -2
  312. data/lib/plaid/models/payment_initiation_payment_create_request.rb +4 -4
  313. data/lib/plaid/models/payment_initiation_payment_create_response.rb +2 -2
  314. data/lib/plaid/models/payment_initiation_payment_get_request.rb +4 -4
  315. data/lib/plaid/models/payment_initiation_payment_get_response.rb +2 -2
  316. data/lib/plaid/models/payment_initiation_payment_list_request.rb +6 -4
  317. data/lib/plaid/models/payment_initiation_payment_list_response.rb +2 -2
  318. data/lib/plaid/models/payment_initiation_payment_token_create_request.rb +4 -4
  319. data/lib/plaid/models/payment_initiation_payment_token_create_response.rb +2 -2
  320. data/lib/plaid/models/payment_initiation_recipient.rb +2 -2
  321. data/lib/plaid/models/payment_initiation_recipient_create_request.rb +4 -4
  322. data/lib/plaid/models/payment_initiation_recipient_create_response.rb +2 -2
  323. data/lib/plaid/models/payment_initiation_recipient_get_request.rb +4 -4
  324. data/lib/plaid/models/payment_initiation_recipient_get_response.rb +2 -2
  325. data/lib/plaid/models/payment_initiation_recipient_list_request.rb +4 -4
  326. data/lib/plaid/models/payment_initiation_recipient_list_response.rb +2 -2
  327. data/lib/plaid/models/payment_meta.rb +2 -2
  328. data/lib/plaid/models/payment_status_update_webhook.rb +2 -2
  329. data/lib/plaid/models/paystub.rb +2 -2
  330. data/lib/plaid/models/paystub_deduction.rb +2 -2
  331. data/lib/plaid/models/paystub_ytd_details.rb +2 -2
  332. data/lib/plaid/models/pending_expiration_webhook.rb +2 -2
  333. data/lib/plaid/models/phone_number.rb +2 -2
  334. data/lib/plaid/models/processor_apex_processor_token_create_request.rb +4 -4
  335. data/lib/plaid/models/processor_auth_get_request.rb +4 -4
  336. data/lib/plaid/models/processor_auth_get_response.rb +2 -2
  337. data/lib/plaid/models/processor_balance_get_request.rb +4 -4
  338. data/lib/plaid/models/processor_balance_get_response.rb +2 -2
  339. data/lib/plaid/models/processor_identity_get_request.rb +4 -4
  340. data/lib/plaid/models/processor_identity_get_response.rb +2 -2
  341. data/lib/plaid/models/processor_number.rb +2 -2
  342. data/lib/plaid/models/processor_stripe_bank_account_token_create_request.rb +4 -4
  343. data/lib/plaid/models/processor_stripe_bank_account_token_create_response.rb +2 -2
  344. data/lib/plaid/models/processor_token_create_request.rb +4 -4
  345. data/lib/plaid/models/processor_token_create_response.rb +2 -2
  346. data/lib/plaid/models/product_status.rb +2 -2
  347. data/lib/plaid/models/product_status_breakdown.rb +2 -2
  348. data/lib/plaid/models/products.rb +2 -2
  349. data/lib/plaid/models/projected_income_summary_field_number.rb +2 -2
  350. data/lib/plaid/models/pslf_status.rb +2 -2
  351. data/lib/plaid/models/recaptcha_required_error.rb +2 -2
  352. data/lib/plaid/models/recipient_bacs.rb +2 -2
  353. data/lib/plaid/models/sandbox_bank_transfer_fire_webhook_request.rb +245 -0
  354. data/lib/plaid/models/sandbox_bank_transfer_fire_webhook_response.rb +225 -0
  355. data/lib/plaid/models/sandbox_bank_transfer_simulate_request.rb +4 -4
  356. data/lib/plaid/models/sandbox_bank_transfer_simulate_response.rb +2 -2
  357. data/lib/plaid/models/sandbox_item_fire_webhook_request.rb +4 -4
  358. data/lib/plaid/models/sandbox_item_fire_webhook_response.rb +2 -2
  359. data/lib/plaid/models/sandbox_item_reset_login_request.rb +4 -4
  360. data/lib/plaid/models/sandbox_item_reset_login_response.rb +2 -2
  361. data/lib/plaid/models/sandbox_item_set_verification_status_request.rb +4 -4
  362. data/lib/plaid/models/sandbox_item_set_verification_status_response.rb +2 -2
  363. data/lib/plaid/models/sandbox_processor_token_create_request.rb +4 -4
  364. data/lib/plaid/models/sandbox_processor_token_create_request_options.rb +2 -2
  365. data/lib/plaid/models/sandbox_processor_token_create_response.rb +2 -2
  366. data/lib/plaid/models/sandbox_public_token_create_request.rb +25 -4
  367. data/lib/plaid/models/sandbox_public_token_create_request_options.rb +2 -2
  368. data/lib/plaid/models/sandbox_public_token_create_request_options_transactions.rb +2 -2
  369. data/lib/plaid/models/sandbox_public_token_create_response.rb +2 -2
  370. data/lib/plaid/models/security.rb +2 -2
  371. data/lib/plaid/models/servicer_address_data.rb +2 -2
  372. data/lib/plaid/models/standalone_account_type.rb +2 -2
  373. data/lib/plaid/models/standalone_currency_code_list.rb +2 -2
  374. data/lib/plaid/models/standalone_investment_transaction_subtype.rb +2 -2
  375. data/lib/plaid/models/standalone_investment_transaction_type.rb +2 -2
  376. data/lib/plaid/models/student_loan.rb +3 -3
  377. data/lib/plaid/models/student_loan_repayment_model.rb +2 -2
  378. data/lib/plaid/models/student_loan_status.rb +2 -2
  379. data/lib/plaid/models/student_repayment_plan.rb +2 -2
  380. data/lib/plaid/models/transaction.rb +2 -2
  381. data/lib/plaid/models/transaction_code.rb +2 -2
  382. data/lib/plaid/models/transaction_data.rb +2 -2
  383. data/lib/plaid/models/transaction_override.rb +21 -21
  384. data/lib/plaid/models/transactions_get_request.rb +4 -4
  385. data/lib/plaid/models/transactions_get_request_options.rb +6 -2
  386. data/lib/plaid/models/transactions_get_response.rb +2 -2
  387. data/lib/plaid/models/transactions_refresh_request.rb +4 -4
  388. data/lib/plaid/models/transactions_refresh_response.rb +2 -2
  389. data/lib/plaid/models/transactions_removed_webhook.rb +2 -2
  390. data/lib/plaid/models/user_custom_password.rb +2 -2
  391. data/lib/plaid/models/user_permission_revoked_webhook.rb +2 -2
  392. data/lib/plaid/models/verification_expired_webhook.rb +2 -2
  393. data/lib/plaid/models/verification_status.rb +2 -2
  394. data/lib/plaid/models/warning.rb +2 -2
  395. data/lib/plaid/models/webhook_update_acknowledged_webhook.rb +2 -2
  396. data/lib/plaid/models/webhook_verification_key_get_request.rb +4 -4
  397. data/lib/plaid/models/webhook_verification_key_get_response.rb +2 -2
  398. data/lib/plaid/models/ytd_gross_income_summary_field_number.rb +2 -2
  399. data/lib/plaid/models/ytd_net_income_summary_field_number.rb +2 -2
  400. data/lib/plaid/version.rb +3 -3
  401. data/pkg/plaid-14.0.0.beta.4.gem +0 -0
  402. data/plaid.gemspec +2 -2
  403. data/templates/ruby/partial_model_generic.mustache +362 -0
  404. data/test/test_bank_transfers.rb +1 -0
  405. metadata +19 -10
  406. data/pkg/plaid-14.0.0.beta.3.gem +0 -0
data/docs/ProcessorApexProcessorTokenCreateRequest.md CHANGED
@@ -4,8 +4,8 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **client_id** | **String** | Your Plaid API `client_id`. | [optional] |
8
- | **secret** | **String** | Your Plaid API `secret`. | [optional] |
7
+ | **client_id** | **String** | 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. | [optional] |
8
+ | **secret** | **String** | 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. | [optional] |
9
9
  | **access_token** | **String** | The access token associated with the Item data is being requested for. | |
10
10
  | **account_id** | **String** | The `account_id` value obtained from the `onSuccess` callback in Link | |
11
11
 
data/docs/ProcessorAuthGetRequest.md CHANGED
@@ -4,8 +4,8 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **client_id** | **String** | Your Plaid API `client_id`. | [optional] |
8
- | **secret** | **String** | Your Plaid API `secret`. | [optional] |
7
+ | **client_id** | **String** | 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. | [optional] |
8
+ | **secret** | **String** | 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. | [optional] |
9
9
  | **processor_token** | **String** | The processor token obtained from the Plaid integration partner. Processor tokens are in the format: `processor-<environment>-<identifier>` | |
10
10
 
11
11
  ## Example
data/docs/ProcessorBalanceGetRequest.md CHANGED
@@ -4,8 +4,8 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **client_id** | **String** | Your Plaid API `client_id`. | [optional] |
8
- | **secret** | **String** | Your Plaid API `secret`. | [optional] |
7
+ | **client_id** | **String** | 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. | [optional] |
8
+ | **secret** | **String** | 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. | [optional] |
9
9
  | **processor_token** | **String** | The processor token obtained from the Plaid integration partner. Processor tokens are in the format: `processor-<environment>-<identifier>` | |
10
10
 
11
11
  ## Example
data/docs/ProcessorIdentityGetRequest.md CHANGED
@@ -4,8 +4,8 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **client_id** | **String** | Your Plaid API `client_id`. | [optional] |
8
- | **secret** | **String** | Your Plaid API `secret`. | [optional] |
7
+ | **client_id** | **String** | 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. | [optional] |
8
+ | **secret** | **String** | 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. | [optional] |
9
9
  | **processor_token** | **String** | The processor token obtained from the Plaid integration partner. Processor tokens are in the format: `processor-<environment>-<identifier>` | |
10
10
 
11
11
  ## Example
data/docs/ProcessorStripeBankAccountTokenCreateRequest.md CHANGED
@@ -4,8 +4,8 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **client_id** | **String** | Your Plaid API `client_id`. | [optional] |
8
- | **secret** | **String** | Your Plaid API `secret`. | [optional] |
7
+ | **client_id** | **String** | 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. | [optional] |
8
+ | **secret** | **String** | 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. | [optional] |
9
9
  | **access_token** | **String** | The access token associated with the Item data is being requested for. | |
10
10
  | **account_id** | **String** | The `account_id` value obtained from the `onSuccess` callback in Link | |
11
11
 
data/docs/ProcessorTokenCreateRequest.md CHANGED
@@ -4,8 +4,8 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **client_id** | **String** | Your Plaid API `client_id`. | [optional] |
8
- | **secret** | **String** | Your Plaid API `secret`. | [optional] |
7
+ | **client_id** | **String** | 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. | [optional] |
8
+ | **secret** | **String** | 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. | [optional] |
9
9
  | **access_token** | **String** | The access token associated with the Item data is being requested for. | |
10
10
  | **account_id** | **String** | The `account_id` value obtained from the `onSuccess` callback in Link | |
11
11
  | **processor** | **String** | The processor you are integrating with. Valid values are `\"achq\"`, `\"check\"`, `\"checkbook\"`, `\"circle\"`, `\"drivewealth\"`, `\"dwolla\"`, `\"galileo\"`, \"`interactive_brokers`\", `\"modern_treasury\"`, `\"ocrolus\"`, `\"prime_trust\"`, `\"rize\"`, `\"sila_money\"`, `\"unit\"`, `\"velox\"`, `\"vesta\"`, `\"vopay\"`, `\"wyre\"` | |
data/docs/SandboxBankTransferFireWebhookRequest.md ADDED
@@ -0,0 +1,22 @@
1
+ # Plaid::SandboxBankTransferFireWebhookRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **client_id** | **String** | 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. | [optional] |
8
+ | **secret** | **String** | 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. | [optional] |
9
+ | **webhook** | **String** | The URL to which the webhook should be sent. | |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'plaid'
15
+
16
+ instance = Plaid::SandboxBankTransferFireWebhookRequest.new(
17
+ client_id: null,
18
+ secret: null,
19
+ webhook: null
20
+ )
21
+ ```
22
+
data/docs/SandboxBankTransferFireWebhookResponse.md ADDED
@@ -0,0 +1,18 @@
1
+ # Plaid::SandboxBankTransferFireWebhookResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **request_id** | **String** | A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive. | |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'plaid'
13
+
14
+ instance = Plaid::SandboxBankTransferFireWebhookResponse.new(
15
+ request_id: null
16
+ )
17
+ ```
18
+
data/docs/SandboxBankTransferSimulateRequest.md CHANGED
@@ -4,8 +4,8 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **client_id** | **String** | Your Plaid API `client_id`. | [optional] |
8
- | **secret** | **String** | Your Plaid API `secret`. | [optional] |
7
+ | **client_id** | **String** | 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. | [optional] |
8
+ | **secret** | **String** | 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. | [optional] |
9
9
  | **bank_transfer_id** | **String** | Plaid’s unique identifier for a bank transfer. | |
10
10
  | **event_type** | **String** | The asynchronous event to be simulated. May be: `posted`, `failed`, or `reversed`. An error will be returned if the event type is incompatible with the current transfer status. Compatible status --> event type transitions include: `pending` --> `failed` `pending` --> `posted` `posted` --> `reversed` | |
11
11
  | **failure_reason** | [**BankTransferFailure**](BankTransferFailure.md) | | [optional] |
data/docs/SandboxItemFireWebhookRequest.md CHANGED
@@ -4,8 +4,8 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **client_id** | **String** | Your Plaid API `client_id`. | [optional] |
8
- | **secret** | **String** | Your Plaid API `secret`. | [optional] |
7
+ | **client_id** | **String** | 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. | [optional] |
8
+ | **secret** | **String** | 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. | [optional] |
9
9
  | **access_token** | **String** | The access token associated with the Item data is being requested for. | |
10
10
  | **webhook_code** | **String** | The following values for `webhook_code` are supported: * `DEFAULT_UPDATE` | [optional] |
11
11
 
data/docs/SandboxItemResetLoginRequest.md CHANGED
@@ -4,8 +4,8 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **client_id** | **String** | Your Plaid API `client_id`. | [optional] |
8
- | **secret** | **String** | Your Plaid API `secret`. | [optional] |
7
+ | **client_id** | **String** | 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. | [optional] |
8
+ | **secret** | **String** | 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. | [optional] |
9
9
  | **access_token** | **String** | The access token associated with the Item data is being requested for. | |
10
10
 
11
11
  ## Example
data/docs/SandboxItemSetVerificationStatusRequest.md CHANGED
@@ -4,8 +4,8 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **client_id** | **String** | Your Plaid API `client_id`. | [optional] |
8
- | **secret** | **String** | Your Plaid API `secret`. | [optional] |
7
+ | **client_id** | **String** | 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. | [optional] |
8
+ | **secret** | **String** | 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. | [optional] |
9
9
  | **access_token** | **String** | The access token associated with the Item data is being requested for. | |
10
10
  | **account_id** | **String** | The `account_id` of the account whose verification status is to be modified | |
11
11
  | **verification_status** | **String** | The verification status to set the account to. | |
data/docs/SandboxProcessorTokenCreateRequest.md CHANGED
@@ -4,8 +4,8 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **client_id** | **String** | Your Plaid API `client_id`. | [optional] |
8
- | **secret** | **String** | Your Plaid API `secret`. | [optional] |
7
+ | **client_id** | **String** | 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. | [optional] |
8
+ | **secret** | **String** | 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. | [optional] |
9
9
  | **institution_id** | **String** | The ID of the institution the Item will be associated with | |
10
10
  | **options** | [**SandboxProcessorTokenCreateRequestOptions**](SandboxProcessorTokenCreateRequestOptions.md) | | [optional] |
11
11
 
data/docs/SandboxPublicTokenCreateRequest.md CHANGED
@@ -4,8 +4,8 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **client_id** | **String** | Your Plaid API `client_id`. | [optional] |
8
- | **secret** | **String** | Your Plaid API `secret`. | [optional] |
7
+ | **client_id** | **String** | 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. | [optional] |
8
+ | **secret** | **String** | 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. | [optional] |
9
9
  | **institution_id** | **String** | The ID of the institution the Item will be associated with | |
10
10
  | **initial_products** | [**Array<Products>**](Products.md) | The products to initially pull for the Item. May be any products that the specified `institution_id` supports. This array may not be empty. | |
11
11
  | **options** | [**SandboxPublicTokenCreateRequestOptions**](SandboxPublicTokenCreateRequestOptions.md) | | [optional] |
data/docs/StudentLoan.md CHANGED
@@ -5,7 +5,7 @@
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **account_id** | **String** | The ID of the account that this liability belongs to. | [optional] |
8
- | **account_number** | **String** | The account number of the loan. | [optional] |
8
+ | **account_number** | **String** | The account number of the loan. For some institutions, this may be a masked version of the number (e.g., the last 4 digits instead of the entire number). | [optional] |
9
9
  | **disbursement_dates** | **Array<String>** | The dates on which loaned funds were disbursed or will be disbursed. These are often in the past. Dates are returned in an ISO 8601 format (YYYY-MM-DD). | [optional] |
10
10
  | **expected_payoff_date** | **String** | The date when the student loan is expected to be paid off. Availability for this field is limited. Dates are returned in an ISO 8601 format (YYYY-MM-DD). | [optional] |
11
11
  | **guarantor** | **String** | The guarantor of the student loan. | [optional] |
data/docs/TransactionOverride.md CHANGED
@@ -4,8 +4,8 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **transaction_date** | **String** | The date of the transaction, in ISO8601 (YYYY-MM-DD) format. Transaction dates in the past or present will result in posted transactions; transaction dates in the future will result in pending transactions. Transactions in Sandbox will move from pending to posted once their transaction date has been reached. | |
8
- | **posted_date** | **String** | The date the transaction posted, in ISO8601 (YYYY-MM-DD) format | |
7
+ | **date_transacted** | **String** | The date of the transaction, in ISO8601 (YYYY-MM-DD) format. Transaction dates in the past or present will result in posted transactions; transaction dates in the future will result in pending transactions. Transactions in Sandbox will move from pending to posted once their transaction date has been reached. | |
8
+ | **date_posted** | **String** | The date the transaction posted, in ISO8601 (YYYY-MM-DD) format | |
9
9
  | **amount** | **Float** | The transaction amount. Can be negative. | |
10
10
  | **description** | **String** | The transaction description. | |
11
11
  | **currency** | **String** | The ISO-4217 format currency code for the transaction. | [optional] |
@@ -16,8 +16,8 @@
16
16
  require 'plaid'
17
17
 
18
18
  instance = Plaid::TransactionOverride.new(
19
- transaction_date: null,
20
- posted_date: null,
19
+ date_transacted: null,
20
+ date_posted: null,
21
21
  amount: null,
22
22
  description: null,
23
23
  currency: null
data/docs/TransactionsGetRequest.md CHANGED
@@ -4,10 +4,10 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **client_id** | **String** | Your Plaid API `client_id`. | [optional] |
7
+ | **client_id** | **String** | 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. | [optional] |
8
8
  | **options** | [**TransactionsGetRequestOptions**](TransactionsGetRequestOptions.md) | | [optional] |
9
9
  | **access_token** | **String** | The access token associated with the Item data is being requested for. | |
10
- | **secret** | **String** | Your Plaid API `secret`. | [optional] |
10
+ | **secret** | **String** | 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. | [optional] |
11
11
  | **start_date** | **Date** | The earliest date for which data should be returned. Dates should be formatted as YYYY-MM-DD. | |
12
12
  | **end_date** | **Date** | The latest date for which data should be returned. Dates should be formatted as YYYY-MM-DD. | |
13
13
 
data/docs/TransactionsRefreshRequest.md CHANGED
@@ -4,9 +4,9 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **client_id** | **String** | Your Plaid API `client_id`. | [optional] |
7
+ | **client_id** | **String** | 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. | [optional] |
8
8
  | **access_token** | **String** | The access token associated with the Item data is being requested for. | |
9
- | **secret** | **String** | Your Plaid API `secret`. | [optional] |
9
+ | **secret** | **String** | 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. | [optional] |
10
10
 
11
11
  ## Example
12
12
 
data/docs/WebhookVerificationKeyGetRequest.md CHANGED
@@ -4,8 +4,8 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **client_id** | **String** | Your Plaid API `client_id`. | [optional] |
8
- | **secret** | **String** | Your Plaid API `secret`. | [optional] |
7
+ | **client_id** | **String** | 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. | [optional] |
8
+ | **secret** | **String** | 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. | [optional] |
9
9
  | **key_id** | **String** | The key ID ( `kid` ) from the JWT header. | |
10
10
 
11
11
  ## Example
data/lib/plaid.rb CHANGED
@@ -3,10 +3,10 @@
3
3
 
4
4
  #The Plaid REST API. Please see https://plaid.com/docs/api for more details.
5
5
 
6
- The version of the OpenAPI document: 2020-09-14_1.8.0
6
+ The version of the OpenAPI document: 2020-09-14_1.11.0
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 5.0.0
9
+ OpenAPI Generator version: 5.1.0
10
10
 
11
11
  =end
12
12
 
@@ -93,6 +93,7 @@ require 'plaid/models/bank_transfer_receiver_details'
93
93
  require 'plaid/models/bank_transfer_status'
94
94
  require 'plaid/models/bank_transfer_type'
95
95
  require 'plaid/models/bank_transfer_user'
96
+ require 'plaid/models/bank_transfers_events_update_webhook'
96
97
  require 'plaid/models/categories_get_response'
97
98
  require 'plaid/models/category'
98
99
  require 'plaid/models/cause'
@@ -198,6 +199,7 @@ require 'plaid/models/liability_override'
198
199
  require 'plaid/models/link_token_account_filters'
199
200
  require 'plaid/models/link_token_create_request'
200
201
  require 'plaid/models/link_token_create_request_account_subtypes'
202
+ require 'plaid/models/link_token_create_request_auth'
201
203
  require 'plaid/models/link_token_create_request_deposit_switch'
202
204
  require 'plaid/models/link_token_create_request_income_verification'
203
205
  require 'plaid/models/link_token_create_request_payment_initiation'
@@ -275,6 +277,8 @@ require 'plaid/models/products'
275
277
  require 'plaid/models/projected_income_summary_field_number'
276
278
  require 'plaid/models/recaptcha_required_error'
277
279
  require 'plaid/models/recipient_bacs'
280
+ require 'plaid/models/sandbox_bank_transfer_fire_webhook_request'
281
+ require 'plaid/models/sandbox_bank_transfer_fire_webhook_response'
278
282
  require 'plaid/models/sandbox_bank_transfer_simulate_request'
279
283
  require 'plaid/models/sandbox_bank_transfer_simulate_response'
280
284
  require 'plaid/models/sandbox_item_fire_webhook_request'
data/lib/plaid/api/plaid_api.rb CHANGED
@@ -3,10 +3,10 @@
3
3
 
4
4
  #The Plaid REST API. Please see https://plaid.com/docs/api for more details.
5
5
 
6
- The version of the OpenAPI document: 2020-09-14_1.8.0
6
+ The version of the OpenAPI document: 2020-09-14_1.11.0
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 5.0.0
9
+ OpenAPI Generator version: 5.1.0
10
10
 
11
11
  =end
12
12
 
@@ -85,7 +85,7 @@ module Plaid
85
85
  end
86
86
 
87
87
  # Retrieve accounts
88
- # The `/accounts/get` endpoint can be used to retrieve information for any linked Item. Note that some information is nullable. Plaid will only return active bank accounts, i.e. accounts that are not closed and are capable of carrying a balance.
88
+ # The `/accounts/get` endpoint can be used to retrieve information for any linked Item. Note that some information is nullable. Plaid will only return active bank accounts, i.e. accounts that are not closed and are capable of carrying a balance. This endpoint retrieves cached information, rather than extracting fresh information from the institution. As a result, balances returned may not be up-to-date; for realtime balance information, use `/accounts/balance/get` instead.
89
89
  # @param accounts_get_request [AccountsGetRequest]
90
90
  # @param [Hash] opts the optional parameters
91
91
  # @return [AccountsGetResponse]
@@ -95,7 +95,7 @@ module Plaid
95
95
  end
96
96
 
97
97
  # Retrieve accounts
98
- # The `/accounts/get` endpoint can be used to retrieve information for any linked Item. Note that some information is nullable. Plaid will only return active bank accounts, i.e. accounts that are not closed and are capable of carrying a balance.
98
+ # The `/accounts/get` endpoint can be used to retrieve information for any linked Item. Note that some information is nullable. Plaid will only return active bank accounts, i.e. accounts that are not closed and are capable of carrying a balance. This endpoint retrieves cached information, rather than extracting fresh information from the institution. As a result, balances returned may not be up-to-date; for realtime balance information, use `/accounts/balance/get` instead.
99
99
  # @param accounts_get_request [AccountsGetRequest]
100
100
  # @param [Hash] opts the optional parameters
101
101
  # @return [Array<(AccountsGetResponse, Integer, Hash)>] AccountsGetResponse data, response status code and response headers
@@ -1451,23 +1451,27 @@ module Plaid
1451
1451
 
1452
1452
  # Create a deposit switch when not using Plaid Exchange.'
1453
1453
  # This endpoint provides an alternative to `/deposit_switch/create` for customers who have not yet fully integrated with Plaid Exchange. Like `/deposit_switch/create`, it created a deposit switch entity that will be persisted throughout the lifecycle of the switch.
1454
+ # @param deposit_switch_alt_create_request [DepositSwitchAltCreateRequest]
1454
1455
  # @param [Hash] opts the optional parameters
1455
- # @option opts [DepositSwitchAltCreateRequest] :deposit_switch_alt_create_request
1456
1456
  # @return [DepositSwitchAltCreateResponse]
1457
- def deposit_switch_alt_create(opts = {})
1458
- data, _status_code, _headers = deposit_switch_alt_create_with_http_info(opts)
1457
+ def deposit_switch_alt_create(deposit_switch_alt_create_request, opts = {})
1458
+ data, _status_code, _headers = deposit_switch_alt_create_with_http_info(deposit_switch_alt_create_request, opts)
1459
1459
  data
1460
1460
  end
1461
1461
 
1462
1462
  # Create a deposit switch when not using Plaid Exchange.&#39;
1463
1463
  # This endpoint provides an alternative to &#x60;/deposit_switch/create&#x60; for customers who have not yet fully integrated with Plaid Exchange. Like &#x60;/deposit_switch/create&#x60;, it created a deposit switch entity that will be persisted throughout the lifecycle of the switch.
1464
+ # @param deposit_switch_alt_create_request [DepositSwitchAltCreateRequest]
1464
1465
  # @param [Hash] opts the optional parameters
1465
- # @option opts [DepositSwitchAltCreateRequest] :deposit_switch_alt_create_request
1466
1466
  # @return [Array<(DepositSwitchAltCreateResponse, Integer, Hash)>] DepositSwitchAltCreateResponse data, response status code and response headers
1467
- def deposit_switch_alt_create_with_http_info(opts = {})
1467
+ def deposit_switch_alt_create_with_http_info(deposit_switch_alt_create_request, opts = {})
1468
1468
  if @api_client.config.debugging
1469
1469
  @api_client.config.logger.debug 'Calling API: PlaidApi.deposit_switch_alt_create ...'
1470
1470
  end
1471
+ # verify the required parameter 'deposit_switch_alt_create_request' is set
1472
+ if @api_client.config.client_side_validation && deposit_switch_alt_create_request.nil?
1473
+ fail ArgumentError, "Missing the required parameter 'deposit_switch_alt_create_request' when calling PlaidApi.deposit_switch_alt_create"
1474
+ end
1471
1475
  # resource path
1472
1476
  local_var_path = '/deposit_switch/alt/create'
1473
1477
 
@@ -1485,7 +1489,7 @@ module Plaid
1485
1489
  form_params = opts[:form_params] || {}
1486
1490
 
1487
1491
  # http body (model)
1488
- post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'deposit_switch_alt_create_request'])
1492
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(deposit_switch_alt_create_request)
1489
1493
 
1490
1494
  # return_type
1491
1495
  return_type = opts[:debug_return_type] || 'DepositSwitchAltCreateResponse'
@@ -3830,6 +3834,71 @@ module Plaid
3830
3834
  return data, status_code, headers
3831
3835
  end
3832
3836
 
3837
+ # Manually fire a Bank Transfer webhook
3838
+ # Use the `/sandbox/bank_transfer/fire_webhook` endpoint to manually trigger a Bank Transfers webhook in the Sandbox environment.
3839
+ # @param sandbox_bank_transfer_fire_webhook_request [SandboxBankTransferFireWebhookRequest]
3840
+ # @param [Hash] opts the optional parameters
3841
+ # @return [SandboxBankTransferFireWebhookResponse]
3842
+ def sandbox_bank_transfer_fire_webhook(sandbox_bank_transfer_fire_webhook_request, opts = {})
3843
+ data, _status_code, _headers = sandbox_bank_transfer_fire_webhook_with_http_info(sandbox_bank_transfer_fire_webhook_request, opts)
3844
+ data
3845
+ end
3846
+
3847
+ # Manually fire a Bank Transfer webhook
3848
+ # Use the &#x60;/sandbox/bank_transfer/fire_webhook&#x60; endpoint to manually trigger a Bank Transfers webhook in the Sandbox environment.
3849
+ # @param sandbox_bank_transfer_fire_webhook_request [SandboxBankTransferFireWebhookRequest]
3850
+ # @param [Hash] opts the optional parameters
3851
+ # @return [Array<(SandboxBankTransferFireWebhookResponse, Integer, Hash)>] SandboxBankTransferFireWebhookResponse data, response status code and response headers
3852
+ def sandbox_bank_transfer_fire_webhook_with_http_info(sandbox_bank_transfer_fire_webhook_request, opts = {})
3853
+ if @api_client.config.debugging
3854
+ @api_client.config.logger.debug 'Calling API: PlaidApi.sandbox_bank_transfer_fire_webhook ...'
3855
+ end
3856
+ # verify the required parameter 'sandbox_bank_transfer_fire_webhook_request' is set
3857
+ if @api_client.config.client_side_validation && sandbox_bank_transfer_fire_webhook_request.nil?
3858
+ fail ArgumentError, "Missing the required parameter 'sandbox_bank_transfer_fire_webhook_request' when calling PlaidApi.sandbox_bank_transfer_fire_webhook"
3859
+ end
3860
+ # resource path
3861
+ local_var_path = '/sandbox/bank_transfer/fire_webhook'
3862
+
3863
+ # query parameters
3864
+ query_params = opts[:query_params] || {}
3865
+
3866
+ # header parameters
3867
+ header_params = opts[:header_params] || {}
3868
+ # HTTP header 'Accept' (if needed)
3869
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
3870
+ # HTTP header 'Content-Type'
3871
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
3872
+
3873
+ # form parameters
3874
+ form_params = opts[:form_params] || {}
3875
+
3876
+ # http body (model)
3877
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(sandbox_bank_transfer_fire_webhook_request)
3878
+
3879
+ # return_type
3880
+ return_type = opts[:debug_return_type] || 'SandboxBankTransferFireWebhookResponse'
3881
+
3882
+ # auth_names
3883
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
3884
+
3885
+ new_options = opts.merge(
3886
+ :operation => :"PlaidApi.sandbox_bank_transfer_fire_webhook",
3887
+ :header_params => header_params,
3888
+ :query_params => query_params,
3889
+ :form_params => form_params,
3890
+ :body => post_body,
3891
+ :auth_names => auth_names,
3892
+ :return_type => return_type
3893
+ )
3894
+
3895
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
3896
+ if @api_client.config.debugging
3897
+ @api_client.config.logger.debug "API called: PlaidApi#sandbox_bank_transfer_fire_webhook\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3898
+ end
3899
+ return data, status_code, headers
3900
+ end
3901
+
3833
3902
  # Simulate a bank transfer event in Sandbox
3834
3903
  # Use the `/sandbox/bank_transfer/simulate` endpoint to simulate a bank transfer event in the Sandbox environment. Note that while an event will be simulated and will appear when using endpoints such as `/bank_transfer/event/sync` or `/bank_transfer/event/list`, no transactions will actually take place and funds will not move between accounts, even within the Sandbox.
3835
3904
  # @param sandbox_bank_transfer_simulate_request [SandboxBankTransferSimulateRequest]
@@ -4217,7 +4286,7 @@ module Plaid
4217
4286
  end
4218
4287
 
4219
4288
  # Get transaction data
4220
- # The `/transactions/get` endpoint allows developers to receive user-authorized transaction data for credit, depository, and some loan-type accounts (the list of loan-type accounts supported is the same as for Liabilities; for details, see the `/liabilities/get` endpoint). For transaction history from investments accounts, use the [Investments endpoint](/docs/api/products#investments) instead. Transaction data is standardized across financial institutions, and in many cases transactions are linked to a clean name, entity type, location, and category. Similarly, account data is standardized and returned with a clean name, number, balance, and other meta information where available. Transactions are returned in reverse-chronological order, and the sequence of transaction ordering is stable and will not shift. Transactions are not immutable and can also be removed altogether by the institution; a removed transaction will no longer appear in `/transactions/get`. For more details, see [Pending and posted transactions](/docs/transactions/transactions-data/#pending-and-posted-transactions). Due to the potentially large number of transactions associated with an Item, results are paginated. Manipulate the `count` and `offset` parameters in conjunction with the `total_transactions` response body field to fetch all available transactions. Note that data may not be immediately available to `/transactions/get`. Plaid will begin to prepare transactions data upon Item link, if Link was initialized with `transactions`, or upon the first call to `/transactions/get`, if it wasn't. To be alerted when transaction data is ready to be fetched, listen for the [`INITIAL_UPDATE`](/docs/api/webhooks#transactions-initial_update) and [`HISTORICAL_UPDATE`](/docs/api/webhooks#transactions-historical_update) webhooks. If no transaction history is ready when `/transactions/get` is called, it will return a `PRODUCT_NOT_READY` error.
4289
+ # The `/transactions/get` endpoint allows developers to receive user-authorized transaction data for credit, depository, and some loan-type accounts (the list of loan-type accounts supported is the same as for Liabilities; for details, see the `/liabilities/get` endpoint). For transaction history from investments accounts, use the [Investments endpoint](/docs/api/products#investments) instead. Transaction data is standardized across financial institutions, and in many cases transactions are linked to a clean name, entity type, location, and category. Similarly, account data is standardized and returned with a clean name, number, balance, and other meta information where available. Transactions are returned in reverse-chronological order, and the sequence of transaction ordering is stable and will not shift. Transactions are not immutable and can also be removed altogether by the institution; a removed transaction will no longer appear in `/transactions/get`. For more details, see [Pending and posted transactions](/docs/transactions/transactions-data/#pending-and-posted-transactions). Due to the potentially large number of transactions associated with an Item, results are paginated. Manipulate the `count` and `offset` parameters in conjunction with the `total_transactions` response body field to fetch all available transactions. Data returned by `/transactions/get` will be the data available for the Item as of the most recent successful check for new transactions. Plaid typically checks for new data multiple times a day, but these checks may occur less frequently, such as once a day, depending on the institution. An Item's `status.transactions.last_successful_update` field will show the timestamp of the most recent successful update. To force Plaid to check for new transactions, you can use the `/transactions/refresh` endpoint. Note that data may not be immediately available to `/transactions/get`. Plaid will begin to prepare transactions data upon Item link, if Link was initialized with `transactions`, or upon the first call to `/transactions/get`, if it wasn't. To be alerted when transaction data is ready to be fetched, listen for the [`INITIAL_UPDATE`](/docs/api/webhooks#transactions-initial_update) and [`HISTORICAL_UPDATE`](/docs/api/webhooks#transactions-historical_update) webhooks. If no transaction history is ready when `/transactions/get` is called, it will return a `PRODUCT_NOT_READY` error.
4221
4290
  # @param transactions_get_request [TransactionsGetRequest]
4222
4291
  # @param [Hash] opts the optional parameters
4223
4292
  # @return [TransactionsGetResponse]
@@ -4227,7 +4296,7 @@ module Plaid
4227
4296
  end
4228
4297
 
4229
4298
  # Get transaction data
4230
- # The &#x60;/transactions/get&#x60; endpoint allows developers to receive user-authorized transaction data for credit, depository, and some loan-type accounts (the list of loan-type accounts supported is the same as for Liabilities; for details, see the &#x60;/liabilities/get&#x60; endpoint). For transaction history from investments accounts, use the [Investments endpoint](/docs/api/products#investments) instead. Transaction data is standardized across financial institutions, and in many cases transactions are linked to a clean name, entity type, location, and category. Similarly, account data is standardized and returned with a clean name, number, balance, and other meta information where available. Transactions are returned in reverse-chronological order, and the sequence of transaction ordering is stable and will not shift. Transactions are not immutable and can also be removed altogether by the institution; a removed transaction will no longer appear in &#x60;/transactions/get&#x60;. For more details, see [Pending and posted transactions](/docs/transactions/transactions-data/#pending-and-posted-transactions). Due to the potentially large number of transactions associated with an Item, results are paginated. Manipulate the &#x60;count&#x60; and &#x60;offset&#x60; parameters in conjunction with the &#x60;total_transactions&#x60; response body field to fetch all available transactions. Note that data may not be immediately available to &#x60;/transactions/get&#x60;. Plaid will begin to prepare transactions data upon Item link, if Link was initialized with &#x60;transactions&#x60;, or upon the first call to &#x60;/transactions/get&#x60;, if it wasn&#39;t. To be alerted when transaction data is ready to be fetched, listen for the [&#x60;INITIAL_UPDATE&#x60;](/docs/api/webhooks#transactions-initial_update) and [&#x60;HISTORICAL_UPDATE&#x60;](/docs/api/webhooks#transactions-historical_update) webhooks. If no transaction history is ready when &#x60;/transactions/get&#x60; is called, it will return a &#x60;PRODUCT_NOT_READY&#x60; error.
4299
+ # The &#x60;/transactions/get&#x60; endpoint allows developers to receive user-authorized transaction data for credit, depository, and some loan-type accounts (the list of loan-type accounts supported is the same as for Liabilities; for details, see the &#x60;/liabilities/get&#x60; endpoint). For transaction history from investments accounts, use the [Investments endpoint](/docs/api/products#investments) instead. Transaction data is standardized across financial institutions, and in many cases transactions are linked to a clean name, entity type, location, and category. Similarly, account data is standardized and returned with a clean name, number, balance, and other meta information where available. Transactions are returned in reverse-chronological order, and the sequence of transaction ordering is stable and will not shift. Transactions are not immutable and can also be removed altogether by the institution; a removed transaction will no longer appear in &#x60;/transactions/get&#x60;. For more details, see [Pending and posted transactions](/docs/transactions/transactions-data/#pending-and-posted-transactions). Due to the potentially large number of transactions associated with an Item, results are paginated. Manipulate the &#x60;count&#x60; and &#x60;offset&#x60; parameters in conjunction with the &#x60;total_transactions&#x60; response body field to fetch all available transactions. Data returned by &#x60;/transactions/get&#x60; will be the data available for the Item as of the most recent successful check for new transactions. Plaid typically checks for new data multiple times a day, but these checks may occur less frequently, such as once a day, depending on the institution. An Item&#39;s &#x60;status.transactions.last_successful_update&#x60; field will show the timestamp of the most recent successful update. To force Plaid to check for new transactions, you can use the &#x60;/transactions/refresh&#x60; endpoint. Note that data may not be immediately available to &#x60;/transactions/get&#x60;. Plaid will begin to prepare transactions data upon Item link, if Link was initialized with &#x60;transactions&#x60;, or upon the first call to &#x60;/transactions/get&#x60;, if it wasn&#39;t. To be alerted when transaction data is ready to be fetched, listen for the [&#x60;INITIAL_UPDATE&#x60;](/docs/api/webhooks#transactions-initial_update) and [&#x60;HISTORICAL_UPDATE&#x60;](/docs/api/webhooks#transactions-historical_update) webhooks. If no transaction history is ready when &#x60;/transactions/get&#x60; is called, it will return a &#x60;PRODUCT_NOT_READY&#x60; error.
4231
4300
  # @param transactions_get_request [TransactionsGetRequest]
4232
4301
  # @param [Hash] opts the optional parameters
4233
4302
  # @return [Array<(TransactionsGetResponse, Integer, Hash)>] TransactionsGetResponse data, response status code and response headers