wire4_client 1.0.5 → 1.1.0

data/lib/wire4_client/models/message_web_hook.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,33 +13,33 @@ Swagger Codegen version: 2.4.10
 require 'date'
 
 module Wire4Client
-  # El objeto que se envía mediante un mensaje WebHook
+  # El objeto que se envía mediante un mensaje WebHook.
   class MessageWebHook
-    # La versión de esta API
+    # Es la versión de esta API.
     attr_accessor :api_version
 
-    # Fecha de creación del mensaje
+    # Fecha de creación del mensaje.
     attr_accessor :created
 
-    # Objeto que contiene la información del evento
+    # Es el objeto que contiene la información del evento.
     attr_accessor :data
 
-    # El identificador del mensaje
+    # Es el identificador del mensaje.
     attr_accessor :id
 
-    # Indica si proviene de un entorno productivo
+    # Indica si proviene de un entorno productivo.
     attr_accessor :livemode
 
-    # Tipo de objeto  que contiene el mensaje en el atributo 'data' los posibles valores son: subscription, beneficiary, spei_outgoing, spei_incoming, spid_outgoing, request_outgoing 
+    # Tipo de objeto  que contiene el mensaje en el atributo 'data'. Los posibles valores son:  <ul><li>subscription</li>, <li>beneficiary</li>, <li>spei_outgoing</li>, <li>spei_incoming</li>, <li>spid_outgoing</li>, <li>request_outgoing</li><ul> 
     attr_accessor :object
 
-    # Número de  mensajes pendientes de enviar
+    # Es el número de mensajes pendientes de enviar.
     attr_accessor :pending_webhooks
 
-    # Identificador del recurso relacionado
+    # Es el identificador del recurso relacionado.
     attr_accessor :request
 
-    # El tipo evento que se esta enviando en la notifiación
+    # El tipo evento que se está enviando en la notificación.
     attr_accessor :type
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/wire4_client/models/operations.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,36 +13,36 @@ Swagger Codegen version: 2.4.10
 require 'date'
 
 module Wire4Client
-  # Objeto que contiene la información de las operaciones
+  # Objeto que contiene la información de las operaciones.
   class Operations
-    # Monto de la petición
+    # Es el monto de la petición.
     attr_accessor :amount
 
-    # Empresa CoDi
+    # Es el objeto de una empresa CODI®.
     attr_accessor :company
 
-    # Descripción de la petición
+    # Es la descripción de la petición.
     attr_accessor :description
 
     # Fecha de vencimiento de la petición
     attr_accessor :due_date
 
-    # Order id de la petición
+    # Es el order id de la petición.
     attr_accessor :order_id
 
     # Pago
     attr_accessor :payment
 
-    # Numero de telefono
+    # Es el número de teléfono.
     attr_accessor :phone_number
 
-    # Punto de venta
+    # Es el objeto de un punto de venta.
     attr_accessor :sales_point
 
     # Estatus de la petición
     attr_accessor :status
 
-    # Tipo de petición de cobro
+    # Es el tipo de petición de cobro.
     attr_accessor :type
 
     class EnumAttributeValidator
@@ -91,7 +91,7 @@ module Wire4Client
         :'description' => :'String',
         :'due_date' => :'DateTime',
         :'order_id' => :'String',
-        :'payment' => :'Payment',
+        :'payment' => :'PaymentCODI',
         :'phone_number' => :'String',
         :'sales_point' => :'SalesPoint',
         :'status' => :'String',

data/lib/wire4_client/models/pager_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
 
@@ -14,22 +14,22 @@ require 'date'
 
 module Wire4Client
   class PagerResponseDto
-    # Contenido de la respuesta paginada
+    # Es el contenido de la respuesta paginada.
     attr_accessor :content
 
-    # Numero de elementos en la pagina
+    # Es el número de elementos en la página actual.
     attr_accessor :number_of_elements
 
-    # Número de pagina
+    # Es el número de página.
     attr_accessor :page
 
-    # Tamaño de la pagina
+    # Es el tamaño de la página, por ejemplo puede ser 20, que significa que son 20 registros por página.
     attr_accessor :size
 
-    # Numero total de elementos de la consulta
+    # Es el número total de elementos de la consulta.
     attr_accessor :total_items
 
-    # Numero total de paginas
+    # Es el número total de paginas.
     attr_accessor :total_pages
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/wire4_client/models/payment.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,61 +14,61 @@ require 'date'
 
 module Wire4Client
   class Payment
-    # Cuenta emisora
+    # Es la uenta emisora.
     attr_accessor :account
 
-    # Monto de la transferencia
+    # Es el monto de la transferencia.
     attr_accessor :amount
 
-    # Cuenta del beneficiario
+    # Es la cuenta del beneficiario.
     attr_accessor :beneficiary_account
 
