@zaapi/open-api-mcp 1.2.0 → 1.4.0

package/dist/tools/messages/send-email.js

@@ -0,0 +1,27 @@
+import { z } from 'zod';
+import { emailMessageFields, hasEmailContent, } from '../common.js';
+const queryKeys = [];
+export const sendEmail = {
+    name: 'sendEmail',
+    title: 'Send an email on a conversation',
+    description: "Send an email on an existing Gmail or Outlook conversation. Check the conversation's account channel first; the API does not reject other channels. Pass text, html, or both — at least one non-empty string. to is required, because Outlook cannot infer recipients from the thread. This reaches a real customer and cannot be recalled, so confirm the recipients and wording before calling it. A retry sends another email. The response is only an acknowledgement, so re-read with getMessages to confirm it landed. Requires the messages:write scope.",
+    scope: 'messages:write',
+    method: 'POST',
+    path: '/v1/messages/email',
+    queryKeys,
+    inputSchema: z
+        .object({
+        conversationId: z
+            .string()
+            .min(1)
+            .describe('Gmail or Outlook conversation to send on.'),
+        ...emailMessageFields,
+    })
+        .refine(hasEmailContent, { message: 'Send text and/or html.' }),
+    annotations: {
+        readOnlyHint: false,
+        destructiveHint: false,
+        openWorldHint: true,
+    },
+};
+//# sourceMappingURL=send-email.js.map

package/dist/tools/messages/send-email.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"send-email.js","sourceRoot":"","sources":["../../../src/tools/messages/send-email.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EACL,kBAAkB,EAClB,eAAe,GAEhB,MAAM,cAAc,CAAC;AAEtB,MAAM,SAAS,GAAG,EAAW,CAAC;AAE9B,MAAM,CAAC,MAAM,SAAS,GAAiB;IACrC,IAAI,EAAE,WAAW;IACjB,KAAK,EAAE,iCAAiC;IACxC,WAAW,EACT,iiBAAiiB;IACniB,KAAK,EAAE,gBAAgB;IACvB,MAAM,EAAE,MAAM;IACd,IAAI,EAAE,oBAAoB;IAC1B,SAAS;IACT,WAAW,EAAE,CAAC;SACX,MAAM,CAAC;QACN,cAAc,EAAE,CAAC;aACd,MAAM,EAAE;aACR,GAAG,CAAC,CAAC,CAAC;aACN,QAAQ,CAAC,2CAA2C,CAAC;QACxD,GAAG,kBAAkB;KACtB,CAAC;SACD,MAAM,CAAC,eAAe,EAAE,EAAE,OAAO,EAAE,wBAAwB,EAAE,CAAC;IACjE,WAAW,EAAE;QACX,YAAY,EAAE,KAAK;QACnB,eAAe,EAAE,KAAK;QACtB,aAAa,EAAE,IAAI;KACpB;CACF,CAAC"}

package/dist/tools/messages/send-new-email.js

@@ -0,0 +1,27 @@
+import { z } from 'zod';
+import { emailMessageFields, hasEmailContent, } from '../common.js';
+const queryKeys = [];
+export const sendNewEmail = {
+    name: 'sendNewEmail',
+    title: 'Start an email thread',
+    description: 'Send an email from a Gmail or Outlook account and start a conversation. accountId comes from listAccounts and must be gmail or outlook. The API does not reject other channels, so check before calling. Pass text, html, or both — at least one non-empty string. to is required and accepts 1 to 50 addresses. This reaches a real customer and cannot be recalled, so confirm the recipients and wording before calling it. A retry sends another email. The response is only an acknowledgement and does not include the new conversation. Requires the messages:write scope.',
+    scope: 'messages:write',
+    method: 'POST',
+    path: '/v1/messages/email/new',
+    queryKeys,
+    inputSchema: z
+        .object({
+        accountId: z
+            .string()
+            .min(1)
+            .describe('Gmail or Outlook account to send from. Use an id from listAccounts.'),
+        ...emailMessageFields,
+    })
+        .refine(hasEmailContent, { message: 'Send text and/or html.' }),
+    annotations: {
+        readOnlyHint: false,
+        destructiveHint: false,
+        openWorldHint: true,
+    },
+};
+//# sourceMappingURL=send-new-email.js.map

package/dist/tools/messages/send-new-email.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"send-new-email.js","sourceRoot":"","sources":["../../../src/tools/messages/send-new-email.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EACL,kBAAkB,EAClB,eAAe,GAEhB,MAAM,cAAc,CAAC;AAEtB,MAAM,SAAS,GAAG,EAAW,CAAC;AAE9B,MAAM,CAAC,MAAM,YAAY,GAAiB;IACxC,IAAI,EAAE,cAAc;IACpB,KAAK,EAAE,uBAAuB;IAC9B,WAAW,EACT,mjBAAmjB;IACrjB,KAAK,EAAE,gBAAgB;IACvB,MAAM,EAAE,MAAM;IACd,IAAI,EAAE,wBAAwB;IAC9B,SAAS;IACT,WAAW,EAAE,CAAC;SACX,MAAM,CAAC;QACN,SAAS,EAAE,CAAC;aACT,MAAM,EAAE;aACR,GAAG,CAAC,CAAC,CAAC;aACN,QAAQ,CACP,qEAAqE,CACtE;QACH,GAAG,kBAAkB;KACtB,CAAC;SACD,MAAM,CAAC,eAAe,EAAE,EAAE,OAAO,EAAE,wBAAwB,EAAE,CAAC;IACjE,WAAW,EAAE;QACX,YAAY,EAAE,KAAK;QACnB,eAAe,EAAE,KAAK;QACtB,aAAa,EAAE,IAAI;KACpB;CACF,CAAC"}

package/dist/tools/messages/send-new-whatsapp-template.js

