@pipedream/easybroker 0.0.1 → 0.1.0

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

@@ -0,0 +1,83 @@
+import easybroker from "../../easybroker.app.mjs";
+import { ConfigurationError } from "@pipedream/platform";
+
+export default {
+  key: "easybroker-create-contact-request",
+  name: "Create Contact Request",
+  description: "Creates or updates a new lead in EasyBroker that is interested in the provided property. [See the documentation](https://dev.easybroker.com/reference/post_contact-requests)",
+  version: "0.0.1",
+  type: "action",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: false,
+  },
+  props: {
+    easybroker,
+    source: {
+      type: "string",
+      label: "Source",
+      description: "The source of the contact request. Example: `mydomain.com`",
+    },
+    propertyId: {
+      propDefinition: [
+        easybroker,
+        "propertyId",
+      ],
+      description: "The ID of the property to create the contact request for",
+      optional: true,
+    },
+    name: {
+      type: "string",
+      label: "Name",
+      description: "The name of the contact making the request",
+    },
+    email: {
+      type: "string",
+      label: "Email",
+      description: "The email address of the contact making the request",
+    },
+    phone: {
+      type: "string",
+      label: "Phone",
+      description: "The phone number of the contact making the request",
+      optional: true,
+    },
+    message: {
+      type: "string",
+      label: "Message",
+      description: "The message from the contact making the request. Example: `I'm interested in the property.`",
+    },
+  },
+  async run({ $ }) {
+    if (this.propertyId && (!this.email && !this.phone && !this.name)) {
+      throw new ConfigurationError("You must provide at least the **Email**, **Phone**, or **Name** field when creating a contact request for a specific property.");
+    }
+
+    if (!this.propertyId && !this.name) {
+      throw new ConfigurationError("You must provide the **Name** field when creating a contact request for a general lead.");
+    }
+
+    if (!this.propertyId && !this.email && !this.phone) {
+      throw new ConfigurationError("You must provide either the **Email** or **Phone** field when creating a contact request for a general lead.");
+    }
+
+    if (!this.propertyId && !this.message) {
+      throw new ConfigurationError("You must provide the **Message** field when creating a contact request for a general lead.");
+    }
+
+    const response = await this.easybroker.createContactRequest({
+      $,
+      data: {
+        source: this.source,
+        property_id: this.propertyId,
+        name: this.name,
+        email: this.email,
+        phone: this.phone,
+        message: this.message,
+      },
+    });
+    $.export("$summary", "Successfully created contact request.");
+    return response;
+  },
+};

package/actions/get-contact/get-contact.mjs

@@ -0,0 +1,31 @@
+import easybroker from "../../easybroker.app.mjs";
+
+export default {
+  key: "easybroker-get-contact",
+  name: "Get Contact",
+  description: "Get details of a contact. [See the documentation](https://dev.easybroker.com/reference/get_contacts-contact-id)",
+  version: "0.0.1",
+  type: "action",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: true,
+  },
+  props: {
+    easybroker,
+    contactId: {
+      propDefinition: [
+        easybroker,
+        "contactId",
+      ],
+    },
+  },
+  async run({ $ }) {
+    const response = await this.easybroker.getContact({
+      $,
+      contactId: this.contactId,
+    });
+    $.export("$summary", `Successfully retrieved contact with ID ${this.contactId}`);
+    return response;
+  },
+};

package/actions/get-property/get-property.mjs

@@ -0,0 +1,31 @@
+import easybroker from "../../easybroker.app.mjs";
+
+export default {
+  key: "easybroker-get-property",
+  name: "Get Property",
+  description: "Get details of a property. [See the documentation](https://dev.easybroker.com/reference/get_properties-property-id)",
+  version: "0.0.1",
+  type: "action",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: true,
+  },
+  props: {
+    easybroker,
+    propertyId: {
+      propDefinition: [
+        easybroker,
+        "propertyId",
+      ],
+    },
+  },
+  async run({ $ }) {
+    const response = await this.easybroker.getProperty({
+      $,
+      propertyId: this.propertyId,
+    });
+    $.export("$summary", `Successfully retrieved property with ID ${this.propertyId}`);
+    return response;
+  },
+};

package/actions/list-contact-requests/list-contact-requests.mjs

