Create Supplier with Clear Books API on New Package Version from npm API

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

Trigger workflow on

New Package Version from the npm API

Next, do this

Create Supplier with the Clear Books 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 Clear Books action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Package Version trigger
1. Connect your npm account
2. Configure timer
3. Configure Package
Configure the Create Supplier action
1. Connect your Clear Books account
2. Configure Name
3. Optional- Configure Email
4. Optional- Configure Phone
5. Optional- Configure Street Address
6. Optional- Configure Town
7. Optional- Configure County
8. Optional- Configure Postcode
9. Optional- Configure Country Code
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 Package Version on npm

Description:Emit new event when a new version of an npm package is published. [See the documentation](https://github.com/npm/registry/blob/main/docs/responses/package-metadata.md)

Version:0.0.1

Key:npm-new-package-version

View on GitHub

Trigger Code#

import { DEFAULT_POLLING_SOURCE_TIMER_INTERVAL } from "@pipedream/platform";
import app from "../../npm.app.mjs";

export default {
  key: "npm-new-package-version",
  name: "New Package Version",
  description: "Emit new event when a new version of an npm package is published. [See the documentation](https://github.com/npm/registry/blob/main/docs/responses/package-metadata.md)",
  version: "0.0.1",
  type: "source",
  dedupe: "unique",
  props: {
    app,
    db: "$.service.db",
    timer: {
      type: "$.interface.timer",
      default: {
        intervalSeconds: DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
      },
    },
    packageName: {
      type: "string",
      label: "Package",
      description: "Enter an npm package name. Leave blank for all",
      default: "@pipedream/platform",
    },
  },
  async run() {
    const {
      app,
      packageName,
    } = this;

    const response = await app.getPackageMetadata({
      debug: true,
      packageName,
    });

    const { "dist-tags": { latest: latestVersion } } = response;

    this.$emit(response, {
      id: latestVersion,
      summary: `New Package Version ${latestVersion}`,
      ts: Date.parse(response.modified),
    });
  },
};

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`
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 Supplier on Clear Books

Description:Creates a new supplier in Clear Books. [See the documentation](https://u.pcloud.link/publink/show?code=XZkThJ5Z4zKewgCL6VBpfxlPeHPDdXXj0Cc7)

Version:0.0.2

Key:clear_books-create-supplier

View on GitHub

Action Code#

import clearBooks from "../../clear_books.app.mjs";

export default {
  key: "clear_books-create-supplier",
  name: "Create Supplier",
  description: "Creates a new supplier in Clear Books. [See the documentation](https://u.pcloud.link/publink/show?code=XZkThJ5Z4zKewgCL6VBpfxlPeHPDdXXj0Cc7)",
  version: "0.0.2",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: false,
  },
  type: "action",
  props: {
    clearBooks,
    name: {
      type: "string",
      label: "Name",
      description: "Name of the supplier",
    },
    email: {
      type: "string",
      label: "Email",
      description: "Email address of the supplier",
      optional: true,
    },
    phone: {
      type: "string",
      label: "Phone",
      description: "Phone number of the supplier",
      optional: true,
    },
    streetAddress: {
      type: "string",
      label: "Street Address",
      description: "Street address of the supplier",
      optional: true,
    },
    town: {
      type: "string",
      label: "Town",
      description: "Town of the supplier",
      optional: true,
    },
    county: {
      type: "string",
      label: "County",
      description: "County of the supplier",
      optional: true,
    },
    postcode: {
      type: "string",
      label: "Postcode",
      description: "Postcode of the supplier",
      optional: true,
    },
    countryCode: {
      type: "string",
      label: "Country Code",
      description: "Country code of the supplier",
      optional: true,
    },
  },
  async run({ $ }) {
    const hasAddress = this.streetAddress
      || this.town
      || this.county
      || this.postcode
      || this.countryCode;

    const response = await this.clearBooks.createSupplier({
      $,
      data: {
        name: this.name,
        email: this.email,
        phone: this.phone,
        address: hasAddress && {
          line1: this.streetAddress,
          town: this.town,
          county: this.county,
          postcode: this.postcode,
          countryCode: this.countryCode,
        },
      },
    });
    $.export("$summary", `Successfully created supplier 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
Clear Books	`clearBooks`	`app`	This component uses the Clear Books app.
Name	`name`	`string`	Name of the supplier
Email	`email`	`string`	Email address of the supplier
Phone	`phone`	`string`	Phone number of the supplier
Street Address	`streetAddress`	`string`	Street address of the supplier
Town	`town`	`string`	Town of the supplier
County	`county`	`string`	County of the supplier
Postcode	`postcode`	`string`	Postcode of the supplier
Country Code	`countryCode`	`string`	Country code of the supplier

Action Authentication#

Clear Books uses OAuth authentication. When you connect your Clear Books account, Pipedream will open a popup window where you can sign into Clear Books and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any Clear Books API.

Pipedream requests the following authorization scopes when you connect your account:

businesses:readaccounting.customers:readaccounting.customers:writeaccounting.suppliers:readaccounting.suppliers:writeaccounting.purchases:readaccounting.purchases:writeaccounting.transactions:read