zaccl 3.0.18 → 4.1.0

package/src/endpoints/ECatCloudRecording.ts

@@ -14,6 +14,7 @@ import ErrorCode from '../shared/types/ErrorCode';
 
 // Import shared types
 import ZoomMeetingRecordings from '../types/ZoomMeetingRecordings';
+import ZoomRecordingInAccount from '../types/ZoomRecordingInAccount';
 
 // Import shared helper
 import {
@@ -23,7 +24,77 @@ import {
 
 class ECatCloudRecording extends EndpointCategory {
   /**
-   * Get all recordings of a meeting
+   * List recordings in the account (Medium)
+   * @author Gabe Abrams
+   * @instance
+   * @memberof api.cloudRecording
+   * @method listAccountRecordings
+   * @param opts object containing all arguments
+   * @param opts.fromYear the start of the date range to list recordings for (e.g. 2026)
+   * @param opts.fromMonth the month of the date range to list recordings for (1-12)
+   * @param [opts.fromDay] the day of the month of the date range to list recordings for (1-31, defaults to 1)
+   * @param [opts.accountId] the account ID of the account of interest (defaults to the account
+   * associated with the current access)
+   * @param [opts.onNewPage] callback function that is called when a new page of results is received.
+   * The function is passed the new page of results as an argument.
+   * @param [opts.minMsBetweenPageRequests] minimum time (in ms) to wait between paginated requests,
+   * for custom throttle control
+   * @returns the list of recordings in the account
+   */
+  async listAccountRecordings(
+    opts: {
+      fromYear: number,
+      fromMonth: number,
+      fromDay?: number,
+      accountId?: string,
+      onNewPage?: (recordings: ZoomRecordingInAccount[]) => void,
+      minMsBetweenPageRequests?: number,
+    },
+  ): Promise<ZoomRecordingInAccount[]> {
+    // Generate from date
+    const {
+      fromYear,
+      fromMonth,
+      minMsBetweenPageRequests,
+    } = opts;
+    const fromMonthPadded = fromMonth < 10 ? `0${fromMonth}` : fromMonth;
+    const fromDay = opts.fromDay ?? 1;
+    const fromDayPadded = fromDay < 10 ? `0${fromDay}` : fromDay;
+    const fromDateString = `${fromYear}-${fromMonthPadded}-${fromDayPadded}`;
+
+    // Generate to date
+    let toYear = fromYear;
+    let toMonth = opts.fromMonth + 1;
+    if (toMonth > 12) {
+      toMonth = 1;
+      toYear += 1;
+    }
+    let toMonthPadded = toMonth < 10 ? `0${toMonth}` : toMonth;
+    let toDay = fromDay;
+    let toDayPadded = toDay < 10 ? `0${toDay}` : toDay;
+    const toDateString = `${toYear}-${toMonthPadded}-${toDayPadded}`;
+
+    return this.visitEndpoint({
+      path: `/accounts/${opts.accountId ?? 'me'}/recordings`,
+      action: 'list recordings in the account',
+      method: 'GET',
+      params: {
+        page_size: 300, // max allowed page size
+        from: fromDateString,
+        to: toDateString,
+      },
+      onNewPage: opts.onNewPage,
+      minMsBetweenPageRequests,
+      itemKey: 'meetings',
+      errorMap: {
+        400: 'Bad request',
+        404: 'No recordings found',
+      },
+    });
+  }
+
+  /**
+   * Get all recordings of a meeting (Light)
    * @author Aryan Pandey
    * @instance
    * @memberof api.cloudRecording
@@ -74,17 +145,13 @@ class ECatCloudRecording extends EndpointCategory {
   }
 
   /**
-   * List all cloud recordings of a user
+   * List all cloud recordings of a user (Medium)
    * @author Aryan Pandey
    * @instance
    * @memberof api.cloudRecording
    * @method listUserRecordings
    * @param opts object containing all arguments
    * @param opts.userId the user ID or email address of the user
-   * @param [opts.pageSize=300] number of records
-   *   returned from a single API call
-   * @param [opts.nextPageToken] token used to pageinate
-   *   through large result sets
    * @param [opts.searchTrash=false] set to true to retrieve
    *   meeting recordings from the trash.
    * @param [opts.startDate=1 month before today]
@@ -95,26 +162,29 @@ class ECatCloudRecording extends EndpointCategory {
    *   constructor or instance of Date object.
    *   Date needs to be within past 6 months. Time data (hours and seconds)
    *   is discarded
+   * @param [opts.onNewPage] callback function that is called when a new page of results is received.
+   * @param [opts.minMsBetweenPageRequests] minimum time (in ms) to wait between paginated requests,
+   * for custom throttle control
    * @returns List of Zoom Recordings {@link https://marketplace.zoom.us/docs/api-reference/zoom-api/cloud-recording/recordingslist#responses}
    */
   async listUserRecordings(
     opts: {
       userId: string,
-      pageSize?: number,
-      nextPageToken?: string,
       searchTrash?: boolean,
       startDate?: (string | Date),
       endDate?: (string | Date),
+      onNewPage?: (recordings: ZoomMeetingRecordings[]) => void,
+      minMsBetweenPageRequests?: number,
     },
   ): Promise<ZoomMeetingRecordings[]> {
     // Destructure arguments
     const {
       userId,
       searchTrash,
-      nextPageToken,
       startDate,
       endDate,
-      pageSize,
+      onNewPage,
+      minMsBetweenPageRequests,
     } = opts;
 
     // Declare default start Date to 1 month before
@@ -135,17 +205,6 @@ class ECatCloudRecording extends EndpointCategory {
       from: formatDate(defaultDate, 'startDate'),
     };
 
-    if (pageSize) {
-      // Throw error if pageSize is over max val of 300
-      if (pageSize > 300) {
-        throw new ZACCLError({
-          message: `We requested ${pageSize} recordings from Zoom but it can only give us 300 at a time`,
-          code: ErrorCode.InvalidPageSize,
-        });
-      }
-      params.page_size = pageSize;
-    }
-
     if (startDate) {
       params.from = formatDate(startDate, 'startDate');
     }
@@ -154,19 +213,14 @@ class ECatCloudRecording extends EndpointCategory {
       params.to = formatDate(endDate, 'endDate');
     }
 
-    if (nextPageToken) {
-      params.next_page_token = nextPageToken;
-    }
-
     return this.visitEndpoint({
       path: `/users/${userId}/recordings`,
       action: 'list all cloud recordings of a user',
       method: 'GET',
       params,
-      postProcessor: (body) => {
-        // Extract the recordings from the body
-        return Array.from(body.meetings);
-      },
+      onNewPage: opts.onNewPage,
+      minMsBetweenPageRequests,
+      itemKey: 'meetings',
       errorMap: {
         404: {
           1001: `We could not find the Zoom user ${userId} on this account`,

package/src/endpoints/ECatGroup.ts

@@ -0,0 +1,97 @@
+/**
+ * Category of endpoints for Zoom groups
+ * @author Gabe Abrams
+ * @namespace api.group
+ */
+
+// Import shared interfaces
+import EndpointCategory from '../shared/interfaces/EndpointCategory';
+
+// Import shared types
+import ZoomGroup from '../types/ZoomGroup';
+import ZoomGroupMember from '../types/ZoomGroupMember';
+
+class ECatGroup extends EndpointCategory {
+  /**
+   * List groups in the account (Medium)
+   * @author Gabe Abrams
+   * @instance
+   * @memberof api.account
+   * @method listGroups
+   * @param [opts] object containing all arguments
+   * @param [opts.onNewPage] callback function that is called when a new page of results is received.
+   * @param [opts.minMsBetweenPageRequests] minimum time (in ms) to wait between paginated requests,
+   * for custom throttle control
+   * @returns the list of groups in the account
+   */
+  async listGroups(
+    opts: {
+      onNewPage?: (groups: ZoomGroup[]) => void,
+      minMsBetweenPageRequests?: number,
+    } = {},
+  ): Promise<ZoomGroup[]> {
+    return this.visitEndpoint({
+      path: '/groups',
+      action: 'list groups in the account',
+      method: 'GET',
+      params: {
+        page_size: 10, // max allowed page size
+        // TODO: change above to 300
+      },
+      errorMap: {
+        400: 'Bad request',
+        404: {
+          4130: 'No groups found for this account.',
+        },
+      },
+      itemKey: 'groups',
+      onNewPage: opts.onNewPage,
+      minMsBetweenPageRequests: opts.minMsBetweenPageRequests,
+    });
+  }
+
+  /**
+   * List the members within a group (Medium)
+   * @author Gabe Abrams
+   * @instance
+   * @memberof api.group
+   * @method listGroupMembers
+   * @param opts object containing all arguments
+   * @params opts.groupId the group ID of the group of interest
+   * @param [opts.onNewPage] callback function that is called when a new page of results is received.
+   * @param [opts.minMsBetweenPageRequests] minimum time (in ms) to wait between paginated requests,
+   * for custom throttle control
+   * @returns the list of members in the group
+   */
+  async listGroupMembers(
+    opts: {
+      groupId: string,
+      onNewPage?: (groupMembers: ZoomGroupMember[]) => void,
+      minMsBetweenPageRequests?: number,
+    },): Promise<ZoomGroupMember[]> {
+    return this.visitEndpoint({
+      path: `/groups/${opts.groupId}/members`,
+      action: 'list members in a Zoom group',
+      method: 'GET',
+      params: {
+        page_size: 2000, // max allowed page size
+      },
+      itemKey: 'members',
+      errorMap: {
+        400: 'Bad request',
+        404: {
+          4130: 'No groups found for this account.',
+        },
+      },
+      onNewPage: opts.onNewPage,
+      minMsBetweenPageRequests: opts.minMsBetweenPageRequests,
+    });
+  }
+}
+
+/*------------------------------------------------------------------------*/
+/*                                 Export                                 */
+/*------------------------------------------------------------------------*/
+
+export default ECatGroup;
+

package/src/endpoints/ECatMeeting.ts

@@ -22,10 +22,13 @@ import ZoomPollStatus from '../types/ZoomPollStatus';
 import ZoomPollQuestion from '../types/ZoomPollQuestion';
 import ZoomMeetingDetails from '../types/ZoomMeetingDetails';
 import ZoomMeetingIdAndStartTime from '../types/ZoomMeetingIdAndStartTime';
+import ZoomMeetingTranscript from '../types/ZoomMeetingTranscript';
+import ZoomPastMeetingParticipant from '../types/ZoomPastMeetingParticipant';
+import ZoomPastMeetingDetails from '../types/ZoomPastMeetingDetails';
 
 class ECatMeeting extends EndpointCategory {
   /**
-   * Get info on a meeting
+   * Get info on a meeting (Light)
    * @author Gabe Abrams
    * @author Aryan Pandey
    * @instance
@@ -36,7 +39,7 @@ class ECatMeeting extends EndpointCategory {
    * @param [opts.occurrenceId] ID for the meeting occurrence
    * @param [opts.showAllOccurrences=false] if truthy,
    *   retrieves all past occurrences
-   * @returns Zoom meeting object {@link https://marketplace.zoom.us/docs/api-reference/zoom-api/meetings/meeting#responses}
+   * @returns Zoom meeting object
    */
   async get(
     opts: {
@@ -78,7 +81,7 @@ class ECatMeeting extends EndpointCategory {
   }
 
   /**
-   * Create a new meeting
+   * Create a new meeting (Light)
    * @author Gabe Abrams
    * @author Aryan Pandey
    * @instance
@@ -110,7 +113,7 @@ class ECatMeeting extends EndpointCategory {
   }
 
   /**
-   * Update a meeting
+   * Update a meeting (Light)
    * @author Gabe Abrams
    * @author Aryan Pandey
    * @instance
@@ -154,7 +157,7 @@ class ECatMeeting extends EndpointCategory {
   }
 
   /**
-   * Delete a meeting
+   * Delete a meeting (Light)
    * @author Gabe Abrams
    * @author Aryan Pandey
    * @instance
@@ -212,7 +215,7 @@ class ECatMeeting extends EndpointCategory {
   }
 
   /**
-   * Get a list of ended meeting instances
+   * Get a list of ended meeting instances (Medium)
    * @author Gabe Abrams
    * @author Aryan Pandey
    * @instance
@@ -234,11 +237,12 @@ class ECatMeeting extends EndpointCategory {
       errorMap: {
         404: `We could not find a meeting with the ID ${opts.meetingId}`,
       },
+      itemKey: 'meetings',
     });
   }
 
   /**
-   * Get details of a past meeting instance
+   * Get details of a past meeting instance (Light)
    * @author Yuen Ler Chow
    * @instance
    * @memberof api.meeting
@@ -270,7 +274,7 @@ class ECatMeeting extends EndpointCategory {
   }
 
   /**
-   * List past poll occurrences
+   * List past poll occurrences (Medium)
    * @author Yuen Ler Chow
    * @instance
    * @memberof api.meeting
@@ -394,7 +398,7 @@ class ECatMeeting extends EndpointCategory {
   }
 
   /**
-   * Get poll info
+   * Get poll info (Light)
    * @author Yuen Ler Chow
    * @instance
    * @memberof api.meeting
@@ -554,7 +558,7 @@ class ECatMeeting extends EndpointCategory {
    *   user is added as the only alt-host. This is because Zoom doesn't give us
    *   enough information to determine which user is deactivated, and thus,
    *   the only way to resolve the issue is to remove all previously existing
-   *   alt-hosts.
+   *   alt-hosts. (Light)
    * @author Gabe Abrams
    * @author Aryan Pandey
    * @instance
@@ -631,6 +635,77 @@ class ECatMeeting extends EndpointCategory {
     // return updated meeting object
     return meetingObj;
   }
+
+  /**
+   * Get meeting transcript (Medium)
+   * @author Gabe Abrams
+   * @instance
+   * @memberof api.meeting
+   * @method getTranscript
+   * @param opts object containing all arguments
+   * @param opts.meetingId the Zoom ID of the meeting (or UUID of a past meeting instance)
+   * @returns meeting transcript
+   */
+  async getTranscript(
+    opts: {
+      meetingId: number,
+    },
+  ): Promise<ZoomMeetingTranscript> {
+    return this.visitEndpoint({
+      path: `/meetings/${opts.meetingId}/transcript`,
+      action: 'get the meeting transcript',
+      method: 'GET',
+      errorMap: {
+        400: 'Invalid meeting ID',
+        403: 'You do not have permission to access the transcript for this meeting',
+        404: {
+          3322: 'The meeting transcript does not exist',
+        },
+      },
+    });
+  }
+
+  /**
+   * Get list of participants in a past meeting (Medium)
+   * @author Gabe Abrams
+   * @instance
+   * @memberof api.meeting
+   * @method listPastMeetingParticipants
+   * @param opts object containing all arguments
+   * @param opts.meetingId the Zoom UUID of the past meeting instance
+   * @param [opts.onNewPage] callback function that is called when a new page of results is received.
+   * @param [opts.minMsBetweenPageRequests] minimum time (in ms) to wait between paginated requests,
+   * for custom throttle control
+   * @returns list of past meeting participants
+   */
+  async listPastMeetingParticipants(
+    opts: {
+      meetingId: string,
+      onNewPage?: (participants: ZoomPastMeetingParticipant[]) => void, 
+      minMsBetweenPageRequests?: number,
+    },
+  ): Promise<ZoomPastMeetingParticipant[]> {
+    return this.visitEndpoint({
+      path: `/past_meetings/${opts.meetingId}/participants`,
+      action: 'get the list of participants in a past meeting',
+      method: 'GET',
+      params: {
+        page_size: 300, // max allowed page size
+      },
+      itemKey: 'participants',
+      onNewPage: opts.onNewPage,
+      minMsBetweenPageRequests: opts.minMsBetweenPageRequests,
+      errorMap: {
+        400: {
+          200: 'You need a paid account to access the participant list of a past meeting.',
+          12702: 'You are not allowed to access information about meetings that occurred more than 1 year ago.',
+        },
+        404: {
+          3001: 'The meeting ID is invalid or the meeting has not ended.',
+        },
+      },
+    });
+  }
 }
 
 /*------------------------------------------------------------------------*/

package/src/endpoints/ECatUser.ts

@@ -12,7 +12,7 @@ import ZoomUser from '../types/ZoomUser';
 
 class ECatUser extends EndpointCategory {
   /**
-   * Retrieve a user's ZAK token
+   * Retrieve a user's ZAK token (Light)
    * @author Aryan Pandey
    * @instance
    * @memberof api.user
@@ -33,21 +33,18 @@ class ECatUser extends EndpointCategory {
       params: {
         type: 'zak',
       },
+      itemKey: 'token',
       errorMap: {
         404: {
           1001: `We could not retrieve a token for Zoom user ${opts.userId} since this user does not exist`,
         },
       },
-      postProcessor: (body) => {
-        // extract zak token from the response object
-        return body.token;
-      },
     });
   }
 
   /**
    * (Re)activate a user and promote them to a "licensed" user (unless
-   *   dontPromoteToLicensed is true)
+   *   dontPromoteToLicensed is true) (Light)
    * @author Gabe Abrams
    * @instance
    * @memberof api.user
@@ -98,7 +95,7 @@ class ECatUser extends EndpointCategory {
   }
 
   /**
-   * Add a webinar license to the user of interest
+   * Add a webinar license to the user of interest (Medium)
    * @author Gabe Abrams
    * @instance
    * @memberof api.user
@@ -136,7 +133,7 @@ class ECatUser extends EndpointCategory {
   }
 
   /**
-   * Get a user
+   * Get a user (Light)
    * @author Gabe Abrams
    * @instance
    * @memberof api.user
@@ -163,7 +160,7 @@ class ECatUser extends EndpointCategory {
   }
 
   /**
-   * Promote a user to "licensed" type
+   * Promote a user to "licensed" type (Light)
    * @author Gabe Abrams
    * @instance
    * @memberof api.user

package/src/endpoints/ECatWebinar.ts

@@ -13,7 +13,7 @@ import ZoomWebinar from '../types/ZoomWebinar';
 
 class ECatWebinar extends EndpointCategory {
   /**
-   * Get info on a Webinar
+   * Get info on a Webinar (Light)
    * @author Gabe Abrams
    * @instance
    * @memberof api.webinar
@@ -64,7 +64,7 @@ class ECatWebinar extends EndpointCategory {
   }
 
   /**
-   * Create a webinar
+   * Create a webinar (Light)
    * @author Gabe Abrams
    * @instance
    * @memberof api.webinar
@@ -101,7 +101,7 @@ class ECatWebinar extends EndpointCategory {
   }
 
   /**
-   * Add one panelist if not already in the list
+   * Add one panelist if not already in the list (Medium)
    * @author Gabe Abrams
    * @instance
    * @memberof api.webinar
@@ -144,7 +144,7 @@ class ECatWebinar extends EndpointCategory {
   }
 
   /**
-   * Get a list of panelists for a webinar
+   * Get a list of panelists for a webinar (Medium)
    * @author Gabe Abrams
    * @instance
    * @memberof api.webinar
@@ -171,6 +171,7 @@ class ECatWebinar extends EndpointCategory {
           3001: `Webinar ${opts.webinarId} could not be found or has expired`,
         },
       },
+      itemKey: 'panelists',
     });
 
     // Just keep list of panelists

package/src/index.ts

@@ -9,6 +9,7 @@ import ECatCloudRecording from './endpoints/ECatCloudRecording';
 import ECatMeeting from './endpoints/ECatMeeting';
 import ECatUser from './endpoints/ECatUser';
 import ECatWebinar from './endpoints/ECatWebinar';
+import ECatGroup from './endpoints/ECatGroup';
 
 // Import shared types
 import ZoomAPIConfig from './types/ZoomAPIConfig';
@@ -17,6 +18,29 @@ import ZACCLError from './shared/classes/ZACCLError';
 import ErrorCode from './shared/types/ErrorCode';
 import ZoomAPIConfigType from './types/ZoomAPIConfigType';
 
+// Import all Zoom types
+import ZoomPanelist from './types/ZoomPanelist';
+import ZoomPollInfo from './types/ZoomPollInfo';
+import ZoomPollOccurrence from './types/ZoomPollOccurrence';
+import ZoomFileType from './types/ZoomFileType';
+import ZoomPollQuestion from './types/ZoomPollQuestion';
+import ZoomPollQuestionAndAnswerType from './types/ZoomPollQuestionAndAnswerType';
+import ZoomPollStatus from './types/ZoomPollStatus';
+import ZoomLoginMethod from './types/ZoomLoginMethod';
+import ZoomPollType from './types/ZoomPollType';
+import ZoomRecordingFile from './types/ZoomRecordingFile';
+import ZoomRecordingType from './types/ZoomRecordingType';
+import ZoomMeetingIdAndStartTime from './types/ZoomMeetingIdAndStartTime';
+import ZoomRecurrenceInfo from './types/ZoomRecurrenceInfo';
+import ZoomMeetingOrWebinarType from './types/ZoomMeetingOrWebinarType';
+import ZoomMeetingRecordings from './types/ZoomMeetingRecordings';
+import ZoomUserAnswer from './types/ZoomUserAnswer';
+import ZoomMeetingTranscript from './types/ZoomMeetingTranscript';
+import ZoomUsersAnswersToQuestion from './types/ZoomUsersAnswersToQuestion';
+import ZoomMeetingType from './types/ZoomMeetingType';
+import ZoomWebinar from './types/ZoomWebinar';
+import ZoomPastMeetingParticipant from './types/ZoomPastMeetingParticipant';
+
 // Import shared constants
 import DEFAULT_ZOOM_HOSTNAME from './shared/constants/DEFAULT_ZOOM_HOSTNAME';
 
@@ -137,9 +161,38 @@ const initZoomAPI = (
   api.meeting = new ECatMeeting(initPack);
   api.user = new ECatUser(initPack);
   api.webinar = new ECatWebinar(initPack);
+  api.group = new ECatGroup(initPack);
 
   // Return api instance
   return api;  
 };
 
 export default initZoomAPI;
+
+/*----------------------------------------*/
+/* ---------------- Types --------------- */
+/*----------------------------------------*/
+
+export {
+  ZoomPanelist,
+  ZoomPollInfo,
+  ZoomPollOccurrence,
+  ZoomFileType,
+  ZoomPollQuestion,
+  ZoomPollQuestionAndAnswerType,
+  ZoomPollStatus,
+  ZoomLoginMethod,
+  ZoomPollType,
+  ZoomRecordingFile,
+  ZoomRecordingType,
+  ZoomMeetingIdAndStartTime,
+  ZoomRecurrenceInfo,
+  ZoomMeetingOrWebinarType,
+  ZoomMeetingRecordings,
+  ZoomUserAnswer,
+  ZoomMeetingTranscript,
+  ZoomUsersAnswersToQuestion,
+  ZoomMeetingType,
+  ZoomWebinar,
+  ZoomPastMeetingParticipant,
+};