@dereekb/zoom 12.1.0

package/src/lib/oauth/oauth.error.api.d.ts

@@ -0,0 +1,30 @@
+import { FetchRequestFactoryError, FetchResponseError } from '@dereekb/util/fetch';
+import { ZoomServerErrorData, ParsedZoomServerError } from '../zoom.error.api';
+/**
+ * Error in the following cases:
+ * - the refresh token string is invalid
+ */
+export declare const ZOOM_ACCOUNTS_INVALID_GRANT_ERROR_CODE = "invalid_grant";
+export interface ZoomOauthInvalidGrantErrorData {
+    readonly reason: 'Invalid Token!';
+    readonly error: 'invalid_grant';
+}
+export type ZoomOAuthAccessTokenErrorCode = typeof ZOOM_ACCOUNTS_INVALID_GRANT_ERROR_CODE;
+/**
+ * Thrown if the call to the Zoom API creating an access token using a refresh token fails.
+ */
+export declare class ZoomOAuthAccessTokenError extends FetchRequestFactoryError {
+    readonly errorCode: ZoomOAuthAccessTokenErrorCode;
+    constructor(errorCode: ZoomOAuthAccessTokenErrorCode);
+}
+/**
+ * Thrown if a valid ZoomAccessToken cannot be retrieved successfully.
+ */
+export declare class ZoomOAuthAuthFailureError extends FetchRequestFactoryError {
+    readonly reason?: string | undefined;
+    constructor(reason?: string | undefined);
+}
+export declare const logZoomOAuthErrorToConsole: import("../zoom.error.api").LogZoomServerErrorFunction;
+export declare function parseZoomOAuthError(responseError: FetchResponseError): Promise<ParsedZoomServerError>;
+export declare function parseZoomOAuthServerErrorResponseData(zoomServerError: ZoomServerErrorData, responseError: FetchResponseError): ParsedZoomServerError;
+export declare const handleZoomOAuthErrorFetch: import("../zoom.error.api").HandleZoomErrorFetchFactory;

package/src/lib/oauth/oauth.factory.d.ts

@@ -0,0 +1,34 @@
+import { ZoomOAuthConfig, ZoomOAuthContextRef, ZoomOAuthFetchFactory } from './oauth.config';
+import { LogZoomServerErrorFunction } from '../zoom.error.api';
+import { ZoomAccessTokenCache, ZoomAccessTokenFactory, ZoomAccessTokenRefresher } from './oauth';
+import { Maybe, Milliseconds } from '@dereekb/util';
+export type ZoomOAuth = ZoomOAuthContextRef;
+export interface ZoomOAuthFactoryConfig {
+    /**
+     * Creates a new fetch instance to use when making calls.
+     */
+    fetchFactory?: ZoomOAuthFetchFactory;
+    /**
+     * Custom log error function.
+     */
+    logZoomServerErrorFunction?: LogZoomServerErrorFunction;
+}
+export type ZoomOAuthFactory = (config: ZoomOAuthConfig) => ZoomOAuth;
+export declare function zoomOAuthFactory(factoryConfig: ZoomOAuthFactoryConfig): ZoomOAuthFactory;
+export interface ZoomOAuthZoomAccessTokenFactoryConfig {
+    /**
+     * Number of milliseconds before the expiration time a token should be discarded.
+     *
+     * Defaults to 1 minute.
+     */
+    readonly tokenExpirationBuffer?: Milliseconds;
+    readonly tokenRefresher: ZoomAccessTokenRefresher;
+    readonly accessTokenCache?: Maybe<ZoomAccessTokenCache>;
+}
+/**
+ * Creates a ZoomOAuthZoomAccessTokenFactoryConfig
+ *
+ * @param config
+ * @returns
+ */
+export declare function zoomOAuthZoomAccessTokenFactory(config: ZoomOAuthZoomAccessTokenFactoryConfig): ZoomAccessTokenFactory;

package/src/lib/zoom/index.d.ts

@@ -0,0 +1,7 @@
+export * from './zoom.api.meeting';
+export * from './zoom.api.meeting.type';
+export * from './zoom.api.user';
+export * from './zoom.api.user.type';
+export * from './zoom.config';
+export * from './zoom.error.api';
+export * from './zoom.factory';

package/src/lib/zoom/zoom.api.meeting.d.ts

