wire4_client 0.0.1.pre.SNAPSHOT → 1.1.0

data/docs/FacturasApi.md

@@ -9,7 +9,7 @@ Method | HTTP request | Description
 
 
 # **billings_report_by_id_using_get**
-> Billing billings_report_by_id_using_get(id)
+> Billing billings_report_by_id_using_get(authorization, id)
 
 Consulta de facturas por identificador
 
@@ -19,20 +19,17 @@ Consulta las facturas emitidas por conceptos de uso de la plataforma y operacion
 ```ruby
 # load the gem
 require 'wire4_client'
-# setup authorization
-Wire4Client.configure do |config|
-  # Configure OAuth2 access token for authorization: wire4_aut_app
-  config.access_token = 'YOUR ACCESS TOKEN'
-end
 
 api_instance = Wire4Client::FacturasApi.new
 
+authorization = 'authorization_example' # String | Header para token
+
 id = 'id_example' # String | Identificador de la factura
 
 
 begin
   #Consulta de facturas por identificador
-  result = api_instance.billings_report_by_id_using_get(id)
+  result = api_instance.billings_report_by_id_using_get(authorization, id)
   p result
 rescue Wire4Client::ApiError => e
   puts "Exception when calling FacturasApi->billings_report_by_id_using_get: #{e}"
@@ -43,6 +40,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
+ **authorization** | **String**| Header para token | 
  **id** | **String**| Identificador de la factura | 
 
 ### Return type
@@ -51,7 +49,7 @@ Name | Type | Description  | Notes
 
 ### Authorization
 
-[wire4_aut_app](../README.md#wire4_aut_app)
+No authorization required
 
 ### HTTP request headers
 
@@ -61,7 +59,7 @@ Name | Type | Description  | Notes
 
 
 # **billings_report_using_get**
-> Array<Billing> billings_report_using_get(opts)
+> Array<Billing> billings_report_using_get(authorization, opts)
 
 Consulta de facturas
 
@@ -71,21 +69,18 @@ Consulta las facturas emitidas por conceptos de uso de la plataforma y operacion
 ```ruby
 # load the gem
 require 'wire4_client'
-# setup authorization
-Wire4Client.configure do |config|
-  # Configure OAuth2 access token for authorization: wire4_aut_app
-  config.access_token = 'YOUR ACCESS TOKEN'
-end
 
 api_instance = Wire4Client::FacturasApi.new
 
+authorization = 'authorization_example' # String | Header para token
+
 opts = { 
   period: 'period_example' # String | Filtro de fecha yyyy-MM
 }
 
 begin
   #Consulta de facturas
-  result = api_instance.billings_report_using_get(opts)
+  result = api_instance.billings_report_using_get(authorization, opts)
   p result
 rescue Wire4Client::ApiError => e
   puts "Exception when calling FacturasApi->billings_report_using_get: #{e}"
@@ -96,6 +91,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
+ **authorization** | **String**| Header para token | 
  **period** | **String**| Filtro de fecha yyyy-MM | [optional] 
 
 ### Return type
@@ -104,7 +100,7 @@ Name | Type | Description  | Notes
 
 ### Authorization
 
