@compassdigital/sdk.typescript 4.66.0 → 4.68.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 (88) hide show
  1. package/lib/index.d.ts +58 -85
  2. package/lib/index.d.ts.map +1 -1
  3. package/lib/index.js +503 -530
  4. package/lib/index.js.map +1 -1
  5. package/lib/interface/ai.d.ts +1 -1
  6. package/lib/interface/ai.d.ts.map +1 -1
  7. package/lib/interface/announcement.d.ts +1 -1
  8. package/lib/interface/announcement.d.ts.map +1 -1
  9. package/lib/interface/auth.d.ts +3 -3
  10. package/lib/interface/auth.d.ts.map +1 -1
  11. package/lib/interface/calendar.d.ts +2 -2
  12. package/lib/interface/calendar.d.ts.map +1 -1
  13. package/lib/interface/centricos.d.ts +11 -11
  14. package/lib/interface/centricos.d.ts.map +1 -1
  15. package/lib/interface/compassconnect.d.ts +1 -1
  16. package/lib/interface/compassconnect.d.ts.map +1 -1
  17. package/lib/interface/config.d.ts +1 -1
  18. package/lib/interface/config.d.ts.map +1 -1
  19. package/lib/interface/datalake.d.ts +1 -1
  20. package/lib/interface/datalake.d.ts.map +1 -1
  21. package/lib/interface/email.d.ts +1 -1
  22. package/lib/interface/email.d.ts.map +1 -1
  23. package/lib/interface/file.d.ts +2 -2
  24. package/lib/interface/file.d.ts.map +1 -1
  25. package/lib/interface/frictionless.d.ts +9 -9
  26. package/lib/interface/frictionless.d.ts.map +1 -1
  27. package/lib/interface/kds.d.ts +1 -1
  28. package/lib/interface/kds.d.ts.map +1 -1
  29. package/lib/interface/location.d.ts +5 -3
  30. package/lib/interface/location.d.ts.map +1 -1
  31. package/lib/interface/mealplan.d.ts +2 -1
  32. package/lib/interface/mealplan.d.ts.map +1 -1
  33. package/lib/interface/menu.d.ts +149 -109
  34. package/lib/interface/menu.d.ts.map +1 -1
  35. package/lib/interface/notification.d.ts +3 -3
  36. package/lib/interface/notification.d.ts.map +1 -1
  37. package/lib/interface/order.d.ts +7 -7
  38. package/lib/interface/order.d.ts.map +1 -1
  39. package/lib/interface/partner.d.ts +10 -10
  40. package/lib/interface/partner.d.ts.map +1 -1
  41. package/lib/interface/payment.d.ts +3 -3
  42. package/lib/interface/payment.d.ts.map +1 -1
  43. package/lib/interface/promo.d.ts +8 -8
  44. package/lib/interface/promo.d.ts.map +1 -1
  45. package/lib/interface/report.d.ts +10 -10
  46. package/lib/interface/report.d.ts.map +1 -1
  47. package/lib/interface/search.d.ts +8 -8
  48. package/lib/interface/search.d.ts.map +1 -1
  49. package/lib/interface/shoppingcart.d.ts +7 -7
  50. package/lib/interface/shoppingcart.d.ts.map +1 -1
  51. package/lib/interface/task.d.ts +8 -8
  52. package/lib/interface/task.d.ts.map +1 -1
  53. package/lib/interface/tax.d.ts +2 -2
  54. package/lib/interface/tax.d.ts.map +1 -1
  55. package/lib/interface/user.d.ts +16 -16
  56. package/lib/interface/user.d.ts.map +1 -1
  57. package/lib/interface/vendor.d.ts +6 -6
  58. package/lib/interface/vendor.d.ts.map +1 -1
  59. package/manifest.json +0 -4
  60. package/package.json +2 -2
  61. package/src/index.ts +10395 -10464
  62. package/src/interface/ai.ts +22 -22
  63. package/src/interface/announcement.ts +60 -60
  64. package/src/interface/auth.ts +68 -68
  65. package/src/interface/calendar.ts +94 -94
  66. package/src/interface/centricos.ts +145 -145
  67. package/src/interface/compassconnect.ts +59 -59
  68. package/src/interface/config.ts +166 -166
  69. package/src/interface/datalake.ts +13 -13
  70. package/src/interface/email.ts +13 -13
  71. package/src/interface/file.ts +18 -18
  72. package/src/interface/frictionless.ts +177 -177
  73. package/src/interface/kds.ts +49 -49
  74. package/src/interface/location.ts +771 -769
  75. package/src/interface/mealplan.ts +155 -154
  76. package/src/interface/menu.ts +4079 -4018
  77. package/src/interface/notification.ts +51 -51
  78. package/src/interface/order.ts +464 -464
  79. package/src/interface/partner.ts +823 -823
  80. package/src/interface/payment.ts +278 -278
  81. package/src/interface/promo.ts +373 -373
  82. package/src/interface/report.ts +348 -348
  83. package/src/interface/search.ts +135 -135
  84. package/src/interface/shoppingcart.ts +429 -429
  85. package/src/interface/task.ts +212 -212
  86. package/src/interface/tax.ts +69 -69
  87. package/src/interface/user.ts +410 -410
  88. package/src/interface/vendor.ts +215 -215
