factorial_api 3.0.1

data/lib/factorial_api/models/expenses_per_diem.rb

@@ -0,0 +1,581 @@
+=begin
+#Factorial API
+
+#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+The version of the OpenAPI document: 2026-10-01
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.23.0
+
+=end
+
+require 'date'
+require 'time'
+
+module F::Api
+  class ExpensesPerDiem < ApiModelBase
+    # The ID of the per diem.
+    attr_accessor :id
+
+    # The ID of the employee the per diem is for.
+    attr_accessor :employee_id
+
+    # The ID of the company the per diem is for.
+    attr_accessor :company_id
+
+    # The ID of the expensable the per diem is for.
+    attr_accessor :expenses_expensable_id
+
+    # The last day of the trip the allowance covers.
+    attr_accessor :end_date
+
+    # The first day of the trip the allowance covers.
+    attr_accessor :start_date
+
+    # The location the per diem is from.
+    attr_accessor :from
+
+    # The location the per diem is to.
+    attr_accessor :to
+
+    # The name of the trip.
+    attr_accessor :trip_name
+
+    # The ID of the ledger account the per diem is for.
+    attr_accessor :ledger_account_id
+
+    # The total allowance amount in cents.
+    attr_accessor :amount
+
+    # The currency code in ISO 4217 format.
+    attr_accessor :currency
+
+    # The amount to be reimbursed by the per diem in cents.
+    attr_accessor :reimbursable_amount
+
+    # The currency for the reimbursable amount.
+    attr_accessor :reimbursable_currency
+
+    # The payment method for the per diem.
+    attr_accessor :payment
+
+    # The date the per diem was paid.
+    attr_accessor :paid_at
+
+    # The files attached to the per diem.
+    attr_accessor :files
+
+    # The date the per diem was requested for review.
+    attr_accessor :review_request_at
+
+    # The date the per diem is effective on.
+    attr_accessor :effective_on
+
+    # The description of the per diem.
+    attr_accessor :description
+
+    attr_accessor :category
+
+    # The subcategory of the per diem.
+    attr_accessor :subcategory
+
+    # The status of the per diem.
+    attr_accessor :status
+
+    # The id of the budget associated with this per diem
+    attr_accessor :budget_id
+
+    # The id of the project associated with this per diem
+    attr_accessor :project_id
+
+    # Array of cost center IDs associated with this per diem
+    attr_accessor :cost_center_ids
+
+    # The rates for the per diem.
+    attr_accessor :rates
+
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'id' => :'id',
+        :'employee_id' => :'employee_id',
+        :'company_id' => :'company_id',
+        :'expenses_expensable_id' => :'expenses_expensable_id',
+        :'end_date' => :'end_date',
+        :'start_date' => :'start_date',
+        :'from' => :'from',
+        :'to' => :'to',
+        :'trip_name' => :'trip_name',
+        :'ledger_account_id' => :'ledger_account_id',
+        :'amount' => :'amount',
+        :'currency' => :'currency',
+        :'reimbursable_amount' => :'reimbursable_amount',
+        :'reimbursable_currency' => :'reimbursable_currency',
+        :'payment' => :'payment',
+        :'paid_at' => :'paid_at',
+        :'files' => :'files',
+        :'review_request_at' => :'review_request_at',
+        :'effective_on' => :'effective_on',
+        :'description' => :'description',
+        :'category' => :'category',
+        :'subcategory' => :'subcategory',
+        :'status' => :'status',
+        :'budget_id' => :'budget_id',
+        :'project_id' => :'project_id',
+        :'cost_center_ids' => :'cost_center_ids',
+        :'rates' => :'rates'
+      }
+    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',
+        :'employee_id' => :'String',
+        :'company_id' => :'String',
+        :'expenses_expensable_id' => :'String',
+        :'end_date' => :'String',
+        :'start_date' => :'String',
+        :'from' => :'String',
+        :'to' => :'String',
+        :'trip_name' => :'String',
+        :'ledger_account_id' => :'String',
+        :'amount' => :'Integer',
+        :'currency' => :'String',
+        :'reimbursable_amount' => :'Integer',
+        :'reimbursable_currency' => :'String',
+        :'payment' => :'String',
+        :'paid_at' => :'String',
+        :'files' => :'Array<ExpensesExpenseFilesInner>',
+        :'review_request_at' => :'String',
+        :'effective_on' => :'String',
+        :'description' => :'String',
+        :'category' => :'LocationsWorkAreasIdPutRequest',
+        :'subcategory' => :'String',
+        :'status' => :'String',
+        :'budget_id' => :'String',
+        :'project_id' => :'String',
+        :'cost_center_ids' => :'Array<String>',
+        :'rates' => :'Array<ExpensesPerDiemRatesInner>'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    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 `F::Api::ExpensesPerDiem` 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 `F::Api::ExpensesPerDiem`. 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']
+      else
+        self.id = nil
+      end
+
+      if attributes.key?(:'employee_id')
+        self.employee_id = attributes[:'employee_id']
+      end
+
+      if attributes.key?(:'company_id')
+        self.company_id = attributes[:'company_id']
+      else
+        self.company_id = nil
+      end
+
+      if attributes.key?(:'expenses_expensable_id')
+        self.expenses_expensable_id = attributes[:'expenses_expensable_id']
+      end
+
+      if attributes.key?(:'end_date')
+        self.end_date = attributes[:'end_date']
+      end
+
+      if attributes.key?(:'start_date')
+        self.start_date = attributes[:'start_date']
+      end
+
+      if attributes.key?(:'from')
+        self.from = attributes[:'from']
+      end
+
+      if attributes.key?(:'to')
+        self.to = attributes[:'to']
+      end
+
+      if attributes.key?(:'trip_name')
+        self.trip_name = attributes[:'trip_name']
+      end
+
+      if attributes.key?(:'ledger_account_id')
+        self.ledger_account_id = attributes[:'ledger_account_id']
+      end
+
+      if attributes.key?(:'amount')
+        self.amount = attributes[:'amount']
+      end
+
+      if attributes.key?(:'currency')
+        self.currency = attributes[:'currency']
+      else
+        self.currency = nil
+      end
+
+      if attributes.key?(:'reimbursable_amount')
+        self.reimbursable_amount = attributes[:'reimbursable_amount']
+      end
+
+      if attributes.key?(:'reimbursable_currency')
+        self.reimbursable_currency = attributes[:'reimbursable_currency']
+      end
+
+      if attributes.key?(:'payment')
+        self.payment = attributes[:'payment']
+      else
+        self.payment = nil
+      end
+
+      if attributes.key?(:'paid_at')
+        self.paid_at = attributes[:'paid_at']
+      end
+
+      if attributes.key?(:'files')
+        if (value = attributes[:'files']).is_a?(Array)
+          self.files = value
+        end
+      else
+        self.files = nil
+      end
+
+      if attributes.key?(:'review_request_at')
+        self.review_request_at = attributes[:'review_request_at']
+      end
+
+      if attributes.key?(:'effective_on')
+        self.effective_on = attributes[:'effective_on']
+      end
+
+      if attributes.key?(:'description')
+        self.description = attributes[:'description']
+      end
+
+      if attributes.key?(:'category')
+        self.category = attributes[:'category']
+      end
+
+      if attributes.key?(:'subcategory')
+        self.subcategory = attributes[:'subcategory']
+      end
+
+      if attributes.key?(:'status')
+        self.status = attributes[:'status']
+      else
+        self.status = nil
+      end
+
+      if attributes.key?(:'budget_id')
+        self.budget_id = attributes[:'budget_id']
+      end
+
+      if attributes.key?(:'project_id')
+        self.project_id = attributes[:'project_id']
+      end
+
+      if attributes.key?(:'cost_center_ids')
+        if (value = attributes[:'cost_center_ids']).is_a?(Array)
+          self.cost_center_ids = value
+        end
+      else
+        self.cost_center_ids = nil
+      end
+
+      if attributes.key?(:'rates')
+        if (value = attributes[:'rates']).is_a?(Array)
+          self.rates = value
+        end
+      else
+        self.rates = nil
+      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
+      if @id.nil?
+        invalid_properties.push('invalid value for "id", id cannot be nil.')
+      end
+
+      if @company_id.nil?
+        invalid_properties.push('invalid value for "company_id", company_id cannot be nil.')
+      end
+
+      if @currency.nil?
+        invalid_properties.push('invalid value for "currency", currency cannot be nil.')
+      end
+
+      if @payment.nil?
+        invalid_properties.push('invalid value for "payment", payment cannot be nil.')
+      end
+
+      if @files.nil?
+        invalid_properties.push('invalid value for "files", files cannot be nil.')
+      end
+
+      if @status.nil?
+        invalid_properties.push('invalid value for "status", status cannot be nil.')
+      end
+
+      if @cost_center_ids.nil?
+        invalid_properties.push('invalid value for "cost_center_ids", cost_center_ids cannot be nil.')
+      end
+
+      if @rates.nil?
+        invalid_properties.push('invalid value for "rates", rates 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?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      return false if @id.nil?
+      return false if @company_id.nil?
+      return false if @currency.nil?
+      return false if @payment.nil?
+      payment_validator = EnumAttributeValidator.new('String', ["reimbursable", "not_reimbursable"])
+      return false unless payment_validator.valid?(@payment)
+      return false if @files.nil?
+      return false if @status.nil?
+      status_validator = EnumAttributeValidator.new('String', ["pending", "changes_requested", "approved", "paid", "rejected", "reversed", "draft", "in_payroll", "sent_to_pay"])
+      return false unless status_validator.valid?(@status)
+      return false if @cost_center_ids.nil?
+      return false if @rates.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] id Value to be assigned
+    def id=(id)
+      if id.nil?
+        @id = nil
+        return
+      end
+
+      @id = id
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] company_id Value to be assigned
+    def company_id=(company_id)
+      if company_id.nil?
+        @company_id = nil
+        return
+      end
+
+      @company_id = company_id
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] currency Value to be assigned
+    def currency=(currency)
+      if currency.nil?
+        @currency = nil
+        return
+      end
+
+      @currency = currency
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] payment Object to be assigned
+    def payment=(payment)
+      validator = EnumAttributeValidator.new('String', ["reimbursable", "not_reimbursable"])
+      unless validator.valid?(payment)
+        fail ArgumentError, "invalid value for \"payment\", must be one of #{validator.allowable_values}."
+      end
+      @payment = payment
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] files Value to be assigned
+    def files=(files)
+      if files.nil?
+        @files = nil
+        return
+      end
+
+      @files = files
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] status Object to be assigned
+    def status=(status)
+      validator = EnumAttributeValidator.new('String', ["pending", "changes_requested", "approved", "paid", "rejected", "reversed", "draft", "in_payroll", "sent_to_pay"])
+      unless validator.valid?(status)
+        fail ArgumentError, "invalid value for \"status\", must be one of #{validator.allowable_values}."
+      end
+      @status = status
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] cost_center_ids Value to be assigned
+    def cost_center_ids=(cost_center_ids)
+      if cost_center_ids.nil?
+        @cost_center_ids = nil
+        return
+      end
+
+      @cost_center_ids = cost_center_ids
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] rates Value to be assigned
+    def rates=(rates)
+      if rates.nil?
+        @rates = nil
+        return
+      end
+
+      @rates = rates
+    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 &&
+          employee_id == o.employee_id &&
+          company_id == o.company_id &&
+          expenses_expensable_id == o.expenses_expensable_id &&
+          end_date == o.end_date &&
+          start_date == o.start_date &&
+          from == o.from &&
+          to == o.to &&
+          trip_name == o.trip_name &&
+          ledger_account_id == o.ledger_account_id &&
+          amount == o.amount &&
+          currency == o.currency &&
+          reimbursable_amount == o.reimbursable_amount &&
+          reimbursable_currency == o.reimbursable_currency &&
+          payment == o.payment &&
+          paid_at == o.paid_at &&
+          files == o.files &&
+          review_request_at == o.review_request_at &&
+          effective_on == o.effective_on &&
+          description == o.description &&
+          category == o.category &&
+          subcategory == o.subcategory &&
+          status == o.status &&
+          budget_id == o.budget_id &&
+          project_id == o.project_id &&
+          cost_center_ids == o.cost_center_ids &&
+          rates == o.rates
+    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, employee_id, company_id, expenses_expensable_id, end_date, start_date, from, to, trip_name, ledger_account_id, amount, currency, reimbursable_amount, reimbursable_currency, payment, paid_at, files, review_request_at, effective_on, description, category, subcategory, status, budget_id, project_id, cost_center_ids, rates].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