wire4_client 0.0.1.pre.SNAPSHOT → 1.1.0

data/lib/wire4_client/models/account_spid.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
   class AccountSpid
-    # Monto límite permitido para la cuenta
+    # Monto límite permitido para la cuenta. Ejemplo: 1000.00
     attr_accessor :amount_limit
 
-    # Código banxico con una longitud de 5 dígitos, es requerido en caso de que la cuenta del beneficiario sea un número de celular
+    # Es el código banxico con una longitud de 5 dígitos, es requerido en caso de que la cuenta del beneficiario sea un número de celular.
     attr_accessor :bank_code_banxico
 
-    # Cuenta del beneficiario debe ser una cuenta CLABE
+    # Cuenta del beneficiario debe ser una cuenta CLABE. Ejemplo: 032180000118359719.
     attr_accessor :beneficiary_account
 
-    # Url a la que se redirigira en caso no exitoso
+    # Es la dirección URL a la que se redirigirá en caso de que el cliente cancele el registro. Se valida hasta 512 caracteres.
     attr_accessor :cancel_return_url
 
-    # 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 cuentaobtained of endpoint 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
+    # Es la referencia numérica.
     attr_accessor :numeric_reference
 
-    # Concepto de pago
+    # Es el concepto de pago.
     attr_accessor :payment_concept
 
-    # Código de relación de la cuenta, este valor debe ser igual a un valor obtenido del endpoint 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
 
-    # Url a la que se redireccionara en caso exitoso
+    # Es la dirección URL a la que se redirigirá en caso exitoso. Se valida hasta 512 caracteres.
     attr_accessor :return_url
 
-    # 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
 
     # Attribute mapping from ruby-style variable name to JSON key.
@@ -170,6 +170,14 @@ module Wire4Client
         invalid_properties.push('invalid value for "beneficiary_account", beneficiary_account cannot be nil.')
       end
 
+      if !@cancel_return_url.nil? && @cancel_return_url.to_s.length > 512
+        invalid_properties.push('invalid value for "cancel_return_url", the character length must be smaller than or equal to 512.')
+      end
+
+      if !@cancel_return_url.nil? && @cancel_return_url.to_s.length < 10
+        invalid_properties.push('invalid value for "cancel_return_url", the character length must be great than or equal to 10.')
+      end
+
       if @institution.nil?
         invalid_properties.push('invalid value for "institution", institution cannot be nil.')
       end
@@ -194,6 +202,14 @@ module Wire4Client
         invalid_properties.push('invalid value for "relationship", relationship cannot be nil.')
       end
 
+      if !@return_url.nil? && @return_url.to_s.length > 512
+        invalid_properties.push('invalid value for "return_url", the character length must be smaller than or equal to 512.')
+      end
+
+      if !@return_url.nil? && @return_url.to_s.length < 10
+        invalid_properties.push('invalid value for "return_url", the character length must be great than or equal to 10.')
+      end
+
       invalid_properties
     end
 
@@ -205,12 +221,16 @@ module Wire4Client
       return false if !@bank_code_banxico.nil? && @bank_code_banxico.to_s.length < 5
       return false if !@bank_code_banxico.nil? && @bank_code_banxico !~ Regexp.new(/[0-9][0-9]*/)
       return false if @beneficiary_account.nil?
+      return false if !@cancel_return_url.nil? && @cancel_return_url.to_s.length > 512
+      return false if !@cancel_return_url.nil? && @cancel_return_url.to_s.length < 10
       return false if @institution.nil?
       return false if @kind_of_relationship.nil?
       return false if !@numeric_reference.nil? && @numeric_reference.to_s.length > 7
       return false if !@numeric_reference.nil? && @numeric_reference.to_s.length < 1
       return false if !@numeric_reference.nil? && @numeric_reference !~ Regexp.new(/[0-9][0-9]*/)
       return false if @relationship.nil?
+      return false if !@return_url.nil? && @return_url.to_s.length > 512
+      return false if !@return_url.nil? && @return_url.to_s.length < 10
       true
     end
 
@@ -232,6 +252,20 @@ module Wire4Client
       @bank_code_banxico = bank_code_banxico
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] cancel_return_url Value to be assigned
+    def cancel_return_url=(cancel_return_url)
+      if !cancel_return_url.nil? && cancel_return_url.to_s.length > 512
+        fail ArgumentError, 'invalid value for "cancel_return_url", the character length must be smaller than or equal to 512.'
+      end
+
+      if !cancel_return_url.nil? && cancel_return_url.to_s.length < 10
+        fail ArgumentError, 'invalid value for "cancel_return_url", the character length must be great than or equal to 10.'
+      end
+
+      @cancel_return_url = cancel_return_url
+    end
+
     # Custom attribute writer method with validation
     # @param [Object] numeric_reference Value to be assigned
     def numeric_reference=(numeric_reference)
