wire4_client 0.0.1.pre.SNAPSHOT

data/docs/InstitutionsList.md

@@ -0,0 +1,8 @@
+# Wire4Client::InstitutionsList
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**institutions** | [**Array<Institution>**](Institution.md) | Lista de instituciones | [optional] 
+
+

data/docs/MessageAccountBeneficiary.md

@@ -0,0 +1,10 @@
+# Wire4Client::MessageAccountBeneficiary
+
+## 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] 
+
+

data/docs/MessageCEP.md

@@ -0,0 +1,28 @@
+# Wire4Client::MessageCEP
+
+## 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] 
+
+

data/docs/MessageDepositReceived.md

@@ -0,0 +1,27 @@
+# Wire4Client::MessageDepositReceived
+
+## 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] 
+
+

data/docs/MessageInstitution.md

@@ -0,0 +1,11 @@
+# Wire4Client::MessageInstitution
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**company_name** | **String** | Nombre de la institución registrada ante el SAT | [optional] 
+**key** | **String** | Clave de la institución | [optional] 
+**name** | **String** | Nombre de la institución | [optional] 
+**rfc** | **String** | RFC de la institución | [optional] 
+
+

data/docs/MessagePayment.md

@@ -0,0 +1,25 @@
+# Wire4Client::MessagePayment
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**account** | **String** | Cuenta del ordenante | [optional] 
+**amount** | **Float** | Monto de la transferencia | [optional] 
+**beneficiary_account** | **String** | Cuenta del beneficiario | [optional] 
+**beneficiary_bank** | [**MessageInstitution**](MessageInstitution.md) | Banco del beneficiario | [optional] 
+**beneficiary_name** | **String** | Nombre del beneficiario | [optional] 
+**cep** | [**MessageCEP**](MessageCEP.md) |  | [optional] 
+**clave_rastreo** | **String** | Clave de rastreo de la transferencia | [optional] 
+**concept** | **String** | Concepto de la transferencia de salida | [optional] 
+**confirm_date** | **DateTime** | Fecha de confirmación de la transferencia de salida | [optional] 
+**currency_code** | **String** | Código de la moneda de la transferencia de salida | [optional] 
+**detention_message** | **String** | Mensaje de detención de Monex de la transferencia de salida | [optional] 
+**monex_description** | **String** | La descripción de Monex de la transferencia de salida | [optional] 
+**order_id** | **String** | El identificador de la transferencia de salida | [optional] 
+**payment_order_id** | **Integer** | El identificador de la orden de pago de Monex de la transferencia de salida | [optional] 
+**reference** | **Integer** | Referecia de la transferencia | [optional] 
+**request_id** | **String** | El identificador, en esta API, de la petición de envío de la transferencia de salida | [optional] 
+**status_code** | **String** | El estado de la transferencia de salida | [optional] 
+**transaction_id** | **Integer** | El identificador de Monex de la transferencia de salida | [optional] 
+
+

data/docs/MessageSubscription.md

@@ -0,0 +1,12 @@
+# Wire4Client::MessageSubscription
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**contract** | **String** | Contrato Monex, con el cual se suscribió el cliente Monex en Wire4 | [optional] 
+**subscription** | **String** | Identificador de la suscripción, el cual se utiliza en las operaciones que solicitan una suscripción | [optional] 
+**user** | **String** | Usuario enmascardo, con el cual se suscribió el cliente Monex en Wire4 | [optional] 
+**user_key** | **String** | Usuario proporcionado por Wire4, el cual se debe utilizar para autenticar a esta suscripción | [optional] 
+**user_secret** | **String** | Contraseña proporcionada por Wire4, la cual se debe utilizar para autenticar a esta suscripción | [optional] 
+
+

data/docs/MessageWebHook.md

@@ -0,0 +1,16 @@
+# Wire4Client::MessageWebHook
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**api_version** | **String** | La versión de la API | [optional] 
+**created** | **DateTime** | Fecha de creación del mensaje | [optional] 
+**data** | **Object** | Objeto que contiene la información del evento | [optional] 
+**id** | **String** | El identificador del mensaje | [optional] 
+**livemode** | **BOOLEAN** | Indica si proviene de un entorno productivo | [optional] 
+**object** | **String** | Tipo de objeto  que contiene el mensaje en el atributo data los posibles valores son: subscription, beneficiary, spei_outgoing, spei_incoming, spid_outgoing  | [optional] 
+**pending_webhooks** | **Integer** | Número de  mensajes pendientes de enviar | [optional] 
+**request** | **String** | Identificador del recurso relacionado | [optional] 
+**type** | **String** | El tipo evento que se esta enviando en la notifiación | [optional] 
+
+

data/docs/Payment.md

@@ -0,0 +1,24 @@
+# Wire4Client::Payment
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**account** | **String** | Cuenta emisora | [optional] 
+**amount** | **Float** | Monto de la transferencia | [optional] 
+**beneficiary_account** | **String** | Cuenta del beneficiario | [optional] 
+**beneficiary_bank** | [**MessageInstitution**](MessageInstitution.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] 
+**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] 
+**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] 
+**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/Person.md

