@pipedream/pandadoc 0.2.4 → 0.2.6

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.5",
+  version: "0.0.6",
   props: {
     app,
     documentId: {

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

@@ -7,7 +7,7 @@ export default {
   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.6",
+  version: "0.0.7",
   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

@@ -5,7 +5,7 @@ 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.5",
+  version: "0.0.6",
   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

@@ -5,7 +5,7 @@ export default {
   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.4",
+  version: "0.0.5",
   props: {
     app,
     name: {

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.5",
+  version: "0.0.6",
   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.5",
+  version: "0.0.6",
   props: {
     app,
     id: {

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.2",
   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

@@ -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.5",
+  version: "0.0.6",
   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.5",
+  version: "0.0.6",
   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.5",
+  version: "0.0.6",
   props: {
     app,
     query: {

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

@@ -5,7 +5,7 @@ export default {
   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.4",
+  version: "0.0.5",
   props: {
     app,
     parentFolderId: {

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

@@ -1,11 +1,11 @@
 import app from "../../pandadoc.app.mjs";
 
-export default defineComponent({
+export default {
   key: "pandadoc-send-document",
   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.4",
+  version: "0.0.6",
   props: {
     app,
     documentId: {
@@ -31,7 +31,7 @@ export default defineComponent({
       type: "boolean",
       label: "Silent",
       description:
-        `Disables sent, viewed, comment and completed email notifications for document recipients and the document sender. By default, notifications emails are sent for specific actions. If set as true, it won't affect "Approve document" email notification sent to the Approver.`,
+        "Disables sent, viewed, comment and completed email notifications for document recipients and the document sender. By default, notifications emails are sent for specific actions. If set as true, it won't affect \"Approve document\" email notification sent to the Approver.",
       optional: true,
       default: false,
     },
@@ -75,7 +75,7 @@ export default defineComponent({
           break;
         }
         console.log(
-          `Document status is '${documentStatus}' and not 'document.draft'. Waiting 1s and trying again...`
+          `Document status is '${documentStatus}' and not 'document.draft'. Waiting 1s and trying again...`,
         );
         await new Promise((resolve) => setTimeout(resolve, 1000)); // Wait for 1 second
         retryCount++;
@@ -114,8 +114,8 @@ export default defineComponent({
 
     $.export(
       "$summary",
-      `Successfully sent "${response.name}" document with ID: ${response.id} to ${response.recipients.length} recipient(s)`
+      `Successfully sent "${response.name}" document with ID: ${response.id} to ${response.recipients.length} recipient(s)`,
     );
     return response;
   },
-});
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pipedream/pandadoc",
-  "version": "0.2.4",
+  "version": "0.2.6",
   "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

@@ -61,7 +61,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 +76,7 @@ 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" }\``,
     },
   },
   methods: {
@@ -104,6 +104,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,7 +196,9 @@ export default {
         ...args,
       });
     },
-    getDocument({ id, ...args }) {
+    getDocument({
+      id, ...args
+    }) {
       return this.makeRequest({
         path: `/documents/${id}`,
         ...args,

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

@@ -8,7 +8,7 @@ export default {
   description:
     `Emit new event when a document failed to be created [See docs here](${DOCS_LINK})`,
   key: "pandadoc-document-creation-failed",
-  version: "0.0.3",
+  version: "0.0.4",
   type: "source",
   methods: {
     ...common.methods,

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

@@ -8,7 +8,7 @@ export default {
   description:
     `Emit new event when a document is deleted [See docs here](${DOCS_LINK})`,
   key: "pandadoc-document-deleted",
-  version: "0.0.3",
+  version: "0.0.4",
   type: "source",
   methods: {
     ...common.methods,

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

@@ -8,7 +8,7 @@ export default {
   description:
     `Emit new event when a document's state is changed [See docs here](${DOCS_LINK})`,
   key: "pandadoc-document-state-changed",
-  version: "0.0.3",
+  version: "0.0.4",
   type: "source",
   methods: {
     ...common.methods,

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

@@ -8,7 +8,7 @@ export default {
   description:
     `Emit new event when a document is updated [See docs here](${DOCS_LINK})`,
   key: "pandadoc-document-updated",
-  version: "0.0.3",
+  version: "0.0.4",
   type: "source",
   methods: {
     ...common.methods,

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

@@ -8,7 +8,7 @@ export default {
   description:
     `Emit new event when a recipient completes a document [See docs here](${DOCS_LINK})`,
   key: "pandadoc-recipient-completed",
-  version: "0.0.3",
+  version: "0.0.4",
   type: "source",
   methods: {
     ...common.methods,