@pipedream/prodpad 0.0.1

package/actions/find-feedback/find-feedback.mjs

@@ -0,0 +1,123 @@
+import app from "../../prodpad.app.mjs";
+import utils from "../../common/utils.mjs";
+
+export default {
+  key: "prodpad-find-feedback",
+  name: "Find Feedback",
+  description: "Finds a feedback. [See the docs](https://app.swaggerhub.com/apis-docs/ProdPad/prodpad/1.0#/Feedback/GetFeedbacks).",
+  type: "action",
+  version: "0.0.1",
+  props: {
+    app,
+    state: {
+      type: "string",
+      label: "State",
+      description: "The state of the feedback. Default is `active`.",
+      optional: true,
+      options: [
+        "active",
+        "unsorted",
+        "archived",
+        "all",
+      ],
+    },
+    company: {
+      description: "Set to filter the feedback results based on whether the feedback was entered for a contact linked to the company.",
+      optional: true,
+      propDefinition: [
+        app,
+        "companyId",
+      ],
+    },
+    country: {
+      label: "Company Country",
+      description: "Set to filter the feedback results based on whether the feedback was entered for a contact linked to the company. Use ISO Alpha-2 country codes.",
+      propDefinition: [
+        app,
+        "country",
+      ],
+    },
+    companySize: {
+      label: "Company Size",
+      description: "Set to filter the feedback results based on the size of the company for the associated company.",
+      propDefinition: [
+        app,
+        "companySize",
+      ],
+    },
+    companyValue: {
+      label: "Company Value",
+      description: "Set to filter the feedback results based on the value of the company for the company assocaited to the feedback.",
+      propDefinition: [
+        app,
+        "companyValue",
+      ],
+    },
+    persona: {
+      description: "Filter results by the persona associated to feedback. Can either be the persona UUID or persona ID.",
+      optional: true,
+      propDefinition: [
+        app,
+        "personaId",
+      ],
+    },
+    jobrole: {
+      description: "Filter results by the job role of the contact associated to the feedback. Use the JobRole UUID.",
+      optional: true,
+      propDefinition: [
+        app,
+        "jobroleId",
+      ],
+    },
+    tagIds: {
+      type: "string[]",
+      label: "Tag IDs",
+      description: "Tag IDs to link to the feedback.",
+      optional: true,
+      propDefinition: [
+        app,
+        "tagId",
+      ],
+    },
+    product: {
+      description: "Filter results by the product associated to feedback. Can either be the product UUID or product ID.",
+      optional: true,
+      propDefinition: [
+        app,
+        "productId",
+      ],
+    },
+  },
+  async run({ $: step }) {
+    const {
+      state,
+      company,
+      country,
+      companySize,
+      companyValue,
+      persona,
+      jobrole,
+      tagIds,
+      product,
+    } = this;
+
+    const feedbacks = await this.app.listFeedbacks({
+      step,
+      params: {
+        state,
+        company,
+        company_country: country,
+        company_size: companySize,
+        company_value: companyValue,
+        persona,
+        job_role: jobrole,
+        tags: utils.mapOrParse(tagIds).join(","),
+        product,
+      },
+    });
+
+    step.export("$summary", `Successfully found ${utils.summaryEnd(feedbacks.length, "feedback")}`);
+
+    return feedbacks;
+  },
+};

package/actions/find-idea/find-idea.mjs

@@ -0,0 +1,66 @@
+import app from "../../prodpad.app.mjs";
+import utils from "../../common/utils.mjs";
+
+export default {
+  key: "prodpad-find-idea",
+  name: "Find Idea",
+  description: "Finds an idea. [See the docs](https://app.swaggerhub.com/apis-docs/ProdPad/prodpad/1.0#/Ideas/GetIdeas).",
+  type: "action",
+  version: "0.0.1",
+  props: {
+    app,
+    externalId: {
+      propDefinition: [
+        app,
+        "externalId",
+      ],
+    },
+    externalUrl: {
+      propDefinition: [
+        app,
+        "externalUrl",
+      ],
+    },
+    tagIds: {
+      type: "string[]",
+      label: "Tags",
+      description: "One or more tag names to filter the ideas by.",
+      optional: true,
+      propDefinition: [
+        app,
+        "tagId",
+      ],
+    },
+    status: {
+      label: "Status",
+      description: "Name of a workflow status to filter the ideas by.",
+      optional: true,
+      propDefinition: [
+        app,
+        "statusId",
+      ],
+    },
+  },
+  async run({ $: step }) {
+    const {
+      externalId,
+      externalUrl,
+      tagIds,
+      status,
+    } = this;
+
+    const { ideas } = await this.app.listIdeas({
+      step,
+      params: {
+        external_id: externalId,
+        external_url: externalUrl,
+        status,
+        tags: utils.mapOrParse(tagIds).join(","),
+      },
+    });
+
+    step.export("$summary", `Successfully found ${utils.summaryEnd(ideas.length, "idea")}`);
+
+    return ideas;
+  },
+};

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