@@ -250,6 +284,20 @@ module Wire4Client
       @numeric_reference = numeric_reference
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] return_url Value to be assigned
+    def return_url=(return_url)
+      if !return_url.nil? && return_url.to_s.length > 512
+        fail ArgumentError, 'invalid value for "return_url", the character length must be smaller than or equal to 512.'
+      end
+
+      if !return_url.nil? && return_url.to_s.length < 10
+        fail ArgumentError, 'invalid value for "return_url", the character length must be great than or equal to 10.'
+      end
+
+      @return_url = return_url
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)

data/lib/wire4_client/models/address_company.rb

@@ -0,0 +1,275 @@
+=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
+  # La dirección de la companía
+  class AddressCompany
+    # La ciudad
+    attr_accessor :city
+
+    # La clabe del país
+    attr_accessor :country_code
+
+    # Número exterior
+    attr_accessor :exterior_number
+
+    # Número interior
+    attr_accessor :interior_number
+
+    # El municipio
+    attr_accessor :municipality
+
+    # Código postal
+    attr_accessor :postal_code
+
+    # El asentamiento
+    attr_accessor :settlement
+
+    # El nombre del asentamiento
+    attr_accessor :settlement_name
+
+    # El estado
+    attr_accessor :state
+
+    # La calle
+    attr_accessor :street_address
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'city' => :'city',
+        :'country_code' => :'country_code',
+        :'exterior_number' => :'exterior_number',
+        :'interior_number' => :'interior_number',
+        :'municipality' => :'municipality',
+        :'postal_code' => :'postal_code',
+        :'settlement' => :'settlement',
+        :'settlement_name' => :'settlement_name',
+        :'state' => :'state',
+        :'street_address' => :'street_address'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'city' => :'String',
+        :'country_code' => :'String',
+        :'exterior_number' => :'String',
+        :'interior_number' => :'String',
+        :'municipality' => :'String',
+        :'postal_code' => :'String',
+        :'settlement' => :'String',
+        :'settlement_name' => :'String',
+        :'state' => :'String',
+        :'street_address' => :'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?(:'city')
+        self.city = attributes[:'city']
+      end
+
+      if attributes.has_key?(:'country_code')
+        self.country_code = attributes[:'country_code']
+      end
+
+      if attributes.has_key?(:'exterior_number')
+        self.exterior_number = attributes[:'exterior_number']
+      end
+
+      if attributes.has_key?(:'interior_number')
+        self.interior_number = attributes[:'interior_number']
+      end
+
+      if attributes.has_key?(:'municipality')
+        self.municipality = attributes[:'municipality']
+      end
+
+      if attributes.has_key?(:'postal_code')
+        self.postal_code = attributes[:'postal_code']
+      end
+
+      if attributes.has_key?(:'settlement')
+        self.settlement = attributes[:'settlement']
+      end
+
+      if attributes.has_key?(:'settlement_name')
+        self.settlement_name = attributes[:'settlement_name']
+      end
+
+      if attributes.has_key?(:'state')
+        self.state = attributes[:'state']
+      end
+
+      if attributes.has_key?(:'street_address')
+        self.street_address = attributes[:'street_address']
+      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 &&
+          city == o.city &&
+          country_code == o.country_code &&
+          exterior_number == o.exterior_number &&
+          interior_number == o.interior_number &&
+          municipality == o.municipality &&
+          postal_code == o.postal_code &&
+          settlement == o.settlement &&
+          settlement_name == o.settlement_name &&
+          state == o.state &&
+          street_address == o.street_address
+    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
+      [city, country_code, exterior_number, interior_number, municipality, postal_code, settlement, settlement_name, state, street_address].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/amount_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,23 +13,31 @@ Swagger Codegen version: 2.4.10
 require 'date'
 
 module Wire4Client
-  # Objeto que contiene la información del previo y nuevo monto límite
+  # Objeto que contiene la información del previo y nuevo monto límite.
   class AmountRequest
-    # Nuevo monto límite que reemplazará al actual, un monto de 0.0 implica que no hay límite
+    # Es el nuevo monto límite que reemplazará al actual, un monto de 0.0 implica que no hay límite.
     attr_accessor :amount_limit
 
-    # Código de moneda de la cuenta
+    # Es la dirección URL a la que se redirigirá en caso de que el cliente cancele el registro. Se valida hasta 512 caracteres.
+    attr_accessor :cancel_return_url
+
+    # Es el código de divisa de la cuenta. 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
 
-    # Monto límite registrado actualmente, un monto de 0.0 implica que no hay límite
+    # Es el monto límite registrado actualmente, un monto de 0.0 implica que no hay límite.
     attr_accessor :previous_amount_limit
 
+    # Es la dirección URL a la que se redirigirá en caso de éxito. Se valida hasta 512 caracteres.
+    attr_accessor :return_url
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'amount_limit' => :'amount_limit',
+        :'cancel_return_url' => :'cancel_return_url',
         :'currency_code' => :'currency_code',
-        :'previous_amount_limit' => :'previous_amount_limit'
+        :'previous_amount_limit' => :'previous_amount_limit',
+        :'return_url' => :'return_url'
       }
     end
 
