[Components] papersign #14412

Sources
 - New Event (Instant)
 - New Document Completed (Instant)
 - New Signer Signed (Instant)

Actions
 - Copy Document
 - Get Document
 - Send Document

Author: luancazarine

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

@@ -1,11 +1,10 @@
 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}}",
+  version: "0.0.1",
   type: "action",
   props: {
     papersign,
@@ -31,27 +30,33 @@ export default {
     path: {
       type: "string",
       label: "Path",
-      description: "The path to copy the document to. Maximum depth is 4 levels.",
+      description: "The path to copy the document to. Maximum depth is 4 levels. Any missing folders will be created.",
       optional: true,
     },
     folderId: {
       propDefinition: [
         papersign,
         "folderId",
-        (c) => ({
-          spaceId: c.spaceId,
-        }),
       ],
       optional: true,
     },
   },
   async run({ $ }) {
+    const data = {};
+    if (this.folderId) {
+      data.folder_id = this.folderId;
+    } else {
+      data.space_id = this.spaceId;
+      data.path = this.path;
+    }
+
     const response = await this.papersign.duplicateDocument({
+      $,
       documentId: this.documentId,
-      name: this.name,
-      spaceId: this.spaceId,
-      path: this.path,
-      folderId: this.folderId,
+      data: {
+        ...data,
+        name: this.name,
+      },
     });
 
     $.export("$summary", `Successfully copied document: ${response.results.document.name}`);

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

@@ -1,11 +1,10 @@
 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}}",
+  version: "0.0.1",
   type: "action",
   props: {
     papersign,
@@ -18,6 +17,7 @@ export default {
   },
   async run({ $ }) {
     const response = await this.papersign.getDocument({
+      $,
       documentId: this.documentId,
     });
 

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

@@ -1,5 +1,6 @@
+import { ConfigurationError } from "@pipedream/platform";
+import { parseObject } from "../../common/utils.mjs";
 import papersign from "../../papersign.app.mjs";
-import { axios } from "@pipedream/platform";
 
 export default {
   key: "papersign-send-document",
@@ -18,7 +19,7 @@ export default {
     expiration: {
       type: "string",
       label: "Expiration",
-      description: "The expiration date of the document. Must be at least 30 minutes in the future.",
+      description: "The expiration date of the document. Must be at least 30 minutes in the future. **Format: YYYY-MM-DDTHH:MM:SS.SSSZ**",
       optional: true,
     },
     inviteMessage: {
@@ -39,22 +40,28 @@ export default {
       description: "An array of recipient emails for the document.",
       optional: true,
     },
-    automaticReminders: {
-      type: "object",
-      label: "Automatic Reminders",
-      description: "An object for setting automatic reminders.",
+    firstAfterDays: {
+      type: "integer",
+      label: "Automatic Reminder - First After Days",
+      description: "The number of days after the document is sent to send the reminder.",
+      optional: true,
+    },
+    followUpEveryDays: {
+      type: "integer",
+      label: "Automatic Reminder - Follow Up Every Days",
+      description: "The number of days to wait between reminders.",
       optional: true,
     },
     signers: {
       type: "string[]",
       label: "Signers",
-      description: "An array of signer objects.",
+      description: "An array of objects of signers. **Object format: {\"key\": \"123\",\"name\": \"Jack Smith\",\"email\": \"[email protected]\",\"phone\": \"123 456 7899\",\"job_title\": \"Account Manager\",\"company\": \"Explosive Startup\",\"custom_attributes\": [{\"key\": \"Relationship\",\"label\": \"Relationship to the company\",\"value\": \"CEO\"}]}**",
       optional: true,
     },
     variables: {
-      type: "string[]",
+      type: "object",
       label: "Variables",
-      description: "An array of variable objects.",
+      description: "The key: value of the document variables.",
       optional: true,
     },
     copy: {
@@ -65,16 +72,42 @@ export default {
     },
   },
   async run({ $ }) {
+    if (
+      (this.firstAfterDays && !this.followUpEveryDays) ||
+      (!this.firstAfterDays && this.followUpEveryDays)
+    ) {
+      throw new ConfigurationError("You must fill in the fields 'First After Days' and 'Follow Up Every Days' or none of them");
+    }
+
+    const automaticReminders = {};
+    if (this.firstAfterDays) {
+      automaticReminders.first_after_days = this.firstAfterDays;
+      automaticReminders.follow_up_every_days = this.followUpEveryDays;
+    }
+
+    const variables = [];
+    if (this.variables) {
+      for (const key of Object.keys(parseObject(this.variables))) {
+        variables.push({
+          key,
+          value: this.variables[key],
+        });
+      }
+    }
+
     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,
+      data: {
+        expiration: this.expiration,
+        inviteMessage: this.inviteMessage,
+        fromUserEmail: this.fromUserEmail,
+        documentRecipientEmails: parseObject(this.documentRecipientEmails),
+        automaticReminders,
+        signers: parseObject(this.signers),
+        variables,
+        copy: this.copy,
+      },
     });
     $.export("$summary", `Document sent successfully with ID ${this.documentId}`);
     return response;

components/papersign/common/constants.mjs

@@ -0,0 +1,12 @@
+export const LIMIT = 100;
+
+export const SCOPE_OPTIONS = [
+  {
+    label: "Direct Children",
+    value: "folder.direct_children",
+  },
+  {
+    label: "All Descendants",
+    value: "folder.all_descendants",
+  },
+];

components/papersign/common/utils.mjs

@@ -0,0 +1,32 @@
+export const parseObject = (obj) => {
+  if (!obj) return undefined;
+
+  if (Array.isArray(obj)) {
+    return obj.map((item) => {
+      if (typeof item === "string") {
+        try {
+          return JSON.parse(item);
+        } catch (e) {
+          return parseObject(item);
+        }
+      }
+      return item;
+    });
+  }
+  if (typeof obj === "string") {
+    try {
+      return JSON.parse(obj);
+    } catch (e) {
+      return obj;
+    }
+  }
+  if (typeof obj === "object") {
+    for (const [
+      key,
+      value,
+    ] of Object.entries(obj)) {
+      obj[key] = parseObject(value);
+    }
+  }
+  return obj;
+};

components/papersign/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pipedream/papersign",
-  "version": "0.0.1",
+  "version": "0.1.0",
   "description": "Pipedream Papersign Components",
   "main": "papersign.app.mjs",
   "keywords": [
@@ -11,5 +11,8 @@
   "author": "Pipedream <[email protected]> (https://pipedream.com/)",
   "publishConfig": {
     "access": "public"
+  },
+  "dependencies": {
+    "@pipedream/platform": "^3.0.3"
   }
 }