gohl
Version:
Go Highlevel Node Js ease of use library implementation to their API
50 lines (49 loc) • 1.58 kB
TypeScript
import { AuthData } from "../interfaces/auth/authdata";
import { INote } from "../interfaces/note";
export declare class Note {
private authData?;
/**
* Endpoints For Contacts Notes
* https://highlevel.stoplight.io/docs/integrations/db572d519b209-get-all-notes
*/
constructor(authData?: AuthData);
/**
* Get all Notes
* Documentation - https://highlevel.stoplight.io/docs/integrations/73decb4b6d0c2-get-all-notes
* @param contactId
*/
getAll(contactId: string): Promise<INote[]>;
/**
* Get Note
* Documentation - https://highlevel.stoplight.io/docs/integrations/24cab1c2b3dfb-get-note
* @param contactId
* @param noteId
* @returns
*/
get(contactId: string, noteId: string): Promise<INote>;
/**
* Create Note
* Documentation - https://highlevel.stoplight.io/docs/integrations/5eab1684a9948-create-note
* @param contactId
* @param note
* @returns
*/
add(contactId: string, note: INote): Promise<INote>;
/**
* Update Note
* Documentation - https://highlevel.stoplight.io/docs/integrations/71814e115658f-update-note
* @param contactId
* @param noteId
* @param note
* @returns
*/
update(contactId: string, noteId: string, note: INote): Promise<INote>;
/**
* Delete Note
* Documentation - https://highlevel.stoplight.io/docs/integrations/d7e867be69e9f-delete-note
* @param contactId
* @param noteId
* @returns
*/
remove(contactId: string, noteId: string): Promise<boolean>;
}