@pipedream/zendesk 0.9.0 → 0.10.1

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

@@ -5,7 +5,12 @@ 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.4",
+  version: "0.0.6",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: false,
+  },
   props: {
     app,
     ticketId: {

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

@@ -5,7 +5,12 @@ 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.8",
+  version: "0.1.10",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: false,
+  },
   props: {
     app,
     ticketCommentBody: {

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

@@ -5,7 +5,12 @@ 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.8",
+  version: "0.1.10",
+  annotations: {
+    destructiveHint: true,
+    openWorldHint: true,
+    readOnlyHint: false,
+  },
   props: {
     app,
     ticketId: {

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

@@ -5,7 +5,12 @@ 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.6",
+  version: "0.0.8",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: true,
+  },
   props: {
     app,
     ticketId: {

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

@@ -4,7 +4,12 @@ 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.3",
+  version: "0.0.5",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: true,
+  },
   type: "action",
   props: {
     zendesk,

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

@@ -4,7 +4,12 @@ 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.3",
+  version: "0.0.5",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: true,
+  },
   type: "action",
   props: {
     zendesk,

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

@@ -4,7 +4,12 @@ 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.3",
+  version: "0.0.5",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: true,
+  },
   type: "action",
   props: {
     zendesk,

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

@@ -4,7 +4,12 @@ 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.3",
+  version: "0.0.5",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: true,
+  },
   type: "action",
   props: {
     zendesk,

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

@@ -5,7 +5,12 @@ 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.6",
+  version: "0.0.8",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: true,
+  },
   props: {
     app,
     sortBy: {

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

@@ -5,7 +5,12 @@ 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.4",
+  version: "0.0.6",
+  annotations: {
+    destructiveHint: true,
+    openWorldHint: true,
+    readOnlyHint: false,
+  },
   props: {
     app,
     ticketId: {

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

@@ -5,7 +5,12 @@ 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.7",
+  version: "0.0.9",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: true,
+  },
   props: {
     app,
     query: {

package/actions/set-custom-ticket-fields/set-custom-ticket-fields.mjs

@@ -0,0 +1,85 @@
+import app from "../../zendesk.app.mjs";
+import { parseObject } from "../../common/utils.mjs";
+import { ConfigurationError } from "@pipedream/platform";
+
+export default {
+  key: "zendesk-set-custom-ticket-fields",
+  name: "Set Custom Ticket Fields",
+  description: "Sets one or more custom field values on a ticket. [See the documentation](https://developer.zendesk.com/api-reference/ticketing/tickets/tickets/#update-ticket).",
+  type: "action",
+  version: "0.0.3",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: false,
+  },
+  props: {
+    app,
+    ticketId: {
+      propDefinition: [
+        app,
+        "ticketId",
+      ],
+    },
+    customFields: {
+      type: "string[]",
+      label: "Custom Fields",
+      description: "Array of custom field objects. Each item should be formatted as `{\"id\": \"field_id\", \"value\": \"field_value\"}`. Example: `{\"id\": \"23129751115165\", \"value\": \"ABCDE\"}`",
+    },
+    customSubdomain: {
+      propDefinition: [
+        app,
+        "customSubdomain",
+      ],
+    },
+  },
+  methods: {
+    updateTicket({
+      ticketId, ...args
+    } = {}) {
+      return this.app.update({
+        path: `/tickets/${ticketId}`,
+        ...args,
+      });
+    },
+  },
+  async run({ $: step }) {
+    const {
+      ticketId,
+      customFields,
+      customSubdomain,
+    } = this;
+
+    // Parse custom fields from string array to objects
+    const parsedCustomFields = parseObject(customFields);
+
+    if (!Array.isArray(parsedCustomFields)) {
+      throw new ConfigurationError("Custom Fields must be an array of custom field objects");
+    }
+
+    // Validate custom fields structure
+    parsedCustomFields.forEach((field, index) => {
+      if (!field.id) {
+        throw new ConfigurationError(`Custom field at index ${index} is missing required "id" property`);
+      }
+      if (field.value === undefined) {
+        throw new ConfigurationError(`Custom field at index ${index} is missing required "value" property`);
+      }
+    });
+
+    const response = await this.updateTicket({
+      step,
+      ticketId,
+      customSubdomain,
+      data: {
+        ticket: {
+          custom_fields: parsedCustomFields,
+        },
+      },
+    });
+
+    step.export("$summary", `Successfully updated ${parsedCustomFields.length} custom field(s) on ticket ${response.ticket.id}`);
+
+    return response;
+  },
+};

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

@@ -5,7 +5,12 @@ 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.4",
+  version: "0.0.6",
+  annotations: {
+    destructiveHint: true,
+    openWorldHint: true,
+    readOnlyHint: false,
+  },
   props: {
     app,
     ticketId: {

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

@@ -5,7 +5,12 @@ export default {
   name: "Update Ticket",
   description: "Updates a ticket. [See the documentation](https://developer.zendesk.com/api-reference/ticketing/tickets/tickets/#update-ticket).",
   type: "action",
-  version: "0.2.1",
+  version: "0.2.3",
+  annotations: {
+    destructiveHint: true,
+    openWorldHint: true,
+    readOnlyHint: false,
+  },
   props: {
     app,
     ticketId: {

package/common/utils.mjs

@@ -0,0 +1,25 @@
+export const parseObject = (obj) => {
+  if (!obj) {
+    return {};
+  }
+  if (typeof obj === "string") {
+    try {
+      return JSON.parse(obj);
+    } catch {
+      return obj;
+    }
+  }
+  if (Array.isArray(obj)) {
+    return obj.map(parseObject);
+  }
+  if (typeof obj === "object") {
+    return Object.fromEntries(Object.entries(obj).map(([
+      key,
+      value,
+    ]) => [
+      key,
+      parseObject(value),
+    ]));
+  }
+  return obj;
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pipedream/zendesk",
-  "version": "0.9.0",
+  "version": "0.10.1",
   "description": "Pipedream Zendesk Components",
   "main": "zendesk.app.mjs",
   "keywords": [
@@ -15,7 +15,6 @@
   },
   "dependencies": {
     "@pipedream/platform": "^3.1.0",
-    "crypto": "^1.0.1",
     "path": "^0.12.7"
   }
 }

package/sources/common/ticket.mjs

@@ -11,7 +11,7 @@ export default {
           : match.toUpperCase();
       }).replace(/\s+/g, "");
     },
-    getTriggerPayload() {
+    async getTriggerPayload() {
       if (this.jsonBody) {
         return JSON.parse(this.jsonBody);
       }
@@ -21,9 +21,20 @@ export default {
           createdAt: "{{ticket.created_at_with_timestamp}}",
           updatedAt: "{{ticket.updated_at_with_timestamp}}",
         };
+        const { ticket_fields: customFields } = await this.app.listTicketFields();
         for (const field of this.fields) {
-          const key = this.convertToCamelCase(field.label);
-          payload[key] = field.value;
+          const key = this.convertToCamelCase(field?.label || field);
+          if (field?.value) {
+            payload[key] = field.value;
+          } else {
+            const fieldId = customFields.find(({ title }) => title === field)?.id;
+            if (fieldId) {
+              payload[key] = `{{ticket.ticket_field_${fieldId}}}`;
+            } else {
+              console.warn(`Custom field not found for: ${field}`);
+              payload[key] = null;
+            }
+          }
         }
         return payload;
       }

package/sources/common/webhook.mjs

@@ -57,7 +57,7 @@ export default {
 
       const { trigger } = await this.createTrigger({
         customSubdomain,
-        data: this.setupTriggerData({
+        data: await this.setupTriggerData({
           webhookId,
           categoryId,
         }),
@@ -171,7 +171,7 @@ export default {
         },
       };
     },
-    setupTriggerData({
+    async setupTriggerData({
       webhookId, categoryId,
     }) {
       return {
@@ -184,7 +184,7 @@ export default {
               field: "notification_webhook",
               value: [
                 webhookId,
-                JSON.stringify(this.getTriggerPayload()),
+                JSON.stringify(await this.getTriggerPayload()),
               ],
             },
           ],

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

@@ -6,7 +6,7 @@ export default {
   name: "Locale Updated",
   type: "source",
   description: "Emit new event when a locale has been updated",
-  version: "0.0.3",
+  version: "0.0.4",
   dedupe: "unique",
   async run() {
     const lastTs = this._getLastTs();

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

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

@@ -7,7 +7,7 @@ export default {
   key: "zendesk-new-ticket-comment-added",
   type: "source",
   description: "Emit new event when a ticket comment has been added",
-  version: "0.1.0",
+  version: "0.1.1",
   dedupe: "unique",
   props: {
     app,
@@ -50,8 +50,8 @@ export default {
         ],
       };
     },
-    getTriggerPayload() {
-      const payload = common.methods.getTriggerPayload.call(this);
+    async getTriggerPayload() {
+      const payload = await common.methods.getTriggerPayload.call(this);
       return {
         ...payload,
         ticketComments: "{{ticket.comments}}",

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.8",
+  version: "0.0.9",
   type: "source",
   dedupe: "unique",
   props: {
@@ -32,10 +32,6 @@ export default {
             field: "update_type",
             value: "Change",
           },
-          {
-            field: "update_type",
-            value: "Create",
-          },
         ],
       };
     },

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

package/zendesk.app.mjs

@@ -87,6 +87,7 @@ export default {
             params: {
               [constants.PAGE_SIZE_PARAM]: constants.DEFAULT_LIMIT,
               [constants.PAGE_AFTER_PARAM]: afterCursor,
+              active: true,
             },
           });