wire4_client 0.0.1.pre.SNAPSHOT → 1.1.0

data/lib/wire4_client/models/account_reassigned.rb

@@ -0,0 +1,375 @@
+=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 información de las cuenta SPEI/SPID reasignadas bajo un nuevo identificador de solicitud.
+  class AccountReassigned
+    # Es el monto límite permitido que se registra para la cuenta. Por ejemplo 1000.00.
+    attr_accessor :amount_limit
+
+    # Es el banco al cuál pertenece la cuenta.
+    attr_accessor :bank
+
+    # Es la cuenta del beneficiario, podría ser teléfono celular (se valida que sea de 10 dígitos), Tarjeta de débito (TDD, se valida que sea de 16 dígitos) o cuenta CLABE (se valida que sea de 18 dígitos). <br/><br/>Por ejemplo Teléfono celular: 5525072600, TDD: 4323 1234 5678 9123, CLABE: 032180000118359719.
+    attr_accessor :beneficiary_account
+
+    # Es el código de divisa. 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>.<br/><br/>Este dato es opcional, al registrar una cuenta si no se cuenta con este valor se asignará <b>MXP</b>
+    attr_accessor :currency_code
+
+    # Es una lista de correos electrónicos (emails). Se valida el formato de email. Este campo es opcional.
+    attr_accessor :email
+
+    # Es el objeto que contiene el nombre de la institución, es mutuamente exclusivo con el objeto Person.
+    attr_accessor :institution
+
+    # 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
+
+    # Es la referencia numérica a utilizar cuando se realice una transferencia y no se especifique una referencia.
+    attr_accessor :numeric_reference_spei
+
+    # Es el concepto de pago a utilizar cuando se realice una transferencia y no se especifique un concepto
+    attr_accessor :payment_concept_spei
+
+    # Es el objeto que contiene los datos de la persona propietaria de la cuenta. <br /> <br /><b>Nota: </b> si se incluye este atributo, entonces el objeto <b>\"institution\"</b> no debe estar presente.
+    attr_accessor :person
+
+    # Es la fecha en la que se registró el beneficiario. Ésta fecha viene en formato ISO 8601 con zona horaria, ejemplo: <strong>2020-10-27T11:03:15.000-06:00</strong>.
+    attr_accessor :register_date
+
+    # 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
+
+    # Es el Registro Federal de Contribuyentes (RFC) de la persona o institución propietaria dela cuenta. <br/> <br/><b>Nota:</b> Si en la respuesta de Monex esta propiedad es nula, tampoco estará presente en esta respuesta.
+    attr_accessor :rfc
+
+    # Es el estado en el que se encuentra el registo del beneficiario.<br>Los valores pueden ser:<ul style=\"font-size: 12px; font-weight: 600;\"><li>RECEIVED</li><li>DELETED</li><li>REQUEST_ERROR_BY_MONEX</li><li>REQUESTED_TO_MONEX</li><li>NOTIFIED_BY_MONEX</li><li>NOTIFIED_BY_SPEIOK<li></li>NOTIFIED_WITH_ERROR_BY_SPEIOK</li><li>PENDING</li></ul>
+    attr_accessor :status
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'amount_limit' => :'amount_limit',
+        :'bank' => :'bank',
+        :'beneficiary_account' => :'beneficiary_account',
+        :'currency_code' => :'currency_code',
+        :'email' => :'email',
+        :'institution' => :'institution',
+        :'kind_of_relationship' => :'kind_of_relationship',
+        :'numeric_reference_spei' => :'numeric_reference_spei',
+        :'payment_concept_spei' => :'payment_concept_spei',
+        :'person' => :'person',
+        :'register_date' => :'register_date',
+        :'relationship' => :'relationship',
+        :'rfc' => :'rfc',
+        :'status' => :'status'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'amount_limit' => :'Float',
+        :'bank' => :'Institution',
+        :'beneficiary_account' => :'String',
+        :'currency_code' => :'String',
+        :'email' => :'Array<String>',
+        :'institution' => :'BeneficiaryInstitution',
+        :'kind_of_relationship' => :'String',
+        :'numeric_reference_spei' => :'String',
+        :'payment_concept_spei' => :'String',
+        :'person' => :'Person',
+        :'register_date' => :'DateTime',
+        :'relationship' => :'String',
+        :'rfc' => :'String',
+        :'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_limit')
+        self.amount_limit = attributes[:'amount_limit']
+      end
+
+      if attributes.has_key?(:'bank')
+        self.bank = attributes[:'bank']
+      end
+
+      if attributes.has_key?(:'beneficiary_account')
+        self.beneficiary_account = attributes[:'beneficiary_account']
+      end
+
+      if attributes.has_key?(:'currency_code')
+        self.currency_code = attributes[:'currency_code']
+      end
+
+      if attributes.has_key?(:'email')
+        if (value = attributes[:'email']).is_a?(Array)
+          self.email = value
+        end
+      end
+
+      if attributes.has_key?(:'institution')
+        self.institution = attributes[:'institution']
+      end
+
+      if attributes.has_key?(:'kind_of_relationship')
+        self.kind_of_relationship = attributes[:'kind_of_relationship']
+      end
+
+      if attributes.has_key?(:'numeric_reference_spei')
+        self.numeric_reference_spei = attributes[:'numeric_reference_spei']
+      end
+
+      if attributes.has_key?(:'payment_concept_spei')
+        self.payment_concept_spei = attributes[:'payment_concept_spei']
+      end
+
+      if attributes.has_key?(:'person')
+        self.person = attributes[:'person']
+      end
+
+      if attributes.has_key?(:'register_date')
+        self.register_date = attributes[:'register_date']
+      end
+
+      if attributes.has_key?(:'relationship')
+        self.relationship = attributes[:'relationship']
+      end
+
+      if attributes.has_key?(:'rfc')
+        self.rfc = attributes[:'rfc']
+      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
+      if @amount_limit.nil?
+        invalid_properties.push('invalid value for "amount_limit", amount_limit cannot be nil.')
+      end
+
+      if @beneficiary_account.nil?
+        invalid_properties.push('invalid value for "beneficiary_account", beneficiary_account cannot be nil.')
+      end
+
+      if @kind_of_relationship.nil?
+        invalid_properties.push('invalid value for "kind_of_relationship", kind_of_relationship cannot be nil.')
+      end
+
+      if !@numeric_reference_spei.nil? && @numeric_reference_spei.to_s.length > 7
+        invalid_properties.push('invalid value for "numeric_reference_spei", the character length must be smaller than or equal to 7.')
+      end
+
+      if !@numeric_reference_spei.nil? && @numeric_reference_spei.to_s.length < 1
+        invalid_properties.push('invalid value for "numeric_reference_spei", the character length must be great than or equal to 1.')
+      end
+
+      if !@numeric_reference_spei.nil? && @numeric_reference_spei !~ Regexp.new(/[0-9][0-9]*/)
+        invalid_properties.push('invalid value for "numeric_reference_spei", must conform to the pattern /[0-9][0-9]*/.')
+      end
+
+      if @relationship.nil?
+        invalid_properties.push('invalid value for "relationship", relationship cannot be nil.')
+      end
+
+      if @rfc.nil?
+        invalid_properties.push('invalid value for "rfc", rfc 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 @amount_limit.nil?
+      return false if @beneficiary_account.nil?
+      return false if @kind_of_relationship.nil?
+      return false if !@numeric_reference_spei.nil? && @numeric_reference_spei.to_s.length > 7
+      return false if !@numeric_reference_spei.nil? && @numeric_reference_spei.to_s.length < 1
+      return false if !@numeric_reference_spei.nil? && @numeric_reference_spei !~ Regexp.new(/[0-9][0-9]*/)
+      return false if @relationship.nil?
+      return false if @rfc.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] numeric_reference_spei Value to be assigned
+    def numeric_reference_spei=(numeric_reference_spei)
+      if !numeric_reference_spei.nil? && numeric_reference_spei.to_s.length > 7
+        fail ArgumentError, 'invalid value for "numeric_reference_spei", the character length must be smaller than or equal to 7.'
+      end
+
+      if !numeric_reference_spei.nil? && numeric_reference_spei.to_s.length < 1
+        fail ArgumentError, 'invalid value for "numeric_reference_spei", the character length must be great than or equal to 1.'
+      end
+
+      if !numeric_reference_spei.nil? && numeric_reference_spei !~ Regexp.new(/[0-9][0-9]*/)
+        fail ArgumentError, 'invalid value for "numeric_reference_spei", must conform to the pattern /[0-9][0-9]*/.'
+      end
+
+      @numeric_reference_spei = numeric_reference_spei
+    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 &&
+          bank == o.bank &&
+          beneficiary_account == o.beneficiary_account &&
+          currency_code == o.currency_code &&
+          email == o.email &&
+          institution == o.institution &&
+          kind_of_relationship == o.kind_of_relationship &&
+          numeric_reference_spei == o.numeric_reference_spei &&
+          payment_concept_spei == o.payment_concept_spei &&
+          person == o.person &&
+          register_date == o.register_date &&
+          relationship == o.relationship &&
+          rfc == o.rfc &&
+          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_limit, bank, beneficiary_account, currency_code, email, institution, kind_of_relationship, numeric_reference_spei, payment_concept_spei, person, register_date, relationship, rfc, 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/account_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
 
