@pipedream/click2mail2 0.0.1 → 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

@@ -0,0 +1,86 @@
+import FormData from "form-data";
+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: "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,
+    documentName: {
+      type: "string",
+      label: "Document Name",
+      description: "Document name as it will be stored in your account.",
+      optional: true,
+    },
+    documentFormat: {
+      type: "string",
+      label: "Document Format",
+      description: "The format of the document.",
+      options: FORMATS,
+    },
+    documentClass: {
+      propDefinition: [
+        click2mail2,
+        "documentClass",
+      ],
+    },
+    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,
+      file,
+      documentName,
+      documentFormat,
+      documentClass,
+    } = this;
+
+    const isUrl = file.startsWith("http://") || file.startsWith("https://");
+
+    const objToSend = {
+      params: {
+        documentName,
+        documentFormat,
+        documentClass,
+      },
+    };
+
+    if (!isUrl) {
+      const {
+        stream, metadata,
+      } = await getFileStreamAndMetadata(file);
+      const formData = new FormData();
+      formData.append("file", stream, {
+        contentType: metadata.contentType,
+        knownLength: metadata.size,
+        filename: metadata.name,
+      });
+
+      objToSend.data = formData;
+      objToSend.headers = formData.getHeaders();
+
+    } else {
+      objToSend.params.url = file;
+    }
+
+    const response = await click2mail2.create({
+      $,
+      path: `${!isUrl
+        ? "documents"
+        : "documents/url"}`,
+      ...objToSend,
+    });
+
+    $.export("$summary", `A new file with Id: ${response.id} was successfully created!`);
+    return response;
+  },
+};

package/actions/create-job/create-job.mjs

@@ -0,0 +1,196 @@
+import click2mail2 from "../../click2mail2.app.mjs";
+import {
+  COLOR,
+  ENVELOPE,
+  LAYOUT,
+  MAILCLASS,
+  PAPERTYPE,
+  PRINTOPTION,
+} from "../../common/constants.mjs";
+
+export default {
+  key: "click2mail2-create-job",
+  name: "Create Job",
+  version: "0.0.1",
+  description: "Creates a new new job in your account. [See the documentation](https://developers.click2mail.com/reference/post_2).",
+  type: "action",
+  props: {
+    click2mail2,
+    documentClass: {
+      propDefinition: [
+        click2mail2,
+        "documentClass",
+      ],
+    },
+    layout: {
+      type: "string",
+      label: "Layout",
+      description: "The specific type of the product",
+      options: LAYOUT,
+    },
+    envelope: {
+      type: "string",
+      label: "Envelope",
+      description: "If this is an enveloped product this determines the envelope in which the product is to be mailed; otherwise provide no value.",
+      options: ENVELOPE,
+    },
+    color: {
+      type: "string",
+      label: "Color",
+      description: "Print in color or black and white.",
+      options: COLOR,
+    },
+    paperType: {
+      type: "string",
+      label: "Paper Type",
+      description: "Sets the paper the mailing is to be printed on.",
+      options: PAPERTYPE,
+    },
+    printOption: {
+      type: "string",
+      label: "Print Option",
+      description: "Sets simplex or duplex printing.",
+      options: PRINTOPTION,
+    },
+    documentId: {
+      propDefinition: [
+        click2mail2,
+        "documentId",
+      ],
+      optional: true,
+    },
+    addressId: {
+      propDefinition: [
+        click2mail2,
+        "addressId",
+      ],
+      optional: true,
+    },
+    rtnName: {
+      type: "string",
+      label: "RTN Name",
+      description: "Return address Name.",
+      optional: true,
+    },
+    rtnOrganization: {
+      type: "string",
+      label: "RTN Organization",
+      description: "Return address Organization.",
+      optional: true,
+    },
+    rtnaddress1: {
+      type: "string",
+      label: "RTN Address1",
+      description: "Return address line 1.",
+      optional: true,
+    },
+    rtnaddress2: {
+      type: "string",
+      label: "RTN Address2",
+      description: "Return address line 2.",
+      optional: true,
+    },
+    rtnCity: {
+      type: "string",
+      label: "RTN City",
+      description: "Return address City.",
+      optional: true,
+    },
+    rtnState: {
+      type: "string",
+      label: "RTN State",
+      description: "Return address State.",
+      optional: true,
+    },
+    rtnZip: {
+      type: "string",
+      label: "RTN Zip",
+      description: "Return address Zip.",
+      optional: true,
+    },
+    mailClass: {
+      type: "string",
+      label: "Mail Class",
+      description: "Overrides the default of First Class for mailed products.",
+      options: MAILCLASS,
+      optional: true,
+    },
+    appSignature: {
+      type: "string",
+      label: "APP Signature",
+      description: "This is a short signature to identify orders that come from your app.",
+      optional: true,
+    },
+    projectId: {
+      propDefinition: [
+        click2mail2,
+        "projectId",
+      ],
+      optional: true,
+    },
+    mailingDate: {
+      type: "string",
+      label: "Mailing Date",
+      description: "Used to schedule the mailing date in the future. Format YYYYMMDD. If not provided the order will be mailed on the next available on the next business day. The business day cut off is 8PM EST.",
+      optional: true,
+    },
+    quantity: {
+      type: "string",
+      label: "Quantity",
+      description: "For products that do not use mailing lists. Quantity to print.",
+      optional: true,
+    },
+    jobDocumentId: {
+      propDefinition: [
+        click2mail2,
+        "jobDocumentId",
+        ({ documentId }) => ({
+          documentId,
+        }),
+      ],
+      optional: true,
+    },
+    jobAddressId: {
+      type: "string",
+      label: "Job Address Id",
+      description: "Address List Id of the job version.",
+      optional: true,
+    },
+    businessReplyAddressId: {
+      type: "integer",
+      label: "Business Reply Address Id",
+      description: "If you are mailing a business reply mail product use this to specify the busines reply address and permit information already in your account.",
+      optional: true,
+    },
+    courtesyReplyAddressId: {
+      type: "integer",
+      label: "Courtesy Reply Address Id",
+      description: "If you are mailing a courtesy reply mail product use this to specify a courtesy reply address already in your account.",
+      optional: true,
+    },
+    returnAddressId: {
+      type: "integer",
+      label: "Return Address Id",
+      description: "You may use the return address id to specify a return address already in your account.",
+      optional: true,
+    },
+  },
+  async run({ $ }) {
+    const {
+      click2mail2,
+      ...params
+    } = this;
+
+    const response = await click2mail2.create({
+      $,
+      path: "jobs",
+      params: {
+        productionTime: "Next Day",
+        ...params,
+      },
+    });
+
+    $.export("$summary", `A new job with Id: ${response.id} was successfully created!`);
+    return response;
+  },
+};

