Add support tickets endpoints

Author: jkmassel

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

@@ -149,3 +149,7 @@ public typealias CreateBotConversationParams = WordPressAPIInternal.CreateBotCon
 public typealias AddMessageToBotConversationParams = WordPressAPIInternal.AddMessageToBotConversationParams
 public typealias GetBotConversationParams = WordPressAPIInternal.GetBotConversationParams
 public typealias CreateBotConversationFeedbackParams = WordPressAPIInternal.CreateBotConversationFeedbackParams
+
+// MARK: Support Tickets
+public typealias CreateSupportTicketParams = WordPressAPIInternal.CreateSupportTicketParams
+

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

@@ -25,4 +25,8 @@ public class WPComApiClient {
     public var supportBots: SupportBotsRequestExecutor {
         internalClient.supportBots()
     }
+
+    public var supportTickets: SupportTicketsRequestExecutor {
+        internalClient.supportTickets()
+    }
 }

wp_api/src/wp_com/client.rs

@@ -5,6 +5,7 @@ use super::endpoint::{
     oauth2::{Oauth2RequestBuilder, Oauth2RequestExecutor},
     subscribers::{SubscribersRequestBuilder, SubscribersRequestExecutor},
     support_bots_endpoint::{SupportBotsRequestBuilder, SupportBotsRequestExecutor},
+    support_tickets_endpoint::{SupportTicketsRequestBuilder, SupportTicketsRequestExecutor},
 };
 use crate::{
     WpApiClientDelegate, api_client_generate_api_client, api_client_generate_endpoint_impl,
@@ -33,6 +34,7 @@ pub struct WpComApiRequestBuilder {
     oauth2: Arc<Oauth2RequestBuilder>,
     subscribers: Arc<SubscribersRequestBuilder>,
     support_bots: Arc<SupportBotsRequestBuilder>,
+    support_tickets: Arc<SupportTicketsRequestBuilder>,
 }
 
 impl WpComApiRequestBuilder {
@@ -45,7 +47,8 @@ impl WpComApiRequestBuilder {
             jetpack_connection,
             oauth2,
             subscribers,
-            support_bots
+            support_bots,
+            support_tickets
         )
     }
 }
@@ -70,6 +73,7 @@ pub struct WpComApiClient {
     oauth2: Arc<Oauth2RequestExecutor>,
     subscribers: Arc<SubscribersRequestExecutor>,
     support_bots: Arc<SupportBotsRequestExecutor>,
+    support_tickets: Arc<SupportTicketsRequestExecutor>,
 }
 
 impl WpComApiClient {
@@ -83,11 +87,13 @@ impl WpComApiClient {
             jetpack_connection,
             oauth2,
             subscribers,
-            support_bots
+            support_bots,
+            support_tickets
         )
     }
 }
 api_client_generate_endpoint_impl!(WpComApi, jetpack_connection);
 api_client_generate_endpoint_impl!(WpComApi, oauth2);
 api_client_generate_endpoint_impl!(WpComApi, subscribers);
 api_client_generate_endpoint_impl!(WpComApi, support_bots);
+api_client_generate_endpoint_impl!(WpComApi, support_tickets);

wp_api/src/wp_com/endpoint.rs

@@ -10,6 +10,7 @@ pub mod jetpack_connection_endpoint;
 pub mod oauth2;
 pub mod subscribers;
 pub mod support_bots_endpoint;
