wire4_client 0.0.1.pre.SNAPSHOT → 1.1.0

data/lib/wire4_client/models/webhook_request.rb

@@ -1,7 +1,7 @@
 =begin
 #Wire4RestAPI
 
-#Referencia de la API de Wire4
+#Referencia de API. La API de Wire4 está organizada en torno a REST
 
 OpenAPI spec version: 1.0.0
 
@@ -15,13 +15,13 @@ require 'date'
 module Wire4Client
   # Objeto que contiene la información de un webhook.
   class WebhookRequest
-    # Tipos de eventos de los cuales Wire4 te enviará información, para mas referencia sobre los tipos de eventos soportados, revise la siguiente liga: https://developers.wire4.mx/#section/Eventos .
+    # Son los eventos para que Wire4 te envíe información. Para más información sobre los tipos de eventos soportados, revise la siguiente liga: <a href=\"#section/Eventos\">https://developers.wire4.mx/#section/Eventos</a>.
     attr_accessor :events
 
-    # Nombre del webhook.
+    # Es el nombre del webhook.
     attr_accessor :name
 
-    # URL a la cual Wire4 enviará las notificaciones cuando un evento ocurra.
+    # Es la dirección URL para que Wire4 envíe las notificaciones cuando un evento ocurra.
     attr_accessor :url
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/wire4_client/models/webhook_response.rb

@@ -1,7 +1,7 @@
 =begin
 #Wire4RestAPI
 
-#Referencia de la API de Wire4
+#Referencia de API. La API de Wire4 está organizada en torno a REST
 
 OpenAPI spec version: 1.0.0
 
@@ -18,19 +18,19 @@ module Wire4Client
     # Tipos de eventos de los cuales Wire4 te enviará información.
     attr_accessor :events
 
-    # Nombre del webhook.
+    # Es el nombre del webhook.
     attr_accessor :name
 
-    # Llave con la cual se debe de identificar que el webhook fue enviado por Wire4, para mayor información revisar la guía de notificaciones (https://wire4.mx/#/guides/notificaciones), en la sección de  \"Comprobación de firmas de Webhook\".
+    # Llave con la cual se debe de identificar que el webhook fue enviado por Wire4, para mayor información revisar la guía de notificaciones (https://wire4.mx/#/guides/notificaciones),  en la sección de  <a href=\"https://wire4.mx/#/guides/notificaciones\">\"Comprobación de firmas de Webhook\".</a>
     attr_accessor :secret
 
-    # Estatus en el que se encuentra el webhook
+    # Es el estado (estatus) en el que se encuentra el webhook.
     attr_accessor :status
 
-    # URL a la cual Wire4 enviará las notificaciones cuando un evento ocurra.
+    # Es la dirección URL a la que Wire4 enviará las notificaciones cuando un evento ocurra.
     attr_accessor :url
 
-    # Identificador del webhook.
+    # Es el identificador del webhook. Ejemplo: wh_54a832866f784b439bc625c0f4e04e12.
     attr_accessor :wh_uuid
 
     class EnumAttributeValidator

data/lib/wire4_client/models/webhooks_list.rb

@@ -1,7 +1,7 @@
 =begin
 #Wire4RestAPI
 
-#Referencia de la API de Wire4
+#Referencia de API. La API de Wire4 está organizada en torno a REST
 
 OpenAPI spec version: 1.0.0
 

data/lib/wire4_client/version.rb

@@ -1,7 +1,7 @@
 =begin
 #Wire4RestAPI
 
-#Referencia de la API de Wire4
+#Referencia de API. La API de Wire4 está organizada en torno a REST
 
 OpenAPI spec version: 1.0.0
 
@@ -11,5 +11,5 @@ Swagger Codegen version: 2.4.10
 =end
 
 module Wire4Client
-  VERSION = '0.0.1-SNAPSHOT'
+  VERSION = '1.1.0'
 end

data/spec/api/autorizacin_de_depsitos_api_spec.rb

