wire4_client 0.0.9.pre.TEST → 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/Gemfile.lock +69 -0
- data/README.md +15 -77
- data/docs/Account.md +3 -3
- data/docs/AccountResponse.md +3 -6
- data/docs/AmountRequest.md +0 -2
- data/docs/BillingTransaction.md +1 -1
- data/docs/CuentasDeBeneficiariosSPEIApi.md +8 -127
- data/docs/CuentasDeBeneficiariosSPIDApi.md +1 -11
- data/docs/Deposit.md +0 -1
- data/docs/MessageAccountBeneficiary.md +2 -2
- data/docs/MessageCEP.md +9 -9
- data/docs/MessageDepositReceived.md +0 -1
- data/docs/MessagePayment.md +1 -3
- data/docs/MessageSubscription.md +6 -6
- data/docs/MessageWebHook.md +2 -2
- data/docs/Payment.md +1 -3
- data/docs/SpidBeneficiaryResponse.md +0 -3
- data/docs/SuscripcionesApi.md +14 -14
- data/docs/Timestamp.md +17 -0
- data/docs/TransactionOutgoing.md +1 -2
- data/docs/TransferenciasSPEIApi.md +3 -61
- 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/cuentas_de_beneficiarios_spei_api.rb +10 -194
- data/lib/wire4_client/api/cuentas_de_beneficiarios_spid_api.rb +1 -16
- data/lib/wire4_client/api/depositantes_api.rb +1 -1
- data/lib/wire4_client/api/facturas_api.rb +1 -1
- data/lib/wire4_client/api/instituciones_api.rb +1 -1
- data/lib/wire4_client/api/saldo_api.rb +1 -1
- data/lib/wire4_client/api/suscripciones_api.rb +15 -15
- data/lib/wire4_client/api/transferencias_spei_api.rb +3 -85
- data/lib/wire4_client/api/transferencias_spid_api.rb +1 -1
- data/lib/wire4_client/api/webhooks_api.rb +1 -1
- 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 +4 -4
- data/lib/wire4_client/models/account_request.rb +1 -1
- data/lib/wire4_client/models/account_response.rb +8 -38
- data/lib/wire4_client/models/account_spid.rb +1 -1
- data/lib/wire4_client/models/amount_request.rb +5 -91
- data/lib/wire4_client/models/balance.rb +1 -1
- data/lib/wire4_client/models/balance_list_response.rb +1 -1
- data/lib/wire4_client/models/beneficiaries_response.rb +1 -1
- 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 +1 -1
- data/lib/wire4_client/models/cep_search_banxico.rb +1 -1
- data/lib/wire4_client/models/contact_request.rb +1 -1
- data/lib/wire4_client/models/deposit.rb +2 -12
- data/lib/wire4_client/models/depositant.rb +1 -1
- data/lib/wire4_client/models/depositants_register.rb +1 -1
- data/lib/wire4_client/models/depositants_response.rb +1 -1
- data/lib/wire4_client/models/error_response.rb +1 -1
- data/lib/wire4_client/models/get_depositants.rb +1 -1
- data/lib/wire4_client/models/institution.rb +1 -1
- data/lib/wire4_client/models/institutions_list.rb +1 -1
- data/lib/wire4_client/models/message_account_beneficiary.rb +3 -3
- data/lib/wire4_client/models/message_cep.rb +11 -11
- data/lib/wire4_client/models/message_deposit_received.rb +3 -13
- data/lib/wire4_client/models/message_institution.rb +1 -1
- data/lib/wire4_client/models/message_payment.rb +3 -24
- data/lib/wire4_client/models/message_subscription.rb +8 -8
- data/lib/wire4_client/models/message_web_hook.rb +3 -3
- data/lib/wire4_client/models/payment.rb +3 -23
- 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 +1 -1
- data/lib/wire4_client/models/pre_enrollment_response.rb +1 -1
- data/lib/wire4_client/models/relationship.rb +1 -1
- data/lib/wire4_client/models/relationships_response.rb +1 -1
- data/lib/wire4_client/models/spid_beneficiaries_response.rb +1 -1
- data/lib/wire4_client/models/spid_beneficiary_response.rb +5 -35
- data/lib/wire4_client/models/spid_classification_dto.rb +1 -1
- data/lib/wire4_client/models/spid_classifications_response_dto.rb +1 -1
- data/lib/wire4_client/models/{codi_operation_response_dto.rb → timestamp.rb} +72 -53
- data/lib/wire4_client/models/token_required_response.rb +1 -1
- data/lib/wire4_client/models/transaction_outgoing.rb +3 -13
- data/lib/wire4_client/models/transaction_outgoing_spid.rb +1 -1
- data/lib/wire4_client/models/transactions_outgoing_register.rb +1 -1
- data/lib/wire4_client/models/webhook_request.rb +1 -1
- data/lib/wire4_client/models/webhook_response.rb +1 -1
- data/lib/wire4_client/models/webhooks_list.rb +1 -1
- data/lib/wire4_client/version.rb +2 -2
- data/lib/wire4_client.rb +2 -53
- 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/cuentas_de_beneficiarios_spei_api_spec.rb +4 -37
- data/spec/api/cuentas_de_beneficiarios_spid_api_spec.rb +1 -6
- data/spec/api/depositantes_api_spec.rb +1 -1
- data/spec/api/facturas_api_spec.rb +1 -1
- data/spec/api/instituciones_api_spec.rb +1 -1
- data/spec/api/saldo_api_spec.rb +1 -1
- data/spec/api/suscripciones_api_spec.rb +8 -8
- data/spec/api/transferencias_spei_api_spec.rb +2 -17
- data/spec/api/transferencias_spid_api_spec.rb +1 -1
- data/spec/api/webhooks_api_spec.rb +1 -1
- data/spec/api_client_spec.rb +1 -1
- data/spec/configuration_spec.rb +1 -1
- data/spec/models/account_request_spec.rb +1 -1
- data/spec/models/account_response_spec.rb +1 -19
- data/spec/models/account_spec.rb +1 -1
- data/spec/models/account_spid_spec.rb +1 -1
- data/spec/models/amount_request_spec.rb +1 -13
- data/spec/models/balance_list_response_spec.rb +1 -1
- data/spec/models/balance_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/contact_request_spec.rb +1 -1
- data/spec/models/deposit_spec.rb +1 -7
- 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/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/message_account_beneficiary_spec.rb +1 -1
- data/spec/models/message_cep_spec.rb +1 -1
- data/spec/models/message_deposit_received_spec.rb +1 -7
- data/spec/models/message_institution_spec.rb +1 -1
- data/spec/models/message_payment_spec.rb +1 -13
- data/spec/models/message_subscription_spec.rb +1 -1
- data/spec/models/message_web_hook_spec.rb +1 -1
- data/spec/models/payment_spec.rb +1 -13
- 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/relationship_spec.rb +1 -1
- data/spec/models/relationships_response_spec.rb +1 -1
- data/spec/models/spid_beneficiaries_response_spec.rb +1 -1
- data/spec/models/spid_beneficiary_response_spec.rb +1 -19
- data/spec/models/spid_classification_dto_spec.rb +1 -1
- data/spec/models/spid_classifications_response_dto_spec.rb +1 -1
- data/spec/models/{address_company_spec.rb → timestamp_spec.rb} +17 -17
- data/spec/models/token_required_response_spec.rb +1 -1
- data/spec/models/transaction_outgoing_spec.rb +1 -7
- data/spec/models/transaction_outgoing_spid_spec.rb +1 -1
- data/spec/models/transactions_outgoing_register_spec.rb +1 -1
- data/spec/models/webhook_request_spec.rb +1 -1
- data/spec/models/webhook_response_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 +10 -214
- data/docs/AccountDetail.md +0 -13
- data/docs/AccountReassigned.md +0 -22
- data/docs/AddressCompany.md +0 -17
- data/docs/AuthorizationTransactionGroup.md +0 -9
- data/docs/AuthorizedBeneficiariesResponse.md +0 -10
- data/docs/AuthorizedUsers.md +0 -13
- data/docs/AutorizacinDeDepsitosApi.md +0 -113
- data/docs/BeneficiariesQueryRegisterStatus.md +0 -13
- data/docs/CertificateRequest.md +0 -11
- data/docs/CodiCodeQrResponseDTO.md +0 -17
- data/docs/CodiCodeRequestDTO.md +0 -14
- data/docs/CodiOperationResponseDTO.md +0 -14
- data/docs/CodiOperationsFiltersRequestDTO.md +0 -15
- data/docs/CompanyRegistered.md +0 -13
- data/docs/CompanyRequested.md +0 -11
- data/docs/Compay.md +0 -11
- data/docs/ConfigurationsLimits.md +0 -9
- data/docs/ContractDetailRequest.md +0 -11
- data/docs/ContractDetailResponse.md +0 -9
- data/docs/ContractsDetailsApi.md +0 -222
- data/docs/DepositAuthorizationRequest.md +0 -10
- data/docs/DepositsAuthorizationResponse.md +0 -10
- data/docs/DetailedErrorResponse.md +0 -10
- data/docs/EmpresasCoDiApi.md +0 -107
- data/docs/Item.md +0 -10
- data/docs/LmitesDeMontosApi.md +0 -112
- data/docs/MessageCodiAction.md +0 -19
- data/docs/MessageConfigurationsLimits.md +0 -8
- data/docs/MessageDepositAuthorizationRequest.md +0 -27
- data/docs/MessagePaymentStatePending.md +0 -23
- data/docs/MessageRequestChanged.md +0 -9
- data/docs/MessageSalesPoint.md +0 -10
- data/docs/MessageUserAuthorized.md +0 -14
- data/docs/OperacionesCoDiApi.md +0 -68
- data/docs/Operations.md +0 -17
- data/docs/PagerResponseDto.md +0 -13
- data/docs/PaymentCODI.md +0 -13
- data/docs/PaymentRequestCodiResponseDTO.md +0 -18
- data/docs/PeticionesDePagoPorCoDiApi.md +0 -116
- data/docs/PreMonexAuthorization.md +0 -11
- data/docs/PuntosDeVentaCoDiApi.md +0 -113
- data/docs/SalesPoint.md +0 -10
- data/docs/SalesPointFound.md +0 -14
- data/docs/SalesPointRequest.md +0 -11
- data/docs/SalesPointRespose.md +0 -11
- data/docs/TransactionErrorCode.md +0 -10
- data/docs/UpdateConfigurationsRequestDTO.md +0 -8
- data/docs/UrlsRedirect.md +0 -9
- data/docs/UserCompany.md +0 -16
- data/docs/WebHookDepositAuthorizationRequest.md +0 -9
- data/docs/WebHookDepositAuthorizationResponse.md +0 -13
- data/docs/Webhook.md +0 -13
- data/lib/wire4_client/api/autorizacin_de_depsitos_api.rb +0 -173
- data/lib/wire4_client/api/contracts_details_api.rb +0 -301
- data/lib/wire4_client/api/empresas_co_di_api.rb +0 -137
- data/lib/wire4_client/api/lmites_de_montos_api.rb +0 -160
- data/lib/wire4_client/api/operaciones_co_di_api.rb +0 -92
- data/lib/wire4_client/api/peticiones_de_pago_por_co_di_api.rb +0 -178
- data/lib/wire4_client/api/puntos_de_venta_co_di_api.rb +0 -151
- data/lib/wire4_client/models/account_detail.rb +0 -239
- data/lib/wire4_client/models/account_reassigned.rb +0 -385
- data/lib/wire4_client/models/address_company.rb +0 -275
- data/lib/wire4_client/models/authorization_transaction_group.rb +0 -207
- data/lib/wire4_client/models/authorized_beneficiaries_response.rb +0 -206
- data/lib/wire4_client/models/authorized_users.rb +0 -235
- data/lib/wire4_client/models/beneficiaries_query_register_status.rb +0 -270
- data/lib/wire4_client/models/certificate_request.rb +0 -248
- data/lib/wire4_client/models/codi_code_qr_response_dto.rb +0 -320
- data/lib/wire4_client/models/codi_code_request_dto.rb +0 -402
- data/lib/wire4_client/models/codi_operations_filters_request_dto.rb +0 -336
- data/lib/wire4_client/models/company_registered.rb +0 -235
- data/lib/wire4_client/models/company_requested.rb +0 -215
- data/lib/wire4_client/models/compay.rb +0 -215
- data/lib/wire4_client/models/configurations_limits.rb +0 -197
- data/lib/wire4_client/models/contract_detail_request.rb +0 -247
- data/lib/wire4_client/models/contract_detail_response.rb +0 -194
- data/lib/wire4_client/models/deposit_authorization_request.rb +0 -205
- data/lib/wire4_client/models/deposits_authorization_response.rb +0 -205
- data/lib/wire4_client/models/detailed_error_response.rb +0 -203
- data/lib/wire4_client/models/item.rb +0 -205
- data/lib/wire4_client/models/message_codi_action.rb +0 -295
- data/lib/wire4_client/models/message_configurations_limits.rb +0 -187
- data/lib/wire4_client/models/message_deposit_authorization_request.rb +0 -375
- data/lib/wire4_client/models/message_payment_state_pending.rb +0 -335
- data/lib/wire4_client/models/message_request_changed.rb +0 -229
- data/lib/wire4_client/models/message_sales_point.rb +0 -205
- data/lib/wire4_client/models/message_user_authorized.rb +0 -245
- data/lib/wire4_client/models/operations.rb +0 -321
- data/lib/wire4_client/models/pager_response_dto.rb +0 -236
- data/lib/wire4_client/models/payment_codi.rb +0 -269
- data/lib/wire4_client/models/payment_request_codi_response_dto.rb +0 -287
- data/lib/wire4_client/models/pre_monex_authorization.rb +0 -291
- data/lib/wire4_client/models/sales_point.rb +0 -205
- data/lib/wire4_client/models/sales_point_found.rb +0 -279
- data/lib/wire4_client/models/sales_point_request.rb +0 -254
- data/lib/wire4_client/models/sales_point_respose.rb +0 -215
- data/lib/wire4_client/models/transaction_error_code.rb +0 -201
- data/lib/wire4_client/models/update_configurations_request_dto.rb +0 -192
- data/lib/wire4_client/models/urls_redirect.rb +0 -205
- data/lib/wire4_client/models/user_company.rb +0 -269
- data/lib/wire4_client/models/web_hook_deposit_authorization_request.rb +0 -195
- data/lib/wire4_client/models/web_hook_deposit_authorization_response.rb +0 -237
- data/lib/wire4_client/models/webhook.rb +0 -271
- data/spec/api/autorizacin_de_depsitos_api_spec.rb +0 -62
- data/spec/api/contracts_details_api_spec.rb +0 -90
- data/spec/api/empresas_co_di_api_spec.rb +0 -60
- data/spec/api/lmites_de_montos_api_spec.rb +0 -62
- data/spec/api/operaciones_co_di_api_spec.rb +0 -52
- data/spec/api/peticiones_de_pago_por_co_di_api_spec.rb +0 -63
- data/spec/api/puntos_de_venta_co_di_api_spec.rb +0 -62
- data/spec/models/account_detail_spec.rb +0 -71
- data/spec/models/account_reassigned_spec.rb +0 -125
- data/spec/models/authorization_transaction_group_spec.rb +0 -47
- data/spec/models/authorized_beneficiaries_response_spec.rb +0 -53
- data/spec/models/authorized_users_spec.rb +0 -71
- data/spec/models/beneficiaries_query_register_status_spec.rb +0 -75
- data/spec/models/certificate_request_spec.rb +0 -59
- data/spec/models/codi_code_qr_response_dto_spec.rb +0 -103
- data/spec/models/codi_code_request_dto_spec.rb +0 -81
- data/spec/models/codi_operation_response_dto_spec.rb +0 -77
- data/spec/models/codi_operations_filters_request_dto_spec.rb +0 -87
- data/spec/models/company_registered_spec.rb +0 -71
- data/spec/models/company_requested_spec.rb +0 -59
- data/spec/models/compay_spec.rb +0 -59
- data/spec/models/configurations_limits_spec.rb +0 -47
- data/spec/models/contract_detail_request_spec.rb +0 -59
- data/spec/models/contract_detail_response_spec.rb +0 -47
- data/spec/models/deposit_authorization_request_spec.rb +0 -53
- data/spec/models/deposits_authorization_response_spec.rb +0 -53
- data/spec/models/detailed_error_response_spec.rb +0 -53
- data/spec/models/item_spec.rb +0 -53
- data/spec/models/message_codi_action_spec.rb +0 -107
- data/spec/models/message_configurations_limits_spec.rb +0 -41
- data/spec/models/message_deposit_authorization_request_spec.rb +0 -155
- data/spec/models/message_payment_state_pending_spec.rb +0 -131
- data/spec/models/message_request_changed_spec.rb +0 -51
- data/spec/models/message_sales_point_spec.rb +0 -53
- data/spec/models/message_user_authorized_spec.rb +0 -77
- data/spec/models/operations_spec.rb +0 -103
- data/spec/models/pager_response_dto_spec.rb +0 -71
- data/spec/models/payment_codi_spec.rb +0 -75
- data/spec/models/payment_request_codi_response_dto_spec.rb +0 -101
- data/spec/models/pre_monex_authorization_spec.rb +0 -59
- data/spec/models/sales_point_found_spec.rb +0 -81
- data/spec/models/sales_point_request_spec.rb +0 -59
- data/spec/models/sales_point_respose_spec.rb +0 -59
- data/spec/models/sales_point_spec.rb +0 -53
- data/spec/models/transaction_error_code_spec.rb +0 -53
- data/spec/models/update_configurations_request_dto_spec.rb +0 -41
- data/spec/models/urls_redirect_spec.rb +0 -47
- data/spec/models/user_company_spec.rb +0 -89
- data/spec/models/web_hook_deposit_authorization_request_spec.rb +0 -47
- data/spec/models/web_hook_deposit_authorization_response_spec.rb +0 -71
- data/spec/models/webhook_spec.rb +0 -75
- data/wire4_client-1.0.9.gem +0 -0
data/docs/LmitesDeMontosApi.md
DELETED
@@ -1,112 +0,0 @@
|
|
1
|
-
# Wire4Client::LmitesDeMontosApi
|
2
|
-
|
3
|
-
All URIs are relative to *https://sandbox-api.wire4.mx/wire4/1.0.0*
|
4
|
-
|
5
|
-
Method | HTTP request | Description
|
6
|
-
------------- | ------------- | -------------
|
7
|
-
[**obtain_configurations_limits**](LmitesDeMontosApi.md#obtain_configurations_limits) | **GET** /subscriptions/{suscription}/configurations | Consulta las configuraciones para el contrato asocaido al enrolamiento en la aplicación
|
8
|
-
[**update_configurations**](LmitesDeMontosApi.md#update_configurations) | **PUT** /subscriptions/{suscription}/configurations | Actualiza las configuraciones por subscripción
|
9
|
-
|
10
|
-
|
11
|
-
# **obtain_configurations_limits**
|
12
|
-
> MessageConfigurationsLimits obtain_configurations_limits(authorization, suscription)
|
13
|
-
|
14
|
-
Consulta las configuraciones para el contrato asocaido al enrolamiento en la aplicación
|
15
|
-
|
16
|
-
Consulta las configuraciones para el contrato asocaido al enrolamiento en la aplicación.
|
17
|
-
|
18
|
-
### Example
|
19
|
-
```ruby
|
20
|
-
# load the gem
|
21
|
-
require 'wire4_client'
|
22
|
-
|
23
|
-
api_instance = Wire4Client::LmitesDeMontosApi.new
|
24
|
-
|
25
|
-
authorization = 'authorization_example' # String | Header para token
|
26
|
-
|
27
|
-
suscription = 'suscription_example' # String | Identificador de la suscripción a esta API
|
28
|
-
|
29
|
-
|
30
|
-
begin
|
31
|
-
#Consulta las configuraciones para el contrato asocaido al enrolamiento en la aplicación
|
32
|
-
result = api_instance.obtain_configurations_limits(authorization, suscription)
|
33
|
-
p result
|
34
|
-
rescue Wire4Client::ApiError => e
|
35
|
-
puts "Exception when calling LmitesDeMontosApi->obtain_configurations_limits: #{e}"
|
36
|
-
end
|
37
|
-
```
|
38
|
-
|
39
|
-
### Parameters
|
40
|
-
|
41
|
-
Name | Type | Description | Notes
|
42
|
-
------------- | ------------- | ------------- | -------------
|
43
|
-
**authorization** | **String**| Header para token |
|
44
|
-
**suscription** | **String**| Identificador de la suscripción a esta API |
|
45
|
-
|
46
|
-
### Return type
|
47
|
-
|
48
|
-
[**MessageConfigurationsLimits**](MessageConfigurationsLimits.md)
|
49
|
-
|
50
|
-
### Authorization
|
51
|
-
|
52
|
-
No authorization required
|
53
|
-
|
54
|
-
### HTTP request headers
|
55
|
-
|
56
|
-
- **Content-Type**: Not defined
|
57
|
-
- **Accept**: application/json
|
58
|
-
|
59
|
-
|
60
|
-
|
61
|
-
# **update_configurations**
|
62
|
-
> update_configurations(authorization, suscription, update_configurations_resquest_dto)
|
63
|
-
|
64
|
-
Actualiza las configuraciones por subscripción
|
65
|
-
|
66
|
-
Actualiza las configuraciones de un contrato asociado a una subscripción
|
67
|
-
|
68
|
-
### Example
|
69
|
-
```ruby
|
70
|
-
# load the gem
|
71
|
-
require 'wire4_client'
|
72
|
-
|
73
|
-
api_instance = Wire4Client::LmitesDeMontosApi.new
|
74
|
-
|
75
|
-
authorization = 'authorization_example' # String | Header para token
|
76
|
-
|
77
|
-
suscription = 'suscription_example' # String | suscription
|
78
|
-
|
79
|
-
update_configurations_resquest_dto = Wire4Client::UpdateConfigurationsRequestDTO.new # UpdateConfigurationsRequestDTO | updateConfigurationsResquestDTO
|
80
|
-
|
81
|
-
|
82
|
-
begin
|
83
|
-
#Actualiza las configuraciones por subscripción
|
84
|
-
api_instance.update_configurations(authorization, suscription, update_configurations_resquest_dto)
|
85
|
-
rescue Wire4Client::ApiError => e
|
86
|
-
puts "Exception when calling LmitesDeMontosApi->update_configurations: #{e}"
|
87
|
-
end
|
88
|
-
```
|
89
|
-
|
90
|
-
### Parameters
|
91
|
-
|
92
|
-
Name | Type | Description | Notes
|
93
|
-
------------- | ------------- | ------------- | -------------
|
94
|
-
**authorization** | **String**| Header para token |
|
95
|
-
**suscription** | **String**| suscription |
|
96
|
-
**update_configurations_resquest_dto** | [**UpdateConfigurationsRequestDTO**](UpdateConfigurationsRequestDTO.md)| updateConfigurationsResquestDTO |
|
97
|
-
|
98
|
-
### Return type
|
99
|
-
|
100
|
-
nil (empty response body)
|
101
|
-
|
102
|
-
### Authorization
|
103
|
-
|
104
|
-
No authorization required
|
105
|
-
|
106
|
-
### HTTP request headers
|
107
|
-
|
108
|
-
- **Content-Type**: application/json
|
109
|
-
- **Accept**: */*
|
110
|
-
|
111
|
-
|
112
|
-
|
data/docs/MessageCodiAction.md
DELETED
@@ -1,19 +0,0 @@
|
|
1
|
-
# Wire4Client::MessageCodiAction
|
2
|
-
|
3
|
-
## Properties
|
4
|
-
Name | Type | Description | Notes
|
5
|
-
------------ | ------------- | ------------- | -------------
|
6
|
-
**amount** | **Float** | Monto de la operación de pago | [optional]
|
7
|
-
**concept** | **String** | Concepto | [optional]
|
8
|
-
**due_date** | **DateTime** | Fecha de expiración de la operación | [optional]
|
9
|
-
**id** | **String** | Uuid de la operación | [optional]
|
10
|
-
**metadata** | **String** | Metadata asociada a la petición de pago | [optional]
|
11
|
-
**operation_date** | **DateTime** | Fecha de la operación | [optional]
|
12
|
-
**order_id** | **String** | Identificador de la petición | [optional]
|
13
|
-
**payment_type** | **String** | Tipo de pago | [optional]
|
14
|
-
**reference** | **String** | Número de referencia | [optional]
|
15
|
-
**sales_point_id** | **String** | Identidicador del punto de venta a la que pertenece la petición de pago | [optional]
|
16
|
-
**status** | **String** | Estado de la operación de pago | [optional]
|
17
|
-
**transaction_id** | **String** | Id de la transacción | [optional]
|
18
|
-
|
19
|
-
|
@@ -1,8 +0,0 @@
|
|
1
|
-
# Wire4Client::MessageConfigurationsLimits
|
2
|
-
|
3
|
-
## Properties
|
4
|
-
Name | Type | Description | Notes
|
5
|
-
------------ | ------------- | ------------- | -------------
|
6
|
-
**configurations** | [**Array<ConfigurationsLimits>**](ConfigurationsLimits.md) | Lista de configuraciones pertenecientes al contrato | [optional]
|
7
|
-
|
8
|
-
|
@@ -1,27 +0,0 @@
|
|
1
|
-
# Wire4Client::MessageDepositAuthorizationRequest
|
2
|
-
|
3
|
-
## Properties
|
4
|
-
Name | Type | Description | Notes
|
5
|
-
------------ | ------------- | ------------- | -------------
|
6
|
-
**amount** | **Float** | Monto de la transferencia | [optional]
|
7
|
-
**beneficiary_account** | **String** | Cuenta del beneficiario | [optional]
|
8
|
-
**beneficiary_name** | **String** | Nombre del beneficiario | [optional]
|
9
|
-
**beneficiary_rfc** | **String** | RFC del beneficiario | [optional]
|
10
|
-
**clave_rastreo** | **String** | Clave de rastreo de la transferencia | [optional]
|
11
|
-
**confirm_date** | **DateTime** | Fecha de confirmación de la transferencia | [optional]
|
12
|
-
**currency_code** | **String** | Código de moneda de la transferencia, puede ser MXP, USD | [optional]
|
13
|
-
**deposit_date** | **DateTime** | Fecha de recepción de la transferencia | [optional]
|
14
|
-
**depositant** | **String** | Nombre del depositante, en caso que la transferencia se reciba en una cuenta de depositante | [optional]
|
15
|
-
**depositant_clabe** | **String** | CLABE del depositante, en caso que la transferencia se reciba en una cuenta de depositante | [optional]
|
16
|
-
**depositant_email** | **String** | Correo electrónico del depositante, en caso que la transferencia se reciba en una cuenta de depositante | [optional]
|
17
|
-
**depositant_rfc** | **String** | RFC del depositante, en caso que la transferencia se reciba en una cuenta de depositante | [optional]
|
18
|
-
**description** | **String** | Concepto de la transferencia | [optional]
|
19
|
-
**monex_description** | **String** | Descripción de Monex para la transferencia | [optional]
|
20
|
-
**monex_transaction_id** | **String** | Identificador asignado por Monex a la transferencia | [optional]
|
21
|
-
**reference** | **String** | Referecia de la transferencia | [optional]
|
22
|
-
**sender_account** | **String** | Cuenta del ordenante, podría ser un número celular, TDD o Cuenta CLABE interbancaria | [optional]
|
23
|
-
**sender_bank** | [**MessageInstitution**](MessageInstitution.md) | Información del banco del ordenante | [optional]
|
24
|
-
**sender_name** | **String** | Nombre del ordenante | [optional]
|
25
|
-
**sender_rfc** | **String** | RFC del ordenante | [optional]
|
26
|
-
|
27
|
-
|
@@ -1,23 +0,0 @@
|
|
1
|
-
# Wire4Client::MessagePaymentStatePending
|
2
|
-
|
3
|
-
## Properties
|
4
|
-
Name | Type | Description | Notes
|
5
|
-
------------ | ------------- | ------------- | -------------
|
6
|
-
**account** | **String** | Cuenta del ordenante | [optional]
|
7
|
-
**amount** | **Float** | Monto de la transferencia | [optional]
|
8
|
-
**beneficiary_account** | **String** | Cuenta del beneficiario | [optional]
|
9
|
-
**beneficiary_bank** | [**MessageInstitution**](MessageInstitution.md) | Banco del beneficiario | [optional]
|
10
|
-
**beneficiary_name** | **String** | Nombre del beneficiario | [optional]
|
11
|
-
**concept** | **String** | Concepto de la transferencia de salida | [optional]
|
12
|
-
**currency_code** | **String** | Código de la moneda de la transferencia de salida | [optional]
|
13
|
-
**detention_message** | **String** | Mensaje de detención de Monex, indica la causa por la cuál esta detenida la operación en Monex | [optional]
|
14
|
-
**error_message** | **String** | Mensaje de error | [optional]
|
15
|
-
**order_id** | **String** | El identificador de la transferencia de salida | [optional]
|
16
|
-
**payment_order_id** | **Integer** | El identificador de la orden de pago de Monex de la transferencia de salida | [optional]
|
17
|
-
**pending_reason** | **String** | Estatus que identifica la causa por la que la transferencia esta en pendiente, los posibles estatus son: FI=Fondos Insuficientes | FM=Firma mancomunada, en espera de ingreso de segundo token de autorización | DP=Se detecto una transferencia duplicada que esta en espera de confirmación o de eliminación | [optional]
|
18
|
-
**reference** | **Integer** | Referecia de la transferencia | [optional]
|
19
|
-
**request_id** | **String** | El identificador, en esta API, de la petición de envío de la transferencia de salida | [optional]
|
20
|
-
**status_code** | **String** | El estado de la transferencia de salida, deberá ser PENDING | [optional]
|
21
|
-
**transaction_id** | **Integer** | El identificador de Monex de la transferencia de salida, podría no estar presente por lo que Usted debería hacer referencias mediate el paymentOrderID | [optional]
|
22
|
-
|
23
|
-
|
@@ -1,9 +0,0 @@
|
|
1
|
-
# Wire4Client::MessageRequestChanged
|
2
|
-
|
3
|
-
## Properties
|
4
|
-
Name | Type | Description | Notes
|
5
|
-
------------ | ------------- | ------------- | -------------
|
6
|
-
**request_id** | **String** | Identificador de la petición realizada a esta API | [optional]
|
7
|
-
**status** | **String** | El cambio a informar en la procesamiento/estado de la petición | [optional]
|
8
|
-
|
9
|
-
|
data/docs/MessageSalesPoint.md
DELETED
@@ -1,10 +0,0 @@
|
|
1
|
-
# Wire4Client::MessageSalesPoint
|
2
|
-
|
3
|
-
## Properties
|
4
|
-
Name | Type | Description | Notes
|
5
|
-
------------ | ------------- | ------------- | -------------
|
6
|
-
**account** | **String** | Cuenta donde se realziaran los pagos | [optional]
|
7
|
-
**ip** | **String** | Ip desde la cual se accedera al API | [optional]
|
8
|
-
**name** | **String** | Nombre del punto de venta | [optional]
|
9
|
-
|
10
|
-
|
@@ -1,14 +0,0 @@
|
|
1
|
-
# Wire4Client::MessageUserAuthorized
|
2
|
-
|
3
|
-
## Properties
|
4
|
-
Name | Type | Description | Notes
|
5
|
-
------------ | ------------- | ------------- | -------------
|
6
|
-
**account** | **String** | El contrato al cual se le brinda el acceso a la API | [optional]
|
7
|
-
**masked_account** | **String** | El contrato enmascarado al cual se le brinda el acceso a la API | [optional]
|
8
|
-
**masked_name** | **String** | El usuario enmascarado que se autorizó | [optional]
|
9
|
-
**masked_user_name** | **String** | El nombre enmascarado del usuario de acceso que se autorizó | [optional]
|
10
|
-
**name** | **String** | El usuario que se autorizó | [optional]
|
11
|
-
**request_id** | **String** | El identificador de la petición cuando se solicitó la autorización | [optional]
|
12
|
-
**user_name** | **String** | El nombre del usuario de acceso que se autorizó | [optional]
|
13
|
-
|
14
|
-
|
data/docs/OperacionesCoDiApi.md
DELETED
@@ -1,68 +0,0 @@
|
|
1
|
-
# Wire4Client::OperacionesCoDiApi
|
2
|
-
|
3
|
-
All URIs are relative to *https://sandbox-api.wire4.mx/wire4/1.0.0*
|
4
|
-
|
5
|
-
Method | HTTP request | Description
|
6
|
-
------------- | ------------- | -------------
|
7
|
-
[**consult_codi_operations**](OperacionesCoDiApi.md#consult_codi_operations) | **POST** /codi/charges | Obtiene las operaciones generadas a partir de peticiones de pago CoDi® de forma paginada, pudiendo aplicar filtros
|
8
|
-
|
9
|
-
|
10
|
-
# **consult_codi_operations**
|
11
|
-
> PagerResponseDto consult_codi_operations(authorization, opts)
|
12
|
-
|
13
|
-
Obtiene las operaciones generadas a partir de peticiones de pago CoDi® de forma paginada, pudiendo aplicar filtros
|
14
|
-
|
15
|
-
Obtiene las operaciones generadas a partir de peticiones de pago CoDi® de forma paginada, pudiendo aplicar filtros
|
16
|
-
|
17
|
-
### Example
|
18
|
-
```ruby
|
19
|
-
# load the gem
|
20
|
-
require 'wire4_client'
|
21
|
-
|
22
|
-
api_instance = Wire4Client::OperacionesCoDiApi.new
|
23
|
-
|
24
|
-
authorization = 'authorization_example' # String | Header para token
|
25
|
-
|
26
|
-
opts = {
|
27
|
-
company_id: 'company_id_example', # String | Identificador de empresa CoDi
|
28
|
-
page: '0', # String | Número de pago
|
29
|
-
request_filters: Wire4Client::CodiOperationsFiltersRequestDTO.new, # CodiOperationsFiltersRequestDTO | Filtros de busqueda
|
30
|
-
sales_point_id: 'sales_point_id_example', # String | Identificador del punto de venta
|
31
|
-
size: '20' # String | Tamaño de pagina
|
32
|
-
}
|
33
|
-
|
34
|
-
begin
|
35
|
-
#Obtiene las operaciones generadas a partir de peticiones de pago CoDi® de forma paginada, pudiendo aplicar filtros
|
36
|
-
result = api_instance.consult_codi_operations(authorization, opts)
|
37
|
-
p result
|
38
|
-
rescue Wire4Client::ApiError => e
|
39
|
-
puts "Exception when calling OperacionesCoDiApi->consult_codi_operations: #{e}"
|
40
|
-
end
|
41
|
-
```
|
42
|
-
|
43
|
-
### Parameters
|
44
|
-
|
45
|
-
Name | Type | Description | Notes
|
46
|
-
------------- | ------------- | ------------- | -------------
|
47
|
-
**authorization** | **String**| Header para token |
|
48
|
-
**company_id** | **String**| Identificador de empresa CoDi | [optional]
|
49
|
-
**page** | **String**| Número de pago | [optional] [default to 0]
|
50
|
-
**request_filters** | [**CodiOperationsFiltersRequestDTO**](CodiOperationsFiltersRequestDTO.md)| Filtros de busqueda | [optional]
|
51
|
-
**sales_point_id** | **String**| Identificador del punto de venta | [optional]
|
52
|
-
**size** | **String**| Tamaño de pagina | [optional] [default to 20]
|
53
|
-
|
54
|
-
### Return type
|
55
|
-
|
56
|
-
[**PagerResponseDto**](PagerResponseDto.md)
|
57
|
-
|
58
|
-
### Authorization
|
59
|
-
|
60
|
-
No authorization required
|
61
|
-
|
62
|
-
### HTTP request headers
|
63
|
-
|
64
|
-
- **Content-Type**: application/json
|
65
|
-
- **Accept**: application/json
|
66
|
-
|
67
|
-
|
68
|
-
|
data/docs/Operations.md
DELETED
@@ -1,17 +0,0 @@
|
|
1
|
-
# Wire4Client::Operations
|
2
|
-
|
3
|
-
## Properties
|
4
|
-
Name | Type | Description | Notes
|
5
|
-
------------ | ------------- | ------------- | -------------
|
6
|
-
**amount** | **Float** | Monto de la petición | [optional]
|
7
|
-
**company** | [**Compay**](Compay.md) | Empresa CoDi | [optional]
|
8
|
-
**description** | **String** | Descripción de la petición | [optional]
|
9
|
-
**due_date** | **DateTime** | Fecha de vencimiento de la petición | [optional]
|
10
|
-
**order_id** | **String** | Order id de la petición | [optional]
|
11
|
-
**payment** | [**PaymentCODI**](PaymentCODI.md) | Pago | [optional]
|
12
|
-
**phone_number** | **String** | Numero de telefono | [optional]
|
13
|
-
**sales_point** | [**SalesPoint**](SalesPoint.md) | Punto de venta | [optional]
|
14
|
-
**status** | **String** | Estatus de la petición | [optional]
|
15
|
-
**type** | **String** | Tipo de petición de cobro | [optional]
|
16
|
-
|
17
|
-
|
data/docs/PagerResponseDto.md
DELETED
@@ -1,13 +0,0 @@
|
|
1
|
-
# Wire4Client::PagerResponseDto
|
2
|
-
|
3
|
-
## Properties
|
4
|
-
Name | Type | Description | Notes
|
5
|
-
------------ | ------------- | ------------- | -------------
|
6
|
-
**content** | [**Array<Operations>**](Operations.md) | Contenido de la respuesta paginada | [optional]
|
7
|
-
**number_of_elements** | **Integer** | Numero de elementos en la pagina | [optional]
|
8
|
-
**page** | **Integer** | Número de pagina | [optional]
|
9
|
-
**size** | **Integer** | Tamaño de la pagina | [optional]
|
10
|
-
**total_items** | **Integer** | Numero total de elementos de la consulta | [optional]
|
11
|
-
**total_pages** | **Integer** | Numero total de paginas | [optional]
|
12
|
-
|
13
|
-
|
data/docs/PaymentCODI.md
DELETED
@@ -1,13 +0,0 @@
|
|
1
|
-
# Wire4Client::PaymentCODI
|
2
|
-
|
3
|
-
## Properties
|
4
|
-
Name | Type | Description | Notes
|
5
|
-
------------ | ------------- | ------------- | -------------
|
6
|
-
**amount** | **Float** | Monto del pago | [optional]
|
7
|
-
**description** | **String** | Descripción del pago | [optional]
|
8
|
-
**error_message** | **String** | Mensaje de error | [optional]
|
9
|
-
**id** | **String** | Identificador del pago | [optional]
|
10
|
-
**operation_date** | **DateTime** | Fecha en que se efectuo el pago | [optional]
|
11
|
-
**status** | **String** | Estatus del pago | [optional]
|
12
|
-
|
13
|
-
|
@@ -1,18 +0,0 @@
|
|
1
|
-
# Wire4Client::PaymentRequestCodiResponseDTO
|
2
|
-
|
3
|
-
## Properties
|
4
|
-
Name | Type | Description | Notes
|
5
|
-
------------ | ------------- | ------------- | -------------
|
6
|
-
**amount** | **Float** | Monto del pago. | [optional]
|
7
|
-
**barcode_base64** | **String** | Imagen QR en formato Base64 para el CODI®. | [optional]
|
8
|
-
**barcode_url** | **String** | URL de la imagen QR para el CODI®. | [optional]
|
9
|
-
**concept** | **String** | Concepto de pago. | [optional]
|
10
|
-
**creation_date** | **DateTime** | Fecha de creación. | [optional]
|
11
|
-
**due_date** | **DateTime** | Fecha de vencimiento. | [optional]
|
12
|
-
**operations** | [**Array<CodiOperationResponseDTO>**](CodiOperationResponseDTO.md) | Listado de pagos realizados sobre la petición. | [optional]
|
13
|
-
**order_id** | **String** | OrderId asignada a la solicitud. | [optional]
|
14
|
-
**phone_number** | **String** | Numero de teléfono. | [optional]
|
15
|
-
**status** | **String** | Estatus de la orden de pago. | [optional]
|
16
|
-
**type** | **String** | Tipo de petición. | [optional]
|
17
|
-
|
18
|
-
|
@@ -1,116 +0,0 @@
|
|
1
|
-
# Wire4Client::PeticionesDePagoPorCoDiApi
|
2
|
-
|
3
|
-
All URIs are relative to *https://sandbox-api.wire4.mx/wire4/1.0.0*
|
4
|
-
|
5
|
-
Method | HTTP request | Description
|
6
|
-
------------- | ------------- | -------------
|
7
|
-
[**consult_codi_request_by_order_id**](PeticionesDePagoPorCoDiApi.md#consult_codi_request_by_order_id) | **GET** /codi/sales-point/charges | Obtiene la información de una petición de pago CODI® por orderId para un punto de venta
|
8
|
-
[**generate_codi_code_qr**](PeticionesDePagoPorCoDiApi.md#generate_codi_code_qr) | **POST** /codi/sales-point/charges | Genera un código QR para un pago mediante CODI®
|
9
|
-
|
10
|
-
|
11
|
-
# **consult_codi_request_by_order_id**
|
12
|
-
> PaymentRequestCodiResponseDTO consult_codi_request_by_order_id(authorization, order_id, sales_point_id)
|
13
|
-
|
14
|
-
Obtiene la información de una petición de pago CODI® por orderId para un punto de venta
|
15
|
-
|
16
|
-
Obtiene la información de una petición de pago CODI® por orderId para un punto de venta
|
17
|
-
|
18
|
-
### Example
|
19
|
-
```ruby
|
20
|
-
# load the gem
|
21
|
-
require 'wire4_client'
|
22
|
-
|
23
|
-
api_instance = Wire4Client::PeticionesDePagoPorCoDiApi.new
|
24
|
-
|
25
|
-
authorization = 'authorization_example' # String | Header para token
|
26
|
-
|
27
|
-
order_id = 'order_id_example' # String | Identificador del pago CODI®
|
28
|
-
|
29
|
-
sales_point_id = 'sales_point_id_example' # String | Identificador del punto de venta
|
30
|
-
|
31
|
-
|
32
|
-
begin
|
33
|
-
#Obtiene la información de una petición de pago CODI® por orderId para un punto de venta
|
34
|
-
result = api_instance.consult_codi_request_by_order_id(authorization, order_id, sales_point_id)
|
35
|
-
p result
|
36
|
-
rescue Wire4Client::ApiError => e
|
37
|
-
puts "Exception when calling PeticionesDePagoPorCoDiApi->consult_codi_request_by_order_id: #{e}"
|
38
|
-
end
|
39
|
-
```
|
40
|
-
|
41
|
-
### Parameters
|
42
|
-
|
43
|
-
Name | Type | Description | Notes
|
44
|
-
------------- | ------------- | ------------- | -------------
|
45
|
-
**authorization** | **String**| Header para token |
|
46
|
-
**order_id** | **String**| Identificador del pago CODI® |
|
47
|
-
**sales_point_id** | **String**| Identificador del punto de venta |
|
48
|
-
|
49
|
-
### Return type
|
50
|
-
|
51
|
-
[**PaymentRequestCodiResponseDTO**](PaymentRequestCodiResponseDTO.md)
|
52
|
-
|
53
|
-
### Authorization
|
54
|
-
|
55
|
-
No authorization required
|
56
|
-
|
57
|
-
### HTTP request headers
|
58
|
-
|
59
|
-
- **Content-Type**: Not defined
|
60
|
-
- **Accept**: application/json
|
61
|
-
|
62
|
-
|
63
|
-
|
64
|
-
# **generate_codi_code_qr**
|
65
|
-
> CodiCodeQrResponseDTO generate_codi_code_qr(authorization, codi_info, sales_point_id)
|
66
|
-
|
67
|
-
Genera un código QR para un pago mediante CODI®
|
68
|
-
|
69
|
-
Genera un código QR solicitado por un punto de venta para un pago mediante CODI®
|
70
|
-
|
71
|
-
### Example
|
72
|
-
```ruby
|
73
|
-
# load the gem
|
74
|
-
require 'wire4_client'
|
75
|
-
|
76
|
-
api_instance = Wire4Client::PeticionesDePagoPorCoDiApi.new
|
77
|
-
|
78
|
-
authorization = 'authorization_example' # String | Header para token
|
79
|
-
|
80
|
-
codi_info = Wire4Client::CodiCodeRequestDTO.new # CodiCodeRequestDTO | Información del pago CODI®
|
81
|
-
|
82
|
-
sales_point_id = 'sales_point_id_example' # String | Identificador del punto de venta
|
83
|
-
|
84
|
-
|
85
|
-
begin
|
86
|
-
#Genera un código QR para un pago mediante CODI®
|
87
|
-
result = api_instance.generate_codi_code_qr(authorization, codi_info, sales_point_id)
|
88
|
-
p result
|
89
|
-
rescue Wire4Client::ApiError => e
|
90
|
-
puts "Exception when calling PeticionesDePagoPorCoDiApi->generate_codi_code_qr: #{e}"
|
91
|
-
end
|
92
|
-
```
|
93
|
-
|
94
|
-
### Parameters
|
95
|
-
|
96
|
-
Name | Type | Description | Notes
|
97
|
-
------------- | ------------- | ------------- | -------------
|
98
|
-
**authorization** | **String**| Header para token |
|
99
|
-
**codi_info** | [**CodiCodeRequestDTO**](CodiCodeRequestDTO.md)| Información del pago CODI® |
|
100
|
-
**sales_point_id** | **String**| Identificador del punto de venta |
|
101
|
-
|
102
|
-
### Return type
|
103
|
-
|
104
|
-
[**CodiCodeQrResponseDTO**](CodiCodeQrResponseDTO.md)
|
105
|
-
|
106
|
-
### Authorization
|
107
|
-
|
108
|
-
No authorization required
|
109
|
-
|
110
|
-
### HTTP request headers
|
111
|
-
|
112
|
-
- **Content-Type**: application/json
|
113
|
-
- **Accept**: application/json
|
114
|
-
|
115
|
-
|
116
|
-
|
@@ -1,11 +0,0 @@
|
|
1
|
-
# Wire4Client::PreMonexAuthorization
|
2
|
-
|
3
|
-
## Properties
|
4
|
-
Name | Type | Description | Notes
|
5
|
-
------------ | ------------- | ------------- | -------------
|
6
|
-
**business_name** | **String** | Razón social de asociada al RFC a la que debe pertenecer el contrato que se solicita |
|
7
|
-
**cancel_return_url** | **String** | Url a la que se redirigira en caso de que el cliente cancele el registro |
|
8
|
-
**return_url** | **String** | Url a la que se redirigirá en caso de exito |
|
9
|
-
**rfc** | **String** | RFC de la empresa a la que debe pertenecer el contrato solicitado, si no se especifica este valor no se realiza validación |
|
10
|
-
|
11
|
-
|
@@ -1,113 +0,0 @@
|
|
1
|
-
# Wire4Client::PuntosDeVentaCoDiApi
|
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_sales_point**](PuntosDeVentaCoDiApi.md#create_sales_point) | **POST** /codi/companies/salespoint | Registra un punto de venta asociado a una empresa
|
8
|
-
[**obtain_sale_points**](PuntosDeVentaCoDiApi.md#obtain_sale_points) | **GET** /codi/companies/salespoint | Obtiene los puntos de venta asociados a una empresa
|
9
|
-
|
10
|
-
|
11
|
-
# **create_sales_point**
|
12
|
-
> SalesPointRespose create_sales_point(authorization, company_id, sales_point_info)
|
13
|
-
|
14
|
-
Registra un punto de venta asociado a una empresa
|
15
|
-
|
16
|
-
Registra un punto de venta desde donde se emitaran los cobros CODI®, el punto de venta se debe asociar a un cuenta cableregistrada previamente ante Banxico para realizar cobros con CODI®
|
17
|
-
|
18
|
-
### Example
|
19
|
-
```ruby
|
20
|
-
# load the gem
|
21
|
-
require 'wire4_client'
|
22
|
-
|
23
|
-
api_instance = Wire4Client::PuntosDeVentaCoDiApi.new
|
24
|
-
|
25
|
-
authorization = 'authorization_example' # String | Header para token
|
26
|
-
|
27
|
-
company_id = 'company_id_example' # String | El identificador de la empresa
|
28
|
-
|
29
|
-
sales_point_info = Wire4Client::SalesPointRequest.new # SalesPointRequest | Información del punto de venta CODI®
|
30
|
-
|
31
|
-
|
32
|
-
begin
|
33
|
-
#Registra un punto de venta asociado a una empresa
|
34
|
-
result = api_instance.create_sales_point(authorization, company_id, sales_point_info)
|
35
|
-
p result
|
36
|
-
rescue Wire4Client::ApiError => e
|
37
|
-
puts "Exception when calling PuntosDeVentaCoDiApi->create_sales_point: #{e}"
|
38
|
-
end
|
39
|
-
```
|
40
|
-
|
41
|
-
### Parameters
|
42
|
-
|
43
|
-
Name | Type | Description | Notes
|
44
|
-
------------- | ------------- | ------------- | -------------
|
45
|
-
**authorization** | **String**| Header para token |
|
46
|
-
**company_id** | **String**| El identificador de la empresa |
|
47
|
-
**sales_point_info** | [**SalesPointRequest**](SalesPointRequest.md)| Información del punto de venta CODI® |
|
48
|
-
|
49
|
-
### Return type
|
50
|
-
|
51
|
-
[**SalesPointRespose**](SalesPointRespose.md)
|
52
|
-
|
53
|
-
### Authorization
|
54
|
-
|
55
|
-
No authorization required
|
56
|
-
|
57
|
-
### HTTP request headers
|
58
|
-
|
59
|
-
- **Content-Type**: application/json
|
60
|
-
- **Accept**: application/json
|
61
|
-
|
62
|
-
|
63
|
-
|
64
|
-
# **obtain_sale_points**
|
65
|
-
> Array<SalesPointFound> obtain_sale_points(authorization, company_id)
|
66
|
-
|
67
|
-
Obtiene los puntos de venta asociados a una empresa
|
68
|
-
|
69
|
-
Obtiene los puntos de venta asociados a una empresa en las cuales se hacen operaciones CODI®
|
70
|
-
|
71
|
-
### Example
|
72
|
-
```ruby
|
73
|
-
# load the gem
|
74
|
-
require 'wire4_client'
|
75
|
-
|
76
|
-
api_instance = Wire4Client::PuntosDeVentaCoDiApi.new
|
77
|
-
|
78
|
-
authorization = 'authorization_example' # String | Header para token
|
79
|
-
|
80
|
-
company_id = 'company_id_example' # String | El identificador de la empresa
|
81
|
-
|
82
|
-
|
83
|
-
begin
|
84
|
-
#Obtiene los puntos de venta asociados a una empresa
|
85
|
-
result = api_instance.obtain_sale_points(authorization, company_id)
|
86
|
-
p result
|
87
|
-
rescue Wire4Client::ApiError => e
|
88
|
-
puts "Exception when calling PuntosDeVentaCoDiApi->obtain_sale_points: #{e}"
|
89
|
-
end
|
90
|
-
```
|
91
|
-
|
92
|
-
### Parameters
|
93
|
-
|
94
|
-
Name | Type | Description | Notes
|
95
|
-
------------- | ------------- | ------------- | -------------
|
96
|
-
**authorization** | **String**| Header para token |
|
97
|
-
**company_id** | **String**| El identificador de la empresa |
|
98
|
-
|
99
|
-
### Return type
|
100
|
-
|
101
|
-
[**Array<SalesPointFound>**](SalesPointFound.md)
|
102
|
-
|
103
|
-
### Authorization
|
104
|
-
|
105
|
-
No authorization required
|
106
|
-
|
107
|
-
### HTTP request headers
|
108
|
-
|
109
|
-
- **Content-Type**: Not defined
|
110
|
-
- **Accept**: application/json
|
111
|
-
|
112
|
-
|
113
|
-
|
data/docs/SalesPoint.md
DELETED
@@ -1,10 +0,0 @@
|
|
1
|
-
# Wire4Client::SalesPoint
|
2
|
-
|
3
|
-
## Properties
|
4
|
-
Name | Type | Description | Notes
|
5
|
-
------------ | ------------- | ------------- | -------------
|
6
|
-
**account** | **String** | Cuenta CLABE | [optional]
|
7
|
-
**name** | **String** | Nombre del punto de venta | [optional]
|
8
|
-
**sales_point_id** | **String** | Identificador del punto de venta | [optional]
|
9
|
-
|
10
|
-
|
data/docs/SalesPointFound.md
DELETED
@@ -1,14 +0,0 @@
|
|
1
|
-
# Wire4Client::SalesPointFound
|
2
|
-
|
3
|
-
## Properties
|
4
|
-
Name | Type | Description | Notes
|
5
|
-
------------ | ------------- | ------------- | -------------
|
6
|
-
**access_ip** | **String** | Ip desde la que accede el punto de venta a wire4 y a la que se devuelven las notificaciones | [optional]
|
7
|
-
**account** | **String** | Cuenta registra para el punto de venta | [optional]
|
8
|
-
**created_at** | **DateTime** | Fecha en la que se creó el punto de venta | [optional]
|
9
|
-
**name** | **String** | Nombre del punto de venta | [optional]
|
10
|
-
**public_id** | **String** | Identificador del punto de venta | [optional]
|
11
|
-
**status** | **String** | Estatus ACTIVO/INACTIVO el punto de venta | [optional]
|
12
|
-
**updated_at** | **DateTime** | Fecha en la que se actualizó el punto de venta | [optional]
|
13
|
-
|
14
|
-
|
data/docs/SalesPointRequest.md
DELETED
@@ -1,11 +0,0 @@
|
|
1
|
-
# Wire4Client::SalesPointRequest
|
2
|
-
|
3
|
-
## Properties
|
4
|
-
Name | Type | Description | Notes
|
5
|
-
------------ | ------------- | ------------- | -------------
|
6
|
-
**access_ip** | **String** | IP desde donde se recibiran las peticiones de este punto de venta |
|
7
|
-
**account** | **String** | Número de cuenta CLABE donde se realizará el deposito del cobro CoDi |
|
8
|
-
**name** | **String** | Nombre del punto de venta |
|
9
|
-
**notifications_url** | **String** | URL para envíar notificaciones CoDi al punto de venta |
|
10
|
-
|
11
|
-
|
data/docs/SalesPointRespose.md
DELETED
@@ -1,11 +0,0 @@
|
|
1
|
-
# Wire4Client::SalesPointRespose
|
2
|
-
|
3
|
-
## Properties
|
4
|
-
Name | Type | Description | Notes
|
5
|
-
------------ | ------------- | ------------- | -------------
|
6
|
-
**sales_point_id** | **String** | Identificador del punto de venta | [optional]
|
7
|
-
**user_key** | **String** | Llave de usuario para el API Wire4 | [optional]
|
8
|
-
**user_secret** | **String** | Contraseña para el API Wire4 | [optional]
|
9
|
-
**webhook** | [**Webhook**](Webhook.md) | codiWebhook | [optional]
|
10
|
-
|
11
|
-
|