@open-tender/types 0.1.6 → 0.1.8

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

@@ -1,7 +1,6 @@
-import { DiscountAuthType, DiscountType, Money, OrderType, ServiceType } from '../global';
+import { DiscountAuthType, DiscountType, Images, Money, OrderType, ServiceType } from '../global';
 import { DayPart } from './customer';
 import { DiscountedItems } from './menu';
-import { OrderItemImage } from './order';
 import { RevenueCenter } from './revenueCenter';
 export interface Deal {
     amount: Money;
@@ -12,7 +11,7 @@ export interface Deal {
     discount_type: DiscountType;
     discounted_items: DiscountedItems;
     end_date: string;
-    images: Array<OrderItemImage>;
+    images: Images;
     max_amount: string;
     max_order_size: string;
     max_redemptions: number;

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

@@ -1,8 +1,8 @@
 import { Money } from '../global';
-import { CreditCard } from './creditCards';
-export interface PurchaseDonationRequest {
+import { CreditCardData, CreditCardSaved } from './creditCards';
+export interface DonationPurchase {
     amount: Money;
-    credit_card: CreditCard;
+    credit_card: CreditCardData | CreditCardSaved;
     email: string;
     token?: string;
 }

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

@@ -17,6 +17,7 @@ export * from './messages';
 export * from './notifications';
 export * from './offlineAuths';
 export * from './order';
+export * from './pos';
 export * from './refund';
 export * from './revenueCenter';
 export * from './settings';

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

@@ -17,6 +17,7 @@ export * from './messages';
 export * from './notifications';
 export * from './offlineAuths';
 export * from './order';
+export * from './pos';
 export * from './refund';
 export * from './revenueCenter';
 export * from './settings';

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

@@ -1,20 +1,15 @@
 import { ISOStringOffset, RequestedAt, TimeHuman, TimezonePython } from '../datetimes';
-import { CardType, CardTypeName, DiscountAuthType, DiscountType, Money, NegativeMoney, OrderStatus, OrderType, ServiceType, TenderType } from '../global';
+import { CardType, CardTypeName, ChannelType, DiscountAuthType, DiscountType, Images, Money, NegativeMoney, OrderStatus, OrderType, ServiceType, TenderType } from '../global';
 import { CreditCard } from './creditCards';
 import { Address } from './customer';
 import { PrepStatus } from './kds';
 import { NutritionalInfo } from './menu';
-export interface OrderItemImage {
-    type: 'LARGE_IMAGE' | 'SMALL_IMAGE' | 'APP_IMAGE';
-    url: string | null;
-}
-export declare type OrderItemImages = OrderItemImage[];
 export interface OrderItem {
     allergens: string[];
     description: string | null;
     groups: OrderItemGroups;
     id: number;
-    images: OrderItemImages;
+    images: Images;
     ingredients: string | null;
     made_for?: string | null;
     name: string;
@@ -184,7 +179,7 @@ export interface OrderTax {
     is_optional: boolean;
     name: string;
 }
-export declare type OrderTaxes = OrderTax;
+export declare type OrderTaxes = OrderTax[];
 export interface OrderTenderCreditCard {
     amount: Money;
     credit_card: CreditCard;
@@ -250,6 +245,11 @@ export interface Order {
     totals: OrderTotals;
 }
 export declare type Orders = Order[];
+export interface OrderChannel {
+    ext_id?: string | null;
+    ext_name?: string | null;
+    type: ChannelType;
+}
 export interface DisplayItem {
     allergens: string[];
     cals: number | null;

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

@@ -1,7 +1,9 @@
-import { DateString, ISOStringOffset } from '../datetimes';
-import { ChannelType, Decimal, Money, NegativeMoney, ReceiptType, SurchargeType } from '../global';
+import { DateString, ISOStringOffset, TimeString } from '../datetimes';
+import { ChannelType, Decimal, Money, NegativeMoney, OrderType, ReceiptType, ServiceType, SurchargeType, TaxType, Weekday } from '../global';
+import { PunchAuthType } from './employee';
 import { PrepStatus, TicketStatus } from './kds';
 import { Order, OrderCart, OrderItem } from './order';
+import { PaymentProcessing } from './store';
 export interface PosOrderItemGroup {
     id: number;
     name: string;
@@ -74,7 +76,7 @@ export interface OrderBucket {
     end: Date;
 }
 export declare type OrderBuckets = Array<OrderBucket>;
-export interface OrderTimes {
+export interface PosOrderTimes {
     delayed: number;
     requested: Date;
     requestedTime: string;
@@ -161,3 +163,52 @@ export interface PosOrderSurcharge {
     taxes: Array<OrderSurchargeTax>;
 }
 export declare type PosOrderSurcharges = Array<PosOrderSurcharge>;
+export interface PosRevenueCenterTax {
+    amount: Decimal;
+    display_order: number;
+    is_active: boolean;
+    is_optional: boolean;
+    name: string;
+    tax_id: number;
+    tax_type: TaxType;
+}
+export interface PosRevenueCenter {
+    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<PosRevenueCenterTax>;
+    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;
+    distance?: number;
+}

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

@@ -1,54 +1,167 @@
-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;
+import { DateString, ISOString, Time24, TimeHuman, TimezonePython } from '../datetimes';
+import { Images, Money, ServiceType, Weekday } from '../global';
+export interface RevenueCenterParams {
+    type: string;
+    is_outpost?: boolean;
+    lat?: number;
+    lng?: number;
+    requestedAt?: string;
+}
+export declare type RevenueCenterType = 'POS' | 'OLO' | 'CATERING';
+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: number[][];
+    description: string | null;
+    priority: number | null;
+}
+export declare type ExcludedTime = {
+    [key: DateString]: number[];
+};
+export declare type ExcludedTimes = {
+    [key in ServiceType]: ExcludedTime;
+};
+export interface FirstTime {
+    date: DateString;
+    has_asap: boolean;
+    minutes: number;
+    time: TimeHuman;
+    utc: ISOString;
+    wait_minutes: number | null;
+    weekday: Weekday;
+}
+export declare type FirstTimes = {
+    [key in ServiceType]: FirstTime;
+};
+export interface GroupOrdering {
+    guest_limit: number | null;
+    lead_time: number;
+    prep_time: number;
+}
+export interface HoursWeekday {
+    close: Time24 | null;
+    holiday: string | null;
+    open: Time24 | null;
+    weekday: Weekday;
+}
+export declare type Hours = {
+    [key in ServiceType]: HoursWeekday[] | null;
+} & {
+    description: string;
+};
+export interface ValidTime {
+    is_orderable: boolean;
+    minutes: number;
+    time: string;
+}
+export declare type ValidTimeList = ValidTime[];
+export declare type ValidTimes = {
+    [key in ServiceType]: {
+        [key in Weekday]: ValidTimeList | null;
+    } | null;
+};
+export interface HolidayHours extends HoursWeekday {
+    valid_times: ValidTimeList;
+}
+export declare type Holidays = {
+    [key: DateString]: {
+        [key in ServiceType]: HolidayHours | null;
+    };
+};
+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 OrderTimes = {
+    [key in ServiceType]: OrderTime[] | null;
+};
+export interface OrderByWithDate {
+    date: Date;
+    time: Time24;
+    weekday: Weekday;
+}
+export interface OrderTimeWithDate {
+    date: Date;
+    end_time: Time24;
+    order_by: OrderByWithDate;
+    start_time: Time24;
+    weekday: Weekday;
+    iso: ISOString;
+}
+export declare type OrderTimesWithDate = {
+    [key in ServiceType]: OrderTimeWithDate[] | null;
+};
+export declare type RevenueCenterStatus = 'CLOSED' | 'CLOSED_TEMPORARILY' | 'COMING_SOON' | 'HIDDEN' | 'OPEN';
+export interface RevenueCenterUser {
+    distance_from: number;
+    in_delivery_zone: boolean;
 }
 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;
+    address: RevenueCenterAddress;
+    cutoff_time: TimeHuman | null;
+    days_ahead: number;
+    delivery_url: string;
+    delivery_zone: DeliveryZone;
+    description: string | null;
+    directions_url: string | null;
+    distance?: number;
+    excluded_times: ExcludedTimes | null;
+    first_times: FirstTimes | null;
+    group_ordering: GroupOrdering;
+    has_curbside: boolean;
+    holidays: Holidays | null;
+    hours: Hours;
+    images: Images;
+    inZone?: boolean;
+    is_new: boolean;
     is_outpost: boolean;
-    is_temporarily_closed: boolean;
-    item_discount_approval: boolean;
+    is_parent: boolean;
+    lead_time_in_hours: number | null;
+    menu_pdf_url: string | null;
     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;
+    order_maximum: {
+        [key in ServiceType]: Money;
+    };
+    order_minimum: {
+        [key in ServiceType]: Money;
+    };
+    order_times: OrderTimes;
+    priority?: number;
     revenue_center_id: number;
-    revenue_center_type: OrderType;
-    send_offline_alerts: boolean;
-    service_types: Array<ServiceType>;
-    short_name: string;
+    revenue_center_type: RevenueCenterType;
+    service_types: ServiceType[];
     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;
-    distance?: number;
+    status: RevenueCenterStatus;
+    tax_exempt_is_allowed: boolean;
+    time_ranges: {
+        [key in ServiceType]: number | null;
+    };
+    timezone: TimezonePython;
+    user: RevenueCenterUser | null;
+    valid_times: ValidTimes | null;
+    wait_times: {
+        [key in ServiceType]: number;
+    };
 }
-export declare type RevenueCenterType = 'POS' | 'OLO' | 'CATERING';
+export declare type RevenueCenters = RevenueCenter[];
+export interface RevenueCenterWithDistance extends RevenueCenter {
+    distance: number;
+    inZone: boolean;
+    priority: number;
+}
+export declare type RevenueCentersWithDistance = RevenueCenterWithDistance[];

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

@@ -15,7 +15,7 @@ export declare type FullOrderType = OrderType | 'MAIN_MENU' | 'ECOMMERCE';
 export declare type OrderTypeMap = {
     [Property in OrderType]: string;
 };
-export declare type ServiceType = 'WALKIN' | 'PICKUP' | 'DELIVERY' | 'PORTAL' | 'OUTPOST';
+export declare type ServiceType = 'WALKIN' | 'PICKUP' | 'DELIVERY';
 export declare type ServiceTypeMap = {
     [Property in ServiceType]: string;
 };
@@ -44,3 +44,9 @@ export interface PicklistOption {
 export declare type PicklistOptions = PicklistOption[];
 export declare type DeviceType = 'DESKTOP' | 'KIOSK' | 'MOBILE' | 'NONE' | 'TABLET';
 export declare type PrepType = 'EAT_HERE' | 'TAKE_OUT';
+export declare type ImageType = 'APP_IMAGE' | 'LARGE_IMAGE' | 'SMALL_IMAGE';
+export interface Image {
+    type: ImageType;
+    url: string;
+}
+export declare type Images = Image[];

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

@@ -8,7 +8,7 @@ export interface RequestErrorMessage {
     message: string;
     title: string;
 }
-export declare type RequestErrorParams = Record<string, RequestErrorMessage>;
+export declare type RequestErrorParams = Record<string, string>;
 export interface RequestErrorAPI extends RequestErrorMessage {
     status: number;
     params?: RequestErrorParams;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@open-tender/types",
-  "version": "0.1.6",
+  "version": "0.1.8",
   "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/types/api/customer/revenueCenters.d.ts

@@ -1,187 +0,0 @@
-import { DateString, ISOString, Time24, TimeHuman, TimezonePython } from '../../datetimes';
-import { Money, ServiceType, Weekday } from '../../global';
-import { OrderItemImages } from '../order';
-import { RevenueCenterType } from '../revenueCenter';
-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;
-    interval?: number;
-}
-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;
-    interval: number;
-    times: ValidTimes | null;
-}
-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;
-    date: Date | string;
-}
-export interface OrderTime {
-    date: DateString | Date;
-    end_time: Time24;
-    order_by: OrderBy;
-    start_time: Time24;
-    weekday: Weekday;
-    iso?: ISOString;
-}
-export declare type RevenueCenterOrderTimes = {
-    [key in ServiceType]: Array<OrderTime> | null;
-};
-export interface CustomerRevenueCenterSettings {
-    cutoff_time: string;
-    days_ahead: {
-        [key in ServiceType]?: number;
-    };
-    first_times: {
-        [key in ServiceType]?: FirstTime | null;
-    };
-    group_ordering: RevenueCenterGroupOrdering;
-    holidays: {
-        [key: DateString]: {
-            [key in ServiceType]?: HolidayItem | null;
-        };
-    };
-    lead_time_in_hours: number;
-    order_maximum: {
-        [key in ServiceType]: Money;
-    };
-    order_minimum: {
-        [key in ServiceType]: Money;
-    };
-    order_times: RevenueCenterOrderTimes;
-    tax_exempt_is_allowed: boolean;
-    time_ranges: {
-        [key in ServiceType]: number | null;
-    };
-    valid_times: {
-        [key in ServiceType]?: {
-            [key in Weekday]?: ValidTimes;
-        };
-    };
-    wait_times: {
-        [key in ServiceType]?: number;
-    };
-    excluded_times: ExcludedTimes | null;
-    service_types?: Array<ServiceType>;
-}
-export declare type CustomerRevenueCenterHours = {
-    [key in ServiceType]?: Array<Hours>;
-} & {
-    description?: string;
-};
-export interface CustomerRevenueCenter {
-    id?: number | null;
-    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: CustomerRevenueCenterHours;
-    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: RevenueCenterType;
-    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;
-        };
-    };
-    settings?: CustomerRevenueCenterSettings;
-    distance?: number;
-    inZone?: boolean;
-    priority?: number;
-    images?: OrderItemImages;
-    app_image_url?: string;
-    hours_desc?: string;
-}
-export declare type CustomerRevenueCenters = Array<CustomerRevenueCenter>;
-export interface AvailableDates {
-    minDate: Date | null;
-    maxDate: Date | null;
-    excludeDates: Array<Date>;
-    filterDate: (date: Date) => boolean;
-}

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

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