@@ -0,0 +1,62 @@
+=begin
+#Wire4RestAPI
+
+#Referencia de API. La API de Wire4 está organizada en torno a REST
+
+OpenAPI spec version: 1.0.0
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.10
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for Wire4Client::AutorizacinDeDepsitosApi
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'AutorizacinDeDepsitosApi' do
+  before do
+    # run before each test
+    @instance = Wire4Client::AutorizacinDeDepsitosApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of AutorizacinDeDepsitosApi' do
+    it 'should create an instance of AutorizacinDeDepsitosApi' do
+      expect(@instance).to be_instance_of(Wire4Client::AutorizacinDeDepsitosApi)
+    end
+  end
+
+  # unit tests for get_deposit_auth_configurations
+  # Consulta autorización de depósitos
+  # Obtiene la información de la autorización de depósitos del contrato relacionado a la suscripción.
+  # @param authorization Header para token
+  # @param subscription Es el identificador de la suscripción a esta API.
+  # @param [Hash] opts the optional parameters
+  # @return [DepositsAuthorizationResponse]
+  describe 'get_deposit_auth_configurations test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for put_deposit_auth_configurations
+  # Habilita / Deshabilita la autorización de depósitos
+  # Habilita o deshabilita la autorización de depósitos. Devuelve la información final de la autorización de depósitos del contrato relacionado a la suscripción al terminar.
+  # @param authorization Header para token
+  # @param register Información para habilitar / deshabilitar la autorización de depósito
+  # @param subscription Es el identificador de la suscripción a esta API.
+  # @param [Hash] opts the optional parameters
+  # @return [DepositsAuthorizationResponse]
+  describe 'put_deposit_auth_configurations test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/api/comprobante_electrnico_de_pago_cep_api_spec.rb

@@ -1,7 +1,7 @@
 =begin
 #Wire4RestAPI
 
-#Referencia de la API de Wire4
+#Referencia de API. La API de Wire4 está organizada en torno a REST
 
 OpenAPI spec version: 1.0.0
 
@@ -35,6 +35,7 @@ describe 'ComprobanteElectrnicoDePagoCEPApi' do
   # unit tests for obtain_transaction_cep_using_post
   # Consulta de CEP
   # Consulta el CEP de un pago realizado a través del SPEI, si es que este se encuentra disponible en BANXICO.
+  # @param authorization Header para token
   # @param cep_data Información para buscar un CEP
   # @param [Hash] opts the optional parameters
   # @return [CepResponse]

data/spec/api/contacto_api_spec.rb

@@ -1,7 +1,7 @@
 =begin
 #Wire4RestAPI
 
-#Referencia de la API de Wire4
+#Referencia de API. La API de Wire4 está organizada en torno a REST
 
 OpenAPI spec version: 1.0.0
 
@@ -35,6 +35,7 @@ describe 'ContactoApi' do
   # unit tests for send_contact_using_post
   # Solicitud de contacto
   # Notifica a un asesor Monex para que se ponga en contacto con un posible cliente.
+  # @param authorization Header para token
   # @param request_dto Información del contacto
   # @param [Hash] opts the optional parameters
   # @return [nil]

data/spec/api/contracts_details_api_spec.rb

@@ -0,0 +1,90 @@
+=begin
+#Wire4RestAPI
+
+#Referencia de API. La API de Wire4 está organizada en torno a REST
+
+OpenAPI spec version: 1.0.0
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.10
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for Wire4Client::ContractsDetailsApi
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'ContractsDetailsApi' do
+  before do
+    # run before each test
+    @instance = Wire4Client::ContractsDetailsApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of ContractsDetailsApi' do
+    it 'should create an instance of ContractsDetailsApi' do
+      expect(@instance).to be_instance_of(Wire4Client::ContractsDetailsApi)
+    end
+  end
+
+  # unit tests for create_authorization
+  # Devuelve la URL para autorización del usuario Monex
+  # Se obtiene la URL para la autorización del usuario Monex.
+  # @param authorization Header para token
+  # @param pre_monex_authorization Información para la autorización
+  # @param [Hash] opts the optional parameters
+  # @return [TokenRequiredResponse]
+  describe 'create_authorization test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for obtain_authorized_users
+  # Obtiene los usuarios autorizados
+  # Obtienen los detalles de los usuarios autorizados de Monex.
+  # @param authorization Header para token
+  # @param x_access_key La llave de acceso de la aplicación
+  # @param request_id El identificador de la petición a esta API
+  # @param [Hash] opts the optional parameters
+  # @return [Array<AuthorizedUsers>]
+  describe 'obtain_authorized_users test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for obtain_authorized_users_by_contract
+  # Obtiene los usuarios autorizados por contrato
+  # Obtienen los detalles de los usuarios autorizados por contrato Monex.
+  # @param authorization Header para token
+  # @param x_access_key La llave de acceso de la aplicación
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :contract El contrato Monex
+  # @return [Array<AuthorizedUsers>]
+  describe 'obtain_authorized_users_by_contract test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for obtain_contract_details
+  # Obtiene los detalles de la empresa del contrato
+  # Detalles de la compañía relacionada con el contrato de Monex.
+  # @param authorization Header para token
+  # @param x_access_key La llave de acceso de la aplicación
+  # @param contract_detail_request Información para obtener los detalles de la companía
+  # @param [Hash] opts the optional parameters
+  # @return [ContractDetailResponse]
+  describe 'obtain_contract_details test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/api/cuentas_de_beneficiarios_spei_api_spec.rb

