apologist 1.0.2

data/lib/Apologist/types/webhook_notification_ref.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Apologist
+  module Types
+    # The notification configuration that produced this delivery.
+    class WebhookNotificationRef < Internal::Types::Model
+      field :id, -> { Integer }, optional: false, nullable: false
+
+      field :name, -> { String }, optional: false, nullable: false
+    end
+  end
+end

data/lib/Apologist/types/webhook_payload.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Apologist
+  module Types
+    # Canonical JSON body POSTed to a configured webhook URL. `notification`, `event`, and `agent` are always present;
+    # the remaining sections appear only when relevant to the event. Treat the payload as additive and ignore
+    # unrecognised fields.
+    class WebhookPayload < Internal::Types::Model
+      field :notification, -> { Apologist::Types::WebhookNotificationRef }, optional: false, nullable: false
+
+      field :event, -> { Apologist::Types::WebhookEventInfo }, optional: false, nullable: false
+
+      field :agent, -> { Apologist::Types::WebhookAgentRef }, optional: false, nullable: false
+
+      field :completion, -> { Internal::Types::Hash[String, Object] }, optional: true, nullable: false
+
+      field :channel, -> { Apologist::Types::WebhookNamedRef }, optional: true, nullable: false
+
+      field :platform, -> { Apologist::Types::WebhookNamedRef }, optional: true, nullable: false
+
+      field :cta, -> { Apologist::Types::WebhookCta }, optional: true, nullable: false
+
+      field :guardrail, -> { Apologist::Types::WebhookNamedRef }, optional: true, nullable: false
+
+      field :evaluator, -> { Apologist::Types::WebhookNamedRef }, optional: true, nullable: false
+
+      field :evaluation, -> { Apologist::Types::WebhookEvaluation }, optional: true, nullable: false
+    end
+  end
+end

data/lib/Apologist/users/client.rb

