@pipedream/zendesk 0.5.0 → 0.6.1

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

@@ -3,9 +3,9 @@ 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).",
+  description: "Creates a ticket. [See the documentation](https://developer.zendesk.com/api-reference/ticketing/tickets/tickets/#create-ticket).",
   type: "action",
-  version: "0.1.0",
+  version: "0.1.2",
   props: {
     app,
     ticketCommentBody: {

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

@@ -3,9 +3,9 @@ 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).",
+  description: "Deletes a ticket. [See the documentation](https://developer.zendesk.com/api-reference/ticketing/tickets/tickets/#delete-ticket).",
   type: "action",
-  version: "0.1.0",
+  version: "0.1.2",
   props: {
     app,
     ticketId: {

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

@@ -3,9 +3,9 @@ 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).",
+  description: "Updates a ticket. [See the documentation](https://developer.zendesk.com/api-reference/ticketing/tickets/tickets/#update-ticket).",
   type: "action",
-  version: "0.1.0",
+  version: "0.1.2",
   props: {
     app,
     ticketId: {

package/common/constants.mjs

@@ -31,6 +31,197 @@ const TICKET_STATUS_OPTIONS = {
   CLOSED: "closed",
 };
 
+const TICKET_FIELD_OPTIONS = [
+  {
+    label: "Current User Details",
+    value: "{{current_user.details}}",
+  },
+  {
+    label: "Current User Email",
+    value: "{{current_user.email}}",
+  },
+  {
+    label: "Current User External ID",
+    value: "{{current_user.external_id}}",
+  },
+  {
+    label: "Current User First Name",
+    value: "{{current_user.first_name}}",
+  },
+  {
+    label: "Current User Language",
+    value: "{{current_user.language}}",
+  },
+  {
+    label: "Current User Name",
+    value: "{{current_user.name}}",
+  },
+  {
+    label: "Current User Notes",
+    value: "{{current_user.notes}}",
+  },
+  {
+    label: "Current User Organization Details",
+    value: "{{current_user.organization.details}}",
+  },
+  {
+    label: "Current User Organization Name",
+    value: "{{current_user.organization.name}}",
+  },
+  {
+    label: "Current User Organization Notes",
+    value: "{{current_user.organization.notes}}",
+  },
+  {
+    label: "Current User Phone",
+    value: "{{current_user.phone}}",
+  },
+  {
+    label: "Satisfaction Current Comment",
+    value: "{{satisfaction.current_comment",
+  },
+  {
+    label: "Satisfaction Current Rating",
+    value: "{{satisfaction.current_rating}}",
+  },
+  {
+    label: "Ticket Account",
+    value: "{{ticket.account}}",
+  },
+  {
+    label: "Ticket Assignee Email",
+    value: "{{ticket.assignee.email}}",
+  },
+  {
+    label: "Ticket Assignee First Name",
+    value: "{{ticket.assignee.first_name}}",
+  },
+  {
+    label: "Ticket Assignee Last Name",
+    value: "{{ticket.assignee.last_name}}",
+  },
+  {
+    label: "Ticket Name",
+    value: "{{ticket.name}}",
+  },
+  {
+    label: "Ticket Brand Name",
+    value: "{{ticket.brand.name}}",
+  },
+  {
+    label: "Ticket CC Names",
+    value: "{{ticket.cc_names}}",
+  },
+  {
+    label: "Ticket CSS",
+    value: "{{ticket.css}}",
+  },
+  {
+    label: "Ticket Current Holiday Name",
+    value: "{{ticket.current_holiday_name}}",
+  },
+  {
+    label: "Ticket Description",
+    value: "{{ticket.description}}",
+  },
+  {
+    label: "Ticket Due Date",
+    value: "{{ticket.due_date}}",
+  },
+  {
+    label: "Ticket External ID",
+    value: "{{ticket.external_id}}",
+  },
+  {
+    label: "Ticket Group Name",
+    value: "{{ticket.group.name}}",
+  },
+  {
+    label: "Ticket Latest Comment HTML",
+    value: "{{ticket.latest_comment_html}}",
+  },
+  {
+    label: "Ticket Latest Public Comment HTML",
+    value: "{{ticket.latest_public_comment_html}}",
+  },
+  {
+    label: "Ticket Organization Details",
+    value: "{{ticket.organization.details}}",
+  },
+  {
+    label: "Ticket Organization External ID",
+    value: "{{ticket.organization.external_id}}",
+  },
+  {
+    label: "Ticket Organization Name",
+    value: "{{ticket.organization.name}}",
+  },
+  {
+    label: "Ticket Organization Notes",
+    value: "{{ticket.organization.notes}}",
+  },
+  {
+    label: "Ticket Priority",
+    value: "{{ticket.priority}}",
+  },
+  {
+    label: "Ticket Requester Details",
+    value: "{{ticket.requester.details}}",
+  },
+  {
+    label: "Ticket Requester Email",
+    value: "{{ticket.requester.email}}",
+  },
+  {
+    label: "Ticket Requester External ID",
+    value: "{{ticket.requester.external_id}}",
+  },
+  {
+    label: "Ticket Requester First Name",
+    value: "{{ticket.requester.first_name}}",
+  },
+  {
+    label: "Ticket Requester Language",
+    value: "{{ticket.requester.language}}",
+  },
+  {
+    label: "Ticket Requester Last Name",
+    value: "{{ticket.requester.last_name}}",
+  },
+  {
+    label: "Ticket Requester Name",
+    value: "{{ticket.requester.name}}",
+  },
+  {
+    label: "Ticket Requester Phone",
+    value: "{{ticket.requester.phone}}",
+  },
+  {
+    label: "Ticket Status",
+    value: "{{ticket.status}}",
+  },
+  {
+    label: "Ticket Tags",
+    value: "{{ticket.tags}}",
+  },
+  {
+    label: "Ticket Title",
+    value: "{{ticket.title}}",
+  },
+  {
+    label: "Ticket Type",
+    value: "{{ticket.ticket_type}}",
+  },
+  {
+    label: "Ticket URL",
+    value: "{{ticket.url}}",
+  },
+  {
+    label: "Ticket Via",
+    value: "{{ticket.via}}",
+  },
+];
+
 export default {
   SUBDOMAIN_PLACEHOLDER,
   BASE_URL,
@@ -50,4 +241,5 @@ export default {
   DEFAULT_TIMEOUT,
   TICKET_PRIORITY_OPTIONS,
   TICKET_STATUS_OPTIONS,
+  TICKET_FIELD_OPTIONS,
 };

package/package.json

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

package/sources/common/ticket.mjs

@@ -4,7 +4,29 @@ export default {
   ...common,
   methods: {
     ...common.methods,
+    convertToCamelCase(str) {
+      return str.replace(/(?:^\w|[A-Z]|\b\w)/g, function(match, index) {
+        return index === 0
+          ? match.toLowerCase()
+          : match.toUpperCase();
+      }).replace(/\s+/g, "");
+    },
     getTriggerPayload() {
+      if (this.jsonBody) {
+        return JSON.parse(this.jsonBody);
+      }
+      if (this.fields?.length) {
+        const payload = {
+          ticketId: "{{ticket.id}}",
+          createdAt: "{{ticket.created_at_with_timestamp}}",
+          updatedAt: "{{ticket.updated_at_with_timestamp}}",
+        };
+        for (const field of this.fields) {
+          const key = this.convertToCamelCase(field.label);
+          payload[key] = field.value;
+        }
+        return payload;
+      }
       return {
         ticketId: "{{ticket.id}}",
         title: "{{ticket.title}}",

package/sources/common/webhook.mjs

@@ -19,6 +19,18 @@ export default {
         "customSubdomain",
       ],
     },
+    fields: {
+      propDefinition: [
+        app,
+        "fields",
+      ],
+    },
+    jsonBody: {
+      type: "string",
+      label: "JSON Body",
+      description: "Custom JSON Body of the incoming payload. Setting `jsonBody` will overwrite the `fields` prop",
+      optional: true,
+    },
   },
   hooks: {
     async activate() {
@@ -197,6 +209,9 @@ export default {
         ) === 0
       );
     },
+    isRelevant() {
+      return true;
+    },
   },
   async run(event) {
     const {
@@ -221,12 +236,17 @@ export default {
       return;
     }
 
+    const isRelevant = await this.isRelevant(payload);
+    if (!isRelevant) {
+      return;
+    }
+
     const ts = Date.parse(payload.updatedAt);
     const id = `${payload.ticketId}-${ts}`;
 
     this.$emit(payload, {
       id,
-      summary: payload.title,
+      summary: payload.title || 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.2.0",
+  version: "0.2.2",
   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.2",
+  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.2.0",
+  version: "0.2.2",
   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.2.0",
+  version: "0.2.2",
   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.2.0",
+  version: "0.2.2",
   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.0",
+  version: "0.2.2",
   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,56 @@ 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,
+          })),
+        };
+      },
+    },
+    fields: {
+      type: "string[]",
+      label: "Fields",
+      description: "Ticket fields to be included in the incoming webhook payload",
+      withLabel: true,
+      optional: true,
+      async options() {
+        // placehoders reference - https://support.zendesk.com/hc/en-us/articles/4408886858138
+        const { ticket_fields: customFields } = await this.listTicketFields();
+        const fields = customFields.reverse().map(({
+          id, title,
+        }) => ({
+          label: title,
+          value: `{{ticket.ticket_field_${id}}}`,
+        }));
+        fields.push(...constants.TICKET_FIELD_OPTIONS);
+        return fields;
+      },
+    },
     ticketCommentBody: {
       type: "string",
       label: "Comment body",
@@ -161,5 +211,25 @@ export default {
         ...args,
       });
     },
+    listViews(args = {}) {
+      return this.makeRequest({
+        path: "/views",
+        ...args,
+      });
+    },
+    listTicketsInView({
+      viewId, ...args
+    } = {}) {
+      return this.makeRequest({
+        path: `/views/${viewId}/tickets`,
+        ...args,
+      });
+    },
+    listTicketFields(args = {}) {
+      return this.makeRequest({
+        path: "/ticket_fields",
+        ...args,
+      });
+    },
   },
 };