@bikdotai/bik-component-library 0.0.735 → 0.0.736-beta.1

package/dist/esm/components/template-preview/models/WhatsAppTemplate.d.ts

@@ -1,350 +1,350 @@
-import React, { ReactElement } from 'react';
-import { variableType } from '../helpers/VariableEditorHelper';
-import { CHANNEL_TYPE } from './Channels';
-import { ACTIONS_TYPES, ButtonPlaceHolderOptions, CUSTOM_VARIABLE, HEADER_TYPES, QUICK_REPLY_BUTTON, TEMPLATE_STATUS } from './TemplateMeta';
-export type WhatsAppTemplate = {
-    name: string;
-    label: string;
-    recommended?: boolean;
-    templateId?: string;
-    channel: CHANNEL_TYPE;
-    templateCategory: string;
-    type?: 'email' | 'whatsapp';
-    components: {
-        type: 'HEADER' | 'BODY' | 'BUTTONS' | 'FOOTER' | 'limited_time_offer' | 'TITLE';
-        format?: HEADER_TYPES;
-        text?: string;
-        limited_time_offer?: {
-            text: string;
-            has_expiration: boolean;
-        };
-        buttons?: {
-            type: 'QUICK_REPLY' | 'URL' | 'PHONE_NUMBER' | 'COPY_CODE' | 'VOICE_CALL';
-            text?: string;
-            url?: string;
-            example?: string[];
-            linkMode?: 'custom' | 'home';
-            phone_number?: string;
-            flowName?: string;
-            flowId?: string;
-        }[];
-        example?: {
-            header_handle?: Array<string>;
-            body_text?: Array<string[]>;
-            header_text?: Array<string>;
-            limited_time_offer?: string;
-            title_text?: Array<string[]>;
-        };
-    }[];
-    mapping: {
-        header?: string[];
-        body?: string[];
-        buttons?: string[];
-        title?: string[];
-    };
-    htmlContentUrl?: string;
-    language: 'en_US';
-    status: TEMPLATE_STATUS;
-    category: string;
-    thumbnailImageUrl?: string;
-    FB_blob_key?: string;
-    reason?: string;
-    createdAt: number;
-    updatedAt: number;
-    isDraft?: boolean;
-    newQualityScore?: TEMPLATE_QUALITY;
-    previousQualityScore?: TEMPLATE_QUALITY;
-    aiContentConfigId?: string;
-    showCallPermissionCard?: boolean;
-    callPermissionText?: string;
-};
-export type WhatsappTemplateButtonTypes = 'QUICK_REPLY' | 'URL' | 'PHONE_NUMBER' | 'COPY_CODE' | 'VOICE_CALL' | 'CALL_PERMISSION';
-export type CreateTemplateType = {
-    /** Data */
-    headerType: HEADER_TYPES;
-    headerAssetLink?: string | null;
-    headerAssetName?: string | null;
-    headerText?: string;
-    headerVariables: templateVariable[];
-    bodyVariables: templateVariable[];
-    titleVariables?: templateVariable[];
-    bodyText?: string;
-    titleText?: string;
-    bodyTextRaw?: string;
-    footerText?: string;
-    actionsType: ACTIONS_TYPES;
-    quickReply: Array<QUICK_REPLY_BUTTON>;
-    ctaBtn: {
-        phoneNumber?: {
-            isChecked?: boolean;
-            btnText?: string;
-            phoneNumber?: string;
-        };
-        websiteLinkBtn?: {
-            isChecked?: boolean;
-            btnText?: string;
-            linkOpens?: string;
-            placeholder?: string;
-        };
-    };
-    allButtons: WhatsappPreviewButtonType[];
-    meta: {
-        name: string;
-        category?: string;
-        subCategory?: string;
-        language?: string;
-        templateId?: string;
-    };
-    mode: 'edit' | 'create';
-    alreadyAsADraft?: boolean;
-    /** UI  */
-    initialLoading: boolean;
-    limitedTimeOfferComponent: {
-        text: string;
-        dateTime: string;
-        code: string;
-    };
-    showCallPermissionCard?: boolean;
-    callPermissionText?: string;
-    error: {
-        modalError?: string;
-        header?: string;
-        body?: string;
-        footer?: string;
-        quickReply?: Array<string | null>;
-        meta?: {
-            name?: string;
-        };
-        ctaBtn?: {
-            phoneNumber: {
-                btnText: string;
-                link: string;
-            };
-            websiteLink: {
-                btnText: string;
-                link: string;
-            };
-        };
-    };
-    /** DATA DUMP */
-    buttonPlaceholders?: templatePlaceHolder[];
-};
-export type templatePlaceHolder = {
-    default_value: string;
-    placeHolder: string;
-    title: string;
-};
-export type templateVariable = {
-    editable: boolean;
-    variableName: string;
-    variableVal?: string;
-    editableDefaultValues?: string | null;
-    idx: number;
-};
-export type getTemplateByIdResponse = {
-    components: WhatsAppTemplate['components'];
-    language: string;
-    label: string;
-    createdAt: any;
-    templateId: string;
-    name: string;
-    createdBy: string;
-    channel: string;
-    isDraft?: boolean;
-    mapping: TemplateVariableMapping;
-    isArchive?: boolean;
-    storeId: string;
-    channelTemplateId: string;
-    status: TEMPLATE_STATUS;
-    category: string;
-    templateCategory: string;
-    syncOnboarding?: boolean;
-    recomendedForCohorts?: string[];
-    htmlContentUrl?: string;
-};
-export type TemplateVariableMapping = {
-    body: string[];
-    buttons: string[];
-    header: string[];
-    footer: string[];
-    title?: string[];
-};
-export type WhatsappLikePreviewTypes = {
-    bodyText?: string;
-    footerText?: string;
-    headerMediaType: HEADER_TYPES;
-    headerText?: string;
-    headerAssetLink?: string;
-    headerAssetName?: string;
-    quickReplybtn?: QUICK_REPLY_BUTTON[];
-    ctaBtn?: {
-        type: 'phoneNumber' | 'website';
-        text: string;
-        extra?: string;
-        placeholder?: string;
-    }[];
-    actionTypes?: ACTIONS_TYPES;
-    textType: 'html' | 'markdown';
-    hidePreviewText?: boolean;
-    extras?: boolean;
-    containerStyle?: React.CSSProperties;
-    showHeader?: boolean;
-    containerPadding?: string;
-    imagePreviewStyles?: React.CSSProperties;
-    size?: 'small' | 'large';
-    zeroStateComponent: ReactElement<any, any>;
-    children?: React.ReactNode;
-    bodyVariableList?: variableType[];
-    headerVariableList?: variableType[];
-    carouselCardIndex?: number;
-    buttons?: WhatsappPreviewButtonType[];
-    limitedTimeOfferComponent?: CreateTemplateType['limitedTimeOfferComponent'];
-    isWhatsappCarousel?: boolean;
-    isPreview?: boolean;
-    titleText?: string;
-    titleVariableList?: variableType[];
-    showCallPermissionCard?: boolean;
-    callPermissionText?: string;
-    hideFooter?: boolean;
-};
-export type WhatsappPreviewButtonType = {
-    type: WhatsappTemplateButtonTypes;
-    text: string;
-    placeholder?: string;
-    flowId: string;
-    flowName: string;
-};
-export declare enum TEMPLATE_QUALITY {
-    GREEN = "GREEN",
-    YELLOW = "YELLOW",
-    RED = "RED",
-    UNKNOWN = "UNKNOWN"
-}
-export type WhatsappMeta = {
-    containerStyle?: React.CSSProperties | undefined;
-    templateContainerStyles?: React.CSSProperties | undefined;
-    size?: 'small' | 'large';
-    showWhatsAppHeader?: boolean;
-    whatsAppExtras?: boolean;
-    zeroStateComponent?: ReactElement;
-    usePlaceHolderName?: boolean;
-    showCallPermissionCard?: boolean;
-    callPermissionText?: string;
-};
-export interface IMimeTypeResponse {
-    isValid: boolean;
-    mimeType: string;
-}
-export type WhatsAppPickerMeta = {
-    uploadMediaFiles: (params: WhatsAppMediaUploadRequest, index?: number) => Promise<WhatsAppMediaUploadResponse>;
-    uploadMediaLink?: (link: string) => Promise<MediaLinkUploadResponse>;
-    validateMimeType?: (file: File | Blob) => Promise<IMimeTypeResponse>;
-    CTAoptions?: ButtonPlaceHolderOptions[];
-    QRBoptions?: ButtonPlaceHolderOptions[];
-};
-export type WhatsAppMediaUploadResponse = {
-    success: boolean;
-    url?: string;
-};
-export interface MediaLinkUploadResponse extends WhatsAppMediaUploadResponse {
-    size: number;
-    type: string;
-}
-export type WhatsAppMediaUploadRequest = {
-    file: File;
-    fileName: string;
-    isImage: boolean;
-};
-export interface WhatsAppTemplateVariables {
-    body: CUSTOM_VARIABLE[];
-    header: CUSTOM_VARIABLE[];
-    buttons: TEMPLATE_BUTTON[];
-    title?: CUSTOM_VARIABLE[];
-}
-export type CTABtnValType = {
-    defaultValue: string;
-    placeHolder: string;
-} | string;
-export type QRBBtnValType = {
-    flowId?: string;
-    flowName?: string;
-};
-export type TEMPLATE_BUTTON = {
-    type: BUTTON_TYPE;
-    text?: string;
-    url?: string;
-    example?: string[] | string;
-    linkMode?: 'custom' | 'home';
-    phone_number?: string;
-    buttonVariable?: string;
-    index?: number;
-    flowId?: string;
-    flowName?: string;
-    queryParams?: {
-        key: string;
-        value: string;
-    }[];
-};
-export declare enum BUTTON_TYPE {
-    QUICK_REPLY = "QUICK_REPLY",
-    URL = "URL",
-    PHONE_NUMBER = "PHONE_NUMBER",
-    COPY_CODE = "COPY_CODE",
-    VOICE_CALL = "VOICE_CALL"
-}
-export declare enum POD {
-    CHATBOT = "CHATBOT",
-    GROWTH = "GROWTH",
-    CAMPAIGN = "CAMPAIGN",
-    CRM = "CRM",
-    INTEGRATIONS = "INTEGRATIONS",
-    OPENAI = "OPENAI",
-    DM = "DM",
-    FRONTEND = "FRONTEND"
-}
-export type ExtrasWhatsapp = {
-    discountCodeExtra?: [
-        discountCode: string,
-        setDiscountCode: (discountCode: string) => void
-    ];
-    backTrackExtra?: [
-        backTrackMessage: string,
-        setBackTrackMessage: (backTrackMessage: string) => void
-    ];
-};
-export type TemplateAnalyticsI = {
-    fetchAnalytics?: (templateId: string) => Promise<TemplateAnalyticsResponseI>;
-    show?: boolean;
-    templateQuality?: TEMPLATE_QUALITY;
-    data?: TemplateAnalyticsDataI;
-};
-export type TemplateAnalyticsResponseI = {
-    success: boolean;
-    analytics?: TemplateAnalyticsDataI;
-};
-export interface TemplateAnalyticsDataI {
-    totalReads: number;
-    totalSent: number;
-    totalDelivered: number;
-    deliveredPercentage: number;
-    readPercentage: number;
-    clickAnalytics: {
-        [buttonName: string]: {
-            totalClicks: number;
-            clickPercentage: number;
-        };
-    };
-    performance: {
-        qualityTimeLine: TEMPLATE_QUALITY[];
-    };
-}
-export interface TemplateAnalyticsComponentI {
-    templateAnalytics?: TemplateAnalyticsI;
-    templateId: string;
-    onClose?: () => void;
-    onProceed?: () => void;
-    onCancel?: () => void;
-    headingTitle?: string;
-    headingSubtitle?: string;
-    analyticsData?: TemplateAnalyticsDataI;
-}
+import React, { ReactElement } from 'react';
+import { variableType } from '../helpers/VariableEditorHelper';
+import { CHANNEL_TYPE } from './Channels';
+import { ACTIONS_TYPES, ButtonPlaceHolderOptions, CUSTOM_VARIABLE, HEADER_TYPES, QUICK_REPLY_BUTTON, TEMPLATE_STATUS } from './TemplateMeta';
+export type WhatsAppTemplate = {
+    name: string;
+    label: string;
+    recommended?: boolean;
+    templateId?: string;
+    channel: CHANNEL_TYPE;
+    templateCategory: string;
+    type?: 'email' | 'whatsapp';
+    components: {
+        type: 'HEADER' | 'BODY' | 'BUTTONS' | 'FOOTER' | 'limited_time_offer' | 'TITLE';
+        format?: HEADER_TYPES;
+        text?: string;
+        limited_time_offer?: {
+            text: string;
+            has_expiration: boolean;
+        };
+        buttons?: {
+            type: 'QUICK_REPLY' | 'URL' | 'PHONE_NUMBER' | 'COPY_CODE' | 'VOICE_CALL';
+            text?: string;
+            url?: string;
+            example?: string[];
+            linkMode?: 'custom' | 'home';
+            phone_number?: string;
+            flowName?: string;
+            flowId?: string;
+        }[];
+        example?: {
+            header_handle?: Array<string>;
+            body_text?: Array<string[]>;
+            header_text?: Array<string>;
+            limited_time_offer?: string;
+            title_text?: Array<string[]>;
+        };
+    }[];
+    mapping: {
+        header?: string[];
+        body?: string[];
+        buttons?: string[];
+        title?: string[];
+    };
+    htmlContentUrl?: string;
+    language: 'en_US';
+    status: TEMPLATE_STATUS;
+    category: string;
+    thumbnailImageUrl?: string;
+    FB_blob_key?: string;
+    reason?: string;
+    createdAt: number;
+    updatedAt: number;
+    isDraft?: boolean;
+    newQualityScore?: TEMPLATE_QUALITY;
+    previousQualityScore?: TEMPLATE_QUALITY;
+    aiContentConfigId?: string;
+    showCallPermissionCard?: boolean;
+    callPermissionText?: string;
+};
+export type WhatsappTemplateButtonTypes = 'QUICK_REPLY' | 'URL' | 'PHONE_NUMBER' | 'COPY_CODE' | 'VOICE_CALL' | 'CALL_PERMISSION';
+export type CreateTemplateType = {
+    /** Data */
+    headerType: HEADER_TYPES;
+    headerAssetLink?: string | null;
+    headerAssetName?: string | null;
+    headerText?: string;
+    headerVariables: templateVariable[];
+    bodyVariables: templateVariable[];
+    titleVariables?: templateVariable[];
+    bodyText?: string;
+    titleText?: string;
+    bodyTextRaw?: string;
+    footerText?: string;
+    actionsType: ACTIONS_TYPES;
+    quickReply: Array<QUICK_REPLY_BUTTON>;
+    ctaBtn: {
+        phoneNumber?: {
+            isChecked?: boolean;
+            btnText?: string;
+            phoneNumber?: string;
+        };
+        websiteLinkBtn?: {
+            isChecked?: boolean;
+            btnText?: string;
+            linkOpens?: string;
+            placeholder?: string;
+        };
+    };
+    allButtons: WhatsappPreviewButtonType[];
+    meta: {
+        name: string;
+        category?: string;
+        subCategory?: string;
+        language?: string;
+        templateId?: string;
+    };
+    mode: 'edit' | 'create';
+    alreadyAsADraft?: boolean;
+    /** UI  */
+    initialLoading: boolean;
+    limitedTimeOfferComponent: {
+        text: string;
+        dateTime: string;
+        code: string;
+    };
+    showCallPermissionCard?: boolean;
+    callPermissionText?: string;
+    error: {
+        modalError?: string;
+        header?: string;
+        body?: string;
+        footer?: string;
+        quickReply?: Array<string | null>;
+        meta?: {
+            name?: string;
+        };
+        ctaBtn?: {
+            phoneNumber: {
+                btnText: string;
+                link: string;
+            };
+            websiteLink: {
+                btnText: string;
+                link: string;
+            };
+        };
+    };
+    /** DATA DUMP */
+    buttonPlaceholders?: templatePlaceHolder[];
+};
+export type templatePlaceHolder = {
+    default_value: string;
+    placeHolder: string;
+    title: string;
+};
+export type templateVariable = {
+    editable: boolean;
+    variableName: string;
+    variableVal?: string;
+    editableDefaultValues?: string | null;
+    idx: number;
+};
+export type getTemplateByIdResponse = {
+    components: WhatsAppTemplate['components'];
+    language: string;
+    label: string;
+    createdAt: any;
+    templateId: string;
+    name: string;
+    createdBy: string;
+    channel: string;
+    isDraft?: boolean;
+    mapping: TemplateVariableMapping;
+    isArchive?: boolean;
+    storeId: string;
+    channelTemplateId: string;
+    status: TEMPLATE_STATUS;
+    category: string;
+    templateCategory: string;
+    syncOnboarding?: boolean;
+    recomendedForCohorts?: string[];
+    htmlContentUrl?: string;
+};
+export type TemplateVariableMapping = {
+    body: string[];
+    buttons: string[];
+    header: string[];
+    footer: string[];
+    title?: string[];
+};
+export type WhatsappLikePreviewTypes = {
+    bodyText?: string;
+    footerText?: string;
+    headerMediaType: HEADER_TYPES;
+    headerText?: string;
+    headerAssetLink?: string;
+    headerAssetName?: string;
+    quickReplybtn?: QUICK_REPLY_BUTTON[];
+    ctaBtn?: {
+        type: 'phoneNumber' | 'website';
+        text: string;
+        extra?: string;
+        placeholder?: string;
+    }[];
+    actionTypes?: ACTIONS_TYPES;
+    textType: 'html' | 'markdown';
+    hidePreviewText?: boolean;
+    extras?: boolean;
+    containerStyle?: React.CSSProperties;
+    showHeader?: boolean;
+    containerPadding?: string;
+    imagePreviewStyles?: React.CSSProperties;
+    size?: 'small' | 'large';
+    zeroStateComponent: ReactElement<any, any>;
+    children?: React.ReactNode;
+    bodyVariableList?: variableType[];
+    headerVariableList?: variableType[];
+    carouselCardIndex?: number;
+    buttons?: WhatsappPreviewButtonType[];
+    limitedTimeOfferComponent?: CreateTemplateType['limitedTimeOfferComponent'];
+    isWhatsappCarousel?: boolean;
+    isPreview?: boolean;
+    titleText?: string;
+    titleVariableList?: variableType[];
+    showCallPermissionCard?: boolean;
+    callPermissionText?: string;
+    hideFooter?: boolean;
+};
+export type WhatsappPreviewButtonType = {
+    type: WhatsappTemplateButtonTypes;
+    text: string;
+    placeholder?: string;
+    flowId: string;
+    flowName: string;
+};
+export declare enum TEMPLATE_QUALITY {
+    GREEN = "GREEN",
+    YELLOW = "YELLOW",
+    RED = "RED",
+    UNKNOWN = "UNKNOWN"
+}
+export type WhatsappMeta = {
+    containerStyle?: React.CSSProperties | undefined;
+    templateContainerStyles?: React.CSSProperties | undefined;
+    size?: 'small' | 'large';
+    showWhatsAppHeader?: boolean;
+    whatsAppExtras?: boolean;
+    zeroStateComponent?: ReactElement;
+    usePlaceHolderName?: boolean;
+    showCallPermissionCard?: boolean;
+    callPermissionText?: string;
+};
+export interface IMimeTypeResponse {
+    isValid: boolean;
+    mimeType: string;
+}
+export type WhatsAppPickerMeta = {
+    uploadMediaFiles: (params: WhatsAppMediaUploadRequest, index?: number) => Promise<WhatsAppMediaUploadResponse>;
+    uploadMediaLink?: (link: string) => Promise<MediaLinkUploadResponse>;
+    validateMimeType?: (file: File | Blob) => Promise<IMimeTypeResponse>;
+    CTAoptions?: ButtonPlaceHolderOptions[];
+    QRBoptions?: ButtonPlaceHolderOptions[];
+};
+export type WhatsAppMediaUploadResponse = {
+    success: boolean;
+    url?: string;
+};
+export interface MediaLinkUploadResponse extends WhatsAppMediaUploadResponse {
+    size: number;
+    type: string;
+}
+export type WhatsAppMediaUploadRequest = {
+    file: File;
+    fileName: string;
+    isImage: boolean;
+};
+export interface WhatsAppTemplateVariables {
+    body: CUSTOM_VARIABLE[];
+    header: CUSTOM_VARIABLE[];
+    buttons: TEMPLATE_BUTTON[];
+    title?: CUSTOM_VARIABLE[];
+}
+export type CTABtnValType = {
+    defaultValue: string;
+    placeHolder: string;
+} | string;
+export type QRBBtnValType = {
+    flowId?: string;
+    flowName?: string;
+};
+export type TEMPLATE_BUTTON = {
+    type: BUTTON_TYPE;
+    text?: string;
+    url?: string;
+    example?: string[] | string;
+    linkMode?: 'custom' | 'home';
+    phone_number?: string;
+    buttonVariable?: string;
+    index?: number;
+    flowId?: string;
+    flowName?: string;
+    queryParams?: {
+        key: string;
+        value: string;
+    }[];
+};
+export declare enum BUTTON_TYPE {
+    QUICK_REPLY = "QUICK_REPLY",
+    URL = "URL",
+    PHONE_NUMBER = "PHONE_NUMBER",
+    COPY_CODE = "COPY_CODE",
+    VOICE_CALL = "VOICE_CALL"
+}
+export declare enum POD {
+    CHATBOT = "CHATBOT",
+    GROWTH = "GROWTH",
+    CAMPAIGN = "CAMPAIGN",
+    CRM = "CRM",
+    INTEGRATIONS = "INTEGRATIONS",
+    OPENAI = "OPENAI",
+    DM = "DM",
+    FRONTEND = "FRONTEND"
+}
+export type ExtrasWhatsapp = {
+    discountCodeExtra?: [
+        discountCode: string,
+        setDiscountCode: (discountCode: string) => void
+    ];
+    backTrackExtra?: [
+        backTrackMessage: string,
+        setBackTrackMessage: (backTrackMessage: string) => void
+    ];
+};
+export type TemplateAnalyticsI = {
+    fetchAnalytics?: (templateId: string) => Promise<TemplateAnalyticsResponseI>;
+    show?: boolean;
+    templateQuality?: TEMPLATE_QUALITY;
+    data?: TemplateAnalyticsDataI;
+};
+export type TemplateAnalyticsResponseI = {
+    success: boolean;
+    analytics?: TemplateAnalyticsDataI;
+};
+export interface TemplateAnalyticsDataI {
+    totalReads: number;
+    totalSent: number;
+    totalDelivered: number;
+    deliveredPercentage: number;
+    readPercentage: number;
+    clickAnalytics: {
+        [buttonName: string]: {
+            totalClicks: number;
+            clickPercentage: number;
+        };
+    };
+    performance: {
+        qualityTimeLine: TEMPLATE_QUALITY[];
+    };
+}
+export interface TemplateAnalyticsComponentI {
+    templateAnalytics?: TemplateAnalyticsI;
+    templateId: string;
+    onClose?: () => void;
+    onProceed?: () => void;
+    onCancel?: () => void;
+    headingTitle?: string;
+    headingSubtitle?: string;
+    analyticsData?: TemplateAnalyticsDataI;
+}