wire4_client 0.0.1.pre.SNAPSHOT → 1.1.0

data/lib/wire4_client/models/deposit.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,64 +14,67 @@ require 'date'
 
 module Wire4Client
   class Deposit
-    # Monto de la transferencia
+    # Es el monto de la transferencia.
     attr_accessor :amount
 
-    # La cuenta del beneficiario
+    # Es la cuenta del beneficiario.
     attr_accessor :beneficiary_account
 
-    # El nombre del beneficiario
+    # Es el nombre del beneficiario.
     attr_accessor :beneficiary_name
 
-    # El RFC del beneficiario
+    # Es el Registro Federal de Contribuyentes (RFC) del beneficiario.
     attr_accessor :beneficiary_rfc
 
-    # La clave de rastreo de la transferencia
+    # Es el Comprobante Electrónico de Pago (CEP) emitido por Banxico que pertenece a la transferencia. Se informa sólo en caso de que esté disponible en banxico, posteriomente podrá usar la  <a href=\"#operation/obtainTransactionCepUsingPOST\">Consulta de CEP</a> que ésta misma API ofrece.
+    attr_accessor :cep
+
+    # Es la clave de rastreo de la transferencia.
     attr_accessor :clave_rastreo
 
-    # Fecha de confirmación del deposito
+    # Es la fecha de confirmación del deposito. É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, por ejemplo para el peso mexicano: <b>MXP</b>, para el dólar estadounidense: <b>USD</b>.
     attr_accessor :currency_code
 
-    # Fecha del deposito
+    # Es la fecha del deposito.  Ésta fecha viene en formato ISO 8601 con zona horaria, ejemplo: <strong>2020-10-27T11:03:15.000-06:00</strong>.
     attr_accessor :deposit_date
 
-    # Depositante
+    # Es el depositante.
     attr_accessor :depositant
 
-    # Cuenta CLABE interbancaria del depositante
+    # Es la Cuenta CLABE interbancaria (de 18 dígitos) del depositante.
     attr_accessor :depositant_clabe
 
-    # Email del depositante
+    # Es el correo electrónico (email) del depositante.
     attr_accessor :depositant_email
 
-    # RFC del depositante
+    # Es el Registro Federal de Contribuyentes (RFC) del depositante.
     attr_accessor :depositant_rfc
 
-    # Descripción del traspaso
+    # Es la descripción del traspaso.
     attr_accessor :description
 
-    # Descripción directa de Monex
+    # Es la descripción directa de Monex.
     attr_accessor :monex_description
 
-    # Identificador de la transferencia en Monex
+    # es el identificador de la transferencia en Monex.
     attr_accessor :monex_transaction_id
 
-    # La referencia del depósito
+    # Es la referencia del depósito.
     attr_accessor :reference
 
-    # La cuenta del ordenante
+    # Es la cuenta del ordenante.
     attr_accessor :sender_account
 
-    # El banco del ordenante
+    # Es el banco del ordenante.
     attr_accessor :sender_bank
 
-    # El nombre del ordenante
+    # Es el nombre del ordenante.
     attr_accessor :sender_name
 
-    # El RFC del ordenante
+    # Es el Registro Federal de Contribuyentes (RFC) de la cuenta ordenante.
     attr_accessor :sender_rfc
 
     # Attribute mapping from ruby-style variable name to JSON key.
@@ -81,6 +84,7 @@ module Wire4Client
         :'beneficiary_account' => :'beneficiary_account',
         :'beneficiary_name' => :'beneficiary_name',
         :'beneficiary_rfc' => :'beneficiary_rfc',
+        :'cep' => :'cep',
         :'clave_rastreo' => :'clave_rastreo',
         :'confirm_date' => :'confirm_date',
         :'currency_code' => :'currency_code',
@@ -107,6 +111,7 @@ module Wire4Client
         :'beneficiary_account' => :'String',
         :'beneficiary_name' => :'String',
         :'beneficiary_rfc' => :'String',
+        :'cep' => :'MessageCEP',
         :'clave_rastreo' => :'String',
         :'confirm_date' => :'DateTime',
         :'currency_code' => :'String',
@@ -150,6 +155,10 @@ module Wire4Client
         self.beneficiary_rfc = attributes[:'beneficiary_rfc']
       end
 
+      if attributes.has_key?(:'cep')
+        self.cep = attributes[:'cep']
+      end
+
       if attributes.has_key?(:'clave_rastreo')
         self.clave_rastreo = attributes[:'clave_rastreo']
       end
@@ -237,6 +246,7 @@ module Wire4Client
           beneficiary_account == o.beneficiary_account &&
           beneficiary_name == o.beneficiary_name &&
           beneficiary_rfc == o.beneficiary_rfc &&
+          cep == o.cep &&
           clave_rastreo == o.clave_rastreo &&
           confirm_date == o.confirm_date &&
           currency_code == o.currency_code &&
