apologist 1.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 76803053a1ad437bb60fa57feb7a40ae4b94f951f8045ff06af98f95f36bc783
-  data.tar.gz: '09b14123c5775032a9d6ad4aa93cef811bf9e713c5abbddf773a23e60ce189eb'
+  metadata.gz: b1054cde9bf35ff84eb9672032b3bc21a3a2d93c111138167b108f7f4e219b7b
+  data.tar.gz: 7262128610497fd136753b775897bad16ff01b12efb110f4d10d202960c65aea
 SHA512:
-  metadata.gz: 022d955a4414294dae0aacafd2e9a6f1f123c2b998c6fd584e6e100e7aa19aff871e5a799448d521aa510c35d4493bf6eb3f8356592e0b091fa0b652c0114f92
-  data.tar.gz: 293d9d182ba7c19f626a07c7416a926e86524886313ce74f75d7f779eeaac85ec3c702cdbe359c92832825bc920601ea97d0dad542405485da0c2916d2eb682a
+  metadata.gz: 2b3d743543ab94eeded1ba0399c818ce58e08eed41c390516e4a17a1dd5a4ada418f8c488fc96f1592b9bf1e6cde25fe5065ea8e228884829c79596bebe9a639
+  data.tar.gz: bb9a18913196ec863ef888a65ed601c52629cd4d2b2acc011d26e64547b7cf144f94c3f371a1e996c2e1f731542d382fe0651676295af6e70dcdd1a15a4005c3

data/.fern/metadata.json

@@ -6,9 +6,9 @@
     "moduleName": "Apologist",
     "clientModuleName": "AgentClient"
   },
-  "originGitCommit": "b34e9073b4d563508b6a9eab41f15e10ab60fb15",
+  "originGitCommit": "b939d4f55706b529800e2b0a7cb51582fd764206",
   "originGitCommitIsDirty": false,
   "invokedBy": "ci",
   "ciProvider": "github",
-  "sdkVersion": "1.0.5"
+  "sdkVersion": "1.1.1"
 }

