@open-tender/types 0.4.158 → 0.4.159

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

@@ -0,0 +1,70 @@
+import { DateString, ISOStringOffset } from '../datetimes';
+import { Money, NegativeMoney } from '../global';
+export declare type PunchAuthType = 'PIN' | 'CARD';
+export declare type PunchType = 'PUNCH_IN' | 'PUNCH_OUT' | 'BREAK_IN' | 'BREAK_OUT';
+export interface Punch {
+    employee_id: number;
+    department_id: number;
+    punch_type: PunchType;
+    tips: Money;
+    created_at?: ISOStringOffset;
+    created_dt?: string;
+}
+export interface Department {
+    code: number;
+    date_effective: string;
+    id: number;
+    name: string;
+    other_pay_rate: string;
+    overtime_pay_rate: string;
+    pay_rate: string;
+}
+export interface PunchProcessed extends Punch {
+    department?: Department;
+    date: Date;
+}
+export declare type PunchesProcessed = PunchProcessed[];
+export interface Shift {
+    department: string;
+    punchIn?: PunchProcessed;
+    punchOut?: PunchProcessed;
+    breaks: PunchesProcessed;
+    breakOut: PunchProcessed | null;
+    breakSeconds: number;
+    netSeconds: number;
+}
+export declare type Shifts = Shift[];
+export declare type Role = 'MANAGER' | 'CASHIER' | 'EMPLOYEE';
+export interface Employee {
+    employee_id: number;
+    timeclock_id: string;
+    code: string;
+    first_name: string;
+    last_name: string;
+    role: Role;
+    version: number;
+    departments: Array<Department>;
+    punches?: Array<Punch>;
+}
+export interface Cashier extends Employee {
+    businessDate: DateString;
+}
+export declare type Employees = Array<Employee>;
+export declare type CashEventType = 'FLOAT' | 'PAID_IN' | 'PAID_OUT' | 'DECLARED';
+export interface CashEvent {
+    employee_id: number;
+    cash_event_type: CashEventType;
+    amount: Money | NegativeMoney;
+    select_option_id?: number;
+    notes?: string;
+}
+export interface CashSummary {
+    float: Money | NegativeMoney;
+    declared: Money | NegativeMoney;
+    paid_in: Money | NegativeMoney;
+    paid_out: Money | NegativeMoney;
+    sale: Money | NegativeMoney;
+    refund: Money | NegativeMoney;
+    calculated: Money | NegativeMoney;
+    over_short: Money | NegativeMoney;
+}

package/dist/esm/types/api/employee.js

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,9 @@
+import { ISOStringOffset } from '../datetimes';
+export interface ErrorAlert {
+    alert_id: number;
+    topic: string;
+    content: string;
+    created_at: ISOStringOffset;
+    silenced_until: ISOStringOffset | null;
+}
+export declare type ErrorAlerts = ErrorAlert[];

package/dist/esm/types/api/errorAlerts.js

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,13 @@
+import { ISOStringOffset } from '../datetimes';
+import { SimpleCartItem } from './checkout';
+import { OrderItem } from './order';
+export interface Favorite {
+    added_at: ISOStringOffset;
+    cart: SimpleCartItem;
+    favorite_id: number;
+    item: OrderItem;
+    name: string | null;
+    updated_at: ISOStringOffset;
+}
+export declare type Favorites = Favorite[];
+export declare type FavoritesLookup = Record<string, number>;

package/dist/esm/types/api/favorite.js

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,11 @@
+import { Money } from '../global';
+export interface GiftCardCredit {
+    code: string;
+    amount: Money;
+    employee_id: number;
+}
+export interface GiftCardBalance {
+    gift_card_id: number;
+    card_number: string;
+    balance: Money;
+}

package/dist/esm/types/api/giftCard.js

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,36 @@
+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 './devices';
+export * from './discounts';
+export * from './donations';
+export * from './employee';
+export * from './errorAlerts';
+export * from './favorite';
+export * from './giftCard';
+export * from './itemTypes';
+export * from './kds';
+export * from './kiosk';
+export * from './menu';
+export * from './menuPages';
+export * from './messages';
+export * from './notifications';
+export * from './offlineAuths';
+export * from './order';
+export * from './orders';
+export * from './refund';
+export * from './revenueCenter';
+export * from './selectOptions';
+export * from './settings';
+export * from './store';
+export * from './surcharges';
+export * from './tags';
+export * from './taxes';
+export * from './theme';

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

