wire4_client 1.0.3 → 1.0.5

data/docs/Operations.md

@@ -0,0 +1,17 @@
+# Wire4Client::Operations
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**amount** | **Float** | Monto de la petición | [optional] 
+**company** | [**Compay**](Compay.md) | Empresa CoDi | [optional] 
+**description** | **String** | Descripción de la petición | [optional] 
+**due_date** | **DateTime** | Fecha de vencimiento de la petición | [optional] 
+**order_id** | **String** | Order id de la petición | [optional] 
+**payment** | [**Payment**](Payment.md) | Pago | [optional] 
+**phone_number** | **String** | Numero de telefono | [optional] 
+**sales_point** | [**SalesPoint**](SalesPoint.md) | Punto de venta | [optional] 
+**status** | **String** | Estatus de la petición | [optional] 
+**type** | **String** | Tipo de petición de cobro | [optional] 
+
+

data/docs/PagerResponseDto.md

@@ -0,0 +1,13 @@
+# Wire4Client::PagerResponseDto
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**content** | [**Array<Operations>**](Operations.md) | Contenido de la respuesta paginada | [optional] 
+**number_of_elements** | **Integer** | Numero de elementos en la pagina | [optional] 
+**page** | **Integer** | Número de pagina | [optional] 
+**size** | **Integer** | Tamaño de la pagina | [optional] 
+**total_items** | **Integer** | Numero total de elementos de la consulta | [optional] 
+**total_pages** | **Integer** | Numero total de paginas | [optional] 
+
+

data/docs/Payment.md

@@ -8,15 +8,17 @@ Name | Type | Description | Notes
 **beneficiary_account** | **String** | Cuenta del beneficiario | [optional] 
 **beneficiary_bank** | [**Institution**](Institution.md) | Información del banco beneficiario | [optional] 
 **beneficiary_name** | **String** | Nombre 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] 
+**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** | Clave de rastreo de la transferencia | [optional] 
 **concept** | **String** | Concepto de pago | [optional] 
 **confirm_date** | **DateTime** | Fecha de aplicación de la transferencia | [optional] 
 **currency_code** | **String** | Código de moneda de la transferencia | [optional] 
 **detention_message** | **String** | Mensaje proporcionado por Monex para la transferencia | [optional] 
+**error_message** | **String** | Mensaje de error, en caso de algún error se informará aquí | [optional] 
 **monex_description** | **String** | Descripción | [optional] 
 **order_id** | **String** | Identificador asignado por la aplciación a la transferencia | [optional] 
 **payment_order_id** | **Integer** | Identificador de la orden de pago en Monex | [optional] 
+**pending_reason** | **String** | Razón de porque esta pendiente aun cuando se autorizó la transferencia | [optional] 
 **reference** | **Integer** | Referencia numérica | [optional] 
 **status_code** | **String** | Estado de la transferencia de la transferencia, los posibles valores son: PENDING, COMPLETED, FAILED, CANCELLED | [optional] 
 **transaction_id** | **Integer** | Identificador de la transferencia asignado por Monex | [optional] 

data/docs/PaymentRequestCodiResponseDTO.md

@@ -0,0 +1,18 @@
+# Wire4Client::PaymentRequestCodiResponseDTO
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**amount** | **Float** | Monto del pago. | [optional] 
+**barcode_base64** | **String** | Imagen QR en formato Base64 para el CODI®. | [optional] 
+**barcode_url** | **String** | URL de la imagen QR para el CODI®. | [optional] 
+**concept** | **String** | Concepto de pago. | [optional] 
+**creation_date** | **DateTime** | Fecha de creación. | [optional] 
+**due_date** | **DateTime** | Fecha de vencimiento. | [optional] 
+**operations** | [**Array<CodiOperationResponseDTO>**](CodiOperationResponseDTO.md) | Listado de pagos realizados sobre la petición. | [optional] 
+**order_id** | **String** | OrderId asignada a la solicitud. | [optional] 
+**phone_number** | **String** | Numero de teléfono. | [optional] 
+**status** | **String** | Estatus de la orden de pago. | [optional] 
+**type** | **String** | Tipo de petición. | [optional] 
+
+

data/docs/PeticionesDePagoPorCoDiApi.md

