plaid 14.0.0 → 14.4.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +16 -2
- data/Gemfile.lock +2 -2
- data/Makefile +1 -1
- data/README.md +5 -5
- data/doc/rdoc/classes/Plaid/AccessToken/UpdateVersionResponse.html +118 -0
- data/doc/rdoc/classes/Plaid/AddToken/CreateResponse.html +118 -0
- data/doc/rdoc/classes/Plaid/AddToken.html +197 -0
- data/doc/rdoc/classes/Plaid/Models/Payment.html +0 -17
- data/doc/rdoc/classes/Plaid/PaymentGetResponse.html +0 -17
- data/doc/rdoc/classes/Plaid/PaymentInitiation.html +20 -23
- data/doc/rdoc/classes/Plaid.html +1 -1
- data/doc/rdoc/created.rid +28 -28
- data/doc/rdoc/files/LICENSE_txt.html +1 -1
- data/doc/rdoc/files/README_md.html +1 -1
- data/doc/rdoc/files/lib/plaid/client_rb.html +1 -1
- data/doc/rdoc/files/lib/plaid/errors_rb.html +1 -1
- data/doc/rdoc/files/lib/plaid/middleware_rb.html +1 -1
- data/doc/rdoc/files/lib/plaid/models_rb.html +1 -1
- data/doc/rdoc/files/lib/plaid/products/accounts_rb.html +1 -1
- data/doc/rdoc/files/lib/plaid/products/asset_report_rb.html +1 -1
- data/doc/rdoc/files/lib/plaid/products/auth_rb.html +1 -1
- data/doc/rdoc/files/lib/plaid/products/base_product_rb.html +1 -1
- data/doc/rdoc/files/lib/plaid/products/categories_rb.html +1 -1
- data/doc/rdoc/files/lib/plaid/products/credit_details_rb.html +1 -1
- data/doc/rdoc/files/lib/plaid/products/deposit_switch_rb.html +1 -1
- data/doc/rdoc/files/lib/plaid/products/identity_rb.html +1 -1
- data/doc/rdoc/files/lib/plaid/products/income_rb.html +1 -1
- data/doc/rdoc/files/lib/plaid/products/institutions_rb.html +1 -1
- data/doc/rdoc/files/lib/plaid/products/investments_rb.html +1 -1
- data/doc/rdoc/files/lib/plaid/products/item_rb.html +1 -1
- data/doc/rdoc/files/lib/plaid/products/liabilities_rb.html +1 -1
- data/doc/rdoc/files/lib/plaid/products/link_token_rb.html +1 -1
- data/doc/rdoc/files/lib/plaid/products/payment_initiation_rb.html +1 -1
- data/doc/rdoc/files/lib/plaid/products/processor_rb.html +1 -1
- data/doc/rdoc/files/lib/plaid/products/sandbox_rb.html +1 -1
- data/doc/rdoc/files/lib/plaid/products/transactions_rb.html +1 -1
- data/doc/rdoc/files/lib/plaid/products/webhooks_rb.html +1 -1
- data/doc/rdoc/files/lib/plaid/version_rb.html +1 -1
- data/doc/rdoc/files/lib/plaid_rb.html +1 -1
- data/doc/rdoc/js/navigation.js.gz +0 -0
- data/doc/rdoc/js/search_index.js +1 -1
- data/doc/rdoc/js/search_index.js.gz +0 -0
- data/doc/rdoc/js/searcher.js.gz +0 -0
- data/lib/plaid/api/plaid_api.rb +1001 -28
- data/lib/plaid/api_client.rb +4 -4
- data/lib/plaid/api_error.rb +3 -3
- data/lib/plaid/configuration.rb +4 -2
- data/lib/plaid/models/account_access.rb +1 -1
- data/lib/plaid/models/account_assets.rb +3 -3
- data/lib/plaid/models/account_assets_all_of.rb +1 -1
- data/lib/plaid/models/account_balance.rb +4 -4
- data/lib/plaid/models/account_base.rb +3 -3
- data/lib/plaid/models/account_filter.rb +1 -1
- data/lib/plaid/models/account_filters_response.rb +1 -1
- data/lib/plaid/models/account_identity.rb +3 -3
- data/lib/plaid/models/account_identity_all_of.rb +1 -1
- data/lib/plaid/models/account_selection_cardinality.rb +5 -3
- data/lib/plaid/models/account_subtype.rb +7 -3
- data/lib/plaid/models/account_type.rb +5 -3
- data/lib/plaid/models/accounts_balance_get_request.rb +1 -1
- data/lib/plaid/models/accounts_balance_get_request_options.rb +2 -2
- data/lib/plaid/models/accounts_get_request.rb +1 -1
- data/lib/plaid/models/accounts_get_request_options.rb +1 -1
- data/lib/plaid/models/accounts_get_response.rb +1 -1
- data/lib/plaid/models/ach_class.rb +5 -3
- data/lib/plaid/models/address.rb +1 -1
- data/lib/plaid/models/address_data.rb +1 -1
- data/lib/plaid/models/address_data_nullable.rb +1 -1
- data/lib/plaid/models/address_nullable.rb +1 -1
- data/lib/plaid/models/application.rb +2 -2
- data/lib/plaid/models/application_get_request.rb +1 -1
- data/lib/plaid/models/application_get_response.rb +1 -1
- data/lib/plaid/models/apr.rb +1 -1
- data/lib/plaid/models/asset_report.rb +2 -2
- data/lib/plaid/models/asset_report_audit_copy_create_request.rb +1 -1
- data/lib/plaid/models/asset_report_audit_copy_create_response.rb +1 -1
- data/lib/plaid/models/asset_report_audit_copy_get_request.rb +1 -1
- data/lib/plaid/models/asset_report_audit_copy_remove_request.rb +1 -1
- data/lib/plaid/models/asset_report_audit_copy_remove_response.rb +1 -1
- data/lib/plaid/models/asset_report_create_request.rb +1 -1
- data/lib/plaid/models/asset_report_create_request_options.rb +1 -1
- data/lib/plaid/models/asset_report_create_response.rb +1 -1
- data/lib/plaid/models/asset_report_filter_request.rb +1 -1
- data/lib/plaid/models/asset_report_filter_response.rb +1 -1
- data/lib/plaid/models/asset_report_get_request.rb +1 -1
- data/lib/plaid/models/asset_report_get_response.rb +1 -1
- data/lib/plaid/models/asset_report_item.rb +2 -2
- data/lib/plaid/models/asset_report_pdf_get_request.rb +1 -1
- data/lib/plaid/models/asset_report_refresh_request.rb +1 -1
- data/lib/plaid/models/asset_report_refresh_request_options.rb +1 -1
- data/lib/plaid/models/asset_report_refresh_response.rb +1 -1
- data/lib/plaid/models/asset_report_remove_request.rb +1 -1
- data/lib/plaid/models/asset_report_remove_response.rb +1 -1
- data/lib/plaid/models/asset_report_transaction.rb +2 -2
- data/lib/plaid/models/asset_report_transaction_all_of.rb +1 -1
- data/lib/plaid/models/asset_report_user.rb +1 -1
- data/lib/plaid/models/assets_error_webhook.rb +1 -1
- data/lib/plaid/models/assets_product_ready_webhook.rb +1 -1
- data/lib/plaid/models/auth_get_numbers.rb +1 -1
- data/lib/plaid/models/auth_get_request.rb +1 -1
- data/lib/plaid/models/auth_get_request_options.rb +1 -1
- data/lib/plaid/models/auth_get_response.rb +1 -1
- data/lib/plaid/models/auth_metadata.rb +220 -0
- data/lib/plaid/models/auth_supported_methods.rb +255 -0
- data/lib/plaid/models/automatically_verified_webhook.rb +1 -1
- data/lib/plaid/models/bank_initiated_return_risk.rb +1 -1
- data/lib/plaid/models/bank_transfer.rb +2 -2
- data/lib/plaid/models/bank_transfer_balance.rb +1 -1
- data/lib/plaid/models/bank_transfer_balance_get_request.rb +2 -2
- data/lib/plaid/models/bank_transfer_balance_get_response.rb +2 -2
- data/lib/plaid/models/bank_transfer_cancel_request.rb +2 -2
- data/lib/plaid/models/bank_transfer_cancel_response.rb +2 -2
- data/lib/plaid/models/bank_transfer_create_request.rb +4 -4
- data/lib/plaid/models/bank_transfer_create_response.rb +2 -2
- data/lib/plaid/models/bank_transfer_direction.rb +5 -3
- data/lib/plaid/models/bank_transfer_event.rb +1 -1
- data/lib/plaid/models/bank_transfer_event_list_request.rb +2 -2
- data/lib/plaid/models/bank_transfer_event_list_response.rb +2 -2
- data/lib/plaid/models/bank_transfer_event_sync_request.rb +2 -2
- data/lib/plaid/models/bank_transfer_event_sync_response.rb +2 -2
- data/lib/plaid/models/bank_transfer_event_type.rb +5 -3
- data/lib/plaid/models/bank_transfer_failure.rb +1 -1
- data/lib/plaid/models/bank_transfer_get_request.rb +2 -2
- data/lib/plaid/models/bank_transfer_get_response.rb +2 -2
- data/lib/plaid/models/bank_transfer_list_request.rb +2 -2
- data/lib/plaid/models/bank_transfer_list_response.rb +2 -2
- data/lib/plaid/models/bank_transfer_migrate_account_request.rb +2 -2
- data/lib/plaid/models/bank_transfer_migrate_account_response.rb +2 -2
- data/lib/plaid/models/bank_transfer_network.rb +5 -3
- data/lib/plaid/models/bank_transfer_receiver_details.rb +1 -1
- data/lib/plaid/models/bank_transfer_status.rb +5 -3
- data/lib/plaid/models/bank_transfer_sweep.rb +316 -0
- data/lib/plaid/models/bank_transfer_sweep_account.rb +238 -0
- data/lib/plaid/models/bank_transfer_sweep_get_request.rb +277 -0
- data/lib/plaid/models/bank_transfer_sweep_get_response.rb +239 -0
- data/lib/plaid/models/bank_transfer_sweep_list_request.rb +330 -0
- data/lib/plaid/models/bank_transfer_sweep_list_response.rb +241 -0
- data/lib/plaid/models/bank_transfer_type.rb +5 -3
- data/lib/plaid/models/bank_transfer_user.rb +2 -2
- data/lib/plaid/models/bank_transfers_events_update_webhook.rb +1 -1
- data/lib/plaid/models/categories_get_response.rb +1 -1
- data/lib/plaid/models/category.rb +1 -1
- data/lib/plaid/models/cause.rb +1 -1
- data/lib/plaid/models/connected_application.rb +3 -3
- data/lib/plaid/models/country_code.rb +5 -3
- data/lib/plaid/models/credit_card_liability.rb +4 -4
- data/lib/plaid/models/credit_filter.rb +1 -1
- data/lib/plaid/models/customer_initiated_return_risk.rb +1 -1
- data/lib/plaid/models/deductions.rb +232 -0
- data/lib/plaid/models/default_update_webhook.rb +1 -1
- data/lib/plaid/models/deposit_switch_address_data.rb +1 -1
- data/lib/plaid/models/deposit_switch_alt_create_request.rb +1 -1
- data/lib/plaid/models/deposit_switch_alt_create_response.rb +1 -1
- data/lib/plaid/models/deposit_switch_create_request.rb +1 -1
- data/lib/plaid/models/deposit_switch_create_request_options.rb +1 -1
- data/lib/plaid/models/deposit_switch_create_response.rb +1 -1
- data/lib/plaid/models/deposit_switch_get_request.rb +1 -1
- data/lib/plaid/models/deposit_switch_get_response.rb +3 -3
- data/lib/plaid/models/deposit_switch_state_update_webhook.rb +1 -1
- data/lib/plaid/models/deposit_switch_target_account.rb +1 -1
- data/lib/plaid/models/deposit_switch_target_user.rb +1 -1
- data/lib/plaid/models/deposit_switch_token_create_request.rb +1 -1
- data/lib/plaid/models/deposit_switch_token_create_response.rb +2 -2
- data/lib/plaid/models/depository_filter.rb +1 -1
- data/lib/plaid/models/distribution_details.rb +263 -0
- data/lib/plaid/models/document_metadata.rb +240 -0
- data/lib/plaid/models/earnings.rb +232 -0
- data/lib/plaid/models/earnings_total.rb +304 -0
- data/lib/plaid/models/email.rb +1 -1
- data/lib/plaid/models/employee.rb +30 -6
- data/lib/plaid/models/employee_income_summary_field_string.rb +1 -1
- data/lib/plaid/models/employer.rb +1 -1
- data/lib/plaid/models/employer_income_summary_field_string.rb +1 -1
- data/lib/plaid/models/employers_search_request.rb +1 -1
- data/lib/plaid/models/employers_search_response.rb +1 -1
- data/lib/plaid/models/employment_details.rb +230 -0
- data/lib/plaid/models/error.rb +1 -1
- data/lib/plaid/models/external_payment_options.rb +1 -1
- data/lib/plaid/models/external_payment_refund_details.rb +1 -1
- data/lib/plaid/models/external_payment_schedule_base.rb +4 -4
- data/lib/plaid/models/external_payment_schedule_get.rb +4 -4
- data/lib/plaid/models/external_payment_schedule_request.rb +4 -4
- data/lib/plaid/models/health_incident.rb +3 -3
- data/lib/plaid/models/historical_balance.rb +2 -2
- data/lib/plaid/models/historical_update_webhook.rb +2 -2
- data/lib/plaid/models/holding.rb +1 -1
- data/lib/plaid/models/holdings_default_update_webhook.rb +1 -1
- data/lib/plaid/models/holdings_override.rb +289 -0
- data/lib/plaid/models/identity_get_request.rb +1 -1
- data/lib/plaid/models/identity_get_request_options.rb +1 -1
- data/lib/plaid/models/identity_get_response.rb +1 -1
- data/lib/plaid/models/incident_update.rb +2 -2
- data/lib/plaid/models/income_breakdown.rb +3 -2
- data/lib/plaid/models/income_override.rb +222 -0
- data/lib/plaid/models/income_summary.rb +1 -1
- data/lib/plaid/models/income_summary_field_number.rb +1 -1
- data/lib/plaid/models/income_summary_field_string.rb +1 -1
- data/lib/plaid/models/income_verification_create_request.rb +1 -1
- data/lib/plaid/models/income_verification_create_response.rb +1 -1
- data/lib/plaid/models/income_verification_documents_download_request.rb +17 -10
- data/lib/plaid/models/income_verification_documents_download_response.rb +1 -1
- data/lib/plaid/models/income_verification_paystub_get_request.rb +252 -0
- data/lib/plaid/models/income_verification_paystub_get_response.rb +249 -0
- data/lib/plaid/models/income_verification_paystubs_get_request.rb +17 -10
- data/lib/plaid/models/income_verification_paystubs_get_response.rb +23 -2
- data/lib/plaid/models/income_verification_precheck_employer.rb +231 -0
- data/lib/plaid/models/income_verification_precheck_military_info.rb +265 -0
- data/lib/plaid/models/income_verification_precheck_request.rb +271 -0
- data/lib/plaid/models/income_verification_precheck_response.rb +289 -0
- data/lib/plaid/models/income_verification_precheck_user.rb +252 -0
- data/lib/plaid/models/income_verification_refresh_request.rb +17 -10
- data/lib/plaid/models/income_verification_refresh_response.rb +1 -1
- data/lib/plaid/models/income_verification_status_webhook.rb +1 -1
- data/lib/plaid/models/income_verification_summary_get_request.rb +17 -10
- data/lib/plaid/models/income_verification_summary_get_response.rb +1 -1
- data/lib/plaid/models/income_verification_taxforms_get_request.rb +252 -0
- data/lib/plaid/models/income_verification_taxforms_get_response.rb +263 -0
- data/lib/plaid/models/income_verification_webhook_status.rb +1 -1
- data/lib/plaid/models/inflow_model.rb +1 -1
- data/lib/plaid/models/initial_update_webhook.rb +2 -2
- data/lib/plaid/models/institution.rb +16 -6
- data/lib/plaid/models/institution_status.rb +1 -1
- data/lib/plaid/models/institutions_get_by_id_request.rb +1 -1
- data/lib/plaid/models/institutions_get_by_id_request_options.rb +14 -2
- data/lib/plaid/models/institutions_get_by_id_response.rb +1 -1
- data/lib/plaid/models/institutions_get_request.rb +1 -1
- data/lib/plaid/models/institutions_get_request_options.rb +14 -2
- data/lib/plaid/models/institutions_get_response.rb +1 -1
- data/lib/plaid/models/institutions_search_account_filter.rb +1 -1
- data/lib/plaid/models/institutions_search_payment_initiation_options.rb +1 -1
- data/lib/plaid/models/institutions_search_request.rb +1 -1
- data/lib/plaid/models/institutions_search_request_options.rb +14 -2
- data/lib/plaid/models/institutions_search_response.rb +1 -1
- data/lib/plaid/models/investment_filter.rb +1 -1
- data/lib/plaid/models/investment_holdings_get_request_options.rb +1 -1
- data/lib/plaid/models/investment_transaction.rb +4 -4
- data/lib/plaid/models/investments_default_update_webhook.rb +1 -1
- data/lib/plaid/models/investments_holdings_get_request.rb +1 -1
- data/lib/plaid/models/investments_holdings_get_response.rb +1 -1
- data/lib/plaid/models/investments_transactions_get_request.rb +1 -1
- data/lib/plaid/models/investments_transactions_get_request_options.rb +1 -1
- data/lib/plaid/models/investments_transactions_get_response.rb +1 -1
- data/lib/plaid/models/investments_transactions_override.rb +319 -0
- data/lib/plaid/models/item.rb +1 -1
- data/lib/plaid/models/item_access_token_invalidate_request.rb +1 -1
- data/lib/plaid/models/item_access_token_invalidate_response.rb +1 -1
- data/lib/plaid/models/item_application_list_request.rb +1 -1
- data/lib/plaid/models/item_application_list_response.rb +1 -1
- data/lib/plaid/models/item_application_list_user_auth.rb +1 -1
- data/lib/plaid/models/item_application_scopes_update_request.rb +29 -5
- data/lib/plaid/models/item_application_scopes_update_response.rb +1 -1
- data/lib/plaid/models/item_error_webhook.rb +1 -1
- data/lib/plaid/models/item_get_request.rb +1 -1
- data/lib/plaid/models/item_get_response.rb +1 -1
- data/lib/plaid/models/item_import_request.rb +1 -1
- data/lib/plaid/models/item_import_request_options.rb +1 -1
- data/lib/plaid/models/item_import_request_user_auth.rb +1 -1
- data/lib/plaid/models/item_import_response.rb +1 -1
- data/lib/plaid/models/item_product_ready_webhook.rb +1 -1
- data/lib/plaid/models/item_public_token_create_request.rb +1 -1
- data/lib/plaid/models/item_public_token_create_response.rb +1 -1
- data/lib/plaid/models/item_public_token_exchange_request.rb +1 -1
- data/lib/plaid/models/item_public_token_exchange_response.rb +1 -1
- data/lib/plaid/models/item_remove_request.rb +1 -1
- data/lib/plaid/models/item_remove_response.rb +1 -1
- data/lib/plaid/models/item_status.rb +1 -1
- data/lib/plaid/models/item_status_investments.rb +3 -3
- data/lib/plaid/models/item_status_last_webhook.rb +2 -2
- data/lib/plaid/models/item_status_nullable.rb +1 -1
- data/lib/plaid/models/item_status_transactions.rb +3 -3
- data/lib/plaid/models/item_webhook_update_request.rb +1 -1
- data/lib/plaid/models/item_webhook_update_response.rb +1 -1
- data/lib/plaid/models/jwk_public_key.rb +3 -1
- data/lib/plaid/models/jwt_header.rb +1 -1
- data/lib/plaid/models/liabilities_default_update_webhook.rb +1 -1
- data/lib/plaid/models/liabilities_get_request.rb +1 -1
- data/lib/plaid/models/liabilities_get_request_options.rb +1 -1
- data/lib/plaid/models/liabilities_get_response.rb +1 -1
- data/lib/plaid/models/liabilities_object.rb +1 -1
- data/lib/plaid/models/liability_override.rb +2 -2
- data/lib/plaid/models/link_token_account_filters.rb +1 -1
- data/lib/plaid/models/link_token_create_request.rb +16 -7
- data/lib/plaid/models/link_token_create_request_account_subtypes.rb +1 -1
- data/lib/plaid/models/link_token_create_request_auth.rb +1 -1
- data/lib/plaid/models/link_token_create_request_deposit_switch.rb +1 -1
- data/lib/plaid/models/link_token_create_request_income_verification.rb +1 -1
- data/lib/plaid/models/link_token_create_request_payment_initiation.rb +1 -1
- data/lib/plaid/models/link_token_create_request_update.rb +222 -0
- data/lib/plaid/models/link_token_create_request_user.rb +4 -4
- data/lib/plaid/models/link_token_create_response.rb +2 -2
- data/lib/plaid/models/link_token_eu_config.rb +1 -1
- data/lib/plaid/models/link_token_get_metadata_response.rb +1 -1
- data/lib/plaid/models/link_token_get_request.rb +1 -1
- data/lib/plaid/models/link_token_get_response.rb +3 -3
- data/lib/plaid/models/loan_filter.rb +1 -1
- data/lib/plaid/models/location.rb +1 -1
- data/lib/plaid/models/meta.rb +1 -1
- data/lib/plaid/models/mfa.rb +1 -1
- data/lib/plaid/models/mortgage_interest_rate.rb +1 -1
- data/lib/plaid/models/mortgage_liability.rb +5 -5
- data/lib/plaid/models/mortgage_property_address.rb +1 -1
- data/lib/plaid/models/net_pay.rb +230 -0
- data/lib/plaid/models/new_accounts_available_webhook.rb +250 -0
- data/lib/plaid/models/numbers.rb +1 -1
- data/lib/plaid/models/numbers_ach.rb +1 -1
- data/lib/plaid/models/numbers_ach_nullable.rb +1 -1
- data/lib/plaid/models/numbers_bacs.rb +1 -1
- data/lib/plaid/models/numbers_bacs_nullable.rb +1 -1
- data/lib/plaid/models/numbers_eft.rb +1 -1
- data/lib/plaid/models/numbers_eft_nullable.rb +1 -1
- data/lib/plaid/models/numbers_international.rb +1 -1
- data/lib/plaid/models/numbers_international_nullable.rb +1 -1
- data/lib/plaid/models/override_account_type.rb +6 -3
- data/lib/plaid/models/override_accounts.rb +32 -5
- data/lib/plaid/models/owner.rb +1 -1
- data/lib/plaid/models/owner_override.rb +1 -1
- data/lib/plaid/models/pay.rb +258 -0
- data/lib/plaid/models/pay_frequency.rb +1 -1
- data/lib/plaid/models/pay_period_details.rb +4 -4
- data/lib/plaid/models/payment_amount.rb +1 -1
- data/lib/plaid/models/payment_initiation_address.rb +1 -1
- data/lib/plaid/models/payment_initiation_metadata.rb +1 -1
- data/lib/plaid/models/payment_initiation_optional_restriction_bacs.rb +1 -1
- data/lib/plaid/models/payment_initiation_payment.rb +14 -2
- data/lib/plaid/models/payment_initiation_payment_create_request.rb +1 -1
- data/lib/plaid/models/payment_initiation_payment_create_response.rb +1 -1
- data/lib/plaid/models/payment_initiation_payment_get_request.rb +1 -1
- data/lib/plaid/models/payment_initiation_payment_get_response.rb +14 -2
- data/lib/plaid/models/payment_initiation_payment_list_request.rb +28 -2
- data/lib/plaid/models/payment_initiation_payment_list_response.rb +1 -1
- data/lib/plaid/models/payment_initiation_payment_reverse_request.rb +266 -0
- data/lib/plaid/models/payment_initiation_payment_reverse_response.rb +289 -0
- data/lib/plaid/models/payment_initiation_payment_token_create_request.rb +1 -1
- data/lib/plaid/models/payment_initiation_payment_token_create_response.rb +2 -2
- data/lib/plaid/models/payment_initiation_recipient.rb +1 -1
- data/lib/plaid/models/payment_initiation_recipient_create_request.rb +1 -1
- data/lib/plaid/models/payment_initiation_recipient_create_response.rb +1 -1
- data/lib/plaid/models/payment_initiation_recipient_get_request.rb +1 -1
- data/lib/plaid/models/payment_initiation_recipient_get_response.rb +1 -1
- data/lib/plaid/models/payment_initiation_recipient_get_response_all_of.rb +1 -1
- data/lib/plaid/models/payment_initiation_recipient_list_request.rb +1 -1
- data/lib/plaid/models/payment_initiation_recipient_list_response.rb +1 -1
- data/lib/plaid/models/payment_initiation_refund.rb +303 -0
- data/lib/plaid/models/payment_initiation_standing_order_metadata.rb +1 -1
- data/lib/plaid/models/payment_meta.rb +1 -1
- data/lib/plaid/models/payment_schedule_interval.rb +5 -3
- data/lib/plaid/models/payment_status_update_webhook.rb +3 -3
- data/lib/plaid/models/paystub.rb +58 -12
- data/lib/plaid/models/paystub_address.rb +297 -0
- data/lib/plaid/models/paystub_deduction.rb +1 -1
- data/lib/plaid/models/paystub_details.rb +299 -0
- data/lib/plaid/models/paystub_employer.rb +15 -6
- data/lib/plaid/models/paystub_override.rb +248 -0
- data/lib/plaid/models/paystub_override_employee.rb +229 -0
- data/lib/plaid/models/paystub_override_employee_address.rb +260 -0
- data/lib/plaid/models/paystub_override_employer.rb +220 -0
- data/lib/plaid/models/paystub_ytd_details.rb +3 -11
- data/lib/plaid/models/pending_expiration_webhook.rb +2 -2
- data/lib/plaid/models/personal_finance_category.rb +240 -0
- data/lib/plaid/models/phone_number.rb +1 -1
- data/lib/plaid/models/processor_apex_processor_token_create_request.rb +1 -1
- data/lib/plaid/models/processor_auth_get_request.rb +1 -1
- data/lib/plaid/models/processor_auth_get_response.rb +1 -1
- data/lib/plaid/models/processor_balance_get_request.rb +14 -5
- data/lib/plaid/models/processor_balance_get_request_options.rb +220 -0
- data/lib/plaid/models/processor_balance_get_response.rb +1 -1
- data/lib/plaid/models/processor_bank_transfer_create_request.rb +4 -4
- data/lib/plaid/models/processor_bank_transfer_create_response.rb +2 -2
- data/lib/plaid/models/processor_identity_get_request.rb +1 -1
- data/lib/plaid/models/processor_identity_get_response.rb +1 -1
- data/lib/plaid/models/processor_number.rb +1 -1
- data/lib/plaid/models/processor_stripe_bank_account_token_create_request.rb +1 -1
- data/lib/plaid/models/processor_stripe_bank_account_token_create_response.rb +1 -1
- data/lib/plaid/models/processor_token_create_request.rb +3 -3
- data/lib/plaid/models/processor_token_create_response.rb +1 -1
- data/lib/plaid/models/product_access.rb +1 -1
- data/lib/plaid/models/product_status.rb +2 -2
- data/lib/plaid/models/product_status_breakdown.rb +1 -1
- data/lib/plaid/models/products.rb +6 -4
- data/lib/plaid/models/projected_income_summary_field_number.rb +1 -1
- data/lib/plaid/models/pslf_status.rb +2 -2
- data/lib/plaid/models/recaptcha_required_error.rb +1 -1
- data/lib/plaid/models/recipient_bacs.rb +1 -1
- data/lib/plaid/models/recipient_bacs_nullable.rb +1 -1
- data/lib/plaid/models/recurring_transaction_frequency.rb +42 -0
- data/lib/plaid/models/requested_scopes.rb +1 -1
- data/lib/plaid/models/sandbox_bank_transfer_fire_webhook_request.rb +2 -2
- data/lib/plaid/models/sandbox_bank_transfer_fire_webhook_response.rb +2 -2
- data/lib/plaid/models/sandbox_bank_transfer_simulate_request.rb +2 -2
- data/lib/plaid/models/sandbox_bank_transfer_simulate_response.rb +2 -2
- data/lib/plaid/models/sandbox_income_fire_webhook_request.rb +1 -1
- data/lib/plaid/models/sandbox_income_fire_webhook_response.rb +1 -1
- data/lib/plaid/models/sandbox_item_fire_webhook_request.rb +1 -1
- data/lib/plaid/models/sandbox_item_fire_webhook_response.rb +1 -1
- data/lib/plaid/models/sandbox_item_reset_login_request.rb +1 -1
- data/lib/plaid/models/sandbox_item_reset_login_response.rb +1 -1
- data/lib/plaid/models/sandbox_item_set_verification_status_request.rb +1 -1
- data/lib/plaid/models/sandbox_item_set_verification_status_response.rb +1 -1
- data/lib/plaid/models/sandbox_oauth_select_accounts_request.rb +1 -1
- data/lib/plaid/models/sandbox_processor_token_create_request.rb +1 -1
- data/lib/plaid/models/sandbox_processor_token_create_request_options.rb +1 -1
- data/lib/plaid/models/sandbox_processor_token_create_response.rb +1 -1
- data/lib/plaid/models/sandbox_public_token_create_request.rb +1 -1
- data/lib/plaid/models/sandbox_public_token_create_request_options.rb +1 -1
- data/lib/plaid/models/sandbox_public_token_create_request_options_transactions.rb +1 -1
- data/lib/plaid/models/sandbox_public_token_create_response.rb +1 -1
- data/lib/plaid/models/sandbox_transfer_simulate_request.rb +270 -0
- data/lib/plaid/models/sandbox_transfer_simulate_response.rb +225 -0
- data/lib/plaid/models/scopes.rb +1 -1
- data/lib/plaid/models/scopes_context.rb +39 -0
- data/lib/plaid/models/scopes_nullable.rb +1 -1
- data/lib/plaid/models/security.rb +1 -1
- data/lib/plaid/models/security_override.rb +270 -0
- data/lib/plaid/models/sender_bacs_nullable.rb +1 -1
- data/lib/plaid/models/servicer_address_data.rb +1 -1
- data/lib/plaid/models/signal_address_data.rb +1 -1
- data/lib/plaid/models/signal_decision_report_request.rb +2 -1
- data/lib/plaid/models/signal_decision_report_response.rb +2 -1
- data/lib/plaid/models/signal_device.rb +1 -1
- data/lib/plaid/models/signal_evaluate_core_attributes.rb +2 -2
- data/lib/plaid/models/signal_evaluate_request.rb +2 -1
- data/lib/plaid/models/signal_evaluate_response.rb +2 -1
- data/lib/plaid/models/signal_person_name.rb +1 -1
- data/lib/plaid/models/signal_return_report_request.rb +2 -1
- data/lib/plaid/models/signal_return_report_response.rb +2 -1
- data/lib/plaid/models/signal_scores.rb +2 -1
- data/lib/plaid/models/signal_user.rb +1 -1
- data/lib/plaid/models/standalone_account_type.rb +1 -1
- data/lib/plaid/models/standalone_currency_code_list.rb +1 -1
- data/lib/plaid/models/standalone_investment_transaction_type.rb +3 -3
- data/lib/plaid/models/student_loan.rb +7 -7
- data/lib/plaid/models/student_loan_repayment_model.rb +1 -1
- data/lib/plaid/models/student_loan_status.rb +2 -2
- data/lib/plaid/models/student_repayment_plan.rb +1 -1
- data/lib/plaid/models/taxform.rb +233 -0
- data/lib/plaid/models/taxpayer_id.rb +257 -0
- data/lib/plaid/models/total.rb +284 -0
- data/lib/plaid/models/transaction.rb +31 -10
- data/lib/plaid/models/transaction_all_of.rb +30 -9
- data/lib/plaid/models/transaction_base.rb +2 -2
- data/lib/plaid/models/transaction_code.rb +5 -3
- data/lib/plaid/models/transaction_data.rb +2 -2
- data/lib/plaid/models/transaction_override.rb +3 -3
- data/lib/plaid/models/transaction_stream.rb +377 -0
- data/lib/plaid/models/transaction_stream_amount.rb +242 -0
- data/lib/plaid/models/transactions_get_request.rb +1 -1
- data/lib/plaid/models/transactions_get_request_options.rb +18 -6
- data/lib/plaid/models/transactions_get_response.rb +1 -1
- data/lib/plaid/models/transactions_recurring_get_request.rb +252 -0
- data/lib/plaid/models/transactions_recurring_get_response.rb +254 -0
- data/lib/plaid/models/transactions_refresh_request.rb +1 -1
- data/lib/plaid/models/transactions_refresh_response.rb +1 -1
- data/lib/plaid/models/transactions_removed_webhook.rb +1 -1
- data/lib/plaid/models/transfer.rb +417 -0
- data/lib/plaid/models/transfer_authorization.rb +313 -0
- data/lib/plaid/models/transfer_authorization_create_request.rb +350 -0
- data/lib/plaid/models/transfer_authorization_create_response.rb +239 -0
- data/lib/plaid/models/transfer_authorization_decision_rationale.rb +274 -0
- data/lib/plaid/models/transfer_authorization_device.rb +230 -0
- data/lib/plaid/models/transfer_authorization_proposed_transfer.rb +312 -0
- data/lib/plaid/models/transfer_cancel_request.rb +245 -0
- data/lib/plaid/models/transfer_cancel_response.rb +225 -0
- data/lib/plaid/models/transfer_create_request.rb +451 -0
- data/lib/plaid/models/transfer_create_response.rb +239 -0
- data/lib/plaid/models/transfer_event.rb +355 -0
- data/lib/plaid/models/transfer_event_list_request.rb +411 -0
- data/lib/plaid/models/transfer_event_list_response.rb +241 -0
- data/lib/plaid/models/transfer_event_sync_request.rb +305 -0
- data/lib/plaid/models/transfer_event_sync_response.rb +241 -0
- data/lib/plaid/models/transfer_event_type.rb +42 -0
- data/lib/plaid/models/transfer_failure.rb +231 -0
- data/lib/plaid/models/transfer_get_request.rb +245 -0
- data/lib/plaid/models/transfer_get_response.rb +239 -0
- data/lib/plaid/models/transfer_list_request.rb +330 -0
- data/lib/plaid/models/transfer_list_response.rb +241 -0
- data/lib/plaid/models/transfer_network.rb +39 -0
- data/lib/plaid/models/transfer_status.rb +42 -0
- data/lib/plaid/models/transfer_type.rb +39 -0
- data/lib/plaid/models/transfer_user_address_in_request.rb +260 -0
- data/lib/plaid/models/transfer_user_address_in_response.rb +265 -0
- data/lib/plaid/models/transfer_user_in_request.rb +254 -0
- data/lib/plaid/models/transfer_user_in_response.rb +257 -0
- data/lib/plaid/models/user_custom_password.rb +1 -1
- data/lib/plaid/models/user_permission_revoked_webhook.rb +1 -1
- data/lib/plaid/models/verification_expired_webhook.rb +1 -1
- data/lib/plaid/models/verification_refresh_status.rb +5 -3
- data/lib/plaid/models/verification_status.rb +5 -3
- data/lib/plaid/models/w2.rb +437 -0
- data/lib/plaid/models/w2_box12.rb +231 -0
- data/lib/plaid/models/w2_state_and_local_wages.rb +286 -0
- data/lib/plaid/models/warning.rb +1 -1
- data/lib/plaid/models/webhook_update_acknowledged_webhook.rb +1 -1
- data/lib/plaid/models/webhook_verification_key_get_request.rb +1 -1
- data/lib/plaid/models/webhook_verification_key_get_response.rb +1 -1
- data/lib/plaid/models/ytd_gross_income_summary_field_number.rb +1 -1
- data/lib/plaid/models/ytd_net_income_summary_field_number.rb +1 -1
- data/lib/plaid/version.rb +2 -2
- data/lib/plaid.rb +86 -2
- data/pkg/plaid-10.0.0.gem +0 -0
- data/pkg/plaid-11.0.0.gem +0 -0
- data/pkg/plaid-12.0.0.gem +0 -0
- data/pkg/plaid-13.1.0.gem +0 -0
- data/pkg/plaid-14.3.0.gem +0 -0
- data/pkg/plaid-14.4.0.gem +0 -0
- data/pkg/plaid-8.5.0.gem +0 -0
- data/pkg/plaid-8.6.0.gem +0 -0
- data/pkg/plaid-8.7.0.gem +0 -0
- data/pkg/plaid-8.8.0.gem +0 -0
- data/pkg/plaid-9.0.0.gem +0 -0
- data/plaid.gemspec +1 -1
- data/templates/ruby/api_client.mustache +1 -2
- data/templates/ruby/api_client_faraday_partial.mustache +2 -1
- data/templates/ruby/api_error.mustache +49 -0
- data/templates/ruby/configuration.mustache +3 -1
- data/templates/ruby/partial_model_enum_class.mustache +22 -0
- data/test/test_accounts.rb +4 -8
- data/test/test_item.rb +0 -1
- metadata +106 -11
- data/doc/rdoc/.DS_Store +0 -0
- data/lib/plaid/.DS_Store +0 -0
- data/lib/plaid/models/standalone_investment_transaction_subtype.rb +0 -650
- data/pkg/plaid-13.2.0.gem +0 -0
- data/pkg/plaid-14.0.0.beta.3.gem +0 -0
- data/pkg/plaid-14.0.0.beta.5.gem +0 -0
data/lib/plaid/api/plaid_api.rb
CHANGED
@@ -3,7 +3,7 @@
|
|
3
3
|
|
4
4
|
#The Plaid REST API. Please see https://plaid.com/docs/api for more details.
|
5
5
|
|
6
|
-
The version of the OpenAPI document: 2020-09-14_1.
|
6
|
+
The version of the OpenAPI document: 2020-09-14_1.34.1
|
7
7
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
OpenAPI Generator version: 5.1.0
|
@@ -1125,7 +1125,7 @@ module Plaid
|
|
1125
1125
|
end
|
1126
1126
|
|
1127
1127
|
# Sync bank transfer events
|
1128
|
-
# `/bank_transfer/event/sync` allows you to request up to the next 25 bank transfer events that happened after a specific `event_id`. Use the `/bank_transfer/event/sync` endpoint to guarantee you have seen all bank transfer events.
|
1128
|
+
# `/bank_transfer/event/sync` allows you to request up to the next 25 bank transfer events that happened after a specific `event_id`. Use the `/bank_transfer/event/sync` endpoint to guarantee you have seen all bank transfer events.
|
1129
1129
|
# @param bank_transfer_event_sync_request [BankTransferEventSyncRequest]
|
1130
1130
|
# @param [Hash] opts the optional parameters
|
1131
1131
|
# @return [BankTransferEventSyncResponse]
|
@@ -1135,7 +1135,7 @@ module Plaid
|
|
1135
1135
|
end
|
1136
1136
|
|
1137
1137
|
# Sync bank transfer events
|
1138
|
-
# `/bank_transfer/event/sync` allows you to request up to the next 25 bank transfer events that happened after a specific `event_id`. Use the `/bank_transfer/event/sync` endpoint to guarantee you have seen all bank transfer events.
|
1138
|
+
# `/bank_transfer/event/sync` allows you to request up to the next 25 bank transfer events that happened after a specific `event_id`. Use the `/bank_transfer/event/sync` endpoint to guarantee you have seen all bank transfer events.
|
1139
1139
|
# @param bank_transfer_event_sync_request [BankTransferEventSyncRequest]
|
1140
1140
|
# @param [Hash] opts the optional parameters
|
1141
1141
|
# @return [Array<(BankTransferEventSyncResponse, Integer, Hash)>] BankTransferEventSyncResponse data, response status code and response headers
|
@@ -1384,6 +1384,136 @@ module Plaid
|
|
1384
1384
|
return data, status_code, headers
|
1385
1385
|
end
|
1386
1386
|
|
1387
|
+
# Retrieve a sweep
|
1388
|
+
# The `/bank_transfer/sweep/get` endpoint fetches information about the sweep corresponding to the given `sweep_id`.
|
1389
|
+
# @param bank_transfer_sweep_get_request [BankTransferSweepGetRequest]
|
1390
|
+
# @param [Hash] opts the optional parameters
|
1391
|
+
# @return [BankTransferSweepGetResponse]
|
1392
|
+
def bank_transfer_sweep_get(bank_transfer_sweep_get_request, opts = {})
|
1393
|
+
data, _status_code, _headers = bank_transfer_sweep_get_with_http_info(bank_transfer_sweep_get_request, opts)
|
1394
|
+
data
|
1395
|
+
end
|
1396
|
+
|
1397
|
+
# Retrieve a sweep
|
1398
|
+
# The `/bank_transfer/sweep/get` endpoint fetches information about the sweep corresponding to the given `sweep_id`.
|
1399
|
+
# @param bank_transfer_sweep_get_request [BankTransferSweepGetRequest]
|
1400
|
+
# @param [Hash] opts the optional parameters
|
1401
|
+
# @return [Array<(BankTransferSweepGetResponse, Integer, Hash)>] BankTransferSweepGetResponse data, response status code and response headers
|
1402
|
+
def bank_transfer_sweep_get_with_http_info(bank_transfer_sweep_get_request, opts = {})
|
1403
|
+
if @api_client.config.debugging
|
1404
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.bank_transfer_sweep_get ...'
|
1405
|
+
end
|
1406
|
+
# verify the required parameter 'bank_transfer_sweep_get_request' is set
|
1407
|
+
if @api_client.config.client_side_validation && bank_transfer_sweep_get_request.nil?
|
1408
|
+
fail ArgumentError, "Missing the required parameter 'bank_transfer_sweep_get_request' when calling PlaidApi.bank_transfer_sweep_get"
|
1409
|
+
end
|
1410
|
+
# resource path
|
1411
|
+
local_var_path = '/bank_transfer/sweep/get'
|
1412
|
+
|
1413
|
+
# query parameters
|
1414
|
+
query_params = opts[:query_params] || {}
|
1415
|
+
|
1416
|
+
# header parameters
|
1417
|
+
header_params = opts[:header_params] || {}
|
1418
|
+
# HTTP header 'Accept' (if needed)
|
1419
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1420
|
+
# HTTP header 'Content-Type'
|
1421
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
1422
|
+
|
1423
|
+
# form parameters
|
1424
|
+
form_params = opts[:form_params] || {}
|
1425
|
+
|
1426
|
+
# http body (model)
|
1427
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(bank_transfer_sweep_get_request)
|
1428
|
+
|
1429
|
+
# return_type
|
1430
|
+
return_type = opts[:debug_return_type] || 'BankTransferSweepGetResponse'
|
1431
|
+
|
1432
|
+
# auth_names
|
1433
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
1434
|
+
|
1435
|
+
new_options = opts.merge(
|
1436
|
+
:operation => :"PlaidApi.bank_transfer_sweep_get",
|
1437
|
+
:header_params => header_params,
|
1438
|
+
:query_params => query_params,
|
1439
|
+
:form_params => form_params,
|
1440
|
+
:body => post_body,
|
1441
|
+
:auth_names => auth_names,
|
1442
|
+
:return_type => return_type
|
1443
|
+
)
|
1444
|
+
|
1445
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
1446
|
+
if @api_client.config.debugging
|
1447
|
+
@api_client.config.logger.debug "API called: PlaidApi#bank_transfer_sweep_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1448
|
+
end
|
1449
|
+
return data, status_code, headers
|
1450
|
+
end
|
1451
|
+
|
1452
|
+
# List sweeps
|
1453
|
+
# The `/bank_transfer/sweep/list` endpoint fetches information about the sweeps matching the given filters.
|
1454
|
+
# @param bank_transfer_sweep_list_request [BankTransferSweepListRequest]
|
1455
|
+
# @param [Hash] opts the optional parameters
|
1456
|
+
# @return [BankTransferSweepListResponse]
|
1457
|
+
def bank_transfer_sweep_list(bank_transfer_sweep_list_request, opts = {})
|
1458
|
+
data, _status_code, _headers = bank_transfer_sweep_list_with_http_info(bank_transfer_sweep_list_request, opts)
|
1459
|
+
data
|
1460
|
+
end
|
1461
|
+
|
1462
|
+
# List sweeps
|
1463
|
+
# The `/bank_transfer/sweep/list` endpoint fetches information about the sweeps matching the given filters.
|
1464
|
+
# @param bank_transfer_sweep_list_request [BankTransferSweepListRequest]
|
1465
|
+
# @param [Hash] opts the optional parameters
|
1466
|
+
# @return [Array<(BankTransferSweepListResponse, Integer, Hash)>] BankTransferSweepListResponse data, response status code and response headers
|
1467
|
+
def bank_transfer_sweep_list_with_http_info(bank_transfer_sweep_list_request, opts = {})
|
1468
|
+
if @api_client.config.debugging
|
1469
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.bank_transfer_sweep_list ...'
|
1470
|
+
end
|
1471
|
+
# verify the required parameter 'bank_transfer_sweep_list_request' is set
|
1472
|
+
if @api_client.config.client_side_validation && bank_transfer_sweep_list_request.nil?
|
1473
|
+
fail ArgumentError, "Missing the required parameter 'bank_transfer_sweep_list_request' when calling PlaidApi.bank_transfer_sweep_list"
|
1474
|
+
end
|
1475
|
+
# resource path
|
1476
|
+
local_var_path = '/bank_transfer/sweep/list'
|
1477
|
+
|
1478
|
+
# query parameters
|
1479
|
+
query_params = opts[:query_params] || {}
|
1480
|
+
|
1481
|
+
# header parameters
|
1482
|
+
header_params = opts[:header_params] || {}
|
1483
|
+
# HTTP header 'Accept' (if needed)
|
1484
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1485
|
+
# HTTP header 'Content-Type'
|
1486
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
1487
|
+
|
1488
|
+
# form parameters
|
1489
|
+
form_params = opts[:form_params] || {}
|
1490
|
+
|
1491
|
+
# http body (model)
|
1492
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(bank_transfer_sweep_list_request)
|
1493
|
+
|
1494
|
+
# return_type
|
1495
|
+
return_type = opts[:debug_return_type] || 'BankTransferSweepListResponse'
|
1496
|
+
|
1497
|
+
# auth_names
|
1498
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
1499
|
+
|
1500
|
+
new_options = opts.merge(
|
1501
|
+
:operation => :"PlaidApi.bank_transfer_sweep_list",
|
1502
|
+
:header_params => header_params,
|
1503
|
+
:query_params => query_params,
|
1504
|
+
:form_params => form_params,
|
1505
|
+
:body => post_body,
|
1506
|
+
:auth_names => auth_names,
|
1507
|
+
:return_type => return_type
|
1508
|
+
)
|
1509
|
+
|
1510
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
1511
|
+
if @api_client.config.debugging
|
1512
|
+
@api_client.config.logger.debug "API called: PlaidApi#bank_transfer_sweep_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1513
|
+
end
|
1514
|
+
return data, status_code, headers
|
1515
|
+
end
|
1516
|
+
|
1387
1517
|
# Get Categories
|
1388
1518
|
# Send a request to the `/categories/get` endpoint to get detailed information on categories returned by Plaid. This endpoint does not require authentication.
|
1389
1519
|
# @param body [Object]
|
@@ -2034,6 +2164,69 @@ module Plaid
|
|
2034
2164
|
return data, status_code, headers
|
2035
2165
|
end
|
2036
2166
|
|
2167
|
+
# (Deprecated) Retrieve information from a single paystub used for income verification
|
2168
|
+
# @param income_verification_paystub_get_request [IncomeVerificationPaystubGetRequest]
|
2169
|
+
# @param [Hash] opts the optional parameters
|
2170
|
+
# @return [IncomeVerificationPaystubGetResponse]
|
2171
|
+
def income_verification_paystub_get(income_verification_paystub_get_request, opts = {})
|
2172
|
+
data, _status_code, _headers = income_verification_paystub_get_with_http_info(income_verification_paystub_get_request, opts)
|
2173
|
+
data
|
2174
|
+
end
|
2175
|
+
|
2176
|
+
# (Deprecated) Retrieve information from a single paystub used for income verification
|
2177
|
+
# @param income_verification_paystub_get_request [IncomeVerificationPaystubGetRequest]
|
2178
|
+
# @param [Hash] opts the optional parameters
|
2179
|
+
# @return [Array<(IncomeVerificationPaystubGetResponse, Integer, Hash)>] IncomeVerificationPaystubGetResponse data, response status code and response headers
|
2180
|
+
def income_verification_paystub_get_with_http_info(income_verification_paystub_get_request, opts = {})
|
2181
|
+
if @api_client.config.debugging
|
2182
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.income_verification_paystub_get ...'
|
2183
|
+
end
|
2184
|
+
# verify the required parameter 'income_verification_paystub_get_request' is set
|
2185
|
+
if @api_client.config.client_side_validation && income_verification_paystub_get_request.nil?
|
2186
|
+
fail ArgumentError, "Missing the required parameter 'income_verification_paystub_get_request' when calling PlaidApi.income_verification_paystub_get"
|
2187
|
+
end
|
2188
|
+
# resource path
|
2189
|
+
local_var_path = '/income/verification/paystub/get'
|
2190
|
+
|
2191
|
+
# query parameters
|
2192
|
+
query_params = opts[:query_params] || {}
|
2193
|
+
|
2194
|
+
# header parameters
|
2195
|
+
header_params = opts[:header_params] || {}
|
2196
|
+
# HTTP header 'Accept' (if needed)
|
2197
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
2198
|
+
# HTTP header 'Content-Type'
|
2199
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
2200
|
+
|
2201
|
+
# form parameters
|
2202
|
+
form_params = opts[:form_params] || {}
|
2203
|
+
|
2204
|
+
# http body (model)
|
2205
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(income_verification_paystub_get_request)
|
2206
|
+
|
2207
|
+
# return_type
|
2208
|
+
return_type = opts[:debug_return_type] || 'IncomeVerificationPaystubGetResponse'
|
2209
|
+
|
2210
|
+
# auth_names
|
2211
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
2212
|
+
|
2213
|
+
new_options = opts.merge(
|
2214
|
+
:operation => :"PlaidApi.income_verification_paystub_get",
|
2215
|
+
:header_params => header_params,
|
2216
|
+
:query_params => query_params,
|
2217
|
+
:form_params => form_params,
|
2218
|
+
:body => post_body,
|
2219
|
+
:auth_names => auth_names,
|
2220
|
+
:return_type => return_type
|
2221
|
+
)
|
2222
|
+
|
2223
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
2224
|
+
if @api_client.config.debugging
|
2225
|
+
@api_client.config.logger.debug "API called: PlaidApi#income_verification_paystub_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2226
|
+
end
|
2227
|
+
return data, status_code, headers
|
2228
|
+
end
|
2229
|
+
|
2037
2230
|
# Retrieve information from the paystubs used for income verification
|
2038
2231
|
# `/income/verification/paystubs/get` returns the information collected from the paystubs that were used to verify an end user's income. It can be called once the status of the verification has been set to `VERIFICATION_STATUS_PROCESSING_COMPLETE`, as reported by the `INCOME: verification_status` webhook. Attempting to call the endpoint before verification has been completed will result in an error.
|
2039
2232
|
# @param income_verification_paystubs_get_request [IncomeVerificationPaystubsGetRequest]
|
@@ -2099,6 +2292,71 @@ module Plaid
|
|
2099
2292
|
return data, status_code, headers
|
2100
2293
|
end
|
2101
2294
|
|
2295
|
+
# Check a user's eligibility for the income verification product
|
2296
|
+
# `/income/verification/precheck` returns whether a given user is supportable by the income product
|
2297
|
+
# @param income_verification_precheck_request [IncomeVerificationPrecheckRequest]
|
2298
|
+
# @param [Hash] opts the optional parameters
|
2299
|
+
# @return [IncomeVerificationPrecheckResponse]
|
2300
|
+
def income_verification_precheck(income_verification_precheck_request, opts = {})
|
2301
|
+
data, _status_code, _headers = income_verification_precheck_with_http_info(income_verification_precheck_request, opts)
|
2302
|
+
data
|
2303
|
+
end
|
2304
|
+
|
2305
|
+
# Check a user's eligibility for the income verification product
|
2306
|
+
# `/income/verification/precheck` returns whether a given user is supportable by the income product
|
2307
|
+
# @param income_verification_precheck_request [IncomeVerificationPrecheckRequest]
|
2308
|
+
# @param [Hash] opts the optional parameters
|
2309
|
+
# @return [Array<(IncomeVerificationPrecheckResponse, Integer, Hash)>] IncomeVerificationPrecheckResponse data, response status code and response headers
|
2310
|
+
def income_verification_precheck_with_http_info(income_verification_precheck_request, opts = {})
|
2311
|
+
if @api_client.config.debugging
|
2312
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.income_verification_precheck ...'
|
2313
|
+
end
|
2314
|
+
# verify the required parameter 'income_verification_precheck_request' is set
|
2315
|
+
if @api_client.config.client_side_validation && income_verification_precheck_request.nil?
|
2316
|
+
fail ArgumentError, "Missing the required parameter 'income_verification_precheck_request' when calling PlaidApi.income_verification_precheck"
|
2317
|
+
end
|
2318
|
+
# resource path
|
2319
|
+
local_var_path = '/income/verification/precheck'
|
2320
|
+
|
2321
|
+
# query parameters
|
2322
|
+
query_params = opts[:query_params] || {}
|
2323
|
+
|
2324
|
+
# header parameters
|
2325
|
+
header_params = opts[:header_params] || {}
|
2326
|
+
# HTTP header 'Accept' (if needed)
|
2327
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
2328
|
+
# HTTP header 'Content-Type'
|
2329
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
2330
|
+
|
2331
|
+
# form parameters
|
2332
|
+
form_params = opts[:form_params] || {}
|
2333
|
+
|
2334
|
+
# http body (model)
|
2335
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(income_verification_precheck_request)
|
2336
|
+
|
2337
|
+
# return_type
|
2338
|
+
return_type = opts[:debug_return_type] || 'IncomeVerificationPrecheckResponse'
|
2339
|
+
|
2340
|
+
# auth_names
|
2341
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
2342
|
+
|
2343
|
+
new_options = opts.merge(
|
2344
|
+
:operation => :"PlaidApi.income_verification_precheck",
|
2345
|
+
:header_params => header_params,
|
2346
|
+
:query_params => query_params,
|
2347
|
+
:form_params => form_params,
|
2348
|
+
:body => post_body,
|
2349
|
+
:auth_names => auth_names,
|
2350
|
+
:return_type => return_type
|
2351
|
+
)
|
2352
|
+
|
2353
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
2354
|
+
if @api_client.config.debugging
|
2355
|
+
@api_client.config.logger.debug "API called: PlaidApi#income_verification_precheck\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2356
|
+
end
|
2357
|
+
return data, status_code, headers
|
2358
|
+
end
|
2359
|
+
|
2102
2360
|
# Refresh an income verification
|
2103
2361
|
# `/income/verification/refresh` refreshes a given income verification.
|
2104
2362
|
# @param income_verification_refresh_request [IncomeVerificationRefreshRequest]
|
@@ -2229,8 +2487,73 @@ module Plaid
|
|
2229
2487
|
return data, status_code, headers
|
2230
2488
|
end
|
2231
2489
|
|
2490
|
+
# Retrieve information from the tax documents used for income verification
|
2491
|
+
# `/income/verification/taxforms/get` returns the information collected from taxforms that were used to verify an end user's. It can be called once the status of the verification has been set to `VERIFICATION_STATUS_PROCESSING_COMPLETE`, as reported by the `INCOME: verification_status` webhook. Attempting to call the endpoint before verification has been completed will result in an error.
|
2492
|
+
# @param request_body [Hash<String, Object>]
|
2493
|
+
# @param [Hash] opts the optional parameters
|
2494
|
+
# @return [IncomeVerificationTaxformsGetResponse]
|
2495
|
+
def income_verification_taxforms_get(request_body, opts = {})
|
2496
|
+
data, _status_code, _headers = income_verification_taxforms_get_with_http_info(request_body, opts)
|
2497
|
+
data
|
2498
|
+
end
|
2499
|
+
|
2500
|
+
# Retrieve information from the tax documents used for income verification
|
2501
|
+
# `/income/verification/taxforms/get` returns the information collected from taxforms that were used to verify an end user's. It can be called once the status of the verification has been set to `VERIFICATION_STATUS_PROCESSING_COMPLETE`, as reported by the `INCOME: verification_status` webhook. Attempting to call the endpoint before verification has been completed will result in an error.
|
2502
|
+
# @param request_body [Hash<String, Object>]
|
2503
|
+
# @param [Hash] opts the optional parameters
|
2504
|
+
# @return [Array<(IncomeVerificationTaxformsGetResponse, Integer, Hash)>] IncomeVerificationTaxformsGetResponse data, response status code and response headers
|
2505
|
+
def income_verification_taxforms_get_with_http_info(request_body, opts = {})
|
2506
|
+
if @api_client.config.debugging
|
2507
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.income_verification_taxforms_get ...'
|
2508
|
+
end
|
2509
|
+
# verify the required parameter 'request_body' is set
|
2510
|
+
if @api_client.config.client_side_validation && request_body.nil?
|
2511
|
+
fail ArgumentError, "Missing the required parameter 'request_body' when calling PlaidApi.income_verification_taxforms_get"
|
2512
|
+
end
|
2513
|
+
# resource path
|
2514
|
+
local_var_path = '/income/verification/taxforms/get'
|
2515
|
+
|
2516
|
+
# query parameters
|
2517
|
+
query_params = opts[:query_params] || {}
|
2518
|
+
|
2519
|
+
# header parameters
|
2520
|
+
header_params = opts[:header_params] || {}
|
2521
|
+
# HTTP header 'Accept' (if needed)
|
2522
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
2523
|
+
# HTTP header 'Content-Type'
|
2524
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
2525
|
+
|
2526
|
+
# form parameters
|
2527
|
+
form_params = opts[:form_params] || {}
|
2528
|
+
|
2529
|
+
# http body (model)
|
2530
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(request_body)
|
2531
|
+
|
2532
|
+
# return_type
|
2533
|
+
return_type = opts[:debug_return_type] || 'IncomeVerificationTaxformsGetResponse'
|
2534
|
+
|
2535
|
+
# auth_names
|
2536
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
2537
|
+
|
2538
|
+
new_options = opts.merge(
|
2539
|
+
:operation => :"PlaidApi.income_verification_taxforms_get",
|
2540
|
+
:header_params => header_params,
|
2541
|
+
:query_params => query_params,
|
2542
|
+
:form_params => form_params,
|
2543
|
+
:body => post_body,
|
2544
|
+
:auth_names => auth_names,
|
2545
|
+
:return_type => return_type
|
2546
|
+
)
|
2547
|
+
|
2548
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
2549
|
+
if @api_client.config.debugging
|
2550
|
+
@api_client.config.logger.debug "API called: PlaidApi#income_verification_taxforms_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2551
|
+
end
|
2552
|
+
return data, status_code, headers
|
2553
|
+
end
|
2554
|
+
|
2232
2555
|
# Get details of all supported institutions
|
2233
|
-
# Returns a JSON response containing details on all financial institutions currently supported by Plaid. Because Plaid supports thousands of institutions, results are paginated. If there is no overlap between an institution’s enabled products and a client’s enabled products, then the institution will be filtered out from the response. As a result, the number of institutions returned may not match the count specified in the call.
|
2556
|
+
# Returns a JSON response containing details on all financial institutions currently supported by Plaid. Because Plaid supports thousands of institutions, results are paginated. If there is no overlap between an institution’s enabled products and a client’s enabled products, then the institution will be filtered out from the response. As a result, the number of institutions returned may not match the count specified in the call.
|
2234
2557
|
# @param institutions_get_request [InstitutionsGetRequest]
|
2235
2558
|
# @param [Hash] opts the optional parameters
|
2236
2559
|
# @return [InstitutionsGetResponse]
|
@@ -2240,7 +2563,7 @@ module Plaid
|
|
2240
2563
|
end
|
2241
2564
|
|
2242
2565
|
# Get details of all supported institutions
|
2243
|
-
# Returns a JSON response containing details on all financial institutions currently supported by Plaid. Because Plaid supports thousands of institutions, results are paginated. If there is no overlap between an institution’s enabled products and a client’s enabled products, then the institution will be filtered out from the response. As a result, the number of institutions returned may not match the count specified in the call.
|
2566
|
+
# Returns a JSON response containing details on all financial institutions currently supported by Plaid. Because Plaid supports thousands of institutions, results are paginated. If there is no overlap between an institution’s enabled products and a client’s enabled products, then the institution will be filtered out from the response. As a result, the number of institutions returned may not match the count specified in the call.
|
2244
2567
|
# @param institutions_get_request [InstitutionsGetRequest]
|
2245
2568
|
# @param [Hash] opts the optional parameters
|
2246
2569
|
# @return [Array<(InstitutionsGetResponse, Integer, Hash)>] InstitutionsGetResponse data, response status code and response headers
|
@@ -3529,31 +3852,31 @@ module Plaid
|
|
3529
3852
|
return data, status_code, headers
|
3530
3853
|
end
|
3531
3854
|
|
3532
|
-
#
|
3533
|
-
#
|
3534
|
-
# @param
|
3855
|
+
# Reverse an existing payment
|
3856
|
+
# Reverse a previously initiated payment. A payment can only be reversed once and will be refunded to the original sender's account.
|
3857
|
+
# @param payment_initiation_payment_reverse_request [PaymentInitiationPaymentReverseRequest]
|
3535
3858
|
# @param [Hash] opts the optional parameters
|
3536
|
-
# @return [
|
3537
|
-
def
|
3538
|
-
data, _status_code, _headers =
|
3859
|
+
# @return [PaymentInitiationPaymentReverseResponse]
|
3860
|
+
def payment_initiation_payment_reverse(payment_initiation_payment_reverse_request, opts = {})
|
3861
|
+
data, _status_code, _headers = payment_initiation_payment_reverse_with_http_info(payment_initiation_payment_reverse_request, opts)
|
3539
3862
|
data
|
3540
3863
|
end
|
3541
3864
|
|
3542
|
-
#
|
3543
|
-
#
|
3544
|
-
# @param
|
3865
|
+
# Reverse an existing payment
|
3866
|
+
# Reverse a previously initiated payment. A payment can only be reversed once and will be refunded to the original sender's account.
|
3867
|
+
# @param payment_initiation_payment_reverse_request [PaymentInitiationPaymentReverseRequest]
|
3545
3868
|
# @param [Hash] opts the optional parameters
|
3546
|
-
# @return [Array<(
|
3547
|
-
def
|
3869
|
+
# @return [Array<(PaymentInitiationPaymentReverseResponse, Integer, Hash)>] PaymentInitiationPaymentReverseResponse data, response status code and response headers
|
3870
|
+
def payment_initiation_payment_reverse_with_http_info(payment_initiation_payment_reverse_request, opts = {})
|
3548
3871
|
if @api_client.config.debugging
|
3549
|
-
@api_client.config.logger.debug 'Calling API: PlaidApi.
|
3872
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.payment_initiation_payment_reverse ...'
|
3550
3873
|
end
|
3551
|
-
# verify the required parameter '
|
3552
|
-
if @api_client.config.client_side_validation &&
|
3553
|
-
fail ArgumentError, "Missing the required parameter '
|
3874
|
+
# verify the required parameter 'payment_initiation_payment_reverse_request' is set
|
3875
|
+
if @api_client.config.client_side_validation && payment_initiation_payment_reverse_request.nil?
|
3876
|
+
fail ArgumentError, "Missing the required parameter 'payment_initiation_payment_reverse_request' when calling PlaidApi.payment_initiation_payment_reverse"
|
3554
3877
|
end
|
3555
3878
|
# resource path
|
3556
|
-
local_var_path = '/payment_initiation/
|
3879
|
+
local_var_path = '/payment_initiation/payment/reverse'
|
3557
3880
|
|
3558
3881
|
# query parameters
|
3559
3882
|
query_params = opts[:query_params] || {}
|
@@ -3569,16 +3892,16 @@ module Plaid
|
|
3569
3892
|
form_params = opts[:form_params] || {}
|
3570
3893
|
|
3571
3894
|
# http body (model)
|
3572
|
-
post_body = opts[:debug_body] || @api_client.object_to_http_body(
|
3895
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(payment_initiation_payment_reverse_request)
|
3573
3896
|
|
3574
3897
|
# return_type
|
3575
|
-
return_type = opts[:debug_return_type] || '
|
3898
|
+
return_type = opts[:debug_return_type] || 'PaymentInitiationPaymentReverseResponse'
|
3576
3899
|
|
3577
3900
|
# auth_names
|
3578
3901
|
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
3579
3902
|
|
3580
3903
|
new_options = opts.merge(
|
3581
|
-
:operation => :"PlaidApi.
|
3904
|
+
:operation => :"PlaidApi.payment_initiation_payment_reverse",
|
3582
3905
|
:header_params => header_params,
|
3583
3906
|
:query_params => query_params,
|
3584
3907
|
:form_params => form_params,
|
@@ -3589,14 +3912,79 @@ module Plaid
|
|
3589
3912
|
|
3590
3913
|
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
3591
3914
|
if @api_client.config.debugging
|
3592
|
-
@api_client.config.logger.debug "API called: PlaidApi#
|
3915
|
+
@api_client.config.logger.debug "API called: PlaidApi#payment_initiation_payment_reverse\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
3593
3916
|
end
|
3594
3917
|
return data, status_code, headers
|
3595
3918
|
end
|
3596
3919
|
|
3597
|
-
#
|
3598
|
-
#
|
3599
|
-
# @param
|
3920
|
+
# Create payment recipient
|
3921
|
+
# Create a payment recipient for payment initiation. The recipient must be in Europe, within a country that is a member of the Single Euro Payment Area (SEPA). For a standing order (recurring) payment, the recipient must be in the UK. The endpoint is idempotent: if a developer has already made a request with the same payment details, Plaid will return the same `recipient_id`.
|
3922
|
+
# @param payment_initiation_recipient_create_request [PaymentInitiationRecipientCreateRequest]
|
3923
|
+
# @param [Hash] opts the optional parameters
|
3924
|
+
# @return [PaymentInitiationRecipientCreateResponse]
|
3925
|
+
def payment_initiation_recipient_create(payment_initiation_recipient_create_request, opts = {})
|
3926
|
+
data, _status_code, _headers = payment_initiation_recipient_create_with_http_info(payment_initiation_recipient_create_request, opts)
|
3927
|
+
data
|
3928
|
+
end
|
3929
|
+
|
3930
|
+
# Create payment recipient
|
3931
|
+
# Create a payment recipient for payment initiation. The recipient must be in Europe, within a country that is a member of the Single Euro Payment Area (SEPA). For a standing order (recurring) payment, the recipient must be in the UK. The endpoint is idempotent: if a developer has already made a request with the same payment details, Plaid will return the same `recipient_id`.
|
3932
|
+
# @param payment_initiation_recipient_create_request [PaymentInitiationRecipientCreateRequest]
|
3933
|
+
# @param [Hash] opts the optional parameters
|
3934
|
+
# @return [Array<(PaymentInitiationRecipientCreateResponse, Integer, Hash)>] PaymentInitiationRecipientCreateResponse data, response status code and response headers
|
3935
|
+
def payment_initiation_recipient_create_with_http_info(payment_initiation_recipient_create_request, opts = {})
|
3936
|
+
if @api_client.config.debugging
|
3937
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.payment_initiation_recipient_create ...'
|
3938
|
+
end
|
3939
|
+
# verify the required parameter 'payment_initiation_recipient_create_request' is set
|
3940
|
+
if @api_client.config.client_side_validation && payment_initiation_recipient_create_request.nil?
|
3941
|
+
fail ArgumentError, "Missing the required parameter 'payment_initiation_recipient_create_request' when calling PlaidApi.payment_initiation_recipient_create"
|
3942
|
+
end
|
3943
|
+
# resource path
|
3944
|
+
local_var_path = '/payment_initiation/recipient/create'
|
3945
|
+
|
3946
|
+
# query parameters
|
3947
|
+
query_params = opts[:query_params] || {}
|
3948
|
+
|
3949
|
+
# header parameters
|
3950
|
+
header_params = opts[:header_params] || {}
|
3951
|
+
# HTTP header 'Accept' (if needed)
|
3952
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
3953
|
+
# HTTP header 'Content-Type'
|
3954
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
3955
|
+
|
3956
|
+
# form parameters
|
3957
|
+
form_params = opts[:form_params] || {}
|
3958
|
+
|
3959
|
+
# http body (model)
|
3960
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(payment_initiation_recipient_create_request)
|
3961
|
+
|
3962
|
+
# return_type
|
3963
|
+
return_type = opts[:debug_return_type] || 'PaymentInitiationRecipientCreateResponse'
|
3964
|
+
|
3965
|
+
# auth_names
|
3966
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
3967
|
+
|
3968
|
+
new_options = opts.merge(
|
3969
|
+
:operation => :"PlaidApi.payment_initiation_recipient_create",
|
3970
|
+
:header_params => header_params,
|
3971
|
+
:query_params => query_params,
|
3972
|
+
:form_params => form_params,
|
3973
|
+
:body => post_body,
|
3974
|
+
:auth_names => auth_names,
|
3975
|
+
:return_type => return_type
|
3976
|
+
)
|
3977
|
+
|
3978
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
3979
|
+
if @api_client.config.debugging
|
3980
|
+
@api_client.config.logger.debug "API called: PlaidApi#payment_initiation_recipient_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
3981
|
+
end
|
3982
|
+
return data, status_code, headers
|
3983
|
+
end
|
3984
|
+
|
3985
|
+
# Get payment recipient
|
3986
|
+
# Get details about a payment recipient you have previously created.
|
3987
|
+
# @param payment_initiation_recipient_get_request [PaymentInitiationRecipientGetRequest]
|
3600
3988
|
# @param [Hash] opts the optional parameters
|
3601
3989
|
# @return [PaymentInitiationRecipientGetResponse]
|
3602
3990
|
def payment_initiation_recipient_get(payment_initiation_recipient_get_request, opts = {})
|
@@ -4762,6 +5150,71 @@ module Plaid
|
|
4762
5150
|
return data, status_code, headers
|
4763
5151
|
end
|
4764
5152
|
|
5153
|
+
# Simulate a transfer event in Sandbox
|
5154
|
+
# Use the `/sandbox/transfer/simulate` endpoint to simulate a transfer event in the Sandbox environment. Note that while an event will be simulated and will appear when using endpoints such as `/transfer/event/sync` or `/transfer/event/list`, no transactions will actually take place and funds will not move between accounts, even within the Sandbox.
|
5155
|
+
# @param sandbox_transfer_simulate_request [SandboxTransferSimulateRequest]
|
5156
|
+
# @param [Hash] opts the optional parameters
|
5157
|
+
# @return [SandboxTransferSimulateResponse]
|
5158
|
+
def sandbox_transfer_simulate(sandbox_transfer_simulate_request, opts = {})
|
5159
|
+
data, _status_code, _headers = sandbox_transfer_simulate_with_http_info(sandbox_transfer_simulate_request, opts)
|
5160
|
+
data
|
5161
|
+
end
|
5162
|
+
|
5163
|
+
# Simulate a transfer event in Sandbox
|
5164
|
+
# Use the `/sandbox/transfer/simulate` endpoint to simulate a transfer event in the Sandbox environment. Note that while an event will be simulated and will appear when using endpoints such as `/transfer/event/sync` or `/transfer/event/list`, no transactions will actually take place and funds will not move between accounts, even within the Sandbox.
|
5165
|
+
# @param sandbox_transfer_simulate_request [SandboxTransferSimulateRequest]
|
5166
|
+
# @param [Hash] opts the optional parameters
|
5167
|
+
# @return [Array<(SandboxTransferSimulateResponse, Integer, Hash)>] SandboxTransferSimulateResponse data, response status code and response headers
|
5168
|
+
def sandbox_transfer_simulate_with_http_info(sandbox_transfer_simulate_request, opts = {})
|
5169
|
+
if @api_client.config.debugging
|
5170
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.sandbox_transfer_simulate ...'
|
5171
|
+
end
|
5172
|
+
# verify the required parameter 'sandbox_transfer_simulate_request' is set
|
5173
|
+
if @api_client.config.client_side_validation && sandbox_transfer_simulate_request.nil?
|
5174
|
+
fail ArgumentError, "Missing the required parameter 'sandbox_transfer_simulate_request' when calling PlaidApi.sandbox_transfer_simulate"
|
5175
|
+
end
|
5176
|
+
# resource path
|
5177
|
+
local_var_path = '/sandbox/transfer/simulate'
|
5178
|
+
|
5179
|
+
# query parameters
|
5180
|
+
query_params = opts[:query_params] || {}
|
5181
|
+
|
5182
|
+
# header parameters
|
5183
|
+
header_params = opts[:header_params] || {}
|
5184
|
+
# HTTP header 'Accept' (if needed)
|
5185
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
5186
|
+
# HTTP header 'Content-Type'
|
5187
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
5188
|
+
|
5189
|
+
# form parameters
|
5190
|
+
form_params = opts[:form_params] || {}
|
5191
|
+
|
5192
|
+
# http body (model)
|
5193
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(sandbox_transfer_simulate_request)
|
5194
|
+
|
5195
|
+
# return_type
|
5196
|
+
return_type = opts[:debug_return_type] || 'SandboxTransferSimulateResponse'
|
5197
|
+
|
5198
|
+
# auth_names
|
5199
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
5200
|
+
|
5201
|
+
new_options = opts.merge(
|
5202
|
+
:operation => :"PlaidApi.sandbox_transfer_simulate",
|
5203
|
+
:header_params => header_params,
|
5204
|
+
:query_params => query_params,
|
5205
|
+
:form_params => form_params,
|
5206
|
+
:body => post_body,
|
5207
|
+
:auth_names => auth_names,
|
5208
|
+
:return_type => return_type
|
5209
|
+
)
|
5210
|
+
|
5211
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
5212
|
+
if @api_client.config.debugging
|
5213
|
+
@api_client.config.logger.debug "API called: PlaidApi#sandbox_transfer_simulate\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
5214
|
+
end
|
5215
|
+
return data, status_code, headers
|
5216
|
+
end
|
5217
|
+
|
4765
5218
|
# Report whether you initiated an ACH transaction
|
4766
5219
|
# After calling `/signal/evaluate`, call `/signal/decision/report` to report whether the transaction was initiated. This endpoint will return an `INVALID_REQUEST` error if called a second time with a different value for `initiated`.
|
4767
5220
|
# @param signal_decision_report_request [SignalDecisionReportRequest]
|
@@ -5022,6 +5475,71 @@ module Plaid
|
|
5022
5475
|
return data, status_code, headers
|
5023
5476
|
end
|
5024
5477
|
|
5478
|
+
# Get streams of recurring transactions
|
5479
|
+
# The `/transactions/recurring/get` endpoint identifies and returns groups of transactions that occur on a regular basis for the inputted Item and accounts. The product is currently in beta. To request access, contact transactions-feedback@plaid.com.
|
5480
|
+
# @param transactions_recurring_get_request [TransactionsRecurringGetRequest]
|
5481
|
+
# @param [Hash] opts the optional parameters
|
5482
|
+
# @return [TransactionsRecurringGetResponse]
|
5483
|
+
def transactions_recurring_get(transactions_recurring_get_request, opts = {})
|
5484
|
+
data, _status_code, _headers = transactions_recurring_get_with_http_info(transactions_recurring_get_request, opts)
|
5485
|
+
data
|
5486
|
+
end
|
5487
|
+
|
5488
|
+
# Get streams of recurring transactions
|
5489
|
+
# The `/transactions/recurring/get` endpoint identifies and returns groups of transactions that occur on a regular basis for the inputted Item and accounts. The product is currently in beta. To request access, contact transactions-feedback@plaid.com.
|
5490
|
+
# @param transactions_recurring_get_request [TransactionsRecurringGetRequest]
|
5491
|
+
# @param [Hash] opts the optional parameters
|
5492
|
+
# @return [Array<(TransactionsRecurringGetResponse, Integer, Hash)>] TransactionsRecurringGetResponse data, response status code and response headers
|
5493
|
+
def transactions_recurring_get_with_http_info(transactions_recurring_get_request, opts = {})
|
5494
|
+
if @api_client.config.debugging
|
5495
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.transactions_recurring_get ...'
|
5496
|
+
end
|
5497
|
+
# verify the required parameter 'transactions_recurring_get_request' is set
|
5498
|
+
if @api_client.config.client_side_validation && transactions_recurring_get_request.nil?
|
5499
|
+
fail ArgumentError, "Missing the required parameter 'transactions_recurring_get_request' when calling PlaidApi.transactions_recurring_get"
|
5500
|
+
end
|
5501
|
+
# resource path
|
5502
|
+
local_var_path = '/transactions/recurring/get'
|
5503
|
+
|
5504
|
+
# query parameters
|
5505
|
+
query_params = opts[:query_params] || {}
|
5506
|
+
|
5507
|
+
# header parameters
|
5508
|
+
header_params = opts[:header_params] || {}
|
5509
|
+
# HTTP header 'Accept' (if needed)
|
5510
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
5511
|
+
# HTTP header 'Content-Type'
|
5512
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
5513
|
+
|
5514
|
+
# form parameters
|
5515
|
+
form_params = opts[:form_params] || {}
|
5516
|
+
|
5517
|
+
# http body (model)
|
5518
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(transactions_recurring_get_request)
|
5519
|
+
|
5520
|
+
# return_type
|
5521
|
+
return_type = opts[:debug_return_type] || 'TransactionsRecurringGetResponse'
|
5522
|
+
|
5523
|
+
# auth_names
|
5524
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
5525
|
+
|
5526
|
+
new_options = opts.merge(
|
5527
|
+
:operation => :"PlaidApi.transactions_recurring_get",
|
5528
|
+
:header_params => header_params,
|
5529
|
+
:query_params => query_params,
|
5530
|
+
:form_params => form_params,
|
5531
|
+
:body => post_body,
|
5532
|
+
:auth_names => auth_names,
|
5533
|
+
:return_type => return_type
|
5534
|
+
)
|
5535
|
+
|
5536
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
5537
|
+
if @api_client.config.debugging
|
5538
|
+
@api_client.config.logger.debug "API called: PlaidApi#transactions_recurring_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
5539
|
+
end
|
5540
|
+
return data, status_code, headers
|
5541
|
+
end
|
5542
|
+
|
5025
5543
|
# Refresh transaction data
|
5026
5544
|
# `/transactions/refresh` is an optional endpoint for users of the Transactions product. It initiates an on-demand extraction to fetch the newest transactions for an Item. This on-demand extraction takes place in addition to the periodic extractions that automatically occur multiple times a day for any Transactions-enabled Item. If changes to transactions are discovered after calling `/transactions/refresh`, Plaid will fire a webhook: [`TRANSACTIONS_REMOVED`](https://plaid.com/docs/api/webhooks#deleted-transactions-detected) will be fired if any removed transactions are detected, and [`DEFAULT_UPDATE`](https://plaid.com/docs/api/webhooks#transactions-default_update) will be fired if any new transactions are detected. New transactions can be fetched by calling `/transactions/get`. Access to `/transactions/refresh` in Production is specific to certain pricing plans. If you cannot access `/transactions/refresh` in Production, [contact Sales](https://www.plaid.com/contact) for assistance.
|
5027
5545
|
# @param transactions_refresh_request [TransactionsRefreshRequest]
|
@@ -5087,6 +5605,461 @@ module Plaid
|
|
5087
5605
|
return data, status_code, headers
|
5088
5606
|
end
|
5089
5607
|
|
5608
|
+
# Create a transfer authorization
|
5609
|
+
# Use the `/transfer/authorization/create` endpoint to determine transfer failure risk. In Plaid's sandbox environment the decisions will be returned as follows: - To approve a transfer, make an authorization request with an `amount` less than the available balance in the account. - To decline a transfer with the rationale code `NSF`, the available balance on the account must be less than the authorization `amount`. See [Create Sandbox test data](https://plaid.com/docs/sandbox/user-custom/) for details on how to customize data in Sandbox. - To decline a transfer with the rationale code `RISK`, the available balance on the account must be exactly $0. See [Create Sandbox test data](https://plaid.com/docs/sandbox/user-custom/) for details on how to customize data in Sandbox. - To permit a transfer with the rationale code `MANUALLY_VERIFIED_ITEM`, create an Item in Link through the [Same Day Micro-deposits flow](https://plaid.com/docs/auth/coverage/testing/#testing-same-day-micro-deposits). - To permit a transfer with the rationale code `LOGIN_REQUIRED`, [reset the login for an Item](https://plaid.com/docs/sandbox/#item_login_required). All username/password combinations other than the ones listed above will result in a decision of permitted and rationale code `ERROR`.
|
5610
|
+
# @param transfer_authorization_create_request [TransferAuthorizationCreateRequest]
|
5611
|
+
# @param [Hash] opts the optional parameters
|
5612
|
+
# @return [TransferAuthorizationCreateResponse]
|
5613
|
+
def transfer_authorization_create(transfer_authorization_create_request, opts = {})
|
5614
|
+
data, _status_code, _headers = transfer_authorization_create_with_http_info(transfer_authorization_create_request, opts)
|
5615
|
+
data
|
5616
|
+
end
|
5617
|
+
|
5618
|
+
# Create a transfer authorization
|
5619
|
+
# Use the `/transfer/authorization/create` endpoint to determine transfer failure risk. In Plaid's sandbox environment the decisions will be returned as follows: - To approve a transfer, make an authorization request with an `amount` less than the available balance in the account. - To decline a transfer with the rationale code `NSF`, the available balance on the account must be less than the authorization `amount`. See [Create Sandbox test data](https://plaid.com/docs/sandbox/user-custom/) for details on how to customize data in Sandbox. - To decline a transfer with the rationale code `RISK`, the available balance on the account must be exactly $0. See [Create Sandbox test data](https://plaid.com/docs/sandbox/user-custom/) for details on how to customize data in Sandbox. - To permit a transfer with the rationale code `MANUALLY_VERIFIED_ITEM`, create an Item in Link through the [Same Day Micro-deposits flow](https://plaid.com/docs/auth/coverage/testing/#testing-same-day-micro-deposits). - To permit a transfer with the rationale code `LOGIN_REQUIRED`, [reset the login for an Item](https://plaid.com/docs/sandbox/#item_login_required). All username/password combinations other than the ones listed above will result in a decision of permitted and rationale code `ERROR`.
|
5620
|
+
# @param transfer_authorization_create_request [TransferAuthorizationCreateRequest]
|
5621
|
+
# @param [Hash] opts the optional parameters
|
5622
|
+
# @return [Array<(TransferAuthorizationCreateResponse, Integer, Hash)>] TransferAuthorizationCreateResponse data, response status code and response headers
|
5623
|
+
def transfer_authorization_create_with_http_info(transfer_authorization_create_request, opts = {})
|
5624
|
+
if @api_client.config.debugging
|
5625
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.transfer_authorization_create ...'
|
5626
|
+
end
|
5627
|
+
# verify the required parameter 'transfer_authorization_create_request' is set
|
5628
|
+
if @api_client.config.client_side_validation && transfer_authorization_create_request.nil?
|
5629
|
+
fail ArgumentError, "Missing the required parameter 'transfer_authorization_create_request' when calling PlaidApi.transfer_authorization_create"
|
5630
|
+
end
|
5631
|
+
# resource path
|
5632
|
+
local_var_path = '/transfer/authorization/create'
|
5633
|
+
|
5634
|
+
# query parameters
|
5635
|
+
query_params = opts[:query_params] || {}
|
5636
|
+
|
5637
|
+
# header parameters
|
5638
|
+
header_params = opts[:header_params] || {}
|
5639
|
+
# HTTP header 'Accept' (if needed)
|
5640
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
5641
|
+
# HTTP header 'Content-Type'
|
5642
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
5643
|
+
|
5644
|
+
# form parameters
|
5645
|
+
form_params = opts[:form_params] || {}
|
5646
|
+
|
5647
|
+
# http body (model)
|
5648
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(transfer_authorization_create_request)
|
5649
|
+
|
5650
|
+
# return_type
|
5651
|
+
return_type = opts[:debug_return_type] || 'TransferAuthorizationCreateResponse'
|
5652
|
+
|
5653
|
+
# auth_names
|
5654
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
5655
|
+
|
5656
|
+
new_options = opts.merge(
|
5657
|
+
:operation => :"PlaidApi.transfer_authorization_create",
|
5658
|
+
:header_params => header_params,
|
5659
|
+
:query_params => query_params,
|
5660
|
+
:form_params => form_params,
|
5661
|
+
:body => post_body,
|
5662
|
+
:auth_names => auth_names,
|
5663
|
+
:return_type => return_type
|
5664
|
+
)
|
5665
|
+
|
5666
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
5667
|
+
if @api_client.config.debugging
|
5668
|
+
@api_client.config.logger.debug "API called: PlaidApi#transfer_authorization_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
5669
|
+
end
|
5670
|
+
return data, status_code, headers
|
5671
|
+
end
|
5672
|
+
|
5673
|
+
# Cancel a transfer
|
5674
|
+
# Use the `/transfer/cancel` endpoint to cancel a transfer. A transfer is eligible for cancelation if the `cancellable` property returned by `/transfer/get` is `true`.
|
5675
|
+
# @param transfer_cancel_request [TransferCancelRequest]
|
5676
|
+
# @param [Hash] opts the optional parameters
|
5677
|
+
# @return [TransferCancelResponse]
|
5678
|
+
def transfer_cancel(transfer_cancel_request, opts = {})
|
5679
|
+
data, _status_code, _headers = transfer_cancel_with_http_info(transfer_cancel_request, opts)
|
5680
|
+
data
|
5681
|
+
end
|
5682
|
+
|
5683
|
+
# Cancel a transfer
|
5684
|
+
# Use the `/transfer/cancel` endpoint to cancel a transfer. A transfer is eligible for cancelation if the `cancellable` property returned by `/transfer/get` is `true`.
|
5685
|
+
# @param transfer_cancel_request [TransferCancelRequest]
|
5686
|
+
# @param [Hash] opts the optional parameters
|
5687
|
+
# @return [Array<(TransferCancelResponse, Integer, Hash)>] TransferCancelResponse data, response status code and response headers
|
5688
|
+
def transfer_cancel_with_http_info(transfer_cancel_request, opts = {})
|
5689
|
+
if @api_client.config.debugging
|
5690
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.transfer_cancel ...'
|
5691
|
+
end
|
5692
|
+
# verify the required parameter 'transfer_cancel_request' is set
|
5693
|
+
if @api_client.config.client_side_validation && transfer_cancel_request.nil?
|
5694
|
+
fail ArgumentError, "Missing the required parameter 'transfer_cancel_request' when calling PlaidApi.transfer_cancel"
|
5695
|
+
end
|
5696
|
+
# resource path
|
5697
|
+
local_var_path = '/transfer/cancel'
|
5698
|
+
|
5699
|
+
# query parameters
|
5700
|
+
query_params = opts[:query_params] || {}
|
5701
|
+
|
5702
|
+
# header parameters
|
5703
|
+
header_params = opts[:header_params] || {}
|
5704
|
+
# HTTP header 'Accept' (if needed)
|
5705
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
5706
|
+
# HTTP header 'Content-Type'
|
5707
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
5708
|
+
|
5709
|
+
# form parameters
|
5710
|
+
form_params = opts[:form_params] || {}
|
5711
|
+
|
5712
|
+
# http body (model)
|
5713
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(transfer_cancel_request)
|
5714
|
+
|
5715
|
+
# return_type
|
5716
|
+
return_type = opts[:debug_return_type] || 'TransferCancelResponse'
|
5717
|
+
|
5718
|
+
# auth_names
|
5719
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
5720
|
+
|
5721
|
+
new_options = opts.merge(
|
5722
|
+
:operation => :"PlaidApi.transfer_cancel",
|
5723
|
+
:header_params => header_params,
|
5724
|
+
:query_params => query_params,
|
5725
|
+
:form_params => form_params,
|
5726
|
+
:body => post_body,
|
5727
|
+
:auth_names => auth_names,
|
5728
|
+
:return_type => return_type
|
5729
|
+
)
|
5730
|
+
|
5731
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
5732
|
+
if @api_client.config.debugging
|
5733
|
+
@api_client.config.logger.debug "API called: PlaidApi#transfer_cancel\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
5734
|
+
end
|
5735
|
+
return data, status_code, headers
|
5736
|
+
end
|
5737
|
+
|
5738
|
+
# Create a transfer
|
5739
|
+
# Use the `/transfer/create` endpoint to initiate a new transfer.
|
5740
|
+
# @param transfer_create_request [TransferCreateRequest]
|
5741
|
+
# @param [Hash] opts the optional parameters
|
5742
|
+
# @return [TransferCreateResponse]
|
5743
|
+
def transfer_create(transfer_create_request, opts = {})
|
5744
|
+
data, _status_code, _headers = transfer_create_with_http_info(transfer_create_request, opts)
|
5745
|
+
data
|
5746
|
+
end
|
5747
|
+
|
5748
|
+
# Create a transfer
|
5749
|
+
# Use the `/transfer/create` endpoint to initiate a new transfer.
|
5750
|
+
# @param transfer_create_request [TransferCreateRequest]
|
5751
|
+
# @param [Hash] opts the optional parameters
|
5752
|
+
# @return [Array<(TransferCreateResponse, Integer, Hash)>] TransferCreateResponse data, response status code and response headers
|
5753
|
+
def transfer_create_with_http_info(transfer_create_request, opts = {})
|
5754
|
+
if @api_client.config.debugging
|
5755
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.transfer_create ...'
|
5756
|
+
end
|
5757
|
+
# verify the required parameter 'transfer_create_request' is set
|
5758
|
+
if @api_client.config.client_side_validation && transfer_create_request.nil?
|
5759
|
+
fail ArgumentError, "Missing the required parameter 'transfer_create_request' when calling PlaidApi.transfer_create"
|
5760
|
+
end
|
5761
|
+
# resource path
|
5762
|
+
local_var_path = '/transfer/create'
|
5763
|
+
|
5764
|
+
# query parameters
|
5765
|
+
query_params = opts[:query_params] || {}
|
5766
|
+
|
5767
|
+
# header parameters
|
5768
|
+
header_params = opts[:header_params] || {}
|
5769
|
+
# HTTP header 'Accept' (if needed)
|
5770
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
5771
|
+
# HTTP header 'Content-Type'
|
5772
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
5773
|
+
|
5774
|
+
# form parameters
|
5775
|
+
form_params = opts[:form_params] || {}
|
5776
|
+
|
5777
|
+
# http body (model)
|
5778
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(transfer_create_request)
|
5779
|
+
|
5780
|
+
# return_type
|
5781
|
+
return_type = opts[:debug_return_type] || 'TransferCreateResponse'
|
5782
|
+
|
5783
|
+
# auth_names
|
5784
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
5785
|
+
|
5786
|
+
new_options = opts.merge(
|
5787
|
+
:operation => :"PlaidApi.transfer_create",
|
5788
|
+
:header_params => header_params,
|
5789
|
+
:query_params => query_params,
|
5790
|
+
:form_params => form_params,
|
5791
|
+
:body => post_body,
|
5792
|
+
:auth_names => auth_names,
|
5793
|
+
:return_type => return_type
|
5794
|
+
)
|
5795
|
+
|
5796
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
5797
|
+
if @api_client.config.debugging
|
5798
|
+
@api_client.config.logger.debug "API called: PlaidApi#transfer_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
5799
|
+
end
|
5800
|
+
return data, status_code, headers
|
5801
|
+
end
|
5802
|
+
|
5803
|
+
# List transfer events
|
5804
|
+
# Use the `/transfer/event/list` endpoint to get a list of transfer events based on specified filter criteria.
|
5805
|
+
# @param transfer_event_list_request [TransferEventListRequest]
|
5806
|
+
# @param [Hash] opts the optional parameters
|
5807
|
+
# @return [TransferEventListResponse]
|
5808
|
+
def transfer_event_list(transfer_event_list_request, opts = {})
|
5809
|
+
data, _status_code, _headers = transfer_event_list_with_http_info(transfer_event_list_request, opts)
|
5810
|
+
data
|
5811
|
+
end
|
5812
|
+
|
5813
|
+
# List transfer events
|
5814
|
+
# Use the `/transfer/event/list` endpoint to get a list of transfer events based on specified filter criteria.
|
5815
|
+
# @param transfer_event_list_request [TransferEventListRequest]
|
5816
|
+
# @param [Hash] opts the optional parameters
|
5817
|
+
# @return [Array<(TransferEventListResponse, Integer, Hash)>] TransferEventListResponse data, response status code and response headers
|
5818
|
+
def transfer_event_list_with_http_info(transfer_event_list_request, opts = {})
|
5819
|
+
if @api_client.config.debugging
|
5820
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.transfer_event_list ...'
|
5821
|
+
end
|
5822
|
+
# verify the required parameter 'transfer_event_list_request' is set
|
5823
|
+
if @api_client.config.client_side_validation && transfer_event_list_request.nil?
|
5824
|
+
fail ArgumentError, "Missing the required parameter 'transfer_event_list_request' when calling PlaidApi.transfer_event_list"
|
5825
|
+
end
|
5826
|
+
# resource path
|
5827
|
+
local_var_path = '/transfer/event/list'
|
5828
|
+
|
5829
|
+
# query parameters
|
5830
|
+
query_params = opts[:query_params] || {}
|
5831
|
+
|
5832
|
+
# header parameters
|
5833
|
+
header_params = opts[:header_params] || {}
|
5834
|
+
# HTTP header 'Accept' (if needed)
|
5835
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
5836
|
+
# HTTP header 'Content-Type'
|
5837
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
5838
|
+
|
5839
|
+
# form parameters
|
5840
|
+
form_params = opts[:form_params] || {}
|
5841
|
+
|
5842
|
+
# http body (model)
|
5843
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(transfer_event_list_request)
|
5844
|
+
|
5845
|
+
# return_type
|
5846
|
+
return_type = opts[:debug_return_type] || 'TransferEventListResponse'
|
5847
|
+
|
5848
|
+
# auth_names
|
5849
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
5850
|
+
|
5851
|
+
new_options = opts.merge(
|
5852
|
+
:operation => :"PlaidApi.transfer_event_list",
|
5853
|
+
:header_params => header_params,
|
5854
|
+
:query_params => query_params,
|
5855
|
+
:form_params => form_params,
|
5856
|
+
:body => post_body,
|
5857
|
+
:auth_names => auth_names,
|
5858
|
+
:return_type => return_type
|
5859
|
+
)
|
5860
|
+
|
5861
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
5862
|
+
if @api_client.config.debugging
|
5863
|
+
@api_client.config.logger.debug "API called: PlaidApi#transfer_event_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
5864
|
+
end
|
5865
|
+
return data, status_code, headers
|
5866
|
+
end
|
5867
|
+
|
5868
|
+
# Sync transfer events
|
5869
|
+
# `/transfer/event/sync` allows you to request up to the next 25 transfer events that happened after a specific `event_id`. Use the `/transfer/event/sync` endpoint to guarantee you have seen all transfer events.
|
5870
|
+
# @param transfer_event_sync_request [TransferEventSyncRequest]
|
5871
|
+
# @param [Hash] opts the optional parameters
|
5872
|
+
# @return [TransferEventSyncResponse]
|
5873
|
+
def transfer_event_sync(transfer_event_sync_request, opts = {})
|
5874
|
+
data, _status_code, _headers = transfer_event_sync_with_http_info(transfer_event_sync_request, opts)
|
5875
|
+
data
|
5876
|
+
end
|
5877
|
+
|
5878
|
+
# Sync transfer events
|
5879
|
+
# `/transfer/event/sync` allows you to request up to the next 25 transfer events that happened after a specific `event_id`. Use the `/transfer/event/sync` endpoint to guarantee you have seen all transfer events.
|
5880
|
+
# @param transfer_event_sync_request [TransferEventSyncRequest]
|
5881
|
+
# @param [Hash] opts the optional parameters
|
5882
|
+
# @return [Array<(TransferEventSyncResponse, Integer, Hash)>] TransferEventSyncResponse data, response status code and response headers
|
5883
|
+
def transfer_event_sync_with_http_info(transfer_event_sync_request, opts = {})
|
5884
|
+
if @api_client.config.debugging
|
5885
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.transfer_event_sync ...'
|
5886
|
+
end
|
5887
|
+
# verify the required parameter 'transfer_event_sync_request' is set
|
5888
|
+
if @api_client.config.client_side_validation && transfer_event_sync_request.nil?
|
5889
|
+
fail ArgumentError, "Missing the required parameter 'transfer_event_sync_request' when calling PlaidApi.transfer_event_sync"
|
5890
|
+
end
|
5891
|
+
# resource path
|
5892
|
+
local_var_path = '/transfer/event/sync'
|
5893
|
+
|
5894
|
+
# query parameters
|
5895
|
+
query_params = opts[:query_params] || {}
|
5896
|
+
|
5897
|
+
# header parameters
|
5898
|
+
header_params = opts[:header_params] || {}
|
5899
|
+
# HTTP header 'Accept' (if needed)
|
5900
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
5901
|
+
# HTTP header 'Content-Type'
|
5902
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
5903
|
+
|
5904
|
+
# form parameters
|
5905
|
+
form_params = opts[:form_params] || {}
|
5906
|
+
|
5907
|
+
# http body (model)
|
5908
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(transfer_event_sync_request)
|
5909
|
+
|
5910
|
+
# return_type
|
5911
|
+
return_type = opts[:debug_return_type] || 'TransferEventSyncResponse'
|
5912
|
+
|
5913
|
+
# auth_names
|
5914
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
5915
|
+
|
5916
|
+
new_options = opts.merge(
|
5917
|
+
:operation => :"PlaidApi.transfer_event_sync",
|
5918
|
+
:header_params => header_params,
|
5919
|
+
:query_params => query_params,
|
5920
|
+
:form_params => form_params,
|
5921
|
+
:body => post_body,
|
5922
|
+
:auth_names => auth_names,
|
5923
|
+
:return_type => return_type
|
5924
|
+
)
|
5925
|
+
|
5926
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
5927
|
+
if @api_client.config.debugging
|
5928
|
+
@api_client.config.logger.debug "API called: PlaidApi#transfer_event_sync\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
5929
|
+
end
|
5930
|
+
return data, status_code, headers
|
5931
|
+
end
|
5932
|
+
|
5933
|
+
# Retrieve a transfer
|
5934
|
+
# The `/transfer/get` fetches information about the transfer corresponding to the given `transfer_id`.
|
5935
|
+
# @param transfer_get_request [TransferGetRequest]
|
5936
|
+
# @param [Hash] opts the optional parameters
|
5937
|
+
# @return [TransferGetResponse]
|
5938
|
+
def transfer_get(transfer_get_request, opts = {})
|
5939
|
+
data, _status_code, _headers = transfer_get_with_http_info(transfer_get_request, opts)
|
5940
|
+
data
|
5941
|
+
end
|
5942
|
+
|
5943
|
+
# Retrieve a transfer
|
5944
|
+
# The `/transfer/get` fetches information about the transfer corresponding to the given `transfer_id`.
|
5945
|
+
# @param transfer_get_request [TransferGetRequest]
|
5946
|
+
# @param [Hash] opts the optional parameters
|
5947
|
+
# @return [Array<(TransferGetResponse, Integer, Hash)>] TransferGetResponse data, response status code and response headers
|
5948
|
+
def transfer_get_with_http_info(transfer_get_request, opts = {})
|
5949
|
+
if @api_client.config.debugging
|
5950
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.transfer_get ...'
|
5951
|
+
end
|
5952
|
+
# verify the required parameter 'transfer_get_request' is set
|
5953
|
+
if @api_client.config.client_side_validation && transfer_get_request.nil?
|
5954
|
+
fail ArgumentError, "Missing the required parameter 'transfer_get_request' when calling PlaidApi.transfer_get"
|
5955
|
+
end
|
5956
|
+
# resource path
|
5957
|
+
local_var_path = '/transfer/get'
|
5958
|
+
|
5959
|
+
# query parameters
|
5960
|
+
query_params = opts[:query_params] || {}
|
5961
|
+
|
5962
|
+
# header parameters
|
5963
|
+
header_params = opts[:header_params] || {}
|
5964
|
+
# HTTP header 'Accept' (if needed)
|
5965
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
5966
|
+
# HTTP header 'Content-Type'
|
5967
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
5968
|
+
|
5969
|
+
# form parameters
|
5970
|
+
form_params = opts[:form_params] || {}
|
5971
|
+
|
5972
|
+
# http body (model)
|
5973
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(transfer_get_request)
|
5974
|
+
|
5975
|
+
# return_type
|
5976
|
+
return_type = opts[:debug_return_type] || 'TransferGetResponse'
|
5977
|
+
|
5978
|
+
# auth_names
|
5979
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
5980
|
+
|
5981
|
+
new_options = opts.merge(
|
5982
|
+
:operation => :"PlaidApi.transfer_get",
|
5983
|
+
:header_params => header_params,
|
5984
|
+
:query_params => query_params,
|
5985
|
+
:form_params => form_params,
|
5986
|
+
:body => post_body,
|
5987
|
+
:auth_names => auth_names,
|
5988
|
+
:return_type => return_type
|
5989
|
+
)
|
5990
|
+
|
5991
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
5992
|
+
if @api_client.config.debugging
|
5993
|
+
@api_client.config.logger.debug "API called: PlaidApi#transfer_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
5994
|
+
end
|
5995
|
+
return data, status_code, headers
|
5996
|
+
end
|
5997
|
+
|
5998
|
+
# List transfers
|
5999
|
+
# Use the `/transfer/list` endpoint to see a list of all your transfers and their statuses. Results are paginated; use the `count` and `offset` query parameters to retrieve the desired transfers.
|
6000
|
+
# @param transfer_list_request [TransferListRequest]
|
6001
|
+
# @param [Hash] opts the optional parameters
|
6002
|
+
# @return [TransferListResponse]
|
6003
|
+
def transfer_list(transfer_list_request, opts = {})
|
6004
|
+
data, _status_code, _headers = transfer_list_with_http_info(transfer_list_request, opts)
|
6005
|
+
data
|
6006
|
+
end
|
6007
|
+
|
6008
|
+
# List transfers
|
6009
|
+
# Use the `/transfer/list` endpoint to see a list of all your transfers and their statuses. Results are paginated; use the `count` and `offset` query parameters to retrieve the desired transfers.
|
6010
|
+
# @param transfer_list_request [TransferListRequest]
|
6011
|
+
# @param [Hash] opts the optional parameters
|
6012
|
+
# @return [Array<(TransferListResponse, Integer, Hash)>] TransferListResponse data, response status code and response headers
|
6013
|
+
def transfer_list_with_http_info(transfer_list_request, opts = {})
|
6014
|
+
if @api_client.config.debugging
|
6015
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.transfer_list ...'
|
6016
|
+
end
|
6017
|
+
# verify the required parameter 'transfer_list_request' is set
|
6018
|
+
if @api_client.config.client_side_validation && transfer_list_request.nil?
|
6019
|
+
fail ArgumentError, "Missing the required parameter 'transfer_list_request' when calling PlaidApi.transfer_list"
|
6020
|
+
end
|
6021
|
+
# resource path
|
6022
|
+
local_var_path = '/transfer/list'
|
6023
|
+
|
6024
|
+
# query parameters
|
6025
|
+
query_params = opts[:query_params] || {}
|
6026
|
+
|
6027
|
+
# header parameters
|
6028
|
+
header_params = opts[:header_params] || {}
|
6029
|
+
# HTTP header 'Accept' (if needed)
|
6030
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
6031
|
+
# HTTP header 'Content-Type'
|
6032
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
6033
|
+
|
6034
|
+
# form parameters
|
6035
|
+
form_params = opts[:form_params] || {}
|
6036
|
+
|
6037
|
+
# http body (model)
|
6038
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(transfer_list_request)
|
6039
|
+
|
6040
|
+
# return_type
|
6041
|
+
return_type = opts[:debug_return_type] || 'TransferListResponse'
|
6042
|
+
|
6043
|
+
# auth_names
|
6044
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
6045
|
+
|
6046
|
+
new_options = opts.merge(
|
6047
|
+
:operation => :"PlaidApi.transfer_list",
|
6048
|
+
:header_params => header_params,
|
6049
|
+
:query_params => query_params,
|
6050
|
+
:form_params => form_params,
|
6051
|
+
:body => post_body,
|
6052
|
+
:auth_names => auth_names,
|
6053
|
+
:return_type => return_type
|
6054
|
+
)
|
6055
|
+
|
6056
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
6057
|
+
if @api_client.config.debugging
|
6058
|
+
@api_client.config.logger.debug "API called: PlaidApi#transfer_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
6059
|
+
end
|
6060
|
+
return data, status_code, headers
|
6061
|
+
end
|
6062
|
+
|
5090
6063
|
# Get webhook verification key
|
5091
6064
|
# Plaid signs all outgoing webhooks and provides JSON Web Tokens (JWTs) so that you can verify the authenticity of any incoming webhooks to your application. A message signature is included in the `Plaid-Verification` header. The `/webhook_verification_key/get` endpoint provides a JSON Web Key (JWK) that can be used to verify a JWT.
|
5092
6065
|
# @param webhook_verification_key_get_request [WebhookVerificationKeyGetRequest]
|