Mail PDF Document with OnlineCheckWriter API on New Download Counts from npm API

Pipedream makes it easy to connect APIs for OnlineCheckWriter, npm and 2,900+ other apps remarkably fast.

Trigger workflow on

New Download Counts from the npm API

Next, do this

Mail PDF Document with the OnlineCheckWriter API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Getting Started#

This integration creates a workflow with a npm trigger and OnlineCheckWriter action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Download Counts trigger
1. Connect your npm account
2. Configure timer
3. Select a Period
4. Optional- Configure Package
Configure the Mail PDF Document action
1. Connect your OnlineCheckWriter account
2. Optional- Configure Document Title
3. Configure File Path or URL
4. Select a Shipping Type ID
5. Optional- Configure Sender Name
6. Optional- Configure Sender Company
7. Optional- Configure Sender Address 1
8. Optional- Configure Sender Address 2
9. Optional- Configure Sender City
10. Optional- Configure Sender State
11. Optional- Configure Sender Zip
12. Optional- Configure Sender Phone
13. Optional- Configure Sender Email
14. Configure Destination Name
15. Optional- Configure Destination Company
16. Configure Destination Address 1
17. Optional- Configure Destination Address 2
18. Configure Destination City
19. Configure Destination State
20. Configure Destination Zip
21. Optional- Configure Destination Phone
22. Optional- Configure Destination Email
23. Optional- Configure syncDir
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Details#

This integration uses pre-built, source-available components from Pipedream's GitHub repo. These components are developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Trigger#

New Download Counts on npm

