wire4_client 1.0.5 → 1.1.3

data/lib/wire4_client/models/payment.rb

@@ -14,61 +14,61 @@ require 'date'
 
 module Wire4Client
   class Payment
-    # Cuenta emisora
+    # Es la cuenta 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 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
+  # 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

data/lib/wire4_client/models/payment_request_codi_response_dto.rb

@@ -15,37 +15,37 @@ require 'date'
 module Wire4Client
   # Objeto que contiene la información de solicitud de pago por CODI®.
   class PaymentRequestCodiResponseDTO
-    # Monto del pago.
+    # Es el Monto del pago. Ejemplo 1000.00
     attr_accessor :amount
 
-    # Imagen QR en formato Base64 para el CODI®.
+    # Es la imagen QR en formato Base64 para el CODI®.
     attr_accessor :barcode_base64
 
-    # URL de la imagen QR para el CODI®.
+    # Es la dirección URL de la imagen QR para el CODI®.
     attr_accessor :barcode_url
 
-    # Concepto de pago.
+    # Es el concepto de pago.
     attr_accessor :concept
 
-    # Fecha de creación.
+    # Es la fecha de creación. Ésta fecha viene en formato ISO 8601 con zona horaria, ejemplo: <strong>2020-10-27T11:03:15.000-06:00</strong>.
     attr_accessor :creation_date
 
-    # Fecha de vencimiento.
+    # Es la fecha de vencimiento. Ésta fecha viene en formato ISO 8601 con zona horaria, ejemplo: <strong>2020-10-27T11:03:15.000-06:00</strong>.
     attr_accessor :due_date
 
-    # Listado de pagos realizados sobre la petición.
+    # Es el listado de pagos realizados sobre la petición.
     attr_accessor :operations
 
-    # OrderId asignada a la solicitud.
+    # Es el orderId asignado a la solicitud.
     attr_accessor :order_id
 
-    # Numero de teléfono.
+    # Es el número de teléfono.
     attr_accessor :phone_number
 
-    # Estatus de la orden de pago.
+    # Es el estado (estatus) de la orden de pago. Los valores pueden ser: <b>RECEIVED, COMPLETED Y CANCELLED</b>
     attr_accessor :status
 
-    # Tipo de petición.
+    # Es el tipo de petición. Los valores pueden ser: <b>QR_CODE o PUSH_NOTIFICATION</b>
     attr_accessor :type
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/wire4_client/models/pre_enrollment_data.rb

@@ -14,10 +14,10 @@ require 'date'
 
 module Wire4Client
   class PreEnrollmentData
-    # Url a la que se redirigirá en caso de un error
+    # Es la dirección URL a la que se redirigirá en caso de que el cliente cancele el registro. Se valida una longitud de 512 caracteres y que la URL sea por ejemplo: http://mysite.com/return.
     attr_accessor :cancel_return_url
 
-    # Url a la que se redirigirá en caso de exito
+    # Es la dirección URL a la que se redirigirá en caso de exito. Se valida una longitud de 512 caracteres  y que la URL sea por ejemplo: http://mysite.com/cancel.
     attr_accessor :return_url
 
     # Attribute mapping from ruby-style variable name to JSON key.
@@ -69,6 +69,10 @@ module Wire4Client
         invalid_properties.push('invalid value for "cancel_return_url", the character length must be great than or equal to 1.')
       end
 
+      if @cancel_return_url !~ Regexp.new(/(http:\/\/|https:\/\/).*$/)
+        invalid_properties.push('invalid value for "cancel_return_url", must conform to the pattern /(http:\/\/|https:\/\/).*$/.')
+      end
+
       if @return_url.nil?
         invalid_properties.push('invalid value for "return_url", return_url cannot be nil.')
       end
@@ -81,6 +85,10 @@ module Wire4Client
         invalid_properties.push('invalid value for "return_url", the character length must be great than or equal to 1.')
       end
 
+      if @return_url !~ Regexp.new(/(http:\/\/|https:\/\/).*$/)
+        invalid_properties.push('invalid value for "return_url", must conform to the pattern /(http:\/\/|https:\/\/).*$/.')
+      end
+
       invalid_properties
     end
 
@@ -90,9 +98,11 @@ module Wire4Client
       return false if @cancel_return_url.nil?
       return false if @cancel_return_url.to_s.length > 512
       return false if @cancel_return_url.to_s.length < 1
+      return false if @cancel_return_url !~ Regexp.new(/(http:\/\/|https:\/\/).*$/)
       return false if @return_url.nil?
       return false if @return_url.to_s.length > 512
       return false if @return_url.to_s.length < 1
+      return false if @return_url !~ Regexp.new(/(http:\/\/|https:\/\/).*$/)
       true
     end
 
@@ -111,6 +121,10 @@ module Wire4Client
         fail ArgumentError, 'invalid value for "cancel_return_url", the character length must be great than or equal to 1.'
       end
 
+      if cancel_return_url !~ Regexp.new(/(http:\/\/|https:\/\/).*$/)
+        fail ArgumentError, 'invalid value for "cancel_return_url", must conform to the pattern /(http:\/\/|https:\/\/).*$/.'
+      end
+
       @cancel_return_url = cancel_return_url
     end
 
@@ -129,6 +143,10 @@ module Wire4Client
         fail ArgumentError, 'invalid value for "return_url", the character length must be great than or equal to 1.'
       end
 