@@ -15,13 +15,13 @@ require 'date'
 module Wire4Client
   # Objeto request para guardar la cuenta del beneficiario
   class AccountRequest
-    # Lista de cuentas del beneficiario que serán registradas
+    # Lista de cuentas de beneficiario que serán registradas.
     attr_accessor :accounts
 
-    # Url a la que se redirigira en caso de que el cliente cancele el registro
+    # Es la dirección URL a la que se redirigirá en caso de que el cliente cancele el registro.
     attr_accessor :cancel_return_url
 
-    # Url a la que se redireccionara en caso exitoso
+    # Es la dirección URL a la que se redirigirá en caso exitoso.
     attr_accessor :return_url
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/wire4_client/models/account_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,41 +13,47 @@ Swagger Codegen version: 2.4.10
 require 'date'
 
 module Wire4Client
-  # Objeto que contiene información de la cuenta
+  # Objeto que contiene información de la cuenta.
   class AccountResponse
-    # Monto límite permitido registrado para la cuenta
+    # Es el monto límite permitido que se registra para la cuenta. Por ejemplo 1000.00.
     attr_accessor :amount_limit
 
-    # El banco al cual pertenece la cuenta
+    # Es el banco al cuál pertenece la cuenta.
     attr_accessor :bank
 
-    # Cuenta del beneficiario, podría ser teléfono celular, TDD o cuenta CLABE
+    # Es la cuenta del beneficiario, podría ser teléfono celular (se valida que sea de 10 dígitos), Tarjeta de débito (TDD, se valida que sea de 16 dígitos) o cuenta CLABE (se valida que sea de 18 dígitos). <br/><br/>Por ejemplo Teléfono celular: 5525072600, TDD: 4323 1234 5678 9123, CLABE: 032180000118359719.
     attr_accessor :beneficiary_account
 
