@open-tender/types 0.4.34 → 0.4.36

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (13) hide show
  1. package/dist/cjs/types/api/customer/customer.d.ts +2 -1
  2. package/dist/cjs/types/api/index.d.ts +1 -0
  3. package/dist/cjs/types/api/index.js +1 -0
  4. package/dist/cjs/types/api/kiosk.d.ts +33 -0
  5. package/dist/cjs/types/api/kiosk.js +2 -0
  6. package/dist/cjs/types/api/store.d.ts +10 -21
  7. package/dist/esm/types/api/customer/customer.d.ts +2 -1
  8. package/dist/esm/types/api/index.d.ts +1 -0
  9. package/dist/esm/types/api/index.js +1 -0
  10. package/dist/esm/types/api/kiosk.d.ts +33 -0
  11. package/dist/esm/types/api/kiosk.js +1 -0
  12. package/dist/esm/types/api/store.d.ts +10 -21
  13. package/package.json +1 -1
package/dist/cjs/types/api/customer/customer.d.ts CHANGED
@@ -40,10 +40,11 @@ export interface Brand {
40
40
  name: string;
41
41
  }
42
42
  export declare type Brands = Brand[];
43
- declare type CustomerEndpoint = 'ACCOUNT' | 'GIFT_CARDS' | 'FAVORITES' | 'LOYALTY' | 'REWARDS' | 'ORDERS';
43
+ declare type CustomerEndpoint = 'ACCOUNT' | 'DEALS' | 'GIFT_CARDS' | 'FAVORITES' | 'LOYALTY' | 'REWARDS' | 'ORDERS';
44
44
  export declare type CustomerEndpoints = CustomerEndpoint[];