@@ -0,0 +1,105 @@
+import app from "../../prodpad.app.mjs";
+import utils from "../../common/utils.mjs";
+
+export default {
+  key: "prodpad-find-or-create-company",
+  name: "Find or Create Company",
+  description: "Finds or creates a company. See the docs for [find company](https://app.swaggerhub.com/apis-docs/ProdPad/prodpad/1.0#/Feedback/GetCompanies) and [create company](https://app.swaggerhub.com/apis-docs/ProdPad/prodpad/1.0#/Feedback/PostCompanies).",
+  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: {
+      label: "Company Size",
+      description: "Set to filter the companies based on their size.",
+      propDefinition: [
+        app,
+        "companySize",
+      ],
+    },
+    companyValue: {
+      label: "Company Value",
+      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(","),
+      },
+    });
+
+    if (companies.length) {
+      step.export("$summary", `Successfully found ${utils.summaryEnd(companies.length, "company", "companies")}`);
+      return companies;
+    }
+
+    const response = await this.app.createCompany({
+      step,
+      data: {
+        name,
+        city,
+        country,
+        size: companySize,
+        value: companyValue,
+        tags: utils.mapOrParse(tagIds, (id) => ({
+          id,
+        })),
+      },
+    });
+
+    step.export("$summary", `Successfully created company with ID ${response.id}.`);
+    return response;
+  },
+};

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

@@ -0,0 +1,114 @@
+import app from "../../prodpad.app.mjs";
+import utils from "../../common/utils.mjs";
+
+export default {
+  key: "prodpad-find-or-create-contact",
+  name: "Find or Create Contact",
+  description: "Finds or creates a contact. See the docs for [find contact](https://app.swaggerhub.com/apis-docs/ProdPad/prodpad/1.0#/Feedback/PostContacts) and [create contact](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",
+      description: "ID of a persona to filter contacts by.",
+      optional: true,
+      propDefinition: [
+        app,
+        "personaId",
+      ],
+    },
+    company: {
+      label: "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,
+      },
+    });
+
+    if (contacts.length) {
+      step.export("$summary", `Successfully found ${utils.summaryEnd(contacts.length, "contact")}`);
+      return contacts;
+    }
+
+    const response = await this.app.createContact({
+      step,
+      data: {
+        name,
+        email,
+        tags: utils.mapOrParse(tagIds, (id) => ({
+          id,
+        })),
+        personas: persona && [
+          {
+            id: persona,
+          },
+        ],
+        company,
+        jobrole: jobrole,
+      },
+    });
+
+    step.export("$summary", `Successfully created contact with ID ${response.id}.`);
+
+    return response;
+  },
+};

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

