@open-tender/types 0.4.61 → 0.4.63

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

@@ -1,350 +1,350 @@
-import { DateString, ISOString, ISOStringOffset, RequestedAt, TimeHuman, TimezonePython } from '../datetimes';
-import { CardType, CardTypeName, ChannelType, DeviceType, DiscountAuthType, Gender, Images, Money, NegativeMoney, OrderStatus, OrderType, ReceiptType, ServiceType, TenderStatus, TenderType } from '../global';
-import { CreditCard, CreditCards } from './creditCards';
-import { Address, Customer, GiftCard, HouseAccounts } from './customer';
-import { PrepStatus } from './kds';
-import { NutritionalInfo } from './menu';
-export interface OrderItemPoints {
-    applied: number;
-    available: number;
-    index?: number;
-    per: number;
-    total: number;
-}
-export interface OrderItem {
-    allergens: string[];
-    description: string | null;
-    groups: OrderItemGroups;
-    id: number;
-    images: Images;
-    ingredients: string | null;
-    index?: number;
-    item_no?: number;
-    line_no?: number;
-    made_for?: string | null;
-    name: string;
-    notes?: string | null;
-    nutritional_info: NutritionalInfo | null;
-    points?: OrderItemPoints | null;
-    price: Money;
-    price_total: Money;
-    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 OrderCustomerCreditCard {
-    card_type: CardType;
-    card_type_name: CardTypeName;
-    customer_card_id: number;
-    is_default: boolean;
-    last4: string;
-    masked: string;
-}
-export declare type OrderCustomerCreditCards = OrderCustomerCreditCard[];
-export declare type OrderCustomerGiftCard = Omit<GiftCard, 'gift_card_id' | 'qr_code_url'>;
-export declare type OrderCustomerGiftCards = OrderCustomerGiftCard[];
-export interface OrderCustomerSso {
-    connected: boolean;
-    service: string;
-}
-export interface OrderCustomer extends Omit<Customer, 'allergens' | 'birth_date' | 'customer_id' | 'customer_notification_preferences' | 'favorites' | 'gender' | 'gift_cards' | 'is_notification_set'> {
-    birth_date?: DateString | null;
-    credit_cards?: CreditCards;
-    customer_id?: number;
-    gender?: Gender | null;
-    gift_cards?: OrderCustomerGiftCards;
-    house_accounts?: HouseAccounts;
-    is_guest: boolean;
-    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 const isOrderCustomer: (customer: OrderCustomer | OrderDineInGuest) => customer is OrderCustomer;
-export interface OrderDelivery {
-    delivery_id: string;
-    dispatched: boolean;
-    service: string;
-    tracking_url: string;
-}
-export interface OrderDetails {
-    cart_id: number | null;
-    eating_utensils: boolean;
-    is_tax_exempt: boolean;
-    notes: string | null;
-    notes_internal: string | null;
-    person_count: number | null;
-    serving_utensils: boolean;
-    tax_exempt_id: string | null;
-}
-export declare type OrderDiscountType = 'DEAL' | 'DISCOUNT' | 'LOYALTY' | 'PROMO_CODE' | 'REWARD';
-export declare type OrderDiscountTplsType = 'OFFER' | 'REDEEMABLE' | 'REDEMPTION';
-export interface OrderDiscount {
-    amount?: NegativeMoney;
-    auth_type: DiscountAuthType;
-    description?: string | null;
-    discount_type: OrderDiscountType;
-    ext_id?: string | null;
-    id: number;
-    is_deal: boolean;
-    is_loyalty: boolean;
-    is_optional?: boolean;
-    is_promo_code: boolean;
-    is_redeemable?: boolean;
-    is_reward: boolean;
-    name: string;
-    per_order: number | null;
-    points?: number | null;
-    title: string | null;
-    tpls_type?: OrderDiscountTplsType;
-}
-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;
-    acknowledged?: boolean;
-}
-export interface OrderGiftCard {
-    amount: Money;
-    card_number: string;
-    employee_id?: number;
-    id: number;
-}
-export declare type OrderGiftCards = OrderGiftCard[];
-export interface OrderPrep {
-    completed_at: ISOString | null;
-    created_at: ISOString;
-    daily_id: string;
-    done_at: ISOString | null;
-    expected_at: ISOString | null;
-    fire_at: ISOString | null;
-    is_in_prep_queue: boolean;
-    prep_status: PrepStatus;
-    ready_at: ISOString | null;
-    requested_at: ISOString;
-}
-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 = OrderTicket[];
-export interface OrderRating {
-    comments: string | null;
-    rating: number;
-}
-export interface OrderRating {
-    comments: string | null;
-    rating: number;
-}
-export interface OrderRatingWithOrder extends OrderRating {
-    order_id: 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;
-    revenue_center_id: number;
-}
-export interface OrderShipment {
-    amount: Money;
-    api_shipment_id: string;
-    carrier: string;
-    label_id: string;
-    label_url: string;
-    service: string;
-    shipment_id: number;
-    tracking_code: string;
-}
-export interface OrderSurcharge {
-    amount: Money;
-    description: string | null;
-    id: number;
-    is_optional: boolean;
-    name: string;
-}
-export declare type OrderSurcharges = OrderSurcharge[];
-export interface OrderTax {
-    amount: Money;
-    id: number;
-    is_optional: boolean;
-    name: string;
-}
-export declare type OrderTaxes = OrderTax[];
-export interface OrderTenderBase {
-    amount: Money;
-    created_at?: ISOStringOffset;
-    is_replaced?: boolean;
-    parent_tender_uuid?: string;
-    tender_index?: number;
-    tender_status: TenderStatus;
-    tender_type: TenderType;
-    tender_uuid?: string;
-}
-export interface OrderTenderCreditCard extends OrderTenderBase {
-    credit_card: CreditCard;
-}
-export interface OrderTenderGiftCard extends OrderTenderBase {
-    card_number: string;
-}
-export interface OrderTenderHouseAccount extends OrderTenderBase {
-    house_account: {
-        house_account_id: number;
-        name: string;
-    };
-}
-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 OrderChannel {
-    ext_id?: string | null;
-    ext_name?: string | null;
-    type: ChannelType;
-}
-export interface Order {
-    address: Address | null;
-    cart: OrderCart;
-    channel: OrderChannel;
-    created_at: ISOString;
-    customer: OrderCustomer | null;
-    delivery: OrderDelivery | null;
-    deposit: Money | null;
-    details: OrderDetails | null;
-    device_type?: DeviceType;
-    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 | null;
-    order_prep: OrderPrep | null;
-    order_type: OrderType;
-    order_uuid?: string | null;
-    parent_receipt_uuid?: string | null;
-    pos_server_id?: number | null;
-    pos_terminal_id?: number | null;
-    rating?: OrderRating | null;
-    receipt_type?: ReceiptType;
-    refunds?: OrderTenders;
-    requested_at: RequestedAt;
-    requested_time?: TimeHuman;
-    revenue_center: OrderRevenueCenter;
-    service_type: ServiceType;
-    status: OrderStatus;
-    surcharges: OrderSurcharges;
-    taxes: OrderTaxes;
-    tenders: OrderTenders;
-    tickets?: OrderTickets;
-    timezone: TimezonePython;
-    totals: OrderTotals;
-}
-export declare type Orders = Order[];
-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;
-    points: null;
-    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;
-    name: string;
-    price: Money;
-    price_total: Money;
-    quantity: number;
-    quantity_total: number;
-    short_name: string;
-}
-export interface ModifiersMetadataGroup {
-    id: number;
-    name: string;
-    options: Array<ModifiersMetadataOption>;
-    short_name: string;
-}
-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>;
+import { DateString, ISOString, ISOStringOffset, RequestedAt, TimeHuman, TimezonePython } from '../datetimes';
+import { CardType, CardTypeName, ChannelType, DeviceType, DiscountAuthType, Gender, Images, Money, NegativeMoney, OrderStatus, OrderType, ReceiptType, ServiceType, TenderStatus, TenderType } from '../global';
+import { CreditCard, CreditCards } from './creditCards';
+import { Address, Customer, GiftCard, HouseAccounts } from './customer';
+import { PrepStatus } from './kds';
+import { NutritionalInfo } from './menu';
+export interface OrderItemPoints {
+    applied: number;
+    available: number;
+    index?: number;
+    per: number;
+    total: number;
+}
+export interface OrderItem {
+    allergens: string[];
+    description: string | null;
+    groups: OrderItemGroups;
+    id: number;
+    images: Images;
+    ingredients: string | null;
+    index?: number;
+    item_no?: number;
+    line_no?: number;
+    made_for?: string | null;
+    name: string;
+    notes?: string | null;
+    nutritional_info: NutritionalInfo | null;
+    points?: OrderItemPoints | null;
+    price: Money;
+    price_total: Money;
+    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 OrderCustomerCreditCard {
+    card_type: CardType;
+    card_type_name: CardTypeName;
+    customer_card_id: number;
+    is_default: boolean;
+    last4: string;
+    masked: string;
+}
+export declare type OrderCustomerCreditCards = OrderCustomerCreditCard[];
+export declare type OrderCustomerGiftCard = Omit<GiftCard, 'gift_card_id' | 'qr_code_url'>;
+export declare type OrderCustomerGiftCards = OrderCustomerGiftCard[];
+export interface OrderCustomerSso {
+    connected: boolean;
+    service: string;
+}
+export interface OrderCustomer extends Omit<Customer, 'allergens' | 'birth_date' | 'customer_id' | 'customer_notification_preferences' | 'favorites' | 'gender' | 'gift_cards' | 'is_notification_set'> {
+    birth_date?: DateString | null;
+    credit_cards?: CreditCards;
+    customer_id?: number;
+    gender?: Gender | null;
+    gift_cards?: OrderCustomerGiftCards;
+    house_accounts?: HouseAccounts;
+    is_guest: boolean;
+    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 const isOrderCustomer: (customer: OrderCustomer | OrderDineInGuest) => customer is OrderCustomer;
+export interface OrderDelivery {
+    delivery_id: string;
+    dispatched: boolean;
+    service: string;
+    tracking_url: string;
+}
+export interface OrderDetails {
+    cart_id: number | null;
+    eating_utensils: boolean;
+    is_tax_exempt: boolean;
+    notes: string | null;
+    notes_internal: string | null;
+    person_count: number | null;
+    serving_utensils: boolean;
+    tax_exempt_id: string | null;
+}
+export declare type OrderDiscountType = 'DEAL' | 'DISCOUNT' | 'LOYALTY' | 'PROMO_CODE' | 'REWARD';
+export declare type OrderDiscountTplsType = 'OFFER' | 'REDEEMABLE' | 'REDEMPTION';
+export interface OrderDiscount {
+    amount?: NegativeMoney;
+    auth_type: DiscountAuthType;
+    description?: string | null;
+    discount_type: OrderDiscountType;
+    ext_id?: string | null;
+    id: number;
+    is_deal: boolean;
+    is_loyalty: boolean;
+    is_optional?: boolean;
+    is_promo_code: boolean;
+    is_redeemable?: boolean;
+    is_reward: boolean;
+    name: string;
+    per_order: number | null;
+    points?: number | null;
+    title: string | null;
+    tpls_type?: OrderDiscountTplsType;
+}
+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;
+    acknowledged?: boolean;
+}
+export interface OrderGiftCard {
+    amount: Money;
+    card_number: string;
+    employee_id?: number;
+    id: number;
+}
+export declare type OrderGiftCards = OrderGiftCard[];
+export interface OrderPrep {
+    completed_at: ISOString | null;
+    created_at: ISOString;
+    daily_id: string;
+    done_at: ISOString | null;
+    expected_at: ISOString | null;
+    fire_at: ISOString | null;
+    is_in_prep_queue: boolean;
+    prep_status: PrepStatus;
+    ready_at: ISOString | null;
+    requested_at: ISOString;
+}
+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 = OrderTicket[];
+export interface OrderRating {
+    comments: string | null;
+    rating: number;
+}
+export interface OrderRating {
+    comments: string | null;
+    rating: number;
+}
+export interface OrderRatingWithOrder extends OrderRating {
+    order_id: 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;
+    revenue_center_id: number;
+}
+export interface OrderShipment {
+    amount: Money;
+    api_shipment_id: string;
+    carrier: string;
+    label_id: string;
+    label_url: string;
+    service: string;
+    shipment_id: number;
+    tracking_code: string;
+}
+export interface OrderSurcharge {
+    amount: Money;
+    description: string | null;
+    id: number;
+    is_optional: boolean;
+    name: string;
+}
+export declare type OrderSurcharges = OrderSurcharge[];
+export interface OrderTax {
+    amount: Money;
+    id: number;
+    is_optional: boolean;
+    name: string;
+}
+export declare type OrderTaxes = OrderTax[];
+export interface OrderTenderBase {
+    amount: Money;
+    created_at?: ISOStringOffset;
+    is_replaced?: boolean;
+    parent_tender_uuid?: string;
+    tender_index?: number;
+    tender_status: TenderStatus;
+    tender_type: TenderType;
+    tender_uuid?: string;
+}
+export interface OrderTenderCreditCard extends OrderTenderBase {
+    credit_card: CreditCard;
+}
+export interface OrderTenderGiftCard extends OrderTenderBase {
+    card_number: string;
+}
+export interface OrderTenderHouseAccount extends OrderTenderBase {
+    house_account: {
+        house_account_id: number;
+        name: string;
+    };
+}
+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 OrderChannel {
+    ext_id?: string | null;
+    ext_name?: string | null;
+    type: ChannelType;
+}
+export interface Order {
+    address: Address | null;
+    cart: OrderCart;
+    channel: OrderChannel;
+    created_at: ISOString;
+    customer: OrderCustomer | null;
+    delivery: OrderDelivery | null;
+    deposit: Money | null;
+    details: OrderDetails | null;
+    device_type?: DeviceType;
+    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 | null;
+    order_prep: OrderPrep | null;
+    order_type: OrderType;
+    order_uuid?: string | null;
+    parent_receipt_uuid?: string | null;
+    pos_server_id?: number | null;
+    pos_terminal_id?: number | null;
+    rating?: OrderRating | null;
+    receipt_type?: ReceiptType;
+    refunds?: OrderTenders;
+    requested_at: RequestedAt;
+    requested_time?: TimeHuman;
+    revenue_center: OrderRevenueCenter;
+    service_type: ServiceType;
+    status: OrderStatus;
+    surcharges: OrderSurcharges;
+    taxes: OrderTaxes;
+    tenders: OrderTenders;
+    tickets?: OrderTickets;
+    timezone: TimezonePython;
+    totals: OrderTotals;
+}
+export declare type Orders = Order[];
+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;
+    points: null;
+    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;
+    name: string;
+    price: Money;
+    price_total: Money;
+    quantity: number;
+    quantity_total: number;
+    short_name: string;
+}
+export interface ModifiersMetadataGroup {
+    id: number;
+    name: string;
+    options: Array<ModifiersMetadataOption>;
+    short_name: string;
+}
+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>;