plaid 14.0.0.beta.2 → 14.0.0.beta.5.pre.plural.pre.income.pre.breakdown
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +15 -1
- data/Gemfile.lock +19 -5
- data/LICENSE.txt +1 -1
- data/Makefile +2 -21
- data/PUBLISH.md +2 -3
- data/README.md +4 -4
- data/lib/plaid/api/plaid_api.rb +274 -116
- data/lib/plaid/api_client.rb +2 -2
- data/lib/plaid/api_error.rb +2 -2
- data/lib/plaid/configuration.rb +2 -2
- data/lib/plaid/models/account_assets.rb +3 -3
- data/lib/plaid/models/account_assets_all_of.rb +2 -2
- data/lib/plaid/models/account_balance.rb +18 -7
- data/lib/plaid/models/account_base.rb +3 -3
- data/lib/plaid/models/account_filters_response.rb +2 -2
- data/lib/plaid/models/account_identity.rb +3 -3
- data/lib/plaid/models/account_identity_all_of.rb +2 -2
- data/lib/plaid/models/account_subtype.rb +3 -2
- data/lib/plaid/models/account_type.rb +2 -2
- data/lib/plaid/models/accounts_balance_get_request.rb +4 -4
- data/lib/plaid/models/accounts_balance_get_request_options.rb +16 -6
- data/lib/plaid/models/accounts_get_request.rb +4 -4
- data/lib/plaid/models/accounts_get_request_options.rb +2 -2
- data/lib/plaid/models/accounts_get_response.rb +2 -2
- data/lib/plaid/models/ach_class.rb +2 -2
- data/lib/plaid/models/address.rb +2 -2
- data/lib/plaid/models/address_data.rb +2 -2
- data/lib/plaid/models/application.rb +273 -0
- data/lib/plaid/models/application_get_request.rb +255 -0
- data/lib/plaid/models/{link_token_create_request_account_subtypes_investment.rb → application_get_response.rb} +33 -16
- data/lib/plaid/models/apr.rb +2 -2
- data/lib/plaid/models/asset_report.rb +2 -2
- data/lib/plaid/models/asset_report_audit_copy_create_request.rb +4 -4
- data/lib/plaid/models/asset_report_audit_copy_create_response.rb +2 -2
- data/lib/plaid/models/asset_report_audit_copy_get_request.rb +4 -4
- data/lib/plaid/models/asset_report_audit_copy_remove_request.rb +4 -4
- data/lib/plaid/models/asset_report_audit_copy_remove_response.rb +2 -2
- data/lib/plaid/models/asset_report_create_request.rb +28 -4
- data/lib/plaid/models/asset_report_create_request_options.rb +2 -2
- data/lib/plaid/models/asset_report_create_response.rb +2 -2
- data/lib/plaid/models/asset_report_filter_request.rb +4 -4
- data/lib/plaid/models/asset_report_filter_response.rb +2 -2
- data/lib/plaid/models/asset_report_get_request.rb +5 -5
- data/lib/plaid/models/asset_report_get_response.rb +2 -2
- data/lib/plaid/models/asset_report_item.rb +2 -2
- data/lib/plaid/models/asset_report_pdf_get_request.rb +4 -4
- data/lib/plaid/models/asset_report_refresh_request.rb +6 -4
- data/lib/plaid/models/asset_report_refresh_request_options.rb +2 -2
- data/lib/plaid/models/asset_report_refresh_response.rb +2 -2
- data/lib/plaid/models/asset_report_remove_request.rb +4 -4
- data/lib/plaid/models/asset_report_remove_response.rb +2 -2
- data/lib/plaid/models/asset_report_transaction.rb +28 -6
- data/lib/plaid/models/asset_report_transaction_all_of.rb +2 -2
- data/lib/plaid/models/asset_report_user.rb +2 -2
- data/lib/plaid/models/assets_error_webhook.rb +2 -2
- data/lib/plaid/models/assets_product_ready_webhook.rb +2 -2
- data/lib/plaid/models/auth_get_numbers.rb +2 -2
- data/lib/plaid/models/auth_get_request.rb +4 -4
- data/lib/plaid/models/auth_get_request_options.rb +2 -2
- data/lib/plaid/models/auth_get_response.rb +2 -2
- data/lib/plaid/models/automatically_verified_webhook.rb +3 -3
- data/lib/plaid/models/bank_transfer.rb +11 -2
- data/lib/plaid/models/bank_transfer_balance.rb +2 -2
- data/lib/plaid/models/bank_transfer_balance_get_request.rb +4 -4
- data/lib/plaid/models/bank_transfer_balance_get_response.rb +2 -2
- data/lib/plaid/models/bank_transfer_cancel_request.rb +4 -4
- data/lib/plaid/models/bank_transfer_cancel_response.rb +2 -2
- data/lib/plaid/models/bank_transfer_create_request.rb +19 -4
- data/lib/plaid/models/bank_transfer_create_response.rb +2 -2
- data/lib/plaid/models/bank_transfer_direction.rb +2 -2
- data/lib/plaid/models/bank_transfer_event.rb +4 -2
- data/lib/plaid/models/bank_transfer_event_list_request.rb +8 -4
- data/lib/plaid/models/bank_transfer_event_list_response.rb +2 -2
- data/lib/plaid/models/bank_transfer_event_sync_request.rb +8 -4
- data/lib/plaid/models/bank_transfer_event_sync_response.rb +2 -2
- data/lib/plaid/models/bank_transfer_event_type.rb +2 -2
- data/lib/plaid/models/bank_transfer_failure.rb +2 -2
- data/lib/plaid/models/bank_transfer_get_request.rb +4 -4
- data/lib/plaid/models/bank_transfer_get_response.rb +2 -2
- data/lib/plaid/models/bank_transfer_list_request.rb +8 -4
- data/lib/plaid/models/bank_transfer_list_response.rb +2 -2
- data/lib/plaid/models/bank_transfer_migrate_account_request.rb +4 -4
- data/lib/plaid/models/bank_transfer_migrate_account_response.rb +2 -2
- data/lib/plaid/models/bank_transfer_network.rb +2 -2
- data/lib/plaid/models/bank_transfer_receiver_details.rb +2 -2
- data/lib/plaid/models/bank_transfer_status.rb +2 -2
- data/lib/plaid/models/bank_transfer_type.rb +2 -2
- data/lib/plaid/models/bank_transfer_user.rb +2 -2
- data/lib/plaid/models/bank_transfers_events_update_webhook.rb +240 -0
- data/lib/plaid/models/categories_get_response.rb +2 -2
- data/lib/plaid/models/category.rb +2 -2
- data/lib/plaid/models/cause.rb +2 -2
- data/lib/plaid/models/country_code.rb +2 -2
- data/lib/plaid/models/credit_card_liability.rb +3 -18
- data/lib/plaid/models/credit_filter.rb +2 -2
- data/lib/plaid/models/default_update_webhook.rb +2 -2
- data/lib/plaid/models/deposit_switch_address_data.rb +2 -2
- data/lib/plaid/models/deposit_switch_alt_create_request.rb +4 -4
- data/lib/plaid/models/deposit_switch_alt_create_response.rb +2 -2
- data/lib/plaid/models/deposit_switch_create_request.rb +4 -4
- data/lib/plaid/models/deposit_switch_create_response.rb +2 -2
- data/lib/plaid/models/deposit_switch_get_request.rb +4 -4
- data/lib/plaid/models/deposit_switch_get_response.rb +2 -2
- data/lib/plaid/models/deposit_switch_target_account.rb +2 -2
- data/lib/plaid/models/deposit_switch_target_user.rb +2 -2
- data/lib/plaid/models/deposit_switch_token_create_request.rb +4 -4
- data/lib/plaid/models/deposit_switch_token_create_response.rb +2 -2
- data/lib/plaid/models/depository_filter.rb +2 -2
- data/lib/plaid/models/email.rb +2 -2
- data/lib/plaid/models/employee.rb +2 -2
- data/lib/plaid/models/employee_income_summary_field_string.rb +2 -2
- data/lib/plaid/models/employer.rb +2 -2
- data/lib/plaid/models/employer_income_summary_field_string.rb +2 -2
- data/lib/plaid/models/employers_search_request.rb +4 -4
- data/lib/plaid/models/employers_search_response.rb +2 -2
- data/lib/plaid/models/error.rb +4 -4
- data/lib/plaid/models/{item_status_transactions.rb → external_payment_options.rb} +33 -23
- data/lib/plaid/models/{link_token_create_request_account_subtypes_depository.rb → external_payment_refund_details.rb} +34 -16
- data/lib/plaid/models/external_payment_schedule.rb +7 -7
- data/lib/plaid/models/external_payment_schedule_get.rb +283 -0
- data/lib/plaid/models/health_incident.rb +2 -2
- 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 +3 -3
- data/lib/plaid/models/holdings_default_update_webhook.rb +2 -2
- data/lib/plaid/models/identity_get_request.rb +4 -4
- data/lib/plaid/models/identity_get_request_options.rb +2 -2
- data/lib/plaid/models/identity_get_response.rb +2 -2
- data/lib/plaid/models/incident_update.rb +2 -2
- data/lib/plaid/models/income_breakdown.rb +2 -2
- data/lib/plaid/models/income_summary.rb +2 -2
- data/lib/plaid/models/income_summary_field_number.rb +2 -2
- data/lib/plaid/models/income_summary_field_string.rb +2 -2
- data/lib/plaid/models/income_verification_create_request.rb +4 -4
- data/lib/plaid/models/income_verification_create_response.rb +2 -2
- data/lib/plaid/models/income_verification_documents_download_request.rb +4 -4
- data/lib/plaid/models/income_verification_documents_download_response.rb +2 -2
- data/lib/plaid/models/income_verification_paystub_get_request.rb +4 -4
- data/lib/plaid/models/income_verification_paystub_get_response.rb +2 -2
- data/lib/plaid/models/income_verification_status_webhook.rb +2 -2
- data/lib/plaid/models/income_verification_summary_get_request.rb +4 -4
- data/lib/plaid/models/income_verification_summary_get_response.rb +2 -2
- data/lib/plaid/models/income_verification_webhook_status.rb +2 -2
- data/lib/plaid/models/inflow_model.rb +2 -2
- data/lib/plaid/models/initial_update_webhook.rb +2 -2
- data/lib/plaid/models/institution.rb +16 -6
- data/lib/plaid/models/institution_status.rb +2 -2
- data/lib/plaid/models/institutions_get_by_id_request.rb +4 -4
- data/lib/plaid/models/institutions_get_by_id_request_options.rb +19 -7
- data/lib/plaid/models/institutions_get_by_id_response.rb +2 -2
- data/lib/plaid/models/institutions_get_request.rb +27 -4
- data/lib/plaid/models/institutions_get_request_options.rb +20 -8
- data/lib/plaid/models/institutions_get_response.rb +3 -3
- data/lib/plaid/models/institutions_search_account_filter.rb +2 -2
- data/lib/plaid/models/{item_status_last_webhook.rb → institutions_search_payment_initiation_options.rb} +14 -26
- data/lib/plaid/models/institutions_search_request.rb +25 -4
- data/lib/plaid/models/institutions_search_request_options.rb +23 -10
- data/lib/plaid/models/institutions_search_response.rb +2 -2
- data/lib/plaid/models/investment_filter.rb +2 -2
- data/lib/plaid/models/investment_holdings_get_request_options.rb +2 -2
- data/lib/plaid/models/investment_transaction.rb +4 -3
- data/lib/plaid/models/investments_default_update_webhook.rb +2 -2
- data/lib/plaid/models/investments_holdings_get_request.rb +4 -4
- data/lib/plaid/models/investments_holdings_get_response.rb +2 -2
- data/lib/plaid/models/investments_transactions_get_request.rb +4 -4
- data/lib/plaid/models/investments_transactions_get_request_options.rb +11 -7
- data/lib/plaid/models/investments_transactions_get_response.rb +2 -2
- data/lib/plaid/models/item.rb +43 -3
- data/lib/plaid/models/item_access_token_invalidate_request.rb +4 -4
- data/lib/plaid/models/item_access_token_invalidate_response.rb +2 -2
- data/lib/plaid/models/item_error_webhook.rb +2 -2
- data/lib/plaid/models/item_get_request.rb +4 -4
- data/lib/plaid/models/item_get_response.rb +6 -16
- data/lib/plaid/models/item_import_request.rb +25 -4
- data/lib/plaid/models/item_import_request_options.rb +2 -2
- data/lib/plaid/models/item_import_request_user_auth.rb +2 -2
- data/lib/plaid/models/item_import_response.rb +2 -2
- data/lib/plaid/models/item_product_ready_webhook.rb +2 -2
- data/lib/plaid/models/item_public_token_create_request.rb +4 -4
- data/lib/plaid/models/item_public_token_create_response.rb +2 -2
- data/lib/plaid/models/item_public_token_exchange_request.rb +4 -4
- data/lib/plaid/models/item_public_token_exchange_response.rb +2 -2
- data/lib/plaid/models/item_remove_request.rb +4 -4
- data/lib/plaid/models/item_remove_response.rb +2 -2
- data/lib/plaid/models/item_status.rb +17 -8
- data/lib/plaid/models/item_webhook_update_request.rb +4 -4
- data/lib/plaid/models/item_webhook_update_response.rb +2 -2
- data/lib/plaid/models/jwk_public_key.rb +42 -2
- data/lib/plaid/models/jwt_header.rb +2 -2
- data/lib/plaid/models/liabilities_default_update_webhook.rb +274 -0
- data/lib/plaid/models/liabilities_get_request.rb +4 -4
- data/lib/plaid/models/liabilities_get_request_options.rb +2 -2
- data/lib/plaid/models/liabilities_get_response.rb +2 -2
- data/lib/plaid/models/liabilities_object.rb +2 -2
- data/lib/plaid/models/liability_override.rb +7 -24
- data/lib/plaid/models/link_token_account_filters.rb +2 -2
- data/lib/plaid/models/link_token_create_request.rb +51 -12
- data/lib/plaid/models/link_token_create_request_account_subtypes.rb +22 -10
- data/lib/plaid/models/{amount.rb → link_token_create_request_auth.rb} +25 -40
- data/lib/plaid/models/link_token_create_request_deposit_switch.rb +2 -2
- data/lib/plaid/models/link_token_create_request_income_verification.rb +2 -2
- data/lib/plaid/models/link_token_create_request_payment_initiation.rb +2 -2
- data/lib/plaid/models/link_token_create_request_user.rb +4 -4
- data/lib/plaid/models/link_token_create_response.rb +3 -3
- data/lib/plaid/models/link_token_get_metadata_response.rb +2 -2
- data/lib/plaid/models/link_token_get_request.rb +4 -4
- data/lib/plaid/models/link_token_get_response.rb +2 -2
- data/lib/plaid/models/loan_filter.rb +2 -2
- data/lib/plaid/models/location.rb +2 -2
- data/lib/plaid/models/meta.rb +2 -2
- data/lib/plaid/models/mfa.rb +2 -2
- data/lib/plaid/models/mortgage_interest_rate.rb +2 -2
- data/lib/plaid/models/mortgage_liability.rb +2 -2
- data/lib/plaid/models/mortgage_property_address.rb +2 -2
- data/lib/plaid/models/nullable_access_token.rb +2 -2
- data/lib/plaid/models/nullable_address.rb +2 -2
- data/lib/plaid/models/nullable_address_data.rb +2 -2
- data/lib/plaid/models/nullable_item_status.rb +17 -8
- data/lib/plaid/models/nullable_numbers_ach.rb +4 -4
- data/lib/plaid/models/nullable_numbers_bacs.rb +2 -2
- data/lib/plaid/models/nullable_numbers_eft.rb +2 -2
- data/lib/plaid/models/nullable_numbers_international.rb +2 -2
- data/lib/plaid/models/nullable_recipient_bacs.rb +2 -2
- data/lib/plaid/models/numbers.rb +2 -2
- data/lib/plaid/models/numbers_ach.rb +4 -4
- data/lib/plaid/models/numbers_bacs.rb +2 -2
- data/lib/plaid/models/numbers_eft.rb +2 -2
- data/lib/plaid/models/numbers_international.rb +2 -2
- data/lib/plaid/models/override_accounts.rb +2 -2
- data/lib/plaid/models/owner.rb +3 -3
- data/lib/plaid/models/owner_override.rb +2 -2
- data/lib/plaid/models/pay_frequency.rb +2 -2
- data/lib/plaid/models/pay_period_details.rb +2 -2
- data/lib/plaid/models/payment_amount.rb +38 -4
- data/lib/plaid/models/payment_initiation_address.rb +19 -2
- data/lib/plaid/models/payment_initiation_metadata.rb +252 -0
- data/lib/plaid/models/{payment_initiation_recipient_bacs.rb → payment_initiation_optional_restriction_bacs.rb} +14 -15
- data/lib/plaid/models/payment_initiation_payment.rb +395 -0
- data/lib/plaid/models/payment_initiation_payment_create_request.rb +20 -10
- data/lib/plaid/models/payment_initiation_payment_create_response.rb +2 -2
- data/lib/plaid/models/payment_initiation_payment_get_request.rb +4 -4
- data/lib/plaid/models/payment_initiation_payment_get_response.rb +77 -22
- data/lib/plaid/models/payment_initiation_payment_list_request.rb +8 -4
- data/lib/plaid/models/payment_initiation_payment_list_response.rb +5 -9
- data/lib/plaid/models/payment_initiation_payment_token_create_request.rb +4 -4
- data/lib/plaid/models/payment_initiation_payment_token_create_response.rb +3 -3
- data/lib/plaid/models/payment_initiation_recipient.rb +21 -10
- data/lib/plaid/models/payment_initiation_recipient_create_request.rb +5 -4
- data/lib/plaid/models/payment_initiation_recipient_create_response.rb +2 -2
- data/lib/plaid/models/payment_initiation_recipient_get_request.rb +4 -4
- data/lib/plaid/models/payment_initiation_recipient_get_response.rb +22 -3
- data/lib/plaid/models/{link_token_create_request_account_subtypes_loan.rb → payment_initiation_recipient_get_response_all_of.rb} +13 -16
- data/lib/plaid/models/payment_initiation_recipient_list_request.rb +4 -4
- data/lib/plaid/models/payment_initiation_recipient_list_response.rb +2 -2
- data/lib/plaid/models/payment_initiation_standing_order_metadata.rb +242 -0
- data/lib/plaid/models/payment_meta.rb +3 -3
- data/lib/plaid/models/payment_schedule_interval.rb +37 -0
- data/lib/plaid/models/payment_status_update_webhook.rb +47 -3
- data/lib/plaid/models/paystub.rb +6 -4
- data/lib/plaid/models/paystub_deduction.rb +2 -2
- data/lib/plaid/models/paystub_ytd_details.rb +2 -2
- data/lib/plaid/models/pending_expiration_webhook.rb +2 -2
- data/lib/plaid/models/phone_number.rb +2 -2
- data/lib/plaid/models/processor_apex_processor_token_create_request.rb +4 -4
- data/lib/plaid/models/processor_auth_get_request.rb +4 -4
- data/lib/plaid/models/processor_auth_get_response.rb +2 -2
- data/lib/plaid/models/processor_balance_get_request.rb +4 -4
- data/lib/plaid/models/processor_balance_get_response.rb +2 -2
- data/lib/plaid/models/processor_identity_get_request.rb +4 -4
- data/lib/plaid/models/processor_identity_get_response.rb +2 -2
- data/lib/plaid/models/processor_number.rb +2 -2
- data/lib/plaid/models/processor_stripe_bank_account_token_create_request.rb +4 -4
- data/lib/plaid/models/processor_stripe_bank_account_token_create_response.rb +2 -2
- data/lib/plaid/models/processor_token_create_request.rb +5 -5
- data/lib/plaid/models/processor_token_create_response.rb +2 -2
- data/lib/plaid/models/product_status.rb +2 -2
- data/lib/plaid/models/product_status_breakdown.rb +2 -2
- data/lib/plaid/models/products.rb +3 -2
- data/lib/plaid/models/projected_income_summary_field_number.rb +2 -2
- data/lib/plaid/models/pslf_status.rb +2 -2
- data/lib/plaid/models/recaptcha_required_error.rb +2 -2
- data/lib/plaid/models/recipient_bacs.rb +2 -2
- data/lib/plaid/models/{item_status_investments.rb → sandbox_bank_transfer_fire_webhook_request.rb} +36 -23
- data/lib/plaid/models/{link_token_create_request_account_subtypes_credit.rb → sandbox_bank_transfer_fire_webhook_response.rb} +19 -16
- data/lib/plaid/models/sandbox_bank_transfer_simulate_request.rb +4 -4
- data/lib/plaid/models/sandbox_bank_transfer_simulate_response.rb +2 -2
- data/lib/plaid/models/sandbox_item_fire_webhook_request.rb +9 -4
- data/lib/plaid/models/sandbox_item_fire_webhook_response.rb +2 -2
- data/lib/plaid/models/sandbox_item_reset_login_request.rb +4 -4
- data/lib/plaid/models/sandbox_item_reset_login_response.rb +2 -2
- data/lib/plaid/models/sandbox_item_set_verification_status_request.rb +4 -4
- data/lib/plaid/models/sandbox_item_set_verification_status_response.rb +2 -2
- data/lib/plaid/models/sandbox_processor_token_create_request.rb +4 -4
- data/lib/plaid/models/sandbox_processor_token_create_request_options.rb +2 -2
- data/lib/plaid/models/sandbox_processor_token_create_response.rb +2 -2
- data/lib/plaid/models/sandbox_public_token_create_request.rb +25 -4
- data/lib/plaid/models/sandbox_public_token_create_request_options.rb +2 -2
- data/lib/plaid/models/sandbox_public_token_create_request_options_transactions.rb +2 -2
- data/lib/plaid/models/sandbox_public_token_create_response.rb +2 -2
- data/lib/plaid/models/security.rb +5 -8
- data/lib/plaid/models/servicer_address_data.rb +2 -2
- data/lib/plaid/models/standalone_account_type.rb +2 -2
- data/lib/plaid/models/standalone_currency_code_list.rb +2 -2
- data/lib/plaid/models/standalone_investment_transaction_subtype.rb +2 -2
- data/lib/plaid/models/standalone_investment_transaction_type.rb +2 -2
- data/lib/plaid/models/student_loan.rb +4 -15
- data/lib/plaid/models/student_loan_repayment_model.rb +2 -2
- data/lib/plaid/models/student_loan_status.rb +2 -2
- data/lib/plaid/models/student_repayment_plan.rb +2 -2
- data/lib/plaid/models/transaction.rb +28 -6
- data/lib/plaid/models/transaction_code.rb +2 -2
- data/lib/plaid/models/transaction_data.rb +2 -2
- data/lib/plaid/models/transaction_override.rb +21 -21
- data/lib/plaid/models/transactions_get_request.rb +4 -4
- data/lib/plaid/models/transactions_get_request_options.rb +6 -2
- data/lib/plaid/models/transactions_get_response.rb +2 -2
- data/lib/plaid/models/transactions_refresh_request.rb +9 -4
- data/lib/plaid/models/transactions_refresh_response.rb +2 -2
- data/lib/plaid/models/transactions_removed_webhook.rb +2 -2
- data/lib/plaid/models/user_custom_password.rb +2 -2
- data/lib/plaid/models/user_permission_revoked_webhook.rb +2 -2
- data/lib/plaid/models/verification_expired_webhook.rb +3 -3
- data/lib/plaid/models/verification_status.rb +2 -2
- data/lib/plaid/models/warning.rb +2 -2
- data/lib/plaid/models/webhook_update_acknowledged_webhook.rb +2 -2
- data/lib/plaid/models/webhook_verification_key_get_request.rb +4 -4
- data/lib/plaid/models/webhook_verification_key_get_response.rb +2 -2
- data/lib/plaid/models/ytd_gross_income_summary_field_number.rb +2 -2
- data/lib/plaid/models/ytd_net_income_summary_field_number.rb +2 -2
- data/lib/plaid/version.rb +3 -3
- data/lib/plaid.rb +20 -11
- data/pkg/plaid-14.2.0.gem +0 -0
- data/plaid.gemspec +3 -3
- data/templates/ruby/partial_model_generic.mustache +362 -0
- data/test/test_bank_transfers.rb +1 -1
- data/test/test_item.rb +2 -2
- data/test/test_payment_initiation.rb +1 -2
- metadata +23 -324
- data/docs/ACHClass.md +0 -15
- data/docs/APR.md +0 -24
- data/docs/AccountAssets.md +0 -40
- data/docs/AccountAssetsAllOf.md +0 -24
- data/docs/AccountBalance.md +0 -26
- data/docs/AccountBase.md +0 -32
- data/docs/AccountFiltersResponse.md +0 -24
- data/docs/AccountIdentity.md +0 -34
- data/docs/AccountIdentityAllOf.md +0 -18
- data/docs/AccountSubtype.md +0 -15
- data/docs/AccountType.md +0 -15
- data/docs/AccountsBalanceGetRequest.md +0 -24
- data/docs/AccountsBalanceGetRequestOptions.md +0 -18
- data/docs/AccountsGetRequest.md +0 -24
- data/docs/AccountsGetRequestOptions.md +0 -18
- data/docs/AccountsGetResponse.md +0 -22
- data/docs/Address.md +0 -20
- data/docs/AddressData.md +0 -26
- data/docs/Amount.md +0 -20
- data/docs/AssetReport.md +0 -28
- data/docs/AssetReportAuditCopyCreateRequest.md +0 -24
- data/docs/AssetReportAuditCopyCreateResponse.md +0 -20
- data/docs/AssetReportAuditCopyGetRequest.md +0 -22
- data/docs/AssetReportAuditCopyRemoveRequest.md +0 -22
- data/docs/AssetReportAuditCopyRemoveResponse.md +0 -20
- data/docs/AssetReportCreateRequest.md +0 -26
- data/docs/AssetReportCreateRequestOptions.md +0 -22
- data/docs/AssetReportCreateResponse.md +0 -22
- data/docs/AssetReportFilterRequest.md +0 -24
- data/docs/AssetReportFilterResponse.md +0 -22
- data/docs/AssetReportGetRequest.md +0 -24
- data/docs/AssetReportGetResponse.md +0 -22
- data/docs/AssetReportItem.md +0 -26
- data/docs/AssetReportPDFGetRequest.md +0 -22
- data/docs/AssetReportRefreshRequest.md +0 -26
- data/docs/AssetReportRefreshRequestOptions.md +0 -22
- data/docs/AssetReportRefreshResponse.md +0 -22
- data/docs/AssetReportRemoveRequest.md +0 -22
- data/docs/AssetReportRemoveResponse.md +0 -20
- data/docs/AssetReportTransaction.md +0 -58
- data/docs/AssetReportTransactionAllOf.md +0 -20
- data/docs/AssetReportUser.md +0 -30
- data/docs/AssetsErrorWebhook.md +0 -24
- data/docs/AssetsProductReadyWebhook.md +0 -22
- data/docs/AuthGetNumbers.md +0 -24
- data/docs/AuthGetRequest.md +0 -24
- data/docs/AuthGetRequestOptions.md +0 -18
- data/docs/AuthGetResponse.md +0 -24
- data/docs/AutomaticallyVerifiedWebhook.md +0 -24
- data/docs/BankTransfer.md +0 -50
- data/docs/BankTransferBalance.md +0 -20
- data/docs/BankTransferBalanceGetRequest.md +0 -22
- data/docs/BankTransferBalanceGetResponse.md +0 -22
- data/docs/BankTransferCancelRequest.md +0 -22
- data/docs/BankTransferCancelResponse.md +0 -18
- data/docs/BankTransferCreateRequest.md +0 -46
- data/docs/BankTransferCreateResponse.md +0 -20
- data/docs/BankTransferDirection.md +0 -15
- data/docs/BankTransferEvent.md +0 -40
- data/docs/BankTransferEventListRequest.md +0 -40
- data/docs/BankTransferEventListResponse.md +0 -20
- data/docs/BankTransferEventSyncRequest.md +0 -24
- data/docs/BankTransferEventSyncResponse.md +0 -20
- data/docs/BankTransferEventType.md +0 -15
- data/docs/BankTransferFailure.md +0 -20
- data/docs/BankTransferGetRequest.md +0 -22
- data/docs/BankTransferGetResponse.md +0 -20
- data/docs/BankTransferListRequest.md +0 -32
- data/docs/BankTransferListResponse.md +0 -20
- data/docs/BankTransferMigrateAccountRequest.md +0 -26
- data/docs/BankTransferMigrateAccountResponse.md +0 -22
- data/docs/BankTransferNetwork.md +0 -15
- data/docs/BankTransferReceiverDetails.md +0 -18
- data/docs/BankTransferStatus.md +0 -15
- data/docs/BankTransferType.md +0 -15
- data/docs/BankTransferUser.md +0 -22
- data/docs/CategoriesGetResponse.md +0 -20
- data/docs/Category.md +0 -22
- data/docs/Cause.md +0 -20
- data/docs/CountryCode.md +0 -15
- data/docs/CreditCardLiability.md +0 -34
- data/docs/CreditFilter.md +0 -18
- data/docs/DefaultUpdateWebhook.md +0 -26
- data/docs/DepositSwitchAddressData.md +0 -26
- data/docs/DepositSwitchAltCreateRequest.md +0 -24
- data/docs/DepositSwitchAltCreateResponse.md +0 -20
- data/docs/DepositSwitchCreateRequest.md +0 -24
- data/docs/DepositSwitchCreateResponse.md +0 -20
- data/docs/DepositSwitchGetRequest.md +0 -22
- data/docs/DepositSwitchGetResponse.md +0 -38
- data/docs/DepositSwitchTargetAccount.md +0 -24
- data/docs/DepositSwitchTargetUser.md +0 -28
- data/docs/DepositSwitchTokenCreateRequest.md +0 -22
- data/docs/DepositSwitchTokenCreateResponse.md +0 -22
- data/docs/DepositoryFilter.md +0 -18
- data/docs/Email.md +0 -22
- data/docs/Employee.md +0 -22
- data/docs/EmployeeIncomeSummaryFieldString.md +0 -20
- data/docs/Employer.md +0 -24
- data/docs/EmployerIncomeSummaryFieldString.md +0 -20
- data/docs/EmployersSearchRequest.md +0 -24
- data/docs/EmployersSearchResponse.md +0 -20
- data/docs/Error.md +0 -34
- data/docs/ExternalPaymentSchedule.md +0 -24
- data/docs/HealthIncident.md +0 -24
- data/docs/HistoricalBalance.md +0 -24
- data/docs/HistoricalUpdateWebhook.md +0 -26
- data/docs/Holding.md +0 -34
- data/docs/HoldingsDefaultUpdateWebhook.md +0 -28
- data/docs/IdentityGetRequest.md +0 -24
- data/docs/IdentityGetRequestOptions.md +0 -18
- data/docs/IdentityGetResponse.md +0 -22
- data/docs/IncidentUpdate.md +0 -22
- data/docs/IncomeBreakdown.md +0 -24
- data/docs/IncomeSummary.md +0 -30
- data/docs/IncomeSummaryFieldNumber.md +0 -20
- data/docs/IncomeSummaryFieldString.md +0 -20
- data/docs/IncomeVerificationCreateRequest.md +0 -22
- data/docs/IncomeVerificationCreateResponse.md +0 -20
- data/docs/IncomeVerificationDocumentsDownloadRequest.md +0 -22
- data/docs/IncomeVerificationDocumentsDownloadResponse.md +0 -18
- data/docs/IncomeVerificationPaystubGetRequest.md +0 -22
- data/docs/IncomeVerificationPaystubGetResponse.md +0 -20
- data/docs/IncomeVerificationStatusWebhook.md +0 -24
- data/docs/IncomeVerificationSummaryGetRequest.md +0 -22
- data/docs/IncomeVerificationSummaryGetResponse.md +0 -20
- data/docs/IncomeVerificationWebhookStatus.md +0 -18
- data/docs/InflowModel.md +0 -26
- data/docs/InitialUpdateWebhook.md +0 -26
- data/docs/Institution.md +0 -36
- data/docs/InstitutionStatus.md +0 -30
- data/docs/InstitutionsGetByIdRequest.md +0 -26
- data/docs/InstitutionsGetByIdRequestOptions.md +0 -20
- data/docs/InstitutionsGetByIdResponse.md +0 -20
- data/docs/InstitutionsGetRequest.md +0 -28
- data/docs/InstitutionsGetRequestOptions.md +0 -24
- data/docs/InstitutionsGetResponse.md +0 -22
- data/docs/InstitutionsSearchAccountFilter.md +0 -24
- data/docs/InstitutionsSearchRequest.md +0 -28
- data/docs/InstitutionsSearchRequestOptions.md +0 -22
- data/docs/InstitutionsSearchResponse.md +0 -20
- data/docs/InvestmentFilter.md +0 -18
- data/docs/InvestmentHoldingsGetRequestOptions.md +0 -18
- data/docs/InvestmentTransaction.md +0 -44
- data/docs/InvestmentsDefaultUpdateWebhook.md +0 -28
- data/docs/InvestmentsHoldingsGetRequest.md +0 -24
- data/docs/InvestmentsHoldingsGetResponse.md +0 -26
- data/docs/InvestmentsTransactionsGetRequest.md +0 -28
- data/docs/InvestmentsTransactionsGetRequestOptions.md +0 -22
- data/docs/InvestmentsTransactionsGetResponse.md +0 -28
- data/docs/Item.md +0 -32
- data/docs/ItemAccessTokenInvalidateRequest.md +0 -22
- data/docs/ItemAccessTokenInvalidateResponse.md +0 -20
- data/docs/ItemErrorWebhook.md +0 -24
- data/docs/ItemGetRequest.md +0 -22
- data/docs/ItemGetResponse.md +0 -24
- data/docs/ItemImportRequest.md +0 -26
- data/docs/ItemImportRequestOptions.md +0 -18
- data/docs/ItemImportRequestUserAuth.md +0 -20
- data/docs/ItemImportResponse.md +0 -20
- data/docs/ItemProductReadyWebhook.md +0 -24
- data/docs/ItemPublicTokenCreateRequest.md +0 -22
- data/docs/ItemPublicTokenCreateResponse.md +0 -22
- data/docs/ItemPublicTokenExchangeRequest.md +0 -22
- data/docs/ItemPublicTokenExchangeResponse.md +0 -22
- data/docs/ItemRemoveRequest.md +0 -22
- data/docs/ItemRemoveResponse.md +0 -18
- data/docs/ItemStatus.md +0 -22
- data/docs/ItemStatusInvestments.md +0 -20
- data/docs/ItemStatusLastWebhook.md +0 -20
- data/docs/ItemStatusTransactions.md +0 -20
- data/docs/ItemWebhookUpdateRequest.md +0 -24
- data/docs/ItemWebhookUpdateResponse.md +0 -20
- data/docs/JWKPublicKey.md +0 -34
- data/docs/JWTHeader.md +0 -18
- data/docs/LiabilitiesGetRequest.md +0 -24
- data/docs/LiabilitiesGetRequestOptions.md +0 -18
- data/docs/LiabilitiesGetResponse.md +0 -24
- data/docs/LiabilitiesObject.md +0 -22
- data/docs/LiabilityOverride.md +0 -66
- data/docs/LinkTokenAccountFilters.md +0 -24
- data/docs/LinkTokenCreateRequest.md +0 -48
- data/docs/LinkTokenCreateRequestAccountSubtypes.md +0 -24
- data/docs/LinkTokenCreateRequestAccountSubtypesCredit.md +0 -18
- data/docs/LinkTokenCreateRequestAccountSubtypesDepository.md +0 -18
- data/docs/LinkTokenCreateRequestAccountSubtypesInvestment.md +0 -18
- data/docs/LinkTokenCreateRequestAccountSubtypesLoan.md +0 -18
- data/docs/LinkTokenCreateRequestDepositSwitch.md +0 -18
- data/docs/LinkTokenCreateRequestIncomeVerification.md +0 -20
- data/docs/LinkTokenCreateRequestPaymentInitiation.md +0 -18
- data/docs/LinkTokenCreateRequestUser.md +0 -32
- data/docs/LinkTokenCreateResponse.md +0 -22
- data/docs/LinkTokenGetMetadataResponse.md +0 -30
- data/docs/LinkTokenGetRequest.md +0 -22
- data/docs/LinkTokenGetResponse.md +0 -26
- data/docs/LoanFilter.md +0 -18
- data/docs/Location.md +0 -32
- data/docs/MFA.md +0 -26
- data/docs/Meta.md +0 -22
- data/docs/MortgageInterestRate.md +0 -20
- data/docs/MortgageLiability.md +0 -56
- data/docs/MortgagePropertyAddress.md +0 -26
- data/docs/NullableAccessToken.md +0 -15
- data/docs/NullableAddress.md +0 -20
- data/docs/NullableAddressData.md +0 -26
- data/docs/NullableItemStatus.md +0 -22
- data/docs/NullableNumbersACH.md +0 -24
- data/docs/NullableNumbersBACS.md +0 -22
- data/docs/NullableNumbersEFT.md +0 -24
- data/docs/NullableNumbersInternational.md +0 -22
- data/docs/NullableRecipientBACS.md +0 -20
- data/docs/Numbers.md +0 -32
- data/docs/NumbersACH.md +0 -24
- data/docs/NumbersBACS.md +0 -22
- data/docs/NumbersEFT.md +0 -24
- data/docs/NumbersInternational.md +0 -22
- data/docs/OverrideAccounts.md +0 -38
- data/docs/Owner.md +0 -24
- data/docs/OwnerOverride.md +0 -24
- data/docs/PSLFStatus.md +0 -22
- data/docs/PayFrequency.md +0 -20
- data/docs/PayPeriodDetails.md +0 -26
- data/docs/PaymentAmount.md +0 -20
- data/docs/PaymentInitiationAddress.md +0 -24
- data/docs/PaymentInitiationPaymentCreateRequest.md +0 -28
- data/docs/PaymentInitiationPaymentCreateResponse.md +0 -22
- data/docs/PaymentInitiationPaymentGetRequest.md +0 -22
- data/docs/PaymentInitiationPaymentGetResponse.md +0 -34
- data/docs/PaymentInitiationPaymentListRequest.md +0 -24
- data/docs/PaymentInitiationPaymentListResponse.md +0 -22
- data/docs/PaymentInitiationPaymentTokenCreateRequest.md +0 -22
- data/docs/PaymentInitiationPaymentTokenCreateResponse.md +0 -22
- data/docs/PaymentInitiationRecipient.md +0 -26
- data/docs/PaymentInitiationRecipientBacs.md +0 -20
- data/docs/PaymentInitiationRecipientCreateRequest.md +0 -28
- data/docs/PaymentInitiationRecipientCreateResponse.md +0 -20
- data/docs/PaymentInitiationRecipientGetRequest.md +0 -22
- data/docs/PaymentInitiationRecipientGetResponse.md +0 -28
- data/docs/PaymentInitiationRecipientListRequest.md +0 -20
- data/docs/PaymentInitiationRecipientListResponse.md +0 -20
- data/docs/PaymentMeta.md +0 -32
- data/docs/PaymentStatusUpdateWebhook.md +0 -30
- data/docs/Paystub.md +0 -30
- data/docs/PaystubDeduction.md +0 -22
- data/docs/PaystubYTDDetails.md +0 -20
- data/docs/PendingExpirationWebhook.md +0 -24
- data/docs/PhoneNumber.md +0 -22
- data/docs/PlaidApi.md +0 -5580
- data/docs/ProcessorApexProcessorTokenCreateRequest.md +0 -24
- data/docs/ProcessorAuthGetRequest.md +0 -22
- data/docs/ProcessorAuthGetResponse.md +0 -22
- data/docs/ProcessorBalanceGetRequest.md +0 -22
- data/docs/ProcessorBalanceGetResponse.md +0 -20
- data/docs/ProcessorIdentityGetRequest.md +0 -22
- data/docs/ProcessorIdentityGetResponse.md +0 -20
- data/docs/ProcessorNumber.md +0 -24
- data/docs/ProcessorStripeBankAccountTokenCreateRequest.md +0 -24
- data/docs/ProcessorStripeBankAccountTokenCreateResponse.md +0 -20
- data/docs/ProcessorTokenCreateRequest.md +0 -26
- data/docs/ProcessorTokenCreateResponse.md +0 -20
- data/docs/ProductStatus.md +0 -22
- data/docs/ProductStatusBreakdown.md +0 -24
- data/docs/Products.md +0 -15
- data/docs/ProjectedIncomeSummaryFieldNumber.md +0 -20
- data/docs/RecaptchaRequiredError.md +0 -30
- data/docs/RecipientBACS.md +0 -20
- data/docs/SandboxBankTransferSimulateRequest.md +0 -26
- data/docs/SandboxBankTransferSimulateResponse.md +0 -18
- data/docs/SandboxItemFireWebhookRequest.md +0 -24
- data/docs/SandboxItemFireWebhookResponse.md +0 -20
- data/docs/SandboxItemResetLoginRequest.md +0 -22
- data/docs/SandboxItemResetLoginResponse.md +0 -20
- data/docs/SandboxItemSetVerificationStatusRequest.md +0 -26
- data/docs/SandboxItemSetVerificationStatusResponse.md +0 -18
- data/docs/SandboxProcessorTokenCreateRequest.md +0 -24
- data/docs/SandboxProcessorTokenCreateRequestOptions.md +0 -20
- data/docs/SandboxProcessorTokenCreateResponse.md +0 -20
- data/docs/SandboxPublicTokenCreateRequest.md +0 -26
- data/docs/SandboxPublicTokenCreateRequestOptions.md +0 -24
- data/docs/SandboxPublicTokenCreateRequestOptionsTransactions.md +0 -20
- data/docs/SandboxPublicTokenCreateResponse.md +0 -20
- data/docs/Security.md +0 -46
- data/docs/ServicerAddressData.md +0 -26
- data/docs/StandaloneAccountType.md +0 -26
- data/docs/StandaloneCurrencyCodeList.md +0 -20
- data/docs/StandaloneInvestmentTransactionSubtype.md +0 -104
- data/docs/StandaloneInvestmentTransactionType.md +0 -28
- data/docs/StudentLoan.md +0 -66
- data/docs/StudentLoanRepaymentModel.md +0 -22
- data/docs/StudentLoanStatus.md +0 -20
- data/docs/StudentRepaymentPlan.md +0 -20
- data/docs/Transaction.md +0 -54
- data/docs/TransactionCode.md +0 -15
- data/docs/TransactionData.md +0 -26
- data/docs/TransactionOverride.md +0 -26
- data/docs/TransactionsGetRequest.md +0 -28
- data/docs/TransactionsGetRequestOptions.md +0 -22
- data/docs/TransactionsGetResponse.md +0 -26
- data/docs/TransactionsRefreshRequest.md +0 -22
- data/docs/TransactionsRefreshResponse.md +0 -18
- data/docs/TransactionsRemovedWebhook.md +0 -26
- data/docs/UserCustomPassword.md +0 -28
- data/docs/UserPermissionRevokedWebhook.md +0 -24
- data/docs/VerificationExpiredWebhook.md +0 -24
- data/docs/VerificationStatus.md +0 -15
- data/docs/Warning.md +0 -22
- data/docs/WebhookUpdateAcknowledgedWebhook.md +0 -26
- data/docs/WebhookVerificationKeyGetRequest.md +0 -22
- data/docs/WebhookVerificationKeyGetResponse.md +0 -20
- data/docs/YTDGrossIncomeSummaryFieldNumber.md +0 -20
- data/docs/YTDNetIncomeSummaryFieldNumber.md +0 -20
- data/pkg/plaid-14.0.0.beta.2.gem +0 -0
@@ -1,22 +0,0 @@
|
|
1
|
-
# Plaid::AssetReportRefreshRequestOptions
|
2
|
-
|
3
|
-
## Properties
|
4
|
-
|
5
|
-
| Name | Type | Description | Notes |
|
6
|
-
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **client_report_id** | **String** | Client-generated identifier, which can be used by lenders to track loan applications. | [optional] |
|
8
|
-
| **webhook** | **String** | URL to which Plaid will send Assets webhooks, for example when the requested Asset Report is ready. | [optional] |
|
9
|
-
| **user** | [**AssetReportUser**](AssetReportUser.md) | | [optional] |
|
10
|
-
|
11
|
-
## Example
|
12
|
-
|
13
|
-
```ruby
|
14
|
-
require 'plaid'
|
15
|
-
|
16
|
-
instance = Plaid::AssetReportRefreshRequestOptions.new(
|
17
|
-
client_report_id: null,
|
18
|
-
webhook: null,
|
19
|
-
user: null
|
20
|
-
)
|
21
|
-
```
|
22
|
-
|
@@ -1,22 +0,0 @@
|
|
1
|
-
# Plaid::AssetReportRefreshResponse
|
2
|
-
|
3
|
-
## Properties
|
4
|
-
|
5
|
-
| Name | Type | Description | Notes |
|
6
|
-
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **asset_report_id** | **String** | A unique ID identifying an Asset Report. Like all Plaid identifiers, this ID is case sensitive. | |
|
8
|
-
| **asset_report_token** | **String** | A token that can be provided to endpoints such as `/asset_report/get` or `/asset_report/pdf/get` to fetch or update an Asset Report. | |
|
9
|
-
| **request_id** | **String** | A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive. | |
|
10
|
-
|
11
|
-
## Example
|
12
|
-
|
13
|
-
```ruby
|
14
|
-
require 'plaid'
|
15
|
-
|
16
|
-
instance = Plaid::AssetReportRefreshResponse.new(
|
17
|
-
asset_report_id: null,
|
18
|
-
asset_report_token: null,
|
19
|
-
request_id: null
|
20
|
-
)
|
21
|
-
```
|
22
|
-
|
@@ -1,22 +0,0 @@
|
|
1
|
-
# Plaid::AssetReportRemoveRequest
|
2
|
-
|
3
|
-
## Properties
|
4
|
-
|
5
|
-
| Name | Type | Description | Notes |
|
6
|
-
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **client_id** | **String** | Your Plaid API `client_id`. | [optional] |
|
8
|
-
| **secret** | **String** | Your Plaid API `secret`. | [optional] |
|
9
|
-
| **asset_report_token** | **String** | A token that can be provided to endpoints such as `/asset_report/get` or `/asset_report/pdf/get` to fetch or update an Asset Report. | |
|
10
|
-
|
11
|
-
## Example
|
12
|
-
|
13
|
-
```ruby
|
14
|
-
require 'plaid'
|
15
|
-
|
16
|
-
instance = Plaid::AssetReportRemoveRequest.new(
|
17
|
-
client_id: null,
|
18
|
-
secret: null,
|
19
|
-
asset_report_token: null
|
20
|
-
)
|
21
|
-
```
|
22
|
-
|
@@ -1,20 +0,0 @@
|
|
1
|
-
# Plaid::AssetReportRemoveResponse
|
2
|
-
|
3
|
-
## Properties
|
4
|
-
|
5
|
-
| Name | Type | Description | Notes |
|
6
|
-
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **removed** | **Boolean** | `true` if the Asset Report was successfully removed. | |
|
8
|
-
| **request_id** | **String** | A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive. | |
|
9
|
-
|
10
|
-
## Example
|
11
|
-
|
12
|
-
```ruby
|
13
|
-
require 'plaid'
|
14
|
-
|
15
|
-
instance = Plaid::AssetReportRemoveResponse.new(
|
16
|
-
removed: null,
|
17
|
-
request_id: null
|
18
|
-
)
|
19
|
-
```
|
20
|
-
|
@@ -1,58 +0,0 @@
|
|
1
|
-
# Plaid::AssetReportTransaction
|
2
|
-
|
3
|
-
## Properties
|
4
|
-
|
5
|
-
| Name | Type | Description | Notes |
|
6
|
-
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **transaction_type** | **String** | Please use the `payment_channel` field, `transaction_type` will be deprecated in the future. `digital:` transactions that took place online. `place:` transactions that were made at a physical location. `special:` transactions that relate to banks, e.g. fees or deposits. `unresolved:` transactions that do not fit into the other three types. | [optional] |
|
8
|
-
| **transaction_id** | **String** | The unique ID of the transaction. Like all Plaid identifiers, the `transaction_id` is case sensitive. | |
|
9
|
-
| **account_owner** | **String** | The name of the account owner. This field is not typically populated and only relevant when dealing with sub-accounts. | [optional] |
|
10
|
-
| **pending_transaction_id** | **String** | The ID of a posted transaction's associated pending transaction, where applicable. | [optional] |
|
11
|
-
| **pending** | **Boolean** | When `true`, identifies the transaction as pending or unsettled. Pending transaction details (name, type, amount, category ID) may change before they are settled. | |
|
12
|
-
| **payment_channel** | **String** | The channel used to make a payment. `online:` transactions that took place online. `in store:` transactions that were made at a physical location. `other:` transactions that relate to banks, e.g. fees or deposits. This field replaces the `transaction_type` field. | [optional] |
|
13
|
-
| **payment_meta** | [**PaymentMeta**](PaymentMeta.md) | | [optional] |
|
14
|
-
| **name** | **String** | The merchant name or transaction description. If the `transaction` object was returned by a Transactions endpoint such as `/transactions/get`, this field will always appear. If the `transaction` object was returned by an Assets endpoint such as `/asset_report/get/` or `/asset_report/pdf/get`, this field will only appear in an Asset Report with Insights. | [optional] |
|
15
|
-
| **merchant_name** | **String** | The merchant name, as extracted by Plaid from the `name` field. | [optional] |
|
16
|
-
| **location** | [**Location**](Location.md) | | [optional] |
|
17
|
-
| **authorized_date** | **String** | The date that the transaction was authorized. Dates are returned in an ISO 8601 format ( `YYYY-MM-DD` ). | [optional] |
|
18
|
-
| **date** | **String** | For pending transactions, the date that the transaction occurred; for posted transactions, the date that the transaction posted. Both dates are returned in an ISO 8601 format ( `YYYY-MM-DD` ). | |
|
19
|
-
| **category_id** | **String** | The ID of the category to which this transaction belongs. See [Categories](https://plaid.com/docs/#category-overview). If the `transaction` object was returned by an Assets endpoint such as `/asset_report/get/` or `/asset_report/pdf/get`, this field will only appear in an Asset Report with Insights. | [optional] |
|
20
|
-
| **category** | **Array<String>** | A hierarchical array of the categories to which this transaction belongs. See [Categories](https://plaid.com/docs/#category-overview). If the `transaction` object was returned by an Assets endpoint such as `/asset_report/get/` or `/asset_report/pdf/get`, this field will only appear in an Asset Report with Insights. | [optional] |
|
21
|
-
| **unofficial_currency_code** | **String** | The unofficial currency code associated with the transaction. Always `null` if `iso_currency_code` is non-`null`. Unofficial currency codes are used for currencies that do not have official ISO currency codes, such as cryptocurrencies and the currencies of certain countries. See the [currency code schema](/docs/api/accounts#currency-code-schema) for a full listing of supported `iso_currency_code`s. | [optional] |
|
22
|
-
| **iso_currency_code** | **String** | The ISO-4217 currency code of the transaction. Always `null` if `unofficial_currency_code` is non-null. | [optional] |
|
23
|
-
| **amount** | **Float** | The settled value of the transaction, denominated in the account's currency, as stated in `iso_currency_code` or `unofficial_currency_code`. Positive values when money moves out of the account; negative values when money moves in. For example, debit card purchases are positive; credit card payments, direct deposits, and refunds are negative. | |
|
24
|
-
| **account_id** | **String** | The ID of the account in which this transaction occurred. | |
|
25
|
-
| **transaction_code** | [**TransactionCode**](TransactionCode.md) | | [optional] |
|
26
|
-
| **date_transacted** | **String** | The date on which the transaction took place, in IS0 8601 format. | [optional] |
|
27
|
-
| **original_description** | **String** | The string returned by the financial institution to describe the transaction | |
|
28
|
-
|
29
|
-
## Example
|
30
|
-
|
31
|
-
```ruby
|
32
|
-
require 'plaid'
|
33
|
-
|
34
|
-
instance = Plaid::AssetReportTransaction.new(
|
35
|
-
transaction_type: null,
|
36
|
-
transaction_id: null,
|
37
|
-
account_owner: null,
|
38
|
-
pending_transaction_id: null,
|
39
|
-
pending: null,
|
40
|
-
payment_channel: null,
|
41
|
-
payment_meta: null,
|
42
|
-
name: null,
|
43
|
-
merchant_name: null,
|
44
|
-
location: null,
|
45
|
-
authorized_date: null,
|
46
|
-
date: null,
|
47
|
-
category_id: null,
|
48
|
-
category: null,
|
49
|
-
unofficial_currency_code: null,
|
50
|
-
iso_currency_code: null,
|
51
|
-
amount: null,
|
52
|
-
account_id: null,
|
53
|
-
transaction_code: null,
|
54
|
-
date_transacted: null,
|
55
|
-
original_description: null
|
56
|
-
)
|
57
|
-
```
|
58
|
-
|
@@ -1,20 +0,0 @@
|
|
1
|
-
# Plaid::AssetReportTransactionAllOf
|
2
|
-
|
3
|
-
## Properties
|
4
|
-
|
5
|
-
| Name | Type | Description | Notes |
|
6
|
-
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **date_transacted** | **String** | The date on which the transaction took place, in IS0 8601 format. | [optional] |
|
8
|
-
| **original_description** | **String** | The string returned by the financial institution to describe the transaction | |
|
9
|
-
|
10
|
-
## Example
|
11
|
-
|
12
|
-
```ruby
|
13
|
-
require 'plaid'
|
14
|
-
|
15
|
-
instance = Plaid::AssetReportTransactionAllOf.new(
|
16
|
-
date_transacted: null,
|
17
|
-
original_description: null
|
18
|
-
)
|
19
|
-
```
|
20
|
-
|
data/docs/AssetReportUser.md
DELETED
@@ -1,30 +0,0 @@
|
|
1
|
-
# Plaid::AssetReportUser
|
2
|
-
|
3
|
-
## Properties
|
4
|
-
|
5
|
-
| Name | Type | Description | Notes |
|
6
|
-
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **client_user_id** | **String** | An identifier you determine and submit for the user. | [optional] |
|
8
|
-
| **first_name** | **String** | The user's first name. Required for the Fannie Mae Day 1 Certainty™ program. | [optional] |
|
9
|
-
| **middle_name** | **String** | The user's middle name | [optional] |
|
10
|
-
| **last_name** | **String** | The user's last name. Required for the Fannie Mae Day 1 Certainty™ program. | [optional] |
|
11
|
-
| **ssn** | **String** | The user's Social Security Number. Required for the Fannie Mae Day 1 Certainty™ program. Format: \"ddd-dd-dddd\" | [optional] |
|
12
|
-
| **phone_number** | **String** | The user's phone number, in E.164 format: +{countrycode}{number}. For example: \"+14151234567\" | [optional] |
|
13
|
-
| **email** | **String** | The user's email address. | [optional] |
|
14
|
-
|
15
|
-
## Example
|
16
|
-
|
17
|
-
```ruby
|
18
|
-
require 'plaid'
|
19
|
-
|
20
|
-
instance = Plaid::AssetReportUser.new(
|
21
|
-
client_user_id: null,
|
22
|
-
first_name: null,
|
23
|
-
middle_name: null,
|
24
|
-
last_name: null,
|
25
|
-
ssn: null,
|
26
|
-
phone_number: null,
|
27
|
-
email: null
|
28
|
-
)
|
29
|
-
```
|
30
|
-
|
data/docs/AssetsErrorWebhook.md
DELETED
@@ -1,24 +0,0 @@
|
|
1
|
-
# Plaid::AssetsErrorWebhook
|
2
|
-
|
3
|
-
## Properties
|
4
|
-
|
5
|
-
| Name | Type | Description | Notes |
|
6
|
-
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **webhook_type** | **String** | `ASSETS` | |
|
8
|
-
| **webhook_code** | **String** | `ERROR` | |
|
9
|
-
| **error** | [**Error**](Error.md) | | |
|
10
|
-
| **asset_report_id** | **String** | The ID associated with the Asset Report. | |
|
11
|
-
|
12
|
-
## Example
|
13
|
-
|
14
|
-
```ruby
|
15
|
-
require 'plaid'
|
16
|
-
|
17
|
-
instance = Plaid::AssetsErrorWebhook.new(
|
18
|
-
webhook_type: null,
|
19
|
-
webhook_code: null,
|
20
|
-
error: null,
|
21
|
-
asset_report_id: null
|
22
|
-
)
|
23
|
-
```
|
24
|
-
|
@@ -1,22 +0,0 @@
|
|
1
|
-
# Plaid::AssetsProductReadyWebhook
|
2
|
-
|
3
|
-
## Properties
|
4
|
-
|
5
|
-
| Name | Type | Description | Notes |
|
6
|
-
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **webhook_type** | **String** | `ASSETS` | |
|
8
|
-
| **webhook_code** | **String** | `PRODUCT_READY` | |
|
9
|
-
| **asset_report_id** | **String** | The `asset_report_id` that can be provided to `/asset_report/get` to retrieve the Asset Report. | |
|
10
|
-
|
11
|
-
## Example
|
12
|
-
|
13
|
-
```ruby
|
14
|
-
require 'plaid'
|
15
|
-
|
16
|
-
instance = Plaid::AssetsProductReadyWebhook.new(
|
17
|
-
webhook_type: null,
|
18
|
-
webhook_code: null,
|
19
|
-
asset_report_id: null
|
20
|
-
)
|
21
|
-
```
|
22
|
-
|
data/docs/AuthGetNumbers.md
DELETED
@@ -1,24 +0,0 @@
|
|
1
|
-
# Plaid::AuthGetNumbers
|
2
|
-
|
3
|
-
## Properties
|
4
|
-
|
5
|
-
| Name | Type | Description | Notes |
|
6
|
-
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **ach** | [**Array<NumbersACH>**](NumbersACH.md) | An array of ACH numbers identifying accounts. | [optional] |
|
8
|
-
| **eft** | [**Array<NumbersEFT>**](NumbersEFT.md) | An array of EFT numbers identifying accounts. | [optional] |
|
9
|
-
| **international** | [**Array<NumbersInternational>**](NumbersInternational.md) | An array of IBAN numbers identifying accounts. | [optional] |
|
10
|
-
| **bacs** | [**Array<NumbersBACS>**](NumbersBACS.md) | An array of BACS numbers identifying accounts. | [optional] |
|
11
|
-
|
12
|
-
## Example
|
13
|
-
|
14
|
-
```ruby
|
15
|
-
require 'plaid'
|
16
|
-
|
17
|
-
instance = Plaid::AuthGetNumbers.new(
|
18
|
-
ach: null,
|
19
|
-
eft: null,
|
20
|
-
international: null,
|
21
|
-
bacs: null
|
22
|
-
)
|
23
|
-
```
|
24
|
-
|
data/docs/AuthGetRequest.md
DELETED
@@ -1,24 +0,0 @@
|
|
1
|
-
# Plaid::AuthGetRequest
|
2
|
-
|
3
|
-
## Properties
|
4
|
-
|
5
|
-
| Name | Type | Description | Notes |
|
6
|
-
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **client_id** | **String** | Your Plaid API `client_id`. | [optional] |
|
8
|
-
| **secret** | **String** | Your Plaid API `secret`. | [optional] |
|
9
|
-
| **access_token** | **String** | The access token associated with the Item data is being requested for. | |
|
10
|
-
| **options** | [**AuthGetRequestOptions**](AuthGetRequestOptions.md) | | [optional] |
|
11
|
-
|
12
|
-
## Example
|
13
|
-
|
14
|
-
```ruby
|
15
|
-
require 'plaid'
|
16
|
-
|
17
|
-
instance = Plaid::AuthGetRequest.new(
|
18
|
-
client_id: null,
|
19
|
-
secret: null,
|
20
|
-
access_token: null,
|
21
|
-
options: null
|
22
|
-
)
|
23
|
-
```
|
24
|
-
|
@@ -1,18 +0,0 @@
|
|
1
|
-
# Plaid::AuthGetRequestOptions
|
2
|
-
|
3
|
-
## Properties
|
4
|
-
|
5
|
-
| Name | Type | Description | Notes |
|
6
|
-
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **account_ids** | **Array<String>** | A list of `account_ids` to retrieve for the Item. Note: An error will be returned if a provided `account_id` is not associated with the Item. | [optional] |
|
8
|
-
|
9
|
-
## Example
|
10
|
-
|
11
|
-
```ruby
|
12
|
-
require 'plaid'
|
13
|
-
|
14
|
-
instance = Plaid::AuthGetRequestOptions.new(
|
15
|
-
account_ids: null
|
16
|
-
)
|
17
|
-
```
|
18
|
-
|
data/docs/AuthGetResponse.md
DELETED
@@ -1,24 +0,0 @@
|
|
1
|
-
# Plaid::AuthGetResponse
|
2
|
-
|
3
|
-
## Properties
|
4
|
-
|
5
|
-
| Name | Type | Description | Notes |
|
6
|
-
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **accounts** | [**Array<AccountBase>**](AccountBase.md) | The `accounts` for which numbers are being retrieved. | |
|
8
|
-
| **numbers** | [**AuthGetNumbers**](AuthGetNumbers.md) | | |
|
9
|
-
| **item** | [**Item**](Item.md) | | |
|
10
|
-
| **request_id** | **String** | A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive. | |
|
11
|
-
|
12
|
-
## Example
|
13
|
-
|
14
|
-
```ruby
|
15
|
-
require 'plaid'
|
16
|
-
|
17
|
-
instance = Plaid::AuthGetResponse.new(
|
18
|
-
accounts: null,
|
19
|
-
numbers: null,
|
20
|
-
item: null,
|
21
|
-
request_id: null
|
22
|
-
)
|
23
|
-
```
|
24
|
-
|
@@ -1,24 +0,0 @@
|
|
1
|
-
# Plaid::AutomaticallyVerifiedWebhook
|
2
|
-
|
3
|
-
## Properties
|
4
|
-
|
5
|
-
| Name | Type | Description | Notes |
|
6
|
-
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **webhook_type** | **String** | `AUTH` | |
|
8
|
-
| **webhook_code** | **String** | `AUTOMATICALLY_VERIFIED` | |
|
9
|
-
| **account_id** | **String** | The `account_id` of the account associated with the webhook | |
|
10
|
-
| **item_id** | **String** | The `item_id` of the Item associated with this webhook, warning, or error | |
|
11
|
-
|
12
|
-
## Example
|
13
|
-
|
14
|
-
```ruby
|
15
|
-
require 'plaid'
|
16
|
-
|
17
|
-
instance = Plaid::AutomaticallyVerifiedWebhook.new(
|
18
|
-
webhook_type: null,
|
19
|
-
webhook_code: null,
|
20
|
-
account_id: null,
|
21
|
-
item_id: null
|
22
|
-
)
|
23
|
-
```
|
24
|
-
|
data/docs/BankTransfer.md
DELETED
@@ -1,50 +0,0 @@
|
|
1
|
-
# Plaid::BankTransfer
|
2
|
-
|
3
|
-
## Properties
|
4
|
-
|
5
|
-
| Name | Type | Description | Notes |
|
6
|
-
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **id** | **String** | Plaid’s unique identifier for a bank transfer. | |
|
8
|
-
| **ach_class** | [**ACHClass**](ACHClass.md) | | |
|
9
|
-
| **account_id** | **String** | The account ID that should be credited/debited for this bank transfer. | |
|
10
|
-
| **type** | [**BankTransferType**](BankTransferType.md) | | |
|
11
|
-
| **user** | [**BankTransferUser**](BankTransferUser.md) | | |
|
12
|
-
| **amount** | **String** | The amount of the transfer (decimal string with two digits of precision e.g. “10.00”). | |
|
13
|
-
| **iso_currency_code** | **String** | The currency of the transfer amount, e.g. \"USD\" | |
|
14
|
-
| **description** | **String** | The description of the transfer. | |
|
15
|
-
| **created** | **String** | The datetime when this bank transfer was created. This will be of the form `2006-01-02T15:04:05Z` | |
|
16
|
-
| **status** | [**BankTransferStatus**](BankTransferStatus.md) | | |
|
17
|
-
| **network** | [**BankTransferNetwork**](BankTransferNetwork.md) | | |
|
18
|
-
| **cancellable** | **Boolean** | When `true`, you can still cancel this bank transfer. | |
|
19
|
-
| **failure_reason** | [**BankTransferFailure**](BankTransferFailure.md) | | [optional] |
|
20
|
-
| **custom_tag** | **String** | A string containing the custom tag provided by the client in the create request. Will be null if not provided. | [optional] |
|
21
|
-
| **metadata** | **Hash<String, String>** | The Metadata object is a mapping of client-provided string fields to any string value. The following limitations apply: - The JSON values must be Strings (no nested JSON objects allowed) - Only ASCII characters may be used - Maximum of 50 key/value pairs - Maximum key length of 40 characters - Maximum value length of 500 characters | |
|
22
|
-
| **origination_account_id** | **String** | Plaid’s unique identifier for the origination account that was used for this transfer. | |
|
23
|
-
| **direction** | [**BankTransferDirection**](BankTransferDirection.md) | | |
|
24
|
-
|
25
|
-
## Example
|
26
|
-
|
27
|
-
```ruby
|
28
|
-
require 'plaid'
|
29
|
-
|
30
|
-
instance = Plaid::BankTransfer.new(
|
31
|
-
id: null,
|
32
|
-
ach_class: null,
|
33
|
-
account_id: null,
|
34
|
-
type: null,
|
35
|
-
user: null,
|
36
|
-
amount: null,
|
37
|
-
iso_currency_code: null,
|
38
|
-
description: null,
|
39
|
-
created: null,
|
40
|
-
status: null,
|
41
|
-
network: null,
|
42
|
-
cancellable: null,
|
43
|
-
failure_reason: null,
|
44
|
-
custom_tag: null,
|
45
|
-
metadata: null,
|
46
|
-
origination_account_id: null,
|
47
|
-
direction: null
|
48
|
-
)
|
49
|
-
```
|
50
|
-
|
data/docs/BankTransferBalance.md
DELETED
@@ -1,20 +0,0 @@
|
|
1
|
-
# Plaid::BankTransferBalance
|
2
|
-
|
3
|
-
## Properties
|
4
|
-
|
5
|
-
| Name | Type | Description | Notes |
|
6
|
-
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **available** | **String** | The total available balance - the sum of all successful debit transfer amounts minus all credit transfer amounts. | |
|
8
|
-
| **transactable** | **String** | The transactable balance shows the amount in your account that you are able to use for transfers, and is essentially your available balance minus your minimum balance. | |
|
9
|
-
|
10
|
-
## Example
|
11
|
-
|
12
|
-
```ruby
|
13
|
-
require 'plaid'
|
14
|
-
|
15
|
-
instance = Plaid::BankTransferBalance.new(
|
16
|
-
available: null,
|
17
|
-
transactable: null
|
18
|
-
)
|
19
|
-
```
|
20
|
-
|
@@ -1,22 +0,0 @@
|
|
1
|
-
# Plaid::BankTransferBalanceGetRequest
|
2
|
-
|
3
|
-
## Properties
|
4
|
-
|
5
|
-
| Name | Type | Description | Notes |
|
6
|
-
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **client_id** | **String** | Your Plaid API `client_id`. | [optional] |
|
8
|
-
| **secret** | **String** | Your Plaid API `secret`. | [optional] |
|
9
|
-
| **origination_account_id** | **String** | If multiple origination accounts are available, `origination_account_id` must be used to specify the account for which balance will be returned. | [optional] |
|
10
|
-
|
11
|
-
## Example
|
12
|
-
|
13
|
-
```ruby
|
14
|
-
require 'plaid'
|
15
|
-
|
16
|
-
instance = Plaid::BankTransferBalanceGetRequest.new(
|
17
|
-
client_id: null,
|
18
|
-
secret: null,
|
19
|
-
origination_account_id: null
|
20
|
-
)
|
21
|
-
```
|
22
|
-
|
@@ -1,22 +0,0 @@
|
|
1
|
-
# Plaid::BankTransferBalanceGetResponse
|
2
|
-
|
3
|
-
## Properties
|
4
|
-
|
5
|
-
| Name | Type | Description | Notes |
|
6
|
-
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **balance** | [**BankTransferBalance**](BankTransferBalance.md) | | |
|
8
|
-
| **origination_account_id** | **String** | The ID of the origination account that this balance belongs to. | [optional] |
|
9
|
-
| **request_id** | **String** | A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive. | |
|
10
|
-
|
11
|
-
## Example
|
12
|
-
|
13
|
-
```ruby
|
14
|
-
require 'plaid'
|
15
|
-
|
16
|
-
instance = Plaid::BankTransferBalanceGetResponse.new(
|
17
|
-
balance: null,
|
18
|
-
origination_account_id: null,
|
19
|
-
request_id: null
|
20
|
-
)
|
21
|
-
```
|
22
|
-
|
@@ -1,22 +0,0 @@
|
|
1
|
-
# Plaid::BankTransferCancelRequest
|
2
|
-
|
3
|
-
## Properties
|
4
|
-
|
5
|
-
| Name | Type | Description | Notes |
|
6
|
-
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **client_id** | **String** | Your Plaid API `client_id`. | [optional] |
|
8
|
-
| **secret** | **String** | Your Plaid API `secret`. | [optional] |
|
9
|
-
| **bank_transfer_id** | **String** | Plaid’s unique identifier for a bank transfer. | |
|
10
|
-
|
11
|
-
## Example
|
12
|
-
|
13
|
-
```ruby
|
14
|
-
require 'plaid'
|
15
|
-
|
16
|
-
instance = Plaid::BankTransferCancelRequest.new(
|
17
|
-
client_id: null,
|
18
|
-
secret: null,
|
19
|
-
bank_transfer_id: null
|
20
|
-
)
|
21
|
-
```
|
22
|
-
|
@@ -1,18 +0,0 @@
|
|
1
|
-
# Plaid::BankTransferCancelResponse
|
2
|
-
|
3
|
-
## Properties
|
4
|
-
|
5
|
-
| Name | Type | Description | Notes |
|
6
|
-
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **request_id** | **String** | A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive. | |
|
8
|
-
|
9
|
-
## Example
|
10
|
-
|
11
|
-
```ruby
|
12
|
-
require 'plaid'
|
13
|
-
|
14
|
-
instance = Plaid::BankTransferCancelResponse.new(
|
15
|
-
request_id: null
|
16
|
-
)
|
17
|
-
```
|
18
|
-
|
@@ -1,46 +0,0 @@
|
|
1
|
-
# Plaid::BankTransferCreateRequest
|
2
|
-
|
3
|
-
## Properties
|
4
|
-
|
5
|
-
| Name | Type | Description | Notes |
|
6
|
-
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **client_id** | **String** | Your Plaid API `client_id`. | [optional] |
|
8
|
-
| **secret** | **String** | Your Plaid API `secret`. | [optional] |
|
9
|
-
| **idempotency_key** | **String** | A random key provided by the client, per unique bank transfer. Maximum of 50 characters. The API supports idempotency for safely retrying requests without accidentally performing the same operation twice. For example, if a request to create a bank transfer fails due to a network connection error, you can retry the request with the same idempotency key to guarantee that only a single bank transfer is created. | |
|
10
|
-
| **access_token** | **String** | The Plaid `access_token` for the account that will be debited or credited. | |
|
11
|
-
| **account_id** | **String** | The Plaid `account_id` for the account that will be debited or credited. | |
|
12
|
-
| **type** | [**BankTransferType**](BankTransferType.md) | | |
|
13
|
-
| **network** | [**BankTransferNetwork**](BankTransferNetwork.md) | | |
|
14
|
-
| **amount** | **String** | The transfer amount (decimal string with two digits of precision e.g. \"10.00\"). | |
|
15
|
-
| **iso_currency_code** | **String** | The currency of the transfer amount – should be set to \"USD\". | |
|
16
|
-
| **description** | **String** | The transfer description. Maximum of 10 characters. | |
|
17
|
-
| **ach_class** | [**ACHClass**](ACHClass.md) | | [optional] |
|
18
|
-
| **user** | [**BankTransferUser**](BankTransferUser.md) | | |
|
19
|
-
| **custom_tag** | **String** | An arbitrary string provided by the client for storage with the bank transfer. Will be returned in all `BankTransfer` objects. May be up to 100 characters. | [optional] |
|
20
|
-
| **metadata** | **Hash<String, String>** | The Metadata object is a mapping of client-provided string fields to any string value. The following limitations apply: - The JSON values must be Strings (no nested JSON objects allowed) - Only ASCII characters may be used - Maximum of 50 key/value pairs - Maximum key length of 40 characters - Maximum value length of 500 characters | [optional] |
|
21
|
-
| **origination_account_id** | **String** | Plaid’s unique identifier for the origination account for this transfer. If you have more than one origination account, this value must be specified. | [optional] |
|
22
|
-
|
23
|
-
## Example
|
24
|
-
|
25
|
-
```ruby
|
26
|
-
require 'plaid'
|
27
|
-
|
28
|
-
instance = Plaid::BankTransferCreateRequest.new(
|
29
|
-
client_id: null,
|
30
|
-
secret: null,
|
31
|
-
idempotency_key: null,
|
32
|
-
access_token: null,
|
33
|
-
account_id: null,
|
34
|
-
type: null,
|
35
|
-
network: null,
|
36
|
-
amount: null,
|
37
|
-
iso_currency_code: null,
|
38
|
-
description: null,
|
39
|
-
ach_class: null,
|
40
|
-
user: null,
|
41
|
-
custom_tag: null,
|
42
|
-
metadata: null,
|
43
|
-
origination_account_id: null
|
44
|
-
)
|
45
|
-
```
|
46
|
-
|
@@ -1,20 +0,0 @@
|
|
1
|
-
# Plaid::BankTransferCreateResponse
|
2
|
-
|
3
|
-
## Properties
|
4
|
-
|
5
|
-
| Name | Type | Description | Notes |
|
6
|
-
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **bank_transfer** | [**BankTransfer**](BankTransfer.md) | | |
|
8
|
-
| **request_id** | **String** | A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive. | |
|
9
|
-
|
10
|
-
## Example
|
11
|
-
|
12
|
-
```ruby
|
13
|
-
require 'plaid'
|
14
|
-
|
15
|
-
instance = Plaid::BankTransferCreateResponse.new(
|
16
|
-
bank_transfer: null,
|
17
|
-
request_id: null
|
18
|
-
)
|
19
|
-
```
|
20
|
-
|
data/docs/BankTransferEvent.md
DELETED
@@ -1,40 +0,0 @@
|
|
1
|
-
# Plaid::BankTransferEvent
|
2
|
-
|
3
|
-
## Properties
|
4
|
-
|
5
|
-
| Name | Type | Description | Notes |
|
6
|
-
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **event_id** | **Integer** | Plaid’s unique identifier for this event. IDs are sequential unsigned 64-bit integers. | |
|
8
|
-
| **timestamp** | **String** | The datetime when this event occurred. This will be of the form `2006-01-02T15:04:05Z`. | |
|
9
|
-
| **event_type** | [**BankTransferEventType**](BankTransferEventType.md) | | |
|
10
|
-
| **account_id** | **String** | The account ID associated with the bank transfer. | |
|
11
|
-
| **bank_transfer_id** | **String** | Plaid’s unique identifier for a bank transfer. | |
|
12
|
-
| **origination_account_id** | **String** | The ID of the origination account that this balance belongs to. | [optional] |
|
13
|
-
| **bank_transfer_type** | [**BankTransferType**](BankTransferType.md) | | |
|
14
|
-
| **bank_transfer_amount** | **String** | The bank transfer amount. | |
|
15
|
-
| **bank_transfer_iso_currency_code** | **String** | The currency of the bank transfer amount. | |
|
16
|
-
| **failure_reason** | [**BankTransferFailure**](BankTransferFailure.md) | | |
|
17
|
-
| **direction** | [**BankTransferDirection**](BankTransferDirection.md) | | |
|
18
|
-
| **receiver_details** | [**BankTransferReceiverDetails**](BankTransferReceiverDetails.md) | | |
|
19
|
-
|
20
|
-
## Example
|
21
|
-
|
22
|
-
```ruby
|
23
|
-
require 'plaid'
|
24
|
-
|
25
|
-
instance = Plaid::BankTransferEvent.new(
|
26
|
-
event_id: null,
|
27
|
-
timestamp: null,
|
28
|
-
event_type: null,
|
29
|
-
account_id: null,
|
30
|
-
bank_transfer_id: null,
|
31
|
-
origination_account_id: null,
|
32
|
-
bank_transfer_type: null,
|
33
|
-
bank_transfer_amount: null,
|
34
|
-
bank_transfer_iso_currency_code: null,
|
35
|
-
failure_reason: null,
|
36
|
-
direction: null,
|
37
|
-
receiver_details: null
|
38
|
-
)
|
39
|
-
```
|
40
|
-
|