@compassdigital/sdk.typescript 4.16.0 → 4.16.2

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 +11 -1
  2. package/lib/base.d.ts.map +1 -1
  3. package/lib/base.js +21 -3
  4. package/lib/base.js.map +1 -1
  5. package/lib/index.d.ts +20 -3
  6. package/lib/index.d.ts.map +1 -1
  7. package/lib/index.js +17 -0
  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 +1 -1
  14. package/lib/interface/calendar.d.ts.map +1 -1
  15. package/lib/interface/centricos.d.ts +19 -3
  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 +2 -2
  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 +5 -5
  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 +12 -21
  34. package/lib/interface/location.d.ts.map +1 -1
  35. package/lib/interface/location.js +0 -12
  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 +253 -255
  40. package/lib/interface/menu.d.ts.map +1 -1
  41. package/lib/interface/menu.js +0 -6
  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 +4 -4
  46. package/lib/interface/order.d.ts.map +1 -1
  47. package/lib/interface/partner.d.ts +18 -26
  48. package/lib/interface/partner.d.ts.map +1 -1
  49. package/lib/interface/partner.js +0 -11
  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 +5 -12
  54. package/lib/interface/promo.d.ts.map +1 -1
  55. package/lib/interface/promo.js +0 -8
  56. package/lib/interface/promo.js.map +1 -1
  57. package/lib/interface/report.d.ts +1 -1
  58. package/lib/interface/report.d.ts.map +1 -1
  59. package/lib/interface/shoppingcart.d.ts +8 -12
  60. package/lib/interface/shoppingcart.d.ts.map +1 -1
  61. package/lib/interface/shoppingcart.js +0 -5
  62. package/lib/interface/shoppingcart.js.map +1 -1
  63. package/lib/interface/task.d.ts +6 -14
  64. package/lib/interface/task.d.ts.map +1 -1
  65. package/lib/interface/task.js +0 -9
  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 +0 -19
  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 +2 -2
  74. package/src/base.ts +25 -6
  75. package/src/index.ts +47 -1
  76. package/src/interface/ai.ts +3 -3
  77. package/src/interface/announcement.ts +2 -2
  78. package/src/interface/calendar.ts +1 -1
  79. package/src/interface/centricos.ts +34 -3
  80. package/src/interface/compassconnect.ts +1 -1
  81. package/src/interface/config.ts +2 -2
  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 +5 -5
  87. package/src/interface/kds.ts +1 -1
  88. package/src/interface/location.ts +12 -20
  89. package/src/interface/mealplan.ts +1 -1
  90. package/src/interface/menu.ts +254 -253
  91. package/src/interface/notification.ts +2 -2
  92. package/src/interface/order.ts +5 -4
  93. package/src/interface/partner.ts +18 -25
  94. package/src/interface/payment.ts +1 -1
  95. package/src/interface/promo.ts +5 -11
  96. package/src/interface/report.ts +1 -1
  97. package/src/interface/shoppingcart.ts +8 -11
  98. package/src/interface/task.ts +12 -13
  99. package/src/interface/user.ts +4 -4
  100. package/src/interface/util.ts +0 -21
  101. package/src/interface/vendor.ts +1 -1
