plaid 14.4.0 → 14.8.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (723) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +14 -2
  3. data/Dockerfile +4 -2
  4. data/Gemfile.lock +2 -2
  5. data/Makefile +1 -1
  6. data/PUBLISH.md +4 -3
  7. data/lib/plaid/api/plaid_api.rb +161 -31
  8. data/lib/plaid/api_client.rb +1 -1
  9. data/lib/plaid/api_error.rb +1 -1
  10. data/lib/plaid/configuration.rb +2 -3
  11. data/lib/plaid/models/account_access.rb +17 -7
  12. data/lib/plaid/models/account_assets.rb +1 -1
  13. data/lib/plaid/models/account_assets_all_of.rb +1 -1
  14. data/lib/plaid/models/account_balance.rb +1 -1
  15. data/lib/plaid/models/account_base.rb +1 -1
  16. data/lib/plaid/models/account_filter.rb +1 -1
  17. data/lib/plaid/models/account_filters_response.rb +1 -1
  18. data/lib/plaid/models/account_identity.rb +1 -1
  19. data/lib/plaid/models/account_identity_all_of.rb +1 -1
  20. data/lib/plaid/models/account_product_access.rb +249 -0
  21. data/lib/plaid/models/account_product_access_nullable.rb +255 -0
  22. data/lib/plaid/models/account_selection_cardinality.rb +1 -1
  23. data/lib/plaid/models/account_subtype.rb +1 -2
  24. data/lib/plaid/models/account_type.rb +1 -1
  25. data/lib/plaid/models/accounts_balance_get_request.rb +1 -1
  26. data/lib/plaid/models/accounts_balance_get_request_options.rb +1 -1
  27. data/lib/plaid/models/accounts_get_request.rb +1 -1
  28. data/lib/plaid/models/accounts_get_request_options.rb +1 -1
  29. data/lib/plaid/models/accounts_get_response.rb +1 -1
  30. data/lib/plaid/models/ach_class.rb +1 -1
  31. data/lib/plaid/models/address.rb +1 -1
  32. data/lib/plaid/models/address_data.rb +1 -1
  33. data/lib/plaid/models/address_data_nullable.rb +1 -1
  34. data/lib/plaid/models/address_nullable.rb +1 -1
  35. data/lib/plaid/models/application.rb +1 -1
  36. data/lib/plaid/models/application_get_request.rb +1 -1
  37. data/lib/plaid/models/application_get_response.rb +1 -1
  38. data/lib/plaid/models/apr.rb +1 -1
  39. data/lib/plaid/models/asset_report.rb +1 -1
  40. data/lib/plaid/models/asset_report_audit_copy_create_request.rb +1 -1
  41. data/lib/plaid/models/asset_report_audit_copy_create_response.rb +1 -1
  42. data/lib/plaid/models/asset_report_audit_copy_get_request.rb +1 -1
  43. data/lib/plaid/models/asset_report_audit_copy_remove_request.rb +1 -1
  44. data/lib/plaid/models/asset_report_audit_copy_remove_response.rb +1 -1
  45. data/lib/plaid/models/asset_report_create_request.rb +6 -6
  46. data/lib/plaid/models/asset_report_create_request_options.rb +3 -1
  47. data/lib/plaid/models/asset_report_create_response.rb +1 -1
  48. data/lib/plaid/models/asset_report_filter_request.rb +1 -1
  49. data/lib/plaid/models/asset_report_filter_response.rb +1 -1
  50. data/lib/plaid/models/asset_report_get_request.rb +3 -1
  51. data/lib/plaid/models/asset_report_get_response.rb +1 -1
  52. data/lib/plaid/models/asset_report_item.rb +1 -1
  53. data/lib/plaid/models/asset_report_pdf_get_request.rb +1 -1
  54. data/lib/plaid/models/asset_report_refresh_request.rb +7 -6
  55. data/lib/plaid/models/asset_report_refresh_request_options.rb +3 -1
  56. data/lib/plaid/models/asset_report_refresh_response.rb +1 -1
  57. data/lib/plaid/models/asset_report_remove_request.rb +1 -1
  58. data/lib/plaid/models/asset_report_remove_response.rb +1 -1
  59. data/lib/plaid/models/asset_report_transaction.rb +24 -2
  60. data/lib/plaid/models/asset_report_transaction_all_of.rb +1 -1
  61. data/lib/plaid/models/asset_report_user.rb +1 -1
  62. data/lib/plaid/models/assets_error_webhook.rb +1 -1
  63. data/lib/plaid/models/assets_product_ready_webhook.rb +1 -1
  64. data/lib/plaid/models/auth_get_numbers.rb +1 -1
  65. data/lib/plaid/models/auth_get_request.rb +1 -1
  66. data/lib/plaid/models/auth_get_request_options.rb +1 -1
  67. data/lib/plaid/models/auth_get_response.rb +1 -1
  68. data/lib/plaid/models/auth_metadata.rb +1 -1
  69. data/lib/plaid/models/auth_supported_methods.rb +1 -1
  70. data/lib/plaid/models/automatically_verified_webhook.rb +1 -1
  71. data/lib/plaid/models/bank_initiated_return_risk.rb +1 -1
  72. data/lib/plaid/models/bank_transfer.rb +1 -1
  73. data/lib/plaid/models/bank_transfer_balance.rb +1 -1
  74. data/lib/plaid/models/bank_transfer_balance_get_request.rb +1 -1
  75. data/lib/plaid/models/bank_transfer_balance_get_response.rb +1 -1
  76. data/lib/plaid/models/bank_transfer_cancel_request.rb +1 -1
  77. data/lib/plaid/models/bank_transfer_cancel_response.rb +1 -1
  78. data/lib/plaid/models/bank_transfer_create_request.rb +1 -1
  79. data/lib/plaid/models/bank_transfer_create_response.rb +1 -1
  80. data/lib/plaid/models/bank_transfer_direction.rb +1 -1
  81. data/lib/plaid/models/bank_transfer_event.rb +1 -1
  82. data/lib/plaid/models/bank_transfer_event_list_request.rb +1 -1
  83. data/lib/plaid/models/bank_transfer_event_list_response.rb +1 -1
  84. data/lib/plaid/models/bank_transfer_event_sync_request.rb +1 -1
  85. data/lib/plaid/models/bank_transfer_event_sync_response.rb +1 -1
  86. data/lib/plaid/models/bank_transfer_event_type.rb +1 -1
  87. data/lib/plaid/models/bank_transfer_failure.rb +1 -1
  88. data/lib/plaid/models/bank_transfer_get_request.rb +1 -1
  89. data/lib/plaid/models/bank_transfer_get_response.rb +1 -1
  90. data/lib/plaid/models/bank_transfer_list_request.rb +1 -1
  91. data/lib/plaid/models/bank_transfer_list_response.rb +1 -1
  92. data/lib/plaid/models/bank_transfer_migrate_account_request.rb +1 -1
  93. data/lib/plaid/models/bank_transfer_migrate_account_response.rb +1 -1
  94. data/lib/plaid/models/bank_transfer_network.rb +1 -1
  95. data/lib/plaid/models/bank_transfer_receiver_details.rb +1 -1
  96. data/lib/plaid/models/bank_transfer_status.rb +1 -1
  97. data/lib/plaid/models/bank_transfer_sweep.rb +2 -23
  98. data/lib/plaid/models/bank_transfer_sweep_account.rb +1 -1
  99. data/lib/plaid/models/bank_transfer_sweep_get_request.rb +2 -23
  100. data/lib/plaid/models/bank_transfer_sweep_get_response.rb +1 -1
  101. data/lib/plaid/models/bank_transfer_sweep_list_request.rb +2 -30
  102. data/lib/plaid/models/bank_transfer_sweep_list_response.rb +1 -1
  103. data/lib/plaid/models/bank_transfer_type.rb +1 -1
  104. data/lib/plaid/models/bank_transfer_user.rb +1 -1
  105. data/lib/plaid/models/bank_transfers_events_update_webhook.rb +1 -1
  106. data/lib/plaid/models/categories_get_response.rb +1 -1
  107. data/lib/plaid/models/category.rb +1 -1
  108. data/lib/plaid/models/cause.rb +1 -1
  109. data/lib/plaid/models/connected_application.rb +1 -1
  110. data/lib/plaid/models/country_code.rb +2 -1
  111. data/lib/plaid/models/credit_card_liability.rb +17 -2
  112. data/lib/plaid/models/credit_filter.rb +1 -1
  113. data/lib/plaid/models/customer_initiated_return_risk.rb +1 -1
  114. data/lib/plaid/models/deductions.rb +35 -5
  115. data/lib/plaid/models/deductions_breakdown.rb +265 -0
  116. data/lib/plaid/models/deductions_total.rb +254 -0
  117. data/lib/plaid/models/default_update_webhook.rb +1 -1
  118. data/lib/plaid/models/deposit_switch_address_data.rb +1 -1
  119. data/lib/plaid/models/deposit_switch_alt_create_request.rb +1 -1
  120. data/lib/plaid/models/deposit_switch_alt_create_response.rb +1 -1
  121. data/lib/plaid/models/deposit_switch_create_request.rb +1 -1
  122. data/lib/plaid/models/deposit_switch_create_request_options.rb +1 -1
  123. data/lib/plaid/models/deposit_switch_create_response.rb +1 -1
  124. data/lib/plaid/models/deposit_switch_get_request.rb +1 -1
  125. data/lib/plaid/models/deposit_switch_get_response.rb +1 -1
  126. data/lib/plaid/models/deposit_switch_state_update_webhook.rb +1 -1
  127. data/lib/plaid/models/deposit_switch_target_account.rb +1 -1
  128. data/lib/plaid/models/deposit_switch_target_user.rb +1 -1
  129. data/lib/plaid/models/deposit_switch_token_create_request.rb +1 -1
  130. data/lib/plaid/models/deposit_switch_token_create_response.rb +1 -1
  131. data/lib/plaid/models/depository_filter.rb +1 -1
  132. data/lib/plaid/models/distribution_breakdown.rb +296 -0
  133. data/lib/plaid/models/doc_type.rb +45 -0
  134. data/lib/plaid/models/document_metadata.rb +14 -5
  135. data/lib/plaid/models/earnings.rb +25 -5
  136. data/lib/plaid/models/earnings_breakdown.rb +297 -0
  137. data/lib/plaid/models/earnings_breakdown_canonical_description.rb +45 -0
  138. data/lib/plaid/models/earnings_total.rb +46 -67
  139. data/lib/plaid/models/email.rb +1 -1
  140. data/lib/plaid/models/employee.rb +11 -11
  141. data/lib/plaid/models/employee_income_summary_field_string.rb +1 -1
  142. data/lib/plaid/models/employer.rb +1 -1
  143. data/lib/plaid/models/employer_income_summary_field_string.rb +1 -1
  144. data/lib/plaid/models/{income_verification_documents_download_response.rb → employer_verification.rb} +14 -17
  145. data/lib/plaid/models/employers_search_request.rb +1 -1
  146. data/lib/plaid/models/employers_search_response.rb +1 -1
  147. data/lib/plaid/models/employment_details.rb +1 -1
  148. data/lib/plaid/models/employment_verification.rb +271 -0
  149. data/lib/plaid/models/employment_verification_get_request.rb +245 -0
  150. data/lib/plaid/models/employment_verification_get_response.rb +252 -0
  151. data/lib/plaid/models/employment_verification_status.rb +40 -0
  152. data/lib/plaid/models/error.rb +3 -3
  153. data/lib/plaid/models/external_payment_options.rb +1 -1
  154. data/lib/plaid/models/external_payment_refund_details.rb +1 -1
  155. data/lib/plaid/models/external_payment_schedule_base.rb +1 -1
  156. data/lib/plaid/models/external_payment_schedule_get.rb +1 -1
  157. data/lib/plaid/models/external_payment_schedule_request.rb +1 -1
  158. data/lib/plaid/models/health_incident.rb +1 -1
  159. data/lib/plaid/models/historical_balance.rb +1 -1
  160. data/lib/plaid/models/historical_update_webhook.rb +1 -1
  161. data/lib/plaid/models/holding.rb +1 -1
  162. data/lib/plaid/models/holdings_default_update_webhook.rb +1 -1
  163. data/lib/plaid/models/holdings_override.rb +1 -1
  164. data/lib/plaid/models/identity_get_request.rb +1 -1
  165. data/lib/plaid/models/identity_get_request_options.rb +1 -1
  166. data/lib/plaid/models/identity_get_response.rb +1 -1
  167. data/lib/plaid/models/incident_update.rb +1 -1
  168. data/lib/plaid/models/income_breakdown.rb +2 -37
  169. data/lib/plaid/models/income_breakdown_type.rb +41 -0
  170. data/lib/plaid/models/income_override.rb +1 -1
  171. data/lib/plaid/models/income_summary.rb +1 -1
  172. data/lib/plaid/models/income_summary_field_number.rb +1 -1
  173. data/lib/plaid/models/income_summary_field_string.rb +1 -1
  174. data/lib/plaid/models/income_verification_create_request.rb +24 -5
  175. data/lib/plaid/models/income_verification_create_request_options.rb +222 -0
  176. data/lib/plaid/models/income_verification_create_response.rb +1 -1
  177. data/lib/plaid/models/income_verification_documents_download_request.rb +17 -6
  178. data/lib/plaid/models/income_verification_paystub_get_request.rb +1 -1
  179. data/lib/plaid/models/income_verification_paystub_get_response.rb +1 -1
  180. data/lib/plaid/models/income_verification_paystubs_get_request.rb +1 -1
  181. data/lib/plaid/models/income_verification_paystubs_get_response.rb +13 -13
  182. data/lib/plaid/models/income_verification_precheck_confidence.rb +40 -0
  183. data/lib/plaid/models/income_verification_precheck_employer.rb +27 -6
  184. data/lib/plaid/models/income_verification_precheck_employer_address.rb +280 -0
  185. data/lib/plaid/models/income_verification_precheck_military_info.rb +1 -1
  186. data/lib/plaid/models/income_verification_precheck_request.rb +14 -2
  187. data/lib/plaid/models/income_verification_precheck_response.rb +2 -37
  188. data/lib/plaid/models/income_verification_precheck_user.rb +1 -1
  189. data/lib/plaid/models/income_verification_refresh_request.rb +1 -1
  190. data/lib/plaid/models/income_verification_refresh_response.rb +1 -1
  191. data/lib/plaid/models/income_verification_status_webhook.rb +18 -3
  192. data/lib/plaid/models/income_verification_summary_get_request.rb +1 -1
  193. data/lib/plaid/models/income_verification_summary_get_response.rb +1 -1
  194. data/lib/plaid/models/income_verification_taxforms_get_request.rb +1 -1
  195. data/lib/plaid/models/income_verification_taxforms_get_response.rb +18 -18
  196. data/lib/plaid/models/income_verification_webhook_status.rb +1 -1
  197. data/lib/plaid/models/inflow_model.rb +1 -1
  198. data/lib/plaid/models/initial_update_webhook.rb +1 -1
  199. data/lib/plaid/models/institution.rb +1 -1
  200. data/lib/plaid/models/institution_status.rb +1 -1
  201. data/lib/plaid/models/institutions_get_by_id_request.rb +1 -1
  202. data/lib/plaid/models/institutions_get_by_id_request_options.rb +1 -1
  203. data/lib/plaid/models/institutions_get_by_id_response.rb +1 -1
  204. data/lib/plaid/models/institutions_get_request.rb +1 -1
  205. data/lib/plaid/models/institutions_get_request_options.rb +1 -1
  206. data/lib/plaid/models/institutions_get_response.rb +1 -1
  207. data/lib/plaid/models/institutions_search_account_filter.rb +1 -1
  208. data/lib/plaid/models/institutions_search_payment_initiation_options.rb +1 -1
  209. data/lib/plaid/models/institutions_search_request.rb +1 -1
  210. data/lib/plaid/models/institutions_search_request_options.rb +1 -1
  211. data/lib/plaid/models/institutions_search_response.rb +1 -1
  212. data/lib/plaid/models/investment_filter.rb +1 -1
  213. data/lib/plaid/models/investment_holdings_get_request_options.rb +1 -1
  214. data/lib/plaid/models/investment_transaction.rb +1 -1
  215. data/lib/plaid/models/investments_default_update_webhook.rb +1 -1
  216. data/lib/plaid/models/investments_holdings_get_request.rb +1 -1
  217. data/lib/plaid/models/investments_holdings_get_response.rb +1 -1
  218. data/lib/plaid/models/investments_transactions_get_request.rb +1 -1
  219. data/lib/plaid/models/investments_transactions_get_request_options.rb +1 -1
  220. data/lib/plaid/models/investments_transactions_get_response.rb +1 -1
  221. data/lib/plaid/models/investments_transactions_override.rb +1 -1
  222. data/lib/plaid/models/item.rb +14 -2
  223. data/lib/plaid/models/item_access_token_invalidate_request.rb +1 -1
  224. data/lib/plaid/models/item_access_token_invalidate_response.rb +1 -1
  225. data/lib/plaid/models/item_application_list_request.rb +1 -1
  226. data/lib/plaid/models/item_application_list_response.rb +1 -1
  227. data/lib/plaid/models/item_application_list_user_auth.rb +1 -1
  228. data/lib/plaid/models/item_application_scopes_update_request.rb +1 -1
  229. data/lib/plaid/models/item_application_scopes_update_response.rb +1 -1
  230. data/lib/plaid/models/item_error_webhook.rb +1 -1
  231. data/lib/plaid/models/item_get_request.rb +1 -1
  232. data/lib/plaid/models/item_get_response.rb +1 -1
  233. data/lib/plaid/models/item_import_request.rb +1 -1
  234. data/lib/plaid/models/item_import_request_options.rb +1 -1
  235. data/lib/plaid/models/item_import_request_user_auth.rb +1 -1
  236. data/lib/plaid/models/item_import_response.rb +1 -1
  237. data/lib/plaid/models/item_product_ready_webhook.rb +1 -1
  238. data/lib/plaid/models/item_public_token_create_request.rb +1 -1
  239. data/lib/plaid/models/item_public_token_create_response.rb +1 -1
  240. data/lib/plaid/models/item_public_token_exchange_request.rb +1 -1
  241. data/lib/plaid/models/item_public_token_exchange_response.rb +1 -1
  242. data/lib/plaid/models/item_remove_request.rb +1 -1
  243. data/lib/plaid/models/item_remove_response.rb +1 -1
  244. data/lib/plaid/models/item_status.rb +1 -1
  245. data/lib/plaid/models/item_status_investments.rb +1 -1
  246. data/lib/plaid/models/item_status_last_webhook.rb +1 -1
  247. data/lib/plaid/models/item_status_nullable.rb +1 -1
  248. data/lib/plaid/models/item_status_transactions.rb +1 -1
  249. data/lib/plaid/models/item_webhook_update_request.rb +1 -1
  250. data/lib/plaid/models/item_webhook_update_response.rb +1 -1
  251. data/lib/plaid/models/jwk_public_key.rb +1 -1
  252. data/lib/plaid/models/jwt_header.rb +1 -1
  253. data/lib/plaid/models/liabilities_default_update_webhook.rb +1 -1
  254. data/lib/plaid/models/liabilities_get_request.rb +1 -1
  255. data/lib/plaid/models/liabilities_get_request_options.rb +1 -1
  256. data/lib/plaid/models/liabilities_get_response.rb +1 -1
  257. data/lib/plaid/models/liabilities_object.rb +1 -1
  258. data/lib/plaid/models/liability_override.rb +1 -1
  259. data/lib/plaid/models/link_token_account_filters.rb +1 -1
  260. data/lib/plaid/models/link_token_create_request.rb +2 -2
  261. data/lib/plaid/models/link_token_create_request_account_subtypes.rb +1 -1
  262. data/lib/plaid/models/link_token_create_request_auth.rb +1 -1
  263. data/lib/plaid/models/link_token_create_request_deposit_switch.rb +1 -1
  264. data/lib/plaid/models/link_token_create_request_income_verification.rb +27 -10
  265. data/lib/plaid/models/link_token_create_request_payment_initiation.rb +1 -1
  266. data/lib/plaid/models/link_token_create_request_update.rb +1 -1
  267. data/lib/plaid/models/link_token_create_request_user.rb +1 -1
  268. data/lib/plaid/models/link_token_create_response.rb +1 -1
  269. data/lib/plaid/models/link_token_eu_config.rb +1 -1
  270. data/lib/plaid/models/link_token_get_metadata_response.rb +1 -1
  271. data/lib/plaid/models/link_token_get_request.rb +1 -1
  272. data/lib/plaid/models/link_token_get_response.rb +1 -1
  273. data/lib/plaid/models/loan_filter.rb +1 -1
  274. data/lib/plaid/models/location.rb +1 -1
  275. data/lib/plaid/models/meta.rb +1 -1
  276. data/lib/plaid/models/mfa.rb +1 -1
  277. data/lib/plaid/models/mortgage_interest_rate.rb +1 -1
  278. data/lib/plaid/models/mortgage_liability.rb +1 -1
  279. data/lib/plaid/models/mortgage_property_address.rb +1 -1
  280. data/lib/plaid/models/net_pay.rb +54 -10
  281. data/lib/plaid/models/new_accounts_available_webhook.rb +1 -1
  282. data/lib/plaid/models/numbers.rb +1 -1
  283. data/lib/plaid/models/numbers_ach.rb +2 -2
  284. data/lib/plaid/models/numbers_ach_nullable.rb +2 -2
  285. data/lib/plaid/models/numbers_bacs.rb +1 -1
  286. data/lib/plaid/models/numbers_bacs_nullable.rb +1 -1
  287. data/lib/plaid/models/numbers_eft.rb +1 -1
  288. data/lib/plaid/models/numbers_eft_nullable.rb +1 -1
  289. data/lib/plaid/models/numbers_international.rb +1 -1
  290. data/lib/plaid/models/numbers_international_nullable.rb +1 -1
  291. data/lib/plaid/models/override_account_type.rb +1 -1
  292. data/lib/plaid/models/override_accounts.rb +1 -1
  293. data/lib/plaid/models/owner.rb +1 -1
  294. data/lib/plaid/models/owner_override.rb +1 -1
  295. data/lib/plaid/models/pay.rb +1 -1
  296. data/lib/plaid/models/pay_frequency.rb +2 -37
  297. data/lib/plaid/models/pay_frequency_value.rb +43 -0
  298. data/lib/plaid/models/pay_period_details.rb +95 -28
  299. data/lib/plaid/models/payment_amount.rb +1 -1
  300. data/lib/plaid/models/payment_initiation_address.rb +1 -1
  301. data/lib/plaid/models/payment_initiation_metadata.rb +1 -1
  302. data/lib/plaid/models/payment_initiation_optional_restriction_bacs.rb +1 -1
  303. data/lib/plaid/models/payment_initiation_payment.rb +1 -1
  304. data/lib/plaid/models/payment_initiation_payment_create_request.rb +1 -1
  305. data/lib/plaid/models/payment_initiation_payment_create_response.rb +1 -1
  306. data/lib/plaid/models/payment_initiation_payment_get_request.rb +1 -1
  307. data/lib/plaid/models/payment_initiation_payment_get_response.rb +1 -1
  308. data/lib/plaid/models/payment_initiation_payment_list_request.rb +1 -1
  309. data/lib/plaid/models/payment_initiation_payment_list_response.rb +1 -1
  310. data/lib/plaid/models/payment_initiation_payment_reverse_request.rb +1 -1
  311. data/lib/plaid/models/payment_initiation_payment_reverse_response.rb +1 -1
  312. data/lib/plaid/models/payment_initiation_payment_token_create_request.rb +1 -1
  313. data/lib/plaid/models/payment_initiation_payment_token_create_response.rb +1 -1
  314. data/lib/plaid/models/payment_initiation_recipient.rb +1 -1
  315. data/lib/plaid/models/payment_initiation_recipient_create_request.rb +1 -1
  316. data/lib/plaid/models/payment_initiation_recipient_create_response.rb +1 -1
  317. data/lib/plaid/models/payment_initiation_recipient_get_request.rb +1 -1
  318. data/lib/plaid/models/payment_initiation_recipient_get_response.rb +1 -1
  319. data/lib/plaid/models/payment_initiation_recipient_get_response_all_of.rb +1 -1
  320. data/lib/plaid/models/payment_initiation_recipient_list_request.rb +1 -1
  321. data/lib/plaid/models/payment_initiation_recipient_list_response.rb +1 -1
  322. data/lib/plaid/models/payment_initiation_refund.rb +1 -1
  323. data/lib/plaid/models/payment_initiation_standing_order_metadata.rb +1 -1
  324. data/lib/plaid/models/payment_meta.rb +1 -1
  325. data/lib/plaid/models/payment_schedule_interval.rb +1 -1
  326. data/lib/plaid/models/payment_status_update_webhook.rb +1 -1
  327. data/lib/plaid/models/paystub.rb +45 -25
  328. data/lib/plaid/models/paystub_address.rb +40 -40
  329. data/lib/plaid/models/paystub_deduction.rb +1 -1
  330. data/lib/plaid/models/paystub_details.rb +2 -37
  331. data/lib/plaid/models/paystub_employer.rb +15 -15
  332. data/lib/plaid/models/paystub_override.rb +1 -1
  333. data/lib/plaid/models/paystub_override_employee.rb +1 -1
  334. data/lib/plaid/models/paystub_override_employee_address.rb +1 -1
  335. data/lib/plaid/models/paystub_override_employer.rb +1 -1
  336. data/lib/plaid/models/paystub_pay_frequency.rb +42 -0
  337. data/lib/plaid/models/{distribution_details.rb → paystub_verification.rb} +21 -53
  338. data/lib/plaid/models/paystub_verification_status.rb +41 -0
  339. data/lib/plaid/models/paystub_ytd_details.rb +1 -1
  340. data/lib/plaid/models/pending_expiration_webhook.rb +1 -1
  341. data/lib/plaid/models/personal_finance_category.rb +1 -1
  342. data/lib/plaid/models/phone_number.rb +1 -1
  343. data/lib/plaid/models/platform_ids.rb +243 -0
  344. data/lib/plaid/models/processor_apex_processor_token_create_request.rb +1 -1
  345. data/lib/plaid/models/processor_auth_get_request.rb +1 -1
  346. data/lib/plaid/models/processor_auth_get_response.rb +1 -1
  347. data/lib/plaid/models/processor_balance_get_request.rb +1 -1
  348. data/lib/plaid/models/processor_balance_get_request_options.rb +1 -1
  349. data/lib/plaid/models/processor_balance_get_response.rb +1 -1
  350. data/lib/plaid/models/processor_bank_transfer_create_request.rb +1 -1
  351. data/lib/plaid/models/processor_bank_transfer_create_response.rb +1 -1
  352. data/lib/plaid/models/processor_identity_get_request.rb +1 -1
  353. data/lib/plaid/models/processor_identity_get_response.rb +1 -1
  354. data/lib/plaid/models/processor_number.rb +1 -1
  355. data/lib/plaid/models/processor_stripe_bank_account_token_create_request.rb +1 -1
  356. data/lib/plaid/models/processor_stripe_bank_account_token_create_response.rb +1 -1
  357. data/lib/plaid/models/processor_token_create_request.rb +1 -1
  358. data/lib/plaid/models/processor_token_create_response.rb +1 -1
  359. data/lib/plaid/models/product_access.rb +5 -5
  360. data/lib/plaid/models/product_status.rb +2 -2
  361. data/lib/plaid/models/product_status_breakdown.rb +1 -1
  362. data/lib/plaid/models/products.rb +2 -1
  363. data/lib/plaid/models/projected_income_summary_field_number.rb +1 -1
  364. data/lib/plaid/models/pslf_status.rb +1 -1
  365. data/lib/plaid/models/recaptcha_required_error.rb +1 -1
  366. data/lib/plaid/models/recipient_bacs.rb +1 -1
  367. data/lib/plaid/models/recipient_bacs_nullable.rb +1 -1
  368. data/lib/plaid/models/recurring_transaction_frequency.rb +1 -1
  369. data/lib/plaid/models/removed_transaction.rb +220 -0
  370. data/lib/plaid/models/requested_scopes.rb +1 -1
  371. data/lib/plaid/models/sandbox_bank_transfer_fire_webhook_request.rb +1 -1
  372. data/lib/plaid/models/sandbox_bank_transfer_fire_webhook_response.rb +1 -1
  373. data/lib/plaid/models/sandbox_bank_transfer_simulate_request.rb +1 -1
  374. data/lib/plaid/models/sandbox_bank_transfer_simulate_response.rb +1 -1
  375. data/lib/plaid/models/sandbox_income_fire_webhook_request.rb +17 -2
  376. data/lib/plaid/models/sandbox_income_fire_webhook_response.rb +1 -1
  377. data/lib/plaid/models/sandbox_item_fire_webhook_request.rb +1 -1
  378. data/lib/plaid/models/sandbox_item_fire_webhook_response.rb +1 -1
  379. data/lib/plaid/models/sandbox_item_reset_login_request.rb +1 -1
  380. data/lib/plaid/models/sandbox_item_reset_login_response.rb +1 -1
  381. data/lib/plaid/models/sandbox_item_set_verification_status_request.rb +1 -1
  382. data/lib/plaid/models/sandbox_item_set_verification_status_response.rb +1 -1
  383. data/lib/plaid/models/sandbox_oauth_select_accounts_request.rb +1 -1
  384. data/lib/plaid/models/sandbox_processor_token_create_request.rb +1 -1
  385. data/lib/plaid/models/sandbox_processor_token_create_request_options.rb +1 -1
  386. data/lib/plaid/models/sandbox_processor_token_create_response.rb +1 -1
  387. data/lib/plaid/models/sandbox_public_token_create_request.rb +1 -1
  388. data/lib/plaid/models/sandbox_public_token_create_request_options.rb +1 -1
  389. data/lib/plaid/models/sandbox_public_token_create_request_options_transactions.rb +2 -2
  390. data/lib/plaid/models/sandbox_public_token_create_response.rb +1 -1
  391. data/lib/plaid/models/sandbox_transfer_simulate_request.rb +1 -1
  392. data/lib/plaid/models/sandbox_transfer_simulate_response.rb +1 -1
  393. data/lib/plaid/models/scopes.rb +1 -1
  394. data/lib/plaid/models/scopes_context.rb +1 -1
  395. data/lib/plaid/models/scopes_nullable.rb +1 -1
  396. data/lib/plaid/models/security.rb +1 -1
  397. data/lib/plaid/models/security_override.rb +1 -1
  398. data/lib/plaid/models/sender_bacs_nullable.rb +1 -1
  399. data/lib/plaid/models/servicer_address_data.rb +1 -1
  400. data/lib/plaid/models/signal_address_data.rb +1 -1
  401. data/lib/plaid/models/signal_decision_report_request.rb +63 -5
  402. data/lib/plaid/models/signal_decision_report_response.rb +1 -1
  403. data/lib/plaid/models/signal_device.rb +1 -1
  404. data/lib/plaid/models/signal_evaluate_core_attributes.rb +2 -2
  405. data/lib/plaid/models/signal_evaluate_request.rb +22 -2
  406. data/lib/plaid/models/signal_evaluate_response.rb +1 -6
  407. data/lib/plaid/models/signal_person_name.rb +1 -1
  408. data/lib/plaid/models/signal_return_report_request.rb +31 -1
  409. data/lib/plaid/models/signal_return_report_response.rb +1 -1
  410. data/lib/plaid/models/signal_scores.rb +1 -1
  411. data/lib/plaid/models/signal_user.rb +1 -1
  412. data/lib/plaid/models/standalone_account_type.rb +1 -1
  413. data/lib/plaid/models/standalone_currency_code_list.rb +1 -1
  414. data/lib/plaid/models/standalone_investment_transaction_type.rb +1 -1
  415. data/lib/plaid/models/student_loan.rb +1 -1
  416. data/lib/plaid/models/student_loan_repayment_model.rb +1 -1
  417. data/lib/plaid/models/student_loan_status.rb +1 -1
  418. data/lib/plaid/models/student_repayment_plan.rb +1 -1
  419. data/lib/plaid/models/taxform.rb +12 -2
  420. data/lib/plaid/models/taxpayer_id.rb +14 -2
  421. data/lib/plaid/models/total.rb +2 -37
  422. data/lib/plaid/models/total_canonical_description.rb +54 -0
  423. data/lib/plaid/models/transaction.rb +23 -23
  424. data/lib/plaid/models/transaction_all_of.rb +2 -24
  425. data/lib/plaid/models/transaction_base.rb +27 -5
  426. data/lib/plaid/models/transaction_code.rb +1 -1
  427. data/lib/plaid/models/transaction_data.rb +1 -1
  428. data/lib/plaid/models/transaction_override.rb +3 -3
  429. data/lib/plaid/models/transaction_stream.rb +1 -1
  430. data/lib/plaid/models/transaction_stream_amount.rb +1 -1
  431. data/lib/plaid/models/transactions_get_request.rb +1 -1
  432. data/lib/plaid/models/transactions_get_request_options.rb +1 -1
  433. data/lib/plaid/models/transactions_get_response.rb +1 -1
  434. data/lib/plaid/models/transactions_recurring_get_request.rb +11 -1
  435. data/lib/plaid/models/transactions_recurring_get_response.rb +6 -1
  436. data/lib/plaid/models/transactions_refresh_request.rb +1 -1
  437. data/lib/plaid/models/transactions_refresh_response.rb +1 -1
  438. data/lib/plaid/models/transactions_removed_webhook.rb +1 -1
  439. data/lib/plaid/models/transactions_sync_request.rb +293 -0
  440. data/lib/plaid/models/transactions_sync_response.rb +291 -0
  441. data/lib/plaid/models/transfer.rb +1 -1
  442. data/lib/plaid/models/transfer_authorization.rb +1 -1
  443. data/lib/plaid/models/transfer_authorization_create_request.rb +1 -1
  444. data/lib/plaid/models/transfer_authorization_create_response.rb +1 -1
  445. data/lib/plaid/models/transfer_authorization_decision_rationale.rb +1 -1
  446. data/lib/plaid/models/transfer_authorization_device.rb +1 -1
  447. data/lib/plaid/models/transfer_authorization_proposed_transfer.rb +1 -1
  448. data/lib/plaid/models/transfer_cancel_request.rb +1 -1
  449. data/lib/plaid/models/transfer_cancel_response.rb +1 -1
  450. data/lib/plaid/models/transfer_create_request.rb +1 -1
  451. data/lib/plaid/models/transfer_create_response.rb +1 -1
  452. data/lib/plaid/models/transfer_event.rb +1 -1
  453. data/lib/plaid/models/transfer_event_list_request.rb +1 -1
  454. data/lib/plaid/models/transfer_event_list_response.rb +1 -1
  455. data/lib/plaid/models/transfer_event_sync_request.rb +1 -1
  456. data/lib/plaid/models/transfer_event_sync_response.rb +1 -1
  457. data/lib/plaid/models/transfer_event_type.rb +1 -1
  458. data/lib/plaid/models/transfer_failure.rb +1 -1
  459. data/lib/plaid/models/transfer_get_request.rb +1 -1
  460. data/lib/plaid/models/transfer_get_response.rb +1 -1
  461. data/lib/plaid/models/transfer_list_request.rb +1 -1
  462. data/lib/plaid/models/transfer_list_response.rb +1 -1
  463. data/lib/plaid/models/transfer_network.rb +1 -1
  464. data/lib/plaid/models/transfer_status.rb +1 -1
  465. data/lib/plaid/models/transfer_type.rb +1 -1
  466. data/lib/plaid/models/transfer_user_address_in_request.rb +1 -1
  467. data/lib/plaid/models/transfer_user_address_in_response.rb +1 -1
  468. data/lib/plaid/models/transfer_user_in_request.rb +1 -1
  469. data/lib/plaid/models/transfer_user_in_response.rb +1 -1
  470. data/lib/plaid/models/user_custom_password.rb +1 -1
  471. data/lib/plaid/models/user_permission_revoked_webhook.rb +1 -1
  472. data/lib/plaid/models/verification_attribute.rb +255 -0
  473. data/lib/plaid/models/verification_expired_webhook.rb +2 -2
  474. data/lib/plaid/models/verification_refresh_status.rb +1 -1
  475. data/lib/plaid/models/verification_status.rb +1 -1
  476. data/lib/plaid/models/w2.rb +1 -1
  477. data/lib/plaid/models/w2_box12.rb +1 -1
  478. data/lib/plaid/models/w2_state_and_local_wages.rb +1 -1
  479. data/lib/plaid/models/warning.rb +1 -1
  480. data/lib/plaid/models/webhook_update_acknowledged_webhook.rb +1 -1
  481. data/lib/plaid/models/webhook_verification_key_get_request.rb +1 -1
  482. data/lib/plaid/models/webhook_verification_key_get_response.rb +1 -1
  483. data/lib/plaid/models/ytd_gross_income_summary_field_number.rb +1 -1
  484. data/lib/plaid/models/ytd_net_income_summary_field_number.rb +1 -1
  485. data/lib/plaid/version.rb +2 -2
  486. data/lib/plaid.rb +28 -3
  487. data/pkg/plaid-14.8.0.gem +0 -0
  488. data/plaid.gemspec +1 -1
  489. data/templates/ruby/configuration.mustache +2 -2
  490. metadata +33 -240
  491. data/doc/rdoc/apple-touch-icon.png +0 -0
  492. data/doc/rdoc/classes/Object.html +0 -118
  493. data/doc/rdoc/classes/Plaid/APIError.html +0 -97
  494. data/doc/rdoc/classes/Plaid/AccessToken/InvalidateResponse.html +0 -110
  495. data/doc/rdoc/classes/Plaid/AccessToken/UpdateVersionResponse.html +0 -118
  496. data/doc/rdoc/classes/Plaid/AccessToken.html +0 -211
  497. data/doc/rdoc/classes/Plaid/Accounts.html +0 -257
  498. data/doc/rdoc/classes/Plaid/AccountsResponse.html +0 -119
  499. data/doc/rdoc/classes/Plaid/AddToken/CreateResponse.html +0 -118
  500. data/doc/rdoc/classes/Plaid/AddToken.html +0 -197
  501. data/doc/rdoc/classes/Plaid/Apex/ProcessorToken.html +0 -205
  502. data/doc/rdoc/classes/Plaid/Apex.html +0 -149
  503. data/doc/rdoc/classes/Plaid/AssetReport.html +0 -683
  504. data/doc/rdoc/classes/Plaid/AssetReportCreateResponse.html +0 -118
  505. data/doc/rdoc/classes/Plaid/AssetReportFilterResponse.html +0 -96
  506. data/doc/rdoc/classes/Plaid/AssetReportGetResponse.html +0 -118
  507. data/doc/rdoc/classes/Plaid/AssetReportRefreshResponse.html +0 -96
  508. data/doc/rdoc/classes/Plaid/AssetReportRemoveResponse.html +0 -110
  509. data/doc/rdoc/classes/Plaid/AuditCopyCreateResponse.html +0 -110
  510. data/doc/rdoc/classes/Plaid/AuditCopyGetResponse.html +0 -96
  511. data/doc/rdoc/classes/Plaid/AuditCopyRemoveResponse.html +0 -110
  512. data/doc/rdoc/classes/Plaid/Auth.html +0 -206
  513. data/doc/rdoc/classes/Plaid/AuthResponse.html +0 -127
  514. data/doc/rdoc/classes/Plaid/Balance.html +0 -206
  515. data/doc/rdoc/classes/Plaid/BaseProduct.html +0 -304
  516. data/doc/rdoc/classes/Plaid/Categories.html +0 -191
  517. data/doc/rdoc/classes/Plaid/CategoriesResponse.html +0 -111
  518. data/doc/rdoc/classes/Plaid/Client.html +0 -802
  519. data/doc/rdoc/classes/Plaid/CreateResponse.html +0 -118
  520. data/doc/rdoc/classes/Plaid/CreditDetails.html +0 -203
  521. data/doc/rdoc/classes/Plaid/CreditDetailsResponse.html +0 -128
  522. data/doc/rdoc/classes/Plaid/DepositSwitch/CreateResponse.html +0 -110
  523. data/doc/rdoc/classes/Plaid/DepositSwitch/CreateTokenResponse.html +0 -118
  524. data/doc/rdoc/classes/Plaid/DepositSwitch/GetResponse.html +0 -150
  525. data/doc/rdoc/classes/Plaid/DepositSwitch.html +0 -339
  526. data/doc/rdoc/classes/Plaid/Dwolla/ProcessorToken.html +0 -205
  527. data/doc/rdoc/classes/Plaid/Dwolla.html +0 -150
  528. data/doc/rdoc/classes/Plaid/Error.html +0 -214
  529. data/doc/rdoc/classes/Plaid/GetResponse.html +0 -134
  530. data/doc/rdoc/classes/Plaid/Holdings/GetResponse.html +0 -137
  531. data/doc/rdoc/classes/Plaid/Holdings.html +0 -218
  532. data/doc/rdoc/classes/Plaid/Identity.html +0 -199
  533. data/doc/rdoc/classes/Plaid/IdentityResponse.html +0 -119
  534. data/doc/rdoc/classes/Plaid/Income.html +0 -198
  535. data/doc/rdoc/classes/Plaid/IncomeResponse.html +0 -119
  536. data/doc/rdoc/classes/Plaid/InstitutionError.html +0 -96
  537. data/doc/rdoc/classes/Plaid/Institutions.html +0 -356
  538. data/doc/rdoc/classes/Plaid/InvalidInputError.html +0 -97
  539. data/doc/rdoc/classes/Plaid/InvalidRequestError.html +0 -96
  540. data/doc/rdoc/classes/Plaid/InvestmentTransactions/GetResponse.html +0 -145
  541. data/doc/rdoc/classes/Plaid/InvestmentTransactions.html +0 -240
  542. data/doc/rdoc/classes/Plaid/Investments.html +0 -204
  543. data/doc/rdoc/classes/Plaid/Item/GetResponse.html +0 -119
  544. data/doc/rdoc/classes/Plaid/Item/ImportResponse.html +0 -110
  545. data/doc/rdoc/classes/Plaid/Item/RemoveResponse.html +0 -110
  546. data/doc/rdoc/classes/Plaid/Item.html +0 -382
  547. data/doc/rdoc/classes/Plaid/ItemError.html +0 -98
  548. data/doc/rdoc/classes/Plaid/Liabilities.html +0 -202
  549. data/doc/rdoc/classes/Plaid/LiabilitiesResponse.html +0 -128
  550. data/doc/rdoc/classes/Plaid/LinkToken.html +0 -215
  551. data/doc/rdoc/classes/Plaid/Middleware.html +0 -225
  552. data/doc/rdoc/classes/Plaid/Models/Account.html +0 -166
  553. data/doc/rdoc/classes/Plaid/Models/AccountWithOwners.html +0 -110
  554. data/doc/rdoc/classes/Plaid/Models/AssetReport.html +0 -153
  555. data/doc/rdoc/classes/Plaid/Models/AssetReportAccount.html +0 -198
  556. data/doc/rdoc/classes/Plaid/Models/AssetReportBalance.html +0 -142
  557. data/doc/rdoc/classes/Plaid/Models/AssetReportHistoricalBalance.html +0 -142
  558. data/doc/rdoc/classes/Plaid/Models/AssetReportItem.html +0 -145
  559. data/doc/rdoc/classes/Plaid/Models/AssetReportOwner.html +0 -139
  560. data/doc/rdoc/classes/Plaid/Models/AssetReportTransaction.html +0 -187
  561. data/doc/rdoc/classes/Plaid/Models/AssetReportUser.html +0 -159
  562. data/doc/rdoc/classes/Plaid/Models/Balances.html +0 -142
  563. data/doc/rdoc/classes/Plaid/Models/BaseError.html +0 -140
  564. data/doc/rdoc/classes/Plaid/Models/BaseModel.html +0 -259
  565. data/doc/rdoc/classes/Plaid/Models/BaseResponse.html +0 -110
  566. data/doc/rdoc/classes/Plaid/Models/Category.html +0 -127
  567. data/doc/rdoc/classes/Plaid/Models/Cause.html +0 -110
  568. data/doc/rdoc/classes/Plaid/Models/CreditCardLiability.html +0 -175
  569. data/doc/rdoc/classes/Plaid/Models/CreditCardLiabilityAPRs.html +0 -137
  570. data/doc/rdoc/classes/Plaid/Models/CreditDetails.html +0 -166
  571. data/doc/rdoc/classes/Plaid/Models/CreditDetailsAPR.html +0 -126
  572. data/doc/rdoc/classes/Plaid/Models/CreditDetailsAPRs.html +0 -126
  573. data/doc/rdoc/classes/Plaid/Models/Error.html +0 -110
  574. data/doc/rdoc/classes/Plaid/Models/Holding.html +0 -181
  575. data/doc/rdoc/classes/Plaid/Models/Identity.html +0 -135
  576. data/doc/rdoc/classes/Plaid/Models/IdentityAddress.html +0 -118
  577. data/doc/rdoc/classes/Plaid/Models/IdentityAddressData.html +0 -142
  578. data/doc/rdoc/classes/Plaid/Models/IdentityEmail.html +0 -127
  579. data/doc/rdoc/classes/Plaid/Models/IdentityPhoneNumber.html +0 -126
  580. data/doc/rdoc/classes/Plaid/Models/Income.html +0 -173
  581. data/doc/rdoc/classes/Plaid/Models/IncomeStream.html +0 -136
  582. data/doc/rdoc/classes/Plaid/Models/Institution.html +0 -230
  583. data/doc/rdoc/classes/Plaid/Models/InstitutionCredential.html +0 -126
  584. data/doc/rdoc/classes/Plaid/Models/InstitutionPaymentInitiationMetadata.html +0 -136
  585. data/doc/rdoc/classes/Plaid/Models/InstitutionStatus.html +0 -111
  586. data/doc/rdoc/classes/Plaid/Models/InstitutionStatusBreakdown.html +0 -129
  587. data/doc/rdoc/classes/Plaid/Models/InstitutionStatusItemLogins.html +0 -127
  588. data/doc/rdoc/classes/Plaid/Models/InvestmentTransaction.html +0 -224
  589. data/doc/rdoc/classes/Plaid/Models/Item.html +0 -169
  590. data/doc/rdoc/classes/Plaid/Models/ItemStatus.html +0 -129
  591. data/doc/rdoc/classes/Plaid/Models/ItemStatusInvestments.html +0 -119
  592. data/doc/rdoc/classes/Plaid/Models/ItemStatusLastWebhook.html +0 -118
  593. data/doc/rdoc/classes/Plaid/Models/ItemStatusTransactions.html +0 -119
  594. data/doc/rdoc/classes/Plaid/Models/Liabilities.html +0 -130
  595. data/doc/rdoc/classes/Plaid/Models/LinkTokenMetadata.html +0 -158
  596. data/doc/rdoc/classes/Plaid/Models/MFA/Device.html +0 -110
  597. data/doc/rdoc/classes/Plaid/Models/MFA/DeviceListElement.html +0 -126
  598. data/doc/rdoc/classes/Plaid/Models/MFA/Selection.html +0 -118
  599. data/doc/rdoc/classes/Plaid/Models/MFA.html +0 -129
  600. data/doc/rdoc/classes/Plaid/Models/NumberACH.html +0 -134
  601. data/doc/rdoc/classes/Plaid/Models/NumberBACS.html +0 -126
  602. data/doc/rdoc/classes/Plaid/Models/NumberEFT.html +0 -134
  603. data/doc/rdoc/classes/Plaid/Models/NumberInternational.html +0 -127
  604. data/doc/rdoc/classes/Plaid/Models/Numbers.html +0 -135
  605. data/doc/rdoc/classes/Plaid/Models/PSLFStatus.html +0 -128
  606. data/doc/rdoc/classes/Plaid/Models/Payment.html +0 -174
  607. data/doc/rdoc/classes/Plaid/Models/PaymentAmount.html +0 -118
  608. data/doc/rdoc/classes/Plaid/Models/PaymentRecipient.html +0 -142
  609. data/doc/rdoc/classes/Plaid/Models/PaymentRecipientAddress.html +0 -134
  610. data/doc/rdoc/classes/Plaid/Models/PaymentRecipientBACS.html +0 -118
  611. data/doc/rdoc/classes/Plaid/Models/PaymentSchedule.html +0 -126
  612. data/doc/rdoc/classes/Plaid/Models/Security.html +0 -228
  613. data/doc/rdoc/classes/Plaid/Models/StandingOrderMetadata.html +0 -129
  614. data/doc/rdoc/classes/Plaid/Models/StudentLoanLiability.html +0 -305
  615. data/doc/rdoc/classes/Plaid/Models/StudentLoanRepaymentPlan.html +0 -118
  616. data/doc/rdoc/classes/Plaid/Models/StudentLoanServicerAddress.html +0 -142
  617. data/doc/rdoc/classes/Plaid/Models/StudentLoanStatus.html +0 -118
  618. data/doc/rdoc/classes/Plaid/Models/Transaction.html +0 -265
  619. data/doc/rdoc/classes/Plaid/Models/TransactionLocation.html +0 -166
  620. data/doc/rdoc/classes/Plaid/Models/TransactionPaymentMeta.html +0 -167
  621. data/doc/rdoc/classes/Plaid/Models/Warning.html +0 -126
  622. data/doc/rdoc/classes/Plaid/Models/WebhookVerificationKey.html +0 -174
  623. data/doc/rdoc/classes/Plaid/Models.html +0 -506
  624. data/doc/rdoc/classes/Plaid/MultipleInstitutionsResponse.html +0 -119
  625. data/doc/rdoc/classes/Plaid/Ocrolus/ProcessorToken.html +0 -205
  626. data/doc/rdoc/classes/Plaid/Ocrolus.html +0 -151
  627. data/doc/rdoc/classes/Plaid/PaymentCreateResponse.html +0 -118
  628. data/doc/rdoc/classes/Plaid/PaymentGetResponse.html +0 -174
  629. data/doc/rdoc/classes/Plaid/PaymentInitiation.html +0 -567
  630. data/doc/rdoc/classes/Plaid/PaymentListResponse.html +0 -119
  631. data/doc/rdoc/classes/Plaid/PaymentRecipientCreateResponse.html +0 -110
  632. data/doc/rdoc/classes/Plaid/PaymentRecipientGetResponse.html +0 -142
  633. data/doc/rdoc/classes/Plaid/PaymentRecipientListResponse.html +0 -110
  634. data/doc/rdoc/classes/Plaid/PaymentTokenCreateResponse.html +0 -118
  635. data/doc/rdoc/classes/Plaid/PlaidAPIError.html +0 -260
  636. data/doc/rdoc/classes/Plaid/PlaidError.html +0 -96
  637. data/doc/rdoc/classes/Plaid/PlaidServerError.html +0 -96
  638. data/doc/rdoc/classes/Plaid/Processor.html +0 -143
  639. data/doc/rdoc/classes/Plaid/ProcessorToken.html +0 -219
  640. data/doc/rdoc/classes/Plaid/ProcessorTokenResponse.html +0 -110
  641. data/doc/rdoc/classes/Plaid/PublicToken/CreateResponse.html +0 -118
  642. data/doc/rdoc/classes/Plaid/PublicToken/ExchangeResponse.html +0 -118
  643. data/doc/rdoc/classes/Plaid/PublicToken.html +0 -283
  644. data/doc/rdoc/classes/Plaid/RateLimitExceededError.html +0 -97
  645. data/doc/rdoc/classes/Plaid/Sandbox.html +0 -119
  646. data/doc/rdoc/classes/Plaid/SandboxItem/FireWebhookResponse.html +0 -110
  647. data/doc/rdoc/classes/Plaid/SandboxItem/ResetLoginResponse.html +0 -110
  648. data/doc/rdoc/classes/Plaid/SandboxItem.html +0 -351
  649. data/doc/rdoc/classes/Plaid/SandboxPublicToken/SandboxCreateResponse.html +0 -118
  650. data/doc/rdoc/classes/Plaid/SandboxPublicToken.html +0 -249
  651. data/doc/rdoc/classes/Plaid/SingleInstitutionResponse.html +0 -111
  652. data/doc/rdoc/classes/Plaid/Stripe/BankAccountToken/CreateResponse.html +0 -110
  653. data/doc/rdoc/classes/Plaid/Stripe/BankAccountToken.html +0 -215
  654. data/doc/rdoc/classes/Plaid/Stripe.html +0 -151
  655. data/doc/rdoc/classes/Plaid/SubproductMixin.html +0 -179
  656. data/doc/rdoc/classes/Plaid/Transactions/GetResponse.html +0 -144
  657. data/doc/rdoc/classes/Plaid/Transactions.html +0 -302
  658. data/doc/rdoc/classes/Plaid/Webhook/UpdateResponse.html +0 -110
  659. data/doc/rdoc/classes/Plaid/Webhook.html +0 -214
  660. data/doc/rdoc/classes/Plaid/Webhooks/WebhookVerificationKeyGetResponse.html +0 -110
  661. data/doc/rdoc/classes/Plaid/Webhooks.html +0 -207
  662. data/doc/rdoc/classes/Plaid.html +0 -772
  663. data/doc/rdoc/created.rid +0 -28
  664. data/doc/rdoc/css/github.css +0 -123
  665. data/doc/rdoc/css/main.css +0 -333
  666. data/doc/rdoc/css/panel.css +0 -383
  667. data/doc/rdoc/css/reset.css +0 -48
  668. data/doc/rdoc/favicon.ico +0 -0
  669. data/doc/rdoc/files/LICENSE_txt.html +0 -98
  670. data/doc/rdoc/files/README_md.html +0 -388
  671. data/doc/rdoc/files/lib/plaid/client_rb.html +0 -121
  672. data/doc/rdoc/files/lib/plaid/errors_rb.html +0 -132
  673. data/doc/rdoc/files/lib/plaid/middleware_rb.html +0 -99
  674. data/doc/rdoc/files/lib/plaid/models_rb.html +0 -450
  675. data/doc/rdoc/files/lib/plaid/products/accounts_rb.html +0 -102
  676. data/doc/rdoc/files/lib/plaid/products/asset_report_rb.html +0 -132
  677. data/doc/rdoc/files/lib/plaid/products/auth_rb.html +0 -97
  678. data/doc/rdoc/files/lib/plaid/products/base_product_rb.html +0 -92
  679. data/doc/rdoc/files/lib/plaid/products/categories_rb.html +0 -92
  680. data/doc/rdoc/files/lib/plaid/products/credit_details_rb.html +0 -97
  681. data/doc/rdoc/files/lib/plaid/products/deposit_switch_rb.html +0 -102
  682. data/doc/rdoc/files/lib/plaid/products/identity_rb.html +0 -97
  683. data/doc/rdoc/files/lib/plaid/products/income_rb.html +0 -97
  684. data/doc/rdoc/files/lib/plaid/products/institutions_rb.html +0 -102
  685. data/doc/rdoc/files/lib/plaid/products/investments_rb.html +0 -120
  686. data/doc/rdoc/files/lib/plaid/products/item_rb.html +0 -142
  687. data/doc/rdoc/files/lib/plaid/products/liabilities_rb.html +0 -97
  688. data/doc/rdoc/files/lib/plaid/products/link_token_rb.html +0 -102
  689. data/doc/rdoc/files/lib/plaid/products/payment_initiation_rb.html +0 -127
  690. data/doc/rdoc/files/lib/plaid/products/processor_rb.html +0 -142
  691. data/doc/rdoc/files/lib/plaid/products/sandbox_rb.html +0 -117
  692. data/doc/rdoc/files/lib/plaid/products/transactions_rb.html +0 -105
  693. data/doc/rdoc/files/lib/plaid/products/webhooks_rb.html +0 -97
  694. data/doc/rdoc/files/lib/plaid/version_rb.html +0 -82
  695. data/doc/rdoc/files/lib/plaid_rb.html +0 -120
  696. data/doc/rdoc/i/arrows.png +0 -0
  697. data/doc/rdoc/i/results_bg.png +0 -0
  698. data/doc/rdoc/i/tree_bg.png +0 -0
  699. data/doc/rdoc/index.html +0 -13
  700. data/doc/rdoc/js/highlight.pack.js +0 -1
  701. data/doc/rdoc/js/jquery-1.3.2.min.js +0 -19
  702. data/doc/rdoc/js/main.js +0 -29
  703. data/doc/rdoc/js/navigation.js +0 -142
  704. data/doc/rdoc/js/navigation.js.gz +0 -0
  705. data/doc/rdoc/js/search_index.js +0 -1
  706. data/doc/rdoc/js/search_index.js.gz +0 -0
  707. data/doc/rdoc/js/searchdoc.js +0 -468
  708. data/doc/rdoc/js/searcher.js +0 -229
  709. data/doc/rdoc/js/searcher.js.gz +0 -0
  710. data/doc/rdoc/panel/index.html +0 -74
  711. data/doc/rdoc/panel/links.html +0 -60
  712. data/doc/rdoc/panel/tree.js +0 -1
  713. data/pkg/plaid-10.0.0.gem +0 -0
  714. data/pkg/plaid-11.0.0.gem +0 -0
  715. data/pkg/plaid-12.0.0.gem +0 -0
  716. data/pkg/plaid-13.1.0.gem +0 -0
  717. data/pkg/plaid-14.3.0.gem +0 -0
  718. data/pkg/plaid-14.4.0.gem +0 -0
  719. data/pkg/plaid-8.5.0.gem +0 -0
  720. data/pkg/plaid-8.6.0.gem +0 -0
  721. data/pkg/plaid-8.7.0.gem +0 -0
  722. data/pkg/plaid-8.8.0.gem +0 -0
  723. data/pkg/plaid-9.0.0.gem +0 -0
