Create Proposal with Offorte API on New Download Counts from npm API

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

Trigger workflow on

New Download Counts from the npm API

Next, do this

Create Proposal with the Offorte 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 Offorte 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 Proposal action
1. Connect your Offorte account
2. Optional- Select a Account User ID
3. Optional- Select one or more Contact People IDs
4. Select a Contact ID
5. Select a Proposal Template ID
6. Select a Design Template ID
7. Optional- Configure Name
8. Optional- Configure Price Total
9. Select a Status
10. Select a Text Template ID
11. Optional- Configure Content
12. Optional- Select one or more Tags
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 Proposal on Offorte

Description:Create a new proposal in Offorte. [See the documentation](https://www.offorte.com/api-docs/api#tag/Proposals/operation/createProposal)

Version:0.0.1

Key:offorte-create-proposal

View on GitHub

Action Code#

import { STATUS_OPTIONS } from "../../common/constants.mjs";
import {
  clearObject, parseObject,
} from "../../common/utils.mjs";
import offorte from "../../offorte.app.mjs";

export default {
  key: "offorte-create-proposal",
  name: "Create Proposal",
  description: "Create a new proposal in Offorte. [See the documentation](https://www.offorte.com/api-docs/api#tag/Proposals/operation/createProposal)",
  version: "0.0.1",
  type: "action",
  props: {
    offorte,
    accountUserId: {
      propDefinition: [
        offorte,
        "userId",
      ],
      label: "Account User ID",
      optional: true,
    },
    contactPeople: {
      propDefinition: [
        offorte,
        "contactId",
      ],
      optional: true,
      type: "string[]",
      label: "Contact People IDs",
      description: "List with people who are going to receive the proposal. These are the contacts belonging to an organisation who are going to receive the proposal. Make sure they got an email filled in.",
    },
    contactId: {
      propDefinition: [
        offorte,
        "contactId",
        () => ({
          fieldId: "contact_id",
        }),
      ],
      description: "The proposal is assigned to this main contact id",
    },
    proposalTemplateId: {
      propDefinition: [
        offorte,
        "proposalTemplateId",
      ],
    },
    designTemplateId: {
      propDefinition: [
        offorte,
        "designTemplateId",
      ],
    },
    name: {
      type: "string",
      label: "Name",
      description: "The name of the proposal",
      optional: true,
    },
    priceTotal: {
      type: "string",
      label: "Price Total",
      description: "Proposal value as calculated by pricetables",
      optional: true,
    },
    status: {
      type: "string",
      label: "Status",
      description: "The status of the proposal",
      options: STATUS_OPTIONS,
    },
    textTemplateId: {
      propDefinition: [
        offorte,
        "textTemplateId",
      ],
    },
    content: {
      type: "string[]",
      label: "Content",
      description: "A list of content items of the proposal. [See the documentation](https://www.offorte.com/api-docs/api#tag/Proposals/operation/createProposal)",
      optional: true,
    },
    tags: {
      propDefinition: [
        offorte,
        "tags",
      ],
      optional: true,
    },
  },
  async run({ $ }) {
    const response = await this.offorte.createProposal({
      $,
      data: clearObject({
        account_user_id: this.accountUserId,
        contact_people: parseObject(this.contactPeople),
        contact_id: this.contactId,
        proposal_template_id: this.proposalTemplateId,
        design_template_id: this.designTemplateId,
        name: this.name,
        price_total: this.priceTotal && parseFloat(this.priceTotal),
        status: this.status,
        text_template_id: this.textTemplateId,
        content: parseObject(this.content),
        tags: parseObject(this.tags),
      }),
    });

    $.export("$summary", `Created proposal 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
Offorte	`offorte`	`app`	This component uses the Offorte app.
Account User ID	`accountUserId`	`string`	Select a value from the drop down menu.
Contact People IDs	`contactPeople`	`string[]`	Select a value from the drop down menu.
Contact ID	`contactId`	`string`	Select a value from the drop down menu.
Proposal Template ID	`proposalTemplateId`	`string`	Select a value from the drop down menu.
Design Template ID	`designTemplateId`	`string`	Select a value from the drop down menu.
Name	`name`	`string`	The name of the proposal
Price Total	`priceTotal`	`string`	Proposal value as calculated by pricetables
Status	`status`	`string`	Select a value from the drop down menu:`{ "label": "Edit", "value": "edit" }{ "label": "Open", "value": "open" }{ "label": "Won", "value": "won" }{ "label": "Lost", "value": "lost" }{ "label": "Closed", "value": "closed" }`
Text Template ID	`textTemplateId`	`string`	Select a value from the drop down menu.
Content	`content`	`string[]`	A list of content items of the proposal. See the documentation
Tags	`tags`	`string[]`	Select a value from the drop down menu.