plaid 14.0.0.beta.3 → 14.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +27 -1
- data/CONTRIBUTING.md +1 -5
- data/Gemfile.lock +18 -4
- data/LICENSE.txt +1 -1
- data/Makefile +2 -21
- data/PUBLISH.md +2 -3
- data/README.md +7 -6
- data/doc/rdoc/.DS_Store +0 -0
- data/doc/rdoc/apple-touch-icon.png +0 -0
- data/doc/rdoc/classes/Object.html +118 -0
- data/doc/rdoc/classes/Plaid/APIError.html +97 -0
- data/doc/rdoc/classes/Plaid/AccessToken/InvalidateResponse.html +110 -0
- data/doc/rdoc/classes/Plaid/AccessToken.html +211 -0
- data/doc/rdoc/classes/Plaid/Accounts.html +257 -0
- data/doc/rdoc/classes/Plaid/AccountsResponse.html +119 -0
- data/doc/rdoc/classes/Plaid/Apex/ProcessorToken.html +205 -0
- data/doc/rdoc/classes/Plaid/Apex.html +149 -0
- data/doc/rdoc/classes/Plaid/AssetReport.html +683 -0
- data/doc/rdoc/classes/Plaid/AssetReportCreateResponse.html +118 -0
- data/doc/rdoc/classes/Plaid/AssetReportFilterResponse.html +96 -0
- data/doc/rdoc/classes/Plaid/AssetReportGetResponse.html +118 -0
- data/doc/rdoc/classes/Plaid/AssetReportRefreshResponse.html +96 -0
- data/doc/rdoc/classes/Plaid/AssetReportRemoveResponse.html +110 -0
- data/doc/rdoc/classes/Plaid/AuditCopyCreateResponse.html +110 -0
- data/doc/rdoc/classes/Plaid/AuditCopyGetResponse.html +96 -0
- data/doc/rdoc/classes/Plaid/AuditCopyRemoveResponse.html +110 -0
- data/doc/rdoc/classes/Plaid/Auth.html +206 -0
- data/doc/rdoc/classes/Plaid/AuthResponse.html +127 -0
- data/doc/rdoc/classes/Plaid/Balance.html +206 -0
- data/doc/rdoc/classes/Plaid/BaseProduct.html +304 -0
- data/doc/rdoc/classes/Plaid/Categories.html +191 -0
- data/doc/rdoc/classes/Plaid/CategoriesResponse.html +111 -0
- data/doc/rdoc/classes/Plaid/Client.html +802 -0
- data/doc/rdoc/classes/Plaid/CreateResponse.html +118 -0
- data/doc/rdoc/classes/Plaid/CreditDetails.html +203 -0
- data/doc/rdoc/classes/Plaid/CreditDetailsResponse.html +128 -0
- data/doc/rdoc/classes/Plaid/DepositSwitch/CreateResponse.html +110 -0
- data/doc/rdoc/classes/Plaid/DepositSwitch/CreateTokenResponse.html +118 -0
- data/doc/rdoc/classes/Plaid/DepositSwitch/GetResponse.html +150 -0
- data/doc/rdoc/classes/Plaid/DepositSwitch.html +339 -0
- data/doc/rdoc/classes/Plaid/Dwolla/ProcessorToken.html +205 -0
- data/doc/rdoc/classes/Plaid/Dwolla.html +150 -0
- data/doc/rdoc/classes/Plaid/Error.html +214 -0
- data/doc/rdoc/classes/Plaid/GetResponse.html +134 -0
- data/doc/rdoc/classes/Plaid/Holdings/GetResponse.html +137 -0
- data/doc/rdoc/classes/Plaid/Holdings.html +218 -0
- data/doc/rdoc/classes/Plaid/Identity.html +199 -0
- data/doc/rdoc/classes/Plaid/IdentityResponse.html +119 -0
- data/doc/rdoc/classes/Plaid/Income.html +198 -0
- data/doc/rdoc/classes/Plaid/IncomeResponse.html +119 -0
- data/doc/rdoc/classes/Plaid/InstitutionError.html +96 -0
- data/doc/rdoc/classes/Plaid/Institutions.html +356 -0
- data/doc/rdoc/classes/Plaid/InvalidInputError.html +97 -0
- data/doc/rdoc/classes/Plaid/InvalidRequestError.html +96 -0
- data/doc/rdoc/classes/Plaid/InvestmentTransactions/GetResponse.html +145 -0
- data/doc/rdoc/classes/Plaid/InvestmentTransactions.html +240 -0
- data/doc/rdoc/classes/Plaid/Investments.html +204 -0
- data/doc/rdoc/classes/Plaid/Item/GetResponse.html +119 -0
- data/doc/rdoc/classes/Plaid/Item/ImportResponse.html +110 -0
- data/doc/rdoc/classes/Plaid/Item/RemoveResponse.html +110 -0
- data/doc/rdoc/classes/Plaid/Item.html +382 -0
- data/doc/rdoc/classes/Plaid/ItemError.html +98 -0
- data/doc/rdoc/classes/Plaid/Liabilities.html +202 -0
- data/doc/rdoc/classes/Plaid/LiabilitiesResponse.html +128 -0
- data/doc/rdoc/classes/Plaid/LinkToken.html +215 -0
- data/doc/rdoc/classes/Plaid/Middleware.html +225 -0
- data/doc/rdoc/classes/Plaid/Models/Account.html +166 -0
- data/doc/rdoc/classes/Plaid/Models/AccountWithOwners.html +110 -0
- data/doc/rdoc/classes/Plaid/Models/AssetReport.html +153 -0
- data/doc/rdoc/classes/Plaid/Models/AssetReportAccount.html +198 -0
- data/doc/rdoc/classes/Plaid/Models/AssetReportBalance.html +142 -0
- data/doc/rdoc/classes/Plaid/Models/AssetReportHistoricalBalance.html +142 -0
- data/doc/rdoc/classes/Plaid/Models/AssetReportItem.html +145 -0
- data/doc/rdoc/classes/Plaid/Models/AssetReportOwner.html +139 -0
- data/doc/rdoc/classes/Plaid/Models/AssetReportTransaction.html +187 -0
- data/doc/rdoc/classes/Plaid/Models/AssetReportUser.html +159 -0
- data/doc/rdoc/classes/Plaid/Models/Balances.html +142 -0
- data/doc/rdoc/classes/Plaid/Models/BaseError.html +140 -0
- data/doc/rdoc/classes/Plaid/Models/BaseModel.html +259 -0
- data/doc/rdoc/classes/Plaid/Models/BaseResponse.html +110 -0
- data/doc/rdoc/classes/Plaid/Models/Category.html +127 -0
- data/doc/rdoc/classes/Plaid/Models/Cause.html +110 -0
- data/doc/rdoc/classes/Plaid/Models/CreditCardLiability.html +175 -0
- data/doc/rdoc/classes/Plaid/Models/CreditCardLiabilityAPRs.html +137 -0
- data/doc/rdoc/classes/Plaid/Models/CreditDetails.html +166 -0
- data/doc/rdoc/classes/Plaid/Models/CreditDetailsAPR.html +126 -0
- data/doc/rdoc/classes/Plaid/Models/CreditDetailsAPRs.html +126 -0
- data/doc/rdoc/classes/Plaid/Models/Error.html +110 -0
- data/doc/rdoc/classes/Plaid/Models/Holding.html +181 -0
- data/doc/rdoc/classes/Plaid/Models/Identity.html +135 -0
- data/doc/rdoc/classes/Plaid/Models/IdentityAddress.html +118 -0
- data/doc/rdoc/classes/Plaid/Models/IdentityAddressData.html +142 -0
- data/doc/rdoc/classes/Plaid/Models/IdentityEmail.html +127 -0
- data/doc/rdoc/classes/Plaid/Models/IdentityPhoneNumber.html +126 -0
- data/doc/rdoc/classes/Plaid/Models/Income.html +173 -0
- data/doc/rdoc/classes/Plaid/Models/IncomeStream.html +136 -0
- data/doc/rdoc/classes/Plaid/Models/Institution.html +230 -0
- data/doc/rdoc/classes/Plaid/Models/InstitutionCredential.html +126 -0
- data/doc/rdoc/classes/Plaid/Models/InstitutionPaymentInitiationMetadata.html +136 -0
- data/doc/rdoc/classes/Plaid/Models/InstitutionStatus.html +111 -0
- data/doc/rdoc/classes/Plaid/Models/InstitutionStatusBreakdown.html +129 -0
- data/doc/rdoc/classes/Plaid/Models/InstitutionStatusItemLogins.html +127 -0
- data/doc/rdoc/classes/Plaid/Models/InvestmentTransaction.html +224 -0
- data/doc/rdoc/classes/Plaid/Models/Item.html +169 -0
- data/doc/rdoc/classes/Plaid/Models/ItemStatus.html +129 -0
- data/doc/rdoc/classes/Plaid/Models/ItemStatusInvestments.html +119 -0
- data/doc/rdoc/classes/Plaid/Models/ItemStatusLastWebhook.html +118 -0
- data/doc/rdoc/classes/Plaid/Models/ItemStatusTransactions.html +119 -0
- data/doc/rdoc/classes/Plaid/Models/Liabilities.html +130 -0
- data/doc/rdoc/classes/Plaid/Models/LinkTokenMetadata.html +158 -0
- data/doc/rdoc/classes/Plaid/Models/MFA/Device.html +110 -0
- data/doc/rdoc/classes/Plaid/Models/MFA/DeviceListElement.html +126 -0
- data/doc/rdoc/classes/Plaid/Models/MFA/Selection.html +118 -0
- data/doc/rdoc/classes/Plaid/Models/MFA.html +129 -0
- data/doc/rdoc/classes/Plaid/Models/NumberACH.html +134 -0
- data/doc/rdoc/classes/Plaid/Models/NumberBACS.html +126 -0
- data/doc/rdoc/classes/Plaid/Models/NumberEFT.html +134 -0
- data/doc/rdoc/classes/Plaid/Models/NumberInternational.html +127 -0
- data/doc/rdoc/classes/Plaid/Models/Numbers.html +135 -0
- data/doc/rdoc/classes/Plaid/Models/PSLFStatus.html +128 -0
- data/doc/rdoc/classes/Plaid/Models/Payment.html +191 -0
- data/doc/rdoc/classes/Plaid/Models/PaymentAmount.html +118 -0
- data/doc/rdoc/classes/Plaid/Models/PaymentRecipient.html +142 -0
- data/doc/rdoc/classes/Plaid/Models/PaymentRecipientAddress.html +134 -0
- data/doc/rdoc/classes/Plaid/Models/PaymentRecipientBACS.html +118 -0
- data/doc/rdoc/classes/Plaid/Models/PaymentSchedule.html +126 -0
- data/doc/rdoc/classes/Plaid/Models/Security.html +228 -0
- data/doc/rdoc/classes/Plaid/Models/StandingOrderMetadata.html +129 -0
- data/doc/rdoc/classes/Plaid/Models/StudentLoanLiability.html +305 -0
- data/doc/rdoc/classes/Plaid/Models/StudentLoanRepaymentPlan.html +118 -0
- data/doc/rdoc/classes/Plaid/Models/StudentLoanServicerAddress.html +142 -0
- data/doc/rdoc/classes/Plaid/Models/StudentLoanStatus.html +118 -0
- data/doc/rdoc/classes/Plaid/Models/Transaction.html +265 -0
- data/doc/rdoc/classes/Plaid/Models/TransactionLocation.html +166 -0
- data/doc/rdoc/classes/Plaid/Models/TransactionPaymentMeta.html +167 -0
- data/doc/rdoc/classes/Plaid/Models/Warning.html +126 -0
- data/doc/rdoc/classes/Plaid/Models/WebhookVerificationKey.html +174 -0
- data/doc/rdoc/classes/Plaid/Models.html +506 -0
- data/doc/rdoc/classes/Plaid/MultipleInstitutionsResponse.html +119 -0
- data/doc/rdoc/classes/Plaid/Ocrolus/ProcessorToken.html +205 -0
- data/doc/rdoc/classes/Plaid/Ocrolus.html +151 -0
- data/doc/rdoc/classes/Plaid/PaymentCreateResponse.html +118 -0
- data/doc/rdoc/classes/Plaid/PaymentGetResponse.html +191 -0
- data/doc/rdoc/classes/Plaid/PaymentInitiation.html +570 -0
- data/doc/rdoc/classes/Plaid/PaymentListResponse.html +119 -0
- data/doc/rdoc/classes/Plaid/PaymentRecipientCreateResponse.html +110 -0
- data/doc/rdoc/classes/Plaid/PaymentRecipientGetResponse.html +142 -0
- data/doc/rdoc/classes/Plaid/PaymentRecipientListResponse.html +110 -0
- data/doc/rdoc/classes/Plaid/PaymentTokenCreateResponse.html +118 -0
- data/doc/rdoc/classes/Plaid/PlaidAPIError.html +260 -0
- data/doc/rdoc/classes/Plaid/PlaidError.html +96 -0
- data/doc/rdoc/classes/Plaid/PlaidServerError.html +96 -0
- data/doc/rdoc/classes/Plaid/Processor.html +143 -0
- data/doc/rdoc/classes/Plaid/ProcessorToken.html +219 -0
- data/doc/rdoc/classes/Plaid/ProcessorTokenResponse.html +110 -0
- data/doc/rdoc/classes/Plaid/PublicToken/CreateResponse.html +118 -0
- data/doc/rdoc/classes/Plaid/PublicToken/ExchangeResponse.html +118 -0
- data/doc/rdoc/classes/Plaid/PublicToken.html +283 -0
- data/doc/rdoc/classes/Plaid/RateLimitExceededError.html +97 -0
- data/doc/rdoc/classes/Plaid/Sandbox.html +119 -0
- data/doc/rdoc/classes/Plaid/SandboxItem/FireWebhookResponse.html +110 -0
- data/doc/rdoc/classes/Plaid/SandboxItem/ResetLoginResponse.html +110 -0
- data/doc/rdoc/classes/Plaid/SandboxItem.html +351 -0
- data/doc/rdoc/classes/Plaid/SandboxPublicToken/SandboxCreateResponse.html +118 -0
- data/doc/rdoc/classes/Plaid/SandboxPublicToken.html +249 -0
- data/doc/rdoc/classes/Plaid/SingleInstitutionResponse.html +111 -0
- data/doc/rdoc/classes/Plaid/Stripe/BankAccountToken/CreateResponse.html +110 -0
- data/doc/rdoc/classes/Plaid/Stripe/BankAccountToken.html +215 -0
- data/doc/rdoc/classes/Plaid/Stripe.html +151 -0
- data/doc/rdoc/classes/Plaid/SubproductMixin.html +179 -0
- data/doc/rdoc/classes/Plaid/Transactions/GetResponse.html +144 -0
- data/doc/rdoc/classes/Plaid/Transactions.html +302 -0
- data/doc/rdoc/classes/Plaid/Webhook/UpdateResponse.html +110 -0
- data/doc/rdoc/classes/Plaid/Webhook.html +214 -0
- data/doc/rdoc/classes/Plaid/Webhooks/WebhookVerificationKeyGetResponse.html +110 -0
- data/doc/rdoc/classes/Plaid/Webhooks.html +207 -0
- data/doc/rdoc/classes/Plaid.html +772 -0
- data/doc/rdoc/created.rid +28 -0
- data/doc/rdoc/css/github.css +123 -0
- data/doc/rdoc/css/main.css +333 -0
- data/doc/rdoc/css/panel.css +383 -0
- data/doc/rdoc/css/reset.css +48 -0
- data/doc/rdoc/favicon.ico +0 -0
- data/doc/rdoc/files/LICENSE_txt.html +98 -0
- data/doc/rdoc/files/README_md.html +388 -0
- data/doc/rdoc/files/lib/plaid/client_rb.html +121 -0
- data/doc/rdoc/files/lib/plaid/errors_rb.html +132 -0
- data/doc/rdoc/files/lib/plaid/middleware_rb.html +99 -0
- data/doc/rdoc/files/lib/plaid/models_rb.html +450 -0
- data/doc/rdoc/files/lib/plaid/products/accounts_rb.html +102 -0
- data/doc/rdoc/files/lib/plaid/products/asset_report_rb.html +132 -0
- data/doc/rdoc/files/lib/plaid/products/auth_rb.html +97 -0
- data/doc/rdoc/files/lib/plaid/products/base_product_rb.html +92 -0
- data/doc/rdoc/files/lib/plaid/products/categories_rb.html +92 -0
- data/doc/rdoc/files/lib/plaid/products/credit_details_rb.html +97 -0
- data/doc/rdoc/files/lib/plaid/products/deposit_switch_rb.html +102 -0
- data/doc/rdoc/files/lib/plaid/products/identity_rb.html +97 -0
- data/doc/rdoc/files/lib/plaid/products/income_rb.html +97 -0
- data/doc/rdoc/files/lib/plaid/products/institutions_rb.html +102 -0
- data/doc/rdoc/files/lib/plaid/products/investments_rb.html +120 -0
- data/doc/rdoc/files/lib/plaid/products/item_rb.html +142 -0
- data/doc/rdoc/files/lib/plaid/products/liabilities_rb.html +97 -0
- data/doc/rdoc/files/lib/plaid/products/link_token_rb.html +102 -0
- data/doc/rdoc/files/lib/plaid/products/payment_initiation_rb.html +127 -0
- data/doc/rdoc/files/lib/plaid/products/processor_rb.html +142 -0
- data/doc/rdoc/files/lib/plaid/products/sandbox_rb.html +117 -0
- data/doc/rdoc/files/lib/plaid/products/transactions_rb.html +105 -0
- data/doc/rdoc/files/lib/plaid/products/webhooks_rb.html +97 -0
- data/doc/rdoc/files/lib/plaid/version_rb.html +82 -0
- data/doc/rdoc/files/lib/plaid_rb.html +120 -0
- data/doc/rdoc/i/arrows.png +0 -0
- data/doc/rdoc/i/results_bg.png +0 -0
- data/doc/rdoc/i/tree_bg.png +0 -0
- data/doc/rdoc/index.html +13 -0
- data/doc/rdoc/js/highlight.pack.js +1 -0
- data/doc/rdoc/js/jquery-1.3.2.min.js +19 -0
- data/doc/rdoc/js/main.js +29 -0
- data/doc/rdoc/js/navigation.js +142 -0
- data/doc/rdoc/js/navigation.js.gz +0 -0
- data/doc/rdoc/js/search_index.js +1 -0
- data/doc/rdoc/js/search_index.js.gz +0 -0
- data/doc/rdoc/js/searchdoc.js +468 -0
- data/doc/rdoc/js/searcher.js +229 -0
- data/doc/rdoc/js/searcher.js.gz +0 -0
- data/doc/rdoc/panel/index.html +74 -0
- data/doc/rdoc/panel/links.html +60 -0
- data/doc/rdoc/panel/tree.js +1 -0
- data/lib/plaid/.DS_Store +0 -0
- data/lib/plaid/api/plaid_api.rb +2255 -801
- data/lib/plaid/api_client.rb +4 -3
- data/lib/plaid/api_error.rb +2 -2
- data/lib/plaid/configuration.rb +2 -2
- data/lib/plaid/models/account_access.rb +238 -0
- data/lib/plaid/models/account_assets.rb +20 -9
- data/lib/plaid/models/account_assets_all_of.rb +17 -5
- data/lib/plaid/models/account_balance.rb +21 -14
- data/lib/plaid/models/account_base.rb +5 -6
- data/lib/plaid/models/account_filter.rb +258 -0
- data/lib/plaid/models/account_filters_response.rb +2 -2
- data/lib/plaid/models/account_identity.rb +5 -6
- data/lib/plaid/models/account_identity_all_of.rb +2 -2
- data/lib/plaid/models/account_selection_cardinality.rb +38 -0
- data/lib/plaid/models/account_subtype.rb +8 -2
- data/lib/plaid/models/account_type.rb +2 -2
- data/lib/plaid/models/accounts_balance_get_request.rb +4 -4
- data/lib/plaid/models/accounts_balance_get_request_options.rb +16 -6
- data/lib/plaid/models/accounts_get_request.rb +4 -4
- data/lib/plaid/models/accounts_get_request_options.rb +2 -2
- data/lib/plaid/models/accounts_get_response.rb +2 -2
- data/lib/plaid/models/ach_class.rb +2 -2
- data/lib/plaid/models/address.rb +2 -3
- data/lib/plaid/models/address_data.rb +3 -7
- data/lib/plaid/models/{nullable_address_data.rb → address_data_nullable.rb} +6 -10
- data/lib/plaid/models/{nullable_address.rb → address_nullable.rb} +5 -6
- data/lib/plaid/models/application.rb +288 -0
- data/lib/plaid/models/application_get_request.rb +255 -0
- data/lib/plaid/models/application_get_response.rb +239 -0
- data/lib/plaid/models/apr.rb +2 -2
- data/lib/plaid/models/asset_report.rb +4 -4
- data/lib/plaid/models/asset_report_audit_copy_create_request.rb +4 -4
- data/lib/plaid/models/asset_report_audit_copy_create_response.rb +2 -2
- data/lib/plaid/models/asset_report_audit_copy_get_request.rb +4 -4
- data/lib/plaid/models/asset_report_audit_copy_remove_request.rb +4 -4
- data/lib/plaid/models/asset_report_audit_copy_remove_response.rb +2 -2
- data/lib/plaid/models/asset_report_create_request.rb +28 -4
- data/lib/plaid/models/asset_report_create_request_options.rb +2 -2
- data/lib/plaid/models/asset_report_create_response.rb +2 -2
- data/lib/plaid/models/asset_report_filter_request.rb +4 -4
- data/lib/plaid/models/asset_report_filter_response.rb +2 -2
- data/lib/plaid/models/asset_report_get_request.rb +5 -5
- data/lib/plaid/models/asset_report_get_response.rb +2 -2
- data/lib/plaid/models/asset_report_item.rb +4 -4
- data/lib/plaid/models/asset_report_pdf_get_request.rb +4 -4
- data/lib/plaid/models/asset_report_refresh_request.rb +6 -4
- data/lib/plaid/models/asset_report_refresh_request_options.rb +2 -2
- data/lib/plaid/models/asset_report_refresh_response.rb +2 -2
- data/lib/plaid/models/asset_report_remove_request.rb +4 -4
- data/lib/plaid/models/asset_report_remove_response.rb +2 -2
- data/lib/plaid/models/asset_report_transaction.rb +109 -188
- data/lib/plaid/models/asset_report_transaction_all_of.rb +7 -22
- data/lib/plaid/models/asset_report_user.rb +3 -3
- data/lib/plaid/models/assets_error_webhook.rb +2 -2
- data/lib/plaid/models/assets_product_ready_webhook.rb +2 -2
- data/lib/plaid/models/auth_get_numbers.rb +22 -2
- data/lib/plaid/models/auth_get_request.rb +4 -4
- data/lib/plaid/models/auth_get_request_options.rb +2 -2
- data/lib/plaid/models/auth_get_response.rb +2 -2
- data/lib/plaid/models/automatically_verified_webhook.rb +3 -3
- data/lib/plaid/models/bank_initiated_return_risk.rb +300 -0
- data/lib/plaid/models/bank_transfer.rb +13 -4
- data/lib/plaid/models/bank_transfer_balance.rb +2 -2
- data/lib/plaid/models/bank_transfer_balance_get_request.rb +5 -5
- data/lib/plaid/models/bank_transfer_balance_get_response.rb +3 -3
- data/lib/plaid/models/bank_transfer_cancel_request.rb +5 -5
- data/lib/plaid/models/bank_transfer_cancel_response.rb +3 -3
- data/lib/plaid/models/bank_transfer_create_request.rb +22 -7
- data/lib/plaid/models/bank_transfer_create_response.rb +3 -3
- data/lib/plaid/models/bank_transfer_direction.rb +3 -2
- data/lib/plaid/models/bank_transfer_event.rb +5 -3
- data/lib/plaid/models/bank_transfer_event_list_request.rb +24 -8
- data/lib/plaid/models/bank_transfer_event_list_response.rb +3 -3
- data/lib/plaid/models/bank_transfer_event_sync_request.rb +9 -5
- data/lib/plaid/models/bank_transfer_event_sync_response.rb +3 -3
- data/lib/plaid/models/bank_transfer_event_type.rb +2 -2
- data/lib/plaid/models/bank_transfer_failure.rb +3 -3
- data/lib/plaid/models/bank_transfer_get_request.rb +5 -5
- data/lib/plaid/models/bank_transfer_get_response.rb +3 -3
- data/lib/plaid/models/bank_transfer_list_request.rb +9 -5
- data/lib/plaid/models/bank_transfer_list_response.rb +3 -3
- data/lib/plaid/models/bank_transfer_migrate_account_request.rb +5 -5
- data/lib/plaid/models/bank_transfer_migrate_account_response.rb +3 -3
- data/lib/plaid/models/bank_transfer_network.rb +2 -2
- data/lib/plaid/models/bank_transfer_receiver_details.rb +4 -4
- data/lib/plaid/models/bank_transfer_status.rb +2 -2
- data/lib/plaid/models/bank_transfer_sweep.rb +316 -0
- data/lib/plaid/models/bank_transfer_sweep_account.rb +238 -0
- data/lib/plaid/models/bank_transfer_sweep_get_request.rb +277 -0
- data/lib/plaid/models/bank_transfer_sweep_get_response.rb +239 -0
- data/lib/plaid/models/bank_transfer_type.rb +2 -2
- data/lib/plaid/models/bank_transfer_user.rb +4 -4
- data/lib/plaid/models/bank_transfers_events_update_webhook.rb +240 -0
- data/lib/plaid/models/categories_get_response.rb +2 -2
- data/lib/plaid/models/category.rb +2 -2
- data/lib/plaid/models/cause.rb +2 -2
- data/lib/plaid/models/connected_application.rb +357 -0
- data/lib/plaid/models/country_code.rb +2 -2
- data/lib/plaid/models/credit_card_liability.rb +10 -29
- data/lib/plaid/models/credit_filter.rb +3 -3
- data/lib/plaid/models/customer_initiated_return_risk.rb +300 -0
- data/lib/plaid/models/deductions.rb +232 -0
- data/lib/plaid/models/default_update_webhook.rb +2 -2
- data/lib/plaid/models/deposit_switch_address_data.rb +2 -2
- data/lib/plaid/models/deposit_switch_alt_create_request.rb +62 -8
- data/lib/plaid/models/deposit_switch_alt_create_response.rb +2 -2
- data/lib/plaid/models/deposit_switch_create_request.rb +62 -8
- data/lib/plaid/models/deposit_switch_create_request_options.rb +251 -0
- data/lib/plaid/models/deposit_switch_create_response.rb +2 -2
- data/lib/plaid/models/deposit_switch_get_request.rb +4 -4
- data/lib/plaid/models/deposit_switch_get_response.rb +77 -10
- data/lib/plaid/models/deposit_switch_state_update_webhook.rb +250 -0
- data/lib/plaid/models/deposit_switch_target_account.rb +2 -2
- data/lib/plaid/models/deposit_switch_target_user.rb +2 -2
- data/lib/plaid/models/deposit_switch_token_create_request.rb +4 -4
- data/lib/plaid/models/deposit_switch_token_create_response.rb +3 -3
- data/lib/plaid/models/depository_filter.rb +3 -3
- data/lib/plaid/models/distribution_details.rb +263 -0
- data/lib/plaid/models/document_metadata.rb +240 -0
- data/lib/plaid/models/earnings.rb +232 -0
- data/lib/plaid/models/earnings_total.rb +304 -0
- data/lib/plaid/models/email.rb +2 -2
- data/lib/plaid/models/employee.rb +26 -13
- data/lib/plaid/models/employee_income_summary_field_string.rb +2 -2
- data/lib/plaid/models/employer.rb +8 -4
- data/lib/plaid/models/employer_income_summary_field_string.rb +2 -2
- data/lib/plaid/models/employers_search_request.rb +4 -4
- data/lib/plaid/models/employers_search_response.rb +2 -2
- data/lib/plaid/models/employment_details.rb +230 -0
- data/lib/plaid/models/error.rb +5 -12
- data/lib/plaid/models/external_payment_options.rb +296 -0
- data/lib/plaid/models/external_payment_refund_details.rb +245 -0
- data/lib/plaid/models/{external_payment_schedule.rb → external_payment_schedule_base.rb} +25 -29
- data/lib/plaid/models/external_payment_schedule_get.rb +23 -23
- data/lib/plaid/models/external_payment_schedule_request.rb +283 -0
- data/lib/plaid/models/health_incident.rb +21 -8
- data/lib/plaid/models/historical_balance.rb +5 -5
- data/lib/plaid/models/historical_update_webhook.rb +2 -2
- data/lib/plaid/models/holding.rb +5 -5
- data/lib/plaid/models/holdings_default_update_webhook.rb +2 -2
- data/lib/plaid/models/holdings_override.rb +289 -0
- data/lib/plaid/models/identity_get_request.rb +4 -4
- data/lib/plaid/models/identity_get_request_options.rb +2 -2
- data/lib/plaid/models/identity_get_response.rb +2 -2
- data/lib/plaid/models/incident_update.rb +6 -6
- data/lib/plaid/models/income_breakdown.rb +38 -3
- data/lib/plaid/models/income_summary.rb +27 -2
- data/lib/plaid/models/income_summary_field_number.rb +2 -2
- data/lib/plaid/models/income_summary_field_string.rb +2 -2
- data/lib/plaid/models/income_verification_create_request.rb +4 -4
- data/lib/plaid/models/income_verification_create_response.rb +2 -2
- data/lib/plaid/models/income_verification_documents_download_request.rb +20 -13
- data/lib/plaid/models/income_verification_documents_download_response.rb +2 -2
- data/lib/plaid/models/income_verification_paystub_get_request.rb +20 -13
- data/lib/plaid/models/income_verification_paystubs_get_request.rb +252 -0
- data/lib/plaid/models/income_verification_paystubs_get_response.rb +262 -0
- data/lib/plaid/models/income_verification_refresh_request.rb +252 -0
- data/lib/plaid/models/income_verification_refresh_response.rb +239 -0
- data/lib/plaid/models/income_verification_status_webhook.rb +3 -3
- data/lib/plaid/models/income_verification_summary_get_request.rb +20 -13
- data/lib/plaid/models/income_verification_summary_get_response.rb +13 -3
- data/lib/plaid/models/income_verification_taxforms_get_request.rb +252 -0
- data/lib/plaid/models/income_verification_taxforms_get_response.rb +263 -0
- data/lib/plaid/models/income_verification_webhook_status.rb +2 -2
- data/lib/plaid/models/inflow_model.rb +2 -2
- data/lib/plaid/models/initial_update_webhook.rb +2 -2
- data/lib/plaid/models/institution.rb +17 -7
- data/lib/plaid/models/institution_status.rb +31 -4
- data/lib/plaid/models/institutions_get_by_id_request.rb +4 -4
- data/lib/plaid/models/institutions_get_by_id_request_options.rb +18 -6
- data/lib/plaid/models/institutions_get_by_id_response.rb +2 -2
- data/lib/plaid/models/institutions_get_request.rb +27 -4
- data/lib/plaid/models/institutions_get_request_options.rb +19 -7
- data/lib/plaid/models/institutions_get_response.rb +3 -3
- data/lib/plaid/models/institutions_search_account_filter.rb +2 -2
- data/lib/plaid/models/institutions_search_payment_initiation_options.rb +220 -0
- data/lib/plaid/models/institutions_search_request.rb +26 -5
- data/lib/plaid/models/institutions_search_request_options.rb +23 -10
- data/lib/plaid/models/institutions_search_response.rb +2 -2
- data/lib/plaid/models/investment_filter.rb +3 -3
- data/lib/plaid/models/investment_holdings_get_request_options.rb +2 -2
- data/lib/plaid/models/investment_transaction.rb +9 -8
- data/lib/plaid/models/investments_default_update_webhook.rb +2 -2
- data/lib/plaid/models/investments_holdings_get_request.rb +4 -4
- data/lib/plaid/models/investments_holdings_get_response.rb +2 -2
- data/lib/plaid/models/investments_transactions_get_request.rb +4 -4
- data/lib/plaid/models/investments_transactions_get_request_options.rb +11 -7
- data/lib/plaid/models/investments_transactions_get_response.rb +2 -2
- data/lib/plaid/models/investments_transactions_override.rb +319 -0
- data/lib/plaid/models/item.rb +7 -7
- data/lib/plaid/models/item_access_token_invalidate_request.rb +4 -4
- data/lib/plaid/models/item_access_token_invalidate_response.rb +2 -2
- data/lib/plaid/models/item_application_list_request.rb +241 -0
- data/lib/plaid/models/item_application_list_response.rb +237 -0
- data/lib/plaid/models/item_application_list_user_auth.rb +232 -0
- data/lib/plaid/models/item_application_scopes_update_request.rb +298 -0
- data/lib/plaid/models/item_application_scopes_update_response.rb +225 -0
- data/lib/plaid/models/item_error_webhook.rb +2 -2
- data/lib/plaid/models/item_get_request.rb +4 -4
- data/lib/plaid/models/item_get_response.rb +7 -17
- data/lib/plaid/models/item_import_request.rb +25 -4
- data/lib/plaid/models/item_import_request_options.rb +2 -2
- data/lib/plaid/models/item_import_request_user_auth.rb +2 -2
- data/lib/plaid/models/item_import_response.rb +2 -2
- data/lib/plaid/models/item_product_ready_webhook.rb +2 -2
- data/lib/plaid/models/item_public_token_create_request.rb +4 -4
- data/lib/plaid/models/item_public_token_create_response.rb +2 -2
- data/lib/plaid/models/item_public_token_exchange_request.rb +4 -4
- data/lib/plaid/models/item_public_token_exchange_response.rb +2 -2
- data/lib/plaid/models/item_remove_request.rb +4 -4
- data/lib/plaid/models/item_remove_response.rb +2 -2
- data/lib/plaid/models/item_status.rb +8 -17
- data/lib/plaid/models/item_status_investments.rb +232 -0
- data/lib/plaid/models/{nullable_recipient_bacs.rb → item_status_last_webhook.rb} +23 -27
- data/lib/plaid/models/{nullable_item_status.rb → item_status_nullable.rb} +11 -20
- data/lib/plaid/models/item_status_transactions.rb +232 -0
- data/lib/plaid/models/item_webhook_update_request.rb +4 -4
- data/lib/plaid/models/item_webhook_update_response.rb +2 -2
- data/lib/plaid/models/jwk_public_key.rb +44 -2
- data/lib/plaid/models/jwt_header.rb +2 -2
- data/lib/plaid/models/liabilities_default_update_webhook.rb +299 -0
- data/lib/plaid/models/liabilities_get_request.rb +4 -4
- data/lib/plaid/models/liabilities_get_request_options.rb +2 -2
- data/lib/plaid/models/liabilities_get_response.rb +2 -2
- data/lib/plaid/models/liabilities_object.rb +5 -5
- data/lib/plaid/models/liability_override.rb +10 -27
- data/lib/plaid/models/link_token_account_filters.rb +3 -3
- data/lib/plaid/models/link_token_create_request.rb +61 -13
- data/lib/plaid/models/link_token_create_request_account_subtypes.rb +3 -3
- data/lib/plaid/models/{amount.rb → link_token_create_request_auth.rb} +25 -40
- data/lib/plaid/models/link_token_create_request_deposit_switch.rb +2 -2
- data/lib/plaid/models/link_token_create_request_income_verification.rb +3 -4
- data/lib/plaid/models/link_token_create_request_payment_initiation.rb +23 -2
- data/lib/plaid/models/link_token_create_request_user.rb +10 -10
- data/lib/plaid/models/link_token_create_response.rb +3 -3
- data/lib/plaid/models/{nullable_access_token.rb → link_token_eu_config.rb} +18 -7
- data/lib/plaid/models/link_token_get_metadata_response.rb +12 -2
- data/lib/plaid/models/link_token_get_request.rb +4 -4
- data/lib/plaid/models/link_token_get_response.rb +14 -4
- data/lib/plaid/models/loan_filter.rb +3 -3
- data/lib/plaid/models/location.rb +2 -2
- data/lib/plaid/models/meta.rb +2 -2
- data/lib/plaid/models/mfa.rb +2 -2
- data/lib/plaid/models/mortgage_interest_rate.rb +2 -2
- data/lib/plaid/models/mortgage_liability.rb +25 -11
- data/lib/plaid/models/mortgage_property_address.rb +2 -2
- data/lib/plaid/models/net_pay.rb +230 -0
- data/lib/plaid/models/numbers.rb +2 -42
- data/lib/plaid/models/numbers_ach.rb +4 -4
- data/lib/plaid/models/{nullable_numbers_ach.rb → numbers_ach_nullable.rb} +7 -7
- data/lib/plaid/models/numbers_bacs.rb +2 -2
- data/lib/plaid/models/{nullable_numbers_bacs.rb → numbers_bacs_nullable.rb} +5 -5
- data/lib/plaid/models/numbers_eft.rb +2 -2
- data/lib/plaid/models/{nullable_numbers_eft.rb → numbers_eft_nullable.rb} +5 -5
- data/lib/plaid/models/numbers_international.rb +2 -2
- data/lib/plaid/models/{nullable_numbers_international.rb → numbers_international_nullable.rb} +5 -5
- data/lib/plaid/models/override_account_type.rb +40 -0
- data/lib/plaid/models/override_accounts.rb +22 -4
- data/lib/plaid/models/owner.rb +3 -3
- data/lib/plaid/models/owner_override.rb +2 -2
- data/lib/plaid/models/pay.rb +258 -0
- data/lib/plaid/models/pay_frequency.rb +2 -2
- data/lib/plaid/models/pay_period_details.rb +8 -8
- data/lib/plaid/models/payment_amount.rb +49 -4
- data/lib/plaid/models/payment_initiation_address.rb +133 -2
- data/lib/plaid/models/payment_initiation_metadata.rb +267 -0
- data/lib/plaid/models/payment_initiation_optional_restriction_bacs.rb +288 -0
- data/lib/plaid/models/payment_initiation_payment.rb +413 -0
- data/lib/plaid/models/payment_initiation_payment_create_request.rb +70 -10
- data/lib/plaid/models/payment_initiation_payment_create_response.rb +36 -2
- data/lib/plaid/models/payment_initiation_payment_get_request.rb +25 -4
- data/lib/plaid/models/payment_initiation_payment_get_response.rb +90 -18
- data/lib/plaid/models/payment_initiation_payment_list_request.rb +18 -5
- data/lib/plaid/models/payment_initiation_payment_list_response.rb +5 -9
- data/lib/plaid/models/payment_initiation_payment_token_create_request.rb +25 -4
- data/lib/plaid/models/payment_initiation_payment_token_create_response.rb +4 -4
- data/lib/plaid/models/payment_initiation_recipient.rb +22 -13
- data/lib/plaid/models/payment_initiation_recipient_create_request.rb +53 -5
- data/lib/plaid/models/payment_initiation_recipient_create_response.rb +2 -2
- data/lib/plaid/models/payment_initiation_recipient_get_request.rb +25 -4
- data/lib/plaid/models/payment_initiation_recipient_get_response.rb +23 -4
- data/lib/plaid/models/payment_initiation_recipient_get_response_all_of.rb +219 -0
- data/lib/plaid/models/payment_initiation_recipient_list_request.rb +4 -4
- data/lib/plaid/models/payment_initiation_recipient_list_response.rb +2 -2
- data/lib/plaid/models/payment_initiation_standing_order_metadata.rb +257 -0
- data/lib/plaid/models/payment_meta.rb +3 -3
- data/lib/plaid/models/payment_schedule_interval.rb +37 -0
- data/lib/plaid/models/payment_status_update_webhook.rb +5 -5
- data/lib/plaid/models/paystub.rb +57 -26
- data/lib/plaid/models/paystub_address.rb +297 -0
- data/lib/plaid/models/paystub_deduction.rb +2 -2
- data/lib/plaid/models/paystub_details.rb +299 -0
- data/lib/plaid/models/paystub_employer.rb +229 -0
- data/lib/plaid/models/paystub_ytd_details.rb +5 -12
- data/lib/plaid/models/pending_expiration_webhook.rb +4 -4
- data/lib/plaid/models/phone_number.rb +12 -4
- data/lib/plaid/models/processor_apex_processor_token_create_request.rb +4 -4
- data/lib/plaid/models/processor_auth_get_request.rb +4 -4
- data/lib/plaid/models/processor_auth_get_response.rb +2 -2
- data/lib/plaid/models/processor_balance_get_request.rb +17 -8
- data/lib/plaid/models/processor_balance_get_request_options.rb +220 -0
- data/lib/plaid/models/processor_balance_get_response.rb +2 -2
- data/lib/plaid/models/processor_bank_transfer_create_request.rb +459 -0
- data/lib/plaid/models/processor_bank_transfer_create_response.rb +239 -0
- data/lib/plaid/models/processor_identity_get_request.rb +4 -4
- data/lib/plaid/models/processor_identity_get_response.rb +2 -2
- data/lib/plaid/models/processor_number.rb +6 -6
- data/lib/plaid/models/processor_stripe_bank_account_token_create_request.rb +4 -4
- data/lib/plaid/models/processor_stripe_bank_account_token_create_response.rb +2 -2
- data/lib/plaid/models/processor_token_create_request.rb +39 -5
- data/lib/plaid/models/processor_token_create_response.rb +2 -2
- data/lib/plaid/models/product_access.rb +262 -0
- data/lib/plaid/models/product_status.rb +5 -5
- data/lib/plaid/models/product_status_breakdown.rb +2 -3
- data/lib/plaid/models/products.rb +4 -2
- data/lib/plaid/models/projected_income_summary_field_number.rb +2 -2
- data/lib/plaid/models/pslf_status.rb +4 -4
- data/lib/plaid/models/recaptcha_required_error.rb +2 -2
- data/lib/plaid/models/recipient_bacs.rb +54 -2
- data/lib/plaid/models/recipient_bacs_nullable.rb +288 -0
- data/lib/plaid/models/requested_scopes.rb +261 -0
- data/lib/plaid/models/sandbox_bank_transfer_fire_webhook_request.rb +245 -0
- data/lib/plaid/models/sandbox_bank_transfer_fire_webhook_response.rb +225 -0
- data/lib/plaid/models/sandbox_bank_transfer_simulate_request.rb +5 -5
- data/lib/plaid/models/sandbox_bank_transfer_simulate_response.rb +3 -3
- data/lib/plaid/models/sandbox_income_fire_webhook_request.rb +309 -0
- data/lib/plaid/models/sandbox_income_fire_webhook_response.rb +225 -0
- data/lib/plaid/models/sandbox_item_fire_webhook_request.rb +9 -4
- data/lib/plaid/models/sandbox_item_fire_webhook_response.rb +2 -2
- data/lib/plaid/models/sandbox_item_reset_login_request.rb +4 -4
- data/lib/plaid/models/sandbox_item_reset_login_response.rb +2 -2
- data/lib/plaid/models/sandbox_item_set_verification_status_request.rb +4 -4
- data/lib/plaid/models/sandbox_item_set_verification_status_response.rb +2 -2
- data/lib/plaid/models/sandbox_oauth_select_accounts_request.rb +240 -0
- data/lib/plaid/models/sandbox_processor_token_create_request.rb +4 -4
- data/lib/plaid/models/sandbox_processor_token_create_request_options.rb +2 -2
- data/lib/plaid/models/sandbox_processor_token_create_response.rb +2 -2
- data/lib/plaid/models/sandbox_public_token_create_request.rb +25 -4
- data/lib/plaid/models/sandbox_public_token_create_request_options.rb +2 -2
- data/lib/plaid/models/sandbox_public_token_create_request_options_transactions.rb +5 -5
- data/lib/plaid/models/sandbox_public_token_create_response.rb +2 -2
- data/lib/plaid/models/sandbox_transfer_simulate_request.rb +270 -0
- data/lib/plaid/models/{income_verification_paystub_get_response.rb → sandbox_transfer_simulate_response.rb} +12 -16
- data/lib/plaid/models/scopes.rb +243 -0
- data/lib/plaid/models/scopes_context.rb +37 -0
- data/lib/plaid/models/scopes_nullable.rb +249 -0
- data/lib/plaid/models/security.rb +7 -10
- data/lib/plaid/models/security_override.rb +270 -0
- data/lib/plaid/models/sender_bacs_nullable.rb +288 -0
- data/lib/plaid/models/servicer_address_data.rb +2 -2
- data/lib/plaid/models/signal_address_data.rb +263 -0
- data/lib/plaid/models/signal_decision_report_request.rb +259 -0
- data/lib/plaid/models/signal_decision_report_response.rb +224 -0
- data/lib/plaid/models/signal_device.rb +232 -0
- data/lib/plaid/models/signal_evaluate_core_attributes.rb +584 -0
- data/lib/plaid/models/signal_evaluate_request.rb +355 -0
- data/lib/plaid/models/signal_evaluate_response.rb +252 -0
- data/lib/plaid/models/signal_person_name.rb +265 -0
- data/lib/plaid/models/signal_return_report_request.rb +259 -0
- data/lib/plaid/models/signal_return_report_response.rb +224 -0
- data/lib/plaid/models/signal_scores.rb +227 -0
- data/lib/plaid/models/signal_user.rb +252 -0
- data/lib/plaid/models/standalone_account_type.rb +2 -2
- data/lib/plaid/models/standalone_currency_code_list.rb +2 -2
- data/lib/plaid/models/standalone_investment_transaction_type.rb +4 -4
- data/lib/plaid/models/student_loan.rb +36 -27
- data/lib/plaid/models/student_loan_repayment_model.rb +2 -2
- data/lib/plaid/models/student_loan_status.rb +4 -4
- data/lib/plaid/models/student_repayment_plan.rb +4 -4
- data/lib/plaid/models/taxform.rb +233 -0
- data/lib/plaid/models/taxpayer_id.rb +257 -0
- data/lib/plaid/models/total.rb +284 -0
- data/lib/plaid/models/transaction.rb +178 -127
- data/lib/plaid/models/transaction_all_of.rb +323 -0
- data/lib/plaid/models/transaction_base.rb +436 -0
- data/lib/plaid/models/transaction_code.rb +2 -2
- data/lib/plaid/models/transaction_data.rb +4 -4
- data/lib/plaid/models/transaction_override.rb +23 -23
- data/lib/plaid/models/transactions_get_request.rb +4 -4
- data/lib/plaid/models/transactions_get_request_options.rb +23 -6
- data/lib/plaid/models/transactions_get_response.rb +2 -2
- data/lib/plaid/models/transactions_refresh_request.rb +4 -4
- data/lib/plaid/models/transactions_refresh_response.rb +2 -2
- data/lib/plaid/models/transactions_removed_webhook.rb +2 -2
- data/lib/plaid/models/transfer.rb +453 -0
- data/lib/plaid/models/transfer_authorization.rb +313 -0
- data/lib/plaid/models/transfer_authorization_create_request.rb +401 -0
- data/lib/plaid/models/transfer_authorization_create_response.rb +239 -0
- data/lib/plaid/models/transfer_authorization_decision_rationale.rb +274 -0
- data/lib/plaid/models/transfer_authorization_device.rb +230 -0
- data/lib/plaid/models/transfer_authorization_proposed_transfer.rb +342 -0
- data/lib/plaid/models/transfer_cancel_request.rb +245 -0
- data/lib/plaid/models/transfer_cancel_response.rb +225 -0
- data/lib/plaid/models/transfer_create_request.rb +489 -0
- data/lib/plaid/models/transfer_create_response.rb +239 -0
- data/lib/plaid/models/transfer_direction.rb +38 -0
- data/lib/plaid/models/transfer_event.rb +390 -0
- data/lib/plaid/models/transfer_event_list_request.rb +434 -0
- data/lib/plaid/models/transfer_event_list_response.rb +241 -0
- data/lib/plaid/models/transfer_event_sync_request.rb +305 -0
- data/lib/plaid/models/transfer_event_sync_response.rb +241 -0
- data/lib/plaid/models/transfer_event_type.rb +42 -0
- data/lib/plaid/models/transfer_failure.rb +231 -0
- data/lib/plaid/models/transfer_get_request.rb +245 -0
- data/lib/plaid/models/transfer_get_response.rb +239 -0
- data/lib/plaid/models/transfer_list_request.rb +340 -0
- data/lib/plaid/models/transfer_list_response.rb +241 -0
- data/lib/plaid/models/transfer_network.rb +37 -0
- data/lib/plaid/models/transfer_receiver_details.rb +255 -0
- data/lib/plaid/models/transfer_status.rb +40 -0
- data/lib/plaid/models/transfer_type.rb +37 -0
- data/lib/plaid/models/transfer_user_address_in_request.rb +260 -0
- data/lib/plaid/models/transfer_user_address_in_response.rb +265 -0
- data/lib/plaid/models/transfer_user_in_request.rb +254 -0
- data/lib/plaid/models/transfer_user_in_response.rb +257 -0
- data/lib/plaid/models/user_custom_password.rb +2 -2
- data/lib/plaid/models/user_permission_revoked_webhook.rb +2 -2
- data/lib/plaid/models/verification_expired_webhook.rb +3 -3
- data/lib/plaid/models/verification_refresh_status.rb +36 -0
- data/lib/plaid/models/verification_status.rb +2 -2
- data/lib/plaid/models/w2.rb +437 -0
- data/lib/plaid/models/w2_box12.rb +231 -0
- data/lib/plaid/models/w2_state_and_local_wages.rb +286 -0
- data/lib/plaid/models/warning.rb +36 -2
- data/lib/plaid/models/webhook_update_acknowledged_webhook.rb +2 -2
- data/lib/plaid/models/webhook_verification_key_get_request.rb +4 -4
- data/lib/plaid/models/webhook_verification_key_get_response.rb +2 -2
- data/lib/plaid/models/ytd_gross_income_summary_field_number.rb +2 -2
- data/lib/plaid/models/ytd_net_income_summary_field_number.rb +2 -2
- data/lib/plaid/version.rb +3 -3
- data/lib/plaid.rb +137 -15
- data/pkg/plaid-13.2.0.gem +0 -0
- data/pkg/plaid-14.0.0.beta.3.gem +0 -0
- data/pkg/plaid-14.0.0.beta.5.gem +0 -0
- data/pkg/plaid-14.0.0.gem +0 -0
- data/pkg/plaid-14.1.0.gem +0 -0
- data/plaid.gemspec +2 -2
- data/templates/ruby/api_client.mustache +3 -1
- data/templates/ruby/partial_model_generic.mustache +362 -0
- data/test/test_bank_transfers.rb +2 -2
- data/test/test_item.rb +0 -9
- data/test/test_payment_initiation.rb +2 -3
- data/test/test_processor.rb +1 -16
- metadata +365 -321
- data/docs/ACHClass.md +0 -15
- data/docs/APR.md +0 -24
- data/docs/AccountAssets.md +0 -40
- data/docs/AccountAssetsAllOf.md +0 -24
- data/docs/AccountBalance.md +0 -26
- data/docs/AccountBase.md +0 -32
- data/docs/AccountFiltersResponse.md +0 -24
- data/docs/AccountIdentity.md +0 -34
- data/docs/AccountIdentityAllOf.md +0 -18
- data/docs/AccountSubtype.md +0 -15
- data/docs/AccountType.md +0 -15
- data/docs/AccountsBalanceGetRequest.md +0 -24
- data/docs/AccountsBalanceGetRequestOptions.md +0 -18
- data/docs/AccountsGetRequest.md +0 -24
- data/docs/AccountsGetRequestOptions.md +0 -18
- data/docs/AccountsGetResponse.md +0 -22
- data/docs/Address.md +0 -20
- data/docs/AddressData.md +0 -26
- data/docs/Amount.md +0 -20
- data/docs/AssetReport.md +0 -28
- data/docs/AssetReportAuditCopyCreateRequest.md +0 -24
- data/docs/AssetReportAuditCopyCreateResponse.md +0 -20
- data/docs/AssetReportAuditCopyGetRequest.md +0 -22
- data/docs/AssetReportAuditCopyRemoveRequest.md +0 -22
- data/docs/AssetReportAuditCopyRemoveResponse.md +0 -20
- data/docs/AssetReportCreateRequest.md +0 -26
- data/docs/AssetReportCreateRequestOptions.md +0 -22
- data/docs/AssetReportCreateResponse.md +0 -22
- data/docs/AssetReportFilterRequest.md +0 -24
- data/docs/AssetReportFilterResponse.md +0 -22
- data/docs/AssetReportGetRequest.md +0 -24
- data/docs/AssetReportGetResponse.md +0 -22
- data/docs/AssetReportItem.md +0 -26
- data/docs/AssetReportPDFGetRequest.md +0 -22
- data/docs/AssetReportRefreshRequest.md +0 -26
- data/docs/AssetReportRefreshRequestOptions.md +0 -22
- data/docs/AssetReportRefreshResponse.md +0 -22
- data/docs/AssetReportRemoveRequest.md +0 -22
- data/docs/AssetReportRemoveResponse.md +0 -20
- data/docs/AssetReportTransaction.md +0 -62
- data/docs/AssetReportTransactionAllOf.md +0 -20
- data/docs/AssetReportUser.md +0 -30
- data/docs/AssetsErrorWebhook.md +0 -24
- data/docs/AssetsProductReadyWebhook.md +0 -22
- data/docs/AuthGetNumbers.md +0 -24
- data/docs/AuthGetRequest.md +0 -24
- data/docs/AuthGetRequestOptions.md +0 -18
- data/docs/AuthGetResponse.md +0 -24
- data/docs/AutomaticallyVerifiedWebhook.md +0 -24
- data/docs/BankTransfer.md +0 -50
- data/docs/BankTransferBalance.md +0 -20
- data/docs/BankTransferBalanceGetRequest.md +0 -22
- data/docs/BankTransferBalanceGetResponse.md +0 -22
- data/docs/BankTransferCancelRequest.md +0 -22
- data/docs/BankTransferCancelResponse.md +0 -18
- data/docs/BankTransferCreateRequest.md +0 -46
- data/docs/BankTransferCreateResponse.md +0 -20
- data/docs/BankTransferDirection.md +0 -15
- data/docs/BankTransferEvent.md +0 -40
- data/docs/BankTransferEventListRequest.md +0 -40
- data/docs/BankTransferEventListResponse.md +0 -20
- data/docs/BankTransferEventSyncRequest.md +0 -24
- data/docs/BankTransferEventSyncResponse.md +0 -20
- data/docs/BankTransferEventType.md +0 -15
- data/docs/BankTransferFailure.md +0 -20
- data/docs/BankTransferGetRequest.md +0 -22
- data/docs/BankTransferGetResponse.md +0 -20
- data/docs/BankTransferListRequest.md +0 -32
- data/docs/BankTransferListResponse.md +0 -20
- data/docs/BankTransferMigrateAccountRequest.md +0 -26
- data/docs/BankTransferMigrateAccountResponse.md +0 -22
- data/docs/BankTransferNetwork.md +0 -15
- data/docs/BankTransferReceiverDetails.md +0 -18
- data/docs/BankTransferStatus.md +0 -15
- data/docs/BankTransferType.md +0 -15
- data/docs/BankTransferUser.md +0 -22
- data/docs/CategoriesGetResponse.md +0 -20
- data/docs/Category.md +0 -22
- data/docs/Cause.md +0 -20
- data/docs/CountryCode.md +0 -15
- data/docs/CreditCardLiability.md +0 -34
- data/docs/CreditFilter.md +0 -18
- data/docs/DefaultUpdateWebhook.md +0 -26
- data/docs/DepositSwitchAddressData.md +0 -26
- data/docs/DepositSwitchAltCreateRequest.md +0 -24
- data/docs/DepositSwitchAltCreateResponse.md +0 -20
- data/docs/DepositSwitchCreateRequest.md +0 -24
- data/docs/DepositSwitchCreateResponse.md +0 -20
- data/docs/DepositSwitchGetRequest.md +0 -22
- data/docs/DepositSwitchGetResponse.md +0 -38
- data/docs/DepositSwitchTargetAccount.md +0 -24
- data/docs/DepositSwitchTargetUser.md +0 -28
- data/docs/DepositSwitchTokenCreateRequest.md +0 -22
- data/docs/DepositSwitchTokenCreateResponse.md +0 -22
- data/docs/DepositoryFilter.md +0 -18
- data/docs/Email.md +0 -22
- data/docs/Employee.md +0 -22
- data/docs/EmployeeIncomeSummaryFieldString.md +0 -20
- data/docs/Employer.md +0 -24
- data/docs/EmployerIncomeSummaryFieldString.md +0 -20
- data/docs/EmployersSearchRequest.md +0 -24
- data/docs/EmployersSearchResponse.md +0 -20
- data/docs/Error.md +0 -34
- data/docs/ExternalPaymentSchedule.md +0 -24
- data/docs/ExternalPaymentScheduleGet.md +0 -26
- data/docs/HealthIncident.md +0 -24
- data/docs/HistoricalBalance.md +0 -24
- data/docs/HistoricalUpdateWebhook.md +0 -26
- data/docs/Holding.md +0 -34
- data/docs/HoldingsDefaultUpdateWebhook.md +0 -28
- data/docs/IdentityGetRequest.md +0 -24
- data/docs/IdentityGetRequestOptions.md +0 -18
- data/docs/IdentityGetResponse.md +0 -22
- data/docs/IncidentUpdate.md +0 -22
- data/docs/IncomeBreakdown.md +0 -24
- data/docs/IncomeSummary.md +0 -30
- data/docs/IncomeSummaryFieldNumber.md +0 -20
- data/docs/IncomeSummaryFieldString.md +0 -20
- data/docs/IncomeVerificationCreateRequest.md +0 -22
- data/docs/IncomeVerificationCreateResponse.md +0 -20
- data/docs/IncomeVerificationDocumentsDownloadRequest.md +0 -22
- data/docs/IncomeVerificationDocumentsDownloadResponse.md +0 -18
- data/docs/IncomeVerificationPaystubGetRequest.md +0 -22
- data/docs/IncomeVerificationPaystubGetResponse.md +0 -20
- data/docs/IncomeVerificationStatusWebhook.md +0 -24
- data/docs/IncomeVerificationSummaryGetRequest.md +0 -22
- data/docs/IncomeVerificationSummaryGetResponse.md +0 -20
- data/docs/IncomeVerificationWebhookStatus.md +0 -18
- data/docs/InflowModel.md +0 -26
- data/docs/InitialUpdateWebhook.md +0 -26
- data/docs/Institution.md +0 -36
- data/docs/InstitutionStatus.md +0 -30
- data/docs/InstitutionsGetByIdRequest.md +0 -26
- data/docs/InstitutionsGetByIdRequestOptions.md +0 -20
- data/docs/InstitutionsGetByIdResponse.md +0 -20
- data/docs/InstitutionsGetRequest.md +0 -28
- data/docs/InstitutionsGetRequestOptions.md +0 -24
- data/docs/InstitutionsGetResponse.md +0 -22
- data/docs/InstitutionsSearchAccountFilter.md +0 -24
- data/docs/InstitutionsSearchRequest.md +0 -28
- data/docs/InstitutionsSearchRequestOptions.md +0 -22
- data/docs/InstitutionsSearchResponse.md +0 -20
- data/docs/InvestmentFilter.md +0 -18
- data/docs/InvestmentHoldingsGetRequestOptions.md +0 -18
- data/docs/InvestmentTransaction.md +0 -44
- data/docs/InvestmentsDefaultUpdateWebhook.md +0 -28
- data/docs/InvestmentsHoldingsGetRequest.md +0 -24
- data/docs/InvestmentsHoldingsGetResponse.md +0 -26
- data/docs/InvestmentsTransactionsGetRequest.md +0 -28
- data/docs/InvestmentsTransactionsGetRequestOptions.md +0 -22
- data/docs/InvestmentsTransactionsGetResponse.md +0 -28
- data/docs/Item.md +0 -32
- data/docs/ItemAccessTokenInvalidateRequest.md +0 -22
- data/docs/ItemAccessTokenInvalidateResponse.md +0 -20
- data/docs/ItemErrorWebhook.md +0 -24
- data/docs/ItemGetRequest.md +0 -22
- data/docs/ItemGetResponse.md +0 -24
- data/docs/ItemImportRequest.md +0 -26
- data/docs/ItemImportRequestOptions.md +0 -18
- data/docs/ItemImportRequestUserAuth.md +0 -20
- data/docs/ItemImportResponse.md +0 -20
- data/docs/ItemProductReadyWebhook.md +0 -24
- data/docs/ItemPublicTokenCreateRequest.md +0 -22
- data/docs/ItemPublicTokenCreateResponse.md +0 -22
- data/docs/ItemPublicTokenExchangeRequest.md +0 -22
- data/docs/ItemPublicTokenExchangeResponse.md +0 -22
- data/docs/ItemRemoveRequest.md +0 -22
- data/docs/ItemRemoveResponse.md +0 -18
- data/docs/ItemStatus.md +0 -22
- data/docs/ItemWebhookUpdateRequest.md +0 -24
- data/docs/ItemWebhookUpdateResponse.md +0 -20
- data/docs/JWKPublicKey.md +0 -34
- data/docs/JWTHeader.md +0 -18
- data/docs/LiabilitiesGetRequest.md +0 -24
- data/docs/LiabilitiesGetRequestOptions.md +0 -18
- data/docs/LiabilitiesGetResponse.md +0 -24
- data/docs/LiabilitiesObject.md +0 -22
- data/docs/LiabilityOverride.md +0 -66
- data/docs/LinkTokenAccountFilters.md +0 -24
- data/docs/LinkTokenCreateRequest.md +0 -48
- data/docs/LinkTokenCreateRequestAccountSubtypes.md +0 -24
- data/docs/LinkTokenCreateRequestDepositSwitch.md +0 -18
- data/docs/LinkTokenCreateRequestIncomeVerification.md +0 -20
- data/docs/LinkTokenCreateRequestPaymentInitiation.md +0 -18
- data/docs/LinkTokenCreateRequestUser.md +0 -32
- data/docs/LinkTokenCreateResponse.md +0 -22
- data/docs/LinkTokenGetMetadataResponse.md +0 -30
- data/docs/LinkTokenGetRequest.md +0 -22
- data/docs/LinkTokenGetResponse.md +0 -26
- data/docs/LoanFilter.md +0 -18
- data/docs/Location.md +0 -32
- data/docs/MFA.md +0 -26
- data/docs/Meta.md +0 -22
- data/docs/MortgageInterestRate.md +0 -20
- data/docs/MortgageLiability.md +0 -56
- data/docs/MortgagePropertyAddress.md +0 -26
- data/docs/NullableAccessToken.md +0 -15
- data/docs/NullableAddress.md +0 -20
- data/docs/NullableAddressData.md +0 -26
- data/docs/NullableItemStatus.md +0 -22
- data/docs/NullableNumbersACH.md +0 -24
- data/docs/NullableNumbersBACS.md +0 -22
- data/docs/NullableNumbersEFT.md +0 -24
- data/docs/NullableNumbersInternational.md +0 -22
- data/docs/NullableRecipientBACS.md +0 -20
- data/docs/Numbers.md +0 -32
- data/docs/NumbersACH.md +0 -24
- data/docs/NumbersBACS.md +0 -22
- data/docs/NumbersEFT.md +0 -24
- data/docs/NumbersInternational.md +0 -22
- data/docs/OverrideAccounts.md +0 -38
- data/docs/Owner.md +0 -24
- data/docs/OwnerOverride.md +0 -24
- data/docs/PSLFStatus.md +0 -22
- data/docs/PayFrequency.md +0 -20
- data/docs/PayPeriodDetails.md +0 -26
- data/docs/PaymentAmount.md +0 -20
- data/docs/PaymentInitiationAddress.md +0 -24
- data/docs/PaymentInitiationPaymentCreateRequest.md +0 -28
- data/docs/PaymentInitiationPaymentCreateResponse.md +0 -22
- data/docs/PaymentInitiationPaymentGetRequest.md +0 -22
- data/docs/PaymentInitiationPaymentGetResponse.md +0 -34
- data/docs/PaymentInitiationPaymentListRequest.md +0 -24
- data/docs/PaymentInitiationPaymentListResponse.md +0 -22
- data/docs/PaymentInitiationPaymentTokenCreateRequest.md +0 -22
- data/docs/PaymentInitiationPaymentTokenCreateResponse.md +0 -22
- data/docs/PaymentInitiationRecipient.md +0 -26
- data/docs/PaymentInitiationRecipientCreateRequest.md +0 -28
- data/docs/PaymentInitiationRecipientCreateResponse.md +0 -20
- data/docs/PaymentInitiationRecipientGetRequest.md +0 -22
- data/docs/PaymentInitiationRecipientGetResponse.md +0 -28
- data/docs/PaymentInitiationRecipientListRequest.md +0 -20
- data/docs/PaymentInitiationRecipientListResponse.md +0 -20
- data/docs/PaymentMeta.md +0 -32
- data/docs/PaymentStatusUpdateWebhook.md +0 -38
- data/docs/Paystub.md +0 -30
- data/docs/PaystubDeduction.md +0 -22
- data/docs/PaystubYTDDetails.md +0 -20
- data/docs/PendingExpirationWebhook.md +0 -24
- data/docs/PhoneNumber.md +0 -22
- data/docs/PlaidApi.md +0 -5580
- data/docs/ProcessorApexProcessorTokenCreateRequest.md +0 -24
- data/docs/ProcessorAuthGetRequest.md +0 -22
- data/docs/ProcessorAuthGetResponse.md +0 -22
- data/docs/ProcessorBalanceGetRequest.md +0 -22
- data/docs/ProcessorBalanceGetResponse.md +0 -20
- data/docs/ProcessorIdentityGetRequest.md +0 -22
- data/docs/ProcessorIdentityGetResponse.md +0 -20
- data/docs/ProcessorNumber.md +0 -24
- data/docs/ProcessorStripeBankAccountTokenCreateRequest.md +0 -24
- data/docs/ProcessorStripeBankAccountTokenCreateResponse.md +0 -20
- data/docs/ProcessorTokenCreateRequest.md +0 -26
- data/docs/ProcessorTokenCreateResponse.md +0 -20
- data/docs/ProductStatus.md +0 -22
- data/docs/ProductStatusBreakdown.md +0 -24
- data/docs/Products.md +0 -15
- data/docs/ProjectedIncomeSummaryFieldNumber.md +0 -20
- data/docs/RecaptchaRequiredError.md +0 -30
- data/docs/RecipientBACS.md +0 -20
- data/docs/SandboxBankTransferSimulateRequest.md +0 -26
- data/docs/SandboxBankTransferSimulateResponse.md +0 -18
- data/docs/SandboxItemFireWebhookRequest.md +0 -24
- data/docs/SandboxItemFireWebhookResponse.md +0 -20
- data/docs/SandboxItemResetLoginRequest.md +0 -22
- data/docs/SandboxItemResetLoginResponse.md +0 -20
- data/docs/SandboxItemSetVerificationStatusRequest.md +0 -26
- data/docs/SandboxItemSetVerificationStatusResponse.md +0 -18
- data/docs/SandboxProcessorTokenCreateRequest.md +0 -24
- data/docs/SandboxProcessorTokenCreateRequestOptions.md +0 -20
- data/docs/SandboxProcessorTokenCreateResponse.md +0 -20
- data/docs/SandboxPublicTokenCreateRequest.md +0 -26
- data/docs/SandboxPublicTokenCreateRequestOptions.md +0 -24
- data/docs/SandboxPublicTokenCreateRequestOptionsTransactions.md +0 -20
- data/docs/SandboxPublicTokenCreateResponse.md +0 -20
- data/docs/Security.md +0 -46
- data/docs/ServicerAddressData.md +0 -26
- data/docs/StandaloneAccountType.md +0 -26
- data/docs/StandaloneCurrencyCodeList.md +0 -20
- data/docs/StandaloneInvestmentTransactionSubtype.md +0 -104
- data/docs/StandaloneInvestmentTransactionType.md +0 -28
- data/docs/StudentLoan.md +0 -66
- data/docs/StudentLoanRepaymentModel.md +0 -22
- data/docs/StudentLoanStatus.md +0 -20
- data/docs/StudentRepaymentPlan.md +0 -20
- data/docs/Transaction.md +0 -58
- data/docs/TransactionCode.md +0 -15
- data/docs/TransactionData.md +0 -26
- data/docs/TransactionOverride.md +0 -26
- data/docs/TransactionsGetRequest.md +0 -28
- data/docs/TransactionsGetRequestOptions.md +0 -22
- data/docs/TransactionsGetResponse.md +0 -26
- data/docs/TransactionsRefreshRequest.md +0 -22
- data/docs/TransactionsRefreshResponse.md +0 -18
- data/docs/TransactionsRemovedWebhook.md +0 -26
- data/docs/UserCustomPassword.md +0 -28
- data/docs/UserPermissionRevokedWebhook.md +0 -24
- data/docs/VerificationExpiredWebhook.md +0 -24
- data/docs/VerificationStatus.md +0 -15
- data/docs/Warning.md +0 -22
- data/docs/WebhookUpdateAcknowledgedWebhook.md +0 -26
- data/docs/WebhookVerificationKeyGetRequest.md +0 -22
- data/docs/WebhookVerificationKeyGetResponse.md +0 -20
- data/docs/YTDGrossIncomeSummaryFieldNumber.md +0 -20
- data/docs/YTDNetIncomeSummaryFieldNumber.md +0 -20
- data/lib/plaid/models/standalone_investment_transaction_subtype.rb +0 -650
|
@@ -0,0 +1,388 @@
|
|
|
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>README.md</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
|
+
</head>
|
|
16
|
+
|
|
17
|
+
<body>
|
|
18
|
+
<div class="banner">
|
|
19
|
+
|
|
20
|
+
<h1>
|
|
21
|
+
README.md
|
|
22
|
+
</h1>
|
|
23
|
+
<ul class="files">
|
|
24
|
+
<li>README.md</li>
|
|
25
|
+
<li>Last modified: 2021-05-14 13:48:06 -0700</li>
|
|
26
|
+
</ul>
|
|
27
|
+
</div>
|
|
28
|
+
|
|
29
|
+
<div id="bodyContent">
|
|
30
|
+
<div id="content">
|
|
31
|
+
|
|
32
|
+
<div class="description">
|
|
33
|
+
|
|
34
|
+
<h1 id="label-plaid-ruby+rdoc-image-3Ahttps-3A-2F-2Fcircleci.com-2Fgh-2Fplaid-2Fplaid-ruby.svg-3Fstyle-3Dsvg-26circle-token-3D30ee002ac2021da5b5b5a701d45fe2888af124a5+rdoc-image-3Ahttps-3A-2F-2Fbadge.fury.io-2Frb-2Fplaid.svg">plaid-ruby <a href="https://circleci.com/gh/plaid/plaid-ruby"><img src="https://circleci.com/gh/plaid/plaid-ruby.svg?style=svg&circle-token=30ee002ac2021da5b5b5a701d45fe2888af124a5"></a> <a href="http://badge.fury.io/rb/plaid"><img src="https://badge.fury.io/rb/plaid.svg"></a></h1>
|
|
35
|
+
|
|
36
|
+
<p>:warning: After 7/12/21, this major version of the library will only
|
|
37
|
+
receive critical security patches. Please consider trying out our new <a
|
|
38
|
+
href="https://github.com/plaid/plaid-ruby/tree/14.0.0-beta-release">beta
|
|
39
|
+
version</a>.</p>
|
|
40
|
+
|
|
41
|
+
<p>The official Ruby bindings for the <a href="https://plaid.com/docs">Plaid
|
|
42
|
+
API</a>.</p>
|
|
43
|
+
|
|
44
|
+
<h2 id="label-Installation">Installation</h2>
|
|
45
|
+
|
|
46
|
+
<p>Add this line to your application's Gemfile:</p>
|
|
47
|
+
|
|
48
|
+
<pre><code>gem 'plaid'
|
|
49
|
+
</code></pre>
|
|
50
|
+
|
|
51
|
+
<p>And then execute:</p>
|
|
52
|
+
|
|
53
|
+
<pre><code>$ bundle
|
|
54
|
+
</code></pre>
|
|
55
|
+
|
|
56
|
+
<p>Or install it yourself as:</p>
|
|
57
|
+
|
|
58
|
+
<pre><code>$ gem install plaid
|
|
59
|
+
</code></pre>
|
|
60
|
+
|
|
61
|
+
<p>The gem supports Ruby 2.2+ only.</p>
|
|
62
|
+
|
|
63
|
+
<h3 id="label-Versioning">Versioning</h3>
|
|
64
|
+
|
|
65
|
+
<p>Each major version of <code>plaid-ruby</code> targets a specific version of
|
|
66
|
+
the <a href="../classes/Plaid.html">Plaid</a> API:</p>
|
|
67
|
+
|
|
68
|
+
<p>| API version | plaid-ruby release | | ———– | —————— | | <a
|
|
69
|
+
href="https://plaid.com/docs/api/versioning/#2020-09-14">2020-09-14</a>
|
|
70
|
+
(<strong>latest</strong>) | <code>12.x.x</code> | | <a
|
|
71
|
+
href="https://plaid.com/docs/api/versioning/#2019-05-29">2019-05-29</a>
|
|
72
|
+
(<strong>latest</strong>) | <code>11.x.x</code>, <code>10.x.x</code>,
|
|
73
|
+
<code>9.x.x</code>, <code>8.x.x</code>, <code>7.x.x</code> | | <a
|
|
74
|
+
href="https://plaid.com/docs/api/versioning/#2018-05-22">2018-05-22</a> |
|
|
75
|
+
<code>6.x.x</code> | | <code>2017-03-08</code> | <code>5.x.x</code> |</p>
|
|
76
|
+
|
|
77
|
+
<p>For information about what has changed between versions and how to update
|
|
78
|
+
your integration, head to the <a
|
|
79
|
+
href="https://plaid.com/docs/api/versioning/">version changelog</a>.</p>
|
|
80
|
+
|
|
81
|
+
<h2 id="label-Usage">Usage</h2>
|
|
82
|
+
|
|
83
|
+
<p>This gem wraps the <a href="../classes/Plaid.html">Plaid</a> API, which is
|
|
84
|
+
fully described in the <a
|
|
85
|
+
href="https://plaid.com/docs/api">documentation</a>.</p>
|
|
86
|
+
|
|
87
|
+
<p>The RubyDoc for the gem is available <a
|
|
88
|
+
href="http://plaid.github.io/plaid-ruby/">here</a>.</p>
|
|
89
|
+
|
|
90
|
+
<h3 id="label-Creating+a+Plaid+client">Creating a <a href="../classes/Plaid.html">Plaid</a> client</h3>
|
|
91
|
+
|
|
92
|
+
<p>Create an instance of the client using the <code>client_id</code> and
|
|
93
|
+
<code>secret</code> from your <a href="../classes/Plaid.html">Plaid</a>
|
|
94
|
+
dashboard along with your environment of choice:</p>
|
|
95
|
+
|
|
96
|
+
<pre><code>require 'plaid'
|
|
97
|
+
|
|
98
|
+
client = Plaid::Client.new(env: :sandbox,
|
|
99
|
+
client_id: '***',
|
|
100
|
+
secret: '***')
|
|
101
|
+
</code></pre>
|
|
102
|
+
|
|
103
|
+
<p>The <code>env</code> field is the environment which the client will be
|
|
104
|
+
running in. Your choices for the <code>env</code> field include:</p>
|
|
105
|
+
<ul><li>
|
|
106
|
+
<p><code>:sandbox</code> allows you to do your initial integrations tests
|
|
107
|
+
against preloaded data without being billed or making expensive API calls.
|
|
108
|
+
More information about using the API sandbox can be found on the <a
|
|
109
|
+
href="https://plaid.com/docs/api#sandbox">API Sandbox documentation</a>.</p>
|
|
110
|
+
</li><li>
|
|
111
|
+
<p><code>:development</code> allows you to test against both real and test
|
|
112
|
+
accounts without being billed. More information about <a
|
|
113
|
+
href="../classes/Plaid.html">Plaid</a> test accounts can be found in our <a
|
|
114
|
+
href="https://plaid.com/docs/api/#sandbox">API documentation</a>.</p>
|
|
115
|
+
</li><li>
|
|
116
|
+
<p><code>:production</code> is the production environment where you can launch
|
|
117
|
+
your production ready application and be charged for your <a
|
|
118
|
+
href="../classes/Plaid.html">Plaid</a> usage.</p>
|
|
119
|
+
</li></ul>
|
|
120
|
+
|
|
121
|
+
<h3 id="label-Tuning+Faraday">Tuning Faraday</h3>
|
|
122
|
+
|
|
123
|
+
<p>The gem uses Faraday to wrap HTTPS connections, which allows you to tune
|
|
124
|
+
certain params:</p>
|
|
125
|
+
|
|
126
|
+
<pre><code>client = Plaid::Client.new(env: :sandbox, client_id: '***', secret: '***') do |builder|
|
|
127
|
+
Plaid::Client.build_default_connection(builder)
|
|
128
|
+
|
|
129
|
+
# Increase network timeout
|
|
130
|
+
builder.options[:timeout] = 60*20 # 20 minutes
|
|
131
|
+
end
|
|
132
|
+
</code></pre>
|
|
133
|
+
|
|
134
|
+
<h2 id="label-Examples">Examples</h2>
|
|
135
|
+
|
|
136
|
+
<h3 id="label-Create+a+new+link_token">Create a new link_token</h3>
|
|
137
|
+
|
|
138
|
+
<pre><code># Grab the client_user_id by searching for the current user in your database
|
|
139
|
+
user = User.find_by!(email: '***')
|
|
140
|
+
client_user_id = user.id
|
|
141
|
+
|
|
142
|
+
# Create the link_token with all of your configurations
|
|
143
|
+
link_token_response = client.link_token.create(
|
|
144
|
+
user: { client_user_id: client_user_id.to_s },
|
|
145
|
+
client_name: 'My app',
|
|
146
|
+
products: %w[auth transactions],
|
|
147
|
+
country_codes: ['US'],
|
|
148
|
+
language: 'en'
|
|
149
|
+
)
|
|
150
|
+
|
|
151
|
+
# Pass the result to your client-side app to initialize Link
|
|
152
|
+
# and retrieve a public_token
|
|
153
|
+
link_token = link_token_response.link_token
|
|
154
|
+
</code></pre>
|
|
155
|
+
|
|
156
|
+
<h3 id="label-Exchanging+a+Link+public_token+for+a+Plaid+access_token">Exchanging a Link public_token for a <a href="../classes/Plaid.html">Plaid</a> access_token</h3>
|
|
157
|
+
|
|
158
|
+
<p>If you have a <a href="https://github.com/plaid/link">Link</a> <code>public
|
|
159
|
+
token</code>, use this function to get an <code>access_token</code>:
|
|
160
|
+
<code>client.item.public_token.exchange(public_token)</code></p>
|
|
161
|
+
|
|
162
|
+
<p>An example of the function's usage if you have a
|
|
163
|
+
<code>public_token</code> in hand:</p>
|
|
164
|
+
|
|
165
|
+
<pre><code>response = client.item.public_token.exchange(public_token)
|
|
166
|
+
access_token = response.access_token
|
|
167
|
+
</code></pre>
|
|
168
|
+
|
|
169
|
+
<h3 id="label-Deleting+an+item">Deleting an item</h3>
|
|
170
|
+
|
|
171
|
+
<pre><code>require 'plaid'
|
|
172
|
+
|
|
173
|
+
client = Plaid::Client.new(env: :sandbox,
|
|
174
|
+
client_id: '***',
|
|
175
|
+
secret: '***')
|
|
176
|
+
|
|
177
|
+
exchange_token_response = client.item.public_token.exchange('[Plaid Link public_token]')
|
|
178
|
+
access_token = exchange_token_response.access_token
|
|
179
|
+
|
|
180
|
+
# Provide the access_token for the Item you want to remove
|
|
181
|
+
client.item.remove(access_token)
|
|
182
|
+
</code></pre>
|
|
183
|
+
|
|
184
|
+
<h3 id="label-Get+paginated+transactions">Get paginated transactions</h3>
|
|
185
|
+
|
|
186
|
+
<pre><code>require 'plaid'
|
|
187
|
+
|
|
188
|
+
client = Plaid::Client.new(env: :sandbox,
|
|
189
|
+
client_id: '***',
|
|
190
|
+
secret: '***')
|
|
191
|
+
|
|
192
|
+
exchange_token_response = client.item.public_token.exchange('[Plaid Link public_token]')
|
|
193
|
+
access_token = exchange_token_response.access_token
|
|
194
|
+
|
|
195
|
+
transaction_response = client.transactions.get(access_token, '2016-07-12', '2017-01-09')
|
|
196
|
+
transactions = transaction_response.transactions
|
|
197
|
+
|
|
198
|
+
# the transactions in the response are paginated, so make multiple calls while
|
|
199
|
+
# increasing the offset to retrieve all transactions
|
|
200
|
+
while transactions.length < transaction_response['total_transactions']
|
|
201
|
+
transaction_response = client.transactions.get(access_token,
|
|
202
|
+
'2016-07-12',
|
|
203
|
+
'2017-01-09',
|
|
204
|
+
offset: transactions.length)
|
|
205
|
+
transactions += transaction_response.transactions
|
|
206
|
+
end
|
|
207
|
+
</code></pre>
|
|
208
|
+
|
|
209
|
+
<h3 id="label-Obtaining+Item-related+data">Obtaining Item-related data</h3>
|
|
210
|
+
|
|
211
|
+
<p>If you have an <code>access_token</code>, you can use following code to
|
|
212
|
+
retreive data: “`ruby require 'plaid'</p>
|
|
213
|
+
|
|
214
|
+
<p>client = <a
|
|
215
|
+
href="../classes/Plaid/Client.html#method-c-new">Plaid::Client.new</a>(env:
|
|
216
|
+
:sandbox, client_id: '<strong><em>', secret:
|
|
217
|
+
'</em></strong>')</p>
|
|
218
|
+
|
|
219
|
+
<p>exchange_token_response = client.item.public_token.exchange('[Plaid
|
|
220
|
+
Link public_token]') access_token =
|
|
221
|
+
exchange_token_response.access_token</p>
|
|
222
|
+
|
|
223
|
+
<p>auth_response = client.auth.get(access_token) auth = auth_response.auth “`</p>
|
|
224
|
+
|
|
225
|
+
<h3 id="label-Create+a+Stripe+bank_account_token">Create a Stripe bank_account_token</h3>
|
|
226
|
+
|
|
227
|
+
<p>Exchange a <a href="../classes/Plaid.html">Plaid</a> Link
|
|
228
|
+
<code>public_token</code> for an API <code>access_token</code> and a Stripe
|
|
229
|
+
<code>bank_account_token</code>: “`ruby require 'plaid'</p>
|
|
230
|
+
|
|
231
|
+
<p>client = <a
|
|
232
|
+
href="../classes/Plaid/Client.html#method-c-new">Plaid::Client.new</a>(env:
|
|
233
|
+
:sandbox, client_id: '<strong><em>', secret:
|
|
234
|
+
'</em></strong>')</p>
|
|
235
|
+
|
|
236
|
+
<p>exchange_token_response = client.item.public_token.exchange('[Plaid
|
|
237
|
+
Link public_token]') access_token =
|
|
238
|
+
exchange_token_response.access_token</p>
|
|
239
|
+
|
|
240
|
+
<p>stripe_response =
|
|
241
|
+
client.processor.stripe.bank_account_token.create(access_token,
|
|
242
|
+
'[Account ID]') bank_account_token =
|
|
243
|
+
stripe_response.stripe_bank_account_token “`</p>
|
|
244
|
+
|
|
245
|
+
<p>There are also a number of other methods you can use to retrieve data:</p>
|
|
246
|
+
<ul><li>
|
|
247
|
+
<p><code>client.accounts.get(access_token, ...)</code>: accounts</p>
|
|
248
|
+
</li><li>
|
|
249
|
+
<p><code>client.accounts.balance.get(access_token, ...)</code>: real-time
|
|
250
|
+
balances</p>
|
|
251
|
+
</li><li>
|
|
252
|
+
<p><code>client.auth.get(access_token, ...)</code>: auth</p>
|
|
253
|
+
</li><li>
|
|
254
|
+
<p><code>client.identity.get(access_token, ...)</code>: identity</p>
|
|
255
|
+
</li><li>
|
|
256
|
+
<p><code>client.transactions.get(access_token, ...)</code>: transactions</p>
|
|
257
|
+
</li><li>
|
|
258
|
+
<p><code>client.credit_details.get(access_token, ...)</code>: credit details</p>
|
|
259
|
+
</li><li>
|
|
260
|
+
<p><code>client.investments.transactions.get(access_token, ...)</code>:
|
|
261
|
+
investment-account transactions</p>
|
|
262
|
+
</li><li>
|
|
263
|
+
<p><code>client.investments.holdings.get(access_token, ...)</code>:
|
|
264
|
+
investment-account holdings</p>
|
|
265
|
+
</li></ul>
|
|
266
|
+
|
|
267
|
+
<p>All of these methods return appropriate data. More information can be found
|
|
268
|
+
on the <a href="https://plaid.com/docs/api">API documentation</a>.</p>
|
|
269
|
+
|
|
270
|
+
<h3 id="label-Categories">Categories</h3>
|
|
271
|
+
|
|
272
|
+
<p>You can request category information:</p>
|
|
273
|
+
|
|
274
|
+
<pre><code>categories = client.categories.get # Array of all known categories
|
|
275
|
+
</code></pre>
|
|
276
|
+
|
|
277
|
+
<h3 id="label-Institutions">Institutions</h3>
|
|
278
|
+
|
|
279
|
+
<p>Financial institution information is available as shown below where the
|
|
280
|
+
function arguments represent count and offset:</p>
|
|
281
|
+
|
|
282
|
+
<pre><code>institutions = client.institutions.get(count: 3, offset: 1)
|
|
283
|
+
</code></pre>
|
|
284
|
+
|
|
285
|
+
<h2 id="label-Errors">Errors</h2>
|
|
286
|
+
|
|
287
|
+
<p>Any methods making API calls will result in an exception raised unless the
|
|
288
|
+
response code is “200: Success” or “210: MFA Required”.</p>
|
|
289
|
+
|
|
290
|
+
<p><code>Plaid::InvalidRequestError</code> is returned when the request is
|
|
291
|
+
malformed and cannot be processed.</p>
|
|
292
|
+
|
|
293
|
+
<p><code>Plaid::InvalidInputError</code> is returned when all fields are
|
|
294
|
+
provided and are in the correct format, but the values provided are
|
|
295
|
+
incorrect in some way.</p>
|
|
296
|
+
|
|
297
|
+
<p><code>Plaid::RateLimitExceededError</code> returned when the request is
|
|
298
|
+
valid but has exceeded established rate limits.</p>
|
|
299
|
+
|
|
300
|
+
<p><code>Plaid::APIError</code> is returned during planned maintenance windows
|
|
301
|
+
and in response to API internal server errors.</p>
|
|
302
|
+
|
|
303
|
+
<p><code>Plaid::ItemError</code> indicates that information provided for the
|
|
304
|
+
Item (such as credentials or MFA) may be invalid or that the Item is not
|
|
305
|
+
supported on Plaid's platform.</p>
|
|
306
|
+
|
|
307
|
+
<p><code>Plaid::InstitutionError</code> is returned when there are errors for
|
|
308
|
+
the requested financial institution.</p>
|
|
309
|
+
|
|
310
|
+
<p>Read more about response codes and their meaning in the <a
|
|
311
|
+
href="https://plaid.com/docs/api">Plaid documentation</a>.</p>
|
|
312
|
+
|
|
313
|
+
<h2 id="label-Response+Objects">Response Objects</h2>
|
|
314
|
+
|
|
315
|
+
<p>Any API call returns a response object which is accessible by dot notation
|
|
316
|
+
(<code>response.foo.bar</code>) or Symbols and Strings as keys:
|
|
317
|
+
<code>response[:foo][:bar]</code> and
|
|
318
|
+
<code>response['foo']['bar']</code>. Expected keys for all types of
|
|
319
|
+
responses are defined, and any attempt to access an unknown key will cause
|
|
320
|
+
<code>NoMethodError</code> exception.</p>
|
|
321
|
+
|
|
322
|
+
<h2 id="label-Network+Timeout">Network Timeout</h2>
|
|
323
|
+
|
|
324
|
+
<p>A network timeout value is currently defaulted at 600 seconds = 10 minutes.
|
|
325
|
+
Some requests from the <a href="../classes/Plaid.html">Plaid</a> API may
|
|
326
|
+
take longer than others and we want to make sure that all valid requests
|
|
327
|
+
have a chance to complete. Adjust this value if necessary (see “Tuning
|
|
328
|
+
Faraday”).</p>
|
|
329
|
+
|
|
330
|
+
<h2 id="label-Contributing">Contributing</h2>
|
|
331
|
+
|
|
332
|
+
<p>Bug reports and pull requests are welcome on GitHub at <a
|
|
333
|
+
href="https://github.com/plaid/plaid-ruby">github.com/plaid/plaid-ruby</a>.
|
|
334
|
+
See also <a href="CONTRIBUTING.md">contributing guidelines</a>.</p>
|
|
335
|
+
|
|
336
|
+
<h2 id="label-License">License</h2>
|
|
337
|
+
|
|
338
|
+
<p>The gem is available as open source under the terms of the <a
|
|
339
|
+
href="http://opensource.org/licenses/MIT">MIT License</a>.</p>
|
|
340
|
+
|
|
341
|
+
<h3 id="label-Legacy+API">Legacy API</h3>
|
|
342
|
+
|
|
343
|
+
<p>If you're looking for a Ruby client that works with the legacy <a
|
|
344
|
+
href="../classes/Plaid.html">Plaid</a> API, use the <a
|
|
345
|
+
href="https://github.com/plaid/plaid-ruby-legacy">plaid-legacy gem</a>.</p>
|
|
346
|
+
|
|
347
|
+
</div>
|
|
348
|
+
|
|
349
|
+
|
|
350
|
+
|
|
351
|
+
|
|
352
|
+
|
|
353
|
+
|
|
354
|
+
|
|
355
|
+
|
|
356
|
+
|
|
357
|
+
|
|
358
|
+
|
|
359
|
+
|
|
360
|
+
|
|
361
|
+
|
|
362
|
+
|
|
363
|
+
|
|
364
|
+
|
|
365
|
+
|
|
366
|
+
|
|
367
|
+
|
|
368
|
+
|
|
369
|
+
|
|
370
|
+
|
|
371
|
+
|
|
372
|
+
|
|
373
|
+
|
|
374
|
+
|
|
375
|
+
|
|
376
|
+
|
|
377
|
+
|
|
378
|
+
|
|
379
|
+
<!-- Methods -->
|
|
380
|
+
|
|
381
|
+
|
|
382
|
+
|
|
383
|
+
|
|
384
|
+
</div>
|
|
385
|
+
|
|
386
|
+
</div>
|
|
387
|
+
</body>
|
|
388
|
+
</html>
|
|
@@ -0,0 +1,121 @@
|
|
|
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>client.rb</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
|
+
</head>
|
|
16
|
+
|
|
17
|
+
<body>
|
|
18
|
+
<div class="banner">
|
|
19
|
+
|
|
20
|
+
<h1>
|
|
21
|
+
client.rb
|
|
22
|
+
</h1>
|
|
23
|
+
<ul class="files">
|
|
24
|
+
<li>lib/plaid/client.rb</li>
|
|
25
|
+
<li>Last modified: 2021-05-14 13:48:06 -0700</li>
|
|
26
|
+
</ul>
|
|
27
|
+
</div>
|
|
28
|
+
|
|
29
|
+
<div id="bodyContent">
|
|
30
|
+
<div id="content">
|
|
31
|
+
|
|
32
|
+
<div class="description">
|
|
33
|
+
|
|
34
|
+
<p>The <a href="../../../classes/Plaid.html">Plaid</a> namespace.</p>
|
|
35
|
+
|
|
36
|
+
</div>
|
|
37
|
+
|
|
38
|
+
|
|
39
|
+
|
|
40
|
+
|
|
41
|
+
|
|
42
|
+
|
|
43
|
+
|
|
44
|
+
|
|
45
|
+
<!-- Sections -->
|
|
46
|
+
<div class="sectiontitle">Sections</div>
|
|
47
|
+
<ul>
|
|
48
|
+
|
|
49
|
+
<li><a href="#Public">Public</a></li>
|
|
50
|
+
|
|
51
|
+
</ul>
|
|
52
|
+
|
|
53
|
+
|
|
54
|
+
|
|
55
|
+
|
|
56
|
+
<!-- Namespace -->
|
|
57
|
+
<div class="sectiontitle">Namespace</div>
|
|
58
|
+
<ul>
|
|
59
|
+
|
|
60
|
+
<li>
|
|
61
|
+
<span class="type">MODULE</span>
|
|
62
|
+
<a href="../../../classes/Plaid.html">Plaid</a>
|
|
63
|
+
</li>
|
|
64
|
+
|
|
65
|
+
<li>
|
|
66
|
+
<span class="type">CLASS</span>
|
|
67
|
+
<a href="../../../classes/Plaid/Client.html">Plaid::Client</a>
|
|
68
|
+
</li>
|
|
69
|
+
|
|
70
|
+
</ul>
|
|
71
|
+
|
|
72
|
+
|
|
73
|
+
|
|
74
|
+
|
|
75
|
+
|
|
76
|
+
|
|
77
|
+
|
|
78
|
+
|
|
79
|
+
|
|
80
|
+
|
|
81
|
+
|
|
82
|
+
|
|
83
|
+
|
|
84
|
+
|
|
85
|
+
|
|
86
|
+
|
|
87
|
+
|
|
88
|
+
|
|
89
|
+
|
|
90
|
+
|
|
91
|
+
|
|
92
|
+
<!-- Methods -->
|
|
93
|
+
|
|
94
|
+
|
|
95
|
+
|
|
96
|
+
|
|
97
|
+
|
|
98
|
+
|
|
99
|
+
<div class="contenttitle" id="Public">
|
|
100
|
+
Public
|
|
101
|
+
</div>
|
|
102
|
+
|
|
103
|
+
|
|
104
|
+
|
|
105
|
+
|
|
106
|
+
|
|
107
|
+
|
|
108
|
+
|
|
109
|
+
|
|
110
|
+
|
|
111
|
+
|
|
112
|
+
<!-- Methods -->
|
|
113
|
+
|
|
114
|
+
|
|
115
|
+
|
|
116
|
+
|
|
117
|
+
</div>
|
|
118
|
+
|
|
119
|
+
</div>
|
|
120
|
+
</body>
|
|
121
|
+
</html>
|