factorial_api 3.0.1

data/lib/factorial_api/models/attendance_shift.rb

@@ -0,0 +1,578 @@
+=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 AttendanceShift < ApiModelBase
+    # Unique identifier for the shift
+    attr_accessor :id
+
+    # Identifier for the employee assigned to the shift
+    attr_accessor :employee_id
+
+    # Date of the shift
+    attr_accessor :date
+
+    # The business day this shift is attributed to; can differ from `date` for overnight shifts that cross midnight
+    attr_accessor :reference_date
+
+    # Time when the employee clocked in
+    attr_accessor :clock_in
+
+    # Time when the employee clocked out
+    attr_accessor :clock_out
+
+    # Source of the clock-in time
+    attr_accessor :in_source
+
+    # Source of the clock-out time
+    attr_accessor :out_source
+
+    # Additional observations about the shift
+    attr_accessor :observations
+
+    # Type of location for the shift
+    attr_accessor :location_type
+
+    # Which half of the day the shift covers when it is a half-day — `beginning_of_day` or `end_of_day`; null for full-day shifts
+    attr_accessor :half_day
+
+    # Latitude of the clock-in location
+    attr_accessor :in_location_latitude
+
+    # Longitude of the clock-in location
+    attr_accessor :in_location_longitude
+
+    # Accuracy of the clock-in location
+    attr_accessor :in_location_accuracy
+
+    # Latitude of the clock-out location
+    attr_accessor :out_location_latitude
+
+    # Longitude of the clock-out location
+    attr_accessor :out_location_longitude
+
+    # Accuracy of the clock-out location
+    attr_accessor :out_location_accuracy
+
+    # Whether the shift counts as worked (workable) time rather than a break
+    attr_accessor :workable
+
+    # Timestamp when the shift record was created
+    attr_accessor :created_at
+
+    # Identifier for the location
+    attr_accessor :workplace_id
+
+    # Identifier for the break configuration
+    attr_accessor :time_settings_break_configuration_id
+
+    # Identifier for the company
+    attr_accessor :company_id
+
+    # Timestamp when the shift record was updated
+    attr_accessor :updated_at
+
+    # Number in minutes of the shift
+    attr_accessor :minutes
+
+    # Clock in time with seconds
+    attr_accessor :clock_in_with_seconds
+
+    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',
+        :'date' => :'date',
+        :'reference_date' => :'reference_date',
+        :'clock_in' => :'clock_in',
+        :'clock_out' => :'clock_out',
+        :'in_source' => :'in_source',
+        :'out_source' => :'out_source',
+        :'observations' => :'observations',
+        :'location_type' => :'location_type',
+        :'half_day' => :'half_day',
+        :'in_location_latitude' => :'in_location_latitude',
+        :'in_location_longitude' => :'in_location_longitude',
+        :'in_location_accuracy' => :'in_location_accuracy',
+        :'out_location_latitude' => :'out_location_latitude',
+        :'out_location_longitude' => :'out_location_longitude',
+        :'out_location_accuracy' => :'out_location_accuracy',
+        :'workable' => :'workable',
+        :'created_at' => :'created_at',
+        :'workplace_id' => :'workplace_id',
+        :'time_settings_break_configuration_id' => :'time_settings_break_configuration_id',
+        :'company_id' => :'company_id',
+        :'updated_at' => :'updated_at',
+        :'minutes' => :'minutes',
+        :'clock_in_with_seconds' => :'clock_in_with_seconds'
+      }
+    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',
+        :'date' => :'String',
+        :'reference_date' => :'String',
+        :'clock_in' => :'String',
+        :'clock_out' => :'String',
+        :'in_source' => :'String',
+        :'out_source' => :'String',
+        :'observations' => :'String',
+        :'location_type' => :'String',
+        :'half_day' => :'String',
+        :'in_location_latitude' => :'Float',
+        :'in_location_longitude' => :'Float',
+        :'in_location_accuracy' => :'Float',
+        :'out_location_latitude' => :'Float',
+        :'out_location_longitude' => :'Float',
+        :'out_location_accuracy' => :'Float',
+        :'workable' => :'Boolean',
+        :'created_at' => :'String',
+        :'workplace_id' => :'String',
+        :'time_settings_break_configuration_id' => :'String',
+        :'company_id' => :'String',
+        :'updated_at' => :'String',
+        :'minutes' => :'Integer',
+        :'clock_in_with_seconds' => :'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::AttendanceShift` 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::AttendanceShift`. 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']
+      else
+        self.employee_id = nil
+      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']
+      else
+        self.reference_date = 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?(:'in_source')
+        self.in_source = attributes[:'in_source']
+      end
+
+      if attributes.key?(:'out_source')
+        self.out_source = attributes[:'out_source']
+      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?(:'half_day')
+        self.half_day = attributes[:'half_day']
+      end
+
+      if attributes.key?(:'in_location_latitude')
+        self.in_location_latitude = attributes[:'in_location_latitude']
+      end
+
+      if attributes.key?(:'in_location_longitude')
+        self.in_location_longitude = attributes[:'in_location_longitude']
+      end
+
+      if attributes.key?(:'in_location_accuracy')
+        self.in_location_accuracy = attributes[:'in_location_accuracy']
+      end
+
+      if attributes.key?(:'out_location_latitude')
+        self.out_location_latitude = attributes[:'out_location_latitude']
+      end
+
+      if attributes.key?(:'out_location_longitude')
+        self.out_location_longitude = attributes[:'out_location_longitude']
+      end
+
+      if attributes.key?(:'out_location_accuracy')
+        self.out_location_accuracy = attributes[:'out_location_accuracy']
+      end
+
+      if attributes.key?(:'workable')
+        self.workable = attributes[:'workable']
+      end
+
+      if attributes.key?(:'created_at')
+        self.created_at = attributes[:'created_at']
+      else
+        self.created_at = nil
+      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
+
+      if attributes.key?(:'company_id')
+        self.company_id = attributes[:'company_id']
+      else
+        self.company_id = nil
+      end
+
+      if attributes.key?(:'updated_at')
+        self.updated_at = attributes[:'updated_at']
+      else
+        self.updated_at = nil
+      end
+
+      if attributes.key?(:'minutes')
+        self.minutes = attributes[:'minutes']
+      else
+        self.minutes = nil
+      end
+
+      if attributes.key?(:'clock_in_with_seconds')
+        self.clock_in_with_seconds = attributes[:'clock_in_with_seconds']
+      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 @employee_id.nil?
+        invalid_properties.push('invalid value for "employee_id", employee_id cannot be nil.')
+      end
+
+      if @date.nil?
+        invalid_properties.push('invalid value for "date", date cannot be nil.')
+      end
+
+      if @reference_date.nil?
+        invalid_properties.push('invalid value for "reference_date", reference_date cannot be nil.')
+      end
+
+      if @created_at.nil?
+        invalid_properties.push('invalid value for "created_at", created_at cannot be nil.')
+      end
+
+      if @company_id.nil?
+        invalid_properties.push('invalid value for "company_id", company_id cannot be nil.')
+      end
+
+      if @updated_at.nil?
+        invalid_properties.push('invalid value for "updated_at", updated_at cannot be nil.')
+      end
+
+      if @minutes.nil?
+        invalid_properties.push('invalid value for "minutes", minutes 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 @employee_id.nil?
+      return false if @date.nil?
+      return false if @reference_date.nil?
+      location_type_validator = EnumAttributeValidator.new('String', ["office", "business_trip", "work_from_home"])
+      return false unless location_type_validator.valid?(@location_type)
+      half_day_validator = EnumAttributeValidator.new('String', ["beginning_of_day", "end_of_day"])
+      return false unless half_day_validator.valid?(@half_day)
+      return false if @created_at.nil?
+      return false if @company_id.nil?
+      return false if @updated_at.nil?
+      return false if @minutes.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] employee_id Value to be assigned
+    def employee_id=(employee_id)
+      if employee_id.nil?
+        @employee_id = nil
+        return
+      end
+
+      @employee_id = employee_id
+    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 with validation
+    # @param [Object] reference_date Value to be assigned
+    def reference_date=(reference_date)
+      if reference_date.nil?
+        @reference_date = nil
+        return
+      end
+
+      @reference_date = reference_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] half_day Object to be assigned
+    def half_day=(half_day)
+      validator = EnumAttributeValidator.new('String', ["beginning_of_day", "end_of_day"])
+      unless validator.valid?(half_day)
+        fail ArgumentError, "invalid value for \"half_day\", must be one of #{validator.allowable_values}."
+      end
+      @half_day = half_day
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] created_at Value to be assigned
+    def created_at=(created_at)
+      if created_at.nil?
+        @created_at = nil
+        return
+      end
+
+      @created_at = created_at
+    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] updated_at Value to be assigned
+    def updated_at=(updated_at)
+      if updated_at.nil?
+        @updated_at = nil
+        return
+      end
+
+      @updated_at = updated_at
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] minutes Value to be assigned
+    def minutes=(minutes)
+      if minutes.nil?
+        @minutes = nil
+        return
+      end
+
+      @minutes = minutes
+    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 &&
+          date == o.date &&
+          reference_date == o.reference_date &&
+          clock_in == o.clock_in &&
+          clock_out == o.clock_out &&
+          in_source == o.in_source &&
+          out_source == o.out_source &&
+          observations == o.observations &&
+          location_type == o.location_type &&
+          half_day == o.half_day &&
+          in_location_latitude == o.in_location_latitude &&
+          in_location_longitude == o.in_location_longitude &&
+          in_location_accuracy == o.in_location_accuracy &&
+          out_location_latitude == o.out_location_latitude &&
+          out_location_longitude == o.out_location_longitude &&
+          out_location_accuracy == o.out_location_accuracy &&
+          workable == o.workable &&
+          created_at == o.created_at &&
+          workplace_id == o.workplace_id &&
+          time_settings_break_configuration_id == o.time_settings_break_configuration_id &&
+          company_id == o.company_id &&
+          updated_at == o.updated_at &&
+          minutes == o.minutes &&
+          clock_in_with_seconds == o.clock_in_with_seconds
+    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, date, reference_date, clock_in, clock_out, in_source, out_source, observations, location_type, half_day, in_location_latitude, in_location_longitude, in_location_accuracy, out_location_latitude, out_location_longitude, out_location_accuracy, workable, created_at, workplace_id, time_settings_break_configuration_id, company_id, updated_at, minutes, clock_in_with_seconds].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