@@ -0,0 +1,193 @@
+# frozen_string_literal: true
+
+module Apologist
+  module Users
+    class Client
+      # @param client [Apologist::Internal::Http::RawClient]
+      #
+      # @return [void]
+      def initialize(client:)
+        @client = client
+      end
+
+      # Returns a paginated list of users for the agent's team, with applied tags expanded as { id, name } and the
+      # persisted responder id.
+      #
+      # @param request_options [Hash]
+      # @param params [Hash]
+      # @option request_options [String] :base_url
+      # @option request_options [Hash{String => Object}] :additional_headers
+      # @option request_options [Hash{String => Object}] :additional_query_parameters
+      # @option request_options [Hash{String => Object}] :additional_body_parameters
+      # @option request_options [Integer] :timeout_in_seconds
+      # @option params [Integer, nil] :page
+      # @option params [Integer, nil] :per_page
+      # @option params [String, nil] :external_id
+      # @option params [String, nil] :tags
+      # @option params [String, nil] :responder_id
+      # @option params [String, nil] :min_timestamp
+      # @option params [String, nil] :max_timestamp
+      #
+      # @example
+      #   client.users.list_users
+      #
+      # @return [Apologist::Users::Types::ListUsersResponse]
+      def list_users(request_options: {}, **params)
+        params = Apologist::Internal::Types::Utils.normalize_keys(params)
+        query_params = {}
+        query_params["page"] = params[:page] if params.key?(:page)
+        query_params["per_page"] = params[:per_page] if params.key?(:per_page)
+        query_params["external_id"] = params[:external_id] if params.key?(:external_id)
+        query_params["tags"] = params[:tags] if params.key?(:tags)
+        query_params["responder_id"] = params[:responder_id] if params.key?(:responder_id)
+        query_params["min_timestamp"] = params[:min_timestamp] if params.key?(:min_timestamp)
+        query_params["max_timestamp"] = params[:max_timestamp] if params.key?(:max_timestamp)
+
+        request = Apologist::Internal::JSON::Request.new(
+          base_url: request_options[:base_url],
+          method: "GET",
+          path: "users",
+          query: query_params,
+          request_options: request_options
+        )
+        begin
+          response = @client.send(request)
+        rescue Net::HTTPRequestTimeout
+          raise Apologist::Errors::TimeoutError
+        end
+        code = response.code.to_i
+        if code.between?(200, 299)
+          Apologist::Users::Types::ListUsersResponse.load(response.body)
+        else
+          error_class = Apologist::Errors::ResponseError.subclass_for_code(code)
+          raise error_class.new(response.body, code: code)
+        end
+      end
+
+      # Returns a paginated list of user flag definitions for the agent's team (all columns from user_flags), ordered by
+      # id ascending.
+      #
+      # @param request_options [Hash]
+      # @param params [Hash]
+      # @option request_options [String] :base_url
+      # @option request_options [Hash{String => Object}] :additional_headers
+      # @option request_options [Hash{String => Object}] :additional_query_parameters
+      # @option request_options [Hash{String => Object}] :additional_body_parameters
+      # @option request_options [Integer] :timeout_in_seconds
+      # @option params [Integer, nil] :page
+      # @option params [Integer, nil] :per_page
+      #
+      # @example
+      #   client.users.list_user_flags
+      #
+      # @return [Apologist::Users::Types::ListUserFlagsResponse]
+      def list_user_flags(request_options: {}, **params)
+        params = Apologist::Internal::Types::Utils.normalize_keys(params)
+        query_params = {}
+        query_params["page"] = params[:page] if params.key?(:page)
+        query_params["per_page"] = params[:per_page] if params.key?(:per_page)
+
+        request = Apologist::Internal::JSON::Request.new(
+          base_url: request_options[:base_url],
+          method: "GET",
+          path: "users/flags",
+          query: query_params,
+          request_options: request_options
+        )
+        begin
+          response = @client.send(request)
+        rescue Net::HTTPRequestTimeout
+          raise Apologist::Errors::TimeoutError
+        end
+        code = response.code.to_i
+        if code.between?(200, 299)
+          Apologist::Users::Types::ListUserFlagsResponse.load(response.body)
+        else
+          error_class = Apologist::Errors::ResponseError.subclass_for_code(code)
+          raise error_class.new(response.body, code: code)
+        end
+      end
+
+      # Returns a single user by external id or internal id, with expanded tags and the persisted responder for the
+      # agent.
+      #
+      # @param request_options [Hash]
+      # @param params [Hash]
+      # @option request_options [String] :base_url
+      # @option request_options [Hash{String => Object}] :additional_headers
+      # @option request_options [Hash{String => Object}] :additional_query_parameters
+      # @option request_options [Hash{String => Object}] :additional_body_parameters
+      # @option request_options [Integer] :timeout_in_seconds
+      # @option params [String] :user_id
+      #
+      # @example
+      #   client.users.get_user(user_id: "user_id")
+      #
+      # @return [Apologist::Users::Types::GetUserResponse]
+      def get_user(request_options: {}, **params)
+        params = Apologist::Internal::Types::Utils.normalize_keys(params)
+        request = Apologist::Internal::JSON::Request.new(
+          base_url: request_options[:base_url],
+          method: "GET",
+          path: "users/#{URI.encode_uri_component(params[:user_id].to_s)}",
+          request_options: request_options
+        )
+        begin
+          response = @client.send(request)
+        rescue Net::HTTPRequestTimeout
+          raise Apologist::Errors::TimeoutError
+        end
+        code = response.code.to_i
+        if code.between?(200, 299)
+          Apologist::Users::Types::GetUserResponse.load(response.body)
+        else
+          error_class = Apologist::Errors::ResponseError.subclass_for_code(code)
+          raise error_class.new(response.body, code: code)
+        end
+      end
+
+      # Updates a user's external_id and/or tags and upserts the persisted responder for the agent. Only provided fields
+      # are changed.
+      #
+      # @param request_options [Hash]
+      # @param params [Apologist::Users::Types::UserUpdateRequest]
+      # @option request_options [String] :base_url
+      # @option request_options [Hash{String => Object}] :additional_headers
+      # @option request_options [Hash{String => Object}] :additional_query_parameters
+      # @option request_options [Hash{String => Object}] :additional_body_parameters
+      # @option request_options [Integer] :timeout_in_seconds
+      # @option params [String] :user_id
+      #
+      # @example
+      #   client.users.update_user(user_id: "user_id")
+      #
+      # @return [Apologist::Users::Types::UpdateUserResponse]
+      def update_user(request_options: {}, **params)
+        params = Apologist::Internal::Types::Utils.normalize_keys(params)
+        request_data = Apologist::Users::Types::UserUpdateRequest.new(params).to_h
+        non_body_param_names = %w[user_id]
+        body = request_data.except(*non_body_param_names)
+
+        request = Apologist::Internal::JSON::Request.new(
+          base_url: request_options[:base_url],
+          method: "PATCH",
+          path: "users/#{URI.encode_uri_component(params[:user_id].to_s)}",
+          body: body,
+          request_options: request_options
+        )
+        begin
+          response = @client.send(request)
+        rescue Net::HTTPRequestTimeout
+          raise Apologist::Errors::TimeoutError
+        end
+        code = response.code.to_i
+        if code.between?(200, 299)
+          Apologist::Users::Types::UpdateUserResponse.load(response.body)
+        else
+          error_class = Apologist::Errors::ResponseError.subclass_for_code(code)
+          raise error_class.new(response.body, code: code)
+        end
+      end
+    end
+  end
+end

