@open-tender/types 0.0.5 → 0.0.7

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

@@ -0,0 +1,170 @@
+import { DateString, ISOString, Time24, TimeHuman, TimezonePython } from '../../datetimes';
+import { ChannelType, Money, ServiceType, Weekday } from '../../global';
+export interface RevenueCenterAddress {
+    city: string;
+    cross_streets: string;
+    lat: number;
+    lng: number;
+    phone: string;
+    postal_code: string;
+    state: string;
+    street: string;
+}
+export interface DeliveryZone {
+    coordinates: Array<Array<number>>;
+    description: string | null;
+    priority: number;
+}
+export interface FirstTime {
+    date: string;
+    has_asap: boolean;
+    minutes: number;
+    time: TimeHuman;
+    utc: ISOString;
+    wait_minutes: number | null;
+    weekday: Weekday;
+    interval?: number;
+}
+export interface RevenueCenterGroupOrdering {
+    guest_limit: number;
+    lead_time: number;
+    prep_time: number;
+}
+export interface Hours {
+    close: Time24 | null;
+    holiday: string | null;
+    open: Time24 | null;
+    weekday: Weekday;
+}
+export interface ValidTime {
+    is_orderable: boolean;
+    minutes: number;
+    time: string;
+}
+export declare type ValidTimes = Array<ValidTime>;
+export interface HolidayItem extends Hours {
+    valid_times: ValidTimes;
+}
+export declare type RevenueCenterImageType = 'APP_IMAGE' | 'SMALL_IMAGE' | 'LARGE_IMAGE';
+export interface RevenueCenterImage {
+    type: RevenueCenterImageType;
+    url: string;
+}
+export declare type ExcludedTimes = {
+    [key in ServiceType]: {
+        [key: DateString]: number[];
+    };
+};
+export interface OrderBy {
+    time: Time24;
+    weekday: Weekday;
+    date: Date | string;
+}
+export interface OrderTime {
+    date: DateString | Date;
+    end_time: Time24;
+    order_by: OrderBy;
+    start_time: Time24;
+    weekday: Weekday;
+    iso?: ISOString;
+}
+export declare type RevenueCenterOrderTimes = {
+    [key in ServiceType]: Array<OrderTime> | null;
+};
+export interface CustomerRevenueCenterSettings {
+    cutoff_time: string;
+    days_ahead: {
+        [key in ServiceType]?: number;
+    };
+    first_times: {
+        [key in ServiceType]?: FirstTime | null;
+    };
+    group_ordering: RevenueCenterGroupOrdering;
+    holidays: {
+        [key in ServiceType]?: HolidayItem | null;
+    };
+    lead_time_in_hours: number;
+    order_maximum: {
+        [key in ServiceType]: Money;
+    };
+    order_minimum: {
+        [key in ServiceType]: Money;
+    };
+    order_times: RevenueCenterOrderTimes;
+    tax_exempt_is_allowed: boolean;
+    time_ranges: {
+        [key in ServiceType]: number | null;
+    };
+    valid_times: {
+        [key in ServiceType]?: {
+            [key in Weekday]?: ValidTimes;
+        };
+    };
+    wait_times: {
+        [key in ServiceType]?: number;
+    };
+    excluded_times: ExcludedTimes | null;
+}
+export interface CustomerRevenueCenter {
+    address: RevenueCenterAddress;
+    cutoff_time: TimeHuman | null;
+    days_ahead: number;
+    delivery_url: string;
+    delivery_zone: DeliveryZone;
+    description: string | null;
+    directions_url: string;
+    excluded_times: ExcludedTimes | null;
+    first_times: {
+        [key in ServiceType]?: FirstTime | null;
+    };
+    group_ordering: RevenueCenterGroupOrdering;
+    has_curbside: boolean;
+    holidays: {
+        [key: DateString]: {
+            [key in ServiceType]?: HolidayItem | null;
+        };
+    };
+    hours: {
+        [key in ServiceType]?: Array<Hours>;
+    };
+    is_new: boolean;
+    is_outpost: boolean;
+    is_parent: boolean;
+    lead_time_in_hours: number | null;
+    menu_pdf_url: string | null;
+    name: string;
+    order_maximum: {
+        [key in ServiceType]: Money;
+    };
+    order_minimum: {
+        [key in ServiceType]: Money;
+    };
+    order_times: RevenueCenterOrderTimes;
+    revenue_center_id: number;
+    revenue_center_type: ChannelType;
+    service_types: Array<ServiceType>;
+    slug: string;
+    status: string;
+    tax_exempt_is_allowed: boolean;
+    time_ranges: {
+        [key in ServiceType]: number | null;
+    };
+    timezone?: TimezonePython;
+    user: any;
+    wait_times: {
+        [key in ServiceType]?: number;
+    };
+    valid_times: {
+        [key in ServiceType]?: {
+            [key in Weekday]?: ValidTimes;
+        };
+    };
+    settings?: CustomerRevenueCenterSettings;
+}
+export declare type CustomerRevenueCenters = Array<CustomerRevenueCenter>;
+export interface AvailableDates {
+    minDate: Date | null;
+    maxDate: Date | null;
+    excludeDates: Array<Date>;
+    filterDate: (date: Date) => boolean;
+}

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

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

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