@@ -1,439 +1,439 @@
1
1
  /* eslint-disable */
2
2
  // THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
3
3
 
4
- import { RequestQuery, BaseRequest } from "./util";
4
+ import { RequestQuery, BaseRequest } from './util';
5
5
 
6
6
  export interface Success {
7
- success?: boolean;
7
+ success?: boolean;
8
8
  }
9
9
 
10
10
  export interface Error {
11
- message?: string;
12
- code?: number;
13
- data?: Record<string, any>;
11
+ message?: string;
12
+ code?: number;
13
+ data?: Record<string, any>;
14
14
  }
15
15
 
16
16
  export interface EODReports {
17
- reports?: {
18
- id?: string;
19
- unit?: number;
20
- data?: Summary;
21
- }[];
22
- summary?: Summary;
23
- // Base64 encoded file
24
- file?: string;
25
- // Base64 encoded file format
26
- format?: string;
17
+ reports?: {
18
+ id?: string;
19
+ unit?: number;
20
+ data?: Summary;
21
+ }[];
22
+ summary?: Summary;
23
+ // Base64 encoded file
24
+ file?: string;
25
+ // Base64 encoded file format
26
+ format?: string;
27
27
  }
28
28
 
29
29
  export interface TotalSummary {
30
- // Beginning reading
31
- beginning: number;
32
- // End reading
33
- end: number;
34
- // Order subtotals
35
- subtotal: number;
36
- // Order gross (subtotal + taxes)
37
- gross: number;
38
- // Order discounts
39
- discount: number;
40
- // Order fee (service, delivery)
41
- fees: number;
42
- // Order tax
43
- taxes: number;
44
- // Net sales (gross - discount - taxes)
45
- net_sales: number;
46
- // Total (register total)
47
- register: number;
48
- // Number of orders
49
- count: number;
50
- // Goods and services tax || HST
51
- gst?: number;
52
- // Provincial sales tax || QST
53
- pst?: number;
30
+ // Beginning reading
31
+ beginning: number;
32
+ // End reading
33
+ end: number;
34
+ // Order subtotals
35
+ subtotal: number;
36
+ // Order gross (subtotal + taxes)
37
+ gross: number;
38
+ // Order discounts
39
+ discount: number;
40
+ // Order fee (service, delivery)
41
+ fees: number;
42
+ // Order tax
43
+ taxes: number;
44
+ // Net sales (gross - discount - taxes)
45
+ net_sales: number;
46
+ // Total (register total)
47
+ register: number;
48
+ // Number of orders
49
+ count: number;
50
+ // Goods and services tax || HST
51
+ gst?: number;
52
+ // Provincial sales tax || QST
53
+ pst?: number;
54
54
  }
55
55
 
56
56
  export interface PaymentTypes {
57
- // Payment type (Visa, MasterCard, Discover, etc...)
58
- types?: string;
59
- // Number of order per payment type
60
- num_order?: number;
61
- // Subtotal of payment type
62
- subtotal?: number;
63
- // Taxes for payment type
64
- taxes?: number;
65
- // GST/HST for payment type
66
- gst?: number;
67
- // PST/QST for payment type
68
- pst?: number;
69
- // Total for payment type
70
- total?: number;
57
+ // Payment type (Visa, MasterCard, Discover, etc...)
58
+ types?: string;
59
+ // Number of order per payment type
60
+ num_order?: number;
61
+ // Subtotal of payment type
62
+ subtotal?: number;
63
+ // Taxes for payment type
64
+ taxes?: number;
65
+ // GST/HST for payment type
66
+ gst?: number;
67
+ // PST/QST for payment type
68
+ pst?: number;
69
+ // Total for payment type
70
+ total?: number;
71
71
  }
