DocuGenerate - new components

components/docugenerate/README.md

@@ -9,3 +9,25 @@ The DocuGenerate API lets you automate document creation and management tasks wi
 - **Automated Report Creation and Distribution**: Schedule a workflow to run weekly, gathering data from tools such as Google Sheets or a database. Use this data to create a tailored report via DocuGenerate and subsequently email the report to a list of stakeholders using an email service like SendGrid.
 
 - **Dynamic Invoice Creation from E-Commerce Platforms**: When a new order is placed on an e-commerce platform (like Shopify), trigger a Pipedream workflow that creates an invoice through the DocuGenerate API. Then, archive the invoice in cloud storage like Google Drive and update the order status within the e-commerce platform.
+
+# Getting Started
+
+## Obtaining Your API Key
+
+1. Sign up for a [DocuGenerate](https://www.docugenerate.com/) account
+2. Get your unique API Key from the Developers tab in the [Settings](https://app.docugenerate.com/settings/developers) page
+3. Copy the API Key for use in Pipedream
+
+## Connecting to Pipedream
+
+1. In your Pipedream workflow, add a DocuGenerate action
+2. When prompted for authentication, paste your API Key
+3. Test the connection by using the "List Templates" action
+
+## Generating Your First Document
+
+Use the "Generate Document" action with:
+- **Template**: Select from your available templates
+- **Data**: Provide JSON data matching your template merge tags (e.g., `{ "name": "John Doe" }`)
+- **Name**: Set a custom document name (optional)
+- **Format**: Choose your desired output format (optional)

components/docugenerate/actions/delete-document/delete-document.mjs

@@ -0,0 +1,23 @@
+import app from "../../docugenerate.app.mjs";
+
+export default {
+  key: "docugenerate-delete-document",
+  name: "Delete Document",
+  description: "Deletes a specific document. [See the documentation](https://api.docugenerate.com/#/Document/deleteDocument)",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    app,
+    documentId: {
+      type: "string",
+      label: "Document",
+      description: "The ID of the document",
+    },
+  },
+  async run({ $ }) {
+    const response = await this.app.deleteDocument($, this.documentId);
+
+    $.export("$summary", `Successfully deleted the document ${this.documentId}`);
+    return response;
+  },
+};

components/docugenerate/actions/delete-template/delete-template.mjs

@@ -0,0 +1,24 @@
+import app from "../../docugenerate.app.mjs";
+
+export default {
+  key: "docugenerate-delete-template",
+  name: "Delete Template",
+  description: "Deletes a specific template. [See the documentation](https://api.docugenerate.com/#/Template/deleteTemplate)",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    app,
+    templateId: {
+      propDefinition: [
+        app,
+        "templateId",
+      ],
+    },
+  },
+  async run({ $ }) {
+    const response = await this.app.deleteTemplate($, this.templateId);
+
+    $.export("$summary", `Successfully deleted the template ${this.templateId}`);
+    return response;
+  },
+};

components/docugenerate/actions/generate-document/generate-document.mjs

@@ -0,0 +1,74 @@
+import app from "../../docugenerate.app.mjs";
+
+export default {
+  key: "docugenerate-generate-document",
+  name: "Generate Document",
+  description: "Generates a document from a template. [See the documentation](https://api.docugenerate.com/#/Document/generateDocument)",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    app,
+    templateId: {
+      propDefinition: [
+        app,
+        "templateId",
+      ],
+    },
+    name: {
+      type: "string",
+      label: "Name",
+      description: "Name of the generated document. Defaults to the template’s name.",
+      optional: true,
+    },
+    format: {
+      type: "string",
+      label: "Format",
+      description: "Output format of the generated document. Defaults to .docx.",
+      optional: true,
+      options: [
+        {
+          label: "PDF (.pdf)",
+          value: ".pdf",
+        },
+        {
+          label: "Microsoft Word (.docx)",
+          value: ".docx",
+        },
+        {
+          label: "Microsoft Word 2007 (.doc)",
+          value: ".doc",
+        },
+        {
+          label: "OpenDocument Format (.odt)",
+          value: ".odt",
+        },
+        {
+          label: "Plain Text (.txt)",
+          value: ".txt",
+        },
+        {
+          label: "PNG (.png)",
+          value: ".png",
+        },
+      ],
+    },
+    data: {
+      type: "object",
+      label: "Data",
+      description: "Data that is used to generate the document.",
+    },
+  },
+  async run({ $ }) {
+    const body = {
+      template_id: this.templateId,
+      name: this.name,
+      output_format: this.format,
+      data: this.data,
+    };
+
+    const response = await this.app.generateDocument($, body);
+
+    $.export("$summary", `Successfully generated the document ${response.id}`);
+    return response;
+  },
+};

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

@@ -0,0 +1,23 @@
+import app from "../../docugenerate.app.mjs";
+
+export default {
+  key: "docugenerate-get-document",
+  name: "Get Document",
+  description: "Retrieves a specific document. [See the documentation](https://api.docugenerate.com/#/Document/getDocument)",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    app,
+    documentId: {
+      type: "string",
+      label: "Document",
+      description: "The ID of the document",
+    },
+  },
+  async run({ $ }) {
+    const response = await this.app.getDocument($, this.documentId);
+
+    $.export("$summary", `Successfully retrieved the document ${this.documentId}`);
+    return response;
+  },
+};

