@open-tender/types 0.0.136 → 0.1.0

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

@@ -1,8 +1,5 @@
 import { RequestedAt } from '../datetimes';
 import { Decimal, Money, ServiceType, TaxTypeInt, Temperature } from '../global';
-import { CartItemGroups } from './cart';
-import { Favorite } from './favorite';
-import { OrderItemImages } from './order';
 export interface NutritionalInfo {
     calories: number;
     cholesterol: number;
@@ -16,6 +13,18 @@ export interface NutritionalInfo {
     total_fat: number;
     trans_fat: number;
 }
+export interface NutritionalInfoCalcs extends Record<string, number> {
+    calories: number;
+    cholesterol: number;
+    dietary_fiber: number;
+    protein: number;
+    saturated_fat: number;
+    sodium: number;
+    sugars: number;
+    total_carbs: number;
+    total_fat: number;
+    trans_fat: number;
+}
 export declare type NutritionalInfoWithEmpty = NutritionalInfo | Record<string, never> | null;
 export interface MenuItemSize {
     name: string;
@@ -34,120 +43,66 @@ export interface MenuItemGroup {
     description: string | null;
     id: number;
     included_options: number;
+    is_pizza: boolean;
     is_size: boolean;
-    is_upsell: boolean;
     large_image_url: string | null;
     max_options: number;
     menu_position: number;
     min_options: number;
     name: string;
-    option_items: Array<OptionItem>;
+    option_items: OptionItem[];
+    pos_display_color: string | null;
     short_name: string;
     slug: string;
     small_image_url: string | null;
 }
-export declare type MenuItemGroups = Array<MenuItemGroup>;
-export interface Item {
-    allergen_classes: string;
-    allergens: string | string[];
+export declare type MenuItemGroups = MenuItemGroup[];
+export interface MenuItem {
+    allergens: string | null;
     app_image_url: string | null;
-    color?: string | null;
-    delivery_days: number | null;
+    calories: number | null;
     description: string | null;
-    end_date: number | null;
-    end_date_str: string | null;
-    height: string | null;
-    id?: number;
+    dimensions: number[] | null;
+    featured_position: number | null;
+    id: number;
     increment: number;
     ingredients: string | null;
     is_alcohol: boolean;
     item_id: number;
     large_image_url: string | null;
-    length: string | null;
     max_quantity: number;
     menu_position: number;
     min_quantity: number;
-    name?: string;
+    name: string;
     nutritional_info: NutritionalInfo | null;
+    option_groups: MenuItemGroups;
     plu: string | null;
     points: number | null;
+    pos_display_color: string | null;
     price: Money | string;
     sales_tax_override: Decimal | null;
-    service_restrictions: number[];
-    short_description?: string | null;
+    short_description: string | null;
     short_name: string;
     shorthand: string | null;
+    similar_items: number[];
     slug: string;
     small_image_url: string | null;
-    start_date: number | null;
-    start_date_str: string | null;
-    tag_classes: string;
-    tags: string | string[];
+    suspend_until: number | null;
+    tags: string | null;
     taxes: MenuItemTaxes;
     temperature: Temperature;
-    weight: string | null;
-    width: string | null;
-}
-export interface OptionItem extends Item {
-    group_id: number;
-    opt_is_default: 1 | 0;
-    serving_size: string | null;
+    upsell_items: number[];
 }
-export interface MenuItem extends Item {
-    calories: number | null;
-    category_id: number;
-    category_name: string;
-    display_options: number;
-    has_upsell: boolean;
-    option_groups: MenuItemGroups;
-    similar_items: number[] | null;
-    sizes: MenuItemSizes | null;
-    upsell_items: number[] | null;
-    use_options_wizard: 1 | 0;
-    favorite?: Partial<Favorite>;
-    upsellItems: number[];
-    index?: number;
-    id?: number;
-    name?: string;
-    shortName?: string;
-    cart_guest_id?: number | null;
-    category: string | null;
-    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: string;
-    increment: number;
-    max: number;
-    min: number;
-    points: any;
-    similarItems: number[];
-    totalPrice: number;
-    totalPoints: number | null;
-    totalCals: number | null;
-    item_no?: number;
-    nutritional_info: NutritionalInfo | null;
-    price_total?: number;
-    favorite_id?: number;
-    images?: OrderItemImages;
-    short_description?: string | null;
-    shortDescription?: string;
-    made_for?: string;
-    signature?: string;
-    isDefault?: boolean | number;
-    isSoldOut?: boolean;
+export interface OptionItem extends MenuItem {
+    opt_is_default: boolean;
 }
-export declare type MenuItems = Array<MenuItem>;
+export declare type MenuItems = MenuItem[];
 export declare type MenuCategoryAppearance = 'small' | 'medium' | 'large';
+export interface MenuCategoryPos {
+    section_id: number | null;
+    color: string | null;
+    order: number | null;
+}
 export interface MenuCategory {
     app_image_url: string | null;
     appearance: MenuCategoryAppearance;
@@ -156,17 +111,17 @@ export interface MenuCategory {
     id: number;
     items: MenuItems;
     large_image_url: string | null;
+    menu_name: string;
+    menu_name_id: number;
+    menu_position: number;
     name: string;
-    pos_display_color: string;
-    pos_display_order: number;
-    pos_section_id: number;
-    position: number;
+    pos: MenuCategoryPos | null;
     revenue_center_id: number | null;
     short_name: string;
     slug: string;
     small_image_url: string | null;
 }
-export declare type MenuCategories = Array<MenuCategory>;
+export declare type MenuCategories = MenuCategory[];
 export interface Menu {
     menu: MenuCategories;
     service_type: ServiceType;

package/dist/esm/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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@open-tender/types",
-  "version": "0.0.136",
+  "version": "0.1.0",
   "description": "A library of types for use with Open Tender applications that utilize our cloud-based Order API.",
   "main": "./dist/cjs/index.js",
   "module": "./dist/esm/index.js",