72
72
 
73
73
  export interface Disbursements {
74
- types?: {
75
- PAYMENT_NAME?: PaymentTypes;
76
- };
77
- // Number of order for all payment types
78
- num_order?: number;
79
- // Total for all payment types
80
- total?: number;
74
+ types?: {
75
+ PAYMENT_NAME?: PaymentTypes;
76
+ };
77
+ // Number of order for all payment types
78
+ num_order?: number;
79
+ // Total for all payment types
80
+ total?: number;
81
81
  }
82
82
 
83
83
  export interface Promo {
84
- // Number of order per promo code
85
- num_order?: number;
86
- // Total for promo code
87
- total?: number;
84
+ // Number of order per promo code
85
+ num_order?: number;
86
+ // Total for promo code
87
+ total?: number;
88
88
  }
89
89
 
90
90
  export interface Discounts {
91
- types?: {
92
- promo?: {
93
- DISCOUNT_CODE_NAME?: Promo;
94
- };
95
- };
96
- // Number of order for all promo codes
97
- num_order?: number;
98
- // Total for all promo codes
99
- total?: number;
91
+ types?: {
92
+ promo?: {
93
+ DISCOUNT_CODE_NAME?: Promo;
94
+ };
95
+ };
96
+ // Number of order for all promo codes
97
+ num_order?: number;
98
+ // Total for all promo codes
99
+ total?: number;
100
100
  }
101
101
 
102
102
  export interface Fee {
103
- amounts?: {
104
- // Number of order for fee amount
105
- num_order?: number;
106
- // Total for fee amount
107
- total?: number;
108
- };
109
- // Total for promo code
110
- total?: number;
103
+ amounts?: {
104
+ // Number of order for fee amount
105
+ num_order?: number;
106
+ // Total for fee amount
107
+ total?: number;
108
+ };
109
+ // Total for promo code
110
+ total?: number;
111
111
  }
112
112
 
113
113
  export interface Fees {
114
- types?: {
115
- FEE_NAME?: Fee;
116
- };
117
- // Number of order for all fees applied
118
- num_order?: number;
119
- // Total for all fees applied
120
- total?: number;
114
+ types?: {
115
+ FEE_NAME?: Fee;
116
+ };
117
+ // Number of order for all fees applied
118
+ num_order?: number;
119
+ // Total for all fees applied
120
+ total?: number;
121
121
  }
122
122
 
123
123
  export interface TimeOfDay {
124
- times?: {
125
- // Total for promo code
126
- Breakfast?: {
127
- // Number of orders during breakfast
128
- num_order?: number;
129
- // Total for breakfast
130
- total?: number;
131
- // Number of orders prepared during breakfast
132
- num_orders_by_prep_time?: number;
133
- // Total for prepared breakfast
134
- total_by_prep_time?: number;
135
- };
136
- // Total for promo code
137
- Lunch?: {
138
- // Number of orders during lunch
139
- num_order?: number;
140
- // Total for lunch
141
- total?: number;
142
- // Number of orders prepared during lunch
143
- num_orders_by_prep_time?: number;
144
- // Total for prepared lunch
145
- total_by_prep_time?: number;
146
- };
147
- // Total for promo code
148
- Dinner?: {
149
- // Number of orders during dinner
150
- num_order?: number;
151
- // Total for dinner
152
- total?: number;
153
- // Number of orders prepared during dinner
154
- num_orders_by_prep_time?: number;
155
- // Total for prepared dinner
156
- total_by_prep_time?: number;
157
- };
158
- };
159
- // Taxes for the day
160
- taxes?: number;
161
- // GST/HST for the day
162
- gst?: number;
163
- // PST/QST for the day
164
- pst?: number;
165
- // Total orders for the day
166
- count_total_daily?: number;
167
- // Total order earnings for the day
168
- net_total_daily?: number;
124
+ times?: {
125
+ // Total for promo code
126
+ Breakfast?: {
127
+ // Number of orders during breakfast
128
+ num_order?: number;
129
+ // Total for breakfast
130
+ total?: number;
131
+ // Number of orders prepared during breakfast
132
+ num_orders_by_prep_time?: number;
133
+ // Total for prepared breakfast
134
+ total_by_prep_time?: number;
135
+ };
136
+ // Total for promo code
137
+ Lunch?: {
138
+ // Number of orders during lunch
139
+ num_order?: number;
140
+ // Total for lunch
141
+ total?: number;
142
+ // Number of orders prepared during lunch
143
+ num_orders_by_prep_time?: number;
144
+ // Total for prepared lunch
145
+ total_by_prep_time?: number;
146
+ };
147
+ // Total for promo code
148
+ Dinner?: {
149
+ // Number of orders during dinner
150
+ num_order?: number;
151
+ // Total for dinner
152
+ total?: number;
153
+ // Number of orders prepared during dinner
154
+ num_orders_by_prep_time?: number;
155
+ // Total for prepared dinner
156
+ total_by_prep_time?: number;
157
+ };
158
+ };
159
+ // Taxes for the day
160
+ taxes?: number;
161
+ // GST/HST for the day
162
+ gst?: number;
163
+ // PST/QST for the day
164
+ pst?: number;
165
+ // Total orders for the day
166
+ count_total_daily?: number;
167
+ // Total order earnings for the day
168
+ net_total_daily?: number;
169
169
  }
