authentik-api 2026.8.0.rc6 → 2026.8.0

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

@@ -0,0 +1,450 @@
+=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 Agent < ApiModelBase
+    attr_accessor :pk
+
+    # Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.
+    attr_accessor :username
+
+    # User's display name.
+    attr_accessor :name
+
+    # Designates whether this user should be treated as active. Unselect this instead of deleting accounts.
+    attr_accessor :is_active
+
+    attr_accessor :last_login
+
+    attr_accessor :email
+
+    attr_accessor :attributes
+
+    attr_accessor :uid
+
+    attr_accessor :uuid
+
+    attr_accessor :expiring
+
+    attr_accessor :expires
+
+    attr_accessor :parent
+
+    attr_accessor :policy_behavior
+
+    # Identifier of the agent's API token, so its key can be retrieved/copied later.
+    attr_accessor :token_identifier
+
+    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
+      {
+        :'pk' => :'pk',
+        :'username' => :'username',
+        :'name' => :'name',
+        :'is_active' => :'is_active',
+        :'last_login' => :'last_login',
+        :'email' => :'email',
+        :'attributes' => :'attributes',
+        :'uid' => :'uid',
+        :'uuid' => :'uuid',
+        :'expiring' => :'expiring',
+        :'expires' => :'expires',
+        :'parent' => :'parent',
+        :'policy_behavior' => :'policy_behavior',
+        :'token_identifier' => :'token_identifier'
+      }
+    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
+      {
+        :'pk' => :'Integer',
+        :'username' => :'String',
+        :'name' => :'String',
+        :'is_active' => :'Boolean',
+        :'last_login' => :'Time',
+        :'email' => :'String',
+        :'attributes' => :'Hash<String, Object>',
+        :'uid' => :'String',
+        :'uuid' => :'String',
+        :'expiring' => :'Boolean',
+        :'expires' => :'Time',
+        :'parent' => :'PartialUser',
+        :'policy_behavior' => :'PolicyBehaviorEnum',
+        :'token_identifier' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'last_login',
+        :'expires',
+        :'token_identifier'
+      ])
+    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::Agent` 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::Agent`. 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?(:'pk')
+        self.pk = attributes[:'pk']
+      else
+        self.pk = nil
+      end
+
+      if attributes.key?(:'username')
+        self.username = attributes[:'username']
+      else
+        self.username = nil
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      else
+        self.name = nil
+      end
+
+      if attributes.key?(:'is_active')
+        self.is_active = attributes[:'is_active']
+      end
+
+      if attributes.key?(:'last_login')
+        self.last_login = attributes[:'last_login']
+      end
+
+      if attributes.key?(:'email')
+        self.email = attributes[:'email']
+      end
+
+      if attributes.key?(:'attributes')
+        if (value = attributes[:'attributes']).is_a?(Hash)
+          self.attributes = value
+        end
+      end
+
+      if attributes.key?(:'uid')
+        self.uid = attributes[:'uid']
+      else
+        self.uid = nil
+      end
+
+      if attributes.key?(:'uuid')
+        self.uuid = attributes[:'uuid']
+      else
+        self.uuid = nil
+      end
+
+      if attributes.key?(:'expiring')
+        self.expiring = attributes[:'expiring']
+      end
+
+      if attributes.key?(:'expires')
+        self.expires = attributes[:'expires']
+      end
+
+      if attributes.key?(:'parent')
+        self.parent = attributes[:'parent']
+      else
+        self.parent = nil
+      end
+
+      if attributes.key?(:'policy_behavior')
+        self.policy_behavior = attributes[:'policy_behavior']
+      else
+        self.policy_behavior = nil
+      end
+
+      if attributes.key?(:'token_identifier')
+        self.token_identifier = attributes[:'token_identifier']
+      else
+        self.token_identifier = 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 @pk.nil?
+        invalid_properties.push('invalid value for "pk", pk cannot be nil.')
+      end
+
+      if @username.nil?
+        invalid_properties.push('invalid value for "username", username cannot be nil.')
+      end
+
+      if @username.to_s.length > 150
+        invalid_properties.push('invalid value for "username", the character length must be smaller than or equal to 150.')
+      end
+
+      pattern = Regexp.new(/^[\w.@+-]+$/)
+      if @username !~ pattern
+        invalid_properties.push("invalid value for \"username\", must conform to the pattern #{pattern}.")
+      end
+
+      if @name.nil?
+        invalid_properties.push('invalid value for "name", name cannot be nil.')
+      end
+
+      if !@email.nil? && @email.to_s.length > 254
+        invalid_properties.push('invalid value for "email", the character length must be smaller than or equal to 254.')
+      end
+
+      if @uid.nil?
+        invalid_properties.push('invalid value for "uid", uid cannot be nil.')
+      end
+
+      if @uuid.nil?
+        invalid_properties.push('invalid value for "uuid", uuid cannot be nil.')
+      end
+
+      if @parent.nil?
+        invalid_properties.push('invalid value for "parent", parent cannot be nil.')
+      end
+
+      if @policy_behavior.nil?
+        invalid_properties.push('invalid value for "policy_behavior", policy_behavior 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 @pk.nil?
+      return false if @username.nil?
+      return false if @username.to_s.length > 150
+      return false if @username !~ Regexp.new(/^[\w.@+-]+$/)
+      return false if @name.nil?
+      return false if !@email.nil? && @email.to_s.length > 254
+      return false if @uid.nil?
+      return false if @uuid.nil?
+      return false if @parent.nil?
+      return false if @policy_behavior.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] pk Value to be assigned
+    def pk=(pk)
+      if pk.nil?
+        fail ArgumentError, 'pk cannot be nil'
+      end
+
+      @pk = pk
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] username Value to be assigned
+    def username=(username)
+      if username.nil?
+        fail ArgumentError, 'username cannot be nil'
+      end
+
+      if username.to_s.length > 150
+        fail ArgumentError, 'invalid value for "username", the character length must be smaller than or equal to 150.'
+      end
+
+      pattern = Regexp.new(/^[\w.@+-]+$/)
+      if username !~ pattern
+        fail ArgumentError, "invalid value for \"username\", must conform to the pattern #{pattern}."
+      end
+
+      @username = username
+    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] email Value to be assigned
+    def email=(email)
+      if email.nil?
+        fail ArgumentError, 'email cannot be nil'
+      end
+
+      if email.to_s.length > 254
+        fail ArgumentError, 'invalid value for "email", the character length must be smaller than or equal to 254.'
+      end
+
+      @email = email
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] uid Value to be assigned
+    def uid=(uid)
+      if uid.nil?
+        fail ArgumentError, 'uid cannot be nil'
+      end
+
+      @uid = uid
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] uuid Value to be assigned
+    def uuid=(uuid)
+      if uuid.nil?
+        fail ArgumentError, 'uuid cannot be nil'
+      end
+
+      @uuid = uuid
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] parent Value to be assigned
+    def parent=(parent)
+      if parent.nil?
+        fail ArgumentError, 'parent cannot be nil'
+      end
+
+      @parent = parent
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] policy_behavior Value to be assigned
+    def policy_behavior=(policy_behavior)
+      if policy_behavior.nil?
+        fail ArgumentError, 'policy_behavior cannot be nil'
+      end
+
+      @policy_behavior = policy_behavior
+    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 &&
+          pk == o.pk &&
+          username == o.username &&
+          name == o.name &&
+          is_active == o.is_active &&
+          last_login == o.last_login &&
+          email == o.email &&
+          attributes == o.attributes &&
+          uid == o.uid &&
+          uuid == o.uuid &&
+          expiring == o.expiring &&
+          expires == o.expires &&
+          parent == o.parent &&
+          policy_behavior == o.policy_behavior &&
+          token_identifier == o.token_identifier
+    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
+      [pk, username, name, is_active, last_login, email, attributes, uid, uuid, expiring, expires, parent, policy_behavior, token_identifier].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/authentik/api/models/agent_create_request.rb

