papersign init

Author: luancazarine

components/papersign/actions/copy-document/copy-document.mjs

@@ -0,0 +1,60 @@
+import papersign from "../../papersign.app.mjs";
+import { axios } from "@pipedream/platform";
+
+export default {
+  key: "papersign-copy-document",
+  name: "Copy Document",
+  description: "Duplicates a given document. [See the documentation](https://paperform.readme.io/reference/papersigncopydocument)",
+  version: "0.0.{{ts}}",
+  type: "action",
+  props: {
+    papersign,
+    documentId: {
+      propDefinition: [
+        papersign,
+        "documentId",
+      ],
+    },
+    name: {
+      type: "string",
+      label: "Name",
+      description: "The new name of the copied document",
+      optional: true,
+    },
+    spaceId: {
+      propDefinition: [
+        papersign,
+        "spaceId",
+      ],
+      optional: true,
+    },
+    path: {
+      type: "string",
+      label: "Path",
+      description: "The path to copy the document to. Maximum depth is 4 levels.",
+      optional: true,
+    },
+    folderId: {
+      propDefinition: [
+        papersign,
+        "folderId",
+        (c) => ({
+          spaceId: c.spaceId,
+        }),
+      ],
+      optional: true,
+    },
+  },
+  async run({ $ }) {
+    const response = await this.papersign.duplicateDocument({
+      documentId: this.documentId,
+      name: this.name,
+      spaceId: this.spaceId,
+      path: this.path,
+      folderId: this.folderId,
+    });
+
+    $.export("$summary", `Successfully copied document: ${response.results.document.name}`);
+    return response;
+  },
+};

components/papersign/actions/get-document/get-document.mjs

@@ -0,0 +1,27 @@
+import papersign from "../../papersign.app.mjs";
+import { axios } from "@pipedream/platform";
+
+export default {
+  key: "papersign-get-document",
+  name: "Get Document",
+  description: "Retrieve a document using a specified ID. [See the documentation](https://paperform.readme.io/reference/getpapersigndocument)",
+  version: "0.0.{{ts}}",
+  type: "action",
+  props: {
+    papersign,
+    documentId: {
+      propDefinition: [
+        papersign,
+        "documentId",
+      ],
+    },
+  },
+  async run({ $ }) {
+    const response = await this.papersign.getDocument({
+      documentId: this.documentId,
+    });
+
+    $.export("$summary", `Successfully retrieved document with ID: ${this.documentId}`);
+    return response;
+  },
+};

components/papersign/actions/send-document/send-document.mjs

@@ -0,0 +1,82 @@
+import papersign from "../../papersign.app.mjs";
+import { axios } from "@pipedream/platform";
+
+export default {
+  key: "papersign-send-document",
+  name: "Send Document",
+  description: "Dispatches a document to a specified recipient. [See the documentation](https://paperform.readme.io/reference/papersignsenddocument)",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    papersign,
+    documentId: {
+      propDefinition: [
+        papersign,
+        "documentId",
+      ],
+    },
+    expiration: {
+      type: "string",
+      label: "Expiration",
+      description: "The expiration date of the document. Must be at least 30 minutes in the future.",
+      optional: true,
+    },
+    inviteMessage: {
+      type: "string",
+      label: "Invite Message",
+      description: "The message to include in the invitation email, up to 1000 characters.",
+      optional: true,
+    },
+    fromUserEmail: {
+      type: "string",
+      label: "From User Email",
+      description: "The email address of a User on your team's account to send the document from.",
+      optional: true,
+    },
+    documentRecipientEmails: {
+      type: "string[]",
+      label: "Document Recipient Emails",
+      description: "An array of recipient emails for the document.",
+      optional: true,
+    },
+    automaticReminders: {
+      type: "object",
+      label: "Automatic Reminders",
+      description: "An object for setting automatic reminders.",
+      optional: true,
+    },
+    signers: {
+      type: "string[]",
+      label: "Signers",
+      description: "An array of signer objects.",
+      optional: true,
+    },
+    variables: {
+      type: "string[]",
+      label: "Variables",
+      description: "An array of variable objects.",
+      optional: true,
+    },
+    copy: {
+      type: "boolean",
+      label: "Copy",
+      description: "Whether to copy before sending.",
+      optional: true,
+    },
+  },
+  async run({ $ }) {
+    const response = await this.papersign.sendDocument({
+      documentId: this.documentId,
+      expiration: this.expiration,
+      inviteMessage: this.inviteMessage,
+      fromUserEmail: this.fromUserEmail,
+      documentRecipientEmails: this.documentRecipientEmails,
+      automaticReminders: this.automaticReminders,
+      signers: this.signers,
+      variables: this.variables,
+      copy: this.copy,
+    });
+    $.export("$summary", `Document sent successfully with ID ${this.documentId}`);
+    return response;
+  },
+};

components/papersign/package.json

@@ -12,4 +12,4 @@
   "publishConfig": {
     "access": "public"
   }
-}
+}

components/papersign/papersign.app.mjs