data/lib/Apologist/users/types/get_user_request.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Apologist
+  module Users
+    module Types
+      class GetUserRequest < Internal::Types::Model
+        field :user_id, -> { String }, optional: false, nullable: false
+      end
+    end
+  end
+end

data/lib/Apologist/users/types/get_user_response.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Apologist
+  module Users
+    module Types
+      class GetUserResponse < Internal::Types::Model
+        field :data, -> { Apologist::Types::User }, optional: true, nullable: false
+      end
+    end
+  end
+end

data/lib/Apologist/users/types/list_user_flags_request.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Apologist
+  module Users
+    module Types
+      class ListUserFlagsRequest < Internal::Types::Model
+        field :page, -> { Integer }, optional: true, nullable: false
+
+        field :per_page, -> { Integer }, optional: true, nullable: false
+      end
+    end
+  end
+end

data/lib/Apologist/users/types/list_user_flags_response.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Apologist
+  module Users
+    module Types
+      class ListUserFlagsResponse < Internal::Types::Model
+        field :data, -> { Internal::Types::Array[Apologist::Types::UserFlag] }, optional: true, nullable: false
+
+        field :total, -> { Integer }, optional: true, nullable: false
+
+        field :page, -> { Integer }, optional: true, nullable: false
+
+        field :per_page, -> { Integer }, optional: true, nullable: false
+      end
+    end
+  end
+end

data/lib/Apologist/users/types/list_users_request.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Apologist
+  module Users
+    module Types
+      class ListUsersRequest < Internal::Types::Model
+        field :page, -> { Integer }, optional: true, nullable: false
+
+        field :per_page, -> { Integer }, optional: true, nullable: false
+
+        field :external_id, -> { String }, optional: true, nullable: false
+
+        field :tags, -> { String }, optional: true, nullable: false
+
+        field :responder_id, -> { String }, optional: true, nullable: false
+
+        field :min_timestamp, -> { String }, optional: true, nullable: false
+
+        field :max_timestamp, -> { String }, optional: true, nullable: false
+      end
+    end
+  end
+end

data/lib/Apologist/users/types/list_users_response.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Apologist
+  module Users
+    module Types
+      class ListUsersResponse < Internal::Types::Model
+        field :data, -> { Internal::Types::Array[Apologist::Types::User] }, optional: true, nullable: false
+
+        field :total, -> { Integer }, optional: true, nullable: false
+
+        field :page, -> { Integer }, optional: true, nullable: false
+
+        field :per_page, -> { Integer }, optional: true, nullable: false
+      end
+    end
+  end
+end

data/lib/Apologist/users/types/update_user_response.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Apologist
+  module Users
+    module Types
+      class UpdateUserResponse < Internal::Types::Model
+        field :data, -> { Apologist::Types::User }, optional: true, nullable: false
+      end
+    end
+  end
+end

data/lib/Apologist/users/types/user_update_request.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Apologist
+  module Users
+    module Types
+      class UserUpdateRequest < Internal::Types::Model
+        field :user_id, -> { String }, optional: false, nullable: false
+
+        field :external_id, -> { String }, optional: true, nullable: false
+
+        field :tags, -> { Internal::Types::Array[Apologist::Users::Types::UserUpdateRequestTagsItem] }, optional: true, nullable: false
+
+        field :responder_id, -> { Integer }, optional: true, nullable: false
+      end
+    end
+  end
+end

