@dereekb/zoom 13.4.0 → 13.4.2

package/nestjs/src/lib/zoom/zoom.module.d.ts

@@ -2,7 +2,13 @@ import { type ModuleMetadata } from '@nestjs/common';
 import { ConfigService } from '@nestjs/config';
 import { ZoomServiceConfig } from './zoom.config';
 import { type Maybe } from '@dereekb/util';
-export declare function zoomServiceConfigFactory(configService: ConfigService): ZoomServiceConfig;
+/**
+ * Default factory function for creating ZoomServiceConfig from ConfigService.
+ *
+ * @param _configService The NestJS ConfigService (unused currently)
+ * @returns A validated ZoomServiceConfig
+ */
+export declare function zoomServiceConfigFactory(_configService: ConfigService): ZoomServiceConfig;
 export interface ProvideAppZoomMetadataConfig extends Pick<ModuleMetadata, 'imports' | 'exports' | 'providers'> {
     /**
      * The ZoomModule requires the following dependencies in order to initialze properly:
@@ -15,8 +21,7 @@ export interface ProvideAppZoomMetadataConfig extends Pick<ModuleMetadata, 'impo
 /**
  * Convenience function used to generate ModuleMetadata for an app's ZoomModule.
  *
- * @param provide
- * @param useFactory
- * @returns
+ * @param config The configuration for the module metadata
+ * @returns Module metadata for the Zoom module
  */
 export declare function appZoomModuleMetadata(config: ProvideAppZoomMetadataConfig): ModuleMetadata;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dereekb/zoom",
-  "version": "13.4.0",
+  "version": "13.4.2",
   "exports": {
     "./nestjs": {
       "module": "./nestjs/index.esm.js",
@@ -17,8 +17,8 @@
     }
   },
   "peerDependencies": {
-    "@dereekb/nestjs": "13.4.0",
-    "@dereekb/util": "13.4.0",
+    "@dereekb/nestjs": "13.4.2",
+    "@dereekb/util": "13.4.2",
     "@nestjs/common": "^11.1.16",
     "@nestjs/config": "^4.0.3",
     "express": "^5.0.0",

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

@@ -35,5 +35,18 @@ export declare function serverAccessToken(context: ZoomOAuthContext): (input?: Z
  * @returns
  */
 export declare function userAccessToken(context: ZoomOAuthContext): (input: ZoomOAuthUserAccessTokenInput) => Promise<ZoomOAuthAccessTokenResponse>;
+/**
+ * Builds a FetchJsonInput for Zoom OAuth API calls with Basic auth.
+ *
+ * @param context The Zoom OAuth context
+ * @param input Optional override for client credentials
+ * @returns A configured FetchJsonInput for the OAuth API call
+ */
 export declare function zoomOAuthApiFetchJsonInput(context: ZoomOAuthContext, input?: Maybe<ZoomOAuthServerAccessTokenInput>): FetchJsonInput;
+/**
+ * Generates a Basic Authorization header value for Zoom OAuth.
+ *
+ * @param input The client ID and secret pair
+ * @returns The Base64-encoded Basic auth header value
+ */
 export declare function zoomOAuthServerBasicAuthorizationHeaderValue(input: ZoomAuthClientIdAndSecretPair): string;

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

@@ -21,14 +21,14 @@ export interface ZoomOAuthConfig extends ZoomAuthClientIdAndSecretPair, ZoomAcco
      */
     readonly accessTokenCache?: Maybe<ZoomAccessTokenCache>;
 }
-export interface ZoomOAuthFetchFactoryInput {
+export interface ZoomOAuthFetchFactoryParams {
 }
-export type ZoomOAuthFetchFactory = FactoryWithInput<ConfiguredFetch, ZoomOAuthFetchFactoryInput>;
-export type ZoomOAuthMakeUserAccessTokenFactoryInput = {
+export type ZoomOAuthFetchFactory = FactoryWithInput<ConfiguredFetch, ZoomOAuthFetchFactoryParams>;
+export type ZoomOAuthMakeUserAccessTokenFactoryParams = {
     readonly refreshToken: ZoomRefreshToken;
     readonly userAccessTokenCache?: Maybe<ZoomAccessTokenCache>;
 };
-export type ZoomOAuthMakeUserAccessTokenFactory = FactoryWithRequiredInput<ZoomAccessTokenFactory, ZoomOAuthMakeUserAccessTokenFactoryInput>;
+export type ZoomOAuthMakeUserAccessTokenFactory = FactoryWithRequiredInput<ZoomAccessTokenFactory, ZoomOAuthMakeUserAccessTokenFactoryParams>;
 /**
  * Context used for performing fetch() and fetchJson() calls with a configured fetch instance.
  */
@@ -42,3 +42,11 @@ export interface ZoomOAuthContext {
 export interface ZoomOAuthContextRef {
     readonly oauthContext: ZoomOAuthContext;
 }
+/**
+ * @deprecated use ZoomOAuthFetchFactoryParams instead.
+ */
+export type ZoomOAuthFetchFactoryInput = ZoomOAuthFetchFactoryParams;
+/**
+ * @deprecated use ZoomOAuthMakeUserAccessTokenFactoryParams instead.
+ */
+export type ZoomOAuthMakeUserAccessTokenFactoryInput = ZoomOAuthMakeUserAccessTokenFactoryParams;

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

@@ -1,4 +1,4 @@
-import { type Maybe } from '@dereekb/util';
+import { type Maybe, type Seconds } from '@dereekb/util';
 /**
  * Access token authorization string generated from a refresh token.
  */
@@ -26,9 +26,9 @@ export interface ZoomAccessToken {
      */
     readonly apiDomain: ZoomAccessTokenApiDomain;
     /**
-     * Length of time the token is valid for.
+     * Length of time the token is valid for, in seconds.
      */
-    readonly expiresIn: number;
+    readonly expiresIn: Seconds;
     /**
      * Date the token expires at.
      */
@@ -66,6 +66,9 @@ export type ZoomAccessTokenRefresher = ZoomAccessTokenFactory;
  */
 export type ZoomAccessTokenStringFactory = () => Promise<ZoomAccessTokenString>;
 /**
- * Generates a new ZoomAccessTokenStringFactory.
+ * Generates a new ZoomAccessTokenStringFactory from a ZoomAccessTokenFactory.
+ *
+ * @param zoomAccessTokenFactory The factory to extract the token string from
+ * @returns A factory that returns the access token string
  */
 export declare function zoomAccessTokenStringFactory(zoomAccessTokenFactory: ZoomAccessTokenFactory): ZoomAccessTokenStringFactory;

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

@@ -25,6 +25,19 @@ export declare class ZoomOAuthAuthFailureError extends FetchRequestFactoryError
     constructor(reason?: string | undefined);
 }
 export declare const logZoomOAuthErrorToConsole: import("..").LogZoomServerErrorFunction;
+/**
+ * Parses a FetchResponseError into a typed Zoom OAuth error.
+ *
+ * @param responseError The fetch response error to parse
+ * @returns The parsed error, or undefined if parsing fails
+ */
 export declare function parseZoomOAuthError(responseError: FetchResponseError): Promise<ParsedZoomServerError>;
-export declare function parseZoomOAuthServerErrorResponseData(zoomServerError: ZoomServerErrorData, responseError: FetchResponseError): ParsedZoomServerError;
+/**
+ * Parses a ZoomServerErrorData into a Zoom OAuth-specific error.
+ *
+ * @param zoomServerError The raw error data from the Zoom API
+ * @param responseError The original fetch response error
+ * @returns A parsed error, or undefined if the error is unrecognized
+ */
+export declare function parseZoomOAuthServerErrorResponseData(zoomServerError: ZoomServerErrorData, responseError: FetchResponseError): FetchRequestFactoryError | import("..").ZoomServerError<ZoomServerErrorData<unknown>> | undefined;
 export declare const handleZoomOAuthErrorFetch: import("..").HandleZoomErrorFetchFactory;

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

@@ -7,13 +7,19 @@ export interface ZoomOAuthFactoryConfig {
     /**
      * Creates a new fetch instance to use when making calls.
      */
-    fetchFactory?: ZoomOAuthFetchFactory;
+    readonly fetchFactory?: ZoomOAuthFetchFactory;
     /**
      * Custom log error function.
      */
-    logZoomServerErrorFunction?: LogZoomServerErrorFunction;
+    readonly logZoomServerErrorFunction?: LogZoomServerErrorFunction;
 }
 export type ZoomOAuthFactory = (config: ZoomOAuthConfig) => ZoomOAuth;
+/**
+ * Creates a ZoomOAuth instance factory from the given configuration.
+ *
+ * @param factoryConfig Configuration for the OAuth factory
+ * @returns A factory that creates configured ZoomOAuth instances
+ */
 export declare function zoomOAuthFactory(factoryConfig: ZoomOAuthFactoryConfig): ZoomOAuthFactory;
 export interface ZoomOAuthZoomAccessTokenFactoryConfig {
     /**

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

@@ -1,4 +1,4 @@
-import { type ISO8601DateString, type Maybe } from '@dereekb/util';
+import { type ISO8601DateString, type Maybe, type TimezoneString } from '@dereekb/util';
 import { type ZoomMeetingType, type ZoomRecurrenceInfo, type ZoomMeetingSettings, type ZoomMeetingAgenda, type ZoomMeetingDuration, type ZoomMeetingTrackingField, type ZoomMeetingTemplateId, type ZoomMeetingPassword, type ZoomMeeting, type ZoomMeetingId, type PastZoomMeeting, type ZoomMeetingOccurrenceId } from './zoom.api.meeting.type';
 import { type ZoomContext } from './zoom.config';
 import { type ZoomPageFilter, type ZoomPageResult } from '../zoom.api.page';
@@ -12,6 +12,9 @@ export type GetMeetingResponse = ZoomMeeting;
 export type GetMeetingFunction = (input: GetMeetingInput) => Promise<GetMeetingResponse>;
 /**
  * https://developers.zoom.us/docs/api/rest/reference/zoom-api/methods/#operation/meeting
+ *
+ * @param context The Zoom API context
+ * @returns A function that retrieves a meeting by ID
  */
 export declare function getMeeting(context: ZoomContext): GetMeetingFunction;
 export interface ListMeetingsForUserInput extends ZoomPageFilter {
@@ -21,9 +24,18 @@ 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
+ *
+ * @param context The Zoom API context
+ * @returns A function that lists meetings for a user
  */
 export declare function listMeetingsForUser(context: ZoomContext): ListMeetingsForUserFunction;
 export type ListMeetingsForUserPageFactory = FetchPageFactory<ListMeetingsForUserInput, ListMeetingsForUserResponse>;
+/**
+ * Creates a page factory for listing meetings for a user.
+ *
+ * @param context The Zoom API context
+ * @returns A page factory for paginated meeting listing
+ */
 export declare function listMeetingsForUserPageFactory(context: ZoomContext): ListMeetingsForUserPageFactory;
 /**
  * https://developers.zoom.us/docs/api/rest/reference/zoom-api/methods/#operation/meetingCreate
@@ -31,6 +43,7 @@ export declare function listMeetingsForUserPageFactory(context: ZoomContext): Li
 export interface CreateMeetingForUserTemplate {
     /**
      * The meeting's agenda. This value has a maximum length of 2,000 characters.
+     *
      * @example "My Meeting"
      */
     readonly agenda?: ZoomMeetingAgenda;
@@ -38,12 +51,14 @@ export interface CreateMeetingForUserTemplate {
      * 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;
@@ -54,6 +69,7 @@ export interface CreateMeetingForUserTemplate {
      * - 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;
@@ -61,6 +77,7 @@ export interface CreateMeetingForUserTemplate {
      * 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
      */
@@ -71,6 +88,7 @@ export interface CreateMeetingForUserTemplate {
     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;
@@ -89,7 +107,7 @@ export interface CreateMeetingForUserTemplate {
     /**
      * The time zone to use for the meeting.
      */
-    readonly timezone?: string;
+    readonly timezone?: TimezoneString;
     /**
      * The meeting type.
      * - `1`: Instant
@@ -114,6 +132,9 @@ export interface CreateMeetingForUserInput {
 export type CreateMeetingForUserResponse = ZoomMeeting;
 /**
  * https://developers.zoom.us/docs/api/meetings/#tag/meetings/POST/users/{userId}/meetings
+ *
+ * @param context The Zoom API context
+ * @returns A function that creates a meeting for a user
  */
 export declare function createMeetingForUser(context: ZoomContext): (input: CreateMeetingForUserInput) => Promise<CreateMeetingForUserResponse>;
 /**
@@ -135,6 +156,9 @@ export type UpdateMeetingResponse = unknown;
 export type UpdateMeetingFunction = (input: UpdateMeetingInput) => Promise<UpdateMeetingResponse>;
 /**
  * https://developers.zoom.us/docs/api/meetings/#tag/meetings/PUT/meetings/{meetingId}
+ *
+ * @param context The Zoom API context
+ * @returns A function that updates a meeting
  */
 export declare function updateMeeting(context: ZoomContext): UpdateMeetingFunction;
 export interface DeleteMeetingInput extends SilenceZoomErrorConfig {
@@ -161,6 +185,9 @@ export type DeleteMeetingFunction = (input: DeleteMeetingInput) => Promise<Delet
 export declare const DELETE_MEETING_DOES_NOT_EXIST_ERROR_CODE = 3001;
 /**
  * https://developers.zoom.us/docs/api/meetings/#tag/meetings/DELETE/meetings/{meetingId}
+ *
+ * @param context The Zoom API context
+ * @returns A function that deletes a meeting (silences 3001 "not found" errors by default)
  */
 export declare function deleteMeeting(context: ZoomContext): DeleteMeetingFunction;
 export interface GetPastMeetingInput {
@@ -170,6 +197,9 @@ export type GetPastMeetingResponse = PastZoomMeeting;
 export type GetPastMeetingFunction = (input: GetPastMeetingInput) => Promise<GetPastMeetingResponse>;
 /**
  * https://developers.zoom.us/docs/api/meetings/#tag/meetings/GET/past_meetings/{meetingId}
+ *
+ * @param context The Zoom API context
+ * @returns A function that retrieves a past meeting
  */
 export declare function getPastMeeting(context: ZoomContext): GetPastMeetingFunction;
 export interface GetPastMeetingParticipantsInput extends ZoomPageFilter {
@@ -179,7 +209,16 @@ export type GetPastMeetingParticipantsResponse = ZoomPageResult<PastZoomMeeting>
 export type GetPastMeetingParticipantsFunction = (input: GetPastMeetingParticipantsInput) => Promise<GetPastMeetingParticipantsResponse>;
 /**
  * https://developers.zoom.us/docs/api/meetings/#tag/meetings/GET/past_meetings/{meetingId}/participants
+ *
+ * @param context The Zoom API context
+ * @returns A function that retrieves participants from a past meeting
  */
 export declare function getPastMeetingParticipants(context: ZoomContext): GetPastMeetingParticipantsFunction;
 export type GetPastMeetingParticipantsPageFactory = FetchPageFactory<GetPastMeetingParticipantsInput, GetPastMeetingParticipantsResponse>;
+/**
+ * Creates a page factory for listing past meeting participants.
+ *
+ * @param context The Zoom API context
+ * @returns A page factory for paginated participant listing
+ */
 export declare function getPastMeetingParticipantsPageFactory(context: ZoomContext): GetPastMeetingParticipantsPageFactory;

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

@@ -13,7 +13,7 @@ export type ZoomMeetingTemplateId = string;
  * The meeting topic.
  */
 export type ZoomMeetingTopic = string;
-export type ZoomMeetingOccurrenceDuration = number;
+export type ZoomMeetingOccurrenceDuration = Minutes;
 /**
  * URL for participants to join the meeting.
  *
@@ -99,6 +99,7 @@ export interface ZoomMeeting {
     readonly registration_url?: ZoomRegistrationUrl;
     /**
      * The meeting's agenda. This value has a maximum length of 2,000 characters.
+     *
      * @example "My Meeting"
      */
     readonly agenda?: ZoomMeetingAgenda;
@@ -247,11 +248,17 @@ export declare enum ZoomMonthlyWeekDay {
  * Options for Continuous Meeting Chat linking between a meeting and a Zoom Team Chat channel.
  */
 export interface ZoomMeetingSettingsContinuousMeetingChat {
-    /** Enable or disable Continuous Meeting Chat. */
+    /**
+     * Enable or disable Continuous Meeting Chat.
+     */
     readonly enable?: boolean;
-    /** Auto-add invited external users to the linked channel. */
+    /**
+     * Auto-add invited external users to the linked channel.
+     */
     readonly auto_add_invited_external_users?: boolean;
-    /** Auto-add all meeting participants to the linked channel. */
+    /**
+     * Auto-add all meeting participants to the linked channel.
+     */
     readonly auto_add_meeting_participants?: boolean;
     /**
      * Rule describing which users are auto-added.
@@ -260,37 +267,59 @@ export interface ZoomMeetingSettingsContinuousMeetingChat {
      * • `org_invitees` – internal invited users only.
      */
     readonly who_is_added?: 'all_users' | 'org_invitees_and_participants' | 'org_invitees';
-    /** Identifier of the chat channel to link. */
+    /**
+     * Identifier of the chat channel to link.
+     */
     readonly channel_id?: string;
 }
-/** A pre-provisioned whiteboard resource shared at meeting start. */
+/**
+ * A pre-provisioned whiteboard resource shared at meeting start.
+ */
 export interface ZoomMeetingSettingsWhiteboardResource {
-    /** Resource type – currently only `whiteboard`. */
+    /**
+     * Resource type – currently only `whiteboard`.
+     */
     readonly resource_type: 'whiteboard';
-    /** Unique whiteboard identifier. */
+    /**
+     * Unique whiteboard identifier.
+     */
     readonly resource_id: string;
-    /** Initial permission granted to participants. */
+    /**
+     * Initial permission granted to participants.
+     */
     readonly permission_level?: 'editor' | 'commenter' | 'viewer';
 }
-/** Additional email invitee outside the standard Zoom invitation. */
+/**
+ * Additional email invitee outside the standard Zoom invitation.
+ */
 export interface ZoomMeetingSettingsInvitee {
     readonly email: EmailAddress;
-    /** Indicates whether the invitee belongs to the owner’s account. */
+    /**
+     * Indicates whether the invitee belongs to the owner’s account.
+     */
     readonly internal_user?: boolean;
 }
-/** User allowed to bypass meeting authentication. */
+/**
+ * User allowed to bypass meeting authentication.
+ */
 export interface ZoomMeetingSettingsAuthenticationException {
     readonly email: EmailAddress;
     readonly name?: string;
-    /** Unique join link generated for the exception user. */
+    /**
+     * Unique join link generated for the exception user.
+     */
     readonly join_url?: string;
 }
-/** Custom tracking field key–value pair. */
+/**
+ * Custom tracking field key–value pair.
+ */
 export interface ZoomMeetingSettingsCustomKey {
     readonly key: string;
     readonly value: string;
 }
-/** International dial-in number exposed in invitations. */
+/**
+ * International dial-in number exposed in invitations.
+ */
 export interface ZoomMeetingSettingsGlobalDialInNumber {
     readonly city?: string;
     readonly country?: string;
@@ -298,7 +327,9 @@ export interface ZoomMeetingSettingsGlobalDialInNumber {
     readonly number: string;
     readonly type: 'toll' | 'tollfree';
 }
-/** Webinar Q&A configuration block. */
+/**
+ * Webinar Q&A configuration block.
+ */
 export interface ZoomMeetingSettingsQnA {
     readonly enable?: boolean;
     readonly allow_submit_questions?: boolean;
@@ -307,10 +338,14 @@ export interface ZoomMeetingSettingsQnA {
     readonly attendees_can_comment?: boolean;
     readonly attendees_can_upvote?: boolean;
 }
-/** Interpreter mapping for language interpretation. */
+/**
+ * Interpreter mapping for language interpretation.
+ */
 export interface ZoomMeetingSettingsInterpreter {
     readonly email: EmailAddress;
-    /** BCP-47 language list in the form `"<source>-<target>"`, e.g., "en-US:es-ES". */
+    /**
+     * BCP-47 language list in the form `"<source>-<target>"`, e.g., "en-US:es-ES".
+     */
     readonly languages: string;
 }
 export interface ZoomMeetingSettings {

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

@@ -29,4 +29,10 @@ export type ListUsersFunction = (input?: ListUsersInput) => Promise<ListUsersRes
  */
 export declare function listUsers(context: ZoomContext): ListUsersFunction;
 export type ListUsersPageFactory = FetchPageFactory<ListUsersInput, ListUsersResponse>;
+/**
+ * Creates a page factory for listing users.
+ *
+ * @param context The Zoom API context
+ * @returns A page factory for paginated user listing
+ */
 export declare function listUsersPageFactory(context: ZoomContext): ListUsersPageFactory;

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

@@ -1,4 +1,4 @@
-import { type EmailAddress, type ISO8601DateStringUTCFull, type TimezoneString } from '@dereekb/util';
+import { type EmailAddress, type ISO8601DateStringUTCFull, type TimezoneString, type WebsiteUrl } from '@dereekb/util';
 import { type ZoomClientVersion, type ZoomUserId } from '../zoom.type';
 /**
  * Represents a Zoom user, as returned by the Zoom API.
@@ -78,26 +78,31 @@ export interface ZoomUser {
     readonly last_login_time: ISO8601DateStringUTCFull;
     /**
      * Returned if the user is enrolled in the Zoom United plan. See docs for enum values.
+     *
      * @example "1"
      */
     readonly plan_united_type?: ZoomUserPlanUnitedType;
     /**
      * The user's personal meeting ID (PMI).
+     *
      * @example 6589310093
      */
     readonly pmi: ZoomUserPersonalMeetingId;
     /**
      * The unique ID of the user's assigned role.
+     *
      * @example "0"
      */
     readonly role_id: ZoomUserRoleId;
     /**
      * The user's status: 'active', 'inactive', or 'pending'.
+     *
      * @example "active"
      */
     readonly status: ZoomUserStatus;
     /**
      * The user's timezone.
+     *
      * @example "Asia/Shanghai"
      */
     readonly timezone: TimezoneString;
@@ -131,11 +136,11 @@ export interface ZoomUser {
     /**
      * The user's personal meeting URL.
      */
-    readonly personal_meeting_url: string;
+    readonly personal_meeting_url: WebsiteUrl;
     /**
      * The user's profile picture URL.
      */
-    readonly pic_url: string;
+    readonly pic_url: WebsiteUrl;
     /**
      * The user's CMS user ID (may be empty).
      */
@@ -183,7 +188,7 @@ export interface ZoomUser {
     /**
      * The user's manager (email address).
      */
-    readonly manager?: string;
+    readonly manager?: EmailAddress;
     /**
      * The user's phone numbers (new format, array of objects).
      */

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

@@ -4,10 +4,10 @@ import { type ZoomConfig, type ZoomRefreshToken } from '../zoom.config';
 import { type ZoomRateLimiterRef } from '../zoom.limit';
 import { type ZoomAccessTokenCache, type ZoomAccessTokenStringFactory } from '../oauth/oauth';
 export type ZoomApiKey = ZoomRefreshToken;
-export interface ZoomFetchFactoryInput {
+export interface ZoomFetchFactoryParams {
     readonly zoomAccessTokenStringFactory: ZoomAccessTokenStringFactory;
 }
-export type ZoomFetchFactory = FactoryWithInput<ConfiguredFetch, ZoomFetchFactoryInput>;
+export type ZoomFetchFactory = FactoryWithInput<ConfiguredFetch, ZoomFetchFactoryParams>;
 /**
  * Denotes the type of authorization used by the ZoomContext.
  *
@@ -39,7 +39,7 @@ export interface ZoomServerContext extends ZoomContext {
     readonly makeUserContext: ZoomUserContextFactory;
     readonly config: ZoomConfig;
 }
-export interface ZoomUserContextFactoryInput {
+export interface ZoomUserContextFactoryParams {
     /**
      * The user's refresh token.
      */
@@ -54,7 +54,7 @@ export interface ZoomUserContextFactoryInput {
 /**
  * Creates a ZoomUserContext from the input.
  */
-export type ZoomUserContextFactory = FactoryWithRequiredInput<ZoomUserContext, ZoomUserContextFactoryInput>;
+export type ZoomUserContextFactory = FactoryWithRequiredInput<ZoomUserContext, ZoomUserContextFactoryParams>;
 /**
  * Context used for performing fetch requests for a specific user.
  */
@@ -67,3 +67,11 @@ export interface ZoomUserContext extends ZoomContext {
 export interface ZoomServerContextRef {
     readonly zoomServerContext: ZoomServerContext;
 }
+/**
+ * @deprecated use ZoomFetchFactoryParams instead.
+ */
+export type ZoomFetchFactoryInput = ZoomFetchFactoryParams;
+/**
+ * @deprecated use ZoomUserContextFactoryParams instead.
+ */
+export type ZoomUserContextFactoryInput = ZoomUserContextFactoryParams;

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

@@ -1,6 +1,19 @@
 import { type FetchResponseError } from '@dereekb/util/fetch';
 import { type ZoomServerErrorData, type ParsedZoomServerError } from '../zoom.error.api';
 export declare const logZoomErrorToConsole: import("..").LogZoomServerErrorFunction;
+/**
+ * Parses a FetchResponseError into a typed Zoom API error.
+ *
+ * @param responseError The fetch response error to parse
+ * @returns The parsed error, or undefined if parsing fails
+ */
 export declare function parseZoomApiError(responseError: FetchResponseError): Promise<ParsedZoomServerError>;
-export declare function parseZoomApiServerErrorResponseData(zoomServerError: ZoomServerErrorData, responseError: FetchResponseError): ParsedZoomServerError;
+/**
+ * Parses a ZoomServerErrorData into a Zoom API-specific error.
+ *
+ * @param zoomServerError The raw error data from the Zoom API
+ * @param responseError The original fetch response error
+ * @returns A parsed error, or undefined if the error is unrecognized
+ */
+export declare function parseZoomApiServerErrorResponseData(zoomServerError: ZoomServerErrorData, responseError: FetchResponseError): import("@dereekb/util/fetch").FetchRequestFactoryError | import("..").ZoomServerError<ZoomServerErrorData<unknown>> | undefined;
 export declare const handleZoomErrorFetch: import("..").HandleZoomErrorFetchFactory;

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

@@ -20,4 +20,10 @@ export interface ZoomFactoryConfig extends ZoomOAuthContextRef {
     readonly logZoomServerErrorFunction?: LogZoomServerErrorFunction;
 }
 export type ZoomFactory = (config: ZoomConfig) => Zoom;
+/**
+ * Creates a Zoom API factory from the given configuration.
+ *
+ * @param factoryConfig Configuration including OAuth context, rate limiting, and fetch settings
+ * @returns A factory function that creates a configured Zoom API instance
+ */
 export declare function zoomFactory(factoryConfig: ZoomFactoryConfig): ZoomFactory;

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

@@ -66,8 +66,8 @@ export type ZoomFetchPageFetchFunction<I extends ZoomPageFilter, R extends ZoomP
 /**
  * Creates a FetchPageFactory using the input ZoomFetchPageFetchFunction.
  *
- * @param fetch
- * @param defaults
- * @returns
+ * @param fetch - function that fetches a single page of results from the Zoom API
+ * @param defaults - optional default pagination configuration
+ * @returns a configured FetchPageFactory that handles Zoom's cursor-based pagination using `next_page_token`
  */
 export declare function zoomFetchPageFactory<I extends ZoomPageFilter, R extends ZoomPageResult<any>>(fetch: ZoomFetchPageFetchFunction<I, R>, defaults?: Maybe<FetchPageFactoryConfigDefaults>): import("@dereekb/util/fetch").FetchPageFactory<I, R>;