@pipedream/zendesk 0.7.0 → 0.7.2

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

@@ -0,0 +1,48 @@
+import app from "../../zendesk.app.mjs";
+
+export default {
+  key: "zendesk-add-ticket-tags",
+  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",
+  props: {
+    app,
+    ticketId: {
+      propDefinition: [
+        app,
+        "ticketId",
+      ],
+    },
+    ticketTags: {
+      propDefinition: [
+        app,
+        "ticketTags",
+      ],
+      description: "Array of tags to add to the ticket. These will be appended to any existing tags.",
+    },
+    customSubdomain: {
+      propDefinition: [
+        app,
+        "customSubdomain",
+      ],
+    },
+  },
+  async run({ $: step }) {
+    const {
+      ticketId,
+      ticketTags,
+      customSubdomain,
+    } = this;
+
+    const response = await this.app.addTicketTags({
+      step,
+      ticketId,
+      tags: ticketTags,
+      customSubdomain,
+    });
+
+    step.export("$summary", `Successfully added ${ticketTags.length} tag(s) to ticket ${ticketId}`);
+    return response;
+  },
+};

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.3",
+  version: "0.1.5",
   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.3",
+  version: "0.1.5",
   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.1",
+  version: "0.0.3",
   props: {
     app,
     ticketId: {

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.1",
+  version: "0.0.3",
   props: {
     app,
     sortBy: {

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

@@ -0,0 +1,48 @@
+import app from "../../zendesk.app.mjs";
+
+export default {
+  key: "zendesk-remove-ticket-tags",
+  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",
+  props: {
+    app,
+    ticketId: {
+      propDefinition: [
+        app,
+        "ticketId",
+      ],
+    },
+    ticketTags: {
+      propDefinition: [
+        app,
+        "ticketTags",
+      ],
+      description: "Array of tags to remove from the ticket.",
+    },
+    customSubdomain: {
+      propDefinition: [
+        app,
+        "customSubdomain",
+      ],
+    },
+  },
+  async run({ $: step }) {
+    const {
+      ticketId,
+      ticketTags,
+      customSubdomain,
+    } = this;
+
+    const response = await this.app.removeTicketTags({
+      step,
+      ticketId,
+      tags: ticketTags,
+      customSubdomain,
+    });
+
+    step.export("$summary", `Successfully removed ${ticketTags.length} tag(s) from ticket ${ticketId}`);
+    return response;
+  },
+};

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.1",
+  version: "0.0.3",
   props: {
     app,
     query: {

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

@@ -0,0 +1,47 @@
+import app from "../../zendesk.app.mjs";
+
+export default {
+  key: "zendesk-set-ticket-tags",
+  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",
+  props: {
+    app,
+    ticketId: {
+      propDefinition: [
+        app,
+        "ticketId",
+      ],
+    },
+    ticketTags: {
+      propDefinition: [
+        app,
+        "ticketTags",
+      ],
+    },
+    customSubdomain: {
+      propDefinition: [
+        app,
+        "customSubdomain",
+      ],
+    },
+  },
+  async run({ $: step }) {
+    const {
+      ticketId,
+      ticketTags,
+      customSubdomain,
+    } = this;
+
+    const response = await this.app.setTicketTags({
+      step,
+      ticketId,
+      tags: ticketTags,
+      customSubdomain,
+    });
+
+    step.export("$summary", `Successfully set ${ticketTags.length} tag(s) on ticket ${ticketId}`);
+    return response;
+  },
+};

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 documentation](https://developer.zendesk.com/api-reference/ticketing/tickets/tickets/#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.3",
+  version: "0.1.5",
   props: {
     app,
     ticketId: {
@@ -20,6 +20,12 @@ export default {
         "ticketCommentBody",
       ],
     },
+    ticketCommentBodyIsHTML: {
+      propDefinition: [
+        app,
+        "ticketCommentBodyIsHTML",
+      ],
+    },
     ticketPriority: {
       propDefinition: [
         app,
@@ -38,12 +44,45 @@ export default {
         "ticketStatus",
       ],
     },
+    ticketCommentPublic: {
+      propDefinition: [
+        app,
+        "ticketCommentPublic",
+      ],
+    },
     customSubdomain: {
       propDefinition: [
         app,
         "customSubdomain",
       ],
     },
+    ticketTags: {
+      propDefinition: [
+        app,
+        "ticketTags",
+      ],
+    },
+    tagAction: {
+      type: "string",
+      label: "Tag Action",
+      description: "How to handle the tags: set (replace all existing tags), add (append to existing tags), or remove (remove specified tags)",
+      options: [
+        {
+          label: "Set Tags (Replace All)",
+          value: "set",
+        },
+        {
+          label: "Add Tags (Append)",
+          value: "add",
+        },
+        {
+          label: "Remove Tags",
+          value: "remove",
+        },
+      ],
+      optional: true,
+      default: "set",
+    },
   },
   methods: {
     updateTicket({
@@ -59,21 +98,33 @@ export default {
     const {
       ticketId,
       ticketCommentBody,
+      ticketCommentBodyIsHTML,
       ticketPriority,
       ticketSubject,
       ticketStatus,
+      ticketCommentPublic,
       customSubdomain,
+      ticketTags,
+      tagAction,
     } = this;
 
+    const ticketComment = ticketCommentBodyIsHTML
+      ? {
+        html_body: ticketCommentBody,
+      }
+      : {
+        body: ticketCommentBody,
+      };
+
+    ticketComment.public = ticketCommentPublic;
+
     const response = await this.updateTicket({
       step,
       ticketId,
       customSubdomain,
       data: {
         ticket: {
-          comment: {
-            body: ticketCommentBody,
-          },
+          comment: ticketComment,
           priority: ticketPriority,
           subject: ticketSubject,
           status: ticketStatus,
@@ -81,8 +132,54 @@ export default {
       },
     });
 
-    step.export("$summary", `Successfully updated ticket with ID ${response.ticket.id}`);
+    // Handle tag operations if tags are provided
+    if (ticketTags && ticketTags.length > 0) {
+      let tagResponse;
+
+      switch (tagAction) {
+      case "add":
+        tagResponse = await this.app.addTicketTags({
+          step,
+          ticketId,
+          tags: ticketTags,
+          customSubdomain,
+        });
+        break;
+      case "remove":
+        tagResponse = await this.app.removeTicketTags({
+          step,
+          ticketId,
+          tags: ticketTags,
+          customSubdomain,
+        });
+        break;
+      case "set":
+      default:
+        tagResponse = await this.app.setTicketTags({
+          step,
+          ticketId,
+          tags: ticketTags,
+          customSubdomain,
+        });
+        break;
+      }
 
+      // Include tag information in summary
+      const tagSummary = `and ${tagAction === "set"
+        ? "set"
+        : tagAction === "add"
+          ? "added"
+          : "removed"} ${ticketTags.length} tag(s)`;
+      step.export("$summary", `Successfully updated ticket with ID ${response.ticket.id} ${tagSummary}`);
+      // Include tag response in the return data
+      return {
+        ticket: response,
+        tags: tagResponse,
+      };
+    }
+
+    step.export("$summary", `Successfully updated ticket with ID ${response.ticket.id}`);
     return response;
   },
 };
+

package/package.json

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

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

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.3",
+  version: "0.0.5",
   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.3",
+  version: "0.2.5",
   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.3",
+  version: "0.2.5",
   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.3",
+  version: "0.2.5",
   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.3",
+  version: "0.2.5",
   dedupe: "unique",
   methods: {
     ...common.methods,

package/zendesk.app.mjs

@@ -9,6 +9,7 @@ export default {
       type: "string",
       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)",
+      optional: true,
       async options({ prevContext }) {
         const { afterCursor } = prevContext;
 
@@ -124,6 +125,13 @@ export default {
       label: "Comment body",
       description: "The body of the comment.",
     },
+    ticketCommentBodyIsHTML: {
+      type: "boolean",
+      label: "Comment body is HTML",
+      description: "Whether the comment body is HTML. Default is `false`, which expects Markdown",
+      default: false,
+      optional: true,
+    },
     ticketPriority: {
       type: "string",
       label: "Ticket Priority",
@@ -144,6 +152,13 @@ export default {
       optional: true,
       options: Object.values(constants.TICKET_STATUS_OPTIONS),
     },
+    ticketCommentPublic: {
+      type: "boolean",
+      label: "Comment Public",
+      description: "Whether the comment is public. Default is `true`",
+      default: true,
+      optional: true,
+    },
     sortBy: {
       type: "string",
       label: "Sort By",
@@ -174,6 +189,12 @@ export default {
       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,
     },
+    ticketTags: {
+      type: "string[]",
+      label: "Tags",
+      description: "Array of tags to apply to the ticket. These will replace any existing tags on the ticket.",
+      optional: true,
+    },
   },
   methods: {
     getUrl(path, customSubdomain) {
@@ -300,5 +321,68 @@ export default {
         args.params.page += 1;
       }
     },
+    /**
+     * Set tags on a ticket (replaces all existing tags)
+     * @param {object} args - Arguments object
+     * @param {string} args.ticketId - The ticket ID
+     * @param {string[]} args.tags - Array of tags to set
+     * @param {string} args.customSubdomain - Optional custom subdomain
+     * @returns {Promise<object>} API response
+     */
+    setTicketTags({
+      ticketId, tags, customSubdomain, ...args
+    }) {
+      return this.makeRequest({
+        method: "POST",
+        path: `/tickets/${ticketId}/tags.json`,
+        customSubdomain,
+        data: {
+          tags,
+        },
+        ...args,
+      });
+    },
+    /**
+     * Add tags to a ticket (appends to existing tags)
+     * @param {object} args - Arguments object
+     * @param {string} args.ticketId - The ticket ID
+     * @param {string[]} args.tags - Array of tags to add
+     * @param {string} args.customSubdomain - Optional custom subdomain
+     * @returns {Promise<object>} API response
+     */
+    addTicketTags({
+      ticketId, tags, customSubdomain, ...args
+    }) {
+      return this.makeRequest({
+        method: "PUT",
+        path: `/tickets/${ticketId}/tags.json`,
+        customSubdomain,
+        data: {
+          tags,
+        },
+        ...args,
+      });
+    },
+    /**
+     * Remove specific tags from a ticket
+     * @param {object} args - Arguments object
+     * @param {string} args.ticketId - The ticket ID
+     * @param {string[]} args.tags - Array of tags to remove
+     * @param {string} args.customSubdomain - Optional custom subdomain
+     * @returns {Promise<object>} API response
+     */
+    removeTicketTags({
+      ticketId, tags, customSubdomain, ...args
+    }) {
+      return this.makeRequest({
+        method: "DELETE",
+        path: `/tickets/${ticketId}/tags.json`,
+        customSubdomain,
+        data: {
+          tags,
+        },
+        ...args,
+      });
+    },
   },
 };