Fynk components

components/fynk/actions/create-contract-from-template/create-contract-from-template.mjs

@@ -0,0 +1,57 @@
+import fynk from "../../fynk.app.mjs";
+
+export default {
+  key: "fynk-create-contract-from-template",
+  name: "Create Contract from Template",
+  description: "Create a new contract in Fynk based on an existing template. [See the documentation](https://app.fynk.com/v1/docs#/operations/v1.documents.create-from-template).",
+  version: "0.0.1",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: false,
+  },
+  type: "action",
+  props: {
+    fynk,
+    templateUuid: {
+      propDefinition: [
+        fynk,
+        "templateUuid",
+      ],
+    },
+    name: {
+      type: "string",
+      label: "Name",
+      description: "The new document's name. If omitted, the name of the template will be used as the new document's name",
+      optional: true,
+    },
+    ownerEmails: {
+      type: "string[]",
+      label: "Owner Emails",
+      description: "Email addresses of the user(s) from your account who should be given ownership of the new document",
+      optional: true,
+    },
+  },
+  async run({ $ }) {
+    const {
+      templateUuid,
+      name,
+      ownerEmails,
+    } = this;
+
+    const data = {
+      template_uuid: templateUuid,
+      name,
+      owner_emails: ownerEmails,
+    };
+
+    const response = await this.fynk.createDocumentFromTemplate({
+      $,
+      data,
+    });
+
+    $.export("$summary", `Successfully created contract "${response.data.name}" with UUID ${response.data.uuid}`);
+    return response;
+  },
+};
+

components/fynk/actions/move-contract-stage/move-contract-stage.mjs

@@ -0,0 +1,97 @@
+import fynk from "../../fynk.app.mjs";
+import { ConfigurationError } from "@pipedream/platform";
+
+export default {
+  key: "fynk-move-contract-stage",
+  name: "Move Contract Stage",
+  description: "Move a contract forward in Fynk's lifecycle. See documentation pages [move document to review stage](https://app.fynk.com/v1/docs#/operations/v1.documents.stage-transitions.review) and [move document to signing stage](https://app.fynk.com/v1/docs#/operations/v1.documents.stage-transitions.signing).",
+  version: "0.0.1",
+  annotations: {
+    destructiveHint: true,
+    openWorldHint: true,
+    readOnlyHint: false,
+  },
+  type: "action",
+  props: {
+    fynk,
+    documentUuid: {
+      propDefinition: [
+        fynk,
+        "documentUuid",
+      ],
+    },
+    targetStage: {
+      propDefinition: [
+        fynk,
+        "targetStage",
+      ],
+    },
+    signatureType: {
+      type: "string",
+      label: "Signature Type",
+      description: "The signature type to use when moving to signing stage. Only used when `Target Stage` is set to `signing`",
+      optional: true,
+      options: [
+        {
+          label: "Simple Electronic Signature (SES)",
+          value: "ses",
+        },
+        {
+          label: "Advanced Electronic Signature (AES)",
+          value: "aes",
+        },
+        {
+          label: "Qualified Electronic Signature (QES)",
+          value: "qes",
+        },
+      ],
+    },
+    sequentialSigning: {
+      type: "boolean",
+      label: "Sequential Signing",
+      description: "If `true`, signatures will be requested in the order defined by the signatories' `signing_order`. Only used when `Target Stage` is set to `signing`",
+      optional: true,
+    },
+    message: {
+      type: "string",
+      label: "Message",
+      description: "Message to include in the email sent to the document's signatories. This is included in addition to the default email text provided by fynk. Only used when `Target Stage` is set to `signing`",
+      optional: true,
+    },
+  },
+  async run({ $ }) {
+    const {
+      documentUuid,
+      targetStage,
+      signatureType,
+      sequentialSigning,
+      message,
+    } = this;
+
+    let response;
+    if (targetStage === "review") {
+      response = await this.fynk.moveDocumentToReview({
+        $,
+        documentUuid,
+      });
+    } else if (targetStage === "signing") {
+      const data = {
+        signature_type: signatureType,
+        sequential_signing: sequentialSigning,
+        message,
+      };
+
+      response = await this.fynk.moveDocumentToSigning({
+        $,
+        documentUuid,
+        data,
+      });
+    } else {
+      throw new ConfigurationError(`Invalid target stage: ${targetStage}`);
+    }
+
+    $.export("$summary", `Successfully moved contract ${documentUuid} to ${targetStage} stage`);
+    return response;
+  },
+};
+