ecf-dgii 1.0.2

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

@@ -0,0 +1,185 @@
+=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
+  # Respuesta de anulación de rango de secuencias de e-NCF.  Representa la respuesta del servicio de anulación de rangos de secuencias de comprobantes fiscales electrónicos. Este modelo se utiliza para procesar la respuesta del servicio web de anulación de e-NCF de la DGII.  Servicio Web:• Endpoint: /api/operaciones/anularrango• Método: POST• Formato de entrada: XML (formato ANECF)• Formato de respuesta: JSON o XMLValidaciones del Servicio:• Tipo de archivo válido (XML)• Firma del documento válida• Tipo de comprobante válido• Secuencias no utilizadas previamente• RNC autorizado para realizar transaccionesReferencia Oficial:• Descripción Técnica de Facturación Electrónica v1.6, Sección \"Anulación de e-NCF\"• Formato Anulación de e-NCF v1.0 - DGII
+  class RespuestaAnulacionRango < ApiModelBase
+    # Número de Registro Nacional del Contribuyente que envió la anulación.  Corresponde al RNC del contribuyente que solicitó la anulación de las secuencias. Este valor debe coincidir con el RNC autorizado para realizar transacciones de anulación y debe estar registrado como Facturador Electrónico en la DGII.
+    attr_accessor :rnc
+
+    # Código asociado al resultado de la validación de la anulación.  Indica el código de estado del resultado de la operación de anulación. Los códigos proporcionan información sobre el éxito o fallo de la operación y los motivos específicos cuando hay errores.
+    attr_accessor :codigo
+
+    # Razón social del contribuyente que realizó la anulación.  Nombre o razón social del contribuyente asociado al RNC que solicitó la anulación. Este campo proporciona información adicional para identificación del contribuyente y corresponde al nombre registrado en la DGII.
+    attr_accessor :nombre
+
+    # Mensajes asociados al resultado de la validación de la anulación.  Array de mensajes que proporcionan información detallada sobre el resultado de la operación. Puede incluir mensajes de éxito, advertencias, o errores específicos que ocurrieron durante el proceso de validación y anulación de las secuencias.
+    attr_accessor :mensajes
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'rnc' => :'rnc',
+        :'codigo' => :'codigo',
+        :'nombre' => :'nombre',
+        :'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',
+        :'codigo' => :'String',
+        :'nombre' => :'String',
+        :'mensajes' => :'Array<String>'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'rnc',
+        :'codigo',
+        :'nombre',
+        :'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::RespuestaAnulacionRango` 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::RespuestaAnulacionRango`. 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?(:'codigo')
+        self.codigo = attributes[:'codigo']
+      end
+
+      if attributes.key?(:'nombre')
+        self.nombre = attributes[:'nombre']
+      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 &&
+          codigo == o.codigo &&
+          nombre == o.nombre &&
+          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, codigo, nombre, 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_estado.rb

