plaid 15.11.0 → 17.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +326 -0
- data/Dockerfile +1 -1
- data/Gemfile.lock +6 -22
- data/Makefile +1 -1
- data/README.md +28 -2
- data/lib/plaid/api/plaid_api.rb +1114 -787
- data/lib/plaid/api_client.rb +5 -3
- 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 +12 -2
- data/lib/plaid/models/account_assets_all_of.rb +12 -2
- data/lib/plaid/models/account_balance.rb +1 -1
- data/lib/plaid/models/account_base.rb +1 -1
- data/lib/plaid/models/account_filter.rb +1 -1
- data/lib/plaid/models/account_filters_response.rb +1 -1
- data/lib/plaid/models/account_identity.rb +1 -1
- data/lib/plaid/models/account_identity_all_of.rb +1 -1
- data/lib/plaid/models/account_identity_match_score.rb +392 -0
- data/lib/plaid/models/account_identity_match_score_all_of.rb +249 -0
- 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_match_score.rb +232 -0
- data/lib/plaid/models/address_nullable.rb +1 -1
- data/lib/plaid/models/address_purpose_label.rb +1 -1
- data/lib/plaid/models/application.rb +1 -1
- data/lib/plaid/models/application_get_request.rb +1 -1
- data/lib/plaid/models/application_get_response.rb +1 -1
- data/lib/plaid/models/apr.rb +1 -1
- data/lib/plaid/models/asset.rb +280 -0
- data/lib/plaid/models/asset_detail.rb +347 -0
- data/lib/plaid/models/{pay_stub_verification_attribute.rb → asset_holder.rb} +17 -14
- data/lib/plaid/models/asset_holder_name.rb +225 -0
- data/lib/plaid/models/asset_owner.rb +221 -0
- data/lib/plaid/models/{report_token.rb → asset_owners.rb} +20 -22
- data/lib/plaid/models/asset_report.rb +1 -1
- data/lib/plaid/models/asset_report_audit_copy_create_request.rb +1 -6
- 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 +1 -1
- data/lib/plaid/models/asset_report_create_response.rb +1 -1
- data/lib/plaid/models/asset_report_filter_request.rb +1 -1
- data/lib/plaid/models/asset_report_filter_response.rb +1 -1
- data/lib/plaid/models/asset_report_freddie.rb +252 -0
- data/lib/plaid/models/asset_report_freddie_get_request.rb +245 -0
- data/lib/plaid/models/asset_report_freddie_get_response.rb +254 -0
- data/lib/plaid/models/asset_report_get_request.rb +14 -5
- data/lib/plaid/models/asset_report_get_request_options.rb +247 -0
- 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 +14 -5
- data/lib/plaid/models/asset_report_pdf_get_request_options.rb +247 -0
- data/lib/plaid/models/asset_report_refresh_request.rb +1 -1
- data/lib/plaid/models/asset_report_refresh_request_options.rb +1 -1
- data/lib/plaid/models/asset_report_refresh_response.rb +1 -1
- data/lib/plaid/models/asset_report_remove_request.rb +1 -1
- data/lib/plaid/models/asset_report_remove_response.rb +1 -1
- data/lib/plaid/models/asset_report_transaction.rb +16 -6
- data/lib/plaid/models/asset_report_transaction_all_of.rb +16 -6
- data/lib/plaid/models/asset_report_user.rb +1 -1
- data/lib/plaid/models/asset_transaction.rb +241 -0
- data/lib/plaid/models/asset_transaction_category_type.rb +144 -0
- data/lib/plaid/models/asset_transaction_description.rb +225 -0
- data/lib/plaid/models/asset_transaction_detail.rb +327 -0
- data/lib/plaid/models/{relay_event.rb → asset_transaction_type.rb} +4 -5
- data/lib/plaid/models/asset_transactions.rb +226 -0
- data/lib/plaid/models/asset_type.rb +42 -0
- data/lib/plaid/models/assets.rb +227 -0
- data/lib/plaid/models/assets_error_webhook.rb +1 -1
- data/lib/plaid/models/assets_product_ready_webhook.rb +1 -1
- data/lib/plaid/models/auth_get_numbers.rb +1 -1
- data/lib/plaid/models/auth_get_request.rb +1 -1
- data/lib/plaid/models/auth_get_request_options.rb +1 -1
- data/lib/plaid/models/auth_get_response.rb +1 -1
- data/lib/plaid/models/auth_metadata.rb +1 -1
- data/lib/plaid/models/auth_supported_methods.rb +1 -1
- data/lib/plaid/models/automatically_verified_webhook.rb +19 -5
- data/lib/plaid/models/bank_initiated_return_risk.rb +12 -12
- 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 +19 -5
- data/lib/plaid/models/categories_get_response.rb +1 -1
- data/lib/plaid/models/category.rb +1 -1
- data/lib/plaid/models/cause.rb +2 -37
- 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/counterparty.rb +239 -0
- data/lib/plaid/models/counterparty_type.rb +41 -0
- data/lib/plaid/models/country_code.rb +8 -1
- data/lib/plaid/models/credit1099.rb +1 -1
- data/lib/plaid/models/credit1099_filer.rb +2 -2
- data/lib/plaid/models/credit1099_payer.rb +1 -1
- data/lib/plaid/models/credit1099_recipient.rb +1 -1
- data/lib/plaid/models/credit_account_subtype.rb +1 -1
- data/lib/plaid/models/credit_audit_copy_token_create_request.rb +5 -20
- data/lib/plaid/models/credit_audit_copy_token_create_response.rb +1 -1
- data/lib/plaid/models/credit_audit_copy_token_remove_request.rb +1 -1
- data/lib/plaid/models/credit_audit_copy_token_remove_response.rb +1 -1
- data/lib/plaid/models/credit_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 +4 -1
- data/lib/plaid/models/credit_bank_income_cause.rb +1 -1
- data/lib/plaid/models/credit_bank_income_error_type.rb +1 -1
- data/lib/plaid/models/credit_bank_income_get_request.rb +1 -1
- data/lib/plaid/models/credit_bank_income_get_request_options.rb +1 -1
- data/lib/plaid/models/credit_bank_income_get_response.rb +1 -1
- data/lib/plaid/models/credit_bank_income_historical_summary.rb +1 -1
- data/lib/plaid/models/credit_bank_income_item.rb +1 -1
- data/lib/plaid/models/credit_bank_income_pay_frequency.rb +1 -1
- data/lib/plaid/models/credit_bank_income_pdf_get_request.rb +1 -1
- data/lib/plaid/models/credit_bank_income_refresh_request.rb +1 -11
- 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 +2 -2
- data/lib/plaid/models/credit_bank_income_summary.rb +1 -1
- data/lib/plaid/models/credit_bank_income_transaction.rb +1 -1
- data/lib/plaid/models/credit_bank_income_warning.rb +1 -1
- data/lib/plaid/models/credit_bank_income_warning_code.rb +1 -1
- data/lib/plaid/models/credit_bank_income_warning_type.rb +1 -1
- data/lib/plaid/models/credit_card_liability.rb +1 -1
- data/lib/plaid/models/credit_category.rb +240 -0
- data/lib/plaid/models/credit_document_metadata.rb +2 -2
- data/lib/plaid/models/credit_employer_verification.rb +1 -1
- data/lib/plaid/models/credit_employment_get_request.rb +1 -11
- data/lib/plaid/models/credit_employment_get_response.rb +1 -1
- data/lib/plaid/models/credit_employment_item.rb +9 -14
- 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 +5 -15
- 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_payroll_income_get_request.rb +1 -1
- data/lib/plaid/models/credit_payroll_income_get_response.rb +1 -1
- data/lib/plaid/models/credit_payroll_income_precheck_request.rb +16 -6
- data/lib/plaid/models/credit_payroll_income_precheck_response.rb +1 -1
- data/lib/plaid/models/credit_payroll_income_refresh_request.rb +1 -1
- data/lib/plaid/models/credit_payroll_income_refresh_response.rb +1 -1
- data/lib/plaid/models/credit_payroll_income_risk_signals_get_request.rb +1 -1
- data/lib/plaid/models/credit_payroll_income_risk_signals_get_response.rb +1 -1
- data/lib/plaid/models/credit_platform_ids.rb +1 -1
- data/lib/plaid/models/credit_relay_create_request.rb +3 -3
- data/lib/plaid/models/credit_relay_create_response.rb +1 -1
- data/lib/plaid/models/credit_relay_get_request.rb +1 -1
- data/lib/plaid/models/credit_relay_refresh_request.rb +1 -1
- data/lib/plaid/models/credit_relay_refresh_response.rb +1 -1
- data/lib/plaid/models/credit_relay_remove_request.rb +1 -1
- data/lib/plaid/models/credit_relay_remove_response.rb +1 -1
- data/lib/plaid/models/credit_session.rb +251 -0
- data/lib/plaid/models/credit_session_bank_income_result.rb +239 -0
- data/lib/plaid/models/credit_session_bank_income_status.rb +40 -0
- data/lib/plaid/models/credit_session_document_income_result.rb +240 -0
- data/lib/plaid/models/credit_session_error.rb +251 -0
- data/lib/plaid/models/credit_session_item_add_result.rb +240 -0
- data/lib/plaid/models/credit_session_payroll_income_result.rb +250 -0
- data/lib/plaid/models/credit_session_results.rb +256 -0
- data/lib/plaid/models/{asset_report_relay_remove_request.rb → credit_sessions_get_request.rb} +16 -16
- data/lib/plaid/models/{asset_report_relay_remove_response.rb → credit_sessions_get_response.rb} +15 -18
- data/lib/plaid/models/credit_w2.rb +1 -1
- data/lib/plaid/models/customer_initiated_return_risk.rb +12 -12
- data/lib/plaid/models/dashboard_user.rb +1 -1
- data/lib/plaid/models/{get_dashboard_user_request.rb → dashboard_user_get_request.rb} +4 -4
- data/lib/plaid/models/{dashboard_user_response.rb → dashboard_user_get_response.rb} +4 -4
- data/lib/plaid/models/{list_dashboard_user_request.rb → dashboard_user_list_request.rb} +4 -4
- data/lib/plaid/models/{paginated_dashboard_user_list_response.rb → dashboard_user_list_response.rb} +4 -4
- 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 +20 -6
- 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 +14 -5
- 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 +2 -1
- data/lib/plaid/models/document_analysis.rb +1 -1
- data/lib/plaid/models/document_authenticity_match_code.rb +1 -1
- data/lib/plaid/models/document_date_of_birth_match_code.rb +1 -1
- data/lib/plaid/models/document_metadata.rb +1 -1
- data/lib/plaid/models/document_name_match_code.rb +1 -1
- data/lib/plaid/models/document_risk_signal.rb +1 -1
- data/lib/plaid/models/document_risk_signal_institution_metadata.rb +1 -1
- data/lib/plaid/models/document_risk_signals_object.rb +1 -1
- data/lib/plaid/models/document_status.rb +1 -1
- data/lib/plaid/models/documentary_verification.rb +2 -2
- data/lib/plaid/models/documentary_verification_document.rb +1 -1
- data/lib/plaid/models/earnings.rb +1 -1
- data/lib/plaid/models/earnings_breakdown.rb +1 -1
- data/lib/plaid/models/earnings_breakdown_canonical_description.rb +1 -1
- data/lib/plaid/models/earnings_total.rb +1 -1
- data/lib/plaid/models/email.rb +1 -1
- data/lib/plaid/models/email_address_match_score.rb +221 -0
- 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 +18 -6
- data/lib/plaid/models/entity_document.rb +1 -12
- 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 -24
- 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 +20 -6
- data/lib/plaid/models/entity_watchlist_code.rb +1 -1
- data/lib/plaid/models/entity_watchlist_program.rb +1 -12
- data/lib/plaid/models/entity_watchlist_screening.rb +20 -1
- data/lib/plaid/models/entity_watchlist_screening_hit.rb +1 -1
- data/lib/plaid/models/entity_watchlist_screening_review.rb +1 -1
- data/lib/plaid/models/entity_watchlist_screening_search_terms.rb +37 -9
- data/lib/plaid/models/entity_watchlist_search_terms.rb +37 -9
- data/lib/plaid/models/expiration_date.rb +1 -1
- data/lib/plaid/models/external_payment_initiation_consent_options.rb +1 -1
- data/lib/plaid/models/external_payment_options.rb +1 -1
- data/lib/plaid/models/external_payment_refund_details.rb +1 -1
- data/lib/plaid/models/external_payment_schedule_base.rb +1 -1
- data/lib/plaid/models/external_payment_schedule_get.rb +1 -1
- data/lib/plaid/models/external_payment_schedule_request.rb +1 -1
- data/lib/plaid/models/fdx_content_types.rb +43 -0
- data/lib/plaid/models/fdx_hateoas_link.rb +256 -0
- data/lib/plaid/models/{payment_initiation_refund_status.rb → fdx_hateoas_link_action.rb} +7 -6
- data/lib/plaid/models/fdx_notification.rb +332 -0
- data/lib/plaid/models/fdx_notification_category.rb +42 -0
- data/lib/plaid/models/fdx_notification_payload.rb +238 -0
- data/lib/plaid/models/fdx_notification_payload_id_type.rb +42 -0
- data/lib/plaid/models/fdx_notification_priority.rb +40 -0
- data/lib/plaid/models/fdx_notification_severity.rb +42 -0
- data/lib/plaid/models/fdx_notification_type.rb +43 -0
- data/lib/plaid/models/{verification_attribute.rb → fdx_party.rb} +76 -43
- data/lib/plaid/models/fdx_party_registry.rb +41 -0
- data/lib/plaid/models/fdx_party_type.rb +43 -0
- data/lib/plaid/models/fdxfi_attribute.rb +230 -0
- data/lib/plaid/models/form1099_type.rb +1 -1
- data/lib/plaid/models/generic_screening_hit_location_items.rb +1 -1
- data/lib/plaid/models/health_incident.rb +2 -1
- data/lib/plaid/models/historical_balance.rb +1 -1
- data/lib/plaid/models/historical_update_webhook.rb +20 -6
- data/lib/plaid/models/holding.rb +3 -3
- data/lib/plaid/models/holdings_default_update_webhook.rb +20 -6
- 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 +20 -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 +1 -1
- data/lib/plaid/models/identity_match_request_options.rb +1 -1
- data/lib/plaid/models/identity_match_response.rb +38 -2
- data/lib/plaid/models/identity_match_user.rb +1 -1
- data/lib/plaid/models/identity_update_types.rb +1 -1
- data/lib/plaid/models/identity_verification.rb +2 -12
- data/lib/plaid/models/identity_verification_create_request.rb +1 -1
- data/lib/plaid/models/{identity_verification_response.rb → identity_verification_create_response.rb} +5 -15
- data/lib/plaid/models/{get_identity_verification_request.rb → identity_verification_get_request.rb} +4 -4
- data/lib/plaid/models/identity_verification_get_response.rb +411 -0
- data/lib/plaid/models/{list_identity_verification_request.rb → identity_verification_list_request.rb} +4 -15
- data/lib/plaid/models/{paginated_identity_verification_list_response.rb → identity_verification_list_response.rb} +4 -4
- data/lib/plaid/models/identity_verification_request_user.rb +3 -34
- data/lib/plaid/models/identity_verification_retried_webhook.rb +20 -6
- data/lib/plaid/models/identity_verification_retry_request.rb +1 -12
- data/lib/plaid/models/identity_verification_retry_request_steps_object.rb +1 -1
- data/lib/plaid/models/identity_verification_retry_response.rb +411 -0
- data/lib/plaid/models/identity_verification_status.rb +1 -1
- data/lib/plaid/models/identity_verification_status_updated_webhook.rb +20 -6
- 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 +20 -6
- data/lib/plaid/models/identity_verification_template_reference.rb +1 -1
- data/lib/plaid/models/identity_verification_user_address.rb +6 -13
- data/lib/plaid/models/identity_verification_user_data.rb +2 -20
- data/lib/plaid/models/image_quality.rb +1 -1
- data/lib/plaid/models/incident_update.rb +1 -1
- data/lib/plaid/models/income_breakdown.rb +1 -1
- data/lib/plaid/models/income_breakdown_type.rb +1 -1
- data/lib/plaid/models/income_override.rb +1 -1
- data/lib/plaid/models/income_summary.rb +1 -1
- data/lib/plaid/models/income_summary_field_number.rb +1 -1
- data/lib/plaid/models/income_summary_field_string.rb +1 -1
- data/lib/plaid/models/income_verification_create_request.rb +1 -1
- data/lib/plaid/models/income_verification_create_request_options.rb +1 -1
- data/lib/plaid/models/income_verification_create_response.rb +1 -1
- data/lib/plaid/models/income_verification_documents_download_request.rb +1 -1
- data/lib/plaid/models/income_verification_payroll_flow_type.rb +1 -1
- data/lib/plaid/models/income_verification_paystubs_get_request.rb +1 -1
- data/lib/plaid/models/income_verification_paystubs_get_response.rb +1 -1
- data/lib/plaid/models/income_verification_precheck_confidence.rb +1 -1
- data/lib/plaid/models/income_verification_precheck_employer.rb +1 -1
- data/lib/plaid/models/income_verification_precheck_employer_address.rb +1 -1
- data/lib/plaid/models/income_verification_precheck_employer_address_data.rb +1 -1
- data/lib/plaid/models/income_verification_precheck_military_info.rb +1 -1
- data/lib/plaid/models/income_verification_precheck_payroll_institution.rb +221 -0
- data/lib/plaid/models/income_verification_precheck_request.rb +12 -2
- 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 +20 -6
- data/lib/plaid/models/income_verification_taxforms_get_request.rb +1 -1
- data/lib/plaid/models/income_verification_taxforms_get_response.rb +1 -1
- data/lib/plaid/models/income_verification_webhook_status.rb +1 -1
- data/lib/plaid/models/individual_name.rb +240 -0
- 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 -12
- data/lib/plaid/models/inflow_model.rb +1 -1
- data/lib/plaid/models/initial_update_webhook.rb +20 -6
- data/lib/plaid/models/institution.rb +2 -2
- data/lib/plaid/models/institution_status.rb +1 -1
- data/lib/plaid/models/institutions_get_by_id_request.rb +1 -1
- data/lib/plaid/models/institutions_get_by_id_request_options.rb +1 -1
- data/lib/plaid/models/institutions_get_by_id_response.rb +1 -1
- data/lib/plaid/models/institutions_get_request.rb +1 -1
- data/lib/plaid/models/institutions_get_request_options.rb +2 -2
- 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 +2 -2
- 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 +2 -1
- data/lib/plaid/models/investment_transaction_type.rb +1 -1
- data/lib/plaid/models/investments_default_update_webhook.rb +20 -6
- 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 +1 -1
- data/lib/plaid/models/item_access_token_invalidate_request.rb +1 -1
- data/lib/plaid/models/item_access_token_invalidate_response.rb +1 -1
- data/lib/plaid/models/item_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 +20 -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 +20 -6
- 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 +2 -2
- 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 +20 -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 +2 -2
- data/lib/plaid/models/{asset_report_relay_refresh_request.rb → link_delivery_create_request.rb} +42 -23
- data/lib/plaid/models/{asset_report_relay_refresh_response.rb → link_delivery_create_response.rb} +26 -25
- data/lib/plaid/models/link_delivery_delivery_method.rb +39 -0
- data/lib/plaid/models/link_delivery_get_request.rb +245 -0
- data/lib/plaid/models/link_delivery_get_response.rb +277 -0
- data/lib/plaid/models/link_delivery_session_status.rb +41 -0
- data/lib/plaid/models/{asset_report_relay_get_request.rb → link_o_auth_correlation_id_exchange_request.rb} +16 -16
- data/lib/plaid/models/{asset_report_relay_create_response.rb → link_o_auth_correlation_id_exchange_response.rb} +16 -16
- 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 +16 -7
- data/lib/plaid/models/link_token_create_request_account_subtypes.rb +1 -1
- data/lib/plaid/models/link_token_create_request_auth.rb +2 -2
- data/lib/plaid/models/link_token_create_request_deposit_switch.rb +1 -1
- data/lib/plaid/models/link_token_create_request_identity_verification.rb +1 -1
- data/lib/plaid/models/link_token_create_request_income_verification.rb +2 -2
- 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 +5 -14
- data/lib/plaid/models/link_token_create_request_transfer.rb +9 -9
- data/lib/plaid/models/link_token_create_request_update.rb +1 -1
- data/lib/plaid/models/link_token_create_request_user.rb +1 -1
- data/lib/plaid/models/link_token_create_request_user_stated_income_source.rb +1 -1
- data/lib/plaid/models/link_token_create_response.rb +1 -1
- data/lib/plaid/models/link_token_eu_config.rb +1 -1
- data/lib/plaid/models/link_token_get_metadata_response.rb +1 -1
- data/lib/plaid/models/link_token_get_request.rb +1 -1
- data/lib/plaid/models/link_token_get_response.rb +1 -1
- data/lib/plaid/models/link_token_investments.rb +220 -0
- data/lib/plaid/models/loan.rb +224 -0
- data/lib/plaid/models/loan_account_subtype.rb +1 -1
- data/lib/plaid/models/loan_filter.rb +1 -1
- data/lib/plaid/models/loan_identifier.rb +231 -0
- data/lib/plaid/models/loan_identifier_type.rb +39 -0
- data/lib/plaid/models/loan_identifiers.rb +224 -0
- data/lib/plaid/models/loans.rb +224 -0
- 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 +61 -5
- data/lib/plaid/models/mfa.rb +1 -1
- data/lib/plaid/models/mortgage_interest_rate.rb +1 -1
- data/lib/plaid/models/mortgage_liability.rb +1 -1
- data/lib/plaid/models/mortgage_property_address.rb +1 -1
- data/lib/plaid/models/multi_document_risk_signal.rb +1 -1
- data/lib/plaid/models/name_match_score.rb +254 -0
- data/lib/plaid/models/net_pay.rb +1 -1
- data/lib/plaid/models/new_accounts_available_webhook.rb +15 -6
- data/lib/plaid/models/numbers.rb +1 -1
- data/lib/plaid/models/numbers_ach.rb +1 -1
- data/lib/plaid/models/numbers_ach_nullable.rb +1 -1
- data/lib/plaid/models/numbers_bacs.rb +1 -1
- data/lib/plaid/models/numbers_bacs_nullable.rb +1 -1
- data/lib/plaid/models/numbers_eft.rb +1 -1
- data/lib/plaid/models/numbers_eft_nullable.rb +1 -1
- data/lib/plaid/models/numbers_iban_nullable.rb +1 -1
- data/lib/plaid/models/numbers_international.rb +1 -1
- data/lib/plaid/models/numbers_international_iban.rb +1 -1
- data/lib/plaid/models/numbers_international_nullable.rb +1 -1
- data/lib/plaid/models/override_account_type.rb +1 -1
- data/lib/plaid/models/override_accounts.rb +1 -1
- data/lib/plaid/models/owner.rb +2 -2
- data/lib/plaid/models/owner_override.rb +1 -1
- data/lib/plaid/models/ownership_type.rb +42 -0
- data/lib/plaid/models/parties.rb +226 -0
- data/lib/plaid/models/{partner_customers_create_request.rb → partner_customer_create_request.rb} +113 -11
- data/lib/plaid/models/partner_customer_create_response.rb +229 -0
- data/lib/plaid/models/partner_customer_enable_request.rb +244 -0
- data/lib/plaid/models/{partner_customers_create_response.rb → partner_customer_enable_response.rb} +7 -15
- data/lib/plaid/models/partner_customer_get_request.rb +244 -0
- data/lib/plaid/models/partner_customer_get_response.rb +229 -0
- data/lib/plaid/models/{partner_end_customer_client.rb → partner_end_customer.rb} +18 -10
- data/lib/plaid/models/partner_end_customer_address.rb +256 -0
- data/lib/plaid/models/partner_end_customer_billing_contact.rb +237 -0
- data/lib/plaid/models/partner_end_customer_secrets.rb +230 -0
- data/lib/plaid/models/partner_end_customer_status.rb +41 -0
- data/lib/plaid/models/partner_end_customer_technical_contact.rb +237 -0
- data/lib/plaid/models/partner_end_customer_with_secrets.rb +254 -0
- data/lib/plaid/models/partner_end_customer_with_secrets_all_of.rb +218 -0
- data/lib/plaid/models/party.rb +252 -0
- data/lib/plaid/models/party_individual.rb +224 -0
- data/lib/plaid/models/party_role_type.rb +38 -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/payment_amount.rb +1 -1
- data/lib/plaid/models/payment_amount_currency.rb +7 -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 +2 -1
- data/lib/plaid/models/payment_initiation_payment_create_request.rb +2 -2
- 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 +2 -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 +2 -2
- data/lib/plaid/models/payment_initiation_payment_status.rb +2 -1
- data/lib/plaid/models/payment_initiation_payment_token_create_request.rb +1 -1
- data/lib/plaid/models/payment_initiation_payment_token_create_response.rb +1 -1
- data/lib/plaid/models/payment_initiation_recipient.rb +1 -1
- data/lib/plaid/models/payment_initiation_recipient_create_request.rb +1 -1
- data/lib/plaid/models/payment_initiation_recipient_create_response.rb +1 -1
- data/lib/plaid/models/payment_initiation_recipient_get_request.rb +1 -1
- data/lib/plaid/models/payment_initiation_recipient_get_response.rb +1 -1
- data/lib/plaid/models/payment_initiation_recipient_get_response_all_of.rb +1 -1
- data/lib/plaid/models/payment_initiation_recipient_list_request.rb +1 -1
- data/lib/plaid/models/payment_initiation_recipient_list_response.rb +1 -1
- data/lib/plaid/models/payment_initiation_standing_order_metadata.rb +1 -1
- data/lib/plaid/models/payment_meta.rb +1 -1
- data/lib/plaid/models/payment_profile_create_request.rb +1 -1
- data/lib/plaid/models/payment_profile_create_response.rb +12 -12
- data/lib/plaid/models/payment_profile_get_request.rb +12 -12
- data/lib/plaid/models/payment_profile_get_response.rb +1 -1
- data/lib/plaid/models/payment_profile_remove_request.rb +12 -12
- data/lib/plaid/models/payment_profile_remove_response.rb +1 -1
- data/lib/plaid/models/payment_profile_status.rb +1 -1
- data/lib/plaid/models/payment_schedule_interval.rb +1 -1
- data/lib/plaid/models/payment_scheme.rb +1 -1
- data/lib/plaid/models/payment_status_update_webhook.rb +20 -6
- data/lib/plaid/models/payroll_income_account_data.rb +1 -1
- data/lib/plaid/models/payroll_income_object.rb +1 -1
- data/lib/plaid/models/payroll_income_rate_of_pay.rb +1 -1
- data/lib/plaid/models/payroll_item.rb +10 -14
- 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 +5 -15
- data/lib/plaid/models/paystub_address.rb +1 -1
- data/lib/plaid/models/paystub_deduction.rb +1 -1
- data/lib/plaid/models/paystub_details.rb +1 -1
- data/lib/plaid/models/paystub_employer.rb +1 -1
- data/lib/plaid/models/paystub_override.rb +1 -1
- data/lib/plaid/models/paystub_override_employee.rb +1 -1
- data/lib/plaid/models/paystub_override_employee_address.rb +1 -1
- data/lib/plaid/models/paystub_override_employer.rb +1 -1
- data/lib/plaid/models/paystub_pay_frequency.rb +1 -1
- data/lib/plaid/models/paystub_ytd_details.rb +1 -1
- data/lib/plaid/models/pending_expiration_webhook.rb +19 -5
- data/lib/plaid/models/personal_finance_category.rb +1 -1
- data/lib/plaid/models/phone_number.rb +1 -1
- data/lib/plaid/models/phone_number_match_score.rb +221 -0
- 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 +17 -35
- 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 +3 -45
- data/lib/plaid/models/{paystub_verification_status.rb → plaid_error_type.rb} +16 -6
- data/lib/plaid/models/platform_ids.rb +1 -1
- data/lib/plaid/models/po_box_status.rb +1 -1
- data/lib/plaid/models/processor_apex_processor_token_create_request.rb +1 -1
- data/lib/plaid/models/processor_auth_get_request.rb +1 -1
- data/lib/plaid/models/processor_auth_get_response.rb +1 -1
- data/lib/plaid/models/processor_balance_get_request.rb +1 -1
- data/lib/plaid/models/processor_balance_get_request_options.rb +1 -1
- data/lib/plaid/models/processor_balance_get_response.rb +1 -1
- data/lib/plaid/models/processor_bank_transfer_create_request.rb +1 -1
- data/lib/plaid/models/processor_bank_transfer_create_response.rb +1 -1
- data/lib/plaid/models/processor_identity_get_request.rb +1 -1
- data/lib/plaid/models/processor_identity_get_response.rb +1 -1
- data/lib/plaid/models/processor_number.rb +1 -1
- data/lib/plaid/models/processor_stripe_bank_account_token_create_request.rb +1 -1
- data/lib/plaid/models/processor_stripe_bank_account_token_create_response.rb +1 -1
- data/lib/plaid/models/processor_token_create_request.rb +3 -3
- data/lib/plaid/models/processor_token_create_response.rb +1 -1
- data/lib/plaid/models/product_access.rb +1 -1
- data/lib/plaid/models/product_status.rb +1 -1
- data/lib/plaid/models/product_status_breakdown.rb +2 -2
- data/lib/plaid/models/products.rb +1 -1
- data/lib/plaid/models/program_name_sensitivity.rb +1 -1
- data/lib/plaid/models/projected_income_summary_field_number.rb +1 -1
- data/lib/plaid/models/pslf_status.rb +2 -2
- data/lib/plaid/models/recaptcha_required_error.rb +1 -1
- data/lib/plaid/models/recipient_bacs.rb +1 -1
- data/lib/plaid/models/recipient_bacs_nullable.rb +1 -1
- data/lib/plaid/models/recurring_transaction_frequency.rb +1 -1
- data/lib/plaid/models/recurring_transactions_update_webhook.rb +19 -5
- data/lib/plaid/models/removed_transaction.rb +1 -1
- data/lib/plaid/models/report_type.rb +1 -1
- data/lib/plaid/models/reporting_information.rb +225 -0
- data/lib/plaid/models/risk_signal_document_reference.rb +1 -1
- data/lib/plaid/models/role.rb +224 -0
- data/lib/plaid/models/role_detail.rb +224 -0
- data/lib/plaid/models/roles.rb +224 -0
- 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 +2 -2
- data/lib/plaid/models/sandbox_income_fire_webhook_response.rb +1 -1
- data/lib/plaid/models/sandbox_item_fire_webhook_request.rb +1 -1
- data/lib/plaid/models/sandbox_item_fire_webhook_response.rb +1 -1
- data/lib/plaid/models/sandbox_item_reset_login_request.rb +1 -1
- data/lib/plaid/models/sandbox_item_reset_login_response.rb +1 -1
- data/lib/plaid/models/sandbox_item_set_verification_status_request.rb +1 -1
- data/lib/plaid/models/sandbox_item_set_verification_status_response.rb +1 -1
- data/lib/plaid/models/sandbox_oauth_select_accounts_request.rb +1 -1
- data/lib/plaid/models/sandbox_payment_profile_reset_login_request.rb +245 -0
- data/lib/plaid/models/sandbox_payment_profile_reset_login_response.rb +240 -0
- data/lib/plaid/models/sandbox_processor_token_create_request.rb +1 -1
- data/lib/plaid/models/sandbox_processor_token_create_request_options.rb +1 -1
- data/lib/plaid/models/sandbox_processor_token_create_response.rb +1 -1
- data/lib/plaid/models/sandbox_public_token_create_request.rb +1 -1
- data/lib/plaid/models/sandbox_public_token_create_request_income_verification_bank_income.rb +220 -0
- data/lib/plaid/models/sandbox_public_token_create_request_options.rb +14 -5
- data/lib/plaid/models/sandbox_public_token_create_request_options_income_verification.rb +231 -0
- 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 +2 -2
- 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 +20 -6
- data/lib/plaid/models/security.rb +3 -3
- data/lib/plaid/models/security_override.rb +1 -1
- data/lib/plaid/models/sender_bacs_nullable.rb +1 -1
- data/lib/plaid/models/service.rb +238 -0
- data/lib/plaid/models/service_product_fulfillment.rb +224 -0
- data/lib/plaid/models/service_product_fulfillment_detail.rb +235 -0
- data/lib/plaid/models/service_product_fulfillment_identifier.rb +38 -0
- data/lib/plaid/models/servicer_address_data.rb +1 -1
- data/lib/plaid/models/services.rb +224 -0
- 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 +2 -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 +16 -5
- data/lib/plaid/models/single_document_risk_signal.rb +1 -1
- data/lib/plaid/models/source.rb +1 -1
- data/lib/plaid/models/standalone_account_type.rb +1 -1
- data/lib/plaid/models/standalone_currency_code_list.rb +1 -1
- data/lib/plaid/models/standalone_investment_transaction_type.rb +1 -1
- data/lib/plaid/models/status.rb +232 -0
- data/lib/plaid/models/statuses.rb +224 -0
- 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 +20 -6
- data/lib/plaid/models/taxform.rb +1 -1
- data/lib/plaid/models/taxpayer_id.rb +1 -1
- data/lib/plaid/models/taxpayer_identifier.rb +231 -0
- data/lib/plaid/models/taxpayer_identifier_type.rb +39 -0
- data/lib/plaid/models/taxpayer_identifiers.rb +224 -0
- data/lib/plaid/models/total.rb +1 -1
- data/lib/plaid/models/total_canonical_description.rb +1 -1
- data/lib/plaid/models/transaction.rb +1 -1
- data/lib/plaid/models/transaction_all_of.rb +1 -1
- data/lib/plaid/models/transaction_base.rb +1 -1
- 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 +1 -1
- 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 +20 -6
- 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 -11
- data/lib/plaid/models/transactions_rules_create_response.rb +1 -1
- data/lib/plaid/models/transactions_rules_list_request.rb +1 -11
- data/lib/plaid/models/transactions_rules_list_response.rb +1 -1
- data/lib/plaid/models/transactions_rules_remove_request.rb +1 -11
- 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 +1 -1
- data/lib/plaid/models/transactions_sync_response.rb +1 -1
- data/lib/plaid/models/transfer.rb +27 -10
- data/lib/plaid/models/transfer_authorization.rb +1 -1
- data/lib/plaid/models/transfer_authorization_create_request.rb +64 -17
- 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 +4 -2
- 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 +1 -1
- data/lib/plaid/models/transfer_authorization_proposed_transfer.rb +1 -6
- data/lib/plaid/models/transfer_authorization_user_in_request.rb +1 -1
- data/lib/plaid/models/transfer_cancel_request.rb +1 -1
- data/lib/plaid/models/transfer_cancel_response.rb +1 -1
- data/lib/plaid/models/transfer_create_request.rb +19 -43
- 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 +2 -2
- 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 +3 -2
- data/lib/plaid/models/transfer_events_update_webhook.rb +19 -5
- 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 +2 -7
- data/lib/plaid/models/transfer_intent_create_mode.rb +1 -1
- data/lib/plaid/models/transfer_intent_create_request.rb +2 -7
- data/lib/plaid/models/transfer_intent_create_response.rb +1 -1
- data/lib/plaid/models/transfer_intent_get.rb +2 -7
- data/lib/plaid/models/transfer_intent_get_failure_reason.rb +2 -2
- 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 +2 -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 +2 -1
- data/lib/plaid/models/transfer_sweep.rb +16 -5
- 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 +2 -2
- data/lib/plaid/models/transfer_type.rb +1 -1
- data/lib/plaid/models/transfer_user_address_in_request.rb +1 -1
- data/lib/plaid/models/transfer_user_address_in_response.rb +1 -1
- data/lib/plaid/models/transfer_user_in_request.rb +1 -1
- data/lib/plaid/models/transfer_user_in_request_deprecated.rb +249 -0
- data/lib/plaid/models/transfer_user_in_response.rb +1 -1
- data/lib/plaid/models/update_entity_screening_request_search_terms.rb +58 -7
- data/lib/plaid/models/update_individual_screening_request_search_terms.rb +57 -6
- data/lib/plaid/models/user_address.rb +2 -13
- data/lib/plaid/models/user_create_request.rb +32 -2
- data/lib/plaid/models/user_create_response.rb +1 -1
- data/lib/plaid/models/user_custom_password.rb +2 -2
- 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 +20 -6
- data/lib/plaid/models/user_stated_income_source_category.rb +1 -1
- data/lib/plaid/models/user_stated_income_source_frequency.rb +1 -1
- data/lib/plaid/models/user_stated_income_source_pay_type.rb +1 -1
- data/lib/plaid/models/validation_source.rb +232 -0
- data/lib/plaid/models/validation_sources.rb +227 -0
- data/lib/plaid/models/verification_expired_webhook.rb +19 -5
- data/lib/plaid/models/{paystub_verification.rb → verification_of_asset.rb} +40 -24
- data/lib/plaid/models/verification_of_asset_response.rb +224 -0
- 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 +15 -5
- 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 +12 -2
- data/lib/plaid/models/wallet_get_request.rb +1 -1
- data/lib/plaid/models/wallet_get_response.rb +12 -2
- data/lib/plaid/models/wallet_iso_currency_code.rb +1 -1
- data/lib/plaid/models/wallet_list_request.rb +1 -1
- data/lib/plaid/models/wallet_list_response.rb +1 -1
- data/lib/plaid/models/wallet_numbers.rb +1 -1
- data/lib/plaid/models/wallet_transaction.rb +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 +1 -1
- data/lib/plaid/models/wallet_transaction_counterparty_numbers.rb +1 -1
- data/lib/plaid/models/wallet_transaction_execute_request.rb +2 -2
- 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 +3 -1
- data/lib/plaid/models/{assets_relay_webhook.rb → wallet_transaction_status_update_webhook.rb} +60 -47
- 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 +2 -1
- data/lib/plaid/models/watchlist_screening_document.rb +1 -12
- data/lib/plaid/models/watchlist_screening_document_type.rb +1 -1
- data/lib/plaid/models/{create_entity_screening_request.rb → watchlist_screening_entity_create_request.rb} +22 -5
- data/lib/plaid/models/watchlist_screening_entity_create_response.rb +321 -0
- data/lib/plaid/models/{get_entity_watchlist_screening_request.rb → watchlist_screening_entity_get_request.rb} +4 -4
- data/lib/plaid/models/{entity_watchlist_screening_response.rb → watchlist_screening_entity_get_response.rb} +23 -4
- data/lib/plaid/models/{list_watchlist_screening_entity_history_request.rb → watchlist_screening_entity_history_list_request.rb} +4 -4
- data/lib/plaid/models/{paginated_entity_watchlist_screening_list_response.rb → watchlist_screening_entity_history_list_response.rb} +4 -4
- data/lib/plaid/models/{list_watchlist_screening_entity_hit_request.rb → watchlist_screening_entity_hit_list_request.rb} +4 -4
- data/lib/plaid/models/{paginated_entity_watchlist_screening_hit_list_response.rb → watchlist_screening_entity_hit_list_response.rb} +4 -4
- data/lib/plaid/models/{list_entity_watchlist_screening_request.rb → watchlist_screening_entity_list_request.rb} +23 -7
- data/lib/plaid/models/watchlist_screening_entity_list_response.rb +253 -0
- data/lib/plaid/models/{get_watchlist_screening_entity_program_request.rb → watchlist_screening_entity_program_get_request.rb} +4 -4
- data/lib/plaid/models/{entity_watchlist_program_response.rb → watchlist_screening_entity_program_get_response.rb} +4 -15
- data/lib/plaid/models/{list_watchlist_screening_entity_programs_request.rb → watchlist_screening_entity_program_list_request.rb} +4 -4
- data/lib/plaid/models/{paginated_entity_watchlist_program_list_response.rb → watchlist_screening_entity_program_list_response.rb} +4 -4
- data/lib/plaid/models/{create_entity_watchlist_screening_review_request.rb → watchlist_screening_entity_review_create_request.rb} +4 -4
- data/lib/plaid/models/{entity_watchlist_screening_review_response.rb → watchlist_screening_entity_review_create_response.rb} +4 -4
- data/lib/plaid/models/{list_watchlist_screening_entity_reviews_request.rb → watchlist_screening_entity_review_list_request.rb} +4 -4
- data/lib/plaid/models/{paginated_entity_watchlist_screening_review_list_response.rb → watchlist_screening_entity_review_list_response.rb} +4 -4
- data/lib/plaid/models/{update_entity_screening_request.rb → watchlist_screening_entity_update_request.rb} +24 -8
- data/lib/plaid/models/{update_individual_screening_request_resettable_field.rb → watchlist_screening_entity_update_request_resettable_field.rb} +2 -2
- data/lib/plaid/models/watchlist_screening_entity_update_response.rb +321 -0
- data/lib/plaid/models/watchlist_screening_hit.rb +1 -1
- data/lib/plaid/models/watchlist_screening_hit_locations.rb +1 -12
- data/lib/plaid/models/watchlist_screening_hit_status.rb +1 -1
- data/lib/plaid/models/watchlist_screening_individual.rb +20 -1
- data/lib/plaid/models/{watchlist_screening_create_request.rb → watchlist_screening_individual_create_request.rb} +22 -5
- data/lib/plaid/models/watchlist_screening_individual_create_response.rb +321 -0
- data/lib/plaid/models/{get_individual_watchlist_screening_request.rb → watchlist_screening_individual_get_request.rb} +4 -4
- data/lib/plaid/models/{watchlist_screening_individual_response.rb → watchlist_screening_individual_get_response.rb} +23 -4
- data/lib/plaid/models/{list_watchlist_screening_individual_history_request.rb → watchlist_screening_individual_history_list_request.rb} +4 -4
- data/lib/plaid/models/{paginated_individual_watchlist_screening_list_response.rb → watchlist_screening_individual_history_list_response.rb} +4 -4
- data/lib/plaid/models/{list_watchlist_screening_individual_hit_request.rb → watchlist_screening_individual_hit_list_request.rb} +4 -4
- data/lib/plaid/models/{paginated_individual_watchlist_screening_hit_list_response.rb → watchlist_screening_individual_hit_list_response.rb} +4 -4
- data/lib/plaid/models/{list_individual_watchlist_screening_request.rb → watchlist_screening_individual_list_request.rb} +23 -7
- data/lib/plaid/models/watchlist_screening_individual_list_response.rb +253 -0
- data/lib/plaid/models/{get_watchlist_screening_individual_program_request.rb → watchlist_screening_individual_program_get_request.rb} +4 -4
- data/lib/plaid/models/{individual_watchlist_program_response.rb → watchlist_screening_individual_program_get_response.rb} +4 -15
- data/lib/plaid/models/{list_watchlist_screening_individual_programs_request.rb → watchlist_screening_individual_program_list_request.rb} +4 -4
- data/lib/plaid/models/{paginated_individual_watchlist_program_list_response.rb → watchlist_screening_individual_program_list_response.rb} +4 -4
- data/lib/plaid/models/{create_individual_watchlist_screening_review_request.rb → watchlist_screening_individual_review_create_request.rb} +4 -4
- data/lib/plaid/models/{watchlist_screening_review_response.rb → watchlist_screening_individual_review_create_response.rb} +4 -4
- data/lib/plaid/models/{list_watchlist_screening_individual_reviews_request.rb → watchlist_screening_individual_review_list_request.rb} +4 -4
- data/lib/plaid/models/{paginated_individual_watchlist_screening_review_list_response.rb → watchlist_screening_individual_review_list_response.rb} +4 -4
- data/lib/plaid/models/{update_individual_screening_request.rb → watchlist_screening_individual_update_request.rb} +24 -8
- data/lib/plaid/models/{update_entity_screening_request_resettable_field.rb → watchlist_screening_individual_update_request_resettable_field.rb} +2 -2
- data/lib/plaid/models/watchlist_screening_individual_update_response.rb +321 -0
- data/lib/plaid/models/watchlist_screening_request_search_terms.rb +35 -12
- data/lib/plaid/models/watchlist_screening_review.rb +1 -1
- data/lib/plaid/models/watchlist_screening_search_terms.rb +35 -9
- data/lib/plaid/models/watchlist_screening_status.rb +1 -1
- data/lib/plaid/models/weak_alias_determination.rb +1 -1
- data/lib/plaid/models/webhook_environment_values.rb +40 -0
- data/lib/plaid/models/webhook_type.rb +1 -1
- data/lib/plaid/models/webhook_update_acknowledged_webhook.rb +20 -6
- 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 +166 -65
- data/plaid.gemspec +5 -4
- data/templates/ruby/api_client.mustache +1 -0
- data/templates/ruby/api_client_faraday_partial.mustache +2 -2
- data/templates/ruby/gemspec.mustache +3 -2
- data/test/test_api_client.rb +2 -0
- data/test/test_identity_verification.rb +51 -0
- data/test/test_institutions.rb +2 -2
- data/test/test_monitor.rb +55 -0
- data/test/test_sandbox.rb +31 -0
- metadata +196 -72
- data/lib/plaid/models/asset_report_relay_create_request.rb +0 -271
- data/lib/plaid/models/credit_pay_stub_verification.rb +0 -237
- data/lib/plaid/models/error.rb +0 -354
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.197.3
|
7
7
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
OpenAPI Generator version: 5.1.1
|
@@ -20,7 +20,7 @@ module Plaid
|
|
20
20
|
@api_client = api_client
|
21
21
|
end
|
22
22
|
# Retrieve real-time balance data
|
23
|
-
# The `/accounts/balance/get` endpoint returns the real-time balance for each of an Item's accounts. While other endpoints may return a balance object, only `/accounts/balance/get` forces the available and current balance fields to be refreshed rather than cached. This endpoint can be used for existing Items that were added via any of Plaid’s other products. This endpoint can be used as long as Link has been initialized with any other product, `balance` itself is not a product that can be used to initialize Link.
|
23
|
+
# The `/accounts/balance/get` endpoint returns the real-time balance for each of an Item's accounts. While other endpoints may return a balance object, only `/accounts/balance/get` forces the available and current balance fields to be refreshed rather than cached. This endpoint can be used for existing Items that were added via any of Plaid’s other products. This endpoint can be used as long as Link has been initialized with any other product, `balance` itself is not a product that can be used to initialize Link. As this endpoint triggers a synchronous request for fresh data, latency may be higher than for other Plaid endpoints; if you encounter errors, you may find it necessary to adjust your timeout period when making requests.
|
24
24
|
# @param accounts_balance_get_request [AccountsBalanceGetRequest]
|
25
25
|
# @param [Hash] opts the optional parameters
|
26
26
|
# @return [AccountsGetResponse]
|
@@ -30,7 +30,7 @@ module Plaid
|
|
30
30
|
end
|
31
31
|
|
32
32
|
# Retrieve real-time balance data
|
33
|
-
# The `/accounts/balance/get` endpoint returns the real-time balance for each of an Item's accounts. While other endpoints may return a balance object, only `/accounts/balance/get` forces the available and current balance fields to be refreshed rather than cached. This endpoint can be used for existing Items that were added via any of Plaid’s other products. This endpoint can be used as long as Link has been initialized with any other product, `balance` itself is not a product that can be used to initialize Link.
|
33
|
+
# The `/accounts/balance/get` endpoint returns the real-time balance for each of an Item's accounts. While other endpoints may return a balance object, only `/accounts/balance/get` forces the available and current balance fields to be refreshed rather than cached. This endpoint can be used for existing Items that were added via any of Plaid’s other products. This endpoint can be used as long as Link has been initialized with any other product, `balance` itself is not a product that can be used to initialize Link. As this endpoint triggers a synchronous request for fresh data, latency may be higher than for other Plaid endpoints; if you encounter errors, you may find it necessary to adjust your timeout period when making requests.
|
34
34
|
# @param accounts_balance_get_request [AccountsBalanceGetRequest]
|
35
35
|
# @param [Hash] opts the optional parameters
|
36
36
|
# @return [Array<(AccountsGetResponse, Integer, Hash)>] AccountsGetResponse data, response status code and response headers
|
@@ -734,266 +734,6 @@ module Plaid
|
|
734
734
|
return data, status_code, headers
|
735
735
|
end
|
736
736
|
|
737
|
-
# Create an `asset_relay_token` to share an Asset Report with a partner client
|
738
|
-
# Plaid can share an Asset Report directly with a participating third party on your behalf. The shared Asset Report is the exact same Asset Report originally created in `/asset_report/create`. To grant access to an Asset Report to a third party, use the `/asset_report/relay/create` endpoint to create an `asset_relay_token` and then pass that token to the third party who needs access. Each third party has its own `secondary_client_id`, for example `ce5bd328dcd34123456`. You'll need to create a separate `asset_relay_token` for each third party to whom you want to grant access to the Report.
|
739
|
-
# @param asset_report_relay_create_request [AssetReportRelayCreateRequest]
|
740
|
-
# @param [Hash] opts the optional parameters
|
741
|
-
# @return [AssetReportRelayCreateResponse]
|
742
|
-
def asset_report_relay_create(asset_report_relay_create_request, opts = {})
|
743
|
-
data, _status_code, _headers = asset_report_relay_create_with_http_info(asset_report_relay_create_request, opts)
|
744
|
-
data
|
745
|
-
end
|
746
|
-
|
747
|
-
# Create an `asset_relay_token` to share an Asset Report with a partner client
|
748
|
-
# Plaid can share an Asset Report directly with a participating third party on your behalf. The shared Asset Report is the exact same Asset Report originally created in `/asset_report/create`. To grant access to an Asset Report to a third party, use the `/asset_report/relay/create` endpoint to create an `asset_relay_token` and then pass that token to the third party who needs access. Each third party has its own `secondary_client_id`, for example `ce5bd328dcd34123456`. You'll need to create a separate `asset_relay_token` for each third party to whom you want to grant access to the Report.
|
749
|
-
# @param asset_report_relay_create_request [AssetReportRelayCreateRequest]
|
750
|
-
# @param [Hash] opts the optional parameters
|
751
|
-
# @return [Array<(AssetReportRelayCreateResponse, Integer, Hash)>] AssetReportRelayCreateResponse data, response status code and response headers
|
752
|
-
def asset_report_relay_create_with_http_info(asset_report_relay_create_request, opts = {})
|
753
|
-
if @api_client.config.debugging
|
754
|
-
@api_client.config.logger.debug 'Calling API: PlaidApi.asset_report_relay_create ...'
|
755
|
-
end
|
756
|
-
# verify the required parameter 'asset_report_relay_create_request' is set
|
757
|
-
if @api_client.config.client_side_validation && asset_report_relay_create_request.nil?
|
758
|
-
fail ArgumentError, "Missing the required parameter 'asset_report_relay_create_request' when calling PlaidApi.asset_report_relay_create"
|
759
|
-
end
|
760
|
-
# resource path
|
761
|
-
local_var_path = '/asset_report/relay/create'
|
762
|
-
|
763
|
-
# query parameters
|
764
|
-
query_params = opts[:query_params] || {}
|
765
|
-
|
766
|
-
# header parameters
|
767
|
-
header_params = opts[:header_params] || {}
|
768
|
-
# HTTP header 'Accept' (if needed)
|
769
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
770
|
-
# HTTP header 'Content-Type'
|
771
|
-
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
772
|
-
|
773
|
-
# form parameters
|
774
|
-
form_params = opts[:form_params] || {}
|
775
|
-
|
776
|
-
# http body (model)
|
777
|
-
post_body = opts[:debug_body] || @api_client.object_to_http_body(asset_report_relay_create_request)
|
778
|
-
|
779
|
-
# return_type
|
780
|
-
return_type = opts[:debug_return_type] || 'AssetReportRelayCreateResponse'
|
781
|
-
|
782
|
-
# auth_names
|
783
|
-
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
784
|
-
|
785
|
-
new_options = opts.merge(
|
786
|
-
:operation => :"PlaidApi.asset_report_relay_create",
|
787
|
-
:header_params => header_params,
|
788
|
-
:query_params => query_params,
|
789
|
-
:form_params => form_params,
|
790
|
-
:body => post_body,
|
791
|
-
:auth_names => auth_names,
|
792
|
-
:return_type => return_type
|
793
|
-
)
|
794
|
-
|
795
|
-
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
796
|
-
if @api_client.config.debugging
|
797
|
-
@api_client.config.logger.debug "API called: PlaidApi#asset_report_relay_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
798
|
-
end
|
799
|
-
return data, status_code, headers
|
800
|
-
end
|
801
|
-
|
802
|
-
# Retrieve an Asset Report that was shared with you
|
803
|
-
# `/asset_report/relay/get` allows third parties to get an Asset Report that was shared with them, using an `asset_relay_token` that was created by the report owner.
|
804
|
-
# @param asset_report_relay_get_request [AssetReportRelayGetRequest]
|
805
|
-
# @param [Hash] opts the optional parameters
|
806
|
-
# @return [AssetReportGetResponse]
|
807
|
-
def asset_report_relay_get(asset_report_relay_get_request, opts = {})
|
808
|
-
data, _status_code, _headers = asset_report_relay_get_with_http_info(asset_report_relay_get_request, opts)
|
809
|
-
data
|
810
|
-
end
|
811
|
-
|
812
|
-
# Retrieve an Asset Report that was shared with you
|
813
|
-
# `/asset_report/relay/get` allows third parties to get an Asset Report that was shared with them, using an `asset_relay_token` that was created by the report owner.
|
814
|
-
# @param asset_report_relay_get_request [AssetReportRelayGetRequest]
|
815
|
-
# @param [Hash] opts the optional parameters
|
816
|
-
# @return [Array<(AssetReportGetResponse, Integer, Hash)>] AssetReportGetResponse data, response status code and response headers
|
817
|
-
def asset_report_relay_get_with_http_info(asset_report_relay_get_request, opts = {})
|
818
|
-
if @api_client.config.debugging
|
819
|
-
@api_client.config.logger.debug 'Calling API: PlaidApi.asset_report_relay_get ...'
|
820
|
-
end
|
821
|
-
# verify the required parameter 'asset_report_relay_get_request' is set
|
822
|
-
if @api_client.config.client_side_validation && asset_report_relay_get_request.nil?
|
823
|
-
fail ArgumentError, "Missing the required parameter 'asset_report_relay_get_request' when calling PlaidApi.asset_report_relay_get"
|
824
|
-
end
|
825
|
-
# resource path
|
826
|
-
local_var_path = '/asset_report/relay/get'
|
827
|
-
|
828
|
-
# query parameters
|
829
|
-
query_params = opts[:query_params] || {}
|
830
|
-
|
831
|
-
# header parameters
|
832
|
-
header_params = opts[:header_params] || {}
|
833
|
-
# HTTP header 'Accept' (if needed)
|
834
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
835
|
-
# HTTP header 'Content-Type'
|
836
|
-
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
837
|
-
|
838
|
-
# form parameters
|
839
|
-
form_params = opts[:form_params] || {}
|
840
|
-
|
841
|
-
# http body (model)
|
842
|
-
post_body = opts[:debug_body] || @api_client.object_to_http_body(asset_report_relay_get_request)
|
843
|
-
|
844
|
-
# return_type
|
845
|
-
return_type = opts[:debug_return_type] || 'AssetReportGetResponse'
|
846
|
-
|
847
|
-
# auth_names
|
848
|
-
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
849
|
-
|
850
|
-
new_options = opts.merge(
|
851
|
-
:operation => :"PlaidApi.asset_report_relay_get",
|
852
|
-
:header_params => header_params,
|
853
|
-
:query_params => query_params,
|
854
|
-
:form_params => form_params,
|
855
|
-
:body => post_body,
|
856
|
-
:auth_names => auth_names,
|
857
|
-
:return_type => return_type
|
858
|
-
)
|
859
|
-
|
860
|
-
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
861
|
-
if @api_client.config.debugging
|
862
|
-
@api_client.config.logger.debug "API called: PlaidApi#asset_report_relay_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
863
|
-
end
|
864
|
-
return data, status_code, headers
|
865
|
-
end
|
866
|
-
|
867
|
-
# Refresh a Relay Token's Asset Report
|
868
|
-
# The `/asset_report/relay/refresh` endpoint allows third parties to refresh an Asset Report that was relayed to them, using an `asset_relay_token` that was created by the report owner. A new Asset Report will be created based on the old one, but with the most recent data available.
|
869
|
-
# @param asset_report_relay_refresh_request [AssetReportRelayRefreshRequest]
|
870
|
-
# @param [Hash] opts the optional parameters
|
871
|
-
# @return [AssetReportRelayRefreshResponse]
|
872
|
-
def asset_report_relay_refresh(asset_report_relay_refresh_request, opts = {})
|
873
|
-
data, _status_code, _headers = asset_report_relay_refresh_with_http_info(asset_report_relay_refresh_request, opts)
|
874
|
-
data
|
875
|
-
end
|
876
|
-
|
877
|
-
# Refresh a Relay Token's Asset Report
|
878
|
-
# The `/asset_report/relay/refresh` endpoint allows third parties to refresh an Asset Report that was relayed to them, using an `asset_relay_token` that was created by the report owner. A new Asset Report will be created based on the old one, but with the most recent data available.
|
879
|
-
# @param asset_report_relay_refresh_request [AssetReportRelayRefreshRequest]
|
880
|
-
# @param [Hash] opts the optional parameters
|
881
|
-
# @return [Array<(AssetReportRelayRefreshResponse, Integer, Hash)>] AssetReportRelayRefreshResponse data, response status code and response headers
|
882
|
-
def asset_report_relay_refresh_with_http_info(asset_report_relay_refresh_request, opts = {})
|
883
|
-
if @api_client.config.debugging
|
884
|
-
@api_client.config.logger.debug 'Calling API: PlaidApi.asset_report_relay_refresh ...'
|
885
|
-
end
|
886
|
-
# verify the required parameter 'asset_report_relay_refresh_request' is set
|
887
|
-
if @api_client.config.client_side_validation && asset_report_relay_refresh_request.nil?
|
888
|
-
fail ArgumentError, "Missing the required parameter 'asset_report_relay_refresh_request' when calling PlaidApi.asset_report_relay_refresh"
|
889
|
-
end
|
890
|
-
# resource path
|
891
|
-
local_var_path = '/asset_report/relay/refresh'
|
892
|
-
|
893
|
-
# query parameters
|
894
|
-
query_params = opts[:query_params] || {}
|
895
|
-
|
896
|
-
# header parameters
|
897
|
-
header_params = opts[:header_params] || {}
|
898
|
-
# HTTP header 'Accept' (if needed)
|
899
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
900
|
-
# HTTP header 'Content-Type'
|
901
|
-
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
902
|
-
|
903
|
-
# form parameters
|
904
|
-
form_params = opts[:form_params] || {}
|
905
|
-
|
906
|
-
# http body (model)
|
907
|
-
post_body = opts[:debug_body] || @api_client.object_to_http_body(asset_report_relay_refresh_request)
|
908
|
-
|
909
|
-
# return_type
|
910
|
-
return_type = opts[:debug_return_type] || 'AssetReportRelayRefreshResponse'
|
911
|
-
|
912
|
-
# auth_names
|
913
|
-
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
914
|
-
|
915
|
-
new_options = opts.merge(
|
916
|
-
:operation => :"PlaidApi.asset_report_relay_refresh",
|
917
|
-
:header_params => header_params,
|
918
|
-
:query_params => query_params,
|
919
|
-
:form_params => form_params,
|
920
|
-
:body => post_body,
|
921
|
-
:auth_names => auth_names,
|
922
|
-
:return_type => return_type
|
923
|
-
)
|
924
|
-
|
925
|
-
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
926
|
-
if @api_client.config.debugging
|
927
|
-
@api_client.config.logger.debug "API called: PlaidApi#asset_report_relay_refresh\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
928
|
-
end
|
929
|
-
return data, status_code, headers
|
930
|
-
end
|
931
|
-
|
932
|
-
# Remove Asset Report Relay Token
|
933
|
-
# The `/asset_report/relay/remove` endpoint allows you to invalidate an `asset_relay_token`, meaning the third party holding the token will no longer be able to use it to access the Asset Report to which the `asset_relay_token` gives access to. The Asset Report, Items associated with it, and other Asset Relay Tokens that provide access to the same Asset Report are not affected and will remain accessible after removing the given `asset_relay_token.
|
934
|
-
# @param asset_report_relay_remove_request [AssetReportRelayRemoveRequest]
|
935
|
-
# @param [Hash] opts the optional parameters
|
936
|
-
# @return [AssetReportRelayRemoveResponse]
|
937
|
-
def asset_report_relay_remove(asset_report_relay_remove_request, opts = {})
|
938
|
-
data, _status_code, _headers = asset_report_relay_remove_with_http_info(asset_report_relay_remove_request, opts)
|
939
|
-
data
|
940
|
-
end
|
941
|
-
|
942
|
-
# Remove Asset Report Relay Token
|
943
|
-
# The `/asset_report/relay/remove` endpoint allows you to invalidate an `asset_relay_token`, meaning the third party holding the token will no longer be able to use it to access the Asset Report to which the `asset_relay_token` gives access to. The Asset Report, Items associated with it, and other Asset Relay Tokens that provide access to the same Asset Report are not affected and will remain accessible after removing the given `asset_relay_token.
|
944
|
-
# @param asset_report_relay_remove_request [AssetReportRelayRemoveRequest]
|
945
|
-
# @param [Hash] opts the optional parameters
|
946
|
-
# @return [Array<(AssetReportRelayRemoveResponse, Integer, Hash)>] AssetReportRelayRemoveResponse data, response status code and response headers
|
947
|
-
def asset_report_relay_remove_with_http_info(asset_report_relay_remove_request, opts = {})
|
948
|
-
if @api_client.config.debugging
|
949
|
-
@api_client.config.logger.debug 'Calling API: PlaidApi.asset_report_relay_remove ...'
|
950
|
-
end
|
951
|
-
# verify the required parameter 'asset_report_relay_remove_request' is set
|
952
|
-
if @api_client.config.client_side_validation && asset_report_relay_remove_request.nil?
|
953
|
-
fail ArgumentError, "Missing the required parameter 'asset_report_relay_remove_request' when calling PlaidApi.asset_report_relay_remove"
|
954
|
-
end
|
955
|
-
# resource path
|
956
|
-
local_var_path = '/asset_report/relay/remove'
|
957
|
-
|
958
|
-
# query parameters
|
959
|
-
query_params = opts[:query_params] || {}
|
960
|
-
|
961
|
-
# header parameters
|
962
|
-
header_params = opts[:header_params] || {}
|
963
|
-
# HTTP header 'Accept' (if needed)
|
964
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
965
|
-
# HTTP header 'Content-Type'
|
966
|
-
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
967
|
-
|
968
|
-
# form parameters
|
969
|
-
form_params = opts[:form_params] || {}
|
970
|
-
|
971
|
-
# http body (model)
|
972
|
-
post_body = opts[:debug_body] || @api_client.object_to_http_body(asset_report_relay_remove_request)
|
973
|
-
|
974
|
-
# return_type
|
975
|
-
return_type = opts[:debug_return_type] || 'AssetReportRelayRemoveResponse'
|
976
|
-
|
977
|
-
# auth_names
|
978
|
-
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
979
|
-
|
980
|
-
new_options = opts.merge(
|
981
|
-
:operation => :"PlaidApi.asset_report_relay_remove",
|
982
|
-
:header_params => header_params,
|
983
|
-
:query_params => query_params,
|
984
|
-
:form_params => form_params,
|
985
|
-
:body => post_body,
|
986
|
-
:auth_names => auth_names,
|
987
|
-
:return_type => return_type
|
988
|
-
)
|
989
|
-
|
990
|
-
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
991
|
-
if @api_client.config.debugging
|
992
|
-
@api_client.config.logger.debug "API called: PlaidApi#asset_report_relay_remove\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
993
|
-
end
|
994
|
-
return data, status_code, headers
|
995
|
-
end
|
996
|
-
|
997
737
|
# Delete an Asset Report
|
998
738
|
# The `/item/remove` endpoint allows you to invalidate an `access_token`, meaning you will not be able to create new Asset Reports with it. Removing an Item does not affect any Asset Reports or Audit Copies you have already created, which will remain accessible until you remove them specifically. The `/asset_report/remove` endpoint allows you to remove an Asset Report. Removing an Asset Report invalidates its `asset_report_token`, meaning you will no longer be able to use it to access Report data or create new Audit Copies. Removing an Asset Report does not affect the underlying Items, but does invalidate any `audit_copy_tokens` associated with the Asset Report.
|
999
739
|
# @param asset_report_remove_request [AssetReportRemoveRequest]
|
@@ -1904,8 +1644,73 @@ module Plaid
|
|
1904
1644
|
return data, status_code, headers
|
1905
1645
|
end
|
1906
1646
|
|
1647
|
+
# Retrieve an Asset Report with Freddie Mac format. Only Freddie Mac can use this endpoint.
|
1648
|
+
# The `credit/asset_report/freddie_mac/get` endpoint retrieves the Asset Report in Freddie Mac's JSON format.
|
1649
|
+
# @param request_body [Hash<String, Object>]
|
1650
|
+
# @param [Hash] opts the optional parameters
|
1651
|
+
# @return [AssetReportFreddieGetResponse]
|
1652
|
+
def credit_asset_report_freddie_mac_get(request_body, opts = {})
|
1653
|
+
data, _status_code, _headers = credit_asset_report_freddie_mac_get_with_http_info(request_body, opts)
|
1654
|
+
data
|
1655
|
+
end
|
1656
|
+
|
1657
|
+
# Retrieve an Asset Report with Freddie Mac format. Only Freddie Mac can use this endpoint.
|
1658
|
+
# The `credit/asset_report/freddie_mac/get` endpoint retrieves the Asset Report in Freddie Mac's JSON format.
|
1659
|
+
# @param request_body [Hash<String, Object>]
|
1660
|
+
# @param [Hash] opts the optional parameters
|
1661
|
+
# @return [Array<(AssetReportFreddieGetResponse, Integer, Hash)>] AssetReportFreddieGetResponse data, response status code and response headers
|
1662
|
+
def credit_asset_report_freddie_mac_get_with_http_info(request_body, opts = {})
|
1663
|
+
if @api_client.config.debugging
|
1664
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.credit_asset_report_freddie_mac_get ...'
|
1665
|
+
end
|
1666
|
+
# verify the required parameter 'request_body' is set
|
1667
|
+
if @api_client.config.client_side_validation && request_body.nil?
|
1668
|
+
fail ArgumentError, "Missing the required parameter 'request_body' when calling PlaidApi.credit_asset_report_freddie_mac_get"
|
1669
|
+
end
|
1670
|
+
# resource path
|
1671
|
+
local_var_path = '/credit/asset_report/freddie_mac/get'
|
1672
|
+
|
1673
|
+
# query parameters
|
1674
|
+
query_params = opts[:query_params] || {}
|
1675
|
+
|
1676
|
+
# header parameters
|
1677
|
+
header_params = opts[:header_params] || {}
|
1678
|
+
# HTTP header 'Accept' (if needed)
|
1679
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1680
|
+
# HTTP header 'Content-Type'
|
1681
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
1682
|
+
|
1683
|
+
# form parameters
|
1684
|
+
form_params = opts[:form_params] || {}
|
1685
|
+
|
1686
|
+
# http body (model)
|
1687
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(request_body)
|
1688
|
+
|
1689
|
+
# return_type
|
1690
|
+
return_type = opts[:debug_return_type] || 'AssetReportFreddieGetResponse'
|
1691
|
+
|
1692
|
+
# auth_names
|
1693
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
1694
|
+
|
1695
|
+
new_options = opts.merge(
|
1696
|
+
:operation => :"PlaidApi.credit_asset_report_freddie_mac_get",
|
1697
|
+
:header_params => header_params,
|
1698
|
+
:query_params => query_params,
|
1699
|
+
:form_params => form_params,
|
1700
|
+
:body => post_body,
|
1701
|
+
:auth_names => auth_names,
|
1702
|
+
:return_type => return_type
|
1703
|
+
)
|
1704
|
+
|
1705
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
1706
|
+
if @api_client.config.debugging
|
1707
|
+
@api_client.config.logger.debug "API called: PlaidApi#credit_asset_report_freddie_mac_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1708
|
+
end
|
1709
|
+
return data, status_code, headers
|
1710
|
+
end
|
1711
|
+
|
1907
1712
|
# Create Asset or Income Report Audit Copy Token
|
1908
|
-
# Plaid can
|
1713
|
+
# Plaid can create an Audit Copy token of an Asset Report and/or Income Report to share with participating Government Sponsored Entity (GSE). If you participate in the Day 1 Certainty™ program, Plaid can supply an Audit Copy token directly to Fannie Mae on your behalf. An Audit Copy token contains the same underlying data as the Asset Report and/or Income Report (result of /credit/payroll_income/get). Use the `/credit/audit_copy_token/create` endpoint to create an `audit_copy_token` and then pass that token to the GSE who needs access.
|
1909
1714
|
# @param credit_audit_copy_token_create_request [CreditAuditCopyTokenCreateRequest]
|
1910
1715
|
# @param [Hash] opts the optional parameters
|
1911
1716
|
# @return [CreditAuditCopyTokenCreateResponse]
|
@@ -1915,7 +1720,7 @@ module Plaid
|
|
1915
1720
|
end
|
1916
1721
|
|
1917
1722
|
# Create Asset or Income Report Audit Copy Token
|
1918
|
-
# Plaid can
|
1723
|
+
# Plaid can create an Audit Copy token of an Asset Report and/or Income Report to share with participating Government Sponsored Entity (GSE). If you participate in the Day 1 Certainty™ program, Plaid can supply an Audit Copy token directly to Fannie Mae on your behalf. An Audit Copy token contains the same underlying data as the Asset Report and/or Income Report (result of /credit/payroll_income/get). Use the `/credit/audit_copy_token/create` endpoint to create an `audit_copy_token` and then pass that token to the GSE who needs access.
|
1919
1724
|
# @param credit_audit_copy_token_create_request [CreditAuditCopyTokenCreateRequest]
|
1920
1725
|
# @param [Hash] opts the optional parameters
|
1921
1726
|
# @return [Array<(CreditAuditCopyTokenCreateResponse, Integer, Hash)>] CreditAuditCopyTokenCreateResponse data, response status code and response headers
|
@@ -2295,7 +2100,7 @@ module Plaid
|
|
2295
2100
|
end
|
2296
2101
|
|
2297
2102
|
# Check income verification eligibility and optimize conversion
|
2298
|
-
# `/credit/payroll_income/precheck` is an optional endpoint that can be called before initializing a Link session for income verification. It evaluates whether a given user is supportable by digital income verification. If the user is eligible for digital verification, that information will be associated with the user token, and in this way will generate a Link UI optimized for the end user and their specific employer. If the user cannot be confirmed as eligible, the user can still use the income verification flow, but they may be required to manually upload a paystub to verify their income. While all request fields are optional, providing `employer` data will increase the chance of receiving a useful result.
|
2103
|
+
# `/credit/payroll_income/precheck` is an optional endpoint that can be called before initializing a Link session for income verification. It evaluates whether a given user is supportable by digital income verification. If the user is eligible for digital verification, that information will be associated with the user token, and in this way will generate a Link UI optimized for the end user and their specific employer. If the user cannot be confirmed as eligible, the user can still use the income verification flow, but they may be required to manually upload a paystub to verify their income. While all request fields are optional, providing `employer` data will increase the chance of receiving a useful result. When testing in Sandbox, you can control the results by providing special test values in the `employer` and `access_tokens` fields. `employer_good` and `employer_bad` will result in `HIGH` and `LOW` confidence values, respectively. `employer_multi` will result in a `HIGH` confidence with multiple payroll options. Likewise, `access_good` and `access_bad` will result in `HIGH` and `LOW` confidence values, respectively. Any other value for `employer` and `access_tokens` in Sandbox will result in `UNKNOWN` confidence.
|
2299
2104
|
# @param credit_payroll_income_precheck_request [CreditPayrollIncomePrecheckRequest]
|
2300
2105
|
# @param [Hash] opts the optional parameters
|
2301
2106
|
# @return [CreditPayrollIncomePrecheckResponse]
|
@@ -2305,7 +2110,7 @@ module Plaid
|
|
2305
2110
|
end
|
2306
2111
|
|
2307
2112
|
# Check income verification eligibility and optimize conversion
|
2308
|
-
# `/credit/payroll_income/precheck` is an optional endpoint that can be called before initializing a Link session for income verification. It evaluates whether a given user is supportable by digital income verification. If the user is eligible for digital verification, that information will be associated with the user token, and in this way will generate a Link UI optimized for the end user and their specific employer. If the user cannot be confirmed as eligible, the user can still use the income verification flow, but they may be required to manually upload a paystub to verify their income. While all request fields are optional, providing `employer` data will increase the chance of receiving a useful result.
|
2113
|
+
# `/credit/payroll_income/precheck` is an optional endpoint that can be called before initializing a Link session for income verification. It evaluates whether a given user is supportable by digital income verification. If the user is eligible for digital verification, that information will be associated with the user token, and in this way will generate a Link UI optimized for the end user and their specific employer. If the user cannot be confirmed as eligible, the user can still use the income verification flow, but they may be required to manually upload a paystub to verify their income. While all request fields are optional, providing `employer` data will increase the chance of receiving a useful result. When testing in Sandbox, you can control the results by providing special test values in the `employer` and `access_tokens` fields. `employer_good` and `employer_bad` will result in `HIGH` and `LOW` confidence values, respectively. `employer_multi` will result in a `HIGH` confidence with multiple payroll options. Likewise, `access_good` and `access_bad` will result in `HIGH` and `LOW` confidence values, respectively. Any other value for `employer` and `access_tokens` in Sandbox will result in `UNKNOWN` confidence.
|
2309
2114
|
# @param credit_payroll_income_precheck_request [CreditPayrollIncomePrecheckRequest]
|
2310
2115
|
# @param [Hash] opts the optional parameters
|
2311
2116
|
# @return [Array<(CreditPayrollIncomePrecheckResponse, Integer, Hash)>] CreditPayrollIncomePrecheckResponse data, response status code and response headers
|
@@ -2749,31 +2554,31 @@ module Plaid
|
|
2749
2554
|
return data, status_code, headers
|
2750
2555
|
end
|
2751
2556
|
|
2752
|
-
#
|
2753
|
-
#
|
2754
|
-
# @param
|
2557
|
+
# Retrieve Link sessions for your user
|
2558
|
+
# This endpoint can be used for your end users after they complete the Link flow. This endpoint returns a list of Link sessions that your user completed, where each session includes the results from the Link flow. These results include details about the Item that was created and some product related metadata (showing, for example, whether the user finished the bank income verification step).
|
2559
|
+
# @param credit_sessions_get_request [CreditSessionsGetRequest]
|
2755
2560
|
# @param [Hash] opts the optional parameters
|
2756
|
-
# @return [
|
2757
|
-
def
|
2758
|
-
data, _status_code, _headers =
|
2561
|
+
# @return [CreditSessionsGetResponse]
|
2562
|
+
def credit_sessions_get(credit_sessions_get_request, opts = {})
|
2563
|
+
data, _status_code, _headers = credit_sessions_get_with_http_info(credit_sessions_get_request, opts)
|
2759
2564
|
data
|
2760
2565
|
end
|
2761
2566
|
|
2762
|
-
#
|
2763
|
-
#
|
2764
|
-
# @param
|
2567
|
+
# Retrieve Link sessions for your user
|
2568
|
+
# This endpoint can be used for your end users after they complete the Link flow. This endpoint returns a list of Link sessions that your user completed, where each session includes the results from the Link flow. These results include details about the Item that was created and some product related metadata (showing, for example, whether the user finished the bank income verification step).
|
2569
|
+
# @param credit_sessions_get_request [CreditSessionsGetRequest]
|
2765
2570
|
# @param [Hash] opts the optional parameters
|
2766
|
-
# @return [Array<(
|
2767
|
-
def
|
2571
|
+
# @return [Array<(CreditSessionsGetResponse, Integer, Hash)>] CreditSessionsGetResponse data, response status code and response headers
|
2572
|
+
def credit_sessions_get_with_http_info(credit_sessions_get_request, opts = {})
|
2768
2573
|
if @api_client.config.debugging
|
2769
|
-
@api_client.config.logger.debug 'Calling API: PlaidApi.
|
2574
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.credit_sessions_get ...'
|
2770
2575
|
end
|
2771
|
-
# verify the required parameter '
|
2772
|
-
if @api_client.config.client_side_validation &&
|
2773
|
-
fail ArgumentError, "Missing the required parameter '
|
2576
|
+
# verify the required parameter 'credit_sessions_get_request' is set
|
2577
|
+
if @api_client.config.client_side_validation && credit_sessions_get_request.nil?
|
2578
|
+
fail ArgumentError, "Missing the required parameter 'credit_sessions_get_request' when calling PlaidApi.credit_sessions_get"
|
2774
2579
|
end
|
2775
2580
|
# resource path
|
2776
|
-
local_var_path = '/
|
2581
|
+
local_var_path = '/credit/sessions/get'
|
2777
2582
|
|
2778
2583
|
# query parameters
|
2779
2584
|
query_params = opts[:query_params] || {}
|
@@ -2789,16 +2594,16 @@ module Plaid
|
|
2789
2594
|
form_params = opts[:form_params] || {}
|
2790
2595
|
|
2791
2596
|
# http body (model)
|
2792
|
-
post_body = opts[:debug_body] || @api_client.object_to_http_body(
|
2597
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(credit_sessions_get_request)
|
2793
2598
|
|
2794
2599
|
# return_type
|
2795
|
-
return_type = opts[:debug_return_type] || '
|
2600
|
+
return_type = opts[:debug_return_type] || 'CreditSessionsGetResponse'
|
2796
2601
|
|
2797
2602
|
# auth_names
|
2798
2603
|
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
2799
2604
|
|
2800
2605
|
new_options = opts.merge(
|
2801
|
-
:operation => :"PlaidApi.
|
2606
|
+
:operation => :"PlaidApi.credit_sessions_get",
|
2802
2607
|
:header_params => header_params,
|
2803
2608
|
:query_params => query_params,
|
2804
2609
|
:form_params => form_params,
|
@@ -2809,33 +2614,33 @@ module Plaid
|
|
2809
2614
|
|
2810
2615
|
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
2811
2616
|
if @api_client.config.debugging
|
2812
|
-
@api_client.config.logger.debug "API called: PlaidApi#
|
2617
|
+
@api_client.config.logger.debug "API called: PlaidApi#credit_sessions_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2813
2618
|
end
|
2814
2619
|
return data, status_code, headers
|
2815
2620
|
end
|
2816
2621
|
|
2817
2622
|
# Retrieve a dashboard user
|
2818
2623
|
# Retrieve information about a dashboard user.
|
2819
|
-
# @param
|
2624
|
+
# @param dashboard_user_get_request [DashboardUserGetRequest]
|
2820
2625
|
# @param [Hash] opts the optional parameters
|
2821
|
-
# @return [
|
2822
|
-
def
|
2823
|
-
data, _status_code, _headers =
|
2626
|
+
# @return [DashboardUserGetResponse]
|
2627
|
+
def dashboard_user_get(dashboard_user_get_request, opts = {})
|
2628
|
+
data, _status_code, _headers = dashboard_user_get_with_http_info(dashboard_user_get_request, opts)
|
2824
2629
|
data
|
2825
2630
|
end
|
2826
2631
|
|
2827
2632
|
# Retrieve a dashboard user
|
2828
2633
|
# Retrieve information about a dashboard user.
|
2829
|
-
# @param
|
2634
|
+
# @param dashboard_user_get_request [DashboardUserGetRequest]
|
2830
2635
|
# @param [Hash] opts the optional parameters
|
2831
|
-
# @return [Array<(
|
2832
|
-
def
|
2636
|
+
# @return [Array<(DashboardUserGetResponse, Integer, Hash)>] DashboardUserGetResponse data, response status code and response headers
|
2637
|
+
def dashboard_user_get_with_http_info(dashboard_user_get_request, opts = {})
|
2833
2638
|
if @api_client.config.debugging
|
2834
|
-
@api_client.config.logger.debug 'Calling API: PlaidApi.
|
2639
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.dashboard_user_get ...'
|
2835
2640
|
end
|
2836
|
-
# verify the required parameter '
|
2837
|
-
if @api_client.config.client_side_validation &&
|
2838
|
-
fail ArgumentError, "Missing the required parameter '
|
2641
|
+
# verify the required parameter 'dashboard_user_get_request' is set
|
2642
|
+
if @api_client.config.client_side_validation && dashboard_user_get_request.nil?
|
2643
|
+
fail ArgumentError, "Missing the required parameter 'dashboard_user_get_request' when calling PlaidApi.dashboard_user_get"
|
2839
2644
|
end
|
2840
2645
|
# resource path
|
2841
2646
|
local_var_path = '/dashboard_user/get'
|
@@ -2854,16 +2659,16 @@ module Plaid
|
|
2854
2659
|
form_params = opts[:form_params] || {}
|
2855
2660
|
|
2856
2661
|
# http body (model)
|
2857
|
-
post_body = opts[:debug_body] || @api_client.object_to_http_body(
|
2662
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(dashboard_user_get_request)
|
2858
2663
|
|
2859
2664
|
# return_type
|
2860
|
-
return_type = opts[:debug_return_type] || '
|
2665
|
+
return_type = opts[:debug_return_type] || 'DashboardUserGetResponse'
|
2861
2666
|
|
2862
2667
|
# auth_names
|
2863
2668
|
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
2864
2669
|
|
2865
2670
|
new_options = opts.merge(
|
2866
|
-
:operation => :"PlaidApi.
|
2671
|
+
:operation => :"PlaidApi.dashboard_user_get",
|
2867
2672
|
:header_params => header_params,
|
2868
2673
|
:query_params => query_params,
|
2869
2674
|
:form_params => form_params,
|
@@ -2874,27 +2679,92 @@ module Plaid
|
|
2874
2679
|
|
2875
2680
|
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
2876
2681
|
if @api_client.config.debugging
|
2877
|
-
@api_client.config.logger.debug "API called: PlaidApi#
|
2682
|
+
@api_client.config.logger.debug "API called: PlaidApi#dashboard_user_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2878
2683
|
end
|
2879
2684
|
return data, status_code, headers
|
2880
2685
|
end
|
2881
2686
|
|
2882
|
-
#
|
2883
|
-
#
|
2884
|
-
# @param
|
2687
|
+
# List dashboard users
|
2688
|
+
# List all dashboard users associated with your account.
|
2689
|
+
# @param dashboard_user_list_request [DashboardUserListRequest]
|
2885
2690
|
# @param [Hash] opts the optional parameters
|
2886
|
-
# @return [
|
2887
|
-
def
|
2888
|
-
data, _status_code, _headers =
|
2691
|
+
# @return [DashboardUserListResponse]
|
2692
|
+
def dashboard_user_list(dashboard_user_list_request, opts = {})
|
2693
|
+
data, _status_code, _headers = dashboard_user_list_with_http_info(dashboard_user_list_request, opts)
|
2889
2694
|
data
|
2890
2695
|
end
|
2891
2696
|
|
2892
|
-
#
|
2893
|
-
#
|
2894
|
-
# @param
|
2697
|
+
# List dashboard users
|
2698
|
+
# List all dashboard users associated with your account.
|
2699
|
+
# @param dashboard_user_list_request [DashboardUserListRequest]
|
2895
2700
|
# @param [Hash] opts the optional parameters
|
2896
|
-
# @return [Array<(
|
2897
|
-
def
|
2701
|
+
# @return [Array<(DashboardUserListResponse, Integer, Hash)>] DashboardUserListResponse data, response status code and response headers
|
2702
|
+
def dashboard_user_list_with_http_info(dashboard_user_list_request, opts = {})
|
2703
|
+
if @api_client.config.debugging
|
2704
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.dashboard_user_list ...'
|
2705
|
+
end
|
2706
|
+
# verify the required parameter 'dashboard_user_list_request' is set
|
2707
|
+
if @api_client.config.client_side_validation && dashboard_user_list_request.nil?
|
2708
|
+
fail ArgumentError, "Missing the required parameter 'dashboard_user_list_request' when calling PlaidApi.dashboard_user_list"
|
2709
|
+
end
|
2710
|
+
# resource path
|
2711
|
+
local_var_path = '/dashboard_user/list'
|
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(dashboard_user_list_request)
|
2728
|
+
|
2729
|
+
# return_type
|
2730
|
+
return_type = opts[:debug_return_type] || 'DashboardUserListResponse'
|
2731
|
+
|
2732
|
+
# auth_names
|
2733
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
2734
|
+
|
2735
|
+
new_options = opts.merge(
|
2736
|
+
:operation => :"PlaidApi.dashboard_user_list",
|
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#dashboard_user_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2748
|
+
end
|
2749
|
+
return data, status_code, headers
|
2750
|
+
end
|
2751
|
+
|
2752
|
+
# Create a deposit switch without using Plaid Exchange
|
2753
|
+
# This endpoint provides an alternative to `/deposit_switch/create` for customers who have not yet fully integrated with Plaid Exchange. Like `/deposit_switch/create`, it creates a deposit switch entity that will be persisted throughout the lifecycle of the switch.
|
2754
|
+
# @param deposit_switch_alt_create_request [DepositSwitchAltCreateRequest]
|
2755
|
+
# @param [Hash] opts the optional parameters
|
2756
|
+
# @return [DepositSwitchAltCreateResponse]
|
2757
|
+
def deposit_switch_alt_create(deposit_switch_alt_create_request, opts = {})
|
2758
|
+
data, _status_code, _headers = deposit_switch_alt_create_with_http_info(deposit_switch_alt_create_request, opts)
|
2759
|
+
data
|
2760
|
+
end
|
2761
|
+
|
2762
|
+
# Create a deposit switch without using Plaid Exchange
|
2763
|
+
# This endpoint provides an alternative to `/deposit_switch/create` for customers who have not yet fully integrated with Plaid Exchange. Like `/deposit_switch/create`, it creates a deposit switch entity that will be persisted throughout the lifecycle of the switch.
|
2764
|
+
# @param deposit_switch_alt_create_request [DepositSwitchAltCreateRequest]
|
2765
|
+
# @param [Hash] opts the optional parameters
|
2766
|
+
# @return [Array<(DepositSwitchAltCreateResponse, Integer, Hash)>] DepositSwitchAltCreateResponse data, response status code and response headers
|
2767
|
+
def deposit_switch_alt_create_with_http_info(deposit_switch_alt_create_request, opts = {})
|
2898
2768
|
if @api_client.config.debugging
|
2899
2769
|
@api_client.config.logger.debug 'Calling API: PlaidApi.deposit_switch_alt_create ...'
|
2900
2770
|
end
|
@@ -3269,6 +3139,71 @@ module Plaid
|
|
3269
3139
|
return data, status_code, headers
|
3270
3140
|
end
|
3271
3141
|
|
3142
|
+
# Webhook receiver for fdx notifications
|
3143
|
+
# A generic webhook receiver endpoint for FDX Event Notifications
|
3144
|
+
# @param fdx_notification [FDXNotification]
|
3145
|
+
# @param [Hash] opts the optional parameters
|
3146
|
+
# @return [nil]
|
3147
|
+
def fdx_notifications(fdx_notification, opts = {})
|
3148
|
+
fdx_notifications_with_http_info(fdx_notification, opts)
|
3149
|
+
nil
|
3150
|
+
end
|
3151
|
+
|
3152
|
+
# Webhook receiver for fdx notifications
|
3153
|
+
# A generic webhook receiver endpoint for FDX Event Notifications
|
3154
|
+
# @param fdx_notification [FDXNotification]
|
3155
|
+
# @param [Hash] opts the optional parameters
|
3156
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
3157
|
+
def fdx_notifications_with_http_info(fdx_notification, opts = {})
|
3158
|
+
if @api_client.config.debugging
|
3159
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.fdx_notifications ...'
|
3160
|
+
end
|
3161
|
+
# verify the required parameter 'fdx_notification' is set
|
3162
|
+
if @api_client.config.client_side_validation && fdx_notification.nil?
|
3163
|
+
fail ArgumentError, "Missing the required parameter 'fdx_notification' when calling PlaidApi.fdx_notifications"
|
3164
|
+
end
|
3165
|
+
# resource path
|
3166
|
+
local_var_path = '/fdx/notifications'
|
3167
|
+
|
3168
|
+
# query parameters
|
3169
|
+
query_params = opts[:query_params] || {}
|
3170
|
+
|
3171
|
+
# header parameters
|
3172
|
+
header_params = opts[:header_params] || {}
|
3173
|
+
# HTTP header 'Accept' (if needed)
|
3174
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
3175
|
+
# HTTP header 'Content-Type'
|
3176
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
3177
|
+
|
3178
|
+
# form parameters
|
3179
|
+
form_params = opts[:form_params] || {}
|
3180
|
+
|
3181
|
+
# http body (model)
|
3182
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(fdx_notification)
|
3183
|
+
|
3184
|
+
# return_type
|
3185
|
+
return_type = opts[:debug_return_type]
|
3186
|
+
|
3187
|
+
# auth_names
|
3188
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
3189
|
+
|
3190
|
+
new_options = opts.merge(
|
3191
|
+
:operation => :"PlaidApi.fdx_notifications",
|
3192
|
+
:header_params => header_params,
|
3193
|
+
:query_params => query_params,
|
3194
|
+
:form_params => form_params,
|
3195
|
+
:body => post_body,
|
3196
|
+
:auth_names => auth_names,
|
3197
|
+
:return_type => return_type
|
3198
|
+
)
|
3199
|
+
|
3200
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
3201
|
+
if @api_client.config.debugging
|
3202
|
+
@api_client.config.logger.debug "API called: PlaidApi#fdx_notifications\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
3203
|
+
end
|
3204
|
+
return data, status_code, headers
|
3205
|
+
end
|
3206
|
+
|
3272
3207
|
# Retrieve identity data
|
3273
3208
|
# The `/identity/get` endpoint allows you to retrieve various account holder information on file with the financial institution, including names, emails, phone numbers, and addresses. Only name data is guaranteed to be returned; other fields will be empty arrays if not provided by the institution. 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. Note: In API versions 2018-05-22 and earlier, the `owners` object is not returned, and instead identity information is returned in the top level `identity` object. For more details, see [Plaid API versioning](https://plaid.com/docs/api/versioning/#version-2019-05-29).
|
3274
3209
|
# @param identity_get_request [IdentityGetRequest]
|
@@ -3403,7 +3338,7 @@ module Plaid
|
|
3403
3338
|
# 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.
|
3404
3339
|
# @param identity_verification_create_request [IdentityVerificationCreateRequest]
|
3405
3340
|
# @param [Hash] opts the optional parameters
|
3406
|
-
# @return [
|
3341
|
+
# @return [IdentityVerificationCreateResponse]
|
3407
3342
|
def identity_verification_create(identity_verification_create_request, opts = {})
|
3408
3343
|
data, _status_code, _headers = identity_verification_create_with_http_info(identity_verification_create_request, opts)
|
3409
3344
|
data
|
@@ -3413,7 +3348,7 @@ module Plaid
|
|
3413
3348
|
# 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.
|
3414
3349
|
# @param identity_verification_create_request [IdentityVerificationCreateRequest]
|
3415
3350
|
# @param [Hash] opts the optional parameters
|
3416
|
-
# @return [Array<(
|
3351
|
+
# @return [Array<(IdentityVerificationCreateResponse, Integer, Hash)>] IdentityVerificationCreateResponse data, response status code and response headers
|
3417
3352
|
def identity_verification_create_with_http_info(identity_verification_create_request, opts = {})
|
3418
3353
|
if @api_client.config.debugging
|
3419
3354
|
@api_client.config.logger.debug 'Calling API: PlaidApi.identity_verification_create ...'
|
@@ -3442,7 +3377,7 @@ module Plaid
|
|
3442
3377
|
post_body = opts[:debug_body] || @api_client.object_to_http_body(identity_verification_create_request)
|
3443
3378
|
|
3444
3379
|
# return_type
|
3445
|
-
return_type = opts[:debug_return_type] || '
|
3380
|
+
return_type = opts[:debug_return_type] || 'IdentityVerificationCreateResponse'
|
3446
3381
|
|
3447
3382
|
# auth_names
|
3448
3383
|
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
@@ -3465,27 +3400,27 @@ module Plaid
|
|
3465
3400
|
end
|
3466
3401
|
|
3467
3402
|
# Retrieve Identity Verification
|
3468
|
-
# Retrieve a previously created identity verification
|
3469
|
-
# @param
|
3403
|
+
# Retrieve a previously created identity verification.
|
3404
|
+
# @param identity_verification_get_request [IdentityVerificationGetRequest]
|
3470
3405
|
# @param [Hash] opts the optional parameters
|
3471
|
-
# @return [
|
3472
|
-
def identity_verification_get(
|
3473
|
-
data, _status_code, _headers = identity_verification_get_with_http_info(
|
3406
|
+
# @return [IdentityVerificationGetResponse]
|
3407
|
+
def identity_verification_get(identity_verification_get_request, opts = {})
|
3408
|
+
data, _status_code, _headers = identity_verification_get_with_http_info(identity_verification_get_request, opts)
|
3474
3409
|
data
|
3475
3410
|
end
|
3476
3411
|
|
3477
3412
|
# Retrieve Identity Verification
|
3478
|
-
# Retrieve a previously created identity verification
|
3479
|
-
# @param
|
3413
|
+
# Retrieve a previously created identity verification.
|
3414
|
+
# @param identity_verification_get_request [IdentityVerificationGetRequest]
|
3480
3415
|
# @param [Hash] opts the optional parameters
|
3481
|
-
# @return [Array<(
|
3482
|
-
def identity_verification_get_with_http_info(
|
3416
|
+
# @return [Array<(IdentityVerificationGetResponse, Integer, Hash)>] IdentityVerificationGetResponse data, response status code and response headers
|
3417
|
+
def identity_verification_get_with_http_info(identity_verification_get_request, opts = {})
|
3483
3418
|
if @api_client.config.debugging
|
3484
3419
|
@api_client.config.logger.debug 'Calling API: PlaidApi.identity_verification_get ...'
|
3485
3420
|
end
|
3486
|
-
# verify the required parameter '
|
3487
|
-
if @api_client.config.client_side_validation &&
|
3488
|
-
fail ArgumentError, "Missing the required parameter '
|
3421
|
+
# verify the required parameter 'identity_verification_get_request' is set
|
3422
|
+
if @api_client.config.client_side_validation && identity_verification_get_request.nil?
|
3423
|
+
fail ArgumentError, "Missing the required parameter 'identity_verification_get_request' when calling PlaidApi.identity_verification_get"
|
3489
3424
|
end
|
3490
3425
|
# resource path
|
3491
3426
|
local_var_path = '/identity_verification/get'
|
@@ -3504,10 +3439,10 @@ module Plaid
|
|
3504
3439
|
form_params = opts[:form_params] || {}
|
3505
3440
|
|
3506
3441
|
# http body (model)
|
3507
|
-
post_body = opts[:debug_body] || @api_client.object_to_http_body(
|
3442
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(identity_verification_get_request)
|
3508
3443
|
|
3509
3444
|
# return_type
|
3510
|
-
return_type = opts[:debug_return_type] || '
|
3445
|
+
return_type = opts[:debug_return_type] || 'IdentityVerificationGetResponse'
|
3511
3446
|
|
3512
3447
|
# auth_names
|
3513
3448
|
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
@@ -3531,26 +3466,26 @@ module Plaid
|
|
3531
3466
|
|
3532
3467
|
# List Identity Verifications
|
3533
3468
|
# Filter and list Identity Verifications created by your account
|
3534
|
-
# @param
|
3469
|
+
# @param identity_verification_list_request [IdentityVerificationListRequest]
|
3535
3470
|
# @param [Hash] opts the optional parameters
|
3536
|
-
# @return [
|
3537
|
-
def identity_verification_list(
|
3538
|
-
data, _status_code, _headers = identity_verification_list_with_http_info(
|
3471
|
+
# @return [IdentityVerificationListResponse]
|
3472
|
+
def identity_verification_list(identity_verification_list_request, opts = {})
|
3473
|
+
data, _status_code, _headers = identity_verification_list_with_http_info(identity_verification_list_request, opts)
|
3539
3474
|
data
|
3540
3475
|
end
|
3541
3476
|
|
3542
3477
|
# List Identity Verifications
|
3543
3478
|
# Filter and list Identity Verifications created by your account
|
3544
|
-
# @param
|
3479
|
+
# @param identity_verification_list_request [IdentityVerificationListRequest]
|
3545
3480
|
# @param [Hash] opts the optional parameters
|
3546
|
-
# @return [Array<(
|
3547
|
-
def identity_verification_list_with_http_info(
|
3481
|
+
# @return [Array<(IdentityVerificationListResponse, Integer, Hash)>] IdentityVerificationListResponse data, response status code and response headers
|
3482
|
+
def identity_verification_list_with_http_info(identity_verification_list_request, opts = {})
|
3548
3483
|
if @api_client.config.debugging
|
3549
3484
|
@api_client.config.logger.debug 'Calling API: PlaidApi.identity_verification_list ...'
|
3550
3485
|
end
|
3551
|
-
# verify the required parameter '
|
3552
|
-
if @api_client.config.client_side_validation &&
|
3553
|
-
fail ArgumentError, "Missing the required parameter '
|
3486
|
+
# verify the required parameter 'identity_verification_list_request' is set
|
3487
|
+
if @api_client.config.client_side_validation && identity_verification_list_request.nil?
|
3488
|
+
fail ArgumentError, "Missing the required parameter 'identity_verification_list_request' when calling PlaidApi.identity_verification_list"
|
3554
3489
|
end
|
3555
3490
|
# resource path
|
3556
3491
|
local_var_path = '/identity_verification/list'
|
@@ -3569,10 +3504,10 @@ module Plaid
|
|
3569
3504
|
form_params = opts[:form_params] || {}
|
3570
3505
|
|
3571
3506
|
# http body (model)
|
3572
|
-
post_body = opts[:debug_body] || @api_client.object_to_http_body(
|
3507
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(identity_verification_list_request)
|
3573
3508
|
|
3574
3509
|
# return_type
|
3575
|
-
return_type = opts[:debug_return_type] || '
|
3510
|
+
return_type = opts[:debug_return_type] || 'IdentityVerificationListResponse'
|
3576
3511
|
|
3577
3512
|
# auth_names
|
3578
3513
|
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
@@ -3598,7 +3533,7 @@ module Plaid
|
|
3598
3533
|
# Allow a customer to retry their identity verification
|
3599
3534
|
# @param identity_verification_retry_request [IdentityVerificationRetryRequest]
|
3600
3535
|
# @param [Hash] opts the optional parameters
|
3601
|
-
# @return [
|
3536
|
+
# @return [IdentityVerificationRetryResponse]
|
3602
3537
|
def identity_verification_retry(identity_verification_retry_request, opts = {})
|
3603
3538
|
data, _status_code, _headers = identity_verification_retry_with_http_info(identity_verification_retry_request, opts)
|
3604
3539
|
data
|
@@ -3608,7 +3543,7 @@ module Plaid
|
|
3608
3543
|
# Allow a customer to retry their identity verification
|
3609
3544
|
# @param identity_verification_retry_request [IdentityVerificationRetryRequest]
|
3610
3545
|
# @param [Hash] opts the optional parameters
|
3611
|
-
# @return [Array<(
|
3546
|
+
# @return [Array<(IdentityVerificationRetryResponse, Integer, Hash)>] IdentityVerificationRetryResponse data, response status code and response headers
|
3612
3547
|
def identity_verification_retry_with_http_info(identity_verification_retry_request, opts = {})
|
3613
3548
|
if @api_client.config.debugging
|
3614
3549
|
@api_client.config.logger.debug 'Calling API: PlaidApi.identity_verification_retry ...'
|
@@ -3637,7 +3572,7 @@ module Plaid
|
|
3637
3572
|
post_body = opts[:debug_body] || @api_client.object_to_http_body(identity_verification_retry_request)
|
3638
3573
|
|
3639
3574
|
# return_type
|
3640
|
-
return_type = opts[:debug_return_type] || '
|
3575
|
+
return_type = opts[:debug_return_type] || 'IdentityVerificationRetryResponse'
|
3641
3576
|
|
3642
3577
|
# auth_names
|
3643
3578
|
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
@@ -4644,21 +4579,346 @@ module Plaid
|
|
4644
4579
|
data
|
4645
4580
|
end
|
4646
4581
|
|
4647
|
-
# Retrieve an Item
|
4648
|
-
# Returns information about the status of an Item.
|
4649
|
-
# @param item_get_request [ItemGetRequest]
|
4582
|
+
# Retrieve an Item
|
4583
|
+
# Returns information about the status of an Item.
|
4584
|
+
# @param item_get_request [ItemGetRequest]
|
4585
|
+
# @param [Hash] opts the optional parameters
|
4586
|
+
# @return [Array<(ItemGetResponse, Integer, Hash)>] ItemGetResponse data, response status code and response headers
|
4587
|
+
def item_get_with_http_info(item_get_request, opts = {})
|
4588
|
+
if @api_client.config.debugging
|
4589
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.item_get ...'
|
4590
|
+
end
|
4591
|
+
# verify the required parameter 'item_get_request' is set
|
4592
|
+
if @api_client.config.client_side_validation && item_get_request.nil?
|
4593
|
+
fail ArgumentError, "Missing the required parameter 'item_get_request' when calling PlaidApi.item_get"
|
4594
|
+
end
|
4595
|
+
# resource path
|
4596
|
+
local_var_path = '/item/get'
|
4597
|
+
|
4598
|
+
# query parameters
|
4599
|
+
query_params = opts[:query_params] || {}
|
4600
|
+
|
4601
|
+
# header parameters
|
4602
|
+
header_params = opts[:header_params] || {}
|
4603
|
+
# HTTP header 'Accept' (if needed)
|
4604
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
4605
|
+
# HTTP header 'Content-Type'
|
4606
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
4607
|
+
|
4608
|
+
# form parameters
|
4609
|
+
form_params = opts[:form_params] || {}
|
4610
|
+
|
4611
|
+
# http body (model)
|
4612
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(item_get_request)
|
4613
|
+
|
4614
|
+
# return_type
|
4615
|
+
return_type = opts[:debug_return_type] || 'ItemGetResponse'
|
4616
|
+
|
4617
|
+
# auth_names
|
4618
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
4619
|
+
|
4620
|
+
new_options = opts.merge(
|
4621
|
+
:operation => :"PlaidApi.item_get",
|
4622
|
+
:header_params => header_params,
|
4623
|
+
:query_params => query_params,
|
4624
|
+
:form_params => form_params,
|
4625
|
+
:body => post_body,
|
4626
|
+
:auth_names => auth_names,
|
4627
|
+
:return_type => return_type
|
4628
|
+
)
|
4629
|
+
|
4630
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
4631
|
+
if @api_client.config.debugging
|
4632
|
+
@api_client.config.logger.debug "API called: PlaidApi#item_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
4633
|
+
end
|
4634
|
+
return data, status_code, headers
|
4635
|
+
end
|
4636
|
+
|
4637
|
+
# Import Item
|
4638
|
+
# `/item/import` creates an Item via your Plaid Exchange Integration and returns an `access_token`. As part of an `/item/import` request, you will include a User ID (`user_auth.user_id`) and Authentication Token (`user_auth.auth_token`) that enable data aggregation through your Plaid Exchange API endpoints. These authentication principals are to be chosen by you. Upon creating an Item via `/item/import`, Plaid will automatically begin an extraction of that Item through the Plaid Exchange infrastructure you have already integrated. This will automatically generate the Plaid native account ID for the account the user will switch their direct deposit to (`target_account_id`).
|
4639
|
+
# @param item_import_request [ItemImportRequest]
|
4640
|
+
# @param [Hash] opts the optional parameters
|
4641
|
+
# @return [ItemImportResponse]
|
4642
|
+
def item_import(item_import_request, opts = {})
|
4643
|
+
data, _status_code, _headers = item_import_with_http_info(item_import_request, opts)
|
4644
|
+
data
|
4645
|
+
end
|
4646
|
+
|
4647
|
+
# Import Item
|
4648
|
+
# `/item/import` creates an Item via your Plaid Exchange Integration and returns an `access_token`. As part of an `/item/import` request, you will include a User ID (`user_auth.user_id`) and Authentication Token (`user_auth.auth_token`) that enable data aggregation through your Plaid Exchange API endpoints. These authentication principals are to be chosen by you. Upon creating an Item via `/item/import`, Plaid will automatically begin an extraction of that Item through the Plaid Exchange infrastructure you have already integrated. This will automatically generate the Plaid native account ID for the account the user will switch their direct deposit to (`target_account_id`).
|
4649
|
+
# @param item_import_request [ItemImportRequest]
|
4650
|
+
# @param [Hash] opts the optional parameters
|
4651
|
+
# @return [Array<(ItemImportResponse, Integer, Hash)>] ItemImportResponse data, response status code and response headers
|
4652
|
+
def item_import_with_http_info(item_import_request, opts = {})
|
4653
|
+
if @api_client.config.debugging
|
4654
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.item_import ...'
|
4655
|
+
end
|
4656
|
+
# verify the required parameter 'item_import_request' is set
|
4657
|
+
if @api_client.config.client_side_validation && item_import_request.nil?
|
4658
|
+
fail ArgumentError, "Missing the required parameter 'item_import_request' when calling PlaidApi.item_import"
|
4659
|
+
end
|
4660
|
+
# resource path
|
4661
|
+
local_var_path = '/item/import'
|
4662
|
+
|
4663
|
+
# query parameters
|
4664
|
+
query_params = opts[:query_params] || {}
|
4665
|
+
|
4666
|
+
# header parameters
|
4667
|
+
header_params = opts[:header_params] || {}
|
4668
|
+
# HTTP header 'Accept' (if needed)
|
4669
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
4670
|
+
# HTTP header 'Content-Type'
|
4671
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
4672
|
+
|
4673
|
+
# form parameters
|
4674
|
+
form_params = opts[:form_params] || {}
|
4675
|
+
|
4676
|
+
# http body (model)
|
4677
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(item_import_request)
|
4678
|
+
|
4679
|
+
# return_type
|
4680
|
+
return_type = opts[:debug_return_type] || 'ItemImportResponse'
|
4681
|
+
|
4682
|
+
# auth_names
|
4683
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
4684
|
+
|
4685
|
+
new_options = opts.merge(
|
4686
|
+
:operation => :"PlaidApi.item_import",
|
4687
|
+
:header_params => header_params,
|
4688
|
+
:query_params => query_params,
|
4689
|
+
:form_params => form_params,
|
4690
|
+
:body => post_body,
|
4691
|
+
:auth_names => auth_names,
|
4692
|
+
:return_type => return_type
|
4693
|
+
)
|
4694
|
+
|
4695
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
4696
|
+
if @api_client.config.debugging
|
4697
|
+
@api_client.config.logger.debug "API called: PlaidApi#item_import\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
4698
|
+
end
|
4699
|
+
return data, status_code, headers
|
4700
|
+
end
|
4701
|
+
|
4702
|
+
# Exchange public token for an access token
|
4703
|
+
# Exchange a Link `public_token` for an API `access_token`. Link hands off the `public_token` client-side via the `onSuccess` callback once a user has successfully created an Item. The `public_token` is ephemeral and expires after 30 minutes. An `access_token` does not expire, but can be revoked by calling `/item/remove`. The response also includes an `item_id` that should be stored with the `access_token`. The `item_id` is used to identify an Item in a webhook. The `item_id` can also be retrieved by making an `/item/get` request.
|
4704
|
+
# @param item_public_token_exchange_request [ItemPublicTokenExchangeRequest]
|
4705
|
+
# @param [Hash] opts the optional parameters
|
4706
|
+
# @return [ItemPublicTokenExchangeResponse]
|
4707
|
+
def item_public_token_exchange(item_public_token_exchange_request, opts = {})
|
4708
|
+
data, _status_code, _headers = item_public_token_exchange_with_http_info(item_public_token_exchange_request, opts)
|
4709
|
+
data
|
4710
|
+
end
|
4711
|
+
|
4712
|
+
# Exchange public token for an access token
|
4713
|
+
# Exchange a Link `public_token` for an API `access_token`. Link hands off the `public_token` client-side via the `onSuccess` callback once a user has successfully created an Item. The `public_token` is ephemeral and expires after 30 minutes. An `access_token` does not expire, but can be revoked by calling `/item/remove`. The response also includes an `item_id` that should be stored with the `access_token`. The `item_id` is used to identify an Item in a webhook. The `item_id` can also be retrieved by making an `/item/get` request.
|
4714
|
+
# @param item_public_token_exchange_request [ItemPublicTokenExchangeRequest]
|
4715
|
+
# @param [Hash] opts the optional parameters
|
4716
|
+
# @return [Array<(ItemPublicTokenExchangeResponse, Integer, Hash)>] ItemPublicTokenExchangeResponse data, response status code and response headers
|
4717
|
+
def item_public_token_exchange_with_http_info(item_public_token_exchange_request, opts = {})
|
4718
|
+
if @api_client.config.debugging
|
4719
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.item_public_token_exchange ...'
|
4720
|
+
end
|
4721
|
+
# verify the required parameter 'item_public_token_exchange_request' is set
|
4722
|
+
if @api_client.config.client_side_validation && item_public_token_exchange_request.nil?
|
4723
|
+
fail ArgumentError, "Missing the required parameter 'item_public_token_exchange_request' when calling PlaidApi.item_public_token_exchange"
|
4724
|
+
end
|
4725
|
+
# resource path
|
4726
|
+
local_var_path = '/item/public_token/exchange'
|
4727
|
+
|
4728
|
+
# query parameters
|
4729
|
+
query_params = opts[:query_params] || {}
|
4730
|
+
|
4731
|
+
# header parameters
|
4732
|
+
header_params = opts[:header_params] || {}
|
4733
|
+
# HTTP header 'Accept' (if needed)
|
4734
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
4735
|
+
# HTTP header 'Content-Type'
|
4736
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
4737
|
+
|
4738
|
+
# form parameters
|
4739
|
+
form_params = opts[:form_params] || {}
|
4740
|
+
|
4741
|
+
# http body (model)
|
4742
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(item_public_token_exchange_request)
|
4743
|
+
|
4744
|
+
# return_type
|
4745
|
+
return_type = opts[:debug_return_type] || 'ItemPublicTokenExchangeResponse'
|
4746
|
+
|
4747
|
+
# auth_names
|
4748
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
4749
|
+
|
4750
|
+
new_options = opts.merge(
|
4751
|
+
:operation => :"PlaidApi.item_public_token_exchange",
|
4752
|
+
:header_params => header_params,
|
4753
|
+
:query_params => query_params,
|
4754
|
+
:form_params => form_params,
|
4755
|
+
:body => post_body,
|
4756
|
+
:auth_names => auth_names,
|
4757
|
+
:return_type => return_type
|
4758
|
+
)
|
4759
|
+
|
4760
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
4761
|
+
if @api_client.config.debugging
|
4762
|
+
@api_client.config.logger.debug "API called: PlaidApi#item_public_token_exchange\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
4763
|
+
end
|
4764
|
+
return data, status_code, headers
|
4765
|
+
end
|
4766
|
+
|
4767
|
+
# Remove an Item
|
4768
|
+
# The `/item/remove` endpoint allows you to remove an Item. Once removed, the `access_token`, as well as any processor tokens or bank account tokens associated with the Item, is no longer valid and cannot be used to access any data that was associated with the Item. Note that in the Development environment, issuing an `/item/remove` request will not decrement your live credential count. To increase your credential account in Development, contact Support. Also note that for certain OAuth-based institutions, an Item removed via `/item/remove` may still show as an active connection in the institution's OAuth permission manager. API versions 2019-05-29 and earlier return a `removed` boolean as part of the response.
|
4769
|
+
# @param item_remove_request [ItemRemoveRequest]
|
4770
|
+
# @param [Hash] opts the optional parameters
|
4771
|
+
# @return [ItemRemoveResponse]
|
4772
|
+
def item_remove(item_remove_request, opts = {})
|
4773
|
+
data, _status_code, _headers = item_remove_with_http_info(item_remove_request, opts)
|
4774
|
+
data
|
4775
|
+
end
|
4776
|
+
|
4777
|
+
# Remove an Item
|
4778
|
+
# The `/item/remove` endpoint allows you to remove an Item. Once removed, the `access_token`, as well as any processor tokens or bank account tokens associated with the Item, is no longer valid and cannot be used to access any data that was associated with the Item. Note that in the Development environment, issuing an `/item/remove` request will not decrement your live credential count. To increase your credential account in Development, contact Support. Also note that for certain OAuth-based institutions, an Item removed via `/item/remove` may still show as an active connection in the institution's OAuth permission manager. API versions 2019-05-29 and earlier return a `removed` boolean as part of the response.
|
4779
|
+
# @param item_remove_request [ItemRemoveRequest]
|
4780
|
+
# @param [Hash] opts the optional parameters
|
4781
|
+
# @return [Array<(ItemRemoveResponse, Integer, Hash)>] ItemRemoveResponse data, response status code and response headers
|
4782
|
+
def item_remove_with_http_info(item_remove_request, opts = {})
|
4783
|
+
if @api_client.config.debugging
|
4784
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.item_remove ...'
|
4785
|
+
end
|
4786
|
+
# verify the required parameter 'item_remove_request' is set
|
4787
|
+
if @api_client.config.client_side_validation && item_remove_request.nil?
|
4788
|
+
fail ArgumentError, "Missing the required parameter 'item_remove_request' when calling PlaidApi.item_remove"
|
4789
|
+
end
|
4790
|
+
# resource path
|
4791
|
+
local_var_path = '/item/remove'
|
4792
|
+
|
4793
|
+
# query parameters
|
4794
|
+
query_params = opts[:query_params] || {}
|
4795
|
+
|
4796
|
+
# header parameters
|
4797
|
+
header_params = opts[:header_params] || {}
|
4798
|
+
# HTTP header 'Accept' (if needed)
|
4799
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
4800
|
+
# HTTP header 'Content-Type'
|
4801
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
4802
|
+
|
4803
|
+
# form parameters
|
4804
|
+
form_params = opts[:form_params] || {}
|
4805
|
+
|
4806
|
+
# http body (model)
|
4807
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(item_remove_request)
|
4808
|
+
|
4809
|
+
# return_type
|
4810
|
+
return_type = opts[:debug_return_type] || 'ItemRemoveResponse'
|
4811
|
+
|
4812
|
+
# auth_names
|
4813
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
4814
|
+
|
4815
|
+
new_options = opts.merge(
|
4816
|
+
:operation => :"PlaidApi.item_remove",
|
4817
|
+
:header_params => header_params,
|
4818
|
+
:query_params => query_params,
|
4819
|
+
:form_params => form_params,
|
4820
|
+
:body => post_body,
|
4821
|
+
:auth_names => auth_names,
|
4822
|
+
:return_type => return_type
|
4823
|
+
)
|
4824
|
+
|
4825
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
4826
|
+
if @api_client.config.debugging
|
4827
|
+
@api_client.config.logger.debug "API called: PlaidApi#item_remove\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
4828
|
+
end
|
4829
|
+
return data, status_code, headers
|
4830
|
+
end
|
4831
|
+
|
4832
|
+
# Update Webhook URL
|
4833
|
+
# The POST `/item/webhook/update` allows you to update the webhook URL associated with an Item. This request triggers a [`WEBHOOK_UPDATE_ACKNOWLEDGED`](https://plaid.com/docs/api/items/#webhook_update_acknowledged) webhook to the newly specified webhook URL.
|
4834
|
+
# @param item_webhook_update_request [ItemWebhookUpdateRequest]
|
4835
|
+
# @param [Hash] opts the optional parameters
|
4836
|
+
# @return [ItemWebhookUpdateResponse]
|
4837
|
+
def item_webhook_update(item_webhook_update_request, opts = {})
|
4838
|
+
data, _status_code, _headers = item_webhook_update_with_http_info(item_webhook_update_request, opts)
|
4839
|
+
data
|
4840
|
+
end
|
4841
|
+
|
4842
|
+
# Update Webhook URL
|
4843
|
+
# The POST `/item/webhook/update` allows you to update the webhook URL associated with an Item. This request triggers a [`WEBHOOK_UPDATE_ACKNOWLEDGED`](https://plaid.com/docs/api/items/#webhook_update_acknowledged) webhook to the newly specified webhook URL.
|
4844
|
+
# @param item_webhook_update_request [ItemWebhookUpdateRequest]
|
4845
|
+
# @param [Hash] opts the optional parameters
|
4846
|
+
# @return [Array<(ItemWebhookUpdateResponse, Integer, Hash)>] ItemWebhookUpdateResponse data, response status code and response headers
|
4847
|
+
def item_webhook_update_with_http_info(item_webhook_update_request, opts = {})
|
4848
|
+
if @api_client.config.debugging
|
4849
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.item_webhook_update ...'
|
4850
|
+
end
|
4851
|
+
# verify the required parameter 'item_webhook_update_request' is set
|
4852
|
+
if @api_client.config.client_side_validation && item_webhook_update_request.nil?
|
4853
|
+
fail ArgumentError, "Missing the required parameter 'item_webhook_update_request' when calling PlaidApi.item_webhook_update"
|
4854
|
+
end
|
4855
|
+
# resource path
|
4856
|
+
local_var_path = '/item/webhook/update'
|
4857
|
+
|
4858
|
+
# query parameters
|
4859
|
+
query_params = opts[:query_params] || {}
|
4860
|
+
|
4861
|
+
# header parameters
|
4862
|
+
header_params = opts[:header_params] || {}
|
4863
|
+
# HTTP header 'Accept' (if needed)
|
4864
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
4865
|
+
# HTTP header 'Content-Type'
|
4866
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
4867
|
+
|
4868
|
+
# form parameters
|
4869
|
+
form_params = opts[:form_params] || {}
|
4870
|
+
|
4871
|
+
# http body (model)
|
4872
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(item_webhook_update_request)
|
4873
|
+
|
4874
|
+
# return_type
|
4875
|
+
return_type = opts[:debug_return_type] || 'ItemWebhookUpdateResponse'
|
4876
|
+
|
4877
|
+
# auth_names
|
4878
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
4879
|
+
|
4880
|
+
new_options = opts.merge(
|
4881
|
+
:operation => :"PlaidApi.item_webhook_update",
|
4882
|
+
:header_params => header_params,
|
4883
|
+
:query_params => query_params,
|
4884
|
+
:form_params => form_params,
|
4885
|
+
:body => post_body,
|
4886
|
+
:auth_names => auth_names,
|
4887
|
+
:return_type => return_type
|
4888
|
+
)
|
4889
|
+
|
4890
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
4891
|
+
if @api_client.config.debugging
|
4892
|
+
@api_client.config.logger.debug "API called: PlaidApi#item_webhook_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
4893
|
+
end
|
4894
|
+
return data, status_code, headers
|
4895
|
+
end
|
4896
|
+
|
4897
|
+
# Retrieve Liabilities data
|
4898
|
+
# The `/liabilities/get` endpoint returns various details about an Item with loan or credit accounts. Liabilities data is available primarily for US financial institutions, with some limited coverage of Canadian institutions. Currently supported account types are account type `credit` with account subtype `credit card` or `paypal`, and account type `loan` with account subtype `student` or `mortgage`. To limit accounts listed in Link to types and subtypes supported by Liabilities, you can use the `account_filters` parameter when [creating a Link token](https://plaid.com/docs/api/tokens/#linktokencreate). The types of information returned by Liabilities can include balances and due dates, loan terms, and account details such as original loan amount and guarantor. Data is refreshed approximately once per day; the latest data can be retrieved by calling `/liabilities/get`. Note: This request may take some time to complete if `liabilities` was not specified as an initial product when creating the Item. This is because Plaid must communicate directly with the institution to retrieve the additional data.
|
4899
|
+
# @param liabilities_get_request [LiabilitiesGetRequest]
|
4900
|
+
# @param [Hash] opts the optional parameters
|
4901
|
+
# @return [LiabilitiesGetResponse]
|
4902
|
+
def liabilities_get(liabilities_get_request, opts = {})
|
4903
|
+
data, _status_code, _headers = liabilities_get_with_http_info(liabilities_get_request, opts)
|
4904
|
+
data
|
4905
|
+
end
|
4906
|
+
|
4907
|
+
# Retrieve Liabilities data
|
4908
|
+
# The `/liabilities/get` endpoint returns various details about an Item with loan or credit accounts. Liabilities data is available primarily for US financial institutions, with some limited coverage of Canadian institutions. Currently supported account types are account type `credit` with account subtype `credit card` or `paypal`, and account type `loan` with account subtype `student` or `mortgage`. To limit accounts listed in Link to types and subtypes supported by Liabilities, you can use the `account_filters` parameter when [creating a Link token](https://plaid.com/docs/api/tokens/#linktokencreate). The types of information returned by Liabilities can include balances and due dates, loan terms, and account details such as original loan amount and guarantor. Data is refreshed approximately once per day; the latest data can be retrieved by calling `/liabilities/get`. Note: This request may take some time to complete if `liabilities` was not specified as an initial product when creating the Item. This is because Plaid must communicate directly with the institution to retrieve the additional data.
|
4909
|
+
# @param liabilities_get_request [LiabilitiesGetRequest]
|
4650
4910
|
# @param [Hash] opts the optional parameters
|
4651
|
-
# @return [Array<(
|
4652
|
-
def
|
4911
|
+
# @return [Array<(LiabilitiesGetResponse, Integer, Hash)>] LiabilitiesGetResponse data, response status code and response headers
|
4912
|
+
def liabilities_get_with_http_info(liabilities_get_request, opts = {})
|
4653
4913
|
if @api_client.config.debugging
|
4654
|
-
@api_client.config.logger.debug 'Calling API: PlaidApi.
|
4914
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.liabilities_get ...'
|
4655
4915
|
end
|
4656
|
-
# verify the required parameter '
|
4657
|
-
if @api_client.config.client_side_validation &&
|
4658
|
-
fail ArgumentError, "Missing the required parameter '
|
4916
|
+
# verify the required parameter 'liabilities_get_request' is set
|
4917
|
+
if @api_client.config.client_side_validation && liabilities_get_request.nil?
|
4918
|
+
fail ArgumentError, "Missing the required parameter 'liabilities_get_request' when calling PlaidApi.liabilities_get"
|
4659
4919
|
end
|
4660
4920
|
# resource path
|
4661
|
-
local_var_path = '/
|
4921
|
+
local_var_path = '/liabilities/get'
|
4662
4922
|
|
4663
4923
|
# query parameters
|
4664
4924
|
query_params = opts[:query_params] || {}
|
@@ -4674,16 +4934,16 @@ module Plaid
|
|
4674
4934
|
form_params = opts[:form_params] || {}
|
4675
4935
|
|
4676
4936
|
# http body (model)
|
4677
|
-
post_body = opts[:debug_body] || @api_client.object_to_http_body(
|
4937
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(liabilities_get_request)
|
4678
4938
|
|
4679
4939
|
# return_type
|
4680
|
-
return_type = opts[:debug_return_type] || '
|
4940
|
+
return_type = opts[:debug_return_type] || 'LiabilitiesGetResponse'
|
4681
4941
|
|
4682
4942
|
# auth_names
|
4683
4943
|
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
4684
4944
|
|
4685
4945
|
new_options = opts.merge(
|
4686
|
-
:operation => :"PlaidApi.
|
4946
|
+
:operation => :"PlaidApi.liabilities_get",
|
4687
4947
|
:header_params => header_params,
|
4688
4948
|
:query_params => query_params,
|
4689
4949
|
:form_params => form_params,
|
@@ -4694,36 +4954,36 @@ module Plaid
|
|
4694
4954
|
|
4695
4955
|
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
4696
4956
|
if @api_client.config.debugging
|
4697
|
-
@api_client.config.logger.debug "API called: PlaidApi#
|
4957
|
+
@api_client.config.logger.debug "API called: PlaidApi#liabilities_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
4698
4958
|
end
|
4699
4959
|
return data, status_code, headers
|
4700
4960
|
end
|
4701
4961
|
|
4702
|
-
#
|
4703
|
-
#
|
4704
|
-
# @param
|
4962
|
+
# Create link delivery session
|
4963
|
+
# Use the `/link_delivery/create` endpoint to create a Link Delivery session.
|
4964
|
+
# @param link_delivery_create_request [LinkDeliveryCreateRequest]
|
4705
4965
|
# @param [Hash] opts the optional parameters
|
4706
|
-
# @return [
|
4707
|
-
def
|
4708
|
-
data, _status_code, _headers =
|
4966
|
+
# @return [LinkDeliveryCreateResponse]
|
4967
|
+
def link_delivery_create(link_delivery_create_request, opts = {})
|
4968
|
+
data, _status_code, _headers = link_delivery_create_with_http_info(link_delivery_create_request, opts)
|
4709
4969
|
data
|
4710
4970
|
end
|
4711
4971
|
|
4712
|
-
#
|
4713
|
-
#
|
4714
|
-
# @param
|
4972
|
+
# Create link delivery session
|
4973
|
+
# Use the `/link_delivery/create` endpoint to create a Link Delivery session.
|
4974
|
+
# @param link_delivery_create_request [LinkDeliveryCreateRequest]
|
4715
4975
|
# @param [Hash] opts the optional parameters
|
4716
|
-
# @return [Array<(
|
4717
|
-
def
|
4976
|
+
# @return [Array<(LinkDeliveryCreateResponse, Integer, Hash)>] LinkDeliveryCreateResponse data, response status code and response headers
|
4977
|
+
def link_delivery_create_with_http_info(link_delivery_create_request, opts = {})
|
4718
4978
|
if @api_client.config.debugging
|
4719
|
-
@api_client.config.logger.debug 'Calling API: PlaidApi.
|
4979
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.link_delivery_create ...'
|
4720
4980
|
end
|
4721
|
-
# verify the required parameter '
|
4722
|
-
if @api_client.config.client_side_validation &&
|
4723
|
-
fail ArgumentError, "Missing the required parameter '
|
4981
|
+
# verify the required parameter 'link_delivery_create_request' is set
|
4982
|
+
if @api_client.config.client_side_validation && link_delivery_create_request.nil?
|
4983
|
+
fail ArgumentError, "Missing the required parameter 'link_delivery_create_request' when calling PlaidApi.link_delivery_create"
|
4724
4984
|
end
|
4725
4985
|
# resource path
|
4726
|
-
local_var_path = '/
|
4986
|
+
local_var_path = '/link_delivery/create'
|
4727
4987
|
|
4728
4988
|
# query parameters
|
4729
4989
|
query_params = opts[:query_params] || {}
|
@@ -4739,16 +4999,16 @@ module Plaid
|
|
4739
4999
|
form_params = opts[:form_params] || {}
|
4740
5000
|
|
4741
5001
|
# http body (model)
|
4742
|
-
post_body = opts[:debug_body] || @api_client.object_to_http_body(
|
5002
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(link_delivery_create_request)
|
4743
5003
|
|
4744
5004
|
# return_type
|
4745
|
-
return_type = opts[:debug_return_type] || '
|
5005
|
+
return_type = opts[:debug_return_type] || 'LinkDeliveryCreateResponse'
|
4746
5006
|
|
4747
5007
|
# auth_names
|
4748
5008
|
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
4749
5009
|
|
4750
5010
|
new_options = opts.merge(
|
4751
|
-
:operation => :"PlaidApi.
|
5011
|
+
:operation => :"PlaidApi.link_delivery_create",
|
4752
5012
|
:header_params => header_params,
|
4753
5013
|
:query_params => query_params,
|
4754
5014
|
:form_params => form_params,
|
@@ -4759,36 +5019,36 @@ module Plaid
|
|
4759
5019
|
|
4760
5020
|
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
4761
5021
|
if @api_client.config.debugging
|
4762
|
-
@api_client.config.logger.debug "API called: PlaidApi#
|
5022
|
+
@api_client.config.logger.debug "API called: PlaidApi#link_delivery_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
4763
5023
|
end
|
4764
5024
|
return data, status_code, headers
|
4765
5025
|
end
|
4766
5026
|
|
4767
|
-
#
|
4768
|
-
#
|
4769
|
-
# @param
|
5027
|
+
# Get link delivery session
|
5028
|
+
# Use the `/link_delivery/get` endpoint to get the status of a Link Delivery session.
|
5029
|
+
# @param link_delivery_get_request [LinkDeliveryGetRequest]
|
4770
5030
|
# @param [Hash] opts the optional parameters
|
4771
|
-
# @return [
|
4772
|
-
def
|
4773
|
-
data, _status_code, _headers =
|
5031
|
+
# @return [LinkDeliveryGetResponse]
|
5032
|
+
def link_delivery_get(link_delivery_get_request, opts = {})
|
5033
|
+
data, _status_code, _headers = link_delivery_get_with_http_info(link_delivery_get_request, opts)
|
4774
5034
|
data
|
4775
5035
|
end
|
4776
5036
|
|
4777
|
-
#
|
4778
|
-
#
|
4779
|
-
# @param
|
5037
|
+
# Get link delivery session
|
5038
|
+
# Use the `/link_delivery/get` endpoint to get the status of a Link Delivery session.
|
5039
|
+
# @param link_delivery_get_request [LinkDeliveryGetRequest]
|
4780
5040
|
# @param [Hash] opts the optional parameters
|
4781
|
-
# @return [Array<(
|
4782
|
-
def
|
5041
|
+
# @return [Array<(LinkDeliveryGetResponse, Integer, Hash)>] LinkDeliveryGetResponse data, response status code and response headers
|
5042
|
+
def link_delivery_get_with_http_info(link_delivery_get_request, opts = {})
|
4783
5043
|
if @api_client.config.debugging
|
4784
|
-
@api_client.config.logger.debug 'Calling API: PlaidApi.
|
5044
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.link_delivery_get ...'
|
4785
5045
|
end
|
4786
|
-
# verify the required parameter '
|
4787
|
-
if @api_client.config.client_side_validation &&
|
4788
|
-
fail ArgumentError, "Missing the required parameter '
|
5046
|
+
# verify the required parameter 'link_delivery_get_request' is set
|
5047
|
+
if @api_client.config.client_side_validation && link_delivery_get_request.nil?
|
5048
|
+
fail ArgumentError, "Missing the required parameter 'link_delivery_get_request' when calling PlaidApi.link_delivery_get"
|
4789
5049
|
end
|
4790
5050
|
# resource path
|
4791
|
-
local_var_path = '/
|
5051
|
+
local_var_path = '/link_delivery/get'
|
4792
5052
|
|
4793
5053
|
# query parameters
|
4794
5054
|
query_params = opts[:query_params] || {}
|
@@ -4804,16 +5064,16 @@ module Plaid
|
|
4804
5064
|
form_params = opts[:form_params] || {}
|
4805
5065
|
|
4806
5066
|
# http body (model)
|
4807
|
-
post_body = opts[:debug_body] || @api_client.object_to_http_body(
|
5067
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(link_delivery_get_request)
|
4808
5068
|
|
4809
5069
|
# return_type
|
4810
|
-
return_type = opts[:debug_return_type] || '
|
5070
|
+
return_type = opts[:debug_return_type] || 'LinkDeliveryGetResponse'
|
4811
5071
|
|
4812
5072
|
# auth_names
|
4813
5073
|
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
4814
5074
|
|
4815
5075
|
new_options = opts.merge(
|
4816
|
-
:operation => :"PlaidApi.
|
5076
|
+
:operation => :"PlaidApi.link_delivery_get",
|
4817
5077
|
:header_params => header_params,
|
4818
5078
|
:query_params => query_params,
|
4819
5079
|
:form_params => form_params,
|
@@ -4824,36 +5084,36 @@ module Plaid
|
|
4824
5084
|
|
4825
5085
|
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
4826
5086
|
if @api_client.config.debugging
|
4827
|
-
@api_client.config.logger.debug "API called: PlaidApi#
|
5087
|
+
@api_client.config.logger.debug "API called: PlaidApi#link_delivery_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
4828
5088
|
end
|
4829
5089
|
return data, status_code, headers
|
4830
5090
|
end
|
4831
5091
|
|
4832
|
-
#
|
4833
|
-
#
|
4834
|
-
# @param
|
5092
|
+
# Exchange the Link Correlation Id for a Link Token
|
5093
|
+
# Exchange an OAuth `link_correlation_id` for the corresponding `link_token`. The `link_correlation_id` is only available for 'payment_initiation' products and is provided to the client via the OAuth `redirect_uri` as a query parameter. The `link_correlation_id` is ephemeral and expires in a brief period, after which it can no longer be exchanged for the 'link_token'.
|
5094
|
+
# @param link_o_auth_correlation_id_exchange_request [LinkOAuthCorrelationIdExchangeRequest]
|
4835
5095
|
# @param [Hash] opts the optional parameters
|
4836
|
-
# @return [
|
4837
|
-
def
|
4838
|
-
data, _status_code, _headers =
|
5096
|
+
# @return [LinkOAuthCorrelationIdExchangeResponse]
|
5097
|
+
def link_oauth_correlation_id_exchange(link_o_auth_correlation_id_exchange_request, opts = {})
|
5098
|
+
data, _status_code, _headers = link_oauth_correlation_id_exchange_with_http_info(link_o_auth_correlation_id_exchange_request, opts)
|
4839
5099
|
data
|
4840
5100
|
end
|
4841
5101
|
|
4842
|
-
#
|
4843
|
-
#
|
4844
|
-
# @param
|
5102
|
+
# Exchange the Link Correlation Id for a Link Token
|
5103
|
+
# Exchange an OAuth `link_correlation_id` for the corresponding `link_token`. The `link_correlation_id` is only available for 'payment_initiation' products and is provided to the client via the OAuth `redirect_uri` as a query parameter. The `link_correlation_id` is ephemeral and expires in a brief period, after which it can no longer be exchanged for the 'link_token'.
|
5104
|
+
# @param link_o_auth_correlation_id_exchange_request [LinkOAuthCorrelationIdExchangeRequest]
|
4845
5105
|
# @param [Hash] opts the optional parameters
|
4846
|
-
# @return [Array<(
|
4847
|
-
def
|
5106
|
+
# @return [Array<(LinkOAuthCorrelationIdExchangeResponse, Integer, Hash)>] LinkOAuthCorrelationIdExchangeResponse data, response status code and response headers
|
5107
|
+
def link_oauth_correlation_id_exchange_with_http_info(link_o_auth_correlation_id_exchange_request, opts = {})
|
4848
5108
|
if @api_client.config.debugging
|
4849
|
-
@api_client.config.logger.debug 'Calling API: PlaidApi.
|
5109
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.link_oauth_correlation_id_exchange ...'
|
4850
5110
|
end
|
4851
|
-
# verify the required parameter '
|
4852
|
-
if @api_client.config.client_side_validation &&
|
4853
|
-
fail ArgumentError, "Missing the required parameter '
|
5111
|
+
# verify the required parameter 'link_o_auth_correlation_id_exchange_request' is set
|
5112
|
+
if @api_client.config.client_side_validation && link_o_auth_correlation_id_exchange_request.nil?
|
5113
|
+
fail ArgumentError, "Missing the required parameter 'link_o_auth_correlation_id_exchange_request' when calling PlaidApi.link_oauth_correlation_id_exchange"
|
4854
5114
|
end
|
4855
5115
|
# resource path
|
4856
|
-
local_var_path = '/
|
5116
|
+
local_var_path = '/link/oauth/correlation_id/exchange'
|
4857
5117
|
|
4858
5118
|
# query parameters
|
4859
5119
|
query_params = opts[:query_params] || {}
|
@@ -4869,16 +5129,16 @@ module Plaid
|
|
4869
5129
|
form_params = opts[:form_params] || {}
|
4870
5130
|
|
4871
5131
|
# http body (model)
|
4872
|
-
post_body = opts[:debug_body] || @api_client.object_to_http_body(
|
5132
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(link_o_auth_correlation_id_exchange_request)
|
4873
5133
|
|
4874
5134
|
# return_type
|
4875
|
-
return_type = opts[:debug_return_type] || '
|
5135
|
+
return_type = opts[:debug_return_type] || 'LinkOAuthCorrelationIdExchangeResponse'
|
4876
5136
|
|
4877
5137
|
# auth_names
|
4878
5138
|
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
4879
5139
|
|
4880
5140
|
new_options = opts.merge(
|
4881
|
-
:operation => :"PlaidApi.
|
5141
|
+
:operation => :"PlaidApi.link_oauth_correlation_id_exchange",
|
4882
5142
|
:header_params => header_params,
|
4883
5143
|
:query_params => query_params,
|
4884
5144
|
:form_params => form_params,
|
@@ -4889,36 +5149,36 @@ module Plaid
|
|
4889
5149
|
|
4890
5150
|
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
4891
5151
|
if @api_client.config.debugging
|
4892
|
-
@api_client.config.logger.debug "API called: PlaidApi#
|
5152
|
+
@api_client.config.logger.debug "API called: PlaidApi#link_oauth_correlation_id_exchange\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
4893
5153
|
end
|
4894
5154
|
return data, status_code, headers
|
4895
5155
|
end
|
4896
5156
|
|
4897
|
-
#
|
4898
|
-
# The
|
4899
|
-
# @param
|
5157
|
+
# Create Link Token
|
5158
|
+
# The `/link/token/create` endpoint creates a `link_token`, which is required as a parameter when initializing Link. Once Link has been initialized, it returns a `public_token`, which can then be exchanged for an `access_token` via `/item/public_token/exchange` as part of the main Link flow. A `link_token` generated by `/link/token/create` is also used to initialize other Link flows, such as the update mode flow for tokens with expired credentials, or the Payment Initiation (Europe) flow.
|
5159
|
+
# @param link_token_create_request [LinkTokenCreateRequest]
|
4900
5160
|
# @param [Hash] opts the optional parameters
|
4901
|
-
# @return [
|
4902
|
-
def
|
4903
|
-
data, _status_code, _headers =
|
5161
|
+
# @return [LinkTokenCreateResponse]
|
5162
|
+
def link_token_create(link_token_create_request, opts = {})
|
5163
|
+
data, _status_code, _headers = link_token_create_with_http_info(link_token_create_request, opts)
|
4904
5164
|
data
|
4905
5165
|
end
|
4906
5166
|
|
4907
|
-
#
|
4908
|
-
# The
|
4909
|
-
# @param
|
5167
|
+
# Create Link Token
|
5168
|
+
# The `/link/token/create` endpoint creates a `link_token`, which is required as a parameter when initializing Link. Once Link has been initialized, it returns a `public_token`, which can then be exchanged for an `access_token` via `/item/public_token/exchange` as part of the main Link flow. A `link_token` generated by `/link/token/create` is also used to initialize other Link flows, such as the update mode flow for tokens with expired credentials, or the Payment Initiation (Europe) flow.
|
5169
|
+
# @param link_token_create_request [LinkTokenCreateRequest]
|
4910
5170
|
# @param [Hash] opts the optional parameters
|
4911
|
-
# @return [Array<(
|
4912
|
-
def
|
5171
|
+
# @return [Array<(LinkTokenCreateResponse, Integer, Hash)>] LinkTokenCreateResponse data, response status code and response headers
|
5172
|
+
def link_token_create_with_http_info(link_token_create_request, opts = {})
|
4913
5173
|
if @api_client.config.debugging
|
4914
|
-
@api_client.config.logger.debug 'Calling API: PlaidApi.
|
5174
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.link_token_create ...'
|
4915
5175
|
end
|
4916
|
-
# verify the required parameter '
|
4917
|
-
if @api_client.config.client_side_validation &&
|
4918
|
-
fail ArgumentError, "Missing the required parameter '
|
5176
|
+
# verify the required parameter 'link_token_create_request' is set
|
5177
|
+
if @api_client.config.client_side_validation && link_token_create_request.nil?
|
5178
|
+
fail ArgumentError, "Missing the required parameter 'link_token_create_request' when calling PlaidApi.link_token_create"
|
4919
5179
|
end
|
4920
5180
|
# resource path
|
4921
|
-
local_var_path = '/
|
5181
|
+
local_var_path = '/link/token/create'
|
4922
5182
|
|
4923
5183
|
# query parameters
|
4924
5184
|
query_params = opts[:query_params] || {}
|
@@ -4934,16 +5194,16 @@ module Plaid
|
|
4934
5194
|
form_params = opts[:form_params] || {}
|
4935
5195
|
|
4936
5196
|
# http body (model)
|
4937
|
-
post_body = opts[:debug_body] || @api_client.object_to_http_body(
|
5197
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(link_token_create_request)
|
4938
5198
|
|
4939
5199
|
# return_type
|
4940
|
-
return_type = opts[:debug_return_type] || '
|
5200
|
+
return_type = opts[:debug_return_type] || 'LinkTokenCreateResponse'
|
4941
5201
|
|
4942
5202
|
# auth_names
|
4943
5203
|
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
4944
5204
|
|
4945
5205
|
new_options = opts.merge(
|
4946
|
-
:operation => :"PlaidApi.
|
5206
|
+
:operation => :"PlaidApi.link_token_create",
|
4947
5207
|
:header_params => header_params,
|
4948
5208
|
:query_params => query_params,
|
4949
5209
|
:form_params => form_params,
|
@@ -4954,36 +5214,36 @@ module Plaid
|
|
4954
5214
|
|
4955
5215
|
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
4956
5216
|
if @api_client.config.debugging
|
4957
|
-
@api_client.config.logger.debug "API called: PlaidApi#
|
5217
|
+
@api_client.config.logger.debug "API called: PlaidApi#link_token_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
4958
5218
|
end
|
4959
5219
|
return data, status_code, headers
|
4960
5220
|
end
|
4961
5221
|
|
4962
|
-
#
|
4963
|
-
# The `/
|
4964
|
-
# @param
|
5222
|
+
# Get Link Token
|
5223
|
+
# The `/link/token/get` endpoint gets information about a previously-created `link_token` using the `/link/token/create` endpoint. It can be useful for debugging purposes.
|
5224
|
+
# @param link_token_get_request [LinkTokenGetRequest]
|
4965
5225
|
# @param [Hash] opts the optional parameters
|
4966
|
-
# @return [
|
4967
|
-
def
|
4968
|
-
data, _status_code, _headers =
|
5226
|
+
# @return [LinkTokenGetResponse]
|
5227
|
+
def link_token_get(link_token_get_request, opts = {})
|
5228
|
+
data, _status_code, _headers = link_token_get_with_http_info(link_token_get_request, opts)
|
4969
5229
|
data
|
4970
5230
|
end
|
4971
5231
|
|
4972
|
-
#
|
4973
|
-
# The `/
|
4974
|
-
# @param
|
5232
|
+
# Get Link Token
|
5233
|
+
# The `/link/token/get` endpoint gets information about a previously-created `link_token` using the `/link/token/create` endpoint. It can be useful for debugging purposes.
|
5234
|
+
# @param link_token_get_request [LinkTokenGetRequest]
|
4975
5235
|
# @param [Hash] opts the optional parameters
|
4976
|
-
# @return [Array<(
|
4977
|
-
def
|
5236
|
+
# @return [Array<(LinkTokenGetResponse, Integer, Hash)>] LinkTokenGetResponse data, response status code and response headers
|
5237
|
+
def link_token_get_with_http_info(link_token_get_request, opts = {})
|
4978
5238
|
if @api_client.config.debugging
|
4979
|
-
@api_client.config.logger.debug 'Calling API: PlaidApi.
|
5239
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.link_token_get ...'
|
4980
5240
|
end
|
4981
|
-
# verify the required parameter '
|
4982
|
-
if @api_client.config.client_side_validation &&
|
4983
|
-
fail ArgumentError, "Missing the required parameter '
|
5241
|
+
# verify the required parameter 'link_token_get_request' is set
|
5242
|
+
if @api_client.config.client_side_validation && link_token_get_request.nil?
|
5243
|
+
fail ArgumentError, "Missing the required parameter 'link_token_get_request' when calling PlaidApi.link_token_get"
|
4984
5244
|
end
|
4985
5245
|
# resource path
|
4986
|
-
local_var_path = '/
|
5246
|
+
local_var_path = '/link/token/get'
|
4987
5247
|
|
4988
5248
|
# query parameters
|
4989
5249
|
query_params = opts[:query_params] || {}
|
@@ -4999,16 +5259,16 @@ module Plaid
|
|
4999
5259
|
form_params = opts[:form_params] || {}
|
5000
5260
|
|
5001
5261
|
# http body (model)
|
5002
|
-
post_body = opts[:debug_body] || @api_client.object_to_http_body(
|
5262
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(link_token_get_request)
|
5003
5263
|
|
5004
5264
|
# return_type
|
5005
|
-
return_type = opts[:debug_return_type] || '
|
5265
|
+
return_type = opts[:debug_return_type] || 'LinkTokenGetResponse'
|
5006
5266
|
|
5007
5267
|
# auth_names
|
5008
5268
|
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
5009
5269
|
|
5010
5270
|
new_options = opts.merge(
|
5011
|
-
:operation => :"PlaidApi.
|
5271
|
+
:operation => :"PlaidApi.link_token_get",
|
5012
5272
|
:header_params => header_params,
|
5013
5273
|
:query_params => query_params,
|
5014
5274
|
:form_params => form_params,
|
@@ -5019,36 +5279,36 @@ module Plaid
|
|
5019
5279
|
|
5020
5280
|
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
5021
5281
|
if @api_client.config.debugging
|
5022
|
-
@api_client.config.logger.debug "API called: PlaidApi#
|
5282
|
+
@api_client.config.logger.debug "API called: PlaidApi#link_token_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
5023
5283
|
end
|
5024
5284
|
return data, status_code, headers
|
5025
5285
|
end
|
5026
5286
|
|
5027
|
-
#
|
5028
|
-
# The `/
|
5029
|
-
# @param
|
5287
|
+
# Creates a new end customer for a Plaid reseller.
|
5288
|
+
# The `/partner/customer/create` endpoint is used by reseller partners to create end customers.
|
5289
|
+
# @param partner_customer_create_request [PartnerCustomerCreateRequest]
|
5030
5290
|
# @param [Hash] opts the optional parameters
|
5031
|
-
# @return [
|
5032
|
-
def
|
5033
|
-
data, _status_code, _headers =
|
5291
|
+
# @return [PartnerCustomerCreateResponse]
|
5292
|
+
def partner_customer_create(partner_customer_create_request, opts = {})
|
5293
|
+
data, _status_code, _headers = partner_customer_create_with_http_info(partner_customer_create_request, opts)
|
5034
5294
|
data
|
5035
5295
|
end
|
5036
5296
|
|
5037
|
-
#
|
5038
|
-
# The `/
|
5039
|
-
# @param
|
5297
|
+
# Creates a new end customer for a Plaid reseller.
|
5298
|
+
# The `/partner/customer/create` endpoint is used by reseller partners to create end customers.
|
5299
|
+
# @param partner_customer_create_request [PartnerCustomerCreateRequest]
|
5040
5300
|
# @param [Hash] opts the optional parameters
|
5041
|
-
# @return [Array<(
|
5042
|
-
def
|
5301
|
+
# @return [Array<(PartnerCustomerCreateResponse, Integer, Hash)>] PartnerCustomerCreateResponse data, response status code and response headers
|
5302
|
+
def partner_customer_create_with_http_info(partner_customer_create_request, opts = {})
|
5043
5303
|
if @api_client.config.debugging
|
5044
|
-
@api_client.config.logger.debug 'Calling API: PlaidApi.
|
5304
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.partner_customer_create ...'
|
5045
5305
|
end
|
5046
|
-
# verify the required parameter '
|
5047
|
-
if @api_client.config.client_side_validation &&
|
5048
|
-
fail ArgumentError, "Missing the required parameter '
|
5306
|
+
# verify the required parameter 'partner_customer_create_request' is set
|
5307
|
+
if @api_client.config.client_side_validation && partner_customer_create_request.nil?
|
5308
|
+
fail ArgumentError, "Missing the required parameter 'partner_customer_create_request' when calling PlaidApi.partner_customer_create"
|
5049
5309
|
end
|
5050
5310
|
# resource path
|
5051
|
-
local_var_path = '/
|
5311
|
+
local_var_path = '/partner/customer/create'
|
5052
5312
|
|
5053
5313
|
# query parameters
|
5054
5314
|
query_params = opts[:query_params] || {}
|
@@ -5064,16 +5324,16 @@ module Plaid
|
|
5064
5324
|
form_params = opts[:form_params] || {}
|
5065
5325
|
|
5066
5326
|
# http body (model)
|
5067
|
-
post_body = opts[:debug_body] || @api_client.object_to_http_body(
|
5327
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(partner_customer_create_request)
|
5068
5328
|
|
5069
5329
|
# return_type
|
5070
|
-
return_type = opts[:debug_return_type] || '
|
5330
|
+
return_type = opts[:debug_return_type] || 'PartnerCustomerCreateResponse'
|
5071
5331
|
|
5072
5332
|
# auth_names
|
5073
5333
|
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
5074
5334
|
|
5075
5335
|
new_options = opts.merge(
|
5076
|
-
:operation => :"PlaidApi.
|
5336
|
+
:operation => :"PlaidApi.partner_customer_create",
|
5077
5337
|
:header_params => header_params,
|
5078
5338
|
:query_params => query_params,
|
5079
5339
|
:form_params => form_params,
|
@@ -5084,36 +5344,36 @@ module Plaid
|
|
5084
5344
|
|
5085
5345
|
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
5086
5346
|
if @api_client.config.debugging
|
5087
|
-
@api_client.config.logger.debug "API called: PlaidApi#
|
5347
|
+
@api_client.config.logger.debug "API called: PlaidApi#partner_customer_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
5088
5348
|
end
|
5089
5349
|
return data, status_code, headers
|
5090
5350
|
end
|
5091
5351
|
|
5092
|
-
#
|
5093
|
-
# The `/
|
5094
|
-
# @param
|
5352
|
+
# Enables a Plaid reseller's end customer in the Production environment.
|
5353
|
+
# The `/partner/customer/enable` endpoint is used by reseller partners to enable an end customer in the Production environment.
|
5354
|
+
# @param partner_customer_enable_request [PartnerCustomerEnableRequest]
|
5095
5355
|
# @param [Hash] opts the optional parameters
|
5096
|
-
# @return [
|
5097
|
-
def
|
5098
|
-
data, _status_code, _headers =
|
5356
|
+
# @return [PartnerCustomerEnableResponse]
|
5357
|
+
def partner_customer_enable(partner_customer_enable_request, opts = {})
|
5358
|
+
data, _status_code, _headers = partner_customer_enable_with_http_info(partner_customer_enable_request, opts)
|
5099
5359
|
data
|
5100
5360
|
end
|
5101
5361
|
|
5102
|
-
#
|
5103
|
-
# The `/
|
5104
|
-
# @param
|
5362
|
+
# Enables a Plaid reseller's end customer in the Production environment.
|
5363
|
+
# The `/partner/customer/enable` endpoint is used by reseller partners to enable an end customer in the Production environment.
|
5364
|
+
# @param partner_customer_enable_request [PartnerCustomerEnableRequest]
|
5105
5365
|
# @param [Hash] opts the optional parameters
|
5106
|
-
# @return [Array<(
|
5107
|
-
def
|
5366
|
+
# @return [Array<(PartnerCustomerEnableResponse, Integer, Hash)>] PartnerCustomerEnableResponse data, response status code and response headers
|
5367
|
+
def partner_customer_enable_with_http_info(partner_customer_enable_request, opts = {})
|
5108
5368
|
if @api_client.config.debugging
|
5109
|
-
@api_client.config.logger.debug 'Calling API: PlaidApi.
|
5369
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.partner_customer_enable ...'
|
5110
5370
|
end
|
5111
|
-
# verify the required parameter '
|
5112
|
-
if @api_client.config.client_side_validation &&
|
5113
|
-
fail ArgumentError, "Missing the required parameter '
|
5371
|
+
# verify the required parameter 'partner_customer_enable_request' is set
|
5372
|
+
if @api_client.config.client_side_validation && partner_customer_enable_request.nil?
|
5373
|
+
fail ArgumentError, "Missing the required parameter 'partner_customer_enable_request' when calling PlaidApi.partner_customer_enable"
|
5114
5374
|
end
|
5115
5375
|
# resource path
|
5116
|
-
local_var_path = '/
|
5376
|
+
local_var_path = '/partner/customer/enable'
|
5117
5377
|
|
5118
5378
|
# query parameters
|
5119
5379
|
query_params = opts[:query_params] || {}
|
@@ -5129,16 +5389,16 @@ module Plaid
|
|
5129
5389
|
form_params = opts[:form_params] || {}
|
5130
5390
|
|
5131
5391
|
# http body (model)
|
5132
|
-
post_body = opts[:debug_body] || @api_client.object_to_http_body(
|
5392
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(partner_customer_enable_request)
|
5133
5393
|
|
5134
5394
|
# return_type
|
5135
|
-
return_type = opts[:debug_return_type] || '
|
5395
|
+
return_type = opts[:debug_return_type] || 'PartnerCustomerEnableResponse'
|
5136
5396
|
|
5137
5397
|
# auth_names
|
5138
5398
|
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
5139
5399
|
|
5140
5400
|
new_options = opts.merge(
|
5141
|
-
:operation => :"PlaidApi.
|
5401
|
+
:operation => :"PlaidApi.partner_customer_enable",
|
5142
5402
|
:header_params => header_params,
|
5143
5403
|
:query_params => query_params,
|
5144
5404
|
:form_params => form_params,
|
@@ -5149,36 +5409,36 @@ module Plaid
|
|
5149
5409
|
|
5150
5410
|
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
5151
5411
|
if @api_client.config.debugging
|
5152
|
-
@api_client.config.logger.debug "API called: PlaidApi#
|
5412
|
+
@api_client.config.logger.debug "API called: PlaidApi#partner_customer_enable\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
5153
5413
|
end
|
5154
5414
|
return data, status_code, headers
|
5155
5415
|
end
|
5156
5416
|
|
5157
|
-
#
|
5158
|
-
# The `/partner/
|
5159
|
-
# @param
|
5417
|
+
# Returns a Plaid reseller's end customer.
|
5418
|
+
# The `/partner/customer/get` endpoint is used by reseller partners to retrieve data about a single end customer.
|
5419
|
+
# @param partner_customer_get_request [PartnerCustomerGetRequest]
|
5160
5420
|
# @param [Hash] opts the optional parameters
|
5161
|
-
# @return [
|
5162
|
-
def
|
5163
|
-
data, _status_code, _headers =
|
5421
|
+
# @return [PartnerCustomerGetResponse]
|
5422
|
+
def partner_customer_get(partner_customer_get_request, opts = {})
|
5423
|
+
data, _status_code, _headers = partner_customer_get_with_http_info(partner_customer_get_request, opts)
|
5164
5424
|
data
|
5165
5425
|
end
|
5166
5426
|
|
5167
|
-
#
|
5168
|
-
# The `/partner/
|
5169
|
-
# @param
|
5427
|
+
# Returns a Plaid reseller's end customer.
|
5428
|
+
# The `/partner/customer/get` endpoint is used by reseller partners to retrieve data about a single end customer.
|
5429
|
+
# @param partner_customer_get_request [PartnerCustomerGetRequest]
|
5170
5430
|
# @param [Hash] opts the optional parameters
|
5171
|
-
# @return [Array<(
|
5172
|
-
def
|
5431
|
+
# @return [Array<(PartnerCustomerGetResponse, Integer, Hash)>] PartnerCustomerGetResponse data, response status code and response headers
|
5432
|
+
def partner_customer_get_with_http_info(partner_customer_get_request, opts = {})
|
5173
5433
|
if @api_client.config.debugging
|
5174
|
-
@api_client.config.logger.debug 'Calling API: PlaidApi.
|
5434
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.partner_customer_get ...'
|
5175
5435
|
end
|
5176
|
-
# verify the required parameter '
|
5177
|
-
if @api_client.config.client_side_validation &&
|
5178
|
-
fail ArgumentError, "Missing the required parameter '
|
5436
|
+
# verify the required parameter 'partner_customer_get_request' is set
|
5437
|
+
if @api_client.config.client_side_validation && partner_customer_get_request.nil?
|
5438
|
+
fail ArgumentError, "Missing the required parameter 'partner_customer_get_request' when calling PlaidApi.partner_customer_get"
|
5179
5439
|
end
|
5180
5440
|
# resource path
|
5181
|
-
local_var_path = '/
|
5441
|
+
local_var_path = '/partner/customer/get'
|
5182
5442
|
|
5183
5443
|
# query parameters
|
5184
5444
|
query_params = opts[:query_params] || {}
|
@@ -5194,16 +5454,16 @@ module Plaid
|
|
5194
5454
|
form_params = opts[:form_params] || {}
|
5195
5455
|
|
5196
5456
|
# http body (model)
|
5197
|
-
post_body = opts[:debug_body] || @api_client.object_to_http_body(
|
5457
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(partner_customer_get_request)
|
5198
5458
|
|
5199
5459
|
# return_type
|
5200
|
-
return_type = opts[:debug_return_type] || '
|
5460
|
+
return_type = opts[:debug_return_type] || 'PartnerCustomerGetResponse'
|
5201
5461
|
|
5202
5462
|
# auth_names
|
5203
5463
|
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
5204
5464
|
|
5205
5465
|
new_options = opts.merge(
|
5206
|
-
:operation => :"PlaidApi.
|
5466
|
+
:operation => :"PlaidApi.partner_customer_get",
|
5207
5467
|
:header_params => header_params,
|
5208
5468
|
:query_params => query_params,
|
5209
5469
|
:form_params => form_params,
|
@@ -5214,7 +5474,7 @@ module Plaid
|
|
5214
5474
|
|
5215
5475
|
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
5216
5476
|
if @api_client.config.debugging
|
5217
|
-
@api_client.config.logger.debug "API called: PlaidApi#
|
5477
|
+
@api_client.config.logger.debug "API called: PlaidApi#partner_customer_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
5218
5478
|
end
|
5219
5479
|
return data, status_code, headers
|
5220
5480
|
end
|
@@ -5675,7 +5935,7 @@ module Plaid
|
|
5675
5935
|
end
|
5676
5936
|
|
5677
5937
|
# Reverse an existing payment
|
5678
|
-
# Reverse a previously
|
5938
|
+
# Reverse a previously settled payment from a Plaid virtual account. The original payment must be in a settled state to be refunded and only full payment refunds are currently supported. To power partial refunds, use `/wallet/transaction/execute`, where you can specify the exact amount for a payout to an end user. A payment can only be reversed once and will be refunded back to the same source account that initiated the payment. The original payment must have been initiated to a Plaid virtual account. The refund will be initiated from the same virtual account that the payment was paid into.
|
5679
5939
|
# @param payment_initiation_payment_reverse_request [PaymentInitiationPaymentReverseRequest]
|
5680
5940
|
# @param [Hash] opts the optional parameters
|
5681
5941
|
# @return [PaymentInitiationPaymentReverseResponse]
|
@@ -5685,7 +5945,7 @@ module Plaid
|
|
5685
5945
|
end
|
5686
5946
|
|
5687
5947
|
# Reverse an existing payment
|
5688
|
-
# Reverse a previously
|
5948
|
+
# Reverse a previously settled payment from a Plaid virtual account. The original payment must be in a settled state to be refunded and only full payment refunds are currently supported. To power partial refunds, use `/wallet/transaction/execute`, where you can specify the exact amount for a payout to an end user. A payment can only be reversed once and will be refunded back to the same source account that initiated the payment. The original payment must have been initiated to a Plaid virtual account. The refund will be initiated from the same virtual account that the payment was paid into.
|
5689
5949
|
# @param payment_initiation_payment_reverse_request [PaymentInitiationPaymentReverseRequest]
|
5690
5950
|
# @param [Hash] opts the optional parameters
|
5691
5951
|
# @return [Array<(PaymentInitiationPaymentReverseResponse, Integer, Hash)>] PaymentInitiationPaymentReverseResponse data, response status code and response headers
|
@@ -5740,7 +6000,7 @@ module Plaid
|
|
5740
6000
|
end
|
5741
6001
|
|
5742
6002
|
# Create payment recipient
|
5743
|
-
# Create a payment recipient for payment initiation. The recipient must be in Europe, within a country that is a member of the Single Euro Payment Area (SEPA). For a standing order (recurring) payment, the recipient must be in the UK. The endpoint is idempotent: if a developer has already made a request with the same payment details, Plaid will return the same `recipient_id`.
|
6003
|
+
# Create a payment recipient for payment initiation. The recipient must be in Europe, within a country that is a member of the Single Euro Payment Area (SEPA). For a standing order (recurring) payment, the recipient must be in the UK. It is recommended to use `bacs` in the UK and `iban` in EU. The endpoint is idempotent: if a developer has already made a request with the same payment details, Plaid will return the same `recipient_id`.
|
5744
6004
|
# @param payment_initiation_recipient_create_request [PaymentInitiationRecipientCreateRequest]
|
5745
6005
|
# @param [Hash] opts the optional parameters
|
5746
6006
|
# @return [PaymentInitiationRecipientCreateResponse]
|
@@ -5750,7 +6010,7 @@ module Plaid
|
|
5750
6010
|
end
|
5751
6011
|
|
5752
6012
|
# Create payment recipient
|
5753
|
-
# Create a payment recipient for payment initiation. The recipient must be in Europe, within a country that is a member of the Single Euro Payment Area (SEPA). For a standing order (recurring) payment, the recipient must be in the UK. The endpoint is idempotent: if a developer has already made a request with the same payment details, Plaid will return the same `recipient_id`.
|
6013
|
+
# Create a payment recipient for payment initiation. The recipient must be in Europe, within a country that is a member of the Single Euro Payment Area (SEPA). For a standing order (recurring) payment, the recipient must be in the UK. It is recommended to use `bacs` in the UK and `iban` in EU. The endpoint is idempotent: if a developer has already made a request with the same payment details, Plaid will return the same `recipient_id`.
|
5754
6014
|
# @param payment_initiation_recipient_create_request [PaymentInitiationRecipientCreateRequest]
|
5755
6015
|
# @param [Hash] opts the optional parameters
|
5756
6016
|
# @return [Array<(PaymentInitiationRecipientCreateResponse, Integer, Hash)>] PaymentInitiationRecipientCreateResponse data, response status code and response headers
|
@@ -5935,7 +6195,7 @@ module Plaid
|
|
5935
6195
|
end
|
5936
6196
|
|
5937
6197
|
# Create payment profile
|
5938
|
-
# Use `/payment_profile/create` endpoint to create a new payment profile
|
6198
|
+
# Use `/payment_profile/create` endpoint to create a new payment profile. To initiate the account linking experience, call `/link/token/create` and provide the `payment_profile_token` in the `transfer.payment_profile_token` field. You can then use the `payment_profile_token` when creating transfers using `/transfer/authorization/create` and `/transfer/create`.
|
5939
6199
|
# @param payment_profile_create_request [PaymentProfileCreateRequest]
|
5940
6200
|
# @param [Hash] opts the optional parameters
|
5941
6201
|
# @return [PaymentProfileCreateResponse]
|
@@ -5945,7 +6205,7 @@ module Plaid
|
|
5945
6205
|
end
|
5946
6206
|
|
5947
6207
|
# Create payment profile
|
5948
|
-
# Use `/payment_profile/create` endpoint to create a new payment profile
|
6208
|
+
# Use `/payment_profile/create` endpoint to create a new payment profile. To initiate the account linking experience, call `/link/token/create` and provide the `payment_profile_token` in the `transfer.payment_profile_token` field. You can then use the `payment_profile_token` when creating transfers using `/transfer/authorization/create` and `/transfer/create`.
|
5949
6209
|
# @param payment_profile_create_request [PaymentProfileCreateRequest]
|
5950
6210
|
# @param [Hash] opts the optional parameters
|
5951
6211
|
# @return [Array<(PaymentProfileCreateResponse, Integer, Hash)>] PaymentProfileCreateResponse data, response status code and response headers
|
@@ -6000,7 +6260,7 @@ module Plaid
|
|
6000
6260
|
end
|
6001
6261
|
|
6002
6262
|
# Get payment profile
|
6003
|
-
# Use
|
6263
|
+
# Use `/payment_profile/get` endpoint to get the status of a given Payment Profile.
|
6004
6264
|
# @param payment_profile_get_request [PaymentProfileGetRequest]
|
6005
6265
|
# @param [Hash] opts the optional parameters
|
6006
6266
|
# @return [PaymentProfileGetResponse]
|
@@ -6010,7 +6270,7 @@ module Plaid
|
|
6010
6270
|
end
|
6011
6271
|
|
6012
6272
|
# Get payment profile
|
6013
|
-
# Use
|
6273
|
+
# Use `/payment_profile/get` endpoint to get the status of a given Payment Profile.
|
6014
6274
|
# @param payment_profile_get_request [PaymentProfileGetRequest]
|
6015
6275
|
# @param [Hash] opts the optional parameters
|
6016
6276
|
# @return [Array<(PaymentProfileGetResponse, Integer, Hash)>] PaymentProfileGetResponse data, response status code and response headers
|
@@ -6455,7 +6715,7 @@ module Plaid
|
|
6455
6715
|
end
|
6456
6716
|
|
6457
6717
|
# Create Stripe bank account token
|
6458
|
-
#
|
6718
|
+
# Used to create a token suitable for sending to Stripe to enable Plaid-Stripe integrations. For a detailed guide on integrating Stripe, see [Add Stripe to your app](https://plaid.com/docs/auth/partnerships/stripe/). Note that the Stripe bank account token is a one-time use token. To store bank account information for later use, you can use a Stripe customer object and create an associated bank account from the token, or you can use a Stripe Custom account and create an associated external bank account from the token. This bank account information should work indefinitely, unless the user's bank account information changes or they revoke Plaid's permissions to access their account. Stripe bank account information cannot be modified once the bank account token has been created. If you ever need to change the bank account details used by Stripe for a specific customer, have the user go through Link again and create a new bank account token from the new `access_token`. Bank account tokens can also be revoked, using `/item/remove`.'
|
6459
6719
|
# @param processor_stripe_bank_account_token_create_request [ProcessorStripeBankAccountTokenCreateRequest]
|
6460
6720
|
# @param [Hash] opts the optional parameters
|
6461
6721
|
# @return [ProcessorStripeBankAccountTokenCreateResponse]
|
@@ -6465,7 +6725,7 @@ module Plaid
|
|
6465
6725
|
end
|
6466
6726
|
|
6467
6727
|
# Create Stripe bank account token
|
6468
|
-
#
|
6728
|
+
# Used to create a token suitable for sending to Stripe to enable Plaid-Stripe integrations. For a detailed guide on integrating Stripe, see [Add Stripe to your app](https://plaid.com/docs/auth/partnerships/stripe/). Note that the Stripe bank account token is a one-time use token. To store bank account information for later use, you can use a Stripe customer object and create an associated bank account from the token, or you can use a Stripe Custom account and create an associated external bank account from the token. This bank account information should work indefinitely, unless the user's bank account information changes or they revoke Plaid's permissions to access their account. Stripe bank account information cannot be modified once the bank account token has been created. If you ever need to change the bank account details used by Stripe for a specific customer, have the user go through Link again and create a new bank account token from the new `access_token`. Bank account tokens can also be revoked, using `/item/remove`.'
|
6469
6729
|
# @param processor_stripe_bank_account_token_create_request [ProcessorStripeBankAccountTokenCreateRequest]
|
6470
6730
|
# @param [Hash] opts the optional parameters
|
6471
6731
|
# @return [Array<(ProcessorStripeBankAccountTokenCreateResponse, Integer, Hash)>] ProcessorStripeBankAccountTokenCreateResponse data, response status code and response headers
|
@@ -6520,7 +6780,7 @@ module Plaid
|
|
6520
6780
|
end
|
6521
6781
|
|
6522
6782
|
# Create processor token
|
6523
|
-
# Used to create a token suitable for sending to one of Plaid's partners to enable integrations. Note that Stripe partnerships use bank account tokens instead; see `/processor/stripe/bank_account_token/create` for creating tokens for use with Stripe integrations. Processor tokens can also be revoked, using `/item/remove`.
|
6783
|
+
# Used to create a token suitable for sending to one of Plaid's partners to enable integrations. Note that Stripe partnerships use bank account tokens instead; see `/processor/stripe/bank_account_token/create` for creating tokens for use with Stripe integrations. Once created, a processor token for a given Item cannot be modified or updated. If the account must be linked to a new or different partner resource, create a new Item by having the user go through the Link flow again; a new processor token can then be created from the new `access_token`. Processor tokens can also be revoked, using `/item/remove`.
|
6524
6784
|
# @param processor_token_create_request [ProcessorTokenCreateRequest]
|
6525
6785
|
# @param [Hash] opts the optional parameters
|
6526
6786
|
# @return [ProcessorTokenCreateResponse]
|
@@ -6530,7 +6790,7 @@ module Plaid
|
|
6530
6790
|
end
|
6531
6791
|
|
6532
6792
|
# Create processor token
|
6533
|
-
# Used to create a token suitable for sending to one of Plaid's partners to enable integrations. Note that Stripe partnerships use bank account tokens instead; see `/processor/stripe/bank_account_token/create` for creating tokens for use with Stripe integrations. Processor tokens can also be revoked, using `/item/remove`.
|
6793
|
+
# Used to create a token suitable for sending to one of Plaid's partners to enable integrations. Note that Stripe partnerships use bank account tokens instead; see `/processor/stripe/bank_account_token/create` for creating tokens for use with Stripe integrations. Once created, a processor token for a given Item cannot be modified or updated. If the account must be linked to a new or different partner resource, create a new Item by having the user go through the Link flow again; a new processor token can then be created from the new `access_token`. Processor tokens can also be revoked, using `/item/remove`.
|
6534
6794
|
# @param processor_token_create_request [ProcessorTokenCreateRequest]
|
6535
6795
|
# @param [Hash] opts the optional parameters
|
6536
6796
|
# @return [Array<(ProcessorTokenCreateResponse, Integer, Hash)>] ProcessorTokenCreateResponse data, response status code and response headers
|
@@ -7039,6 +7299,71 @@ module Plaid
|
|
7039
7299
|
return data, status_code, headers
|
7040
7300
|
end
|
7041
7301
|
|
7302
|
+
# Reset the login of a Payment Profile
|
7303
|
+
# `/sandbox/payment_profile/reset_login/` forces a Payment Profile into a state where the login is no longer valid. This makes it easy to test update mode for Payment Profile in the Sandbox environment. After calling `/sandbox/payment_profile/reset_login`, calls to the `/transfer/authorization/create` with the Payment Profile will result in a decision_rationale `PAYMENT_PROFILE_LOGIN_REQUIRED``. You can then use update mode for Payment Profile to restore it into a good state. In order to invoke this endpoint, you must first [create a Payment Profile](https://plaid.com/docs/transfer/add-to-app/#create-a-payment-profile-optional) and [go through the Link flow](https://plaid.com/docs/transfer/add-to-app/#create-a-link-token).
|
7304
|
+
# @param sandbox_payment_profile_reset_login_request [SandboxPaymentProfileResetLoginRequest]
|
7305
|
+
# @param [Hash] opts the optional parameters
|
7306
|
+
# @return [SandboxPaymentProfileResetLoginResponse]
|
7307
|
+
def sandbox_payment_profile_reset_login(sandbox_payment_profile_reset_login_request, opts = {})
|
7308
|
+
data, _status_code, _headers = sandbox_payment_profile_reset_login_with_http_info(sandbox_payment_profile_reset_login_request, opts)
|
7309
|
+
data
|
7310
|
+
end
|
7311
|
+
|
7312
|
+
# Reset the login of a Payment Profile
|
7313
|
+
# `/sandbox/payment_profile/reset_login/` forces a Payment Profile into a state where the login is no longer valid. This makes it easy to test update mode for Payment Profile in the Sandbox environment. After calling `/sandbox/payment_profile/reset_login`, calls to the `/transfer/authorization/create` with the Payment Profile will result in a decision_rationale `PAYMENT_PROFILE_LOGIN_REQUIRED``. You can then use update mode for Payment Profile to restore it into a good state. In order to invoke this endpoint, you must first [create a Payment Profile](https://plaid.com/docs/transfer/add-to-app/#create-a-payment-profile-optional) and [go through the Link flow](https://plaid.com/docs/transfer/add-to-app/#create-a-link-token).
|
7314
|
+
# @param sandbox_payment_profile_reset_login_request [SandboxPaymentProfileResetLoginRequest]
|
7315
|
+
# @param [Hash] opts the optional parameters
|
7316
|
+
# @return [Array<(SandboxPaymentProfileResetLoginResponse, Integer, Hash)>] SandboxPaymentProfileResetLoginResponse data, response status code and response headers
|
7317
|
+
def sandbox_payment_profile_reset_login_with_http_info(sandbox_payment_profile_reset_login_request, opts = {})
|
7318
|
+
if @api_client.config.debugging
|
7319
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.sandbox_payment_profile_reset_login ...'
|
7320
|
+
end
|
7321
|
+
# verify the required parameter 'sandbox_payment_profile_reset_login_request' is set
|
7322
|
+
if @api_client.config.client_side_validation && sandbox_payment_profile_reset_login_request.nil?
|
7323
|
+
fail ArgumentError, "Missing the required parameter 'sandbox_payment_profile_reset_login_request' when calling PlaidApi.sandbox_payment_profile_reset_login"
|
7324
|
+
end
|
7325
|
+
# resource path
|
7326
|
+
local_var_path = '/sandbox/payment_profile/reset_login'
|
7327
|
+
|
7328
|
+
# query parameters
|
7329
|
+
query_params = opts[:query_params] || {}
|
7330
|
+
|
7331
|
+
# header parameters
|
7332
|
+
header_params = opts[:header_params] || {}
|
7333
|
+
# HTTP header 'Accept' (if needed)
|
7334
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
7335
|
+
# HTTP header 'Content-Type'
|
7336
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
7337
|
+
|
7338
|
+
# form parameters
|
7339
|
+
form_params = opts[:form_params] || {}
|
7340
|
+
|
7341
|
+
# http body (model)
|
7342
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(sandbox_payment_profile_reset_login_request)
|
7343
|
+
|
7344
|
+
# return_type
|
7345
|
+
return_type = opts[:debug_return_type] || 'SandboxPaymentProfileResetLoginResponse'
|
7346
|
+
|
7347
|
+
# auth_names
|
7348
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
7349
|
+
|
7350
|
+
new_options = opts.merge(
|
7351
|
+
:operation => :"PlaidApi.sandbox_payment_profile_reset_login",
|
7352
|
+
:header_params => header_params,
|
7353
|
+
:query_params => query_params,
|
7354
|
+
:form_params => form_params,
|
7355
|
+
:body => post_body,
|
7356
|
+
:auth_names => auth_names,
|
7357
|
+
:return_type => return_type
|
7358
|
+
)
|
7359
|
+
|
7360
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
7361
|
+
if @api_client.config.debugging
|
7362
|
+
@api_client.config.logger.debug "API called: PlaidApi#sandbox_payment_profile_reset_login\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
7363
|
+
end
|
7364
|
+
return data, status_code, headers
|
7365
|
+
end
|
7366
|
+
|
7042
7367
|
# Create a test Item and processor token
|
7043
7368
|
# Use the `/sandbox/processor_token/create` endpoint to create a valid `processor_token` for an arbitrary institution ID and test credentials. The created `processor_token` corresponds to a new Sandbox Item. You can then use this `processor_token` with the `/processor/` API endpoints in Sandbox. You can also use `/sandbox/processor_token/create` with the [`user_custom` test username](https://plaid.com/docs/sandbox/user-custom) to generate a test account with custom data.
|
7044
7369
|
# @param sandbox_processor_token_create_request [SandboxProcessorTokenCreateRequest]
|
@@ -7885,7 +8210,7 @@ module Plaid
|
|
7885
8210
|
end
|
7886
8211
|
|
7887
8212
|
# Refresh transaction data
|
7888
|
-
# `/transactions/refresh` is an optional endpoint for users of the Transactions product. It initiates an on-demand extraction to fetch the newest transactions for an Item. This on-demand extraction takes place in addition to the periodic extractions that automatically occur multiple times a day for any Transactions-enabled Item. If changes to transactions are discovered after calling `/transactions/refresh`, Plaid will fire a webhook: [`TRANSACTIONS_REMOVED`](https://plaid.com/docs/api/products/transactions/#transactions_removed) will be fired if any removed transactions are detected, and [`DEFAULT_UPDATE`](https://plaid.com/docs/api/products/transactions/#default_update) will be fired if any new transactions are detected. New transactions can be fetched by calling `/transactions/get`. Access to `/transactions/refresh` in Production is specific to certain pricing plans. If you cannot access `/transactions/refresh` in Production, [contact Sales](https://www.plaid.com/contact) for assistance.
|
8213
|
+
# `/transactions/refresh` is an optional endpoint for users of the Transactions product. It initiates an on-demand extraction to fetch the newest transactions for an Item. This on-demand extraction takes place in addition to the periodic extractions that automatically occur multiple times a day for any Transactions-enabled Item. If changes to transactions are discovered after calling `/transactions/refresh`, Plaid will fire a webhook: for `/transactions/sync` users, [`SYNC_UDPATES_AVAILABLE`](https://plaid.com/docs/api/products/transactions/#sync_updates_available) will be fired if there are any transactions updated, added, or removed. For users of both `/transactions/sync` and `/transactions/get`, [`TRANSACTIONS_REMOVED`](https://plaid.com/docs/api/products/transactions/#transactions_removed) will be fired if any removed transactions are detected, and [`DEFAULT_UPDATE`](https://plaid.com/docs/api/products/transactions/#default_update) will be fired if any new transactions are detected. New transactions can be fetched by calling `/transactions/get` or `/transactions/sync`. Access to `/transactions/refresh` in Production is specific to certain pricing plans. If you cannot access `/transactions/refresh` in Production, [contact Sales](https://www.plaid.com/contact) for assistance.
|
7889
8214
|
# @param transactions_refresh_request [TransactionsRefreshRequest]
|
7890
8215
|
# @param [Hash] opts the optional parameters
|
7891
8216
|
# @return [TransactionsRefreshResponse]
|
@@ -7895,7 +8220,7 @@ module Plaid
|
|
7895
8220
|
end
|
7896
8221
|
|
7897
8222
|
# Refresh transaction data
|
7898
|
-
# `/transactions/refresh` is an optional endpoint for users of the Transactions product. It initiates an on-demand extraction to fetch the newest transactions for an Item. This on-demand extraction takes place in addition to the periodic extractions that automatically occur multiple times a day for any Transactions-enabled Item. If changes to transactions are discovered after calling `/transactions/refresh`, Plaid will fire a webhook: [`TRANSACTIONS_REMOVED`](https://plaid.com/docs/api/products/transactions/#transactions_removed) will be fired if any removed transactions are detected, and [`DEFAULT_UPDATE`](https://plaid.com/docs/api/products/transactions/#default_update) will be fired if any new transactions are detected. New transactions can be fetched by calling `/transactions/get`. Access to `/transactions/refresh` in Production is specific to certain pricing plans. If you cannot access `/transactions/refresh` in Production, [contact Sales](https://www.plaid.com/contact) for assistance.
|
8223
|
+
# `/transactions/refresh` is an optional endpoint for users of the Transactions product. It initiates an on-demand extraction to fetch the newest transactions for an Item. This on-demand extraction takes place in addition to the periodic extractions that automatically occur multiple times a day for any Transactions-enabled Item. If changes to transactions are discovered after calling `/transactions/refresh`, Plaid will fire a webhook: for `/transactions/sync` users, [`SYNC_UDPATES_AVAILABLE`](https://plaid.com/docs/api/products/transactions/#sync_updates_available) will be fired if there are any transactions updated, added, or removed. For users of both `/transactions/sync` and `/transactions/get`, [`TRANSACTIONS_REMOVED`](https://plaid.com/docs/api/products/transactions/#transactions_removed) will be fired if any removed transactions are detected, and [`DEFAULT_UPDATE`](https://plaid.com/docs/api/products/transactions/#default_update) will be fired if any new transactions are detected. New transactions can be fetched by calling `/transactions/get` or `/transactions/sync`. Access to `/transactions/refresh` in Production is specific to certain pricing plans. If you cannot access `/transactions/refresh` in Production, [contact Sales](https://www.plaid.com/contact) for assistance.
|
7899
8224
|
# @param transactions_refresh_request [TransactionsRefreshRequest]
|
7900
8225
|
# @param [Hash] opts the optional parameters
|
7901
8226
|
# @return [Array<(TransactionsRefreshResponse, Integer, Hash)>] TransactionsRefreshResponse data, response status code and response headers
|
@@ -8210,7 +8535,7 @@ module Plaid
|
|
8210
8535
|
end
|
8211
8536
|
|
8212
8537
|
# Create a transfer authorization
|
8213
|
-
# Use the `/transfer/authorization/create` endpoint to determine transfer failure risk. In Plaid's
|
8538
|
+
# 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 `ITEM_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. `device.ip_address`, `device.user_agent` are required fields. For [Guarantee](https://www.plaid.com/docs//transfer/guarantee/), the following fields are required : `idempotency_key`, `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`.
|
8214
8539
|
# @param transfer_authorization_create_request [TransferAuthorizationCreateRequest]
|
8215
8540
|
# @param [Hash] opts the optional parameters
|
8216
8541
|
# @return [TransferAuthorizationCreateResponse]
|
@@ -8220,7 +8545,7 @@ module Plaid
|
|
8220
8545
|
end
|
8221
8546
|
|
8222
8547
|
# Create a transfer authorization
|
8223
|
-
# Use the `/transfer/authorization/create` endpoint to determine transfer failure risk. In Plaid's
|
8548
|
+
# 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 `ITEM_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. `device.ip_address`, `device.user_agent` are required fields. For [Guarantee](https://www.plaid.com/docs//transfer/guarantee/), the following fields are required : `idempotency_key`, `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`.
|
8224
8549
|
# @param transfer_authorization_create_request [TransferAuthorizationCreateRequest]
|
8225
8550
|
# @param [Hash] opts the optional parameters
|
8226
8551
|
# @return [Array<(TransferAuthorizationCreateResponse, Integer, Hash)>] TransferAuthorizationCreateResponse data, response status code and response headers
|
@@ -8275,7 +8600,7 @@ module Plaid
|
|
8275
8600
|
end
|
8276
8601
|
|
8277
8602
|
# Cancel a transfer
|
8278
|
-
# Use the `/transfer/cancel` endpoint to cancel a transfer. A transfer is eligible for
|
8603
|
+
# Use the `/transfer/cancel` endpoint to cancel a transfer. A transfer is eligible for cancellation if the `cancellable` property returned by `/transfer/get` is `true`.
|
8279
8604
|
# @param transfer_cancel_request [TransferCancelRequest]
|
8280
8605
|
# @param [Hash] opts the optional parameters
|
8281
8606
|
# @return [TransferCancelResponse]
|
@@ -8285,7 +8610,7 @@ module Plaid
|
|
8285
8610
|
end
|
8286
8611
|
|
8287
8612
|
# Cancel a transfer
|
8288
|
-
# Use the `/transfer/cancel` endpoint to cancel a transfer. A transfer is eligible for
|
8613
|
+
# Use the `/transfer/cancel` endpoint to cancel a transfer. A transfer is eligible for cancellation if the `cancellable` property returned by `/transfer/get` is `true`.
|
8289
8614
|
# @param transfer_cancel_request [TransferCancelRequest]
|
8290
8615
|
# @param [Hash] opts the optional parameters
|
8291
8616
|
# @return [Array<(TransferCancelResponse, Integer, Hash)>] TransferCancelResponse data, response status code and response headers
|
@@ -9120,7 +9445,7 @@ module Plaid
|
|
9120
9445
|
end
|
9121
9446
|
|
9122
9447
|
# Create 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`.
|
9448
|
+
# 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`. Ensure that you store the `user_token` along with your user's identifier in your database, as it is not possible to retrieve a previously created `user_token`.
|
9124
9449
|
# @param user_create_request [UserCreateRequest]
|
9125
9450
|
# @param [Hash] opts the optional parameters
|
9126
9451
|
# @return [UserCreateResponse]
|
@@ -9130,7 +9455,7 @@ module Plaid
|
|
9130
9455
|
end
|
9131
9456
|
|
9132
9457
|
# Create 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`.
|
9458
|
+
# 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`. Ensure that you store the `user_token` along with your user's identifier in your database, as it is not possible to retrieve a previously created `user_token`.
|
9134
9459
|
# @param user_create_request [UserCreateRequest]
|
9135
9460
|
# @param [Hash] opts the optional parameters
|
9136
9461
|
# @return [Array<(UserCreateResponse, Integer, Hash)>] UserCreateResponse data, response status code and response headers
|
@@ -9380,7 +9705,7 @@ module Plaid
|
|
9380
9705
|
end
|
9381
9706
|
|
9382
9707
|
# Execute a transaction using an e-wallet
|
9383
|
-
# Execute a transaction using the specified e-wallet. Specify the e-wallet to debit from, the counterparty to credit to, the idempotency key to prevent duplicate
|
9708
|
+
# Execute a transaction using the specified e-wallet. Specify the e-wallet to debit from, the counterparty to credit to, the idempotency key to prevent duplicate transactions, the amount and reference for the transaction. Transactions will settle in seconds to several days, depending on the underlying payment rail.
|
9384
9709
|
# @param wallet_transaction_execute_request [WalletTransactionExecuteRequest]
|
9385
9710
|
# @param [Hash] opts the optional parameters
|
9386
9711
|
# @return [WalletTransactionExecuteResponse]
|
@@ -9390,7 +9715,7 @@ module Plaid
|
|
9390
9715
|
end
|
9391
9716
|
|
9392
9717
|
# Execute a transaction using an e-wallet
|
9393
|
-
# Execute a transaction using the specified e-wallet. Specify the e-wallet to debit from, the counterparty to credit to, the idempotency key to prevent duplicate
|
9718
|
+
# Execute a transaction using the specified e-wallet. Specify the e-wallet to debit from, the counterparty to credit to, the idempotency key to prevent duplicate transactions, the amount and reference for the transaction. Transactions will settle in seconds to several days, depending on the underlying payment rail.
|
9394
9719
|
# @param wallet_transaction_execute_request [WalletTransactionExecuteRequest]
|
9395
9720
|
# @param [Hash] opts the optional parameters
|
9396
9721
|
# @return [Array<(WalletTransactionExecuteResponse, Integer, Hash)>] WalletTransactionExecuteResponse data, response status code and response headers
|
@@ -9444,6 +9769,7 @@ module Plaid
|
|
9444
9769
|
return data, status_code, headers
|
9445
9770
|
end
|
9446
9771
|
|
9772
|
+
# Fetch an e-wallet transaction
|
9447
9773
|
# Fetch a specific e-wallet transaction
|
9448
9774
|
# @param wallet_transaction_get_request [WalletTransactionGetRequest]
|
9449
9775
|
# @param [Hash] opts the optional parameters
|
@@ -9453,6 +9779,7 @@ module Plaid
|
|
9453
9779
|
data
|
9454
9780
|
end
|
9455
9781
|
|
9782
|
+
# Fetch an e-wallet transaction
|
9456
9783
|
# Fetch a specific e-wallet transaction
|
9457
9784
|
# @param wallet_transaction_get_request [WalletTransactionGetRequest]
|
9458
9785
|
# @param [Hash] opts the optional parameters
|
@@ -9574,26 +9901,26 @@ module Plaid
|
|
9574
9901
|
|
9575
9902
|
# Create a watchlist screening for an entity
|
9576
9903
|
# Create a new entity watchlist screening to check your customer against watchlists defined in the associated entity watchlist program. If your associated program has ongoing screening enabled, this is the profile information that will be used to monitor your customer over time.
|
9577
|
-
# @param
|
9904
|
+
# @param watchlist_screening_entity_create_request [WatchlistScreeningEntityCreateRequest]
|
9578
9905
|
# @param [Hash] opts the optional parameters
|
9579
|
-
# @return [
|
9580
|
-
def watchlist_screening_entity_create(
|
9581
|
-
data, _status_code, _headers = watchlist_screening_entity_create_with_http_info(
|
9906
|
+
# @return [WatchlistScreeningEntityCreateResponse]
|
9907
|
+
def watchlist_screening_entity_create(watchlist_screening_entity_create_request, opts = {})
|
9908
|
+
data, _status_code, _headers = watchlist_screening_entity_create_with_http_info(watchlist_screening_entity_create_request, opts)
|
9582
9909
|
data
|
9583
9910
|
end
|
9584
9911
|
|
9585
9912
|
# Create a watchlist screening for an entity
|
9586
9913
|
# Create a new entity watchlist screening to check your customer against watchlists defined in the associated entity watchlist program. If your associated program has ongoing screening enabled, this is the profile information that will be used to monitor your customer over time.
|
9587
|
-
# @param
|
9914
|
+
# @param watchlist_screening_entity_create_request [WatchlistScreeningEntityCreateRequest]
|
9588
9915
|
# @param [Hash] opts the optional parameters
|
9589
|
-
# @return [Array<(
|
9590
|
-
def watchlist_screening_entity_create_with_http_info(
|
9916
|
+
# @return [Array<(WatchlistScreeningEntityCreateResponse, Integer, Hash)>] WatchlistScreeningEntityCreateResponse data, response status code and response headers
|
9917
|
+
def watchlist_screening_entity_create_with_http_info(watchlist_screening_entity_create_request, opts = {})
|
9591
9918
|
if @api_client.config.debugging
|
9592
9919
|
@api_client.config.logger.debug 'Calling API: PlaidApi.watchlist_screening_entity_create ...'
|
9593
9920
|
end
|
9594
|
-
# verify the required parameter '
|
9595
|
-
if @api_client.config.client_side_validation &&
|
9596
|
-
fail ArgumentError, "Missing the required parameter '
|
9921
|
+
# verify the required parameter 'watchlist_screening_entity_create_request' is set
|
9922
|
+
if @api_client.config.client_side_validation && watchlist_screening_entity_create_request.nil?
|
9923
|
+
fail ArgumentError, "Missing the required parameter 'watchlist_screening_entity_create_request' when calling PlaidApi.watchlist_screening_entity_create"
|
9597
9924
|
end
|
9598
9925
|
# resource path
|
9599
9926
|
local_var_path = '/watchlist_screening/entity/create'
|
@@ -9612,10 +9939,10 @@ module Plaid
|
|
9612
9939
|
form_params = opts[:form_params] || {}
|
9613
9940
|
|
9614
9941
|
# http body (model)
|
9615
|
-
post_body = opts[:debug_body] || @api_client.object_to_http_body(
|
9942
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(watchlist_screening_entity_create_request)
|
9616
9943
|
|
9617
9944
|
# return_type
|
9618
|
-
return_type = opts[:debug_return_type] || '
|
9945
|
+
return_type = opts[:debug_return_type] || 'WatchlistScreeningEntityCreateResponse'
|
9619
9946
|
|
9620
9947
|
# auth_names
|
9621
9948
|
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
@@ -9639,26 +9966,26 @@ module Plaid
|
|
9639
9966
|
|
9640
9967
|
# Get an entity screening
|
9641
9968
|
# Retrieve an entity watchlist screening.
|
9642
|
-
# @param
|
9969
|
+
# @param watchlist_screening_entity_get_request [WatchlistScreeningEntityGetRequest]
|
9643
9970
|
# @param [Hash] opts the optional parameters
|
9644
|
-
# @return [
|
9645
|
-
def watchlist_screening_entity_get(
|
9646
|
-
data, _status_code, _headers = watchlist_screening_entity_get_with_http_info(
|
9971
|
+
# @return [WatchlistScreeningEntityGetResponse]
|
9972
|
+
def watchlist_screening_entity_get(watchlist_screening_entity_get_request, opts = {})
|
9973
|
+
data, _status_code, _headers = watchlist_screening_entity_get_with_http_info(watchlist_screening_entity_get_request, opts)
|
9647
9974
|
data
|
9648
9975
|
end
|
9649
9976
|
|
9650
9977
|
# Get an entity screening
|
9651
9978
|
# Retrieve an entity watchlist screening.
|
9652
|
-
# @param
|
9979
|
+
# @param watchlist_screening_entity_get_request [WatchlistScreeningEntityGetRequest]
|
9653
9980
|
# @param [Hash] opts the optional parameters
|
9654
|
-
# @return [Array<(
|
9655
|
-
def watchlist_screening_entity_get_with_http_info(
|
9981
|
+
# @return [Array<(WatchlistScreeningEntityGetResponse, Integer, Hash)>] WatchlistScreeningEntityGetResponse data, response status code and response headers
|
9982
|
+
def watchlist_screening_entity_get_with_http_info(watchlist_screening_entity_get_request, opts = {})
|
9656
9983
|
if @api_client.config.debugging
|
9657
9984
|
@api_client.config.logger.debug 'Calling API: PlaidApi.watchlist_screening_entity_get ...'
|
9658
9985
|
end
|
9659
|
-
# verify the required parameter '
|
9660
|
-
if @api_client.config.client_side_validation &&
|
9661
|
-
fail ArgumentError, "Missing the required parameter '
|
9986
|
+
# verify the required parameter 'watchlist_screening_entity_get_request' is set
|
9987
|
+
if @api_client.config.client_side_validation && watchlist_screening_entity_get_request.nil?
|
9988
|
+
fail ArgumentError, "Missing the required parameter 'watchlist_screening_entity_get_request' when calling PlaidApi.watchlist_screening_entity_get"
|
9662
9989
|
end
|
9663
9990
|
# resource path
|
9664
9991
|
local_var_path = '/watchlist_screening/entity/get'
|
@@ -9677,10 +10004,10 @@ module Plaid
|
|
9677
10004
|
form_params = opts[:form_params] || {}
|
9678
10005
|
|
9679
10006
|
# http body (model)
|
9680
|
-
post_body = opts[:debug_body] || @api_client.object_to_http_body(
|
10007
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(watchlist_screening_entity_get_request)
|
9681
10008
|
|
9682
10009
|
# return_type
|
9683
|
-
return_type = opts[:debug_return_type] || '
|
10010
|
+
return_type = opts[:debug_return_type] || 'WatchlistScreeningEntityGetResponse'
|
9684
10011
|
|
9685
10012
|
# auth_names
|
9686
10013
|
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
@@ -9704,26 +10031,26 @@ module Plaid
|
|
9704
10031
|
|
9705
10032
|
# List history for entity watchlist screenings
|
9706
10033
|
# List all changes to the entity watchlist screening in reverse-chronological order. If the watchlist screening has not been edited, no history will be returned.
|
9707
|
-
# @param
|
10034
|
+
# @param watchlist_screening_entity_history_list_request [WatchlistScreeningEntityHistoryListRequest]
|
9708
10035
|
# @param [Hash] opts the optional parameters
|
9709
|
-
# @return [
|
9710
|
-
def watchlist_screening_entity_history_list(
|
9711
|
-
data, _status_code, _headers = watchlist_screening_entity_history_list_with_http_info(
|
10036
|
+
# @return [WatchlistScreeningEntityHistoryListResponse]
|
10037
|
+
def watchlist_screening_entity_history_list(watchlist_screening_entity_history_list_request, opts = {})
|
10038
|
+
data, _status_code, _headers = watchlist_screening_entity_history_list_with_http_info(watchlist_screening_entity_history_list_request, opts)
|
9712
10039
|
data
|
9713
10040
|
end
|
9714
10041
|
|
9715
10042
|
# List history for entity watchlist screenings
|
9716
10043
|
# List all changes to the entity watchlist screening in reverse-chronological order. If the watchlist screening has not been edited, no history will be returned.
|
9717
|
-
# @param
|
10044
|
+
# @param watchlist_screening_entity_history_list_request [WatchlistScreeningEntityHistoryListRequest]
|
9718
10045
|
# @param [Hash] opts the optional parameters
|
9719
|
-
# @return [Array<(
|
9720
|
-
def watchlist_screening_entity_history_list_with_http_info(
|
10046
|
+
# @return [Array<(WatchlistScreeningEntityHistoryListResponse, Integer, Hash)>] WatchlistScreeningEntityHistoryListResponse data, response status code and response headers
|
10047
|
+
def watchlist_screening_entity_history_list_with_http_info(watchlist_screening_entity_history_list_request, opts = {})
|
9721
10048
|
if @api_client.config.debugging
|
9722
10049
|
@api_client.config.logger.debug 'Calling API: PlaidApi.watchlist_screening_entity_history_list ...'
|
9723
10050
|
end
|
9724
|
-
# verify the required parameter '
|
9725
|
-
if @api_client.config.client_side_validation &&
|
9726
|
-
fail ArgumentError, "Missing the required parameter '
|
10051
|
+
# verify the required parameter 'watchlist_screening_entity_history_list_request' is set
|
10052
|
+
if @api_client.config.client_side_validation && watchlist_screening_entity_history_list_request.nil?
|
10053
|
+
fail ArgumentError, "Missing the required parameter 'watchlist_screening_entity_history_list_request' when calling PlaidApi.watchlist_screening_entity_history_list"
|
9727
10054
|
end
|
9728
10055
|
# resource path
|
9729
10056
|
local_var_path = '/watchlist_screening/entity/history/list'
|
@@ -9742,10 +10069,10 @@ module Plaid
|
|
9742
10069
|
form_params = opts[:form_params] || {}
|
9743
10070
|
|
9744
10071
|
# http body (model)
|
9745
|
-
post_body = opts[:debug_body] || @api_client.object_to_http_body(
|
10072
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(watchlist_screening_entity_history_list_request)
|
9746
10073
|
|
9747
10074
|
# return_type
|
9748
|
-
return_type = opts[:debug_return_type] || '
|
10075
|
+
return_type = opts[:debug_return_type] || 'WatchlistScreeningEntityHistoryListResponse'
|
9749
10076
|
|
9750
10077
|
# auth_names
|
9751
10078
|
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
@@ -9769,26 +10096,26 @@ module Plaid
|
|
9769
10096
|
|
9770
10097
|
# List hits for entity watchlist screenings
|
9771
10098
|
# List all hits for the entity watchlist screening.
|
9772
|
-
# @param
|
10099
|
+
# @param watchlist_screening_entity_hit_list_request [WatchlistScreeningEntityHitListRequest]
|
9773
10100
|
# @param [Hash] opts the optional parameters
|
9774
|
-
# @return [
|
9775
|
-
def
|
9776
|
-
data, _status_code, _headers =
|
10101
|
+
# @return [WatchlistScreeningEntityHitListResponse]
|
10102
|
+
def watchlist_screening_entity_hit_list(watchlist_screening_entity_hit_list_request, opts = {})
|
10103
|
+
data, _status_code, _headers = watchlist_screening_entity_hit_list_with_http_info(watchlist_screening_entity_hit_list_request, opts)
|
9777
10104
|
data
|
9778
10105
|
end
|
9779
10106
|
|
9780
10107
|
# List hits for entity watchlist screenings
|
9781
10108
|
# List all hits for the entity watchlist screening.
|
9782
|
-
# @param
|
10109
|
+
# @param watchlist_screening_entity_hit_list_request [WatchlistScreeningEntityHitListRequest]
|
9783
10110
|
# @param [Hash] opts the optional parameters
|
9784
|
-
# @return [Array<(
|
9785
|
-
def
|
10111
|
+
# @return [Array<(WatchlistScreeningEntityHitListResponse, Integer, Hash)>] WatchlistScreeningEntityHitListResponse data, response status code and response headers
|
10112
|
+
def watchlist_screening_entity_hit_list_with_http_info(watchlist_screening_entity_hit_list_request, opts = {})
|
9786
10113
|
if @api_client.config.debugging
|
9787
|
-
@api_client.config.logger.debug 'Calling API: PlaidApi.
|
10114
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.watchlist_screening_entity_hit_list ...'
|
9788
10115
|
end
|
9789
|
-
# verify the required parameter '
|
9790
|
-
if @api_client.config.client_side_validation &&
|
9791
|
-
fail ArgumentError, "Missing the required parameter '
|
10116
|
+
# verify the required parameter 'watchlist_screening_entity_hit_list_request' is set
|
10117
|
+
if @api_client.config.client_side_validation && watchlist_screening_entity_hit_list_request.nil?
|
10118
|
+
fail ArgumentError, "Missing the required parameter 'watchlist_screening_entity_hit_list_request' when calling PlaidApi.watchlist_screening_entity_hit_list"
|
9792
10119
|
end
|
9793
10120
|
# resource path
|
9794
10121
|
local_var_path = '/watchlist_screening/entity/hit/list'
|
@@ -9807,16 +10134,16 @@ module Plaid
|
|
9807
10134
|
form_params = opts[:form_params] || {}
|
9808
10135
|
|
9809
10136
|
# http body (model)
|
9810
|
-
post_body = opts[:debug_body] || @api_client.object_to_http_body(
|
10137
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(watchlist_screening_entity_hit_list_request)
|
9811
10138
|
|
9812
10139
|
# return_type
|
9813
|
-
return_type = opts[:debug_return_type] || '
|
10140
|
+
return_type = opts[:debug_return_type] || 'WatchlistScreeningEntityHitListResponse'
|
9814
10141
|
|
9815
10142
|
# auth_names
|
9816
10143
|
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
9817
10144
|
|
9818
10145
|
new_options = opts.merge(
|
9819
|
-
:operation => :"PlaidApi.
|
10146
|
+
:operation => :"PlaidApi.watchlist_screening_entity_hit_list",
|
9820
10147
|
:header_params => header_params,
|
9821
10148
|
:query_params => query_params,
|
9822
10149
|
:form_params => form_params,
|
@@ -9827,33 +10154,33 @@ module Plaid
|
|
9827
10154
|
|
9828
10155
|
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
9829
10156
|
if @api_client.config.debugging
|
9830
|
-
@api_client.config.logger.debug "API called: PlaidApi#
|
10157
|
+
@api_client.config.logger.debug "API called: PlaidApi#watchlist_screening_entity_hit_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
9831
10158
|
end
|
9832
10159
|
return data, status_code, headers
|
9833
10160
|
end
|
9834
10161
|
|
9835
10162
|
# List entity watchlist screenings
|
9836
10163
|
# List all entity screenings.
|
9837
|
-
# @param
|
10164
|
+
# @param watchlist_screening_entity_list_request [WatchlistScreeningEntityListRequest]
|
9838
10165
|
# @param [Hash] opts the optional parameters
|
9839
|
-
# @return [
|
9840
|
-
def watchlist_screening_entity_list(
|
9841
|
-
data, _status_code, _headers = watchlist_screening_entity_list_with_http_info(
|
10166
|
+
# @return [WatchlistScreeningEntityListResponse]
|
10167
|
+
def watchlist_screening_entity_list(watchlist_screening_entity_list_request, opts = {})
|
10168
|
+
data, _status_code, _headers = watchlist_screening_entity_list_with_http_info(watchlist_screening_entity_list_request, opts)
|
9842
10169
|
data
|
9843
10170
|
end
|
9844
10171
|
|
9845
10172
|
# List entity watchlist screenings
|
9846
10173
|
# List all entity screenings.
|
9847
|
-
# @param
|
10174
|
+
# @param watchlist_screening_entity_list_request [WatchlistScreeningEntityListRequest]
|
9848
10175
|
# @param [Hash] opts the optional parameters
|
9849
|
-
# @return [Array<(
|
9850
|
-
def watchlist_screening_entity_list_with_http_info(
|
10176
|
+
# @return [Array<(WatchlistScreeningEntityListResponse, Integer, Hash)>] WatchlistScreeningEntityListResponse data, response status code and response headers
|
10177
|
+
def watchlist_screening_entity_list_with_http_info(watchlist_screening_entity_list_request, opts = {})
|
9851
10178
|
if @api_client.config.debugging
|
9852
10179
|
@api_client.config.logger.debug 'Calling API: PlaidApi.watchlist_screening_entity_list ...'
|
9853
10180
|
end
|
9854
|
-
# verify the required parameter '
|
9855
|
-
if @api_client.config.client_side_validation &&
|
9856
|
-
fail ArgumentError, "Missing the required parameter '
|
10181
|
+
# verify the required parameter 'watchlist_screening_entity_list_request' is set
|
10182
|
+
if @api_client.config.client_side_validation && watchlist_screening_entity_list_request.nil?
|
10183
|
+
fail ArgumentError, "Missing the required parameter 'watchlist_screening_entity_list_request' when calling PlaidApi.watchlist_screening_entity_list"
|
9857
10184
|
end
|
9858
10185
|
# resource path
|
9859
10186
|
local_var_path = '/watchlist_screening/entity/list'
|
@@ -9872,10 +10199,10 @@ module Plaid
|
|
9872
10199
|
form_params = opts[:form_params] || {}
|
9873
10200
|
|
9874
10201
|
# http body (model)
|
9875
|
-
post_body = opts[:debug_body] || @api_client.object_to_http_body(
|
10202
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(watchlist_screening_entity_list_request)
|
9876
10203
|
|
9877
10204
|
# return_type
|
9878
|
-
return_type = opts[:debug_return_type] || '
|
10205
|
+
return_type = opts[:debug_return_type] || 'WatchlistScreeningEntityListResponse'
|
9879
10206
|
|
9880
10207
|
# auth_names
|
9881
10208
|
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
@@ -9899,26 +10226,26 @@ module Plaid
|
|
9899
10226
|
|
9900
10227
|
# Get entity watchlist screening program
|
9901
10228
|
# Get an entity watchlist screening program
|
9902
|
-
# @param
|
10229
|
+
# @param watchlist_screening_entity_program_get_request [WatchlistScreeningEntityProgramGetRequest]
|
9903
10230
|
# @param [Hash] opts the optional parameters
|
9904
|
-
# @return [
|
9905
|
-
def watchlist_screening_entity_program_get(
|
9906
|
-
data, _status_code, _headers = watchlist_screening_entity_program_get_with_http_info(
|
10231
|
+
# @return [WatchlistScreeningEntityProgramGetResponse]
|
10232
|
+
def watchlist_screening_entity_program_get(watchlist_screening_entity_program_get_request, opts = {})
|
10233
|
+
data, _status_code, _headers = watchlist_screening_entity_program_get_with_http_info(watchlist_screening_entity_program_get_request, opts)
|
9907
10234
|
data
|
9908
10235
|
end
|
9909
10236
|
|
9910
10237
|
# Get entity watchlist screening program
|
9911
10238
|
# Get an entity watchlist screening program
|
9912
|
-
# @param
|
10239
|
+
# @param watchlist_screening_entity_program_get_request [WatchlistScreeningEntityProgramGetRequest]
|
9913
10240
|
# @param [Hash] opts the optional parameters
|
9914
|
-
# @return [Array<(
|
9915
|
-
def watchlist_screening_entity_program_get_with_http_info(
|
10241
|
+
# @return [Array<(WatchlistScreeningEntityProgramGetResponse, Integer, Hash)>] WatchlistScreeningEntityProgramGetResponse data, response status code and response headers
|
10242
|
+
def watchlist_screening_entity_program_get_with_http_info(watchlist_screening_entity_program_get_request, opts = {})
|
9916
10243
|
if @api_client.config.debugging
|
9917
10244
|
@api_client.config.logger.debug 'Calling API: PlaidApi.watchlist_screening_entity_program_get ...'
|
9918
10245
|
end
|
9919
|
-
# verify the required parameter '
|
9920
|
-
if @api_client.config.client_side_validation &&
|
9921
|
-
fail ArgumentError, "Missing the required parameter '
|
10246
|
+
# verify the required parameter 'watchlist_screening_entity_program_get_request' is set
|
10247
|
+
if @api_client.config.client_side_validation && watchlist_screening_entity_program_get_request.nil?
|
10248
|
+
fail ArgumentError, "Missing the required parameter 'watchlist_screening_entity_program_get_request' when calling PlaidApi.watchlist_screening_entity_program_get"
|
9922
10249
|
end
|
9923
10250
|
# resource path
|
9924
10251
|
local_var_path = '/watchlist_screening/entity/program/get'
|
@@ -9937,10 +10264,10 @@ module Plaid
|
|
9937
10264
|
form_params = opts[:form_params] || {}
|
9938
10265
|
|
9939
10266
|
# http body (model)
|
9940
|
-
post_body = opts[:debug_body] || @api_client.object_to_http_body(
|
10267
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(watchlist_screening_entity_program_get_request)
|
9941
10268
|
|
9942
10269
|
# return_type
|
9943
|
-
return_type = opts[:debug_return_type] || '
|
10270
|
+
return_type = opts[:debug_return_type] || 'WatchlistScreeningEntityProgramGetResponse'
|
9944
10271
|
|
9945
10272
|
# auth_names
|
9946
10273
|
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
@@ -9964,26 +10291,26 @@ module Plaid
|
|
9964
10291
|
|
9965
10292
|
# List entity watchlist screening programs
|
9966
10293
|
# List all entity watchlist screening programs
|
9967
|
-
# @param
|
10294
|
+
# @param watchlist_screening_entity_program_list_request [WatchlistScreeningEntityProgramListRequest]
|
9968
10295
|
# @param [Hash] opts the optional parameters
|
9969
|
-
# @return [
|
9970
|
-
def watchlist_screening_entity_program_list(
|
9971
|
-
data, _status_code, _headers = watchlist_screening_entity_program_list_with_http_info(
|
10296
|
+
# @return [WatchlistScreeningEntityProgramListResponse]
|
10297
|
+
def watchlist_screening_entity_program_list(watchlist_screening_entity_program_list_request, opts = {})
|
10298
|
+
data, _status_code, _headers = watchlist_screening_entity_program_list_with_http_info(watchlist_screening_entity_program_list_request, opts)
|
9972
10299
|
data
|
9973
10300
|
end
|
9974
10301
|
|
9975
10302
|
# List entity watchlist screening programs
|
9976
10303
|
# List all entity watchlist screening programs
|
9977
|
-
# @param
|
10304
|
+
# @param watchlist_screening_entity_program_list_request [WatchlistScreeningEntityProgramListRequest]
|
9978
10305
|
# @param [Hash] opts the optional parameters
|
9979
|
-
# @return [Array<(
|
9980
|
-
def watchlist_screening_entity_program_list_with_http_info(
|
10306
|
+
# @return [Array<(WatchlistScreeningEntityProgramListResponse, Integer, Hash)>] WatchlistScreeningEntityProgramListResponse data, response status code and response headers
|
10307
|
+
def watchlist_screening_entity_program_list_with_http_info(watchlist_screening_entity_program_list_request, opts = {})
|
9981
10308
|
if @api_client.config.debugging
|
9982
10309
|
@api_client.config.logger.debug 'Calling API: PlaidApi.watchlist_screening_entity_program_list ...'
|
9983
10310
|
end
|
9984
|
-
# verify the required parameter '
|
9985
|
-
if @api_client.config.client_side_validation &&
|
9986
|
-
fail ArgumentError, "Missing the required parameter '
|
10311
|
+
# verify the required parameter 'watchlist_screening_entity_program_list_request' is set
|
10312
|
+
if @api_client.config.client_side_validation && watchlist_screening_entity_program_list_request.nil?
|
10313
|
+
fail ArgumentError, "Missing the required parameter 'watchlist_screening_entity_program_list_request' when calling PlaidApi.watchlist_screening_entity_program_list"
|
9987
10314
|
end
|
9988
10315
|
# resource path
|
9989
10316
|
local_var_path = '/watchlist_screening/entity/program/list'
|
@@ -10002,10 +10329,10 @@ module Plaid
|
|
10002
10329
|
form_params = opts[:form_params] || {}
|
10003
10330
|
|
10004
10331
|
# http body (model)
|
10005
|
-
post_body = opts[:debug_body] || @api_client.object_to_http_body(
|
10332
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(watchlist_screening_entity_program_list_request)
|
10006
10333
|
|
10007
10334
|
# return_type
|
10008
|
-
return_type = opts[:debug_return_type] || '
|
10335
|
+
return_type = opts[:debug_return_type] || 'WatchlistScreeningEntityProgramListResponse'
|
10009
10336
|
|
10010
10337
|
# auth_names
|
10011
10338
|
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
@@ -10029,26 +10356,26 @@ module Plaid
|
|
10029
10356
|
|
10030
10357
|
# Create a review for an entity watchlist screening
|
10031
10358
|
# Create a review for an entity watchlist screening. Reviews are compliance reports created by users in your organization regarding the relevance of potential hits found by Plaid.
|
10032
|
-
# @param
|
10359
|
+
# @param watchlist_screening_entity_review_create_request [WatchlistScreeningEntityReviewCreateRequest]
|
10033
10360
|
# @param [Hash] opts the optional parameters
|
10034
|
-
# @return [
|
10035
|
-
def watchlist_screening_entity_review_create(
|
10036
|
-
data, _status_code, _headers = watchlist_screening_entity_review_create_with_http_info(
|
10361
|
+
# @return [WatchlistScreeningEntityReviewCreateResponse]
|
10362
|
+
def watchlist_screening_entity_review_create(watchlist_screening_entity_review_create_request, opts = {})
|
10363
|
+
data, _status_code, _headers = watchlist_screening_entity_review_create_with_http_info(watchlist_screening_entity_review_create_request, opts)
|
10037
10364
|
data
|
10038
10365
|
end
|
10039
10366
|
|
10040
10367
|
# Create a review for an entity watchlist screening
|
10041
10368
|
# Create a review for an entity watchlist screening. Reviews are compliance reports created by users in your organization regarding the relevance of potential hits found by Plaid.
|
10042
|
-
# @param
|
10369
|
+
# @param watchlist_screening_entity_review_create_request [WatchlistScreeningEntityReviewCreateRequest]
|
10043
10370
|
# @param [Hash] opts the optional parameters
|
10044
|
-
# @return [Array<(
|
10045
|
-
def watchlist_screening_entity_review_create_with_http_info(
|
10371
|
+
# @return [Array<(WatchlistScreeningEntityReviewCreateResponse, Integer, Hash)>] WatchlistScreeningEntityReviewCreateResponse data, response status code and response headers
|
10372
|
+
def watchlist_screening_entity_review_create_with_http_info(watchlist_screening_entity_review_create_request, opts = {})
|
10046
10373
|
if @api_client.config.debugging
|
10047
10374
|
@api_client.config.logger.debug 'Calling API: PlaidApi.watchlist_screening_entity_review_create ...'
|
10048
10375
|
end
|
10049
|
-
# verify the required parameter '
|
10050
|
-
if @api_client.config.client_side_validation &&
|
10051
|
-
fail ArgumentError, "Missing the required parameter '
|
10376
|
+
# verify the required parameter 'watchlist_screening_entity_review_create_request' is set
|
10377
|
+
if @api_client.config.client_side_validation && watchlist_screening_entity_review_create_request.nil?
|
10378
|
+
fail ArgumentError, "Missing the required parameter 'watchlist_screening_entity_review_create_request' when calling PlaidApi.watchlist_screening_entity_review_create"
|
10052
10379
|
end
|
10053
10380
|
# resource path
|
10054
10381
|
local_var_path = '/watchlist_screening/entity/review/create'
|
@@ -10067,10 +10394,10 @@ module Plaid
|
|
10067
10394
|
form_params = opts[:form_params] || {}
|
10068
10395
|
|
10069
10396
|
# http body (model)
|
10070
|
-
post_body = opts[:debug_body] || @api_client.object_to_http_body(
|
10397
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(watchlist_screening_entity_review_create_request)
|
10071
10398
|
|
10072
10399
|
# return_type
|
10073
|
-
return_type = opts[:debug_return_type] || '
|
10400
|
+
return_type = opts[:debug_return_type] || 'WatchlistScreeningEntityReviewCreateResponse'
|
10074
10401
|
|
10075
10402
|
# auth_names
|
10076
10403
|
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
@@ -10094,26 +10421,26 @@ module Plaid
|
|
10094
10421
|
|
10095
10422
|
# List reviews for entity watchlist screenings
|
10096
10423
|
# List all reviews for a particular entity watchlist screening. Reviews are compliance reports created by users in your organization regarding the relevance of potential hits found by Plaid.
|
10097
|
-
# @param
|
10424
|
+
# @param watchlist_screening_entity_review_list_request [WatchlistScreeningEntityReviewListRequest]
|
10098
10425
|
# @param [Hash] opts the optional parameters
|
10099
|
-
# @return [
|
10100
|
-
def watchlist_screening_entity_review_list(
|
10101
|
-
data, _status_code, _headers = watchlist_screening_entity_review_list_with_http_info(
|
10426
|
+
# @return [WatchlistScreeningEntityReviewListResponse]
|
10427
|
+
def watchlist_screening_entity_review_list(watchlist_screening_entity_review_list_request, opts = {})
|
10428
|
+
data, _status_code, _headers = watchlist_screening_entity_review_list_with_http_info(watchlist_screening_entity_review_list_request, opts)
|
10102
10429
|
data
|
10103
10430
|
end
|
10104
10431
|
|
10105
10432
|
# List reviews for entity watchlist screenings
|
10106
10433
|
# List all reviews for a particular entity watchlist screening. Reviews are compliance reports created by users in your organization regarding the relevance of potential hits found by Plaid.
|
10107
|
-
# @param
|
10434
|
+
# @param watchlist_screening_entity_review_list_request [WatchlistScreeningEntityReviewListRequest]
|
10108
10435
|
# @param [Hash] opts the optional parameters
|
10109
|
-
# @return [Array<(
|
10110
|
-
def watchlist_screening_entity_review_list_with_http_info(
|
10436
|
+
# @return [Array<(WatchlistScreeningEntityReviewListResponse, Integer, Hash)>] WatchlistScreeningEntityReviewListResponse data, response status code and response headers
|
10437
|
+
def watchlist_screening_entity_review_list_with_http_info(watchlist_screening_entity_review_list_request, opts = {})
|
10111
10438
|
if @api_client.config.debugging
|
10112
10439
|
@api_client.config.logger.debug 'Calling API: PlaidApi.watchlist_screening_entity_review_list ...'
|
10113
10440
|
end
|
10114
|
-
# verify the required parameter '
|
10115
|
-
if @api_client.config.client_side_validation &&
|
10116
|
-
fail ArgumentError, "Missing the required parameter '
|
10441
|
+
# verify the required parameter 'watchlist_screening_entity_review_list_request' is set
|
10442
|
+
if @api_client.config.client_side_validation && watchlist_screening_entity_review_list_request.nil?
|
10443
|
+
fail ArgumentError, "Missing the required parameter 'watchlist_screening_entity_review_list_request' when calling PlaidApi.watchlist_screening_entity_review_list"
|
10117
10444
|
end
|
10118
10445
|
# resource path
|
10119
10446
|
local_var_path = '/watchlist_screening/entity/review/list'
|
@@ -10132,10 +10459,10 @@ module Plaid
|
|
10132
10459
|
form_params = opts[:form_params] || {}
|
10133
10460
|
|
10134
10461
|
# http body (model)
|
10135
|
-
post_body = opts[:debug_body] || @api_client.object_to_http_body(
|
10462
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(watchlist_screening_entity_review_list_request)
|
10136
10463
|
|
10137
10464
|
# return_type
|
10138
|
-
return_type = opts[:debug_return_type] || '
|
10465
|
+
return_type = opts[:debug_return_type] || 'WatchlistScreeningEntityReviewListResponse'
|
10139
10466
|
|
10140
10467
|
# auth_names
|
10141
10468
|
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
@@ -10159,26 +10486,26 @@ module Plaid
|
|
10159
10486
|
|
10160
10487
|
# Update an entity screening
|
10161
10488
|
# Update an entity watchlist screening.
|
10162
|
-
# @param
|
10489
|
+
# @param watchlist_screening_entity_update_request [WatchlistScreeningEntityUpdateRequest] The entity screening was successfully updated.
|
10163
10490
|
# @param [Hash] opts the optional parameters
|
10164
|
-
# @return [
|
10165
|
-
def watchlist_screening_entity_update(
|
10166
|
-
data, _status_code, _headers = watchlist_screening_entity_update_with_http_info(
|
10491
|
+
# @return [WatchlistScreeningEntityUpdateResponse]
|
10492
|
+
def watchlist_screening_entity_update(watchlist_screening_entity_update_request, opts = {})
|
10493
|
+
data, _status_code, _headers = watchlist_screening_entity_update_with_http_info(watchlist_screening_entity_update_request, opts)
|
10167
10494
|
data
|
10168
10495
|
end
|
10169
10496
|
|
10170
10497
|
# Update an entity screening
|
10171
10498
|
# Update an entity watchlist screening.
|
10172
|
-
# @param
|
10499
|
+
# @param watchlist_screening_entity_update_request [WatchlistScreeningEntityUpdateRequest] The entity screening was successfully updated.
|
10173
10500
|
# @param [Hash] opts the optional parameters
|
10174
|
-
# @return [Array<(
|
10175
|
-
def watchlist_screening_entity_update_with_http_info(
|
10501
|
+
# @return [Array<(WatchlistScreeningEntityUpdateResponse, Integer, Hash)>] WatchlistScreeningEntityUpdateResponse data, response status code and response headers
|
10502
|
+
def watchlist_screening_entity_update_with_http_info(watchlist_screening_entity_update_request, opts = {})
|
10176
10503
|
if @api_client.config.debugging
|
10177
10504
|
@api_client.config.logger.debug 'Calling API: PlaidApi.watchlist_screening_entity_update ...'
|
10178
10505
|
end
|
10179
|
-
# verify the required parameter '
|
10180
|
-
if @api_client.config.client_side_validation &&
|
10181
|
-
fail ArgumentError, "Missing the required parameter '
|
10506
|
+
# verify the required parameter 'watchlist_screening_entity_update_request' is set
|
10507
|
+
if @api_client.config.client_side_validation && watchlist_screening_entity_update_request.nil?
|
10508
|
+
fail ArgumentError, "Missing the required parameter 'watchlist_screening_entity_update_request' when calling PlaidApi.watchlist_screening_entity_update"
|
10182
10509
|
end
|
10183
10510
|
# resource path
|
10184
10511
|
local_var_path = '/watchlist_screening/entity/update'
|
@@ -10197,10 +10524,10 @@ module Plaid
|
|
10197
10524
|
form_params = opts[:form_params] || {}
|
10198
10525
|
|
10199
10526
|
# http body (model)
|
10200
|
-
post_body = opts[:debug_body] || @api_client.object_to_http_body(
|
10527
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(watchlist_screening_entity_update_request)
|
10201
10528
|
|
10202
10529
|
# return_type
|
10203
|
-
return_type = opts[:debug_return_type] || '
|
10530
|
+
return_type = opts[:debug_return_type] || 'WatchlistScreeningEntityUpdateResponse'
|
10204
10531
|
|
10205
10532
|
# auth_names
|
10206
10533
|
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
@@ -10224,26 +10551,26 @@ module Plaid
|
|
10224
10551
|
|
10225
10552
|
# Create a watchlist screening for a person
|
10226
10553
|
# Create a new Watchlist Screening to check your customer against watchlists defined in the associated Watchlist Program. If your associated program has ongoing screening enabled, this is the profile information that will be used to monitor your customer over time.
|
10227
|
-
# @param
|
10554
|
+
# @param watchlist_screening_individual_create_request [WatchlistScreeningIndividualCreateRequest]
|
10228
10555
|
# @param [Hash] opts the optional parameters
|
10229
|
-
# @return [
|
10230
|
-
def watchlist_screening_individual_create(
|
10231
|
-
data, _status_code, _headers = watchlist_screening_individual_create_with_http_info(
|
10556
|
+
# @return [WatchlistScreeningIndividualCreateResponse]
|
10557
|
+
def watchlist_screening_individual_create(watchlist_screening_individual_create_request, opts = {})
|
10558
|
+
data, _status_code, _headers = watchlist_screening_individual_create_with_http_info(watchlist_screening_individual_create_request, opts)
|
10232
10559
|
data
|
10233
10560
|
end
|
10234
10561
|
|
10235
10562
|
# Create a watchlist screening for a person
|
10236
10563
|
# Create a new Watchlist Screening to check your customer against watchlists defined in the associated Watchlist Program. If your associated program has ongoing screening enabled, this is the profile information that will be used to monitor your customer over time.
|
10237
|
-
# @param
|
10564
|
+
# @param watchlist_screening_individual_create_request [WatchlistScreeningIndividualCreateRequest]
|
10238
10565
|
# @param [Hash] opts the optional parameters
|
10239
|
-
# @return [Array<(
|
10240
|
-
def watchlist_screening_individual_create_with_http_info(
|
10566
|
+
# @return [Array<(WatchlistScreeningIndividualCreateResponse, Integer, Hash)>] WatchlistScreeningIndividualCreateResponse data, response status code and response headers
|
10567
|
+
def watchlist_screening_individual_create_with_http_info(watchlist_screening_individual_create_request, opts = {})
|
10241
10568
|
if @api_client.config.debugging
|
10242
10569
|
@api_client.config.logger.debug 'Calling API: PlaidApi.watchlist_screening_individual_create ...'
|
10243
10570
|
end
|
10244
|
-
# verify the required parameter '
|
10245
|
-
if @api_client.config.client_side_validation &&
|
10246
|
-
fail ArgumentError, "Missing the required parameter '
|
10571
|
+
# verify the required parameter 'watchlist_screening_individual_create_request' is set
|
10572
|
+
if @api_client.config.client_side_validation && watchlist_screening_individual_create_request.nil?
|
10573
|
+
fail ArgumentError, "Missing the required parameter 'watchlist_screening_individual_create_request' when calling PlaidApi.watchlist_screening_individual_create"
|
10247
10574
|
end
|
10248
10575
|
# resource path
|
10249
10576
|
local_var_path = '/watchlist_screening/individual/create'
|
@@ -10262,10 +10589,10 @@ module Plaid
|
|
10262
10589
|
form_params = opts[:form_params] || {}
|
10263
10590
|
|
10264
10591
|
# http body (model)
|
10265
|
-
post_body = opts[:debug_body] || @api_client.object_to_http_body(
|
10592
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(watchlist_screening_individual_create_request)
|
10266
10593
|
|
10267
10594
|
# return_type
|
10268
|
-
return_type = opts[:debug_return_type] || '
|
10595
|
+
return_type = opts[:debug_return_type] || 'WatchlistScreeningIndividualCreateResponse'
|
10269
10596
|
|
10270
10597
|
# auth_names
|
10271
10598
|
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
@@ -10289,26 +10616,26 @@ module Plaid
|
|
10289
10616
|
|
10290
10617
|
# Retrieve an individual watchlist screening
|
10291
10618
|
# Retrieve a previously created individual watchlist screening
|
10292
|
-
# @param
|
10619
|
+
# @param watchlist_screening_individual_get_request [WatchlistScreeningIndividualGetRequest]
|
10293
10620
|
# @param [Hash] opts the optional parameters
|
10294
|
-
# @return [
|
10295
|
-
def watchlist_screening_individual_get(
|
10296
|
-
data, _status_code, _headers = watchlist_screening_individual_get_with_http_info(
|
10621
|
+
# @return [WatchlistScreeningIndividualGetResponse]
|
10622
|
+
def watchlist_screening_individual_get(watchlist_screening_individual_get_request, opts = {})
|
10623
|
+
data, _status_code, _headers = watchlist_screening_individual_get_with_http_info(watchlist_screening_individual_get_request, opts)
|
10297
10624
|
data
|
10298
10625
|
end
|
10299
10626
|
|
10300
10627
|
# Retrieve an individual watchlist screening
|
10301
10628
|
# Retrieve a previously created individual watchlist screening
|
10302
|
-
# @param
|
10629
|
+
# @param watchlist_screening_individual_get_request [WatchlistScreeningIndividualGetRequest]
|
10303
10630
|
# @param [Hash] opts the optional parameters
|
10304
|
-
# @return [Array<(
|
10305
|
-
def watchlist_screening_individual_get_with_http_info(
|
10631
|
+
# @return [Array<(WatchlistScreeningIndividualGetResponse, Integer, Hash)>] WatchlistScreeningIndividualGetResponse data, response status code and response headers
|
10632
|
+
def watchlist_screening_individual_get_with_http_info(watchlist_screening_individual_get_request, opts = {})
|
10306
10633
|
if @api_client.config.debugging
|
10307
10634
|
@api_client.config.logger.debug 'Calling API: PlaidApi.watchlist_screening_individual_get ...'
|
10308
10635
|
end
|
10309
|
-
# verify the required parameter '
|
10310
|
-
if @api_client.config.client_side_validation &&
|
10311
|
-
fail ArgumentError, "Missing the required parameter '
|
10636
|
+
# verify the required parameter 'watchlist_screening_individual_get_request' is set
|
10637
|
+
if @api_client.config.client_side_validation && watchlist_screening_individual_get_request.nil?
|
10638
|
+
fail ArgumentError, "Missing the required parameter 'watchlist_screening_individual_get_request' when calling PlaidApi.watchlist_screening_individual_get"
|
10312
10639
|
end
|
10313
10640
|
# resource path
|
10314
10641
|
local_var_path = '/watchlist_screening/individual/get'
|
@@ -10327,10 +10654,10 @@ module Plaid
|
|
10327
10654
|
form_params = opts[:form_params] || {}
|
10328
10655
|
|
10329
10656
|
# http body (model)
|
10330
|
-
post_body = opts[:debug_body] || @api_client.object_to_http_body(
|
10657
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(watchlist_screening_individual_get_request)
|
10331
10658
|
|
10332
10659
|
# return_type
|
10333
|
-
return_type = opts[:debug_return_type] || '
|
10660
|
+
return_type = opts[:debug_return_type] || 'WatchlistScreeningIndividualGetResponse'
|
10334
10661
|
|
10335
10662
|
# auth_names
|
10336
10663
|
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
@@ -10354,26 +10681,26 @@ module Plaid
|
|
10354
10681
|
|
10355
10682
|
# List history for individual watchlist screenings
|
10356
10683
|
# List all changes to the individual watchlist screening in reverse-chronological order. If the watchlist screening has not been edited, no history will be returned.
|
10357
|
-
# @param
|
10684
|
+
# @param watchlist_screening_individual_history_list_request [WatchlistScreeningIndividualHistoryListRequest]
|
10358
10685
|
# @param [Hash] opts the optional parameters
|
10359
|
-
# @return [
|
10360
|
-
def watchlist_screening_individual_history_list(
|
10361
|
-
data, _status_code, _headers = watchlist_screening_individual_history_list_with_http_info(
|
10686
|
+
# @return [WatchlistScreeningIndividualHistoryListResponse]
|
10687
|
+
def watchlist_screening_individual_history_list(watchlist_screening_individual_history_list_request, opts = {})
|
10688
|
+
data, _status_code, _headers = watchlist_screening_individual_history_list_with_http_info(watchlist_screening_individual_history_list_request, opts)
|
10362
10689
|
data
|
10363
10690
|
end
|
10364
10691
|
|
10365
10692
|
# List history for individual watchlist screenings
|
10366
10693
|
# List all changes to the individual watchlist screening in reverse-chronological order. If the watchlist screening has not been edited, no history will be returned.
|
10367
|
-
# @param
|
10694
|
+
# @param watchlist_screening_individual_history_list_request [WatchlistScreeningIndividualHistoryListRequest]
|
10368
10695
|
# @param [Hash] opts the optional parameters
|
10369
|
-
# @return [Array<(
|
10370
|
-
def watchlist_screening_individual_history_list_with_http_info(
|
10696
|
+
# @return [Array<(WatchlistScreeningIndividualHistoryListResponse, Integer, Hash)>] WatchlistScreeningIndividualHistoryListResponse data, response status code and response headers
|
10697
|
+
def watchlist_screening_individual_history_list_with_http_info(watchlist_screening_individual_history_list_request, opts = {})
|
10371
10698
|
if @api_client.config.debugging
|
10372
10699
|
@api_client.config.logger.debug 'Calling API: PlaidApi.watchlist_screening_individual_history_list ...'
|
10373
10700
|
end
|
10374
|
-
# verify the required parameter '
|
10375
|
-
if @api_client.config.client_side_validation &&
|
10376
|
-
fail ArgumentError, "Missing the required parameter '
|
10701
|
+
# verify the required parameter 'watchlist_screening_individual_history_list_request' is set
|
10702
|
+
if @api_client.config.client_side_validation && watchlist_screening_individual_history_list_request.nil?
|
10703
|
+
fail ArgumentError, "Missing the required parameter 'watchlist_screening_individual_history_list_request' when calling PlaidApi.watchlist_screening_individual_history_list"
|
10377
10704
|
end
|
10378
10705
|
# resource path
|
10379
10706
|
local_var_path = '/watchlist_screening/individual/history/list'
|
@@ -10392,10 +10719,10 @@ module Plaid
|
|
10392
10719
|
form_params = opts[:form_params] || {}
|
10393
10720
|
|
10394
10721
|
# http body (model)
|
10395
|
-
post_body = opts[:debug_body] || @api_client.object_to_http_body(
|
10722
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(watchlist_screening_individual_history_list_request)
|
10396
10723
|
|
10397
10724
|
# return_type
|
10398
|
-
return_type = opts[:debug_return_type] || '
|
10725
|
+
return_type = opts[:debug_return_type] || 'WatchlistScreeningIndividualHistoryListResponse'
|
10399
10726
|
|
10400
10727
|
# auth_names
|
10401
10728
|
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
@@ -10419,26 +10746,26 @@ module Plaid
|
|
10419
10746
|
|
10420
10747
|
# List hits for individual watchlist screening
|
10421
10748
|
# List all hits found by Plaid for a particular individual watchlist screening.
|
10422
|
-
# @param
|
10749
|
+
# @param watchlist_screening_individual_hit_list_request [WatchlistScreeningIndividualHitListRequest]
|
10423
10750
|
# @param [Hash] opts the optional parameters
|
10424
|
-
# @return [
|
10425
|
-
def watchlist_screening_individual_hit_list(
|
10426
|
-
data, _status_code, _headers = watchlist_screening_individual_hit_list_with_http_info(
|
10751
|
+
# @return [WatchlistScreeningIndividualHitListResponse]
|
10752
|
+
def watchlist_screening_individual_hit_list(watchlist_screening_individual_hit_list_request, opts = {})
|
10753
|
+
data, _status_code, _headers = watchlist_screening_individual_hit_list_with_http_info(watchlist_screening_individual_hit_list_request, opts)
|
10427
10754
|
data
|
10428
10755
|
end
|
10429
10756
|
|
10430
10757
|
# List hits for individual watchlist screening
|
10431
10758
|
# List all hits found by Plaid for a particular individual watchlist screening.
|
10432
|
-
# @param
|
10759
|
+
# @param watchlist_screening_individual_hit_list_request [WatchlistScreeningIndividualHitListRequest]
|
10433
10760
|
# @param [Hash] opts the optional parameters
|
10434
|
-
# @return [Array<(
|
10435
|
-
def watchlist_screening_individual_hit_list_with_http_info(
|
10761
|
+
# @return [Array<(WatchlistScreeningIndividualHitListResponse, Integer, Hash)>] WatchlistScreeningIndividualHitListResponse data, response status code and response headers
|
10762
|
+
def watchlist_screening_individual_hit_list_with_http_info(watchlist_screening_individual_hit_list_request, opts = {})
|
10436
10763
|
if @api_client.config.debugging
|
10437
10764
|
@api_client.config.logger.debug 'Calling API: PlaidApi.watchlist_screening_individual_hit_list ...'
|
10438
10765
|
end
|
10439
|
-
# verify the required parameter '
|
10440
|
-
if @api_client.config.client_side_validation &&
|
10441
|
-
fail ArgumentError, "Missing the required parameter '
|
10766
|
+
# verify the required parameter 'watchlist_screening_individual_hit_list_request' is set
|
10767
|
+
if @api_client.config.client_side_validation && watchlist_screening_individual_hit_list_request.nil?
|
10768
|
+
fail ArgumentError, "Missing the required parameter 'watchlist_screening_individual_hit_list_request' when calling PlaidApi.watchlist_screening_individual_hit_list"
|
10442
10769
|
end
|
10443
10770
|
# resource path
|
10444
10771
|
local_var_path = '/watchlist_screening/individual/hit/list'
|
@@ -10457,10 +10784,10 @@ module Plaid
|
|
10457
10784
|
form_params = opts[:form_params] || {}
|
10458
10785
|
|
10459
10786
|
# http body (model)
|
10460
|
-
post_body = opts[:debug_body] || @api_client.object_to_http_body(
|
10787
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(watchlist_screening_individual_hit_list_request)
|
10461
10788
|
|
10462
10789
|
# return_type
|
10463
|
-
return_type = opts[:debug_return_type] || '
|
10790
|
+
return_type = opts[:debug_return_type] || 'WatchlistScreeningIndividualHitListResponse'
|
10464
10791
|
|
10465
10792
|
# auth_names
|
10466
10793
|
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
@@ -10484,26 +10811,26 @@ module Plaid
|
|
10484
10811
|
|
10485
10812
|
# List Individual Watchlist Screenings
|
10486
10813
|
# List previously created watchlist screenings for individuals
|
10487
|
-
# @param
|
10814
|
+
# @param watchlist_screening_individual_list_request [WatchlistScreeningIndividualListRequest]
|
10488
10815
|
# @param [Hash] opts the optional parameters
|
10489
|
-
# @return [
|
10490
|
-
def watchlist_screening_individual_list(
|
10491
|
-
data, _status_code, _headers = watchlist_screening_individual_list_with_http_info(
|
10816
|
+
# @return [WatchlistScreeningIndividualListResponse]
|
10817
|
+
def watchlist_screening_individual_list(watchlist_screening_individual_list_request, opts = {})
|
10818
|
+
data, _status_code, _headers = watchlist_screening_individual_list_with_http_info(watchlist_screening_individual_list_request, opts)
|
10492
10819
|
data
|
10493
10820
|
end
|
10494
10821
|
|
10495
10822
|
# List Individual Watchlist Screenings
|
10496
10823
|
# List previously created watchlist screenings for individuals
|
10497
|
-
# @param
|
10824
|
+
# @param watchlist_screening_individual_list_request [WatchlistScreeningIndividualListRequest]
|
10498
10825
|
# @param [Hash] opts the optional parameters
|
10499
|
-
# @return [Array<(
|
10500
|
-
def watchlist_screening_individual_list_with_http_info(
|
10826
|
+
# @return [Array<(WatchlistScreeningIndividualListResponse, Integer, Hash)>] WatchlistScreeningIndividualListResponse data, response status code and response headers
|
10827
|
+
def watchlist_screening_individual_list_with_http_info(watchlist_screening_individual_list_request, opts = {})
|
10501
10828
|
if @api_client.config.debugging
|
10502
10829
|
@api_client.config.logger.debug 'Calling API: PlaidApi.watchlist_screening_individual_list ...'
|
10503
10830
|
end
|
10504
|
-
# verify the required parameter '
|
10505
|
-
if @api_client.config.client_side_validation &&
|
10506
|
-
fail ArgumentError, "Missing the required parameter '
|
10831
|
+
# verify the required parameter 'watchlist_screening_individual_list_request' is set
|
10832
|
+
if @api_client.config.client_side_validation && watchlist_screening_individual_list_request.nil?
|
10833
|
+
fail ArgumentError, "Missing the required parameter 'watchlist_screening_individual_list_request' when calling PlaidApi.watchlist_screening_individual_list"
|
10507
10834
|
end
|
10508
10835
|
# resource path
|
10509
10836
|
local_var_path = '/watchlist_screening/individual/list'
|
@@ -10522,10 +10849,10 @@ module Plaid
|
|
10522
10849
|
form_params = opts[:form_params] || {}
|
10523
10850
|
|
10524
10851
|
# http body (model)
|
10525
|
-
post_body = opts[:debug_body] || @api_client.object_to_http_body(
|
10852
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(watchlist_screening_individual_list_request)
|
10526
10853
|
|
10527
10854
|
# return_type
|
10528
|
-
return_type = opts[:debug_return_type] || '
|
10855
|
+
return_type = opts[:debug_return_type] || 'WatchlistScreeningIndividualListResponse'
|
10529
10856
|
|
10530
10857
|
# auth_names
|
10531
10858
|
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
@@ -10549,26 +10876,26 @@ module Plaid
|
|
10549
10876
|
|
10550
10877
|
# Get individual watchlist screening program
|
10551
10878
|
# Get an individual watchlist screening program
|
10552
|
-
# @param
|
10879
|
+
# @param watchlist_screening_individual_program_get_request [WatchlistScreeningIndividualProgramGetRequest]
|
10553
10880
|
# @param [Hash] opts the optional parameters
|
10554
|
-
# @return [
|
10555
|
-
def watchlist_screening_individual_program_get(
|
10556
|
-
data, _status_code, _headers = watchlist_screening_individual_program_get_with_http_info(
|
10881
|
+
# @return [WatchlistScreeningIndividualProgramGetResponse]
|
10882
|
+
def watchlist_screening_individual_program_get(watchlist_screening_individual_program_get_request, opts = {})
|
10883
|
+
data, _status_code, _headers = watchlist_screening_individual_program_get_with_http_info(watchlist_screening_individual_program_get_request, opts)
|
10557
10884
|
data
|
10558
10885
|
end
|
10559
10886
|
|
10560
10887
|
# Get individual watchlist screening program
|
10561
10888
|
# Get an individual watchlist screening program
|
10562
|
-
# @param
|
10889
|
+
# @param watchlist_screening_individual_program_get_request [WatchlistScreeningIndividualProgramGetRequest]
|
10563
10890
|
# @param [Hash] opts the optional parameters
|
10564
|
-
# @return [Array<(
|
10565
|
-
def watchlist_screening_individual_program_get_with_http_info(
|
10891
|
+
# @return [Array<(WatchlistScreeningIndividualProgramGetResponse, Integer, Hash)>] WatchlistScreeningIndividualProgramGetResponse data, response status code and response headers
|
10892
|
+
def watchlist_screening_individual_program_get_with_http_info(watchlist_screening_individual_program_get_request, opts = {})
|
10566
10893
|
if @api_client.config.debugging
|
10567
10894
|
@api_client.config.logger.debug 'Calling API: PlaidApi.watchlist_screening_individual_program_get ...'
|
10568
10895
|
end
|
10569
|
-
# verify the required parameter '
|
10570
|
-
if @api_client.config.client_side_validation &&
|
10571
|
-
fail ArgumentError, "Missing the required parameter '
|
10896
|
+
# verify the required parameter 'watchlist_screening_individual_program_get_request' is set
|
10897
|
+
if @api_client.config.client_side_validation && watchlist_screening_individual_program_get_request.nil?
|
10898
|
+
fail ArgumentError, "Missing the required parameter 'watchlist_screening_individual_program_get_request' when calling PlaidApi.watchlist_screening_individual_program_get"
|
10572
10899
|
end
|
10573
10900
|
# resource path
|
10574
10901
|
local_var_path = '/watchlist_screening/individual/program/get'
|
@@ -10587,10 +10914,10 @@ module Plaid
|
|
10587
10914
|
form_params = opts[:form_params] || {}
|
10588
10915
|
|
10589
10916
|
# http body (model)
|
10590
|
-
post_body = opts[:debug_body] || @api_client.object_to_http_body(
|
10917
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(watchlist_screening_individual_program_get_request)
|
10591
10918
|
|
10592
10919
|
# return_type
|
10593
|
-
return_type = opts[:debug_return_type] || '
|
10920
|
+
return_type = opts[:debug_return_type] || 'WatchlistScreeningIndividualProgramGetResponse'
|
10594
10921
|
|
10595
10922
|
# auth_names
|
10596
10923
|
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
@@ -10614,26 +10941,26 @@ module Plaid
|
|
10614
10941
|
|
10615
10942
|
# List individual watchlist screening programs
|
10616
10943
|
# List all individual watchlist screening programs
|
10617
|
-
# @param
|
10944
|
+
# @param watchlist_screening_individual_program_list_request [WatchlistScreeningIndividualProgramListRequest]
|
10618
10945
|
# @param [Hash] opts the optional parameters
|
10619
|
-
# @return [
|
10620
|
-
def watchlist_screening_individual_program_list(
|
10621
|
-
data, _status_code, _headers = watchlist_screening_individual_program_list_with_http_info(
|
10946
|
+
# @return [WatchlistScreeningIndividualProgramListResponse]
|
10947
|
+
def watchlist_screening_individual_program_list(watchlist_screening_individual_program_list_request, opts = {})
|
10948
|
+
data, _status_code, _headers = watchlist_screening_individual_program_list_with_http_info(watchlist_screening_individual_program_list_request, opts)
|
10622
10949
|
data
|
10623
10950
|
end
|
10624
10951
|
|
10625
10952
|
# List individual watchlist screening programs
|
10626
10953
|
# List all individual watchlist screening programs
|
10627
|
-
# @param
|
10954
|
+
# @param watchlist_screening_individual_program_list_request [WatchlistScreeningIndividualProgramListRequest]
|
10628
10955
|
# @param [Hash] opts the optional parameters
|
10629
|
-
# @return [Array<(
|
10630
|
-
def watchlist_screening_individual_program_list_with_http_info(
|
10956
|
+
# @return [Array<(WatchlistScreeningIndividualProgramListResponse, Integer, Hash)>] WatchlistScreeningIndividualProgramListResponse data, response status code and response headers
|
10957
|
+
def watchlist_screening_individual_program_list_with_http_info(watchlist_screening_individual_program_list_request, opts = {})
|
10631
10958
|
if @api_client.config.debugging
|
10632
10959
|
@api_client.config.logger.debug 'Calling API: PlaidApi.watchlist_screening_individual_program_list ...'
|
10633
10960
|
end
|
10634
|
-
# verify the required parameter '
|
10635
|
-
if @api_client.config.client_side_validation &&
|
10636
|
-
fail ArgumentError, "Missing the required parameter '
|
10961
|
+
# verify the required parameter 'watchlist_screening_individual_program_list_request' is set
|
10962
|
+
if @api_client.config.client_side_validation && watchlist_screening_individual_program_list_request.nil?
|
10963
|
+
fail ArgumentError, "Missing the required parameter 'watchlist_screening_individual_program_list_request' when calling PlaidApi.watchlist_screening_individual_program_list"
|
10637
10964
|
end
|
10638
10965
|
# resource path
|
10639
10966
|
local_var_path = '/watchlist_screening/individual/program/list'
|
@@ -10652,10 +10979,10 @@ module Plaid
|
|
10652
10979
|
form_params = opts[:form_params] || {}
|
10653
10980
|
|
10654
10981
|
# http body (model)
|
10655
|
-
post_body = opts[:debug_body] || @api_client.object_to_http_body(
|
10982
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(watchlist_screening_individual_program_list_request)
|
10656
10983
|
|
10657
10984
|
# return_type
|
10658
|
-
return_type = opts[:debug_return_type] || '
|
10985
|
+
return_type = opts[:debug_return_type] || 'WatchlistScreeningIndividualProgramListResponse'
|
10659
10986
|
|
10660
10987
|
# auth_names
|
10661
10988
|
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
@@ -10679,26 +11006,26 @@ module Plaid
|
|
10679
11006
|
|
10680
11007
|
# Create a review for an individual watchlist screening
|
10681
11008
|
# Create a review for the individual watchlist screening. Reviews are compliance reports created by users in your organization regarding the relevance of potential hits found by Plaid.
|
10682
|
-
# @param
|
11009
|
+
# @param watchlist_screening_individual_review_create_request [WatchlistScreeningIndividualReviewCreateRequest]
|
10683
11010
|
# @param [Hash] opts the optional parameters
|
10684
|
-
# @return [
|
10685
|
-
def watchlist_screening_individual_review_create(
|
10686
|
-
data, _status_code, _headers = watchlist_screening_individual_review_create_with_http_info(
|
11011
|
+
# @return [WatchlistScreeningIndividualReviewCreateResponse]
|
11012
|
+
def watchlist_screening_individual_review_create(watchlist_screening_individual_review_create_request, opts = {})
|
11013
|
+
data, _status_code, _headers = watchlist_screening_individual_review_create_with_http_info(watchlist_screening_individual_review_create_request, opts)
|
10687
11014
|
data
|
10688
11015
|
end
|
10689
11016
|
|
10690
11017
|
# Create a review for an individual watchlist screening
|
10691
11018
|
# Create a review for the individual watchlist screening. Reviews are compliance reports created by users in your organization regarding the relevance of potential hits found by Plaid.
|
10692
|
-
# @param
|
11019
|
+
# @param watchlist_screening_individual_review_create_request [WatchlistScreeningIndividualReviewCreateRequest]
|
10693
11020
|
# @param [Hash] opts the optional parameters
|
10694
|
-
# @return [Array<(
|
10695
|
-
def watchlist_screening_individual_review_create_with_http_info(
|
11021
|
+
# @return [Array<(WatchlistScreeningIndividualReviewCreateResponse, Integer, Hash)>] WatchlistScreeningIndividualReviewCreateResponse data, response status code and response headers
|
11022
|
+
def watchlist_screening_individual_review_create_with_http_info(watchlist_screening_individual_review_create_request, opts = {})
|
10696
11023
|
if @api_client.config.debugging
|
10697
11024
|
@api_client.config.logger.debug 'Calling API: PlaidApi.watchlist_screening_individual_review_create ...'
|
10698
11025
|
end
|
10699
|
-
# verify the required parameter '
|
10700
|
-
if @api_client.config.client_side_validation &&
|
10701
|
-
fail ArgumentError, "Missing the required parameter '
|
11026
|
+
# verify the required parameter 'watchlist_screening_individual_review_create_request' is set
|
11027
|
+
if @api_client.config.client_side_validation && watchlist_screening_individual_review_create_request.nil?
|
11028
|
+
fail ArgumentError, "Missing the required parameter 'watchlist_screening_individual_review_create_request' when calling PlaidApi.watchlist_screening_individual_review_create"
|
10702
11029
|
end
|
10703
11030
|
# resource path
|
10704
11031
|
local_var_path = '/watchlist_screening/individual/review/create'
|
@@ -10717,10 +11044,10 @@ module Plaid
|
|
10717
11044
|
form_params = opts[:form_params] || {}
|
10718
11045
|
|
10719
11046
|
# http body (model)
|
10720
|
-
post_body = opts[:debug_body] || @api_client.object_to_http_body(
|
11047
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(watchlist_screening_individual_review_create_request)
|
10721
11048
|
|
10722
11049
|
# return_type
|
10723
|
-
return_type = opts[:debug_return_type] || '
|
11050
|
+
return_type = opts[:debug_return_type] || 'WatchlistScreeningIndividualReviewCreateResponse'
|
10724
11051
|
|
10725
11052
|
# auth_names
|
10726
11053
|
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
@@ -10744,26 +11071,26 @@ module Plaid
|
|
10744
11071
|
|
10745
11072
|
# List reviews for individual watchlist screenings
|
10746
11073
|
# List all reviews for the individual watchlist screening.
|
10747
|
-
# @param
|
11074
|
+
# @param watchlist_screening_individual_review_list_request [WatchlistScreeningIndividualReviewListRequest]
|
10748
11075
|
# @param [Hash] opts the optional parameters
|
10749
|
-
# @return [
|
10750
|
-
def
|
10751
|
-
data, _status_code, _headers =
|
11076
|
+
# @return [WatchlistScreeningIndividualReviewListResponse]
|
11077
|
+
def watchlist_screening_individual_review_list(watchlist_screening_individual_review_list_request, opts = {})
|
11078
|
+
data, _status_code, _headers = watchlist_screening_individual_review_list_with_http_info(watchlist_screening_individual_review_list_request, opts)
|
10752
11079
|
data
|
10753
11080
|
end
|
10754
11081
|
|
10755
11082
|
# List reviews for individual watchlist screenings
|
10756
11083
|
# List all reviews for the individual watchlist screening.
|
10757
|
-
# @param
|
11084
|
+
# @param watchlist_screening_individual_review_list_request [WatchlistScreeningIndividualReviewListRequest]
|
10758
11085
|
# @param [Hash] opts the optional parameters
|
10759
|
-
# @return [Array<(
|
10760
|
-
def
|
11086
|
+
# @return [Array<(WatchlistScreeningIndividualReviewListResponse, Integer, Hash)>] WatchlistScreeningIndividualReviewListResponse data, response status code and response headers
|
11087
|
+
def watchlist_screening_individual_review_list_with_http_info(watchlist_screening_individual_review_list_request, opts = {})
|
10761
11088
|
if @api_client.config.debugging
|
10762
|
-
@api_client.config.logger.debug 'Calling API: PlaidApi.
|
11089
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.watchlist_screening_individual_review_list ...'
|
10763
11090
|
end
|
10764
|
-
# verify the required parameter '
|
10765
|
-
if @api_client.config.client_side_validation &&
|
10766
|
-
fail ArgumentError, "Missing the required parameter '
|
11091
|
+
# verify the required parameter 'watchlist_screening_individual_review_list_request' is set
|
11092
|
+
if @api_client.config.client_side_validation && watchlist_screening_individual_review_list_request.nil?
|
11093
|
+
fail ArgumentError, "Missing the required parameter 'watchlist_screening_individual_review_list_request' when calling PlaidApi.watchlist_screening_individual_review_list"
|
10767
11094
|
end
|
10768
11095
|
# resource path
|
10769
11096
|
local_var_path = '/watchlist_screening/individual/review/list'
|
@@ -10782,16 +11109,16 @@ module Plaid
|
|
10782
11109
|
form_params = opts[:form_params] || {}
|
10783
11110
|
|
10784
11111
|
# http body (model)
|
10785
|
-
post_body = opts[:debug_body] || @api_client.object_to_http_body(
|
11112
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(watchlist_screening_individual_review_list_request)
|
10786
11113
|
|
10787
11114
|
# return_type
|
10788
|
-
return_type = opts[:debug_return_type] || '
|
11115
|
+
return_type = opts[:debug_return_type] || 'WatchlistScreeningIndividualReviewListResponse'
|
10789
11116
|
|
10790
11117
|
# auth_names
|
10791
11118
|
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
10792
11119
|
|
10793
11120
|
new_options = opts.merge(
|
10794
|
-
:operation => :"PlaidApi.
|
11121
|
+
:operation => :"PlaidApi.watchlist_screening_individual_review_list",
|
10795
11122
|
:header_params => header_params,
|
10796
11123
|
:query_params => query_params,
|
10797
11124
|
:form_params => form_params,
|
@@ -10802,33 +11129,33 @@ module Plaid
|
|
10802
11129
|
|
10803
11130
|
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
10804
11131
|
if @api_client.config.debugging
|
10805
|
-
@api_client.config.logger.debug "API called: PlaidApi#
|
11132
|
+
@api_client.config.logger.debug "API called: PlaidApi#watchlist_screening_individual_review_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
10806
11133
|
end
|
10807
11134
|
return data, status_code, headers
|
10808
11135
|
end
|
10809
11136
|
|
10810
11137
|
# Update individual watchlist screening
|
10811
11138
|
# Update a specific individual watchlist screening. This endpoint can be used to add additional customer information, correct outdated information, add a reference id, assign the individual to a reviewer, and update which program it is associated with. Please note that you may not update `search_terms` and `status` at the same time since editing `search_terms` may trigger an automatic `status` change.
|
10812
|
-
# @param
|
11139
|
+
# @param watchlist_screening_individual_update_request [WatchlistScreeningIndividualUpdateRequest]
|
10813
11140
|
# @param [Hash] opts the optional parameters
|
10814
|
-
# @return [
|
10815
|
-
def watchlist_screening_individual_update(
|
10816
|
-
data, _status_code, _headers = watchlist_screening_individual_update_with_http_info(
|
11141
|
+
# @return [WatchlistScreeningIndividualUpdateResponse]
|
11142
|
+
def watchlist_screening_individual_update(watchlist_screening_individual_update_request, opts = {})
|
11143
|
+
data, _status_code, _headers = watchlist_screening_individual_update_with_http_info(watchlist_screening_individual_update_request, opts)
|
10817
11144
|
data
|
10818
11145
|
end
|
10819
11146
|
|
10820
11147
|
# Update individual watchlist screening
|
10821
11148
|
# Update a specific individual watchlist screening. This endpoint can be used to add additional customer information, correct outdated information, add a reference id, assign the individual to a reviewer, and update which program it is associated with. Please note that you may not update `search_terms` and `status` at the same time since editing `search_terms` may trigger an automatic `status` change.
|
10822
|
-
# @param
|
11149
|
+
# @param watchlist_screening_individual_update_request [WatchlistScreeningIndividualUpdateRequest]
|
10823
11150
|
# @param [Hash] opts the optional parameters
|
10824
|
-
# @return [Array<(
|
10825
|
-
def watchlist_screening_individual_update_with_http_info(
|
11151
|
+
# @return [Array<(WatchlistScreeningIndividualUpdateResponse, Integer, Hash)>] WatchlistScreeningIndividualUpdateResponse data, response status code and response headers
|
11152
|
+
def watchlist_screening_individual_update_with_http_info(watchlist_screening_individual_update_request, opts = {})
|
10826
11153
|
if @api_client.config.debugging
|
10827
11154
|
@api_client.config.logger.debug 'Calling API: PlaidApi.watchlist_screening_individual_update ...'
|
10828
11155
|
end
|
10829
|
-
# verify the required parameter '
|
10830
|
-
if @api_client.config.client_side_validation &&
|
10831
|
-
fail ArgumentError, "Missing the required parameter '
|
11156
|
+
# verify the required parameter 'watchlist_screening_individual_update_request' is set
|
11157
|
+
if @api_client.config.client_side_validation && watchlist_screening_individual_update_request.nil?
|
11158
|
+
fail ArgumentError, "Missing the required parameter 'watchlist_screening_individual_update_request' when calling PlaidApi.watchlist_screening_individual_update"
|
10832
11159
|
end
|
10833
11160
|
# resource path
|
10834
11161
|
local_var_path = '/watchlist_screening/individual/update'
|
@@ -10847,10 +11174,10 @@ module Plaid
|
|
10847
11174
|
form_params = opts[:form_params] || {}
|
10848
11175
|
|
10849
11176
|
# http body (model)
|
10850
|
-
post_body = opts[:debug_body] || @api_client.object_to_http_body(
|
11177
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(watchlist_screening_individual_update_request)
|
10851
11178
|
|
10852
11179
|
# return_type
|
10853
|
-
return_type = opts[:debug_return_type] || '
|
11180
|
+
return_type = opts[:debug_return_type] || 'WatchlistScreeningIndividualUpdateResponse'
|
10854
11181
|
|
10855
11182
|
# auth_names
|
10856
11183
|
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|