@open-tender/types 0.1.4 → 0.1.6

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

@@ -1,136 +1,14 @@
-import { DateString, ISOString, ISOStringOffset, RequestedAt, TimeHuman, TimezonePython } from '../datetimes';
-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 { ISOStringOffset, RequestedAt, TimeHuman, TimezonePython } from '../datetimes';
+import { CardType, CardTypeName, DiscountAuthType, DiscountType, Money, NegativeMoney, OrderStatus, OrderType, ServiceType, TenderType } from '../global';
+import { CreditCard } from './creditCards';
+import { Address } from './customer';
+import { PrepStatus } from './kds';
 import { NutritionalInfo } from './menu';
-import { Cart } from './cart';
-export interface OrderChannel {
-    ext_id?: string | null;
-    ext_name?: string | null;
-    type: ChannelType;
-}
-export interface OrderDetails {
-    cart_id: number | null;
-    eating_utensils: boolean;
-    notes: string | null;
-    notes_internal: string | null;
-    person_count: number | null;
-    serving_utensils: boolean;
-    tax_exempt_id: string | null;
-    device_type: string;
-    is_tax_exempt?: boolean;
-}
-export interface OrderDiscount {
-    discount_id?: number;
-    amount: Money;
-    description?: string | null;
-    ext_id?: string | null;
-    id: number;
-    name: string;
-    is_optional?: boolean;
-    is_promo_code: boolean;
-    discount_type: 1 | 2 | 3 | 4;
-}
-export declare type OrderDiscounts = Array<OrderDiscount>;
-export interface OrderFulfillment {
-    title?: string;
-    description?: string;
-    fields?: Array<ConfigFulfillmentField>;
-    acknowledged: boolean;
-    arrival_info: string | null;
-    has_arrived: boolean;
-    vehicle_color: string | null;
-    vehicle_id: string | null;
-    vehicle_type: string | null;
-}
-export interface OrderRevenueCenterAddress {
-    city: string;
-    cross_streets: string;
-    lat: number | null;
-    lng: number | null;
-    phone: string | null;
-    postal_code: string;
-    state: string;
-    street: string;
-}
-export interface OrderRevenueCenter {
-    address?: OrderRevenueCenterAddress;
-    is_outpost: boolean;
-    name: string;
-    revenue_center_id: number;
-    revenue_center_type?: string;
-    timezone?: TimezonePython;
-    distance?: number;
-    settings?: CustomerRevenueCenterSettings;
-    group_ordering?: RevenueCenterGroupOrdering;
-    wait_times?: {
-        [key in ServiceType]?: number;
-    };
-    order_maximum?: {
-        [key in ServiceType]: Money;
-    };
-    order_minimum?: {
-        [key in ServiceType]: Money;
-    };
-    first_times?: {
-        [key in ServiceType]?: FirstTime | null;
-    };
-    order_times?: RevenueCenterOrderTimes;
-    cutoff_time: TimeHuman | null;
-    days_ahead: number;
-    delivery_url: string;
-    delivery_zone: DeliveryZone;
-    description: string | null;
-    directions_url: string;
-    excluded_times: ExcludedTimes | null;
-    has_curbside: boolean;
-    holidays: {
-        [key: DateString]: {
-            [key in ServiceType]?: HolidayItem | null;
-        };
-    };
-    hours: CustomerRevenueCenterHours;
-    is_new: boolean;
-    is_parent: boolean;
-    lead_time_in_hours: number | null;
-    menu_pdf_url: string | null;
-    service_types: Array<ServiceType>;
-    slug: string;
-    status: string;
-    tax_exempt_is_allowed: boolean;
-    time_ranges: {
-        [key in ServiceType]: number | null;
-    };
-    user: any;
-    valid_times: {
-        [key in ServiceType]?: {
-            [key in Weekday]?: ValidTimes;
-        };
-    };
-    inZone?: boolean;
-    priority?: number;
-    images?: OrderItemImages;
-    has_order_fulfillment?: boolean;
-}
-export interface OrderItemDiscount {
-    discount_id: number;
-    amount: NegativeMoney;
-    amount_total: NegativeMoney;
-}
-export declare type OrderItemDiscounts = Array<OrderItemDiscount>;
 export interface OrderItemImage {
     type: 'LARGE_IMAGE' | 'SMALL_IMAGE' | 'APP_IMAGE';
     url: string | null;
 }
 export declare type OrderItemImages = OrderItemImage[];
