@pipedream/zoom 0.7.1 → 0.9.0

package/README.md

@@ -1,7 +1,7 @@
 # Overview
 The Zoom API lets you tap into a rich set of functionalities to enhance the video conferencing experience within your own app or workflow. With the Zoom API on Pipedream, you can automatically create meetings, manage users, send meeting notifications, and more, orchestrating these actions within a broader automation. This allows for seamless integration with other services, enabling both data collection and action triggers based on Zoom events.
 
-**Pipedream [workflows](/workflows/) allow you to run any Node.js code that connects to the Zoom API**. Just [create a new workflow](https://pipedream.com/new), then add prebuilt Zoom [actions](/components#actions) (create a meeting, send a chat message, etc.) or [write your own code](/code/). These workflows can be triggered by HTTP requests, timers, email, or on any app-based event (new tweets, a Github PR, Zoom events, etc). 
+**Pipedream [workflows](/workflows/) allow you to run any Node.js code that connects to the Zoom API**. Just [create a new workflow](https://pipedream.com/new), then add prebuilt Zoom [actions](/components#actions) (create a meeting, send a chat message, etc.) or [write your own code](/code/). These workflows can be triggered by HTTP requests, timers, email, or on any app-based event (new tweets, a GitHub PR, Zoom events, etc). 
 
 # Getting Started
 
@@ -33,4 +33,4 @@ The [Zoom API docs on permissions](https://marketplace.zoom.us/docs/guides/autho
 
 - **Zoom Webinar Attendee Management**: Build a workflow where new sign-ups from an event management platform like Eventbrite trigger the addition of these attendees to a Zoom webinar. Post-webinar, send a follow-up email via Mailgun with a link to the webinar recording, which you can upload to a cloud storage platform like Dropbox.
 
-- **Meeting Analytics and Reporting**: Combine Zoom's meeting ended webhook with Pipedream's capabilities to create a workflow that captures meeting details upon conclusion. With this data, you can send a summary email to the host, update a Google Sheet with attendance information, and even push the data to a BI tool like Tableau for more in-depth analysis.
+- **Meeting Analytics and Reporting**: Combine Zoom's meeting ended webhook with Pipedream's capabilities to create a workflow that captures meeting details upon conclusion. With this data, you can send a summary email to the host, update a Google Sheet with attendance information, and even push the data to a BI tool like Tableau for more in-depth analysis.

package/actions/add-meeting-registrant/add-meeting-registrant.mjs

@@ -4,7 +4,7 @@ export default {
   key: "zoom-add-meeting-registrant",
   name: "Add Meeting Registrant",
   description: "Registers a participant for a meeting. [See the docs here](https://marketplace.zoom.us/docs/api-reference/zoom-api/methods/#operation/meetingRegistrantCreate)",
-  version: "0.3.5",
+  version: "0.3.7",
   annotations: {
     destructiveHint: false,
     openWorldHint: true,

package/actions/add-webinar-registrant/add-webinar-registrant.mjs

@@ -4,7 +4,7 @@ export default {
   key: "zoom-add-webinar-registrant",
   name: "Add Webinar Registrant",
   description: "Registers a participant for a webinar. [See the docs here](https://marketplace.zoom.us/docs/api-reference/zoom-api/webinars/webinarregistrantcreate).",
-  version: "0.3.5",
+  version: "0.3.7",
   annotations: {
     destructiveHint: false,
     openWorldHint: true,

package/actions/delete-meeting/delete-meeting.mjs

@@ -0,0 +1,65 @@
+import zoom from "../../zoom.app.mjs";
+
+export default {
+  key: "zoom-delete-meeting",
+  name: "Delete Meeting",
+  description: "Delete a meeting. [See the documentation](https://developers.zoom.us/docs/api/meetings/#tag/meetings/delete/meetings/{meetingId})",
+  version: "0.0.2",
+  type: "action",
+  annotations: {
+    destructiveHint: true,
+    openWorldHint: true,
+    readOnlyHint: false,
+  },
+  props: {
+    zoom,
+    meetingId: {
+      propDefinition: [
+        zoom,
+        "meetingId",
+      ],
+      description: "The ID of the meeting to delete",
+      optional: false,
+    },
+    occurrenceId: {
+      propDefinition: [
+        zoom,
+        "occurrenceId",
+        ({ meetingId }) => ({
+          meetingId,
+        }),
+      ],
+    },
+    scheduleForReminder: {
+      type: "boolean",
+      label: "Schedule for Reminder",
+      description: "If `true`, notify host and alternative host about the meeting cancellation via email. If `false`, do not send any email notification.",
+      optional: true,
+    },
+    cancelMeetingReminder: {
+      type: "boolean",
+      label: "Cancel Meeting Reminder",
+      description: "If `true`, notify registrants about the meeting cancellation via email. If `false`, do not send any email notification to meeting registrants.",
+      optional: true,
+    },
+  },
+  async run({ $ }) {
+    const response = await this.zoom.deleteMeeting({
+      $,
+      meetingId: this.meetingId,
+      params: {
+        occurrence_id: this.occurrenceId,
+        schedule_for_reminder: this.scheduleForReminder,
+        cancel_meeting_reminder: this.cancelMeetingReminder,
+      },
+    });
+
+    if (this.occurrenceId) {
+      $.export("$summary", `The occurrence "${this.occurrenceId}" related to the meeting "${this.meetingId}" was successfully deleted`);
+    } else {
+      $.export("$summary", `The meeting "${this.meetingId}" was successfully deleted`);
+    }
+
+    return response;
+  },
+};

package/actions/get-meeting-transcript/get-meeting-transcript.mjs

@@ -5,7 +5,7 @@ export default {
   key: "zoom-get-meeting-transcript",
   name: "Get Meeting Transcript",
   description: "Get the transcript of a meeting. [See the documentation](https://developers.zoom.us/docs/api/meetings/#tag/cloud-recording/get/meetings/{meetingId}/transcript)",
-  version: "0.0.3",
+  version: "0.0.5",
   annotations: {
     destructiveHint: false,
     openWorldHint: true,

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

@@ -4,7 +4,7 @@ export default {
   key: "zoom-get-webinar-details",
   name: "Get Webinar Details",
   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.5",
+  version: "0.3.7",
   annotations: {
     destructiveHint: false,
     openWorldHint: true,

package/actions/list-call-recordings/list-call-recordings.mjs

@@ -4,7 +4,7 @@ export default {
   name: "List Call Recordings",
   description: "Get your account's call recordings. [See the documentation](https://developers.zoom.us/docs/api/rest/reference/phone/methods/#operation/getPhoneRecordings)",
   key: "zoom-list-call-recordings",
-  version: "0.0.3",
+  version: "0.0.5",
   annotations: {
     destructiveHint: false,
     openWorldHint: true,

package/actions/list-meetings/list-meetings.mjs

@@ -0,0 +1,125 @@
+import zoom from "../../zoom.app.mjs";
+import constants from "../../common/constants.mjs";
+
+export default {
+  name: "List Meetings",
+  description: "List meetings for a user. [See the documentation](https://developers.zoom.us/docs/api/rest/reference/zoom-api/methods/#operation/meetings)",
+  key: "zoom-list-meetings",
+  version: "0.0.1",
+  type: "action",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: true,
+  },
+  props: {
+    zoom,
+    userId: {
+      propDefinition: [
+        zoom,
+        "meetingUserId",
+      ],
+    },
+    type: {
+      type: "string",
+      label: "Type",
+      description: "The type of meetings to list. Defaults to `scheduled`",
+      optional: true,
+      options: constants.MEETING_TYPES,
+    },
+    from: {
+      type: "string",
+      label: "From",
+      description: "The start date and time of the meetings to list. Example: `2023-01-01`",
+      optional: true,
+    },
+    to: {
+      type: "string",
+      label: "To",
+      description: "The end date and time of the meetings to list. Example: `2023-01-01`",
+      optional: true,
+    },
+    timezone: {
+      type: "string",
+      label: "Timezone",
+      description: "The timezone to use for the `from` and `to` dates. Example: `America/New_York`",
+      optional: true,
+    },
+    titleSearch: {
+      type: "string",
+      label: "Title Search",
+      description: "The title of the meetings to search for",
+      optional: true,
+    },
+    createdAfter: {
+      type: "string",
+      label: "Created After",
+      description: "The date and time to filter meetings created after. Example: `2023-01-01`",
+      optional: true,
+    },
+    createdBefore: {
+      type: "string",
+      label: "Created Before",
+      description: "The date and time to filter meetings created before. Example: `2023-01-01`",
+      optional: true,
+    },
+    max: {
+      propDefinition: [
+        zoom,
+        "max",
+      ],
+    },
+  },
+  methods: {
+    isRelevant(meeting) {
+      if (this.titleSearch) {
+        if (!meeting.topic?.toLowerCase().includes(this.titleSearch.toLowerCase())) {
+          return false;
+        }
+      }
+      if (this.createdAfter && Date.parse(meeting.created_at) < Date.parse(this.createdAfter)) {
+        return false;
+      }
+      if (this.createdBefore && Date.parse(meeting.created_at) > Date.parse(this.createdBefore)) {
+        return false;
+      }
+      return true;
+    },
+  },
+  async run({ $ }) {
+    const meetings = [];
+    let count = 0;
+
+    const results = this.zoom.getResourcesStream({
+      resourceFn: this.zoom.listUserMeetings,
+      resourceFnArgs: {
+        $,
+        userId: this.userId,
+        params: {
+          type: this.type,
+          from: this.from,
+          to: this.to,
+          timezone: this.timezone,
+        },
+      },
+      resourceName: "meetings",
+    });
+
+    for await (const meeting of results) {
+      if (!this.isRelevant(meeting)) {
+        continue;
+      }
+      meetings.push(meeting);
+      count++;
+      if (count >= this.max) {
+        break;
+      }
+    }
+
+    $.export("$summary", `Successfully retrieved ${count} meeting${count === 1
+      ? ""
+      : "s"}`);
+
+    return meetings;
+  },
+};

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

@@ -5,7 +5,7 @@ export default {
   key: "zoom-list-past-meeting-participants",
   name: "List Past Meeting Participants",
   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.5",
+  version: "0.2.7",
   annotations: {
     destructiveHint: false,
     openWorldHint: true,

package/actions/list-user-call-logs/list-user-call-logs.mjs

@@ -4,7 +4,7 @@ export default {
   name: "List User's Call Logs",
   description: "Gets a user's Zoom phone call logs. [See the documentation](https://developers.zoom.us/docs/zoom-phone/apis/#operation/phoneUserCallLogs)",
   key: "zoom-list-user-call-logs",
-  version: "0.0.5",
+  version: "0.0.7",
   annotations: {
     destructiveHint: false,
     openWorldHint: true,

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

@@ -5,7 +5,7 @@ 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.6",
+  version: "0.0.8",
   annotations: {
     destructiveHint: false,
     openWorldHint: true,

package/common/constants.mjs

@@ -2,8 +2,28 @@ const BASE_URL = "https://api.zoom.us";
 const VERSION_PATH = "/v2";
 const MAX_RESOURCES = 300;
 
+const MEETING_TYPES = [
+  {
+    value: "scheduled",
+    label: "All valid previous (unexpired) meetings, live meetings, and upcoming scheduled meetings",
+  },
+  {
+    value: "live",
+    label: "All ongoing meetings",
+  },
+  {
+    value: "upcoming",
+    label: "All upcoming meetings, including live meetings",
+  },
+  {
+    value: "previous_meetings",
+    label: "All the previous meetings",
+  },
+];
+
 export default {
   BASE_URL,
   VERSION_PATH,
   MAX_RESOURCES,
+  MEETING_TYPES,
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pipedream/zoom",
-  "version": "0.7.1",
+  "version": "0.9.0",
   "description": "Pipedream Zoom Components",
   "main": "zoom.app.mjs",
   "keywords": [
@@ -14,6 +14,6 @@
     "access": "public"
   },
   "dependencies": {
-    "@pipedream/platform": "^3.1.0"
+    "@pipedream/platform": "^3.1.1"
   }
 }

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

@@ -6,7 +6,7 @@ export default {
   key: "zoom-custom-event",
   name: "Custom Events (Instant)",
   description: "Emit new events tied to your Zoom user or resources you own",
-  version: "0.1.4",
+  version: "0.1.6",
   type: "source",
   dedupe: "unique",
   props: {

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

@@ -6,7 +6,7 @@ export default {
   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.1.4",
+  version: "0.1.6",
   type: "source",
   dedupe: "unique",
   props: {

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

@@ -6,7 +6,7 @@ export default {
   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.1.4",
+  version: "0.1.6",
   type: "source",
   dedupe: "unique",
   props: {

package/sources/meeting-ended/meeting-ended.mjs

@@ -6,7 +6,7 @@ export default {
   key: "zoom-meeting-ended",
   name: "Meeting Ended (Instant)",
   description: "Emit new event each time a meeting ends where you're the host",
-  version: "0.1.4",
+  version: "0.1.6",
   type: "source",
   dedupe: "unique",
   props: {

package/sources/meeting-started/meeting-started.mjs

@@ -6,7 +6,7 @@ export default {
   key: "zoom-meeting-started",
   name: "Meeting Started (Instant)",
   description: "Emit new event each time a meeting starts where you're the host",
-  version: "0.1.5",
+  version: "0.1.7",
   type: "source",
   dedupe: "unique",
   props: {

package/sources/meeting-updated/meeting-updated.mjs

@@ -6,7 +6,7 @@ export default {
   key: "zoom-meeting-updated",
   name: "Meeting Updated (Instant)",
   description: "Emit new event each time a meeting is updated where you're the host",
-  version: "0.1.4",
+  version: "0.1.6",
   type: "source",
   dedupe: "unique",
   props: {

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

@@ -6,7 +6,7 @@ export default {
   key: "zoom-new-recording-transcript-completed",
   name: "New Recording Transcript Completed (Instant)",
   description: "Emit new event each time a recording transcript is completed",
-  version: "0.0.2",
+  version: "0.0.4",
   type: "source",
   dedupe: "unique",
   props: {

package/sources/phone-event/phone-event.mjs

@@ -6,7 +6,7 @@ export default {
   key: "zoom-phone-event",
   name: "Zoom Phone Events (Instant)",
   description: "Emit new Zoom Phone event tied to your Zoom user or resources you own",
-  version: "0.1.4",
+  version: "0.1.6",
   type: "source",
   props: {
     ...common.props,

package/sources/recording-completed/recording-completed.mjs

@@ -6,7 +6,7 @@ export default {
   key: "zoom-recording-completed",
   name: "Recording Completed (Instant)",
   description: "Emit new event each time a new recording completes for a meeting or webinar where you're the host",
-  version: "0.1.4",
+  version: "0.1.6",
   type: "source",
   dedupe: "unique",
   props: {

package/sources/webinar-created/webinar-created.mjs

@@ -6,7 +6,7 @@ export default {
   key: "zoom-webinar-created",
   name: "Webinar Created (Instant)",
   description: "Emit new event each time a webinar is created where you're the host",
-  version: "0.1.4",
+  version: "0.1.6",
   type: "source",
   dedupe: "unique",
   props: {

package/sources/webinar-deleted/webinar-deleted.mjs

@@ -6,7 +6,7 @@ export default {
   key: "zoom-webinar-deleted",
   name: "Webinar Deleted (Instant)",
   description: "Emit new event each time a webinar is deleted where you're the host",
-  version: "0.1.4",
+  version: "0.1.6",
   type: "source",
   dedupe: "unique",
   props: {

package/sources/webinar-ended/webinar-ended.mjs

@@ -6,7 +6,7 @@ export default {
   key: "zoom-webinar-ended",
   name: "Webinar Ended (Instant)",
   description: "Emit new event each time a webinar ends where you're the host",
-  version: "0.1.4",
+  version: "0.1.6",
   type: "source",
   dedupe: "unique",
   props: {

package/sources/webinar-started/webinar-started.mjs

@@ -6,7 +6,7 @@ export default {
   key: "zoom-webinar-started",
   name: "Webinar Started (Instant)",
   description: "Emit new event each time a webinar starts where you're the host",
-  version: "0.1.4",
+  version: "0.1.6",
   type: "source",
   dedupe: "unique",
   props: {

package/sources/webinar-updated/webinar-updated.mjs

@@ -6,7 +6,7 @@ export default {
   key: "zoom-webinar-updated",
   name: "Webinar Updated (Instant)",
   description: "Emit new event each time a webinar is updated where you're the host",
-  version: "0.1.4",
+  version: "0.1.6",
   type: "source",
   dedupe: "unique",
   props: {

package/zoom.app.mjs

@@ -55,6 +55,22 @@ export default {
       },
       optional: true,
     },
+    occurrenceId: {
+      type: "string",
+      label: "Occurrence ID",
+      description: "If you select a value for this param, only that instance will be deleted. Otherwise, the entire meeting series will be deleted.",
+      optional: true,
+      async options({ meetingId }) {
+        if (!meetingId) {
+          return [];
+        }
+        const occurrences = await this.listMeetingsOccurrences(meetingId);
+        return occurrences.map((occurrence) => ({
+          label: `${occurrence.start_time} (${occurrence.status})`,
+          value: occurrence.occurrence_id,
+        }));
+      },
+    },
     userId: {
       type: "string",
       label: "User Id",
@@ -80,6 +96,31 @@ export default {
         };
       },
     },
+    meetingUserId: {
+      type: "string",
+      label: "User ID",
+      description: "The user ID or email address of the user to list meetings for",
+      async options({ prevContext }) {
+        const { nextPageToken } = prevContext;
+        const response = await this.listAllUsers({
+          params: {
+            next_page_token: nextPageToken,
+          },
+        });
+        const options = response.users.map(({
+          id: value, display_name, email,
+        }) => ({
+          label: `${display_name} - ${email}`,
+          value,
+        }));
+        return {
+          options,
+          context: {
+            nextPageToken: response.next_page_token,
+          },
+        };
+      },
+    },
     includeAudioRecordings: {
       type: "boolean",
       label: "Include Audio Recordings",
@@ -257,6 +298,14 @@ export default {
         ...args,
       });
     },
+    listUserMeetings({
+      userId, ...args
+    }) {
+      return this._makeRequest({
+        path: `/users/${userId}/meetings`,
+        ...args,
+      });
+    },
     listWebinars({
       userId = "me", ...args
     } = {}) {
@@ -283,6 +332,12 @@ export default {
         ...opts,
       });
     },
+    listAllUsers(opts = {}) {
+      return this._makeRequest({
+        path: "/users",
+        ...opts,
+      });
+    },
     listCallLogs({
       userId, ...args
     }) {
@@ -297,6 +352,26 @@ export default {
         ...args,
       });
     },
+    async listMeetingsOccurrences(meetingId) {
+      try {
+        meetingId = utils.doubleEncode(meetingId);
+        const { occurrences } = await this._makeRequest({
+          path: `/meetings/${meetingId}`,
+        });
+        return occurrences || [];
+      } catch {
+        return [];
+      }
+    },
+    deleteMeeting({
+      meetingId, ...args
+    }) {
+      return this._makeRequest({
+        method: "DELETE",
+        path: `/meetings/${utils.doubleEncode(meetingId)}`,
+        ...args,
+      });
+    },
     async *getResourcesStream({
       resourceFn,
       resourceFnArgs,