@spokpay/chat 0.1.1 → 0.2.0

package/dist/index.d.ts

@@ -1,3 +1,3 @@
 export { SpokPayChat } from "./client.js";
 export { SpokPayChatApiError } from "./types.js";
-export type { SpokPayChatOptions, Conversation, CreateConversationOptions, GetConversationOptions, Message, SendMessageOptions, MessageAttachment, ListMessagesOptions, CloseConversationOptions, GetUploadUrlOptions, ChatWebhookPayload, WebhookMessageData, WebhookConversationData, VerifyWebhookOptions, } from "./types.js";
+export type { SpokPayChatOptions, Conversation, CreateConversationOptions, GetConversationOptions, Message, SendMessageOptions, MessageAttachment, ListMessagesOptions, CloseConversationOptions, GetUploadUrlOptions, ChatWebhookPayload, WebhookMessageData, WebhookConversationData, WebhookItemDeliveredData, WebhookItemRefundedData, VerifyWebhookOptions, } from "./types.js";

package/dist/types.d.ts

@@ -236,10 +236,12 @@ export interface ChatWebhookPayload {
      * - `"message.updated"` — A message was edited.
      * - `"message.deleted"` — A message was deleted.
      * - `"conversation.closed"` — The conversation was closed.
+     * - `"item.delivered"` — An order item was delivered by staff.
+     * - `"item.refunded"` — An order item was refunded by staff.
      */
-    type: "message.created" | "message.updated" | "message.deleted" | "conversation.closed";
+    type: "message.created" | "message.updated" | "message.deleted" | "conversation.closed" | "item.delivered" | "item.refunded";
     /** Event data. Shape depends on the event type. */
-    data: WebhookMessageData | WebhookConversationData;
+    data: WebhookMessageData | WebhookConversationData | WebhookItemDeliveredData | WebhookItemRefundedData;
     /** Unix timestamp (ms) when the event was created. */
     createdAt: number;
 }
@@ -312,6 +314,85 @@ export interface WebhookConversationData {
     /** Unix timestamp (ms) when the conversation was closed. */
     closedAt?: number;
 }
+/**
+ * Data included in `item.delivered` webhook events.
+ *
+ * Fired when a staff member marks an order item as delivered from the SpokPay dashboard.
+ *
+ * @example
+ * ```ts
+ * const event: ChatWebhookPayload = JSON.parse(body);
+ * if (event.type === "item.delivered") {
+ *   const data = event.data as WebhookItemDeliveredData;
+ *   console.log(`${data.item.name} delivered by ${data.deliveredBy}`);
+ * }
+ * ```
+ */
+export interface WebhookItemDeliveredData {
+    /** SpokPay conversation ID. */
+    conversationId: string;
+    /** Your external ID for the conversation. */
+    externalId?: string;
+    /** The delivered item. */
+    item: {
+        /** Your external ID for this product (from charge items). */
+        externalId?: string;
+        /** Product name. */
+        name: string;
+        /** Quantity delivered. */
+        quantity: number;
+        /** Delivery proof image, if provided. */
+        deliveryProof?: {
+            /** Direct URL to the proof image. */
+            url: string;
+            /** Filename. */
+            filename: string;
+            /** MIME content type. */
+            contentType: string;
+        };
+    };
+    /** Display name of the staff member who delivered. */
+    deliveredBy: string;
+    /** Unix timestamp (ms) when the item was delivered. */
+    deliveredAt: number;
+}
+/**
+ * Data included in `item.refunded` webhook events.
+ *
+ * Fired when a staff member refunds an order item from the SpokPay dashboard.
+ *
+ * @example
+ * ```ts
+ * const event: ChatWebhookPayload = JSON.parse(body);
+ * if (event.type === "item.refunded") {
+ *   const data = event.data as WebhookItemRefundedData;
+ *   console.log(`${data.item.name} refunded: ${data.item.refundReason}`);
+ * }
+ * ```
+ */
+export interface WebhookItemRefundedData {
+    /** SpokPay conversation ID. */
+    conversationId: string;
+    /** Your external ID for the conversation. */
+    externalId?: string;
+    /** The refunded item. */
+    item: {
+        /** Your external ID for this product (from charge items). */
+        externalId?: string;
+        /** Product name. */
+        name: string;
+        /** Quantity refunded. */
+        quantity: number;
+        /** Refund amount. */
+        refundAmount?: number;
+        /** Reason for the refund. */
+        refundReason?: string;
+    };
+    /** Display name of the staff member who processed the refund. */
+    refundedBy: string;
+    /** Unix timestamp (ms) when the item was refunded. */
+    refundedAt: number;
+}
 /**
  * Options for verifying a webhook signature.
  *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@spokpay/chat",
-  "version": "0.1.1",
+  "version": "0.2.0",
   "description": "SpokPay Chat SDK — add live chat conversations to your app",
   "type": "module",
   "main": "dist/index.js",