@open-tender/types 0.0.2 → 0.0.3

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

@@ -0,0 +1,173 @@
+import { ISOString, TimezonePython } from '../datetimes';
+import { DiscountType, GratuityType, Money, OrderType, ServiceType, TenderType } from '../global';
+import { Address, Customer, LoyaltyPoints } from './customer';
+import { OrderDetails, OrderDiscounts, OrderFulfillment, OrderItem, OrderRevenueCenter, OrderShipment, OrderSurcharges, OrderTaxes, OrderTenders, OrderTotals } from './order';
+export interface CustomerIdentifier {
+    card_token?: string;
+    phone?: string;
+    qr_code?: string;
+}
+export interface IdentifyCustomer {
+    data: CustomerIdentifier;
+    callback?: () => void;
+    showError?: boolean;
+}
+export interface CustomerDiscount {
+    customer_loyalty_id: number;
+    loyalty_program_id: number;
+    order_type: OrderType;
+    amount: Money;
+    name: string;
+    discount_id: number;
+    discount_type: DiscountType;
+    description: string;
+    before_surcharge: boolean;
+    is_taxed: boolean;
+    is_promo_code: boolean;
+    is_auto: boolean;
+    is_loyalty: boolean;
+}
+export declare type CustomerDiscounts = Array<CustomerDiscount>;
+export interface CustomerCheckout {
+    customer: Customer;
+    discounts: CustomerDiscounts;
+    points: any;
+    discount: any;
+}
+export interface SimpleCartOption {
+    id: number;
+    quantity: number;
+}
+export interface SimpleCartGroup {
+    id: number;
+    options: Array<SimpleCartOption>;
+}
+export interface SimpleCartItem {
+    id: number;
+    quantity: number;
+    groups?: Array<SimpleCartGroup>;
+    made_for?: string;
+    notes?: string;
+}
+export declare type SimpleCart = Array<SimpleCartItem>;
+export interface OrderCreateDetails {
+    eating_utensils?: boolean;
+    serving_utensils?: boolean;
+    person_count?: number | null;
+    notes?: string | null;
+    tax_exempt_id?: string | null;
+    cart_id?: number | null;
+}
+export interface OrderCreateGiftCard {
+    id: number;
+    gift_card_id?: number;
+    code?: string;
+    card_number: string;
+    amount: Money;
+    employee_id?: number;
+}
+export interface OrderCreateSurcharge {
+    id: number;
+}
+export interface OrderCreateDiscount {
+    id: number;
+    ext_id?: string | null;
+}
+export interface OrderCreateTax {
+    id: number;
+}
+export interface OrderCreatePoints {
+    index: number;
+    points: number;
+}
+export interface Tender {
+    tender_type: TenderType;
+    amount?: Money;
+    cash_back?: Money;
+    customer_card_id?: string;
+    acct?: string;
+    cvv?: string;
+    exp?: string;
+    zip?: string;
+    save?: boolean;
+}
+export interface OrderCreate {
+    address?: Address | null;
+    cart: SimpleCart;
+    customer?: Customer | null;
+    details?: OrderCreateDetails | null;
+    discounts?: Array<OrderCreateDiscount>;
+    gift_cards?: Array<OrderCreateGiftCard>;
+    is_tax_exempt?: boolean;
+    made_for?: string;
+    order_type?: OrderType;
+    order_uuid?: string;
+    points?: Array<OrderCreatePoints>;
+    promo_codes?: string[];
+    requested_at: ISOString | 'asap';
+    revenue_center_id: number;
+    service_type: ServiceType;
+    shipment_id?: string;
+    surcharges?: Array<OrderCreateSurcharge>;
+    taxes?: Array<OrderCreateTax>;
+    tenders?: Array<Tender>;
+    tip?: Money;
+}
+export interface CheckoutConfigDisplayed {
+    address: string[];
+    customer: Customer[];
+    details: string[];
+}
+export interface CheckoutConfigGratuity {
+    default: {
+        [key in GratuityType]: string;
+    } | null;
+    has_tip: boolean;
+    max_gratuity: {
+        [key in GratuityType]: string;
+    } | null;
+    options: {
+        [key in GratuityType]: string;
+    }[];
+}
+export interface CheckoutConfig {
+    allow_tax_exempt: boolean;
+    discounts: OrderDiscounts;
+    displayed: CheckoutConfigDisplayed;
+    gratuity: CheckoutConfigGratuity;
+    order_fulfillment: OrderFulfillment;
+    points: LoyaltyPoints | null;
+    promo_code_limit: number;
+    required: CheckoutConfigDisplayed;
+    surcharges: OrderSurcharges;
+    tender_types: Array<TenderType>;
+}
+export interface CheckoutForm {
+    address: Address | null;
+    customer: Customer;
+    details: OrderDetails;
+    discounts: OrderDiscounts;
+    points: Array<LoyaltyPoints>;
+    promoCodes: any;
+    surcharges: OrderSurcharges;
+    tenders: OrderTenders;
+    tip: any;
+}
+export interface CheckoutCheck {
+    address: Address | null;
+    cart: Array<OrderItem>;
+    config: CheckoutConfig;
+    customer: Customer;
+    details: OrderDetails;
+    discounts: OrderDiscounts;
+    order_type: OrderType;
+    requested_at: ISOString;
+    revenue_center: OrderRevenueCenter;
+    service_type: ServiceType;
+    shipment: OrderShipment | null;
+    surcharges: OrderSurcharges;
+    taxes: OrderTaxes;
+    tenders: OrderTenders;
+    timezone: TimezonePython;
+    totals: OrderTotals;
+}

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

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

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