-    # Lista de email's, este dato es opcional
+    # Es una lista de correos electrónicos (emails). Se valida el formato de email. Este campo es opcional.
     attr_accessor :email
 
-    # Objeto que contiene el nombre de la institución, es mutuamente exclusivo con el objeto Person
+    # Es el objeto que contiene el nombre de la institución, es mutuamente exclusivo con el objeto Person.
     attr_accessor :institution
 
-    # Tipo de relación con el propietario de la cuenta, para registrar una cuenta este valor se debe obtener  del recurso 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 a utilizar cuando se realice una transferencia y no se especifique una referencia
+    # Es la referencia numérica a utilizar cuando se realice una transferencia y no se especifique una referencia.
     attr_accessor :numeric_reference_spei
 
-    # Concepto de pago a utilizar cuando se realice una transferencia y no se especifique un concepto
+    # Es el concepto de pago a utilizar cuando se realice una transferencia y no se especifique un concepto
     attr_accessor :payment_concept_spei
 
-    # Objeto que contiene los datos de la persona propietaria de la cuenta, si se incluye este atributo, el atributo institution no debe estar presente
+    # Es el objeto que contiene los datos de la persona propietaria de la cuenta. <br /> <br /><b>Nota: </b> si se incluye este atributo, entonces el objeto <b>\"institution\"</b> no debe estar presente.
     attr_accessor :person
 
