@compassdigital/sdk.typescript 4.4.1 → 4.6.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 (96) hide show
  1. package/lib/base.d.ts.map +1 -1
  2. package/lib/base.js +2 -1
  3. package/lib/base.js.map +1 -1
  4. package/lib/index.d.ts +8 -1
  5. package/lib/index.d.ts.map +1 -1
  6. package/lib/index.js +9 -0
  7. package/lib/index.js.map +1 -1
  8. package/lib/interface/ai.d.ts +3 -3
  9. package/lib/interface/ai.d.ts.map +1 -1
  10. package/lib/interface/announcement.d.ts +2 -2
  11. package/lib/interface/announcement.d.ts.map +1 -1
  12. package/lib/interface/calendar.d.ts +1 -1
  13. package/lib/interface/calendar.d.ts.map +1 -1
  14. package/lib/interface/centricos.d.ts +3 -3
  15. package/lib/interface/centricos.d.ts.map +1 -1
  16. package/lib/interface/compassconnect.d.ts +1 -1
  17. package/lib/interface/compassconnect.d.ts.map +1 -1
  18. package/lib/interface/config.d.ts +75 -15
  19. package/lib/interface/config.d.ts.map +1 -1
  20. package/lib/interface/datalake.d.ts +2 -2
  21. package/lib/interface/datalake.d.ts.map +1 -1
  22. package/lib/interface/delivery.d.ts +3 -3
  23. package/lib/interface/delivery.d.ts.map +1 -1
  24. package/lib/interface/email.d.ts +2 -2
  25. package/lib/interface/email.d.ts.map +1 -1
  26. package/lib/interface/file.d.ts +1 -1
  27. package/lib/interface/file.d.ts.map +1 -1
  28. package/lib/interface/frictionless.d.ts +1 -1
  29. package/lib/interface/frictionless.d.ts.map +1 -1
  30. package/lib/interface/kds.d.ts +1 -1
  31. package/lib/interface/kds.d.ts.map +1 -1
  32. package/lib/interface/location.d.ts +12 -21
  33. package/lib/interface/location.d.ts.map +1 -1
  34. package/lib/interface/location.js +0 -12
  35. package/lib/interface/location.js.map +1 -1
  36. package/lib/interface/mealplan.d.ts +1 -1
  37. package/lib/interface/mealplan.d.ts.map +1 -1
  38. package/lib/interface/menu.d.ts +241 -246
  39. package/lib/interface/menu.d.ts.map +1 -1
  40. package/lib/interface/menu.js +0 -6
  41. package/lib/interface/menu.js.map +1 -1
  42. package/lib/interface/notification.d.ts +2 -2
  43. package/lib/interface/notification.d.ts.map +1 -1
  44. package/lib/interface/order.d.ts +3 -3
  45. package/lib/interface/order.d.ts.map +1 -1
  46. package/lib/interface/partner.d.ts +17 -22
  47. package/lib/interface/partner.d.ts.map +1 -1
  48. package/lib/interface/partner.js +0 -6
  49. package/lib/interface/partner.js.map +1 -1
  50. package/lib/interface/payment.d.ts +12 -4
  51. package/lib/interface/payment.d.ts.map +1 -1
  52. package/lib/interface/promo.d.ts +5 -12
  53. package/lib/interface/promo.d.ts.map +1 -1
  54. package/lib/interface/promo.js +0 -8
  55. package/lib/interface/promo.js.map +1 -1
  56. package/lib/interface/report.d.ts +1 -1
  57. package/lib/interface/report.d.ts.map +1 -1
  58. package/lib/interface/shoppingcart.d.ts +8 -12
  59. package/lib/interface/shoppingcart.d.ts.map +1 -1
  60. package/lib/interface/shoppingcart.js +0 -5
  61. package/lib/interface/shoppingcart.js.map +1 -1
  62. package/lib/interface/task.d.ts +5 -5
  63. package/lib/interface/task.d.ts.map +1 -1
  64. package/lib/interface/user.d.ts +4 -4
  65. package/lib/interface/user.d.ts.map +1 -1
  66. package/lib/interface/vendor.d.ts +1 -1
  67. package/lib/interface/vendor.d.ts.map +1 -1
  68. package/package.json +2 -2
  69. package/src/base.ts +2 -1
  70. package/src/index.ts +22 -0
  71. package/src/interface/ai.ts +3 -3
  72. package/src/interface/announcement.ts +2 -2
  73. package/src/interface/calendar.ts +1 -1
  74. package/src/interface/centricos.ts +3 -3
  75. package/src/interface/compassconnect.ts +1 -1
  76. package/src/interface/config.ts +81 -15
  77. package/src/interface/datalake.ts +2 -2
  78. package/src/interface/delivery.ts +3 -3
  79. package/src/interface/email.ts +2 -2
  80. package/src/interface/file.ts +1 -1
  81. package/src/interface/frictionless.ts +1 -1
  82. package/src/interface/kds.ts +1 -1
  83. package/src/interface/location.ts +12 -20
  84. package/src/interface/mealplan.ts +1 -1
  85. package/src/interface/menu.ts +241 -245
  86. package/src/interface/notification.ts +2 -2
  87. package/src/interface/order.ts +3 -3
  88. package/src/interface/partner.ts +17 -21
  89. package/src/interface/payment.ts +17 -4
  90. package/src/interface/promo.ts +5 -11
  91. package/src/interface/report.ts +1 -1
  92. package/src/interface/shoppingcart.ts +8 -11
  93. package/src/interface/task.ts +5 -5
  94. package/src/interface/user.ts +4 -4
  95. package/src/interface/vendor.ts +1 -1
  96. package/test/client.test.ts +2 -0
