wire4_client 1.0.5 → 1.1.0

data/lib/wire4_client/models/spid_beneficiaries_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
 
@@ -14,7 +14,7 @@ require 'date'
 
 module Wire4Client
   class SpidBeneficiariesResponse
-    # Lista de beneficiarios obtenidos
+    # Es una lista de beneficiarios obtenidos.
     attr_accessor :beneficiaries
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/wire4_client/models/spid_beneficiary_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
 
@@ -15,40 +15,40 @@ require 'date'
 module Wire4Client
   # Objeto que contiene información de la cuenta de beneficiario SPID
   class SpidBeneficiaryResponse
-    # Monto límite permitido para la cuenta
+    # Monto límite permitido para la cuenta. Ejemplo: 1000.00
     attr_accessor :amount_limit
 
-    # El banco al cual pertenece la cuenta
+    # El banco al cual pertenece la cuenta.
     attr_accessor :bank
 
-    # Cuenta del beneficiario debe ser una cuenta CLABE
+    # Cuenta del beneficiario debe ser una cuenta CLABE. Ejemplo: 032180000118359719.
     attr_accessor :beneficiary_account
 
-    # Lista de email's, este dato es opcional
+    # Lista de correos electrónicos (emails), este dato es opcional.
     attr_accessor :email
 
     # Objeto que contiene el nombre de la institución, es mutuamente exclusivo con el objeto Person
     attr_accessor :institution
 
-    # Tipo de relación de la cuenta, este valor debe ser igual a uno de los obtenidos del recurso de consulta de relationships
+    # Es el tipo de relación que se tiene con el propietario de la cuenta. Para registrar una cuenta, este valor se debe obtener del recurso <a href=\"#operation/getAvailableRelationshipsMonexUsingGET\"> relationships.</a> <br /><br /><b>Nota:</b> <em>Si en la respuesta de Monex esta propiedad es nula, tampoco estará presente en esta respuesta.</em>
     attr_accessor :kind_of_relationship
 
-    # Referencia numérica
+    # Referencia numérica.
     attr_accessor :numeric_reference_spid
 
-    # Concepto de pago
+    # Concepto de pago.
     attr_accessor :payment_concept_spid
 
-    # La fecha en la que se registro el beneficiario
+    # La fecha en la que se registro el beneficiario.
     attr_accessor :register_date
 
-    # Código de relación de la cuenta, este valor debe ser igual a uno de los obtenidos del recurso de consulta de  relationship
+    # Es la relación con el propietario de la cuenta, para registrar este valor se debe obtener del recurso <a href=\"#operation/getAvailableRelationshipsMonexUsingGET\">relationships.</a> <br/> <br/> <b>Nota:</b> Si en la respuesta de Monex, sta propiedad es nula, tampoco estará presente en esta respuesta.
     attr_accessor :relationship
 
-    # Registro federal de contribuyentes
+    # Es el Registro federal de contribuyentes (RFC) de la persona o institución propietaria de la cuenta. <br/> <br/><b>Nota:</b> Se valida el formato de RFC.
     attr_accessor :rfc
 
-    # El estado en el que se encuentra el registo del beneficiario
+    # El estado en el que se encuentra el registo del beneficiario.<br><br> Los valores pueden ser: <b>\"RECEIVED\", \"DELETED\", \"REQUEST_ERROR_BY_MONEX\", \"REQUESTED_TO_MONEX\", \"NOTIFIED_BY_MONEX\", \"NOTIFIED_BY_SPEIOK\", \"NOTIFIED_WITH_ERROR_BY_SPEIOK\" y \"PENDING\"</b>
     attr_accessor :status
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/wire4_client/models/spid_classification_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,10 +15,10 @@ require 'date'
 module Wire4Client
   # La información acerca de la clasificación de la operación.
   class SpidClassificationDTO
-    # El identificador de la clasificación
+    # Es el identificador de la clasificación.
     attr_accessor :classification_id
 
-    # Las descripción de la clasificación de la operación
+    # Es la descripción de la clasificación de la operación.
     attr_accessor :description
 
     # Attribute mapping from ruby-style variable name to JSON key.

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

data/lib/wire4_client/models/subscription_change_status_request.rb

@@ -0,0 +1,222 @@
+=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
+  class SubscriptionChangeStatusRequest
+    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
+      {
+        :'status' => :'status'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'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?(:'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
+      if @status.nil?
+        invalid_properties.push('invalid value for "status", status cannot be nil.')
+      end
+
+      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?
+      return false if @status.nil?
+      status_validator = EnumAttributeValidator.new('String', ['ACTIVE', 'INACTIVE'])
+      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', ['ACTIVE', 'INACTIVE'])
+      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 &&
+          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
+      [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/token_required_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
 
@@ -13,12 +13,12 @@ Swagger Codegen version: 2.4.10
 require 'date'
 
 module Wire4Client
-  # Respuesta con una url que requiere que un token sea capturado
+  # Respuesta con una dirección URL para el centro de autorización y se que requiere una autorización mediante un token.
   class TokenRequiredResponse
-    # Identificador público generado para la petición
+    # Es el identificador público generado para la petición (solicitud).
     attr_accessor :request_id
 
-    # La url generada para confirmación de la operación
+    # Es la dirección URL generada para confirmación de la operación. Es para ingresar al centro de autorización.
     attr_accessor :url
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/wire4_client/models/transaction_error_code.rb

@@ -0,0 +1,201 @@
+=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
+  class TransactionErrorCode
+    attr_accessor :code
+
+    attr_accessor :error
+
+    attr_accessor :order_id
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'code' => :'code',
+        :'error' => :'error',
+        :'order_id' => :'order_id'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'code' => :'String',
+        :'error' => :'String',
+        :'order_id' => :'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?(:'code')
+        self.code = attributes[:'code']
+      end
+
+      if attributes.has_key?(:'error')
+        self.error = attributes[:'error']
+      end
+
+      if attributes.has_key?(:'order_id')
+        self.order_id = attributes[:'order_id']
+      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 &&
+          code == o.code &&
+          error == o.error &&
+          order_id == o.order_id
+    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
+      [code, error, order_id].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