170
170
 
171
171
  export interface Distribution {
172
- time_of_day?: TimeOfDay;
173
- brands?: Brands;
174
- grand_total?: GrandTotal;
175
- web_total?: GrandTotal;
172
+ time_of_day?: TimeOfDay;
173
+ brands?: Brands;
174
+ grand_total?: GrandTotal;
175
+ web_total?: GrandTotal;
176
176
  }
177
177
 
178
178
  export interface BrandPayments {
179
- // Number of order per payment type
180
- count?: number;
181
- // Subtotal of payment type
182
- subtotal?: number;
183
- // Gross earnings for payment type
184
- gross?: number;
185
- // Total discount for payment type
186
- total_discount?: number;
187
- // Total fees for payment type
188
- total_fees?: number;
189
- // Taxes for payment type
190
- taxes?: number;
191
- // GST/HST for payment type
192
- gst?: number;
193
- // PST/QST for payment type
194
- pst?: number;
195
- // Net sales for payment type
196
- net_sales?: number;
197
- // Total for payment type
198
- total?: number;
179
+ // Number of order per payment type
180
+ count?: number;
181
+ // Subtotal of payment type
182
+ subtotal?: number;
183
+ // Gross earnings for payment type
184
+ gross?: number;
185
+ // Total discount for payment type
186
+ total_discount?: number;
187
+ // Total fees for payment type
188
+ total_fees?: number;
189
+ // Taxes for payment type
190
+ taxes?: number;
191
+ // GST/HST for payment type
192
+ gst?: number;
193
+ // PST/QST for payment type
194
+ pst?: number;
195
+ // Net sales for payment type
196
+ net_sales?: number;
197
+ // Total for payment type
198
+ total?: number;
199
199
  }
200
200
 
201
201
  export interface BrandTotals {
202
- PAYMENT_TYPE?: BrandPayments;
203
- "Brand Total"?: BrandPayments;
202
+ PAYMENT_TYPE?: BrandPayments;
203
+ 'Brand Total'?: BrandPayments;
204
204
  }
205
205
 
206
206
  export interface Brands {
207
- names?: {
208
- BRAND_NAME?: BrandTotals;
209
- };
210
- // Number of order for all payment types
211
- num_order?: number;
212
- // Total for all payment types
213
- total?: number;
207
+ names?: {
208
+ BRAND_NAME?: BrandTotals;
209
+ };
210
+ // Number of order for all payment types
211
+ num_order?: number;
212
+ // Total for all payment types
213
+ total?: number;
214
214
  }
215
215
 
216
216
  export interface GrandTotal {
217
- // gross earnings
218
- gross?: number;
219
- // total earnings
220
- total?: number;
221
- // order count
222
- count?: number;
223
- // subtotal earnings
224
- sub_total?: number;
225
- // total service fees earnings
226
- service_fees?: number;
227
- // total delivery fees earnings
228
- delivery_fees?: number;
229
- // total discounts applied
230
- discounts?: number;
231
- // total taxes applied
232
- taxes?: number;
233
- // total net sales
234
- net_sales?: number;
235
- // total pst applied
236
- pst?: number;
237
- // total gst applied
238
- gst?: number;
217
+ // gross earnings
218
+ gross?: number;
219
+ // total earnings
220
+ total?: number;
221
+ // order count
222
+ count?: number;
223
+ // subtotal earnings
224
+ sub_total?: number;
225
+ // total service fees earnings
226
+ service_fees?: number;
227
+ // total delivery fees earnings
228
+ delivery_fees?: number;
229
+ // total discounts applied
230
+ discounts?: number;
231
+ // total taxes applied
232
+ taxes?: number;
233
+ // total net sales
234
+ net_sales?: number;
235
+ // total pst applied
236
+ pst?: number;
237
+ // total gst applied
238
+ gst?: number;
239
239
  }
