@open-tender/types 0.0.2 → 0.0.3

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

@@ -0,0 +1,427 @@
+import { DateString, ISOStringOffset, TimezonePython } from '../datetimes';
+import { CardType, ChannelType, Decimal, Money, NegativeMoney, OrderStatus, OrderType, ReceiptType, ServiceType, SurchargeType, Temperature, TenderStatus, TenderType } from '../global';
+import { Address, Customer, CustomerAllergens, CustomerGiftCards } from './customer';
+import { PrepStatus, TicketStatus } from './kds';
+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;
+}
+export interface OrderDiscount {
+    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 {
+    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;
+}
+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' | 'IMAGE';
+    url: string | null;
+}
+export declare type OrderItemImages = Array<OrderItemImage>;
+export interface OrderItemTax {
+    tax_id: number;
+    name: string;
+    amount: NegativeMoney;
+    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 {
+    allergens?: CustomerAllergens;
+    description: string;
+    discount?: Money;
+    discount_total?: Money;
+    discounts?: OrderItemDiscounts;
+    groups?: OrderGroups;
+    id: number;
+    images: OrderItemImages;
+    ingredients: string | null;
+    item_no?: number;
+    line_no?: number;
+    made_for?: string;
+    name: string;
+    notes?: string;
+    points?: number | null;
+    points_total?: number;
+    price?: Money;
+    price_quantity?: number;
+    price_total: Money;
+    price_unit?: Money;
+    quantity: number;
+    quantity_total?: number;
+    sales_tax_override?: string | null;
+    short_description: string;
+    short_name: string;
+    tax?: Money;
+    tax_total?: Money;
+    taxes?: OrderItemTaxes;
+    temperature: Temperature;
+}
+export declare type OrderCart = Array<OrderItem>;
+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>;
+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 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;
+    id: number;
+    is_optinoal?: boolean;
+    is_taxed: boolean;
+    label?: string;
+    name: string;
+    percentage: Decimal | null;
+    surcharge_type: SurchargeType;
+    tax: Money;
+    taxes: Array<OrderSurchargeTax>;
+}
+export declare type OrderSurcharges = Array<OrderSurcharge>;
+export interface OrderTax {
+    amount: Money;
+    amount_total?: Money;
+    id: number;
+    is_active?: 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;
+}
+export interface OrderTenderGiftCard {
+    gift_card_id: number;
+    card_number: string;
+    code: string;
+}
+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;
+    tender_type: TenderType;
+    tender_uuid: string;
+}
+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 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;
+}
+export interface Order {
+    address: Address | null;
+    cart: OrderCart;
+    channel?: OrderChannel;
+    completed_at?: ISOStringOffset | null;
+    created_at: ISOStringOffset;
+    customer: Customer | null;
+    daily_id?: string;
+    delivery?: OrderDelivery | null;
+    details: OrderDetails | null;
+    discounts: OrderDiscounts | [];
+    estimated_at?: ISOStringOffset | null;
+    done_at: ISOStringOffset | null;
+    expected_at: ISOStringOffset | null;
+    fire_at: ISOStringOffset | 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;
+    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 | null;
+    receipt_type: ReceiptType;
+    refunds?: Array<OrderTender>;
+    requested_at: ISOStringOffset;
+    requested_time?: string;
+    revenue_center: OrderRevenueCenter;
+    service_type: ServiceType;
+    shipment?: OrderShipment | null;
+    status: OrderStatus;
+    surcharges: OrderSurcharges | [];
+    taxes: OrderTaxes | [];
+    tenders: OrderTenders | [];
+    tickets?: OrderTickets;
+    timezone: TimezonePython;
+    totals: OrderTotals;
+}
+export declare type Orders = Array<Order>;
+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;
+}
+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 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/order.js

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

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

@@ -0,0 +1,5 @@
+export interface OrdersCount {
+    current: any;
+    future: any;
+    qa: any;
+}

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

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

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

@@ -0,0 +1,22 @@
+import { Money } from '../global';
+export interface RefundItem {
+    item_no: number;
+    quantity: number;
+}
+export declare type RefundItems = Array<RefundItem>;
+export interface RefundSurcharge {
+    surcharge_id: number;
+}
+export declare type RefundSurcharges = Array<RefundSurcharge>;
+export interface Refund {
+    full_refund: boolean;
+    all_taxes: boolean;
+    items: RefundItems;
+    surcharges: RefundSurcharges;
+    tip: Money;
+    shipping: Money;
+}
+export interface RefundArgs {
+    orderId: string;
+    refund: Refund;
+}

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

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

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

@@ -0,0 +1,52 @@
+import { TimeString } from '../datetimes';
+import { Decimal, Money, OrderType, ServiceType, TaxType, Weekday } from '../global';
+import { PunchAuthType } from './employee';
+import { PaymentProcessing } from './store';
+export interface RevenueCenterTax {
+    amount: Decimal;
+    display_order: number;
+    is_active: boolean;
+    is_optional: boolean;
+    name: string;
+    tax_id: number;
+    tax_type: TaxType;
+}
+export interface RevenueCenter {
+    credit: PaymentProcessing;
+    dine_in_prompt: boolean;
+    dine_in_show: boolean;
+    end_of_day: TimeString;
+    greeting: string;
+    has_loyalty: boolean;
+    is_closed: boolean;
+    is_outpost: boolean;
+    is_temporarily_closed: boolean;
+    item_discount_approval: boolean;
+    name: string;
+    olo_print_device_id: number;
+    olo_print_order_type: 'BOTH_OLO_CATERING' | 'OLO_ONLY' | 'CATERING_ONLY';
+    olo_print_server_id: number;
+    olo_print_stage: 'PLACED' | 'FIRED' | 'CONFIRMED';
+    order_page_swipe: boolean;
+    overtime_threshold: number;
+    overtime_threshold_daily: number;
+    page_timeout: number;
+    punch_type: PunchAuthType;
+    receipt_footer: string;
+    receipt_header: string;
+    receipt_phone: boolean;
+    revenue_center_id: number;
+    revenue_center_type: OrderType;
+    send_offline_alerts: boolean;
+    service_types: Array<ServiceType>;
+    short_name: string;
+    slug: string;
+    starting_cash: Money;
+    tax_exempt_approval: boolean;
+    taxes: Array<RevenueCenterTax>;
+    week_start_day: Weekday;
+    delivery_wait_time_id: number | null;
+    temporary_delivery_wait_time_id: number | null;
+    pickup_wait_time_id: number | null;
+    temporary_pickup_wait_time_id: number | null;
+}

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

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

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

