factorial_api 3.0.1

data/lib/factorial_api/models/shift_management_shift.rb

@@ -0,0 +1,491 @@
+=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 ShiftManagementShift < ApiModelBase
+    # Unique identifier for the shift
+    attr_accessor :id
+
+    # Identifier of the company that owns this shift
+    attr_accessor :company_id
+
+    # Display name of the shift. If not explicitly set, falls back to the default shift title or template week name
+    attr_accessor :name
+
+    # Current state of the shift. 'draft' means the shift is not yet visible to employees, 'published' means it's visible and confirmed, 'backup' indicates a backup shift that can be replaced
+    attr_accessor :state
+
+    # Identifier of the location where the shift takes place. Can be null if the shift uses the employee's default location
+    attr_accessor :location_id
+
+    # Identifier of the specific work area within the location where the shift occurs. Work areas allow further subdivision of locations
+    attr_accessor :locations_work_area_id
+
+    # Identifier of the employee assigned to this shift
+    attr_accessor :employee_id
+
+    # Timestamp indicating when the shift starts
+    attr_accessor :start_at
+
+    # Timestamp indicating when the shift ends
+    attr_accessor :end_at
+
+    # Optional notes or comments about the shift, visible to managers and schedulers
+    attr_accessor :notes
+
+    # Indicates whether this shift counts as extra hours beyond the employee's regular schedule. Used for overtime calculations
+    attr_accessor :extra_hours
+
+    # Title from the default shift template that was used to create this shift, if applicable
+    attr_accessor :default_shift_title
+
+    # IANA timezone identifier (e.g., 'Europe/Madrid', 'America/New_York') used to display the shift times in the local timezone
+    attr_accessor :timezone
+
+    # Start time of the shift converted to the local timezone. This is what employees see in their schedule
+    attr_accessor :local_start_at
+
+    # End time of the shift converted to the local timezone. This is what employees see in their schedule
+    attr_accessor :local_end_at
+
+    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',
+        :'company_id' => :'company_id',
+        :'name' => :'name',
+        :'state' => :'state',
+        :'location_id' => :'location_id',
+        :'locations_work_area_id' => :'locations_work_area_id',
+        :'employee_id' => :'employee_id',
+        :'start_at' => :'start_at',
+        :'end_at' => :'end_at',
+        :'notes' => :'notes',
+        :'extra_hours' => :'extra_hours',
+        :'default_shift_title' => :'default_shift_title',
+        :'timezone' => :'timezone',
+        :'local_start_at' => :'local_start_at',
+        :'local_end_at' => :'local_end_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',
+        :'company_id' => :'String',
+        :'name' => :'String',
+        :'state' => :'String',
+        :'location_id' => :'String',
+        :'locations_work_area_id' => :'String',
+        :'employee_id' => :'String',
+        :'start_at' => :'String',
+        :'end_at' => :'String',
+        :'notes' => :'String',
+        :'extra_hours' => :'Boolean',
+        :'default_shift_title' => :'String',
+        :'timezone' => :'String',
+        :'local_start_at' => :'String',
+        :'local_end_at' => :'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::ShiftManagementShift` 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::ShiftManagementShift`. 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?(:'company_id')
+        self.company_id = attributes[:'company_id']
+      else
+        self.company_id = nil
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.key?(:'state')
+        self.state = attributes[:'state']
+      else
+        self.state = nil
+      end
+
+      if attributes.key?(:'location_id')
+        self.location_id = attributes[:'location_id']
+      end
+
+      if attributes.key?(:'locations_work_area_id')
+        self.locations_work_area_id = attributes[:'locations_work_area_id']
+      end
+
+      if attributes.key?(:'employee_id')
+        self.employee_id = attributes[:'employee_id']
+      else
+        self.employee_id = nil
+      end
+
+      if attributes.key?(:'start_at')
+        self.start_at = attributes[:'start_at']
+      else
+        self.start_at = nil
+      end
+
+      if attributes.key?(:'end_at')
+        self.end_at = attributes[:'end_at']
+      else
+        self.end_at = nil
+      end
+
+      if attributes.key?(:'notes')
+        self.notes = attributes[:'notes']
+      end
+
+      if attributes.key?(:'extra_hours')
+        self.extra_hours = attributes[:'extra_hours']
+      else
+        self.extra_hours = nil
+      end
+
+      if attributes.key?(:'default_shift_title')
+        self.default_shift_title = attributes[:'default_shift_title']
+      end
+
+      if attributes.key?(:'timezone')
+        self.timezone = attributes[:'timezone']
+      else
+        self.timezone = nil
+      end
+
+      if attributes.key?(:'local_start_at')
+        self.local_start_at = attributes[:'local_start_at']
+      else
+        self.local_start_at = nil
+      end
+
+      if attributes.key?(:'local_end_at')
+        self.local_end_at = attributes[:'local_end_at']
+      else
+        self.local_end_at = 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 @state.nil?
+        invalid_properties.push('invalid value for "state", state cannot be nil.')
+      end
+
+      if @employee_id.nil?
+        invalid_properties.push('invalid value for "employee_id", employee_id cannot be nil.')
+      end
+
+      if @start_at.nil?
+        invalid_properties.push('invalid value for "start_at", start_at cannot be nil.')
+      end
+
+      if @end_at.nil?
+        invalid_properties.push('invalid value for "end_at", end_at cannot be nil.')
+      end
+
+      if @extra_hours.nil?
+        invalid_properties.push('invalid value for "extra_hours", extra_hours cannot be nil.')
+      end
+
+      if @timezone.nil?
+        invalid_properties.push('invalid value for "timezone", timezone cannot be nil.')
+      end
+
+      if @local_start_at.nil?
+        invalid_properties.push('invalid value for "local_start_at", local_start_at cannot be nil.')
+      end
+
+      if @local_end_at.nil?
+        invalid_properties.push('invalid value for "local_end_at", local_end_at 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 @state.nil?
+      state_validator = EnumAttributeValidator.new('String', ["draft", "published", "backup"])
+      return false unless state_validator.valid?(@state)
+      return false if @employee_id.nil?
+      return false if @start_at.nil?
+      return false if @end_at.nil?
+      return false if @extra_hours.nil?
+      return false if @timezone.nil?
+      return false if @local_start_at.nil?
+      return false if @local_end_at.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 checking allowed values (enum).
+    # @param [Object] state Object to be assigned
+    def state=(state)
+      validator = EnumAttributeValidator.new('String', ["draft", "published", "backup"])
+      unless validator.valid?(state)
+        fail ArgumentError, "invalid value for \"state\", must be one of #{validator.allowable_values}."
+      end
+      @state = state
+    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] start_at Value to be assigned
+    def start_at=(start_at)
+      if start_at.nil?
+        @start_at = nil
+        return
+      end
+
+      @start_at = start_at
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] end_at Value to be assigned
+    def end_at=(end_at)
+      if end_at.nil?
+        @end_at = nil
+        return
+      end
+
+      @end_at = end_at
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] extra_hours Value to be assigned
+    def extra_hours=(extra_hours)
+      if extra_hours.nil?
+        @extra_hours = nil
+        return
+      end
+
+      @extra_hours = extra_hours
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] timezone Value to be assigned
+    def timezone=(timezone)
+      if timezone.nil?
+        @timezone = nil
+        return
+      end
+
+      @timezone = timezone
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] local_start_at Value to be assigned
+    def local_start_at=(local_start_at)
+      if local_start_at.nil?
+        @local_start_at = nil
+        return
+      end
+
+      @local_start_at = local_start_at
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] local_end_at Value to be assigned
+    def local_end_at=(local_end_at)
+      if local_end_at.nil?
+        @local_end_at = nil
+        return
+      end
+
+      @local_end_at = local_end_at
+    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 &&
+          company_id == o.company_id &&
+          name == o.name &&
+          state == o.state &&
+          location_id == o.location_id &&
+          locations_work_area_id == o.locations_work_area_id &&
+          employee_id == o.employee_id &&
+          start_at == o.start_at &&
+          end_at == o.end_at &&
+          notes == o.notes &&
+          extra_hours == o.extra_hours &&
+          default_shift_title == o.default_shift_title &&
+          timezone == o.timezone &&
+          local_start_at == o.local_start_at &&
+          local_end_at == o.local_end_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, company_id, name, state, location_id, locations_work_area_id, employee_id, start_at, end_at, notes, extra_hours, default_shift_title, timezone, local_start_at, local_end_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)
+      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/shift_management_shifts_bulk_create_post_request.rb