@@ -0,0 +1,36 @@
+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 './devices';
+export * from './discounts';
+export * from './donations';
+export * from './employee';
+export * from './errorAlerts';
+export * from './favorite';
+export * from './giftCard';
+export * from './itemTypes';
+export * from './kds';
+export * from './kiosk';
+export * from './menu';
+export * from './menuPages';
+export * from './messages';
+export * from './notifications';
+export * from './offlineAuths';
+export * from './order';
+export * from './orders';
+export * from './refund';
+export * from './revenueCenter';
+export * from './selectOptions';
+export * from './settings';
+export * from './store';
+export * from './surcharges';
+export * from './tags';
+export * from './taxes';
+export * from './theme';

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

@@ -0,0 +1,15 @@
+import { PrepStatus } from './kds';
+export interface ItemType {
+    default_prep_status: PrepStatus;
+    display_order: number;
+    is_default: boolean;
+    is_grouped: boolean;
+    is_hidden_assembly: boolean;
+    is_hidden_qa: boolean;
+    item_type_id: number;
+    items: number[];
+    name: string;
+    prep_time: number;
+    print_on_completed: boolean;
+}
+export declare type ItemTypes = ItemType[];

package/dist/esm/types/api/itemTypes.js

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,100 @@
+import { PrepStations } from './devices';
+import { OrderCart, OrderItem, Orders } from './order';
+export declare type DeviceFontSize = 'xsmall' | 'small' | 'medium' | 'large';
+export declare type DeviceColorScheme = 'dark' | 'light';
+export declare type KdsView = 'column' | 'grid' | 'list' | 'tiles';
+export declare type KdsPrepType = 'ASSEMBLY' | 'EXPO';
+export declare type KdsOrderType = 'CURRENT' | 'FUTURE' | 'COMPLETED' | 'INCOMPLETE';
+export declare type KdsAssemblyOptions = 'AUTO_PRINT' | 'PRINT_DONE' | 'MARK_DONE' | 'PRINT_AND_DONE' | null;
+export declare type PrepStatus = 'TODO' | 'IN_PROGRESS' | 'DONE' | 'COMPLETED' | 'FULFILLED';
+export declare type PrepStatusMap = {
+    [Property in PrepStatus]: PrepStatus;
+};
+export declare type TicketStatus = 'TODO' | 'IN_PROGRESS' | 'DONE' | 'COMPLETED';
+export interface KdsTerminalSettings {
+    name: string;
+    ipAddress: string;
+    prepStations: PrepStations;
+    defaultView: KdsView;
+    columns: number;
+    boxes: number;
+    cardWidth: number;
+    fontSize: DeviceFontSize;
+    colorScheme: DeviceColorScheme;
+}
+export interface KdsStationOrderTypeCount {
+    orders: number;
+    tickets: number;
+}
+export interface KdsStationCount {
+    CURRENT: KdsStationOrderTypeCount;
+    FUTURE: KdsStationOrderTypeCount;
+}
+export declare type KdsStationCounts = Record<string, KdsStationCount>;
+export interface OrdersAndStationCounts {
+    orders: Orders;
+    stationCounts: KdsStationCounts | null;
+}
+export interface OrderCounts {
+    current: Record<string, number> | null;
+    future: Record<string, number> | null;
+    qa: Record<string, number> | null;
+}
+export interface OrdersAndCounts {
+    orders: Orders;
+    counts: OrderCounts;
+}
+export interface OrderUpdate {
+    expected_at?: string;
+    prep_status?: PrepStatus;
+}
+export interface OrderBucket {
+    orders: Orders;
+    start: Date;
+    end: Date;
+}
+export declare type OrderBuckets = Array<OrderBucket>;
+export interface OrderPrepTimes {
+    delayed: number;
+    requested: Date;
+    requestedTime: string;
+    expected: Date;
+    expectedDate: string;
+    expectedTime: string;
+    readyBy: Date;
+    readyTime: string;
+    dateStr: string;
+    status: string;
+}
+export interface TicketUpdate {
+    ticket_status: TicketStatus;
+}
+export interface TicketsUpdate {
+    ticket_status?: TicketStatus;
+    ticket_nos?: number[];
+}
+export declare type TicketStatusUpdate = 'done' | 'completed' | 'reset';
+export interface Ticket {
+    item_nos: number[];
+    item_type_id: number;
+    item_type_name: string;
+    ticket_no: number;
+    ticket_status: TicketStatus;
+    items: OrderCart;
+    is_default: boolean;
+    is_grouped: boolean;
+    is_hidden_assembly: boolean;
+    is_hidden_qa: boolean;
+    print_on_completed: boolean;
+}
+export declare type TicketGroup = Ticket[];
+export declare type TicketGroups = TicketGroup[];
+export interface OrderKdsStatus {
+    NOT_DONE: boolean;
+    DONE: boolean;
+    COMPLETED: boolean;
+}
+export interface OrderItemCount {
+    item: OrderItem;
+    count: number;
+}

