@pipedream/trello 0.3.13 → 0.4.0

package/README.md

@@ -1,12 +1,11 @@
 # Overview
 
-With the Trello API, you can:
-
-- Create new boards
-- Add and remove lists from boards
-- Add and remove cards from lists
-- Add comments to cards
-- Add and remove attachments from cards
-- Add and remove members from boards
-- Change the background of boards
-- And more!
+Trello's API lets you craft workflows around managing boards, lists, cards, and users. With Pipedream, you can automate Trello tasks, like syncing cards with external databases, updating checklists, and posting notifications to other platforms. It enables seamless connection with other apps, fostering productivity by automating routine board operations, card management, and team notifications.
+
+# Example Use Cases
+
+- **Automated Project Management**: Sync Trello cards with a GitHub repository, creating issues from new cards, and updating cards when issues are closed. This keeps developers and stakeholders aligned across platforms.
+
+- **Marketing Campaign Tracker**: Connect Trello with Google Sheets to track campaign progress. When a card moves to the "Complete" list, automatically log the details in a spreadsheet, giving a real-time view of campaign status.
+
+- **Team Coordination**: Integrate Trello with Slack, notifying a channel when due dates are updated or cards are marked complete, ensuring the team stays informed of task progression without having to check Trello.

package/actions/add-attachment-to-card/add-attachment-to-card.mjs

@@ -0,0 +1,124 @@
+import { ConfigurationError } from "@pipedream/platform";
+import fs from "fs";
+import FormData from "form-data";
+import common from "../common.mjs";
+
+export default {
+  ...common,
+  key: "trello-add-attachment-to-card",
+  name: "Add Attachment To Card",
+  description: "Adds a file attachment on a card. [See the documentation](https://developer.atlassian.com/cloud/trello/rest/api-group-cards/#api-cards-id-attachments-post)",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    ...common.props,
+    board: {
+      propDefinition: [
+        common.props.app,
+        "board",
+      ],
+    },
+    cardId: {
+      propDefinition: [
+        common.props.app,
+        "cards",
+        (c) => ({
+          board: c.board,
+        }),
+      ],
+      type: "string",
+      label: "Card",
+      description: "The ID of the Card to add the Attachment to",
+      optional: false,
+    },
+    name: {
+      propDefinition: [
+        common.props.app,
+        "name",
+      ],
+    },
+    url: {
+      propDefinition: [
+        common.props.app,
+        "url",
+      ],
+    },
+    mimeType: {
+      propDefinition: [
+        common.props.app,
+        "mimeType",
+      ],
+    },
+    file: {
+      propDefinition: [
+        common.props.app,
+        "file",
+      ],
+    },
+    setCover: {
+      type: "boolean",
+      label: "Set Cover?",
+      description: "Determines whether to use the new attachment as a cover for the Card",
+      default: false,
+    },
+  },
+  methods: {
+    ...common.methods,
+    addAttachmentToCard({
+      cardId, ...args
+    } = {}) {
+      return this.app.post({
+        path: `/cards/${cardId}/attachments`,
+        ...args,
+      });
+    },
+  },
+  async run({ $ }) {
+    const {
+      addAttachmentToCard,
+      cardId,
+      name,
+      url,
+      mimeType,
+      setCover,
+      file,
+    } = this;
+
+    let response;
+    const params = {
+      name,
+      mimeType,
+      setCover,
+    };
+
+    if (file && !file?.startsWith("/tmp")) {
+      throw new ConfigurationError("The file path must be in the `/tmp` directory");
+    }
+
+    if (file) {
+      const form = new FormData();
+      form.append("file", fs.createReadStream(file));
+
+      response = await addAttachmentToCard({
+        $,
+        cardId,
+        params,
+        headers: form.getHeaders(),
+        data: form,
+      });
+
+    } else {
+      response = await addAttachmentToCard({
+        $,
+        cardId,
+        params: {
+          ...params,
+          url,
+        },
+      });
+    }
+
+    $.export("$summary", `Successfully added attachement to card ${cardId}`);
+    return response;
+  },
+};

package/actions/add-checklist/add-checklist.mjs