@@ -0,0 +1,203 @@
+=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
+  # Base serializer class which doesn't implement create/update methods
+  class AgentCreateRequest < ApiModelBase
+    attr_accessor :parent
+
+    attr_accessor :label
+
+    attr_accessor :expiring
+
+    attr_accessor :expires
+
+    attr_accessor :policy_behavior
+
+    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
+      {
+        :'parent' => :'parent',
+        :'label' => :'label',
+        :'expiring' => :'expiring',
+        :'expires' => :'expires',
+        :'policy_behavior' => :'policy_behavior'
+      }
+    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
+      {
+        :'parent' => :'Integer',
+        :'label' => :'String',
+        :'expiring' => :'Boolean',
+        :'expires' => :'Time',
+        :'policy_behavior' => :'PolicyBehaviorEnum'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'expires',
+      ])
+    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::AgentCreateRequest` 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::AgentCreateRequest`. 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?(:'parent')
+        self.parent = attributes[:'parent']
+      end
+
+      if attributes.key?(:'label')
+        self.label = attributes[:'label']
+      end
+
+      if attributes.key?(:'expiring')
+        self.expiring = attributes[:'expiring']
+      else
+        self.expiring = false
+      end
+
+      if attributes.key?(:'expires')
+        self.expires = attributes[:'expires']
+      end
+
+      if attributes.key?(:'policy_behavior')
+        self.policy_behavior = attributes[:'policy_behavior']
+      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 &&
+          parent == o.parent &&
+          label == o.label &&
+          expiring == o.expiring &&
+          expires == o.expires &&
+          policy_behavior == o.policy_behavior
+    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
+      [parent, label, expiring, expires, policy_behavior].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