@open-tender/types 0.0.135 → 0.1.0

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

@@ -1,8 +1,10 @@
 import { DateString, ISOString, ISOStringOffset, RequestedAt, TimeHuman, TimezonePython } from '../datetimes';
-import { CardType, ChannelType, Decimal, Money, NegativeMoney, OrderStatus, OrderType, ReceiptType, ServiceType, SurchargeType, Temperature, TenderStatus, TenderType, Weekday } from '../global';
-import { Address, Customer, CustomerAllergens, CustomerGiftCards, CustomerRevenueCenterHours, CustomerRevenueCenterSettings, DeliveryZone, ExcludedTimes, FirstTime, HolidayItem, LoyaltyPoints, RevenueCenterGroupOrdering, RevenueCenterOrderTimes, ValidTimes } from './customer';
+import { CardType, ChannelType, Decimal, Money, NegativeMoney, OrderStatus, OrderType, ReceiptType, ServiceType, SurchargeType, TenderStatus, TenderType, Weekday } from '../global';
+import { Address, Customer, CustomerGiftCards, CustomerRevenueCenterHours, CustomerRevenueCenterSettings, DeliveryZone, ExcludedTimes, FirstTime, HolidayItem, LoyaltyPoints, RevenueCenterGroupOrdering, RevenueCenterOrderTimes, ValidTimes } from './customer';
 import { PrepStatus, TicketStatus } from './kds';
 import { ConfigFulfillmentField } from './config';