-    # Relación con el propietario de la cuenta, para registrar una cuenta este valor se debe obtener  del recurso relationships
+    # Es la fecha en la que se registró el beneficiario. Ésta fecha viene en formato ISO 8601 con zona horaria, ejemplo: <strong>2020-10-27T11:03:15.000-06:00</strong>.
+    attr_accessor :register_date
+
+    # 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 de la persona o institución propietaria de la cuenta
+    # Es el Registro Federal de Contribuyentes (RFC) de la persona o institución propietaria dela cuenta. <br/> <br/><b>Nota:</b> Si en la respuesta de Monex esta propiedad es nula, tampoco estará presente en esta respuesta.
     attr_accessor :rfc
 
+    # Es el estado en el que se encuentra el registo del beneficiario.<br>Los valores pueden ser:<ul style=\"font-size: 12px; font-weight: 600;\"><li>RECEIVED</li><li>DELETED</li><li>REQUEST_ERROR_BY_MONEX</li><li>REQUESTED_TO_MONEX</li><li>NOTIFIED_BY_MONEX</li><li>NOTIFIED_BY_SPEIOK<li></li>NOTIFIED_WITH_ERROR_BY_SPEIOK</li><li>PENDING</li></ul>
+    attr_accessor :status
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -60,8 +66,10 @@ module Wire4Client
         :'numeric_reference_spei' => :'numeric_reference_spei',
         :'payment_concept_spei' => :'payment_concept_spei',
         :'person' => :'person',
+        :'register_date' => :'register_date',
         :'relationship' => :'relationship',
-        :'rfc' => :'rfc'
+        :'rfc' => :'rfc',
+        :'status' => :'status'
       }
     end
 
@@ -77,8 +85,10 @@ module Wire4Client
         :'numeric_reference_spei' => :'String',
         :'payment_concept_spei' => :'String',
         :'person' => :'Person',
+        :'register_date' => :'DateTime',
         :'relationship' => :'String',
-        :'rfc' => :'String'
+        :'rfc' => :'String',
+        :'status' => :'String'
       }
     end
 
@@ -128,6 +138,10 @@ module Wire4Client
         self.person = attributes[:'person']
       end
 
+      if attributes.has_key?(:'register_date')
+        self.register_date = attributes[:'register_date']
+      end
+
       if attributes.has_key?(:'relationship')
         self.relationship = attributes[:'relationship']
       end
@@ -135,6 +149,10 @@ module Wire4Client
       if attributes.has_key?(:'rfc')
         self.rfc = attributes[:'rfc']
       end
+
+      if attributes.has_key?(:'status')
+        self.status = attributes[:'status']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -222,8 +240,10 @@ module Wire4Client
           numeric_reference_spei == o.numeric_reference_spei &&
           payment_concept_spei == o.payment_concept_spei &&
           person == o.person &&
+          register_date == o.register_date &&
           relationship == o.relationship &&
-          rfc == o.rfc
+          rfc == o.rfc &&
+          status == o.status
     end
 
     # @see the `==` method
@@ -235,7 +255,7 @@ module Wire4Client
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [amount_limit, bank, beneficiary_account, email, institution, kind_of_relationship, numeric_reference_spei, payment_concept_spei, person, relationship, rfc].hash
+      [amount_limit, bank, beneficiary_account, email, institution, kind_of_relationship, numeric_reference_spei, payment_concept_spei, person, register_date, relationship, rfc, status].hash
     end
 
     # Builds the object from hash