@scryme/chat 2.57.1 → 2.81.1

package/dist/sdk.d.ts

@@ -349,6 +349,140 @@ export interface UserProfile {
     /** ISO timestamp when the user account was created. */
     createdAt?: string;
 }
+/**
+ * Represents a customer profile for support and CRM tracking.
+ */
+export interface CustomerProfile {
+    /** Unique customer profile identifier. */
+    id: string;
+    /** Unique user identifier. */
+    userId: string;
+    /** Associated workspace identifier. */
+    workspaceId: string;
+    /** Optional company name. */
+    company?: string | null;
+    /** Optional job title. */
+    jobTitle?: string | null;
+    /** External CRM identifier. */
+    crmId?: string | null;
+    /** Custom metadata key-value store. */
+    metadata?: Record<string, unknown> | null;
+    /** Array of customer tags. */
+    tags?: string[];
+    /** Associated user profile details. */
+    user?: UserProfile;
+}
+/**
+ * Represents a support ticket.
+ */
+export interface SupportTicket {
+    /** Unique ticket identifier. */
+    id: string;
+    /** Subject line or title of the ticket. */
+    subject: string;
+    /** Status of the ticket (OPEN, IN_PROGRESS, RESOLVED, CLOSED). */
+    status: string;
+    /** Unique workspace identifier. */
+    workspaceId: string;
+    /** Unique customer profile identifier. */
+    customerId: string;
+    /** Unique channel identifier created for ticket messages. */
+    channelId?: string | null;
+    /** Optional assigned agent user identifier. */
+    assigneeId?: string | null;
+    /** ISO timestamp when the ticket was created. */
+    createdAt: string;
+    /** ISO timestamp when the last message was sent. */
+    lastMessageAt: string;
+    /** Optional customer details. */
+    customer?: {
+        id: string;
+        userId: string;
+        user?: UserProfile;
+    };
+    /** Optional assignee details. */
+    assignee?: UserProfile;
+    /** Associated channel details. */
+    channel?: WorkspaceChannel;
+}
+/**
+ * Represents an active or ended live chat session.
+ */
+export interface LiveChatSession {
+    /** Unique session identifier. */
+    id: string;
+    /** Associated workspace identifier. */
+    workspaceId: string;
+    /** Optional customer profile identifier. */
+    customerId?: string | null;
+    /** Unique channel identifier for live chat. */
+    channelId: string;
+    /** Session status (ACTIVE, ENDED). */
+    status: string;
+    /** Custom metadata key-value store. */
+    metadata?: Record<string, unknown> | null;
+    /** Associated support ticket identifier if escalated. */
+    ticketId?: string | null;
+    /** ISO timestamp when live chat started. */
+    createdAt: string;
+    /** ISO timestamp when live chat ended. */
+    endedAt?: string | null;
+    /** Associated live chat channel details. */
+    channel?: WorkspaceChannel;
+}
+/**
+ * Options for creating a new support ticket.
+ */
+export interface CreateSupportTicketDto {
+    /** Unique workspace identifier where ticket is filed. */
+    workspaceId: string;
+    /** Subject or title of the support ticket. */
+    subject: string;
+    /** Initial message content to start the ticket conversation. */
+    initialMessage?: string;
+}
+/**
+ * Options for updating support ticket status.
+ */
+export interface UpdateSupportTicketStatusDto {
+    /** Target status (OPEN, IN_PROGRESS, RESOLVED, CLOSED). */
+    status: string;
+}
+/**
+ * Options for assigning or unassigning an agent to a support ticket.
+ */
+export interface AssignSupportTicketDto {
+    /** User ID of the agent to assign, or null to unassign. */
+    assigneeId: string | null;
+}
+/**
+ * Options for starting a new live chat session.
+ */
+export interface StartLiveChatDto {
+    /** Unique workspace identifier where live chat is initialized. */
+    workspaceId: string;
+    /** Optional metadata associated with the live chat session. */
+    metadata?: Record<string, unknown>;
+}
+/**
+ * Options for creating or updating a customer profile.
+ */
+export interface CreateCustomerProfileDto {
+    /** Associated workspace identifier. */
+    workspaceId: string;
+    /** User ID of the customer. */
+    userId: string;
+    /** Optional company name. */
+    company?: string;
+    /** Optional job title. */
+    jobTitle?: string;
+    /** External CRM identifier. */
+    crmId?: string;
+    /** Additional metadata key-value pairs. */
+    metadata?: Record<string, unknown>;
+    /** Tags for segmenting customers. */
+    tags?: string[];
+}
 /**
  * Configuration options for initializing the Scryme SDK.
  */
