@compassdigital/sdk.typescript 4.67.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.
- package/lib/index.d.ts +58 -57
- package/lib/index.d.ts.map +1 -1
- package/lib/index.js +503 -501
- package/lib/index.js.map +1 -1
- package/lib/interface/ai.d.ts +1 -1
- package/lib/interface/ai.d.ts.map +1 -1
- package/lib/interface/announcement.d.ts +1 -1
- package/lib/interface/announcement.d.ts.map +1 -1
- package/lib/interface/auth.d.ts +3 -3
- package/lib/interface/auth.d.ts.map +1 -1
- package/lib/interface/calendar.d.ts +2 -2
- package/lib/interface/calendar.d.ts.map +1 -1
- package/lib/interface/centricos.d.ts +11 -11
- package/lib/interface/centricos.d.ts.map +1 -1
- package/lib/interface/compassconnect.d.ts +1 -1
- package/lib/interface/compassconnect.d.ts.map +1 -1
- package/lib/interface/config.d.ts +1 -1
- package/lib/interface/config.d.ts.map +1 -1
- package/lib/interface/datalake.d.ts +1 -1
- package/lib/interface/datalake.d.ts.map +1 -1
- package/lib/interface/email.d.ts +1 -1
- package/lib/interface/email.d.ts.map +1 -1
- package/lib/interface/file.d.ts +2 -2
- package/lib/interface/file.d.ts.map +1 -1
- package/lib/interface/frictionless.d.ts +9 -9
- package/lib/interface/frictionless.d.ts.map +1 -1
- package/lib/interface/kds.d.ts +1 -1
- package/lib/interface/kds.d.ts.map +1 -1
- package/lib/interface/location.d.ts +5 -3
- package/lib/interface/location.d.ts.map +1 -1
- package/lib/interface/mealplan.d.ts +2 -1
- package/lib/interface/mealplan.d.ts.map +1 -1
- package/lib/interface/menu.d.ts +149 -109
- package/lib/interface/menu.d.ts.map +1 -1
- package/lib/interface/notification.d.ts +3 -3
- package/lib/interface/notification.d.ts.map +1 -1
- package/lib/interface/order.d.ts +7 -7
- package/lib/interface/order.d.ts.map +1 -1
- package/lib/interface/partner.d.ts +10 -10
- package/lib/interface/partner.d.ts.map +1 -1
- package/lib/interface/payment.d.ts +3 -3
- package/lib/interface/payment.d.ts.map +1 -1
- package/lib/interface/promo.d.ts +8 -8
- package/lib/interface/promo.d.ts.map +1 -1
- package/lib/interface/report.d.ts +10 -10
- package/lib/interface/report.d.ts.map +1 -1
- package/lib/interface/search.d.ts +8 -8
- package/lib/interface/search.d.ts.map +1 -1
- package/lib/interface/shoppingcart.d.ts +7 -7
- package/lib/interface/shoppingcart.d.ts.map +1 -1
- package/lib/interface/task.d.ts +8 -8
- package/lib/interface/task.d.ts.map +1 -1
- package/lib/interface/tax.d.ts +2 -2
- package/lib/interface/tax.d.ts.map +1 -1
- package/lib/interface/user.d.ts +16 -16
- package/lib/interface/user.d.ts.map +1 -1
- package/lib/interface/vendor.d.ts +6 -6
- package/lib/interface/vendor.d.ts.map +1 -1
- package/package.json +1 -1
- package/src/index.ts +10395 -10394
- package/src/interface/ai.ts +22 -22
- package/src/interface/announcement.ts +60 -60
- package/src/interface/auth.ts +68 -68
- package/src/interface/calendar.ts +94 -94
- package/src/interface/centricos.ts +145 -145
- package/src/interface/compassconnect.ts +59 -59
- package/src/interface/config.ts +166 -166
- package/src/interface/datalake.ts +13 -13
- package/src/interface/email.ts +13 -13
- package/src/interface/file.ts +18 -18
- package/src/interface/frictionless.ts +177 -177
- package/src/interface/kds.ts +49 -49
- package/src/interface/location.ts +771 -769
- package/src/interface/mealplan.ts +155 -154
- package/src/interface/menu.ts +4079 -4018
- package/src/interface/notification.ts +51 -51
- package/src/interface/order.ts +464 -464
- package/src/interface/partner.ts +823 -823
- package/src/interface/payment.ts +278 -278
- package/src/interface/promo.ts +373 -373
- package/src/interface/report.ts +348 -348
- package/src/interface/search.ts +135 -135
- package/src/interface/shoppingcart.ts +429 -429
- package/src/interface/task.ts +212 -212
- package/src/interface/tax.ts +69 -69
- package/src/interface/user.ts +410 -410
- package/src/interface/vendor.ts +215 -215
|
@@ -1,500 +1,502 @@
|
|
|
1
1
|
/* eslint-disable */
|
|
2
2
|
// THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
|
|
3
3
|
|
|
4
|
-
import { RequestQuery, BaseRequest } from
|
|
4
|
+
import { RequestQuery, BaseRequest } from './util';
|
|
5
5
|
|
|
6
6
|
export interface MenuHours {
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
7
|
+
// menu
|
|
8
|
+
id?: string;
|
|
9
|
+
label?: {
|
|
10
|
+
en?: string;
|
|
11
|
+
};
|
|
12
|
+
hours?: Hours[];
|
|
13
|
+
is_pickup?: boolean;
|
|
14
|
+
is_delivery?: boolean;
|
|
15
|
+
is_frictionless?: boolean;
|
|
16
|
+
state?: BrandOrMenuState;
|
|
17
17
|
}
|
|
18
18
|
|
|
19
19
|
export interface Hours {
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
20
|
+
// hours
|
|
21
|
+
id?: string;
|
|
22
|
+
date?: {
|
|
23
|
+
deleted?: string;
|
|
24
|
+
start?: string;
|
|
25
|
+
end?: string;
|
|
26
|
+
};
|
|
27
|
+
day?: {
|
|
28
|
+
start?: number;
|
|
29
|
+
end?: number;
|
|
30
|
+
};
|
|
31
|
+
hours?: string;
|
|
32
32
|
}
|
|
33
33
|
|
|
34
34
|
export interface DeliveryHours {
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
35
|
+
// hours
|
|
36
|
+
id?: string;
|
|
37
|
+
day?: {
|
|
38
|
+
start?: number;
|
|
39
|
+
end?: number;
|
|
40
|
+
};
|
|
41
|
+
hours?: string;
|
|
42
42
|
}
|
|
43
43
|
|
|
44
44
|
export interface Timeslot {
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
45
|
+
// timeslot id (optional)
|
|
46
|
+
id?: number;
|
|
47
|
+
// brand
|
|
48
|
+
brand_id?: string;
|
|
49
|
+
start_time?: string;
|
|
50
|
+
duration?: string;
|
|
51
|
+
is_available?: boolean;
|
|
52
|
+
number_orders?: number;
|
|
53
53
|
}
|
|
54
54
|
|
|
55
55
|
export interface Address {
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
56
|
+
// Suite number of the address, if applicable
|
|
57
|
+
suite?: string;
|
|
58
|
+
// First line of the address, should include street number
|
|
59
|
+
address?: string;
|
|
60
|
+
// City of the address
|
|
61
|
+
city?: string;
|
|
62
|
+
// State of the address, also province in Canada
|
|
63
|
+
state?: string;
|
|
64
|
+
// Country of the address
|
|
65
|
+
country?: string;
|
|
66
|
+
// Zip code or postal code of the address
|
|
67
|
+
zip?: string;
|
|
68
|
+
coordinates?: {
|
|
69
|
+
// latitude of the the address
|
|
70
|
+
latitude?: number;
|
|
71
|
+
// longitude of the the address
|
|
72
|
+
longitude?: number;
|
|
73
|
+
};
|
|
74
74
|
}
|
|
75
75
|
|
|
76
76
|
export interface Brand {
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
|
|
177
|
-
|
|
178
|
-
|
|
179
|
-
|
|
180
|
-
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
|
|
185
|
-
|
|
186
|
-
|
|
187
|
-
|
|
188
|
-
|
|
189
|
-
|
|
190
|
-
|
|
191
|
-
|
|
192
|
-
|
|
193
|
-
|
|
194
|
-
|
|
195
|
-
|
|
196
|
-
|
|
197
|
-
|
|
198
|
-
|
|
199
|
-
|
|
200
|
-
|
|
201
|
-
|
|
202
|
-
|
|
203
|
-
|
|
204
|
-
|
|
205
|
-
|
|
206
|
-
|
|
207
|
-
|
|
208
|
-
|
|
209
|
-
|
|
210
|
-
|
|
211
|
-
|
|
212
|
-
|
|
213
|
-
|
|
214
|
-
|
|
215
|
-
|
|
216
|
-
|
|
217
|
-
|
|
218
|
-
|
|
219
|
-
|
|
77
|
+
// brand
|
|
78
|
+
id?: string;
|
|
79
|
+
// sector
|
|
80
|
+
sector?: string;
|
|
81
|
+
name?: string;
|
|
82
|
+
label?: {
|
|
83
|
+
en?: string;
|
|
84
|
+
fr?: string;
|
|
85
|
+
};
|
|
86
|
+
timezone?: string;
|
|
87
|
+
description?: string;
|
|
88
|
+
//@deprecated
|
|
89
|
+
latitude?: number;
|
|
90
|
+
//@deprecated
|
|
91
|
+
longitude?: number;
|
|
92
|
+
address?: Address;
|
|
93
|
+
menus?: MenuHours[];
|
|
94
|
+
date?: {
|
|
95
|
+
deleted?: string;
|
|
96
|
+
created?: string;
|
|
97
|
+
};
|
|
98
|
+
hours?: Hours[];
|
|
99
|
+
deliveryHours?: DeliveryHours[];
|
|
100
|
+
style?: {
|
|
101
|
+
logo?: string | null;
|
|
102
|
+
main_logo?: string | null;
|
|
103
|
+
alt_logo?: string | null;
|
|
104
|
+
};
|
|
105
|
+
// pos
|
|
106
|
+
pos?: string;
|
|
107
|
+
terminals?: Record<string, any>[];
|
|
108
|
+
device_mapping?: {
|
|
109
|
+
[index: string]: {
|
|
110
|
+
device_type: string;
|
|
111
|
+
site_device_id: string;
|
|
112
|
+
business_units: string[];
|
|
113
|
+
}[];
|
|
114
|
+
};
|
|
115
|
+
timeslots?: {
|
|
116
|
+
time?: string;
|
|
117
|
+
averagePrepTime?: string;
|
|
118
|
+
duration_minutes?: number;
|
|
119
|
+
customers_per_slot?: number;
|
|
120
|
+
menu_items_per_slot?: number;
|
|
121
|
+
delivery_time?: string;
|
|
122
|
+
delivery_customers_per_slot?: number;
|
|
123
|
+
delivery_menu_items_per_slot?: number;
|
|
124
|
+
delivery_prep_time?: string;
|
|
125
|
+
delivery_is_user_defined?: boolean;
|
|
126
|
+
delivery_user_defined?: {
|
|
127
|
+
start_time: string;
|
|
128
|
+
end_time: string;
|
|
129
|
+
delivery_destinations?: string[];
|
|
130
|
+
sorted_delivery_destinations?: SortedDeliveryDestination[];
|
|
131
|
+
}[];
|
|
132
|
+
sorted_delivery_destinations?: SortedDeliveryDestination[];
|
|
133
|
+
};
|
|
134
|
+
is?: {
|
|
135
|
+
pickup_supported?: boolean;
|
|
136
|
+
delivery_supported?: boolean;
|
|
137
|
+
frictionless_supported?: boolean;
|
|
138
|
+
plu_enabled?: boolean;
|
|
139
|
+
promo_exemptions_enabled?: boolean;
|
|
140
|
+
local_images_enabled?: boolean;
|
|
141
|
+
hidden?: boolean;
|
|
142
|
+
show_in_kiosk?: boolean;
|
|
143
|
+
show_in_pos?: boolean;
|
|
144
|
+
item_desc_edit_enabled?: boolean;
|
|
145
|
+
scan_and_go_supported?: boolean;
|
|
146
|
+
calories_edit_enabled?: boolean;
|
|
147
|
+
// admin panel toggle
|
|
148
|
+
special_instructions?: boolean;
|
|
149
|
+
dining_hall?: boolean;
|
|
150
|
+
[index: string]: any;
|
|
151
|
+
};
|
|
152
|
+
// brand
|
|
153
|
+
brand?: string;
|
|
154
|
+
// location
|
|
155
|
+
location?: string;
|
|
156
|
+
// location group
|
|
157
|
+
group?: string;
|
|
158
|
+
// payment
|
|
159
|
+
payment_provider?: string;
|
|
160
|
+
//@deprecated
|
|
161
|
+
location_description?: string;
|
|
162
|
+
// company
|
|
163
|
+
company?: string;
|
|
164
|
+
config?: {
|
|
165
|
+
private?: Record<string, any>;
|
|
166
|
+
public?: Record<string, any>;
|
|
167
|
+
};
|
|
168
|
+
tax_rate?: number;
|
|
169
|
+
meta?: {
|
|
170
|
+
scout?: {
|
|
171
|
+
user_id?: string;
|
|
172
|
+
name?: {
|
|
173
|
+
first?: string;
|
|
174
|
+
last?: string;
|
|
175
|
+
};
|
|
176
|
+
};
|
|
177
|
+
partner?: {
|
|
178
|
+
user_id?: string;
|
|
179
|
+
name?: {
|
|
180
|
+
first?: string;
|
|
181
|
+
last?: string;
|
|
182
|
+
};
|
|
183
|
+
};
|
|
184
|
+
contact?: {
|
|
185
|
+
name?: string;
|
|
186
|
+
role?: string;
|
|
187
|
+
email?: string;
|
|
188
|
+
phone?: string;
|
|
189
|
+
};
|
|
190
|
+
market_id?: string;
|
|
191
|
+
partner_type?: string;
|
|
192
|
+
business_number?: number;
|
|
193
|
+
website?: string;
|
|
194
|
+
cuisine_types?: string[];
|
|
195
|
+
status?: PartnerStatus;
|
|
196
|
+
active?: boolean;
|
|
197
|
+
max_showcase_items?: number;
|
|
198
|
+
jde_category?: string;
|
|
199
|
+
software_integrations?: {
|
|
200
|
+
system365?: string;
|
|
201
|
+
jwo?: string;
|
|
202
|
+
};
|
|
203
|
+
[index: string]: any;
|
|
204
|
+
};
|
|
205
|
+
descriptions?: {
|
|
206
|
+
location?: {
|
|
207
|
+
en?: string;
|
|
208
|
+
fr?: string;
|
|
209
|
+
};
|
|
210
|
+
};
|
|
211
|
+
estimated_wait_time?: {
|
|
212
|
+
delivery?: WaitTime;
|
|
213
|
+
pickup?: WaitTime;
|
|
214
|
+
};
|
|
215
|
+
state?: {
|
|
216
|
+
pickup?: BrandOrMenuState;
|
|
217
|
+
delivery?: BrandOrMenuState;
|
|
218
|
+
};
|
|
219
|
+
[index: string]: any;
|
|
220
220
|
}
|
|
221
221
|
|
|
222
222
|
export type Brands = Brand[];
|
|
223
223
|
|
|
224
224
|
export interface Location {
|
|
225
|
-
|
|
226
|
-
|
|
227
|
-
|
|
228
|
-
|
|
229
|
-
|
|
230
|
-
|
|
231
|
-
|
|
232
|
-
|
|
233
|
-
|
|
234
|
-
|
|
235
|
-
|
|
236
|
-
|
|
237
|
-
|
|
238
|
-
|
|
239
|
-
|
|
240
|
-
|
|
241
|
-
|
|
242
|
-
|
|
243
|
-
|
|
244
|
-
|
|
245
|
-
|
|
246
|
-
|
|
247
|
-
|
|
248
|
-
|
|
249
|
-
|
|
250
|
-
|
|
251
|
-
|
|
252
|
-
|
|
253
|
-
|
|
254
|
-
|
|
255
|
-
|
|
256
|
-
|
|
257
|
-
|
|
258
|
-
|
|
259
|
-
|
|
260
|
-
|
|
261
|
-
|
|
262
|
-
|
|
263
|
-
|
|
264
|
-
|
|
265
|
-
|
|
266
|
-
|
|
267
|
-
|
|
268
|
-
|
|
269
|
-
|
|
270
|
-
|
|
271
|
-
|
|
272
|
-
|
|
273
|
-
|
|
274
|
-
|
|
275
|
-
|
|
276
|
-
|
|
277
|
-
|
|
278
|
-
|
|
279
|
-
|
|
280
|
-
|
|
281
|
-
|
|
282
|
-
|
|
283
|
-
|
|
284
|
-
|
|
285
|
-
|
|
286
|
-
|
|
225
|
+
// location
|
|
226
|
+
id?: string;
|
|
227
|
+
operation_id?: number;
|
|
228
|
+
name?: string;
|
|
229
|
+
label?: {
|
|
230
|
+
en?: string;
|
|
231
|
+
fr?: string;
|
|
232
|
+
};
|
|
233
|
+
search?: string[];
|
|
234
|
+
app?: string;
|
|
235
|
+
address?: Address;
|
|
236
|
+
latitude?: number;
|
|
237
|
+
longitude?: number;
|
|
238
|
+
brands?: Brand[];
|
|
239
|
+
meta?: {
|
|
240
|
+
[index: string]: any;
|
|
241
|
+
};
|
|
242
|
+
phone?: string;
|
|
243
|
+
// group
|
|
244
|
+
location_group?: string;
|
|
245
|
+
// multigroup
|
|
246
|
+
location_multigroup?: string;
|
|
247
|
+
// sector
|
|
248
|
+
sector?: string;
|
|
249
|
+
date?: {
|
|
250
|
+
deleted?: string;
|
|
251
|
+
created?: string;
|
|
252
|
+
modified?: string;
|
|
253
|
+
};
|
|
254
|
+
market_place?: {
|
|
255
|
+
label?: {
|
|
256
|
+
en?: string;
|
|
257
|
+
fr?: string;
|
|
258
|
+
};
|
|
259
|
+
location_description?: {
|
|
260
|
+
en?: string;
|
|
261
|
+
fr?: string;
|
|
262
|
+
};
|
|
263
|
+
logo?: string;
|
|
264
|
+
is?: {
|
|
265
|
+
pickup_supported?: boolean;
|
|
266
|
+
delivery_supported?: boolean;
|
|
267
|
+
};
|
|
268
|
+
delivery_details?: {
|
|
269
|
+
show_single_timeslot?: boolean;
|
|
270
|
+
show_instructions?: boolean;
|
|
271
|
+
runner_app_enabled?: boolean;
|
|
272
|
+
};
|
|
273
|
+
delivery_destinations?: string[];
|
|
274
|
+
pickup_instruction?: {
|
|
275
|
+
en?: string;
|
|
276
|
+
fr?: string;
|
|
277
|
+
};
|
|
278
|
+
hours?: Hours[];
|
|
279
|
+
deliveryHours?: DeliveryHours[];
|
|
280
|
+
service_fee?: {
|
|
281
|
+
type?: string;
|
|
282
|
+
value?: number;
|
|
283
|
+
};
|
|
284
|
+
[index: string]: any;
|
|
285
|
+
};
|
|
286
|
+
[index: string]: any;
|
|
287
287
|
}
|
|
288
288
|
|
|
289
289
|
export interface Group {
|
|
290
|
-
|
|
291
|
-
|
|
292
|
-
|
|
293
|
-
|
|
294
|
-
|
|
295
|
-
|
|
296
|
-
|
|
297
|
-
|
|
298
|
-
|
|
299
|
-
|
|
300
|
-
|
|
301
|
-
|
|
302
|
-
|
|
303
|
-
|
|
304
|
-
|
|
305
|
-
|
|
306
|
-
|
|
307
|
-
|
|
308
|
-
|
|
309
|
-
|
|
310
|
-
|
|
290
|
+
// group
|
|
291
|
+
id?: string;
|
|
292
|
+
name?: string;
|
|
293
|
+
label?: {
|
|
294
|
+
en?: string;
|
|
295
|
+
fr?: string;
|
|
296
|
+
};
|
|
297
|
+
// Distance in meters from the group
|
|
298
|
+
distance?: number;
|
|
299
|
+
locations?: Location[];
|
|
300
|
+
address?: Address;
|
|
301
|
+
meta?: {
|
|
302
|
+
[index: string]: any;
|
|
303
|
+
};
|
|
304
|
+
style?: {
|
|
305
|
+
logo?: string | null;
|
|
306
|
+
main_logo?: string | null;
|
|
307
|
+
alt_logo?: string | null;
|
|
308
|
+
};
|
|
309
|
+
timezone?: string;
|
|
310
|
+
[index: string]: any;
|
|
311
311
|
}
|
|
312
312
|
|
|
313
313
|
export interface MultiGroup {
|
|
314
|
-
|
|
315
|
-
|
|
316
|
-
|
|
317
|
-
|
|
318
|
-
|
|
314
|
+
// multigroup
|
|
315
|
+
id?: string;
|
|
316
|
+
name?: string;
|
|
317
|
+
groups?: Group[];
|
|
318
|
+
[index: string]: any;
|
|
319
319
|
}
|
|
320
320
|
|
|
321
321
|
export interface success {
|
|
322
|
-
|
|
322
|
+
success?: boolean;
|
|
323
323
|
}
|
|
324
324
|
|
|
325
325
|
export interface Error {
|
|
326
|
-
|
|
327
|
-
|
|
328
|
-
|
|
326
|
+
error?: string;
|
|
327
|
+
code?: number;
|
|
328
|
+
data?: Record<string, any>;
|
|
329
329
|
}
|
|
330
330
|
|
|
331
331
|
export interface Sector {
|
|
332
|
-
|
|
333
|
-
|
|
334
|
-
|
|
335
|
-
|
|
336
|
-
|
|
337
|
-
|
|
338
|
-
|
|
339
|
-
|
|
340
|
-
|
|
341
|
-
|
|
342
|
-
|
|
332
|
+
// sector
|
|
333
|
+
id?: string;
|
|
334
|
+
name?: string;
|
|
335
|
+
label?: {
|
|
336
|
+
en?: string;
|
|
337
|
+
fr?: string;
|
|
338
|
+
};
|
|
339
|
+
companies?: Company[];
|
|
340
|
+
meta?: {
|
|
341
|
+
[index: string]: any;
|
|
342
|
+
};
|
|
343
343
|
}
|
|
344
344
|
|
|
345
345
|
export interface Company {
|
|
346
|
-
|
|
347
|
-
|
|
348
|
-
|
|
349
|
-
|
|
350
|
-
|
|
351
|
-
|
|
352
|
-
|
|
353
|
-
|
|
354
|
-
|
|
355
|
-
|
|
356
|
-
|
|
357
|
-
|
|
358
|
-
|
|
359
|
-
|
|
360
|
-
|
|
361
|
-
|
|
346
|
+
// company
|
|
347
|
+
id?: string;
|
|
348
|
+
name?: string;
|
|
349
|
+
label?: {
|
|
350
|
+
en?: string;
|
|
351
|
+
fr?: string;
|
|
352
|
+
};
|
|
353
|
+
// sector
|
|
354
|
+
sector?: string;
|
|
355
|
+
locations?: Location[];
|
|
356
|
+
is?: {
|
|
357
|
+
global_images_enabled?: boolean;
|
|
358
|
+
};
|
|
359
|
+
meta?: {
|
|
360
|
+
[index: string]: any;
|
|
361
|
+
};
|
|
362
362
|
}
|
|
363
363
|
|
|
364
364
|
export interface Locations {
|
|
365
|
-
|
|
365
|
+
locations?: Location[];
|
|
366
366
|
}
|
|
367
367
|
|
|
368
368
|
export interface Multigroups {
|
|
369
|
-
|
|
370
|
-
|
|
371
|
-
|
|
369
|
+
//@deprecated
|
|
370
|
+
groups?: MultiGroup[];
|
|
371
|
+
multigroups?: MultiGroup[];
|
|
372
372
|
}
|
|
373
373
|
|
|
374
374
|
export interface Groups {
|
|
375
|
-
|
|
375
|
+
groups?: Group[];
|
|
376
376
|
}
|
|
377
377
|
|
|
378
378
|
export interface PostDeliveryDestination {
|
|
379
|
-
|
|
380
|
-
|
|
381
|
-
|
|
382
|
-
|
|
383
|
-
|
|
384
|
-
|
|
385
|
-
|
|
379
|
+
// Name of the delivery destination
|
|
380
|
+
name: string;
|
|
381
|
+
// Boolean to indicate whether the delivery destination is a foodlocker or not
|
|
382
|
+
foodlocker: boolean;
|
|
383
|
+
address: Address;
|
|
384
|
+
// Additional information of the delivery destination
|
|
385
|
+
information?: string;
|
|
386
|
+
sort_sequence?: number;
|
|
386
387
|
}
|
|
387
388
|
|
|
388
389
|
export interface DeliveryDestination {
|
|
389
|
-
|
|
390
|
-
|
|
391
|
-
|
|
392
|
-
|
|
393
|
-
|
|
394
|
-
|
|
395
|
-
|
|
396
|
-
|
|
397
|
-
|
|
390
|
+
// delivery_destination
|
|
391
|
+
id: string;
|
|
392
|
+
// Name of the delivery destination
|
|
393
|
+
name: string;
|
|
394
|
+
// Boolean to indicate whether the delivery destination is a foodlocker or not
|
|
395
|
+
foodlocker: boolean;
|
|
396
|
+
address: Address;
|
|
397
|
+
// Additional information of the delivery destination
|
|
398
|
+
information?: string;
|
|
399
|
+
sort_sequence?: number;
|
|
398
400
|
}
|
|
399
401
|
|
|
400
402
|
export type DeliveryDestinations = DeliveryDestination[];
|
|
401
403
|
|
|
402
404
|
export interface DeliveryDestinationIDs {
|
|
403
|
-
|
|
405
|
+
delivery_destinations?: string[];
|
|
404
406
|
}
|
|
405
407
|
|
|
406
408
|
export interface TimeSlots {
|
|
407
|
-
|
|
409
|
+
timeslots?: Timeslot[];
|
|
408
410
|
}
|
|
409
411
|
|
|
410
412
|
export interface SortedDeliveryDestination {
|
|
411
|
-
|
|
412
|
-
|
|
413
|
+
name: string;
|
|
414
|
+
sort_sequence: number;
|
|
413
415
|
}
|
|
414
416
|
|
|
415
417
|
export interface Sectors {
|
|
416
|
-
|
|
418
|
+
sectors?: Sector[];
|
|
417
419
|
}
|
|
418
420
|
|
|
419
421
|
export interface CompanyUpdateBody {
|
|
420
|
-
|
|
421
|
-
|
|
422
|
-
|
|
423
|
-
|
|
424
|
-
|
|
425
|
-
|
|
426
|
-
|
|
427
|
-
|
|
428
|
-
|
|
422
|
+
// Company name
|
|
423
|
+
name?: string;
|
|
424
|
+
is?: {
|
|
425
|
+
// Allow Global Menu Images Toggle
|
|
426
|
+
global_images_enabled?: boolean;
|
|
427
|
+
};
|
|
428
|
+
date?: {
|
|
429
|
+
deleted?: string;
|
|
430
|
+
};
|
|
429
431
|
}
|
|
430
432
|
|
|
431
433
|
export interface MarketPlace {
|
|
432
|
-
|
|
433
|
-
|
|
434
|
+
stations?: Station[];
|
|
435
|
+
[index: string]: any;
|
|
434
436
|
}
|
|
435
437
|
|
|
436
438
|
export interface Station {
|
|
437
|
-
|
|
438
|
-
|
|
439
|
-
|
|
440
|
-
|
|
441
|
-
|
|
439
|
+
// CDL id
|
|
440
|
+
brand?: string;
|
|
441
|
+
// CDL id
|
|
442
|
+
menu?: string;
|
|
443
|
+
[index: string]: any;
|
|
442
444
|
}
|
|
443
445
|
|
|
444
446
|
export interface CreateSector {
|
|
445
|
-
|
|
446
|
-
|
|
447
|
+
// Sector name
|
|
448
|
+
name?: string;
|
|
447
449
|
}
|
|
448
450
|
|
|
449
451
|
export interface BadRequest {
|
|
450
|
-
|
|
452
|
+
error?: string;
|
|
451
453
|
}
|
|
452
454
|
|
|
453
|
-
export type PartnerStatus =
|
|
455
|
+
export type PartnerStatus = 'await_partner' | 'await_scout' | 'completed';
|
|
454
456
|
|
|
455
457
|
export interface WaitTime {
|
|
456
|
-
|
|
457
|
-
|
|
458
|
-
|
|
459
|
-
|
|
460
|
-
|
|
461
|
-
|
|
458
|
+
// maxium wait time to the next time slot in minutes
|
|
459
|
+
max: number;
|
|
460
|
+
// minimum wait time to the next time slot in minutes
|
|
461
|
+
min: number;
|
|
462
|
+
// the epoch timestamp of the next available ready time for a station
|
|
463
|
+
ready_time: number;
|
|
462
464
|
}
|
|
463
465
|
|
|
464
|
-
export type BrandOrMenuState =
|
|
466
|
+
export type BrandOrMenuState = 'open' | 'closed' | 'preorder';
|
|
465
467
|
|
|
466
468
|
export interface MenuAssociations {
|
|
467
|
-
|
|
469
|
+
menu_associations?: MenuAssociation[];
|
|
468
470
|
}
|
|
469
471
|
|
|
470
472
|
export interface MenuAssociation {
|
|
471
|
-
|
|
472
|
-
|
|
473
|
-
|
|
474
|
-
|
|
475
|
-
|
|
476
|
-
|
|
477
|
-
|
|
478
|
-
|
|
479
|
-
|
|
480
|
-
|
|
473
|
+
// CDL id
|
|
474
|
+
id?: string;
|
|
475
|
+
// CDL id
|
|
476
|
+
brand?: string;
|
|
477
|
+
// CDL id
|
|
478
|
+
menu?: string;
|
|
479
|
+
// CDL id
|
|
480
|
+
group?: string;
|
|
481
|
+
created?: string;
|
|
482
|
+
[index: string]: any;
|
|
481
483
|
}
|
|
482
484
|
|
|
483
485
|
export interface WaitTimeResponse {
|
|
484
|
-
|
|
485
|
-
|
|
486
|
-
|
|
487
|
-
|
|
488
|
-
|
|
489
|
-
|
|
490
|
-
|
|
491
|
-
|
|
492
|
-
|
|
493
|
-
|
|
494
|
-
|
|
495
|
-
|
|
496
|
-
|
|
497
|
-
|
|
486
|
+
// group
|
|
487
|
+
id?: string;
|
|
488
|
+
locations?: {
|
|
489
|
+
// location
|
|
490
|
+
id?: string;
|
|
491
|
+
brands?: {
|
|
492
|
+
// location
|
|
493
|
+
id?: string;
|
|
494
|
+
estimated_wait_time?: {
|
|
495
|
+
delivery?: WaitTime;
|
|
496
|
+
pickup?: WaitTime;
|
|
497
|
+
};
|
|
498
|
+
}[];
|
|
499
|
+
}[];
|
|
498
500
|
}
|
|
499
501
|
|
|
500
502
|
// POST /location - Create a new location
|
|
@@ -504,14 +506,14 @@ export type PostLocationBody = Location;
|
|
|
504
506
|
export type PostLocationResponse = Location;
|
|
505
507
|
|
|
506
508
|
export interface PostLocationRequest extends BaseRequest {
|
|
507
|
-
|
|
509
|
+
body: PostLocationBody;
|
|
508
510
|
}
|
|
509
511
|
|
|
510
512
|
// GET /location - Get all location
|
|
511
513
|
|
|
512
514
|
export interface GetLocationsQuery {
|
|
513
|
-
|
|
514
|
-
|
|
515
|
+
// Graphql query string
|
|
516
|
+
_query?: string;
|
|
515
517
|
}
|
|
516
518
|
|
|
517
519
|
export type GetLocationsResponse = Locations;
|
|
@@ -521,53 +523,53 @@ export interface GetLocationsRequest extends BaseRequest, RequestQuery<GetLocati
|
|
|
521
523
|
// GET /location/search - Gets Location within a radius of the provided point
|
|
522
524
|
|
|
523
525
|
export interface GetLocationSearchQuery {
|
|
524
|
-
|
|
525
|
-
|
|
526
|
-
|
|
527
|
-
|
|
528
|
-
|
|
529
|
-
|
|
530
|
-
|
|
531
|
-
|
|
526
|
+
//@deprecated
|
|
527
|
+
lat?: number;
|
|
528
|
+
//@deprecated
|
|
529
|
+
long?: number;
|
|
530
|
+
// Operation id to be used
|
|
531
|
+
operation_id?: number;
|
|
532
|
+
// Graphql query string
|
|
533
|
+
_query?: string;
|
|
532
534
|
}
|
|
533
535
|
|
|
534
536
|
export type GetLocationSearchResponse = Locations;
|
|
535
537
|
|
|
536
538
|
export interface GetLocationSearchRequest
|
|
537
|
-
|
|
538
|
-
|
|
539
|
+
extends BaseRequest,
|
|
540
|
+
RequestQuery<GetLocationSearchQuery> {}
|
|
539
541
|
|
|
540
542
|
// GET /location/{id} - Get an individual Location
|
|
541
543
|
|
|
542
544
|
export interface GetLocationPath {
|
|
543
|
-
|
|
544
|
-
|
|
545
|
+
// location id
|
|
546
|
+
id: string;
|
|
545
547
|
}
|
|
546
548
|
|
|
547
549
|
export interface GetLocationQuery {
|
|
548
|
-
|
|
549
|
-
|
|
550
|
-
|
|
551
|
-
|
|
552
|
-
|
|
553
|
-
|
|
554
|
-
|
|
555
|
-
|
|
556
|
-
|
|
550
|
+
// When fetching location, brands will come with private and public configs
|
|
551
|
+
include_brands_config?: boolean;
|
|
552
|
+
// active cafes
|
|
553
|
+
active_cafes?: string[];
|
|
554
|
+
// show additional hidden properties/entities
|
|
555
|
+
extended?: boolean;
|
|
556
|
+
// Graphql query string
|
|
557
|
+
_query?: string;
|
|
558
|
+
nocache?: boolean;
|
|
557
559
|
}
|
|
558
560
|
|
|
559
561
|
export type GetLocationResponse = Location;
|
|
560
562
|
|
|
561
563
|
export interface GetLocationRequest
|
|
562
|
-
|
|
563
|
-
|
|
564
|
-
|
|
564
|
+
extends BaseRequest,
|
|
565
|
+
RequestQuery<GetLocationQuery>,
|
|
566
|
+
GetLocationPath {}
|
|
565
567
|
|
|
566
568
|
// PUT /location/{id} - Override a complete Location
|
|
567
569
|
|
|
568
570
|
export interface PutLocationPath {
|
|
569
|
-
|
|
570
|
-
|
|
571
|
+
// location id
|
|
572
|
+
id: string;
|
|
571
573
|
}
|
|
572
574
|
|
|
573
575
|
export type PutLocationBody = Location;
|
|
@@ -575,32 +577,32 @@ export type PutLocationBody = Location;
|
|
|
575
577
|
export type PutLocationResponse = Location;
|
|
576
578
|
|
|
577
579
|
export interface PutLocationRequest extends BaseRequest, PutLocationPath {
|
|
578
|
-
|
|
580
|
+
body: PutLocationBody;
|
|
579
581
|
}
|
|
580
582
|
|
|
581
583
|
// DELETE /location/{id} - Delete brands from a Location
|
|
582
584
|
|
|
583
585
|
export interface DeleteLocationPath {
|
|
584
|
-
|
|
585
|
-
|
|
586
|
+
// location id
|
|
587
|
+
id: string;
|
|
586
588
|
}
|
|
587
589
|
|
|
588
590
|
export interface DeleteLocationBody {
|
|
589
|
-
|
|
590
|
-
|
|
591
|
+
// List of brands to remove
|
|
592
|
+
brands?: Brand[];
|
|
591
593
|
}
|
|
592
594
|
|
|
593
595
|
export type DeleteLocationResponse = Location;
|
|
594
596
|
|
|
595
597
|
export interface DeleteLocationRequest extends BaseRequest, DeleteLocationPath {
|
|
596
|
-
|
|
598
|
+
body: DeleteLocationBody;
|
|
597
599
|
}
|
|
598
600
|
|
|
599
601
|
// PATCH /location/{id} - Update a Location
|
|
600
602
|
|
|
601
603
|
export interface PatchLocationPath {
|
|
602
|
-
|
|
603
|
-
|
|
604
|
+
// location id
|
|
605
|
+
id: string;
|
|
604
606
|
}
|
|
605
607
|
|
|
606
608
|
export type PatchLocationBody = Location;
|
|
@@ -608,22 +610,22 @@ export type PatchLocationBody = Location;
|
|
|
608
610
|
export type PatchLocationResponse = Location;
|
|
609
611
|
|
|
610
612
|
export interface PatchLocationRequest extends BaseRequest, PatchLocationPath {
|
|
611
|
-
|
|
613
|
+
body: PatchLocationBody;
|
|
612
614
|
}
|
|
613
615
|
|
|
614
616
|
// GET /location/multigroup - Get all the top level multigroups
|
|
615
617
|
|
|
616
618
|
export interface GetLocationMultigroupsQuery {
|
|
617
|
-
|
|
618
|
-
|
|
619
|
-
|
|
619
|
+
// Graphql query string
|
|
620
|
+
_query?: string;
|
|
621
|
+
nocache?: boolean;
|
|
620
622
|
}
|
|
621
623
|
|
|
622
624
|
export type GetLocationMultigroupsResponse = Multigroups;
|
|
623
625
|
|
|
624
626
|
export interface GetLocationMultigroupsRequest
|
|
625
|
-
|
|
626
|
-
|
|
627
|
+
extends BaseRequest,
|
|
628
|
+
RequestQuery<GetLocationMultigroupsQuery> {}
|
|
627
629
|
|
|
628
630
|
// POST /location/multigroup - Create a new multigroup
|
|
629
631
|
|
|
@@ -632,52 +634,52 @@ export type PostLocationMultigroupBody = MultiGroup;
|
|
|
632
634
|
export type PostLocationMultigroupResponse = MultiGroup;
|
|
633
635
|
|
|
634
636
|
export interface PostLocationMultigroupRequest extends BaseRequest {
|
|
635
|
-
|
|
637
|
+
body: PostLocationMultigroupBody;
|
|
636
638
|
}
|
|
637
639
|
|
|
638
640
|
// GET /location/multigroup/{id} - Get a multigroup
|
|
639
641
|
|
|
640
642
|
export interface GetLocationMultigroupPath {
|
|
641
|
-
|
|
642
|
-
|
|
643
|
+
// multigroup id
|
|
644
|
+
id: string;
|
|
643
645
|
}
|
|
644
646
|
|
|
645
647
|
export interface GetLocationMultigroupQuery {
|
|
646
|
-
|
|
647
|
-
|
|
648
|
-
|
|
649
|
-
|
|
650
|
-
|
|
651
|
-
|
|
652
|
-
|
|
653
|
-
|
|
654
|
-
|
|
655
|
-
|
|
656
|
-
|
|
657
|
-
|
|
658
|
-
|
|
659
|
-
|
|
660
|
-
|
|
661
|
-
|
|
662
|
-
|
|
663
|
-
|
|
664
|
-
|
|
665
|
-
|
|
666
|
-
|
|
648
|
+
// coordinate to sort from
|
|
649
|
+
latitude?: string;
|
|
650
|
+
// coordinate to sort from
|
|
651
|
+
longitude?: string;
|
|
652
|
+
// Merge multigroups from different providers. Set false to get only from queried provider
|
|
653
|
+
merge?: string;
|
|
654
|
+
// return multigroup location/brands in response
|
|
655
|
+
expanded?: boolean;
|
|
656
|
+
// return additional attributes in response
|
|
657
|
+
extended?: boolean;
|
|
658
|
+
// return additional hours and deliveryHours properties in response
|
|
659
|
+
hours?: boolean;
|
|
660
|
+
// filters for web order enabled brands only
|
|
661
|
+
web?: boolean;
|
|
662
|
+
// filters for non-marketplace locations only
|
|
663
|
+
non_market_places?: boolean;
|
|
664
|
+
// filters for non-scan & go locations only
|
|
665
|
+
non_scan_go?: boolean;
|
|
666
|
+
// Graphql query string
|
|
667
|
+
_query?: string;
|
|
668
|
+
nocache?: boolean;
|
|
667
669
|
}
|
|
668
670
|
|
|
669
671
|
export type GetLocationMultigroupResponse = MultiGroup;
|
|
670
672
|
|
|
671
673
|
export interface GetLocationMultigroupRequest
|
|
672
|
-
|
|
673
|
-
|
|
674
|
-
|
|
674
|
+
extends BaseRequest,
|
|
675
|
+
RequestQuery<GetLocationMultigroupQuery>,
|
|
676
|
+
GetLocationMultigroupPath {}
|
|
675
677
|
|
|
676
678
|
// PUT /location/multigroup/{id} - Override a complete multigroup
|
|
677
679
|
|
|
678
680
|
export interface PutLocationMultigroupPath {
|
|
679
|
-
|
|
680
|
-
|
|
681
|
+
// multigroup id
|
|
682
|
+
id: string;
|
|
681
683
|
}
|
|
682
684
|
|
|
683
685
|
export type PutLocationMultigroupBody = MultiGroup;
|
|
@@ -685,32 +687,32 @@ export type PutLocationMultigroupBody = MultiGroup;
|
|
|
685
687
|
export type PutLocationMultigroupResponse = MultiGroup;
|
|
686
688
|
|
|
687
689
|
export interface PutLocationMultigroupRequest extends BaseRequest, PutLocationMultigroupPath {
|
|
688
|
-
|
|
690
|
+
body: PutLocationMultigroupBody;
|
|
689
691
|
}
|
|
690
692
|
|
|
691
693
|
// DELETE /location/multigroup/{id} - Delete groups from a multigroup
|
|
692
694
|
|
|
693
695
|
export interface DeleteLocationMultigroupPath {
|
|
694
|
-
|
|
695
|
-
|
|
696
|
+
// multigroup id
|
|
697
|
+
id: string;
|
|
696
698
|
}
|
|
697
699
|
|
|
698
700
|
export interface DeleteLocationMultigroupBody {
|
|
699
|
-
|
|
700
|
-
|
|
701
|
+
// List of groups to remove
|
|
702
|
+
groups?: Group[];
|
|
701
703
|
}
|
|
702
704
|
|
|
703
705
|
export type DeleteLocationMultigroupResponse = MultiGroup;
|
|
704
706
|
|
|
705
707
|
export interface DeleteLocationMultigroupRequest extends BaseRequest, DeleteLocationMultigroupPath {
|
|
706
|
-
|
|
708
|
+
body: DeleteLocationMultigroupBody;
|
|
707
709
|
}
|
|
708
710
|
|
|
709
711
|
// PATCH /location/multigroup/{id} - Update a multigroup
|
|
710
712
|
|
|
711
713
|
export interface PatchLocationMultigroupPath {
|
|
712
|
-
|
|
713
|
-
|
|
714
|
+
// multigroup id
|
|
715
|
+
id: string;
|
|
714
716
|
}
|
|
715
717
|
|
|
716
718
|
export type PatchLocationMultigroupBody = MultiGroup;
|
|
@@ -718,31 +720,31 @@ export type PatchLocationMultigroupBody = MultiGroup;
|
|
|
718
720
|
export type PatchLocationMultigroupResponse = MultiGroup;
|
|
719
721
|
|
|
720
722
|
export interface PatchLocationMultigroupRequest extends BaseRequest, PatchLocationMultigroupPath {
|
|
721
|
-
|
|
723
|
+
body: PatchLocationMultigroupBody;
|
|
722
724
|
}
|
|
723
725
|
|
|
724
726
|
// GET /location/multigroup/{id}/user/{user_id} - Get all the groups in a multigroup specific to user permissions
|
|
725
727
|
|
|
726
728
|
export interface GetLocationUserMultigroupPath {
|
|
727
|
-
|
|
728
|
-
|
|
729
|
-
|
|
730
|
-
|
|
729
|
+
// multigroup
|
|
730
|
+
id: string;
|
|
731
|
+
// user
|
|
732
|
+
user_id: string;
|
|
731
733
|
}
|
|
732
734
|
|
|
733
735
|
export interface GetLocationUserMultigroupQuery {
|
|
734
|
-
|
|
735
|
-
|
|
736
|
-
|
|
737
|
-
|
|
736
|
+
expanded?: boolean;
|
|
737
|
+
// Graphql query string
|
|
738
|
+
_query?: string;
|
|
739
|
+
nocache?: boolean;
|
|
738
740
|
}
|
|
739
741
|
|
|
740
742
|
export type GetLocationUserMultigroupResponse = Groups;
|
|
741
743
|
|
|
742
744
|
export interface GetLocationUserMultigroupRequest
|
|
743
|
-
|
|
744
|
-
|
|
745
|
-
|
|
745
|
+
extends BaseRequest,
|
|
746
|
+
RequestQuery<GetLocationUserMultigroupQuery>,
|
|
747
|
+
GetLocationUserMultigroupPath {}
|
|
746
748
|
|
|
747
749
|
// POST /location/group - Create a new group
|
|
748
750
|
|
|
@@ -751,50 +753,50 @@ export type PostLocationGroupBody = Group;
|
|
|
751
753
|
export type PostLocationGroupResponse = Group;
|
|
752
754
|
|
|
753
755
|
export interface PostLocationGroupRequest extends BaseRequest {
|
|
754
|
-
|
|
756
|
+
body: PostLocationGroupBody;
|
|
755
757
|
}
|
|
756
758
|
|
|
757
759
|
// GET /location/group/{id} - Get an individual Group based on id or latitude/longitude
|
|
758
760
|
|
|
759
761
|
export interface GetLocationGroupPath {
|
|
760
|
-
|
|
761
|
-
|
|
762
|
+
// group id
|
|
763
|
+
id: string;
|
|
762
764
|
}
|
|
763
765
|
|
|
764
766
|
export interface GetLocationGroupQuery {
|
|
765
|
-
|
|
766
|
-
|
|
767
|
-
|
|
768
|
-
|
|
769
|
-
|
|
770
|
-
|
|
771
|
-
|
|
772
|
-
|
|
773
|
-
|
|
774
|
-
|
|
775
|
-
|
|
776
|
-
|
|
777
|
-
|
|
778
|
-
|
|
779
|
-
|
|
780
|
-
|
|
781
|
-
|
|
782
|
-
|
|
783
|
-
|
|
767
|
+
latitude?: number;
|
|
768
|
+
longitude?: number;
|
|
769
|
+
// When fetching a group, brands will come with private and public configs
|
|
770
|
+
include_brands_config?: boolean;
|
|
771
|
+
// When fetching a group, brands will come with public configs
|
|
772
|
+
public_config_only?: boolean;
|
|
773
|
+
// show additional hidden properties/entities
|
|
774
|
+
extended?: boolean;
|
|
775
|
+
// return only groups with brands that have web_order_enabled switched on
|
|
776
|
+
web?: boolean;
|
|
777
|
+
// return only groups with non-marketplace locations/brands
|
|
778
|
+
non_market_places?: boolean;
|
|
779
|
+
// return only groups with non-scan & go locations/brands
|
|
780
|
+
non_scan_go?: boolean;
|
|
781
|
+
//@deprecated
|
|
782
|
+
include_estimated_wait_time?: boolean;
|
|
783
|
+
// Graphql query string
|
|
784
|
+
_query?: string;
|
|
785
|
+
nocache?: boolean;
|
|
784
786
|
}
|
|
785
787
|
|
|
786
788
|
export type GetLocationGroupResponse = Group;
|
|
787
789
|
|
|
788
790
|
export interface GetLocationGroupRequest
|
|
789
|
-
|
|
790
|
-
|
|
791
|
-
|
|
791
|
+
extends BaseRequest,
|
|
792
|
+
RequestQuery<GetLocationGroupQuery>,
|
|
793
|
+
GetLocationGroupPath {}
|
|
792
794
|
|
|
793
795
|
// PUT /location/group/{id} - Override a complete Group
|
|
794
796
|
|
|
795
797
|
export interface PutLocationGroupPath {
|
|
796
|
-
|
|
797
|
-
|
|
798
|
+
// group id
|
|
799
|
+
id: string;
|
|
798
800
|
}
|
|
799
801
|
|
|
800
802
|
export type PutLocationGroupBody = Group;
|
|
@@ -802,32 +804,32 @@ export type PutLocationGroupBody = Group;
|
|
|
802
804
|
export type PutLocationGroupResponse = Group;
|
|
803
805
|
|
|
804
806
|
export interface PutLocationGroupRequest extends BaseRequest, PutLocationGroupPath {
|
|
805
|
-
|
|
807
|
+
body: PutLocationGroupBody;
|
|
806
808
|
}
|
|
807
809
|
|
|
808
810
|
// DELETE /location/group/{id} - Delete locations from a Group
|
|
809
811
|
|
|
810
812
|
export interface DeleteLocationGroupPath {
|
|
811
|
-
|
|
812
|
-
|
|
813
|
+
// group id
|
|
814
|
+
id: string;
|
|
813
815
|
}
|
|
814
816
|
|
|
815
817
|
export interface DeleteLocationGroupBody {
|
|
816
|
-
|
|
817
|
-
|
|
818
|
+
// List of locations to remove
|
|
819
|
+
locations?: Location[];
|
|
818
820
|
}
|
|
819
821
|
|
|
820
822
|
export type DeleteLocationGroupResponse = Group;
|
|
821
823
|
|
|
822
824
|
export interface DeleteLocationGroupRequest extends BaseRequest, DeleteLocationGroupPath {
|
|
823
|
-
|
|
825
|
+
body: DeleteLocationGroupBody;
|
|
824
826
|
}
|
|
825
827
|
|
|
826
828
|
// PATCH /location/group/{id} - Update a Group
|
|
827
829
|
|
|
828
830
|
export interface PatchLocationGroupPath {
|
|
829
|
-
|
|
830
|
-
|
|
831
|
+
// group id
|
|
832
|
+
id: string;
|
|
831
833
|
}
|
|
832
834
|
|
|
833
835
|
export type PatchLocationGroupBody = Group;
|
|
@@ -835,57 +837,57 @@ export type PatchLocationGroupBody = Group;
|
|
|
835
837
|
export type PatchLocationGroupResponse = Group;
|
|
836
838
|
|
|
837
839
|
export interface PatchLocationGroupRequest extends BaseRequest, PatchLocationGroupPath {
|
|
838
|
-
|
|
840
|
+
body: PatchLocationGroupBody;
|
|
839
841
|
}
|
|
840
842
|
|
|
841
843
|
// GET /location/group/{id}/waittimes - Get an individual Group's estimated wait times based on id
|
|
842
844
|
|
|
843
845
|
export interface GetLocationGroupWaittimesPath {
|
|
844
|
-
|
|
845
|
-
|
|
846
|
+
// group id
|
|
847
|
+
id: string;
|
|
846
848
|
}
|
|
847
849
|
|
|
848
850
|
export interface GetLocationGroupWaittimesQuery {
|
|
849
|
-
|
|
850
|
-
|
|
851
|
-
|
|
851
|
+
// Graphql query string
|
|
852
|
+
_query?: string;
|
|
853
|
+
nocache?: boolean;
|
|
852
854
|
}
|
|
853
855
|
|
|
854
856
|
export type GetLocationGroupWaittimesResponse = WaitTimeResponse;
|
|
855
857
|
|
|
856
858
|
export interface GetLocationGroupWaittimesRequest
|
|
857
|
-
|
|
858
|
-
|
|
859
|
-
|
|
859
|
+
extends BaseRequest,
|
|
860
|
+
RequestQuery<GetLocationGroupWaittimesQuery>,
|
|
861
|
+
GetLocationGroupWaittimesPath {}
|
|
860
862
|
|
|
861
863
|
// GET /location/group/{id}/deliverydestination - Get all delivery destinations for group
|
|
862
864
|
|
|
863
865
|
export interface GetLocationGroupDeliverydestinationsPath {
|
|
864
|
-
|
|
865
|
-
|
|
866
|
+
// Group ID
|
|
867
|
+
id: string;
|
|
866
868
|
}
|
|
867
869
|
|
|
868
870
|
export interface GetLocationGroupDeliverydestinationsQuery {
|
|
869
|
-
|
|
870
|
-
|
|
871
|
-
|
|
872
|
-
|
|
871
|
+
// Delivery destination name
|
|
872
|
+
name?: string;
|
|
873
|
+
// Graphql query string
|
|
874
|
+
_query?: string;
|
|
873
875
|
}
|
|
874
876
|
|
|
875
877
|
export interface GetLocationGroupDeliverydestinationsResponse {
|
|
876
|
-
|
|
878
|
+
delivery_destinations?: DeliveryDestinations;
|
|
877
879
|
}
|
|
878
880
|
|
|
879
881
|
export interface GetLocationGroupDeliverydestinationsRequest
|
|
880
|
-
|
|
881
|
-
|
|
882
|
-
|
|
882
|
+
extends BaseRequest,
|
|
883
|
+
RequestQuery<GetLocationGroupDeliverydestinationsQuery>,
|
|
884
|
+
GetLocationGroupDeliverydestinationsPath {}
|
|
883
885
|
|
|
884
886
|
// POST /location/group/{id}/deliverydestination - Create a new location group delivery destination
|
|
885
887
|
|
|
886
888
|
export interface PostLocationGroupDeliverydestinationPath {
|
|
887
|
-
|
|
888
|
-
|
|
889
|
+
// Group ID
|
|
890
|
+
id: string;
|
|
889
891
|
}
|
|
890
892
|
|
|
891
893
|
export type PostLocationGroupDeliverydestinationBody = PostDeliveryDestination;
|
|
@@ -893,140 +895,140 @@ export type PostLocationGroupDeliverydestinationBody = PostDeliveryDestination;
|
|
|
893
895
|
export type PostLocationGroupDeliverydestinationResponse = DeliveryDestination;
|
|
894
896
|
|
|
895
897
|
export interface PostLocationGroupDeliverydestinationRequest
|
|
896
|
-
|
|
897
|
-
|
|
898
|
-
|
|
898
|
+
extends BaseRequest,
|
|
899
|
+
PostLocationGroupDeliverydestinationPath {
|
|
900
|
+
body: PostLocationGroupDeliverydestinationBody;
|
|
899
901
|
}
|
|
900
902
|
|
|
901
903
|
// PATCH /location/group/{id}/deliverydestination - Patch single or multiple delivery destinations
|
|
902
904
|
|
|
903
905
|
export interface PatchLocationGroupDeliverydestinationPath {
|
|
904
|
-
|
|
905
|
-
|
|
906
|
+
// Group ID
|
|
907
|
+
id: string;
|
|
906
908
|
}
|
|
907
909
|
|
|
908
910
|
export interface PatchLocationGroupDeliverydestinationBody {
|
|
909
|
-
|
|
911
|
+
delivery_destinations: DeliveryDestination[];
|
|
910
912
|
}
|
|
911
913
|
|
|
912
914
|
export interface PatchLocationGroupDeliverydestinationResponse {
|
|
913
|
-
|
|
915
|
+
delivery_destinations: DeliveryDestination[];
|
|
914
916
|
}
|
|
915
917
|
|
|
916
918
|
export interface PatchLocationGroupDeliverydestinationRequest
|
|
917
|
-
|
|
918
|
-
|
|
919
|
-
|
|
919
|
+
extends BaseRequest,
|
|
920
|
+
PatchLocationGroupDeliverydestinationPath {
|
|
921
|
+
body: PatchLocationGroupDeliverydestinationBody;
|
|
920
922
|
}
|
|
921
923
|
|
|
922
924
|
// DELETE /location/group/{id}/deliverydestination - Delete single or multiple delivery destinations
|
|
923
925
|
|
|
924
926
|
export interface DeleteLocationGroupDeliverydestinationPath {
|
|
925
|
-
|
|
926
|
-
|
|
927
|
+
// Group ID
|
|
928
|
+
id: string;
|
|
927
929
|
}
|
|
928
930
|
|
|
929
931
|
export interface DeleteLocationGroupDeliverydestinationBody {
|
|
930
|
-
|
|
932
|
+
delivery_destination_ids: string[];
|
|
931
933
|
}
|
|
932
934
|
|
|
933
935
|
export interface DeleteLocationGroupDeliverydestinationResponse {
|
|
934
|
-
|
|
936
|
+
deleted_delivery_destinations: DeliveryDestination[];
|
|
935
937
|
}
|
|
936
938
|
|
|
937
939
|
export interface DeleteLocationGroupDeliverydestinationRequest
|
|
938
|
-
|
|
939
|
-
|
|
940
|
-
|
|
940
|
+
extends BaseRequest,
|
|
941
|
+
DeleteLocationGroupDeliverydestinationPath {
|
|
942
|
+
body: DeleteLocationGroupDeliverydestinationBody;
|
|
941
943
|
}
|
|
942
944
|
|
|
943
945
|
// GET /location/group/{id}/deliverydestination/{delivery_destination} - Get a delivery destination
|
|
944
946
|
|
|
945
947
|
export interface GetLocationGroupDeliverydestinationPath {
|
|
946
|
-
|
|
947
|
-
|
|
948
|
-
|
|
949
|
-
|
|
948
|
+
// Group ID
|
|
949
|
+
id: string;
|
|
950
|
+
// Delivery Destination ID
|
|
951
|
+
delivery_destination: string;
|
|
950
952
|
}
|
|
951
953
|
|
|
952
954
|
export interface GetLocationGroupDeliverydestinationQuery {
|
|
953
|
-
|
|
954
|
-
|
|
955
|
-
|
|
956
|
-
|
|
955
|
+
// Return only in-use destinations
|
|
956
|
+
active?: boolean;
|
|
957
|
+
// Graphql query string
|
|
958
|
+
_query?: string;
|
|
957
959
|
}
|
|
958
960
|
|
|
959
961
|
export type GetLocationGroupDeliverydestinationResponse = DeliveryDestination;
|
|
960
962
|
|
|
961
963
|
export interface GetLocationGroupDeliverydestinationRequest
|
|
962
|
-
|
|
963
|
-
|
|
964
|
-
|
|
964
|
+
extends BaseRequest,
|
|
965
|
+
RequestQuery<GetLocationGroupDeliverydestinationQuery>,
|
|
966
|
+
GetLocationGroupDeliverydestinationPath {}
|
|
965
967
|
|
|
966
968
|
// GET /location/brands - Get all location brands
|
|
967
969
|
|
|
968
970
|
export interface GetLocationBrandsQuery {
|
|
969
|
-
|
|
970
|
-
|
|
971
|
+
// Graphql query string
|
|
972
|
+
_query?: string;
|
|
971
973
|
}
|
|
972
974
|
|
|
973
975
|
export interface GetLocationBrandsResponse {
|
|
974
|
-
|
|
976
|
+
brands?: Brands;
|
|
975
977
|
}
|
|
976
978
|
|
|
977
979
|
export interface GetLocationBrandsRequest
|
|
978
|
-
|
|
979
|
-
|
|
980
|
+
extends BaseRequest,
|
|
981
|
+
RequestQuery<GetLocationBrandsQuery> {}
|
|
980
982
|
|
|
981
983
|
// GET /location/brand/{id}/deliverydestinations - Get delivery destinations for a brand
|
|
982
984
|
|
|
983
985
|
export interface GetLocationBrandDestinationsPath {
|
|
984
|
-
|
|
985
|
-
|
|
986
|
+
// Brand ID
|
|
987
|
+
id: string;
|
|
986
988
|
}
|
|
987
989
|
|
|
988
990
|
export interface GetLocationBrandDestinationsQuery {
|
|
989
|
-
|
|
990
|
-
|
|
991
|
+
// Graphql query string
|
|
992
|
+
_query?: string;
|
|
991
993
|
}
|
|
992
994
|
|
|
993
995
|
export type GetLocationBrandDestinationsResponse = DeliveryDestinationIDs;
|
|
994
996
|
|
|
995
997
|
export interface GetLocationBrandDestinationsRequest
|
|
996
|
-
|
|
997
|
-
|
|
998
|
-
|
|
998
|
+
extends BaseRequest,
|
|
999
|
+
RequestQuery<GetLocationBrandDestinationsQuery>,
|
|
1000
|
+
GetLocationBrandDestinationsPath {}
|
|
999
1001
|
|
|
1000
1002
|
// GET /location/brand/{id}/timeslots - Get location brand timeslots
|
|
1001
1003
|
|
|
1002
1004
|
export interface GetLocationBrandTimeslotsPath {
|
|
1003
|
-
|
|
1004
|
-
|
|
1005
|
+
// Brand ID
|
|
1006
|
+
id: string;
|
|
1005
1007
|
}
|
|
1006
1008
|
|
|
1007
1009
|
export interface GetLocationBrandTimeslotsQuery {
|
|
1008
|
-
|
|
1009
|
-
|
|
1010
|
-
|
|
1011
|
-
|
|
1012
|
-
|
|
1013
|
-
|
|
1010
|
+
// Get the pickup timeslots after this date within the business hours of the location
|
|
1011
|
+
date?: number;
|
|
1012
|
+
// Limit the number of timeslots returned
|
|
1013
|
+
limit?: number;
|
|
1014
|
+
// Graphql query string
|
|
1015
|
+
_query?: string;
|
|
1014
1016
|
}
|
|
1015
1017
|
|
|
1016
1018
|
export type GetLocationBrandTimeslotsResponse = TimeSlots;
|
|
1017
1019
|
|
|
1018
1020
|
export interface GetLocationBrandTimeslotsRequest
|
|
1019
|
-
|
|
1020
|
-
|
|
1021
|
-
|
|
1021
|
+
extends BaseRequest,
|
|
1022
|
+
RequestQuery<GetLocationBrandTimeslotsQuery>,
|
|
1023
|
+
GetLocationBrandTimeslotsPath {}
|
|
1022
1024
|
|
|
1023
1025
|
// POST /location/marketplace/timeslots - Get Market Place timeslots
|
|
1024
1026
|
|
|
1025
1027
|
export interface PostLocationMarketplaceTimeslotsQuery {
|
|
1026
|
-
|
|
1027
|
-
|
|
1028
|
-
|
|
1029
|
-
|
|
1028
|
+
// Get the pickup timeslots after this date within the business hours of the location
|
|
1029
|
+
date?: number;
|
|
1030
|
+
// Limit the number of timeslots returned
|
|
1031
|
+
limit?: number;
|
|
1030
1032
|
}
|
|
1031
1033
|
|
|
1032
1034
|
export type PostLocationMarketplaceTimeslotsBody = MarketPlace;
|
|
@@ -1034,18 +1036,18 @@ export type PostLocationMarketplaceTimeslotsBody = MarketPlace;
|
|
|
1034
1036
|
export type PostLocationMarketplaceTimeslotsResponse = TimeSlots;
|
|
1035
1037
|
|
|
1036
1038
|
export interface PostLocationMarketplaceTimeslotsRequest
|
|
1037
|
-
|
|
1038
|
-
|
|
1039
|
-
|
|
1039
|
+
extends BaseRequest,
|
|
1040
|
+
RequestQuery<PostLocationMarketplaceTimeslotsQuery> {
|
|
1041
|
+
body: PostLocationMarketplaceTimeslotsBody;
|
|
1040
1042
|
}
|
|
1041
1043
|
|
|
1042
1044
|
// POST /location/marketplace/timeslots/delivery - Get Marketplace delivery timeslots
|
|
1043
1045
|
|
|
1044
1046
|
export interface PostLocationMarketplaceTimeslotsDeliveryQuery {
|
|
1045
|
-
|
|
1046
|
-
|
|
1047
|
-
|
|
1048
|
-
|
|
1047
|
+
// Get the delivery timeslots after this date within the business hours of the location
|
|
1048
|
+
date?: number;
|
|
1049
|
+
// Limit the number of timeslots returned
|
|
1050
|
+
limit?: number;
|
|
1049
1051
|
}
|
|
1050
1052
|
|
|
1051
1053
|
export type PostLocationMarketplaceTimeslotsDeliveryBody = MarketPlace;
|
|
@@ -1053,83 +1055,83 @@ export type PostLocationMarketplaceTimeslotsDeliveryBody = MarketPlace;
|
|
|
1053
1055
|
export type PostLocationMarketplaceTimeslotsDeliveryResponse = TimeSlots;
|
|
1054
1056
|
|
|
1055
1057
|
export interface PostLocationMarketplaceTimeslotsDeliveryRequest
|
|
1056
|
-
|
|
1057
|
-
|
|
1058
|
-
|
|
1058
|
+
extends BaseRequest,
|
|
1059
|
+
RequestQuery<PostLocationMarketplaceTimeslotsDeliveryQuery> {
|
|
1060
|
+
body: PostLocationMarketplaceTimeslotsDeliveryBody;
|
|
1059
1061
|
}
|
|
1060
1062
|
|
|
1061
1063
|
// GET /location/brand/{id}/timeslots/menu/{menu} - Get location brand timeslots for menu
|
|
1062
1064
|
|
|
1063
1065
|
export interface GetLocationBrandMenuTimeslotsPath {
|
|
1064
|
-
|
|
1065
|
-
|
|
1066
|
-
|
|
1067
|
-
|
|
1066
|
+
// Brand ID
|
|
1067
|
+
id: string;
|
|
1068
|
+
// Menu ID
|
|
1069
|
+
menu: string;
|
|
1068
1070
|
}
|
|
1069
1071
|
|
|
1070
1072
|
export interface GetLocationBrandMenuTimeslotsQuery {
|
|
1071
|
-
|
|
1072
|
-
|
|
1073
|
-
|
|
1074
|
-
|
|
1075
|
-
|
|
1076
|
-
|
|
1073
|
+
// Get the pickup timeslots after this date within the business hours of the location
|
|
1074
|
+
date?: number;
|
|
1075
|
+
// Limit the number of timeslots returned
|
|
1076
|
+
limit?: number;
|
|
1077
|
+
// Graphql query string
|
|
1078
|
+
_query?: string;
|
|
1077
1079
|
}
|
|
1078
1080
|
|
|
1079
1081
|
export type GetLocationBrandMenuTimeslotsResponse = TimeSlots;
|
|
1080
1082
|
|
|
1081
1083
|
export interface GetLocationBrandMenuTimeslotsRequest
|
|
1082
|
-
|
|
1083
|
-
|
|
1084
|
-
|
|
1084
|
+
extends BaseRequest,
|
|
1085
|
+
RequestQuery<GetLocationBrandMenuTimeslotsQuery>,
|
|
1086
|
+
GetLocationBrandMenuTimeslotsPath {}
|
|
1085
1087
|
|
|
1086
1088
|
// GET /location/brand/{id}/timeslots/delivery - Get location brand delivery timeslots
|
|
1087
1089
|
|
|
1088
1090
|
export interface GetLocationBrandDeliveryTimeslotsPath {
|
|
1089
|
-
|
|
1090
|
-
|
|
1091
|
+
// Brand ID
|
|
1092
|
+
id: string;
|
|
1091
1093
|
}
|
|
1092
1094
|
|
|
1093
1095
|
export interface GetLocationBrandDeliveryTimeslotsQuery {
|
|
1094
|
-
|
|
1095
|
-
|
|
1096
|
-
|
|
1097
|
-
|
|
1098
|
-
|
|
1099
|
-
|
|
1096
|
+
// Get the delivery timeslots after this date within the business hours of the location
|
|
1097
|
+
date?: number;
|
|
1098
|
+
// Limit the number of timeslots returned
|
|
1099
|
+
limit?: number;
|
|
1100
|
+
// Graphql query string
|
|
1101
|
+
_query?: string;
|
|
1100
1102
|
}
|
|
1101
1103
|
|
|
1102
1104
|
export type GetLocationBrandDeliveryTimeslotsResponse = TimeSlots;
|
|
1103
1105
|
|
|
1104
1106
|
export interface GetLocationBrandDeliveryTimeslotsRequest
|
|
1105
|
-
|
|
1106
|
-
|
|
1107
|
-
|
|
1107
|
+
extends BaseRequest,
|
|
1108
|
+
RequestQuery<GetLocationBrandDeliveryTimeslotsQuery>,
|
|
1109
|
+
GetLocationBrandDeliveryTimeslotsPath {}
|
|
1108
1110
|
|
|
1109
1111
|
// GET /location/brand/{id}/timeslots/delivery/menu/{menu} - Get location brand delivery timeslots for menu
|
|
1110
1112
|
|
|
1111
1113
|
export interface GetLocationBrandMenuDeliveryTimeslostsPath {
|
|
1112
|
-
|
|
1113
|
-
|
|
1114
|
-
|
|
1115
|
-
|
|
1114
|
+
// Brand ID
|
|
1115
|
+
id: string;
|
|
1116
|
+
// Menu ID
|
|
1117
|
+
menu: string;
|
|
1116
1118
|
}
|
|
1117
1119
|
|
|
1118
1120
|
export interface GetLocationBrandMenuDeliveryTimeslostsQuery {
|
|
1119
|
-
|
|
1120
|
-
|
|
1121
|
-
|
|
1122
|
-
|
|
1123
|
-
|
|
1124
|
-
|
|
1121
|
+
// Get the delivery timeslots after this date within the business hours of the location
|
|
1122
|
+
date?: number;
|
|
1123
|
+
// Limit the number of timeslots returned
|
|
1124
|
+
limit?: number;
|
|
1125
|
+
// Graphql query string
|
|
1126
|
+
_query?: string;
|
|
1125
1127
|
}
|
|
1126
1128
|
|
|
1127
1129
|
export type GetLocationBrandMenuDeliveryTimeslostsResponse = TimeSlots;
|
|
1128
1130
|
|
|
1129
1131
|
export interface GetLocationBrandMenuDeliveryTimeslostsRequest
|
|
1130
|
-
|
|
1131
|
-
|
|
1132
|
-
|
|
1132
|
+
extends BaseRequest,
|
|
1133
|
+
RequestQuery<GetLocationBrandMenuDeliveryTimeslostsQuery>,
|
|
1134
|
+
GetLocationBrandMenuDeliveryTimeslostsPath {}
|
|
1133
1135
|
|
|
1134
1136
|
// POST /location/brand - Create a new Brand
|
|
1135
1137
|
|
|
@@ -1138,58 +1140,58 @@ export type PostLocationBrandBody = Brand;
|
|
|
1138
1140
|
export type PostLocationBrandResponse = Brand;
|
|
1139
1141
|
|
|
1140
1142
|
export interface PostLocationBrandRequest extends BaseRequest {
|
|
1141
|
-
|
|
1143
|
+
body: PostLocationBrandBody;
|
|
1142
1144
|
}
|
|
1143
1145
|
|
|
1144
1146
|
// PATCH /location/brand/bulk - Update multiple brands
|
|
1145
1147
|
|
|
1146
1148
|
export interface PatchLocationBrandBulkBody {
|
|
1147
|
-
|
|
1149
|
+
brands: Brands;
|
|
1148
1150
|
}
|
|
1149
1151
|
|
|
1150
1152
|
export interface PatchLocationBrandBulkResponse {
|
|
1151
|
-
|
|
1152
|
-
|
|
1153
|
-
|
|
1154
|
-
|
|
1155
|
-
|
|
1153
|
+
message?: string;
|
|
1154
|
+
// List of updated brands
|
|
1155
|
+
updated_brands?: Brand[];
|
|
1156
|
+
// List of brands that failed to update
|
|
1157
|
+
failed_brand_updates?: Brand[];
|
|
1156
1158
|
}
|
|
1157
1159
|
|
|
1158
1160
|
export interface PatchLocationBrandBulkRequest extends BaseRequest {
|
|
1159
|
-
|
|
1161
|
+
body: PatchLocationBrandBulkBody;
|
|
1160
1162
|
}
|
|
1161
1163
|
|
|
1162
1164
|
// GET /location/brand/{id} - Get location brand
|
|
1163
1165
|
|
|
1164
1166
|
export interface GetLocationBrandPath {
|
|
1165
|
-
|
|
1166
|
-
|
|
1167
|
+
// Brand ID
|
|
1168
|
+
id: string;
|
|
1167
1169
|
}
|
|
1168
1170
|
|
|
1169
1171
|
export interface GetLocationBrandQuery {
|
|
1170
|
-
|
|
1171
|
-
|
|
1172
|
-
|
|
1173
|
-
|
|
1174
|
-
|
|
1175
|
-
|
|
1176
|
-
|
|
1177
|
-
|
|
1178
|
-
|
|
1172
|
+
// If true, includes brand public/private configs into response. Auth should be provided.
|
|
1173
|
+
include_config?: boolean;
|
|
1174
|
+
// show additional hidden properties/entities
|
|
1175
|
+
extended?: boolean;
|
|
1176
|
+
// determine whether to calculate estimated_wait_time
|
|
1177
|
+
include_estimated_wait_time?: boolean;
|
|
1178
|
+
// Graphql query string
|
|
1179
|
+
_query?: string;
|
|
1180
|
+
nocache?: boolean;
|
|
1179
1181
|
}
|
|
1180
1182
|
|
|
1181
1183
|
export type GetLocationBrandResponse = Brand;
|
|
1182
1184
|
|
|
1183
1185
|
export interface GetLocationBrandRequest
|
|
1184
|
-
|
|
1185
|
-
|
|
1186
|
-
|
|
1186
|
+
extends BaseRequest,
|
|
1187
|
+
RequestQuery<GetLocationBrandQuery>,
|
|
1188
|
+
GetLocationBrandPath {}
|
|
1187
1189
|
|
|
1188
1190
|
// PATCH /location/brand/{id} - Update location brand
|
|
1189
1191
|
|
|
1190
1192
|
export interface PatchLocationBrandPath {
|
|
1191
|
-
|
|
1192
|
-
|
|
1193
|
+
// Brand ID
|
|
1194
|
+
id: string;
|
|
1193
1195
|
}
|
|
1194
1196
|
|
|
1195
1197
|
export type PatchLocationBrandBody = Brand;
|
|
@@ -1197,14 +1199,14 @@ export type PatchLocationBrandBody = Brand;
|
|
|
1197
1199
|
export type PatchLocationBrandResponse = Brand;
|
|
1198
1200
|
|
|
1199
1201
|
export interface PatchLocationBrandRequest extends BaseRequest, PatchLocationBrandPath {
|
|
1200
|
-
|
|
1202
|
+
body: PatchLocationBrandBody;
|
|
1201
1203
|
}
|
|
1202
1204
|
|
|
1203
1205
|
// DELETE /location/brand/{id} - Delete data from a Brand
|
|
1204
1206
|
|
|
1205
1207
|
export interface DeleteLocationBrandPath {
|
|
1206
|
-
|
|
1207
|
-
|
|
1208
|
+
// Brand ID
|
|
1209
|
+
id: string;
|
|
1208
1210
|
}
|
|
1209
1211
|
|
|
1210
1212
|
export type DeleteLocationBrandResponse = success;
|
|
@@ -1214,8 +1216,8 @@ export interface DeleteLocationBrandRequest extends BaseRequest, DeleteLocationB
|
|
|
1214
1216
|
// PUT /location/brand/{id} - Update location brand
|
|
1215
1217
|
|
|
1216
1218
|
export interface PutLocationBrandPath {
|
|
1217
|
-
|
|
1218
|
-
|
|
1219
|
+
// Brand ID
|
|
1220
|
+
id: string;
|
|
1219
1221
|
}
|
|
1220
1222
|
|
|
1221
1223
|
export type PutLocationBrandBody = Brand;
|
|
@@ -1223,22 +1225,22 @@ export type PutLocationBrandBody = Brand;
|
|
|
1223
1225
|
export type PutLocationBrandResponse = Brand;
|
|
1224
1226
|
|
|
1225
1227
|
export interface PutLocationBrandRequest extends BaseRequest, PutLocationBrandPath {
|
|
1226
|
-
|
|
1228
|
+
body: PutLocationBrandBody;
|
|
1227
1229
|
}
|
|
1228
1230
|
|
|
1229
1231
|
// GET /location/sector - Get list of all the sectors
|
|
1230
1232
|
|
|
1231
1233
|
export interface GetLocationSectorsQuery {
|
|
1232
|
-
|
|
1233
|
-
|
|
1234
|
-
|
|
1234
|
+
// Graphql query string
|
|
1235
|
+
_query?: string;
|
|
1236
|
+
nocache?: boolean;
|
|
1235
1237
|
}
|
|
1236
1238
|
|
|
1237
1239
|
export type GetLocationSectorsResponse = Sectors;
|
|
1238
1240
|
|
|
1239
1241
|
export interface GetLocationSectorsRequest
|
|
1240
|
-
|
|
1241
|
-
|
|
1242
|
+
extends BaseRequest,
|
|
1243
|
+
RequestQuery<GetLocationSectorsQuery> {}
|
|
1242
1244
|
|
|
1243
1245
|
// POST /location/sector - Create a new sector
|
|
1244
1246
|
|
|
@@ -1247,41 +1249,41 @@ export type PostLocationSectorBody = CreateSector;
|
|
|
1247
1249
|
export type PostLocationSectorResponse = Sector;
|
|
1248
1250
|
|
|
1249
1251
|
export interface PostLocationSectorRequest extends BaseRequest {
|
|
1250
|
-
|
|
1252
|
+
body: PostLocationSectorBody;
|
|
1251
1253
|
}
|
|
1252
1254
|
|
|
1253
1255
|
// GET /location/sector/{id} - Get a sector
|
|
1254
1256
|
|
|
1255
1257
|
export interface GetLocationSectorPath {
|
|
1256
|
-
|
|
1257
|
-
|
|
1258
|
+
// sector
|
|
1259
|
+
id: string;
|
|
1258
1260
|
}
|
|
1259
1261
|
|
|
1260
1262
|
export interface GetLocationSectorQuery {
|
|
1261
|
-
|
|
1262
|
-
|
|
1263
|
-
|
|
1264
|
-
|
|
1265
|
-
|
|
1263
|
+
// Omits nested children of a sector if false
|
|
1264
|
+
expanded?: boolean;
|
|
1265
|
+
// Graphql query string
|
|
1266
|
+
_query?: string;
|
|
1267
|
+
nocache?: boolean;
|
|
1266
1268
|
}
|
|
1267
1269
|
|
|
1268
1270
|
export type GetLocationSectorResponse = Sector;
|
|
1269
1271
|
|
|
1270
1272
|
export interface GetLocationSectorRequest
|
|
1271
|
-
|
|
1272
|
-
|
|
1273
|
-
|
|
1273
|
+
extends BaseRequest,
|
|
1274
|
+
RequestQuery<GetLocationSectorQuery>,
|
|
1275
|
+
GetLocationSectorPath {}
|
|
1274
1276
|
|
|
1275
1277
|
// PATCH /location/sector/{id} - Update a sector
|
|
1276
1278
|
|
|
1277
1279
|
export interface PatchLocationSectorPath {
|
|
1278
|
-
|
|
1279
|
-
|
|
1280
|
+
// sector
|
|
1281
|
+
id: string;
|
|
1280
1282
|
}
|
|
1281
1283
|
|
|
1282
1284
|
export interface PatchLocationSectorQuery {
|
|
1283
|
-
|
|
1284
|
-
|
|
1285
|
+
// Omits nested children of a sector if false
|
|
1286
|
+
expanded?: boolean;
|
|
1285
1287
|
}
|
|
1286
1288
|
|
|
1287
1289
|
export type PatchLocationSectorBody = CreateSector;
|
|
@@ -1289,56 +1291,56 @@ export type PatchLocationSectorBody = CreateSector;
|
|
|
1289
1291
|
export type PatchLocationSectorResponse = Sector;
|
|
1290
1292
|
|
|
1291
1293
|
export interface PatchLocationSectorRequest
|
|
1292
|
-
|
|
1293
|
-
|
|
1294
|
-
|
|
1295
|
-
|
|
1294
|
+
extends BaseRequest,
|
|
1295
|
+
RequestQuery<PatchLocationSectorQuery>,
|
|
1296
|
+
PatchLocationSectorPath {
|
|
1297
|
+
body: PatchLocationSectorBody;
|
|
1296
1298
|
}
|
|
1297
1299
|
|
|
1298
1300
|
// POST /location/company - Create a new company
|
|
1299
1301
|
|
|
1300
1302
|
export interface PostLocationCompanyBody {
|
|
1301
|
-
|
|
1302
|
-
|
|
1303
|
-
|
|
1304
|
-
|
|
1305
|
-
|
|
1306
|
-
|
|
1307
|
-
|
|
1308
|
-
|
|
1303
|
+
// Sector name
|
|
1304
|
+
name: string;
|
|
1305
|
+
// sector
|
|
1306
|
+
sector: string;
|
|
1307
|
+
label?: Record<string, any>;
|
|
1308
|
+
is?: {
|
|
1309
|
+
global_images_enabled?: boolean;
|
|
1310
|
+
};
|
|
1309
1311
|
}
|
|
1310
1312
|
|
|
1311
1313
|
export type PostLocationCompanyResponse = Company;
|
|
1312
1314
|
|
|
1313
1315
|
export interface PostLocationCompanyRequest extends BaseRequest {
|
|
1314
|
-
|
|
1316
|
+
body: PostLocationCompanyBody;
|
|
1315
1317
|
}
|
|
1316
1318
|
|
|
1317
1319
|
// GET /location/company/{id} - Get a company within sector
|
|
1318
1320
|
|
|
1319
1321
|
export interface GetLocationCompanyPath {
|
|
1320
|
-
|
|
1321
|
-
|
|
1322
|
+
// Company ID
|
|
1323
|
+
id: string;
|
|
1322
1324
|
}
|
|
1323
1325
|
|
|
1324
1326
|
export interface GetLocationCompanyQuery {
|
|
1325
|
-
|
|
1326
|
-
|
|
1327
|
-
|
|
1327
|
+
expanded?: boolean;
|
|
1328
|
+
// Graphql query string
|
|
1329
|
+
_query?: string;
|
|
1328
1330
|
}
|
|
1329
1331
|
|
|
1330
1332
|
export type GetLocationCompanyResponse = Company;
|
|
1331
1333
|
|
|
1332
1334
|
export interface GetLocationCompanyRequest
|
|
1333
|
-
|
|
1334
|
-
|
|
1335
|
-
|
|
1335
|
+
extends BaseRequest,
|
|
1336
|
+
RequestQuery<GetLocationCompanyQuery>,
|
|
1337
|
+
GetLocationCompanyPath {}
|
|
1336
1338
|
|
|
1337
1339
|
// PATCH /location/company/{id} - Update a company
|
|
1338
1340
|
|
|
1339
1341
|
export interface PatchLocationCompanyPath {
|
|
1340
|
-
|
|
1341
|
-
|
|
1342
|
+
// Company ID
|
|
1343
|
+
id: string;
|
|
1342
1344
|
}
|
|
1343
1345
|
|
|
1344
1346
|
export type PatchLocationCompanyBody = CompanyUpdateBody;
|
|
@@ -1346,101 +1348,101 @@ export type PatchLocationCompanyBody = CompanyUpdateBody;
|
|
|
1346
1348
|
export type PatchLocationCompanyResponse = Company;
|
|
1347
1349
|
|
|
1348
1350
|
export interface PatchLocationCompanyRequest extends BaseRequest, PatchLocationCompanyPath {
|
|
1349
|
-
|
|
1351
|
+
body: PatchLocationCompanyBody;
|
|
1350
1352
|
}
|
|
1351
1353
|
|
|
1352
1354
|
// DELETE /location/record/{id} - Delete a Brand, Location, Group, or MultiGroup
|
|
1353
1355
|
|
|
1354
1356
|
export interface DeleteLocationRecordPath {
|
|
1355
|
-
|
|
1356
|
-
|
|
1357
|
+
// brand, location, group, or multigroup id
|
|
1358
|
+
id: string;
|
|
1357
1359
|
}
|
|
1358
1360
|
|
|
1359
1361
|
export interface DeleteLocationRecordQuery {
|
|
1360
|
-
|
|
1361
|
-
|
|
1362
|
+
// Don't delete the record
|
|
1363
|
+
dryrun?: boolean;
|
|
1362
1364
|
}
|
|
1363
1365
|
|
|
1364
1366
|
export interface DeleteLocationRecordResponse {
|
|
1365
|
-
|
|
1367
|
+
[index: string]: any;
|
|
1366
1368
|
}
|
|
1367
1369
|
|
|
1368
1370
|
export interface DeleteLocationRecordRequest
|
|
1369
|
-
|
|
1370
|
-
|
|
1371
|
-
|
|
1371
|
+
extends BaseRequest,
|
|
1372
|
+
RequestQuery<DeleteLocationRecordQuery>,
|
|
1373
|
+
DeleteLocationRecordPath {}
|
|
1372
1374
|
|
|
1373
1375
|
// GET /location/v2/groups - Get a list of groups
|
|
1374
1376
|
|
|
1375
1377
|
export interface GetLocationV2GroupsQuery {
|
|
1376
|
-
|
|
1377
|
-
|
|
1378
|
-
|
|
1379
|
-
|
|
1380
|
-
|
|
1381
|
-
|
|
1382
|
-
|
|
1383
|
-
|
|
1384
|
-
|
|
1385
|
-
|
|
1386
|
-
|
|
1387
|
-
|
|
1388
|
-
|
|
1389
|
-
|
|
1378
|
+
// Filter groups by multigroup id. Should be like an array of string
|
|
1379
|
+
id_multigroups?: string;
|
|
1380
|
+
// The number of items per page to return
|
|
1381
|
+
limit?: number;
|
|
1382
|
+
// ASC or DESC
|
|
1383
|
+
sortOrder?: string;
|
|
1384
|
+
// The page number to return
|
|
1385
|
+
page?: number;
|
|
1386
|
+
// Expand group results with children locations and brands
|
|
1387
|
+
expanded?: boolean;
|
|
1388
|
+
// Filter groups by given string
|
|
1389
|
+
filter?: string;
|
|
1390
|
+
// Graphql query string
|
|
1391
|
+
_query?: string;
|
|
1390
1392
|
}
|
|
1391
1393
|
|
|
1392
1394
|
export interface GetLocationV2GroupsResponse {
|
|
1393
|
-
|
|
1394
|
-
|
|
1395
|
-
|
|
1396
|
-
|
|
1397
|
-
|
|
1398
|
-
|
|
1399
|
-
|
|
1400
|
-
|
|
1401
|
-
|
|
1402
|
-
|
|
1403
|
-
|
|
1395
|
+
meta?: {
|
|
1396
|
+
limit?: number;
|
|
1397
|
+
page?: number;
|
|
1398
|
+
totalResults?: number;
|
|
1399
|
+
totalPages?: number;
|
|
1400
|
+
resultsCount?: number;
|
|
1401
|
+
sortOrder?: string;
|
|
1402
|
+
sortBy?: string;
|
|
1403
|
+
};
|
|
1404
|
+
// An Array of Groups
|
|
1405
|
+
results?: Group[];
|
|
1404
1406
|
}
|
|
1405
1407
|
|
|
1406
1408
|
export interface GetLocationV2GroupsRequest
|
|
1407
|
-
|
|
1408
|
-
|
|
1409
|
+
extends BaseRequest,
|
|
1410
|
+
RequestQuery<GetLocationV2GroupsQuery> {}
|
|
1409
1411
|
|
|
1410
1412
|
// GET /location/menu_association/{id}/brand - Get menu association for a brand
|
|
1411
1413
|
|
|
1412
1414
|
export interface GetLocationMenuAssociationBrandPath {
|
|
1413
|
-
|
|
1414
|
-
|
|
1415
|
+
// brand id
|
|
1416
|
+
id: string;
|
|
1415
1417
|
}
|
|
1416
1418
|
|
|
1417
1419
|
export interface GetLocationMenuAssociationBrandQuery {
|
|
1418
|
-
|
|
1419
|
-
|
|
1420
|
+
// Graphql query string
|
|
1421
|
+
_query?: string;
|
|
1420
1422
|
}
|
|
1421
1423
|
|
|
1422
1424
|
export type GetLocationMenuAssociationBrandResponse = MenuAssociations;
|
|
1423
1425
|
|
|
1424
1426
|
export interface GetLocationMenuAssociationBrandRequest
|
|
1425
|
-
|
|
1426
|
-
|
|
1427
|
-
|
|
1427
|
+
extends BaseRequest,
|
|
1428
|
+
RequestQuery<GetLocationMenuAssociationBrandQuery>,
|
|
1429
|
+
GetLocationMenuAssociationBrandPath {}
|
|
1428
1430
|
|
|
1429
1431
|
// GET /location/menu_association/{id}/menu - Get menu association for a brand
|
|
1430
1432
|
|
|
1431
1433
|
export interface GetLocationMenuAssociationMenuPath {
|
|
1432
|
-
|
|
1433
|
-
|
|
1434
|
+
// menu id
|
|
1435
|
+
id: string;
|
|
1434
1436
|
}
|
|
1435
1437
|
|
|
1436
1438
|
export interface GetLocationMenuAssociationMenuQuery {
|
|
1437
|
-
|
|
1438
|
-
|
|
1439
|
+
// Graphql query string
|
|
1440
|
+
_query?: string;
|
|
1439
1441
|
}
|
|
1440
1442
|
|
|
1441
1443
|
export type GetLocationMenuAssociationMenuResponse = MenuAssociations;
|
|
1442
1444
|
|
|
1443
1445
|
export interface GetLocationMenuAssociationMenuRequest
|
|
1444
|
-
|
|
1445
|
-
|
|
1446
|
-
|
|
1446
|
+
extends BaseRequest,
|
|
1447
|
+
RequestQuery<GetLocationMenuAssociationMenuQuery>,
|
|
1448
|
+
GetLocationMenuAssociationMenuPath {}
|