@pipedream/zoom 0.3.5 → 0.4.0

package/actions/get-webinar-details/get-webinar-details.mjs

@@ -1,38 +1,52 @@
-// legacy_hash_id: a_WYie0m
-import { axios } from "@pipedream/platform";
+import app from "../../zoom.app.mjs";
 
 export default {
   key: "zoom-get-webinar-details",
   name: "Get Webinar Details",
-  description: "Gets details of a scheduled webinar.",
-  version: "0.2.1",
+  description: "Gets details of a scheduled webinar. [See the docs here](https://marketplace.zoom.us/docs/api-reference/zoom-api/methods/#operation/webinar).",
+  version: "0.3.0",
   type: "action",
   props: {
-    zoom: {
-      type: "app",
-      app: "zoom",
+    app,
+    webinarId: {
+      propDefinition: [
+        app,
+        "webinarId",
+      ],
     },
-    webinar_id: {
-      type: "integer",
-      description: "The webinar ID.",
-    },
-    occurrence_id: {
+    occurrenceId: {
       type: "string",
+      label: "Occurrence ID",
       description: "Unique Identifier that identifies an occurrence of a recurring webinar.  Recurring webinars can have a maximum of 50 occurrences.",
       optional: true,
     },
   },
-  async run({ $ }) {
-  //See the API docs here: https://marketplace.zoom.us/docs/api-reference/zoom-api/webinars/webinar
-    const config = {
-      url: `https://api.zoom.us/v2/webinars/${this.webinar_id}`,
+  methods: {
+    getWebinarDetails({
+      webinarId, ...args
+    } = {}) {
+      return this.app._makeRequest({
+        path: `/webinars/${webinarId}`,
+        ...args,
+      });
+    },
+  },
+  async run({ $: step }) {
+    const {
+      webinarId,
+      occurrenceId,
+    } = this;
+
+    const response = await this.getWebinarDetails({
+      step,
+      webinarId,
       params: {
-        occurrence_id: this.occurrence_id,
+        occurrence_id: occurrenceId,
       },
-      headers: {
-        Authorization: `Bearer ${this.zoom.$auth.oauth_access_token}`,
-      },
-    };
-    return await axios($, config);
+    });
+
+    step.export("$summary", `Successfully retrieved webinar details with ID \`${response.id}\``);
+
+    return response;
   },
 };

package/actions/list-past-meeting-participants/list-past-meeting-participants.mjs

@@ -1,36 +1,38 @@
-// legacy_hash_id: a_YEik5g
-import { axios } from "@pipedream/platform";
+import app from "../../zoom.app.mjs";
 
 export default {
   key: "zoom-list-past-meeting-participants",
   name: "List Past Meeting Participants",
-  description: "Retrieve information on participants from a past meeting.",
-  version: "0.1.1",
+  description: "Retrieve information on participants from a past meeting. [See the docs here](https://marketplace.zoom.us/docs/api-reference/zoom-api/methods/#operation/pastMeetingParticipants).",
+  version: "0.2.0",
   type: "action",
   props: {
-    zoom: {
-      type: "app",
-      app: "zoom",
+    app,
+    meetingId: {
+      propDefinition: [
+        app,
+        "meetingId",
+      ],
     },
-    meeting_id: {
-      type: "string",
+  },
+  methods: {
+    listPastMeetingParticipants({
+      meetingId, ...args
+    } = {}) {
+      return this.app._makeRequest({
+        path: `/past_meetings/${meetingId}/participants`,
+        ...args,
+      });
     },
   },
-  async run({ $ }) {
-    const config = {
-      url: `https://api.zoom.us/v2/past_meetings/${this.meeting_id}/participants`,
-      headers: {
-        Authorization: `Bearer ${this.zoom.$auth.oauth_access_token}`,
-      },
-    };
+  async run({ $: step }) {
+    const { participants } = await this.listPastMeetingParticipants({
+      step,
+      meetingId: this.meetingId,
+    });
 
-    const results = await axios($, config);
+    step.export("$summary", `Successfully retrieved ${participants.length} past meeting participants`);
 
-    return results.participants.filter((element, index) => {
-      const _element = JSON.stringify(element);
-      return index === results.participants.findIndex((obj) => {
-        return JSON.stringify(obj) === _element;
-      });
-    });
+    return participants;
   },
 };

package/actions/list-webinar-participants-report/list-webinar-participants-report.mjs

@@ -0,0 +1,68 @@
+import app from "../../zoom.app.mjs";
+import utils from "../../common/utils.mjs";
+
+export default {
+  key: "zoom-list-webinar-participants-report",
+  name: "List Webinar Participants Report",
+  description: "Retrieves detailed report on each webinar attendee. You can get webinar participant reports for the last 6 months. [See the docs here](https://marketplace.zoom.us/docs/api-reference/zoom-api/methods/#operation/reportWebinarParticipants).",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    app,
+    webinarId: {
+      propDefinition: [
+        app,
+        "webinarId",
+      ],
+    },
+    nextPageToken: {
+      propDefinition: [
+        app,
+        "nextPageToken",
+      ],
+    },
+    max: {
+      propDefinition: [
+        app,
+        "max",
+      ],
+    },
+  },
+  methods: {
+    async listWebinarParticipantsReport({
+      webinarId, ...args
+    } = {}) {
+      return this.app._makeRequest({
+        path: `/report/webinars/${webinarId}/participants`,
+        ...args,
+      });
+    },
+  },
+  async run({ $: step }) {
+    const {
+      webinarId,
+      nextPageToken,
+      max,
+    } = this;
+
+    const stream = await this.app.getResourcesStream({
+      resourceFn: this.listWebinarParticipantsReport,
+      resourceFnArgs: {
+        step,
+        webinarId,
+        params: {
+          page_size: 300,
+          next_page_token: nextPageToken,
+        },
+      },
+      resourceName: "participants",
+      max,
+    });
+
+    const participants = await utils.streamIterator(stream);
+
+    step.export("$summary", `Successfully retrieved ${utils.summaryEnd(participants.length, "participant")}.`);
+
+    return participants;
+  },
+};

package/common/constants.mjs

@@ -0,0 +1,9 @@
+const BASE_URL = "https://api.zoom.us";
+const VERSION_PATH = "/v2";
+const MAX_RESOURCES = 300;
+
+export default {
+  BASE_URL,
+  VERSION_PATH,
+  MAX_RESOURCES,
+};

package/common/utils.mjs

@@ -0,0 +1,20 @@
+async function streamIterator(stream) {
+  const resources = [];
+  for await (const resource of stream) {
+    resources.push(resource);
+  }
+  return resources;
+}
+
+function summaryEnd(count, singular, plural) {
+  if (!plural) {
+    plural = singular + "s";
+  }
+  const noun = count === 1 && singular || plural;
+  return `${count} ${noun}`;
+}
+
+export default {
+  streamIterator,
+  summaryEnd,
+};

package/package.json

@@ -1,20 +1,19 @@
 {
   "name": "@pipedream/zoom",
-  "version": "0.3.5",
+  "version": "0.4.0",
   "description": "Pipedream Zoom Components",
-  "main": "zoom.app.js",
+  "main": "zoom.app.mjs",
   "keywords": [
     "pipedream",
     "zoom"
   ],
   "homepage": "https://pipedream.com/apps/zoom",
   "author": "Pipedream <support@pipedream.com> (https://pipedream.com/)",
-  "license": "MIT",
   "gitHead": "e12480b94cc03bed4808ebc6b13e7fdb3a1ba535",
   "publishConfig": {
     "access": "public"
   },
   "dependencies": {
-    "@pipedream/platform": "^1.1.0"
+    "@pipedream/platform": "^1.3.0"
   }
 }

package/sources/common/common.mjs

@@ -1,8 +1,8 @@
-import zoom from "../../zoom.app.mjs";
+import app from "../../zoom.app.mjs";
 
 export default {
   props: {
-    zoom,
+    app,
   },
   methods: {
     sortByDate(objects, field) {

package/sources/common/constants.mjs

@@ -1,108 +1,110 @@
-const CUSTOM_EVENT_TYPES = [
-  "meeting.alert",
-  "meeting.created.by_me",
-  "meeting.created.for_me",
-  "meeting.updated",
-  "meeting.deleted.by_me",
-  "meeting.deleted.for_me",
-  "meeting.started",
-  "meeting.ended",
-  "meeting.registration_created",
-  "meeting.registration_approved",
-  "meeting.registration_cancelled",
-  "meeting.registration_denied",
-  "meeting.sharing_started.host",
-  "meeting.sharing_started.participant",
-  "meeting.sharing_ended.host",
-  "meeting.sharing_ended.participant",
-  "meeting.participant_jbh_joined",
-  "meeting.participant_jbh_waiting",
-  "meeting.participant_joined",
-  "meeting.participant_left",
-  "meeting.participant_joined_waiting_room",
-  "meeting.participant_admitted",
-  "meeting.participant_put_in_waiting_room",
-  "meeting.participant_left_waiting_room",
-  "recording.started",
-  "recording.paused",
-  "recording.resumed",
-  "recording.stopped",
-  "recording.completed",
-  "recording.trashed.by_me",
-  "recording.trashed.for_me",
-  "recording.deleted.by_me",
-  "recording.deleted.for_me",
-  "recording.recovered.by_me",
-  "recording.recovered.for_me",
-  "recording.transcript_completed",
-  "recording.registration_created",
-  "recording.registration_approved",
-  "recording.registration_denied",
-  "user.updated",
-  "user.settings_updated",
-  "user.signed_in",
-  "user.signed_out",
-  "webinar.created.by_me",
-  "webinar.created.for_me",
-  "webinar.updated",
-  "webinar.started",
-  "webinar.ended",
-  "webinar.alert",
-  "webinar.sharing_started.host",
-  "webinar.sharing_started.participant",
-  "webinar.sharing_ended",
-  "webinar.registration_created",
-  "webinar.registration_approved",
-  "webinar.registration_denied",
-  "webinar.registration_cancelled",
-  "webinar.participant_joined",
-  "webinar.participant_left",
-];
+const CUSTOM_EVENT_TYPES = {
+  MEETING_ALERT: "meeting.alert",
+  MEETING_CREATED_BY_ME: "meeting.created.by_me",
+  MEETING_CREATED_FOR_ME: "meeting.created.for_me",
+  MEETING_UPDATED: "meeting.updated",
+  MEETING_DELETED_BY_ME: "meeting.deleted.by_me",
+  MEETING_DELETED_FOR_ME: "meeting.deleted.for_me",
+  MEETING_STARTED: "meeting.started",
+  MEETING_ENDED: "meeting.ended",
+  MEETING_REGISTRATION_CREATED: "meeting.registration_created",
+  MEETING_REGISTRATION_APPROVED: "meeting.registration_approved",
+  MEETING_REGISTRATION_CANCELLED: "meeting.registration_cancelled",
+  MEETING_REGISTRATION_DENIED: "meeting.registration_denied",
+  MEETING_SHARING_STARTED_HOST: "meeting.sharing_started.host",
+  MEETING_SHARING_STARTED_PARTICIPANT: "meeting.sharing_started.participant",
+  MEETING_SHARING_ENDED_HOST: "meeting.sharing_ended.host",
+  MEETING_SHARING_ENDED_PARTICIPANT: "meeting.sharing_ended.participant",
+  MEETING_PARTICIPANT_JBH_JOINED: "meeting.participant_jbh_joined",
+  MEETING_PARTICIPANT_JBH_WAITING: "meeting.participant_jbh_waiting",
+  MEETING_PARTICIPANT_JOINED: "meeting.participant_joined",
+  MEETING_PARTICIPANT_LEFT: "meeting.participant_left",
+  MEETING_PARTICIPANT_JOINED_WAITING_ROOM: "meeting.participant_joined_waiting_room",
+  MEETING_PARTICIPANT_ADMITTED: "meeting.participant_admitted",
+  MEETING_PARTICIPANT_PUT_IN_WAITING_ROOM: "meeting.participant_put_in_waiting_room",
+  MEETING_PARTICIPANT_LEFT_WAITING_ROOM: "meeting.participant_left_waiting_room",
+  RECORDING_STARTED: "recording.started",
+  RECORDING_PAUSED: "recording.paused",
+  RECORDING_RESUMED: "recording.resumed",
+  RECORDING_STOPPED: "recording.stopped",
+  RECORDING_COMPLETED: "recording.completed",
+  RECORDING_TRASHED_BY_ME: "recording.trashed.by_me",
+  RECORDING_TRASHED_FOR_ME: "recording.trashed.for_me",
+  RECORDING_DELETED_BY_ME: "recording.deleted.by_me",
+  RECORDING_DELETED_FOR_ME: "recording.deleted.for_me",
+  RECORDING_RECOVERED_BY_ME: "recording.recovered.by_me",
+  RECORDING_RECOVERED_FOR_ME: "recording.recovered.for_me",
+  RECORDING_TRANSCRIPT_COMPLETED: "recording.transcript_completed",
+  RECORDING_REGISTRATION_CREATED: "recording.registration_created",
+  RECORDING_REGISTRATION_APPROVED: "recording.registration_approved",
+  RECORDING_REGISTRATION_DENIED: "recording.registration_denied",
+  USER_UPDATED: "user.updated",
+  USER_SETTINGS_UPDATED: "user.settings_updated",
+  USER_SIGNED_IN: "user.signed_in",
+  USER_SIGNED_OUT: "user.signed_out",
+  WEBINAR_CREATED_BY_ME: "webinar.created.by_me",
+  WEBINAR_CREATED_FOR_ME: "webinar.created.for_me",
+  WEBINAR_UPDATED: "webinar.updated",
+  WEBINAR_STARTED: "webinar.started",
+  WEBINAR_ENDED: "webinar.ended",
+  WEBINAR_ALERT: "webinar.alert",
+  WEBINAR_SHARING_STARTED_HOST: "webinar.sharing_started.host",
+  WEBINAR_SHARING_STARTED_PARTICIPANT: "webinar.sharing_started.participant",
+  WEBINAR_SHARING_ENDED: "webinar.sharing_ended",
+  WEBINAR_REGISTRATION_CREATED: "webinar.registration_created",
+  WEBINAR_REGISTRATION_APPROVED: "webinar.registration_approved",
+  WEBINAR_REGISTRATION_DENIED: "webinar.registration_denied",
+  WEBINAR_REGISTRATION_CANCELLED: "webinar.registration_cancelled",
+  WEBINAR_PARTICIPANT_JOINED: "webinar.participant_joined",
+  WEBINAR_PARTICIPANT_LEFT: "webinar.participant_left",
+  WEBINAR_DELETED_BY_ME: "webinar.deleted.by_me",
+  WEBINAR_DELETED_FOR_ME: "webinar.deleted.for_me",
+};
 
-const PHONE_EVENT_TYPES = [
-  "phone.call_log_deleted",
-  "phone.call_log_permanently_deleted",
-  "phone.callee_answered",
-  "phone.callee_call_log_completed",
-  "phone.callee_ended",
-  "phone.callee_hold",
-  "phone.callee_meeting_inviting",
-  "phone.callee_missed",
-  "phone.callee_mute",
-  "phone.callee_rejected",
-  "phone.callee_ringing",
-  "phone.callee_unhold",
-  "phone.callee_unmute",
-  "phone.caller_call_log_completed",
-  "phone.caller_connected",
-  "phone.caller_ended",
-  "phone.caller_hold",
-  "phone.caller_meeting_inviting",
-  "phone.caller_mute",
-  "phone.caller_ringing",
-  "phone.caller_unhold",
-  "phone.caller_unmute",
-  "phone.device_registration",
-  "phone.emergency_alert",
-  "phone.generic_device_provision",
-  "phone.peering_number_cnam_updated",
-  "phone.peering_number_emergency_address_updated",
-  "phone.recording_completed",
-  "phone.recording_deleted",
-  "phone.recording_paused",
-  "phone.recording_permanently_deleted",
-  "phone.recording_resumed",
-  "phone.recording_started",
-  "phone.recording_stopped",
-  "phone.recording_transcript_completed",
-  "phone.sms_received",
-  "phone.sms_sent",
-  "phone.voicemail_deleted",
-  "phone.voicemail_permanently_deleted",
-  "phone.voicemail_received",
-  "phone.voicemail_transcript_completed",
-  "phone.warm_transfer_accepted",
-];
+const PHONE_EVENT_TYPES = {
+  PHONE_CALL_LOG_DELETED: "phone.call_log_deleted",
+  PHONE_CALL_LOG_PERMANENTLY_DELETED: "phone.call_log_permanently_deleted",
+  PHONE_CALLEE_ANSWERED: "phone.callee_answered",
+  PHONE_CALLEE_CALL_LOG_COMPLETED: "phone.callee_call_log_completed",
+  PHONE_CALLEE_ENDED: "phone.callee_ended",
+  PHONE_CALLEE_HOLD: "phone.callee_hold",
+  PHONE_CALLEE_MEETING_INVITING: "phone.callee_meeting_inviting",
+  PHONE_CALLEE_MISSED: "phone.callee_missed",
+  PHONE_CALLEE_MUTE: "phone.callee_mute",
+  PHONE_CALLEE_REJECTED: "phone.callee_rejected",
+  PHONE_CALLEE_RINGING: "phone.callee_ringing",
+  PHONE_CALLEE_UNHOLD: "phone.callee_unhold",
+  PHONE_CALLEE_UNMUTE: "phone.callee_unmute",
+  PHONE_CALLER_CALL_LOG_COMPLETED: "phone.caller_call_log_completed",
+  PHONE_CALLER_CONNECTED: "phone.caller_connected",
+  PHONE_CALLER_ENDED: "phone.caller_ended",
+  PHONE_CALLER_HOLD: "phone.caller_hold",
+  PHONE_CALLER_MEETING_INVITING: "phone.caller_meeting_inviting",
+  PHONE_CALLER_MUTE: "phone.caller_mute",
+  PHONE_CALLER_RINGING: "phone.caller_ringing",
+  PHONE_CALLER_UNHOLD: "phone.caller_unhold",
+  PHONE_CALLER_UNMUTE: "phone.caller_unmute",
+  PHONE_DEVICE_REGISTRATION: "phone.device_registration",
+  PHONE_EMERGENCY_ALERT: "phone.emergency_alert",
+  PHONE_GENERIC_DEVICE_PROVISION: "phone.generic_device_provision",
+  PHONE_PEERING_NUMBER_CNAM_UPDATED: "phone.peering_number_cnam_updated",
+  PHONE_PEERING_NUMBER_EMERGENCY_ADDRESS_UPDATED: "phone.peering_number_emergency_address_updated",
+  PHONE_RECORDING_COMPLETED: "phone.recording_completed",
+  PHONE_RECORDING_DELETED: "phone.recording_deleted",
+  PHONE_RECORDING_PAUSED: "phone.recording_paused",
+  PHONE_RECORDING_PERMANENTLY_DELETED: "phone.recording_permanently_deleted",
+  PHONE_RECORDING_RESUMED: "phone.recording_resumed",
+  PHONE_RECORDING_STARTED: "phone.recording_started",
+  PHONE_RECORDING_STOPPED: "phone.recording_stopped",
+  PHONE_RECORDING_TRANSCRIPT_COMPLETED: "phone.recording_transcript_completed",
+  PHONE_SMS_RECEIVED: "phone.sms_received",
+  PHONE_SMS_SENT: "phone.sms_sent",
+  PHONE_VOICEMAIL_DELETED: "phone.voicemail_deleted",
+  PHONE_VOICEMAIL_PERMANENTLY_DELETED: "phone.voicemail_permanently_deleted",
+  PHONE_VOICEMAIL_RECEIVED: "phone.voicemail_received",
+  PHONE_VOICEMAIL_TRANSCRIPT_COMPLETED: "phone.voicemail_transcript_completed",
+  PHONE_WARM_TRANSFER_ACCEPTED: "phone.warm_transfer_accepted",
+};
 
 export default {
   CUSTOM_EVENT_TYPES,

package/sources/custom-event/custom-event.mjs

@@ -1,29 +1,32 @@
-import zoom from "../../zoom.app.mjs";
+import common from "../common/common.mjs";
 import constants from "../common/constants.mjs";
 
 export default {
+  ...common,
   key: "zoom-custom-event",
   name: "Custom Events (Instant)",
-  description: "Listen for any events tied to your Zoom user or resources you own",
-  version: "0.0.6",
+  description: "Emit new events tied to your Zoom user or resources you own",
+  version: "0.1.0",
   type: "source",
+  dedupe: "unique",
   props: {
-    zoom,
+    ...common.props,
     eventNameOptions: {
-      label: "Zoom Events",
       type: "string[]",
-      options: constants.CUSTOM_EVENT_TYPES,
+      label: "Zoom Events",
+      description: "Select the events you want to listen for",
+      options: Object.values(constants.CUSTOM_EVENT_TYPES),
     },
-    zoomApphook: {
+    // eslint-disable-next-line pipedream/props-label, pipedream/props-description
+    apphook: {
       type: "$.interface.apphook",
-      appProp: "zoom",
-      async eventNames() {
+      appProp: "app",
+      eventNames() {
         return this.eventNameOptions;
       },
     },
   },
   async run(event) {
-    console.log(event);
     this.$emit(event, {
       id: event.payload?.object?.id,
       summary: event.event,

package/sources/meeting-created/meeting-created.mjs

@@ -1,28 +1,34 @@
 import common from "../common/common.mjs";
+import constants from "../common/constants.mjs";
 
 export default {
   ...common,
   key: "zoom-meeting-created",
   name: "Meeting Created (Instant)",
   description: "Emit new event each time a meeting is created where you're the host",
-  version: "0.0.4",
+  version: "0.1.0",
   type: "source",
-  dedupe: "unique", // Dedupe based on meeting ID
+  dedupe: "unique",
   props: {
     ...common.props,
-    zoomApphook: {
+    // eslint-disable-next-line pipedream/props-label, pipedream/props-description
+    apphook: {
       type: "$.interface.apphook",
-      appProp: "zoom",
-      eventNames: [
-        "meeting.created.by_me",
-        "meeting.created.for_me",
-      ],
+      appProp: "app",
+      eventNames() {
+        return [
+          constants.CUSTOM_EVENT_TYPES.MEETING_CREATED_BY_ME,
+          constants.CUSTOM_EVENT_TYPES.MEETING_CREATED_FOR_ME,
+        ];
+      },
     },
   },
   hooks: {
     async deploy() {
-      const { meetings } = await this.zoom.listMeetings({
-        page_size: 25,
+      const { meetings } = await this.app.listMeetings({
+        params: {
+          page_size: 25,
+        },
       });
       if (!meetings || meetings.length === 0) {
         return;

package/sources/meeting-deleted/meeting-deleted.mjs

@@ -1,25 +1,30 @@
 import common from "../common/common.mjs";
+import constants from "../common/constants.mjs";
 
 export default {
   ...common,
   key: "zoom-meeting-deleted",
   name: "Meeting Deleted (Instant)",
   description: "Emit new event each time a meeting is deleted where you're the host",
-  version: "0.0.4",
+  version: "0.1.0",
   type: "source",
-  dedupe: "unique", // Dedupe based on meeting ID
+  dedupe: "unique",
   props: {
     ...common.props,
-    zoomApphook: {
+    // eslint-disable-next-line pipedream/props-label, pipedream/props-description
+    apphook: {
       type: "$.interface.apphook",
-      appProp: "zoom",
-      eventNames: [
-        "meeting.deleted.by_me",
-        "meeting.deleted.for_me",
-      ],
+      appProp: "app",
+      eventNames() {
+        return [
+          constants.CUSTOM_EVENT_TYPES.MEETING_DELETED_BY_ME,
+          constants.CUSTOM_EVENT_TYPES.MEETING_DELETED_FOR_ME,
+        ];
+      },
     },
   },
   methods: {
+    ...common.methods,
     emitEvent(payload, object) {
       const meta = this.generateMeta(object);
       this.$emit({