Create Shipment with Trunkrs API on New Download Counts from npm API

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

Trigger workflow on

New Download Counts from the npm API

Next, do this

Create Shipment with the Trunkrs 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 Trunkrs 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 Shipment action
1. Connect your Trunkrs account
2. Configure Order Reference
3. Configure Sender Name
4. Configure Sender Email Address
5. Configure Sender Street Address
6. Configure Sender Postal Code
7. Configure Sender City
8. Select a Country
9. Configure Recipient Name
10. Configure Recipient Email Address
11. Configure Recipient Street Address
12. Configure Recipient Postal Code
13. Configure Recipient City
14. Select a Country
15. Select a Parcel Weight Unit
16. Configure Parcel Weights
17. Optional- Select a Time Slot ID
18. Optional- Select a Service
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 Shipment on Trunkrs

Description:Create a new shipment. [See the documentation](https://docs.trunkrs.nl/docs/v2-api-documentation/85ba39933b755-create-shipment)

Version:0.0.1

Key:trunkrs-create-shipment

View on GitHub

Action Code#

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

export default {
  key: "trunkrs-create-shipment",
  name: "Create Shipment",
  description: "Create a new shipment. [See the documentation](https://docs.trunkrs.nl/docs/v2-api-documentation/85ba39933b755-create-shipment)",
  version: "0.0.1",
  type: "action",
  props: {
    trunkrs,
    orderReference: {
      type: "string",
      label: "Order Reference",
      description: "Internal order reference provided by customer, this must be unique",
    },
    senderName: {
      type: "string",
      label: "Sender Name",
      description: "The name of the sender",
    },
    senderEmailAddress: {
      type: "string",
      label: "Sender Email Address",
      description: "The email address of the sender",
    },
    senderStreetAddress: {
      type: "string",
      label: "Sender Street Address",
      description: "The street address of the sender",
    },
    senderPostalCode: {
      type: "string",
      label: "Sender Postal Code",
      description: "The postal code of the sender",
    },
    senderCity: {
      type: "string",
      label: "Sender City",
      description: "The city of the sender",
    },
    senderCountry: {
      propDefinition: [
        trunkrs,
        "country",
      ],
      description: "The country of the sender",
    },
    recipientName: {
      type: "string",
      label: "Recipient Name",
      description: "The name of the recipient",
    },
    recipientEmailAddress: {
      type: "string",
      label: "Recipient Email Address",
      description: "The email address of the recipient",
    },
    recipientStreetAddress: {
      type: "string",
      label: "Recipient Street Address",
      description: "The street address of the recipient",
    },
    recipientPostalCode: {
      type: "string",
      label: "Recipient Postal Code",
      description: "The postal code of the recipient",
    },
    recipientCity: {
      type: "string",
      label: "Recipient City",
      description: "The city of the recipient",
    },
    recipientCountry: {
      propDefinition: [
        trunkrs,
        "country",
      ],
    },
    parcelWeightUnit: {
      type: "string",
      label: "Parcel Weight Unit",
      description: "The unit of weight for the parcels",
      options: [
        "g",
        "kg",
      ],
    },
    parcelWeights: {
      type: "string[]",
      label: "Parcel Weights",
      description: "An array of weights for the parcels in the unit provided by the parcelWeightUnit prop",
    },
    timeSlotId: {
      propDefinition: [
        trunkrs,
        "timeSlotId",
        (c) => ({
          country: c.recipientCountry,
          postalCode: c.recipientPostalCode,
        }),
      ],
    },
    service: {
      type: "string",
      label: "Service",
      description: "Specifies the service level of this parcel. To use the freezer service, set the value to SAME_DAY_FROZEN_FOOD.",
      options: [
        "SAME_DAY",
        "SAME_DAY_FROZEN_FOOD",
      ],
      optional: true,
    },
  },
  async run({ $ }) {
    const { data } = await this.trunkrs.createShipment({
      $,
      data: {
        orderReference: this.orderReference,
        sender: {
          name: this.senderName,
          emailAddress: this.senderEmailAddress,
          address: this.senderStreetAddress,
          postalCode: this.senderPostalCode,
          city: this.senderCity,
          country: this.senderCountry,
        },
        recipient: {
          name: this.recipientName,
          emailAddress: this.recipientEmailAddress,
          address: this.recipientStreetAddress,
          postalCode: this.recipientPostalCode,
          city: this.recipientCity,
          country: this.recipientCountry,
        },
        parcel: this.parcelWeights.map((weight) => ({
          weight: {
            unit: this.parcelWeightUnit,
            value: +weight,
          },
        })),
        timeSlotId: this.timeSlotId,
        service: this.service,
      },
    });
    $.export("$summary", "Successfully created shipment.");
    return data;
  },
};

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
Trunkrs	`trunkrs`	`app`	This component uses the Trunkrs app.
Order Reference	`orderReference`	`string`	Internal order reference provided by customer, this must be unique
Sender Name	`senderName`	`string`	The name of the sender
Sender Email Address	`senderEmailAddress`	`string`	The email address of the sender
Sender Street Address	`senderStreetAddress`	`string`	The street address of the sender
Sender Postal Code	`senderPostalCode`	`string`	The postal code of the sender
Sender City	`senderCity`	`string`	The city of the sender
Country	`senderCountry`	`string`	Select a value from the drop down menu:`{ "value": "NL", "label": "Netherlands" }{ "value": "BE", "label": "Belgium" }`
Recipient Name	`recipientName`	`string`	The name of the recipient
Recipient Email Address	`recipientEmailAddress`	`string`	The email address of the recipient
Recipient Street Address	`recipientStreetAddress`	`string`	The street address of the recipient
Recipient Postal Code	`recipientPostalCode`	`string`	The postal code of the recipient
Recipient City	`recipientCity`	`string`	The city of the recipient
Country	`recipientCountry`	`string`	Select a value from the drop down menu:`{ "value": "NL", "label": "Netherlands" }{ "value": "BE", "label": "Belgium" }`
Parcel Weight Unit	`parcelWeightUnit`	`string`	Select a value from the drop down menu:`gkg`
Parcel Weights	`parcelWeights`	`string[]`	An array of weights for the parcels in the unit provided by the parcelWeightUnit prop
Time Slot ID	`timeSlotId`	`string`	Select a value from the drop down menu.
Service	`service`	`string`	Select a value from the drop down menu:`SAME_DAYSAME_DAY_FROZEN_FOOD`

Create Shipment with Trunkrs API on New Download Counts from npm API

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

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

Developers ♥ Pipedream

1-24of2,800+apps by most popular

1
-
24
of
2,800+
apps by most popular