Send Announcement with Textline API on New Download Counts from npm API

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

Trigger workflow on

New Download Counts from the npm API

Next, do this

Send Announcement with the Textline 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 Textline 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 Send Announcement action
1. Connect your Textline account
2. Select a Mass Text Group UUID
3. Configure Mass Text Comment Body
4. Configure Mass Text Title
5. Select a Selection Type
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#

Send Announcement on Textline

Description:Send an announcement to a group of contacts. [See the documentation](https://textline.docs.apiary.io/#reference/messaging-tools/announcements/send-an-announcement).

Version:0.0.2

Key:textline-send-announcement

View on GitHub

Action Code#

import app from "../../textline.app.mjs";
import constants from "../../common/constants.mjs";

export default {
  key: "textline-send-announcement",
  name: "Send Announcement",
  description: "Send an announcement to a group of contacts. [See the documentation](https://textline.docs.apiary.io/#reference/messaging-tools/announcements/send-an-announcement).",
  version: "0.0.2",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: false,
  },
  type: "action",
  props: {
    app,
    massTextGroupUuid: {
      label: "Mass Text Group UUID",
      description: "The UUID of the mass text group.",
      propDefinition: [
        app,
        "groupUuid",
      ],
    },
    massTextCommentBody: {
      type: "string",
      label: "Mass Text Comment Body",
      description: "The content of the message to send.",
    },
    massTextTitle: {
      type: "string",
      label: "Mass Text Title",
      description: "The title of the message.",
    },
    selectionType: {
      type: "string",
      label: "Selection Type",
      description: "The type of the selection for the announcement.",
      reloadProps: true,
      options: Object.values(constants.SELECTION_TYPE),
    },
  },
  additionalProps() {
    const { selectionType } = this;

    if (selectionType === constants.SELECTION_TYPE.TAGS.value) {
      return {
        tag: {
          type: "string",
          label: "Tag",
          description: "Send to all contacts with this tag.",
        },
      };
    }

    if (selectionType === constants.SELECTION_TYPE.PHONE_NUMBERS.value) {
      return {
        phoneNumbers: {
          type: "string[]",
          label: "Phone Numbers",
          description: "The phone numbers to send the announcement to.",
          useQuery: true,
          options: async ({
            page, query,
          }) => {
            const { customers } = await this.app.listCustomers({
              params: {
                page,
                page_size: 30,
                query: query || "",
              },
            });
            return customers.map(({
              name: label, phone_number: value,
            }) => ({
              label,
              value,
            }));
          },
        },
      };
    }

    return {};
  },
  methods: {
    sendAnnouncement(args = {}) {
      return this.app.post({
        path: "/announcements",
        ...args,
      });
    },
  },
  async run({ $ }) {
    const {
      sendAnnouncement,
      selectionType,
      massTextGroupUuid,
      massTextCommentBody,
      massTextTitle,
      tag,
      phoneNumbers,
    } = this;

    const response = await sendAnnouncement({
      $,
      data: {
        selection_type: selectionType,
        recipients: {
          tag,
          phone_numbers: phoneNumbers,
        },
        mass_text: {
          group_uuid: massTextGroupUuid,
          comment_body: massTextCommentBody,
          title: massTextTitle,
        },
      },
    });

    $.export("$summary", "Successfully sent the announcement.");
    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
Textline	`app`	`app`	This component uses the Textline app.
Mass Text Group UUID	`massTextGroupUuid`	`string`	Select a value from the drop down menu.
Mass Text Comment Body	`massTextCommentBody`	`string`	The content of the message to send.
Mass Text Title	`massTextTitle`	`string`	The title of the message.
Selection Type	`selectionType`	`string`	Select a value from the drop down menu:`{ "label": "Tags", "value": "tags" }{ "label": "Phone Numbers", "value": "phone_numbers" }`