-[wire4_aut_app](../README.md#wire4_aut_app)
+No authorization required
 
 ### HTTP request headers
 

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,29 +4,29 @@ 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
+> 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
 # load the gem
 require 'wire4_client'
-# setup authorization
-Wire4Client.configure do |config|
-  # Configure OAuth2 access token for authorization: wire4_aut_app
-  config.access_token = 'YOUR ACCESS TOKEN'
-end
 
 api_instance = Wire4Client::InstitucionesApi.new
 
+authorization = 'authorization_example' # String | Header para token
+
+
 begin
-  #Información de instituciones bancarias.
-  result = api_instance.get_all_institutions_using_get
+  #Consulta de instituciones bancarias
+  result = api_instance.get_all_institutions_using_get(authorization)
   p result
 rescue Wire4Client::ApiError => e
   puts "Exception when calling InstitucionesApi->get_all_institutions_using_get: #{e}"
@@ -34,7 +34,10 @@ end
 ```
 
 ### Parameters
-This endpoint does not need any parameter.
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **authorization** | **String**| Header para token | 
 
 ### Return type
 
@@ -42,7 +45,7 @@ This endpoint does not need any parameter.
 
 ### Authorization
 
-[wire4_aut_app](../README.md#wire4_aut_app)
+No authorization required
 
 ### HTTP request headers
 

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] 
 
 

data/docs/MessageCodiAction.md

@@ -0,0 +1,19 @@
+# Wire4Client::MessageCodiAction
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**amount** | **Float** | Es el monto de la operación de pago. | [optional] 
+**concept** | **String** | Es el concepto de la transacción. | [optional] 
+**due_date** | **DateTime** | Es la fecha de expiración de la operación. | [optional] 
+**id** | **String** | Es el UUID de la operación. | [optional] 
+**metadata** | **String** | Es el campo Metadata asociado a la petición de pago. Es información que indica guardar la petición. | [optional] 
+**operation_date** | **DateTime** | Es la fecha de la operación. | [optional] 
+**order_id** | **String** | Es el identificador de la petición. | [optional] 
+**payment_type** | **String** | Es el tipo de pago. | [optional] 
+**reference** | **String** | Es el número de referencia. | [optional] 
+**sales_point_id** | **String** | Identidicador del punto de venta a la que pertenece la petición de pago. | [optional] 
+**status** | **String** | Es el estado (estatus) de la operación de pago. | [optional] 
+**transaction_id** | **String** | Es el identificador de la transacción. | [optional] 
+
+

data/docs/MessageConfigurationsLimits.md

@@ -0,0 +1,8 @@
+# Wire4Client::MessageConfigurationsLimits
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**configurations** | [**Array<ConfigurationsLimits>**](ConfigurationsLimits.md) | Lista de configuraciones pertenecientes al contrato | [optional] 
+
+

data/docs/MessageDepositAuthorizationRequest.md

@@ -0,0 +1,27 @@
+# Wire4Client::MessageDepositAuthorizationRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**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] 
+**clave_rastreo** | **String** | Es la clave de rastreo de la transferencia. | [optional] 
+**confirm_date** | **DateTime** | Es la Fecha de confirmación de la transferencia. | [optional] 
+**currency_code** | **String** | Es el código de divisa de la transferencia. Es en el formato estándar ISO 4217 y es de 3 dígitos. Puede ser \"MXN\" o \"USD\". | [optional] 
+**deposit_date** | **DateTime** | Es la fecha de recepción de la transferencia. | [optional] 
+**depositant** | **String** | Es el nombre del depositante en caso de que la transferencia se reciba en una cuenta de depositante. | [optional] 
+**depositant_clabe** | **String** | Es la cuenta CLABE del depositante en caso que la transferencia se reciba en una cuenta de depositante | [optional] 
+**depositant_email** | **String** | Es el Correo electrónico (email) del depositante en caso que la transferencia se reciba en una cuenta de depositante | [optional] 
+**depositant_rfc** | **String** | Es el Registro Federal de Contribuyentes (RFC) del depositante, en caso que la transferencia se reciba en una cuenta de depositante. | [optional] 
+**description** | **String** | Es el concepto de la transferencia. | [optional] 
+**monex_description** | **String** | Es la descripción de Monex para la transferencia. | [optional] 
+**monex_transaction_id** | **String** | Es el identificador asignado por Monex a la transferencia. | [optional] 
+**reference** | **String** | Es la referecia de la transferencia. | [optional] 
+**sender_account** | **String** | Es la cuenta del ordenante que podría ser un número celular (10 dígitos), una tarjeta de débito (TDD, de 16 dígitos) o Cuenta CLABE interbancaria (18 dígitos). | [optional] 
+**sender_bank** | [**MessageInstitution**](MessageInstitution.md) | Es el objeto con información del banco del ordenante. | [optional] 
+**sender_name** | **String** | Es el nombre del ordenante. | [optional] 
+**sender_rfc** | **String** | Es el Registro Federal de Contribuyente (RFC) del ordenante. | [optional] 
+
+

data/docs/MessageDepositReceived.md

@@ -3,25 +3,26 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**amount** | **Float** | Monto de la transferencia | [optional] 
-**beneficiary_account** | **String** | Cuenta del beneficiario | [optional] 
-**beneficiary_name** | **String** | Nombre del beneficiario | [optional] 
-**beneficiary_rfc** | **String** | RFC del beneficiario | [optional] 
-**clave_rastreo** | **String** | Clave de rastreo de la transferencia | [optional] 
-**confirm_date** | **DateTime** | Fecha de confirmación de la transferencia | [optional] 
-**currency_code** | **String** | Código de moneda de la transferencia, puede ser MXP, USD | [optional] 
-**deposit_date** | **DateTime** | Fecha de recepción de la transferencia | [optional] 
-**depositant** | **String** | Nombre del depositante, en caso que la transferencia se reciba en una cuenta de depositante | [optional] 
-**depositant_clabe** | **String** | CLABE del depositante, en caso que la transferencia se reciba en una cuenta de depositante | [optional] 
-**depositant_email** | **String** | Correo electrónico del depositante, en caso que la transferencia se reciba en una cuenta de depositante | [optional] 
-**depositant_rfc** | **String** | RFC del depositante, en caso que la transferencia se reciba en una cuenta de depositante | [optional] 
-**description** | **String** | Concepto de la transferencia | [optional] 
-**monex_description** | **String** | Descripción de Monex para la transferencia | [optional] 
-**monex_transaction_id** | **String** | Identificador asignado por Monex a la transferencia | [optional] 
-**reference** | **String** | Referecia de la transferencia | [optional] 
-**sender_account** | **String** | Cuenta del ordenante, podría ser un número celular, TDD o Cuenta CLABE interbancaria | [optional] 
-**sender_bank** | [**MessageInstitution**](MessageInstitution.md) | Información del banco del ordenante | [optional] 
-**sender_name** | **String** | Nombre del ordenante | [optional] 
-**sender_rfc** | **String** | 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 objeto que contiene la informacion del CEP. | [optional] 
+**clave_rastreo** | **String** | Es la clave de rastreo de la transferencia. | [optional] 
+**confirm_date** | **DateTime** | Es la Fecha de confirmación de la transferencia. | [optional] 
+**currency_code** | **String** | Es el código de divisa de la transferencia. Es en el formato estándar ISO 4217 y es de 3 dígitos. Puede ser \"MXN\" o \"USD\". | [optional] 
+**deposit_date** | **DateTime** | Es la fecha de recepción de la transferencia. | [optional] 
+**depositant** | **String** | Es el nombre del depositante en caso de que la transferencia se reciba en una cuenta de depositante. | [optional] 
+**depositant_clabe** | **String** | Es la cuenta CLABE del depositante en caso que la transferencia se reciba en una cuenta de depositante | [optional] 
+**depositant_email** | **String** | Es el Correo electrónico (email) del depositante en caso que la transferencia se reciba en una cuenta de depositante | [optional] 
+**depositant_rfc** | **String** | Es el Registro Federal de Contribuyentes (RFC) del depositante, en caso que la transferencia se reciba en una cuenta de depositante. | [optional] 
+**description** | **String** | Es el concepto de la transferencia. | [optional] 
+**monex_description** | **String** | Es la descripción de Monex para la transferencia. | [optional] 
+**monex_transaction_id** | **String** | Es el identificador asignado por Monex a la transferencia. | [optional] 
+**reference** | **String** | Es la referecia de la transferencia. | [optional] 
+**sender_account** | **String** | Es la cuenta del ordenante que podría ser un número celular (10 dígitos), una tarjeta de débito (TDD, de 16 dígitos) o Cuenta CLABE interbancaria (18 dígitos). | [optional] 
+**sender_bank** | [**MessageInstitution**](MessageInstitution.md) | Es el objeto con información del banco del ordenante. | [optional] 
+**sender_name** | **String** | Es el nombre del ordenante. | [optional] 
+**sender_rfc** | **String** | Es el Registro Federal de Contribuyente (RFC) del ordenante. | [optional]