@pipedream/highlevel_oauth 0.1.0 → 0.2.0

package/actions/add-contact-to-campaign/add-contact-to-campaign.mjs

@@ -0,0 +1,36 @@
+import common from "../../common/base.mjs";
+
+export default {
+  ...common,
+  key: "highlevel_oauth-add-contact-to-campaign",
+  name: "Add Contact to Campaign",
+  description: "Adds an existing contact to a campaign. [See the documentation](https://highlevel.stoplight.io/docs/integrations/ecf9b5b45deaf-add-contact-to-campaign)",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    ...common.props,
+    contactId: {
+      propDefinition: [
+        common.props.app,
+        "contactId",
+      ],
+    },
+    campaignId: {
+      propDefinition: [
+        common.props.app,
+        "campaignId",
+      ],
+    },
+  },
+  async run({ $ }) {
+    const response = await this.app.addContactToCampaign({
+      $,
+      contactId: this.contactId,
+      campaignId: this.campaignId,
+    });
+    if (response?.succeded) {
+      $.export("$summary", `Successfully added contact to campaign with ID: ${this.campaignId}`);
+    }
+    return response;
+  },
+};

package/actions/common/{common.mjs → common-contacts.mjs}

@@ -1,13 +1,10 @@
-import { ConfigurationError } from "@pipedream/platform";
 import { parseObjectEntries } from "../../common/utils.mjs";
