wire4_client 0.0.1.pre.SNAPSHOT

data/docs/CuentasDeBeneficiariosSPIDApi.md

@@ -0,0 +1,62 @@
+# Wire4Client::CuentasDeBeneficiariosSPIDApi
+
+All URIs are relative to *https://sandbox-api.wire4.mx/wire4/1.0.0*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**pre_register_accounts_using_post1**](CuentasDeBeneficiariosSPIDApi.md#pre_register_accounts_using_post1) | **POST** /subscriptions/{subscription}/beneficiaries/spid | Pre-registro de cuentas de beneficiarios SPID
+
+
+# **pre_register_accounts_using_post1**
+> TokenRequiredResponse pre_register_accounts_using_post1(request_spid_dto, subscription)
+
+Pre-registro de cuentas de beneficiarios SPID
+
+### Example
+```ruby
+# load the gem
+require 'wire4_client'
+# setup authorization
+Wire4Client.configure do |config|
+  # Configure OAuth2 access token for authorization: wire4_aut_app_user_spid
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = Wire4Client::CuentasDeBeneficiariosSPIDApi.new
+
+request_spid_dto = Wire4Client::AccountSpid.new # AccountSpid | Información de la cuenta del beneficiario
+
+subscription = 'subscription_example' # String | El identificador de la suscripción a esta API
+
+
+begin
+  #Pre-registro de cuentas de beneficiarios SPID
+  result = api_instance.pre_register_accounts_using_post1(request_spid_dto, subscription)
+  p result
+rescue Wire4Client::ApiError => e
+  puts "Exception when calling CuentasDeBeneficiariosSPIDApi->pre_register_accounts_using_post1: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **request_spid_dto** | [**AccountSpid**](AccountSpid.md)| Información de la cuenta del beneficiario | 
+ **subscription** | **String**| El identificador de la suscripción a esta API | 
+
+### Return type
+
+[**TokenRequiredResponse**](TokenRequiredResponse.md)
+
+### Authorization
+
+[wire4_aut_app_user_spid](../README.md#wire4_aut_app_user_spid)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/Deposit.md

@@ -0,0 +1,27 @@
+# Wire4Client::Deposit
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**amount** | **Float** | Monto de la transferencia | [optional] 
+**beneficiary_account** | **String** | La cuenta del beneficiario | [optional] 
+**beneficiary_name** | **String** | El nombre del beneficiario | [optional] 
+**beneficiary_rfc** | **String** | El RFC del beneficiario | [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] 
+**deposit_date** | **DateTime** | Fecha del deposito | [optional] 
+**depositant** | **String** | Depositante | [optional] 
+**depositant_clabe** | **String** | Cuenta CLABE interbancaria del depositante | [optional] 
+**depositant_email** | **String** | Email del depositante | [optional] 
+**depositant_rfc** | **String** | RFC del depositante | [optional] 
+**description** | **String** | Descripción del traspaso | [optional] 
+**monex_description** | **String** | Descripción directa de Monex | [optional] 
+**monex_transaction_id** | **String** | Identificador de la transferencia en Monex | [optional] 
+**reference** | **String** | La referencia del depósito | [optional] 
+**sender_account** | **String** | La cuenta del ordenante | [optional] 
+**sender_bank** | [**MessageInstitution**](MessageInstitution.md) | El banco del ordenante | [optional] 
+**sender_name** | **String** | El nombre del ordenante | [optional] 
+**sender_rfc** | **String** | El RFC del ordenante | [optional] 
+
+

data/docs/Depositant.md

@@ -0,0 +1,12 @@
+# Wire4Client::Depositant
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**_alias** | **String** | Alias del depositante | [optional] 
+**currency_code** | **String** | Código de moneda con el que operará el depositante | [optional] 
+**depositant_clabe** | **String** | Cuenta clabe del depositante | [optional] 
+**email** | **Array<String>** | Lista de emails del depositante | [optional] 
+**name** | **String** | Nombre del depositante | [optional] 
+
+

data/docs/DepositantesApi.md

@@ -0,0 +1,117 @@
+# Wire4Client::DepositantesApi
+
+All URIs are relative to *https://sandbox-api.wire4.mx/wire4/1.0.0*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_depositants_using_get**](DepositantesApi.md#get_depositants_using_get) | **GET** /subscriptions/{subscription}/depositants | Consulta de cuentas de depositantes
+[**register_depositants_using_post**](DepositantesApi.md#register_depositants_using_post) | **POST** /subscriptions/{subscription}/depositants | Registra un nuevo depositante
+
+
+# **get_depositants_using_get**
+> GetDepositants get_depositants_using_get(subscription)
+
+Consulta de cuentas de depositantes
+
+Obtiene una lista de depositantes asociados al contrato relacionado a la subscripció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::DepositantesApi.new
+
+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)
+  p result
+rescue Wire4Client::ApiError => e
+  puts "Exception when calling DepositantesApi->get_depositants_using_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **subscription** | **String**| El identificador de la suscripción a esta API | 
+
+### Return type
+
+[**GetDepositants**](GetDepositants.md)
+
+### Authorization
+
+[wire4_aut_app_user_spei](../README.md#wire4_aut_app_user_spei)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **register_depositants_using_post**
+> DepositantsResponse register_depositants_using_post(register, subscription)
+
+Registra un nuevo depositante
+
+Registra un nuevo depositante en el contrato asociado a la subscripció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::DepositantesApi.new
+
+register = Wire4Client::DepositantsRegister.new # DepositantsRegister | Depositant info
+
+subscription = 'subscription_example' # String | El identificador de la suscripción a esta API
+
+
+begin
+  #Registra un nuevo depositante
+  result = api_instance.register_depositants_using_post(register, subscription)
+  p result
+rescue Wire4Client::ApiError => e
+  puts "Exception when calling DepositantesApi->register_depositants_using_post: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **register** | [**DepositantsRegister**](DepositantsRegister.md)| Depositant info | 
+ **subscription** | **String**| El identificador de la suscripción a esta API | 
+
+### Return type
+
+[**DepositantsResponse**](DepositantsResponse.md)
+
+### Authorization
+
+[wire4_aut_app_user_spei](../README.md#wire4_aut_app_user_spei)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/DepositantsRegister.md

@@ -0,0 +1,11 @@
+# Wire4Client::DepositantsRegister
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**_alias** | **String** | Alias del depositante | 
+**currency_code** | **String** | Codigo de la moneda en que operará el depositante, los valores validos son MXP y USD | 
+**email** | **Array<String>** | Lista de email del depositante | [optional] 
+**name** | **String** | Nombre del depositante | 
+
+

data/docs/DepositantsResponse.md

@@ -0,0 +1,8 @@
+# Wire4Client::DepositantsResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**clabe** | **String** | Cuenta clabe del depositante | [optional] 
+
+

data/docs/ErrorResponse.md

@@ -0,0 +1,9 @@
+# Wire4Client::ErrorResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**http_status** | **Integer** |  | [optional] 
+**message** | **String** |  | [optional] 
+
+

data/docs/FacturasApi.md

@@ -0,0 +1,115 @@
+# Wire4Client::FacturasApi
+
+All URIs are relative to *https://sandbox-api.wire4.mx/wire4/1.0.0*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**billings_report_by_id_using_get**](FacturasApi.md#billings_report_by_id_using_get) | **GET** /billings/{id} | Consulta de facturas por identificador
+[**billings_report_using_get**](FacturasApi.md#billings_report_using_get) | **GET** /billings | Consulta de facturas
+
+
+# **billings_report_by_id_using_get**
+> Billing billings_report_by_id_using_get(id)
+
+Consulta de facturas por identificador
+
+Consulta las facturas emitidas por conceptos de uso de la plataforma y operaciones realizadas tanto de entrada como de salida. Se debe especificar el identificador de la factura
+
+### 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::FacturasApi.new
+
+id = 'id_example' # String | Identificador de la factura
+
+
+begin
+  #Consulta de facturas por identificador
+  result = api_instance.billings_report_by_id_using_get(id)
+  p result
+rescue Wire4Client::ApiError => e
+  puts "Exception when calling FacturasApi->billings_report_by_id_using_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**| Identificador de la factura | 
+
+### Return type
+
+[**Billing**](Billing.md)
+
+### Authorization
+
+[wire4_aut_app](../README.md#wire4_aut_app)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **billings_report_using_get**
+> Array<Billing> billings_report_using_get(opts)
+
+Consulta de facturas
+
+Consulta las facturas emitidas por conceptos de uso de la plataforma y operaciones realizadas tanto de entrada como de salida. Es posible filtrar por periodo de fecha yyyy-MM, por ejemplo 2019-11
+
+### 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::FacturasApi.new
+
+opts = { 
+  period: 'period_example' # String | Filtro de fecha yyyy-MM
+}
+
+begin
+  #Consulta de facturas
+  result = api_instance.billings_report_using_get(opts)
+  p result
+rescue Wire4Client::ApiError => e
+  puts "Exception when calling FacturasApi->billings_report_using_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **period** | **String**| Filtro de fecha yyyy-MM | [optional] 
+
+### Return type
+
+[**Array<Billing>**](Billing.md)
+
+### Authorization
+
+[wire4_aut_app](../README.md#wire4_aut_app)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+

data/docs/GetDepositants.md

@@ -0,0 +1,8 @@
+# Wire4Client::GetDepositants
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**depositants** | [**Array<Depositant>**](Depositant.md) | Lista de depositantes que contiene cada depositante encontrado | 
+
+

data/docs/InstitucionesApi.md

@@ -0,0 +1,53 @@
+# Wire4Client::InstitucionesApi
+
+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**
+> InstitutionsList get_all_institutions_using_get
+
+Información de instituciones bancarias.
+
+### 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
+
+begin
+  #Información de instituciones bancarias.
+  result = api_instance.get_all_institutions_using_get
+  p result
+rescue Wire4Client::ApiError => e
+  puts "Exception when calling InstitucionesApi->get_all_institutions_using_get: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**InstitutionsList**](InstitutionsList.md)
+
+### Authorization
+
+[wire4_aut_app](../README.md#wire4_aut_app)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+

data/docs/Institution.md

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