@chelseaapps/zoom documentation

File

Index

Properties

body
body: any
Type : any
Optional
Request body

method
method: Method
Type : Method
HTTP method to use for request

path
path: string
Type : string
Get the URL suffix of resource in the Zoom API

queryParameters
queryParameters: literal type[]
Type : literal type[]
Optional
List of parameters to add to the query

export enum Method {
    GET = 'GET',
    POST = 'POST',
    PUT = 'PUT',
    PATCH = 'PATCH',
    DELETE = 'DELETE',
}

export interface IZoomCommand {
    /**
     * Get the URL suffix of resource in the Zoom API
     * @example users/{userId}/webinars
     */
    path: string;

    /**
     * HTTP method to use for request
     */
    method: Method;

    /**
     * List of parameters to add to the query
     */
    queryParameters?: {
        name: string;
        value: string;
    }[];

    /**
     * Request body
     */
    body?: any;
}