@pipedream/pandadoc 0.2.5 → 0.3.0

package/README.md

@@ -1,22 +1,11 @@
 # Overview
 
-The PandaDoc API is a powerful tool that can be used to create and customize
-documents with ease. With the PandaDoc API, you can connect to the PandaDoc
-cloud Platform and create automated document workflows, streamline document
-creation and editing, and more.
+The PandaDoc API opens up a realm of possibilities for automating document workflows, creating a seamless bridge between document management and various business processes. With it, you can programmatically create, send, and track documents, streamline electronic signatures, and manage templates, among others. Integrations through Pipedream can harness these capabilities, enabling you to trigger actions in PandaDoc based on events from other apps, or vice versa.
 
-Using the PandaDoc API, you can:
+# Example Use Cases
 
-- Automate and streamline document creation and editing
-- Create custom document workflows
-- Securely store documents and access document data
-- Track document activity and analyze document data
-- Automate document approvals and sign-off
-- Integrate PandaDoc with third-party applications
-- Personalize documents with dynamic data fields
-- Generate intelligent document insights
-- View, sign, and approve documents online
-- Automatically store documents in cloud-based file storage
-- Automatically send documents directly to customers
-- Customize integration with your organization's branding
-- Create reports and dashboard to monitor document performance
+- **Sales Pipeline Automation**: When a new deal is marked as "won" in a CRM like Salesforce, trigger a PandaDoc workflow to automatically generate a contract from a template, fill it with the deal details, and send it out for e-signature.
+
+- **HR Onboarding Processes**: Sync PandaDoc with an HR platform like BambooHR. Once a new employee is added to the HR system, kick off a workflow that auto-populates and sends out onboarding paperwork through PandaDoc.
+
+- **Real-time Notifications**: Combine PandaDoc with a messaging platform like Slack. Set up a workflow that sends a message to a designated channel or direct message when a document is completed or a specific action is taken on a document in PandaDoc.

package/actions/create-document-attachment/create-document-attachment.mjs

