import { ConfigurationError } from "@pipedream/platform";
import fs from "fs";
import boldsign from "../../boldsign.app.mjs";
import { DOCUMENT_DOWNLOAD_OPTIONS } from "../../common/constants.mjs";
import {
checkTmp,
parseObject,
} from "../../common/utils.mjs";
export default {
key: "boldsign-send-document-template",
name: "Send Document Using Template",
description: "Send documents for e-signature using a BoldSign template. [See the documentation](https://developers.boldsign.com/documents/send-document-from-template/?region=us)",
version: "0.0.1",
type: "action",
props: {
boldsign,
templateId: {
propDefinition: [
boldsign,
"templateId",
],
},
title: {
type: "string",
label: "Title",
description: "The title of the document.",
optional: true,
},
message: {
type: "string",
label: "Message",
description: "A message to include with the document.",
optional: true,
},
roles: {
type: "string[]",
label: "Roles",
description: "A role is simply a placeholder for a real person. For example, if we have a purchase order that will always be signed by two people, one from the company and one from the customer, we can create a template with two roles Customer and Representative. Example: **[{\"roleIndex\": 50,\"signerName\": \"Richard\",\"signerOrder\": 1,\"signerEmail\": \"richard@cubeflakes.com\",\"privateMessage\": \"Please check and sign the document.\",\"authenticationCode\": \"281028\",\"enableEmailOTP\": false,\"signerType\": \"Signer\",\"signerRole\": \"Manager\",\"formFields\": [{\"id\": \"SignField\",\"fieldType\": \"Signature\",\"pageNumber\": 1,\"bounds\": {\"x\": 100,\"y\": 100,\"width\": 100,\"height\": 50},\"isRequired\": true}]**.",
},
brandId: {
propDefinition: [
boldsign,
"brandId",
],
optional: true,
},
labels: {
propDefinition: [
boldsign,
"labels",
],
optional: true,
},
disableEmails: {
type: "boolean",
label: "Disable Emails",
description: "Disable sending emails to recipients.",
optional: true,
},
disableSMS: {
type: "boolean",
label: "Disable SMS",
description: "Disable sending SMS to recipients.",
optional: true,
},
hideDocumentId: {
type: "boolean",
label: "Hide Document ID",
description: "Decides whether the document ID should be hidden or not.",
optional: true,
},
enableAutoReminder: {
type: "boolean",
label: "Enable Auto Reminder",
description: "Enable automatic reminders.",
reloadProps: true,
optional: true,
},
reminderDays: {
type: "integer",
label: "Reminder Days",
description: "Number of days between reminders.",
hidden: true,
optional: true,
},
reminderCount: {
type: "integer",
label: "Reminder Count",
description: "Number of reminder attempts.",
hidden: true,
optional: true,
},
cc: {
propDefinition: [
boldsign,
"cc",
],
optional: true,
},
expiryDays: {
type: "integer",
label: "Expiry Days",
description: "Number of days before document expires.",
optional: true,
},
enablePrintAndSign: {
type: "boolean",
label: "Enable Print and Sign",
description: "Allow signers to print and sign document.",
optional: true,
},
enableReassign: {
type: "boolean",
label: "Enable Reassign",
description: "Allow signers to reassign the document.",
optional: true,
},
enableSigningOrder: {
type: "boolean",
label: "Enable Signing Order",
description: "Enable signing order for the document.",
optional: true,
},
disableExpiryAlert: {
type: "boolean",
label: "Disable Expiry Alert",
description: "Disable alerts before document expiry.",
optional: true,
},
documentInfo: {
type: "string[]",
label: "Document Info",
description: "Custom information fields for the document. [See the documentation](https://developers.boldsign.com/documents/send-document-from-template) for further information.",
optional: true,
},
roleRemovalIndices: {
type: "integer[]",
label: "Role Removal Indices",
description: "Removes the roles present in the template with their indices given in this property.",
optional: true,
},
documentDownloadOption: {
type: "string",
label: "Document Download Option",
description: "Option for document download configuration.",
options: DOCUMENT_DOWNLOAD_OPTIONS,
optional: true,
},
formGroups: {
type: "string[]",
label: "Form Groups",
description: "Manages the rules and configuration of grouped form fields. [See the documentation](https://developers.boldsign.com/documents/send-document-from-template) for further information.",
optional: true,
},
files: {
type: "string[]",
label: "Files",
description: "A list of paths to files in the `/tmp` directory. [See the documentation on working with files](https://pipedream.com/docs/code/nodejs/working-with-files/#writing-a-file-to-tmp).",
optional: true,
},
fileUrls: {
type: "string[]",
label: "File URLs",
description: "URLs of files to include in the document.",
optional: true,
},
recipientNotificationSettings: {
type: "object",
label: "Recipient Notification Settings",
description: "Settings for recipient notifications. [See the documentation](https://developers.boldsign.com/documents/send-document-from-template) for further information.",
optional: true,
},
removeFormfields: {
type: "string[]",
label: "Remove Formfields",
description: "The removeFormFields property in API allows you to exclude specific form fields from a document before sending it. You provide a string array with the IDs of the existing form fields you want to remove. One or more values can be specified.",
optional: true,
},
enableAuditTrailLocalization: {
type: "boolean",
label: "Enable Audit Trail Localization",
description: "Enable localization for audit trail based on the signer's language. If null is provided, the value will be inherited from the Business Profile settings. Only one additional language can be specified in the signer's languages besides English.",
optional: true,
},
},
async additionalProps(props) {
props.reminderDays.hidden = !this.enableAutoReminder;
props.reminderCount.hidden = !this.enableAutoReminder;
return {};
},
async run({ $ }) {
try {
const files = [];
if (this.files) {
for (const file of parseObject(this.files)) {
const filePath = fs.readFileSync(checkTmp(file), "base64");
files.push(`data:application/${file.substr(file.length - 3)};base64,${filePath}`);
}
}
const additionalData = {};
if (this.enableAutoReminder) {
additionalData.reminderSettings = {
enableAutoReminder: this.enableAutoReminder,
reminderDays: this.reminderDays,
reminderCount: this.reminderCount,
};
}
const response = await this.boldsign.sendDocument({
$,
headers: {
"Content-Type": "application/json;odata.metadata=minimal;odata.streaming=true",
},
params: {
templateId: this.templateId,
},
data: {
title: this.title,
message: this.message,
roles: parseObject(this.roles),
brandId: this.brandId,
labels: parseObject(this.labels),
disableEmails: this.disableEmails,
disableSMS: this.disableSMS,
hideDocumentId: this.hideDocumentId,
reminderSettings: {
enableAutoReminder: this.enableAutoReminder,
reminderDays: this.reminderDays,
reminderCount: this.reminderCount,
},
cc: parseObject(this.cc)?.map((item) => ({
emailAddress: item,
})),
expiryDays: this.expiryDays,
enablePrintAndSign: this.enablePrintAndSign,
enableReassign: this.enableReassign,
enableSigningOrder: this.enableSigningOrder,
disableExpiryAlert: this.disableExpiryAlert,
documentInfo: parseObject(this.documentInfo),
roleRemovalIndices: parseObject(this.roleRemovalIndices),
documentDownloadOption: this.documentDownloadOption,
formGroups: parseObject(this.formGroups),
files,
fileUrls: parseObject(this.fileUrls),
recipientNotificationSettings: parseObject(this.recipientNotificationSettings),
removeFormfields: parseObject(this.removeFormfields),
enableAuditTrailLocalization: this.enableAuditTrailLocalization,
...additionalData,
},
});
$.export("$summary", `Document sent successfully using template ${this.templateId}`);
return response;
} catch ({ message }) {
const parsedMessage = JSON.parse(message);
let errorMessage = "";
if (parsedMessage.error) errorMessage = parsedMessage.error;
if (parsedMessage.errors) {
Object.entries(parsedMessage.errors).map(([
,
value,
]) => {
errorMessage += `- ${value[0]}\n`;
});
}
throw new ConfigurationError(errorMessage);
}
},
};
Chase Roberts@chsrbrts@benedictevans If you haven’t used @pipedream yet, then you haven’t lived.
✨Ellie Day✨@heyelliedayEvaluation update: @pipedream has quite literally been a dream to work with! I’m excited to leverage this tool for all the various workflows I need to write. I’m currently at 11k invocations a day from the initial workflows I’ve written in the past couple weeks.
Michael Braedley@MBraedleyUpdate: I got it working properly, and it's working so well that I'm dropping IFTTT. @pipedream can do everything that IFTTT basic can, and most (if not all things) IFTTT pro can for free or at a reasonable price if you need it. I am recommending it for basically any power user.
Thomas Cutting@mrthomascuttingWant quick+dirty integrations for a serverless workflow - @pipedream is my new go-to 😃
Matthew Roberts@mattdotrobertsday 013 - finally hit node js. This is the secret sauce of taking #nocode projects that one step further. Pumped about getting deeper into @pipedream now
Kenneth Auchenberg 💭@auchenbergYahoo Pipes is back! Kinda 😍 @pipedream
Raymond Camden 🥑@raymondcamdenAwesome video by the @pipedream folks showing real time twitter sentiment analysis integrated with Google Sheets. This is where Pipedream *really* shines, connecting systems together in easy workflows.
Nacho Caballero@nachocaballeroI couldn't recommend @pipedream more. It's an amazing service to integrate different APIs. Much more powerful than Zapier and more user-friendly than AWS Lambda. I'm very proud to wear this t-shirt #NoCode
Jason Snow@jyksnwDeveloped a working prototype environmental sensor IoT solution with @particle Photon, @pipedream, and @MongoDB with full graphing and alerting in less than a day! All amazing technology, will def. be exploring these more.
Steven Terrana@steven_terrana@burgwyn you've inspired me to finally set up my own blog. I'll make sure my first blog post explains the tech behind the setup. think @obsdmd + @GatsbyJS + @pipedream.
🚄 James Augeri, PhD@DotDotJamesWant to low-code your back end, need more horsepower than @Bubble / @KnackHQ, or just miss Yahoo! Pipes? Check out @PipeDream
Sébastien Chopin@AtinuxGitHub issues should be like @linear_app for maintainers. Looking forward more integrations with GH actions or tools like @pipedream 👀
Raul@raul_predescuIf you're a dev and not using @pipedream, you're missing out. Been using it for months, daily. FREE for devs. Plenty of integrations and good limits. Absolutely love it.
Bruno Skvorc@bitfallsSo @pipedream is pretty amazing. In 3 minutes I just made a flow which adds @rickastley's Never Gonna Give You Up to my @spotify playlist whenever a new pull request arrives in an old repo of mine.
Zach Lanich@ZachLanichUm, wow 🤯 @pipedream
Steven Bell@bellontechI just used @pipedream to build a Shopify App. Wow, they make small backed tasks easy.
Jay Hack 🎩🇺🇸@_jayhack_Very impressed with this bad boi - it reminds me of a @PalantirTech internal tool, but geared towards integrations instead of data analysis and far more customizable. Great expectations here 🚀🤩
Tree Sturgeon 🔥🚴♂️🌳@philsturgeonFor context this is day 2 of a really challenging and stupid migration from Notion to @airtable with disparate/missing data. It's going better than expected and thanks to @pipedream I don't have to bother the iOS dev to add W3W.