+pub mod support_tickets_endpoint;
 
 #[derive(uniffi::Object)]
 pub struct WpComDotOrgApiUrlResolver {

wp_api/src/wp_com/endpoint/support_tickets_endpoint.rs

@@ -0,0 +1,29 @@
+use crate::{
+    request::endpoint::{AsNamespace, DerivedRequest},
+    wp_com::{
+        WpComNamespace,
+        support_tickets::{
+            AddMessageToSupportConversationParams, ConversationId, CreateSupportTicketParams,
+            SupportConversation, SupportConversationSummary,
+        },
+    },
+};
+use wp_derive_request_builder::WpDerivedRequest;
+
+#[derive(WpDerivedRequest)]
+enum SupportTicketsRequest {
+    #[post(url = "/mobile-support/conversations", params = &CreateSupportTicketParams, output = SupportConversation)]
+    CreateSupportTicket,
+    #[get(url = "/mobile-support/conversations", output = Vec<SupportConversationSummary>)]
+    GetSupportConversationList,
+    #[get(url = "/mobile-support/conversations/<conversation_id>", output = SupportConversation)]
+    GetSupportConversation,
+    #[post(url = "/mobile-support/conversations/<conversation_id>", params = &AddMessageToSupportConversationParams, output = SupportConversation)]
+    AddMessageToSupportConversation,
+}
+
+impl DerivedRequest for SupportTicketsRequest {
+    fn namespace() -> impl AsNamespace {
+        WpComNamespace::V2
+    }
+}

wp_api/src/wp_com/mod.rs

@@ -8,6 +8,7 @@ pub mod jetpack_connection;
 pub mod oauth2;
 pub mod subscribers;
 pub mod support_bots;
+pub mod support_tickets;
 
 impl_as_query_value_for_new_type!(WpComSiteId);
 uniffi::custom_newtype!(WpComSiteId, u64);

wp_api/src/wp_com/support_tickets.rs

@@ -0,0 +1,145 @@
+use std::collections::HashMap;
+
+use serde::{Deserialize, Serialize};
+
+use crate::{date::WpGmtDateTime, impl_as_query_value_for_new_type};
+
+#[derive(Debug, PartialEq, Eq, Serialize, uniffi::Record)]
+pub struct CreateSupportTicketParams {
+    pub subject: String,
+    pub message: String,
+    pub application: String,
+    #[uniffi(default = None)]
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub wpcom_site_id: Option<u64>,
+    #[uniffi(default = [])]
+    pub tags: Vec<String>,
+    #[uniffi(default = [])]
+    pub attachments: Vec<String>,
+}
+
+#[derive(Debug, PartialEq, Eq, Serialize, Deserialize, uniffi::Record)]
+pub struct SupportConversationSummary {
+    pub id: ConversationId,
+    pub title: String,
+    pub description: String,
+    pub status: String,
+    pub created_at: WpGmtDateTime,
+    pub updated_at: WpGmtDateTime,
+}
+
+#[derive(Debug, PartialEq, Eq, Serialize, Deserialize, uniffi::Record)]
+pub struct SupportConversation {
+    pub id: ConversationId,
+    pub title: String,
+    pub description: String,
+    pub status: String,
+    pub created_at: WpGmtDateTime,
+    pub updated_at: WpGmtDateTime,
+    pub messages: Vec<SupportMessage>,
+}
+
+#[derive(Debug, PartialEq, Eq, Serialize, Deserialize, uniffi::Record)]
+pub struct SupportMessage {
+    pub id: u64,
+    pub content: String,
+    pub author: SupportMessageAuthor,
+    pub role: String,
+    pub author_is_current_user: bool,
+    pub created_at: WpGmtDateTime,
+    pub attachments: Vec<SupportAttachment>,
+}
+
+#[derive(Debug, PartialEq, Eq, Serialize, Deserialize, uniffi::Record)]
+pub struct SupportUserIdentity {
+    pub id: u64,
+    pub email: String,
+    pub display_name: String,
+    pub avatar_url: String,
+}
+
+#[derive(Debug, PartialEq, Eq, Serialize, Deserialize, uniffi::Record)]
+pub struct SupportAttachment {
+    pub id: u64,
+    pub filename: String,
+    pub content_type: String,
+    pub size: u64,
+    pub url: String,
+    pub metadata: HashMap<String, AttachmentMetadataValue>,
+}
+
+#[derive(Debug, PartialEq, Eq, Serialize, Deserialize, uniffi::Enum)]
+#[serde(untagged)]
+pub enum SupportMessageAuthor {
+    User(SupportUserIdentity),
+    SupportAgent(SupportAgentIdentity),
+}
+
+#[derive(Debug, PartialEq, Eq, Serialize, Deserialize, uniffi::Enum, strum_macros::Display)]
+#[strum(serialize_all = "snake_case")]
+pub enum AttachmentMetadataKey {
+    Width,
+    Height,
+    Other(String),
+}
+
+#[derive(Debug, PartialEq, Eq, Serialize, Deserialize, uniffi::Enum)]
+#[serde(untagged)]
+pub enum AttachmentMetadataValue {
+    String(String),
+    Number(u64),
+    Boolean(bool),
+}
+
+#[derive(Debug, PartialEq, Eq, Serialize, Deserialize, uniffi::Record)]
+pub struct SupportAgentIdentity {
+    pub id: u64,
+    pub name: String,
+}
+
+#[derive(Debug, PartialEq, Eq, Serialize, uniffi::Record)]
+pub struct AddMessageToSupportConversationParams {
+    pub message: String,
+    #[uniffi(default = [])]
+    pub attachments: Vec<String>,
+}
+
+impl_as_query_value_for_new_type!(ConversationId);
+uniffi::custom_newtype!(ConversationId, u64);
+#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
+pub struct ConversationId(pub u64);
+
+impl std::str::FromStr for ConversationId {
+    type Err = std::num::ParseIntError;
+
+    fn from_str(s: &str) -> Result<Self, Self::Err> {
+        s.parse().map(Self)
+    }
+}
+
+impl std::fmt::Display for ConversationId {
+    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
+        write!(f, "{}", self.0)
+    }
+}
+
+#[cfg(test)]
+mod tests {
+    use super::*;
+
+    #[test]
+    fn test_support_conversation_deserialization() {
+        let json = include_str!("../../tests/wpcom/support_tickets/single-conversation.json");
+        let conversation: SupportConversation =
+            serde_json::from_str(json).expect("Failed to deserialize support conversation");
+        assert_eq!(conversation.messages.len(), 7);
+    }
+
+    #[test]
+    fn test_support_conversation_list_deserialization() {
+        let json = include_str!("../../tests/wpcom/support_tickets/conversation-list.json");
+        let conversation_list: Vec<SupportConversationSummary> =
+            serde_json::from_str(json).expect("Failed to deserialize support conversation list");
+        assert_eq!(conversation_list.len(), 11);
+    }
+}