package/dist/esm/types/api/kds.js

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,37 @@
+import { AppTheme } from './theme';
+export interface Dimensions {
+    width: number;
+    height: number;
+}
+export declare type KioskContent = Record<string, unknown>;
+export declare type KioskStyles = Record<string, Record<string, string | number>>;
+export interface KioskBrand {
+    brand: string;
+    email: string;
+    logo: string;
+    logoLight: string;
+    webAppUrl: string;
+    gtmContainer2Id?: string;
+}
+export interface KioskDisplaySettings {
+    hasCustomize: boolean;
+    showAllergens: boolean;
+    showCals: boolean;
+    showDesc: boolean;
+    showMadeFor: boolean;
+    showNotes: boolean;
+    showQuickAdd: boolean;
+    showTags: boolean;
+    skipToCustomize: boolean;
+}
+export interface KioskSettings {
+    ratio: number;
+    displaySettings: KioskDisplaySettings;
+}
+export interface KioskConfig {
+    brand: KioskBrand;
+    content: KioskContent;
+    settings: KioskSettings;
+    theme: AppTheme;
+}
+export declare type KioskSignInType = 'PHONE' | 'QR_CODE' | 'CREDIT_CARD' | null;

package/dist/esm/types/api/kiosk.js

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,188 @@
+import { RequestedAt } from '../datetimes';
+import { Decimal, Money, ServiceType, TaxTypeInt, Temperature } from '../global';
+import { Cart, CartErrors } from './cart';
+import { SimpleCartItem } from './checkout';
+import { MenuSection } from './config';
+export interface NutritionalInfo {
+    calories: number;
+    cholesterol: number;
+    dietary_fiber: number;
+    protein: number;
+    saturated_fat: number;
+    serving_size: Decimal;
+    sodium: number;
+    sugars: number;
+    total_carbs: number;
+    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;
+    serving_size: string | null;
+}
+export declare type MenuItemSizes = Array<MenuItemSize>;
+export interface MenuItemTax {
+    amount: Money;
+    name: string;
+    tax_id: number;
+    tax_type: TaxTypeInt;
+}
+export declare type MenuItemTaxes = Array<MenuItemTax>;
+export interface MenuItemGroup {
+    app_image_url: string | null;
+    description: string | null;
+    id: number;
+    included_options: number;
+    is_pizza: boolean;
+    is_size: boolean;
+    large_image_url: string | null;
+    max_options: number;
+    menu_position: number;
+    min_options: number;
+    name: string;
+    option_items: OptionItem[];
+    pos_display_color: string | null;
+    short_name: string;
+    slug: string;
+    small_image_url: string | null;
+    item_shape: PizzaShape | null;
+    exclude_from_builder: boolean;
+}
+export declare type MenuItemGroups = MenuItemGroup[];
+export interface MenuItemFavorite {
+    item: SimpleCartItem;
+}
+export interface MenuItemAllergen {
+    allergen_id: number;
+    app_image_url: string | null;
+    description: string | null;
+    large_image_url: string | null;
+    name: string;
+    small_image_url: string | null;
+}
+export declare type MenuItemAllergens = MenuItemAllergen[];
+export interface MenuItemTag {
+    app_image_url: string | null;
+    description: string | null;
+    large_image_url: string | null;
+    name: string;
+    small_image_url: string | null;
+    tag_id: number;
+}
+export declare type MenuItemTags = MenuItemTag[];
+export declare type PizzaShape = 'CIRCULAR' | 'RECTANGULAR';
+export interface MenuItem {
+    allergens: string | null;
+    allergens_list?: MenuItemAllergens;
+    app_image_url: string | null;
+    calories: number | null;
+    description: string | null;
+    dimensions: number[] | null;
+    favorite?: MenuItemFavorite;
+    featured_position: number | null;
+    id: number;
+    increment: number;
+    ingredients: string | null;
+    is_alcohol: boolean;
+    item_id: number;
+    large_image_url: string | null;
+    max_quantity: number;
+    menu_position: number;
+    min_quantity: number;
+    name: string;
+    nutritional_info: NutritionalInfo | null;
+    option_groups: MenuItemGroups;
+    plu: string | null;
+    points: number | null;
+    pos_display_color: string | null;
+    pos_ext_id: string | null;
+    price: Money | string;
+    sales_tax_override: Decimal | null;
+    short_description: string | null;
+    short_name: string;
+    shorthand: string | null;
+    similar_items: number[];
+    slug: string;
+    small_image_url: string | null;
+    suspend_until: number | null;
+    tags: string | null;
+    tags_list?: MenuItemTags;
+    taxes: MenuItemTaxes;
+    temperature: Temperature;
+    upsell_items: number[];
+    item_shape: PizzaShape | null;
+    exclude_from_builder: boolean;
+    list_name: string | null;
+    list_id: string | null;
+    index?: number;
+}
+export interface OptionItem extends MenuItem {
+    opt_is_default: boolean;
+}
+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;
+    children: MenuCategories;
+    description: string | null;
+    id: number;
+    items: MenuItems;
+    large_image_url: string | null;
+    menu_name: string;
+    menu_name_id: number;
+    menu_position: number;
+    name: string;
+    pos: MenuCategoryPos | null;
+    revenue_center_id: number | null;
+    short_name: string;
+    slug: string;
+    small_image_url: string | null;
+}
+export declare type MenuCategories = MenuCategory[];
+export interface MenuRevenueCenter {
+    app_image_url: string;
+    description: string;
+    display_order: number;
+    hours_desc: string;
+    large_image_url: string;
+    name: string;
+    revenue_center_id: number;
+    short_name: string;
+    small_image_url: string;
+}
+export declare type MenuRevenueCenters = MenuRevenueCenter[];
+export declare type SoldOut = number[];
+export interface Menu {
+    menu: MenuCategories;
+    revenue_centers: MenuRevenueCenters | null;
+    sold_out_items: SoldOut;
+}
+export interface MenuVars {
+    revenueCenterId: number;
+    serviceType: ServiceType;
+    requestedAt: RequestedAt;
+}
+export interface MenuCartErrors {
+    newCart: Cart;
+    errors: CartErrors | null;
+}
+export declare type MenuDisplayedSections = Record<MenuSection, MenuItems>;