@@ -0,0 +1,10 @@
+# Wire4Client::Person
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**last_name** | **String** | Apellido Materno del propietario de la cuenta | 
+**middle_name** | **String** | Apellido Paterno del propietario de la cuenta | 
+**name** | **String** | Nombre(s) del propietario de la cuenta | 
+
+

data/docs/PreEnrollmentData.md

@@ -0,0 +1,9 @@
+# Wire4Client::PreEnrollmentData
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**cancel_return_url** | **String** | Url a la que se redirigirá en caso de un error | 
+**return_url** | **String** | Url a la que se redirigirá en caso de exito | 
+
+

data/docs/PreEnrollmentResponse.md

@@ -0,0 +1,9 @@
+# Wire4Client::PreEnrollmentResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**subscription_id** | **String** | Identificador público generado | [optional] 
+**url** | **String** | Url para confirmación de enrolamiento | [optional] 
+
+

data/docs/Relationship.md

@@ -0,0 +1,9 @@
+# Wire4Client::Relationship
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**kind_of_relationship** | **String** | Tipo de relación | [optional] 
+**relationship** | **String** | Nombre de la  relación | [optional] 
+
+

data/docs/RelationshipsResponse.md

@@ -0,0 +1,8 @@
+# Wire4Client::RelationshipsResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**relationships** | [**Array<Relationship>**](Relationship.md) | Lista de relaciones del beneficiario | [optional] 
+
+

data/docs/SaldoApi.md

@@ -0,0 +1,61 @@
+# Wire4Client::SaldoApi
+
+All URIs are relative to *https://sandbox-api.wire4.mx/wire4/1.0.0*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_balance_using_get**](SaldoApi.md#get_balance_using_get) | **GET** /subscriptions/{subscription}/balance | Consulta los saldo de una cuenta
+
+
+# **get_balance_using_get**
+> BalanceListResponse get_balance_using_get(subscription)
+
+Consulta los saldo de una cuenta
+
+Obtiene el de las divisas que se manejen en el contrato.
+
+### 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::SaldoApi.new
+
+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)
+  p result
+rescue Wire4Client::ApiError => e
+  puts "Exception when calling SaldoApi->get_balance_using_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **subscription** | **String**| El identificador de la suscripción a esta API | 
+
+### Return type
+
+[**BalanceListResponse**](BalanceListResponse.md)
+
+### Authorization
+
+[wire4_aut_app_user_spei](../README.md#wire4_aut_app_user_spei)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+

data/docs/SpidClassificationDTO.md

@@ -0,0 +1,9 @@
+# Wire4Client::SpidClassificationDTO
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**classification_id** | **String** | El identificador de la clasificación | [optional] 
+**description** | **String** | Las descripción de la clasificación de la operación | [optional] 
+
+

data/docs/SpidClassificationsResponseDTO.md

@@ -0,0 +1,8 @@
+# Wire4Client::SpidClassificationsResponseDTO
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**classifications** | [**Array<SpidClassificationDTO>**](SpidClassificationDTO.md) | Lista de clasificaciones para operaciones con dólares (SPID) | [optional] 
+
+

data/docs/SuscripcionesApi.md

@@ -0,0 +1,165 @@
+# Wire4Client::SuscripcionesApi
+
+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**
+> PreEnrollmentResponse pre_enrollment_monex_user_using_post(pre_enrollment_data)
+
+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.
+
+### 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
+
+
+begin
+  #registra una pre-suscripción
+  result = api_instance.pre_enrollment_monex_user_using_post(pre_enrollment_data)
+  p result
+rescue Wire4Client::ApiError => e
+  puts "Exception when calling SuscripcionesApi->pre_enrollment_monex_user_using_post: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **pre_enrollment_data** | [**PreEnrollmentData**](PreEnrollmentData.md)| Información para el enrolamiento | 
+
+### Return type
+
+[**PreEnrollmentResponse**](PreEnrollmentResponse.md)
+
+### Authorization
+
+[wire4_aut_app](../README.md#wire4_aut_app)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **remove_enrollment_user_using_delete**
+> remove_enrollment_user_using_delete(subscription)
+
+Elimna una suscripción por id
+
+Elimina una suscripción, una ves eliminada la suscripcion ya no se podran realizar operacions en el API uilizando 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
+
+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)
+rescue Wire4Client::ApiError => e
+  puts "Exception when calling SuscripcionesApi->remove_enrollment_user_using_delete: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **subscription** | **String**| El identificador de la suscripción a esta API | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[wire4_aut_app_user_spei](../README.md#wire4_aut_app_user_spei)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: */*
+
+
+
+# **remove_subscription_pending_status_using_delete**
+> remove_subscription_pending_status_using_delete(subscription)
+
+Elimna 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.
+
+### 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
+
+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)
+rescue Wire4Client::ApiError => e
+  puts "Exception when calling SuscripcionesApi->remove_subscription_pending_status_using_delete: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **subscription** | **String**| El identificador de la suscripción a esta API | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[wire4_aut_app](../README.md#wire4_aut_app)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: */*
+
+
+