factorial_api 3.0.1

data/lib/factorial_api/models/time_planning_planned_break.rb

@@ -0,0 +1,371 @@
+=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 TimePlanningPlannedBreak < ApiModelBase
+    # Planned break identifier
+    attr_accessor :id
+
+    # Break start time
+    attr_accessor :start_at
+
+    # Break end time
+    attr_accessor :end_at
+
+    # Duration of the break in minutes
+    attr_accessor :duration
+
+    # Type of the break
+    attr_accessor :break_type
+
+    # Break configuration identifier
+    attr_accessor :break_configuration_id
+
+    # Name of the break configuration
+    attr_accessor :break_configuration_name
+
+    # Whether the break is paid
+    attr_accessor :break_configuration_paid
+
+    # Default shift identifier
+    attr_accessor :default_shift_id
+
+    # Shift configuration identifier
+    attr_accessor :shift_configuration_id
+
+    # Shift identifier
+    attr_accessor :shift_id
+
+    # Day configuration identifier
+    attr_accessor :day_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',
+        :'start_at' => :'start_at',
+        :'end_at' => :'end_at',
+        :'duration' => :'duration',
+        :'break_type' => :'break_type',
+        :'break_configuration_id' => :'break_configuration_id',
+        :'break_configuration_name' => :'break_configuration_name',
+        :'break_configuration_paid' => :'break_configuration_paid',
+        :'default_shift_id' => :'default_shift_id',
+        :'shift_configuration_id' => :'shift_configuration_id',
+        :'shift_id' => :'shift_id',
+        :'day_configuration_id' => :'day_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',
+        :'start_at' => :'String',
+        :'end_at' => :'String',
+        :'duration' => :'Integer',
+        :'break_type' => :'String',
+        :'break_configuration_id' => :'String',
+        :'break_configuration_name' => :'String',
+        :'break_configuration_paid' => :'Boolean',
+        :'default_shift_id' => :'String',
+        :'shift_configuration_id' => :'String',
+        :'shift_id' => :'String',
+        :'day_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::TimePlanningPlannedBreak` 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::TimePlanningPlannedBreak`. 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?(:'start_at')
+        self.start_at = attributes[:'start_at']
+      end
+
+      if attributes.key?(:'end_at')
+        self.end_at = attributes[:'end_at']
+      end
+
+      if attributes.key?(:'duration')
+        self.duration = attributes[:'duration']
+      end
+
+      if attributes.key?(:'break_type')
+        self.break_type = attributes[:'break_type']
+      else
+        self.break_type = nil
+      end
+
+      if attributes.key?(:'break_configuration_id')
+        self.break_configuration_id = attributes[:'break_configuration_id']
+      else
+        self.break_configuration_id = nil
+      end
+
+      if attributes.key?(:'break_configuration_name')
+        self.break_configuration_name = attributes[:'break_configuration_name']
+      else
+        self.break_configuration_name = nil
+      end
+
+      if attributes.key?(:'break_configuration_paid')
+        self.break_configuration_paid = attributes[:'break_configuration_paid']
+      else
+        self.break_configuration_paid = nil
+      end
+
+      if attributes.key?(:'default_shift_id')
+        self.default_shift_id = attributes[:'default_shift_id']
+      end
+
+      if attributes.key?(:'shift_configuration_id')
+        self.shift_configuration_id = attributes[:'shift_configuration_id']
+      end
+
+      if attributes.key?(:'shift_id')
+        self.shift_id = attributes[:'shift_id']
+      end
+
+      if attributes.key?(:'day_configuration_id')
+        self.day_configuration_id = attributes[:'day_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
+
+      if @break_type.nil?
+        invalid_properties.push('invalid value for "break_type", break_type cannot be nil.')
+      end
+
+      if @break_configuration_id.nil?
+        invalid_properties.push('invalid value for "break_configuration_id", break_configuration_id cannot be nil.')
+      end
+
+      if @break_configuration_name.nil?
+        invalid_properties.push('invalid value for "break_configuration_name", break_configuration_name cannot be nil.')
+      end
+
+      if @break_configuration_paid.nil?
+        invalid_properties.push('invalid value for "break_configuration_paid", break_configuration_paid 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 @break_type.nil?
+      break_type_validator = EnumAttributeValidator.new('String', ["flexible", "fixed", "semi_flexible"])
+      return false unless break_type_validator.valid?(@break_type)
+      return false if @break_configuration_id.nil?
+      return false if @break_configuration_name.nil?
+      return false if @break_configuration_paid.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 checking allowed values (enum).
+    # @param [Object] break_type Object to be assigned
+    def break_type=(break_type)
+      validator = EnumAttributeValidator.new('String', ["flexible", "fixed", "semi_flexible"])
+      unless validator.valid?(break_type)
+        fail ArgumentError, "invalid value for \"break_type\", must be one of #{validator.allowable_values}."
+      end
+      @break_type = break_type
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] break_configuration_id Value to be assigned
+    def break_configuration_id=(break_configuration_id)
+      if break_configuration_id.nil?
+        @break_configuration_id = nil
+        return
+      end
+
+      @break_configuration_id = break_configuration_id
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] break_configuration_name Value to be assigned
+    def break_configuration_name=(break_configuration_name)
+      if break_configuration_name.nil?
+        @break_configuration_name = nil
+        return
+      end
+
+      @break_configuration_name = break_configuration_name
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] break_configuration_paid Value to be assigned
+    def break_configuration_paid=(break_configuration_paid)
+      if break_configuration_paid.nil?
+        @break_configuration_paid = nil
+        return
+      end
+
+      @break_configuration_paid = break_configuration_paid
+    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 &&
+          start_at == o.start_at &&
+          end_at == o.end_at &&
+          duration == o.duration &&
+          break_type == o.break_type &&
+          break_configuration_id == o.break_configuration_id &&
+          break_configuration_name == o.break_configuration_name &&
+          break_configuration_paid == o.break_configuration_paid &&
+          default_shift_id == o.default_shift_id &&
+          shift_configuration_id == o.shift_configuration_id &&
+          shift_id == o.shift_id &&
+          day_configuration_id == o.day_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, start_at, end_at, duration, break_type, break_configuration_id, break_configuration_name, break_configuration_paid, default_shift_id, shift_configuration_id, shift_id, day_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/time_planning_planned_breaks_bulk_create_post_request.rb

