apimatic-plaid-sdk 0.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (542) hide show
  1. checksums.yaml +7 -0
  2. data/LICENSE +28 -0
  3. data/README.md +192 -0
  4. data/bin/console +15 -0
  5. data/lib/plaid/api_helper.rb +10 -0
  6. data/lib/plaid/apis/accounts_api.rb +70 -0
  7. data/lib/plaid/apis/application_api.rb +35 -0
  8. data/lib/plaid/apis/asset_report_api.rb +301 -0
  9. data/lib/plaid/apis/auth_api.rb +43 -0
  10. data/lib/plaid/apis/bank_transfer_api.rb +287 -0
  11. data/lib/plaid/apis/base_api.rb +65 -0
  12. data/lib/plaid/apis/categories_api.rb +34 -0
  13. data/lib/plaid/apis/deposit_switch_api.rb +106 -0
  14. data/lib/plaid/apis/employers_api.rb +40 -0
  15. data/lib/plaid/apis/identity_api.rb +38 -0
  16. data/lib/plaid/apis/income_api.rb +220 -0
  17. data/lib/plaid/apis/institutions_api.rb +92 -0
  18. data/lib/plaid/apis/investments_api.rb +61 -0
  19. data/lib/plaid/apis/item_api.rb +267 -0
  20. data/lib/plaid/apis/liabilities_api.rb +47 -0
  21. data/lib/plaid/apis/link_api.rb +62 -0
  22. data/lib/plaid/apis/payment_initiation_api.rb +236 -0
  23. data/lib/plaid/apis/processor_api.rb +189 -0
  24. data/lib/plaid/apis/sandbox_api.rb +302 -0
  25. data/lib/plaid/apis/signal_api.rb +97 -0
  26. data/lib/plaid/apis/transactions_api.rb +111 -0
  27. data/lib/plaid/apis/transfer_api.rb +214 -0
  28. data/lib/plaid/apis/webhook_verification_key_api.rb +36 -0
  29. data/lib/plaid/client.rb +208 -0
  30. data/lib/plaid/configuration.rb +198 -0
  31. data/lib/plaid/exceptions/api_exception.rb +21 -0
  32. data/lib/plaid/exceptions/error_error_exception.rb +110 -0
  33. data/lib/plaid/http/api_response.rb +19 -0
  34. data/lib/plaid/http/auth/plaid_client_id.rb +52 -0
  35. data/lib/plaid/http/auth/plaid_secret.rb +52 -0
  36. data/lib/plaid/http/auth/plaid_version.rb +52 -0
  37. data/lib/plaid/http/http_call_back.rb +10 -0
  38. data/lib/plaid/http/http_method_enum.rb +10 -0
  39. data/lib/plaid/http/http_request.rb +10 -0
  40. data/lib/plaid/http/http_response.rb +10 -0
  41. data/lib/plaid/http/proxy_settings.rb +22 -0
  42. data/lib/plaid/logging/configuration/api_logging_configuration.rb +186 -0
  43. data/lib/plaid/logging/sdk_logger.rb +17 -0
  44. data/lib/plaid/models/account.rb +185 -0
  45. data/lib/plaid/models/account_access.rb +89 -0
  46. data/lib/plaid/models/account_assets.rb +258 -0
  47. data/lib/plaid/models/account_balance.rb +189 -0
  48. data/lib/plaid/models/account_filter.rb +107 -0
  49. data/lib/plaid/models/account_filters_response.rb +106 -0
  50. data/lib/plaid/models/account_identity.rb +206 -0
  51. data/lib/plaid/models/account_selection_cardinality.rb +44 -0
  52. data/lib/plaid/models/account_subtype.rb +319 -0
  53. data/lib/plaid/models/account_subtype1.rb +36 -0
  54. data/lib/plaid/models/account_type.rb +57 -0
  55. data/lib/plaid/models/accounts_balance_get_request.rb +108 -0
  56. data/lib/plaid/models/accounts_balance_get_request_options.rb +111 -0
  57. data/lib/plaid/models/accounts_get_request.rb +107 -0
  58. data/lib/plaid/models/accounts_get_request_options.rb +76 -0
  59. data/lib/plaid/models/accounts_get_response.rb +104 -0
  60. data/lib/plaid/models/ach_class.rb +99 -0
  61. data/lib/plaid/models/address.rb +84 -0
  62. data/lib/plaid/models/address1.rb +116 -0
  63. data/lib/plaid/models/address2.rb +155 -0
  64. data/lib/plaid/models/address_data.rb +114 -0
  65. data/lib/plaid/models/address_data1.rb +120 -0
  66. data/lib/plaid/models/address_data_nullable.rb +114 -0
  67. data/lib/plaid/models/address_nullable.rb +84 -0
  68. data/lib/plaid/models/application.rb +131 -0
  69. data/lib/plaid/models/application_get_request.rb +98 -0
  70. data/lib/plaid/models/application_get_response.rb +84 -0
  71. data/lib/plaid/models/apr.rb +109 -0
  72. data/lib/plaid/models/apr_type.rb +44 -0
  73. data/lib/plaid/models/asset_report.rb +145 -0
  74. data/lib/plaid/models/asset_report_audit_copy_create_request.rb +111 -0
  75. data/lib/plaid/models/asset_report_audit_copy_create_response.rb +87 -0
  76. data/lib/plaid/models/asset_report_audit_copy_get_request.rb +101 -0
  77. data/lib/plaid/models/asset_report_audit_copy_remove_request.rb +101 -0
  78. data/lib/plaid/models/asset_report_audit_copy_remove_response.rb +85 -0
  79. data/lib/plaid/models/asset_report_create_request.rb +125 -0
  80. data/lib/plaid/models/asset_report_create_request_options.rb +104 -0
  81. data/lib/plaid/models/asset_report_create_response.rb +100 -0
  82. data/lib/plaid/models/asset_report_filter_request.rb +111 -0
  83. data/lib/plaid/models/asset_report_filter_response.rb +100 -0
  84. data/lib/plaid/models/asset_report_get_request.rb +112 -0
  85. data/lib/plaid/models/asset_report_get_response.rb +103 -0
  86. data/lib/plaid/models/asset_report_item.rb +130 -0
  87. data/lib/plaid/models/asset_report_pdf_get_request.rb +101 -0
  88. data/lib/plaid/models/asset_report_refresh_request.rb +127 -0
  89. data/lib/plaid/models/asset_report_refresh_request_options.rb +104 -0
  90. data/lib/plaid/models/asset_report_refresh_response.rb +100 -0
  91. data/lib/plaid/models/asset_report_remove_request.rb +101 -0
  92. data/lib/plaid/models/asset_report_remove_response.rb +85 -0
  93. data/lib/plaid/models/asset_report_transaction.rb +296 -0
  94. data/lib/plaid/models/asset_report_user.rb +153 -0
  95. data/lib/plaid/models/assets_error_webhook.rb +107 -0
  96. data/lib/plaid/models/assets_product_ready_webhook.rb +97 -0
  97. data/lib/plaid/models/auth_get_numbers.rb +141 -0
  98. data/lib/plaid/models/auth_get_request.rb +107 -0
  99. data/lib/plaid/models/auth_get_request_options.rb +78 -0
  100. data/lib/plaid/models/auth_get_response.rb +116 -0
  101. data/lib/plaid/models/auth_metadata.rb +77 -0
  102. data/lib/plaid/models/auth_supported_methods.rb +94 -0
  103. data/lib/plaid/models/automatically_verified_webhook.rb +102 -0
  104. data/lib/plaid/models/available_balance.rb +39 -0
  105. data/lib/plaid/models/bank_initiated_return_risk.rb +96 -0
  106. data/lib/plaid/models/bank_transfer.rb +263 -0
  107. data/lib/plaid/models/bank_transfer_balance.rb +85 -0
  108. data/lib/plaid/models/bank_transfer_balance_get_request.rb +103 -0
  109. data/lib/plaid/models/bank_transfer_balance_get_response.rb +97 -0
  110. data/lib/plaid/models/bank_transfer_cancel_request.rb +99 -0
  111. data/lib/plaid/models/bank_transfer_cancel_response.rb +76 -0
  112. data/lib/plaid/models/bank_transfer_create_request.rb +254 -0
  113. data/lib/plaid/models/bank_transfer_create_response.rb +84 -0
  114. data/lib/plaid/models/bank_transfer_direction.rb +37 -0
  115. data/lib/plaid/models/bank_transfer_direction1.rb +37 -0
  116. data/lib/plaid/models/bank_transfer_event.rb +211 -0
  117. data/lib/plaid/models/bank_transfer_event_list_request.rb +229 -0
  118. data/lib/plaid/models/bank_transfer_event_list_response.rb +94 -0
  119. data/lib/plaid/models/bank_transfer_event_sync_request.rb +110 -0
  120. data/lib/plaid/models/bank_transfer_event_sync_response.rb +94 -0
  121. data/lib/plaid/models/bank_transfer_event_type.rb +63 -0
  122. data/lib/plaid/models/bank_transfer_failure.rb +93 -0
  123. data/lib/plaid/models/bank_transfer_get_request.rb +99 -0
  124. data/lib/plaid/models/bank_transfer_get_response.rb +84 -0
  125. data/lib/plaid/models/bank_transfer_list_request.rb +175 -0
  126. data/lib/plaid/models/bank_transfer_list_response.rb +93 -0
  127. data/lib/plaid/models/bank_transfer_migrate_account_request.rb +117 -0
  128. data/lib/plaid/models/bank_transfer_migrate_account_response.rb +93 -0
  129. data/lib/plaid/models/bank_transfer_network.rb +41 -0
  130. data/lib/plaid/models/bank_transfer_receiver_details.rb +79 -0
  131. data/lib/plaid/models/bank_transfer_status.rb +48 -0
  132. data/lib/plaid/models/bank_transfer_sweep.rb +129 -0
  133. data/lib/plaid/models/bank_transfer_sweep_account.rb +84 -0
  134. data/lib/plaid/models/bank_transfer_sweep_get_request.rb +113 -0
  135. data/lib/plaid/models/bank_transfer_sweep_get_response.rb +85 -0
  136. data/lib/plaid/models/bank_transfer_sweep_list_request.rb +164 -0
  137. data/lib/plaid/models/bank_transfer_sweep_list_response.rb +94 -0
  138. data/lib/plaid/models/bank_transfer_type.rb +38 -0
  139. data/lib/plaid/models/bank_transfer_type1.rb +38 -0
  140. data/lib/plaid/models/bank_transfer_user.rb +100 -0
  141. data/lib/plaid/models/bank_transfers_events_update_webhook.rb +83 -0
  142. data/lib/plaid/models/base_model.rb +110 -0
  143. data/lib/plaid/models/branch.rb +49 -0
  144. data/lib/plaid/models/buy_type.rb +165 -0
  145. data/lib/plaid/models/canonical_description.rb +92 -0
  146. data/lib/plaid/models/cash_type.rb +305 -0
  147. data/lib/plaid/models/categories_get_response.rb +93 -0
  148. data/lib/plaid/models/category.rb +93 -0
  149. data/lib/plaid/models/cause.rb +88 -0
  150. data/lib/plaid/models/code.rb +56 -0
  151. data/lib/plaid/models/confidence.rb +45 -0
  152. data/lib/plaid/models/connected_application.rb +177 -0
  153. data/lib/plaid/models/country_code.rb +56 -0
  154. data/lib/plaid/models/country_code1.rb +36 -0
  155. data/lib/plaid/models/credit.rb +80 -0
  156. data/lib/plaid/models/credit_account.rb +83 -0
  157. data/lib/plaid/models/credit_card_liability.rb +164 -0
  158. data/lib/plaid/models/credit_filter.rb +78 -0
  159. data/lib/plaid/models/currency.rb +37 -0
  160. data/lib/plaid/models/customer_initiated_return_risk.rb +100 -0
  161. data/lib/plaid/models/decision.rb +48 -0
  162. data/lib/plaid/models/deductions.rb +103 -0
  163. data/lib/plaid/models/default_update_webhook.rb +119 -0
  164. data/lib/plaid/models/deposit_switch_address_data.rb +110 -0
  165. data/lib/plaid/models/deposit_switch_alt_create_request.rb +132 -0
  166. data/lib/plaid/models/deposit_switch_alt_create_response.rb +87 -0
  167. data/lib/plaid/models/deposit_switch_create_request.rb +133 -0
  168. data/lib/plaid/models/deposit_switch_create_request_options.rb +99 -0
  169. data/lib/plaid/models/deposit_switch_create_response.rb +87 -0
  170. data/lib/plaid/models/deposit_switch_get_request.rb +99 -0
  171. data/lib/plaid/models/deposit_switch_get_response.rb +277 -0
  172. data/lib/plaid/models/deposit_switch_state_update_webhook.rb +116 -0
  173. data/lib/plaid/models/deposit_switch_target_account.rb +106 -0
  174. data/lib/plaid/models/deposit_switch_target_user.rb +121 -0
  175. data/lib/plaid/models/deposit_switch_token_create_request.rb +100 -0
  176. data/lib/plaid/models/deposit_switch_token_create_response.rb +101 -0
  177. data/lib/plaid/models/depository.rb +80 -0
  178. data/lib/plaid/models/depository_account.rb +147 -0
  179. data/lib/plaid/models/depository_filter.rb +78 -0
  180. data/lib/plaid/models/distribution_details.rb +126 -0
  181. data/lib/plaid/models/document_metadata.rb +96 -0
  182. data/lib/plaid/models/earnings.rb +104 -0
  183. data/lib/plaid/models/earnings_total.rb +133 -0
  184. data/lib/plaid/models/email.rb +91 -0
  185. data/lib/plaid/models/employee.rb +107 -0
  186. data/lib/plaid/models/employee2.rb +85 -0
  187. data/lib/plaid/models/employee_income_summary_field_string.rb +90 -0
  188. data/lib/plaid/models/employer.rb +102 -0
  189. data/lib/plaid/models/employer2.rb +86 -0
  190. data/lib/plaid/models/employer3.rb +74 -0
  191. data/lib/plaid/models/employer_income_summary_field_string.rb +90 -0
  192. data/lib/plaid/models/employers_search_request.rb +107 -0
  193. data/lib/plaid/models/employers_search_response.rb +93 -0
  194. data/lib/plaid/models/employment_details.rb +88 -0
  195. data/lib/plaid/models/error.rb +172 -0
  196. data/lib/plaid/models/error_type.rb +76 -0
  197. data/lib/plaid/models/external_payment_refund_details.rb +92 -0
  198. data/lib/plaid/models/external_payment_schedule_base.rb +147 -0
  199. data/lib/plaid/models/external_payment_schedule_get.rb +140 -0
  200. data/lib/plaid/models/external_payment_schedule_request.rb +144 -0
  201. data/lib/plaid/models/fee_type.rb +287 -0
  202. data/lib/plaid/models/health_incident.rb +130 -0
  203. data/lib/plaid/models/historical_balance.rb +118 -0
  204. data/lib/plaid/models/historical_update_webhook.rb +124 -0
  205. data/lib/plaid/models/holding.rb +169 -0
  206. data/lib/plaid/models/holdings_default_update_webhook.rb +129 -0
  207. data/lib/plaid/models/holdings_override.rb +133 -0
  208. data/lib/plaid/models/identity_get_request.rb +107 -0
  209. data/lib/plaid/models/identity_get_request_options.rb +78 -0
  210. data/lib/plaid/models/identity_get_response.rb +101 -0
  211. data/lib/plaid/models/incident_update.rb +106 -0
  212. data/lib/plaid/models/income_breakdown.rb +106 -0
  213. data/lib/plaid/models/income_override.rb +84 -0
  214. data/lib/plaid/models/income_summary.rb +137 -0
  215. data/lib/plaid/models/income_summary_field_number.rb +90 -0
  216. data/lib/plaid/models/income_summary_field_string.rb +90 -0
  217. data/lib/plaid/models/income_verification_create_request.rb +99 -0
  218. data/lib/plaid/models/income_verification_create_response.rb +88 -0
  219. data/lib/plaid/models/income_verification_documents_download_request.rb +114 -0
  220. data/lib/plaid/models/income_verification_documents_download_response.rb +73 -0
  221. data/lib/plaid/models/income_verification_paystub_get_request.rb +114 -0
  222. data/lib/plaid/models/income_verification_paystub_get_response.rb +100 -0
  223. data/lib/plaid/models/income_verification_paystubs_get_request.rb +114 -0
  224. data/lib/plaid/models/income_verification_paystubs_get_response.rb +133 -0
  225. data/lib/plaid/models/income_verification_precheck_employer.rb +88 -0
  226. data/lib/plaid/models/income_verification_precheck_military_info.rb +90 -0
  227. data/lib/plaid/models/income_verification_precheck_request.rb +141 -0
  228. data/lib/plaid/models/income_verification_precheck_response.rb +101 -0
  229. data/lib/plaid/models/income_verification_precheck_user.rb +110 -0
  230. data/lib/plaid/models/income_verification_refresh_request.rb +114 -0
  231. data/lib/plaid/models/income_verification_refresh_response.rb +90 -0
  232. data/lib/plaid/models/income_verification_status_webhook.rb +117 -0
  233. data/lib/plaid/models/income_verification_summary_get_request.rb +114 -0
  234. data/lib/plaid/models/income_verification_summary_get_response.rb +109 -0
  235. data/lib/plaid/models/income_verification_taxforms_get_request.rb +114 -0
  236. data/lib/plaid/models/income_verification_taxforms_get_response.rb +129 -0
  237. data/lib/plaid/models/income_verification_webhook_status.rb +72 -0
  238. data/lib/plaid/models/inflow_model.rb +136 -0
  239. data/lib/plaid/models/initial_update_webhook.rb +121 -0
  240. data/lib/plaid/models/institution.rb +213 -0
  241. data/lib/plaid/models/institution_status.rb +211 -0
  242. data/lib/plaid/models/institutions_get_by_id_request.rb +120 -0
  243. data/lib/plaid/models/institutions_get_by_id_request_options.rb +131 -0
  244. data/lib/plaid/models/institutions_get_by_id_response.rb +85 -0
  245. data/lib/plaid/models/institutions_get_request.rb +125 -0
  246. data/lib/plaid/models/institutions_get_request_options.rb +154 -0
  247. data/lib/plaid/models/institutions_get_response.rb +102 -0
  248. data/lib/plaid/models/institutions_search_account_filter.rb +105 -0
  249. data/lib/plaid/models/institutions_search_payment_initiation_options.rb +77 -0
  250. data/lib/plaid/models/institutions_search_request.rb +132 -0
  251. data/lib/plaid/models/institutions_search_request_options.rb +136 -0
  252. data/lib/plaid/models/institutions_search_response.rb +94 -0
  253. data/lib/plaid/models/investment.rb +80 -0
  254. data/lib/plaid/models/investment_account_subtype.rb +501 -0
  255. data/lib/plaid/models/investment_filter.rb +78 -0
  256. data/lib/plaid/models/investment_holdings_get_request_options.rb +78 -0
  257. data/lib/plaid/models/investment_transaction.rb +231 -0
  258. data/lib/plaid/models/investments_holdings_get_request.rb +109 -0
  259. data/lib/plaid/models/investments_holdings_get_response.rb +142 -0
  260. data/lib/plaid/models/investments_transactions_get_request.rb +130 -0
  261. data/lib/plaid/models/investments_transactions_get_request_options.rb +96 -0
  262. data/lib/plaid/models/investments_transactions_get_response.rb +156 -0
  263. data/lib/plaid/models/investments_transactions_override.rb +151 -0
  264. data/lib/plaid/models/item.rb +173 -0
  265. data/lib/plaid/models/item_access_token_invalidate_request.rb +98 -0
  266. data/lib/plaid/models/item_access_token_invalidate_response.rb +86 -0
  267. data/lib/plaid/models/item_application_list_request.rb +100 -0
  268. data/lib/plaid/models/item_application_list_response.rb +95 -0
  269. data/lib/plaid/models/item_application_list_user_auth.rb +93 -0
  270. data/lib/plaid/models/item_application_scopes_update_request.rb +143 -0
  271. data/lib/plaid/models/item_application_scopes_update_response.rb +77 -0
  272. data/lib/plaid/models/item_error_webhook.rb +105 -0
  273. data/lib/plaid/models/item_get_request.rb +97 -0
  274. data/lib/plaid/models/item_get_response.rb +95 -0
  275. data/lib/plaid/models/item_import_request.rb +117 -0
  276. data/lib/plaid/models/item_import_request_options.rb +76 -0
  277. data/lib/plaid/models/item_import_request_user_auth.rb +83 -0
  278. data/lib/plaid/models/item_import_response.rb +84 -0
  279. data/lib/plaid/models/item_product_ready_webhook.rb +106 -0
  280. data/lib/plaid/models/item_public_token_create_request.rb +98 -0
  281. data/lib/plaid/models/item_public_token_create_response.rb +107 -0
  282. data/lib/plaid/models/item_public_token_exchange_request.rb +99 -0
  283. data/lib/plaid/models/item_public_token_exchange_response.rb +95 -0
  284. data/lib/plaid/models/item_remove_request.rb +97 -0
  285. data/lib/plaid/models/item_remove_response.rb +76 -0
  286. data/lib/plaid/models/item_status.rb +99 -0
  287. data/lib/plaid/models/item_status_investments.rb +114 -0
  288. data/lib/plaid/models/item_status_last_webhook.rb +98 -0
  289. data/lib/plaid/models/item_status_nullable.rb +99 -0
  290. data/lib/plaid/models/item_status_transactions.rb +114 -0
  291. data/lib/plaid/models/item_webhook_update_request.rb +107 -0
  292. data/lib/plaid/models/item_webhook_update_response.rb +85 -0
  293. data/lib/plaid/models/jwk_public_key.rb +150 -0
  294. data/lib/plaid/models/jwt_header.rb +72 -0
  295. data/lib/plaid/models/liabilities_default_update_webhook.rb +135 -0
  296. data/lib/plaid/models/liabilities_get_request.rb +108 -0
  297. data/lib/plaid/models/liabilities_get_request_options.rb +79 -0
  298. data/lib/plaid/models/liabilities_get_response.rb +111 -0
  299. data/lib/plaid/models/liabilities_object.rb +121 -0
  300. data/lib/plaid/models/liability_override.rb +326 -0
  301. data/lib/plaid/models/link_token_account_filters.rb +120 -0
  302. data/lib/plaid/models/link_token_create_request.rb +378 -0
  303. data/lib/plaid/models/link_token_create_request_account_subtypes.rb +118 -0
  304. data/lib/plaid/models/link_token_create_request_auth.rb +77 -0
  305. data/lib/plaid/models/link_token_create_request_deposit_switch.rb +77 -0
  306. data/lib/plaid/models/link_token_create_request_income_verification.rb +94 -0
  307. data/lib/plaid/models/link_token_create_request_payment_initiation.rb +77 -0
  308. data/lib/plaid/models/link_token_create_request_update.rb +82 -0
  309. data/lib/plaid/models/link_token_create_request_user.rb +201 -0
  310. data/lib/plaid/models/link_token_create_response.rb +107 -0
  311. data/lib/plaid/models/link_token_eu_config.rb +75 -0
  312. data/lib/plaid/models/link_token_get_metadata_response.rb +140 -0
  313. data/lib/plaid/models/link_token_get_request.rb +97 -0
  314. data/lib/plaid/models/link_token_get_response.rb +132 -0
  315. data/lib/plaid/models/loan.rb +80 -0
  316. data/lib/plaid/models/loan_account.rb +173 -0
  317. data/lib/plaid/models/loan_filter.rb +78 -0
  318. data/lib/plaid/models/meta.rb +90 -0
  319. data/lib/plaid/models/mfa.rb +124 -0
  320. data/lib/plaid/models/mortgage_interest_rate.rb +86 -0
  321. data/lib/plaid/models/mortgage_liability.rb +295 -0
  322. data/lib/plaid/models/mortgage_property_address.rb +114 -0
  323. data/lib/plaid/models/net_pay.rb +96 -0
  324. data/lib/plaid/models/new_accounts_available_webhook.rb +115 -0
  325. data/lib/plaid/models/new_payment_status.rb +73 -0
  326. data/lib/plaid/models/numbers.rb +157 -0
  327. data/lib/plaid/models/numbers_ach.rb +113 -0
  328. data/lib/plaid/models/numbers_ach_nullable.rb +112 -0
  329. data/lib/plaid/models/numbers_bacs.rb +92 -0
  330. data/lib/plaid/models/numbers_bacs_nullable.rb +91 -0
  331. data/lib/plaid/models/numbers_eft.rb +101 -0
  332. data/lib/plaid/models/numbers_eft_nullable.rb +100 -0
  333. data/lib/plaid/models/numbers_international.rb +91 -0
  334. data/lib/plaid/models/numbers_international_nullable.rb +90 -0
  335. data/lib/plaid/models/old_payment_status.rb +73 -0
  336. data/lib/plaid/models/override_account_type.rb +56 -0
  337. data/lib/plaid/models/override_accounts.rb +230 -0
  338. data/lib/plaid/models/owner.rb +141 -0
  339. data/lib/plaid/models/owner_override.rb +131 -0
  340. data/lib/plaid/models/pay.rb +88 -0
  341. data/lib/plaid/models/pay_frequency.rb +90 -0
  342. data/lib/plaid/models/pay_frequency1.rb +45 -0
  343. data/lib/plaid/models/pay_period_details.rb +119 -0
  344. data/lib/plaid/models/payment_amount.rb +84 -0
  345. data/lib/plaid/models/payment_channel.rb +43 -0
  346. data/lib/plaid/models/payment_initiation_address.rb +103 -0
  347. data/lib/plaid/models/payment_initiation_metadata.rb +117 -0
  348. data/lib/plaid/models/payment_initiation_optional_restriction_bacs.rb +85 -0
  349. data/lib/plaid/models/payment_initiation_payment.rb +242 -0
  350. data/lib/plaid/models/payment_initiation_payment_create_request.rb +140 -0
  351. data/lib/plaid/models/payment_initiation_payment_create_response.rb +95 -0
  352. data/lib/plaid/models/payment_initiation_payment_get_request.rb +98 -0
  353. data/lib/plaid/models/payment_initiation_payment_get_response.rb +254 -0
  354. data/lib/plaid/models/payment_initiation_payment_list_request.rb +124 -0
  355. data/lib/plaid/models/payment_initiation_payment_list_response.rb +115 -0
  356. data/lib/plaid/models/payment_initiation_payment_reverse_request.rb +98 -0
  357. data/lib/plaid/models/payment_initiation_payment_reverse_response.rb +99 -0
  358. data/lib/plaid/models/payment_initiation_payment_token_create_request.rb +98 -0
  359. data/lib/plaid/models/payment_initiation_payment_token_create_response.rb +107 -0
  360. data/lib/plaid/models/payment_initiation_recipient.rb +131 -0
  361. data/lib/plaid/models/payment_initiation_recipient_create_request.rb +133 -0
  362. data/lib/plaid/models/payment_initiation_recipient_create_response.rb +85 -0
  363. data/lib/plaid/models/payment_initiation_recipient_get_request.rb +98 -0
  364. data/lib/plaid/models/payment_initiation_recipient_get_response.rb +144 -0
  365. data/lib/plaid/models/payment_initiation_recipient_list_request.rb +89 -0
  366. data/lib/plaid/models/payment_initiation_recipient_list_response.rb +94 -0
  367. data/lib/plaid/models/payment_initiation_refund.rb +116 -0
  368. data/lib/plaid/models/payment_initiation_standing_order_metadata.rb +108 -0
  369. data/lib/plaid/models/payment_meta.rb +156 -0
  370. data/lib/plaid/models/payment_options.rb +122 -0
  371. data/lib/plaid/models/payment_schedule_interval.rb +36 -0
  372. data/lib/plaid/models/payment_status_update_webhook.rb +234 -0
  373. data/lib/plaid/models/paystub.rb +186 -0
  374. data/lib/plaid/models/paystub_deduction.rb +95 -0
  375. data/lib/plaid/models/paystub_details.rb +127 -0
  376. data/lib/plaid/models/paystub_override.rb +116 -0
  377. data/lib/plaid/models/paystub_ytd_details.rb +90 -0
  378. data/lib/plaid/models/pending_expiration_webhook.rb +112 -0
  379. data/lib/plaid/models/personal_finance_category.rb +87 -0
  380. data/lib/plaid/models/personal_finance_category2.rb +83 -0
  381. data/lib/plaid/models/phone_number.rb +91 -0
  382. data/lib/plaid/models/processor.rb +116 -0
  383. data/lib/plaid/models/processor_apex_processor_token_create_request.rb +108 -0
  384. data/lib/plaid/models/processor_auth_get_request.rb +100 -0
  385. data/lib/plaid/models/processor_auth_get_response.rb +98 -0
  386. data/lib/plaid/models/processor_balance_get_request.rb +111 -0
  387. data/lib/plaid/models/processor_balance_get_request_options.rb +98 -0
  388. data/lib/plaid/models/processor_balance_get_response.rb +85 -0
  389. data/lib/plaid/models/processor_bank_transfer_create_request.rb +248 -0
  390. data/lib/plaid/models/processor_bank_transfer_create_response.rb +84 -0
  391. data/lib/plaid/models/processor_identity_get_request.rb +101 -0
  392. data/lib/plaid/models/processor_identity_get_response.rb +85 -0
  393. data/lib/plaid/models/processor_number.rb +111 -0
  394. data/lib/plaid/models/processor_stripe_bank_account_token_create_request.rb +108 -0
  395. data/lib/plaid/models/processor_stripe_bank_account_token_create_response.rb +87 -0
  396. data/lib/plaid/models/processor_token_create_request.rb +116 -0
  397. data/lib/plaid/models/processor_token_create_response.rb +87 -0
  398. data/lib/plaid/models/product_access.rb +112 -0
  399. data/lib/plaid/models/product_data_type.rb +40 -0
  400. data/lib/plaid/models/product_status.rb +106 -0
  401. data/lib/plaid/models/products.rb +86 -0
  402. data/lib/plaid/models/projected_income_summary_field_number.rb +90 -0
  403. data/lib/plaid/models/pslf_status.rb +103 -0
  404. data/lib/plaid/models/recaptcha_required_error.rb +143 -0
  405. data/lib/plaid/models/recipient_bacs.rb +87 -0
  406. data/lib/plaid/models/recipient_bacs_nullable.rb +85 -0
  407. data/lib/plaid/models/refresh_interval.rb +42 -0
  408. data/lib/plaid/models/requested_scopes.rb +124 -0
  409. data/lib/plaid/models/sandbox_bank_transfer_fire_webhook_request.rb +97 -0
  410. data/lib/plaid/models/sandbox_bank_transfer_fire_webhook_response.rb +76 -0
  411. data/lib/plaid/models/sandbox_bank_transfer_simulate_request.rb +128 -0
  412. data/lib/plaid/models/sandbox_bank_transfer_simulate_response.rb +76 -0
  413. data/lib/plaid/models/sandbox_income_fire_webhook_request.rb +125 -0
  414. data/lib/plaid/models/sandbox_income_fire_webhook_response.rb +77 -0
  415. data/lib/plaid/models/sandbox_item_fire_webhook_request.rb +109 -0
  416. data/lib/plaid/models/sandbox_item_fire_webhook_response.rb +85 -0
  417. data/lib/plaid/models/sandbox_item_reset_login_request.rb +98 -0
  418. data/lib/plaid/models/sandbox_item_reset_login_response.rb +85 -0
  419. data/lib/plaid/models/sandbox_item_set_verification_status_request.rb +118 -0
  420. data/lib/plaid/models/sandbox_item_set_verification_status_response.rb +77 -0
  421. data/lib/plaid/models/sandbox_oauth_select_accounts_request.rb +83 -0
  422. data/lib/plaid/models/sandbox_processor_token_create_request.rb +111 -0
  423. data/lib/plaid/models/sandbox_processor_token_create_request_options.rb +92 -0
  424. data/lib/plaid/models/sandbox_processor_token_create_response.rb +85 -0
  425. data/lib/plaid/models/sandbox_public_token_create_request.rb +123 -0
  426. data/lib/plaid/models/sandbox_public_token_create_request_options.rb +116 -0
  427. data/lib/plaid/models/sandbox_public_token_create_request_options_transactions.rb +88 -0
  428. data/lib/plaid/models/sandbox_public_token_create_response.rb +86 -0
  429. data/lib/plaid/models/sandbox_transfer_simulate_request.rb +124 -0
  430. data/lib/plaid/models/sandbox_transfer_simulate_response.rb +76 -0
  431. data/lib/plaid/models/scopes.rb +109 -0
  432. data/lib/plaid/models/scopes_context.rb +38 -0
  433. data/lib/plaid/models/scopes_nullable.rb +109 -0
  434. data/lib/plaid/models/security.rb +252 -0
  435. data/lib/plaid/models/security_override.rb +131 -0
  436. data/lib/plaid/models/sell_type.rb +105 -0
  437. data/lib/plaid/models/sender_bacs_nullable.rb +85 -0
  438. data/lib/plaid/models/servicer_address_data.rb +117 -0
  439. data/lib/plaid/models/signal_decision_report_request.rb +110 -0
  440. data/lib/plaid/models/signal_decision_report_response.rb +77 -0
  441. data/lib/plaid/models/signal_evaluate_core_attributes.rb +662 -0
  442. data/lib/plaid/models/signal_evaluate_device.rb +90 -0
  443. data/lib/plaid/models/signal_evaluate_request.rb +163 -0
  444. data/lib/plaid/models/signal_evaluate_response.rb +99 -0
  445. data/lib/plaid/models/signal_evaluate_scores.rb +108 -0
  446. data/lib/plaid/models/signal_person_name.rb +122 -0
  447. data/lib/plaid/models/signal_return_report_request.rb +110 -0
  448. data/lib/plaid/models/signal_return_report_response.rb +77 -0
  449. data/lib/plaid/models/signal_user.rb +111 -0
  450. data/lib/plaid/models/standalone_account_type.rb +115 -0
  451. data/lib/plaid/models/standalone_currency_code_list.rb +86 -0
  452. data/lib/plaid/models/standalone_investment_transaction_type.rb +119 -0
  453. data/lib/plaid/models/state.rb +49 -0
  454. data/lib/plaid/models/status.rb +41 -0
  455. data/lib/plaid/models/status1.rb +48 -0
  456. data/lib/plaid/models/status2.rb +49 -0
  457. data/lib/plaid/models/status3.rb +73 -0
  458. data/lib/plaid/models/status_breakdown.rb +111 -0
  459. data/lib/plaid/models/student_loan.rb +367 -0
  460. data/lib/plaid/models/student_loan_repayment_model.rb +95 -0
  461. data/lib/plaid/models/student_loan_status.rb +86 -0
  462. data/lib/plaid/models/student_repayment_plan.rb +84 -0
  463. data/lib/plaid/models/subtype.rb +209 -0
  464. data/lib/plaid/models/switch_method.rb +45 -0
  465. data/lib/plaid/models/taxform.rb +84 -0
  466. data/lib/plaid/models/taxpayer_id.rb +89 -0
  467. data/lib/plaid/models/total.rb +110 -0
  468. data/lib/plaid/models/transaction.rb +426 -0
  469. data/lib/plaid/models/transaction_base.rb +285 -0
  470. data/lib/plaid/models/transaction_code.rb +87 -0
  471. data/lib/plaid/models/transaction_data.rb +112 -0
  472. data/lib/plaid/models/transaction_location.rb +143 -0
  473. data/lib/plaid/models/transaction_override.rb +119 -0
  474. data/lib/plaid/models/transaction_type.rb +48 -0
  475. data/lib/plaid/models/transactions_get_request.rb +128 -0
  476. data/lib/plaid/models/transactions_get_request_options.rb +139 -0
  477. data/lib/plaid/models/transactions_get_response.rb +138 -0
  478. data/lib/plaid/models/transactions_refresh_request.rb +98 -0
  479. data/lib/plaid/models/transactions_refresh_response.rb +77 -0
  480. data/lib/plaid/models/transactions_removed_webhook.rb +119 -0
  481. data/lib/plaid/models/transactions_update_investments_webhook.rb +134 -0
  482. data/lib/plaid/models/transfer.rb +229 -0
  483. data/lib/plaid/models/transfer_authorization.rb +126 -0
  484. data/lib/plaid/models/transfer_authorization_create_request.rb +197 -0
  485. data/lib/plaid/models/transfer_authorization_create_response.rb +86 -0
  486. data/lib/plaid/models/transfer_authorization_decision_rationale.rb +96 -0
  487. data/lib/plaid/models/transfer_authorization_device.rb +86 -0
  488. data/lib/plaid/models/transfer_authorization_proposed_transfer.rb +150 -0
  489. data/lib/plaid/models/transfer_cancel_request.rb +97 -0
  490. data/lib/plaid/models/transfer_cancel_response.rb +76 -0
  491. data/lib/plaid/models/transfer_create_request.rb +241 -0
  492. data/lib/plaid/models/transfer_create_response.rb +84 -0
  493. data/lib/plaid/models/transfer_event.rb +171 -0
  494. data/lib/plaid/models/transfer_event_list_request.rb +214 -0
  495. data/lib/plaid/models/transfer_event_list_response.rb +93 -0
  496. data/lib/plaid/models/transfer_event_sync_request.rb +110 -0
  497. data/lib/plaid/models/transfer_event_sync_response.rb +93 -0
  498. data/lib/plaid/models/transfer_event_type.rb +52 -0
  499. data/lib/plaid/models/transfer_failure.rb +93 -0
  500. data/lib/plaid/models/transfer_get_request.rb +97 -0
  501. data/lib/plaid/models/transfer_get_response.rb +84 -0
  502. data/lib/plaid/models/transfer_list_request.rb +163 -0
  503. data/lib/plaid/models/transfer_list_response.rb +93 -0
  504. data/lib/plaid/models/transfer_network.rb +37 -0
  505. data/lib/plaid/models/transfer_status.rb +48 -0
  506. data/lib/plaid/models/transfer_type.rb +146 -0
  507. data/lib/plaid/models/transfer_type1.rb +38 -0
  508. data/lib/plaid/models/transfer_type2.rb +38 -0
  509. data/lib/plaid/models/transfer_user_address_in_request.rb +114 -0
  510. data/lib/plaid/models/transfer_user_address_in_response.rb +114 -0
  511. data/lib/plaid/models/transfer_user_in_request.rb +105 -0
  512. data/lib/plaid/models/transfer_user_in_response.rb +104 -0
  513. data/lib/plaid/models/type.rb +52 -0
  514. data/lib/plaid/models/type1.rb +40 -0
  515. data/lib/plaid/models/type2.rb +100 -0
  516. data/lib/plaid/models/type3.rb +68 -0
  517. data/lib/plaid/models/type4.rb +60 -0
  518. data/lib/plaid/models/type5.rb +41 -0
  519. data/lib/plaid/models/unofficial_currency_code_list.rb +252 -0
  520. data/lib/plaid/models/update_type.rb +39 -0
  521. data/lib/plaid/models/user_custom_password.rb +166 -0
  522. data/lib/plaid/models/user_permission_revoked_webhook.rb +110 -0
  523. data/lib/plaid/models/value.rb +52 -0
  524. data/lib/plaid/models/verification_expired_webhook.rb +102 -0
  525. data/lib/plaid/models/verification_refresh_status.rb +29 -0
  526. data/lib/plaid/models/verification_status.rb +53 -0
  527. data/lib/plaid/models/verification_status1.rb +36 -0
  528. data/lib/plaid/models/verification_status3.rb +48 -0
  529. data/lib/plaid/models/verification_status4.rb +65 -0
  530. data/lib/plaid/models/w2.rb +346 -0
  531. data/lib/plaid/models/w2_box12.rb +88 -0
  532. data/lib/plaid/models/w2_state_and_local_wages.rb +152 -0
  533. data/lib/plaid/models/warning.rb +98 -0
  534. data/lib/plaid/models/webhook_update_acknowledged_webhook.rb +118 -0
  535. data/lib/plaid/models/webhook_verification_key_get_request.rb +98 -0
  536. data/lib/plaid/models/webhook_verification_key_get_response.rb +86 -0
  537. data/lib/plaid/models/ytd_gross_income_summary_field_number.rb +90 -0
  538. data/lib/plaid/models/ytd_net_income_summary_field_number.rb +90 -0
  539. data/lib/plaid/utilities/date_time_helper.rb +11 -0
  540. data/lib/plaid/utilities/file_wrapper.rb +28 -0
  541. data/lib/plaid.rb +565 -0
  542. metadata +625 -0