+import { NutritionalInfo } from './menu';
+import { Cart } from './cart';
 export interface OrderChannel {
     ext_id?: string | null;
     ext_name?: string | null;
@@ -118,10 +120,10 @@ export interface OrderItemDiscount {
 }
 export declare type OrderItemDiscounts = Array<OrderItemDiscount>;
 export interface OrderItemImage {
-    type: 'LARGE_IMAGE' | 'SMALL_IMAGE' | 'APP_IMAGE' | 'IMAGE' | 'SECONDARY_IMAGE' | 'FEATURED_IMAGE';
+    type: 'LARGE_IMAGE' | 'SMALL_IMAGE' | 'APP_IMAGE';
     url: string | null;
 }
-export declare type OrderItemImages = Array<OrderItemImage>;
+export declare type OrderItemImages = OrderItemImage[];
 export interface OrderItemTax {
     tax_id: number;
     name: string;
@@ -129,54 +131,74 @@ export interface OrderItemTax {
     amount_total: NegativeMoney;
 }
 export declare type OrderItemTaxes = Array<OrderItemTax>;
-export declare type OrderGroupOptions = Array<OrderItem>;
-export interface OrderGroup {
-    id?: number;
-    inc?: number;
-    is_size?: boolean;
-    max?: number;
-    min?: number;
-    name: string;
-    options: OrderGroupOptions;
-    short_name?: string;
-}
-export declare type OrderGroups = Array<OrderGroup>;
 export interface OrderItem {
-    cart_guest_id?: number;
-    allergens?: CustomerAllergens | string[];
-    description?: string | null;
-    discount?: Money;
-    discount_total?: Money;
-    discounts?: OrderItemDiscounts;
-    groups?: OrderGroups;
+    allergens: string[];
+    description: string | null;
+    groups: OrderItemGroups;
     id: number;
     images: OrderItemImages;
     ingredients: string | null;
-    item_no?: number;
-    line_no?: number;
-    made_for?: string;
+    made_for?: string | null;
     name: string;
-    notes?: string;
-    points?: any;
-    points_total?: number;
-    price?: Money;
-    price_quantity?: number;
+    notes?: string | null;
+    nutritional_info: NutritionalInfo | null;
+    points?: number | null;
+    price: Money;
     price_total: Money;
-    price_unit?: Money;
-    quantity?: number;
-    quantity_total?: number;
-    sales_tax_override?: string | null;
-    short_description: string;
+    quantity: number;
+    short_description: string | null;
+    tags: string[];
+    temperature: 'Hot' | 'Cold';
+}
+export declare type OrderItemOptions = OrderItem[];
+export interface OrderItemGroup {
+    id: number;
+    name: string;
+    options: OrderItemOptions;
+    short_name: string;
+}
+export declare type OrderItemGroups = OrderItemGroup[];
+export declare type OrderCart = OrderItem[];
+export interface PosOrderItemGroup {
+    id: number;
+    name: string;
+    options: PosOrderItemOptions;
     short_name: string;
-    tax?: Money;
-    tax_total?: Money;
-    taxes?: OrderItemTaxes;
-    temperature: Temperature;
-    cals?: number;
-    madeFor?: string;
-    customer_id?: number;
-}
-export declare type OrderCart = Array<OrderItem>;
+}
+export declare type PosOrderItemGroups = PosOrderItemGroup[];
+export interface PosOrderItem extends Omit<OrderItem, 'groups'> {
+    item_no: number;
+    line_no: number;
+    groups: PosOrderItemGroups;
+}
+export declare type PosOrderItemOptions = PosOrderItem[];
+export declare type PosOrderCart = PosOrderItem[];
+export interface DisplayItem {
+    allergens: string[];
+    cals: number | null;
+    description: string | null;
+    groups: DisplayItemGroups;
+    imageUrl: string | null;
+    id: number;
+    madeFor?: string | null;
+    name: string;
+    notes?: string | null;
+    nutritionalInfo: NutritionalInfo | null;
+    quantity: number;
+    price: Money;
+    shortDescription: string | null;
+    signature?: string;
+    tags: string[];
+    totalPrice: Money;
+}
+export declare type DisplayItems = DisplayItem[];
+export interface DisplayItemGroup {
+    id: number;
+    name: string;
+    options: DisplayItems;
+    short_name: string;
+}
+export declare type DisplayItemGroups = DisplayItemGroup[];
 export interface ModifiersMetadataOption {
     id: number;
     line_no: number;
@@ -410,7 +432,10 @@ export interface Order {
     revenueCenter?: OrderRevenueCenter;
     serviceType?: ServiceType;
 }
-export declare type Orders = Array<Order>;
+export declare type Orders = Order[];
+export interface OrderPos extends Omit<Order, 'cart'> {
+    cart: PosOrderCart;
+}
 export interface OrderKds extends Omit<Order, 'fire_at' | 'tickets' | 'expected_at'> {
     expected_at: ISOStringOffset;
     fire_at: ISOStringOffset;
@@ -490,6 +515,7 @@ export interface Ticket {
     is_hidden_qa: boolean;
     print_on_completed: boolean;
 }
+export declare type Tickets = Ticket[];
 export declare type TicketGroup = Ticket[];
 export declare type TicketGroups = TicketGroup[];
 export interface OrderKdsStatus {
@@ -506,7 +532,7 @@ export interface UnpreparedOrderData {
     revenueCenterId: number | null;
     serviceType: ServiceType | null;
     requestedAt: string | null;
-    cart: OrderCart | null;
+    cart: Cart | null;
     customer: Customer;
     address: Address | null;
     details: OrderDetails | null;

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

@@ -1,15 +1,16 @@
 import { AuthType } from '../global';
-export interface AnnouncementImage {
-    type: 'LARGE_IMAGE' | 'SMALL_IMAGE' | 'APP_IMAGE' | 'IMAGE' | 'SECONDARY_IMAGE' | 'FEATURED_IMAGE';
+export interface ContentImage {
+    type: 'SECONDARY_IMAGE' | 'FEATURED_IMAGE';
     url: string | null;
 }
+export declare type ContentImages = ContentImage[];
 export interface Announcement {
     announcement_id: number;
     display_order: number;
     hide_text: boolean;
     hide_text_mobile: boolean;
     horizontal: string;
-    images: Array<AnnouncementImage>;
+    images: ContentImages;
     overlay_color: string;
     overlay_opacity: number;
     show_overlay: boolean;

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

@@ -1,87 +1,63 @@
-import { Favorite } from './favorite';
 import { NutritionalInfo } from './menu';
-export interface GuestItem {
-    cart_guest_id?: number | null;
-    customer_id?: number | null;
-    made_for: string | null;
-    notes: string | null;
-}
 export interface CartItemOption {
-    id: number;
-    name: string;
-    shortName: string;
+    allergens: string[];
+    cals: number | null;
     description: string | null;
+    groups: CartItemGroups;
+    id: number;
     imageUrl: string | null;
-    allergens: string[];
-    tags: string[];
+    increment: number;
     ingredients: string | null;
+    isDefault: boolean;
+    isSoldOut: boolean;
+    max: number;
+    min: number;
+    name: string;
     nutritionalInfo: NutritionalInfo | null;
-    cals: number | null;
+    points: number | null;
     price: number;
-    price_total?: number;
     quantity: number;
-    isDefault?: boolean | number;
-    increment: number;
-    max: number;
-    min: number;
-    isSoldOut: boolean;
-    points: number;
-    totalPrice?: number;
-    totalPoints?: number | null;
-    totalCals?: number | null;
-    groups?: Array<Partial<CartItemGroup>>;
+    shortDescription: string | null;
+    shortName: string;
+    slug: string;
+    tags: string[];
+    totalCals: number | null;
+    totalPoints: number | null;
+    totalPrice: number | null;
+}
+export interface CartItemOptionWithIndex extends CartItemOption {
+    index: number;
+}
+export interface CartItem extends Omit<CartItemOption, 'isDefault'> {
+    cartGuestId: number | null;
+    customerId: number | null;
+    index?: number;
+    madeFor: string | null;
+    notes: string | null;
+    signature?: string;
+    similarItems: number[];
+    upsellItems: number[];
 }
-export declare type CartItemOptions = Array<Partial<CartItemOption>>;
+export declare type CartItemOptions = CartItemOption[];
 export interface CartItemGroup {
-    id: number;
-    name: string;
     description: string | null;
+    id: number;
     imageUrl: string | null;
     included: number;
+    isPizza: boolean;
+    isSize: boolean;
     max: number;
     min: number;
-    isSize: boolean;
+    name: string;
     options: CartItemOptions;
-    inc?: number;
-    is_size?: boolean;
-    short_name: string;
     quantity?: number;
-    isPizza?: boolean;
 }
-export declare type CartItemGroups = Array<Partial<CartItemGroup>>;
-export interface CartItem {
-    index?: number;
-    id: number;
-    name: string;
-    shortName: string;
-    cart_guest_id?: number | null;
-    category: string;
-    customer_id?: number | null;
-    description: string | null;
-    imageUrl: string | null;
-    slug: string;
-    allergens: string[];
-    tags: string[];
-    ingredients: string | null;
-    madeFor?: string | null;
-    notes?: string | null;
-    nutritionalInfo: NutritionalInfo | null;
-    cals: number | null;
-    groups: CartItemGroups;
-    quantity: number;
-    price: number;
-    increment: number;
-    max: number;
-    min: number;
-    points: number | null;
-    upsellItems: number[];
-    similarItems: number[];
-    totalPrice: number;
-    totalPoints: number | null;
-    totalCals: number | null;
-    favorite: Favorite;
-    isSoldOut?: boolean;
-    signature?: string;
-}
-export declare type Cart = Array<CartItem>;
+export declare type CartItemGroups = CartItemGroup[];
+export declare type Cart = CartItem[];
+export declare type CartLevels = number[][];
 export declare type CartCounts = Record<string, number>;
+export interface PosCartItem extends CartItem {
+    item_no: number;
+    line_no: number;
+}
+export declare type PosCart = PosCartItem[];

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

@@ -37,21 +37,30 @@ export interface CustomerCheckout {
 export interface SimpleCartOption {
     id: number;
     quantity: number;
+    groups: SimpleCartGroups;
 }
 export interface SimpleCartGroup {
     id: number;
-    options: Array<SimpleCartOption>;
+    options: SimpleCartOption[];
 }
+export declare type SimpleCartGroups = SimpleCartGroup[];
 export interface SimpleCartItem {
     id: number;
     quantity: number;
-    groups?: Array<SimpleCartGroup>;
+    groups: SimpleCartGroups;
     made_for?: string;
     notes?: string;
     cart_guest_id?: number;
     customer_id?: number;
 }
-export declare type SimpleCart = Array<SimpleCartItem>;
+export declare type SimpleCart = SimpleCartItem[];
+export interface SimpleCartLookupOption {
+    quantity: number;
+    groupsLookup: Record<string, SimpleCartLookupGroup> | null;
+}
+export interface SimpleCartLookupGroup {
+    options: Record<string, SimpleCartLookupOption>;
+}
 export interface OrderCreateDetails {
     eating_utensils?: boolean;
     serving_utensils?: boolean;

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

@@ -1,39 +1,36 @@
 import { ISOString } from '../../datetimes';
 import { ServiceType } from '../../global';
-import { RequestErrorAPI, RequestStatus } from '../../request';
-import { OrderItem, OrderRevenueCenter } from '../order';
+import { SimpleCart } from '../checkout';
 import { Address } from './addresses';
 export interface CartOwner {
     customer_id: number;
     first_name: string;
     last_name: string;
 }
+export interface GroupOrderGuest {
+    cart_guest_id: number;
+    cart_id: number;
+    first_name: string;
+    last_name: string;
+}
+export declare type GroupOrderGuests = GroupOrderGuest[];
 export interface GroupOrder {
-    order_id?: string | null;
-    address?: Address | null;
-    cart: Array<OrderItem>;
-    cartGuest?: any;
-    cartGuests?: any;
-    cart_guests: any;
+    address: Address | null;
+    cart: SimpleCart;
+    cart_guests?: GroupOrderGuests;
     cart_id: number;
-    cartOwner?: CartOwner;
-    customer?: CartOwner;
     closed: boolean;
-    cutoff_at: string;
-    error?: RequestErrorAPI;
+    customer?: CartOwner;
+    cutoff_at: string | null;
     guest_count: number;
-    guest_limit: number;
-    isCartOwner: boolean;
-    loading?: RequestStatus;
-    requested_at: ISOString;
-    revenue_center?: OrderRevenueCenter;
+    guest_limit: number | null;
+    requested_at: ISOString | 'asap';
     revenue_center_id: number;
     service_type: ServiceType;
-    spending_limit: string;
+    spending_limit: string | null;
     token: string;
-    spendingLimit: string;
 }
-export declare type GroupOrders = Array<GroupOrder>;
+export declare type GroupOrders = GroupOrder[];
 export interface GroupOrderTime {
     isAdjusted: boolean;
     firstIso: ISOString;

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

@@ -1,98 +1,12 @@
 import { ISOStringOffset } from '../datetimes';
-import { Decimal, Temperature } from '../global';
-import { NutritionalInfo } from './menu';
-export interface FavoriteCartOption {
-    id: number;
-    quantity: number;
-}
-export interface FavoriteCartGroup {
-    id: number;
-    options: Array<FavoriteCartOption>;
-}
-export interface FavoriteCartItem {
-    id: number;
-    made_for?: string;
-    notes?: string;
-    quantity?: string;
-}
-export declare type FavoriteCart = Array<FavoriteCartItem>;
-export interface FavoriteItemImage {
-    type: 'LARGE_IMAGE' | 'SMALL_IMAGE' | 'APP_IMAGE';
-    url: string | null;
-}
-export interface FavoriteItemNutritionalInfo {
-    calories: Decimal;
-    cholesterol: Decimal;
-    dietary_fiber: Decimal;
-    protein: Decimal;
-    saturated_fat: Decimal;
-    serving_size: Decimal;
-    sodium: Decimal;
-    sugars: Decimal;
-    total_carbs: Decimal;
-    total_fat: Decimal;
-    trans_fat: Decimal;
-}
-export interface FavoriteItemGroup {
-    id: number;
-    inc?: number;
-    is_size?: boolean;
-    max?: number;
-    min?: number;
-    name?: string;
-    options: Array<Partial<FavoriteItem>>;
-    short_name?: string;
-}
-export interface FavoriteItem {
-    allergens: Array<string>;
-    description: string;
-    groups?: Array<Partial<FavoriteItemGroup>>;
-    id: number;
-    images: Array<FavoriteItemImage>;
-    ingredients: string | null;
-    made_for?: string;
-    name: string;
-    notes?: string;
-    nutritional_info?: FavoriteItemNutritionalInfo | null;
-    points?: number | null;
-    quantity?: number;
-    short_description: string | null;
-    tags: Array<string>;
-    temperature: Temperature;
-    index?: number;
-    shortName?: string;
-    cart_guest_id?: number | null;
-    category: string | null;
-    customer_id?: number | null;
-    imageUrl: string | null;
-    slug: string;
-    madeFor?: string | null;
-    nutritionalInfo: NutritionalInfo | null;
-    cals: number | null;
-    price: number;
-    increment: number;
-    max: number;
-    min: number;
-    upsellItems: number[];
-    similarItems: number[];
-    totalPrice: number;
-    totalPoints: number | null;
-    totalCals: number | null;
-    item_no?: number;
-    price_total?: number;
-    favorite_id?: number;
-    shortDescription?: string;
-    signature?: string;
-    isDefault?: boolean | number;
-    isSoldOut?: boolean;
-    favorite?: Favorite;
-}
+import { SimpleCartItem } from './checkout';
+import { OrderItem } from './order';
 export interface Favorite {
     added_at: ISOStringOffset;
-    cart: FavoriteCart;
-    favorite_id?: number;
-    item: Partial<FavoriteItem>;
+    cart: SimpleCartItem;
+    favorite_id: number;
+    item: OrderItem;
     name: string | null;
     updated_at: ISOStringOffset;
 }
-export declare type Favorites = Array<Favorite>;
+export declare type Favorites = Favorite[];