@@ -0,0 +1,35 @@
+import { z } from 'zod';
+const queryKeys = [];
+export const sendNewWhatsappTemplate = {
+    name: 'sendNewWhatsappTemplate',
+    title: 'Send a WhatsApp template to a phone number',
+    description: 'Send an approved WhatsApp template to a phone number from a WhatsApp account, and start a conversation when that phone has no thread on the account. accountId comes from listAccounts and must be whatsapp. phoneNumber is E.164, for example +66812345678. templateId and variables work the same way as sendWhatsappTemplate. This reaches a real customer and cannot be recalled, so confirm the recipient, template, and variables before calling it. A retry sends the template again. A 400 means the account is not WhatsApp or has no WhatsApp credentials, the template cannot be sent (not APPROVED, NAMED parameters, header or button variables, or a YELLOW or RED quality score), or it is a MARKETING template to a contact who opted out. The response is only an acknowledgement and does not include the new conversation. Requires the messages:write scope.',
+    scope: 'messages:write',
+    method: 'POST',
+    path: '/v1/messages/whatsapp/new',
+    queryKeys,
+    inputSchema: z.object({
+        accountId: z
+            .string()
+            .min(1)
+            .describe('WhatsApp account to send from. Use an id from listAccounts whose channel is whatsapp.'),
+        phoneNumber: z
+            .string()
+            .regex(/^\+[1-9]\d{1,14}$/)
+            .describe('Recipient phone number in E.164 format, for example +66812345678.'),
+        templateId: z
+            .string()
+            .min(1)
+            .describe('Template id from listWhatsappTemplates. Status must be APPROVED.'),
+        variables: z
+            .array(z.string())
+            .optional()
+            .describe('Positional body values for a template whose body contains {{1}}, {{2}}, and so on, in that order. Omit when the body has no placeholders.'),
+    }),
+    annotations: {
+        readOnlyHint: false,
+        destructiveHint: false,
+        openWorldHint: true,
+    },
+};
+//# sourceMappingURL=send-new-whatsapp-template.js.map

package/dist/tools/messages/send-new-whatsapp-template.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"send-new-whatsapp-template.js","sourceRoot":"","sources":["../../../src/tools/messages/send-new-whatsapp-template.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAGxB,MAAM,SAAS,GAAG,EAAW,CAAC;AAE9B,MAAM,CAAC,MAAM,uBAAuB,GAAiB;IACnD,IAAI,EAAE,yBAAyB;IAC/B,KAAK,EAAE,4CAA4C;IACnD,WAAW,EACT,k1BAAk1B;IACp1B,KAAK,EAAE,gBAAgB;IACvB,MAAM,EAAE,MAAM;IACd,IAAI,EAAE,2BAA2B;IACjC,SAAS;IACT,WAAW,EAAE,CAAC,CAAC,MAAM,CAAC;QACpB,SAAS,EAAE,CAAC;aACT,MAAM,EAAE;aACR,GAAG,CAAC,CAAC,CAAC;aACN,QAAQ,CACP,uFAAuF,CACxF;QACH,WAAW,EAAE,CAAC;aACX,MAAM,EAAE;aACR,KAAK,CAAC,mBAAmB,CAAC;aAC1B,QAAQ,CACP,mEAAmE,CACpE;QACH,UAAU,EAAE,CAAC;aACV,MAAM,EAAE;aACR,GAAG,CAAC,CAAC,CAAC;aACN,QAAQ,CACP,kEAAkE,CACnE;QACH,SAAS,EAAE,CAAC;aACT,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;aACjB,QAAQ,EAAE;aACV,QAAQ,CACP,2IAA2I,CAC5I;KACJ,CAAC;IACF,WAAW,EAAE;QACX,YAAY,EAAE,KAAK;QACnB,eAAe,EAAE,KAAK;QACtB,aAAa,EAAE,IAAI;KACpB;CACF,CAAC"}

package/dist/tools/messages/send-plain-text-message.js

@@ -1,24 +1,25 @@
 import { z } from 'zod';
-import { describeHttpRequest } from '../common.js';
 const queryKeys = [];
 export const sendPlainTextMessage = {
     name: 'sendPlainTextMessage',
     title: 'Send a plain text message',
-    description: `Required scope: messages:write. ${describeHttpRequest('POST', '/v1/messages/plain-text', queryKeys)} Send plain text to the customer on a conversation.`,
+    description: 'Send plain text to the customer on a conversation. This reaches a real person on the channel and cannot be recalled, so confirm the wording before calling it; for a note only the team can see, use createInternalComment instead. Delivery can still fail downstream when the account is unhealthy or the channel has closed its reply window — the response is only an acknowledgement, so re-read with getMessages to confirm the message landed. Requires the messages:write scope.',
+    scope: 'messages:write',
     method: 'POST',
     path: '/v1/messages/plain-text',
     queryKeys,
     inputSchema: z.object({
-        conversationId: z
-            .string()
-            .min(1)
-            .describe('JSON body. The ID of the conversation.'),
+        conversationId: z.string().min(1).describe('The ID of the conversation.'),
         text: z
             .string()
             .min(1)
             .max(1000)
-            .describe('JSON body. Plain text to send to the customer. Maximum 1000 characters.'),
+            .describe('Plain text sent to the customer. Maximum 1000 characters.'),
     }),
-    annotations: { readOnlyHint: false, destructiveHint: false },
+    annotations: {
+        readOnlyHint: false,
+        destructiveHint: false,
+        openWorldHint: true,
+    },
 };
 //# sourceMappingURL=send-plain-text-message.js.map

package/dist/tools/messages/send-plain-text-message.js.map