@@ -1,7 +1,7 @@
 =begin
 #Wire4RestAPI
 
-#Referencia de la API de Wire4
+#Referencia de API. La API de Wire4 está organizada en torno a REST
 
 OpenAPI spec version: 1.0.0
 
@@ -32,11 +32,26 @@ describe 'CuentasDeBeneficiariosSPEIApi' do
     end
   end
 
+  # unit tests for authorize_accounts_pending_put
+  # Solicitud para agrupar cuentas de beneficiarios SPEI/SPID en estado pendiente.
+  # Solicta la agrupación de las cuentas de beneficiarios en estado pendiente para que sean autorizadas,  para ello se crea un conjunto de éstas que puede incluir tanto de SPEI como de SPID. Además se debe indicar las urls de redirección en caso de error y éxito
+  # @param authorization Header para token
+  # @param subscription Es el identificador de la suscripción a esta API.
+  # @param urls_redirect_dto Información de la cuenta del beneficiario
+  # @param [Hash] opts the optional parameters
+  # @return [AuthorizedBeneficiariesResponse]
+  describe 'authorize_accounts_pending_put test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
   # unit tests for delete_account_using_delete
   # Elimina la cuenta del beneficiario
-  # Borra la cuenta de beneficiario proporcionada relacionada al contrato perteneciente a la subscripción. La cuenta a borrar debe ser una cuenta que opere con SPEI.
-  # @param account La cuenta del beneciario que será eliminada
-  # @param subscription El identificador de la suscripción a esta API
+  # Elimina la cuenta de beneficiario proporcionada relacionada al contrato perteneciente a la suscripción. La cuenta a borrar debe ser una que opere con SPEI.
+  # @param authorization Header para token
+  # @param account Es la cuenta del beneficiario que será eliminada.
+  # @param subscription Es el identificador de la suscripción a esta API.
   # @param [Hash] opts the optional parameters
   # @return [nil]
   describe 'delete_account_using_delete test' do
@@ -48,7 +63,8 @@ describe 'CuentasDeBeneficiariosSPEIApi' do
   # unit tests for get_available_relationships_monex_using_get
   # Consulta de relaciones
   # Obtiene las posibles relaciones existentes para registrar beneficiarios en Monex. Se debe invocar este recurso antes de pre-registrar una cuenta de beneficiario.
-  # @param subscription Identificador de la suscripción a esta API
+  # @param authorization Header para token
+  # @param subscription Es el identificador de la suscripción a esta API.
   # @param [Hash] opts the optional parameters
   # @return [RelationshipsResponse]
   describe 'get_available_relationships_monex_using_get test' do
@@ -57,12 +73,33 @@ describe 'CuentasDeBeneficiariosSPEIApi' do
     end
   end
 
+  # unit tests for get_beneficiaries_by_request_id
+  # Consulta los beneficiarios por el identificador de la petición de registro
+  # Obtiene los beneficiarios enviados para registro en una petición al contrato relacionado con la suscripción, Los beneficiarios son los que actualmente se encuentran registrados en banca Monex, que pertenezcan a la petición que se solicita.
+  # @param authorization Header para token
+  # @param request_id El identificador de la petición del registro de beneficiarios a esta API.
+  # @param subscription Es el identificador de la suscripción a esta API.
+  # @param [Hash] opts the optional parameters
+  # @return [BeneficiariesResponse]
+  describe 'get_beneficiaries_by_request_id test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
   # unit tests for get_beneficiaries_for_account_using_get
   # Consulta los beneficiarios registrados
   # Obtiene los beneficiarios registrados al contrato relacionado con la suscripción, Los beneficiarios son los que actualmente se encuentran registrados en banca Monex.
-  # @param subscription El identificador de la suscripción a esta API
+  # @param authorization Header para token
+  # @param subscription Es el identificador de la suscripción a esta API.
   # @param [Hash] opts the optional parameters
