@chelseaapps/zoom documentation

Simple wrapper around the Zoom REST API, with full parameter, body and response types.

Push zooms are not yet implemented

Installation

The project is hosted on our private npm registry, so to install simply run

npm

yarn

yarn add @chelseaapps/zoom

Requirements

The only requirement is Axios. If you use Nest this is handled by the HttpModule of NestJS, so does not need to be manually installed.

Configuration

The module can be imported either globally or restricted to a single module scope. The default option is global, as this allows the module to be used across multiple modules without having to configure it multiple times.

Config options

Option	Description	Example
isGlobal	Register the module globally across all modules in the app	true
auth > key	Zoom App API key	********
auth > secret	Zoom App secret key	********

The module can be configured in two ways:

• Regular

• Asynchronous

Regular config

Import the module into the module in which you wish to register, and call the static register function.

import { Module } from '@nestjs/common';
import { ZoomModule } from '@chelseaapps/zoom';

@Module({
    imports: [
        ... other imports here
        ZoomModule.register({
            isGlobal: true,
            auth: {
                key: "",
                secret: 465,
            },
        }),
    ],
    controllers: [],
    providers: [],
})
export class AppModule {}

Asynchronous config

The module can also be registered asynchronously to create the module dynamically, fetching configuration details from an external source (such as an environment variable).

import { Module } from '@nestjs/common';
import { ConfigModule, ConfigService } from '@nestjs/config';
import { ZoomModule } from '@chelseaapps/zoom';

@Module({
    imports: [
        ZoomModule.registerAsync({
            isGlobal: true,
            imports: [ConfigModule],
            useFactory: (configService: ConfigService) => ({
                auth: {
                    key: configService.get('ZOOM_API_KEY')!,
                    secret: configService.get('ZOOM_API_SECRET')!,
                },
            }),
            inject: [ConfigService],
        }),
    ],
    controllers: [],
    providers: [],
})
export class AppModule {}

Usage

Import the ZoomService into a module using the Nest depedency injection mechanism.

import { ZoomService } from '@chelseaapps/zoom';

@Injectable()
export class UserService {
    constructor(private zoomService: ZoomService) {}
}

The API is build using the concept of commands, which map directly to the list of endpoints available on the Zoom API - each command is an endpoint. To send a command to an endpoint, create a new instance of the command, passing in the required parameters, and call the ZoomService's send method.

This method returns the response from the Zoom API directly.

It does not handle errors yet.

import { ZoomService, CreateWebinarCommand } from "@chelseaapps/zoom"

@Injectable()
export class UserService {
    constructor(
        private zoomService: ZoomService,
    ) {}

    async createWebinar() {
        await this.zoomService.send(new CreateWebinarCommand("me", {
            password: "1234"
            ...
        }))
    }
}

Documentation

Zoom API documentation can be found here.

Detailed documentation of the methods can be found in the documentation folder. They can be hosted locally by running

from the documentation folder, and are also hosted on the Chelsea Apps Gitbook.