gohl/dist/classes/calendars.appointmentsnotes.d.ts

Go Highlevel Node Js ease of use library implementation to their API

import { AuthData } from "../interfaces/auth/authdata";
import { ICalendarEventAppointmentNote } from "../interfaces/calendar.appointmentnote";
export declare class CalendarAppointmentNote {
    private authData?;
    /**
     * Endpoints For Calendars Appointments Notes
     * https://highlevel.stoplight.io/docs/integrations/e04d0822bd613-get-notes
     */
    constructor(authData?: AuthData);
    /**
     * Get Appointment Notes
     * Documentation - https://highlevel.stoplight.io/docs/integrations/e04d0822bd613-get-notes
     * @param appointmentId
     * @param limit
     * @param offset
     */
    getAll(appointmentId: string, limit: number, offset: number): Promise<ICalendarEventAppointmentNote[]>;
    /**
     * Create Appointment Note
     * Documentation - https://highlevel.stoplight.io/docs/integrations/dcdda866d8b49-create-note
     * @param appointmentId
     * @param body - Note body (<= 5000 characters)
     * @param userId
     * @returns
     */
    add(appointmentId: string, body: string, userId?: string): Promise<ICalendarEventAppointmentNote>;
    /**
     * Update Appointment Note
     * Documentation - https://highlevel.stoplight.io/docs/integrations/f27408b1ae367-update-note
     * @param appointmentId
     * @param noteId
     * @param body - Note body (<= 5000 characters)
     * @param userId
     * @returns
     */
    update(appointmentId: string, noteId: string, body: string, userId?: string): Promise<ICalendarEventAppointmentNote>;
    /**
     * Delete Appointment Note
     * Documentation - https://highlevel.stoplight.io/docs/integrations/fe10a2bff1674-delete-note
     * @param appointmentId
     * @param noteId
     * @returns
     */
    remove(appointmentId: string, noteId: string): Promise<boolean>;
}