authentik-api 2025.12.4 → 2026.2.1.1

data/lib/authentik/api/models/lifecycle_iteration_state_enum.rb

@@ -0,0 +1,36 @@
+=begin
+This file is automatically generated by: https://openapi-generator.tech.
+Any manual changes will be lost when the OpenAPI scheme changes.
+
+=end
+
+require 'date'
+require 'time'
+
+module Authentik::Api
+  class LifecycleIterationStateEnum
+    REVIEWED = "REVIEWED".freeze
+    PENDING = "PENDING".freeze
+    OVERDUE = "OVERDUE".freeze
+    CANCELED = "CANCELED".freeze
+
+    def self.all_vars
+      @all_vars ||= [REVIEWED, PENDING, OVERDUE, CANCELED].freeze
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def self.build_from_hash(value)
+      new.build_from_hash(value)
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def build_from_hash(value)
+      return value if LifecycleIterationStateEnum.all_vars.include?(value)
+      raise "Invalid ENUM value #{value} for class #LifecycleIterationStateEnum"
+    end
+  end
+end

data/lib/authentik/api/models/lifecycle_rule.rb

@@ -0,0 +1,440 @@
+=begin
+This file is automatically generated by: https://openapi-generator.tech.
+Any manual changes will be lost when the OpenAPI scheme changes.
+
+=end
+
+require 'date'
+require 'time'
+
+module Authentik::Api
+  # Mixin to validate that a valid enterprise license exists before allowing to save the object
+  class LifecycleRule < ApiModelBase
+    attr_accessor :id
+
+    attr_accessor :name
+
+    attr_accessor :content_type
+
+    attr_accessor :obj_id
+
+    attr_accessor :interval
+
+    attr_accessor :grace_period
+
+    attr_accessor :reviewer_groups
+
+    attr_accessor :reviewer_groups_obj
+
+    attr_accessor :min_reviewers
+
+    attr_accessor :min_reviewers_is_per_group
+
+    attr_accessor :reviewers
+
+    attr_accessor :reviewers_obj
+
+    # Select which transports should be used to notify the reviewers. If none are selected, the notification will only be shown in the authentik UI.
+    attr_accessor :notification_transports
+
+    attr_accessor :target_verbose
+
+    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',
+        :'content_type' => :'content_type',
+        :'obj_id' => :'object_id',
+        :'interval' => :'interval',
+        :'grace_period' => :'grace_period',
+        :'reviewer_groups' => :'reviewer_groups',
+        :'reviewer_groups_obj' => :'reviewer_groups_obj',
+        :'min_reviewers' => :'min_reviewers',
+        :'min_reviewers_is_per_group' => :'min_reviewers_is_per_group',
+        :'reviewers' => :'reviewers',
+        :'reviewers_obj' => :'reviewers_obj',
+        :'notification_transports' => :'notification_transports',
+        :'target_verbose' => :'target_verbose'
+      }
+    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',
+        :'content_type' => :'ContentTypeEnum',
+        :'obj_id' => :'String',
+        :'interval' => :'String',
+        :'grace_period' => :'String',
+        :'reviewer_groups' => :'Array<String>',
+        :'reviewer_groups_obj' => :'Array<ReviewerGroup>',
+        :'min_reviewers' => :'Integer',
+        :'min_reviewers_is_per_group' => :'Boolean',
+        :'reviewers' => :'Array<String>',
+        :'reviewers_obj' => :'Array<ReviewerUser>',
+        :'notification_transports' => :'Array<String>',
+        :'target_verbose' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'obj_id',
+      ])
+    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 `Authentik::Api::LifecycleRule` 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 `Authentik::Api::LifecycleRule`. 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?(:'content_type')
+        self.content_type = attributes[:'content_type']
+      else
+        self.content_type = nil
+      end
+
+      if attributes.key?(:'obj_id')
+        self.obj_id = attributes[:'obj_id']
+      end
+
+      if attributes.key?(:'interval')
+        self.interval = attributes[:'interval']
+      end
+
+      if attributes.key?(:'grace_period')
+        self.grace_period = attributes[:'grace_period']
+      end
+
+      if attributes.key?(:'reviewer_groups')
+        if (value = attributes[:'reviewer_groups']).is_a?(Array)
+          self.reviewer_groups = value
+        end
+      end
+
+      if attributes.key?(:'reviewer_groups_obj')
+        if (value = attributes[:'reviewer_groups_obj']).is_a?(Array)
+          self.reviewer_groups_obj = value
+        end
+      else
+        self.reviewer_groups_obj = nil
+      end
+
+      if attributes.key?(:'min_reviewers')
+        self.min_reviewers = attributes[:'min_reviewers']
+      end
+
+      if attributes.key?(:'min_reviewers_is_per_group')
+        self.min_reviewers_is_per_group = attributes[:'min_reviewers_is_per_group']
+      end
+
+      if attributes.key?(:'reviewers')
+        if (value = attributes[:'reviewers']).is_a?(Array)
+          self.reviewers = value
+        end
+      else
+        self.reviewers = nil
+      end
+
+      if attributes.key?(:'reviewers_obj')
+        if (value = attributes[:'reviewers_obj']).is_a?(Array)
+          self.reviewers_obj = value
+        end
+      else
+        self.reviewers_obj = nil
+      end
+
+      if attributes.key?(:'notification_transports')
+        if (value = attributes[:'notification_transports']).is_a?(Array)
+          self.notification_transports = value
+        end
+      end
+
+      if attributes.key?(:'target_verbose')
+        self.target_verbose = attributes[:'target_verbose']
+      else
+        self.target_verbose = 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 @name.nil?
+        invalid_properties.push('invalid value for "name", name cannot be nil.')
+      end
+
+      if @content_type.nil?
+        invalid_properties.push('invalid value for "content_type", content_type cannot be nil.')
+      end
+
+      if @reviewer_groups_obj.nil?
+        invalid_properties.push('invalid value for "reviewer_groups_obj", reviewer_groups_obj cannot be nil.')
+      end
+
+      if !@min_reviewers.nil? && @min_reviewers > 32767
+        invalid_properties.push('invalid value for "min_reviewers", must be smaller than or equal to 32767.')
+      end
+
+      if !@min_reviewers.nil? && @min_reviewers < 0
+        invalid_properties.push('invalid value for "min_reviewers", must be greater than or equal to 0.')
+      end
+
+      if @reviewers.nil?
+        invalid_properties.push('invalid value for "reviewers", reviewers cannot be nil.')
+      end
+
+      if @reviewers_obj.nil?
+        invalid_properties.push('invalid value for "reviewers_obj", reviewers_obj cannot be nil.')
+      end
+
+      if @target_verbose.nil?
+        invalid_properties.push('invalid value for "target_verbose", target_verbose 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 @content_type.nil?
+      return false if @reviewer_groups_obj.nil?
+      return false if !@min_reviewers.nil? && @min_reviewers > 32767
+      return false if !@min_reviewers.nil? && @min_reviewers < 0
+      return false if @reviewers.nil?
+      return false if @reviewers_obj.nil?
+      return false if @target_verbose.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] id Value to be assigned
+    def id=(id)
+      if id.nil?
+        fail ArgumentError, 'id cannot be nil'
+      end
+
+      @id = id
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] name Value to be assigned
+    def name=(name)
+      if name.nil?
+        fail ArgumentError, 'name cannot be nil'
+      end
+
+      @name = name
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] content_type Value to be assigned
+    def content_type=(content_type)
+      if content_type.nil?
+        fail ArgumentError, 'content_type cannot be nil'
+      end
+
+      @content_type = content_type
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] reviewer_groups_obj Value to be assigned
+    def reviewer_groups_obj=(reviewer_groups_obj)
+      if reviewer_groups_obj.nil?
+        fail ArgumentError, 'reviewer_groups_obj cannot be nil'
+      end
+
+      @reviewer_groups_obj = reviewer_groups_obj
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] min_reviewers Value to be assigned
+    def min_reviewers=(min_reviewers)
+      if min_reviewers.nil?
+        fail ArgumentError, 'min_reviewers cannot be nil'
+      end
+
+      if min_reviewers > 32767
+        fail ArgumentError, 'invalid value for "min_reviewers", must be smaller than or equal to 32767.'
+      end
+
+      if min_reviewers < 0
+        fail ArgumentError, 'invalid value for "min_reviewers", must be greater than or equal to 0.'
+      end
+
+      @min_reviewers = min_reviewers
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] reviewers Value to be assigned
+    def reviewers=(reviewers)
+      if reviewers.nil?
+        fail ArgumentError, 'reviewers cannot be nil'
+      end
+
+      @reviewers = reviewers
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] reviewers_obj Value to be assigned
+    def reviewers_obj=(reviewers_obj)
+      if reviewers_obj.nil?
+        fail ArgumentError, 'reviewers_obj cannot be nil'
+      end
+
+      @reviewers_obj = reviewers_obj
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] target_verbose Value to be assigned
+    def target_verbose=(target_verbose)
+      if target_verbose.nil?
+        fail ArgumentError, 'target_verbose cannot be nil'
+      end
+
+      @target_verbose = target_verbose
+    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 &&
+          content_type == o.content_type &&
+          obj_id == o.obj_id &&
+          interval == o.interval &&
+          grace_period == o.grace_period &&
+          reviewer_groups == o.reviewer_groups &&
+          reviewer_groups_obj == o.reviewer_groups_obj &&
+          min_reviewers == o.min_reviewers &&
+          min_reviewers_is_per_group == o.min_reviewers_is_per_group &&
+          reviewers == o.reviewers &&
+          reviewers_obj == o.reviewers_obj &&
+          notification_transports == o.notification_transports &&
+          target_verbose == o.target_verbose
+    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, content_type, obj_id, interval, grace_period, reviewer_groups, reviewer_groups_obj, min_reviewers, min_reviewers_is_per_group, reviewers, reviewers_obj, notification_transports, target_verbose].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