apologist 1.1.0 → 1.2.0

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.2.0"
 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.2.0
 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