ecf-dgii 1.0.2

data/lib/ecf_dgii/generated/models/respuesta_consulta_rfce.rb

@@ -0,0 +1,205 @@
+=begin
+#ECF API
+
+#ECF API (Electronic Fiscal Receipt).
+
+The version of the OpenAPI document: v1
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.23.0
+
+=end
+
+require 'date'
+require 'time'
+
+module EcfDgii::Generated
+  # Representa la respuesta del servicio de Consulta de Resumen de Factura (RFCE) de la DGII. Este servicio permite validar la validez fiscal de un comprobante fiscal electrónico a través del RNC emisor, e-NCF y código de seguridad.
+  class RespuestaConsultaRFCE < ApiModelBase
+    # Número de registro nacional del contribuyente que envió el e-CF. RNC del emisor del comprobante fiscal electrónico consultado.
+    attr_accessor :rnc
+
+    # Número de secuencia utilizada por el contribuyente en el ENCF. Número de comprobante fiscal electrónico (e-NCF) consultado.
+    attr_accessor :encf
+
+    # Indica si el número de secuencia puede ser reutilizado. `true` si la secuencia NO puede reutilizarse (rechazado por motivos específicos);         `false` si la secuencia SÍ puede reutilizarse.
+    attr_accessor :secuencia_utilizada
+
+    # Código asociado al estado de validación del e-CF recibido. Código numérico que indica el resultado de la validación: - 0: No encontrado - 1: Aceptado - 2: Rechazado - 4: Aceptado Condicional (solo para FC &lt; RD$ 250000.00)
+    attr_accessor :codigo
+
+    # Estado de validación otorgado por Impuestos Internos al e-CF recibido. Descripción textual del estado de validación del comprobante.
+    attr_accessor :estado
+
+    # Mensajes y códigos asociados al estado de validación del e-CF recibido. Array de mensajes que proporcionan detalles adicionales sobre la validación.
+    attr_accessor :mensajes
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'rnc' => :'rnc',
+        :'encf' => :'encf',
+        :'secuencia_utilizada' => :'secuenciaUtilizada',
+        :'codigo' => :'codigo',
+        :'estado' => :'estado',
+        :'mensajes' => :'mensajes'
+      }
+    end
+
+    # Returns attribute mapping this model knows about
+    def self.acceptable_attribute_map
+      attribute_map
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      acceptable_attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'rnc' => :'String',
+        :'encf' => :'String',
+        :'secuencia_utilizada' => :'Boolean',
+        :'codigo' => :'String',
+        :'estado' => :'String',
+        :'mensajes' => :'Array<Mensaje>'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'rnc',
+        :'codigo',
+        :'estado',
+        :'mensajes'
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `EcfDgii::Generated::RespuestaConsultaRFCE` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      acceptable_attribute_map = self.class.acceptable_attribute_map
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!acceptable_attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `EcfDgii::Generated::RespuestaConsultaRFCE`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'rnc')
+        self.rnc = attributes[:'rnc']
+      end
+
+      if attributes.key?(:'encf')
+        self.encf = attributes[:'encf']
+      end
+
+      if attributes.key?(:'secuencia_utilizada')
+        self.secuencia_utilizada = attributes[:'secuencia_utilizada']
+      end
+
+      if attributes.key?(:'codigo')
+        self.codigo = attributes[:'codigo']
+      end
+
+      if attributes.key?(:'estado')
+        self.estado = attributes[:'estado']
+      end
+
+      if attributes.key?(:'mensajes')
+        if (value = attributes[:'mensajes']).is_a?(Array)
+          self.mensajes = value
+        end
+      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
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      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?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      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 &&
+          rnc == o.rnc &&
+          encf == o.encf &&
+          secuencia_utilizada == o.secuencia_utilizada &&
+          codigo == o.codigo &&
+          estado == o.estado &&
+          mensajes == o.mensajes
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [rnc, encf, secuencia_utilizada, codigo, estado, mensajes].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = nil
+        elsif type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
+      end
+      new(transformed_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)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+  end
+
+end

data/lib/ecf_dgii/generated/models/respuesta_consulta_timbre.rb