@@ -0,0 +1,180 @@
+=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 ShiftManagementShiftsBulkCreatePostRequest < ApiModelBase
+    # Array of shift objects to create. Each shift object represents a scheduled work period for an employee
+    attr_accessor :shifts
+
+    # An array of planned breaks to be added to the shifts created.
+    attr_accessor :planned_breaks
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'shifts' => :'shifts',
+        :'planned_breaks' => :'planned_breaks'
+      }
+    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
+      {
+        :'shifts' => :'Array<ShiftManagementShiftsBulkCreatePostRequestShiftsInner>',
+        :'planned_breaks' => :'Array<ShiftManagementShiftsBulkCreatePostRequestPlannedBreaksInner>'
+      }
+    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::ShiftManagementShiftsBulkCreatePostRequest` 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::ShiftManagementShiftsBulkCreatePostRequest`. 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?(:'shifts')
+        if (value = attributes[:'shifts']).is_a?(Array)
+          self.shifts = value
+        end
+      else
+        self.shifts = nil
+      end
+
+      if attributes.key?(:'planned_breaks')
+        if (value = attributes[:'planned_breaks']).is_a?(Array)
+          self.planned_breaks = value
+        end
+      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 @shifts.nil?
+        invalid_properties.push('invalid value for "shifts", shifts 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 @shifts.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] shifts Value to be assigned
+    def shifts=(shifts)
+      if shifts.nil?
+        @shifts = nil
+        return
+      end
+
+      @shifts = shifts
+    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 &&
+          shifts == o.shifts &&
+          planned_breaks == o.planned_breaks
+    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
+      [shifts, planned_breaks].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