-export interface OrderItemTax {
-    tax_id: number;
-    name: string;
-    amount: NegativeMoney;
-    amount_total: NegativeMoney;
-}
-export declare type OrderItemTaxes = Array<OrderItemTax>;
 export interface OrderItem {
     allergens: string[];
     description: string | null;
@@ -159,78 +37,129 @@ export interface OrderItemGroup {
 }
 export declare type OrderItemGroups = OrderItemGroup[];
 export declare type OrderCart = OrderItem[];
-export interface PosOrderItemGroup {
-    id: number;
-    name: string;
-    options: PosOrderItemOptions;
-    short_name: string;
+export declare type OrderNotifications = 'ALL' | 'EMAIL' | 'NEW' | 'NONE' | 'SMS';
+export interface OrderCustomerCreditCard {
+    card_type: CardType;
+    card_type_name: CardTypeName;
+    customer_card_id: number;
+    is_default: boolean;
+    last4: string;
+    masked: string;
 }
-export declare type PosOrderItemGroups = PosOrderItemGroup[];
-export interface PosOrderItem extends Omit<OrderItem, 'groups'> {
-    item_no: number;
-    line_no: number;
-    groups: PosOrderItemGroups;
+export declare type OrderCustomerCreditCards = OrderCustomerCreditCard[];
+export interface OrderCustomerGiftCard {
+    balance: Money;
+    card_number: string;
+    expiration: ISOStringOffset | null;
+    orders: number;
+    updated_at: ISOStringOffset;
 }
-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 OrderCustomerGiftCards = OrderCustomerGiftCard[];
+export interface OrderCustomerSso {
+    connected: boolean;
+    service: string;
 }
-export declare type DisplayItems = DisplayItem[];
-export interface DisplayItemGroup {
-    id: number;
-    name: string;
-    options: DisplayItems;
-    short_name: string;
+export interface OrderCustomer {
+    accepts_marketing: boolean;
+    company: string | null;
+    credit_cards?: OrderCustomerCreditCards;
+    customer_id: number;
+    email: string;
+    first_name: string;
+    gift_cards?: OrderCustomerGiftCards;
+    is_guest: boolean;
+    is_verified: boolean;
+    last_name: string;
+    order_notifications: OrderNotifications;
+    phone: string;
+    sso?: OrderCustomerSso;
+}
+export interface OrderDineInGuest {
+    company: string | null;
+    email: string | null;
+    first_name: string;
+    is_guest: boolean;
+    last_name: string;
+    phone: string | null;
 }
-export declare type DisplayItemGroups = DisplayItemGroup[];
-export interface ModifiersMetadataOption {
-    id: number;
-    line_no: number;
-    name: string;
-    price: Money;
-    price_total: Money;
-    quantity: number;
-    quantity_total: number;
-    short_name: string;
+export declare const isOrderCustomer: (customer: OrderCustomer | OrderDineInGuest) => customer is OrderCustomer;
+export interface OrderDelivery {
+    delivery_id: string;
+    dispatched: boolean;
+    service: string;
+    tracking_url: string;
 }
-export interface ModifiersMetadataGroup {
+export interface OrderDetails {
+    cart_id: number | null;
+    eating_utensils: boolean;
+    notes: string | null;
+    notes_internal: string | null;
+    person_count: number | null;
+    serving_utensils: boolean;
+    tax_exempt_id: string | null;
+}
+export interface OrderDiscount {
+    amount: NegativeMoney;
+    auth_type: DiscountAuthType;
+    discount_type: DiscountType;
+    ext_id?: string | null;
     id: number;
+    is_deal: boolean;
+    is_loyalty: boolean;
+    is_optional: boolean;
+    is_promo_code: boolean;
+    is_reward: boolean;
     name: string;
-    options: Array<ModifiersMetadataOption>;
-    short_name: string;
+    per_order: number | null;
+    title: string | null;
 }
-export interface ModifiersMetadataItem {
-    groups: Array<ModifiersMetadataGroup>;
+export declare type OrderDiscounts = OrderDiscount[];
+export interface OrderFulfillment {
+    arrival_info: string | null;
+    has_arrived: boolean;
+    vehicle_color: string | null;
+    vehicle_id: string | null;
+    vehicle_type: string | null;
+}
+export interface OrderGiftCard {
+    amount: Money;
+    card_number: string;
+    employee_id?: number;
     id: number;
-    item_no: number;
-    line_no: number;
-    made_for: string | null;
+}
+export declare type OrderGiftCards = OrderGiftCard[];
+export interface OrderPrep {
+    completed_at: ISOStringOffset | null;
+    created_at: ISOStringOffset;
+    daily_id: string;
+    done_at: ISOStringOffset | null;
+    expected_at: ISOStringOffset | null;
+    fire_at: ISOStringOffset | null;
+    is_in_prep_queue: boolean;
+    prep_status: PrepStatus;
+    ready_at: ISOStringOffset | null;
+    requested_at: ISOStringOffset;
+}
+export interface OrderRating {
+    comments: string | null;
+    rating: number;
+}
+export interface OrderRevenueCenterAddress {
+    city: string;
+    lat: number;
+    lng: number;
+    phone: string | null;
+    postal_code: string;
+    state: string;
+    street: string;
+}
+export interface OrderRevenueCenter {
+    address: OrderRevenueCenterAddress;
+    has_order_fulfillment: boolean;
+    is_outpost: boolean;
     name: string;
-    notes: string | null;
-    price: Money;
-    price_total: Money;
-    quantity: number;
-    quantity_total: number;
-    short_name: string;
-    shorthand: string | null;
+    revenue_center_id: number;
 }
-export declare type ModifiersMetadata = Array<ModifiersMetadataItem>;
 export interface OrderShipment {
     amount: Money;
     api_shipment_id: string;
@@ -241,309 +170,141 @@ export interface OrderShipment {
     shipment_id: number;
     tracking_code: string;
 }
-export interface OrderSurchargeDiscount {
-    amount: NegativeMoney;
-    discount_id: number;
-    employee_id: number | null;
-}
-export interface OrderSurchargeTax {
-    tax_id: number;
-    name: string;
-    amount: NegativeMoney;
-    amount_total: NegativeMoney;
-}
 export interface OrderSurcharge {
     amount: Money;
-    discount: NegativeMoney;
-    discounts: Array<OrderSurchargeDiscount>;
-    description?: string;
-    employee_id: number | null;
+    description: string | null;
     id: number;
-    surcharge_id?: number;
-    is_optional?: boolean;
-    is_taxed: boolean;
-    label?: string;
+    is_optional: boolean;
     name: string;
-    percentage: Decimal | null;
-    surcharge_type: SurchargeType;
-    tax: Money;
-    taxes: Array<OrderSurchargeTax>;
 }
-export declare type OrderSurcharges = Array<OrderSurcharge>;
+export declare type OrderSurcharges = OrderSurcharge[];
 export interface OrderTax {
     amount: Money;
-    amount_total?: Money;
     id: number;
-    is_active?: boolean;
-    is_optional?: boolean;
+    is_optional: boolean;
     name: string;
-    tax_id?: number;
-    tax_type?: number;
 }
-export declare type OrderTaxes = Array<OrderTax>;
-export interface OrderTenderCash {
-    cash_back: Money;
-}
-export interface OrderTenderCredit {
-    auth_id: string;
-    authcode: string;
-    batchid: string;
-    card_type: CardType;
-    charged_at: ISOStringOffset;
-    customer_card_id: number;
-    external_api_id: number;
-    last4: string;
-    masked: string;
-    merchant_id: string;
-    processor_id: string;
-    profileid: string;
-    retref: string;
-    token: string;
-    card_type_name?: string;
+export declare type OrderTaxes = OrderTax;
+export interface OrderTenderCreditCard {
+    amount: Money;
+    credit_card: CreditCard;
+    tender_type: TenderType;
 }
 export interface OrderTenderGiftCard {
-    gift_card_id: number;
+    amount: Money;
     card_number: string;
-    code: string;
+    tender_type: TenderType;
 }
 export interface OrderTenderHouseAccount {
-    house_account_id: number;
-    name: string;
-    pin: string;
-}
-export interface OrderTender {
     amount: Money;
-    cash?: OrderTenderCash;
-    created_at: ISOStringOffset;
-    credit_card?: OrderTenderCredit;
-    gift_card?: OrderTenderGiftCard;
-    house_account?: OrderTenderHouseAccount;
-    is_replaced: boolean;
-    parent_tender_uuid?: string;
-    tender_index?: number;
-    tender_status: TenderStatus;
+    house_account: {
+        house_account_id: number;
+        name: string;
+    };
     tender_type: TenderType;
-    tender_uuid: string;
-    card_number?: number;
-    name?: string;
-    customer_card_id?: number;
-    balance?: number;
-    house_account_id?: number;
-}
-export declare type OrderTenders = Array<OrderTender>;
-export interface OrderTicket {
-    display_order?: number;
-    item_nos: number[];
-    item_type_id: number;
-    item_type_name: string;
-    ticket_no?: number;
-    ticket_status: PrepStatus;
 }
-export declare type OrderTickets = Array<OrderTicket>;
+export declare type OrderTender = OrderTenderCreditCard | OrderTenderGiftCard | OrderTenderHouseAccount;
+export declare type OrderTenders = OrderTender[];
+export declare const isCreditTender: (tender: OrderTenderCreditCard | OrderTenderGiftCard | OrderTenderHouseAccount) => tender is OrderTenderCreditCard;
+export declare const isGiftCardTender: (tender: OrderTenderCreditCard | OrderTenderGiftCard | OrderTenderHouseAccount) => tender is OrderTenderGiftCard;
+export declare const isHouseAccountTender: (tender: OrderTenderCreditCard | OrderTenderGiftCard | OrderTenderHouseAccount) => tender is OrderTenderHouseAccount;
 export interface OrderTotals {
-    amount_due?: Money;
     discount: NegativeMoney;
     gift_card: Money;
-    refund?: NegativeMoney;
-    refunds_total?: NegativeMoney;
     shipping: Money;
     subtotal: Money;
     surcharge: Money;
     tax: Money;
-    tenders_net?: Money;
-    tenders_total?: Money;
     tip: Money;
     total: Money;
 }
-export interface OrderDelivery {
-    delivery_id: string;
-    dispatched: boolean;
-    service: string;
-    tracking_url: string;
-}
-export interface OrderPrep {
-    completed_at: ISOStringOffset | null;
-    created_at: ISOStringOffset;
-    daily_id?: string;
-    done_at: ISOStringOffset | null;
-    expected_at: ISOStringOffset | null;
-    fire_at: ISOStringOffset | null;
-    is_in_prep_queue: boolean;
-    prep_status: PrepStatus;
-    ready_at: ISOStringOffset | null;
-    requested_at: ISOStringOffset;
-}
-export interface OrderRating {
-    comments?: string | null;
-    rating: number;
-    order_id: number;
-}
 export interface Order {
-    revenue_center_id?: number;
     address: Address | null;
     cart: OrderCart;
-    channel?: OrderChannel;
-    completed_at?: ISOStringOffset | null;
     created_at: ISOStringOffset;
-    customer: Customer | null;
-    daily_id?: string;
-    delivery?: OrderDelivery | null;
+    customer: OrderCustomer | OrderDineInGuest;
+    delivery: OrderDelivery | null;
     details: OrderDetails | null;
-    discounts: OrderDiscounts | [];
-    estimated_at?: ISOStringOffset | null;
-    done_at: ISOStringOffset | null;
-    expected_at: ISOStringOffset | null;
-    fire_at: ISOStringOffset | ISOString | null;
-    fulfillment?: OrderFulfillment | null;
-    order_fulfillment?: OrderFulfillment | null;
-    gift_cards: CustomerGiftCards;
-    is_asap?: boolean;
-    is_editable?: boolean;
-    is_future?: boolean;
-    is_in_prep_queue: boolean;
-    made_for?: string;
-    modifiers_metadata?: ModifiersMetadata | null;
-    order_id?: number | null;
+    discounts: OrderDiscounts;
+    estimated_at: ISOStringOffset | null;
+    gift_cards: OrderGiftCards;
+    is_asap: boolean;
+    is_editable: boolean;
+    is_future: boolean;
+    order_fulfillment: OrderFulfillment | null;
+    order_id: number;
     order_prep: OrderPrep | null;
     order_type: OrderType;
-    rating?: OrderRating | null;
-    order_uuid: string;
-    parent_receipt_uuid?: string | null;
-    pos_server_id?: number;
-    pos_terminal_id?: number;
-    prep_status: PrepStatus;
-    ready_at: ISOStringOffset | ISOString | null;
-    receipt_type: ReceiptType;
-    refunds?: Array<OrderTender>;
+    rating: OrderRating | null;
+    refunds?: OrderTenders;
     requested_at: RequestedAt;
-    requested_time?: string;
+    requested_time: TimeHuman;
     revenue_center: OrderRevenueCenter;
     service_type: ServiceType;
-    shipment?: OrderShipment | null;
+    shipment: OrderShipment | null;
     status: OrderStatus;
-    surcharges: OrderSurcharges | [];
-    taxes: OrderTaxes | [];
-    tenders: OrderTenders | [];
-    tickets?: OrderTickets;
+    surcharges: OrderSurcharges;
+    taxes: OrderTaxes;
+    tenders: OrderTenders;
     timezone: TimezonePython;
     totals: OrderTotals;
-    notes?: string;
-    prepType?: string | null;
-    revenueCenter?: OrderRevenueCenter;
-    serviceType?: ServiceType;
 }
 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;
-    tickets: OrderTickets;
-}
-export declare type OrdersKds = Array<OrderKds>;
-export interface FetchOrdersArgs {
-    businessDate?: DateString | null;
-    receiptType?: ReceiptType | 'BOTH';
-    channelType?: Array<ChannelType> | null;
-    prepStatus?: Array<PrepStatus> | null;
-    search?: string | null;
-    sortBy?: 'requested_at' | 'expected_at' | 'fire_at';
-    sortDirection?: 'ASC' | 'DESC';
-    parentOrderId?: string;
-}
-export interface FetchOrdersAPIArgs {
-    business_date?: DateString;
-    receipt_type?: ReceiptType | 'BOTH';
-    channel_type?: string;
-    prep_status?: string;
-    search?: string;
-    sort_by?: 'requested_at' | 'expected_at' | 'fire_at';
-    sort_direction?: 'ASC' | 'DESC';
-    parent_receipt_uuid?: string;
-}
-export interface OrderCounts {
-    current: Record<string, number> | null;
-    future: Record<string, number> | null;
-    qa: Record<string, number> | null;
-    Orders: number;
-}
-export interface OrdersAndCounts {
-    orders: OrdersKds;
-    counts: OrderCounts;
-}
-export interface OrderUpdate {
-    expected_at?: string;
-    prep_status?: PrepStatus;
-}
-export interface OrderBucket {
-    orders: OrdersKds;
-    start: Date;
-    end: Date;
-}
-export declare type OrderBuckets = Array<OrderBucket>;
-export interface OrderTimes {
-    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 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 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 DisplayItems = DisplayItem[];
+export interface DisplayItemGroup {
+    id: number;
+    name: string;
+    options: DisplayItems;
+    short_name: string;
 }
-export declare type Tickets = Ticket[];
-export declare type TicketGroup = Ticket[];
-export declare type TicketGroups = TicketGroup[];
-export interface OrderKdsStatus {
-    NOT_DONE: boolean;
-    DONE: boolean;
-    COMPLETED: boolean;
+export declare type DisplayItemGroups = DisplayItemGroup[];
+export interface ModifiersMetadataOption {
+    id: number;
+    line_no: number;
+    name: string;
+    price: Money;
+    price_total: Money;
+    quantity: number;
+    quantity_total: number;
+    short_name: string;
 }
-export interface OrderItemCount {
-    item: OrderItem;
-    count: number;
+export interface ModifiersMetadataGroup {
+    id: number;
+    name: string;
+    options: Array<ModifiersMetadataOption>;
+    short_name: string;
 }
-export interface UnpreparedOrderData {
-    orderId: number | null;
-    revenueCenterId: number | null;
-    serviceType: ServiceType | null;
-    requestedAt: string | null;
-    cart: Cart | null;
-    customer: Customer;
-    address: Address | null;
-    details: OrderDetails | null;
-    surcharges: OrderSurcharge | null;
-    discounts: OrderDiscounts | null;
-    promoCodes: any | null;
-    points: LoyaltyPoints | number | null;
-    tip: number | null;
-    tenders: OrderTenders | null;
-    cartId: number | null;
-    deviceType: string | null;
-    prepType: string | null;
-    table: number | null;
+export interface ModifiersMetadataItem {
+    groups: Array<ModifiersMetadataGroup>;
+    id: number;
+    item_no: number;
+    line_no: number;
+    made_for: string | null;
+    name: string;
+    notes: string | null;
+    price: Money;
+    price_total: Money;
+    quantity: number;
+    quantity_total: number;
+    short_name: string;
+    shorthand: string | null;
 }
+export declare type ModifiersMetadata = Array<ModifiersMetadataItem>;