trevol 0.1.0

data/lib/trevol_generado/models/payroll_adjustment.rb

@@ -0,0 +1,467 @@
+=begin
+#API de Trevol
+
+#Trevol API. Documentación: https://platform.trevol.si/docs
+
+The version of the OpenAPI document: 2026-10-22
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.26.0
+
+=end
+
+require 'date'
+require 'time'
+
+module TrevolGenerado
+  # Una nota de ajuste de nómina electrónica (103: Reemplazar o Eliminar). Archivos `xml`, `zip` y `dian_response`.
+  class PayrollAdjustment < ApiModelBase
+    # pra_…
+    attr_accessor :id
+
+    # Valores conocidos: `payroll_adjustment`.
+    attr_accessor :object
+
+    # Valores conocidos: `test`, `live`.
+    attr_accessor :environment
+
+    # `validating`: el set de pruebas de la DIAN (habilitación) recibió la nómina y todavía la valida; no es un error, responde 202 en las dos versiones y Trevol solo consulta (nunca reenvía). `processing`: solo en la versión 2026-10-22, la DIAN no contestó y Trevol sigue resolviendo el documento. Valores conocidos: `pending`, `sending`, `validating`, `accepted`, `rejected`, `error`, `processing`.
+    attr_accessor :status
+
+    attr_accessor :number
+
+    attr_accessor :prefix
+
+    attr_accessor :external_id
+
+    # Valores conocidos: `api`, `app`.
+    attr_accessor :origin
+
+    # El código único de la nómina (CUNE, 96 hex).
+    attr_accessor :cune
+
+    attr_accessor :qr
+
+    attr_accessor :issued_at
+
+    # `sync`: SendNominaSync; `test_set`: el set de pruebas de habilitación. Valores conocidos: `sync`, `test_set`.
+    attr_accessor :submission
+
+    # Valores conocidos: `replace`, `delete`.
+    attr_accessor :type
+
+    attr_accessor :predecessor
+
+    attr_accessor :period
+
+    attr_accessor :pay_period
+
+    attr_accessor :currency
+
+    # Tasa de cambio a pesos. Obligatoria con una moneda distinta de COP y prohibida con COP.
+    attr_accessor :exchange_rate
+
+    attr_accessor :notes
+
+    attr_accessor :employee
+
+    attr_accessor :payment
+
+    attr_accessor :payment_dates
+
+    attr_accessor :earnings
+
+    attr_accessor :deductions
+
+    # Redondeo hasta 2.00; no suma a los totales.
+    attr_accessor :rounding
+
+    attr_accessor :generation_place
+
+    attr_accessor :employer
+
+    # Montos como texto decimal con 2 decimales. Null en un ajuste Eliminar.
+    attr_accessor :totals
+
+    attr_accessor :dian
+
+    # Qué archivos hay (…/xml, …/zip, …/dian_response). No hay PDF.
+    attr_accessor :files
+
+    attr_accessor :created_at
+
+    attr_accessor :updated_at
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'id' => :'id',
+        :'object' => :'object',
+        :'environment' => :'environment',
+        :'status' => :'status',
+        :'number' => :'number',
+        :'prefix' => :'prefix',
+        :'external_id' => :'external_id',
+        :'origin' => :'origin',
+        :'cune' => :'cune',
+        :'qr' => :'qr',
+        :'issued_at' => :'issued_at',
+        :'submission' => :'submission',
+        :'type' => :'type',
+        :'predecessor' => :'predecessor',
+        :'period' => :'period',
+        :'pay_period' => :'pay_period',
+        :'currency' => :'currency',
+        :'exchange_rate' => :'exchange_rate',
+        :'notes' => :'notes',
+        :'employee' => :'employee',
+        :'payment' => :'payment',
+        :'payment_dates' => :'payment_dates',
+        :'earnings' => :'earnings',
+        :'deductions' => :'deductions',
+        :'rounding' => :'rounding',
+        :'generation_place' => :'generation_place',
+        :'employer' => :'employer',
+        :'totals' => :'totals',
+        :'dian' => :'dian',
+        :'files' => :'files',
+        :'created_at' => :'created_at',
+        :'updated_at' => :'updated_at'
+      }
+    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
+      {
+        :'id' => :'String',
+        :'object' => :'String',
+        :'environment' => :'String',
+        :'status' => :'String',
+        :'number' => :'String',
+        :'prefix' => :'String',
+        :'external_id' => :'String',
+        :'origin' => :'String',
+        :'cune' => :'String',
+        :'qr' => :'String',
+        :'issued_at' => :'Time',
+        :'submission' => :'String',
+        :'type' => :'String',
+        :'predecessor' => :'PayrollReference',
+        :'period' => :'PayrollPeriod',
+        :'pay_period' => :'String',
+        :'currency' => :'String',
+        :'exchange_rate' => :'String',
+        :'notes' => :'Array<String>',
+        :'employee' => :'PayrollEmployee',
+        :'payment' => :'PayrollPayment',
+        :'payment_dates' => :'Array<Date>',
+        :'earnings' => :'PayrollEarnings',
+        :'deductions' => :'PayrollDeductions',
+        :'rounding' => :'String',
+        :'generation_place' => :'PayrollPlace',
+        :'employer' => :'PayrollEmployer',
+        :'totals' => :'PayrollTotals',
+        :'dian' => :'DianResult',
+        :'files' => :'PayrollFiles',
+        :'created_at' => :'Time',
+        :'updated_at' => :'Time'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'number',
+        :'prefix',
+        :'external_id',
+        :'cune',
+        :'qr',
+        :'issued_at',
+        :'submission',
+        :'type',
+        :'predecessor',
+        :'totals',
+        :'updated_at'
+      ])
+    end
+
+    # Returns attribute type mapping
+    def self.acceptable_openapi_types
+      openapi_types
+    end
+
+    # Returns the nullable attributes
+    def self.acceptable_openapi_nullable
+      openapi_nullable
+    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 `TrevolGenerado::PayrollAdjustment` 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 `TrevolGenerado::PayrollAdjustment`. 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?(:'id')
+        self.id = attributes[:'id']
+      end
+
+      if attributes.key?(:'object')
+        self.object = attributes[:'object']
+      end
+
+      if attributes.key?(:'environment')
+        self.environment = attributes[:'environment']
+      end
+
+      if attributes.key?(:'status')
+        self.status = attributes[:'status']
+      end
+
+      if attributes.key?(:'number')
+        self.number = attributes[:'number']
+      end
+
+      if attributes.key?(:'prefix')
+        self.prefix = attributes[:'prefix']
+      end
+
+      if attributes.key?(:'external_id')
+        self.external_id = attributes[:'external_id']
+      end
+
+      if attributes.key?(:'origin')
+        self.origin = attributes[:'origin']
+      end
+
+      if attributes.key?(:'cune')
+        self.cune = attributes[:'cune']
+      end
+
+      if attributes.key?(:'qr')
+        self.qr = attributes[:'qr']
+      end
+
+      if attributes.key?(:'issued_at')
+        self.issued_at = attributes[:'issued_at']
+      end
+
+      if attributes.key?(:'submission')
+        self.submission = attributes[:'submission']
+      end
+
+      if attributes.key?(:'type')
+        self.type = attributes[:'type']
+      end
+
+      if attributes.key?(:'predecessor')
+        self.predecessor = attributes[:'predecessor']
+      end
+
+      if attributes.key?(:'period')
+        self.period = attributes[:'period']
+      end
+
+      if attributes.key?(:'pay_period')
+        self.pay_period = attributes[:'pay_period']
+      end
+
+      if attributes.key?(:'currency')
+        self.currency = attributes[:'currency']
+      end
+
+      if attributes.key?(:'exchange_rate')
+        self.exchange_rate = attributes[:'exchange_rate']
+      end
+
+      if attributes.key?(:'notes')
+        if (value = attributes[:'notes']).is_a?(Array)
+          self.notes = value
+        end
+      end
+
+      if attributes.key?(:'employee')
+        self.employee = attributes[:'employee']
+      end
+
+      if attributes.key?(:'payment')
+        self.payment = attributes[:'payment']
+      end
+
+      if attributes.key?(:'payment_dates')
+        if (value = attributes[:'payment_dates']).is_a?(Array)
+          self.payment_dates = value
+        end
+      end
+
+      if attributes.key?(:'earnings')
+        self.earnings = attributes[:'earnings']
+      end
+
+      if attributes.key?(:'deductions')
+        self.deductions = attributes[:'deductions']
+      end
+
+      if attributes.key?(:'rounding')
+        self.rounding = attributes[:'rounding']
+      end
+
+      if attributes.key?(:'generation_place')
+        self.generation_place = attributes[:'generation_place']
+      end
+
+      if attributes.key?(:'employer')
+        self.employer = attributes[:'employer']
+      end
+
+      if attributes.key?(:'totals')
+        self.totals = attributes[:'totals']
+      end
+
+      if attributes.key?(:'dian')
+        self.dian = attributes[:'dian']
+      end
+
+      if attributes.key?(:'files')
+        self.files = attributes[:'files']
+      end
+
+      if attributes.key?(:'created_at')
+        self.created_at = attributes[:'created_at']
+      end
+
+      if attributes.key?(:'updated_at')
+        self.updated_at = attributes[:'updated_at']
+      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 &&
+          id == o.id &&
+          object == o.object &&
+          environment == o.environment &&
+          status == o.status &&
+          number == o.number &&
+          prefix == o.prefix &&
+          external_id == o.external_id &&
+          origin == o.origin &&
+          cune == o.cune &&
+          qr == o.qr &&
+          issued_at == o.issued_at &&
+          submission == o.submission &&
+          type == o.type &&
+          predecessor == o.predecessor &&
+          period == o.period &&
+          pay_period == o.pay_period &&
+          currency == o.currency &&
+          exchange_rate == o.exchange_rate &&
+          notes == o.notes &&
+          employee == o.employee &&
+          payment == o.payment &&
+          payment_dates == o.payment_dates &&
+          earnings == o.earnings &&
+          deductions == o.deductions &&
+          rounding == o.rounding &&
+          generation_place == o.generation_place &&
+          employer == o.employer &&
+          totals == o.totals &&
+          dian == o.dian &&
+          files == o.files &&
+          created_at == o.created_at &&
+          updated_at == o.updated_at
+    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
+      [id, object, environment, status, number, prefix, external_id, origin, cune, qr, issued_at, submission, type, predecessor, period, pay_period, currency, exchange_rate, notes, employee, payment, payment_dates, earnings, deductions, rounding, generation_place, employer, totals, dian, files, created_at, updated_at].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)
+      # include attributes inherited from allOf parents (the nearest declaration wins)
+      map = acceptable_attribute_map
+      transformed_hash = {}
+      acceptable_openapi_types.each_pair do |key, type|
+        if attributes.key?(map[key]) && attributes[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[map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[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 = {}
+      # include attributes inherited from allOf parents (the nearest declaration wins)
+      self.class.acceptable_attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.acceptable_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