240
240
 
241
241
  export interface Summary {
242
- summary?: {
243
- summary?: TotalSummary;
244
- disbursement?: Disbursements;
245
- discount?: Discounts;
246
- fees?: Fees;
247
- };
248
- distribution?: Distribution;
242
+ summary?: {
243
+ summary?: TotalSummary;
244
+ disbursement?: Disbursements;
245
+ discount?: Discounts;
246
+ fees?: Fees;
247
+ };
248
+ distribution?: Distribution;
249
249
  }
250
250
 
251
251
  export interface EODSubscribers {
252
- subscribers?: {
253
- email?: string;
254
- // Units this user is subscribed to
255
- units?: {
256
- id?: string;
257
- unit?: number;
258
- }[];
259
- }[];
260
- // Number of units in this group
261
- total_units?: number;
252
+ subscribers?: {
253
+ email?: string;
254
+ // Units this user is subscribed to
255
+ units?: {
256
+ id?: string;
257
+ unit?: number;
258
+ }[];
259
+ }[];
260
+ // Number of units in this group
261
+ total_units?: number;
262
262
  }
263
263
 
264
264
  export interface Subscriber {
265
- email?: string;
266
- units?: number[];
265
+ email?: string;
266
+ units?: number[];
267
267
  }
268
268
 
269
269
  export interface SAReport {
270
- analytics?: {
271
- avg_bill: number;
272
- transactions_total: number;
273
- sales_total: number;
274
- years: string;
275
- dates: string[];
276
- series: {
277
- name: string;
278
- data: number[];
279
- }[];
280
- top_items: {
281
- sales: number;
282
- item_rank: number;
283
- location_description: string;
284
- [index: string]: any;
285
- }[];
286
- };
270
+ analytics?: {
271
+ avg_bill: number;
272
+ transactions_total: number;
273
+ sales_total: number;
274
+ years: string;
275
+ dates: string[];
276
+ series: {
277
+ name: string;
278
+ data: number[];
279
+ }[];
280
+ top_items: {
281
+ sales: number;
282
+ item_rank: number;
283
+ location_description: string;
284
+ [index: string]: any;
285
+ }[];
286
+ };
287
287
  }
288
288
 
289
289
  export interface P2AnalyticsReport {
290
- message?: string;
291
- date_resolved?: string;
292
- payload?: {
293
- location_group: string;
294
- location_id?: string;
295
- order_date?: string;
296
- brandname: string;
297
- brandid: string;
298
- avg_bill?: number;
299
- currency?: string;
300
- avg_cad_against_usd?: number;
301
- avg_cad_rate?: number;
302
- order_net_sales?: number;
303
- number_transactions?: number;
304
- itemlabel?: string;
305
- item_rank?: number;
306
- sales?: number;
307
- }[];
290
+ message?: string;
291
+ date_resolved?: string;
292
+ payload?: {
293
+ location_group: string;
294
+ location_id?: string;
295
+ order_date?: string;
296
+ brandname: string;
297
+ brandid: string;
298
+ avg_bill?: number;
299
+ currency?: string;
300
+ avg_cad_against_usd?: number;
301
+ avg_cad_rate?: number;
302
+ order_net_sales?: number;
303
+ number_transactions?: number;
304
+ itemlabel?: string;
305
+ item_rank?: number;
306
+ sales?: number;
307
+ }[];
308
308
  }
309
309
 
310
310
  export interface EODItemReport {
311
- // Base64 encoded file
312
- file?: string;
313
- // Base64 encoded file format
314
- format?: string;
311
+ // Base64 encoded file
312
+ file?: string;
313
+ // Base64 encoded file format
314
+ format?: string;
315
315
  }
316
316
 
317
317
  export type DayPartConfig = {
318
- label: string;
319
- // Time in 24-hour format (HH:MM).
320
- start: string;
321
- // Time in 24-hour format (HH:MM).
322
- end: string;
318
+ label: string;
319
+ // Time in 24-hour format (HH:MM).
320
+ start: string;
321
+ // Time in 24-hour format (HH:MM).
322
+ end: string;
323
323
  }[];
324
324
 
325
325
  export interface ReportGroupConfigRequest {
326
- // Time in 24-hour format (HH:MM).
327
- day_time: string;
328
- day_parts: DayPartConfig;
326
+ // Time in 24-hour format (HH:MM).
327
+ day_time: string;
328
+ day_parts: DayPartConfig;
329
329
  }