@@ -0,0 +1,183 @@
+=begin
+#ECF API
+
+#ECF API (Electronic Fiscal Receipt).
+
+The version of the OpenAPI document: v1
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.23.0
+
+=end
+
+require 'date'
+require 'time'
+
+module EcfDgii::Generated
+  # Representa la respuesta del servicio de Consulta Timbre Fiscal (QR) de la DGII. Este servicio permite validar la validez de un e-CF remitido exclusivamente por el servicio web de recepción de e-CF, a partir de los datos incluidos en el timbre de su representación impresa (RI).
+  class RespuestaConsultaTimbre < ApiModelBase
+    # Número de registro nacional del contribuyente que emitió el resumen de factura de consumo. RNC del emisor del comprobante fiscal electrónico consultado.
+    attr_accessor :rnc_emisor
+
+    # Razón social del contribuyente que emitió el resumen de factura de consumo. Nombre comercial o razón social del emisor del comprobante fiscal electrónico.
+    attr_accessor :razon_social
+
+    # Número de secuencia utilizada por el contribuyente, extraído del resumen de factura de consumo. Número de comprobante fiscal electrónico (e-NCF) utilizado en la transacción.
+    attr_accessor :encf
+
+    # Estado de validación otorgado por Impuestos Internos al resumen de factura de consumo recibido. Descripción textual del estado de validación del comprobante. Posibles valores: - \"No fue encontrada la factura (e-CF)\": El e-CF no se encontró en la base de datos de la DGII. - \"Aceptado\": Implica la validez del e-CF de la RI, incluyendo el aceptado condicional que corresponde   a que no cumplió en algún punto pero que no amerita el rechazo de este. - \"Rechazado\": Corresponde a que el e-CF de la RI le fue rechazado al emisor.
+    attr_accessor :estado
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'rnc_emisor' => :'rncEmisor',
+        :'razon_social' => :'razonSocial',
+        :'encf' => :'encf',
+        :'estado' => :'estado'
+      }
+    end
+
+    # Returns attribute mapping this model knows about
+    def self.acceptable_attribute_map
+      attribute_map
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      acceptable_attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'rnc_emisor' => :'String',
+        :'razon_social' => :'String',
+        :'encf' => :'String',
+        :'estado' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'rnc_emisor',
+        :'razon_social',
+        :'encf',
+        :'estado'
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `EcfDgii::Generated::RespuestaConsultaTimbre` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      acceptable_attribute_map = self.class.acceptable_attribute_map
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!acceptable_attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `EcfDgii::Generated::RespuestaConsultaTimbre`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'rnc_emisor')
+        self.rnc_emisor = attributes[:'rnc_emisor']
+      end
+
+      if attributes.key?(:'razon_social')
+        self.razon_social = attributes[:'razon_social']
+      end
+
+      if attributes.key?(:'encf')
+        self.encf = attributes[:'encf']
+      end
+
+      if attributes.key?(:'estado')
+        self.estado = attributes[:'estado']
+      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
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      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?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      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 &&
+          rnc_emisor == o.rnc_emisor &&
+          razon_social == o.razon_social &&
+          encf == o.encf &&
+          estado == o.estado
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [rnc_emisor, razon_social, encf, estado].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = nil
+        elsif type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
+      end
+      new(transformed_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)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+  end
+
+end

data/lib/ecf_dgii/generated/models/respuesta_consulta_track_id.rb

