@pipedream/pandadoc 0.0.1

package/LICENSE

@@ -0,0 +1,41 @@
+Pipedream Source Available License Version 1.0
+ 
+This Pipedream Source Available License Agreement Version 1.0 (this “Agreement”) sets forth the terms on which Pipedream, Inc., a Delaware corporation (“Pipedream”) makes available certain software (the “Software”). By installing, downloading, accessing, using or distributing the Software, you agree to the terms of this Agreement. If you do not agree to such terms, you must not use the Software. If you are receiving the Software on behalf of a legal entity, you represent and warrant that you have the actual authority to agree to the terms and conditions of this Agreement on behalf of such entity. “Licensee” means you, an individual, or the entity on whose behalf you are receiving the Software.
+ 
+LICENSE GRANT AND CONDITIONS.
+ 
+1.1  License. Subject to the terms and conditions of this Agreement, Pipedream hereby grants to Licensee a non-exclusive, royalty-free, worldwide, non-transferable, non-sublicenseable license during the term of this Agreement to use, prepare modifications and derivative works, distribute (including without limitation in source code or object code form) and reproduce copies of the Software (the “License”). Licensee is not granted the right to, and Licensee shall not, exercise the License for an Excluded Purpose. For purposes of this Agreement, “Excluded Purpose” means any commercial use of the software including, but not limited to, making available any software-as-a-service, platform-as-a-service, infrastructure-as-a-service or other online service that competes with the Software or any other Pipedream products or services.
+ 
+1.2  Conditions. In consideration of the License, Licensee’s distribution of the Software is subject to the following conditions:
+ 
+a. Licensee must cause any Software modified by Licensee to carry prominent notices stating that Licensee modified the Software.
+ 
+b. On each Software copy, Licensee shall reproduce and not remove or alter all Pipedream or third party copyright or other proprietary notices contained in the Software, and Licensee must provide this with each copy: “This software is made available by Pipedream, Inc., under the terms of the Pipedream Source Available License, Version 1.0 located at https://github.com/PipedreamHQ/pipedream/blob/master/LICENSE. By installing, downloading, accessing, using or distributing the Software, you agree to the terms of such License Agreement.”
+ 
+1.3  Modifications. Licensee may add its own copyright notices to modifications made by Licensee and may provide additional or different license terms and conditions for use, reproduction, or distribution of Licensee’s modifications. While redistributing the Software or modifications thereof, Licensee may choose to offer, for a fee or free of charge, support, warranty, indemnity, or other obligations. Licensee, and not Pipedream, will be responsible for any such obligations.
+ 
+1.4  No Sublicensing. The License does not include the right to sublicense the Software; provided, however, that any recipient to which Licensee provides the Software may exercise the License so long as such recipient agrees to the terms and conditions of this Agreement.
+ 
+TERM AND TERMINATION.
+ 
+This Agreement will continue unless and until earlier terminated as set forth herein. If Licensee breaches any of its conditions or obligations under this Agreement, this Agreement will terminate automatically and the License will terminate automatically and permanently.
+ 
+INTELLECTUAL PROPERTY.
+ 
+As between the parties, Pipedream retains all right, title, and interest in the Software, and all intellectual property rights therein. Pipedream hereby reserves all rights not expressly granted to Licensee in this Agreement. Pipedream reserves all rights in its trademarks and service marks, and no licenses thereto are granted by this Agreement.
+ 
+DISCLAIMER.
+ 
+PIPEDREAM HEREBY DISCLAIMS ANY AND ALL WARRANTIES AND CONDITIONS, EXPRESS, IMPLIED, STATUTORY, OR OTHERWISE, AND SPECIFICALLY DISCLAIMS ANY WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE, WITH RESPECT TO THE SOFTWARE.
+ 
+LIMITATION OF LIABILITY.
+ 
+PIPEDREAM WILL NOT BE LIABLE FOR ANY DAMAGES OF ANY KIND, INCLUDING BUT NOT LIMITED TO, LOST PROFITS OR ANY CONSEQUENTIAL, SPECIAL, INCIDENTAL, INDIRECT, OR DIRECT DAMAGES, HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, ARISING OUT OF THIS AGREEMENT. THE FOREGOING SHALL APPLY TO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE LAW.
+ 
+GENERAL.
+ 
+6.1  Governing Law. This Agreement will be governed by and interpreted in accordance with the laws of the state of California, without reference to its conflict of laws principles. If Licensee is located outside of the United States, any dispute, controversy or claim arising out of or relating to this Agreement will be referred to and finally determined by arbitration in accordance with the JAMS International Arbitration Rules. The tribunal will consist of one arbitrator. Judgment upon the award rendered by the arbitrator may be entered in any court having jurisdiction thereof. All disputes including arbitrations shall take place in Santa Clara County, California. The language to be used in any such proceedings shall be English.
+ 
+6.2.  Assignment. Licensee is not authorized to assign its rights under this Agreement to any third party. Pipedream may freely assign its rights under this Agreement to any third party.
+ 
+6.3.  Other. This Agreement is the entire agreement between the parties regarding the subject matter hereof. No amendment or modification of this Agreement will be valid or binding upon the parties unless made in writing and signed by the duly authorized representatives of both parties. In the event that any provision, including without limitation any condition, of this Agreement is held to be unenforceable, this Agreement and all licenses and rights granted hereunder will immediately terminate. Waiver by Pipedream of a breach of any provision of this Agreement or the failure by Pipedream to exercise any right hereunder will not be construed as a waiver of any subsequent breach of that right or as a waiver of any other right.

