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

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/SaldoApi.md

@@ -8,7 +8,7 @@ Method | HTTP request | Description
 
 
 # **get_balance_using_get**
-> BalanceListResponse get_balance_using_get(subscription)
+> BalanceListResponse get_balance_using_get(authorization, subscription)
 
 Consulta los saldo de una cuenta
 
@@ -18,20 +18,17 @@ Obtiene el de las divisas que se manejen en el contrato.
 ```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::SaldoApi.new
 
+authorization = 'authorization_example' # String | Header para token
+
 subscription = 'subscription_example' # String | El identificador de la suscripción a esta API
 
 
 begin
   #Consulta los saldo de una cuenta
-  result = api_instance.get_balance_using_get(subscription)
+  result = api_instance.get_balance_using_get(authorization, subscription)
   p result
 rescue Wire4Client::ApiError => e
   puts "Exception when calling SaldoApi->get_balance_using_get: #{e}"
@@ -42,6 +39,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
+ **authorization** | **String**| Header para token | 
  **subscription** | **String**| El identificador de la suscripción a esta API | 
 
 ### Return type
@@ -50,7 +48,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/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** | **DateTime** | 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** | **DateTime** | 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) | codiWebhook | [optional] 
+
+

data/docs/SpidBeneficiariesResponse.md

@@ -0,0 +1,8 @@
+# Wire4Client::SpidBeneficiariesResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**beneficiaries** | [**Array<SpidBeneficiaryResponse>**](SpidBeneficiaryResponse.md) | Lista de beneficiarios obtenidos | [optional] 
+
+

data/docs/SpidBeneficiaryResponse.md

@@ -0,0 +1,20 @@
+# Wire4Client::SpidBeneficiaryResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**amount_limit** | **Float** | Monto límite permitido para la cuenta | 
+**authorization_date** | **DateTime** | La fecha/hora en la que se autorizo el registro del beneficiario desde el centro de autorización | [optional] 
+**bank** | [**Institution**](Institution.md) | El banco al cual pertenece la cuenta | [optional] 
+**beneficiary_account** | **String** | Cuenta del beneficiario debe ser una cuenta CLABE | 
+**email** | **Array<String>** | Lista de email's, este dato es opcional | [optional] 
+**institution** | [**BeneficiaryInstitution**](BeneficiaryInstitution.md) | Objeto que contiene el nombre de la institución, es mutuamente exclusivo con el objeto Person | 
+**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,36 +4,33 @@ 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(pre_enrollment_data)
+> 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
 # 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::SuscripcionesApi.new
 
-pre_enrollment_data = Wire4Client::PreEnrollmentData.new # PreEnrollmentData | Información para el enrolamiento
+authorization = 'authorization_example' # String | Header para token
+
+pre_enrollment_data = Wire4Client::PreEnrollmentData.new # PreEnrollmentData | Información para la pre-suscripción
 
 
 begin
-  #registra una pre-suscripción
-  result = api_instance.pre_enrollment_monex_user_using_post(pre_enrollment_data)
+  #Registra una pre-suscripción
+  result = api_instance.pre_enrollment_monex_user_using_post(authorization, pre_enrollment_data)
   p result
 rescue Wire4Client::ApiError => e
   puts "Exception when calling SuscripcionesApi->pre_enrollment_monex_user_using_post: #{e}"
@@ -44,7 +41,8 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **pre_enrollment_data** | [**PreEnrollmentData**](PreEnrollmentData.md)| Información para el enrolamiento | 
+ **authorization** | **String**| Header para token | 
+ **pre_enrollment_data** | [**PreEnrollmentData**](PreEnrollmentData.md)| Información para la pre-suscripción | 
 
 ### Return type
 
@@ -52,7 +50,7 @@ Name | Type | Description  | Notes
 
 ### Authorization
 
-[wire4_aut_app](../README.md#wire4_aut_app)
+No authorization required
 
 ### HTTP request headers
 
@@ -62,30 +60,27 @@ Name | Type | Description  | Notes
 
 
 # **remove_enrollment_user_using_delete**
-> remove_enrollment_user_using_delete(subscription)
+> 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
 # 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::SuscripcionesApi.new
 
+authorization = 'authorization_example' # String | Header para token
+
 subscription = 'subscription_example' # String | El identificador de la suscripción a esta API
 
 
 begin
-  #Elimna una suscripción por id
-  api_instance.remove_enrollment_user_using_delete(subscription)
+  #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}"
 end
@@ -95,6 +90,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
+ **authorization** | **String**| Header para token | 
  **subscription** | **String**| El identificador de la suscripción a esta API | 
 
 ### Return type
@@ -103,7 +99,7 @@ nil (empty response body)
 
 ### Authorization
 
-[wire4_aut_app_user_spei](../README.md#wire4_aut_app_user_spei)
+No authorization required
 
 ### HTTP request headers
 
@@ -113,30 +109,27 @@ nil (empty response body)
 
 
 # **remove_subscription_pending_status_using_delete**
-> remove_subscription_pending_status_using_delete(subscription)
+> 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
 # 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::SuscripcionesApi.new
 
+authorization = 'authorization_example' # String | Header para token
+
 subscription = 'subscription_example' # String | El identificador de la suscripción a esta API
 
 
 begin
-  #Elimna una pre-suscripción
-  api_instance.remove_subscription_pending_status_using_delete(subscription)
+  #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}"
 end
@@ -146,6 +139,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
+ **authorization** | **String**| Header para token | 
  **subscription** | **String**| El identificador de la suscripción a esta API | 
 
 ### Return type
@@ -154,7 +148,7 @@ nil (empty response body)
 
 ### Authorization
 
-[wire4_aut_app](../README.md#wire4_aut_app)
+No authorization required
 
 ### HTTP request headers
 

data/docs/TransactionErrorCode.md

@@ -0,0 +1,10 @@
+# Wire4Client::TransactionErrorCode
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**code** | **String** |  | [optional] 
+**error** | **String** |  | [optional] 
+**order_id** | **String** |  | [optional] 
+
+

data/docs/TransactionOutgoing.md

@@ -4,7 +4,8 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **amount** | **Float** | Monto de la transferencia | 
-**beneficiary_account** | **String** | Cuenta del beneficiario, podría ser un numero celular, TDD o Cuenta CLABE interbancaria  | 
+**beneficiary_account** | **String** | Cuenta del beneficiario, podría ser un número celular, TDD o Cuenta CLABE interbancaria  | 
+**beneficiary_bank_key** | **String** | La clave del banco beneficiario, proprocionada por BANXICO, este campo solo es obligatario cuando la cuenta beneficiaria es un número celular (*). | [optional] 
 **concept** | **String** | Concepto de la transferencia | 
 **currency_code** | **String** | Código de moneda en la que opera la cuenta | 
 **email** | **Array<String>** | Lista de email del beneficiario,es opcional | [optional]