@pipedream/zendesk 0.7.2 → 0.8.1

package/actions/add-ticket-tags/add-ticket-tags.mjs

@@ -5,7 +5,7 @@ export default {
   name: "Add Ticket Tags",
   description: "Add tags to a ticket (appends to existing tags). [See the documentation](https://developer.zendesk.com/api-reference/ticketing/ticket-management/tags/#add-tags).",
   type: "action",
-  version: "0.0.1",
+  version: "0.0.2",
   props: {
     app,
     ticketId: {

package/actions/create-ticket/create-ticket.mjs

@@ -5,7 +5,7 @@ export default {
   name: "Create Ticket",
   description: "Creates a ticket. [See the documentation](https://developer.zendesk.com/api-reference/ticketing/tickets/tickets/#create-ticket).",
   type: "action",
-  version: "0.1.5",
+  version: "0.1.6",
   props: {
     app,
     ticketCommentBody: {

package/actions/delete-ticket/delete-ticket.mjs

@@ -5,7 +5,7 @@ export default {
   name: "Delete Ticket",
   description: "Deletes a ticket. [See the documentation](https://developer.zendesk.com/api-reference/ticketing/tickets/tickets/#delete-ticket).",
   type: "action",
-  version: "0.1.5",
+  version: "0.1.6",
   props: {
     app,
     ticketId: {

package/actions/get-ticket-info/get-ticket-info.mjs

@@ -5,7 +5,7 @@ export default {
   name: "Get Ticket Info",
   description: "Retrieves information about a specific ticket. [See the documentation](https://developer.zendesk.com/api-reference/ticketing/tickets/tickets/#show-ticket).",
   type: "action",
-  version: "0.0.3",
+  version: "0.0.4",
   props: {
     app,
     ticketId: {

package/actions/get-user-info/get-user-info.mjs

@@ -0,0 +1,28 @@
+import zendesk from "../../zendesk.app.mjs";
+
+export default {
+  key: "zendesk-get-user-info",
+  name: "Get User Info",
+  description: "Retrieves information about a specific user. [See the documentation](https://developer.zendesk.com/api-reference/ticketing/users/users/#show-user).",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    zendesk,
+    userId: {
+      propDefinition: [
+        zendesk,
+        "userId",
+      ],
+    },
+  },
+  async run({ $: step }) {
+    const response = await this.zendesk.getUserInfo({
+      step,
+      userId: this.userId,
+    });
+
+    step.export("$summary", `Successfully retrieved user info for ${response.user.name}`);
+
+    return response;
+  },
+};

package/actions/list-locales/list-locales.mjs

@@ -0,0 +1,21 @@
+import zendesk from "../../zendesk.app.mjs";
+
+export default {
+  key: "zendesk-list-locales",
+  name: "List Locales",
+  description: "Retrieves all locales. [See the documentation](https://developer.zendesk.com/api-reference/ticketing/account-configuration/locales/).",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    zendesk,
+  },
+  async run({ $: step }) {
+    const { locales } = await this.zendesk.listLocales();
+
+    step.export("$summary", `Successfully retrieved ${locales.length} locale${locales.length === 1
+      ? ""
+      : "s"}`);
+
+    return locales;
+  },
+};

package/actions/list-macros/list-macros.mjs

@@ -0,0 +1,99 @@
+import zendesk from "../../zendesk.app.mjs";
+
+export default {
+  key: "zendesk-list-macros",
+  name: "List Macros",
+  description: "Retrieves all macros. [See the documentation](https://developer.zendesk.com/api-reference/ticketing/business-rules/macros/#list-macros).",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    zendesk,
+    access: {
+      type: "string",
+      label: "Access",
+      description: "The access level of the macros to return",
+      options: [
+        "personal",
+        "agents",
+        "shared",
+        "account",
+      ],
+      optional: true,
+    },
+    active: {
+      type: "boolean",
+      label: "Active",
+      description: "Filter by active macros if `true` or inactive macros if `false`",
+      optional: true,
+    },
+    macroCategory: {
+      propDefinition: [
+        zendesk,
+        "macroCategory",
+      ],
+    },
+    groupId: {
+      propDefinition: [
+        zendesk,
+        "groupId",
+      ],
+    },
+    sortBy: {
+      type: "string",
+      label: "Sort By",
+      description: "The field to sort the results by",
+      options: [
+        "alphabetical",
+        "created_at",
+        "updated_at",
+        "usage_1h",
+        "usage_24h",
+        "usage_7d",
+        "usage_30d",
+      ],
+      optional: true,
+    },
+    sortOrder: {
+      propDefinition: [
+        zendesk,
+        "sortOrder",
+      ],
+    },
+    limit: {
+      propDefinition: [
+        zendesk,
+        "limit",
+      ],
+      description: "Maximum number of macros to return",
+    },
+  },
+  async run({ $: step }) {
+    const results = this.zendesk.paginate({
+      fn: this.zendesk.listMacros,
+      args: {
+        step,
+        params: {
+          access: this.access,
+          active: this.active,
+          category: this.macroCategory,
+          group_id: this.groupId,
+          sort_by: this.sortBy,
+          sort_order: this.sortOrder,
+        },
+      },
+      resourceKey: "macros",
+      max: this.limit,
+    });
+
+    const macros = [];
+    for await (const macro of results) {
+      macros.push(macro);
+    }
+
+    step.export("$summary", `Successfully retrieved ${macros.length} macro${macros.length === 1
+      ? ""
+      : "s"}`);
+
+    return macros;
+  },
+};

package/actions/list-ticket-comments/list-ticket-comments.mjs

@@ -0,0 +1,56 @@
+import zendesk from "../../zendesk.app.mjs";
+
+export default {
+  key: "zendesk-list-ticket-comments",
+  name: "List Ticket Comments",
+  description: "Retrieves all comments for a specific ticket. [See the documentation](https://developer.zendesk.com/api-reference/ticketing/tickets/ticket_comments/#list-comments).",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    zendesk,
+    ticketId: {
+      propDefinition: [
+        zendesk,
+        "ticketId",
+      ],
+    },
+    sortOrder: {
+      propDefinition: [
+        zendesk,
+        "sortOrder",
+      ],
+    },
+    limit: {
+      propDefinition: [
+        zendesk,
+        "limit",
+      ],
+      description: "Maximum number of comments to return",
+    },
+  },
+  async run({ $: step }) {
+    const results = this.zendesk.paginate({
+      fn: this.zendesk.listTicketComments,
+      args: {
+        step,
+        ticketId: this.ticketId,
+        params: {
+          sort_order: this.sortOrder,
+        },
+      },
+      resourceKey: "comments",
+      max: this.limit,
+    });
+
+    const comments = [];
+    for await (const comment of results) {
+      comments.push(comment);
+    }
+
+    step.export("$summary", `Successfully retrieved ${comments.length} comment${comments.length === 1
+      ? ""
+      : "s"}`);
+
+    return comments;
+  },
+};

package/actions/list-tickets/list-tickets.mjs

@@ -5,7 +5,7 @@ export default {
   name: "List Tickets",
   description: "Retrieves a list of tickets. [See the documentation](https://developer.zendesk.com/api-reference/ticketing/tickets/tickets/#list-tickets).",
   type: "action",
-  version: "0.0.3",
+  version: "0.0.4",
   props: {
     app,
     sortBy: {

package/actions/remove-ticket-tags/remove-ticket-tags.mjs

@@ -5,7 +5,7 @@ export default {
   name: "Remove Ticket Tags",
   description: "Remove specific tags from a ticket. [See the documentation](https://developer.zendesk.com/api-reference/ticketing/ticket-management/tags/#remove-tags).",
   type: "action",
-  version: "0.0.1",
+  version: "0.0.2",
   props: {
     app,
     ticketId: {

package/actions/search-tickets/search-tickets.mjs

@@ -5,7 +5,7 @@ export default {
   name: "Search Tickets",
   description: "Searches for tickets using Zendesk's search API. [See the documentation](https://developer.zendesk.com/api-reference/ticketing/ticket-management/search/#search-tickets).",
   type: "action",
-  version: "0.0.3",
+  version: "0.0.5",
   props: {
     app,
     query: {
@@ -37,6 +37,13 @@ export default {
         "customSubdomain",
       ],
     },
+    page: {
+      type: "integer",
+      label: "Page",
+      description: "The page number to retrieve. Default is 1.",
+      default: 1,
+      optional: true,
+    },
   },
   async run({ $: step }) {
     const {
@@ -47,28 +54,20 @@ export default {
       customSubdomain,
     } = this;
 
-    const results = this.app.paginate({
-      fn: this.app.searchTickets,
-      args: {
-        step,
-        customSubdomain,
-        params: {
-          query,
-          sort_by: sortBy,
-          sort_order: sortOrder,
-        },
+    const results = await this.app.searchTickets({
+      step,
+      customSubdomain,
+      params: {
+        query,
+        sort_by: sortBy,
+        sort_order: sortOrder,
+        per_page: limit,
+        page: this.page,
       },
-      resourceKey: "results",
-      max: limit,
     });
 
-    const tickets = [];
-    for await (const ticket of results) {
-      tickets.push(ticket);
-    }
-
-    step.export("$summary", `Successfully found ${tickets.length} tickets matching the search query`);
+    step.export("$summary", "Successfully retrieved tickets matching the search query");
 
-    return tickets;
+    return results;
   },
 };

package/actions/set-ticket-tags/set-ticket-tags.mjs

@@ -5,7 +5,7 @@ export default {
   name: "Set Ticket Tags",
   description: "Set tags on a ticket (replaces all existing tags). [See the documentation](https://developer.zendesk.com/api-reference/ticketing/ticket-management/tags/#set-tags).",
   type: "action",
-  version: "0.0.1",
+  version: "0.0.2",
   props: {
     app,
     ticketId: {

package/actions/update-ticket/update-ticket.mjs

@@ -5,7 +5,7 @@ export default {
   name: "Update Ticket",
   description: "Updates a ticket and optionally manages tags. [See the documentation](https://developer.zendesk.com/api-reference/ticketing/tickets/tickets/#update-ticket).",
   type: "action",
-  version: "0.1.5",
+  version: "0.1.6",
   props: {
     app,
     ticketId: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pipedream/zendesk",
-  "version": "0.7.2",
+  "version": "0.8.1",
   "description": "Pipedream Zendesk Components",
   "main": "zendesk.app.mjs",
   "keywords": [

package/sources/common/polling.mjs

@@ -0,0 +1,23 @@
+import zendesk from "../../zendesk.app.mjs";
+import { DEFAULT_POLLING_SOURCE_TIMER_INTERVAL } from "@pipedream/platform";
+
+export default {
+  props: {
+    zendesk,
+    db: "$.service.db",
+    timer: {
+      type: "$.interface.timer",
+      default: {
+        intervalSeconds: DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
+      },
+    },
+  },
+  methods: {
+    _getLastTs() {
+      return this.db.get("lastTs") || 0;
+    },
+    _setLastTs(ts) {
+      this.db.set("lastTs", ts);
+    },
+  },
+};

package/sources/common/webhook.mjs

@@ -212,6 +212,15 @@ export default {
     isRelevant() {
       return true;
     },
+    emitEvent(payload) {
+      const ts = Date.parse(payload.updatedAt);
+      const id = `${payload.ticketId}-${ts}`;
+      this.$emit(payload, {
+        id,
+        summary: payload.title || payload.ticketId,
+        ts,
+      });
+    },
   },
   async run(event) {
     const {
@@ -241,13 +250,6 @@ export default {
       return;
     }
 
-    const ts = Date.parse(payload.updatedAt);
-    const id = `${payload.ticketId}-${ts}`;
-
-    this.$emit(payload, {
-      id,
-      summary: payload.title || payload.ticketId,
-      ts,
-    });
+    this.emitEvent(payload);
   },
 };

package/sources/locale-updated/locale-updated.mjs

@@ -0,0 +1,29 @@
+import common from "../common/polling.mjs";
+
+export default {
+  ...common,
+  key: "zendesk-locale-updated",
+  name: "Locale Updated",
+  type: "source",
+  description: "Emit new event when a locale has been updated",
+  version: "0.0.1",
+  dedupe: "unique",
+  async run() {
+    const lastTs = this._getLastTs();
+    let maxTs = lastTs;
+
+    const { locales } = await this.zendesk.listLocales();
+    for (const locale of locales) {
+      const ts = Date.parse(locale.updated_at);
+      if (ts > lastTs) {
+        this.$emit(locale, {
+          id: `${locale.id}-${ts}`,
+          summary: locale.name,
+          ts,
+        });
+        maxTs = Math.max(maxTs, ts);
+      }
+    }
+    this._setLastTs(maxTs);
+  },
+};

package/sources/new-ticket/new-ticket.mjs

@@ -6,7 +6,7 @@ export default {
   key: "zendesk-new-ticket",
   type: "source",
   description: "Emit new event when a ticket is created",
-  version: "0.2.5",
+  version: "0.2.6",
   dedupe: "unique",
   methods: {
     ...common.methods,

package/sources/new-ticket-comment-added/new-ticket-comment-added.mjs

@@ -0,0 +1,111 @@
+import app from "../../zendesk.app.mjs";
+import common from "../common/ticket.mjs";
+
+export default {
+  ...common,
+  name: "New Ticket Comment Added (Instant)",
+  key: "zendesk-new-ticket-comment-added",
+  type: "source",
+  description: "Emit new event when a ticket comment has been added",
+  version: "0.0.1",
+  dedupe: "unique",
+  props: {
+    app,
+    db: "$.service.db",
+    http: "$.interface.http",
+    categoryId: {
+      propDefinition: [
+        app,
+        "categoryId",
+      ],
+    },
+    customSubdomain: {
+      propDefinition: [
+        app,
+        "customSubdomain",
+      ],
+    },
+  },
+  methods: {
+    ...common.methods,
+    _getLastTs() {
+      return this.db.get("lastTs");
+    },
+    _setLastTs(ts) {
+      this.db.set("lastTs", ts);
+    },
+    getWebhookName() {
+      return "Ticket Comment Added Webhook";
+    },
+    getTriggerTitle() {
+      return "Ticket Comment Added Trigger";
+    },
+    getTriggerConditions() {
+      return {
+        all: [
+          {
+            field: "update_type",
+            value: "Change",
+          },
+        ],
+      };
+    },
+    getTriggerPayload() {
+      const payload = common.methods.getTriggerPayload.call(this);
+      return {
+        ...payload,
+        ticketComments: "{{ticket.comments}}",
+      };
+    },
+    convertCommentsToJson(raw) {
+      return [
+        ...raw.matchAll(/#<Comment (.*?)>/g),
+      ].map((match) => {
+        const fields = match[1]
+          .split(",")
+          .map((part) => part.trim())
+          .map((pair) => {
+            const [
+              key,
+              value,
+            ] = pair.split(/:\s+/);
+            // Clean up values: remove extra quotes or cast to appropriate types
+            let cleaned = value;
+            if (cleaned === "nil") cleaned = null;
+            else if (cleaned === "true") cleaned = true;
+            else if (cleaned === "false") cleaned = false;
+            else if (/^\d+$/.test(cleaned)) cleaned = parseInt(cleaned, 10);
+            else if (/^".*"$/.test(cleaned)) cleaned = cleaned.slice(1, -1);
+            return [
+              key,
+              cleaned,
+            ];
+          });
+        return Object.fromEntries(fields);
+      });
+    },
+    isRelevant(payload) {
+      const lastTs = this._getLastTs() || 0;
+      let maxTs = lastTs;
+      const comments = this.convertCommentsToJson(payload.ticketComments);
+      for (const comment of comments) {
+        const ts = Date.parse(comment.created_at);
+        maxTs = Math.max(maxTs, ts);
+      }
+      this._setLastTs(maxTs);
+      return comments.length > 0 && maxTs > lastTs;
+    },
+    emitEvent(payload) {
+      payload.ticketComments = this.convertCommentsToJson(payload.ticketComments);
+      for (const comment of payload.ticketComments) {
+        const ts = Date.parse(comment.created_at);
+        const id = `${payload.ticketId}-${ts}`;
+        this.$emit(comment, {
+          id,
+          summary: comment.value,
+          ts,
+        });
+      }
+    },
+  },
+};

package/sources/ticket-added-to-view/ticket-added-to-view.mjs

@@ -5,7 +5,7 @@ export default {
   key: "zendesk-ticket-added-to-view",
   name: "New Ticket Added to View (Instant)",
   description: "Emit new event when a ticket is added to the specified view",
-  version: "0.0.5",
+  version: "0.0.6",
   type: "source",
   dedupe: "unique",
   props: {

package/sources/ticket-closed/ticket-closed.mjs

@@ -6,7 +6,7 @@ export default {
   key: "zendesk-ticket-closed",
   type: "source",
   description: "Emit new event when a ticket has changed to closed status",
-  version: "0.2.5",
+  version: "0.2.6",
   dedupe: "unique",
   methods: {
     ...common.methods,

package/sources/ticket-pended/ticket-pended.mjs

@@ -6,7 +6,7 @@ export default {
   key: "zendesk-ticket-pended",
   type: "source",
   description: "Emit new event when a ticket has changed to pending status",
-  version: "0.2.5",
+  version: "0.2.6",
   dedupe: "unique",
   methods: {
     ...common.methods,

package/sources/ticket-solved/ticket-solved.mjs

@@ -6,7 +6,7 @@ export default {
   key: "zendesk-ticket-solved",
   type: "source",
   description: "Emit new event when a ticket has changed to solved status",
-  version: "0.2.5",
+  version: "0.2.6",
   dedupe: "unique",
   methods: {
     ...common.methods,

package/sources/ticket-updated/ticket-updated.mjs

@@ -6,7 +6,7 @@ export default {
   key: "zendesk-ticket-updated",
   type: "source",
   description: "Emit new event when a ticket has been updated",
-  version: "0.2.5",
+  version: "0.2.6",
   dedupe: "unique",
   methods: {
     ...common.methods,

package/zendesk.app.mjs

@@ -101,6 +101,77 @@ export default {
         };
       },
     },
+    userId: {
+      type: "string",
+      label: "User ID",
+      description: "The ID of the user",
+      async options({ prevContext }) {
+        const { afterCursor } = prevContext;
+
+        const {
+          users,
+          meta,
+        } = await this.listUsers({
+          params: {
+            [constants.PAGE_SIZE_PARAM]: constants.DEFAULT_LIMIT,
+            [constants.PAGE_AFTER_PARAM]: afterCursor,
+          },
+        });
+
+        return {
+          context: {
+            afterCursor: meta.after_cursor,
+          },
+          options: users.map(({
+            id, name,
+          }) => ({
+            label: name,
+            value: id,
+          })),
+        };
+      },
+    },
+    groupId: {
+      type: "string",
+      label: "Group ID",
+      description: "The ID of the group",
+      optional: true,
+      async options({ prevContext }) {
+        const { afterCursor } = prevContext;
+
+        const {
+          groups,
+          meta,
+        } = await this.listGroups({
+          params: {
+            [constants.PAGE_SIZE_PARAM]: constants.DEFAULT_LIMIT,
+            [constants.PAGE_AFTER_PARAM]: afterCursor,
+          },
+        });
+
+        return {
+          context: {
+            afterCursor: meta.after_cursor,
+          },
+          options: groups.map(({
+            id, name,
+          }) => ({
+            label: name,
+            value: id,
+          })),
+        };
+      },
+    },
+    macroCategory: {
+      type: "string",
+      label: "Macro Category",
+      description: "The category of the macro",
+      optional: true,
+      async options() {
+        const { categories } = await this.listMacroCategories();
+        return categories.map((category) => category);
+      },
+    },
     fields: {
       type: "string[]",
       label: "Fields",
@@ -234,6 +305,14 @@ export default {
         ...args,
       });
     },
+    getUserInfo({
+      userId, ...args
+    }) {
+      return this.makeRequest({
+        path: `/users/${userId}`,
+        ...args,
+      });
+    },
     searchTickets(args = {}) {
       return this.makeRequest({
         path: "/search",
@@ -290,6 +369,44 @@ export default {
         ...args,
       });
     },
+    listTicketComments({
+      ticketId, ...args
+    } = {}) {
+      return this.makeRequest({
+        path: `/tickets/${ticketId}/comments`,
+        ...args,
+      });
+    },
+    listUsers(args = {}) {
+      return this.makeRequest({
+        path: "/users",
+        ...args,
+      });
+    },
+    listLocales(args = {}) {
+      return this.makeRequest({
+        path: "/locales",
+        ...args,
+      });
+    },
+    listMacros(args = {}) {
+      return this.makeRequest({
+        path: "/macros",
+        ...args,
+      });
+    },
+    listMacroCategories(args = {}) {
+      return this.makeRequest({
+        path: "/macros/categories",
+        ...args,
+      });
+    },
+    listGroups(args = {}) {
+      return this.makeRequest({
+        path: "/groups",
+        ...args,
+      });
+    },
     async *paginate({
       fn, args, resourceKey, max,
     }) {