wire4_client 1.0.5 → 1.1.0

data/lib/wire4_client/models/codi_code_request_dto.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/models/codi_operation_response_dto.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,25 +15,25 @@ require 'date'
 module Wire4Client
   # Objeto que contiene la información de solicitud de pago por CODI®.
   class CodiOperationResponseDTO
-    # Monto de la operacion.
+    # Es el monto de la operacion. Ejemplo: 1000.00
     attr_accessor :amount
 
-    # Concepto del pago.
+    # Es el concepto del pago.
     attr_accessor :concept
 
-    # Identificador de la operacion.
+    # Es el identificador de la operacion.
     attr_accessor :id
 
-    # Fecha de la operacion.
+    # Es la fecha de la operacion. Ésta fecha viene en formato ISO 8601 con zona horaria, ejemplo: <strong>2020-10-27T11:03:15.000-06:00</strong>.
     attr_accessor :operation_date
 
-    # Tipo de pago.
+    # Es el tipo de pago.
     attr_accessor :payment_type
 
-    # Estatus.
+    # Es el estado (estatus) de la operación. Los valores pueden ser: <b>COMPLETED, CANCELLED Y POSTPONED</b>
     attr_accessor :status
 
-    # Identificador de la transacción.
+    # Es el identificador de la transacción.
     attr_accessor :transaction_id
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/wire4_client/models/codi_operations_filters_request_dto.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
 
@@ -14,28 +14,28 @@ require 'date'
 
 module Wire4Client
   class CodiOperationsFiltersRequestDTO
-    # Monto minimo, dos decimales
+    # Es el monto minimo. Se permiten dos decimales. Ejemplo 1000.00
     attr_accessor :amount_from
 
-    # Monto máximo,dos decimales
+    # Es el monto máximo. Se permiten dos decimales. Ejemplo 1000.00
     attr_accessor :amount_to
 
-    # Fecha de operación desde
+    # Es el filtro de fecha de operación \"desde\".
     attr_accessor :operation_date_from
 
-    # Fecha de operación hasta
+    # Es el filtro de fecha de operación \"hasta\".
     attr_accessor :operation_date_to
 
-    # Order id de la petición
+    # Es el order id de la petición.
     attr_accessor :order_id
 
-    # Fecha de petición desde
+    # Es el filtro de fecha de petición \"desde\".
     attr_accessor :request_date_from
 
-    # Fecha de petición hasta
+    # Es el filtro de fecha de petición \"hasta\".
     attr_accessor :request_date_to
 
-    # Estatus de petición
+    # Es el estado (estatus) de la petición.
     attr_accessor :status
 
     class EnumAttributeValidator

data/lib/wire4_client/models/company_registered.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,22 +15,22 @@ require 'date'
 module Wire4Client
   # Contiene la información de una empresa registrada
   class CompanyRegistered
-    # Nombre de la empresa registrada
+    # Es el nombre de la empresa registrada.
     attr_accessor :business_name
 
-    # La información del certificado
+    # Es la información del certificado.
     attr_accessor :certificate
 
-    # Nombre comercial de la empresa registrada
+    # Es el nombre comercial de la empresa registrada.
     attr_accessor :comercial_name
 
-    # Identificador de la empresa
+    # Es el identificador de la empresa.
     attr_accessor :company_id
 
-    # RFC de la empresa registrada
+    # Es el Registro Federal de Constituyentes (RFC) de la empresa registrada.
     attr_accessor :rfc
 
-    # El estado de la compañía
+    # Es el estado (estatus) de la compañía. Puede ser \"ACTIVE\" o \"INACTIVE\".
     attr_accessor :status
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/wire4_client/models/company_requested.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
 
@@ -13,18 +13,18 @@ Swagger Codegen version: 2.4.10
 require 'date'
 
 module Wire4Client
-  # Contiene la información de la empresa que se quiere registrar
+  # Contiene la información de la empresa que se quiere registrar.
   class CompanyRequested
-    # Nombre de la empresa que se va a registrar
+    # Es el nombre de la empresa que se va a registrar.
     attr_accessor :business_name
 
-    # Información del certificado
+    # Es el objeto que contiene la información del certificado.
     attr_accessor :certificate
 
-    # Nombre comercial de la empresa que se va a registrar
+    # Es el nombre comercial de la empresa que se va a registrar.
     attr_accessor :comercial_name
 
-    # RFC de la empresa que se va a registrar
+    # Es el Registro Federal de Contribuyentes (RFC) de la empresa que se va a registrar.
     attr_accessor :rfc
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/wire4_client/models/compay.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/models/configurations_limits.rb

@@ -0,0 +1,197 @@
+=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 'date'
+
+module Wire4Client
+  # Es la lista de configuraciones asociadas al contrato
+  class ConfigurationsLimits
+    # Nombre del grupo de configuraciones. Debe ser LIMIT_BY_TIME para especificar la configuración por límite por horario, LIMIT_BY_RANGE para especificar límite por periodo o LIMIT_BY_SCHEDULE para especificar el horario de operaciones
+    attr_accessor :group
+
+    # Lista de items configurados
+    attr_accessor :items
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'group' => :'group',
+        :'items' => :'items'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'group' => :'String',
+        :'items' => :'Array<Item>'
+      }
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      return unless attributes.is_a?(Hash)
+
+      # convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
+
+      if attributes.has_key?(:'group')
+        self.group = attributes[:'group']
+      end
+
+      if attributes.has_key?(:'items')
+        if (value = attributes[:'items']).is_a?(Array)
+          self.items = value
+        end
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          group == o.group &&
+          items == o.items
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [group, items].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.swagger_types.each_pair do |key, type|
+        if type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end # or else data not found in attributes(hash), not an issue as the data can be optional
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :BOOLEAN
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        temp_model = Wire4Client.const_get(type).new
+        temp_model.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        next if value.nil?
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+  end
+end