@@ -0,0 +1,116 @@
+# Wire4Client::PeticionesDePagoPorCoDiApi
+
+All URIs are relative to *https://sandbox-api.wire4.mx/wire4/1.0.0*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**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
+[**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®
+
+
+# **consult_codi_request_by_order_id**
+> PaymentRequestCodiResponseDTO consult_codi_request_by_order_id(authorization, order_id, sales_point_id)
+
+Obtiene la información de una petición de pago CODI® por orderId para un punto de venta
+
+Obtiene la información de una petición de pago CODI® por orderId para un punto de venta
+
+### Example
+```ruby
+# load the gem
+require 'wire4_client'
+
+api_instance = Wire4Client::PeticionesDePagoPorCoDiApi.new
+
+authorization = 'authorization_example' # String | Header para token
+
+order_id = 'order_id_example' # String | Identificador del pago CODI®
+
+sales_point_id = 'sales_point_id_example' # String | Identificador del punto de venta
+
+
+begin
+  #Obtiene la información de una petición de pago CODI® por orderId para un punto de venta
+  result = api_instance.consult_codi_request_by_order_id(authorization, order_id, sales_point_id)
+  p result
+rescue Wire4Client::ApiError => e
+  puts "Exception when calling PeticionesDePagoPorCoDiApi->consult_codi_request_by_order_id: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **authorization** | **String**| Header para token | 
+ **order_id** | **String**| Identificador del pago CODI® | 
+ **sales_point_id** | **String**| Identificador del punto de venta | 
+
+### Return type
+
+[**PaymentRequestCodiResponseDTO**](PaymentRequestCodiResponseDTO.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **generate_codi_code_qr**
+> CodiCodeQrResponseDTO generate_codi_code_qr(authorization, codi_info, sales_point_id)
+
+Genera un código QR para un pago mediante CODI®
+
+Genera un código QR solicitado por un punto de venta para un pago mediante CODI®
+
+### Example
+```ruby
+# load the gem
+require 'wire4_client'
+
+api_instance = Wire4Client::PeticionesDePagoPorCoDiApi.new
+
+authorization = 'authorization_example' # String | Header para token
+
+codi_info = Wire4Client::CodiCodeRequestDTO.new # CodiCodeRequestDTO | Información del pago CODI®
+
+sales_point_id = 'sales_point_id_example' # String | Identificador del punto de venta
+
+
+begin
+  #Genera un código QR para un pago mediante CODI®
+  result = api_instance.generate_codi_code_qr(authorization, codi_info, sales_point_id)
+  p result
+rescue Wire4Client::ApiError => e
+  puts "Exception when calling PeticionesDePagoPorCoDiApi->generate_codi_code_qr: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **authorization** | **String**| Header para token | 
+ **codi_info** | [**CodiCodeRequestDTO**](CodiCodeRequestDTO.md)| Información del pago CODI® | 
+ **sales_point_id** | **String**| Identificador del punto de venta | 
+
+### Return type
+
+[**CodiCodeQrResponseDTO**](CodiCodeQrResponseDTO.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/PreMonexAuthorization.md

@@ -0,0 +1,11 @@
+# Wire4Client::PreMonexAuthorization
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**business_name** | **String** | Razón social de asociada al RFC a la que debe pertenecer el contrato que se solicita | 
+**cancel_return_url** | **String** | Url a la que se redirigira en caso de que el cliente cancele el registro | 
+**return_url** | **String** | Url a la que se redirigirá en caso de exito | 
+**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 | 
+
+

data/docs/PuntosDeVentaCoDiApi.md

@@ -0,0 +1,113 @@
+# Wire4Client::PuntosDeVentaCoDiApi
+
+All URIs are relative to *https://sandbox-api.wire4.mx/wire4/1.0.0*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create_sales_point**](PuntosDeVentaCoDiApi.md#create_sales_point) | **POST** /codi/companies/salespoint | Registra un punto de venta asociado a una empresa
+[**obtain_sale_points**](PuntosDeVentaCoDiApi.md#obtain_sale_points) | **GET** /codi/companies/salespoint | Obtiene los puntos de venta asociados a una empresa
+
+
+# **create_sales_point**
+> SalesPointRespose create_sales_point(authorization, company_id, sales_point_info)
+
+Registra un punto de venta asociado a una empresa
+
+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®
+
+### Example
+```ruby
+# load the gem
+require 'wire4_client'
+
+api_instance = Wire4Client::PuntosDeVentaCoDiApi.new
+
+authorization = 'authorization_example' # String | Header para token
+
+company_id = 'company_id_example' # String | El identificador de la empresa
+
+sales_point_info = Wire4Client::SalesPointRequest.new # SalesPointRequest | Información del punto de venta CODI®
+
+
+begin
+  #Registra un punto de venta asociado a una empresa
+  result = api_instance.create_sales_point(authorization, company_id, sales_point_info)
+  p result
+rescue Wire4Client::ApiError => e
+  puts "Exception when calling PuntosDeVentaCoDiApi->create_sales_point: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **authorization** | **String**| Header para token | 
+ **company_id** | **String**| El identificador de la empresa | 
+ **sales_point_info** | [**SalesPointRequest**](SalesPointRequest.md)| Información del punto de venta CODI® | 
+
+### Return type
+
+[**SalesPointRespose**](SalesPointRespose.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **obtain_sale_points**
+> Array<SalesPointFound> obtain_sale_points(authorization, company_id)
+
+Obtiene los puntos de venta asociados a una empresa
+
+Obtiene los puntos de venta asociados a una empresa en las cuales se hacen operaciones CODI®
+
+### Example
+```ruby
+# load the gem
+require 'wire4_client'
+
+api_instance = Wire4Client::PuntosDeVentaCoDiApi.new
+
+authorization = 'authorization_example' # String | Header para token
+
+company_id = 'company_id_example' # String | El identificador de la empresa
+
+
+begin
+  #Obtiene los puntos de venta asociados a una empresa
+  result = api_instance.obtain_sale_points(authorization, company_id)
+  p result
+rescue Wire4Client::ApiError => e
+  puts "Exception when calling PuntosDeVentaCoDiApi->obtain_sale_points: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **authorization** | **String**| Header para token | 
+ **company_id** | **String**| El identificador de la empresa | 
+
+### Return type
+
+[**Array<SalesPointFound>**](SalesPointFound.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+

data/docs/SalesPoint.md

@@ -0,0 +1,10 @@
+# Wire4Client::SalesPoint
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**account** | **String** | Cuenta CLABE | [optional] 
+**name** | **String** | Nombre del punto de venta | [optional] 
+**sales_point_id** | **String** | Identificador del punto de venta | [optional] 
+
+

data/docs/SalesPointFound.md

@@ -0,0 +1,14 @@
+# Wire4Client::SalesPointFound
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**access_ip** | **String** | Ip desde la que accede el punto de venta a wire4 y a la que se devuelven las notificaciones | [optional] 
+**account** | **String** | Cuenta registra para el punto de venta | [optional] 
+**created_at** | [**Timestamp**](Timestamp.md) | Fecha en la que se creó el punto de venta | [optional] 
+**name** | **String** | Nombre del punto de venta | [optional] 
+**public_id** | **String** | Identificador del punto de venta | [optional] 
+**status** | **String** | Estatus ACTIVO/INACTIVO el punto de venta | [optional] 
+**updated_at** | [**Timestamp**](Timestamp.md) | Fecha en la que se actualizó el punto de venta | [optional] 
+
+

data/docs/SalesPointRequest.md

@@ -0,0 +1,11 @@
+# Wire4Client::SalesPointRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**access_ip** | **String** | IP desde donde se recibiran las peticiones de este punto de venta | 
+**account** | **String** | Número de cuenta CLABE donde se realizará el deposito del cobro CoDi | 
+**name** | **String** | Nombre del punto de venta | 
+**notifications_url** | **String** | URL para envíar notificaciones CoDi al punto de venta | 
+
+

data/docs/SalesPointRespose.md

@@ -0,0 +1,11 @@
+# Wire4Client::SalesPointRespose
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**sales_point_id** | **String** | Identificador del punto de venta | [optional] 
+**user_key** | **String** | Llave de usuario para el API Wire4 | [optional] 
+**user_secret** | **String** | Contraseña para el API Wire4 | [optional] 
+**webhook** | [**Webhook**](Webhook.md) | Webhook registrado para enviar las notificaciones CoDi | [optional] 
+
+

data/docs/SpidBeneficiaryResponse.md

@@ -11,7 +11,9 @@ Name | Type | Description | Notes
 **kind_of_relationship** | **String** | Tipo de relación de la cuenta, este valor debe ser igual a uno de los obtenidos del recurso de consulta de relationships | 
 **numeric_reference_spid** | **String** | Referencia numérica | [optional] 
 **payment_concept_spid** | **String** | Concepto de pago | [optional] 
+**register_date** | **DateTime** | La fecha en la que se registro el beneficiario | [optional] 
 **relationship** | **String** | Código de relación de la cuenta, este valor debe ser igual a uno de los obtenidos del recurso de consulta de  relationship | 
 **rfc** | **String** | Registro federal de contribuyentes | [optional] 
+**status** | **String** | El estado en el que se encuentra el registo del beneficiario | [optional] 
 
 

data/docs/SuscripcionesApi.md

@@ -4,17 +4,17 @@ All URIs are relative to *https://sandbox-api.wire4.mx/wire4/1.0.0*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
-[**pre_enrollment_monex_user_using_post**](SuscripcionesApi.md#pre_enrollment_monex_user_using_post) | **POST** /subscriptions/pre-subscription | registra una pre-suscripción
-[**remove_enrollment_user_using_delete**](SuscripcionesApi.md#remove_enrollment_user_using_delete) | **DELETE** /subscriptions/{subscription} | Elimna una suscripción por id
-[**remove_subscription_pending_status_using_delete**](SuscripcionesApi.md#remove_subscription_pending_status_using_delete) | **DELETE** /subscriptions/pre-subscription/{subscription} | Elimna una pre-suscripción
+[**pre_enrollment_monex_user_using_post**](SuscripcionesApi.md#pre_enrollment_monex_user_using_post) | **POST** /subscriptions/pre-subscription | Registra una pre-suscripción
+[**remove_enrollment_user_using_delete**](SuscripcionesApi.md#remove_enrollment_user_using_delete) | **DELETE** /subscriptions/{subscription} | Elimina una suscripción por el identificador de la suscripción
+[**remove_subscription_pending_status_using_delete**](SuscripcionesApi.md#remove_subscription_pending_status_using_delete) | **DELETE** /subscriptions/pre-subscription/{subscription} | Elimina una pre-suscripción
 
 
 # **pre_enrollment_monex_user_using_post**
 > PreEnrollmentResponse pre_enrollment_monex_user_using_post(authorization, pre_enrollment_data)
 
-registra una pre-suscripción
+Registra una pre-suscripción
 
-Pre-registra una suscripción para operar un contrato a través de un aplicación socio de la plataforma, proporcionando una URL donde el cliente Monex debe autorizar el acceso a los datos de su cuenta a el socio.<br/>Una vez que el cuentahabiente autorice el acceso, se envia un webhook con el evento ENROLLMENT.CREATED, el cual contiene los datos de acceso.
+Registra una pre-suscripción para operar un contrato a través de un aplicación socio de la plataforma, proporcionando una URL donde el cliente Monex debe autorizar el acceso a los datos de su cuenta a el socio.<br/>Una vez que el cuentahabiente autorice el acceso, se envía un mensaje webhook con el evento 'ENROLLMENT.CREATED', el cuál contiene los datos de acceso a esta API.
 
 ### Example
 ```ruby
@@ -25,11 +25,11 @@ api_instance = Wire4Client::SuscripcionesApi.new
 
 authorization = 'authorization_example' # String | Header para token
 
-pre_enrollment_data = Wire4Client::PreEnrollmentData.new # PreEnrollmentData | Información para el enrolamiento
+pre_enrollment_data = Wire4Client::PreEnrollmentData.new # PreEnrollmentData | Información para la pre-suscripción
 
 
 begin
-  #registra una pre-suscripción
+  #Registra una pre-suscripción
   result = api_instance.pre_enrollment_monex_user_using_post(authorization, pre_enrollment_data)
   p result
 rescue Wire4Client::ApiError => e
@@ -42,7 +42,7 @@ end
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **authorization** | **String**| Header para token | 
- **pre_enrollment_data** | [**PreEnrollmentData**](PreEnrollmentData.md)| Información para el enrolamiento | 
+ **pre_enrollment_data** | [**PreEnrollmentData**](PreEnrollmentData.md)| Información para la pre-suscripción | 
 
 ### Return type
 
@@ -62,9 +62,9 @@ No authorization required
 # **remove_enrollment_user_using_delete**
 > remove_enrollment_user_using_delete(authorization, subscription)
 
-Elimna una suscripción por id
+Elimina una suscripción por el identificador de la suscripción
 
-Elimina una suscripción, una ves eliminada la suscripcion ya no se podran realizar operacions en el API uilizando esta suscripción
+Elimina una suscripción, una vez eliminada ya no se podrán realizar operacions en el API utilizando esta suscripción
 
 ### Example
 ```ruby
@@ -79,7 +79,7 @@ subscription = 'subscription_example' # String | El identificador de la suscripc
 
 
 begin
-  #Elimna una suscripción por id
+  #Elimina una suscripción por el identificador de la suscripción
   api_instance.remove_enrollment_user_using_delete(authorization, subscription)
 rescue Wire4Client::ApiError => e
   puts "Exception when calling SuscripcionesApi->remove_enrollment_user_using_delete: #{e}"
@@ -111,9 +111,9 @@ No authorization required
 # **remove_subscription_pending_status_using_delete**
 > remove_subscription_pending_status_using_delete(authorization, subscription)
 
-Elimna una pre-suscripción
+Elimina una pre-suscripción
 
-Se elimina una pre-suscripción, sólo se elimina en caso de que cliente monex no haya concedio su autorización de acceso, es decir que la pre-suscripcion este pendiente.
+Se elimina una pre-suscripción, sólo se elimina en caso de que el cliente Monex no haya concedido su autorización de acceso (token), es decir que la pre-suscripcion este pendiente.
 
 ### Example
 ```ruby
@@ -128,7 +128,7 @@ subscription = 'subscription_example' # String | El identificador de la suscripc
 
 
 begin
-  #Elimna una pre-suscripción
+  #Elimina una pre-suscripción
   api_instance.remove_subscription_pending_status_using_delete(authorization, subscription)
 rescue Wire4Client::ApiError => e
   puts "Exception when calling SuscripcionesApi->remove_subscription_pending_status_using_delete: #{e}"