zoomwebinarclient/dist/cjs/index.d.ts

A node client for handling Zoom webinars. Can be used to create webinars as well as get webinar attendance. Requires a zoom api and secret key.

import { AxiosInstance } from "axios";
export default class ZoomClient {
    #private;
    _zoom: AxiosInstance;
    constructor({ apiKey, secretKey, timezone, user }: ZoomClientParams);
    getToken(): string;
    createSingleWebinar({ ...params }: CreateWebinarBaseParams): Promise<string>;
    createRecurringWebinar({ ...options }: CreateRecurringWebinarParams): Promise<string>;
    registerToWebinar({ webinarID, firstName, lastName, email, }: RegisterToWebinarParams): Promise<string>;
    getWebinarAttendees(webinarID: string): Promise<Participation[]>;
    deleteWebinar(webinarID: string): Promise<void>;
    updateWebinar({ ...params }: UpdateWebinarParams): Promise<unknown>;
}
declare type Recording = "local" | "cloud" | "none";
declare type Approval = "registration" | "registration+approval" | "none";
declare type Recurrence = "daily" | "weekly" | "monthly";
declare type DayOfWeek = "sunday" | "monday" | "tuesday" | "wednesday" | "thursday" | "friday" | "saturday";
declare type RecurrenceParams = {
    type: Recurrence;
    interval: number;
    endAfter: Date | Number;
};
declare type WeeklyRecurrence = RecurrenceParams & {
    type: "weekly";
    params: {
        weekdays: DayOfWeek[];
    };
};
declare type MonthlyRecurrence = RecurrenceParams & {
    type: "monthly";
    params: {
        day: number;
    } | {
        week: -1 | 1 | 2 | 3 | 4;
        weekdays: DayOfWeek[];
    };
};
declare type DailyRecurrence = RecurrenceParams & {
    type: "daily";
};
declare type RecurrenceOptions = WeeklyRecurrence | MonthlyRecurrence | DailyRecurrence;
declare type CreateRecurringWebinarParams = CreateWebinarBaseParams & RecurrenceOptions & {
    endAfter: Date | number;
    interval: number;
};
declare type UpdateWebinarParams = {
    id: string;
    occurrence_id?: string;
    options: Partial<CreateRecurringWebinarParams>;
};
declare type ZoomClientParams = {
    apiKey: string;
    secretKey: string;
    timezone: string;
    user: string;
};
declare type CreateWebinarBaseParams = {
    start: Date;
    name: string;
    agenda?: string;
    account?: string;
    password?: string;
    approval?: Approval;
    recording?: Recording;
    duration: number;
    alterantiveHosts?: string[];
};
declare type RegisterToWebinarParams = {
    webinarID: string;
    firstName: string;
    lastName: string;
    email: string;
};
declare type Participation = {
    id: string;
    user_id: string;
    name: string;
    user_email: string;
    join_time: Date | string;
    leave_time: Date | string;
    duration: number;
};
export {};