plaid 30.0.0 → 31.0.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 +155 -0
- data/Gemfile.lock +7 -5
- data/Makefile +1 -1
- data/lib/plaid/api/plaid_api.rb +758 -227
- data/lib/plaid/api_client.rb +2 -2
- 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_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_holder_category.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_document_upload.rb +1 -1
- data/lib/plaid/models/account_identity_document_upload_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 +29 -33
- data/lib/plaid/models/account_type.rb +1 -1
- data/lib/plaid/models/account_verification_insights.rb +1 -1
- data/lib/plaid/models/account_verification_insights_account_number_format.rb +1 -1
- data/lib/plaid/models/account_verification_insights_network_status.rb +1 -1
- data/lib/plaid/models/account_verification_insights_previous_returns.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_balance_get_request_payment_details.rb +1 -1
- data/lib/plaid/models/accounts_balance_get_response_payment_risk_assessment.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/action_state.rb +1 -1
- data/lib/plaid/models/activity.rb +1 -1
- data/lib/plaid/models/activity_type.rb +1 -1
- data/lib/plaid/models/address.rb +1 -1
- data/lib/plaid/models/address_data.rb +1 -1
- data/lib/plaid/models/address_data_not_required.rb +1 -1
- data/lib/plaid/models/address_data_nullable.rb +1 -1
- data/lib/plaid/models/address_data_nullable_no_required_fields.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 +1 -1
- data/lib/plaid/models/asset_detail.rb +1 -1
- data/lib/plaid/models/asset_holder.rb +1 -1
- data/lib/plaid/models/asset_holder_name.rb +1 -1
- data/lib/plaid/models/asset_owner.rb +1 -1
- data/lib/plaid/models/asset_owners.rb +1 -1
- data/lib/plaid/models/asset_report.rb +1 -1
- data/lib/plaid/models/asset_report_account_balance.rb +1 -1
- data/lib/plaid/models/asset_report_add_ons.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 +1 -1
- data/lib/plaid/models/asset_report_create_request_options.rb +18 -5
- 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 +1 -1
- 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_investment_holding.rb +1 -1
- data/lib/plaid/models/asset_report_investment_security.rb +1 -1
- data/lib/plaid/models/asset_report_investments.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 +1 -1
- data/lib/plaid/models/asset_report_transaction_type.rb +1 -1
- data/lib/plaid/models/asset_report_type.rb +1 -1
- data/lib/plaid/models/asset_report_user.rb +1 -1
- data/lib/plaid/models/asset_transaction.rb +1 -1
- data/lib/plaid/models/asset_transaction_category_type.rb +1 -1
- data/lib/plaid/models/asset_transaction_description.rb +1 -1
- data/lib/plaid/models/asset_transaction_detail.rb +1 -1
- data/lib/plaid/models/asset_transaction_type.rb +1 -1
- data/lib/plaid/models/asset_transactions.rb +1 -1
- data/lib/plaid/models/asset_type.rb +1 -1
- data/lib/plaid/models/assets.rb +1 -1
- data/lib/plaid/models/assets_error_webhook.rb +1 -1
- data/lib/plaid/models/assets_product_ready_webhook.rb +1 -1
- data/lib/plaid/models/auth_default_update_webhook.rb +3 -3
- 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/auth_update_types.rb +1 -1
- data/lib/plaid/models/automatically_verified_webhook.rb +1 -1
- data/lib/plaid/models/balance_plus_attributes.rb +1 -1
- data/lib/plaid/models/balance_plus_risk_level.rb +1 -1
- data/lib/plaid/models/bank_income_complete_result.rb +1 -1
- data/lib/plaid/models/bank_income_complete_webhook.rb +1 -1
- data/lib/plaid/models/bank_income_refresh_complete_result.rb +1 -1
- data/lib/plaid/models/bank_income_refresh_complete_webhook.rb +1 -1
- data/lib/plaid/models/bank_income_refresh_update_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 +1 -1
- data/lib/plaid/models/base_report.rb +1 -1
- data/lib/plaid/models/base_report_account.rb +20 -3
- data/lib/plaid/models/base_report_account_balances.rb +1 -9
- data/lib/plaid/models/base_report_account_insights.rb +43 -11
- data/lib/plaid/models/base_report_average_flow_insights.rb +17 -2
- data/lib/plaid/models/base_report_average_monthly_balances.rb +16 -1
- data/lib/plaid/models/base_report_historical_balance.rb +263 -0
- data/lib/plaid/models/base_report_item.rb +1 -1
- data/lib/plaid/models/base_report_longest_gap_insights.rb +2 -1
- data/lib/plaid/models/base_report_number_flow_insights.rb +17 -2
- data/lib/plaid/models/base_report_transaction.rb +2 -3
- data/lib/plaid/models/base_report_transaction_type.rb +1 -1
- data/lib/plaid/models/base_report_warning.rb +1 -1
- data/lib/plaid/models/base_report_warning_code.rb +1 -1
- data/lib/plaid/models/base_reports_error_webhook.rb +1 -1
- data/lib/plaid/models/base_reports_product_ready_webhook.rb +1 -1
- data/lib/plaid/models/beacon_account_risk_attributes.rb +1 -1
- data/lib/plaid/models/beacon_account_risk_evaluate_account.rb +1 -1
- data/lib/plaid/models/beacon_account_risk_evaluate_account_attributes.rb +1 -1
- data/lib/plaid/models/beacon_account_risk_evaluate_evaluation_reason.rb +1 -1
- data/lib/plaid/models/beacon_account_risk_evaluate_request.rb +1 -1
- data/lib/plaid/models/beacon_account_risk_evaluate_request_options.rb +1 -1
- data/lib/plaid/models/beacon_account_risk_evaluate_response.rb +1 -1
- data/lib/plaid/models/beacon_audit_trail.rb +1 -1
- data/lib/plaid/models/beacon_audit_trail_source.rb +1 -1
- data/lib/plaid/models/beacon_bank_account_insights.rb +1 -1
- data/lib/plaid/models/beacon_bank_accounts.rb +1 -1
- data/lib/plaid/models/beacon_duplicate_detected_webhook.rb +1 -1
- data/lib/plaid/models/beacon_duplicate_get_request.rb +1 -1
- data/lib/plaid/models/beacon_duplicate_get_response.rb +1 -1
- data/lib/plaid/models/beacon_match_summary_analysis.rb +1 -1
- data/lib/plaid/models/beacon_match_summary_code.rb +1 -1
- data/lib/plaid/models/beacon_report.rb +16 -5
- data/lib/plaid/models/beacon_report_create_request.rb +2 -2
- data/lib/plaid/models/beacon_report_create_response.rb +16 -5
- data/lib/plaid/models/beacon_report_create_type.rb +43 -0
- data/lib/plaid/models/beacon_report_created_webhook.rb +1 -1
- data/lib/plaid/models/beacon_report_get_request.rb +1 -1
- data/lib/plaid/models/beacon_report_get_response.rb +16 -5
- data/lib/plaid/models/beacon_report_list_request.rb +1 -1
- data/lib/plaid/models/beacon_report_list_response.rb +1 -1
- data/lib/plaid/models/beacon_report_syndication.rb +1 -1
- data/lib/plaid/models/beacon_report_syndication_analysis.rb +21 -5
- data/lib/plaid/models/beacon_report_syndication_created_webhook.rb +1 -1
- data/lib/plaid/models/beacon_report_syndication_get_request.rb +1 -1
- data/lib/plaid/models/beacon_report_syndication_get_response.rb +1 -1
- data/lib/plaid/models/beacon_report_syndication_list_request.rb +1 -1
- data/lib/plaid/models/beacon_report_syndication_list_response.rb +1 -1
- data/lib/plaid/models/beacon_report_syndication_original_report.rb +19 -8
- data/lib/plaid/models/beacon_report_type.rb +2 -1
- data/lib/plaid/models/beacon_report_updated_webhook.rb +1 -1
- data/lib/plaid/models/beacon_syndicated_report_depository_account_match_analysis.rb +277 -0
- data/lib/plaid/models/beacon_user.rb +1 -1
- data/lib/plaid/models/beacon_user_account_insights_get_request.rb +1 -1
- data/lib/plaid/models/beacon_user_account_insights_get_response.rb +1 -1
- data/lib/plaid/models/beacon_user_address.rb +2 -2
- data/lib/plaid/models/beacon_user_create_request.rb +2 -2
- data/lib/plaid/models/beacon_user_create_response.rb +1 -1
- data/lib/plaid/models/beacon_user_data.rb +23 -7
- data/lib/plaid/models/beacon_user_depository_account.rb +256 -0
- data/lib/plaid/models/beacon_user_get_request.rb +1 -1
- data/lib/plaid/models/beacon_user_get_response.rb +1 -1
- data/lib/plaid/models/beacon_user_history_list_request.rb +1 -1
- data/lib/plaid/models/beacon_user_history_list_response.rb +1 -1
- data/lib/plaid/models/beacon_user_id_number.rb +1 -1
- data/lib/plaid/models/beacon_user_name.rb +1 -1
- data/lib/plaid/models/beacon_user_name_nullable.rb +1 -1
- data/lib/plaid/models/beacon_user_request_address.rb +2 -2
- data/lib/plaid/models/beacon_user_request_address_nullable.rb +2 -2
- data/lib/plaid/models/beacon_user_request_data.rb +20 -13
- data/lib/plaid/models/beacon_user_request_depository_account.rb +241 -0
- data/lib/plaid/models/beacon_user_review_request.rb +1 -1
- data/lib/plaid/models/beacon_user_revision.rb +1 -1
- data/lib/plaid/models/beacon_user_status.rb +1 -1
- data/lib/plaid/models/beacon_user_status_updated_webhook.rb +1 -1
- data/lib/plaid/models/beacon_user_update_request.rb +1 -1
- data/lib/plaid/models/beacon_user_update_request_data.rb +18 -7
- data/lib/plaid/models/beacon_user_update_response.rb +1 -1
- data/lib/plaid/models/cashflow_attributes_version.rb +38 -0
- data/lib/plaid/models/categories_get_response.rb +1 -1
- data/lib/plaid/models/category.rb +1 -1
- data/lib/plaid/models/category_insight_details.rb +1 -1
- data/lib/plaid/models/category_insights.rb +1 -1
- data/lib/plaid/models/cause.rb +14 -3
- 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 +1 -1
- data/lib/plaid/models/client_provided_raw_transaction.rb +1 -1
- data/lib/plaid/models/client_provided_transaction.rb +1 -1
- data/lib/plaid/models/client_provided_transaction_location.rb +1 -1
- data/lib/plaid/models/connected_application.rb +1 -1
- data/lib/plaid/models/consumer_dispute.rb +292 -0
- data/lib/plaid/models/consumer_dispute_category.rb +41 -0
- data/lib/plaid/models/consumer_report_pdf_get_request.rb +1 -1
- data/lib/plaid/models/consumer_report_permissible_purpose.rb +1 -1
- data/lib/plaid/models/consumer_report_user_identity.rb +3 -3
- data/lib/plaid/models/counterparty.rb +1 -1
- data/lib/plaid/models/counterparty_insights.rb +1 -1
- data/lib/plaid/models/counterparty_type.rb +1 -1
- data/lib/plaid/models/country_code.rb +1 -1
- data/lib/plaid/models/cra_bank_income.rb +6 -6
- data/lib/plaid/models/cra_bank_income_account.rb +1 -1
- data/lib/plaid/models/cra_bank_income_bonus_type.rb +4 -3
- data/lib/plaid/models/cra_bank_income_cause.rb +1 -1
- data/lib/plaid/models/cra_bank_income_complete_result.rb +1 -1
- data/lib/plaid/models/cra_bank_income_complete_webhook.rb +1 -1
- data/lib/plaid/models/cra_bank_income_create_request.rb +2 -2
- data/lib/plaid/models/cra_bank_income_create_response.rb +1 -1
- data/lib/plaid/models/cra_bank_income_employer.rb +1 -1
- data/lib/plaid/models/cra_bank_income_error_webhook.rb +1 -1
- data/lib/plaid/models/cra_bank_income_get_request.rb +1 -1
- data/lib/plaid/models/cra_bank_income_get_response.rb +1 -1
- data/lib/plaid/models/cra_bank_income_historical_summary.rb +1 -1
- data/lib/plaid/models/cra_bank_income_item.rb +2 -2
- data/lib/plaid/models/cra_bank_income_source.rb +1 -1
- data/lib/plaid/models/cra_bank_income_summary.rb +2 -2
- data/lib/plaid/models/cra_bank_income_transaction.rb +21 -1
- data/lib/plaid/models/cra_bank_income_warning.rb +2 -2
- data/lib/plaid/models/cra_bank_income_warning_code.rb +1 -1
- data/lib/plaid/models/{base_report_create_request.rb → cra_base_report_create_request.rb} +5 -5
- data/lib/plaid/models/cra_base_report_create_response.rb +226 -0
- data/lib/plaid/models/{base_report_get_request.rb → cra_base_report_get_request.rb} +5 -5
- data/lib/plaid/models/{base_report_get_response.rb → cra_base_report_get_response.rb} +10 -5
- data/lib/plaid/models/cra_cashflow_insights_report.rb +261 -0
- data/lib/plaid/models/cra_check_report_base_report_get_request.rb +1 -1
- data/lib/plaid/models/cra_check_report_base_report_get_response.rb +6 -1
- data/lib/plaid/models/cra_check_report_cashflow_insights_get_options.rb +254 -0
- data/lib/plaid/models/cra_check_report_create_request.rb +17 -8
- data/lib/plaid/models/cra_check_report_create_response.rb +1 -1
- data/lib/plaid/models/cra_check_report_failed_webhook.rb +1 -1
- data/lib/plaid/models/cra_check_report_income_insights_get_request.rb +1 -1
- data/lib/plaid/models/cra_check_report_income_insights_get_response.rb +1 -1
- data/lib/plaid/models/{cra_check_report_network_attributes_get_request.rb → cra_check_report_network_insights_get_request.rb} +5 -5
- data/lib/plaid/models/{cra_check_report_network_attributes_get_response.rb → cra_check_report_network_insights_get_response.rb} +6 -6
- data/lib/plaid/models/cra_check_report_partner_insights_get_options.rb +15 -5
- data/lib/plaid/models/cra_check_report_partner_insights_get_request.rb +1 -1
- data/lib/plaid/models/cra_check_report_partner_insights_get_response.rb +1 -1
- data/lib/plaid/models/cra_check_report_pdf_get_request.rb +1 -1
- data/lib/plaid/models/cra_check_report_product.rb +1 -1
- data/lib/plaid/models/cra_check_report_ready_webhook.rb +1 -1
- data/lib/plaid/models/cra_income_insights.rb +6 -6
- data/lib/plaid/models/cra_loan_application.rb +1 -1
- data/lib/plaid/models/cra_loan_application_decision.rb +1 -1
- data/lib/plaid/models/cra_loan_closed_status.rb +1 -1
- data/lib/plaid/models/cra_loan_opened_status.rb +1 -1
- data/lib/plaid/models/cra_loan_payment_history.rb +1 -1
- data/lib/plaid/models/cra_loan_payment_schedule.rb +1 -1
- data/lib/plaid/models/cra_loan_register.rb +1 -1
- data/lib/plaid/models/cra_loan_register_application.rb +1 -1
- data/lib/plaid/models/cra_loan_status.rb +1 -1
- data/lib/plaid/models/cra_loan_status_history_update.rb +1 -1
- data/lib/plaid/models/cra_loan_type.rb +1 -1
- data/lib/plaid/models/cra_loan_unregister.rb +1 -1
- data/lib/plaid/models/cra_loan_unregister_response.rb +1 -1
- data/lib/plaid/models/cra_loan_update.rb +1 -1
- data/lib/plaid/models/cra_loans_applications_register_request.rb +1 -1
- data/lib/plaid/models/cra_loans_applications_register_response.rb +1 -1
- data/lib/plaid/models/cra_loans_register_request.rb +1 -1
- data/lib/plaid/models/cra_loans_register_response.rb +1 -1
- data/lib/plaid/models/cra_loans_unregister_request.rb +1 -1
- data/lib/plaid/models/cra_loans_update_request.rb +1 -1
- data/lib/plaid/models/cra_loans_update_response.rb +1 -1
- data/lib/plaid/models/cra_monitoring_insights_get_request.rb +246 -0
- data/lib/plaid/models/cra_monitoring_insights_get_response.rb +243 -0
- data/lib/plaid/models/cra_monitoring_insights_item.rb +269 -0
- data/lib/plaid/models/cra_monitoring_insights_subscribe_request.rb +261 -0
- data/lib/plaid/models/cra_monitoring_insights_subscribe_response.rb +241 -0
- data/lib/plaid/models/cra_monitoring_insights_unsubscribe_request.rb +246 -0
- data/lib/plaid/models/cra_monitoring_insights_unsubscribe_response.rb +226 -0
- data/lib/plaid/models/{cra_network_attributes_item.rb → cra_network_insights_item.rb} +4 -4
- data/lib/plaid/models/{cra_network_attributes_report.rb → cra_network_insights_report.rb} +5 -5
- data/lib/plaid/models/cra_partner_insights.rb +1 -1
- data/lib/plaid/models/cra_partner_insights_complete_webhook.rb +1 -1
- data/lib/plaid/models/cra_partner_insights_error_webhook.rb +1 -1
- data/lib/plaid/models/cra_partner_insights_get_request.rb +1 -1
- data/lib/plaid/models/cra_partner_insights_get_response.rb +1 -1
- data/lib/plaid/models/cra_partner_insights_item.rb +1 -1
- data/lib/plaid/models/cra_partner_insights_item_account.rb +1 -1
- data/lib/plaid/models/cra_partner_insights_prism.rb +1 -1
- data/lib/plaid/models/cra_pdf_add_ons.rb +1 -1
- data/lib/plaid/models/cra_prediction_interval.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_ach_class.rb +1 -1
- data/lib/plaid/models/credit_amount_with_currency.rb +6 -1
- 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 +1 -1
- data/lib/plaid/models/credit_audit_copy_token_update_response.rb +1 -1
- data/lib/plaid/models/credit_bank_employer.rb +1 -1
- data/lib/plaid/models/credit_bank_employment.rb +1 -1
- data/lib/plaid/models/credit_bank_employment_get_request.rb +1 -1
- data/lib/plaid/models/credit_bank_employment_get_response.rb +1 -1
- data/lib/plaid/models/credit_bank_employment_item.rb +1 -1
- data/lib/plaid/models/credit_bank_employment_report.rb +1 -1
- data/lib/plaid/models/credit_bank_employment_warning.rb +1 -1
- data/lib/plaid/models/credit_bank_employment_warning_type.rb +1 -1
- data/lib/plaid/models/credit_bank_income.rb +4 -4
- 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 +1 -1
- 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 +1 -1
- 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_bank_income_webhook_update_request.rb +1 -1
- data/lib/plaid/models/credit_bank_income_webhook_update_response.rb +1 -1
- data/lib/plaid/models/credit_bank_statement_upload_account_owner.rb +1 -1
- data/lib/plaid/models/credit_bank_statement_upload_account_owner_address.rb +1 -1
- data/lib/plaid/models/credit_bank_statement_upload_bank_account.rb +1 -1
- data/lib/plaid/models/credit_bank_statement_upload_bank_account_period.rb +1 -1
- data/lib/plaid/models/credit_bank_statement_upload_item.rb +1 -1
- data/lib/plaid/models/credit_bank_statement_upload_object.rb +1 -1
- data/lib/plaid/models/credit_bank_statement_upload_transaction.rb +1 -1
- data/lib/plaid/models/credit_bank_statements_uploads_get_request.rb +1 -1
- data/lib/plaid/models/credit_bank_statements_uploads_get_request_options.rb +1 -1
- data/lib/plaid/models/credit_bank_statements_uploads_get_response.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.rb +1 -1
- data/lib/plaid/models/credit_freddie_mac_asset_transaction.rb +1 -1
- data/lib/plaid/models/credit_freddie_mac_asset_transactions.rb +1 -1
- data/lib/plaid/models/credit_freddie_mac_assets.rb +1 -1
- data/lib/plaid/models/credit_freddie_mac_individual_name.rb +1 -1
- data/lib/plaid/models/credit_freddie_mac_loan.rb +1 -1
- data/lib/plaid/models/credit_freddie_mac_loan_identifiers.rb +1 -1
- data/lib/plaid/models/credit_freddie_mac_loans.rb +1 -1
- data/lib/plaid/models/credit_freddie_mac_parties.rb +1 -1
- data/lib/plaid/models/credit_freddie_mac_party.rb +1 -1
- data/lib/plaid/models/credit_freddie_mac_party_individual.rb +1 -1
- data/lib/plaid/models/credit_freddie_mac_reporting_information.rb +1 -1
- data/lib/plaid/models/credit_freddie_mac_reports_get_request.rb +1 -1
- data/lib/plaid/models/credit_freddie_mac_reports_get_response.rb +1 -1
- data/lib/plaid/models/credit_freddie_mac_service.rb +1 -1
- data/lib/plaid/models/credit_freddie_mac_services.rb +1 -1
- data/lib/plaid/models/credit_freddie_mac_verification_of_asset.rb +1 -1
- data/lib/plaid/models/credit_freddie_mac_verification_of_asset_response.rb +1 -1
- data/lib/plaid/models/credit_freddie_mac_verification_of_assets_deal.rb +1 -1
- 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 +1 -1
- data/lib/plaid/models/credit_payroll_income_get_request.rb +1 -1
- data/lib/plaid/models/credit_payroll_income_get_request_options.rb +1 -1
- data/lib/plaid/models/credit_payroll_income_get_response.rb +1 -1
- data/lib/plaid/models/credit_payroll_income_parsing_config_update_request.rb +1 -1
- data/lib/plaid/models/credit_payroll_income_parsing_config_update_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_request_options.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 +1 -1
- 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_pdf_get_request.rb +1 -1
- data/lib/plaid/models/credit_relay_refresh_request.rb +1 -1
- 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 +1 -1
- data/lib/plaid/models/credit_session.rb +1 -1
- data/lib/plaid/models/credit_session_bank_employment_result.rb +1 -1
- data/lib/plaid/models/credit_session_bank_employment_status.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 +2 -2
- data/lib/plaid/models/dashboard_user_get_request.rb +1 -1
- data/lib/plaid/models/dashboard_user_get_response.rb +2 -2
- 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/detailed_originator.rb +1 -1
- data/lib/plaid/models/detected_account.rb +1 -1
- 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_source_type.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 +1 -1
- data/lib/plaid/models/enrich_transaction_direction.rb +1 -1
- data/lib/plaid/models/enrichments.rb +1 -1
- data/lib/plaid/models/entity_document.rb +2 -2
- 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 +2 -2
- 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 +1 -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 +4 -4
- data/lib/plaid/models/entity_watchlist_search_terms.rb +4 -4
- data/lib/plaid/models/expiration_date.rb +1 -1
- data/lib/plaid/models/extended_recipient_metadata.rb +383 -0
- data/lib/plaid/models/{base_report_account_balances_all_of.rb → extended_recipient_metadata_all_of.rb} +41 -30
- 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/fallback_auth_microdeposit_auto_verified_webhook.rb +1 -1
- data/lib/plaid/models/fallback_auth_microdeposit_verification_expired_webhook.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_initiator_fi_attribute.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/fdx_recipient_metadata.rb +330 -0
- data/lib/plaid/models/fdxfi_attribute.rb +1 -1
- data/lib/plaid/models/financial_institution_insights.rb +1 -1
- data/lib/plaid/models/forecasted_monthly_income.rb +241 -0
- data/lib/plaid/models/form1099_type.rb +1 -1
- data/lib/plaid/models/{base_report_create_response.rb → forwarded_json_response.rb} +5 -5
- data/lib/plaid/models/fraud_amount.rb +1 -1
- data/lib/plaid/models/generic_screening_hit_location_items.rb +1 -1
- data/lib/plaid/models/get_recipient_response.rb +337 -0
- data/lib/plaid/models/get_recipients_response.rb +227 -0
- data/lib/plaid/models/health_incident.rb +1 -1
- data/lib/plaid/models/hidden_match_summary_code.rb +42 -0
- data/lib/plaid/models/historical_balance.rb +1 -1
- data/lib/plaid/models/historical_update_webhook.rb +3 -3
- data/lib/plaid/models/holding.rb +1 -1
- data/lib/plaid/models/holdings_default_update_webhook.rb +1 -1
- data/lib/plaid/models/holdings_override.rb +1 -1
- data/lib/plaid/models/hosted_link_delivery_method.rb +1 -1
- data/lib/plaid/models/hosted_mmd_verification_webhook.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_document_metadata.rb +1 -1
- data/lib/plaid/models/identity_document_upload.rb +1 -1
- data/lib/plaid/models/identity_document_upload_metadata.rb +1 -1
- data/lib/plaid/models/identity_document_upload_risk_insights.rb +1 -1
- data/lib/plaid/models/identity_document_upload_risk_signal.rb +1 -1
- data/lib/plaid/models/identity_document_upload_risk_summary.rb +1 -1
- data/lib/plaid/models/identity_documents_uploads_get_request.rb +1 -1
- data/lib/plaid/models/identity_documents_uploads_get_request_options.rb +1 -1
- data/lib/plaid/models/identity_documents_uploads_get_response.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 +2 -2
- data/lib/plaid/models/identity_refresh_request.rb +1 -1
- data/lib/plaid/models/identity_refresh_response.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_autofill_address.rb +2 -2
- data/lib/plaid/models/identity_verification_autofill_create_request.rb +1 -1
- data/lib/plaid/models/identity_verification_autofill_create_response.rb +1 -1
- data/lib/plaid/models/identity_verification_autofill_status.rb +1 -1
- data/lib/plaid/models/identity_verification_autofill_user_data.rb +1 -1
- data/lib/plaid/models/identity_verification_create_request.rb +1 -1
- data/lib/plaid/models/identity_verification_create_request_user.rb +3 -3
- data/lib/plaid/models/identity_verification_create_response.rb +1 -1
- data/lib/plaid/models/identity_verification_document_address_response.rb +1 -1
- data/lib/plaid/models/identity_verification_document_name_response.rb +241 -0
- 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 +3 -3
- data/lib/plaid/models/identity_verification_request_user_name.rb +1 -1
- data/lib/plaid/models/identity_verification_response_user_name.rb +1 -1
- data/lib/plaid/models/identity_verification_retried_webhook.rb +1 -1
- data/lib/plaid/models/identity_verification_retry_request.rb +13 -2
- 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 +2 -2
- data/lib/plaid/models/identity_verification_user_data.rb +3 -3
- 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_sources_counts.rb +241 -0
- data/lib/plaid/models/income_summary.rb +1 -1
- data/lib/plaid/models/income_summary_field_number.rb +1 -1
- data/lib/plaid/models/income_summary_field_string.rb +1 -1
- data/lib/plaid/models/income_verification_create_request.rb +1 -1
- data/lib/plaid/models/income_verification_create_request_options.rb +1 -1
- data/lib/plaid/models/income_verification_create_response.rb +1 -1
- data/lib/plaid/models/income_verification_doc_parsing_config.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_refresh_reconnect_needed_webhook.rb +1 -1
- data/lib/plaid/models/income_verification_risk_signals_status_webhook.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 +1 -1
- 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 +3 -3
- data/lib/plaid/models/institution.rb +1 -1
- data/lib/plaid/models/institution_status.rb +1 -1
- data/lib/plaid/models/institution_status_alert_webhook.rb +1 -1
- data/lib/plaid/models/institution_supported_networks.rb +1 -1
- data/lib/plaid/models/institutions_get_by_id_request.rb +1 -1
- data/lib/plaid/models/institutions_get_by_id_request_options.rb +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 +1 -1
- 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_auth_get_numbers.rb +1 -1
- data/lib/plaid/models/investments_auth_get_request.rb +1 -1
- data/lib/plaid/models/investments_auth_get_request_options.rb +1 -1
- data/lib/plaid/models/investments_auth_get_response.rb +1 -1
- data/lib/plaid/models/investments_auth_owner.rb +1 -1
- data/lib/plaid/models/investments_default_update_webhook.rb +1 -1
- data/lib/plaid/models/investments_historical_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_refresh_request.rb +1 -1
- data/lib/plaid/models/investments_refresh_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 +2 -2
- data/lib/plaid/models/investments_transactions_get_response.rb +1 -1
- data/lib/plaid/models/investments_transactions_override.rb +1 -1
- data/lib/plaid/models/iso_currency_code.rb +1 -1
- data/lib/plaid/models/issue_resolved_webhook.rb +316 -0
- 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 +1 -1
- data/lib/plaid/models/item_activity_list_response.rb +1 -1
- data/lib/plaid/models/item_add_result_webhook.rb +2 -2
- 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_application_unlink_request.rb +1 -1
- data/lib/plaid/models/item_application_unlink_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_login_repaired_webhook.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 +1 -1
- data/lib/plaid/models/jwt_header.rb +1 -1
- data/lib/plaid/models/kyc_check_address_summary.rb +51 -5
- data/lib/plaid/models/kyc_check_date_of_birth_summary.rb +32 -5
- data/lib/plaid/models/kyc_check_details.rb +1 -1
- data/lib/plaid/models/kyc_check_details_international_address.rb +317 -0
- data/lib/plaid/models/kyc_check_id_number_summary.rb +1 -1
- data/lib/plaid/models/kyc_check_name_summary.rb +23 -5
- data/lib/plaid/models/kyc_check_phone_summary.rb +1 -1
- data/lib/plaid/models/last_data_access_times.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_callback_metadata.rb +1 -1
- data/lib/plaid/models/link_delivery_account.rb +1 -1
- data/lib/plaid/models/link_delivery_callback_webhook.rb +1 -1
- data/lib/plaid/models/link_delivery_communication_method.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_institution.rb +1 -1
- data/lib/plaid/models/link_delivery_metadata.rb +1 -1
- data/lib/plaid/models/link_delivery_options.rb +1 -1
- data/lib/plaid/models/link_delivery_recipient.rb +1 -1
- data/lib/plaid/models/link_delivery_session_status.rb +1 -1
- data/lib/plaid/models/link_delivery_verification_status.rb +1 -1
- data/lib/plaid/models/link_delivery_webhook_callback_type.rb +1 -1
- data/lib/plaid/models/link_delivery_webhook_communication_method.rb +1 -1
- data/lib/plaid/models/link_delivery_webhook_delivery_status.rb +1 -1
- data/lib/plaid/models/link_event.rb +1 -1
- data/lib/plaid/models/link_event_metadata.rb +1 -1
- data/lib/plaid/models/link_event_name.rb +2 -1
- data/lib/plaid/models/link_events_webhook.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_profile_eligibility_check_request.rb +1 -1
- data/lib/plaid/models/link_profile_eligibility_check_response.rb +1 -1
- data/lib/plaid/models/link_profile_eligibility_check_user.rb +1 -1
- data/lib/plaid/models/link_session_bank_employment_result.rb +1 -1
- data/lib/plaid/models/link_session_bank_income_result.rb +1 -1
- data/lib/plaid/models/link_session_cra_item_add_result.rb +253 -0
- data/lib/plaid/models/link_session_exit.rb +1 -1
- data/lib/plaid/models/link_session_exit_deprecated.rb +2 -2
- data/lib/plaid/models/link_session_exit_metadata.rb +1 -1
- data/lib/plaid/models/link_session_exit_metadata_institution.rb +1 -1
- data/lib/plaid/models/link_session_finished_webhook.rb +2 -2
- data/lib/plaid/models/link_session_item_add_result.rb +1 -1
- data/lib/plaid/models/link_session_payroll_income_result.rb +1 -1
- data/lib/plaid/models/link_session_results.rb +14 -2
- data/lib/plaid/models/link_session_success.rb +2 -2
- data/lib/plaid/models/link_session_success_metadata.rb +1 -1
- data/lib/plaid/models/link_session_success_metadata_account.rb +1 -1
- data/lib/plaid/models/link_session_success_metadata_institution.rb +1 -1
- data/lib/plaid/models/link_session_success_metadata_transfer_status.rb +2 -1
- data/lib/plaid/models/link_token_account_filters.rb +1 -1
- data/lib/plaid/models/link_token_create_card_switch.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_hosted_link.rb +2 -2
- data/lib/plaid/models/link_token_create_identity.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 +3 -3
- 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_base_report.rb +1 -1
- data/lib/plaid/models/link_token_create_request_cra_options.rb +15 -6
- data/lib/plaid/models/link_token_create_request_cra_options_base_report.rb +1 -1
- data/lib/plaid/models/link_token_create_request_cra_options_cashflow_insights.rb +254 -0
- data/lib/plaid/models/link_token_create_request_cra_options_partner_insights.rb +15 -5
- data/lib/plaid/models/link_token_create_request_credit_partner_insights.rb +2 -2
- data/lib/plaid/models/link_token_create_request_deposit_switch.rb +1 -1
- data/lib/plaid/models/link_token_create_request_employment.rb +1 -1
- data/lib/plaid/models/link_token_create_request_employment_bank_income.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 +2 -2
- data/lib/plaid/models/link_token_create_request_income_verification_bank_income.rb +2 -2
- data/lib/plaid/models/link_token_create_request_income_verification_payroll_income.rb +1 -1
- data/lib/plaid/models/link_token_create_request_payment_initiation.rb +1 -1
- data/lib/plaid/models/link_token_create_request_statements.rb +3 -3
- data/lib/plaid/models/link_token_create_request_transfer.rb +1 -1
- data/lib/plaid/models/link_token_create_request_update.rb +28 -5
- data/lib/plaid/models/link_token_create_request_user.rb +1 -1
- data/lib/plaid/models/link_token_create_request_user_address.rb +2 -2
- data/lib/plaid/models/link_token_create_request_user_id_number.rb +1 -1
- data/lib/plaid/models/link_token_create_request_user_name.rb +1 -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_get_sessions_response.rb +1 -1
- data/lib/plaid/models/link_token_investments.rb +1 -1
- data/lib/plaid/models/link_token_investments_auth.rb +19 -6
- data/lib/plaid/models/link_token_transactions.rb +2 -2
- data/lib/plaid/models/link_user_delivery_status_webhook.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/loan_payments_counts.rb +241 -0
- data/lib/plaid/models/loan_payments_merchant_counts.rb +241 -0
- 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/merchant_insights.rb +1 -1
- data/lib/plaid/models/meta.rb +1 -1
- data/lib/plaid/models/mfa.rb +1 -1
- data/lib/plaid/models/monitoring_income_insights.rb +270 -0
- data/lib/plaid/models/monitoring_income_source.rb +307 -0
- data/lib/plaid/models/monitoring_insights.rb +239 -0
- data/lib/plaid/models/monitoring_insights_item_status.rb +258 -0
- data/lib/plaid/models/monitoring_insights_webhook.rb +303 -0
- data/lib/plaid/models/monitoring_item_status_code.rb +41 -0
- data/lib/plaid/models/monitoring_loan_insights.rb +254 -0
- 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 +2 -2
- data/lib/plaid/models/net_pay.rb +1 -1
- data/lib/plaid/models/network_insights_item.rb +256 -0
- data/lib/plaid/models/network_insights_report.rb +273 -0
- data/lib/plaid/models/network_insights_report_get_request.rb +248 -0
- data/lib/plaid/models/network_insights_report_get_response.rb +240 -0
- data/lib/plaid/models/new_accounts_available_webhook.rb +2 -2
- data/lib/plaid/models/numbers.rb +1 -1
- data/lib/plaid/models/numbers_acats.rb +1 -1
- data/lib/plaid/models/numbers_ach.rb +2 -2
- data/lib/plaid/models/numbers_ach_nullable.rb +2 -2
- data/lib/plaid/models/numbers_aton.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/omittable_transfer_type.rb +1 -1
- data/lib/plaid/models/option_contract.rb +1 -1
- data/lib/plaid/models/originator.rb +1 -1
- data/lib/plaid/models/originator_expected_transfer_frequency.rb +1 -1
- data/lib/plaid/models/other_account_subtype.rb +1 -1
- data/lib/plaid/models/other_filter.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 +1 -1
- 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 +1 -1
- data/lib/plaid/models/partner_customer_o_auth_institutions_get_response.rb +1 -1
- 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 +1 -1
- data/lib/plaid/models/partner_end_customer_flowdown_status.rb +1 -1
- data/lib/plaid/models/partner_end_customer_o_auth_institution.rb +1 -1
- data/lib/plaid/models/partner_end_customer_o_auth_institution_application_status.rb +1 -1
- data/lib/plaid/models/partner_end_customer_o_auth_institution_environments.rb +1 -1
- data/lib/plaid/models/partner_end_customer_o_auth_status_updated_values.rb +1 -1
- data/lib/plaid/models/partner_end_customer_o_auth_status_updated_webhook.rb +1 -1
- data/lib/plaid/models/partner_end_customer_questionnaire_status.rb +1 -1
- data/lib/plaid/models/partner_end_customer_secrets.rb +1 -1
- data/lib/plaid/models/partner_end_customer_status.rb +1 -1
- 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 +1 -1
- 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_period_details_pay_frequency.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 +1 -1
- 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 -1
- data/lib/plaid/models/payment_amount_nullable.rb +1 -1
- data/lib/plaid/models/payment_amount_refunded.rb +1 -1
- data/lib/plaid/models/payment_amount_to_refund.rb +1 -1
- 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 +1 -1
- 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_deductions.rb +1 -1
- data/lib/plaid/models/paystub_override_deductions_breakdown.rb +1 -1
- data/lib/plaid/models/paystub_override_deductions_total.rb +1 -1
- data/lib/plaid/models/paystub_override_distribution_breakdown.rb +1 -1
- data/lib/plaid/models/paystub_override_earnings.rb +1 -1
- data/lib/plaid/models/paystub_override_earnings_breakdown.rb +1 -1
- data/lib/plaid/models/paystub_override_earnings_total.rb +17 -6
- 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_override_employer_address.rb +1 -1
- data/lib/plaid/models/paystub_override_net_pay.rb +1 -1
- data/lib/plaid/models/paystub_override_pay_period_details.rb +1 -1
- data/lib/plaid/models/paystub_override_taxpayer_id.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_disconnect_webhook.rb +306 -0
- data/lib/plaid/models/pending_disconnect_webhook_reason.rb +38 -0
- 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 +16 -6
- 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_check_score.rb +233 -0
- data/lib/plaid/models/plaid_error.rb +14 -3
- data/lib/plaid/models/plaid_error_type.rb +6 -1
- data/lib/plaid/models/platform_ids.rb +1 -1
- data/lib/plaid/models/po_box_status.rb +1 -1
- data/lib/plaid/models/prism_cash_score.rb +1 -1
- data/lib/plaid/models/prism_cash_score_metadata.rb +1 -1
- data/lib/plaid/models/prism_cash_score_version.rb +39 -0
- data/lib/plaid/models/prism_first_detect.rb +1 -1
- data/lib/plaid/models/prism_first_detect_version.rb +39 -0
- data/lib/plaid/models/prism_insights.rb +1 -1
- data/lib/plaid/models/prism_insights_version.rb +39 -0
- data/lib/plaid/models/prism_product.rb +1 -1
- data/lib/plaid/models/prism_versions.rb +263 -0
- data/lib/plaid/models/processor_account_get_request.rb +1 -1
- data/lib/plaid/models/processor_account_get_response.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_default_update_webhook.rb +1 -1
- data/lib/plaid/models/processor_historical_update_webhook.rb +3 -3
- 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_identity_match_request.rb +1 -1
- data/lib/plaid/models/processor_identity_match_response.rb +1 -1
- data/lib/plaid/models/processor_initial_update_webhook.rb +3 -3
- data/lib/plaid/models/processor_liabilities_get_request.rb +1 -1
- data/lib/plaid/models/processor_liabilities_get_response.rb +1 -1
- data/lib/plaid/models/processor_number.rb +1 -1
- data/lib/plaid/models/processor_recurring_transactions_update_webhook.rb +1 -1
- data/lib/plaid/models/processor_signal_decision_report_request.rb +1 -1
- data/lib/plaid/models/processor_signal_decision_report_response.rb +1 -1
- data/lib/plaid/models/processor_signal_evaluate_request.rb +16 -5
- data/lib/plaid/models/processor_signal_evaluate_response.rb +12 -2
- data/lib/plaid/models/processor_signal_prepare_request.rb +1 -1
- data/lib/plaid/models/processor_signal_prepare_response.rb +1 -1
- data/lib/plaid/models/processor_signal_return_report_request.rb +1 -1
- data/lib/plaid/models/processor_signal_return_report_response.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_sync_updates_available_webhook.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/processor_token_permissions_get_request.rb +1 -1
- data/lib/plaid/models/processor_token_permissions_get_response.rb +1 -1
- data/lib/plaid/models/processor_token_permissions_set_request.rb +1 -1
- data/lib/plaid/models/processor_token_permissions_set_response.rb +1 -1
- data/lib/plaid/models/processor_token_webhook_update.rb +1 -1
- data/lib/plaid/models/processor_token_webhook_update_request.rb +1 -1
- data/lib/plaid/models/processor_token_webhook_update_response.rb +1 -1
- data/lib/plaid/models/processor_transactions_get_request.rb +1 -1
- data/lib/plaid/models/processor_transactions_get_request_options.rb +1 -1
- data/lib/plaid/models/processor_transactions_get_response.rb +1 -1
- data/lib/plaid/models/processor_transactions_recurring_get_request.rb +1 -1
- data/lib/plaid/models/processor_transactions_recurring_get_response.rb +1 -1
- data/lib/plaid/models/processor_transactions_refresh_request.rb +1 -1
- data/lib/plaid/models/processor_transactions_refresh_response.rb +1 -1
- data/lib/plaid/models/processor_transactions_removed_webhook.rb +1 -1
- data/lib/plaid/models/processor_transactions_sync_request.rb +1 -1
- data/lib/plaid/models/processor_transactions_sync_response.rb +1 -1
- data/lib/plaid/models/product_access.rb +1 -1
- data/lib/plaid/models/product_permissions_required_auth_webhook.rb +1 -1
- data/lib/plaid/models/product_permissions_required_identity_webhook.rb +1 -1
- data/lib/plaid/models/product_status.rb +1 -1
- data/lib/plaid/models/product_status_breakdown.rb +2 -2
- data/lib/plaid/models/products.rb +2 -1
- data/lib/plaid/models/profile_get_request.rb +1 -1
- data/lib/plaid/models/profile_get_response.rb +1 -1
- data/lib/plaid/models/profile_identity.rb +1 -1
- data/lib/plaid/models/profile_identity_address.rb +1 -1
- data/lib/plaid/models/profile_identity_name.rb +1 -1
- data/lib/plaid/models/profile_item.rb +1 -1
- data/lib/plaid/models/profile_network_status_get_network_status.rb +39 -0
- data/lib/plaid/models/profile_network_status_get_request.rb +245 -0
- data/lib/plaid/models/profile_network_status_get_response.rb +262 -0
- data/lib/plaid/models/profile_network_status_get_user.rb +226 -0
- 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/proxy_type.rb +1 -1
- data/lib/plaid/models/pslf_status.rb +2 -2
- data/lib/plaid/models/recaptcha_required_error.rb +1 -1
- data/lib/plaid/models/recipient_bacs.rb +1 -1
- data/lib/plaid/models/recipient_bacs_nullable.rb +1 -1
- data/lib/plaid/models/recurrence.rb +1 -1
- data/lib/plaid/models/recurring_cancelled_webhook.rb +1 -1
- data/lib/plaid/models/recurring_frequency.rb +1 -1
- data/lib/plaid/models/recurring_insights_stream.rb +1 -1
- data/lib/plaid/models/recurring_new_transfer_webhook.rb +1 -1
- data/lib/plaid/models/recurring_transaction_frequency.rb +1 -1
- data/lib/plaid/models/recurring_transactions.rb +1 -1
- data/lib/plaid/models/recurring_transactions_update_webhook.rb +1 -1
- data/lib/plaid/models/recurring_transfer.rb +1 -1
- data/lib/plaid/models/recurring_transfer_nullable.rb +1 -1
- data/lib/plaid/models/recurring_transfer_skipped_webhook.rb +1 -1
- 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 +1 -1
- data/lib/plaid/models/risk_check_behavior.rb +1 -1
- data/lib/plaid/models/risk_check_behavior_bot_detected_label.rb +1 -1
- data/lib/plaid/models/risk_check_behavior_fraud_ring_detected_label.rb +1 -1
- data/lib/plaid/models/risk_check_behavior_user_interactions_label.rb +1 -1
- data/lib/plaid/models/risk_check_details.rb +1 -1
- data/lib/plaid/models/risk_check_device.rb +1 -1
- data/lib/plaid/models/risk_check_email.rb +1 -1
- data/lib/plaid/models/risk_check_email_domain_is_custom.rb +1 -1
- data/lib/plaid/models/risk_check_email_domain_is_disposable.rb +1 -1
- data/lib/plaid/models/risk_check_email_domain_is_free_provider.rb +1 -1
- data/lib/plaid/models/risk_check_email_is_deliverable_status.rb +1 -1
- data/lib/plaid/models/risk_check_email_top_level_domain_is_suspicious.rb +1 -1
- data/lib/plaid/models/risk_check_identity_abuse_signals.rb +1 -1
- data/lib/plaid/models/risk_check_linked_service.rb +1 -1
- data/lib/plaid/models/risk_check_phone.rb +1 -1
- data/lib/plaid/models/risk_check_stolen_identity.rb +1 -1
- data/lib/plaid/models/risk_check_synthetic_identity.rb +1 -1
- data/lib/plaid/models/risk_profile.rb +1 -1
- data/lib/plaid/models/risk_reason.rb +1 -1
- data/lib/plaid/models/risk_signal_document_reference.rb +16 -6
- data/lib/plaid/models/risk_signal_document_status.rb +1 -1
- data/lib/plaid/models/risk_signal_document_type.rb +1 -1
- data/lib/plaid/models/risk_signal_file_type.rb +45 -0
- data/lib/plaid/models/role.rb +1 -1
- data/lib/plaid/models/role_detail.rb +1 -1
- data/lib/plaid/models/roles.rb +1 -1
- data/lib/plaid/models/ruleset.rb +1 -1
- data/lib/plaid/models/sandbox_bank_income_fire_webhook_request.rb +1 -1
- data/lib/plaid/models/sandbox_bank_income_fire_webhook_response.rb +1 -1
- data/lib/plaid/models/sandbox_bank_income_webhook_fire_request_webhook_code.rb +1 -1
- data/lib/plaid/models/sandbox_bank_income_webhook_fire_request_webhook_fields.rb +1 -1
- 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_income_webhook_fire_request_webhook_code.rb +1 -1
- data/lib/plaid/models/sandbox_item_fire_webhook_request.rb +3 -3
- 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_statements.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_ledger_deposit_simulate_request.rb +1 -1
- data/lib/plaid/models/sandbox_transfer_ledger_deposit_simulate_response.rb +1 -1
- data/lib/plaid/models/sandbox_transfer_ledger_simulate_available_request.rb +13 -2
- data/lib/plaid/models/sandbox_transfer_ledger_simulate_available_response.rb +1 -1
- data/lib/plaid/models/sandbox_transfer_ledger_withdraw_simulate_request.rb +1 -1
- data/lib/plaid/models/sandbox_transfer_ledger_withdraw_simulate_response.rb +1 -1
- data/lib/plaid/models/sandbox_transfer_refund_simulate_request.rb +1 -1
- data/lib/plaid/models/sandbox_transfer_refund_simulate_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 +1 -1
- data/lib/plaid/models/sandbox_transfer_test_clock_advance_response.rb +1 -1
- data/lib/plaid/models/sandbox_transfer_test_clock_create_request.rb +1 -1
- data/lib/plaid/models/sandbox_transfer_test_clock_create_response.rb +1 -1
- data/lib/plaid/models/sandbox_transfer_test_clock_get_request.rb +1 -1
- data/lib/plaid/models/sandbox_transfer_test_clock_get_response.rb +1 -1
- data/lib/plaid/models/sandbox_transfer_test_clock_list_request.rb +1 -1
- data/lib/plaid/models/sandbox_transfer_test_clock_list_response.rb +1 -1
- data/lib/plaid/models/sandbox_user_reset_login_request.rb +1 -1
- data/lib/plaid/models/sandbox_user_reset_login_response.rb +1 -1
- 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 +24 -2
- data/lib/plaid/models/security_override.rb +1 -1
- data/lib/plaid/models/selfie_analysis.rb +1 -1
- data/lib/plaid/models/selfie_analysis_document_comparison.rb +1 -1
- data/lib/plaid/models/selfie_capture.rb +1 -1
- data/lib/plaid/models/selfie_check.rb +1 -1
- data/lib/plaid/models/selfie_check_selfie.rb +1 -1
- data/lib/plaid/models/selfie_check_status.rb +1 -1
- data/lib/plaid/models/selfie_status.rb +1 -1
- 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 +1 -1
- data/lib/plaid/models/service_product_fulfillment_identifier.rb +1 -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 +1 -53
- 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/signal_warning.rb +1 -1
- data/lib/plaid/models/simulated_transfer_sweep.rb +13 -2
- 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 +5 -5
- 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/statements_account.rb +1 -1
- data/lib/plaid/models/statements_download_request.rb +1 -1
- data/lib/plaid/models/statements_list_request.rb +1 -1
- data/lib/plaid/models/statements_list_response.rb +1 -1
- data/lib/plaid/models/statements_refresh_complete_result.rb +1 -1
- data/lib/plaid/models/statements_refresh_complete_webhook.rb +1 -1
- data/lib/plaid/models/statements_refresh_request.rb +3 -3
- data/lib/plaid/models/statements_refresh_response.rb +1 -1
- data/lib/plaid/models/statements_statement.rb +1 -1
- data/lib/plaid/models/status.rb +1 -1
- data/lib/plaid/models/statuses.rb +1 -1
- data/lib/plaid/models/strategy.rb +1 -1
- data/lib/plaid/models/student_loan.rb +2 -2
- 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/sweep_status.rb +1 -1
- data/lib/plaid/models/sweep_trigger.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/total_monthly_income_insights.rb +241 -0
- data/lib/plaid/models/transaction.rb +4 -4
- data/lib/plaid/models/transaction_all_of.rb +1 -1
- data/lib/plaid/models/transaction_base.rb +4 -4
- data/lib/plaid/models/transaction_code.rb +1 -1
- data/lib/plaid/models/transaction_counterparty.rb +1 -1
- 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_request.rb +1 -1
- data/lib/plaid/models/transactions_enrich_request_options.rb +1 -1
- data/lib/plaid/models/transactions_enrich_response.rb +1 -1
- data/lib/plaid/models/transactions_get_request.rb +1 -1
- data/lib/plaid/models/transactions_get_request_options.rb +2 -2
- data/lib/plaid/models/transactions_get_response.rb +1 -1
- data/lib/plaid/models/transactions_recurring_create_input.rb +1 -1
- data/lib/plaid/models/transactions_recurring_create_request.rb +1 -1
- data/lib/plaid/models/transactions_recurring_create_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_recurring_merge_input.rb +1 -1
- data/lib/plaid/models/transactions_recurring_merge_request.rb +1 -1
- data/lib/plaid/models/transactions_recurring_merge_response.rb +1 -1
- data/lib/plaid/models/transactions_recurring_update_input.rb +1 -1
- data/lib/plaid/models/transactions_recurring_update_request.rb +1 -1
- data/lib/plaid/models/transactions_recurring_update_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 +2 -2
- data/lib/plaid/models/transactions_sync_response.rb +1 -1
- data/lib/plaid/models/transactions_update_status.rb +1 -1
- data/lib/plaid/models/transactions_user_insights_get_request.rb +1 -1
- data/lib/plaid/models/transactions_user_insights_get_response.rb +1 -1
- data/lib/plaid/models/transfer.rb +13 -2
- data/lib/plaid/models/transfer_ach_network.rb +1 -1
- data/lib/plaid/models/transfer_authorization.rb +1 -1
- data/lib/plaid/models/transfer_authorization_cancel_request.rb +1 -1
- data/lib/plaid/models/transfer_authorization_cancel_response.rb +1 -1
- data/lib/plaid/models/transfer_authorization_create_request.rb +14 -3
- 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_payment_risk.rb +1 -1
- data/lib/plaid/models/transfer_authorization_proposed_transfer.rb +13 -2
- data/lib/plaid/models/transfer_authorization_risk_level.rb +1 -1
- data/lib/plaid/models/transfer_authorization_user_in_request.rb +1 -1
- data/lib/plaid/models/transfer_balance.rb +1 -1
- data/lib/plaid/models/transfer_balance_get_request.rb +1 -1
- data/lib/plaid/models/transfer_balance_get_response.rb +1 -1
- data/lib/plaid/models/transfer_balance_type.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 +1 -1
- data/lib/plaid/models/transfer_capabilities_get_response.rb +1 -1
- data/lib/plaid/models/transfer_capabilities_get_rtp.rb +1 -1
- data/lib/plaid/models/transfer_configuration_get_request.rb +1 -1
- data/lib/plaid/models/transfer_configuration_get_response.rb +1 -1
- 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_credit_funds_source.rb +1 -1
- data/lib/plaid/models/transfer_credit_usage_configuration.rb +1 -1
- data/lib/plaid/models/transfer_debit_usage_configuration.rb +1 -1
- data/lib/plaid/models/transfer_device.rb +1 -1
- data/lib/plaid/models/transfer_diligence_document_upload_request.rb +1 -1
- data/lib/plaid/models/transfer_diligence_document_upload_response.rb +1 -1
- data/lib/plaid/models/transfer_diligence_status.rb +1 -1
- data/lib/plaid/models/transfer_diligence_submit_request.rb +1 -1
- data/lib/plaid/models/transfer_diligence_submit_response.rb +1 -1
- data/lib/plaid/models/transfer_document_purpose.rb +1 -1
- data/lib/plaid/models/transfer_event.rb +13 -2
- 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_expected_sweep_settlement_schedule_item.rb +1 -1
- data/lib/plaid/models/transfer_failure.rb +1 -1
- data/lib/plaid/models/transfer_funding_account.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_network.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_ledger_balance.rb +1 -1
- data/lib/plaid/models/transfer_ledger_deposit_request.rb +13 -2
- data/lib/plaid/models/transfer_ledger_deposit_response.rb +1 -1
- data/lib/plaid/models/transfer_ledger_distribute_request.rb +1 -1
- data/lib/plaid/models/transfer_ledger_distribute_response.rb +1 -1
- data/lib/plaid/models/transfer_ledger_get_request.rb +13 -2
- data/lib/plaid/models/transfer_ledger_get_response.rb +1 -1
- data/lib/plaid/models/transfer_ledger_sweep_simulate_event_type.rb +1 -1
- data/lib/plaid/models/transfer_ledger_withdraw_request.rb +13 -2
- data/lib/plaid/models/transfer_ledger_withdraw_response.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_metrics_get_authorization_usage.rb +251 -0
- data/lib/plaid/models/transfer_metrics_get_request.rb +1 -1
- data/lib/plaid/models/transfer_metrics_get_response.rb +16 -6
- data/lib/plaid/models/transfer_metrics_get_return_rates.rb +1 -1
- data/lib/plaid/models/transfer_metrics_get_return_rates_over_interval.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_address.rb +1 -1
- data/lib/plaid/models/transfer_originator_create_request.rb +1 -1
- data/lib/plaid/models/transfer_originator_create_response.rb +1 -1
- data/lib/plaid/models/transfer_originator_diligence.rb +1 -1
- data/lib/plaid/models/transfer_originator_funding_account_update_request.rb +1 -1
- data/lib/plaid/models/transfer_originator_funding_account_update_response.rb +1 -1
- data/lib/plaid/models/transfer_originator_get_request.rb +1 -1
- data/lib/plaid/models/transfer_originator_get_response.rb +1 -1
- data/lib/plaid/models/transfer_originator_list_request.rb +1 -1
- data/lib/plaid/models/transfer_originator_list_response.rb +1 -1
- data/lib/plaid/models/transfer_platform_originator_create_request.rb +275 -0
- data/lib/plaid/models/transfer_platform_originator_create_response.rb +226 -0
- data/lib/plaid/models/transfer_platform_tos_acceptance_metadata.rb +256 -0
- data/lib/plaid/models/transfer_questionnaire_create_request.rb +1 -1
- data/lib/plaid/models/transfer_questionnaire_create_response.rb +1 -1
- data/lib/plaid/models/transfer_recurring_cancel_request.rb +1 -1
- data/lib/plaid/models/transfer_recurring_cancel_response.rb +1 -1
- data/lib/plaid/models/transfer_recurring_create_request.rb +1 -1
- data/lib/plaid/models/transfer_recurring_create_response.rb +1 -1
- data/lib/plaid/models/transfer_recurring_get_request.rb +1 -1
- data/lib/plaid/models/transfer_recurring_get_response.rb +1 -1
- data/lib/plaid/models/transfer_recurring_list_request.rb +1 -1
- data/lib/plaid/models/transfer_recurring_list_response.rb +1 -1
- data/lib/plaid/models/transfer_recurring_network.rb +1 -1
- data/lib/plaid/models/transfer_recurring_schedule.rb +1 -1
- data/lib/plaid/models/transfer_recurring_status.rb +1 -1
- data/lib/plaid/models/transfer_refund.rb +13 -2
- 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_failure.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 +13 -2
- 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 +1 -1
- 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/transfer_wire_details.rb +1 -1
- data/lib/plaid/models/update_entity_screening_request_search_terms.rb +4 -4
- data/lib/plaid/models/update_individual_screening_request_search_terms.rb +3 -3
- data/lib/plaid/models/user_account_identity.rb +1 -1
- data/lib/plaid/models/user_account_identity_address.rb +1 -1
- data/lib/plaid/models/user_account_identity_name.rb +1 -1
- data/lib/plaid/models/user_account_item.rb +1 -1
- data/lib/plaid/models/user_account_revoked_webhook.rb +1 -1
- data/lib/plaid/models/user_account_session_get_request.rb +1 -1
- data/lib/plaid/models/user_account_session_get_response.rb +1 -1
- data/lib/plaid/models/user_address.rb +2 -2
- 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_data_overview.rb +1 -1
- data/lib/plaid/models/user_id_number.rb +1 -1
- data/lib/plaid/models/user_items_get_request.rb +1 -1
- data/lib/plaid/models/user_items_get_response.rb +1 -1
- data/lib/plaid/models/user_permission_revoked_webhook.rb +2 -2
- data/lib/plaid/models/user_remove_request.rb +1 -1
- data/lib/plaid/models/user_remove_response.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/user_update_request.rb +1 -1
- data/lib/plaid/models/user_update_response.rb +1 -1
- data/lib/plaid/models/validation_source.rb +1 -1
- data/lib/plaid/models/validation_sources.rb +1 -1
- data/lib/plaid/models/verification_expired_webhook.rb +1 -1
- data/lib/plaid/models/verification_of_asset.rb +1 -1
- data/lib/plaid/models/verification_of_asset_response.rb +1 -1
- 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_box12_override.rb +1 -1
- data/lib/plaid/models/w2_override.rb +2 -2
- data/lib/plaid/models/w2_state_and_local_wages.rb +1 -1
- data/lib/plaid/models/w2_state_and_local_wages_override.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 +6 -6
- data/lib/plaid/models/wallet_list_response.rb +1 -1
- data/lib/plaid/models/wallet_numbers.rb +1 -1
- data/lib/plaid/models/wallet_payment_scheme.rb +1 -1
- data/lib/plaid/models/wallet_status.rb +1 -1
- data/lib/plaid/models/wallet_transaction.rb +18 -6
- 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_failure_reason.rb +1 -1
- data/lib/plaid/models/wallet_transaction_get_request.rb +1 -1
- data/lib/plaid/models/wallet_transaction_get_response.rb +14 -2
- 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_relation.rb +265 -0
- 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 +2 -2
- 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 +3 -3
- data/lib/plaid/models/watchlist_screening_review.rb +1 -1
- data/lib/plaid/models/watchlist_screening_search_terms.rb +3 -3
- 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 +71 -10
- data/plaid.gemspec +1 -1
- metadata +72 -11
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.556.0
|
7
7
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
OpenAPI Generator version: 6.3.0
|
@@ -836,7 +836,7 @@ module Plaid
|
|
836
836
|
end
|
837
837
|
|
838
838
|
# Retrieve auth data
|
839
|
-
# The `/auth/get` endpoint returns the bank account and bank identification numbers (such as routing numbers, for US accounts) associated with an Item's checking and savings accounts, along with high-level account data and balances when available.
|
839
|
+
# The `/auth/get` endpoint returns the bank account and bank identification numbers (such as routing numbers, for US accounts) associated with an Item's checking and savings accounts, along with high-level account data and balances when available. Versioning note: In API version 2017-03-08, the schema of the `numbers` object returned by this endpoint is substantially different. For details, see [Plaid API versioning](https://plaid.com/docs/api/versioning/#version-2018-05-22).
|
840
840
|
# @param auth_get_request [AuthGetRequest]
|
841
841
|
# @param [Hash] opts the optional parameters
|
842
842
|
# @return [AuthGetResponse]
|
@@ -846,7 +846,7 @@ module Plaid
|
|
846
846
|
end
|
847
847
|
|
848
848
|
# Retrieve auth data
|
849
|
-
# The `/auth/get` endpoint returns the bank account and bank identification numbers (such as routing numbers, for US accounts) associated with an Item's checking and savings accounts, along with high-level account data and balances when available.
|
849
|
+
# The `/auth/get` endpoint returns the bank account and bank identification numbers (such as routing numbers, for US accounts) associated with an Item's checking and savings accounts, along with high-level account data and balances when available. Versioning note: In API version 2017-03-08, the schema of the `numbers` object returned by this endpoint is substantially different. For details, see [Plaid API versioning](https://plaid.com/docs/api/versioning/#version-2018-05-22).
|
850
850
|
# @param auth_get_request [AuthGetRequest]
|
851
851
|
# @param [Hash] opts the optional parameters
|
852
852
|
# @return [Array<(AuthGetResponse, Integer, Hash)>] AuthGetResponse data, response status code and response headers
|
@@ -1583,142 +1583,6 @@ module Plaid
|
|
1583
1583
|
return data, status_code, headers
|
1584
1584
|
end
|
1585
1585
|
|
1586
|
-
# Create a Base Report
|
1587
|
-
# This endpoint allows the customer to create a Base Report by passing in a user token. The Base Report will be generated based on the most recently linked item from the user token.
|
1588
|
-
# @param base_report_create_request [BaseReportCreateRequest]
|
1589
|
-
# @param [Hash] opts the optional parameters
|
1590
|
-
# @return [BaseReportCreateResponse]
|
1591
|
-
def base_report_create(base_report_create_request, opts = {})
|
1592
|
-
data, _status_code, _headers = base_report_create_with_http_info(base_report_create_request, opts)
|
1593
|
-
data
|
1594
|
-
end
|
1595
|
-
|
1596
|
-
# Create a Base Report
|
1597
|
-
# This endpoint allows the customer to create a Base Report by passing in a user token. The Base Report will be generated based on the most recently linked item from the user token.
|
1598
|
-
# @param base_report_create_request [BaseReportCreateRequest]
|
1599
|
-
# @param [Hash] opts the optional parameters
|
1600
|
-
# @return [Array<(BaseReportCreateResponse, Integer, Hash)>] BaseReportCreateResponse data, response status code and response headers
|
1601
|
-
def base_report_create_with_http_info(base_report_create_request, opts = {})
|
1602
|
-
if @api_client.config.debugging
|
1603
|
-
@api_client.config.logger.debug 'Calling API: PlaidApi.base_report_create ...'
|
1604
|
-
end
|
1605
|
-
# verify the required parameter 'base_report_create_request' is set
|
1606
|
-
if @api_client.config.client_side_validation && base_report_create_request.nil?
|
1607
|
-
fail ArgumentError, "Missing the required parameter 'base_report_create_request' when calling PlaidApi.base_report_create"
|
1608
|
-
end
|
1609
|
-
# resource path
|
1610
|
-
local_var_path = '/cra/base_report/create'
|
1611
|
-
|
1612
|
-
# query parameters
|
1613
|
-
query_params = opts[:query_params] || {}
|
1614
|
-
|
1615
|
-
# header parameters
|
1616
|
-
header_params = opts[:header_params] || {}
|
1617
|
-
# HTTP header 'Accept' (if needed)
|
1618
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1619
|
-
# HTTP header 'Content-Type'
|
1620
|
-
content_type = @api_client.select_header_content_type(['application/json'])
|
1621
|
-
if !content_type.nil?
|
1622
|
-
header_params['Content-Type'] = content_type
|
1623
|
-
end
|
1624
|
-
|
1625
|
-
# form parameters
|
1626
|
-
form_params = opts[:form_params] || {}
|
1627
|
-
|
1628
|
-
# http body (model)
|
1629
|
-
post_body = opts[:debug_body] || @api_client.object_to_http_body(base_report_create_request)
|
1630
|
-
|
1631
|
-
# return_type
|
1632
|
-
return_type = opts[:debug_return_type] || 'BaseReportCreateResponse'
|
1633
|
-
|
1634
|
-
# auth_names
|
1635
|
-
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
1636
|
-
|
1637
|
-
new_options = opts.merge(
|
1638
|
-
:operation => :"PlaidApi.base_report_create",
|
1639
|
-
:header_params => header_params,
|
1640
|
-
:query_params => query_params,
|
1641
|
-
:form_params => form_params,
|
1642
|
-
:body => post_body,
|
1643
|
-
:auth_names => auth_names,
|
1644
|
-
:return_type => return_type
|
1645
|
-
)
|
1646
|
-
|
1647
|
-
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
1648
|
-
if @api_client.config.debugging
|
1649
|
-
@api_client.config.logger.debug "API called: PlaidApi#base_report_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1650
|
-
end
|
1651
|
-
return data, status_code, headers
|
1652
|
-
end
|
1653
|
-
|
1654
|
-
# Retrieve a Base Report
|
1655
|
-
# This endpoint allows the customer to retrieve a Base Report. Customers should pass in the `user_token` created in `/link/token/create`.
|
1656
|
-
# @param base_report_get_request [BaseReportGetRequest]
|
1657
|
-
# @param [Hash] opts the optional parameters
|
1658
|
-
# @return [BaseReportGetResponse]
|
1659
|
-
def base_report_get(base_report_get_request, opts = {})
|
1660
|
-
data, _status_code, _headers = base_report_get_with_http_info(base_report_get_request, opts)
|
1661
|
-
data
|
1662
|
-
end
|
1663
|
-
|
1664
|
-
# Retrieve a Base Report
|
1665
|
-
# This endpoint allows the customer to retrieve a Base Report. Customers should pass in the `user_token` created in `/link/token/create`.
|
1666
|
-
# @param base_report_get_request [BaseReportGetRequest]
|
1667
|
-
# @param [Hash] opts the optional parameters
|
1668
|
-
# @return [Array<(BaseReportGetResponse, Integer, Hash)>] BaseReportGetResponse data, response status code and response headers
|
1669
|
-
def base_report_get_with_http_info(base_report_get_request, opts = {})
|
1670
|
-
if @api_client.config.debugging
|
1671
|
-
@api_client.config.logger.debug 'Calling API: PlaidApi.base_report_get ...'
|
1672
|
-
end
|
1673
|
-
# verify the required parameter 'base_report_get_request' is set
|
1674
|
-
if @api_client.config.client_side_validation && base_report_get_request.nil?
|
1675
|
-
fail ArgumentError, "Missing the required parameter 'base_report_get_request' when calling PlaidApi.base_report_get"
|
1676
|
-
end
|
1677
|
-
# resource path
|
1678
|
-
local_var_path = '/cra/base_report/get'
|
1679
|
-
|
1680
|
-
# query parameters
|
1681
|
-
query_params = opts[:query_params] || {}
|
1682
|
-
|
1683
|
-
# header parameters
|
1684
|
-
header_params = opts[:header_params] || {}
|
1685
|
-
# HTTP header 'Accept' (if needed)
|
1686
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1687
|
-
# HTTP header 'Content-Type'
|
1688
|
-
content_type = @api_client.select_header_content_type(['application/json'])
|
1689
|
-
if !content_type.nil?
|
1690
|
-
header_params['Content-Type'] = content_type
|
1691
|
-
end
|
1692
|
-
|
1693
|
-
# form parameters
|
1694
|
-
form_params = opts[:form_params] || {}
|
1695
|
-
|
1696
|
-
# http body (model)
|
1697
|
-
post_body = opts[:debug_body] || @api_client.object_to_http_body(base_report_get_request)
|
1698
|
-
|
1699
|
-
# return_type
|
1700
|
-
return_type = opts[:debug_return_type] || 'BaseReportGetResponse'
|
1701
|
-
|
1702
|
-
# auth_names
|
1703
|
-
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
1704
|
-
|
1705
|
-
new_options = opts.merge(
|
1706
|
-
:operation => :"PlaidApi.base_report_get",
|
1707
|
-
:header_params => header_params,
|
1708
|
-
:query_params => query_params,
|
1709
|
-
:form_params => form_params,
|
1710
|
-
:body => post_body,
|
1711
|
-
:auth_names => auth_names,
|
1712
|
-
:return_type => return_type
|
1713
|
-
)
|
1714
|
-
|
1715
|
-
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
1716
|
-
if @api_client.config.debugging
|
1717
|
-
@api_client.config.logger.debug "API called: PlaidApi#base_report_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1718
|
-
end
|
1719
|
-
return data, status_code, headers
|
1720
|
-
end
|
1721
|
-
|
1722
1586
|
# Evaluate risk of a bank account
|
1723
1587
|
# Use `/beacon/account_risk/v1/evaluate` to get risk insights for a linked account.
|
1724
1588
|
# @param beacon_account_risk_evaluate_request [BeaconAccountRiskEvaluateRequest]
|
@@ -2875,6 +2739,142 @@ module Plaid
|
|
2875
2739
|
return data, status_code, headers
|
2876
2740
|
end
|
2877
2741
|
|
2742
|
+
# Create a Base Report
|
2743
|
+
# This endpoint allows the customer to create a Base Report by passing in a user token. The Base Report will be generated based on the most recently linked item from the user token.
|
2744
|
+
# @param cra_base_report_create_request [CraBaseReportCreateRequest]
|
2745
|
+
# @param [Hash] opts the optional parameters
|
2746
|
+
# @return [CraBaseReportCreateResponse]
|
2747
|
+
def cra_base_report_create(cra_base_report_create_request, opts = {})
|
2748
|
+
data, _status_code, _headers = cra_base_report_create_with_http_info(cra_base_report_create_request, opts)
|
2749
|
+
data
|
2750
|
+
end
|
2751
|
+
|
2752
|
+
# Create a Base Report
|
2753
|
+
# This endpoint allows the customer to create a Base Report by passing in a user token. The Base Report will be generated based on the most recently linked item from the user token.
|
2754
|
+
# @param cra_base_report_create_request [CraBaseReportCreateRequest]
|
2755
|
+
# @param [Hash] opts the optional parameters
|
2756
|
+
# @return [Array<(CraBaseReportCreateResponse, Integer, Hash)>] CraBaseReportCreateResponse data, response status code and response headers
|
2757
|
+
def cra_base_report_create_with_http_info(cra_base_report_create_request, opts = {})
|
2758
|
+
if @api_client.config.debugging
|
2759
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.cra_base_report_create ...'
|
2760
|
+
end
|
2761
|
+
# verify the required parameter 'cra_base_report_create_request' is set
|
2762
|
+
if @api_client.config.client_side_validation && cra_base_report_create_request.nil?
|
2763
|
+
fail ArgumentError, "Missing the required parameter 'cra_base_report_create_request' when calling PlaidApi.cra_base_report_create"
|
2764
|
+
end
|
2765
|
+
# resource path
|
2766
|
+
local_var_path = '/cra/base_report/create'
|
2767
|
+
|
2768
|
+
# query parameters
|
2769
|
+
query_params = opts[:query_params] || {}
|
2770
|
+
|
2771
|
+
# header parameters
|
2772
|
+
header_params = opts[:header_params] || {}
|
2773
|
+
# HTTP header 'Accept' (if needed)
|
2774
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
2775
|
+
# HTTP header 'Content-Type'
|
2776
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
2777
|
+
if !content_type.nil?
|
2778
|
+
header_params['Content-Type'] = content_type
|
2779
|
+
end
|
2780
|
+
|
2781
|
+
# form parameters
|
2782
|
+
form_params = opts[:form_params] || {}
|
2783
|
+
|
2784
|
+
# http body (model)
|
2785
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(cra_base_report_create_request)
|
2786
|
+
|
2787
|
+
# return_type
|
2788
|
+
return_type = opts[:debug_return_type] || 'CraBaseReportCreateResponse'
|
2789
|
+
|
2790
|
+
# auth_names
|
2791
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
2792
|
+
|
2793
|
+
new_options = opts.merge(
|
2794
|
+
:operation => :"PlaidApi.cra_base_report_create",
|
2795
|
+
:header_params => header_params,
|
2796
|
+
:query_params => query_params,
|
2797
|
+
:form_params => form_params,
|
2798
|
+
:body => post_body,
|
2799
|
+
:auth_names => auth_names,
|
2800
|
+
:return_type => return_type
|
2801
|
+
)
|
2802
|
+
|
2803
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
2804
|
+
if @api_client.config.debugging
|
2805
|
+
@api_client.config.logger.debug "API called: PlaidApi#cra_base_report_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2806
|
+
end
|
2807
|
+
return data, status_code, headers
|
2808
|
+
end
|
2809
|
+
|
2810
|
+
# Retrieve a Base Report
|
2811
|
+
# This endpoint allows the customer to retrieve a Base Report. Customers should pass in the `user_token` created in `/user/create`.
|
2812
|
+
# @param cra_base_report_get_request [CraBaseReportGetRequest]
|
2813
|
+
# @param [Hash] opts the optional parameters
|
2814
|
+
# @return [CraBaseReportGetResponse]
|
2815
|
+
def cra_base_report_get(cra_base_report_get_request, opts = {})
|
2816
|
+
data, _status_code, _headers = cra_base_report_get_with_http_info(cra_base_report_get_request, opts)
|
2817
|
+
data
|
2818
|
+
end
|
2819
|
+
|
2820
|
+
# Retrieve a Base Report
|
2821
|
+
# This endpoint allows the customer to retrieve a Base Report. Customers should pass in the `user_token` created in `/user/create`.
|
2822
|
+
# @param cra_base_report_get_request [CraBaseReportGetRequest]
|
2823
|
+
# @param [Hash] opts the optional parameters
|
2824
|
+
# @return [Array<(CraBaseReportGetResponse, Integer, Hash)>] CraBaseReportGetResponse data, response status code and response headers
|
2825
|
+
def cra_base_report_get_with_http_info(cra_base_report_get_request, opts = {})
|
2826
|
+
if @api_client.config.debugging
|
2827
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.cra_base_report_get ...'
|
2828
|
+
end
|
2829
|
+
# verify the required parameter 'cra_base_report_get_request' is set
|
2830
|
+
if @api_client.config.client_side_validation && cra_base_report_get_request.nil?
|
2831
|
+
fail ArgumentError, "Missing the required parameter 'cra_base_report_get_request' when calling PlaidApi.cra_base_report_get"
|
2832
|
+
end
|
2833
|
+
# resource path
|
2834
|
+
local_var_path = '/cra/base_report/get'
|
2835
|
+
|
2836
|
+
# query parameters
|
2837
|
+
query_params = opts[:query_params] || {}
|
2838
|
+
|
2839
|
+
# header parameters
|
2840
|
+
header_params = opts[:header_params] || {}
|
2841
|
+
# HTTP header 'Accept' (if needed)
|
2842
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
2843
|
+
# HTTP header 'Content-Type'
|
2844
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
2845
|
+
if !content_type.nil?
|
2846
|
+
header_params['Content-Type'] = content_type
|
2847
|
+
end
|
2848
|
+
|
2849
|
+
# form parameters
|
2850
|
+
form_params = opts[:form_params] || {}
|
2851
|
+
|
2852
|
+
# http body (model)
|
2853
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(cra_base_report_get_request)
|
2854
|
+
|
2855
|
+
# return_type
|
2856
|
+
return_type = opts[:debug_return_type] || 'CraBaseReportGetResponse'
|
2857
|
+
|
2858
|
+
# auth_names
|
2859
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
2860
|
+
|
2861
|
+
new_options = opts.merge(
|
2862
|
+
:operation => :"PlaidApi.cra_base_report_get",
|
2863
|
+
:header_params => header_params,
|
2864
|
+
:query_params => query_params,
|
2865
|
+
:form_params => form_params,
|
2866
|
+
:body => post_body,
|
2867
|
+
:auth_names => auth_names,
|
2868
|
+
:return_type => return_type
|
2869
|
+
)
|
2870
|
+
|
2871
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
2872
|
+
if @api_client.config.debugging
|
2873
|
+
@api_client.config.logger.debug "API called: PlaidApi#cra_base_report_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2874
|
+
end
|
2875
|
+
return data, status_code, headers
|
2876
|
+
end
|
2877
|
+
|
2878
2878
|
# Retrieve a Base Report
|
2879
2879
|
# This endpoint allows you to retrieve the Base Report for your user, allowing you to receive comprehensive bank account and cash flow data. You should call this endpoint after you've received a `CHECK_REPORT_READY` webhook, either after the Link session for the user or after calling `/cra/check_report/create`. If the most recent consumer report for the user doesn't have sufficient data to generate the base report, or the consumer report has expired, you will receive an error indicating that you should create a new consumer report by calling `/cra/check_report/create`.
|
2880
2880
|
# @param cra_check_report_base_report_get_request [CraCheckReportBaseReportGetRequest]
|
@@ -3080,27 +3080,27 @@ module Plaid
|
|
3080
3080
|
end
|
3081
3081
|
|
3082
3082
|
# Retrieve network attributes for the user
|
3083
|
-
# This endpoint allows you to retrieve the Network
|
3084
|
-
# @param
|
3083
|
+
# This endpoint allows you to retrieve the Network Insights product for your user. You should call this endpoint after you've received the `CHECK_REPORT_READY` webhook, either after the Link session for the user or after calling `/cra/check_report/create`. If the most recent consumer report for the user doesn’t have sufficient data to generate the report, or the consumer report has expired, you will receive an error indicating that you should create a new consumer report by calling `/cra/check_report/create`. If you did not initialize Link with the `cra_network_attributes` product or have generated a report using `/cra/check_report/create`, we will generate the attributes when you call this endpoint.
|
3084
|
+
# @param cra_check_report_network_insights_get_request [CraCheckReportNetworkInsightsGetRequest]
|
3085
3085
|
# @param [Hash] opts the optional parameters
|
3086
|
-
# @return [
|
3087
|
-
def
|
3088
|
-
data, _status_code, _headers =
|
3086
|
+
# @return [CraCheckReportNetworkInsightsGetResponse]
|
3087
|
+
def cra_check_report_network_insights_get(cra_check_report_network_insights_get_request, opts = {})
|
3088
|
+
data, _status_code, _headers = cra_check_report_network_insights_get_with_http_info(cra_check_report_network_insights_get_request, opts)
|
3089
3089
|
data
|
3090
3090
|
end
|
3091
3091
|
|
3092
3092
|
# Retrieve network attributes for the user
|
3093
|
-
# This endpoint allows you to retrieve the Network
|
3094
|
-
# @param
|
3093
|
+
# This endpoint allows you to retrieve the Network Insights product for your user. You should call this endpoint after you've received the `CHECK_REPORT_READY` webhook, either after the Link session for the user or after calling `/cra/check_report/create`. If the most recent consumer report for the user doesn’t have sufficient data to generate the report, or the consumer report has expired, you will receive an error indicating that you should create a new consumer report by calling `/cra/check_report/create`. If you did not initialize Link with the `cra_network_attributes` product or have generated a report using `/cra/check_report/create`, we will generate the attributes when you call this endpoint.
|
3094
|
+
# @param cra_check_report_network_insights_get_request [CraCheckReportNetworkInsightsGetRequest]
|
3095
3095
|
# @param [Hash] opts the optional parameters
|
3096
|
-
# @return [Array<(
|
3097
|
-
def
|
3096
|
+
# @return [Array<(CraCheckReportNetworkInsightsGetResponse, Integer, Hash)>] CraCheckReportNetworkInsightsGetResponse data, response status code and response headers
|
3097
|
+
def cra_check_report_network_insights_get_with_http_info(cra_check_report_network_insights_get_request, opts = {})
|
3098
3098
|
if @api_client.config.debugging
|
3099
|
-
@api_client.config.logger.debug 'Calling API: PlaidApi.
|
3099
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.cra_check_report_network_insights_get ...'
|
3100
3100
|
end
|
3101
|
-
# verify the required parameter '
|
3102
|
-
if @api_client.config.client_side_validation &&
|
3103
|
-
fail ArgumentError, "Missing the required parameter '
|
3101
|
+
# verify the required parameter 'cra_check_report_network_insights_get_request' is set
|
3102
|
+
if @api_client.config.client_side_validation && cra_check_report_network_insights_get_request.nil?
|
3103
|
+
fail ArgumentError, "Missing the required parameter 'cra_check_report_network_insights_get_request' when calling PlaidApi.cra_check_report_network_insights_get"
|
3104
3104
|
end
|
3105
3105
|
# resource path
|
3106
3106
|
local_var_path = '/cra/check_report/network_insights/get'
|
@@ -3122,16 +3122,16 @@ module Plaid
|
|
3122
3122
|
form_params = opts[:form_params] || {}
|
3123
3123
|
|
3124
3124
|
# http body (model)
|
3125
|
-
post_body = opts[:debug_body] || @api_client.object_to_http_body(
|
3125
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(cra_check_report_network_insights_get_request)
|
3126
3126
|
|
3127
3127
|
# return_type
|
3128
|
-
return_type = opts[:debug_return_type] || '
|
3128
|
+
return_type = opts[:debug_return_type] || 'CraCheckReportNetworkInsightsGetResponse'
|
3129
3129
|
|
3130
3130
|
# auth_names
|
3131
3131
|
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
3132
3132
|
|
3133
3133
|
new_options = opts.merge(
|
3134
|
-
:operation => :"PlaidApi.
|
3134
|
+
:operation => :"PlaidApi.cra_check_report_network_insights_get",
|
3135
3135
|
:header_params => header_params,
|
3136
3136
|
:query_params => query_params,
|
3137
3137
|
:form_params => form_params,
|
@@ -3142,13 +3142,13 @@ module Plaid
|
|
3142
3142
|
|
3143
3143
|
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
3144
3144
|
if @api_client.config.debugging
|
3145
|
-
@api_client.config.logger.debug "API called: PlaidApi#
|
3145
|
+
@api_client.config.logger.debug "API called: PlaidApi#cra_check_report_network_insights_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
3146
3146
|
end
|
3147
3147
|
return data, status_code, headers
|
3148
3148
|
end
|
3149
3149
|
|
3150
3150
|
# Retrieve cash flow insights from partners
|
3151
|
-
# This endpoint allows you to retrieve the Partner Insights
|
3151
|
+
# This endpoint allows you to retrieve the Partner Insights report for your user. You should call this endpoint after you've received the `CHECK_REPORT_READY` webhook, either after the Link session for the user or after calling `/cra/check_report/create`. If the most recent consumer report for the user doesn’t have sufficient data to generate the base report, or the consumer report has expired, you will receive an error indicating that you should create a new consumer report by calling `/cra/check_report/create`. If you did not initialize Link with the `credit_partner_insights` product or have generated a report using `/cra/check_report/create`, we will call our partners to generate the insights when you call this endpoint. In this case, you may optionally provide parameters under `options` to configure which insights you want to receive.
|
3152
3152
|
# @param cra_check_report_partner_insights_get_request [CraCheckReportPartnerInsightsGetRequest]
|
3153
3153
|
# @param [Hash] opts the optional parameters
|
3154
3154
|
# @return [CraCheckReportPartnerInsightsGetResponse]
|
@@ -3158,7 +3158,7 @@ module Plaid
|
|
3158
3158
|
end
|
3159
3159
|
|
3160
3160
|
# Retrieve cash flow insights from partners
|
3161
|
-
# This endpoint allows you to retrieve the Partner Insights
|
3161
|
+
# This endpoint allows you to retrieve the Partner Insights report for your user. You should call this endpoint after you've received the `CHECK_REPORT_READY` webhook, either after the Link session for the user or after calling `/cra/check_report/create`. If the most recent consumer report for the user doesn’t have sufficient data to generate the base report, or the consumer report has expired, you will receive an error indicating that you should create a new consumer report by calling `/cra/check_report/create`. If you did not initialize Link with the `credit_partner_insights` product or have generated a report using `/cra/check_report/create`, we will call our partners to generate the insights when you call this endpoint. In this case, you may optionally provide parameters under `options` to configure which insights you want to receive.
|
3162
3162
|
# @param cra_check_report_partner_insights_get_request [CraCheckReportPartnerInsightsGetRequest]
|
3163
3163
|
# @param [Hash] opts the optional parameters
|
3164
3164
|
# @return [Array<(CraCheckReportPartnerInsightsGetResponse, Integer, Hash)>] CraCheckReportPartnerInsightsGetResponse data, response status code and response headers
|
@@ -3215,8 +3215,8 @@ module Plaid
|
|
3215
3215
|
return data, status_code, headers
|
3216
3216
|
end
|
3217
3217
|
|
3218
|
-
# Retrieve
|
3219
|
-
# `/cra/check_report/pdf/get`
|
3218
|
+
# Retrieve Consumer Reports as a PDF
|
3219
|
+
# `/cra/check_report/pdf/get` retrieves the most recent Bank Income report (if it exists) followed by the most recent Base Report (if it exists) in PDF format.
|
3220
3220
|
# @param cra_check_report_pdf_get_request [CraCheckReportPDFGetRequest]
|
3221
3221
|
# @param [Hash] opts the optional parameters
|
3222
3222
|
# @return [File]
|
@@ -3225,8 +3225,8 @@ module Plaid
|
|
3225
3225
|
data
|
3226
3226
|
end
|
3227
3227
|
|
3228
|
-
# Retrieve
|
3229
|
-
# `/cra/check_report/pdf/get`
|
3228
|
+
# Retrieve Consumer Reports as a PDF
|
3229
|
+
# `/cra/check_report/pdf/get` retrieves the most recent Bank Income report (if it exists) followed by the most recent Base Report (if it exists) in PDF format.
|
3230
3230
|
# @param cra_check_report_pdf_get_request [CraCheckReportPDFGetRequest]
|
3231
3231
|
# @param [Hash] opts the optional parameters
|
3232
3232
|
# @return [Array<(File, Integer, Hash)>] File data, response status code and response headers
|
@@ -3436,14 +3436,218 @@ module Plaid
|
|
3436
3436
|
# @return [Array<(CraLoanUnregisterResponse, Integer, Hash)>] CraLoanUnregisterResponse data, response status code and response headers
|
3437
3437
|
def cra_loans_unregister_with_http_info(cra_loans_unregister_request, opts = {})
|
3438
3438
|
if @api_client.config.debugging
|
3439
|
-
@api_client.config.logger.debug 'Calling API: PlaidApi.cra_loans_unregister ...'
|
3439
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.cra_loans_unregister ...'
|
3440
|
+
end
|
3441
|
+
# verify the required parameter 'cra_loans_unregister_request' is set
|
3442
|
+
if @api_client.config.client_side_validation && cra_loans_unregister_request.nil?
|
3443
|
+
fail ArgumentError, "Missing the required parameter 'cra_loans_unregister_request' when calling PlaidApi.cra_loans_unregister"
|
3444
|
+
end
|
3445
|
+
# resource path
|
3446
|
+
local_var_path = '/cra/loans/unregister'
|
3447
|
+
|
3448
|
+
# query parameters
|
3449
|
+
query_params = opts[:query_params] || {}
|
3450
|
+
|
3451
|
+
# header parameters
|
3452
|
+
header_params = opts[:header_params] || {}
|
3453
|
+
# HTTP header 'Accept' (if needed)
|
3454
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
3455
|
+
# HTTP header 'Content-Type'
|
3456
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
3457
|
+
if !content_type.nil?
|
3458
|
+
header_params['Content-Type'] = content_type
|
3459
|
+
end
|
3460
|
+
|
3461
|
+
# form parameters
|
3462
|
+
form_params = opts[:form_params] || {}
|
3463
|
+
|
3464
|
+
# http body (model)
|
3465
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(cra_loans_unregister_request)
|
3466
|
+
|
3467
|
+
# return_type
|
3468
|
+
return_type = opts[:debug_return_type] || 'CraLoanUnregisterResponse'
|
3469
|
+
|
3470
|
+
# auth_names
|
3471
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
3472
|
+
|
3473
|
+
new_options = opts.merge(
|
3474
|
+
:operation => :"PlaidApi.cra_loans_unregister",
|
3475
|
+
:header_params => header_params,
|
3476
|
+
:query_params => query_params,
|
3477
|
+
:form_params => form_params,
|
3478
|
+
:body => post_body,
|
3479
|
+
:auth_names => auth_names,
|
3480
|
+
:return_type => return_type
|
3481
|
+
)
|
3482
|
+
|
3483
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
3484
|
+
if @api_client.config.debugging
|
3485
|
+
@api_client.config.logger.debug "API called: PlaidApi#cra_loans_unregister\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
3486
|
+
end
|
3487
|
+
return data, status_code, headers
|
3488
|
+
end
|
3489
|
+
|
3490
|
+
# Updates loan data.
|
3491
|
+
# `/cra/loans/update` updates loan information such as the status and payment history.
|
3492
|
+
# @param cra_loans_update_request [CraLoansUpdateRequest]
|
3493
|
+
# @param [Hash] opts the optional parameters
|
3494
|
+
# @return [CraLoansUpdateResponse]
|
3495
|
+
def cra_loans_update(cra_loans_update_request, opts = {})
|
3496
|
+
data, _status_code, _headers = cra_loans_update_with_http_info(cra_loans_update_request, opts)
|
3497
|
+
data
|
3498
|
+
end
|
3499
|
+
|
3500
|
+
# Updates loan data.
|
3501
|
+
# `/cra/loans/update` updates loan information such as the status and payment history.
|
3502
|
+
# @param cra_loans_update_request [CraLoansUpdateRequest]
|
3503
|
+
# @param [Hash] opts the optional parameters
|
3504
|
+
# @return [Array<(CraLoansUpdateResponse, Integer, Hash)>] CraLoansUpdateResponse data, response status code and response headers
|
3505
|
+
def cra_loans_update_with_http_info(cra_loans_update_request, opts = {})
|
3506
|
+
if @api_client.config.debugging
|
3507
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.cra_loans_update ...'
|
3508
|
+
end
|
3509
|
+
# verify the required parameter 'cra_loans_update_request' is set
|
3510
|
+
if @api_client.config.client_side_validation && cra_loans_update_request.nil?
|
3511
|
+
fail ArgumentError, "Missing the required parameter 'cra_loans_update_request' when calling PlaidApi.cra_loans_update"
|
3512
|
+
end
|
3513
|
+
# resource path
|
3514
|
+
local_var_path = '/cra/loans/update'
|
3515
|
+
|
3516
|
+
# query parameters
|
3517
|
+
query_params = opts[:query_params] || {}
|
3518
|
+
|
3519
|
+
# header parameters
|
3520
|
+
header_params = opts[:header_params] || {}
|
3521
|
+
# HTTP header 'Accept' (if needed)
|
3522
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
3523
|
+
# HTTP header 'Content-Type'
|
3524
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
3525
|
+
if !content_type.nil?
|
3526
|
+
header_params['Content-Type'] = content_type
|
3527
|
+
end
|
3528
|
+
|
3529
|
+
# form parameters
|
3530
|
+
form_params = opts[:form_params] || {}
|
3531
|
+
|
3532
|
+
# http body (model)
|
3533
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(cra_loans_update_request)
|
3534
|
+
|
3535
|
+
# return_type
|
3536
|
+
return_type = opts[:debug_return_type] || 'CraLoansUpdateResponse'
|
3537
|
+
|
3538
|
+
# auth_names
|
3539
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
3540
|
+
|
3541
|
+
new_options = opts.merge(
|
3542
|
+
:operation => :"PlaidApi.cra_loans_update",
|
3543
|
+
:header_params => header_params,
|
3544
|
+
:query_params => query_params,
|
3545
|
+
:form_params => form_params,
|
3546
|
+
:body => post_body,
|
3547
|
+
:auth_names => auth_names,
|
3548
|
+
:return_type => return_type
|
3549
|
+
)
|
3550
|
+
|
3551
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
3552
|
+
if @api_client.config.debugging
|
3553
|
+
@api_client.config.logger.debug "API called: PlaidApi#cra_loans_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
3554
|
+
end
|
3555
|
+
return data, status_code, headers
|
3556
|
+
end
|
3557
|
+
|
3558
|
+
# Retrieve a Monitoring Insights Report
|
3559
|
+
# This endpoint allows you to retrieve a Monitoring Insights report by passing in the `user_token` referred to in the webhook you received.
|
3560
|
+
# @param cra_monitoring_insights_get_request [CraMonitoringInsightsGetRequest]
|
3561
|
+
# @param [Hash] opts the optional parameters
|
3562
|
+
# @return [CraMonitoringInsightsGetResponse]
|
3563
|
+
def cra_monitoring_insights_get(cra_monitoring_insights_get_request, opts = {})
|
3564
|
+
data, _status_code, _headers = cra_monitoring_insights_get_with_http_info(cra_monitoring_insights_get_request, opts)
|
3565
|
+
data
|
3566
|
+
end
|
3567
|
+
|
3568
|
+
# Retrieve a Monitoring Insights Report
|
3569
|
+
# This endpoint allows you to retrieve a Monitoring Insights report by passing in the `user_token` referred to in the webhook you received.
|
3570
|
+
# @param cra_monitoring_insights_get_request [CraMonitoringInsightsGetRequest]
|
3571
|
+
# @param [Hash] opts the optional parameters
|
3572
|
+
# @return [Array<(CraMonitoringInsightsGetResponse, Integer, Hash)>] CraMonitoringInsightsGetResponse data, response status code and response headers
|
3573
|
+
def cra_monitoring_insights_get_with_http_info(cra_monitoring_insights_get_request, opts = {})
|
3574
|
+
if @api_client.config.debugging
|
3575
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.cra_monitoring_insights_get ...'
|
3576
|
+
end
|
3577
|
+
# verify the required parameter 'cra_monitoring_insights_get_request' is set
|
3578
|
+
if @api_client.config.client_side_validation && cra_monitoring_insights_get_request.nil?
|
3579
|
+
fail ArgumentError, "Missing the required parameter 'cra_monitoring_insights_get_request' when calling PlaidApi.cra_monitoring_insights_get"
|
3580
|
+
end
|
3581
|
+
# resource path
|
3582
|
+
local_var_path = '/cra/monitoring_insights/get'
|
3583
|
+
|
3584
|
+
# query parameters
|
3585
|
+
query_params = opts[:query_params] || {}
|
3586
|
+
|
3587
|
+
# header parameters
|
3588
|
+
header_params = opts[:header_params] || {}
|
3589
|
+
# HTTP header 'Accept' (if needed)
|
3590
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
3591
|
+
# HTTP header 'Content-Type'
|
3592
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
3593
|
+
if !content_type.nil?
|
3594
|
+
header_params['Content-Type'] = content_type
|
3595
|
+
end
|
3596
|
+
|
3597
|
+
# form parameters
|
3598
|
+
form_params = opts[:form_params] || {}
|
3599
|
+
|
3600
|
+
# http body (model)
|
3601
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(cra_monitoring_insights_get_request)
|
3602
|
+
|
3603
|
+
# return_type
|
3604
|
+
return_type = opts[:debug_return_type] || 'CraMonitoringInsightsGetResponse'
|
3605
|
+
|
3606
|
+
# auth_names
|
3607
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
3608
|
+
|
3609
|
+
new_options = opts.merge(
|
3610
|
+
:operation => :"PlaidApi.cra_monitoring_insights_get",
|
3611
|
+
:header_params => header_params,
|
3612
|
+
:query_params => query_params,
|
3613
|
+
:form_params => form_params,
|
3614
|
+
:body => post_body,
|
3615
|
+
:auth_names => auth_names,
|
3616
|
+
:return_type => return_type
|
3617
|
+
)
|
3618
|
+
|
3619
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
3620
|
+
if @api_client.config.debugging
|
3621
|
+
@api_client.config.logger.debug "API called: PlaidApi#cra_monitoring_insights_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
3622
|
+
end
|
3623
|
+
return data, status_code, headers
|
3624
|
+
end
|
3625
|
+
|
3626
|
+
# Subscribe to Monitoring Insights
|
3627
|
+
# This endpoint allows you to subscribe to insights for a user's linked CRA items, which are updated every 14 days.
|
3628
|
+
# @param cra_monitoring_insights_subscribe_request [CraMonitoringInsightsSubscribeRequest]
|
3629
|
+
# @param [Hash] opts the optional parameters
|
3630
|
+
# @return [CraMonitoringInsightsSubscribeResponse]
|
3631
|
+
def cra_monitoring_insights_subscribe(cra_monitoring_insights_subscribe_request, opts = {})
|
3632
|
+
data, _status_code, _headers = cra_monitoring_insights_subscribe_with_http_info(cra_monitoring_insights_subscribe_request, opts)
|
3633
|
+
data
|
3634
|
+
end
|
3635
|
+
|
3636
|
+
# Subscribe to Monitoring Insights
|
3637
|
+
# This endpoint allows you to subscribe to insights for a user's linked CRA items, which are updated every 14 days.
|
3638
|
+
# @param cra_monitoring_insights_subscribe_request [CraMonitoringInsightsSubscribeRequest]
|
3639
|
+
# @param [Hash] opts the optional parameters
|
3640
|
+
# @return [Array<(CraMonitoringInsightsSubscribeResponse, Integer, Hash)>] CraMonitoringInsightsSubscribeResponse data, response status code and response headers
|
3641
|
+
def cra_monitoring_insights_subscribe_with_http_info(cra_monitoring_insights_subscribe_request, opts = {})
|
3642
|
+
if @api_client.config.debugging
|
3643
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.cra_monitoring_insights_subscribe ...'
|
3440
3644
|
end
|
3441
|
-
# verify the required parameter '
|
3442
|
-
if @api_client.config.client_side_validation &&
|
3443
|
-
fail ArgumentError, "Missing the required parameter '
|
3645
|
+
# verify the required parameter 'cra_monitoring_insights_subscribe_request' is set
|
3646
|
+
if @api_client.config.client_side_validation && cra_monitoring_insights_subscribe_request.nil?
|
3647
|
+
fail ArgumentError, "Missing the required parameter 'cra_monitoring_insights_subscribe_request' when calling PlaidApi.cra_monitoring_insights_subscribe"
|
3444
3648
|
end
|
3445
3649
|
# resource path
|
3446
|
-
local_var_path = '/cra/
|
3650
|
+
local_var_path = '/cra/monitoring_insights/subscribe'
|
3447
3651
|
|
3448
3652
|
# query parameters
|
3449
3653
|
query_params = opts[:query_params] || {}
|
@@ -3462,16 +3666,16 @@ module Plaid
|
|
3462
3666
|
form_params = opts[:form_params] || {}
|
3463
3667
|
|
3464
3668
|
# http body (model)
|
3465
|
-
post_body = opts[:debug_body] || @api_client.object_to_http_body(
|
3669
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(cra_monitoring_insights_subscribe_request)
|
3466
3670
|
|
3467
3671
|
# return_type
|
3468
|
-
return_type = opts[:debug_return_type] || '
|
3672
|
+
return_type = opts[:debug_return_type] || 'CraMonitoringInsightsSubscribeResponse'
|
3469
3673
|
|
3470
3674
|
# auth_names
|
3471
3675
|
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
3472
3676
|
|
3473
3677
|
new_options = opts.merge(
|
3474
|
-
:operation => :"PlaidApi.
|
3678
|
+
:operation => :"PlaidApi.cra_monitoring_insights_subscribe",
|
3475
3679
|
:header_params => header_params,
|
3476
3680
|
:query_params => query_params,
|
3477
3681
|
:form_params => form_params,
|
@@ -3482,36 +3686,36 @@ module Plaid
|
|
3482
3686
|
|
3483
3687
|
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
3484
3688
|
if @api_client.config.debugging
|
3485
|
-
@api_client.config.logger.debug "API called: PlaidApi#
|
3689
|
+
@api_client.config.logger.debug "API called: PlaidApi#cra_monitoring_insights_subscribe\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
3486
3690
|
end
|
3487
3691
|
return data, status_code, headers
|
3488
3692
|
end
|
3489
3693
|
|
3490
|
-
#
|
3491
|
-
#
|
3492
|
-
# @param
|
3694
|
+
# Unsubscribe from Monitoring Insights
|
3695
|
+
# This endpoint allows you to unsubscribe from previously subscribed Monitoring Insights.
|
3696
|
+
# @param cra_monitoring_insights_unsubscribe_request [CraMonitoringInsightsUnsubscribeRequest]
|
3493
3697
|
# @param [Hash] opts the optional parameters
|
3494
|
-
# @return [
|
3495
|
-
def
|
3496
|
-
data, _status_code, _headers =
|
3698
|
+
# @return [CraMonitoringInsightsUnsubscribeResponse]
|
3699
|
+
def cra_monitoring_insights_unsubscribe(cra_monitoring_insights_unsubscribe_request, opts = {})
|
3700
|
+
data, _status_code, _headers = cra_monitoring_insights_unsubscribe_with_http_info(cra_monitoring_insights_unsubscribe_request, opts)
|
3497
3701
|
data
|
3498
3702
|
end
|
3499
3703
|
|
3500
|
-
#
|
3501
|
-
#
|
3502
|
-
# @param
|
3704
|
+
# Unsubscribe from Monitoring Insights
|
3705
|
+
# This endpoint allows you to unsubscribe from previously subscribed Monitoring Insights.
|
3706
|
+
# @param cra_monitoring_insights_unsubscribe_request [CraMonitoringInsightsUnsubscribeRequest]
|
3503
3707
|
# @param [Hash] opts the optional parameters
|
3504
|
-
# @return [Array<(
|
3505
|
-
def
|
3708
|
+
# @return [Array<(CraMonitoringInsightsUnsubscribeResponse, Integer, Hash)>] CraMonitoringInsightsUnsubscribeResponse data, response status code and response headers
|
3709
|
+
def cra_monitoring_insights_unsubscribe_with_http_info(cra_monitoring_insights_unsubscribe_request, opts = {})
|
3506
3710
|
if @api_client.config.debugging
|
3507
|
-
@api_client.config.logger.debug 'Calling API: PlaidApi.
|
3711
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.cra_monitoring_insights_unsubscribe ...'
|
3508
3712
|
end
|
3509
|
-
# verify the required parameter '
|
3510
|
-
if @api_client.config.client_side_validation &&
|
3511
|
-
fail ArgumentError, "Missing the required parameter '
|
3713
|
+
# verify the required parameter 'cra_monitoring_insights_unsubscribe_request' is set
|
3714
|
+
if @api_client.config.client_side_validation && cra_monitoring_insights_unsubscribe_request.nil?
|
3715
|
+
fail ArgumentError, "Missing the required parameter 'cra_monitoring_insights_unsubscribe_request' when calling PlaidApi.cra_monitoring_insights_unsubscribe"
|
3512
3716
|
end
|
3513
3717
|
# resource path
|
3514
|
-
local_var_path = '/cra/
|
3718
|
+
local_var_path = '/cra/monitoring_insights/unsubscribe'
|
3515
3719
|
|
3516
3720
|
# query parameters
|
3517
3721
|
query_params = opts[:query_params] || {}
|
@@ -3530,16 +3734,16 @@ module Plaid
|
|
3530
3734
|
form_params = opts[:form_params] || {}
|
3531
3735
|
|
3532
3736
|
# http body (model)
|
3533
|
-
post_body = opts[:debug_body] || @api_client.object_to_http_body(
|
3737
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(cra_monitoring_insights_unsubscribe_request)
|
3534
3738
|
|
3535
3739
|
# return_type
|
3536
|
-
return_type = opts[:debug_return_type] || '
|
3740
|
+
return_type = opts[:debug_return_type] || 'CraMonitoringInsightsUnsubscribeResponse'
|
3537
3741
|
|
3538
3742
|
# auth_names
|
3539
3743
|
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
3540
3744
|
|
3541
3745
|
new_options = opts.merge(
|
3542
|
-
:operation => :"PlaidApi.
|
3746
|
+
:operation => :"PlaidApi.cra_monitoring_insights_unsubscribe",
|
3543
3747
|
:header_params => header_params,
|
3544
3748
|
:query_params => query_params,
|
3545
3749
|
:form_params => form_params,
|
@@ -3550,7 +3754,7 @@ module Plaid
|
|
3550
3754
|
|
3551
3755
|
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
3552
3756
|
if @api_client.config.debugging
|
3553
|
-
@api_client.config.logger.debug "API called: PlaidApi#
|
3757
|
+
@api_client.config.logger.debug "API called: PlaidApi#cra_monitoring_insights_unsubscribe\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
3554
3758
|
end
|
3555
3759
|
return data, status_code, headers
|
3556
3760
|
end
|
@@ -3964,7 +4168,7 @@ module Plaid
|
|
3964
4168
|
end
|
3965
4169
|
|
3966
4170
|
# Retrieve information from the bank accounts used for income verification
|
3967
|
-
# `/credit/bank_income/get` returns the bank income report(s) for a specified user.
|
4171
|
+
# `/credit/bank_income/get` returns the bank income report(s) for a specified user. A single report corresponds to all institutions linked in a single Link session. To include multiple institutions in a single report, use [Multi-Item Link](https://plaid.com/docs/link/multi-item-link). To return older reports, use the `options.count` field.
|
3968
4172
|
# @param credit_bank_income_get_request [CreditBankIncomeGetRequest]
|
3969
4173
|
# @param [Hash] opts the optional parameters
|
3970
4174
|
# @return [CreditBankIncomeGetResponse]
|
@@ -3974,7 +4178,7 @@ module Plaid
|
|
3974
4178
|
end
|
3975
4179
|
|
3976
4180
|
# Retrieve information from the bank accounts used for income verification
|
3977
|
-
# `/credit/bank_income/get` returns the bank income report(s) for a specified user.
|
4181
|
+
# `/credit/bank_income/get` returns the bank income report(s) for a specified user. A single report corresponds to all institutions linked in a single Link session. To include multiple institutions in a single report, use [Multi-Item Link](https://plaid.com/docs/link/multi-item-link). To return older reports, use the `options.count` field.
|
3978
4182
|
# @param credit_bank_income_get_request [CreditBankIncomeGetRequest]
|
3979
4183
|
# @param [Hash] opts the optional parameters
|
3980
4184
|
# @return [Array<(CreditBankIncomeGetResponse, Integer, Hash)>] CreditBankIncomeGetResponse data, response status code and response headers
|
@@ -4032,7 +4236,7 @@ module Plaid
|
|
4032
4236
|
end
|
4033
4237
|
|
4034
4238
|
# Retrieve information from the bank accounts used for income verification in PDF format
|
4035
|
-
# `/credit/bank_income/pdf/get` returns the most recent bank income report for a specified user in PDF format.
|
4239
|
+
# `/credit/bank_income/pdf/get` returns the most recent bank income report for a specified user in PDF format. A single report corresponds to all institutions linked in a single Link session. To include multiple institutions in a single report, use [Multi-Item Link](https://plaid.com/docs/link/multi-item-link).
|
4036
4240
|
# @param credit_bank_income_pdf_get_request [CreditBankIncomePDFGetRequest]
|
4037
4241
|
# @param [Hash] opts the optional parameters
|
4038
4242
|
# @return [File]
|
@@ -4042,7 +4246,7 @@ module Plaid
|
|
4042
4246
|
end
|
4043
4247
|
|
4044
4248
|
# Retrieve information from the bank accounts used for income verification in PDF format
|
4045
|
-
# `/credit/bank_income/pdf/get` returns the most recent bank income report for a specified user in PDF format.
|
4249
|
+
# `/credit/bank_income/pdf/get` returns the most recent bank income report for a specified user in PDF format. A single report corresponds to all institutions linked in a single Link session. To include multiple institutions in a single report, use [Multi-Item Link](https://plaid.com/docs/link/multi-item-link).
|
4046
4250
|
# @param credit_bank_income_pdf_get_request [CreditBankIncomePDFGetRequest]
|
4047
4251
|
# @param [Hash] opts the optional parameters
|
4048
4252
|
# @return [Array<(File, Integer, Hash)>] File data, response status code and response headers
|
@@ -4100,7 +4304,7 @@ module Plaid
|
|
4100
4304
|
end
|
4101
4305
|
|
4102
4306
|
# Refresh a user's bank income information
|
4103
|
-
# `/credit/bank_income/refresh` refreshes the bank income report data for a specific user.
|
4307
|
+
# `/credit/bank_income/refresh` refreshes the most recent bank income report data for a specific user. If the most recent bank income report is no longer valid (i.e. deleted), the endpoint will refresh the most recent valid report instead.
|
4104
4308
|
# @param credit_bank_income_refresh_request [CreditBankIncomeRefreshRequest]
|
4105
4309
|
# @param [Hash] opts the optional parameters
|
4106
4310
|
# @return [CreditBankIncomeRefreshResponse]
|
@@ -4110,7 +4314,7 @@ module Plaid
|
|
4110
4314
|
end
|
4111
4315
|
|
4112
4316
|
# Refresh a user's bank income information
|
4113
|
-
# `/credit/bank_income/refresh` refreshes the bank income report data for a specific user.
|
4317
|
+
# `/credit/bank_income/refresh` refreshes the most recent bank income report data for a specific user. If the most recent bank income report is no longer valid (i.e. deleted), the endpoint will refresh the most recent valid report instead.
|
4114
4318
|
# @param credit_bank_income_refresh_request [CreditBankIncomeRefreshRequest]
|
4115
4319
|
# @param [Hash] opts the optional parameters
|
4116
4320
|
# @return [Array<(CreditBankIncomeRefreshResponse, Integer, Hash)>] CreditBankIncomeRefreshResponse data, response status code and response headers
|
@@ -5867,6 +6071,129 @@ module Plaid
|
|
5867
6071
|
return data, status_code, headers
|
5868
6072
|
end
|
5869
6073
|
|
6074
|
+
# Get Recipient
|
6075
|
+
# Get a specific recipient
|
6076
|
+
# @param recipient_id [String] Recipient Identifier. Uniquely identifies the recipient
|
6077
|
+
# @param [Hash] opts the optional parameters
|
6078
|
+
# @option opts [String] :oauth_state_id The value that is passed into the OAuth URI 'state' query parameter.
|
6079
|
+
# @return [GetRecipientResponse]
|
6080
|
+
def get_recipient(recipient_id, opts = {})
|
6081
|
+
data, _status_code, _headers = get_recipient_with_http_info(recipient_id, opts)
|
6082
|
+
data
|
6083
|
+
end
|
6084
|
+
|
6085
|
+
# Get Recipient
|
6086
|
+
# Get a specific recipient
|
6087
|
+
# @param recipient_id [String] Recipient Identifier. Uniquely identifies the recipient
|
6088
|
+
# @param [Hash] opts the optional parameters
|
6089
|
+
# @option opts [String] :oauth_state_id The value that is passed into the OAuth URI 'state' query parameter.
|
6090
|
+
# @return [Array<(GetRecipientResponse, Integer, Hash)>] GetRecipientResponse data, response status code and response headers
|
6091
|
+
def get_recipient_with_http_info(recipient_id, opts = {})
|
6092
|
+
if @api_client.config.debugging
|
6093
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.get_recipient ...'
|
6094
|
+
end
|
6095
|
+
# verify the required parameter 'recipient_id' is set
|
6096
|
+
if @api_client.config.client_side_validation && recipient_id.nil?
|
6097
|
+
fail ArgumentError, "Missing the required parameter 'recipient_id' when calling PlaidApi.get_recipient"
|
6098
|
+
end
|
6099
|
+
# resource path
|
6100
|
+
local_var_path = '/fdx/recipient/{recipientId}'.sub('{' + 'recipientId' + '}', CGI.escape(recipient_id.to_s))
|
6101
|
+
|
6102
|
+
# query parameters
|
6103
|
+
query_params = opts[:query_params] || {}
|
6104
|
+
|
6105
|
+
# header parameters
|
6106
|
+
header_params = opts[:header_params] || {}
|
6107
|
+
# HTTP header 'Accept' (if needed)
|
6108
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
6109
|
+
header_params[:'OAUTH-STATE-ID'] = opts[:'oauth_state_id'] if !opts[:'oauth_state_id'].nil?
|
6110
|
+
|
6111
|
+
# form parameters
|
6112
|
+
form_params = opts[:form_params] || {}
|
6113
|
+
|
6114
|
+
# http body (model)
|
6115
|
+
post_body = opts[:debug_body]
|
6116
|
+
|
6117
|
+
# return_type
|
6118
|
+
return_type = opts[:debug_return_type] || 'GetRecipientResponse'
|
6119
|
+
|
6120
|
+
# auth_names
|
6121
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
6122
|
+
|
6123
|
+
new_options = opts.merge(
|
6124
|
+
:operation => :"PlaidApi.get_recipient",
|
6125
|
+
:header_params => header_params,
|
6126
|
+
:query_params => query_params,
|
6127
|
+
:form_params => form_params,
|
6128
|
+
:body => post_body,
|
6129
|
+
:auth_names => auth_names,
|
6130
|
+
:return_type => return_type
|
6131
|
+
)
|
6132
|
+
|
6133
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
6134
|
+
if @api_client.config.debugging
|
6135
|
+
@api_client.config.logger.debug "API called: PlaidApi#get_recipient\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
6136
|
+
end
|
6137
|
+
return data, status_code, headers
|
6138
|
+
end
|
6139
|
+
|
6140
|
+
# Get Recipients
|
6141
|
+
# Returns a list of Recipients
|
6142
|
+
# @param [Hash] opts the optional parameters
|
6143
|
+
# @return [GetRecipientsResponse]
|
6144
|
+
def get_recipients(opts = {})
|
6145
|
+
data, _status_code, _headers = get_recipients_with_http_info(opts)
|
6146
|
+
data
|
6147
|
+
end
|
6148
|
+
|
6149
|
+
# Get Recipients
|
6150
|
+
# Returns a list of Recipients
|
6151
|
+
# @param [Hash] opts the optional parameters
|
6152
|
+
# @return [Array<(GetRecipientsResponse, Integer, Hash)>] GetRecipientsResponse data, response status code and response headers
|
6153
|
+
def get_recipients_with_http_info(opts = {})
|
6154
|
+
if @api_client.config.debugging
|
6155
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.get_recipients ...'
|
6156
|
+
end
|
6157
|
+
# resource path
|
6158
|
+
local_var_path = '/fdx/recipients'
|
6159
|
+
|
6160
|
+
# query parameters
|
6161
|
+
query_params = opts[:query_params] || {}
|
6162
|
+
|
6163
|
+
# header parameters
|
6164
|
+
header_params = opts[:header_params] || {}
|
6165
|
+
# HTTP header 'Accept' (if needed)
|
6166
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
6167
|
+
|
6168
|
+
# form parameters
|
6169
|
+
form_params = opts[:form_params] || {}
|
6170
|
+
|
6171
|
+
# http body (model)
|
6172
|
+
post_body = opts[:debug_body]
|
6173
|
+
|
6174
|
+
# return_type
|
6175
|
+
return_type = opts[:debug_return_type] || 'GetRecipientsResponse'
|
6176
|
+
|
6177
|
+
# auth_names
|
6178
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
6179
|
+
|
6180
|
+
new_options = opts.merge(
|
6181
|
+
:operation => :"PlaidApi.get_recipients",
|
6182
|
+
:header_params => header_params,
|
6183
|
+
:query_params => query_params,
|
6184
|
+
:form_params => form_params,
|
6185
|
+
:body => post_body,
|
6186
|
+
:auth_names => auth_names,
|
6187
|
+
:return_type => return_type
|
6188
|
+
)
|
6189
|
+
|
6190
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
6191
|
+
if @api_client.config.debugging
|
6192
|
+
@api_client.config.logger.debug "API called: PlaidApi#get_recipients\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
6193
|
+
end
|
6194
|
+
return data, status_code, headers
|
6195
|
+
end
|
6196
|
+
|
5870
6197
|
# Returns uploaded document identity
|
5871
6198
|
# Use `/identity/documents/uploads/get` to retrieve document uploaded identity.
|
5872
6199
|
# @param identity_documents_uploads_get_request [IdentityDocumentsUploadsGetRequest]
|
@@ -5936,7 +6263,7 @@ module Plaid
|
|
5936
6263
|
end
|
5937
6264
|
|
5938
6265
|
# Retrieve identity data
|
5939
|
-
# The `/identity/get` endpoint allows you to retrieve various account holder information on file with the financial institution, including names, emails, phone numbers, and addresses. Only name data is guaranteed to be returned; other fields will be empty arrays if not provided by the institution.
|
6266
|
+
# The `/identity/get` endpoint allows you to retrieve various account holder information on file with the financial institution, including names, emails, phone numbers, and addresses. Only name data is guaranteed to be returned; other fields will be empty arrays if not provided by the institution. Note: In API versions 2018-05-22 and earlier, the `owners` object is not returned, and instead identity information is returned in the top level `identity` object. For more details, see [Plaid API versioning](https://plaid.com/docs/api/versioning/#version-2019-05-29).
|
5940
6267
|
# @param identity_get_request [IdentityGetRequest]
|
5941
6268
|
# @param [Hash] opts the optional parameters
|
5942
6269
|
# @return [IdentityGetResponse]
|
@@ -5946,7 +6273,7 @@ module Plaid
|
|
5946
6273
|
end
|
5947
6274
|
|
5948
6275
|
# Retrieve identity data
|
5949
|
-
# The `/identity/get` endpoint allows you to retrieve various account holder information on file with the financial institution, including names, emails, phone numbers, and addresses. Only name data is guaranteed to be returned; other fields will be empty arrays if not provided by the institution.
|
6276
|
+
# The `/identity/get` endpoint allows you to retrieve various account holder information on file with the financial institution, including names, emails, phone numbers, and addresses. Only name data is guaranteed to be returned; other fields will be empty arrays if not provided by the institution. Note: In API versions 2018-05-22 and earlier, the `owners` object is not returned, and instead identity information is returned in the top level `identity` object. For more details, see [Plaid API versioning](https://plaid.com/docs/api/versioning/#version-2019-05-29).
|
5950
6277
|
# @param identity_get_request [IdentityGetRequest]
|
5951
6278
|
# @param [Hash] opts the optional parameters
|
5952
6279
|
# @return [Array<(IdentityGetResponse, Integer, Hash)>] IdentityGetResponse data, response status code and response headers
|
@@ -6004,7 +6331,7 @@ module Plaid
|
|
6004
6331
|
end
|
6005
6332
|
|
6006
6333
|
# Retrieve identity match score
|
6007
|
-
# The `/identity/match` endpoint generates a match score, which indicates how well the provided identity data matches the identity information on file with the account holder's financial institution. Fields within the `balances` object will always be null when retrieved by `/identity/match`. Instead, use the free `/accounts/get` endpoint to request balance cached data, or `/accounts/balance/get` for real-time data.
|
6334
|
+
# The `/identity/match` endpoint generates a match score, which indicates how well the provided identity data matches the identity information on file with the account holder's financial institution. Fields within the `balances` object will always be null when retrieved by `/identity/match`. Instead, use the free `/accounts/get` endpoint to request balance cached data, or `/accounts/balance/get` for real-time data.
|
6008
6335
|
# @param identity_match_request [IdentityMatchRequest]
|
6009
6336
|
# @param [Hash] opts the optional parameters
|
6010
6337
|
# @return [IdentityMatchResponse]
|
@@ -6014,7 +6341,7 @@ module Plaid
|
|
6014
6341
|
end
|
6015
6342
|
|
6016
6343
|
# Retrieve identity match score
|
6017
|
-
# The `/identity/match` endpoint generates a match score, which indicates how well the provided identity data matches the identity information on file with the account holder's financial institution. Fields within the `balances` object will always be null when retrieved by `/identity/match`. Instead, use the free `/accounts/get` endpoint to request balance cached data, or `/accounts/balance/get` for real-time data.
|
6344
|
+
# The `/identity/match` endpoint generates a match score, which indicates how well the provided identity data matches the identity information on file with the account holder's financial institution. Fields within the `balances` object will always be null when retrieved by `/identity/match`. Instead, use the free `/accounts/get` endpoint to request balance cached data, or `/accounts/balance/get` for real-time data.
|
6018
6345
|
# @param identity_match_request [IdentityMatchRequest]
|
6019
6346
|
# @param [Hash] opts the optional parameters
|
6020
6347
|
# @return [Array<(IdentityMatchResponse, Integer, Hash)>] IdentityMatchResponse data, response status code and response headers
|
@@ -7160,7 +7487,7 @@ module Plaid
|
|
7160
7487
|
end
|
7161
7488
|
|
7162
7489
|
# Refresh investment data
|
7163
|
-
# `/investments/refresh` is an optional endpoint for users of the Investments product. It initiates an on-demand extraction to fetch the newest
|
7490
|
+
# `/investments/refresh` is an optional endpoint for users of the Investments product. It initiates an on-demand extraction to fetch the newest investment holdings and transactions for an Item. This on-demand extraction takes place in addition to the periodic extractions that automatically occur one or more times per day for any Investments-enabled Item. If changes to investments are discovered after calling `/investments/refresh`, Plaid will fire webhooks: [`HOLDINGS: DEFAULT_UPDATE`](https://plaid.com/docs/api/products/investments/#holdings-default_update) if any new holdings are detected, and [`INVESTMENTS_TRANSACTIONS: DEFAULT_UPDATE`](https://plaid.com/docs/api/products/investments/#investments_transactions-default_update) if any new investment transactions are detected. Updated holdings and investment transactions can be fetched by calling `/investments/holdings/get` and `/investments/transactions/get`. Note that the `/investments/refresh` endpoint is not supported by all institutions. If called on an Item from an institution that does not support this functionality, it will return a `PRODUCT_NOT_SUPPORTED` error. As this endpoint triggers a synchronous request for fresh data, latency may be higher than for other Plaid endpoints (typically less than 10 seconds, but occasionally up to 30 seconds or more); if you encounter errors, you may find it necessary to adjust your timeout period when making requests. `/investments/refresh` is offered as an add-on to Investments and has a separate [fee model](/docs/account/billing/#per-request-flat-fee). To request access to this endpoint, submit a [product access request](https://dashboard.plaid.com/team/products) or contact your Plaid account manager.
|
7164
7491
|
# @param investments_refresh_request [InvestmentsRefreshRequest]
|
7165
7492
|
# @param [Hash] opts the optional parameters
|
7166
7493
|
# @return [InvestmentsRefreshResponse]
|
@@ -7170,7 +7497,7 @@ module Plaid
|
|
7170
7497
|
end
|
7171
7498
|
|
7172
7499
|
# Refresh investment data
|
7173
|
-
# `/investments/refresh` is an optional endpoint for users of the Investments product. It initiates an on-demand extraction to fetch the newest
|
7500
|
+
# `/investments/refresh` is an optional endpoint for users of the Investments product. It initiates an on-demand extraction to fetch the newest investment holdings and transactions for an Item. This on-demand extraction takes place in addition to the periodic extractions that automatically occur one or more times per day for any Investments-enabled Item. If changes to investments are discovered after calling `/investments/refresh`, Plaid will fire webhooks: [`HOLDINGS: DEFAULT_UPDATE`](https://plaid.com/docs/api/products/investments/#holdings-default_update) if any new holdings are detected, and [`INVESTMENTS_TRANSACTIONS: DEFAULT_UPDATE`](https://plaid.com/docs/api/products/investments/#investments_transactions-default_update) if any new investment transactions are detected. Updated holdings and investment transactions can be fetched by calling `/investments/holdings/get` and `/investments/transactions/get`. Note that the `/investments/refresh` endpoint is not supported by all institutions. If called on an Item from an institution that does not support this functionality, it will return a `PRODUCT_NOT_SUPPORTED` error. As this endpoint triggers a synchronous request for fresh data, latency may be higher than for other Plaid endpoints (typically less than 10 seconds, but occasionally up to 30 seconds or more); if you encounter errors, you may find it necessary to adjust your timeout period when making requests. `/investments/refresh` is offered as an add-on to Investments and has a separate [fee model](/docs/account/billing/#per-request-flat-fee). To request access to this endpoint, submit a [product access request](https://dashboard.plaid.com/team/products) or contact your Plaid account manager.
|
7174
7501
|
# @param investments_refresh_request [InvestmentsRefreshRequest]
|
7175
7502
|
# @param [Hash] opts the optional parameters
|
7176
7503
|
# @return [Array<(InvestmentsRefreshResponse, Integer, Hash)>] InvestmentsRefreshResponse data, response status code and response headers
|
@@ -8044,7 +8371,7 @@ module Plaid
|
|
8044
8371
|
end
|
8045
8372
|
|
8046
8373
|
# Retrieve Liabilities data
|
8047
|
-
# The `/liabilities/get` endpoint returns various details about an Item with loan or credit accounts. Liabilities data is available primarily for US financial institutions, with some limited coverage of Canadian institutions. Currently supported account types are account type `credit` with account subtype `credit card` or `paypal`, and account type `loan` with account subtype `student` or `mortgage`. To limit accounts listed in Link to types and subtypes supported by Liabilities, you can use the `account_filters` parameter when [creating a Link token](https://plaid.com/docs/api/
|
8374
|
+
# The `/liabilities/get` endpoint returns various details about an Item with loan or credit accounts. Liabilities data is available primarily for US financial institutions, with some limited coverage of Canadian institutions. Currently supported account types are account type `credit` with account subtype `credit card` or `paypal`, and account type `loan` with account subtype `student` or `mortgage`. To limit accounts listed in Link to types and subtypes supported by Liabilities, you can use the `account_filters` parameter when [creating a Link token](https://plaid.com/docs/api/link/#linktokencreate). The types of information returned by Liabilities can include balances and due dates, loan terms, and account details such as original loan amount and guarantor. Data is refreshed approximately once per day; the latest data can be retrieved by calling `/liabilities/get`.
|
8048
8375
|
# @param liabilities_get_request [LiabilitiesGetRequest]
|
8049
8376
|
# @param [Hash] opts the optional parameters
|
8050
8377
|
# @return [LiabilitiesGetResponse]
|
@@ -8054,7 +8381,7 @@ module Plaid
|
|
8054
8381
|
end
|
8055
8382
|
|
8056
8383
|
# Retrieve Liabilities data
|
8057
|
-
# The `/liabilities/get` endpoint returns various details about an Item with loan or credit accounts. Liabilities data is available primarily for US financial institutions, with some limited coverage of Canadian institutions. Currently supported account types are account type `credit` with account subtype `credit card` or `paypal`, and account type `loan` with account subtype `student` or `mortgage`. To limit accounts listed in Link to types and subtypes supported by Liabilities, you can use the `account_filters` parameter when [creating a Link token](https://plaid.com/docs/api/
|
8384
|
+
# The `/liabilities/get` endpoint returns various details about an Item with loan or credit accounts. Liabilities data is available primarily for US financial institutions, with some limited coverage of Canadian institutions. Currently supported account types are account type `credit` with account subtype `credit card` or `paypal`, and account type `loan` with account subtype `student` or `mortgage`. To limit accounts listed in Link to types and subtypes supported by Liabilities, you can use the `account_filters` parameter when [creating a Link token](https://plaid.com/docs/api/link/#linktokencreate). The types of information returned by Liabilities can include balances and due dates, loan terms, and account details such as original loan amount and guarantor. Data is refreshed approximately once per day; the latest data can be retrieved by calling `/liabilities/get`.
|
8058
8385
|
# @param liabilities_get_request [LiabilitiesGetRequest]
|
8059
8386
|
# @param [Hash] opts the optional parameters
|
8060
8387
|
# @return [Array<(LiabilitiesGetResponse, Integer, Hash)>] LiabilitiesGetResponse data, response status code and response headers
|
@@ -8452,7 +8779,7 @@ module Plaid
|
|
8452
8779
|
end
|
8453
8780
|
|
8454
8781
|
# Get Link Token
|
8455
|
-
# The `/link/token/get` endpoint gets information about a
|
8782
|
+
# The `/link/token/get` endpoint gets information about a Link session, including all callbacks fired during the session along with their metadata, including the public token. This endpoint is used with Link flows that don't provide a public token via frontend callbacks, such as the [Hosted Link flow](https://plaid.com/docs/link/hosted-link/) and the [Multi-Item Link flow](https://plaid.com/docs/link/multi-item-link/). It also can be useful for debugging purposes.
|
8456
8783
|
# @param link_token_get_request [LinkTokenGetRequest]
|
8457
8784
|
# @param [Hash] opts the optional parameters
|
8458
8785
|
# @return [LinkTokenGetResponse]
|
@@ -8462,7 +8789,7 @@ module Plaid
|
|
8462
8789
|
end
|
8463
8790
|
|
8464
8791
|
# Get Link Token
|
8465
|
-
# The `/link/token/get` endpoint gets information about a
|
8792
|
+
# The `/link/token/get` endpoint gets information about a Link session, including all callbacks fired during the session along with their metadata, including the public token. This endpoint is used with Link flows that don't provide a public token via frontend callbacks, such as the [Hosted Link flow](https://plaid.com/docs/link/hosted-link/) and the [Multi-Item Link flow](https://plaid.com/docs/link/multi-item-link/). It also can be useful for debugging purposes.
|
8466
8793
|
# @param link_token_get_request [LinkTokenGetRequest]
|
8467
8794
|
# @param [Hash] opts the optional parameters
|
8468
8795
|
# @return [Array<(LinkTokenGetResponse, Integer, Hash)>] LinkTokenGetResponse data, response status code and response headers
|
@@ -8519,6 +8846,74 @@ module Plaid
|
|
8519
8846
|
return data, status_code, headers
|
8520
8847
|
end
|
8521
8848
|
|
8849
|
+
# Retrieve network insights for the provided `access_tokens`
|
8850
|
+
# This endpoint allows you to retrieve the Network Insights from a list of `access_tokens`.
|
8851
|
+
# @param network_insights_report_get_request [NetworkInsightsReportGetRequest]
|
8852
|
+
# @param [Hash] opts the optional parameters
|
8853
|
+
# @return [NetworkInsightsReportGetResponse]
|
8854
|
+
def network_insights_report_get(network_insights_report_get_request, opts = {})
|
8855
|
+
data, _status_code, _headers = network_insights_report_get_with_http_info(network_insights_report_get_request, opts)
|
8856
|
+
data
|
8857
|
+
end
|
8858
|
+
|
8859
|
+
# Retrieve network insights for the provided `access_tokens`
|
8860
|
+
# This endpoint allows you to retrieve the Network Insights from a list of `access_tokens`.
|
8861
|
+
# @param network_insights_report_get_request [NetworkInsightsReportGetRequest]
|
8862
|
+
# @param [Hash] opts the optional parameters
|
8863
|
+
# @return [Array<(NetworkInsightsReportGetResponse, Integer, Hash)>] NetworkInsightsReportGetResponse data, response status code and response headers
|
8864
|
+
def network_insights_report_get_with_http_info(network_insights_report_get_request, opts = {})
|
8865
|
+
if @api_client.config.debugging
|
8866
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.network_insights_report_get ...'
|
8867
|
+
end
|
8868
|
+
# verify the required parameter 'network_insights_report_get_request' is set
|
8869
|
+
if @api_client.config.client_side_validation && network_insights_report_get_request.nil?
|
8870
|
+
fail ArgumentError, "Missing the required parameter 'network_insights_report_get_request' when calling PlaidApi.network_insights_report_get"
|
8871
|
+
end
|
8872
|
+
# resource path
|
8873
|
+
local_var_path = '/network_insights/report/get'
|
8874
|
+
|
8875
|
+
# query parameters
|
8876
|
+
query_params = opts[:query_params] || {}
|
8877
|
+
|
8878
|
+
# header parameters
|
8879
|
+
header_params = opts[:header_params] || {}
|
8880
|
+
# HTTP header 'Accept' (if needed)
|
8881
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
8882
|
+
# HTTP header 'Content-Type'
|
8883
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
8884
|
+
if !content_type.nil?
|
8885
|
+
header_params['Content-Type'] = content_type
|
8886
|
+
end
|
8887
|
+
|
8888
|
+
# form parameters
|
8889
|
+
form_params = opts[:form_params] || {}
|
8890
|
+
|
8891
|
+
# http body (model)
|
8892
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(network_insights_report_get_request)
|
8893
|
+
|
8894
|
+
# return_type
|
8895
|
+
return_type = opts[:debug_return_type] || 'NetworkInsightsReportGetResponse'
|
8896
|
+
|
8897
|
+
# auth_names
|
8898
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
8899
|
+
|
8900
|
+
new_options = opts.merge(
|
8901
|
+
:operation => :"PlaidApi.network_insights_report_get",
|
8902
|
+
:header_params => header_params,
|
8903
|
+
:query_params => query_params,
|
8904
|
+
:form_params => form_params,
|
8905
|
+
:body => post_body,
|
8906
|
+
:auth_names => auth_names,
|
8907
|
+
:return_type => return_type
|
8908
|
+
)
|
8909
|
+
|
8910
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
8911
|
+
if @api_client.config.debugging
|
8912
|
+
@api_client.config.logger.debug "API called: PlaidApi#network_insights_report_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
8913
|
+
end
|
8914
|
+
return data, status_code, headers
|
8915
|
+
end
|
8916
|
+
|
8522
8917
|
# Creates a new end customer for a Plaid reseller.
|
8523
8918
|
# The `/partner/customer/create` endpoint is used by reseller partners to create end customers.
|
8524
8919
|
# @param partner_customer_create_request [PartnerCustomerCreateRequest]
|
@@ -10220,7 +10615,7 @@ module Plaid
|
|
10220
10615
|
end
|
10221
10616
|
|
10222
10617
|
# Retrieve identity match score
|
10223
|
-
# The `/processor/identity/match` endpoint generates a match score, which indicates how well the provided identity data matches the identity information on file with the account holder's financial institution. Fields within the `balances` object will always be null when retrieved by `/identity/match`. Instead, use the free `/accounts/get` endpoint to request balance cached data, or `/accounts/balance/get` for real-time data.
|
10618
|
+
# The `/processor/identity/match` endpoint generates a match score, which indicates how well the provided identity data matches the identity information on file with the account holder's financial institution. Fields within the `balances` object will always be null when retrieved by `/identity/match`. Instead, use the free `/accounts/get` endpoint to request balance cached data, or `/accounts/balance/get` for real-time data.
|
10224
10619
|
# @param processor_identity_match_request [ProcessorIdentityMatchRequest]
|
10225
10620
|
# @param [Hash] opts the optional parameters
|
10226
10621
|
# @return [ProcessorIdentityMatchResponse]
|
@@ -10230,7 +10625,7 @@ module Plaid
|
|
10230
10625
|
end
|
10231
10626
|
|
10232
10627
|
# Retrieve identity match score
|
10233
|
-
# The `/processor/identity/match` endpoint generates a match score, which indicates how well the provided identity data matches the identity information on file with the account holder's financial institution. Fields within the `balances` object will always be null when retrieved by `/identity/match`. Instead, use the free `/accounts/get` endpoint to request balance cached data, or `/accounts/balance/get` for real-time data.
|
10628
|
+
# The `/processor/identity/match` endpoint generates a match score, which indicates how well the provided identity data matches the identity information on file with the account holder's financial institution. Fields within the `balances` object will always be null when retrieved by `/identity/match`. Instead, use the free `/accounts/get` endpoint to request balance cached data, or `/accounts/balance/get` for real-time data.
|
10234
10629
|
# @param processor_identity_match_request [ProcessorIdentityMatchRequest]
|
10235
10630
|
# @param [Hash] opts the optional parameters
|
10236
10631
|
# @return [Array<(ProcessorIdentityMatchResponse, Integer, Hash)>] ProcessorIdentityMatchResponse data, response status code and response headers
|
@@ -11307,6 +11702,74 @@ module Plaid
|
|
11307
11702
|
return data, status_code, headers
|
11308
11703
|
end
|
11309
11704
|
|
11705
|
+
# Check a user's Plaid Network status
|
11706
|
+
# The `/profile/network_status/get` endpoint can be used to check whether Plaid has a matching profile for the user.
|
11707
|
+
# @param profile_network_status_get_request [ProfileNetworkStatusGetRequest]
|
11708
|
+
# @param [Hash] opts the optional parameters
|
11709
|
+
# @return [ProfileNetworkStatusGetResponse]
|
11710
|
+
def profile_network_status_get(profile_network_status_get_request, opts = {})
|
11711
|
+
data, _status_code, _headers = profile_network_status_get_with_http_info(profile_network_status_get_request, opts)
|
11712
|
+
data
|
11713
|
+
end
|
11714
|
+
|
11715
|
+
# Check a user's Plaid Network status
|
11716
|
+
# The `/profile/network_status/get` endpoint can be used to check whether Plaid has a matching profile for the user.
|
11717
|
+
# @param profile_network_status_get_request [ProfileNetworkStatusGetRequest]
|
11718
|
+
# @param [Hash] opts the optional parameters
|
11719
|
+
# @return [Array<(ProfileNetworkStatusGetResponse, Integer, Hash)>] ProfileNetworkStatusGetResponse data, response status code and response headers
|
11720
|
+
def profile_network_status_get_with_http_info(profile_network_status_get_request, opts = {})
|
11721
|
+
if @api_client.config.debugging
|
11722
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.profile_network_status_get ...'
|
11723
|
+
end
|
11724
|
+
# verify the required parameter 'profile_network_status_get_request' is set
|
11725
|
+
if @api_client.config.client_side_validation && profile_network_status_get_request.nil?
|
11726
|
+
fail ArgumentError, "Missing the required parameter 'profile_network_status_get_request' when calling PlaidApi.profile_network_status_get"
|
11727
|
+
end
|
11728
|
+
# resource path
|
11729
|
+
local_var_path = '/profile/network_status/get'
|
11730
|
+
|
11731
|
+
# query parameters
|
11732
|
+
query_params = opts[:query_params] || {}
|
11733
|
+
|
11734
|
+
# header parameters
|
11735
|
+
header_params = opts[:header_params] || {}
|
11736
|
+
# HTTP header 'Accept' (if needed)
|
11737
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
11738
|
+
# HTTP header 'Content-Type'
|
11739
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
11740
|
+
if !content_type.nil?
|
11741
|
+
header_params['Content-Type'] = content_type
|
11742
|
+
end
|
11743
|
+
|
11744
|
+
# form parameters
|
11745
|
+
form_params = opts[:form_params] || {}
|
11746
|
+
|
11747
|
+
# http body (model)
|
11748
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(profile_network_status_get_request)
|
11749
|
+
|
11750
|
+
# return_type
|
11751
|
+
return_type = opts[:debug_return_type] || 'ProfileNetworkStatusGetResponse'
|
11752
|
+
|
11753
|
+
# auth_names
|
11754
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
11755
|
+
|
11756
|
+
new_options = opts.merge(
|
11757
|
+
:operation => :"PlaidApi.profile_network_status_get",
|
11758
|
+
:header_params => header_params,
|
11759
|
+
:query_params => query_params,
|
11760
|
+
:form_params => form_params,
|
11761
|
+
:body => post_body,
|
11762
|
+
:auth_names => auth_names,
|
11763
|
+
:return_type => return_type
|
11764
|
+
)
|
11765
|
+
|
11766
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
11767
|
+
if @api_client.config.debugging
|
11768
|
+
@api_client.config.logger.debug "API called: PlaidApi#profile_network_status_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
11769
|
+
end
|
11770
|
+
return data, status_code, headers
|
11771
|
+
end
|
11772
|
+
|
11310
11773
|
# Manually fire a bank income webhook in sandbox
|
11311
11774
|
# Use the `/sandbox/bank_income/fire_webhook` endpoint to manually trigger a Bank Income webhook in the Sandbox environment.
|
11312
11775
|
# @param sandbox_bank_income_fire_webhook_request [SandboxBankIncomeFireWebhookRequest]
|
@@ -11580,7 +12043,7 @@ module Plaid
|
|
11580
12043
|
end
|
11581
12044
|
|
11582
12045
|
# Fire a test webhook
|
11583
|
-
# The `/sandbox/item/fire_webhook` endpoint is used to test that code correctly handles webhooks. This endpoint can trigger the following webhooks: `DEFAULT_UPDATE`: Webhook to be fired for a given Sandbox Item simulating a default update event for the respective product as specified with the `webhook_type` in the request body. Valid sandbox `DEFAULT_UPDATE` responses include: `AUTH`, `IDENTITY`, `TRANSACTIONS`, `INVESTMENTS_TRANSACTIONS`, `LIABILITIES`, `HOLDINGS`. If the Item does not support the product, a `SANDBOX_PRODUCT_NOT_ENABLED` error will result. `NEW_ACCOUNTS_AVAILABLE`:
|
12046
|
+
# The `/sandbox/item/fire_webhook` endpoint is used to test that code correctly handles webhooks. This endpoint can trigger the following webhooks: `DEFAULT_UPDATE`: Webhook to be fired for a given Sandbox Item simulating a default update event for the respective product as specified with the `webhook_type` in the request body. Valid sandbox `DEFAULT_UPDATE` responses include: `AUTH`, `IDENTITY`, `TRANSACTIONS`, `INVESTMENTS_TRANSACTIONS`, `LIABILITIES`, `HOLDINGS`. If the Item does not support the product, a `SANDBOX_PRODUCT_NOT_ENABLED` error will result. `NEW_ACCOUNTS_AVAILABLE`: Fired to indicate that a new account is available on the Item and you can launch update mode to request access to it. `SMS_MICRODEPOSITS_VERIFICATION`: Fired when a given same day micro-deposit item is verified via SMS verification. `LOGIN_REPAIRED`: Fired when an Item recovers from the `ITEM_LOGIN_REQUIRED` without the user going through update mode in your app. `RECURRING_TRANSACTIONS_UPDATE`: Recurring Transactions webhook to be fired for a given Sandbox Item. If the Item does not support Recurring Transactions, a `SANDBOX_PRODUCT_NOT_ENABLED` error will result. `SYNC_UPDATES_AVAILABLE`: Transactions webhook to be fired for a given Sandbox Item. If the Item does not support Transactions, a `SANDBOX_PRODUCT_NOT_ENABLED` error will result. `PRODUCT_READY`: Assets webhook to be fired when a given asset report has been successfully generated. If the Item does not support Assets, a `SANDBOX_PRODUCT_NOT_ENABLED` error will result. `ERROR`: Assets webhook to be fired when asset report generation has failed. If the Item does not support Assets, a `SANDBOX_PRODUCT_NOT_ENABLED` error will result. Note that this endpoint is provided for developer ease-of-use and is not required for testing webhooks; webhooks will also fire in Sandbox under the same conditions that they would in Production (except for webhooks of type `TRANSFER`).
|
11584
12047
|
# @param sandbox_item_fire_webhook_request [SandboxItemFireWebhookRequest]
|
11585
12048
|
# @param [Hash] opts the optional parameters
|
11586
12049
|
# @return [SandboxItemFireWebhookResponse]
|
@@ -11590,7 +12053,7 @@ module Plaid
|
|
11590
12053
|
end
|
11591
12054
|
|
11592
12055
|
# Fire a test webhook
|
11593
|
-
# The `/sandbox/item/fire_webhook` endpoint is used to test that code correctly handles webhooks. This endpoint can trigger the following webhooks: `DEFAULT_UPDATE`: Webhook to be fired for a given Sandbox Item simulating a default update event for the respective product as specified with the `webhook_type` in the request body. Valid sandbox `DEFAULT_UPDATE` responses include: `AUTH`, `IDENTITY`, `TRANSACTIONS`, `INVESTMENTS_TRANSACTIONS`, `LIABILITIES`, `HOLDINGS`. If the Item does not support the product, a `SANDBOX_PRODUCT_NOT_ENABLED` error will result. `NEW_ACCOUNTS_AVAILABLE`:
|
12056
|
+
# The `/sandbox/item/fire_webhook` endpoint is used to test that code correctly handles webhooks. This endpoint can trigger the following webhooks: `DEFAULT_UPDATE`: Webhook to be fired for a given Sandbox Item simulating a default update event for the respective product as specified with the `webhook_type` in the request body. Valid sandbox `DEFAULT_UPDATE` responses include: `AUTH`, `IDENTITY`, `TRANSACTIONS`, `INVESTMENTS_TRANSACTIONS`, `LIABILITIES`, `HOLDINGS`. If the Item does not support the product, a `SANDBOX_PRODUCT_NOT_ENABLED` error will result. `NEW_ACCOUNTS_AVAILABLE`: Fired to indicate that a new account is available on the Item and you can launch update mode to request access to it. `SMS_MICRODEPOSITS_VERIFICATION`: Fired when a given same day micro-deposit item is verified via SMS verification. `LOGIN_REPAIRED`: Fired when an Item recovers from the `ITEM_LOGIN_REQUIRED` without the user going through update mode in your app. `RECURRING_TRANSACTIONS_UPDATE`: Recurring Transactions webhook to be fired for a given Sandbox Item. If the Item does not support Recurring Transactions, a `SANDBOX_PRODUCT_NOT_ENABLED` error will result. `SYNC_UPDATES_AVAILABLE`: Transactions webhook to be fired for a given Sandbox Item. If the Item does not support Transactions, a `SANDBOX_PRODUCT_NOT_ENABLED` error will result. `PRODUCT_READY`: Assets webhook to be fired when a given asset report has been successfully generated. If the Item does not support Assets, a `SANDBOX_PRODUCT_NOT_ENABLED` error will result. `ERROR`: Assets webhook to be fired when asset report generation has failed. If the Item does not support Assets, a `SANDBOX_PRODUCT_NOT_ENABLED` error will result. Note that this endpoint is provided for developer ease-of-use and is not required for testing webhooks; webhooks will also fire in Sandbox under the same conditions that they would in Production (except for webhooks of type `TRANSFER`).
|
11594
12057
|
# @param sandbox_item_fire_webhook_request [SandboxItemFireWebhookRequest]
|
11595
12058
|
# @param [Hash] opts the optional parameters
|
11596
12059
|
# @return [Array<(SandboxItemFireWebhookResponse, Integer, Hash)>] SandboxItemFireWebhookResponse data, response status code and response headers
|
@@ -11988,7 +12451,7 @@ module Plaid
|
|
11988
12451
|
end
|
11989
12452
|
|
11990
12453
|
# Create a test Item
|
11991
|
-
# Use the `/sandbox/public_token/create` endpoint to create a valid `public_token` for an arbitrary institution ID, initial products, and test credentials. The created `public_token` maps to a new Sandbox Item. You can then call `/item/public_token/exchange` to exchange the `public_token` for an `access_token` and perform all API actions. `/sandbox/public_token/create` can also be used with the [`user_custom` test username](https://plaid.com/docs/sandbox/user-custom) to generate a test account with custom data
|
12454
|
+
# Use the `/sandbox/public_token/create` endpoint to create a valid `public_token` for an arbitrary institution ID, initial products, and test credentials. The created `public_token` maps to a new Sandbox Item. You can then call `/item/public_token/exchange` to exchange the `public_token` for an `access_token` and perform all API actions. `/sandbox/public_token/create` can also be used with the [`user_custom` test username](https://plaid.com/docs/sandbox/user-custom) to generate a test account with custom data, or with Plaid's [pre-populated Sandbox test accounts](https://plaid.com/docs/sandbox/test-credentials/).
|
11992
12455
|
# @param sandbox_public_token_create_request [SandboxPublicTokenCreateRequest]
|
11993
12456
|
# @param [Hash] opts the optional parameters
|
11994
12457
|
# @return [SandboxPublicTokenCreateResponse]
|
@@ -11998,7 +12461,7 @@ module Plaid
|
|
11998
12461
|
end
|
11999
12462
|
|
12000
12463
|
# Create a test Item
|
12001
|
-
# Use the `/sandbox/public_token/create` endpoint to create a valid `public_token` for an arbitrary institution ID, initial products, and test credentials. The created `public_token` maps to a new Sandbox Item. You can then call `/item/public_token/exchange` to exchange the `public_token` for an `access_token` and perform all API actions. `/sandbox/public_token/create` can also be used with the [`user_custom` test username](https://plaid.com/docs/sandbox/user-custom) to generate a test account with custom data
|
12464
|
+
# Use the `/sandbox/public_token/create` endpoint to create a valid `public_token` for an arbitrary institution ID, initial products, and test credentials. The created `public_token` maps to a new Sandbox Item. You can then call `/item/public_token/exchange` to exchange the `public_token` for an `access_token` and perform all API actions. `/sandbox/public_token/create` can also be used with the [`user_custom` test username](https://plaid.com/docs/sandbox/user-custom) to generate a test account with custom data, or with Plaid's [pre-populated Sandbox test accounts](https://plaid.com/docs/sandbox/test-credentials/).
|
12002
12465
|
# @param sandbox_public_token_create_request [SandboxPublicTokenCreateRequest]
|
12003
12466
|
# @param [Hash] opts the optional parameters
|
12004
12467
|
# @return [Array<(SandboxPublicTokenCreateResponse, Integer, Hash)>] SandboxPublicTokenCreateResponse data, response status code and response headers
|
@@ -13620,7 +14083,7 @@ module Plaid
|
|
13620
14083
|
end
|
13621
14084
|
|
13622
14085
|
# Fetch recurring transaction streams
|
13623
|
-
# 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 offered as an add-on to 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` or `/transactions/sync`).
|
14086
|
+
# 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 offered as an add-on to 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` or `/transactions/sync`). When using Recurring Transactions, for best results, make sure to use the [`days_requested`](https://plaid.com/docs/api/link/#link-token-create-request-transactions-days-requested) parameter to request at least 180 days of history when initializing Items with Transactions. Once all historical transactions have been fetched, 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. To know when historical transactions have been fetched, if you are using `/transactions/sync` listen for the [`SYNC_UPDATES_AVAILABLE`](https://plaid.com/docs/api/products/transactions/#SyncUpdatesAvailableWebhook-historical-update-complete) webhook and check that the `historical_update_complete` field in the payload is `true`. If using `/transactions/get`, listen for the [`HISTORICAL_UPDATE`](https://plaid.com/docs/api/products/transactions/#historical_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.
|
13624
14087
|
# @param transactions_recurring_get_request [TransactionsRecurringGetRequest]
|
13625
14088
|
# @param [Hash] opts the optional parameters
|
13626
14089
|
# @return [TransactionsRecurringGetResponse]
|
@@ -13630,7 +14093,7 @@ module Plaid
|
|
13630
14093
|
end
|
13631
14094
|
|
13632
14095
|
# Fetch recurring transaction streams
|
13633
|
-
# 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 offered as an add-on to 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` or `/transactions/sync`).
|
14096
|
+
# 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 offered as an add-on to 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` or `/transactions/sync`). When using Recurring Transactions, for best results, make sure to use the [`days_requested`](https://plaid.com/docs/api/link/#link-token-create-request-transactions-days-requested) parameter to request at least 180 days of history when initializing Items with Transactions. Once all historical transactions have been fetched, 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. To know when historical transactions have been fetched, if you are using `/transactions/sync` listen for the [`SYNC_UPDATES_AVAILABLE`](https://plaid.com/docs/api/products/transactions/#SyncUpdatesAvailableWebhook-historical-update-complete) webhook and check that the `historical_update_complete` field in the payload is `true`. If using `/transactions/get`, listen for the [`HISTORICAL_UPDATE`](https://plaid.com/docs/api/products/transactions/#historical_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.
|
13634
14097
|
# @param transactions_recurring_get_request [TransactionsRecurringGetRequest]
|
13635
14098
|
# @param [Hash] opts the optional parameters
|
13636
14099
|
# @return [Array<(TransactionsRecurringGetResponse, Integer, Hash)>] TransactionsRecurringGetResponse data, response status code and response headers
|
@@ -14164,7 +14627,7 @@ module Plaid
|
|
14164
14627
|
end
|
14165
14628
|
|
14166
14629
|
# Create a transfer authorization
|
14167
|
-
# Use the `/transfer/authorization/create` endpoint to authorize a transfer. This endpoint must be called prior to calling `/transfer/create`.
|
14630
|
+
# Use the `/transfer/authorization/create` endpoint to authorize a transfer. This endpoint must be called prior to calling `/transfer/create`. The transfer authorization will expire if not used after one hour. (You can contact your account manager to change the default authorization lifetime.) There are four possible outcomes to calling this endpoint: - If the `authorization.decision` in the response is `declined`, the proposed transfer has failed the risk check and you cannot proceed with the transfer. - If the `authorization.decision` is `user_action_required`, additional user input is needed, usually to fix a broken bank connection, before Plaid can properly assess the risk. You need to launch Link in update mode to complete the required user action. When calling `/link/token/create` to get a new Link token, instead of providing `access_token` in the request, you should set [`transfer.authorization_id`](https://plaid.com/docs/api/link/#link-token-create-request-transfer-authorization-id) as the `authorization.id`. After the Link flow is completed, you may re-attempt the authorization. - If the `authorization.decision` is `approved`, and the `authorization.rationale_code` is `null`, the transfer has passed the risk check and you can proceed to call `/transfer/create`. - If the `authorization.decision` is `approved` and the `authorization.rationale_code` is non-`null`, the risk check could not be run: you may proceed with the transfer, but should perform your own risk evaluation. For more details, see the response schema. In Plaid's Sandbox environment the decisions will be returned as follows: - To approve a transfer with `null` rationale code, make an authorization request with an `amount` less than the available balance in the account. - To approve a transfer with the rationale code `MANUALLY_VERIFIED_ITEM`, create an Item in Link through the [Same Day Micro-deposits flow](https://plaid.com/docs/auth/coverage/testing/#testing-same-day-micro-deposits). - To get an authorization decision of `user_action_required`, [reset the login for an Item](https://plaid.com/docs/sandbox/#item_login_required). - To decline a transfer with the rationale code `NSF`, the available balance on the account must be less than the authorization `amount`. See [Create Sandbox test data](https://plaid.com/docs/sandbox/user-custom/) for details on how to customize data in Sandbox. - To decline a transfer with the rationale code `RISK`, the available balance on the account must be exactly $0. See [Create Sandbox test data](https://plaid.com/docs/sandbox/user-custom/) for details on how to customize data in Sandbox.
|
14168
14631
|
# @param transfer_authorization_create_request [TransferAuthorizationCreateRequest]
|
14169
14632
|
# @param [Hash] opts the optional parameters
|
14170
14633
|
# @return [TransferAuthorizationCreateResponse]
|
@@ -14174,7 +14637,7 @@ module Plaid
|
|
14174
14637
|
end
|
14175
14638
|
|
14176
14639
|
# Create a transfer authorization
|
14177
|
-
# Use the `/transfer/authorization/create` endpoint to authorize a transfer. This endpoint must be called prior to calling `/transfer/create`.
|
14640
|
+
# Use the `/transfer/authorization/create` endpoint to authorize a transfer. This endpoint must be called prior to calling `/transfer/create`. The transfer authorization will expire if not used after one hour. (You can contact your account manager to change the default authorization lifetime.) There are four possible outcomes to calling this endpoint: - If the `authorization.decision` in the response is `declined`, the proposed transfer has failed the risk check and you cannot proceed with the transfer. - If the `authorization.decision` is `user_action_required`, additional user input is needed, usually to fix a broken bank connection, before Plaid can properly assess the risk. You need to launch Link in update mode to complete the required user action. When calling `/link/token/create` to get a new Link token, instead of providing `access_token` in the request, you should set [`transfer.authorization_id`](https://plaid.com/docs/api/link/#link-token-create-request-transfer-authorization-id) as the `authorization.id`. After the Link flow is completed, you may re-attempt the authorization. - If the `authorization.decision` is `approved`, and the `authorization.rationale_code` is `null`, the transfer has passed the risk check and you can proceed to call `/transfer/create`. - If the `authorization.decision` is `approved` and the `authorization.rationale_code` is non-`null`, the risk check could not be run: you may proceed with the transfer, but should perform your own risk evaluation. For more details, see the response schema. In Plaid's Sandbox environment the decisions will be returned as follows: - To approve a transfer with `null` rationale code, make an authorization request with an `amount` less than the available balance in the account. - To approve a transfer with the rationale code `MANUALLY_VERIFIED_ITEM`, create an Item in Link through the [Same Day Micro-deposits flow](https://plaid.com/docs/auth/coverage/testing/#testing-same-day-micro-deposits). - To get an authorization decision of `user_action_required`, [reset the login for an Item](https://plaid.com/docs/sandbox/#item_login_required). - To decline a transfer with the rationale code `NSF`, the available balance on the account must be less than the authorization `amount`. See [Create Sandbox test data](https://plaid.com/docs/sandbox/user-custom/) for details on how to customize data in Sandbox. - To decline a transfer with the rationale code `RISK`, the available balance on the account must be exactly $0. See [Create Sandbox test data](https://plaid.com/docs/sandbox/user-custom/) for details on how to customize data in Sandbox.
|
14178
14641
|
# @param transfer_authorization_create_request [TransferAuthorizationCreateRequest]
|
14179
14642
|
# @param [Hash] opts the optional parameters
|
14180
14643
|
# @return [Array<(TransferAuthorizationCreateResponse, Integer, Hash)>] TransferAuthorizationCreateResponse data, response status code and response headers
|
@@ -14504,7 +14967,7 @@ module Plaid
|
|
14504
14967
|
end
|
14505
14968
|
|
14506
14969
|
# Create a transfer
|
14507
|
-
# Use the `/transfer/create` endpoint to initiate a new transfer.
|
14970
|
+
# Use the `/transfer/create` endpoint to initiate a new transfer. This endpoint is retryable and idempotent; if a transfer with the provided `transfer_id` has already been created, it will return the transfer details without creating a new transfer. A transfer may still be created if a 500 error is returned; to detect this scenario, use [Transfer events](https://plaid.com/docs/transfer/reconciling-transfers/).
|
14508
14971
|
# @param transfer_create_request [TransferCreateRequest]
|
14509
14972
|
# @param [Hash] opts the optional parameters
|
14510
14973
|
# @return [TransferCreateResponse]
|
@@ -14514,7 +14977,7 @@ module Plaid
|
|
14514
14977
|
end
|
14515
14978
|
|
14516
14979
|
# Create a transfer
|
14517
|
-
# Use the `/transfer/create` endpoint to initiate a new transfer.
|
14980
|
+
# Use the `/transfer/create` endpoint to initiate a new transfer. This endpoint is retryable and idempotent; if a transfer with the provided `transfer_id` has already been created, it will return the transfer details without creating a new transfer. A transfer may still be created if a 500 error is returned; to detect this scenario, use [Transfer events](https://plaid.com/docs/transfer/reconciling-transfers/).
|
14518
14981
|
# @param transfer_create_request [TransferCreateRequest]
|
14519
14982
|
# @param [Hash] opts the optional parameters
|
14520
14983
|
# @return [Array<(TransferCreateResponse, Integer, Hash)>] TransferCreateResponse data, response status code and response headers
|
@@ -15456,7 +15919,7 @@ module Plaid
|
|
15456
15919
|
end
|
15457
15920
|
|
15458
15921
|
# Migrate account into Transfers
|
15459
|
-
# As an alternative to adding Items via Link, you can also use the `/transfer/migrate_account` endpoint to migrate known account and routing numbers to Plaid Items.
|
15922
|
+
# As an alternative to adding Items via Link, you can also use the `/transfer/migrate_account` endpoint to migrate known account and routing numbers to Plaid Items. This endpoint is also required when adding an Item for use with wire transfers; if you intend to create wire transfers on this account, you must provide `wire_routing_number`. Note that Items created in this way are not compatible with endpoints for other products, such as `/accounts/balance/get`, and can only be used with Transfer endpoints. If you require access to other endpoints, create the Item through Link instead. Access to `/transfer/migrate_account` is not enabled by default; to obtain access, contact your Plaid Account Manager.
|
15460
15923
|
# @param transfer_migrate_account_request [TransferMigrateAccountRequest]
|
15461
15924
|
# @param [Hash] opts the optional parameters
|
15462
15925
|
# @return [TransferMigrateAccountResponse]
|
@@ -15466,7 +15929,7 @@ module Plaid
|
|
15466
15929
|
end
|
15467
15930
|
|
15468
15931
|
# Migrate account into Transfers
|
15469
|
-
# As an alternative to adding Items via Link, you can also use the `/transfer/migrate_account` endpoint to migrate known account and routing numbers to Plaid Items.
|
15932
|
+
# As an alternative to adding Items via Link, you can also use the `/transfer/migrate_account` endpoint to migrate known account and routing numbers to Plaid Items. This endpoint is also required when adding an Item for use with wire transfers; if you intend to create wire transfers on this account, you must provide `wire_routing_number`. Note that Items created in this way are not compatible with endpoints for other products, such as `/accounts/balance/get`, and can only be used with Transfer endpoints. If you require access to other endpoints, create the Item through Link instead. Access to `/transfer/migrate_account` is not enabled by default; to obtain access, contact your Plaid Account Manager.
|
15470
15933
|
# @param transfer_migrate_account_request [TransferMigrateAccountRequest]
|
15471
15934
|
# @param [Hash] opts the optional parameters
|
15472
15935
|
# @return [Array<(TransferMigrateAccountResponse, Integer, Hash)>] TransferMigrateAccountResponse data, response status code and response headers
|
@@ -15795,6 +16258,74 @@ module Plaid
|
|
15795
16258
|
return data, status_code, headers
|
15796
16259
|
end
|
15797
16260
|
|
16261
|
+
# Create an originator for scaled platform customers
|
16262
|
+
# The `/transfer/platform/originator/create` endpoint allows gathering information about the originator specific to the Scaled Platform Transfer offering, including the originator's agreement to legal terms required before accepting any further information related to the originator.
|
16263
|
+
# @param transfer_platform_originator_create_request [TransferPlatformOriginatorCreateRequest]
|
16264
|
+
# @param [Hash] opts the optional parameters
|
16265
|
+
# @return [TransferPlatformOriginatorCreateResponse]
|
16266
|
+
def transfer_platform_originator_create(transfer_platform_originator_create_request, opts = {})
|
16267
|
+
data, _status_code, _headers = transfer_platform_originator_create_with_http_info(transfer_platform_originator_create_request, opts)
|
16268
|
+
data
|
16269
|
+
end
|
16270
|
+
|
16271
|
+
# Create an originator for scaled platform customers
|
16272
|
+
# The `/transfer/platform/originator/create` endpoint allows gathering information about the originator specific to the Scaled Platform Transfer offering, including the originator's agreement to legal terms required before accepting any further information related to the originator.
|
16273
|
+
# @param transfer_platform_originator_create_request [TransferPlatformOriginatorCreateRequest]
|
16274
|
+
# @param [Hash] opts the optional parameters
|
16275
|
+
# @return [Array<(TransferPlatformOriginatorCreateResponse, Integer, Hash)>] TransferPlatformOriginatorCreateResponse data, response status code and response headers
|
16276
|
+
def transfer_platform_originator_create_with_http_info(transfer_platform_originator_create_request, opts = {})
|
16277
|
+
if @api_client.config.debugging
|
16278
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.transfer_platform_originator_create ...'
|
16279
|
+
end
|
16280
|
+
# verify the required parameter 'transfer_platform_originator_create_request' is set
|
16281
|
+
if @api_client.config.client_side_validation && transfer_platform_originator_create_request.nil?
|
16282
|
+
fail ArgumentError, "Missing the required parameter 'transfer_platform_originator_create_request' when calling PlaidApi.transfer_platform_originator_create"
|
16283
|
+
end
|
16284
|
+
# resource path
|
16285
|
+
local_var_path = '/transfer/platform/originator/create'
|
16286
|
+
|
16287
|
+
# query parameters
|
16288
|
+
query_params = opts[:query_params] || {}
|
16289
|
+
|
16290
|
+
# header parameters
|
16291
|
+
header_params = opts[:header_params] || {}
|
16292
|
+
# HTTP header 'Accept' (if needed)
|
16293
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
16294
|
+
# HTTP header 'Content-Type'
|
16295
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
16296
|
+
if !content_type.nil?
|
16297
|
+
header_params['Content-Type'] = content_type
|
16298
|
+
end
|
16299
|
+
|
16300
|
+
# form parameters
|
16301
|
+
form_params = opts[:form_params] || {}
|
16302
|
+
|
16303
|
+
# http body (model)
|
16304
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(transfer_platform_originator_create_request)
|
16305
|
+
|
16306
|
+
# return_type
|
16307
|
+
return_type = opts[:debug_return_type] || 'TransferPlatformOriginatorCreateResponse'
|
16308
|
+
|
16309
|
+
# auth_names
|
16310
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
16311
|
+
|
16312
|
+
new_options = opts.merge(
|
16313
|
+
:operation => :"PlaidApi.transfer_platform_originator_create",
|
16314
|
+
:header_params => header_params,
|
16315
|
+
:query_params => query_params,
|
16316
|
+
:form_params => form_params,
|
16317
|
+
:body => post_body,
|
16318
|
+
:auth_names => auth_names,
|
16319
|
+
:return_type => return_type
|
16320
|
+
)
|
16321
|
+
|
16322
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
16323
|
+
if @api_client.config.debugging
|
16324
|
+
@api_client.config.logger.debug "API called: PlaidApi#transfer_platform_originator_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
16325
|
+
end
|
16326
|
+
return data, status_code, headers
|
16327
|
+
end
|
16328
|
+
|
15798
16329
|
# Generate a Plaid-hosted onboarding UI URL.
|
15799
16330
|
# The `/transfer/questionnaire/create` endpoint generates a Plaid-hosted onboarding UI URL. Redirect the originator to this URL to provide their due diligence information and agree to Plaid’s terms for ACH money movement.
|
15800
16331
|
# @param transfer_questionnaire_create_request [TransferQuestionnaireCreateRequest]
|
@@ -16680,7 +17211,7 @@ module Plaid
|
|
16680
17211
|
end
|
16681
17212
|
|
16682
17213
|
# Create user
|
16683
|
-
# This endpoint should be called for each of your end users before they begin a Plaid
|
17214
|
+
# This endpoint should be called for each of your end users before they begin a Plaid Check or Income flow, or a Multi-Item Link flow. This provides you a single token to access all data associated with the user. You should only create one per end user. The `consumer_report_user_identity` object must be present in order to create a Plaid Check Consumer Report for a user. If it is not provided during the `/user/create` call, it can be added later by calling `/user/update`. If you call the endpoint multiple times with the same `client_user_id`, the first creation call will succeed and the rest will fail with an error message indicating that the user has been created for the given `client_user_id`. Ensure that you store the `user_token` along with your user's identifier in your database, as it is not possible to retrieve a previously created `user_token`.
|
16684
17215
|
# @param user_create_request [UserCreateRequest]
|
16685
17216
|
# @param [Hash] opts the optional parameters
|
16686
17217
|
# @return [UserCreateResponse]
|
@@ -16690,7 +17221,7 @@ module Plaid
|
|
16690
17221
|
end
|
16691
17222
|
|
16692
17223
|
# Create user
|
16693
|
-
# This endpoint should be called for each of your end users before they begin a Plaid
|
17224
|
+
# This endpoint should be called for each of your end users before they begin a Plaid Check or Income flow, or a Multi-Item Link flow. This provides you a single token to access all data associated with the user. You should only create one per end user. The `consumer_report_user_identity` object must be present in order to create a Plaid Check Consumer Report for a user. If it is not provided during the `/user/create` call, it can be added later by calling `/user/update`. If you call the endpoint multiple times with the same `client_user_id`, the first creation call will succeed and the rest will fail with an error message indicating that the user has been created for the given `client_user_id`. Ensure that you store the `user_token` along with your user's identifier in your database, as it is not possible to retrieve a previously created `user_token`.
|
16694
17225
|
# @param user_create_request [UserCreateRequest]
|
16695
17226
|
# @param [Hash] opts the optional parameters
|
16696
17227
|
# @return [Array<(UserCreateResponse, Integer, Hash)>] UserCreateResponse data, response status code and response headers
|
@@ -16816,7 +17347,7 @@ module Plaid
|
|
16816
17347
|
end
|
16817
17348
|
|
16818
17349
|
# Remove user
|
16819
|
-
#
|
17350
|
+
# `/user/remove` deletes a user token and and associated information, including any Items associated with the token. Any subsequent calls to retrieve information using the same user token will result in an error stating the user does not exist.
|
16820
17351
|
# @param user_remove_request [UserRemoveRequest]
|
16821
17352
|
# @param [Hash] opts the optional parameters
|
16822
17353
|
# @return [UserRemoveResponse]
|
@@ -16826,7 +17357,7 @@ module Plaid
|
|
16826
17357
|
end
|
16827
17358
|
|
16828
17359
|
# Remove user
|
16829
|
-
#
|
17360
|
+
# `/user/remove` deletes a user token and and associated information, including any Items associated with the token. Any subsequent calls to retrieve information using the same user token will result in an error stating the user does not exist.
|
16830
17361
|
# @param user_remove_request [UserRemoveRequest]
|
16831
17362
|
# @param [Hash] opts the optional parameters
|
16832
17363
|
# @return [Array<(UserRemoveResponse, Integer, Hash)>] UserRemoveResponse data, response status code and response headers
|
@@ -16884,7 +17415,7 @@ module Plaid
|
|
16884
17415
|
end
|
16885
17416
|
|
16886
17417
|
# Update user information
|
16887
|
-
# This endpoint is used to update user information associated with an existing `user_token`.
|
17418
|
+
# This endpoint is used to update user information associated with an existing `user_token`. It can also be used to enable an existing `user_token` for use with Consumer Reports by Plaid Check, by adding a `consumer_report_user_identity` object to the user.
|
16888
17419
|
# @param user_update_request [UserUpdateRequest]
|
16889
17420
|
# @param [Hash] opts the optional parameters
|
16890
17421
|
# @return [UserUpdateResponse]
|
@@ -16894,7 +17425,7 @@ module Plaid
|
|
16894
17425
|
end
|
16895
17426
|
|
16896
17427
|
# Update user information
|
16897
|
-
# This endpoint is used to update user information associated with an existing `user_token`.
|
17428
|
+
# This endpoint is used to update user information associated with an existing `user_token`. It can also be used to enable an existing `user_token` for use with Consumer Reports by Plaid Check, by adding a `consumer_report_user_identity` object to the user.
|
16898
17429
|
# @param user_update_request [UserUpdateRequest]
|
16899
17430
|
# @param [Hash] opts the optional parameters
|
16900
17431
|
# @return [Array<(UserUpdateResponse, Integer, Hash)>] UserUpdateResponse data, response status code and response headers
|