-    # Información del banco beneficiario
+    # Es la información del banco beneficiario.
     attr_accessor :beneficiary_bank
 
-    # Nombre del Beneficiario
+    # Es el nombre del Beneficiario.
     attr_accessor :beneficiary_name
 
-    # 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 de la transferencia. Sólo en caso de que este disponible en Banxico, posteriomente podrá usar la <a href=\"#operation/obtainTransactionCepUsingPOST\">Consulta de CEP</a> que ésta misma API ofrece.
     attr_accessor :cep
 
-    # Clave de rastreo de la transferencia
+    # Es la clave de rastreo de la transferencia.
     attr_accessor :clave_rastreo
 
-    # Concepto de pago
+    # Es el concepto de pago.
     attr_accessor :concept
 
-    # Fecha de aplicación de la transferencia
+    # Es la fecha de aplicación de la transferencia. É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. Ejemplo del peso mexicano: <b>MXP</b>, ejemplo del dólar estadounidense: <b>USD</b>.
     attr_accessor :currency_code
 
-    # Mensaje proporcionado por Monex para la transferencia
+    # Es el mensaje proporcionado por Monex para la transferencia.
     attr_accessor :detention_message
 
-    # Mensaje de error, en caso de algún error se informará aquí
+    # Es el mensaje de error, en caso de algún error se informará aquí.
     attr_accessor :error_message
 
-    # Descripción
+    # Es la descripción de Monex.
     attr_accessor :monex_description
 
-    # Identificador asignado por la aplciación a la transferencia
+    # Es el identificador asignado por la aplciación a la transferencia.
     attr_accessor :order_id
 
-    # Identificador de la orden de pago en Monex
+    # Es el identificador de la orden de pago en Monex.
     attr_accessor :payment_order_id
 
-    # Razón de porque esta pendiente aun cuando se autorizó la transferencia
+    # Es la razón de porque esta pendiente aún cuando se autorizó la transferencia.
     attr_accessor :pending_reason
 
-    # Referencia numérica
+    # Es la referencia numérica.
     attr_accessor :reference
 
-    # Estado de la transferencia de la transferencia, los posibles valores son: PENDING, COMPLETED, FAILED, CANCELLED
+    # Es el estado de la transferencia de la transferencia, los posibles valores son: <b>PENDING, COMPLETED, FAILED, CANCELLED</b>
     attr_accessor :status_code
 
-    # Identificador de la transferencia asignado por Monex
+    # Es el identificador de la transferencia asignado por Monex.
     attr_accessor :transaction_id
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/wire4_client/models/payment_codi.rb

@@ -0,0 +1,269 @@
+=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
+  # Objeto que contiene la información del pago realizado
+  class PaymentCODI
+    # Monto del pago
+    attr_accessor :amount
+
+    # Descripción del pago
+    attr_accessor :description
+
+    # Mensaje de error
+    attr_accessor :error_message
+
+    # Identificador del pago
+    attr_accessor :id
+
+    # Fecha en que se efectuo el pago
+    attr_accessor :operation_date
+
+    # Estatus del pago
+    attr_accessor :status
+
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'amount' => :'amount',
+        :'description' => :'description',
+        :'error_message' => :'error_message',
+        :'id' => :'id',
+        :'operation_date' => :'operation_date',
+        :'status' => :'status'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'amount' => :'Float',
+        :'description' => :'String',
+        :'error_message' => :'String',
+        :'id' => :'String',
+        :'operation_date' => :'DateTime',
+        :'status' => :'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?(:'amount')
+        self.amount = attributes[:'amount']
+      end
+
+      if attributes.has_key?(:'description')
+        self.description = attributes[:'description']
+      end
+
+      if attributes.has_key?(:'error_message')
+        self.error_message = attributes[:'error_message']
+      end
+
+      if attributes.has_key?(:'id')
+        self.id = attributes[:'id']
+      end
+
+      if attributes.has_key?(:'operation_date')
+        self.operation_date = attributes[:'operation_date']
+      end
+
+      if attributes.has_key?(:'status')
+        self.status = attributes[:'status']
+      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?
+      status_validator = EnumAttributeValidator.new('String', ['RECEIVED', 'COMPLETED', 'CANCELLED'])
+      return false unless status_validator.valid?(@status)
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] status Object to be assigned
+    def status=(status)
+      validator = EnumAttributeValidator.new('String', ['RECEIVED', 'COMPLETED', 'CANCELLED'])
+      unless validator.valid?(status)
+        fail ArgumentError, 'invalid value for "status", must be one of #{validator.allowable_values}.'
+      end
+      @status = status
+    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 &&
+          amount == o.amount &&
+          description == o.description &&
+          error_message == o.error_message &&
+          id == o.id &&
+          operation_date == o.operation_date &&
+          status == o.status
+    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
+      [amount, description, error_message, id, operation_date, status].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