package/dist/esm/types/api/menu.js

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,21 @@
+import { FullOrderType } from '../global';
+export interface MenuPageSection {
+    name: string;
+    pos_page_id: number;
+    pos_section_id: number;
+    position: number;
+}
+export declare type MenuPageSections = MenuPageSection[];
+export interface MenuPage {
+    name: string;
+    order_type: FullOrderType;
+    pos_page_id: number;
+    position: number;
+    sections: MenuPageSections;
+}
+export declare type MenuPages = Array<MenuPage>;
+export interface MenuColor {
+    id: number;
+    color: string;
+}
+export declare type MenuColors = MenuColor[];

package/dist/esm/types/api/menuPages.js

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,5 @@
+export interface Message {
+    message: string;
+    id: string;
+}
+export declare type Messages = Message[];

package/dist/esm/types/api/messages.js

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,5 @@
+export interface Notification {
+    message: string;
+    id: string;
+}
+export declare type Notifications = Notification[];

package/dist/esm/types/api/notifications.js

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,12 @@
+export interface OfflineAuth {
+    order_uuid: string;
+    created_at: string;
+    amount: string;
+    nmi_offline_id: number;
+}
+export declare type OfflineAuths = OfflineAuth[];
+export interface OfflineAuthsResult {
+    paid: number;
+    void: number;
+    error: number;
+}

package/dist/esm/types/api/offlineAuths.js

@@ -0,0 +1 @@
+export {};