package/click2mail2.app.mjs

@@ -1,11 +1,143 @@
+import { axios } from "@pipedream/platform";
+import {
+  CLASSES, LIMIT,
+} from "./common/constants.mjs";
+
 export default {
   type: "app",
   app: "click2mail2",
-  propDefinitions: {},
+  propDefinitions: {
+    addressId: {
+      type: "string",
+      label: "Address Id",
+      description: "This required if the product required a recipient address list.",
+      async options({ page }) {
+        const { addressListsInfo } = await this.list({
+          path: "addressLists",
+          params: {
+            numberOfDocuments: LIMIT,
+            offset: page * LIMIT,
+          },
+        });
+
+        return addressListsInfo.map(({
+          id: value, name: label,
+        }) => ({
+          label,
+          value,
+        }));
+      },
+    },
+    documentClass: {
+      type: "string",
+      label: "Document Class",
+      description: "The general type of the document.",
+      options: CLASSES,
+    },
+    documentId: {
+      type: "string",
+      label: "Document Id",
+      description: "ID of the document to print",
+      async options({ page }) {
+        const { document } = await this.list({
+          path: "documents",
+          params: {
+            numberOfDocuments: LIMIT,
+            offset: page * LIMIT,
+          },
+        });
+
+        return document.map(({
+          id: value, name: label,
+        }) => ({
+          label,
+          value,
+        }));
+      },
+    },
+    jobDocumentId: {
+      type: "string",
+      label: "Job Document Id",
+      description: "Document ID of the job version of the document.",
+      async options({
+        page, documentId,
+      }) {
+        try {
+
+          const { documentJob } = await this.list({
+            path: "documents/jobDocuments",
+            params: {
+              numberOfDocuments: LIMIT,
+              offset: page * LIMIT,
+              documentId,
+            },
+          });
+
+          return documentJob.map(({
+            jobId: value, description, product,
+          }) => ({
+            label: description || product,
+            value,
+          }));
+        } catch (e) {
+          return [];
+        }
+      },
+    },
+    projectId: {
+      type: "integer",
+      label: "Project Id",
+      description: "Use to place this job in a pre-existing project in your account",
+      async options({ page }) {
+        const { projects } = await this.list({
+          path: "projects",
+          params: {
+            numberOfDocuments: LIMIT,
+            offset: page * LIMIT,
+          },
+        });
+
+        return projects.map(({
+          id: value, name: label,
+        }) => ({
+          label,
+          value,
+        }));
+      },
+    },
+  },
   methods: {
-    // this.$auth contains connected account data
-    authKeys() {
-      console.log(Object.keys(this.$auth));
+    _apiUrl() {
+      return `https://${this.$auth.subdomain}.click2mail.com/molpro`;
+    },
+    _getAuth() {
+      return {
+        "username": `${this.$auth.username}`,
+        "password": `${this.$auth.password}`,
+      };
+    },
+    _makeRequest({
+      $ = this, path, ...opts
+    }) {
+      const config = {
+        url: `${this._apiUrl()}/${path}`,
+        auth: this._getAuth(),
+        ...opts,
+      };
+
+      return axios($, config);
+    },
+    create(args = {}) {
+      return this._makeRequest({
+        method: "POST",
+        ...args,
+      });
+    },
+    list(args = {}) {
+      return this._makeRequest({
+        method: "GET",
+        ...args,
+      });
     },
   },
-};
+};

