plaid 17.1.0 → 17.3.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 +250 -0
- data/Gemfile.lock +2 -2
- data/Makefile +1 -1
- data/lib/plaid/api/plaid_api.rb +442 -52
- data/lib/plaid/api_client.rb +11 -4
- data/lib/plaid/api_error.rb +1 -1
- data/lib/plaid/configuration.rb +1 -1
- data/lib/plaid/models/account_access.rb +1 -1
- data/lib/plaid/models/account_assets.rb +1 -1
- data/lib/plaid/models/account_assets_all_of.rb +1 -1
- data/lib/plaid/models/account_balance.rb +1 -1
- data/lib/plaid/models/account_base.rb +1 -1
- 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 +1 -1
- data/lib/plaid/models/account_identity_all_of.rb +1 -1
- data/lib/plaid/models/account_identity_match_score.rb +1 -1
- data/lib/plaid/models/account_identity_match_score_all_of.rb +1 -1
- data/lib/plaid/models/account_product_access.rb +1 -1
- data/lib/plaid/models/account_product_access_nullable.rb +1 -1
- data/lib/plaid/models/account_selection_cardinality.rb +1 -1
- data/lib/plaid/models/account_subtype.rb +1 -1
- data/lib/plaid/models/account_type.rb +1 -1
- data/lib/plaid/models/accounts_balance_get_request.rb +1 -1
- data/lib/plaid/models/accounts_balance_get_request_options.rb +1 -1
- 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 +1 -1
- data/lib/plaid/models/{transaction_frequency.rb → action_state.rb} +7 -6
- data/lib/plaid/models/activity.rb +303 -0
- data/lib/plaid/models/activity_type.rb +47 -0
- 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_match_score.rb +1 -1
- data/lib/plaid/models/address_nullable.rb +1 -1
- data/lib/plaid/models/address_purpose_label.rb +1 -1
- data/lib/plaid/models/application.rb +1 -1
- 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.rb +2 -2
- data/lib/plaid/models/asset_detail.rb +3 -3
- data/lib/plaid/models/asset_holder.rb +2 -2
- data/lib/plaid/models/asset_holder_name.rb +2 -2
- data/lib/plaid/models/asset_owner.rb +2 -2
- data/lib/plaid/models/asset_owners.rb +2 -2
- data/lib/plaid/models/asset_report.rb +1 -1
- 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 +14 -5
- 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_freddie.rb +1 -1
- data/lib/plaid/models/asset_report_freddie_get_request.rb +2 -2
- data/lib/plaid/models/asset_report_freddie_get_response.rb +1 -1
- data/lib/plaid/models/asset_report_get_request.rb +1 -1
- data/lib/plaid/models/asset_report_get_request_options.rb +1 -1
- data/lib/plaid/models/asset_report_get_response.rb +1 -1
- data/lib/plaid/models/asset_report_item.rb +1 -1
- data/lib/plaid/models/asset_report_pdf_get_request.rb +1 -1
- data/lib/plaid/models/asset_report_pdf_get_request_options.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 +24 -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/asset_transaction.rb +2 -2
- data/lib/plaid/models/asset_transaction_category_type.rb +1 -1
- data/lib/plaid/models/asset_transaction_description.rb +2 -2
- data/lib/plaid/models/asset_transaction_detail.rb +4 -4
- data/lib/plaid/models/asset_transaction_type.rb +1 -1
- data/lib/plaid/models/asset_transactions.rb +2 -2
- data/lib/plaid/models/asset_type.rb +1 -1
- data/lib/plaid/models/assets.rb +3 -3
- 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 +1 -1
- data/lib/plaid/models/auth_supported_methods.rb +1 -1
- 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 +1 -1
- data/lib/plaid/models/bank_transfer_balance.rb +1 -1
- data/lib/plaid/models/bank_transfer_balance_get_request.rb +1 -1
- data/lib/plaid/models/bank_transfer_balance_get_response.rb +1 -1
- data/lib/plaid/models/bank_transfer_cancel_request.rb +1 -1
- data/lib/plaid/models/bank_transfer_cancel_response.rb +1 -1
- data/lib/plaid/models/bank_transfer_create_request.rb +1 -1
- data/lib/plaid/models/bank_transfer_create_response.rb +1 -1
- data/lib/plaid/models/bank_transfer_direction.rb +1 -1
- data/lib/plaid/models/bank_transfer_event.rb +1 -1
- data/lib/plaid/models/bank_transfer_event_list_bank_transfer_type.rb +1 -1
- data/lib/plaid/models/bank_transfer_event_list_direction.rb +1 -1
- data/lib/plaid/models/bank_transfer_event_list_request.rb +1 -1
- data/lib/plaid/models/bank_transfer_event_list_response.rb +1 -1
- data/lib/plaid/models/bank_transfer_event_sync_request.rb +1 -1
- data/lib/plaid/models/bank_transfer_event_sync_response.rb +1 -1
- data/lib/plaid/models/bank_transfer_event_type.rb +1 -1
- data/lib/plaid/models/bank_transfer_failure.rb +1 -1
- data/lib/plaid/models/bank_transfer_get_request.rb +1 -1
- data/lib/plaid/models/bank_transfer_get_response.rb +1 -1
- data/lib/plaid/models/bank_transfer_list_request.rb +1 -1
- data/lib/plaid/models/bank_transfer_list_response.rb +1 -1
- data/lib/plaid/models/bank_transfer_migrate_account_request.rb +1 -1
- data/lib/plaid/models/bank_transfer_migrate_account_response.rb +1 -1
- data/lib/plaid/models/bank_transfer_network.rb +1 -1
- data/lib/plaid/models/bank_transfer_status.rb +1 -1
- data/lib/plaid/models/bank_transfer_sweep.rb +1 -1
- data/lib/plaid/models/bank_transfer_sweep_get_request.rb +1 -1
- data/lib/plaid/models/bank_transfer_sweep_get_response.rb +1 -1
- data/lib/plaid/models/bank_transfer_sweep_list_request.rb +1 -1
- data/lib/plaid/models/bank_transfer_sweep_list_response.rb +1 -1
- data/lib/plaid/models/bank_transfer_type.rb +1 -1
- data/lib/plaid/models/bank_transfer_user.rb +1 -1
- data/lib/plaid/models/bank_transfers_events_update_webhook.rb +1 -1
- data/lib/plaid/models/bank_transfers_events_update_webhook_for_auth.rb +254 -0
- 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/cause_all_of.rb +1 -1
- data/lib/plaid/models/client_provided_enhanced_transaction.rb +1 -1
- data/lib/plaid/models/client_provided_enriched_transaction.rb +2 -2
- data/lib/plaid/models/client_provided_raw_transaction.rb +2 -2
- data/lib/plaid/models/client_provided_transaction.rb +40 -6
- data/lib/plaid/models/client_provided_transaction_location.rb +260 -0
- data/lib/plaid/models/connected_application.rb +1 -1
- data/lib/plaid/models/counterparty.rb +27 -5
- data/lib/plaid/models/counterparty_type.rb +3 -2
- data/lib/plaid/models/country_code.rb +1 -1
- data/lib/plaid/models/credit1099.rb +1 -1
- data/lib/plaid/models/credit1099_filer.rb +1 -1
- data/lib/plaid/models/credit1099_payer.rb +1 -1
- data/lib/plaid/models/credit1099_recipient.rb +1 -1
- data/lib/plaid/models/credit_account_subtype.rb +1 -1
- data/lib/plaid/models/credit_amount_with_currency.rb +242 -0
- data/lib/plaid/models/credit_audit_copy_token_create_request.rb +1 -1
- data/lib/plaid/models/credit_audit_copy_token_create_response.rb +1 -1
- data/lib/plaid/models/credit_audit_copy_token_remove_request.rb +1 -1
- data/lib/plaid/models/credit_audit_copy_token_remove_response.rb +1 -1
- data/lib/plaid/models/credit_audit_copy_token_update_request.rb +262 -0
- data/lib/plaid/models/credit_audit_copy_token_update_response.rb +225 -0
- data/lib/plaid/models/credit_bank_income.rb +1 -1
- data/lib/plaid/models/credit_bank_income_account.rb +1 -1
- data/lib/plaid/models/credit_bank_income_account_type.rb +1 -1
- data/lib/plaid/models/credit_bank_income_category.rb +1 -1
- data/lib/plaid/models/credit_bank_income_cause.rb +1 -1
- data/lib/plaid/models/credit_bank_income_error_type.rb +1 -1
- data/lib/plaid/models/credit_bank_income_get_request.rb +1 -1
- data/lib/plaid/models/credit_bank_income_get_request_options.rb +1 -1
- data/lib/plaid/models/credit_bank_income_get_response.rb +1 -1
- data/lib/plaid/models/credit_bank_income_historical_summary.rb +17 -5
- data/lib/plaid/models/credit_bank_income_item.rb +1 -1
- data/lib/plaid/models/credit_bank_income_pay_frequency.rb +1 -1
- data/lib/plaid/models/credit_bank_income_pdf_get_request.rb +1 -1
- data/lib/plaid/models/credit_bank_income_refresh_request.rb +1 -1
- data/lib/plaid/models/credit_bank_income_refresh_request_options.rb +1 -1
- data/lib/plaid/models/credit_bank_income_refresh_response.rb +1 -1
- data/lib/plaid/models/credit_bank_income_source.rb +1 -1
- data/lib/plaid/models/credit_bank_income_summary.rb +17 -5
- data/lib/plaid/models/credit_bank_income_transaction.rb +1 -1
- data/lib/plaid/models/credit_bank_income_warning.rb +1 -1
- data/lib/plaid/models/credit_bank_income_warning_code.rb +1 -1
- data/lib/plaid/models/credit_bank_income_warning_type.rb +1 -1
- data/lib/plaid/models/credit_card_liability.rb +1 -1
- data/lib/plaid/models/credit_category.rb +1 -1
- data/lib/plaid/models/credit_document_metadata.rb +1 -1
- data/lib/plaid/models/credit_employer_verification.rb +1 -1
- data/lib/plaid/models/credit_employment_get_request.rb +1 -1
- data/lib/plaid/models/credit_employment_get_response.rb +1 -1
- data/lib/plaid/models/credit_employment_item.rb +1 -1
- data/lib/plaid/models/credit_employment_verification.rb +1 -1
- data/lib/plaid/models/credit_filter.rb +1 -1
- data/lib/plaid/models/credit_freddie_mac_asset_detail_voe25.rb +317 -0
- data/lib/plaid/models/credit_freddie_mac_asset_transaction_detail_voe25.rb +323 -0
- data/lib/plaid/models/credit_freddie_mac_asset_transaction_voa24.rb +241 -0
- data/lib/plaid/models/credit_freddie_mac_asset_transaction_voe25.rb +241 -0
- data/lib/plaid/models/credit_freddie_mac_asset_transactions_voa24.rb +226 -0
- data/lib/plaid/models/credit_freddie_mac_asset_transactions_voe25.rb +226 -0
- data/lib/plaid/models/credit_freddie_mac_asset_voa24.rb +280 -0
- data/lib/plaid/models/credit_freddie_mac_asset_voe25.rb +266 -0
- data/lib/plaid/models/credit_freddie_mac_assets_voa24.rb +227 -0
- data/lib/plaid/models/credit_freddie_mac_assets_voe25.rb +227 -0
- data/lib/plaid/models/credit_freddie_mac_individual_name_voa24.rb +250 -0
- data/lib/plaid/models/credit_freddie_mac_loan_identifiers_voa24.rb +226 -0
- data/lib/plaid/models/credit_freddie_mac_loan_voa24.rb +239 -0
- data/lib/plaid/models/credit_freddie_mac_loans_voa24.rb +224 -0
- data/lib/plaid/models/credit_freddie_mac_parties_voa24.rb +226 -0
- data/lib/plaid/models/credit_freddie_mac_party_individual_voa24.rb +224 -0
- data/lib/plaid/models/{payment_limits.rb → credit_freddie_mac_party_voa24.rb} +33 -36
- data/lib/plaid/models/credit_freddie_mac_reporting_information_voa24.rb +245 -0
- data/lib/plaid/models/credit_freddie_mac_reports_get_request.rb +245 -0
- data/lib/plaid/models/credit_freddie_mac_reports_get_response.rb +253 -0
- data/lib/plaid/models/credit_freddie_mac_service_voa24.rb +240 -0
- data/lib/plaid/models/credit_freddie_mac_service_voe25.rb +240 -0
- data/lib/plaid/models/credit_freddie_mac_services_voa24.rb +224 -0
- data/lib/plaid/models/credit_freddie_mac_services_voe25.rb +224 -0
- data/lib/plaid/models/credit_freddie_mac_verification_of_asset_response_voa24.rb +224 -0
- data/lib/plaid/models/credit_freddie_mac_verification_of_asset_response_voe25.rb +224 -0
- data/lib/plaid/models/credit_freddie_mac_verification_of_asset_voa24.rb +252 -0
- data/lib/plaid/models/credit_freddie_mac_verification_of_asset_voe25.rb +252 -0
- data/lib/plaid/models/credit_freddie_mac_verification_of_assets_deal_voa24.rb +252 -0
- data/lib/plaid/models/credit_freddie_mac_verification_of_assets_voa24.rb +219 -0
- data/lib/plaid/models/credit_freddie_verification_of_employment_deal_voe25.rb +252 -0
- data/lib/plaid/models/credit_freddie_verification_of_employment_voe25.rb +219 -0
- data/lib/plaid/models/credit_pay_stub.rb +1 -1
- data/lib/plaid/models/credit_pay_stub_address.rb +1 -1
- data/lib/plaid/models/credit_pay_stub_deductions.rb +1 -1
- data/lib/plaid/models/credit_pay_stub_earnings.rb +1 -1
- data/lib/plaid/models/credit_pay_stub_employee.rb +1 -1
- data/lib/plaid/models/credit_pay_stub_employer.rb +1 -1
- data/lib/plaid/models/credit_pay_stub_net_pay.rb +1 -1
- data/lib/plaid/models/credit_pay_stub_pay_basis_type.rb +40 -0
- data/lib/plaid/models/credit_payroll_income_get_request.rb +1 -1
- data/lib/plaid/models/credit_payroll_income_get_response.rb +1 -1
- data/lib/plaid/models/credit_payroll_income_precheck_request.rb +1 -1
- data/lib/plaid/models/credit_payroll_income_precheck_response.rb +1 -1
- data/lib/plaid/models/credit_payroll_income_refresh_request.rb +1 -1
- data/lib/plaid/models/credit_payroll_income_refresh_response.rb +1 -1
- data/lib/plaid/models/credit_payroll_income_risk_signals_get_request.rb +1 -1
- data/lib/plaid/models/credit_payroll_income_risk_signals_get_response.rb +1 -1
- data/lib/plaid/models/credit_platform_ids.rb +1 -1
- data/lib/plaid/models/credit_relay_create_request.rb +2 -2
- data/lib/plaid/models/credit_relay_create_response.rb +1 -1
- data/lib/plaid/models/credit_relay_get_request.rb +1 -1
- data/lib/plaid/models/credit_relay_refresh_request.rb +2 -2
- data/lib/plaid/models/credit_relay_refresh_response.rb +1 -1
- data/lib/plaid/models/credit_relay_remove_request.rb +1 -1
- data/lib/plaid/models/credit_relay_remove_response.rb +2 -2
- data/lib/plaid/models/credit_session.rb +1 -1
- data/lib/plaid/models/credit_session_bank_income_result.rb +1 -1
- data/lib/plaid/models/credit_session_bank_income_status.rb +1 -1
- data/lib/plaid/models/credit_session_document_income_result.rb +1 -1
- data/lib/plaid/models/credit_session_error.rb +1 -1
- data/lib/plaid/models/credit_session_item_add_result.rb +1 -1
- data/lib/plaid/models/credit_session_payroll_income_result.rb +1 -1
- data/lib/plaid/models/credit_session_results.rb +1 -1
- data/lib/plaid/models/credit_sessions_get_request.rb +1 -1
- data/lib/plaid/models/credit_sessions_get_response.rb +1 -1
- data/lib/plaid/models/credit_w2.rb +1 -1
- data/lib/plaid/models/customer_initiated_return_risk.rb +1 -1
- data/lib/plaid/models/dashboard_user.rb +1 -1
- data/lib/plaid/models/dashboard_user_get_request.rb +1 -1
- data/lib/plaid/models/dashboard_user_get_response.rb +1 -1
- data/lib/plaid/models/dashboard_user_list_request.rb +1 -1
- data/lib/plaid/models/dashboard_user_list_response.rb +1 -1
- data/lib/plaid/models/dashboard_user_status.rb +1 -1
- data/lib/plaid/models/date_range.rb +1 -1
- data/lib/plaid/models/deductions.rb +1 -1
- data/lib/plaid/models/deductions_breakdown.rb +1 -1
- data/lib/plaid/models/deductions_total.rb +1 -1
- 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 +1 -1
- 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 +1 -1
- data/lib/plaid/models/depository_account_subtype.rb +1 -1
- data/lib/plaid/models/depository_filter.rb +1 -1
- data/lib/plaid/models/{disbursement_limits.rb → detailed_originator.rb} +34 -36
- data/lib/plaid/models/distribution_breakdown.rb +1 -1
- data/lib/plaid/models/doc_type.rb +1 -1
- data/lib/plaid/models/document_analysis.rb +1 -1
- data/lib/plaid/models/document_authenticity_match_code.rb +1 -1
- data/lib/plaid/models/document_date_of_birth_match_code.rb +1 -1
- data/lib/plaid/models/document_metadata.rb +1 -1
- data/lib/plaid/models/document_name_match_code.rb +1 -1
- data/lib/plaid/models/document_risk_signal.rb +1 -1
- data/lib/plaid/models/document_risk_signal_institution_metadata.rb +1 -1
- data/lib/plaid/models/document_risk_signals_object.rb +1 -1
- data/lib/plaid/models/document_risk_summary.rb +1 -1
- data/lib/plaid/models/document_status.rb +1 -1
- data/lib/plaid/models/documentary_verification.rb +1 -1
- data/lib/plaid/models/documentary_verification_document.rb +1 -1
- data/lib/plaid/models/earnings.rb +1 -1
- data/lib/plaid/models/earnings_breakdown.rb +1 -1
- data/lib/plaid/models/earnings_breakdown_canonical_description.rb +1 -1
- data/lib/plaid/models/earnings_total.rb +1 -1
- data/lib/plaid/models/email.rb +1 -1
- data/lib/plaid/models/email_address_match_score.rb +1 -1
- data/lib/plaid/models/employee.rb +1 -1
- 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/employer_verification.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 +1 -1
- data/lib/plaid/models/employment_verification.rb +1 -1
- data/lib/plaid/models/employment_verification_get_request.rb +1 -1
- data/lib/plaid/models/employment_verification_get_response.rb +1 -1
- data/lib/plaid/models/employment_verification_status.rb +1 -1
- data/lib/plaid/models/enhancements.rb +4 -4
- data/lib/plaid/models/enrich_transaction_direction.rb +1 -1
- data/lib/plaid/models/enrichments.rb +61 -56
- data/lib/plaid/models/entity_document.rb +1 -1
- data/lib/plaid/models/entity_document_type.rb +1 -1
- data/lib/plaid/models/entity_screening_hit_analysis.rb +1 -1
- data/lib/plaid/models/entity_screening_hit_data.rb +1 -1
- data/lib/plaid/models/entity_screening_hit_documents_items.rb +1 -1
- data/lib/plaid/models/entity_screening_hit_emails.rb +1 -1
- data/lib/plaid/models/entity_screening_hit_emails_items.rb +1 -1
- data/lib/plaid/models/entity_screening_hit_names.rb +1 -1
- data/lib/plaid/models/entity_screening_hit_names_items.rb +1 -1
- data/lib/plaid/models/entity_screening_hit_phone_numbers.rb +1 -1
- data/lib/plaid/models/entity_screening_hit_urls.rb +1 -1
- data/lib/plaid/models/entity_screening_hit_urls_items.rb +1 -1
- data/lib/plaid/models/entity_screening_hits_phone_number_items.rb +1 -1
- data/lib/plaid/models/entity_screening_status_updated_webhook.rb +1 -1
- data/lib/plaid/models/entity_watchlist_code.rb +2 -1
- data/lib/plaid/models/entity_watchlist_program.rb +1 -1
- data/lib/plaid/models/entity_watchlist_screening.rb +1 -1
- data/lib/plaid/models/entity_watchlist_screening_hit.rb +1 -1
- data/lib/plaid/models/entity_watchlist_screening_review.rb +1 -1
- data/lib/plaid/models/entity_watchlist_screening_search_terms.rb +1 -1
- data/lib/plaid/models/entity_watchlist_search_terms.rb +1 -1
- data/lib/plaid/models/expiration_date.rb +1 -1
- data/lib/plaid/models/external_payment_initiation_consent_options.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 +1 -1
- data/lib/plaid/models/external_payment_schedule_get.rb +1 -1
- data/lib/plaid/models/external_payment_schedule_request.rb +1 -1
- data/lib/plaid/models/fdx_content_types.rb +1 -1
- data/lib/plaid/models/fdx_hateoas_link.rb +1 -1
- data/lib/plaid/models/fdx_hateoas_link_action.rb +1 -1
- data/lib/plaid/models/fdx_notification.rb +1 -1
- data/lib/plaid/models/fdx_notification_category.rb +1 -1
- data/lib/plaid/models/fdx_notification_payload.rb +1 -1
- data/lib/plaid/models/fdx_notification_payload_id_type.rb +1 -1
- data/lib/plaid/models/fdx_notification_priority.rb +1 -1
- data/lib/plaid/models/fdx_notification_severity.rb +1 -1
- data/lib/plaid/models/fdx_notification_type.rb +1 -1
- data/lib/plaid/models/fdx_party.rb +1 -1
- data/lib/plaid/models/fdx_party_registry.rb +1 -1
- data/lib/plaid/models/fdx_party_type.rb +1 -1
- data/lib/plaid/models/fdxfi_attribute.rb +1 -1
- data/lib/plaid/models/form1099_type.rb +1 -1
- data/lib/plaid/models/freddie_report_type.rb +38 -0
- data/lib/plaid/models/generic_screening_hit_location_items.rb +1 -1
- data/lib/plaid/models/health_incident.rb +1 -1
- data/lib/plaid/models/historical_balance.rb +1 -1
- data/lib/plaid/models/historical_update_webhook.rb +1 -1
- data/lib/plaid/models/holding.rb +2 -2
- data/lib/plaid/models/holdings_default_update_webhook.rb +1 -1
- data/lib/plaid/models/holdings_override.rb +1 -1
- data/lib/plaid/models/id_number_type.rb +1 -1
- data/lib/plaid/models/identity_default_update_webhook.rb +1 -1
- 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/identity_match_request.rb +1 -1
- data/lib/plaid/models/identity_match_request_options.rb +1 -1
- data/lib/plaid/models/identity_match_response.rb +1 -1
- data/lib/plaid/models/identity_match_user.rb +1 -1
- data/lib/plaid/models/identity_update_types.rb +1 -1
- data/lib/plaid/models/identity_verification.rb +1 -1
- data/lib/plaid/models/identity_verification_create_request.rb +1 -1
- data/lib/plaid/models/identity_verification_create_response.rb +1 -1
- data/lib/plaid/models/identity_verification_get_request.rb +1 -1
- data/lib/plaid/models/identity_verification_get_response.rb +1 -1
- data/lib/plaid/models/identity_verification_list_request.rb +1 -1
- data/lib/plaid/models/identity_verification_list_response.rb +1 -1
- data/lib/plaid/models/identity_verification_request_user.rb +1 -1
- data/lib/plaid/models/identity_verification_retried_webhook.rb +1 -1
- data/lib/plaid/models/identity_verification_retry_request.rb +1 -1
- data/lib/plaid/models/identity_verification_retry_request_steps_object.rb +1 -1
- data/lib/plaid/models/identity_verification_retry_response.rb +1 -1
- data/lib/plaid/models/identity_verification_status.rb +1 -1
- data/lib/plaid/models/identity_verification_status_updated_webhook.rb +1 -1
- data/lib/plaid/models/identity_verification_step_status.rb +1 -1
- data/lib/plaid/models/identity_verification_step_summary.rb +1 -1
- data/lib/plaid/models/identity_verification_step_updated_webhook.rb +1 -1
- data/lib/plaid/models/identity_verification_template_reference.rb +1 -1
- data/lib/plaid/models/identity_verification_user_address.rb +1 -1
- data/lib/plaid/models/identity_verification_user_data.rb +1 -1
- data/lib/plaid/models/image_quality.rb +1 -1
- data/lib/plaid/models/incident_update.rb +1 -1
- data/lib/plaid/models/income_breakdown.rb +1 -1
- data/lib/plaid/models/income_breakdown_type.rb +1 -1
- data/lib/plaid/models/income_override.rb +1 -1
- 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_request_options.rb +1 -1
- data/lib/plaid/models/income_verification_create_response.rb +1 -1
- data/lib/plaid/models/income_verification_documents_download_request.rb +1 -1
- data/lib/plaid/models/income_verification_payroll_flow_type.rb +1 -1
- data/lib/plaid/models/income_verification_paystubs_get_request.rb +1 -1
- data/lib/plaid/models/income_verification_paystubs_get_response.rb +1 -1
- data/lib/plaid/models/income_verification_precheck_confidence.rb +1 -1
- data/lib/plaid/models/income_verification_precheck_employer.rb +1 -1
- data/lib/plaid/models/income_verification_precheck_employer_address.rb +1 -1
- data/lib/plaid/models/income_verification_precheck_employer_address_data.rb +1 -1
- data/lib/plaid/models/income_verification_precheck_military_info.rb +1 -1
- data/lib/plaid/models/income_verification_precheck_payroll_institution.rb +1 -1
- data/lib/plaid/models/income_verification_precheck_request.rb +1 -1
- data/lib/plaid/models/income_verification_precheck_response.rb +1 -1
- data/lib/plaid/models/income_verification_precheck_user.rb +1 -1
- data/lib/plaid/models/income_verification_source_type.rb +1 -1
- data/lib/plaid/models/income_verification_status_webhook.rb +1 -1
- data/lib/plaid/models/income_verification_taxforms_get_request.rb +1 -1
- data/lib/plaid/models/income_verification_taxforms_get_response.rb +1 -1
- data/lib/plaid/models/income_verification_webhook_status.rb +1 -1
- data/lib/plaid/models/individual_name.rb +1 -1
- data/lib/plaid/models/individual_screening_hit_names.rb +1 -1
- data/lib/plaid/models/individual_watchlist_code.rb +4 -2
- data/lib/plaid/models/individual_watchlist_program.rb +1 -1
- data/lib/plaid/models/inflow_model.rb +1 -1
- data/lib/plaid/models/initial_update_webhook.rb +1 -1
- data/lib/plaid/models/institution.rb +1 -1
- data/lib/plaid/models/institution_status.rb +1 -1
- data/lib/plaid/models/institution_supported_networks.rb +224 -0
- data/lib/plaid/models/institutions_get_by_id_request.rb +1 -1
- data/lib/plaid/models/institutions_get_by_id_request_options.rb +1 -1
- 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 +1 -1
- 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 +1 -1
- data/lib/plaid/models/institutions_search_response.rb +1 -1
- data/lib/plaid/models/investment_account_subtype.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 +2 -2
- data/lib/plaid/models/investment_transaction_subtype.rb +1 -1
- data/lib/plaid/models/investment_transaction_type.rb +1 -1
- 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 +2 -2
- data/lib/plaid/models/investments_transactions_override.rb +1 -1
- data/lib/plaid/models/issuing_country.rb +1 -1
- 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_activity_list_request.rb +287 -0
- data/lib/plaid/models/item_activity_list_response.rb +247 -0
- 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 +1 -1
- 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 +1 -1
- data/lib/plaid/models/item_status_last_webhook.rb +1 -1
- data/lib/plaid/models/item_status_nullable.rb +1 -1
- data/lib/plaid/models/item_status_transactions.rb +1 -1
- 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 -3
- data/lib/plaid/models/jwt_header.rb +1 -1
- data/lib/plaid/models/kyc_check_address_summary.rb +1 -1
- data/lib/plaid/models/kyc_check_date_of_birth_summary.rb +1 -1
- data/lib/plaid/models/kyc_check_details.rb +1 -1
- data/lib/plaid/models/kyc_check_id_number_summary.rb +1 -1
- data/lib/plaid/models/kyc_check_name_summary.rb +1 -1
- data/lib/plaid/models/kyc_check_phone_summary.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 +1 -1
- data/lib/plaid/models/link_delivery_create_request.rb +1 -1
- data/lib/plaid/models/link_delivery_create_response.rb +1 -1
- data/lib/plaid/models/link_delivery_delivery_method.rb +1 -1
- data/lib/plaid/models/link_delivery_get_request.rb +1 -1
- data/lib/plaid/models/link_delivery_get_response.rb +1 -1
- data/lib/plaid/models/link_delivery_session_status.rb +1 -1
- data/lib/plaid/models/link_o_auth_correlation_id_exchange_request.rb +1 -1
- data/lib/plaid/models/link_o_auth_correlation_id_exchange_response.rb +1 -1
- data/lib/plaid/models/link_token_account_filters.rb +1 -1
- data/lib/plaid/models/link_token_create_credit_filter.rb +1 -1
- data/lib/plaid/models/link_token_create_depository_filter.rb +1 -1
- data/lib/plaid/models/link_token_create_institution_data.rb +1 -1
- data/lib/plaid/models/link_token_create_investment_filter.rb +1 -1
- data/lib/plaid/models/link_token_create_loan_filter.rb +1 -1
- data/lib/plaid/models/link_token_create_request.rb +1 -1
- 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_identity_verification.rb +1 -1
- data/lib/plaid/models/link_token_create_request_income_verification.rb +1 -1
- data/lib/plaid/models/link_token_create_request_income_verification_bank_income.rb +6 -1
- data/lib/plaid/models/link_token_create_request_income_verification_payroll_income.rb +6 -4
- data/lib/plaid/models/link_token_create_request_payment_initiation.rb +1 -1
- data/lib/plaid/models/link_token_create_request_transfer.rb +1 -1
- data/lib/plaid/models/link_token_create_request_update.rb +1 -1
- data/lib/plaid/models/link_token_create_request_user.rb +4 -1
- data/lib/plaid/models/link_token_create_request_user_stated_income_source.rb +1 -1
- data/lib/plaid/models/link_token_create_response.rb +1 -1
- 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 +1 -1
- data/lib/plaid/models/link_token_investments.rb +1 -1
- data/lib/plaid/models/loan.rb +1 -1
- data/lib/plaid/models/loan_account_subtype.rb +1 -1
- data/lib/plaid/models/loan_filter.rb +1 -1
- data/lib/plaid/models/loan_identifier.rb +1 -1
- data/lib/plaid/models/loan_identifier_type.rb +1 -1
- data/lib/plaid/models/loan_identifiers.rb +1 -1
- data/lib/plaid/models/loans.rb +1 -1
- data/lib/plaid/models/location.rb +1 -1
- data/lib/plaid/models/match_summary.rb +1 -1
- data/lib/plaid/models/match_summary_code.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 +1 -1
- data/lib/plaid/models/mortgage_property_address.rb +1 -1
- data/lib/plaid/models/multi_document_risk_signal.rb +1 -1
- data/lib/plaid/models/name_match_score.rb +1 -1
- data/lib/plaid/models/net_pay.rb +1 -1
- data/lib/plaid/models/new_accounts_available_webhook.rb +1 -1
- 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_iban_nullable.rb +1 -1
- data/lib/plaid/models/numbers_international.rb +1 -1
- data/lib/plaid/models/numbers_international_iban.rb +1 -1
- data/lib/plaid/models/numbers_international_nullable.rb +1 -1
- data/lib/plaid/models/originator.rb +1 -1
- data/lib/plaid/models/override_account_type.rb +1 -1
- data/lib/plaid/models/override_accounts.rb +1 -1
- data/lib/plaid/models/owner.rb +1 -1
- data/lib/plaid/models/owner_override.rb +1 -1
- data/lib/plaid/models/ownership_type.rb +1 -1
- data/lib/plaid/models/parties.rb +1 -1
- data/lib/plaid/models/partner_customer_create_request.rb +15 -6
- data/lib/plaid/models/partner_customer_create_response.rb +1 -1
- data/lib/plaid/models/partner_customer_enable_request.rb +1 -1
- data/lib/plaid/models/partner_customer_enable_response.rb +1 -1
- data/lib/plaid/models/partner_customer_get_request.rb +1 -1
- data/lib/plaid/models/partner_customer_get_response.rb +1 -1
- data/lib/plaid/models/partner_customer_o_auth_institutions_get_request.rb +244 -0
- data/lib/plaid/models/partner_customer_o_auth_institutions_get_response.rb +250 -0
- data/lib/plaid/models/partner_customer_remove_request.rb +1 -1
- data/lib/plaid/models/partner_customer_remove_response.rb +1 -1
- data/lib/plaid/models/partner_end_customer.rb +1 -1
- data/lib/plaid/models/partner_end_customer_address.rb +1 -1
- data/lib/plaid/models/partner_end_customer_assets_under_management.rb +1 -1
- data/lib/plaid/models/partner_end_customer_billing_contact.rb +1 -1
- data/lib/plaid/models/partner_end_customer_customer_support_info.rb +246 -0
- data/lib/plaid/models/partner_end_customer_flowdown_status.rb +41 -0
- data/lib/plaid/models/partner_end_customer_o_auth_institution.rb +259 -0
- data/lib/plaid/models/partner_end_customer_o_auth_institution_application_status.rb +42 -0
- data/lib/plaid/models/partner_end_customer_o_auth_institution_environments.rb +228 -0
- data/lib/plaid/models/partner_end_customer_questionnaire_status.rb +40 -0
- data/lib/plaid/models/partner_end_customer_secrets.rb +1 -1
- data/lib/plaid/models/partner_end_customer_status.rb +3 -3
- data/lib/plaid/models/partner_end_customer_technical_contact.rb +1 -1
- data/lib/plaid/models/partner_end_customer_with_secrets.rb +1 -1
- data/lib/plaid/models/partner_end_customer_with_secrets_all_of.rb +1 -1
- data/lib/plaid/models/party.rb +1 -1
- data/lib/plaid/models/party_individual.rb +2 -2
- data/lib/plaid/models/party_role_type.rb +1 -1
- data/lib/plaid/models/pay.rb +1 -1
- data/lib/plaid/models/pay_frequency.rb +1 -1
- data/lib/plaid/models/pay_frequency_value.rb +1 -1
- data/lib/plaid/models/pay_period_details.rb +1 -1
- data/lib/plaid/models/pay_stub_deductions_breakdown.rb +1 -1
- data/lib/plaid/models/pay_stub_deductions_total.rb +1 -1
- data/lib/plaid/models/pay_stub_distribution_breakdown.rb +1 -1
- data/lib/plaid/models/pay_stub_earnings_breakdown.rb +1 -1
- data/lib/plaid/models/pay_stub_earnings_total.rb +1 -1
- data/lib/plaid/models/pay_stub_pay_period_details.rb +11 -2
- data/lib/plaid/models/pay_stub_taxpayer_id.rb +1 -1
- data/lib/plaid/models/payment_amount.rb +1 -1
- data/lib/plaid/models/payment_amount_currency.rb +1 -3
- data/lib/plaid/models/payment_amount_nullable.rb +1 -1
- data/lib/plaid/models/payment_amount_refunded.rb +2 -2
- data/lib/plaid/models/payment_amount_to_refund.rb +2 -2
- data/lib/plaid/models/payment_channel.rb +1 -1
- data/lib/plaid/models/payment_consent_max_payment_amount.rb +1 -1
- data/lib/plaid/models/payment_consent_periodic_alignment.rb +1 -1
- data/lib/plaid/models/payment_consent_periodic_amount.rb +1 -1
- data/lib/plaid/models/payment_consent_periodic_amount_amount.rb +1 -1
- data/lib/plaid/models/payment_consent_periodic_interval.rb +1 -1
- data/lib/plaid/models/payment_consent_valid_date_time.rb +1 -1
- data/lib/plaid/models/payment_initiation_address.rb +1 -1
- data/lib/plaid/models/payment_initiation_consent.rb +1 -1
- data/lib/plaid/models/payment_initiation_consent_constraints.rb +1 -1
- data/lib/plaid/models/payment_initiation_consent_create_request.rb +1 -1
- data/lib/plaid/models/payment_initiation_consent_create_response.rb +1 -1
- data/lib/plaid/models/payment_initiation_consent_get_request.rb +1 -1
- data/lib/plaid/models/payment_initiation_consent_get_response.rb +1 -1
- data/lib/plaid/models/payment_initiation_consent_payment_execute_request.rb +1 -1
- data/lib/plaid/models/payment_initiation_consent_payment_execute_response.rb +1 -1
- data/lib/plaid/models/payment_initiation_consent_revoke_request.rb +1 -1
- data/lib/plaid/models/payment_initiation_consent_revoke_response.rb +1 -1
- data/lib/plaid/models/payment_initiation_consent_scope.rb +1 -1
- data/lib/plaid/models/payment_initiation_consent_status.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 +1 -1
- 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_create_status.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 +1 -1
- data/lib/plaid/models/payment_initiation_payment_list_request.rb +1 -1
- data/lib/plaid/models/payment_initiation_payment_list_response.rb +1 -1
- data/lib/plaid/models/payment_initiation_payment_reverse_request.rb +1 -1
- data/lib/plaid/models/payment_initiation_payment_reverse_response.rb +1 -1
- data/lib/plaid/models/payment_initiation_payment_status.rb +1 -1
- data/lib/plaid/models/payment_initiation_payment_token_create_request.rb +1 -1
- data/lib/plaid/models/payment_initiation_payment_token_create_response.rb +1 -1
- 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_standing_order_metadata.rb +1 -1
- data/lib/plaid/models/payment_meta.rb +1 -1
- data/lib/plaid/models/payment_profile_create_request.rb +1 -1
- data/lib/plaid/models/payment_profile_create_response.rb +1 -1
- data/lib/plaid/models/payment_profile_get_request.rb +1 -1
- data/lib/plaid/models/payment_profile_get_response.rb +1 -1
- data/lib/plaid/models/payment_profile_remove_request.rb +1 -1
- data/lib/plaid/models/payment_profile_remove_response.rb +1 -1
- data/lib/plaid/models/payment_profile_status.rb +1 -1
- data/lib/plaid/models/payment_schedule_interval.rb +1 -1
- data/lib/plaid/models/payment_scheme.rb +3 -2
- data/lib/plaid/models/payment_status_update_webhook.rb +1 -1
- data/lib/plaid/models/payroll_income_account_data.rb +1 -1
- data/lib/plaid/models/payroll_income_object.rb +1 -1
- data/lib/plaid/models/payroll_income_rate_of_pay.rb +1 -1
- data/lib/plaid/models/payroll_item.rb +1 -1
- data/lib/plaid/models/payroll_item_status.rb +1 -1
- data/lib/plaid/models/payroll_risk_signals_item.rb +1 -1
- data/lib/plaid/models/paystub.rb +1 -1
- data/lib/plaid/models/paystub_address.rb +1 -1
- data/lib/plaid/models/paystub_deduction.rb +1 -1
- data/lib/plaid/models/paystub_details.rb +1 -1
- data/lib/plaid/models/paystub_employer.rb +1 -1
- data/lib/plaid/models/paystub_override.rb +1 -1
- data/lib/plaid/models/paystub_override_employee.rb +1 -1
- data/lib/plaid/models/paystub_override_employee_address.rb +1 -1
- data/lib/plaid/models/paystub_override_employer.rb +1 -1
- data/lib/plaid/models/paystub_pay_frequency.rb +1 -1
- data/lib/plaid/models/paystub_ytd_details.rb +1 -1
- data/lib/plaid/models/pending_expiration_webhook.rb +1 -1
- data/lib/plaid/models/personal_finance_category.rb +1 -1
- data/lib/plaid/models/phone_number.rb +1 -1
- data/lib/plaid/models/phone_number_match_score.rb +1 -1
- data/lib/plaid/models/phone_type.rb +1 -1
- data/lib/plaid/models/physical_document_category.rb +1 -1
- data/lib/plaid/models/physical_document_extracted_data.rb +1 -1
- data/lib/plaid/models/physical_document_extracted_data_analysis.rb +1 -1
- data/lib/plaid/models/physical_document_images.rb +1 -1
- data/lib/plaid/models/plaid_error.rb +1 -1
- data/lib/plaid/models/plaid_error_type.rb +1 -1
- data/lib/plaid/models/platform_ids.rb +1 -1
- data/lib/plaid/models/po_box_status.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 +1 -1
- data/lib/plaid/models/processor_balance_get_request_options.rb +1 -1
- data/lib/plaid/models/processor_balance_get_response.rb +1 -1
- data/lib/plaid/models/processor_bank_transfer_create_request.rb +1 -1
- data/lib/plaid/models/processor_bank_transfer_create_response.rb +1 -1
- 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 +1 -1
- data/lib/plaid/models/product_status_breakdown.rb +1 -1
- data/lib/plaid/models/products.rb +1 -1
- data/lib/plaid/models/program_name_sensitivity.rb +1 -1
- data/lib/plaid/models/projected_income_summary_field_number.rb +1 -1
- data/lib/plaid/models/pslf_status.rb +1 -1
- 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_cancelled_webhook.rb +269 -0
- data/lib/plaid/models/recurring_new_transfer_webhook.rb +284 -0
- data/lib/plaid/models/recurring_transaction_frequency.rb +1 -1
- data/lib/plaid/models/recurring_transactions_update_webhook.rb +2 -2
- data/lib/plaid/models/recurring_transfer.rb +29 -24
- data/lib/plaid/models/recurring_transfer_nullable.rb +443 -0
- data/lib/plaid/models/recurring_transfer_skipped_webhook.rb +307 -0
- data/lib/plaid/models/removed_transaction.rb +1 -1
- data/lib/plaid/models/report_type.rb +1 -1
- data/lib/plaid/models/reporting_information.rb +2 -2
- data/lib/plaid/models/risk_signal_document_reference.rb +1 -1
- data/lib/plaid/models/role.rb +2 -2
- data/lib/plaid/models/role_detail.rb +2 -2
- data/lib/plaid/models/roles.rb +2 -2
- data/lib/plaid/models/sandbox_bank_transfer_fire_webhook_request.rb +1 -1
- data/lib/plaid/models/sandbox_bank_transfer_fire_webhook_response.rb +1 -1
- data/lib/plaid/models/sandbox_bank_transfer_simulate_request.rb +1 -1
- data/lib/plaid/models/sandbox_bank_transfer_simulate_response.rb +1 -1
- 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_payment_profile_reset_login_request.rb +1 -1
- data/lib/plaid/models/sandbox_payment_profile_reset_login_response.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_income_verification_bank_income.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_income_verification.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_fire_webhook_request.rb +1 -1
- data/lib/plaid/models/sandbox_transfer_fire_webhook_response.rb +1 -1
- data/lib/plaid/models/sandbox_transfer_repayment_simulate_request.rb +1 -1
- data/lib/plaid/models/sandbox_transfer_repayment_simulate_response.rb +1 -1
- data/lib/plaid/models/sandbox_transfer_simulate_request.rb +1 -1
- data/lib/plaid/models/sandbox_transfer_simulate_response.rb +1 -1
- data/lib/plaid/models/sandbox_transfer_sweep_simulate_request.rb +1 -1
- data/lib/plaid/models/sandbox_transfer_sweep_simulate_response.rb +1 -1
- data/lib/plaid/models/sandbox_transfer_test_clock_advance_request.rb +15 -21
- data/lib/plaid/models/sandbox_transfer_test_clock_advance_response.rb +1 -1
- data/lib/plaid/models/sandbox_transfer_test_clock_create_request.rb +12 -22
- data/lib/plaid/models/sandbox_transfer_test_clock_create_response.rb +1 -1
- data/lib/plaid/models/sandbox_transfer_test_clock_get_request.rb +4 -10
- data/lib/plaid/models/sandbox_transfer_test_clock_get_response.rb +1 -1
- data/lib/plaid/models/sandbox_transfer_test_clock_list_request.rb +320 -0
- data/lib/plaid/models/sandbox_transfer_test_clock_list_response.rb +241 -0
- data/lib/plaid/models/scopes.rb +1 -1
- data/lib/plaid/models/scopes_context.rb +1 -1
- data/lib/plaid/models/scopes_nullable.rb +1 -1
- data/lib/plaid/models/screening_hit_analysis.rb +1 -1
- data/lib/plaid/models/screening_hit_data.rb +1 -1
- data/lib/plaid/models/screening_hit_date_of_birth_item.rb +1 -1
- data/lib/plaid/models/screening_hit_documents_items.rb +1 -1
- data/lib/plaid/models/screening_hit_names_items.rb +1 -1
- data/lib/plaid/models/screening_status_updated_webhook.rb +1 -1
- data/lib/plaid/models/security.rb +5 -5
- data/lib/plaid/models/security_override.rb +3 -3
- data/lib/plaid/models/sender_bacs_nullable.rb +1 -1
- data/lib/plaid/models/service.rb +1 -1
- data/lib/plaid/models/service_product_fulfillment.rb +1 -1
- data/lib/plaid/models/service_product_fulfillment_detail.rb +2 -2
- data/lib/plaid/models/service_product_fulfillment_identifier.rb +2 -1
- data/lib/plaid/models/servicer_address_data.rb +1 -1
- data/lib/plaid/models/services.rb +1 -1
- data/lib/plaid/models/signal_address_data.rb +1 -1
- data/lib/plaid/models/signal_decision_outcome.rb +1 -1
- data/lib/plaid/models/signal_decision_report_request.rb +1 -1
- data/lib/plaid/models/signal_decision_report_response.rb +1 -1
- data/lib/plaid/models/signal_device.rb +1 -1
- data/lib/plaid/models/signal_evaluate_core_attributes.rb +1 -1
- data/lib/plaid/models/signal_evaluate_request.rb +2 -2
- data/lib/plaid/models/signal_evaluate_response.rb +1 -1
- data/lib/plaid/models/signal_payment_method.rb +1 -1
- data/lib/plaid/models/signal_person_name.rb +1 -1
- data/lib/plaid/models/signal_prepare_request.rb +1 -1
- data/lib/plaid/models/signal_prepare_response.rb +1 -1
- data/lib/plaid/models/signal_return_report_request.rb +1 -1
- data/lib/plaid/models/signal_return_report_response.rb +1 -1
- data/lib/plaid/models/signal_scores.rb +1 -1
- data/lib/plaid/models/signal_user.rb +1 -1
- data/lib/plaid/models/simulated_transfer_sweep.rb +1 -1
- data/lib/plaid/models/single_document_risk_signal.rb +1 -1
- data/lib/plaid/models/source.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 +1 -1
- data/lib/plaid/models/status.rb +2 -2
- data/lib/plaid/models/statuses.rb +1 -1
- data/lib/plaid/models/strategy.rb +1 -1
- data/lib/plaid/models/student_loan.rb +1 -1
- data/lib/plaid/models/student_loan_repayment_model.rb +1 -1
- data/lib/plaid/models/student_loan_status.rb +1 -1
- data/lib/plaid/models/student_repayment_plan.rb +1 -1
- data/lib/plaid/models/sync_updates_available_webhook.rb +1 -1
- data/lib/plaid/models/taxform.rb +1 -1
- data/lib/plaid/models/taxpayer_id.rb +1 -1
- data/lib/plaid/models/taxpayer_identifier.rb +1 -1
- data/lib/plaid/models/taxpayer_identifier_type.rb +1 -1
- data/lib/plaid/models/taxpayer_identifiers.rb +1 -1
- data/lib/plaid/models/total.rb +1 -1
- data/lib/plaid/models/total_canonical_description.rb +1 -1
- data/lib/plaid/models/transaction.rb +50 -6
- data/lib/plaid/models/transaction_all_of.rb +28 -6
- data/lib/plaid/models/transaction_base.rb +24 -2
- data/lib/plaid/models/transaction_code.rb +1 -1
- data/lib/plaid/models/transaction_counterparty.rb +261 -0
- data/lib/plaid/models/transaction_data.rb +1 -1
- data/lib/plaid/models/transaction_override.rb +1 -1
- data/lib/plaid/models/transaction_stream.rb +1 -1
- data/lib/plaid/models/transaction_stream_amount.rb +1 -1
- data/lib/plaid/models/transaction_stream_status.rb +1 -1
- data/lib/plaid/models/transactions_category_rule.rb +1 -1
- data/lib/plaid/models/transactions_enhance_get_request.rb +1 -1
- data/lib/plaid/models/transactions_enhance_get_response.rb +1 -1
- data/lib/plaid/models/transactions_enrich_get_request.rb +8 -11
- data/lib/plaid/models/transactions_enrich_get_response.rb +1 -1
- data/lib/plaid/models/transactions_enrich_request_options.rb +222 -0
- data/lib/plaid/models/transactions_get_request.rb +1 -1
- data/lib/plaid/models/transactions_get_request_options.rb +17 -5
- data/lib/plaid/models/transactions_get_response.rb +1 -1
- data/lib/plaid/models/transactions_recurring_get_request.rb +1 -1
- data/lib/plaid/models/transactions_recurring_get_request_options.rb +1 -1
- data/lib/plaid/models/transactions_recurring_get_response.rb +1 -1
- 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/transactions_rule_details.rb +1 -1
- data/lib/plaid/models/transactions_rule_field.rb +1 -1
- data/lib/plaid/models/transactions_rule_type.rb +1 -1
- data/lib/plaid/models/transactions_rules_create_request.rb +1 -1
- data/lib/plaid/models/transactions_rules_create_response.rb +1 -1
- data/lib/plaid/models/transactions_rules_list_request.rb +1 -1
- data/lib/plaid/models/transactions_rules_list_response.rb +1 -1
- data/lib/plaid/models/transactions_rules_remove_request.rb +1 -1
- data/lib/plaid/models/transactions_rules_remove_response.rb +1 -1
- data/lib/plaid/models/transactions_sync_request.rb +1 -1
- data/lib/plaid/models/transactions_sync_request_options.rb +17 -5
- data/lib/plaid/models/transactions_sync_response.rb +1 -1
- data/lib/plaid/models/transfer.rb +16 -5
- data/lib/plaid/models/transfer_authorization.rb +1 -1
- data/lib/plaid/models/transfer_authorization_create_request.rb +1 -1
- data/lib/plaid/models/transfer_authorization_create_response.rb +1 -1
- data/lib/plaid/models/transfer_authorization_decision.rb +1 -1
- data/lib/plaid/models/transfer_authorization_decision_rationale.rb +1 -1
- data/lib/plaid/models/transfer_authorization_decision_rationale_code.rb +1 -1
- data/lib/plaid/models/transfer_authorization_device.rb +1 -1
- data/lib/plaid/models/transfer_authorization_guarantee_decision.rb +1 -1
- data/lib/plaid/models/transfer_authorization_guarantee_decision_rationale.rb +1 -1
- data/lib/plaid/models/transfer_authorization_guarantee_decision_rationale_code.rb +1 -1
- data/lib/plaid/models/transfer_authorization_proposed_transfer.rb +1 -1
- data/lib/plaid/models/transfer_authorization_user_in_request.rb +1 -1
- data/lib/plaid/models/transfer_cancel_request.rb +1 -1
- data/lib/plaid/models/transfer_cancel_response.rb +1 -1
- data/lib/plaid/models/transfer_capabilities_get_request.rb +260 -0
- data/lib/plaid/models/transfer_capabilities_get_response.rb +239 -0
- data/lib/plaid/models/transfer_capabilities_get_rtp.rb +222 -0
- data/lib/plaid/models/transfer_create_request.rb +1 -1
- data/lib/plaid/models/transfer_create_response.rb +1 -1
- data/lib/plaid/models/transfer_device.rb +1 -1
- data/lib/plaid/models/transfer_diligence_status.rb +1 -1
- data/lib/plaid/models/transfer_event.rb +1 -1
- data/lib/plaid/models/transfer_event_list_request.rb +1 -1
- data/lib/plaid/models/transfer_event_list_response.rb +1 -1
- data/lib/plaid/models/transfer_event_list_transfer_type.rb +1 -1
- data/lib/plaid/models/transfer_event_sync_request.rb +1 -1
- data/lib/plaid/models/transfer_event_sync_response.rb +1 -1
- data/lib/plaid/models/transfer_event_type.rb +1 -1
- data/lib/plaid/models/transfer_events_update_webhook.rb +1 -1
- data/lib/plaid/models/transfer_failure.rb +1 -1
- data/lib/plaid/models/transfer_get_request.rb +1 -1
- data/lib/plaid/models/transfer_get_response.rb +1 -1
- data/lib/plaid/models/transfer_intent_authorization_decision.rb +1 -1
- data/lib/plaid/models/transfer_intent_create.rb +1 -1
- data/lib/plaid/models/transfer_intent_create_mode.rb +1 -1
- data/lib/plaid/models/transfer_intent_create_request.rb +1 -1
- data/lib/plaid/models/transfer_intent_create_response.rb +1 -1
- data/lib/plaid/models/transfer_intent_get.rb +1 -1
- data/lib/plaid/models/transfer_intent_get_failure_reason.rb +1 -1
- data/lib/plaid/models/transfer_intent_get_request.rb +1 -1
- data/lib/plaid/models/transfer_intent_get_response.rb +1 -1
- data/lib/plaid/models/transfer_intent_status.rb +1 -1
- data/lib/plaid/models/transfer_list_request.rb +1 -1
- data/lib/plaid/models/transfer_list_response.rb +1 -1
- data/lib/plaid/models/transfer_migrate_account_request.rb +1 -1
- data/lib/plaid/models/transfer_migrate_account_response.rb +1 -1
- data/lib/plaid/models/transfer_network.rb +1 -1
- data/lib/plaid/models/transfer_originator_create_request.rb +22 -1
- data/lib/plaid/models/transfer_originator_create_response.rb +1 -1
- data/lib/plaid/models/transfer_originator_get_request.rb +1 -1
- data/lib/plaid/models/transfer_originator_get_response.rb +2 -2
- data/lib/plaid/models/transfer_originator_list_request.rb +5 -3
- data/lib/plaid/models/transfer_originator_list_response.rb +1 -1
- data/lib/plaid/models/transfer_questionnaire_create_request.rb +5 -47
- data/lib/plaid/models/transfer_questionnaire_create_response.rb +1 -1
- data/lib/plaid/models/transfer_recurring_cancel_request.rb +1 -11
- data/lib/plaid/models/transfer_recurring_cancel_response.rb +1 -1
- data/lib/plaid/models/transfer_recurring_create_request.rb +27 -14
- data/lib/plaid/models/transfer_recurring_create_response.rb +25 -6
- data/lib/plaid/models/transfer_recurring_get_request.rb +1 -11
- data/lib/plaid/models/transfer_recurring_get_response.rb +1 -1
- data/lib/plaid/models/transfer_recurring_list_request.rb +18 -28
- data/lib/plaid/models/transfer_recurring_list_response.rb +1 -1
- data/lib/plaid/models/transfer_recurring_schedule.rb +22 -2
- data/lib/plaid/models/transfer_recurring_status.rb +1 -1
- data/lib/plaid/models/transfer_refund.rb +1 -1
- data/lib/plaid/models/transfer_refund_cancel_request.rb +1 -1
- data/lib/plaid/models/transfer_refund_cancel_response.rb +1 -1
- data/lib/plaid/models/transfer_refund_create_request.rb +1 -1
- data/lib/plaid/models/transfer_refund_create_response.rb +1 -1
- data/lib/plaid/models/transfer_refund_get_request.rb +1 -1
- data/lib/plaid/models/transfer_refund_get_response.rb +1 -1
- data/lib/plaid/models/transfer_refund_status.rb +1 -1
- data/lib/plaid/models/transfer_repayment.rb +1 -1
- data/lib/plaid/models/transfer_repayment_list_request.rb +1 -1
- data/lib/plaid/models/transfer_repayment_list_response.rb +1 -1
- data/lib/plaid/models/transfer_repayment_return.rb +1 -1
- data/lib/plaid/models/transfer_repayment_return_list_request.rb +1 -1
- data/lib/plaid/models/transfer_repayment_return_list_response.rb +1 -1
- data/lib/plaid/models/transfer_schedule_interval_unit.rb +1 -1
- data/lib/plaid/models/transfer_status.rb +1 -1
- data/lib/plaid/models/transfer_sweep.rb +1 -1
- data/lib/plaid/models/transfer_sweep_get_request.rb +1 -1
- data/lib/plaid/models/transfer_sweep_get_response.rb +1 -1
- data/lib/plaid/models/transfer_sweep_list_request.rb +1 -1
- data/lib/plaid/models/transfer_sweep_list_response.rb +1 -1
- data/lib/plaid/models/transfer_sweep_status.rb +1 -1
- data/lib/plaid/models/transfer_test_clock.rb +17 -13
- data/lib/plaid/models/transfer_type.rb +1 -1
- data/lib/plaid/models/transfer_user_address_in_request.rb +1 -1
- data/lib/plaid/models/transfer_user_address_in_response.rb +1 -1
- data/lib/plaid/models/transfer_user_in_request.rb +1 -1
- data/lib/plaid/models/transfer_user_in_request_deprecated.rb +1 -1
- data/lib/plaid/models/transfer_user_in_response.rb +1 -1
- data/lib/plaid/models/update_entity_screening_request_search_terms.rb +1 -1
- data/lib/plaid/models/update_individual_screening_request_search_terms.rb +1 -1
- data/lib/plaid/models/user_address.rb +1 -1
- data/lib/plaid/models/user_create_request.rb +1 -1
- data/lib/plaid/models/user_create_response.rb +1 -1
- data/lib/plaid/models/user_custom_password.rb +1 -1
- data/lib/plaid/models/user_id_number.rb +1 -1
- data/lib/plaid/models/user_name.rb +1 -1
- data/lib/plaid/models/user_permission_revoked_webhook.rb +1 -1
- data/lib/plaid/models/user_stated_income_source_category.rb +1 -1
- data/lib/plaid/models/user_stated_income_source_frequency.rb +1 -1
- data/lib/plaid/models/user_stated_income_source_pay_type.rb +1 -1
- data/lib/plaid/models/validation_source.rb +4 -4
- data/lib/plaid/models/validation_sources.rb +3 -3
- data/lib/plaid/models/verification_expired_webhook.rb +1 -1
- data/lib/plaid/models/verification_of_asset.rb +2 -2
- data/lib/plaid/models/verification_of_asset_response.rb +2 -2
- data/lib/plaid/models/verification_refresh_status.rb +1 -1
- data/lib/plaid/models/verification_status.rb +1 -1
- data/lib/plaid/models/w2.rb +1 -1
- data/lib/plaid/models/w2_box12.rb +1 -1
- data/lib/plaid/models/w2_state_and_local_wages.rb +1 -1
- data/lib/plaid/models/wallet.rb +1 -1
- data/lib/plaid/models/wallet_balance.rb +1 -1
- data/lib/plaid/models/wallet_create_request.rb +1 -1
- data/lib/plaid/models/wallet_create_response.rb +1 -1
- data/lib/plaid/models/wallet_get_request.rb +1 -1
- data/lib/plaid/models/wallet_get_response.rb +1 -1
- data/lib/plaid/models/wallet_iso_currency_code.rb +1 -1
- data/lib/plaid/models/wallet_list_request.rb +1 -1
- data/lib/plaid/models/wallet_list_response.rb +1 -1
- data/lib/plaid/models/wallet_numbers.rb +1 -1
- data/lib/plaid/models/wallet_transaction.rb +4 -4
- data/lib/plaid/models/wallet_transaction_amount.rb +1 -1
- data/lib/plaid/models/wallet_transaction_counterparty.rb +1 -1
- data/lib/plaid/models/wallet_transaction_counterparty_bacs.rb +1 -1
- data/lib/plaid/models/wallet_transaction_counterparty_international.rb +1 -1
- data/lib/plaid/models/wallet_transaction_counterparty_numbers.rb +1 -1
- data/lib/plaid/models/wallet_transaction_execute_request.rb +1 -1
- data/lib/plaid/models/wallet_transaction_execute_response.rb +1 -1
- data/lib/plaid/models/wallet_transaction_get_request.rb +1 -1
- data/lib/plaid/models/wallet_transaction_get_response.rb +4 -4
- data/lib/plaid/models/wallet_transaction_list_request.rb +1 -1
- data/lib/plaid/models/wallet_transaction_list_request_options.rb +1 -1
- data/lib/plaid/models/wallet_transaction_list_response.rb +1 -1
- data/lib/plaid/models/wallet_transaction_status.rb +1 -1
- data/lib/plaid/models/wallet_transaction_status_update_webhook.rb +1 -1
- data/lib/plaid/models/wallet_transactions_list_request.rb +1 -1
- data/lib/plaid/models/warning.rb +1 -1
- data/lib/plaid/models/watchlist_screening_audit_trail.rb +1 -1
- data/lib/plaid/models/watchlist_screening_document.rb +1 -1
- data/lib/plaid/models/watchlist_screening_document_type.rb +1 -1
- data/lib/plaid/models/watchlist_screening_entity_create_request.rb +1 -1
- data/lib/plaid/models/watchlist_screening_entity_create_response.rb +1 -1
- data/lib/plaid/models/watchlist_screening_entity_get_request.rb +1 -1
- data/lib/plaid/models/watchlist_screening_entity_get_response.rb +1 -1
- data/lib/plaid/models/watchlist_screening_entity_history_list_request.rb +1 -1
- data/lib/plaid/models/watchlist_screening_entity_history_list_response.rb +1 -1
- data/lib/plaid/models/watchlist_screening_entity_hit_list_request.rb +1 -1
- data/lib/plaid/models/watchlist_screening_entity_hit_list_response.rb +1 -1
- data/lib/plaid/models/watchlist_screening_entity_list_request.rb +1 -1
- data/lib/plaid/models/watchlist_screening_entity_list_response.rb +1 -1
- data/lib/plaid/models/watchlist_screening_entity_program_get_request.rb +1 -1
- data/lib/plaid/models/watchlist_screening_entity_program_get_response.rb +1 -1
- data/lib/plaid/models/watchlist_screening_entity_program_list_request.rb +1 -1
- data/lib/plaid/models/watchlist_screening_entity_program_list_response.rb +1 -1
- data/lib/plaid/models/watchlist_screening_entity_review_create_request.rb +1 -1
- data/lib/plaid/models/watchlist_screening_entity_review_create_response.rb +1 -1
- data/lib/plaid/models/watchlist_screening_entity_review_list_request.rb +1 -1
- data/lib/plaid/models/watchlist_screening_entity_review_list_response.rb +1 -1
- data/lib/plaid/models/watchlist_screening_entity_update_request.rb +1 -1
- data/lib/plaid/models/watchlist_screening_entity_update_request_resettable_field.rb +1 -1
- data/lib/plaid/models/watchlist_screening_entity_update_response.rb +1 -1
- data/lib/plaid/models/watchlist_screening_hit.rb +1 -1
- data/lib/plaid/models/watchlist_screening_hit_locations.rb +1 -1
- data/lib/plaid/models/watchlist_screening_hit_status.rb +1 -1
- data/lib/plaid/models/watchlist_screening_individual.rb +1 -1
- data/lib/plaid/models/watchlist_screening_individual_create_request.rb +1 -1
- data/lib/plaid/models/watchlist_screening_individual_create_response.rb +1 -1
- data/lib/plaid/models/watchlist_screening_individual_get_request.rb +1 -1
- data/lib/plaid/models/watchlist_screening_individual_get_response.rb +1 -1
- data/lib/plaid/models/watchlist_screening_individual_history_list_request.rb +1 -1
- data/lib/plaid/models/watchlist_screening_individual_history_list_response.rb +1 -1
- data/lib/plaid/models/watchlist_screening_individual_hit_list_request.rb +1 -1
- data/lib/plaid/models/watchlist_screening_individual_hit_list_response.rb +1 -1
- data/lib/plaid/models/watchlist_screening_individual_list_request.rb +1 -1
- data/lib/plaid/models/watchlist_screening_individual_list_response.rb +1 -1
- data/lib/plaid/models/watchlist_screening_individual_program_get_request.rb +1 -1
- data/lib/plaid/models/watchlist_screening_individual_program_get_response.rb +1 -1
- data/lib/plaid/models/watchlist_screening_individual_program_list_request.rb +1 -1
- data/lib/plaid/models/watchlist_screening_individual_program_list_response.rb +1 -1
- data/lib/plaid/models/watchlist_screening_individual_review_create_request.rb +1 -1
- data/lib/plaid/models/watchlist_screening_individual_review_create_response.rb +1 -1
- data/lib/plaid/models/watchlist_screening_individual_review_list_request.rb +1 -1
- data/lib/plaid/models/watchlist_screening_individual_review_list_response.rb +1 -1
- data/lib/plaid/models/watchlist_screening_individual_update_request.rb +1 -1
- data/lib/plaid/models/watchlist_screening_individual_update_request_resettable_field.rb +1 -1
- data/lib/plaid/models/watchlist_screening_individual_update_response.rb +1 -1
- data/lib/plaid/models/watchlist_screening_request_search_terms.rb +1 -1
- data/lib/plaid/models/watchlist_screening_review.rb +1 -1
- data/lib/plaid/models/watchlist_screening_search_terms.rb +1 -1
- data/lib/plaid/models/watchlist_screening_status.rb +1 -1
- data/lib/plaid/models/weak_alias_determination.rb +1 -1
- data/lib/plaid/models/webhook_environment_values.rb +1 -1
- data/lib/plaid/models/webhook_type.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 +66 -4
- data/plaid.gemspec +1 -1
- data/templates/ruby/api_client_faraday_partial.mustache +9 -2
- data/test/test_enrich.rb +60 -0
- data/test/test_payment_initiation.rb +2 -2
- metadata +68 -5
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.214.0
|
7
7
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
OpenAPI Generator version: 5.1.1
|
@@ -1060,7 +1060,7 @@ module Plaid
|
|
1060
1060
|
end
|
1061
1061
|
|
1062
1062
|
# List bank transfer events
|
1063
|
-
# Use the `/bank_transfer/event/list` endpoint to get a list of bank transfer events based on specified filter criteria.
|
1063
|
+
# Use the `/bank_transfer/event/list` endpoint to get a list of ACH or bank transfer events based on specified filter criteria.
|
1064
1064
|
# @param bank_transfer_event_list_request [BankTransferEventListRequest]
|
1065
1065
|
# @param [Hash] opts the optional parameters
|
1066
1066
|
# @return [BankTransferEventListResponse]
|
@@ -1070,7 +1070,7 @@ module Plaid
|
|
1070
1070
|
end
|
1071
1071
|
|
1072
1072
|
# List bank transfer events
|
1073
|
-
# Use the `/bank_transfer/event/list` endpoint to get a list of bank transfer events based on specified filter criteria.
|
1073
|
+
# Use the `/bank_transfer/event/list` endpoint to get a list of ACH or bank transfer events based on specified filter criteria.
|
1074
1074
|
# @param bank_transfer_event_list_request [BankTransferEventListRequest]
|
1075
1075
|
# @param [Hash] opts the optional parameters
|
1076
1076
|
# @return [Array<(BankTransferEventListResponse, Integer, Hash)>] BankTransferEventListResponse data, response status code and response headers
|
@@ -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`.
|
1128
|
+
# `/bank_transfer/event/sync` allows you to request up to the next 25 bank transfer events that happened after a specific `event_id`. When using Auth with micro-deposit verification enabled, this endpoint can be used to fetch status updates on ACH micro-deposits. For more details, see [micro-deposit events](https://www.plaid.com/docs/auth/coverage/microdeposit-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`.
|
1138
|
+
# `/bank_transfer/event/sync` allows you to request up to the next 25 bank transfer events that happened after a specific `event_id`. When using Auth with micro-deposit verification enabled, this endpoint can be used to fetch status updates on ACH micro-deposits. For more details, see [micro-deposit events](https://www.plaid.com/docs/auth/coverage/microdeposit-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
|
@@ -1774,6 +1774,71 @@ module Plaid
|
|
1774
1774
|
return data, status_code, headers
|
1775
1775
|
end
|
1776
1776
|
|
1777
|
+
# Update an Audit Copy Token
|
1778
|
+
# The `/credit/audit_copy_token/update` endpoint updates the Audit Copy Token by adding the report tokens in the `report_tokens` field to the `audit_copy_token`. If the Audit Copy Token already contains a report of a certain type, it will be replaced with the token provided in the `report_tokens` field.
|
1779
|
+
# @param credit_audit_copy_token_update_request [CreditAuditCopyTokenUpdateRequest]
|
1780
|
+
# @param [Hash] opts the optional parameters
|
1781
|
+
# @return [CreditAuditCopyTokenUpdateResponse]
|
1782
|
+
def credit_audit_copy_token_update(credit_audit_copy_token_update_request, opts = {})
|
1783
|
+
data, _status_code, _headers = credit_audit_copy_token_update_with_http_info(credit_audit_copy_token_update_request, opts)
|
1784
|
+
data
|
1785
|
+
end
|
1786
|
+
|
1787
|
+
# Update an Audit Copy Token
|
1788
|
+
# The `/credit/audit_copy_token/update` endpoint updates the Audit Copy Token by adding the report tokens in the `report_tokens` field to the `audit_copy_token`. If the Audit Copy Token already contains a report of a certain type, it will be replaced with the token provided in the `report_tokens` field.
|
1789
|
+
# @param credit_audit_copy_token_update_request [CreditAuditCopyTokenUpdateRequest]
|
1790
|
+
# @param [Hash] opts the optional parameters
|
1791
|
+
# @return [Array<(CreditAuditCopyTokenUpdateResponse, Integer, Hash)>] CreditAuditCopyTokenUpdateResponse data, response status code and response headers
|
1792
|
+
def credit_audit_copy_token_update_with_http_info(credit_audit_copy_token_update_request, opts = {})
|
1793
|
+
if @api_client.config.debugging
|
1794
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.credit_audit_copy_token_update ...'
|
1795
|
+
end
|
1796
|
+
# verify the required parameter 'credit_audit_copy_token_update_request' is set
|
1797
|
+
if @api_client.config.client_side_validation && credit_audit_copy_token_update_request.nil?
|
1798
|
+
fail ArgumentError, "Missing the required parameter 'credit_audit_copy_token_update_request' when calling PlaidApi.credit_audit_copy_token_update"
|
1799
|
+
end
|
1800
|
+
# resource path
|
1801
|
+
local_var_path = '/credit/audit_copy_token/update'
|
1802
|
+
|
1803
|
+
# query parameters
|
1804
|
+
query_params = opts[:query_params] || {}
|
1805
|
+
|
1806
|
+
# header parameters
|
1807
|
+
header_params = opts[:header_params] || {}
|
1808
|
+
# HTTP header 'Accept' (if needed)
|
1809
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1810
|
+
# HTTP header 'Content-Type'
|
1811
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
1812
|
+
|
1813
|
+
# form parameters
|
1814
|
+
form_params = opts[:form_params] || {}
|
1815
|
+
|
1816
|
+
# http body (model)
|
1817
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(credit_audit_copy_token_update_request)
|
1818
|
+
|
1819
|
+
# return_type
|
1820
|
+
return_type = opts[:debug_return_type] || 'CreditAuditCopyTokenUpdateResponse'
|
1821
|
+
|
1822
|
+
# auth_names
|
1823
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
1824
|
+
|
1825
|
+
new_options = opts.merge(
|
1826
|
+
:operation => :"PlaidApi.credit_audit_copy_token_update",
|
1827
|
+
:header_params => header_params,
|
1828
|
+
:query_params => query_params,
|
1829
|
+
:form_params => form_params,
|
1830
|
+
:body => post_body,
|
1831
|
+
:auth_names => auth_names,
|
1832
|
+
:return_type => return_type
|
1833
|
+
)
|
1834
|
+
|
1835
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
1836
|
+
if @api_client.config.debugging
|
1837
|
+
@api_client.config.logger.debug "API called: PlaidApi#credit_audit_copy_token_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1838
|
+
end
|
1839
|
+
return data, status_code, headers
|
1840
|
+
end
|
1841
|
+
|
1777
1842
|
# Retrieve information from the bank accounts used for income verification
|
1778
1843
|
# `/credit/bank_income/get` returns the bank income report(s) for a specified user.
|
1779
1844
|
# @param credit_bank_income_get_request [CreditBankIncomeGetRequest]
|
@@ -1906,26 +1971,26 @@ module Plaid
|
|
1906
1971
|
|
1907
1972
|
# Refresh a user's bank income information
|
1908
1973
|
# `/credit/bank_income/refresh` refreshes the bank income report data for a specific user.
|
1909
|
-
# @param
|
1974
|
+
# @param request_body [Hash<String, Object>]
|
1910
1975
|
# @param [Hash] opts the optional parameters
|
1911
1976
|
# @return [CreditBankIncomeRefreshResponse]
|
1912
|
-
def credit_bank_income_refresh(
|
1913
|
-
data, _status_code, _headers = credit_bank_income_refresh_with_http_info(
|
1977
|
+
def credit_bank_income_refresh(request_body, opts = {})
|
1978
|
+
data, _status_code, _headers = credit_bank_income_refresh_with_http_info(request_body, opts)
|
1914
1979
|
data
|
1915
1980
|
end
|
1916
1981
|
|
1917
1982
|
# Refresh a user's bank income information
|
1918
1983
|
# `/credit/bank_income/refresh` refreshes the bank income report data for a specific user.
|
1919
|
-
# @param
|
1984
|
+
# @param request_body [Hash<String, Object>]
|
1920
1985
|
# @param [Hash] opts the optional parameters
|
1921
1986
|
# @return [Array<(CreditBankIncomeRefreshResponse, Integer, Hash)>] CreditBankIncomeRefreshResponse data, response status code and response headers
|
1922
|
-
def credit_bank_income_refresh_with_http_info(
|
1987
|
+
def credit_bank_income_refresh_with_http_info(request_body, opts = {})
|
1923
1988
|
if @api_client.config.debugging
|
1924
1989
|
@api_client.config.logger.debug 'Calling API: PlaidApi.credit_bank_income_refresh ...'
|
1925
1990
|
end
|
1926
|
-
# verify the required parameter '
|
1927
|
-
if @api_client.config.client_side_validation &&
|
1928
|
-
fail ArgumentError, "Missing the required parameter '
|
1991
|
+
# verify the required parameter 'request_body' is set
|
1992
|
+
if @api_client.config.client_side_validation && request_body.nil?
|
1993
|
+
fail ArgumentError, "Missing the required parameter 'request_body' when calling PlaidApi.credit_bank_income_refresh"
|
1929
1994
|
end
|
1930
1995
|
# resource path
|
1931
1996
|
local_var_path = '/credit/bank_income/refresh'
|
@@ -1944,7 +2009,7 @@ module Plaid
|
|
1944
2009
|
form_params = opts[:form_params] || {}
|
1945
2010
|
|
1946
2011
|
# http body (model)
|
1947
|
-
post_body = opts[:debug_body] || @api_client.object_to_http_body(
|
2012
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(request_body)
|
1948
2013
|
|
1949
2014
|
# return_type
|
1950
2015
|
return_type = opts[:debug_return_type] || 'CreditBankIncomeRefreshResponse'
|
@@ -2034,6 +2099,71 @@ module Plaid
|
|
2034
2099
|
return data, status_code, headers
|
2035
2100
|
end
|
2036
2101
|
|
2102
|
+
# Retrieve an Asset Report with Freddie Mac format (aka VOA - Verification Of Assets), and a Verification Of Employment (VOE) report if this one is available. Only Freddie Mac can use this endpoint.
|
2103
|
+
# The `credit/asset_report/freddie_mac/get` endpoint retrieves the Verification of Assets and Verification of Employment reports.
|
2104
|
+
# @param request_body [Hash<String, Object>]
|
2105
|
+
# @param [Hash] opts the optional parameters
|
2106
|
+
# @return [CreditFreddieMacReportsGetResponse]
|
2107
|
+
def credit_freddie_mac_reports_get(request_body, opts = {})
|
2108
|
+
data, _status_code, _headers = credit_freddie_mac_reports_get_with_http_info(request_body, opts)
|
2109
|
+
data
|
2110
|
+
end
|
2111
|
+
|
2112
|
+
# Retrieve an Asset Report with Freddie Mac format (aka VOA - Verification Of Assets), and a Verification Of Employment (VOE) report if this one is available. Only Freddie Mac can use this endpoint.
|
2113
|
+
# The `credit/asset_report/freddie_mac/get` endpoint retrieves the Verification of Assets and Verification of Employment reports.
|
2114
|
+
# @param request_body [Hash<String, Object>]
|
2115
|
+
# @param [Hash] opts the optional parameters
|
2116
|
+
# @return [Array<(CreditFreddieMacReportsGetResponse, Integer, Hash)>] CreditFreddieMacReportsGetResponse data, response status code and response headers
|
2117
|
+
def credit_freddie_mac_reports_get_with_http_info(request_body, opts = {})
|
2118
|
+
if @api_client.config.debugging
|
2119
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.credit_freddie_mac_reports_get ...'
|
2120
|
+
end
|
2121
|
+
# verify the required parameter 'request_body' is set
|
2122
|
+
if @api_client.config.client_side_validation && request_body.nil?
|
2123
|
+
fail ArgumentError, "Missing the required parameter 'request_body' when calling PlaidApi.credit_freddie_mac_reports_get"
|
2124
|
+
end
|
2125
|
+
# resource path
|
2126
|
+
local_var_path = '/credit/freddie_mac/reports/get'
|
2127
|
+
|
2128
|
+
# query parameters
|
2129
|
+
query_params = opts[:query_params] || {}
|
2130
|
+
|
2131
|
+
# header parameters
|
2132
|
+
header_params = opts[:header_params] || {}
|
2133
|
+
# HTTP header 'Accept' (if needed)
|
2134
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
2135
|
+
# HTTP header 'Content-Type'
|
2136
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
2137
|
+
|
2138
|
+
# form parameters
|
2139
|
+
form_params = opts[:form_params] || {}
|
2140
|
+
|
2141
|
+
# http body (model)
|
2142
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(request_body)
|
2143
|
+
|
2144
|
+
# return_type
|
2145
|
+
return_type = opts[:debug_return_type] || 'CreditFreddieMacReportsGetResponse'
|
2146
|
+
|
2147
|
+
# auth_names
|
2148
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
2149
|
+
|
2150
|
+
new_options = opts.merge(
|
2151
|
+
:operation => :"PlaidApi.credit_freddie_mac_reports_get",
|
2152
|
+
:header_params => header_params,
|
2153
|
+
:query_params => query_params,
|
2154
|
+
:form_params => form_params,
|
2155
|
+
:body => post_body,
|
2156
|
+
:auth_names => auth_names,
|
2157
|
+
:return_type => return_type
|
2158
|
+
)
|
2159
|
+
|
2160
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
2161
|
+
if @api_client.config.debugging
|
2162
|
+
@api_client.config.logger.debug "API called: PlaidApi#credit_freddie_mac_reports_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2163
|
+
end
|
2164
|
+
return data, status_code, headers
|
2165
|
+
end
|
2166
|
+
|
2037
2167
|
# Retrieve a user's payroll information
|
2038
2168
|
# This endpoint gets payroll income information for a specific user, either as a result of the user connecting to their payroll provider or uploading a pay related document.
|
2039
2169
|
# @param credit_payroll_income_get_request [CreditPayrollIncomeGetRequest]
|
@@ -2229,8 +2359,8 @@ module Plaid
|
|
2229
2359
|
return data, status_code, headers
|
2230
2360
|
end
|
2231
2361
|
|
2232
|
-
# Create a
|
2233
|
-
# Plaid can share an Asset Report directly with a participating third party on your behalf. The shared Asset Report is the exact same Asset Report originally created in `/asset_report/create`. To grant access to an Asset Report
|
2362
|
+
# Create a relay token to share an Asset Report with a partner client (beta)
|
2363
|
+
# Plaid can share an Asset Report directly with a participating third party on your behalf. The shared Asset Report is the exact same Asset Report originally created in `/asset_report/create`. To grant a third party access to an Asset Report, use the `/credit/relay/create` endpoint to create a `relay_token` and then pass that token to your third party. Each third party has its own `secondary_client_id`; for example, `ce5bd328dcd34123456`. You'll need to create a separate `relay_token` for each third party that needs access to the report on your behalf.
|
2234
2364
|
# @param credit_relay_create_request [CreditRelayCreateRequest]
|
2235
2365
|
# @param [Hash] opts the optional parameters
|
2236
2366
|
# @return [CreditRelayCreateResponse]
|
@@ -2239,8 +2369,8 @@ module Plaid
|
|
2239
2369
|
data
|
2240
2370
|
end
|
2241
2371
|
|
2242
|
-
# Create a
|
2243
|
-
# Plaid can share an Asset Report directly with a participating third party on your behalf. The shared Asset Report is the exact same Asset Report originally created in `/asset_report/create`. To grant access to an Asset Report
|
2372
|
+
# Create a relay token to share an Asset Report with a partner client (beta)
|
2373
|
+
# Plaid can share an Asset Report directly with a participating third party on your behalf. The shared Asset Report is the exact same Asset Report originally created in `/asset_report/create`. To grant a third party access to an Asset Report, use the `/credit/relay/create` endpoint to create a `relay_token` and then pass that token to your third party. Each third party has its own `secondary_client_id`; for example, `ce5bd328dcd34123456`. You'll need to create a separate `relay_token` for each third party that needs access to the report on your behalf.
|
2244
2374
|
# @param credit_relay_create_request [CreditRelayCreateRequest]
|
2245
2375
|
# @param [Hash] opts the optional parameters
|
2246
2376
|
# @return [Array<(CreditRelayCreateResponse, Integer, Hash)>] CreditRelayCreateResponse data, response status code and response headers
|
@@ -2294,8 +2424,8 @@ module Plaid
|
|
2294
2424
|
return data, status_code, headers
|
2295
2425
|
end
|
2296
2426
|
|
2297
|
-
# Retrieve the reports associated with a
|
2298
|
-
# `/credit/relay/get` allows third parties to
|
2427
|
+
# Retrieve the reports associated with a relay token that was shared with you (beta)
|
2428
|
+
# `/credit/relay/get` allows third parties to receive a report that was shared with them, using a `relay_token` that was created by the report owner.
|
2299
2429
|
# @param credit_relay_get_request [CreditRelayGetRequest]
|
2300
2430
|
# @param [Hash] opts the optional parameters
|
2301
2431
|
# @return [AssetReportGetResponse]
|
@@ -2304,8 +2434,8 @@ module Plaid
|
|
2304
2434
|
data
|
2305
2435
|
end
|
2306
2436
|
|
2307
|
-
# Retrieve the reports associated with a
|
2308
|
-
# `/credit/relay/get` allows third parties to
|
2437
|
+
# Retrieve the reports associated with a relay token that was shared with you (beta)
|
2438
|
+
# `/credit/relay/get` allows third parties to receive a report that was shared with them, using a `relay_token` that was created by the report owner.
|
2309
2439
|
# @param credit_relay_get_request [CreditRelayGetRequest]
|
2310
2440
|
# @param [Hash] opts the optional parameters
|
2311
2441
|
# @return [Array<(AssetReportGetResponse, Integer, Hash)>] AssetReportGetResponse data, response status code and response headers
|
@@ -2359,8 +2489,8 @@ module Plaid
|
|
2359
2489
|
return data, status_code, headers
|
2360
2490
|
end
|
2361
2491
|
|
2362
|
-
# Refresh a report of a
|
2363
|
-
# The `/credit/relay/refresh` endpoint allows third parties to refresh
|
2492
|
+
# Refresh a report of a relay token (beta)
|
2493
|
+
# The `/credit/relay/refresh` endpoint allows third parties to refresh a report that was relayed to them, using a `relay_token` that was created by the report owner. A new report will be created with the original report parameters, but with the most recent data available based on the `days_requested` value of the original report.
|
2364
2494
|
# @param credit_relay_refresh_request [CreditRelayRefreshRequest]
|
2365
2495
|
# @param [Hash] opts the optional parameters
|
2366
2496
|
# @return [CreditRelayRefreshResponse]
|
@@ -2369,8 +2499,8 @@ module Plaid
|
|
2369
2499
|
data
|
2370
2500
|
end
|
2371
2501
|
|
2372
|
-
# Refresh a report of a
|
2373
|
-
# The `/credit/relay/refresh` endpoint allows third parties to refresh
|
2502
|
+
# Refresh a report of a relay token (beta)
|
2503
|
+
# The `/credit/relay/refresh` endpoint allows third parties to refresh a report that was relayed to them, using a `relay_token` that was created by the report owner. A new report will be created with the original report parameters, but with the most recent data available based on the `days_requested` value of the original report.
|
2374
2504
|
# @param credit_relay_refresh_request [CreditRelayRefreshRequest]
|
2375
2505
|
# @param [Hash] opts the optional parameters
|
2376
2506
|
# @return [Array<(CreditRelayRefreshResponse, Integer, Hash)>] CreditRelayRefreshResponse data, response status code and response headers
|
@@ -2424,8 +2554,8 @@ module Plaid
|
|
2424
2554
|
return data, status_code, headers
|
2425
2555
|
end
|
2426
2556
|
|
2427
|
-
# Remove
|
2428
|
-
# The `/credit/relay/remove` endpoint allows you to invalidate a `relay_token
|
2557
|
+
# Remove relay token (beta)
|
2558
|
+
# The `/credit/relay/remove` endpoint allows you to invalidate a `relay_token`. The third party holding the token will no longer be able to access or refresh the reports which the `relay_token` gives access to. The original report, associated Items, and other relay tokens that provide access to the same report are not affected and will remain accessible after removing the given `relay_token`.
|
2429
2559
|
# @param credit_relay_remove_request [CreditRelayRemoveRequest]
|
2430
2560
|
# @param [Hash] opts the optional parameters
|
2431
2561
|
# @return [CreditRelayRemoveResponse]
|
@@ -2434,8 +2564,8 @@ module Plaid
|
|
2434
2564
|
data
|
2435
2565
|
end
|
2436
2566
|
|
2437
|
-
# Remove
|
2438
|
-
# The `/credit/relay/remove` endpoint allows you to invalidate a `relay_token`
|
2567
|
+
# Remove relay token (beta)
|
2568
|
+
# The `/credit/relay/remove` endpoint allows you to invalidate a `relay_token`. The third party holding the token will no longer be able to access or refresh the reports which the `relay_token` gives access to. The original report, associated Items, and other relay tokens that provide access to the same report are not affected and will remain accessible after removing the given `relay_token`.
|
2439
2569
|
# @param credit_relay_remove_request [CreditRelayRemoveRequest]
|
2440
2570
|
# @param [Hash] opts the optional parameters
|
2441
2571
|
# @return [Array<(CreditRelayRemoveResponse, Integer, Hash)>] CreditRelayRemoveResponse data, response status code and response headers
|
@@ -4180,7 +4310,7 @@ module Plaid
|
|
4180
4310
|
end
|
4181
4311
|
|
4182
4312
|
# Get investment transactions
|
4183
|
-
# The `/investments/transactions/get` endpoint allows developers to retrieve up to 24 months of user-authorized transaction data for investment accounts. Transactions are returned in reverse-chronological order, and the sequence of transaction ordering is stable and will not shift. Due to the potentially large number of investment transactions associated with an Item, results are paginated. Manipulate the count and offset parameters in conjunction with the `total_investment_transactions` response body field to fetch all available investment transactions.
|
4313
|
+
# The `/investments/transactions/get` endpoint allows developers to retrieve up to 24 months of user-authorized transaction data for investment accounts. Transactions are returned in reverse-chronological order, and the sequence of transaction ordering is stable and will not shift. Due to the potentially large number of investment transactions associated with an Item, results are paginated. Manipulate the count and offset parameters in conjunction with the `total_investment_transactions` response body field to fetch all available investment transactions. Note that Investments does not have a webhook to indicate when initial transaction data has loaded. Instead, if transactions data is not ready when `/investments/transactions/get` is first called, Plaid will wait for the data. For this reason, calling `/investments/transactions/get` immediately after Link may take up to one to two minutes to return.
|
4184
4314
|
# @param investments_transactions_get_request [InvestmentsTransactionsGetRequest]
|
4185
4315
|
# @param [Hash] opts the optional parameters
|
4186
4316
|
# @return [InvestmentsTransactionsGetResponse]
|
@@ -4190,7 +4320,7 @@ module Plaid
|
|
4190
4320
|
end
|
4191
4321
|
|
4192
4322
|
# Get investment transactions
|
4193
|
-
# The `/investments/transactions/get` endpoint allows developers to retrieve up to 24 months of user-authorized transaction data for investment accounts. Transactions are returned in reverse-chronological order, and the sequence of transaction ordering is stable and will not shift. Due to the potentially large number of investment transactions associated with an Item, results are paginated. Manipulate the count and offset parameters in conjunction with the `total_investment_transactions` response body field to fetch all available investment transactions.
|
4323
|
+
# The `/investments/transactions/get` endpoint allows developers to retrieve up to 24 months of user-authorized transaction data for investment accounts. Transactions are returned in reverse-chronological order, and the sequence of transaction ordering is stable and will not shift. Due to the potentially large number of investment transactions associated with an Item, results are paginated. Manipulate the count and offset parameters in conjunction with the `total_investment_transactions` response body field to fetch all available investment transactions. Note that Investments does not have a webhook to indicate when initial transaction data has loaded. Instead, if transactions data is not ready when `/investments/transactions/get` is first called, Plaid will wait for the data. For this reason, calling `/investments/transactions/get` immediately after Link may take up to one to two minutes to return.
|
4194
4324
|
# @param investments_transactions_get_request [InvestmentsTransactionsGetRequest]
|
4195
4325
|
# @param [Hash] opts the optional parameters
|
4196
4326
|
# @return [Array<(InvestmentsTransactionsGetResponse, Integer, Hash)>] InvestmentsTransactionsGetResponse data, response status code and response headers
|
@@ -4309,6 +4439,71 @@ module Plaid
|
|
4309
4439
|
return data, status_code, headers
|
4310
4440
|
end
|
4311
4441
|
|
4442
|
+
# List a historical log of user consent events
|
4443
|
+
# List a historical log of user consent events
|
4444
|
+
# @param item_activity_list_request [ItemActivityListRequest]
|
4445
|
+
# @param [Hash] opts the optional parameters
|
4446
|
+
# @return [ItemActivityListResponse]
|
4447
|
+
def item_activity_list(item_activity_list_request, opts = {})
|
4448
|
+
data, _status_code, _headers = item_activity_list_with_http_info(item_activity_list_request, opts)
|
4449
|
+
data
|
4450
|
+
end
|
4451
|
+
|
4452
|
+
# List a historical log of user consent events
|
4453
|
+
# List a historical log of user consent events
|
4454
|
+
# @param item_activity_list_request [ItemActivityListRequest]
|
4455
|
+
# @param [Hash] opts the optional parameters
|
4456
|
+
# @return [Array<(ItemActivityListResponse, Integer, Hash)>] ItemActivityListResponse data, response status code and response headers
|
4457
|
+
def item_activity_list_with_http_info(item_activity_list_request, opts = {})
|
4458
|
+
if @api_client.config.debugging
|
4459
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.item_activity_list ...'
|
4460
|
+
end
|
4461
|
+
# verify the required parameter 'item_activity_list_request' is set
|
4462
|
+
if @api_client.config.client_side_validation && item_activity_list_request.nil?
|
4463
|
+
fail ArgumentError, "Missing the required parameter 'item_activity_list_request' when calling PlaidApi.item_activity_list"
|
4464
|
+
end
|
4465
|
+
# resource path
|
4466
|
+
local_var_path = '/item/activity/list'
|
4467
|
+
|
4468
|
+
# query parameters
|
4469
|
+
query_params = opts[:query_params] || {}
|
4470
|
+
|
4471
|
+
# header parameters
|
4472
|
+
header_params = opts[:header_params] || {}
|
4473
|
+
# HTTP header 'Accept' (if needed)
|
4474
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
4475
|
+
# HTTP header 'Content-Type'
|
4476
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
4477
|
+
|
4478
|
+
# form parameters
|
4479
|
+
form_params = opts[:form_params] || {}
|
4480
|
+
|
4481
|
+
# http body (model)
|
4482
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(item_activity_list_request)
|
4483
|
+
|
4484
|
+
# return_type
|
4485
|
+
return_type = opts[:debug_return_type] || 'ItemActivityListResponse'
|
4486
|
+
|
4487
|
+
# auth_names
|
4488
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
4489
|
+
|
4490
|
+
new_options = opts.merge(
|
4491
|
+
:operation => :"PlaidApi.item_activity_list",
|
4492
|
+
:header_params => header_params,
|
4493
|
+
:query_params => query_params,
|
4494
|
+
:form_params => form_params,
|
4495
|
+
:body => post_body,
|
4496
|
+
:auth_names => auth_names,
|
4497
|
+
:return_type => return_type
|
4498
|
+
)
|
4499
|
+
|
4500
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
4501
|
+
if @api_client.config.debugging
|
4502
|
+
@api_client.config.logger.debug "API called: PlaidApi#item_activity_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
4503
|
+
end
|
4504
|
+
return data, status_code, headers
|
4505
|
+
end
|
4506
|
+
|
4312
4507
|
# List a user’s connected applications
|
4313
4508
|
# List a user’s connected applications
|
4314
4509
|
# @param item_application_list_request [ItemApplicationListRequest]
|
@@ -5414,6 +5609,71 @@ module Plaid
|
|
5414
5609
|
return data, status_code, headers
|
5415
5610
|
end
|
5416
5611
|
|
5612
|
+
# Returns OAuth-institution registration information for a given end customer.
|
5613
|
+
# The `/partner/customer/oauth_institutions/get` endpoint is used by reseller partners to retrieve OAuth-institution registration information about a single end customer.
|
5614
|
+
# @param partner_customer_o_auth_institutions_get_request [PartnerCustomerOAuthInstitutionsGetRequest]
|
5615
|
+
# @param [Hash] opts the optional parameters
|
5616
|
+
# @return [PartnerCustomerOAuthInstitutionsGetResponse]
|
5617
|
+
def partner_customer_oauth_institutions_get(partner_customer_o_auth_institutions_get_request, opts = {})
|
5618
|
+
data, _status_code, _headers = partner_customer_oauth_institutions_get_with_http_info(partner_customer_o_auth_institutions_get_request, opts)
|
5619
|
+
data
|
5620
|
+
end
|
5621
|
+
|
5622
|
+
# Returns OAuth-institution registration information for a given end customer.
|
5623
|
+
# The `/partner/customer/oauth_institutions/get` endpoint is used by reseller partners to retrieve OAuth-institution registration information about a single end customer.
|
5624
|
+
# @param partner_customer_o_auth_institutions_get_request [PartnerCustomerOAuthInstitutionsGetRequest]
|
5625
|
+
# @param [Hash] opts the optional parameters
|
5626
|
+
# @return [Array<(PartnerCustomerOAuthInstitutionsGetResponse, Integer, Hash)>] PartnerCustomerOAuthInstitutionsGetResponse data, response status code and response headers
|
5627
|
+
def partner_customer_oauth_institutions_get_with_http_info(partner_customer_o_auth_institutions_get_request, opts = {})
|
5628
|
+
if @api_client.config.debugging
|
5629
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.partner_customer_oauth_institutions_get ...'
|
5630
|
+
end
|
5631
|
+
# verify the required parameter 'partner_customer_o_auth_institutions_get_request' is set
|
5632
|
+
if @api_client.config.client_side_validation && partner_customer_o_auth_institutions_get_request.nil?
|
5633
|
+
fail ArgumentError, "Missing the required parameter 'partner_customer_o_auth_institutions_get_request' when calling PlaidApi.partner_customer_oauth_institutions_get"
|
5634
|
+
end
|
5635
|
+
# resource path
|
5636
|
+
local_var_path = '/partner/customer/oauth_institutions/get'
|
5637
|
+
|
5638
|
+
# query parameters
|
5639
|
+
query_params = opts[:query_params] || {}
|
5640
|
+
|
5641
|
+
# header parameters
|
5642
|
+
header_params = opts[:header_params] || {}
|
5643
|
+
# HTTP header 'Accept' (if needed)
|
5644
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
5645
|
+
# HTTP header 'Content-Type'
|
5646
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
5647
|
+
|
5648
|
+
# form parameters
|
5649
|
+
form_params = opts[:form_params] || {}
|
5650
|
+
|
5651
|
+
# http body (model)
|
5652
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(partner_customer_o_auth_institutions_get_request)
|
5653
|
+
|
5654
|
+
# return_type
|
5655
|
+
return_type = opts[:debug_return_type] || 'PartnerCustomerOAuthInstitutionsGetResponse'
|
5656
|
+
|
5657
|
+
# auth_names
|
5658
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
5659
|
+
|
5660
|
+
new_options = opts.merge(
|
5661
|
+
:operation => :"PlaidApi.partner_customer_oauth_institutions_get",
|
5662
|
+
:header_params => header_params,
|
5663
|
+
:query_params => query_params,
|
5664
|
+
:form_params => form_params,
|
5665
|
+
:body => post_body,
|
5666
|
+
:auth_names => auth_names,
|
5667
|
+
:return_type => return_type
|
5668
|
+
)
|
5669
|
+
|
5670
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
5671
|
+
if @api_client.config.debugging
|
5672
|
+
@api_client.config.logger.debug "API called: PlaidApi#partner_customer_oauth_institutions_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
5673
|
+
end
|
5674
|
+
return data, status_code, headers
|
5675
|
+
end
|
5676
|
+
|
5417
5677
|
# Removes a Plaid reseller's end customer.
|
5418
5678
|
# The `/partner/customer/remove` endpoint is used by reseller partners to remove an end customer. Removing an end customer will remove it from view in the Plaid Dashboard and deactivate its API keys. This endpoint can only be used to remove an end customer that has not yet been enabled in Production.
|
5419
5679
|
# @param partner_customer_remove_request [PartnerCustomerRemoveRequest]
|
@@ -5740,7 +6000,7 @@ module Plaid
|
|
5740
6000
|
end
|
5741
6001
|
|
5742
6002
|
# Create a payment
|
5743
|
-
# After creating a payment recipient, you can use the `/payment_initiation/payment/create` endpoint to create a payment to that recipient. Payments can be one-time or standing order (recurring) and can be denominated in either EUR or
|
6003
|
+
# After creating a payment recipient, you can use the `/payment_initiation/payment/create` endpoint to create a payment to that recipient. Payments can be one-time or standing order (recurring) and can be denominated in either EUR, GBP or other chosen [currency](https://plaid.com/docs/api/products/payment-initiation/#payment_initiation-payment-create-request-amount-currency). If making domestic GBP-denominated payments, your recipient must have been created with BACS numbers. In general, EUR-denominated payments will be sent via SEPA Credit Transfer, GBP-denominated payments will be sent via the Faster Payments network and for non-Eurozone markets typically via the local payment scheme, but the payment network used will be determined by the institution. Payments sent via Faster Payments will typically arrive immediately, while payments sent via SEPA Credit Transfer or other local payment schemes will typically arrive in one business day. Standing orders (recurring payments) must be denominated in GBP and can only be sent to recipients in the UK. Once created, standing order payments cannot be modified or canceled via the API. An end user can cancel or modify a standing order directly on their banking application or website, or by contacting the bank. Standing orders will follow the payment rules of the underlying rails (Faster Payments in UK). Payments can be sent Monday to Friday, excluding bank holidays. If the pre-arranged date falls on a weekend or bank holiday, the payment is made on the next working day. It is not possible to guarantee the exact time the payment will reach the recipient’s account, although at least 90% of standing order payments are sent by 6am. In the Development environment, payments must be below 5 GBP or other chosen [currency](https://plaid.com/docs/api/products/payment-initiation/#payment_initiation-payment-create-request-amount-currency). For details on any payment limits in Production, contact your Plaid Account Manager.
|
5744
6004
|
# @param payment_initiation_payment_create_request [PaymentInitiationPaymentCreateRequest]
|
5745
6005
|
# @param [Hash] opts the optional parameters
|
5746
6006
|
# @return [PaymentInitiationPaymentCreateResponse]
|
@@ -5750,7 +6010,7 @@ module Plaid
|
|
5750
6010
|
end
|
5751
6011
|
|
5752
6012
|
# Create a payment
|
5753
|
-
# After creating a payment recipient, you can use the `/payment_initiation/payment/create` endpoint to create a payment to that recipient. Payments can be one-time or standing order (recurring) and can be denominated in either EUR or
|
6013
|
+
# After creating a payment recipient, you can use the `/payment_initiation/payment/create` endpoint to create a payment to that recipient. Payments can be one-time or standing order (recurring) and can be denominated in either EUR, GBP or other chosen [currency](https://plaid.com/docs/api/products/payment-initiation/#payment_initiation-payment-create-request-amount-currency). If making domestic GBP-denominated payments, your recipient must have been created with BACS numbers. In general, EUR-denominated payments will be sent via SEPA Credit Transfer, GBP-denominated payments will be sent via the Faster Payments network and for non-Eurozone markets typically via the local payment scheme, but the payment network used will be determined by the institution. Payments sent via Faster Payments will typically arrive immediately, while payments sent via SEPA Credit Transfer or other local payment schemes will typically arrive in one business day. Standing orders (recurring payments) must be denominated in GBP and can only be sent to recipients in the UK. Once created, standing order payments cannot be modified or canceled via the API. An end user can cancel or modify a standing order directly on their banking application or website, or by contacting the bank. Standing orders will follow the payment rules of the underlying rails (Faster Payments in UK). Payments can be sent Monday to Friday, excluding bank holidays. If the pre-arranged date falls on a weekend or bank holiday, the payment is made on the next working day. It is not possible to guarantee the exact time the payment will reach the recipient’s account, although at least 90% of standing order payments are sent by 6am. In the Development environment, payments must be below 5 GBP or other chosen [currency](https://plaid.com/docs/api/products/payment-initiation/#payment_initiation-payment-create-request-amount-currency). For details on any payment limits in Production, contact your Plaid Account Manager.
|
5754
6014
|
# @param payment_initiation_payment_create_request [PaymentInitiationPaymentCreateRequest]
|
5755
6015
|
# @param [Hash] opts the optional parameters
|
5756
6016
|
# @return [Array<(PaymentInitiationPaymentCreateResponse, Integer, Hash)>] PaymentInitiationPaymentCreateResponse data, response status code and response headers
|
@@ -5935,7 +6195,7 @@ module Plaid
|
|
5935
6195
|
end
|
5936
6196
|
|
5937
6197
|
# Reverse an existing payment
|
5938
|
-
# Reverse a
|
6198
|
+
# Reverse a settled payment from a Plaid virtual account. The original payment must be in a settled state to be refunded. To refund partially, specify the amount as part of the request. If the amount is not specified, the refund amount will be equal to all of the remaining payment amount that has not been refunded yet. If the remaining amount is less than one unit of currency (e.g. 1 GBP or 1 EUR), the refund will fail. The refund will go back to the source account that initiated the payment. The original payment must have been initiated to a Plaid virtual account so that this account can be used to initiate the refund.
|
5939
6199
|
# @param payment_initiation_payment_reverse_request [PaymentInitiationPaymentReverseRequest]
|
5940
6200
|
# @param [Hash] opts the optional parameters
|
5941
6201
|
# @return [PaymentInitiationPaymentReverseResponse]
|
@@ -5945,7 +6205,7 @@ module Plaid
|
|
5945
6205
|
end
|
5946
6206
|
|
5947
6207
|
# Reverse an existing payment
|
5948
|
-
# Reverse a
|
6208
|
+
# Reverse a settled payment from a Plaid virtual account. The original payment must be in a settled state to be refunded. To refund partially, specify the amount as part of the request. If the amount is not specified, the refund amount will be equal to all of the remaining payment amount that has not been refunded yet. If the remaining amount is less than one unit of currency (e.g. 1 GBP or 1 EUR), the refund will fail. The refund will go back to the source account that initiated the payment. The original payment must have been initiated to a Plaid virtual account so that this account can be used to initiate the refund.
|
5949
6209
|
# @param payment_initiation_payment_reverse_request [PaymentInitiationPaymentReverseRequest]
|
5950
6210
|
# @param [Hash] opts the optional parameters
|
5951
6211
|
# @return [Array<(PaymentInitiationPaymentReverseResponse, Integer, Hash)>] PaymentInitiationPaymentReverseResponse data, response status code and response headers
|
@@ -6000,7 +6260,7 @@ module Plaid
|
|
6000
6260
|
end
|
6001
6261
|
|
6002
6262
|
# Create payment recipient
|
6003
|
-
# 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).
|
6263
|
+
# 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) or a non-Eurozone country [supported](https://plaid.com/global) by Plaid. For a standing order (recurring) payment, the recipient must be in the UK. It is recommended to use `bacs` in the UK and `iban` in EU. The endpoint is idempotent: if a developer has already made a request with the same payment details, Plaid will return the same `recipient_id`.
|
6004
6264
|
# @param payment_initiation_recipient_create_request [PaymentInitiationRecipientCreateRequest]
|
6005
6265
|
# @param [Hash] opts the optional parameters
|
6006
6266
|
# @return [PaymentInitiationRecipientCreateResponse]
|
@@ -6010,7 +6270,7 @@ module Plaid
|
|
6010
6270
|
end
|
6011
6271
|
|
6012
6272
|
# Create payment recipient
|
6013
|
-
# 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).
|
6273
|
+
# 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) or a non-Eurozone country [supported](https://plaid.com/global) by Plaid. For a standing order (recurring) payment, the recipient must be in the UK. It is recommended to use `bacs` in the UK and `iban` in EU. The endpoint is idempotent: if a developer has already made a request with the same payment details, Plaid will return the same `recipient_id`.
|
6014
6274
|
# @param payment_initiation_recipient_create_request [PaymentInitiationRecipientCreateRequest]
|
6015
6275
|
# @param [Hash] opts the optional parameters
|
6016
6276
|
# @return [Array<(PaymentInitiationRecipientCreateResponse, Integer, Hash)>] PaymentInitiationRecipientCreateResponse data, response status code and response headers
|
@@ -7755,7 +8015,7 @@ module Plaid
|
|
7755
8015
|
end
|
7756
8016
|
|
7757
8017
|
# Advance a test clock
|
7758
|
-
# Use the `/sandbox/transfer/test_clock/advance` endpoint to advance a `test_clock` in the Sandbox environment.
|
8018
|
+
# Use the `/sandbox/transfer/test_clock/advance` endpoint to advance a `test_clock` in the Sandbox environment. A test clock object represents an independent timeline and has a `virtual_time` field indicating the current timestamp of the timeline. A test clock can be advanced by incrementing `virtual_time`, but may never go back to a lower `virtual_time`. If a test clock is advanced, we will simulate the changes that ought to occur during the time that elapsed. For instance, a client creates a weekly recurring transfer with a test clock set at t. When the client advances the test clock by setting `virtual_time` = t + 15 days, 2 new originations should be created, along with the webhook events. The advancement of the test clock from its current `virtual_time` should be limited such that there are no more than 20 originations resulting from the advance operation on each `recurring_transfer` associated with the `test_clock`. For instance, if the recurring transfer associated with this test clock originates once every 4 weeks, you can advance the `virtual_time` up to 80 weeks on each API call.
|
7759
8019
|
# @param sandbox_transfer_test_clock_advance_request [SandboxTransferTestClockAdvanceRequest]
|
7760
8020
|
# @param [Hash] opts the optional parameters
|
7761
8021
|
# @return [SandboxTransferTestClockAdvanceResponse]
|
@@ -7765,7 +8025,7 @@ module Plaid
|
|
7765
8025
|
end
|
7766
8026
|
|
7767
8027
|
# Advance a test clock
|
7768
|
-
# Use the `/sandbox/transfer/test_clock/advance` endpoint to advance a `test_clock` in the Sandbox environment.
|
8028
|
+
# Use the `/sandbox/transfer/test_clock/advance` endpoint to advance a `test_clock` in the Sandbox environment. A test clock object represents an independent timeline and has a `virtual_time` field indicating the current timestamp of the timeline. A test clock can be advanced by incrementing `virtual_time`, but may never go back to a lower `virtual_time`. If a test clock is advanced, we will simulate the changes that ought to occur during the time that elapsed. For instance, a client creates a weekly recurring transfer with a test clock set at t. When the client advances the test clock by setting `virtual_time` = t + 15 days, 2 new originations should be created, along with the webhook events. The advancement of the test clock from its current `virtual_time` should be limited such that there are no more than 20 originations resulting from the advance operation on each `recurring_transfer` associated with the `test_clock`. For instance, if the recurring transfer associated with this test clock originates once every 4 weeks, you can advance the `virtual_time` up to 80 weeks on each API call.
|
7769
8029
|
# @param sandbox_transfer_test_clock_advance_request [SandboxTransferTestClockAdvanceRequest]
|
7770
8030
|
# @param [Hash] opts the optional parameters
|
7771
8031
|
# @return [Array<(SandboxTransferTestClockAdvanceResponse, Integer, Hash)>] SandboxTransferTestClockAdvanceResponse data, response status code and response headers
|
@@ -7820,7 +8080,7 @@ module Plaid
|
|
7820
8080
|
end
|
7821
8081
|
|
7822
8082
|
# Create a test clock
|
7823
|
-
# Use the `/sandbox/transfer/test_clock/create` endpoint to create a `test_clock` in the Sandbox environment.
|
8083
|
+
# Use the `/sandbox/transfer/test_clock/create` endpoint to create a `test_clock` in the Sandbox environment. A test clock object represents an independent timeline and has a `virtual_time` field indicating the current timestamp of the timeline. Test clocks are used for testing recurring transfers in Sandbox. A test clock can be associated with up to 5 recurring transfers.
|
7824
8084
|
# @param sandbox_transfer_test_clock_create_request [SandboxTransferTestClockCreateRequest]
|
7825
8085
|
# @param [Hash] opts the optional parameters
|
7826
8086
|
# @return [SandboxTransferTestClockCreateResponse]
|
@@ -7830,7 +8090,7 @@ module Plaid
|
|
7830
8090
|
end
|
7831
8091
|
|
7832
8092
|
# Create a test clock
|
7833
|
-
# Use the `/sandbox/transfer/test_clock/create` endpoint to create a `test_clock` in the Sandbox environment.
|
8093
|
+
# Use the `/sandbox/transfer/test_clock/create` endpoint to create a `test_clock` in the Sandbox environment. A test clock object represents an independent timeline and has a `virtual_time` field indicating the current timestamp of the timeline. Test clocks are used for testing recurring transfers in Sandbox. A test clock can be associated with up to 5 recurring transfers.
|
7834
8094
|
# @param sandbox_transfer_test_clock_create_request [SandboxTransferTestClockCreateRequest]
|
7835
8095
|
# @param [Hash] opts the optional parameters
|
7836
8096
|
# @return [Array<(SandboxTransferTestClockCreateResponse, Integer, Hash)>] SandboxTransferTestClockCreateResponse data, response status code and response headers
|
@@ -7949,6 +8209,71 @@ module Plaid
|
|
7949
8209
|
return data, status_code, headers
|
7950
8210
|
end
|
7951
8211
|
|
8212
|
+
# List test clocks
|
8213
|
+
# Use the `/sandbox/transfer/test_clock/list` endpoint to see a list of all your test clocks in the Sandbox environment, by ascending `virtual_time`. Results are paginated; use the `count` and `offset` query parameters to retrieve the desired test clocks.
|
8214
|
+
# @param sandbox_transfer_test_clock_list_request [SandboxTransferTestClockListRequest]
|
8215
|
+
# @param [Hash] opts the optional parameters
|
8216
|
+
# @return [SandboxTransferTestClockListResponse]
|
8217
|
+
def sandbox_transfer_test_clock_list(sandbox_transfer_test_clock_list_request, opts = {})
|
8218
|
+
data, _status_code, _headers = sandbox_transfer_test_clock_list_with_http_info(sandbox_transfer_test_clock_list_request, opts)
|
8219
|
+
data
|
8220
|
+
end
|
8221
|
+
|
8222
|
+
# List test clocks
|
8223
|
+
# Use the `/sandbox/transfer/test_clock/list` endpoint to see a list of all your test clocks in the Sandbox environment, by ascending `virtual_time`. Results are paginated; use the `count` and `offset` query parameters to retrieve the desired test clocks.
|
8224
|
+
# @param sandbox_transfer_test_clock_list_request [SandboxTransferTestClockListRequest]
|
8225
|
+
# @param [Hash] opts the optional parameters
|
8226
|
+
# @return [Array<(SandboxTransferTestClockListResponse, Integer, Hash)>] SandboxTransferTestClockListResponse data, response status code and response headers
|
8227
|
+
def sandbox_transfer_test_clock_list_with_http_info(sandbox_transfer_test_clock_list_request, opts = {})
|
8228
|
+
if @api_client.config.debugging
|
8229
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.sandbox_transfer_test_clock_list ...'
|
8230
|
+
end
|
8231
|
+
# verify the required parameter 'sandbox_transfer_test_clock_list_request' is set
|
8232
|
+
if @api_client.config.client_side_validation && sandbox_transfer_test_clock_list_request.nil?
|
8233
|
+
fail ArgumentError, "Missing the required parameter 'sandbox_transfer_test_clock_list_request' when calling PlaidApi.sandbox_transfer_test_clock_list"
|
8234
|
+
end
|
8235
|
+
# resource path
|
8236
|
+
local_var_path = '/sandbox/transfer/test_clock/list'
|
8237
|
+
|
8238
|
+
# query parameters
|
8239
|
+
query_params = opts[:query_params] || {}
|
8240
|
+
|
8241
|
+
# header parameters
|
8242
|
+
header_params = opts[:header_params] || {}
|
8243
|
+
# HTTP header 'Accept' (if needed)
|
8244
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
8245
|
+
# HTTP header 'Content-Type'
|
8246
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
8247
|
+
|
8248
|
+
# form parameters
|
8249
|
+
form_params = opts[:form_params] || {}
|
8250
|
+
|
8251
|
+
# http body (model)
|
8252
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(sandbox_transfer_test_clock_list_request)
|
8253
|
+
|
8254
|
+
# return_type
|
8255
|
+
return_type = opts[:debug_return_type] || 'SandboxTransferTestClockListResponse'
|
8256
|
+
|
8257
|
+
# auth_names
|
8258
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
8259
|
+
|
8260
|
+
new_options = opts.merge(
|
8261
|
+
:operation => :"PlaidApi.sandbox_transfer_test_clock_list",
|
8262
|
+
:header_params => header_params,
|
8263
|
+
:query_params => query_params,
|
8264
|
+
:form_params => form_params,
|
8265
|
+
:body => post_body,
|
8266
|
+
:auth_names => auth_names,
|
8267
|
+
:return_type => return_type
|
8268
|
+
)
|
8269
|
+
|
8270
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
8271
|
+
if @api_client.config.debugging
|
8272
|
+
@api_client.config.logger.debug "API called: PlaidApi#sandbox_transfer_test_clock_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
8273
|
+
end
|
8274
|
+
return data, status_code, headers
|
8275
|
+
end
|
8276
|
+
|
7952
8277
|
# Report whether you initiated an ACH transaction
|
7953
8278
|
# After calling `/signal/evaluate`, call `/signal/decision/report` to report whether the transaction was initiated. This endpoint will return an [`INVALID_FIELD`](/docs/errors/invalid-request/#invalid_field) error if called a second time with a different value for `initiated`.
|
7954
8279
|
# @param signal_decision_report_request [SignalDecisionReportRequest]
|
@@ -8210,7 +8535,7 @@ module Plaid
|
|
8210
8535
|
end
|
8211
8536
|
|
8212
8537
|
# enhance locally-held transaction data
|
8213
|
-
# The
|
8538
|
+
# The `/beta/transactions/v1/enhance` endpoint enriches raw transaction data provided directly by clients. The product is currently in beta.
|
8214
8539
|
# @param transactions_enhance_get_request [TransactionsEnhanceGetRequest]
|
8215
8540
|
# @param [Hash] opts the optional parameters
|
8216
8541
|
# @return [TransactionsEnhanceGetResponse]
|
@@ -8220,7 +8545,7 @@ module Plaid
|
|
8220
8545
|
end
|
8221
8546
|
|
8222
8547
|
# enhance locally-held transaction data
|
8223
|
-
# The &#
|
8548
|
+
# The `/beta/transactions/v1/enhance` endpoint enriches raw transaction data provided directly by clients. The product is currently in beta.
|
8224
8549
|
# @param transactions_enhance_get_request [TransactionsEnhanceGetRequest]
|
8225
8550
|
# @param [Hash] opts the optional parameters
|
8226
8551
|
# @return [Array<(TransactionsEnhanceGetResponse, Integer, Hash)>] TransactionsEnhanceGetResponse data, response status code and response headers
|
@@ -8275,7 +8600,7 @@ module Plaid
|
|
8275
8600
|
end
|
8276
8601
|
|
8277
8602
|
# Enrich locally-held transaction data
|
8278
|
-
# The
|
8603
|
+
# The `/transactions/enrich` endpoint enriches raw transaction data generated by your own banking products or retrieved from other non-Plaid sources. The product is currently in beta. To request access, contact enrich-feedback@plaid.com
|
8279
8604
|
# @param transactions_enrich_get_request [TransactionsEnrichGetRequest]
|
8280
8605
|
# @param [Hash] opts the optional parameters
|
8281
8606
|
# @return [TransactionsEnrichGetResponse]
|
@@ -8285,7 +8610,7 @@ module Plaid
|
|
8285
8610
|
end
|
8286
8611
|
|
8287
8612
|
# Enrich locally-held transaction data
|
8288
|
-
# The &#
|
8613
|
+
# The `/transactions/enrich` endpoint enriches raw transaction data generated by your own banking products or retrieved from other non-Plaid sources. The product is currently in beta. To request access, contact enrich-feedback@plaid.com
|
8289
8614
|
# @param transactions_enrich_get_request [TransactionsEnrichGetRequest]
|
8290
8615
|
# @param [Hash] opts the optional parameters
|
8291
8616
|
# @return [Array<(TransactionsEnrichGetResponse, Integer, Hash)>] TransactionsEnrichGetResponse data, response status code and response headers
|
@@ -8405,7 +8730,7 @@ module Plaid
|
|
8405
8730
|
end
|
8406
8731
|
|
8407
8732
|
# Fetch recurring transaction streams
|
8408
|
-
# The `/transactions/recurring/get` endpoint allows developers to receive a summary of the recurring outflow and inflow streams (expenses and deposits) from a user’s checking, savings or credit card accounts. Additionally, Plaid provides key insights about each recurring stream including the category, merchant, last amount, and more. Developers can use these insights to build tools and experiences that help their users better manage cash flow, monitor subscriptions, reduce spend, and stay on track with bill payments. This endpoint is not included by default as part of Transactions. To request access to this endpoint, submit a [product access request](https://dashboard.plaid.com/team/products) or contact your Plaid account manager.
|
8733
|
+
# The `/transactions/recurring/get` endpoint allows developers to receive a summary of the recurring outflow and inflow streams (expenses and deposits) from a user’s checking, savings or credit card accounts. Additionally, Plaid provides key insights about each recurring stream including the category, merchant, last amount, and more. Developers can use these insights to build tools and experiences that help their users better manage cash flow, monitor subscriptions, reduce spend, and stay on track with bill payments. This endpoint is not included by default as part of Transactions. To request access to this endpoint, submit a [product access request](https://dashboard.plaid.com/team/products) or contact your Plaid account manager. This endpoint can only be called on an Item that has already been initialized with Transactions (either during Link, by specifying it in `/link/token/create`; or after Link, by calling `/transactions/get`). After the [`HISTORICAL_UPDATE`](https://plaid.com/docs/api/products/transactions/#historical_update) webhook has fired, call `/transactions/recurring/get` to receive the Recurring Transactions streams and subscribe to the [`RECURRING_TRANSACTIONS_UPDATE`](https://plaid.com/docs/api/products/transactions/#recurring_transactions_update) webhook. After the initial call, you can call `/transactions/recurring/get` endpoint at any point in the future to retrieve the latest summary of recurring streams. Listen to the [`RECURRING_TRANSACTIONS_UPDATE`](https://plaid.com/docs/api/products/transactions/#recurring_transactions_update) webhook to be notified when new updates are available.
|
8409
8734
|
# @param transactions_recurring_get_request [TransactionsRecurringGetRequest]
|
8410
8735
|
# @param [Hash] opts the optional parameters
|
8411
8736
|
# @return [TransactionsRecurringGetResponse]
|
@@ -8415,7 +8740,7 @@ module Plaid
|
|
8415
8740
|
end
|
8416
8741
|
|
8417
8742
|
# Fetch recurring transaction streams
|
8418
|
-
# The `/transactions/recurring/get` endpoint allows developers to receive a summary of the recurring outflow and inflow streams (expenses and deposits) from a user’s checking, savings or credit card accounts. Additionally, Plaid provides key insights about each recurring stream including the category, merchant, last amount, and more. Developers can use these insights to build tools and experiences that help their users better manage cash flow, monitor subscriptions, reduce spend, and stay on track with bill payments. This endpoint is not included by default as part of Transactions. To request access to this endpoint, submit a [product access request](https://dashboard.plaid.com/team/products) or contact your Plaid account manager.
|
8743
|
+
# The `/transactions/recurring/get` endpoint allows developers to receive a summary of the recurring outflow and inflow streams (expenses and deposits) from a user’s checking, savings or credit card accounts. Additionally, Plaid provides key insights about each recurring stream including the category, merchant, last amount, and more. Developers can use these insights to build tools and experiences that help their users better manage cash flow, monitor subscriptions, reduce spend, and stay on track with bill payments. This endpoint is not included by default as part of Transactions. To request access to this endpoint, submit a [product access request](https://dashboard.plaid.com/team/products) or contact your Plaid account manager. This endpoint can only be called on an Item that has already been initialized with Transactions (either during Link, by specifying it in `/link/token/create`; or after Link, by calling `/transactions/get`). After the [`HISTORICAL_UPDATE`](https://plaid.com/docs/api/products/transactions/#historical_update) webhook has fired, call `/transactions/recurring/get` to receive the Recurring Transactions streams and subscribe to the [`RECURRING_TRANSACTIONS_UPDATE`](https://plaid.com/docs/api/products/transactions/#recurring_transactions_update) webhook. After the initial call, you can call `/transactions/recurring/get` endpoint at any point in the future to retrieve the latest summary of recurring streams. Listen to the [`RECURRING_TRANSACTIONS_UPDATE`](https://plaid.com/docs/api/products/transactions/#recurring_transactions_update) webhook to be notified when new updates are available.
|
8419
8744
|
# @param transactions_recurring_get_request [TransactionsRecurringGetRequest]
|
8420
8745
|
# @param [Hash] opts the optional parameters
|
8421
8746
|
# @return [Array<(TransactionsRecurringGetResponse, Integer, Hash)>] TransactionsRecurringGetResponse data, response status code and response headers
|
@@ -8730,7 +9055,7 @@ module Plaid
|
|
8730
9055
|
end
|
8731
9056
|
|
8732
9057
|
# Get incremental transaction updates on an Item
|
8733
|
-
# This endpoint replaces `/transactions/get` and its associated webhooks for most common use-cases. The `/transactions/sync` endpoint allows developers to subscribe to all transactions associated with an Item and get updates synchronously in a stream-like manner, using a cursor to track which updates have already been seen. `/transactions/sync` provides the same functionality as `/transactions/get` and can be used instead of `/transactions/get` to simplify the process of tracking transactions updates. This endpoint provides user-authorized transaction data for `credit`, `depository`, and some loan-type accounts (only those with account subtype `student`; coverage may be limited). For transaction history from `investments` accounts, use `/investments/transactions/get` instead. Returned transactions data is grouped into three types of update, indicating whether the transaction was added, removed, or modified since the last call to the API. In the first call to `/transactions/sync` for an Item, the endpoint will return all historical transactions data associated with that Item up until the time of the API call (as \"adds\"), which then generates a `next_cursor` for that Item. In subsequent calls, send the `next_cursor` to receive only the changes that have occurred since the previous call. Due to the potentially large number of transactions associated with an Item, results are paginated. The `has_more` field specifies if additional calls are necessary to fetch all available transaction updates. Call `/transactions/sync` with the new cursor, pulling all updates, until `has_more` is `false`.
|
9058
|
+
# This endpoint replaces `/transactions/get` and its associated webhooks for most common use-cases. The `/transactions/sync` endpoint allows developers to subscribe to all transactions associated with an Item and get updates synchronously in a stream-like manner, using a cursor to track which updates have already been seen. `/transactions/sync` provides the same functionality as `/transactions/get` and can be used instead of `/transactions/get` to simplify the process of tracking transactions updates. This endpoint provides user-authorized transaction data for `credit`, `depository`, and some loan-type accounts (only those with account subtype `student`; coverage may be limited). For transaction history from `investments` accounts, use `/investments/transactions/get` instead. Returned transactions data is grouped into three types of update, indicating whether the transaction was added, removed, or modified since the last call to the API. In the first call to `/transactions/sync` for an Item, the endpoint will return all historical transactions data associated with that Item up until the time of the API call (as \"adds\"), which then generates a `next_cursor` for that Item. In subsequent calls, send the `next_cursor` to receive only the changes that have occurred since the previous call. Due to the potentially large number of transactions associated with an Item, results are paginated. The `has_more` field specifies if additional calls are necessary to fetch all available transaction updates. Call `/transactions/sync` with the new cursor, pulling all updates, until `has_more` is `false`. When retrieving paginated updates, track both the `next_cursor` from the latest response and the original cursor from the first call in which `has_more` was `true`; if a call to `/transactions/sync` fails when retrieving a paginated update, the entire pagination request loop must be restarted beginning with the cursor for the first page of the update, rather than retrying only the single request that failed. Whenever new or updated transaction data becomes available, `/transactions/sync` will provide these updates. Plaid typically checks for new data multiple times a day, but these checks may occur less frequently, such as once a day, depending on the institution. An Item's `status.transactions.last_successful_update` field will show the timestamp of the most recent successful update. To force Plaid to check for new transactions, use the `/transactions/refresh` endpoint. Note that for newly created Items, data may not be immediately available to `/transactions/sync`. Plaid begins preparing transactions data when the Item is created, but the process can take anywhere from a few seconds to several minutes to complete, depending on the number of transactions available. To be alerted when new data is available, listen for the [`SYNC_UPDATES_AVAILABLE`](https://plaid.com/docs/api/products/transactions/#sync_updates_available) webhook.
|
8734
9059
|
# @param transactions_sync_request [TransactionsSyncRequest]
|
8735
9060
|
# @param [Hash] opts the optional parameters
|
8736
9061
|
# @return [TransactionsSyncResponse]
|
@@ -8740,7 +9065,7 @@ module Plaid
|
|
8740
9065
|
end
|
8741
9066
|
|
8742
9067
|
# Get incremental transaction updates on an Item
|
8743
|
-
# This endpoint replaces `/transactions/get` and its associated webhooks for most common use-cases. The `/transactions/sync` endpoint allows developers to subscribe to all transactions associated with an Item and get updates synchronously in a stream-like manner, using a cursor to track which updates have already been seen. `/transactions/sync` provides the same functionality as `/transactions/get` and can be used instead of `/transactions/get` to simplify the process of tracking transactions updates. This endpoint provides user-authorized transaction data for `credit`, `depository`, and some loan-type accounts (only those with account subtype `student`; coverage may be limited). For transaction history from `investments` accounts, use `/investments/transactions/get` instead. Returned transactions data is grouped into three types of update, indicating whether the transaction was added, removed, or modified since the last call to the API. In the first call to `/transactions/sync` for an Item, the endpoint will return all historical transactions data associated with that Item up until the time of the API call (as \"adds\"), which then generates a `next_cursor` for that Item. In subsequent calls, send the `next_cursor` to receive only the changes that have occurred since the previous call. Due to the potentially large number of transactions associated with an Item, results are paginated. The `has_more` field specifies if additional calls are necessary to fetch all available transaction updates. Call `/transactions/sync` with the new cursor, pulling all updates, until `has_more` is `false`.
|
9068
|
+
# This endpoint replaces `/transactions/get` and its associated webhooks for most common use-cases. The `/transactions/sync` endpoint allows developers to subscribe to all transactions associated with an Item and get updates synchronously in a stream-like manner, using a cursor to track which updates have already been seen. `/transactions/sync` provides the same functionality as `/transactions/get` and can be used instead of `/transactions/get` to simplify the process of tracking transactions updates. This endpoint provides user-authorized transaction data for `credit`, `depository`, and some loan-type accounts (only those with account subtype `student`; coverage may be limited). For transaction history from `investments` accounts, use `/investments/transactions/get` instead. Returned transactions data is grouped into three types of update, indicating whether the transaction was added, removed, or modified since the last call to the API. In the first call to `/transactions/sync` for an Item, the endpoint will return all historical transactions data associated with that Item up until the time of the API call (as \"adds\"), which then generates a `next_cursor` for that Item. In subsequent calls, send the `next_cursor` to receive only the changes that have occurred since the previous call. Due to the potentially large number of transactions associated with an Item, results are paginated. The `has_more` field specifies if additional calls are necessary to fetch all available transaction updates. Call `/transactions/sync` with the new cursor, pulling all updates, until `has_more` is `false`. When retrieving paginated updates, track both the `next_cursor` from the latest response and the original cursor from the first call in which `has_more` was `true`; if a call to `/transactions/sync` fails when retrieving a paginated update, the entire pagination request loop must be restarted beginning with the cursor for the first page of the update, rather than retrying only the single request that failed. Whenever new or updated transaction data becomes available, `/transactions/sync` will provide these updates. Plaid typically checks for new data multiple times a day, but these checks may occur less frequently, such as once a day, depending on the institution. An Item's `status.transactions.last_successful_update` field will show the timestamp of the most recent successful update. To force Plaid to check for new transactions, use the `/transactions/refresh` endpoint. Note that for newly created Items, data may not be immediately available to `/transactions/sync`. Plaid begins preparing transactions data when the Item is created, but the process can take anywhere from a few seconds to several minutes to complete, depending on the number of transactions available. To be alerted when new data is available, listen for the [`SYNC_UPDATES_AVAILABLE`](https://plaid.com/docs/api/products/transactions/#sync_updates_available) webhook.
|
8744
9069
|
# @param transactions_sync_request [TransactionsSyncRequest]
|
8745
9070
|
# @param [Hash] opts the optional parameters
|
8746
9071
|
# @return [Array<(TransactionsSyncResponse, Integer, Hash)>] TransactionsSyncResponse data, response status code and response headers
|
@@ -8924,6 +9249,71 @@ module Plaid
|
|
8924
9249
|
return data, status_code, headers
|
8925
9250
|
end
|
8926
9251
|
|
9252
|
+
# Get RTP eligibility information of a transfer
|
9253
|
+
# Use the `/transfer/capabilities/get` endpoint to determine the RTP eligibility information of a transfer.
|
9254
|
+
# @param transfer_capabilities_get_request [TransferCapabilitiesGetRequest]
|
9255
|
+
# @param [Hash] opts the optional parameters
|
9256
|
+
# @return [TransferCapabilitiesGetResponse]
|
9257
|
+
def transfer_capabilities_get(transfer_capabilities_get_request, opts = {})
|
9258
|
+
data, _status_code, _headers = transfer_capabilities_get_with_http_info(transfer_capabilities_get_request, opts)
|
9259
|
+
data
|
9260
|
+
end
|
9261
|
+
|
9262
|
+
# Get RTP eligibility information of a transfer
|
9263
|
+
# Use the `/transfer/capabilities/get` endpoint to determine the RTP eligibility information of a transfer.
|
9264
|
+
# @param transfer_capabilities_get_request [TransferCapabilitiesGetRequest]
|
9265
|
+
# @param [Hash] opts the optional parameters
|
9266
|
+
# @return [Array<(TransferCapabilitiesGetResponse, Integer, Hash)>] TransferCapabilitiesGetResponse data, response status code and response headers
|
9267
|
+
def transfer_capabilities_get_with_http_info(transfer_capabilities_get_request, opts = {})
|
9268
|
+
if @api_client.config.debugging
|
9269
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.transfer_capabilities_get ...'
|
9270
|
+
end
|
9271
|
+
# verify the required parameter 'transfer_capabilities_get_request' is set
|
9272
|
+
if @api_client.config.client_side_validation && transfer_capabilities_get_request.nil?
|
9273
|
+
fail ArgumentError, "Missing the required parameter 'transfer_capabilities_get_request' when calling PlaidApi.transfer_capabilities_get"
|
9274
|
+
end
|
9275
|
+
# resource path
|
9276
|
+
local_var_path = '/transfer/capabilities/get'
|
9277
|
+
|
9278
|
+
# query parameters
|
9279
|
+
query_params = opts[:query_params] || {}
|
9280
|
+
|
9281
|
+
# header parameters
|
9282
|
+
header_params = opts[:header_params] || {}
|
9283
|
+
# HTTP header 'Accept' (if needed)
|
9284
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
9285
|
+
# HTTP header 'Content-Type'
|
9286
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
9287
|
+
|
9288
|
+
# form parameters
|
9289
|
+
form_params = opts[:form_params] || {}
|
9290
|
+
|
9291
|
+
# http body (model)
|
9292
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(transfer_capabilities_get_request)
|
9293
|
+
|
9294
|
+
# return_type
|
9295
|
+
return_type = opts[:debug_return_type] || 'TransferCapabilitiesGetResponse'
|
9296
|
+
|
9297
|
+
# auth_names
|
9298
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
9299
|
+
|
9300
|
+
new_options = opts.merge(
|
9301
|
+
:operation => :"PlaidApi.transfer_capabilities_get",
|
9302
|
+
:header_params => header_params,
|
9303
|
+
:query_params => query_params,
|
9304
|
+
:form_params => form_params,
|
9305
|
+
:body => post_body,
|
9306
|
+
:auth_names => auth_names,
|
9307
|
+
:return_type => return_type
|
9308
|
+
)
|
9309
|
+
|
9310
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
9311
|
+
if @api_client.config.debugging
|
9312
|
+
@api_client.config.logger.debug "API called: PlaidApi#transfer_capabilities_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
9313
|
+
end
|
9314
|
+
return data, status_code, headers
|
9315
|
+
end
|
9316
|
+
|
8927
9317
|
# Create a transfer
|
8928
9318
|
# Use the `/transfer/create` endpoint to initiate a new transfer.
|
8929
9319
|
# @param transfer_create_request [TransferCreateRequest]
|
@@ -9055,7 +9445,7 @@ module Plaid
|
|
9055
9445
|
end
|
9056
9446
|
|
9057
9447
|
# Sync transfer events
|
9058
|
-
# `/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.
|
9448
|
+
# `/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. When using Auth with micro-deposit verification enabled, this endpoint can be used to fetch status updates on ACH micro-deposits. For more details, see [micro-deposit events](https://www.plaid.com/docs/auth/coverage/microdeposit-events/).
|
9059
9449
|
# @param transfer_event_sync_request [TransferEventSyncRequest]
|
9060
9450
|
# @param [Hash] opts the optional parameters
|
9061
9451
|
# @return [TransferEventSyncResponse]
|
@@ -9065,7 +9455,7 @@ module Plaid
|
|
9065
9455
|
end
|
9066
9456
|
|
9067
9457
|
# Sync transfer events
|
9068
|
-
# `/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.
|
9458
|
+
# `/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. When using Auth with micro-deposit verification enabled, this endpoint can be used to fetch status updates on ACH micro-deposits. For more details, see [micro-deposit events](https://www.plaid.com/docs/auth/coverage/microdeposit-events/).
|
9069
9459
|
# @param transfer_event_sync_request [TransferEventSyncRequest]
|
9070
9460
|
# @param [Hash] opts the optional parameters
|
9071
9461
|
# @return [Array<(TransferEventSyncResponse, Integer, Hash)>] TransferEventSyncResponse data, response status code and response headers
|