gohl/dist/classes/conversations.d.ts

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

import { AuthData } from "../interfaces/auth/authdata";
import { IConversation, ISearchConversation, ISearchConversationParams } from "../interfaces/conversation";
import { ConversationsEmail } from "./conversations.email";
import { ConversationsMessage } from "./conversations.messages";
import { ConversationsProviders } from "./conversations.providers";
export declare class Conversations {
    private authData?;
    email: ConversationsEmail;
    messages: ConversationsMessage;
    providers: ConversationsProviders;
    /**
     * Endpoints For Conversations
     * https://highlevel.stoplight.io/docs/integrations/7fd1120fbd540-conversations-api
     */
    constructor(authData?: AuthData);
    /**
     * Get Conversation
     * Documentation - https://highlevel.stoplight.io/docs/integrations/d22efcfdb0c80-get-conversation
     * @param conversationId
     * @returns
     */
    get(conversationId: string): Promise<IConversation>;
    search(params: ISearchConversationParams): Promise<ISearchConversation>;
    /**
     * Create Conversation
     * Documentation - https://highlevel.stoplight.io/docs/integrations/8d0b19e09176e-create-conversation
     * @param locationId
     * @param contactId
     * @returns
     */
    create(locationId: string, contactId: string): Promise<IConversation>;
    /**
     * Update Conversation
     * Documentation - https://highlevel.stoplight.io/docs/integrations/f6c7d276afe8e-update-conversation
     * @param conversationId
     * @param data
     * @returns
     */
    update(conversationId: string, data: Partial<IConversation>): Promise<IConversation>;
    /**
     * Delete Conversation
     * Documentation - https://highlevel.stoplight.io/docs/integrations/d6b698c33ff49-delete-conversation
     * @param conversationId
     * @returns
     */
    remove(conversationId: string): Promise<any>;
}