@@ -0,0 +1,228 @@
+=begin
+#ECF API
+
+#ECF API (Electronic Fiscal Receipt).
+
+The version of the OpenAPI document: v1
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.23.0
+
+=end
+
+require 'date'
+require 'time'
+
+module EcfDgii::Generated
+  # Representa la respuesta del servicio de consulta de resultado de comprobantes fiscales electrónicos (e-CF). Este modelo contiene la información completa sobre el estado de procesamiento y validación de un e-CF que fue enviado previamente mediante el servicio de recepción.
+  class RespuestaConsultaTrackId < ApiModelBase
+    # Obtiene el número único generado por Impuestos Internos para identificar un e-CF recibido. Este identificador se obtiene como respuesta del servicio de recepción de e-CF. El identificador único del track. Puede ser null si no está disponible.
+    attr_accessor :track_id
+
+    # Obtiene el código asociado al estado de validación del e-CF recibido. Un código que indica el resultado de la validación. Los valores típicos son: - \"0\": No encontrado - \"1\": Aceptado - \"2\": Rechazado - \"3\": En Proceso - \"4\": Aceptado Condicional
+    attr_accessor :codigo
+
+    # Obtiene el estado de validación otorgado por Impuestos Internos al e-CF recibido. Descripción textual del estado. Puede incluir valores como: - \"No encontrado\": No se encontró el trackid en los registros - \"Aceptado\": Implica la validez del e-CF - \"Rechazado\": Implica la nulidad del comprobante para fines tributarios - \"En Proceso\": El comprobante aún no ha sido validado - \"Aceptado Condicional\": El comprobante no cumplió en algún punto pero no ameritó el rechazo
+    attr_accessor :estado
+
+    # Obtiene el número de registro nacional del contribuyente que envió el e-CF. El RNC del emisor del comprobante. Puede ser null si no está disponible.
+    attr_accessor :rnc
+
+    # Obtiene el número de secuencia utilizada por el contribuyente en el e-CF. El número de comprobante fiscal electrónico (e-NCF). Puede ser null si no está disponible.
+    attr_accessor :encf
+
+    # Indica si el número de secuencia puede ser reutilizada en otro e-CF. True si la secuencia puede reutilizarse, False si no puede reutilizarse.  Este parámetro permite dar a conocer si el número de secuencia que fue recibido por Impuestos Internos puede reutilizarse en otro Comprobante Fiscal Electrónico (e-CF) en el escenario de que el resultado de la validación haya sido \"Rechazado\" por los siguientes motivos: - Certificado y/o firma inválida - Estructura del comprobante (XML) no es válida - Firmante del comprobante fiscal electrónico no corresponde a un delegado autorizado - El e-NCF no está autorizado para el RNC Emisor - El e-NCF autorizado se encuentra vencido - El RNC Emisor no corresponde a un emisor electrónico - El RNC Emisor no existe o no se encuentra activo
+    attr_accessor :secuencia_utilizada
+
+    # Obtiene la fecha en la cual Impuestos Internos recibió el e-CF. La fecha de recepción del comprobante. Puede ser null si no está disponible. El formato típico es ISO 8601 o un formato de fecha legible.
+    attr_accessor :fecha_recepcion
+
+    # Obtiene los mensajes asociados al estado de validación del e-CF recibido. Un array de mensajes que proporcionan información detallada sobre el estado de validación. Puede ser null si no hay mensajes disponibles.
+    attr_accessor :mensajes
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'track_id' => :'trackId',
+        :'codigo' => :'codigo',
+        :'estado' => :'estado',
+        :'rnc' => :'rnc',
+        :'encf' => :'encf',
+        :'secuencia_utilizada' => :'secuenciaUtilizada',
+        :'fecha_recepcion' => :'fechaRecepcion',
+        :'mensajes' => :'mensajes'
+      }
+    end
+
+    # Returns attribute mapping this model knows about
+    def self.acceptable_attribute_map
+      attribute_map
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      acceptable_attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'track_id' => :'String',
+        :'codigo' => :'String',
+        :'estado' => :'String',
+        :'rnc' => :'String',
+        :'encf' => :'String',
+        :'secuencia_utilizada' => :'Boolean',
+        :'fecha_recepcion' => :'String',
+        :'mensajes' => :'Array<Mensaje>'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'track_id',
+        :'codigo',
+        :'estado',
+        :'rnc',
+        :'encf',
+        :'fecha_recepcion',
+        :'mensajes'
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `EcfDgii::Generated::RespuestaConsultaTrackId` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      acceptable_attribute_map = self.class.acceptable_attribute_map
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!acceptable_attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `EcfDgii::Generated::RespuestaConsultaTrackId`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'track_id')
+        self.track_id = attributes[:'track_id']
+      end
+
+      if attributes.key?(:'codigo')
+        self.codigo = attributes[:'codigo']
+      end
+
+      if attributes.key?(:'estado')
+        self.estado = attributes[:'estado']
+      end
+
+      if attributes.key?(:'rnc')
+        self.rnc = attributes[:'rnc']
+      end
+
+      if attributes.key?(:'encf')
+        self.encf = attributes[:'encf']
+      end
+
+      if attributes.key?(:'secuencia_utilizada')
+        self.secuencia_utilizada = attributes[:'secuencia_utilizada']
+      end
+
+      if attributes.key?(:'fecha_recepcion')
+        self.fecha_recepcion = attributes[:'fecha_recepcion']
+      end
+
+      if attributes.key?(:'mensajes')
+        if (value = attributes[:'mensajes']).is_a?(Array)
+          self.mensajes = value
+        end
+      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
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      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?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      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 &&
+          track_id == o.track_id &&
+          codigo == o.codigo &&
+          estado == o.estado &&
+          rnc == o.rnc &&
+          encf == o.encf &&
+          secuencia_utilizada == o.secuencia_utilizada &&
+          fecha_recepcion == o.fecha_recepcion &&
+          mensajes == o.mensajes
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [track_id, codigo, estado, rnc, encf, secuencia_utilizada, fecha_recepcion, mensajes].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = nil
+        elsif type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
+      end
+      new(transformed_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)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+  end
+
+end