@@ -0,0 +1,144 @@
+import { ISO8601DateString } from '@dereekb/util';
+import { ZoomMeetingType, ZoomRecurrenceInfo, ZoomMeetingSettings, ZoomMeetingAgenda, ZoomMeetingDuration, ZoomMeetingTrackingField, ZoomMeetingTemplateId, ZoomMeetingPassword, ZoomMeeting, ZoomMeetingId } from './zoom.api.meeting.type';
+import { ZoomContext } from './zoom.config';
+import { ZoomPageFilter, ZoomPageResult } from '../zoom.api.page';
+import { FetchPageFactory } from '@dereekb/util/fetch';
+import { ZoomUserId } from '../zoom.type';
+import { SilenceZoomErrorConfig } from '../zoom.error.api';
+export interface GetMeetingInput {
+    readonly meetingId: string;
+}
+export type GetMeetingResponse = ZoomMeeting;
+export type GetMeetingFunction = (input: GetMeetingInput) => Promise<GetMeetingResponse>;
+/**
+ * https://developers.zoom.us/docs/api/rest/reference/zoom-api/methods/#operation/meeting
+ */
+export declare function getMeeting(context: ZoomContext): GetMeetingFunction;
+export interface ListMeetingsForUserInput extends ZoomPageFilter {
+    readonly user: ZoomUserId | 'me';
+}
+export type ListMeetingsForUserResponse = ZoomPageResult<ZoomMeeting>;
+export type ListMeetingsForUserFunction = (input: ListMeetingsForUserInput) => Promise<ListMeetingsForUserResponse>;
+/**
+ * https://developers.zoom.us/docs/api/rest/reference/zoom-api/methods/#operation/meetings
+ */
+export declare function listMeetingsForUser(context: ZoomContext): ListMeetingsForUserFunction;
+export type ListMeetingsForUserPageFactory = FetchPageFactory<ListMeetingsForUserInput, ListMeetingsForUserResponse>;
+export declare function listMeetingsForUserPageFactory(context: ZoomContext): ListMeetingsForUserPageFactory;
+/**
+ * https://developers.zoom.us/docs/api/rest/reference/zoom-api/methods/#operation/meetingCreate
+ */
+export interface CreateMeetingForUserTemplate {
+    /**
+     * The meeting's agenda. This value has a maximum length of 2,000 characters.
+     * @example "My Meeting"
+     */
+    readonly agenda?: ZoomMeetingAgenda;
+    /**
+     * Whether to generate a default passcode using the user's settings. This value defaults to `false`.
+     *
+     * If this value is `true` and the user has the PMI setting enabled with a passcode, then the user's meetings will use the PMI passcode. It will **not** use a default passcode.
+     * @default false
+     * @example false
+     */
+    readonly default_password?: boolean;
+    /**
+     * The meeting's scheduled duration, in minutes. This field is only used for scheduled meetings (`2`).
+     * @example 60
+     */
+    readonly duration?: ZoomMeetingDuration;
+    /**
+     * The passcode required to join the meeting. By default, a passcode can **only** have a maximum length of 10 characters and only contain alphanumeric characters and the `@`, `-`, `_`, and `*` characters.
+     *
+     * **Note:**
+     * - If the account owner or administrator has configured [minimum passcode requirement settings](https://support.zoom.us/hc/en-us/articles/360033559832-Meeting-and-webinar-passwords#h_a427384b-e383-4f80-864d-794bf0a37604), the passcode **must** meet those requirements.
+     * - If passcode requirements are enabled, use the [**Get user settings**](/docs/api/users/#tag/users/GET/users/{userId}/settings) API or the [**Get account settings**](/docs/api/accounts/#tag/accounts/GET/accounts/{accountId}/settings) API to get the requirements.
+     * - If the **Require a passcode when scheduling new meetings** account setting is enabled and locked, a passcode will be automatically generated if one is not provided.
+     * @example "123456"
+     */
+    readonly password?: ZoomMeetingPassword;
+    /**
+     * Whether to create a prescheduled meeting via the [GSuite app](https://support.zoom.us/hc/en-us/articles/360020187492-Zoom-for-GSuite-add-on). This **only** supports the meeting `type` value of `2` (scheduled meetings) and `3` (recurring meetings with no fixed time).
+     * - `true` - Create a prescheduled meeting.
+     * - `false` - Create a regular meeting.
+     * @default false
+     * @example false
+     */
+    readonly pre_schedule?: boolean;
+    /**
+     * Recurrence object. Use this object only for a meeting with type `8`, a recurring meeting with a fixed time.
+     */
+    readonly recurrence?: ZoomRecurrenceInfo;
+    /**
+     * The email address or user ID of the user to schedule a meeting for.
+     * @example "jchill@example.com"
+     */
+    readonly schedule_for?: string;
+    /**
+     * Meeting settings object. See ZoomMeetingSettings for all available options.
+     */
+    readonly settings?: ZoomMeetingSettings;
+    /**
+     * The meeting's topic.
+     */
+    readonly topic?: string;
+    /**
+     * The meeting's scheduled start time, in ISO 8601 format.
+     */
+    readonly start_time?: ISO8601DateString;
+    /**
+     * The time zone to use for the meeting.
+     */
+    readonly timezone?: string;
+    /**
+     * The meeting type.
+     * - `1`: Instant
+     * - `2`: Scheduled
+     * - `3`: Recurring (no fixed time)
+     * - `8`: Recurring (fixed time)
+     */
+    readonly type?: ZoomMeetingType;
+    /**
+     * Tracking fields for the meeting.
+     */
+    readonly tracking_fields?: ZoomMeetingTrackingField[];
+    /**
+     * Template ID to use for the meeting.
+     */
+    readonly template_id?: ZoomMeetingTemplateId;
+}
+export interface CreateMeetingForUserInput {
+    readonly user: ZoomUserId | 'me';
+    readonly template: CreateMeetingForUserTemplate;
+}
+export type CreateMeetingForUserResponse = ZoomMeeting;
+/**
+ * https://developers.zoom.us/docs/api/meetings/#tag/meetings/POST/users/{userId}/meetings
+ */
+export declare function createMeetingForUser(context: ZoomContext): (input: CreateMeetingForUserInput) => Promise<CreateMeetingForUserResponse>;
+export interface DeleteMeetingInput extends SilenceZoomErrorConfig {
+    readonly meetingId: ZoomMeetingId;
+    /**
+     * The occurrence ID of the meeting to delete.
+     */
+    readonly occurrence_id?: string;
+    /**
+     * `true`: Notify host and alternative host about the meeting cancellation via email.
+     * `false`: Do not send any email notification.
+     */
+    readonly schedule_for_reminder?: boolean;
+    /**
+     * `true`: Notify registrants about the meeting cancellation via email.
+     * `false`: Do not send any email notification to meeting registrants.
+     *
+     * The default value of this field is `false`.
+     */
+    readonly cancel_meeting_reminder?: boolean;
+}
+export type DeleteMeetingResponse = unknown;
+export type DeleteMeetingFunction = (input: DeleteMeetingInput) => Promise<DeleteMeetingResponse>;
+export declare const DELETE_MEETING_DOES_NOT_EXIST_ERROR_CODE = 3001;
+/**
+ * https://developers.zoom.us/docs/api/meetings/#tag/meetings/DELETE/meetings/{meetingId}
+ */
+export declare function deleteMeeting(context: ZoomContext): DeleteMeetingFunction;

