wire4_client 0.0.1.pre.SNAPSHOT → 1.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +96 -51
- data/docs/Account.md +11 -11
- data/docs/AccountDetail.md +13 -0
- data/docs/AccountReassigned.md +21 -0
- data/docs/AccountRequest.md +3 -3
- data/docs/AccountResponse.md +13 -11
- data/docs/AccountSpid.md +11 -11
- data/docs/AddressCompany.md +17 -0
- data/docs/AmountRequest.md +5 -3
- data/docs/AuthorizationTransactionGroup.md +9 -0
- data/docs/AuthorizedBeneficiariesResponse.md +10 -0
- data/docs/AuthorizedUsers.md +13 -0
- data/docs/AutorizacinDeDepsitosApi.md +113 -0
- data/docs/Balance.md +3 -3
- data/docs/BalanceListResponse.md +1 -1
- data/docs/BeneficiariesQueryRegisterStatus.md +13 -0
- data/docs/BeneficiariesResponse.md +1 -1
- data/docs/BillingTransaction.md +1 -1
- data/docs/CepResponse.md +20 -20
- data/docs/CepSearchBanxico.md +8 -8
- data/docs/CertificateRequest.md +11 -0
- data/docs/CodiCodeQrResponseDTO.md +17 -0
- data/docs/CodiCodeRequestDTO.md +14 -0
- data/docs/CodiOperationResponseDTO.md +14 -0
- data/docs/CodiOperationsFiltersRequestDTO.md +15 -0
- data/docs/CompanyRegistered.md +13 -0
- data/docs/CompanyRequested.md +11 -0
- data/docs/Compay.md +11 -0
- data/docs/ComprobanteElectrnicoDePagoCEPApi.md +6 -8
- data/docs/ConfigurationsLimits.md +9 -0
- data/docs/ContactRequest.md +5 -5
- data/docs/ContactoApi.md +6 -8
- data/docs/ContractDetailRequest.md +11 -0
- data/docs/ContractDetailResponse.md +9 -0
- data/docs/ContractsDetailsApi.md +222 -0
- data/docs/CuentasDeBeneficiariosSPEIApi.md +190 -81
- data/docs/CuentasDeBeneficiariosSPIDApi.md +80 -13
- data/docs/Deposit.md +21 -20
- data/docs/DepositAuthorizationRequest.md +10 -0
- data/docs/Depositant.md +5 -5
- data/docs/DepositantesApi.md +18 -22
- data/docs/DepositantsRegister.md +4 -4
- data/docs/DepositantsResponse.md +1 -1
- data/docs/DepositsAuthorizationResponse.md +10 -0
- data/docs/DetailedErrorResponse.md +10 -0
- data/docs/EmpresasCoDiApi.md +107 -0
- data/docs/FacturasApi.md +12 -16
- data/docs/GetDepositants.md +1 -1
- data/docs/InstitucionesApi.md +15 -12
- data/docs/Institution.md +4 -4
- data/docs/InstitutionsList.md +1 -1
- data/docs/Item.md +10 -0
- data/docs/LmitesDeMontosApi.md +112 -0
- data/docs/MessageAccountBeneficiary.md +3 -3
- data/docs/MessageCEP.md +21 -21
- data/docs/MessageCodiAction.md +19 -0
- data/docs/MessageConfigurationsLimits.md +8 -0
- data/docs/MessageDepositAuthorizationRequest.md +27 -0
- data/docs/MessageDepositReceived.md +21 -20
- data/docs/MessageInstitution.md +4 -4
- data/docs/MessagePayment.md +20 -18
- data/docs/MessagePaymentStatePending.md +23 -0
- data/docs/MessageRequestChanged.md +9 -0
- data/docs/MessageSalesPoint.md +10 -0
- data/docs/MessageSubscription.md +6 -5
- data/docs/MessageUserAuthorized.md +14 -0
- data/docs/MessageWebHook.md +9 -9
- data/docs/OperacionesCoDiApi.md +68 -0
- data/docs/Operations.md +17 -0
- data/docs/PagerResponseDto.md +13 -0
- data/docs/Payment.md +19 -17
- data/docs/PaymentCODI.md +13 -0
- data/docs/PaymentRequestCodiResponseDTO.md +18 -0
- data/docs/PaymentsRequestId.md +13 -0
- data/docs/PeticionesDePagoPorCoDiApi.md +116 -0
- data/docs/PreEnrollmentData.md +2 -2
- data/docs/PreEnrollmentResponse.md +2 -2
- data/docs/PreMonexAuthorization.md +11 -0
- data/docs/PuntosDeVentaCoDiApi.md +113 -0
- data/docs/Relationship.md +2 -2
- data/docs/RelationshipsResponse.md +1 -1
- data/docs/SaldoApi.md +9 -11
- data/docs/SalesPoint.md +10 -0
- data/docs/SalesPointFound.md +14 -0
- data/docs/SalesPointRequest.md +11 -0
- data/docs/SalesPointRespose.md +11 -0
- data/docs/ServiceBanking.md +9 -0
- data/docs/SpidBeneficiariesResponse.md +8 -0
- data/docs/SpidBeneficiaryResponse.md +19 -0
- data/docs/SpidClassificationDTO.md +2 -2
- data/docs/SubscriptionChangeStatusRequest.md +8 -0
- data/docs/SuscripcionesApi.md +143 -42
- data/docs/TokenRequiredResponse.md +2 -2
- data/docs/TransactionErrorCode.md +10 -0
- data/docs/TransactionOutgoing.md +2 -1
- data/docs/TransactionOutgoingSpid.md +10 -10
- data/docs/TransactionsOutgoingRegister.md +3 -3
- data/docs/TransferenciasSPEIApi.md +150 -46
- data/docs/TransferenciasSPIDApi.md +24 -28
- data/docs/UpdateConfigurationsRequestDTO.md +8 -0
- data/docs/UrlsRedirect.md +9 -0
- data/docs/UseServiceBanking.md +9 -0
- data/docs/UserCompany.md +16 -0
- data/docs/WebHookDepositAuthorizationRequest.md +9 -0
- data/docs/WebHookDepositAuthorizationResponse.md +13 -0
- data/docs/Webhook.md +13 -0
- data/docs/WebhookRequest.md +3 -3
- data/docs/WebhookResponse.md +5 -5
- data/docs/WebhooksApi.md +30 -33
- data/lib/wire4_client.rb +59 -2
- data/lib/wire4_client/api/autorizacin_de_depsitos_api.rb +173 -0
- data/lib/wire4_client/api/comprobante_electrnico_de_pago_cep_api.rb +12 -5
- data/lib/wire4_client/api/contacto_api.rb +12 -5
- data/lib/wire4_client/api/contracts_details_api.rb +301 -0
- data/lib/wire4_client/api/cuentas_de_beneficiarios_spei_api.rb +292 -63
- data/lib/wire4_client/api/cuentas_de_beneficiarios_spid_api.rb +110 -9
- data/lib/wire4_client/api/depositantes_api.rb +31 -17
- data/lib/wire4_client/api/empresas_co_di_api.rb +137 -0
- data/lib/wire4_client/api/facturas_api.rb +23 -9
- data/lib/wire4_client/api/instituciones_api.rb +16 -7
- data/lib/wire4_client/api/lmites_de_montos_api.rb +160 -0
- data/lib/wire4_client/api/operaciones_co_di_api.rb +92 -0
- data/lib/wire4_client/api/peticiones_de_pago_por_co_di_api.rb +178 -0
- data/lib/wire4_client/api/puntos_de_venta_co_di_api.rb +151 -0
- data/lib/wire4_client/api/saldo_api.rb +16 -9
- data/lib/wire4_client/api/suscripciones_api.rb +185 -31
- data/lib/wire4_client/api/transferencias_spei_api.rb +220 -33
- data/lib/wire4_client/api/transferencias_spid_api.rb +35 -21
- data/lib/wire4_client/api/webhooks_api.rb +46 -25
- data/lib/wire4_client/api_client.rb +1 -2
- data/lib/wire4_client/api_error.rb +1 -1
- data/lib/wire4_client/configuration.rb +1 -22
- data/lib/wire4_client/models/account.rb +12 -12
- data/lib/wire4_client/models/{timestamp.rb → account_detail.rb} +50 -75
- data/lib/wire4_client/models/account_reassigned.rb +375 -0
- data/lib/wire4_client/models/account_request.rb +4 -4
- data/lib/wire4_client/models/account_response.rb +37 -17
- data/lib/wire4_client/models/account_spid.rb +60 -12
- data/lib/wire4_client/models/address_company.rb +275 -0
- data/lib/wire4_client/models/amount_request.rb +95 -9
- data/lib/wire4_client/models/authorization_transaction_group.rb +207 -0
- data/lib/wire4_client/models/authorized_beneficiaries_response.rb +206 -0
- data/lib/wire4_client/models/authorized_users.rb +235 -0
- data/lib/wire4_client/models/balance.rb +5 -5
- data/lib/wire4_client/models/balance_list_response.rb +2 -2
- data/lib/wire4_client/models/beneficiaries_query_register_status.rb +270 -0
- data/lib/wire4_client/models/beneficiaries_response.rb +2 -2
- data/lib/wire4_client/models/beneficiary_institution.rb +1 -1
- data/lib/wire4_client/models/billing.rb +1 -1
- data/lib/wire4_client/models/billing_transaction.rb +2 -2
- data/lib/wire4_client/models/cep_response.rb +21 -21
- data/lib/wire4_client/models/cep_search_banxico.rb +9 -9
- data/lib/wire4_client/models/certificate_request.rb +248 -0
- data/lib/wire4_client/models/codi_code_qr_response_dto.rb +320 -0
- data/lib/wire4_client/models/codi_code_request_dto.rb +402 -0
- data/lib/wire4_client/models/codi_operation_response_dto.rb +245 -0
- data/lib/wire4_client/models/codi_operations_filters_request_dto.rb +336 -0
- data/lib/wire4_client/models/company_registered.rb +235 -0
- data/lib/wire4_client/models/company_requested.rb +215 -0
- data/lib/wire4_client/models/compay.rb +215 -0
- data/lib/wire4_client/models/configurations_limits.rb +197 -0
- data/lib/wire4_client/models/contact_request.rb +7 -7
- data/lib/wire4_client/models/contract_detail_request.rb +247 -0
- data/lib/wire4_client/models/contract_detail_response.rb +194 -0
- data/lib/wire4_client/models/deposit.rb +32 -22
- data/lib/wire4_client/models/deposit_authorization_request.rb +205 -0
- data/lib/wire4_client/models/depositant.rb +6 -6
- data/lib/wire4_client/models/depositants_register.rb +5 -5
- data/lib/wire4_client/models/depositants_response.rb +2 -2
- data/lib/wire4_client/models/deposits_authorization_response.rb +205 -0
- data/lib/wire4_client/models/detailed_error_response.rb +203 -0
- data/lib/wire4_client/models/error_response.rb +1 -1
- data/lib/wire4_client/models/get_depositants.rb +3 -3
- data/lib/wire4_client/models/institution.rb +6 -6
- data/lib/wire4_client/models/institutions_list.rb +2 -2
- data/lib/wire4_client/models/item.rb +205 -0
- data/lib/wire4_client/models/message_account_beneficiary.rb +5 -5
- data/lib/wire4_client/models/message_cep.rb +23 -23
- data/lib/wire4_client/models/message_codi_action.rb +295 -0
- data/lib/wire4_client/models/message_configurations_limits.rb +187 -0
- data/lib/wire4_client/models/message_deposit_authorization_request.rb +375 -0
- data/lib/wire4_client/models/message_deposit_received.rb +33 -23
- data/lib/wire4_client/models/message_institution.rb +6 -6
- data/lib/wire4_client/models/message_payment.rb +41 -20
- data/lib/wire4_client/models/message_payment_state_pending.rb +335 -0
- data/lib/wire4_client/models/message_request_changed.rb +229 -0
- data/lib/wire4_client/models/message_sales_point.rb +205 -0
- data/lib/wire4_client/models/message_subscription.rb +18 -8
- data/lib/wire4_client/models/message_user_authorized.rb +245 -0
- data/lib/wire4_client/models/message_web_hook.rb +11 -11
- data/lib/wire4_client/models/operations.rb +321 -0
- data/lib/wire4_client/models/pager_response_dto.rb +236 -0
- data/lib/wire4_client/models/payment.rb +40 -20
- data/lib/wire4_client/models/payment_codi.rb +269 -0
- data/lib/wire4_client/models/payment_request_codi_response_dto.rb +287 -0
- data/lib/wire4_client/models/payments_request_id.rb +236 -0
- data/lib/wire4_client/models/person.rb +1 -1
- data/lib/wire4_client/models/pre_enrollment_data.rb +21 -3
- data/lib/wire4_client/models/pre_enrollment_response.rb +3 -3
- data/lib/wire4_client/models/pre_monex_authorization.rb +291 -0
- data/lib/wire4_client/models/relationship.rb +3 -3
- data/lib/wire4_client/models/relationships_response.rb +2 -2
- data/lib/wire4_client/models/sales_point.rb +205 -0
- data/lib/wire4_client/models/sales_point_found.rb +279 -0
- data/lib/wire4_client/models/sales_point_request.rb +254 -0
- data/lib/wire4_client/models/sales_point_respose.rb +215 -0
- data/lib/wire4_client/models/service_banking.rb +193 -0
- data/lib/wire4_client/models/spid_beneficiaries_response.rb +186 -0
- data/lib/wire4_client/models/spid_beneficiary_response.rb +355 -0
- data/lib/wire4_client/models/spid_classification_dto.rb +3 -3
- data/lib/wire4_client/models/spid_classifications_response_dto.rb +1 -1
- data/lib/wire4_client/models/subscription_change_status_request.rb +222 -0
- data/lib/wire4_client/models/token_required_response.rb +4 -4
- data/lib/wire4_client/models/transaction_error_code.rb +201 -0
- data/lib/wire4_client/models/transaction_outgoing.rb +13 -3
- data/lib/wire4_client/models/transaction_outgoing_spid.rb +12 -12
- data/lib/wire4_client/models/transactions_outgoing_register.rb +5 -5
- data/lib/wire4_client/models/update_configurations_request_dto.rb +192 -0
- data/lib/wire4_client/models/urls_redirect.rb +261 -0
- data/lib/wire4_client/models/use_service_banking.rb +251 -0
- data/lib/wire4_client/models/user_company.rb +269 -0
- data/lib/wire4_client/models/web_hook_deposit_authorization_request.rb +195 -0
- data/lib/wire4_client/models/web_hook_deposit_authorization_response.rb +237 -0
- data/lib/wire4_client/models/webhook.rb +271 -0
- data/lib/wire4_client/models/webhook_request.rb +4 -4
- data/lib/wire4_client/models/webhook_response.rb +6 -6
- data/lib/wire4_client/models/webhooks_list.rb +1 -1
- data/lib/wire4_client/version.rb +2 -2
- data/spec/api/autorizacin_de_depsitos_api_spec.rb +62 -0
- data/spec/api/comprobante_electrnico_de_pago_cep_api_spec.rb +2 -1
- data/spec/api/contacto_api_spec.rb +2 -1
- data/spec/api/contracts_details_api_spec.rb +90 -0
- data/spec/api/cuentas_de_beneficiarios_spei_api_spec.rb +59 -19
- data/spec/api/cuentas_de_beneficiarios_spid_api_spec.rb +25 -3
- data/spec/api/depositantes_api_spec.rb +7 -5
- data/spec/api/empresas_co_di_api_spec.rb +60 -0
- data/spec/api/facturas_api_spec.rb +3 -1
- data/spec/api/instituciones_api_spec.rb +4 -2
- data/spec/api/lmites_de_montos_api_spec.rb +62 -0
- data/spec/api/operaciones_co_di_api_spec.rb +52 -0
- data/spec/api/peticiones_de_pago_por_co_di_api_spec.rb +63 -0
- data/spec/api/puntos_de_venta_co_di_api_spec.rb +62 -0
- data/spec/api/saldo_api_spec.rb +4 -3
- data/spec/api/suscripciones_api_spec.rb +41 -10
- data/spec/api/transferencias_spei_api_spec.rb +42 -9
- data/spec/api/transferencias_spid_api_spec.rb +9 -7
- data/spec/api/webhooks_api_spec.rb +8 -5
- data/spec/api_client_spec.rb +1 -1
- data/spec/configuration_spec.rb +1 -1
- data/spec/models/account_detail_spec.rb +71 -0
- data/spec/models/account_reassigned_spec.rb +119 -0
- data/spec/models/account_request_spec.rb +1 -1
- data/spec/models/account_response_spec.rb +13 -1
- data/spec/models/account_spec.rb +1 -1
- data/spec/models/account_spid_spec.rb +1 -1
- data/spec/models/{timestamp_spec.rb → address_company_spec.rb} +17 -17
- data/spec/models/amount_request_spec.rb +13 -1
- data/spec/models/authorization_transaction_group_spec.rb +47 -0
- data/spec/models/authorized_beneficiaries_response_spec.rb +53 -0
- data/spec/models/authorized_users_spec.rb +71 -0
- data/spec/models/balance_list_response_spec.rb +1 -1
- data/spec/models/balance_spec.rb +1 -1
- data/spec/models/beneficiaries_query_register_status_spec.rb +75 -0
- data/spec/models/beneficiaries_response_spec.rb +1 -1
- data/spec/models/beneficiary_institution_spec.rb +1 -1
- data/spec/models/billing_spec.rb +1 -1
- data/spec/models/billing_transaction_spec.rb +1 -1
- data/spec/models/cep_response_spec.rb +1 -1
- data/spec/models/cep_search_banxico_spec.rb +1 -1
- data/spec/models/certificate_request_spec.rb +59 -0
- data/spec/models/codi_code_qr_response_dto_spec.rb +103 -0
- data/spec/models/codi_code_request_dto_spec.rb +81 -0
- data/spec/models/codi_operation_response_dto_spec.rb +77 -0
- data/spec/models/codi_operations_filters_request_dto_spec.rb +87 -0
- data/spec/models/company_registered_spec.rb +71 -0
- data/spec/models/company_requested_spec.rb +59 -0
- data/spec/models/compay_spec.rb +59 -0
- data/spec/models/configurations_limits_spec.rb +47 -0
- data/spec/models/contact_request_spec.rb +1 -1
- data/spec/models/contract_detail_request_spec.rb +59 -0
- data/spec/models/contract_detail_response_spec.rb +47 -0
- data/spec/models/deposit_authorization_request_spec.rb +53 -0
- data/spec/models/deposit_spec.rb +7 -1
- data/spec/models/depositant_spec.rb +1 -1
- data/spec/models/depositants_register_spec.rb +1 -1
- data/spec/models/depositants_response_spec.rb +1 -1
- data/spec/models/deposits_authorization_response_spec.rb +53 -0
- data/spec/models/detailed_error_response_spec.rb +53 -0
- data/spec/models/error_response_spec.rb +1 -1
- data/spec/models/get_depositants_spec.rb +1 -1
- data/spec/models/institution_spec.rb +1 -1
- data/spec/models/institutions_list_spec.rb +1 -1
- data/spec/models/item_spec.rb +53 -0
- data/spec/models/message_account_beneficiary_spec.rb +1 -1
- data/spec/models/message_cep_spec.rb +1 -1
- data/spec/models/message_codi_action_spec.rb +107 -0
- data/spec/models/message_configurations_limits_spec.rb +41 -0
- data/spec/models/message_deposit_authorization_request_spec.rb +155 -0
- data/spec/models/message_deposit_received_spec.rb +7 -1
- data/spec/models/message_institution_spec.rb +1 -1
- data/spec/models/message_payment_spec.rb +13 -1
- data/spec/models/message_payment_state_pending_spec.rb +131 -0
- data/spec/models/message_request_changed_spec.rb +51 -0
- data/spec/models/message_sales_point_spec.rb +53 -0
- data/spec/models/message_subscription_spec.rb +7 -1
- data/spec/models/message_user_authorized_spec.rb +77 -0
- data/spec/models/message_web_hook_spec.rb +1 -1
- data/spec/models/operations_spec.rb +103 -0
- data/spec/models/pager_response_dto_spec.rb +71 -0
- data/spec/models/payment_codi_spec.rb +75 -0
- data/spec/models/payment_request_codi_response_dto_spec.rb +101 -0
- data/spec/models/payment_spec.rb +13 -1
- data/spec/models/payments_request_id_spec.rb +71 -0
- data/spec/models/person_spec.rb +1 -1
- data/spec/models/pre_enrollment_data_spec.rb +1 -1
- data/spec/models/pre_enrollment_response_spec.rb +1 -1
- data/spec/models/pre_monex_authorization_spec.rb +59 -0
- data/spec/models/relationship_spec.rb +1 -1
- data/spec/models/relationships_response_spec.rb +1 -1
- data/spec/models/sales_point_found_spec.rb +81 -0
- data/spec/models/sales_point_request_spec.rb +59 -0
- data/spec/models/sales_point_respose_spec.rb +59 -0
- data/spec/models/sales_point_spec.rb +53 -0
- data/spec/models/service_banking_spec.rb +47 -0
- data/spec/models/spid_beneficiaries_response_spec.rb +41 -0
- data/spec/models/spid_beneficiary_response_spec.rb +107 -0
- data/spec/models/spid_classification_dto_spec.rb +1 -1
- data/spec/models/spid_classifications_response_dto_spec.rb +1 -1
- data/spec/models/subscription_change_status_request_spec.rb +45 -0
- data/spec/models/token_required_response_spec.rb +1 -1
- data/spec/models/transaction_error_code_spec.rb +53 -0
- data/spec/models/transaction_outgoing_spec.rb +7 -1
- data/spec/models/transaction_outgoing_spid_spec.rb +1 -1
- data/spec/models/transactions_outgoing_register_spec.rb +1 -1
- data/spec/models/update_configurations_request_dto_spec.rb +41 -0
- data/spec/models/urls_redirect_spec.rb +47 -0
- data/spec/models/use_service_banking_spec.rb +55 -0
- data/spec/models/user_company_spec.rb +89 -0
- data/spec/models/web_hook_deposit_authorization_request_spec.rb +47 -0
- data/spec/models/web_hook_deposit_authorization_response_spec.rb +71 -0
- data/spec/models/webhook_request_spec.rb +1 -1
- data/spec/models/webhook_response_spec.rb +1 -1
- data/spec/models/webhook_spec.rb +75 -0
- data/spec/models/webhooks_list_spec.rb +1 -1
- data/spec/spec_helper.rb +1 -1
- data/wire4_client.gemspec +2 -2
- metadata +281 -54
- data/Gemfile.lock +0 -69
- data/docs/Timestamp.md +0 -17
data/docs/ContactRequest.md
CHANGED
@@ -3,10 +3,10 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**address** | **String** |
|
7
|
-
**company** | **String** |
|
8
|
-
**contact_person** | **String** |
|
9
|
-
**email** | **String** |
|
10
|
-
**phone_number** | **String** |
|
6
|
+
**address** | **String** | Es la dirección del contacto, por ejemplo: Calle fulanita No. 500 int 2, Col. Conocida. | [optional]
|
7
|
+
**company** | **String** | Es el nombre de la empresa. | [optional]
|
8
|
+
**contact_person** | **String** | Es el nombre completo de la persona quién será contactada. | [optional]
|
9
|
+
**email** | **String** | Es el correo electrónico (email) de la persona. Se valida que tenga el formato de email, por ejemplo: correo@correo.com. |
|
10
|
+
**phone_number** | **String** | Es el número de teléfono de la persona. Se validan que sean 10 dígitos del número. |
|
11
11
|
|
12
12
|
|
data/docs/ContactoApi.md
CHANGED
@@ -8,7 +8,7 @@ Method | HTTP request | Description
|
|
8
8
|
|
9
9
|
|
10
10
|
# **send_contact_using_post**
|
11
|
-
> send_contact_using_post(request_dto)
|
11
|
+
> send_contact_using_post(authorization, request_dto)
|
12
12
|
|
13
13
|
Solicitud de contacto
|
14
14
|
|
@@ -18,20 +18,17 @@ Notifica a un asesor Monex para que se ponga en contacto con un posible cliente.
|
|
18
18
|
```ruby
|
19
19
|
# load the gem
|
20
20
|
require 'wire4_client'
|
21
|
-
# setup authorization
|
22
|
-
Wire4Client.configure do |config|
|
23
|
-
# Configure OAuth2 access token for authorization: wire4_aut_app
|
24
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
25
|
-
end
|
26
21
|
|
27
22
|
api_instance = Wire4Client::ContactoApi.new
|
28
23
|
|
24
|
+
authorization = 'authorization_example' # String | Header para token
|
25
|
+
|
29
26
|
request_dto = Wire4Client::ContactRequest.new # ContactRequest | Información del contacto
|
30
27
|
|
31
28
|
|
32
29
|
begin
|
33
30
|
#Solicitud de contacto
|
34
|
-
api_instance.send_contact_using_post(request_dto)
|
31
|
+
api_instance.send_contact_using_post(authorization, request_dto)
|
35
32
|
rescue Wire4Client::ApiError => e
|
36
33
|
puts "Exception when calling ContactoApi->send_contact_using_post: #{e}"
|
37
34
|
end
|
@@ -41,6 +38,7 @@ end
|
|
41
38
|
|
42
39
|
Name | Type | Description | Notes
|
43
40
|
------------- | ------------- | ------------- | -------------
|
41
|
+
**authorization** | **String**| Header para token |
|
44
42
|
**request_dto** | [**ContactRequest**](ContactRequest.md)| Información del contacto |
|
45
43
|
|
46
44
|
### Return type
|
@@ -49,7 +47,7 @@ nil (empty response body)
|
|
49
47
|
|
50
48
|
### Authorization
|
51
49
|
|
52
|
-
|
50
|
+
No authorization required
|
53
51
|
|
54
52
|
### HTTP request headers
|
55
53
|
|
@@ -0,0 +1,11 @@
|
|
1
|
+
# Wire4Client::ContractDetailRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**contract** | **String** | El contrato a consultar la información | [optional]
|
7
|
+
**password** | **String** | La contraseña del usuario | [optional]
|
8
|
+
**token_code** | **String** | La contraseña del usuario | [optional]
|
9
|
+
**user_name** | **String** | El nombre del usuario | [optional]
|
10
|
+
|
11
|
+
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# Wire4Client::ContractDetailResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**account** | [**AccountDetail**](AccountDetail.md) | La información de la compañía correspondiente al contrato | [optional]
|
7
|
+
**user** | [**UserCompany**](UserCompany.md) | La información del usuario de la compañía correspondiente al contrato | [optional]
|
8
|
+
|
9
|
+
|
@@ -0,0 +1,222 @@
|
|
1
|
+
# Wire4Client::ContractsDetailsApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://sandbox-api.wire4.mx/wire4/1.0.0*
|
4
|
+
|
5
|
+
Method | HTTP request | Description
|
6
|
+
------------- | ------------- | -------------
|
7
|
+
[**create_authorization**](ContractsDetailsApi.md#create_authorization) | **POST** /onboarding/accounts/authorize | Devuelve la URL para autorización del usuario Monex
|
8
|
+
[**obtain_authorized_users**](ContractsDetailsApi.md#obtain_authorized_users) | **GET** /onboarding/accounts/{requestId}/authorized-users | Obtiene los usuarios autorizados
|
9
|
+
[**obtain_authorized_users_by_contract**](ContractsDetailsApi.md#obtain_authorized_users_by_contract) | **GET** /onboarding/accounts/authorized-users | Obtiene los usuarios autorizados por contrato
|
10
|
+
[**obtain_contract_details**](ContractsDetailsApi.md#obtain_contract_details) | **POST** /onboarding/accounts/details | Obtiene los detalles de la empresa del contrato
|
11
|
+
|
12
|
+
|
13
|
+
# **create_authorization**
|
14
|
+
> TokenRequiredResponse create_authorization(authorization, pre_monex_authorization)
|
15
|
+
|
16
|
+
Devuelve la URL para autorización del usuario Monex
|
17
|
+
|
18
|
+
Se obtiene la URL para la autorización del usuario Monex.
|
19
|
+
|
20
|
+
### Example
|
21
|
+
```ruby
|
22
|
+
# load the gem
|
23
|
+
require 'wire4_client'
|
24
|
+
|
25
|
+
api_instance = Wire4Client::ContractsDetailsApi.new
|
26
|
+
|
27
|
+
authorization = 'authorization_example' # String | Header para token
|
28
|
+
|
29
|
+
pre_monex_authorization = Wire4Client::PreMonexAuthorization.new # PreMonexAuthorization | Información para la autorización
|
30
|
+
|
31
|
+
|
32
|
+
begin
|
33
|
+
#Devuelve la URL para autorización del usuario Monex
|
34
|
+
result = api_instance.create_authorization(authorization, pre_monex_authorization)
|
35
|
+
p result
|
36
|
+
rescue Wire4Client::ApiError => e
|
37
|
+
puts "Exception when calling ContractsDetailsApi->create_authorization: #{e}"
|
38
|
+
end
|
39
|
+
```
|
40
|
+
|
41
|
+
### Parameters
|
42
|
+
|
43
|
+
Name | Type | Description | Notes
|
44
|
+
------------- | ------------- | ------------- | -------------
|
45
|
+
**authorization** | **String**| Header para token |
|
46
|
+
**pre_monex_authorization** | [**PreMonexAuthorization**](PreMonexAuthorization.md)| Información para la autorización |
|
47
|
+
|
48
|
+
### Return type
|
49
|
+
|
50
|
+
[**TokenRequiredResponse**](TokenRequiredResponse.md)
|
51
|
+
|
52
|
+
### Authorization
|
53
|
+
|
54
|
+
No authorization required
|
55
|
+
|
56
|
+
### HTTP request headers
|
57
|
+
|
58
|
+
- **Content-Type**: application/json
|
59
|
+
- **Accept**: application/json
|
60
|
+
|
61
|
+
|
62
|
+
|
63
|
+
# **obtain_authorized_users**
|
64
|
+
> Array<AuthorizedUsers> obtain_authorized_users(authorization, x_access_key, request_id)
|
65
|
+
|
66
|
+
Obtiene los usuarios autorizados
|
67
|
+
|
68
|
+
Obtienen los detalles de los usuarios autorizados de Monex.
|
69
|
+
|
70
|
+
### Example
|
71
|
+
```ruby
|
72
|
+
# load the gem
|
73
|
+
require 'wire4_client'
|
74
|
+
|
75
|
+
api_instance = Wire4Client::ContractsDetailsApi.new
|
76
|
+
|
77
|
+
authorization = 'authorization_example' # String | Header para token
|
78
|
+
|
79
|
+
x_access_key = 'x_access_key_example' # String | La llave de acceso de la aplicación
|
80
|
+
|
81
|
+
request_id = 'request_id_example' # String | El identificador de la petición a esta API
|
82
|
+
|
83
|
+
|
84
|
+
begin
|
85
|
+
#Obtiene los usuarios autorizados
|
86
|
+
result = api_instance.obtain_authorized_users(authorization, x_access_key, request_id)
|
87
|
+
p result
|
88
|
+
rescue Wire4Client::ApiError => e
|
89
|
+
puts "Exception when calling ContractsDetailsApi->obtain_authorized_users: #{e}"
|
90
|
+
end
|
91
|
+
```
|
92
|
+
|
93
|
+
### Parameters
|
94
|
+
|
95
|
+
Name | Type | Description | Notes
|
96
|
+
------------- | ------------- | ------------- | -------------
|
97
|
+
**authorization** | **String**| Header para token |
|
98
|
+
**x_access_key** | **String**| La llave de acceso de la aplicación |
|
99
|
+
**request_id** | **String**| El identificador de la petición a esta API |
|
100
|
+
|
101
|
+
### Return type
|
102
|
+
|
103
|
+
[**Array<AuthorizedUsers>**](AuthorizedUsers.md)
|
104
|
+
|
105
|
+
### Authorization
|
106
|
+
|
107
|
+
No authorization required
|
108
|
+
|
109
|
+
### HTTP request headers
|
110
|
+
|
111
|
+
- **Content-Type**: Not defined
|
112
|
+
- **Accept**: application/json
|
113
|
+
|
114
|
+
|
115
|
+
|
116
|
+
# **obtain_authorized_users_by_contract**
|
117
|
+
> Array<AuthorizedUsers> obtain_authorized_users_by_contract(authorization, x_access_key, opts)
|
118
|
+
|
119
|
+
Obtiene los usuarios autorizados por contrato
|
120
|
+
|
121
|
+
Obtienen los detalles de los usuarios autorizados por contrato Monex.
|
122
|
+
|
123
|
+
### Example
|
124
|
+
```ruby
|
125
|
+
# load the gem
|
126
|
+
require 'wire4_client'
|
127
|
+
|
128
|
+
api_instance = Wire4Client::ContractsDetailsApi.new
|
129
|
+
|
130
|
+
authorization = 'authorization_example' # String | Header para token
|
131
|
+
|
132
|
+
x_access_key = 'x_access_key_example' # String | La llave de acceso de la aplicación
|
133
|
+
|
134
|
+
opts = {
|
135
|
+
contract: 'contract_example' # String | El contrato Monex
|
136
|
+
}
|
137
|
+
|
138
|
+
begin
|
139
|
+
#Obtiene los usuarios autorizados por contrato
|
140
|
+
result = api_instance.obtain_authorized_users_by_contract(authorization, x_access_key, opts)
|
141
|
+
p result
|
142
|
+
rescue Wire4Client::ApiError => e
|
143
|
+
puts "Exception when calling ContractsDetailsApi->obtain_authorized_users_by_contract: #{e}"
|
144
|
+
end
|
145
|
+
```
|
146
|
+
|
147
|
+
### Parameters
|
148
|
+
|
149
|
+
Name | Type | Description | Notes
|
150
|
+
------------- | ------------- | ------------- | -------------
|
151
|
+
**authorization** | **String**| Header para token |
|
152
|
+
**x_access_key** | **String**| La llave de acceso de la aplicación |
|
153
|
+
**contract** | **String**| El contrato Monex | [optional]
|
154
|
+
|
155
|
+
### Return type
|
156
|
+
|
157
|
+
[**Array<AuthorizedUsers>**](AuthorizedUsers.md)
|
158
|
+
|
159
|
+
### Authorization
|
160
|
+
|
161
|
+
No authorization required
|
162
|
+
|
163
|
+
### HTTP request headers
|
164
|
+
|
165
|
+
- **Content-Type**: Not defined
|
166
|
+
- **Accept**: application/json
|
167
|
+
|
168
|
+
|
169
|
+
|
170
|
+
# **obtain_contract_details**
|
171
|
+
> ContractDetailResponse obtain_contract_details(authorization, x_access_key, contract_detail_request)
|
172
|
+
|
173
|
+
Obtiene los detalles de la empresa del contrato
|
174
|
+
|
175
|
+
Detalles de la compañía relacionada con el contrato de Monex.
|
176
|
+
|
177
|
+
### Example
|
178
|
+
```ruby
|
179
|
+
# load the gem
|
180
|
+
require 'wire4_client'
|
181
|
+
|
182
|
+
api_instance = Wire4Client::ContractsDetailsApi.new
|
183
|
+
|
184
|
+
authorization = 'authorization_example' # String | Header para token
|
185
|
+
|
186
|
+
x_access_key = 'x_access_key_example' # String | La llave de acceso de la aplicación
|
187
|
+
|
188
|
+
contract_detail_request = Wire4Client::ContractDetailRequest.new # ContractDetailRequest | Información para obtener los detalles de la companía
|
189
|
+
|
190
|
+
|
191
|
+
begin
|
192
|
+
#Obtiene los detalles de la empresa del contrato
|
193
|
+
result = api_instance.obtain_contract_details(authorization, x_access_key, contract_detail_request)
|
194
|
+
p result
|
195
|
+
rescue Wire4Client::ApiError => e
|
196
|
+
puts "Exception when calling ContractsDetailsApi->obtain_contract_details: #{e}"
|
197
|
+
end
|
198
|
+
```
|
199
|
+
|
200
|
+
### Parameters
|
201
|
+
|
202
|
+
Name | Type | Description | Notes
|
203
|
+
------------- | ------------- | ------------- | -------------
|
204
|
+
**authorization** | **String**| Header para token |
|
205
|
+
**x_access_key** | **String**| La llave de acceso de la aplicación |
|
206
|
+
**contract_detail_request** | [**ContractDetailRequest**](ContractDetailRequest.md)| Información para obtener los detalles de la companía |
|
207
|
+
|
208
|
+
### Return type
|
209
|
+
|
210
|
+
[**ContractDetailResponse**](ContractDetailResponse.md)
|
211
|
+
|
212
|
+
### Authorization
|
213
|
+
|
214
|
+
No authorization required
|
215
|
+
|
216
|
+
### HTTP request headers
|
217
|
+
|
218
|
+
- **Content-Type**: application/json
|
219
|
+
- **Accept**: application/json
|
220
|
+
|
221
|
+
|
222
|
+
|
@@ -4,41 +4,93 @@ All URIs are relative to *https://sandbox-api.wire4.mx/wire4/1.0.0*
|
|
4
4
|
|
5
5
|
Method | HTTP request | Description
|
6
6
|
------------- | ------------- | -------------
|
7
|
+
[**authorize_accounts_pending_put**](CuentasDeBeneficiariosSPEIApi.md#authorize_accounts_pending_put) | **PUT** /subscriptions/{subscription}/beneficiaries/pending | Solicitud para agrupar cuentas de beneficiarios SPEI/SPID en estado pendiente.
|
7
8
|
[**delete_account_using_delete**](CuentasDeBeneficiariosSPEIApi.md#delete_account_using_delete) | **DELETE** /subscriptions/{subscription}/beneficiaries/spei/{account} | Elimina la cuenta del beneficiario
|
8
9
|
[**get_available_relationships_monex_using_get**](CuentasDeBeneficiariosSPEIApi.md#get_available_relationships_monex_using_get) | **GET** /subscriptions/{subscription}/beneficiaries/relationships | Consulta de relaciones
|
10
|
+
[**get_beneficiaries_by_request_id**](CuentasDeBeneficiariosSPEIApi.md#get_beneficiaries_by_request_id) | **GET** /subscriptions/{subscription}/beneficiaries/spei/{requestId} | Consulta los beneficiarios por el identificador de la petición de registro
|
9
11
|
[**get_beneficiaries_for_account_using_get**](CuentasDeBeneficiariosSPEIApi.md#get_beneficiaries_for_account_using_get) | **GET** /subscriptions/{subscription}/beneficiaries/spei | Consulta los beneficiarios registrados
|
10
|
-
[**pre_register_accounts_using_post**](CuentasDeBeneficiariosSPEIApi.md#pre_register_accounts_using_post) | **POST** /subscriptions/{subscription}/beneficiaries/spei | Pre-registro de cuentas de beneficiarios
|
12
|
+
[**pre_register_accounts_using_post**](CuentasDeBeneficiariosSPEIApi.md#pre_register_accounts_using_post) | **POST** /subscriptions/{subscription}/beneficiaries/spei | Pre-registro de cuentas de beneficiarios SPEI®.
|
11
13
|
[**remove_beneficiaries_pending_using_delete**](CuentasDeBeneficiariosSPEIApi.md#remove_beneficiaries_pending_using_delete) | **DELETE** /subscriptions/{subscription}/beneficiaries/spei/request/{requestId} | Eliminación de beneficiarios SPEI® sin confirmar
|
12
|
-
[**update_amount_limit_account_using_put**](CuentasDeBeneficiariosSPEIApi.md#update_amount_limit_account_using_put) | **PUT** /subscriptions/{subscription}/beneficiaries/spei/{account} |
|
14
|
+
[**update_amount_limit_account_using_put**](CuentasDeBeneficiariosSPEIApi.md#update_amount_limit_account_using_put) | **PUT** /subscriptions/{subscription}/beneficiaries/spei/{account} | Solicitud para actualizar el monto límite de una cuenta
|
15
|
+
|
16
|
+
|
17
|
+
# **authorize_accounts_pending_put**
|
18
|
+
> AuthorizedBeneficiariesResponse authorize_accounts_pending_put(authorization, subscription, urls_redirect_dto)
|
19
|
+
|
20
|
+
Solicitud para agrupar cuentas de beneficiarios SPEI/SPID en estado pendiente.
|
21
|
+
|
22
|
+
Solicta la agrupación de las cuentas de beneficiarios en estado pendiente para que sean autorizadas, para ello se crea un conjunto de éstas que puede incluir tanto de SPEI como de SPID. Además se debe indicar las urls de redirección en caso de error y éxito
|
23
|
+
|
24
|
+
### Example
|
25
|
+
```ruby
|
26
|
+
# load the gem
|
27
|
+
require 'wire4_client'
|
28
|
+
|
29
|
+
api_instance = Wire4Client::CuentasDeBeneficiariosSPEIApi.new
|
30
|
+
|
31
|
+
authorization = 'authorization_example' # String | Header para token
|
32
|
+
|
33
|
+
subscription = 'subscription_example' # String | Es el identificador de la suscripción a esta API.
|
34
|
+
|
35
|
+
urls_redirect_dto = Wire4Client::UrlsRedirect.new # UrlsRedirect | Información de la cuenta del beneficiario
|
36
|
+
|
37
|
+
|
38
|
+
begin
|
39
|
+
#Solicitud para agrupar cuentas de beneficiarios SPEI/SPID en estado pendiente.
|
40
|
+
result = api_instance.authorize_accounts_pending_put(authorization, subscription, urls_redirect_dto)
|
41
|
+
p result
|
42
|
+
rescue Wire4Client::ApiError => e
|
43
|
+
puts "Exception when calling CuentasDeBeneficiariosSPEIApi->authorize_accounts_pending_put: #{e}"
|
44
|
+
end
|
45
|
+
```
|
46
|
+
|
47
|
+
### Parameters
|
48
|
+
|
49
|
+
Name | Type | Description | Notes
|
50
|
+
------------- | ------------- | ------------- | -------------
|
51
|
+
**authorization** | **String**| Header para token |
|
52
|
+
**subscription** | **String**| Es el identificador de la suscripción a esta API. |
|
53
|
+
**urls_redirect_dto** | [**UrlsRedirect**](UrlsRedirect.md)| Información de la cuenta del beneficiario |
|
54
|
+
|
55
|
+
### Return type
|
56
|
+
|
57
|
+
[**AuthorizedBeneficiariesResponse**](AuthorizedBeneficiariesResponse.md)
|
58
|
+
|
59
|
+
### Authorization
|
60
|
+
|
61
|
+
No authorization required
|
62
|
+
|
63
|
+
### HTTP request headers
|
64
|
+
|
65
|
+
- **Content-Type**: application/json
|
66
|
+
- **Accept**: application/json
|
67
|
+
|
13
68
|
|
14
69
|
|
15
70
|
# **delete_account_using_delete**
|
16
|
-
> delete_account_using_delete(account, subscription)
|
71
|
+
> delete_account_using_delete(authorization, account, subscription)
|
17
72
|
|
18
73
|
Elimina la cuenta del beneficiario
|
19
74
|
|
20
|
-
|
75
|
+
Elimina la cuenta de beneficiario proporcionada relacionada al contrato perteneciente a la suscripción. La cuenta a borrar debe ser una que opere con SPEI.
|
21
76
|
|
22
77
|
### Example
|
23
78
|
```ruby
|
24
79
|
# load the gem
|
25
80
|
require 'wire4_client'
|
26
|
-
# setup authorization
|
27
|
-
Wire4Client.configure do |config|
|
28
|
-
# Configure OAuth2 access token for authorization: wire4_aut_app_user_spei
|
29
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
30
|
-
end
|
31
81
|
|
32
82
|
api_instance = Wire4Client::CuentasDeBeneficiariosSPEIApi.new
|
33
83
|
|
34
|
-
|
84
|
+
authorization = 'authorization_example' # String | Header para token
|
85
|
+
|
86
|
+
account = 'account_example' # String | Es la cuenta del beneficiario que será eliminada.
|
35
87
|
|
36
|
-
subscription = 'subscription_example' # String |
|
88
|
+
subscription = 'subscription_example' # String | Es el identificador de la suscripción a esta API.
|
37
89
|
|
38
90
|
|
39
91
|
begin
|
40
92
|
#Elimina la cuenta del beneficiario
|
41
|
-
api_instance.delete_account_using_delete(account, subscription)
|
93
|
+
api_instance.delete_account_using_delete(authorization, account, subscription)
|
42
94
|
rescue Wire4Client::ApiError => e
|
43
95
|
puts "Exception when calling CuentasDeBeneficiariosSPEIApi->delete_account_using_delete: #{e}"
|
44
96
|
end
|
@@ -48,8 +100,9 @@ end
|
|
48
100
|
|
49
101
|
Name | Type | Description | Notes
|
50
102
|
------------- | ------------- | ------------- | -------------
|
51
|
-
**
|
52
|
-
**
|
103
|
+
**authorization** | **String**| Header para token |
|
104
|
+
**account** | **String**| Es la cuenta del beneficiario que será eliminada. |
|
105
|
+
**subscription** | **String**| Es el identificador de la suscripción a esta API. |
|
53
106
|
|
54
107
|
### Return type
|
55
108
|
|
@@ -57,7 +110,7 @@ nil (empty response body)
|
|
57
110
|
|
58
111
|
### Authorization
|
59
112
|
|
60
|
-
|
113
|
+
No authorization required
|
61
114
|
|
62
115
|
### HTTP request headers
|
63
116
|
|
@@ -67,7 +120,7 @@ nil (empty response body)
|
|
67
120
|
|
68
121
|
|
69
122
|
# **get_available_relationships_monex_using_get**
|
70
|
-
> RelationshipsResponse get_available_relationships_monex_using_get(subscription)
|
123
|
+
> RelationshipsResponse get_available_relationships_monex_using_get(authorization, subscription)
|
71
124
|
|
72
125
|
Consulta de relaciones
|
73
126
|
|
@@ -77,20 +130,17 @@ Obtiene las posibles relaciones existentes para registrar beneficiarios en Monex
|
|
77
130
|
```ruby
|
78
131
|
# load the gem
|
79
132
|
require 'wire4_client'
|
80
|
-
# setup authorization
|
81
|
-
Wire4Client.configure do |config|
|
82
|
-
# Configure OAuth2 access token for authorization: wire4_aut_app_user_spei
|
83
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
84
|
-
end
|
85
133
|
|
86
134
|
api_instance = Wire4Client::CuentasDeBeneficiariosSPEIApi.new
|
87
135
|
|
88
|
-
|
136
|
+
authorization = 'authorization_example' # String | Header para token
|
137
|
+
|
138
|
+
subscription = 'subscription_example' # String | Es el identificador de la suscripción a esta API.
|
89
139
|
|
90
140
|
|
91
141
|
begin
|
92
142
|
#Consulta de relaciones
|
93
|
-
result = api_instance.get_available_relationships_monex_using_get(subscription)
|
143
|
+
result = api_instance.get_available_relationships_monex_using_get(authorization, subscription)
|
94
144
|
p result
|
95
145
|
rescue Wire4Client::ApiError => e
|
96
146
|
puts "Exception when calling CuentasDeBeneficiariosSPEIApi->get_available_relationships_monex_using_get: #{e}"
|
@@ -101,7 +151,8 @@ end
|
|
101
151
|
|
102
152
|
Name | Type | Description | Notes
|
103
153
|
------------- | ------------- | ------------- | -------------
|
104
|
-
**
|
154
|
+
**authorization** | **String**| Header para token |
|
155
|
+
**subscription** | **String**| Es el identificador de la suscripción a esta API. |
|
105
156
|
|
106
157
|
### Return type
|
107
158
|
|
@@ -109,7 +160,60 @@ Name | Type | Description | Notes
|
|
109
160
|
|
110
161
|
### Authorization
|
111
162
|
|
112
|
-
|
163
|
+
No authorization required
|
164
|
+
|
165
|
+
### HTTP request headers
|
166
|
+
|
167
|
+
- **Content-Type**: Not defined
|
168
|
+
- **Accept**: application/json
|
169
|
+
|
170
|
+
|
171
|
+
|
172
|
+
# **get_beneficiaries_by_request_id**
|
173
|
+
> BeneficiariesResponse get_beneficiaries_by_request_id(authorization, request_id, subscription)
|
174
|
+
|
175
|
+
Consulta los beneficiarios por el identificador de la petición de registro
|
176
|
+
|
177
|
+
Obtiene los beneficiarios enviados para registro en una petición al contrato relacionado con la suscripción, Los beneficiarios son los que actualmente se encuentran registrados en banca Monex, que pertenezcan a la petición que se solicita.
|
178
|
+
|
179
|
+
### Example
|
180
|
+
```ruby
|
181
|
+
# load the gem
|
182
|
+
require 'wire4_client'
|
183
|
+
|
184
|
+
api_instance = Wire4Client::CuentasDeBeneficiariosSPEIApi.new
|
185
|
+
|
186
|
+
authorization = 'authorization_example' # String | Header para token
|
187
|
+
|
188
|
+
request_id = 'request_id_example' # String | El identificador de la petición del registro de beneficiarios a esta API.
|
189
|
+
|
190
|
+
subscription = 'subscription_example' # String | Es el identificador de la suscripción a esta API.
|
191
|
+
|
192
|
+
|
193
|
+
begin
|
194
|
+
#Consulta los beneficiarios por el identificador de la petición de registro
|
195
|
+
result = api_instance.get_beneficiaries_by_request_id(authorization, request_id, subscription)
|
196
|
+
p result
|
197
|
+
rescue Wire4Client::ApiError => e
|
198
|
+
puts "Exception when calling CuentasDeBeneficiariosSPEIApi->get_beneficiaries_by_request_id: #{e}"
|
199
|
+
end
|
200
|
+
```
|
201
|
+
|
202
|
+
### Parameters
|
203
|
+
|
204
|
+
Name | Type | Description | Notes
|
205
|
+
------------- | ------------- | ------------- | -------------
|
206
|
+
**authorization** | **String**| Header para token |
|
207
|
+
**request_id** | **String**| El identificador de la petición del registro de beneficiarios a esta API. |
|
208
|
+
**subscription** | **String**| Es el identificador de la suscripción a esta API. |
|
209
|
+
|
210
|
+
### Return type
|
211
|
+
|
212
|
+
[**BeneficiariesResponse**](BeneficiariesResponse.md)
|
213
|
+
|
214
|
+
### Authorization
|
215
|
+
|
216
|
+
No authorization required
|
113
217
|
|
114
218
|
### HTTP request headers
|
115
219
|
|
@@ -119,7 +223,7 @@ Name | Type | Description | Notes
|
|
119
223
|
|
120
224
|
|
121
225
|
# **get_beneficiaries_for_account_using_get**
|
122
|
-
> BeneficiariesResponse get_beneficiaries_for_account_using_get(subscription, opts)
|
226
|
+
> BeneficiariesResponse get_beneficiaries_for_account_using_get(authorization, subscription, opts)
|
123
227
|
|
124
228
|
Consulta los beneficiarios registrados
|
125
229
|
|
@@ -129,23 +233,26 @@ Obtiene los beneficiarios registrados al contrato relacionado con la suscripció
|
|
129
233
|
```ruby
|
130
234
|
# load the gem
|
131
235
|
require 'wire4_client'
|
132
|
-
# setup authorization
|
133
|
-
Wire4Client.configure do |config|
|
134
|
-
# Configure OAuth2 access token for authorization: wire4_aut_app_user_spei
|
135
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
136
|
-
end
|
137
236
|
|
138
237
|
api_instance = Wire4Client::CuentasDeBeneficiariosSPEIApi.new
|
139
238
|
|
140
|
-
|
239
|
+
authorization = 'authorization_example' # String | Header para token
|
240
|
+
|
241
|
+
subscription = 'subscription_example' # String | Es el identificador de la suscripción a esta API.
|
141
242
|
|
142
243
|
opts = {
|
143
|
-
|
244
|
+
account: 'account_example', # String | Es la cuenta del beneficiario, podría ser teléfono celular (es de 10 dígitos), Tarjeta de débito (TDD, es de 16 dígitos) o cuenta CLABE (es de 18 dígitos). <br/><br/>Por ejemplo Teléfono celular: 5525072600, TDD: 4323 1234 5678 9123, CLABE: 032180000118359719.
|
245
|
+
beneficiary_bank: 'beneficiary_bank_example', # String | Es la clave del banco beneficiario. Se puede obtener del recurso de las <a href=\"#operation/getAllInstitutionsUsingGET\">instituciones.</a>
|
246
|
+
beneficiary_name: 'beneficiary_name_example', # String | Es el nombre del beneficiario.
|
247
|
+
end_date: 'end_date_example', # String | Es la fecha de inicio del perido a filtrar en formato dd-mm-yyyy.
|
248
|
+
init_date: 'init_date_example', # String | Es la fºecha de inicio del perido a filtrar en formato dd-mm-yyyy.
|
249
|
+
rfc: 'rfc_example', # String | Es el Registro Federal de Controbuyentes (RFC) del beneficiario.
|
250
|
+
status: 'status_example' # String | Es el estado (estatus) de la cuenta. Los valores pueden ser <b>PENDING</b> y <b>REGISTERED</b>.
|
144
251
|
}
|
145
252
|
|
146
253
|
begin
|
147
254
|
#Consulta los beneficiarios registrados
|
148
|
-
result = api_instance.get_beneficiaries_for_account_using_get(subscription, opts)
|
255
|
+
result = api_instance.get_beneficiaries_for_account_using_get(authorization, subscription, opts)
|
149
256
|
p result
|
150
257
|
rescue Wire4Client::ApiError => e
|
151
258
|
puts "Exception when calling CuentasDeBeneficiariosSPEIApi->get_beneficiaries_for_account_using_get: #{e}"
|
@@ -156,8 +263,15 @@ end
|
|
156
263
|
|
157
264
|
Name | Type | Description | Notes
|
158
265
|
------------- | ------------- | ------------- | -------------
|
159
|
-
**
|
160
|
-
**
|
266
|
+
**authorization** | **String**| Header para token |
|
267
|
+
**subscription** | **String**| Es el identificador de la suscripción a esta API. |
|
268
|
+
**account** | **String**| Es la cuenta del beneficiario, podría ser teléfono celular (es de 10 dígitos), Tarjeta de débito (TDD, es de 16 dígitos) o cuenta CLABE (es de 18 dígitos). <br/><br/>Por ejemplo Teléfono celular: 5525072600, TDD: 4323 1234 5678 9123, CLABE: 032180000118359719. | [optional]
|
269
|
+
**beneficiary_bank** | **String**| Es la clave del banco beneficiario. Se puede obtener del recurso de las <a href=\"#operation/getAllInstitutionsUsingGET\">instituciones.</a> | [optional]
|
270
|
+
**beneficiary_name** | **String**| Es el nombre del beneficiario. | [optional]
|
271
|
+
**end_date** | **String**| Es la fecha de inicio del perido a filtrar en formato dd-mm-yyyy. | [optional]
|
272
|
+
**init_date** | **String**| Es la fºecha de inicio del perido a filtrar en formato dd-mm-yyyy. | [optional]
|
273
|
+
**rfc** | **String**| Es el Registro Federal de Controbuyentes (RFC) del beneficiario. | [optional]
|
274
|
+
**status** | **String**| Es el estado (estatus) de la cuenta. Los valores pueden ser <b>PENDING</b> y <b>REGISTERED</b>. | [optional]
|
161
275
|
|
162
276
|
### Return type
|
163
277
|
|
@@ -165,7 +279,7 @@ Name | Type | Description | Notes
|
|
165
279
|
|
166
280
|
### Authorization
|
167
281
|
|
168
|
-
|
282
|
+
No authorization required
|
169
283
|
|
170
284
|
### HTTP request headers
|
171
285
|
|
@@ -175,32 +289,29 @@ Name | Type | Description | Notes
|
|
175
289
|
|
176
290
|
|
177
291
|
# **pre_register_accounts_using_post**
|
178
|
-
> TokenRequiredResponse pre_register_accounts_using_post(request_dto, subscription)
|
292
|
+
> TokenRequiredResponse pre_register_accounts_using_post(authorization, request_dto, subscription)
|
179
293
|
|
180
|
-
Pre-registro de cuentas de beneficiarios
|
294
|
+
Pre-registro de cuentas de beneficiarios SPEI®.
|
181
295
|
|
182
|
-
Pre-registra una o más cuentas de beneficiario en la plataforma,
|
296
|
+
Pre-registra una o más cuentas de beneficiario en la plataforma de Wire4, ésta le proporcionará una URL donde lo llevará al centro de autorización para que el cuentahabiente Monex ingrese su llave digital para confirmar el alta de las cuentas de beneficiarios.<br/> Los posibles valores de <em>relationship</em> y <em>kind_of_relationship</em> se deben obtener de <a href=\"#operation/getAvailableRelationshipsMonexUsingGET\">/subscriptions/{subscription}/beneficiaries/relationships.</a><br/><br/>La confirmación de registro en Monex se realizará a través de una notificación a los webhooks registrados con el evento de tipo <a href=\"#section/Eventos/Tipos-de-Eventos\">ACCOUNT.CREATED.</a>
|
183
297
|
|
184
298
|
### Example
|
185
299
|
```ruby
|
186
300
|
# load the gem
|
187
301
|
require 'wire4_client'
|
188
|
-
# setup authorization
|
189
|
-
Wire4Client.configure do |config|
|
190
|
-
# Configure OAuth2 access token for authorization: wire4_aut_app_user_spei
|
191
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
192
|
-
end
|
193
302
|
|
194
303
|
api_instance = Wire4Client::CuentasDeBeneficiariosSPEIApi.new
|
195
304
|
|
305
|
+
authorization = 'authorization_example' # String | Header para token
|
306
|
+
|
196
307
|
request_dto = Wire4Client::AccountRequest.new # AccountRequest | Información de la cuenta del beneficiario
|
197
308
|
|
198
|
-
subscription = 'subscription_example' # String |
|
309
|
+
subscription = 'subscription_example' # String | Es el identificador de la suscripción a esta API.
|
199
310
|
|
200
311
|
|
201
312
|
begin
|
202
|
-
#Pre-registro de cuentas de beneficiarios
|
203
|
-
result = api_instance.pre_register_accounts_using_post(request_dto, subscription)
|
313
|
+
#Pre-registro de cuentas de beneficiarios SPEI®.
|
314
|
+
result = api_instance.pre_register_accounts_using_post(authorization, request_dto, subscription)
|
204
315
|
p result
|
205
316
|
rescue Wire4Client::ApiError => e
|
206
317
|
puts "Exception when calling CuentasDeBeneficiariosSPEIApi->pre_register_accounts_using_post: #{e}"
|
@@ -211,8 +322,9 @@ end
|
|
211
322
|
|
212
323
|
Name | Type | Description | Notes
|
213
324
|
------------- | ------------- | ------------- | -------------
|
325
|
+
**authorization** | **String**| Header para token |
|
214
326
|
**request_dto** | [**AccountRequest**](AccountRequest.md)| Información de la cuenta del beneficiario |
|
215
|
-
**subscription** | **String**|
|
327
|
+
**subscription** | **String**| Es el identificador de la suscripción a esta API. |
|
216
328
|
|
217
329
|
### Return type
|
218
330
|
|
@@ -220,7 +332,7 @@ Name | Type | Description | Notes
|
|
220
332
|
|
221
333
|
### Authorization
|
222
334
|
|
223
|
-
|
335
|
+
No authorization required
|
224
336
|
|
225
337
|
### HTTP request headers
|
226
338
|
|
@@ -230,32 +342,29 @@ Name | Type | Description | Notes
|
|
230
342
|
|
231
343
|
|
232
344
|
# **remove_beneficiaries_pending_using_delete**
|
233
|
-
> remove_beneficiaries_pending_using_delete(request_id, subscription)
|
345
|
+
> remove_beneficiaries_pending_using_delete(authorization, request_id, subscription)
|
234
346
|
|
235
347
|
Eliminación de beneficiarios SPEI® sin confirmar
|
236
348
|
|
237
|
-
Elimina
|
349
|
+
Elimina uno o más beneficiarios que se encuentran en estado pendiente de confirmar (autorizar) de la cuenta del cliente Monex relacionada a la suscripción.
|
238
350
|
|
239
351
|
### Example
|
240
352
|
```ruby
|
241
353
|
# load the gem
|
242
354
|
require 'wire4_client'
|
243
|
-
# setup authorization
|
244
|
-
Wire4Client.configure do |config|
|
245
|
-
# Configure OAuth2 access token for authorization: wire4_aut_app_user_spei
|
246
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
247
|
-
end
|
248
355
|
|
249
356
|
api_instance = Wire4Client::CuentasDeBeneficiariosSPEIApi.new
|
250
357
|
|
251
|
-
|
358
|
+
authorization = 'authorization_example' # String | Header para token
|
359
|
+
|
360
|
+
request_id = 'request_id_example' # String | Es el identificador con el que se dió de alta a los beneficiarios (viene en el cuerpo de la respuesta del <a href=\"#operation/getAvailableRelationshipsMonexUsingGET\">pre-registro de beneficiarios</a>), los registros bajo éste campo van a ser eliminados.
|
252
361
|
|
253
|
-
subscription = 'subscription_example' # String |
|
362
|
+
subscription = 'subscription_example' # String | Es el identificador de la suscripción a esta API.
|
254
363
|
|
255
364
|
|
256
365
|
begin
|
257
366
|
#Eliminación de beneficiarios SPEI® sin confirmar
|
258
|
-
api_instance.remove_beneficiaries_pending_using_delete(request_id, subscription)
|
367
|
+
api_instance.remove_beneficiaries_pending_using_delete(authorization, request_id, subscription)
|
259
368
|
rescue Wire4Client::ApiError => e
|
260
369
|
puts "Exception when calling CuentasDeBeneficiariosSPEIApi->remove_beneficiaries_pending_using_delete: #{e}"
|
261
370
|
end
|
@@ -265,8 +374,9 @@ end
|
|
265
374
|
|
266
375
|
Name | Type | Description | Notes
|
267
376
|
------------- | ------------- | ------------- | -------------
|
268
|
-
**
|
269
|
-
**
|
377
|
+
**authorization** | **String**| Header para token |
|
378
|
+
**request_id** | **String**| Es el identificador con el que se dió de alta a los beneficiarios (viene en el cuerpo de la respuesta del <a href=\"#operation/getAvailableRelationshipsMonexUsingGET\">pre-registro de beneficiarios</a>), los registros bajo éste campo van a ser eliminados. |
|
379
|
+
**subscription** | **String**| Es el identificador de la suscripción a esta API. |
|
270
380
|
|
271
381
|
### Return type
|
272
382
|
|
@@ -274,7 +384,7 @@ nil (empty response body)
|
|
274
384
|
|
275
385
|
### Authorization
|
276
386
|
|
277
|
-
|
387
|
+
No authorization required
|
278
388
|
|
279
389
|
### HTTP request headers
|
280
390
|
|
@@ -284,34 +394,32 @@ nil (empty response body)
|
|
284
394
|
|
285
395
|
|
286
396
|
# **update_amount_limit_account_using_put**
|
287
|
-
> update_amount_limit_account_using_put(account, request_dto, subscription)
|
397
|
+
> TokenRequiredResponse update_amount_limit_account_using_put(authorization, account, request_dto, subscription)
|
288
398
|
|
289
|
-
|
399
|
+
Solicitud para actualizar el monto límite de una cuenta
|
290
400
|
|
291
|
-
|
401
|
+
Se crea una solicitud para actualizar el monto límite a la cuenta de beneficiario proporcionada y relacionada al contrato perteneciente a la subscripción. Una vez enviada la solicitud se retornará una URl que lo llevará al centro de autorización para que el cuentahabiente Monex ingrese su llave digital para confirmar la actualización del monto límite.
|
292
402
|
|
293
403
|
### Example
|
294
404
|
```ruby
|
295
405
|
# load the gem
|
296
406
|
require 'wire4_client'
|
297
|
-
# setup authorization
|
298
|
-
Wire4Client.configure do |config|
|
299
|
-
# Configure OAuth2 access token for authorization: wire4_aut_app_user_spei
|
300
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
301
|
-
end
|
302
407
|
|
303
408
|
api_instance = Wire4Client::CuentasDeBeneficiariosSPEIApi.new
|
304
409
|
|
305
|
-
|
410
|
+
authorization = 'authorization_example' # String | Header para token
|
411
|
+
|
412
|
+
account = 'account_example' # String | Es la cuenta que va a ser actualizada.
|
306
413
|
|
307
|
-
request_dto = Wire4Client::AmountRequest.new # AmountRequest | Información de la cuenta y el monto límite a actualizar
|
414
|
+
request_dto = Wire4Client::AmountRequest.new # AmountRequest | Información de la cuenta y el monto límite a actualizar.
|
308
415
|
|
309
|
-
subscription = 'subscription_example' # String |
|
416
|
+
subscription = 'subscription_example' # String | Es el identificador de la suscripción a esta API.
|
310
417
|
|
311
418
|
|
312
419
|
begin
|
313
|
-
#
|
314
|
-
api_instance.update_amount_limit_account_using_put(account, request_dto, subscription)
|
420
|
+
#Solicitud para actualizar el monto límite de una cuenta
|
421
|
+
result = api_instance.update_amount_limit_account_using_put(authorization, account, request_dto, subscription)
|
422
|
+
p result
|
315
423
|
rescue Wire4Client::ApiError => e
|
316
424
|
puts "Exception when calling CuentasDeBeneficiariosSPEIApi->update_amount_limit_account_using_put: #{e}"
|
317
425
|
end
|
@@ -321,17 +429,18 @@ end
|
|
321
429
|
|
322
430
|
Name | Type | Description | Notes
|
323
431
|
------------- | ------------- | ------------- | -------------
|
324
|
-
**
|
325
|
-
**
|
326
|
-
**
|
432
|
+
**authorization** | **String**| Header para token |
|
433
|
+
**account** | **String**| Es la cuenta que va a ser actualizada. |
|
434
|
+
**request_dto** | [**AmountRequest**](AmountRequest.md)| Información de la cuenta y el monto límite a actualizar. |
|
435
|
+
**subscription** | **String**| Es el identificador de la suscripción a esta API. |
|
327
436
|
|
328
437
|
### Return type
|
329
438
|
|
330
|
-
|
439
|
+
[**TokenRequiredResponse**](TokenRequiredResponse.md)
|
331
440
|
|
332
441
|
### Authorization
|
333
442
|
|
334
|
-
|
443
|
+
No authorization required
|
335
444
|
|
336
445
|
### HTTP request headers
|
337
446
|
|