Create Mail Check with OnlineCheckWriter API on New Download Counts from npm API

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

Trigger workflow on

New Download Counts from the npm API

Next, do this

Create Mail Check 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 Create Mail Check action
1. Connect your OnlineCheckWriter account
2. Optional- Configure Shipping To Custom Address?
3. Optional- Select a Custom From Address ID
4. Optional- Select a Custom To Address ID
5. Optional- Select a Custom Shipping Type ID
6. Select a Check ID
7. Select a Shipping Type ID
8. Select a Paper Type ID
9. Optional- Select a Inform Type ID
10. Optional- Configure Enable SMS Inform
11. Optional- Configure Enable Email Inform
12. Optional- Configure Payee Email
13. Optional- Configure Payee Phone
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#

Create Mail Check on OnlineCheckWriter

Description:Creates a mail check. [See the documentation](https://apiv3.onlinecheckwriter.com/#f4562b65-70e8-4c4d-8444-8898e61ab7f0).

Version:0.0.1

Key:onlinecheckwriter-create-mail-check

View on GitHub

Action Code#

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

export default {
  key: "onlinecheckwriter-create-mail-check",
  name: "Create Mail Check",
  description: "Creates a mail check. [See the documentation](https://apiv3.onlinecheckwriter.com/#f4562b65-70e8-4c4d-8444-8898e61ab7f0).",
  version: "0.0.1",
  type: "action",
  props: {
    app,
    isShippingToCustomAddress: {
      type: "boolean",
      label: "Shipping To Custom Address?",
      description: "Value is `true` if sending mail to custom address. Default `false`",
      optional: true,
    },
    customFromAddressId: {
      description: "Must be a custom from address ID. Required if **Shipping To Custom Address?** is `true`.",
      propDefinition: [
        app,
        "customFromAddressId",
      ],
    },
    customToAddressId: {
      description: "Must be a custom to address ID. Required if **Shipping To Custom Address?** is `true`.",
      propDefinition: [
        app,
        "customToAddressId",
      ],
    },
    customShippingTypeId: {
      label: "Custom Shipping Type ID",
      description: "Must be a valid custom shipping type ID. Required if **Shipping To Custom Address?** is `true`.",
      propDefinition: [
        app,
        "shippingTypeId",
      ],
    },
    checkId: {
      propDefinition: [
        app,
        "checkId",
      ],
    },
    shippingTypeId: {
      optional: false,
      description: "The shipping type ID of the check.",
      propDefinition: [
        app,
        "shippingTypeId",
      ],
    },
    paperTypeId: {
      propDefinition: [
        app,
        "paperTypeId",
      ],
    },
    informTypeId: {
      propDefinition: [
        app,
        "informTypeId",
      ],
    },
    enableSmsInform: {
      propDefinition: [
        app,
        "enableSmsInform",
      ],
    },
    enableEmailInform: {
      type: "boolean",
      label: "Enable Email Inform",
      description: "Value is `true` if email inform is enabled. Default `false`.",
      optional: true,
    },
    payeeEmail: {
      description: "Required if **Enable Email Inform** is `true` and there is no email on the associated payee.",
      propDefinition: [
        app,
        "payeeEmail",
      ],
    },
    payeePhone: {
      description: "Required if **Enable SMS Inform** is `true` and there is no phone on the associated payee.",
      propDefinition: [
        app,
        "payeePhone",
      ],
    },
  },
  methods: {
    createMailChecks(args = {}) {
      return this.app.post({
        path: "/mailchecks",
        ...args,
      });
    },
  },
  async run({ $ }) {
    const {
      createMailChecks,
      isShippingToCustomAddress,
      customFromAddressId,
      customToAddressId,
      customShippingTypeId,
      checkId,
      shippingTypeId,
      paperTypeId,
      informTypeId,
      enableSmsInform,
      enableEmailInform,
      payeeEmail,
      payeePhone,
    } = this;

    const response = await createMailChecks({
      $,
      data: {
        isShippingToCustomAddress,
        customFromAddressId,
        customToAddressId,
        customShippingTypeId,
        mailChecks: [
          {
            checkId,
            shippingTypeId,
            paperTypeId,
            informTypeId,
            ...(enableSmsInform !== undefined && {
              enableSmsInform: +enableSmsInform,
            }),
            ...(enableEmailInform !== undefined && {
              enableEmailInform: +enableEmailInform,
            }),
            payeeEmail,
            payeePhone,
          },
        ],
      },
    });
    $.export("$summary", "Successfully created and mailed checks.");
    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.
Shipping To Custom Address?	`isShippingToCustomAddress`	`boolean`	Value is `true` if sending mail to custom address. Default `false`
Custom From Address ID	`customFromAddressId`	`string`	Select a value from the drop down menu.
Custom To Address ID	`customToAddressId`	`string`	Select a value from the drop down menu.
Custom Shipping Type ID	`customShippingTypeId`	`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" }`
Check ID	`checkId`	`string`	Select a value from the drop down menu.
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" }`
Paper Type ID	`paperTypeId`	`string`	Select a value from the drop down menu:`{ "label": "Regular Check Paper", "value": "7" }{ "label": "Hollogram Check Paper", "value": "8" }{ "label": "Ultra Hollogram Check Paper", "value": "9" }`
Inform Type ID	`informTypeId`	`string`	Select a value from the drop down menu:`{ "label": "Notify Receiver by Sms", "value": "10" }`
Enable SMS Inform	`enableSmsInform`	`boolean`	Value is `true` if SMS inform is enabled. Default `false`
Enable Email Inform	`enableEmailInform`	`boolean`	Value is `true` if email inform is enabled. Default `false`.
Payee Email	`payeeEmail`	`string`	Required if Enable Email Inform is `true` and there is no email on the associated payee.
Payee Phone	`payeePhone`	`string`	Required if Enable SMS Inform is `true` and there is no phone on the associated payee.