wp_api/tests/wpcom/support_tickets/conversation-list.json

@@ -0,0 +1,90 @@
+[
+    {
+      "id": 9033503,
+      "title": "🎨 Theme Customization Help",
+      "description": "Hello! 👋\n\nI see you're having trouble with your theme customization. Let me help you with that!\n\nThe color picker issue you're experiencing is a known bug that we've fixed in the latest update. Please try updating your theme to version 2.3.1.\n\nIf you need any further assistance, I'm here to help!\n\nBest regards,\n\nTheme Support Team 🌟",
+      "status": "closed",
+      "created_at": "2024-03-15T14:30:22+00:00",
+      "updated_at": "2024-03-18T09:45:33+00:00"
+    },
+    {
+      "id": 1698812,
+      "title": "🔒 Security Update Required",
+      "description": "مرحباً!\n\nلقد لاحظنا أن موقعك يحتاج إلى تحديث أمني. يرجى تحديث إصدار WordPress الخاص بك إلى أحدث إصدار متاح.\n\nيمكنك القيام بذلك من لوحة التحكم الخاصة بك.\n\nمع تحياتنا،\n\nفريق الدعم الأمني",
+      "status": "closed",
+      "created_at": "2024-03-10T09:15:45+00:00",
+      "updated_at": "2024-03-11T16:20:12+00:00"
+    },
+    {
+      "id": 1629241,
+      "title": "🚀 Performance Optimization",
+      "description": "Bonjour!\n\nJe vois que vous souhaitez optimiser les performances de votre site. Voici quelques suggestions:\n\n1. Activez la mise en cache\n2. Optimisez vos images\n3. Utilisez un CDN\n\nVoulez-vous que je vous guide à travers ces étapes?\n\nCordialement,\n\nL'équipe de support",
+      "status": "closed",
+      "created_at": "2024-03-05T11:22:18+00:00",
+      "updated_at": "2024-03-07T14:33:29+00:00"
+    },
+    {
+      "id": 1500710,
+      "title": "📱 Mobile App Feedback",
+      "description": "Hi there! 👋\n\nThank you for your feedback about our mobile app. We're constantly working to improve the user experience.\n\nYour suggestion about the navigation menu has been forwarded to our development team.\n\nKeep the feedback coming! 💪\n\nBest regards,\n\nMobile Support Team",
+      "status": "closed",
+      "created_at": "2024-02-28T15:40:55+00:00",
+      "updated_at": "2024-03-01T10:15:22+00:00"
+    },
+    {
+      "id": 1499869,
+      "title": "🎯 SEO Optimization Help",
+      "description": "Hello!\n\nI'd be happy to help you with your SEO optimization. Here are some key areas we can focus on:\n\n1. Meta descriptions\n2. Image alt tags\n3. URL structure\n\nWould you like me to provide more specific guidance on any of these topics?\n\nBest regards,\n\nSEO Support Team",
+      "status": "closed",
+      "created_at": "2024-02-25T13:20:33+00:00",
+      "updated_at": "2024-02-27T09:45:11+00:00"
+    },
+    {
+      "id": 1500203,
+      "title": "💰 Payment Gateway Setup",
+      "description": "Hi!\n\nI see you're setting up a new payment gateway. Let's make sure everything is configured correctly.\n\nPlease verify these settings:\n1. API keys\n2. Webhook endpoints\n3. Test mode status\n\nNeed any clarification? 🤔\n\nBest regards,\n\nPayment Support Team",
+      "status": "closed",
+      "created_at": "2024-02-20T10:15:44+00:00",
+      "updated_at": "2024-02-22T16:30:27+00:00"
+    },
+    {
+      "id": 1698812,
+      "title": "🎨 Design Consultation",
+      "description": "Hello! 👋\n\nThank you for reaching out about your site's design. I'd be happy to help you achieve the look you're going for.\n\nWould you like to schedule a design consultation call? We can discuss:\n- Color schemes\n- Layout options\n- Typography\n\nLet me know what works best for you! ✨\n\nBest regards,\n\nDesign Support Team",
+      "status": "closed",
+      "created_at": "2024-02-15T09:30:22+00:00",
+      "updated_at": "2024-02-17T14:45:33+00:00"
+    },
+    {
+      "id": 1629241,
+      "title": "📊 Analytics Integration",
+      "description": "Hi there!\n\nI see you're having trouble with your analytics integration. Let's get that sorted out.\n\nFirst, please verify that you've added the tracking code correctly to your site's header.\n\nNeed help finding where to add it? 🧐\n\nBest regards,\n\nAnalytics Support Team",
+      "status": "closed",
+      "created_at": "2024-02-10T11:20:18+00:00",
+      "updated_at": "2024-02-12T15:33:29+00:00"
+    },
+    {
+      "id": 1500710,
+      "title": "🌐 Multilingual Setup",
+      "description": "Bonjour!\n\nJe vois que vous souhaitez configurer votre site en plusieurs langues. Voici les étapes à suivre:\n\n1. Installer le plugin de traduction\n2. Configurer les langues\n3. Traduire le contenu\n\nBesoin d'aide avec l'une de ces étapes? 🤝\n\nCordialement,\n\nL'équipe de support multilingue",
+      "status": "closed",
+      "created_at": "2024-02-05T13:40:55+00:00",
+      "updated_at": "2024-02-07T10:15:22+00:00"
+    },
+    {
+      "id": 1499869,
+      "title": "🔧 Technical Support",
+      "description": "Hello! 👋\n\nI understand you're experiencing some technical issues. Let's troubleshoot this step by step.\n\nCould you please:\n1. Clear your browser cache\n2. Try a different browser\n3. Check your internet connection\n\nLet me know if you need help with any of these steps! 🛠️\n\nBest regards,\n\nTechnical Support Team",
+      "status": "closed",
+      "created_at": "2024-02-01T10:20:33+00:00",
+      "updated_at": "2024-02-03T09:45:11+00:00"
+    },
+    {
+      "id": 1500203,
+      "title": "📝 Content Migration",
+      "description": "Hi there!\n\nI see you're planning to migrate your content. Let me help you with that process.\n\nWe can use our automated migration tool, or I can guide you through a manual migration.\n\nWhich option would you prefer? 🤔\n\nBest regards,\n\nMigration Support Team",
+      "status": "closed",
+      "created_at": "2024-01-28T09:15:44+00:00",
+      "updated_at": "2024-01-30T16:30:27+00:00"
+    }
+  ]