Description:Emit new event with the latest count of downloads for an npm package. [See the documentation](https://github.com/npm/registry/blob/main/docs/download-counts.md).

Version:0.1.0

Key:npm-download-counts

View on GitHub

Trigger Code#

import app from "../../npm.app.mjs";

export default {
  key: "npm-download-counts",
  name: "New Download Counts",
  description: "Emit new event with the latest count of downloads for an npm package. [See the documentation](https://github.com/npm/registry/blob/main/docs/download-counts.md).",
  version: "0.1.0",
  type: "source",
  props: {
    app,
    db: "$.service.db",
    timer: {
      type: "$.interface.timer",
      description: "One day interval time is recommended because NPM only update metrics once a day. [See the documentation](https://github.com/npm/registry/blob/main/docs/download-counts.md#data-source).",
      default: {
        intervalSeconds: 60 * 60 * 24,
      },
    },
    period: {
      type: "string",
      label: "Period",
      description: "Select last-day, last-week or last-month.",
      optional: false,
      default: "last-day",
      options: [
        "last-day",
        "last-week",
        "last-month",
      ],
    },
    packageName: {
      type: "string",
      label: "Package",
      description: "Enter an npm package name. Leave blank for all",
      optional: true,
    },
  },
  methods: {
    getDownloadCounts({
      period, packageName, ...args
    } = {}) {
      const basePath = `/downloads/point/${encodeURIComponent(period)}`;
      return this.app.makeRequest({
        path: packageName
          ? `${basePath}/${encodeURIComponent(packageName)}`
          : basePath,
        ...args,
      });
    },
  },
  async run({ timestamp: ts }) {
    const {
      getDownloadCounts,
      period,
      packageName,
    } = this;

    const response = await getDownloadCounts({
      period,
      packageName,
    });

    this.$emit(response, {
      id: ts,
      summary: `New Download Count ${response.downloads}`,
      ts,
    });
  },
};

Trigger Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.

Label	Prop	Type	Description
npm	`app`	`app`	This component uses the npm app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`	One day interval time is recommended because NPM only update metrics once a day. See the documentation
Period	`period`	`string`	Select a value from the drop down menu:`last-daylast-weeklast-month`
Package	`packageName`	`string`	Enter an npm package name. Leave blank for all

Trigger Authentication#

The npm API does not require authentication.

About npm#

Node package manager

Action#

Mail PDF Document on OnlineCheckWriter

Description:Mails a PDF document to a destination. [See the documentation](https://apiv3.onlinecheckwriter.com/#878daf05-e36e-44a2-bce8-15f24d72f82e).

Version:0.1.2

Key:onlinecheckwriter-mail-pdf-document

View on GitHub

Action Code#

import FormData from "form-data";
import { getFileStreamAndMetadata } from "@pipedream/platform";
import app from "../../onlinecheckwriter.app.mjs";

export default {
  key: "onlinecheckwriter-mail-pdf-document",
  name: "Mail PDF Document",
  description: "Mails a PDF document to a destination. [See the documentation](https://apiv3.onlinecheckwriter.com/#878daf05-e36e-44a2-bce8-15f24d72f82e).",
  version: "0.1.2",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: false,
  },
  type: "action",
  props: {
    app,
    documentTitle: {
      type: "string",
      label: "Document Title",
      description: "The title of the document.",
      optional: true,
    },
    filePath: {
      type: "string",
      label: "File Path or URL",
      description: "The PDF file to upload. Provide either a file URL or a path to a file in the `/tmp` directory (for example, `/tmp/myFile.pdf`)",
    },
    shippingTypeId: {
      optional: false,
      propDefinition: [
        app,
        "shippingTypeId",
      ],
    },
    senderName: {
      type: "string",
      label: "Sender Name",
      description: "The name of the sender.",
      optional: true,
    },
    senderCompany: {
      type: "string",
      label: "Sender Company",
      description: "The company of the sender.",
      optional: true,
    },
    senderAddress1: {
      type: "string",
      label: "Sender Address 1",
      description: "The first line of the sender's address.",
      optional: true,
    },
    senderAddress2: {
      type: "string",
      label: "Sender Address 2",
      description: "The second line of the sender's address.",
      optional: true,
    },
    senderCity: {
      type: "string",
      label: "Sender City",
      description: "The city of the sender.",
      optional: true,
    },
    senderState: {
      type: "string",
      label: "Sender State",
      description: "The state of the sender.",
      optional: true,
    },
    senderZip: {
      type: "string",
      label: "Sender Zip",
      description: "The zip code of the sender.",
      optional: true,
    },
    senderPhone: {
      type: "string",
      label: "Sender Phone",
      description: "The phone number of the sender.",
      optional: true,
    },
    senderEmail: {
      type: "string",
      label: "Sender Email",
      description: "The email address of the sender.",
      optional: true,
    },
    destinationName: {
      type: "string",
      label: "Destination Name",
      description: "The name of the recipient.",
    },
    destinationCompany: {
      type: "string",
      label: "Destination Company",
      description: "The company of the recipient.",
      optional: true,
    },
    destinationAddress1: {
      type: "string",
      label: "Destination Address 1",
      description: "The first line of the recipient's address.",
    },
    destinationAddress2: {
      type: "string",
      label: "Destination Address 2",
      description: "The second line of the recipient's address.",
      optional: true,
    },
    destinationCity: {
      type: "string",
      label: "Destination City",
      description: "The city of the recipient.",
    },
    destinationState: {
      type: "string",
      label: "Destination State",
      description: "The state of the recipient. Use 2 characters Eg. `Tx` instead of `Texas` for example.",
    },
    destinationZip: {
      type: "string",
      label: "Destination Zip",
      description: "The zip code of the recipient.",
    },
    destinationPhone: {
      type: "string",
      label: "Destination Phone",
      description: "The phone number of the recipient.",
      optional: true,
    },
    destinationEmail: {
      type: "string",
      label: "Destination Email",
      description: "The email address of the recipient.",
      optional: true,
    },
    syncDir: {
      type: "dir",
      accessMode: "read",
      sync: true,
      optional: true,
    },
  },
  methods: {
    mailPdfDocument(args = {}) {
      return this.app.post({
        path: "/documentmailing/mail",
        ...args,
      });
    },
  },
  async run({ $ }) {
    const {
      mailPdfDocument,
      documentTitle,
      filePath,
      shippingTypeId,
      senderName,
      senderCompany,
      senderAddress1,
      senderAddress2,
      senderCity,
      senderState,
      senderZip,
      senderPhone,
      senderEmail,
      destinationName,
      destinationCompany,
      destinationAddress1,
      destinationAddress2,
      destinationCity,
      destinationState,
      destinationZip,
      destinationPhone,
      destinationEmail,
    } = this;

    const data = new FormData();
    const {
      stream, metadata,
    } = await getFileStreamAndMetadata(filePath);
    data.append("document_details[file]", stream, {
      contentType: metadata.contentType,
      knownLength: metadata.size,
      filename: metadata.name,
    });
    data.append("document_details[title]", documentTitle || "");
    data.append("shipping[shippingTypeId]", shippingTypeId || "");
    data.append("destination[name]", destinationName || "");
    data.append("destination[company]", destinationCompany || "");
    data.append("destination[address1]", destinationAddress1 || "");
    data.append("destination[address2]", destinationAddress2 || "");
    data.append("destination[city]", destinationCity || "");
    data.append("destination[state]", destinationState || "");
    data.append("destination[zip]", destinationZip || "");
    data.append("destination[phone]", destinationPhone || "");
    data.append("destination[email]", destinationEmail || "");
    data.append("from_address[name]", senderName || "");
    data.append("from_address[company]", senderCompany || "");
    data.append("from_address[address1]", senderAddress1 || "");
    data.append("from_address[address2]", senderAddress2 || "");
    data.append("from_address[city]", senderCity || "");
    data.append("from_address[state]", senderState || "");
    data.append("from_address[zip]", senderZip || "");
    data.append("from_address[phone]", senderPhone || "");
    data.append("from_address[email]", senderEmail || "");
    const response = await mailPdfDocument({
      $,
      data,
      headers: data.getHeaders(),
    });

    $.export("$summary", "Successfully generated and mailed PDF document");
    return response;
  },
};

Action Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI.

Label	Prop	Type	Description
OnlineCheckWriter	`app`	`app`	This component uses the OnlineCheckWriter app.
Document Title	`documentTitle`	`string`	The title of the document.
File Path or URL	`filePath`	`string`	The PDF file to upload. Provide either a file URL or a path to a file in the `/tmp` directory (for example, `/tmp/myFile.pdf`)
Shipping Type ID	`shippingTypeId`	`string`	Select a value from the drop down menu:`{ "label": "First Class", "value": "1" }{ "label": "First Class with Tracking", "value": "3" }{ "label": "Priority Mail", "value": "4" }{ "label": "Express Mail", "value": "5" }{ "label": "Standard Overnight -Fedex-By 3pm the next business day", "value": "12" }{ "label": "Fedex Saturday Delivery", "value": "20" }`
Sender Name	`senderName`	`string`	The name of the sender.
Sender Company	`senderCompany`	`string`	The company of the sender.
Sender Address 1	`senderAddress1`	`string`	The first line of the sender's address.
Sender Address 2	`senderAddress2`	`string`	The second line of the sender's address.
Sender City	`senderCity`	`string`	The city of the sender.
Sender State	`senderState`	`string`	The state of the sender.
Sender Zip	`senderZip`	`string`	The zip code of the sender.
Sender Phone	`senderPhone`	`string`	The phone number of the sender.
Sender Email	`senderEmail`	`string`	The email address of the sender.
Destination Name	`destinationName`	`string`	The name of the recipient.
Destination Company	`destinationCompany`	`string`	The company of the recipient.
Destination Address 1	`destinationAddress1`	`string`	The first line of the recipient's address.
Destination Address 2	`destinationAddress2`	`string`	The second line of the recipient's address.
Destination City	`destinationCity`	`string`	The city of the recipient.
Destination State	`destinationState`	`string`	The state of the recipient. Use 2 characters Eg. `Tx` instead of `Texas` for example.
Destination Zip	`destinationZip`	`string`	The zip code of the recipient.
Destination Phone	`destinationPhone`	`string`	The phone number of the recipient.
Destination Email	`destinationEmail`	`string`	The email address of the recipient.
syncDir	`syncDir`	`dir`