+      if return_url !~ Regexp.new(/(http:\/\/|https:\/\/).*$/)
+        fail ArgumentError, 'invalid value for "return_url", must conform to the pattern /(http:\/\/|https:\/\/).*$/.'
+      end
+
       @return_url = return_url
     end
 

data/lib/wire4_client/models/pre_enrollment_response.rb

@@ -14,10 +14,10 @@ require 'date'
 
 module Wire4Client
   class PreEnrollmentResponse
-    # Identificador público generado
+    # Es el identificador público generado para la suscripción.
     attr_accessor :subscription_id
 
-    # Url para confirmación de enrolamiento
+    # Es la dirección URL del centro de autorizción para confirmación del alta de la suscripción.
     attr_accessor :url
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/wire4_client/models/relationship.rb

@@ -14,10 +14,10 @@ require 'date'
 
 module Wire4Client
   class Relationship
-    # Tipo de relación
+    # Es el tipo de relación.
     attr_accessor :kind_of_relationship
 
-    # Nombre de la  relación
+    # Es el mombre de la relación.
     attr_accessor :relationship
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/wire4_client/models/relationships_response.rb

@@ -14,7 +14,7 @@ require 'date'
 
 module Wire4Client
   class RelationshipsResponse
-    # Lista de relaciones del beneficiario
+    # Es una lista de relaciones del beneficiario.
     attr_accessor :relationships
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/wire4_client/models/sales_point_found.rb

@@ -13,27 +13,27 @@ Swagger Codegen version: 2.4.10
 require 'date'
 
 module Wire4Client
-  # Objeto que contiene la información del punto de venta encontrada
+  # Objeto que contiene la información del punto de venta encontrada.
   class SalesPointFound
-    # Ip desde la que accede el punto de venta a wire4 y a la que se devuelven las notificaciones
+    # Es la dirección IP desde la que accede el punto de venta a wire4 y a la que se devuelven las notificaciones.
     attr_accessor :access_ip
 
-    # Cuenta registra para el punto de venta
+    # Es la cuenta registra para el punto de venta.
     attr_accessor :account
 
-    # Fecha en la que se creó el punto de venta
+    # Es la fecha en la que se creó el punto de venta. Ésta fecha viene en formato ISO 8601 con zona horaria, ejemplo: <strong>2020-10-27T11:03:15.000-06:00</strong>.
     attr_accessor :created_at
 
-    # Nombre del punto de venta
+    # Es el nombre del punto de venta.
     attr_accessor :name
 
-    # Identificador del punto de venta
+    # Es el identificador del punto de venta.
     attr_accessor :public_id
 
-    # Estatus ACTIVO/INACTIVO el punto de venta
+    # Es el estado (estatus) del punto de venta. Puede ser \"ACTIVE\" o \"INACTIVO\".
     attr_accessor :status
 
-    # Fecha en la que se actualizó el punto de venta
+    # Es la fecha en la que se actualizó el punto de venta. Ésta fecha viene en formato ISO 8601 con zona horaria, ejemplo: <strong>2020-10-27T11:03:15.000-06:00</strong>.
     attr_accessor :updated_at
 
     class EnumAttributeValidator
@@ -76,11 +76,11 @@ module Wire4Client
       {
         :'access_ip' => :'String',
         :'account' => :'String',
-        :'created_at' => :'Timestamp',
+        :'created_at' => :'DateTime',
         :'name' => :'String',
         :'public_id' => :'String',
         :'status' => :'String',
-        :'updated_at' => :'Timestamp'
+        :'updated_at' => :'DateTime'
       }
     end
 

data/lib/wire4_client/models/sales_point_request.rb

@@ -13,18 +13,18 @@ Swagger Codegen version: 2.4.10
 require 'date'
 
 module Wire4Client
-  # Información para registrar un punto de venta asociado una empresa
+  # Información para registrar un punto de venta asociado una empresa.
   class SalesPointRequest
-    # IP desde donde se recibiran las peticiones de este punto de venta
+    # Es la dirección IP desde donde se recibirán las peticiones de este punto de venta
     attr_accessor :access_ip
 
-    # Número de cuenta CLABE donde se realizará el deposito del cobro CoDi
+    # Es el número de cuenta CLABE donde se realizará el deposito del cobro CODI®.
     attr_accessor :account
 
-    # Nombre del punto de venta
+    # Es el nombre del punto de venta.
     attr_accessor :name
 
-    # URL para envíar notificaciones CoDi al punto de venta
+    # Es la dirección URL para envíar notificaciones CODI® al punto de venta.
     attr_accessor :notifications_url
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/wire4_client/models/sales_point_respose.rb

@@ -13,18 +13,18 @@ Swagger Codegen version: 2.4.10
 require 'date'
 
 module Wire4Client
-  # Objeto que contiene la información del punto de venta que se registro.
+  # Objeto que contiene la información del punto de venta que se registró.
   class SalesPointRespose
-    # Identificador del punto de venta
+    # Es el identificador del punto de venta.
     attr_accessor :sales_point_id
 
-    # Llave de usuario para el API Wire4
+    # Es la llave de usuario para el API Wire4. Sólo para el uso de CODI®.
     attr_accessor :user_key
 
-    # Contraseña para el API Wire4
+    # Es la contraseña para el API Wire4. Sólo para el uso de CODI®.
     attr_accessor :user_secret
 
-    # Webhook registrado para enviar las notificaciones CoDi
+    # codiWebhook
     attr_accessor :webhook
 
     # Attribute mapping from ruby-style variable name to JSON key.