@@ -0,0 +1,10 @@
+import { EntityType } from '../global';
+export interface Settings {
+    entity_type: EntityType;
+    object_id: number;
+    version: number;
+    data: Record<string, unknown>;
+}
+export interface InternalSettings {
+    is_offline: boolean;
+}

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

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

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

@@ -0,0 +1,111 @@
+import { TimeString, TimezonePython } from '../datetimes';
+import { Decimal, Money, ServiceType, TenderType, Url, Weekday } from '../global';
+export declare type PaymentProcessor = 'NONE' | 'CARDCONNECT' | 'VANTIV' | 'CLOVER' | 'NMI';
+export interface PaymentProcessing {
+    integration: PaymentProcessor;
+    is_testing: boolean;
+    merchant_api_key: string;
+    merchant_id: string;
+    merchant_password: string;
+    merchant_username: string;
+    offline_limit: Money | null;
+    saved_cards: boolean;
+    signature_threshold: Money | null;
+}
+export interface StoreTax {
+    amount: Decimal;
+    display_order: number;
+    id: number;
+    is_active: boolean;
+    is_optional: boolean;
+    name: string;
+    tax_id: number;
+    tax_type: number;
+}
+export interface StoreTenderTypes {
+    DELIVERY: Array<TenderType>;
+    PICKUP: Array<TenderType>;
+    WALKIN: Array<TenderType>;
+}
+export interface StoreAddress {
+    city: string;
+    cross_streets: string;
+    directions_link: string;
+    fax: string | null;
+    latitude: Decimal;
+    longitude: Decimal;
+    phone: string | null;
+    postal_code: string;
+    state: string;
+    street: string;
+}
+export interface LevelUp {
+    discount_id: number;
+    location_id: number;
+    merchant_id: number;
+    merchant_token: string;
+    sandbox: boolean;
+}
+export interface StoreMessage {
+    pos_message_id: number;
+    name: string;
+    message_above: string | null;
+    message_below: string | null;
+    message_url: string | null;
+    is_active: boolean;
+}
+export interface Store {
+    address: StoreAddress;
+    auth_type: 'PIN' | 'CARD';
+    alert_minutes: number;
+    closed: boolean;
+    credit: PaymentProcessing;
+    delivery_minutes: number;
+    dine_in_prompt: boolean;
+    dine_in_show: boolean;
+    disable_complete: boolean;
+    display_promised_at: boolean;
+    display_ready_at: boolean;
+    display_revenue_center: boolean;
+    done_on_print: boolean;
+    end_of_day: TimeString;
+    greeting: string;
+    has_loyalty: boolean;
+    hide_default_mods: boolean;
+    hide_delay: boolean;
+    is_closed: boolean;
+    is_outpost: boolean;
+    is_temporarily_closed: boolean;
+    item_discount_approval: boolean;
+    levelup?: LevelUp;
+    messages: Array<StoreMessage> | null;
+    name: string;
+    number: string;
+    order_page_swipe: boolean;
+    origin: Url | null;
+    overtime_threshold: number;
+    overtime_threshold_daily: number;
+    page_timeout: number;
+    pickup_minutes: number;
+    prep_minutes: number;
+    print_on_completed: boolean;
+    punch_type: 'PIN' | 'CARD';
+    receipt_footer: string;
+    receipt_header: string;
+    receipt_phone: boolean;
+    revenue_center_id: number;
+    revenue_center_type: 'POS' | 'OLO' | 'CATERING';
+    service_types: Array<ServiceType>;
+    short_name: string;
+    slug: string;
+    starting_cash: Decimal;
+    store_id: number;
+    tax_exempt_approval: boolean;
+    taxes: Array<StoreTax>;
+    tender_types: StoreTenderTypes;
+    timezone: TimezonePython;
+    walkin_minutes: number;
+    walkin_prep_minutes: number;
+    warning_minutes: number;
+    week_start_day: Weekday;
+}

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

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

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

@@ -0,0 +1,15 @@
+import { Money, SurchargeType } from '../global';
+export interface Surcharge {
+    id: number;
+    name: string;
+    surcharge_type: SurchargeType;
+    position: number;
+    amount: Money;
+    min_amount: Money;
+    max_amount: Money;
+    is_active: boolean;
+    is_taxed: boolean;
+    requires_approval: boolean;
+    version: number;
+}
+export declare type Surcharges = Array<Surcharge>;

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

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

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

@@ -0,0 +1,15 @@
+import { Money, OrderType, ServiceType, TaxType } from '../global';
+export interface Tax {
+    id: number;
+    name: string;
+    tax_type: TaxType;
+    position: number;
+    amount: Money;
+    min_amount: Money;
+    max_amount: Money;
+    requires_approval: boolean;
+    service_type: ServiceType | null;
+    order_type: OrderType | null;
+    version: number;
+}
+export declare type Taxes = Array<Tax>;

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

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