nylas/lib/types/resources/notetakers.d.ts

A NodeJS wrapper for the Nylas REST API for email, contacts, and calendar.

import { Overrides } from '../config.js';
import { CreateNotetakerRequest, ListNotetakersResponse, Notetaker, NotetakerMedia, UpdateNotetakerRequest, ListNotetakersQueryParams, NotetakerLeaveResponse } from '../models/notetakers.js';
import { NylasBaseResponse, NylasResponse } from '../models/response.js';
import { AsyncListResponse, Resource } from './resource.js';
/**
 * @property identifier The identifier of the grant to act upon
 * @property queryParams The query parameters to filter the list of Notetakers
 */
export interface ListNotetakersParams {
    identifier?: string;
    queryParams?: ListNotetakersQueryParams;
}
/**
 * @property identifier The identifier of the grant to act upon
 * @property requestBody The request body to create the Notetaker with
 */
export interface CreateNotetakerParams {
    identifier?: string;
    requestBody: CreateNotetakerRequest;
}
/**
 * @property identifier The identifier of the grant to act upon
 * @property notetakerId The ID of the Notetaker to find
 */
export interface FindNotetakerParams {
    identifier?: string;
    notetakerId: string;
}
/**
 * @property identifier The identifier of the grant to act upon
 * @property notetakerId The ID of the Notetaker to update
 * @property requestBody The request body to update the Notetaker with
 */
export interface UpdateNotetakerParams {
    identifier?: string;
    notetakerId: string;
    requestBody: UpdateNotetakerRequest;
}
/**
 * @property identifier The identifier of the grant to act upon
 * @property notetakerId The ID of the Notetaker to cancel
 */
export interface CancelNotetakerParams {
    identifier?: string;
    notetakerId: string;
}
/**
 * @property identifier The identifier of the grant to act upon
 * @property notetakerId The ID of the Notetaker to leave
 */
export interface LeaveNotetakerParams {
    identifier?: string;
    notetakerId: string;
}
/**
 * @property identifier The identifier of the grant to act upon
 * @property notetakerId The ID of the Notetaker to download media from
 */
export interface DownloadNotetakerMediaParams {
    identifier?: string;
    notetakerId: string;
}
/**
 * Nylas Notetakers API
 *
 * The Nylas Notetakers API allows you to invite a Notetaker bot to meetings.
 */
export declare class Notetakers extends Resource {
    /**
     * Return all Notetakers
     * @param params The parameters to list Notetakers with
     * @return The list of Notetakers
     */
    list({ identifier, queryParams, overrides, }: ListNotetakersParams & Overrides): AsyncListResponse<ListNotetakersResponse>;
    /**
     * Invite a Notetaker to a meeting
     * @param params The parameters to create the Notetaker with
     * @returns Promise resolving to the created Notetaker
     */
    create({ identifier, requestBody, overrides, }: CreateNotetakerParams & Overrides): Promise<NylasResponse<Notetaker>>;
    /**
     * Return a single Notetaker
     * @param params The parameters to find the Notetaker with
     * @returns Promise resolving to the Notetaker
     */
    find({ identifier, notetakerId, overrides, }: FindNotetakerParams & Overrides): Promise<NylasResponse<Notetaker>>;
    /**
     * Update a Notetaker
     * @param params The parameters to update the Notetaker with
     * @returns Promise resolving to the updated Notetaker
     */
    update({ identifier, notetakerId, requestBody, overrides, }: UpdateNotetakerParams & Overrides): Promise<NylasResponse<Notetaker>>;
    /**
     * Cancel a scheduled Notetaker
     * @param params The parameters to cancel the Notetaker with
     * @returns Promise resolving to the base response with request ID
     */
    cancel({ identifier, notetakerId, overrides, }: CancelNotetakerParams & Overrides): Promise<NylasBaseResponse>;
    /**
     * Remove a Notetaker from a meeting
     * @param params The parameters to remove the Notetaker from the meeting
     * @returns Promise resolving to a response containing the Notetaker ID and a message
     */
    leave({ identifier, notetakerId, overrides, }: LeaveNotetakerParams & Overrides): Promise<NylasResponse<NotetakerLeaveResponse>>;
    /**
     * Download media (recording and transcript) from a Notetaker session
     * @param params The parameters to download the Notetaker media
     * @returns Promise resolving to the media download response with URLs and sizes
     */
    downloadMedia({ identifier, notetakerId, overrides, }: DownloadNotetakerMediaParams & Overrides): Promise<NylasResponse<NotetakerMedia>>;
}