@@ -0,0 +1,168 @@
+=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 TimePlanningPlannedBreaksBulkCreatePostRequest < ApiModelBase
+    # List of planned breaks to create
+    attr_accessor :planned_breaks
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'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
+      {
+        :'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::TimePlanningPlannedBreaksBulkCreatePostRequest` 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::TimePlanningPlannedBreaksBulkCreatePostRequest`. 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?(:'planned_breaks')
+        if (value = attributes[:'planned_breaks']).is_a?(Array)
+          self.planned_breaks = value
+        end
+      else
+        self.planned_breaks = 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 @planned_breaks.nil?
+        invalid_properties.push('invalid value for "planned_breaks", planned_breaks 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 @planned_breaks.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] planned_breaks Value to be assigned
+    def planned_breaks=(planned_breaks)
+      if planned_breaks.nil?
+        @planned_breaks = nil
+        return
+      end
+
+      @planned_breaks = planned_breaks
+    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 &&
+          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
+      [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

data/lib/factorial_api/models/time_planning_planned_breaks_get200_response.rb

@@ -0,0 +1,158 @@
+=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 TimePlanningPlannedBreaksGet200Response < ApiModelBase
+    attr_accessor :data
+
+    attr_accessor :meta
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'data' => :'data',
+        :'meta' => :'meta'
+      }
+    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
+      {
+        :'data' => :'Array<TimePlanningPlannedBreak>',
+        :'meta' => :'PagedIndexMeta'
+      }
+    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::TimePlanningPlannedBreaksGet200Response` 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::TimePlanningPlannedBreaksGet200Response`. 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?(:'data')
+        if (value = attributes[:'data']).is_a?(Array)
+          self.data = value
+        end
+      end
+
+      if attributes.key?(:'meta')
+        self.meta = attributes[:'meta']
+      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
+      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'
+      true
+    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 &&
+          data == o.data &&
+          meta == o.meta
+    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
+      [data, meta].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