330
330
 
331
331
  export interface ReportGroupConfigResponse {
332
- location_group_id: string;
333
- // Time in 24-hour format (HH:MM).
334
- day_time: string;
335
- day_parts: DayPartConfig;
336
- is_default: boolean;
332
+ location_group_id: string;
333
+ // Time in 24-hour format (HH:MM).
334
+ day_time: string;
335
+ day_parts: DayPartConfig;
336
+ is_default: boolean;
337
337
  }
338
338
 
339
339
  // GET /report/analytics/group/{location_group}/{report_type}
340
340
 
341
341
  export interface GetReportAnalyticsGroupPath {
342
- location_group: string;
343
- report_type: "bills" | "sales" | "transactions" | "top-items";
342
+ location_group: string;
343
+ report_type: 'bills' | 'sales' | 'transactions' | 'top-items';
344
344
  }
345
345
 
346
346
  export interface GetReportAnalyticsGroupQuery {
347
- brand_id?: string;
348
- brand_ids?: string;
349
- start_date: string;
350
- end_date: string;
351
- time_frame: "week" | "month" | "day";
352
- order_type?: "delivery" | "pickup" | "frictionless";
353
- // Graphql query string
354
- _query?: string;
347
+ brand_id?: string;
348
+ brand_ids?: string;
349
+ start_date: string;
350
+ end_date: string;
351
+ time_frame: 'week' | 'month' | 'day';
352
+ order_type?: 'delivery' | 'pickup' | 'frictionless';
353
+ // Graphql query string
354
+ _query?: string;
355
355
  }
356
356
 
357
357
  export type GetReportAnalyticsGroupResponse = P2AnalyticsReport;
358
358
 
359
359
  export interface GetReportAnalyticsGroupRequest
360
- extends BaseRequest,
361
- RequestQuery<GetReportAnalyticsGroupQuery>,
362
- GetReportAnalyticsGroupPath {}
360
+ extends BaseRequest,
361
+ RequestQuery<GetReportAnalyticsGroupQuery>,
362
+ GetReportAnalyticsGroupPath {}
363
363
 
364
364
  // GET /report/analytics/combined/group/{location_group}
365
365
 
366
366
  export interface GetReportAnalyticsCombinedGroupPath {
367
- location_group: string;
367
+ location_group: string;
368
368
  }
369
369
 
370
370
  export interface GetReportAnalyticsCombinedGroupQuery {
371
- brand_id?: string;
372
- brand_ids?: string;
373
- start_date: string;
374
- end_date: string;
375
- time_frame: "week" | "month" | "day";
376
- order_type?: "delivery" | "pickup" | "frictionless";
377
- // Graphql query string
378
- _query?: string;
371
+ brand_id?: string;
372
+ brand_ids?: string;
373
+ start_date: string;
374
+ end_date: string;
375
+ time_frame: 'week' | 'month' | 'day';
376
+ order_type?: 'delivery' | 'pickup' | 'frictionless';
377
+ // Graphql query string
378
+ _query?: string;
379
379
  }
380
380
 
381
381
  export type GetReportAnalyticsCombinedGroupResponse = SAReport;
382
382
 
383
383
  export interface GetReportAnalyticsCombinedGroupRequest
384
- extends BaseRequest,
385
- RequestQuery<GetReportAnalyticsCombinedGroupQuery>,
386
- GetReportAnalyticsCombinedGroupPath {}
384
+ extends BaseRequest,
385
+ RequestQuery<GetReportAnalyticsCombinedGroupQuery>,
386
+ GetReportAnalyticsCombinedGroupPath {}
387
387
 
388
388
  // GET /report/eod/group/{id} - Get reports for selected location group
389
389
 
390
390
  export interface GetReportEodGroupPath {
391
- id: string;
391
+ id: string;
392
392
  }
393
393
 
394
394
  export interface GetReportEodGroupQuery {
395
- // Report start date in ISO 8601 format
396
- start?: string;
397
- // Report end date in ISO 8601 format
398
- end?: string;
399
- // Output format
400
- format?: "json" | "xslx";
401
- // Location IDs, comma-separated
402
- locations?: string;
403
- // Graphql query string
404
- _query?: string;
405
- nocache?: boolean;
395
+ // Report start date in ISO 8601 format
396
+ start?: string;
397
+ // Report end date in ISO 8601 format
398
+ end?: string;
399
+ // Output format
400
+ format?: 'json' | 'xslx';
401
+ // Location IDs, comma-separated
402
+ locations?: string;
403
+ // Graphql query string
404
+ _query?: string;
405
+ nocache?: boolean;
406
406
  }
