@pipedream/click2mail2 0.1.0 → 1.0.0

package/README.md

@@ -0,0 +1,11 @@
+# Overview
+
+The Click2Mail API enables automated mailing solutions, letting you integrate direct mail processes within your digital workflows. On Pipedream, you can harness this API to craft serverless workflows that interact with other apps and services. Create, manage, and send postal mail without leaving your digital ecosystem. Automate mail for marketing, invoicing, or any correspondence that requires a physical mail presence.
+
+# Example Use Cases
+
+- **Automated Invoice Mailing**: When a new invoice is created in your accounting software, such as QuickBooks, trigger a Pipedream workflow that sends the invoice details to Click2Mail. Click2Mail then prints and mails the invoice to the customer, streamlining the billing process.
+
+- **Postcard Marketing Campaign Trigger**: Use a CRM platform like HubSpot to trigger a Pipedream workflow when a new lead is added to a specific stage in your sales pipeline. The workflow then sends a custom postcard via Click2Mail, providing a personal touch to potential customers.
+
+- **Customer Thank You Notes**: After an order is marked as delivered in an e-commerce platform like Shopify, trigger a Pipedream workflow that sends a thank you note through Click2Mail. This gesture can enhance customer satisfaction and encourage repeat business.

package/actions/create-document/create-document.mjs

@@ -1,26 +1,16 @@
 import FormData from "form-data";
-import fs from "fs";
+import { getFileStreamAndMetadata } from "@pipedream/platform";
 import click2mail2 from "../../click2mail2.app.mjs";
 import { FORMATS } from "../../common/constants.mjs";
 
 export default {
   key: "click2mail2-create-document",
   name: "Create Document",
-  version: "0.0.1",
+  version: "1.0.0",
   description: "Creates a new document in your account from an uploaded file or a URL. [See the documentation for file](https://developers.click2mail.com/reference/createdocument_1).  [See the documentation for URL](https://developers.click2mail.com/reference/createdocumentfromurl)",
   type: "action",
   props: {
     click2mail2,
-    uploadType: {
-      type: "string",
-      label: "Upload Type",
-      description: "The type of the upload.",
-      reloadProps: true,
-      options: [
-        "URL",
-        "File",
-      ],
-    },
     documentName: {
       type: "string",
       label: "Document Name",
@@ -39,49 +29,54 @@ export default {
         "documentClass",
       ],
     },
-  },
-  async additionalProps() {
-    const props = {};
-    if (this.uploadType === "URL") {
-      props.url = {
-        type: "string",
-        label: "URL",
-        description: "Document url",
-      };
-    } else {
-      props.file = {
-        type: "string",
-        label: "File",
-        description: "Path of the file in /tmp folder. To upload a file to /tmp folder, please follow the [doc here](https://pipedream.com/docs/code/nodejs/working-with-files/#writing-a-file-to-tmp)",
-      };
-    }
-    return props;
+    file: {
+      type: "string",
+      label: "File Path Or Url",
+      description: "Provide either a file URL or a path to a file in the `/tmp` directory (for example, `/tmp/myFile.pdf`).",
+    },
   },
   async run({ $ }) {
     const {
       click2mail2,
-      uploadType,
       file,
-      ...params
+      documentName,
+      documentFormat,
+      documentClass,
     } = this;
 
-    let objToSend = {};
+    const isUrl = file.startsWith("http://") || file.startsWith("https://");
+
+    const objToSend = {
+      params: {
+        documentName,
+        documentFormat,
+        documentClass,
+      },
+    };
 
-    if (uploadType === "File") {
+    if (!isUrl) {
+      const {
+        stream, metadata,
+      } = await getFileStreamAndMetadata(file);
       const formData = new FormData();
-      formData.append("file", fs.createReadStream(file));
+      formData.append("file", stream, {
+        contentType: metadata.contentType,
+        knownLength: metadata.size,
+        filename: metadata.name,
+      });
 
-      objToSend = {
-        data: formData,
-        headers: formData.getHeaders(),
-      };
+      objToSend.data = formData;
+      objToSend.headers = formData.getHeaders();
+
+    } else {
+      objToSend.params.url = file;
     }
+
     const response = await click2mail2.create({
       $,
-      path: `${uploadType === "File"
+      path: `${!isUrl
         ? "documents"
         : "documents/url"}`,
-      params,
       ...objToSend,
     });
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pipedream/click2mail2",
-  "version": "0.1.0",
+  "version": "1.0.0",
   "description": "Pipedream Click2Mail Components",
   "main": "click2mail2.app.mjs",
   "keywords": [
@@ -13,7 +13,7 @@
     "access": "public"
   },
   "dependencies": {
-    "@pipedream/platform": "^1.5.1",
+    "@pipedream/platform": "^3.1.0",
     "form-data": "^4.0.0",
     "fs": "^0.0.1-security"
   }