@@ -0,0 +1,42 @@
+import { ISOString, Timezone } from '../datetimes';
+import { Money, OrderType, ServiceType, TenderType } from '../global';
+import { RequestError } from '../request';
+import { CreditCard } from './creditCards';
+import { Address, Customer, HouseAccount } from './customer';
+import { OrderDelivery, OrderDetails, OrderDiscounts, OrderFulfillment, OrderRating, OrderRevenueCenter, OrderShipment, OrderSurcharges, OrderTaxes, OrderTotals } from './order';
+export interface CompletedOrderConfig {
+    discounts: OrderDiscounts | [];
+    surcharges: OrderSurcharges | [];
+}
+export interface OrderRefund {
+    amount: Money;
+    credit_card: CreditCard | null;
+    house_account: HouseAccount | null;
+    tender_type: TenderType;
+}
+export interface CompletedOrder {
+    address: Address | null;
+    config: CompletedOrderConfig;
+    created_at: ISOString;
+    customer: Customer;
+    delivery: OrderDelivery | null;
+    details: OrderDetails | null;
+    errors: RequestError;
+    estimated_at: ISOString;
+    is_asap: boolean;
+    is_editable: boolean;
+    is_future: boolean;
+    order_fulfillment: OrderFulfillment | null;
+    rating: OrderRating;
+    refunds: Array<OrderRefund>;
+    requested_at: ISOString;
+    requested_time: string;
+    revenue_center: OrderRevenueCenter;
+    service_type: ServiceType;
+    shipment: OrderShipment;
+    texes: OrderTaxes;
+    timezone: Timezone;
+    totals: OrderTotals;
+    order_type: OrderType;
+}
+export declare type CompletedOrders = Array<CompletedOrder>;

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

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

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

@@ -0,0 +1,47 @@
+import { IpAddress } from '../global';
+import { PrepStations, PrepStatus } from './kds';
+export interface Config {
+    backup_printer_ip_address: IpAddress | null;
+    backup_printer_use_beeper: boolean;
+    brand_id: number;
+    cardreader_id: string;
+    has_cardreader: boolean;
+    has_cardwriter: boolean;
+    has_cashdrawer: boolean;
+    has_pinpad: boolean;
+    has_qrcode: boolean;
+    has_timeclock: boolean;
+    ip_address: IpAddress;
+    name: string;
+    pos_server_id: number;
+    pos_terminal_id: number;
+    prep_stations?: PrepStations | null;
+    print_kds: boolean;
+    print_receipt: 'never' | 'always' | 'prompt';
+    printer: IpAddress;
+    printer_use_beeper: boolean;
+    scanner_id: string;
+    server: IpAddress;
+    terminal_type: 'POS_TERMINAL' | 'KDS_TERMINAL' | 'KIOSK';
+}
+export interface ItemType {
+    default_prep_status: PrepStatus;
+    is_default: boolean;
+    is_grouped: boolean;
+    is_hidden_assembly: boolean;
+    is_hidden_qa: boolean;
+    item_type_id: number;
+    items: number[];
+    name: string;
+    position: number;
+    prep_time: number;
+    print_on_completed: boolean;
+}
+export declare type ItemTypes = Array<ItemType>;
+export interface SelectOption {
+    name: string;
+    option_type: 'PAID_IN' | 'PAID_OUT';
+    position: number;
+    select_option_id: number;
+}
+export declare type SelectOptions = Array<SelectOption>;

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

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

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

