@pipedream/zendesk 0.3.5 → 0.5.0

package/README.md

@@ -1,8 +1,11 @@
 # Overview
 
-Using the Zendesk API, you can build custom apps and integrations to automate processes and help your teams build better customer relationships.
+Using the Zendesk API, you can build custom apps and integrations to automate
+processes and help your teams build better customer relationships.
 
-The API provides a range of methods to interact with your customer help desk, customer data, and customer communication tools. This enables you to create custom customer experiences that are tailored to your business needs.
+The API provides a range of methods to interact with your customer help desk,
+customer data, and customer communication tools. This enables you to create
+custom customer experiences that are tailored to your business needs.
 
 Some examples of what you can build using the Zendesk API include:
 

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

@@ -0,0 +1,78 @@
+import app from "../../zendesk.app.mjs";
+
+export default {
+  key: "zendesk-create-ticket",
+  name: "Create Ticket",
+  description: "Creates a ticket. [See the docs](https://developer.zendesk.com/api-reference/ticketing/tickets/tickets/#create-ticket).",
+  type: "action",
+  version: "0.1.0",
+  props: {
+    app,
+    ticketCommentBody: {
+      propDefinition: [
+        app,
+        "ticketCommentBody",
+      ],
+    },
+    ticketPriority: {
+      propDefinition: [
+        app,
+        "ticketPriority",
+      ],
+    },
+    ticketSubject: {
+      propDefinition: [
+        app,
+        "ticketSubject",
+      ],
+    },
+    ticketStatus: {
+      propDefinition: [
+        app,
+        "ticketStatus",
+      ],
+    },
+    customSubdomain: {
+      propDefinition: [
+        app,
+        "customSubdomain",
+      ],
+    },
+  },
+  methods: {
+    createTicket(args = {}) {
+      return this.app.create({
+        path: "/tickets",
+        ...args,
+      });
+    },
+  },
+  async run({ $: step }) {
+    const {
+      ticketCommentBody,
+      ticketPriority,
+      ticketSubject,
+      ticketStatus,
+      customSubdomain,
+    } = this;
+
+    const response = await this.createTicket({
+      step,
+      customSubdomain,
+      data: {
+        ticket: {
+          comment: {
+            body: ticketCommentBody,
+          },
+          priority: ticketPriority,
+          subject: ticketSubject,
+          status: ticketStatus,
+        },
+      },
+    });
+
+    step.export("$summary", `Successfully created ticket with ID ${response.ticket.id}`);
+
+    return response;
+  },
+};

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

@@ -0,0 +1,50 @@
+import app from "../../zendesk.app.mjs";
+
+export default {
+  key: "zendesk-delete-ticket",
+  name: "Delete Ticket",
+  description: "Deletes a ticket. [See the docs](https://developer.zendesk.com/api-reference/ticketing/tickets/tickets/#delete-ticket).",
+  type: "action",
+  version: "0.1.0",
+  props: {
+    app,
+    ticketId: {
+      propDefinition: [
+        app,
+        "ticketId",
+      ],
+    },
+    customSubdomain: {
+      propDefinition: [
+        app,
+        "customSubdomain",
+      ],
+    },
+  },
+  methods: {
+    deleteTicket({
+      ticketId, ...args
+    } = {}) {
+      return this.app.delete({
+        path: `/tickets/${ticketId}`,
+        ...args,
+      });
+    },
+  },
+  async run({ $: step }) {
+    const {
+      ticketId,
+      customSubdomain,
+    } = this;
+
+    await this.deleteTicket({
+      step,
+      ticketId,
+      customSubdomain,
+    });
+
+    step.export("$summary", "Successfully deleted ticket");
+
+    return true;
+  },
+};

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

