plaid 14.5.0 → 14.9.0

data/doc/rdoc/js/search_index.js

@@ -1 +1 @@
-var search_data = {"index":{"searchIndex":["object","plaid","apierror","accesstoken","invalidateresponse","accounts","accountsresponse","apex","processortoken","assetreport","assetreportcreateresponse","assetreportfilterresponse","assetreportgetresponse","assetreportrefreshresponse","assetreportremoveresponse","auditcopycreateresponse","auditcopygetresponse","auditcopyremoveresponse","auth","authresponse","balance","baseproduct","categories","categoriesresponse","client","createresponse","creditdetails","creditdetailsresponse","depositswitch","createresponse","createtokenresponse","getresponse","dwolla","processortoken","error","getresponse","holdings","getresponse","identity","identityresponse","income","incomeresponse","institutionerror","institutions","invalidinputerror","invalidrequesterror","investmenttransactions","getresponse","investments","item","getresponse","importresponse","removeresponse","itemerror","liabilities","liabilitiesresponse","linktoken","middleware","models","account","accountwithowners","assetreport","assetreportaccount","assetreportbalance","assetreporthistoricalbalance","assetreportitem","assetreportowner","assetreporttransaction","assetreportuser","balances","baseerror","basemodel","baseresponse","category","cause","creditcardliability","creditcardliabilityaprs","creditdetails","creditdetailsapr","creditdetailsaprs","error","holding","identity","identityaddress","identityaddressdata","identityemail","identityphonenumber","income","incomestream","institution","institutioncredential","institutionpaymentinitiationmetadata","institutionstatus","institutionstatusbreakdown","institutionstatusitemlogins","investmenttransaction","item","itemstatus","itemstatusinvestments","itemstatuslastwebhook","itemstatustransactions","liabilities","linktokenmetadata","mfa","device","devicelistelement","selection","numberach","numberbacs","numbereft","numberinternational","numbers","pslfstatus","payment","paymentamount","paymentrecipient","paymentrecipientaddress","paymentrecipientbacs","paymentschedule","security","standingordermetadata","studentloanliability","studentloanrepaymentplan","studentloanserviceraddress","studentloanstatus","transaction","transactionlocation","transactionpaymentmeta","warning","webhookverificationkey","multipleinstitutionsresponse","ocrolus","processortoken","paymentcreateresponse","paymentgetresponse","paymentinitiation","paymentlistresponse","paymentrecipientcreateresponse","paymentrecipientgetresponse","paymentrecipientlistresponse","paymenttokencreateresponse","plaidapierror","plaiderror","plaidservererror","processor","processortoken","processortokenresponse","publictoken","createresponse","exchangeresponse","ratelimitexceedederror","sandbox","sandboxitem","firewebhookresponse","resetloginresponse","sandboxpublictoken","sandboxcreateresponse","singleinstitutionresponse","stripe","bankaccounttoken","createresponse","subproductmixin","transactions","getresponse","webhook","updateresponse","webhooks","webhookverificationkeygetresponse","api_host()","assert_property_exists!()","balance()","build_default_connection()","build_payload()","client()","convert_to_date_string()","create()","create()","create()","create()","create()","create()","create()","create()","create()","create()","create_audit_copy()","create_connection()","create_payment()","create_payment_token()","create_recipient()","create_token()","error_from_type()","exchange()","filter()","fire_webhook()","get()","get()","get()","get()","get()","get()","get()","get()","get()","get()","get()","get()","get()","get()","get()","get()","get_audit_copy()","get_by_id()","get_payment()","get_pdf()","get_recipient()","get_verification_key()","holdings()","import()","invalidate()","link_token()","list_payments()","list_recipients()","new()","new()","new()","on_complete()","post()","post_with_auth()","post_with_auth()","property_ignored?()","refresh()","refresh()","relaxed_models=()","relaxed_models?()","remove()","remove()","remove_audit_copy()","reset_login()","search()","set_verification_status()","subproduct()","transactions()","update()","license","readme"],"longSearchIndex":["object","plaid","plaid::apierror","plaid::accesstoken","plaid::accesstoken::invalidateresponse","plaid::accounts","plaid::accountsresponse","plaid::apex","plaid::apex::processortoken","plaid::assetreport","plaid::assetreportcreateresponse","plaid::assetreportfilterresponse","plaid::assetreportgetresponse","plaid::assetreportrefreshresponse","plaid::assetreportremoveresponse","plaid::auditcopycreateresponse","plaid::auditcopygetresponse","plaid::auditcopyremoveresponse","plaid::auth","plaid::authresponse","plaid::balance","plaid::baseproduct","plaid::categories","plaid::categoriesresponse","plaid::client","plaid::createresponse","plaid::creditdetails","plaid::creditdetailsresponse","plaid::depositswitch","plaid::depositswitch::createresponse","plaid::depositswitch::createtokenresponse","plaid::depositswitch::getresponse","plaid::dwolla","plaid::dwolla::processortoken","plaid::error","plaid::getresponse","plaid::holdings","plaid::holdings::getresponse","plaid::identity","plaid::identityresponse","plaid::income","plaid::incomeresponse","plaid::institutionerror","plaid::institutions","plaid::invalidinputerror","plaid::invalidrequesterror","plaid::investmenttransactions","plaid::investmenttransactions::getresponse","plaid::investments","plaid::item","plaid::item::getresponse","plaid::item::importresponse","plaid::item::removeresponse","plaid::itemerror","plaid::liabilities","plaid::liabilitiesresponse","plaid::linktoken","plaid::middleware","plaid::models","plaid::models::account","plaid::models::accountwithowners","plaid::models::assetreport","plaid::models::assetreportaccount","plaid::models::assetreportbalance","plaid::models::assetreporthistoricalbalance","plaid::models::assetreportitem","plaid::models::assetreportowner","plaid::models::assetreporttransaction","plaid::models::assetreportuser","plaid::models::balances","plaid::models::baseerror","plaid::models::basemodel","plaid::models::baseresponse","plaid::models::category","plaid::models::cause","plaid::models::creditcardliability","plaid::models::creditcardliabilityaprs","plaid::models::creditdetails","plaid::models::creditdetailsapr","plaid::models::creditdetailsaprs","plaid::models::error","plaid::models::holding","plaid::models::identity","plaid::models::identityaddress","plaid::models::identityaddressdata","plaid::models::identityemail","plaid::models::identityphonenumber","plaid::models::income","plaid::models::incomestream","plaid::models::institution","plaid::models::institutioncredential","plaid::models::institutionpaymentinitiationmetadata","plaid::models::institutionstatus","plaid::models::institutionstatusbreakdown","plaid::models::institutionstatusitemlogins","plaid::models::investmenttransaction","plaid::models::item","plaid::models::itemstatus","plaid::models::itemstatusinvestments","plaid::models::itemstatuslastwebhook","plaid::models::itemstatustransactions","plaid::models::liabilities","plaid::models::linktokenmetadata","plaid::models::mfa","plaid::models::mfa::device","plaid::models::mfa::devicelistelement","plaid::models::mfa::selection","plaid::models::numberach","plaid::models::numberbacs","plaid::models::numbereft","plaid::models::numberinternational","plaid::models::numbers","plaid::models::pslfstatus","plaid::models::payment","plaid::models::paymentamount","plaid::models::paymentrecipient","plaid::models::paymentrecipientaddress","plaid::models::paymentrecipientbacs","plaid::models::paymentschedule","plaid::models::security","plaid::models::standingordermetadata","plaid::models::studentloanliability","plaid::models::studentloanrepaymentplan","plaid::models::studentloanserviceraddress","plaid::models::studentloanstatus","plaid::models::transaction","plaid::models::transactionlocation","plaid::models::transactionpaymentmeta","plaid::models::warning","plaid::models::webhookverificationkey","plaid::multipleinstitutionsresponse","plaid::ocrolus","plaid::ocrolus::processortoken","plaid::paymentcreateresponse","plaid::paymentgetresponse","plaid::paymentinitiation","plaid::paymentlistresponse","plaid::paymentrecipientcreateresponse","plaid::paymentrecipientgetresponse","plaid::paymentrecipientlistresponse","plaid::paymenttokencreateresponse","plaid::plaidapierror","plaid::plaiderror","plaid::plaidservererror","plaid::processor","plaid::processortoken","plaid::processortokenresponse","plaid::publictoken","plaid::publictoken::createresponse","plaid::publictoken::exchangeresponse","plaid::ratelimitexceedederror","plaid::sandbox","plaid::sandboxitem","plaid::sandboxitem::firewebhookresponse","plaid::sandboxitem::resetloginresponse","plaid::sandboxpublictoken","plaid::sandboxpublictoken::sandboxcreateresponse","plaid::singleinstitutionresponse","plaid::stripe","plaid::stripe::bankaccounttoken","plaid::stripe::bankaccounttoken::createresponse","plaid::subproductmixin","plaid::transactions","plaid::transactions::getresponse","plaid::webhook","plaid::webhook::updateresponse","plaid::webhooks","plaid::webhooks::webhookverificationkeygetresponse","plaid::client#api_host()","plaid::models::basemodel#assert_property_exists!()","plaid::accounts#balance()","plaid::client::build_default_connection()","plaid::baseproduct#build_payload()","plaid::client#client()","plaid::convert_to_date_string()","plaid::apex::processortoken#create()","plaid::assetreport#create()","plaid::depositswitch#create()","plaid::dwolla::processortoken#create()","plaid::linktoken#create()","plaid::ocrolus::processortoken#create()","plaid::processortoken#create()","plaid::publictoken#create()","plaid::sandboxpublictoken#create()","plaid::stripe::bankaccounttoken#create()","plaid::assetreport#create_audit_copy()","plaid::client#create_connection()","plaid::paymentinitiation#create_payment()","plaid::paymentinitiation#create_payment_token()","plaid::paymentinitiation#create_recipient()","plaid::depositswitch#create_token()","plaid::error::error_from_type()","plaid::publictoken#exchange()","plaid::assetreport#filter()","plaid::sandboxitem#fire_webhook()","plaid::accounts#get()","plaid::assetreport#get()","plaid::auth#get()","plaid::balance#get()","plaid::categories#get()","plaid::creditdetails#get()","plaid::depositswitch#get()","plaid::holdings#get()","plaid::identity#get()","plaid::income#get()","plaid::institutions#get()","plaid::investmenttransactions#get()","plaid::item#get()","plaid::liabilities#get()","plaid::linktoken#get()","plaid::transactions#get()","plaid::assetreport#get_audit_copy()","plaid::institutions#get_by_id()","plaid::paymentinitiation#get_payment()","plaid::assetreport#get_pdf()","plaid::paymentinitiation#get_recipient()","plaid::webhooks#get_verification_key()","plaid::investments#holdings()","plaid::item#import()","plaid::accesstoken#invalidate()","plaid::client#link_token()","plaid::paymentinitiation#list_payments()","plaid::paymentinitiation#list_recipients()","plaid::baseproduct::new()","plaid::client::new()","plaid::plaidapierror::new()","plaid::middleware#on_complete()","plaid::client#post()","plaid::baseproduct#post_with_auth()","plaid::client#post_with_auth()","plaid::models::basemodel::property_ignored?()","plaid::assetreport#refresh()","plaid::transactions#refresh()","plaid::relaxed_models=()","plaid::relaxed_models?()","plaid::assetreport#remove()","plaid::item#remove()","plaid::assetreport#remove_audit_copy()","plaid::sandboxitem#reset_login()","plaid::institutions#search()","plaid::sandboxitem#set_verification_status()","plaid::subproductmixin#subproduct()","plaid::investments#transactions()","plaid::webhook#update()","",""],"info":[["Object","","classes/Object.html","",""],["Plaid","","classes/Plaid.html","","<p>The namespace for all the things Plaid.\n<p>The Plaid namespace.\n"],["Plaid::APIError","","classes/Plaid/APIError.html","","<p>Returned during planned maintenance windows and in response to API internal\nserver errors.\n"],["Plaid::AccessToken","","classes/Plaid/AccessToken.html","","<p>Class used to call the AccessToken sub-product.\n"],["Plaid::AccessToken::InvalidateResponse","","classes/Plaid/AccessToken/InvalidateResponse.html","","<p>Response for /item/access_token/invalidate.\n"],["Plaid::Accounts","","classes/Plaid/Accounts.html","","<p>Class used to call the Accounts product.\n"],["Plaid::AccountsResponse","","classes/Plaid/AccountsResponse.html","","<p>The response wrapper for /accounts/get and /accounts/balance/get.\n"],["Plaid::Apex","","classes/Plaid/Apex.html","","<p>Class used to call the Apex sub-product.\n"],["Plaid::Apex::ProcessorToken","","classes/Plaid/Apex/ProcessorToken.html","","<p>Class used to call the apex.processor_token subproduct\n"],["Plaid::AssetReport","","classes/Plaid/AssetReport.html","","<p>Class used to call the Assets product. Documentation available at\nplaid.com/docs/api/#assets.\n"],["Plaid::AssetReportCreateResponse","","classes/Plaid/AssetReportCreateResponse.html","","<p>The response wrapper for /asset_report/create.\n"],["Plaid::AssetReportFilterResponse","","classes/Plaid/AssetReportFilterResponse.html","","<p>The response wrapper for /asset_report/filter.\n"],["Plaid::AssetReportGetResponse","","classes/Plaid/AssetReportGetResponse.html","","<p>The response wrapper for /asset_report/get.\n"],["Plaid::AssetReportRefreshResponse","","classes/Plaid/AssetReportRefreshResponse.html","","<p>The response wrapper for /asset_report/refresh.\n"],["Plaid::AssetReportRemoveResponse","","classes/Plaid/AssetReportRemoveResponse.html","","<p>The response wrapper for /asset_report/remove.\n"],["Plaid::AuditCopyCreateResponse","","classes/Plaid/AuditCopyCreateResponse.html","","<p>The response wrapper for /asset_report/audit_copy/create.\n"],["Plaid::AuditCopyGetResponse","","classes/Plaid/AuditCopyGetResponse.html","","<p>The response wrapper for /asset_report/audit_copy/get.\n"],["Plaid::AuditCopyRemoveResponse","","classes/Plaid/AuditCopyRemoveResponse.html","","<p>The response wrapper for /asset_report/audit_copy/remove.\n"],["Plaid::Auth","","classes/Plaid/Auth.html","","<p>Class used to call the Auth product.\n"],["Plaid::AuthResponse","","classes/Plaid/AuthResponse.html","","<p>Response wrapper for /accounts/get and /accounts/balance/get\n"],["Plaid::Balance","","classes/Plaid/Balance.html","","<p>Class used to call the Balance product.\n"],["Plaid::BaseProduct","","classes/Plaid/BaseProduct.html","","<p>The base class for all client products\n"],["Plaid::Categories","","classes/Plaid/Categories.html","","<p>Class used to call the Categories product.\n"],["Plaid::CategoriesResponse","","classes/Plaid/CategoriesResponse.html","","<p>Response wrapper for /categories/get.\n"],["Plaid::Client","","classes/Plaid/Client.html","","<p>The main interface to Plaid API.\n"],["Plaid::CreateResponse","","classes/Plaid/CreateResponse.html","","<p>Response for /link/token/create.\n"],["Plaid::CreditDetails","","classes/Plaid/CreditDetails.html","","<p>Class used to call the CreditDetails product.\n"],["Plaid::CreditDetailsResponse","","classes/Plaid/CreditDetailsResponse.html","","<p>Response wrapper for /credit_details/get.\n"],["Plaid::DepositSwitch","","classes/Plaid/DepositSwitch.html","","<p>Class used to call the Deposit Switch product.\n"],["Plaid::DepositSwitch::CreateResponse","","classes/Plaid/DepositSwitch/CreateResponse.html","","<p>Response wrapper for /deposit_switch/create.\n"],["Plaid::DepositSwitch::CreateTokenResponse","","classes/Plaid/DepositSwitch/CreateTokenResponse.html","","<p>Response wrapper for /deposit_switch/create.\n"],["Plaid::DepositSwitch::GetResponse","","classes/Plaid/DepositSwitch/GetResponse.html","","<p>Response wrapper for /deposit_switch/get.\n"],["Plaid::Dwolla","","classes/Plaid/Dwolla.html","","<p>Class used to call the Dwolla sub-product.\n"],["Plaid::Dwolla::ProcessorToken","","classes/Plaid/Dwolla/ProcessorToken.html","","<p>Class used to call the dwolla.processor_token subproduct\n"],["Plaid::Error","","classes/Plaid/Error.html","","<p>A module that provides utilities for errors.\n"],["Plaid::GetResponse","","classes/Plaid/GetResponse.html","","<p>Response for /link/token/get.\n"],["Plaid::Holdings","","classes/Plaid/Holdings.html","","<p>Class used to get Holdings for the Investments product.\n"],["Plaid::Holdings::GetResponse","","classes/Plaid/Holdings/GetResponse.html","","<p>Response for /investments/holdings/get.\n"],["Plaid::Identity","","classes/Plaid/Identity.html","","<p>Class used to call the Identity product.\n"],["Plaid::IdentityResponse","","classes/Plaid/IdentityResponse.html","","<p>Response for /identity/get.\n"],["Plaid::Income","","classes/Plaid/Income.html","","<p>Class used to call the Income product.\n"],["Plaid::IncomeResponse","","classes/Plaid/IncomeResponse.html","","<p>Income product response.\n"],["Plaid::InstitutionError","","classes/Plaid/InstitutionError.html","","<p>Returned when there are errors for the requested financial institution.\n"],["Plaid::Institutions","","classes/Plaid/Institutions.html","","<p>Class used to call the Institutions product.\n"],["Plaid::InvalidInputError","","classes/Plaid/InvalidInputError.html","","<p>Returned when all fields are provided and are in the correct format, but\nthe values provided are incorrect …\n"],["Plaid::InvalidRequestError","","classes/Plaid/InvalidRequestError.html","","<p>Returned when the request is malformed and cannot be processed.\n"],["Plaid::InvestmentTransactions","","classes/Plaid/InvestmentTransactions.html","","<p>Class used to get InvestmentTransactions for the Investments product.\n"],["Plaid::InvestmentTransactions::GetResponse","","classes/Plaid/InvestmentTransactions/GetResponse.html","","<p>Response for /investments/transactions/get.\n"],["Plaid::Investments","","classes/Plaid/Investments.html","","<p>Class used to call the Accounts product.\n"],["Plaid::Item","","classes/Plaid/Item.html","","<p>Class used to call the Item product.\n"],["Plaid::Item::GetResponse","","classes/Plaid/Item/GetResponse.html","","<p>Response for /item/get.\n"],["Plaid::Item::ImportResponse","","classes/Plaid/Item/ImportResponse.html","","<p>Response for /item/import.\n"],["Plaid::Item::RemoveResponse","","classes/Plaid/Item/RemoveResponse.html","","<p>Response for /item/remove.\n"],["Plaid::ItemError","","classes/Plaid/ItemError.html","","<p>Indicates that information provided for the item (such as credentials or\nMFA) may be invalid or that …\n"],["Plaid::Liabilities","","classes/Plaid/Liabilities.html","","<p>Class used to call the Liabilities product.\n"],["Plaid::LiabilitiesResponse","","classes/Plaid/LiabilitiesResponse.html","","<p>Response wrapper for /liabilities/get.\n"],["Plaid::LinkToken","","classes/Plaid/LinkToken.html","","<p>Class used to call the LinkToken sub-product.\n"],["Plaid::Middleware","","classes/Plaid/Middleware.html","","<p>The Faraday middleware used to catch errors.\n"],["Plaid::Models","","classes/Plaid/Models.html","",""],["Plaid::Models::Account","","classes/Plaid/Models/Account.html","","<p>A representation of an account.\n"],["Plaid::Models::AccountWithOwners","","classes/Plaid/Models/AccountWithOwners.html","","<p>A representation of an account with owners\n"],["Plaid::Models::AssetReport","","classes/Plaid/Models/AssetReport.html","","<p>A representation of an asset report.\n"],["Plaid::Models::AssetReportAccount","","classes/Plaid/Models/AssetReportAccount.html","","<p>A representation of an asset report account.\n"],["Plaid::Models::AssetReportBalance","","classes/Plaid/Models/AssetReportBalance.html","","<p>A representation of an asset report balance.\n"],["Plaid::Models::AssetReportHistoricalBalance","","classes/Plaid/Models/AssetReportHistoricalBalance.html","","<p>A representation of an asset report historical balance.\n"],["Plaid::Models::AssetReportItem","","classes/Plaid/Models/AssetReportItem.html","","<p>A representation of an asset report item.\n"],["Plaid::Models::AssetReportOwner","","classes/Plaid/Models/AssetReportOwner.html","","<p>A representation of an asset report owner.\n"],["Plaid::Models::AssetReportTransaction","","classes/Plaid/Models/AssetReportTransaction.html","","<p>A representation of an asset report transaction.\n"],["Plaid::Models::AssetReportUser","","classes/Plaid/Models/AssetReportUser.html","","<p>A representation of an asset report user.\n"],["Plaid::Models::Balances","","classes/Plaid/Models/Balances.html","","<p>A representation of account balances.\n"],["Plaid::Models::BaseError","","classes/Plaid/Models/BaseError.html","","<p>Base error.\n"],["Plaid::Models::BaseModel","","classes/Plaid/Models/BaseModel.html","","<p>Base model for all other models.\n"],["Plaid::Models::BaseResponse","","classes/Plaid/Models/BaseResponse.html","","<p>Base API response.\n"],["Plaid::Models::Category","","classes/Plaid/Models/Category.html","","<p>A representation of a transaction category.\n"],["Plaid::Models::Cause","","classes/Plaid/Models/Cause.html","","<p>A representation of a cause.\n"],["Plaid::Models::CreditCardLiability","","classes/Plaid/Models/CreditCardLiability.html","","<p>A representation of a credit card liability\n"],["Plaid::Models::CreditCardLiabilityAPRs","","classes/Plaid/Models/CreditCardLiabilityAPRs.html","","<p>A representation of a credit card liability APR\n"],["Plaid::Models::CreditDetails","","classes/Plaid/Models/CreditDetails.html","","<p>A representation of Credit Details data.\n"],["Plaid::Models::CreditDetailsAPR","","classes/Plaid/Models/CreditDetailsAPR.html","","<p>A representation of a single Credit Details APR.\n"],["Plaid::Models::CreditDetailsAPRs","","classes/Plaid/Models/CreditDetailsAPRs.html","","<p>A representation of Credit Details APRs data.\n"],["Plaid::Models::Error","","classes/Plaid/Models/Error.html","","<p>A representation of an error.\n"],["Plaid::Models::Holding","","classes/Plaid/Models/Holding.html","","<p>A representation of a Holding in an investment account.\n"],["Plaid::Models::Identity","","classes/Plaid/Models/Identity.html","","<p>A representation of Identity data.\n"],["Plaid::Models::IdentityAddress","","classes/Plaid/Models/IdentityAddress.html","","<p>A representation of Identity address data.\n"],["Plaid::Models::IdentityAddressData","","classes/Plaid/Models/IdentityAddressData.html","","<p>A representation of Identity address details.\n"],["Plaid::Models::IdentityEmail","","classes/Plaid/Models/IdentityEmail.html","","<p>A representation of Identity email data.\n"],["Plaid::Models::IdentityPhoneNumber","","classes/Plaid/Models/IdentityPhoneNumber.html","","<p>A representation of Identity phone number data.\n"],["Plaid::Models::Income","","classes/Plaid/Models/Income.html","","<p>A representation of Income data.\n"],["Plaid::Models::IncomeStream","","classes/Plaid/Models/IncomeStream.html","","<p>A representation of Income Stream data.\n"],["Plaid::Models::Institution","","classes/Plaid/Models/Institution.html","","<p>A representation of Institution.\n"],["Plaid::Models::InstitutionCredential","","classes/Plaid/Models/InstitutionCredential.html","","<p>A representation of an institution login credential.\n"],["Plaid::Models::InstitutionPaymentInitiationMetadata","","classes/Plaid/Models/InstitutionPaymentInitiationMetadata.html","","<p>A representation of an institution&#39;s payment initiation metadata.\n"],["Plaid::Models::InstitutionStatus","","classes/Plaid/Models/InstitutionStatus.html","","<p>A representation of Institution status.\n"],["Plaid::Models::InstitutionStatusBreakdown","","classes/Plaid/Models/InstitutionStatusBreakdown.html","","<p>A representation of Institution status breakdown.\n"],["Plaid::Models::InstitutionStatusItemLogins","","classes/Plaid/Models/InstitutionStatusItemLogins.html","","<p>A representation of Institution item logins status.\n"],["Plaid::Models::InvestmentTransaction","","classes/Plaid/Models/InvestmentTransaction.html","","<p>A representation of an InvestmentTransaction in an investment account.\n"],["Plaid::Models::Item","","classes/Plaid/Models/Item.html","","<p>A representation of an item.\n"],["Plaid::Models::ItemStatus","","classes/Plaid/Models/ItemStatus.html","","<p>A representation of Item status\n"],["Plaid::Models::ItemStatusInvestments","","classes/Plaid/Models/ItemStatusInvestments.html","","<p>A representation of Item investments update status\n"],["Plaid::Models::ItemStatusLastWebhook","","classes/Plaid/Models/ItemStatusLastWebhook.html","","<p>A representation of Item webhook status\n"],["Plaid::Models::ItemStatusTransactions","","classes/Plaid/Models/ItemStatusTransactions.html","","<p>A representation of Item transaction update status\n"],["Plaid::Models::Liabilities","","classes/Plaid/Models/Liabilities.html","","<p>A representation of someone&#39;s liabilities of all types.\n"],["Plaid::Models::LinkTokenMetadata","","classes/Plaid/Models/LinkTokenMetadata.html","","<p>Metadata associated with a link token.\n"],["Plaid::Models::MFA","","classes/Plaid/Models/MFA.html","",""],["Plaid::Models::MFA::Device","","classes/Plaid/Models/MFA/Device.html","","<p>A representation of an MFA device.\n"],["Plaid::Models::MFA::DeviceListElement","","classes/Plaid/Models/MFA/DeviceListElement.html","","<p>A representation of a single element in a device list.\n"],["Plaid::Models::MFA::Selection","","classes/Plaid/Models/MFA/Selection.html","","<p>A representation of MFA selection.\n"],["Plaid::Models::NumberACH","","classes/Plaid/Models/NumberACH.html","","<p>A representation of an ACH account number.\n"],["Plaid::Models::NumberBACS","","classes/Plaid/Models/NumberBACS.html","","<p>A representation of a BACS (British) account number.\n"],["Plaid::Models::NumberEFT","","classes/Plaid/Models/NumberEFT.html","","<p>A representation of an EFT (Canadian) account number.\n"],["Plaid::Models::NumberInternational","","classes/Plaid/Models/NumberInternational.html","","<p>A representation of an International account number.\n"],["Plaid::Models::Numbers","","classes/Plaid/Models/Numbers.html","","<p>A representation of a Auth Numbers response\n"],["Plaid::Models::PSLFStatus","","classes/Plaid/Models/PSLFStatus.html","","<p>A representation of an eligibility for the Public Service Loan Forgiveness\nprogram.\n"],["Plaid::Models::Payment","","classes/Plaid/Models/Payment.html","","<p>A representation of a payment.\n"],["Plaid::Models::PaymentAmount","","classes/Plaid/Models/PaymentAmount.html","","<p>A representation of a payment amount.\n"],["Plaid::Models::PaymentRecipient","","classes/Plaid/Models/PaymentRecipient.html","","<p>A representation of a payment recipient.\n"],["Plaid::Models::PaymentRecipientAddress","","classes/Plaid/Models/PaymentRecipientAddress.html","","<p>A representation of a payment amount.\n"],["Plaid::Models::PaymentRecipientBACS","","classes/Plaid/Models/PaymentRecipientBACS.html","","<p>A representation of a payment recipient BACS number.\n"],["Plaid::Models::PaymentSchedule","","classes/Plaid/Models/PaymentSchedule.html","","<p>A representation of a payment amount.\n"],["Plaid::Models::Security","","classes/Plaid/Models/Security.html","","<p>A representation of a Security.\n"],["Plaid::Models::StandingOrderMetadata","","classes/Plaid/Models/StandingOrderMetadata.html","","<p>A representation of standing order metadata for an institution.\n"],["Plaid::Models::StudentLoanLiability","","classes/Plaid/Models/StudentLoanLiability.html","","<p>A representation of a student loan liability.\n"],["Plaid::Models::StudentLoanRepaymentPlan","","classes/Plaid/Models/StudentLoanRepaymentPlan.html","","<p>A representation of a student loan repayment plan.\n"],["Plaid::Models::StudentLoanServicerAddress","","classes/Plaid/Models/StudentLoanServicerAddress.html","","<p>A representation of a student loan servicer address.\n"],["Plaid::Models::StudentLoanStatus","","classes/Plaid/Models/StudentLoanStatus.html","","<p>A representation of the status of a student loan.\n"],["Plaid::Models::Transaction","","classes/Plaid/Models/Transaction.html","","<p>A representation of Transaction.\n"],["Plaid::Models::TransactionLocation","","classes/Plaid/Models/TransactionLocation.html","","<p>A representation of Transaction location.\n"],["Plaid::Models::TransactionPaymentMeta","","classes/Plaid/Models/TransactionPaymentMeta.html","","<p>A representation of Transaction Payment meta information.\n"],["Plaid::Models::Warning","","classes/Plaid/Models/Warning.html","","<p>A representation of a warning.\n"],["Plaid::Models::WebhookVerificationKey","","classes/Plaid/Models/WebhookVerificationKey.html","","<p>A representation of a payment amount.\n"],["Plaid::MultipleInstitutionsResponse","","classes/Plaid/MultipleInstitutionsResponse.html","","<p>Response for institutions search returning multiple institutions.\n"],["Plaid::Ocrolus","","classes/Plaid/Ocrolus.html","","<p>Class used to call the Ocrolus sub-product.\n"],["Plaid::Ocrolus::ProcessorToken","","classes/Plaid/Ocrolus/ProcessorToken.html","","<p>Class used to call the ocrolus.processor_token subproduct\n"],["Plaid::PaymentCreateResponse","","classes/Plaid/PaymentCreateResponse.html","","<p>The response wrapper for /payment_initiation/payment/create.\n"],["Plaid::PaymentGetResponse","","classes/Plaid/PaymentGetResponse.html","","<p>The response wrapper for /payment_initiation/payment/get.\n"],["Plaid::PaymentInitiation","","classes/Plaid/PaymentInitiation.html","","<p>Class used to call the Payment product.\n"],["Plaid::PaymentListResponse","","classes/Plaid/PaymentListResponse.html","","<p>The response wrapper for /payment_initiation/payment/list.\n"],["Plaid::PaymentRecipientCreateResponse","","classes/Plaid/PaymentRecipientCreateResponse.html","","<p>The response wrapper for /payment_initiation/recipient/create.\n"],["Plaid::PaymentRecipientGetResponse","","classes/Plaid/PaymentRecipientGetResponse.html","","<p>The response wrapper for /payment_initiation/recipient/get.\n"],["Plaid::PaymentRecipientListResponse","","classes/Plaid/PaymentRecipientListResponse.html","","<p>The response wrapper for /payment_initiation/recipient/list.\n"],["Plaid::PaymentTokenCreateResponse","","classes/Plaid/PaymentTokenCreateResponse.html","","<p>The response wrapper for /payment_initiation/payment/token/create.\n"],["Plaid::PlaidAPIError","","classes/Plaid/PlaidAPIError.html","","<p>Base class for any error returned by the API\n"],["Plaid::PlaidError","","classes/Plaid/PlaidError.html","","<p>Base class for Plaid SDK errors\n"],["Plaid::PlaidServerError","","classes/Plaid/PlaidServerError.html","","<p>Returned on Plaid server or network issues\n"],["Plaid::Processor","","classes/Plaid/Processor.html","","<p>Class used to call the Processor product.\n"],["Plaid::ProcessorToken","","classes/Plaid/ProcessorToken.html","","<p>Class used to call the generic ProcessorToken sub-product.\n"],["Plaid::ProcessorTokenResponse","","classes/Plaid/ProcessorTokenResponse.html","","<p>A response for /processor/…/processor_token/create.\n"],["Plaid::PublicToken","","classes/Plaid/PublicToken.html","","<p>Class used to call the PublicToken sub-product\n"],["Plaid::PublicToken::CreateResponse","","classes/Plaid/PublicToken/CreateResponse.html","","<p>Response for /item/public_token/create.\n"],["Plaid::PublicToken::ExchangeResponse","","classes/Plaid/PublicToken/ExchangeResponse.html","","<p>Response for /item/public_token/exchange.\n"],["Plaid::RateLimitExceededError","","classes/Plaid/RateLimitExceededError.html","","<p>Returned when the request is valid but has exceeded established rate\nlimits.\n"],["Plaid::Sandbox","","classes/Plaid/Sandbox.html","","<p>Class used to call the Sandbox product.\n"],["Plaid::SandboxItem","","classes/Plaid/SandboxItem.html","","<p>Class used to call the SandboxItem sub-product.\n"],["Plaid::SandboxItem::FireWebhookResponse","","classes/Plaid/SandboxItem/FireWebhookResponse.html","","<p>Response for /sandbox/item/fire_webhook.\n"],["Plaid::SandboxItem::ResetLoginResponse","","classes/Plaid/SandboxItem/ResetLoginResponse.html","","<p>Response for /sandbox/item/reset_login.\n"],["Plaid::SandboxPublicToken","","classes/Plaid/SandboxPublicToken.html","","<p>Class used to call the SandboxPublicToken sub-product\n"],["Plaid::SandboxPublicToken::SandboxCreateResponse","","classes/Plaid/SandboxPublicToken/SandboxCreateResponse.html","","<p>Response for /sandbox/public_token/create.\n"],["Plaid::SingleInstitutionResponse","","classes/Plaid/SingleInstitutionResponse.html","","<p>Response for institutions search returning a single institution.\n"],["Plaid::Stripe","","classes/Plaid/Stripe.html","","<p>Class used to call the Stripe sub-product.\n"],["Plaid::Stripe::BankAccountToken","","classes/Plaid/Stripe/BankAccountToken.html","","<p>Class used to call the BankAccountToken sub-product.\n"],["Plaid::Stripe::BankAccountToken::CreateResponse","","classes/Plaid/Stripe/BankAccountToken/CreateResponse.html","","<p>A response for /processor/stripe/bank_account_token/create.\n"],["Plaid::SubproductMixin","","classes/Plaid/SubproductMixin.html","","<p>Support for subproduct metaprogramming\n<p>Allows to write\n\n<pre><code>class SomeProduct\n  subproduct :cool, Plaid::Cool ...\n</code></pre>\n"],["Plaid::Transactions","","classes/Plaid/Transactions.html","","<p>Class used to call the Transactions product.\n"],["Plaid::Transactions::GetResponse","","classes/Plaid/Transactions/GetResponse.html","","<p>Response for /transactions/get.\n"],["Plaid::Webhook","","classes/Plaid/Webhook.html","","<p>Class used to call the Webhook sub-product\n"],["Plaid::Webhook::UpdateResponse","","classes/Plaid/Webhook/UpdateResponse.html","","<p>Response for /item/webhook/update.\n"],["Plaid::Webhooks","","classes/Plaid/Webhooks.html","","<p>Class used to call the Webhooks endpoint.\n"],["Plaid::Webhooks::WebhookVerificationKeyGetResponse","","classes/Plaid/Webhooks/WebhookVerificationKeyGetResponse.html","","<p>The response wrapper for /webhook_verification_key/get.\n"],["api_host","Plaid::Client","classes/Plaid/Client.html#method-i-api_host","()","<p>Gets the API hostname for given environment.\n<p>env &mdash; The Symbol (:sandbox, :development, :production)\n\n<p>Returns …\n"],["assert_property_exists!","Plaid::Models::BaseModel","classes/Plaid/Models/BaseModel.html#method-i-assert_property_exists-21","(property)","<p>Be strict or forgiving depending on Plaid.relaxed_models value.\n"],["balance","Plaid::Accounts","classes/Plaid/Accounts.html#method-i-balance","","<p>The Plaid::Balance product accessor.\n"],["build_default_connection","Plaid::Client","classes/Plaid/Client.html#method-c-build_default_connection","(builder)","<p>Set Plaid defaults on the Faraday connection.\n<p>builder &mdash; The Faraday builder object.\n\n"],["build_payload","Plaid::BaseProduct","classes/Plaid/BaseProduct.html#method-i-build_payload","(access_token, account_ids: nil, options: nil)","<p>Build a simple payload with access_token, options, and account_ids.\n"],["client","Plaid::Client","classes/Plaid/Client.html#method-i-client","()","<p>subproduct-generated methods depend on client method.\n"],["convert_to_date_string","Plaid","classes/Plaid.html#method-c-convert_to_date_string","(date)","<p>Converts date objects to strings if needed.\n<p>Takes in a string or a Date object and performs necessary …\n"],["create","Plaid::Apex::ProcessorToken","classes/Plaid/Apex/ProcessorToken.html#method-i-create","(access_token, account_id)","<p>Creates an Apex processor token from an access_token.\n<p>Does a POST /processor/apex/processor_token/create …\n"],["create","Plaid::AssetReport","classes/Plaid/AssetReport.html#method-i-create","(access_tokens, days_requested, options = {})","<p>Create an asset report.\n<p>access_tokens &mdash; An array of access tokens, one token for each Item to be included …\n"],["create","Plaid::DepositSwitch","classes/Plaid/DepositSwitch.html#method-i-create","(target_account_id, target_access_token)","<p>Create Deposit Switch.\n<p>Does a POST /deposit_switch/create call which creates a deposit switch\n<p>target_account_id … &mdash; "],["create","Plaid::Dwolla::ProcessorToken","classes/Plaid/Dwolla/ProcessorToken.html#method-i-create","(access_token, account_id)","<p>Creates a Dwolla processor token from an access_token.\n<p>Does a POST /processor/dwolla/processor_token/create …\n"],["create","Plaid::LinkToken","classes/Plaid/LinkToken.html#method-i-create","(configs)",""],["create","Plaid::Ocrolus::ProcessorToken","classes/Plaid/Ocrolus/ProcessorToken.html#method-i-create","(access_token, account_id)","<p>Creates a Ocrolus processor token from an access_token.\n<p>Does a POST /processor/ocrolus/processor_token/create …\n"],["create","Plaid::ProcessorToken","classes/Plaid/ProcessorToken.html#method-i-create","(access_token, account_id, processor)","<p>Creates a processor token from an access_token.\n<p>Does a POST /processor/token/create call which can be …\n"],["create","Plaid::PublicToken","classes/Plaid/PublicToken.html#method-i-create","(access_token)","<p>Creates a public token from an access_token.\n<p>Does a POST /item/public_token/create call which can be used …\n"],["create","Plaid::SandboxPublicToken","classes/Plaid/SandboxPublicToken.html#method-i-create","(institution_id:, initial_products:, transactions_start_date: nil, transactions_end_date: nil, webhook: nil, override_username: nil, override_password: nil, options: nil)","<p>Creates a public token for sandbox testing.\n<p>Does a POST /sandbox/public_token/create call which can be …\n"],["create","Plaid::Stripe::BankAccountToken","classes/Plaid/Stripe/BankAccountToken.html#method-i-create","(access_token, account_id)","<p>Creates a Stripe bank account token from an access_token.\n<p>Does a POST /processor/stripe/bank_account_token/create …\n"],["create_audit_copy","Plaid::AssetReport","classes/Plaid/AssetReport.html#method-i-create_audit_copy","(asset_report_token, auditor_id)","<p>Create an audit copy token.\n<p>asset_report_token &mdash; The asset report token from the `create` response.\n<p>auditor_id … &mdash; "],["create_connection","Plaid::Client","classes/Plaid/Client.html#method-i-create_connection","()","<p>Initializes a new Plaid connection object via Faraday.\n<p>Optionally takes a block to allow overriding the …\n"],["create_payment","Plaid::PaymentInitiation","classes/Plaid/PaymentInitiation.html#method-i-create_payment","(recipient_id, reference, amount, schedule: nil)","<p>Create a payment.\n<p>recipient_id &mdash; Recipient ID that the payment will be initiated for.\n<p>reference &mdash; Payment reference. …\n"],["create_payment_token","Plaid::PaymentInitiation","classes/Plaid/PaymentInitiation.html#method-i-create_payment_token","(payment_id)","<p>Create a payment token.\n<p>payment_id &mdash; Payment ID that the token will be created for.\n\n<p>Returns\n"],["create_recipient","Plaid::PaymentInitiation","classes/Plaid/PaymentInitiation.html#method-i-create_recipient","(name, iban, address, bacs)","<p>Create a recipient.\n<p>name &mdash; Recipient name.\n<p>iban &mdash; Recipient IBAN. Should be nil if using bacs.\n"],["create_token","Plaid::DepositSwitch","classes/Plaid/DepositSwitch.html#method-i-create_token","(deposit_switch_id)","<p>Create Deposit Switch token.\n<p>Does a POST /deposit_switch/token/create call which creates a deposit\nswitch. …\n"],["error_from_type","Plaid::Error","classes/Plaid/Error.html#method-c-error_from_type","(error_type)","<p>Map error_type to PlaidAPIError.\n<p>Maps an error_type from an error HTTP response to an actual PlaidAPIError …\n"],["exchange","Plaid::PublicToken","classes/Plaid/PublicToken.html#method-i-exchange","(public_token)","<p>Exchange a public token for an access_token\n<p>Does a POST /item/public_token/exchange call helps you exchange …\n"],["filter","Plaid::AssetReport","classes/Plaid/AssetReport.html#method-i-filter","(asset_report_token, account_ids_to_exclude)","<p>Create a new, filtered asset report.\n<p>asset_report_token &mdash; The asset report token for the asset report you …\n"],["fire_webhook","Plaid::SandboxItem","classes/Plaid/SandboxItem.html#method-i-fire_webhook","(access_token, webhook_code)","<p>Fires a webhook for a sandbox item\n<p>Does a POST /sandbox/item/fire_webhook call.\n<p>access_token &mdash; access_token …\n"],["get","Plaid::Accounts","classes/Plaid/Accounts.html#method-i-get","(access_token, account_ids: nil, options: nil)","<p>Get information about all available accounts.\n<p>Does a POST /accounts/get call to retrieve high level account …\n"],["get","Plaid::AssetReport","classes/Plaid/AssetReport.html#method-i-get","(asset_report_token, include_insights: false)","<p>Retrieve an asset report.\n<p>asset_report_token &mdash; The asset report token from the `create` response.\n<p>include_insights … &mdash; "],["get","Plaid::Auth","classes/Plaid/Auth.html#method-i-get","(access_token, account_ids: nil, options: nil)","<p>Get information about account and routing numbers for checking and savings\naccounts.\n<p>Does a POST /auth/get …\n"],["get","Plaid::Balance","classes/Plaid/Balance.html#method-i-get","(access_token, account_ids: nil, options: nil)","<p>Get information about all available balances.\n<p>Does a POST /accounts/balance/get call to get real-time …\n"],["get","Plaid::Categories","classes/Plaid/Categories.html#method-i-get","()","<p>Get information about all Plaid categories\n<p>Does a POST /categories/get call to retrieve a list of all …\n"],["get","Plaid::CreditDetails","classes/Plaid/CreditDetails.html#method-i-get","(access_token, account_ids: nil)","<p>Get information about all available credit_details.\n<p>Does a POST /credit_details/get call which fetches …\n"],["get","Plaid::DepositSwitch","classes/Plaid/DepositSwitch.html#method-i-get","(deposit_switch_id)","<p>Get Deposit Switch information.\n<p>Does a POST /deposit_switch/get call which fetches deposit switch\nassociated …\n"],["get","Plaid::Holdings","classes/Plaid/Holdings.html#method-i-get","(access_token, account_ids: nil, options: nil)","<p>Get information about all available investment holdings.\n<p>Does a POST /investments/holdings/get call which …\n"],["get","Plaid::Identity","classes/Plaid/Identity.html#method-i-get","(access_token)","<p>Get Identity information.\n<p>Does a POST /identity/get call to retrieve all info for a given\naccess_token …\n"],["get","Plaid::Income","classes/Plaid/Income.html#method-i-get","(access_token)","<p>Get information about user incomes.\n<p>Does a POST /income/get call which returns income info for an access_token\n…\n"],["get","Plaid::Institutions","classes/Plaid/Institutions.html#method-i-get","(count:, offset:, country_codes:, options: nil)","<p>Get information about Plaid institutions.\n<p>Does a POST /institutions/get call pulls a list of supported …\n"],["get","Plaid::InvestmentTransactions","classes/Plaid/InvestmentTransactions.html#method-i-get","(access_token, start_date, end_date, account_ids: nil, count: nil, offset: nil, options: nil)","<p>Get information about all available investment transactions.\n<p>Does a POST /investments/transactions/get …\n"],["get","Plaid::Item","classes/Plaid/Item.html#method-i-get","(access_token)","<p>Get information about an item.\n<p>Does a POST /item/get call which returns information about an item or  …\n"],["get","Plaid::Liabilities","classes/Plaid/Liabilities.html#method-i-get","(access_token, account_ids: nil)","<p>Get liabilities information.\n<p>Does a POST /liabilities/get call which fetches liabilities associated with\n…\n"],["get","Plaid::LinkToken","classes/Plaid/LinkToken.html#method-i-get","(link_token)",""],["get","Plaid::Transactions","classes/Plaid/Transactions.html#method-i-get","(access_token, start_date, end_date, account_ids: nil, count: nil, offset: nil, options: nil)","<p>Get information about transactions\n<p>Does a POST /transactions/get call which gives you high level account …\n"],["get_audit_copy","Plaid::AssetReport","classes/Plaid/AssetReport.html#method-i-get_audit_copy","(audit_copy_token)","<p>Retrieve an audit copy.\n<p>audit_copy_token &mdash; The audit copy token from the `create_audit_copy` response.\n\n<p>Returns …\n"],["get_by_id","Plaid::Institutions","classes/Plaid/Institutions.html#method-i-get_by_id","(institution_id, country_codes, options: nil)","<p>Get information about a Plaid institution by ID.\n<p>Does a POST /institutions/get_by_id call which allows …\n"],["get_payment","Plaid::PaymentInitiation","classes/Plaid/PaymentInitiation.html#method-i-get_payment","(payment_id)","<p>Retrieve a payment.\n<p>payment_id &mdash; The payment ID from the `create_payment` response.\n\n<p>Returns\n"],["get_pdf","Plaid::AssetReport","classes/Plaid/AssetReport.html#method-i-get_pdf","(asset_report_token)","<p>Retrieve an asset report as a PDF.\n<p>asset_report_token &mdash; The asset report token from the `create` response. …\n\n"],["get_recipient","Plaid::PaymentInitiation","classes/Plaid/PaymentInitiation.html#method-i-get_recipient","(recipient_id)","<p>Retrieve a recipient.\n<p>recipient_id &mdash; The recipient ID from the `create_recipient` response.\n\n<p>Returns\n"],["get_verification_key","Plaid::Webhooks","classes/Plaid/Webhooks.html#method-i-get_verification_key","(key_id)","<p>Retrieve a webhook verification key.\n<p>key_id &mdash; The key ID from the Plaid-Verification header.\n\n<p>Returns\n"],["holdings","Plaid::Investments","classes/Plaid/Investments.html#method-i-holdings","","<p>The Plaid::Holdings product accessor.\n"],["import","Plaid::Item","classes/Plaid/Item.html#method-i-import","(products, user_auth, options)","<p>Import an item.\n<p>Does a POST /item/import call which imports an item.\n<p>products &mdash; array of products to enable …\n"],["invalidate","Plaid::AccessToken","classes/Plaid/AccessToken.html#method-i-invalidate","(access_token)","<p>Rotate your access_token, keeping it attached to the item\n<p>Does a POST /item/access_token/invalidate call …\n"],["link_token","Plaid::Client","classes/Plaid/Client.html#method-i-link_token","","<p>:attr_reader: Public: The Plaid::LinkToken endpoint accessor.\n"],["list_payments","Plaid::PaymentInitiation","classes/Plaid/PaymentInitiation.html#method-i-list_payments","(options)","<p>List all payments.\n<p>options &mdash; Object to specify optional parameters &#39;count&#39; and &#39;cursor&#39;.\n…\n\n"],["list_recipients","Plaid::PaymentInitiation","classes/Plaid/PaymentInitiation.html#method-i-list_recipients","()","<p>List all recipients.\n<p>Returns\n<p>Returns a PaymentRecipientListResponse object.\n"],["new","Plaid::BaseProduct","classes/Plaid/BaseProduct.html#method-c-new","(client)",""],["new","Plaid::Client","classes/Plaid/Client.html#method-c-new","(env:, client_id:, secret:, &block)","<p>Construct a Client instance\n<p>Optionally takes a block to allow overriding the default Faraday connection\n…\n"],["new","Plaid::PlaidAPIError","classes/Plaid/PlaidAPIError.html#method-c-new","(error_type, error_code, error_message, display_message, request_id)","<p>Initialize an error with proper attributes.\n<p>error_type &mdash; A broad categorization of the error.\n<p>error_code … &mdash; "],["on_complete","Plaid::Middleware","classes/Plaid/Middleware.html#method-i-on_complete","(env)",""],["post","Plaid::Client","classes/Plaid/Client.html#method-i-post","(path, payload)","<p>Make a post request\n<p>path &mdash; Path or URL to make the request to\n<p>payload &mdash; The payload or data to post\n"],["post_with_auth","Plaid::BaseProduct","classes/Plaid/BaseProduct.html#method-i-post_with_auth","(path, response_class, payload)","<p>Do a POST to API and capture it into a response object.\n"],["post_with_auth","Plaid::Client","classes/Plaid/Client.html#method-i-post_with_auth","(path, payload)","<p>Make a post request with appended authentication fields\n<p>path &mdash; Path or URL to make the request to\n<p>payload … &mdash; "],["property_ignored?","Plaid::Models::BaseModel","classes/Plaid/Models/BaseModel.html#method-c-property_ignored-3F","(property)",""],["refresh","Plaid::AssetReport","classes/Plaid/AssetReport.html#method-i-refresh","(asset_report_token, days_requested, options = {})","<p>Create a new, refreshed asset report.\n<p>asset_report_token &mdash; The asset report token for the asset report you …\n"],["refresh","Plaid::Transactions","classes/Plaid/Transactions.html#method-i-refresh","(access_token)","<p>Manually refresh transactions\n<p>Does a POST /transactions/refresh call which kicks off a manual\ntransactions …\n"],["relaxed_models=","Plaid","classes/Plaid.html#method-c-relaxed_models-3D","(value)","<p>Sets value for relaxed_models.\n"],["relaxed_models?","Plaid","classes/Plaid.html#method-c-relaxed_models-3F","()","<p>Get relaxed models state.\n<p>We support two modes for parsing response bodies.\n<p>Strict mode: Unknown attributes …\n"],["remove","Plaid::AssetReport","classes/Plaid/AssetReport.html#method-i-remove","(asset_report_token)","<p>Remove an asset report.\n<p>asset_report_token &mdash; The asset report token from the `create` response.\n\n<p>Returns\n"],["remove","Plaid::Item","classes/Plaid/Item.html#method-i-remove","(access_token)","<p>Removes an item\n<p>Does a POST /item/remove call which is used to remove an item\n<p>access_token &mdash; access_token …\n"],["remove_audit_copy","Plaid::AssetReport","classes/Plaid/AssetReport.html#method-i-remove_audit_copy","(audit_copy_token)","<p>Remove an audit copy token.\n<p>audit_copy_token &mdash; The audit copy token from the `create` response.\n\n<p>Returns\n"],["reset_login","Plaid::SandboxItem","classes/Plaid/SandboxItem.html#method-i-reset_login","(access_token)","<p>Resets sandbox item login.\n<p>Does a POST /sandbox/item/reset_login call.\n<p>access_token &mdash; access_token which …\n"],["search","Plaid::Institutions","classes/Plaid/Institutions.html#method-i-search","(query, country_codes, products = nil, options: nil)","<p>Get information about all available institutions matching your query.\n<p>Does a POST /institutions/search …\n"],["set_verification_status","Plaid::SandboxItem","classes/Plaid/SandboxItem.html#method-i-set_verification_status","(access_token, account_id, verification_status)","<p>Sets the verification status for an item created via automated\nmicrodeposits\n<p>Does a POST /sandbox/item/set_verification_status …\n"],["subproduct","Plaid::SubproductMixin","classes/Plaid/SubproductMixin.html#method-i-subproduct","(name, klass = nil)",""],["transactions","Plaid::Investments","classes/Plaid/Investments.html#method-i-transactions","","<p>The Plaid::InvestmentTransactions product accessor.\n"],["update","Plaid::Webhook","classes/Plaid/Webhook.html#method-i-update","(access_token, webhook)","<p>Update webhook for an access_token.\n<p>Does a POST /item/webhook/update call which is used to update webhook …\n"],["LICENSE","","files/LICENSE_txt.html","","<p>The MIT License (MIT)\n<p>Copyright © 2017 Plaid Technologies, Inc.\n<p>Permission is hereby granted, free of …\n"],["README","","files/README_md.html","","<p>plaid-ruby <img src=\"https://circleci.com/gh/plaid/plaid-ruby.svg?style=svg&circle-token=30ee002ac2021da5b5b5a701d45fe2888af124a5\"> …\n"]]}}
+var search_data = {"index":{"searchIndex":["object","plaid","apierror","accesstoken","invalidateresponse","accounts","accountsresponse","apex","processortoken","assetreport","assetreportcreateresponse","assetreportfilterresponse","assetreportgetresponse","assetreportrefreshresponse","assetreportremoveresponse","auditcopycreateresponse","auditcopygetresponse","auditcopyremoveresponse","auth","authresponse","balance","baseproduct","categories","categoriesresponse","client","createresponse","creditdetails","creditdetailsresponse","depositswitch","createresponse","createtokenresponse","getresponse","dwolla","processortoken","error","getresponse","holdings","getresponse","identity","identityresponse","income","incomeresponse","institutionerror","institutions","invalidinputerror","invalidrequesterror","investmenttransactions","getresponse","investments","item","getresponse","importresponse","removeresponse","itemerror","liabilities","liabilitiesresponse","linktoken","middleware","models","account","accountwithowners","assetreport","assetreportaccount","assetreportbalance","assetreporthistoricalbalance","assetreportitem","assetreportowner","assetreporttransaction","assetreportuser","balances","baseerror","basemodel","baseresponse","category","cause","creditcardliability","creditcardliabilityaprs","creditdetails","creditdetailsapr","creditdetailsaprs","error","holding","identity","identityaddress","identityaddressdata","identityemail","identityphonenumber","income","incomestream","institution","institutioncredential","institutionpaymentinitiationmetadata","institutionstatus","institutionstatusbreakdown","institutionstatusitemlogins","investmenttransaction","item","itemstatus","itemstatusinvestments","itemstatuslastwebhook","itemstatustransactions","liabilities","linktokenmetadata","mfa","device","devicelistelement","selection","numberach","numberbacs","numbereft","numberinternational","numbers","pslfstatus","payment","paymentamount","paymentrecipient","paymentrecipientaddress","paymentrecipientbacs","paymentschedule","security","standingordermetadata","studentloanliability","studentloanrepaymentplan","studentloanserviceraddress","studentloanstatus","transaction","transactionlocation","transactionpaymentmeta","warning","webhookverificationkey","multipleinstitutionsresponse","ocrolus","processortoken","paymentcreateresponse","paymentgetresponse","paymentinitiation","paymentlistresponse","paymentrecipientcreateresponse","paymentrecipientgetresponse","paymentrecipientlistresponse","paymenttokencreateresponse","plaidapierror","plaiderror","plaidservererror","processor","processortoken","processortokenresponse","publictoken","createresponse","exchangeresponse","ratelimitexceedederror","sandbox","sandboxitem","firewebhookresponse","resetloginresponse","sandboxpublictoken","sandboxcreateresponse","singleinstitutionresponse","stripe","bankaccounttoken","createresponse","subproductmixin","transactions","getresponse","webhook","updateresponse","webhooks","webhookverificationkeygetresponse","api_host()","assert_property_exists!()","balance()","build_default_connection()","build_payload()","client()","convert_to_date_string()","create()","create()","create()","create()","create()","create()","create()","create()","create()","create()","create_audit_copy()","create_connection()","create_payment()","create_payment_token()","create_recipient()","create_token()","error_from_type()","exchange()","filter()","fire_webhook()","get()","get()","get()","get()","get()","get()","get()","get()","get()","get()","get()","get()","get()","get()","get()","get()","get_audit_copy()","get_by_id()","get_payment()","get_pdf()","get_recipient()","get_verification_key()","holdings()","import()","invalidate()","link_token()","list_payments()","list_recipients()","new()","new()","new()","on_complete()","post()","post_with_auth()","post_with_auth()","property_ignored?()","refresh()","refresh()","relaxed_models=()","relaxed_models?()","remove()","remove()","remove_audit_copy()","reset_login()","search()","set_verification_status()","subproduct()","transactions()","update()","license","readme"],"longSearchIndex":["object","plaid","plaid::apierror","plaid::accesstoken","plaid::accesstoken::invalidateresponse","plaid::accounts","plaid::accountsresponse","plaid::apex","plaid::apex::processortoken","plaid::assetreport","plaid::assetreportcreateresponse","plaid::assetreportfilterresponse","plaid::assetreportgetresponse","plaid::assetreportrefreshresponse","plaid::assetreportremoveresponse","plaid::auditcopycreateresponse","plaid::auditcopygetresponse","plaid::auditcopyremoveresponse","plaid::auth","plaid::authresponse","plaid::balance","plaid::baseproduct","plaid::categories","plaid::categoriesresponse","plaid::client","plaid::createresponse","plaid::creditdetails","plaid::creditdetailsresponse","plaid::depositswitch","plaid::depositswitch::createresponse","plaid::depositswitch::createtokenresponse","plaid::depositswitch::getresponse","plaid::dwolla","plaid::dwolla::processortoken","plaid::error","plaid::getresponse","plaid::holdings","plaid::holdings::getresponse","plaid::identity","plaid::identityresponse","plaid::income","plaid::incomeresponse","plaid::institutionerror","plaid::institutions","plaid::invalidinputerror","plaid::invalidrequesterror","plaid::investmenttransactions","plaid::investmenttransactions::getresponse","plaid::investments","plaid::item","plaid::item::getresponse","plaid::item::importresponse","plaid::item::removeresponse","plaid::itemerror","plaid::liabilities","plaid::liabilitiesresponse","plaid::linktoken","plaid::middleware","plaid::models","plaid::models::account","plaid::models::accountwithowners","plaid::models::assetreport","plaid::models::assetreportaccount","plaid::models::assetreportbalance","plaid::models::assetreporthistoricalbalance","plaid::models::assetreportitem","plaid::models::assetreportowner","plaid::models::assetreporttransaction","plaid::models::assetreportuser","plaid::models::balances","plaid::models::baseerror","plaid::models::basemodel","plaid::models::baseresponse","plaid::models::category","plaid::models::cause","plaid::models::creditcardliability","plaid::models::creditcardliabilityaprs","plaid::models::creditdetails","plaid::models::creditdetailsapr","plaid::models::creditdetailsaprs","plaid::models::error","plaid::models::holding","plaid::models::identity","plaid::models::identityaddress","plaid::models::identityaddressdata","plaid::models::identityemail","plaid::models::identityphonenumber","plaid::models::income","plaid::models::incomestream","plaid::models::institution","plaid::models::institutioncredential","plaid::models::institutionpaymentinitiationmetadata","plaid::models::institutionstatus","plaid::models::institutionstatusbreakdown","plaid::models::institutionstatusitemlogins","plaid::models::investmenttransaction","plaid::models::item","plaid::models::itemstatus","plaid::models::itemstatusinvestments","plaid::models::itemstatuslastwebhook","plaid::models::itemstatustransactions","plaid::models::liabilities","plaid::models::linktokenmetadata","plaid::models::mfa","plaid::models::mfa::device","plaid::models::mfa::devicelistelement","plaid::models::mfa::selection","plaid::models::numberach","plaid::models::numberbacs","plaid::models::numbereft","plaid::models::numberinternational","plaid::models::numbers","plaid::models::pslfstatus","plaid::models::payment","plaid::models::paymentamount","plaid::models::paymentrecipient","plaid::models::paymentrecipientaddress","plaid::models::paymentrecipientbacs","plaid::models::paymentschedule","plaid::models::security","plaid::models::standingordermetadata","plaid::models::studentloanliability","plaid::models::studentloanrepaymentplan","plaid::models::studentloanserviceraddress","plaid::models::studentloanstatus","plaid::models::transaction","plaid::models::transactionlocation","plaid::models::transactionpaymentmeta","plaid::models::warning","plaid::models::webhookverificationkey","plaid::multipleinstitutionsresponse","plaid::ocrolus","plaid::ocrolus::processortoken","plaid::paymentcreateresponse","plaid::paymentgetresponse","plaid::paymentinitiation","plaid::paymentlistresponse","plaid::paymentrecipientcreateresponse","plaid::paymentrecipientgetresponse","plaid::paymentrecipientlistresponse","plaid::paymenttokencreateresponse","plaid::plaidapierror","plaid::plaiderror","plaid::plaidservererror","plaid::processor","plaid::processortoken","plaid::processortokenresponse","plaid::publictoken","plaid::publictoken::createresponse","plaid::publictoken::exchangeresponse","plaid::ratelimitexceedederror","plaid::sandbox","plaid::sandboxitem","plaid::sandboxitem::firewebhookresponse","plaid::sandboxitem::resetloginresponse","plaid::sandboxpublictoken","plaid::sandboxpublictoken::sandboxcreateresponse","plaid::singleinstitutionresponse","plaid::stripe","plaid::stripe::bankaccounttoken","plaid::stripe::bankaccounttoken::createresponse","plaid::subproductmixin","plaid::transactions","plaid::transactions::getresponse","plaid::webhook","plaid::webhook::updateresponse","plaid::webhooks","plaid::webhooks::webhookverificationkeygetresponse","plaid::client#api_host()","plaid::models::basemodel#assert_property_exists!()","plaid::accounts#balance()","plaid::client::build_default_connection()","plaid::baseproduct#build_payload()","plaid::client#client()","plaid::convert_to_date_string()","plaid::apex::processortoken#create()","plaid::assetreport#create()","plaid::depositswitch#create()","plaid::dwolla::processortoken#create()","plaid::linktoken#create()","plaid::ocrolus::processortoken#create()","plaid::processortoken#create()","plaid::publictoken#create()","plaid::sandboxpublictoken#create()","plaid::stripe::bankaccounttoken#create()","plaid::assetreport#create_audit_copy()","plaid::client#create_connection()","plaid::paymentinitiation#create_payment()","plaid::paymentinitiation#create_payment_token()","plaid::paymentinitiation#create_recipient()","plaid::depositswitch#create_token()","plaid::error::error_from_type()","plaid::publictoken#exchange()","plaid::assetreport#filter()","plaid::sandboxitem#fire_webhook()","plaid::accounts#get()","plaid::assetreport#get()","plaid::auth#get()","plaid::balance#get()","plaid::categories#get()","plaid::creditdetails#get()","plaid::depositswitch#get()","plaid::holdings#get()","plaid::identity#get()","plaid::income#get()","plaid::institutions#get()","plaid::investmenttransactions#get()","plaid::item#get()","plaid::liabilities#get()","plaid::linktoken#get()","plaid::transactions#get()","plaid::assetreport#get_audit_copy()","plaid::institutions#get_by_id()","plaid::paymentinitiation#get_payment()","plaid::assetreport#get_pdf()","plaid::paymentinitiation#get_recipient()","plaid::webhooks#get_verification_key()","plaid::investments#holdings()","plaid::item#import()","plaid::accesstoken#invalidate()","plaid::client#link_token()","plaid::paymentinitiation#list_payments()","plaid::paymentinitiation#list_recipients()","plaid::baseproduct::new()","plaid::client::new()","plaid::plaidapierror::new()","plaid::middleware#on_complete()","plaid::client#post()","plaid::baseproduct#post_with_auth()","plaid::client#post_with_auth()","plaid::models::basemodel::property_ignored?()","plaid::assetreport#refresh()","plaid::transactions#refresh()","plaid::relaxed_models=()","plaid::relaxed_models?()","plaid::assetreport#remove()","plaid::item#remove()","plaid::assetreport#remove_audit_copy()","plaid::sandboxitem#reset_login()","plaid::institutions#search()","plaid::sandboxitem#set_verification_status()","plaid::subproductmixin#subproduct()","plaid::investments#transactions()","plaid::webhook#update()","",""],"info":[["Object","","classes/Object.html","",""],["Plaid","","classes/Plaid.html","","<p>The namespace for all the things Plaid.\n<p>The Plaid namespace.\n"],["Plaid::APIError","","classes/Plaid/APIError.html","","<p>Returned during planned maintenance windows and in response to API internal\nserver errors.\n"],["Plaid::AccessToken","","classes/Plaid/AccessToken.html","","<p>Class used to call the AccessToken sub-product.\n"],["Plaid::AccessToken::InvalidateResponse","","classes/Plaid/AccessToken/InvalidateResponse.html","","<p>Response for /item/access_token/invalidate.\n"],["Plaid::Accounts","","classes/Plaid/Accounts.html","","<p>Class used to call the Accounts product.\n"],["Plaid::AccountsResponse","","classes/Plaid/AccountsResponse.html","","<p>The response wrapper for /accounts/get and /accounts/balance/get.\n"],["Plaid::Apex","","classes/Plaid/Apex.html","","<p>Class used to call the Apex sub-product.\n"],["Plaid::Apex::ProcessorToken","","classes/Plaid/Apex/ProcessorToken.html","","<p>Class used to call the apex.processor_token subproduct\n"],["Plaid::AssetReport","","classes/Plaid/AssetReport.html","","<p>Class used to call the Assets product. Documentation available at\nplaid.com/docs/api/#assets.\n"],["Plaid::AssetReportCreateResponse","","classes/Plaid/AssetReportCreateResponse.html","","<p>The response wrapper for /asset_report/create.\n"],["Plaid::AssetReportFilterResponse","","classes/Plaid/AssetReportFilterResponse.html","","<p>The response wrapper for /asset_report/filter.\n"],["Plaid::AssetReportGetResponse","","classes/Plaid/AssetReportGetResponse.html","","<p>The response wrapper for /asset_report/get.\n"],["Plaid::AssetReportRefreshResponse","","classes/Plaid/AssetReportRefreshResponse.html","","<p>The response wrapper for /asset_report/refresh.\n"],["Plaid::AssetReportRemoveResponse","","classes/Plaid/AssetReportRemoveResponse.html","","<p>The response wrapper for /asset_report/remove.\n"],["Plaid::AuditCopyCreateResponse","","classes/Plaid/AuditCopyCreateResponse.html","","<p>The response wrapper for /asset_report/audit_copy/create.\n"],["Plaid::AuditCopyGetResponse","","classes/Plaid/AuditCopyGetResponse.html","","<p>The response wrapper for /asset_report/audit_copy/get.\n"],["Plaid::AuditCopyRemoveResponse","","classes/Plaid/AuditCopyRemoveResponse.html","","<p>The response wrapper for /asset_report/audit_copy/remove.\n"],["Plaid::Auth","","classes/Plaid/Auth.html","","<p>Class used to call the Auth product.\n"],["Plaid::AuthResponse","","classes/Plaid/AuthResponse.html","","<p>Response wrapper for /accounts/get and /accounts/balance/get\n"],["Plaid::Balance","","classes/Plaid/Balance.html","","<p>Class used to call the Balance product.\n"],["Plaid::BaseProduct","","classes/Plaid/BaseProduct.html","","<p>The base class for all client products\n"],["Plaid::Categories","","classes/Plaid/Categories.html","","<p>Class used to call the Categories product.\n"],["Plaid::CategoriesResponse","","classes/Plaid/CategoriesResponse.html","","<p>Response wrapper for /categories/get.\n"],["Plaid::Client","","classes/Plaid/Client.html","","<p>The main interface to Plaid API.\n"],["Plaid::CreateResponse","","classes/Plaid/CreateResponse.html","","<p>Response for /link/token/create.\n"],["Plaid::CreditDetails","","classes/Plaid/CreditDetails.html","","<p>Class used to call the CreditDetails product.\n"],["Plaid::CreditDetailsResponse","","classes/Plaid/CreditDetailsResponse.html","","<p>Response wrapper for /credit_details/get.\n"],["Plaid::DepositSwitch","","classes/Plaid/DepositSwitch.html","","<p>Class used to call the Deposit Switch product.\n"],["Plaid::DepositSwitch::CreateResponse","","classes/Plaid/DepositSwitch/CreateResponse.html","","<p>Response wrapper for /deposit_switch/create.\n"],["Plaid::DepositSwitch::CreateTokenResponse","","classes/Plaid/DepositSwitch/CreateTokenResponse.html","","<p>Response wrapper for /deposit_switch/create.\n"],["Plaid::DepositSwitch::GetResponse","","classes/Plaid/DepositSwitch/GetResponse.html","","<p>Response wrapper for /deposit_switch/get.\n"],["Plaid::Dwolla","","classes/Plaid/Dwolla.html","","<p>Class used to call the Dwolla sub-product.\n"],["Plaid::Dwolla::ProcessorToken","","classes/Plaid/Dwolla/ProcessorToken.html","","<p>Class used to call the dwolla.processor_token subproduct\n"],["Plaid::Error","","classes/Plaid/Error.html","","<p>A module that provides utilities for errors.\n"],["Plaid::GetResponse","","classes/Plaid/GetResponse.html","","<p>Response for /link/token/get.\n"],["Plaid::Holdings","","classes/Plaid/Holdings.html","","<p>Class used to get Holdings for the Investments product.\n"],["Plaid::Holdings::GetResponse","","classes/Plaid/Holdings/GetResponse.html","","<p>Response for /investments/holdings/get.\n"],["Plaid::Identity","","classes/Plaid/Identity.html","","<p>Class used to call the Identity product.\n"],["Plaid::IdentityResponse","","classes/Plaid/IdentityResponse.html","","<p>Response for /identity/get.\n"],["Plaid::Income","","classes/Plaid/Income.html","","<p>Class used to call the Income product.\n"],["Plaid::IncomeResponse","","classes/Plaid/IncomeResponse.html","","<p>Income product response.\n"],["Plaid::InstitutionError","","classes/Plaid/InstitutionError.html","","<p>Returned when there are errors for the requested financial institution.\n"],["Plaid::Institutions","","classes/Plaid/Institutions.html","","<p>Class used to call the Institutions product.\n"],["Plaid::InvalidInputError","","classes/Plaid/InvalidInputError.html","","<p>Returned when all fields are provided and are in the correct format, but\nthe values provided are incorrect …\n"],["Plaid::InvalidRequestError","","classes/Plaid/InvalidRequestError.html","","<p>Returned when the request is malformed and cannot be processed.\n"],["Plaid::InvestmentTransactions","","classes/Plaid/InvestmentTransactions.html","","<p>Class used to get InvestmentTransactions for the Investments product.\n"],["Plaid::InvestmentTransactions::GetResponse","","classes/Plaid/InvestmentTransactions/GetResponse.html","","<p>Response for /investments/transactions/get.\n"],["Plaid::Investments","","classes/Plaid/Investments.html","","<p>Class used to call the Accounts product.\n"],["Plaid::Item","","classes/Plaid/Item.html","","<p>Class used to call the Item product.\n"],["Plaid::Item::GetResponse","","classes/Plaid/Item/GetResponse.html","","<p>Response for /item/get.\n"],["Plaid::Item::ImportResponse","","classes/Plaid/Item/ImportResponse.html","","<p>Response for /item/import.\n"],["Plaid::Item::RemoveResponse","","classes/Plaid/Item/RemoveResponse.html","","<p>Response for /item/remove.\n"],["Plaid::ItemError","","classes/Plaid/ItemError.html","","<p>Indicates that information provided for the item (such as credentials or\nMFA) may be invalid or that …\n"],["Plaid::Liabilities","","classes/Plaid/Liabilities.html","","<p>Class used to call the Liabilities product.\n"],["Plaid::LiabilitiesResponse","","classes/Plaid/LiabilitiesResponse.html","","<p>Response wrapper for /liabilities/get.\n"],["Plaid::LinkToken","","classes/Plaid/LinkToken.html","","<p>Class used to call the LinkToken sub-product.\n"],["Plaid::Middleware","","classes/Plaid/Middleware.html","","<p>The Faraday middleware used to catch errors.\n"],["Plaid::Models","","classes/Plaid/Models.html","",""],["Plaid::Models::Account","","classes/Plaid/Models/Account.html","","<p>A representation of an account.\n"],["Plaid::Models::AccountWithOwners","","classes/Plaid/Models/AccountWithOwners.html","","<p>A representation of an account with owners\n"],["Plaid::Models::AssetReport","","classes/Plaid/Models/AssetReport.html","","<p>A representation of an asset report.\n"],["Plaid::Models::AssetReportAccount","","classes/Plaid/Models/AssetReportAccount.html","","<p>A representation of an asset report account.\n"],["Plaid::Models::AssetReportBalance","","classes/Plaid/Models/AssetReportBalance.html","","<p>A representation of an asset report balance.\n"],["Plaid::Models::AssetReportHistoricalBalance","","classes/Plaid/Models/AssetReportHistoricalBalance.html","","<p>A representation of an asset report historical balance.\n"],["Plaid::Models::AssetReportItem","","classes/Plaid/Models/AssetReportItem.html","","<p>A representation of an asset report item.\n"],["Plaid::Models::AssetReportOwner","","classes/Plaid/Models/AssetReportOwner.html","","<p>A representation of an asset report owner.\n"],["Plaid::Models::AssetReportTransaction","","classes/Plaid/Models/AssetReportTransaction.html","","<p>A representation of an asset report transaction.\n"],["Plaid::Models::AssetReportUser","","classes/Plaid/Models/AssetReportUser.html","","<p>A representation of an asset report user.\n"],["Plaid::Models::Balances","","classes/Plaid/Models/Balances.html","","<p>A representation of account balances.\n"],["Plaid::Models::BaseError","","classes/Plaid/Models/BaseError.html","","<p>Base error.\n"],["Plaid::Models::BaseModel","","classes/Plaid/Models/BaseModel.html","","<p>Base model for all other models.\n"],["Plaid::Models::BaseResponse","","classes/Plaid/Models/BaseResponse.html","","<p>Base API response.\n"],["Plaid::Models::Category","","classes/Plaid/Models/Category.html","","<p>A representation of a transaction category.\n"],["Plaid::Models::Cause","","classes/Plaid/Models/Cause.html","","<p>A representation of a cause.\n"],["Plaid::Models::CreditCardLiability","","classes/Plaid/Models/CreditCardLiability.html","","<p>A representation of a credit card liability\n"],["Plaid::Models::CreditCardLiabilityAPRs","","classes/Plaid/Models/CreditCardLiabilityAPRs.html","","<p>A representation of a credit card liability APR\n"],["Plaid::Models::CreditDetails","","classes/Plaid/Models/CreditDetails.html","","<p>A representation of Credit Details data.\n"],["Plaid::Models::CreditDetailsAPR","","classes/Plaid/Models/CreditDetailsAPR.html","","<p>A representation of a single Credit Details APR.\n"],["Plaid::Models::CreditDetailsAPRs","","classes/Plaid/Models/CreditDetailsAPRs.html","","<p>A representation of Credit Details APRs data.\n"],["Plaid::Models::Error","","classes/Plaid/Models/Error.html","","<p>A representation of an error.\n"],["Plaid::Models::Holding","","classes/Plaid/Models/Holding.html","","<p>A representation of a Holding in an investment account.\n"],["Plaid::Models::Identity","","classes/Plaid/Models/Identity.html","","<p>A representation of Identity data.\n"],["Plaid::Models::IdentityAddress","","classes/Plaid/Models/IdentityAddress.html","","<p>A representation of Identity address data.\n"],["Plaid::Models::IdentityAddressData","","classes/Plaid/Models/IdentityAddressData.html","","<p>A representation of Identity address details.\n"],["Plaid::Models::IdentityEmail","","classes/Plaid/Models/IdentityEmail.html","","<p>A representation of Identity email data.\n"],["Plaid::Models::IdentityPhoneNumber","","classes/Plaid/Models/IdentityPhoneNumber.html","","<p>A representation of Identity phone number data.\n"],["Plaid::Models::Income","","classes/Plaid/Models/Income.html","","<p>A representation of Income data.\n"],["Plaid::Models::IncomeStream","","classes/Plaid/Models/IncomeStream.html","","<p>A representation of Income Stream data.\n"],["Plaid::Models::Institution","","classes/Plaid/Models/Institution.html","","<p>A representation of Institution.\n"],["Plaid::Models::InstitutionCredential","","classes/Plaid/Models/InstitutionCredential.html","","<p>A representation of an institution login credential.\n"],["Plaid::Models::InstitutionPaymentInitiationMetadata","","classes/Plaid/Models/InstitutionPaymentInitiationMetadata.html","","<p>A representation of an institution&#39;s payment initiation metadata.\n"],["Plaid::Models::InstitutionStatus","","classes/Plaid/Models/InstitutionStatus.html","","<p>A representation of Institution status.\n"],["Plaid::Models::InstitutionStatusBreakdown","","classes/Plaid/Models/InstitutionStatusBreakdown.html","","<p>A representation of Institution status breakdown.\n"],["Plaid::Models::InstitutionStatusItemLogins","","classes/Plaid/Models/InstitutionStatusItemLogins.html","","<p>A representation of Institution item logins status.\n"],["Plaid::Models::InvestmentTransaction","","classes/Plaid/Models/InvestmentTransaction.html","","<p>A representation of an InvestmentTransaction in an investment account.\n"],["Plaid::Models::Item","","classes/Plaid/Models/Item.html","","<p>A representation of an item.\n"],["Plaid::Models::ItemStatus","","classes/Plaid/Models/ItemStatus.html","","<p>A representation of Item status\n"],["Plaid::Models::ItemStatusInvestments","","classes/Plaid/Models/ItemStatusInvestments.html","","<p>A representation of Item investments update status\n"],["Plaid::Models::ItemStatusLastWebhook","","classes/Plaid/Models/ItemStatusLastWebhook.html","","<p>A representation of Item webhook status\n"],["Plaid::Models::ItemStatusTransactions","","classes/Plaid/Models/ItemStatusTransactions.html","","<p>A representation of Item transaction update status\n"],["Plaid::Models::Liabilities","","classes/Plaid/Models/Liabilities.html","","<p>A representation of someone&#39;s liabilities of all types.\n"],["Plaid::Models::LinkTokenMetadata","","classes/Plaid/Models/LinkTokenMetadata.html","","<p>Metadata associated with a link token.\n"],["Plaid::Models::MFA","","classes/Plaid/Models/MFA.html","",""],["Plaid::Models::MFA::Device","","classes/Plaid/Models/MFA/Device.html","","<p>A representation of an MFA device.\n"],["Plaid::Models::MFA::DeviceListElement","","classes/Plaid/Models/MFA/DeviceListElement.html","","<p>A representation of a single element in a device list.\n"],["Plaid::Models::MFA::Selection","","classes/Plaid/Models/MFA/Selection.html","","<p>A representation of MFA selection.\n"],["Plaid::Models::NumberACH","","classes/Plaid/Models/NumberACH.html","","<p>A representation of an ACH account number.\n"],["Plaid::Models::NumberBACS","","classes/Plaid/Models/NumberBACS.html","","<p>A representation of a BACS (British) account number.\n"],["Plaid::Models::NumberEFT","","classes/Plaid/Models/NumberEFT.html","","<p>A representation of an EFT (Canadian) account number.\n"],["Plaid::Models::NumberInternational","","classes/Plaid/Models/NumberInternational.html","","<p>A representation of an International account number.\n"],["Plaid::Models::Numbers","","classes/Plaid/Models/Numbers.html","","<p>A representation of a Auth Numbers response\n"],["Plaid::Models::PSLFStatus","","classes/Plaid/Models/PSLFStatus.html","","<p>A representation of an eligibility for the Public Service Loan Forgiveness\nprogram.\n"],["Plaid::Models::Payment","","classes/Plaid/Models/Payment.html","","<p>A representation of a payment.\n"],["Plaid::Models::PaymentAmount","","classes/Plaid/Models/PaymentAmount.html","","<p>A representation of a payment amount.\n"],["Plaid::Models::PaymentRecipient","","classes/Plaid/Models/PaymentRecipient.html","","<p>A representation of a payment recipient.\n"],["Plaid::Models::PaymentRecipientAddress","","classes/Plaid/Models/PaymentRecipientAddress.html","","<p>A representation of a payment amount.\n"],["Plaid::Models::PaymentRecipientBACS","","classes/Plaid/Models/PaymentRecipientBACS.html","","<p>A representation of a payment recipient BACS number.\n"],["Plaid::Models::PaymentSchedule","","classes/Plaid/Models/PaymentSchedule.html","","<p>A representation of a payment amount.\n"],["Plaid::Models::Security","","classes/Plaid/Models/Security.html","","<p>A representation of a Security.\n"],["Plaid::Models::StandingOrderMetadata","","classes/Plaid/Models/StandingOrderMetadata.html","","<p>A representation of standing order metadata for an institution.\n"],["Plaid::Models::StudentLoanLiability","","classes/Plaid/Models/StudentLoanLiability.html","","<p>A representation of a student loan liability.\n"],["Plaid::Models::StudentLoanRepaymentPlan","","classes/Plaid/Models/StudentLoanRepaymentPlan.html","","<p>A representation of a student loan repayment plan.\n"],["Plaid::Models::StudentLoanServicerAddress","","classes/Plaid/Models/StudentLoanServicerAddress.html","","<p>A representation of a student loan servicer address.\n"],["Plaid::Models::StudentLoanStatus","","classes/Plaid/Models/StudentLoanStatus.html","","<p>A representation of the status of a student loan.\n"],["Plaid::Models::Transaction","","classes/Plaid/Models/Transaction.html","","<p>A representation of Transaction.\n"],["Plaid::Models::TransactionLocation","","classes/Plaid/Models/TransactionLocation.html","","<p>A representation of Transaction location.\n"],["Plaid::Models::TransactionPaymentMeta","","classes/Plaid/Models/TransactionPaymentMeta.html","","<p>A representation of Transaction Payment meta information.\n"],["Plaid::Models::Warning","","classes/Plaid/Models/Warning.html","","<p>A representation of a warning.\n"],["Plaid::Models::WebhookVerificationKey","","classes/Plaid/Models/WebhookVerificationKey.html","","<p>A representation of a payment amount.\n"],["Plaid::MultipleInstitutionsResponse","","classes/Plaid/MultipleInstitutionsResponse.html","","<p>Response for institutions search returning multiple institutions.\n"],["Plaid::Ocrolus","","classes/Plaid/Ocrolus.html","","<p>Class used to call the Ocrolus sub-product.\n"],["Plaid::Ocrolus::ProcessorToken","","classes/Plaid/Ocrolus/ProcessorToken.html","","<p>Class used to call the ocrolus.processor_token subproduct\n"],["Plaid::PaymentCreateResponse","","classes/Plaid/PaymentCreateResponse.html","","<p>The response wrapper for /payment_initiation/payment/create.\n"],["Plaid::PaymentGetResponse","","classes/Plaid/PaymentGetResponse.html","","<p>The response wrapper for /payment_initiation/payment/get.\n"],["Plaid::PaymentInitiation","","classes/Plaid/PaymentInitiation.html","","<p>Class used to call the Payment product.\n"],["Plaid::PaymentListResponse","","classes/Plaid/PaymentListResponse.html","","<p>The response wrapper for /payment_initiation/payment/list.\n"],["Plaid::PaymentRecipientCreateResponse","","classes/Plaid/PaymentRecipientCreateResponse.html","","<p>The response wrapper for /payment_initiation/recipient/create.\n"],["Plaid::PaymentRecipientGetResponse","","classes/Plaid/PaymentRecipientGetResponse.html","","<p>The response wrapper for /payment_initiation/recipient/get.\n"],["Plaid::PaymentRecipientListResponse","","classes/Plaid/PaymentRecipientListResponse.html","","<p>The response wrapper for /payment_initiation/recipient/list.\n"],["Plaid::PaymentTokenCreateResponse","","classes/Plaid/PaymentTokenCreateResponse.html","","<p>The response wrapper for /payment_initiation/payment/token/create.\n"],["Plaid::PlaidAPIError","","classes/Plaid/PlaidAPIError.html","","<p>Base class for any error returned by the API\n"],["Plaid::PlaidError","","classes/Plaid/PlaidError.html","","<p>Base class for Plaid SDK errors\n"],["Plaid::PlaidServerError","","classes/Plaid/PlaidServerError.html","","<p>Returned on Plaid server or network issues\n"],["Plaid::Processor","","classes/Plaid/Processor.html","","<p>Class used to call the Processor product.\n"],["Plaid::ProcessorToken","","classes/Plaid/ProcessorToken.html","","<p>Class used to call the generic ProcessorToken sub-product.\n"],["Plaid::ProcessorTokenResponse","","classes/Plaid/ProcessorTokenResponse.html","","<p>A response for /processor/…/processor_token/create.\n"],["Plaid::PublicToken","","classes/Plaid/PublicToken.html","","<p>Class used to call the PublicToken sub-product\n"],["Plaid::PublicToken::CreateResponse","","classes/Plaid/PublicToken/CreateResponse.html","","<p>Response for /item/public_token/create.\n"],["Plaid::PublicToken::ExchangeResponse","","classes/Plaid/PublicToken/ExchangeResponse.html","","<p>Response for /item/public_token/exchange.\n"],["Plaid::RateLimitExceededError","","classes/Plaid/RateLimitExceededError.html","","<p>Returned when the request is valid but has exceeded established rate\nlimits.\n"],["Plaid::Sandbox","","classes/Plaid/Sandbox.html","","<p>Class used to call the Sandbox product.\n"],["Plaid::SandboxItem","","classes/Plaid/SandboxItem.html","","<p>Class used to call the SandboxItem sub-product.\n"],["Plaid::SandboxItem::FireWebhookResponse","","classes/Plaid/SandboxItem/FireWebhookResponse.html","","<p>Response for /sandbox/item/fire_webhook.\n"],["Plaid::SandboxItem::ResetLoginResponse","","classes/Plaid/SandboxItem/ResetLoginResponse.html","","<p>Response for /sandbox/item/reset_login.\n"],["Plaid::SandboxPublicToken","","classes/Plaid/SandboxPublicToken.html","","<p>Class used to call the SandboxPublicToken sub-product\n"],["Plaid::SandboxPublicToken::SandboxCreateResponse","","classes/Plaid/SandboxPublicToken/SandboxCreateResponse.html","","<p>Response for /sandbox/public_token/create.\n"],["Plaid::SingleInstitutionResponse","","classes/Plaid/SingleInstitutionResponse.html","","<p>Response for institutions search returning a single institution.\n"],["Plaid::Stripe","","classes/Plaid/Stripe.html","","<p>Class used to call the Stripe sub-product.\n"],["Plaid::Stripe::BankAccountToken","","classes/Plaid/Stripe/BankAccountToken.html","","<p>Class used to call the BankAccountToken sub-product.\n"],["Plaid::Stripe::BankAccountToken::CreateResponse","","classes/Plaid/Stripe/BankAccountToken/CreateResponse.html","","<p>A response for /processor/stripe/bank_account_token/create.\n"],["Plaid::SubproductMixin","","classes/Plaid/SubproductMixin.html","","<p>Support for subproduct metaprogramming\n<p>Allows to write\n\n<pre><code>class SomeProduct\n  subproduct :cool, Plaid::Cool ...\n</code></pre>\n"],["Plaid::Transactions","","classes/Plaid/Transactions.html","","<p>Class used to call the Transactions product.\n"],["Plaid::Transactions::GetResponse","","classes/Plaid/Transactions/GetResponse.html","","<p>Response for /transactions/get.\n"],["Plaid::Webhook","","classes/Plaid/Webhook.html","","<p>Class used to call the Webhook sub-product\n"],["Plaid::Webhook::UpdateResponse","","classes/Plaid/Webhook/UpdateResponse.html","","<p>Response for /item/webhook/update.\n"],["Plaid::Webhooks","","classes/Plaid/Webhooks.html","","<p>Class used to call the Webhooks endpoint.\n"],["Plaid::Webhooks::WebhookVerificationKeyGetResponse","","classes/Plaid/Webhooks/WebhookVerificationKeyGetResponse.html","","<p>The response wrapper for /webhook_verification_key/get.\n"],["api_host","Plaid::Client","classes/Plaid/Client.html#method-i-api_host","()","<p>Gets the API hostname for given environment.\n<p>env &mdash; The Symbol (:sandbox, :development, :production)\n\n<p>Returns …\n"],["assert_property_exists!","Plaid::Models::BaseModel","classes/Plaid/Models/BaseModel.html#method-i-assert_property_exists-21","(property)","<p>Be strict or forgiving depending on Plaid.relaxed_models value.\n"],["balance","Plaid::Accounts","classes/Plaid/Accounts.html#method-i-balance","","<p>The Plaid::Balance product accessor.\n"],["build_default_connection","Plaid::Client","classes/Plaid/Client.html#method-c-build_default_connection","(builder)","<p>Set Plaid defaults on the Faraday connection.\n<p>builder &mdash; The Faraday builder object.\n\n"],["build_payload","Plaid::BaseProduct","classes/Plaid/BaseProduct.html#method-i-build_payload","(access_token, account_ids: nil, options: nil)","<p>Build a simple payload with access_token, options, and account_ids.\n"],["client","Plaid::Client","classes/Plaid/Client.html#method-i-client","()","<p>subproduct-generated methods depend on client method.\n"],["convert_to_date_string","Plaid","classes/Plaid.html#method-c-convert_to_date_string","(date)","<p>Converts date objects to strings if needed.\n<p>Takes in a string or a Date object and performs necessary …\n"],["create","Plaid::Apex::ProcessorToken","classes/Plaid/Apex/ProcessorToken.html#method-i-create","(access_token, account_id)","<p>Creates an Apex processor token from an access_token.\n<p>Does a POST /processor/apex/processor_token/create …\n"],["create","Plaid::AssetReport","classes/Plaid/AssetReport.html#method-i-create","(access_tokens, days_requested, options = {})","<p>Create an asset report.\n<p>access_tokens &mdash; An array of access tokens, one token for each Item to be included …\n"],["create","Plaid::DepositSwitch","classes/Plaid/DepositSwitch.html#method-i-create","(target_account_id, target_access_token)","<p>Create Deposit Switch.\n<p>Does a POST /deposit_switch/create call which creates a deposit switch\n<p>target_account_id … &mdash; "],["create","Plaid::Dwolla::ProcessorToken","classes/Plaid/Dwolla/ProcessorToken.html#method-i-create","(access_token, account_id)","<p>Creates a Dwolla processor token from an access_token.\n<p>Does a POST /processor/dwolla/processor_token/create …\n"],["create","Plaid::LinkToken","classes/Plaid/LinkToken.html#method-i-create","(configs)",""],["create","Plaid::Ocrolus::ProcessorToken","classes/Plaid/Ocrolus/ProcessorToken.html#method-i-create","(access_token, account_id)","<p>Creates a Ocrolus processor token from an access_token.\n<p>Does a POST /processor/ocrolus/processor_token/create …\n"],["create","Plaid::ProcessorToken","classes/Plaid/ProcessorToken.html#method-i-create","(access_token, account_id, processor)","<p>Creates a processor token from an access_token.\n<p>Does a POST /processor/token/create call which can be …\n"],["create","Plaid::PublicToken","classes/Plaid/PublicToken.html#method-i-create","(access_token)","<p>Creates a public token from an access_token.\n<p>Does a POST /item/public_token/create call which can be used …\n"],["create","Plaid::SandboxPublicToken","classes/Plaid/SandboxPublicToken.html#method-i-create","(institution_id:, initial_products:, transactions_start_date: nil, transactions_end_date: nil, webhook: nil, override_username: nil, override_password: nil, options: nil)","<p>Creates a public token for sandbox testing.\n<p>Does a POST /sandbox/public_token/create call which can be …\n"],["create","Plaid::Stripe::BankAccountToken","classes/Plaid/Stripe/BankAccountToken.html#method-i-create","(access_token, account_id)","<p>Creates a Stripe bank account token from an access_token.\n<p>Does a POST /processor/stripe/bank_account_token/create …\n"],["create_audit_copy","Plaid::AssetReport","classes/Plaid/AssetReport.html#method-i-create_audit_copy","(asset_report_token, auditor_id)","<p>Create an audit copy token.\n<p>asset_report_token &mdash; The asset report token from the `create` response.\n<p>auditor_id … &mdash; "],["create_connection","Plaid::Client","classes/Plaid/Client.html#method-i-create_connection","()","<p>Initializes a new Plaid connection object via Faraday.\n<p>Optionally takes a block to allow overriding the …\n"],["create_payment","Plaid::PaymentInitiation","classes/Plaid/PaymentInitiation.html#method-i-create_payment","( recipient_id, reference, amount, schedule: nil, options: nil )","<p>Create a payment.\n<p>recipient_id &mdash; Recipient ID that the payment will be initiated for.\n<p>reference &mdash; Payment reference. …\n"],["create_payment_token","Plaid::PaymentInitiation","classes/Plaid/PaymentInitiation.html#method-i-create_payment_token","(payment_id)","<p>Create a payment token.\n<p>payment_id &mdash; Payment ID that the token will be created for.\n\n<p>Returns\n"],["create_recipient","Plaid::PaymentInitiation","classes/Plaid/PaymentInitiation.html#method-i-create_recipient","(name, iban, address, bacs)","<p>Create a recipient.\n<p>name &mdash; Recipient name.\n<p>iban &mdash; Recipient IBAN. Should be nil if using bacs.\n"],["create_token","Plaid::DepositSwitch","classes/Plaid/DepositSwitch.html#method-i-create_token","(deposit_switch_id)","<p>Create Deposit Switch token.\n<p>Does a POST /deposit_switch/token/create call which creates a deposit\nswitch. …\n"],["error_from_type","Plaid::Error","classes/Plaid/Error.html#method-c-error_from_type","(error_type)","<p>Map error_type to PlaidAPIError.\n<p>Maps an error_type from an error HTTP response to an actual PlaidAPIError …\n"],["exchange","Plaid::PublicToken","classes/Plaid/PublicToken.html#method-i-exchange","(public_token)","<p>Exchange a public token for an access_token\n<p>Does a POST /item/public_token/exchange call helps you exchange …\n"],["filter","Plaid::AssetReport","classes/Plaid/AssetReport.html#method-i-filter","(asset_report_token, account_ids_to_exclude)","<p>Create a new, filtered asset report.\n<p>asset_report_token &mdash; The asset report token for the asset report you …\n"],["fire_webhook","Plaid::SandboxItem","classes/Plaid/SandboxItem.html#method-i-fire_webhook","(access_token, webhook_code)","<p>Fires a webhook for a sandbox item\n<p>Does a POST /sandbox/item/fire_webhook call.\n<p>access_token &mdash; access_token …\n"],["get","Plaid::Accounts","classes/Plaid/Accounts.html#method-i-get","(access_token, account_ids: nil, options: nil)","<p>Get information about all available accounts.\n<p>Does a POST /accounts/get call to retrieve high level account …\n"],["get","Plaid::AssetReport","classes/Plaid/AssetReport.html#method-i-get","(asset_report_token, include_insights: false)","<p>Retrieve an asset report.\n<p>asset_report_token &mdash; The asset report token from the `create` response.\n<p>include_insights … &mdash; "],["get","Plaid::Auth","classes/Plaid/Auth.html#method-i-get","(access_token, account_ids: nil, options: nil)","<p>Get information about account and routing numbers for checking and savings\naccounts.\n<p>Does a POST /auth/get …\n"],["get","Plaid::Balance","classes/Plaid/Balance.html#method-i-get","(access_token, account_ids: nil, options: nil)","<p>Get information about all available balances.\n<p>Does a POST /accounts/balance/get call to get real-time …\n"],["get","Plaid::Categories","classes/Plaid/Categories.html#method-i-get","()","<p>Get information about all Plaid categories\n<p>Does a POST /categories/get call to retrieve a list of all …\n"],["get","Plaid::CreditDetails","classes/Plaid/CreditDetails.html#method-i-get","(access_token, account_ids: nil)","<p>Get information about all available credit_details.\n<p>Does a POST /credit_details/get call which fetches …\n"],["get","Plaid::DepositSwitch","classes/Plaid/DepositSwitch.html#method-i-get","(deposit_switch_id)","<p>Get Deposit Switch information.\n<p>Does a POST /deposit_switch/get call which fetches deposit switch\nassociated …\n"],["get","Plaid::Holdings","classes/Plaid/Holdings.html#method-i-get","(access_token, account_ids: nil, options: nil)","<p>Get information about all available investment holdings.\n<p>Does a POST /investments/holdings/get call which …\n"],["get","Plaid::Identity","classes/Plaid/Identity.html#method-i-get","(access_token)","<p>Get Identity information.\n<p>Does a POST /identity/get call to retrieve all info for a given\naccess_token …\n"],["get","Plaid::Income","classes/Plaid/Income.html#method-i-get","(access_token)","<p>Get information about user incomes.\n<p>Does a POST /income/get call which returns income info for an access_token\n…\n"],["get","Plaid::Institutions","classes/Plaid/Institutions.html#method-i-get","(count:, offset:, country_codes:, options: nil)","<p>Get information about Plaid institutions.\n<p>Does a POST /institutions/get call pulls a list of supported …\n"],["get","Plaid::InvestmentTransactions","classes/Plaid/InvestmentTransactions.html#method-i-get","(access_token, start_date, end_date, account_ids: nil, count: nil, offset: nil, options: nil)","<p>Get information about all available investment transactions.\n<p>Does a POST /investments/transactions/get …\n"],["get","Plaid::Item","classes/Plaid/Item.html#method-i-get","(access_token)","<p>Get information about an item.\n<p>Does a POST /item/get call which returns information about an item or  …\n"],["get","Plaid::Liabilities","classes/Plaid/Liabilities.html#method-i-get","(access_token, account_ids: nil)","<p>Get liabilities information.\n<p>Does a POST /liabilities/get call which fetches liabilities associated with\n…\n"],["get","Plaid::LinkToken","classes/Plaid/LinkToken.html#method-i-get","(link_token)",""],["get","Plaid::Transactions","classes/Plaid/Transactions.html#method-i-get","(access_token, start_date, end_date, account_ids: nil, count: nil, offset: nil, options: nil)","<p>Get information about transactions\n<p>Does a POST /transactions/get call which gives you high level account …\n"],["get_audit_copy","Plaid::AssetReport","classes/Plaid/AssetReport.html#method-i-get_audit_copy","(audit_copy_token)","<p>Retrieve an audit copy.\n<p>audit_copy_token &mdash; The audit copy token from the `create_audit_copy` response.\n\n<p>Returns …\n"],["get_by_id","Plaid::Institutions","classes/Plaid/Institutions.html#method-i-get_by_id","(institution_id, country_codes, options: nil)","<p>Get information about a Plaid institution by ID.\n<p>Does a POST /institutions/get_by_id call which allows …\n"],["get_payment","Plaid::PaymentInitiation","classes/Plaid/PaymentInitiation.html#method-i-get_payment","(payment_id)","<p>Retrieve a payment.\n<p>payment_id &mdash; The payment ID from the `create_payment` response.\n\n<p>Returns\n"],["get_pdf","Plaid::AssetReport","classes/Plaid/AssetReport.html#method-i-get_pdf","(asset_report_token)","<p>Retrieve an asset report as a PDF.\n<p>asset_report_token &mdash; The asset report token from the `create` response. …\n\n"],["get_recipient","Plaid::PaymentInitiation","classes/Plaid/PaymentInitiation.html#method-i-get_recipient","(recipient_id)","<p>Retrieve a recipient.\n<p>recipient_id &mdash; The recipient ID from the `create_recipient` response.\n\n<p>Returns\n"],["get_verification_key","Plaid::Webhooks","classes/Plaid/Webhooks.html#method-i-get_verification_key","(key_id)","<p>Retrieve a webhook verification key.\n<p>key_id &mdash; The key ID from the Plaid-Verification header.\n\n<p>Returns\n"],["holdings","Plaid::Investments","classes/Plaid/Investments.html#method-i-holdings","","<p>The Plaid::Holdings product accessor.\n"],["import","Plaid::Item","classes/Plaid/Item.html#method-i-import","(products, user_auth, options)","<p>Import an item.\n<p>Does a POST /item/import call which imports an item.\n<p>products &mdash; array of products to enable …\n"],["invalidate","Plaid::AccessToken","classes/Plaid/AccessToken.html#method-i-invalidate","(access_token)","<p>Rotate your access_token, keeping it attached to the item\n<p>Does a POST /item/access_token/invalidate call …\n"],["link_token","Plaid::Client","classes/Plaid/Client.html#method-i-link_token","","<p>:attr_reader: Public: The Plaid::LinkToken endpoint accessor.\n"],["list_payments","Plaid::PaymentInitiation","classes/Plaid/PaymentInitiation.html#method-i-list_payments","(options)","<p>List all payments.\n<p>options &mdash; Object to specify optional parameters &#39;count&#39; and &#39;cursor&#39;.\n…\n\n"],["list_recipients","Plaid::PaymentInitiation","classes/Plaid/PaymentInitiation.html#method-i-list_recipients","()","<p>List all recipients.\n<p>Returns\n<p>Returns a PaymentRecipientListResponse object.\n"],["new","Plaid::BaseProduct","classes/Plaid/BaseProduct.html#method-c-new","(client)",""],["new","Plaid::Client","classes/Plaid/Client.html#method-c-new","(env:, client_id:, secret:, &block)","<p>Construct a Client instance\n<p>Optionally takes a block to allow overriding the default Faraday connection\n…\n"],["new","Plaid::PlaidAPIError","classes/Plaid/PlaidAPIError.html#method-c-new","(error_type, error_code, error_message, display_message, request_id)","<p>Initialize an error with proper attributes.\n<p>error_type &mdash; A broad categorization of the error.\n<p>error_code … &mdash; "],["on_complete","Plaid::Middleware","classes/Plaid/Middleware.html#method-i-on_complete","(env)",""],["post","Plaid::Client","classes/Plaid/Client.html#method-i-post","(path, payload)","<p>Make a post request\n<p>path &mdash; Path or URL to make the request to\n<p>payload &mdash; The payload or data to post\n"],["post_with_auth","Plaid::BaseProduct","classes/Plaid/BaseProduct.html#method-i-post_with_auth","(path, response_class, payload)","<p>Do a POST to API and capture it into a response object.\n"],["post_with_auth","Plaid::Client","classes/Plaid/Client.html#method-i-post_with_auth","(path, payload)","<p>Make a post request with appended authentication fields\n<p>path &mdash; Path or URL to make the request to\n<p>payload … &mdash; "],["property_ignored?","Plaid::Models::BaseModel","classes/Plaid/Models/BaseModel.html#method-c-property_ignored-3F","(property)",""],["refresh","Plaid::AssetReport","classes/Plaid/AssetReport.html#method-i-refresh","(asset_report_token, days_requested, options = {})","<p>Create a new, refreshed asset report.\n<p>asset_report_token &mdash; The asset report token for the asset report you …\n"],["refresh","Plaid::Transactions","classes/Plaid/Transactions.html#method-i-refresh","(access_token)","<p>Manually refresh transactions\n<p>Does a POST /transactions/refresh call which kicks off a manual\ntransactions …\n"],["relaxed_models=","Plaid","classes/Plaid.html#method-c-relaxed_models-3D","(value)","<p>Sets value for relaxed_models.\n"],["relaxed_models?","Plaid","classes/Plaid.html#method-c-relaxed_models-3F","()","<p>Get relaxed models state.\n<p>We support two modes for parsing response bodies.\n<p>Strict mode: Unknown attributes …\n"],["remove","Plaid::AssetReport","classes/Plaid/AssetReport.html#method-i-remove","(asset_report_token)","<p>Remove an asset report.\n<p>asset_report_token &mdash; The asset report token from the `create` response.\n\n<p>Returns\n"],["remove","Plaid::Item","classes/Plaid/Item.html#method-i-remove","(access_token)","<p>Removes an item\n<p>Does a POST /item/remove call which is used to remove an item\n<p>access_token &mdash; access_token …\n"],["remove_audit_copy","Plaid::AssetReport","classes/Plaid/AssetReport.html#method-i-remove_audit_copy","(audit_copy_token)","<p>Remove an audit copy token.\n<p>audit_copy_token &mdash; The audit copy token from the `create` response.\n\n<p>Returns\n"],["reset_login","Plaid::SandboxItem","classes/Plaid/SandboxItem.html#method-i-reset_login","(access_token)","<p>Resets sandbox item login.\n<p>Does a POST /sandbox/item/reset_login call.\n<p>access_token &mdash; access_token which …\n"],["search","Plaid::Institutions","classes/Plaid/Institutions.html#method-i-search","(query, country_codes, products = nil, options: nil)","<p>Get information about all available institutions matching your query.\n<p>Does a POST /institutions/search …\n"],["set_verification_status","Plaid::SandboxItem","classes/Plaid/SandboxItem.html#method-i-set_verification_status","(access_token, account_id, verification_status)","<p>Sets the verification status for an item created via automated\nmicrodeposits\n<p>Does a POST /sandbox/item/set_verification_status …\n"],["subproduct","Plaid::SubproductMixin","classes/Plaid/SubproductMixin.html#method-i-subproduct","(name, klass = nil)",""],["transactions","Plaid::Investments","classes/Plaid/Investments.html#method-i-transactions","","<p>The Plaid::InvestmentTransactions product accessor.\n"],["update","Plaid::Webhook","classes/Plaid/Webhook.html#method-i-update","(access_token, webhook)","<p>Update webhook for an access_token.\n<p>Does a POST /item/webhook/update call which is used to update webhook …\n"],["LICENSE","","files/LICENSE_txt.html","","<p>The MIT License (MIT)\n<p>Copyright © 2017 Plaid Technologies, Inc.\n<p>Permission is hereby granted, free of …\n"],["README","","files/README_md.html","","<p>plaid-ruby <img src=\"https://circleci.com/gh/plaid/plaid-ruby.svg?style=svg&circle-token=30ee002ac2021da5b5b5a701d45fe2888af124a5\"> …\n"]]}}