@pipedream/prodpad 0.0.1

package/LICENSE

@@ -0,0 +1,41 @@
+Pipedream Source Available License Version 1.0
+ 
+This Pipedream Source Available License Agreement Version 1.0 (this “Agreement”) sets forth the terms on which Pipedream, Inc., a Delaware corporation (“Pipedream”) makes available certain software (the “Software”). By installing, downloading, accessing, using or distributing the Software, you agree to the terms of this Agreement. If you do not agree to such terms, you must not use the Software. If you are receiving the Software on behalf of a legal entity, you represent and warrant that you have the actual authority to agree to the terms and conditions of this Agreement on behalf of such entity. “Licensee” means you, an individual, or the entity on whose behalf you are receiving the Software.
+ 
+LICENSE GRANT AND CONDITIONS.
+ 
+1.1  License. Subject to the terms and conditions of this Agreement, Pipedream hereby grants to Licensee a non-exclusive, royalty-free, worldwide, non-transferable, non-sublicenseable license during the term of this Agreement to use, prepare modifications and derivative works, distribute (including without limitation in source code or object code form) and reproduce copies of the Software (the “License”). Licensee is not granted the right to, and Licensee shall not, exercise the License for an Excluded Purpose. For purposes of this Agreement, “Excluded Purpose” means any commercial use of the software including, but not limited to, making available any software-as-a-service, platform-as-a-service, infrastructure-as-a-service or other online service that competes with the Software or any other Pipedream products or services.
+ 
+1.2  Conditions. In consideration of the License, Licensee’s distribution of the Software is subject to the following conditions:
+ 
+a. Licensee must cause any Software modified by Licensee to carry prominent notices stating that Licensee modified the Software.
+ 
+b. On each Software copy, Licensee shall reproduce and not remove or alter all Pipedream or third party copyright or other proprietary notices contained in the Software, and Licensee must provide this with each copy: “This software is made available by Pipedream, Inc., under the terms of the Pipedream Source Available License, Version 1.0 located at https://github.com/PipedreamHQ/pipedream/blob/master/LICENSE. By installing, downloading, accessing, using or distributing the Software, you agree to the terms of such License Agreement.”
+ 
+1.3  Modifications. Licensee may add its own copyright notices to modifications made by Licensee and may provide additional or different license terms and conditions for use, reproduction, or distribution of Licensee’s modifications. While redistributing the Software or modifications thereof, Licensee may choose to offer, for a fee or free of charge, support, warranty, indemnity, or other obligations. Licensee, and not Pipedream, will be responsible for any such obligations.
+ 
+1.4  No Sublicensing. The License does not include the right to sublicense the Software; provided, however, that any recipient to which Licensee provides the Software may exercise the License so long as such recipient agrees to the terms and conditions of this Agreement.
+ 
+TERM AND TERMINATION.
+ 
+This Agreement will continue unless and until earlier terminated as set forth herein. If Licensee breaches any of its conditions or obligations under this Agreement, this Agreement will terminate automatically and the License will terminate automatically and permanently.
+ 
+INTELLECTUAL PROPERTY.
+ 
+As between the parties, Pipedream retains all right, title, and interest in the Software, and all intellectual property rights therein. Pipedream hereby reserves all rights not expressly granted to Licensee in this Agreement. Pipedream reserves all rights in its trademarks and service marks, and no licenses thereto are granted by this Agreement.
+ 
+DISCLAIMER.
+ 
+PIPEDREAM HEREBY DISCLAIMS ANY AND ALL WARRANTIES AND CONDITIONS, EXPRESS, IMPLIED, STATUTORY, OR OTHERWISE, AND SPECIFICALLY DISCLAIMS ANY WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE, WITH RESPECT TO THE SOFTWARE.
+ 
+LIMITATION OF LIABILITY.
+ 
+PIPEDREAM WILL NOT BE LIABLE FOR ANY DAMAGES OF ANY KIND, INCLUDING BUT NOT LIMITED TO, LOST PROFITS OR ANY CONSEQUENTIAL, SPECIAL, INCIDENTAL, INDIRECT, OR DIRECT DAMAGES, HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, ARISING OUT OF THIS AGREEMENT. THE FOREGOING SHALL APPLY TO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE LAW.
+ 
+GENERAL.
+ 
+6.1  Governing Law. This Agreement will be governed by and interpreted in accordance with the laws of the state of California, without reference to its conflict of laws principles. If Licensee is located outside of the United States, any dispute, controversy or claim arising out of or relating to this Agreement will be referred to and finally determined by arbitration in accordance with the JAMS International Arbitration Rules. The tribunal will consist of one arbitrator. Judgment upon the award rendered by the arbitrator may be entered in any court having jurisdiction thereof. All disputes including arbitrations shall take place in Santa Clara County, California. The language to be used in any such proceedings shall be English.
+ 
+6.2.  Assignment. Licensee is not authorized to assign its rights under this Agreement to any third party. Pipedream may freely assign its rights under this Agreement to any third party.
+ 
+6.3.  Other. This Agreement is the entire agreement between the parties regarding the subject matter hereof. No amendment or modification of this Agreement will be valid or binding upon the parties unless made in writing and signed by the duly authorized representatives of both parties. In the event that any provision, including without limitation any condition, of this Agreement is held to be unenforceable, this Agreement and all licenses and rights granted hereunder will immediately terminate. Waiver by Pipedream of a breach of any provision of this Agreement or the failure by Pipedream to exercise any right hereunder will not be construed as a waiver of any subsequent breach of that right or as a waiver of any other right.