407
407
 
408
408
  export type GetReportEodGroupResponse = EODReports;
409
409
 
410
410
  export interface GetReportEodGroupRequest
411
- extends BaseRequest,
412
- RequestQuery<GetReportEodGroupQuery>,
413
- GetReportEodGroupPath {}
411
+ extends BaseRequest,
412
+ RequestQuery<GetReportEodGroupQuery>,
413
+ GetReportEodGroupPath {}
414
414
 
415
415
  // GET /report/eod/group/{id}/subscribers - Get reports for selected location group
416
416
 
417
417
  export interface GetReportEodGroupSubscribersPath {
418
- id: string;
418
+ id: string;
419
419
  }
420
420
 
421
421
  export interface GetReportEodGroupSubscribersQuery {
422
- // Graphql query string
423
- _query?: string;
422
+ // Graphql query string
423
+ _query?: string;
424
424
  }
425
425
 
426
426
  export type GetReportEodGroupSubscribersResponse = EODSubscribers;
427
427
 
428
428
  export interface GetReportEodGroupSubscribersRequest
429
- extends BaseRequest,
430
- RequestQuery<GetReportEodGroupSubscribersQuery>,
431
- GetReportEodGroupSubscribersPath {}
429
+ extends BaseRequest,
430
+ RequestQuery<GetReportEodGroupSubscribersQuery>,
431
+ GetReportEodGroupSubscribersPath {}
432
432
 
433
433
  // POST /report/eod/group/{id}/subscribers - Add emails to selected location group
434
434
 
435
435
  export interface PostReportEodGroupSubscribersPath {
436
- id: string;
436
+ id: string;
437
437
  }
438
438
 
439
439
  export type PostReportEodGroupSubscribersBody = EODSubscribers;
@@ -441,27 +441,27 @@ export type PostReportEodGroupSubscribersBody = EODSubscribers;
441
441
  export type PostReportEodGroupSubscribersResponse = EODSubscribers;
442
442
 
443
443
  export interface PostReportEodGroupSubscribersRequest
