wire4_client 1.0.5 → 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 +52 -31
- data/docs/Account.md +11 -11
- data/docs/AccountReassigned.md +14 -14
- data/docs/AccountRequest.md +3 -3
- data/docs/AccountResponse.md +13 -13
- data/docs/AccountSpid.md +11 -11
- data/docs/AmountRequest.md +5 -5
- data/docs/AuthorizationTransactionGroup.md +2 -2
- data/docs/AuthorizedBeneficiariesResponse.md +3 -3
- data/docs/AutorizacinDeDepsitosApi.md +113 -0
- data/docs/Balance.md +3 -3
- data/docs/BalanceListResponse.md +1 -1
- data/docs/BeneficiariesQueryRegisterStatus.md +2 -2
- 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 +4 -4
- data/docs/CodiCodeQrResponseDTO.md +10 -10
- data/docs/CodiOperationResponseDTO.md +7 -7
- data/docs/CodiOperationsFiltersRequestDTO.md +8 -8
- data/docs/CompanyRegistered.md +6 -6
- data/docs/CompanyRequested.md +4 -4
- data/docs/ConfigurationsLimits.md +9 -0
- data/docs/ContactRequest.md +5 -5
- data/docs/ContractsDetailsApi.md +55 -0
- data/docs/CuentasDeBeneficiariosSPEIApi.md +54 -54
- data/docs/CuentasDeBeneficiariosSPIDApi.md +24 -22
- data/docs/Deposit.md +21 -21
- data/docs/DepositAuthorizationRequest.md +10 -0
- data/docs/Depositant.md +5 -5
- data/docs/DepositantesApi.md +6 -6
- 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 +8 -8
- data/docs/GetDepositants.md +1 -1
- data/docs/InstitucionesApi.md +5 -3
- 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 +19 -19
- data/docs/MessageCodiAction.md +12 -12
- data/docs/MessageConfigurationsLimits.md +8 -0
- data/docs/MessageDepositAuthorizationRequest.md +27 -0
- data/docs/MessageDepositReceived.md +21 -21
- data/docs/MessageInstitution.md +4 -4
- data/docs/MessagePayment.md +20 -20
- data/docs/MessagePaymentStatePending.md +16 -16
- data/docs/MessageRequestChanged.md +2 -2
- data/docs/MessageSalesPoint.md +3 -3
- data/docs/MessageSubscription.md +6 -6
- data/docs/MessageUserAuthorized.md +7 -6
- data/docs/MessageWebHook.md +9 -9
- data/docs/OperacionesCoDiApi.md +12 -12
- data/docs/Operations.md +8 -8
- data/docs/PagerResponseDto.md +6 -6
- data/docs/Payment.md +19 -19
- data/docs/PaymentCODI.md +13 -0
- data/docs/PaymentRequestCodiResponseDTO.md +11 -11
- data/docs/PeticionesDePagoPorCoDiApi.md +7 -7
- data/docs/PreEnrollmentData.md +2 -2
- data/docs/PreEnrollmentResponse.md +2 -2
- data/docs/PuntosDeVentaCoDiApi.md +14 -14
- data/docs/Relationship.md +2 -2
- data/docs/RelationshipsResponse.md +1 -1
- data/docs/SaldoApi.md +3 -3
- data/docs/SalesPointFound.md +7 -7
- data/docs/SalesPointRequest.md +4 -4
- data/docs/SalesPointRespose.md +4 -4
- data/docs/ServiceBanking.md +9 -0
- data/docs/SpidBeneficiariesResponse.md +1 -1
- data/docs/SpidBeneficiaryResponse.md +11 -11
- data/docs/SpidClassificationDTO.md +2 -2
- data/docs/SubscriptionChangeStatusRequest.md +8 -0
- data/docs/SuscripcionesApi.md +123 -16
- data/docs/TokenRequiredResponse.md +2 -2
- data/docs/TransactionErrorCode.md +10 -0
- data/docs/TransactionOutgoingSpid.md +10 -10
- data/docs/TransactionsOutgoingRegister.md +3 -3
- data/docs/TransferenciasSPEIApi.md +31 -31
- data/docs/TransferenciasSPIDApi.md +12 -12
- data/docs/UpdateConfigurationsRequestDTO.md +8 -0
- data/docs/UrlsRedirect.md +2 -2
- data/docs/UseServiceBanking.md +9 -0
- data/docs/WebHookDepositAuthorizationRequest.md +9 -0
- data/docs/WebHookDepositAuthorizationResponse.md +13 -0
- data/docs/Webhook.md +6 -6
- data/docs/WebhookRequest.md +3 -3
- data/docs/WebhookResponse.md +5 -5
- data/docs/WebhooksApi.md +10 -10
- data/lib/wire4_client.rb +18 -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 +1 -1
- data/lib/wire4_client/api/contacto_api.rb +1 -1
- data/lib/wire4_client/api/contracts_details_api.rb +72 -1
- data/lib/wire4_client/api/cuentas_de_beneficiarios_spei_api.rb +57 -57
- data/lib/wire4_client/api/cuentas_de_beneficiarios_spid_api.rb +25 -23
- data/lib/wire4_client/api/depositantes_api.rb +9 -9
- data/lib/wire4_client/api/empresas_co_di_api.rb +9 -9
- data/lib/wire4_client/api/facturas_api.rb +1 -1
- data/lib/wire4_client/api/instituciones_api.rb +5 -3
- data/lib/wire4_client/api/lmites_de_montos_api.rb +160 -0
- data/lib/wire4_client/api/operaciones_co_di_api.rb +13 -13
- data/lib/wire4_client/api/peticiones_de_pago_por_co_di_api.rb +7 -7
- data/lib/wire4_client/api/puntos_de_venta_co_di_api.rb +15 -15
- data/lib/wire4_client/api/saldo_api.rb +5 -5
- data/lib/wire4_client/api/suscripciones_api.rb +150 -17
- data/lib/wire4_client/api/transferencias_spei_api.rb +41 -41
- data/lib/wire4_client/api/transferencias_spid_api.rb +13 -13
- data/lib/wire4_client/api/webhooks_api.rb +16 -16
- data/lib/wire4_client/api_client.rb +1 -1
- data/lib/wire4_client/api_error.rb +1 -1
- data/lib/wire4_client/configuration.rb +1 -1
- data/lib/wire4_client/models/account.rb +12 -12
- data/lib/wire4_client/models/account_detail.rb +2 -2
- data/lib/wire4_client/models/account_reassigned.rb +16 -16
- data/lib/wire4_client/models/account_request.rb +4 -4
- data/lib/wire4_client/models/account_response.rb +15 -15
- data/lib/wire4_client/models/account_spid.rb +60 -12
- data/lib/wire4_client/models/address_company.rb +1 -1
- data/lib/wire4_client/models/amount_request.rb +7 -7
- data/lib/wire4_client/models/authorization_transaction_group.rb +3 -3
- data/lib/wire4_client/models/authorized_beneficiaries_response.rb +4 -4
- data/lib/wire4_client/models/authorized_users.rb +1 -1
- 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 +3 -3
- 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 +6 -6
- data/lib/wire4_client/models/codi_code_qr_response_dto.rb +11 -11
- data/lib/wire4_client/models/codi_code_request_dto.rb +1 -1
- data/lib/wire4_client/models/codi_operation_response_dto.rb +8 -8
- data/lib/wire4_client/models/codi_operations_filters_request_dto.rb +9 -9
- data/lib/wire4_client/models/company_registered.rb +7 -7
- data/lib/wire4_client/models/company_requested.rb +6 -6
- data/lib/wire4_client/models/compay.rb +1 -1
- 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 +1 -1
- data/lib/wire4_client/models/contract_detail_response.rb +1 -1
- data/lib/wire4_client/models/deposit.rb +22 -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 +21 -21
- data/lib/wire4_client/models/message_codi_action.rb +14 -14
- 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 +23 -23
- data/lib/wire4_client/models/message_institution.rb +6 -6
- data/lib/wire4_client/models/message_payment.rb +22 -22
- data/lib/wire4_client/models/message_payment_state_pending.rb +18 -18
- data/lib/wire4_client/models/message_request_changed.rb +4 -4
- data/lib/wire4_client/models/message_sales_point.rb +5 -5
- data/lib/wire4_client/models/message_subscription.rb +8 -8
- data/lib/wire4_client/models/message_user_authorized.rb +22 -12
- data/lib/wire4_client/models/message_web_hook.rb +11 -11
- data/lib/wire4_client/models/operations.rb +10 -10
- data/lib/wire4_client/models/pager_response_dto.rb +7 -7
- data/lib/wire4_client/models/payment.rb +20 -20
- data/lib/wire4_client/models/payment_codi.rb +269 -0
- data/lib/wire4_client/models/payment_request_codi_response_dto.rb +12 -12
- data/lib/wire4_client/models/payments_request_id.rb +1 -1
- 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 +1 -1
- 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 +1 -1
- data/lib/wire4_client/models/sales_point_found.rb +11 -11
- data/lib/wire4_client/models/sales_point_request.rb +6 -6
- data/lib/wire4_client/models/sales_point_respose.rb +6 -6
- data/lib/wire4_client/models/service_banking.rb +193 -0
- data/lib/wire4_client/models/spid_beneficiaries_response.rb +2 -2
- data/lib/wire4_client/models/spid_beneficiary_response.rb +12 -12
- 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 +1 -1
- 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 +60 -4
- data/lib/wire4_client/models/use_service_banking.rb +251 -0
- data/lib/wire4_client/models/user_company.rb +1 -1
- data/lib/wire4_client/models/web_hook_deposit_authorization_request.rb +195 -0
- data/lib/wire4_client/models/{timestamp.rb → web_hook_deposit_authorization_response.rb} +48 -75
- data/lib/wire4_client/models/webhook.rb +8 -8
- 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 +1 -1
- data/spec/api/contacto_api_spec.rb +1 -1
- data/spec/api/contracts_details_api_spec.rb +15 -1
- data/spec/api/cuentas_de_beneficiarios_spei_api_spec.rb +29 -29
- data/spec/api/cuentas_de_beneficiarios_spid_api_spec.rb +13 -12
- data/spec/api/depositantes_api_spec.rb +5 -5
- data/spec/api/empresas_co_di_api_spec.rb +5 -5
- data/spec/api/facturas_api_spec.rb +1 -1
- data/spec/api/instituciones_api_spec.rb +3 -2
- data/spec/api/lmites_de_montos_api_spec.rb +62 -0
- data/spec/api/operaciones_co_di_api_spec.rb +7 -7
- data/spec/api/peticiones_de_pago_por_co_di_api_spec.rb +4 -4
- data/spec/api/puntos_de_venta_co_di_api_spec.rb +8 -8
- data/spec/api/saldo_api_spec.rb +3 -3
- data/spec/api/suscripciones_api_spec.rb +37 -9
- data/spec/api/transferencias_spei_api_spec.rb +17 -17
- data/spec/api/transferencias_spid_api_spec.rb +7 -7
- data/spec/api/webhooks_api_spec.rb +5 -5
- data/spec/api_client_spec.rb +1 -1
- data/spec/configuration_spec.rb +1 -1
- data/spec/models/account_detail_spec.rb +1 -1
- data/spec/models/account_reassigned_spec.rb +1 -1
- data/spec/models/account_request_spec.rb +1 -1
- data/spec/models/account_response_spec.rb +1 -1
- data/spec/models/account_spec.rb +1 -1
- data/spec/models/account_spid_spec.rb +1 -1
- data/spec/models/address_company_spec.rb +1 -1
- data/spec/models/amount_request_spec.rb +1 -1
- data/spec/models/authorization_transaction_group_spec.rb +1 -1
- data/spec/models/authorized_beneficiaries_response_spec.rb +1 -1
- data/spec/models/authorized_users_spec.rb +1 -1
- 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 +1 -1
- 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 +1 -1
- data/spec/models/codi_code_qr_response_dto_spec.rb +1 -1
- data/spec/models/codi_code_request_dto_spec.rb +1 -1
- data/spec/models/codi_operation_response_dto_spec.rb +1 -1
- data/spec/models/codi_operations_filters_request_dto_spec.rb +1 -1
- data/spec/models/company_registered_spec.rb +1 -1
- data/spec/models/company_requested_spec.rb +1 -1
- data/spec/models/compay_spec.rb +1 -1
- 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 +1 -1
- data/spec/models/contract_detail_response_spec.rb +1 -1
- data/spec/models/deposit_authorization_request_spec.rb +53 -0
- data/spec/models/deposit_spec.rb +1 -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 +1 -1
- 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 +1 -1
- data/spec/models/message_institution_spec.rb +1 -1
- data/spec/models/message_payment_spec.rb +1 -1
- data/spec/models/message_payment_state_pending_spec.rb +1 -1
- data/spec/models/message_request_changed_spec.rb +1 -1
- data/spec/models/message_sales_point_spec.rb +1 -1
- data/spec/models/message_subscription_spec.rb +1 -1
- data/spec/models/message_user_authorized_spec.rb +7 -1
- data/spec/models/message_web_hook_spec.rb +1 -1
- data/spec/models/operations_spec.rb +1 -1
- data/spec/models/pager_response_dto_spec.rb +1 -1
- data/spec/models/{timestamp_spec.rb → payment_codi_spec.rb} +17 -37
- data/spec/models/payment_request_codi_response_dto_spec.rb +1 -1
- data/spec/models/payment_spec.rb +1 -1
- data/spec/models/payments_request_id_spec.rb +1 -1
- 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 +1 -1
- 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 +1 -1
- data/spec/models/sales_point_request_spec.rb +1 -1
- data/spec/models/sales_point_respose_spec.rb +1 -1
- data/spec/models/sales_point_spec.rb +1 -1
- data/spec/models/service_banking_spec.rb +47 -0
- data/spec/models/spid_beneficiaries_response_spec.rb +1 -1
- data/spec/models/spid_beneficiary_response_spec.rb +1 -1
- 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 +1 -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 +1 -1
- data/spec/models/use_service_banking_spec.rb +55 -0
- data/spec/models/user_company_spec.rb +1 -1
- 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 +1 -1
- data/spec/models/webhooks_list_spec.rb +1 -1
- data/spec/spec_helper.rb +1 -1
- data/wire4_client.gemspec +2 -2
- metadata +72 -8
- data/docs/Timestamp.md +0 -17
@@ -3,7 +3,7 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**request_id** | **String** |
|
7
|
-
**url** | **String** |
|
6
|
+
**request_id** | **String** | Es el identificador público generado para la petición (solicitud). | [optional]
|
7
|
+
**url** | **String** | Es la dirección URL generada para confirmación de la operación. Es para ingresar al centro de autorización. | [optional]
|
8
8
|
|
9
9
|
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# Wire4Client::TransactionErrorCode
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**code** | **String** | | [optional]
|
7
|
+
**error** | **String** | | [optional]
|
8
|
+
**order_id** | **String** | | [optional]
|
9
|
+
|
10
|
+
|
@@ -3,15 +3,15 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**amount** | **Float** |
|
7
|
-
**beneficiary_account** | **String** | Cuenta del beneficiario, podría ser un
|
8
|
-
**cancel_return_url** | **String** |
|
9
|
-
**classification_id** | **String** |
|
10
|
-
**currency_code** | **String** | Código de moneda en la que opera la cuenta |
|
11
|
-
**email** | **Array<String>** | Lista de email del beneficiario
|
12
|
-
**numeric_reference_spid** | **Integer** |
|
13
|
-
**order_id** | **String** |
|
14
|
-
**payment_concept_spid** | **String** |
|
15
|
-
**return_url** | **String** |
|
6
|
+
**amount** | **Float** | Es el monto de la transferencia. Se valida que sean máximo 20 dígitos y 2 decimales. Ejemplo 1000.00 |
|
7
|
+
**beneficiary_account** | **String** | Cuenta del beneficiario, podría ser un número celular (10dígitos), tarjeta de débito (TDD) o Cuenta CLABE interbancaria (18 dígitos). |
|
8
|
+
**cancel_return_url** | **String** | Es la dirección URL a la que se redirigirá en caso de que el usario cancele el registro. |
|
9
|
+
**classification_id** | **String** | Es el identificador de la clasificación de la transferencia SPID. |
|
10
|
+
**currency_code** | **String** | Código de moneda en la que opera la cuenta. |
|
11
|
+
**email** | **Array<String>** | Lista de correo electrónico (email) del beneficiario. Este campo es opcional. | [optional]
|
12
|
+
**numeric_reference_spid** | **Integer** | Es la referencia numérica de la transferencia. |
|
13
|
+
**order_id** | **String** | Es la referencia de la transferencia asignada por el cliente. Ejemplo: dae9c6ae-8c7a-42e8-99f4-ebe90566efae |
|
14
|
+
**payment_concept_spid** | **String** | Es el concepto de la transferencia. |
|
15
|
+
**return_url** | **String** | Es la dirección URL a la que se redirigirá en caso de éxito. |
|
16
16
|
|
17
17
|
|
@@ -3,8 +3,8 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**cancel_return_url** | **String** |
|
7
|
-
**return_url** | **String** |
|
8
|
-
**transactions** | [**Array<TransactionOutgoing>**](TransactionOutgoing.md) | Lista de transferencias de salida que se enviarán a Monex |
|
6
|
+
**cancel_return_url** | **String** | Es la dirección URL a la que se redirigirá en caso de que el usuario cancele. |
|
7
|
+
**return_url** | **String** | Es la dirección URL a la que se redirigirá en caso de éxito. |
|
8
|
+
**transactions** | [**Array<TransactionOutgoing>**](TransactionOutgoing.md) | Lista de transferencias de salida que se enviarán a Monex. |
|
9
9
|
|
10
10
|
|
@@ -4,7 +4,7 @@ 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
|
-
[**create_authorization_transactions_group**](TransferenciasSPEIApi.md#create_authorization_transactions_group) | **POST** /subscriptions/{subscription}/transactions/group | Agrupa
|
7
|
+
[**create_authorization_transactions_group**](TransferenciasSPEIApi.md#create_authorization_transactions_group) | **POST** /subscriptions/{subscription}/transactions/group | Agrupa transacciones bajo un request_id
|
8
8
|
[**drop_transactions_pending_using_delete**](TransferenciasSPEIApi.md#drop_transactions_pending_using_delete) | **DELETE** /subscriptions/{subscription}/transactions/outcoming/spei/request/{requestId} | Eliminación de transferencias SPEI® pendientes
|
9
9
|
[**incoming_spei_transactions_report_using_get**](TransferenciasSPEIApi.md#incoming_spei_transactions_report_using_get) | **GET** /subscriptions/{subscription}/transactions/incoming/spei | Consulta de transferencias recibidas
|
10
10
|
[**out_comming_spei_request_id_transactions_report_using_get**](TransferenciasSPEIApi.md#out_comming_spei_request_id_transactions_report_using_get) | **GET** /subscriptions/{subscription}/transactions/outcoming/spei/{requestId} | Consulta de transferencias de salida por identificador de petición
|
@@ -13,11 +13,11 @@ Method | HTTP request | Description
|
|
13
13
|
|
14
14
|
|
15
15
|
# **create_authorization_transactions_group**
|
16
|
-
> TokenRequiredResponse create_authorization_transactions_group(authorization,
|
16
|
+
> TokenRequiredResponse create_authorization_transactions_group(authorization, subscription, subscription2)
|
17
17
|
|
18
|
-
Agrupa
|
18
|
+
Agrupa transacciones bajo un request_id
|
19
19
|
|
20
|
-
Agrupa transacciones SPEI/SPID en un transaction_id,
|
20
|
+
Agrupa transacciones SPEI/SPID en un mismo transaction_id, posteriormente genera la dirección URL del centro de autorización para la confirmación de las transacciones. <br><br>Las transacciones deben estar en estatus PENDING y pertenecer a un mismo contrato.
|
21
21
|
|
22
22
|
### Example
|
23
23
|
```ruby
|
@@ -28,14 +28,14 @@ api_instance = Wire4Client::TransferenciasSPEIApi.new
|
|
28
28
|
|
29
29
|
authorization = 'authorization_example' # String | Header para token
|
30
30
|
|
31
|
-
|
31
|
+
subscription = 'subscription_example' # String | Es el Identificador de la suscripción.
|
32
32
|
|
33
|
-
|
33
|
+
subscription2 = Wire4Client::AuthorizationTransactionGroup.new # AuthorizationTransactionGroup | Objeto con la información para agrupar transacciones existentes y autorizarlas de forma conjunta.
|
34
34
|
|
35
35
|
|
36
36
|
begin
|
37
|
-
#Agrupa
|
38
|
-
result = api_instance.create_authorization_transactions_group(authorization,
|
37
|
+
#Agrupa transacciones bajo un request_id
|
38
|
+
result = api_instance.create_authorization_transactions_group(authorization, subscription, subscription2)
|
39
39
|
p result
|
40
40
|
rescue Wire4Client::ApiError => e
|
41
41
|
puts "Exception when calling TransferenciasSPEIApi->create_authorization_transactions_group: #{e}"
|
@@ -47,8 +47,8 @@ end
|
|
47
47
|
Name | Type | Description | Notes
|
48
48
|
------------- | ------------- | ------------- | -------------
|
49
49
|
**authorization** | **String**| Header para token |
|
50
|
-
**
|
51
|
-
**
|
50
|
+
**subscription** | **String**| Es el Identificador de la suscripción. |
|
51
|
+
**subscription2** | [**AuthorizationTransactionGroup**](AuthorizationTransactionGroup.md)| Objeto con la información para agrupar transacciones existentes y autorizarlas de forma conjunta. |
|
52
52
|
|
53
53
|
### Return type
|
54
54
|
|
@@ -70,7 +70,7 @@ No authorization required
|
|
70
70
|
|
71
71
|
Eliminación de transferencias SPEI® pendientes
|
72
72
|
|
73
|
-
Elimina un conjunto de transferencias
|
73
|
+
Elimina un conjunto de transferencias en estado pendiente de confirmar o autorizar, en la cuenta del cliente Monex relacionada a la suscripción.<br><br><b>Nota:</b> Las transferencias no deben haber sido confirmadas o autorizadas por el cliente.
|
74
74
|
|
75
75
|
### Example
|
76
76
|
```ruby
|
@@ -81,12 +81,12 @@ api_instance = Wire4Client::TransferenciasSPEIApi.new
|
|
81
81
|
|
82
82
|
authorization = 'authorization_example' # String | Header para token
|
83
83
|
|
84
|
-
request_id = 'request_id_example' # String | Identificador de las transferencias a eliminar
|
84
|
+
request_id = 'request_id_example' # String | Identificador de las transferencias a eliminar.
|
85
85
|
|
86
|
-
subscription = 'subscription_example' # String |
|
86
|
+
subscription = 'subscription_example' # String | Es el identificador de la suscripción a esta API.
|
87
87
|
|
88
88
|
opts = {
|
89
|
-
order_id: 'order_id_example' # String | Listado de identificadores dentro del request_id para eliminar
|
89
|
+
order_id: 'order_id_example' # String | Listado de identificadores dentro del request_id para eliminar.
|
90
90
|
}
|
91
91
|
|
92
92
|
begin
|
@@ -102,9 +102,9 @@ end
|
|
102
102
|
Name | Type | Description | Notes
|
103
103
|
------------- | ------------- | ------------- | -------------
|
104
104
|
**authorization** | **String**| Header para token |
|
105
|
-
**request_id** | **String**| Identificador de las transferencias a eliminar |
|
106
|
-
**subscription** | **String**|
|
107
|
-
**order_id** | **String**| Listado de identificadores dentro del request_id para eliminar | [optional]
|
105
|
+
**request_id** | **String**| Identificador de las transferencias a eliminar. |
|
106
|
+
**subscription** | **String**| Es el identificador de la suscripción a esta API. |
|
107
|
+
**order_id** | **String**| Listado de identificadores dentro del request_id para eliminar. | [optional]
|
108
108
|
|
109
109
|
### Return type
|
110
110
|
|
@@ -137,7 +137,7 @@ api_instance = Wire4Client::TransferenciasSPEIApi.new
|
|
137
137
|
|
138
138
|
authorization = 'authorization_example' # String | Header para token
|
139
139
|
|
140
|
-
subscription = 'subscription_example' # String |
|
140
|
+
subscription = 'subscription_example' # String | Es el identificador de la suscripción a esta API.
|
141
141
|
|
142
142
|
|
143
143
|
begin
|
@@ -154,7 +154,7 @@ end
|
|
154
154
|
Name | Type | Description | Notes
|
155
155
|
------------- | ------------- | ------------- | -------------
|
156
156
|
**authorization** | **String**| Header para token |
|
157
|
-
**subscription** | **String**|
|
157
|
+
**subscription** | **String**| Es el identificador de la suscripción a esta API. |
|
158
158
|
|
159
159
|
### Return type
|
160
160
|
|
@@ -176,7 +176,7 @@ No authorization required
|
|
176
176
|
|
177
177
|
Consulta de transferencias de salida por identificador de petición
|
178
178
|
|
179
|
-
Consulta las transferencias de salida registradas en una petición, las transferencias que regresa este recuso son únicamente las transferencias de salida agrupadas al identificador de la petición que se generó al hacer el registro de las transacciones el
|
179
|
+
Consulta las transferencias de salida registradas en una petición, las transferencias que regresa este recuso son únicamente las transferencias de salida agrupadas al identificador de la petición que se generó al hacer el registro de las transacciones el cuál se debe especificar como parte del path de este endpoint.
|
180
180
|
|
181
181
|
### Example
|
182
182
|
```ruby
|
@@ -187,9 +187,9 @@ api_instance = Wire4Client::TransferenciasSPEIApi.new
|
|
187
187
|
|
188
188
|
authorization = 'authorization_example' # String | Header para token
|
189
189
|
|
190
|
-
request_id = 'request_id_example' # String | Identificador de la petición a buscar
|
190
|
+
request_id = 'request_id_example' # String | Identificador de la petición a buscar.
|
191
191
|
|
192
|
-
subscription = 'subscription_example' # String |
|
192
|
+
subscription = 'subscription_example' # String | Es el identificador de la suscripción a esta API.
|
193
193
|
|
194
194
|
|
195
195
|
begin
|
@@ -206,8 +206,8 @@ end
|
|
206
206
|
Name | Type | Description | Notes
|
207
207
|
------------- | ------------- | ------------- | -------------
|
208
208
|
**authorization** | **String**| Header para token |
|
209
|
-
**request_id** | **String**| Identificador de la petición a buscar |
|
210
|
-
**subscription** | **String**|
|
209
|
+
**request_id** | **String**| Identificador de la petición a buscar. |
|
210
|
+
**subscription** | **String**| Es el identificador de la suscripción a esta API. |
|
211
211
|
|
212
212
|
### Return type
|
213
213
|
|
@@ -240,10 +240,10 @@ api_instance = Wire4Client::TransferenciasSPEIApi.new
|
|
240
240
|
|
241
241
|
authorization = 'authorization_example' # String | Header para token
|
242
242
|
|
243
|
-
subscription = 'subscription_example' # String |
|
243
|
+
subscription = 'subscription_example' # String | Es el identificador de la suscripción a esta API.
|
244
244
|
|
245
245
|
opts = {
|
246
|
-
order_id: 'order_id_example' # String |
|
246
|
+
order_id: 'order_id_example' # String | Es el identificador de la orden a buscar.
|
247
247
|
}
|
248
248
|
|
249
249
|
begin
|
@@ -260,8 +260,8 @@ end
|
|
260
260
|
Name | Type | Description | Notes
|
261
261
|
------------- | ------------- | ------------- | -------------
|
262
262
|
**authorization** | **String**| Header para token |
|
263
|
-
**subscription** | **String**|
|
264
|
-
**order_id** | **String**|
|
263
|
+
**subscription** | **String**| Es el identificador de la suscripción a esta API. |
|
264
|
+
**order_id** | **String**| Es el identificador de la orden a buscar. | [optional]
|
265
265
|
|
266
266
|
### Return type
|
267
267
|
|
@@ -283,7 +283,7 @@ No authorization required
|
|
283
283
|
|
284
284
|
Registro de transferencias
|
285
285
|
|
286
|
-
|
286
|
+
Se registra un conjunto de transferencias (una o más) a realizar en la cuenta del cliente Monex relacionada a la suscripción. En la respuesta se proporcionará una dirección URL que lo llevará al centro de autorización para que las transferencias sean confirmadas (autorizadas) por el cliente para que se efectúen, para ello debe ingresar la llave electrónica (Token).<br> Nota: Debe considerar que el concepto de cada una de las transacciones solo debe contener caracteres alfanuméricos por lo que en caso de que se reciban caracteres como ñ o acentos serán sustituidos por n o en su caso por la letra sin acento. Los caracteres no alfanuméricos como pueden ser caracteres especiales serán eliminados.
|
287
287
|
|
288
288
|
### Example
|
289
289
|
```ruby
|
@@ -294,7 +294,7 @@ api_instance = Wire4Client::TransferenciasSPEIApi.new
|
|
294
294
|
|
295
295
|
authorization = 'authorization_example' # String | Header para token
|
296
296
|
|
297
|
-
subscription = 'subscription_example' # String |
|
297
|
+
subscription = 'subscription_example' # String | Es el identificador de la suscripción a esta API.
|
298
298
|
|
299
299
|
transactions = Wire4Client::TransactionsOutgoingRegister.new # TransactionsOutgoingRegister | Información de las transferencias SPEI de salida
|
300
300
|
|
@@ -313,7 +313,7 @@ end
|
|
313
313
|
Name | Type | Description | Notes
|
314
314
|
------------- | ------------- | ------------- | -------------
|
315
315
|
**authorization** | **String**| Header para token |
|
316
|
-
**subscription** | **String**|
|
316
|
+
**subscription** | **String**| Es el identificador de la suscripción a esta API. |
|
317
317
|
**transactions** | [**TransactionsOutgoingRegister**](TransactionsOutgoingRegister.md)| Información de las transferencias SPEI de salida |
|
318
318
|
|
319
319
|
### Return type
|
@@ -4,16 +4,16 @@ 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
|
-
[**get_spid_classifications_using_get**](TransferenciasSPIDApi.md#get_spid_classifications_using_get) | **GET** /subscriptions/{subscription}/beneficiaries/spid/classifications | Consulta
|
8
|
-
[**register_outgoing_spid_transaction_using_post**](TransferenciasSPIDApi.md#register_outgoing_spid_transaction_using_post) | **POST** /subscriptions/{subscription}/transactions/outcoming/spid | Registro de transferencias SPID
|
7
|
+
[**get_spid_classifications_using_get**](TransferenciasSPIDApi.md#get_spid_classifications_using_get) | **GET** /subscriptions/{subscription}/beneficiaries/spid/classifications | Consulta de clasificaciones para operaciones SPID®
|
8
|
+
[**register_outgoing_spid_transaction_using_post**](TransferenciasSPIDApi.md#register_outgoing_spid_transaction_using_post) | **POST** /subscriptions/{subscription}/transactions/outcoming/spid | Registro de transferencias SPID®
|
9
9
|
|
10
10
|
|
11
11
|
# **get_spid_classifications_using_get**
|
12
12
|
> SpidClassificationsResponseDTO get_spid_classifications_using_get(authorization, subscription)
|
13
13
|
|
14
|
-
Consulta
|
14
|
+
Consulta de clasificaciones para operaciones SPID®
|
15
15
|
|
16
|
-
Obtiene las clasificaciones para operaciones con dólares (SPID) de Monex.<br/>Este recurso se debe invocar previo al realizar una operación SPID.<br/>
|
16
|
+
Obtiene las clasificaciones para operaciones con dólares (SPID®) de Monex.<br/><br/>Este recurso se debe invocar previo al realizar una operación SPID.<br/><br/>
|
17
17
|
|
18
18
|
### Example
|
19
19
|
```ruby
|
@@ -24,11 +24,11 @@ api_instance = Wire4Client::TransferenciasSPIDApi.new
|
|
24
24
|
|
25
25
|
authorization = 'authorization_example' # String | Header para token
|
26
26
|
|
27
|
-
subscription = 'subscription_example' # String |
|
27
|
+
subscription = 'subscription_example' # String | Es el identificador de la suscripción a esta API.
|
28
28
|
|
29
29
|
|
30
30
|
begin
|
31
|
-
#Consulta
|
31
|
+
#Consulta de clasificaciones para operaciones SPID®
|
32
32
|
result = api_instance.get_spid_classifications_using_get(authorization, subscription)
|
33
33
|
p result
|
34
34
|
rescue Wire4Client::ApiError => e
|
@@ -41,7 +41,7 @@ end
|
|
41
41
|
Name | Type | Description | Notes
|
42
42
|
------------- | ------------- | ------------- | -------------
|
43
43
|
**authorization** | **String**| Header para token |
|
44
|
-
**subscription** | **String**|
|
44
|
+
**subscription** | **String**| Es el identificador de la suscripción a esta API. |
|
45
45
|
|
46
46
|
### Return type
|
47
47
|
|
@@ -61,9 +61,9 @@ No authorization required
|
|
61
61
|
# **register_outgoing_spid_transaction_using_post**
|
62
62
|
> TokenRequiredResponse register_outgoing_spid_transaction_using_post(authorization, subscription, transactions)
|
63
63
|
|
64
|
-
Registro de transferencias SPID
|
64
|
+
Registro de transferencias SPID®
|
65
65
|
|
66
|
-
Registra un conjunto de transferencias a realizar en la cuenta del cliente Monex relacionada a la suscripción
|
66
|
+
Registra un conjunto de transferencias a realizar en la cuenta del cliente Monex relacionada a la suscripción. En la respuesta se proporcionará una dirección URL que lo llevará al centro de autorización para que las transferencias sean confirmadas (autorizadas) por el cliente para que se efectúen, para ello debe ingresar la llave electrónica (Token).<br> Nota: Debe considerar que el concepto de cada una de las transacciones solo debe contener caracteres alfanuméricos por lo que en caso de que se reciban caracteres como ñ o acentos serán sustituidos por n o en su caso por la letra sin acento. Los caracteres no alfanuméricos como pueden ser caracteres especiales serán eliminados.
|
67
67
|
|
68
68
|
### Example
|
69
69
|
```ruby
|
@@ -74,13 +74,13 @@ api_instance = Wire4Client::TransferenciasSPIDApi.new
|
|
74
74
|
|
75
75
|
authorization = 'authorization_example' # String | Header para token
|
76
76
|
|
77
|
-
subscription = 'subscription_example' # String |
|
77
|
+
subscription = 'subscription_example' # String | Es el identificador de la suscripción a esta API.
|
78
78
|
|
79
79
|
transactions = Wire4Client::TransactionOutgoingSpid.new # TransactionOutgoingSpid | Información de las transferencias SPID de salida
|
80
80
|
|
81
81
|
|
82
82
|
begin
|
83
|
-
#Registro de transferencias SPID
|
83
|
+
#Registro de transferencias SPID®
|
84
84
|
result = api_instance.register_outgoing_spid_transaction_using_post(authorization, subscription, transactions)
|
85
85
|
p result
|
86
86
|
rescue Wire4Client::ApiError => e
|
@@ -93,7 +93,7 @@ end
|
|
93
93
|
Name | Type | Description | Notes
|
94
94
|
------------- | ------------- | ------------- | -------------
|
95
95
|
**authorization** | **String**| Header para token |
|
96
|
-
**subscription** | **String**|
|
96
|
+
**subscription** | **String**| Es el identificador de la suscripción a esta API. |
|
97
97
|
**transactions** | [**TransactionOutgoingSpid**](TransactionOutgoingSpid.md)| Información de las transferencias SPID de salida |
|
98
98
|
|
99
99
|
### Return type
|
@@ -0,0 +1,8 @@
|
|
1
|
+
# Wire4Client::UpdateConfigurationsRequestDTO
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**configurations** | [**Array<ConfigurationsLimits>**](ConfigurationsLimits.md) | Listado de configuraciones para actualizar |
|
7
|
+
|
8
|
+
|
data/docs/UrlsRedirect.md
CHANGED
@@ -3,7 +3,7 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**cancel_return_url** | **String** |
|
7
|
-
**return_url** | **String** |
|
6
|
+
**cancel_return_url** | **String** | Es la dirección URL a la que se redirigirá en caso de que el cliente cancele el registro. Se valida hasta 512 caracteres. |
|
7
|
+
**return_url** | **String** | Es la dirección URL a la que se redirigirá en caso exitoso. Se valida hasta 512 caracteres. |
|
8
8
|
|
9
9
|
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# Wire4Client::UseServiceBanking
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**status** | **String** | Estatus que se le asigna a la subscripción |
|
7
|
+
**use** | **String** | Uso que se le desea dar a la subscripción |
|
8
|
+
|
9
|
+
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# Wire4Client::WebHookDepositAuthorizationRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**name** | **String** | Es el nombre del webhook. | [optional]
|
7
|
+
**url** | **String** | Es la dirección URL a la cuál Wire4 enviará las notificaciones cuando un evento ocurra. | [optional]
|
8
|
+
|
9
|
+
|
@@ -0,0 +1,13 @@
|
|
1
|
+
# Wire4Client::WebHookDepositAuthorizationResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**events** | **Array<String>** | Tipo de evento manejado por el webhook, para mas referencia sobre los tipos de eventos soportados, revise la siguiente liga: <a href=\"https://developers.wire4.mx/#section/Eventos\">https://developers.wire4.mx/#section/Eventos.</a> | [optional]
|
7
|
+
**name** | **String** | Es el nombre del webhook. | [optional]
|
8
|
+
**secret** | **String** | Es la llave con la cuál se debe de identificar que el webhook fue enviado por Wire4. Para mayor información revisar la guía de notificaciones en la sección de <a href=\"https://wire4.mx/#/guides/notificaciones\">\"Comprobación de firmas de Webhook\".</a> | [optional]
|
9
|
+
**status** | **String** | Es el estado (estatus) en el que se encuentra el webhook. | [optional]
|
10
|
+
**url** | **String** | Es la dirección URL a la cuál Wire4 enviará las notificaciones cuando un evento ocurra. | [optional]
|
11
|
+
**wh_uuid** | **String** | Es el identificador del webhook. | [optional]
|
12
|
+
|
13
|
+
|
data/docs/Webhook.md
CHANGED
@@ -3,11 +3,11 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**events** | **Array<String>** | Tipo de evento manejado por el webhook
|
7
|
-
**name** | **String** |
|
8
|
-
**secret** | **String** |
|
9
|
-
**status** | **String** |
|
10
|
-
**url** | **String** | URL a la
|
11
|
-
**wh_id** | **String** |
|
6
|
+
**events** | **Array<String>** | Tipo de evento manejado por el webhook. Para más referencia sobre los tipos de eventos soportados, revise la siguiente liga: <a href=\"#section/Eventos\">https://developers.wire4.mx/#section/Eventos.</a> | [optional]
|
7
|
+
**name** | **String** | Es el nombre del webhook. | [optional]
|
8
|
+
**secret** | **String** | Es la llave con la que se debe de identificar que el webhook fue enviado por Wire4. Para mayor información revisar la guía de notificaciones en la sección de <a href=\"https://wire4.mx/#/guides/notificaciones\">\"Comprobación de firmas de Webhook\".</a> | [optional]
|
9
|
+
**status** | **String** | Estado (estatus) en el que se encuentra el webhook. | [optional]
|
10
|
+
**url** | **String** | Es la dirección URL a la que Wire4 enviará las notificaciones cuando un evento ocurra. | [optional]
|
11
|
+
**wh_id** | **String** | Es el identificador del webhook. | [optional]
|
12
12
|
|
13
13
|
|
data/docs/WebhookRequest.md
CHANGED
@@ -3,8 +3,8 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**events** | **Array<String>** |
|
7
|
-
**name** | **String** |
|
8
|
-
**url** | **String** | URL
|
6
|
+
**events** | **Array<String>** | Son los eventos para que Wire4 te envíe información. Para más información sobre los tipos de eventos soportados, revise la siguiente liga: <a href=\"#section/Eventos\">https://developers.wire4.mx/#section/Eventos</a>. |
|
7
|
+
**name** | **String** | Es el nombre del webhook. |
|
8
|
+
**url** | **String** | Es la dirección URL para que Wire4 envíe las notificaciones cuando un evento ocurra. |
|
9
9
|
|
10
10
|
|
data/docs/WebhookResponse.md
CHANGED
@@ -4,10 +4,10 @@
|
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
6
|
**events** | **Array<String>** | Tipos de eventos de los cuales Wire4 te enviará información. | [optional]
|
7
|
-
**name** | **String** |
|
8
|
-
**secret** | **String** | Llave con la cual se debe de identificar que el webhook fue enviado por Wire4, para mayor información revisar la guía de notificaciones (https://wire4.mx/#/guides/notificaciones),
|
9
|
-
**status** | **String** |
|
10
|
-
**url** | **String** | URL a la
|
11
|
-
**wh_uuid** | **String** |
|
7
|
+
**name** | **String** | Es el nombre del webhook. | [optional]
|
8
|
+
**secret** | **String** | Llave con la cual se debe de identificar que el webhook fue enviado por Wire4, para mayor información revisar la guía de notificaciones (https://wire4.mx/#/guides/notificaciones), en la sección de <a href=\"https://wire4.mx/#/guides/notificaciones\">\"Comprobación de firmas de Webhook\".</a> | [optional]
|
9
|
+
**status** | **String** | Es el estado (estatus) en el que se encuentra el webhook. | [optional]
|
10
|
+
**url** | **String** | Es la dirección URL a la que Wire4 enviará las notificaciones cuando un evento ocurra. | [optional]
|
11
|
+
**wh_uuid** | **String** | Es el identificador del webhook. Ejemplo: wh_54a832866f784b439bc625c0f4e04e12. | [optional]
|
12
12
|
|
13
13
|
|
data/docs/WebhooksApi.md
CHANGED
@@ -4,13 +4,13 @@ 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
|
-
[**get_webhook**](WebhooksApi.md#get_webhook) | **GET** /webhooks/{
|
8
|
-
[**get_webhooks**](WebhooksApi.md#get_webhooks) | **GET** /webhooks | Consulta de Webhooks
|
7
|
+
[**get_webhook**](WebhooksApi.md#get_webhook) | **GET** /webhooks/{webhook_id} | Consulta de Webhook
|
8
|
+
[**get_webhooks**](WebhooksApi.md#get_webhooks) | **GET** /webhooks | Consulta la lista de Webhooks
|
9
9
|
[**register_webhook**](WebhooksApi.md#register_webhook) | **POST** /webhooks | Alta de Webhook
|
10
10
|
|
11
11
|
|
12
12
|
# **get_webhook**
|
13
|
-
> WebhookResponse get_webhook(authorization,
|
13
|
+
> WebhookResponse get_webhook(authorization, webhook_id)
|
14
14
|
|
15
15
|
Consulta de Webhook
|
16
16
|
|
@@ -25,12 +25,12 @@ api_instance = Wire4Client::WebhooksApi.new
|
|
25
25
|
|
26
26
|
authorization = 'authorization_example' # String | Header para token
|
27
27
|
|
28
|
-
|
28
|
+
webhook_id = 'webhook_id_example' # String | Es el identificador del webhook. Ejemplo: wh_54a932866f784b439bc625c0f4e04e12
|
29
29
|
|
30
30
|
|
31
31
|
begin
|
32
32
|
#Consulta de Webhook
|
33
|
-
result = api_instance.get_webhook(authorization,
|
33
|
+
result = api_instance.get_webhook(authorization, webhook_id)
|
34
34
|
p result
|
35
35
|
rescue Wire4Client::ApiError => e
|
36
36
|
puts "Exception when calling WebhooksApi->get_webhook: #{e}"
|
@@ -42,7 +42,7 @@ end
|
|
42
42
|
Name | Type | Description | Notes
|
43
43
|
------------- | ------------- | ------------- | -------------
|
44
44
|
**authorization** | **String**| Header para token |
|
45
|
-
**
|
45
|
+
**webhook_id** | **String**| Es el identificador del webhook. Ejemplo: wh_54a932866f784b439bc625c0f4e04e12 |
|
46
46
|
|
47
47
|
### Return type
|
48
48
|
|
@@ -62,9 +62,9 @@ No authorization required
|
|
62
62
|
# **get_webhooks**
|
63
63
|
> WebhooksList get_webhooks(authorization)
|
64
64
|
|
65
|
-
Consulta de Webhooks
|
65
|
+
Consulta la lista de Webhooks
|
66
66
|
|
67
|
-
Obtiene los webhooks registrados en la plataforma que tengan estatus
|
67
|
+
Obtiene una lista de los webhooks registrados en la plataforma que tengan el estado (estatus) Activo (ACTIVE) e Inactivo (INACTIVE).
|
68
68
|
|
69
69
|
### Example
|
70
70
|
```ruby
|
@@ -77,7 +77,7 @@ authorization = 'authorization_example' # String | Header para token
|
|
77
77
|
|
78
78
|
|
79
79
|
begin
|
80
|
-
#Consulta de Webhooks
|
80
|
+
#Consulta la lista de Webhooks
|
81
81
|
result = api_instance.get_webhooks(authorization)
|
82
82
|
p result
|
83
83
|
rescue Wire4Client::ApiError => e
|
@@ -111,7 +111,7 @@ No authorization required
|
|
111
111
|
|
112
112
|
Alta de Webhook
|
113
113
|
|
114
|
-
Registra un webhook en la plataforma para su uso como notificador de eventos
|
114
|
+
Registra un webhook en la plataforma para su uso como notificador de eventos, cuándo estos ocurran.
|
115
115
|
|
116
116
|
### Example
|
117
117
|
```ruby
|