@@ -0,0 +1,267 @@
1
+ # plaid
2
+ #
3
+ # This file was automatically generated by APIMATIC v3.0 (
4
+ # https://www.apimatic.io ).
5
+
6
+ module Plaid
7
+ # ItemApi
8
+ class ItemApi < BaseApi
9
+ # By default, the `access_token` associated with an Item does not expire and
10
+ # should be stored in a persistent, secure manner.
11
+ # You can use the `/item/access_token/invalidate` endpoint to rotate the
12
+ # `access_token` associated with an Item. The endpoint returns a new
13
+ # `access_token` and immediately invalidates the previous `access_token`.
14
+ # @param [ItemAccessTokenInvalidateRequest] body Required parameter: TODO:
15
+ # type description here
16
+ # @return [ApiResponse] Complete http response with raw body and status code.
17
+ def item_access_token_invalidate(body)
18
+ @api_call
19
+ .request(new_request_builder(HttpMethodEnum::POST,
20
+ '/item/access_token/invalidate',
21
+ Server::DEFAULT)
22
+ .header_param(new_parameter('application/json', key: 'Content-Type'))
23
+ .body_param(new_parameter(body)
24
+ .is_required(true))
25
+ .header_param(new_parameter('application/json', key: 'accept'))
26
+ .body_serializer(proc do |param| param.to_json unless param.nil? end)
27
+ .auth(And.new('PLAID-CLIENT-ID', 'PLAID-SECRET', 'Plaid-Version')))
28
+ .response(new_response_handler
29
+ .deserializer(APIHelper.method(:custom_type_deserializer))
30
+ .deserialize_into(ItemAccessTokenInvalidateResponse.method(:from_hash))
31
+ .is_api_response(true))
32
+ .execute
33
+ end
34
+
35
+ # The `/item/remove` endpoint allows you to remove an Item. Once removed,
36
+ # the `access_token` associated with the Item is no longer valid and cannot
37
+ # be used to access any data that was associated with the Item.
38
+ # Note that in the Development environment, issuing an `/item/remove`
39
+ # request will not decrement your live credential count. To increase your
40
+ # credential account in Development, contact Support.
41
+ # Also note that for certain OAuth-based institutions, an Item removed via
42
+ # `/item/remove` may still show as an active connection in the institution's
43
+ # OAuth permission manager.
44
+ # @param [ItemRemoveRequest] body Required parameter: TODO: type description
45
+ # here
46
+ # @return [ApiResponse] Complete http response with raw body and status code.
47
+ def item_remove(body)
48
+ @api_call
49
+ .request(new_request_builder(HttpMethodEnum::POST,
50
+ '/item/remove',
51
+ Server::DEFAULT)
52
+ .header_param(new_parameter('application/json', key: 'Content-Type'))
53
+ .body_param(new_parameter(body)
54
+ .is_required(true))
55
+ .header_param(new_parameter('application/json', key: 'accept'))
56
+ .body_serializer(proc do |param| param.to_json unless param.nil? end)
57
+ .auth(And.new('PLAID-CLIENT-ID', 'PLAID-SECRET', 'Plaid-Version')))
58
+ .response(new_response_handler
59
+ .deserializer(APIHelper.method(:custom_type_deserializer))
60
+ .deserialize_into(ItemRemoveResponse.method(:from_hash))
61
+ .is_api_response(true)
62
+ .local_error('default',
63
+ 'Error response.',
64
+ ErrorErrorException))
65
+ .execute
66
+ end
67
+
68
+ # List a user’s connected applications
69
+ # @param [ItemApplicationListRequest] body Required parameter: TODO: type
70
+ # description here
71
+ # @return [ApiResponse] Complete http response with raw body and status code.
72
+ def item_application_list(body)
73
+ @api_call
74
+ .request(new_request_builder(HttpMethodEnum::POST,
75
+ '/item/application/list',
76
+ Server::DEFAULT)
77
+ .header_param(new_parameter('application/json', key: 'Content-Type'))
78
+ .body_param(new_parameter(body)
79
+ .is_required(true))
80
+ .header_param(new_parameter('application/json', key: 'accept'))
81
+ .body_serializer(proc do |param| param.to_json unless param.nil? end)
82
+ .auth(And.new('PLAID-CLIENT-ID', 'PLAID-SECRET', 'Plaid-Version')))
83
+ .response(new_response_handler
84
+ .deserializer(APIHelper.method(:custom_type_deserializer))
85
+ .deserialize_into(ItemApplicationListResponse.method(:from_hash))
86
+ .is_api_response(true)
87
+ .local_error('default',
88
+ 'Error response.',
89
+ ErrorErrorException))
90
+ .execute
91
+ end
92
+
93
+ # Exchange a Link `public_token` for an API `access_token`. Link hands off
94
+ # the `public_token` client-side via the `onSuccess` callback once a user
95
+ # has successfully created an Item. The `public_token` is ephemeral and
96
+ # expires after 30 minutes.
97
+ # The response also includes an `item_id` that should be stored with the
98
+ # `access_token`. The `item_id` is used to identify an Item in a webhook.
99
+ # The `item_id` can also be retrieved by making an `/item/get` request.
100
+ # @param [ItemPublicTokenExchangeRequest] body Required parameter: TODO:
101
+ # type description here
102
+ # @return [ApiResponse] Complete http response with raw body and status code.
103
+ def item_public_token_exchange(body)
104
+ @api_call
105
+ .request(new_request_builder(HttpMethodEnum::POST,
106
+ '/item/public_token/exchange',
107
+ Server::DEFAULT)
108
+ .header_param(new_parameter('application/json', key: 'Content-Type'))
109
+ .body_param(new_parameter(body)
110
+ .is_required(true))
111
+ .header_param(new_parameter('application/json', key: 'accept'))
112
+ .body_serializer(proc do |param| param.to_json unless param.nil? end)
113
+ .auth(And.new('PLAID-CLIENT-ID', 'PLAID-SECRET', 'Plaid-Version')))
114
+ .response(new_response_handler
115
+ .deserializer(APIHelper.method(:custom_type_deserializer))
116
+ .deserialize_into(ItemPublicTokenExchangeResponse.method(:from_hash))
117
+ .is_api_response(true))
118
+ .execute
119
+ end
120
+
121
+ # Returns information about the status of an Item.
122
+ # @param [ItemGetRequest] body Required parameter: TODO: type description
123
+ # here
124
+ # @return [ApiResponse] Complete http response with raw body and status code.
125
+ def item_get(body)
126
+ @api_call
127
+ .request(new_request_builder(HttpMethodEnum::POST,
128
+ '/item/get',
129
+ Server::DEFAULT)
130
+ .header_param(new_parameter('application/json', key: 'Content-Type'))
131
+ .body_param(new_parameter(body)
132
+ .is_required(true))
133
+ .header_param(new_parameter('application/json', key: 'accept'))
134
+ .body_serializer(proc do |param| param.to_json unless param.nil? end)
135
+ .auth(And.new('PLAID-CLIENT-ID', 'PLAID-SECRET', 'Plaid-Version')))
136
+ .response(new_response_handler
137
+ .deserializer(APIHelper.method(:custom_type_deserializer))
138
+ .deserialize_into(ItemGetResponse.method(:from_hash))
139
+ .is_api_response(true)
140
+ .local_error('default',
141
+ 'Error response.',
142
+ ErrorErrorException))
143
+ .execute
144
+ end
145
+
146
+ # Note: As of July 2020, the `/item/public_token/create` endpoint is
147
+ # deprecated. Instead, use `/link/token/create` with an `access_token` to
148
+ # create a Link token for use with [update
149
+ # mode](https://plaid.com/docs/link/update-mode).
150
+ # If you need your user to take action to restore or resolve an error
151
+ # associated with an Item, generate a public token with the
152
+ # `/item/public_token/create` endpoint and then initialize Link with that
153
+ # `public_token`.
154
+ # A `public_token` is one-time use and expires after 30 minutes. You use a
155
+ # `public_token` to initialize Link in [update
156
+ # mode](https://plaid.com/docs/link/update-mode) for a particular Item. You
157
+ # can generate a `public_token` for an Item even if you did not use Link to
158
+ # create the Item originally.
159
+ # The `/item/public_token/create` endpoint is **not** used to create your
160
+ # initial `public_token`. If you have not already received an `access_token`
161
+ # for a specific Item, use Link to obtain your `public_token` instead. See
162
+ # the [Quickstart](https://plaid.com/docs/quickstart) for more information.
163
+ # @param [ItemPublicTokenCreateRequest] body Required parameter: TODO: type
164
+ # description here
165
+ # @return [ApiResponse] Complete http response with raw body and status code.
166
+ def item_create_public_token(body)
167
+ @api_call
168
+ .request(new_request_builder(HttpMethodEnum::POST,
169
+ '/item/public_token/create',
170
+ Server::DEFAULT)
171
+ .header_param(new_parameter('application/json', key: 'Content-Type'))
172
+ .body_param(new_parameter(body)
173
+ .is_required(true))
174
+ .header_param(new_parameter('application/json', key: 'accept'))
175
+ .body_serializer(proc do |param| param.to_json unless param.nil? end)
176
+ .auth(And.new('PLAID-CLIENT-ID', 'PLAID-SECRET', 'Plaid-Version')))
177
+ .response(new_response_handler
178
+ .deserializer(APIHelper.method(:custom_type_deserializer))
179
+ .deserialize_into(ItemPublicTokenCreateResponse.method(:from_hash))
180
+ .is_api_response(true))
181
+ .execute
182
+ end
183
+
184
+ # Enable consumers to update product access on selected accounts for an
185
+ # application.
186
+ # @param [ItemApplicationScopesUpdateRequest] body Required parameter: TODO:
187
+ # type description here
188
+ # @return [ApiResponse] Complete http response with raw body and status code.
189
+ def item_application_scopes_update(body)
190
+ @api_call
191
+ .request(new_request_builder(HttpMethodEnum::POST,
192
+ '/item/application/scopes/update',
193
+ Server::DEFAULT)
194
+ .header_param(new_parameter('application/json', key: 'Content-Type'))
195
+ .body_param(new_parameter(body)
196
+ .is_required(true))
197
+ .header_param(new_parameter('application/json', key: 'accept'))
198
+ .body_serializer(proc do |param| param.to_json unless param.nil? end)
199
+ .auth(And.new('PLAID-CLIENT-ID', 'PLAID-SECRET', 'Plaid-Version')))
200
+ .response(new_response_handler
201
+ .deserializer(APIHelper.method(:custom_type_deserializer))
202
+ .deserialize_into(ItemApplicationScopesUpdateResponse.method(:from_hash))
203
+ .is_api_response(true)
204
+ .local_error('default',
205
+ 'Error response.',
206
+ ErrorErrorException))
207
+ .execute
208
+ end
209
+
210
+ # The POST `/item/webhook/update` allows you to update the webhook URL
211
+ # associated with an Item. This request triggers a
212
+ # [`WEBHOOK_UPDATE_ACKNOWLEDGED`](https://plaid.com/docs/api/webhooks/#item-
213
+ # webhook-url-updated) webhook to the newly specified webhook URL.
214
+ # @param [ItemWebhookUpdateRequest] body Required parameter: TODO: type
215
+ # description here
216
+ # @return [ApiResponse] Complete http response with raw body and status code.
217
+ def item_webhook_update(body)
218
+ @api_call
219
+ .request(new_request_builder(HttpMethodEnum::POST,
220
+ '/item/webhook/update',
221
+ Server::DEFAULT)
222
+ .header_param(new_parameter('application/json', key: 'Content-Type'))
223
+ .body_param(new_parameter(body)
224
+ .is_required(true))
225
+ .header_param(new_parameter('application/json', key: 'accept'))
226
+ .body_serializer(proc do |param| param.to_json unless param.nil? end)
227
+ .auth(And.new('PLAID-CLIENT-ID', 'PLAID-SECRET', 'Plaid-Version')))
228
+ .response(new_response_handler
229
+ .deserializer(APIHelper.method(:custom_type_deserializer))
230
+ .deserialize_into(ItemWebhookUpdateResponse.method(:from_hash))
231
+ .is_api_response(true))
232
+ .execute
233
+ end
234
+
235
+ # `/item/import` creates an Item via your Plaid Exchange Integration and
236
+ # returns an `access_token`. As part of an `/item/import` request, you will
237
+ # include a User ID (`user_auth.user_id`) and Authentication Token
238
+ # (`user_auth.auth_token`) that enable data aggregation through your Plaid
239
+ # Exchange API endpoints. These authentication principals are to be chosen
240
+ # by you.
241
+ # Upon creating an Item via `/item/import`, Plaid will automatically begin
242
+ # an extraction of that Item through the Plaid Exchange infrastructure you
243
+ # have already integrated. This will automatically generate the Plaid native
244
+ # account ID for the account the user will switch their direct deposit to
245
+ # (`target_account_id`).
246
+ # @param [ItemImportRequest] body Required parameter: TODO: type description
247
+ # here
248
+ # @return [ApiResponse] Complete http response with raw body and status code.
249
+ def item_import(body)
250
+ @api_call
251
+ .request(new_request_builder(HttpMethodEnum::POST,
252
+ '/item/import',
253
+ Server::DEFAULT)
254
+ .header_param(new_parameter('application/json', key: 'Content-Type'))
255
+ .body_param(new_parameter(body)
256
+ .is_required(true))
257
+ .header_param(new_parameter('application/json', key: 'accept'))
258
+ .body_serializer(proc do |param| param.to_json unless param.nil? end)
259
+ .auth(And.new('PLAID-CLIENT-ID', 'PLAID-SECRET', 'Plaid-Version')))
260
+ .response(new_response_handler
261
+ .deserializer(APIHelper.method(:custom_type_deserializer))
262
+ .deserialize_into(ItemImportResponse.method(:from_hash))
263
+ .is_api_response(true))
264
+ .execute
265
+ end
266
+ end
267
+ end
@@ -0,0 +1,47 @@
1
+ # plaid
2
+ #
3
+ # This file was automatically generated by APIMATIC v3.0 (
4
+ # https://www.apimatic.io ).
5
+
6
+ module Plaid
7
+ # LiabilitiesApi
8
+ class LiabilitiesApi < BaseApi
9
+ # The `/liabilities/get` endpoint returns various details about an Item with
10
+ # loan or credit accounts. Liabilities data is available primarily for US
11
+ # financial institutions, with some limited coverage of Canadian
12
+ # institutions. Currently supported account types are account type `credit`
13
+ # with account subtype `credit card` or `paypal`, and account type `loan`
14
+ # with account subtype `student` or `mortgage`. To limit accounts listed in
15
+ # Link to types and subtypes supported by Liabilities, you can use the
16
+ # `account_filters` parameter when [creating a Link
17
+ # token](https://plaid.com/docs/api/tokens/#linktokencreate).
18
+ # The types of information returned by Liabilities can include balances and
19
+ # due dates, loan terms, and account details such as original loan amount
20
+ # and guarantor. Data is refreshed approximately once per day; the latest
21
+ # data can be retrieved by calling `/liabilities/get`.
22
+ # Note: This request may take some time to complete if `liabilities` was not
23
+ # specified as an initial product when creating the Item. This is because
24
+ # Plaid must communicate directly with the institution to retrieve the
25
+ # additional data.
26
+ # @param [LiabilitiesGetRequest] body Required parameter: TODO: type
27
+ # description here
28
+ # @return [ApiResponse] Complete http response with raw body and status code.
29
+ def liabilities_get(body)
30
+ @api_call
31
+ .request(new_request_builder(HttpMethodEnum::POST,
32
+ '/liabilities/get',
33
+ Server::DEFAULT)
34
+ .header_param(new_parameter('application/json', key: 'Content-Type'))
35
+ .body_param(new_parameter(body)
36
+ .is_required(true))
37
+ .header_param(new_parameter('application/json', key: 'accept'))
38
+ .body_serializer(proc do |param| param.to_json unless param.nil? end)
39
+ .auth(And.new('PLAID-CLIENT-ID', 'PLAID-SECRET', 'Plaid-Version')))
40
+ .response(new_response_handler
41
+ .deserializer(APIHelper.method(:custom_type_deserializer))
42
+ .deserialize_into(LiabilitiesGetResponse.method(:from_hash))
43
+ .is_api_response(true))
44
+ .execute
45
+ end
46
+ end
47
+ end
@@ -0,0 +1,62 @@
1
+ # plaid
2
+ #
3
+ # This file was automatically generated by APIMATIC v3.0 (
4
+ # https://www.apimatic.io ).
5
+
6
+ module Plaid
7
+ # LinkApi
8
+ class LinkApi < BaseApi
9
+ # The `/link/token/get` endpoint gets information about a previously-created
10
+ # `link_token` using the
11
+ # `/link/token/create` endpoint. It can be useful for debugging purposes.
12
+ # @param [LinkTokenGetRequest] body Required parameter: TODO: type
13
+ # description here
14
+ # @return [ApiResponse] Complete http response with raw body and status code.
15
+ def link_token_get(body)
16
+ @api_call
17
+ .request(new_request_builder(HttpMethodEnum::POST,
18
+ '/link/token/get',
19
+ Server::DEFAULT)
20
+ .header_param(new_parameter('application/json', key: 'Content-Type'))
21
+ .body_param(new_parameter(body)
22
+ .is_required(true))
23
+ .header_param(new_parameter('application/json', key: 'accept'))
24
+ .body_serializer(proc do |param| param.to_json unless param.nil? end)
25
+ .auth(And.new('PLAID-CLIENT-ID', 'PLAID-SECRET', 'Plaid-Version')))
26
+ .response(new_response_handler
27
+ .deserializer(APIHelper.method(:custom_type_deserializer))
28
+ .deserialize_into(LinkTokenGetResponse.method(:from_hash))
29
+ .is_api_response(true))
30
+ .execute
31
+ end
32
+
33
+ # The `/link/token/create` endpoint creates a `link_token`, which is
34
+ # required as a parameter when initializing Link. Once Link has been
35
+ # initialized, it returns a `public_token`, which can then be exchanged for
36
+ # an `access_token` via `/item/public_token/exchange` as part of the main
37
+ # Link flow.
38
+ # A `link_token` generated by `/link/token/create` is also used to
39
+ # initialize other Link flows, such as the update mode flow for tokens with
40
+ # expired credentials, or the Payment Initiation (Europe) flow.
41
+ # @param [LinkTokenCreateRequest] body Required parameter: TODO: type
42
+ # description here
43
+ # @return [ApiResponse] Complete http response with raw body and status code.
44
+ def link_token_create(body)
45
+ @api_call
46
+ .request(new_request_builder(HttpMethodEnum::POST,
47
+ '/link/token/create',
48
+ Server::DEFAULT)
49
+ .header_param(new_parameter('application/json', key: 'Content-Type'))
50
+ .body_param(new_parameter(body)
51
+ .is_required(true))
52
+ .header_param(new_parameter('application/json', key: 'accept'))
53
+ .body_serializer(proc do |param| param.to_json unless param.nil? end)
54
+ .auth(And.new('PLAID-CLIENT-ID', 'PLAID-SECRET', 'Plaid-Version')))
55
+ .response(new_response_handler
56
+ .deserializer(APIHelper.method(:custom_type_deserializer))
57
+ .deserialize_into(LinkTokenCreateResponse.method(:from_hash))
58
+ .is_api_response(true))
59
+ .execute
60
+ end
61
+ end
62
+ end
@@ -0,0 +1,236 @@
1
+ # plaid
2
+ #
3
+ # This file was automatically generated by APIMATIC v3.0 (
4
+ # https://www.apimatic.io ).
5
+
6
+ module Plaid
7
+ # PaymentInitiationApi
8
+ class PaymentInitiationApi < BaseApi
9
+ # Reverse a previously initiated payment.
10
+ # A payment can only be reversed once and will be refunded to the original
11
+ # sender's account.
12
+ # @param [PaymentInitiationPaymentReverseRequest] body Required parameter:
13
+ # TODO: type description here
14
+ # @return [ApiResponse] Complete http response with raw body and status code.
15
+ def payment_initiation_payment_reverse(body)
16
+ @api_call
17
+ .request(new_request_builder(HttpMethodEnum::POST,
18
+ '/payment_initiation/payment/reverse',
19
+ Server::DEFAULT)
20
+ .header_param(new_parameter('application/json', key: 'Content-Type'))
21
+ .body_param(new_parameter(body)
22
+ .is_required(true))
23
+ .header_param(new_parameter('application/json', key: 'accept'))
24
+ .body_serializer(proc do |param| param.to_json unless param.nil? end)
25
+ .auth(And.new('PLAID-CLIENT-ID', 'PLAID-SECRET', 'Plaid-Version')))
26
+ .response(new_response_handler
27
+ .deserializer(APIHelper.method(:custom_type_deserializer))
28
+ .deserialize_into(PaymentInitiationPaymentReverseResponse.method(:from_hash))
29
+ .is_api_response(true))
30
+ .execute
31
+ end
32
+
33
+ # Create a payment recipient for payment initiation. The recipient must be
34
+ # in Europe, within a country that is a member of the Single Euro Payment
35
+ # Area (SEPA). For a standing order (recurring) payment, the recipient must
36
+ # be in the UK.
37
+ # The endpoint is idempotent: if a developer has already made a request with
38
+ # the same payment details, Plaid will return the same `recipient_id`.
39
+ # @param [PaymentInitiationRecipientCreateRequest] body Required parameter:
40
+ # TODO: type description here
41
+ # @return [ApiResponse] Complete http response with raw body and status code.
42
+ def payment_initiation_recipient_create(body)
43
+ @api_call
44
+ .request(new_request_builder(HttpMethodEnum::POST,
45
+ '/payment_initiation/recipient/create',
46
+ Server::DEFAULT)
47
+ .header_param(new_parameter('application/json', key: 'Content-Type'))
48
+ .body_param(new_parameter(body)
49
+ .is_required(true))
50
+ .header_param(new_parameter('application/json', key: 'accept'))
51
+ .body_serializer(proc do |param| param.to_json unless param.nil? end)
52
+ .auth(And.new('PLAID-CLIENT-ID', 'PLAID-SECRET', 'Plaid-Version')))
53
+ .response(new_response_handler
54
+ .deserializer(APIHelper.method(:custom_type_deserializer))
55
+ .deserialize_into(PaymentInitiationRecipientCreateResponse.method(:from_hash))
56
+ .is_api_response(true))
57
+ .execute
58
+ end
59
+
60
+ # The `/payment_initiation/recipient/list` endpoint list the payment
61
+ # recipients that you have previously created.
62
+ # @param [PaymentInitiationRecipientListRequest] body Required parameter:
63
+ # TODO: type description here
64
+ # @return [ApiResponse] Complete http response with raw body and status code.
65
+ def payment_initiation_recipient_list(body)
66
+ @api_call
67
+ .request(new_request_builder(HttpMethodEnum::POST,
68
+ '/payment_initiation/recipient/list',
69
+ Server::DEFAULT)
70
+ .header_param(new_parameter('application/json', key: 'Content-Type'))
71
+ .body_param(new_parameter(body)
72
+ .is_required(true))
73
+ .header_param(new_parameter('application/json', key: 'accept'))
74
+ .body_serializer(proc do |param| param.to_json unless param.nil? end)
75
+ .auth(And.new('PLAID-CLIENT-ID', 'PLAID-SECRET', 'Plaid-Version')))
76
+ .response(new_response_handler
77
+ .deserializer(APIHelper.method(:custom_type_deserializer))
78
+ .deserialize_into(PaymentInitiationRecipientListResponse.method(:from_hash))
79
+ .is_api_response(true))
80
+ .execute
81
+ end
82
+
83
+ # Get details about a payment recipient you have previously created.
84
+ # @param [PaymentInitiationRecipientGetRequest] body Required parameter:
85
+ # TODO: type description here
86
+ # @return [ApiResponse] Complete http response with raw body and status code.
87
+ def payment_initiation_recipient_get(body)
88
+ @api_call
89
+ .request(new_request_builder(HttpMethodEnum::POST,
90
+ '/payment_initiation/recipient/get',
91
+ Server::DEFAULT)
92
+ .header_param(new_parameter('application/json', key: 'Content-Type'))
93
+ .body_param(new_parameter(body)
94
+ .is_required(true))
95
+ .header_param(new_parameter('application/json', key: 'accept'))
96
+ .body_serializer(proc do |param| param.to_json unless param.nil? end)
97
+ .auth(And.new('PLAID-CLIENT-ID', 'PLAID-SECRET', 'Plaid-Version')))
98
+ .response(new_response_handler
99
+ .deserializer(APIHelper.method(:custom_type_deserializer))
100
+ .deserialize_into(PaymentInitiationRecipientGetResponse.method(:from_hash))
101
+ .is_api_response(true))
102
+ .execute
103
+ end
104
+
105
+ # After creating a payment recipient, you can use the
106
+ # `/payment_initiation/payment/create` endpoint to create a payment to that
107
+ # recipient. Payments can be one-time or standing order (recurring) and can
108
+ # be denominated in either EUR or GBP. If making domestic GBP-denominated
109
+ # payments, your recipient must have been created with BACS numbers. In
110
+ # general, EUR-denominated payments will be sent via SEPA Credit Transfer
111
+ # and GBP-denominated payments will be sent via the Faster Payments network,
112
+ # but the payment network used will be determined by the institution.
113
+ # Payments sent via Faster Payments will typically arrive immediately, while
114
+ # payments sent via SEPA Credit Transfer will typically arrive in one
115
+ # business day.
116
+ # Standing orders (recurring payments) must be denominated in GBP and can
117
+ # only be sent to recipients in the UK. Once created, standing order
118
+ # payments cannot be modified or canceled via the API. An end user can
119
+ # cancel or modify a standing order directly on their banking application or
120
+ # website, or by contacting the bank. Standing orders will follow the
121
+ # payment rules of the underlying rails (Faster Payments in UK). Payments
122
+ # can be sent Monday to Friday, excluding bank holidays. If the pre-arranged
123
+ # date falls on a weekend or bank holiday, the payment is made on the next
124
+ # working day. It is not possible to guarantee the exact time the payment
125
+ # will reach the recipient’s account, although at least 90% of standing
126
+ # order payments are sent by 6am.
127
+ # In the Development environment, payments must be below 5 GBP / EUR. For
128
+ # details on any payment limits in Production, contact your Plaid Account
129
+ # Manager.
130
+ # @param [PaymentInitiationPaymentCreateRequest] body Required parameter:
131
+ # TODO: type description here
132
+ # @return [ApiResponse] Complete http response with raw body and status code.
133
+ def payment_initiation_payment_create(body)
134
+ @api_call
135
+ .request(new_request_builder(HttpMethodEnum::POST,
136
+ '/payment_initiation/payment/create',
137
+ Server::DEFAULT)
138
+ .header_param(new_parameter('application/json', key: 'Content-Type'))
139
+ .body_param(new_parameter(body)
140
+ .is_required(true))
141
+ .header_param(new_parameter('application/json', key: 'accept'))
142
+ .body_serializer(proc do |param| param.to_json unless param.nil? end)
143
+ .auth(And.new('PLAID-CLIENT-ID', 'PLAID-SECRET', 'Plaid-Version')))
144
+ .response(new_response_handler
145
+ .deserializer(APIHelper.method(:custom_type_deserializer))
146
+ .deserialize_into(PaymentInitiationPaymentCreateResponse.method(:from_hash))
147
+ .is_api_response(true))
148
+ .execute
149
+ end
150
+
151
+ # The `/payment_initiation/payment/get` endpoint can be used to check the
152
+ # status of a payment, as well as to receive basic information such as
153
+ # recipient and payment amount. In the case of standing orders, the
154
+ # `/payment_initiation/payment/get` endpoint will provide information about
155
+ # the status of the overall standing order itself; the API cannot be used to
156
+ # retrieve payment status for individual payments within a standing order.
157
+ # @param [PaymentInitiationPaymentGetRequest] body Required parameter: TODO:
158
+ # type description here
159
+ # @return [ApiResponse] Complete http response with raw body and status code.
160
+ def payment_initiation_payment_get(body)
161
+ @api_call
162
+ .request(new_request_builder(HttpMethodEnum::POST,
163
+ '/payment_initiation/payment/get',
164
+ Server::DEFAULT)
165
+ .header_param(new_parameter('application/json', key: 'Content-Type'))
166
+ .body_param(new_parameter(body)
167
+ .is_required(true))
168
+ .header_param(new_parameter('application/json', key: 'accept'))
169
+ .body_serializer(proc do |param| param.to_json unless param.nil? end)
170
+ .auth(And.new('PLAID-CLIENT-ID', 'PLAID-SECRET', 'Plaid-Version')))
171
+ .response(new_response_handler
172
+ .deserializer(APIHelper.method(:custom_type_deserializer))
173
+ .deserialize_into(PaymentInitiationPaymentGetResponse.method(:from_hash))
174
+ .is_api_response(true))
175
+ .execute
176
+ end
177
+
178
+ # The `/payment_initiation/payment/token/create` endpoint has been
179
+ # deprecated. New Plaid customers will be unable to use this endpoint, and
180
+ # existing customers are encouraged to migrate to the newer,
181
+ # `link_token`-based flow. The recommended flow is to provide the
182
+ # `payment_id` to `/link/token/create`, which returns a `link_token` used to
183
+ # initialize Link.
184
+ # The `/payment_initiation/payment/token/create` is used to create a
185
+ # `payment_token`, which can then be used in Link initialization to enter a
186
+ # payment initiation flow. You can only use a `payment_token` once. If this
187
+ # attempt fails, the end user aborts the flow, or the token expires, you
188
+ # will need to create a new payment token. Creating a new payment token does
189
+ # not require end user input.
190
+ # @param [PaymentInitiationPaymentTokenCreateRequest] body Required
191
+ # parameter: TODO: type description here
192
+ # @return [ApiResponse] Complete http response with raw body and status code.
193
+ def create_payment_token(body)
194
+ @api_call
195
+ .request(new_request_builder(HttpMethodEnum::POST,
196
+ '/payment_initiation/payment/token/create',
197
+ Server::DEFAULT)
198
+ .header_param(new_parameter('application/json', key: 'Content-Type'))
199
+ .body_param(new_parameter(body)
200
+ .is_required(true))
201
+ .header_param(new_parameter('application/json', key: 'accept'))
202
+ .body_serializer(proc do |param| param.to_json unless param.nil? end)
203
+ .auth(And.new('PLAID-CLIENT-ID', 'PLAID-SECRET', 'Plaid-Version')))
204
+ .response(new_response_handler
205
+ .deserializer(APIHelper.method(:custom_type_deserializer))
206
+ .deserialize_into(PaymentInitiationPaymentTokenCreateResponse.method(:from_hash))
207
+ .is_api_response(true))
208
+ .execute
209
+ end
210
+
211
+ # The `/payment_initiation/payment/list` endpoint can be used to retrieve
212
+ # all created payments. By default, the 10 most recent payments are
213
+ # returned. You can request more payments and paginate through the results
214
+ # using the optional `count` and `cursor` parameters.
215
+ # @param [PaymentInitiationPaymentListRequest] body Required parameter:
216
+ # TODO: type description here
217
+ # @return [ApiResponse] Complete http response with raw body and status code.
218
+ def payment_initiation_payment_list(body)
219
+ @api_call
220
+ .request(new_request_builder(HttpMethodEnum::POST,
221
+ '/payment_initiation/payment/list',
222
+ Server::DEFAULT)
223
+ .header_param(new_parameter('application/json', key: 'Content-Type'))
224
+ .body_param(new_parameter(body)
225
+ .is_required(true))
226
+ .header_param(new_parameter('application/json', key: 'accept'))
227
+ .body_serializer(proc do |param| param.to_json unless param.nil? end)
228
+ .auth(And.new('PLAID-CLIENT-ID', 'PLAID-SECRET', 'Plaid-Version')))
229
+ .response(new_response_handler
230
+ .deserializer(APIHelper.method(:custom_type_deserializer))
231
+ .deserialize_into(PaymentInitiationPaymentListResponse.method(:from_hash))
232
+ .is_api_response(true))
233
+ .execute
234
+ end
235
+ end
236
+ end