package/common/constants.mjs

@@ -0,0 +1,117 @@
+export const CLASSES = [
+  "Postcard 6 x 11",
+  "Postcard 5 x 8",
+  "Postcard 4.25 x 6",
+  "Postcard 3.5 x 5",
+  "Postcard 4 x 9",
+  "Postcard 6 x 9",
+  "Notecard 4.25 x 5.5",
+  "Notecard - Folded 4.25 x 5.5",
+  "Rack Card 4 x 9 - Mailed",
+  "Flyer 8.5 x 11",
+  "Brochure 11 x 8.5",
+  "Letter 8.5 x 11",
+  "Letter 8.5 x 14",
+  "Secure Self Mailer 8.5 x 11",
+  "Booklet Self Mailer 8.5 x 11",
+  "Booklet 8.5 x 11 - Address Front Page",
+  "Booklet 8.5 x 11 - Address Back Page",
+  "Reply Letter 8.5 x 11",
+  "Reply Postcard  4.25 x 6",
+  "Certified Letter 8.5 x 11",
+  "Certified Self Mailer 8.5 x 11",
+  "Certified Self Mailer - with Green Card Receipt",
+  "Priority Letter 8.5 x 11",
+  "Priority Mail Express Letter 8.5 x 11",
+  "EDDM Mailer 6.25 x 11",
+  "EDDM Mailer 6.5 x 9",
+  "EDDM Mailer 8.5 x 12",
+  "EDDM Mailer 8.5 x 11",
+  "Postcard 3.5 x 5 - Shipped",
+  "Brochure 11 x 8.5 - Shipped",
+  "Postcard 4.25 x 6 - Shipped",
+  "Postcard 5 x 8 - Shipped",
+  "Postcard 6 x 11 - Shipped",
+  "Postcard 6.5 x 9 - Shipped",
+  "Cardstock 12 x 4.5 - Shipped",
+  "Flyer 8.5 x 11 - Shipped",
+  "Postcard 4 x 9 - Shipped",
+  "Rack Card 4 x 9 - Shipped",
+  "Postcard 4.25 x 6 Movers Format",
+];
+
+export const COLOR = [
+  "Full Color",
+  "Black and White",
+];
+
+export const ENDROSEMENT = [
+  {
+    "label": "No Ancillary Endorsement",
+    "value": "NONE",
+  },
+  {
+    "label": "Address Service Requested",
+    "value": "ADDRESS_SERVICE_REQUESTED",
+  },
+  {
+    "label": "Forwarding Service Requested",
+    "value": "FORWARDING_SERVICE_REQUESTED",
+  },
+  {
+    "label": "Return Service Requested",
+    "value": "RETURN_SERVICE_REQUESTED",
+  },
+];
+
+export const ENVELOPE = [
+  "#10 Double Window",
+  "Best Fit",
+  "#10 Open Window Envelope",
+  "6 x 9.5 Double Window",
+  "6 x 9.5 Open Window",
+  "Flat Envelope",
+];
+
+export const FORMATS = [
+  "PDF",
+  "DOC",
+  "DOCX",
+  "PUB",
+  "PPT",
+  "PPTX",
+  "ODT",
+  "JPEG",
+  "JPG",
+  "PNG",
+];
+
+export const LAYOUT = [
+  "Address on Separate Page",
+  "Address on First Page",
+  "Picture and Address First Page",
+  "Address Back Page",
+];
+
+export const LIMIT = 100;
+
+export const MAILCLASS = [
+  "First Class",
+  "Standard",
+  "First Class Live Stamp",
+  "First Class Specialty Stamp",
+  "First Class No Move Update",
+];
+
+export const PAPERTYPE = [
+  "White 24#",
+  "Off-White 28#",
+  "Canary 24#",
+  "White 28#",
+  "White 28# Matte",
+];
+
+export const PRINTOPTION = [
+  "Printing One side",
+  "Printing both sides",
+];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pipedream/click2mail2",
-  "version": "0.0.1",
+  "version": "1.0.0",
   "description": "Pipedream Click2Mail Components",
   "main": "click2mail2.app.mjs",
   "keywords": [
@@ -11,5 +11,10 @@
   "author": "Pipedream <support@pipedream.com> (https://pipedream.com/)",
   "publishConfig": {
     "access": "public"
+  },
+  "dependencies": {
+    "@pipedream/platform": "^3.1.0",
+    "form-data": "^4.0.0",
+    "fs": "^0.0.1-security"
   }
 }