444
- extends BaseRequest,
445
- PostReportEodGroupSubscribersPath {
446
- body: PostReportEodGroupSubscribersBody;
444
+ extends BaseRequest,
445
+ PostReportEodGroupSubscribersPath {
446
+ body: PostReportEodGroupSubscribersBody;
447
447
  }
448
448
 
449
449
  // DELETE /report/eod/group/{id}/subscribers - deletes subscribers from selected group
450
450
 
451
451
  export interface DeleteReportEodGroupSubscribersPath {
452
- id: string;
452
+ id: string;
453
453
  }
454
454
 
455
455
  export type DeleteReportEodGroupSubscribersResponse = Success;
456
456
 
457
457
  export interface DeleteReportEodGroupSubscribersRequest
458
- extends BaseRequest,
459
- DeleteReportEodGroupSubscribersPath {}
458
+ extends BaseRequest,
459
+ DeleteReportEodGroupSubscribersPath {}
460
460
 
461
461
  // PUT /report/eod/group/{id}/subscribers - replace all subscribers from selected location group with payload
462
462
 
463
463
  export interface PutReportEodGroupSubscribersPath {
464
- id: string;
464
+ id: string;
465
465
  }
466
466
 
467
467
  export type PutReportEodGroupSubscribersBody = EODSubscribers;
@@ -469,44 +469,44 @@ export type PutReportEodGroupSubscribersBody = EODSubscribers;
469
469
  export type PutReportEodGroupSubscribersResponse = EODSubscribers;
470
470
 
471
471
  export interface PutReportEodGroupSubscribersRequest
472
- extends BaseRequest,
473
- PutReportEodGroupSubscribersPath {
474
- body: PutReportEodGroupSubscribersBody;
472
+ extends BaseRequest,
473
+ PutReportEodGroupSubscribersPath {
474
+ body: PutReportEodGroupSubscribersBody;
475
475
  }
476
476
 
477
477
  // GET /report/eod/group/{id}/items - Get items sales report for selected location group
478
478
 
479
479
  export interface GetReportEodGroupItemsPath {
480
- id: string;
480
+ id: string;
481
481
  }
482
482
 
483
483
  export interface GetReportEodGroupItemsQuery {
484
- // Report start date in ISO 8601 format
485
- start: string;
486
- // Report end date in ISO 8601 format
487
- end: string;
488
- // Output format
489
- format: "xslx";
490
- // Partner name for specific formatting
491
- partner: "onemarket";
492
- // Location IDs, comma-separated
493
- locations: string;
494
- // Graphql query string
495
- _query?: string;
496
- nocache?: boolean;
484
+ // Report start date in ISO 8601 format
485
+ start: string;
486
+ // Report end date in ISO 8601 format
487
+ end: string;
488
+ // Output format
489
+ format: 'xslx';
490
+ // Partner name for specific formatting
491
+ partner: 'onemarket';
492
+ // Location IDs, comma-separated
493
+ locations: string;
494
+ // Graphql query string
495
+ _query?: string;
496
+ nocache?: boolean;
497
497
  }
498
498
 
499
499
  export type GetReportEodGroupItemsResponse = EODItemReport;
500
500
 
501
501
  export interface GetReportEodGroupItemsRequest
502
- extends BaseRequest,
503
- RequestQuery<GetReportEodGroupItemsQuery>,
504
- GetReportEodGroupItemsPath {}
502
+ extends BaseRequest,
503
+ RequestQuery<GetReportEodGroupItemsQuery>,
504
+ GetReportEodGroupItemsPath {}
505
505
 
506
506
  // PUT /report/group/{location_group}/config - Update report configuration for a location group. Times are in UTC.
507
507
 
508
508
  export interface PutReportGroupConfigPath {
509
- location_group: string;
509
+ location_group: string;
510
510
  }
511
511
 
512
512
  export type PutReportGroupConfigBody = ReportGroupConfigRequest;
@@ -514,31 +514,31 @@ export type PutReportGroupConfigBody = ReportGroupConfigRequest;
514
514
  export type PutReportGroupConfigResponse = ReportGroupConfigResponse;
515
515
 
516
516
  export interface PutReportGroupConfigRequest extends BaseRequest, PutReportGroupConfigPath {
517
- body: PutReportGroupConfigBody;
517
+ body: PutReportGroupConfigBody;
518
518
  }
519
519
 
520
520
  // GET /report/group/{location_group}/config - Get report configuration for a location group. Times are in UTC.
521
521
 
522
522
  export interface GetReportGroupConfigPath {
523
- location_group: string;
523
+ location_group: string;
524
524
  }
525
525
 
526
526
  export interface GetReportGroupConfigQuery {
527
- // Graphql query string
528
- _query?: string;
527
+ // Graphql query string
528
+ _query?: string;
529
529
  }
530
530
 
531
531
  export type GetReportGroupConfigResponse = ReportGroupConfigResponse;
532
532
 
533
533
  export interface GetReportGroupConfigRequest
534
- extends BaseRequest,
535
- RequestQuery<GetReportGroupConfigQuery>,
536
- GetReportGroupConfigPath {}
534
+ extends BaseRequest,
535
+ RequestQuery<GetReportGroupConfigQuery>,
536
+ GetReportGroupConfigPath {}
537
537
 
538
538
  // DELETE /report/group/{location_group}/config - Delete report configuration for a location group
539
539
 
540
540
  export interface DeleteReportGroupConfigPath {
541
- location_group: string;
541
+ location_group: string;
542
542
  }
543
543
 
544
544
  export type DeleteReportGroupConfigResponse = ReportGroupConfigResponse;
@@ -548,17 +548,17 @@ export interface DeleteReportGroupConfigRequest extends BaseRequest, DeleteRepor
548
548
  // GET /report/group/{location_group}/config/default - Get default report configuration for a location group. Times are in UTC.
549
549
 
550
550
  export interface GetReportGroupConfigDefaultPath {
551
- location_group: string;
551
+ location_group: string;
552
552
  }
553
553
 
554
554
  export interface GetReportGroupConfigDefaultQuery {
555
- // Graphql query string
556
- _query?: string;
555
+ // Graphql query string
556
+ _query?: string;
557
557
  }
558
558
 
559
559
  export type GetReportGroupConfigDefaultResponse = ReportGroupConfigResponse;
560
560
 
561
561
  export interface GetReportGroupConfigDefaultRequest
562
- extends BaseRequest,
563
- RequestQuery<GetReportGroupConfigDefaultQuery>,
564
- GetReportGroupConfigDefaultPath {}
562
+ extends BaseRequest,
563
+ RequestQuery<GetReportGroupConfigDefaultQuery>,
564
+ GetReportGroupConfigDefaultPath {}