Merging pull request #18108

seynadio · Afstkla · michelle0927 · web-flow · commit 71a52a12f05b · 2025-09-01T09:58:42.000+07:00
* Add file attachment support to Zendesk update-ticket action

- Add attachments prop definition to zendesk.app.mjs for multiple file uploads
- Add uploadFile() and uploadFiles() helper methods with MIME type detection
- Modify update-ticket action to support file attachments via Zendesk uploads API
- Update version to 0.2.0 and package version to 0.7.2
- Enhanced success message to show attachment count

* Address CodeRabbit feedback

- Add guard for missing upload token and fail fast with clear error message
- Remove duplicate summary emission from uploadFiles method
- Use actual upload token count instead of input array length for summary

* Implement comprehensive URL support and improve file handling

- Add full HTTP/HTTPS URL support with axios for remote file fetching
- Extract filename from Content-Disposition header or URL path for URLs
- Use response Content-Type when available for better MIME detection
- Replace blocking readFileSync with async fs.promises.readFile
- Add proper input validation and JSDoc documentation
- Implement concurrent uploads with Promise.allSettled for better performance
- Add comprehensive error aggregation showing all failed uploads
- Filter and trim attachment input for robustness

* up versions

* lock change for some reason

* updates

* pnpm-lock.yaml

* update @pipedream/platform dependency

* pnpm-lock.yaml

---------

