new actions

Author: michelle0927

components/pipedrive/actions/get-lead-by-id/get-lead-by-id.mjs

@@ -0,0 +1,25 @@
+import pipedriveApp from "../../pipedrive.app.mjs";
+
+export default {
+  key: "pipedrive-get-lead-by-id",
+  name: "Get Lead by ID",
+  description: "Get a lead by its ID. [See the documentation](https://developers.pipedrive.com/docs/api/v1/Leads#getLead)",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    pipedriveApp,
+    leadId: {
+      propDefinition: [
+        pipedriveApp,
+        "leadId",
+      ],
+      description: "The ID of the lead to get",
+      optional: false,
+    },
+  },
+  async run({ $ }) {
+    const { data } = await this.pipedriveApp.getLead(this.leadId);
+    $.export("$summary", `Successfully retrieved lead with ID: ${this.leadId}`);
+    return data;
+  },
+};

components/pipedrive/actions/search-leads/search-leads.mjs

@@ -0,0 +1,68 @@
+import pipedriveApp from "../../pipedrive.app.mjs";
+import constants from "../../common/constants.mjs";
+
+export default {
+  key: "pipedrive-search-leads",
+  name: "Search Leads",
+  description: "Search for leads by name or email. [See the documentation](https://developers.pipedrive.com/docs/api/v1/Leads#searchLeads)",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    pipedriveApp,
+    term: {
+      type: "string",
+      label: "Search Term",
+      description: "The search term to look for. Minimum 2 characters (or 1 if using exact_match).",
+    },
+    exactMatch: {
+      type: "boolean",
+      label: "Exact Match",
+      description: "When enabled, only full exact matches against the given term are returned. It is not case sensitive.",
+      optional: true,
+    },
+    fields: {
+      type: "string[]",
+      label: "Search Fields",
+      description: "An array containing fields to perform the search from. Defaults to all of them.",
+      optional: true,
+      options: constants.LEAD_FIELD_OPTIONS,
+    },
+    personId: {
+      propDefinition: [
+        pipedriveApp,
+        "personId",
+      ],
+      description: "Will filter Deals by the provided Person ID",
+    },
+    organizationId: {
+      propDefinition: [
+        pipedriveApp,
+        "organizationId",
+      ],
+      description: "Will filter Deals by the provided Organization ID",
+    },
+    includeFields: {
+      type: "string",
+      label: "Include fields",
+      description: "Supports including optional fields in the results which are not provided by default.",
+      optional: true,
+      options: [
+        "lead.was_seen",
+      ],
+    },
+  },
+  async run({ $ }) {
+    const { data: { items = [] } } = await this.pipedriveApp.searchLeads({
+      term: this.term,
+      exact_match: this.exactMatch,
+      fields: this.fields,
+      person_id: this.personId,
+      organization_id: this.organizationId,
+      include_fields: this.includeFields,
+    });
+    $.export("$summary", `Successfully found ${items.length} lead${items.length === 1
+      ? ""
+      : "s"}`);
+    return items;
+  },
+};

components/pipedrive/common/constants.mjs

@@ -35,11 +35,18 @@ const FIELD = {
   UPDATE_TIME: "update_time",
 };
 
+const LEAD_FIELD_OPTIONS = [
+  "custom_fields",
+  "notes",
+  "title",
+];
+
 export default {
   STATUS_OPTIONS,
   FIELD_OPTIONS,
   VISIBLE_TO_OPTIONS,
   INCLUDE_FIELDS_OPTIONS,
   DEFAULT_PAGE_LIMIT,
   FIELD,
+  LEAD_FIELD_OPTIONS,
 };

components/pipedrive/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pipedream/pipedrive",
-  "version": "0.8.0",
+  "version": "0.9.0",
   "description": "Pipedream Pipedrive Components",
   "main": "pipedrive.app.mjs",
   "keywords": [

components/pipedrive/pipedrive.app.mjs

@@ -449,6 +449,16 @@ export default {
         id: personId,
       });
     },
+    getLead(leadId) {
+      const leadApi = this.api("LeadsApi");
+      return leadApi.getLead({
+        id: leadId,
+      });
+    },
+    searchLeads(opts = {}) {
+      const leadApi = this.api("LeadsApi", "v2");
+      return leadApi.searchLeads(opts);
+    },
     async *paginate({
       fn, params, max,
     }) {