plaid 14.0.0.beta.2 → 14.0.0.beta.3

Sign up to get free protection for your applications and to get access to all the features.
Files changed (351) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +3 -0
  3. data/Gemfile.lock +1 -1
  4. data/Makefile +3 -3
  5. data/README.md +2 -2
  6. data/docs/AssetReportTransaction.md +4 -0
  7. data/docs/BankTransferBalanceGetResponse.md +1 -1
  8. data/docs/ExternalPaymentSchedule.md +2 -2
  9. data/docs/ExternalPaymentScheduleGet.md +26 -0
  10. data/docs/Item.md +1 -1
  11. data/docs/ItemStatus.md +3 -3
  12. data/docs/LinkTokenCreateRequest.md +1 -1
  13. data/docs/LinkTokenCreateRequestAccountSubtypes.md +4 -4
  14. data/docs/LinkTokenCreateRequestUser.md +1 -1
  15. data/docs/LinkTokenCreateResponse.md +1 -1
  16. data/docs/NullableItemStatus.md +3 -3
  17. data/docs/PaymentInitiationPaymentGetResponse.md +4 -4
  18. data/docs/PaymentInitiationRecipient.md +1 -1
  19. data/docs/PaymentStatusUpdateWebhook.md +8 -0
  20. data/docs/PlaidApi.md +2 -2
  21. data/docs/Transaction.md +4 -0
  22. data/docs/TransactionsRefreshRequest.md +1 -1
  23. data/lib/plaid.rb +2 -9
  24. data/lib/plaid/api/plaid_api.rb +3 -3
  25. data/lib/plaid/api_client.rb +1 -1
  26. data/lib/plaid/api_error.rb +1 -1
  27. data/lib/plaid/configuration.rb +1 -1
  28. data/lib/plaid/models/account_assets.rb +1 -1
  29. data/lib/plaid/models/account_assets_all_of.rb +1 -1
  30. data/lib/plaid/models/account_balance.rb +1 -1
  31. data/lib/plaid/models/account_base.rb +1 -1
  32. data/lib/plaid/models/account_filters_response.rb +1 -1
  33. data/lib/plaid/models/account_identity.rb +1 -1
  34. data/lib/plaid/models/account_identity_all_of.rb +1 -1
  35. data/lib/plaid/models/account_subtype.rb +1 -1
  36. data/lib/plaid/models/account_type.rb +1 -1
  37. data/lib/plaid/models/accounts_balance_get_request.rb +1 -1
  38. data/lib/plaid/models/accounts_balance_get_request_options.rb +1 -1
  39. data/lib/plaid/models/accounts_get_request.rb +1 -1
  40. data/lib/plaid/models/accounts_get_request_options.rb +1 -1
  41. data/lib/plaid/models/accounts_get_response.rb +1 -1
  42. data/lib/plaid/models/ach_class.rb +1 -1
  43. data/lib/plaid/models/address.rb +1 -1
  44. data/lib/plaid/models/address_data.rb +1 -1
  45. data/lib/plaid/models/amount.rb +1 -1
  46. data/lib/plaid/models/apr.rb +1 -1
  47. data/lib/plaid/models/asset_report.rb +1 -1
  48. data/lib/plaid/models/asset_report_audit_copy_create_request.rb +1 -1
  49. data/lib/plaid/models/asset_report_audit_copy_create_response.rb +1 -1
  50. data/lib/plaid/models/asset_report_audit_copy_get_request.rb +1 -1
  51. data/lib/plaid/models/asset_report_audit_copy_remove_request.rb +1 -1
  52. data/lib/plaid/models/asset_report_audit_copy_remove_response.rb +1 -1
  53. data/lib/plaid/models/asset_report_create_request.rb +1 -1
  54. data/lib/plaid/models/asset_report_create_request_options.rb +1 -1
  55. data/lib/plaid/models/asset_report_create_response.rb +1 -1
  56. data/lib/plaid/models/asset_report_filter_request.rb +1 -1
  57. data/lib/plaid/models/asset_report_filter_response.rb +1 -1
  58. data/lib/plaid/models/asset_report_get_request.rb +1 -1
  59. data/lib/plaid/models/asset_report_get_response.rb +1 -1
  60. data/lib/plaid/models/asset_report_item.rb +1 -1
  61. data/lib/plaid/models/asset_report_pdf_get_request.rb +1 -1
  62. data/lib/plaid/models/asset_report_refresh_request.rb +1 -1
  63. data/lib/plaid/models/asset_report_refresh_request_options.rb +1 -1
  64. data/lib/plaid/models/asset_report_refresh_response.rb +1 -1
  65. data/lib/plaid/models/asset_report_remove_request.rb +1 -1
  66. data/lib/plaid/models/asset_report_remove_response.rb +1 -1
  67. data/lib/plaid/models/asset_report_transaction.rb +24 -2
  68. data/lib/plaid/models/asset_report_transaction_all_of.rb +1 -1
  69. data/lib/plaid/models/asset_report_user.rb +1 -1
  70. data/lib/plaid/models/assets_error_webhook.rb +1 -1
  71. data/lib/plaid/models/assets_product_ready_webhook.rb +1 -1
  72. data/lib/plaid/models/auth_get_numbers.rb +1 -1
  73. data/lib/plaid/models/auth_get_request.rb +1 -1
  74. data/lib/plaid/models/auth_get_request_options.rb +1 -1
  75. data/lib/plaid/models/auth_get_response.rb +1 -1
  76. data/lib/plaid/models/automatically_verified_webhook.rb +1 -1
  77. data/lib/plaid/models/bank_transfer.rb +1 -1
  78. data/lib/plaid/models/bank_transfer_balance.rb +1 -1
  79. data/lib/plaid/models/bank_transfer_balance_get_request.rb +1 -1
  80. data/lib/plaid/models/bank_transfer_balance_get_response.rb +1 -1
  81. data/lib/plaid/models/bank_transfer_cancel_request.rb +1 -1
  82. data/lib/plaid/models/bank_transfer_cancel_response.rb +1 -1
  83. data/lib/plaid/models/bank_transfer_create_request.rb +1 -1
  84. data/lib/plaid/models/bank_transfer_create_response.rb +1 -1
  85. data/lib/plaid/models/bank_transfer_direction.rb +1 -1
  86. data/lib/plaid/models/bank_transfer_event.rb +1 -1
  87. data/lib/plaid/models/bank_transfer_event_list_request.rb +1 -1
  88. data/lib/plaid/models/bank_transfer_event_list_response.rb +1 -1
  89. data/lib/plaid/models/bank_transfer_event_sync_request.rb +1 -1
  90. data/lib/plaid/models/bank_transfer_event_sync_response.rb +1 -1
  91. data/lib/plaid/models/bank_transfer_event_type.rb +1 -1
  92. data/lib/plaid/models/bank_transfer_failure.rb +1 -1
  93. data/lib/plaid/models/bank_transfer_get_request.rb +1 -1
  94. data/lib/plaid/models/bank_transfer_get_response.rb +1 -1
  95. data/lib/plaid/models/bank_transfer_list_request.rb +1 -1
  96. data/lib/plaid/models/bank_transfer_list_response.rb +1 -1
  97. data/lib/plaid/models/bank_transfer_migrate_account_request.rb +1 -1
  98. data/lib/plaid/models/bank_transfer_migrate_account_response.rb +1 -1
  99. data/lib/plaid/models/bank_transfer_network.rb +1 -1
  100. data/lib/plaid/models/bank_transfer_receiver_details.rb +1 -1
  101. data/lib/plaid/models/bank_transfer_status.rb +1 -1
  102. data/lib/plaid/models/bank_transfer_type.rb +1 -1
  103. data/lib/plaid/models/bank_transfer_user.rb +1 -1
  104. data/lib/plaid/models/categories_get_response.rb +1 -1
  105. data/lib/plaid/models/category.rb +1 -1
  106. data/lib/plaid/models/cause.rb +1 -1
  107. data/lib/plaid/models/country_code.rb +1 -1
  108. data/lib/plaid/models/credit_card_liability.rb +1 -1
  109. data/lib/plaid/models/credit_filter.rb +1 -1
  110. data/lib/plaid/models/default_update_webhook.rb +1 -1
  111. data/lib/plaid/models/deposit_switch_address_data.rb +1 -1
  112. data/lib/plaid/models/deposit_switch_alt_create_request.rb +1 -1
  113. data/lib/plaid/models/deposit_switch_alt_create_response.rb +1 -1
  114. data/lib/plaid/models/deposit_switch_create_request.rb +1 -1
  115. data/lib/plaid/models/deposit_switch_create_response.rb +1 -1
  116. data/lib/plaid/models/deposit_switch_get_request.rb +1 -1
  117. data/lib/plaid/models/deposit_switch_get_response.rb +1 -1
  118. data/lib/plaid/models/deposit_switch_target_account.rb +1 -1
  119. data/lib/plaid/models/deposit_switch_target_user.rb +1 -1
  120. data/lib/plaid/models/deposit_switch_token_create_request.rb +1 -1
  121. data/lib/plaid/models/deposit_switch_token_create_response.rb +1 -1
  122. data/lib/plaid/models/depository_filter.rb +1 -1
  123. data/lib/plaid/models/email.rb +1 -1
  124. data/lib/plaid/models/employee.rb +1 -1
  125. data/lib/plaid/models/employee_income_summary_field_string.rb +1 -1
  126. data/lib/plaid/models/employer.rb +1 -1
  127. data/lib/plaid/models/employer_income_summary_field_string.rb +1 -1
  128. data/lib/plaid/models/employers_search_request.rb +1 -1
  129. data/lib/plaid/models/employers_search_response.rb +1 -1
  130. data/lib/plaid/models/error.rb +1 -1
  131. data/lib/plaid/models/external_payment_schedule.rb +3 -3
  132. data/lib/plaid/models/{item_status_investments.rb → external_payment_schedule_get.rb} +73 -22
  133. data/lib/plaid/models/health_incident.rb +1 -1
  134. data/lib/plaid/models/historical_balance.rb +1 -1
  135. data/lib/plaid/models/historical_update_webhook.rb +1 -1
  136. data/lib/plaid/models/holding.rb +1 -1
  137. data/lib/plaid/models/holdings_default_update_webhook.rb +1 -1
  138. data/lib/plaid/models/identity_get_request.rb +1 -1
  139. data/lib/plaid/models/identity_get_request_options.rb +1 -1
  140. data/lib/plaid/models/identity_get_response.rb +1 -1
  141. data/lib/plaid/models/incident_update.rb +1 -1
  142. data/lib/plaid/models/income_breakdown.rb +1 -1
  143. data/lib/plaid/models/income_summary.rb +1 -1
  144. data/lib/plaid/models/income_summary_field_number.rb +1 -1
  145. data/lib/plaid/models/income_summary_field_string.rb +1 -1
  146. data/lib/plaid/models/income_verification_create_request.rb +1 -1
  147. data/lib/plaid/models/income_verification_create_response.rb +1 -1
  148. data/lib/plaid/models/income_verification_documents_download_request.rb +1 -1
  149. data/lib/plaid/models/income_verification_documents_download_response.rb +1 -1
  150. data/lib/plaid/models/income_verification_paystub_get_request.rb +1 -1
  151. data/lib/plaid/models/income_verification_paystub_get_response.rb +1 -1
  152. data/lib/plaid/models/income_verification_status_webhook.rb +1 -1
  153. data/lib/plaid/models/income_verification_summary_get_request.rb +1 -1
  154. data/lib/plaid/models/income_verification_summary_get_response.rb +1 -1
  155. data/lib/plaid/models/income_verification_webhook_status.rb +1 -1
  156. data/lib/plaid/models/inflow_model.rb +1 -1
  157. data/lib/plaid/models/initial_update_webhook.rb +1 -1
  158. data/lib/plaid/models/institution.rb +1 -1
  159. data/lib/plaid/models/institution_status.rb +1 -1
  160. data/lib/plaid/models/institutions_get_by_id_request.rb +1 -1
  161. data/lib/plaid/models/institutions_get_by_id_request_options.rb +1 -1
  162. data/lib/plaid/models/institutions_get_by_id_response.rb +1 -1
  163. data/lib/plaid/models/institutions_get_request.rb +1 -1
  164. data/lib/plaid/models/institutions_get_request_options.rb +1 -1
  165. data/lib/plaid/models/institutions_get_response.rb +1 -1
  166. data/lib/plaid/models/institutions_search_account_filter.rb +1 -1
  167. data/lib/plaid/models/institutions_search_request.rb +1 -1
  168. data/lib/plaid/models/institutions_search_request_options.rb +1 -1
  169. data/lib/plaid/models/institutions_search_response.rb +1 -1
  170. data/lib/plaid/models/investment_filter.rb +1 -1
  171. data/lib/plaid/models/investment_holdings_get_request_options.rb +1 -1
  172. data/lib/plaid/models/investment_transaction.rb +1 -1
  173. data/lib/plaid/models/investments_default_update_webhook.rb +1 -1
  174. data/lib/plaid/models/investments_holdings_get_request.rb +1 -1
  175. data/lib/plaid/models/investments_holdings_get_response.rb +1 -1
  176. data/lib/plaid/models/investments_transactions_get_request.rb +1 -1
  177. data/lib/plaid/models/investments_transactions_get_request_options.rb +1 -1
  178. data/lib/plaid/models/investments_transactions_get_response.rb +1 -1
  179. data/lib/plaid/models/item.rb +41 -1
  180. data/lib/plaid/models/item_access_token_invalidate_request.rb +1 -1
  181. data/lib/plaid/models/item_access_token_invalidate_response.rb +1 -1
  182. data/lib/plaid/models/item_error_webhook.rb +1 -1
  183. data/lib/plaid/models/item_get_request.rb +1 -1
  184. data/lib/plaid/models/item_get_response.rb +1 -1
  185. data/lib/plaid/models/item_import_request.rb +1 -1
  186. data/lib/plaid/models/item_import_request_options.rb +1 -1
  187. data/lib/plaid/models/item_import_request_user_auth.rb +1 -1
  188. data/lib/plaid/models/item_import_response.rb +1 -1
  189. data/lib/plaid/models/item_product_ready_webhook.rb +1 -1
  190. data/lib/plaid/models/item_public_token_create_request.rb +1 -1
  191. data/lib/plaid/models/item_public_token_create_response.rb +1 -1
  192. data/lib/plaid/models/item_public_token_exchange_request.rb +1 -1
  193. data/lib/plaid/models/item_public_token_exchange_response.rb +1 -1
  194. data/lib/plaid/models/item_remove_request.rb +1 -1
  195. data/lib/plaid/models/item_remove_response.rb +1 -1
  196. data/lib/plaid/models/item_status.rb +16 -7
  197. data/lib/plaid/models/item_webhook_update_request.rb +1 -1
  198. data/lib/plaid/models/item_webhook_update_response.rb +1 -1
  199. data/lib/plaid/models/jwk_public_key.rb +1 -1
  200. data/lib/plaid/models/jwt_header.rb +1 -1
  201. data/lib/plaid/models/liabilities_get_request.rb +1 -1
  202. data/lib/plaid/models/liabilities_get_request_options.rb +1 -1
  203. data/lib/plaid/models/liabilities_get_response.rb +1 -1
  204. data/lib/plaid/models/liabilities_object.rb +1 -1
  205. data/lib/plaid/models/liability_override.rb +1 -1
  206. data/lib/plaid/models/link_token_account_filters.rb +1 -1
  207. data/lib/plaid/models/link_token_create_request.rb +2 -2
  208. data/lib/plaid/models/link_token_create_request_account_subtypes.rb +21 -9
  209. data/lib/plaid/models/link_token_create_request_deposit_switch.rb +1 -1
  210. data/lib/plaid/models/link_token_create_request_income_verification.rb +1 -1
  211. data/lib/plaid/models/link_token_create_request_payment_initiation.rb +1 -1
  212. data/lib/plaid/models/link_token_create_request_user.rb +2 -2
  213. data/lib/plaid/models/link_token_create_response.rb +2 -2
  214. data/lib/plaid/models/link_token_get_metadata_response.rb +1 -1
  215. data/lib/plaid/models/link_token_get_request.rb +1 -1
  216. data/lib/plaid/models/link_token_get_response.rb +1 -1
  217. data/lib/plaid/models/loan_filter.rb +1 -1
  218. data/lib/plaid/models/location.rb +1 -1
  219. data/lib/plaid/models/meta.rb +1 -1
  220. data/lib/plaid/models/mfa.rb +1 -1
  221. data/lib/plaid/models/mortgage_interest_rate.rb +1 -1
  222. data/lib/plaid/models/mortgage_liability.rb +1 -1
  223. data/lib/plaid/models/mortgage_property_address.rb +1 -1
  224. data/lib/plaid/models/nullable_access_token.rb +1 -1
  225. data/lib/plaid/models/nullable_address.rb +1 -1
  226. data/lib/plaid/models/nullable_address_data.rb +1 -1
  227. data/lib/plaid/models/nullable_item_status.rb +16 -7
  228. data/lib/plaid/models/nullable_numbers_ach.rb +1 -1
  229. data/lib/plaid/models/nullable_numbers_bacs.rb +1 -1
  230. data/lib/plaid/models/nullable_numbers_eft.rb +1 -1
  231. data/lib/plaid/models/nullable_numbers_international.rb +1 -1
  232. data/lib/plaid/models/nullable_recipient_bacs.rb +1 -1
  233. data/lib/plaid/models/numbers.rb +1 -1
  234. data/lib/plaid/models/numbers_ach.rb +1 -1
  235. data/lib/plaid/models/numbers_bacs.rb +1 -1
  236. data/lib/plaid/models/numbers_eft.rb +1 -1
  237. data/lib/plaid/models/numbers_international.rb +1 -1
  238. data/lib/plaid/models/override_accounts.rb +1 -1
  239. data/lib/plaid/models/owner.rb +1 -1
  240. data/lib/plaid/models/owner_override.rb +1 -1
  241. data/lib/plaid/models/pay_frequency.rb +1 -1
  242. data/lib/plaid/models/pay_period_details.rb +1 -1
  243. data/lib/plaid/models/payment_amount.rb +1 -1
  244. data/lib/plaid/models/payment_initiation_address.rb +1 -1
  245. data/lib/plaid/models/payment_initiation_payment_create_request.rb +1 -1
  246. data/lib/plaid/models/payment_initiation_payment_create_response.rb +1 -1
  247. data/lib/plaid/models/payment_initiation_payment_get_request.rb +1 -1
  248. data/lib/plaid/models/payment_initiation_payment_get_response.rb +17 -16
  249. data/lib/plaid/models/payment_initiation_payment_list_request.rb +1 -1
  250. data/lib/plaid/models/payment_initiation_payment_list_response.rb +1 -1
  251. data/lib/plaid/models/payment_initiation_payment_token_create_request.rb +1 -1
  252. data/lib/plaid/models/payment_initiation_payment_token_create_response.rb +1 -1
  253. data/lib/plaid/models/payment_initiation_recipient.rb +5 -3
  254. data/lib/plaid/models/payment_initiation_recipient_create_request.rb +1 -1
  255. data/lib/plaid/models/payment_initiation_recipient_create_response.rb +1 -1
  256. data/lib/plaid/models/payment_initiation_recipient_get_request.rb +1 -1
  257. data/lib/plaid/models/payment_initiation_recipient_get_response.rb +1 -1
  258. data/lib/plaid/models/payment_initiation_recipient_list_request.rb +1 -1
  259. data/lib/plaid/models/payment_initiation_recipient_list_response.rb +1 -1
  260. data/lib/plaid/models/payment_meta.rb +1 -1
  261. data/lib/plaid/models/payment_status_update_webhook.rb +46 -2
  262. data/lib/plaid/models/paystub.rb +1 -1
  263. data/lib/plaid/models/paystub_deduction.rb +1 -1
  264. data/lib/plaid/models/paystub_ytd_details.rb +1 -1
  265. data/lib/plaid/models/pending_expiration_webhook.rb +1 -1
  266. data/lib/plaid/models/phone_number.rb +1 -1
  267. data/lib/plaid/models/processor_apex_processor_token_create_request.rb +1 -1
  268. data/lib/plaid/models/processor_auth_get_request.rb +1 -1
  269. data/lib/plaid/models/processor_auth_get_response.rb +1 -1
  270. data/lib/plaid/models/processor_balance_get_request.rb +1 -1
  271. data/lib/plaid/models/processor_balance_get_response.rb +1 -1
  272. data/lib/plaid/models/processor_identity_get_request.rb +1 -1
  273. data/lib/plaid/models/processor_identity_get_response.rb +1 -1
  274. data/lib/plaid/models/processor_number.rb +1 -1
  275. data/lib/plaid/models/processor_stripe_bank_account_token_create_request.rb +1 -1
  276. data/lib/plaid/models/processor_stripe_bank_account_token_create_response.rb +1 -1
  277. data/lib/plaid/models/processor_token_create_request.rb +1 -1
  278. data/lib/plaid/models/processor_token_create_response.rb +1 -1
  279. data/lib/plaid/models/product_status.rb +1 -1
  280. data/lib/plaid/models/product_status_breakdown.rb +1 -1
  281. data/lib/plaid/models/products.rb +1 -1
  282. data/lib/plaid/models/projected_income_summary_field_number.rb +1 -1
  283. data/lib/plaid/models/pslf_status.rb +1 -1
  284. data/lib/plaid/models/recaptcha_required_error.rb +1 -1
  285. data/lib/plaid/models/recipient_bacs.rb +1 -1
  286. data/lib/plaid/models/sandbox_bank_transfer_simulate_request.rb +1 -1
  287. data/lib/plaid/models/sandbox_bank_transfer_simulate_response.rb +1 -1
  288. data/lib/plaid/models/sandbox_item_fire_webhook_request.rb +1 -1
  289. data/lib/plaid/models/sandbox_item_fire_webhook_response.rb +1 -1
  290. data/lib/plaid/models/sandbox_item_reset_login_request.rb +1 -1
  291. data/lib/plaid/models/sandbox_item_reset_login_response.rb +1 -1
  292. data/lib/plaid/models/sandbox_item_set_verification_status_request.rb +1 -1
  293. data/lib/plaid/models/sandbox_item_set_verification_status_response.rb +1 -1
  294. data/lib/plaid/models/sandbox_processor_token_create_request.rb +1 -1
  295. data/lib/plaid/models/sandbox_processor_token_create_request_options.rb +1 -1
  296. data/lib/plaid/models/sandbox_processor_token_create_response.rb +1 -1
  297. data/lib/plaid/models/sandbox_public_token_create_request.rb +1 -1
  298. data/lib/plaid/models/sandbox_public_token_create_request_options.rb +1 -1
  299. data/lib/plaid/models/sandbox_public_token_create_request_options_transactions.rb +1 -1
  300. data/lib/plaid/models/sandbox_public_token_create_response.rb +1 -1
  301. data/lib/plaid/models/security.rb +1 -1
  302. data/lib/plaid/models/servicer_address_data.rb +1 -1
  303. data/lib/plaid/models/standalone_account_type.rb +1 -1
  304. data/lib/plaid/models/standalone_currency_code_list.rb +1 -1
  305. data/lib/plaid/models/standalone_investment_transaction_subtype.rb +1 -1
  306. data/lib/plaid/models/standalone_investment_transaction_type.rb +1 -1
  307. data/lib/plaid/models/student_loan.rb +1 -1
  308. data/lib/plaid/models/student_loan_repayment_model.rb +1 -1
  309. data/lib/plaid/models/student_loan_status.rb +1 -1
  310. data/lib/plaid/models/student_repayment_plan.rb +1 -1
  311. data/lib/plaid/models/transaction.rb +24 -2
  312. data/lib/plaid/models/transaction_code.rb +1 -1
  313. data/lib/plaid/models/transaction_data.rb +1 -1
  314. data/lib/plaid/models/transaction_override.rb +1 -1
  315. data/lib/plaid/models/transactions_get_request.rb +1 -1
  316. data/lib/plaid/models/transactions_get_request_options.rb +1 -1
  317. data/lib/plaid/models/transactions_get_response.rb +1 -1
  318. data/lib/plaid/models/transactions_refresh_request.rb +6 -1
  319. data/lib/plaid/models/transactions_refresh_response.rb +1 -1
  320. data/lib/plaid/models/transactions_removed_webhook.rb +1 -1
  321. data/lib/plaid/models/user_custom_password.rb +1 -1
  322. data/lib/plaid/models/user_permission_revoked_webhook.rb +1 -1
  323. data/lib/plaid/models/verification_expired_webhook.rb +1 -1
  324. data/lib/plaid/models/verification_status.rb +1 -1
  325. data/lib/plaid/models/warning.rb +1 -1
  326. data/lib/plaid/models/webhook_update_acknowledged_webhook.rb +1 -1
  327. data/lib/plaid/models/webhook_verification_key_get_request.rb +1 -1
  328. data/lib/plaid/models/webhook_verification_key_get_response.rb +1 -1
  329. data/lib/plaid/models/ytd_gross_income_summary_field_number.rb +1 -1
  330. data/lib/plaid/models/ytd_net_income_summary_field_number.rb +1 -1
  331. data/lib/plaid/version.rb +2 -2
  332. data/pkg/plaid-14.0.0.beta.3.gem +0 -0
  333. data/plaid.gemspec +2 -2
  334. data/test/test_item.rb +2 -2
  335. metadata +13 -27
  336. data/docs/ItemStatusInvestments.md +0 -20
  337. data/docs/ItemStatusLastWebhook.md +0 -20
  338. data/docs/ItemStatusTransactions.md +0 -20
  339. data/docs/LinkTokenCreateRequestAccountSubtypesCredit.md +0 -18
  340. data/docs/LinkTokenCreateRequestAccountSubtypesDepository.md +0 -18
  341. data/docs/LinkTokenCreateRequestAccountSubtypesInvestment.md +0 -18
  342. data/docs/LinkTokenCreateRequestAccountSubtypesLoan.md +0 -18
  343. data/docs/PaymentInitiationRecipientBacs.md +0 -20
  344. data/lib/plaid/models/item_status_last_webhook.rb +0 -232
  345. data/lib/plaid/models/item_status_transactions.rb +0 -232
  346. data/lib/plaid/models/link_token_create_request_account_subtypes_credit.rb +0 -222
  347. data/lib/plaid/models/link_token_create_request_account_subtypes_depository.rb +0 -222
  348. data/lib/plaid/models/link_token_create_request_account_subtypes_investment.rb +0 -222
  349. data/lib/plaid/models/link_token_create_request_account_subtypes_loan.rb +0 -222
  350. data/lib/plaid/models/payment_initiation_recipient_bacs.rb +0 -237
  351. data/pkg/plaid-14.0.0.beta.2.gem +0 -0
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: e8c05e8bb5cbfacc0902d2ba1e55caa9e598903400664b6e3af05194f9030f48
4
- data.tar.gz: d91005c3e51594ffd83a0a018eeed137c4617cf34e19b6d213de72576f351925
3
+ metadata.gz: ee2d1cba8ea4b9a4e74f6e845826457abfb0db01c73cbd5d81385040ad88bbe8
4
+ data.tar.gz: c30e67570b80c0eeb2d62fb1fff537747d736a80ce8d6801c5ef7d20f98fd628
5
5
  SHA512:
6
- metadata.gz: 59a640409c54e4c585dff9597c99ee9cee2283d5b48299cc800e0e5572380e468d138553eb072523e209c21963850954f74d6310e77d58e153b2f50c8d2080f6
7
- data.tar.gz: 7e951849c7ddc3da52f234959c7d598fe027445d1f7931e40f170937313993449b1247abef2abc27acbb1efbdfac246dc67e62b5cc68dbf6c5af4230da30f315
6
+ metadata.gz: a248f03836383e29d0aea12b05f8aaf7375bc62de99531bd5b83b7c858f40f30a38b20b820b4f9031e9a453f0d43493ecb4b5da52753292233b80de02ac82e63
7
+ data.tar.gz: b727db3ce0953017a6cbe565fc0690fddb9173d57b67a066ccb75bea778973170de4a0a0cad0c77d7e3be81c50b56e017d354a1563c600a00ddb545e3487bf05
data/CHANGELOG.md CHANGED
@@ -1,3 +1,6 @@
1
+ # 14.0.0.beta.3
2
+ Type fixes, see full changelog [here](https://github.com/plaid/plaid-openapi/blob/master/CHANGELOG.md).
3
+
1
4
  # 14.0.0.beta.1
2
5
 
3
6
  This version represents a transition in how we maintain our external client libraries. We are now using an [API spec](https://github.com/plaid/plaid-openapi) written in `OpenAPI 3.0.0` and running our definition file through [OpenAPITool's `python` generator](https://github.com/OpenAPITools/openapi-generator).
data/Gemfile.lock CHANGED
@@ -1,7 +1,7 @@
1
1
  PATH
2
2
  remote: .
3
3
  specs:
4
- plaid (14.0.0.beta.2)
4
+ plaid (14.0.0.beta.3)
5
5
  faraday (~> 1.0, >= 1.0.1)
6
6
 
7
7
  GEM
data/Makefile CHANGED
@@ -2,9 +2,9 @@ CURRENT_DIR:=$(shell pwd)
2
2
  OPENAPI_FILE:=2020-09-14.yml
3
3
  # Theres a bug in 5.0.1 for ruby generation. https://github.com/OpenAPITools/openapi-generator/issues/8677
4
4
  OPENAPI_GENERATOR_5:=docker run --rm -v $(CURRENT_DIR):/local openapitools/openapi-generator-cli:v5.0.0 generate
5
- OPENAPI_VERSION:=1.5.0-beta
5
+ OPENAPI_VERSION:=1.8.0-beta
6
6
  # Ruby embeds the version in the generator where as others dont os its not possible to cat for it.
7
- RUBY_PACKAGE_VERSION="14.0.0.beta.2"
7
+ RUBY_PACKAGE_VERSION=14.0.0.beta.3
8
8
 
9
9
  .PHONY: pull-openapi
10
10
  pull-openapi:
@@ -17,5 +17,5 @@ build-openapi:
17
17
  -o local/ \
18
18
  --global-property=apiTests=false,modelTests=false \
19
19
  --library=faraday \
20
- -p gemName=plaid,gemRequiredRubyVersion=">= 2.7.1",gemVersion=$(RUBY_PACKAGE_VERSION) \
20
+ -p gemName=plaid,gemRequiredRubyVersion=">= 2.4.0",gemVersion=$(RUBY_PACKAGE_VERSION) \
21
21
  -t local/templates/ruby
data/README.md CHANGED
@@ -16,9 +16,9 @@ And then execute:
16
16
 
17
17
  Or install it yourself as:
18
18
 
19
- $ gem install plaid
19
+ $ gem install plaid --pre
20
20
 
21
- The gem supports Ruby 2.7.1+ only.
21
+ The gem supports Ruby 2.4.0+ only.
22
22
 
23
23
  ### Versioning
24
24
 
@@ -15,7 +15,9 @@
15
15
  | **merchant_name** | **String** | The merchant name, as extracted by Plaid from the `name` field. | [optional] |
16
16
  | **location** | [**Location**](Location.md) | | [optional] |
17
17
  | **authorized_date** | **String** | The date that the transaction was authorized. Dates are returned in an ISO 8601 format ( `YYYY-MM-DD` ). | [optional] |
18
+ | **authorized_datetime** | **String** | Date and time when a transaction was authorized in ISO 8601 format ( `YYYY-MM-DDTHH:mm:ssZ` ). This field is only populated for UK institutions. For institutions in other countries, will be `null`. | [optional] |
18
19
  | **date** | **String** | For pending transactions, the date that the transaction occurred; for posted transactions, the date that the transaction posted. Both dates are returned in an ISO 8601 format ( `YYYY-MM-DD` ). | |
20
+ | **datetime** | **String** | Date and time when a transaction was posted in ISO 8601 format ( `YYYY-MM-DDTHH:mm:ssZ` ). This field is only populated for UK institutions. For institutions in other countries, will be `null`. | [optional] |
19
21
  | **category_id** | **String** | The ID of the category to which this transaction belongs. See [Categories](https://plaid.com/docs/#category-overview). If the `transaction` object was returned by an Assets endpoint such as `/asset_report/get/` or `/asset_report/pdf/get`, this field will only appear in an Asset Report with Insights. | [optional] |
20
22
  | **category** | **Array<String>** | A hierarchical array of the categories to which this transaction belongs. See [Categories](https://plaid.com/docs/#category-overview). If the `transaction` object was returned by an Assets endpoint such as `/asset_report/get/` or `/asset_report/pdf/get`, this field will only appear in an Asset Report with Insights. | [optional] |
21
23
  | **unofficial_currency_code** | **String** | The unofficial currency code associated with the transaction. Always `null` if `iso_currency_code` is non-`null`. Unofficial currency codes are used for currencies that do not have official ISO currency codes, such as cryptocurrencies and the currencies of certain countries. See the [currency code schema](/docs/api/accounts#currency-code-schema) for a full listing of supported `iso_currency_code`s. | [optional] |
@@ -43,7 +45,9 @@ instance = Plaid::AssetReportTransaction.new(
43
45
  merchant_name: null,
44
46
  location: null,
45
47
  authorized_date: null,
48
+ authorized_datetime: null,
46
49
  date: null,
50
+ datetime: null,
47
51
  category_id: null,
48
52
  category: null,
49
53
  unofficial_currency_code: null,
@@ -5,7 +5,7 @@
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **balance** | [**BankTransferBalance**](BankTransferBalance.md) | | |
8
- | **origination_account_id** | **String** | The ID of the origination account that this balance belongs to. | [optional] |
8
+ | **origination_account_id** | **String** | The ID of the origination account that this balance belongs to. | |
9
9
  | **request_id** | **String** | A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive. | |
10
10
 
11
11
  ## Example
@@ -6,8 +6,8 @@
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **interval** | **String** | The frequency interval of the payment. Valid values are `\"WEEKLY\"` or `\"MONTHLY\"`. | |
8
8
  | **interval_execution_day** | **Float** | The day of the interval on which to schedule the payment. If the payment interval is weekly, `interval_execution_day` should be an integer from 1 (Monday) to 7 (Sunday). If the payment interval is monthly, `interval_execution_day` should be an integer indicating which day of the month to make the payment on. Integers from 1 to 28 can be used to make a payment on that day of the month. Negative integers from -1 to -5 can be used to make a payment relative to the end of the month. To make a payment on the last day of the month, use -1; to make the payment on the second-to-last day, use -2, and so on. | |
9
- | **start_date** | **String** | A date in ISO 8601 format (YYYY-MM-DD). Standing order payments will begin on the first `interval_execution_day` on or after the `start_date`. If the first `interval_execution_day` on or after the start date is also the same day that `/payment_initiation/payment/create` was called, the bank *may* make the first payment on that day, but it is not guaranteed to do so. | |
10
- | **end_date** | **String** | A date in ISO 8601 format (YYYY-MM-DD). Standing order payments will end on the last `interval_execution_day` on or before the `end_date`. If the only `interval_execution_day` between the start date and the end date (inclusive) is also the same day that `/payment_initiation/payment/create` was called, the bank *may* make a payment on that day, but it is not guaranteed to do so. | [optional] |
9
+ | **start_date** | **Date** | A date in ISO 8601 format (YYYY-MM-DD). Standing order payments will begin on the first `interval_execution_day` on or after the `start_date`. If the first `interval_execution_day` on or after the start date is also the same day that `/payment_initiation/payment/create` was called, the bank *may* make the first payment on that day, but it is not guaranteed to do so. | |
10
+ | **end_date** | **Date** | A date in ISO 8601 format (YYYY-MM-DD). Standing order payments will end on the last `interval_execution_day` on or before the `end_date`. If the only `interval_execution_day` between the start date and the end date (inclusive) is also the same day that `/payment_initiation/payment/create` was called, the bank *may* make a payment on that day, but it is not guaranteed to do so. | [optional] |
11
11
 
12
12
  ## Example
13
13
 
@@ -0,0 +1,26 @@
1
+ # Plaid::ExternalPaymentScheduleGet
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **adjusted_start_date** | **Date** | The start date sent to the bank after adjusting for holidays or weekends. Will be provided in ISO 8601 format (YYYY-MM-DD). If the start date did not require adjustment, this field will be `null`. | [optional] |
8
+ | **interval** | **String** | The frequency interval of the payment. Valid values are `\"WEEKLY\"` or `\"MONTHLY\"`. | |
9
+ | **interval_execution_day** | **Float** | The day of the interval on which to schedule the payment. If the payment interval is weekly, `interval_execution_day` should be an integer from 1 (Monday) to 7 (Sunday). If the payment interval is monthly, `interval_execution_day` should be an integer indicating which day of the month to make the payment on. Integers from 1 to 28 can be used to make a payment on that day of the month. Negative integers from -1 to -5 can be used to make a payment relative to the end of the month. To make a payment on the last day of the month, use -1; to make the payment on the second-to-last day, use -2, and so on. | |
10
+ | **start_date** | **Date** | A date in ISO 8601 format (YYYY-MM-DD). Standing order payments will begin on the first `interval_execution_day` on or after the `start_date`. If the first `interval_execution_day` on or after the start date is also the same day that `/payment_initiation/payment/create` was called, the bank *may* make the first payment on that day, but it is not guaranteed to do so. | |
11
+ | **end_date** | **Date** | A date in ISO 8601 format (YYYY-MM-DD). Standing order payments will end on the last `interval_execution_day` on or before the `end_date`. If the only `interval_execution_day` between the start date and the end date (inclusive) is also the same day that `/payment_initiation/payment/create` was called, the bank *may* make a payment on that day, but it is not guaranteed to do so. | [optional] |
12
+
13
+ ## Example
14
+
15
+ ```ruby
16
+ require 'plaid'
17
+
18
+ instance = Plaid::ExternalPaymentScheduleGet.new(
19
+ adjusted_start_date: null,
20
+ interval: null,
21
+ interval_execution_day: null,
22
+ start_date: null,
23
+ end_date: null
24
+ )
25
+ ```
26
+
data/docs/Item.md CHANGED
@@ -11,7 +11,7 @@
11
11
  | **available_products** | [**Array<Products>**](Products.md) | A list of products available for the Item that have not yet been accessed. | |
12
12
  | **billed_products** | [**Array<Products>**](Products.md) | A list of products that have been billed for the Item. Note - `billed_products` is populated in all environments but only requests in Production are billed. | |
13
13
  | **consent_expiration_time** | **String** | The RFC 3339 timestamp after which the consent provided by the end user will expire. Upon consent expiration, the item will enter the `ITEM_LOGIN_REQUIRED` error state. To circumvent the `ITEM_LOGIN_REQUIRED` error and maintain continuous consent, the end user can reauthenticate via Link’s update mode in advance of the consent expiration time. Note - This is only relevant for European institutions subject to PSD2 regulations mandating a 90-day consent window. For all other institutions, this field will be null. | [optional] |
14
- | **update_type** | **String** | | [optional] |
14
+ | **update_type** | **String** | Indicates whether an Item requires user interaction to be updated, which can be the case for Items with some forms of two-factor authentication. `background` - Item can be updated in the background `requires_user_authentication` - Item requires user interaction to be updated | |
15
15
 
16
16
  ## Example
17
17
 
data/docs/ItemStatus.md CHANGED
@@ -4,9 +4,9 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **investments** | [**ItemStatusInvestments**](ItemStatusInvestments.md) | | [optional] |
8
- | **transactions** | [**ItemStatusTransactions**](ItemStatusTransactions.md) | | [optional] |
9
- | **last_webhook** | [**ItemStatusLastWebhook**](ItemStatusLastWebhook.md) | | [optional] |
7
+ | **investments** | **Hash<String, Object>** | Information about the last successful and failed investments update for the Item. | [optional] |
8
+ | **transactions** | **Hash<String, Object>** | Information about the last successful and failed transactions update for the Item. | [optional] |
9
+ | **last_webhook** | **Hash<String, Object>** | Information about the last webhook fired for the Item. | [optional] |
10
10
 
11
11
  ## Example
12
12
 
@@ -10,7 +10,7 @@
10
10
  | **language** | **String** | The language that Link should be displayed in. Supported languages are: - English (`'en'`) - French (`'fr'`) - Spanish (`'es'`) - Dutch (`'nl'`) When using a Link customization, the language configured here must match the setting in the customization, or the customization will not be applied. | |
11
11
  | **country_codes** | [**Array<CountryCode>**](CountryCode.md) | Specify an array of Plaid-supported country codes using the ISO-3166-1 alpha-2 country code standard. Institutions from all listed countries will be shown. Supported country codes are: `US`, `CA`, `ES`, `FR`, `GB`, `IE`, `NL`. Example value: `['US', 'CA']`. If Link is launched with multiple country codes, only products that you are enabled for in all countries will be used by Link. Note that while all countries are enabled by default in Sandbox and Development, in Production only US and Canada are enabled by default. To gain access to European institutions in the Production environment, [file a product access Support ticket](https://dashboard.plaid.com/support/new/product-and-development/product-troubleshooting/request-product-access) via the Plaid dashboard. If you initialize with a European country code, your users will see the European consent panel during the Link flow. If using a Link customization, make sure the country codes in the customization match those specified in `country_codes`. If both `country_codes` and a Link customization are used, the value in `country_codes` may override the value in the customization. If using the Auth features Instant Match, Same-day Micro-deposits, or Automated Micro-deposits, `country_codes` must be set to `['US']`. | |
12
12
  | **user** | [**LinkTokenCreateRequestUser**](LinkTokenCreateRequestUser.md) | | |
13
- | **products** | [**Array<Products>**](Products.md) | List of Plaid product(s) you wish to use. If launching Link in update mode, should be omitted; required otherwise. Valid products are: `transactions`, `auth`, `identity`, `assets`, `investments`, `liabilities`, `payment_initiation`, `deposit_switch` Example: `['auth', 'transactions']` `balance` is *not* a valid value, the Balance product does not require explicit initalization and will automatically be initialized when any other product is initialized. Only institutions that support *all* requested products will be shown in Link; to maximize the number of institutions listed, it is recommended to initialize Link with the minimal product set required for your use case. Additional products can be added after Link initialization by calling the relevant endpoints. For details and exceptions, see [Choosing when to initialize products](/docs/link/best-practices/#choosing-when-to-initialize-products). 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`. | [optional] |
13
+ | **products** | [**Array<Products>**](Products.md) | List of Plaid product(s) you wish to use. If launching Link in update mode, should be omitted; required otherwise. Valid products are: `transactions`, `auth`, `identity`, `assets`, `investments`, `liabilities`, `payment_initiation`, `deposit_switch` Example: `['auth', 'transactions']` `balance` is *not* a valid value, the Balance product does not require explicit initalization and will automatically be initialized when any other product is initialized. Only institutions that support *all* requested products will be shown in Link; to maximize the number of institutions listed, it is recommended to initialize Link with the minimal product set required for your use case. Additional products can be added after Link initialization by calling the relevant endpoints. For details and exceptions, see [Choosing when to initialize products](/docs/link/best-practices/#choosing-when-to-initialize-products). 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`. | [optional] |
14
14
  | **webhook** | **String** | The destination URL to which any webhooks should be sent. | [optional] |
15
15
  | **access_token** | **String** | The `access_token` associated with the Item to update, used when updating or modifying an existing `access_token`. Used when launching Link in update mode, when completing the Same-day (manual) Micro-deposit flow, or (optionally) when initializing Link as part of the Payment Initiation (UK and Europe) flow. | [optional] |
16
16
  | **link_customization_name** | **String** | 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`. | [optional] |
@@ -4,10 +4,10 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **depository** | [**LinkTokenCreateRequestAccountSubtypesDepository**](LinkTokenCreateRequestAccountSubtypesDepository.md) | | [optional] |
8
- | **credit** | [**LinkTokenCreateRequestAccountSubtypesCredit**](LinkTokenCreateRequestAccountSubtypesCredit.md) | | [optional] |
9
- | **loan** | [**LinkTokenCreateRequestAccountSubtypesLoan**](LinkTokenCreateRequestAccountSubtypesLoan.md) | | [optional] |
10
- | **investment** | [**LinkTokenCreateRequestAccountSubtypesInvestment**](LinkTokenCreateRequestAccountSubtypesInvestment.md) | | [optional] |
7
+ | **depository** | **Hash<String, Object>** | A filter to apply to `depository`-type accounts | [optional] |
8
+ | **credit** | **Hash<String, Object>** | A filter to apply to `credit`-type accounts | [optional] |
9
+ | **loan** | **Hash<String, Object>** | A filter to apply to `loan`-type accounts | [optional] |
10
+ | **investment** | **Hash<String, Object>** | A filter to apply to `investment`-type accounts | [optional] |
11
11
 
12
12
  ## Example
13
13
 
@@ -4,7 +4,7 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **client_user_id** | **String** | A unique ID representing the end user. Typically this will be a user ID number from your application. Personally identifiable information, such as an email address or phone number, should not be used in the `client_user_id`. | |
7
+ | **client_user_id** | **String** | A unique ID representing the end user. Typically this will be a user ID number from your application. Personally identifiable information, such as an email address or phone number, should not be used in the `client_user_id`. It is currently used as a means of searching logs for the given user in the Plaid Dashboard. | |
8
8
  | **legal_name** | **String** | The user's full legal name. This is an optional field used in the [returning user experience](/docs/link/returning-user) to associate Items to the user. | [optional] |
9
9
  | **phone_number** | **String** | The user's phone number in [E.164](https://en.wikipedia.org/wiki/E.164) format. This field is optional, but required to enable the [returning user experience](/docs/link/returning-user). | [optional] |
10
10
  | **phone_number_verified_time** | **String** | The date and time the phone number was verified in ISO 8601 format (`YYYY-MM-DDThh:mm:ssZ`). This field is optional, but required to enable any [returning user experience](/docs/link/returning-user). Only pass a verification time for a phone number that you have verified. If you have performed verification but don’t have the time, you may supply a signal value of the start of the UNIX epoch. Example: `2020-01-01T00:00:00Z` | [optional] |
@@ -5,7 +5,7 @@
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **link_token** | **String** | A `link_token`, which can be supplied to Link in order to initialize it and receive a `public_token`, which can be exchanged for an `access_token`. | |
8
- | **expiration** | **Time** | The expiration date for the `link_token`, in ISO 8601 format. A `link_token` created to generate a `public_token` that will be exchanged for a new `access_token` expires after 24 hours. A `link_token` created for an existing Item (such as when updating an existing `access_token` by launching Link in update mode) expires after 30 minutes. | |
8
+ | **expiration** | **Time** | The expiration date for the `link_token`, in ISO 8601 format. A `link_token` created to generate a `public_token` that will be exchanged for a new `access_token` expires after 4 hours. A `link_token` created for an existing Item (such as when updating an existing `access_token` by launching Link in update mode) expires after 30 minutes. | |
9
9
  | **request_id** | **String** | A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive. | |
10
10
 
11
11
  ## Example
@@ -4,9 +4,9 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **investments** | [**ItemStatusInvestments**](ItemStatusInvestments.md) | | [optional] |
8
- | **transactions** | [**ItemStatusTransactions**](ItemStatusTransactions.md) | | [optional] |
9
- | **last_webhook** | [**ItemStatusLastWebhook**](ItemStatusLastWebhook.md) | | [optional] |
7
+ | **investments** | **Hash<String, Object>** | Information about the last successful and failed investments update for the Item. | [optional] |
8
+ | **transactions** | **Hash<String, Object>** | Information about the last successful and failed transactions update for the Item. | [optional] |
9
+ | **last_webhook** | **Hash<String, Object>** | Information about the last webhook fired for the Item. | [optional] |
10
10
 
11
11
  ## Example
12
12
 
@@ -10,9 +10,9 @@
10
10
  | **status** | **String** | The status of the payment. `PAYMENT_STATUS_INPUT_NEEDED`: This is the initial state of all payments. It indicates that the payment is waiting on user input to continue processing. A payment may re-enter this state later on if further input is needed. `PAYMENT_STATUS_PROCESSING`: The payment is currently being processed. The payment will automatically exit this state when processing is complete. `PAYMENT_STATUS_INITIATED`: The payment has been successfully initiated and is considered complete. `PAYMENT_STATUS_COMPLETED`: Indicates that the standing order has been successfully established. This state is only used for standing orders. `PAYMENT_STATUS_INSUFFICIENT_FUNDS`: The payment has failed due to insufficient funds. `PAYMENT_STATUS_FAILED`: The payment has failed to be initiated. This error is retryable once the root cause is resolved. `PAYMENT_STATUS_BLOCKED`: The payment has been blocked. This is a retryable error. `PAYMENT_STATUS_UNKNOWN`: The payment status is unknown. | |
11
11
  | **recipient_id** | **String** | The ID of the recipient | |
12
12
  | **reference** | **String** | A reference for the payment. | |
13
+ | **adjusted_reference** | **String** | The value of the reference sent to the bank after adjustment to pass bank validation rules. | [optional] |
13
14
  | **last_status_update** | **String** | The date and time of the last time the `status` was updated, in IS0 8601 format | |
14
- | **schedule** | [**ExternalPaymentSchedule**](ExternalPaymentSchedule.md) | | [optional] |
15
- | **adjusted_reference** | **String** | | [optional] |
15
+ | **schedule** | [**ExternalPaymentScheduleGet**](ExternalPaymentScheduleGet.md) | | [optional] |
16
16
 
17
17
  ## Example
18
18
 
@@ -26,9 +26,9 @@ instance = Plaid::PaymentInitiationPaymentGetResponse.new(
26
26
  status: null,
27
27
  recipient_id: null,
28
28
  reference: null,
29
+ adjusted_reference: null,
29
30
  last_status_update: null,
30
- schedule: null,
31
- adjusted_reference: null
31
+ schedule: null
32
32
  )
33
33
  ```
34
34
 
@@ -8,7 +8,7 @@
8
8
  | **name** | **String** | The name of the recipient | |
9
9
  | **address** | [**PaymentInitiationAddress**](PaymentInitiationAddress.md) | | |
10
10
  | **iban** | **String** | The International Bank Account Number (IBAN) for the recipient. | [optional] |
11
- | **bacs** | [**PaymentInitiationRecipientBacs**](PaymentInitiationRecipientBacs.md) | | [optional] |
11
+ | **bacs** | **Hash<String, Object>** | | [optional] |
12
12
 
13
13
  ## Example
14
14
 
@@ -9,6 +9,10 @@
9
9
  | **payment_id** | **String** | The `payment_id` for the payment being updated | |
10
10
  | **new_payment_status** | **String** | The new status of the payment. `PAYMENT_STATUS_INPUT_NEEDED`: This is the initial state of all payments. It indicates that the payment is waiting on user input to continue processing. A payment may re-enter this state later on if further input is needed. `PAYMENT_STATUS_PROCESSING`: The payment is currently being processed. The payment will automatically exit this state when processing is complete. `PAYMENT_STATUS_INITIATED`: The payment has been successfully initiated and is considered complete. `PAYMENT_STATUS_COMPLETED`: Indicates that the standing order has been successfully established. This state is only used for standing orders. `PAYMENT_STATUS_INSUFFICIENT_FUNDS`: The payment has failed due to insufficient funds. `PAYMENT_STATUS_FAILED`: The payment has failed to be initiated. This error is retryable once the root cause is resolved. `PAYMENT_STATUS_BLOCKED`: The payment has been blocked. This is a retryable error. `PAYMENT_STATUS_UNKNOWN`: The payment status is unknown. | |
11
11
  | **old_payment_status** | **String** | The previous status of the payment. `PAYMENT_STATUS_INPUT_NEEDED`: This is the initial state of all payments. It indicates that the payment is waiting on user input to continue processing. A payment may re-enter this state later on if further input is needed. `PAYMENT_STATUS_PROCESSING`: The payment is currently being processed. The payment will automatically exit this state when processing is complete. `PAYMENT_STATUS_INITIATED`: The payment has been successfully initiated and is considered complete. `PAYMENT_STATUS_COMPLETED`: Indicates that the standing order has been successfully established. This state is only used for standing orders. `PAYMENT_STATUS_INSUFFICIENT_FUNDS`: The payment has failed due to insufficient funds. `PAYMENT_STATUS_FAILED`: The payment has failed to be initiated. This error is retryable once the root cause is resolved. `PAYMENT_STATUS_BLOCKED`: The payment has been blocked. This is a retryable error. `PAYMENT_STATUS_UNKNOWN`: The payment status is unknown. | |
12
+ | **original_reference** | **String** | The original value of the reference when creating the payment. | [optional] |
13
+ | **adjusted_reference** | **String** | The value of the reference sent to the bank after adjustment to pass bank validation rules. | [optional] |
14
+ | **original_start_date** | **Date** | The original value of the `start_date` provided during the creation of a standing order. If the payment is not a standing order, this field will be `null`. | [optional] |
15
+ | **adjusted_start_date** | **Date** | The start date sent to the bank after adjusting for holidays or weekends. Will be provided in ISO 8601 format (YYYY-MM-DD). If the start date did not require adjustment, or if the payment is not a standing order, this field will be `null`. | [optional] |
12
16
  | **timestamp** | **String** | The timestamp of the update, in ISO 8601 format, e.g. `\"2017-09-14T14:42:19.350Z\"` | |
13
17
  | **error** | [**Error**](Error.md) | | [optional] |
14
18
 
@@ -23,6 +27,10 @@ instance = Plaid::PaymentStatusUpdateWebhook.new(
23
27
  payment_id: null,
24
28
  new_payment_status: null,
25
29
  old_payment_status: null,
30
+ original_reference: null,
31
+ adjusted_reference: null,
32
+ original_start_date: null,
33
+ adjusted_start_date: null,
26
34
  timestamp: null,
27
35
  error: null
28
36
  )
data/docs/PlaidApi.md CHANGED
@@ -3799,7 +3799,7 @@ end
3799
3799
 
3800
3800
  Create a payment
3801
3801
 
3802
- After creating a payment recipient, you can use the `/payment_initiation/payment/create` endpoint to create a payment to that recipient. Payments can be one-time or standing order (recurring) and can be denominated in either EUR or GBP. If making domestic GBP-denominated payments, your recipient must have been created with BACS numbers. In general, EUR-denominated payments will be sent via SEPA Credit Transfer and GBP-denominated payments will be sent via the Faster Payments network, but the payment network used will be determined by the institution. Payments sent via Faster Payments will typically arrive immediately, while payments sent via SEPA Credit Transfer will typically arrive in one business day. Standing orders (recurring payments) must be denominated in GBP and can only be sent to recipients in the UK. Once created, standing order payments will continue indefinitely and cannot be modified or canceled via the API. An end user can cancel or modify a standing order directly on their banking application or website, or by contacting the bank. Standing orders will follow the payment rules of the underlying rails (Faster Payments in UK). Payments can be sent Monday to Friday, excluding bank holidays. If the pre-arranged date falls on a weekend or bank holiday, the payment is made on the next working day. It is not possible to guarantee the exact time the payment will reach the recipient’s account, although at least 90% of standing order payments are sent by 6am.
3802
+ After creating a payment recipient, you can use the `/payment_initiation/payment/create` endpoint to create a payment to that recipient. Payments can be one-time or standing order (recurring) and can be denominated in either EUR or GBP. If making domestic GBP-denominated payments, your recipient must have been created with BACS numbers. In general, EUR-denominated payments will be sent via SEPA Credit Transfer and GBP-denominated payments will be sent via the Faster Payments network, but the payment network used will be determined by the institution. Payments sent via Faster Payments will typically arrive immediately, while payments sent via SEPA Credit Transfer will typically arrive in one business day. Standing orders (recurring payments) must be denominated in GBP and can only be sent to recipients in the UK. Once created, standing order payments will continue indefinitely and cannot be modified or canceled via the API. An end user can cancel or modify a standing order directly on their banking application or website, or by contacting the bank. Standing orders will follow the payment rules of the underlying rails (Faster Payments in UK). Payments can be sent Monday to Friday, excluding bank holidays. If the pre-arranged date falls on a weekend or bank holiday, the payment is made on the next working day. It is not possible to guarantee the exact time the payment will reach the recipient’s account, although at least 90% of standing order payments are sent by 6am. In the Development environment, payments must be below 5 GBP / EUR. For details on any payment limits in Production, contact your Plaid Account Manager.
3803
3803
 
3804
3804
  ### Examples
3805
3805
 
@@ -5449,7 +5449,7 @@ Plaid.configure do |config|
5449
5449
  end
5450
5450
 
5451
5451
  api_instance = Plaid::PlaidApi.new
5452
- transactions_refresh_request = Plaid::TransactionsRefreshRequest.new # TransactionsRefreshRequest |
5452
+ transactions_refresh_request = Plaid::TransactionsRefreshRequest.new({access_token: 'access_token_example'}) # TransactionsRefreshRequest |
5453
5453
 
5454
5454
  begin
5455
5455
  # Refresh transaction data
data/docs/Transaction.md CHANGED
@@ -15,7 +15,9 @@
15
15
  | **merchant_name** | **String** | The merchant name, as extracted by Plaid from the `name` field. | [optional] |
16
16
  | **location** | [**Location**](Location.md) | | [optional] |
17
17
  | **authorized_date** | **String** | The date that the transaction was authorized. Dates are returned in an ISO 8601 format ( `YYYY-MM-DD` ). | [optional] |
18
+ | **authorized_datetime** | **String** | Date and time when a transaction was authorized in ISO 8601 format ( `YYYY-MM-DDTHH:mm:ssZ` ). This field is only populated for UK institutions. For institutions in other countries, will be `null`. | [optional] |
18
19
  | **date** | **String** | For pending transactions, the date that the transaction occurred; for posted transactions, the date that the transaction posted. Both dates are returned in an ISO 8601 format ( `YYYY-MM-DD` ). | |
20
+ | **datetime** | **String** | Date and time when a transaction was posted in ISO 8601 format ( `YYYY-MM-DDTHH:mm:ssZ` ). This field is only populated for UK institutions. For institutions in other countries, will be `null`. | [optional] |
19
21
  | **category_id** | **String** | The ID of the category to which this transaction belongs. See [Categories](https://plaid.com/docs/#category-overview). If the `transaction` object was returned by an Assets endpoint such as `/asset_report/get/` or `/asset_report/pdf/get`, this field will only appear in an Asset Report with Insights. | [optional] |
20
22
  | **category** | **Array<String>** | A hierarchical array of the categories to which this transaction belongs. See [Categories](https://plaid.com/docs/#category-overview). If the `transaction` object was returned by an Assets endpoint such as `/asset_report/get/` or `/asset_report/pdf/get`, this field will only appear in an Asset Report with Insights. | [optional] |
21
23
  | **unofficial_currency_code** | **String** | The unofficial currency code associated with the transaction. Always `null` if `iso_currency_code` is non-`null`. Unofficial currency codes are used for currencies that do not have official ISO currency codes, such as cryptocurrencies and the currencies of certain countries. See the [currency code schema](/docs/api/accounts#currency-code-schema) for a full listing of supported `iso_currency_code`s. | [optional] |
@@ -41,7 +43,9 @@ instance = Plaid::Transaction.new(
41
43
  merchant_name: null,
42
44
  location: null,
43
45
  authorized_date: null,
46
+ authorized_datetime: null,
44
47
  date: null,
48
+ datetime: null,
45
49
  category_id: null,
46
50
  category: null,
47
51
  unofficial_currency_code: null,
@@ -5,7 +5,7 @@
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **client_id** | **String** | Your Plaid API `client_id`. | [optional] |
8
- | **access_token** | **String** | The access token associated with the Item data is being requested for. | [optional] |
8
+ | **access_token** | **String** | The access token associated with the Item data is being requested for. | |
9
9
  | **secret** | **String** | Your Plaid API `secret`. | [optional] |
10
10
 
11
11
  ## Example
data/lib/plaid.rb CHANGED
@@ -3,7 +3,7 @@
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.5.3
6
+ The version of the OpenAPI document: 2020-09-14_1.8.0
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 5.0.0
@@ -121,6 +121,7 @@ require 'plaid/models/employers_search_request'
121
121
  require 'plaid/models/employers_search_response'
122
122
  require 'plaid/models/error'
123
123
  require 'plaid/models/external_payment_schedule'
124
+ require 'plaid/models/external_payment_schedule_get'
124
125
  require 'plaid/models/health_incident'
125
126
  require 'plaid/models/historical_balance'
126
127
  require 'plaid/models/historical_update_webhook'
@@ -185,9 +186,6 @@ require 'plaid/models/item_public_token_exchange_response'
185
186
  require 'plaid/models/item_remove_request'
186
187
  require 'plaid/models/item_remove_response'
187
188
  require 'plaid/models/item_status'
188
- require 'plaid/models/item_status_investments'
189
- require 'plaid/models/item_status_last_webhook'
190
- require 'plaid/models/item_status_transactions'
191
189
  require 'plaid/models/item_webhook_update_request'
192
190
  require 'plaid/models/item_webhook_update_response'
193
191
  require 'plaid/models/jwk_public_key'
@@ -200,10 +198,6 @@ require 'plaid/models/liability_override'
200
198
  require 'plaid/models/link_token_account_filters'
201
199
  require 'plaid/models/link_token_create_request'
202
200
  require 'plaid/models/link_token_create_request_account_subtypes'
203
- require 'plaid/models/link_token_create_request_account_subtypes_credit'
204
- require 'plaid/models/link_token_create_request_account_subtypes_depository'
205
- require 'plaid/models/link_token_create_request_account_subtypes_investment'
206
- require 'plaid/models/link_token_create_request_account_subtypes_loan'
207
201
  require 'plaid/models/link_token_create_request_deposit_switch'
208
202
  require 'plaid/models/link_token_create_request_income_verification'
209
203
  require 'plaid/models/link_token_create_request_payment_initiation'
@@ -250,7 +244,6 @@ require 'plaid/models/payment_initiation_payment_list_response'
250
244
  require 'plaid/models/payment_initiation_payment_token_create_request'
251
245
  require 'plaid/models/payment_initiation_payment_token_create_response'
252
246
  require 'plaid/models/payment_initiation_recipient'
253
- require 'plaid/models/payment_initiation_recipient_bacs'
254
247
  require 'plaid/models/payment_initiation_recipient_create_request'
255
248
  require 'plaid/models/payment_initiation_recipient_create_response'
256
249
  require 'plaid/models/payment_initiation_recipient_get_request'
@@ -3,7 +3,7 @@
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.5.3
6
+ The version of the OpenAPI document: 2020-09-14_1.8.0
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 5.0.0
@@ -2990,7 +2990,7 @@ module Plaid
2990
2990
  end
2991
2991
 
2992
2992
  # Create a payment
2993
- # After creating a payment recipient, you can use the `/payment_initiation/payment/create` endpoint to create a payment to that recipient. Payments can be one-time or standing order (recurring) and can be denominated in either EUR or GBP. If making domestic GBP-denominated payments, your recipient must have been created with BACS numbers. In general, EUR-denominated payments will be sent via SEPA Credit Transfer and GBP-denominated payments will be sent via the Faster Payments network, but the payment network used will be determined by the institution. Payments sent via Faster Payments will typically arrive immediately, while payments sent via SEPA Credit Transfer will typically arrive in one business day. Standing orders (recurring payments) must be denominated in GBP and can only be sent to recipients in the UK. Once created, standing order payments will continue indefinitely and cannot be modified or canceled via the API. An end user can cancel or modify a standing order directly on their banking application or website, or by contacting the bank. Standing orders will follow the payment rules of the underlying rails (Faster Payments in UK). Payments can be sent Monday to Friday, excluding bank holidays. If the pre-arranged date falls on a weekend or bank holiday, the payment is made on the next working day. It is not possible to guarantee the exact time the payment will reach the recipient’s account, although at least 90% of standing order payments are sent by 6am.
2993
+ # After creating a payment recipient, you can use the `/payment_initiation/payment/create` endpoint to create a payment to that recipient. Payments can be one-time or standing order (recurring) and can be denominated in either EUR or GBP. If making domestic GBP-denominated payments, your recipient must have been created with BACS numbers. In general, EUR-denominated payments will be sent via SEPA Credit Transfer and GBP-denominated payments will be sent via the Faster Payments network, but the payment network used will be determined by the institution. Payments sent via Faster Payments will typically arrive immediately, while payments sent via SEPA Credit Transfer will typically arrive in one business day. Standing orders (recurring payments) must be denominated in GBP and can only be sent to recipients in the UK. Once created, standing order payments will continue indefinitely and cannot be modified or canceled via the API. An end user can cancel or modify a standing order directly on their banking application or website, or by contacting the bank. Standing orders will follow the payment rules of the underlying rails (Faster Payments in UK). Payments can be sent Monday to Friday, excluding bank holidays. If the pre-arranged date falls on a weekend or bank holiday, the payment is made on the next working day. It is not possible to guarantee the exact time the payment will reach the recipient’s account, although at least 90% of standing order payments are sent by 6am. In the Development environment, payments must be below 5 GBP / EUR. For details on any payment limits in Production, contact your Plaid Account Manager.
2994
2994
  # @param payment_initiation_payment_create_request [PaymentInitiationPaymentCreateRequest]
2995
2995
  # @param [Hash] opts the optional parameters
2996
2996
  # @return [PaymentInitiationPaymentCreateResponse]
@@ -3000,7 +3000,7 @@ module Plaid
3000
3000
  end
3001
3001
 
3002
3002
  # Create a payment
3003
- # After creating a payment recipient, you can use the `/payment_initiation/payment/create` endpoint to create a payment to that recipient. Payments can be one-time or standing order (recurring) and can be denominated in either EUR or GBP. If making domestic GBP-denominated payments, your recipient must have been created with BACS numbers. In general, EUR-denominated payments will be sent via SEPA Credit Transfer and GBP-denominated payments will be sent via the Faster Payments network, but the payment network used will be determined by the institution. Payments sent via Faster Payments will typically arrive immediately, while payments sent via SEPA Credit Transfer will typically arrive in one business day. Standing orders (recurring payments) must be denominated in GBP and can only be sent to recipients in the UK. Once created, standing order payments will continue indefinitely and cannot be modified or canceled via the API. An end user can cancel or modify a standing order directly on their banking application or website, or by contacting the bank. Standing orders will follow the payment rules of the underlying rails (Faster Payments in UK). Payments can be sent Monday to Friday, excluding bank holidays. If the pre-arranged date falls on a weekend or bank holiday, the payment is made on the next working day. It is not possible to guarantee the exact time the payment will reach the recipient’s account, although at least 90% of standing order payments are sent by 6am.
3003
+ # After creating a payment recipient, you can use the `/payment_initiation/payment/create` endpoint to create a payment to that recipient. Payments can be one-time or standing order (recurring) and can be denominated in either EUR or GBP. If making domestic GBP-denominated payments, your recipient must have been created with BACS numbers. In general, EUR-denominated payments will be sent via SEPA Credit Transfer and GBP-denominated payments will be sent via the Faster Payments network, but the payment network used will be determined by the institution. Payments sent via Faster Payments will typically arrive immediately, while payments sent via SEPA Credit Transfer will typically arrive in one business day. Standing orders (recurring payments) must be denominated in GBP and can only be sent to recipients in the UK. Once created, standing order payments will continue indefinitely and cannot be modified or canceled via the API. An end user can cancel or modify a standing order directly on their banking application or website, or by contacting the bank. Standing orders will follow the payment rules of the underlying rails (Faster Payments in UK). Payments can be sent Monday to Friday, excluding bank holidays. If the pre-arranged date falls on a weekend or bank holiday, the payment is made on the next working day. It is not possible to guarantee the exact time the payment will reach the recipient’s account, although at least 90% of standing order payments are sent by 6am. In the Development environment, payments must be below 5 GBP / EUR. For details on any payment limits in Production, contact your Plaid Account Manager.
3004
3004
  # @param payment_initiation_payment_create_request [PaymentInitiationPaymentCreateRequest]
3005
3005
  # @param [Hash] opts the optional parameters
3006
3006
  # @return [Array<(PaymentInitiationPaymentCreateResponse, Integer, Hash)>] PaymentInitiationPaymentCreateResponse data, response status code and response headers
@@ -3,7 +3,7 @@
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.5.3
6
+ The version of the OpenAPI document: 2020-09-14_1.8.0
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 5.0.0
@@ -3,7 +3,7 @@
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.5.3
6
+ The version of the OpenAPI document: 2020-09-14_1.8.0
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 5.0.0
@@ -3,7 +3,7 @@
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.5.3
6
+ The version of the OpenAPI document: 2020-09-14_1.8.0
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 5.0.0
@@ -3,7 +3,7 @@
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.5.3
6
+ The version of the OpenAPI document: 2020-09-14_1.8.0
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 5.0.0
@@ -3,7 +3,7 @@
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.5.3
6
+ The version of the OpenAPI document: 2020-09-14_1.8.0
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 5.0.0