data/lib/Apologist/users/types/user_update_request_tags_item.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Apologist
+  module Users
+    module Types
+      class UserUpdateRequestTagsItem < Internal::Types::Model
+        extend Apologist::Internal::Types::Union
+
+        member -> { String }
+
+        member -> { Integer }
+      end
+    end
+  end
+end

data/lib/Apologist/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Apologist
+  VERSION = "1.0.2"
+end

data/lib/Apologist.rb

@@ -0,0 +1,131 @@
+# frozen_string_literal: true
+
+require "json"
+require "net/http"
+require "securerandom"
+
+require_relative "Apologist/internal/json/serializable"
+require_relative "Apologist/internal/types/type"
+require_relative "Apologist/internal/types/utils"
+require_relative "Apologist/internal/types/union"
+require_relative "Apologist/internal/errors/constraint_error"
+require_relative "Apologist/internal/errors/type_error"
+require_relative "Apologist/internal/http/base_request"
+require_relative "Apologist/internal/json/request"
+require_relative "Apologist/internal/http/raw_client"
+require_relative "Apologist/internal/multipart/multipart_encoder"
+require_relative "Apologist/internal/multipart/multipart_form_data_part"
+require_relative "Apologist/internal/multipart/multipart_form_data"
+require_relative "Apologist/internal/multipart/multipart_request"
+require_relative "Apologist/internal/types/model/field"
+require_relative "Apologist/internal/types/model"
+require_relative "Apologist/internal/types/array"
+require_relative "Apologist/internal/types/boolean"
+require_relative "Apologist/internal/types/enum"
+require_relative "Apologist/internal/types/hash"
+require_relative "Apologist/internal/types/unknown"
+require_relative "Apologist/errors/api_error"
+require_relative "Apologist/errors/response_error"
+require_relative "Apologist/errors/client_error"
+require_relative "Apologist/errors/redirect_error"
+require_relative "Apologist/errors/server_error"
+require_relative "Apologist/errors/timeout_error"
+require_relative "Apologist/internal/iterators/item_iterator"
+require_relative "Apologist/internal/iterators/cursor_item_iterator"
+require_relative "Apologist/internal/iterators/offset_item_iterator"
+require_relative "Apologist/internal/iterators/cursor_page_iterator"
+require_relative "Apologist/internal/iterators/offset_page_iterator"
+require_relative "Apologist/internal/url_encoded/request"
+require_relative "Apologist/chat/types/list_chat_completions_response"
+require_relative "Apologist/chat/types/get_chat_completion_response"
+require_relative "Apologist/corpus/types/corpus_search_request_filters"
+require_relative "Apologist/corpus/types/search_corpus_response"
+require_relative "Apologist/evaluators/types/list_evaluations_response"
+require_relative "Apologist/evaluators/types/evaluator_request_content"
+require_relative "Apologist/evaluators/types/evaluator_request_reasoning_effort"
+require_relative "Apologist/evaluators/types/evaluator_request_verbosity"
+require_relative "Apologist/evaluators/types/evaluate_content_response"
+require_relative "Apologist/evaluators/types/get_evaluation_response"
+require_relative "Apologist/ct_as/types/match_ctas_response"
+require_relative "Apologist/types/tag_ref"
+require_relative "Apologist/types/user"
+require_relative "Apologist/users/types/list_users_response"
+require_relative "Apologist/types/user_flag"
+require_relative "Apologist/users/types/list_user_flags_response"
+require_relative "Apologist/users/types/get_user_response"
+require_relative "Apologist/users/types/user_update_request_tags_item"
+require_relative "Apologist/users/types/update_user_response"
+require_relative "Apologist/benchmarks/types/list_benchmark_runs_response"
+require_relative "Apologist/benchmarks/types/benchmark_run_request_content"
+require_relative "Apologist/benchmarks/types/benchmark_run_request_reasoning_effort"
+require_relative "Apologist/benchmarks/types/benchmark_run_request_verbosity"
+require_relative "Apologist/benchmarks/types/get_benchmark_run_response"
+require_relative "Apologist/channels/types/get_discord_channel_status_response"
+require_relative "Apologist/channels/types/verify_facebook_webhook_request_hub_mode"
+require_relative "Apologist/shares/types/get_shared_messages_response"
+require_relative "Apologist/types/error"
+require_relative "Apologist/types/success_response"
+require_relative "Apologist/types/chat_message_role"
+require_relative "Apologist/types/chat_message"
+require_relative "Apologist/types/chat_completion_request_logprobs"
+require_relative "Apologist/types/chat_completion_request_metadata"
+require_relative "Apologist/types/chat_completion_request_reasoning_effort"
+require_relative "Apologist/types/chat_completion_request_verbosity"
+require_relative "Apologist/types/chat_completion_request_response_format_type"
+require_relative "Apologist/types/chat_completion_request_response_format_json_schema"
+require_relative "Apologist/types/chat_completion_request_response_format"
+require_relative "Apologist/types/chat_completion_request_tool_choice_zero"
+require_relative "Apologist/types/chat_completion_request_tool_choice"
+require_relative "Apologist/types/chat_completion_request"
+require_relative "Apologist/types/chat_completion_response_choices_item"
+require_relative "Apologist/types/chat_completion_response_usage"
+require_relative "Apologist/types/chat_completion_response"
+require_relative "Apologist/types/cta_match_request"
+require_relative "Apologist/types/webhook_notification_ref"
+require_relative "Apologist/types/webhook_event_info_key"
+require_relative "Apologist/types/webhook_event_info"
+require_relative "Apologist/types/webhook_agent_ref"
+require_relative "Apologist/types/webhook_named_ref"
+require_relative "Apologist/types/webhook_cta"
+require_relative "Apologist/types/webhook_evaluation"
+require_relative "Apologist/types/webhook_payload"
+require_relative "Apologist/client"
+require_relative "Apologist/chat/client"
+require_relative "Apologist/chat/types/list_chat_completions_request"
+require_relative "Apologist/chat/types/like_request"
+require_relative "Apologist/chat/types/flag_request"
+require_relative "Apologist/chat/types/feedback_request"
+require_relative "Apologist/chat/types/share_request"
+require_relative "Apologist/chat/types/get_chat_completion_request"
+require_relative "Apologist/corpus/client"
+require_relative "Apologist/corpus/types/corpus_search_request"
+require_relative "Apologist/corpus/types/view_request"
+require_relative "Apologist/corpus/types/impression_request"
+require_relative "Apologist/corpus/types/log_corpus_referral_redirect_request"
+require_relative "Apologist/corpus/types/referral_request"
+require_relative "Apologist/evaluators/client"
+require_relative "Apologist/evaluators/types/list_evaluations_request"
+require_relative "Apologist/evaluators/types/evaluator_request"
+require_relative "Apologist/evaluators/types/get_evaluation_request"
+require_relative "Apologist/ct_as/client"
+require_relative "Apologist/ct_as/types/cta_click_request"
+require_relative "Apologist/users/client"
+require_relative "Apologist/users/types/list_users_request"
+require_relative "Apologist/users/types/list_user_flags_request"
+require_relative "Apologist/users/types/get_user_request"
+require_relative "Apologist/users/types/user_update_request"
+require_relative "Apologist/benchmarks/client"
+require_relative "Apologist/benchmarks/types/list_benchmark_runs_request"
+require_relative "Apologist/benchmarks/types/benchmark_run_request"
+require_relative "Apologist/benchmarks/types/get_benchmark_run_request"
+require_relative "Apologist/channels/client"
+require_relative "Apologist/channels/types/get_discord_channel_status_request"
+require_relative "Apologist/channels/types/receive_discord_interaction_request"
+require_relative "Apologist/channels/types/verify_facebook_webhook_request"
+require_relative "Apologist/channels/types/receive_facebook_message_request"
+require_relative "Apologist/channels/types/get_instagram_privacy_policy_request"
+require_relative "Apologist/channels/types/receive_telegram_update_request"
+require_relative "Apologist/channels/types/receive_twilio_message_request"
+require_relative "Apologist/shares/client"
+require_relative "Apologist/shares/types/get_shared_messages_request"
+require_relative "Apologist/environment"