@@ -0,0 +1,256 @@
+=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 estado de e-CF. Este modelo contiene la información de validez y estado de un comprobante fiscal electrónico consultado a través del servicio web de consulta estado de la DGII.
+  class RespuestaConsultaEstado < ApiModelBase
+    attr_accessor :codigo
+
+    # Estado de validación otorgado por Impuestos Internos al e-CF recibido. Descripción textual del estado del comprobante fiscal electrónico.
+    attr_accessor :estado
+
+    # Número de registro nacional del contribuyente que envió el e-CF. RNC del emisor del comprobante fiscal electrónico.
+    attr_accessor :rnc_emisor
+
+    # Número de secuencia utilizada por el contribuyente en el e-CF. Número de comprobante fiscal electrónico (e-NCF) utilizado en la transacción.
+    attr_accessor :ncf_electronico
+
+    attr_accessor :monto_total
+
+    attr_accessor :total_itbis
+
+    # Fecha de emisión extraída del e-CF recibido. Fecha en que fue emitido el comprobante fiscal electrónico.
+    attr_accessor :fecha_emision
+
+    # Fecha de firma extraída del e-CF recibido. Fecha en que fue firmado digitalmente el comprobante fiscal electrónico.
+    attr_accessor :fecha_firma
+
+    # RNC del comprador extraído del e-CF recibido (si aplica). Número de registro nacional del contribuyente comprador, cuando corresponde.
+    attr_accessor :rnc_comprador
+
+    # Código de seguridad extraído de los primeros seis (6) dígitos del hash generado  en el SignatureValue de la firma digital del e-CF recibido. Código de seguridad de 6 caracteres para validación del comprobante.
+    attr_accessor :codigo_seguridad
+
+    # Identificación de extranjero extraída del e-CF recibido (si aplica). Número de identificación del comprador extranjero cuando corresponde.
+    attr_accessor :id_extranjero
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'codigo' => :'codigo',
+        :'estado' => :'estado',
+        :'rnc_emisor' => :'rncEmisor',
+        :'ncf_electronico' => :'ncfElectronico',
+        :'monto_total' => :'montoTotal',
+        :'total_itbis' => :'totalITBIS',
+        :'fecha_emision' => :'fechaEmision',
+        :'fecha_firma' => :'fechaFirma',
+        :'rnc_comprador' => :'rncComprador',
+        :'codigo_seguridad' => :'codigoSeguridad',
+        :'id_extranjero' => :'idExtranjero'
+      }
+    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
+      {
+        :'codigo' => :'SearchEcfReceptionRequestsTiposEcfsParameterInner',
+        :'estado' => :'String',
+        :'rnc_emisor' => :'String',
+        :'ncf_electronico' => :'String',
+        :'monto_total' => :'RespuestaConsultaEstadoMontoTotal',
+        :'total_itbis' => :'RespuestaConsultaEstadoMontoTotal',
+        :'fecha_emision' => :'String',
+        :'fecha_firma' => :'String',
+        :'rnc_comprador' => :'String',
+        :'codigo_seguridad' => :'String',
+        :'id_extranjero' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'estado',
+        :'rnc_emisor',
+        :'ncf_electronico',
+        :'monto_total',
+        :'total_itbis',
+        :'fecha_emision',
+        :'fecha_firma',
+        :'rnc_comprador',
+        :'codigo_seguridad',
+        :'id_extranjero'
+      ])
+    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::RespuestaConsultaEstado` 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::RespuestaConsultaEstado`. 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?(:'codigo')
+        self.codigo = attributes[:'codigo']
+      end
+
+      if attributes.key?(:'estado')
+        self.estado = attributes[:'estado']
+      end
+
+      if attributes.key?(:'rnc_emisor')
+        self.rnc_emisor = attributes[:'rnc_emisor']
+      end
+
+      if attributes.key?(:'ncf_electronico')
+        self.ncf_electronico = attributes[:'ncf_electronico']
+      end
+
+      if attributes.key?(:'monto_total')
+        self.monto_total = attributes[:'monto_total']
+      end
+
+      if attributes.key?(:'total_itbis')
+        self.total_itbis = attributes[:'total_itbis']
+      end
+
+      if attributes.key?(:'fecha_emision')
+        self.fecha_emision = attributes[:'fecha_emision']
+      end
+
+      if attributes.key?(:'fecha_firma')
+        self.fecha_firma = attributes[:'fecha_firma']
+      end
+
+      if attributes.key?(:'rnc_comprador')
+        self.rnc_comprador = attributes[:'rnc_comprador']
+      end
+
+      if attributes.key?(:'codigo_seguridad')
+        self.codigo_seguridad = attributes[:'codigo_seguridad']
+      end
+
+      if attributes.key?(:'id_extranjero')
+        self.id_extranjero = attributes[:'id_extranjero']
+      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 &&
+          codigo == o.codigo &&
+          estado == o.estado &&
+          rnc_emisor == o.rnc_emisor &&
+          ncf_electronico == o.ncf_electronico &&
+          monto_total == o.monto_total &&
+          total_itbis == o.total_itbis &&
+          fecha_emision == o.fecha_emision &&
+          fecha_firma == o.fecha_firma &&
+          rnc_comprador == o.rnc_comprador &&
+          codigo_seguridad == o.codigo_seguridad &&
+          id_extranjero == o.id_extranjero
+    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
+      [codigo, estado, rnc_emisor, ncf_electronico, monto_total, total_itbis, fecha_emision, fecha_firma, rnc_comprador, codigo_seguridad, id_extranjero].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_estado_monto_total.rb

