wire4_client 0.0.9.pre.TEST → 1.0.0

data/docs/AutorizacinDeDepsitosApi.md

@@ -1,113 +0,0 @@
-# Wire4Client::AutorizacinDeDepsitosApi
-
-All URIs are relative to *https://sandbox-api.wire4.mx/wire4/1.0.0*
-
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**get_deposit_auth_configurations**](AutorizacinDeDepsitosApi.md#get_deposit_auth_configurations) | **GET** /subscriptions/{subscription}/configurations/deposit-authorization | Consulta autorización de depósitos
-[**put_deposit_auth_configurations**](AutorizacinDeDepsitosApi.md#put_deposit_auth_configurations) | **PUT** /subscriptions/{subscription}/configurations/deposit-authorization | Des/Habilitar autorización de depósitos
-
-
-# **get_deposit_auth_configurations**
-> DepositsAuthorizationResponse get_deposit_auth_configurations(authorization, subscription)
-
-Consulta autorización de depósitos
-
-Obtiene la información de la autorización de depósitos del contrato relacionado a la subscripción.
-
-### Example
-```ruby
-# load the gem
-require 'wire4_client'
-
-api_instance = Wire4Client::AutorizacinDeDepsitosApi.new
-
-authorization = 'authorization_example' # String | Header para token
-
-subscription = 'subscription_example' # String | El identificador de la suscripción a esta API
-
-
-begin
-  #Consulta autorización de depósitos
-  result = api_instance.get_deposit_auth_configurations(authorization, subscription)
-  p result
-rescue Wire4Client::ApiError => e
-  puts "Exception when calling AutorizacinDeDepsitosApi->get_deposit_auth_configurations: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **authorization** | **String**| Header para token | 
- **subscription** | **String**| El identificador de la suscripción a esta API | 
-
-### Return type
-
-[**DepositsAuthorizationResponse**](DepositsAuthorizationResponse.md)
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-
-# **put_deposit_auth_configurations**
-> DepositsAuthorizationResponse put_deposit_auth_configurations(authorization, register, subscription)
-
-Des/Habilitar autorización de depósitos
-
-Des/Habilitar autorización de depósitos, devuelve la información final de la autorización de depósitos del contrato relacionado a la subscripción al terminar.
-
-### Example
-```ruby
-# load the gem
-require 'wire4_client'
-
-api_instance = Wire4Client::AutorizacinDeDepsitosApi.new
-
-authorization = 'authorization_example' # String | Header para token
-
-register = Wire4Client::DepositAuthorizationRequest.new # DepositAuthorizationRequest | Deposit Authorization info
-
-subscription = 'subscription_example' # String | El identificador de la suscripción a esta API
-
-
-begin
-  #Des/Habilitar autorización de depósitos
-  result = api_instance.put_deposit_auth_configurations(authorization, register, subscription)
-  p result
-rescue Wire4Client::ApiError => e
-  puts "Exception when calling AutorizacinDeDepsitosApi->put_deposit_auth_configurations: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **authorization** | **String**| Header para token | 
- **register** | [**DepositAuthorizationRequest**](DepositAuthorizationRequest.md)| Deposit Authorization info | 
- **subscription** | **String**| El identificador de la suscripción a esta API | 
-
-### Return type
-
-[**DepositsAuthorizationResponse**](DepositsAuthorizationResponse.md)
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-

data/docs/BeneficiariesQueryRegisterStatus.md

@@ -1,13 +0,0 @@
-# Wire4Client::BeneficiariesQueryRegisterStatus
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**authorization_date** | **DateTime** | Fecha en que el usuario propietario del token autorizo el registro de beneficiarios | [optional] 
-**beneficiaries** | [**Array<AccountResponse>**](AccountResponse.md) | Lista de beneficiarios obtenidos | [optional] 
-**request_date** | **DateTime** | Fecha en que se realizó la petición de registro de beneficiarios | [optional] 
-**request_id** | **String** | Identificador de la petición del registro de beneficiarios | [optional] 
-**status_request** | **String** | Indica sí la petición ya fue autorizada usando el token del usuario | [optional] 
-**total_beneficiaries** | **Integer** | Total de beneficiarios enviados en la petición | [optional] 
-
-

data/docs/CertificateRequest.md

@@ -1,11 +0,0 @@
-# Wire4Client::CertificateRequest
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**_alias** | **String** | Alias del certificado | [optional] 
-**certificate_number** | **String** | Numero de certificado | [optional] 
-**check_digit** | **String** | Dígito verificador | [optional] 
-**cipher_data** | **String** | Información de cifrado | [optional] 
-
-

data/docs/CodiCodeQrResponseDTO.md

@@ -1,17 +0,0 @@
-# Wire4Client::CodiCodeQrResponseDTO
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**amount** | **Float** | Monto del pago CODI® | [optional] 
-**barcode_base64** | **String** | El código QR en su represantación base 64 | [optional] 
-**barcode_url** | **String** | La URL del código QR | [optional] 
-**concept** | **String** | Descripción del pago CODI® | [optional] 
-**creation_date** | **DateTime** | Fecha de creación del código QR para pago CODI® | [optional] 
-**due_date** | **DateTime** | Fecha de operación del pago CODI® | [optional] 
-**order_id** | **String** | Referencia de la transferencia asignada por el cliente | [optional] 
-**phone_number** | **String** | Número de teléfono móvil en caso de ser un pago CODI® usando 'PUSH_NOTIFICATION' | [optional] 
-**status** | **String** | El estado del código QR para pago CODI® | [optional] 
-**type** | **String** | El tipo de código QR para pago con CODI® | [optional] 
-
-

data/docs/CodiCodeRequestDTO.md

@@ -1,14 +0,0 @@
-# Wire4Client::CodiCodeRequestDTO
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**amount** | **Float** | Monto del pago CODI® | [optional] 
-**concept** | **String** | Descripción del pago CODI® | 
-**due_date** | **DateTime** | Fecha de operación pago CODI®, formato: yyyy-MM-dd'T'HH:mm:ss | 
-**metadata** | **String** | Campo de metada CODI®, longitud máxima determinada por configuracion de la empresa, por defecto 100 caracteres | [optional] 
-**order_id** | **String** | Referencia de la transferencia asignada por el cliente | 
-**phone_number** | **String** | Número de teléfono móvil en caso de ser un pago CODI® usando 'PUSH_NOTIFICATION' estecampo sería obligatorio | [optional] 
-**type** | **String** | El tipo de código QR para pago con CODI® | 
-
-

data/docs/CodiOperationResponseDTO.md

@@ -1,14 +0,0 @@
-# Wire4Client::CodiOperationResponseDTO
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**amount** | **Float** | Monto de la operacion. | [optional] 
-**concept** | **String** | Concepto del pago. | [optional] 
-**id** | **String** | Identificador de la operacion. | [optional] 
-**operation_date** | **DateTime** | Fecha de la operacion. | [optional] 
-**payment_type** | **String** | Tipo de pago. | [optional] 
-**status** | **String** | Estatus. | [optional] 
-**transaction_id** | **String** | Identificador de la transacción. | [optional] 
-
-

data/docs/CodiOperationsFiltersRequestDTO.md

@@ -1,15 +0,0 @@
-# Wire4Client::CodiOperationsFiltersRequestDTO
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**amount_from** | **Float** | Monto minimo, dos decimales | [optional] 
-**amount_to** | **Float** | Monto máximo,dos decimales | [optional] 
-**operation_date_from** | **Date** | Fecha de operación desde | [optional] 
-**operation_date_to** | **Date** | Fecha de operación hasta | [optional] 
-**order_id** | **String** | Order id de la petición | [optional] 
-**request_date_from** | **Date** | Fecha de petición desde | [optional] 
-**request_date_to** | **Date** | Fecha de petición hasta | [optional] 
-**status** | **String** | Estatus de petición | [optional] 
-
-

data/docs/CompanyRegistered.md

@@ -1,13 +0,0 @@
-# Wire4Client::CompanyRegistered
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**business_name** | **String** | Nombre de la empresa registrada | [optional] 
-**certificate** | **String** | La información del certificado | [optional] 
-**comercial_name** | **String** | Nombre comercial de la empresa registrada | [optional] 
-**company_id** | **String** | Identificador de la empresa | [optional] 
-**rfc** | **String** | RFC de la empresa registrada | [optional] 
-**status** | **String** | El estado de la compañía | [optional] 
-
-

data/docs/CompanyRequested.md

@@ -1,11 +0,0 @@
-# Wire4Client::CompanyRequested
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**business_name** | **String** | Nombre de la empresa que se va a registrar | [optional] 
-**certificate** | [**CertificateRequest**](CertificateRequest.md) | Información del certificado | [optional] 
-**comercial_name** | **String** | Nombre comercial de la empresa que se va a registrar | [optional] 
-**rfc** | **String** | RFC de la empresa que se va a registrar | [optional] 
-
-

data/docs/Compay.md

@@ -1,11 +0,0 @@
-# Wire4Client::Compay
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**commercial_name** | **String** | Nombre comercial de la empresa | [optional] 
-**company_id** | **String** | Identificador de la empresa | [optional] 
-**name** | **String** | Nombre de la empresa | [optional] 
-**rfc** | **String** | RFC de la empresa | [optional] 
-
-

data/docs/ConfigurationsLimits.md

@@ -1,9 +0,0 @@
-# Wire4Client::ConfigurationsLimits
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**group** | **String** | Nombre del grupo de configuraciones. Debe ser LIMIT_BY_TIME para especificar la configuración por límite por horario o LIMIT_BY_RANGE para especificar límite por periodo. | [optional] 
-**items** | [**Array<Item>**](Item.md) | Lista de items configurados | [optional] 
-
-

data/docs/ContractDetailRequest.md

@@ -1,11 +0,0 @@
-# Wire4Client::ContractDetailRequest
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**contract** | **String** | El contrato a consultar la información | [optional] 
-**password** | **String** | La contraseña del usuario | [optional] 
-**token_code** | **String** | La contraseña del usuario | [optional] 
-**user_name** | **String** | El nombre del usuario | [optional] 
-
-

data/docs/ContractDetailResponse.md

@@ -1,9 +0,0 @@
-# Wire4Client::ContractDetailResponse
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**account** | [**AccountDetail**](AccountDetail.md) | La información de la compañía correspondiente al contrato | [optional] 
-**user** | [**UserCompany**](UserCompany.md) | La información del usuario de la compañía correspondiente al contrato | [optional] 
-
-

data/docs/ContractsDetailsApi.md

@@ -1,222 +0,0 @@
-# Wire4Client::ContractsDetailsApi
-
-All URIs are relative to *https://sandbox-api.wire4.mx/wire4/1.0.0*
-
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**create_authorization**](ContractsDetailsApi.md#create_authorization) | **POST** /onboarding/accounts/authorize | Devuelve la URL para autorización del usuario Monex
-[**obtain_authorized_users**](ContractsDetailsApi.md#obtain_authorized_users) | **GET** /onboarding/accounts/{requestId}/authorized-users | Obtiene los usuarios autorizados
-[**obtain_authorized_users_by_contract**](ContractsDetailsApi.md#obtain_authorized_users_by_contract) | **GET** /onboarding/accounts/authorized-users | Obtiene los usuarios autorizados por contrato
-[**obtain_contract_details**](ContractsDetailsApi.md#obtain_contract_details) | **POST** /onboarding/accounts/details | Obtiene los detalles de la empresa del contrato
-
-
-# **create_authorization**
-> TokenRequiredResponse create_authorization(authorization, pre_monex_authorization)
-
-Devuelve la URL para autorización del usuario Monex
-
-Se obtiene la URL para la autorización del usuario Monex.
-
-### Example
-```ruby
-# load the gem
-require 'wire4_client'
-
-api_instance = Wire4Client::ContractsDetailsApi.new
-
-authorization = 'authorization_example' # String | Header para token
-
-pre_monex_authorization = Wire4Client::PreMonexAuthorization.new # PreMonexAuthorization | Información para la autorización
-
-
-begin
-  #Devuelve la URL para autorización del usuario Monex
-  result = api_instance.create_authorization(authorization, pre_monex_authorization)
-  p result
-rescue Wire4Client::ApiError => e
-  puts "Exception when calling ContractsDetailsApi->create_authorization: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **authorization** | **String**| Header para token | 
- **pre_monex_authorization** | [**PreMonexAuthorization**](PreMonexAuthorization.md)| Información para la autorización | 
-
-### Return type
-
-[**TokenRequiredResponse**](TokenRequiredResponse.md)
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-
-# **obtain_authorized_users**
-> Array<AuthorizedUsers> obtain_authorized_users(authorization, x_access_key, request_id)
-
-Obtiene los usuarios autorizados
-
-Obtienen los detalles de los usuarios autorizados de Monex.
-
-### Example
-```ruby
-# load the gem
-require 'wire4_client'
-
-api_instance = Wire4Client::ContractsDetailsApi.new
-
-authorization = 'authorization_example' # String | Header para token
-
-x_access_key = 'x_access_key_example' # String | La llave de acceso de la aplicación
-
-request_id = 'request_id_example' # String | El identificador de la petición a esta API
-
-
-begin
-  #Obtiene los usuarios autorizados
-  result = api_instance.obtain_authorized_users(authorization, x_access_key, request_id)
-  p result
-rescue Wire4Client::ApiError => e
-  puts "Exception when calling ContractsDetailsApi->obtain_authorized_users: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **authorization** | **String**| Header para token | 
- **x_access_key** | **String**| La llave de acceso de la aplicación | 
- **request_id** | **String**| El identificador de la petición a esta API | 
-
-### Return type
-
-[**Array<AuthorizedUsers>**](AuthorizedUsers.md)
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-
-# **obtain_authorized_users_by_contract**
-> Array<AuthorizedUsers> obtain_authorized_users_by_contract(authorization, x_access_key, opts)
-
-Obtiene los usuarios autorizados por contrato
-
-Obtienen los detalles de los usuarios autorizados por contrato Monex.
-
-### Example
-```ruby
-# load the gem
-require 'wire4_client'
-
-api_instance = Wire4Client::ContractsDetailsApi.new
-
-authorization = 'authorization_example' # String | Header para token
-
-x_access_key = 'x_access_key_example' # String | La llave de acceso de la aplicación
-
-opts = { 
-  contract: 'contract_example' # String | El contrato Monex
-}
-
-begin
-  #Obtiene los usuarios autorizados por contrato
-  result = api_instance.obtain_authorized_users_by_contract(authorization, x_access_key, opts)
-  p result
-rescue Wire4Client::ApiError => e
-  puts "Exception when calling ContractsDetailsApi->obtain_authorized_users_by_contract: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **authorization** | **String**| Header para token | 
- **x_access_key** | **String**| La llave de acceso de la aplicación | 
- **contract** | **String**| El contrato Monex | [optional] 
-
-### Return type
-
-[**Array<AuthorizedUsers>**](AuthorizedUsers.md)
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-
-# **obtain_contract_details**
-> ContractDetailResponse obtain_contract_details(authorization, x_access_key, contract_detail_request)
-
-Obtiene los detalles de la empresa del contrato
-
-Detalles de la compañía relacionada con el contrato de Monex.
-
-### Example
-```ruby
-# load the gem
-require 'wire4_client'
-
-api_instance = Wire4Client::ContractsDetailsApi.new
-
-authorization = 'authorization_example' # String | Header para token
-
-x_access_key = 'x_access_key_example' # String | La llave de acceso de la aplicación
-
-contract_detail_request = Wire4Client::ContractDetailRequest.new # ContractDetailRequest | Información para obtener los detalles de la companía
-
-
-begin
-  #Obtiene los detalles de la empresa del contrato
-  result = api_instance.obtain_contract_details(authorization, x_access_key, contract_detail_request)
-  p result
-rescue Wire4Client::ApiError => e
-  puts "Exception when calling ContractsDetailsApi->obtain_contract_details: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **authorization** | **String**| Header para token | 
- **x_access_key** | **String**| La llave de acceso de la aplicación | 
- **contract_detail_request** | [**ContractDetailRequest**](ContractDetailRequest.md)| Información para obtener los detalles de la companía | 
-
-### Return type
-
-[**ContractDetailResponse**](ContractDetailResponse.md)
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-

data/docs/DepositAuthorizationRequest.md

@@ -1,10 +0,0 @@
-# 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/DepositsAuthorizationResponse.md

@@ -1,10 +0,0 @@
-# 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

@@ -1,10 +0,0 @@
-# Wire4Client::DetailedErrorResponse
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**errors** | [**Array<TransactionErrorCode>**](TransactionErrorCode.md) |  | [optional] 
-**http_status** | **Integer** |  | [optional] 
-**message** | **String** |  | [optional] 
-
-

data/docs/EmpresasCoDiApi.md

@@ -1,107 +0,0 @@
-# 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/Item.md

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