@@ -0,0 +1,88 @@
+import app from "../../zendesk.app.mjs";
+
+export default {
+  key: "zendesk-update-ticket",
+  name: "Update Ticket",
+  description: "Updates a ticket. [See the docs](https://developer.zendesk.com/api-reference/ticketing/tickets/tickets/#update-ticket).",
+  type: "action",
+  version: "0.1.0",
+  props: {
+    app,
+    ticketId: {
+      propDefinition: [
+        app,
+        "ticketId",
+      ],
+    },
+    ticketCommentBody: {
+      propDefinition: [
+        app,
+        "ticketCommentBody",
+      ],
+    },
+    ticketPriority: {
+      propDefinition: [
+        app,
+        "ticketPriority",
+      ],
+    },
+    ticketSubject: {
+      propDefinition: [
+        app,
+        "ticketSubject",
+      ],
+    },
+    ticketStatus: {
+      propDefinition: [
+        app,
+        "ticketStatus",
+      ],
+    },
+    customSubdomain: {
+      propDefinition: [
+        app,
+        "customSubdomain",
+      ],
+    },
+  },
+  methods: {
+    updateTicket({
+      ticketId, ...args
+    } = {}) {
+      return this.app.update({
+        path: `/tickets/${ticketId}`,
+        ...args,
+      });
+    },
+  },
+  async run({ $: step }) {
+    const {
+      ticketId,
+      ticketCommentBody,
+      ticketPriority,
+      ticketSubject,
+      ticketStatus,
+      customSubdomain,
+    } = this;
+
+    const response = await this.updateTicket({
+      step,
+      ticketId,
+      customSubdomain,
+      data: {
+        ticket: {
+          comment: {
+            body: ticketCommentBody,
+          },
+          priority: ticketPriority,
+          subject: ticketSubject,
+          status: ticketStatus,
+        },
+      },
+    });
+
+    step.export("$summary", `Successfully updated ticket with ID ${response.ticket.id}`);
+
+    return response;
+  },
+};

package/common/constants.mjs

@@ -6,11 +6,30 @@ const TRIGGER_ID = "triggerId";
 const PAGE_SIZE_PARAM = "page[size]";
 const PAGE_AFTER_PARAM = "page[after]";
 const SORT_BY_POSITION_ASC = "position";
+const SORT_BY_UPDATED_AT_DESC = "-updated_at";
 const X_ZENDESK_WEBHOOK_SIGNATURE_HEADER = "x-zendesk-webhook-signature";
 const X_ZENDESK_WEBHOOK_SIGNATURE_TIMESTAMP_HEADER = "x-zendesk-webhook-signature-timestamp";
 const SIGNING_SECRET = "signingSecret";
 const SIGNING_SECRET_ALGORITHM = "sha256";
 const BASE_64 = "base64";