-  # @option opts [String] :rfc RFC del beneficiario
+  # @option opts [String] :account Es la cuenta del beneficiario, podría ser teléfono celular (es de 10 dígitos), Tarjeta de débito (TDD, es de 16 dígitos) o cuenta CLABE (es de 18 dígitos). <br/><br/>Por ejemplo Teléfono celular: 5525072600, TDD: 4323 1234 5678 9123, CLABE: 032180000118359719.
+  # @option opts [String] :beneficiary_bank Es la clave del banco beneficiario. Se puede obtener del recurso de las <a href=\"#operation/getAllInstitutionsUsingGET\">instituciones.</a>
+  # @option opts [String] :beneficiary_name Es el nombre del beneficiario.
+  # @option opts [String] :end_date Es la fecha de inicio del perido a filtrar en formato dd-mm-yyyy.
+  # @option opts [String] :init_date Es la fºecha de inicio del perido a filtrar en formato dd-mm-yyyy.
+  # @option opts [String] :rfc Es el Registro Federal de Controbuyentes (RFC) del beneficiario.
+  # @option opts [String] :status Es el estado (estatus) de la cuenta. Los valores pueden ser <b>PENDING</b> y <b>REGISTERED</b>.
   # @return [BeneficiariesResponse]
   describe 'get_beneficiaries_for_account_using_get test' do
     it 'should work' do
@@ -71,10 +108,11 @@ describe 'CuentasDeBeneficiariosSPEIApi' do
   end
 
   # unit tests for pre_register_accounts_using_post
-  # Pre-registro de cuentas de beneficiarios.
-  # Pre-registra una o más cuentas de beneficiario en la plataforma, proporcionando una URL donde el cuentahabiente Monex debe ingresar un valor de su llave digital para confirmar el alta de las cuentas de beneficiarios.<br/>Los posibles valores de <i>relationship</i> y <i>kind_of_relationship</i> se deben  obtener de /subscriptions/{subscription}/beneficiaries/relationships.<br/><br/>La confirmación de registro en Monex se realiza a través de una llamada a los webhooks registrados con el evento ACCOUNT.CREATED.
+  # Pre-registro de cuentas de beneficiarios SPEI®.
+  # Pre-registra una o más cuentas de beneficiario en la plataforma de Wire4, ésta le proporcionará una URL donde lo llevará al centro de autorización para que el cuentahabiente Monex ingrese su llave digital para confirmar el alta de las cuentas de beneficiarios.<br/> Los posibles valores de <em>relationship</em> y <em>kind_of_relationship</em> se deben  obtener de <a href=\"#operation/getAvailableRelationshipsMonexUsingGET\">/subscriptions/{subscription}/beneficiaries/relationships.</a><br/><br/>La confirmación de registro en Monex se realizará a través de una notificación a los webhooks registrados con el evento de tipo <a href=\"#section/Eventos/Tipos-de-Eventos\">ACCOUNT.CREATED.</a>
+  # @param authorization Header para token
   # @param request_dto Información de la cuenta del beneficiario
-  # @param subscription El identificador de la suscripción a esta API
+  # @param subscription Es el identificador de la suscripción a esta API.
   # @param [Hash] opts the optional parameters
   # @return [TokenRequiredResponse]
   describe 'pre_register_accounts_using_post test' do
@@ -85,9 +123,10 @@ describe 'CuentasDeBeneficiariosSPEIApi' do
 
   # unit tests for remove_beneficiaries_pending_using_delete
   # Eliminación de beneficiarios SPEI® sin confirmar
-  # Elimina un conjunto de beneficiarios a registrar en la cuenta del cliente Monex relacionada a la suscripción, los beneficiarios no deben haber sido confirmados por el cliente.
-  # @param request_id Identificador de los beneficiarios a eliminar
-  # @param subscription El identificador de la suscripción a esta API
+  # Elimina uno o más beneficiarios que se encuentran en estado pendiente de confirmar (autorizar) de la cuenta del cliente Monex relacionada a la suscripción.
+  # @param authorization Header para token
+  # @param request_id Es el identificador con el que se dió de alta a los beneficiarios (viene en el cuerpo de la respuesta del <a href=\"#operation/getAvailableRelationshipsMonexUsingGET\">pre-registro de beneficiarios</a>), los registros bajo éste campo van a ser eliminados.
+  # @param subscription Es el identificador de la suscripción a esta API.
   # @param [Hash] opts the optional parameters
   # @return [nil]
   describe 'remove_beneficiaries_pending_using_delete test' do