@@ -0,0 +1,40 @@
+import { DiscountType, DisplayPage, OrderType, ServiceType } from '../../global';
+import { MenuItems } from '../menu';
+import { OrderItemImage } from '../order';
+export interface DayPart {
+    daypart_id: number;
+    end_time: string;
+    name: string;
+    order_type: OrderType;
+    start_time: string;
+}
+export interface RewardItems {
+    items: MenuItems;
+    quantity: number;
+}
+export interface Reward {
+    amount: string;
+    auth_type: DisplayPage;
+    dayparts: Array<DayPart>;
+    description: string;
+    discount_id: number;
+    discount_type: DiscountType;
+    discounted_items: RewardItems;
+    end_date: string;
+    images: OrderItemImage;
+    max_amount: string;
+    max_order_size: string;
+    max_redemptions: number;
+    max_redemptions_per: number;
+    min_amount: string;
+    min_order_size: string;
+    name: string;
+    order_type: OrderType;
+    per_order: number;
+    required_items: RewardItems;
+    service_type: ServiceType;
+    short_description: string;
+    start_date: string;
+    title: string;
+}
+export declare type Rewards = Array<Reward>;

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

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

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

@@ -0,0 +1,3 @@
+export interface DeviceRead {
+    data: string;
+}

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

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

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

@@ -0,0 +1,20 @@
+import { DiscountType, Money, ServiceType } from '../global';
+export interface Discount {
+    id: number;
+    name: string;
+    discount_type: DiscountType;
+    position: number;
+    amount: Money;
+    min_amount: Money;
+    max_amount: Money;
+    min_order_size: Money;
+    max_order_size: Money;
+    discounted_items: Array<number>;
+    discounted_quantity: number;
+    required_items: Array<number>;
+    required_quantity: number;
+    requires_approval: boolean;
+    service_type: ServiceType | null;
+    version: number;
+}
+export declare type Discounts = Array<Discount>;

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

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

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

@@ -0,0 +1,12 @@
+import { Money } from '../global';
+import { CreditCard } from './creditCards';
+export interface PurchaseDonationRequest {
+    amount: Money;
+    credit_card: CreditCard;
+    email: string;
+    token: string;
+}
+export interface Donation {
+    email: string;
+    amount: Money;
+}

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

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

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

@@ -0,0 +1,51 @@
+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?: string;
+    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 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 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 = Array<ErrorAlert>;

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

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

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

@@ -0,0 +1,70 @@
+import { ISOStringOffset } from '../datetimes';
+import { Decimal, Temperature } from '../global';
+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;
+    opttions: Array<FavoriteItem>;
+    short_name: string;
+}
+export interface FavoriteItem {
+    allergens: Array<string>;
+    description: string;
+    groups?: 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;
+}
+export interface Favorite {
+    added_at: ISOStringOffset;
+    cart: FavoriteCart;
+    favorite_id?: number;
+    item: FavoriteItem;
+    name: string | null;
+    updated_at: ISOStringOffset;
+}
+export declare type Favorites = Array<Favorite>;

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/guest.d.ts

@@ -0,0 +1,11 @@
+export interface Brand {
+    name: string;
+}
+export declare type Brands = Array<Brand>;
+export interface GuestData {
+    first_name: string;
+    email: string;
+    last_name: string;
+    phone: string;
+    password: string;
+}

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

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

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

@@ -0,0 +1,32 @@
+export * from './alerts';
+export * from './arrivals';
+export * from './cart';
+export * from './checkout';
+export * from './config';
+export * from './customer';
+export * from './device';
+export * from './discounts';
+export * from './employee';
+export * from './errorAlerts';
+export * from './favorite';
+export * from './giftCard';
+export * from './kds';
+export * from './menu';
+export * from './menuPages';
+export * from './messages';
+export * from './notifications';
+export * from './offlineAuths';
+export * from './order';
+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';

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

@@ -0,0 +1,32 @@
+export * from './alerts';
+export * from './arrivals';
+export * from './cart';
+export * from './checkout';
+export * from './config';
+export * from './customer';
+export * from './device';
+export * from './discounts';
+export * from './employee';
+export * from './errorAlerts';
+export * from './favorite';
+export * from './giftCard';
+export * from './kds';
+export * from './menu';
+export * from './menuPages';
+export * from './messages';
+export * from './notifications';
+export * from './offlineAuths';
+export * from './order';
+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';

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

@@ -0,0 +1,52 @@
+import { OrdersKds } from './order';
+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 declare type KdsView = 'column' | 'grid' | 'list' | 'tiles';
+export declare type KdsFontSize = 'xsmall' | 'small' | 'medium' | 'large';
+export declare type KdsColorScheme = 'dark' | 'light';
+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 interface PrepStation {
+    prep_station_id: number;
+    name: string;
+    item_type_ids: number[] | null;
+    prep_type: KdsPrepType;
+    assembly_options: KdsAssemblyOptions;
+    expo_done_only: boolean;
+    expo_print: boolean;
+    expo_reset: boolean;
+    expo_complete: boolean;
+    expo_complete_all: boolean;
+    show_modifiers: boolean;
+    show_groups: boolean;
+    show_counts: boolean;
+}
+export declare type PrepStations = PrepStation[];
+export interface KdsTerminal {
+    name: string;
+    ipAddress: string;
+    prepStations: PrepStations;
+    defaultView: KdsView;
+    columns: number;
+    boxes: number;
+    cardWidth: number;
+    fontSize: KdsFontSize;
+    colorScheme: KdsColorScheme;
+}
+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: OrdersKds;
+    stationCounts: KdsStationCounts | null;
+}

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

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