@open-tender/types 0.1.7 → 0.1.9

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

@@ -1,53 +1,7 @@
 import { TimezonePython } from '../datetimes';
-import { IpAddress, OrderType, ServiceType } from '../global';
-import { ButtonColor } from '../theme';
+import { OrderType, ServiceType } from '../global';
 import { LoyaltyType, NotificationChannel } from './customer';
-import { PrepStations, PrepStatus } from './kds';
-export interface Config {
-    backup_printer_ip_address: IpAddress | null;
-    backup_printer_use_beeper: boolean;
-    brand_id: number;
-    cardreader_id: string;
-    has_cardreader: boolean;
-    has_cardwriter: boolean;
-    has_cashdrawer: boolean;
-    has_pinpad: boolean;
-    has_qrcode: boolean;
-    has_timeclock: boolean;
-    ip_address: IpAddress;
-    name: string;
-    pos_server_id: number;
-    pos_terminal_id: number;
-    prep_stations?: PrepStations | null;
-    print_kds: boolean;
-    print_receipt: 'never' | 'always' | 'prompt';
-    printer: IpAddress;
-    printer_use_beeper: boolean;
-    scanner_id: string;
-    server: IpAddress;
-    terminal_type: 'POS_TERMINAL' | 'KDS_TERMINAL' | 'KIOSK';
-}
-export interface ItemType {
-    default_prep_status: PrepStatus;
-    is_default: boolean;
-    is_grouped: boolean;
-    is_hidden_assembly: boolean;
-    is_hidden_qa: boolean;
-    item_type_id: number;
-    items: number[];
-    name: string;
-    position: number;
-    prep_time: number;
-    print_on_completed: boolean;
-}
-export declare type ItemTypes = Array<ItemType>;
-export interface SelectOption {
-    name: string;
-    option_type: 'PAID_IN' | 'PAID_OUT';
-    position: number;
-    select_option_id: number;
-}
-export declare type SelectOptions = Array<SelectOption>;
+import { RevenueCenterStatus } from './revenueCenter';
 export interface ConfigApp {
     authUrl: string;
     baseUrl: string;
@@ -97,7 +51,7 @@ export interface ConfigOrderNotifications {
     title: string;
 }
 export interface ConfigBrand {
-    accepts_marketing: ConfigAcceptMarketing;
+    accepts_marketing: ConfigAcceptMarketing | null;
     applePayMerchantId: string;
     appleTouchIcon: string;
     brandId: number;
@@ -127,7 +81,7 @@ export interface ConfigBrand {
     loyalty: ConfigLoyalty;
     olo_id: number;
     openGraphImage: string | null;
-    order_notifications: ConfigOrderNotifications;
+    order_notifications: ConfigOrderNotifications | null;
     origin: string;
     timezone: TimezonePython;
     title: string;
@@ -139,7 +93,6 @@ export interface ConfigContentField {
     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;
@@ -461,7 +414,7 @@ export interface ConfigSettings {
         zoom: number;
     };
     locationName: {
-        [keys in ServiceType]?: Array<string>;
+        [keys in ServiceType | 'OUTPOST']: Array<string>;
     };
     maxDistance: number;
     orderTypes: Array<HomeOrderTypes>;
@@ -471,319 +424,3 @@ export interface ConfigSettings {
         giftCards: boolean;
     };
 }
-export 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;
-    fontMobile: 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 declare type ConfigThemeFontSizes = Record<string, string> & {
-    [keys in ConfigFontSizes]: string;
-};
-export interface ConfigFont {
-    color: string;
-    family: string;
-    fontMobile: string;
-    fontSmoothing: string;
-    letterSpacing: string;
-    lineHeight: number;
-    lineHeights: ConfigThemeFontSizes;
-    textTransform: string;
-    url: string;
-    weight: string;
-    fontSize?: 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 ConfigThemeFont {
-    body: ConfigFont;
-    headings: ConfigFont;
-    headline: ConfigFont;
-    lineHeights: ConfigThemeFontSizes;
-    preface: ConfigFont;
-    sizes: ConfigThemeFontSizes;
-    sizesMobile: ConfigThemeFontSizes;
-}
-export interface ConfigThemeInputLabel {
-    fontSize: string;
-    left: string;
-    lineHeight: string;
-    offset: string;
-    padding: string;
-    top: string;
-    fontSizeMobile: string;
-}
-export interface ConfigThemeInput {
-    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: ConfigThemeInputLabel;
-    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;
-}
-export interface ConfigThemeItem {
-    desktop: ConfigItem;
-    imageMaxHeight: string;
-    imageMinHeight: string;
-    imagePadding: string;
-    maxWidth: string;
-    mobile: ConfigItem;
-    padding: string;
-}
-export interface ConfigThemeLayout {
-    containerMaxWidth: string;
-    headerHeightApp: string;
-    headerHeightSite: string;
-    headerHeightSiteMobile: string;
-    margin: string;
-    marginMobile: string;
-    maxWidth: string;
-    navHeight: string;
-    navHeightApp: string;
-    navHeightMobile: string;
-    padding: string;
-    paddingMobile: string;
-}
-export interface ConfigCategoriesItem {
-    desktop: {
-        displayType: string;
-    };
-    mobile: {
-        displayType: string;
-    };
-}
-export interface ConfigThemeButtons {
-    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>;
-    };
-}
-export interface ConfigThemeCards {
-    default: Partial<ConfigCardColors>;
-    form: Partial<ConfigCardColors>;
-    menuItem: Partial<ConfigCardColors>;
-    modifier: Partial<ConfigCardColors>;
-}
-export interface ConfigThemeBorder {
-    color: string;
-    radius: string;
-    radiusSmall: string;
-    width: string;
-    widthApp: string;
-}
-export interface ConfigThemeCounts {
-    alerts: Partial<ConfigCountColors>;
-    quantity: Partial<ConfigCountColors>;
-}
-export interface ConfigThemeWelcome {
-    marginBottom: string;
-    marginTop: string;
-    subtitleLineHeight: string;
-    subtitleMarginTop: string;
-    subtitleSize: string;
-    textAlign: string;
-    titleLineHeight: string;
-    titleMarginLeft: string;
-    titleSize: string;
-    mobile?: ConfigThemeWelcome;
-}
-export interface ConfigThemeColors extends Record<string, string> {
-    alert: string;
-    allergens: string;
-    dark: string;
-    error: string;
-    highlight: string;
-    light: string;
-    primary: string;
-    secondary: string;
-    success: string;
-    tertiary: string;
-    toast: string;
-}
-export interface ConfigTheme {
-    alert: {
-        bgColor: string;
-        color: string;
-    };
-    bgColors: ConfigThemeColors;
-    boldWeight: string;
-    border: ConfigThemeBorder;
-    boxShadow: {
-        appBig: string;
-        appSmall: string;
-        inset: string;
-        outer: string;
-    };
-    breakpoints: {
-        laptop: string;
-        mobile: string;
-        narrow: string;
-        tablet: string;
-    };
-    buttons: ConfigThemeButtons;
-    cards: ConfigThemeCards;
-    colors: ConfigThemeColors;
-    counts: ConfigThemeCounts;
-    error: {
-        bgColor: string;
-        color: string;
-    };
-    favorite: {
-        iconSize: string;
-        size: string;
-    };
-    fonts: ConfigThemeFont;
-    header: {
-        primary: string;
-        stuck: string;
-    };
-    icons: {
-        strokeWidth: number;
-    };
-    inputs: ConfigThemeInput;
-    item: ConfigThemeItem;
-    layout: ConfigThemeLayout;
-    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: ConfigThemeWelcome;
-    categories: ConfigCategoriesItem;
-}

package/dist/esm/types/api/configPos.d.ts

@@ -0,0 +1,47 @@
+import { IpAddress } from '../global';
+import { PrepStations, PrepStatus } from './kds';
+export interface Config {
+    backup_printer_ip_address: IpAddress | null;
+    backup_printer_use_beeper: boolean;
+    brand_id: number;
+    cardreader_id: string;
+    has_cardreader: boolean;
+    has_cardwriter: boolean;
+    has_cashdrawer: boolean;
+    has_pinpad: boolean;
+    has_qrcode: boolean;
+    has_timeclock: boolean;
+    ip_address: IpAddress;
+    name: string;
+    pos_server_id: number;
+    pos_terminal_id: number;
+    prep_stations?: PrepStations | null;
+    print_kds: boolean;
+    print_receipt: 'never' | 'always' | 'prompt';
+    printer: IpAddress;
+    printer_use_beeper: boolean;
+    scanner_id: string;
+    server: IpAddress;
+    terminal_type: 'POS_TERMINAL' | 'KDS_TERMINAL' | 'KIOSK';
+}
+export interface ItemType {
+    default_prep_status: PrepStatus;
+    is_default: boolean;
+    is_grouped: boolean;
+    is_hidden_assembly: boolean;
+    is_hidden_qa: boolean;
+    item_type_id: number;
+    items: number[];
+    name: string;
+    position: number;
+    prep_time: number;
+    print_on_completed: boolean;
+}
+export declare type ItemTypes = Array<ItemType>;
+export interface SelectOption {
+    name: string;
+    option_type: 'PAID_IN' | 'PAID_OUT';
+    position: number;
+    select_option_id: number;
+}
+export declare type SelectOptions = Array<SelectOption>;

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

@@ -8,7 +8,10 @@ export interface CreditCard {
     last4: string;
     masked: string;
 }
-export declare type CreditCards = Array<CreditCard>;
+export declare type CreditCards = CreditCard[];
+export interface CreditCardSaved {
+    customer_card_id: number;
+}
 export interface CreditCardData {
     acct: string;
     exp: string;
@@ -18,7 +21,8 @@ export interface CreditCardData {
     is_default?: boolean;
     token?: string;
 }
-export interface ValidatedCreditCard {
+export interface CreditCardValidate {
     card: CreditCardData;
+    cardType: CardType;
     errors: Partial<CreditCardData> | null;
 }

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

@@ -2,7 +2,7 @@ import { ISOStringOffset } from '../../datetimes';
 export declare type NotificationChannel = 'EMAIL' | 'SMS' | 'PUSH' | 'ALL';
 export declare type NotificationArea = 'ORDER' | 'RATING' | 'MARKETING';
 export interface CustomerNotificationPref {
-    craeted_at: ISOStringOffset;
+    created_at: ISOStringOffset;
     customer_notification_preference_id: number;
     notification_area: NotificationArea;
     notification_channel: NotificationChannel;

package/dist/esm/types/api/customer/customer.d.ts

@@ -1,6 +1,7 @@
 import { DateString } from '../../datetimes';
+import { Gender, OrderNotifications } from '../../global';
 import { Allergens } from '../allergens';
-import { CreditCard } from '../creditCards';
+import { CreditCards } from '../creditCards';
 import { Favorites } from '../favorite';
 import { CustomerNotificationPrefs } from './communicationPreferences';
 import { CustomerGiftCard, CustomerGiftCards } from './giftCards';
@@ -12,18 +13,17 @@ export interface Customer {
     customer_id?: number;
     email?: string;
     first_name?: string;
-    gender?: 'MALE' | 'FEMALE' | 'DECLINED' | null;
+    gender?: Gender;
     is_guest?: boolean;
     is_notification_set?: boolean;
     is_verified?: boolean;
     last_name?: string;
-    order_notifications?: 'NEW' | 'EMAIL' | 'SMS' | 'ALL' | 'NONE';
+    order_notifications?: OrderNotifications;
     phone?: string | null;
     password?: string;
-    credit_cards?: Array<Partial<CreditCard>>;
+    credit_cards?: CreditCards;
     gift_cards?: Array<Partial<CustomerGiftCard>>;
     house_accounts?: HouseAccounts;
-    levelup?: any;
 }
 export interface CustomerWithRelated extends Customer {
     allergens?: Allergens;

package/dist/esm/types/api/customer/giftCards.d.ts

@@ -1,5 +1,6 @@
 import { DateString, ISOStringOffset } from '../../datetimes';
 import { Money } from '../../global';
+import { CreditCardData, CreditCardSaved } from '../creditCards';
 export interface CustomerGiftCard {
     balance: Money;
     card_number: string;
@@ -11,14 +12,22 @@ export interface CustomerGiftCard {
     amount?: number;
     customer_card_id?: string | number;
 }
-export declare type CustomerGiftCards = Array<CustomerGiftCard>;
-export interface PurchasedGiftCard {
+export declare type CustomerGiftCards = CustomerGiftCard[];
+export interface GiftCardPurchased {
     email: string;
     balance: string;
     card_number: string;
 }
-export interface PurchaseGiftCardData {
+export interface GiftCardPurchaseData {
     amount: string;
     quantity: number;
     email: string;
 }
+export interface GiftCardsPurchase {
+    credit_card: CreditCardData | CreditCardSaved;
+    email: string;
+    gift_cards: GiftCardPurchaseData[];
+    name: string;
+    url: string;
+    token?: string;
+}

package/dist/esm/types/api/customer/index.d.ts

@@ -8,6 +8,5 @@ export * from './groupOrders';
 export * from './allergens';
 export * from './houseAccounts';
 export * from './rewards';
-export * from './revenueCenters';
 export * from './qrcode';
 export * from './thanx';

package/dist/esm/types/api/customer/index.js

@@ -8,6 +8,5 @@ export * from './groupOrders';
 export * from './allergens';
 export * from './houseAccounts';
 export * from './rewards';
-export * from './revenueCenters';
 export * from './qrcode';
 export * from './thanx';

package/dist/esm/types/api/customer/rewards.d.ts

@@ -1,6 +1,5 @@
-import { DiscountAuthType, DiscountType, OrderType, ServiceType } from '../../global';
+import { DiscountAuthType, DiscountType, Images, OrderType, ServiceType } from '../../global';
 import { MenuItems } from '../menu';
-import { OrderItemImages } from '../order';
 export interface DayPart {
     daypart_id: number;
     end_time: string;
@@ -21,7 +20,7 @@ export interface Reward {
     discount_type: DiscountType;
     discounted_items: RewardItems;
     end_date: string;
-    images: OrderItemImages;
+    images: Images;
     max_amount: string;
     max_order_size: string;
     max_redemptions: number;

package/dist/esm/types/api/deals.d.ts

@@ -1,7 +1,6 @@
-import { DiscountAuthType, DiscountType, Money, OrderType, ServiceType } from '../global';
+import { DiscountAuthType, DiscountType, Images, Money, OrderType, ServiceType } from '../global';
 import { DayPart } from './customer';
 import { DiscountedItems } from './menu';
-import { OrderItemImage } from './order';
 import { RevenueCenter } from './revenueCenter';
 export interface Deal {
     amount: Money;
@@ -12,7 +11,7 @@ export interface Deal {
     discount_type: DiscountType;
     discounted_items: DiscountedItems;
     end_date: string;
-    images: Array<OrderItemImage>;
+    images: Images;
     max_amount: string;
     max_order_size: string;
     max_redemptions: number;

package/dist/esm/types/api/donations.d.ts

@@ -1,8 +1,8 @@
 import { Money } from '../global';
-import { CreditCard } from './creditCards';
-export interface PurchaseDonationRequest {
+import { CreditCardData, CreditCardSaved } from './creditCards';
+export interface DonationPurchase {
     amount: Money;
-    credit_card: CreditCard;
+    credit_card: CreditCardData | CreditCardSaved;
     email: string;
     token?: string;
 }

package/dist/esm/types/api/index.d.ts

@@ -1,15 +1,22 @@
 export * from './alerts';
+export * from './allergens';
+export * from './announcements';
 export * from './arrivals';
 export * from './cart';
 export * from './checkout';
+export * from './completedOrders';
 export * from './config';
+export * from './creditCards';
 export * from './customer';
+export * from './deals';
 export * from './device';
 export * from './discounts';
+export * from './donations';
 export * from './employee';
 export * from './errorAlerts';
 export * from './favorite';
 export * from './giftCard';
+export * from './guest';
 export * from './kds';
 export * from './menu';
 export * from './menuPages';
@@ -17,19 +24,12 @@ export * from './messages';
 export * from './notifications';
 export * from './offlineAuths';
 export * from './order';
+export * from './orders';
+export * from './pos';
 export * from './refund';
 export * from './revenueCenter';
 export * from './settings';
 export * from './store';
 export * from './surcharges';
 export * from './taxes';
-export * from './donations';
-export * from './guest';
-export * from './completedOrders';
-export * from './orders';
-export * from './allergens';
-export * from './creditCards';
-export * from './announcements';
-export * from './deals';
-export * from './allergens';
-export * from './config';
+export * from './theme';