package/README.md

@@ -0,0 +1,33 @@
+# Overview
+
+What can you build with ProdPad's API? The possibilities are endless!
+
+ProdPad is an idea and innovation management platform – with our API, you’re able to turn ideas into actionable tasks with minimal effort. ProdPad’s API enables you to manage product planning and roadmapping, such as:
+
+- Retrieve ideas, including customer feedback and suggestions
+- Automatically creates tasks for your team to feature develop and utilize
+- Track and analyze the progress of product-related tasks across your different products
+- Generate reports on product performance
+- Monitor customer feedback with customizable filters
+- Integrate your product roadmap with third-party systems and tools
+
+The ProdPad API allows you to build a range of custom projects that can streamline and automate parts of your product planning process. Here are some of the things you can do:
+
+- Track customer feedback and manage product roadmaps
+- Keep track of team tasks and milestones
+- Analyze product performance and utilization
+- Visualize your product roadmap
+- Aggregate customer feedback into reports
+- Integrate ProdPad into your existing systems and tools
+- Create custom development projects
+- Synchronize data between Prodpad and third-party applications
+
+# Webhooks
+
+Some triggers support webhooks for ProdPad. These include:
+
+- New Pushed Idea
+- New Pushed User Story
+
+To set up a webhook, please create and deploy one of these triggers and copy the HTTP URL.
+Then follow the instructions on [this link](https://help.prodpad.com/article/759-create-a-custom-webhook).

package/actions/create-company/create-company.mjs

@@ -0,0 +1,81 @@
+import app from "../../prodpad.app.mjs";
+import utils from "../../common/utils.mjs";
+
+export default {
+  key: "prodpad-create-company",
+  name: "Create Company",
+  description: "Create a new company in the account. This is only available to accounts with an Advanced or higher subscription. If you try on an account without an advanced or higher subscription package it will return a 403. [See the docs](https://app.swaggerhub.com/apis-docs/ProdPad/prodpad/1.0#/Feedback/PostCompanies).",
+  type: "action",
+  version: "0.0.1",
+  props: {
+    app,
+    name: {
+      propDefinition: [
+        app,
+        "name",
+      ],
+    },
+    city: {
+      propDefinition: [
+        app,
+        "city",
+      ],
+    },
+    country: {
+      propDefinition: [
+        app,
+        "country",
+      ],
+    },
+    size: {
+      propDefinition: [
+        app,
+        "companySize",
+      ],
+    },
+    value: {
+      propDefinition: [
+        app,
+        "companyValue",
+      ],
+    },
+    tagIds: {
+      type: "string[]",
+      label: "Tags",
+      description: "The tags to associate with the company.",
+      optional: true,
+      propDefinition: [
+        app,
+        "tagId",
+      ],
+    },
+  },
+  async run({ $: step }) {
+    const {
+      name,
+      city,
+      country,
+      size,
+      value,
+      tagIds,
+    } = this;
+
+    const response = await this.app.createCompany({
+      step,
+      data: {
+        name,
+        city,
+        country,
+        size,
+        value,
+        tags: utils.mapOrParse(tagIds, (id) => ({
+          id,
+        })),
+      },
+    });
+
+    step.export("$summary", `Successfully created company with ID ${response.id}.`);
+
+    return response;
+  },
+};

package/actions/create-contact/create-contact.mjs

@@ -0,0 +1,115 @@
+import app from "../../prodpad.app.mjs";
+import utils from "../../common/utils.mjs";
+
+export default {
+  key: "prodpad-create-contact",
+  name: "Create Contact",
+  description: "Creates a contact. [See the docs](https://app.swaggerhub.com/apis-docs/ProdPad/prodpad/1.0#/Feedback/PostContacts).",
+  type: "action",
+  version: "0.0.1",
+  props: {
+    app,
+    name: {
+      description: "The name of the contact",
+      propDefinition: [
+        app,
+        "name",
+      ],
+    },
+    email: {
+      description: "The email of the contact",
+      propDefinition: [
+        app,
+        "email",
+      ],
+    },
+    about: {
+      type: "string",
+      label: "About",
+      description: "About the contact",
+      optional: true,
+    },
+    phone: {
+      type: "string",
+      label: "Phone",
+      description: "The phone number of the contact",
+      optional: true,
+    },
+    twitterUrl: {
+      type: "string",
+      label: "Twitter URL",
+      description: "The twitter URL of the contact",
+      optional: true,
+    },
+    tagIds: {
+      type: "string[]",
+      label: "Tags",
+      description: "The tags to associate with the contact.",
+      optional: true,
+      propDefinition: [
+        app,
+        "tagId",
+      ],
+    },
+    personaIds: {
+      type: "string[]",
+      label: "Persona IDs",
+      description: "The persona IDs to associate with the contact.",
+      optional: true,
+      propDefinition: [
+        app,
+        "personaId",
+      ],
+    },
+    company: {
+      optional: true,
+      propDefinition: [
+        app,
+        "companyId",
+      ],
+    },
+    jobrole: {
+      optional: true,
+      propDefinition: [
+        app,
+        "jobroleId",
+      ],
+    },
+  },
+  async run({ $: step }) {
+    const {
+      name,
+      email,
+      about,
+      phone,
+      twitterUrl,
+      tagIds,
+      personaIds,
+      company,
+      jobrole,
+    } = this;
+
+    const response = await this.app.createContact({
+      step,
+      data: {
+        name,
+        email,
+        about,
+        phone,
+        twitter_url: twitterUrl,
+        tags: utils.mapOrParse(tagIds, (id) => ({
+          id,
+        })),
+        personas: utils.mapOrParse(personaIds, (id) => ({
+          id,
+        })),
+        company,
+        jobrole,
+      },
+    });
+
+    step.export("$summary", `Successfully created contact with ID ${response.id}.`);
+
+    return response;
+  },
+};

package/actions/create-feedback/create-feedback.mjs

@@ -0,0 +1,85 @@
+import app from "../../prodpad.app.mjs";
+import utils from "../../common/utils.mjs";
+
+export default {
+  key: "prodpad-create-feedback",
+  name: "Create Feedback",
+  description: "Creates a feedback. [See the docs](https://app.swaggerhub.com/apis-docs/ProdPad/prodpad/1.0#/Feedback/PostFeedbacks).",
+  type: "action",
+  version: "0.0.1",
+  props: {
+    app,
+    contactId: {
+      description: "ID of the contact providing the feedback.",
+      propDefinition: [
+        app,
+        "contactId",
+      ],
+    },
+    feedback: {
+      propDefinition: [
+        app,
+        "feedback",
+      ],
+    },
+    tagIds: {
+      type: "string[]",
+      label: "Tag IDs",
+      description: "Tag IDs to link to the feedback.",
+      optional: true,
+      propDefinition: [
+        app,
+        "tagId",
+      ],
+    },
+    personaIds: {
+      type: "string[]",
+      label: "Persona IDs",
+      description: "Persona IDs to link to the feedback.",
+      optional: true,
+      propDefinition: [
+        app,
+        "personaId",
+      ],
+    },
+    productIds: {
+      type: "string[]",
+      label: "Product IDs",
+      description: "Product IDs to link to the feedback.",
+      optional: true,
+      propDefinition: [
+        app,
+        "productId",
+      ],
+    },
+  },
+  async run({ $: step }) {
+    const {
+      contactId,
+      feedback,
+      tagIds,
+      personaIds,
+      productIds,
+    } = this;
+
+    const response = await this.app.createFeedback({
+      step,
+      data: {
+        contact_id: contactId,
+        feedback,
+        tags: utils.mapOrParse(tagIds, (id) => ({
+          id,
+        })),
+        personas: utils.mapOrParse(personaIds, (id) => ({
+          id,
+        })),
+        products: utils.mapOrParse(productIds, (id) => ({
+          id,
+        })),
+      },
+    });
+
+    step.export("$summary", `Successfully created feedback with ID ${response.id}.`);
+    return response;
+  },
+};

package/actions/create-idea/create-idea.mjs

@@ -0,0 +1,151 @@
+import app from "../../prodpad.app.mjs";
+import utils from "../../common/utils.mjs";
+
+export default {
+  key: "prodpad-create-idea",
+  name: "Create Idea",
+  description: "Creates an idea. [See the docs](https://app.swaggerhub.com/apis-docs/ProdPad/prodpad/1.0#/Ideas/PostIdeas).",
+  type: "action",
+  version: "0.0.1",
+  props: {
+    app,
+    title: {
+      type: "string",
+      label: "Title",
+      description: "The title of the idea. Either the title or description is required.",
+    },
+    description: {
+      type: "string",
+      label: "Description",
+      description: "The description of the idea. This field accepts HTML and is stored as UTF-8.",
+      optional: true,
+    },
+    businessCaseProblem: {
+      type: "string",
+      label: "Business Case Problem",
+      description: "The problem or hypothesis this idea is aiming to address. This field accepts HTML and is stored as UTF-8.",
+      optional: true,
+    },
+    businessCaseValue: {
+      type: "string",
+      label: "Business Case Value",
+      description: "The value of solving this problem or hypothesis to the user and the company. This field accepts HTML and is stored as UTF-8.",
+      optional: true,
+    },
+    functional: {
+      type: "string",
+      label: "Functional Specs",
+      description: "The functional specs of how this idea could be implemented. This field accepts HTML and is stored as UTF-8.",
+      optional: true,
+    },
+    notes: {
+      type: "string",
+      label: "Notes",
+      description: "Free text field for notes on the idea. This field accepts HTML and is stored as UTF-8.",
+      optional: true,
+    },
+    productIds: {
+      type: "string[]",
+      label: "Products",
+      description: "The products to associate with the idea.",
+      optional: true,
+      propDefinition: [
+        app,
+        "productId",
+      ],
+    },
+    personaIds: {
+      type: "string[]",
+      label: "Personas",
+      description: "The persona IDs to associate with the persona.",
+      optional: true,
+      propDefinition: [
+        app,
+        "personaId",
+      ],
+    },
+    tagIds: {
+      type: "string[]",
+      label: "Tags",
+      description: "The tags to associate with the persona.",
+      optional: true,
+      propDefinition: [
+        app,
+        "tagId",
+      ],
+    },
+    statusId: {
+      optional: true,
+      propDefinition: [
+        app,
+        "statusId",
+      ],
+    },
+    state: {
+      type: "string",
+      label: "State",
+      description: "State of the idea.",
+      optional: true,
+      options: [
+        "active",
+        "active_public",
+        "archived",
+        "unsorted",
+      ],
+    },
+  },
+  methods: {
+    createIdea(args = {}) {
+      return this.app.create({
+        path: "/ideas",
+        ...args,
+      });
+    },
+  },
+  async run({ $: step }) {
+    const {
+      title,
+      description,
+      businessCaseProblem,
+      businessCaseValue,
+      functional,
+      notes,
+      productIds,
+      personaIds,
+      tagIds,
+      statusId,
+      state,
+    } = this;
+
+    const response = await this.createIdea({
+      step,
+      data: {
+        title,
+        description,
+        business_case: {
+          problem: businessCaseProblem,
+          value: businessCaseValue,
+        },
+        functional,
+        notes,
+        tags: utils.mapOrParse(tagIds, (id) => ({
+          id,
+        })),
+        personas: utils.mapOrParse(personaIds, (id) => ({
+          id,
+        })),
+        products: utils.mapOrParse(productIds, (id) => ({
+          id,
+        })),
+        status: {
+          id: statusId,
+        },
+        state,
+      },
+    });
+
+    step.export("$summary", `Successfully created idea with ID ${response.id}.`);
+
+    return response;
+  },
+};

package/actions/find-company/find-company.mjs

@@ -0,0 +1,85 @@
+import app from "../../prodpad.app.mjs";
+import utils from "../../common/utils.mjs";
+
+export default {
+  key: "prodpad-find-company",
+  name: "Find Company",
+  description: "Finds a company. [See the docs](https://app.swaggerhub.com/apis-docs/ProdPad/prodpad/1.0#/Feedback/GetCompanies).",
+  type: "action",
+  version: "0.0.1",
+  props: {
+    app,
+    name: {
+      description: "Filter the companies by the name or partial name of the companies.",
+      optional: true,
+      propDefinition: [
+        app,
+        "name",
+      ],
+    },
+    city: {
+      description: "Set to filter the companies based on city.",
+      propDefinition: [
+        app,
+        "city",
+      ],
+    },
+    country: {
+      description: "Set to filter the companies based on the country. Use ISO Alpha-2 country codes. Only one country can be filtered at a time.",
+      propDefinition: [
+        app,
+        "country",
+      ],
+    },
+    companySize: {
+      description: "Set to filter the companies based on their size.",
+      propDefinition: [
+        app,
+        "companySize",
+      ],
+    },
+    companyValue: {
+      description: "Set to filter the companies based on their value.",
+      propDefinition: [
+        app,
+        "companyValue",
+      ],
+    },
+    tagIds: {
+      type: "string[]",
+      label: "Tags",
+      description: "Filter companies by the tags associated to the feedback. Mulitple tags can be specified and acts as an OR. Use the tag ID or UUID.",
+      optional: true,
+      propDefinition: [
+        app,
+        "tagId",
+      ],
+    },
+  },
+  async run({ $: step }) {
+    const {
+      name,
+      city,
+      country,
+      companySize,
+      companyValue,
+      tagIds,
+    } = this;
+
+    const { companies } = await this.app.listCompanies({
+      step,
+      params: {
+        name,
+        city,
+        country,
+        company_size: companySize,
+        value: companyValue,
+        tags: utils.mapOrParse(tagIds).join(","),
+      },
+    });
+
+    step.export("$summary", `Successfully found ${utils.summaryEnd(companies.length, "company", "companies")}`);
+
+    return companies;
+  },
+};

package/actions/find-contact/find-contact.mjs

@@ -0,0 +1,90 @@
+import app from "../../prodpad.app.mjs";
+import utils from "../../common/utils.mjs";
+
+export default {
+  key: "prodpad-find-contact",
+  name: "Find Contact",
+  description: "Finds a contact. [See the docs](https://app.swaggerhub.com/apis-docs/ProdPad/prodpad/1.0#/Feedback/PostContacts).",
+  type: "action",
+  version: "0.0.1",
+  props: {
+    app,
+    name: {
+      description: "Name of contact or partial name of contacts to filter the list by",
+      optional: true,
+      propDefinition: [
+        app,
+        "name",
+      ],
+    },
+    email: {
+      description: "Filter the contacts by an email.",
+      optional: true,
+      propDefinition: [
+        app,
+        "email",
+      ],
+    },
+    tagIds: {
+      type: "string[]",
+      label: "Tags",
+      description: "ID of one or more tags to filter the contacts by.",
+      optional: true,
+      propDefinition: [
+        app,
+        "tagId",
+      ],
+    },
+    persona: {
+      label: "Persona ID",
+      description: "ID of a persona to filter contacts by.",
+      optional: true,
+      propDefinition: [
+        app,
+        "personaId",
+      ],
+    },
+    company: {
+      description: "UUID of a company to filter contacts by.",
+      optional: true,
+      propDefinition: [
+        app,
+        "companyId",
+      ],
+    },
+    jobrole: {
+      description: "UUID of a job role to filter contacts by.",
+      optional: true,
+      propDefinition: [
+        app,
+        "jobroleId",
+      ],
+    },
+  },
+  async run({ $: step }) {
+    const {
+      name,
+      email,
+      tagIds,
+      persona,
+      company,
+      jobrole,
+    } = this;
+
+    const { contacts } = await this.app.listContacts({
+      step,
+      params: {
+        name,
+        email,
+        tags: utils.mapOrParse(tagIds).join(","),
+        persona,
+        company,
+        job_role: jobrole,
+      },
+    });
+
+    step.export("$summary", `Successfully found ${utils.summaryEnd(contacts.length, "contact")}`);
+
+    return contacts;
+  },
+};