data/doc/rdoc/classes/Plaid/Client.html DELETED
@@ -1,802 +0,0 @@
1
- <?xml version="1.0" encoding="utf-8"?>
2
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
3
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
4
- <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
5
- <head>
6
- <title>Plaid::Client</title>
7
- <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
8
- <link rel="stylesheet" href="../../css/reset.css" type="text/css" media="screen" />
9
- <link rel="stylesheet" href="../../css/main.css" type="text/css" media="screen" />
10
- <link rel="stylesheet" href="../../css/github.css" type="text/css" media="screen" />
11
- <script src="../../js/jquery-1.3.2.min.js" type="text/javascript" charset="utf-8"></script>
12
- <script src="../../js/main.js" type="text/javascript" charset="utf-8"></script>
13
- <script src="../../js/highlight.pack.js" type="text/javascript" charset="utf-8"></script>
14
-
15
-
16
- <meta property="og:title" value="Plaid::Client">
17
-
18
-
19
-
20
- <meta name="description" content="The main interface to Plaid API.">
21
- <meta property="og:description" content="The main interface to Plaid API.">
22
-
23
-
24
- <meta name="keywords" content="Plaid::Client class">
25
-
26
- <meta name="keywords" content="new, link_token, post, post_with_auth, build_default_connection, client, api_host, create_connection">
27
-
28
- </head>
29
-
30
- <body>
31
- <div class="banner">
32
-
33
- <h1>
34
- <span class="type">Class</span>
35
- Plaid::Client
36
-
37
- <span class="parent">&lt;
38
-
39
- <a href="../Object.html">Object</a>
40
-
41
- </span>
42
-
43
- </h1>
44
- <ul class="files">
45
-
46
- <li><a href="../../files/lib/plaid/client_rb.html">lib/plaid/client.rb</a></li>
47
-
48
- </ul>
49
- </div>
50
- <div id="bodyContent">
51
- <div id="content">
52
-
53
- <div class="description">
54
-
55
- <p>The main interface to <a href="../Plaid.html">Plaid</a> API.</p>
56
-
57
- </div>
58
-
59
-
60
-
61
-
62
-
63
-
64
-
65
-
66
- <!-- Sections -->
67
- <div class="sectiontitle">Sections</div>
68
- <ul>
69
-
70
- <li><a href="#Internal">Internal</a></li>
71
-
72
- <li><a href="#Public">Public</a></li>
73
-
74
- </ul>
75
-
76
-
77
-
78
-
79
-
80
-
81
-
82
- <!-- Method ref -->
83
- <div class="sectiontitle">Methods</div>
84
- <dl class="methods">
85
-
86
- <dt>A</dt>
87
- <dd>
88
- <ul>
89
-
90
-
91
- <li>
92
- <a href="#method-i-api_host">api_host</a>
93
- </li>
94
-
95
- </ul>
96
- </dd>
97
-
98
- <dt>B</dt>
99
- <dd>
100
- <ul>
101
-
102
-
103
- <li>
104
- <a href="#method-c-build_default_connection">build_default_connection</a>
105
- </li>
106
-
107
- </ul>
108
- </dd>
109
-
110
- <dt>C</dt>
111
- <dd>
112
- <ul>
113
-
114
-
115
- <li>
116
- <a href="#method-i-client">client</a>,
117
- </li>
118
-
119
-
120
- <li>
121
- <a href="#method-i-create_connection">create_connection</a>
122
- </li>
123
-
124
- </ul>
125
- </dd>
126
-
127
- <dt>L</dt>
128
- <dd>
129
- <ul>
130
-
131
-
132
- <li>
133
- <a href="#method-i-link_token">link_token</a>
134
- </li>
135
-
136
- </ul>
137
- </dd>
138
-
139
- <dt>N</dt>
140
- <dd>
141
- <ul>
142
-
143
-
144
- <li>
145
- <a href="#method-c-new">new</a>
146
- </li>
147
-
148
- </ul>
149
- </dd>
150
-
151
- <dt>P</dt>
152
- <dd>
153
- <ul>
154
-
155
-
156
- <li>
157
- <a href="#method-i-post">post</a>,
158
- </li>
159
-
160
-
161
- <li>
162
- <a href="#method-i-post_with_auth">post_with_auth</a>
163
- </li>
164
-
165
- </ul>
166
- </dd>
167
-
168
- </dl>
169
-
170
-
171
-
172
-
173
-
174
-
175
-
176
-
177
-
178
-
179
-
180
-
181
-
182
-
183
-
184
-
185
- <!-- Section attributes -->
186
- <div class="sectiontitle">Attributes</div>
187
- <table border='0' cellpadding='5'>
188
-
189
- <tr valign='top'>
190
- <td class='attr-rw'>
191
- [R]
192
- </td>
193
- <td class='attr-name'>accounts</td>
194
- <td class='attr-desc'><p>The <a href="Accounts.html">Plaid::Accounts</a> product accessor.</p></td>
195
- </tr>
196
-
197
- <tr valign='top'>
198
- <td class='attr-rw'>
199
- [R]
200
- </td>
201
- <td class='attr-name'>asset_report</td>
202
- <td class='attr-desc'><p>The <a href="AssetReport.html">Plaid::AssetReport</a> product accessor.</p></td>
203
- </tr>
204
-
205
- <tr valign='top'>
206
- <td class='attr-rw'>
207
- [R]
208
- </td>
209
- <td class='attr-name'>auth</td>
210
- <td class='attr-desc'><p>The <a href="Auth.html">Plaid::Auth</a> product accessor.</p></td>
211
- </tr>
212
-
213
- <tr valign='top'>
214
- <td class='attr-rw'>
215
- [R]
216
- </td>
217
- <td class='attr-name'>categories</td>
218
- <td class='attr-desc'><p>The <a href="Categories.html">Plaid::Categories</a> product accessor.</p></td>
219
- </tr>
220
-
221
- <tr valign='top'>
222
- <td class='attr-rw'>
223
- [R]
224
- </td>
225
- <td class='attr-name'>credit_details</td>
226
- <td class='attr-desc'><p>The <a href="CreditDetails.html">Plaid::CreditDetails</a> product accessor.</p></td>
227
- </tr>
228
-
229
- <tr valign='top'>
230
- <td class='attr-rw'>
231
- [R]
232
- </td>
233
- <td class='attr-name'>deposit_switch</td>
234
- <td class='attr-desc'><p>The <a href="DepositSwitch.html">Plaid::DepositSwitch</a> product accessor.</p></td>
235
- </tr>
236
-
237
- <tr valign='top'>
238
- <td class='attr-rw'>
239
- [R]
240
- </td>
241
- <td class='attr-name'>identity</td>
242
- <td class='attr-desc'><p>The <a href="Identity.html">Plaid::Identity</a> product accessor.</p></td>
243
- </tr>
244
-
245
- <tr valign='top'>
246
- <td class='attr-rw'>
247
- [R]
248
- </td>
249
- <td class='attr-name'>income</td>
250
- <td class='attr-desc'><p>The <a href="Income.html">Plaid::Income</a> product accessor.</p></td>
251
- </tr>
252
-
253
- <tr valign='top'>
254
- <td class='attr-rw'>
255
- [R]
256
- </td>
257
- <td class='attr-name'>institutions</td>
258
- <td class='attr-desc'><p>The <a href="Institutions.html">Plaid::Institutions</a> product accessor.</p></td>
259
- </tr>
260
-
261
- <tr valign='top'>
262
- <td class='attr-rw'>
263
- [R]
264
- </td>
265
- <td class='attr-name'>investments</td>
266
- <td class='attr-desc'><p>The <a href="Investments.html">Plaid::Investments</a> product accessor.</p></td>
267
- </tr>
268
-
269
- <tr valign='top'>
270
- <td class='attr-rw'>
271
- [R]
272
- </td>
273
- <td class='attr-name'>item</td>
274
- <td class='attr-desc'><p>The <a href="Item.html">Plaid::Item</a> product accessor.</p></td>
275
- </tr>
276
-
277
- <tr valign='top'>
278
- <td class='attr-rw'>
279
- [R]
280
- </td>
281
- <td class='attr-name'>liabilities</td>
282
- <td class='attr-desc'><p>The <a href="Liabilities.html">Plaid::Liabilities</a> product accessor.</p></td>
283
- </tr>
284
-
285
- <tr valign='top'>
286
- <td class='attr-rw'>
287
- [R]
288
- </td>
289
- <td class='attr-name'>payment_initiation</td>
290
- <td class='attr-desc'><p>The <a href="PaymentInitiation.html">Plaid::PaymentInitiation</a> product
291
- accessor.</p></td>
292
- </tr>
293
-
294
- <tr valign='top'>
295
- <td class='attr-rw'>
296
- [R]
297
- </td>
298
- <td class='attr-name'>processor</td>
299
- <td class='attr-desc'><p>The <a href="Processor.html">Plaid::Processor</a> product accessor.</p></td>
300
- </tr>
301
-
302
- <tr valign='top'>
303
- <td class='attr-rw'>
304
- [R]
305
- </td>
306
- <td class='attr-name'>sandbox</td>
307
- <td class='attr-desc'><p>The <a href="Sandbox.html">Plaid::Sandbox</a> product accessor.</p></td>
308
- </tr>
309
-
310
- <tr valign='top'>
311
- <td class='attr-rw'>
312
- [R]
313
- </td>
314
- <td class='attr-name'>transactions</td>
315
- <td class='attr-desc'><p>The <a href="Transactions.html">Plaid::Transactions</a> product accessor.</p></td>
316
- </tr>
317
-
318
- <tr valign='top'>
319
- <td class='attr-rw'>
320
- [R]
321
- </td>
322
- <td class='attr-name'>webhooks</td>
323
- <td class='attr-desc'><p>The <a href="Webhooks.html">Plaid::Webhooks</a> endpoint accessor.</p></td>
324
- </tr>
325
-
326
- </table>
327
-
328
-
329
-
330
- <!-- Methods -->
331
-
332
-
333
- <div class="sectiontitle">Instance Public methods</div>
334
-
335
- <div class="method">
336
- <div class="title method-title" id="method-i-link_token">
337
-
338
- <b>link_token</b>
339
-
340
- <a href="../../classes/Plaid/Client.html#method-i-link_token" name="method-i-link_token" class="permalink">Link</a>
341
- </div>
342
-
343
-
344
- <div class="description">
345
- <p>:attr_reader: Public: The <a href="LinkToken.html">Plaid::LinkToken</a>
346
- endpoint accessor.</p>
347
- </div>
348
-
349
-
350
-
351
-
352
-
353
-
354
-
355
-
356
- <div class="sourcecode">
357
-
358
- <p class="source-link">
359
- Source:
360
- <a href="javascript:toggleSource('method-i-link_token_source')" id="l_method-i-link_token_source">show</a>
361
-
362
- </p>
363
- <div id="method-i-link_token_source" class="dyn-source">
364
- <pre><span class="ruby-comment"># File lib/plaid/client.rb, line 121</span>
365
- <span class="ruby-identifier">subproduct</span> <span class="ruby-value">:link_token</span>
366
- </pre>
367
- </div>
368
- </div>
369
-
370
- </div>
371
-
372
-
373
-
374
-
375
-
376
-
377
- <div class="contenttitle" id="Public">
378
- Public
379
- </div>
380
-
381
-
382
-
383
-
384
-
385
- <!-- Section constants -->
386
- <div class="sectiontitle">Constants</div>
387
- <table border='0' cellpadding='5'>
388
-
389
- <tr valign='top'>
390
- <td class="attr-name">ENVIRONMENTS</td>
391
- <td>=</td>
392
- <td class="attr-value">%i[sandbox development production].freeze</td>
393
- </tr>
394
-
395
- <tr valign='top'>
396
- <td>&nbsp;</td>
397
- <td colspan="2" class="attr-desc"><p>All possible environments for the client to use.</p></td>
398
- </tr>
399
-
400
-
401
- </table>
402
-
403
-
404
-
405
-
406
- <!-- Section attributes -->
407
- <div class="sectiontitle">Attributes</div>
408
- <table border='0' cellpadding='5'>
409
-
410
- <tr valign='top'>
411
- <td class='attr-rw'>
412
- [R]
413
- </td>
414
- <td class='attr-name'>client_id</td>
415
- <td class='attr-desc'><p>The client ID.</p></td>
416
- </tr>
417
-
418
- <tr valign='top'>
419
- <td class='attr-rw'>
420
- [R]
421
- </td>
422
- <td class='attr-name'>env</td>
423
- <td class='attr-desc'><p>The current environment in use (one of <a
424
- href="Client.html#ENVIRONMENTS">ENVIRONMENTS</a>).</p></td>
425
- </tr>
426
-
427
- </table>
428
-
429
-
430
-
431
- <!-- Methods -->
432
-
433
- <div class="sectiontitle">Class Public methods</div>
434
-
435
- <div class="method">
436
- <div class="title method-title" id="method-c-build_default_connection">
437
-
438
- <b>build_default_connection</b>(builder)
439
-
440
- <a href="../../classes/Plaid/Client.html#method-c-build_default_connection" name="method-c-build_default_connection" class="permalink">Link</a>
441
- </div>
442
-
443
-
444
- <div class="description">
445
- <p>Set <a href="../Plaid.html">Plaid</a> defaults on the Faraday connection.</p>
446
- <dl class="rdoc-list note-list"><dt>builder
447
- <dd>
448
- <p>The Faraday builder object.</p>
449
- </dd></dl>
450
- </div>
451
-
452
-
453
-
454
-
455
-
456
-
457
-
458
-
459
- <div class="sourcecode">
460
-
461
- <p class="source-link">
462
- Source:
463
- <a href="javascript:toggleSource('method-c-build_default_connection_source')" id="l_method-c-build_default_connection_source">show</a>
464
-
465
- </p>
466
- <div id="method-c-build_default_connection_source" class="dyn-source">
467
- <pre><span class="ruby-comment"># File lib/plaid/client.rb, line 149</span>
468
- <span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">build_default_connection</span>(<span class="ruby-identifier">builder</span>)
469
- <span class="ruby-identifier">builder</span>.<span class="ruby-identifier">options</span>[<span class="ruby-value">:timeout</span>] = <span class="ruby-constant">Plaid</span><span class="ruby-operator">::</span><span class="ruby-constant">Middleware</span><span class="ruby-operator">::</span><span class="ruby-constant">NETWORK_TIMEOUT</span>
470
- <span class="ruby-identifier">builder</span>.<span class="ruby-identifier">headers</span> = <span class="ruby-constant">Plaid</span><span class="ruby-operator">::</span><span class="ruby-constant">Middleware</span><span class="ruby-operator">::</span><span class="ruby-constant">NETWORK_HEADERS</span>
471
- <span class="ruby-identifier">builder</span>.<span class="ruby-identifier">request</span> <span class="ruby-value">:json</span>
472
- <span class="ruby-identifier">builder</span>.<span class="ruby-identifier">use</span> <span class="ruby-constant">Plaid</span><span class="ruby-operator">::</span><span class="ruby-constant">Middleware</span>
473
- <span class="ruby-identifier">builder</span>.<span class="ruby-identifier">response</span> <span class="ruby-value">:json</span>, <span class="ruby-value">content_type:</span> <span class="ruby-regexp">/\bjson$/</span>
474
- <span class="ruby-identifier">builder</span>.<span class="ruby-identifier">adapter</span> <span class="ruby-constant">Faraday</span>.<span class="ruby-identifier">default_adapter</span>
475
- <span class="ruby-keyword">end</span></pre>
476
- </div>
477
- </div>
478
-
479
- </div>
480
-
481
- <div class="method">
482
- <div class="title method-title" id="method-c-new">
483
-
484
- <b>new</b>(env:, client_id:, secret:, &amp;block)
485
-
486
- <a href="../../classes/Plaid/Client.html#method-c-new" name="method-c-new" class="permalink">Link</a>
487
- </div>
488
-
489
-
490
- <div class="description">
491
- <p>Construct a <a href="Client.html">Client</a> instance</p>
492
-
493
- <p>Optionally takes a block to allow overriding the default Faraday connection
494
- options.</p>
495
- <dl class="rdoc-list note-list"><dt>env
496
- <dd>
497
- <p>The Symbol (:sandbox, :development, :production)</p>
498
- </dd><dt><a href="Client.html#attribute-i-client_id">#client_id</a>
499
- <dd>
500
- <p>The String <a href="../Plaid.html">Plaid</a> account client ID to
501
- authenticate requests</p>
502
- </dd><dt>secret
503
- <dd>
504
- <p>The String <a href="../Plaid.html">Plaid</a> account secret to authenticate
505
- requests</p>
506
- </dd></dl>
507
- </div>
508
-
509
-
510
-
511
-
512
-
513
-
514
-
515
-
516
- <div class="sourcecode">
517
-
518
- <p class="source-link">
519
- Source:
520
- <a href="javascript:toggleSource('method-c-new_source')" id="l_method-c-new_source">show</a>
521
-
522
- </p>
523
- <div id="method-c-new_source" class="dyn-source">
524
- <pre><span class="ruby-comment"># File lib/plaid/client.rb, line 22</span>
525
- <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-value">env:</span>, <span class="ruby-value">client_id:</span>, <span class="ruby-value">secret:</span>, <span class="ruby-operator">&amp;</span><span class="ruby-identifier">block</span>)
526
- <span class="ruby-ivar">@env</span> = <span class="ruby-identifier">env</span>.<span class="ruby-identifier">to_sym</span>
527
- <span class="ruby-ivar">@api_host</span> = <span class="ruby-identifier">api_host</span>
528
- <span class="ruby-ivar">@client_id</span> = <span class="ruby-identifier">client_id</span>
529
- <span class="ruby-ivar">@secret</span> = <span class="ruby-identifier">secret</span>
530
-
531
- <span class="ruby-identifier">create_connection</span>(<span class="ruby-operator">&amp;</span><span class="ruby-identifier">block</span>)
532
- <span class="ruby-keyword">end</span></pre>
533
- </div>
534
- </div>
535
-
536
- </div>
537
-
538
-
539
-
540
- <div class="sectiontitle">Instance Public methods</div>
541
-
542
- <div class="method">
543
- <div class="title method-title" id="method-i-post">
544
-
545
- <b>post</b>(path, payload)
546
-
547
- <a href="../../classes/Plaid/Client.html#method-i-post" name="method-i-post" class="permalink">Link</a>
548
- </div>
549
-
550
-
551
- <div class="description">
552
- <p>Make a post request</p>
553
- <dl class="rdoc-list note-list"><dt>path
554
- <dd>
555
- <p>Path or URL to make the request to</p>
556
- </dd><dt>payload
557
- <dd>
558
- <p>The payload or data to post</p>
559
- </dd></dl>
560
-
561
- <h3 id="method-i-post-label-Returns">Returns</h3>
562
-
563
- <p>Returns the resulting parsed JSON of the request</p>
564
- </div>
565
-
566
-
567
-
568
-
569
-
570
-
571
-
572
-
573
- <div class="sourcecode">
574
-
575
- <p class="source-link">
576
- Source:
577
- <a href="javascript:toggleSource('method-i-post_source')" id="l_method-i-post_source">show</a>
578
-
579
- </p>
580
- <div id="method-i-post_source" class="dyn-source">
581
- <pre><span class="ruby-comment"># File lib/plaid/client.rb, line 129</span>
582
- <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">post</span>(<span class="ruby-identifier">path</span>, <span class="ruby-identifier">payload</span>)
583
- <span class="ruby-ivar">@connection</span>.<span class="ruby-identifier">post</span>(<span class="ruby-identifier">path</span>, <span class="ruby-identifier">payload</span>).<span class="ruby-identifier">body</span>
584
- <span class="ruby-keyword">end</span></pre>
585
- </div>
586
- </div>
587
-
588
- </div>
589
-
590
- <div class="method">
591
- <div class="title method-title" id="method-i-post_with_auth">
592
-
593
- <b>post_with_auth</b>(path, payload)
594
-
595
- <a href="../../classes/Plaid/Client.html#method-i-post_with_auth" name="method-i-post_with_auth" class="permalink">Link</a>
596
- </div>
597
-
598
-
599
- <div class="description">
600
- <p>Make a post request with appended authentication fields</p>
601
- <dl class="rdoc-list note-list"><dt>path
602
- <dd>
603
- <p>Path or URL to make the request to</p>
604
- </dd><dt>payload
605
- <dd>
606
- <p>The payload or data to post</p>
607
- </dd></dl>
608
-
609
- <h3 id="method-i-post_with_auth-label-Returns">Returns</h3>
610
-
611
- <p>Returns the resulting parsed JSON of the request</p>
612
- </div>
613
-
614
-
615
-
616
-
617
-
618
-
619
-
620
-
621
- <div class="sourcecode">
622
-
623
- <p class="source-link">
624
- Source:
625
- <a href="javascript:toggleSource('method-i-post_with_auth_source')" id="l_method-i-post_with_auth_source">show</a>
626
-
627
- </p>
628
- <div id="method-i-post_with_auth_source" class="dyn-source">
629
- <pre><span class="ruby-comment"># File lib/plaid/client.rb, line 139</span>
630
- <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">post_with_auth</span>(<span class="ruby-identifier">path</span>, <span class="ruby-identifier">payload</span>)
631
- <span class="ruby-ivar">@connection</span>.<span class="ruby-identifier">post</span>(
632
- <span class="ruby-identifier">path</span>,
633
- <span class="ruby-identifier">payload</span>.<span class="ruby-identifier">merge</span>(<span class="ruby-value">client_id:</span> <span class="ruby-ivar">@client_id</span>, <span class="ruby-value">secret:</span> <span class="ruby-ivar">@secret</span>)
634
- ).<span class="ruby-identifier">body</span>
635
- <span class="ruby-keyword">end</span></pre>
636
- </div>
637
- </div>
638
-
639
- </div>
640
-
641
-
642
-
643
-
644
-
645
-
646
- <div class="contenttitle" id="Internal">
647
- Internal
648
- </div>
649
-
650
-
651
-
652
-
653
-
654
-
655
-
656
-
657
-
658
-
659
- <!-- Methods -->
660
-
661
-
662
- <div class="sectiontitle">Instance Protected methods</div>
663
-
664
- <div class="method">
665
- <div class="title method-title" id="method-i-api_host">
666
-
667
- <b>api_host</b>()
668
-
669
- <a href="../../classes/Plaid/Client.html#method-i-api_host" name="method-i-api_host" class="permalink">Link</a>
670
- </div>
671
-
672
-
673
- <div class="description">
674
- <p>Gets the API hostname for given environment.</p>
675
- <dl class="rdoc-list note-list"><dt>env
676
- <dd>
677
- <p>The Symbol (:sandbox, :development, :production)</p>
678
- </dd></dl>
679
-
680
- <h3 id="method-i-api_host-label-Returns">Returns</h3>
681
-
682
- <p>Returns a String representing the environment URL. Raises ArgumentError if
683
- environment is unknown.</p>
684
- </div>
685
-
686
-
687
-
688
-
689
-
690
-
691
-
692
-
693
- <div class="sourcecode">
694
-
695
- <p class="source-link">
696
- Source:
697
- <a href="javascript:toggleSource('method-i-api_host_source')" id="l_method-i-api_host_source">show</a>
698
-
699
- </p>
700
- <div id="method-i-api_host_source" class="dyn-source">
701
- <pre><span class="ruby-comment"># File lib/plaid/client.rb, line 171</span>
702
- <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">api_host</span>
703
- <span class="ruby-keyword">unless</span> <span class="ruby-constant">ENVIRONMENTS</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-ivar">@env</span>)
704
- <span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>,
705
- <span class="ruby-node">&quot;Invalid value for env (#{@env.inspect}): must be one of &quot;</span> <span class="ruby-operator">+</span>
706
- <span class="ruby-constant">ENVIRONMENTS</span>.<span class="ruby-identifier">map</span>(<span class="ruby-operator">&amp;</span><span class="ruby-value">:inspect</span>) <span class="ruby-operator">*</span> <span class="ruby-string">&#39;, &#39;</span>
707
- <span class="ruby-keyword">end</span>
708
-
709
- <span class="ruby-node">&quot;https://#{@env}.plaid.com&quot;</span>
710
- <span class="ruby-keyword">end</span></pre>
711
- </div>
712
- </div>
713
-
714
- </div>
715
-
716
- <div class="method">
717
- <div class="title method-title" id="method-i-client">
718
-
719
- <b>client</b>()
720
-
721
- <a href="../../classes/Plaid/Client.html#method-i-client" name="method-i-client" class="permalink">Link</a>
722
- </div>
723
-
724
-
725
- <div class="description">
726
- <p>subproduct-generated methods depend on client method.</p>
727
- </div>
728
-
729
-
730
-
731
-
732
-
733
-
734
-
735
-
736
- <div class="sourcecode">
737
-
738
- <p class="source-link">
739
- Source:
740
- <a href="javascript:toggleSource('method-i-client_source')" id="l_method-i-client_source">show</a>
741
-
742
- </p>
743
- <div id="method-i-client_source" class="dyn-source">
744
- <pre><span class="ruby-comment"># File lib/plaid/client.rb, line 161</span>
745
- <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">client</span>
746
- <span class="ruby-keyword">self</span>
747
- <span class="ruby-keyword">end</span></pre>
748
- </div>
749
- </div>
750
-
751
- </div>
752
-
753
- <div class="method">
754
- <div class="title method-title" id="method-i-create_connection">
755
-
756
- <b>create_connection</b>()
757
-
758
- <a href="../../classes/Plaid/Client.html#method-i-create_connection" name="method-i-create_connection" class="permalink">Link</a>
759
- </div>
760
-
761
-
762
- <div class="description">
763
- <p>Initializes a new <a href="../Plaid.html">Plaid</a> connection object via
764
- Faraday.</p>
765
-
766
- <p>Optionally takes a block to allow overriding the defaults.</p>
767
- </div>
768
-
769
-
770
-
771
-
772
-
773
-
774
-
775
-
776
- <div class="sourcecode">
777
-
778
- <p class="source-link">
779
- Source:
780
- <a href="javascript:toggleSource('method-i-create_connection_source')" id="l_method-i-create_connection_source">show</a>
781
-
782
- </p>
783
- <div id="method-i-create_connection_source" class="dyn-source">
784
- <pre><span class="ruby-comment"># File lib/plaid/client.rb, line 184</span>
785
- <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">create_connection</span>
786
- <span class="ruby-ivar">@connection</span> = <span class="ruby-constant">Faraday</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value">url:</span> <span class="ruby-ivar">@api_host</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">builder</span><span class="ruby-operator">|</span>
787
- <span class="ruby-identifier">block_given?</span> <span class="ruby-operator">?</span> <span class="ruby-keyword">yield</span>(<span class="ruby-identifier">builder</span>) <span class="ruby-operator">:</span> <span class="ruby-constant">Client</span>.<span class="ruby-identifier">build_default_connection</span>(<span class="ruby-identifier">builder</span>)
788
- <span class="ruby-keyword">end</span>
789
- <span class="ruby-keyword">end</span></pre>
790
- </div>
791
- </div>
792
-
793
- </div>
794
-
795
-
796
-
797
-
798
- </div>
799
-
800
- </div>
801
- </body>
802
- </html>