package/README.md

@@ -0,0 +1,22 @@
+# 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.
+
+Using the PandaDoc API, you can:
+
+- 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

package/actions/common/constants.mjs

@@ -0,0 +1,52 @@
+export default {
+  DOCUMENTS_STATUS_OPTS: [
+    {
+      value: "0",
+      label: "document.draft",
+    },
+    {
+      value: "1",
+      label: "document.sent",
+    },
+    {
+      value: "2",
+      label: "document.completed",
+    },
+    {
+      value: "5",
+      label: "document.viewed",
+    },
+    {
+      value: "6",
+      label: "document.waiting_approval",
+    },
+    {
+      value: "7",
+      label: "document.approved",
+    },
+    {
+      value: "8",
+      label: "document.rejected",
+    },
+    {
+      value: "9",
+      label: "document.waiting_pay",
+    },
+    {
+      value: "10",
+      label: "document.paid",
+    },
+    {
+      value: "11",
+      label: "document.voided",
+    },
+    {
+      value: "12",
+      label: "document.declined",
+    },
+    {
+      value: "13",
+      label: "document.external_review",
+    },
+  ],
+};

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

@@ -0,0 +1,84 @@
+import app from "../../pandadoc.app.mjs";
+import { ConfigurationError } from "@pipedream/platform";
+import fs from "fs";
+import path from "path";
+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)",
+  type: "action",
+  version: "0.0.1",
+  props: {
+    app,
+    documentId: {
+      propDefinition: [
+        app,
+        "documentId",
+      ],
+    },
+    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)",
+    },
+    fileName: {
+      type: "string",
+      label: "File Name",
+      description: "A name you want to set for a file in the system",
+    },
+  },
+  methods: {
+    isValidFile(filePath) {
+      const filePathWithTmp = `/tmp/${filePath}`;
+      if (fs.existsSync(filePathWithTmp)) {
+        return filePathWithTmp;
+      } else if (fs.existsSync(filePath)) {
+        return filePath;
+      }
+      return false;
+    },
+    getFileStream(filePath) {
+      return fs.createReadStream(filePath);
+    },
+    getFileMeta(filePath) {
+      const stats = fs.statSync(filePath);
+      return {
+        name: path.basename(filePath),
+        size: stats.size,
+      };
+    },
+  },
+  async run({ $ }) {
+    const {
+      documentId,
+      file,
+      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 response = await this.app.createDocumentAttachments({
+      $,
+      documentId,
+      data,
+      headers: {
+        "Content-Type": `multipart/form-data; boundary=${data._boundary}`,
+      },
+    });
+
+    $.export("$summary", `Successfully created document attachment with ID: ${response.uuid}`);
+    return response;
+  },
+};

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

