agentcat-api 0.0.1 → 0.0.3

data/lib/agentcat-api/models/publish_event_request.rb

@@ -0,0 +1,545 @@
+=begin
+#AgentCat API
+
+#API for AgentCat application
+
+The version of the OpenAPI document: v1
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.14.0
+
+=end
+
+require 'date'
+require 'time'
+
+module AgentCatApi
+  class PublishEventRequest
+    # ID of the event, typically auto-generated by the AgentCat Agent
+    attr_accessor :id
+
+    # ID of the project this event belongs to
+    attr_accessor :project_id
+
+    # ID of the session this event belongs to. Null for stateless mode (server assigns session).
+    attr_accessor :session_id
+
+    # Optional actor ID
+    attr_accessor :actor_id
+
+    # Optional custom event ID (must be unique)
+    attr_accessor :event_id
+
+    # Type of event (e.g., mcp:tools/call, agentcat:identify)
+    attr_accessor :event_type
+
+    # Whether this event represents an error
+    attr_accessor :is_error
+
+    # Error details if is_error is true
+    attr_accessor :error
+
+    # Name of the resource accessed (for resource events)
+    attr_accessor :resource_name
+
+    # Duration of the operation in milliseconds
+    attr_accessor :duration
+
+    # Token count of the request side as measured by the SDK. When absent, the server estimates it from the stored parameters.
+    attr_accessor :input_tokens
+
+    # Token count of the response side as measured by the SDK. When absent, the server estimates it from the stored response. Drives the oversized-tool-response rule.
+    attr_accessor :output_tokens
+
+    # Agent-provided timestamp of when the event occurred
+    attr_accessor :timestamp
+
+    # Captured explanation of why the actor made this request
+    attr_accessor :user_intent
+
+    # Parameters sent with the request
+    attr_accessor :parameters
+
+    # Response data from the operation
+    attr_accessor :response
+
+    # Actor ID for agentcat:identify events
+    attr_accessor :identify_actor_given_id
+
+    # Actor name for agentcat:identify events
+    attr_accessor :identify_actor_name
+
+    # Additional data for agentcat:identify events
+    attr_accessor :identify_data
+
+    # Custom string key-value pairs. Keys: max 32 chars, alphanumeric/underscore/period/colon/dash/dollar-sign only. Values: max 200 chars, no newlines. Max 50 entries.
+    attr_accessor :tags
+
+    # Custom structured data. Keys are strings, values can be string, number, boolean, array, object, or null (null values are filtered out).
+    attr_accessor :properties
+
+    # IP address of the client
+    attr_accessor :ip_address
+
+    # Programming language of the SDK used
+    attr_accessor :sdk_language
+
+    # Version of AgentCat being used
+    attr_accessor :agentcat_version
+
+    # Name of the MCP server
+    attr_accessor :server_name
+
+    # Version of the MCP server
+    attr_accessor :server_version
+
+    # Name of the MCP client
+    attr_accessor :client_name
+
+    # Version of the MCP client
+    attr_accessor :client_version
+
+    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',
+        :'project_id' => :'project_id',
+        :'session_id' => :'session_id',
+        :'actor_id' => :'actor_id',
+        :'event_id' => :'event_id',
+        :'event_type' => :'event_type',
+        :'is_error' => :'is_error',
+        :'error' => :'error',
+        :'resource_name' => :'resource_name',
+        :'duration' => :'duration',
+        :'input_tokens' => :'input_tokens',
+        :'output_tokens' => :'output_tokens',
+        :'timestamp' => :'timestamp',
+        :'user_intent' => :'user_intent',
+        :'parameters' => :'parameters',
+        :'response' => :'response',
+        :'identify_actor_given_id' => :'identify_actor_given_id',
+        :'identify_actor_name' => :'identify_actor_name',
+        :'identify_data' => :'identify_data',
+        :'tags' => :'tags',
+        :'properties' => :'properties',
+        :'ip_address' => :'ip_address',
+        :'sdk_language' => :'sdk_language',
+        :'agentcat_version' => :'agentcat_version',
+        :'server_name' => :'server_name',
+        :'server_version' => :'server_version',
+        :'client_name' => :'client_name',
+        :'client_version' => :'client_version'
+      }
+    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',
+        :'project_id' => :'String',
+        :'session_id' => :'String',
+        :'actor_id' => :'String',
+        :'event_id' => :'String',
+        :'event_type' => :'String',
+        :'is_error' => :'Boolean',
+        :'error' => :'Object',
+        :'resource_name' => :'String',
+        :'duration' => :'Integer',
+        :'input_tokens' => :'Integer',
+        :'output_tokens' => :'Integer',
+        :'timestamp' => :'Time',
+        :'user_intent' => :'String',
+        :'parameters' => :'Object',
+        :'response' => :'Object',
+        :'identify_actor_given_id' => :'String',
+        :'identify_actor_name' => :'String',
+        :'identify_data' => :'Object',
+        :'tags' => :'Hash<String, String>',
+        :'properties' => :'Object',
+        :'ip_address' => :'String',
+        :'sdk_language' => :'String',
+        :'agentcat_version' => :'String',
+        :'server_name' => :'String',
+        :'server_version' => :'String',
+        :'client_name' => :'String',
+        :'client_version' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'session_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 `AgentCatApi::PublishEventRequest` 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 `AgentCatApi::PublishEventRequest`. 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']
+      end
+
+      if attributes.key?(:'project_id')
+        self.project_id = attributes[:'project_id']
+      else
+        self.project_id = nil
+      end
+
+      if attributes.key?(:'session_id')
+        self.session_id = attributes[:'session_id']
+      end
+
+      if attributes.key?(:'actor_id')
+        self.actor_id = attributes[:'actor_id']
+      end
+
+      if attributes.key?(:'event_id')
+        self.event_id = attributes[:'event_id']
+      end
+
+      if attributes.key?(:'event_type')
+        self.event_type = attributes[:'event_type']
+      end
+
+      if attributes.key?(:'is_error')
+        self.is_error = attributes[:'is_error']
+      end
+
+      if attributes.key?(:'error')
+        self.error = attributes[:'error']
+      end
+
+      if attributes.key?(:'resource_name')
+        self.resource_name = attributes[:'resource_name']
+      end
+
+      if attributes.key?(:'duration')
+        self.duration = attributes[:'duration']
+      end
+
+      if attributes.key?(:'input_tokens')
+        self.input_tokens = attributes[:'input_tokens']
+      end
+
+      if attributes.key?(:'output_tokens')
+        self.output_tokens = attributes[:'output_tokens']
+      end
+
+      if attributes.key?(:'timestamp')
+        self.timestamp = attributes[:'timestamp']
+      end
+
+      if attributes.key?(:'user_intent')
+        self.user_intent = attributes[:'user_intent']
+      end
+
+      if attributes.key?(:'parameters')
+        self.parameters = attributes[:'parameters']
+      end
+
+      if attributes.key?(:'response')
+        self.response = attributes[:'response']
+      end
+
+      if attributes.key?(:'identify_actor_given_id')
+        self.identify_actor_given_id = attributes[:'identify_actor_given_id']
+      end
+
+      if attributes.key?(:'identify_actor_name')
+        self.identify_actor_name = attributes[:'identify_actor_name']
+      end
+
+      if attributes.key?(:'identify_data')
+        self.identify_data = attributes[:'identify_data']
+      end
+
+      if attributes.key?(:'tags')
+        if (value = attributes[:'tags']).is_a?(Hash)
+          self.tags = value
+        end
+      end
+
+      if attributes.key?(:'properties')
+        self.properties = attributes[:'properties']
+      end
+
+      if attributes.key?(:'ip_address')
+        self.ip_address = attributes[:'ip_address']
+      end
+
+      if attributes.key?(:'sdk_language')
+        self.sdk_language = attributes[:'sdk_language']
+      end
+
+      if attributes.key?(:'agentcat_version')
+        self.agentcat_version = attributes[:'agentcat_version']
+      end
+
+      if attributes.key?(:'server_name')
+        self.server_name = attributes[:'server_name']
+      end
+
+      if attributes.key?(:'server_version')
+        self.server_version = attributes[:'server_version']
+      end
+
+      if attributes.key?(:'client_name')
+        self.client_name = attributes[:'client_name']
+      end
+
+      if attributes.key?(:'client_version')
+        self.client_version = attributes[:'client_version']
+      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 @project_id.nil?
+        invalid_properties.push('invalid value for "project_id", project_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 @project_id.nil?
+      event_type_validator = EnumAttributeValidator.new('String', ["mcp:ping", "mcp:initialize", "mcp:completion/complete", "mcp:logging/setLevel", "mcp:prompts/get", "mcp:prompts/list", "mcp:resources/list", "mcp:resources/templates/list", "mcp:resources/read", "mcp:resources/subscribe", "mcp:resources/unsubscribe", "mcp:tools/call", "mcp:tools/list", "mcp:tasks/get", "mcp:tasks/result", "mcp:tasks/list", "mcp:tasks/cancel", "agentcat:identify"])
+      return false unless event_type_validator.valid?(@event_type)
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] project_id Value to be assigned
+    def project_id=(project_id)
+      if project_id.nil?
+        fail ArgumentError, 'project_id cannot be nil'
+      end
+
+      @project_id = project_id
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] event_type Object to be assigned
+    def event_type=(event_type)
+      validator = EnumAttributeValidator.new('String', ["mcp:ping", "mcp:initialize", "mcp:completion/complete", "mcp:logging/setLevel", "mcp:prompts/get", "mcp:prompts/list", "mcp:resources/list", "mcp:resources/templates/list", "mcp:resources/read", "mcp:resources/subscribe", "mcp:resources/unsubscribe", "mcp:tools/call", "mcp:tools/list", "mcp:tasks/get", "mcp:tasks/result", "mcp:tasks/list", "mcp:tasks/cancel", "agentcat:identify"])
+      unless validator.valid?(event_type)
+        fail ArgumentError, "invalid value for \"event_type\", must be one of #{validator.allowable_values}."
+      end
+      @event_type = event_type
+    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 &&
+          project_id == o.project_id &&
+          session_id == o.session_id &&
+          actor_id == o.actor_id &&
+          event_id == o.event_id &&
+          event_type == o.event_type &&
+          is_error == o.is_error &&
+          error == o.error &&
+          resource_name == o.resource_name &&
+          duration == o.duration &&
+          input_tokens == o.input_tokens &&
+          output_tokens == o.output_tokens &&
+          timestamp == o.timestamp &&
+          user_intent == o.user_intent &&
+          parameters == o.parameters &&
+          response == o.response &&
+          identify_actor_given_id == o.identify_actor_given_id &&
+          identify_actor_name == o.identify_actor_name &&
+          identify_data == o.identify_data &&
+          tags == o.tags &&
+          properties == o.properties &&
+          ip_address == o.ip_address &&
+          sdk_language == o.sdk_language &&
+          agentcat_version == o.agentcat_version &&
+          server_name == o.server_name &&
+          server_version == o.server_version &&
+          client_name == o.client_name &&
+          client_version == o.client_version
+    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, project_id, session_id, actor_id, event_id, event_type, is_error, error, resource_name, duration, input_tokens, output_tokens, timestamp, user_intent, parameters, response, identify_actor_given_id, identify_actor_name, identify_data, tags, properties, ip_address, sdk_language, agentcat_version, server_name, server_version, client_name, client_version].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
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def self._deserialize(type, value)
+      case type.to_sym
+      when :Time
+        Time.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        # models (e.g. Pet) or oneOf
+        klass = AgentCatApi.const_get(type)
+        klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_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
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+
+end