@@ -871,6 +1005,102 @@ export declare class ScrymeSDK {
             executeByChannelId: (channelId: string, data: ExecuteChannelIncomingWebhookDto, params?: V3ChannelIncomingWebhooksControllerExecuteWebhookByChannelIdParams, options?: AxiosRequestConfig) => Promise<V3ChannelIncomingWebhooksControllerExecuteWebhookByChannelIdResult>;
         };
     };
+    /**
+     * Operations for managing support tickets, live chat sessions, and customer profiles.
+     */
+    get support(): {
+        /**
+         * Creates a new support ticket in a workspace.
+         * @param data Details for creating the ticket including workspaceId, subject, and optional initialMessage.
+         * @param options Optional request config override.
+         */
+        createTicket: (data: CreateSupportTicketDto, options?: AxiosRequestConfig) => Promise<SupportTicket>;
+        /**
+         * Retrieves all support tickets for a given workspace.
+         * @param workspaceId Unique workspace identifier.
+         * @param options Optional request config override.
+         */
+        getTickets: (workspaceId: string, options?: AxiosRequestConfig) => Promise<SupportTicket[]>;
+        /**
+         * Updates the status of an existing support ticket.
+         * @param ticketId Unique identifier of the support ticket.
+         * @param status New status string (e.g. OPEN, IN_PROGRESS, RESOLVED, CLOSED).
+         * @param options Optional request config override.
+         */
+        updateStatus: (ticketId: string, status: string, options?: AxiosRequestConfig) => Promise<SupportTicket>;
+        /**
+         * Assigns a support ticket to an agent or unassigns it.
+         * @param ticketId Unique identifier of the support ticket.
+         * @param assigneeId User ID of the assigned agent or null to unassign.
+         * @param options Optional request config override.
+         */
+        assignTicket: (ticketId: string, assigneeId: string | null, options?: AxiosRequestConfig) => Promise<SupportTicket>;
+        /**
+         * Sub-namespace for managing support tickets.
+         */
+        tickets: {
+            /**
+             * Creates a new support ticket in a workspace.
+             * @param data Details for creating the ticket.
+             * @param options Optional request config override.
+             */
+            create: (data: CreateSupportTicketDto, options?: AxiosRequestConfig) => Promise<SupportTicket>;
+            /**
+             * Lists all support tickets in a workspace.
+             * @param workspaceId Unique workspace identifier.
+             * @param options Optional request config override.
+             */
+            list: (workspaceId: string, options?: AxiosRequestConfig) => Promise<SupportTicket[]>;
+            /**
+             * Updates ticket status.
+             * @param ticketId Unique ticket identifier.
+             * @param status New status string.
+             * @param options Optional request config override.
+             */
+            updateStatus: (ticketId: string, status: string, options?: AxiosRequestConfig) => Promise<SupportTicket>;
+            /**
+             * Assigns or unassigns an agent to/from a support ticket.
+             * @param ticketId Unique ticket identifier.
+             * @param assigneeId Agent user ID or null.
+             * @param options Optional request config override.
+             */
+            assign: (ticketId: string, assigneeId: string | null, options?: AxiosRequestConfig) => Promise<SupportTicket>;
+        };
+        /**
+         * Sub-namespace for live chat sessions.
+         */
+        liveChat: {
+            /**
+             * Starts a new live chat session for support.
+             * @param data Details for starting live chat session.
+             * @param options Optional request config override.
+             */
+            start: (data: StartLiveChatDto, options?: AxiosRequestConfig) => Promise<LiveChatSession>;
+            /**
+             * Ends an active live chat session.
+             * @param sessionId Unique session identifier.
+             * @param options Optional request config override.
+             */
+            end: (sessionId: string, options?: AxiosRequestConfig) => Promise<LiveChatSession>;
+        };
+        /**
+         * Sub-namespace for managing customer profiles.
+         */
+        customer: {
+            /**
+             * Creates or updates a customer profile in a workspace.
+             * @param data Profile details including workspaceId and userId.
+             * @param options Optional request config override.
+             */
+            createProfile: (data: CreateCustomerProfileDto, options?: AxiosRequestConfig) => Promise<CustomerProfile>;
+            /**
+             * Retrieves customer profiles in a workspace.
+             * @param workspaceId Unique workspace identifier.
+             * @param options Optional request config override.
+             */
+            getProfiles: (workspaceId: string, options?: AxiosRequestConfig) => Promise<CustomerProfile[]>;
+        };
+    };
     /**
      * First-class namespace for Machine-to-Machine (M2M) operations,
      * grouping V3 Enterprise M2M APIs into logical, highly cohesive spaces.

package/dist/sdk.js

@@ -957,6 +957,157 @@ var ScrymeSDK = /** @class */ (function () {
         enumerable: false,
         configurable: true
     });