@@ -0,0 +1,104 @@
+=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
+  # Monto total extraído del e-CF recibido. Valor total de la transacción en pesos dominicanos.
+  module RespuestaConsultaEstadoMontoTotal
+    class << self
+      # List of class defined in anyOf (OpenAPI v3)
+      def openapi_any_of
+        [
+          :'Float',
+          :'String'
+        ]
+      end
+
+      # Builds the object
+      # @param [Mixed] Data to be matched against the list of anyOf items
+      # @return [Object] Returns the model or the data itself
+      def build(data)
+        # Go through the list of anyOf items and attempt to identify the appropriate one.
+        # Note:
+        # - No advanced validation of types in some cases (e.g. "x: { type: string }" will happily match { x: 123 })
+        #   due to the way the deserialization is made in the base_object template (it just casts without verifying).
+        # - TODO: scalar values are de facto behaving as if they were nullable.
+        # - TODO: logging when debugging is set.
+        openapi_any_of.each do |klass|
+          begin
+            next if klass == :AnyType # "nullable: true"
+            return find_and_cast_into_type(klass, data)
+          rescue # rescue all errors so we keep iterating even if the current item lookup raises
+          end
+        end
+
+        openapi_any_of.include?(:AnyType) ? data : nil
+      end
+
+      private
+
+      SchemaMismatchError = Class.new(StandardError)
+
+      # Note: 'File' is missing here because in the regular case we get the data _after_ a call to JSON.parse.
+      def find_and_cast_into_type(klass, data)
+        return if data.nil?
+
+        case klass.to_s
+        when 'Boolean'
+          return data if data.instance_of?(TrueClass) || data.instance_of?(FalseClass)
+        when 'Float'
+          return data if data.instance_of?(Float)
+        when 'Integer'
+          return data if data.instance_of?(Integer)
+        when 'Time'
+          return Time.parse(data)
+        when 'Date'
+          return Date.iso8601(data)
+        when 'String'
+          return data if data.instance_of?(String)
+        when 'Object' # "type: object"
+          return data if data.instance_of?(Hash)
+        when /\AArray<(?<sub_type>.+)>\z/ # "type: array"
+          if data.instance_of?(Array)
+            sub_type = Regexp.last_match[:sub_type]
+            return data.map { |item| find_and_cast_into_type(sub_type, item) }
+          end
+        when /\AHash<String, (?<sub_type>.+)>\z/ # "type: object" with "additionalProperties: { ... }"
+          if data.instance_of?(Hash) && data.keys.all? { |k| k.instance_of?(Symbol) || k.instance_of?(String) }
+            sub_type = Regexp.last_match[:sub_type]
+            return data.each_with_object({}) { |(k, v), hsh| hsh[k] = find_and_cast_into_type(sub_type, v) }
+          end
+        else # model
+          const = EcfDgii::Generated.const_get(klass)
+          if const
+            if const.respond_to?(:openapi_any_of) # nested anyOf model
+              model = const.build(data)
+              return model if model
+            else
+              # raise if data contains keys that are not known to the model
+              raise if const.respond_to?(:acceptable_attributes) && !(data.keys - const.acceptable_attributes).empty?
+              model = const.build_from_hash(data)
+              return model if model
+            end
+          end
+        end
+
+        raise # if no match by now, raise
+      rescue
+        raise SchemaMismatchError, "#{data} doesn't match the #{klass} type"
+      end
+    end
+  end
+
+end