@@ -6,7 +6,7 @@ import { RequestQuery, BaseRequest } from "./util";
6
6
  export interface Error {
7
7
  message?: string;
8
8
  code?: number;
9
- data?: any;
9
+ data?: Record<string, any>;
10
10
  }
11
11
 
12
12
  export interface Delivery {
@@ -81,8 +81,8 @@ export interface Available {
81
81
 
82
82
  export interface PostAvailabilityBody {
83
83
  destination: {
84
- latitude: any;
85
- longitude: any;
84
+ latitude: Record<string, any>;
85
+ longitude: Record<string, any>;
86
86
  };
87
87
  brand_id: string;
88
88
  }
@@ -6,7 +6,7 @@ import { RequestQuery, BaseRequest } from "./util";
6
6
  export interface Error {
7
7
  message?: string;
8
8
  code?: number;
9
- data?: any;
9
+ data?: Record<string, any>;
10
10
  }
11
11
 
12
12
  export interface Success {
@@ -20,7 +20,7 @@ export interface EmailPayload {
20
20
  // Text of an email instead of template_id/data
21
21
  text?: string;
22
22
  template_id?: string;
23
- data?: any;
23
+ data?: Record<string, any>;
24
24
  }
25
25
 
26
26
  // POST /email - Send an email
@@ -6,7 +6,7 @@ import { RequestQuery, BaseRequest } from "./util";
6
6
  export interface Error {
7
7
  message?: string;
8
8
  code?: number;
9
- data?: any;
9
+ data?: Record<string, any>;
10
10
  }
11
11
 
12
12
  export interface File {
@@ -28,7 +28,7 @@ export interface NotFoundErrorDTO {
28
28
  message: string;
29
29
  }
30
30
 
31
- export type MealplanDTO = any;
31
+ export type MealplanDTO = Record<string, any>;
32
32
 
33
33
  export interface CreditCardDTO {
34
34
  cardType: string;
@@ -11,7 +11,7 @@ export interface Error {
11
11
  error?: string;
12
12
  message?: string;
13
13
  code: number;
14
- data?: any;
14
+ data?: Record<string, any>;
15
15
  }
16
16
 
17
17
  export interface Device {
@@ -95,10 +95,10 @@ export interface Brand {
95
95
  };
96
96
  hours?: Hours[];
97
97
  deliveryHours?: DeliveryHours[];
98
- style?: any;
98
+ style?: Record<string, any>;
99
99
  // pos
100
100
  pos?: string;
101
- terminals?: any[];
101
+ terminals?: Record<string, any>[];
102
102
  timeslots?: {
103
103
  time?: string;
104
104
  averagePrepTime?: string;
@@ -143,8 +143,8 @@ export interface Brand {
143
143
  // company
144
144
  company?: string;
145
145
  config?: {
146
- private?: any;
147
- public?: any;
146
+ private?: Record<string, any>;
147
+ public?: Record<string, any>;
148
148
  };
149
149
  tax_rate?: number;
150
150
  meta?: {
@@ -252,8 +252,8 @@ export interface Location {
252
252
  en?: string;
253
253
  fr?: string;
254
254
  };
255
- hours?: any;
256
- deliveryHours?: any;
255
+ hours?: Record<string, any>;
256
+ deliveryHours?: Record<string, any>;
257
257
  service_fee?: {
258
258
  type?: string;
259
259
  value?: number;
@@ -278,7 +278,7 @@ export interface Group {
278
278
  meta?: {
279
279
  [index: string]: any;
280
280
  };
281
- style?: any;
281
+ style?: Record<string, any>;
282
282
  [index: string]: any;
283
283
  }
284
284
 
@@ -297,7 +297,7 @@ export interface success {
297
297
  export interface Error {
298
298
  error?: string;
299
299
  code?: number;
300
- data?: any;
300
+ data?: Record<string, any>;
301
301
  }
302
302
 
303
303
  export interface Sector {
@@ -416,11 +416,7 @@ export interface BadRequest {
416
416
  error?: string;
417
417
  }
418
418
 
419
- enum PartnerStatus {
420
- AWAIT_PARTNER = "await_partner",
421
- AWAIT_SCOUT = "await_scout",
422
- COMPLETED = "completed",
423
- }
419
+ export type PartnerStatus = "await_partner" | "await_scout" | "completed";
424
420
 
425
421
  export interface WaitTime {
426
422
  // maxium wait time to the next time slot in minutes
@@ -431,11 +427,7 @@ export interface WaitTime {
431
427
  ready_time: number;
432
428
  }
433
429
 
434
- enum BrandOrMenuState {
435
- OPEN = "open",
436
- CLOSED = "closed",
437
- PREORDER = "preorder",
438
- }
430
+ export type BrandOrMenuState = "open" | "closed" | "preorder";
439
431
 
440
432
  export interface MenuAssociations {
441
433
  menu_associations?: MenuAssociation[];
@@ -505,7 +497,7 @@ export interface GetLocationQuery {
505
497
  // When fetching location, brands will come with private and public configs
506
498
  include_brands_config?: boolean;
507
499
  // active cafes
508
- active_cafes?: any[];
500
+ active_cafes?: Record<string, any>[];
509
501
  // show additional hidden properties/entities
510
502
  extended?: boolean;
511
503
  // Graphql query string
@@ -1219,7 +1211,7 @@ export interface PostLocationCompanyBody {
1219
1211
  name: string;
1220
1212
  // sector
1221
1213
  sector: string;
1222
- label?: any;
1214
+ label?: Record<string, any>;
1223
1215
  is?: {
1224
1216
  global_images_enabled?: boolean;
1225
1217
  };
@@ -6,7 +6,7 @@ import { RequestQuery, BaseRequest } from "./util";
6
6
  export interface Error {
7
7
  code?: number;
8
8
  message?: string;
9
- data?: any;
9
+ data?: Record<string, any>;
10
10
  headers?: {
11
11
  Location?: string;
12
12
  };