@open-tender/types 0.0.38 → 0.0.40

package/dist/cjs/types/api/config.d.ts

@@ -1,4 +1,7 @@
-import { IpAddress } from '../global';
+import { TimezonePython } from '../datetimes';
+import { IpAddress, OrderType, ServiceType } from '../global';
+import { ButtonColor } from '../theme';
+import { LoyaltyType, NotificationChannel } from './customer';
 import { PrepStations, PrepStatus } from './kds';
 export interface Config {
     backup_printer_ip_address: IpAddress | null;
@@ -45,3 +48,726 @@ export interface SelectOption {
     select_option_id: number;
 }
 export declare type SelectOptions = Array<SelectOption>;
+export interface ConfigApp {
+    authUrl: string;
+    baseUrl: string;
+    brandId: string;
+    clientId: string;
+}
+export interface ConfigAcceptMarketing {
+    default: boolean;
+    description: string;
+    title: string;
+}
+export interface ConfigFulfillmentField {
+    label: string;
+    name: string;
+    placeholder: string;
+}
+export interface ConfigFulfillment {
+    button: string;
+    description: string;
+    title: string;
+    fields: Array<ConfigFulfillmentField>;
+}
+export interface ConfigLoyaltyTermsThreshold {
+    description: string;
+    name: string;
+    points: number;
+}
+export interface ConfigLoyaltyTerms {
+    expiration_days: number;
+    name: string;
+    points_per_dollar: number;
+    thresholds: Array<ConfigLoyaltyTermsThreshold>;
+}
+export interface ConfigLoyalty {
+    description: string;
+    loyalty_type: LoyaltyType;
+    name: string;
+    order_type: OrderType;
+    terms: ConfigLoyaltyTerms;
+}
+export interface ConfigOrderNotifications {
+    default: NotificationChannel;
+    description: string;
+    title: string;
+}
+export interface ConfigBrand {
+    accepts_marketing: ConfigAcceptMarketing;
+    applePayMerchantId: string;
+    appleTouchIcon: string;
+    brandId: number;
+    catering_id: number;
+    description: string;
+    email: string;
+    favicon: string;
+    fulfillment: ConfigFulfillment;
+    gatewayId: string;
+    googlePayMerchantId: string;
+    gtmContainerId: string;
+    has_allergens: boolean;
+    has_app: boolean;
+    has_deals: boolean;
+    has_donations: boolean;
+    has_favorites: boolean;
+    has_gift_cards: boolean;
+    has_house_accounts: boolean;
+    has_levelup: boolean;
+    has_loyalty: boolean;
+    has_pos: boolean;
+    has_rewards: boolean;
+    has_sms: boolean;
+    has_thanx: boolean;
+    logo: string;
+    logoLight: string;
+    loyalty: ConfigLoyalty;
+    olo_id: number;
+    openGraphImage: string | null;
+    order_notifications: ConfigOrderNotifications;
+    origin: string;
+    timezone: TimezonePython;
+    title: string;
+    url: string;
+}
+export interface ConfigContentField {
+    title: string;
+    subtitle: string;
+    empty?: string;
+}
+export declare type HomeOrderTypes = 'CATERING' | 'DELIVERY' | 'DONATIONS' | 'GIFT_CARDS' | 'GROUP' | 'MERCH' | 'OUTPOST' | 'PICKUP' | 'WALKIN';
+export declare type RevenueCenterStatus = 'CLOSED' | 'CLOSED_TEMPORARILY' | 'COMING_SOON';
+export interface ConfigContent {
+    about: {
+        background: string;
+        content: string;
+        mobile: string;
+        subtitle: string;
+        title: string;
+    };
+    accessibility: {
+        background: string;
+        content: Array<string>;
+        subtitle: string;
+        title: string;
+    };
+    account: {
+        addresses: ConfigContentField;
+        allergens: ConfigContentField;
+        background: string;
+        content: string;
+        creditCards: ConfigContentField;
+        deals: ConfigContentField;
+        displayLogo: boolean;
+        displayLogoApp: boolean;
+        displayLogoMobile: boolean;
+        displayed: Array<string>;
+        displayedMobile: Array<string>;
+        favorites: ConfigContentField;
+        giftCards: ConfigContentField;
+        greeting: string;
+        groupOrders: ConfigContentField;
+        houseAccounts: ConfigContentField;
+        levelup: ConfigContentField;
+        loyalty: {
+            signUp: string;
+            title: string;
+            subtitle: string;
+            skip: string;
+        };
+        mobile: string;
+        profile: ConfigContentField;
+        punctuation: string;
+        recentItems: ConfigContentField;
+        recentOrders: ConfigContentField;
+        rewards: ConfigContentField;
+        showFirstName: boolean;
+        showHero: boolean;
+        subtitle: string;
+        thanx: ConfigContentField;
+        title: string;
+    };
+    accountSettings: ConfigContentField;
+    addresses: ConfigContentField;
+    allergens: ConfigContentField;
+    catering: {
+        background: string;
+        content: string;
+        mobile: string;
+        subtitle: string;
+        title: string;
+        policy: {
+            content: Array<string>;
+            subtitle: string;
+            title: string;
+        };
+    };
+    cateringSite: {
+        background: string;
+        content: string;
+        mobile: string;
+        subtitle: string;
+        title: string;
+    };
+    checkout: {
+        account: ConfigContentField;
+        address: ConfigContentField;
+        background: string;
+        checkTitle: string;
+        details: ConfigContentField;
+        discounts: ConfigContentField;
+        giftCards: ConfigContentField;
+        guest: ConfigContentField;
+        promoCodes: ConfigContentField;
+        signUp: ConfigContentField;
+        subtitle: string;
+        surcharges: ConfigContentField;
+        tenders: ConfigContentField;
+        title: string;
+    };
+    checkoutFlow: {
+        sections: {
+            email: ConfigContentField;
+            magicLink: {
+                changeEmail: string;
+                resend: string;
+                subtitle: string;
+                title: string;
+            };
+            name: ConfigContentField;
+            signIn: ConfigContentField;
+            signUp: ConfigContentField & {
+                showGuest: boolean;
+            };
+        };
+    };
+    communicationPreferences: ConfigContentField;
+    confirmation: ConfigContentField & {
+        background: string;
+        error: string;
+    };
+    creditCards: ConfigContentField;
+    deals: ConfigContentField;
+    donations: ConfigContentField & {
+        background: string;
+    };
+    error: ConfigContentField & {
+        background: string;
+    };
+    favorites: ConfigContentField;
+    fulfillment: {
+        background: string;
+    };
+    giftCards: ConfigContentField & {
+        background: string;
+    };
+    giftCardsAccount: ConfigContentField;
+    groupOrders: ConfigContentField & {
+        background: string;
+    };
+    guest: ConfigContentField & {
+        background: string;
+        content: string;
+        displayLogo: boolean;
+        displayLogoApp: boolean;
+        displayLogoMobile: boolean;
+        displayed: Array<string>;
+        displayedMobile: Array<string>;
+        mobile: string;
+        showGuest: boolean;
+        subtitle: string;
+        title: string;
+    };
+    home: ConfigContentField & {
+        background: string;
+        content: string;
+        mobile: string;
+        orderTypes: {
+            [keys in HomeOrderTypes]: ConfigContentField;
+        };
+        showHero: boolean;
+    };
+    houseAccounts: ConfigContentField;
+    menu: {
+        background: string;
+        cartErrors: ConfigContentField;
+        displayed: Array<string>;
+        displayedMobile: Array<string>;
+        loadingMessage: string;
+        mobile: string;
+        soldOutMessage: string;
+    };
+    menuSite: ConfigContentField & {
+        background: string;
+        content: string;
+        mobile: string;
+    };
+    notFound: ConfigContentField & {
+        back: string;
+        background: string;
+    };
+    orderType: ConfigContentField & {
+        background: string;
+        content: string;
+        mobile: string;
+        orderTypes: {
+            [keys in HomeOrderTypes]: ConfigContentField;
+        };
+        showDescriptions: boolean;
+        showDescriptionsMobile: boolean;
+        showHero: boolean;
+    };
+    orders: ConfigContentField;
+    profile: ConfigContentField;
+    refunds: ConfigContentField & {
+        background: string;
+        content: Array<string>;
+    };
+    resetPassword: ConfigContentField & {
+        back: string;
+        background: string;
+    };
+    revenueCenters: ConfigContentField & {
+        background: string;
+        mobile: string;
+        statusMessages: {
+            [keys in RevenueCenterStatus]: ConfigContentField;
+        };
+    };
+    rewards: ConfigContentField & {
+        loyalty: ConfigContentField;
+        rewards: ConfigContentField;
+    };
+    signUp: ConfigContentField & {
+        back: string;
+        background: string;
+    };
+    upsells: {
+        cart: ConfigContentField & {
+            decline: string;
+            show: boolean;
+        };
+        checkout: ConfigContentField & {
+            decline: string;
+            proceed: string;
+            show: boolean;
+        };
+        item: ConfigContentField & {
+            decline: string;
+            show: boolean;
+        };
+    };
+}
+export interface ConfigSettingsCheckout {
+    address_company: string | null;
+    address_contact: string | null;
+    address_phone: string | null;
+    address_unit: string | null;
+    customer_company: string | null;
+    details_count: string | null;
+    details_eatingUtensils: string | null;
+    details_notes: string | null;
+    details_servingUtensils: string | null;
+    promo_code_limit: number;
+}
+export interface ConfigDisplaySetting {
+    allergens: boolean;
+    builderImages: boolean;
+    builderType: string;
+    calories: boolean;
+    categoryType: string;
+    categoryTypeMobile: string;
+    groupsTypeApp: string;
+    hasCustomize: boolean;
+    itemsTwoPerRowMobile: boolean;
+    madeFor: boolean;
+    menuHero: boolean;
+    menuHeroChild: boolean;
+    menuHeroChildMobile: boolean;
+    menuHeroMobile: boolean;
+    menuImages: boolean;
+    menuItemDescription: string;
+    menuItemDescriptionMobile: string;
+    menuType: string;
+    menuTypeApp: string;
+    menuTypeMobile: string;
+    modifierDescription: boolean;
+    modifierGroupDescription: boolean;
+    modifierImage: boolean;
+    modifiersType: string;
+    notes: boolean;
+    quickAdd: boolean;
+    quickAddMobile: boolean;
+    skipToCustomize: boolean;
+    skipToCustomizeMobile: boolean;
+    storePhone: boolean;
+    tags: boolean;
+}
+export interface LocationAnchor {
+    x: number;
+    y: number;
+}
+export interface ConfigIconSize {
+    height: number;
+    width: number;
+}
+export interface ConfigIcon {
+    anchor: LocationAnchor | null;
+    size: ConfigIconSize;
+    url: string;
+}
+export interface ConfigSettings {
+    accountSections: Array<string>;
+    autoSelect: {
+        [keys in OrderType]?: {
+            [keys in ServiceType]?: boolean;
+        };
+    };
+    checkout: {
+        orderTypes: {
+            [keys in OrderType]?: ConfigSettingsCheckout;
+        };
+    };
+    displaySettings: {
+        [keys in OrderType]?: ConfigDisplaySetting;
+    };
+    googleMaps: {
+        apiKey: string;
+        apiKeyApp: string;
+        defaultCenter: {
+            lat: number;
+            lng: number;
+        };
+        icons: {
+            location: ConfigIcon;
+            locationSelected: ConfigIcon;
+            user: ConfigIcon;
+        };
+        styles: {
+            backgroundColor: string;
+            featureColor: string;
+            labelColor: string;
+            roadColor: string;
+            waterColor: string;
+        };
+        zoom: number;
+    };
+    locationName: {
+        [keys in ServiceType]?: Array<string>;
+    };
+    maxDistance: number;
+    orderTypes: Array<HomeOrderTypes>;
+    recaptcha: {
+        addCard: boolean;
+        donations: boolean;
+        giftCards: boolean;
+    };
+}
+interface ConfigButtonSize {
+    borderRadius: string;
+    borderWidth: string;
+    borderWidthApp: string;
+    fontSize: string;
+    letterSpacing: string;
+    padding: string;
+    showButtonApp: boolean;
+    showSubtitle: boolean;
+    showSubtitleMobile: boolean;
+    subtitleFontMobile: string;
+    subtitleFontSize: string;
+    subtitleFontSizeMobile: string;
+    subtitleFontWeight: string;
+    subtitleMarginTop: string;
+    subtitleMarginTopMobile: string;
+    titleFontMobile: string;
+    titleFontSize: string;
+    titleFontSizeMobile: string;
+    titleFontWeight: string;
+    titleMarginLeft: string;
+    titleMarginLeftMobile: string;
+}
+export interface ConfigCardColors {
+    bgColor: string;
+    borderColor: string;
+    borderRadius: string;
+    borderWidth: string;
+    borderWidthApp: string;
+    boxShadow: string;
+    caloriesColor: string;
+    overrideFontColors: boolean;
+    priceColor: string;
+    priceSize: string;
+    priceSizeMobile: string;
+    textColor: string;
+    titleColor: string;
+    titleSize: string;
+    titleSizeMobile: string;
+}
+export interface ConfigCountColors {
+    bgColor: string;
+    borderColor: string;
+    borderWidth: string;
+    borderWidthApp: string;
+    color: string;
+    family: string;
+    fontMobile: string;
+    fontSize: string;
+    fontSizeMobile: string;
+    fontSmoothing: string;
+    paddingBottom: string;
+    paddingTop: string;
+    weight: string;
+}
+export declare type ConfigFontSizes = 'big' | 'giga' | 'h1' | 'h2' | 'h3' | 'h4' | 'h5' | 'h6' | 'main' | 'mega' | 'small' | 'tera' | 'xBig' | 'xSmall' | 'xxBig' | 'xxSmall';
+export interface ConfigFont {
+    color: string;
+    family: string;
+    fontMobile: string;
+    fontSmoothing: string;
+    letterSpacing: string;
+    lineHeight: number;
+    lineHeights: {
+        [keys in ConfigFontSizes]: string;
+    };
+    textTransform: string;
+    url: string;
+    weight: string;
+}
+export interface ConfigItem {
+    imageHeight: string;
+    imageMaxHeight: string;
+    imageMinHeight: string;
+    imagePadding: string;
+    maxWidth: string;
+    padding: string;
+}
+export interface ConfigLink {
+    color: string;
+    hover: string;
+}
+export interface ConfigTheme {
+    alert: {
+        bgColor: string;
+        color: string;
+    };
+    bgColors: {
+        alert: string;
+        allergens: string;
+        dark: string;
+        error: string;
+        highlight: string;
+        light: string;
+        primary: string;
+        secondary: string;
+        success: string;
+        tertiary: string;
+        toast: string;
+    };
+    boldWeight: string;
+    border: {
+        color: string;
+        radius: string;
+        radiusSmall: string;
+        width: string;
+        widthApp: string;
+    };
+    boxShadow: {
+        appBig: string;
+        appSmall: string;
+        inset: string;
+        outer: string;
+    };
+    breakpoints: {
+        laptop: string;
+        mobile: string;
+        narrow: string;
+        tablet: string;
+    };
+    buttons: {
+        colors: {
+            cart: ButtonColor;
+            cartHover: ButtonColor;
+            header: ButtonColor;
+            headerHover: ButtonColor;
+            large: ButtonColor & {
+                iconColor: string;
+                subtitleColor: string;
+            };
+            largeHover: ButtonColor & {
+                iconColor: string;
+                subtitleColor: string;
+            };
+            light: ButtonColor;
+            lightHover: ButtonColor;
+            primary: ButtonColor;
+            primaryHover: ButtonColor;
+            secondary: ButtonColor;
+            secondaryHover: ButtonColor;
+        };
+        sizes: {
+            big: Partial<ConfigButtonSize>;
+            default: Partial<ConfigButtonSize>;
+            header: Partial<ConfigButtonSize>;
+            large: Partial<ConfigButtonSize>;
+            small: Partial<ConfigButtonSize>;
+        };
+    };
+    cards: {
+        default: Partial<ConfigCardColors>;
+        form: Partial<ConfigCardColors>;
+        menuItem: Partial<ConfigCardColors>;
+        modifier: Partial<ConfigCardColors>;
+    };
+    colors: {
+        alert: string;
+        allergens: string;
+        dark: string;
+        error: string;
+        light: string;
+        primary: string;
+        secondary: string;
+        success: string;
+        tags: string;
+        tertiary: string;
+        title: string;
+        toast: string;
+    };
+    counts: {
+        alerts: Partial<ConfigCountColors>;
+        quantity: Partial<ConfigCountColors>;
+    };
+    error: {
+        bgColor: string;
+        color: string;
+    };
+    favorite: {
+        iconSize: string;
+        size: string;
+    };
+    fonts: {
+        body: ConfigFont;
+        headings: ConfigFont;
+        headline: ConfigFont;
+        lineHeights: {
+            [keys in ConfigFontSizes]: string;
+        };
+        preface: ConfigFont;
+        sizes: {
+            [keys in ConfigFontSizes]: string;
+        };
+    };
+    header: {
+        primary: string;
+        stuck: string;
+    };
+    icons: {
+        strokeWidth: number;
+    };
+    inputs: {
+        bgColor: string;
+        bgColorFocus: string;
+        borderColor: string;
+        borderColorFocus: string;
+        borderStyle: string;
+        borderWidth: string;
+        borderWidthApp: string;
+        bottomBorderOnly: boolean;
+        boxShadow: string;
+        color: string;
+        colorFocus: string;
+        family: string;
+        fontMobile: string;
+        fontSize: string;
+        fontSizeMobile: string;
+        fontSmoothing: string;
+        iconLeft: string;
+        iconPadding: string;
+        label: {
+            fontSize: string;
+            left: string;
+            lineHeight: string;
+            offset: string;
+            padding: string;
+            top: string;
+        };
+        letterSpacing: string;
+        lineHeight: string;
+        padding: string;
+        paddingBottom: string;
+        paddingBottomActive: string;
+        paddingHorizontal: string;
+        paddingTop: string;
+        paddingTopActive: string;
+        paddingVertical: string;
+        placeholderColor: string;
+        radius: string;
+        selectPaddingBottom: string;
+        selectSize: string;
+        selectSizeMobile: string;
+        showIcon: boolean;
+        showLabel: boolean;
+        showOutline: boolean;
+        textTransform: string;
+        weight: string;
+    };
+    item: {
+        desktop: ConfigItem;
+        imageMaxHeight: string;
+        imageMinHeight: string;
+        imagePadding: string;
+        maxWidth: string;
+        mobile: ConfigItem;
+        padding: string;
+    };
+    layout: {
+        containerMaxWidth: string;
+        headerHeightApp: string;
+        headerHeightSite: string;
+        headerHeightSiteMobile: string;
+        margin: string;
+        marginMobile: string;
+        maxWidth: string;
+        navHeight: string;
+        navHeightApp: string;
+        navHeightMobile: string;
+        padding: string;
+        paddingMobile: string;
+    };
+    lineHeight: string;
+    links: {
+        customize: ConfigLink;
+        dark: ConfigLink;
+        light: ConfigLink;
+        primary: ConfigLink;
+        textDecoration: string;
+        transition: string;
+    };
+    overlay: {
+        alert: string;
+        dark: string;
+        light: string;
+        primary: string;
+        secondary: string;
+        tertiary: string;
+    };
+    success: {
+        bgColor: string;
+        color: string;
+    };
+    toast: {
+        bgColor: string;
+        color: string;
+    };
+    welcome: {
+        marginBottom: string;
+        marginTop: string;
+        subtitleLineHeight: string;
+        subtitleMarginTop: string;
+        subtitleSize: string;
+        textAlign: string;
+        titleLineHeight: string;
+        titleMarginLeft: string;
+        titleSize: string;
+    };
+}
+export {};