@@ -0,0 +1,92 @@
+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)",
+  type: "action",
+  version: "0.0.1",
+  props: {
+    app,
+    name: {
+      type: "string",
+      label: "Document Name",
+      description: "Specify the document's name.",
+    },
+    templateId: {
+      propDefinition: [
+        app,
+        "templateId",
+      ],
+    },
+    documentFolderId: {
+      propDefinition: [
+        app,
+        "documentFolderId",
+      ],
+    },
+    tags: {
+      type: "string[]",
+      label: "Tags",
+      description: "Mark your document with one or several tags.",
+      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" }\``,
+    },
+    tokens: {
+      type: "string[]",
+      label: "Tokens",
+      description: `You may pass a list of tokens/values to pre-fill tokens (variables) used in a template. 
+      Name is a token (variable) name in a template. 
+      Value is a real value you would like to replace a token (variable) with.
+      \n\nE.g. \`{ "name": "Favorite.Pet", "value": "Dog Doe" }\``,
+      optional: true,
+    },
+  },
+  methods: {
+    parseToAnyArray(arr) {
+      if (!arr) {
+        return undefined;
+      }
+      return arr.map((item) => {
+        if (typeof (item) === "string") {
+          return JSON.parse(item);
+        }
+        return item;
+      });
+    },
+  },
+  async run({ $ }) {
+    const {
+      name,
+      templateId,
+      documentFolderId,
+      tags,
+      recipients,
+      tokens,
+    } = this;
+
+    const response = await this.app.createDocumentFromTemplate({
+      $,
+      data: {
+        name,
+        template_uuid: templateId,
+        folder_uuid: documentFolderId,
+        tags,
+        recipients: this.parseToAnyArray(recipients),
+        tokens: this.parseToAnyArray(tokens),
+      },
+    });
+
+    $.export("$summary", `Successfully created document with template ID: ${templateId}`);
+    return response;
+  },
+};

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

@@ -0,0 +1,112 @@
+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)",
+  type: "action",
+  version: "0.0.1",
+  props: {
+    app,
+    email: {
+      type: "string",
+      label: "Email",
+      description: "Contact's email address.",
+    },
+    firstName: {
+      type: "string",
+      label: "First Name",
+      description: "Contact's first name.",
+      optional: true,
+    },
+    lastName: {
+      type: "string",
+      label: "Last Name",
+      description: "Contact's last name.",
+      optional: true,
+    },
+    company: {
+      type: "string",
+      label: "Company",
+      description: "Contact's company name.",
+      optional: true,
+    },
+    jobTitle: {
+      type: "string",
+      label: "Job Title",
+      description: "Contact's job title.",
+      optional: true,
+    },
+    phone: {
+      type: "string",
+      label: "Phone",
+      description: "Contact's phone number.",
+      optional: true,
+    },
+    country: {
+      type: "string",
+      label: "Country",
+      description: "Contact's country name.",
+      optional: true,
+    },
+    state: {
+      type: "string",
+      label: "State",
+      description: "Contact's state name.",
+      optional: true,
+    },
+    streetAddress: {
+      type: "string",
+      label: "Street Address",
+      description: "Contact's street address.",
+      optional: true,
+    },
+    city: {
+      type: "string",
+      label: "City",
+      description: "Contact's city name.",
+      optional: true,
+    },
+    postalCode: {
+      type: "string",
+      label: "Postal Code",
+      description: "Contact's postal code.",
+      optional: true,
+    },
+  },
+  async run({ $ }) {
+    const {
+      email,
+      firstName,
+      lastName,
+      company,
+      jobTitle,
+      phone,
+      country,
+      state,
+      streetAddress,
+      city,
+      postalCode,
+    } = this;
+
+    const response = await this.app.createOrUpdateContact({
+      $,
+      data: {
+        email,
+        first_name: firstName,
+        last_name: lastName,
+        company,
+        job_title: jobTitle,
+        phone,
+        country,
+        state,
+        street_address: streetAddress,
+        city,
+        postal_code: postalCode,
+      },
+    });
+
+    $.export("$summary", `Successfully created or updated a contact with email: ${email}`);
+    return response;
+  },
+};

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