+const DEFAULT_LIMIT = 20;
+const DEFAULT_TIMEOUT = 10000;
+
+const TICKET_PRIORITY_OPTIONS = {
+  URGENT: "urgent",
+  HIGH: "high",
+  NORMAL: "normal",
+  LOW: "low",
+};
+
+const TICKET_STATUS_OPTIONS = {
+  NEW: "new",
+  OPEN: "open",
+  PENDING: "pending",
+  HOLD: "hold",
+  SOLVED: "solved",
+  CLOSED: "closed",
+};
 
 export default {
   SUBDOMAIN_PLACEHOLDER,
@@ -21,9 +40,14 @@ export default {
   PAGE_SIZE_PARAM,
   PAGE_AFTER_PARAM,
   SORT_BY_POSITION_ASC,
+  SORT_BY_UPDATED_AT_DESC,
   X_ZENDESK_WEBHOOK_SIGNATURE_HEADER,
   X_ZENDESK_WEBHOOK_SIGNATURE_TIMESTAMP_HEADER,
   SIGNING_SECRET,
   SIGNING_SECRET_ALGORITHM,
   BASE_64,
+  DEFAULT_LIMIT,
+  DEFAULT_TIMEOUT,
+  TICKET_PRIORITY_OPTIONS,
+  TICKET_STATUS_OPTIONS,
 };

package/package.json

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

package/sources/common/ticket.mjs

@@ -1,4 +1,4 @@
-import common from "./base.mjs";
+import common from "./webhook.mjs";
 
 export default {
   ...common,

package/sources/common/{base.mjs → webhook.mjs}

@@ -1,38 +1,50 @@
 import crypto from "crypto";
-import zendesk from "../../zendesk.app.mjs";
+import app from "../../zendesk.app.mjs";
 import constants from "../../common/constants.mjs";
 
 export default {
   props: {
-    zendesk,
+    app,
     db: "$.service.db",
     http: "$.interface.http",
     categoryId: {
       propDefinition: [
-        zendesk,
+        app,
         "categoryId",
       ],
     },
+    customSubdomain: {
+      propDefinition: [
+        app,
+        "customSubdomain",
+      ],
+    },
   },
   hooks: {
     async activate() {
-      const { categoryId } = this;
+      const {
+        categoryId,
+        customSubdomain,
+      } = this;
 
-      const { webhook } = await this.zendesk.createWebhook({
+      const { webhook } = await this.createWebhook({
+        customSubdomain,
         data: this.setupWebhookData(),
       });
 
       const { id: webhookId } = webhook;
       this.setWebhookId(webhookId);
 
-      const { signing_secret: signingSecret } = await this.zendesk.showWebhookSigningSecret({
+      const { signing_secret: signingSecret } = await this.showWebhookSigningSecret({
+        customSubdomain,
         webhookId,
       });
 
       const { secret } = signingSecret;
       this.setSigningSecret(secret);
 
-      const { trigger } = await this.zendesk.createTrigger({
+      const { trigger } = await this.createTrigger({
+        customSubdomain,
         data: this.setupTriggerData({
           webhookId,
           categoryId,
@@ -43,17 +55,56 @@ export default {
       this.setTriggerId(String(triggerId));
     },
     async deactivate() {
+      const { customSubdomain } = this;
       await Promise.all([
-        this.zendesk.deleteTrigger({
+        this.deleteTrigger({
+          customSubdomain,
           triggerId: this.getTriggerId(),
         }),
-        this.zendesk.deleteWebhook({
+        this.deleteWebhook({
+          customSubdomain,
           webhookId: this.getWebhookId(),
         }),
       ]);
     },
   },
   methods: {
+    createWebhook(args = {}) {
+      return this.app.create({
+        path: "/webhooks",
+        ...args,
+      });
+    },
+    deleteWebhook({
+      webhookId, ...args
+    } = {}) {
+      return this.app.delete({
+        path: `/webhooks/${webhookId}`,
+        ...args,
+      });
+    },
+    createTrigger(args = {}) {
+      return this.app.create({
+        path: "/triggers",
+        ...args,
+      });
+    },
+    deleteTrigger({
+      triggerId, ...args
+    } = {}) {
+      return this.app.delete({
+        path: `/triggers/${triggerId}`,
+        ...args,
+      });
+    },
+    showWebhookSigningSecret({
+      webhookId, ...args
+    } = {}) {
+      return this.app.makeRequest({
+        path: `/webhooks/${webhookId}/signing_secret`,
+        ...args,
+      });
+    },
     setWebhookId(webhookId) {
       this.db.set(constants.WEBHOOK_ID, webhookId);
     },

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.0.2",
+  version: "0.2.0",
   dedupe: "unique",
   methods: {
     ...common.methods,

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.0.2",
+  version: "0.2.0",
   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.0.2",
+  version: "0.2.0",
   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.0.2",
+  version: "0.2.0",
   dedupe: "unique",
   methods: {
     ...common.methods,

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

@@ -0,0 +1,30 @@
+import common from "../common/ticket.mjs";
+
+export default {
+  ...common,
+  name: "Ticket Updated (Instant)",
+  key: "zendesk-ticket-updated",
+  type: "source",
+  description: "Emit new event when a ticket has been updated",
+  version: "0.2.0",
+  dedupe: "unique",
+  methods: {
+    ...common.methods,
+    getWebhookName() {
+      return "Ticket Updated Webhook";
+    },
+    getTriggerTitle() {
+      return "Ticket Updated Trigger";
+    },
+    getTriggerConditions() {
+      return {
+        all: [
+          {
+            field: "update_type",
+            value: "Change",
+          },
+        ],
+      };
+    },
+  },
+};

package/zendesk.app.mjs

@@ -18,7 +18,7 @@ export default {
         } =
           await this.listTriggerCategories({
             params: {
-              [constants.PAGE_SIZE_PARAM]: 20,
+              [constants.PAGE_SIZE_PARAM]: constants.DEFAULT_LIMIT,
               sort: constants.SORT_BY_POSITION_ASC,
               [constants.PAGE_AFTER_PARAM]: afterCursor,
             },
@@ -37,102 +37,128 @@ export default {
         };
       },
     },
+    ticketId: {
+      type: "string",
+      label: "Ticket ID",
+      description: "The ID of the ticket.",
+      async options({ prevContext }) {
+        const { afterCursor } = prevContext;
+
+        const {
+          tickets,
+          meta,
+        } =
+          await this.listTickets({
+            params: {
+              [constants.PAGE_SIZE_PARAM]: constants.DEFAULT_LIMIT,
+              sort: constants.SORT_BY_UPDATED_AT_DESC,
+              [constants.PAGE_AFTER_PARAM]: afterCursor,
+            },
+          });
+
+        return {
+          context: {
+            afterCursor: meta.after_cursor,
+          },
+          options: tickets.map(({
+            id, subject,
+          }) => ({
+            label: subject || `Ticket #${id}`,
+            value: id,
+          })),
+        };
+      },
+    },
+    ticketCommentBody: {
+      type: "string",
+      label: "Comment body",
+      description: "The body of the comment.",
+    },
+    ticketPriority: {
+      type: "string",
+      label: "Ticket Priority",
+      description: "The priority of the ticket.",
+      optional: true,
+      options: Object.values(constants.TICKET_PRIORITY_OPTIONS),
+    },
+    ticketSubject: {
+      type: "string",
+      label: "Ticket Subject",
+      description: "The subject of the ticket.",
+      optional: true,
+    },
+    ticketStatus: {
+      type: "string",
+      label: "Ticket Status",
+      description: "The status of the ticket.",
+      optional: true,
+      options: Object.values(constants.TICKET_STATUS_OPTIONS),
+    },
+    customSubdomain: {
+      type: "string",
+      label: "Custom Subdomain",
+      description: "For Enterprise Zendesk accounts: optionally specify the subdomain to use. This will override the subdomain that was provided when connecting your Zendesk account to Pipedream. For example, if you Zendesk URL is https://examplehelp.zendesk.com, your subdomain is `examplehelp`",
+      optional: true,
+    },
   },
   methods: {
-    getApiUrl({
-      path, subdomain,
-    }) {
+    getUrl(path, customSubdomain) {
       const {
         SUBDOMAIN_PLACEHOLDER,
         BASE_URL,
         VERSION_PATH,
       } = constants;
-      return `${BASE_URL.replace(SUBDOMAIN_PLACEHOLDER, subdomain)}${VERSION_PATH}${path}`;
+      const baseUrl = BASE_URL.replace(
+        SUBDOMAIN_PLACEHOLDER,
+        customSubdomain?.trim() || this.$auth.subdomain,
+      );
+      return `${baseUrl}${VERSION_PATH}${path}`;
     },
-    async makeRequest(customConfig) {
-      const {
-        $,
-        url,
-        path,
-        ...configProps
-      } = customConfig;
-
-      const {
-        oauth_access_token: oauthAccessToken,
-        subdomain,
-      } = this.$auth;
-
-      const headers = {
-        ...configProps?.headers,
-        authorization: `Bearer ${oauthAccessToken}`,
+    getHeaders(headers) {
+      return {
+        authorization: `Bearer ${this.$auth.oauth_access_token}`,
+        ...headers,
       };
-
+    },
+    makeRequest({
+      step = this, url, path, headers, customSubdomain, ...args
+    }) {
       const config = {
-        ...configProps,
-        headers,
-        url: url ?? this.getApiUrl({
-          subdomain,
-          path,
-        }),
-        timeout: 10000,
+        headers: this.getHeaders(headers),
+        url: url ?? this.getUrl(path, customSubdomain),
+        timeout: constants.DEFAULT_TIMEOUT,
+        ...args,
       };
-
-      return axios($ ?? this, config);
+      return axios(step, config);
     },
-    async createTrigger({
-      $, data,
-    }) {
+    create(args = {}) {
       return this.makeRequest({
-        $,
         method: "post",
-        path: "/triggers",
-        data,
+        ...args,
       });
     },
-    async deleteTrigger({
-      $, triggerId,
-    }) {
+    update(args = {}) {
       return this.makeRequest({
-        $,
-        method: "delete",
-        path: `/triggers/${triggerId}`,
-      });
-    },
-    async listTriggerCategories({
-      $, url, params,
-    }) {
-      return this.makeRequest({
-        $,
-        url,
-        path: "/trigger_categories",
-        params,
+        method: "put",
+        ...args,
       });
     },
-    async createWebhook({
-      $, data,
-    }) {
+    delete(args = {}) {
       return this.makeRequest({
-        $,
-        method: "post",
-        path: "/webhooks",
-        data,
+        method: "delete",
+        ...args,
       });
     },
-    async deleteWebhook({
-      $, webhookId,
-    }) {
+    listTriggerCategories(args = {}) {
       return this.makeRequest({
-        $,
-        method: "delete",
-        path: `/webhooks/${webhookId}`,
+        path: "/trigger_categories",
+        ...args,
       });
     },
-    async showWebhookSigningSecret({
-      $, webhookId,
-    }) {
+    listTickets(args = {}) {
       return this.makeRequest({
-        $,
-        path: `/webhooks/${webhookId}/signing_secret`,
+        path: "/tickets",
+        ...args,
       });
     },
   },