plaid 15.8.0 → 15.11.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 +215 -0
- data/Gemfile.lock +1 -1
- data/Makefile +1 -1
- data/lib/plaid/api/plaid_api.rb +661 -11
- 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_assets_all_of.rb +1 -21
- data/lib/plaid/models/account_balance.rb +1 -1
- data/lib/plaid/models/account_base.rb +1 -1
- data/lib/plaid/models/account_filter.rb +1 -1
- data/lib/plaid/models/account_filters_response.rb +1 -1
- data/lib/plaid/models/account_identity.rb +1 -1
- data/lib/plaid/models/account_identity_all_of.rb +1 -1
- data/lib/plaid/models/account_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 +2 -1
- data/lib/plaid/models/account_type.rb +1 -1
- data/lib/plaid/models/accounts_balance_get_request.rb +1 -1
- data/lib/plaid/models/accounts_balance_get_request_options.rb +1 -1
- data/lib/plaid/models/accounts_get_request.rb +1 -1
- data/lib/plaid/models/accounts_get_request_options.rb +1 -1
- data/lib/plaid/models/accounts_get_response.rb +1 -1
- data/lib/plaid/models/ach_class.rb +1 -1
- data/lib/plaid/models/address.rb +1 -1
- data/lib/plaid/models/address_data.rb +1 -1
- data/lib/plaid/models/address_data_nullable.rb +1 -1
- data/lib/plaid/models/address_nullable.rb +1 -1
- data/lib/plaid/models/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_report.rb +1 -1
- data/lib/plaid/models/asset_report_audit_copy_create_request.rb +1 -1
- data/lib/plaid/models/asset_report_audit_copy_create_response.rb +1 -1
- data/lib/plaid/models/asset_report_audit_copy_get_request.rb +1 -1
- data/lib/plaid/models/asset_report_audit_copy_remove_request.rb +1 -1
- data/lib/plaid/models/asset_report_audit_copy_remove_response.rb +1 -1
- data/lib/plaid/models/asset_report_create_request.rb +1 -1
- data/lib/plaid/models/asset_report_create_request_options.rb +14 -2
- data/lib/plaid/models/asset_report_create_response.rb +1 -1
- data/lib/plaid/models/asset_report_filter_request.rb +1 -1
- data/lib/plaid/models/asset_report_filter_response.rb +1 -1
- data/lib/plaid/models/asset_report_get_request.rb +1 -1
- data/lib/plaid/models/asset_report_get_response.rb +1 -1
- data/lib/plaid/models/asset_report_item.rb +1 -1
- data/lib/plaid/models/asset_report_pdf_get_request.rb +1 -1
- data/lib/plaid/models/asset_report_refresh_request.rb +1 -1
- data/lib/plaid/models/asset_report_refresh_request_options.rb +1 -1
- data/lib/plaid/models/asset_report_refresh_response.rb +1 -1
- data/lib/plaid/models/asset_report_relay_create_request.rb +1 -1
- data/lib/plaid/models/asset_report_relay_create_response.rb +1 -1
- data/lib/plaid/models/asset_report_relay_get_request.rb +1 -1
- data/lib/plaid/models/asset_report_relay_refresh_request.rb +1 -1
- data/lib/plaid/models/asset_report_relay_refresh_response.rb +1 -1
- data/lib/plaid/models/asset_report_relay_remove_request.rb +1 -1
- data/lib/plaid/models/asset_report_relay_remove_response.rb +1 -1
- data/lib/plaid/models/asset_report_remove_request.rb +1 -1
- data/lib/plaid/models/asset_report_remove_response.rb +1 -1
- data/lib/plaid/models/asset_report_transaction.rb +2 -2
- data/lib/plaid/models/asset_report_transaction_all_of.rb +1 -1
- data/lib/plaid/models/asset_report_user.rb +1 -1
- data/lib/plaid/models/assets_error_webhook.rb +2 -6
- data/lib/plaid/models/assets_product_ready_webhook.rb +1 -1
- data/lib/plaid/models/assets_relay_webhook.rb +1 -1
- data/lib/plaid/models/auth_get_numbers.rb +1 -1
- data/lib/plaid/models/auth_get_request.rb +1 -1
- data/lib/plaid/models/auth_get_request_options.rb +1 -1
- data/lib/plaid/models/auth_get_response.rb +1 -1
- data/lib/plaid/models/auth_metadata.rb +1 -1
- data/lib/plaid/models/auth_supported_methods.rb +1 -1
- data/lib/plaid/models/automatically_verified_webhook.rb +1 -1
- data/lib/plaid/models/bank_initiated_return_risk.rb +1 -1
- data/lib/plaid/models/bank_transfer.rb +1 -1
- data/lib/plaid/models/bank_transfer_balance.rb +1 -1
- data/lib/plaid/models/bank_transfer_balance_get_request.rb +1 -1
- data/lib/plaid/models/bank_transfer_balance_get_response.rb +1 -1
- data/lib/plaid/models/bank_transfer_cancel_request.rb +1 -1
- data/lib/plaid/models/bank_transfer_cancel_response.rb +1 -1
- data/lib/plaid/models/bank_transfer_create_request.rb +1 -1
- data/lib/plaid/models/bank_transfer_create_response.rb +1 -1
- data/lib/plaid/models/bank_transfer_direction.rb +1 -1
- data/lib/plaid/models/bank_transfer_event.rb +1 -1
- data/lib/plaid/models/bank_transfer_event_list_bank_transfer_type.rb +1 -1
- data/lib/plaid/models/bank_transfer_event_list_direction.rb +1 -1
- data/lib/plaid/models/bank_transfer_event_list_request.rb +1 -1
- data/lib/plaid/models/bank_transfer_event_list_response.rb +1 -1
- data/lib/plaid/models/bank_transfer_event_sync_request.rb +1 -1
- data/lib/plaid/models/bank_transfer_event_sync_response.rb +1 -1
- data/lib/plaid/models/bank_transfer_event_type.rb +1 -1
- data/lib/plaid/models/bank_transfer_failure.rb +1 -1
- data/lib/plaid/models/bank_transfer_get_request.rb +1 -1
- data/lib/plaid/models/bank_transfer_get_response.rb +1 -1
- data/lib/plaid/models/bank_transfer_list_request.rb +1 -1
- data/lib/plaid/models/bank_transfer_list_response.rb +1 -1
- data/lib/plaid/models/bank_transfer_migrate_account_request.rb +1 -1
- data/lib/plaid/models/bank_transfer_migrate_account_response.rb +1 -1
- data/lib/plaid/models/bank_transfer_network.rb +1 -1
- data/lib/plaid/models/bank_transfer_status.rb +1 -1
- data/lib/plaid/models/bank_transfer_sweep.rb +1 -1
- data/lib/plaid/models/bank_transfer_sweep_get_request.rb +1 -1
- data/lib/plaid/models/bank_transfer_sweep_get_response.rb +1 -1
- data/lib/plaid/models/bank_transfer_sweep_list_request.rb +1 -1
- data/lib/plaid/models/bank_transfer_sweep_list_response.rb +1 -1
- data/lib/plaid/models/bank_transfer_type.rb +1 -1
- data/lib/plaid/models/bank_transfer_user.rb +1 -1
- data/lib/plaid/models/bank_transfers_events_update_webhook.rb +1 -1
- data/lib/plaid/models/categories_get_response.rb +1 -1
- data/lib/plaid/models/category.rb +1 -1
- data/lib/plaid/models/cause.rb +1 -1
- data/lib/plaid/models/cause_all_of.rb +1 -1
- data/lib/plaid/models/client_provided_enhanced_transaction.rb +1 -1
- data/lib/plaid/models/client_provided_raw_transaction.rb +1 -1
- data/lib/plaid/models/connected_application.rb +1 -1
- data/lib/plaid/models/country_code.rb +1 -1
- data/lib/plaid/models/create_entity_screening_request.rb +1 -1
- data/lib/plaid/models/create_entity_watchlist_screening_review_request.rb +1 -1
- data/lib/plaid/models/create_individual_watchlist_screening_review_request.rb +1 -1
- data/lib/plaid/models/credit1099.rb +772 -0
- data/lib/plaid/models/credit1099_filer.rb +252 -0
- data/lib/plaid/models/credit1099_payer.rb +252 -0
- data/lib/plaid/models/credit1099_recipient.rb +274 -0
- data/lib/plaid/models/credit_account_subtype.rb +1 -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 +245 -0
- data/lib/plaid/models/credit_audit_copy_token_remove_response.rb +240 -0
- data/lib/plaid/models/credit_bank_income.rb +1 -1
- data/lib/plaid/models/credit_bank_income_account.rb +1 -1
- data/lib/plaid/models/credit_bank_income_account_type.rb +1 -1
- data/lib/plaid/models/credit_bank_income_category.rb +1 -1
- data/lib/plaid/models/credit_bank_income_cause.rb +1 -1
- data/lib/plaid/models/credit_bank_income_error_type.rb +1 -1
- data/lib/plaid/models/credit_bank_income_get_request.rb +1 -1
- data/lib/plaid/models/credit_bank_income_get_request_options.rb +1 -1
- data/lib/plaid/models/credit_bank_income_get_response.rb +1 -1
- data/lib/plaid/models/credit_bank_income_historical_summary.rb +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 +245 -0
- 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 +2 -2
- data/lib/plaid/models/credit_bank_income_warning.rb +1 -1
- data/lib/plaid/models/credit_bank_income_warning_code.rb +1 -1
- data/lib/plaid/models/credit_bank_income_warning_type.rb +1 -1
- data/lib/plaid/models/credit_card_liability.rb +1 -1
- data/lib/plaid/models/credit_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 +20 -5
- data/lib/plaid/models/credit_employment_verification.rb +1 -1
- data/lib/plaid/models/credit_filter.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_verification.rb +2 -2
- data/lib/plaid/models/credit_payroll_income_get_request.rb +1 -1
- data/lib/plaid/models/credit_payroll_income_get_response.rb +6 -20
- data/lib/plaid/models/credit_payroll_income_precheck_request.rb +1 -1
- data/lib/plaid/models/credit_payroll_income_precheck_response.rb +1 -1
- data/lib/plaid/models/credit_payroll_income_refresh_request.rb +1 -1
- data/lib/plaid/models/credit_payroll_income_refresh_response.rb +1 -1
- data/lib/plaid/models/credit_payroll_income_risk_signals_get_request.rb +1 -1
- data/lib/plaid/models/credit_payroll_income_risk_signals_get_response.rb +2 -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 +259 -0
- data/lib/plaid/models/credit_relay_refresh_request.rb +270 -0
- data/lib/plaid/models/credit_relay_refresh_response.rb +249 -0
- data/lib/plaid/models/credit_relay_remove_request.rb +245 -0
- data/lib/plaid/models/credit_relay_remove_response.rb +240 -0
- data/lib/plaid/models/credit_w2.rb +1 -1
- data/lib/plaid/models/customer_initiated_return_risk.rb +1 -1
- data/lib/plaid/models/dashboard_user.rb +1 -1
- data/lib/plaid/models/dashboard_user_response.rb +1 -1
- data/lib/plaid/models/dashboard_user_status.rb +1 -1
- data/lib/plaid/models/date_range.rb +1 -1
- data/lib/plaid/models/deductions.rb +1 -1
- data/lib/plaid/models/deductions_breakdown.rb +1 -1
- data/lib/plaid/models/deductions_total.rb +1 -1
- data/lib/plaid/models/default_update_webhook.rb +2 -1
- data/lib/plaid/models/deposit_switch_address_data.rb +1 -1
- data/lib/plaid/models/deposit_switch_alt_create_request.rb +1 -1
- data/lib/plaid/models/deposit_switch_alt_create_response.rb +1 -1
- data/lib/plaid/models/deposit_switch_create_request.rb +1 -1
- data/lib/plaid/models/deposit_switch_create_request_options.rb +1 -1
- data/lib/plaid/models/deposit_switch_create_response.rb +1 -1
- data/lib/plaid/models/deposit_switch_get_request.rb +1 -1
- data/lib/plaid/models/deposit_switch_get_response.rb +1 -1
- data/lib/plaid/models/deposit_switch_state_update_webhook.rb +1 -1
- data/lib/plaid/models/deposit_switch_target_account.rb +1 -1
- data/lib/plaid/models/deposit_switch_target_user.rb +1 -1
- data/lib/plaid/models/deposit_switch_token_create_request.rb +1 -1
- data/lib/plaid/models/deposit_switch_token_create_response.rb +1 -1
- data/lib/plaid/models/depository_account_subtype.rb +1 -1
- data/lib/plaid/models/depository_filter.rb +1 -1
- data/lib/plaid/models/distribution_breakdown.rb +1 -1
- data/lib/plaid/models/doc_type.rb +3 -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 +18 -6
- data/lib/plaid/models/document_risk_signal_institution_metadata.rb +2 -2
- data/lib/plaid/models/document_risk_signals_object.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/employee.rb +1 -1
- data/lib/plaid/models/employee_income_summary_field_string.rb +1 -1
- data/lib/plaid/models/employer.rb +1 -1
- data/lib/plaid/models/employer_income_summary_field_string.rb +1 -1
- data/lib/plaid/models/employer_verification.rb +1 -1
- data/lib/plaid/models/employers_search_request.rb +1 -1
- data/lib/plaid/models/employers_search_response.rb +1 -1
- data/lib/plaid/models/employment_details.rb +1 -1
- data/lib/plaid/models/employment_verification.rb +1 -1
- data/lib/plaid/models/employment_verification_get_request.rb +1 -1
- data/lib/plaid/models/employment_verification_get_response.rb +1 -1
- data/lib/plaid/models/employment_verification_status.rb +1 -1
- data/lib/plaid/models/enhancements.rb +32 -22
- data/lib/plaid/models/entity_document.rb +1 -1
- data/lib/plaid/models/entity_document_type.rb +1 -1
- data/lib/plaid/models/entity_screening_hit_analysis.rb +1 -1
- data/lib/plaid/models/entity_screening_hit_data.rb +1 -1
- data/lib/plaid/models/entity_screening_hit_documents_items.rb +1 -1
- data/lib/plaid/models/entity_screening_hit_emails.rb +1 -1
- data/lib/plaid/models/entity_screening_hit_emails_items.rb +1 -1
- data/lib/plaid/models/entity_screening_hit_names.rb +1 -1
- data/lib/plaid/models/entity_screening_hit_names_items.rb +1 -1
- data/lib/plaid/models/entity_screening_hit_phone_numbers.rb +1 -1
- data/lib/plaid/models/entity_screening_hit_urls.rb +1 -1
- data/lib/plaid/models/entity_screening_hit_urls_items.rb +1 -1
- data/lib/plaid/models/entity_screening_hits_phone_number_items.rb +1 -1
- data/lib/plaid/models/entity_screening_status_updated_webhook.rb +1 -1
- data/lib/plaid/models/entity_watchlist_code.rb +1 -1
- data/lib/plaid/models/entity_watchlist_program.rb +1 -1
- data/lib/plaid/models/entity_watchlist_program_response.rb +1 -1
- data/lib/plaid/models/entity_watchlist_screening.rb +1 -1
- data/lib/plaid/models/entity_watchlist_screening_hit.rb +1 -1
- data/lib/plaid/models/entity_watchlist_screening_response.rb +1 -1
- data/lib/plaid/models/entity_watchlist_screening_review.rb +1 -1
- data/lib/plaid/models/entity_watchlist_screening_review_response.rb +1 -1
- data/lib/plaid/models/entity_watchlist_screening_search_terms.rb +1 -1
- data/lib/plaid/models/entity_watchlist_search_terms.rb +1 -1
- data/lib/plaid/models/error.rb +1 -1
- data/lib/plaid/models/expiration_date.rb +1 -1
- data/lib/plaid/models/external_payment_initiation_consent_options.rb +1 -1
- data/lib/plaid/models/external_payment_options.rb +1 -1
- data/lib/plaid/models/external_payment_refund_details.rb +1 -1
- data/lib/plaid/models/external_payment_schedule_base.rb +1 -1
- data/lib/plaid/models/external_payment_schedule_get.rb +1 -1
- data/lib/plaid/models/external_payment_schedule_request.rb +1 -1
- data/lib/plaid/models/form1099_type.rb +40 -0
- data/lib/plaid/models/generic_screening_hit_location_items.rb +1 -1
- data/lib/plaid/models/get_dashboard_user_request.rb +1 -1
- data/lib/plaid/models/get_entity_watchlist_screening_request.rb +1 -1
- data/lib/plaid/models/get_identity_verification_request.rb +1 -1
- data/lib/plaid/models/get_individual_watchlist_screening_request.rb +1 -1
- data/lib/plaid/models/get_watchlist_screening_entity_program_request.rb +1 -1
- data/lib/plaid/models/get_watchlist_screening_individual_program_request.rb +1 -1
- data/lib/plaid/models/health_incident.rb +1 -1
- data/lib/plaid/models/historical_balance.rb +1 -1
- data/lib/plaid/models/historical_update_webhook.rb +2 -1
- data/lib/plaid/models/holding.rb +13 -2
- data/lib/plaid/models/holdings_default_update_webhook.rb +2 -1
- data/lib/plaid/models/holdings_override.rb +1 -1
- data/lib/plaid/models/id_number_type.rb +1 -1
- data/lib/plaid/models/identity_default_update_webhook.rb +2 -6
- 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 +263 -0
- data/lib/plaid/models/identity_match_request_options.rb +222 -0
- data/lib/plaid/models/identity_match_response.rb +220 -0
- data/lib/plaid/models/identity_match_user.rb +253 -0
- data/lib/plaid/models/identity_update_types.rb +1 -1
- data/lib/plaid/models/identity_verification.rb +1 -1
- data/lib/plaid/models/identity_verification_create_request.rb +2 -2
- data/lib/plaid/models/identity_verification_request_user.rb +1 -1
- data/lib/plaid/models/identity_verification_response.rb +1 -1
- data/lib/plaid/models/identity_verification_retried_webhook.rb +1 -1
- data/lib/plaid/models/identity_verification_retry_request.rb +1 -1
- data/lib/plaid/models/identity_verification_retry_request_steps_object.rb +1 -1
- data/lib/plaid/models/identity_verification_status.rb +1 -1
- data/lib/plaid/models/identity_verification_status_updated_webhook.rb +1 -1
- data/lib/plaid/models/identity_verification_step_status.rb +1 -1
- data/lib/plaid/models/identity_verification_step_summary.rb +1 -1
- data/lib/plaid/models/identity_verification_step_updated_webhook.rb +1 -1
- data/lib/plaid/models/identity_verification_template_reference.rb +1 -1
- data/lib/plaid/models/identity_verification_user_address.rb +1 -1
- data/lib/plaid/models/identity_verification_user_data.rb +1 -1
- data/lib/plaid/models/image_quality.rb +1 -1
- data/lib/plaid/models/incident_update.rb +1 -1
- data/lib/plaid/models/income_breakdown.rb +1 -1
- data/lib/plaid/models/income_breakdown_type.rb +1 -1
- data/lib/plaid/models/income_override.rb +1 -1
- data/lib/plaid/models/income_summary.rb +1 -1
- data/lib/plaid/models/income_summary_field_number.rb +1 -1
- data/lib/plaid/models/income_summary_field_string.rb +1 -1
- data/lib/plaid/models/income_verification_create_request.rb +1 -1
- data/lib/plaid/models/income_verification_create_request_options.rb +1 -1
- data/lib/plaid/models/income_verification_create_response.rb +1 -1
- data/lib/plaid/models/income_verification_documents_download_request.rb +1 -1
- data/lib/plaid/models/income_verification_payroll_flow_type.rb +1 -1
- data/lib/plaid/models/income_verification_paystubs_get_request.rb +1 -1
- data/lib/plaid/models/income_verification_paystubs_get_response.rb +2 -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_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_request.rb +1 -1
- data/lib/plaid/models/income_verification_refresh_response.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 +2 -1
- data/lib/plaid/models/income_verification_webhook_status.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/individual_watchlist_program_response.rb +1 -1
- data/lib/plaid/models/inflow_model.rb +1 -1
- data/lib/plaid/models/initial_update_webhook.rb +1 -1
- data/lib/plaid/models/institution.rb +1 -1
- data/lib/plaid/models/institution_status.rb +1 -6
- 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 +2 -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 +3 -1
- data/lib/plaid/models/investment_transaction_type.rb +1 -1
- data/lib/plaid/models/investments_default_update_webhook.rb +2 -1
- data/lib/plaid/models/investments_holdings_get_request.rb +1 -1
- data/lib/plaid/models/investments_holdings_get_response.rb +1 -1
- data/lib/plaid/models/investments_transactions_get_request.rb +1 -1
- data/lib/plaid/models/investments_transactions_get_request_options.rb +1 -1
- data/lib/plaid/models/investments_transactions_get_response.rb +1 -1
- data/lib/plaid/models/investments_transactions_override.rb +1 -1
- data/lib/plaid/models/issuing_country.rb +1 -1
- data/lib/plaid/models/item.rb +2 -2
- data/lib/plaid/models/item_access_token_invalidate_request.rb +1 -1
- data/lib/plaid/models/item_access_token_invalidate_response.rb +1 -1
- data/lib/plaid/models/item_application_list_request.rb +1 -1
- data/lib/plaid/models/item_application_list_response.rb +1 -1
- data/lib/plaid/models/item_application_list_user_auth.rb +1 -1
- data/lib/plaid/models/item_application_scopes_update_request.rb +1 -1
- data/lib/plaid/models/item_application_scopes_update_response.rb +1 -1
- data/lib/plaid/models/item_error_webhook.rb +2 -6
- data/lib/plaid/models/item_get_request.rb +1 -1
- data/lib/plaid/models/item_get_response.rb +1 -1
- data/lib/plaid/models/item_import_request.rb +1 -1
- data/lib/plaid/models/item_import_request_options.rb +1 -1
- data/lib/plaid/models/item_import_request_user_auth.rb +1 -1
- data/lib/plaid/models/item_import_response.rb +1 -1
- data/lib/plaid/models/item_product_ready_webhook.rb +2 -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 +1 -1
- data/lib/plaid/models/kyc_check_date_of_birth_summary.rb +1 -1
- data/lib/plaid/models/kyc_check_details.rb +1 -1
- data/lib/plaid/models/kyc_check_id_number_summary.rb +1 -1
- data/lib/plaid/models/kyc_check_name_summary.rb +1 -1
- data/lib/plaid/models/kyc_check_phone_summary.rb +1 -1
- data/lib/plaid/models/liabilities_default_update_webhook.rb +2 -6
- 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_token_account_filters.rb +1 -1
- data/lib/plaid/models/link_token_create_credit_filter.rb +1 -1
- data/lib/plaid/models/link_token_create_depository_filter.rb +1 -1
- data/lib/plaid/models/link_token_create_institution_data.rb +1 -1
- data/lib/plaid/models/link_token_create_investment_filter.rb +1 -1
- data/lib/plaid/models/link_token_create_loan_filter.rb +1 -1
- data/lib/plaid/models/link_token_create_request.rb +3 -3
- data/lib/plaid/models/link_token_create_request_account_subtypes.rb +1 -1
- data/lib/plaid/models/link_token_create_request_auth.rb +1 -1
- data/lib/plaid/models/link_token_create_request_deposit_switch.rb +1 -1
- data/lib/plaid/models/link_token_create_request_identity_verification.rb +16 -7
- data/lib/plaid/models/link_token_create_request_income_verification.rb +18 -6
- data/lib/plaid/models/link_token_create_request_income_verification_bank_income.rb +1 -1
- 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_transfer.rb +15 -5
- data/lib/plaid/models/link_token_create_request_update.rb +1 -1
- data/lib/plaid/models/link_token_create_request_user.rb +38 -8
- data/lib/plaid/models/link_token_create_request_user_stated_income_source.rb +267 -0
- 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/list_dashboard_user_request.rb +1 -1
- data/lib/plaid/models/list_entity_watchlist_screening_request.rb +1 -1
- data/lib/plaid/models/list_identity_verification_request.rb +1 -1
- data/lib/plaid/models/list_individual_watchlist_screening_request.rb +1 -1
- data/lib/plaid/models/list_watchlist_screening_entity_history_request.rb +1 -1
- data/lib/plaid/models/list_watchlist_screening_entity_hit_request.rb +1 -1
- data/lib/plaid/models/list_watchlist_screening_entity_programs_request.rb +1 -1
- data/lib/plaid/models/list_watchlist_screening_entity_reviews_request.rb +1 -1
- data/lib/plaid/models/list_watchlist_screening_individual_history_request.rb +1 -1
- data/lib/plaid/models/list_watchlist_screening_individual_hit_request.rb +1 -1
- data/lib/plaid/models/list_watchlist_screening_individual_programs_request.rb +1 -1
- data/lib/plaid/models/list_watchlist_screening_individual_reviews_request.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/location.rb +1 -1
- data/lib/plaid/models/match_summary.rb +1 -1
- data/lib/plaid/models/match_summary_code.rb +1 -1
- data/lib/plaid/models/meta.rb +1 -1
- data/lib/plaid/models/mfa.rb +1 -1
- data/lib/plaid/models/mortgage_interest_rate.rb +1 -1
- data/lib/plaid/models/mortgage_liability.rb +1 -1
- data/lib/plaid/models/mortgage_property_address.rb +1 -1
- data/lib/plaid/models/multi_document_risk_signal.rb +1 -1
- data/lib/plaid/models/net_pay.rb +1 -1
- data/lib/plaid/models/new_accounts_available_webhook.rb +2 -1
- data/lib/plaid/models/numbers.rb +1 -1
- data/lib/plaid/models/numbers_ach.rb +1 -1
- data/lib/plaid/models/numbers_ach_nullable.rb +1 -1
- data/lib/plaid/models/numbers_bacs.rb +1 -1
- data/lib/plaid/models/numbers_bacs_nullable.rb +1 -1
- data/lib/plaid/models/numbers_eft.rb +1 -1
- data/lib/plaid/models/numbers_eft_nullable.rb +1 -1
- data/lib/plaid/models/numbers_iban_nullable.rb +210 -0
- data/lib/plaid/models/numbers_international.rb +1 -1
- data/lib/plaid/models/numbers_international_iban.rb +300 -0
- data/lib/plaid/models/numbers_international_nullable.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/paginated_dashboard_user_list_response.rb +1 -1
- data/lib/plaid/models/paginated_entity_watchlist_program_list_response.rb +1 -1
- data/lib/plaid/models/paginated_entity_watchlist_screening_hit_list_response.rb +1 -1
- data/lib/plaid/models/paginated_entity_watchlist_screening_list_response.rb +1 -1
- data/lib/plaid/models/paginated_entity_watchlist_screening_review_list_response.rb +1 -1
- data/lib/plaid/models/paginated_identity_verification_list_response.rb +1 -1
- data/lib/plaid/models/paginated_individual_watchlist_program_list_response.rb +1 -1
- data/lib/plaid/models/paginated_individual_watchlist_screening_hit_list_response.rb +1 -1
- data/lib/plaid/models/paginated_individual_watchlist_screening_list_response.rb +1 -1
- data/lib/plaid/models/paginated_individual_watchlist_screening_review_list_response.rb +1 -1
- data/lib/plaid/models/partner_customers_create_request.rb +287 -0
- data/lib/plaid/models/partner_customers_create_response.rb +238 -0
- data/lib/plaid/models/partner_end_customer_client.rb +229 -0
- data/lib/plaid/models/pay.rb +1 -1
- data/lib/plaid/models/pay_frequency.rb +1 -1
- data/lib/plaid/models/pay_frequency_value.rb +1 -1
- data/lib/plaid/models/pay_period_details.rb +1 -1
- data/lib/plaid/models/pay_stub_deductions_breakdown.rb +1 -1
- data/lib/plaid/models/pay_stub_deductions_total.rb +1 -1
- data/lib/plaid/models/pay_stub_distribution_breakdown.rb +1 -1
- data/lib/plaid/models/pay_stub_earnings_breakdown.rb +1 -1
- data/lib/plaid/models/pay_stub_earnings_total.rb +1 -1
- data/lib/plaid/models/pay_stub_pay_period_details.rb +1 -1
- data/lib/plaid/models/pay_stub_taxpayer_id.rb +1 -1
- data/lib/plaid/models/pay_stub_verification_attribute.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_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 +2 -2
- data/lib/plaid/models/payment_initiation_recipient_create_response.rb +1 -1
- data/lib/plaid/models/payment_initiation_recipient_get_request.rb +1 -1
- data/lib/plaid/models/payment_initiation_recipient_get_response.rb +1 -1
- data/lib/plaid/models/payment_initiation_recipient_get_response_all_of.rb +1 -1
- data/lib/plaid/models/payment_initiation_recipient_list_request.rb +1 -1
- data/lib/plaid/models/payment_initiation_recipient_list_response.rb +1 -1
- data/lib/plaid/models/payment_initiation_refund_status.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 +230 -0
- data/lib/plaid/models/payment_profile_create_response.rb +240 -0
- data/lib/plaid/models/payment_profile_get_request.rb +245 -0
- data/lib/plaid/models/payment_profile_get_response.rb +269 -0
- data/lib/plaid/models/payment_profile_remove_request.rb +245 -0
- data/lib/plaid/models/payment_profile_remove_response.rb +225 -0
- data/lib/plaid/models/payment_profile_status.rb +40 -0
- 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 +2 -1
- data/lib/plaid/models/payroll_income_account_data.rb +1 -1
- data/lib/plaid/models/payroll_income_object.rb +22 -5
- data/lib/plaid/models/payroll_income_rate_of_pay.rb +1 -1
- data/lib/plaid/models/payroll_item.rb +21 -6
- data/lib/plaid/models/payroll_item_status.rb +1 -1
- data/lib/plaid/models/payroll_risk_signals_item.rb +1 -1
- data/lib/plaid/models/paystub.rb +1 -1
- data/lib/plaid/models/paystub_address.rb +1 -1
- data/lib/plaid/models/paystub_deduction.rb +1 -1
- data/lib/plaid/models/paystub_details.rb +1 -1
- data/lib/plaid/models/paystub_employer.rb +1 -1
- data/lib/plaid/models/paystub_override.rb +1 -1
- data/lib/plaid/models/paystub_override_employee.rb +1 -1
- data/lib/plaid/models/paystub_override_employee_address.rb +1 -1
- data/lib/plaid/models/paystub_override_employer.rb +1 -1
- data/lib/plaid/models/paystub_pay_frequency.rb +1 -1
- data/lib/plaid/models/paystub_verification.rb +1 -1
- data/lib/plaid/models/paystub_verification_status.rb +1 -1
- data/lib/plaid/models/paystub_ytd_details.rb +1 -1
- data/lib/plaid/models/pending_expiration_webhook.rb +1 -1
- data/lib/plaid/models/personal_finance_category.rb +2 -2
- data/lib/plaid/models/phone_number.rb +1 -1
- data/lib/plaid/models/phone_type.rb +1 -1
- data/lib/plaid/models/physical_document_category.rb +1 -1
- data/lib/plaid/models/physical_document_extracted_data.rb +1 -1
- data/lib/plaid/models/physical_document_extracted_data_analysis.rb +1 -1
- data/lib/plaid/models/physical_document_images.rb +1 -1
- data/lib/plaid/models/plaid_error.rb +1 -1
- data/lib/plaid/models/platform_ids.rb +1 -1
- data/lib/plaid/models/po_box_status.rb +1 -1
- data/lib/plaid/models/processor_apex_processor_token_create_request.rb +1 -1
- data/lib/plaid/models/processor_auth_get_request.rb +1 -1
- data/lib/plaid/models/processor_auth_get_response.rb +1 -1
- data/lib/plaid/models/processor_balance_get_request.rb +1 -1
- data/lib/plaid/models/processor_balance_get_request_options.rb +1 -1
- data/lib/plaid/models/processor_balance_get_response.rb +1 -1
- data/lib/plaid/models/processor_bank_transfer_create_request.rb +1 -1
- data/lib/plaid/models/processor_bank_transfer_create_response.rb +1 -1
- data/lib/plaid/models/processor_identity_get_request.rb +1 -1
- data/lib/plaid/models/processor_identity_get_response.rb +1 -1
- data/lib/plaid/models/processor_number.rb +1 -1
- data/lib/plaid/models/processor_stripe_bank_account_token_create_request.rb +1 -1
- data/lib/plaid/models/processor_stripe_bank_account_token_create_response.rb +1 -1
- data/lib/plaid/models/processor_token_create_request.rb +1 -1
- data/lib/plaid/models/processor_token_create_response.rb +1 -1
- data/lib/plaid/models/product_access.rb +1 -1
- data/lib/plaid/models/product_status.rb +1 -1
- data/lib/plaid/models/product_status_breakdown.rb +1 -1
- data/lib/plaid/models/products.rb +2 -1
- data/lib/plaid/models/program_name_sensitivity.rb +1 -1
- data/lib/plaid/models/projected_income_summary_field_number.rb +1 -1
- data/lib/plaid/models/pslf_status.rb +1 -1
- data/lib/plaid/models/recaptcha_required_error.rb +1 -1
- data/lib/plaid/models/recipient_bacs.rb +1 -1
- data/lib/plaid/models/recipient_bacs_nullable.rb +1 -1
- data/lib/plaid/models/recurring_transaction_frequency.rb +1 -1
- data/lib/plaid/models/recurring_transactions_update_webhook.rb +272 -0
- data/lib/plaid/models/relay_event.rb +1 -1
- data/lib/plaid/models/removed_transaction.rb +1 -1
- data/lib/plaid/models/report_token.rb +2 -3
- data/lib/plaid/models/report_type.rb +39 -0
- data/lib/plaid/models/risk_signal_document_reference.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_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_processor_token_create_request.rb +1 -1
- data/lib/plaid/models/sandbox_processor_token_create_request_options.rb +1 -1
- data/lib/plaid/models/sandbox_processor_token_create_response.rb +1 -1
- data/lib/plaid/models/sandbox_public_token_create_request.rb +1 -1
- data/lib/plaid/models/sandbox_public_token_create_request_options.rb +1 -1
- data/lib/plaid/models/sandbox_public_token_create_request_options_transactions.rb +1 -1
- data/lib/plaid/models/sandbox_public_token_create_response.rb +1 -1
- data/lib/plaid/models/sandbox_transfer_fire_webhook_request.rb +1 -1
- data/lib/plaid/models/sandbox_transfer_fire_webhook_response.rb +1 -1
- data/lib/plaid/models/sandbox_transfer_repayment_simulate_request.rb +1 -1
- data/lib/plaid/models/sandbox_transfer_repayment_simulate_response.rb +1 -1
- data/lib/plaid/models/sandbox_transfer_simulate_request.rb +1 -1
- data/lib/plaid/models/sandbox_transfer_simulate_response.rb +1 -1
- data/lib/plaid/models/sandbox_transfer_sweep_simulate_request.rb +1 -1
- data/lib/plaid/models/sandbox_transfer_sweep_simulate_response.rb +1 -1
- data/lib/plaid/models/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 +15 -4
- data/lib/plaid/models/security_override.rb +1 -1
- data/lib/plaid/models/sender_bacs_nullable.rb +1 -1
- data/lib/plaid/models/servicer_address_data.rb +1 -1
- data/lib/plaid/models/signal_address_data.rb +1 -1
- data/lib/plaid/models/signal_decision_report_request.rb +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 +11 -1
- data/lib/plaid/models/signal_evaluate_request.rb +1 -1
- data/lib/plaid/models/signal_evaluate_response.rb +1 -1
- data/lib/plaid/models/signal_person_name.rb +1 -1
- data/lib/plaid/models/signal_prepare_request.rb +1 -1
- data/lib/plaid/models/signal_prepare_response.rb +1 -1
- data/lib/plaid/models/signal_return_report_request.rb +1 -1
- data/lib/plaid/models/signal_return_report_response.rb +1 -1
- data/lib/plaid/models/signal_scores.rb +1 -1
- data/lib/plaid/models/signal_user.rb +1 -1
- data/lib/plaid/models/simulated_transfer_sweep.rb +1 -1
- data/lib/plaid/models/single_document_risk_signal.rb +1 -1
- data/lib/plaid/models/source.rb +1 -1
- data/lib/plaid/models/standalone_account_type.rb +1 -1
- data/lib/plaid/models/standalone_currency_code_list.rb +1 -1
- data/lib/plaid/models/standalone_investment_transaction_type.rb +1 -1
- data/lib/plaid/models/strategy.rb +1 -1
- data/lib/plaid/models/student_loan.rb +1 -1
- data/lib/plaid/models/student_loan_repayment_model.rb +1 -1
- data/lib/plaid/models/student_loan_status.rb +1 -1
- data/lib/plaid/models/student_repayment_plan.rb +1 -1
- data/lib/plaid/models/sync_updates_available_webhook.rb +2 -2
- data/lib/plaid/models/taxform.rb +1 -1
- data/lib/plaid/models/taxpayer_id.rb +1 -1
- data/lib/plaid/models/total.rb +1 -1
- data/lib/plaid/models/total_canonical_description.rb +1 -1
- data/lib/plaid/models/transaction.rb +2 -2
- data/lib/plaid/models/transaction_all_of.rb +1 -1
- data/lib/plaid/models/transaction_base.rb +2 -2
- data/lib/plaid/models/transaction_code.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_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_get_request.rb +1 -1
- data/lib/plaid/models/transactions_recurring_get_request_options.rb +1 -1
- data/lib/plaid/models/transactions_recurring_get_response.rb +1 -1
- data/lib/plaid/models/transactions_refresh_request.rb +1 -1
- data/lib/plaid/models/transactions_refresh_response.rb +1 -1
- data/lib/plaid/models/transactions_removed_webhook.rb +2 -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/transfer.rb +1 -1
- data/lib/plaid/models/transfer_authorization.rb +1 -1
- data/lib/plaid/models/transfer_authorization_create_request.rb +27 -16
- 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 +2 -1
- data/lib/plaid/models/transfer_authorization_device.rb +3 -3
- 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 +2 -1
- data/lib/plaid/models/transfer_authorization_proposed_transfer.rb +1 -1
- data/lib/plaid/models/transfer_authorization_user_in_request.rb +254 -0
- 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_create_request.rb +15 -15
- data/lib/plaid/models/transfer_create_response.rb +1 -1
- data/lib/plaid/models/transfer_event.rb +1 -1
- data/lib/plaid/models/transfer_event_list_request.rb +1 -1
- data/lib/plaid/models/transfer_event_list_response.rb +1 -1
- data/lib/plaid/models/transfer_event_list_transfer_type.rb +1 -1
- data/lib/plaid/models/transfer_event_sync_request.rb +1 -1
- data/lib/plaid/models/transfer_event_sync_response.rb +1 -1
- data/lib/plaid/models/transfer_event_type.rb +1 -2
- data/lib/plaid/models/transfer_events_update_webhook.rb +1 -1
- data/lib/plaid/models/transfer_failure.rb +1 -1
- data/lib/plaid/models/transfer_get_request.rb +1 -1
- data/lib/plaid/models/transfer_get_response.rb +1 -1
- data/lib/plaid/models/transfer_intent_authorization_decision.rb +1 -1
- data/lib/plaid/models/transfer_intent_create.rb +1 -1
- data/lib/plaid/models/transfer_intent_create_mode.rb +1 -1
- data/lib/plaid/models/transfer_intent_create_request.rb +1 -1
- data/lib/plaid/models/transfer_intent_create_response.rb +1 -1
- data/lib/plaid/models/transfer_intent_get.rb +1 -1
- data/lib/plaid/models/transfer_intent_get_failure_reason.rb +1 -1
- data/lib/plaid/models/transfer_intent_get_request.rb +1 -1
- data/lib/plaid/models/transfer_intent_get_response.rb +1 -1
- data/lib/plaid/models/transfer_intent_status.rb +1 -1
- data/lib/plaid/models/transfer_list_request.rb +1 -1
- data/lib/plaid/models/transfer_list_response.rb +1 -1
- data/lib/plaid/models/transfer_migrate_account_request.rb +1 -1
- data/lib/plaid/models/transfer_migrate_account_response.rb +1 -1
- data/lib/plaid/models/transfer_network.rb +1 -1
- data/lib/plaid/models/transfer_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_status.rb +1 -2
- data/lib/plaid/models/transfer_sweep.rb +1 -1
- data/lib/plaid/models/transfer_sweep_get_request.rb +1 -1
- data/lib/plaid/models/transfer_sweep_get_response.rb +1 -1
- data/lib/plaid/models/transfer_sweep_list_request.rb +1 -1
- data/lib/plaid/models/transfer_sweep_list_response.rb +1 -1
- data/lib/plaid/models/transfer_sweep_status.rb +1 -1
- data/lib/plaid/models/transfer_type.rb +1 -1
- data/lib/plaid/models/transfer_user_address_in_request.rb +2 -2
- 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_response.rb +1 -1
- data/lib/plaid/models/update_entity_screening_request.rb +1 -1
- data/lib/plaid/models/update_entity_screening_request_resettable_field.rb +1 -1
- data/lib/plaid/models/update_entity_screening_request_search_terms.rb +1 -1
- data/lib/plaid/models/update_individual_screening_request.rb +1 -1
- data/lib/plaid/models/update_individual_screening_request_resettable_field.rb +1 -1
- data/lib/plaid/models/update_individual_screening_request_search_terms.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 +3 -3
- data/lib/plaid/models/user_id_number.rb +1 -1
- data/lib/plaid/models/user_name.rb +1 -1
- data/lib/plaid/models/user_permission_revoked_webhook.rb +3 -2
- data/lib/plaid/models/user_stated_income_source_category.rb +48 -0
- data/lib/plaid/models/user_stated_income_source_frequency.rb +42 -0
- data/lib/plaid/models/user_stated_income_source_pay_type.rb +40 -0
- data/lib/plaid/models/verification_attribute.rb +1 -1
- data/lib/plaid/models/verification_expired_webhook.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_state_and_local_wages.rb +1 -1
- data/lib/plaid/models/wallet.rb +1 -1
- data/lib/plaid/models/wallet_balance.rb +1 -1
- data/lib/plaid/models/wallet_create_request.rb +1 -1
- data/lib/plaid/models/wallet_create_response.rb +1 -1
- data/lib/plaid/models/wallet_get_request.rb +1 -1
- data/lib/plaid/models/wallet_get_response.rb +1 -1
- data/lib/plaid/models/wallet_iso_currency_code.rb +2 -1
- data/lib/plaid/models/wallet_list_request.rb +1 -1
- data/lib/plaid/models/wallet_list_response.rb +1 -1
- data/lib/plaid/models/wallet_numbers.rb +16 -6
- data/lib/plaid/models/wallet_transaction.rb +1 -1
- 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 +246 -0
- data/lib/plaid/models/wallet_transaction_counterparty_numbers.rb +16 -11
- data/lib/plaid/models/wallet_transaction_execute_request.rb +1 -1
- data/lib/plaid/models/wallet_transaction_execute_response.rb +1 -1
- data/lib/plaid/models/wallet_transaction_get_request.rb +1 -1
- data/lib/plaid/models/wallet_transaction_get_response.rb +1 -1
- data/lib/plaid/models/wallet_transaction_status.rb +1 -1
- data/lib/plaid/models/wallet_transactions_list_request.rb +1 -1
- data/lib/plaid/models/wallet_transactions_list_response.rb +1 -1
- data/lib/plaid/models/warning.rb +1 -1
- data/lib/plaid/models/watchlist_screening_audit_trail.rb +1 -1
- data/lib/plaid/models/watchlist_screening_create_request.rb +1 -1
- data/lib/plaid/models/watchlist_screening_document.rb +1 -1
- data/lib/plaid/models/watchlist_screening_document_type.rb +1 -1
- data/lib/plaid/models/watchlist_screening_hit.rb +1 -1
- data/lib/plaid/models/watchlist_screening_hit_locations.rb +1 -1
- data/lib/plaid/models/watchlist_screening_hit_status.rb +1 -1
- data/lib/plaid/models/watchlist_screening_individual.rb +1 -1
- data/lib/plaid/models/watchlist_screening_individual_response.rb +1 -1
- data/lib/plaid/models/watchlist_screening_request_search_terms.rb +1 -1
- data/lib/plaid/models/watchlist_screening_review.rb +1 -1
- data/lib/plaid/models/watchlist_screening_review_response.rb +1 -1
- data/lib/plaid/models/watchlist_screening_search_terms.rb +1 -1
- data/lib/plaid/models/watchlist_screening_status.rb +1 -1
- data/lib/plaid/models/weak_alias_determination.rb +1 -1
- data/lib/plaid/models/webhook_type.rb +1 -1
- data/lib/plaid/models/webhook_update_acknowledged_webhook.rb +2 -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 +38 -1
- data/plaid.gemspec +1 -1
- data/test/test_link_token.rb +75 -41
- metadata +39 -2
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.161.5
|
7
7
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
OpenAPI Generator version: 5.1.1
|
@@ -2034,6 +2034,71 @@ module Plaid
|
|
2034
2034
|
return data, status_code, headers
|
2035
2035
|
end
|
2036
2036
|
|
2037
|
+
# Retrieve information from the bank accounts used for income verification in PDF format
|
2038
|
+
# `/credit/bank_income/pdf/get` returns the most recent bank income report for a specified user in PDF format.
|
2039
|
+
# @param credit_bank_income_pdf_get_request [CreditBankIncomePDFGetRequest]
|
2040
|
+
# @param [Hash] opts the optional parameters
|
2041
|
+
# @return [File]
|
2042
|
+
def credit_bank_income_pdf_get(credit_bank_income_pdf_get_request, opts = {})
|
2043
|
+
data, _status_code, _headers = credit_bank_income_pdf_get_with_http_info(credit_bank_income_pdf_get_request, opts)
|
2044
|
+
data
|
2045
|
+
end
|
2046
|
+
|
2047
|
+
# Retrieve information from the bank accounts used for income verification in PDF format
|
2048
|
+
# `/credit/bank_income/pdf/get` returns the most recent bank income report for a specified user in PDF format.
|
2049
|
+
# @param credit_bank_income_pdf_get_request [CreditBankIncomePDFGetRequest]
|
2050
|
+
# @param [Hash] opts the optional parameters
|
2051
|
+
# @return [Array<(File, Integer, Hash)>] File data, response status code and response headers
|
2052
|
+
def credit_bank_income_pdf_get_with_http_info(credit_bank_income_pdf_get_request, opts = {})
|
2053
|
+
if @api_client.config.debugging
|
2054
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.credit_bank_income_pdf_get ...'
|
2055
|
+
end
|
2056
|
+
# verify the required parameter 'credit_bank_income_pdf_get_request' is set
|
2057
|
+
if @api_client.config.client_side_validation && credit_bank_income_pdf_get_request.nil?
|
2058
|
+
fail ArgumentError, "Missing the required parameter 'credit_bank_income_pdf_get_request' when calling PlaidApi.credit_bank_income_pdf_get"
|
2059
|
+
end
|
2060
|
+
# resource path
|
2061
|
+
local_var_path = '/credit/bank_income/pdf/get'
|
2062
|
+
|
2063
|
+
# query parameters
|
2064
|
+
query_params = opts[:query_params] || {}
|
2065
|
+
|
2066
|
+
# header parameters
|
2067
|
+
header_params = opts[:header_params] || {}
|
2068
|
+
# HTTP header 'Accept' (if needed)
|
2069
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/pdf'])
|
2070
|
+
# HTTP header 'Content-Type'
|
2071
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
2072
|
+
|
2073
|
+
# form parameters
|
2074
|
+
form_params = opts[:form_params] || {}
|
2075
|
+
|
2076
|
+
# http body (model)
|
2077
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(credit_bank_income_pdf_get_request)
|
2078
|
+
|
2079
|
+
# return_type
|
2080
|
+
return_type = opts[:debug_return_type] || 'File'
|
2081
|
+
|
2082
|
+
# auth_names
|
2083
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
2084
|
+
|
2085
|
+
new_options = opts.merge(
|
2086
|
+
:operation => :"PlaidApi.credit_bank_income_pdf_get",
|
2087
|
+
:header_params => header_params,
|
2088
|
+
:query_params => query_params,
|
2089
|
+
:form_params => form_params,
|
2090
|
+
:body => post_body,
|
2091
|
+
:auth_names => auth_names,
|
2092
|
+
:return_type => return_type
|
2093
|
+
)
|
2094
|
+
|
2095
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
2096
|
+
if @api_client.config.debugging
|
2097
|
+
@api_client.config.logger.debug "API called: PlaidApi#credit_bank_income_pdf_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2098
|
+
end
|
2099
|
+
return data, status_code, headers
|
2100
|
+
end
|
2101
|
+
|
2037
2102
|
# Refresh a user's bank income information
|
2038
2103
|
# `/credit/bank_income/refresh` refreshes the bank income report data for a specific user.
|
2039
2104
|
# @param credit_bank_income_refresh_request [CreditBankIncomeRefreshRequest]
|
@@ -2424,6 +2489,266 @@ module Plaid
|
|
2424
2489
|
return data, status_code, headers
|
2425
2490
|
end
|
2426
2491
|
|
2492
|
+
# Retrieve the reports associated with a Relay token that was shared with you
|
2493
|
+
# `/credit/relay/get` allows third parties to get a report that was shared with them, using an `relay_token` that was created by the report owner.
|
2494
|
+
# @param credit_relay_get_request [CreditRelayGetRequest]
|
2495
|
+
# @param [Hash] opts the optional parameters
|
2496
|
+
# @return [AssetReportGetResponse]
|
2497
|
+
def credit_relay_get(credit_relay_get_request, opts = {})
|
2498
|
+
data, _status_code, _headers = credit_relay_get_with_http_info(credit_relay_get_request, opts)
|
2499
|
+
data
|
2500
|
+
end
|
2501
|
+
|
2502
|
+
# Retrieve the reports associated with a Relay token that was shared with you
|
2503
|
+
# `/credit/relay/get` allows third parties to get a report that was shared with them, using an `relay_token` that was created by the report owner.
|
2504
|
+
# @param credit_relay_get_request [CreditRelayGetRequest]
|
2505
|
+
# @param [Hash] opts the optional parameters
|
2506
|
+
# @return [Array<(AssetReportGetResponse, Integer, Hash)>] AssetReportGetResponse data, response status code and response headers
|
2507
|
+
def credit_relay_get_with_http_info(credit_relay_get_request, opts = {})
|
2508
|
+
if @api_client.config.debugging
|
2509
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.credit_relay_get ...'
|
2510
|
+
end
|
2511
|
+
# verify the required parameter 'credit_relay_get_request' is set
|
2512
|
+
if @api_client.config.client_side_validation && credit_relay_get_request.nil?
|
2513
|
+
fail ArgumentError, "Missing the required parameter 'credit_relay_get_request' when calling PlaidApi.credit_relay_get"
|
2514
|
+
end
|
2515
|
+
# resource path
|
2516
|
+
local_var_path = '/credit/relay/get'
|
2517
|
+
|
2518
|
+
# query parameters
|
2519
|
+
query_params = opts[:query_params] || {}
|
2520
|
+
|
2521
|
+
# header parameters
|
2522
|
+
header_params = opts[:header_params] || {}
|
2523
|
+
# HTTP header 'Accept' (if needed)
|
2524
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
2525
|
+
# HTTP header 'Content-Type'
|
2526
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
2527
|
+
|
2528
|
+
# form parameters
|
2529
|
+
form_params = opts[:form_params] || {}
|
2530
|
+
|
2531
|
+
# http body (model)
|
2532
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(credit_relay_get_request)
|
2533
|
+
|
2534
|
+
# return_type
|
2535
|
+
return_type = opts[:debug_return_type] || 'AssetReportGetResponse'
|
2536
|
+
|
2537
|
+
# auth_names
|
2538
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
2539
|
+
|
2540
|
+
new_options = opts.merge(
|
2541
|
+
:operation => :"PlaidApi.credit_relay_get",
|
2542
|
+
:header_params => header_params,
|
2543
|
+
:query_params => query_params,
|
2544
|
+
:form_params => form_params,
|
2545
|
+
:body => post_body,
|
2546
|
+
:auth_names => auth_names,
|
2547
|
+
:return_type => return_type
|
2548
|
+
)
|
2549
|
+
|
2550
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
2551
|
+
if @api_client.config.debugging
|
2552
|
+
@api_client.config.logger.debug "API called: PlaidApi#credit_relay_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2553
|
+
end
|
2554
|
+
return data, status_code, headers
|
2555
|
+
end
|
2556
|
+
|
2557
|
+
# Refresh a report of a Relay Token
|
2558
|
+
# The `/credit/relay/refresh` endpoint allows third parties to refresh an report that was relayed to them, using a `relay_token` that was created by the report owner. A new report will be created based on the old one, but with the most recent data available.
|
2559
|
+
# @param credit_relay_refresh_request [CreditRelayRefreshRequest]
|
2560
|
+
# @param [Hash] opts the optional parameters
|
2561
|
+
# @return [CreditRelayRefreshResponse]
|
2562
|
+
def credit_relay_refresh(credit_relay_refresh_request, opts = {})
|
2563
|
+
data, _status_code, _headers = credit_relay_refresh_with_http_info(credit_relay_refresh_request, opts)
|
2564
|
+
data
|
2565
|
+
end
|
2566
|
+
|
2567
|
+
# Refresh a report of a Relay Token
|
2568
|
+
# The `/credit/relay/refresh` endpoint allows third parties to refresh an report that was relayed to them, using a `relay_token` that was created by the report owner. A new report will be created based on the old one, but with the most recent data available.
|
2569
|
+
# @param credit_relay_refresh_request [CreditRelayRefreshRequest]
|
2570
|
+
# @param [Hash] opts the optional parameters
|
2571
|
+
# @return [Array<(CreditRelayRefreshResponse, Integer, Hash)>] CreditRelayRefreshResponse data, response status code and response headers
|
2572
|
+
def credit_relay_refresh_with_http_info(credit_relay_refresh_request, opts = {})
|
2573
|
+
if @api_client.config.debugging
|
2574
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.credit_relay_refresh ...'
|
2575
|
+
end
|
2576
|
+
# verify the required parameter 'credit_relay_refresh_request' is set
|
2577
|
+
if @api_client.config.client_side_validation && credit_relay_refresh_request.nil?
|
2578
|
+
fail ArgumentError, "Missing the required parameter 'credit_relay_refresh_request' when calling PlaidApi.credit_relay_refresh"
|
2579
|
+
end
|
2580
|
+
# resource path
|
2581
|
+
local_var_path = '/credit/relay/refresh'
|
2582
|
+
|
2583
|
+
# query parameters
|
2584
|
+
query_params = opts[:query_params] || {}
|
2585
|
+
|
2586
|
+
# header parameters
|
2587
|
+
header_params = opts[:header_params] || {}
|
2588
|
+
# HTTP header 'Accept' (if needed)
|
2589
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
2590
|
+
# HTTP header 'Content-Type'
|
2591
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
2592
|
+
|
2593
|
+
# form parameters
|
2594
|
+
form_params = opts[:form_params] || {}
|
2595
|
+
|
2596
|
+
# http body (model)
|
2597
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(credit_relay_refresh_request)
|
2598
|
+
|
2599
|
+
# return_type
|
2600
|
+
return_type = opts[:debug_return_type] || 'CreditRelayRefreshResponse'
|
2601
|
+
|
2602
|
+
# auth_names
|
2603
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
2604
|
+
|
2605
|
+
new_options = opts.merge(
|
2606
|
+
:operation => :"PlaidApi.credit_relay_refresh",
|
2607
|
+
:header_params => header_params,
|
2608
|
+
:query_params => query_params,
|
2609
|
+
:form_params => form_params,
|
2610
|
+
:body => post_body,
|
2611
|
+
:auth_names => auth_names,
|
2612
|
+
:return_type => return_type
|
2613
|
+
)
|
2614
|
+
|
2615
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
2616
|
+
if @api_client.config.debugging
|
2617
|
+
@api_client.config.logger.debug "API called: PlaidApi#credit_relay_refresh\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2618
|
+
end
|
2619
|
+
return data, status_code, headers
|
2620
|
+
end
|
2621
|
+
|
2622
|
+
# Remove Credit Relay Token
|
2623
|
+
# The `/credit/relay/remove` endpoint allows you to invalidate a `relay_token`, meaning the third party holding the token will no longer be able to use it to access the reports to which the `relay_token` gives access to. The report, items associated with it, and other Relay tokens that provide access to the same report are not affected and will remain accessible after removing the given `relay_token.
|
2624
|
+
# @param credit_relay_remove_request [CreditRelayRemoveRequest]
|
2625
|
+
# @param [Hash] opts the optional parameters
|
2626
|
+
# @return [CreditRelayRemoveResponse]
|
2627
|
+
def credit_relay_remove(credit_relay_remove_request, opts = {})
|
2628
|
+
data, _status_code, _headers = credit_relay_remove_with_http_info(credit_relay_remove_request, opts)
|
2629
|
+
data
|
2630
|
+
end
|
2631
|
+
|
2632
|
+
# Remove Credit Relay Token
|
2633
|
+
# The `/credit/relay/remove` endpoint allows you to invalidate a `relay_token`, meaning the third party holding the token will no longer be able to use it to access the reports to which the `relay_token` gives access to. The report, items associated with it, and other Relay tokens that provide access to the same report are not affected and will remain accessible after removing the given `relay_token.
|
2634
|
+
# @param credit_relay_remove_request [CreditRelayRemoveRequest]
|
2635
|
+
# @param [Hash] opts the optional parameters
|
2636
|
+
# @return [Array<(CreditRelayRemoveResponse, Integer, Hash)>] CreditRelayRemoveResponse data, response status code and response headers
|
2637
|
+
def credit_relay_remove_with_http_info(credit_relay_remove_request, opts = {})
|
2638
|
+
if @api_client.config.debugging
|
2639
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.credit_relay_remove ...'
|
2640
|
+
end
|
2641
|
+
# verify the required parameter 'credit_relay_remove_request' is set
|
2642
|
+
if @api_client.config.client_side_validation && credit_relay_remove_request.nil?
|
2643
|
+
fail ArgumentError, "Missing the required parameter 'credit_relay_remove_request' when calling PlaidApi.credit_relay_remove"
|
2644
|
+
end
|
2645
|
+
# resource path
|
2646
|
+
local_var_path = '/credit/relay/remove'
|
2647
|
+
|
2648
|
+
# query parameters
|
2649
|
+
query_params = opts[:query_params] || {}
|
2650
|
+
|
2651
|
+
# header parameters
|
2652
|
+
header_params = opts[:header_params] || {}
|
2653
|
+
# HTTP header 'Accept' (if needed)
|
2654
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
2655
|
+
# HTTP header 'Content-Type'
|
2656
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
2657
|
+
|
2658
|
+
# form parameters
|
2659
|
+
form_params = opts[:form_params] || {}
|
2660
|
+
|
2661
|
+
# http body (model)
|
2662
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(credit_relay_remove_request)
|
2663
|
+
|
2664
|
+
# return_type
|
2665
|
+
return_type = opts[:debug_return_type] || 'CreditRelayRemoveResponse'
|
2666
|
+
|
2667
|
+
# auth_names
|
2668
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
2669
|
+
|
2670
|
+
new_options = opts.merge(
|
2671
|
+
:operation => :"PlaidApi.credit_relay_remove",
|
2672
|
+
:header_params => header_params,
|
2673
|
+
:query_params => query_params,
|
2674
|
+
:form_params => form_params,
|
2675
|
+
:body => post_body,
|
2676
|
+
:auth_names => auth_names,
|
2677
|
+
:return_type => return_type
|
2678
|
+
)
|
2679
|
+
|
2680
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
2681
|
+
if @api_client.config.debugging
|
2682
|
+
@api_client.config.logger.debug "API called: PlaidApi#credit_relay_remove\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2683
|
+
end
|
2684
|
+
return data, status_code, headers
|
2685
|
+
end
|
2686
|
+
|
2687
|
+
# Remove an Audit Copy token
|
2688
|
+
# The `/credit/audit_copy_token/remove` endpoint allows you to remove an Audit Copy. Removing an Audit Copy invalidates the `audit_copy_token` associated with it, meaning both you and any third parties holding the token will no longer be able to use it to access Report data. Items associated with the Report data and other Audit Copies of it are not affected and will remain accessible after removing the given Audit Copy.
|
2689
|
+
# @param credit_audit_copy_token_remove_request [CreditAuditCopyTokenRemoveRequest]
|
2690
|
+
# @param [Hash] opts the optional parameters
|
2691
|
+
# @return [CreditAuditCopyTokenRemoveResponse]
|
2692
|
+
def credit_report_audit_copy_remove(credit_audit_copy_token_remove_request, opts = {})
|
2693
|
+
data, _status_code, _headers = credit_report_audit_copy_remove_with_http_info(credit_audit_copy_token_remove_request, opts)
|
2694
|
+
data
|
2695
|
+
end
|
2696
|
+
|
2697
|
+
# Remove an Audit Copy token
|
2698
|
+
# The `/credit/audit_copy_token/remove` endpoint allows you to remove an Audit Copy. Removing an Audit Copy invalidates the `audit_copy_token` associated with it, meaning both you and any third parties holding the token will no longer be able to use it to access Report data. Items associated with the Report data and other Audit Copies of it are not affected and will remain accessible after removing the given Audit Copy.
|
2699
|
+
# @param credit_audit_copy_token_remove_request [CreditAuditCopyTokenRemoveRequest]
|
2700
|
+
# @param [Hash] opts the optional parameters
|
2701
|
+
# @return [Array<(CreditAuditCopyTokenRemoveResponse, Integer, Hash)>] CreditAuditCopyTokenRemoveResponse data, response status code and response headers
|
2702
|
+
def credit_report_audit_copy_remove_with_http_info(credit_audit_copy_token_remove_request, opts = {})
|
2703
|
+
if @api_client.config.debugging
|
2704
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.credit_report_audit_copy_remove ...'
|
2705
|
+
end
|
2706
|
+
# verify the required parameter 'credit_audit_copy_token_remove_request' is set
|
2707
|
+
if @api_client.config.client_side_validation && credit_audit_copy_token_remove_request.nil?
|
2708
|
+
fail ArgumentError, "Missing the required parameter 'credit_audit_copy_token_remove_request' when calling PlaidApi.credit_report_audit_copy_remove"
|
2709
|
+
end
|
2710
|
+
# resource path
|
2711
|
+
local_var_path = '/credit/audit_copy_token/remove'
|
2712
|
+
|
2713
|
+
# query parameters
|
2714
|
+
query_params = opts[:query_params] || {}
|
2715
|
+
|
2716
|
+
# header parameters
|
2717
|
+
header_params = opts[:header_params] || {}
|
2718
|
+
# HTTP header 'Accept' (if needed)
|
2719
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
2720
|
+
# HTTP header 'Content-Type'
|
2721
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
2722
|
+
|
2723
|
+
# form parameters
|
2724
|
+
form_params = opts[:form_params] || {}
|
2725
|
+
|
2726
|
+
# http body (model)
|
2727
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(credit_audit_copy_token_remove_request)
|
2728
|
+
|
2729
|
+
# return_type
|
2730
|
+
return_type = opts[:debug_return_type] || 'CreditAuditCopyTokenRemoveResponse'
|
2731
|
+
|
2732
|
+
# auth_names
|
2733
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
2734
|
+
|
2735
|
+
new_options = opts.merge(
|
2736
|
+
:operation => :"PlaidApi.credit_report_audit_copy_remove",
|
2737
|
+
:header_params => header_params,
|
2738
|
+
:query_params => query_params,
|
2739
|
+
:form_params => form_params,
|
2740
|
+
:body => post_body,
|
2741
|
+
:auth_names => auth_names,
|
2742
|
+
:return_type => return_type
|
2743
|
+
)
|
2744
|
+
|
2745
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
2746
|
+
if @api_client.config.debugging
|
2747
|
+
@api_client.config.logger.debug "API called: PlaidApi#credit_report_audit_copy_remove\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2748
|
+
end
|
2749
|
+
return data, status_code, headers
|
2750
|
+
end
|
2751
|
+
|
2427
2752
|
# List dashboard users
|
2428
2753
|
# List all dashboard users associated with your account.
|
2429
2754
|
# @param list_dashboard_user_request [ListDashboardUserRequest]
|
@@ -3009,6 +3334,71 @@ module Plaid
|
|
3009
3334
|
return data, status_code, headers
|
3010
3335
|
end
|
3011
3336
|
|
3337
|
+
# Retrieve identity match score
|
3338
|
+
# 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. This request may take some time to complete if Identity was not specified as an initial product when creating the Item. This is because Plaid must communicate directly with the institution to retrieve the data.
|
3339
|
+
# @param identity_match_request [IdentityMatchRequest]
|
3340
|
+
# @param [Hash] opts the optional parameters
|
3341
|
+
# @return [IdentityMatchResponse]
|
3342
|
+
def identity_match(identity_match_request, opts = {})
|
3343
|
+
data, _status_code, _headers = identity_match_with_http_info(identity_match_request, opts)
|
3344
|
+
data
|
3345
|
+
end
|
3346
|
+
|
3347
|
+
# Retrieve identity match score
|
3348
|
+
# 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. This request may take some time to complete if Identity was not specified as an initial product when creating the Item. This is because Plaid must communicate directly with the institution to retrieve the data.
|
3349
|
+
# @param identity_match_request [IdentityMatchRequest]
|
3350
|
+
# @param [Hash] opts the optional parameters
|
3351
|
+
# @return [Array<(IdentityMatchResponse, Integer, Hash)>] IdentityMatchResponse data, response status code and response headers
|
3352
|
+
def identity_match_with_http_info(identity_match_request, opts = {})
|
3353
|
+
if @api_client.config.debugging
|
3354
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.identity_match ...'
|
3355
|
+
end
|
3356
|
+
# verify the required parameter 'identity_match_request' is set
|
3357
|
+
if @api_client.config.client_side_validation && identity_match_request.nil?
|
3358
|
+
fail ArgumentError, "Missing the required parameter 'identity_match_request' when calling PlaidApi.identity_match"
|
3359
|
+
end
|
3360
|
+
# resource path
|
3361
|
+
local_var_path = '/identity/match'
|
3362
|
+
|
3363
|
+
# query parameters
|
3364
|
+
query_params = opts[:query_params] || {}
|
3365
|
+
|
3366
|
+
# header parameters
|
3367
|
+
header_params = opts[:header_params] || {}
|
3368
|
+
# HTTP header 'Accept' (if needed)
|
3369
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
3370
|
+
# HTTP header 'Content-Type'
|
3371
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
3372
|
+
|
3373
|
+
# form parameters
|
3374
|
+
form_params = opts[:form_params] || {}
|
3375
|
+
|
3376
|
+
# http body (model)
|
3377
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(identity_match_request)
|
3378
|
+
|
3379
|
+
# return_type
|
3380
|
+
return_type = opts[:debug_return_type] || 'IdentityMatchResponse'
|
3381
|
+
|
3382
|
+
# auth_names
|
3383
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
3384
|
+
|
3385
|
+
new_options = opts.merge(
|
3386
|
+
:operation => :"PlaidApi.identity_match",
|
3387
|
+
:header_params => header_params,
|
3388
|
+
:query_params => query_params,
|
3389
|
+
:form_params => form_params,
|
3390
|
+
:body => post_body,
|
3391
|
+
:auth_names => auth_names,
|
3392
|
+
:return_type => return_type
|
3393
|
+
)
|
3394
|
+
|
3395
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
3396
|
+
if @api_client.config.debugging
|
3397
|
+
@api_client.config.logger.debug "API called: PlaidApi#identity_match\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
3398
|
+
end
|
3399
|
+
return data, status_code, headers
|
3400
|
+
end
|
3401
|
+
|
3012
3402
|
# Create a new identity verification
|
3013
3403
|
# Create a new Identity Verification for the user specified by the `client_user_id` field. The requirements and behavior of the verification are determined by the `template_id` provided. If you don't know whether the associated user already has an active Identity Verification, you can specify `\"is_idempotent\": true` in the request body. With idempotency enabled, a new Identity Verification will only be created if one does not already exist for the associated `client_user_id` and `template_id`. If an Identity Verification is found, it will be returned unmodified with an `200 OK` HTTP status code.
|
3014
3404
|
# @param identity_verification_create_request [IdentityVerificationCreateRequest]
|
@@ -3400,7 +3790,7 @@ module Plaid
|
|
3400
3790
|
end
|
3401
3791
|
|
3402
3792
|
# (Deprecated) Retrieve information from the paystubs used for income verification
|
3403
|
-
# `/income/verification/paystubs/get` returns the information collected from the paystubs that were used to verify an end user'
|
3793
|
+
# `/income/verification/paystubs/get` returns the information collected from the paystubs that were used to verify an end user's income. It can be called once the status of the verification has been set to `VERIFICATION_STATUS_PROCESSING_COMPLETE`, as reported by the `INCOME: verification_status` webhook. Attempting to call the endpoint before verification has been completed will result in an error. This endpoint has been deprecated; new integrations should use `/credit/payroll_income/get` instead.
|
3404
3794
|
# @param income_verification_paystubs_get_request [IncomeVerificationPaystubsGetRequest]
|
3405
3795
|
# @param [Hash] opts the optional parameters
|
3406
3796
|
# @return [IncomeVerificationPaystubsGetResponse]
|
@@ -3410,7 +3800,7 @@ module Plaid
|
|
3410
3800
|
end
|
3411
3801
|
|
3412
3802
|
# (Deprecated) Retrieve information from the paystubs used for income verification
|
3413
|
-
# `/income/verification/paystubs/get` returns the information collected from the paystubs that were used to verify an end user'
|
3803
|
+
# `/income/verification/paystubs/get` returns the information collected from the paystubs that were used to verify an end user's income. It can be called once the status of the verification has been set to `VERIFICATION_STATUS_PROCESSING_COMPLETE`, as reported by the `INCOME: verification_status` webhook. Attempting to call the endpoint before verification has been completed will result in an error. This endpoint has been deprecated; new integrations should use `/credit/payroll_income/get` instead.
|
3414
3804
|
# @param income_verification_paystubs_get_request [IncomeVerificationPaystubsGetRequest]
|
3415
3805
|
# @param [Hash] opts the optional parameters
|
3416
3806
|
# @return [Array<(IncomeVerificationPaystubsGetResponse, Integer, Hash)>] IncomeVerificationPaystubsGetResponse data, response status code and response headers
|
@@ -4764,6 +5154,71 @@ module Plaid
|
|
4764
5154
|
return data, status_code, headers
|
4765
5155
|
end
|
4766
5156
|
|
5157
|
+
# Creates a new client for a reseller partner end customer.
|
5158
|
+
# The `/partner/v1/customers/create` endpoint is used by reseller partners to create an end customer client.
|
5159
|
+
# @param partner_customers_create_request [PartnerCustomersCreateRequest]
|
5160
|
+
# @param [Hash] opts the optional parameters
|
5161
|
+
# @return [PartnerCustomersCreateResponse]
|
5162
|
+
def partner_customers_create(partner_customers_create_request, opts = {})
|
5163
|
+
data, _status_code, _headers = partner_customers_create_with_http_info(partner_customers_create_request, opts)
|
5164
|
+
data
|
5165
|
+
end
|
5166
|
+
|
5167
|
+
# Creates a new client for a reseller partner end customer.
|
5168
|
+
# The `/partner/v1/customers/create` endpoint is used by reseller partners to create an end customer client.
|
5169
|
+
# @param partner_customers_create_request [PartnerCustomersCreateRequest]
|
5170
|
+
# @param [Hash] opts the optional parameters
|
5171
|
+
# @return [Array<(PartnerCustomersCreateResponse, Integer, Hash)>] PartnerCustomersCreateResponse data, response status code and response headers
|
5172
|
+
def partner_customers_create_with_http_info(partner_customers_create_request, opts = {})
|
5173
|
+
if @api_client.config.debugging
|
5174
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.partner_customers_create ...'
|
5175
|
+
end
|
5176
|
+
# verify the required parameter 'partner_customers_create_request' is set
|
5177
|
+
if @api_client.config.client_side_validation && partner_customers_create_request.nil?
|
5178
|
+
fail ArgumentError, "Missing the required parameter 'partner_customers_create_request' when calling PlaidApi.partner_customers_create"
|
5179
|
+
end
|
5180
|
+
# resource path
|
5181
|
+
local_var_path = '/beta/partner/v1/customers/create'
|
5182
|
+
|
5183
|
+
# query parameters
|
5184
|
+
query_params = opts[:query_params] || {}
|
5185
|
+
|
5186
|
+
# header parameters
|
5187
|
+
header_params = opts[:header_params] || {}
|
5188
|
+
# HTTP header 'Accept' (if needed)
|
5189
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
5190
|
+
# HTTP header 'Content-Type'
|
5191
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
5192
|
+
|
5193
|
+
# form parameters
|
5194
|
+
form_params = opts[:form_params] || {}
|
5195
|
+
|
5196
|
+
# http body (model)
|
5197
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(partner_customers_create_request)
|
5198
|
+
|
5199
|
+
# return_type
|
5200
|
+
return_type = opts[:debug_return_type] || 'PartnerCustomersCreateResponse'
|
5201
|
+
|
5202
|
+
# auth_names
|
5203
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
5204
|
+
|
5205
|
+
new_options = opts.merge(
|
5206
|
+
:operation => :"PlaidApi.partner_customers_create",
|
5207
|
+
:header_params => header_params,
|
5208
|
+
:query_params => query_params,
|
5209
|
+
:form_params => form_params,
|
5210
|
+
:body => post_body,
|
5211
|
+
:auth_names => auth_names,
|
5212
|
+
:return_type => return_type
|
5213
|
+
)
|
5214
|
+
|
5215
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
5216
|
+
if @api_client.config.debugging
|
5217
|
+
@api_client.config.logger.debug "API called: PlaidApi#partner_customers_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
5218
|
+
end
|
5219
|
+
return data, status_code, headers
|
5220
|
+
end
|
5221
|
+
|
4767
5222
|
# Create payment consent
|
4768
5223
|
# The `/payment_initiation/consent/create` endpoint is used to create a payment consent, which can be used to initiate payments on behalf of the user. Payment consents are created with `UNAUTHORISED` status by default and must be authorised by the user before payments can be initiated. Consents can be limited in time and scope, and have constraints that describe limitations for payments.
|
4769
5224
|
# @param payment_initiation_consent_create_request [PaymentInitiationConsentCreateRequest]
|
@@ -5479,6 +5934,201 @@ module Plaid
|
|
5479
5934
|
return data, status_code, headers
|
5480
5935
|
end
|
5481
5936
|
|
5937
|
+
# Create payment profile
|
5938
|
+
# Use `/payment_profile/create` endpoint to create a new payment profile, the return value is a Payment Profile ID. Attach it to the link token create request and the link workflow will then \"activate\" this Payment Profile if the linkage is successful. It can then be used to create Transfers using `/transfer/authorization/create` and /transfer/create`.
|
5939
|
+
# @param payment_profile_create_request [PaymentProfileCreateRequest]
|
5940
|
+
# @param [Hash] opts the optional parameters
|
5941
|
+
# @return [PaymentProfileCreateResponse]
|
5942
|
+
def payment_profile_create(payment_profile_create_request, opts = {})
|
5943
|
+
data, _status_code, _headers = payment_profile_create_with_http_info(payment_profile_create_request, opts)
|
5944
|
+
data
|
5945
|
+
end
|
5946
|
+
|
5947
|
+
# Create payment profile
|
5948
|
+
# Use `/payment_profile/create` endpoint to create a new payment profile, the return value is a Payment Profile ID. Attach it to the link token create request and the link workflow will then \"activate\" this Payment Profile if the linkage is successful. It can then be used to create Transfers using `/transfer/authorization/create` and /transfer/create`.
|
5949
|
+
# @param payment_profile_create_request [PaymentProfileCreateRequest]
|
5950
|
+
# @param [Hash] opts the optional parameters
|
5951
|
+
# @return [Array<(PaymentProfileCreateResponse, Integer, Hash)>] PaymentProfileCreateResponse data, response status code and response headers
|
5952
|
+
def payment_profile_create_with_http_info(payment_profile_create_request, opts = {})
|
5953
|
+
if @api_client.config.debugging
|
5954
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.payment_profile_create ...'
|
5955
|
+
end
|
5956
|
+
# verify the required parameter 'payment_profile_create_request' is set
|
5957
|
+
if @api_client.config.client_side_validation && payment_profile_create_request.nil?
|
5958
|
+
fail ArgumentError, "Missing the required parameter 'payment_profile_create_request' when calling PlaidApi.payment_profile_create"
|
5959
|
+
end
|
5960
|
+
# resource path
|
5961
|
+
local_var_path = '/payment_profile/create'
|
5962
|
+
|
5963
|
+
# query parameters
|
5964
|
+
query_params = opts[:query_params] || {}
|
5965
|
+
|
5966
|
+
# header parameters
|
5967
|
+
header_params = opts[:header_params] || {}
|
5968
|
+
# HTTP header 'Accept' (if needed)
|
5969
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
5970
|
+
# HTTP header 'Content-Type'
|
5971
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
5972
|
+
|
5973
|
+
# form parameters
|
5974
|
+
form_params = opts[:form_params] || {}
|
5975
|
+
|
5976
|
+
# http body (model)
|
5977
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(payment_profile_create_request)
|
5978
|
+
|
5979
|
+
# return_type
|
5980
|
+
return_type = opts[:debug_return_type] || 'PaymentProfileCreateResponse'
|
5981
|
+
|
5982
|
+
# auth_names
|
5983
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
5984
|
+
|
5985
|
+
new_options = opts.merge(
|
5986
|
+
:operation => :"PlaidApi.payment_profile_create",
|
5987
|
+
:header_params => header_params,
|
5988
|
+
:query_params => query_params,
|
5989
|
+
:form_params => form_params,
|
5990
|
+
:body => post_body,
|
5991
|
+
:auth_names => auth_names,
|
5992
|
+
:return_type => return_type
|
5993
|
+
)
|
5994
|
+
|
5995
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
5996
|
+
if @api_client.config.debugging
|
5997
|
+
@api_client.config.logger.debug "API called: PlaidApi#payment_profile_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
5998
|
+
end
|
5999
|
+
return data, status_code, headers
|
6000
|
+
end
|
6001
|
+
|
6002
|
+
# Get payment profile
|
6003
|
+
# Use the `/payment_profile/get` endpoint to get the status of a given Payment Profile.
|
6004
|
+
# @param payment_profile_get_request [PaymentProfileGetRequest]
|
6005
|
+
# @param [Hash] opts the optional parameters
|
6006
|
+
# @return [PaymentProfileGetResponse]
|
6007
|
+
def payment_profile_get(payment_profile_get_request, opts = {})
|
6008
|
+
data, _status_code, _headers = payment_profile_get_with_http_info(payment_profile_get_request, opts)
|
6009
|
+
data
|
6010
|
+
end
|
6011
|
+
|
6012
|
+
# Get payment profile
|
6013
|
+
# Use the `/payment_profile/get` endpoint to get the status of a given Payment Profile.
|
6014
|
+
# @param payment_profile_get_request [PaymentProfileGetRequest]
|
6015
|
+
# @param [Hash] opts the optional parameters
|
6016
|
+
# @return [Array<(PaymentProfileGetResponse, Integer, Hash)>] PaymentProfileGetResponse data, response status code and response headers
|
6017
|
+
def payment_profile_get_with_http_info(payment_profile_get_request, opts = {})
|
6018
|
+
if @api_client.config.debugging
|
6019
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.payment_profile_get ...'
|
6020
|
+
end
|
6021
|
+
# verify the required parameter 'payment_profile_get_request' is set
|
6022
|
+
if @api_client.config.client_side_validation && payment_profile_get_request.nil?
|
6023
|
+
fail ArgumentError, "Missing the required parameter 'payment_profile_get_request' when calling PlaidApi.payment_profile_get"
|
6024
|
+
end
|
6025
|
+
# resource path
|
6026
|
+
local_var_path = '/payment_profile/get'
|
6027
|
+
|
6028
|
+
# query parameters
|
6029
|
+
query_params = opts[:query_params] || {}
|
6030
|
+
|
6031
|
+
# header parameters
|
6032
|
+
header_params = opts[:header_params] || {}
|
6033
|
+
# HTTP header 'Accept' (if needed)
|
6034
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
6035
|
+
# HTTP header 'Content-Type'
|
6036
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
6037
|
+
|
6038
|
+
# form parameters
|
6039
|
+
form_params = opts[:form_params] || {}
|
6040
|
+
|
6041
|
+
# http body (model)
|
6042
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(payment_profile_get_request)
|
6043
|
+
|
6044
|
+
# return_type
|
6045
|
+
return_type = opts[:debug_return_type] || 'PaymentProfileGetResponse'
|
6046
|
+
|
6047
|
+
# auth_names
|
6048
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
6049
|
+
|
6050
|
+
new_options = opts.merge(
|
6051
|
+
:operation => :"PlaidApi.payment_profile_get",
|
6052
|
+
:header_params => header_params,
|
6053
|
+
:query_params => query_params,
|
6054
|
+
:form_params => form_params,
|
6055
|
+
:body => post_body,
|
6056
|
+
:auth_names => auth_names,
|
6057
|
+
:return_type => return_type
|
6058
|
+
)
|
6059
|
+
|
6060
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
6061
|
+
if @api_client.config.debugging
|
6062
|
+
@api_client.config.logger.debug "API called: PlaidApi#payment_profile_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
6063
|
+
end
|
6064
|
+
return data, status_code, headers
|
6065
|
+
end
|
6066
|
+
|
6067
|
+
# Remove payment profile
|
6068
|
+
# Use the `/payment_profile/remove` endpoint to remove a given Payment Profile. Once it’s removed, it can no longer be used to create transfers.
|
6069
|
+
# @param payment_profile_remove_request [PaymentProfileRemoveRequest]
|
6070
|
+
# @param [Hash] opts the optional parameters
|
6071
|
+
# @return [PaymentProfileRemoveResponse]
|
6072
|
+
def payment_profile_remove(payment_profile_remove_request, opts = {})
|
6073
|
+
data, _status_code, _headers = payment_profile_remove_with_http_info(payment_profile_remove_request, opts)
|
6074
|
+
data
|
6075
|
+
end
|
6076
|
+
|
6077
|
+
# Remove payment profile
|
6078
|
+
# Use the `/payment_profile/remove` endpoint to remove a given Payment Profile. Once it’s removed, it can no longer be used to create transfers.
|
6079
|
+
# @param payment_profile_remove_request [PaymentProfileRemoveRequest]
|
6080
|
+
# @param [Hash] opts the optional parameters
|
6081
|
+
# @return [Array<(PaymentProfileRemoveResponse, Integer, Hash)>] PaymentProfileRemoveResponse data, response status code and response headers
|
6082
|
+
def payment_profile_remove_with_http_info(payment_profile_remove_request, opts = {})
|
6083
|
+
if @api_client.config.debugging
|
6084
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.payment_profile_remove ...'
|
6085
|
+
end
|
6086
|
+
# verify the required parameter 'payment_profile_remove_request' is set
|
6087
|
+
if @api_client.config.client_side_validation && payment_profile_remove_request.nil?
|
6088
|
+
fail ArgumentError, "Missing the required parameter 'payment_profile_remove_request' when calling PlaidApi.payment_profile_remove"
|
6089
|
+
end
|
6090
|
+
# resource path
|
6091
|
+
local_var_path = '/payment_profile/remove'
|
6092
|
+
|
6093
|
+
# query parameters
|
6094
|
+
query_params = opts[:query_params] || {}
|
6095
|
+
|
6096
|
+
# header parameters
|
6097
|
+
header_params = opts[:header_params] || {}
|
6098
|
+
# HTTP header 'Accept' (if needed)
|
6099
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
6100
|
+
# HTTP header 'Content-Type'
|
6101
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
6102
|
+
|
6103
|
+
# form parameters
|
6104
|
+
form_params = opts[:form_params] || {}
|
6105
|
+
|
6106
|
+
# http body (model)
|
6107
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(payment_profile_remove_request)
|
6108
|
+
|
6109
|
+
# return_type
|
6110
|
+
return_type = opts[:debug_return_type] || 'PaymentProfileRemoveResponse'
|
6111
|
+
|
6112
|
+
# auth_names
|
6113
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
6114
|
+
|
6115
|
+
new_options = opts.merge(
|
6116
|
+
:operation => :"PlaidApi.payment_profile_remove",
|
6117
|
+
:header_params => header_params,
|
6118
|
+
:query_params => query_params,
|
6119
|
+
:form_params => form_params,
|
6120
|
+
:body => post_body,
|
6121
|
+
:auth_names => auth_names,
|
6122
|
+
:return_type => return_type
|
6123
|
+
)
|
6124
|
+
|
6125
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
6126
|
+
if @api_client.config.debugging
|
6127
|
+
@api_client.config.logger.debug "API called: PlaidApi#payment_profile_remove\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
6128
|
+
end
|
6129
|
+
return data, status_code, headers
|
6130
|
+
end
|
6131
|
+
|
5482
6132
|
# Create Apex bank account token
|
5483
6133
|
# Used to create a token suitable for sending to Apex to enable Plaid-Apex integrations.
|
5484
6134
|
# @param processor_apex_processor_token_create_request [ProcessorApexProcessorTokenCreateRequest]
|
@@ -6130,7 +6780,7 @@ module Plaid
|
|
6130
6780
|
end
|
6131
6781
|
|
6132
6782
|
# Fire a test webhook
|
6133
|
-
# The `/sandbox/item/fire_webhook` endpoint is used to test that code correctly handles webhooks. This endpoint can trigger the following webhooks: `DEFAULT_UPDATE`: Transactions update webhook to be fired for a given Sandbox Item. If the Item does not support Transactions, a `SANDBOX_PRODUCT_NOT_ENABLED` error will result. `NEW_ACCOUNTS_AVAILABLE`: Webhook to be fired for a given Sandbox Item created with Account Select v2. `AUTH_DATA_UPDATE`: Webhook to be fired for a given Sandbox Item created with Auth as an enabled product. 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 or Development
|
6783
|
+
# The `/sandbox/item/fire_webhook` endpoint is used to test that code correctly handles webhooks. This endpoint can trigger the following webhooks: `DEFAULT_UPDATE`: Transactions update webhook to be fired for a given Sandbox Item. If the Item does not support Transactions, a `SANDBOX_PRODUCT_NOT_ENABLED` error will result. `NEW_ACCOUNTS_AVAILABLE`: Webhook to be fired for a given Sandbox Item created with Account Select v2. `AUTH_DATA_UPDATE`: Webhook to be fired for a given Sandbox Item created with Auth as an enabled product. `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. 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 or Development.
|
6134
6784
|
# @param sandbox_item_fire_webhook_request [SandboxItemFireWebhookRequest]
|
6135
6785
|
# @param [Hash] opts the optional parameters
|
6136
6786
|
# @return [SandboxItemFireWebhookResponse]
|
@@ -6140,7 +6790,7 @@ module Plaid
|
|
6140
6790
|
end
|
6141
6791
|
|
6142
6792
|
# Fire a test webhook
|
6143
|
-
# The `/sandbox/item/fire_webhook` endpoint is used to test that code correctly handles webhooks. This endpoint can trigger the following webhooks: `DEFAULT_UPDATE`: Transactions update webhook to be fired for a given Sandbox Item. If the Item does not support Transactions, a `SANDBOX_PRODUCT_NOT_ENABLED` error will result. `NEW_ACCOUNTS_AVAILABLE`: Webhook to be fired for a given Sandbox Item created with Account Select v2. `AUTH_DATA_UPDATE`: Webhook to be fired for a given Sandbox Item created with Auth as an enabled product. 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 or Development
|
6793
|
+
# The `/sandbox/item/fire_webhook` endpoint is used to test that code correctly handles webhooks. This endpoint can trigger the following webhooks: `DEFAULT_UPDATE`: Transactions update webhook to be fired for a given Sandbox Item. If the Item does not support Transactions, a `SANDBOX_PRODUCT_NOT_ENABLED` error will result. `NEW_ACCOUNTS_AVAILABLE`: Webhook to be fired for a given Sandbox Item created with Account Select v2. `AUTH_DATA_UPDATE`: Webhook to be fired for a given Sandbox Item created with Auth as an enabled product. `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. 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 or Development.
|
6144
6794
|
# @param sandbox_item_fire_webhook_request [SandboxItemFireWebhookRequest]
|
6145
6795
|
# @param [Hash] opts the optional parameters
|
6146
6796
|
# @return [Array<(SandboxItemFireWebhookResponse, Integer, Hash)>] SandboxItemFireWebhookResponse data, response status code and response headers
|
@@ -7495,7 +8145,7 @@ module Plaid
|
|
7495
8145
|
end
|
7496
8146
|
|
7497
8147
|
# Get incremental transaction updates on an Item
|
7498
|
-
# This endpoint replaces `/transactions/get` and its associated webhooks for most common use-cases. The `/transactions/sync` endpoint allows developers to subscribe to all transactions associated with an Item and get updates synchronously in a stream-like manner, using a cursor to track which updates have already been seen. `/transactions/sync` provides the same functionality as `/transactions/get` and can be used instead of `/transactions/get` to simplify the process of tracking transactions updates. This endpoint provides user-authorized transaction data for `credit`, `depository`, and some loan-type accounts (only those with account subtype `student`; coverage may be limited). For transaction history from `investments` accounts, use `/investments/transactions/get` instead. Returned transactions data is grouped into three types of update, indicating whether the transaction was added, removed, or modified since the last call to the API. In the first call to `/transactions/sync` for an Item, the endpoint will return all historical transactions data associated with that Item up until the time of the API call (as \"adds\"), which then generates a `
|
8148
|
+
# This endpoint replaces `/transactions/get` and its associated webhooks for most common use-cases. The `/transactions/sync` endpoint allows developers to subscribe to all transactions associated with an Item and get updates synchronously in a stream-like manner, using a cursor to track which updates have already been seen. `/transactions/sync` provides the same functionality as `/transactions/get` and can be used instead of `/transactions/get` to simplify the process of tracking transactions updates. This endpoint provides user-authorized transaction data for `credit`, `depository`, and some loan-type accounts (only those with account subtype `student`; coverage may be limited). For transaction history from `investments` accounts, use `/investments/transactions/get` instead. Returned transactions data is grouped into three types of update, indicating whether the transaction was added, removed, or modified since the last call to the API. In the first call to `/transactions/sync` for an Item, the endpoint will return all historical transactions data associated with that Item up until the time of the API call (as \"adds\"), which then generates a `next_cursor` for that Item. In subsequent calls, send the `next_cursor` to receive only the changes that have occurred since the previous call. Due to the potentially large number of transactions associated with an Item, results are paginated. The `has_more` field specifies if additional calls are necessary to fetch all available transaction updates. Whenever new or updated transaction data becomes available, `/transactions/sync` will provide these updates. Plaid typically checks for new data multiple times a day, but these checks may occur less frequently, such as once a day, depending on the institution. An Item's `status.transactions.last_successful_update` field will show the timestamp of the most recent successful update. To force Plaid to check for new transactions, use the `/transactions/refresh` endpoint. Note that for newly created Items, data may not be immediately available to `/transactions/sync`. Plaid begins preparing transactions data when the Item is created, but the process can take anywhere from a few seconds to several minutes to complete, depending on the number of transactions available. To be alerted when new data is available, listen for the [`SYNC_UPDATES_AVAILABLE`](https://plaid.com/docs/api/products/transactions/#sync_updates_available) webhook.
|
7499
8149
|
# @param transactions_sync_request [TransactionsSyncRequest]
|
7500
8150
|
# @param [Hash] opts the optional parameters
|
7501
8151
|
# @return [TransactionsSyncResponse]
|
@@ -7505,7 +8155,7 @@ module Plaid
|
|
7505
8155
|
end
|
7506
8156
|
|
7507
8157
|
# Get incremental transaction updates on an Item
|
7508
|
-
# This endpoint replaces `/transactions/get` and its associated webhooks for most common use-cases. The `/transactions/sync` endpoint allows developers to subscribe to all transactions associated with an Item and get updates synchronously in a stream-like manner, using a cursor to track which updates have already been seen. `/transactions/sync` provides the same functionality as `/transactions/get` and can be used instead of `/transactions/get` to simplify the process of tracking transactions updates. This endpoint provides user-authorized transaction data for `credit`, `depository`, and some loan-type accounts (only those with account subtype `student`; coverage may be limited). For transaction history from `investments` accounts, use `/investments/transactions/get` instead. Returned transactions data is grouped into three types of update, indicating whether the transaction was added, removed, or modified since the last call to the API. In the first call to `/transactions/sync` for an Item, the endpoint will return all historical transactions data associated with that Item up until the time of the API call (as \"adds\"), which then generates a `
|
8158
|
+
# This endpoint replaces `/transactions/get` and its associated webhooks for most common use-cases. The `/transactions/sync` endpoint allows developers to subscribe to all transactions associated with an Item and get updates synchronously in a stream-like manner, using a cursor to track which updates have already been seen. `/transactions/sync` provides the same functionality as `/transactions/get` and can be used instead of `/transactions/get` to simplify the process of tracking transactions updates. This endpoint provides user-authorized transaction data for `credit`, `depository`, and some loan-type accounts (only those with account subtype `student`; coverage may be limited). For transaction history from `investments` accounts, use `/investments/transactions/get` instead. Returned transactions data is grouped into three types of update, indicating whether the transaction was added, removed, or modified since the last call to the API. In the first call to `/transactions/sync` for an Item, the endpoint will return all historical transactions data associated with that Item up until the time of the API call (as \"adds\"), which then generates a `next_cursor` for that Item. In subsequent calls, send the `next_cursor` to receive only the changes that have occurred since the previous call. Due to the potentially large number of transactions associated with an Item, results are paginated. The `has_more` field specifies if additional calls are necessary to fetch all available transaction updates. Whenever new or updated transaction data becomes available, `/transactions/sync` will provide these updates. Plaid typically checks for new data multiple times a day, but these checks may occur less frequently, such as once a day, depending on the institution. An Item's `status.transactions.last_successful_update` field will show the timestamp of the most recent successful update. To force Plaid to check for new transactions, use the `/transactions/refresh` endpoint. Note that for newly created Items, data may not be immediately available to `/transactions/sync`. Plaid begins preparing transactions data when the Item is created, but the process can take anywhere from a few seconds to several minutes to complete, depending on the number of transactions available. To be alerted when new data is available, listen for the [`SYNC_UPDATES_AVAILABLE`](https://plaid.com/docs/api/products/transactions/#sync_updates_available) webhook.
|
7509
8159
|
# @param transactions_sync_request [TransactionsSyncRequest]
|
7510
8160
|
# @param [Hash] opts the optional parameters
|
7511
8161
|
# @return [Array<(TransactionsSyncResponse, Integer, Hash)>] TransactionsSyncResponse data, response status code and response headers
|
@@ -7560,7 +8210,7 @@ module Plaid
|
|
7560
8210
|
end
|
7561
8211
|
|
7562
8212
|
# Create a transfer authorization
|
7563
|
-
# Use the `/transfer/authorization/create` endpoint to determine transfer failure risk. In Plaid's sandbox environment the decisions will be returned as follows: - To approve a transfer 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 approve a transfer with the rationale code `LOGIN_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.
|
8213
|
+
# Use the `/transfer/authorization/create` endpoint to determine transfer failure risk. In Plaid's sandbox environment the decisions will be returned as follows: - To approve a transfer 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 approve a transfer with the rationale code `LOGIN_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. For guaranteed ACH customers, the following fields are required : `user.phone_number` (optional if `email_address` provided), `user.email_address` (optional if `phone_number` provided), `device.ip_address`, `device.user_agent`, and `user_present`.
|
7564
8214
|
# @param transfer_authorization_create_request [TransferAuthorizationCreateRequest]
|
7565
8215
|
# @param [Hash] opts the optional parameters
|
7566
8216
|
# @return [TransferAuthorizationCreateResponse]
|
@@ -7570,7 +8220,7 @@ module Plaid
|
|
7570
8220
|
end
|
7571
8221
|
|
7572
8222
|
# Create a transfer authorization
|
7573
|
-
# Use the `/transfer/authorization/create` endpoint to determine transfer failure risk. In Plaid's sandbox environment the decisions will be returned as follows: - To approve a transfer 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 approve a transfer with the rationale code `LOGIN_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.
|
8223
|
+
# Use the `/transfer/authorization/create` endpoint to determine transfer failure risk. In Plaid's sandbox environment the decisions will be returned as follows: - To approve a transfer 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 approve a transfer with the rationale code `LOGIN_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. For guaranteed ACH customers, the following fields are required : `user.phone_number` (optional if `email_address` provided), `user.email_address` (optional if `phone_number` provided), `device.ip_address`, `device.user_agent`, and `user_present`.
|
7574
8224
|
# @param transfer_authorization_create_request [TransferAuthorizationCreateRequest]
|
7575
8225
|
# @param [Hash] opts the optional parameters
|
7576
8226
|
# @return [Array<(TransferAuthorizationCreateResponse, Integer, Hash)>] TransferAuthorizationCreateResponse data, response status code and response headers
|
@@ -8470,7 +9120,7 @@ module Plaid
|
|
8470
9120
|
end
|
8471
9121
|
|
8472
9122
|
# Create user
|
8473
|
-
# This endpoint should be called for each of your end users before they begin a Plaid income flow. This provides you a single token to access all income data associated with the user. You should only create one per end user.
|
9123
|
+
# This endpoint should be called for each of your end users before they begin a Plaid income flow. This provides you a single token to access all income data associated with the user. You should only create one per end user. 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`.
|
8474
9124
|
# @param user_create_request [UserCreateRequest]
|
8475
9125
|
# @param [Hash] opts the optional parameters
|
8476
9126
|
# @return [UserCreateResponse]
|
@@ -8480,7 +9130,7 @@ module Plaid
|
|
8480
9130
|
end
|
8481
9131
|
|
8482
9132
|
# Create user
|
8483
|
-
# This endpoint should be called for each of your end users before they begin a Plaid income flow. This provides you a single token to access all income data associated with the user. You should only create one per end user.
|
9133
|
+
# This endpoint should be called for each of your end users before they begin a Plaid income flow. This provides you a single token to access all income data associated with the user. You should only create one per end user. 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`.
|
8484
9134
|
# @param user_create_request [UserCreateRequest]
|
8485
9135
|
# @param [Hash] opts the optional parameters
|
8486
9136
|
# @return [Array<(UserCreateResponse, Integer, Hash)>] UserCreateResponse data, response status code and response headers
|