react-live-chat-customerly/dist/types.d.ts

The Live Chat component for React Apps by Customerly.

export declare type LogLevel = "info" | "error" | "warn";
export declare type CustomerlyPosition = {
    bottom: number;
    side: number;
};
export declare type CustomerlyMessengerPosition = {
    mobile: CustomerlyPosition;
    desktop: CustomerlyPosition;
};
export declare type CustomerlyMessenger = {
    direction?: "right" | "left";
    accentColor?: string;
    contrastColor?: string;
    autodetectLocale?: boolean;
    visible?: boolean;
    visibleOnMobile?: boolean;
    screenshotAvailable?: boolean;
    attachmentsAvailable?: boolean;
    singleConversation?: boolean;
    position?: CustomerlyMessengerPosition;
    disableCSSOMInjection?: boolean;
};
export declare type CustomerlyContactProperty = {
    user_id?: string | number;
    name?: string;
    email?: string;
    email_hash?: string;
    attributes?: any;
};
export interface CustomerlyCompanyProperty {
    company?: {
        company_id: string | number;
        name?: string;
        attributes?: any;
    };
}
export declare type CustomerlySettings = CustomerlyMessenger & CustomerlyContactProperty & CustomerlyCompanyProperty;
export declare type CustomerlyCallerMethod = "load" | "update" | "show" | "hide" | "open" | "close" | "attribute" | "event" | "showArticle" | "showBookMeeting" | "showNewMessage" | "sendNewMessage" | "logout" | "registerCallback";
export declare type CustomerlyCallbackOnChatClosed = {
    type: "onChatClosed";
    function: () => void;
};
export declare type CustomerlyCallbackOnChatOpened = {
    type: "onChatOpened";
    function: () => void;
};
export declare type CustomerlyCallbackOnRealtimeVideoAnswered = {
    type: "onRealtimeVideoAnswered";
    function: () => void;
};
export declare type CustomerlyCallbackOnRealtimeVideoRejected = {
    type: "onRealtimeVideoRejected";
    function: () => void;
};
export declare type CustomerlyCallbackOnLeadGenerated = {
    type: "onLeadGenerated";
    function: (email: string) => void;
};
export declare type CustomerlyCallbackOnNewConversation = {
    type: "onNewConversation";
    function: (message: string, attachments: any) => void;
};
export declare type CustomerlyCallbackOnProfilingQuestionAsked = {
    type: "onProfilingQuestionAsked";
    function: (attribute: string) => void;
};
export declare type CustomerlyCallbackOnProfilingQuestionAnswered = {
    type: "onProfilingQuestionAnswered";
    function: (attribute: string, value: any) => void;
};
export declare type CustomerlyCallbackOnHelpCenterArticleOpened = {
    type: "onHelpCenterArticleOpened";
    function: (article: any) => void;
};
export declare type CustomerlyCallbackOnChatflowNotificationViewed = {
    type: "onChatflowNotificationViewed";
    function: (notificationId: number, email?: string) => void;
};
export declare type CustomerlyCallbackOnChatflowNotificationClicked = {
    type: "onChatflowNotificationClicked";
    function: (notificationId: number, item: ChatflowNotificationCallbackItem, email?: string) => void;
};
export declare type CustomerlyCallbackOnNewMessageReceived = {
    type: "onNewMessageReceived";
    function: (message: {
        accountId: number;
        message: string;
        timestamp: number;
        userId: number;
        conversationId: number;
    }) => void;
};
export declare type CustomerlyCallbackOnNewConversationReceived = {
    type: "onNewConversationReceived";
    function: (conversationId: number) => void;
};
export declare type CustomerlyCallback = CustomerlyCallbackOnChatClosed | CustomerlyCallbackOnChatOpened | CustomerlyCallbackOnNewConversation | CustomerlyCallbackOnProfilingQuestionAnswered | CustomerlyCallbackOnProfilingQuestionAsked | CustomerlyCallbackOnLeadGenerated | CustomerlyCallbackOnHelpCenterArticleOpened | CustomerlyCallbackOnRealtimeVideoAnswered | CustomerlyCallbackOnRealtimeVideoRejected | CustomerlyCallbackOnChatflowNotificationViewed | CustomerlyCallbackOnChatflowNotificationClicked | CustomerlyCallbackOnNewMessageReceived | CustomerlyCallbackOnNewConversationReceived;
export declare type CustomerlyContextValues = {
    load: (settings: CustomerlySettings) => void;
    update: (settings: CustomerlySettings) => void;
    show: () => void;
    hide: () => void;
    open: () => void;
    close: () => void;
    attribute: (attributeIdentifier: string, attributeValue: any) => void;
    event: (eventName: string) => void;
    logout: () => void;
    showArticle: (collectionSlugOrArticleId: string | number, articleSlug?: string) => void;
    showBookMeeting: () => void;
    showNewMessage: (message: string) => void;
    sendNewMessage: (message: string) => void;
    registerCallback: (callback: CustomerlyCallback) => void;
};
export declare type CustomerlyProviderValues = {
    appId: string;
    beta?: boolean;
};
export declare enum ChatflowNotificationCallbackItemType {
    Article = "article",
    Attributes = "attributes",
    Button = "button",
    CalendarButton = "calendar_button",
    CloseButton = "close_button",
    StartConversationButton = "start_conversation_button"
}
declare type ChatflowNotificationCallbackItem = ChatflowNotificationCallbackItemArticle | ChatflowNotificationCallbackItemAttribute | ChatflowNotificationCallbackItemButton | ChatflowNotificationCallbackItemCalendarButton | ChatflowNotificationCallbackItemCloseButton | ChatflowNotificationCallbackItemStartConversationButton;
interface ChatflowNotificationCallbackItemArticle {
    article: {
        article_id: number;
        collection_id: number;
        title: string;
        description: string;
        author: {
            account_id: number;
            name?: string;
        };
    };
    type: ChatflowNotificationCallbackItemType.Article;
}
interface ChatflowNotificationCallbackItemAttribute {
    attributes: {
        name: string;
        value: boolean | number | string;
    }[];
    type: ChatflowNotificationCallbackItemType.Attributes;
}
interface ChatflowNotificationCallbackItemButton {
    button: {
        caption: string;
        link: string;
    };
    type: ChatflowNotificationCallbackItemType.Button;
}
interface ChatflowNotificationCallbackItemCalendarButton {
    button: {
        caption: string;
        link: string;
    };
    type: ChatflowNotificationCallbackItemType.CalendarButton;
}
interface ChatflowNotificationCallbackItemCloseButton {
    type: ChatflowNotificationCallbackItemType.CloseButton;
}
interface ChatflowNotificationCallbackItemStartConversationButton {
    button: {
        caption: string;
    };
    type: ChatflowNotificationCallbackItemType.StartConversationButton;
}
export {};