wire4_client 0.0.1.pre.SNAPSHOT → 0.0.9.pre.TEST

data/docs/Deposit.md

@@ -7,6 +7,7 @@ Name | Type | Description | Notes
 **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] 

data/docs/DepositAuthorizationRequest.md

@@ -0,0 +1,10 @@
+# Wire4Client::DepositAuthorizationRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**enabled** | **BOOLEAN** | Indica sí se aplica 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/DepositantesApi.md

@@ -9,7 +9,7 @@ Method | HTTP request | Description
 
 
 # **get_depositants_using_get**
-> GetDepositants get_depositants_using_get(subscription)
+> GetDepositants get_depositants_using_get(authorization, subscription)
 
 Consulta de cuentas de depositantes
 
@@ -19,20 +19,17 @@ Obtiene una lista de depositantes asociados al contrato relacionado a la subscri
 ```ruby
 # load the gem
 require 'wire4_client'
-# setup authorization
-Wire4Client.configure do |config|
-  # Configure OAuth2 access token for authorization: wire4_aut_app_user_spei
-  config.access_token = 'YOUR ACCESS TOKEN'
-end
 
 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
 
 
 begin
   #Consulta de cuentas de depositantes
-  result = api_instance.get_depositants_using_get(subscription)
+  result = api_instance.get_depositants_using_get(authorization, subscription)
   p result
 rescue Wire4Client::ApiError => e
   puts "Exception when calling DepositantesApi->get_depositants_using_get: #{e}"
@@ -43,6 +40,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
+ **authorization** | **String**| Header para token | 
  **subscription** | **String**| El identificador de la suscripción a esta API | 
 
 ### Return type
@@ -51,7 +49,7 @@ Name | Type | Description  | Notes
 
 ### Authorization
 
-[wire4_aut_app_user_spei](../README.md#wire4_aut_app_user_spei)
+No authorization required
 
 ### HTTP request headers
 
@@ -61,7 +59,7 @@ Name | Type | Description  | Notes
 
 
 # **register_depositants_using_post**
-> DepositantsResponse register_depositants_using_post(register, subscription)
+> DepositantsResponse register_depositants_using_post(authorization, register, subscription)
 
 Registra un nuevo depositante
 
@@ -71,14 +69,11 @@ Registra un nuevo depositante en el contrato asociado a la subscripción.
 ```ruby
 # load the gem
 require 'wire4_client'
-# setup authorization
-Wire4Client.configure do |config|
-  # Configure OAuth2 access token for authorization: wire4_aut_app_user_spei
-  config.access_token = 'YOUR ACCESS TOKEN'
-end
 
 api_instance = Wire4Client::DepositantesApi.new
 
+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
@@ -86,7 +81,7 @@ subscription = 'subscription_example' # String | El identificador de la suscripc
 
 begin
   #Registra un nuevo depositante
-  result = api_instance.register_depositants_using_post(register, subscription)
+  result = api_instance.register_depositants_using_post(authorization, register, subscription)
   p result
 rescue Wire4Client::ApiError => e
   puts "Exception when calling DepositantesApi->register_depositants_using_post: #{e}"
@@ -97,6 +92,7 @@ end
 
 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 | 
 
@@ -106,7 +102,7 @@ Name | Type | Description  | Notes
 
 ### Authorization
 
-[wire4_aut_app_user_spei](../README.md#wire4_aut_app_user_spei)
+No authorization required
 
 ### HTTP request headers
 

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 de solo lectura, sí otra aplicación tiene el control sobre la autorización de depósitos | [optional] 
+**webhook** | [**WebHookDepositAuthorizationResponse**](WebHookDepositAuthorizationResponse.md) | 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. Es requerido tener el certificado emitido por BANXICO® asi como el Nombre de la empresa, Nombre comercial y 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/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/InstitucionesApi.md

@@ -8,7 +8,7 @@ Method | HTTP request | Description
 
 
 # **get_all_institutions_using_get**
-> InstitutionsList get_all_institutions_using_get
+> InstitutionsList get_all_institutions_using_get(authorization)
 
 Información de instituciones bancarias.
 
@@ -16,17 +16,15 @@ Información de instituciones bancarias.
 ```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
+  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 +32,10 @@ end
 ```
 
 ### Parameters
-This endpoint does not need any parameter.
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **authorization** | **String**| Header para token | 
 
 ### Return type
 
@@ -42,7 +43,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/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 | [optional] 
+**type** | **String** | El tipo de dato del grupo de configuraciones. | [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 las configuraciones para el contrato asocaido al enrolamiento en la aplicación
+[**update_configurations**](LmitesDeMontosApi.md#update_configurations) | **PUT** /subscriptions/{suscription}/configurations | Actualiza las configuraciones por subscripción
+
+
+# **obtain_configurations_limits**
+> MessageConfigurationsLimits obtain_configurations_limits(authorization, suscription)
+
+Consulta las configuraciones para el contrato asocaido al enrolamiento en la aplicación
+
+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 | Identificador de la suscripción a esta API
+
+
+begin
+  #Consulta las configuraciones para el contrato asocaido al enrolamiento en la aplicación
+  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**| 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 las configuraciones por subscripción
+
+Actualiza las configuraciones de un contrato asociado a una subscripció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 las configuraciones por subscripció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**: */*
+
+
+