wire4_client 1.0.5 → 1.1.3

data/lib/wire4_client/models/detailed_error_response.rb

@@ -0,0 +1,203 @@
+=begin
+#Wire4RestAPI
+
+#Referencia de la API de Wire4
+
+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
+  class DetailedErrorResponse
+    attr_accessor :errors
+
+    attr_accessor :http_status
+
+    attr_accessor :message
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'errors' => :'errors',
+        :'http_status' => :'http_status',
+        :'message' => :'message'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'errors' => :'Array<TransactionErrorCode>',
+        :'http_status' => :'Integer',
+        :'message' => :'String'
+      }
+    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?(:'errors')
+        if (value = attributes[:'errors']).is_a?(Array)
+          self.errors = value
+        end
+      end
+
+      if attributes.has_key?(:'http_status')
+        self.http_status = attributes[:'http_status']
+      end
+
+      if attributes.has_key?(:'message')
+        self.message = attributes[:'message']
+      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 &&
+          errors == o.errors &&
+          http_status == o.http_status &&
+          message == o.message
+    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
+      [errors, http_status, message].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/get_depositants.rb

@@ -13,9 +13,9 @@ Swagger Codegen version: 2.4.10
 require 'date'
 
 module Wire4Client
-  # Objeto que contiene una lista de depositantes
+  # Es el objeto que contiene una lista de depositantes.
   class GetDepositants
-    # Lista de depositantes que contiene cada depositante encontrado
+    # Es la lista que contiene cada depositante encontrad.o
     attr_accessor :depositants
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/wire4_client/models/institution.rb

@@ -13,18 +13,18 @@ Swagger Codegen version: 2.4.10
 require 'date'
 
 module Wire4Client
-  # Objeto que contiene la información del banco
+  # Objeto que contiene la información del banco.
   class Institution
-    # Razón social de la institución
+    # Es la razón social de la institución.
     attr_accessor :company_name
 
-    # La clabe BANXICO de la institución
+    # Es la clave de BANXICO que pertenece a la institución.
     attr_accessor :key
 
-    # Nombre de la institución
+    # Es el nombre de la institución.
     attr_accessor :name
 
-    # RFC de la institución
+    # Es el Registro Federal de Contribuyente (RFC) que pertenece a la institución bancaria.
     attr_accessor :rfc
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/wire4_client/models/institutions_list.rb

@@ -14,7 +14,7 @@ require 'date'
 
 module Wire4Client
   class InstitutionsList
-    # Lista de instituciones
+    # Es la lista de instituciones bancarias.
     attr_accessor :institutions
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/wire4_client/models/item.rb

@@ -0,0 +1,205 @@
+=begin
+#Wire4RestAPI
+
+#Referencia de la API de Wire4
+
+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
+  # Cada Item especifica el valor configurado para límite de monto permitido o número de operaciones permitidas. Debe especificar un item por cada configuración
+  class Item
+    # Debe ser BY_AMOUNT para indicar la configuración por monto o BY_OPERATION para indicar la configuración por número de operaciones. Si se quiere configurar el horario de operaciones entonces se debe usar START_OPERATIONS_TIME para la hora de inicio de operaciones y END_OPERATIONS_TIME para la hora de fin de operaciones.
+    attr_accessor :key
+
+    # El tipo de dato del grupo de configuraciones. Puede ser: <ul><li>DECIMAL</li><li>INT</li><li>BOOLEAN</li><li>TIME</li>
+    attr_accessor :type
+
+    # Valor configurado
+    attr_accessor :value
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'key' => :'key',
+        :'type' => :'type',
+        :'value' => :'value'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'key' => :'String',
+        :'type' => :'String',
+        :'value' => :'String'
+      }
+    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?(:'key')
+        self.key = attributes[:'key']
+      end
+
+      if attributes.has_key?(:'type')
+        self.type = attributes[:'type']
+      end
+
+      if attributes.has_key?(:'value')
+        self.value = attributes[:'value']
+      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 &&
+          key == o.key &&
+          type == o.type &&
+          value == o.value
+    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
+      [key, type, value].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/message_account_beneficiary.rb

@@ -13,15 +13,15 @@ Swagger Codegen version: 2.4.10
 require 'date'
 
 module Wire4Client
-  # El mensaje que se envía mediante (webHook) con la información del registro de la cuenta del beneficiario
+  # Es el objeto del mensaje que se envía mediante webhook con la información del registro de la cuenta del beneficiario.
   class MessageAccountBeneficiary
-    # Cuenta del beneficiario registrado
+    # Es la cuenta del beneficiario registrado.
     attr_accessor :account
 
-    # Mensaje de error en caso de existir, el valor de este atributo contiene el mensaje
+    # Es el mensaje de error que se informa en caso de existir uno.
     attr_accessor :error_message
 
-    # El identificador en esta API, de la petición de registro de la cuenta del beneficiario
+    # Es el identificador en esta API de la petición de registro de la cuenta del beneficiario.
     attr_accessor :request_id
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/wire4_client/models/message_cep.rb