package/src/lib/zoom/zoom.api.meeting.type.d.ts

@@ -0,0 +1,297 @@
+import { CommaSeparatedString, DayOfMonth, EmailAddress, ISO8601DateString, Minutes, WebsiteDomain } from '@dereekb/util';
+import { ZoomUserId } from '../zoom.type';
+import { type ZoomUserPersonalMeetingId } from './zoom.api.user.type';
+export type ZoomMeetingId = string;
+export type ZoomMeetingTemplateId = string;
+export type ZoomMeetingOccurrenceDuration = number;
+/**
+ * URL for participants to join the meeting.
+ *
+ * This URL should only be shared with users that you would like to invite for the meeting.
+ */
+export type ZoomMeetingJoinUrl = string;
+/**
+ * URL for participants to join the meeting.
+ *
+ * This URL should only be shared with users that you would like to invite for the meeting.
+ */
+export type ZoomMeetingChatJoinUrl = string;
+export type ZoomRegistrationUrl = string;
+/**
+ * The status of the occurrence.
+ */
+export type ZoomMeetingOccurrenceStatus = 'available' | 'deleted';
+export interface ZoomMeetingOccurrence {
+    /**
+     * The meeting duration in minutes.
+     */
+    readonly duration: Minutes;
+    /**
+     * Occurrence ID. The unique identifier for an occurrence of a recurring webinar.
+     *
+     * Recurring webinars can have a maximum of 50 occurrences.
+     */
+    readonly occurrence_id: string;
+    /**
+     * The start time of the meeting.
+     */
+    readonly start_time: ISO8601DateString;
+    /**
+     * The status of the occurrence.
+     */
+    readonly status: ZoomMeetingOccurrenceStatus;
+}
+export interface ZoomMeeting {
+    /**
+     * The ID of the user who scheduled this meeting on behalf of the host.
+     */
+    readonly assistant_id?: ZoomUserId;
+    /**
+     * The meeting host's email address.
+     */
+    readonly host_email: EmailAddress;
+    /**
+     * The meeting ID (meeting number): Unique identifier of the meeting in long format (int64), also known as the meeting number.
+     */
+    readonly id: ZoomMeetingId;
+    /**
+     * The URL that registrants can use to register for a meeting. Only returned for meetings with registration enabled.
+     */
+    readonly registration_url?: ZoomRegistrationUrl;
+    /**
+     * The meeting's agenda. This value has a maximum length of 2,000 characters.
+     * @example "My Meeting"
+     */
+    readonly agenda?: ZoomMeetingAgenda;
+    /**
+     * The date and time when this meeting was created.
+     */
+    readonly created_at: ISO8601DateString;
+    /**
+     * The meeting duration.
+     */
+    readonly duration?: Minutes;
+    /**
+     * Encrypted passcode for third party endpoints (H323/SIP).
+     */
+    readonly encrypted_password?: string;
+    /**
+     * Passcode for participants to join the meeting via PSTN.
+     */
+    readonly pstn_password?: string;
+    /**
+     * H.323/SIP room system passcode.
+     */
+    readonly h323_password?: string;
+    /**
+     * URL for participants to join the meeting. Should only be shared with users you would like to invite.
+     */
+    readonly join_url: ZoomMeetingJoinUrl;
+    /**
+     * The URL to join the chat.
+     */
+    readonly chat_join_url?: ZoomMeetingChatJoinUrl;
+    /**
+     * Array of occurrence objects. Only returned for recurring webinars.
+     */
+    readonly occurrences?: ZoomMeetingOccurrence[];
+    /**
+     * The meeting passcode.
+     */
+    readonly password?: ZoomMeetingPassword;
+    /**
+     * Personal meeting ID (PMI). Only used for scheduled meetings and recurring meetings with no fixed time.
+     */
+    readonly pmi?: ZoomUserPersonalMeetingId;
+    /**
+     * Whether the prescheduled meeting was created via the GSuite app. Only supports meeting type 2 and 3.
+     */
+    readonly pre_schedule?: boolean;
+    /**
+     * Recurrence object. Use this object only for a meeting with type 8, a recurring meeting with fixed time.
+     */
+    readonly recurrence?: ZoomRecurrenceInfo;
+    /**
+     * Meeting settings object.
+     */
+    readonly settings?: ZoomMeetingSettings;
+}
+/**
+ * The meeting's agenda. This value has a maximum length of 2,000 characters.
+ */
+export type ZoomMeetingAgenda = string;
+/**
+ * The passcode required to join the meeting.
+ *
+ * By default, a passcode can **only** have a maximum length of 10 characters and only contain alphanumeric characters and the `@`, `-`, `_`, and `*` characters.
+ *
+ * **Note:**
+ * If the account owner or administrator has configured [minimum passcode requirement settings](https://support.zoom.us/hc/en-us/articles/360033559832-Meeting-and-webinar-passwords#h_a427384b-e383-4f80-864d-794bf0a37604), the passcode **must** meet those requirements.
+ *
+ * If passcode requirements are enabled, use the [**Get user settings**](/docs/api/users/#tag/users/GET/users/{userId}/settings) API or the [**Get account settings**](/docs/api/accounts/#tag/accounts/GET/accounts/{accountId}/settings) API to get the requirements.
+ */
+export type ZoomMeetingPassword = string;
+/**
+ * The meeting's scheduled duration, in minutes.
+ */
+export type ZoomMeetingDuration = Minutes;
+export declare enum ZoomMeetingType {
+    INSTANT = 1,
+    SCHEDULED = 2,
+    RECURRING_NO_FIXED_TIME = 3,
+    RECURRING_FIXED_TIME = 8
+}
+/**
+ * Define the interval when the meeting should recur.
+ *
+ * For instance, to schedule a meeting that recurs every two months, set this field's value as `2` and the value of the `type` parameter as `3`.
+ *
+ * For a daily meeting, the maximum number of recurrences is `99` days. For a weekly meeting, the maximum is `50` weeks.
+ *
+ * For a monthly meeting, the maximum is `10` months.
+ */
+export type ZoomRecurrenceInfoRepeatInterval = number;
+/**
+ * Comma-separated values, e.g., "1,2,3" for Sunday, Monday, Tuesday. (1-Sunday, 7-Saturday)
+ */
+export type ZoomRecurrenceInfoWeeklyDays = string;
+/**
+ * The number of times the meeting will recur
+ */
+export type ZoomRecurrenceInfoRecurrenceCount = number;
+export interface ZoomRecurrenceInfo {
+    readonly type: ZoomRecurrenceType;
+    readonly repeat_interval?: ZoomRecurrenceInfoRepeatInterval;
+    readonly weekly_days?: ZoomRecurrenceInfoWeeklyDays;
+    readonly monthly_day?: DayOfMonth;
+    readonly monthly_week?: ZoomMonthlyWeek;
+    readonly monthly_week_day?: ZoomMonthlyWeekDay;
+    readonly end_times?: ZoomRecurrenceInfoRecurrenceCount;
+    /**
+     * Date at which the recurrence ends.
+     */
+    readonly end_date_time?: ISO8601DateString;
+}
+export declare enum ZoomRecurrenceType {
+    DAILY = 1,
+    WEEKLY = 2,
+    MONTHLY = 3
+}
+export declare enum ZoomMonthlyWeek {
+    LAST_WEEK = -1,
+    FIRST_WEEK = 1,
+    SECOND_WEEK = 2,
+    THIRD_WEEK = 3,
+    FOURTH_WEEK = 4
+}
+export declare enum ZoomMonthlyWeekDay {
+    SUNDAY = 1,
+    MONDAY = 2,
+    TUESDAY = 3,
+    WEDNESDAY = 4,
+    THURSDAY = 5,
+    FRIDAY = 6,
+    SATURDAY = 7
+}
+export interface ZoomMeetingSettingsBreakoutRoomRoom {
+    readonly name: string;
+    readonly participants?: string[];
+}
+export interface ZoomMeetingSettingsBreakoutRoom {
+    readonly enable?: boolean;
+    readonly rooms?: ZoomMeetingSettingsBreakoutRoomRoom[];
+}
+export interface ZoomMeetingSettingsLanguageInterpretation {
+    readonly enable?: boolean;
+    readonly interpreters?: ZoomMeetingInterpreter[];
+}
+export interface ZoomMeetingSettingsApprovedOrDeniedCountriesOrRegions {
+    readonly enable?: boolean;
+    readonly method?: 'approve' | 'deny';
+    readonly approved_list?: string[];
+    readonly denied_list?: string[];
+}
+export type ZoomMeetingSettingsEncryptionType = 'enhanced_encryption' | 'end_to_end_encryption';
+/**
+ * Language translation string.
+ *
+ * e.g., "US:Fr" for US English to French
+ */
+export type ZoomMeetingInterpreterLanguage = string;
+export type ZoomMeetingInterpreterLanguages = string;
+export interface ZoomMeetingInterpreter {
+    readonly email: EmailAddress;
+    readonly languages: ZoomMeetingInterpreterLanguage;
+}
+/**
+ * Join before host time.
+ *
+ * 0 (Anytime), 5, 10 or 15 minutes before start time.
+ */
+export type ZoomJoinBeforeHostTime = 0 | 5 | 10 | 15;
+export declare enum ZoomApprovalType {
+    /**
+     * Automatically approve.
+     */
+    AUTOMATICALLY_APPROVE = 0,
+    /**
+     * Manually approve.
+     */
+    MANUALLY_APPROVE = 1,
+    /**
+     * No registration required.
+     */
+    NO_REGISTRATION_REQUIRED = 2
+}
+export declare enum ZoomRegistrationType {
+    /**
+     * Attendees register once and can attend any meeting occurrence.
+     */
+    REGISTER_ONCE_ATTEND_ANY = 1,
+    /**
+     * Attendees must register for each meeting occurrence.
+     */
+    REGISTER_FOR_EACH_OCCURRENCE = 2,
+    /**
+     * Attendees register once and can select one or more meeting occurrences to attend.
+     */
+    REGISTER_ONCE_CHOOSE_OCCURRENCES = 3
+}
+export interface ZoomMeetingTrackingField {
+    readonly field: string;
+    readonly value?: string;
+}
+export interface ZoomMeetingSettings {
+    readonly host_video?: boolean;
+    readonly participant_video?: boolean;
+    readonly cn_meeting?: boolean;
+    readonly in_meeting?: boolean;
+    readonly join_before_host?: boolean;
+    readonly jbh_time?: ZoomJoinBeforeHostTime;
+    readonly mute_upon_entry?: boolean;
+    readonly watermark?: boolean;
+    readonly use_pmi?: boolean;
+    readonly approval_type?: ZoomApprovalType;
+    readonly registration_type?: ZoomRegistrationType;
+    readonly audio?: 'both' | 'telephony' | 'voip' | 'thirdParty';
+    readonly auto_recording?: 'local' | 'cloud' | 'none';
+    readonly alternative_hosts?: CommaSeparatedString<EmailAddress>;
+    readonly waiting_room?: boolean;
+    readonly global_dial_in_countries?: string[];
+    readonly contact_name?: string;
+    readonly contact_email?: EmailAddress;
+    readonly meeting_authentication?: boolean;
+    readonly authentication_option?: string;
+    readonly authentication_domains?: CommaSeparatedString<WebsiteDomain>;
+    readonly breakout_room?: ZoomMeetingSettingsBreakoutRoom;
+    readonly language_interpretation?: ZoomMeetingSettingsLanguageInterpretation;
+    readonly interpreters?: Array<{
+        email: string;
+        languages: string;
+    }>;
+    readonly approved_or_denied_countries_or_regions?: ZoomMeetingSettingsApprovedOrDeniedCountriesOrRegions;
+    readonly encryption_type?: ZoomMeetingSettingsEncryptionType;
+    readonly alternative_host_update_polls?: boolean;
+    readonly show_share_button?: boolean;
+    readonly allow_multiple_devices?: boolean;
+}

