wire4_client 1.0.5 → 1.1.0

data/docs/CuentasDeBeneficiariosSPIDApi.md

@@ -5,7 +5,7 @@ All URIs are relative to *https://sandbox-api.wire4.mx/wire4/1.0.0*
 Method | HTTP request | Description
 ------------- | ------------- | -------------
 [**get_spid_beneficiaries_for_account**](CuentasDeBeneficiariosSPIDApi.md#get_spid_beneficiaries_for_account) | **GET** /subscriptions/{subscription}/beneficiaries/spid | Consulta los beneficiarios SPID registrados
-[**pre_register_accounts_using_post1**](CuentasDeBeneficiariosSPIDApi.md#pre_register_accounts_using_post1) | **POST** /subscriptions/{subscription}/beneficiaries/spid | Pre-registro de cuentas de beneficiarios SPID
+[**pre_register_accounts_using_post1**](CuentasDeBeneficiariosSPIDApi.md#pre_register_accounts_using_post1) | **POST** /subscriptions/{subscription}/beneficiaries/spid | Pre-registro de cuentas de beneficiarios SPID®
 
 
 # **get_spid_beneficiaries_for_account**
@@ -13,7 +13,7 @@ Method | HTTP request | Description
 
 Consulta los beneficiarios SPID registrados
 
-Obtiene los beneficiarios SPID registrados al contrato relacionado con la suscripción, Los beneficiarios son los que actualmente se encuentran registrados en banca Monex.
+Obtiene los beneficiarios SPID registrados al contrato relacionado con la suscripción. Los beneficiarios son los que actualmente se encuentran registrados en banca Monex.
 
 ### Example
 ```ruby
@@ -24,16 +24,16 @@ api_instance = Wire4Client::CuentasDeBeneficiariosSPIDApi.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.
 
 opts = { 
-  account: 'account_example', # String | Cuenta del beneficiario, puede ser Clabe, TDD o Celular
-  beneficiary_bank: 'beneficiary_bank_example', # String | Clave del banco beneficiario
-  beneficiary_name: 'beneficiary_name_example', # String | Nombre del beneficiario
-  end_date: 'end_date_example', # String | Fecha de inicio del perido a filtrar en formato dd-mm-yyyy
-  init_date: 'init_date_example', # String | Fecha de inicio del perido a filtrar en formato dd-mm-yyyy
-  rfc: 'rfc_example', # String | RFC del beneficiario
-  status: 'status_example' # String | Estatus de la cuenta
+  account: 'account_example', # String | Cuenta del beneficiario, puede ser CLABE (18 dígitos), Tarjeta de débito  (TDD, 16 dígitos) o número de celular (10 dígitos).
+  beneficiary_bank: 'beneficiary_bank_example', # String | Es la clave del banco beneficiario. Se puede obtener del catalogo de <a href=\"#operation/getAllInstitutionsUsingGET\">instituciones.</a>
+  beneficiary_name: 'beneficiary_name_example', # String | Es el nombre del beneficiario.
+  end_date: 'end_date_example', # String | Es la fecha de inicio del periodo a filtrar en formato dd-mm-yyyy.
+  init_date: 'init_date_example', # String | Es la fecha de inicio del periodo a filtrar en formato dd-mm-yyyy.
+  rfc: 'rfc_example', # String | Es el Registro Federal de Contribuyentes (RFC) del beneficiario.
+  status: 'status_example' # String | Es el estado (estatus) de la cuenta, Los valores pueden ser <b>PENDING</b> y <b>REGISTERED</b>.
 }
 
 begin
@@ -50,14 +50,14 @@ end
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **authorization** | **String**| Header para token | 
- **subscription** | **String**| El identificador de la suscripción a esta API | 
- **account** | **String**| Cuenta del beneficiario, puede ser Clabe, TDD o Celular | [optional] 
- **beneficiary_bank** | **String**| Clave del banco beneficiario | [optional] 
- **beneficiary_name** | **String**| Nombre del beneficiario | [optional] 
- **end_date** | **String**| Fecha de inicio del perido a filtrar en formato dd-mm-yyyy | [optional] 
- **init_date** | **String**| Fecha de inicio del perido a filtrar en formato dd-mm-yyyy | [optional] 
- **rfc** | **String**| RFC del beneficiario | [optional] 
- **status** | **String**| Estatus de la cuenta | [optional] 
+ **subscription** | **String**| Es el identificador de la suscripción a esta API. | 
+ **account** | **String**| Cuenta del beneficiario, puede ser CLABE (18 dígitos), Tarjeta de débito  (TDD, 16 dígitos) o número de celular (10 dígitos). | [optional] 
+ **beneficiary_bank** | **String**| Es la clave del banco beneficiario. Se puede obtener del catalogo de &lt;a href&#x3D;\&quot;#operation/getAllInstitutionsUsingGET\&quot;&gt;instituciones.&lt;/a&gt; | [optional] 
+ **beneficiary_name** | **String**| Es el nombre del beneficiario. | [optional] 
+ **end_date** | **String**| Es la fecha de inicio del periodo a filtrar en formato dd-mm-yyyy. | [optional] 
+ **init_date** | **String**| Es la fecha de inicio del periodo a filtrar en formato dd-mm-yyyy. | [optional] 
+ **rfc** | **String**| Es el Registro Federal de Contribuyentes (RFC) del beneficiario. | [optional] 
+ **status** | **String**| Es el estado (estatus) de la cuenta, Los valores pueden ser &lt;b&gt;PENDING&lt;/b&gt; y &lt;b&gt;REGISTERED&lt;/b&gt;. | [optional] 
 
 ### Return type
 
@@ -77,7 +77,9 @@ No authorization required
 # **pre_register_accounts_using_post1**
 > TokenRequiredResponse pre_register_accounts_using_post1(authorization, request_spid_dto, subscription)
 
-Pre-registro de cuentas de beneficiarios SPID
+Pre-registro de cuentas de beneficiarios SPID®
+
+Pre-registra una o más cuentas de beneficiario SPID® en la plataforma de Wire4, ésta le proporcionaará una URL donde lo llevará al centro de autorización para que el cuentahabiente Monex ingrese su llave digital para confirmar el alta de las cuentas de beneficiarios.<br/> Los posibles valores de <em>relationship</em> y <em>kind_of_relationship</em> se deben  obtener de <a href=\"#operation/getAvailableRelationshipsMonexUsingGET\">/subscriptions/{subscription}/beneficiaries/relationships.</a><br/><br/>La confirmación de registro en Monex se realizará a través de una notificación a los webhooks registrados con el evento de tipo <a href=\"#section/Eventos/Tipos-de-Eventos\">ACCOUNT.CREATED.</a>
 
 ### Example
 ```ruby
@@ -90,11 +92,11 @@ authorization = 'authorization_example' # String | Header para token
 
 request_spid_dto = Wire4Client::AccountSpid.new # AccountSpid | Información de la cuenta del beneficiario
 
-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
-  #Pre-registro de cuentas de beneficiarios SPID
+  #Pre-registro de cuentas de beneficiarios SPID®
   result = api_instance.pre_register_accounts_using_post1(authorization, request_spid_dto, subscription)
   p result
 rescue Wire4Client::ApiError => e
@@ -108,7 +110,7 @@ Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **authorization** | **String**| Header para token | 
  **request_spid_dto** | [**AccountSpid**](AccountSpid.md)| Información de la cuenta del beneficiario | 
- **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/Deposit.md

@@ -3,26 +3,26 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**amount** | **Float** | Monto de la transferencia | [optional] 
-**beneficiary_account** | **String** | La cuenta del beneficiario | [optional] 
-**beneficiary_name** | **String** | El nombre del beneficiario | [optional] 
-**beneficiary_rfc** | **String** | El RFC del beneficiario | [optional] 
-**cep** | [**MessageCEP**](MessageCEP.md) | CEP emitido por Banxico de la transferencia, sólo en caso de que este disponible en banxico, posteriomente  podrá usar la consulta de CEP del API | [optional] 
-**clave_rastreo** | **String** | La clave de rastreo de la transferencia | [optional] 
-**confirm_date** | **DateTime** | Fecha de confirmación del deposito | [optional] 
-**currency_code** | **String** | Código de moneda de la transferencia | [optional] 
-**deposit_date** | **DateTime** | Fecha del deposito | [optional] 
-**depositant** | **String** | Depositante | [optional] 
-**depositant_clabe** | **String** | Cuenta CLABE interbancaria del depositante | [optional] 
-**depositant_email** | **String** | Email del depositante | [optional] 
-**depositant_rfc** | **String** | RFC del depositante | [optional] 
-**description** | **String** | Descripción del traspaso | [optional] 
-**monex_description** | **String** | Descripción directa de Monex | [optional] 
-**monex_transaction_id** | **String** | Identificador de la transferencia en Monex | [optional] 
-**reference** | **String** | La referencia del depósito | [optional] 
-**sender_account** | **String** | La cuenta del ordenante | [optional] 
-**sender_bank** | [**MessageInstitution**](MessageInstitution.md) | El banco del ordenante | [optional] 
-**sender_name** | **String** | El nombre del ordenante | [optional] 
-**sender_rfc** | **String** | El RFC del ordenante | [optional] 
+**amount** | **Float** | Es el monto de la transferencia. | [optional] 
+**beneficiary_account** | **String** | Es la cuenta del beneficiario. | [optional] 
+**beneficiary_name** | **String** | Es el nombre del beneficiario. | [optional] 
+**beneficiary_rfc** | **String** | Es el Registro Federal de Contribuyentes (RFC) del beneficiario. | [optional] 
+**cep** | [**MessageCEP**](MessageCEP.md) | Es el Comprobante Electrónico de Pago (CEP) emitido por Banxico que pertenece a la transferencia. Se informa sólo en caso de que esté disponible en banxico, posteriomente podrá usar la  <a href=\"#operation/obtainTransactionCepUsingPOST\">Consulta de CEP</a> que ésta misma API ofrece. | [optional] 
+**clave_rastreo** | **String** | Es la clave de rastreo de la transferencia. | [optional] 
+**confirm_date** | **DateTime** | Es la fecha de confirmación del deposito. Ésta fecha viene en formato ISO 8601 con zona horaria, ejemplo: <strong>2020-10-27T11:03:15.000-06:00</strong>. | [optional] 
+**currency_code** | **String** | Es el código de divisa de la transferencia. Es en el formato estándar de 3 dígitos, por ejemplo para el peso mexicano: <b>MXP</b>, para el dólar estadounidense: <b>USD</b>. | [optional] 
+**deposit_date** | **DateTime** | Es la fecha del deposito.  Ésta fecha viene en formato ISO 8601 con zona horaria, ejemplo: <strong>2020-10-27T11:03:15.000-06:00</strong>. | [optional] 
+**depositant** | **String** | Es el depositante. | [optional] 
+**depositant_clabe** | **String** | Es la Cuenta CLABE interbancaria (de 18 dígitos) del depositante. | [optional] 
+**depositant_email** | **String** | Es el correo electrónico (email) del depositante. | [optional] 
+**depositant_rfc** | **String** | Es el Registro Federal de Contribuyentes (RFC) del depositante. | [optional] 
+**description** | **String** | Es la descripción del traspaso. | [optional] 
+**monex_description** | **String** | Es la descripción directa de Monex. | [optional] 
+**monex_transaction_id** | **String** | es el identificador de la transferencia en Monex. | [optional] 
+**reference** | **String** | Es la referencia del depósito. | [optional] 
+**sender_account** | **String** | Es la cuenta del ordenante. | [optional] 
+**sender_bank** | [**MessageInstitution**](MessageInstitution.md) | Es el banco del ordenante. | [optional] 
+**sender_name** | **String** | Es el nombre del ordenante. | [optional] 
+**sender_rfc** | **String** | Es el Registro Federal de Contribuyentes (RFC) de la cuenta ordenante. | [optional] 
 
 

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

@@ -4,16 +4,16 @@ 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**](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®
 
-Consulta de empresas CODI registradas para la aplicación.
+Consulta de empresas CODI® registradas para la aplicación.
 
 ### Example
 ```ruby
@@ -26,7 +26,7 @@ authorization = 'authorization_example' # String | Header para token
 
 
 begin
-  #Consulta de empresas CODI
+  #Consulta de empresas CODI®
   result = api_instance.obtain_companies(authorization)
   p result
 rescue Wire4Client::ApiError => e
@@ -58,9 +58,9 @@ No authorization required
 # **register_company_using_post**
 > CompanyRegistered register_company_using_post(authorization, request_dto)
 
-Registro de empresas CODI
+Registro de empresas CODI®
 
-Registra una empresa para hacer uso de operaciones CODI. Es requerido tener el certificado emitido por BANXICO® asi como el Nombre de la empresa, Nombre comercial y RFC de la empresa.<br/>
+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
@@ -75,7 +75,7 @@ request_dto = Wire4Client::CompanyRequested.new # CompanyRequested | Informació
 
 
 begin
-  #Registro de empresas CODI
+  #Registro de empresas CODI®
   result = api_instance.register_company_using_post(authorization, request_dto)
   p result
 rescue Wire4Client::ApiError => e

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**: */*
+
+
+