factorial_api 3.0.1

data/lib/factorial_api/models/attendance_shifts_id_put_request.rb

@@ -0,0 +1,280 @@
+=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 AttendanceShiftsIdPutRequest < ApiModelBase
+    # Id of the shift
+    attr_accessor :id
+
+    # Time of the clock in
+    attr_accessor :clock_in
+
+    # Time of the clock out
+    attr_accessor :clock_out
+
+    # Date of the shift
+    attr_accessor :date
+
+    # reference date of the shift
+    attr_accessor :reference_date
+
+    # Comments added to the shift
+    attr_accessor :observations
+
+    # Type of the location
+    attr_accessor :location_type
+
+    # Id of the location related
+    attr_accessor :workplace_id
+
+    # Id of the break configuration
+    attr_accessor :time_settings_break_configuration_id
+
+    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',
+        :'clock_in' => :'clock_in',
+        :'clock_out' => :'clock_out',
+        :'date' => :'date',
+        :'reference_date' => :'reference_date',
+        :'observations' => :'observations',
+        :'location_type' => :'location_type',
+        :'workplace_id' => :'workplace_id',
+        :'time_settings_break_configuration_id' => :'time_settings_break_configuration_id'
+      }
+    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',
+        :'clock_in' => :'String',
+        :'clock_out' => :'String',
+        :'date' => :'String',
+        :'reference_date' => :'String',
+        :'observations' => :'String',
+        :'location_type' => :'String',
+        :'workplace_id' => :'String',
+        :'time_settings_break_configuration_id' => :'String'
+      }
+    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::AttendanceShiftsIdPutRequest` 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::AttendanceShiftsIdPutRequest`. 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?(:'clock_in')
+        self.clock_in = attributes[:'clock_in']
+      end
+
+      if attributes.key?(:'clock_out')
+        self.clock_out = attributes[:'clock_out']
+      end
+
+      if attributes.key?(:'date')
+        self.date = attributes[:'date']
+      end
+
+      if attributes.key?(:'reference_date')
+        self.reference_date = attributes[:'reference_date']
+      end
+
+      if attributes.key?(:'observations')
+        self.observations = attributes[:'observations']
+      end
+
+      if attributes.key?(:'location_type')
+        self.location_type = attributes[:'location_type']
+      end
+
+      if attributes.key?(:'workplace_id')
+        self.workplace_id = attributes[:'workplace_id']
+      end
+
+      if attributes.key?(:'time_settings_break_configuration_id')
+        self.time_settings_break_configuration_id = attributes[:'time_settings_break_configuration_id']
+      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
+
+      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?
+      location_type_validator = EnumAttributeValidator.new('String', ["office", "business_trip", "work_from_home"])
+      return false unless location_type_validator.valid?(@location_type)
+      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 checking allowed values (enum).
+    # @param [Object] location_type Object to be assigned
+    def location_type=(location_type)
+      validator = EnumAttributeValidator.new('String', ["office", "business_trip", "work_from_home"])
+      unless validator.valid?(location_type)
+        fail ArgumentError, "invalid value for \"location_type\", must be one of #{validator.allowable_values}."
+      end
+      @location_type = location_type
+    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 &&
+          clock_in == o.clock_in &&
+          clock_out == o.clock_out &&
+          date == o.date &&
+          reference_date == o.reference_date &&
+          observations == o.observations &&
+          location_type == o.location_type &&
+          workplace_id == o.workplace_id &&
+          time_settings_break_configuration_id == o.time_settings_break_configuration_id
+    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, clock_in, clock_out, date, reference_date, observations, location_type, workplace_id, time_settings_break_configuration_id].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/attendance_shifts_post_request.rb