@@ -0,0 +1,29 @@
+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)",
+  type: "action",
+  version: "0.0.1",
+  props: {
+    app,
+    id: {
+      propDefinition: [
+        app,
+        "documentId",
+      ],
+    },
+  },
+  async run({ $ }) {
+    const { id } = this;
+
+    const response = await this.app.documentDetails({
+      $,
+      id,
+    });
+
+    $.export("$summary", `Successfully fetched document with ID: ${id}`);
+    return response;
+  },
+};

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

@@ -0,0 +1,20 @@
+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)",
+  type: "action",
+  version: "0.0.1",
+  props: {
+    app,
+  },
+  async run({ $ }) {
+    const response = await this.app.listContacts({
+      $,
+    });
+
+    $.export("$summary", `Successfully fetched ${response?.results?.length} contact(s).`);
+    return response;
+  },
+};

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

@@ -0,0 +1,29 @@
+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)",
+  type: "action",
+  version: "0.0.1",
+  props: {
+    app,
+    documentId: {
+      propDefinition: [
+        app,
+        "documentId",
+      ],
+    },
+  },
+  async run({ $ }) {
+    const { documentId } = this;
+
+    const response = await this.app.listDocumentAttachments({
+      $,
+      documentId,
+    });
+
+    $.export("$summary", `Successfully fetched attachments of the document with ID: ${documentId}`);
+    return response;
+  },
+};

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

@@ -0,0 +1,86 @@
+import app from "../../pandadoc.app.mjs";
+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)",
+  type: "action",
+  version: "0.0.1",
+  props: {
+    app,
+    query: {
+      type: "string",
+      label: "Query",
+      description: "Search query. Filter by document reference number (this token is stored on template level) or name.",
+      optional: true,
+    },
+    tag: {
+      type: "string",
+      label: "Tag",
+      description: "Search tag. Filter by document tag.",
+      optional: true,
+    },
+    status: {
+      type: "string",
+      label: "Status",
+      description: "Specify the status of documents to return.",
+      options: constants.DOCUMENTS_STATUS_OPTS,
+      optional: true,
+    },
+    id: {
+      propDefinition: [
+        app,
+        "documentId",
+      ],
+      optional: true,
+    },
+    deleted: {
+      type: "boolean",
+      label: "Deleted",
+      description: "Returns only deleted documents. Default is false.",
+      optional: true,
+    },
+    count: {
+      type: "integer",
+      label: "Count",
+      description: "Specify how many document results to return. Default is 50 documents, maximum is 100 documents.",
+      optional: true,
+      min: 0,
+    },
+    page: {
+      type: "integer",
+      label: "Page",
+      description: "Specify which page of the dataset to return.",
+      optional: true,
+      min: 0,
+    },
+  },
+  async run({ $ }) {
+    const {
+      query,
+      tag,
+      status,
+      count,
+      page,
+      deleted,
+      id,
+    } = this;
+
+    const response = await this.app.listDocuments({
+      $,
+      params: {
+        q: query,
+        tag,
+        status,
+        count,
+        page,
+        deleted,
+        id,
+      },
+    });
+
+    $.export("$summary", `Successfully fetched ${response?.results?.length} documents`);
+    return response;
+  },
+};

package/package.json