components/docugenerate/actions/get-template/get-template.mjs

@@ -0,0 +1,24 @@
+import app from "../../docugenerate.app.mjs";
+
+export default {
+  key: "docugenerate-get-template",
+  name: "Get Template",
+  description: "Retrieves a specific template. [See the documentation](https://api.docugenerate.com/#/Template/getTemplate)",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    app,
+    templateId: {
+      propDefinition: [
+        app,
+        "templateId",
+      ],
+    },
+  },
+  async run({ $ }) {
+    const response = await this.app.getTemplate($, this.templateId);
+
+    $.export("$summary", `Successfully retrieved the template ${this.templateId}`);
+    return response;
+  },
+};

components/docugenerate/actions/list-documents/list-documents.mjs

@@ -0,0 +1,24 @@
+import app from "../../docugenerate.app.mjs";
+
+export default {
+  key: "docugenerate-list-documents",
+  name: "List Documents",
+  description: "Retrieves a list of documents generated from a template. [See the documentation](https://api.docugenerate.com/#/Document/queryDocuments)",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    app,
+    templateId: {
+      propDefinition: [
+        app,
+        "templateId",
+      ],
+    },
+  },
+  async run({ $ }) {
+    const response = await this.app.listDocuments($, this.templateId);
+
+    $.export("$summary", `Successfully retrieved ${response?.length || 0} documents`);
+    return response;
+  },
+};

components/docugenerate/actions/list-templates/list-templates.mjs

@@ -0,0 +1,18 @@
+import app from "../../docugenerate.app.mjs";
+
+export default {
+  key: "docugenerate-list-templates",
+  name: "List Templates",
+  description: "Retrieves a list of all templates. [See the documentation](https://api.docugenerate.com/#/Template/queryTemplates)",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    app,
+  },
+  async run({ $ }) {
+    const response = await this.app.listTemplates($);
+
+    $.export("$summary", `Successfully retrieved ${response?.length || 0} templates`);
+    return response;
+  },
+};

components/docugenerate/actions/update-document/update-document.mjs

@@ -0,0 +1,30 @@
+import app from "../../docugenerate.app.mjs";
+
+export default {
+  key: "docugenerate-update-document",
+  name: "Update Document",
+  description: "Updates a specific document. [See the documentation](https://api.docugenerate.com/#/Document/updateDocument)",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    app,
+    documentId: {
+      type: "string",
+      label: "Document",
+      description: "The ID of the document",
+    },
+    name: {
+      type: "string",
+      label: "Name",
+      description: "The new name for the document",
+    },
+  },
+  async run({ $ }) {
+    const response = await this.app.updateDocument($, this.documentId, {
+      name: this.name,
+    });
+
+    $.export("$summary", `Successfully updated the document ${this.documentId}`);
+    return response;
+  },
+};

components/docugenerate/docugenerate.app.mjs

@@ -1,11 +1,99 @@
+import { axios } from "@pipedream/platform";
+
 export default {
   type: "app",
   app: "docugenerate",
-  propDefinitions: {},
+  propDefinitions: {
+    templateId: {
+      type: "string",
+      label: "Template",
+      description: "The selected template",
+      async options() {
+        const response = await this.listTemplates();
+        return response.map((template) => ({
+          label: template.name,
+          value: template.id,
+        }));
+      },
+    },
+  },
   methods: {
-    // this.$auth contains connected account data
-    authKeys() {
-      console.log(Object.keys(this.$auth));
+    getBaseUrl() {
+      return "https://api.docugenerate.com/v1";
+    },
+    getHeaders() {
+      return {
+        "Authorization": `${this.$auth.api_key}`,
+        "Content-Type": "application/json",
+      };
+    },
+    async makeRequest({
+      $ = this,
+      method = "GET",
+      path,
+      ...args
+    }) {
+      const config = {
+        method,
+        url: `${this.getBaseUrl()}${path}`,
+        headers: this.getHeaders(),
+        ...args,
+      };
+      return axios($, config);
+    },
+    async listTemplates($ = this) {
+      return this.makeRequest({
+        $,
+        path: "/template",
+      });
+    },
+    async getTemplate($ = this, templateId) {
+      return this.makeRequest({
+        $,
+        path: `/template/${templateId}`,
+      });
+    },
+    async deleteTemplate($ = this, templateId) {
+      return this.makeRequest({
+        $,
+        method: "DELETE",
+        path: `/template/${templateId}`,
+      });
+    },
+    async listDocuments($ = this, templateId) {
+      return this.makeRequest({
+        $,
+        path: `/document?template_id=${templateId}`,
+      });
+    },
+    async getDocument($ = this, documentId) {
+      return this.makeRequest({
+        $,
+        path: `/document/${documentId}`,
+      });
+    },
+    async updateDocument($ = this, documentId, body) {
+      return this.makeRequest({
+        $,
+        method: "PUT",
+        path: `/document/${documentId}`,
+        data: body,
+      });
+    },
+    async deleteDocument($ = this, documentId) {
+      return this.makeRequest({
+        $,
+        method: "DELETE",
+        path: `/document/${documentId}`,
+      });
+    },
+    async generateDocument($ = this, body) {
+      return this.makeRequest({
+        $,
+        method: "POST",
+        path: "/document",
+        data: body,
+      });
     },
   },
-};
+};