@@ -1,11 +1,124 @@
+import { axios } from "@pipedream/platform";
+
 export default {
   type: "app",
   app: "papersign",
-  propDefinitions: {},
+  propDefinitions: {
+    documentId: {
+      type: "string",
+      label: "Document ID",
+      description: "Enter the ID of the Papersign document",
+      async options() {
+        const documents = await this.listDocuments();
+        return documents.map((doc) => ({
+          value: doc.id,
+          label: doc.name,
+        }));
+      },
+    },
+    spaceId: {
+      type: "string",
+      label: "Space ID",
+      description: "Enter the ID of the Papersign space",
+      async options() {
+        const spaces = await this.listSpaces();
+        return spaces.map((space) => ({
+          value: space.id,
+          label: space.name,
+        }));
+      },
+    },
+    folderId: {
+      type: "string",
+      label: "Folder ID",
+      description: "Enter the ID of the Papersign folder",
+      async options() {
+        const folders = await this.listFolders();
+        return folders.map((folder) => ({
+          value: folder.id,
+          label: folder.name,
+        }));
+      },
+    },
+  },
   methods: {
-    // this.$auth contains connected account data
-    authKeys() {
-      console.log(Object.keys(this.$auth));
+    _baseUrl() {
+      return "https://api.paperform.co/v1/papersign";
+    },
+    async _makeRequest(opts = {}) {
+      const {
+        $ = this, method = "GET", path = "/", headers, ...otherOpts
+      } = opts;
+      return axios($, {
+        ...otherOpts,
+        method,
+        url: this._baseUrl() + path,
+        headers: {
+          ...headers,
+          Authorization: `Bearer ${this.$auth.api_key}`,
+        },
+      });
+    },
+    async listDocuments(opts = {}) {
+      return this._makeRequest({
+        path: "/documents",
+        ...opts,
+      });
+    },
+    async listSpaces(opts = {}) {
+      return this._makeRequest({
+        path: "/spaces",
+        ...opts,
+      });
+    },
+    async listFolders(opts = {}) {
+      const { spaceId } = opts;
+      return this._makeRequest({
+        path: "/folders",
+        params: spaceId
+          ? {
+            space_id: spaceId,
+          }
+          : {},
+        ...opts,
+      });
+    },
+    async duplicateDocument({
+      documentId, name, spaceId, path, folderId,
+    }) {
+      return this._makeRequest({
+        method: "POST",
+        path: `/documents/${documentId}/copy`,
+        data: {
+          name,
+          space_id: spaceId,
+          path,
+          folder_id: folderId,
+        },
+      });
+    },
+    async getDocument({ documentId }) {
+      return this._makeRequest({
+        path: `/documents/${documentId}`,
+      });
+    },
+    async sendDocument({
+      documentId, expiration, inviteMessage, fromUserEmail, documentRecipientEmails, automaticReminders, signers, variables, copy,
+    }) {
+      return this._makeRequest({
+        method: "POST",
+        path: `/documents/${documentId}/send`,
+        data: {
+          expiration,
+          invite_message: inviteMessage,
+          from_user_email: fromUserEmail,
+          document_recipient_emails: documentRecipientEmails,
+          automatic_reminders: automaticReminders,
+          signers,
+          variables,
+          copy,
+        },
+      });
     },
   },
-};
+};

components/papersign/sources/new-document-completed-instant/new-document-completed-instant.mjs

@@ -0,0 +1,71 @@
+import papersign from "../../papersign.app.mjs";
+import { axios } from "@pipedream/platform";
+
+export default {
+  key: "papersign-new-document-completed-instant",
+  name: "New Document Completed (Instant)",
+  description: "Emit new event when a document is completed, i.e., all signers have signed. [See the documentation](https://paperform.readme.io/reference/getting-started-1)",
+  version: "0.0.{{ts}}",
+  type: "source",
+  dedupe: "unique",
+  props: {
+    papersign,
+    http: {
+      type: "$.interface.http",
+      customResponse: false,
+    },
+    db: "$.service.db",
+  },
+  hooks: {
+    async deploy() {
+      const documents = await this.papersign.listDocuments();
+      const completedDocs = documents.filter((doc) => doc.status === "completed");
+      for (const doc of completedDocs) {
+        this.$emit(doc, {
+          id: doc.id,
+          summary: `Document ${doc.name} completed`,
+          ts: Date.parse(doc.updated_at),
+        });
+      }
+    },
+    async activate() {
+      const webhookData = {
+        name: "Document Completed Webhook",
+        target_url: this.http.endpoint,
+        triggers: [
+          "document.completed",
+        ],
+      };
+      const response = await axios(this, {
+        method: "POST",
+        url: `${this.papersign._baseUrl()}/webhooks`,
+        headers: {
+          Authorization: `Bearer ${this.papersign.$auth.api_key}`,
+        },
+        data: webhookData,
+      });
+      this.db.set("webhookId", response.webhook.id);
+    },
+    async deactivate() {
+      const webhookId = this.db.get("webhookId");
+      if (webhookId) {
+        await axios(this, {
+          method: "DELETE",
+          url: `${this.papersign._baseUrl()}/webhooks/${webhookId}`,
+          headers: {
+            Authorization: `Bearer ${this.papersign.$auth.api_key}`,
+          },
+        });
+        this.db.set("webhookId", null);
+      }
+    },
+  },
+  async run(event) {
+    const doc = event.body;
+    this.$emit(doc, {
+      id: doc.id,
+      summary: `Document ${doc.name} completed`,
+      ts: Date.parse(doc.updated_at),
+    });
+  },
+};