data/lib/wire4_client/models/contact_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
 
@@ -13,21 +13,21 @@ Swagger Codegen version: 2.4.10
 require 'date'
 
 module Wire4Client
-  # Objeto que contiene información básica de un posible cliente
+  # Objeto que contiene información básica de un posible cliente.
   class ContactRequest
-    # Dirección del contacto
+    # Es la dirección del contacto, por ejemplo: Calle fulanita No. 500 int 2, Col. Conocida.
     attr_accessor :address
 
-    # Nombre de la empresa
+    # Es el nombre de la empresa.
     attr_accessor :company
 
-    # Nombre de la persona quién será contactada
+    # Es el nombre completo de la persona quién será contactada.
     attr_accessor :contact_person
 
-    # Email de la persona
+    # Es el correo electrónico (email) de la persona. Se valida que tenga el formato de email, por ejemplo: correo@correo.com.
     attr_accessor :email
 
-    # Número de teléfono de la persona
+    # Es el número de teléfono de la persona. Se validan que sean 10 dígitos del número.
     attr_accessor :phone_number
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/wire4_client/models/contract_detail_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
 

data/lib/wire4_client/models/contract_detail_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
 

data/lib/wire4_client/models/deposit.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
 
@@ -14,67 +14,67 @@ require 'date'
 
 module Wire4Client
   class Deposit
-    # Monto de la transferencia
+    # Es el monto de la transferencia.
     attr_accessor :amount
 
-    # La cuenta del beneficiario
+    # Es la cuenta del beneficiario.
     attr_accessor :beneficiary_account
 
-    # El nombre del beneficiario
+    # Es el nombre del beneficiario.
     attr_accessor :beneficiary_name
 
-    # El RFC del beneficiario
+    # Es el Registro Federal de Contribuyentes (RFC) del beneficiario.
     attr_accessor :beneficiary_rfc
 
-    # 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
+    # Es el Comprobante Electrónico de Pago (CEP) emitido por Banxico que pertenece a la transferencia. Se informa sólo en caso de que esté disponible en banxico, posteriomente podrá usar la  <a href=\"#operation/obtainTransactionCepUsingPOST\">Consulta de CEP</a> que ésta misma API ofrece.
     attr_accessor :cep
 
-    # La clave de rastreo de la transferencia
+    # Es la clave de rastreo de la transferencia.
     attr_accessor :clave_rastreo
 
-    # Fecha de confirmación del deposito
+    # Es la fecha de confirmación del deposito. Ésta fecha viene en formato ISO 8601 con zona horaria, ejemplo: <strong>2020-10-27T11:03:15.000-06:00</strong>.
     attr_accessor :confirm_date
 
-    # Código de moneda de la transferencia
+    # Es el código de divisa de la transferencia. Es en el formato estándar de 3 dígitos, por ejemplo para el peso mexicano: <b>MXP</b>, para el dólar estadounidense: <b>USD</b>.
     attr_accessor :currency_code
 
-    # Fecha del deposito
+    # Es la fecha del deposito.  Ésta fecha viene en formato ISO 8601 con zona horaria, ejemplo: <strong>2020-10-27T11:03:15.000-06:00</strong>.
     attr_accessor :deposit_date
 
-    # Depositante
+    # Es el depositante.
     attr_accessor :depositant
 
-    # Cuenta CLABE interbancaria del depositante
+    # Es la Cuenta CLABE interbancaria (de 18 dígitos) del depositante.
     attr_accessor :depositant_clabe
 
-    # Email del depositante
+    # Es el correo electrónico (email) del depositante.
     attr_accessor :depositant_email
 
-    # RFC del depositante
+    # Es el Registro Federal de Contribuyentes (RFC) del depositante.
     attr_accessor :depositant_rfc
 
-    # Descripción del traspaso
+    # Es la descripción del traspaso.
     attr_accessor :description
 
-    # Descripción directa de Monex
+    # Es la descripción directa de Monex.
     attr_accessor :monex_description
 
-    # Identificador de la transferencia en Monex
+    # es el identificador de la transferencia en Monex.
     attr_accessor :monex_transaction_id
 
-    # La referencia del depósito
+    # Es la referencia del depósito.
     attr_accessor :reference
 
-    # La cuenta del ordenante
+    # Es la cuenta del ordenante.
     attr_accessor :sender_account
 
-    # El banco del ordenante
+    # Es el banco del ordenante.
     attr_accessor :sender_bank
 
-    # El nombre del ordenante
+    # Es el nombre del ordenante.
     attr_accessor :sender_name
 
-    # El RFC del ordenante
+    # Es el Registro Federal de Contribuyentes (RFC) de la cuenta ordenante.
     attr_accessor :sender_rfc
 
     # Attribute mapping from ruby-style variable name to JSON key.