@@ -264,7 +274,7 @@ module Wire4Client
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [amount, beneficiary_account, beneficiary_name, beneficiary_rfc, clave_rastreo, confirm_date, currency_code, deposit_date, depositant, depositant_clabe, depositant_email, depositant_rfc, description, monex_description, monex_transaction_id, reference, sender_account, sender_bank, sender_name, sender_rfc].hash
+      [amount, beneficiary_account, beneficiary_name, beneficiary_rfc, cep, clave_rastreo, confirm_date, currency_code, deposit_date, depositant, depositant_clabe, depositant_email, depositant_rfc, description, monex_description, monex_transaction_id, reference, sender_account, sender_bank, sender_name, sender_rfc].hash
     end
 
     # Builds the object from hash

data/lib/wire4_client/models/deposit_authorization_request.rb

@@ -0,0 +1,205 @@
+=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
+  # Contiene la información de la autorización de depósitos
+  class DepositAuthorizationRequest
+    # Indica sí se aplica la autorización de depósitos.
+    attr_accessor :enabled
+
+    # La información del WebHook de autorización de depósitos.
+    attr_accessor :webhook
+
+    # Identificador del webhook.
+    attr_accessor :wh_uuid
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'enabled' => :'enabled',
+        :'webhook' => :'webhook',
+        :'wh_uuid' => :'wh_uuid'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'enabled' => :'BOOLEAN',
+        :'webhook' => :'WebHookDepositAuthorizationRequest',
+        :'wh_uuid' => :'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?(:'enabled')
+        self.enabled = attributes[:'enabled']
+      end
+
+      if attributes.has_key?(:'webhook')
+        self.webhook = attributes[:'webhook']
+      end
+
+      if attributes.has_key?(:'wh_uuid')
+        self.wh_uuid = attributes[:'wh_uuid']
+      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 &&
+          enabled == o.enabled &&
+          webhook == o.webhook &&
+          wh_uuid == o.wh_uuid
+    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
+      [enabled, webhook, wh_uuid].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/depositant.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,19 +15,19 @@ require 'date'
 module Wire4Client
   # Objeto que contiene los datos del depositante
   class Depositant
-    # Alias del depositante
+    # Es el alias del depositante.
     attr_accessor :_alias
 
-    # Código de moneda con el que operará el depositante
+    # Es el código de divisa que opera el depositante. Es en el formato estándar de 3 dígitos. Sólo se permiten los valores <b>MXP</b> y <b>USD</b>.
     attr_accessor :currency_code
 
-    # Cuenta clabe del depositante
+    # Es la cuenta CLABE (es de 18 dígitos) del depositante.
     attr_accessor :depositant_clabe
 
-    # Lista de emails del depositante
+    # Es la lista de correos electrónicos (emails) del depositante.
     attr_accessor :email
 
-    # Nombre del depositante
+    # Es el nombre del depositante.
     attr_accessor :name
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/wire4_client/models/depositants_register.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,16 +14,16 @@ require 'date'
 
 module Wire4Client
   class DepositantsRegister
-    # Alias del depositante
+    # Es el alias del depositante. Se valida hasta 80 caracteres.
     attr_accessor :_alias
 
-    # Codigo de la moneda en que operará el depositante, los valores validos son MXP y USD
+    # Es el código de divisa en que operará el depositante. Es en el formato estándar de 3 dígitos.  Sólo se permiten los valores <b>MXP</b> y <b>USD</b>.
     attr_accessor :currency_code
 
-    # Lista de email del depositante
+    # Es la lista de correos electrónicos (emails) del depositante. <br><br><b>Ejemplo</b>: mi_correo@correo.com,mi_correo@correo.com...
     attr_accessor :email
 
-    # Nombre del depositante
+    # Es el nombre del depositante. Se valida hasta 120 caracteres.
     attr_accessor :name
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/wire4_client/models/depositants_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 DepositantsResponse
-    # Cuenta clabe del depositante
+    # Cuenta CLABE (es de 18 dígitos) del depositante.
     attr_accessor :clabe
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/wire4_client/models/deposits_authorization_response.rb

@@ -0,0 +1,205 @@
+=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
+  # Contiene la información de la autorización de depósitos
+  class DepositsAuthorizationResponse
+    # Indica sí se aplica autorización de depósitos.
+    attr_accessor :enabled
+
+    # Indica sí es posible modificar o no la autorización, ésto depende si otra aplicación tiene el control sobre la autorización de depósitos.
+    attr_accessor :read_only
+
+    # Es la información del webHook de autorización de depósitos.
+    attr_accessor :webhook
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'enabled' => :'enabled',
+        :'read_only' => :'read_only',
+        :'webhook' => :'webhook'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'enabled' => :'BOOLEAN',
+        :'read_only' => :'BOOLEAN',
+        :'webhook' => :'WebHookDepositAuthorizationResponse'
+      }
+    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?(:'enabled')
+        self.enabled = attributes[:'enabled']
+      end
+
+      if attributes.has_key?(:'read_only')
+        self.read_only = attributes[:'read_only']
+      end
+
+      if attributes.has_key?(:'webhook')
+        self.webhook = attributes[:'webhook']
+      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 &&
+          enabled == o.enabled &&
+          read_only == o.read_only &&
+          webhook == o.webhook
+    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
+      [enabled, read_only, webhook].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