factorial_api 3.0.1

data/lib/factorial_api/models/contracts_compensations_id_put_request.rb

@@ -0,0 +1,334 @@
+=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 ContractsCompensationsIdPutRequest < ApiModelBase
+    attr_accessor :id
+
+    attr_accessor :contracts_taxonomy_id
+
+    attr_accessor :description
+
+    attr_accessor :compensation_type
+
+    attr_accessor :amount
+
+    attr_accessor :unit
+
+    attr_accessor :sync_with_supplements
+
+    attr_accessor :payroll_policy_id
+
+    attr_accessor :recurrence_count
+
+    attr_accessor :starts_on
+
+    attr_accessor :recurrence
+
+    attr_accessor :first_payment_on
+
+    attr_accessor :calculation
+
+    attr_accessor :time_condition
+
+    attr_accessor :minimum_amount_of_hours
+
+    attr_accessor :minimum_amount_of_hours_in_cents
+
+    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',
+        :'contracts_taxonomy_id' => :'contracts_taxonomy_id',
+        :'description' => :'description',
+        :'compensation_type' => :'compensation_type',
+        :'amount' => :'amount',
+        :'unit' => :'unit',
+        :'sync_with_supplements' => :'sync_with_supplements',
+        :'payroll_policy_id' => :'payroll_policy_id',
+        :'recurrence_count' => :'recurrence_count',
+        :'starts_on' => :'starts_on',
+        :'recurrence' => :'recurrence',
+        :'first_payment_on' => :'first_payment_on',
+        :'calculation' => :'calculation',
+        :'time_condition' => :'time_condition',
+        :'minimum_amount_of_hours' => :'minimum_amount_of_hours',
+        :'minimum_amount_of_hours_in_cents' => :'minimum_amount_of_hours_in_cents'
+      }
+    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',
+        :'contracts_taxonomy_id' => :'String',
+        :'description' => :'String',
+        :'compensation_type' => :'String',
+        :'amount' => :'Integer',
+        :'unit' => :'String',
+        :'sync_with_supplements' => :'Boolean',
+        :'payroll_policy_id' => :'String',
+        :'recurrence_count' => :'Integer',
+        :'starts_on' => :'String',
+        :'recurrence' => :'String',
+        :'first_payment_on' => :'String',
+        :'calculation' => :'String',
+        :'time_condition' => :'String',
+        :'minimum_amount_of_hours' => :'Integer',
+        :'minimum_amount_of_hours_in_cents' => :'Integer'
+      }
+    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::ContractsCompensationsIdPutRequest` 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::ContractsCompensationsIdPutRequest`. 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?(:'contracts_taxonomy_id')
+        self.contracts_taxonomy_id = attributes[:'contracts_taxonomy_id']
+      else
+        self.contracts_taxonomy_id = nil
+      end
+
+      if attributes.key?(:'description')
+        self.description = attributes[:'description']
+      end
+
+      if attributes.key?(:'compensation_type')
+        self.compensation_type = attributes[:'compensation_type']
+      end
+
+      if attributes.key?(:'amount')
+        self.amount = attributes[:'amount']
+      end
+
+      if attributes.key?(:'unit')
+        self.unit = attributes[:'unit']
+      end
+
+      if attributes.key?(:'sync_with_supplements')
+        self.sync_with_supplements = attributes[:'sync_with_supplements']
+      end
+
+      if attributes.key?(:'payroll_policy_id')
+        self.payroll_policy_id = attributes[:'payroll_policy_id']
+      end
+
+      if attributes.key?(:'recurrence_count')
+        self.recurrence_count = attributes[:'recurrence_count']
+      end
+
+      if attributes.key?(:'starts_on')
+        self.starts_on = attributes[:'starts_on']
+      end
+
+      if attributes.key?(:'recurrence')
+        self.recurrence = attributes[:'recurrence']
+      end
+
+      if attributes.key?(:'first_payment_on')
+        self.first_payment_on = attributes[:'first_payment_on']
+      end
+
+      if attributes.key?(:'calculation')
+        self.calculation = attributes[:'calculation']
+      end
+
+      if attributes.key?(:'time_condition')
+        self.time_condition = attributes[:'time_condition']
+      end
+
+      if attributes.key?(:'minimum_amount_of_hours')
+        self.minimum_amount_of_hours = attributes[:'minimum_amount_of_hours']
+      end
+
+      if attributes.key?(:'minimum_amount_of_hours_in_cents')
+        self.minimum_amount_of_hours_in_cents = attributes[:'minimum_amount_of_hours_in_cents']
+      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 @contracts_taxonomy_id.nil?
+        invalid_properties.push('invalid value for "contracts_taxonomy_id", contracts_taxonomy_id 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 @contracts_taxonomy_id.nil?
+      time_condition_validator = EnumAttributeValidator.new('String', ["full_day", "half_day", "custom"])
+      return false unless time_condition_validator.valid?(@time_condition)
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] contracts_taxonomy_id Value to be assigned
+    def contracts_taxonomy_id=(contracts_taxonomy_id)
+      if contracts_taxonomy_id.nil?
+        @contracts_taxonomy_id = nil
+        return
+      end
+
+      @contracts_taxonomy_id = contracts_taxonomy_id
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] time_condition Object to be assigned
+    def time_condition=(time_condition)
+      validator = EnumAttributeValidator.new('String', ["full_day", "half_day", "custom"])
+      unless validator.valid?(time_condition)
+        fail ArgumentError, "invalid value for \"time_condition\", must be one of #{validator.allowable_values}."
+      end
+      @time_condition = time_condition
+    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 &&
+          contracts_taxonomy_id == o.contracts_taxonomy_id &&
+          description == o.description &&
+          compensation_type == o.compensation_type &&
+          amount == o.amount &&
+          unit == o.unit &&
+          sync_with_supplements == o.sync_with_supplements &&
+          payroll_policy_id == o.payroll_policy_id &&
+          recurrence_count == o.recurrence_count &&
+          starts_on == o.starts_on &&
+          recurrence == o.recurrence &&
+          first_payment_on == o.first_payment_on &&
+          calculation == o.calculation &&
+          time_condition == o.time_condition &&
+          minimum_amount_of_hours == o.minimum_amount_of_hours &&
+          minimum_amount_of_hours_in_cents == o.minimum_amount_of_hours_in_cents
+    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, contracts_taxonomy_id, description, compensation_type, amount, unit, sync_with_supplements, payroll_policy_id, recurrence_count, starts_on, recurrence, first_payment_on, calculation, time_condition, minimum_amount_of_hours, minimum_amount_of_hours_in_cents].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/factorial_api/models/contracts_compensations_post_request.rb

