@open-tender/types 0.4.157 → 0.4.158

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 (237) hide show
  1. package/package.json +1 -1
  2. package/dist/cjs/index.d.ts +0 -1
  3. package/dist/cjs/index.js +0 -4
  4. package/dist/cjs/types/api/alerts.d.ts +0 -5
  5. package/dist/cjs/types/api/alerts.js +0 -2
  6. package/dist/cjs/types/api/allergens.d.ts +0 -13
  7. package/dist/cjs/types/api/allergens.js +0 -2
  8. package/dist/cjs/types/api/announcements.d.ts +0 -57
  9. package/dist/cjs/types/api/announcements.js +0 -2
  10. package/dist/cjs/types/api/arrivals.d.ts +0 -14
  11. package/dist/cjs/types/api/arrivals.js +0 -2
  12. package/dist/cjs/types/api/cart.d.ts +0 -117
  13. package/dist/cjs/types/api/cart.js +0 -2
  14. package/dist/cjs/types/api/checkout.d.ts +0 -376
  15. package/dist/cjs/types/api/checkout.js +0 -29
  16. package/dist/cjs/types/api/completedOrders.d.ts +0 -42
  17. package/dist/cjs/types/api/completedOrders.js +0 -2
  18. package/dist/cjs/types/api/config.d.ts +0 -565
  19. package/dist/cjs/types/api/config.js +0 -2
  20. package/dist/cjs/types/api/creditCards.d.ts +0 -42
  21. package/dist/cjs/types/api/creditCards.js +0 -2
  22. package/dist/cjs/types/api/customer/account.d.ts +0 -26
  23. package/dist/cjs/types/api/customer/account.js +0 -2
  24. package/dist/cjs/types/api/customer/addresses.d.ts +0 -24
  25. package/dist/cjs/types/api/customer/addresses.js +0 -2
  26. package/dist/cjs/types/api/customer/allergens.d.ts +0 -5
  27. package/dist/cjs/types/api/customer/allergens.js +0 -2
  28. package/dist/cjs/types/api/customer/communicationPreferences.d.ts +0 -12
  29. package/dist/cjs/types/api/customer/communicationPreferences.js +0 -2
  30. package/dist/cjs/types/api/customer/customer.d.ts +0 -55
  31. package/dist/cjs/types/api/customer/customer.js +0 -2
  32. package/dist/cjs/types/api/customer/giftCards.d.ts +0 -37
  33. package/dist/cjs/types/api/customer/giftCards.js +0 -2
  34. package/dist/cjs/types/api/customer/groupOrders.d.ts +0 -62
  35. package/dist/cjs/types/api/customer/groupOrders.js +0 -11
  36. package/dist/cjs/types/api/customer/houseAccounts.d.ts +0 -21
  37. package/dist/cjs/types/api/customer/houseAccounts.js +0 -2
  38. package/dist/cjs/types/api/customer/identify.d.ts +0 -46
  39. package/dist/cjs/types/api/customer/identify.js +0 -2
  40. package/dist/cjs/types/api/customer/index.d.ts +0 -13
  41. package/dist/cjs/types/api/customer/index.js +0 -17
  42. package/dist/cjs/types/api/customer/loyalty.d.ts +0 -70
  43. package/dist/cjs/types/api/customer/loyalty.js +0 -2
  44. package/dist/cjs/types/api/customer/qrcode.d.ts +0 -3
  45. package/dist/cjs/types/api/customer/qrcode.js +0 -2
  46. package/dist/cjs/types/api/customer/thanx.d.ts +0 -26
  47. package/dist/cjs/types/api/customer/thanx.js +0 -2
  48. package/dist/cjs/types/api/customer/tpls.d.ts +0 -76
  49. package/dist/cjs/types/api/customer/tpls.js +0 -2
  50. package/dist/cjs/types/api/devices.d.ts +0 -96
  51. package/dist/cjs/types/api/devices.js +0 -2
  52. package/dist/cjs/types/api/discounts.d.ts +0 -65
  53. package/dist/cjs/types/api/discounts.js +0 -2
  54. package/dist/cjs/types/api/donations.d.ts +0 -13
  55. package/dist/cjs/types/api/donations.js +0 -2
  56. package/dist/cjs/types/api/employee.d.ts +0 -70
  57. package/dist/cjs/types/api/employee.js +0 -2
  58. package/dist/cjs/types/api/errorAlerts.d.ts +0 -9
  59. package/dist/cjs/types/api/errorAlerts.js +0 -2
  60. package/dist/cjs/types/api/favorite.d.ts +0 -13
  61. package/dist/cjs/types/api/favorite.js +0 -2
  62. package/dist/cjs/types/api/giftCard.d.ts +0 -11
  63. package/dist/cjs/types/api/giftCard.js +0 -2
  64. package/dist/cjs/types/api/index.d.ts +0 -36
  65. package/dist/cjs/types/api/index.js +0 -39
  66. package/dist/cjs/types/api/itemTypes.d.ts +0 -15
  67. package/dist/cjs/types/api/itemTypes.js +0 -2
  68. package/dist/cjs/types/api/kds.d.ts +0 -100
  69. package/dist/cjs/types/api/kds.js +0 -2
  70. package/dist/cjs/types/api/kiosk.d.ts +0 -37
  71. package/dist/cjs/types/api/kiosk.js +0 -2
  72. package/dist/cjs/types/api/menu.d.ts +0 -188
  73. package/dist/cjs/types/api/menu.js +0 -2
  74. package/dist/cjs/types/api/menuPages.d.ts +0 -21
  75. package/dist/cjs/types/api/menuPages.js +0 -2
  76. package/dist/cjs/types/api/messages.d.ts +0 -5
  77. package/dist/cjs/types/api/messages.js +0 -2
  78. package/dist/cjs/types/api/notifications.d.ts +0 -5
  79. package/dist/cjs/types/api/notifications.js +0 -2
  80. package/dist/cjs/types/api/offlineAuths.d.ts +0 -12
  81. package/dist/cjs/types/api/offlineAuths.js +0 -2
  82. package/dist/cjs/types/api/order.d.ts +0 -352
  83. package/dist/cjs/types/api/order.js +0 -19
  84. package/dist/cjs/types/api/orders.d.ts +0 -5
  85. package/dist/cjs/types/api/orders.js +0 -2
  86. package/dist/cjs/types/api/refund.d.ts +0 -22
  87. package/dist/cjs/types/api/refund.js +0 -2
  88. package/dist/cjs/types/api/revenueCenter.d.ts +0 -180
  89. package/dist/cjs/types/api/revenueCenter.js +0 -2
  90. package/dist/cjs/types/api/selectOptions.d.ts +0 -7
  91. package/dist/cjs/types/api/selectOptions.js +0 -2
  92. package/dist/cjs/types/api/settings.d.ts +0 -17
  93. package/dist/cjs/types/api/settings.js +0 -2
  94. package/dist/cjs/types/api/store.d.ts +0 -159
  95. package/dist/cjs/types/api/store.js +0 -2
  96. package/dist/cjs/types/api/surcharges.d.ts +0 -15
  97. package/dist/cjs/types/api/surcharges.js +0 -2
  98. package/dist/cjs/types/api/tags.d.ts +0 -13
  99. package/dist/cjs/types/api/tags.js +0 -2
  100. package/dist/cjs/types/api/taxes.d.ts +0 -15
  101. package/dist/cjs/types/api/taxes.js +0 -2
  102. package/dist/cjs/types/api/theme.d.ts +0 -767
  103. package/dist/cjs/types/api/theme.js +0 -2
  104. package/dist/cjs/types/datetimes.d.ts +0 -52
  105. package/dist/cjs/types/datetimes.js +0 -2
  106. package/dist/cjs/types/errors.d.ts +0 -2
  107. package/dist/cjs/types/errors.js +0 -5
  108. package/dist/cjs/types/global.d.ts +0 -58
  109. package/dist/cjs/types/global.js +0 -2
  110. package/dist/cjs/types/index.d.ts +0 -8
  111. package/dist/cjs/types/index.js +0 -11
  112. package/dist/cjs/types/inputs.d.ts +0 -82
  113. package/dist/cjs/types/inputs.js +0 -23
  114. package/dist/cjs/types/pizzaBuilder.d.ts +0 -7
  115. package/dist/cjs/types/pizzaBuilder.js +0 -2
  116. package/dist/cjs/types/request.d.ts +0 -27
  117. package/dist/cjs/types/request.js +0 -2
  118. package/dist/cjs/types/themePos.d.ts +0 -117
  119. package/dist/cjs/types/themePos.js +0 -2
  120. package/dist/esm/index.d.ts +0 -1
  121. package/dist/esm/index.js +0 -1
  122. package/dist/esm/types/api/alerts.d.ts +0 -5
  123. package/dist/esm/types/api/alerts.js +0 -1
  124. package/dist/esm/types/api/allergens.d.ts +0 -13
  125. package/dist/esm/types/api/allergens.js +0 -1
  126. package/dist/esm/types/api/announcements.d.ts +0 -57
  127. package/dist/esm/types/api/announcements.js +0 -1
  128. package/dist/esm/types/api/arrivals.d.ts +0 -14
  129. package/dist/esm/types/api/arrivals.js +0 -1
  130. package/dist/esm/types/api/cart.d.ts +0 -117
  131. package/dist/esm/types/api/cart.js +0 -1
  132. package/dist/esm/types/api/checkout.d.ts +0 -376
  133. package/dist/esm/types/api/checkout.js +0 -20
  134. package/dist/esm/types/api/completedOrders.d.ts +0 -42
  135. package/dist/esm/types/api/completedOrders.js +0 -1
  136. package/dist/esm/types/api/config.d.ts +0 -565
  137. package/dist/esm/types/api/config.js +0 -1
  138. package/dist/esm/types/api/creditCards.d.ts +0 -42
  139. package/dist/esm/types/api/creditCards.js +0 -1
  140. package/dist/esm/types/api/customer/account.d.ts +0 -26
  141. package/dist/esm/types/api/customer/account.js +0 -1
  142. package/dist/esm/types/api/customer/addresses.d.ts +0 -24
  143. package/dist/esm/types/api/customer/addresses.js +0 -1
  144. package/dist/esm/types/api/customer/allergens.d.ts +0 -5
  145. package/dist/esm/types/api/customer/allergens.js +0 -1
  146. package/dist/esm/types/api/customer/communicationPreferences.d.ts +0 -12
  147. package/dist/esm/types/api/customer/communicationPreferences.js +0 -1
  148. package/dist/esm/types/api/customer/customer.d.ts +0 -55
  149. package/dist/esm/types/api/customer/customer.js +0 -1
  150. package/dist/esm/types/api/customer/giftCards.d.ts +0 -37
  151. package/dist/esm/types/api/customer/giftCards.js +0 -1
  152. package/dist/esm/types/api/customer/groupOrders.d.ts +0 -62
  153. package/dist/esm/types/api/customer/groupOrders.js +0 -6
  154. package/dist/esm/types/api/customer/houseAccounts.d.ts +0 -21
  155. package/dist/esm/types/api/customer/houseAccounts.js +0 -1
  156. package/dist/esm/types/api/customer/identify.d.ts +0 -46
  157. package/dist/esm/types/api/customer/identify.js +0 -1
  158. package/dist/esm/types/api/customer/index.d.ts +0 -13
  159. package/dist/esm/types/api/customer/index.js +0 -14
  160. package/dist/esm/types/api/customer/loyalty.d.ts +0 -70
  161. package/dist/esm/types/api/customer/loyalty.js +0 -1
  162. package/dist/esm/types/api/customer/qrcode.d.ts +0 -3
  163. package/dist/esm/types/api/customer/qrcode.js +0 -1
  164. package/dist/esm/types/api/customer/thanx.d.ts +0 -26
  165. package/dist/esm/types/api/customer/thanx.js +0 -1
  166. package/dist/esm/types/api/customer/tpls.d.ts +0 -76
  167. package/dist/esm/types/api/customer/tpls.js +0 -1
  168. package/dist/esm/types/api/devices.d.ts +0 -96
  169. package/dist/esm/types/api/devices.js +0 -1
  170. package/dist/esm/types/api/discounts.d.ts +0 -65
  171. package/dist/esm/types/api/discounts.js +0 -1
  172. package/dist/esm/types/api/donations.d.ts +0 -13
  173. package/dist/esm/types/api/donations.js +0 -1
  174. package/dist/esm/types/api/employee.d.ts +0 -70
  175. package/dist/esm/types/api/employee.js +0 -1
  176. package/dist/esm/types/api/errorAlerts.d.ts +0 -9
  177. package/dist/esm/types/api/errorAlerts.js +0 -1
  178. package/dist/esm/types/api/favorite.d.ts +0 -13
  179. package/dist/esm/types/api/favorite.js +0 -1
  180. package/dist/esm/types/api/giftCard.d.ts +0 -11
  181. package/dist/esm/types/api/giftCard.js +0 -1
  182. package/dist/esm/types/api/index.d.ts +0 -36
  183. package/dist/esm/types/api/index.js +0 -36
  184. package/dist/esm/types/api/itemTypes.d.ts +0 -15
  185. package/dist/esm/types/api/itemTypes.js +0 -1
  186. package/dist/esm/types/api/kds.d.ts +0 -100
  187. package/dist/esm/types/api/kds.js +0 -1
  188. package/dist/esm/types/api/kiosk.d.ts +0 -37
  189. package/dist/esm/types/api/kiosk.js +0 -1
  190. package/dist/esm/types/api/menu.d.ts +0 -188
  191. package/dist/esm/types/api/menu.js +0 -1
  192. package/dist/esm/types/api/menuPages.d.ts +0 -21
  193. package/dist/esm/types/api/menuPages.js +0 -1
  194. package/dist/esm/types/api/messages.d.ts +0 -5
  195. package/dist/esm/types/api/messages.js +0 -1
  196. package/dist/esm/types/api/notifications.d.ts +0 -5
  197. package/dist/esm/types/api/notifications.js +0 -1
  198. package/dist/esm/types/api/offlineAuths.d.ts +0 -12
  199. package/dist/esm/types/api/offlineAuths.js +0 -1
  200. package/dist/esm/types/api/order.d.ts +0 -352
  201. package/dist/esm/types/api/order.js +0 -12
  202. package/dist/esm/types/api/orders.d.ts +0 -5
  203. package/dist/esm/types/api/orders.js +0 -1
  204. package/dist/esm/types/api/refund.d.ts +0 -22
  205. package/dist/esm/types/api/refund.js +0 -1
  206. package/dist/esm/types/api/revenueCenter.d.ts +0 -180
  207. package/dist/esm/types/api/revenueCenter.js +0 -1
  208. package/dist/esm/types/api/selectOptions.d.ts +0 -7
  209. package/dist/esm/types/api/selectOptions.js +0 -1
  210. package/dist/esm/types/api/settings.d.ts +0 -17
  211. package/dist/esm/types/api/settings.js +0 -1
  212. package/dist/esm/types/api/store.d.ts +0 -159
  213. package/dist/esm/types/api/store.js +0 -1
  214. package/dist/esm/types/api/surcharges.d.ts +0 -15
  215. package/dist/esm/types/api/surcharges.js +0 -1
  216. package/dist/esm/types/api/tags.d.ts +0 -13
  217. package/dist/esm/types/api/tags.js +0 -1
  218. package/dist/esm/types/api/taxes.d.ts +0 -15
  219. package/dist/esm/types/api/taxes.js +0 -1
  220. package/dist/esm/types/api/theme.d.ts +0 -767
  221. package/dist/esm/types/api/theme.js +0 -1
  222. package/dist/esm/types/datetimes.d.ts +0 -52
  223. package/dist/esm/types/datetimes.js +0 -1
  224. package/dist/esm/types/errors.d.ts +0 -2
  225. package/dist/esm/types/errors.js +0 -2
  226. package/dist/esm/types/global.d.ts +0 -58
  227. package/dist/esm/types/global.js +0 -1
  228. package/dist/esm/types/index.d.ts +0 -8
  229. package/dist/esm/types/index.js +0 -8
  230. package/dist/esm/types/inputs.d.ts +0 -82
  231. package/dist/esm/types/inputs.js +0 -15
  232. package/dist/esm/types/pizzaBuilder.d.ts +0 -7
  233. package/dist/esm/types/pizzaBuilder.js +0 -1
  234. package/dist/esm/types/request.d.ts +0 -27
  235. package/dist/esm/types/request.js +0 -1
  236. package/dist/esm/types/themePos.d.ts +0 -117
  237. package/dist/esm/types/themePos.js +0 -1
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@open-tender/types",
3
- "version": "0.4.157",
3
+ "version": "0.4.158",
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",
@@ -1 +0,0 @@
1
- export * from './types';
package/dist/cjs/index.js DELETED
@@ -1,4 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- const tslib_1 = require("tslib");
4
- tslib_1.__exportStar(require("./types"), exports);
@@ -1,5 +0,0 @@
1
- export interface Alert {
2
- message: string;
3
- id: string;
4
- }
5
- export declare type Alerts = Alert[];
@@ -1,2 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
@@ -1,13 +0,0 @@
1
- import { Images } from '../global';
2
- export interface Allergen {
3
- allergen_id: number;
4
- description: string | null;
5
- images: Images | null;
6
- name: string;
7
- }
8
- export declare type Allergens = Allergen[];
9
- export declare type AllergenLookup = Record<string, Allergen>;
10
- export interface AllergenEnhanced extends Allergen {
11
- imageUrl: string;
12
- }
13
- export declare type AllergenLookupEnhanced = Record<string, AllergenEnhanced>;
@@ -1,2 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
@@ -1,57 +0,0 @@
1
- export interface ContentImage {
2
- type: 'SECONDARY_IMAGE' | 'FEATURED_IMAGE';
3
- url: string | null;
4
- }
5
- export declare type ContentImages = ContentImage[];
6
- export declare type AnnouncementVertical = 'TOP' | 'BOTTOM' | 'CENTER';
7
- export declare type AnnouncementHorizontal = 'LEFT' | 'RIGHT' | 'CENTER';
8
- export interface Announcement {
9
- announcement_id: number;
10
- display_order: number;
11
- hide_text: boolean;
12
- hide_text_mobile: boolean;
13
- horizontal: AnnouncementHorizontal;
14
- images: ContentImages;
15
- overlay_color: string;
16
- overlay_opacity: number;
17
- show_overlay: boolean;
18
- subtitle: string;
19
- subtitle_color: string;
20
- subtitle_size: number | string | null;
21
- text_color: string;
22
- title: string;
23
- title_color: string;
24
- title_size: number | string | null;
25
- url: string | null;
26
- url_text: string | null;
27
- vertical: AnnouncementVertical;
28
- imageUrl?: string | null;
29
- }
30
- export declare type AnnouncementPageType = 'ABOUT' | 'ACCOUNT' | 'CATERING' | 'CHECKOUT' | 'GUEST' | 'HOME' | 'MENU' | 'ORDER_TYPE';
31
- export interface AnnouncementSettings {
32
- announcement_page_id: number;
33
- arrows_horizontal: string;
34
- arrows_vertical: string;
35
- autoplay: boolean;
36
- duration: number;
37
- duration_mobile: number;
38
- hide_text: boolean;
39
- hide_text_mobile: boolean;
40
- page: AnnouncementPageType;
41
- show_arrows: boolean;
42
- show_arrows_mobile: boolean;
43
- show_dots: boolean;
44
- show_dots_mobile: boolean;
45
- subtitle: string | null;
46
- title: string | null;
47
- transition: number;
48
- transition_mobile: number;
49
- transition_type: string;
50
- }
51
- export declare type Announcements = Announcement[];
52
- export interface AnnouncementPage {
53
- entities: Announcements;
54
- page: AnnouncementPageType;
55
- settings: AnnouncementSettings;
56
- }
57
- export declare type AnnouncementPages = AnnouncementPage[];
@@ -1,2 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
@@ -1,14 +0,0 @@
1
- import { ISOStringOffset } from '../datetimes';
2
- import { Customer } from './customer';
3
- export interface Arrival {
4
- arrived_utc: ISOStringOffset;
5
- arrival_info: string | null;
6
- customer?: Customer | null;
7
- has_arrived: boolean;
8
- order_id: number;
9
- order_uuid: string;
10
- vehicle_type: string | null;
11
- vehicle_color: string | null;
12
- vehicle_id: string | null;
13
- }
14
- export declare type Arrivals = Array<Arrival>;
@@ -1,2 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
@@ -1,117 +0,0 @@
1
- import { MenuItemAllergens, MenuItemTags, NutritionalInfo, PizzaShape } from './menu';
2
- import { OrderItemPoints } from './order';
3
- export interface BaseItemGroup {
4
- id: number;
5
- name: string;
6
- options: BaseItem[];
7
- }
8
- export declare type BaseItemGroups = BaseItemGroup[];
9
- export interface BaseItem {
10
- id: number;
11
- name: string;
12
- quantity: number;
13
- price: string | number;
14
- groups: BaseItemGroups;
15
- }
16
- export declare type BaseItems = BaseItem[];
17
- export interface CartItemOption {
18
- allergens: string[];
19
- allergens_list?: MenuItemAllergens;
20
- cals: number | null;
21
- description: string | null;
22
- groups: CartItemGroups;
23
- id: number;
24
- imageUrl: string | null;
25
- appImageUrl?: string | null;
26
- increment: number;
27
- ingredients: string | null;
28
- isDefault: boolean;
29
- isSoldOut: boolean;
30
- max: number;
31
- min: number;
32
- name: string;
33
- nutritionalInfo: NutritionalInfo | null;
34
- points: number | null;
35
- pos_ext_id: string | null;
36
- price: number;
37
- quantity: number;
38
- shorthand: string | null;
39
- shortDescription: string | null;
40
- shortName: string;
41
- slug: string;
42
- suspend_until: number | null;
43
- tags: string[];
44
- tags_list?: MenuItemTags;
45
- totalAllergens: string[];
46
- totalCals: number | null;
47
- totalPoints: number | null;
48
- totalPrice: number | null;
49
- itemShape: PizzaShape | null;
50
- excludeFromBuilder: boolean;
51
- }
52
- export declare type CartItemOptions = CartItemOption[];
53
- export interface CartItemOptionWithGroup extends CartItemOption {
54
- group: CartItemGroup;
55
- }
56
- export declare type CartItemOptionsWithGroup = CartItemOptionWithGroup[];
57
- export interface CartItemOptionWithIndex extends CartItemOption {
58
- index: number;
59
- }
60
- export interface CartItem extends Omit<CartItemOption, 'isDefault'> {
61
- cartGuestId: number | null;
62
- customerId: number | null;
63
- index?: number;
64
- madeFor: string | null;
65
- notes: string | null;
66
- signature?: string;
67
- similarItems: number[];
68
- upsellItems: number[];
69
- list_name: string | null;
70
- list_id: string | null;
71
- menu_position: number | null;
72
- }
73
- export interface CartItemWithPoints extends Omit<CartItem, 'points'> {
74
- points: OrderItemPoints | null;
75
- }
76
- export declare type CartWithPoints = CartItemWithPoints[];
77
- export interface CartItemGroup {
78
- description: string | null;
79
- id: number;
80
- imageUrl: string | null;
81
- appImageUrl?: string | null;
82
- included: number;
83
- isPizza: boolean;
84
- isSize: boolean;
85
- max: number;
86
- min: number;
87
- name: string;
88
- options: CartItemOptions;
89
- quantity: number;
90
- itemShape: PizzaShape | null;
91
- excludeFromBuilder: boolean;
92
- }
93
- export declare type CartItemGroups = CartItemGroup[];
94
- export declare type Cart = CartItem[];
95
- export declare type CartLevels = number[][];
96
- export declare type CartCounts = Record<string, number>;
97
- export declare type CartItemOptionLookup = Record<string, CartItemOption>;
98
- export declare type CartItemGroupLookupOptions = Omit<CartItemGroup, 'options'> & {
99
- options: CartItemOptionLookup;
100
- };
101
- export declare type CartItemGroupLookup = Record<string, CartItemGroupLookupOptions>;
102
- export interface CartItemWithErrors extends CartItem {
103
- missingGroups: CartItemGroupLookupOptions[];
104
- invalidGroups: CartItemGroups;
105
- missingOptions: CartItemOptions;
106
- invalidOptions: CartItemOptions;
107
- }
108
- export declare type CartWithErrors = CartItemWithErrors[];
109
- export interface CartErrors {
110
- missingItems: Cart;
111
- invalidItems: CartWithErrors;
112
- }
113
- export interface PosCartItem extends CartItem {
114
- item_no: number;
115
- line_no: number;
116
- }
117
- export declare type PosCart = PosCartItem[];
@@ -1,2 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
@@ -1,376 +0,0 @@
1
- import { ISOString, RequestedAt } from '../datetimes';
2
- import { CardType, CardTypeName, DeviceType, Money, OrderType, PrepType, ServiceType, TenderStatus, TenderType } from '../global';
3
- import { CheckoutErrorParams } from '../request';
4
- import { Cart, CartItemWithPoints } from './cart';
5
- import { Address, CustomerIdentify } from './customer';
6
- import { Order, OrderCustomer, OrderDiscounts, OrderFulfillment, OrderSurcharge } from './order';
7
- export interface SimpleCartOption {
8
- id: number;
9
- quantity: number;
10
- groups: SimpleCartGroups;
11
- }
12
- export interface SimpleCartGroup {
13
- id: number;
14
- options: SimpleCartOption[];
15
- }
16
- export declare type SimpleCartGroups = SimpleCartGroup[];
17
- export interface SimpleCartItem {
18
- id: number;
19
- quantity: number;
20
- groups: SimpleCartGroups;
21
- made_for?: string | null;
22
- notes?: string | null;
23
- cart_guest_id?: number;
24
- customer_id?: number;
25
- }
26
- export declare type SimpleCart = SimpleCartItem[];
27
- export interface SimpleCartLookupOption {
28
- quantity: number;
29
- groupsLookup: Record<string, SimpleCartLookupGroup> | null;
30
- }
31
- export interface SimpleCartLookupGroup {
32
- options: Record<string, SimpleCartLookupOption>;
33
- }
34
- export declare type CheckoutConfigFieldAddress = 'company' | 'contact' | 'phone' | 'unit';
35
- export declare type CheckoutConfigFieldCustomer = 'company';
36
- export declare type CheckoutConfigFieldDetails = 'count' | 'eatingUtensils' | 'notes' | 'servingUtensils';
37
- export interface CheckoutConfigFields {
38
- address: CheckoutConfigFieldAddress[];
39
- customer: CheckoutConfigFieldCustomer[];
40
- details: CheckoutConfigFieldDetails[];
41
- }
42
- export interface CheckoutConfigGratuityAmount {
43
- amount: Money;
44
- percent: Money;
45
- }
46
- export interface CheckoutConfigGratuity {
47
- default: CheckoutConfigGratuityAmount | null;
48
- has_tip: boolean;
49
- max_gratuity: CheckoutConfigGratuityAmount | null;
50
- options: CheckoutConfigGratuityAmount[];
51
- }
52
- export interface CheckoutConfigCurbsideField {
53
- label: string;
54
- name: keyof OrderFulfillment;
55
- placeholder: string;
56
- }
57
- export declare type CheckoutConfigCurbsideFields = CheckoutConfigCurbsideField[];
58
- export interface CheckoutConfigCurbside {
59
- description: string;
60
- fields: CheckoutConfigCurbsideFields;
61
- title: string;
62
- }
63
- export interface CheckoutConfigLoyalty {
64
- balance: Money;
65
- name: string;
66
- per: number;
67
- remaining: Money;
68
- }
69
- export interface CheckoutConfigSurcharge extends OrderSurcharge {
70
- label: string;
71
- }
72
- export declare type CheckoutConfigSurcharges = CheckoutConfigSurcharge[];
73
- export interface CheckoutConfig {
74
- allow_tax_exempt: boolean;
75
- discounts: OrderDiscounts;
76
- displayed: CheckoutConfigFields;
77
- gratuity: CheckoutConfigGratuity;
78
- order_fulfillment: CheckoutConfigCurbside | null;
79
- points: CheckoutConfigLoyalty | null;
80
- promo_code_limit: number;
81
- require_address: boolean;
82
- require_cardholder_name: boolean;
83
- required: CheckoutConfigFields;
84
- surcharges: CheckoutConfigSurcharges;
85
- tender_types: TenderType[];
86
- }
87
- export interface CheckoutCheck extends Omit<Order, 'customer'> {
88
- config: CheckoutConfig;
89
- customer: OrderCustomer | null;
90
- errors: CheckoutErrorParams;
91
- }
92
- export interface OrderCreateDetails {
93
- arrival_info?: string | null;
94
- cart_id?: number | null;
95
- device_type?: DeviceType | null;
96
- eating_utensils?: boolean;
97
- has_arrived?: boolean;
98
- is_tax_exempt?: boolean;
99
- notes?: string | null;
100
- notes_internal?: string | null;
101
- person_count?: number | null;
102
- serving_utensils?: boolean;
103
- tax_exempt_id?: string | null;
104
- order_fulfillment?: boolean;
105
- vehicle_color?: string | null;
106
- vehicle_id?: string | null;
107
- vehicle_type?: string | null;
108
- }
109
- export interface OrderCreateGiftCard {
110
- id: number;
111
- gift_card_id?: number;
112
- code?: string;
113
- card_number: string;
114
- amount: Money;
115
- employee_id?: number;
116
- }
117
- export declare type OrderCreateGiftCards = OrderCreateGiftCard[];
118
- export interface OrderCreateSurcharge {
119
- id: number;
120
- }
121
- export declare type OrderCreateSurcharges = OrderCreateSurcharge[];
122
- export interface OrderCreateDiscount {
123
- id: number;
124
- ext_id?: string | null;
125
- }
126
- export declare type OrderCreateDiscounts = OrderCreateDiscount[];
127
- export interface OrderCreateTax {
128
- id: number;
129
- }
130
- export declare type OrderCreateTaxes = OrderCreateTax[];
131
- export interface OrderCreatePointsItem {
132
- index: number;
133
- points: number;
134
- }
135
- export declare type OrderCreatePoints = OrderCreatePointsItem[];
136
- export interface CheckoutFormAddress {
137
- company?: string;
138
- contact?: string;
139
- phone?: string;
140
- unit?: string;
141
- }
142
- export interface CheckoutFormCustomer {
143
- company?: string;
144
- customer_id?: number;
145
- email?: string;
146
- first_name?: string;
147
- password?: string;
148
- phone?: string;
149
- last_name?: string;
150
- }
151
- export interface CheckoutTenderCreditGuest {
152
- acct: string;
153
- addr?: string;
154
- amount: Money;
155
- card_type_name: CardTypeName;
156
- cardholder_name?: string;
157
- cvv: string;
158
- exp: string;
159
- is_default: boolean;
160
- last4: string;
161
- masked: string;
162
- tender_status?: TenderStatus;
163
- tender_type: TenderType;
164
- zip: string;
165
- }
166
- export interface CheckoutTenderCreditCustomer {
167
- amount: Money;
168
- card_type?: CardType;
169
- card_type_name?: CardTypeName;
170
- customer_card_id: number;
171
- is_default?: boolean;
172
- last4?: string;
173
- masked?: string;
174
- tender_status?: TenderStatus;
175
- tender_type: TenderType;
176
- }
177
- export interface CheckoutTenderGiftCard {
178
- amount: Money;
179
- balance?: Money;
180
- card_number: string;
181
- pin?: string;
182
- tender_status?: TenderStatus;
183
- tender_type: TenderType;
184
- }
185
- export interface CheckoutTenderHouseAccount {
186
- amount: Money;
187
- approved_contact?: boolean;
188
- domain?: string | null;
189
- house_account_id: number;
190
- name: string;
191
- order_type?: OrderType | null;
192
- pin?: string;
193
- revenue_centers?: number[];
194
- service_type?: ServiceType | null;
195
- tender_status?: TenderStatus;
196
- tender_type?: TenderType;
197
- }
198
- export interface CheckoutTenderApplePay {
199
- amount: Money;
200
- tender_status?: TenderStatus;
201
- tender_type: TenderType;
202
- token: any;
203
- }
204
- export interface CheckoutTenderGooglePay {
205
- amount: Money;
206
- tender_status?: TenderStatus;
207
- tender_type: TenderType;
208
- token: any;
209
- }
210
- export declare type CheckoutTender = CheckoutTenderCreditGuest | CheckoutTenderCreditCustomer | CheckoutTenderGiftCard | CheckoutTenderHouseAccount | CheckoutTenderApplePay | CheckoutTenderGooglePay;
211
- export declare type CheckoutTenders = CheckoutTender[];
212
- export declare const isCreditCustomerCheckoutTender: (tender: CheckoutTender) => tender is CheckoutTenderCreditCustomer;
213
- export declare const isCreditGuestCheckoutTender: (tender: CheckoutTender) => tender is CheckoutTenderCreditGuest;
214
- export declare const isGiftCardCheckoutTender: (tender: CheckoutTender) => tender is CheckoutTenderGiftCard;
215
- export declare const isHouseAccountCheckoutTender: (tender: CheckoutTender) => tender is CheckoutTenderHouseAccount;
216
- export declare const isApplePayCheckoutTender: (tender: CheckoutTender) => tender is CheckoutTenderApplePay;
217
- export declare const isGooglePayCheckoutTender: (tender: CheckoutTender) => tender is CheckoutTenderGooglePay;
218
- export declare type CheckoutPromoCodes = string[];
219
- export interface CheckoutForm {
220
- address: CheckoutFormAddress;
221
- customer: CheckoutFormCustomer;
222
- details: OrderCreateDetails;
223
- discounts: OrderCreateDiscounts;
224
- points: OrderCreatePoints;
225
- promoCodes: CheckoutPromoCodes;
226
- surcharges: OrderCreateSurcharges;
227
- tenders: CheckoutTenders;
228
- tip: Money | null;
229
- token?: string | null;
230
- kount_device_session_id?: string;
231
- }
232
- export interface OrderData {
233
- address: Address | null;
234
- cart: Cart;
235
- cartId: number | null;
236
- customer: CheckoutFormCustomer | null;
237
- deposit: Money | null;
238
- details: OrderCreateDetails | null;
239
- deviceType: DeviceType | null;
240
- discounts: OrderCreateDiscounts | null;
241
- discountsInternal?: OrderCreateDiscounts | null;
242
- orderId: number | null;
243
- points: OrderCreatePoints | null;
244
- prepType: PrepType | null;
245
- promoCodes: CheckoutPromoCodes | null;
246
- requestedAt: RequestedAt;
247
- revenueCenterId: number;
248
- save?: boolean;
249
- serviceType: ServiceType;
250
- surcharges: OrderCreateSurcharges | null;
251
- table: string | null;
252
- tenders: CheckoutTenders | null;
253
- tip: Money | null;
254
- token?: string | null;
255
- kount_device_session_id?: string;
256
- }
257
- export interface OrderCreate {
258
- address?: Address | null;
259
- cart: SimpleCart;
260
- cart_id?: number;
261
- customer?: CheckoutFormCustomer | null;
262
- deposit?: Money | null;
263
- details?: OrderCreateDetails | null;
264
- discounts?: OrderCreateDiscounts;
265
- discounts_internal?: OrderCreateDiscounts | null;
266
- order_id?: number;
267
- order_uuid?: string;
268
- points?: OrderCreatePoints;
269
- promo_codes?: CheckoutPromoCodes;
270
- requested_at: RequestedAt;
271
- revenue_center_id: number;
272
- save?: boolean;
273
- service_type: ServiceType;
274
- shipment_id?: string;
275
- surcharges?: OrderCreateSurcharges;
276
- taxes?: OrderCreateTaxes;
277
- tenders?: CheckoutTenders;
278
- tip?: Money;
279
- token?: string | null;
280
- kount_device_session_id?: string;
281
- }
282
- export interface CheckoutPoints {
283
- points: CheckoutConfigLoyalty;
284
- applied: OrderCreatePoints;
285
- apply: (item: CartItemWithPoints) => void;
286
- remove: (item: CartItemWithPoints) => void;
287
- }
288
- export interface CheckoutTenderPos {
289
- acct?: string;
290
- addr?: string;
291
- amount?: Money;
292
- cash_back?: Money;
293
- customer_card_id?: string;
294
- cardholder_name?: string;
295
- cvv?: string;
296
- exp?: string;
297
- gift_card_code?: string | number;
298
- house_account_pin?: string;
299
- save?: boolean;
300
- tender_type: TenderType;
301
- track_data?: string;
302
- zip?: string;
303
- }
304
- export interface ChipDNA {
305
- ACCOUNT_TYPE: string;
306
- ACQUIRER_RESPONSE_CODE: string;
307
- AID: string;
308
- AUTH_CODE: string;
309
- AUTH_DATE_TIME: string;
310
- CARDEASE_REFERENCE: string;
311
- CARDHOLDER_VERIFICATION: string;
312
- CARD_HASH: string;
313
- CARD_HASH_COLLECTION: string;
314
- ource: string;
315
- CARD_HOLDER_LAST_NAME: string;
316
- CARD_REFERENCE: string;
317
- CARD_SCHEME: string;
318
- CARD_SCHEME_ID: string;
319
- EXPIRY_DATE: string;
320
- MERCHANT_ID_MASKED: string;
321
- MERCHANT_NAME: string;
322
- PAN_MASKED: string;
323
- PAN_SEQUENCE: string;
324
- RECEIPT_DATA: string;
325
- REFERENCE: string;
326
- SIGNATURE_CAPTURED: string;
327
- SIGNATURE_VERIFICATION_REQUIRED: string;
328
- TERMINAL_ID_MASKED: string;
329
- TOTAL_AMOUNT: string;
330
- TRANSACTION_ID: string;
331
- TRANSACTION_RESULT: string;
332
- TRANSACTION_SOURCE: string;
333
- TRANSACTION_TYPE: string;
334
- }
335
- export interface ChipDNACreditCard {
336
- authcode: string;
337
- card_type: CardType;
338
- charged_at: ISOString;
339
- entry_mode: string;
340
- external_api_id: number;
341
- last4: string;
342
- masked: string;
343
- merchant_id: string;
344
- processor_id: string;
345
- profileid: string;
346
- retref: string;
347
- token: string;
348
- }
349
- export interface CheckoutTenderChipDNA {
350
- amount: Money;
351
- chipdna: ChipDNA;
352
- created_at: ISOString;
353
- credit_card: ChipDNACreditCard;
354
- is_replaced: boolean;
355
- tender_status: TenderStatus;
356
- tender_type: TenderType;
357
- tender_uuid: string;
358
- }
359
- export interface OrderCreatePos extends Omit<OrderCreate, 'customer'> {
360
- customer: CustomerIdentify | null;
361
- made_for?: string | null;
362
- phone?: string | null;
363
- prep_type?: PrepType | null;
364
- notes_internal?: string | null;
365
- device_type?: DeviceType | null;
366
- }
367
- export interface OrderCreateSendReceipt {
368
- email: string | null;
369
- phone: string | null;
370
- }
371
- export interface GratuityIncrement {
372
- amount?: Money;
373
- isDefault: boolean;
374
- percentage: string;
375
- }
376
- export declare type GratuityIncrements = GratuityIncrement[];
@@ -1,29 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.isGooglePayCheckoutTender = exports.isApplePayCheckoutTender = exports.isHouseAccountCheckoutTender = exports.isGiftCardCheckoutTender = exports.isCreditGuestCheckoutTender = exports.isCreditCustomerCheckoutTender = void 0;
4
- const isCreditCustomerCheckoutTender = (tender) => {
5
- return (tender.tender_type === 'CREDIT' &&
6
- tender.customer_card_id !== undefined);
7
- };
8
- exports.isCreditCustomerCheckoutTender = isCreditCustomerCheckoutTender;
9
- const isCreditGuestCheckoutTender = (tender) => {
10
- return (tender.tender_type === 'CREDIT' &&
11
- tender.acct !== undefined);
12
- };
13
- exports.isCreditGuestCheckoutTender = isCreditGuestCheckoutTender;
14
- const isGiftCardCheckoutTender = (tender) => {
15
- return tender.tender_type === 'GIFT_CARD';
16
- };
17
- exports.isGiftCardCheckoutTender = isGiftCardCheckoutTender;
18
- const isHouseAccountCheckoutTender = (tender) => {
19
- return tender.tender_type === 'HOUSE_ACCOUNT';
20
- };
21
- exports.isHouseAccountCheckoutTender = isHouseAccountCheckoutTender;
22
- const isApplePayCheckoutTender = (tender) => {
23
- return tender.tender_type === 'APPLE_PAY';
24
- };
25
- exports.isApplePayCheckoutTender = isApplePayCheckoutTender;
26
- const isGooglePayCheckoutTender = (tender) => {
27
- return tender.tender_type === 'GOOGLE_PAY';
28
- };
29
- exports.isGooglePayCheckoutTender = isGooglePayCheckoutTender;
@@ -1,42 +0,0 @@
1
- import { ISOString, Timezone } from '../datetimes';
2
- import { Money, OrderType, ServiceType, TenderType } from '../global';
3
- import { RequestError } from '../request';
4
- import { CreditCard } from './creditCards';
5
- import { Address, Customer, HouseAccount } from './customer';
6
- import { OrderDelivery, OrderDetails, OrderDiscounts, OrderFulfillment, OrderRating, OrderRevenueCenter, OrderShipment, OrderSurcharges, OrderTaxes, OrderTotals } from './order';
7
- export interface CompletedOrderConfig {
8
- discounts: OrderDiscounts | [];
9
- surcharges: OrderSurcharges | [];
10
- }
11
- export interface OrderRefund {
12
- amount: Money;
13
- credit_card: CreditCard | null;
14
- house_account: HouseAccount | null;
15
- tender_type: TenderType;
16
- }
17
- export interface CompletedOrder {
18
- address: Address | null;
19
- config: CompletedOrderConfig;
20
- created_at: ISOString;
21
- customer: Customer;
22
- delivery: OrderDelivery | null;
23
- details: OrderDetails | null;
24
- errors: RequestError;
25
- estimated_at: ISOString;
26
- is_asap: boolean;
27
- is_editable: boolean;
28
- is_future: boolean;
29
- order_fulfillment: OrderFulfillment | null;
30
- rating: OrderRating;
31
- refunds: Array<OrderRefund>;
32
- requested_at: ISOString;
33
- requested_time: string;
34
- revenue_center: OrderRevenueCenter;
35
- service_type: ServiceType;
36
- shipment: OrderShipment;
37
- texes: OrderTaxes;
38
- timezone: Timezone;
39
- totals: OrderTotals;
40
- order_type: OrderType;
41
- }
42
- export declare type CompletedOrders = Array<CompletedOrder>;