data/lib/Apologist/agent/client.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+module Apologist
+  module Agent
+    class Client
+      # @param client [Apologist::Internal::Http::RawClient]
+      #
+      # @return [void]
+      def initialize(client:)
+        @client = client
+      end
+
+      # Pauses the agent globally and fans out pause transition messages to open conversations. Requires an API key.
+      #
+      # @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
+      #
+      # @example
+      #   client.agent.pause_agent
+      #
+      # @return [Apologist::Agent::Types::PauseAgentResponse]
+      def pause_agent(request_options: {}, **_params)
+        request = Apologist::Internal::JSON::Request.new(
+          base_url: request_options[:base_url],
+          method: "POST",
+          path: "pause",
+          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::Agent::Types::PauseAgentResponse.load(response.body)
+        else
+          error_class = Apologist::Errors::ResponseError.subclass_for_code(code)
+          raise error_class.new(response.body, code: code)
+        end
+      end
+
+      # Resumes the agent globally and fans out resume transition messages to open conversations. Requires an API key.
+      #
+      # @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
+      #
+      # @example
+      #   client.agent.resume_agent
+      #
+      # @return [Apologist::Agent::Types::ResumeAgentResponse]
+      def resume_agent(request_options: {}, **_params)
+        request = Apologist::Internal::JSON::Request.new(
+          base_url: request_options[:base_url],
+          method: "POST",
+          path: "resume",
+          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::Agent::Types::ResumeAgentResponse.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/agent/types/pause_agent_response.rb

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

data/lib/Apologist/agent/types/resume_agent_response.rb

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

data/lib/Apologist/channels/client.rb

@@ -402,6 +402,106 @@ module Apologist
         error_class = Apologist::Errors::ResponseError.subclass_for_code(code)
         raise error_class.new(response.body, code: code)
       end
+
+      # Handles the Meta WhatsApp Cloud API webhook verification handshake, echoing `hub.challenge` when
+      # `hub.verify_token` matches the channel's configured token.
+      #
+      # @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] :id
+      # @option params [Apologist::Channels::Types::VerifyWhatsAppWebhookRequestHubMode] :hub_mode
+      # @option params [String] :hub_verify_token
+      # @option params [String, nil] :hub_challenge
+      #
+      # @example
+      #   client.channels.verify_whats_app_webhook(
+      #     id: "id",
+      #     hub_mode: "subscribe",
+      #     hub_verify_token: "hub.verify_token"
+      #   )
+      #
+      # @return [String]
+      def verify_whats_app_webhook(request_options: {}, **params)
+        params = Apologist::Internal::Types::Utils.normalize_keys(params)
+        query_params = {}
+        query_params["hub.mode"] = params[:hub_mode] if params.key?(:hub_mode)
+        query_params["hub.verify_token"] = params[:hub_verify_token] if params.key?(:hub_verify_token)
+        query_params["hub.challenge"] = params[:hub_challenge] if params.key?(:hub_challenge)
+
+        request = Apologist::Internal::JSON::Request.new(
+          base_url: request_options[:base_url],
+          method: "GET",
+          path: "channels/#{URI.encode_uri_component(params[:id].to_s)}/whatsapp",
+          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
+        return if code.between?(200, 299)
+
+        error_class = Apologist::Errors::ResponseError.subclass_for_code(code)
+        raise error_class.new(response.body, code: code)
+      end
+
+      # Receives WhatsApp Cloud API message events for the channel. Payload shape is defined by Meta. Signature
+      # verification via `x-hub-signature-256` is used when the channel has an App Secret configured; otherwise the
+      # webhook relies on URL secrecy and/or an `api_key` query parameter.
+      #
+      # @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] :id
+      # @option params [String, nil] :hub_signature256
+      #
+      # @example
+      #   client.channels.receive_whats_app_message(
+      #     id: "id",
+      #     body: {
+      #       key: "value"
+      #     }
+      #   )
+      #
+      # @return [untyped]
+      def receive_whats_app_message(request_options: {}, **params)
+        params = Apologist::Internal::Types::Utils.normalize_keys(params)
+        path_param_names = %i[id]
+        body_params = params.except(*path_param_names)
+
+        headers = {}
+        headers["x-hub-signature-256"] = params[:hub_signature256] if params[:hub_signature256]
+
+        request = Apologist::Internal::JSON::Request.new(
+          base_url: request_options[:base_url],
+          method: "POST",
+          path: "channels/#{URI.encode_uri_component(params[:id].to_s)}/whatsapp",
+          headers: headers,
+          body: body_params,
+          request_options: request_options
+        )
+        begin
+          response = @client.send(request)
+        rescue Net::HTTPRequestTimeout
+          raise Apologist::Errors::TimeoutError
+        end
+        code = response.code.to_i
+        return if code.between?(200, 299)
+
+        error_class = Apologist::Errors::ResponseError.subclass_for_code(code)
+        raise error_class.new(response.body, code: code)
+      end
     end
   end
 end

data/lib/Apologist/channels/types/receive_whats_app_message_request.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Apologist
+  module Channels
+    module Types
+      class ReceiveWhatsAppMessageRequest < Internal::Types::Model
+        field :id, -> { String }, optional: false, nullable: false
+
+        field :hub_signature256, -> { String }, optional: true, nullable: false, api_name: "x-hub-signature-256"
+
+        field :body, -> { Internal::Types::Hash[String, Object] }, optional: false, nullable: false
+      end
+    end
+  end
+end

data/lib/Apologist/channels/types/verify_whats_app_webhook_request.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Apologist
+  module Channels
+    module Types
+      class VerifyWhatsAppWebhookRequest < Internal::Types::Model
+        field :id, -> { String }, optional: false, nullable: false
+
+        field :hub_mode, -> { Apologist::Channels::Types::VerifyWhatsAppWebhookRequestHubMode }, optional: false, nullable: false, api_name: "hub.mode"
+
+        field :hub_verify_token, -> { String }, optional: false, nullable: false, api_name: "hub.verify_token"
+
+        field :hub_challenge, -> { String }, optional: true, nullable: false, api_name: "hub.challenge"
+      end
+    end
+  end
+end

data/lib/Apologist/channels/types/verify_whats_app_webhook_request_hub_mode.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Apologist
+  module Channels
+    module Types
+      module VerifyWhatsAppWebhookRequestHubMode
+        extend Apologist::Internal::Types::Enum
+
+        SUBSCRIBE = "subscribe"
+      end
+    end
+  end
+end

data/lib/Apologist/client.rb

@@ -20,7 +20,7 @@ module Apologist
       @raw_client = Apologist::Internal::Http::RawClient.new(
         base_url: base_url || Apologist::Environment::DEFAULT,
         headers: {
-          "User-Agent" => "apologist/1.0.5",
+          "User-Agent" => "apologist/1.1.1",
           "X-Fern-Language" => "Ruby",
           "x-api-key" => api_key.to_s
         },
@@ -58,6 +58,16 @@ module Apologist
       @benchmarks ||= Apologist::Benchmarks::Client.new(client: @raw_client)
     end
 
+    # @return [Apologist::Agent::Client]
+    def agent
+      @agent ||= Apologist::Agent::Client.new(client: @raw_client)
+    end
+
+    # @return [Apologist::Conversations::Client]
+    def conversations
+      @conversations ||= Apologist::Conversations::Client.new(client: @raw_client)
+    end
+
     # @return [Apologist::Channels::Client]
     def channels
       @channels ||= Apologist::Channels::Client.new(client: @raw_client)

data/lib/Apologist/conversations/client.rb

@@ -0,0 +1,168 @@
+# frozen_string_literal: true
+
+module Apologist
+  module Conversations
+    class Client
+      # @param client [Apologist::Internal::Http::RawClient]
+      #
+      # @return [void]
+      def initialize(client:)
+        @client = client
+      end
+
+      # Returns a paginated list of conversations for the requesting agent, newest first.
+      #
+      # @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.conversations.list_conversations
+      #
+      # @return [Apologist::Conversations::Types::ListConversationsResponse]
+      def list_conversations(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: "conversations",
+          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::Conversations::Types::ListConversationsResponse.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 conversation by internal UUID or team-scoped external 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 [String] :id
+      #
+      # @example
+      #   client.conversations.get_conversation(id: "id")
+      #
+      # @return [Apologist::Conversations::Types::GetConversationResponse]
+      def get_conversation(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: "conversations/#{URI.encode_uri_component(params[: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::Conversations::Types::GetConversationResponse.load(response.body)
+        else
+          error_class = Apologist::Errors::ResponseError.subclass_for_code(code)
+          raise error_class.new(response.body, code: code)
+        end
+      end
+
+      # Pauses the agent on a conversation identified by internal UUID or team-scoped external id. Requires an API key.
+      #
+      # @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] :id
+      #
+      # @example
+      #   client.conversations.pause_conversation(id: "id")
+      #
+      # @return [Apologist::Conversations::Types::PauseConversationResponse]
+      def pause_conversation(request_options: {}, **params)
+        params = Apologist::Internal::Types::Utils.normalize_keys(params)
+        request = Apologist::Internal::JSON::Request.new(
+          base_url: request_options[:base_url],
+          method: "POST",
+          path: "conversations/#{URI.encode_uri_component(params[:id].to_s)}/pause",
+          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::Conversations::Types::PauseConversationResponse.load(response.body)
+        else
+          error_class = Apologist::Errors::ResponseError.subclass_for_code(code)
+          raise error_class.new(response.body, code: code)
+        end
+      end
+
+      # Resumes the agent on a conversation identified by internal UUID or team-scoped external id. Requires an API key.
+      #
+      # @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] :id
+      #
+      # @example
+      #   client.conversations.resume_conversation(id: "id")
+      #
+      # @return [Apologist::Conversations::Types::ResumeConversationResponse]
+      def resume_conversation(request_options: {}, **params)
+        params = Apologist::Internal::Types::Utils.normalize_keys(params)
+        request = Apologist::Internal::JSON::Request.new(
+          base_url: request_options[:base_url],
+          method: "POST",
+          path: "conversations/#{URI.encode_uri_component(params[:id].to_s)}/resume",
+          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::Conversations::Types::ResumeConversationResponse.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/conversations/types/get_conversation_request.rb

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

data/lib/Apologist/conversations/types/get_conversation_response.rb

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

data/lib/Apologist/conversations/types/list_conversations_request.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Apologist
+  module Conversations
+    module Types
+      class ListConversationsRequest < 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/conversations/types/list_conversations_response.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Apologist
+  module Conversations
+    module Types
+      class ListConversationsResponse < Internal::Types::Model
+        field :data, -> { Internal::Types::Array[Apologist::Types::Conversation] }, 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/conversations/types/pause_conversation_request.rb

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

data/lib/Apologist/conversations/types/pause_conversation_response.rb

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

data/lib/Apologist/conversations/types/resume_conversation_request.rb

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

data/lib/Apologist/conversations/types/resume_conversation_response.rb

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

data/lib/Apologist/types/agent_pause_state.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Apologist
+  module Types
+    # Agent-wide pause or resume result, including fan-out counts.
+    class AgentPauseState < Internal::Types::Model
+      field :is_paused, -> { Internal::Types::Boolean }, optional: true, nullable: false
+
+      field :paused_at, -> { String }, optional: true, nullable: false
+
+      field :resumed_at, -> { String }, optional: true, nullable: false
+
+      field :emitted, -> { Integer }, optional: true, nullable: false
+
+      field :skipped, -> { Integer }, optional: true, nullable: false
+    end
+  end
+end

data/lib/Apologist/types/conversation.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Apologist
+  module Types
+    # A conversation scoped to the requesting agent.
+    class Conversation < Internal::Types::Model
+      field :id, -> { String }, optional: true, nullable: false
+
+      field :external_id, -> { String }, optional: true, nullable: false
+
+      field :agent_id, -> { Integer }, optional: true, nullable: false
+
+      field :team_id, -> { Integer }, optional: true, nullable: false
+
+      field :tags, -> { Internal::Types::Hash[String, Object] }, optional: true, nullable: false
+
+      field :started_at, -> { String }, optional: true, nullable: false
+
+      field :ended_at, -> { String }, optional: true, nullable: false
+
+      field :agent_paused, -> { Internal::Types::Boolean }, optional: true, nullable: false
+
+      field :agent_paused_at, -> { String }, optional: true, nullable: false
+
+      field :agent_resumed_at, -> { String }, optional: true, nullable: false
+    end
+  end
+end

data/lib/Apologist/version.rb

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

data/lib/Apologist.rb

@@ -60,9 +60,18 @@ 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/types/agent_pause_state"
+require_relative "Apologist/agent/types/pause_agent_response"
+require_relative "Apologist/agent/types/resume_agent_response"
+require_relative "Apologist/types/conversation"
+require_relative "Apologist/conversations/types/list_conversations_response"
+require_relative "Apologist/conversations/types/get_conversation_response"
+require_relative "Apologist/conversations/types/pause_conversation_response"
+require_relative "Apologist/conversations/types/resume_conversation_response"
 require_relative "Apologist/channels/types/get_discord_channel_status_response"
 require_relative "Apologist/channels/types/get_line_channel_status_response"
 require_relative "Apologist/channels/types/verify_facebook_webhook_request_hub_mode"
+require_relative "Apologist/channels/types/verify_whats_app_webhook_request_hub_mode"
 require_relative "Apologist/shares/types/get_shared_messages_response"
 require_relative "Apologist/types/error"
 require_relative "Apologist/types/success_response"
@@ -119,6 +128,12 @@ 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/agent/client"
+require_relative "Apologist/conversations/client"
+require_relative "Apologist/conversations/types/list_conversations_request"
+require_relative "Apologist/conversations/types/get_conversation_request"
+require_relative "Apologist/conversations/types/pause_conversation_request"
+require_relative "Apologist/conversations/types/resume_conversation_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"
@@ -129,6 +144,8 @@ 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/channels/types/verify_whats_app_webhook_request"
+require_relative "Apologist/channels/types/receive_whats_app_message_request"
 require_relative "Apologist/shares/client"
 require_relative "Apologist/shares/types/get_shared_messages_request"
 require_relative "Apologist/environment"

data/reference.md

@@ -2322,6 +2322,372 @@ client.benchmarks.get_benchmark_run(
 </dl>
 
 
+</dd>
+</dl>
+</details>
+
+## Agent
+<details><summary><code>client.agent.<a href="/lib/Apologist/agent/client.rb">pause_agent</a>() -> Apologist::Agent::Types::PauseAgentResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Pauses the agent globally and fans out pause transition messages to open conversations. Requires an API key.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```ruby
+client.agent.pause_agent
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request_options:** `Apologist::Agent::RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.agent.<a href="/lib/Apologist/agent/client.rb">resume_agent</a>() -> Apologist::Agent::Types::ResumeAgentResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Resumes the agent globally and fans out resume transition messages to open conversations. Requires an API key.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```ruby
+client.agent.resume_agent
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request_options:** `Apologist::Agent::RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+## Conversations
+<details><summary><code>client.conversations.<a href="/lib/Apologist/conversations/client.rb">list_conversations</a>() -> Apologist::Conversations::Types::ListConversationsResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Returns a paginated list of conversations for the requesting agent, newest first.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```ruby
+client.conversations.list_conversations
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**page:** `Integer` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**per_page:** `Integer` — Results per page (clamped to 100).
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request_options:** `Apologist::Conversations::RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.conversations.<a href="/lib/Apologist/conversations/client.rb">get_conversation</a>(id:) -> Apologist::Conversations::Types::GetConversationResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Returns a single conversation by internal UUID or team-scoped external id.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```ruby
+client.conversations.get_conversation(id: "id")
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**id:** `String` — The conversation UUID or team-scoped external id
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request_options:** `Apologist::Conversations::RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.conversations.<a href="/lib/Apologist/conversations/client.rb">pause_conversation</a>(id:) -> Apologist::Conversations::Types::PauseConversationResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Pauses the agent on a conversation identified by internal UUID or team-scoped external id. Requires an API key.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```ruby
+client.conversations.pause_conversation(id: "id")
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**id:** `String` — The conversation UUID or team-scoped external id
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request_options:** `Apologist::Conversations::RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.conversations.<a href="/lib/Apologist/conversations/client.rb">resume_conversation</a>(id:) -> Apologist::Conversations::Types::ResumeConversationResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Resumes the agent on a conversation identified by internal UUID or team-scoped external id. Requires an API key.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```ruby
+client.conversations.resume_conversation(id: "id")
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**id:** `String` — The conversation UUID or team-scoped external id
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request_options:** `Apologist::Conversations::RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
 </dd>
 </dl>
 </details>
@@ -3003,6 +3369,179 @@ client.channels.receive_twilio_message(id: "id")
 </dl>
 
 
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.channels.<a href="/lib/Apologist/channels/client.rb">verify_whats_app_webhook</a>(id:) -> String</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Handles the Meta WhatsApp Cloud API webhook verification handshake, echoing `hub.challenge` when `hub.verify_token` matches the channel's configured token.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```ruby
+client.channels.verify_whats_app_webhook(
+  id: "id",
+  hub_mode: "subscribe",
+  hub_verify_token: "hub.verify_token"
+)
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**id:** `String` — The channel id
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**hub_mode:** `Apologist::Channels::Types::VerifyWhatsAppWebhookRequestHubMode` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**hub_verify_token:** `String` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**hub_challenge:** `String` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request_options:** `Apologist::Channels::RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.channels.<a href="/lib/Apologist/channels/client.rb">receive_whats_app_message</a>(id:, request) -> </code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Receives WhatsApp Cloud API message events for the channel. Payload shape is defined by Meta. Signature verification via `x-hub-signature-256` is used when the channel has an App Secret configured; otherwise the webhook relies on URL secrecy and/or an `api_key` query parameter.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```ruby
+client.channels.receive_whats_app_message(
+  id: "id",
+  body: {
+    key: "value"
+  }
+)
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**id:** `String` — The channel id
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**hub_signature256:** `String` — Meta `sha256=<hex>` HMAC of the raw body keyed with the WhatsApp App Secret. Required when the channel has an App Secret configured and the webhook URL does not include an api_key.
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request:** `Internal::Types::Hash[String, Object]` — WhatsApp Cloud API webhook payload (`entry` + `changes`).
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request_options:** `Apologist::Channels::RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
 </dd>
 </dl>
 </details>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: apologist
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Apologist
@@ -27,6 +27,9 @@ files:
 - Rakefile
 - custom.gemspec.rb
 - lib/Apologist.rb
+- lib/Apologist/agent/client.rb
+- lib/Apologist/agent/types/pause_agent_response.rb
+- lib/Apologist/agent/types/resume_agent_response.rb
 - lib/Apologist/benchmarks/client.rb
 - lib/Apologist/benchmarks/types/benchmark_run_request.rb
 - lib/Apologist/benchmarks/types/benchmark_run_request_content.rb
@@ -47,8 +50,11 @@ files:
 - lib/Apologist/channels/types/receive_line_webhook_request.rb
 - lib/Apologist/channels/types/receive_telegram_update_request.rb
 - lib/Apologist/channels/types/receive_twilio_message_request.rb
+- lib/Apologist/channels/types/receive_whats_app_message_request.rb
 - lib/Apologist/channels/types/verify_facebook_webhook_request.rb
 - lib/Apologist/channels/types/verify_facebook_webhook_request_hub_mode.rb
+- lib/Apologist/channels/types/verify_whats_app_webhook_request.rb
+- lib/Apologist/channels/types/verify_whats_app_webhook_request_hub_mode.rb
 - lib/Apologist/chat/client.rb
 - lib/Apologist/chat/types/feedback_request.rb
 - lib/Apologist/chat/types/flag_request.rb
@@ -59,6 +65,15 @@ files:
 - lib/Apologist/chat/types/list_chat_completions_response.rb
 - lib/Apologist/chat/types/share_request.rb
 - lib/Apologist/client.rb
+- lib/Apologist/conversations/client.rb
+- lib/Apologist/conversations/types/get_conversation_request.rb
+- lib/Apologist/conversations/types/get_conversation_response.rb
+- lib/Apologist/conversations/types/list_conversations_request.rb
+- lib/Apologist/conversations/types/list_conversations_response.rb
+- lib/Apologist/conversations/types/pause_conversation_request.rb
+- lib/Apologist/conversations/types/pause_conversation_response.rb
+- lib/Apologist/conversations/types/resume_conversation_request.rb
+- lib/Apologist/conversations/types/resume_conversation_response.rb
 - lib/Apologist/corpus/client.rb
 - lib/Apologist/corpus/types/corpus_search_request.rb
 - lib/Apologist/corpus/types/corpus_search_request_filters.rb
@@ -116,6 +131,7 @@ files:
 - lib/Apologist/shares/client.rb
 - lib/Apologist/shares/types/get_shared_messages_request.rb
 - lib/Apologist/shares/types/get_shared_messages_response.rb
+- lib/Apologist/types/agent_pause_state.rb
 - lib/Apologist/types/chat_completion_request.rb
 - lib/Apologist/types/chat_completion_request_logprobs.rb
 - lib/Apologist/types/chat_completion_request_metadata.rb
@@ -131,6 +147,7 @@ files:
 - lib/Apologist/types/chat_completion_response_usage.rb
 - lib/Apologist/types/chat_message.rb
 - lib/Apologist/types/chat_message_role.rb
+- lib/Apologist/types/conversation.rb
 - lib/Apologist/types/cta_match_request.rb
 - lib/Apologist/types/error.rb
 - lib/Apologist/types/success_response.rb