@@ -0,0 +1,20 @@
+{
+  "name": "@pipedream/pandadoc",
+  "version": "0.0.1",
+  "description": "Pipedream PandaDoc Components",
+  "main": "pandadoc.app.mjs",
+  "keywords": [
+    "pipedream",
+    "pandadoc"
+  ],
+  "homepage": "https://pipedream.com/apps/pandadoc",
+  "author": "Pipedream <support@pipedream.com> (https://pipedream.com/)",
+  "gitHead": "e12480b94cc03bed4808ebc6b13e7fdb3a1ba535",
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@pipedream/platform": "^1.3.0",
+    "form-data": "^4.0.0"
+  }
+}

package/pandadoc.app.mjs

@@ -0,0 +1,145 @@
+import { axios } from "@pipedream/platform";
+
+export default {
+  type: "app",
+  app: "pandadoc",
+  propDefinitions: {
+    documentId: {
+      type: "string",
+      label: "Document Id",
+      description: "Specify document's ID",
+      async options() {
+        const response = await this.listDocuments({
+          params: {
+            deleted: false,
+          },
+        });
+        return response?.results?.map(({
+          id,
+          name,
+        }) => ({
+          label: name,
+          value: id,
+        })) || [];
+      },
+    },
+    templateId: {
+      type: "string",
+      label: "Template Id",
+      description: "Specify template's ID",
+      async options() {
+        const response = await this.listTemplates({
+          params: {
+            deleted: false,
+          },
+        });
+        return response?.results?.map(({
+          id,
+          name,
+        }) => ({
+          label: name,
+          value: id,
+        })) || [];
+      },
+    },
+    documentFolderId: {
+      type: "string",
+      label: "Document Folder Id",
+      description: "Specify the document folder ID",
+      optional: true,
+      async options() {
+        const response = await this.listDocumentFolders();
+        return response?.results?.map(({
+          uuid,
+          name,
+        }) => ({
+          label: name,
+          value: uuid,
+        })) || [];
+      },
+    },
+  },
+  methods: {
+    getUrl(path) {
+      return `https://api.pandadoc.com/public/v1${path}`;
+    },
+    getHeaders(headers = {}) {
+      return {
+        authorization: `Bearer ${this.$auth.oauth_access_token}`,
+        ...headers,
+      };
+    },
+    makeRequest(customConfig) {
+      const {
+        $ = this,
+        path,
+        headers,
+        ...otherConfig
+      } = customConfig;
+
+      const config = {
+        headers: this.getHeaders(headers),
+        url: this.getUrl(path),
+        ...otherConfig,
+      };
+      return axios($, config);
+    },
+    listTemplates(args = {}) {
+      return this.makeRequest({
+        path: "/templates",
+        ...args,
+      });
+    },
+    listDocuments(args = {}) {
+      return this.makeRequest({
+        path: "/documents",
+        ...args,
+      });
+    },
+    listDocumentFolders(args = {}) {
+      return this.makeRequest({
+        path: "/documents/folders",
+        ...args,
+      });
+    },
+    documentDetails(args = {}) {
+      return this.makeRequest({
+        path: `/documents/${args.id}/details`,
+        ...args,
+      });
+    },
+    listDocumentAttachments(args = {}) {
+      return this.makeRequest({
+        path: `/documents/${args.documentId}/attachments`,
+        ...args,
+      });
+    },
+    createDocumentAttachments(args = {}) {
+      return this.makeRequest({
+        path: `/documents/${args.documentId}/attachments`,
+        method: "POST",
+        ...args,
+      });
+    },
+    createDocumentFromTemplate(args = {}) {
+      return this.makeRequest({
+        path: "/documents",
+        method: "POST",
+        ...args,
+      });
+    },
+    createOrUpdateContact(args = {}) {
+      return this.makeRequest({
+        path: "/contacts",
+        method: "POST",
+        ...args,
+      });
+    },
+    listContacts(args = {}) {
+      return this.makeRequest({
+        path: "/contacts",
+        ...args,
+      });
+    },
+  },
+};