-import app from "../../highlevel_oauth.app.mjs";
+import common from "../../common/base.mjs";
 
 export default {
+  ...common,
   props: {
-    app: {
-      ...app,
-      reloadProps: true,
-    },
+    ...common.props,
     name: {
       type: "string",
       label: "Name",
@@ -34,15 +31,8 @@ export default {
       optional: true,
     },
   },
-  async additionalProps() {
-    const locationId = this.app.getLocationId();
-    if (!locationId) {
-      throw new ConfigurationError("This component requires you to authenticate as a **location**, not as an agency/company. *(`locationId` field is missing from `$auth`)*");
-    }
-
-    return {};
-  },
   methods: {
+    ...common.methods,
     getData(useLocation = true) {
       const {
         app, additionalOptions, locationId, ...data

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

@@ -1,4 +1,4 @@
-import common from "../common/common.mjs";
+import common from "../common/common-contacts.mjs";
 
 const {
   props: {
@@ -11,7 +11,7 @@ export default {
   key: "highlevel_oauth-create-contact",
   name: "Create Contact",
   description: "Creates a new contact on HighLevel. [See the documentation](https://highlevel.stoplight.io/docs/integrations/4c8362223c17b-create-contact)",
-  version: "0.0.1",
+  version: "0.0.2",
   type: "action",
   props: {
     app,

package/actions/update-contact/update-contact.mjs

@@ -1,4 +1,4 @@
-import common from "../common/common.mjs";
+import common from "../common/common-contacts.mjs";
 
 const {
   props: {
@@ -11,7 +11,7 @@ export default {
   key: "highlevel_oauth-update-contact",
   name: "Update Contact",
   description: "Updates a selected contact on HighLevel. [See the documentation](https://highlevel.stoplight.io/docs/integrations/9ce5a739d4fb9-update-contact)",
-  version: "0.0.1",
+  version: "0.0.2",
   type: "action",
   props: {
     app,

package/actions/upsert-contact/upsert-contact.mjs

@@ -1,4 +1,4 @@
-import common from "../common/common.mjs";
+import common from "../common/common-contacts.mjs";
 
 const {
   props: {
@@ -11,7 +11,7 @@ export default {
   key: "highlevel_oauth-upsert-contact",
   name: "Upsert Contact",
   description: "Creates or updates a contact on HighLevel. [See the documentation](https://highlevel.stoplight.io/docs/integrations/f71bbdd88f028-upsert-contact)",
-  version: "0.0.1",
+  version: "0.0.2",
   type: "action",
   props: {
     app,

package/common/base.mjs

@@ -0,0 +1,19 @@
+import { ConfigurationError } from "@pipedream/platform";
+import app from "../highlevel_oauth.app.mjs";
+
+export default {
+  props: {
+    app: {
+      ...app,
+      reloadProps: true,
+    },
+  },
+  async additionalProps() {
+    const locationId = this.app.getLocationId();
+    if (!locationId) {
+      throw new ConfigurationError("This component requires you to authenticate as a **location**, not as an agency/company. *(`locationId` field is missing from `$auth`)*");
+    }
+
+    return {};
+  },
+};

package/highlevel_oauth.app.mjs

@@ -31,6 +31,24 @@ export default {
         }));
       },
     },
+    campaignId: {
+      type: "string",
+      label: "Campaign ID",
+      description: "The ID of the campaign to add contact to",
+      async options() {
+        const { campaigns } = await this.listCampaigns({
+          params: {
+            locationId: this.getLocationId(),
+          },
+        });
+        return campaigns?.map(({
+          id: value, name: label,
+        }) => ({
+          label,
+          value,
+        })) || [];
+      },
+    },
   },
   methods: {
     getLocationId() {
@@ -39,7 +57,7 @@ export default {
     _baseUrl() {
       return "https://services.leadconnectorhq.com";
     },
-    async _makeRequest({
+    _makeRequest({
       $ = this,
       headers,
       ...otherOpts
@@ -54,14 +72,14 @@ export default {
         ...otherOpts,
       });
     },
-    async createContact(args) {
+    createContact(args = {}) {
       return this._makeRequest({
         method: "POST",
         url: "/contacts/",
         ...args,
       });
     },
-    async updateContact({
+    updateContact({
       contactId, ...args
     }) {
       return this._makeRequest({
@@ -70,18 +88,39 @@ export default {
         ...args,
       });
     },
-    async upsertContact(args) {
+    upsertContact(args = {}) {
       return this._makeRequest({
         method: "POST",
         url: "/contacts/upsert",
         ...args,
       });
     },
-    async searchContacts(args) {
+    searchContacts(args = {}) {
       return this._makeRequest({
         url: "/contacts/",
         ...args,
       });
     },
+    listCampaigns(args = {}) {
+      return this._makeRequest({
+        url: "/campaigns/",
+        ...args,
+      });
+    },
+    listFormSubmissions(args = {}) {
+      return this._makeRequest({
+        url: "/forms/submissions",
+        ...args,
+      });
+    },
+    addContactToCampaign({
+      contactId, campaignId, ...args
+    }) {
+      return this._makeRequest({
+        method: "POST",
+        url: `/contacts/${contactId}/campaigns/${campaignId}`,
+        ...args,
+      });
+    },
   },
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pipedream/highlevel_oauth",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "Pipedream HighLevel (OAuth) Components",
   "main": "highlevel_oauth.app.mjs",
   "keywords": [
@@ -13,6 +13,6 @@
     "access": "public"
   },
   "dependencies": {
-    "@pipedream/platform": "^1.6.2"
+    "@pipedream/platform": "^3.0.3"
   }
 }

package/sources/common/base-polling.mjs

@@ -0,0 +1,25 @@
+import common from "../../common/base.mjs";
+import { DEFAULT_POLLING_SOURCE_TIMER_INTERVAL } from "@pipedream/platform";
+
+export default {
+  ...common,
+  props: {
+    ...common.props,
+    db: "$.service.db",
+    timer: {
+      type: "$.interface.timer",
+      default: {
+        intervalSeconds: DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
+      },
+    },
+  },
+  methods: {
+    ...common.methods,
+    _getLastDate() {
+      return this.db.get("lastDate");
+    },
+    _setLastDate(lastDate) {
+      this.db.set("lastDate", lastDate);
+    },
+  },
+};

package/sources/new-contact-created/new-contact-created.mjs

@@ -0,0 +1,50 @@
+import common from "../common/base-polling.mjs";
+import sampleEmit from "./test-event.mjs";
+
+export default {
+  ...common,
+  key: "highlevel_oauth-new-contact-created",
+  name: "New Contact Created",
+  description: "Emit new event when a new contact is created. [See the documentation](https://highlevel.stoplight.io/docs/integrations/ab55933a57f6f-get-contacts)",
+  version: "0.0.1",
+  type: "source",
+  dedupe: "unique",
+  methods: {
+    ...common.methods,
+    generateMeta(contact) {
+      return {
+        id: contact.id,
+        summary: `New Contact ID: ${contact.id}`,
+        ts: Date.parse(contact.dateAdded),
+      };
+    },
+  },
+  async run() {
+    const results = [];
+    const params = {
+      limit: 100,
+      startAfter: this._getLastDate(),
+      locationId: this.app.getLocationId(),
+    };
+    let total;
+
+    do {
+      const {
+        contacts, meta,
+      } = await this.app.searchContacts({
+        params,
+      });
+      results.push(...contacts);
+      params.startAfter = meta?.startAfter;
+      total = meta?.total;
+    } while (results.length < total);
+
+    this._setLastDate(params.startAfter);
+
+    results.forEach((contact) => {
+      const meta = this.generateMeta(contact);
+      this.$emit(contact, meta);
+    });
+  },
+  sampleEmit,
+};

package/sources/new-contact-created/test-event.mjs

@@ -0,0 +1,35 @@
+export default {
+  "id": "jLxz55idEps7XRAgsWMz",
+  "locationId": "t8lsEHvfdlZugCobd4t7",
+  "contactName": "(example) casey morgan",
+  "firstName": "(example) casey",
+  "lastName": "morgan",
+  "firstNameRaw": "(Example) Casey",
+  "lastNameRaw": "Morgan",
+  "companyName": "(Example) Dunder Mifflin",
+  "email": null,
+  "phone": "+16541234567",
+  "dnd": false,
+  "dndSettings": {},
+  "type": "lead",
+  "source": null,
+  "assignedTo": null,
+  "city": null,
+  "state": null,
+  "postalCode": null,
+  "address1": null,
+  "dateAdded": "2025-04-04T16:00:08.369Z",
+  "dateUpdated": "2025-04-04T16:00:12.888Z",
+  "dateOfBirth": null,
+  "businessId": "67f001fe6b2c160e6f140161",
+  "tags": [
+    "high priority",
+    "follow-up"
+  ],
+  "followers": [],
+  "country": "US",
+  "website": null,
+  "timezone": null,
+  "additionalEmails": [],
+  "customFields": []
+}

package/sources/new-form-submission/new-form-submission.mjs

@@ -0,0 +1,59 @@
+import common from "../common/base-polling.mjs";
+import sampleEmit from "./test-event.mjs";
+
+export default {
+  ...common,
+  key: "highlevel_oauth-new-form-submission",
+  name: "New Form Submission",
+  description: "Emit new event when a new form submission is created. [See the documentation](https://highlevel.stoplight.io/docs/integrations/a6114bd7685d1-get-forms-submissions)",
+  version: "0.0.1",
+  type: "source",
+  dedupe: "unique",
+  methods: {
+    ...common.methods,
+    generateMeta(submission) {
+      return {
+        id: submission.id,
+        summary: `New Submission ID: ${submission.id}`,
+        ts: Date.parse(submission.createdAt),
+      };
+    },
+  },
+  async run() {
+    const lastDate = this._getLastDate();
+    let maxDate = lastDate;
+
+    const results = [];
+    const params = {
+      limit: 100,
+      page: 1,
+      startAt: lastDate,
+      locationId: this.app.getLocationId(),
+    };
+    let total;
+
+    do {
+      const {
+        submissions = [], meta,
+      } = await this.app.listFormSubmissions({
+        params,
+      });
+      for (const submission of submissions) {
+        results.push(submission);
+        if (!maxDate || Date.parse(submission.createdAt) > Date.parse(maxDate)) {
+          maxDate = submission.createdAt.slice(0, 10);
+        }
+      }
+      total = meta?.total;
+      params.page++;
+    } while (results.length < total);
+
+    this._setLastDate(maxDate);
+
+    results.forEach((submission) => {
+      const meta = this.generateMeta(submission);
+      this.$emit(submission, meta);
+    });
+  },
+  sampleEmit,
+};

package/sources/new-form-submission/test-event.mjs

@@ -0,0 +1,59 @@
+export default {
+  "id": "67f029b5735c5378f6ba3b8a",
+  "contactId": "2N41CyHhuw4dUROfablK",
+  "formId": "AhRYrvMdMFRmZ7GxDlDS",
+  "name": "",
+  "email": "email@email.com",
+  "others": {
+    "first_name": "",
+    "last_name": "",
+    "phone": "",
+    "email": "email@email.com",
+    "terms_and_conditions": "By checking this box, I consent to receive transactional messages related to my account, orders, or services I have requested. These messages may include appointment reminders, order confirmations, and account notifications among others. Message frequency may vary. Message & Data rates may apply.Reply HELP for help or STOP to opt-out.; By checking this box, I consent to receive marketing and promotional messages, including special offers, discounts, new product updates among others. Message frequency may vary. Message & Data rates may apply. Reply HELP for help or STOP to opt-out.",
+    "formId": "AhRYrvMdMFRmZ7GxDlDS",
+    "location_id": "t8lsEHvfdlZugCobd4t7",
+    "sessionId": "59cdf305-4ac2-402d-bdbd-6e1e99be33cc",
+    "eventData": {
+      "source": "Direct traffic",
+      "referrer": "https://app.gohighlevel.com",
+      "adSource": "",
+      "page": {
+        "url": "https://link.apisystem.tech/widget/form/AhRYrvMdMFRmZ7GxDlDS",
+        "title": ""
+      },
+      "timestamp": 1743792563661,
+      "contactSessionIds": {
+        "ids": [
+          "59cdf305-4ac2-402d-bdbd-6e1e99be33cc"
+        ]
+      },
+      "fbp": "",
+      "fbc": "",
+      "type": "page-visit",
+      "parentId": "AhRYrvMdMFRmZ7GxDlDS",
+      "pageVisitType": "form",
+      "domain": "link.apisystem.tech",
+      "version": "v3",
+      "parentName": "Form 0",
+      "fingerprint": null,
+      "documentURL": "https://link.apisystem.tech/widget/form/AhRYrvMdMFRmZ7GxDlDS",
+      "fbEventId": "024451af-ea45-4e6e-8b83-3385fb5eaff1",
+      "medium": "form",
+      "mediumId": "AhRYrvMdMFRmZ7GxDlDS"
+    },
+    "Timezone": "America/Detroit (GMT-04:00)",
+    "fieldsOriSequance": [
+      "first_name",
+      "last_name",
+      "phone",
+      "email",
+      "terms_and_conditions",
+      "button",
+      "header"
+    ],
+    "submissionId": "4e3e3cef-2ed9-421e-b939-2200e68ec3e8",
+    "signatureHash": "U2FsdGVkX1+dZ1Qwj2YqgNrQ7WORnn2C2oJMM2gicn1jU5f36Qfrmwnil5YbCjow2fGNVwUkegq4cCd7DMYSJlmd8j6W08aD0p10US7A6D15WcJ7uGVdOf8P++6aipHIBEF50SAfO09tucoLG56hRj1W6JxPmGdgVMlTWt8ZaiawTZlC4/93w9PCfXcrQ7hMZXMgP5/rt5/B08QQdhtTtW4sXTeShMWxSUIMCLZ/3MmWJ45P8zrwqeS2BFeQMpoKwNKx/Kv9jqMloZPVFt5dDo5Ak0CXUsBR0XDjxL7Ut5Wq+NXC7630yQrrGb1XgZFwqfMAKEXYosLV5lM6ai8Wo9eWOdpLPeAtXHw+p8MK3GX0mCXHuoHSINmS+ZBp43h366vXfPpe0Zxxz0Ll7hm5BA+/KiP4Ya7MnUYf3fhVMUhc9fk6SP3mAPQh+SkRoWxyAhVHdQaLkP7NFzg0aoBCUSCmK7XASpZS/tY9+oPuh77bkee3Sd7UQeKRiqV/Bjr7Bf8lmtVEEyUHgaVgRJB5WAoW2l6/kjE92FpLilH0eO5Iz8tFXWj+52hyKR5s70E0H02vrwg56awumTSiPMhrKMKik7bvHy3G8frMFe9TAy//nF3Sq+Pb3Lvb4pnp58WjrD3z9SDBgejdUAfukOaX5o6V5kFeXBSgKEFVle8hO2+KBcQNqoVXwa6ug1zfDiwAX+Yc2TFbbEZzLrDWLQjujt5+Jbo/PAlyqE5cSzft4FZUeheFJnuHWUoUowhrhWwlb5UMNnoEPQVjOmhoM6WG/pho9eG38MtSVDIsbQ6iuY0WhWvKX9z56E4CyxlvuxUparO/g+KWRV0g8dJe2kgvHrPOkBo2nrXer0eMbQjhtU4dn198BssWCWCMksbeBuB5bPR7k0zKVu0yViao3NZhSNcvOQGhsdknyq4rpCKi8KfK8inkwhMYUjbGBOMlRToPVPupca1czwoLw9cqRT2FzVBQW1aorDHxyv7CwbcAD9ICBiJ70ql/gpXYTdR/PK2erWsegtMD2MPdlATlWv/0qctXipDlnPcxpg9jcqcRWDbrRYCv59VogBthp8pAZiVSiC7/GpNmosYIQjgXpCt8IHkJ42Tdl9e/3UCRqgNfqcZb7tW4ZGSz4FVbL7ZLjZkVbA5b10xY7SGsdQFMrF7tZ5Hjj0czTACNOCtAdCKAf2DdBj1IZM4dpCTX1jONJpBjFDX5Id8Gly1moh9WW6vUe0IIgcfjSBlZ5m52/agTGlEofIDpOCf8pzDUrmusvmnQBhJbY+mpGBGXUnqJkXt8+KXPxwTyfxx5yrnHIEQcgK6Xkr6pk/mdVb5OZTa3Lu+XrnLAFIwO4EuKe5ZtVoyND/Eftu+Fdcuhl/flGh020z5KV3GjOIVTDlDVZTrS2bndLQ4LI1S/30tqFPm7lpYE9Sw7Ef/95Hrjx7Qe3LsIfMrqaPFsk0JNUinf6zRzEIMHYeU9gruv8pRxIUXIz5Hkh7Xdm2s8jkEwu6f1kDgZT7xJz0KparFUns6lRW3JD5Rj3v9N+SVCpIKUyMbJPI0jlVs/J5b+dioEtGHNEI8MtM7HSgzglPe0yeZVvGbWe3TW4ow4pc7WLipxfWGpRp4ZFAOxurr1L9Gp6nQdNc5I9Jdae5k1Gyd41pfGXfvN2/nEqDqYziLGuiKctJRi8exAi75v1RhcN5OUCN4XFxfzUMqceigpTR3x9hIXM8X/6jJOJWxn1TNgVkz57PHoYLuEdUq2RmaDf5isIqyVVNrutEP2wKXL1+voovJF3suRTDydKDJKjI2sZ3XobhWTmcMkISLnPWe/M3cqi3zck2MagRAi6cak2ePvpjMWjgWwT0LWbBqM25udEjq7PKbtb6xqHiw/wf9pkeQIPVGpWf3wXFhjBMcjhAiclWH3l8dyWXJL+4LNpRddah9qVtG1d/Wq3QouhVx+zs98PBlqAF/S0d8x91hcJ24fRPK/YDbL4HQszw9bycYK6HMO0rPlPTnhS1EnrNKyNY6Khb55Cq1grCZYHBC4Q8FQDFaXmgC/Mu8KIwjDIShrXId/xI9poc0Qr0hPo71kFnFympyGJDRHnwxycMk+ySHPy+VLvsPcYDVpajtVXcXxkB4gfbIP0CQQnSj6tLMTZIVN+WlrUxZMGheb0hOTeMWtgHg1qi+xZCDL",
+    "ip": "47.225.143.157"
+  },
+  "createdAt": "2025-04-04T18:49:25.568Z"
+}