factorial_api 3.0.1

data/lib/factorial_api/models/trainings_session.rb

@@ -0,0 +1,435 @@
+=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 TrainingsSession < ApiModelBase
+    # id of the session
+    attr_accessor :id
+
+    attr_accessor :name
+
+    # Identifier of the course
+    attr_accessor :training_id
+
+    # Session description
+    attr_accessor :description
+
+    # Identifier of the group
+    attr_accessor :training_class_id
+
+    # Date when the session should start
+    attr_accessor :starts_at
+
+    # Date when the session should end
+    attr_accessor :ends_at
+
+    # Date when the session should end
+    attr_accessor :due_date
+
+    # The duration in hours and minutes of the session
+    attr_accessor :duration
+
+    # The mode the session will be handled, online, in person or hybrid.
+    attr_accessor :modality
+
+    # Session schedule information (scheduled, self-paced)
+    attr_accessor :schedule
+
+    # The link to see material from the session
+    attr_accessor :link
+
+    # The place where the session takes place
+    attr_accessor :location
+
+    attr_accessor :session_attendance_ids
+
+    attr_accessor :session_feedback_id
+
+    # if the session is subsidized
+    attr_accessor :subsidized
+
+    # Status of the session
+    attr_accessor :status
+
+    # Id of the recurrent session that is parent of the current one
+    attr_accessor :parent_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',
+        :'name' => :'name',
+        :'training_id' => :'training_id',
+        :'description' => :'description',
+        :'training_class_id' => :'training_class_id',
+        :'starts_at' => :'starts_at',
+        :'ends_at' => :'ends_at',
+        :'due_date' => :'due_date',
+        :'duration' => :'duration',
+        :'modality' => :'modality',
+        :'schedule' => :'schedule',
+        :'link' => :'link',
+        :'location' => :'location',
+        :'session_attendance_ids' => :'session_attendance_ids',
+        :'session_feedback_id' => :'session_feedback_id',
+        :'subsidized' => :'subsidized',
+        :'status' => :'status',
+        :'parent_id' => :'parent_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',
+        :'name' => :'String',
+        :'training_id' => :'String',
+        :'description' => :'String',
+        :'training_class_id' => :'String',
+        :'starts_at' => :'String',
+        :'ends_at' => :'String',
+        :'due_date' => :'String',
+        :'duration' => :'String',
+        :'modality' => :'String',
+        :'schedule' => :'String',
+        :'link' => :'String',
+        :'location' => :'String',
+        :'session_attendance_ids' => :'Array<String>',
+        :'session_feedback_id' => :'String',
+        :'subsidized' => :'Boolean',
+        :'status' => :'String',
+        :'parent_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::TrainingsSession` 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::TrainingsSession`. 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?(:'name')
+        self.name = attributes[:'name']
+      else
+        self.name = nil
+      end
+
+      if attributes.key?(:'training_id')
+        self.training_id = attributes[:'training_id']
+      else
+        self.training_id = nil
+      end
+
+      if attributes.key?(:'description')
+        self.description = attributes[:'description']
+      end
+
+      if attributes.key?(:'training_class_id')
+        self.training_class_id = attributes[:'training_class_id']
+      end
+
+      if attributes.key?(:'starts_at')
+        self.starts_at = attributes[:'starts_at']
+      end
+
+      if attributes.key?(:'ends_at')
+        self.ends_at = attributes[:'ends_at']
+      end
+
+      if attributes.key?(:'due_date')
+        self.due_date = attributes[:'due_date']
+      end
+
+      if attributes.key?(:'duration')
+        self.duration = attributes[:'duration']
+      end
+
+      if attributes.key?(:'modality')
+        self.modality = attributes[:'modality']
+      end
+
+      if attributes.key?(:'schedule')
+        self.schedule = attributes[:'schedule']
+      end
+
+      if attributes.key?(:'link')
+        self.link = attributes[:'link']
+      end
+
+      if attributes.key?(:'location')
+        self.location = attributes[:'location']
+      end
+
+      if attributes.key?(:'session_attendance_ids')
+        if (value = attributes[:'session_attendance_ids']).is_a?(Array)
+          self.session_attendance_ids = value
+        end
+      end
+
+      if attributes.key?(:'session_feedback_id')
+        self.session_feedback_id = attributes[:'session_feedback_id']
+      end
+
+      if attributes.key?(:'subsidized')
+        self.subsidized = attributes[:'subsidized']
+      else
+        self.subsidized = nil
+      end
+
+      if attributes.key?(:'status')
+        self.status = attributes[:'status']
+      end
+
+      if attributes.key?(:'parent_id')
+        self.parent_id = attributes[:'parent_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 @name.nil?
+        invalid_properties.push('invalid value for "name", name cannot be nil.')
+      end
+
+      if @training_id.nil?
+        invalid_properties.push('invalid value for "training_id", training_id cannot be nil.')
+      end
+
+      if @subsidized.nil?
+        invalid_properties.push('invalid value for "subsidized", subsidized 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 @name.nil?
+      return false if @training_id.nil?
+      modality_validator = EnumAttributeValidator.new('String', ["online", "inperson", "mixed"])
+      return false unless modality_validator.valid?(@modality)
+      schedule_validator = EnumAttributeValidator.new('String', ["scheduled", "selfpaced"])
+      return false unless schedule_validator.valid?(@schedule)
+      return false if @subsidized.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] name Value to be assigned
+    def name=(name)
+      if name.nil?
+        @name = nil
+        return
+      end
+
+      @name = name
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] training_id Value to be assigned
+    def training_id=(training_id)
+      if training_id.nil?
+        @training_id = nil
+        return
+      end
+
+      @training_id = training_id
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] modality Object to be assigned
+    def modality=(modality)
+      validator = EnumAttributeValidator.new('String', ["online", "inperson", "mixed"])
+      unless validator.valid?(modality)
+        fail ArgumentError, "invalid value for \"modality\", must be one of #{validator.allowable_values}."
+      end
+      @modality = modality
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] schedule Object to be assigned
+    def schedule=(schedule)
+      validator = EnumAttributeValidator.new('String', ["scheduled", "selfpaced"])
+      unless validator.valid?(schedule)
+        fail ArgumentError, "invalid value for \"schedule\", must be one of #{validator.allowable_values}."
+      end
+      @schedule = schedule
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] subsidized Value to be assigned
+    def subsidized=(subsidized)
+      if subsidized.nil?
+        @subsidized = nil
+        return
+      end
+
+      @subsidized = subsidized
+    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 &&
+          name == o.name &&
+          training_id == o.training_id &&
+          description == o.description &&
+          training_class_id == o.training_class_id &&
+          starts_at == o.starts_at &&
+          ends_at == o.ends_at &&
+          due_date == o.due_date &&
+          duration == o.duration &&
+          modality == o.modality &&
+          schedule == o.schedule &&
+          link == o.link &&
+          location == o.location &&
+          session_attendance_ids == o.session_attendance_ids &&
+          session_feedback_id == o.session_feedback_id &&
+          subsidized == o.subsidized &&
+          status == o.status &&
+          parent_id == o.parent_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, name, training_id, description, training_class_id, starts_at, ends_at, due_date, duration, modality, schedule, link, location, session_attendance_ids, session_feedback_id, subsidized, status, parent_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/trainings_session_access_membership.rb

