@pipedream/twilio 0.3.4 → 0.3.5

package/README.md

@@ -0,0 +1,14 @@
+# Overview
+
+With the Twilio API, you can build telephone applications that make and receive
+phone calls, as well astext messaging applications that send and receive text
+messages.
+
+Some examples of applications you could build include:
+
+- A phone call application that allows you to make and receive phone calls over
+  the internet
+- A text messaging application that allows you to send and receive text
+  messages over the internet
+- A voicemail application that allows you to leave and receive voicemails over
+  the internet

package/actions/delete-call/delete-call.mjs

@@ -4,7 +4,7 @@ export default {
   key: "twilio-delete-call",
   name: "Delete Call",
   description: "Remove a call record from your account. [See the docs](https://www.twilio.com/docs/voice/api/call-resource#delete-a-call-resource) for more information",
-  version: "0.0.1",
+  version: "0.1.0",
   type: "action",
   props: {
     twilio,

package/actions/delete-message/delete-message.mjs

@@ -4,7 +4,7 @@ export default {
   key: "twilio-delete-message",
   name: "Delete Message",
   description: "Delete a message record from your account. [See the docs](https://www.twilio.com/docs/sms/api/message-resource#delete-a-message-resource) for more information",
-  version: "0.0.1",
+  version: "0.1.0",
   type: "action",
   props: {
     twilio,

package/actions/download-recording-media/download-recording-media.mjs

@@ -8,7 +8,7 @@ export default {
   key: "twilio-download-recording-media",
   name: "Download Recording Media",
   description: "Download a recording media file. [See the docs](https://www.twilio.com/docs/voice/api/recording#fetch-a-recording-media-file) for more information",
-  version: "0.0.1",
+  version: "0.1.0",
   type: "action",
   props: {
     twilio,

package/actions/get-call/get-call.mjs

@@ -1,10 +1,11 @@
 import twilio from "../../twilio.app.mjs";
+import { callToString } from "../../common/utils.mjs";
 
 export default {
   key: "twilio-get-call",
   name: "Get Call",
   description: "Return call resource of an individual call. [See the docs](https://www.twilio.com/docs/voice/api/call-resource#fetch-a-call-resource) for more information",
-  version: "0.0.1",
+  version: "0.1.0",
   type: "action",
   props: {
     twilio,
@@ -17,7 +18,7 @@ export default {
   },
   async run({ $ }) {
     const resp = await this.twilio.getCall(this.sid);
-    $.export("$summary", `Successfully fetched the call, "${this.twilio.callToString(resp)}"`);
+    $.export("$summary", `Successfully fetched the call, "${callToString(resp)}"`);
     return resp;
   },
 };

package/actions/get-message/get-message.mjs

@@ -1,10 +1,11 @@
 import twilio from "../../twilio.app.mjs";
+import { messageToString } from "../../common/utils.mjs";
 
 export default {
   key: "twilio-get-message",
   name: "Get Message",
   description: "Return details of a message. [See the docs](https://www.twilio.com/docs/sms/api/message-resource#fetch-a-message-resource) for more information",
-  version: "0.0.1",
+  version: "0.1.0",
   type: "action",
   props: {
     twilio,
@@ -17,7 +18,7 @@ export default {
   },
   async run({ $ }) {
     const resp = await this.twilio.getMessage(this.messageId);
-    $.export("$summary", `Successfully fetched the message, "${this.twilio.messageToString(resp)}"`);
+    $.export("$summary", `Successfully fetched the message, "${messageToString(resp)}"`);
     return resp;
   },
 };

package/actions/list-calls/list-calls.mjs

@@ -1,11 +1,11 @@
 import twilio from "../../twilio.app.mjs";
-import { omitEmptyStringValues } from "../../utils.mjs";
+import { omitEmptyStringValues } from "../../common/utils.mjs";
 
 export default {
   key: "twilio-list-calls",
   name: "List Calls",
   description: "Return a list of calls associated with your account. [See the docs](https://www.twilio.com/docs/voice/api/call-resource#read-multiple-call-resources) for more information",
-  version: "0.0.1",
+  version: "0.1.0",
   type: "action",
   props: {
     twilio,

package/actions/list-message-media/list-message-media.mjs

@@ -1,11 +1,11 @@
 import twilio from "../../twilio.app.mjs";
-import { omitEmptyStringValues } from "../../utils.mjs";
+import { omitEmptyStringValues } from "../../common/utils.mjs";
 
 export default {
   key: "twilio-list-message-media",
   name: "List Message Media",
   description: "Return a list of media associated with your message. [See the docs](https://www.twilio.com/docs/sms/api/media-resource#read-multiple-media-resources) for more information",
-  version: "0.0.1",
+  version: "0.1.0",
   type: "action",
   props: {
     twilio,

package/actions/list-messages/list-messages.mjs

@@ -1,12 +1,12 @@
-import twilio from "../../twilio.app.mjs";
 import { phone } from "phone";
-import { omitEmptyStringValues } from "../../utils.mjs";
+import twilio from "../../twilio.app.mjs";
+import { omitEmptyStringValues } from "../../common/utils.mjs";
 
 export default {
   key: "twilio-list-messages",
   name: "List Messages",
   description: "Return a list of messages associated with your account. [See the docs](https://www.twilio.com/docs/sms/api/message-resource#read-multiple-message-resources) for more information",
-  version: "0.0.1",
+  version: "0.1.0",
   type: "action",
   props: {
     twilio,

package/actions/list-recording-transcriptions/list-recording-transcriptions.mjs

@@ -1,11 +1,11 @@
 import twilio from "../../twilio.app.mjs";
-import { omitEmptyStringValues } from "../../utils.mjs";
+import { omitEmptyStringValues } from "../../common/utils.mjs";
 
 export default {
   key: "twilio-list-recording-transcriptions",
   name: "List Recording Transcriptions",
   description: "Return a set of transcriptions available for a recording. [See the docs](https://www.twilio.com/docs/voice/api/recording#fetch-a-recordings-transcriptions) for more information",
-  version: "0.0.1",
+  version: "0.1.0",
   type: "action",
   props: {
     twilio,

package/actions/make-phone-call/make-phone-call.mjs

@@ -1,12 +1,12 @@
-// Read the Twilio docs at https://www.twilio.com/docs/sms/api/message-resource#create-a-message-resource
-import twilio from "../../twilio.app.mjs";
 import { phone } from "phone";
+import twilio from "../../twilio.app.mjs";
+import { callToString } from "../../common/utils.mjs";
 
 export default {
   key: "twilio-make-phone-call",
   name: "Make a Phone Call",
   description: "Make a phone call, passing text that Twilio will speak to the recipient of the call. [See the docs](https://www.twilio.com/docs/voice/api/call-resource#create-a-call-resource) for more information",
-  version: "0.0.7",
+  version: "0.1.0",
   type: "action",
   props: {
     twilio,
@@ -46,7 +46,7 @@ export default {
     };
 
     const resp = await this.twilio.getClient().calls.create(data);
-    $.export("$summary", `Successfully made a new phone call, "${this.twilio.callToString(resp)}"`);
+    $.export("$summary", `Successfully made a new phone call, "${callToString(resp)}"`);
     return resp;
   },
 };

package/actions/send-mms/send-mms.mjs

@@ -1,13 +1,13 @@
-// Read the Twilio docs at https://www.twilio.com/docs/sms/api/message-resource#create-a-message-resource
-import twilio from "../../twilio.app.mjs";
 import { phone } from "phone";
+import twilio from "../../twilio.app.mjs";
+import { messageToString } from "../../common/utils.mjs";
 
 export default {
   key: "twilio-send-mms",
   name: "Send MMS",
   description: "Send an SMS with text and media files. [See the docs](https://www.twilio.com/docs/sms/api/message-resource#create-a-message-resource) for more information",
   type: "action",
-  version: "0.0.6",
+  version: "0.1.0",
   props: {
     twilio,
     from: {
@@ -53,7 +53,7 @@ export default {
     };
 
     const resp = await this.twilio.getClient().messages.create(data);
-    $.export("$summary", `Successfully sent a new MMS, "${this.twilio.messageToString(resp)}"`);
+    $.export("$summary", `Successfully sent a new MMS, "${messageToString(resp)}"`);
     return resp;
   },
 };

package/actions/send-sms/send-sms.mjs

@@ -1,13 +1,13 @@
-// Read the Twilio docs at https://www.twilio.com/docs/sms/api/message-resource#create-a-message-resource
-import twilio from "../../twilio.app.mjs";
 import { phone } from "phone";
+import twilio from "../../twilio.app.mjs";
+import { messageToString } from "../../common/utils.mjs";
 
 export default {
   key: "twilio-send-sms",
   name: "Send SMS",
   description: "Send a simple text-only SMS. [See the docs](https://www.twilio.com/docs/sms/api/message-resource#create-a-message-resource) for more information",
   type: "action",
-  version: "0.0.6",
+  version: "0.1.0",
   props: {
     twilio,
     from: {
@@ -46,7 +46,7 @@ export default {
     };
 
     const resp = await this.twilio.getClient().messages.create(data);
-    $.export("$summary", `Successfully sent a new SMS, "${this.twilio.messageToString(resp)}"`);
+    $.export("$summary", `Successfully sent a new SMS, "${messageToString(resp)}"`);
     return resp;
   },
 };

package/common/constants.mjs

@@ -0,0 +1,13 @@
+const HTTP_METHOD = {
+  POST: "POST",
+};
+
+const SERVICE_TYPE = {
+  SMS: "sms",
+  VOICE: "voice",
+};
+
+export default {
+  HTTP_METHOD,
+  SERVICE_TYPE,
+};

package/{utils.mjs → common/utils.mjs}

@@ -136,11 +136,8 @@ function recordingToString(recording) {
 }
 
 export {
-  formatTimeElapsed,
   timeBetween,
   omitEmptyStringValues,
-  valueOrEmptyString,
-  formatDateString,
   callToString,
   messageToString,
   recordingToString,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pipedream/twilio",
-  "version": "0.3.4",
+  "version": "0.3.5",
   "description": "Pipedream Twilio Components",
   "main": "twilio.app.mjs",
   "keywords": [
@@ -11,6 +11,7 @@
   "author": "Pipedream <support@pipedream.com> (https://pipedream.com/)",
   "license": "MIT",
   "dependencies": {
+    "phone": "^3.1.29",
     "twilio": "^3.54.2"
   },
   "gitHead": "e12480b94cc03bed4808ebc6b13e7fdb3a1ba535",

package/sources/common-webhook.mjs

@@ -1,5 +1,4 @@
 import twilio from "../twilio.app.mjs";
-import twilioClient from "twilio";
 
 export default {
   props: {
@@ -10,12 +9,6 @@ export default {
         "incomingPhoneNumber",
       ],
     },
-    authToken: {
-      propDefinition: [
-        twilio,
-        "authToken",
-      ],
-    },
     http: {
       label: "HTTP Responder",
       description: "Exposes a `respond()` method that lets the source issue HTTP responses",
@@ -25,43 +18,33 @@ export default {
   },
   hooks: {
     async activate() {
-      const createWebhookResp = await this.setWebhook(
-        this.incomingPhoneNumber,
-        this.http.endpoint,
-      );
+      const createWebhookResp = await this.twilio.setWebhookURL({
+        serviceType: this.getServiceType(),
+        phoneNumberSid: this.incomingPhoneNumber,
+        url: this.http.endpoint,
+      });
       console.log(createWebhookResp);
     },
     async deactivate() {
-      const deleteWebhookResp = await this.setWebhook(
-        this.incomingPhoneNumber,
-        "", // remove the webhook URL
-      );
+      // remove the webhook URL if url prop is not set
+      const deleteWebhookResp = await this.twilio.setWebhookURL({
+        serviceType: this.getServiceType(),
+        phoneNumberSid: this.incomingPhoneNumber,
+        url: "",
+      });
       console.log(deleteWebhookResp);
     },
   },
   methods: {
+    getServiceType() {
+      throw new Error("getServiceType() is not implemented!");
+    },
     getResponseBody() {
       return null;
     },
     isRelevant() {
       return true;
     },
-    validateRequest(body, headers) {
-      const twilioSignature = headers["x-twilio-signature"];
-      if (!twilioSignature) {
-        console.log("No x-twilio-signature header in request. Exiting.");
-        return false;
-      }
-
-      /** See https://www.twilio.com/docs/usage/webhooks/webhooks-security */
-      return twilioClient.validateRequest(
-        this.authToken,
-        twilioSignature,
-        /** This must match the incoming URL exactly, which contains a / */
-        `${this.http.endpoint}/`,
-        body,
-      );
-    },
     emitEvent(body, headers) {
       const meta = this.generateMeta(body, headers);
       this.$emit(body, meta);
@@ -84,15 +67,29 @@ export default {
       });
     }
 
-    if (typeof body !== "object")
+    if (typeof body !== "object") {
       body = Object.fromEntries(new URLSearchParams(body));
+    }
 
     if (!this.isRelevant(body)) {
       console.log("Event not relevant. Skipping...");
       return;
     }
 
-    if (!this.validateRequest(body, headers)) {
+    const signature = headers["x-twilio-signature"];
+    if (!signature) {
+      console.log("No x-twilio-signature header in request. Exiting.");
+      return;
+    }
+
+    // The url must match the incoming URL exactly, which contains a `/` at the end
+    const isRequestValid = this.twilio.validateRequest({
+      signature,
+      url: `${this.http.endpoint}/`,
+      params: body,
+    });
+
+    if (!isRequestValid) {
       console.log("Event could not be validated. Skipping...");
       return;
     }

package/sources/new-call/new-call.mjs

@@ -1,18 +1,18 @@
 import common from "../common-webhook.mjs";
+import constants from "../../common/constants.mjs";
 
 export default {
   ...common,
   key: "twilio-new-call",
   name: "New Call (Instant)",
-  description:
-    "Configures a webhook in Twilio, tied to a phone number, and emits an event each time a call to that number is completed",
-  version: "0.0.3",
+  description: "Emit new event each time a call to the phone number is completed. Configures a webhook in Twilio, tied to a phone number.",
+  version: "0.1.0",
   type: "source",
   dedupe: "unique",
   methods: {
     ...common.methods,
-    async setWebhook(...args) {
-      return await this.twilio.setIncomingCallWebhookURL(...args);
+    getServiceType() {
+      return constants.SERVICE_TYPE.VOICE;
     },
     generateMeta(body, headers) {
       return {

package/sources/new-incoming-sms/new-incoming-sms.mjs

@@ -1,14 +1,15 @@
-import common from "../common-webhook.mjs";
 import twilio from "twilio";
+import common from "../common-webhook.mjs";
+import constants from "../../common/constants.mjs";
+
 const MessagingResponse = twilio.twiml.MessagingResponse;
 
 export default {
   ...common,
   key: "twilio-new-incoming-sms",
   name: "New Incoming SMS (Instant)",
-  description:
-    "Configures a webhook in Twilio, tied to an incoming phone number, and emits an event each time an SMS is sent to that number",
-  version: "0.0.7",
+  description: "Emit new event every time an SMS is sent to the phone number set. Configures a webhook in Twilio, tied to an incoming phone number.",
+  version: "0.1.0",
   type: "source",
   dedupe: "unique",
   props: {
@@ -22,8 +23,8 @@ export default {
   },
   methods: {
     ...common.methods,
-    async setWebhook(...args) {
-      return await this.twilio.setIncomingSMSWebhookURL(...args);
+    getServiceType() {
+      return constants.SERVICE_TYPE.SMS;
     },
     getResponseBody() {
       const twiml = new MessagingResponse();

package/sources/new-phone-number/new-phone-number.mjs

@@ -4,8 +4,8 @@ export default {
   ...common,
   key: "twilio-new-phone-number",
   name: "New Phone Number",
-  description: "Emits an event when you add a new phone number to your account",
-  version: "0.0.3",
+  description: "Emit new event when you add a new phone number to your account",
+  version: "0.1.0",
   type: "source",
   dedupe: "unique",
   methods: {

package/sources/new-recording/new-recording.mjs

@@ -2,10 +2,10 @@ import common from "../common-polling.mjs";
 
 export default {
   ...common,
-  key: "twilio-new-phone-recording",
+  key: "twilio-new-recording",
   name: "New Recording",
-  description: "Emits an event when a new call recording is created",
-  version: "0.0.3",
+  description: "Emit new event when a new call recording is created",
+  version: "0.1.0",
   type: "source",
   dedupe: "unique",
   methods: {

package/sources/new-transcription/new-transcription.mjs

@@ -4,8 +4,8 @@ export default {
   ...common,
   key: "twilio-new-transcription",
   name: "New Transcription",
-  description: "Emits an event when a new call transcription is created",
-  version: "0.0.3",
+  description: "Emit new event when a new call transcription is created",
+  version: "0.1.0",
   type: "source",
   dedupe: "unique",
   methods: {

package/twilio.app.mjs

@@ -1,21 +1,15 @@
-import twilioClient from "twilio";
+import twilio from "twilio";
 import {
   callToString,
   messageToString,
   recordingToString,
-} from "./utils.mjs";
+} from "./common/utils.mjs";
+import constants from "./common/constants.mjs";
 
 export default {
   type: "app",
   app: "twilio",
   propDefinitions: {
-    authToken: {
-      type: "string",
-      secret: true,
-      label: "Twilio Auth Token",
-      description:
-        "Your Twilio auth token, found [in your Twilio console](https://www.twilio.com/console). Required for validating Twilio events.",
-    },
     body: {
       type: "string",
       label: "Message Body",
@@ -84,7 +78,7 @@ export default {
         const messages = await this.listMessages();
         return messages.map((message) => {
           return {
-            label: this.messageToString(message),
+            label: messageToString(message),
             value: message.sid,
           };
         });
@@ -116,7 +110,7 @@ export default {
         const recordings = await this.listRecordings();
         return recordings.map((recording) => {
           return {
-            label: this.recordingToString(recording),
+            label: recordingToString(recording),
             value: recording.sid,
           };});
       },
@@ -155,33 +149,34 @@ export default {
     },
   },
   methods: {
-    // Static methods
-    callToString,
-    messageToString,
-    recordingToString,
-
+    validateRequest({
+      signature, url, params,
+    } = {}) {
+      // See https://www.twilio.com/docs/usage/webhooks/webhooks-security
+      return twilio.validateRequest(
+        this.$auth.authToken,
+        signature,
+        url,
+        params,
+      );
+    },
     getClient() {
-      return twilioClient(this.$auth.Sid, this.$auth.Secret, {
-        accountSid: this.$auth.AccountSid,
-      });
+      return twilio(this.$auth.accountSid, this.$auth.authToken);
     },
-    async setWebhookURL(phoneNumberSid, params) {
+    setWebhookURL({
+      serviceType = constants.SERVICE_TYPE.SMS, phoneNumberSid, url,
+    } = {}) {
+      const opts = serviceType === constants.SERVICE_TYPE.SMS
+        ? {
+          smsMethod: constants.HTTP_METHOD.POST,
+          smsUrl: url,
+        }
+        : {
+          statusCallbackMethod: constants.HTTP_METHOD.POST,
+          statusCallback: url,
+        };
       const client = this.getClient();
-      return await client.incomingPhoneNumbers(phoneNumberSid).update(params);
-    },
-    async setIncomingSMSWebhookURL(phoneNumberSid, url) {
-      const params = {
-        smsMethod: "POST",
-        smsUrl: url,
-      };
-      return await this.setWebhookURL(phoneNumberSid, params);
-    },
-    async setIncomingCallWebhookURL(phoneNumberSid, url) {
-      const params = {
-        statusCallbackMethod: "POST",
-        statusCallback: url,
-      };
-      return await this.setWebhookURL(phoneNumberSid, params);
+      return client.incomingPhoneNumbers(phoneNumberSid).update(opts);
     },
     /**
      * Returns a IncomingPhoneNumber list resource representing an account's
@@ -192,9 +187,9 @@ export default {
      *
      * @returns the IncomingPhoneNumber list
      */
-    async listIncomingPhoneNumbers(params) {
+    listIncomingPhoneNumbers(params) {
       const client = this.getClient();
-      return await client.incomingPhoneNumbers.list(params);
+      return client.incomingPhoneNumbers.list(params);
     },
     /**
      * Returns a list of Recordings, each representing a recording generated
@@ -205,9 +200,9 @@ export default {
      *
      * @returns the list of recordings
      */
-    async listRecordings(params) {
+    listRecordings(params) {
       const client = this.getClient();
-      return await client.recordings.list(params);
+      return client.recordings.list(params);
     },
     /**
      * Returns a list of Transcriptions generated from all recordings in an
@@ -218,9 +213,9 @@ export default {
      *
      * @returns the list of transcriptions
      */
-    async listTranscriptions(params) {
+    listTranscriptions(params) {
       const client = this.getClient();
-      return await client.transcriptions.list(params);
+      return client.transcriptions.list(params);
     },
     /**
      * Returns a list of messages associated with your account. When getting the
@@ -232,9 +227,9 @@ export default {
      *
      * @returns the list of messages
      */
-    async listMessages(params) {
+    listMessages(params) {
       const client = this.getClient();
-      return await client.messages.list(params);
+      return client.messages.list(params);
     },
     /**
      * Returns a single message specified by the provided Message `sid`
@@ -244,9 +239,9 @@ export default {
      *
      * @returns the message
      */
-    async getMessage(sid) {
+    getMessage(sid) {
       const client = this.getClient();
-      return await client.messages(sid).fetch();
+      return client.messages(sid).fetch();
     },
     /**
      * Deletes a message record from your account. Once the record is deleted,
@@ -256,9 +251,9 @@ export default {
      * the Message resource to delete
      * @returns `true` on success
      */
-    async deleteMessage(sid) {
+    deleteMessage(sid) {
       const client = this.getClient();
-      return await client.messages(sid).remove();
+      return client.messages(sid).remove();
     },
     /**
      * Returns a list of media associated with your message
@@ -268,9 +263,9 @@ export default {
      * @param {Object} [params] - an object containing parameters to be fed to the
      * Twilio API call, as defined in [the API docs](https://bit.ly/3mc8apg)
      */
-    async listMessageMedia(messageId, params) {
+    listMessageMedia(messageId, params) {
       const client = this.getClient();
-      return await client.messages(messageId).media.list(params);
+      return client.messages(messageId).media.list(params);
     },
     /**
      * Return a list of phone calls made to and from an account
@@ -279,15 +274,15 @@ export default {
      * Twilio API call, as defined in [the API docs](https://bit.ly/3iiHIJ9)
      * @returns the list of calls
      */
-    async listCalls(params) {
+    listCalls(params) {
       const client = this.getClient();
-      return await client.calls.list(params);
+      return client.calls.list(params);
     },
     async listCallsOptions(params = {}) {
       const calls = await this.listCalls(params);
       return calls.map((call) => {
         return {
-          label: this.callToString(call),
+          label: callToString(call),
           value: call.sid,
         };
       });
@@ -298,9 +293,9 @@ export default {
      * @param {String} sid - The SID of the Call resource to fetch
      * @returns the Call
      */
-    async getCall(sid) {
+    getCall(sid) {
       const client = this.getClient();
-      return await client.calls(sid).fetch();
+      return client.calls(sid).fetch();
     },
     /**
      * This will delete a call record from the account. Once the record is
@@ -310,9 +305,9 @@ export default {
      * the Call resource to delete
      * @returns `true` on success
      */
-    async deleteCall(sid) {
+    deleteCall(sid) {
       const client = this.getClient();
-      return await client.calls(sid).remove();
+      return client.calls(sid).remove();
     },
     /**
      * Returns a recording specified by the provided Recording `sid`
@@ -322,9 +317,9 @@ export default {
      *
      * @returns the recording
      */
-    async getRecording(sid) {
+    getRecording(sid) {
       const client = this.getClient();
-      return await client.recordings(sid).fetch();
+      return client.recordings(sid).fetch();
     },
     /**
      * Returns a list of transcriptions available for the recording identified
@@ -335,9 +330,9 @@ export default {
      *
      * @returns the list of transcriptions
      */
-    async listRecordingTranscriptions(sid, params) {
+    listRecordingTranscriptions(sid, params) {
       const client = this.getClient();
-      return await client.recordings(sid).transcriptions.list(params);
+      return client.recordings(sid).transcriptions.list(params);
     },
   },
 };