package/src/lib/zoom/zoom.api.user.d.ts

@@ -0,0 +1,32 @@
+import { FetchPageFactory } from '@dereekb/util/fetch';
+import { ZoomPageFilter, ZoomPageResult } from '../zoom.api.page';
+import { ZoomUser, ZoomUserRoleId, ZoomUserStatus } from './zoom.api.user.type';
+import { ZoomContext } from './zoom.config';
+import { ZoomUserId } from '../zoom.type';
+export interface GetUserInput {
+    readonly userId: ZoomUserId;
+}
+export type GetUserResponse = ZoomUser;
+export type GetUserFunction = (input: GetUserInput) => Promise<GetUserResponse>;
+/**
+ * https://developers.zoom.us/docs/api/users/#tag/users/GET/users/{userId}
+ *
+ * @param context
+ * @returns
+ */
+export declare function getUser(context: ZoomContext): GetUserFunction;
+export interface ListUsersInput extends ZoomPageFilter {
+    readonly status?: ZoomUserStatus;
+    readonly role_id?: ZoomUserRoleId;
+}
+export type ListUsersResponse = ZoomPageResult<ZoomUser>;
+export type ListUsersFunction = (input?: ListUsersInput) => Promise<ListUsersResponse>;
+/**
+ * https://developers.zoom.us/docs/api/users/#tag/users/GET/users
+ *
+ * @param context
+ * @returns
+ */
+export declare function listUsers(context: ZoomContext): ListUsersFunction;
+export type ListUsersPageFactory = FetchPageFactory<ListUsersInput, ListUsersResponse>;
+export declare function listUsersPageFactory(context: ZoomContext): ListUsersPageFactory;