@@ -0,0 +1,262 @@
+=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 TrainingsSessionAccessMembership < ApiModelBase
+    # ID of this membership
+    attr_accessor :id
+
+    # ID of the access associated with this membership
+    attr_accessor :access_id
+
+    # ID of the employee associated with this membership
+    attr_accessor :employee_id
+
+    # ID of the session associated with this membership
+    attr_accessor :session_id
+
+    # First name of the user associated with this membership
+    attr_accessor :first_name
+
+    # Last name of the user associated with this membership
+    attr_accessor :last_name
+
+    # Job title of the user associated with this membership
+    attr_accessor :job_title
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'id' => :'id',
+        :'access_id' => :'access_id',
+        :'employee_id' => :'employee_id',
+        :'session_id' => :'session_id',
+        :'first_name' => :'first_name',
+        :'last_name' => :'last_name',
+        :'job_title' => :'job_title'
+      }
+    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',
+        :'access_id' => :'String',
+        :'employee_id' => :'String',
+        :'session_id' => :'String',
+        :'first_name' => :'String',
+        :'last_name' => :'String',
+        :'job_title' => :'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::TrainingsSessionAccessMembership` 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::TrainingsSessionAccessMembership`. 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?(:'access_id')
+        self.access_id = attributes[:'access_id']
+      else
+        self.access_id = nil
+      end
+
+      if attributes.key?(:'employee_id')
+        self.employee_id = attributes[:'employee_id']
+      end
+
+      if attributes.key?(:'session_id')
+        self.session_id = attributes[:'session_id']
+      else
+        self.session_id = nil
+      end
+
+      if attributes.key?(:'first_name')
+        self.first_name = attributes[:'first_name']
+      end
+
+      if attributes.key?(:'last_name')
+        self.last_name = attributes[:'last_name']
+      end
+
+      if attributes.key?(:'job_title')
+        self.job_title = attributes[:'job_title']
+      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 @access_id.nil?
+        invalid_properties.push('invalid value for "access_id", access_id cannot be nil.')
+      end
+
+      if @session_id.nil?
+        invalid_properties.push('invalid value for "session_id", session_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?
+      return false if @access_id.nil?
+      return false if @session_id.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] access_id Value to be assigned
+    def access_id=(access_id)
+      if access_id.nil?
+        @access_id = nil
+        return
+      end
+
+      @access_id = access_id
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] session_id Value to be assigned
+    def session_id=(session_id)
+      if session_id.nil?
+        @session_id = nil
+        return
+      end
+
+      @session_id = session_id
+    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 &&
+          access_id == o.access_id &&
+          employee_id == o.employee_id &&
+          session_id == o.session_id &&
+          first_name == o.first_name &&
+          last_name == o.last_name &&
+          job_title == o.job_title
+    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, access_id, employee_id, session_id, first_name, last_name, job_title].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