@@ -97,13 +136,14 @@ describe 'CuentasDeBeneficiariosSPEIApi' do
   end
 
   # unit tests for update_amount_limit_account_using_put
-  # Actualiza el monto límite
-  # Actualiza el monto límite a la cuenta de beneficiario proporcionada relacionada al contrato perteneciente a la subscripción.
-  # @param account Cuenta a actualizar
-  # @param request_dto Información de la cuenta y el monto límite a actualizar
-  # @param subscription El identificador de la suscripción a esta API
+  # Solicitud para actualizar el monto límite de una cuenta
+  # Se crea una solicitud para actualizar el monto límite a la cuenta de beneficiario proporcionada y relacionada al contrato perteneciente a la subscripción. Una vez enviada la solicitud se retornará una URl que lo llevará al centro de autorización para que el cuentahabiente Monex ingrese su llave digital para confirmar la actualización del monto límite. 
+  # @param authorization Header para token
+  # @param account Es la cuenta que va a ser actualizada.
+  # @param request_dto Información de la cuenta y el monto límite a actualizar.
+  # @param subscription Es el identificador de la suscripción a esta API.
   # @param [Hash] opts the optional parameters
-  # @return [nil]
+  # @return [TokenRequiredResponse]
   describe 'update_amount_limit_account_using_put test' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers

data/spec/api/cuentas_de_beneficiarios_spid_api_spec.rb

@@ -1,7 +1,7 @@
 =begin
 #Wire4RestAPI
 
-#Referencia de la API de Wire4
+#Referencia de API. La API de Wire4 está organizada en torno a REST
 
 OpenAPI spec version: 1.0.0
 
@@ -32,10 +32,32 @@ describe 'CuentasDeBeneficiariosSPIDApi' do
     end
   end
 
+  # unit tests for get_spid_beneficiaries_for_account
+  # Consulta los beneficiarios SPID registrados
+  # Obtiene los beneficiarios SPID registrados al contrato relacionado con la suscripción. Los beneficiarios son los que actualmente se encuentran registrados en banca Monex.
+  # @param authorization Header para token
+  # @param subscription Es el identificador de la suscripción a esta API.
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :account Cuenta del beneficiario, puede ser CLABE (18 dígitos), Tarjeta de débito  (TDD, 16 dígitos) o número de celular (10 dígitos).
+  # @option opts [String] :beneficiary_bank Es la clave del banco beneficiario. Se puede obtener del catalogo de <a href=\"#operation/getAllInstitutionsUsingGET\">instituciones.</a>
+  # @option opts [String] :beneficiary_name Es el nombre del beneficiario.
+  # @option opts [String] :end_date Es la fecha de inicio del periodo a filtrar en formato dd-mm-yyyy.
+  # @option opts [String] :init_date Es la fecha de inicio del periodo a filtrar en formato dd-mm-yyyy.
+  # @option opts [String] :rfc Es el Registro Federal de Contribuyentes (RFC) del beneficiario.
+  # @option opts [String] :status Es el estado (estatus) de la cuenta, Los valores pueden ser <b>PENDING</b> y <b>REGISTERED</b>.
+  # @return [SpidBeneficiariesResponse]
+  describe 'get_spid_beneficiaries_for_account test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
   # unit tests for pre_register_accounts_using_post1
-  # Pre-registro de cuentas de beneficiarios SPID
+  # Pre-registro de cuentas de beneficiarios SPID®
+  # Pre-registra una o más cuentas de beneficiario SPID® en la plataforma de Wire4, ésta le proporcionaará una URL donde lo llevará al centro de autorización para que el cuentahabiente Monex ingrese su llave digital para confirmar el alta de las cuentas de beneficiarios.<br/> Los posibles valores de <em>relationship</em> y <em>kind_of_relationship</em> se deben  obtener de <a href=\"#operation/getAvailableRelationshipsMonexUsingGET\">/subscriptions/{subscription}/beneficiaries/relationships.</a><br/><br/>La confirmación de registro en Monex se realizará a través de una notificación a los webhooks registrados con el evento de tipo <a href=\"#section/Eventos/Tipos-de-Eventos\">ACCOUNT.CREATED.</a>
+  # @param authorization Header para token
   # @param request_spid_dto Información de la cuenta del beneficiario
-  # @param subscription El identificador de la suscripción a esta API
+  # @param subscription Es el identificador de la suscripción a esta API.
   # @param [Hash] opts the optional parameters
   # @return [TokenRequiredResponse]
   describe 'pre_register_accounts_using_post1 test' do