@@ -0,0 +1,149 @@
+import app from "../../prodpad.app.mjs";
+import utils from "../../common/utils.mjs";
+
+export default {
+  key: "prodpad-find-or-create-feedback",
+  name: "Find or Create Feedback",
+  description: "Finds or creates a feedback. See the docs for [find feedback](https://app.swaggerhub.com/apis-docs/ProdPad/prodpad/1.0#/Feedback/GetFeedbacks) and [create feedback](https://app.swaggerhub.com/apis-docs/ProdPad/prodpad/1.0#/Feedback/PostFeedbacks).",
+  type: "action",
+  version: "0.0.1",
+  props: {
+    app,
+    customer: {
+      label: "Customer",
+      optional: true,
+      description: "ID of the contact providing the feedback.",
+      propDefinition: [
+        app,
+        "contactId",
+      ],
+    },
+    company: {
+      label: "Company",
+      description: "Set to filter the feedback results based on whether the feedback was entered for a contact linked to the company.",
+      optional: true,
+      propDefinition: [
+        app,
+        "companyId",
+      ],
+    },
+    product: {
+      label: "Product",
+      description: "Product IDs to link to the feedback.",
+      optional: true,
+      propDefinition: [
+        app,
+        "productId",
+      ],
+    },
+    persona: {
+      label: "Persona",
+      optional: true,
+      propDefinition: [
+        app,
+        "personaId",
+      ],
+    },
+    tagIds: {
+      type: "string[]",
+      label: "Tag IDs",
+      description: "Tag IDs to link to the feedback.",
+      optional: true,
+      propDefinition: [
+        app,
+        "tagId",
+      ],
+    },
+    externalId: {
+      description: "Filter feedback to return the feedback associated with a specific External ID. An example of an external ID is the ID of a record in a CRM or ID of a ticket in a customer support application.",
+      propDefinition: [
+        app,
+        "externalId",
+      ],
+    },
+    externalUrl: {
+      description: "Filter feedback to return the feedback associated with a specific external url. An example of an external url is that of a record in a CRM or a ticket in a customer support application",
+      propDefinition: [
+        app,
+        "externalUrl",
+      ],
+    },
+    feedback: {
+      type: "string",
+      label: "Feedback",
+      description: "In case the feedback is not found, this will be used to create a new feedback. This field accepts HTML and is stored as UTF-8.",
+      optional: true,
+    },
+    name: {
+      description: "In case the feedback is not found, this will be used to create a new feedback.",
+      optional: true,
+      propDefinition: [
+        app,
+        "name",
+      ],
+    },
+  },
+  async run({ $: step }) {
+    const {
+      customer,
+      company,
+      product,
+      persona,
+      tagIds,
+      externalId,
+      externalUrl,
+      feedback,
+      name,
+    } = this;
+
+    const feedbacks = await this.app.listFeedbacks({
+      step,
+      params: {
+        customer,
+        company,
+        product,
+        persona,
+        tags: utils.mapOrParse(tagIds).join(","),
+        external_id: externalId,
+        external_url: externalUrl,
+      },
+    });
+
+    if (feedbacks.length) {
+      step.export("$summary", `Successfully found ${utils.summaryEnd(feedbacks.length, "feedback")}`);
+      return feedbacks;
+    }
+
+    const response = await this.app.createFeedback({
+      step,
+      data: {
+        name,
+        feedback,
+        contact_id: customer,
+        company_id: company,
+        products: product && [
+          {
+            id: product,
+          },
+        ],
+        personas: persona && [
+          {
+            id: persona,
+          },
+        ],
+        tags: utils.mapOrParse(tagIds, (id) => ({
+          id,
+        })),
+        external_links: (externalId || externalUrl) && [
+          {
+            external_id: externalId,
+            url: externalUrl,
+          },
+        ],
+      },
+    });
+
+    step.export("$summary", `Successfully created feedback with ID ${response.id}.`);
+    return response;
+  },
+};

package/actions/update-company/update-company.mjs

@@ -0,0 +1,101 @@
+import app from "../../prodpad.app.mjs";
+import utils from "../../common/utils.mjs";
+
+export default {
+  key: "prodpad-update-company",
+  name: "Update Company",
+  description: "Updates a company. [See the docs](https://app.swaggerhub.com/apis-docs/ProdPad/prodpad/1.0#/Feedback/PutCompany).",
+  type: "action",
+  version: "0.0.1",
+  props: {
+    app,
+    companyId: {
+      propDefinition: [
+        app,
+        "companyId",
+      ],
+    },
+    name: {
+      optional: true,
+      propDefinition: [
+        app,
+        "name",
+      ],
+    },
+    city: {
+      propDefinition: [
+        app,
+        "city",
+      ],
+    },
+    country: {
+      propDefinition: [
+        app,
+        "country",
+      ],
+    },
+    size: {
+      label: "Company Size",
+      propDefinition: [
+        app,
+        "companySize",
+      ],
+    },
+    value: {
+      label: "Company Value",
+      propDefinition: [
+        app,
+        "companyValue",
+      ],
+    },
+    tagIds: {
+      type: "string[]",
+      label: "Tags",
+      description: "The tags to associate with the company.",
+      optional: true,
+      propDefinition: [
+        app,
+        "tagId",
+      ],
+    },
+  },
+  methods: {
+    updateCompany({
+      companyId, ...args
+    } = {}) {
+      return this.app.update({
+        path: `/companies/${companyId}`,
+        ...args,
+      });
+    },
+  },
+  async run({ $: step }) {
+    const {
+      companyId,
+      name,
+      city,
+      country,
+      size,
+      value,
+      tagIds,
+    } = this;
+
+    const response = await this.updateCompany({
+      companyId,
+      data: {
+        name,
+        city,
+        country,
+        size,
+        value,
+        tags: utils.mapOrParse(tagIds, (id) => ({
+          id,
+        })),
+      },
+    });
+
+    step.export("$summary", `Successfully updated company with ID ${response.id}`);
+
+    return response;
+  },
+};