gohl/dist/classes/contacts.campaigns.d.ts

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

import { AuthData } from "../interfaces/auth/authdata";
export declare class Campaign {
    private authData?;
    /**
     * Endpoints For Contacts for Campaigns
     * Documentation: https://highlevel.stoplight.io/docs/integrations/ecf9b5b45deaf-add-contact-to-campaign
     */
    constructor(authData?: AuthData);
    /**
     * Add Contact to Campaign
     * Documentation: https://highlevel.stoplight.io/docs/integrations/ecf9b5b45deaf-add-contact-to-campaign
     * https://public-api.gohighlevel.com/#8a506dff-cea3-48bc-909f-4f85a0e8a7be
     * @param contactId
     * @param campaignId
     * @returns
     */
    add(contactId: string, campaignId: string): Promise<boolean>;
    /**
     * Delete Contact from Campaign
     * Documentation: https://highlevel.stoplight.io/docs/integrations/e88fc8bf2a781-remove-contact-from-campaign
     * @param contactId
     * @param campaignId
     * @returns
     */
    remove(contactId: string, campaignId: string): Promise<boolean>;
    /**
     * Delete Contact from all Campaign
     * Documentation: https://highlevel.stoplight.io/docs/integrations/e9642e2d8bc8a-remove-contact-from-every-campaign
     * @param contactId
     * @param campaignId
     * @returns
     */
    removeAll(contactId: string, campaignId: string): Promise<boolean>;
}