wire4_client 1.0.0 → 1.1.2

data/docs/DepositAuthorizationRequest.md

@@ -0,0 +1,10 @@
+# Wire4Client::DepositAuthorizationRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**enabled** | **BOOLEAN** | Indica sí se aplica la autorización de depósitos. | [optional] 
+**webhook** | [**WebHookDepositAuthorizationRequest**](WebHookDepositAuthorizationRequest.md) | La información del WebHook de autorización de depósitos. | [optional] 
+**wh_uuid** | **String** | Identificador del webhook. | [optional] 
+
+

data/docs/Depositant.md

@@ -3,10 +3,10 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**_alias** | **String** | Alias del depositante | [optional] 
-**currency_code** | **String** | Código de moneda con el que operará el depositante | [optional] 
-**depositant_clabe** | **String** | Cuenta clabe del depositante | [optional] 
-**email** | **Array<String>** | Lista de emails del depositante | [optional] 
-**name** | **String** | Nombre del depositante | [optional] 
+**_alias** | **String** | Es el alias del depositante. | [optional] 
+**currency_code** | **String** | Es el código de divisa que opera el depositante. Es en el formato estándar de 3 dígitos. Sólo se permiten los valores <b>MXP</b> y <b>USD</b>. | [optional] 
+**depositant_clabe** | **String** | Es la cuenta CLABE (es de 18 dígitos) del depositante. | [optional] 
+**email** | **Array<String>** | Es la lista de correos electrónicos (emails) del depositante. | [optional] 
+**name** | **String** | Es el nombre del depositante. | [optional] 
 
 

data/docs/DepositantesApi.md

@@ -13,7 +13,7 @@ Method | HTTP request | Description
 
 Consulta de cuentas de depositantes
 
-Obtiene una lista de depositantes asociados al contrato relacionado a la subscripción.
+Obtiene una lista de depositantes asociados al contrato relacionado a la suscripción.
 
 ### Example
 ```ruby
@@ -24,7 +24,7 @@ api_instance = Wire4Client::DepositantesApi.new
 
 authorization = 'authorization_example' # String | Header para token
 
-subscription = 'subscription_example' # String | El identificador de la suscripción a esta API
+subscription = 'subscription_example' # String | Es el identificador de la suscripción a esta API.
 
 
 begin
@@ -41,7 +41,7 @@ end
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **authorization** | **String**| Header para token | 
- **subscription** | **String**| El identificador de la suscripción a esta API | 
+ **subscription** | **String**| Es el identificador de la suscripción a esta API. | 
 
 ### Return type
 
@@ -63,7 +63,7 @@ No authorization required
 
 Registra un nuevo depositante
 
-Registra un nuevo depositante en el contrato asociado a la subscripción.
+Registra un nuevo depositante en el contrato asociado a la suscripción.
 
 ### Example
 ```ruby
@@ -76,7 +76,7 @@ authorization = 'authorization_example' # String | Header para token
 
 register = Wire4Client::DepositantsRegister.new # DepositantsRegister | Depositant info
 
-subscription = 'subscription_example' # String | El identificador de la suscripción a esta API
+subscription = 'subscription_example' # String | Es el identificador de la suscripción a esta API.
 
 
 begin
@@ -94,7 +94,7 @@ Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **authorization** | **String**| Header para token | 
  **register** | [**DepositantsRegister**](DepositantsRegister.md)| Depositant info | 
- **subscription** | **String**| El identificador de la suscripción a esta API | 
+ **subscription** | **String**| Es el identificador de la suscripción a esta API. | 
 
 ### Return type
 

data/docs/DepositantsRegister.md

@@ -3,9 +3,9 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**_alias** | **String** | Alias del depositante | 
-**currency_code** | **String** | Codigo de la moneda en que operará el depositante, los valores validos son MXP y USD | 
-**email** | **Array<String>** | Lista de email del depositante | [optional] 
-**name** | **String** | Nombre del depositante | 
+**_alias** | **String** | Es el alias del depositante. Se valida hasta 80 caracteres. | 
+**currency_code** | **String** | Es el código de divisa en que operará el depositante. Es en el formato estándar de 3 dígitos.  Sólo se permiten los valores <b>MXP</b> y <b>USD</b>. | 
+**email** | **Array<String>** | Es la lista de correos electrónicos (emails) del depositante. <br><br><b>Ejemplo</b>: mi_correo@correo.com,mi_correo@correo.com... | [optional] 
+**name** | **String** | Es el nombre del depositante. Se valida hasta 120 caracteres. | 
 
 

data/docs/DepositantsResponse.md

@@ -3,6 +3,6 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**clabe** | **String** | Cuenta clabe del depositante | [optional] 
+**clabe** | **String** | Cuenta CLABE (es de 18 dígitos) del depositante. | [optional] 
 
 