@@ -37,8 +45,10 @@ module Wire4Client
     def self.swagger_types
       {
         :'amount_limit' => :'Float',
+        :'cancel_return_url' => :'String',
         :'currency_code' => :'String',
-        :'previous_amount_limit' => :'Float'
+        :'previous_amount_limit' => :'Float',
+        :'return_url' => :'String'
       }
     end
 
@@ -54,6 +64,10 @@ module Wire4Client
         self.amount_limit = attributes[:'amount_limit']
       end
 
+      if attributes.has_key?(:'cancel_return_url')
+        self.cancel_return_url = attributes[:'cancel_return_url']
+      end
+
       if attributes.has_key?(:'currency_code')
         self.currency_code = attributes[:'currency_code']
       end
@@ -61,6 +75,10 @@ module Wire4Client
       if attributes.has_key?(:'previous_amount_limit')
         self.previous_amount_limit = attributes[:'previous_amount_limit']
       end
+
+      if attributes.has_key?(:'return_url')
+        self.return_url = attributes[:'return_url']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -75,6 +93,18 @@ module Wire4Client
         invalid_properties.push('invalid value for "amount_limit", must be greater than or equal to 0.0.')
       end
 
+      if @cancel_return_url.nil?
+        invalid_properties.push('invalid value for "cancel_return_url", cancel_return_url cannot be nil.')
+      end
+
+      if @cancel_return_url.to_s.length > 512
+        invalid_properties.push('invalid value for "cancel_return_url", the character length must be smaller than or equal to 512.')
+      end
+
+      if @cancel_return_url.to_s.length < 10
+        invalid_properties.push('invalid value for "cancel_return_url", the character length must be great than or equal to 10.')
+      end
+
       if @currency_code.nil?
         invalid_properties.push('invalid value for "currency_code", currency_code cannot be nil.')
       end
@@ -87,6 +117,18 @@ module Wire4Client
         invalid_properties.push('invalid value for "previous_amount_limit", must be greater than or equal to 0.0.')
       end
 
+      if @return_url.nil?
+        invalid_properties.push('invalid value for "return_url", return_url cannot be nil.')
+      end
+
+      if @return_url.to_s.length > 512
+        invalid_properties.push('invalid value for "return_url", the character length must be smaller than or equal to 512.')
+      end
+
+      if @return_url.to_s.length < 10
+        invalid_properties.push('invalid value for "return_url", the character length must be great than or equal to 10.')
+      end
+
       invalid_properties
     end
 
@@ -95,9 +137,15 @@ module Wire4Client
     def valid?
       return false if @amount_limit.nil?
       return false if @amount_limit < 0.0
+      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 < 10
       return false if @currency_code.nil?
       return false if @previous_amount_limit.nil?
       return false if @previous_amount_limit < 0.0
+      return false if @return_url.nil?
+      return false if @return_url.to_s.length > 512
+      return false if @return_url.to_s.length < 10
       true
     end
 
@@ -115,6 +163,24 @@ module Wire4Client
       @amount_limit = amount_limit
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] cancel_return_url Value to be assigned
+    def cancel_return_url=(cancel_return_url)
+      if cancel_return_url.nil?
+        fail ArgumentError, 'cancel_return_url cannot be nil'
+      end
+
+      if cancel_return_url.to_s.length > 512
+        fail ArgumentError, 'invalid value for "cancel_return_url", the character length must be smaller than or equal to 512.'
+      end
+
+      if cancel_return_url.to_s.length < 10
+        fail ArgumentError, 'invalid value for "cancel_return_url", the character length must be great than or equal to 10.'
+      end
+
+      @cancel_return_url = cancel_return_url
+    end
+
     # Custom attribute writer method with validation
     # @param [Object] previous_amount_limit Value to be assigned
     def previous_amount_limit=(previous_amount_limit)
@@ -129,14 +195,34 @@ module Wire4Client
       @previous_amount_limit = previous_amount_limit
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] return_url Value to be assigned
+    def return_url=(return_url)
+      if return_url.nil?
+        fail ArgumentError, 'return_url cannot be nil'
+      end
+
+      if return_url.to_s.length > 512
+        fail ArgumentError, 'invalid value for "return_url", the character length must be smaller than or equal to 512.'
+      end
+
+      if return_url.to_s.length < 10
+        fail ArgumentError, 'invalid value for "return_url", the character length must be great than or equal to 10.'
+      end
+
+      @return_url = return_url
+    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_limit == o.amount_limit &&
+          cancel_return_url == o.cancel_return_url &&
           currency_code == o.currency_code &&
-          previous_amount_limit == o.previous_amount_limit
+          previous_amount_limit == o.previous_amount_limit &&
+          return_url == o.return_url
     end
 
     # @see the `==` method
@@ -148,7 +234,7 @@ module Wire4Client
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [amount_limit, currency_code, previous_amount_limit].hash
+      [amount_limit, cancel_return_url, currency_code, previous_amount_limit, return_url].hash
     end
 
     # Builds the object from hash