@compassdigital/sdk.typescript 4.14.0 → 4.16.0

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 (101) hide show
  1. package/lib/base.d.ts +1 -11
  2. package/lib/base.d.ts.map +1 -1
  3. package/lib/base.js +3 -21
  4. package/lib/base.js.map +1 -1
  5. package/lib/index.d.ts +54 -4
  6. package/lib/index.d.ts.map +1 -1
  7. package/lib/index.js +55 -1
  8. package/lib/index.js.map +1 -1
  9. package/lib/interface/ai.d.ts +3 -3
  10. package/lib/interface/ai.d.ts.map +1 -1
  11. package/lib/interface/announcement.d.ts +2 -2
  12. package/lib/interface/announcement.d.ts.map +1 -1
  13. package/lib/interface/calendar.d.ts +2 -2
  14. package/lib/interface/calendar.d.ts.map +1 -1
  15. package/lib/interface/centricos.d.ts +46 -4
  16. package/lib/interface/centricos.d.ts.map +1 -1
  17. package/lib/interface/compassconnect.d.ts +1 -1
  18. package/lib/interface/compassconnect.d.ts.map +1 -1
  19. package/lib/interface/config.d.ts +3 -5
  20. package/lib/interface/config.d.ts.map +1 -1
  21. package/lib/interface/datalake.d.ts +2 -2
  22. package/lib/interface/datalake.d.ts.map +1 -1
  23. package/lib/interface/delivery.d.ts +1 -1
  24. package/lib/interface/delivery.d.ts.map +1 -1
  25. package/lib/interface/email.d.ts +2 -2
  26. package/lib/interface/email.d.ts.map +1 -1
  27. package/lib/interface/file.d.ts +1 -1
  28. package/lib/interface/file.d.ts.map +1 -1
  29. package/lib/interface/frictionless.d.ts +26 -7
  30. package/lib/interface/frictionless.d.ts.map +1 -1
  31. package/lib/interface/kds.d.ts +1 -1
  32. package/lib/interface/kds.d.ts.map +1 -1
  33. package/lib/interface/location.d.ts +27 -16
  34. package/lib/interface/location.d.ts.map +1 -1
  35. package/lib/interface/location.js +12 -0
  36. package/lib/interface/location.js.map +1 -1
  37. package/lib/interface/mealplan.d.ts +1 -1
  38. package/lib/interface/mealplan.d.ts.map +1 -1
  39. package/lib/interface/menu.d.ts +264 -249
  40. package/lib/interface/menu.d.ts.map +1 -1
  41. package/lib/interface/menu.js +6 -0
  42. package/lib/interface/menu.js.map +1 -1
  43. package/lib/interface/notification.d.ts +2 -2
  44. package/lib/interface/notification.d.ts.map +1 -1
  45. package/lib/interface/order.d.ts +3 -3
  46. package/lib/interface/order.d.ts.map +1 -1
  47. package/lib/interface/partner.d.ts +51 -19
  48. package/lib/interface/partner.d.ts.map +1 -1
  49. package/lib/interface/partner.js +11 -0
  50. package/lib/interface/partner.js.map +1 -1
  51. package/lib/interface/payment.d.ts +1 -1
  52. package/lib/interface/payment.d.ts.map +1 -1
  53. package/lib/interface/promo.d.ts +12 -5
  54. package/lib/interface/promo.d.ts.map +1 -1
  55. package/lib/interface/promo.js +8 -0
  56. package/lib/interface/promo.js.map +1 -1
  57. package/lib/interface/report.d.ts +20 -5
  58. package/lib/interface/report.d.ts.map +1 -1
  59. package/lib/interface/shoppingcart.d.ts +12 -8
  60. package/lib/interface/shoppingcart.d.ts.map +1 -1
  61. package/lib/interface/shoppingcart.js +5 -0
  62. package/lib/interface/shoppingcart.js.map +1 -1
  63. package/lib/interface/task.d.ts +19 -11
  64. package/lib/interface/task.d.ts.map +1 -1
  65. package/lib/interface/task.js +9 -0
  66. package/lib/interface/task.js.map +1 -1
  67. package/lib/interface/user.d.ts +4 -4
  68. package/lib/interface/user.d.ts.map +1 -1
  69. package/lib/interface/util.d.ts +19 -0
  70. package/lib/interface/util.d.ts.map +1 -1
  71. package/lib/interface/vendor.d.ts +1 -1
  72. package/lib/interface/vendor.d.ts.map +1 -1
  73. package/package.json +1 -1
  74. package/src/base.ts +6 -25
  75. package/src/index.ts +140 -1
  76. package/src/interface/ai.ts +3 -3
  77. package/src/interface/announcement.ts +2 -2
  78. package/src/interface/calendar.ts +2 -2
  79. package/src/interface/centricos.ts +76 -4
  80. package/src/interface/compassconnect.ts +1 -1
  81. package/src/interface/config.ts +3 -5
  82. package/src/interface/datalake.ts +2 -2
  83. package/src/interface/delivery.ts +1 -1
  84. package/src/interface/email.ts +2 -2
  85. package/src/interface/file.ts +1 -1
  86. package/src/interface/frictionless.ts +49 -7
  87. package/src/interface/kds.ts +1 -1
  88. package/src/interface/location.ts +26 -16
  89. package/src/interface/mealplan.ts +1 -1
  90. package/src/interface/menu.ts +263 -249
  91. package/src/interface/notification.ts +2 -2
  92. package/src/interface/order.ts +3 -3
  93. package/src/interface/partner.ts +53 -19
  94. package/src/interface/payment.ts +1 -1
  95. package/src/interface/promo.ts +11 -5
  96. package/src/interface/report.ts +34 -6
  97. package/src/interface/shoppingcart.ts +11 -8
  98. package/src/interface/task.ts +18 -17
  99. package/src/interface/user.ts +4 -4
  100. package/src/interface/util.ts +21 -0
  101. package/src/interface/vendor.ts +1 -1
