@open-tender/types 0.0.10 → 0.0.12

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

@@ -1,4 +1,4 @@
-import { DisplayPage } from '../global';
+import { AuthType } from '../global';
 export interface Announcement {
     announcement_id: number;
     display_order: number;
@@ -27,7 +27,7 @@ export interface AnnouncementSettings {
     autoplay: boolean;
     duration: number;
     duration_mobile: number;
-    page: DisplayPage;
+    page: AuthType;
     show_arrows: boolean;
     show_arrows_mobile: boolean;
     show_dots: boolean;
@@ -41,7 +41,7 @@ export interface AnnouncementSettings {
 export declare type Announcements = Array<Announcement>;
 export interface AnnouncementPage {
     entities: Announcements;
-    page: DisplayPage;
+    page: AuthType;
     settings: AnnouncementSettings;
 }
 export declare type AnnouncementPages = Array<AnnouncementPage>;

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

@@ -109,6 +109,7 @@ export interface CustomerRevenueCenterSettings {
         [key in ServiceType]?: number;
     };
     excluded_times: ExcludedTimes | null;
+    service_types?: Array<ServiceType>;
 }
 export interface CustomerRevenueCenter {
     address: RevenueCenterAddress;
@@ -165,6 +166,9 @@ export interface CustomerRevenueCenter {
         };
     };
     settings?: CustomerRevenueCenterSettings;
+    distance?: number;
+    inZone?: boolean;
+    priority?: number;
 }
 export declare type CustomerRevenueCenters = Array<CustomerRevenueCenter>;
 export interface AvailableDates {

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

@@ -1,4 +1,4 @@
-import { DiscountType, DisplayPage, OrderType, ServiceType } from '../../global';
+import { DiscountType, AuthType, OrderType, ServiceType } from '../../global';
 import { MenuItems } from '../menu';
 import { OrderItemImage } from '../order';
 export interface DayPart {
@@ -14,7 +14,7 @@ export interface RewardItems {
 }
 export interface Reward {
     amount: string;
-    auth_type: DisplayPage;
+    auth_type: AuthType;
     dayparts: Array<DayPart>;
     description: string;
     discount_id: number;

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

@@ -0,0 +1,30 @@
+import { AuthType, DiscountType, Money, OrderType, ServiceType } from "../global";
+import { DayPart } from "./customer";
+import { DiscountedItems } from "./menu";
+import { OrderItemImage } from "./order";
+export interface Deal {
+    amount: Money;
+    auth_type: AuthType;
+    dayparts: Array<DayPart>;
+    description: string;
+    discount_id: number;
+    discount_type: DiscountType;
+    discounted_items: DiscountedItems;
+    end_date: string;
+    images: Array<OrderItemImage>;
+    max_amount: string;
+    max_order_size: string;
+    max_redemptions: number;
+    max_redemptions_per: number;
+    min_amount: string;
+    min_order_size: string;
+    name: string;
+    order_type: OrderType;
+    per_order: number;
+    required_items: DiscountedItems;
+    service_type: ServiceType;
+    short_description: string;
+    start_date: string;
+    title: string;
+}
+export declare type Deals = Array<Deal>;

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

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

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

@@ -133,3 +133,13 @@ export interface MenuVars {
     requestedAt: RequestedAt;
 }
 export declare type SoldOut = number[];
+export interface DiscountedItem {
+    id: number;
+    category_id: number;
+    name: string;
+    short_name: string;
+}
+export interface DiscountedItems {
+    items: Array<DiscountedItem>;
+    quantity: number;
+}

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

@@ -1,6 +1,6 @@
 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 { Address, Customer, CustomerAllergens, CustomerGiftCards, LoyaltyPoints } from './customer';
 import { PrepStatus, TicketStatus } from './kds';
 export interface OrderChannel {
     ext_id?: string | null;
@@ -15,8 +15,10 @@ export interface OrderDetails {
     person_count: number | null;
     serving_utensils: boolean;
     tax_exempt_id: string | null;
+    device_type: string;
 }
 export interface OrderDiscount {
+    discount_id?: number;
     amount: Money;
     description?: string | null;
     ext_id?: string | null;
@@ -52,6 +54,7 @@ export interface OrderRevenueCenter {
     revenue_center_id: number;
     revenue_center_type?: string;
     timezone?: TimezonePython;
+    distance?: number;
 }
 export interface OrderItemDiscount {
     discount_id: number;
@@ -175,7 +178,7 @@ export interface OrderSurcharge {
     description?: string;
     employee_id: number | null;
     id: number;
-    is_optinoal?: boolean;
+    is_optional?: boolean;
     is_taxed: boolean;
     label?: string;
     name: string;
@@ -425,3 +428,23 @@ export interface OrderItemCount {
     item: OrderItem;
     count: number;
 }
+export interface UnpreparedOrderData {
+    orderId: number;
+    revenueCenterId: number;
+    serviceType: ServiceType;
+    requestedAt: string;
+    cart: OrderCart;
+    customer: Customer;
+    address: Address | null;
+    details: OrderDetails;
+    surcharges: OrderSurcharge;
+    discounts: OrderDiscounts;
+    promoCodes: any;
+    points: LoyaltyPoints | number;
+    tip: number;
+    tenders: OrderTenders;
+    cartId: number | null;
+    deviceType: string;
+    prepType: string;
+    table: number;
+}

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

@@ -49,5 +49,6 @@ export interface RevenueCenter {
     temporary_delivery_wait_time_id: number | null;
     pickup_wait_time_id: number | null;
     temporary_pickup_wait_time_id: number | null;
+    distance?: number;
 }
 export declare type RevenueCenterType = 'POS' | 'OLO' | 'CATERING';

package/dist/cjs/types/global.d.ts

@@ -36,4 +36,4 @@ export interface PicklistOption {
     disabled?: boolean;
 }
 export declare type PicklistOptions = PicklistOption[];
-export declare type DisplayPage = 'GUEST' | 'ACCOUNT';
+export declare type AuthType = 'GUEST' | 'ACCOUNT';

package/dist/cjs/types/request.d.ts

@@ -8,6 +8,7 @@ export interface RequestErrorAPI {
     detail: string;
     status: number;
     params?: Record<string, string>;
+    message?: string;
 }
 export declare type RequestError = RequestErrorAPI | null | undefined;
 export declare type RequestStatus = 'idle' | 'pending';

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

@@ -1,4 +1,4 @@
-import { DisplayPage } from '../global';
+import { AuthType } from '../global';
 export interface Announcement {
     announcement_id: number;
     display_order: number;
@@ -27,7 +27,7 @@ export interface AnnouncementSettings {
     autoplay: boolean;
     duration: number;
     duration_mobile: number;
-    page: DisplayPage;
+    page: AuthType;
     show_arrows: boolean;
     show_arrows_mobile: boolean;
     show_dots: boolean;
@@ -41,7 +41,7 @@ export interface AnnouncementSettings {
 export declare type Announcements = Array<Announcement>;
 export interface AnnouncementPage {
     entities: Announcements;
-    page: DisplayPage;
+    page: AuthType;
     settings: AnnouncementSettings;
 }
 export declare type AnnouncementPages = Array<AnnouncementPage>;

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

@@ -109,6 +109,7 @@ export interface CustomerRevenueCenterSettings {
         [key in ServiceType]?: number;
     };
     excluded_times: ExcludedTimes | null;
+    service_types?: Array<ServiceType>;
 }
 export interface CustomerRevenueCenter {
     address: RevenueCenterAddress;
@@ -165,6 +166,9 @@ export interface CustomerRevenueCenter {
         };
     };
     settings?: CustomerRevenueCenterSettings;
+    distance?: number;
+    inZone?: boolean;
+    priority?: number;
 }
 export declare type CustomerRevenueCenters = Array<CustomerRevenueCenter>;
 export interface AvailableDates {

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

@@ -1,4 +1,4 @@
-import { DiscountType, DisplayPage, OrderType, ServiceType } from '../../global';
+import { DiscountType, AuthType, OrderType, ServiceType } from '../../global';
 import { MenuItems } from '../menu';
 import { OrderItemImage } from '../order';
 export interface DayPart {
@@ -14,7 +14,7 @@ export interface RewardItems {
 }
 export interface Reward {
     amount: string;
-    auth_type: DisplayPage;
+    auth_type: AuthType;
     dayparts: Array<DayPart>;
     description: string;
     discount_id: number;

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

@@ -0,0 +1,30 @@
+import { AuthType, DiscountType, Money, OrderType, ServiceType } from "../global";
+import { DayPart } from "./customer";
+import { DiscountedItems } from "./menu";
+import { OrderItemImage } from "./order";
+export interface Deal {
+    amount: Money;
+    auth_type: AuthType;
+    dayparts: Array<DayPart>;
+    description: string;
+    discount_id: number;
+    discount_type: DiscountType;
+    discounted_items: DiscountedItems;
+    end_date: string;
+    images: Array<OrderItemImage>;
+    max_amount: string;
+    max_order_size: string;
+    max_redemptions: number;
+    max_redemptions_per: number;
+    min_amount: string;
+    min_order_size: string;
+    name: string;
+    order_type: OrderType;
+    per_order: number;
+    required_items: DiscountedItems;
+    service_type: ServiceType;
+    short_description: string;
+    start_date: string;
+    title: string;
+}
+export declare type Deals = Array<Deal>;

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

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

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

@@ -133,3 +133,13 @@ export interface MenuVars {
     requestedAt: RequestedAt;
 }
 export declare type SoldOut = number[];
+export interface DiscountedItem {
+    id: number;
+    category_id: number;
+    name: string;
+    short_name: string;
+}
+export interface DiscountedItems {
+    items: Array<DiscountedItem>;
+    quantity: number;
+}

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

@@ -1,6 +1,6 @@
 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 { Address, Customer, CustomerAllergens, CustomerGiftCards, LoyaltyPoints } from './customer';
 import { PrepStatus, TicketStatus } from './kds';
 export interface OrderChannel {
     ext_id?: string | null;
@@ -15,8 +15,10 @@ export interface OrderDetails {
     person_count: number | null;
     serving_utensils: boolean;
     tax_exempt_id: string | null;
+    device_type: string;
 }
 export interface OrderDiscount {
+    discount_id?: number;
     amount: Money;
     description?: string | null;
     ext_id?: string | null;
@@ -52,6 +54,7 @@ export interface OrderRevenueCenter {
     revenue_center_id: number;
     revenue_center_type?: string;
     timezone?: TimezonePython;
+    distance?: number;
 }
 export interface OrderItemDiscount {
     discount_id: number;
@@ -175,7 +178,7 @@ export interface OrderSurcharge {
     description?: string;
     employee_id: number | null;
     id: number;
-    is_optinoal?: boolean;
+    is_optional?: boolean;
     is_taxed: boolean;
     label?: string;
     name: string;
@@ -425,3 +428,23 @@ export interface OrderItemCount {
     item: OrderItem;
     count: number;
 }
+export interface UnpreparedOrderData {
+    orderId: number;
+    revenueCenterId: number;
+    serviceType: ServiceType;
+    requestedAt: string;
+    cart: OrderCart;
+    customer: Customer;
+    address: Address | null;
+    details: OrderDetails;
+    surcharges: OrderSurcharge;
+    discounts: OrderDiscounts;
+    promoCodes: any;
+    points: LoyaltyPoints | number;
+    tip: number;
+    tenders: OrderTenders;
+    cartId: number | null;
+    deviceType: string;
+    prepType: string;
+    table: number;
+}

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

@@ -49,5 +49,6 @@ export interface RevenueCenter {
     temporary_delivery_wait_time_id: number | null;
     pickup_wait_time_id: number | null;
     temporary_pickup_wait_time_id: number | null;
+    distance?: number;
 }
 export declare type RevenueCenterType = 'POS' | 'OLO' | 'CATERING';

package/dist/esm/types/global.d.ts

@@ -36,4 +36,4 @@ export interface PicklistOption {
     disabled?: boolean;
 }
 export declare type PicklistOptions = PicklistOption[];
-export declare type DisplayPage = 'GUEST' | 'ACCOUNT';
+export declare type AuthType = 'GUEST' | 'ACCOUNT';

package/dist/esm/types/request.d.ts

@@ -8,6 +8,7 @@ export interface RequestErrorAPI {
     detail: string;
     status: number;
     params?: Record<string, string>;
+    message?: string;
 }
 export declare type RequestError = RequestErrorAPI | null | undefined;
 export declare type RequestStatus = 'idle' | 'pending';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@open-tender/types",
-  "version": "0.0.10",
+  "version": "0.0.12",
   "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",