gohl/dist/classes/location.d.ts

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

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