@@ -0,0 +1,67 @@
+import easybroker from "../../easybroker.app.mjs";
+
+export default {
+  key: "easybroker-list-contact-requests",
+  name: "List Contact Requests",
+  description: "List all contact requests. [See the documentation](https://dev.easybroker.com/reference/get_contact-requests)",
+  version: "0.0.1",
+  type: "action",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: true,
+  },
+  props: {
+    easybroker,
+    propertyId: {
+      propDefinition: [
+        easybroker,
+        "propertyId",
+      ],
+      description: "The ID of a property to retrieve the contact requests for",
+      optional: true,
+    },
+    happenedAfter: {
+      type: "string",
+      label: "Happened After",
+      description: "Get contact requests created after the given date. Example: `2025-03-01T23:26:53.402Z`",
+      optional: true,
+    },
+    happenedBefore: {
+      type: "string",
+      label: "Happened Before",
+      description: "Get contact requests created before the given date. Example: `2025-03-01T23:26:53.402Z`",
+      optional: true,
+    },
+    limit: {
+      type: "integer",
+      label: "Limit",
+      description: "The maximum number of contact requests to return",
+      optional: true,
+      max: 50,
+    },
+    page: {
+      type: "integer",
+      label: "Page",
+      description: "The page number to return",
+      optional: true,
+      default: 1,
+    },
+  },
+  async run({ $ }) {
+    const response = await this.easybroker.listContactRequests({
+      $,
+      params: {
+        property_id: this.propertyId,
+        happened_after: this.happenedAfter,
+        happened_before: this.happenedBefore,
+        limit: this.limit,
+        page: this.page,
+      },
+    });
+    $.export("$summary", `Successfully listed ${response?.content?.length} contact request${response?.content?.length === 1
+      ? ""
+      : "s"}.`);
+    return response;
+  },
+};

package/easybroker.app.mjs

