@credal/actions 0.2.228 → 0.2.229

package/dist/actions/autogen/templates.js

@@ -4418,7 +4418,8 @@ export const zendeskCreateZendeskTicketDefinition = {
             },
             subdomain: {
                 type: "string",
-                description: "The subdomain of the Zendesk account",
+                pattern: "^[A-Za-z0-9](?:[A-Za-z0-9-]{0,61}[A-Za-z0-9])?$",
+                description: "The hostname-label subdomain of the Zendesk account, without a protocol, path, or .zendesk.com suffix",
                 tags: ["recommend-predefined"],
             },
             groupId: {
@@ -4455,7 +4456,8 @@ export const zendeskListZendeskTicketsDefinition = {
         properties: {
             subdomain: {
                 type: "string",
-                description: "The subdomain of the Zendesk account",
+                pattern: "^[A-Za-z0-9](?:[A-Za-z0-9-]{0,61}[A-Za-z0-9])?$",
+                description: "The hostname-label subdomain of the Zendesk account, without a protocol, path, or .zendesk.com suffix",
                 tags: ["recommend-predefined"],
             },
             status: {
@@ -4499,7 +4501,8 @@ export const zendeskGetTicketDetailsDefinition = {
             },
             subdomain: {
                 type: "string",
-                description: "The subdomain of the Zendesk account",
+                pattern: "^[A-Za-z0-9](?:[A-Za-z0-9-]{0,61}[A-Za-z0-9])?$",
+                description: "The hostname-label subdomain of the Zendesk account, without a protocol, path, or .zendesk.com suffix",
                 tags: ["recommend-predefined"],
             },
         },
@@ -4532,7 +4535,8 @@ export const zendeskUpdateTicketStatusDefinition = {
             },
             subdomain: {
                 type: "string",
-                description: "The subdomain of the Zendesk account",
+                pattern: "^[A-Za-z0-9](?:[A-Za-z0-9-]{0,61}[A-Za-z0-9])?$",
+                description: "The hostname-label subdomain of the Zendesk account, without a protocol, path, or .zendesk.com suffix",
                 tags: ["recommend-predefined"],
             },
             status: {
@@ -4559,7 +4563,8 @@ export const zendeskAddCommentToTicketDefinition = {
             },
             subdomain: {
                 type: "string",
-                description: "The subdomain of the Zendesk account",
+                pattern: "^[A-Za-z0-9](?:[A-Za-z0-9-]{0,61}[A-Za-z0-9])?$",
+                description: "The hostname-label subdomain of the Zendesk account, without a protocol, path, or .zendesk.com suffix",
                 tags: ["recommend-predefined"],
             },
             body: {
@@ -4604,7 +4609,8 @@ export const zendeskAssignTicketDefinition = {
             },
             subdomain: {
                 type: "string",
-                description: "The subdomain of the Zendesk account",
+                pattern: "^[A-Za-z0-9](?:[A-Za-z0-9-]{0,61}[A-Za-z0-9])?$",
+                description: "The hostname-label subdomain of the Zendesk account, without a protocol, path, or .zendesk.com suffix",
                 tags: ["recommend-predefined"],
             },
             assigneeEmail: {
@@ -4627,7 +4633,8 @@ export const zendeskSearchZendeskByQueryDefinition = {
         properties: {
             subdomain: {
                 type: "string",
-                description: "The subdomain of the Zendesk account",
+                pattern: "^[A-Za-z0-9](?:[A-Za-z0-9-]{0,61}[A-Za-z0-9])?$",
+                description: "The hostname-label subdomain of the Zendesk account, without a protocol, path, or .zendesk.com suffix",
                 tags: ["recommend-predefined"],
             },
             query: {

package/dist/actions/autogen/types.js

@@ -1596,7 +1596,10 @@ export const bingGetTopNSearchResultUrlsOutputSchema = z.object({
 export const zendeskCreateZendeskTicketParamsSchema = z.object({
     subject: z.string().describe("The subject of the ticket"),
     body: z.string().describe("The body of the ticket").optional(),
-    subdomain: z.string().describe("The subdomain of the Zendesk account"),
+    subdomain: z
+        .string()
+        .regex(new RegExp("^[A-Za-z0-9](?:[A-Za-z0-9-]{0,61}[A-Za-z0-9])?$"))
+        .describe("The hostname-label subdomain of the Zendesk account, without a protocol, path, or .zendesk.com suffix"),
     groupId: z.coerce.number().describe("The ID of the group to assign the ticket to").optional(),
 });
 export const zendeskCreateZendeskTicketOutputSchema = z.object({
@@ -1604,7 +1607,10 @@ export const zendeskCreateZendeskTicketOutputSchema = z.object({
     ticketUrl: z.string().describe("The URL of the ticket created").optional(),
 });
 export const zendeskListZendeskTicketsParamsSchema = z.object({
-    subdomain: z.string().describe("The subdomain of the Zendesk account"),
+    subdomain: z
+        .string()
+        .regex(new RegExp("^[A-Za-z0-9](?:[A-Za-z0-9-]{0,61}[A-Za-z0-9])?$"))
+        .describe("The hostname-label subdomain of the Zendesk account, without a protocol, path, or .zendesk.com suffix"),
     status: z.string().describe("Filter tickets by status (new, open, pending, hold, solved, closed)").optional(),
 });
 export const zendeskListZendeskTicketsOutputSchema = z.object({
@@ -1613,14 +1619,20 @@ export const zendeskListZendeskTicketsOutputSchema = z.object({
 });
 export const zendeskGetTicketDetailsParamsSchema = z.object({
     ticketId: z.string().describe("The ID of the ticket"),
-    subdomain: z.string().describe("The subdomain of the Zendesk account"),
+    subdomain: z
+        .string()
+        .regex(new RegExp("^[A-Za-z0-9](?:[A-Za-z0-9-]{0,61}[A-Za-z0-9])?$"))
+        .describe("The hostname-label subdomain of the Zendesk account, without a protocol, path, or .zendesk.com suffix"),
 });
 export const zendeskGetTicketDetailsOutputSchema = z.object({
     ticket: z.object({}).catchall(z.any()).describe("The details of the ticket"),
 });
 export const zendeskUpdateTicketStatusParamsSchema = z.object({
     ticketId: z.string().describe("The ID of the ticket to update"),
-    subdomain: z.string().describe("The subdomain of the Zendesk account"),
+    subdomain: z
+        .string()
+        .regex(new RegExp("^[A-Za-z0-9](?:[A-Za-z0-9-]{0,61}[A-Za-z0-9])?$"))
+        .describe("The hostname-label subdomain of the Zendesk account, without a protocol, path, or .zendesk.com suffix"),
     status: z
         .string()
         .describe('The state of the ticket. If your account has activated custom ticket statuses, this is the ticket\'s status category. Allowed values are "new", "open", "pending", "hold", "solved", or "closed".'),
@@ -1628,7 +1640,10 @@ export const zendeskUpdateTicketStatusParamsSchema = z.object({
 export const zendeskUpdateTicketStatusOutputSchema = z.void();
 export const zendeskAddCommentToTicketParamsSchema = z.object({
     ticketId: z.string().describe("The ID of the ticket to update"),
-    subdomain: z.string().describe("The subdomain of the Zendesk account"),
+    subdomain: z
+        .string()
+        .regex(new RegExp("^[A-Za-z0-9](?:[A-Za-z0-9-]{0,61}[A-Za-z0-9])?$"))
+        .describe("The hostname-label subdomain of the Zendesk account, without a protocol, path, or .zendesk.com suffix"),
     body: z.string().describe("The body of the comment"),
     public: z.boolean().describe("Whether the comment should be public (defaults to true)").optional(),
 });
@@ -1638,12 +1653,18 @@ export const zendeskAddCommentToTicketOutputSchema = z.object({
 });
 export const zendeskAssignTicketParamsSchema = z.object({
     ticketId: z.string().describe("The ID of the ticket to update"),
-    subdomain: z.string().describe("The subdomain of the Zendesk account"),
+    subdomain: z
+        .string()
+        .regex(new RegExp("^[A-Za-z0-9](?:[A-Za-z0-9-]{0,61}[A-Za-z0-9])?$"))
+        .describe("The hostname-label subdomain of the Zendesk account, without a protocol, path, or .zendesk.com suffix"),
     assigneeEmail: z.string().describe("The email address of the agent to assign the ticket to"),
 });
 export const zendeskAssignTicketOutputSchema = z.void();
 export const zendeskSearchZendeskByQueryParamsSchema = z.object({
-    subdomain: z.string().describe("The subdomain of the Zendesk account"),
+    subdomain: z
+        .string()
+        .regex(new RegExp("^[A-Za-z0-9](?:[A-Za-z0-9-]{0,61}[A-Za-z0-9])?$"))
+        .describe("The hostname-label subdomain of the Zendesk account, without a protocol, path, or .zendesk.com suffix"),
     query: z
         .string()
         .describe('Search query string that can include filters like status, priority, tags, assignee, etc. Examples - status:open, priority:high, tags:bug, assignee:user@example.com, or combination like "status:open priority:high"'),

package/dist/actions/providers/zendesk/addCommentToTicket.js

@@ -1,16 +1,18 @@
 import { createAxiosClientWithRetries } from "../../util/axiosClient.js";
 import { MISSING_AUTH_TOKEN } from "../../util/missingAuthConstants.js";
+import { getZendeskBaseUrl } from "./utils/getZendeskBaseUrl.js";
 const addCommentToTicket = async ({ params, authParams, }) => {
     const { authToken } = authParams;
     const { subdomain, ticketId, body, public: isPublic } = params;
-    const url = `https://${subdomain}.zendesk.com/api/v2/tickets/${ticketId}.json`;
     if (!authToken) {
         throw new Error(MISSING_AUTH_TOKEN);
     }
+    const zendeskBaseUrl = getZendeskBaseUrl({ subdomain });
+    const apiEndpoint = new URL(`/api/v2/tickets/${ticketId}.json`, zendeskBaseUrl);
     const axiosClient = createAxiosClientWithRetries({ timeout: 20000, retryCount: 5 });
     try {
         await axiosClient.request({
-            url: url,
+            url: apiEndpoint.toString(),
             method: "PUT",
             headers: {
                 "Content-Type": "application/json",
@@ -27,7 +29,7 @@ const addCommentToTicket = async ({ params, authParams, }) => {
         });
         return {
             success: true,
-            ticketUrl: `https://${subdomain}.zendesk.com/agent/tickets/${ticketId}`,
+            ticketUrl: new URL(`/agent/tickets/${ticketId}`, zendeskBaseUrl).toString(),
         };
     }
     catch (error) {

package/dist/actions/providers/zendesk/assignTicket.js

@@ -1,15 +1,17 @@
 import { createAxiosClientWithRetries } from "../../util/axiosClient.js";
 import { MISSING_AUTH_TOKEN } from "../../util/missingAuthConstants.js";
+import { getZendeskBaseUrl } from "./utils/getZendeskBaseUrl.js";
 const updateTicketStatus = async ({ params, authParams, }) => {
     const { authToken } = authParams;
     const { subdomain, ticketId, assigneeEmail } = params;
-    const url = `https://${subdomain}.zendesk.com/api/v2/tickets/${ticketId}.json`;
     if (!authToken) {
         throw new Error(MISSING_AUTH_TOKEN);
     }
+    const zendeskBaseUrl = getZendeskBaseUrl({ subdomain });
+    const apiEndpoint = new URL(`/api/v2/tickets/${ticketId}.json`, zendeskBaseUrl);
     const axiosClient = createAxiosClientWithRetries({ timeout: 10000, retryCount: 4 });
     await axiosClient.request({
-        url: url,
+        url: apiEndpoint.toString(),
         method: "PUT",
         headers: {
             "Content-Type": "application/json",

package/dist/actions/providers/zendesk/createZendeskTicket.js

@@ -1,9 +1,14 @@
 import { createAxiosClientWithRetries } from "../../util/axiosClient.js";
 import { MISSING_AUTH_TOKEN } from "../../util/missingAuthConstants.js";
+import { getZendeskBaseUrl } from "./utils/getZendeskBaseUrl.js";
 const createZendeskTicket = async ({ params, authParams, }) => {
     const { authToken } = authParams;
     const { subdomain, subject, body, groupId } = params;
-    const url = `https://${subdomain}.zendesk.com/api/v2/tickets.json`;
+    if (!authToken) {
+        throw new Error(MISSING_AUTH_TOKEN);
+    }
+    const zendeskBaseUrl = getZendeskBaseUrl({ subdomain });
+    const apiEndpoint = new URL("/api/v2/tickets.json", zendeskBaseUrl);
     const payload = {
         ticket: {
             subject,
@@ -13,11 +18,8 @@ const createZendeskTicket = async ({ params, authParams, }) => {
             group_id: groupId,
         },
     };
-    if (!authToken) {
-        throw new Error(MISSING_AUTH_TOKEN);
-    }
     const axiosClient = createAxiosClientWithRetries({ timeout: 10000, retryCount: 4 });
-    const response = await axiosClient.post(url, payload, {
+    const response = await axiosClient.post(apiEndpoint.toString(), payload, {
         headers: {
             "Content-Type": "application/json",
             Authorization: `Bearer ${authToken}`,
@@ -25,7 +27,7 @@ const createZendeskTicket = async ({ params, authParams, }) => {
     });
     return {
         ticketId: response.data.ticket.id,
-        ticketUrl: `https://${subdomain}.zendesk.com/requests/${response.data.ticket.id}`,
+        ticketUrl: new URL(`/requests/${response.data.ticket.id}`, zendeskBaseUrl).toString(),
     };
 };
 export default createZendeskTicket;

package/dist/actions/providers/zendesk/getTicketDetails.js

@@ -1,15 +1,17 @@
 import { createAxiosClientWithRetries } from "../../util/axiosClient.js";
 import { MISSING_AUTH_TOKEN } from "../../util/missingAuthConstants.js";
+import { getZendeskBaseUrl } from "./utils/getZendeskBaseUrl.js";
 const getZendeskTicketDetails = async ({ params, authParams, }) => {
     const { authToken } = authParams;
     const { subdomain, ticketId } = params;
-    const url = `https://${subdomain}.zendesk.com/api/v2/tickets/${ticketId}.json`;
     if (!authToken) {
         throw new Error(MISSING_AUTH_TOKEN);
     }
+    const zendeskBaseUrl = getZendeskBaseUrl({ subdomain });
+    const apiEndpoint = new URL(`/api/v2/tickets/${ticketId}.json`, zendeskBaseUrl);
     const axiosClient = createAxiosClientWithRetries({ timeout: 10000, retryCount: 4 });
     const response = await axiosClient.request({
-        url: url,
+        url: apiEndpoint.toString(),
         method: "GET",
         headers: {
             "Content-Type": "application/json",

package/dist/actions/providers/zendesk/listTickets.js

@@ -1,5 +1,6 @@
 import { createAxiosClientWithRetries } from "../../util/axiosClient.js";
 import { MISSING_AUTH_TOKEN } from "../../util/missingAuthConstants.js";
+import { getZendeskBaseUrl } from "./utils/getZendeskBaseUrl.js";
 const listZendeskTickets = async ({ params, authParams, }) => {
     const { authToken } = authParams;
     const { subdomain, status } = params;
@@ -7,19 +8,18 @@ const listZendeskTickets = async ({ params, authParams, }) => {
     const threeMonthsAgo = new Date();
     threeMonthsAgo.setMonth(threeMonthsAgo.getMonth() - 3);
     const formattedDate = threeMonthsAgo.toISOString().split("T")[0];
-    // Endpoint for getting tickets
-    const url = `https://${subdomain}.zendesk.com/api/v2/tickets.json`;
     if (!authToken) {
         throw new Error(MISSING_AUTH_TOKEN);
     }
+    const zendeskBaseUrl = getZendeskBaseUrl({ subdomain });
+    const apiEndpoint = new URL("/api/v2/tickets.json", zendeskBaseUrl);
     const axiosClient = createAxiosClientWithRetries({ timeout: 10000, retryCount: 4 });
     // Add query parameters for filtering
-    const queryParams = new URLSearchParams();
-    queryParams.append("created_after", formattedDate);
+    apiEndpoint.searchParams.set("created_after", formattedDate);
     if (status) {
-        queryParams.append("status", status);
+        apiEndpoint.searchParams.set("status", status);
     }
-    const response = await axiosClient.get(`${url}?${queryParams.toString()}`, {
+    const response = await axiosClient.get(apiEndpoint.toString(), {
         headers: {
             "Content-Type": "application/json",
             Authorization: `Bearer ${authToken}`,

package/dist/actions/providers/zendesk/searchZendeskByQuery.js

@@ -1,19 +1,19 @@
 import { createAxiosClientWithRetries } from "../../util/axiosClient.js";
 import { MISSING_AUTH_TOKEN } from "../../util/missingAuthConstants.js";
+import { getZendeskBaseUrl } from "./utils/getZendeskBaseUrl.js";
 const searchZendeskByQuery = async ({ params, authParams, }) => {
     const { authToken } = authParams;
     const { subdomain, query, objectType = "ticket", limit = 100 } = params;
-    // Endpoint for searching Zendesk objects
-    const url = `https://${subdomain}.zendesk.com/api/v2/search.json`;
     if (!authToken) {
         throw new Error(MISSING_AUTH_TOKEN);
     }
+    const zendeskBaseUrl = getZendeskBaseUrl({ subdomain });
+    const apiEndpoint = new URL("/api/v2/search.json", zendeskBaseUrl);
     const axiosClient = createAxiosClientWithRetries({ timeout: 10000, retryCount: 4 });
     // Build search query parameters
-    const queryParams = new URLSearchParams();
-    queryParams.append("query", `type:${objectType} ${query}`);
-    queryParams.append("per_page", limit.toString());
-    const response = await axiosClient.get(`${url}?${queryParams.toString()}`, {
+    apiEndpoint.searchParams.set("query", `type:${objectType} ${query}`);
+    apiEndpoint.searchParams.set("per_page", limit.toString());
+    const response = await axiosClient.get(apiEndpoint.toString(), {
         headers: {
             "Content-Type": "application/json",
             Authorization: `Bearer ${authToken}`,

package/dist/actions/providers/zendesk/searchZendeskTicketsByQuery.js

@@ -1,16 +1,14 @@
 import { createAxiosClientWithRetries } from "../../util/axiosClient.js";
 import { MISSING_AUTH_TOKEN } from "../../util/missingAuthConstants.js";
-const ZENDESK_SUBDOMAIN_PATTERN = /^[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?$/i;
+import { getZendeskBaseUrl } from "./utils/getZendeskBaseUrl.js";
 const searchZendeskTicketsByQuery = async ({ params, authParams, }) => {
     const { authToken } = authParams;
     const { subdomain, query, limit = 100 } = params;
     if (!authToken) {
         throw new Error(MISSING_AUTH_TOKEN);
     }
-    if (!ZENDESK_SUBDOMAIN_PATTERN.test(subdomain)) {
-        throw new Error("Invalid Zendesk subdomain");
-    }
-    const url = new URL(`https://${subdomain}.zendesk.com/api/v2/search.json`);
+    const zendeskBaseUrl = getZendeskBaseUrl({ subdomain });
+    const apiEndpoint = new URL("/api/v2/search.json", zendeskBaseUrl);
     const axiosClient = createAxiosClientWithRetries({ timeout: 10000, retryCount: 4 });
     // Strip any type: filters from the incoming query so it can't target other resource types,
     // then force the search to tickets only
@@ -18,9 +16,9 @@ const searchZendeskTicketsByQuery = async ({ params, authParams, }) => {
         .replace(/\btype:\S+/gi, "")
         .replace(/\s+/g, " ")
         .trim();
-    url.searchParams.set("query", `type:ticket ${sanitizedQuery}`.trim());
-    url.searchParams.set("per_page", limit.toString());
-    const response = await axiosClient.get(url.toString(), {
+    apiEndpoint.searchParams.set("query", `type:ticket ${sanitizedQuery}`.trim());
+    apiEndpoint.searchParams.set("per_page", limit.toString());
+    const response = await axiosClient.get(apiEndpoint.toString(), {
         headers: {
             "Content-Type": "application/json",
             Authorization: `Bearer ${authToken}`,

package/dist/actions/providers/zendesk/updateTicketStatus.js

@@ -1,15 +1,17 @@
 import { createAxiosClientWithRetries } from "../../util/axiosClient.js";
 import { MISSING_AUTH_TOKEN } from "../../util/missingAuthConstants.js";
+import { getZendeskBaseUrl } from "./utils/getZendeskBaseUrl.js";
 const updateTicketStatus = async ({ params, authParams, }) => {
     const { authToken } = authParams;
     const { subdomain, ticketId, status } = params;
-    const url = `https://${subdomain}.zendesk.com/api/v2/tickets/${ticketId}.json`;
     if (!authToken) {
         throw new Error(MISSING_AUTH_TOKEN);
     }
+    const zendeskBaseUrl = getZendeskBaseUrl({ subdomain });
+    const apiEndpoint = new URL(`/api/v2/tickets/${ticketId}.json`, zendeskBaseUrl);
     const axiosClient = createAxiosClientWithRetries({ timeout: 10000, retryCount: 4 });
     await axiosClient.request({
-        url: url,
+        url: apiEndpoint.toString(),
         method: "PUT",
         headers: {
             "Content-Type": "application/json",

package/dist/actions/providers/zendesk/utils/getZendeskBaseUrl.d.ts

@@ -0,0 +1,3 @@
+export declare const getZendeskBaseUrl: ({ subdomain }: {
+    subdomain: string;
+}) => URL;

package/dist/actions/providers/zendesk/utils/getZendeskBaseUrl.js

@@ -0,0 +1,7 @@
+const ZENDESK_SUBDOMAIN_PATTERN = /^[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?$/i;
+export const getZendeskBaseUrl = ({ subdomain }) => {
+    if (!ZENDESK_SUBDOMAIN_PATTERN.test(subdomain)) {
+        throw new Error("Invalid Zendesk subdomain");
+    }
+    return new URL(`https://${subdomain}.zendesk.com/`);
+};

package/dist/actions/providers/zendesk/utils/validateSubdomain.d.ts

@@ -0,0 +1 @@
+export declare const validateZendeskSubdomain: (subdomain: string) => void;

package/dist/actions/providers/zendesk/utils/validateSubdomain.js

@@ -0,0 +1,6 @@
+const ZENDESK_SUBDOMAIN_PATTERN = /^[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?$/i;
+export const validateZendeskSubdomain = (subdomain) => {
+    if (!ZENDESK_SUBDOMAIN_PATTERN.test(subdomain)) {
+        throw new Error("Invalid Zendesk subdomain");
+    }
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@credal/actions",
-  "version": "0.2.228",
+  "version": "0.2.229",
   "type": "module",
   "description": "AI Actions by Credal AI",
   "sideEffects": false,