@@ -13,63 +13,63 @@ Swagger Codegen version: 2.4.10
 require 'date'
 
 module Wire4Client
-  # El CEP emitido por Banxico de la transferencia. Solo cuando esté disponible, en otro caso se podrá usar la Consulta de CEP que esta misma API ofrece
+  # Es el objeto del Comprobante Electrónico de Pago (CEP) de la transferencia, que es emitido por Banxico. Se muestra sólo cuando esté disponible, en otro caso se podrá usar la <a href=\"#operation/obtainTransactionCepUsingPOST\">Consulta de CEP</a> que ésta misma API ofrece.
   class MessageCEP
-    # Cuenta del beneficiario
+    # Es la cuenta del beneficiario.
     attr_accessor :account_beneficiary
 
-    # Cuenta que envia la operación
+    # Es la cuenta que envía la operación.
     attr_accessor :account_sender
 
-    # Monto de la operación
+    # Es el monto de la operación.
     attr_accessor :amount
 
-    # Indica sí el CEP está disponible
+    # Indica sí el CEP está disponible.
     attr_accessor :available
 
-    # Clave del banco beneficiario
+    # Es la clave del banco beneficiario.
     attr_accessor :bank_beneficiary
 
-    # Clave del banco que envía la operación
+    # Es la clave del banco que envía la operación.
     attr_accessor :bank_sender
 
-    # Nombre del beneficiario
+    # Es el nombre del beneficiario.
     attr_accessor :beneficiary_name
 
-    # RFC del beneficiario
+    # Es el Registro Federal de Contribuyentes (RFC) del beneficiario.
     attr_accessor :beneficiary_rfc
 
-    # Cadena original emita por el SAT
+    # Es la cadena original emitida por el Servicio de Administración Tributaria (SAT).
     attr_accessor :cadena_original
 
-    # Fecha de captura
+    # Es la fecha de captura.
     attr_accessor :capture_date
 
-    # Número de serie emitido por el SAT
+    # Es el número de serie emitido por el SAT
     attr_accessor :certificate_serial_number
 
-    # Clave de rastreo de la operación
+    # Es la clave de rastreo de la operación.
     attr_accessor :clave_rastreo
 
-    # Descripción de la operación
+    # Es la descripción de la operación.
     attr_accessor :description
 
-    # IVA de la operación
+    # Es el Impuesto al Valor Agregado (IVA) de la operación.
     attr_accessor :iva
 
-    # Fecha en la que se realizó la operación
+    # Es la fecha en la que se realizó la operación.
     attr_accessor :operation_date
 
-    # Fecha en la que genera el CEP
+    # Es la fecha en la que se genera el CEP.
     attr_accessor :operation_date_cep
 
-    # Referencia de la operación
+    # Es la Referencia de la operación
     attr_accessor :reference
 
-    # Nombre de quién envía la operación
+    # Es el nombre de quién envía la operación.
     attr_accessor :sender_name
 
-    # RFC de quién envía la operación
+    # Es el Registro Federal de Contrinuyentes (RFC) de quién envía la operación.
     attr_accessor :sender_rfc
 
     # Firma del CEP

data/lib/wire4_client/models/message_codi_action.rb

@@ -13,42 +13,42 @@ Swagger Codegen version: 2.4.10
 require 'date'
 
 module Wire4Client
-  # El mensaje que se envía con la informacion del punto de venta registrado
+  # Es el objeto del mensaje que se envía con la información del punto de venta registrado.
   class MessageCodiAction
-    # Monto de la operación de pago
+    # Es el monto de la operación de pago.
     attr_accessor :amount
 
-    # Concepto
+    # Es el concepto de la transacción.
     attr_accessor :concept
 
-    # Fecha de expiración de la operación
+    # Es la fecha de expiración de la operación.
     attr_accessor :due_date
 
-    # Uuid de la operación
+    # Es el UUID de la operación.
     attr_accessor :id
 
-    # Metadata asociada a la petición de pago
+    # Es el campo Metadata asociado a la petición de pago. Es información que indica guardar la petición.
     attr_accessor :metadata
 
-    # Fecha de la operación
+    # Es la fecha de la operación.
     attr_accessor :operation_date
 
-    # Identificador de la petición
+    # Es el identificador de la petición.
     attr_accessor :order_id
 
-    # Tipo de pago
+    # Es el tipo de pago.
     attr_accessor :payment_type
 
-    # Número de referencia
+    # Es el número de referencia.
     attr_accessor :reference
 
-    # Identidicador del punto de venta a la que pertenece la petición de pago
+    # Identidicador del punto de venta a la que pertenece la petición de pago.
     attr_accessor :sales_point_id
 
-    # Estado de la operación de pago
+    # Es el estado (estatus) de la operación de pago.
     attr_accessor :status
 
-    # Id 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.