@open-tender/types 0.0.4 → 0.0.5

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@open-tender/types",
-  "version": "0.0.4",
+  "version": "0.0.5",
   "description": "A library of types for use with Open Tender applications that utilize our cloud-based Order API.",
   "main": "./dist/cjs/index.js",
   "module": "./dist/esm/index.js",

package/dist/cjs/index.d.ts

@@ -1 +0,0 @@
-export * from './types';

package/dist/cjs/index.js

@@ -1,4 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const tslib_1 = require("tslib");
-tslib_1.__exportStar(require("./types"), exports);

package/dist/cjs/types/api/alerts.d.ts

@@ -1,5 +0,0 @@
-export interface Alert {
-    message: string;
-    id: string;
-}
-export declare type Alerts = Array<Alert>;

package/dist/cjs/types/api/alerts.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/types/api/allergens.d.ts

@@ -1,7 +0,0 @@
-export interface Allergen {
-    allergen_id: number;
-    description?: string;
-    images?: string[];
-    name?: string;
-}
-export declare type Allergens = Array<Allergen>;

package/dist/cjs/types/api/allergens.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/types/api/announcements.d.ts

@@ -1,47 +0,0 @@
-import { DisplayPage } from '../global';
-export interface Announcement {
-    announcement_id: number;
-    display_order: number;
-    hide_text: boolean;
-    hide_text_mobile: boolean;
-    horizontal: string;
-    images: string[];
-    overlay_color: string;
-    overlay_opacity: number;
-    show_overlay: boolean;
-    subtitle: string;
-    subtitle_color: string;
-    subtitle_size: number | string | null;
-    text_color: string;
-    title: string;
-    title_color: string;
-    title_size: number | string | null;
-    url: string | null;
-    url_text: string | null;
-    vertical: string;
-}
-export interface AnnouncementSettings {
-    announcement_page_id: number;
-    arrows_horizontal: string;
-    arrows_vertical: string;
-    autoplay: boolean;
-    duration: number;
-    duration_mobile: number;
-    page: DisplayPage;
-    show_arrows: boolean;
-    show_arrows_mobile: boolean;
-    show_dots: boolean;
-    show_dots_mobile: boolean;
-    subtitle: string | null;
-    title: string | null;
-    transition: number;
-    transition_mobile: number;
-    transition_type: string;
-}
-export declare type Announcements = Array<Announcement>;
-export interface AnnouncementPage {
-    entities: Announcements;
-    page: DisplayPage;
-    settings: AnnouncementSettings;
-}
-export declare type AnnouncementPages = Array<AnnouncementPage>;

package/dist/cjs/types/api/announcements.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/types/api/arrivals.d.ts

@@ -1,14 +0,0 @@
-import { ISOStringOffset } from '../datetimes';
-import { Customer } from './customer';
-export interface Arrival {
-    arrived_utc: ISOStringOffset;
-    arrival_info: string | null;
-    customer?: Customer | null;
-    has_arrived: boolean;
-    order_id: number;
-    order_uuid: string;
-    vehicle_type: string | null;
-    vehicle_color: string | null;
-    vehicle_id: string | null;
-}
-export declare type Arrivals = Array<Arrival>;

package/dist/cjs/types/api/arrivals.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/types/api/cart.d.ts

@@ -1,76 +0,0 @@
-import { NutritionalInfo } from './menu';
-export interface GuestItem {
-    cart_guest_id?: number | null;
-    customer_id?: number | null;
-    made_for: string | null;
-    notes: string | null;
-}
-export interface CartItemOption {
-    id: number;
-    name: string;
-    shortName: string;
-    description: string | null;
-    imageUrl: string | null;
-    allergens: string[];
-    tags: string[];
-    ingredients: string | null;
-    nutritionalInfo: NutritionalInfo | null;
-    cals: number | null;
-    price: number;
-    quantity: number;
-    isDefault: boolean;
-    increment: number;
-    max: number;
-    min: number;
-    isSoldOut: boolean;
-    points: number;
-    totalPrice: number;
-    totalPoints: number | null;
-    totalCals: number | null;
-}
-export declare type CartItemOptions = Array<CartItemOption>;
-export interface CartItemGroup {
-    id: number;
-    name: string;
-    description: string | null;
-    imageUrl: string | null;
-    included: number;
-    max: number;
-    min: number;
-    isSize: boolean;
-    options: CartItemOptions;
-}
-export declare type CartItemGroups = Array<CartItemGroup>;
-export interface CartItem {
-    index?: number;
-    id: number;
-    name: string;
-    shortName: string;
-    cart_guest_id?: number | null;
-    category: string;
-    customer_id?: number | null;
-    description: string | null;
-    imageUrl: string | null;
-    slug: string;
-    allergens: string[];
-    tags: string[];
-    ingredients: string | null;
-    madeFor?: string | null;
-    notes?: string | null;
-    nutritionalInfo: NutritionalInfo | null;
-    cals: number | null;
-    groups: CartItemGroups;
-    quantity: number;
-    price: number;
-    increment: number;
-    max: number;
-    min: number;
-    points: number | null;
-    upsellItems: number[];
-    similarItems: number[];
-    totalPrice: number;
-    totalPoints: number | null;
-    totalCals: number | null;
-}
-export declare type Cart = Array<CartItem>;
-export declare type CartCounts = Record<string, number>;

package/dist/cjs/types/api/cart.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -1,173 +0,0 @@
-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/cjs/types/api/checkout.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -1,42 +0,0 @@
-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/cjs/types/api/completedOrders.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -1,47 +0,0 @@
-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/cjs/types/api/config.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -1,11 +0,0 @@
-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/cjs/types/api/creditCards.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -1,22 +0,0 @@
-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/cjs/types/api/customer/account.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -1,20 +0,0 @@
-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/cjs/types/api/customer/addresses.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

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

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

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

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -1,10 +0,0 @@
-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/cjs/types/api/customer/communicationPreferences.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -1,27 +0,0 @@
-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/cjs/types/api/customer/customer.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -1,12 +0,0 @@
-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/cjs/types/api/customer/giftCards.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -1,33 +0,0 @@
-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/cjs/types/api/customer/groupOrders.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -1,13 +0,0 @@
-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>;