@@ -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 Event {
@@ -15,16 +15,16 @@ export interface AIItemDescriptionResponse {
15
15
  export interface BadRequestErrorDTO {
16
16
  message: string;
17
17
  code: number;
18
- data: any;
18
+ data: Record<string, any>;
19
19
  }
20
20
 
21
21
  export interface UnauthorizedErrorDTO {
22
22
  message: string;
23
23
  code: number;
24
- data: any;
24
+ data: Record<string, any>;
25
25
  }
26
26
 
27
- export type InternalServerErrorException = any;
27
+ export type InternalServerErrorException = Record<string, any>;
28
28
 
29
29
  export interface AIItemImageRequest {
30
30
  name?: string;
@@ -73,6 +73,10 @@ export interface ReportDefaultConfigResponse {
73
73
  day_parts: DayPart[];
74
74
  }
75
75
 
76
+ export interface LookerEmbedURLResponse {
77
+ url: string;
78
+ }
79
+
76
80
  // POST /centricos/ai/item/description - Generate item description
77
81
 
78
82
  export type PostCentricosAiItemDescriptionBody = AIItemDescriptionRequest;
@@ -178,6 +182,19 @@ export interface PutCentricosReportGroupConfigRequest
178
182
  body: PutCentricosReportGroupConfigBody;
179
183
  }
180
184
 
185
+ // DELETE /centricos/report/group/{location_group}/config - Delete report configuration for a location group.
186
+
187
+ export interface DeleteCentricosReportGroupConfigPath {
188
+ // TODO: add parameter to swagger.json
189
+ location_group: string;
190
+ }
191
+
192
+ export type DeleteCentricosReportGroupConfigResponse = ReportGroupConfigResponse;
193
+
194
+ export interface DeleteCentricosReportGroupConfigRequest
195
+ extends BaseRequest,
196
+ DeleteCentricosReportGroupConfigPath {}
197
+
181
198
  // GET /centricos/report/config/default - Get default report configuration. Times are in UTC.
182
199
 
183
200
  export interface GetCentricosReportConfigDefaultQuery {
@@ -190,3 +207,17 @@ export type GetCentricosReportConfigDefaultResponse = ReportDefaultConfigRespons
190
207
  export interface GetCentricosReportConfigDefaultRequest
191
208
  extends BaseRequest,
192
209
  RequestQuery<GetCentricosReportConfigDefaultQuery> {}
210
+
211
+ // GET /centricos/looker/embedurl - Get a signed URL for looker embeding
212
+
213
+ export interface GetCentricosLookerEmbedurlQuery {
214
+ src: string;
215
+ // Graphql query string
216
+ _query?: string;
217
+ }
218
+
219
+ export type GetCentricosLookerEmbedurlResponse = LookerEmbedURLResponse;
220
+
221
+ export interface GetCentricosLookerEmbedurlRequest
222
+ extends BaseRequest,
223
+ RequestQuery<GetCentricosLookerEmbedurlQuery> {}
@@ -13,7 +13,7 @@ export interface OMSRequest {
13
13
  export interface Error {
14
14
  message?: string;
15
15
  code?: number;
16
- data?: any;
16
+ data?: Record<string, any>;
17
17
  }
18
18
 
19
19
  export interface Auth {
@@ -3,7 +3,7 @@
3
3
 
4
4
  import { RequestQuery, BaseRequest } from "./util";
5
5
 
6
- export type CreateConfig = any;
6
+ export type CreateConfig = Record<string, any>;
7
7
 
8
8
  export interface Config {
9
9
  [index: string]: any;
@@ -12,7 +12,7 @@ export interface Config {
12
12
  export interface Error {
13
13
  error?: string;
14
14
  code?: number;
15
- data?: any;
15
+ data?: Record<string, any>;
16
16
  }
17
17
 
18
18
  export interface Success {
@@ -6,7 +6,7 @@ import { RequestQuery, BaseRequest } from "./util";
6
6
  export interface Error {
7
7
  error?: string;
8
8
  code?: number;
9
- data?: any;
9
+ data?: Record<string, any>;
10
10
  }
11
11
 
12
12
  export interface QueryBody {
@@ -34,7 +34,7 @@ export interface GetDatalakeSwaggerQuery {
34
34
  _query?: string;
35
35
  }
36
36
 
37
- export type GetDatalakeSwaggerResponse = any;
37
+ export type GetDatalakeSwaggerResponse = Record<string, any>;
38
38
 
39
39
  export interface GetDatalakeSwaggerRequest
40
40
  extends BaseRequest,
@@ -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 {
@@ -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 {
@@ -39,13 +39,13 @@ export interface AmazonJWOIdentityKeysResponseDTO {
39
39
  export interface BadRequestErrorDTO {
40
40
  message: string;
41
41
  code: number;
42
- data: any;
42
+ data: Record<string, any>;
43
43
  }
44
44
 
45
45
  export interface UnauthorizedErrorDTO {
46
46
  message: string;
47
47
  code: number;
48
- data: any;
48
+ data: Record<string, any>;
49
49
  }
50
50
 
51
51
  export interface ShoppingTrip {
@@ -100,13 +100,13 @@ export interface FrictionlessSupportResponse {
100
100
  export interface ForbiddenErrorDTO {
101
101
  message: string;
102
102
  code: number;
103
- data: any;
103
+ data: Record<string, any>;
104
104
  }
105
105
 
106
106
  export interface NotFoundErrorDTO {
107
107
  message: string;
108
108
  code: number;
109
- data: any;
109
+ data: Record<string, any>;
110
110
  }
111
111
 
112
112
  export interface MealplanDTO {
@@ -245,7 +245,7 @@ export interface GetFrictionlessBrandFrictionlessStatusRequest
245
245
 
246
246
  export type PostFrictionlessQrCodeBody = CreateFrictionlessQRCodeCommand;
247
247
 
248
- export type PostFrictionlessQrCodeResponse = {};
248
+ export type PostFrictionlessQrCodeResponse = QRCodeCreationResponse;
249
249
 
250
250
  export interface PostFrictionlessQrCodeRequest extends BaseRequest {
251
251
  body: PostFrictionlessQrCodeBody;
@@ -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;
@@ -145,8 +145,8 @@ export interface Brand {
145
145
  // company
146
146
  company?: string;
147
147
  config?: {
148
- private?: any;
149
- public?: any;
148
+ private?: Record<string, any>;
149
+ public?: Record<string, any>;
150
150
  };
151
151
  tax_rate?: number;
152
152
  meta?: {
@@ -254,8 +254,8 @@ export interface Location {
254
254
  en?: string;
255
255
  fr?: string;
256
256
  };
257
- hours?: any;
258
- deliveryHours?: any;
257
+ hours?: Record<string, any>;
258
+ deliveryHours?: Record<string, any>;
259
259
  service_fee?: {
260
260
  type?: string;
261
261
  value?: number;
@@ -280,7 +280,7 @@ export interface Group {
280
280
  meta?: {
281
281
  [index: string]: any;
282
282
  };
283
- style?: any;
283
+ style?: Record<string, any>;
284
284
  [index: string]: any;
285
285
  }
286
286
 
@@ -299,7 +299,7 @@ export interface success {
299
299
  export interface Error {
300
300
  error?: string;
301
301
  code?: number;
302
- data?: any;
302
+ data?: Record<string, any>;
303
303
  }
304
304
 
305
305
  export interface Sector {
@@ -418,11 +418,7 @@ export interface BadRequest {
418
418
  error?: string;
419
419
  }
420
420
 
421
- enum PartnerStatus {
422
- AWAIT_PARTNER = "await_partner",
423
- AWAIT_SCOUT = "await_scout",
424
- COMPLETED = "completed",
425
- }
421
+ export type PartnerStatus = "await_partner" | "await_scout" | "completed";
426
422
 
427
423
  export interface WaitTime {
428
424
  // maxium wait time to the next time slot in minutes
@@ -433,11 +429,7 @@ export interface WaitTime {
433
429
  ready_time: number;
434
430
  }
435
431
 
436
- enum BrandOrMenuState {
437
- OPEN = "open",
438
- CLOSED = "closed",
439
- PREORDER = "preorder",
440
- }
432
+ export type BrandOrMenuState = "open" | "closed" | "preorder";
441
433
 
442
434
  export interface MenuAssociations {
443
435
  menu_associations?: MenuAssociation[];
@@ -507,7 +499,7 @@ export interface GetLocationQuery {
507
499
  // When fetching location, brands will come with private and public configs
508
500
  include_brands_config?: boolean;
509
501
  // active cafes
510
- active_cafes?: any[];
502
+ active_cafes?: Record<string, any>[];
511
503
  // show additional hidden properties/entities
512
504
  extended?: boolean;
513
505
  // Graphql query string
@@ -1223,7 +1215,7 @@ export interface PostLocationCompanyBody {
1223
1215
  name: string;
1224
1216
  // sector
1225
1217
  sector: string;
1226
- label?: any;
1218
+ label?: Record<string, any>;
1227
1219
  is?: {
1228
1220
  global_images_enabled?: boolean;
1229
1221
  };
@@ -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
  };