Update Pass with WalleTap API on New Download Counts from npm API

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

Trigger workflow on

New Download Counts from the npm API

Next, do this

Update Pass with the WalleTap 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 WalleTap 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 Update Pass action
1. Connect your WalleTap account
2. Configure Pass ID
3. Optional- Configure Template Fields
4. Optional- Configure Member ID
5. Optional- Configure Custom Fields
6. Optional- Configure Redemption Value
7. Optional- Configure Valid
8. Optional- Configure Email
9. Optional- Configure 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#

Update Pass on WalleTap

Description:Updates an existing Walletap pass and pushes the updated pass to the user. [See the documentation](https://walletap.io/docs/api#tag/Pass/operation/updatePass)

Version:0.0.1

Key:walletap-update-pass

View on GitHub

Action Code#

import { parseObject } from "../../common/utils.mjs";
import walletap from "../../walletap.app.mjs";

export default {
  key: "walletap-update-pass",
  name: "Update Pass",
  description: "Updates an existing Walletap pass and pushes the updated pass to the user. [See the documentation](https://walletap.io/docs/api#tag/Pass/operation/updatePass)",
  version: "0.0.1",
  type: "action",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: false,
  },
  props: {
    walletap,
    passId: {
      type: "string",
      label: "Pass ID",
      description: "Walletap generated pass ID",
    },
    templateFields: {
      type: "object",
      label: "Template Fields",
      description: "The template fields to update. Generic (object) or Loyalty (object) or Gift Card (object) or Event Ticket (object) or Offer/Coupon (object)",
      optional: true,
    },
    memberId: {
      type: "string",
      label: "Member ID",
      description: "The ID connecting this pass to a member in your system",
      optional: true,
    },
    customFields: {
      type: "object",
      label: "Custom Fields",
      description: "Custom fields defined in pass design, using field IDs as object keys",
      optional: true,
    },
    redemptionValue: {
      type: "string",
      label: "Redemption Value",
      description: "Value to be encoded in barcode and/or NFC payload. If not provided, it is set to `externalId`. If also not provided, it is set to Walletap generated `id`",
      optional: true,
    },
    isValid: {
      type: "boolean",
      label: "Valid",
      description: "If set to `false` it invalidates the pass and moves it to the \"Expired passes\" section in user Wallet",
      optional: true,
    },
    email: {
      type: "string",
      label: "Email",
      description: "The email of the user",
      optional: true,
    },
    phone: {
      type: "string",
      label: "Phone",
      description: "The phone of the user",
      optional: true,
    },
  },
  async run({ $ }) {
    const response = await this.walletap.updatePass({
      $,
      data: {
        id: this.passId,
        templateFields: parseObject(this.templateFields),
        memberId: this.memberId,
        customFields: parseObject(this.customFields),
        redemptionValue: this.redemptionValue,
        isValid: this.isValid,
        email: this.email,
        phone: this.phone,
      },
    });

    $.export("$summary", `Successfully updated pass with id: ${response.id}`);
    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
WalleTap	`walletap`	`app`	This component uses the WalleTap app.
Pass ID	`passId`	`string`	Walletap generated pass ID
Template Fields	`templateFields`	`object`	The template fields to update. Generic (object) or Loyalty (object) or Gift Card (object) or Event Ticket (object) or Offer/Coupon (object)
Member ID	`memberId`	`string`	The ID connecting this pass to a member in your system
Custom Fields	`customFields`	`object`	Custom fields defined in pass design, using field IDs as object keys
Redemption Value	`redemptionValue`	`string`	Value to be encoded in barcode and/or NFC payload. If not provided, it is set to `externalId`. If also not provided, it is set to Walletap generated `id`
Valid	`isValid`	`boolean`	If set to `false` it invalidates the pass and moves it to the "Expired passes" section in user Wallet
Email	`email`	`string`	The email of the user
Phone	`phone`	`string`	The phone of the user