@@ -1,68 +1,86 @@
-// legacy_hash_id: a_WYieM3
-import { axios } from "@pipedream/platform";
+import app from "../../trello.app.mjs";
 
 export default {
   key: "trello-add-checklist",
   name: "Create a Checklist",
-  description: "Adds a new checklist to a card.",
-  version: "0.1.3",
+  description: "Adds a new checklist to a card. [See the documentation](https://developer.atlassian.com/cloud/trello/rest/api-group-cards/#api-cards-id-checklists-post).",
+  version: "0.2.0",
   type: "action",
   props: {
-    trello: {
-      type: "app",
-      app: "trello",
+    app,
+    boardId: {
+      propDefinition: [
+        app,
+        "board",
+      ],
     },
-    id: {
+    cardId: {
       type: "string",
+      label: "Card ID",
       description: "The ID of the card.",
+      optional: false,
+      propDefinition: [
+        app,
+        "cards",
+        ({ boardId }) => ({
+          board: boardId,
+        }),
+      ],
     },
     name: {
       type: "string",
+      label: "Checklist Name",
       description: "The name of the checklist.",
       optional: true,
     },
     idChecklistSource: {
-      type: "string",
-      description: "The ID of a source checklist to copy into the new one.",
       optional: true,
+      propDefinition: [
+        app,
+        "checklist",
+        ({ boardId }) => ({
+          board: boardId,
+        }),
+      ],
     },
     pos: {
       type: "string",
+      label: "Position",
       description: "The position of the checklist on the card. One of: top, bottom, or a positive number.",
       optional: true,
     },
   },
+  methods: {
+    addChecklist({
+      cardId, ...args
+    } = {}) {
+      return this.app.post({
+        path: `/cards/${cardId}/checklists`,
+        ...args,
+      });
+    },
+  },
   async run({ $ }) {
-    const oauthSignerUri = this.trello.$auth.oauth_signer_uri;
-
-    let id = this.id;
-    const trelloParams = [
-      "name",
-      "idChecklistSource",
-      "pos",
-    ];
-    let p = this;
-
-    const queryString = trelloParams.filter((param) => p[param]).map((param) => `${param}=${p[param]}`)
-      .join("&");
-
-    const config = {
-      url: `https://api.trello.com/1/cards/${id}/checklists?${queryString}`,
-      method: "POST",
-      data: "",
-    };
+    const {
+      addChecklist,
+      cardId,
+      name,
+      idChecklistSource,
+      pos,
+    } = this;
 
-    const token = {
-      key: this.trello.$auth.oauth_access_token,
-      secret: this.trello.$auth.oauth_refresh_token,
-    };
+    const response = await addChecklist({
+      $,
+      cardId,
+      params: {
+        name,
+        idChecklistSource,
+        pos,
+      },
+    });
 
-    const signConfig = {
-      token,
-      oauthSignerUri,
-    };
+    $.export("$summary", "Successfully added checklist.");
 
-    const resp = await axios($, config, signConfig);
-    return resp;
+    return response;
   },
 };

package/actions/add-comment/add-comment.mjs

@@ -1,55 +1,65 @@
-// legacy_hash_id: a_Xzi26w
-import { axios } from "@pipedream/platform";
+import app from "../../trello.app.mjs";
 
 export default {
   key: "trello-add-comment",
   name: "Create a Comment",
-  description: "Create a new comment on a specific card.",
-  version: "0.1.3",
+  description: "Create a new comment on a specific card. [See the documentation](https://developer.atlassian.com/cloud/trello/rest/api-group-cards/#api-cards-id-actions-comments-post).",
+  version: "0.2.0",
   type: "action",
   props: {
-    trello: {
-      type: "app",
-      app: "trello",
+    app,
+    boardId: {
+      propDefinition: [
+        app,
+        "board",
+      ],
     },
-    id: {
+    cardId: {
       type: "string",
+      label: "Card ID",
       description: "The ID of the card.",
+      optional: false,
+      propDefinition: [
+        app,
+        "cards",
+        ({ boardId }) => ({
+          board: boardId,
+        }),
+      ],
     },
     text: {
       type: "string",
+      label: "Comment",
       description: "The comment to add.",
     },
   },
+  methods: {
+    addComment({
+      cardId, ...args
+    } = {}) {
+      return this.app.post({
+        path: `/cards/${cardId}/actions/comments`,
+        ...args,
+      });
+    },
+  },
   async run({ $ }) {
-    const oauthSignerUri = this.trello.$auth.oauth_signer_uri;
-
-    let id = this.id;
-    const trelloParams = [
-      "text",
-    ];
-    let p = this;
-
-    const queryString = trelloParams.filter((param) => p[param]).map((param) => `${param}=${p[param]}`)
-      .join("&");
-
-    const config = {
-      url: `https://api.trello.com/1/cards/${id}/actions/comments?${queryString}`,
-      method: "POST",
-      data: "",
-    };
+    const {
+      addComment,
+      cardId,
+      text,
+    } = this;
 
-    const token = {
-      key: this.trello.$auth.oauth_access_token,
-      secret: this.trello.$auth.oauth_refresh_token,
-    };
+    const response = await addComment({
+      $,
+      cardId,
+      params: {
+        text,
+      },
+    });
 
-    const signConfig = {
-      token,
-      oauthSignerUri,
-    };
+    $.export("$summary", "Successfully added comment.");
 
-    const resp = await axios($, config, signConfig);
-    return resp;
+    return response;
   },
 };

package/actions/add-existing-label-to-card/add-existing-label-to-card.mjs

@@ -4,20 +4,20 @@ export default {
   ...common,
   key: "trello-add-existing-label-to-card",
   name: "Add Existing Label to Card",
-  description: "Adds an existing label to the specified card. [See the docs here](https://developer.atlassian.com/cloud/trello/rest/api-group-cards/#api-cards-id-idlabels-post)",
-  version: "0.0.3",
+  description: "Adds an existing label to the specified card. [See the documentation](https://developer.atlassian.com/cloud/trello/rest/api-group-cards/#api-cards-id-idlabels-post).",
+  version: "0.1.0",
   type: "action",
   props: {
     ...common.props,
     board: {
       propDefinition: [
-        common.props.trello,
+        common.props.app,
         "board",
       ],
     },
-    idCard: {
+    cardId: {
       propDefinition: [
-        common.props.trello,
+        common.props.app,
         "cards",
         (c) => ({
           board: c.board,
@@ -28,9 +28,9 @@ export default {
       description: "The ID of the Card to add the Label to",
       optional: false,
     },
-    idLabel: {
+    value: {
       propDefinition: [
-        common.props.trello,
+        common.props.app,
         "label",
         (c) => ({
           board: c.board,
@@ -38,11 +38,26 @@ export default {
       ],
     },
   },
+  methods: {
+    ...common.methods,
+    addExistingLabelToCard({
+      cardId, ...args
+    } = {}) {
+      return this.app.post({
+        path: `/cards/${cardId}/idLabels`,
+        ...args,
+      });
+    },
+  },
   async run({ $ }) {
-    const res = await this.trello.addExistingLabelToCard(this.idCard, {
-      value: this.idLabel,
-    }, $);
-    $.export("$summary", `Successfully added label ${this.idLabel} to card ${this.idCard}`);
+    const res = await this.addExistingLabelToCard({
+      $,
+      cardId: this.cardId,
+      params: {
+        value: this.value,
+      },
+    });
+    $.export("$summary", `Successfully added label and returned \`${res.length}\` labels added.`);
     return res;
   },
 };

package/actions/add-member-to-card/add-member-to-card.mjs

@@ -4,20 +4,20 @@ export default {
   ...common,
   key: "trello-add-member-to-card",
   name: "Add Member to Card",
-  description: "Adds a member to the specified card. [See the docs here](https://developer.atlassian.com/cloud/trello/rest/api-group-cards/#api-cards-id-idmembers-post)",
-  version: "0.1.4",
+  description: "Adds a member to the specified card. [See the documentation](https://developer.atlassian.com/cloud/trello/rest/api-group-cards/#api-cards-id-idmembers-post).",
+  version: "0.2.0",
   type: "action",
   props: {
     ...common.props,
     board: {
       propDefinition: [
-        common.props.trello,
+        common.props.app,
         "board",
       ],
     },
-    idCard: {
+    cardId: {
       propDefinition: [
-        common.props.trello,
+        common.props.app,
         "cards",
         (c) => ({
           board: c.board,
@@ -28,9 +28,9 @@ export default {
       description: "The ID of the Card to add the Member to",
       optional: false,
     },
-    idMember: {
+    value: {
       propDefinition: [
-        common.props.trello,
+        common.props.app,
         "member",
         (c) => ({
           board: c.board,
@@ -38,11 +38,26 @@ export default {
       ],
     },
   },
+  methods: {
+    ...common.methods,
+    addMemberToCard({
+      cardId, ...args
+    } = {}) {
+      return this.app.post({
+        path: `/cards/${cardId}/idMembers`,
+        ...args,
+      });
+    },
+  },
   async run({ $ }) {
-    const res = await this.trello.addMemberToCard(this.idCard, {
-      value: this.idMember,
-    }, $);
-    $.export("$summary", `Successfully added member ${res[0].fullName} to card ${this.idCard}`);
+    const res = await this.addMemberToCard({
+      $,
+      cardId: this.cardId,
+      params: {
+        value: this.value,
+      },
+    });
+    $.export("$summary", `Successfully added member ${res[0].fullName} to card ${this.cardId}`);
     return res;
   },
 };

package/actions/archive-card/archive-card.mjs

@@ -4,20 +4,20 @@ export default {
   ...common,
   key: "trello-archive-card",
   name: "Archive Card",
-  description: "Archives a card. [See the docs here](https://developer.atlassian.com/cloud/trello/rest/api-group-cards/#api-cards-id-put)",
-  version: "0.1.4",
+  description: "Archives a card. [See the documentation](https://developer.atlassian.com/cloud/trello/rest/api-group-cards/#api-cards-id-put).",
+  version: "0.2.0",
   type: "action",
   props: {
     ...common.props,
     board: {
       propDefinition: [
-        common.props.trello,
+        common.props.app,
         "board",
       ],
     },
-    idCard: {
+    cardId: {
       propDefinition: [
-        common.props.trello,
+        common.props.app,
         "cards",
         (c) => ({
           board: c.board,
@@ -30,8 +30,14 @@ export default {
     },
   },
   async run({ $ }) {
-    const res = await this.trello.archiveCard(this.idCard, $);
-    $.export("$summary", `Successfully archived card ${this.idCard}`);
+    const res = await this.app.updateCard({
+      $,
+      cardId: this.cardId,
+      data: {
+        closed: true,
+      },
+    });
+    $.export("$summary", `Successfully archived card ${this.cardId}`);
     return res;
   },
 };

package/actions/close-board/close-board.mjs

@@ -4,21 +4,27 @@ export default {
   ...common,
   key: "trello-close-board",
   name: "Close Board",
-  description: "Closes a board. [See the docs here](https://developer.atlassian.com/cloud/trello/rest/api-group-boards/#api-boards-id-put)",
-  version: "0.0.3",
+  description: "Closes a board. [See the documentation](https://developer.atlassian.com/cloud/trello/rest/api-group-boards/#api-boards-id-put).",
+  version: "0.1.0",
   type: "action",
   props: {
     ...common.props,
     boardId: {
       propDefinition: [
-        common.props.trello,
+        common.props.app,
         "board",
       ],
       description: "The ID of the Board to close",
     },
   },
   async run({ $ }) {
-    const res = await this.trello.closeBoard(this.boardId, $);
+    const res = await this.app.updateBoard({
+      $,
+      boardId: this.boardId,
+      data: {
+        closed: true,
+      },
+    });
     $.export("$summary", `Successfully closed board ${this.boardId}`);
     return res;
   },

package/actions/common.mjs

@@ -1,8 +1,8 @@
-import trello from "../trello.app.mjs";
+import app from "../trello.app.mjs";
 
 export default {
   props: {
-    trello,
+    app,
   },
   methods: {
     /**