@@ -0,0 +1,11 @@
+import { CardType } from '../global';
+export interface CreditCard {
+    card_type?: CardType;
+    card_type_name?: string;
+    customer_card_id?: number;
+    has_profile?: boolean;
+    is_default?: boolean;
+    last4?: string;
+    masked?: string;
+}
+export declare type CreditCards = Array<CreditCard>;

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

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

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

@@ -0,0 +1,22 @@
+export interface Auth {
+    access_token: string;
+    expires_in: number;
+    refresh_token: string;
+    token_type: string;
+}
+export interface Profile {
+    birth_date: string | null;
+    company: string;
+    customer_id: number;
+    email: string;
+    first_name: string;
+    gender: string | null;
+    is_notification_set: boolean;
+    is_verified: boolean;
+    last_name: string;
+    phone: string;
+}
+export interface LoginData {
+    email: string;
+    password: string;
+}

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

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

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

@@ -0,0 +1,20 @@
+export interface Address {
+    city: string;
+    company?: string;
+    contact?: string;
+    created_at?: string;
+    customer_address_id?: number;
+    description?: string;
+    formatted_address?: string;
+    is_default?: boolean;
+    last_used_at?: string;
+    lat: number | null;
+    lng: number | null;
+    notes?: string;
+    phone?: string;
+    postal_code: string;
+    state: string;
+    street: string;
+    unit?: string;
+}
+export declare type Addresses = Array<Address>;

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

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

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

@@ -0,0 +1,5 @@
+export interface CustomerAllergen {
+    allergen_id: number;
+    name?: string;
+}
+export declare type CustomerAllergens = Array<CustomerAllergen>;

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

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

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

@@ -0,0 +1,10 @@
+import { ISOStringOffset } from '../../datetimes';
+export declare type NotificationChannel = 'EMAIL' | 'SMS' | 'PUSH';
+export declare type NotificationArea = 'ORDER' | 'RATING' | 'MARKETING';
+export interface CustomerNotificationPref {
+    craeted_at: ISOStringOffset;
+    customer_notification_preference_id: number;
+    notification_area: NotificationArea;
+    notification_channel: NotificationChannel;
+}
+export declare type CustomerNotificationPrefs = Array<CustomerNotificationPref>;

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

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

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

@@ -0,0 +1,27 @@
+import { DateString } from '../../datetimes';
+import { Allergens } from '../allergens';
+import { Favorites } from '../favorite';
+import { CustomerNotificationPrefs } from './communicationPreferences';
+import { CustomerGiftCards } from './giftCards';
+export interface Customer {
+    accepts_marketing?: boolean;
+    birth_date?: DateString | null;
+    company?: boolean;
+    customer_id?: number;
+    email?: string;
+    first_name?: string;
+    gender?: 'MALE' | 'FEMALE' | 'DECLINED' | null;
+    is_guest?: boolean;
+    is_notification_set?: boolean;
+    is_verified?: boolean;
+    last_name?: string;
+    order_notifications?: 'NEW' | 'EMAIL' | 'SMS' | 'ALL' | 'NONE';
+    phone?: string | null;
+}
+export interface CustomerWithRelated extends Customer {
+    allergens?: Allergens;
+    customer_notification_preferences?: CustomerNotificationPrefs;
+    favorites?: Favorites;
+    gift_cards?: CustomerGiftCards;
+    levelup?: [] | null;
+}

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

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

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

@@ -0,0 +1,12 @@
+import { DateString, ISOStringOffset } from '../../datetimes';
+import { Money } from '../../global';
+export interface CustomerGiftCard {
+    balance: Money;
+    card_number: string;
+    expiration: DateString | null;
+    gift_card_id: number;
+    orders: number;
+    qr_code_url: string;
+    updated_at: ISOStringOffset;
+}
+export declare type CustomerGiftCards = Array<CustomerGiftCard>;

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

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

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

