OpenPhone Usability Audit (#16165)

* updates

* pnpm-lock.yaml

* pnpm-lock.yaml

Author: michelle0927

components/bettercontact/bettercontact.app.mjs

@@ -8,4 +8,4 @@ export default {
       console.log(Object.keys(this.$auth));
     },
   },
-};
+};

components/bytebot/bytebot.app.mjs

@@ -8,4 +8,4 @@ export default {
       console.log(Object.keys(this.$auth));
     },
   },
-};
+};

components/notiff/notiff.app.mjs

@@ -8,4 +8,4 @@ export default {
       console.log(Object.keys(this.$auth));
     },
   },
-};
+};

components/openphone/actions/create-contact/create-contact.mjs

@@ -5,7 +5,7 @@ export default {
   key: "openphone-create-contact",
   name: "Create Contact",
   description: "Create a new contact in OpenPhone. [See the documentation](https://www.openphone.com/docs/api-reference/contacts/create-a-contact)",
-  version: "0.0.1",
+  version: "0.0.2",
   type: "action",
   props: {
     openphone,

components/openphone/actions/list-phone-numbers/list-phone-numbers.mjs

@@ -0,0 +1,23 @@
+import openphone from "../../openphone.app.mjs";
+
+export default {
+  key: "openphone-list-phone-numbers",
+  name: "List Phone Numbers",
+  description: "Retrieve the list of phone numbers and users associated with your OpenPhone workspace. [See the documentation](https://www.openphone.com/docs/mdx/api-reference/phone-numbers/list-phone-numbers)",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    openphone,
+  },
+  async run({ $ }) {
+    const { data } = await this.openphone.listPhoneNumbers({
+      $,
+    });
+    if (data?.length) {
+      $.export("$summary", `Successfully retrieved ${data.length} phone number${data.length === 1
+        ? ""
+        : "s"}`);
+    }
+    return data;
+  },
+};

components/openphone/actions/send-message/send-message.mjs

@@ -1,11 +1,10 @@
-import { ConfigurationError } from "@pipedream/platform";
 import openphone from "../../openphone.app.mjs";
 
 export default {
   key: "openphone-send-message",
-  name: "Send a Text Message via OpenPhone",
+  name: "Send a Text Message",
   description: "Send a text message from your OpenPhone number to a recipient. [See the documentation](https://www.openphone.com/docs/api-reference/messages/send-a-text-message)",
-  version: "0.0.1",
+  version: "0.0.2",
   type: "action",
   props: {
     openphone,
@@ -27,31 +26,18 @@ export default {
     },
   },
   async run({ $ }) {
-    try {
-      const response = await this.openphone.sendTextMessage({
-        $,
-        data: {
-          content: this.content,
-          from: this.from,
-          to: [
-            this.to,
-          ],
-          setInboxStatus: "done",
-        },
-      });
-      $.export("$summary", `Successfully sent message to ${this.to}`);
-      return response;
-
-    } catch ({ response }) {
-      let errorMessage = "";
-
-      if (response.data.errors) {
-        errorMessage = `Prop: ${response.data.errors[0].path} - ${response.data.errors[0].message}`;
-      } else {
-        errorMessage = response.data.message;
-      }
-
-      throw new ConfigurationError(errorMessage);
-    }
+    const response = await this.openphone.sendTextMessage({
+      $,
+      data: {
+        content: this.content,
+        from: this.from,
+        to: [
+          this.to,
+        ],
+        setInboxStatus: "done",
+      },
+    });
+    $.export("$summary", `Successfully sent message to ${this.to}`);
+    return response;
   },
 };

components/openphone/actions/update-contact/update-contact.mjs

@@ -5,14 +5,14 @@ export default {
   key: "openphone-update-contact",
   name: "Update Contact",
   description: "Update an existing contact on OpenPhone. [See the documentation](https://www.openphone.com/docs/api-reference/contacts/update-a-contact-by-id)",
-  version: "0.0.1",
+  version: "0.0.2",
   type: "action",
   props: {
     openphone,
     contactId: {
       type: "string",
       label: "Contact ID",
-      description: "The unique identifier of the contact.",
+      description: "The unique identifier of the contact",
     },
     firstName: {
       propDefinition: [

components/openphone/openphone.app.mjs

@@ -1,4 +1,12 @@
-import { axios } from "@pipedream/platform";
+import {
+  axios, ConfigurationError,
+} from "@pipedream/platform";
+import Bottleneck from "bottleneck";
+const limiter = new Bottleneck({
+  minTime: 100, // 10 requests per seconds (https://www.openphone.com/docs/mdx/api-reference/rate-limits)
+  maxConcurrent: 1,
+});
+const axiosRateLimiter = limiter.wrap(axios);
 
 export default {
   type: "app",
@@ -10,51 +18,53 @@ export default {
       description: "The sender's phone number. Can be either your OpenPhone phone number ID or the full phone number in E.164 format.",
       async options() {
         const { data } = await this.listPhoneNumbers();
-        return data.map(({
+        return data?.map(({
           id: value, name, formattedNumber,
         }) => ({
-          label: `${name} - ${formattedNumber}`,
+          label: name && formattedNumber
+            ? `${name} - ${formattedNumber}`
+            : value,
           value,
-        }));
+        })) || [];
       },
     },
     firstName: {
       type: "string",
       label: "First Name",
-      description: "The contact's first name.",
+      description: "The contact's first name",
     },
     lastName: {
       type: "string",
       label: "Last Name",
-      description: "The contact's last name.",
+      description: "The contact's last name",
       optional: true,
     },
     company: {
       type: "string",
       label: "Company",
-      description: "The contact's company name.",
+      description: "The contact's company name",
       optional: true,
     },
     role: {
       type: "string",
       label: "Role",
-      description: "The contact's role.",
+      description: "The contact's role",
       optional: true,
     },
     emails: {
       type: "string[]",
       label: "Emails",
-      description: "Array of objects of contact's emails. **Example:** `{\"name\": \"Company Email\", \"value\": \"[email protected]\"}`.",
+      description: "Array of objects of contact's emails. **Example:** `{\"name\": \"Company Email\", \"value\": \"[email protected]\"}`",
     },
     phoneNumbers: {
       type: "string[]",
       label: "Phone Numbers",
-      description: "Array of objects of contact's phone numbers. **Example:** `{\"name\": \"Company Phone\", \"value\": \"+12345678901\"}`.",
+      description: "Array of objects of contact's phone numbers. **Example:** `{\"name\": \"Company Phone\", \"value\": \"+12345678901\"}`",
     },
     customFields: {
       type: "string[]",
       label: "Custom Fields",
-      description: "Array of objects of custom fields for the contact. **Example:** `{\"key\": \"inbound-lead\", \"value\": \"[\"option1\", \"option2\"]\"}`.",
+      description: "Array of objects of custom fields for the contact. **Example:** `{\"key\": \"inbound-lead\", \"value\": [\"option1\", \"option2\"]}`",
     },
   },
   methods: {
@@ -66,14 +76,22 @@ export default {
         Authorization: `${this.$auth.api_key}`,
       };
     },
-    _makeRequest({
+    async _makeRequest({
       $ = this, path, ...opts
     }) {
-      return axios($, {
-        url: this._baseUrl() + path,
-        headers: this._headers(),
-        ...opts,
-      });
+      try {
+        return await axiosRateLimiter($, {
+          url: this._baseUrl() + path,
+          headers: this._headers(),
+          ...opts,
+        });
+      } catch ({ response }) {
+        const errorMessage = response?.data?.errors
+          ? `Prop: ${response.data.errors[0].path} - ${response.data.errors[0].message}`
+          : response?.data?.message;
+
+        throw new ConfigurationError(errorMessage);
+      }
     },
     listPhoneNumbers(opts = {}) {
       return this._makeRequest({

components/openphone/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pipedream/openphone",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "Pipedream OpenPhone Components",
   "main": "openphone.app.mjs",
   "keywords": [
@@ -13,6 +13,7 @@
     "access": "public"
   },
   "dependencies": {
-    "@pipedream/platform": "^3.0.3"
+    "@pipedream/platform": "^3.0.3",
+    "bottleneck": "^2.19.5"
   }
 }

components/openphone/sources/common/base.mjs

@@ -12,13 +12,13 @@ export default {
       ],
       type: "string[]",
       label: "Resource IDs",
-      description: "The unique identifiers of phone numbers associated with the webhook.",
+      description: "The IDs of the incoming or outgoing phone numbers to retrieve events for. Use the List Phone Numbers action to retrieve information about phone numbers.",
       optional: true,
     },
     label: {
       type: "string",
       label: "Label",
-      description: "Webhook's label",
+      description: "A label to identify the webhook",
       optional: true,
     },
   },