@@ -0,0 +1,342 @@
+=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 AttendanceShiftsPostRequest < ApiModelBase
+    # Id of the employee related
+    attr_accessor :employee_id
+
+    # Date of the shift
+    attr_accessor :date
+
+    # Reference date of the shift
+    attr_accessor :reference_date
+
+    # number of days of the shift
+    attr_accessor :day
+
+    # Time of the clock in
+    attr_accessor :clock_in
+
+    # Time of the clock out
+    attr_accessor :clock_out
+
+    # Comments added to the shift
+    attr_accessor :observations
+
+    # Boolean that indicates if the shift is a half day
+    attr_accessor :half_day
+
+    # Boolean that indicates if the shift is workable
+    attr_accessor :workable
+
+    # Type of the location
+    attr_accessor :location_type
+
+    # Source of the shift creation
+    attr_accessor :source
+
+    # Id of the break configuration
+    attr_accessor :time_settings_break_configuration_id
+
+    # Id of the location related
+    attr_accessor :workplace_id
+
+    # Id of the project worker the shift is imputed to. A time record for that project is created with the shift.
+    attr_accessor :project_worker_id
+
+    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
+      {
+        :'employee_id' => :'employee_id',
+        :'date' => :'date',
+        :'reference_date' => :'reference_date',
+        :'day' => :'day',
+        :'clock_in' => :'clock_in',
+        :'clock_out' => :'clock_out',
+        :'observations' => :'observations',
+        :'half_day' => :'half_day',
+        :'workable' => :'workable',
+        :'location_type' => :'location_type',
+        :'source' => :'source',
+        :'time_settings_break_configuration_id' => :'time_settings_break_configuration_id',
+        :'workplace_id' => :'workplace_id',
+        :'project_worker_id' => :'project_worker_id'
+      }
+    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
+      {
+        :'employee_id' => :'String',
+        :'date' => :'String',
+        :'reference_date' => :'String',
+        :'day' => :'Integer',
+        :'clock_in' => :'String',
+        :'clock_out' => :'String',
+        :'observations' => :'String',
+        :'half_day' => :'String',
+        :'workable' => :'Boolean',
+        :'location_type' => :'String',
+        :'source' => :'String',
+        :'time_settings_break_configuration_id' => :'String',
+        :'workplace_id' => :'String',
+        :'project_worker_id' => :'String'
+      }
+    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::AttendanceShiftsPostRequest` 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::AttendanceShiftsPostRequest`. 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?(:'employee_id')
+        self.employee_id = attributes[:'employee_id']
+      end
+
+      if attributes.key?(:'date')
+        self.date = attributes[:'date']
+      else
+        self.date = nil
+      end
+
+      if attributes.key?(:'reference_date')
+        self.reference_date = attributes[:'reference_date']
+      end
+
+      if attributes.key?(:'day')
+        self.day = attributes[:'day']
+      end
+
+      if attributes.key?(:'clock_in')
+        self.clock_in = attributes[:'clock_in']
+      end
+
+      if attributes.key?(:'clock_out')
+        self.clock_out = attributes[:'clock_out']
+      end
+
+      if attributes.key?(:'observations')
+        self.observations = attributes[:'observations']
+      end
+
+      if attributes.key?(:'half_day')
+        self.half_day = attributes[:'half_day']
+      end
+
+      if attributes.key?(:'workable')
+        self.workable = attributes[:'workable']
+      end
+
+      if attributes.key?(:'location_type')
+        self.location_type = attributes[:'location_type']
+      end
+
+      if attributes.key?(:'source')
+        self.source = attributes[:'source']
+      end
+
+      if attributes.key?(:'time_settings_break_configuration_id')
+        self.time_settings_break_configuration_id = attributes[:'time_settings_break_configuration_id']
+      end
+
+      if attributes.key?(:'workplace_id')
+        self.workplace_id = attributes[:'workplace_id']
+      end
+
+      if attributes.key?(:'project_worker_id')
+        self.project_worker_id = attributes[:'project_worker_id']
+      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 @date.nil?
+        invalid_properties.push('invalid value for "date", date 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 @date.nil?
+      location_type_validator = EnumAttributeValidator.new('String', ["office", "business_trip", "work_from_home"])
+      return false unless location_type_validator.valid?(@location_type)
+      source_validator = EnumAttributeValidator.new('String', ["desktop", "mobile", "face_recognition", "qr_code", "mobile_geolocation", "shared_device", "api", "system", "one_assistant"])
+      return false unless source_validator.valid?(@source)
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] date Value to be assigned
+    def date=(date)
+      if date.nil?
+        @date = nil
+        return
+      end
+
+      @date = date
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] location_type Object to be assigned
+    def location_type=(location_type)
+      validator = EnumAttributeValidator.new('String', ["office", "business_trip", "work_from_home"])
+      unless validator.valid?(location_type)
+        fail ArgumentError, "invalid value for \"location_type\", must be one of #{validator.allowable_values}."
+      end
+      @location_type = location_type
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] source Object to be assigned
+    def source=(source)
+      validator = EnumAttributeValidator.new('String', ["desktop", "mobile", "face_recognition", "qr_code", "mobile_geolocation", "shared_device", "api", "system", "one_assistant"])
+      unless validator.valid?(source)
+        fail ArgumentError, "invalid value for \"source\", must be one of #{validator.allowable_values}."
+      end
+      @source = source
+    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 &&
+          employee_id == o.employee_id &&
+          date == o.date &&
+          reference_date == o.reference_date &&
+          day == o.day &&
+          clock_in == o.clock_in &&
+          clock_out == o.clock_out &&
+          observations == o.observations &&
+          half_day == o.half_day &&
+          workable == o.workable &&
+          location_type == o.location_type &&
+          source == o.source &&
+          time_settings_break_configuration_id == o.time_settings_break_configuration_id &&
+          workplace_id == o.workplace_id &&
+          project_worker_id == o.project_worker_id
+    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
+      [employee_id, date, reference_date, day, clock_in, clock_out, observations, half_day, workable, location_type, source, time_settings_break_configuration_id, workplace_id, project_worker_id].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