@@ -0,0 +1,352 @@
+=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 ContractsCompensationsPostRequest < ApiModelBase
+    attr_accessor :contract_version_id
+
+    attr_accessor :contracts_taxonomy_id
+
+    attr_accessor :description
+
+    attr_accessor :compensation_type
+
+    attr_accessor :amount
+
+    attr_accessor :unit
+
+    attr_accessor :sync_with_supplements
+
+    attr_accessor :payroll_policy_id
+
+    attr_accessor :recurrence_count
+
+    attr_accessor :starts_on
+
+    attr_accessor :recurrence
+
+    attr_accessor :first_payment_on
+
+    attr_accessor :calculation
+
+    attr_accessor :time_condition
+
+    attr_accessor :minimum_amount_of_hours
+
+    attr_accessor :minimum_amount_of_hours_in_cents
+
+    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
+      {
+        :'contract_version_id' => :'contract_version_id',
+        :'contracts_taxonomy_id' => :'contracts_taxonomy_id',
+        :'description' => :'description',
+        :'compensation_type' => :'compensation_type',
+        :'amount' => :'amount',
+        :'unit' => :'unit',
+        :'sync_with_supplements' => :'sync_with_supplements',
+        :'payroll_policy_id' => :'payroll_policy_id',
+        :'recurrence_count' => :'recurrence_count',
+        :'starts_on' => :'starts_on',
+        :'recurrence' => :'recurrence',
+        :'first_payment_on' => :'first_payment_on',
+        :'calculation' => :'calculation',
+        :'time_condition' => :'time_condition',
+        :'minimum_amount_of_hours' => :'minimum_amount_of_hours',
+        :'minimum_amount_of_hours_in_cents' => :'minimum_amount_of_hours_in_cents'
+      }
+    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
+      {
+        :'contract_version_id' => :'String',
+        :'contracts_taxonomy_id' => :'String',
+        :'description' => :'String',
+        :'compensation_type' => :'String',
+        :'amount' => :'Integer',
+        :'unit' => :'String',
+        :'sync_with_supplements' => :'Boolean',
+        :'payroll_policy_id' => :'String',
+        :'recurrence_count' => :'Integer',
+        :'starts_on' => :'String',
+        :'recurrence' => :'String',
+        :'first_payment_on' => :'String',
+        :'calculation' => :'String',
+        :'time_condition' => :'String',
+        :'minimum_amount_of_hours' => :'Integer',
+        :'minimum_amount_of_hours_in_cents' => :'Integer'
+      }
+    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::ContractsCompensationsPostRequest` 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::ContractsCompensationsPostRequest`. 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?(:'contract_version_id')
+        self.contract_version_id = attributes[:'contract_version_id']
+      else
+        self.contract_version_id = nil
+      end
+
+      if attributes.key?(:'contracts_taxonomy_id')
+        self.contracts_taxonomy_id = attributes[:'contracts_taxonomy_id']
+      else
+        self.contracts_taxonomy_id = nil
+      end
+
+      if attributes.key?(:'description')
+        self.description = attributes[:'description']
+      end
+
+      if attributes.key?(:'compensation_type')
+        self.compensation_type = attributes[:'compensation_type']
+      end
+
+      if attributes.key?(:'amount')
+        self.amount = attributes[:'amount']
+      end
+
+      if attributes.key?(:'unit')
+        self.unit = attributes[:'unit']
+      end
+
+      if attributes.key?(:'sync_with_supplements')
+        self.sync_with_supplements = attributes[:'sync_with_supplements']
+      end
+
+      if attributes.key?(:'payroll_policy_id')
+        self.payroll_policy_id = attributes[:'payroll_policy_id']
+      end
+
+      if attributes.key?(:'recurrence_count')
+        self.recurrence_count = attributes[:'recurrence_count']
+      end
+
+      if attributes.key?(:'starts_on')
+        self.starts_on = attributes[:'starts_on']
+      end
+
+      if attributes.key?(:'recurrence')
+        self.recurrence = attributes[:'recurrence']
+      end
+
+      if attributes.key?(:'first_payment_on')
+        self.first_payment_on = attributes[:'first_payment_on']
+      end
+
+      if attributes.key?(:'calculation')
+        self.calculation = attributes[:'calculation']
+      end
+
+      if attributes.key?(:'time_condition')
+        self.time_condition = attributes[:'time_condition']
+      end
+
+      if attributes.key?(:'minimum_amount_of_hours')
+        self.minimum_amount_of_hours = attributes[:'minimum_amount_of_hours']
+      end
+
+      if attributes.key?(:'minimum_amount_of_hours_in_cents')
+        self.minimum_amount_of_hours_in_cents = attributes[:'minimum_amount_of_hours_in_cents']
+      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 @contract_version_id.nil?
+        invalid_properties.push('invalid value for "contract_version_id", contract_version_id cannot be nil.')
+      end
+
+      if @contracts_taxonomy_id.nil?
+        invalid_properties.push('invalid value for "contracts_taxonomy_id", contracts_taxonomy_id 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 @contract_version_id.nil?
+      return false if @contracts_taxonomy_id.nil?
+      time_condition_validator = EnumAttributeValidator.new('String', ["full_day", "half_day", "custom"])
+      return false unless time_condition_validator.valid?(@time_condition)
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] contract_version_id Value to be assigned
+    def contract_version_id=(contract_version_id)
+      if contract_version_id.nil?
+        @contract_version_id = nil
+        return
+      end
+
+      @contract_version_id = contract_version_id
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] contracts_taxonomy_id Value to be assigned
+    def contracts_taxonomy_id=(contracts_taxonomy_id)
+      if contracts_taxonomy_id.nil?
+        @contracts_taxonomy_id = nil
+        return
+      end
+
+      @contracts_taxonomy_id = contracts_taxonomy_id
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] time_condition Object to be assigned
+    def time_condition=(time_condition)
+      validator = EnumAttributeValidator.new('String', ["full_day", "half_day", "custom"])
+      unless validator.valid?(time_condition)
+        fail ArgumentError, "invalid value for \"time_condition\", must be one of #{validator.allowable_values}."
+      end
+      @time_condition = time_condition
+    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 &&
+          contract_version_id == o.contract_version_id &&
+          contracts_taxonomy_id == o.contracts_taxonomy_id &&
+          description == o.description &&
+          compensation_type == o.compensation_type &&
+          amount == o.amount &&
+          unit == o.unit &&
+          sync_with_supplements == o.sync_with_supplements &&
+          payroll_policy_id == o.payroll_policy_id &&
+          recurrence_count == o.recurrence_count &&
+          starts_on == o.starts_on &&
+          recurrence == o.recurrence &&
+          first_payment_on == o.first_payment_on &&
+          calculation == o.calculation &&
+          time_condition == o.time_condition &&
+          minimum_amount_of_hours == o.minimum_amount_of_hours &&
+          minimum_amount_of_hours_in_cents == o.minimum_amount_of_hours_in_cents
+    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
+      [contract_version_id, contracts_taxonomy_id, description, compensation_type, amount, unit, sync_with_supplements, payroll_policy_id, recurrence_count, starts_on, recurrence, first_payment_on, calculation, time_condition, minimum_amount_of_hours, minimum_amount_of_hours_in_cents].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