@@ -7,9 +7,9 @@ import FormData from "form-data";
 export default {
   key: "pandadoc-create-document-attachment",
   name: "Create Document Attachment",
-  description: "Adds an attachment to a document. [See the docs here](https://developers.pandadoc.com/reference/create-document-attachment)",
+  description: "Adds an attachment to a document. [See the documentation here](https://developers.pandadoc.com/reference/create-document-attachment)",
   type: "action",
-  version: "0.0.5",
+  version: "0.0.7",
   props: {
     app,
     documentId: {

package/actions/create-document-from-file/create-document-from-file.mjs

@@ -5,9 +5,9 @@ import createDocumentAttachment from "../create-document-attachment/create-docum
 export default {
   key: "pandadoc-create-document-from-file",
   name: "Create Document From File",
-  description: "Create a document from a file or public file URL. [See the docs here](https://developers.pandadoc.com/reference/create-document-from-pdf)",
+  description: "Create a document from a file or public file URL. [See the documentation here](https://developers.pandadoc.com/reference/create-document-from-pdf)",
   type: "action",
-  version: "0.0.6",
+  version: "0.0.8",
   props: {
     app,
     name: {
@@ -41,6 +41,13 @@ export default {
         "documentFolderId",
       ],
     },
+    fields: {
+      type: "string",
+      label: "Fields",
+      description: `A \`fields\` object containing fields to add to the document. [See the documentation](https://developers.pandadoc.com/reference/create-document-from-pdf) for more information about fields.
+      \nE.g. \`{ "name": { "value": "Jane", "role": "user" }, "like": { "value": true, "role": "user" } }\``,
+      optional: true,
+    },
   },
   methods: createDocumentAttachment.methods,
   async run({ $ }) {
@@ -64,6 +71,12 @@ export default {
       recipients: parsedRecipients,
       folder_uuid: documentFolderId,
     };
+    if (this.fields) {
+      json.parse_form_fields = true;
+      json.fields = typeof this.fields === "string"
+        ? JSON.parse(this.fields)
+        : this.fields;
+    }
 
     if (fileUrl) {
       data = json;
@@ -83,7 +96,7 @@ export default {
       },
     });
 
-    $.export("$summary", `Successfully created document attachment with ID: ${response.uuid}`);
+    $.export("$summary", `Successfully created document with ID: ${response.uuid}`);
     return response;
   },
 };

package/actions/create-document-from-template/create-document-from-template.mjs

@@ -3,9 +3,9 @@ import app from "../../pandadoc.app.mjs";
 export default {
   key: "pandadoc-create-document-from-template",
   name: "Create Document From Template",
-  description: "Create Document from PandaDoc Template. [See the docs here](https://developers.pandadoc.com/reference/create-document-from-pandadoc-template)",
+  description: "Create a Document from a PandaDoc Template. [See the documentation here](https://developers.pandadoc.com/reference/create-document-from-pandadoc-template)",
   type: "action",
-  version: "0.0.5",
+  version: "0.0.7",
   props: {
     app,
     name: {
@@ -19,6 +19,8 @@ export default {
         app,
         "templateId",
       ],
+      reloadProps: true,
+      description: "The ID of a template you want to use. Note: if you want to **prefill fields in your template**, you need to map your template fields to the API fields following [the instruction here](https://developers.pandadoc.com/reference/create-document-from-pandadoc-template#prefilled-fields)",
     },
     documentFolderId: {
       propDefinition: [
@@ -48,6 +50,23 @@ export default {
       optional: true,
     },
   },
+  async additionalProps() {
+    const props = {};
+    const { fields } = await this.app.getTemplate({
+      templateId: this.templateId,
+    });
+    for (const field of fields) {
+      if (!field.merge_field) {
+        continue;
+      }
+      props[field.merge_field] = {
+        type: "string",
+        label: `Field ${field.merge_field}`,
+        optional: true,
+      };
+    }
+    return props;
+  },
   methods: {
     parseToAnyArray(arr) {
       if (!arr) {
@@ -71,6 +90,19 @@ export default {
       tokens,
     } = this;
 
+    const fields = {};
+    const { fields: items } = await this.app.getTemplate({
+      templateId: this.templateId,
+    });
+    for (const field of items) {
+      if (!field.merge_field) {
+        continue;
+      }
+      fields[field.merge_field] = {
+        value: this[field.merge_field],
+      };
+    }
+
     const response = await this.app.createDocument({
       $,
       data: {
@@ -80,6 +112,7 @@ export default {
         tags,
         recipients: this.parseToAnyArray(recipients),
         tokens: this.parseToAnyArray(tokens),
+        fields,
       },
     });
 

package/actions/create-folder/create-folder.mjs

@@ -3,9 +3,9 @@ import app from "../../pandadoc.app.mjs";
 export default {
   key: "pandadoc-create-folder",
   name: "Create Folder",
-  description: "Create a new folder to store your documents. [See the docs here](https://developers.pandadoc.com/reference/create-documents-folder)",
+  description: "Create a new folder to store your documents. [See the documentation here](https://developers.pandadoc.com/reference/create-documents-folder)",
   type: "action",
-  version: "0.0.4",
+  version: "0.0.6",
   props: {
     app,
     name: {

package/actions/create-or-update-contact/create-or-update-contact.mjs

@@ -3,9 +3,9 @@ import app from "../../pandadoc.app.mjs";
 export default {
   key: "pandadoc-create-or-update-contact",
   name: "Create or Update Contact",
-  description: "This method adds or updates a contact using the email as index. [See the docs here](https://developers.pandadoc.com/reference/create-contact)",
+  description: "This method adds or updates a contact using the email as index. [See the documentation here](https://developers.pandadoc.com/reference/create-contact)",
   type: "action",
-  version: "0.0.5",
+  version: "0.0.7",
   props: {
     app,
     email: {

package/actions/document-details/document-details.mjs

@@ -2,10 +2,10 @@ import app from "../../pandadoc.app.mjs";
 
 export default {
   key: "pandadoc-document-details",
-  name: "Document Details",
-  description: "Return detailed data about a document. [See the docs here](https://developers.pandadoc.com/reference/document-details)",
+  name: "Get Document Details",
+  description: "Return detailed data about a document. [See the documentation here](https://developers.pandadoc.com/reference/document-details)",
   type: "action",
-  version: "0.0.5",
+  version: "0.0.7",
   props: {
     app,
     id: {

package/actions/download-document/download-document.mjs

@@ -0,0 +1,92 @@
+import app from "../../pandadoc.app.mjs";
+import fs from "fs";
+
+export default {
+  key: "pandadoc-download-document",
+  name: "Download Document",
+  description:
+    "Download a document as PDF. [See documentation here](https://developers.pandadoc.com/reference/download-document)",
+  type: "action",
+  version: "0.0.1",
+  props: {
+    app,
+    id: {
+      propDefinition: [
+        app,
+        "documentId",
+      ],
+    },
+    outputFilename: {
+      propDefinition: [
+        app,
+        "outputFilename",
+      ],
+    },
+    showWatermark: {
+      type: "boolean",
+      label: "Apply Watermark",
+      description: "Set to true to show available watermark props",
+      reloadProps: true,
+    },
+    separateFiles: {
+      propDefinition: [
+        app,
+        "separateFiles",
+      ],
+    },
+  },
+  additionalProps() {
+    return this.showWatermark
+      ? {
+        watermarkText: {
+          type: "string",
+          label: "Watermark Text",
+          description: "Specify watermark text",
+          optional: true,
+        },
+        watermarkColor: {
+          type: "string",
+          label: "Watermark Color",
+          description: "Should be a HEX code `#RRGGBB`",
+          optional: true,
+        },
+        watermarkFontSize: {
+          type: "integer",
+          label: "Watermark Font Size",
+          description: "Font size of the watermark - positive integer",
+          optional: true,
+        },
+        watermarkOpacity: {
+          type: "string",
+          label: "Watermark Opacity",
+          description: "Should be in range 0.0 - 1.0",
+          optional: true,
+        },
+      }
+      : {};
+  },
+  async run({ $ }) {
+    const {
+      outputFilename, id,
+    } = this;
+    const data = await this.app.downloadDocument({
+      $,
+      id,
+      params: {
+        separate_files: this.separateFiles,
+        watermark_text: this.watermarkText,
+        watermark_color: this.watermarkColor,
+        watermark_font_size: this.watermarkFontSize,
+        watermark_opacity: this.watermarkOpacity,
+      },
+    });
+
+    const filePath = `/tmp/${outputFilename}`;
+    fs.writeFileSync(filePath, data);
+    $.export("$summary", `Successfully downloaded document "${outputFilename}"`);
+
+    return {
+      filePath,
+    };
+  },
+};

package/actions/download-protected-document/download-protected-document.mjs

@@ -0,0 +1,52 @@
+import app from "../../pandadoc.app.mjs";
+import fs from "fs";
+
+export default {
+  key: "pandadoc-download-protected-document",
+  name: "Download Protected Document",
+  description:
+    "Download a completed document as a verifiable PDF. [See documentation here](https://developers.pandadoc.com/reference/download-protected-document)",
+  type: "action",
+  version: "0.0.1",
+  props: {
+    app,
+    id: {
+      propDefinition: [
+        app,
+        "completedDocumentId",
+      ],
+    },
+    outputFilename: {
+      propDefinition: [
+        app,
+        "outputFilename",
+      ],
+    },
+    separateFiles: {
+      propDefinition: [
+        app,
+        "separateFiles",
+      ],
+    },
+  },
+  async run({ $ }) {
+    const {
+      outputFilename, id,
+    } = this;
+    const data = await this.app.downloadProtectedDocument({
+      $,
+      id,
+      params: {
+        separate_files: this.separateFiles,
+      },
+    });
+
+    const filePath = `/tmp/${outputFilename}`;
+    fs.writeFileSync(filePath, data);
+    $.export("$summary", `Successfully downloaded protected document "${outputFilename}"`);
+
+    return {
+      filePath,
+    };
+  },
+};

package/actions/get-document-status/get-document-status.mjs

@@ -6,16 +6,19 @@ export default {
   description:
     "Get basic status info about a document. [See documentation here](https://developers.pandadoc.com/reference/document-status)",
   type: "action",
-  version: "0.0.1",
+  version: "0.0.3",
   props: {
     app,
     id: {
-      propDefinition: [app, "documentId"],
+      propDefinition: [
+        app,
+        "documentId",
+      ],
     },
   },
   async run({ $ }) {
     const response = await this.app.getDocument({
-      id: this.id
+      id: this.id,
     });
 
     $.export("$summary", `Successfully fetched document status with ID ${this.id}`);

package/actions/list-contacts/list-contacts.mjs

@@ -3,9 +3,9 @@ import app from "../../pandadoc.app.mjs";
 export default {
   key: "pandadoc-list-contacts",
   name: "List Contacts",
-  description: "This method lists all contacts within an account. [See the docs here](https://developers.pandadoc.com/reference/list-contacts)",
+  description: "List all contacts within an account. [See the documentation here](https://developers.pandadoc.com/reference/list-contacts)",
   type: "action",
-  version: "0.0.5",
+  version: "0.0.7",
   props: {
     app,
   },

package/actions/list-document-attachments/list-document-attachments.mjs

@@ -2,10 +2,10 @@ import app from "../../pandadoc.app.mjs";
 
 export default {
   key: "pandadoc-list-document-attachments",
-  name: "List Document Attachment",
-  description: "Returns a list of attachments associated with a specified document. [See the docs here](https://developers.pandadoc.com/reference/list-attachment)",
+  name: "List Document Attachments",
+  description: "Returns a list of attachments associated with a specified document. [See the documentation here](https://developers.pandadoc.com/reference/list-attachment)",
   type: "action",
-  version: "0.0.5",
+  version: "0.0.7",
   props: {
     app,
     documentId: {

package/actions/list-documents/list-documents.mjs

@@ -4,9 +4,9 @@ import constants from "../common/constants.mjs";
 export default {
   key: "pandadoc-list-documents",
   name: "List Documents",
-  description: "List documents optionally filter by a search query or tags. [See the docs here](https://developers.pandadoc.com/reference/list-documents)",
+  description: "List documents, optionally filtering by a search query or tags. [See the documentation here](https://developers.pandadoc.com/reference/list-documents)",
   type: "action",
-  version: "0.0.5",
+  version: "0.0.7",
   props: {
     app,
     query: {

package/actions/list-folders/list-folders.mjs

@@ -3,9 +3,9 @@ import app from "../../pandadoc.app.mjs";
 export default {
   key: "pandadoc-list-folders",
   name: "List Folders",
-  description: "List folders which contain Documents [See the docs here](https://developers.pandadoc.com/reference/list-documents-folders)",
+  description: "List folders which contain Documents. [See the documentation here](https://developers.pandadoc.com/reference/list-documents-folders)",
   type: "action",
-  version: "0.0.4",
+  version: "0.0.6",
   props: {
     app,
     parentFolderId: {

package/actions/send-document/send-document.mjs

@@ -5,7 +5,7 @@ export default {
   name: "Send Document",
   description: "Move a document to sent status and send an optional email. [See the documentation](https://developers.pandadoc.com/reference/send-document)",
   type: "action",
-  version: "0.0.5",
+  version: "0.0.7",
   props: {
     app,
     documentId: {

package/common/constants.mjs

@@ -0,0 +1 @@
+export const DOCUMENT_STATUS_COMPLETED = 2;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pipedream/pandadoc",
-  "version": "0.2.5",
+  "version": "0.3.0",
   "description": "Pipedream PandaDoc Components",
   "main": "pandadoc.app.mjs",
   "keywords": [
@@ -14,7 +14,7 @@
     "access": "public"
   },
   "dependencies": {
-    "@pipedream/platform": "^1.4.1",
+    "@pipedream/platform": "^1.6.0",
     "form-data": "^4.0.0"
   }
 }

package/pandadoc.app.mjs

@@ -1,4 +1,5 @@
 import { axios } from "@pipedream/platform";
+import { DOCUMENT_STATUS_COMPLETED } from "./common/constants.mjs";
 
 export default {
   type: "app",
@@ -8,10 +9,32 @@ export default {
       type: "string",
       label: "Document Id",
       description: "Specify document's ID",
-      async options() {
+      async options({ page }) {
         const response = await this.listDocuments({
           params: {
             deleted: false,
+            page: page || undefined,
+          },
+        });
+        return response?.results?.map(({
+          id,
+          name,
+        }) => ({
+          label: name,
+          value: id,
+        })) || [];
+      },
+    },
+    completedDocumentId: {
+      type: "string",
+      label: "Completed Document Id",
+      description: "Select a completed document or provide its ID",
+      async options({ page }) {
+        const response = await this.listDocuments({
+          params: {
+            deleted: false,
+            status: DOCUMENT_STATUS_COMPLETED,
+            page: page || undefined,
           },
         });
         return response?.results?.map(({
@@ -27,10 +50,11 @@ export default {
       type: "string",
       label: "Template Id",
       description: "Specify template's ID",
-      async options() {
+      async options({ page }) {
         const response = await this.listTemplates({
           params: {
             deleted: false,
+            page: page || undefined,
           },
         });
         return response?.results?.map(({
@@ -47,8 +71,12 @@ export default {
       label: "Document Folder Id",
       description: "Specify the document folder ID",
       optional: true,
-      async options() {
-        const response = await this.listDocumentFolders();
+      async options({ page }) {
+        const response = await this.listDocumentFolders({
+          params: {
+            page: page || undefined,
+          },
+        });
         return response?.results?.map(({
           uuid,
           name,
@@ -61,7 +89,7 @@ export default {
     file: {
       type: "string",
       label: "File",
-      description: "The file to upload from the `/tmp` folder. [See the docs here] on how to upload a file to `/tmp`.(https://pipedream.com/docs/code/nodejs/working-with-files/#writing-a-file-to-tmp)",
+      description: "The file to upload from the `/tmp` folder. [See the docs here](https://pipedream.com/docs/code/nodejs/working-with-files/#writing-a-file-to-tmp) on how to upload a file to `/tmp`.",
     },
     name: {
       type: "string",
@@ -76,7 +104,18 @@ export default {
       If not passed, a person will receive a read-only link to view the document. 
       If the first_name and last_name not passed the system: 1. creates a new contact, 
       if none exists with the given email; or 2. gets the existing contact with the given email that already exists.
-      \n\nE.g. \`{ "email": "john.doe@pipedream.com", "first_name": "John", "last_name": "Doe" }\``,
+      \n\nE.g. \`{ "email": "john.doe@pipedream.com", "first_name": "John", "last_name": "Doe", "role": "user" }\``,
+    },
+    separateFiles: {
+      type: "boolean",
+      label: "Separate Files",
+      description: "Download document bundle as a zip-archive of separate PDFs (1 file per section)",
+      optional: true,
+    },
+    outputFilename: {
+      type: "string",
+      label: "Output Filename",
+      description: "The filename of the downloaded file in the `tmp` folder.",
     },
   },
   methods: {
@@ -104,6 +143,14 @@ export default {
       };
       return axios($, config);
     },
+    getTemplate({
+      templateId, ...args
+    }) {
+      return this.makeRequest({
+        path: `/templates/${templateId}/details`,
+        ...args,
+      });
+    },
     listTemplates(args = {}) {
       return this.makeRequest({
         path: "/templates",
@@ -188,11 +235,31 @@ export default {
         ...args,
       });
     },
-    getDocument({ id, ...args }) {
+    getDocument({
+      id, ...args
+    }) {
       return this.makeRequest({
         path: `/documents/${id}`,
         ...args,
       });
     },
+    downloadDocument({
+      id, ...args
+    }) {
+      return this.makeRequest({
+        path: `/documents/${id}/download`,
+        responseType: "arraybuffer",
+        ...args,
+      });
+    },
+    downloadProtectedDocument({
+      id, ...args
+    }) {
+      return this.makeRequest({
+        path: `/documents/${id}/download-protected`,
+        responseType: "arraybuffer",
+        ...args,
+      });
+    },
   },
 };

package/sources/document-creation-failed/document-creation-failed.mjs

@@ -6,9 +6,9 @@ export default {
   ...common,
   name: "Document Creation Failed (Instant)",
   description:
-    `Emit new event when a document failed to be created [See docs here](${DOCS_LINK})`,
+    `Emit new event when a document failed to be created. [See the documentation here](${DOCS_LINK})`,
   key: "pandadoc-document-creation-failed",
-  version: "0.0.3",
+  version: "0.0.5",
   type: "source",
   methods: {
     ...common.methods,

package/sources/document-deleted/document-deleted.mjs

@@ -6,9 +6,9 @@ export default {
   ...common,
   name: "Document Deleted (Instant)",
   description:
-    `Emit new event when a document is deleted [See docs here](${DOCS_LINK})`,
+    `Emit new event when a document is deleted. [See the documentation here](${DOCS_LINK})`,
   key: "pandadoc-document-deleted",
-  version: "0.0.3",
+  version: "0.0.5",
   type: "source",
   methods: {
     ...common.methods,

package/sources/document-state-changed/document-state-changed.mjs

@@ -6,9 +6,9 @@ export default {
   ...common,
   name: "Document State Changed (Instant)",
   description:
-    `Emit new event when a document's state is changed [See docs here](${DOCS_LINK})`,
+    `Emit new event when a document's state is changed. [See the documentation here](${DOCS_LINK})`,
   key: "pandadoc-document-state-changed",
-  version: "0.0.3",
+  version: "0.0.5",
   type: "source",
   methods: {
     ...common.methods,

package/sources/document-updated/document-updated.mjs

@@ -6,9 +6,9 @@ export default {
   ...common,
   name: "Document Updated (Instant)",
   description:
-    `Emit new event when a document is updated [See docs here](${DOCS_LINK})`,
+    `Emit new event when a document is updated. [See the documentation here](${DOCS_LINK})`,
   key: "pandadoc-document-updated",
-  version: "0.0.3",
+  version: "0.0.5",
   type: "source",
   methods: {
     ...common.methods,

package/sources/recipient-completed/recipient-completed.mjs

@@ -6,9 +6,9 @@ export default {
   ...common,
   name: "Recipient Completed (Instant)",
   description:
-    `Emit new event when a recipient completes a document [See docs here](${DOCS_LINK})`,
+    `Emit new event when a recipient completes a document. [See the documentation here](${DOCS_LINK})`,
   key: "pandadoc-recipient-completed",
-  version: "0.0.3",
+  version: "0.0.5",
   type: "source",
   methods: {
     ...common.methods,