+    Object.defineProperty(ScrymeSDK.prototype, "support", {
+        /**
+         * Operations for managing support tickets, live chat sessions, and customer profiles.
+         */
+        get: function () {
+            var _this = this;
+            return {
+                /**
+                 * Creates a new support ticket in a workspace.
+                 * @param data Details for creating the ticket including workspaceId, subject, and optional initialMessage.
+                 * @param options Optional request config override.
+                 */
+                createTicket: function (data, options) { return __awaiter(_this, void 0, void 0, function () {
+                    return __generator(this, function (_a) {
+                        return [2 /*return*/, this.raw.supportControllerCreateTicket(__assign(__assign({}, options), { data: data }))];
+                    });
+                }); },
+                /**
+                 * Retrieves all support tickets for a given workspace.
+                 * @param workspaceId Unique workspace identifier.
+                 * @param options Optional request config override.
+                 */
+                getTickets: function (workspaceId, options) { return __awaiter(_this, void 0, void 0, function () {
+                    return __generator(this, function (_a) {
+                        return [2 /*return*/, this.raw.supportControllerGetTickets({ workspaceId: workspaceId }, options)];
+                    });
+                }); },
+                /**
+                 * Updates the status of an existing support ticket.
+                 * @param ticketId Unique identifier of the support ticket.
+                 * @param status New status string (e.g. OPEN, IN_PROGRESS, RESOLVED, CLOSED).
+                 * @param options Optional request config override.
+                 */
+                updateStatus: function (ticketId, status, options) { return __awaiter(_this, void 0, void 0, function () {
+                    return __generator(this, function (_a) {
+                        return [2 /*return*/, this.raw.supportControllerUpdateTicketStatus(ticketId, __assign(__assign({}, options), { data: { status: status } }))];
+                    });
+                }); },
+                /**
+                 * Assigns a support ticket to an agent or unassigns it.
+                 * @param ticketId Unique identifier of the support ticket.
+                 * @param assigneeId User ID of the assigned agent or null to unassign.
+                 * @param options Optional request config override.
+                 */
+                assignTicket: function (ticketId, assigneeId, options) { return __awaiter(_this, void 0, void 0, function () {
+                    return __generator(this, function (_a) {
+                        return [2 /*return*/, this.raw.supportControllerAssignTicket(ticketId, __assign(__assign({}, options), { data: { assigneeId: assigneeId } }))];
+                    });
+                }); },
+                /**
+                 * Sub-namespace for managing support tickets.
+                 */
+                tickets: {
+                    /**
+                     * Creates a new support ticket in a workspace.
+                     * @param data Details for creating the ticket.
+                     * @param options Optional request config override.
+                     */
+                    create: function (data, options) { return __awaiter(_this, void 0, void 0, function () {
+                        return __generator(this, function (_a) {
+                            return [2 /*return*/, this.support.createTicket(data, options)];
+                        });
+                    }); },
+                    /**
+                     * Lists all support tickets in a workspace.
+                     * @param workspaceId Unique workspace identifier.
+                     * @param options Optional request config override.
+                     */
+                    list: function (workspaceId, options) { return __awaiter(_this, void 0, void 0, function () {
+                        return __generator(this, function (_a) {
+                            return [2 /*return*/, this.support.getTickets(workspaceId, options)];
+                        });
+                    }); },
+                    /**
+                     * Updates ticket status.
+                     * @param ticketId Unique ticket identifier.
+                     * @param status New status string.
+                     * @param options Optional request config override.
+                     */
+                    updateStatus: function (ticketId, status, options) { return __awaiter(_this, void 0, void 0, function () {
+                        return __generator(this, function (_a) {
+                            return [2 /*return*/, this.support.updateStatus(ticketId, status, options)];
+                        });
+                    }); },
+                    /**
+                     * Assigns or unassigns an agent to/from a support ticket.
+                     * @param ticketId Unique ticket identifier.
+                     * @param assigneeId Agent user ID or null.
+                     * @param options Optional request config override.
+                     */
+                    assign: function (ticketId, assigneeId, options) { return __awaiter(_this, void 0, void 0, function () {
+                        return __generator(this, function (_a) {
+                            return [2 /*return*/, this.support.assignTicket(ticketId, assigneeId, options)];
+                        });
+                    }); },
+                },
+                /**
+                 * Sub-namespace for live chat sessions.
+                 */
+                liveChat: {
+                    /**
+                     * Starts a new live chat session for support.
+                     * @param data Details for starting live chat session.
+                     * @param options Optional request config override.
+                     */
+                    start: function (data, options) { return __awaiter(_this, void 0, void 0, function () {
+                        return __generator(this, function (_a) {
+                            return [2 /*return*/, this.raw.supportControllerStartLiveChat(__assign(__assign({}, options), { data: data }))];
+                        });
+                    }); },
+                    /**
+                     * Ends an active live chat session.
+                     * @param sessionId Unique session identifier.
+                     * @param options Optional request config override.
+                     */
+                    end: function (sessionId, options) { return __awaiter(_this, void 0, void 0, function () {
+                        return __generator(this, function (_a) {
+                            return [2 /*return*/, this.raw.supportControllerEndLiveChat(sessionId, options)];
+                        });
+                    }); },
+                },
+                /**
+                 * Sub-namespace for managing customer profiles.
+                 */
+                customer: {
+                    /**
+                     * Creates or updates a customer profile in a workspace.
+                     * @param data Profile details including workspaceId and userId.
+                     * @param options Optional request config override.
+                     */
+                    createProfile: function (data, options) { return __awaiter(_this, void 0, void 0, function () {
+                        return __generator(this, function (_a) {
+                            return [2 /*return*/, this.raw.supportControllerCreateCustomerProfile(__assign(__assign({}, options), { data: data }))];
+                        });
+                    }); },
+                    /**
+                     * Retrieves customer profiles in a workspace.
+                     * @param workspaceId Unique workspace identifier.
+                     * @param options Optional request config override.
+                     */
+                    getProfiles: function (workspaceId, options) { return __awaiter(_this, void 0, void 0, function () {
+                        return __generator(this, function (_a) {
+                            return [2 /*return*/, this.raw.supportControllerGetCustomerProfiles({ workspaceId: workspaceId }, options)];
+                        });
+                    }); },
+                },
+            };
+        },
+        enumerable: false,
+        configurable: true
+    });
     Object.defineProperty(ScrymeSDK.prototype, "m2m", {
         /**
          * First-class namespace for Machine-to-Machine (M2M) operations,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scryme/chat",
-  "version": "2.57.1",
+  "version": "2.81.1",
   "private": false,
   "publishConfig": {
     "access": "public"

package/src/__tests__/sdk.test.ts

@@ -154,6 +154,32 @@ vi.mock('../generated/v3-server', () => {
       v3OAuthControllerGetToken: vi.fn(async (data, options) => {
         return { success: true, data, options };
       }),
+
+      // Support Controller Mock
+      supportControllerCreateTicket: vi.fn(async (options) => {
+        return { success: true, ticket: options?.data, options };
+      }),
+      supportControllerGetTickets: vi.fn(async (params, options) => {
+        return { success: true, workspaceId: params?.workspaceId, tickets: [], options };
+      }),
+      supportControllerStartLiveChat: vi.fn(async (options) => {
+        return { success: true, session: options?.data, options };
+      }),
+      supportControllerEndLiveChat: vi.fn(async (sessionId, options) => {
+        return { success: true, sessionId, options };
+      }),
+      supportControllerUpdateTicketStatus: vi.fn(async (ticketId, options) => {
+        return { success: true, ticketId, status: options?.data?.status, options };
+      }),
+      supportControllerAssignTicket: vi.fn(async (ticketId, options) => {
+        return { success: true, ticketId, assigneeId: options?.data?.assigneeId, options };
+      }),
+      supportControllerCreateCustomerProfile: vi.fn(async (options) => {
+        return { success: true, profile: options?.data, options };
+      }),
+      supportControllerGetCustomerProfiles: vi.fn(async (params, options) => {
+        return { success: true, workspaceId: params?.workspaceId, profiles: [], options };
+      }),
     })),
   };
 });
@@ -451,5 +477,63 @@ describe('ScrymeSDK', () => {
       const tokenRes = await sdk.m2m.auth.token('cid', 'sec') as any;
       expect(tokenRes.data.client_id).toBe('cid');
     });
+
+    it('should support sdk.support ticketing and customer operations', async () => {
+      const sdk = new ScrymeSDK({
+        baseURL: 'https://api.test.com',
+        token: 'active-token',
+      });
+
+      // support.createTicket
+      const ticketDto = { workspaceId: 'ws-123', subject: 'Billing Issue', initialMessage: 'Need help with invoice' };
+      const createRes = await sdk.support.createTicket(ticketDto) as any;
+      expect(createRes.success).toBe(true);
+      expect(createRes.ticket).toEqual(ticketDto);
+
+      // support.getTickets
+      const getRes = await sdk.support.getTickets('ws-123') as any;
+      expect(getRes.success).toBe(true);
+      expect(getRes.workspaceId).toBe('ws-123');
+
+      // support.updateStatus
+      const statusRes = await sdk.support.updateStatus('t-1', 'RESOLVED') as any;
+      expect(statusRes.success).toBe(true);
+      expect(statusRes.ticketId).toBe('t-1');
+      expect(statusRes.status).toBe('RESOLVED');
+
+      // support.assignTicket
+      const assignRes = await sdk.support.assignTicket('t-1', 'agent-99') as any;
+      expect(assignRes.success).toBe(true);
+      expect(assignRes.ticketId).toBe('t-1');
+      expect(assignRes.assigneeId).toBe('agent-99');
+
+      // support.tickets sub-namespace
+      const ticketSubCreate = await sdk.support.tickets.create(ticketDto) as any;
+      expect(ticketSubCreate.ticket).toEqual(ticketDto);
+
+      const ticketSubList = await sdk.support.tickets.list('ws-123') as any;
+      expect(ticketSubList.workspaceId).toBe('ws-123');
+
+      const ticketSubStatus = await sdk.support.tickets.updateStatus('t-2', 'CLOSED') as any;
+      expect(ticketSubStatus.status).toBe('CLOSED');
+
+      const ticketSubAssign = await sdk.support.tickets.assign('t-2', null) as any;
+      expect(ticketSubAssign.assigneeId).toBeNull();
+
+      // support.liveChat sub-namespace
+      const liveChatStart = await sdk.support.liveChat.start({ workspaceId: 'ws-123', metadata: { source: 'web' } }) as any;
+      expect(liveChatStart.session.workspaceId).toBe('ws-123');
+
+      const liveChatEnd = await sdk.support.liveChat.end('session-789') as any;
+      expect(liveChatEnd.sessionId).toBe('session-789');
+
+      // support.customer sub-namespace
+      const custDto = { workspaceId: 'ws-123', userId: 'usr-1', company: 'Acme Corp' };
+      const custCreate = await sdk.support.customer.createProfile(custDto) as any;
+      expect(custCreate.profile).toEqual(custDto);
+
+      const custGet = await sdk.support.customer.getProfiles('ws-123') as any;
+      expect(custGet.workspaceId).toBe('ws-123');
+    });
   });
 });