Co-authored-by: Job &lt;9075380+Afstkla@users.noreply.github.com&gt;
Co-authored-by: Job Nijenhuis &lt;job@neople.io&gt;
Co-authored-by: Michelle Bergeron &lt;michelle.bergeron@gmail.com&gt;
diff --git a/components/zendesk/actions/add-ticket-tags/add-ticket-tags.mjs b/components/zendesk/actions/add-ticket-tags/add-ticket-tags.mjs
@@ -5,7 +5,7 @@ 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.2",
+  version: "0.0.3",
   props: {
     app,
     ticketId: {
diff --git a/components/zendesk/actions/create-ticket/create-ticket.mjs b/components/zendesk/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.6",
+  version: "0.1.7",
   props: {
     app,
     ticketCommentBody: {
diff --git a/components/zendesk/actions/delete-ticket/delete-ticket.mjs b/components/zendesk/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.6",
+  version: "0.1.7",
   props: {
     app,
     ticketId: {
diff --git a/components/zendesk/actions/get-ticket-info/get-ticket-info.mjs b/components/zendesk/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.4",
+  version: "0.0.5",
   props: {
     app,
     ticketId: {
diff --git a/components/zendesk/actions/get-user-info/get-user-info.mjs b/components/zendesk/actions/get-user-info/get-user-info.mjs
@@ -4,7 +4,7 @@ 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.1",
+  version: "0.0.2",
   type: "action",
   props: {
     zendesk,
diff --git a/components/zendesk/actions/list-locales/list-locales.mjs b/components/zendesk/actions/list-locales/list-locales.mjs
@@ -4,7 +4,7 @@ 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.1",
+  version: "0.0.2",
   type: "action",
   props: {
     zendesk,
diff --git a/components/zendesk/actions/list-macros/list-macros.mjs b/components/zendesk/actions/list-macros/list-macros.mjs
@@ -4,7 +4,7 @@ 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.1",
+  version: "0.0.2",
   type: "action",
   props: {
     zendesk,
diff --git a/components/zendesk/actions/list-ticket-comments/list-ticket-comments.mjs b/components/zendesk/actions/list-ticket-comments/list-ticket-comments.mjs
@@ -4,7 +4,7 @@ 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.1",
+  version: "0.0.2",
   type: "action",
   props: {
     zendesk,
diff --git a/components/zendesk/actions/list-tickets/list-tickets.mjs b/components/zendesk/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.4",
+  version: "0.0.5",
   props: {
     app,
     sortBy: {
diff --git a/components/zendesk/actions/remove-ticket-tags/remove-ticket-tags.mjs b/components/zendesk/actions/remove-ticket-tags/remove-ticket-tags.mjs
@@ -5,7 +5,7 @@ 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.2",
+  version: "0.0.3",
   props: {
     app,
     ticketId: {
diff --git a/components/zendesk/actions/search-tickets/search-tickets.mjs b/components/zendesk/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.5",
+  version: "0.0.6",
   props: {
     app,
     query: {
diff --git a/components/zendesk/actions/set-ticket-tags/set-ticket-tags.mjs b/components/zendesk/actions/set-ticket-tags/set-ticket-tags.mjs
@@ -5,7 +5,7 @@ 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.2",
+  version: "0.0.3",
   props: {
     app,
     ticketId: {
diff --git a/components/zendesk/actions/update-ticket/update-ticket.mjs b/components/zendesk/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 and optionally manages tags. [See the documentation](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.6",
+  version: "0.2.0",
   props: {
     app,
     ticketId: {
@@ -56,6 +56,12 @@ export default {
         "customSubdomain",
       ],
     },
+    attachments: {
+      propDefinition: [
+        app,
+        "attachments",
+      ],
+    },
     ticketTags: {
       propDefinition: [
         app,
@@ -104,6 +110,7 @@ export default {
       ticketStatus,
       ticketCommentPublic,
       customSubdomain,
+      attachments,
       ticketTags,
       tagAction,
     } = this;
@@ -118,6 +125,24 @@ export default {
 
     ticketComment.public = ticketCommentPublic;
 
+    // Upload attachments if provided
+    if (attachments && attachments.length > 0) {
+      try {
+        const uploadTokens = await this.app.uploadFiles({
+          attachments,
+          customSubdomain,
+          step,
+        });
+
+        if (uploadTokens.length > 0) {
+          ticketComment.uploads = uploadTokens;
+        }
+      } catch (error) {
+        step.export("$summary", `Failed to upload attachments: ${error.message}`);
+        throw error;
+      }
+    }
+
     const response = await this.updateTicket({
       step,
       ticketId,
@@ -132,6 +157,13 @@ export default {
       },
     });
 
+    const attachmentCount = ticketComment.uploads?.length || 0;
+    const summary = attachmentCount > 0
+      ? `Successfully updated ticket with ID ${response.ticket.id} with ${attachmentCount} attachment(s)`
+      : `Successfully updated ticket with ID ${response.ticket.id}`;
+
+    step.export("$summary", summary);
+
     // Handle tag operations if tags are provided
     if (ticketTags && ticketTags.length > 0) {
       let tagResponse;
diff --git a/components/zendesk/package.json b/components/zendesk/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@pipedream/zendesk",
-  "version": "0.8.1",
+  "version": "0.8.2",
   "description": "Pipedream Zendesk Components",
   "main": "zendesk.app.mjs",
   "keywords": [
@@ -14,7 +14,8 @@
     "access": "public"
   },
   "dependencies": {
-    "@pipedream/platform": "^3.0.3",
-    "crypto": "^1.0.1"
+    "@pipedream/platform": "^3.1.0",
+    "crypto": "^1.0.1",
+    "path": "^0.12.7"
   }
 }
diff --git a/components/zendesk/sources/locale-updated/locale-updated.mjs b/components/zendesk/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.1",
+  version: "0.0.2",
   dedupe: "unique",
   async run() {
     const lastTs = this._getLastTs();
diff --git a/components/zendesk/sources/new-ticket-comment-added/new-ticket-comment-added.mjs b/components/zendesk/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.0.1",
+  version: "0.0.2",
   dedupe: "unique",
   props: {
     app,
diff --git a/components/zendesk/sources/new-ticket/new-ticket.mjs b/components/zendesk/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.6",
+  version: "0.2.7",
   dedupe: "unique",
   methods: {
     ...common.methods,
diff --git a/components/zendesk/sources/ticket-added-to-view/ticket-added-to-view.mjs b/components/zendesk/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.6",
+  version: "0.0.7",
   type: "source",
   dedupe: "unique",
   props: {
diff --git a/components/zendesk/sources/ticket-closed/ticket-closed.mjs b/components/zendesk/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.6",
+  version: "0.2.7",
   dedupe: "unique",
   methods: {
     ...common.methods,
diff --git a/components/zendesk/sources/ticket-pended/ticket-pended.mjs b/components/zendesk/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.6",
+  version: "0.2.7",
   dedupe: "unique",
   methods: {
     ...common.methods,
diff --git a/components/zendesk/sources/ticket-solved/ticket-solved.mjs b/components/zendesk/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.6",
+  version: "0.2.7",
   dedupe: "unique",
   methods: {
     ...common.methods,
diff --git a/components/zendesk/sources/ticket-updated/ticket-updated.mjs b/components/zendesk/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.6",
+  version: "0.2.7",
   dedupe: "unique",
   methods: {
     ...common.methods,
diff --git a/components/zendesk/zendesk.app.mjs b/components/zendesk/zendesk.app.mjs
@@ -1,5 +1,7 @@
 import { axios } from "@pipedream/platform";
 import constants from "./common/constants.mjs";
+import { getFileStreamAndMetadata } from "@pipedream/platform";
+import path from "path";
 
 export default {
   type: "app",
@@ -260,6 +262,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,
     },
+    attachments: {
+      type: "string[]",
+      label: "Attachments",
+      description: "File paths or URLs to attach to the ticket. Multiple files can be attached.",
+      optional: true,
+    },
     ticketTags: {
       type: "string[]",
       label: "Tags",
@@ -369,6 +377,94 @@ export default {
         ...args,
       });
     },
+    streamToBuffer(stream) {
+      return new Promise((resolve, reject) => {
+        const chunks = [];
+        stream.on("data", (chunk) => chunks.push(chunk));
+        stream.on("end", () => resolve(Buffer.concat(chunks)));
+        stream.on("error", reject);
+      });
+    },
+    /**
+     * Upload a single file (local path or http(s) URL) to Zendesk Uploads API.
+     * @param {Object} params
+     * @param {string} params.filePath - Local filesystem path or http(s) URL.
+     * @param {string} [params.filename] - Optional filename override for the upload.
+     * @param {string} [params.customSubdomain]
+     * @param {*} [params.step]
+     */
+    async uploadFile({
+      filePath, filename, customSubdomain, step,
+    }) {
+      if (!filePath || typeof filePath !== "string") {
+        throw new Error("uploadFile: 'filePath' (string) is required");
+      }
+
+      const {
+        stream, metadata,
+      } = await getFileStreamAndMetadata(filePath);
+      const fileBinary = await this.streamToBuffer(stream);
+
+      if (!filename) {
+        filename = path.basename(filePath);
+      }
+
+      return this.makeRequest({
+        step,
+        method: "post",
+        path: `/uploads?filename=${encodeURIComponent(filename)}`,
+        customSubdomain,
+        headers: {
+          "Content-Type": metadata.contentType,
+          "Content-Length": metadata.size,
+          "Accept": "application/json",
+        },
+        data: Buffer.from(fileBinary, "binary"),
+      });
+    },
+    async uploadFiles({
+      attachments, customSubdomain, step,
+    } = {}) {
+      if (!attachments || !attachments.length) {
+        return [];
+      }
+      const files = attachments
+        .map((a) => (typeof a === "string"
+          ? a.trim()
+          : a))
+        .filter(Boolean);
+
+      const settled = await Promise.allSettled(
+        files.map((attachment) =>
+          this.uploadFile({
+            filePath: attachment,
+            customSubdomain,
+            step,
+          })),
+      );
+
+      const tokens = [];
+      const errors = [];
+      settled.forEach((res, i) => {
+        const attachment = files[i];
+        if (res.status === "fulfilled") {
+          const token = res.value?.upload?.token;
+          if (!token) {
+            errors.push(`Upload API returned no token for ${attachment}`);
+          } else {
+            tokens.push(token);
+          }
+        } else {
+          const reason = res.reason?.message || String(res.reason || "Unknown error");
+          errors.push(`${attachment}: ${reason}`);
+        }
+      });
+
+      if (errors.length) {
+        throw new Error(`Failed to upload ${errors.length}/${files.length} attachment(s): ${errors.join("; ")}`);
+      }
+      return tokens;
+    },
     listTicketComments({
       ticketId, ...args
     } = {}) {
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
