@pipedream/pandadoc 0.0.1 → 0.1.0

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

@@ -9,7 +9,7 @@ export default {
   name: "Create Document Attachment",
   description: "Adds an attachment to a document. [See the docs here](https://developers.pandadoc.com/reference/create-document-attachment)",
   type: "action",
-  version: "0.0.1",
+  version: "0.0.2",
   props: {
     app,
     documentId: {
@@ -19,9 +19,10 @@ export default {
       ],
     },
     file: {
-      type: "string",
-      label: "File",
-      description: "The file to upload to Box, please provide a file from `/tmp`. To upload a file to `/tmp` folder, please follow the doc [here](https://pipedream.com/docs/code/nodejs/working-with-files/#writing-a-file-to-tmp)",
+      propDefinition: [
+        app,
+        "file",
+      ],
     },
     fileName: {
       type: "string",
@@ -49,6 +50,22 @@ export default {
         size: stats.size,
       };
     },
+    getFormData(file, fileName) {
+      const fileValidation = this.isValidFile(file);
+      if (!fileValidation) {
+        throw new ConfigurationError("`file` must be a valid file path!");
+      }
+
+      const fileMeta = this.getFileMeta(fileValidation);
+      const fileContent = this.getFileStream(fileValidation);
+      const data = new FormData();
+      if (fileName) data.append("name", fileName);
+      data.append("file", fileContent, {
+        knownLength: fileMeta.size,
+      });
+
+      return data;
+    },
   },
   async run({ $ }) {
     const {
@@ -57,17 +74,7 @@ export default {
       fileName,
     } = this;
 
-    const fileValidation = this.isValidFile(file);
-    if (!fileValidation) {
-      throw new ConfigurationError("`file` must be a valid file path!");
-    }
-    const fileMeta = this.getFileMeta(fileValidation);
-    const fileContent = this.getFileStream(fileValidation);
-    const data = new FormData();
-    data.append("name", fileName);
-    data.append("file", fileContent, {
-      knownLength: fileMeta.size,
-    });
+    const data = this.getFormData(file, fileName);
 
     const response = await this.app.createDocumentAttachments({
       $,

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

@@ -0,0 +1,81 @@
+import { ConfigurationError } from "@pipedream/platform";
+import app from "../../pandadoc.app.mjs";
+import createDocumentAttachment from "../create-document-attachment/create-document-attachment.mjs";
+
+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)",
+  type: "action",
+  version: "0.0.1",
+  props: {
+    app,
+    name: {
+      propDefinition: [
+        app,
+        "name",
+      ],
+    },
+    recipients: {
+      propDefinition: [
+        app,
+        "recipients",
+      ],
+    },
+    file: {
+      propDefinition: [
+        app,
+        "file",
+      ],
+      optional: true,
+    },
+    fileUrl: {
+      type: "string",
+      label: "File URL",
+      description: "A public file URL to use instead of a local file.",
+      optional: true,
+    },
+  },
+  methods: createDocumentAttachment.methods,
+  async run({ $ }) {
+    const {
+      name,
+      recipients,
+      file,
+      fileUrl,
+    } = this;
+
+    let parsedRecipients;
+    try {
+      parsedRecipients = recipients.map((s) => JSON.parse(s));
+    } catch (err) {
+      throw new ConfigurationError("**Error parsing recipients** - each must be a valid JSON-stringified object");
+    }
+
+    let data, contentType, json = {
+      name,
+      recipients: parsedRecipients,
+    };
+
+    if (fileUrl) {
+      data = json;
+      contentType = "application/json";
+      data.url = fileUrl;
+    } else {
+      data = this.getFormData(file);
+      contentType = `multipart/form-data; boundary=${data._boundary}`;
+      data.append("data", JSON.stringify(json));
+    }
+
+    const response = await this.app.createDocument({
+      $,
+      data,
+      headers: {
+        "Content-Type": contentType,
+      },
+    });
+
+    $.export("$summary", `Successfully created document attachment with ID: ${response.uuid}`);
+    return response;
+  },
+};

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

@@ -5,13 +5,14 @@ export default {
   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)",
   type: "action",
-  version: "0.0.1",
+  version: "0.0.2",
   props: {
     app,
     name: {
-      type: "string",
-      label: "Document Name",
-      description: "Specify the document's name.",
+      propDefinition: [
+        app,
+        "name",
+      ],
     },
     templateId: {
       propDefinition: [
@@ -32,14 +33,10 @@ export default {
       optional: true,
     },
     recipients: {
-      type: "string[]",
-      label: "Recipients",
-      description: `The list of recipients you're sending the document to. Every object must contain the email parameter. 
-      The role, first_name and last_name parameters are optional. If the role parameter passed, a person is assigned all fields matching their corresponding role. 
-      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" }\``,
+      propDefinition: [
+        app,
+        "recipients",
+      ],
     },
     tokens: {
       type: "string[]",
@@ -74,7 +71,7 @@ export default {
       tokens,
     } = this;
 
-    const response = await this.app.createDocumentFromTemplate({
+    const response = await this.app.createDocument({
       $,
       data: {
         name,

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

@@ -0,0 +1,43 @@
+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)",
+  type: "action",
+  version: "0.0.1",
+  props: {
+    app,
+    name: {
+      type: "string",
+      label: "Name",
+      description: "Name the folder for Documents you are creating.",
+    },
+    parentFolderId: {
+      propDefinition: [
+        app,
+        "documentFolderId",
+      ],
+      label: "Parent Folder ID",
+      description: "The ID of a parent folder. If not set, the new folder will be created in the root folder.",
+      optional: true,
+    },
+  },
+  async run({ $ }) {
+    const {
+      name,
+      parentFolderId,
+    } = this;
+
+    const response = await this.app.createFolder({
+      $,
+      data: {
+        name,
+        parent_uuid: parentFolderId,
+      },
+    });
+
+    $.export("$summary", `Successfully created folder "${response.name ?? response.uuid}"`);
+    return response;
+  },
+};

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

@@ -5,7 +5,7 @@ export default {
   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)",
   type: "action",
-  version: "0.0.1",
+  version: "0.0.2",
   props: {
     app,
     email: {

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

@@ -5,7 +5,7 @@ export default {
   name: "Document Details",
   description: "Return detailed data about a document. [See the docs here](https://developers.pandadoc.com/reference/document-details)",
   type: "action",
-  version: "0.0.1",
+  version: "0.0.2",
   props: {
     app,
     id: {

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

@@ -5,7 +5,7 @@ export default {
   name: "List Contacts",
   description: "This method lists all contacts within an account. [See the docs here](https://developers.pandadoc.com/reference/list-contacts)",
   type: "action",
-  version: "0.0.1",
+  version: "0.0.2",
   props: {
     app,
   },

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

@@ -5,7 +5,7 @@ export default {
   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)",
   type: "action",
-  version: "0.0.1",
+  version: "0.0.2",
   props: {
     app,
     documentId: {

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

@@ -6,7 +6,7 @@ export default {
   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)",
   type: "action",
-  version: "0.0.1",
+  version: "0.0.2",
   props: {
     app,
     query: {

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

@@ -0,0 +1,34 @@
+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)",
+  type: "action",
+  version: "0.0.1",
+  props: {
+    app,
+    parentFolderId: {
+      propDefinition: [
+        app,
+        "documentFolderId",
+      ],
+      label: "Parent Folder ID",
+      description: "The ID of a parent folder whose folders to list. If not set, the root folder will be used.",
+      optional: true,
+    },
+  },
+  async run({ $ }) {
+    const { parentFolderId } = this;
+
+    const response = await this.app.listDocumentFolders({
+      $,
+      params: {
+        parent_uuid: parentFolderId,
+      },
+    });
+
+    $.export("$summary", `Successfully fetched ${response?.results?.length} folders`);
+    return response;
+  },
+};

package/package.json

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

package/pandadoc.app.mjs

@@ -58,6 +58,26 @@ 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)",
+    },
+    name: {
+      type: "string",
+      label: "Document Name",
+      description: "Specify the document's name.",
+    },
+    recipients: {
+      type: "string[]",
+      label: "Recipients",
+      description: `The list of recipients you're sending the document to. Every object must contain the email parameter. 
+      The role, first_name and last_name parameters are optional. If the role parameter passed, a person is assigned all fields matching their corresponding role. 
+      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" }\``,
+    },
   },
   methods: {
     getUrl(path) {
@@ -121,13 +141,20 @@ export default {
         ...args,
       });
     },
-    createDocumentFromTemplate(args = {}) {
+    createDocument(args = {}) {
       return this.makeRequest({
         path: "/documents",
         method: "POST",
         ...args,
       });
     },
+    createFolder(args = {}) {
+      return this.makeRequest({
+        path: "/documents/folders",
+        method: "POST",
+        ...args,
+      });
+    },
     createOrUpdateContact(args = {}) {
       return this.makeRequest({
         path: "/contacts",