@@ -95,10 +95,10 @@ export interface Brand {
95
95
  };
96
96
  hours?: Hours[];
97
97
  deliveryHours?: DeliveryHours[];
98
- style?: Record<string, any>;
98
+ style?: any;
99
99
  // pos
100
100
  pos?: string;
101
- terminals?: Record<string, any>[];
101
+ terminals?: any[];
102
102
  timeslots?: {
103
103
  time?: string;
104
104
  averagePrepTime?: string;
@@ -123,6 +123,8 @@ export interface Brand {
123
123
  promo_exemptions_enabled?: boolean;
124
124
  local_images_enabled?: boolean;
125
125
  hidden?: boolean;
126
+ show_in_kiosk?: boolean;
127
+ show_in_pos?: boolean;
126
128
  item_desc_edit_enabled?: boolean;
127
129
  scan_and_go_supported?: boolean;
128
130
  calories_edit_enabled?: boolean;
@@ -143,8 +145,8 @@ export interface Brand {
143
145
  // company
144
146
  company?: string;
145
147
  config?: {
146
- private?: Record<string, any>;
147
- public?: Record<string, any>;
148
+ private?: any;
149
+ public?: any;
148
150
  };
149
151
  tax_rate?: number;
150
152
  meta?: {
@@ -252,8 +254,8 @@ export interface Location {
252
254
  en?: string;
253
255
  fr?: string;
254
256
  };
255
- hours?: Record<string, any>;
256
- deliveryHours?: Record<string, any>;
257
+ hours?: any;
258
+ deliveryHours?: any;
257
259
  service_fee?: {
258
260
  type?: string;
259
261
  value?: number;
@@ -278,7 +280,7 @@ export interface Group {
278
280
  meta?: {
279
281
  [index: string]: any;
280
282
  };
281
- style?: Record<string, any>;
283
+ style?: any;
282
284
  [index: string]: any;
283
285
  }
284
286
 
@@ -297,7 +299,7 @@ export interface success {
297
299
  export interface Error {
298
300
  error?: string;
299
301
  code?: number;
300
- data?: Record<string, any>;
302
+ data?: any;
301
303
  }
302
304
 
303
305
  export interface Sector {
@@ -416,7 +418,11 @@ export interface BadRequest {
416
418
  error?: string;
417
419
  }
418
420
 
419
- export type PartnerStatus = "await_partner" | "await_scout" | "completed";
421
+ enum PartnerStatus {
422
+ AWAIT_PARTNER = "await_partner",
423
+ AWAIT_SCOUT = "await_scout",
424
+ COMPLETED = "completed",
425
+ }
420
426
 
421
427
  export interface WaitTime {
422
428
  // maxium wait time to the next time slot in minutes
@@ -427,7 +433,11 @@ export interface WaitTime {
427
433
  ready_time: number;
428
434
  }
429
435
 
430
- export type BrandOrMenuState = "open" | "closed" | "preorder";
436
+ enum BrandOrMenuState {
437
+ OPEN = "open",
438
+ CLOSED = "closed",
439
+ PREORDER = "preorder",
440
+ }
431
441
 
432
442
  export interface MenuAssociations {
433
443
  menu_associations?: MenuAssociation[];
@@ -497,7 +507,7 @@ export interface GetLocationQuery {
497
507
  // When fetching location, brands will come with private and public configs
498
508
  include_brands_config?: boolean;
499
509
  // active cafes
500
- active_cafes?: Record<string, any>[];
510
+ active_cafes?: any[];
501
511
  // show additional hidden properties/entities
502
512
  extended?: boolean;
503
513
  // Graphql query string
@@ -1213,7 +1223,7 @@ export interface PostLocationCompanyBody {
1213
1223
  name: string;
1214
1224
  // sector
1215
1225
  sector: string;
1216
- label?: Record<string, any>;
1226
+ label?: any;
1217
1227
  is?: {
1218
1228
  global_images_enabled?: boolean;
1219
1229
  };
@@ -1287,13 +1297,13 @@ export interface GetLocationV2GroupsQuery {
1287
1297
  // Filter groups by multigroup id. Should be like an array of string
1288
1298
  id_multigroups?: string;
1289
1299
  // The number of items per page to return
1290
- limit?: string;
1300
+ limit?: number;
1291
1301
  // ASC or DESC
1292
- sortOrder?: "ASC" | "DESC";
1302
+ sortOrder?: string;
1293
1303
  // The page number to return
1294
- page?: string;
1304
+ page?: number;
1295
1305
  // Expand group results with children locations and brands
1296
- expanded?: string;
1306
+ expanded?: boolean;
1297
1307
  // Filter groups by given string
1298
1308
  filter?: string;
1299
1309
  // Graphql query string
@@ -6,7 +6,7 @@ import { RequestQuery, BaseRequest } from "./util";
6
6
  export interface Error {
7
7
  code?: number;
8
8
  message?: string;
9
- data?: Record<string, any>;
9
+ data?: any;
10
10
  headers?: {
11
11
  Location?: string;
12
12
  };