@pipedream/zendesk 0.4.0 → 0.6.0

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

@@ -5,7 +5,7 @@ export default {
   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.0.1",
+  version: "0.1.1",
   props: {
     app,
     ticketCommentBody: {
@@ -32,6 +32,12 @@ export default {
         "ticketStatus",
       ],
     },
+    customSubdomain: {
+      propDefinition: [
+        app,
+        "customSubdomain",
+      ],
+    },
   },
   methods: {
     createTicket(args = {}) {
@@ -47,10 +53,12 @@ export default {
       ticketPriority,
       ticketSubject,
       ticketStatus,
+      customSubdomain,
     } = this;
 
     const response = await this.createTicket({
       step,
+      customSubdomain,
       data: {
         ticket: {
           comment: {

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

@@ -5,7 +5,7 @@ export default {
   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.0.1",
+  version: "0.1.1",
   props: {
     app,
     ticketId: {
@@ -14,6 +14,12 @@ export default {
         "ticketId",
       ],
     },
+    customSubdomain: {
+      propDefinition: [
+        app,
+        "customSubdomain",
+      ],
+    },
   },
   methods: {
     deleteTicket({
@@ -26,9 +32,15 @@ export default {
     },
   },
   async run({ $: step }) {
+    const {
+      ticketId,
+      customSubdomain,
+    } = this;
+
     await this.deleteTicket({
       step,
-      ticketId: this.ticketId,
+      ticketId,
+      customSubdomain,
     });
 
     step.export("$summary", "Successfully deleted ticket");

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

@@ -5,7 +5,7 @@ export default {
   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.0.1",
+  version: "0.1.1",
   props: {
     app,
     ticketId: {
@@ -38,6 +38,12 @@ export default {
         "ticketStatus",
       ],
     },
+    customSubdomain: {
+      propDefinition: [
+        app,
+        "customSubdomain",
+      ],
+    },
   },
   methods: {
     updateTicket({
@@ -56,11 +62,13 @@ export default {
       ticketPriority,
       ticketSubject,
       ticketStatus,
+      customSubdomain,
     } = this;
 
     const response = await this.updateTicket({
       step,
       ticketId,
+      customSubdomain,
       data: {
         ticket: {
           comment: {

package/package.json

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

package/sources/common/webhook.mjs

@@ -13,12 +13,22 @@ export default {
         "categoryId",
       ],
     },
+    customSubdomain: {
+      propDefinition: [
+        app,
+        "customSubdomain",
+      ],
+    },
   },
   hooks: {
     async activate() {
-      const { categoryId } = this;
+      const {
+        categoryId,
+        customSubdomain,
+      } = this;
 
       const { webhook } = await this.createWebhook({
+        customSubdomain,
         data: this.setupWebhookData(),
       });
 
@@ -26,6 +36,7 @@ export default {
       this.setWebhookId(webhookId);
 
       const { signing_secret: signingSecret } = await this.showWebhookSigningSecret({
+        customSubdomain,
         webhookId,
       });
 
@@ -33,6 +44,7 @@ export default {
       this.setSigningSecret(secret);
 
       const { trigger } = await this.createTrigger({
+        customSubdomain,
         data: this.setupTriggerData({
           webhookId,
           categoryId,
@@ -43,11 +55,14 @@ export default {
       this.setTriggerId(String(triggerId));
     },
     async deactivate() {
+      const { customSubdomain } = this;
       await Promise.all([
         this.deleteTrigger({
+          customSubdomain,
           triggerId: this.getTriggerId(),
         }),
         this.deleteWebhook({
+          customSubdomain,
           webhookId: this.getWebhookId(),
         }),
       ]);
@@ -182,6 +197,9 @@ export default {
         ) === 0
       );
     },
+    isRelevant() {
+      return true;
+    },
   },
   async run(event) {
     const {
@@ -206,6 +224,11 @@ export default {
       return;
     }
 
+    const isRelevant = await this.isRelevant(payload);
+    if (!isRelevant) {
+      return;
+    }
+
     const ts = Date.parse(payload.updatedAt);
     const id = `${payload.ticketId}-${ts}`;
 

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

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

@@ -0,0 +1,50 @@
+import common from "../common/ticket.mjs";
+
+export default {
+  ...common,
+  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.1",
+  type: "source",
+  dedupe: "unique",
+  props: {
+    ...common.props,
+    viewId: {
+      propDefinition: [
+        common.props.app,
+        "viewId",
+      ],
+    },
+  },
+  methods: {
+    ...common.methods,
+    getWebhookName() {
+      return "Ticket Added To View Webhook";
+    },
+    getTriggerTitle() {
+      return "Ticket Added To View Trigger";
+    },
+    getTriggerConditions() {
+      return {
+        any: [
+          {
+            field: "update_type",
+            value: "Change",
+          },
+          {
+            field: "update_type",
+            value: "Create",
+          },
+        ],
+      };
+    },
+    async isRelevant(payload) {
+      const { tickets } = await this.app.listTicketsInView({
+        viewId: this.viewId,
+      });
+      const foundTicket = tickets.find(({ id }) => id == payload.ticketId);
+      return foundTicket;
+    },
+  },
+};

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

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

@@ -2,19 +2,19 @@ import common from "../common/ticket.mjs";
 
 export default {
   ...common,
-  name: "Ticket Pended (Instant)",
+  name: "Ticket Pending (Instant)",
   key: "zendesk-ticket-pended",
   type: "source",
   description: "Emit new event when a ticket has changed to pending status",
-  version: "0.1.0",
+  version: "0.2.1",
   dedupe: "unique",
   methods: {
     ...common.methods,
     getWebhookName() {
-      return "Ticket Pended Webhook";
+      return "Ticket Pending Webhook";
     },
     getTriggerTitle() {
-      return "Ticket Pended Trigger";
+      return "Ticket Pending Trigger";
     },
     getTriggerConditions() {
       return {

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

package/zendesk.app.mjs

@@ -7,7 +7,7 @@ export default {
   propDefinitions: {
     categoryId: {
       type: "string",
-      label: "Trigger category ID",
+      label: "Trigger Category ID",
       description: "The ID of the trigger category. [See the docs here](https://developer.zendesk.com/api-reference/ticketing/business-rules/trigger_categories/#list-trigger-categories)",
       async options({ prevContext }) {
         const { afterCursor } = prevContext;
@@ -69,6 +69,37 @@ export default {
         };
       },
     },
+    viewId: {
+      type: "string",
+      label: "View ID",
+      description: "The ID of the view",
+      async options({ prevContext }) {
+        const { afterCursor } = prevContext;
+
+        const {
+          views,
+          meta,
+        } =
+          await this.listViews({
+            params: {
+              [constants.PAGE_SIZE_PARAM]: constants.DEFAULT_LIMIT,
+              [constants.PAGE_AFTER_PARAM]: afterCursor,
+            },
+          });
+
+        return {
+          context: {
+            afterCursor: meta.after_cursor,
+          },
+          options: views.map(({
+            id, title,
+          }) => ({
+            label: title || `View #${id}`,
+            value: id,
+          })),
+        };
+      },
+    },
     ticketCommentBody: {
       type: "string",
       label: "Comment body",
@@ -94,15 +125,24 @@ export default {
       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: {
-    getUrl(path) {
+    getUrl(path, customSubdomain) {
       const {
         SUBDOMAIN_PLACEHOLDER,
         BASE_URL,
         VERSION_PATH,
       } = constants;
-      const baseUrl = BASE_URL.replace(SUBDOMAIN_PLACEHOLDER, this.$auth.subdomain);
+      const baseUrl = BASE_URL.replace(
+        SUBDOMAIN_PLACEHOLDER,
+        customSubdomain?.trim() || this.$auth.subdomain,
+      );
       return `${baseUrl}${VERSION_PATH}${path}`;
     },
     getHeaders(headers) {
@@ -112,11 +152,11 @@ export default {
       };
     },
     makeRequest({
-      step = this, url, path, headers, ...args
+      step = this, url, path, headers, customSubdomain, ...args
     }) {
       const config = {
         headers: this.getHeaders(headers),
-        url: url ?? this.getUrl(path),
+        url: url ?? this.getUrl(path, customSubdomain),
         timeout: constants.DEFAULT_TIMEOUT,
         ...args,
       };
@@ -152,5 +192,19 @@ export default {
         ...args,
       });
     },
+    listViews(args = {}) {
+      return this.makeRequest({
+        path: "/views",
+        ...args,
+      });
+    },
+    listTicketsInView({
+      viewId, ...args
+    } = {}) {
+      return this.makeRequest({
+        path: `/views/${viewId}/tickets`,
+        ...args,
+      });
+    },
   },
 };