gohl/dist/classes/users.d.ts

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

import { AuthData } from "../interfaces/auth/authdata";
import { IUser } from "../interfaces/user";
export declare class User {
    private authData?;
    /**
     * Endpoints For Users
     */
    constructor(authData?: AuthData);
    /**
     * Get all Users
     * Documentation - https://public-api.gohighlevel.com/#b2157151-366b-4625-b1f8-d77458d0cf9f
     */
    getAll(): Promise<IUser[]>;
    /**
     * Get User by Location ID
     * Documentation - https://highlevel.stoplight.io/docs/integrations/2b1f72be935aa-get-user-by-location
     * @param locationId
     * @returns
     */
    getByLocation(locationId: string): Promise<IUser>;
    /**
     * Lookup user by email
     * Documentation - https://public-api.gohighlevel.com/#e74596d5-360c-46cb-b3dd-e065d62c29ee
     * @param email
     * @returns
     */
    lookup(email: string): Promise<IUser>;
    /**
     * Add Location
     * Documentation - https://public-api.gohighlevel.com/#2be923cc-fcbf-466a-8d8e-ff5ee1cfc244
     * @param user
     * @returns
     */
    add(user: IUser): Promise<IUser>;
    /**
     * Update a Location.
     * Documentation - https://public-api.gohighlevel.com/#4554e49d-0fc6-49d0-aa5c-feda76e522f0
     * @param userId
     * @param noteId
     * @param note
     * @returns
     */
    update(userId: string, user: IUser): Promise<IUser>;
    /**
     * Delete user.
     * Documentation - https://public-api.gohighlevel.com/#a59b4ce5-0657-46c7-8351-cb42e166e276
     * @param userId
     * @param deleteTwilioAccount
     * @returns
     */
    remove(userId: string, deleteTwilioAccount: boolean): Promise<string>;
}