plaid 30.0.0 → 32.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 +223 -0
- data/Dockerfile +1 -0
- data/Gemfile.lock +7 -5
- data/Makefile +1 -1
- data/lib/plaid/api/plaid_api.rb +1150 -279
- 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 +2 -2
- 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 +2 -2
- data/lib/plaid/models/accounts_balance_get_response_payment_risk_assessment.rb +2 -2
- data/lib/plaid/models/accounts_get_request.rb +1 -1
- data/lib/plaid/models/accounts_get_request_options.rb +1 -1
- data/lib/plaid/models/accounts_get_response.rb +1 -1
- data/lib/plaid/models/ach_class.rb +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 +2 -2
- 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 +2 -10
- 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 +2 -2
- 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/consent_event.rb +338 -0
- data/lib/plaid/models/consent_event_code.rb +41 -0
- data/lib/plaid/models/consent_event_initiator.rb +41 -0
- data/lib/plaid/models/consent_event_type.rb +40 -0
- data/lib/plaid/models/consent_events_get_request.rb +246 -0
- data/lib/plaid/models/consent_events_get_response.rb +243 -0
- data/lib/plaid/models/consented_account.rb +292 -0
- 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 +15 -4
- 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 +2 -2
- 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 +3 -3
- data/lib/plaid/models/dashboard_user_get_request.rb +2 -2
- data/lib/plaid/models/dashboard_user_get_response.rb +3 -3
- 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/data_sources.rb +40 -0
- 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 +2 -2
- data/lib/plaid/models/deposit_switch_alt_create_request.rb +2 -2
- data/lib/plaid/models/deposit_switch_alt_create_response.rb +2 -2
- data/lib/plaid/models/deposit_switch_create_request.rb +2 -2
- data/lib/plaid/models/deposit_switch_create_request_options.rb +2 -2
- data/lib/plaid/models/deposit_switch_create_response.rb +2 -2
- data/lib/plaid/models/deposit_switch_get_request.rb +2 -2
- data/lib/plaid/models/deposit_switch_get_response.rb +2 -2
- data/lib/plaid/models/deposit_switch_state_update_webhook.rb +2 -2
- data/lib/plaid/models/deposit_switch_target_account.rb +2 -2
- data/lib/plaid/models/deposit_switch_target_user.rb +2 -2
- data/lib/plaid/models/deposit_switch_token_create_request.rb +2 -2
- data/lib/plaid/models/deposit_switch_token_create_response.rb +2 -2
- 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/device_id.rb +230 -0
- 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 +2 -2
- 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 +2 -2
- 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_data_sources.rb +260 -0
- 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 +16 -2
- 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.rb +306 -0
- data/lib/plaid/models/issue_resolved_webhook.rb +316 -0
- data/lib/plaid/models/issues_get_request.rb +246 -0
- data/lib/plaid/models/issues_get_response.rb +230 -0
- data/lib/plaid/models/issues_search_request.rb +261 -0
- data/lib/plaid/models/issues_search_response.rb +233 -0
- data/lib/plaid/models/issues_status.rb +43 -0
- data/lib/plaid/models/issues_subscribe_request.rb +261 -0
- data/lib/plaid/models/issues_subscribe_response.rb +226 -0
- data/lib/plaid/models/issuing_country.rb +1 -1
- data/lib/plaid/models/item.rb +38 -4
- 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_consented_data_scope.rb +45 -0
- 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 +2 -2
- 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 +2 -2
- 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 -25
- 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 +2 -2
- 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 +20 -7
- 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 +2 -2
- 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 +3 -2
- 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 +2 -2
- 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 +29 -5
- data/lib/plaid/models/selfie_analysis_document_comparison.rb +1 -1
- data/lib/plaid/models/selfie_analysis_facial_analysis.rb +401 -0
- data/lib/plaid/models/selfie_analysis_facial_analysis_outcome.rb +39 -0
- data/lib/plaid/models/selfie_analysis_liveness_check.rb +39 -0
- 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 +7 -7
- 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 +12 -7
- 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 +22 -22
- 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 +47 -2
- 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_requirement_submission.rb +251 -0
- data/lib/plaid/models/transfer_platform_requirement_submit_request.rb +285 -0
- data/lib/plaid/models/transfer_platform_requirement_submit_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/trusted_device_data.rb +229 -0
- 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 +2 -2
- 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 +2 -2
- data/lib/plaid/models/watchlist_screening_entity_get_request.rb +1 -1
- data/lib/plaid/models/watchlist_screening_entity_get_response.rb +2 -2
- 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 +2 -2
- 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 +2 -2
- data/lib/plaid/models/watchlist_screening_entity_update_request_resettable_field.rb +1 -1
- data/lib/plaid/models/watchlist_screening_entity_update_response.rb +2 -2
- 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 +2 -2
- data/lib/plaid/models/watchlist_screening_individual_create_request.rb +1 -1
- data/lib/plaid/models/watchlist_screening_individual_create_response.rb +2 -2
- data/lib/plaid/models/watchlist_screening_individual_get_request.rb +1 -1
- data/lib/plaid/models/watchlist_screening_individual_get_response.rb +2 -2
- 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 +2 -2
- 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 +2 -2
- data/lib/plaid/models/watchlist_screening_individual_update_request_resettable_field.rb +1 -1
- data/lib/plaid/models/watchlist_screening_individual_update_response.rb +2 -2
- 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 +97 -10
- data/plaid.gemspec +1 -1
- metadata +98 -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.565.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]
|
@@ -2671,6 +2535,74 @@ module Plaid
|
|
2671
2535
|
return data, status_code, headers
|
2672
2536
|
end
|
2673
2537
|
|
2538
|
+
# List a historical log of item consent events
|
2539
|
+
# List a historical log of item consent events
|
2540
|
+
# @param consent_events_get_request [ConsentEventsGetRequest]
|
2541
|
+
# @param [Hash] opts the optional parameters
|
2542
|
+
# @return [ConsentEventsGetResponse]
|
2543
|
+
def consent_events_get(consent_events_get_request, opts = {})
|
2544
|
+
data, _status_code, _headers = consent_events_get_with_http_info(consent_events_get_request, opts)
|
2545
|
+
data
|
2546
|
+
end
|
2547
|
+
|
2548
|
+
# List a historical log of item consent events
|
2549
|
+
# List a historical log of item consent events
|
2550
|
+
# @param consent_events_get_request [ConsentEventsGetRequest]
|
2551
|
+
# @param [Hash] opts the optional parameters
|
2552
|
+
# @return [Array<(ConsentEventsGetResponse, Integer, Hash)>] ConsentEventsGetResponse data, response status code and response headers
|
2553
|
+
def consent_events_get_with_http_info(consent_events_get_request, opts = {})
|
2554
|
+
if @api_client.config.debugging
|
2555
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.consent_events_get ...'
|
2556
|
+
end
|
2557
|
+
# verify the required parameter 'consent_events_get_request' is set
|
2558
|
+
if @api_client.config.client_side_validation && consent_events_get_request.nil?
|
2559
|
+
fail ArgumentError, "Missing the required parameter 'consent_events_get_request' when calling PlaidApi.consent_events_get"
|
2560
|
+
end
|
2561
|
+
# resource path
|
2562
|
+
local_var_path = '/consent/events/get'
|
2563
|
+
|
2564
|
+
# query parameters
|
2565
|
+
query_params = opts[:query_params] || {}
|
2566
|
+
|
2567
|
+
# header parameters
|
2568
|
+
header_params = opts[:header_params] || {}
|
2569
|
+
# HTTP header 'Accept' (if needed)
|
2570
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
2571
|
+
# HTTP header 'Content-Type'
|
2572
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
2573
|
+
if !content_type.nil?
|
2574
|
+
header_params['Content-Type'] = content_type
|
2575
|
+
end
|
2576
|
+
|
2577
|
+
# form parameters
|
2578
|
+
form_params = opts[:form_params] || {}
|
2579
|
+
|
2580
|
+
# http body (model)
|
2581
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(consent_events_get_request)
|
2582
|
+
|
2583
|
+
# return_type
|
2584
|
+
return_type = opts[:debug_return_type] || 'ConsentEventsGetResponse'
|
2585
|
+
|
2586
|
+
# auth_names
|
2587
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
2588
|
+
|
2589
|
+
new_options = opts.merge(
|
2590
|
+
:operation => :"PlaidApi.consent_events_get",
|
2591
|
+
:header_params => header_params,
|
2592
|
+
:query_params => query_params,
|
2593
|
+
:form_params => form_params,
|
2594
|
+
:body => post_body,
|
2595
|
+
:auth_names => auth_names,
|
2596
|
+
:return_type => return_type
|
2597
|
+
)
|
2598
|
+
|
2599
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
2600
|
+
if @api_client.config.debugging
|
2601
|
+
@api_client.config.logger.debug "API called: PlaidApi#consent_events_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2602
|
+
end
|
2603
|
+
return data, status_code, headers
|
2604
|
+
end
|
2605
|
+
|
2674
2606
|
# Retrieve a PDF Reports
|
2675
2607
|
# Retrieves all existing CRB Bank Income and Base reports for the consumer in PDF format. Response is PDF binary data. The `request_id` is returned in the `Plaid-Request-ID` header.
|
2676
2608
|
# @param consumer_report_pdf_get_request [ConsumerReportPDFGetRequest]
|
@@ -2875,6 +2807,142 @@ module Plaid
|
|
2875
2807
|
return data, status_code, headers
|
2876
2808
|
end
|
2877
2809
|
|
2810
|
+
# Create a Base Report
|
2811
|
+
# 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.
|
2812
|
+
# @param cra_base_report_create_request [CraBaseReportCreateRequest]
|
2813
|
+
# @param [Hash] opts the optional parameters
|
2814
|
+
# @return [CraBaseReportCreateResponse]
|
2815
|
+
def cra_base_report_create(cra_base_report_create_request, opts = {})
|
2816
|
+
data, _status_code, _headers = cra_base_report_create_with_http_info(cra_base_report_create_request, opts)
|
2817
|
+
data
|
2818
|
+
end
|
2819
|
+
|
2820
|
+
# Create a Base Report
|
2821
|
+
# 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.
|
2822
|
+
# @param cra_base_report_create_request [CraBaseReportCreateRequest]
|
2823
|
+
# @param [Hash] opts the optional parameters
|
2824
|
+
# @return [Array<(CraBaseReportCreateResponse, Integer, Hash)>] CraBaseReportCreateResponse data, response status code and response headers
|
2825
|
+
def cra_base_report_create_with_http_info(cra_base_report_create_request, opts = {})
|
2826
|
+
if @api_client.config.debugging
|
2827
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.cra_base_report_create ...'
|
2828
|
+
end
|
2829
|
+
# verify the required parameter 'cra_base_report_create_request' is set
|
2830
|
+
if @api_client.config.client_side_validation && cra_base_report_create_request.nil?
|
2831
|
+
fail ArgumentError, "Missing the required parameter 'cra_base_report_create_request' when calling PlaidApi.cra_base_report_create"
|
2832
|
+
end
|
2833
|
+
# resource path
|
2834
|
+
local_var_path = '/cra/base_report/create'
|
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_create_request)
|
2854
|
+
|
2855
|
+
# return_type
|
2856
|
+
return_type = opts[:debug_return_type] || 'CraBaseReportCreateResponse'
|
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_create",
|
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_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2874
|
+
end
|
2875
|
+
return data, status_code, headers
|
2876
|
+
end
|
2877
|
+
|
2878
|
+
# Retrieve a Base Report
|
2879
|
+
# This endpoint allows the customer to retrieve a Base Report. Customers should pass in the `user_token` created in `/user/create`.
|
2880
|
+
# @param cra_base_report_get_request [CraBaseReportGetRequest]
|
2881
|
+
# @param [Hash] opts the optional parameters
|
2882
|
+
# @return [CraBaseReportGetResponse]
|
2883
|
+
def cra_base_report_get(cra_base_report_get_request, opts = {})
|
2884
|
+
data, _status_code, _headers = cra_base_report_get_with_http_info(cra_base_report_get_request, opts)
|
2885
|
+
data
|
2886
|
+
end
|
2887
|
+
|
2888
|
+
# Retrieve a Base Report
|
2889
|
+
# This endpoint allows the customer to retrieve a Base Report. Customers should pass in the `user_token` created in `/user/create`.
|
2890
|
+
# @param cra_base_report_get_request [CraBaseReportGetRequest]
|
2891
|
+
# @param [Hash] opts the optional parameters
|
2892
|
+
# @return [Array<(CraBaseReportGetResponse, Integer, Hash)>] CraBaseReportGetResponse data, response status code and response headers
|
2893
|
+
def cra_base_report_get_with_http_info(cra_base_report_get_request, opts = {})
|
2894
|
+
if @api_client.config.debugging
|
2895
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.cra_base_report_get ...'
|
2896
|
+
end
|
2897
|
+
# verify the required parameter 'cra_base_report_get_request' is set
|
2898
|
+
if @api_client.config.client_side_validation && cra_base_report_get_request.nil?
|
2899
|
+
fail ArgumentError, "Missing the required parameter 'cra_base_report_get_request' when calling PlaidApi.cra_base_report_get"
|
2900
|
+
end
|
2901
|
+
# resource path
|
2902
|
+
local_var_path = '/cra/base_report/get'
|
2903
|
+
|
2904
|
+
# query parameters
|
2905
|
+
query_params = opts[:query_params] || {}
|
2906
|
+
|
2907
|
+
# header parameters
|
2908
|
+
header_params = opts[:header_params] || {}
|
2909
|
+
# HTTP header 'Accept' (if needed)
|
2910
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
2911
|
+
# HTTP header 'Content-Type'
|
2912
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
2913
|
+
if !content_type.nil?
|
2914
|
+
header_params['Content-Type'] = content_type
|
2915
|
+
end
|
2916
|
+
|
2917
|
+
# form parameters
|
2918
|
+
form_params = opts[:form_params] || {}
|
2919
|
+
|
2920
|
+
# http body (model)
|
2921
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(cra_base_report_get_request)
|
2922
|
+
|
2923
|
+
# return_type
|
2924
|
+
return_type = opts[:debug_return_type] || 'CraBaseReportGetResponse'
|
2925
|
+
|
2926
|
+
# auth_names
|
2927
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
2928
|
+
|
2929
|
+
new_options = opts.merge(
|
2930
|
+
:operation => :"PlaidApi.cra_base_report_get",
|
2931
|
+
:header_params => header_params,
|
2932
|
+
:query_params => query_params,
|
2933
|
+
:form_params => form_params,
|
2934
|
+
:body => post_body,
|
2935
|
+
:auth_names => auth_names,
|
2936
|
+
:return_type => return_type
|
2937
|
+
)
|
2938
|
+
|
2939
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
2940
|
+
if @api_client.config.debugging
|
2941
|
+
@api_client.config.logger.debug "API called: PlaidApi#cra_base_report_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2942
|
+
end
|
2943
|
+
return data, status_code, headers
|
2944
|
+
end
|
2945
|
+
|
2878
2946
|
# Retrieve a Base Report
|
2879
2947
|
# 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
2948
|
# @param cra_check_report_base_report_get_request [CraCheckReportBaseReportGetRequest]
|
@@ -2944,7 +3012,7 @@ module Plaid
|
|
2944
3012
|
end
|
2945
3013
|
|
2946
3014
|
# Create a Consumer Report
|
2947
|
-
# `/cra/check_report/create` creates a Consumer Report powered by Plaid Check. Plaid Check automatically
|
3015
|
+
# `/cra/check_report/create` creates a Consumer Report powered by Plaid Check. You can call this endpoint to create a new report if `consumer_report_permissible_purpose` was omitted during Link token creation. If you did provide a `consumer_report_permissible_purpose` during Link token creation, then Plaid Check will automatically begin creating a Consumer Report once the user completes the Link process, and it is not necessary to call `/cra/check_report/create` before retrieving the report. `/cra/check_report/create` can also be used to refresh data in an existing report. A Consumer Report will last for 24 hours before expiring; you should call any `/get` endpoints on the report before it expires. If a report expires, you can call `/cra/check_report/create` again to re-generate it. Note that refreshing or regenerating a report is a billable event.\"
|
2948
3016
|
# @param cra_check_report_create_request [CraCheckReportCreateRequest]
|
2949
3017
|
# @param [Hash] opts the optional parameters
|
2950
3018
|
# @return [CraCheckReportCreateResponse]
|
@@ -2954,7 +3022,7 @@ module Plaid
|
|
2954
3022
|
end
|
2955
3023
|
|
2956
3024
|
# Create a Consumer Report
|
2957
|
-
# `/cra/check_report/create` creates a Consumer Report powered by Plaid Check. Plaid Check automatically
|
3025
|
+
# `/cra/check_report/create` creates a Consumer Report powered by Plaid Check. You can call this endpoint to create a new report if `consumer_report_permissible_purpose` was omitted during Link token creation. If you did provide a `consumer_report_permissible_purpose` during Link token creation, then Plaid Check will automatically begin creating a Consumer Report once the user completes the Link process, and it is not necessary to call `/cra/check_report/create` before retrieving the report. `/cra/check_report/create` can also be used to refresh data in an existing report. A Consumer Report will last for 24 hours before expiring; you should call any `/get` endpoints on the report before it expires. If a report expires, you can call `/cra/check_report/create` again to re-generate it. Note that refreshing or regenerating a report is a billable event.\"
|
2958
3026
|
# @param cra_check_report_create_request [CraCheckReportCreateRequest]
|
2959
3027
|
# @param [Hash] opts the optional parameters
|
2960
3028
|
# @return [Array<(CraCheckReportCreateResponse, Integer, Hash)>] CraCheckReportCreateResponse data, response status code and response headers
|
@@ -3080,27 +3148,27 @@ module Plaid
|
|
3080
3148
|
end
|
3081
3149
|
|
3082
3150
|
# Retrieve network attributes for the user
|
3083
|
-
# This endpoint allows you to retrieve the Network
|
3084
|
-
# @param
|
3151
|
+
# 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.
|
3152
|
+
# @param cra_check_report_network_insights_get_request [CraCheckReportNetworkInsightsGetRequest]
|
3085
3153
|
# @param [Hash] opts the optional parameters
|
3086
|
-
# @return [
|
3087
|
-
def
|
3088
|
-
data, _status_code, _headers =
|
3154
|
+
# @return [CraCheckReportNetworkInsightsGetResponse]
|
3155
|
+
def cra_check_report_network_insights_get(cra_check_report_network_insights_get_request, opts = {})
|
3156
|
+
data, _status_code, _headers = cra_check_report_network_insights_get_with_http_info(cra_check_report_network_insights_get_request, opts)
|
3089
3157
|
data
|
3090
3158
|
end
|
3091
3159
|
|
3092
3160
|
# Retrieve network attributes for the user
|
3093
|
-
# This endpoint allows you to retrieve the Network
|
3094
|
-
# @param
|
3161
|
+
# 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.
|
3162
|
+
# @param cra_check_report_network_insights_get_request [CraCheckReportNetworkInsightsGetRequest]
|
3095
3163
|
# @param [Hash] opts the optional parameters
|
3096
|
-
# @return [Array<(
|
3097
|
-
def
|
3164
|
+
# @return [Array<(CraCheckReportNetworkInsightsGetResponse, Integer, Hash)>] CraCheckReportNetworkInsightsGetResponse data, response status code and response headers
|
3165
|
+
def cra_check_report_network_insights_get_with_http_info(cra_check_report_network_insights_get_request, opts = {})
|
3098
3166
|
if @api_client.config.debugging
|
3099
|
-
@api_client.config.logger.debug 'Calling API: PlaidApi.
|
3167
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.cra_check_report_network_insights_get ...'
|
3100
3168
|
end
|
3101
|
-
# verify the required parameter '
|
3102
|
-
if @api_client.config.client_side_validation &&
|
3103
|
-
fail ArgumentError, "Missing the required parameter '
|
3169
|
+
# verify the required parameter 'cra_check_report_network_insights_get_request' is set
|
3170
|
+
if @api_client.config.client_side_validation && cra_check_report_network_insights_get_request.nil?
|
3171
|
+
fail ArgumentError, "Missing the required parameter 'cra_check_report_network_insights_get_request' when calling PlaidApi.cra_check_report_network_insights_get"
|
3104
3172
|
end
|
3105
3173
|
# resource path
|
3106
3174
|
local_var_path = '/cra/check_report/network_insights/get'
|
@@ -3122,16 +3190,16 @@ module Plaid
|
|
3122
3190
|
form_params = opts[:form_params] || {}
|
3123
3191
|
|
3124
3192
|
# http body (model)
|
3125
|
-
post_body = opts[:debug_body] || @api_client.object_to_http_body(
|
3193
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(cra_check_report_network_insights_get_request)
|
3126
3194
|
|
3127
3195
|
# return_type
|
3128
|
-
return_type = opts[:debug_return_type] || '
|
3196
|
+
return_type = opts[:debug_return_type] || 'CraCheckReportNetworkInsightsGetResponse'
|
3129
3197
|
|
3130
3198
|
# auth_names
|
3131
3199
|
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
3132
3200
|
|
3133
3201
|
new_options = opts.merge(
|
3134
|
-
:operation => :"PlaidApi.
|
3202
|
+
:operation => :"PlaidApi.cra_check_report_network_insights_get",
|
3135
3203
|
:header_params => header_params,
|
3136
3204
|
:query_params => query_params,
|
3137
3205
|
:form_params => form_params,
|
@@ -3142,13 +3210,13 @@ module Plaid
|
|
3142
3210
|
|
3143
3211
|
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
3144
3212
|
if @api_client.config.debugging
|
3145
|
-
@api_client.config.logger.debug "API called: PlaidApi#
|
3213
|
+
@api_client.config.logger.debug "API called: PlaidApi#cra_check_report_network_insights_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
3146
3214
|
end
|
3147
3215
|
return data, status_code, headers
|
3148
3216
|
end
|
3149
3217
|
|
3150
3218
|
# Retrieve cash flow insights from partners
|
3151
|
-
# This endpoint allows you to retrieve the Partner Insights
|
3219
|
+
# 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
3220
|
# @param cra_check_report_partner_insights_get_request [CraCheckReportPartnerInsightsGetRequest]
|
3153
3221
|
# @param [Hash] opts the optional parameters
|
3154
3222
|
# @return [CraCheckReportPartnerInsightsGetResponse]
|
@@ -3158,7 +3226,7 @@ module Plaid
|
|
3158
3226
|
end
|
3159
3227
|
|
3160
3228
|
# Retrieve cash flow insights from partners
|
3161
|
-
# This endpoint allows you to retrieve the Partner Insights
|
3229
|
+
# 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
3230
|
# @param cra_check_report_partner_insights_get_request [CraCheckReportPartnerInsightsGetRequest]
|
3163
3231
|
# @param [Hash] opts the optional parameters
|
3164
3232
|
# @return [Array<(CraCheckReportPartnerInsightsGetResponse, Integer, Hash)>] CraCheckReportPartnerInsightsGetResponse data, response status code and response headers
|
@@ -3215,8 +3283,8 @@ module Plaid
|
|
3215
3283
|
return data, status_code, headers
|
3216
3284
|
end
|
3217
3285
|
|
3218
|
-
# Retrieve
|
3219
|
-
# `/cra/check_report/pdf/get`
|
3286
|
+
# Retrieve Consumer Reports as a PDF
|
3287
|
+
# `/cra/check_report/pdf/get` retrieves the most recent Consumer Report in PDF format. By default, the most recent Base Report (if it exists) for the user will be returned. To request that the most recent Income Insights report be included in the PDF as well, use the `add-ons` field.
|
3220
3288
|
# @param cra_check_report_pdf_get_request [CraCheckReportPDFGetRequest]
|
3221
3289
|
# @param [Hash] opts the optional parameters
|
3222
3290
|
# @return [File]
|
@@ -3225,8 +3293,8 @@ module Plaid
|
|
3225
3293
|
data
|
3226
3294
|
end
|
3227
3295
|
|
3228
|
-
# Retrieve
|
3229
|
-
# `/cra/check_report/pdf/get`
|
3296
|
+
# Retrieve Consumer Reports as a PDF
|
3297
|
+
# `/cra/check_report/pdf/get` retrieves the most recent Consumer Report in PDF format. By default, the most recent Base Report (if it exists) for the user will be returned. To request that the most recent Income Insights report be included in the PDF as well, use the `add-ons` field.
|
3230
3298
|
# @param cra_check_report_pdf_get_request [CraCheckReportPDFGetRequest]
|
3231
3299
|
# @param [Hash] opts the optional parameters
|
3232
3300
|
# @return [Array<(File, Integer, Hash)>] File data, response status code and response headers
|
@@ -3555,6 +3623,210 @@ module Plaid
|
|
3555
3623
|
return data, status_code, headers
|
3556
3624
|
end
|
3557
3625
|
|
3626
|
+
# Retrieve a Monitoring Insights Report
|
3627
|
+
# This endpoint allows you to retrieve a Monitoring Insights report by passing in the `user_token` referred to in the webhook you received.
|
3628
|
+
# @param cra_monitoring_insights_get_request [CraMonitoringInsightsGetRequest]
|
3629
|
+
# @param [Hash] opts the optional parameters
|
3630
|
+
# @return [CraMonitoringInsightsGetResponse]
|
3631
|
+
def cra_monitoring_insights_get(cra_monitoring_insights_get_request, opts = {})
|
3632
|
+
data, _status_code, _headers = cra_monitoring_insights_get_with_http_info(cra_monitoring_insights_get_request, opts)
|
3633
|
+
data
|
3634
|
+
end
|
3635
|
+
|
3636
|
+
# Retrieve a Monitoring Insights Report
|
3637
|
+
# This endpoint allows you to retrieve a Monitoring Insights report by passing in the `user_token` referred to in the webhook you received.
|
3638
|
+
# @param cra_monitoring_insights_get_request [CraMonitoringInsightsGetRequest]
|
3639
|
+
# @param [Hash] opts the optional parameters
|
3640
|
+
# @return [Array<(CraMonitoringInsightsGetResponse, Integer, Hash)>] CraMonitoringInsightsGetResponse data, response status code and response headers
|
3641
|
+
def cra_monitoring_insights_get_with_http_info(cra_monitoring_insights_get_request, opts = {})
|
3642
|
+
if @api_client.config.debugging
|
3643
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.cra_monitoring_insights_get ...'
|
3644
|
+
end
|
3645
|
+
# verify the required parameter 'cra_monitoring_insights_get_request' is set
|
3646
|
+
if @api_client.config.client_side_validation && cra_monitoring_insights_get_request.nil?
|
3647
|
+
fail ArgumentError, "Missing the required parameter 'cra_monitoring_insights_get_request' when calling PlaidApi.cra_monitoring_insights_get"
|
3648
|
+
end
|
3649
|
+
# resource path
|
3650
|
+
local_var_path = '/cra/monitoring_insights/get'
|
3651
|
+
|
3652
|
+
# query parameters
|
3653
|
+
query_params = opts[:query_params] || {}
|
3654
|
+
|
3655
|
+
# header parameters
|
3656
|
+
header_params = opts[:header_params] || {}
|
3657
|
+
# HTTP header 'Accept' (if needed)
|
3658
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
3659
|
+
# HTTP header 'Content-Type'
|
3660
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
3661
|
+
if !content_type.nil?
|
3662
|
+
header_params['Content-Type'] = content_type
|
3663
|
+
end
|
3664
|
+
|
3665
|
+
# form parameters
|
3666
|
+
form_params = opts[:form_params] || {}
|
3667
|
+
|
3668
|
+
# http body (model)
|
3669
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(cra_monitoring_insights_get_request)
|
3670
|
+
|
3671
|
+
# return_type
|
3672
|
+
return_type = opts[:debug_return_type] || 'CraMonitoringInsightsGetResponse'
|
3673
|
+
|
3674
|
+
# auth_names
|
3675
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
3676
|
+
|
3677
|
+
new_options = opts.merge(
|
3678
|
+
:operation => :"PlaidApi.cra_monitoring_insights_get",
|
3679
|
+
:header_params => header_params,
|
3680
|
+
:query_params => query_params,
|
3681
|
+
:form_params => form_params,
|
3682
|
+
:body => post_body,
|
3683
|
+
:auth_names => auth_names,
|
3684
|
+
:return_type => return_type
|
3685
|
+
)
|
3686
|
+
|
3687
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
3688
|
+
if @api_client.config.debugging
|
3689
|
+
@api_client.config.logger.debug "API called: PlaidApi#cra_monitoring_insights_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
3690
|
+
end
|
3691
|
+
return data, status_code, headers
|
3692
|
+
end
|
3693
|
+
|
3694
|
+
# Subscribe to Monitoring Insights
|
3695
|
+
# This endpoint allows you to subscribe to insights for a user's linked CRA items, which are updated every 14 days.
|
3696
|
+
# @param cra_monitoring_insights_subscribe_request [CraMonitoringInsightsSubscribeRequest]
|
3697
|
+
# @param [Hash] opts the optional parameters
|
3698
|
+
# @return [CraMonitoringInsightsSubscribeResponse]
|
3699
|
+
def cra_monitoring_insights_subscribe(cra_monitoring_insights_subscribe_request, opts = {})
|
3700
|
+
data, _status_code, _headers = cra_monitoring_insights_subscribe_with_http_info(cra_monitoring_insights_subscribe_request, opts)
|
3701
|
+
data
|
3702
|
+
end
|
3703
|
+
|
3704
|
+
# Subscribe to Monitoring Insights
|
3705
|
+
# This endpoint allows you to subscribe to insights for a user's linked CRA items, which are updated every 14 days.
|
3706
|
+
# @param cra_monitoring_insights_subscribe_request [CraMonitoringInsightsSubscribeRequest]
|
3707
|
+
# @param [Hash] opts the optional parameters
|
3708
|
+
# @return [Array<(CraMonitoringInsightsSubscribeResponse, Integer, Hash)>] CraMonitoringInsightsSubscribeResponse data, response status code and response headers
|
3709
|
+
def cra_monitoring_insights_subscribe_with_http_info(cra_monitoring_insights_subscribe_request, opts = {})
|
3710
|
+
if @api_client.config.debugging
|
3711
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.cra_monitoring_insights_subscribe ...'
|
3712
|
+
end
|
3713
|
+
# verify the required parameter 'cra_monitoring_insights_subscribe_request' is set
|
3714
|
+
if @api_client.config.client_side_validation && cra_monitoring_insights_subscribe_request.nil?
|
3715
|
+
fail ArgumentError, "Missing the required parameter 'cra_monitoring_insights_subscribe_request' when calling PlaidApi.cra_monitoring_insights_subscribe"
|
3716
|
+
end
|
3717
|
+
# resource path
|
3718
|
+
local_var_path = '/cra/monitoring_insights/subscribe'
|
3719
|
+
|
3720
|
+
# query parameters
|
3721
|
+
query_params = opts[:query_params] || {}
|
3722
|
+
|
3723
|
+
# header parameters
|
3724
|
+
header_params = opts[:header_params] || {}
|
3725
|
+
# HTTP header 'Accept' (if needed)
|
3726
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
3727
|
+
# HTTP header 'Content-Type'
|
3728
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
3729
|
+
if !content_type.nil?
|
3730
|
+
header_params['Content-Type'] = content_type
|
3731
|
+
end
|
3732
|
+
|
3733
|
+
# form parameters
|
3734
|
+
form_params = opts[:form_params] || {}
|
3735
|
+
|
3736
|
+
# http body (model)
|
3737
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(cra_monitoring_insights_subscribe_request)
|
3738
|
+
|
3739
|
+
# return_type
|
3740
|
+
return_type = opts[:debug_return_type] || 'CraMonitoringInsightsSubscribeResponse'
|
3741
|
+
|
3742
|
+
# auth_names
|
3743
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
3744
|
+
|
3745
|
+
new_options = opts.merge(
|
3746
|
+
:operation => :"PlaidApi.cra_monitoring_insights_subscribe",
|
3747
|
+
:header_params => header_params,
|
3748
|
+
:query_params => query_params,
|
3749
|
+
:form_params => form_params,
|
3750
|
+
:body => post_body,
|
3751
|
+
:auth_names => auth_names,
|
3752
|
+
:return_type => return_type
|
3753
|
+
)
|
3754
|
+
|
3755
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
3756
|
+
if @api_client.config.debugging
|
3757
|
+
@api_client.config.logger.debug "API called: PlaidApi#cra_monitoring_insights_subscribe\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
3758
|
+
end
|
3759
|
+
return data, status_code, headers
|
3760
|
+
end
|
3761
|
+
|
3762
|
+
# Unsubscribe from Monitoring Insights
|
3763
|
+
# This endpoint allows you to unsubscribe from previously subscribed Monitoring Insights.
|
3764
|
+
# @param cra_monitoring_insights_unsubscribe_request [CraMonitoringInsightsUnsubscribeRequest]
|
3765
|
+
# @param [Hash] opts the optional parameters
|
3766
|
+
# @return [CraMonitoringInsightsUnsubscribeResponse]
|
3767
|
+
def cra_monitoring_insights_unsubscribe(cra_monitoring_insights_unsubscribe_request, opts = {})
|
3768
|
+
data, _status_code, _headers = cra_monitoring_insights_unsubscribe_with_http_info(cra_monitoring_insights_unsubscribe_request, opts)
|
3769
|
+
data
|
3770
|
+
end
|
3771
|
+
|
3772
|
+
# Unsubscribe from Monitoring Insights
|
3773
|
+
# This endpoint allows you to unsubscribe from previously subscribed Monitoring Insights.
|
3774
|
+
# @param cra_monitoring_insights_unsubscribe_request [CraMonitoringInsightsUnsubscribeRequest]
|
3775
|
+
# @param [Hash] opts the optional parameters
|
3776
|
+
# @return [Array<(CraMonitoringInsightsUnsubscribeResponse, Integer, Hash)>] CraMonitoringInsightsUnsubscribeResponse data, response status code and response headers
|
3777
|
+
def cra_monitoring_insights_unsubscribe_with_http_info(cra_monitoring_insights_unsubscribe_request, opts = {})
|
3778
|
+
if @api_client.config.debugging
|
3779
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.cra_monitoring_insights_unsubscribe ...'
|
3780
|
+
end
|
3781
|
+
# verify the required parameter 'cra_monitoring_insights_unsubscribe_request' is set
|
3782
|
+
if @api_client.config.client_side_validation && cra_monitoring_insights_unsubscribe_request.nil?
|
3783
|
+
fail ArgumentError, "Missing the required parameter 'cra_monitoring_insights_unsubscribe_request' when calling PlaidApi.cra_monitoring_insights_unsubscribe"
|
3784
|
+
end
|
3785
|
+
# resource path
|
3786
|
+
local_var_path = '/cra/monitoring_insights/unsubscribe'
|
3787
|
+
|
3788
|
+
# query parameters
|
3789
|
+
query_params = opts[:query_params] || {}
|
3790
|
+
|
3791
|
+
# header parameters
|
3792
|
+
header_params = opts[:header_params] || {}
|
3793
|
+
# HTTP header 'Accept' (if needed)
|
3794
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
3795
|
+
# HTTP header 'Content-Type'
|
3796
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
3797
|
+
if !content_type.nil?
|
3798
|
+
header_params['Content-Type'] = content_type
|
3799
|
+
end
|
3800
|
+
|
3801
|
+
# form parameters
|
3802
|
+
form_params = opts[:form_params] || {}
|
3803
|
+
|
3804
|
+
# http body (model)
|
3805
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(cra_monitoring_insights_unsubscribe_request)
|
3806
|
+
|
3807
|
+
# return_type
|
3808
|
+
return_type = opts[:debug_return_type] || 'CraMonitoringInsightsUnsubscribeResponse'
|
3809
|
+
|
3810
|
+
# auth_names
|
3811
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
3812
|
+
|
3813
|
+
new_options = opts.merge(
|
3814
|
+
:operation => :"PlaidApi.cra_monitoring_insights_unsubscribe",
|
3815
|
+
:header_params => header_params,
|
3816
|
+
:query_params => query_params,
|
3817
|
+
:form_params => form_params,
|
3818
|
+
:body => post_body,
|
3819
|
+
:auth_names => auth_names,
|
3820
|
+
:return_type => return_type
|
3821
|
+
)
|
3822
|
+
|
3823
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
3824
|
+
if @api_client.config.debugging
|
3825
|
+
@api_client.config.logger.debug "API called: PlaidApi#cra_monitoring_insights_unsubscribe\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
3826
|
+
end
|
3827
|
+
return data, status_code, headers
|
3828
|
+
end
|
3829
|
+
|
3558
3830
|
# Retrieve cash flow insights from the bank accounts used for income verification
|
3559
3831
|
# `/cra/partner_insights/get` returns cash flow insights for a specified user.
|
3560
3832
|
# @param cra_partner_insights_get_request [CraPartnerInsightsGetRequest]
|
@@ -3964,7 +4236,7 @@ module Plaid
|
|
3964
4236
|
end
|
3965
4237
|
|
3966
4238
|
# 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.
|
4239
|
+
# `/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
4240
|
# @param credit_bank_income_get_request [CreditBankIncomeGetRequest]
|
3969
4241
|
# @param [Hash] opts the optional parameters
|
3970
4242
|
# @return [CreditBankIncomeGetResponse]
|
@@ -3974,7 +4246,7 @@ module Plaid
|
|
3974
4246
|
end
|
3975
4247
|
|
3976
4248
|
# 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.
|
4249
|
+
# `/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
4250
|
# @param credit_bank_income_get_request [CreditBankIncomeGetRequest]
|
3979
4251
|
# @param [Hash] opts the optional parameters
|
3980
4252
|
# @return [Array<(CreditBankIncomeGetResponse, Integer, Hash)>] CreditBankIncomeGetResponse data, response status code and response headers
|
@@ -4032,7 +4304,7 @@ module Plaid
|
|
4032
4304
|
end
|
4033
4305
|
|
4034
4306
|
# 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.
|
4307
|
+
# `/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
4308
|
# @param credit_bank_income_pdf_get_request [CreditBankIncomePDFGetRequest]
|
4037
4309
|
# @param [Hash] opts the optional parameters
|
4038
4310
|
# @return [File]
|
@@ -4042,7 +4314,7 @@ module Plaid
|
|
4042
4314
|
end
|
4043
4315
|
|
4044
4316
|
# 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.
|
4317
|
+
# `/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
4318
|
# @param credit_bank_income_pdf_get_request [CreditBankIncomePDFGetRequest]
|
4047
4319
|
# @param [Hash] opts the optional parameters
|
4048
4320
|
# @return [Array<(File, Integer, Hash)>] File data, response status code and response headers
|
@@ -4100,7 +4372,7 @@ module Plaid
|
|
4100
4372
|
end
|
4101
4373
|
|
4102
4374
|
# Refresh a user's bank income information
|
4103
|
-
# `/credit/bank_income/refresh` refreshes the bank income report data for a specific user.
|
4375
|
+
# `/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
4376
|
# @param credit_bank_income_refresh_request [CreditBankIncomeRefreshRequest]
|
4105
4377
|
# @param [Hash] opts the optional parameters
|
4106
4378
|
# @return [CreditBankIncomeRefreshResponse]
|
@@ -4110,7 +4382,7 @@ module Plaid
|
|
4110
4382
|
end
|
4111
4383
|
|
4112
4384
|
# Refresh a user's bank income information
|
4113
|
-
# `/credit/bank_income/refresh` refreshes the bank income report data for a specific user.
|
4385
|
+
# `/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
4386
|
# @param credit_bank_income_refresh_request [CreditBankIncomeRefreshRequest]
|
4115
4387
|
# @param [Hash] opts the optional parameters
|
4116
4388
|
# @return [Array<(CreditBankIncomeRefreshResponse, Integer, Hash)>] CreditBankIncomeRefreshResponse data, response status code and response headers
|
@@ -5256,7 +5528,7 @@ module Plaid
|
|
5256
5528
|
end
|
5257
5529
|
|
5258
5530
|
# Retrieve a dashboard user
|
5259
|
-
#
|
5531
|
+
# The `/dashboard_user/get` endpoint provides details (such as email address) about a specific Dashboard user based on the `dashboard_user_id` field, which is returned in the `audit_trail` object of certain Monitor and Beacon endpoints. This can be used to identify the specific reviewer who performed a Dashboard action.
|
5260
5532
|
# @param dashboard_user_get_request [DashboardUserGetRequest]
|
5261
5533
|
# @param [Hash] opts the optional parameters
|
5262
5534
|
# @return [DashboardUserGetResponse]
|
@@ -5266,7 +5538,7 @@ module Plaid
|
|
5266
5538
|
end
|
5267
5539
|
|
5268
5540
|
# Retrieve a dashboard user
|
5269
|
-
#
|
5541
|
+
# The `/dashboard_user/get` endpoint provides details (such as email address) about a specific Dashboard user based on the `dashboard_user_id` field, which is returned in the `audit_trail` object of certain Monitor and Beacon endpoints. This can be used to identify the specific reviewer who performed a Dashboard action.
|
5270
5542
|
# @param dashboard_user_get_request [DashboardUserGetRequest]
|
5271
5543
|
# @param [Hash] opts the optional parameters
|
5272
5544
|
# @return [Array<(DashboardUserGetResponse, Integer, Hash)>] DashboardUserGetResponse data, response status code and response headers
|
@@ -5324,7 +5596,7 @@ module Plaid
|
|
5324
5596
|
end
|
5325
5597
|
|
5326
5598
|
# List dashboard users
|
5327
|
-
#
|
5599
|
+
# The `/dashboard_user/list` endpoint provides details (such as email address) all Dashboard users associated with your account. This can use used to audit or track the list of reviewers for Monitor, Beacon, and Identity Verification products.
|
5328
5600
|
# @param dashboard_user_list_request [DashboardUserListRequest]
|
5329
5601
|
# @param [Hash] opts the optional parameters
|
5330
5602
|
# @return [DashboardUserListResponse]
|
@@ -5334,7 +5606,7 @@ module Plaid
|
|
5334
5606
|
end
|
5335
5607
|
|
5336
5608
|
# List dashboard users
|
5337
|
-
#
|
5609
|
+
# The `/dashboard_user/list` endpoint provides details (such as email address) all Dashboard users associated with your account. This can use used to audit or track the list of reviewers for Monitor, Beacon, and Identity Verification products.
|
5338
5610
|
# @param dashboard_user_list_request [DashboardUserListRequest]
|
5339
5611
|
# @param [Hash] opts the optional parameters
|
5340
5612
|
# @return [Array<(DashboardUserListResponse, Integer, Hash)>] DashboardUserListResponse data, response status code and response headers
|
@@ -5391,7 +5663,7 @@ module Plaid
|
|
5391
5663
|
return data, status_code, headers
|
5392
5664
|
end
|
5393
5665
|
|
5394
|
-
# Create a deposit switch without using Plaid Exchange
|
5666
|
+
# (Deprecated) Create a deposit switch without using Plaid Exchange
|
5395
5667
|
# This endpoint provides an alternative to `/deposit_switch/create` for customers who have not yet fully integrated with Plaid Exchange. Like `/deposit_switch/create`, it creates a deposit switch entity that will be persisted throughout the lifecycle of the switch.
|
5396
5668
|
# @param deposit_switch_alt_create_request [DepositSwitchAltCreateRequest]
|
5397
5669
|
# @param [Hash] opts the optional parameters
|
@@ -5401,7 +5673,7 @@ module Plaid
|
|
5401
5673
|
data
|
5402
5674
|
end
|
5403
5675
|
|
5404
|
-
# Create a deposit switch without using Plaid Exchange
|
5676
|
+
# (Deprecated) Create a deposit switch without using Plaid Exchange
|
5405
5677
|
# This endpoint provides an alternative to `/deposit_switch/create` for customers who have not yet fully integrated with Plaid Exchange. Like `/deposit_switch/create`, it creates a deposit switch entity that will be persisted throughout the lifecycle of the switch.
|
5406
5678
|
# @param deposit_switch_alt_create_request [DepositSwitchAltCreateRequest]
|
5407
5679
|
# @param [Hash] opts the optional parameters
|
@@ -5459,7 +5731,7 @@ module Plaid
|
|
5459
5731
|
return data, status_code, headers
|
5460
5732
|
end
|
5461
5733
|
|
5462
|
-
# Create a deposit switch
|
5734
|
+
# (Deprecated) Create a deposit switch
|
5463
5735
|
# This endpoint creates a deposit switch entity that will be persisted throughout the lifecycle of the switch.
|
5464
5736
|
# @param deposit_switch_create_request [DepositSwitchCreateRequest]
|
5465
5737
|
# @param [Hash] opts the optional parameters
|
@@ -5469,7 +5741,7 @@ module Plaid
|
|
5469
5741
|
data
|
5470
5742
|
end
|
5471
5743
|
|
5472
|
-
# Create a deposit switch
|
5744
|
+
# (Deprecated) Create a deposit switch
|
5473
5745
|
# This endpoint creates a deposit switch entity that will be persisted throughout the lifecycle of the switch.
|
5474
5746
|
# @param deposit_switch_create_request [DepositSwitchCreateRequest]
|
5475
5747
|
# @param [Hash] opts the optional parameters
|
@@ -5527,7 +5799,7 @@ module Plaid
|
|
5527
5799
|
return data, status_code, headers
|
5528
5800
|
end
|
5529
5801
|
|
5530
|
-
# Retrieve a deposit switch
|
5802
|
+
# (Deprecated) Retrieve a deposit switch
|
5531
5803
|
# This endpoint returns information related to how the user has configured their payroll allocation and the state of the switch. You can use this information to build logic related to the user's direct deposit allocation preferences.
|
5532
5804
|
# @param deposit_switch_get_request [DepositSwitchGetRequest]
|
5533
5805
|
# @param [Hash] opts the optional parameters
|
@@ -5537,7 +5809,7 @@ module Plaid
|
|
5537
5809
|
data
|
5538
5810
|
end
|
5539
5811
|
|
5540
|
-
# Retrieve a deposit switch
|
5812
|
+
# (Deprecated) Retrieve a deposit switch
|
5541
5813
|
# This endpoint returns information related to how the user has configured their payroll allocation and the state of the switch. You can use this information to build logic related to the user's direct deposit allocation preferences.
|
5542
5814
|
# @param deposit_switch_get_request [DepositSwitchGetRequest]
|
5543
5815
|
# @param [Hash] opts the optional parameters
|
@@ -5595,7 +5867,7 @@ module Plaid
|
|
5595
5867
|
return data, status_code, headers
|
5596
5868
|
end
|
5597
5869
|
|
5598
|
-
# Create a deposit switch token
|
5870
|
+
# (Deprecated) Create a deposit switch token
|
5599
5871
|
# In order for the end user to take action, you will need to create a public token representing the deposit switch. This token is used to initialize Link. It can be used one time and expires after 30 minutes.
|
5600
5872
|
# @param deposit_switch_token_create_request [DepositSwitchTokenCreateRequest]
|
5601
5873
|
# @param [Hash] opts the optional parameters
|
@@ -5605,7 +5877,7 @@ module Plaid
|
|
5605
5877
|
data
|
5606
5878
|
end
|
5607
5879
|
|
5608
|
-
# Create a deposit switch token
|
5880
|
+
# (Deprecated) Create a deposit switch token
|
5609
5881
|
# In order for the end user to take action, you will need to create a public token representing the deposit switch. This token is used to initialize Link. It can be used one time and expires after 30 minutes.
|
5610
5882
|
# @param deposit_switch_token_create_request [DepositSwitchTokenCreateRequest]
|
5611
5883
|
# @param [Hash] opts the optional parameters
|
@@ -5867,6 +6139,129 @@ module Plaid
|
|
5867
6139
|
return data, status_code, headers
|
5868
6140
|
end
|
5869
6141
|
|
6142
|
+
# Get Recipient
|
6143
|
+
# Get a specific recipient
|
6144
|
+
# @param recipient_id [String] Recipient Identifier. Uniquely identifies the recipient
|
6145
|
+
# @param [Hash] opts the optional parameters
|
6146
|
+
# @option opts [String] :oauth_state_id The value that is passed into the OAuth URI 'state' query parameter.
|
6147
|
+
# @return [GetRecipientResponse]
|
6148
|
+
def get_recipient(recipient_id, opts = {})
|
6149
|
+
data, _status_code, _headers = get_recipient_with_http_info(recipient_id, opts)
|
6150
|
+
data
|
6151
|
+
end
|
6152
|
+
|
6153
|
+
# Get Recipient
|
6154
|
+
# Get a specific recipient
|
6155
|
+
# @param recipient_id [String] Recipient Identifier. Uniquely identifies the recipient
|
6156
|
+
# @param [Hash] opts the optional parameters
|
6157
|
+
# @option opts [String] :oauth_state_id The value that is passed into the OAuth URI 'state' query parameter.
|
6158
|
+
# @return [Array<(GetRecipientResponse, Integer, Hash)>] GetRecipientResponse data, response status code and response headers
|
6159
|
+
def get_recipient_with_http_info(recipient_id, opts = {})
|
6160
|
+
if @api_client.config.debugging
|
6161
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.get_recipient ...'
|
6162
|
+
end
|
6163
|
+
# verify the required parameter 'recipient_id' is set
|
6164
|
+
if @api_client.config.client_side_validation && recipient_id.nil?
|
6165
|
+
fail ArgumentError, "Missing the required parameter 'recipient_id' when calling PlaidApi.get_recipient"
|
6166
|
+
end
|
6167
|
+
# resource path
|
6168
|
+
local_var_path = '/fdx/recipient/{recipientId}'.sub('{' + 'recipientId' + '}', CGI.escape(recipient_id.to_s))
|
6169
|
+
|
6170
|
+
# query parameters
|
6171
|
+
query_params = opts[:query_params] || {}
|
6172
|
+
|
6173
|
+
# header parameters
|
6174
|
+
header_params = opts[:header_params] || {}
|
6175
|
+
# HTTP header 'Accept' (if needed)
|
6176
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
6177
|
+
header_params[:'OAUTH-STATE-ID'] = opts[:'oauth_state_id'] if !opts[:'oauth_state_id'].nil?
|
6178
|
+
|
6179
|
+
# form parameters
|
6180
|
+
form_params = opts[:form_params] || {}
|
6181
|
+
|
6182
|
+
# http body (model)
|
6183
|
+
post_body = opts[:debug_body]
|
6184
|
+
|
6185
|
+
# return_type
|
6186
|
+
return_type = opts[:debug_return_type] || 'GetRecipientResponse'
|
6187
|
+
|
6188
|
+
# auth_names
|
6189
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
6190
|
+
|
6191
|
+
new_options = opts.merge(
|
6192
|
+
:operation => :"PlaidApi.get_recipient",
|
6193
|
+
:header_params => header_params,
|
6194
|
+
:query_params => query_params,
|
6195
|
+
:form_params => form_params,
|
6196
|
+
:body => post_body,
|
6197
|
+
:auth_names => auth_names,
|
6198
|
+
:return_type => return_type
|
6199
|
+
)
|
6200
|
+
|
6201
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
6202
|
+
if @api_client.config.debugging
|
6203
|
+
@api_client.config.logger.debug "API called: PlaidApi#get_recipient\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
6204
|
+
end
|
6205
|
+
return data, status_code, headers
|
6206
|
+
end
|
6207
|
+
|
6208
|
+
# Get Recipients
|
6209
|
+
# Returns a list of Recipients
|
6210
|
+
# @param [Hash] opts the optional parameters
|
6211
|
+
# @return [GetRecipientsResponse]
|
6212
|
+
def get_recipients(opts = {})
|
6213
|
+
data, _status_code, _headers = get_recipients_with_http_info(opts)
|
6214
|
+
data
|
6215
|
+
end
|
6216
|
+
|
6217
|
+
# Get Recipients
|
6218
|
+
# Returns a list of Recipients
|
6219
|
+
# @param [Hash] opts the optional parameters
|
6220
|
+
# @return [Array<(GetRecipientsResponse, Integer, Hash)>] GetRecipientsResponse data, response status code and response headers
|
6221
|
+
def get_recipients_with_http_info(opts = {})
|
6222
|
+
if @api_client.config.debugging
|
6223
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.get_recipients ...'
|
6224
|
+
end
|
6225
|
+
# resource path
|
6226
|
+
local_var_path = '/fdx/recipients'
|
6227
|
+
|
6228
|
+
# query parameters
|
6229
|
+
query_params = opts[:query_params] || {}
|
6230
|
+
|
6231
|
+
# header parameters
|
6232
|
+
header_params = opts[:header_params] || {}
|
6233
|
+
# HTTP header 'Accept' (if needed)
|
6234
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
6235
|
+
|
6236
|
+
# form parameters
|
6237
|
+
form_params = opts[:form_params] || {}
|
6238
|
+
|
6239
|
+
# http body (model)
|
6240
|
+
post_body = opts[:debug_body]
|
6241
|
+
|
6242
|
+
# return_type
|
6243
|
+
return_type = opts[:debug_return_type] || 'GetRecipientsResponse'
|
6244
|
+
|
6245
|
+
# auth_names
|
6246
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
6247
|
+
|
6248
|
+
new_options = opts.merge(
|
6249
|
+
:operation => :"PlaidApi.get_recipients",
|
6250
|
+
:header_params => header_params,
|
6251
|
+
:query_params => query_params,
|
6252
|
+
:form_params => form_params,
|
6253
|
+
:body => post_body,
|
6254
|
+
:auth_names => auth_names,
|
6255
|
+
:return_type => return_type
|
6256
|
+
)
|
6257
|
+
|
6258
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
6259
|
+
if @api_client.config.debugging
|
6260
|
+
@api_client.config.logger.debug "API called: PlaidApi#get_recipients\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
6261
|
+
end
|
6262
|
+
return data, status_code, headers
|
6263
|
+
end
|
6264
|
+
|
5870
6265
|
# Returns uploaded document identity
|
5871
6266
|
# Use `/identity/documents/uploads/get` to retrieve document uploaded identity.
|
5872
6267
|
# @param identity_documents_uploads_get_request [IdentityDocumentsUploadsGetRequest]
|
@@ -5936,7 +6331,7 @@ module Plaid
|
|
5936
6331
|
end
|
5937
6332
|
|
5938
6333
|
# 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.
|
6334
|
+
# 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
6335
|
# @param identity_get_request [IdentityGetRequest]
|
5941
6336
|
# @param [Hash] opts the optional parameters
|
5942
6337
|
# @return [IdentityGetResponse]
|
@@ -5946,7 +6341,7 @@ module Plaid
|
|
5946
6341
|
end
|
5947
6342
|
|
5948
6343
|
# 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.
|
6344
|
+
# 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
6345
|
# @param identity_get_request [IdentityGetRequest]
|
5951
6346
|
# @param [Hash] opts the optional parameters
|
5952
6347
|
# @return [Array<(IdentityGetResponse, Integer, Hash)>] IdentityGetResponse data, response status code and response headers
|
@@ -6004,7 +6399,7 @@ module Plaid
|
|
6004
6399
|
end
|
6005
6400
|
|
6006
6401
|
# 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.
|
6402
|
+
# 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
6403
|
# @param identity_match_request [IdentityMatchRequest]
|
6009
6404
|
# @param [Hash] opts the optional parameters
|
6010
6405
|
# @return [IdentityMatchResponse]
|
@@ -6014,7 +6409,7 @@ module Plaid
|
|
6014
6409
|
end
|
6015
6410
|
|
6016
6411
|
# 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.
|
6412
|
+
# 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
6413
|
# @param identity_match_request [IdentityMatchRequest]
|
6019
6414
|
# @param [Hash] opts the optional parameters
|
6020
6415
|
# @return [Array<(IdentityMatchResponse, Integer, Hash)>] IdentityMatchResponse data, response status code and response headers
|
@@ -7069,13 +7464,217 @@ module Plaid
|
|
7069
7464
|
post_body = opts[:debug_body] || @api_client.object_to_http_body(investments_auth_get_request)
|
7070
7465
|
|
7071
7466
|
# return_type
|
7072
|
-
return_type = opts[:debug_return_type] || 'InvestmentsAuthGetResponse'
|
7467
|
+
return_type = opts[:debug_return_type] || 'InvestmentsAuthGetResponse'
|
7468
|
+
|
7469
|
+
# auth_names
|
7470
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
7471
|
+
|
7472
|
+
new_options = opts.merge(
|
7473
|
+
:operation => :"PlaidApi.investments_auth_get",
|
7474
|
+
:header_params => header_params,
|
7475
|
+
:query_params => query_params,
|
7476
|
+
:form_params => form_params,
|
7477
|
+
:body => post_body,
|
7478
|
+
:auth_names => auth_names,
|
7479
|
+
:return_type => return_type
|
7480
|
+
)
|
7481
|
+
|
7482
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
7483
|
+
if @api_client.config.debugging
|
7484
|
+
@api_client.config.logger.debug "API called: PlaidApi#investments_auth_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
7485
|
+
end
|
7486
|
+
return data, status_code, headers
|
7487
|
+
end
|
7488
|
+
|
7489
|
+
# Get Investment holdings
|
7490
|
+
# The `/investments/holdings/get` endpoint allows developers to receive user-authorized stock position data for `investment`-type accounts.
|
7491
|
+
# @param investments_holdings_get_request [InvestmentsHoldingsGetRequest]
|
7492
|
+
# @param [Hash] opts the optional parameters
|
7493
|
+
# @return [InvestmentsHoldingsGetResponse]
|
7494
|
+
def investments_holdings_get(investments_holdings_get_request, opts = {})
|
7495
|
+
data, _status_code, _headers = investments_holdings_get_with_http_info(investments_holdings_get_request, opts)
|
7496
|
+
data
|
7497
|
+
end
|
7498
|
+
|
7499
|
+
# Get Investment holdings
|
7500
|
+
# The `/investments/holdings/get` endpoint allows developers to receive user-authorized stock position data for `investment`-type accounts.
|
7501
|
+
# @param investments_holdings_get_request [InvestmentsHoldingsGetRequest]
|
7502
|
+
# @param [Hash] opts the optional parameters
|
7503
|
+
# @return [Array<(InvestmentsHoldingsGetResponse, Integer, Hash)>] InvestmentsHoldingsGetResponse data, response status code and response headers
|
7504
|
+
def investments_holdings_get_with_http_info(investments_holdings_get_request, opts = {})
|
7505
|
+
if @api_client.config.debugging
|
7506
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.investments_holdings_get ...'
|
7507
|
+
end
|
7508
|
+
# verify the required parameter 'investments_holdings_get_request' is set
|
7509
|
+
if @api_client.config.client_side_validation && investments_holdings_get_request.nil?
|
7510
|
+
fail ArgumentError, "Missing the required parameter 'investments_holdings_get_request' when calling PlaidApi.investments_holdings_get"
|
7511
|
+
end
|
7512
|
+
# resource path
|
7513
|
+
local_var_path = '/investments/holdings/get'
|
7514
|
+
|
7515
|
+
# query parameters
|
7516
|
+
query_params = opts[:query_params] || {}
|
7517
|
+
|
7518
|
+
# header parameters
|
7519
|
+
header_params = opts[:header_params] || {}
|
7520
|
+
# HTTP header 'Accept' (if needed)
|
7521
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
7522
|
+
# HTTP header 'Content-Type'
|
7523
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
7524
|
+
if !content_type.nil?
|
7525
|
+
header_params['Content-Type'] = content_type
|
7526
|
+
end
|
7527
|
+
|
7528
|
+
# form parameters
|
7529
|
+
form_params = opts[:form_params] || {}
|
7530
|
+
|
7531
|
+
# http body (model)
|
7532
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(investments_holdings_get_request)
|
7533
|
+
|
7534
|
+
# return_type
|
7535
|
+
return_type = opts[:debug_return_type] || 'InvestmentsHoldingsGetResponse'
|
7536
|
+
|
7537
|
+
# auth_names
|
7538
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
7539
|
+
|
7540
|
+
new_options = opts.merge(
|
7541
|
+
:operation => :"PlaidApi.investments_holdings_get",
|
7542
|
+
:header_params => header_params,
|
7543
|
+
:query_params => query_params,
|
7544
|
+
:form_params => form_params,
|
7545
|
+
:body => post_body,
|
7546
|
+
:auth_names => auth_names,
|
7547
|
+
:return_type => return_type
|
7548
|
+
)
|
7549
|
+
|
7550
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
7551
|
+
if @api_client.config.debugging
|
7552
|
+
@api_client.config.logger.debug "API called: PlaidApi#investments_holdings_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
7553
|
+
end
|
7554
|
+
return data, status_code, headers
|
7555
|
+
end
|
7556
|
+
|
7557
|
+
# Refresh investment data
|
7558
|
+
# `/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.
|
7559
|
+
# @param investments_refresh_request [InvestmentsRefreshRequest]
|
7560
|
+
# @param [Hash] opts the optional parameters
|
7561
|
+
# @return [InvestmentsRefreshResponse]
|
7562
|
+
def investments_refresh(investments_refresh_request, opts = {})
|
7563
|
+
data, _status_code, _headers = investments_refresh_with_http_info(investments_refresh_request, opts)
|
7564
|
+
data
|
7565
|
+
end
|
7566
|
+
|
7567
|
+
# Refresh investment data
|
7568
|
+
# `/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.
|
7569
|
+
# @param investments_refresh_request [InvestmentsRefreshRequest]
|
7570
|
+
# @param [Hash] opts the optional parameters
|
7571
|
+
# @return [Array<(InvestmentsRefreshResponse, Integer, Hash)>] InvestmentsRefreshResponse data, response status code and response headers
|
7572
|
+
def investments_refresh_with_http_info(investments_refresh_request, opts = {})
|
7573
|
+
if @api_client.config.debugging
|
7574
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.investments_refresh ...'
|
7575
|
+
end
|
7576
|
+
# verify the required parameter 'investments_refresh_request' is set
|
7577
|
+
if @api_client.config.client_side_validation && investments_refresh_request.nil?
|
7578
|
+
fail ArgumentError, "Missing the required parameter 'investments_refresh_request' when calling PlaidApi.investments_refresh"
|
7579
|
+
end
|
7580
|
+
# resource path
|
7581
|
+
local_var_path = '/investments/refresh'
|
7582
|
+
|
7583
|
+
# query parameters
|
7584
|
+
query_params = opts[:query_params] || {}
|
7585
|
+
|
7586
|
+
# header parameters
|
7587
|
+
header_params = opts[:header_params] || {}
|
7588
|
+
# HTTP header 'Accept' (if needed)
|
7589
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
7590
|
+
# HTTP header 'Content-Type'
|
7591
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
7592
|
+
if !content_type.nil?
|
7593
|
+
header_params['Content-Type'] = content_type
|
7594
|
+
end
|
7595
|
+
|
7596
|
+
# form parameters
|
7597
|
+
form_params = opts[:form_params] || {}
|
7598
|
+
|
7599
|
+
# http body (model)
|
7600
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(investments_refresh_request)
|
7601
|
+
|
7602
|
+
# return_type
|
7603
|
+
return_type = opts[:debug_return_type] || 'InvestmentsRefreshResponse'
|
7604
|
+
|
7605
|
+
# auth_names
|
7606
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
7607
|
+
|
7608
|
+
new_options = opts.merge(
|
7609
|
+
:operation => :"PlaidApi.investments_refresh",
|
7610
|
+
:header_params => header_params,
|
7611
|
+
:query_params => query_params,
|
7612
|
+
:form_params => form_params,
|
7613
|
+
:body => post_body,
|
7614
|
+
:auth_names => auth_names,
|
7615
|
+
:return_type => return_type
|
7616
|
+
)
|
7617
|
+
|
7618
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
7619
|
+
if @api_client.config.debugging
|
7620
|
+
@api_client.config.logger.debug "API called: PlaidApi#investments_refresh\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
7621
|
+
end
|
7622
|
+
return data, status_code, headers
|
7623
|
+
end
|
7624
|
+
|
7625
|
+
# Get investment transactions
|
7626
|
+
# The `/investments/transactions/get` endpoint allows developers to retrieve up to 24 months of user-authorized transaction data for investment accounts. Transactions are returned in reverse-chronological order, and the sequence of transaction ordering is stable and will not shift. Due to the potentially large number of investment transactions associated with an Item, results are paginated. Manipulate the count and offset parameters in conjunction with the `total_investment_transactions` response body field to fetch all available investment transactions. Note that Investments does not have a webhook to indicate when initial transaction data has loaded (unless you use the `async_update` option). Instead, if transactions data is not ready when `/investments/transactions/get` is first called, Plaid will wait for the data. For this reason, calling `/investments/transactions/get` immediately after Link may take up to one to two minutes to return. Data returned by the asynchronous investments extraction flow (when `async_update` is set to true) may not be immediately available to `/investments/transactions/get`. To be alerted when the data is ready to be fetched, listen for the `HISTORICAL_UPDATE` webhook. If no investments history is ready when `/investments/transactions/get` is called, it will return a `PRODUCT_NOT_READY` error.
|
7627
|
+
# @param investments_transactions_get_request [InvestmentsTransactionsGetRequest]
|
7628
|
+
# @param [Hash] opts the optional parameters
|
7629
|
+
# @return [InvestmentsTransactionsGetResponse]
|
7630
|
+
def investments_transactions_get(investments_transactions_get_request, opts = {})
|
7631
|
+
data, _status_code, _headers = investments_transactions_get_with_http_info(investments_transactions_get_request, opts)
|
7632
|
+
data
|
7633
|
+
end
|
7634
|
+
|
7635
|
+
# Get investment transactions
|
7636
|
+
# The `/investments/transactions/get` endpoint allows developers to retrieve up to 24 months of user-authorized transaction data for investment accounts. Transactions are returned in reverse-chronological order, and the sequence of transaction ordering is stable and will not shift. Due to the potentially large number of investment transactions associated with an Item, results are paginated. Manipulate the count and offset parameters in conjunction with the `total_investment_transactions` response body field to fetch all available investment transactions. Note that Investments does not have a webhook to indicate when initial transaction data has loaded (unless you use the `async_update` option). Instead, if transactions data is not ready when `/investments/transactions/get` is first called, Plaid will wait for the data. For this reason, calling `/investments/transactions/get` immediately after Link may take up to one to two minutes to return. Data returned by the asynchronous investments extraction flow (when `async_update` is set to true) may not be immediately available to `/investments/transactions/get`. To be alerted when the data is ready to be fetched, listen for the `HISTORICAL_UPDATE` webhook. If no investments history is ready when `/investments/transactions/get` is called, it will return a `PRODUCT_NOT_READY` error.
|
7637
|
+
# @param investments_transactions_get_request [InvestmentsTransactionsGetRequest]
|
7638
|
+
# @param [Hash] opts the optional parameters
|
7639
|
+
# @return [Array<(InvestmentsTransactionsGetResponse, Integer, Hash)>] InvestmentsTransactionsGetResponse data, response status code and response headers
|
7640
|
+
def investments_transactions_get_with_http_info(investments_transactions_get_request, opts = {})
|
7641
|
+
if @api_client.config.debugging
|
7642
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.investments_transactions_get ...'
|
7643
|
+
end
|
7644
|
+
# verify the required parameter 'investments_transactions_get_request' is set
|
7645
|
+
if @api_client.config.client_side_validation && investments_transactions_get_request.nil?
|
7646
|
+
fail ArgumentError, "Missing the required parameter 'investments_transactions_get_request' when calling PlaidApi.investments_transactions_get"
|
7647
|
+
end
|
7648
|
+
# resource path
|
7649
|
+
local_var_path = '/investments/transactions/get'
|
7650
|
+
|
7651
|
+
# query parameters
|
7652
|
+
query_params = opts[:query_params] || {}
|
7653
|
+
|
7654
|
+
# header parameters
|
7655
|
+
header_params = opts[:header_params] || {}
|
7656
|
+
# HTTP header 'Accept' (if needed)
|
7657
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
7658
|
+
# HTTP header 'Content-Type'
|
7659
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
7660
|
+
if !content_type.nil?
|
7661
|
+
header_params['Content-Type'] = content_type
|
7662
|
+
end
|
7663
|
+
|
7664
|
+
# form parameters
|
7665
|
+
form_params = opts[:form_params] || {}
|
7666
|
+
|
7667
|
+
# http body (model)
|
7668
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(investments_transactions_get_request)
|
7669
|
+
|
7670
|
+
# return_type
|
7671
|
+
return_type = opts[:debug_return_type] || 'InvestmentsTransactionsGetResponse'
|
7073
7672
|
|
7074
7673
|
# auth_names
|
7075
7674
|
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
7076
7675
|
|
7077
7676
|
new_options = opts.merge(
|
7078
|
-
:operation => :"PlaidApi.
|
7677
|
+
:operation => :"PlaidApi.investments_transactions_get",
|
7079
7678
|
:header_params => header_params,
|
7080
7679
|
:query_params => query_params,
|
7081
7680
|
:form_params => form_params,
|
@@ -7086,36 +7685,36 @@ module Plaid
|
|
7086
7685
|
|
7087
7686
|
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
7088
7687
|
if @api_client.config.debugging
|
7089
|
-
@api_client.config.logger.debug "API called: PlaidApi#
|
7688
|
+
@api_client.config.logger.debug "API called: PlaidApi#investments_transactions_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
7090
7689
|
end
|
7091
7690
|
return data, status_code, headers
|
7092
7691
|
end
|
7093
7692
|
|
7094
|
-
# Get
|
7095
|
-
#
|
7096
|
-
# @param
|
7693
|
+
# Get an Issue
|
7694
|
+
# Retrieve detailed information about a specific `Issue`. This endpoint returns a single `Issue` object.
|
7695
|
+
# @param issues_get_request [IssuesGetRequest]
|
7097
7696
|
# @param [Hash] opts the optional parameters
|
7098
|
-
# @return [
|
7099
|
-
def
|
7100
|
-
data, _status_code, _headers =
|
7697
|
+
# @return [IssuesGetResponse]
|
7698
|
+
def issues_get(issues_get_request, opts = {})
|
7699
|
+
data, _status_code, _headers = issues_get_with_http_info(issues_get_request, opts)
|
7101
7700
|
data
|
7102
7701
|
end
|
7103
7702
|
|
7104
|
-
# Get
|
7105
|
-
#
|
7106
|
-
# @param
|
7703
|
+
# Get an Issue
|
7704
|
+
# Retrieve detailed information about a specific `Issue`. This endpoint returns a single `Issue` object.
|
7705
|
+
# @param issues_get_request [IssuesGetRequest]
|
7107
7706
|
# @param [Hash] opts the optional parameters
|
7108
|
-
# @return [Array<(
|
7109
|
-
def
|
7707
|
+
# @return [Array<(IssuesGetResponse, Integer, Hash)>] IssuesGetResponse data, response status code and response headers
|
7708
|
+
def issues_get_with_http_info(issues_get_request, opts = {})
|
7110
7709
|
if @api_client.config.debugging
|
7111
|
-
@api_client.config.logger.debug 'Calling API: PlaidApi.
|
7710
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.issues_get ...'
|
7112
7711
|
end
|
7113
|
-
# verify the required parameter '
|
7114
|
-
if @api_client.config.client_side_validation &&
|
7115
|
-
fail ArgumentError, "Missing the required parameter '
|
7712
|
+
# verify the required parameter 'issues_get_request' is set
|
7713
|
+
if @api_client.config.client_side_validation && issues_get_request.nil?
|
7714
|
+
fail ArgumentError, "Missing the required parameter 'issues_get_request' when calling PlaidApi.issues_get"
|
7116
7715
|
end
|
7117
7716
|
# resource path
|
7118
|
-
local_var_path = '/
|
7717
|
+
local_var_path = '/issues/get'
|
7119
7718
|
|
7120
7719
|
# query parameters
|
7121
7720
|
query_params = opts[:query_params] || {}
|
@@ -7134,16 +7733,16 @@ module Plaid
|
|
7134
7733
|
form_params = opts[:form_params] || {}
|
7135
7734
|
|
7136
7735
|
# http body (model)
|
7137
|
-
post_body = opts[:debug_body] || @api_client.object_to_http_body(
|
7736
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(issues_get_request)
|
7138
7737
|
|
7139
7738
|
# return_type
|
7140
|
-
return_type = opts[:debug_return_type] || '
|
7739
|
+
return_type = opts[:debug_return_type] || 'IssuesGetResponse'
|
7141
7740
|
|
7142
7741
|
# auth_names
|
7143
7742
|
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
7144
7743
|
|
7145
7744
|
new_options = opts.merge(
|
7146
|
-
:operation => :"PlaidApi.
|
7745
|
+
:operation => :"PlaidApi.issues_get",
|
7147
7746
|
:header_params => header_params,
|
7148
7747
|
:query_params => query_params,
|
7149
7748
|
:form_params => form_params,
|
@@ -7154,36 +7753,36 @@ module Plaid
|
|
7154
7753
|
|
7155
7754
|
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
7156
7755
|
if @api_client.config.debugging
|
7157
|
-
@api_client.config.logger.debug "API called: PlaidApi#
|
7756
|
+
@api_client.config.logger.debug "API called: PlaidApi#issues_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
7158
7757
|
end
|
7159
7758
|
return data, status_code, headers
|
7160
7759
|
end
|
7161
7760
|
|
7162
|
-
#
|
7163
|
-
#
|
7164
|
-
# @param
|
7761
|
+
# Search for an Issue
|
7762
|
+
# Search for an issue associated with one of the following identifiers: `item_id`, `link_session_id` or Link session `request_id`. This endpoint returns a list of `Issue` objects, with an empty list indicating that no issues are associated with the provided identifier. At least one of the identifiers must be provided to perform the search.
|
7763
|
+
# @param issues_search_request [IssuesSearchRequest]
|
7165
7764
|
# @param [Hash] opts the optional parameters
|
7166
|
-
# @return [
|
7167
|
-
def
|
7168
|
-
data, _status_code, _headers =
|
7765
|
+
# @return [IssuesSearchResponse]
|
7766
|
+
def issues_search(issues_search_request, opts = {})
|
7767
|
+
data, _status_code, _headers = issues_search_with_http_info(issues_search_request, opts)
|
7169
7768
|
data
|
7170
7769
|
end
|
7171
7770
|
|
7172
|
-
#
|
7173
|
-
#
|
7174
|
-
# @param
|
7771
|
+
# Search for an Issue
|
7772
|
+
# Search for an issue associated with one of the following identifiers: `item_id`, `link_session_id` or Link session `request_id`. This endpoint returns a list of `Issue` objects, with an empty list indicating that no issues are associated with the provided identifier. At least one of the identifiers must be provided to perform the search.
|
7773
|
+
# @param issues_search_request [IssuesSearchRequest]
|
7175
7774
|
# @param [Hash] opts the optional parameters
|
7176
|
-
# @return [Array<(
|
7177
|
-
def
|
7775
|
+
# @return [Array<(IssuesSearchResponse, Integer, Hash)>] IssuesSearchResponse data, response status code and response headers
|
7776
|
+
def issues_search_with_http_info(issues_search_request, opts = {})
|
7178
7777
|
if @api_client.config.debugging
|
7179
|
-
@api_client.config.logger.debug 'Calling API: PlaidApi.
|
7778
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.issues_search ...'
|
7180
7779
|
end
|
7181
|
-
# verify the required parameter '
|
7182
|
-
if @api_client.config.client_side_validation &&
|
7183
|
-
fail ArgumentError, "Missing the required parameter '
|
7780
|
+
# verify the required parameter 'issues_search_request' is set
|
7781
|
+
if @api_client.config.client_side_validation && issues_search_request.nil?
|
7782
|
+
fail ArgumentError, "Missing the required parameter 'issues_search_request' when calling PlaidApi.issues_search"
|
7184
7783
|
end
|
7185
7784
|
# resource path
|
7186
|
-
local_var_path = '/
|
7785
|
+
local_var_path = '/issues/search'
|
7187
7786
|
|
7188
7787
|
# query parameters
|
7189
7788
|
query_params = opts[:query_params] || {}
|
@@ -7202,16 +7801,16 @@ module Plaid
|
|
7202
7801
|
form_params = opts[:form_params] || {}
|
7203
7802
|
|
7204
7803
|
# http body (model)
|
7205
|
-
post_body = opts[:debug_body] || @api_client.object_to_http_body(
|
7804
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(issues_search_request)
|
7206
7805
|
|
7207
7806
|
# return_type
|
7208
|
-
return_type = opts[:debug_return_type] || '
|
7807
|
+
return_type = opts[:debug_return_type] || 'IssuesSearchResponse'
|
7209
7808
|
|
7210
7809
|
# auth_names
|
7211
7810
|
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
7212
7811
|
|
7213
7812
|
new_options = opts.merge(
|
7214
|
-
:operation => :"PlaidApi.
|
7813
|
+
:operation => :"PlaidApi.issues_search",
|
7215
7814
|
:header_params => header_params,
|
7216
7815
|
:query_params => query_params,
|
7217
7816
|
:form_params => form_params,
|
@@ -7222,36 +7821,36 @@ module Plaid
|
|
7222
7821
|
|
7223
7822
|
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
7224
7823
|
if @api_client.config.debugging
|
7225
|
-
@api_client.config.logger.debug "API called: PlaidApi#
|
7824
|
+
@api_client.config.logger.debug "API called: PlaidApi#issues_search\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
7226
7825
|
end
|
7227
7826
|
return data, status_code, headers
|
7228
7827
|
end
|
7229
7828
|
|
7230
|
-
#
|
7231
|
-
#
|
7232
|
-
# @param
|
7829
|
+
# Subscribe to an Issue
|
7830
|
+
# Allows a user to subscribe to updates on a specific `Issue` using a POST method. Subscribers will receive webhook notifications when the issue status changes, particularly when resolved.
|
7831
|
+
# @param issues_subscribe_request [IssuesSubscribeRequest]
|
7233
7832
|
# @param [Hash] opts the optional parameters
|
7234
|
-
# @return [
|
7235
|
-
def
|
7236
|
-
data, _status_code, _headers =
|
7833
|
+
# @return [IssuesSubscribeResponse]
|
7834
|
+
def issues_subscribe(issues_subscribe_request, opts = {})
|
7835
|
+
data, _status_code, _headers = issues_subscribe_with_http_info(issues_subscribe_request, opts)
|
7237
7836
|
data
|
7238
7837
|
end
|
7239
7838
|
|
7240
|
-
#
|
7241
|
-
#
|
7242
|
-
# @param
|
7839
|
+
# Subscribe to an Issue
|
7840
|
+
# Allows a user to subscribe to updates on a specific `Issue` using a POST method. Subscribers will receive webhook notifications when the issue status changes, particularly when resolved.
|
7841
|
+
# @param issues_subscribe_request [IssuesSubscribeRequest]
|
7243
7842
|
# @param [Hash] opts the optional parameters
|
7244
|
-
# @return [Array<(
|
7245
|
-
def
|
7843
|
+
# @return [Array<(IssuesSubscribeResponse, Integer, Hash)>] IssuesSubscribeResponse data, response status code and response headers
|
7844
|
+
def issues_subscribe_with_http_info(issues_subscribe_request, opts = {})
|
7246
7845
|
if @api_client.config.debugging
|
7247
|
-
@api_client.config.logger.debug 'Calling API: PlaidApi.
|
7846
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.issues_subscribe ...'
|
7248
7847
|
end
|
7249
|
-
# verify the required parameter '
|
7250
|
-
if @api_client.config.client_side_validation &&
|
7251
|
-
fail ArgumentError, "Missing the required parameter '
|
7848
|
+
# verify the required parameter 'issues_subscribe_request' is set
|
7849
|
+
if @api_client.config.client_side_validation && issues_subscribe_request.nil?
|
7850
|
+
fail ArgumentError, "Missing the required parameter 'issues_subscribe_request' when calling PlaidApi.issues_subscribe"
|
7252
7851
|
end
|
7253
7852
|
# resource path
|
7254
|
-
local_var_path = '/
|
7853
|
+
local_var_path = '/issues/subscribe'
|
7255
7854
|
|
7256
7855
|
# query parameters
|
7257
7856
|
query_params = opts[:query_params] || {}
|
@@ -7270,16 +7869,16 @@ module Plaid
|
|
7270
7869
|
form_params = opts[:form_params] || {}
|
7271
7870
|
|
7272
7871
|
# http body (model)
|
7273
|
-
post_body = opts[:debug_body] || @api_client.object_to_http_body(
|
7872
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(issues_subscribe_request)
|
7274
7873
|
|
7275
7874
|
# return_type
|
7276
|
-
return_type = opts[:debug_return_type] || '
|
7875
|
+
return_type = opts[:debug_return_type] || 'IssuesSubscribeResponse'
|
7277
7876
|
|
7278
7877
|
# auth_names
|
7279
7878
|
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
7280
7879
|
|
7281
7880
|
new_options = opts.merge(
|
7282
|
-
:operation => :"PlaidApi.
|
7881
|
+
:operation => :"PlaidApi.issues_subscribe",
|
7283
7882
|
:header_params => header_params,
|
7284
7883
|
:query_params => query_params,
|
7285
7884
|
:form_params => form_params,
|
@@ -7290,7 +7889,7 @@ module Plaid
|
|
7290
7889
|
|
7291
7890
|
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
7292
7891
|
if @api_client.config.debugging
|
7293
|
-
@api_client.config.logger.debug "API called: PlaidApi#
|
7892
|
+
@api_client.config.logger.debug "API called: PlaidApi#issues_subscribe\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
7294
7893
|
end
|
7295
7894
|
return data, status_code, headers
|
7296
7895
|
end
|
@@ -8044,7 +8643,7 @@ module Plaid
|
|
8044
8643
|
end
|
8045
8644
|
|
8046
8645
|
# 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/
|
8646
|
+
# 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
8647
|
# @param liabilities_get_request [LiabilitiesGetRequest]
|
8049
8648
|
# @param [Hash] opts the optional parameters
|
8050
8649
|
# @return [LiabilitiesGetResponse]
|
@@ -8054,7 +8653,7 @@ module Plaid
|
|
8054
8653
|
end
|
8055
8654
|
|
8056
8655
|
# 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/
|
8656
|
+
# 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
8657
|
# @param liabilities_get_request [LiabilitiesGetRequest]
|
8059
8658
|
# @param [Hash] opts the optional parameters
|
8060
8659
|
# @return [Array<(LiabilitiesGetResponse, Integer, Hash)>] LiabilitiesGetResponse data, response status code and response headers
|
@@ -8452,7 +9051,7 @@ module Plaid
|
|
8452
9051
|
end
|
8453
9052
|
|
8454
9053
|
# Get Link Token
|
8455
|
-
# The `/link/token/get` endpoint gets information about a
|
9054
|
+
# 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
9055
|
# @param link_token_get_request [LinkTokenGetRequest]
|
8457
9056
|
# @param [Hash] opts the optional parameters
|
8458
9057
|
# @return [LinkTokenGetResponse]
|
@@ -8462,7 +9061,7 @@ module Plaid
|
|
8462
9061
|
end
|
8463
9062
|
|
8464
9063
|
# Get Link Token
|
8465
|
-
# The `/link/token/get` endpoint gets information about a
|
9064
|
+
# 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
9065
|
# @param link_token_get_request [LinkTokenGetRequest]
|
8467
9066
|
# @param [Hash] opts the optional parameters
|
8468
9067
|
# @return [Array<(LinkTokenGetResponse, Integer, Hash)>] LinkTokenGetResponse data, response status code and response headers
|
@@ -8519,6 +9118,74 @@ module Plaid
|
|
8519
9118
|
return data, status_code, headers
|
8520
9119
|
end
|
8521
9120
|
|
9121
|
+
# Retrieve network insights for the provided `access_tokens`
|
9122
|
+
# This endpoint allows you to retrieve the Network Insights from a list of `access_tokens`.
|
9123
|
+
# @param network_insights_report_get_request [NetworkInsightsReportGetRequest]
|
9124
|
+
# @param [Hash] opts the optional parameters
|
9125
|
+
# @return [NetworkInsightsReportGetResponse]
|
9126
|
+
def network_insights_report_get(network_insights_report_get_request, opts = {})
|
9127
|
+
data, _status_code, _headers = network_insights_report_get_with_http_info(network_insights_report_get_request, opts)
|
9128
|
+
data
|
9129
|
+
end
|
9130
|
+
|
9131
|
+
# Retrieve network insights for the provided `access_tokens`
|
9132
|
+
# This endpoint allows you to retrieve the Network Insights from a list of `access_tokens`.
|
9133
|
+
# @param network_insights_report_get_request [NetworkInsightsReportGetRequest]
|
9134
|
+
# @param [Hash] opts the optional parameters
|
9135
|
+
# @return [Array<(NetworkInsightsReportGetResponse, Integer, Hash)>] NetworkInsightsReportGetResponse data, response status code and response headers
|
9136
|
+
def network_insights_report_get_with_http_info(network_insights_report_get_request, opts = {})
|
9137
|
+
if @api_client.config.debugging
|
9138
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.network_insights_report_get ...'
|
9139
|
+
end
|
9140
|
+
# verify the required parameter 'network_insights_report_get_request' is set
|
9141
|
+
if @api_client.config.client_side_validation && network_insights_report_get_request.nil?
|
9142
|
+
fail ArgumentError, "Missing the required parameter 'network_insights_report_get_request' when calling PlaidApi.network_insights_report_get"
|
9143
|
+
end
|
9144
|
+
# resource path
|
9145
|
+
local_var_path = '/network_insights/report/get'
|
9146
|
+
|
9147
|
+
# query parameters
|
9148
|
+
query_params = opts[:query_params] || {}
|
9149
|
+
|
9150
|
+
# header parameters
|
9151
|
+
header_params = opts[:header_params] || {}
|
9152
|
+
# HTTP header 'Accept' (if needed)
|
9153
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
9154
|
+
# HTTP header 'Content-Type'
|
9155
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
9156
|
+
if !content_type.nil?
|
9157
|
+
header_params['Content-Type'] = content_type
|
9158
|
+
end
|
9159
|
+
|
9160
|
+
# form parameters
|
9161
|
+
form_params = opts[:form_params] || {}
|
9162
|
+
|
9163
|
+
# http body (model)
|
9164
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(network_insights_report_get_request)
|
9165
|
+
|
9166
|
+
# return_type
|
9167
|
+
return_type = opts[:debug_return_type] || 'NetworkInsightsReportGetResponse'
|
9168
|
+
|
9169
|
+
# auth_names
|
9170
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
9171
|
+
|
9172
|
+
new_options = opts.merge(
|
9173
|
+
:operation => :"PlaidApi.network_insights_report_get",
|
9174
|
+
:header_params => header_params,
|
9175
|
+
:query_params => query_params,
|
9176
|
+
:form_params => form_params,
|
9177
|
+
:body => post_body,
|
9178
|
+
:auth_names => auth_names,
|
9179
|
+
:return_type => return_type
|
9180
|
+
)
|
9181
|
+
|
9182
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
9183
|
+
if @api_client.config.debugging
|
9184
|
+
@api_client.config.logger.debug "API called: PlaidApi#network_insights_report_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
9185
|
+
end
|
9186
|
+
return data, status_code, headers
|
9187
|
+
end
|
9188
|
+
|
8522
9189
|
# Creates a new end customer for a Plaid reseller.
|
8523
9190
|
# The `/partner/customer/create` endpoint is used by reseller partners to create end customers.
|
8524
9191
|
# @param partner_customer_create_request [PartnerCustomerCreateRequest]
|
@@ -9132,7 +9799,7 @@ module Plaid
|
|
9132
9799
|
end
|
9133
9800
|
|
9134
9801
|
# Create a payment
|
9135
|
-
# After creating a payment recipient, you can use the `/payment_initiation/payment/create` endpoint to create a payment to that recipient. Payments can be one-time or standing order (recurring) and can be denominated in either EUR, GBP or other chosen [currency](https://plaid.com/docs/api/products/payment-initiation/#payment_initiation-payment-create-request-amount-currency). If making domestic GBP-denominated payments, your recipient must have been created with BACS numbers. In general, EUR-denominated payments will be sent via SEPA Credit Transfer, GBP-denominated payments will be sent via the Faster Payments network and for non-Eurozone markets typically via the local payment scheme, but the payment network used will be determined by the institution. Payments sent via Faster Payments will typically arrive immediately, while payments sent via SEPA Credit Transfer or other local payment schemes will typically arrive in one business day. Standing orders (recurring payments) must be denominated in GBP and can only be sent to recipients in the UK. Once created, standing order payments cannot be modified or canceled via the API. An end user can cancel or modify a standing order directly on their banking application or website, or by contacting the bank. Standing orders will follow the payment rules of the underlying rails (Faster Payments in UK). Payments can be sent Monday to Friday, excluding bank holidays. If the pre-arranged date falls on a weekend or bank holiday, the payment is made on the next working day. It is not possible to guarantee the exact time the payment will reach the recipient’s account, although at least 90% of standing order payments are sent by 6am. In Limited Production, payments must be below 5 GBP or other chosen [currency](https://plaid.com/docs/api/products/payment-initiation/#payment_initiation-payment-create-request-amount-currency), and standing orders, variable recurring payments, and Virtual Accounts are not supported.
|
9802
|
+
# After creating a payment recipient, you can use the `/payment_initiation/payment/create` endpoint to create a payment to that recipient. Payments can be one-time or standing order (recurring) and can be denominated in either EUR, GBP or other chosen [currency](https://plaid.com/docs/api/products/payment-initiation/#payment_initiation-payment-create-request-amount-currency). If making domestic GBP-denominated payments, your recipient must have been created with BACS numbers. In general, EUR-denominated payments will be sent via SEPA Credit Transfer, GBP-denominated payments will be sent via the Faster Payments network and for non-Eurozone markets typically via the local payment scheme, but the payment network used will be determined by the institution. Payments sent via Faster Payments will typically arrive immediately, while payments sent via SEPA Credit Transfer or other local payment schemes will typically arrive in one business day. Standing orders (recurring payments) must be denominated in GBP and can only be sent to recipients in the UK. Once created, standing order payments cannot be modified or canceled via the API. An end user can cancel or modify a standing order directly on their banking application or website, or by contacting the bank. Standing orders will follow the payment rules of the underlying rails (Faster Payments in UK). Payments can be sent Monday to Friday, excluding bank holidays. If the pre-arranged date falls on a weekend or bank holiday, the payment is made on the next working day. It is not possible to guarantee the exact time the payment will reach the recipient’s account, although at least 90% of standing order payments are sent by 6am. In Limited Production, payments must be below 5 GBP or other chosen [currency](https://plaid.com/docs/api/products/payment-initiation/#payment_initiation-payment-create-request-amount-currency), and standing orders, variable recurring payments, and Virtual Accounts are not supported.
|
9136
9803
|
# @param payment_initiation_payment_create_request [PaymentInitiationPaymentCreateRequest]
|
9137
9804
|
# @param [Hash] opts the optional parameters
|
9138
9805
|
# @return [PaymentInitiationPaymentCreateResponse]
|
@@ -9142,7 +9809,7 @@ module Plaid
|
|
9142
9809
|
end
|
9143
9810
|
|
9144
9811
|
# Create a payment
|
9145
|
-
# After creating a payment recipient, you can use the `/payment_initiation/payment/create` endpoint to create a payment to that recipient. Payments can be one-time or standing order (recurring) and can be denominated in either EUR, GBP or other chosen [currency](https://plaid.com/docs/api/products/payment-initiation/#payment_initiation-payment-create-request-amount-currency). If making domestic GBP-denominated payments, your recipient must have been created with BACS numbers. In general, EUR-denominated payments will be sent via SEPA Credit Transfer, GBP-denominated payments will be sent via the Faster Payments network and for non-Eurozone markets typically via the local payment scheme, but the payment network used will be determined by the institution. Payments sent via Faster Payments will typically arrive immediately, while payments sent via SEPA Credit Transfer or other local payment schemes will typically arrive in one business day. Standing orders (recurring payments) must be denominated in GBP and can only be sent to recipients in the UK. Once created, standing order payments cannot be modified or canceled via the API. An end user can cancel or modify a standing order directly on their banking application or website, or by contacting the bank. Standing orders will follow the payment rules of the underlying rails (Faster Payments in UK). Payments can be sent Monday to Friday, excluding bank holidays. If the pre-arranged date falls on a weekend or bank holiday, the payment is made on the next working day. It is not possible to guarantee the exact time the payment will reach the recipient’s account, although at least 90% of standing order payments are sent by 6am. In Limited Production, payments must be below 5 GBP or other chosen [currency](https://plaid.com/docs/api/products/payment-initiation/#payment_initiation-payment-create-request-amount-currency), and standing orders, variable recurring payments, and Virtual Accounts are not supported.
|
9812
|
+
# After creating a payment recipient, you can use the `/payment_initiation/payment/create` endpoint to create a payment to that recipient. Payments can be one-time or standing order (recurring) and can be denominated in either EUR, GBP or other chosen [currency](https://plaid.com/docs/api/products/payment-initiation/#payment_initiation-payment-create-request-amount-currency). If making domestic GBP-denominated payments, your recipient must have been created with BACS numbers. In general, EUR-denominated payments will be sent via SEPA Credit Transfer, GBP-denominated payments will be sent via the Faster Payments network and for non-Eurozone markets typically via the local payment scheme, but the payment network used will be determined by the institution. Payments sent via Faster Payments will typically arrive immediately, while payments sent via SEPA Credit Transfer or other local payment schemes will typically arrive in one business day. Standing orders (recurring payments) must be denominated in GBP and can only be sent to recipients in the UK. Once created, standing order payments cannot be modified or canceled via the API. An end user can cancel or modify a standing order directly on their banking application or website, or by contacting the bank. Standing orders will follow the payment rules of the underlying rails (Faster Payments in UK). Payments can be sent Monday to Friday, excluding bank holidays. If the pre-arranged date falls on a weekend or bank holiday, the payment is made on the next working day. It is not possible to guarantee the exact time the payment will reach the recipient’s account, although at least 90% of standing order payments are sent by 6am. In Limited Production, payments must be below 5 GBP or other chosen [currency](https://plaid.com/docs/api/products/payment-initiation/#payment_initiation-payment-create-request-amount-currency), and standing orders, variable recurring payments, and Virtual Accounts are not supported.
|
9146
9813
|
# @param payment_initiation_payment_create_request [PaymentInitiationPaymentCreateRequest]
|
9147
9814
|
# @param [Hash] opts the optional parameters
|
9148
9815
|
# @return [Array<(PaymentInitiationPaymentCreateResponse, Integer, Hash)>] PaymentInitiationPaymentCreateResponse data, response status code and response headers
|
@@ -10220,7 +10887,7 @@ module Plaid
|
|
10220
10887
|
end
|
10221
10888
|
|
10222
10889
|
# 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.
|
10890
|
+
# 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
10891
|
# @param processor_identity_match_request [ProcessorIdentityMatchRequest]
|
10225
10892
|
# @param [Hash] opts the optional parameters
|
10226
10893
|
# @return [ProcessorIdentityMatchResponse]
|
@@ -10230,7 +10897,7 @@ module Plaid
|
|
10230
10897
|
end
|
10231
10898
|
|
10232
10899
|
# 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.
|
10900
|
+
# 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
10901
|
# @param processor_identity_match_request [ProcessorIdentityMatchRequest]
|
10235
10902
|
# @param [Hash] opts the optional parameters
|
10236
10903
|
# @return [Array<(ProcessorIdentityMatchResponse, Integer, Hash)>] ProcessorIdentityMatchResponse data, response status code and response headers
|
@@ -11307,6 +11974,74 @@ module Plaid
|
|
11307
11974
|
return data, status_code, headers
|
11308
11975
|
end
|
11309
11976
|
|
11977
|
+
# Check a user's Plaid Network status
|
11978
|
+
# The `/profile/network_status/get` endpoint can be used to check whether Plaid has a matching profile for the user.
|
11979
|
+
# @param profile_network_status_get_request [ProfileNetworkStatusGetRequest]
|
11980
|
+
# @param [Hash] opts the optional parameters
|
11981
|
+
# @return [ProfileNetworkStatusGetResponse]
|
11982
|
+
def profile_network_status_get(profile_network_status_get_request, opts = {})
|
11983
|
+
data, _status_code, _headers = profile_network_status_get_with_http_info(profile_network_status_get_request, opts)
|
11984
|
+
data
|
11985
|
+
end
|
11986
|
+
|
11987
|
+
# Check a user's Plaid Network status
|
11988
|
+
# The `/profile/network_status/get` endpoint can be used to check whether Plaid has a matching profile for the user.
|
11989
|
+
# @param profile_network_status_get_request [ProfileNetworkStatusGetRequest]
|
11990
|
+
# @param [Hash] opts the optional parameters
|
11991
|
+
# @return [Array<(ProfileNetworkStatusGetResponse, Integer, Hash)>] ProfileNetworkStatusGetResponse data, response status code and response headers
|
11992
|
+
def profile_network_status_get_with_http_info(profile_network_status_get_request, opts = {})
|
11993
|
+
if @api_client.config.debugging
|
11994
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.profile_network_status_get ...'
|
11995
|
+
end
|
11996
|
+
# verify the required parameter 'profile_network_status_get_request' is set
|
11997
|
+
if @api_client.config.client_side_validation && profile_network_status_get_request.nil?
|
11998
|
+
fail ArgumentError, "Missing the required parameter 'profile_network_status_get_request' when calling PlaidApi.profile_network_status_get"
|
11999
|
+
end
|
12000
|
+
# resource path
|
12001
|
+
local_var_path = '/profile/network_status/get'
|
12002
|
+
|
12003
|
+
# query parameters
|
12004
|
+
query_params = opts[:query_params] || {}
|
12005
|
+
|
12006
|
+
# header parameters
|
12007
|
+
header_params = opts[:header_params] || {}
|
12008
|
+
# HTTP header 'Accept' (if needed)
|
12009
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
12010
|
+
# HTTP header 'Content-Type'
|
12011
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
12012
|
+
if !content_type.nil?
|
12013
|
+
header_params['Content-Type'] = content_type
|
12014
|
+
end
|
12015
|
+
|
12016
|
+
# form parameters
|
12017
|
+
form_params = opts[:form_params] || {}
|
12018
|
+
|
12019
|
+
# http body (model)
|
12020
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(profile_network_status_get_request)
|
12021
|
+
|
12022
|
+
# return_type
|
12023
|
+
return_type = opts[:debug_return_type] || 'ProfileNetworkStatusGetResponse'
|
12024
|
+
|
12025
|
+
# auth_names
|
12026
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
12027
|
+
|
12028
|
+
new_options = opts.merge(
|
12029
|
+
:operation => :"PlaidApi.profile_network_status_get",
|
12030
|
+
:header_params => header_params,
|
12031
|
+
:query_params => query_params,
|
12032
|
+
:form_params => form_params,
|
12033
|
+
:body => post_body,
|
12034
|
+
:auth_names => auth_names,
|
12035
|
+
:return_type => return_type
|
12036
|
+
)
|
12037
|
+
|
12038
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
12039
|
+
if @api_client.config.debugging
|
12040
|
+
@api_client.config.logger.debug "API called: PlaidApi#profile_network_status_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
12041
|
+
end
|
12042
|
+
return data, status_code, headers
|
12043
|
+
end
|
12044
|
+
|
11310
12045
|
# Manually fire a bank income webhook in sandbox
|
11311
12046
|
# Use the `/sandbox/bank_income/fire_webhook` endpoint to manually trigger a Bank Income webhook in the Sandbox environment.
|
11312
12047
|
# @param sandbox_bank_income_fire_webhook_request [SandboxBankIncomeFireWebhookRequest]
|
@@ -11580,7 +12315,7 @@ module Plaid
|
|
11580
12315
|
end
|
11581
12316
|
|
11582
12317
|
# 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`:
|
12318
|
+
# 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
12319
|
# @param sandbox_item_fire_webhook_request [SandboxItemFireWebhookRequest]
|
11585
12320
|
# @param [Hash] opts the optional parameters
|
11586
12321
|
# @return [SandboxItemFireWebhookResponse]
|
@@ -11590,7 +12325,7 @@ module Plaid
|
|
11590
12325
|
end
|
11591
12326
|
|
11592
12327
|
# 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`:
|
12328
|
+
# 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
12329
|
# @param sandbox_item_fire_webhook_request [SandboxItemFireWebhookRequest]
|
11595
12330
|
# @param [Hash] opts the optional parameters
|
11596
12331
|
# @return [Array<(SandboxItemFireWebhookResponse, Integer, Hash)>] SandboxItemFireWebhookResponse data, response status code and response headers
|
@@ -11988,7 +12723,7 @@ module Plaid
|
|
11988
12723
|
end
|
11989
12724
|
|
11990
12725
|
# 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
|
12726
|
+
# 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
12727
|
# @param sandbox_public_token_create_request [SandboxPublicTokenCreateRequest]
|
11993
12728
|
# @param [Hash] opts the optional parameters
|
11994
12729
|
# @return [SandboxPublicTokenCreateResponse]
|
@@ -11998,7 +12733,7 @@ module Plaid
|
|
11998
12733
|
end
|
11999
12734
|
|
12000
12735
|
# 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
|
12736
|
+
# 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
12737
|
# @param sandbox_public_token_create_request [SandboxPublicTokenCreateRequest]
|
12003
12738
|
# @param [Hash] opts the optional parameters
|
12004
12739
|
# @return [Array<(SandboxPublicTokenCreateResponse, Integer, Hash)>] SandboxPublicTokenCreateResponse data, response status code and response headers
|
@@ -13620,7 +14355,7 @@ module Plaid
|
|
13620
14355
|
end
|
13621
14356
|
|
13622
14357
|
# 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`).
|
14358
|
+
# 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
14359
|
# @param transactions_recurring_get_request [TransactionsRecurringGetRequest]
|
13625
14360
|
# @param [Hash] opts the optional parameters
|
13626
14361
|
# @return [TransactionsRecurringGetResponse]
|
@@ -13630,7 +14365,7 @@ module Plaid
|
|
13630
14365
|
end
|
13631
14366
|
|
13632
14367
|
# 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`).
|
14368
|
+
# 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
14369
|
# @param transactions_recurring_get_request [TransactionsRecurringGetRequest]
|
13635
14370
|
# @param [Hash] opts the optional parameters
|
13636
14371
|
# @return [Array<(TransactionsRecurringGetResponse, Integer, Hash)>] TransactionsRecurringGetResponse data, response status code and response headers
|
@@ -14164,7 +14899,7 @@ module Plaid
|
|
14164
14899
|
end
|
14165
14900
|
|
14166
14901
|
# 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`.
|
14902
|
+
# 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
14903
|
# @param transfer_authorization_create_request [TransferAuthorizationCreateRequest]
|
14169
14904
|
# @param [Hash] opts the optional parameters
|
14170
14905
|
# @return [TransferAuthorizationCreateResponse]
|
@@ -14174,7 +14909,7 @@ module Plaid
|
|
14174
14909
|
end
|
14175
14910
|
|
14176
14911
|
# 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`.
|
14912
|
+
# 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
14913
|
# @param transfer_authorization_create_request [TransferAuthorizationCreateRequest]
|
14179
14914
|
# @param [Hash] opts the optional parameters
|
14180
14915
|
# @return [Array<(TransferAuthorizationCreateResponse, Integer, Hash)>] TransferAuthorizationCreateResponse data, response status code and response headers
|
@@ -14368,7 +15103,7 @@ module Plaid
|
|
14368
15103
|
end
|
14369
15104
|
|
14370
15105
|
# Get RTP eligibility information of a transfer
|
14371
|
-
# Use the `/transfer/capabilities/get` endpoint to determine the RTP eligibility information of
|
15106
|
+
# Use the `/transfer/capabilities/get` endpoint to determine the RTP eligibility information of an account to be used with Transfer. This endpoint works on all Transfer-capable Items, including those created by `/transfer/migrate_account`. To simulate RTP eligibility in Sandbox, log in using the username `user_good` and password `pass_good` and use the first two checking and savings accounts in the \"First Platypus Bank\" institution (ending in 0000 or 1111), which will return `true`. Any other account will return `false`.
|
14372
15107
|
# @param transfer_capabilities_get_request [TransferCapabilitiesGetRequest]
|
14373
15108
|
# @param [Hash] opts the optional parameters
|
14374
15109
|
# @return [TransferCapabilitiesGetResponse]
|
@@ -14378,7 +15113,7 @@ module Plaid
|
|
14378
15113
|
end
|
14379
15114
|
|
14380
15115
|
# Get RTP eligibility information of a transfer
|
14381
|
-
# Use the `/transfer/capabilities/get` endpoint to determine the RTP eligibility information of
|
15116
|
+
# Use the `/transfer/capabilities/get` endpoint to determine the RTP eligibility information of an account to be used with Transfer. This endpoint works on all Transfer-capable Items, including those created by `/transfer/migrate_account`. To simulate RTP eligibility in Sandbox, log in using the username `user_good` and password `pass_good` and use the first two checking and savings accounts in the \"First Platypus Bank\" institution (ending in 0000 or 1111), which will return `true`. Any other account will return `false`.
|
14382
15117
|
# @param transfer_capabilities_get_request [TransferCapabilitiesGetRequest]
|
14383
15118
|
# @param [Hash] opts the optional parameters
|
14384
15119
|
# @return [Array<(TransferCapabilitiesGetResponse, Integer, Hash)>] TransferCapabilitiesGetResponse data, response status code and response headers
|
@@ -14504,7 +15239,7 @@ module Plaid
|
|
14504
15239
|
end
|
14505
15240
|
|
14506
15241
|
# Create a transfer
|
14507
|
-
# Use the `/transfer/create` endpoint to initiate a new transfer.
|
15242
|
+
# 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
15243
|
# @param transfer_create_request [TransferCreateRequest]
|
14509
15244
|
# @param [Hash] opts the optional parameters
|
14510
15245
|
# @return [TransferCreateResponse]
|
@@ -14514,7 +15249,7 @@ module Plaid
|
|
14514
15249
|
end
|
14515
15250
|
|
14516
15251
|
# Create a transfer
|
14517
|
-
# Use the `/transfer/create` endpoint to initiate a new transfer.
|
15252
|
+
# 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
15253
|
# @param transfer_create_request [TransferCreateRequest]
|
14519
15254
|
# @param [Hash] opts the optional parameters
|
14520
15255
|
# @return [Array<(TransferCreateResponse, Integer, Hash)>] TransferCreateResponse data, response status code and response headers
|
@@ -14844,7 +15579,7 @@ module Plaid
|
|
14844
15579
|
end
|
14845
15580
|
|
14846
15581
|
# Retrieve a transfer
|
14847
|
-
# The `/transfer/get` endpoint fetches information about the transfer corresponding to the given `transfer_id`.
|
15582
|
+
# The `/transfer/get` endpoint fetches information about the transfer corresponding to the given `transfer_id` or `authorization_id`. One of `transfer_id` or `authorization_id` must be populated but not both.
|
14848
15583
|
# @param transfer_get_request [TransferGetRequest]
|
14849
15584
|
# @param [Hash] opts the optional parameters
|
14850
15585
|
# @return [TransferGetResponse]
|
@@ -14854,7 +15589,7 @@ module Plaid
|
|
14854
15589
|
end
|
14855
15590
|
|
14856
15591
|
# Retrieve a transfer
|
14857
|
-
# The `/transfer/get` endpoint fetches information about the transfer corresponding to the given `transfer_id`.
|
15592
|
+
# The `/transfer/get` endpoint fetches information about the transfer corresponding to the given `transfer_id` or `authorization_id`. One of `transfer_id` or `authorization_id` must be populated but not both.
|
14858
15593
|
# @param transfer_get_request [TransferGetRequest]
|
14859
15594
|
# @param [Hash] opts the optional parameters
|
14860
15595
|
# @return [Array<(TransferGetResponse, Integer, Hash)>] TransferGetResponse data, response status code and response headers
|
@@ -15456,7 +16191,7 @@ module Plaid
|
|
15456
16191
|
end
|
15457
16192
|
|
15458
16193
|
# 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.
|
16194
|
+
# 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
16195
|
# @param transfer_migrate_account_request [TransferMigrateAccountRequest]
|
15461
16196
|
# @param [Hash] opts the optional parameters
|
15462
16197
|
# @return [TransferMigrateAccountResponse]
|
@@ -15466,7 +16201,7 @@ module Plaid
|
|
15466
16201
|
end
|
15467
16202
|
|
15468
16203
|
# 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.
|
16204
|
+
# 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
16205
|
# @param transfer_migrate_account_request [TransferMigrateAccountRequest]
|
15471
16206
|
# @param [Hash] opts the optional parameters
|
15472
16207
|
# @return [Array<(TransferMigrateAccountResponse, Integer, Hash)>] TransferMigrateAccountResponse data, response status code and response headers
|
@@ -15795,6 +16530,142 @@ module Plaid
|
|
15795
16530
|
return data, status_code, headers
|
15796
16531
|
end
|
15797
16532
|
|
16533
|
+
# Create an originator for scaled platform customers
|
16534
|
+
# 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.
|
16535
|
+
# @param transfer_platform_originator_create_request [TransferPlatformOriginatorCreateRequest]
|
16536
|
+
# @param [Hash] opts the optional parameters
|
16537
|
+
# @return [TransferPlatformOriginatorCreateResponse]
|
16538
|
+
def transfer_platform_originator_create(transfer_platform_originator_create_request, opts = {})
|
16539
|
+
data, _status_code, _headers = transfer_platform_originator_create_with_http_info(transfer_platform_originator_create_request, opts)
|
16540
|
+
data
|
16541
|
+
end
|
16542
|
+
|
16543
|
+
# Create an originator for scaled platform customers
|
16544
|
+
# 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.
|
16545
|
+
# @param transfer_platform_originator_create_request [TransferPlatformOriginatorCreateRequest]
|
16546
|
+
# @param [Hash] opts the optional parameters
|
16547
|
+
# @return [Array<(TransferPlatformOriginatorCreateResponse, Integer, Hash)>] TransferPlatformOriginatorCreateResponse data, response status code and response headers
|
16548
|
+
def transfer_platform_originator_create_with_http_info(transfer_platform_originator_create_request, opts = {})
|
16549
|
+
if @api_client.config.debugging
|
16550
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.transfer_platform_originator_create ...'
|
16551
|
+
end
|
16552
|
+
# verify the required parameter 'transfer_platform_originator_create_request' is set
|
16553
|
+
if @api_client.config.client_side_validation && transfer_platform_originator_create_request.nil?
|
16554
|
+
fail ArgumentError, "Missing the required parameter 'transfer_platform_originator_create_request' when calling PlaidApi.transfer_platform_originator_create"
|
16555
|
+
end
|
16556
|
+
# resource path
|
16557
|
+
local_var_path = '/transfer/platform/originator/create'
|
16558
|
+
|
16559
|
+
# query parameters
|
16560
|
+
query_params = opts[:query_params] || {}
|
16561
|
+
|
16562
|
+
# header parameters
|
16563
|
+
header_params = opts[:header_params] || {}
|
16564
|
+
# HTTP header 'Accept' (if needed)
|
16565
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
16566
|
+
# HTTP header 'Content-Type'
|
16567
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
16568
|
+
if !content_type.nil?
|
16569
|
+
header_params['Content-Type'] = content_type
|
16570
|
+
end
|
16571
|
+
|
16572
|
+
# form parameters
|
16573
|
+
form_params = opts[:form_params] || {}
|
16574
|
+
|
16575
|
+
# http body (model)
|
16576
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(transfer_platform_originator_create_request)
|
16577
|
+
|
16578
|
+
# return_type
|
16579
|
+
return_type = opts[:debug_return_type] || 'TransferPlatformOriginatorCreateResponse'
|
16580
|
+
|
16581
|
+
# auth_names
|
16582
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
16583
|
+
|
16584
|
+
new_options = opts.merge(
|
16585
|
+
:operation => :"PlaidApi.transfer_platform_originator_create",
|
16586
|
+
:header_params => header_params,
|
16587
|
+
:query_params => query_params,
|
16588
|
+
:form_params => form_params,
|
16589
|
+
:body => post_body,
|
16590
|
+
:auth_names => auth_names,
|
16591
|
+
:return_type => return_type
|
16592
|
+
)
|
16593
|
+
|
16594
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
16595
|
+
if @api_client.config.debugging
|
16596
|
+
@api_client.config.logger.debug "API called: PlaidApi#transfer_platform_originator_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
16597
|
+
end
|
16598
|
+
return data, status_code, headers
|
16599
|
+
end
|
16600
|
+
|
16601
|
+
# Submit onboarding requirements for Scaled Platform originators
|
16602
|
+
# The `/transfer/platform/requirement/submit` endpoint allows platforms to submit onboarding requirements for an originator as part of the Scaled Platform Transfer offering.
|
16603
|
+
# @param transfer_platform_requirement_submit_request [TransferPlatformRequirementSubmitRequest]
|
16604
|
+
# @param [Hash] opts the optional parameters
|
16605
|
+
# @return [TransferPlatformRequirementSubmitResponse]
|
16606
|
+
def transfer_platform_requirement_submit(transfer_platform_requirement_submit_request, opts = {})
|
16607
|
+
data, _status_code, _headers = transfer_platform_requirement_submit_with_http_info(transfer_platform_requirement_submit_request, opts)
|
16608
|
+
data
|
16609
|
+
end
|
16610
|
+
|
16611
|
+
# Submit onboarding requirements for Scaled Platform originators
|
16612
|
+
# The `/transfer/platform/requirement/submit` endpoint allows platforms to submit onboarding requirements for an originator as part of the Scaled Platform Transfer offering.
|
16613
|
+
# @param transfer_platform_requirement_submit_request [TransferPlatformRequirementSubmitRequest]
|
16614
|
+
# @param [Hash] opts the optional parameters
|
16615
|
+
# @return [Array<(TransferPlatformRequirementSubmitResponse, Integer, Hash)>] TransferPlatformRequirementSubmitResponse data, response status code and response headers
|
16616
|
+
def transfer_platform_requirement_submit_with_http_info(transfer_platform_requirement_submit_request, opts = {})
|
16617
|
+
if @api_client.config.debugging
|
16618
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.transfer_platform_requirement_submit ...'
|
16619
|
+
end
|
16620
|
+
# verify the required parameter 'transfer_platform_requirement_submit_request' is set
|
16621
|
+
if @api_client.config.client_side_validation && transfer_platform_requirement_submit_request.nil?
|
16622
|
+
fail ArgumentError, "Missing the required parameter 'transfer_platform_requirement_submit_request' when calling PlaidApi.transfer_platform_requirement_submit"
|
16623
|
+
end
|
16624
|
+
# resource path
|
16625
|
+
local_var_path = '/transfer/platform/requirement/submit'
|
16626
|
+
|
16627
|
+
# query parameters
|
16628
|
+
query_params = opts[:query_params] || {}
|
16629
|
+
|
16630
|
+
# header parameters
|
16631
|
+
header_params = opts[:header_params] || {}
|
16632
|
+
# HTTP header 'Accept' (if needed)
|
16633
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
16634
|
+
# HTTP header 'Content-Type'
|
16635
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
16636
|
+
if !content_type.nil?
|
16637
|
+
header_params['Content-Type'] = content_type
|
16638
|
+
end
|
16639
|
+
|
16640
|
+
# form parameters
|
16641
|
+
form_params = opts[:form_params] || {}
|
16642
|
+
|
16643
|
+
# http body (model)
|
16644
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(transfer_platform_requirement_submit_request)
|
16645
|
+
|
16646
|
+
# return_type
|
16647
|
+
return_type = opts[:debug_return_type] || 'TransferPlatformRequirementSubmitResponse'
|
16648
|
+
|
16649
|
+
# auth_names
|
16650
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
16651
|
+
|
16652
|
+
new_options = opts.merge(
|
16653
|
+
:operation => :"PlaidApi.transfer_platform_requirement_submit",
|
16654
|
+
:header_params => header_params,
|
16655
|
+
:query_params => query_params,
|
16656
|
+
:form_params => form_params,
|
16657
|
+
:body => post_body,
|
16658
|
+
:auth_names => auth_names,
|
16659
|
+
:return_type => return_type
|
16660
|
+
)
|
16661
|
+
|
16662
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
16663
|
+
if @api_client.config.debugging
|
16664
|
+
@api_client.config.logger.debug "API called: PlaidApi#transfer_platform_requirement_submit\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
16665
|
+
end
|
16666
|
+
return data, status_code, headers
|
16667
|
+
end
|
16668
|
+
|
15798
16669
|
# Generate a Plaid-hosted onboarding UI URL.
|
15799
16670
|
# 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
16671
|
# @param transfer_questionnaire_create_request [TransferQuestionnaireCreateRequest]
|
@@ -16680,7 +17551,7 @@ module Plaid
|
|
16680
17551
|
end
|
16681
17552
|
|
16682
17553
|
# Create user
|
16683
|
-
# This endpoint should be called for each of your end users before they begin a Plaid
|
17554
|
+
# 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
17555
|
# @param user_create_request [UserCreateRequest]
|
16685
17556
|
# @param [Hash] opts the optional parameters
|
16686
17557
|
# @return [UserCreateResponse]
|
@@ -16690,7 +17561,7 @@ module Plaid
|
|
16690
17561
|
end
|
16691
17562
|
|
16692
17563
|
# Create user
|
16693
|
-
# This endpoint should be called for each of your end users before they begin a Plaid
|
17564
|
+
# 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
17565
|
# @param user_create_request [UserCreateRequest]
|
16695
17566
|
# @param [Hash] opts the optional parameters
|
16696
17567
|
# @return [Array<(UserCreateResponse, Integer, Hash)>] UserCreateResponse data, response status code and response headers
|
@@ -16816,7 +17687,7 @@ module Plaid
|
|
16816
17687
|
end
|
16817
17688
|
|
16818
17689
|
# Remove user
|
16819
|
-
#
|
17690
|
+
# `/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
17691
|
# @param user_remove_request [UserRemoveRequest]
|
16821
17692
|
# @param [Hash] opts the optional parameters
|
16822
17693
|
# @return [UserRemoveResponse]
|
@@ -16826,7 +17697,7 @@ module Plaid
|
|
16826
17697
|
end
|
16827
17698
|
|
16828
17699
|
# Remove user
|
16829
|
-
#
|
17700
|
+
# `/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
17701
|
# @param user_remove_request [UserRemoveRequest]
|
16831
17702
|
# @param [Hash] opts the optional parameters
|
16832
17703
|
# @return [Array<(UserRemoveResponse, Integer, Hash)>] UserRemoveResponse data, response status code and response headers
|
@@ -16884,7 +17755,7 @@ module Plaid
|
|
16884
17755
|
end
|
16885
17756
|
|
16886
17757
|
# Update user information
|
16887
|
-
# This endpoint is used to update user information associated with an existing `user_token`.
|
17758
|
+
# 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
17759
|
# @param user_update_request [UserUpdateRequest]
|
16889
17760
|
# @param [Hash] opts the optional parameters
|
16890
17761
|
# @return [UserUpdateResponse]
|
@@ -16894,7 +17765,7 @@ module Plaid
|
|
16894
17765
|
end
|
16895
17766
|
|
16896
17767
|
# Update user information
|
16897
|
-
# This endpoint is used to update user information associated with an existing `user_token`.
|
17768
|
+
# 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
17769
|
# @param user_update_request [UserUpdateRequest]
|
16899
17770
|
# @param [Hash] opts the optional parameters
|
16900
17771
|
# @return [Array<(UserUpdateResponse, Integer, Hash)>] UserUpdateResponse data, response status code and response headers
|