@@ -0,0 +1,33 @@
+import { ISOString } from '../../datetimes';
+import { ServiceType } from '../../global';
+import { RequestErrorAPI, RequestStatus } from '../../request';
+import { OrderItem, OrderRevenueCenter } from '../order';
+import { Address } from './addresses';
+export interface CartOwner {
+    customer_id: number;
+    first_name: string;
+    last_name: string;
+}
+export interface GroupOrder {
+    address?: Address | null;
+    cart: Array<OrderItem>;
+    cartGuest?: any;
+    cartGuests?: any[];
+    cart_id: number;
+    cartOwner?: CartOwner;
+    customer?: CartOwner;
+    closed: boolean;
+    cutoff_at: string;
+    error?: RequestErrorAPI;
+    guest_count: number;
+    guest_limit: number;
+    isCartOwner: boolean;
+    loading?: RequestStatus;
+    requested_at: ISOString;
+    revenue_center?: OrderRevenueCenter;
+    revenue_center_id: number;
+    service_type: ServiceType;
+    spending_limit: string;
+    token: string;
+}
+export declare type GroupOrders = Array<GroupOrder>;

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

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

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

@@ -0,0 +1,13 @@
+import { OrderType, ServiceType } from '../../global';
+import { RevenueCenter } from '../revenueCenter';
+export interface HouseAccount {
+    approved_contact: boolean;
+    domain: string;
+    house_account_id: number;
+    name: string;
+    order_type: OrderType;
+    pin: string;
+    revenue_centers: Array<RevenueCenter>;
+    service_type: ServiceType;
+}
+export declare type HouseAccounts = Array<HouseAccount>;

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

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

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

@@ -0,0 +1,11 @@
+export * from './account';
+export * from './addresses';
+export * from './communicationPreferences';
+export * from './giftCards';
+export * from './customer';
+export * from './loyalty';
+export * from './groupOrders';
+export * from './allergens';
+export * from './houseAccounts';
+export * from './rewards';
+export * from './revenueCenters';

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

@@ -0,0 +1,11 @@
+export * from './account';
+export * from './addresses';
+export * from './communicationPreferences';
+export * from './giftCards';
+export * from './customer';
+export * from './loyalty';
+export * from './groupOrders';
+export * from './allergens';
+export * from './houseAccounts';
+export * from './rewards';
+export * from './revenueCenters';

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

@@ -0,0 +1,64 @@
+import { OrderType } from '../../global';
+export interface LoyaltyCredit {
+    current: string;
+    total: string;
+}
+export declare type LoyaltyType = 'CREDIT' | 'POINTS';
+export interface LoyaltyPoints {
+    expiration_days: number;
+    name: string;
+    points: number;
+    points_per_dollar: number;
+}
+export interface LoyaltyRedemption {
+    order_type: OrderType;
+    reward: string;
+    threshold: string;
+    type: string;
+}
+export interface LoyaltySpend {
+    current: string | null;
+    order_type: OrderType;
+    total: string;
+    type: string;
+}
+export interface LoyaltyStatus {
+    days: number;
+    progress: string;
+    tier: any;
+}
+export interface LoyaltyThreshold {
+    name: string;
+    points: number;
+    description: string;
+}
+export interface LoyaltyDiscount {
+    amount: string;
+    description: string;
+    discount_id: number;
+    discount_type: string;
+    name: string;
+    title: string;
+}
+export interface LoyaltyTier {
+    description: string;
+    hex_code: string;
+    name: string;
+    threshold: string;
+    discount: LoyaltyDiscount;
+}
+export interface CustomerLoyalty {
+    credit: LoyaltyCredit | null;
+    description: string;
+    loyalty_type: LoyaltyType;
+    name: string;
+    points: LoyaltyPoints | null;
+    redemption: LoyaltyRedemption | null;
+    remaining: string | null;
+    spend: LoyaltySpend;
+    status: LoyaltyStatus;
+    thresholds: Array<LoyaltyThreshold>;
+    tiers: Array<LoyaltyTier>;
+    towards: string | null;
+}
+export declare type CustomerLoyalties = Array<CustomerLoyalty>;

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

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

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

@@ -0,0 +1,126 @@
+import { DateString, ISOString, Time24, TimeHuman, TimezonePython } from '../../datetimes';
+import { Money, OrderType, 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;
+}
+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;
+}
+export interface OrderTime {
+    date: DateString;
+    end_time: Time24;
+    order_by: OrderBy;
+    start_time: Time24;
+    weekday: Weekday;
+}
+export declare type RevenueCenterOrderTimes = {
+    [key in ServiceType]: Array<OrderTime> | 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: OrderType;
+    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;
+        };
+    };
+}
+export declare type CustomerRevenueCenters = Array<CustomerRevenueCenter>;