plaid 13.2.0 → 14.0.0.beta.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +73 -9
- data/CONTRIBUTING.md +2 -32
- data/Dockerfile +11 -0
- data/Gemfile.lock +45 -40
- data/LICENSE.txt +1 -1
- data/PUBLISH.md +0 -1
- data/README.md +99 -93
- data/Rakefile +8 -79
- data/UPGRADING.md +4 -0
- data/docs/ACHClass.md +15 -0
- data/docs/APR.md +24 -0
- data/docs/AccountAssets.md +40 -0
- data/docs/AccountAssetsAllOf.md +24 -0
- data/docs/AccountBalance.md +26 -0
- data/docs/AccountBase.md +32 -0
- data/docs/AccountFiltersResponse.md +24 -0
- data/docs/AccountIdentity.md +34 -0
- data/docs/AccountIdentityAllOf.md +18 -0
- data/docs/AccountSubtype.md +15 -0
- data/docs/AccountType.md +15 -0
- data/docs/AccountsBalanceGetRequest.md +24 -0
- data/docs/AccountsBalanceGetRequestOptions.md +18 -0
- data/docs/AccountsGetRequest.md +24 -0
- data/docs/AccountsGetRequestOptions.md +18 -0
- data/docs/AccountsGetResponse.md +22 -0
- data/docs/Address.md +20 -0
- data/docs/AddressData.md +26 -0
- data/docs/Amount.md +20 -0
- data/docs/AssetReport.md +28 -0
- data/docs/AssetReportAuditCopyCreateRequest.md +24 -0
- data/docs/AssetReportAuditCopyCreateResponse.md +20 -0
- data/docs/AssetReportAuditCopyGetRequest.md +22 -0
- data/docs/AssetReportAuditCopyRemoveRequest.md +22 -0
- data/docs/AssetReportAuditCopyRemoveResponse.md +20 -0
- data/docs/AssetReportCreateRequest.md +26 -0
- data/docs/AssetReportCreateRequestOptions.md +22 -0
- data/docs/AssetReportCreateResponse.md +22 -0
- data/docs/AssetReportFilterRequest.md +24 -0
- data/docs/AssetReportFilterResponse.md +22 -0
- data/docs/AssetReportGetRequest.md +24 -0
- data/docs/AssetReportGetResponse.md +22 -0
- data/docs/AssetReportItem.md +26 -0
- data/docs/AssetReportPDFGetRequest.md +22 -0
- data/docs/AssetReportRefreshRequest.md +26 -0
- data/docs/AssetReportRefreshRequestOptions.md +22 -0
- data/docs/AssetReportRefreshResponse.md +22 -0
- data/docs/AssetReportRemoveRequest.md +22 -0
- data/docs/AssetReportRemoveResponse.md +20 -0
- data/docs/AssetReportTransaction.md +58 -0
- data/docs/AssetReportTransactionAllOf.md +20 -0
- data/docs/AssetReportUser.md +30 -0
- data/docs/AssetsErrorWebhook.md +24 -0
- data/docs/AssetsProductReadyWebhook.md +22 -0
- data/docs/AuthGetNumbers.md +24 -0
- data/docs/AuthGetRequest.md +24 -0
- data/docs/AuthGetRequestOptions.md +18 -0
- data/docs/AuthGetResponse.md +24 -0
- data/docs/AutomaticallyVerifiedWebhook.md +24 -0
- data/docs/BankTransfer.md +50 -0
- data/docs/BankTransferBalance.md +20 -0
- data/docs/BankTransferBalanceGetRequest.md +22 -0
- data/docs/BankTransferBalanceGetResponse.md +22 -0
- data/docs/BankTransferCancelRequest.md +22 -0
- data/docs/BankTransferCancelResponse.md +18 -0
- data/docs/BankTransferCreateRequest.md +46 -0
- data/docs/BankTransferCreateResponse.md +20 -0
- data/docs/BankTransferDirection.md +15 -0
- data/docs/BankTransferEvent.md +40 -0
- data/docs/BankTransferEventListRequest.md +40 -0
- data/docs/BankTransferEventListResponse.md +20 -0
- data/docs/BankTransferEventSyncRequest.md +24 -0
- data/docs/BankTransferEventSyncResponse.md +20 -0
- data/docs/BankTransferEventType.md +15 -0
- data/docs/BankTransferFailure.md +20 -0
- data/docs/BankTransferGetRequest.md +22 -0
- data/docs/BankTransferGetResponse.md +20 -0
- data/docs/BankTransferListRequest.md +32 -0
- data/docs/BankTransferListResponse.md +20 -0
- data/docs/BankTransferMigrateAccountRequest.md +26 -0
- data/docs/BankTransferMigrateAccountResponse.md +22 -0
- data/docs/BankTransferNetwork.md +15 -0
- data/docs/BankTransferReceiverDetails.md +18 -0
- data/docs/BankTransferStatus.md +15 -0
- data/docs/BankTransferType.md +15 -0
- data/docs/BankTransferUser.md +22 -0
- data/docs/CategoriesGetResponse.md +20 -0
- data/docs/Category.md +22 -0
- data/docs/Cause.md +20 -0
- data/docs/CountryCode.md +15 -0
- data/docs/CreditCardLiability.md +34 -0
- data/docs/CreditFilter.md +18 -0
- data/docs/DefaultUpdateWebhook.md +26 -0
- data/docs/DepositSwitchAddressData.md +26 -0
- data/docs/DepositSwitchAltCreateRequest.md +24 -0
- data/docs/DepositSwitchAltCreateResponse.md +20 -0
- data/docs/DepositSwitchCreateRequest.md +24 -0
- data/docs/DepositSwitchCreateResponse.md +20 -0
- data/docs/DepositSwitchGetRequest.md +22 -0
- data/docs/DepositSwitchGetResponse.md +38 -0
- data/docs/DepositSwitchTargetAccount.md +24 -0
- data/docs/DepositSwitchTargetUser.md +28 -0
- data/docs/DepositSwitchTokenCreateRequest.md +22 -0
- data/docs/DepositSwitchTokenCreateResponse.md +22 -0
- data/docs/DepositoryFilter.md +18 -0
- data/docs/Email.md +22 -0
- data/docs/Employee.md +22 -0
- data/docs/EmployeeIncomeSummaryFieldString.md +20 -0
- data/docs/Employer.md +24 -0
- data/docs/EmployerIncomeSummaryFieldString.md +20 -0
- data/docs/EmployersSearchRequest.md +24 -0
- data/docs/EmployersSearchResponse.md +20 -0
- data/docs/Error.md +34 -0
- data/docs/ExternalPaymentSchedule.md +24 -0
- data/docs/HealthIncident.md +24 -0
- data/docs/HistoricalBalance.md +24 -0
- data/docs/HistoricalUpdateWebhook.md +26 -0
- data/docs/Holding.md +34 -0
- data/docs/HoldingsDefaultUpdateWebhook.md +28 -0
- data/docs/IdentityGetRequest.md +24 -0
- data/docs/IdentityGetRequestOptions.md +18 -0
- data/docs/IdentityGetResponse.md +22 -0
- data/docs/IncidentUpdate.md +22 -0
- data/docs/IncomeBreakdown.md +24 -0
- data/docs/IncomeSummary.md +30 -0
- data/docs/IncomeSummaryFieldNumber.md +20 -0
- data/docs/IncomeSummaryFieldString.md +20 -0
- data/docs/IncomeVerificationCreateRequest.md +22 -0
- data/docs/IncomeVerificationCreateResponse.md +20 -0
- data/docs/IncomeVerificationDocumentsDownloadRequest.md +22 -0
- data/docs/IncomeVerificationDocumentsDownloadResponse.md +18 -0
- data/docs/IncomeVerificationPaystubGetRequest.md +22 -0
- data/docs/IncomeVerificationPaystubGetResponse.md +20 -0
- data/docs/IncomeVerificationStatusWebhook.md +24 -0
- data/docs/IncomeVerificationSummaryGetRequest.md +22 -0
- data/docs/IncomeVerificationSummaryGetResponse.md +20 -0
- data/docs/IncomeVerificationWebhookStatus.md +18 -0
- data/docs/InflowModel.md +26 -0
- data/docs/InitialUpdateWebhook.md +26 -0
- data/docs/Institution.md +36 -0
- data/docs/InstitutionStatus.md +30 -0
- data/docs/InstitutionsGetByIdRequest.md +26 -0
- data/docs/InstitutionsGetByIdRequestOptions.md +20 -0
- data/docs/InstitutionsGetByIdResponse.md +20 -0
- data/docs/InstitutionsGetRequest.md +28 -0
- data/docs/InstitutionsGetRequestOptions.md +24 -0
- data/docs/InstitutionsGetResponse.md +22 -0
- data/docs/InstitutionsSearchAccountFilter.md +24 -0
- data/docs/InstitutionsSearchRequest.md +28 -0
- data/docs/InstitutionsSearchRequestOptions.md +22 -0
- data/docs/InstitutionsSearchResponse.md +20 -0
- data/docs/InvestmentFilter.md +18 -0
- data/docs/InvestmentHoldingsGetRequestOptions.md +18 -0
- data/docs/InvestmentTransaction.md +44 -0
- data/docs/InvestmentsDefaultUpdateWebhook.md +28 -0
- data/docs/InvestmentsHoldingsGetRequest.md +24 -0
- data/docs/InvestmentsHoldingsGetResponse.md +26 -0
- data/docs/InvestmentsTransactionsGetRequest.md +28 -0
- data/docs/InvestmentsTransactionsGetRequestOptions.md +22 -0
- data/docs/InvestmentsTransactionsGetResponse.md +28 -0
- data/docs/Item.md +32 -0
- data/docs/ItemAccessTokenInvalidateRequest.md +22 -0
- data/docs/ItemAccessTokenInvalidateResponse.md +20 -0
- data/docs/ItemErrorWebhook.md +24 -0
- data/docs/ItemGetRequest.md +22 -0
- data/docs/ItemGetResponse.md +24 -0
- data/docs/ItemImportRequest.md +26 -0
- data/docs/ItemImportRequestOptions.md +18 -0
- data/docs/ItemImportRequestUserAuth.md +20 -0
- data/docs/ItemImportResponse.md +20 -0
- data/docs/ItemProductReadyWebhook.md +24 -0
- data/docs/ItemPublicTokenCreateRequest.md +22 -0
- data/docs/ItemPublicTokenCreateResponse.md +22 -0
- data/docs/ItemPublicTokenExchangeRequest.md +22 -0
- data/docs/ItemPublicTokenExchangeResponse.md +22 -0
- data/docs/ItemRemoveRequest.md +22 -0
- data/docs/ItemRemoveResponse.md +18 -0
- data/docs/ItemStatus.md +22 -0
- data/docs/ItemStatusInvestments.md +20 -0
- data/docs/ItemStatusLastWebhook.md +20 -0
- data/docs/ItemStatusTransactions.md +20 -0
- data/docs/ItemWebhookUpdateRequest.md +24 -0
- data/docs/ItemWebhookUpdateResponse.md +20 -0
- data/docs/JWKPublicKey.md +34 -0
- data/docs/JWTHeader.md +18 -0
- data/docs/LiabilitiesGetRequest.md +24 -0
- data/docs/LiabilitiesGetRequestOptions.md +18 -0
- data/docs/LiabilitiesGetResponse.md +24 -0
- data/docs/LiabilitiesObject.md +22 -0
- data/docs/LiabilityOverride.md +66 -0
- data/docs/LinkTokenAccountFilters.md +24 -0
- data/docs/LinkTokenCreateRequest.md +48 -0
- data/docs/LinkTokenCreateRequestAccountSubtypes.md +24 -0
- data/docs/LinkTokenCreateRequestAccountSubtypesCredit.md +18 -0
- data/docs/LinkTokenCreateRequestAccountSubtypesDepository.md +18 -0
- data/docs/LinkTokenCreateRequestAccountSubtypesInvestment.md +18 -0
- data/docs/LinkTokenCreateRequestAccountSubtypesLoan.md +18 -0
- data/docs/LinkTokenCreateRequestDepositSwitch.md +18 -0
- data/docs/LinkTokenCreateRequestIncomeVerification.md +20 -0
- data/docs/LinkTokenCreateRequestPaymentInitiation.md +18 -0
- data/docs/LinkTokenCreateRequestUser.md +32 -0
- data/docs/LinkTokenCreateResponse.md +22 -0
- data/docs/LinkTokenGetMetadataResponse.md +30 -0
- data/docs/LinkTokenGetRequest.md +22 -0
- data/docs/LinkTokenGetResponse.md +26 -0
- data/docs/LoanFilter.md +18 -0
- data/docs/Location.md +32 -0
- data/docs/MFA.md +26 -0
- data/docs/Meta.md +22 -0
- data/docs/MortgageInterestRate.md +20 -0
- data/docs/MortgageLiability.md +56 -0
- data/docs/MortgagePropertyAddress.md +26 -0
- data/docs/NullableAccessToken.md +15 -0
- data/docs/NullableAddress.md +20 -0
- data/docs/NullableAddressData.md +26 -0
- data/docs/NullableItemStatus.md +22 -0
- data/docs/NullableNumbersACH.md +24 -0
- data/docs/NullableNumbersBACS.md +22 -0
- data/docs/NullableNumbersEFT.md +24 -0
- data/docs/NullableNumbersInternational.md +22 -0
- data/docs/NullableRecipientBACS.md +20 -0
- data/docs/Numbers.md +32 -0
- data/docs/NumbersACH.md +24 -0
- data/docs/NumbersBACS.md +22 -0
- data/docs/NumbersEFT.md +24 -0
- data/docs/NumbersInternational.md +22 -0
- data/docs/OverrideAccounts.md +38 -0
- data/docs/Owner.md +24 -0
- data/docs/OwnerOverride.md +24 -0
- data/docs/PSLFStatus.md +22 -0
- data/docs/PayFrequency.md +20 -0
- data/docs/PayPeriodDetails.md +26 -0
- data/docs/PaymentAmount.md +20 -0
- data/docs/PaymentInitiationAddress.md +24 -0
- data/docs/PaymentInitiationPaymentCreateRequest.md +28 -0
- data/docs/PaymentInitiationPaymentCreateResponse.md +22 -0
- data/docs/PaymentInitiationPaymentGetRequest.md +22 -0
- data/docs/PaymentInitiationPaymentGetResponse.md +32 -0
- data/docs/PaymentInitiationPaymentListRequest.md +24 -0
- data/docs/PaymentInitiationPaymentListResponse.md +22 -0
- data/docs/PaymentInitiationPaymentTokenCreateRequest.md +22 -0
- data/docs/PaymentInitiationPaymentTokenCreateResponse.md +22 -0
- data/docs/PaymentInitiationRecipient.md +26 -0
- data/docs/PaymentInitiationRecipientBacs.md +20 -0
- data/docs/PaymentInitiationRecipientCreateRequest.md +28 -0
- data/docs/PaymentInitiationRecipientCreateResponse.md +20 -0
- data/docs/PaymentInitiationRecipientGetRequest.md +22 -0
- data/docs/PaymentInitiationRecipientGetResponse.md +28 -0
- data/docs/PaymentInitiationRecipientListRequest.md +20 -0
- data/docs/PaymentInitiationRecipientListResponse.md +20 -0
- data/docs/PaymentMeta.md +32 -0
- data/docs/PaymentStatusUpdateWebhook.md +30 -0
- data/docs/Paystub.md +30 -0
- data/docs/PaystubDeduction.md +22 -0
- data/docs/PaystubYTDDetails.md +20 -0
- data/docs/PendingExpirationWebhook.md +24 -0
- data/docs/PhoneNumber.md +22 -0
- data/docs/PlaidApi.md +5580 -0
- data/docs/ProcessorApexProcessorTokenCreateRequest.md +24 -0
- data/docs/ProcessorAuthGetRequest.md +22 -0
- data/docs/ProcessorAuthGetResponse.md +22 -0
- data/docs/ProcessorBalanceGetRequest.md +22 -0
- data/docs/ProcessorBalanceGetResponse.md +20 -0
- data/docs/ProcessorIdentityGetRequest.md +22 -0
- data/docs/ProcessorIdentityGetResponse.md +20 -0
- data/docs/ProcessorNumber.md +24 -0
- data/docs/ProcessorStripeBankAccountTokenCreateRequest.md +24 -0
- data/docs/ProcessorStripeBankAccountTokenCreateResponse.md +20 -0
- data/docs/ProcessorTokenCreateRequest.md +26 -0
- data/docs/ProcessorTokenCreateResponse.md +20 -0
- data/docs/ProductStatus.md +22 -0
- data/docs/ProductStatusBreakdown.md +24 -0
- data/docs/Products.md +15 -0
- data/docs/ProjectedIncomeSummaryFieldNumber.md +20 -0
- data/docs/RecaptchaRequiredError.md +30 -0
- data/docs/RecipientBACS.md +20 -0
- data/docs/SandboxBankTransferSimulateRequest.md +26 -0
- data/docs/SandboxBankTransferSimulateResponse.md +18 -0
- data/docs/SandboxItemFireWebhookRequest.md +24 -0
- data/docs/SandboxItemFireWebhookResponse.md +20 -0
- data/docs/SandboxItemResetLoginRequest.md +22 -0
- data/docs/SandboxItemResetLoginResponse.md +20 -0
- data/docs/SandboxItemSetVerificationStatusRequest.md +26 -0
- data/docs/SandboxItemSetVerificationStatusResponse.md +18 -0
- data/docs/SandboxProcessorTokenCreateRequest.md +24 -0
- data/docs/SandboxProcessorTokenCreateRequestOptions.md +20 -0
- data/docs/SandboxProcessorTokenCreateResponse.md +20 -0
- data/docs/SandboxPublicTokenCreateRequest.md +26 -0
- data/docs/SandboxPublicTokenCreateRequestOptions.md +24 -0
- data/docs/SandboxPublicTokenCreateRequestOptionsTransactions.md +20 -0
- data/docs/SandboxPublicTokenCreateResponse.md +20 -0
- data/docs/Security.md +46 -0
- data/docs/ServicerAddressData.md +26 -0
- data/docs/StandaloneAccountType.md +26 -0
- data/docs/StandaloneCurrencyCodeList.md +20 -0
- data/docs/StandaloneInvestmentTransactionSubtype.md +104 -0
- data/docs/StandaloneInvestmentTransactionType.md +28 -0
- data/docs/StudentLoan.md +66 -0
- data/docs/StudentLoanRepaymentModel.md +22 -0
- data/docs/StudentLoanStatus.md +20 -0
- data/docs/StudentRepaymentPlan.md +20 -0
- data/docs/Transaction.md +54 -0
- data/docs/TransactionCode.md +15 -0
- data/docs/TransactionData.md +26 -0
- data/docs/TransactionOverride.md +26 -0
- data/docs/TransactionsGetRequest.md +28 -0
- data/docs/TransactionsGetRequestOptions.md +22 -0
- data/docs/TransactionsGetResponse.md +26 -0
- data/docs/TransactionsRefreshRequest.md +22 -0
- data/docs/TransactionsRefreshResponse.md +18 -0
- data/docs/TransactionsRemovedWebhook.md +26 -0
- data/docs/UserCustomPassword.md +28 -0
- data/docs/UserPermissionRevokedWebhook.md +24 -0
- data/docs/VerificationExpiredWebhook.md +24 -0
- data/docs/VerificationStatus.md +15 -0
- data/docs/Warning.md +22 -0
- data/docs/WebhookUpdateAcknowledgedWebhook.md +26 -0
- data/docs/WebhookVerificationKeyGetRequest.md +22 -0
- data/docs/WebhookVerificationKeyGetResponse.md +20 -0
- data/docs/YTDGrossIncomeSummaryFieldNumber.md +20 -0
- data/docs/YTDNetIncomeSummaryFieldNumber.md +20 -0
- data/lib/plaid.rb +343 -61
- data/lib/plaid/api/plaid_api.rb +4414 -0
- data/lib/plaid/api_client.rb +383 -0
- data/lib/plaid/api_error.rb +57 -0
- data/lib/plaid/configuration.rb +297 -0
- data/lib/plaid/models/account_assets.rb +406 -0
- data/lib/plaid/models/account_assets_all_of.rb +263 -0
- data/lib/plaid/models/account_balance.rb +269 -0
- data/lib/plaid/models/account_base.rb +345 -0
- data/lib/plaid/models/account_filters_response.rb +246 -0
- data/lib/plaid/models/account_identity.rb +369 -0
- data/lib/plaid/models/account_identity_all_of.rb +226 -0
- data/lib/plaid/models/account_subtype.rb +101 -0
- data/lib/plaid/models/account_type.rb +41 -0
- data/lib/plaid/models/accounts_balance_get_request.rb +254 -0
- data/lib/plaid/models/accounts_balance_get_request_options.rb +222 -0
- data/lib/plaid/models/accounts_get_request.rb +254 -0
- data/lib/plaid/models/accounts_get_request_options.rb +222 -0
- data/lib/plaid/models/accounts_get_response.rb +256 -0
- data/lib/plaid/models/ach_class.rb +50 -0
- data/lib/plaid/models/address.rb +235 -0
- data/lib/plaid/models/address_data.rb +277 -0
- data/lib/plaid/models/amount.rb +274 -0
- data/lib/plaid/models/apr.rb +296 -0
- data/lib/plaid/models/asset_report.rb +301 -0
- data/lib/plaid/models/asset_report_audit_copy_create_request.rb +260 -0
- data/lib/plaid/models/asset_report_audit_copy_create_response.rb +240 -0
- data/lib/plaid/models/asset_report_audit_copy_get_request.rb +245 -0
- data/lib/plaid/models/asset_report_audit_copy_remove_request.rb +245 -0
- data/lib/plaid/models/asset_report_audit_copy_remove_response.rb +240 -0
- data/lib/plaid/models/asset_report_create_request.rb +299 -0
- data/lib/plaid/models/asset_report_create_request_options.rb +239 -0
- data/lib/plaid/models/asset_report_create_response.rb +255 -0
- data/lib/plaid/models/asset_report_filter_request.rb +262 -0
- data/lib/plaid/models/asset_report_filter_response.rb +255 -0
- data/lib/plaid/models/asset_report_get_request.rb +255 -0
- data/lib/plaid/models/asset_report_get_response.rb +256 -0
- data/lib/plaid/models/asset_report_item.rb +287 -0
- data/lib/plaid/models/asset_report_pdf_get_request.rb +245 -0
- data/lib/plaid/models/asset_report_refresh_request.rb +288 -0
- data/lib/plaid/models/asset_report_refresh_request_options.rb +239 -0
- data/lib/plaid/models/asset_report_refresh_response.rb +255 -0
- data/lib/plaid/models/asset_report_remove_request.rb +245 -0
- data/lib/plaid/models/asset_report_remove_response.rb +240 -0
- data/lib/plaid/models/asset_report_transaction.rb +511 -0
- data/lib/plaid/models/asset_report_transaction_all_of.rb +235 -0
- data/lib/plaid/models/asset_report_user.rb +287 -0
- data/lib/plaid/models/assets_error_webhook.rb +265 -0
- data/lib/plaid/models/assets_product_ready_webhook.rb +255 -0
- data/lib/plaid/models/auth_get_numbers.rb +258 -0
- data/lib/plaid/models/auth_get_request.rb +254 -0
- data/lib/plaid/models/auth_get_request_options.rb +222 -0
- data/lib/plaid/models/auth_get_response.rb +270 -0
- data/lib/plaid/models/automatically_verified_webhook.rb +270 -0
- data/lib/plaid/models/bank_transfer.rb +444 -0
- data/lib/plaid/models/bank_transfer_balance.rb +239 -0
- data/lib/plaid/models/bank_transfer_balance_get_request.rb +241 -0
- data/lib/plaid/models/bank_transfer_balance_get_response.rb +250 -0
- data/lib/plaid/models/bank_transfer_cancel_request.rb +245 -0
- data/lib/plaid/models/bank_transfer_cancel_response.rb +225 -0
- data/lib/plaid/models/bank_transfer_create_request.rb +459 -0
- data/lib/plaid/models/bank_transfer_create_response.rb +239 -0
- data/lib/plaid/models/bank_transfer_direction.rb +37 -0
- data/lib/plaid/models/bank_transfer_event.rb +388 -0
- data/lib/plaid/models/bank_transfer_event_list_request.rb +418 -0
- data/lib/plaid/models/bank_transfer_event_list_response.rb +241 -0
- data/lib/plaid/models/bank_transfer_event_sync_request.rb +301 -0
- data/lib/plaid/models/bank_transfer_event_sync_response.rb +241 -0
- data/lib/plaid/models/bank_transfer_event_type.rb +42 -0
- data/lib/plaid/models/bank_transfer_failure.rb +231 -0
- data/lib/plaid/models/bank_transfer_get_request.rb +245 -0
- data/lib/plaid/models/bank_transfer_get_response.rb +239 -0
- data/lib/plaid/models/bank_transfer_list_request.rb +336 -0
- data/lib/plaid/models/bank_transfer_list_response.rb +241 -0
- data/lib/plaid/models/bank_transfer_migrate_account_request.rb +275 -0
- data/lib/plaid/models/bank_transfer_migrate_account_response.rb +255 -0
- data/lib/plaid/models/bank_transfer_network.rb +38 -0
- data/lib/plaid/models/bank_transfer_receiver_details.rb +255 -0
- data/lib/plaid/models/bank_transfer_status.rb +40 -0
- data/lib/plaid/models/bank_transfer_type.rb +37 -0
- data/lib/plaid/models/bank_transfer_user.rb +246 -0
- data/lib/plaid/models/categories_get_response.rb +242 -0
- data/lib/plaid/models/category.rb +257 -0
- data/lib/plaid/models/cause.rb +235 -0
- data/lib/plaid/models/country_code.rb +42 -0
- data/lib/plaid/models/credit_card_liability.rb +339 -0
- data/lib/plaid/models/credit_filter.rb +227 -0
- data/lib/plaid/models/default_update_webhook.rb +280 -0
- data/lib/plaid/models/deposit_switch_address_data.rb +285 -0
- data/lib/plaid/models/deposit_switch_alt_create_request.rb +258 -0
- data/lib/plaid/models/deposit_switch_alt_create_response.rb +240 -0
- data/lib/plaid/models/deposit_switch_create_request.rb +260 -0
- data/lib/plaid/models/deposit_switch_create_response.rb +240 -0
- data/lib/plaid/models/deposit_switch_get_request.rb +245 -0
- data/lib/plaid/models/deposit_switch_get_response.rb +381 -0
- data/lib/plaid/models/deposit_switch_target_account.rb +303 -0
- data/lib/plaid/models/deposit_switch_target_user.rb +288 -0
- data/lib/plaid/models/deposit_switch_token_create_request.rb +245 -0
- data/lib/plaid/models/deposit_switch_token_create_response.rb +255 -0
- data/lib/plaid/models/depository_filter.rb +227 -0
- data/lib/plaid/models/email.rb +289 -0
- data/lib/plaid/models/employee.rb +242 -0
- data/lib/plaid/models/employee_income_summary_field_string.rb +245 -0
- data/lib/plaid/models/employer.rb +261 -0
- data/lib/plaid/models/employer_income_summary_field_string.rb +245 -0
- data/lib/plaid/models/employers_search_request.rb +262 -0
- data/lib/plaid/models/employers_search_response.rb +242 -0
- data/lib/plaid/models/error.rb +360 -0
- data/lib/plaid/models/external_payment_schedule.rb +265 -0
- data/lib/plaid/models/health_incident.rb +253 -0
- data/lib/plaid/models/historical_balance.rb +262 -0
- data/lib/plaid/models/historical_update_webhook.rb +280 -0
- data/lib/plaid/models/holding.rb +329 -0
- data/lib/plaid/models/holdings_default_update_webhook.rb +295 -0
- data/lib/plaid/models/identity_get_request.rb +254 -0
- data/lib/plaid/models/identity_get_request_options.rb +222 -0
- data/lib/plaid/models/identity_get_response.rb +256 -0
- data/lib/plaid/models/incident_update.rb +273 -0
- data/lib/plaid/models/income_breakdown.rb +253 -0
- data/lib/plaid/models/income_summary.rb +275 -0
- data/lib/plaid/models/income_summary_field_number.rb +238 -0
- data/lib/plaid/models/income_summary_field_string.rb +238 -0
- data/lib/plaid/models/income_verification_create_request.rb +245 -0
- data/lib/plaid/models/income_verification_create_response.rb +240 -0
- data/lib/plaid/models/income_verification_documents_download_request.rb +245 -0
- data/lib/plaid/models/income_verification_documents_download_response.rb +224 -0
- data/lib/plaid/models/income_verification_paystub_get_request.rb +245 -0
- data/lib/plaid/models/income_verification_paystub_get_response.rb +229 -0
- data/lib/plaid/models/income_verification_status_webhook.rb +270 -0
- data/lib/plaid/models/income_verification_summary_get_request.rb +245 -0
- data/lib/plaid/models/income_verification_summary_get_response.rb +242 -0
- data/lib/plaid/models/income_verification_webhook_status.rb +223 -0
- data/lib/plaid/models/inflow_model.rb +285 -0
- data/lib/plaid/models/initial_update_webhook.rb +281 -0
- data/lib/plaid/models/institution.rb +344 -0
- data/lib/plaid/models/institution_status.rb +307 -0
- data/lib/plaid/models/institutions_get_by_id_request.rb +271 -0
- data/lib/plaid/models/institutions_get_by_id_request_options.rb +234 -0
- data/lib/plaid/models/institutions_get_by_id_response.rb +239 -0
- data/lib/plaid/models/institutions_get_request.rb +305 -0
- data/lib/plaid/models/institutions_get_request_options.rb +254 -0
- data/lib/plaid/models/institutions_get_response.rb +257 -0
- data/lib/plaid/models/institutions_search_account_filter.rb +253 -0
- data/lib/plaid/models/institutions_search_request.rb +288 -0
- data/lib/plaid/models/institutions_search_request_options.rb +239 -0
- data/lib/plaid/models/institutions_search_response.rb +242 -0
- data/lib/plaid/models/investment_filter.rb +227 -0
- data/lib/plaid/models/investment_holdings_get_request_options.rb +222 -0
- data/lib/plaid/models/investment_transaction.rb +445 -0
- data/lib/plaid/models/investments_default_update_webhook.rb +295 -0
- data/lib/plaid/models/investments_holdings_get_request.rb +254 -0
- data/lib/plaid/models/investments_holdings_get_response.rb +290 -0
- data/lib/plaid/models/investments_transactions_get_request.rb +284 -0
- data/lib/plaid/models/investments_transactions_get_request_options.rb +285 -0
- data/lib/plaid/models/investments_transactions_get_response.rb +305 -0
- data/lib/plaid/models/item.rb +311 -0
- data/lib/plaid/models/item_access_token_invalidate_request.rb +245 -0
- data/lib/plaid/models/item_access_token_invalidate_response.rb +240 -0
- data/lib/plaid/models/item_error_webhook.rb +265 -0
- data/lib/plaid/models/item_get_request.rb +245 -0
- data/lib/plaid/models/item_get_response.rb +259 -0
- data/lib/plaid/models/item_import_request.rb +270 -0
- data/lib/plaid/models/item_import_request_options.rb +220 -0
- data/lib/plaid/models/item_import_request_user_auth.rb +240 -0
- data/lib/plaid/models/item_import_response.rb +240 -0
- data/lib/plaid/models/item_product_ready_webhook.rb +265 -0
- data/lib/plaid/models/item_public_token_create_request.rb +245 -0
- data/lib/plaid/models/item_public_token_create_response.rb +249 -0
- data/lib/plaid/models/item_public_token_exchange_request.rb +245 -0
- data/lib/plaid/models/item_public_token_exchange_response.rb +255 -0
- data/lib/plaid/models/item_remove_request.rb +245 -0
- data/lib/plaid/models/item_remove_response.rb +225 -0
- data/lib/plaid/models/item_status.rb +240 -0
- data/lib/plaid/models/item_status_investments.rb +232 -0
- data/lib/plaid/models/item_status_last_webhook.rb +232 -0
- data/lib/plaid/models/item_status_transactions.rb +232 -0
- data/lib/plaid/models/item_webhook_update_request.rb +260 -0
- data/lib/plaid/models/item_webhook_update_response.rb +239 -0
- data/lib/plaid/models/jwk_public_key.rb +299 -0
- data/lib/plaid/models/jwt_header.rb +224 -0
- data/lib/plaid/models/liabilities_get_request.rb +254 -0
- data/lib/plaid/models/liabilities_get_request_options.rb +222 -0
- data/lib/plaid/models/liabilities_get_response.rb +270 -0
- data/lib/plaid/models/liabilities_object.rb +249 -0
- data/lib/plaid/models/liability_override.rb +583 -0
- data/lib/plaid/models/link_token_account_filters.rb +246 -0
- data/lib/plaid/models/link_token_create_request.rb +390 -0
- data/lib/plaid/models/link_token_create_request_account_subtypes.rb +246 -0
- data/lib/plaid/models/link_token_create_request_account_subtypes_credit.rb +222 -0
- data/lib/plaid/models/link_token_create_request_account_subtypes_depository.rb +222 -0
- data/lib/plaid/models/link_token_create_request_account_subtypes_investment.rb +222 -0
- data/lib/plaid/models/link_token_create_request_account_subtypes_loan.rb +222 -0
- data/lib/plaid/models/link_token_create_request_deposit_switch.rb +225 -0
- data/lib/plaid/models/link_token_create_request_income_verification.rb +236 -0
- data/lib/plaid/models/link_token_create_request_payment_initiation.rb +225 -0
- data/lib/plaid/models/link_token_create_request_user.rb +295 -0
- data/lib/plaid/models/link_token_create_response.rb +255 -0
- data/lib/plaid/models/link_token_get_metadata_response.rb +287 -0
- data/lib/plaid/models/link_token_get_request.rb +245 -0
- data/lib/plaid/models/link_token_get_response.rb +266 -0
- data/lib/plaid/models/loan_filter.rb +227 -0
- data/lib/plaid/models/location.rb +298 -0
- data/lib/plaid/models/meta.rb +255 -0
- data/lib/plaid/models/mfa.rb +285 -0
- data/lib/plaid/models/mortgage_interest_rate.rb +232 -0
- data/lib/plaid/models/mortgage_liability.rb +430 -0
- data/lib/plaid/models/mortgage_property_address.rb +265 -0
- data/lib/plaid/models/nullable_access_token.rb +209 -0
- data/lib/plaid/models/nullable_address.rb +241 -0
- data/lib/plaid/models/nullable_address_data.rb +283 -0
- data/lib/plaid/models/nullable_item_status.rb +246 -0
- data/lib/plaid/models/nullable_numbers_ach.rb +272 -0
- data/lib/plaid/models/nullable_numbers_bacs.rb +261 -0
- data/lib/plaid/models/nullable_numbers_eft.rb +276 -0
- data/lib/plaid/models/nullable_numbers_international.rb +261 -0
- data/lib/plaid/models/nullable_recipient_bacs.rb +236 -0
- data/lib/plaid/models/numbers.rb +330 -0
- data/lib/plaid/models/numbers_ach.rb +266 -0
- data/lib/plaid/models/numbers_bacs.rb +255 -0
- data/lib/plaid/models/numbers_eft.rb +270 -0
- data/lib/plaid/models/numbers_international.rb +255 -0
- data/lib/plaid/models/override_accounts.rb +366 -0
- data/lib/plaid/models/owner.rb +278 -0
- data/lib/plaid/models/owner_override.rb +278 -0
- data/lib/plaid/models/pay_frequency.rb +272 -0
- data/lib/plaid/models/pay_period_details.rb +265 -0
- data/lib/plaid/models/payment_amount.rb +240 -0
- data/lib/plaid/models/payment_initiation_address.rb +252 -0
- data/lib/plaid/models/payment_initiation_payment_create_request.rb +284 -0
- data/lib/plaid/models/payment_initiation_payment_create_response.rb +255 -0
- data/lib/plaid/models/payment_initiation_payment_get_request.rb +245 -0
- data/lib/plaid/models/payment_initiation_payment_get_response.rb +353 -0
- data/lib/plaid/models/payment_initiation_payment_list_request.rb +267 -0
- data/lib/plaid/models/payment_initiation_payment_list_response.rb +257 -0
- data/lib/plaid/models/payment_initiation_payment_token_create_request.rb +245 -0
- data/lib/plaid/models/payment_initiation_payment_token_create_response.rb +255 -0
- data/lib/plaid/models/payment_initiation_recipient.rb +271 -0
- data/lib/plaid/models/payment_initiation_recipient_bacs.rb +237 -0
- data/lib/plaid/models/payment_initiation_recipient_create_request.rb +275 -0
- data/lib/plaid/models/payment_initiation_recipient_create_response.rb +240 -0
- data/lib/plaid/models/payment_initiation_recipient_get_request.rb +245 -0
- data/lib/plaid/models/payment_initiation_recipient_get_response.rb +286 -0
- data/lib/plaid/models/payment_initiation_recipient_list_request.rb +230 -0
- data/lib/plaid/models/payment_initiation_recipient_list_response.rb +242 -0
- data/lib/plaid/models/payment_meta.rb +298 -0
- data/lib/plaid/models/payment_status_update_webhook.rb +356 -0
- data/lib/plaid/models/paystub.rb +306 -0
- data/lib/plaid/models/paystub_deduction.rb +242 -0
- data/lib/plaid/models/paystub_ytd_details.rb +239 -0
- data/lib/plaid/models/pending_expiration_webhook.rb +270 -0
- data/lib/plaid/models/phone_number.rb +281 -0
- data/lib/plaid/models/processor_apex_processor_token_create_request.rb +260 -0
- data/lib/plaid/models/processor_auth_get_request.rb +245 -0
- data/lib/plaid/models/processor_auth_get_response.rb +253 -0
- data/lib/plaid/models/processor_balance_get_request.rb +245 -0
- data/lib/plaid/models/processor_balance_get_response.rb +239 -0
- data/lib/plaid/models/processor_identity_get_request.rb +245 -0
- data/lib/plaid/models/processor_identity_get_response.rb +239 -0
- data/lib/plaid/models/processor_number.rb +250 -0
- data/lib/plaid/models/processor_stripe_bank_account_token_create_request.rb +260 -0
- data/lib/plaid/models/processor_stripe_bank_account_token_create_response.rb +240 -0
- data/lib/plaid/models/processor_token_create_request.rb +275 -0
- data/lib/plaid/models/processor_token_create_response.rb +240 -0
- data/lib/plaid/models/product_status.rb +288 -0
- data/lib/plaid/models/product_status_breakdown.rb +300 -0
- data/lib/plaid/models/products.rb +45 -0
- data/lib/plaid/models/projected_income_summary_field_number.rb +245 -0
- data/lib/plaid/models/pslf_status.rb +243 -0
- data/lib/plaid/models/recaptcha_required_error.rb +314 -0
- data/lib/plaid/models/recipient_bacs.rb +230 -0
- data/lib/plaid/models/sandbox_bank_transfer_simulate_request.rb +270 -0
- data/lib/plaid/models/sandbox_bank_transfer_simulate_response.rb +225 -0
- data/lib/plaid/models/sandbox_item_fire_webhook_request.rb +289 -0
- data/lib/plaid/models/sandbox_item_fire_webhook_response.rb +240 -0
- data/lib/plaid/models/sandbox_item_reset_login_request.rb +245 -0
- data/lib/plaid/models/sandbox_item_reset_login_response.rb +240 -0
- data/lib/plaid/models/sandbox_item_set_verification_status_request.rb +309 -0
- data/lib/plaid/models/sandbox_item_set_verification_status_response.rb +225 -0
- data/lib/plaid/models/sandbox_processor_token_create_request.rb +253 -0
- data/lib/plaid/models/sandbox_processor_token_create_request_options.rb +236 -0
- data/lib/plaid/models/sandbox_processor_token_create_response.rb +239 -0
- data/lib/plaid/models/sandbox_public_token_create_request.rb +271 -0
- data/lib/plaid/models/sandbox_public_token_create_request_options.rb +255 -0
- data/lib/plaid/models/sandbox_public_token_create_request_options_transactions.rb +230 -0
- data/lib/plaid/models/sandbox_public_token_create_response.rb +240 -0
- data/lib/plaid/models/security.rb +382 -0
- data/lib/plaid/models/servicer_address_data.rb +265 -0
- data/lib/plaid/models/standalone_account_type.rb +285 -0
- data/lib/plaid/models/standalone_currency_code_list.rb +240 -0
- data/lib/plaid/models/standalone_investment_transaction_subtype.rb +650 -0
- data/lib/plaid/models/standalone_investment_transaction_type.rb +300 -0
- data/lib/plaid/models/student_loan.rb +483 -0
- data/lib/plaid/models/student_loan_repayment_model.rb +255 -0
- data/lib/plaid/models/student_loan_status.rb +266 -0
- data/lib/plaid/models/student_repayment_plan.rb +266 -0
- data/lib/plaid/models/transaction.rb +478 -0
- data/lib/plaid/models/transaction_code.rb +48 -0
- data/lib/plaid/models/transaction_data.rb +285 -0
- data/lib/plaid/models/transaction_override.rb +280 -0
- data/lib/plaid/models/transactions_get_request.rb +284 -0
- data/lib/plaid/models/transactions_get_request_options.rb +285 -0
- data/lib/plaid/models/transactions_get_response.rb +288 -0
- data/lib/plaid/models/transactions_refresh_request.rb +240 -0
- data/lib/plaid/models/transactions_refresh_response.rb +225 -0
- data/lib/plaid/models/transactions_removed_webhook.rb +282 -0
- data/lib/plaid/models/user_custom_password.rb +297 -0
- data/lib/plaid/models/user_permission_revoked_webhook.rb +265 -0
- data/lib/plaid/models/verification_expired_webhook.rb +270 -0
- data/lib/plaid/models/verification_status.rb +40 -0
- data/lib/plaid/models/warning.rb +254 -0
- data/lib/plaid/models/webhook_update_acknowledged_webhook.rb +280 -0
- data/lib/plaid/models/webhook_verification_key_get_request.rb +245 -0
- data/lib/plaid/models/webhook_verification_key_get_response.rb +239 -0
- data/lib/plaid/models/ytd_gross_income_summary_field_number.rb +245 -0
- data/lib/plaid/models/ytd_net_income_summary_field_number.rb +245 -0
- data/lib/plaid/version.rb +13 -2
- data/plaid.gemspec +44 -49
- data/templates/ruby/api_client.mustache +266 -0
- data/templates/ruby/api_client_faraday_partial.mustache +120 -0
- data/templates/ruby/configuration.mustache +353 -0
- data/templates/ruby/gemspec.mustache +41 -0
- data/test/test_accounts.rb +103 -0
- data/test/test_asset_report.rb +147 -0
- data/test/test_auth.rb +61 -0
- data/test/test_bank_transfers.rb +219 -0
- data/test/test_categories.rb +10 -0
- data/test/test_configuration.rb +26 -0
- data/test/test_deposit_switch.rb +73 -0
- data/test/test_helper.rb +109 -0
- data/test/test_identity.rb +38 -0
- data/test/test_institutions.rb +159 -0
- data/test/test_investments.rb +205 -0
- data/test/test_item.rb +285 -0
- data/test/test_liabilities.rb +45 -0
- data/test/test_link_token.rb +97 -0
- data/test/test_payment_initiation.rb +95 -0
- data/test/test_processor.rb +67 -0
- data/test/test_transactions.rb +165 -0
- data/test/test_webhooks.rb +22 -0
- metadata +687 -99
- data/.circleci/config.yml +0 -21
- data/.env.sample +0 -3
- data/.github/workflows/add_to_project.yml +0 -21
- data/.rubocop.yml +0 -18
- data/bin/console +0 -14
- data/bin/setup +0 -8
- data/lib/plaid/client.rb +0 -190
- data/lib/plaid/errors.rb +0 -89
- data/lib/plaid/middleware.rb +0 -31
- data/lib/plaid/models.rb +0 -2221
- data/lib/plaid/products/accounts.rb +0 -63
- data/lib/plaid/products/asset_report.rb +0 -199
- data/lib/plaid/products/auth.rb +0 -42
- data/lib/plaid/products/base_product.rb +0 -64
- data/lib/plaid/products/categories.rb +0 -21
- data/lib/plaid/products/credit_details.rb +0 -40
- data/lib/plaid/products/deposit_switch.rb +0 -99
- data/lib/plaid/products/identity.rb +0 -31
- data/lib/plaid/products/income.rb +0 -31
- data/lib/plaid/products/institutions.rb +0 -91
- data/lib/plaid/products/investments.rb +0 -127
- data/lib/plaid/products/item.rb +0 -209
- data/lib/plaid/products/liabilities.rb +0 -39
- data/lib/plaid/products/link_token.rb +0 -74
- data/lib/plaid/products/payment_initiation.rb +0 -251
- data/lib/plaid/products/processor.rb +0 -190
- data/lib/plaid/products/sandbox.rb +0 -148
- data/lib/plaid/products/transactions.rb +0 -81
- data/lib/plaid/products/webhooks.rb +0 -23
|
@@ -1,39 +0,0 @@
|
|
|
1
|
-
module Plaid
|
|
2
|
-
# Public: Class used to call the Liabilities product.
|
|
3
|
-
class Liabilities < BaseProduct
|
|
4
|
-
# Public: Get liabilities information.
|
|
5
|
-
#
|
|
6
|
-
# Does a POST /liabilities/get call which fetches liabilities associated
|
|
7
|
-
# with an access_token's item.
|
|
8
|
-
#
|
|
9
|
-
# access_token - access_token of an item to fetch liabilities for.
|
|
10
|
-
# account_ids - Specific account ids to fetch liabilities for
|
|
11
|
-
# (optional).
|
|
12
|
-
#
|
|
13
|
-
# Returns the LiabilitiesResponse object with liabilities data.
|
|
14
|
-
def get(access_token, account_ids: nil)
|
|
15
|
-
post_with_auth 'liabilities/get',
|
|
16
|
-
LiabilitiesResponse,
|
|
17
|
-
build_payload(access_token,
|
|
18
|
-
account_ids: account_ids)
|
|
19
|
-
end
|
|
20
|
-
end
|
|
21
|
-
|
|
22
|
-
# Public: Response wrapper for /liabilities/get.
|
|
23
|
-
class LiabilitiesResponse < Models::BaseResponse
|
|
24
|
-
##
|
|
25
|
-
# :attr_reader:
|
|
26
|
-
# Public: The list of accounts: Array of Plaid::Models::Account.
|
|
27
|
-
property :accounts, coerce: Array[Models::Account]
|
|
28
|
-
|
|
29
|
-
##
|
|
30
|
-
# :attr_reader:
|
|
31
|
-
# Public: The liabilities: Plaid::Models::Liabilities.
|
|
32
|
-
property :liabilities, coerce: Models::Liabilities
|
|
33
|
-
|
|
34
|
-
##
|
|
35
|
-
# :attr_reader:
|
|
36
|
-
# Public: The item: Plaid::Models::Item.
|
|
37
|
-
property :item, coerce: Models::Item
|
|
38
|
-
end
|
|
39
|
-
end
|
|
@@ -1,74 +0,0 @@
|
|
|
1
|
-
LINK_TOKEN_FIELD_NAMES = %i[
|
|
2
|
-
user
|
|
3
|
-
client_name
|
|
4
|
-
products
|
|
5
|
-
country_codes
|
|
6
|
-
language
|
|
7
|
-
webhook
|
|
8
|
-
access_token
|
|
9
|
-
link_customization_name
|
|
10
|
-
redirect_uri
|
|
11
|
-
android_package_name
|
|
12
|
-
account_filters
|
|
13
|
-
cross_app_item_add
|
|
14
|
-
payment_initiation
|
|
15
|
-
].freeze
|
|
16
|
-
|
|
17
|
-
module Plaid
|
|
18
|
-
# Public: Class used to call the LinkToken sub-product.
|
|
19
|
-
class LinkToken < BaseProduct
|
|
20
|
-
def create(configs)
|
|
21
|
-
body = {}
|
|
22
|
-
|
|
23
|
-
LINK_TOKEN_FIELD_NAMES.each do |field|
|
|
24
|
-
body[field] = configs[field]
|
|
25
|
-
end
|
|
26
|
-
|
|
27
|
-
post_with_auth 'link/token/create',
|
|
28
|
-
CreateResponse,
|
|
29
|
-
body
|
|
30
|
-
end
|
|
31
|
-
|
|
32
|
-
def get(link_token)
|
|
33
|
-
post_with_auth 'link/token/get',
|
|
34
|
-
GetResponse,
|
|
35
|
-
link_token: link_token
|
|
36
|
-
end
|
|
37
|
-
end
|
|
38
|
-
|
|
39
|
-
# Public: Response for /link/token/create.
|
|
40
|
-
class CreateResponse < Models::BaseResponse
|
|
41
|
-
##
|
|
42
|
-
# :attr_reader:
|
|
43
|
-
# Public: The String token.
|
|
44
|
-
property :link_token
|
|
45
|
-
|
|
46
|
-
##
|
|
47
|
-
# :attr_reader:
|
|
48
|
-
# Public: The String token expiration time.
|
|
49
|
-
property :expiration
|
|
50
|
-
end
|
|
51
|
-
|
|
52
|
-
# Public: Response for /link/token/get.
|
|
53
|
-
class GetResponse < Models::BaseResponse
|
|
54
|
-
##
|
|
55
|
-
# :attr_reader:
|
|
56
|
-
# Public: The String token.
|
|
57
|
-
property :link_token
|
|
58
|
-
|
|
59
|
-
##
|
|
60
|
-
# :attr_reader:
|
|
61
|
-
# Public: The link token expiration time.
|
|
62
|
-
property :expiration
|
|
63
|
-
|
|
64
|
-
##
|
|
65
|
-
# :attr_reader:
|
|
66
|
-
# Public: The link token created time.
|
|
67
|
-
property :created_at
|
|
68
|
-
|
|
69
|
-
##
|
|
70
|
-
# :attr_reader:
|
|
71
|
-
# Public: The metadata associated with the link token.
|
|
72
|
-
property :metadata, coerce: Models::LinkTokenMetadata
|
|
73
|
-
end
|
|
74
|
-
end
|
|
@@ -1,251 +0,0 @@
|
|
|
1
|
-
module Plaid
|
|
2
|
-
# Public: Class used to call the Payment product.
|
|
3
|
-
class PaymentInitiation < BaseProduct
|
|
4
|
-
# Public: Create a recipient.
|
|
5
|
-
#
|
|
6
|
-
# name - Recipient name.
|
|
7
|
-
# iban - Recipient IBAN. Should be nil if using bacs.
|
|
8
|
-
# address - Recipient address (hash with "street", "city", "postal_code"
|
|
9
|
-
# and "country"). Best practice is to set it as nil.
|
|
10
|
-
# bacs - Recipient BACS (hash with "account" and "sort_code" keys).
|
|
11
|
-
# Should be nil if using iban.
|
|
12
|
-
#
|
|
13
|
-
# Returns a PaymentRecipientCreateResponse object.
|
|
14
|
-
def create_recipient(name, iban, address, bacs)
|
|
15
|
-
post_with_auth 'payment_initiation/recipient/create',
|
|
16
|
-
PaymentRecipientCreateResponse,
|
|
17
|
-
name: name,
|
|
18
|
-
iban: iban,
|
|
19
|
-
bacs: bacs,
|
|
20
|
-
address: address
|
|
21
|
-
end
|
|
22
|
-
|
|
23
|
-
# Public: Retrieve a recipient.
|
|
24
|
-
#
|
|
25
|
-
# recipient_id - The recipient ID from the `create_recipient` response.
|
|
26
|
-
#
|
|
27
|
-
# Returns a PaymentRecipientGetResponse object.
|
|
28
|
-
def get_recipient(recipient_id)
|
|
29
|
-
post_with_auth 'payment_initiation/recipient/get',
|
|
30
|
-
PaymentRecipientGetResponse,
|
|
31
|
-
recipient_id: recipient_id
|
|
32
|
-
end
|
|
33
|
-
|
|
34
|
-
# Public: List all recipients.
|
|
35
|
-
#
|
|
36
|
-
# Returns a PaymentRecipientListResponse object.
|
|
37
|
-
def list_recipients
|
|
38
|
-
post_with_auth 'payment_initiation/recipient/list',
|
|
39
|
-
PaymentRecipientListResponse,
|
|
40
|
-
{}
|
|
41
|
-
end
|
|
42
|
-
|
|
43
|
-
# Public: Create a payment.
|
|
44
|
-
#
|
|
45
|
-
# recipient_id - Recipient ID that the payment will be initiated for.
|
|
46
|
-
# reference - Payment reference.
|
|
47
|
-
# amount - Payment amount.
|
|
48
|
-
# schedule - Payment schedule.
|
|
49
|
-
# options - Payment options.
|
|
50
|
-
#
|
|
51
|
-
# Returns a PaymentCreateResponse object.
|
|
52
|
-
def create_payment(
|
|
53
|
-
recipient_id, reference, amount, schedule: nil, options: nil
|
|
54
|
-
)
|
|
55
|
-
create_payment = {
|
|
56
|
-
'recipient_id': recipient_id,
|
|
57
|
-
'reference': reference,
|
|
58
|
-
'amount': amount
|
|
59
|
-
}
|
|
60
|
-
|
|
61
|
-
create_payment['schedule'] = schedule unless schedule.nil?
|
|
62
|
-
create_payment['options'] = options unless options.nil?
|
|
63
|
-
|
|
64
|
-
post_with_auth('payment_initiation/payment/create',
|
|
65
|
-
PaymentCreateResponse,
|
|
66
|
-
create_payment)
|
|
67
|
-
end
|
|
68
|
-
|
|
69
|
-
# Public: Create a payment token.
|
|
70
|
-
#
|
|
71
|
-
# payment_id - Payment ID that the token will be created for.
|
|
72
|
-
#
|
|
73
|
-
# Returns a PaymentTokenCreateResponse object.
|
|
74
|
-
def create_payment_token(payment_id)
|
|
75
|
-
puts 'Warning: this method will be deprecated in a future version. '\
|
|
76
|
-
'To replace the payment_token, look into the link_token at '\
|
|
77
|
-
'https://plaid.com/docs/api/tokens/#linktokencreate.'
|
|
78
|
-
|
|
79
|
-
post_with_auth 'payment_initiation/payment/token/create',
|
|
80
|
-
PaymentTokenCreateResponse,
|
|
81
|
-
payment_id: payment_id
|
|
82
|
-
end
|
|
83
|
-
|
|
84
|
-
# Public: Retrieve a payment.
|
|
85
|
-
#
|
|
86
|
-
# payment_id - The payment ID from the `create_payment` response.
|
|
87
|
-
#
|
|
88
|
-
# Returns a PaymentGetResponse object.
|
|
89
|
-
def get_payment(payment_id)
|
|
90
|
-
post_with_auth 'payment_initiation/payment/get',
|
|
91
|
-
PaymentGetResponse,
|
|
92
|
-
payment_id: payment_id
|
|
93
|
-
end
|
|
94
|
-
|
|
95
|
-
# Public: List all payments.
|
|
96
|
-
#
|
|
97
|
-
# options - Object to specify optional parameters 'count' and 'cursor'.
|
|
98
|
-
# e.g {count: 10, cursor: '2019-12-06T22:35:49Z'} returns 10
|
|
99
|
-
# payments initiated before 2019-12-06T22:35:49Z.
|
|
100
|
-
#
|
|
101
|
-
# Returns a PaymentListResponse object.
|
|
102
|
-
def list_payments(options)
|
|
103
|
-
post_with_auth 'payment_initiation/payment/list',
|
|
104
|
-
PaymentListResponse,
|
|
105
|
-
options
|
|
106
|
-
end
|
|
107
|
-
end
|
|
108
|
-
|
|
109
|
-
# Public: The response wrapper for /payment_initiation/recipient/create.
|
|
110
|
-
class PaymentRecipientCreateResponse < Models::BaseResponse
|
|
111
|
-
##
|
|
112
|
-
# :attr_reader:
|
|
113
|
-
# Public: The recipient ID.
|
|
114
|
-
property :recipient_id
|
|
115
|
-
end
|
|
116
|
-
|
|
117
|
-
# Public: The response wrapper for /payment_initiation/recipient/get.
|
|
118
|
-
class PaymentRecipientGetResponse < Models::BaseResponse
|
|
119
|
-
##
|
|
120
|
-
# :attr_reader:
|
|
121
|
-
# Public: The recipient ID.
|
|
122
|
-
property :recipient_id
|
|
123
|
-
|
|
124
|
-
##
|
|
125
|
-
# :attr_reader:
|
|
126
|
-
# Public: The recipient name.
|
|
127
|
-
property :name
|
|
128
|
-
|
|
129
|
-
##
|
|
130
|
-
# :attr_reader:
|
|
131
|
-
# Public: The recipient IBAN.
|
|
132
|
-
property :iban
|
|
133
|
-
|
|
134
|
-
##
|
|
135
|
-
# :attr_reader:
|
|
136
|
-
# Public: The recipient IBAN.
|
|
137
|
-
property :bacs, coerce: Models::PaymentRecipientBACS
|
|
138
|
-
|
|
139
|
-
##
|
|
140
|
-
# :attr_reader:
|
|
141
|
-
# Public: The recipient address.
|
|
142
|
-
property :address, coerce: Models::PaymentRecipientAddress
|
|
143
|
-
end
|
|
144
|
-
|
|
145
|
-
# Public: The response wrapper for /payment_initiation/recipient/list.
|
|
146
|
-
class PaymentRecipientListResponse < Models::BaseResponse
|
|
147
|
-
##
|
|
148
|
-
# :attr_reader:
|
|
149
|
-
# Public: The list of recipients.
|
|
150
|
-
property :recipients, coerce: Array[Models::PaymentRecipient]
|
|
151
|
-
end
|
|
152
|
-
|
|
153
|
-
# Public: The response wrapper for /payment_initiation/payment/create.
|
|
154
|
-
class PaymentCreateResponse < Models::BaseResponse
|
|
155
|
-
##
|
|
156
|
-
# :attr_reader:
|
|
157
|
-
# Public: The payment ID.
|
|
158
|
-
property :payment_id
|
|
159
|
-
|
|
160
|
-
##
|
|
161
|
-
# :attr_reader:
|
|
162
|
-
# Public: The payment status.
|
|
163
|
-
property :status
|
|
164
|
-
end
|
|
165
|
-
|
|
166
|
-
# Public: The response wrapper for /payment_initiation/payment/token/create.
|
|
167
|
-
class PaymentTokenCreateResponse < Models::BaseResponse
|
|
168
|
-
##
|
|
169
|
-
# :attr_reader:
|
|
170
|
-
# Public: The payment token.
|
|
171
|
-
property :payment_token
|
|
172
|
-
|
|
173
|
-
##
|
|
174
|
-
# :attr_reader:
|
|
175
|
-
# Public: The payment token's expiration time.
|
|
176
|
-
property :payment_token_expiration_time
|
|
177
|
-
end
|
|
178
|
-
|
|
179
|
-
# Public: The response wrapper for /payment_initiation/payment/get.
|
|
180
|
-
class PaymentGetResponse < Models::BaseResponse
|
|
181
|
-
##
|
|
182
|
-
# :attr_reader:
|
|
183
|
-
# Public: The payment ID.
|
|
184
|
-
property :payment_id
|
|
185
|
-
|
|
186
|
-
##
|
|
187
|
-
# :attr_reader:
|
|
188
|
-
# Public: The payment token.
|
|
189
|
-
property :payment_token
|
|
190
|
-
|
|
191
|
-
##
|
|
192
|
-
# :attr_reader:
|
|
193
|
-
# Public: The payment reference.
|
|
194
|
-
property :reference
|
|
195
|
-
|
|
196
|
-
##
|
|
197
|
-
# :attr_reader:
|
|
198
|
-
# Public: The payment amount.
|
|
199
|
-
property :amount, coerce: Models::PaymentAmount
|
|
200
|
-
|
|
201
|
-
##
|
|
202
|
-
# :attr_reader:
|
|
203
|
-
# Public: The payment schedule.
|
|
204
|
-
property :schedule, coerce: Models::PaymentSchedule
|
|
205
|
-
|
|
206
|
-
##
|
|
207
|
-
# :attr_reader:
|
|
208
|
-
# Public: The payment's status.
|
|
209
|
-
property :status
|
|
210
|
-
|
|
211
|
-
##
|
|
212
|
-
# :attr_reader:
|
|
213
|
-
# Public: The last status update time for payment.
|
|
214
|
-
property :last_status_update
|
|
215
|
-
|
|
216
|
-
##
|
|
217
|
-
# :attr_reader:
|
|
218
|
-
# Public: The payment token's expiration time.
|
|
219
|
-
property :payment_token_expiration_time
|
|
220
|
-
|
|
221
|
-
##
|
|
222
|
-
# :attr_reader:
|
|
223
|
-
# Public: The recipient ID for payment.
|
|
224
|
-
property :recipient_id
|
|
225
|
-
|
|
226
|
-
##
|
|
227
|
-
# :attr_reader:
|
|
228
|
-
# Public: An object containing a BACS account number and sort code
|
|
229
|
-
# for the payer's account.
|
|
230
|
-
property :bacs
|
|
231
|
-
|
|
232
|
-
##
|
|
233
|
-
# :attr_reader:
|
|
234
|
-
# Public: A string containing the IBAN for the payer's account.
|
|
235
|
-
property :iban
|
|
236
|
-
end
|
|
237
|
-
|
|
238
|
-
# Public: The response wrapper for /payment_initiation/payment/list.
|
|
239
|
-
class PaymentListResponse < Models::BaseResponse
|
|
240
|
-
##
|
|
241
|
-
# :attr_reader:
|
|
242
|
-
# Public: The list of payments.
|
|
243
|
-
property :payments, coerce: Array[Models::Payment]
|
|
244
|
-
|
|
245
|
-
##
|
|
246
|
-
# :attr_reader:
|
|
247
|
-
# Public: The cursor (its a timestamp) to use in the next
|
|
248
|
-
# /payment_initiation/payment/list call for retrieving more older payments.
|
|
249
|
-
property :next_cursor
|
|
250
|
-
end
|
|
251
|
-
end
|
|
@@ -1,190 +0,0 @@
|
|
|
1
|
-
module Plaid
|
|
2
|
-
# Public: Class used to call the Stripe sub-product.
|
|
3
|
-
class Stripe < BaseProduct
|
|
4
|
-
# Public: Class used to call the BankAccountToken sub-product.
|
|
5
|
-
class BankAccountToken < BaseProduct
|
|
6
|
-
# Public: Creates a Stripe bank account token from an access_token.
|
|
7
|
-
#
|
|
8
|
-
# Does a POST /processor/stripe/bank_account_token/create call which can
|
|
9
|
-
# be used to generate a Stripe bank account token for a given account
|
|
10
|
-
# ID.
|
|
11
|
-
#
|
|
12
|
-
# access_token - access_token to create a public token for
|
|
13
|
-
# account_id - ID of the account to create a bank account token for
|
|
14
|
-
#
|
|
15
|
-
# Returns CreateResponse object containing a Stripe bank account token.
|
|
16
|
-
def create(access_token, account_id)
|
|
17
|
-
post_with_auth 'processor/stripe/bank_account_token/create',
|
|
18
|
-
CreateResponse,
|
|
19
|
-
access_token: access_token, account_id: account_id
|
|
20
|
-
end
|
|
21
|
-
|
|
22
|
-
# Public: A response for /processor/stripe/bank_account_token/create.
|
|
23
|
-
class CreateResponse < Models::BaseResponse
|
|
24
|
-
##
|
|
25
|
-
# :attr_reader:
|
|
26
|
-
# Public: The String stripe token.
|
|
27
|
-
property :stripe_bank_account_token
|
|
28
|
-
end
|
|
29
|
-
end
|
|
30
|
-
|
|
31
|
-
##
|
|
32
|
-
# :attr_reader:
|
|
33
|
-
# Public: The Plaid::Stripe::BankAccountToken product accessor.
|
|
34
|
-
subproduct :bank_account_token, BankAccountToken
|
|
35
|
-
end
|
|
36
|
-
|
|
37
|
-
# Public: A response for /processor/.../processor_token/create.
|
|
38
|
-
class ProcessorTokenResponse < Models::BaseResponse
|
|
39
|
-
##
|
|
40
|
-
# :attr_reader:
|
|
41
|
-
# Public: The String processor token.
|
|
42
|
-
property :processor_token
|
|
43
|
-
end
|
|
44
|
-
|
|
45
|
-
# Public: Class used to call the Dwolla sub-product.
|
|
46
|
-
class Dwolla < BaseProduct
|
|
47
|
-
# Public: Class used to call the dwolla.processor_token subproduct
|
|
48
|
-
class ProcessorToken < BaseProduct
|
|
49
|
-
# Public: Creates a Dwolla processor token from an access_token.
|
|
50
|
-
#
|
|
51
|
-
# Does a POST /processor/dwolla/processor_token/create call which can be
|
|
52
|
-
# used to generate a Dwolla processor token for a given account ID.
|
|
53
|
-
#
|
|
54
|
-
# access_token - access_token to create a public token for.
|
|
55
|
-
# account_id - ID of the account to create a processor token for.
|
|
56
|
-
#
|
|
57
|
-
# Returns a ProcessorTokenResponse object containing a Dwolla processor
|
|
58
|
-
# token.
|
|
59
|
-
def create(access_token, account_id)
|
|
60
|
-
post_with_auth 'processor/dwolla/processor_token/create',
|
|
61
|
-
ProcessorTokenResponse,
|
|
62
|
-
access_token: access_token,
|
|
63
|
-
account_id: account_id
|
|
64
|
-
end
|
|
65
|
-
end
|
|
66
|
-
|
|
67
|
-
##
|
|
68
|
-
# :attr_reader:
|
|
69
|
-
# Public: The Plaid::Dwolla::ProcessorToken product accessor.
|
|
70
|
-
subproduct :processor_token, ProcessorToken
|
|
71
|
-
end
|
|
72
|
-
|
|
73
|
-
# Public: Class used to call the Apex sub-product.
|
|
74
|
-
class Apex < BaseProduct
|
|
75
|
-
# Public: Class used to call the apex.processor_token subproduct
|
|
76
|
-
class ProcessorToken < BaseProduct
|
|
77
|
-
# Public: Creates an Apex processor token from an access_token.
|
|
78
|
-
#
|
|
79
|
-
# Does a POST /processor/apex/processor_token/create call which can be
|
|
80
|
-
# used to generate an Apex processor token for a given account ID.
|
|
81
|
-
#
|
|
82
|
-
# access_token - access_token to create a public token for.
|
|
83
|
-
# account_id - ID of the account to create a processor token for.
|
|
84
|
-
#
|
|
85
|
-
# Returns a ProcessorTokenResponse object containing an Apex processor
|
|
86
|
-
# token.
|
|
87
|
-
def create(access_token, account_id)
|
|
88
|
-
post_with_auth 'processor/apex/processor_token/create',
|
|
89
|
-
ProcessorTokenResponse,
|
|
90
|
-
access_token: access_token,
|
|
91
|
-
account_id: account_id
|
|
92
|
-
end
|
|
93
|
-
end
|
|
94
|
-
|
|
95
|
-
##
|
|
96
|
-
# :attr_reader:
|
|
97
|
-
# Public: The Plaid::ApexProcessorToken product accessor.
|
|
98
|
-
subproduct :processor_token, ProcessorToken
|
|
99
|
-
end
|
|
100
|
-
|
|
101
|
-
# Public: Class used to call the Ocrolus sub-product.
|
|
102
|
-
class Ocrolus < BaseProduct
|
|
103
|
-
# Public: Class used to call the ocrolus.processor_token subproduct
|
|
104
|
-
class ProcessorToken < BaseProduct
|
|
105
|
-
# Public: Creates a Ocrolus processor token from an access_token.
|
|
106
|
-
#
|
|
107
|
-
# Does a POST /processor/ocrolus/processor_token/create call which can be
|
|
108
|
-
# used to generate a Ocrolus processor token for a given account ID.
|
|
109
|
-
#
|
|
110
|
-
# access_token - access_token to create a public token for.
|
|
111
|
-
# account_id - ID of the account to create a processor token for.
|
|
112
|
-
#
|
|
113
|
-
# Returns a ProcessorTokenResponse object containing a Ocrolus processor
|
|
114
|
-
# token.
|
|
115
|
-
def create(access_token, account_id)
|
|
116
|
-
post_with_auth 'processor/ocrolus/processor_token/create',
|
|
117
|
-
ProcessorTokenResponse,
|
|
118
|
-
access_token: access_token,
|
|
119
|
-
account_id: account_id
|
|
120
|
-
end
|
|
121
|
-
end
|
|
122
|
-
|
|
123
|
-
##
|
|
124
|
-
# :attr_reader:
|
|
125
|
-
# Public: The Plaid::Ocrolus::ProcessorToken product accessor.
|
|
126
|
-
subproduct :processor_token, ProcessorToken
|
|
127
|
-
end
|
|
128
|
-
|
|
129
|
-
# Public: Class used to call the generic ProcessorToken sub-product.
|
|
130
|
-
class ProcessorToken < BaseProduct
|
|
131
|
-
# Public: Creates a processor token from an access_token.
|
|
132
|
-
#
|
|
133
|
-
# Does a POST /processor/token/create call which can be used to
|
|
134
|
-
# generate any non-stripe processor token for a given account ID.
|
|
135
|
-
# If the processor is Stripe, the stripe endpoint will be called
|
|
136
|
-
# instead.
|
|
137
|
-
#
|
|
138
|
-
# access_token - access_token to create a public token for.
|
|
139
|
-
# account_id - ID of the account to create a processor token for.
|
|
140
|
-
# processor - name of the processor to create a token for.
|
|
141
|
-
#
|
|
142
|
-
# Returns a ProcessorTokenResponse object containing a processor token.
|
|
143
|
-
def create(access_token, account_id, processor)
|
|
144
|
-
endpoint = 'processor/token/create'
|
|
145
|
-
options = {
|
|
146
|
-
access_token: access_token,
|
|
147
|
-
account_id: account_id,
|
|
148
|
-
processor: processor
|
|
149
|
-
}
|
|
150
|
-
|
|
151
|
-
if processor == 'stripe'
|
|
152
|
-
endpoint = '/processor/stripe/bank_account_token/create'
|
|
153
|
-
options.delete(:processor)
|
|
154
|
-
elsif processor == 'apex'
|
|
155
|
-
endpoint = '/processor/apex/processor_token/create'
|
|
156
|
-
options.delete(:processor)
|
|
157
|
-
end
|
|
158
|
-
|
|
159
|
-
post_with_auth endpoint, ProcessorTokenResponse, **options
|
|
160
|
-
end
|
|
161
|
-
end
|
|
162
|
-
|
|
163
|
-
# Public: Class used to call the Processor product.
|
|
164
|
-
class Processor < BaseProduct
|
|
165
|
-
##
|
|
166
|
-
# :attr_reader:
|
|
167
|
-
# Public: The Plaid::Stripe product accessor.
|
|
168
|
-
subproduct :stripe
|
|
169
|
-
|
|
170
|
-
##
|
|
171
|
-
# :attr_reader:
|
|
172
|
-
# Public: The Plaid::Dwolla product accessor.
|
|
173
|
-
subproduct :dwolla
|
|
174
|
-
|
|
175
|
-
##
|
|
176
|
-
# :attr_reader:
|
|
177
|
-
# Public: The Plaid::Apex product accessor.
|
|
178
|
-
subproduct :apex
|
|
179
|
-
|
|
180
|
-
##
|
|
181
|
-
# :attr_reader:
|
|
182
|
-
# Public: The Plaid::Ocrolus product accessor.
|
|
183
|
-
subproduct :ocrolus
|
|
184
|
-
|
|
185
|
-
##
|
|
186
|
-
# :attr_reader:
|
|
187
|
-
# Public: The Plaid::ProcessorToken product accessor.
|
|
188
|
-
subproduct :processor_token
|
|
189
|
-
end
|
|
190
|
-
end
|