Allow fetching first message of a bot conversation (#998)

* Allow fetching first message of a bot conversation

* Export Swift list type

* Fix spelling issue

Author: jkmassel

native/swift/Sources/wordpress-api/Exports.swift

@@ -271,6 +271,7 @@ public typealias SubscriberImportJobsListParams = WordPressAPIInternal.Subscribe
 public typealias AddSubscribersParams = WordPressAPIInternal.AddSubscribersParams
 
 // MARK: Support Bots
+public typealias ListBotConversationParams = WordPressAPIInternal.ListBotConversationsParams
 public typealias CreateBotConversationParams = WordPressAPIInternal.CreateBotConversationParams
 public typealias AddMessageToBotConversationParams = WordPressAPIInternal.AddMessageToBotConversationParams
 public typealias GetBotConversationParams = WordPressAPIInternal.GetBotConversationParams

wp_api/src/wp_com/endpoint/support_bots_endpoint.rs

@@ -1,5 +1,6 @@
 use crate::wp_com::support_bots::BotId;
 use crate::wp_com::support_bots::ChatId;
+use crate::wp_com::support_bots::ListBotConversationsParams;
 use crate::wp_com::support_bots::MessageId;
 use crate::{
     request::endpoint::{AsNamespace, DerivedRequest},
@@ -18,8 +19,8 @@ use wp_derive_request_builder::WpDerivedRequest;
 enum SupportBotsRequest {
     #[post(url = "/odie/chat/<bot_id>", params = &CreateBotConversationParams, output = BotConversation)]
     CreateBotConversation,
-    #[get(url = "/odie/conversations/<bot_id>", output = Vec<BotConversationSummary>)]
-    GetBotConverationList,
+    #[get(url = "/odie/conversations/<bot_id>", params = &ListBotConversationsParams, output = Vec<BotConversationSummary>)]
+    GetBotConversationList,
     #[get(url = "/odie/chat/<bot_id>/<chat_id>", params = &GetBotConversationParams, output = BotConversation)]
     GetBotConversation,
     #[post(url = "/odie/chat/<bot_id>/<chat_id>", params = &AddMessageToBotConversationParams, output = BotConversation)]

wp_api/src/wp_com/support_bots.rs

@@ -1,16 +1,53 @@
+use crate::url_query::FromUrlQueryPairs;
+use crate::url_query::UrlQueryPairsMap;
 use crate::{
     date::WpGmtDateTime,
-    impl_as_query_value_for_new_type,
+    impl_as_query_value_for_new_type, impl_as_query_value_from_to_string,
     url_query::{AppendUrlQueryPairs, QueryPairs, QueryPairsExtension},
     users::UserId,
 };
 use serde::{Deserialize, Serialize};
 use serde_repr::*;
 use std::collections::HashMap;
+use wp_derive::WpDeriveParamsField;
 use wp_serde_helper::deserialize_empty_vec_or_none;
 
 use super::WpComSiteId;
 
+#[derive(
+    Debug,
+    Default,
+    Clone,
+    PartialEq,
+    Eq,
+    PartialOrd,
+    Ord,
+    Hash,
+    Serialize,
+    Deserialize,
+    uniffi::Enum,
+    strum_macros::EnumString,
+    strum_macros::Display,
+)]
+#[serde(rename_all = "snake_case")]
+#[strum(serialize_all = "snake_case")]
+pub enum ListBotConversationsSummaryMethod {
+    FirstMessage,
+    #[default]
+    LastMessage,
+}
+
+impl_as_query_value_from_to_string!(ListBotConversationsSummaryMethod);
+
+#[derive(
+    Debug, Default, PartialEq, Eq, Serialize, Deserialize, uniffi::Record, WpDeriveParamsField,
+)]
+#[supports_pagination(false)]
+pub struct ListBotConversationsParams {
+    #[uniffi(default = None)]
+    pub summary_method: Option<ListBotConversationsSummaryMethod>,
+}
+
 #[derive(Debug, PartialEq, Eq, Serialize, uniffi::Record)]
 pub struct CreateBotConversationParams {
     pub message: String,
@@ -107,7 +144,9 @@ pub struct UserPaidSupportPlan {
 pub struct BotConversationSummary {
     pub chat_id: u64,
     pub created_at: WpGmtDateTime,
-    pub last_message: BotMessageSummary,
+    #[serde(alias = "first_message")]
+    #[serde(alias = "last_message")]
+    pub summary_message: BotMessageSummary,
 }
 
 #[derive(Debug, PartialEq, Eq, Serialize, Deserialize, uniffi::Record)]
@@ -231,17 +270,20 @@ mod tests {
         #[case] json_file_path: &str,
         #[case] expected_chat_id: u64,
     ) {
-        let json = test_json(json_file_path).expect("Failed to read JSON file");
+        let json: Vec<u8> = test_json(json_file_path).expect("Failed to read JSON file");
         let conversation: BotConversation = serde_json::from_slice(json.as_slice())
             .expect("Failed to deserialize bot conversation");
         assert_eq!(conversation.chat_id, expected_chat_id);
     }
 
-    #[test]
-    fn test_bot_conversation_summary_deserialization() {
-        let json = include_str!("../../tests/wpcom/support_bots/converation-list.json");
-        let conversations: Vec<BotConversationSummary> =
-            serde_json::from_str(json).expect("Failed to deserialize bot conversation summary");
+    #[rstest]
+    #[case("conversation-list-01.json")]
+    #[case("conversation-list-02.json")]
+    fn test_bot_conversation_summary_deserialization(#[case] json_file_path: &str) {
+        let json = test_json(json_file_path).expect("Failed to read JSON file");
+        let conversations: Vec<BotConversationSummary> = serde_json::from_slice(json.as_slice())
+            .expect("Failed to deserialize bot conversation summary");
+
         assert_eq!(conversations.len(), 1);
         assert_eq!(conversations[0].chat_id, 1965758);
     }

wp_api/tests/wpcom/support_bots/converation-list.json renamed to wp_api/tests/wpcom/support_bots/conversation-list-01.json

@@ -0,0 +1,11 @@
+[
+    {
+        "chat_id": 1965758,
+        "created_at": "2025-10-16 18:41:19",
+        "first_message": {
+            "content": "oh hi there I have a new android tablet here",
+            "role": "user",
+            "created_at": "2025-10-16 18:41:20"
+        }
+    }
+]

wp_api/tests/wpcom/support_bots/conversation-list-02.json

@@ -4,7 +4,7 @@ use wp_api::wp_com::{
     client::WpComApiClient,
     support_bots::{
         AddMessageToBotConversationParams, BotConversation, BotId, ChatId,
-        CreateBotConversationParams, GetBotConversationParams,
+        CreateBotConversationParams, GetBotConversationParams, ListBotConversationsParams,
     },
 };
 
@@ -14,7 +14,7 @@ pub async fn support_bots_test(client: &WpComApiClient, allow_writes: bool) -> a
 
     let conversations = client
         .support_bots()
-        .get_bot_converation_list(&bot_id)
+        .get_bot_conversation_list(&bot_id, &ListBotConversationsParams::default())
         .await?
         .data;