45
45
  export interface CustomerEntities {
46
46
  ACCOUNT?: Customer;
47
+ DEALS?: Discounts;
47
48
  GIFT_CARDS?: GiftCards;
48
49
  FAVORITES?: Favorites;
49
50
  LOYALTY?: LoyaltyPrograms;
package/dist/cjs/types/api/index.d.ts CHANGED
@@ -17,6 +17,7 @@ export * from './favorite';
17
17
  export * from './giftCard';
18
18
  export * from './itemTypes';
19
19
  export * from './kds';
20
+ export * from './kiosk';
20
21
  export * from './menu';
21
22
  export * from './menuPages';
22
23
  export * from './messages';
package/dist/cjs/types/api/index.js CHANGED
@@ -20,6 +20,7 @@ tslib_1.__exportStar(require("./favorite"), exports);
20
20
  tslib_1.__exportStar(require("./giftCard"), exports);
21
21
  tslib_1.__exportStar(require("./itemTypes"), exports);
22
22
  tslib_1.__exportStar(require("./kds"), exports);
23
+ tslib_1.__exportStar(require("./kiosk"), exports);
23
24
  tslib_1.__exportStar(require("./menu"), exports);
24
25
  tslib_1.__exportStar(require("./menuPages"), exports);
25
26
  tslib_1.__exportStar(require("./messages"), exports);
package/dist/cjs/types/api/kiosk.d.ts ADDED
@@ -0,0 +1,33 @@
1
+ import { AppTheme } from './theme';
2
+ export interface Dimensions {
3
+ width: number;
4
+ height: number;
5
+ }
6
+ export declare type KioskContent = Record<string, unknown>;
7
+ export declare type KioskStyles = Record<string, Record<string, string | number>>;
8
+ export interface KioskBrand {
9
+ email: string;
10
+ logo: string;
11
+ logoLight: string;
12
+ }
13
+ export interface KioskDisplaySettings {
14
+ hasCustomize: boolean;
15
+ showAllergens: boolean;
16
+ showCals: boolean;
17
+ showDesc: boolean;
18
+ showMadeFor: boolean;
19
+ showNotes: boolean;
20
+ showQuickAdd: boolean;
21
+ showTags: boolean;
22
+ skipToCustomize: boolean;
23
+ }
24
+ export interface KioskSettings {
25
+ ratio: number;
26
+ displaySettings: KioskDisplaySettings;
27
+ }
28
+ export interface KioskConfig {
29
+ brand: KioskBrand;
30
+ content: KioskContent;
31
+ settings: KioskSettings;
32
+ theme: AppTheme;
33
+ }
package/dist/cjs/types/api/kiosk.js ADDED
@@ -0,0 +1,2 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
package/dist/cjs/types/api/store.d.ts CHANGED
@@ -1,6 +1,5 @@
1
- import { TimeString, TimezonePython } from '../datetimes';
2
- import { Decimal, Money, ServiceType, TenderType, Url, Weekday } from '../global';
3
- import { RevenueCenterType } from './revenueCenter';
1
+ import { TimeString } from '../datetimes';
2
+ import { Decimal, Money, ServiceType, TenderType, Weekday } from '../global';
4
3
  export declare type PaymentProcessor = 'NONE' | 'CARDCONNECT' | 'VANTIV' | 'CLOVER' | 'NMI';
5
4
  export interface PaymentProcessing {
6
5
  integration: PaymentProcessor;
@@ -16,25 +15,23 @@ export interface PaymentProcessing {
16
15
  export interface StoreTax {
17
16
  amount: Decimal;
18
17
  display_order: number;
19
- id: number;
20
- is_active: boolean;
21
18
  is_optional: boolean;
22
19
  name: string;
23
20
  tax_id: number;
24
21
  tax_type: number;
25
22
  }
26
23
  export interface StoreTenderTypes {
27
- DELIVERY: Array<TenderType>;
28
- PICKUP: Array<TenderType>;
29
- WALKIN: Array<TenderType>;
24
+ DELIVERY: TenderType[];
25
+ PICKUP: TenderType[];
26
+ WALKIN: TenderType[];
30
27
  }
31
28
  export interface StoreAddress {
32
29
  city: string;
33
30
  cross_streets: string;
34
31
  directions_link: string;
35
32
  fax: string | null;
36
- latitude: Decimal;
37
- longitude: Decimal;
33
+ latitude: string;
34
+ longitude: string;
38
35
  phone: string | null;
39
36
  postal_code: string;
40
37
  state: string;
@@ -57,9 +54,8 @@ export interface StoreMessage {
57
54
  }
58
55
  export interface Store {
59
56
  address: StoreAddress;
60
- auth_type: 'PIN' | 'CARD';
61
57
  alert_minutes: number;
62
- closed: boolean;
58
+ auth_type: 'PIN' | 'CARD';
63
59
  credit: PaymentProcessing;
64
60
  delivery_minutes: number;
65
61
  dine_in_prompt: boolean;
@@ -74,16 +70,11 @@ export interface Store {
74
70
  has_loyalty: boolean;
75
71
  hide_default_mods: boolean;
76
72
  hide_delay: boolean;
77
- is_closed: boolean;
78
73
  is_outpost: boolean;
79
- is_temporarily_closed: boolean;
80
74
  item_discount_approval: boolean;
81
- levelup?: LevelUp;
82
- messages: Array<StoreMessage> | null;
83
75
  name: string;
84
76
  number: string;
85
77
  order_page_swipe: boolean;
86
- origin: Url | null;
87
78
  overtime_threshold: number;
88
79
  overtime_threshold_daily: number;
89
80
  page_timeout: number;
@@ -95,16 +86,14 @@ export interface Store {
95
86
  receipt_header: string;
96
87
  receipt_phone: boolean;
97
88
  revenue_center_id: number;
98
- revenue_center_type: RevenueCenterType;
99
- service_types: Array<ServiceType>;
89
+ service_types: ServiceType[];
100
90
  short_name: string;
101
91
  slug: string;
102
92
  starting_cash: Decimal;
103
93
  store_id: number;
104
94
  tax_exempt_approval: boolean;
105
- taxes: Array<StoreTax>;
95
+ taxes: StoreTax[];
106
96
  tender_types: StoreTenderTypes;
107
- timezone: TimezonePython;
108
97
  walkin_minutes: number;
109
98
  walkin_prep_minutes: number;
110
99
  warning_minutes: number;
package/dist/esm/types/api/customer/customer.d.ts CHANGED
@@ -40,10 +40,11 @@ export interface Brand {
40
40
  name: string;
41
41
  }
42
42
  export declare type Brands = Brand[];
43
- declare type CustomerEndpoint = 'ACCOUNT' | 'GIFT_CARDS' | 'FAVORITES' | 'LOYALTY' | 'REWARDS' | 'ORDERS';
43
+ declare type CustomerEndpoint = 'ACCOUNT' | 'DEALS' | 'GIFT_CARDS' | 'FAVORITES' | 'LOYALTY' | 'REWARDS' | 'ORDERS';
44
44
  export declare type CustomerEndpoints = CustomerEndpoint[];
45
45
  export interface CustomerEntities {
46
46
  ACCOUNT?: Customer;
47
+ DEALS?: Discounts;
47
48
  GIFT_CARDS?: GiftCards;
48
49
  FAVORITES?: Favorites;
49
50
  LOYALTY?: LoyaltyPrograms;
package/dist/esm/types/api/index.d.ts CHANGED
@@ -17,6 +17,7 @@ export * from './favorite';
17
17
  export * from './giftCard';
18
18
  export * from './itemTypes';
19
19
  export * from './kds';
20
+ export * from './kiosk';
20
21
  export * from './menu';
21
22
  export * from './menuPages';
22
23
  export * from './messages';
package/dist/esm/types/api/index.js CHANGED
@@ -17,6 +17,7 @@ export * from './favorite';
17
17
  export * from './giftCard';
18
18
  export * from './itemTypes';
19
19
  export * from './kds';
20
+ export * from './kiosk';
20
21
  export * from './menu';
21
22
  export * from './menuPages';
22
23
  export * from './messages';
package/dist/esm/types/api/kiosk.d.ts ADDED
@@ -0,0 +1,33 @@
1
+ import { AppTheme } from './theme';
2
+ export interface Dimensions {
3
+ width: number;
4
+ height: number;
5
+ }
6
+ export declare type KioskContent = Record<string, unknown>;
7
+ export declare type KioskStyles = Record<string, Record<string, string | number>>;
8
+ export interface KioskBrand {
9
+ email: string;
10
+ logo: string;
11
+ logoLight: string;
12
+ }
13
+ export interface KioskDisplaySettings {
14
+ hasCustomize: boolean;
15
+ showAllergens: boolean;
16
+ showCals: boolean;
17
+ showDesc: boolean;
18
+ showMadeFor: boolean;
19
+ showNotes: boolean;
20
+ showQuickAdd: boolean;
21
+ showTags: boolean;
22
+ skipToCustomize: boolean;
23
+ }
24
+ export interface KioskSettings {
25
+ ratio: number;
26
+ displaySettings: KioskDisplaySettings;
27
+ }
28
+ export interface KioskConfig {
29
+ brand: KioskBrand;
30
+ content: KioskContent;
31
+ settings: KioskSettings;
32
+ theme: AppTheme;
33
+ }
package/dist/esm/types/api/kiosk.js ADDED
@@ -0,0 +1 @@
1
+ export {};
package/dist/esm/types/api/store.d.ts CHANGED
@@ -1,6 +1,5 @@
1
- import { TimeString, TimezonePython } from '../datetimes';
2
- import { Decimal, Money, ServiceType, TenderType, Url, Weekday } from '../global';
3
- import { RevenueCenterType } from './revenueCenter';
1
+ import { TimeString } from '../datetimes';
2
+ import { Decimal, Money, ServiceType, TenderType, Weekday } from '../global';
4
3
  export declare type PaymentProcessor = 'NONE' | 'CARDCONNECT' | 'VANTIV' | 'CLOVER' | 'NMI';
5
4
  export interface PaymentProcessing {
6
5
  integration: PaymentProcessor;
@@ -16,25 +15,23 @@ export interface PaymentProcessing {
16
15
  export interface StoreTax {
17
16
  amount: Decimal;
18
17
  display_order: number;
19
- id: number;
20
- is_active: boolean;
21
18
  is_optional: boolean;
22
19
  name: string;
23
20
  tax_id: number;
24
21
  tax_type: number;
25
22
  }
26
23
  export interface StoreTenderTypes {
27
- DELIVERY: Array<TenderType>;
28
- PICKUP: Array<TenderType>;
29
- WALKIN: Array<TenderType>;
24
+ DELIVERY: TenderType[];
25
+ PICKUP: TenderType[];
26
+ WALKIN: TenderType[];
30
27
  }
31
28
  export interface StoreAddress {
32
29
  city: string;
33
30
  cross_streets: string;
34
31
  directions_link: string;
35
32
  fax: string | null;
36
- latitude: Decimal;
37
- longitude: Decimal;
33
+ latitude: string;
34
+ longitude: string;
38
35
  phone: string | null;
39
36
  postal_code: string;
40
37
  state: string;
@@ -57,9 +54,8 @@ export interface StoreMessage {
57
54
  }
58
55
  export interface Store {
59
56
  address: StoreAddress;
60
- auth_type: 'PIN' | 'CARD';
61
57
  alert_minutes: number;
62
- closed: boolean;
58
+ auth_type: 'PIN' | 'CARD';
63
59
  credit: PaymentProcessing;
64
60
  delivery_minutes: number;
65
61
  dine_in_prompt: boolean;
@@ -74,16 +70,11 @@ export interface Store {
74
70
  has_loyalty: boolean;
75
71
  hide_default_mods: boolean;
76
72
  hide_delay: boolean;
77
- is_closed: boolean;
78
73
  is_outpost: boolean;
79
- is_temporarily_closed: boolean;
80
74
  item_discount_approval: boolean;
81
- levelup?: LevelUp;
82
- messages: Array<StoreMessage> | null;
83
75
  name: string;
84
76
  number: string;
85
77
  order_page_swipe: boolean;
86
- origin: Url | null;
87
78
  overtime_threshold: number;
88
79
  overtime_threshold_daily: number;
89
80
  page_timeout: number;
@@ -95,16 +86,14 @@ export interface Store {
95
86
  receipt_header: string;
96
87
  receipt_phone: boolean;
97
88
  revenue_center_id: number;
98
- revenue_center_type: RevenueCenterType;
99
- service_types: Array<ServiceType>;
89
+ service_types: ServiceType[];
100
90
  short_name: string;
101
91
  slug: string;
102
92
  starting_cash: Decimal;
103
93
  store_id: number;
104
94
  tax_exempt_approval: boolean;
105
- taxes: Array<StoreTax>;
95
+ taxes: StoreTax[];
106
96
  tender_types: StoreTenderTypes;
107
- timezone: TimezonePython;
108
97
  walkin_minutes: number;
109
98
  walkin_prep_minutes: number;
110
99
  warning_minutes: number;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@open-tender/types",
3
- "version": "0.4.34",
3
+ "version": "0.4.36",
4
4
  "description": "A library of types for use with Open Tender applications that utilize our cloud-based Order API.",
5
5
  "main": "./dist/cjs/index.js",
6
6
  "module": "./dist/esm/index.js",