@open-tender/types 0.4.157 → 0.4.158

package/dist/cjs/types/api/completedOrders.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -1,565 +0,0 @@
-import { TimezonePython } from '../datetimes';
-import { LatLng, OrderType, ServiceType } from '../global';
-import { CustomerCreate, LoyaltyType, NotificationArea, NotificationChannel } from './customer';
-import { RevenueCenterStatus } from './revenueCenter';
-export interface ConfigApp {
-    authUrl: string;
-    baseUrl: string;
-    brandId: string;
-    clientId: string;
-}
-export declare type ConfigPageType = 'DESIGN_SYSTEM' | 'GUEST' | 'ORDER_TYPE' | 'CATERING' | 'LOCATIONS' | 'LOCATION' | 'MENU' | 'MENU_CATEGORY' | 'MENU_FEATURED' | 'MENU_FAVORITES' | 'MENU_RECENTS' | 'ITEM' | 'UPSELL' | 'CHECKOUT_GUEST' | 'CHECKOUT_SIGNIN' | 'CHECKOUT_SIGNUP' | 'CHECKOUT' | 'CONFIRMATION' | 'GROUP_GUEST' | 'GROUP_REVIEW' | 'SIGN_UP' | 'VERIFY' | 'RESET_SEND' | 'RESET_PASSWORD' | 'ACCOUNT' | 'ACCOUNT_PROFILE' | 'ACCOUNT_COMMS' | 'ACCOUNT_DIETARY' | 'ACCOUNT_ORDERS' | 'ACCOUNT_ORDER' | 'ACCOUNT_LOYALTY' | 'ACCOUNT_REWARDS' | 'ACCOUNT_PAYMENTS' | 'ACCOUNT_GIFTCARDS' | 'ACCOUNT_ADDRESSES' | 'ACCOUNT_HOUSE' | 'ACCOUNT_DELETE' | 'DEALS' | 'GIFT_CARDS' | 'DONATIONS' | 'RATING' | 'QUOTE' | 'CURBSIDE' | 'POINTS_SHOP' | 'TERMS' | 'PRIVACY' | 'ACCESSIBILITY' | 'REFUNDS' | 'NOT_FOUND' | 'ERROR';
-export interface ConfigPageElement {
-    props: Record<string, string>;
-    text: Record<string, string> | null;
-}
-export interface ConfigPage {
-    desktop: Record<string, ConfigPageElement>;
-    mobile: Record<string, ConfigPageElement>;
-}
-export declare type ConfigPages = Record<ConfigPageType, ConfigPage>;
-export interface ConfigAcceptMarketing {
-    default: boolean;
-    description: string;
-    title: string;
-}
-export interface ConfigNotificationPreference {
-    notification_area: NotificationArea;
-    notification_channel: NotificationChannel;
-}
-export declare type ConfigNotificationPreferences = ConfigNotificationPreference[];
-export interface ConfigFulfillmentField {
-    label: string;
-    name: string;
-    placeholder: string;
-}
-export interface ConfigFulfillment {
-    button: string;
-    description: string;
-    title: string;
-    fields: 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>;
-    reward: any;
-    points?: number;
-    threshold?: string;
-}
-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 declare type OrderRatingTypes = OrderType[];
-export declare type CHECKOUT_CREDIT_CARD_METHOD = 'REQUIRE_ADD' | 'REQUIRE_CARD_NUMBER' | 'ALLOW_BOTH';
-export interface ConfigBrand {
-    app_requires_recaptcha: boolean;
-    accepts_marketing: ConfigAcceptMarketing | null;
-    applePayMerchantId: string;
-    appleTouchIcon: string;
-    brandId: number;
-    catering_id: number;
-    checkout_credit_card_method: CHECKOUT_CREDIT_CARD_METHOD;
-    como_business_id: number | null;
-    description: string;
-    display_credit_card_logos: 'ON' | 'OFF';
-    displayed_credit_card_logos: string[];
-    display_payment_methods: boolean;
-    display_view_only_menu: boolean;
-    display_reward_code: boolean;
-    display_top_qr_scan_button: boolean;
-    email: string;
-    favicon: string;
-    fulfillment: ConfigFulfillment;
-    gatewayId: string;
-    googlePayMerchantId: string;
-    gtmContainerId: string;
-    gtmContainer2Id: string;
-    has_allergens: boolean;
-    has_app: boolean;
-    has_deals: boolean;
-    has_donations: boolean;
-    has_ext_curbside: boolean;
-    has_favorites: boolean;
-    has_gift_cards: boolean;
-    has_house_accounts: boolean;
-    has_levelup: boolean;
-    has_loyalty: boolean;
-    has_points_shop: boolean;
-    has_pos: boolean;
-    has_promo_codes: boolean;
-    has_rewards: boolean;
-    has_sms: boolean;
-    has_thanx: boolean;
-    has_valutec: boolean;
-    hide_logo: boolean;
-    logo: string;
-    logoLight: string;
-    loyalty: ConfigLoyalty;
-    min_mobile_app_version: string;
-    notification_preferences: ConfigNotificationPreferences;
-    olo_id: number;
-    openGraphImage: string | null;
-    order_notifications: ConfigOrderNotifications | null;
-    order_rating_types: OrderRatingTypes;
-    origin: string;
-    pilot_slug: string | null;
-    privacy_url: string | null;
-    require_address: boolean;
-    require_cardholder_name: boolean;
-    sign_up_message: string | null;
-    terms_url: string | null;
-    timezone: TimezonePython;
-    title: string;
-    tpls: 'COMO' | 'THANX' | 'PUNCHH' | 'SPARKFLY' | null;
-    url: string;
-    use_enterprise_recaptcha: boolean;
-    view_suspended_item: 'HIDE' | 'SHOW_DATE' | 'SHOW_DATETIME';
-}
-export interface ConfigContentField {
-    title: string;
-    subtitle: string;
-    empty?: string;
-}
-export declare type ConfigOrderTypes = 'CATERING' | 'DELIVERY' | 'DONATIONS' | 'GIFT_CARDS' | 'GROUP' | 'MERCH' | 'OUTPOST' | 'PICKUP' | 'WALKIN';
-export declare type GuestSection = 'ANNOUNCEMENTS' | 'HERO' | 'CONTENT' | 'DEALS' | 'LOYALTY';
-export declare type GuestSections = GuestSection[];
-export declare type AccountSection = 'ANNOUNCEMENTS' | 'HERO' | 'CONTENT' | 'LOYALTY' | 'REWARDS' | 'DEALS' | 'ORDERS' | 'GROUP_ORDERS';
-export declare type AccountSections = AccountSection[];
-export declare type BottomTabsSection = 'ACCOUNT' | 'DEALS' | 'HOME' | 'LOYALTY' | 'LOCATIONS' | 'MENU' | 'MORE' | 'NEWS' | 'ORDERS' | 'POINTS_SHOP' | 'REWARDS' | 'SCAN';
-export declare type BottomTabsSections = BottomTabsSection[];
-export interface BottomTabsSectionContent {
-    title: string;
-}
-export interface BottomTabsTitles {
-    [key: string]: BottomTabsSectionContent;
-}
-export interface BottomTabsDisplayed {
-    displayed: BottomTabsSections;
-}
-export declare type MenuSection = 'FEATURED' | 'FAVORITES' | 'RECENTS';
-export declare type MenuSections = MenuSection[];
-export interface ConfigUpsell {
-    cart: ConfigContentField & {
-        decline: string;
-        show: boolean;
-    };
-    checkout: ConfigContentField & {
-        decline: string;
-        proceed: string;
-        show: boolean;
-    };
-    item: ConfigContentField & {
-        decline: string;
-        show: boolean;
-    };
-}
-export interface ConfirmationSection {
-    message: string;
-}
-export interface ConfirmationSections {
-    dineIn: ConfirmationSection;
-    takeOut: ConfirmationSection;
-    pickup: ConfirmationSection;
-    curbside: ConfirmationSection;
-    delivery: ConfirmationSection;
-    catering: ConfirmationSection;
-    outpost: ConfirmationSection;
-}
-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: AccountSections;
-        displayedMobile: AccountSections;
-        favorites: ConfigContentField;
-        giftCards: ConfigContentField;
-        greeting: string;
-        groupOrders: ConfigContentField;
-        houseAccounts: ConfigContentField;
-        levelup: ConfigContentField;
-        loyalty: {
-            signUp: string;
-            title: string;
-            subtitle: string;
-            skip: string;
-        };
-        mobile: string;
-        pointsShop: ConfigContentField;
-        profile: ConfigContentField;
-        punctuation: string;
-        recentItems: ConfigContentField;
-        recentOrders: ConfigContentField;
-        rewards: ConfigContentField;
-        showFirstName: boolean;
-        showHero: boolean;
-        subtitle: string;
-        thanx: ConfigContentField;
-        title: string;
-        videoUrl: string;
-        videoUrlMobile: string;
-        useAppHomeHeading: boolean;
-    };
-    accountHistory: ConfigContentField;
-    accountSettings: ConfigContentField;
-    addresses: ConfigContentField;
-    allergens: ConfigContentField;
-    bottomTabs: BottomTabsDisplayed & BottomTabsTitles;
-    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;
-        gratuity: ConfigContentField;
-        guest: ConfigContentField;
-        pointsShop: 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;
-        sections: ConfirmationSections;
-    };
-    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: GuestSections;
-        displayedMobile: GuestSections;
-        mobile: string;
-        showGuest: boolean;
-        subtitle: string;
-        title: string;
-        videoUrl: string;
-        videoUrlMobile: string;
-        useAppHomeHeading: boolean;
-    };
-    home: ConfigContentField & {
-        background: string;
-        content: string;
-        mobile: string;
-        orderTypes: {
-            [keys in ConfigOrderTypes]: ConfigContentField;
-        };
-        showHero: boolean;
-    };
-    houseAccounts: ConfigContentField;
-    menu: {
-        background: string;
-        cartErrors: ConfigContentField;
-        displayLogo: boolean;
-        displayLogoApp: boolean;
-        displayLogoMobile: boolean;
-        displayed: MenuSections;
-        displayedMobile: MenuSections;
-        loadingMessage: string;
-        mobile: string;
-        soldOutMessage: string;
-        videoUrl: string;
-        videoUrlMobile: string;
-    };
-    menuSite: ConfigContentField & {
-        background: string;
-        content: string;
-        mobile: string;
-    };
-    news: {
-        background: string;
-        content: string;
-        mobile: string;
-        subtitle: string;
-        title: string;
-    };
-    notFound: ConfigContentField & {
-        back: string;
-        background: string;
-    };
-    orderType: ConfigContentField & {
-        background: string;
-        content: string;
-        mobile: string;
-        orderTypes: {
-            [keys in ConfigOrderTypes]: ConfigContentField;
-        };
-        showDescriptions: boolean;
-        showDescriptionsMobile: boolean;
-        showHero: boolean;
-        videoUrl: string;
-        videoUrlMobile: string;
-    };
-    orders: ConfigContentField;
-    pointsShop: ConfigContentField;
-    profile: ConfigContentField & {
-        displayed: (keyof CustomerCreate)[];
-    };
-    refunds: ConfigContentField & {
-        background: string;
-        content: Array<string>;
-    };
-    resetPassword: ConfigContentField & {
-        back: string;
-        background: string;
-    };
-    revenueCenters: ConfigContentField & {
-        background: string;
-        display_full_address: boolean;
-        display_location_images_mobile: boolean;
-        mobile: string;
-        statusMessages: {
-            [keys in RevenueCenterStatus]: ConfigContentField;
-        };
-    };
-    rewards: ConfigContentField & {
-        loyalty: ConfigContentField;
-        rewards: ConfigContentField;
-    };
-    signUp: ConfigContentField & {
-        back: string;
-        background: string;
-        displayed: (keyof CustomerCreate)[];
-        display_marketing_message: boolean;
-        email: string;
-        marketing: string;
-        push: string;
-        sms: string;
-    };
-    unsubscribe: ConfigContentField & {
-        button: string;
-    };
-    upsells: ConfigUpsell;
-}
-export interface ConfigSettingsCheckoutOrderType {
-    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 declare type ConfigDisplaySettingMenuType = 'DEFAULT' | 'SCROLLABLE';
-export declare type ConfigDisplaySettingMenuTypeApp = ConfigDisplaySettingMenuType | 'TABS';
-export declare type ConfigDisplaySettingBuilderType = 'PAGE' | 'PAGE_FULL' | 'DEFAULT' | 'SIDEBAR';
-export declare type ConfigDisplaySettingGroupsTypeApp = 'SCROLLABLE' | 'TABS';
-export declare type ConfigDisplaySettingModifiersType = 'DEFAULT' | 'CARDS';
-export declare type ConfigDisplaySettingDescriptionType = 'SHOW' | 'SHORT' | 'HIDE';
-export declare type AllergesTagFilter = 'NONE' | 'SHOW_HIDE' | 'HIGHLIGHT';
-export interface ConfigDisplaySetting {
-    allergens: boolean;
-    allergensFilter: AllergesTagFilter;
-    builderImages: boolean;
-    builderType: ConfigDisplaySettingBuilderType;
-    calories: boolean;
-    categoryType: string;
-    categoryTypeMobile: string;
-    groupsTypeApp: ConfigDisplaySettingGroupsTypeApp;
-    hasCustomize: boolean;
-    itemsTwoPerRowMobile: boolean;
-    madeFor: boolean;
-    menuHero: boolean;
-    menuHeroChild: boolean;
-    menuHeroChildMobile: boolean;
-    menuHeroMobile: boolean;
-    menuImages: boolean;
-    menuItemDescription: ConfigDisplaySettingDescriptionType;
-    menuItemDescriptionMobile: ConfigDisplaySettingDescriptionType;
-    menuType: ConfigDisplaySettingMenuType;
-    menuTypeApp: ConfigDisplaySettingMenuTypeApp;
-    menuTypeMobile: ConfigDisplaySettingMenuType;
-    modifierDescription: boolean;
-    modifierGroupDescription: boolean;
-    modifierImage: boolean;
-    modifiersType: ConfigDisplaySettingModifiersType;
-    notes: boolean;
-    quickAdd: boolean;
-    quickAddMobile: boolean;
-    skipToCustomize: boolean;
-    skipToCustomizeMobile: boolean;
-    storePhone: boolean;
-    tags: boolean;
-    tagsFilter: AllergesTagFilter;
-}
-export interface GoogleMapsAnchor {
-    x: number;
-    y: number;
-}
-export interface GoogleMapsIconSize {
-    height: number;
-    width: number;
-}
-export interface GoogleMapsIcon {
-    anchor: GoogleMapsAnchor | null;
-    size: GoogleMapsIconSize;
-    url: string;
-}
-export interface GoogleMapsIcons {
-    location: GoogleMapsIcon;
-    locationSelected: GoogleMapsIcon;
-    user: GoogleMapsIcon;
-}
-export interface GoogleMapsStyles {
-    backgroundColor: string;
-    featureColor: string;
-    labelColor: string;
-    roadColor: string;
-    waterColor: string;
-}
-export interface GoogleMaps {
-    apiKey: string;
-    apiKeyApp: string;
-    defaultCenter: LatLng;
-    icons: GoogleMapsIcons;
-    styles: GoogleMapsStyles;
-    zoom: number;
-}
-export interface ConfigRecaptcha {
-    addCard: boolean;
-    donations: boolean;
-    giftCards: boolean;
-    login: boolean;
-    signup: boolean;
-    androidKey: string;
-    iOsKey: string;
-}
-export declare type ConfigSettingsAutoselect = {
-    [keys in OrderType]: {
-        [keys in ServiceType]?: boolean;
-    };
-};
-export declare type ConfigSettingsCheckout = {
-    orderTypes: {
-        [keys in OrderType]: ConfigSettingsCheckoutOrderType;
-    };
-};
-export declare type ConfigSettingsDisplaySettings = {
-    [keys in OrderType]: ConfigDisplaySetting;
-};
-export declare type ConfigSettingsLocationName = {
-    [keys in ServiceType | 'OUTPOST']: string[];
-};
-export interface ConfigKount {
-    clientId: string;
-    enabled: boolean;
-    environment: 'TEST' | 'PROD';
-}
-export interface ConfigSettings {
-    accountSections: string[];
-    autoSelect: ConfigSettingsAutoselect;
-    checkout: ConfigSettingsCheckout;
-    displaySettings: ConfigSettingsDisplaySettings;
-    googleMaps: GoogleMaps;
-    locationName: ConfigSettingsLocationName;
-    maxDistance: number;
-    orderTypes: ConfigOrderTypes[];
-    recaptcha: ConfigRecaptcha;
-    kount?: ConfigKount;
-}
-export interface ConfigAccordion {
-    hasCals: boolean;
-    hasCustomize: boolean;
-    hasMadeFor: boolean;
-    hasNotes: boolean;
-}

package/dist/cjs/types/api/config.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -1,42 +0,0 @@
-import { CardType, CardTypeName } from '../global';
-export interface CreditCard {
-    card_type: CardType;
-    card_type_name: CardTypeName;
-    customer_card_id: number;
-    has_profile?: boolean;
-    is_default: boolean;
-    last4: string;
-    masked: string;
-}
-export declare type CreditCards = CreditCard[];
-export interface CreditCardSaved {
-    customer_card_id: number;
-}
-export interface CreditCardData {
-    cardholder_name?: string;
-    acct: string;
-    addr?: string;
-    exp: string;
-    cvv: string;
-    zip: string;
-    save?: boolean;
-    is_default?: boolean;
-    token?: string;
-    kount_device_session_id?: string;
-}
-export interface CreditCardUpdate {
-    is_default: boolean;
-}
-export interface CreditCardErrors extends Record<string, string | undefined> {
-    cardholder_name?: string;
-    addr?: string;
-    acct?: string;
-    exp?: string;
-    cvv?: string;
-    zip?: string;
-}
-export interface CreditCardValidate {
-    card: CreditCardData;
-    cardType: CardType;
-    errors: CreditCardErrors | null;
-}

package/dist/cjs/types/api/creditCards.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/types/api/customer/account.d.ts

@@ -1,26 +0,0 @@
-export interface Auth {
-    access_token: string;
-    customer_id?: number;
-    expires_in: number;
-    message?: string;
-    refresh_token: string;
-    token_type: string;
-}
-export interface LoginData {
-    email: string;
-    password: string;
-    recaptcha_token?: string;
-}
-export interface ResetPasswordData {
-    new_password: string;
-    password: string;
-    confirm: string;
-}
-export interface CustomerSignIn {
-    email?: string;
-    one_time_passcode?: string;
-    password?: string;
-    phone?: string;
-    token?: string;
-    recaptcha_token?: string;
-}

package/dist/cjs/types/api/customer/account.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/types/api/customer/addresses.d.ts

@@ -1,24 +0,0 @@
-import { ISOStringOffset } from '../../datetimes';
-export interface Address {
-    city: string;
-    company?: string;
-    contact?: string;
-    country?: string;
-    created_at?: ISOStringOffset;
-    customer_address_id?: number;
-    customer_id?: number;
-    description?: string;
-    formatted_address?: string;
-    is_active?: boolean;
-    is_default?: boolean;
-    last_used_at?: ISOStringOffset;
-    lat: number;
-    lng: number;
-    notes?: string;
-    phone?: string;
-    postal_code: string;
-    state: string;
-    street: string;
-    unit?: string;
-}
-export declare type Addresses = Address[];

package/dist/cjs/types/api/customer/addresses.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/types/api/customer/allergens.d.ts

@@ -1,5 +0,0 @@
-export interface CustomerAllergen {
-    allergen_id: number;
-    name?: string;
-}
-export declare type CustomerAllergens = CustomerAllergen[];

package/dist/cjs/types/api/customer/allergens.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/types/api/customer/communicationPreferences.d.ts

@@ -1,12 +0,0 @@
-import { ISOStringOffset } from '../../datetimes';
-export declare type NotificationChannel = 'EMAIL' | 'SMS' | 'PUSH' | 'ALL';
-export declare type NotificationArea = 'ORDER' | 'RATING' | 'MARKETING';
-export interface CustomerNotificationPref {
-    created_at: ISOStringOffset;
-    customer_notification_preference_id: number;
-    notification_area: NotificationArea;
-    notification_channel: NotificationChannel;
-}
-export declare type CustomerNotificationPrefs = CustomerNotificationPref[];
-export declare type CustomerNotificationPrefCreate = Omit<CustomerNotificationPref, 'created_at' | 'customer_notification_preference_id'>;
-export declare type CustomerNotificationPrefsCreate = CustomerNotificationPrefCreate[];