data/docs/DepositsAuthorizationResponse.md

@@ -0,0 +1,10 @@
+# Wire4Client::DepositsAuthorizationResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**enabled** | **BOOLEAN** | Indica sí se aplica autorización de depósitos. | [optional] 
+**read_only** | **BOOLEAN** | Indica sí es posible modificar o no la autorización, ésto depende si otra aplicación tiene el control sobre la autorización de depósitos. | [optional] 
+**webhook** | [**WebHookDepositAuthorizationResponse**](WebHookDepositAuthorizationResponse.md) | Es la información del webHook de autorización de depósitos. | [optional] 
+
+

data/docs/DetailedErrorResponse.md

@@ -0,0 +1,10 @@
+# Wire4Client::DetailedErrorResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**errors** | [**Array<TransactionErrorCode>**](TransactionErrorCode.md) |  | [optional] 
+**http_status** | **Integer** |  | [optional] 
+**message** | **String** |  | [optional] 
+
+

data/docs/EmpresasCoDiApi.md

@@ -0,0 +1,107 @@
+# Wire4Client::EmpresasCoDiApi
+
+All URIs are relative to *https://sandbox-api.wire4.mx/wire4/1.0.0*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**obtain_companies**](EmpresasCoDiApi.md#obtain_companies) | **GET** /codi/companies | Consulta de empresas CODI®
+[**register_company_using_post**](EmpresasCoDiApi.md#register_company_using_post) | **POST** /codi/companies | Registro de empresas CODI®
+
+
+# **obtain_companies**
+> Array<CompanyRegistered> obtain_companies(authorization)
+
+Consulta de empresas CODI®
+
+Consulta de empresas CODI® registradas para la aplicación.
+
+### Example
+```ruby
+# load the gem
+require 'wire4_client'
+
+api_instance = Wire4Client::EmpresasCoDiApi.new
+
+authorization = 'authorization_example' # String | Header para token
+
+
+begin
+  #Consulta de empresas CODI®
+  result = api_instance.obtain_companies(authorization)
+  p result
+rescue Wire4Client::ApiError => e
+  puts "Exception when calling EmpresasCoDiApi->obtain_companies: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **authorization** | **String**| Header para token | 
+
+### Return type
+
+[**Array<CompanyRegistered>**](CompanyRegistered.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **register_company_using_post**
+> CompanyRegistered register_company_using_post(authorization, request_dto)
+
+Registro de empresas CODI®
+
+Registra una empresa para hacer uso de operaciones CODI®.<br><br> <b>Nota:<b> Es requerido tener el certificado emitido por BANXICO® asi como el Nombre de la empresa, Nombre comercial y el Registro Federal de Contribuyentes (RFC) de la empresa.<br/>
+
+### Example
+```ruby
+# load the gem
+require 'wire4_client'
+
+api_instance = Wire4Client::EmpresasCoDiApi.new
+
+authorization = 'authorization_example' # String | Header para token
+
+request_dto = Wire4Client::CompanyRequested.new # CompanyRequested | Información de la cuenta del beneficiario
+
+
+begin
+  #Registro de empresas CODI®
+  result = api_instance.register_company_using_post(authorization, request_dto)
+  p result
+rescue Wire4Client::ApiError => e
+  puts "Exception when calling EmpresasCoDiApi->register_company_using_post: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **authorization** | **String**| Header para token | 
+ **request_dto** | [**CompanyRequested**](CompanyRequested.md)| Información de la cuenta del beneficiario | 
+
+### Return type
+
+[**CompanyRegistered**](CompanyRegistered.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/GetDepositants.md

@@ -3,6 +3,6 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**depositants** | [**Array<Depositant>**](Depositant.md) | Lista de depositantes que contiene cada depositante encontrado | 
+**depositants** | [**Array<Depositant>**](Depositant.md) | Es la lista que contiene cada depositante encontrad.o | 
 
 

data/docs/InstitucionesApi.md

@@ -4,13 +4,15 @@ All URIs are relative to *https://sandbox-api.wire4.mx/wire4/1.0.0*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
-[**get_all_institutions_using_get**](InstitucionesApi.md#get_all_institutions_using_get) | **GET** /institutions | Información de instituciones bancarias.
+[**get_all_institutions_using_get**](InstitucionesApi.md#get_all_institutions_using_get) | **GET** /institutions | Consulta de instituciones bancarias
 
 
 # **get_all_institutions_using_get**
 > InstitutionsList get_all_institutions_using_get(authorization)
 
-Información de instituciones bancarias.
+Consulta de instituciones bancarias
+
+Se obtiene un listado de las instituciones bancarias y la información de cada una de estas.
 
 ### Example
 ```ruby
@@ -23,7 +25,7 @@ authorization = 'authorization_example' # String | Header para token
 
 
 begin
-  #Información de instituciones bancarias.
+  #Consulta de instituciones bancarias
   result = api_instance.get_all_institutions_using_get(authorization)
   p result
 rescue Wire4Client::ApiError => e

data/docs/Institution.md

@@ -3,9 +3,9 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**company_name** | **String** | Razón social de la institución | [optional] 
-**key** | **String** | La clabe BANXICO de la institución | [optional] 
-**name** | **String** | Nombre de la institución | [optional] 
-**rfc** | **String** | RFC de la institución | [optional] 
+**company_name** | **String** | Es la razón social de la institución. | [optional] 
+**key** | **String** | Es la clave de BANXICO que pertenece a la institución. | [optional] 
+**name** | **String** | Es el nombre de la institución. | [optional] 
+**rfc** | **String** | Es el Registro Federal de Contribuyente (RFC) que pertenece a la institución bancaria. | [optional] 
 
 

data/docs/InstitutionsList.md

@@ -3,6 +3,6 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**institutions** | [**Array<Institution>**](Institution.md) | Lista de instituciones | [optional] 
+**institutions** | [**Array<Institution>**](Institution.md) | Es la lista de instituciones bancarias. | [optional] 
 
 

data/docs/Item.md

@@ -0,0 +1,10 @@
+# Wire4Client::Item
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**key** | **String** | Debe ser BY_AMOUNT para indicar la configuración por monto o BY_OPERATION para indicar la configuración por número de operaciones. Si se quiere configurar el horario de operaciones entonces se debe usar START_OPERATIONS_TIME para la hora de inicio de operaciones y END_OPERATIONS_TIME para la hora de fin de operaciones. | [optional] 
+**type** | **String** | El tipo de dato del grupo de configuraciones. Puede ser: <ul><li>DECIMAL</li><li>INT</li><li>BOOLEAN</li><li>TIME</li> | [optional] 
+**value** | **String** | Valor configurado | [optional] 
+
+

data/docs/LmitesDeMontosApi.md

@@ -0,0 +1,112 @@
+# Wire4Client::LmitesDeMontosApi
+
+All URIs are relative to *https://sandbox-api.wire4.mx/wire4/1.0.0*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**obtain_configurations_limits**](LmitesDeMontosApi.md#obtain_configurations_limits) | **GET** /subscriptions/{suscription}/configurations | Consulta de configuraciones
+[**update_configurations**](LmitesDeMontosApi.md#update_configurations) | **PUT** /subscriptions/{suscription}/configurations | Actualiza configuraciones por suscripción
+
+
+# **obtain_configurations_limits**
+> MessageConfigurationsLimits obtain_configurations_limits(authorization, suscription)
+
+Consulta de configuraciones
+
+Consulta las configuraciones para el contrato asocaido al enrolamiento en la aplicación.
+
+### Example
+```ruby
+# load the gem
+require 'wire4_client'
+
+api_instance = Wire4Client::LmitesDeMontosApi.new
+
+authorization = 'authorization_example' # String | Header para token
+
+suscription = 'suscription_example' # String | Es el identificador de la suscripción a esta API.
+
+
+begin
+  #Consulta de configuraciones
+  result = api_instance.obtain_configurations_limits(authorization, suscription)
+  p result
+rescue Wire4Client::ApiError => e
+  puts "Exception when calling LmitesDeMontosApi->obtain_configurations_limits: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **authorization** | **String**| Header para token | 
+ **suscription** | **String**| Es el identificador de la suscripción a esta API. | 
+
+### Return type
+
+[**MessageConfigurationsLimits**](MessageConfigurationsLimits.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **update_configurations**
+> update_configurations(authorization, suscription, update_configurations_resquest_dto)
+
+Actualiza configuraciones por suscripción
+
+Actualiza las configuraciones de un contrato asociado a una suscripción
+
+### Example
+```ruby
+# load the gem
+require 'wire4_client'
+
+api_instance = Wire4Client::LmitesDeMontosApi.new
+
+authorization = 'authorization_example' # String | Header para token
+
+suscription = 'suscription_example' # String | suscription
+
+update_configurations_resquest_dto = Wire4Client::UpdateConfigurationsRequestDTO.new # UpdateConfigurationsRequestDTO | updateConfigurationsResquestDTO
+
+
+begin
+  #Actualiza configuraciones por suscripción
+  api_instance.update_configurations(authorization, suscription, update_configurations_resquest_dto)
+rescue Wire4Client::ApiError => e
+  puts "Exception when calling LmitesDeMontosApi->update_configurations: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **authorization** | **String**| Header para token | 
+ **suscription** | **String**| suscription | 
+ **update_configurations_resquest_dto** | [**UpdateConfigurationsRequestDTO**](UpdateConfigurationsRequestDTO.md)| updateConfigurationsResquestDTO | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: */*
+
+
+

data/docs/MessageAccountBeneficiary.md

@@ -3,8 +3,8 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**account** | **String** | Cuenta del beneficiario | [optional] 
-**error_message** | **String** | Mensaje de error en caso de existir, el valor de este atributo contiene el mensaje | [optional] 
-**request_id** | **String** | El identificador, en esta API, de la petición de registro de la cuenta del beneficiario | [optional] 
+**account** | **String** | Es la cuenta del beneficiario registrado. | [optional] 
+**error_message** | **String** | Es el mensaje de error que se informa en caso de existir uno. | [optional] 
+**request_id** | **String** | Es el identificador en esta API de la petición de registro de la cuenta del beneficiario. | [optional] 
 
 

data/docs/MessageCEP.md

@@ -3,26 +3,26 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**account_beneficiary** | **String** | Cuenta del beneficiario | [optional] 
-**account_sender** | **String** | Cuenta que envia la operación | [optional] 
-**amount** | **Float** | Monto de la operación | [optional] 
-**available** | **BOOLEAN** | Bander para saber si el cep esta disponible | [optional] 
-**bank_beneficiary** | **String** | Clave del banco beneficiario | [optional] 
-**bank_sender** | **String** | Clave del banco que envia la operación | [optional] 
-**beneficiary_name** | **String** | Nombre del beneficiario | [optional] 
-**beneficiary_rfc** | **String** | RFC del beneficiario | [optional] 
-**cadena_original** | **String** | Cadena original emita por el SAT | [optional] 
-**capture_date** | **DateTime** | Fecha de captura | [optional] 
-**certificate_serial_number** | **String** | Numero de serie emitido por el SAT | [optional] 
-**clave_rastreo** | **String** | Clave de rastreo de la operación | [optional] 
-**description** | **String** | Descripción de la operación | [optional] 
-**iva** | **Float** | Iva de la operación | [optional] 
-**operation_date** | **DateTime** | Fecha en la que se realizó la operación | [optional] 
-**operation_date_cep** | **DateTime** | Fecha en la que genera el cep | [optional] 
-**reference** | **String** | Referencia de la operación | [optional] 
-**sender_name** | **String** | Nombre de quien envia la operación | [optional] 
-**sender_rfc** | **String** | RFC de quien envia la operación | [optional] 
-**signature** | **String** | Firma del Cep | [optional] 
-**url_zip** | **String** | Url que contiene el PDF y XML del CEP proporcionado por banxico | [optional] 
+**account_beneficiary** | **String** | Es la cuenta del beneficiario. | [optional] 
+**account_sender** | **String** | Es la cuenta que envía la operación. | [optional] 
+**amount** | **Float** | Es el monto de la operación. | [optional] 
+**available** | **BOOLEAN** | Indica sí el CEP está disponible. | [optional] 
+**bank_beneficiary** | **String** | Es la clave del banco beneficiario. | [optional] 
+**bank_sender** | **String** | Es la clave del banco que envía la operación. | [optional] 
+**beneficiary_name** | **String** | Es el nombre del beneficiario. | [optional] 
+**beneficiary_rfc** | **String** | Es el Registro Federal de Contribuyentes (RFC) del beneficiario. | [optional] 
+**cadena_original** | **String** | Es la cadena original emitida por el Servicio de Administración Tributaria (SAT). | [optional] 
+**capture_date** | **DateTime** | Es la fecha de captura. | [optional] 
+**certificate_serial_number** | **String** | Es el número de serie emitido por el SAT | [optional] 
+**clave_rastreo** | **String** | Es la clave de rastreo de la operación. | [optional] 
+**description** | **String** | Es la descripción de la operación. | [optional] 
+**iva** | **Float** | Es el Impuesto al Valor Agregado (IVA) de la operación. | [optional] 
+**operation_date** | **DateTime** | Es la fecha en la que se realizó la operación. | [optional] 
+**operation_date_cep** | **DateTime** | Es la fecha en la que se genera el CEP. | [optional] 
+**reference** | **String** | Es la Referencia de la operación | [optional] 
+**sender_name** | **String** | Es el nombre de quién envía la operación. | [optional] 
+**sender_rfc** | **String** | Es el Registro Federal de Contrinuyentes (RFC) de quién envía la operación. | [optional] 
+**signature** | **String** | Firma del CEP | [optional] 
+**url_zip** | **String** | Dirección URL de descarga del archivo ZIP que contiene el PDF y XML del CEP proporcionado por BANXICO | [optional]