@@ -1 +1 @@
-{"version":3,"file":"send-plain-text-message.js","sourceRoot":"","sources":["../../../src/tools/messages/send-plain-text-message.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,mBAAmB,EAAqB,MAAM,cAAc,CAAC;AAEtE,MAAM,SAAS,GAAG,EAAW,CAAC;AAE9B,MAAM,CAAC,MAAM,oBAAoB,GAAiB;IAChD,IAAI,EAAE,sBAAsB;IAC5B,KAAK,EAAE,2BAA2B;IAClC,WAAW,EAAE,mCAAmC,mBAAmB,CAAC,MAAM,EAAE,yBAAyB,EAAE,SAAS,CAAC,qDAAqD;IACtK,MAAM,EAAE,MAAM;IACd,IAAI,EAAE,yBAAyB;IAC/B,SAAS;IACT,WAAW,EAAE,CAAC,CAAC,MAAM,CAAC;QACpB,cAAc,EAAE,CAAC;aACd,MAAM,EAAE;aACR,GAAG,CAAC,CAAC,CAAC;aACN,QAAQ,CAAC,wCAAwC,CAAC;QACrD,IAAI,EAAE,CAAC;aACJ,MAAM,EAAE;aACR,GAAG,CAAC,CAAC,CAAC;aACN,GAAG,CAAC,IAAI,CAAC;aACT,QAAQ,CACP,yEAAyE,CAC1E;KACJ,CAAC;IACF,WAAW,EAAE,EAAE,YAAY,EAAE,KAAK,EAAE,eAAe,EAAE,KAAK,EAAE;CAC7D,CAAC"}
+{"version":3,"file":"send-plain-text-message.js","sourceRoot":"","sources":["../../../src/tools/messages/send-plain-text-message.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAGxB,MAAM,SAAS,GAAG,EAAW,CAAC;AAE9B,MAAM,CAAC,MAAM,oBAAoB,GAAiB;IAChD,IAAI,EAAE,sBAAsB;IAC5B,KAAK,EAAE,2BAA2B;IAClC,WAAW,EACT,0dAA0d;IAC5d,KAAK,EAAE,gBAAgB;IACvB,MAAM,EAAE,MAAM;IACd,IAAI,EAAE,yBAAyB;IAC/B,SAAS;IACT,WAAW,EAAE,CAAC,CAAC,MAAM,CAAC;QACpB,cAAc,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,6BAA6B,CAAC;QACzE,IAAI,EAAE,CAAC;aACJ,MAAM,EAAE;aACR,GAAG,CAAC,CAAC,CAAC;aACN,GAAG,CAAC,IAAI,CAAC;aACT,QAAQ,CAAC,2DAA2D,CAAC;KACzE,CAAC;IACF,WAAW,EAAE;QACX,YAAY,EAAE,KAAK;QACnB,eAAe,EAAE,KAAK;QACtB,aAAa,EAAE,IAAI;KACpB;CACF,CAAC"}

package/dist/tools/messages/send-whatsapp-template.js

@@ -0,0 +1,32 @@
+import { z } from 'zod';
+const queryKeys = [];
+const variables = z
+    .array(z.string())
+    .optional()
+    .describe('Positional body values for a template whose body contains {{1}}, {{2}}, and so on, in that order. Omit when the body has no placeholders.');
+export const sendWhatsappTemplate = {
+    name: 'sendWhatsappTemplate',
+    title: 'Send a WhatsApp template',
+    description: 'Send an approved WhatsApp template on an existing WhatsApp conversation. templateId is the id from listWhatsappTemplates; pass variables in placeholder order when the body contains {{1}}, {{2}}, and so on. This reaches a real customer and cannot be recalled, so confirm the template and variables before calling it. A retry sends the template again. A 400 means the account is not WhatsApp or has no WhatsApp credentials, the template cannot be sent (not APPROVED, NAMED parameters, header or button variables, or a YELLOW or RED quality score), or it is a MARKETING template to a contact who opted out. The response is only an acknowledgement, so re-read with getMessages to confirm it landed. Requires the messages:write scope.',
+    scope: 'messages:write',
+    method: 'POST',
+    path: '/v1/messages/whatsapp',
+    queryKeys,
+    inputSchema: z.object({
+        conversationId: z
+            .string()
+            .min(1)
+            .describe('WhatsApp conversation to send on.'),
+        templateId: z
+            .string()
+            .min(1)
+            .describe('Template id from listWhatsappTemplates. Status must be APPROVED.'),
+        variables,
+    }),
+    annotations: {
+        readOnlyHint: false,
+        destructiveHint: false,
+        openWorldHint: true,
+    },
+};
+//# sourceMappingURL=send-whatsapp-template.js.map

package/dist/tools/messages/send-whatsapp-template.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"send-whatsapp-template.js","sourceRoot":"","sources":["../../../src/tools/messages/send-whatsapp-template.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAGxB,MAAM,SAAS,GAAG,EAAW,CAAC;AAE9B,MAAM,SAAS,GAAG,CAAC;KAChB,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;KACjB,QAAQ,EAAE;KACV,QAAQ,CACP,2IAA2I,CAC5I,CAAC;AAEJ,MAAM,CAAC,MAAM,oBAAoB,GAAiB;IAChD,IAAI,EAAE,sBAAsB;IAC5B,KAAK,EAAE,0BAA0B;IACjC,WAAW,EACT,2tBAA2tB;IAC7tB,KAAK,EAAE,gBAAgB;IACvB,MAAM,EAAE,MAAM;IACd,IAAI,EAAE,uBAAuB;IAC7B,SAAS;IACT,WAAW,EAAE,CAAC,CAAC,MAAM,CAAC;QACpB,cAAc,EAAE,CAAC;aACd,MAAM,EAAE;aACR,GAAG,CAAC,CAAC,CAAC;aACN,QAAQ,CAAC,mCAAmC,CAAC;QAChD,UAAU,EAAE,CAAC;aACV,MAAM,EAAE;aACR,GAAG,CAAC,CAAC,CAAC;aACN,QAAQ,CACP,kEAAkE,CACnE;QACH,SAAS;KACV,CAAC;IACF,WAAW,EAAE;QACX,YAAY,EAAE,KAAK;QACnB,eAAe,EAAE,KAAK;QACtB,aAAa,EAAE,IAAI;KACpB;CACF,CAAC"}

package/dist/tools/responses.js

@@ -0,0 +1,303 @@
+import { z } from 'zod';
+const openObject = () => z.looseObject({});
+export const channel = z.enum([
+    'line',
+    'instagram',
+    'facebook',
+    'lazada',
+    'shopee',
+    'tiktok',
+    'drunken_lullabies',
+    'whatsapp',
+    'widget',
+    'gmail',
+    'outlook',
+]);
+const relatedChannel = z.looseObject({
+    id: z.string().optional(),
+    name: z.string().optional(),
+    channel: z.string().optional(),
+});
+const relatedUser = z.looseObject({
+    id: z.string().optional(),
+    name: z.string().optional(),
+});
+const relatedSeller = z.looseObject({
+    userId: z.string().optional(),
+    name: z.string().optional(),
+    roleId: z.string().optional(),
+});
+export const ticket = z.looseObject({
+    id: z.string().optional(),
+    ticketNumber: z.string().optional(),
+    accountId: z.string().optional(),
+    account: relatedChannel.optional(),
+    conversationId: z.string().optional(),
+    conversation: relatedChannel.optional(),
+    contactId: z.string().optional(),
+    channel: channel.optional(),
+    isOpen: z.boolean().optional(),
+    openedAt: z.string().optional(),
+    closedAt: z.string().optional(),
+    reopenedAt: z.string().optional(),
+    assigneeUserId: z.string().optional().describe('User UUID (User.userId).'),
+    assignee: relatedUser.optional(),
+    handledBy: z.string().optional().describe('User UUID of whoever closed it.'),
+    handledByUser: relatedUser.optional(),
+    isFollowUp: z.boolean().optional(),
+    isSpam: z.boolean().optional(),
+    ticketFields: openObject()
+        .optional()
+        .describe('Keyed by ticket field id, plus isConverted, salesRevenue, aiCsat, aiSummary.'),
+    ticketFieldsUpdatedAt: z
+        .string()
+        .optional()
+        .describe('Echo back on the next updateTicketField or it is rejected with 409.'),
+    createdAt: z.string().optional(),
+    updatedAt: z.string().optional(),
+});
+export const ticketField = z.looseObject({
+    id: z.string().optional(),
+    name: z
+        .string()
+        .optional()
+        .describe('Label shown in the app. Match on this.'),
+    description: z.string().optional(),
+    displayType: z.string().optional(),
+    dataType: z
+        .string()
+        .optional()
+        .describe('Values must match: string, number, boolean or date.'),
+    sortOrder: z.number().optional(),
+    selectOptions: z
+        .array(openObject())
+        .optional()
+        .describe('Permitted values for select fields.'),
+    regex: z.string().optional(),
+    isRequired: z.boolean().optional(),
+    showConditions: z.array(openObject()).optional(),
+    maxItems: z.number().optional(),
+    active: z.boolean().optional(),
+    accounts: z.array(openObject()).optional(),
+    createdAt: z.string().optional(),
+    updatedAt: z.string().optional(),
+});
+export const conversation = z.looseObject({
+    id: z.string().optional(),
+    accountId: z.string().optional(),
+    account: relatedChannel.optional(),
+    channel: channel.optional(),
+    displayName: z.string().optional(),
+    contactId: z.string().optional(),
+    referenceId: z
+        .string()
+        .optional()
+        .describe("The channel's own conversation id."),
+    labelIds: z.array(z.string()).optional(),
+    isSpam: z.boolean().optional(),
+    unreadMsgCnt: z.number().optional(),
+    allMsgCnt: z.number().optional(),
+    emailSubject: z.string().optional(),
+    lastRecipientMsgDate: z.string().optional(),
+    lastMsg: z
+        .looseObject({
+        snippet: z.string().optional(),
+        sentByRecipient: z.boolean().optional(),
+        sentAt: z.string().optional(),
+    })
+        .optional(),
+    createdAt: z.string().optional(),
+    updatedAt: z.string().optional(),
+});
+export const contact = z.looseObject({
+    id: z.string().optional(),
+    fullName: z.string().optional(),
+    firstName: z.string().optional(),
+    lastName: z.string().optional(),
+    email: z.string().optional(),
+    phone: z.string().optional(),
+    secondaryPhones: z.array(z.string()).optional(),
+    secondaryEmails: z.array(z.string()).optional(),
+    addresses: z.array(z.string()).optional(),
+    note: z.string().optional(),
+    customFields: openObject().optional().describe('Keyed by contact field id.'),
+    customFieldsUpdatedAt: z
+        .string()
+        .optional()
+        .describe('Echo back as updatedAt on the next updateContactField. Absent means send updatedAt instead.'),
+    createdAt: z.string().optional(),
+    updatedAt: z.string().optional(),
+});
+export const contactField = z.looseObject({
+    id: z.string().optional(),
+    name: z
+        .string()
+        .optional()
+        .describe('Label shown in the app. Match on this.'),
+    description: z.string().optional(),
+    displayType: z.string().optional(),
+    dataType: z
+        .string()
+        .optional()
+        .describe('Values must match: string, number, boolean or date.'),
+    active: z.boolean().optional(),
+    sortOrder: z.number().optional(),
+    selectOptions: z
+        .array(openObject())
+        .optional()
+        .describe('Permitted values for select fields.'),
+    regex: z.string().optional(),
+    maxItems: z.number().optional(),
+});
+export const contactSearchHit = z.looseObject({
+    id: z.string().optional(),
+    fullName: z.string().optional(),
+    phone: z.string().optional(),
+    email: z.string().optional(),
+    secondaryPhones: z.array(z.string()).optional(),
+    secondaryEmails: z.array(z.string()).optional(),
+    addresses: z.array(z.string()).optional(),
+    note: z.string().optional(),
+    matchedFields: z
+        .array(z.string())
+        .optional()
+        .describe('Which fields matched.'),
+});
+export const message = z.looseObject({
+    id: z.string().optional(),
+    conversationId: z.string().optional(),
+    text: z.string().optional(),
+    messageDirection: z
+        .enum(['inbound', 'outbound'])
+        .optional()
+        .describe('inbound is from the contact, outbound from the store.'),
+    messageCategory: z.string().optional(),
+    type: z.string().optional(),
+    sender: openObject().optional(),
+    sentAt: z.string().optional(),
+    conversation: relatedChannel.optional(),
+    account: relatedChannel.optional(),
+    sentBy: relatedSeller.optional(),
+});
+export const messageSearchHit = z.looseObject({
+    id: z.string().optional(),
+    conversationId: z.string().optional(),
+    text: z.string().optional(),
+    sentByRecipient: z
+        .boolean()
+        .optional()
+        .describe('true when the contact sent it.'),
+    sentAt: z.string().optional(),
+    score: z.number().optional().describe('Relevance score.'),
+});
+export const internalComment = z.looseObject({
+    id: z.string().optional(),
+    conversationId: z.string().optional(),
+    conversation: relatedChannel.optional(),
+    accountId: z.string().optional(),
+    account: relatedChannel.optional(),
+    authorUserId: z.string().optional(),
+    noteData: z
+        .looseObject({
+        text: z.string().optional(),
+        createdBy: z.union([z.string(), relatedSeller]).optional(),
+        tagText: z.string().optional(),
+        mediaUrl: z.string().optional(),
+    })
+        .optional(),
+    sentAt: z.string().optional(),
+    createdAt: z.string().optional(),
+    updatedAt: z.string().optional(),
+});
+export const user = z.looseObject({
+    id: z.string().optional().describe('Seat record id. Filters nothing.'),
+    name: z.string().optional(),
+    userId: z
+        .string()
+        .optional()
+        .describe('User UUID. What assignment, handledBy and the team filter match on.'),
+    roleId: z.string().optional(),
+    role: z
+        .looseObject({ id: z.string().optional(), name: z.string().optional() })
+        .optional(),
+});
+export const label = z.looseObject({
+    id: z.string().optional(),
+    label: z.string().optional().describe('The label text.'),
+    color: z.string().optional(),
+    fbAdId: z.string().optional(),
+    whatsAppAdId: z.string().optional(),
+    metaPostId: z.string().optional(),
+    whatsAppBroadcastId: z.string().optional(),
+    isSystemLabel: z.boolean().optional(),
+});
+export const team = z.looseObject({
+    id: z.string().optional(),
+    name: z.string().optional(),
+    description: z.string().optional(),
+    users: z
+        .array(z.union([z.string(), relatedUser]))
+        .optional()
+        .describe('User ids, or { id, name } under expand=users.'),
+});
+export const whatsappTemplate = z.looseObject({
+    id: z
+        .string()
+        .optional()
+        .describe('Pass this as templateId when sending the template.'),
+    name: z.string().optional(),
+    parameter_format: z
+        .string()
+        .optional()
+        .describe('POSITIONAL fills {{1}}, {{2}} in order.'),
+    language: z.string().optional(),
+    status: z.string().optional(),
+    category: z.string().optional(),
+    components: z
+        .array(z.looseObject({
+        type: z.string().optional(),
+        format: z.string().optional(),
+        text: z
+            .string()
+            .optional()
+            .describe('Body text may contain {{1}}, {{2}}, and so on.'),
+        buttons: z.array(openObject()).optional(),
+    }))
+        .optional()
+        .describe('Template parts. A BODY part may contain {{1}}, {{2}}. Pass those values as variables when sending.'),
+    quality_score: z
+        .looseObject({
+        score: z.string().optional(),
+        date: z.number().optional(),
+    })
+        .optional(),
+});
+export const account = z.looseObject({
+    id: z.string().optional(),
+    channel: channel.optional(),
+    name: z.string().optional(),
+    status: z
+        .enum(['healthy', 'unhealthy', 'disconnected'])
+        .optional()
+        .describe('Sending on anything but healthy may fail at the channel.'),
+    lastAuthorizedAt: z.string().optional(),
+    metadata: openObject().optional(),
+});
+export const acknowledgement = z
+    .looseObject({ message: z.string().optional() })
+    .describe('Acknowledgement only. Re-read the resource to confirm the result.');
+const pagination = z.looseObject({
+    pageSize: z.string().optional(),
+    nextCursor: z
+        .string()
+        .optional()
+        .describe('Pass back as cursor for the next page. Absent on the last page.'),
+});
+export function envelope(data, dataDescription, options = {}) {
+    return z.looseObject({
+        status: z.number().describe('HTTP status from the Open API.'),
+        data: data.describe(dataDescription),
+        ...(options.paginated ? { pagination: pagination.optional() } : {}),
+    });
+}
+//# sourceMappingURL=responses.js.map

package/dist/tools/responses.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"responses.js","sourceRoot":"","sources":["../../src/tools/responses.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAaxB,MAAM,UAAU,GAAG,GAAG,EAAE,CAAC,CAAC,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;AAE3C,MAAM,CAAC,MAAM,OAAO,GAAG,CAAC,CAAC,IAAI,CAAC;IAC5B,MAAM;IACN,WAAW;IACX,UAAU;IACV,QAAQ;IACR,QAAQ;IACR,QAAQ;IACR,mBAAmB;IACnB,UAAU;IACV,QAAQ;IACR,OAAO;IACP,SAAS;CACV,CAAC,CAAC;AAGH,MAAM,cAAc,GAAG,CAAC,CAAC,WAAW,CAAC;IACnC,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACzB,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC3B,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CAC/B,CAAC,CAAC;AAGH,MAAM,WAAW,GAAG,CAAC,CAAC,WAAW,CAAC;IAChC,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACzB,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CAC5B,CAAC,CAAC;AAEH,MAAM,aAAa,GAAG,CAAC,CAAC,WAAW,CAAC;IAClC,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC7B,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC3B,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CAC9B,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,MAAM,GAAG,CAAC,CAAC,WAAW,CAAC;IAClC,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACzB,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACnC,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAChC,OAAO,EAAE,cAAc,CAAC,QAAQ,EAAE;IAClC,cAAc,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACrC,YAAY,EAAE,cAAc,CAAC,QAAQ,EAAE;IACvC,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAChC,OAAO,EAAE,OAAO,CAAC,QAAQ,EAAE;IAC3B,MAAM,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IAC9B,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC/B,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC/B,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACjC,cAAc,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,0BAA0B,CAAC;IAC1E,QAAQ,EAAE,WAAW,CAAC,QAAQ,EAAE;IAChC,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,iCAAiC,CAAC;IAC5E,aAAa,EAAE,WAAW,CAAC,QAAQ,EAAE;IACrC,UAAU,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IAClC,MAAM,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IAC9B,YAAY,EAAE,UAAU,EAAE;SACvB,QAAQ,EAAE;SACV,QAAQ,CACP,8EAA8E,CAC/E;IACH,qBAAqB,EAAE,CAAC;SACrB,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,QAAQ,CACP,qEAAqE,CACtE;IACH,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAChC,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CACjC,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,CAAC,WAAW,CAAC;IACvC,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACzB,IAAI,EAAE,CAAC;SACJ,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,QAAQ,CAAC,wCAAwC,CAAC;IACrD,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAClC,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAClC,QAAQ,EAAE,CAAC;SACR,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,QAAQ,CAAC,qDAAqD,CAAC;IAClE,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAChC,aAAa,EAAE,CAAC;SACb,KAAK,CAAC,UAAU,EAAE,CAAC;SACnB,QAAQ,EAAE;SACV,QAAQ,CAAC,qCAAqC,CAAC;IAClD,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC5B,UAAU,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IAClC,cAAc,EAAE,CAAC,CAAC,KAAK,CAAC,UAAU,EAAE,CAAC,CAAC,QAAQ,EAAE;IAChD,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC/B,MAAM,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IAC9B,QAAQ,EAAE,CAAC,CAAC,KAAK,CAAC,UAAU,EAAE,CAAC,CAAC,QAAQ,EAAE;IAC1C,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAChC,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CACjC,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,CAAC,WAAW,CAAC;IACxC,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACzB,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAChC,OAAO,EAAE,cAAc,CAAC,QAAQ,EAAE;IAClC,OAAO,EAAE,OAAO,CAAC,QAAQ,EAAE;IAC3B,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAClC,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAChC,WAAW,EAAE,CAAC;SACX,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,QAAQ,CAAC,oCAAoC,CAAC;IACjD,QAAQ,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;IACxC,MAAM,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IAC9B,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACnC,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAChC,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACnC,oBAAoB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC3C,OAAO,EAAE,CAAC;SACP,WAAW,CAAC;QACX,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QAC9B,eAAe,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;QACvC,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;KAC9B,CAAC;SACD,QAAQ,EAAE;IACb,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAChC,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CACjC,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,OAAO,GAAG,CAAC,CAAC,WAAW,CAAC;IACnC,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACzB,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC/B,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAChC,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC/B,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC5B,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC5B,eAAe,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;IAC/C,eAAe,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;IAC/C,SAAS,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;IACzC,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC3B,YAAY,EAAE,UAAU,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,4BAA4B,CAAC;IAC5E,qBAAqB,EAAE,CAAC;SACrB,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,QAAQ,CACP,6FAA6F,CAC9F;IACH,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAChC,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CACjC,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,CAAC,WAAW,CAAC;IACxC,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACzB,IAAI,EAAE,CAAC;SACJ,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,QAAQ,CAAC,wCAAwC,CAAC;IACrD,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAClC,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAClC,QAAQ,EAAE,CAAC;SACR,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,QAAQ,CAAC,qDAAqD,CAAC;IAClE,MAAM,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IAC9B,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAChC,aAAa,EAAE,CAAC;SACb,KAAK,CAAC,UAAU,EAAE,CAAC;SACnB,QAAQ,EAAE;SACV,QAAQ,CAAC,qCAAqC,CAAC;IAClD,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC5B,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CAChC,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,CAAC,WAAW,CAAC;IAC5C,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACzB,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC/B,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC5B,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC5B,eAAe,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;IAC/C,eAAe,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;IAC/C,SAAS,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;IACzC,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC3B,aAAa,EAAE,CAAC;SACb,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;SACjB,QAAQ,EAAE;SACV,QAAQ,CAAC,uBAAuB,CAAC;CACrC,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,OAAO,GAAG,CAAC,CAAC,WAAW,CAAC;IACnC,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACzB,cAAc,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACrC,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC3B,gBAAgB,EAAE,CAAC;SAChB,IAAI,CAAC,CAAC,SAAS,EAAE,UAAU,CAAC,CAAC;SAC7B,QAAQ,EAAE;SACV,QAAQ,CAAC,uDAAuD,CAAC;IACpE,eAAe,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACtC,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC3B,MAAM,EAAE,UAAU,EAAE,CAAC,QAAQ,EAAE;IAC/B,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC7B,YAAY,EAAE,cAAc,CAAC,QAAQ,EAAE;IACvC,OAAO,EAAE,cAAc,CAAC,QAAQ,EAAE;IAClC,MAAM,EAAE,aAAa,CAAC,QAAQ,EAAE;CACjC,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,CAAC,WAAW,CAAC;IAC5C,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACzB,cAAc,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACrC,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC3B,eAAe,EAAE,CAAC;SACf,OAAO,EAAE;SACT,QAAQ,EAAE;SACV,QAAQ,CAAC,gCAAgC,CAAC;IAC7C,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC7B,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,kBAAkB,CAAC;CAC1D,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,CAAC,WAAW,CAAC;IAC3C,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACzB,cAAc,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACrC,YAAY,EAAE,cAAc,CAAC,QAAQ,EAAE;IACvC,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAChC,OAAO,EAAE,cAAc,CAAC,QAAQ,EAAE;IAClC,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACnC,QAAQ,EAAE,CAAC;SACR,WAAW,CAAC;QACX,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QAC3B,SAAS,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,aAAa,CAAC,CAAC,CAAC,QAAQ,EAAE;QAC1D,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QAC9B,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;KAChC,CAAC;SACD,QAAQ,EAAE;IACb,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC7B,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAChC,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CACjC,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,IAAI,GAAG,CAAC,CAAC,WAAW,CAAC;IAChC,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,kCAAkC,CAAC;IACtE,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC3B,MAAM,EAAE,CAAC;SACN,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,QAAQ,CACP,qEAAqE,CACtE;IACH,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC7B,IAAI,EAAE,CAAC;SACJ,WAAW,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,EAAE,CAAC;SACvE,QAAQ,EAAE;CACd,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,KAAK,GAAG,CAAC,CAAC,WAAW,CAAC;IACjC,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACzB,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,iBAAiB,CAAC;IACxD,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC5B,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC7B,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACnC,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACjC,mBAAmB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC1C,aAAa,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;CACtC,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,IAAI,GAAG,CAAC,CAAC,WAAW,CAAC;IAChC,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACzB,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC3B,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAClC,KAAK,EAAE,CAAC;SACL,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,WAAW,CAAC,CAAC,CAAC;SACzC,QAAQ,EAAE;SACV,QAAQ,CAAC,+CAA+C,CAAC;CAC7D,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,CAAC,WAAW,CAAC;IAC5C,EAAE,EAAE,CAAC;SACF,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,QAAQ,CAAC,oDAAoD,CAAC;IACjE,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC3B,gBAAgB,EAAE,CAAC;SAChB,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,QAAQ,CAAC,yCAAyC,CAAC;IACtD,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC/B,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC7B,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC/B,UAAU,EAAE,CAAC;SACV,KAAK,CACJ,CAAC,CAAC,WAAW,CAAC;QACZ,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QAC3B,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QAC7B,IAAI,EAAE,CAAC;aACJ,MAAM,EAAE;aACR,QAAQ,EAAE;aACV,QAAQ,CAAC,gDAAgD,CAAC;QAC7D,OAAO,EAAE,CAAC,CAAC,KAAK,CAAC,UAAU,EAAE,CAAC,CAAC,QAAQ,EAAE;KAC1C,CAAC,CACH;SACA,QAAQ,EAAE;SACV,QAAQ,CACP,oGAAoG,CACrG;IACH,aAAa,EAAE,CAAC;SACb,WAAW,CAAC;QACX,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QAC5B,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;KAC5B,CAAC;SACD,QAAQ,EAAE;CACd,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,OAAO,GAAG,CAAC,CAAC,WAAW,CAAC;IACnC,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACzB,OAAO,EAAE,OAAO,CAAC,QAAQ,EAAE;IAC3B,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC3B,MAAM,EAAE,CAAC;SACN,IAAI,CAAC,CAAC,SAAS,EAAE,WAAW,EAAE,cAAc,CAAC,CAAC;SAC9C,QAAQ,EAAE;SACV,QAAQ,CAAC,0DAA0D,CAAC;IACvE,gBAAgB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACvC,QAAQ,EAAE,UAAU,EAAE,CAAC,QAAQ,EAAE;CAClC,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC;KAC7B,WAAW,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,EAAE,CAAC;KAC/C,QAAQ,CACP,mEAAmE,CACpE,CAAC;AAEJ,MAAM,UAAU,GAAG,CAAC,CAAC,WAAW,CAAC;IAC/B,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC/B,UAAU,EAAE,CAAC;SACV,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,QAAQ,CACP,iEAAiE,CAClE;CACJ,CAAC,CAAC;AAOH,MAAM,UAAU,QAAQ,CACtB,IAAO,EACP,eAAuB,EACvB,UAAmC,EAAE;IAErC,OAAO,CAAC,CAAC,WAAW,CAAC;QACnB,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,gCAAgC,CAAC;QAC7D,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,eAAe,CAAC;QACpC,GAAG,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,UAAU,EAAE,UAAU,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;KACpE,CAAC,CAAC;AACL,CAAC"}

package/dist/tools/teams/list-teams.js

@@ -1,10 +1,12 @@
 import { z } from 'zod';
-import { describeHttpRequest, expand, paginationFields, paginationQueryKeys, } from '../common.js';
+import { expand, paginationFields, paginationQueryKeys, } from '../common.js';
+import { envelope, team } from '../responses.js';
 const queryKeys = ['userId', ...paginationQueryKeys];
 export const listTeams = {
     name: 'listTeams',
     title: 'List teams',
-    description: `Required scope: teams:read. ${describeHttpRequest('GET', '/v1/teams', queryKeys)} Teams for the store. Pass userId to return only teams containing that user. Pass expand=users to return member { id, name }.`,
+    description: 'Page through the teams on the store and their members. Pass userId to return only the teams containing that user. There is no team filter on tickets — to scope a ticket query to a team, read its members here and pass their UUIDs as listTickets assigneeUserIds. Requires the teams:read scope.',
+    scope: 'teams:read',
     method: 'GET',
     path: '/v1/teams',
     queryKeys,
@@ -13,10 +15,13 @@ export const listTeams = {
             .string()
             .min(1)
             .optional()
-            .describe('Query parameter. Return only teams containing this user (UUID).'),
+            .describe('Return only teams containing this user UUID.'),
         ...paginationFields,
-        expand: expand('Pass users to return each member as { id, name } when that user exists on the store.'),
+        expand: expand(['users'], 'Return each member as { id, name } when that user still exists on the store.'),
     }),
-    annotations: { readOnlyHint: true },
+    outputSchema: envelope(z.array(team), 'A page of teams.', {
+        paginated: true,
+    }),
+    annotations: { readOnlyHint: true, openWorldHint: true },
 };
 //# sourceMappingURL=list-teams.js.map

package/dist/tools/teams/list-teams.js.map

@@ -1 +1 @@
-{"version":3,"file":"list-teams.js","sourceRoot":"","sources":["../../../src/tools/teams/list-teams.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EACL,mBAAmB,EACnB,MAAM,EACN,gBAAgB,EAChB,mBAAmB,GAEpB,MAAM,cAAc,CAAC;AAEtB,MAAM,SAAS,GAAG,CAAC,QAAQ,EAAE,GAAG,mBAAmB,CAAC,CAAC;AAErD,MAAM,CAAC,MAAM,SAAS,GAAiB;IACrC,IAAI,EAAE,WAAW;IACjB,KAAK,EAAE,YAAY;IACnB,WAAW,EAAE,+BAA+B,mBAAmB,CAAC,KAAK,EAAE,WAAW,EAAE,SAAS,CAAC,+HAA+H;IAC7N,MAAM,EAAE,KAAK;IACb,IAAI,EAAE,WAAW;IACjB,SAAS;IACT,WAAW,EAAE,CAAC,CAAC,MAAM,CAAC;QACpB,MAAM,EAAE,CAAC;aACN,MAAM,EAAE;aACR,GAAG,CAAC,CAAC,CAAC;aACN,QAAQ,EAAE;aACV,QAAQ,CACP,iEAAiE,CAClE;QACH,GAAG,gBAAgB;QACnB,MAAM,EAAE,MAAM,CACZ,sFAAsF,CACvF;KACF,CAAC;IACF,WAAW,EAAE,EAAE,YAAY,EAAE,IAAI,EAAE;CACpC,CAAC"}
+{"version":3,"file":"list-teams.js","sourceRoot":"","sources":["../../../src/tools/teams/list-teams.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EACL,MAAM,EACN,gBAAgB,EAChB,mBAAmB,GAEpB,MAAM,cAAc,CAAC;AACtB,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,iBAAiB,CAAC;AAEjD,MAAM,SAAS,GAAG,CAAC,QAAQ,EAAE,GAAG,mBAAmB,CAAC,CAAC;AAErD,MAAM,CAAC,MAAM,SAAS,GAAiB;IACrC,IAAI,EAAE,WAAW;IACjB,KAAK,EAAE,YAAY;IACnB,WAAW,EACT,qSAAqS;IACvS,KAAK,EAAE,YAAY;IACnB,MAAM,EAAE,KAAK;IACb,IAAI,EAAE,WAAW;IACjB,SAAS;IACT,WAAW,EAAE,CAAC,CAAC,MAAM,CAAC;QACpB,MAAM,EAAE,CAAC;aACN,MAAM,EAAE;aACR,GAAG,CAAC,CAAC,CAAC;aACN,QAAQ,EAAE;aACV,QAAQ,CAAC,8CAA8C,CAAC;QAC3D,GAAG,gBAAgB;QACnB,MAAM,EAAE,MAAM,CACZ,CAAC,OAAO,CAAC,EACT,8EAA8E,CAC/E;KACF,CAAC;IACF,YAAY,EAAE,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,kBAAkB,EAAE;QACxD,SAAS,EAAE,IAAI;KAChB,CAAC;IACF,WAAW,EAAE,EAAE,YAAY,EAAE,IAAI,EAAE,aAAa,EAAE,IAAI,EAAE;CACzD,CAAC"}

package/dist/tools/tickets/close-ticket.js

@@ -1,40 +1,47 @@
 import { z } from 'zod';
-import { describeHttpRequest, expand, fieldValue, } from '../common.js';
+import { expand, fieldValue } from '../common.js';
+import { envelope, ticket } from '../responses.js';
 const queryKeys = ['expand'];
 export const closeTicket = {
     name: 'closeTicket',
     title: 'Close a ticket',
-    description: `Required scope: tickets:write. ${describeHttpRequest('PATCH', '/v1/tickets/close', queryKeys)} Close a ticket. You can record who handled it, conversion details, and ticket field values in the same request.`,
+    description: 'Close a ticket, optionally recording who handled it, whether it converted, and any ticket field values in the same request. Closing ends the ticket that fronts the conversation, so confirm with the user before calling it. handledBy is a user UUID — the userId from listUsers, not the id beside it. Requires the tickets:write scope.',
+    scope: 'tickets:write',
     method: 'PATCH',
     path: '/v1/tickets/close',
     queryKeys,
     inputSchema: z.object({
-        expand: expand('Related objects to include on the closed ticket: account, conversation, assignee, handledBy.'),
-        ticketId: z.string().min(1).describe('JSON body. The ID of the ticket.'),
+        expand: expand(['account', 'conversation', 'assignee', 'handledBy'], 'Replace these ids on the returned ticket with the named object.'),
+        ticketId: z.string().min(1).describe('The ID of the ticket.'),
         handledBy: z
             .string()
             .min(1)
             .optional()
-            .describe('JSON body. UUID of the user who handled the ticket.'),
+            .describe('User UUID of whoever handled the ticket, from listUsers userId.'),
         isConverted: z
             .boolean()
             .optional()
-            .describe('JSON body. Whether the conversation led to a conversion.'),
+            .describe('Whether the conversation led to a conversion.'),
         totalRevenue: z
             .number()
             .min(0)
             .optional()
-            .describe('JSON body. Conversion revenue recorded on close.'),
+            .describe('Conversion revenue recorded on close.'),
         currency: z
             .string()
             .optional()
-            .describe('JSON body. Currency of the conversion revenue.'),
+            .describe('Currency of the conversion revenue.'),
         ticketFields: z
             .object({})
             .catchall(fieldValue)
             .optional()
-            .describe('JSON body. Ticket field values to set when closing, keyed by field id. Must be a non-empty object when sent.'),
+            .describe('Ticket field values to set while closing, keyed by field id from listTicketFields. Must be non-empty when sent.'),
     }),
-    annotations: { readOnlyHint: false, destructiveHint: true },
+    outputSchema: envelope(ticket, 'The ticket after it was closed.'),
+    annotations: {
+        readOnlyHint: false,
+        destructiveHint: true,
+        openWorldHint: true,
+    },
 };
 //# sourceMappingURL=close-ticket.js.map

package/dist/tools/tickets/close-ticket.js.map

@@ -1 +1 @@
-{"version":3,"file":"close-ticket.js","sourceRoot":"","sources":["../../../src/tools/tickets/close-ticket.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EACL,mBAAmB,EACnB,MAAM,EACN,UAAU,GAEX,MAAM,cAAc,CAAC;AAEtB,MAAM,SAAS,GAAG,CAAC,QAAQ,CAAU,CAAC;AAEtC,MAAM,CAAC,MAAM,WAAW,GAAiB;IACvC,IAAI,EAAE,aAAa;IACnB,KAAK,EAAE,gBAAgB;IACvB,WAAW,EAAE,kCAAkC,mBAAmB,CAAC,OAAO,EAAE,mBAAmB,EAAE,SAAS,CAAC,kHAAkH;IAC7N,MAAM,EAAE,OAAO;IACf,IAAI,EAAE,mBAAmB;IACzB,SAAS;IACT,WAAW,EAAE,CAAC,CAAC,MAAM,CAAC;QACpB,MAAM,EAAE,MAAM,CACZ,8FAA8F,CAC/F;QACD,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,kCAAkC,CAAC;QACxE,SAAS,EAAE,CAAC;aACT,MAAM,EAAE;aACR,GAAG,CAAC,CAAC,CAAC;aACN,QAAQ,EAAE;aACV,QAAQ,CAAC,qDAAqD,CAAC;QAClE,WAAW,EAAE,CAAC;aACX,OAAO,EAAE;aACT,QAAQ,EAAE;aACV,QAAQ,CAAC,0DAA0D,CAAC;QACvE,YAAY,EAAE,CAAC;aACZ,MAAM,EAAE;aACR,GAAG,CAAC,CAAC,CAAC;aACN,QAAQ,EAAE;aACV,QAAQ,CAAC,kDAAkD,CAAC;QAC/D,QAAQ,EAAE,CAAC;aACR,MAAM,EAAE;aACR,QAAQ,EAAE;aACV,QAAQ,CAAC,gDAAgD,CAAC;QAC7D,YAAY,EAAE,CAAC;aACZ,MAAM,CAAC,EAAE,CAAC;aACV,QAAQ,CAAC,UAAU,CAAC;aACpB,QAAQ,EAAE;aACV,QAAQ,CACP,8GAA8G,CAC/G;KACJ,CAAC;IACF,WAAW,EAAE,EAAE,YAAY,EAAE,KAAK,EAAE,eAAe,EAAE,IAAI,EAAE;CAC5D,CAAC"}
+{"version":3,"file":"close-ticket.js","sourceRoot":"","sources":["../../../src/tools/tickets/close-ticket.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,MAAM,EAAE,UAAU,EAAqB,MAAM,cAAc,CAAC;AACrE,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAC;AAEnD,MAAM,SAAS,GAAG,CAAC,QAAQ,CAAU,CAAC;AAEtC,MAAM,CAAC,MAAM,WAAW,GAAiB;IACvC,IAAI,EAAE,aAAa;IACnB,KAAK,EAAE,gBAAgB;IACvB,WAAW,EACT,6UAA6U;IAC/U,KAAK,EAAE,eAAe;IACtB,MAAM,EAAE,OAAO;IACf,IAAI,EAAE,mBAAmB;IACzB,SAAS;IACT,WAAW,EAAE,CAAC,CAAC,MAAM,CAAC;QACpB,MAAM,EAAE,MAAM,CACZ,CAAC,SAAS,EAAE,cAAc,EAAE,UAAU,EAAE,WAAW,CAAC,EACpD,iEAAiE,CAClE;QACD,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,uBAAuB,CAAC;QAC7D,SAAS,EAAE,CAAC;aACT,MAAM,EAAE;aACR,GAAG,CAAC,CAAC,CAAC;aACN,QAAQ,EAAE;aACV,QAAQ,CACP,iEAAiE,CAClE;QACH,WAAW,EAAE,CAAC;aACX,OAAO,EAAE;aACT,QAAQ,EAAE;aACV,QAAQ,CAAC,+CAA+C,CAAC;QAC5D,YAAY,EAAE,CAAC;aACZ,MAAM,EAAE;aACR,GAAG,CAAC,CAAC,CAAC;aACN,QAAQ,EAAE;aACV,QAAQ,CAAC,uCAAuC,CAAC;QACpD,QAAQ,EAAE,CAAC;aACR,MAAM,EAAE;aACR,QAAQ,EAAE;aACV,QAAQ,CAAC,qCAAqC,CAAC;QAClD,YAAY,EAAE,CAAC;aACZ,MAAM,CAAC,EAAE,CAAC;aACV,QAAQ,CAAC,UAAU,CAAC;aACpB,QAAQ,EAAE;aACV,QAAQ,CACP,iHAAiH,CAClH;KACJ,CAAC;IACF,YAAY,EAAE,QAAQ,CAAC,MAAM,EAAE,iCAAiC,CAAC;IACjE,WAAW,EAAE;QACX,YAAY,EAAE,KAAK;QACnB,eAAe,EAAE,IAAI;QACrB,aAAa,EAAE,IAAI;KACpB;CACF,CAAC"}