@@ -1,11 +1,102 @@
+import { axios } from "@pipedream/platform";
+
 export default {
   type: "app",
   app: "easybroker",
-  propDefinitions: {},
+  propDefinitions: {
+    propertyId: {
+      type: "string",
+      label: "Property ID",
+      description: "The ID of the property to get",
+      async options({ page }) {
+        const { content } = await this.listProperties({
+          params: {
+            page: page + 1,
+          },
+        });
+        return content?.map(({
+          public_id: value, title: label,
+        }) => ({
+          label,
+          value,
+        })) || [];
+      },
+    },
+    contactId: {
+      type: "string",
+      label: "Contact ID",
+      description: "The ID of the contact to get",
+      async options({ page }) {
+        const { content } = await this.listContacts({
+          params: {
+            page: page + 1,
+          },
+        });
+        return content?.map(({
+          id: value, full_name: label,
+        }) => ({
+          label,
+          value,
+        })) || [];
+      },
+    },
+  },
   methods: {
-    // this.$auth contains connected account data
-    authKeys() {
-      console.log(Object.keys(this.$auth));
+    _baseUrl() {
+      return "https://api.easybroker.com/v1";
+    },
+    _makeRequest({
+      $ = this, path, ...opts
+    }) {
+      return axios($, {
+        url: `${this._baseUrl()}${path}`,
+        headers: {
+          "x-authorization": `${this.$auth.api_key}`,
+          "Accept": "application/json",
+        },
+        ...opts,
+      });
+    },
+    getProperty({
+      propertyId, ...opts
+    }) {
+      return this._makeRequest({
+        path: `/properties/${propertyId}`,
+        ...opts,
+      });
+    },
+    getContact({
+      contactId, ...opts
+    }) {
+      return this._makeRequest({
+        path: `/contacts/${contactId}`,
+        ...opts,
+      });
+    },
+    listProperties(opts = {}) {
+      return this._makeRequest({
+        path: "/properties",
+        ...opts,
+      });
+    },
+    listContacts(opts = {}) {
+      return this._makeRequest({
+        path: "/contacts",
+        ...opts,
+      });
+    },
+    listContactRequests(opts = {}) {
+      return this._makeRequest({
+        path: "/contact_requests",
+        ...opts,
+      });
+    },
+    createContactRequest(opts = {}) {
+      return this._makeRequest({
+        method: "POST",
+        path: "/contact_requests",
+        ...opts,
+      });
     },
   },
-};
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pipedream/easybroker",
-  "version": "0.0.1",
+  "version": "0.1.0",
   "description": "Pipedream EasyBroker Components",
   "main": "easybroker.app.mjs",
   "keywords": [
@@ -11,5 +11,8 @@
   "author": "Pipedream <support@pipedream.com> (https://pipedream.com/)",
   "publishConfig": {
     "access": "public"
+  },
+  "dependencies": {
+    "@pipedream/platform": "^3.1.1"
   }
 }

package/sources/common/base-polling.mjs

@@ -0,0 +1,36 @@
+import easybroker from "../../easybroker.app.mjs";
+import {
+  DEFAULT_POLLING_SOURCE_TIMER_INTERVAL, ConfigurationError,
+} from "@pipedream/platform";
+
+export default {
+  props: {
+    easybroker,
+    db: "$.service.db",
+    timer: {
+      type: "$.interface.timer",
+      default: {
+        intervalSeconds: DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
+      },
+    },
+  },
+  methods: {
+    _getLastCreated() {
+      return this.db.get("lastCreated");
+    },
+    _setLastCreated(lastCreated) {
+      this.db.set("lastCreated", lastCreated);
+    },
+    processEvents() {
+      throw new ConfigurationError("processEvents must be implemented");
+    },
+  },
+  hooks: {
+    async deploy() {
+      await this.processEvents(10);
+    },
+  },
+  async run() {
+    await this.processEvents();
+  },
+};

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

@@ -0,0 +1,61 @@
+import common from "../common/base-polling.mjs";
+
+export default {
+  ...common,
+  key: "easybroker-new-contact-created",
+  name: "New Contact Created",
+  description: "Emit new event when a new contact is created. [See the documentation](https://dev.easybroker.com/reference/get_contacts)",
+  version: "0.0.1",
+  type: "source",
+  dedupe: "unique",
+  methods: {
+    ...common.methods,
+    async processEvents(max) {
+      const lastCreated = this._getLastCreated();
+      let maxCreated = lastCreated;
+      let page = 1;
+      let contacts = [];
+      let hasMore = true;
+
+      do {
+        const {
+          content, pagination,
+        } = await this.easybroker.listContacts({
+          params: {
+            page,
+            limit: 50,
+          },
+        });
+        for (const contact of content) {
+          if (!lastCreated || Date.parse(contact.created_at) > Date.parse(lastCreated)) {
+            contacts.push(contact);
+            if (!maxCreated || Date.parse(contact.created_at) > Date.parse(maxCreated)) {
+              maxCreated = contact.created_at;
+            }
+          }
+        }
+        hasMore = pagination.next_page !== null;
+        page++;
+      } while (hasMore);
+
+      if (maxCreated) {
+        this._setLastCreated(maxCreated);
+      }
+
+      if (max && contacts.length >= max) {
+        contacts = contacts.slice(-1 * max);
+      }
+
+      for (const contact of contacts) {
+        this.$emit(contact, this.generateMeta(contact));
+      }
+    },
+    generateMeta(contact) {
+      return {
+        id: contact.id,
+        summary: `New Contact: ${contact.full_name}`,
+        ts: Date.parse(contact.created_at),
+      };
+    },
+  },
+};

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

@@ -0,0 +1,65 @@
+import common from "../common/base-polling.mjs";
+
+export default {
+  ...common,
+  key: "easybroker-new-contact-request-created",
+  name: "New Contact Request Created",
+  description: "Emit new event when a new contact request is created. [See the documentation](https://dev.easybroker.com/reference/get_contact-requests)",
+  version: "0.0.1",
+  type: "source",
+  dedupe: "unique",
+  methods: {
+    ...common.methods,
+    async processEvents(max) {
+      const lastCreated = this._getLastCreated();
+      let maxCreated = lastCreated;
+      let page = 1;
+      let contactRequests = [];
+      let done = false, hasMore = true;
+
+      do {
+        const {
+          content, pagination,
+        } = await this.easybroker.listContactRequests({
+          params: {
+            page,
+            limit: 50,
+            happened_after: lastCreated,
+          },
+        });
+        for (const contactRequest of content) {
+          if (!lastCreated || Date.parse(contactRequest.happened_at) > Date.parse(lastCreated)) {
+            contactRequests.push(contactRequest);
+            if (!maxCreated || Date.parse(contactRequest.happened_at) > Date.parse(maxCreated)) {
+              maxCreated = contactRequest.happened_at;
+            }
+            if (max && contactRequests.length >= max) {
+              done = true;
+              break;
+            }
+          } else {
+            done = true;
+            break;
+          }
+        }
+        hasMore = pagination.next_page !== null;
+        page++;
+      } while (hasMore && !done);
+
+      if (maxCreated) {
+        this._setLastCreated(maxCreated);
+      }
+
+      for (const contactRequest of contactRequests) {
+        this.$emit(contactRequest, this.generateMeta(contactRequest));
+      }
+    },
+    generateMeta(contactRequest) {
+      return {
+        id: contactRequest.id,
+        summary: `New Contact Request: ${contactRequest.name || contactRequest.id}`,
+        ts: Date.parse(contactRequest.happened_at),
+      };
+    },
+  },
+};