@compassdigital/sdk.typescript 4.27.0 → 4.28.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 (43) hide show
  1. package/.vscode/settings.json +5 -0
  2. package/lib/index.d.ts +53 -36
  3. package/lib/index.d.ts.map +1 -1
  4. package/lib/index.js +52 -36
  5. package/lib/index.js.map +1 -1
  6. package/lib/interface/consumer.d.ts +76 -0
  7. package/lib/interface/consumer.d.ts.map +1 -0
  8. package/lib/interface/consumer.js +5 -0
  9. package/lib/interface/consumer.js.map +1 -0
  10. package/lib/interface/frictionless.d.ts +107 -107
  11. package/lib/interface/frictionless.d.ts.map +1 -1
  12. package/lib/interface/location.d.ts +0 -1
  13. package/lib/interface/location.d.ts.map +1 -1
  14. package/lib/interface/mealplan.d.ts +0 -4
  15. package/lib/interface/mealplan.d.ts.map +1 -1
  16. package/lib/interface/menu.d.ts +16 -15
  17. package/lib/interface/menu.d.ts.map +1 -1
  18. package/lib/interface/order.d.ts +3 -1
  19. package/lib/interface/order.d.ts.map +1 -1
  20. package/lib/interface/partner.d.ts +5 -3
  21. package/lib/interface/partner.d.ts.map +1 -1
  22. package/lib/interface/promo.d.ts +10 -3
  23. package/lib/interface/promo.d.ts.map +1 -1
  24. package/lib/interface/task.d.ts +3 -0
  25. package/lib/interface/task.d.ts.map +1 -1
  26. package/lib/interface/user.d.ts +14 -12
  27. package/lib/interface/user.d.ts.map +1 -1
  28. package/lib/interface/vendor.d.ts.map +1 -1
  29. package/manifest.json +5 -1
  30. package/package.json +3 -3
  31. package/pipeline.yml +1 -1
  32. package/src/index.ts +144 -97
  33. package/src/interface/consumer.ts +105 -0
  34. package/src/interface/frictionless.ts +200 -158
  35. package/src/interface/location.ts +4 -2
  36. package/src/interface/mealplan.ts +1 -9
  37. package/src/interface/menu.ts +21 -15
  38. package/src/interface/order.ts +12 -1
  39. package/src/interface/partner.ts +14 -3
  40. package/src/interface/promo.ts +10 -3
  41. package/src/interface/task.ts +4 -0
  42. package/src/interface/user.ts +20 -14
  43. package/src/interface/vendor.ts +0 -1
@@ -3,43 +3,11 @@
3
3
 
4
4
  import { RequestQuery, BaseRequest } from "./util";
5
5
 
6
- export interface StandardCognitionEvent {
7
- event_id: string;
8
- event_type: string;
9
- external_customer_id: string;
10
- tenant_id: string;
11
- order_id: string;
12
- }
13
-
14
- export interface AmazonJWOAuthEventDTO {
15
- // Value that uniquely identifies each authorization event that occurs when a shopper interacts with a JWO gate
16
- id: string;
17
- // Contains the timestamp when the authorization event took place
18
- timestamp: string;
19
- // Contains an enumerated string that tells the system where the authorization event took place. Current values are ENTRY for the JWO Entry Gate and EXIT for the Exit Gate
20
- location: "ENTRY" | "EXIT";
21
- }
22
-
23
- export interface AmazonJWOIdentityKeysRequestDTO {
24
- authEvent: AmazonJWOAuthEventDTO;
25
- identityKey: string;
26
- requestId: string;
27
- storeId: string;
28
- }
29
-
30
- export interface VisitorDetailsDTO {
31
- id: string;
32
- type: "SHOPPER" | "ASSOCIATE" | "CASH_SHOPPER";
33
- }
34
-
35
- export interface AmazonJWOIdentityKeysResponseDTO {
36
- visitorDetails: VisitorDetailsDTO;
37
- }
38
-
39
- export interface BadRequestErrorDTO {
40
- message: string;
41
- code: number;
42
- data: Record<string, any>;
6
+ export interface FrictionlessSupportResponseDTO {
7
+ // Whether the brand supports frictionless checkins
8
+ supported: boolean;
9
+ // The version of the frictionless support
10
+ version?: "NFC" | "QR";
43
11
  }
44
12
 
45
13
  export interface UnauthorizedErrorDTO {
@@ -48,55 +16,6 @@ export interface UnauthorizedErrorDTO {
48
16
  data: Record<string, any>;
49
17
  }
50
18
 
51
- export interface ShoppingTrip {
52
- // Contains a timestamp for the time the shopping trip starts. This value is not validated on our service.
53
- startTime: string;
54
- // Contains a timestamp for the time the shopping trip ends. This value is not validated on our service.
55
- endTime: string;
56
- authEvents: AmazonJWOAuthEventDTO[];
57
- }
58
-
59
- export interface Quantity {
60
- // Contains the number of each item the shopper purchased
61
- value: string;
62
- // Contains the type of unique identifier your store uses to identify each item in the cart
63
- unit: "unit" | "each";
64
- }
65
-
66
- export interface CartItem {
67
- // Contain a unique identifier for the item in the cart. This identifier will be an SKU for Compass
68
- id: string;
69
- // Contains the type of unique identifier the store uses to identify each item in the cart. This field will be always SKU for Compass
70
- type: "SKU";
71
- quantity: Quantity;
72
- }
73
-
74
- export interface ShopperIdentity {
75
- // Contains a unique identifier for each shopper AWS sends back. Refers to our CheckIn ID.
76
- id: string;
77
- }
78
-
79
- export interface AmazonJWOOrderingRequestDTO {
80
- // Contains a UUID for each checkout request. Amazon generates this UUID for each request. If Amazon has to send the same request more than once, the requestId will be different for each request. Compare the requestId to the idempotentShoppingTripId field, which remains the same throughout the shopping trip.
81
- requestId: string;
82
- // Contains a Universally Unique ID (UUID) for the current shopping trip. Amazon generates this UUID for each shopping trip
83
- idempotentShoppingTripId: string;
84
- // The storeId field contains a unique identifier for your store on AWS system
85
- storeId: string;
86
- shoppingTrip: ShoppingTrip;
87
- cartItems: CartItem[];
88
- shopperIdentity: ShopperIdentity;
89
- }
90
-
91
- export interface AmazonJWOOrderingResponseDTO {
92
- purchaseId: string;
93
- }
94
-
95
- export interface FrictionlessSupportResponse {
96
- supported: boolean;
97
- version?: "NFC" | "QR";
98
- }
99
-
100
19
  export interface ForbiddenErrorDTO {
101
20
  message: string;
102
21
  code: number;
@@ -110,30 +29,40 @@ export interface NotFoundErrorDTO {
110
29
  }
111
30
 
112
31
  export interface MealplanDTO {
32
+ // The unique identifier of the mealplan tender
113
33
  tenderID: string;
34
+ // The name of the mealplan
114
35
  name: string;
115
36
  }
116
37
 
117
38
  export interface CreditCardDTO {
39
+ // The CreditCard Type. This field is not validated. It is used to enrich checkin metadata
118
40
  cardType: string;
41
+ // The last 4 digits of the credit card
119
42
  last4: string;
120
43
  }
121
44
 
122
45
  export interface PaymentMethodDTO {
123
46
  mealplan?: MealplanDTO;
124
47
  creditCard?: CreditCardDTO;
48
+ // Token used for identify the payment method
125
49
  token: string;
126
50
  }
127
51
 
128
- export interface CreateFrictionlessQRCodeCommand {
52
+ export interface CreateFrictionlessQRCodeCommandDTO {
53
+ // The unique identifier of the brand that the checkin should be created with
129
54
  brandID: string;
55
+ // The unique identifier of the user that the checkin should be created with
130
56
  userID: string;
131
57
  paymentMethod: PaymentMethodDTO;
132
58
  }
133
59
 
134
- export interface QRCodeCreationResponse {
60
+ export interface QRCodeCreationResponseDTO {
61
+ // The base64 encoded QR code
135
62
  qrcode: string;
63
+ // The expiration time of the QR code in unix time. Always in future.
136
64
  expiration: number;
65
+ // The unique identifier for the checkin created for this QR code
137
66
  id: string;
138
67
  }
139
68
 
@@ -155,14 +84,8 @@ export interface UnprocessableEntityErrorDTO {
155
84
  data: ErrorDataDTO;
156
85
  }
157
86
 
158
- export interface FailedCheckInDTO {
159
- id: string;
160
- shopperID: string;
161
- brandID: string;
162
- reason: string;
163
- }
164
-
165
87
  export interface GetCheckInStatusResponseDTO {
88
+ // The status of the checkin
166
89
  status:
167
90
  | "CREATING"
168
91
  | "ACTIVE"
@@ -173,53 +96,138 @@ export interface GetCheckInStatusResponseDTO {
173
96
  | "COMPLETED";
174
97
  }
175
98
 
176
- export interface CheckInPaymentRequiredDTO {
177
- id: string;
178
- }
179
-
180
99
  export interface GetCheckinResponseDTO {
100
+ // The unique identifier for this checkin
181
101
  id: string;
182
- provider: string;
183
- status: string;
102
+ // The third-party provider that the checkin was created on. The value varies based on the technology installed in the station.
103
+ provider: "AWS" | "SC";
104
+ // The status of the checkin
105
+ status:
106
+ | "CREATING"
107
+ | "ACTIVE"
108
+ | "ERROR"
109
+ | "CANCELED"
110
+ | "PROCESSING"
111
+ | "UPDATE_PAYMENT_REQUIRED"
112
+ | "COMPLETED";
113
+ // The reason why the checkin failed. This field is only present when the status is 'FAILED'
184
114
  reasonOfFail?: string;
115
+ // The ID of the checkin that was created in the third-party system. They might call this entity with other terminology
185
116
  thirdPartyCorrelatedID?: string;
117
+ // The shopping cart ID for this checkin. This field is only present if the checkin was processed or is being processed but the shopping cart was already created.
186
118
  shoppingCartID?: string;
119
+ // The unique identifier of the brand that the checkin was created on
187
120
  brandID: string;
121
+ // The unique identifier of the user that created the checkin
188
122
  userID: string;
189
123
  }
190
124
 
191
- // POST /frictionless/webhook/standardcognition - Receive frictionless standard cognition events
125
+ export interface CheckInPaymentRequiredDTO {
126
+ // The unique identifier for this checkin
127
+ id: string;
128
+ }
192
129
 
193
- export type PostFrictionlessWebhookStandardcognitionBody = StandardCognitionEvent;
130
+ export interface FailedCheckInDTO {
131
+ // The unique identifier for this checkin
132
+ id: string;
133
+ // The unique identifier of the user that created the checkin
134
+ shopperID: string;
135
+ // The unique identifier of the brand that the checkin was created on
136
+ brandID: string;
137
+ // The reason why the checkin failed
138
+ reason: string;
139
+ }
194
140
 
195
- export type PostFrictionlessWebhookStandardcognitionResponse = {};
141
+ export interface AmazonJWOAuthEventDTO {
142
+ // Value that uniquely identifies each authorization event that occurs when a shopper interacts with a JWO gate
143
+ id: string;
144
+ // Contains the timestamp when the authorization event took place
145
+ timestamp: string;
146
+ // Contains an enumerated string that tells the system where the authorization event took place. Current values are ENTRY for the JWO Entry Gate and EXIT for the Exit Gate
147
+ location: "ENTRY" | "EXIT";
148
+ }
196
149
 
197
- export interface PostFrictionlessWebhookStandardcognitionRequest extends BaseRequest {
198
- body: PostFrictionlessWebhookStandardcognitionBody;
150
+ export interface AmazonJWOIdentityKeysRequestDTO {
151
+ authEvent: AmazonJWOAuthEventDTO;
152
+ // The Payload of the QR Code generated for the shopper to scan. Amazon calls this "Identity Key"
153
+ identityKey: string;
154
+ // The unique identifier for this request.
155
+ requestId: string;
156
+ // The unique identifier for the store that the shopper is interacting with on Amazon System
157
+ storeId: string;
199
158
  }
200
159
 
201
- // POST /frictionless/amazon-jwo-connector/v1/identity/identity-keys - Amazon JWO Identity Key Connector
160
+ export interface VisitorDetailsDTO {
161
+ // The unique identifier for this visitor on AWS System. Coincides with our Checkin ID
162
+ id: string;
163
+ type: "SHOPPER" | "ASSOCIATE" | "CASH_SHOPPER";
164
+ }
202
165
 
203
- export type PostFrictionlessAmazonJwoConnectorV1IdentityIdentityKeysBody =
204
- AmazonJWOIdentityKeysRequestDTO;
166
+ export interface AmazonJWOIdentityKeysResponseDTO {
167
+ visitorDetails: VisitorDetailsDTO;
168
+ }
205
169
 
206
- export type PostFrictionlessAmazonJwoConnectorV1IdentityIdentityKeysResponse =
207
- AmazonJWOIdentityKeysResponseDTO;
170
+ export interface BadRequestErrorDTO {
171
+ message: string;
172
+ code: number;
173
+ data: Record<string, any>;
174
+ }
208
175
 
209
- export interface PostFrictionlessAmazonJwoConnectorV1IdentityIdentityKeysRequest
210
- extends BaseRequest {
211
- body: PostFrictionlessAmazonJwoConnectorV1IdentityIdentityKeysBody;
176
+ export interface ShoppingTrip {
177
+ // Contains a timestamp for the time the shopping trip starts. This value is not validated on our service.
178
+ startTime: string;
179
+ // Contains a timestamp for the time the shopping trip ends. This value is not validated on our service.
180
+ endTime: string;
181
+ authEvents: AmazonJWOAuthEventDTO[];
212
182
  }
213
183
 
214
- // POST /frictionless/amazon-jwo-connector/v1/order/purchases - Amazon JWO Ordering Connector
184
+ export interface QuantityDTO {
185
+ // Contains the number of each item the shopper purchased
186
+ value: string;
187
+ // Contains the type of unique identifier your store uses to identify each item in the cart
188
+ unit: "unit" | "each";
189
+ }
215
190
 
216
- export type PostFrictionlessAmazonJwoConnectorV1OrderPurchasesBody = AmazonJWOOrderingRequestDTO;
191
+ export interface CartItemDTO {
192
+ // Contain a unique identifier for the item in the cart. This identifier will be an SKU for Compass
193
+ id: string;
194
+ // Contains the type of unique identifier the store uses to identify each item in the cart. This field will be always SKU for Compass
195
+ type: "SKU";
196
+ quantity: QuantityDTO;
197
+ }
217
198
 
218
- export type PostFrictionlessAmazonJwoConnectorV1OrderPurchasesResponse =
219
- AmazonJWOOrderingResponseDTO;
199
+ export interface ShopperIdentity {
200
+ // Contains a unique identifier for each shopper AWS sends back. Refers to our CheckIn ID.
201
+ id: string;
202
+ }
220
203
 
221
- export interface PostFrictionlessAmazonJwoConnectorV1OrderPurchasesRequest extends BaseRequest {
222
- body: PostFrictionlessAmazonJwoConnectorV1OrderPurchasesBody;
204
+ export interface AmazonJWOOrderingRequestDTO {
205
+ // Contains a UUID for each checkout request. Amazon generates this UUID for each request. If Amazon has to send the same request more than once, the requestId will be different for each request. Compare the requestId to the idempotentShoppingTripId field, which remains the same throughout the shopping trip.
206
+ requestId: string;
207
+ // Contains a Universally Unique ID (UUID) for the current shopping trip. Amazon generates this UUID for each shopping trip
208
+ idempotentShoppingTripId: string;
209
+ // The storeId field contains a unique identifier for your store on AWS system
210
+ storeId: string;
211
+ shoppingTrip: ShoppingTrip;
212
+ cartItems: CartItemDTO[];
213
+ shopperIdentity: ShopperIdentity;
214
+ }
215
+
216
+ export interface AmazonJWOOrderingResponseDTO {
217
+ purchaseId: string;
218
+ }
219
+
220
+ export interface StandardCognitionEventDTO {
221
+ // Value that uniquely identifies each event that occurs in Standard Cognition's system
222
+ event_id: string;
223
+ // Contains an enumerated string that tells the system what type of event took place. Current values are external-customer-order-created for when a new order is created and external-customer-order-state-changed for when an order changes state
224
+ event_type: "external-customer-order-created" | "external-customer-order-state-changed";
225
+ // Value that uniquely identifies each customer in Standard Cognition's system. Coincides with our Checkin ID
226
+ external_customer_id: string;
227
+ // Value that uniquely identifies each store in Standard Cognition's system
228
+ tenant_id: string;
229
+ // Value that uniquely identifies each order in Standard Cognition's system
230
+ order_id: string;
223
231
  }
224
232
 
225
233
  // GET /frictionless/brand/{id_brand}/frictionless-status - Check frictionless support of a given brand
@@ -234,7 +242,7 @@ export interface GetFrictionlessBrandFrictionlessStatusQuery {
234
242
  _query?: string;
235
243
  }
236
244
 
237
- export type GetFrictionlessBrandFrictionlessStatusResponse = FrictionlessSupportResponse;
245
+ export type GetFrictionlessBrandFrictionlessStatusResponse = FrictionlessSupportResponseDTO;
238
246
 
239
247
  export interface GetFrictionlessBrandFrictionlessStatusRequest
240
248
  extends BaseRequest,
@@ -243,56 +251,49 @@ export interface GetFrictionlessBrandFrictionlessStatusRequest
243
251
 
244
252
  // POST /frictionless/qrcode - Create Frictionless QR Code to make user able to check in
245
253
 
246
- export type PostFrictionlessQrCodeBody = CreateFrictionlessQRCodeCommand;
254
+ export type PostFrictionlessQrCodeBody = CreateFrictionlessQRCodeCommandDTO;
247
255
 
248
- export type PostFrictionlessQrCodeResponse = QRCodeCreationResponse;
256
+ export type PostFrictionlessQrCodeResponse = QRCodeCreationResponseDTO;
249
257
 
250
258
  export interface PostFrictionlessQrCodeRequest extends BaseRequest {
251
259
  body: PostFrictionlessQrCodeBody;
252
260
  }
253
261
 
254
- // GET /frictionless/failed-checkins - List check-ins on error
262
+ // GET /frictionless/checkin/{id_checkin}/status - Fetch CheckIn Status
255
263
 
256
- export interface GetFrictionlessFailedCheckinsQuery {
257
- // Graphql query string
258
- _query?: string;
264
+ export interface GetFrictionlessCheckinStatusPath {
265
+ id_checkin: string;
259
266
  }
260
267
 
261
- export type GetFrictionlessFailedCheckinsResponse = FailedCheckInDTO[];
262
-
263
- export interface GetFrictionlessFailedCheckinsRequest
264
- extends BaseRequest,
265
- RequestQuery<GetFrictionlessFailedCheckinsQuery> {}
266
-
267
- // POST /frictionless/checkins/{id_checkin}/reprocess - Reprocess checkin on error
268
-
269
- export interface PostFrictionlessCheckinsReprocessPath {
270
- id_checkin: string;
268
+ export interface GetFrictionlessCheckinStatusQuery {
269
+ // Graphql query string
270
+ _query?: string;
271
271
  }
272
272
 
273
- export type PostFrictionlessCheckinsReprocessResponse = {};
273
+ export type GetFrictionlessCheckinStatusResponse = GetCheckInStatusResponseDTO;
274
274
 
275
- export interface PostFrictionlessCheckinsReprocessRequest
275
+ export interface GetFrictionlessCheckinStatusRequest
276
276
  extends BaseRequest,
277
- PostFrictionlessCheckinsReprocessPath {}
277
+ RequestQuery<GetFrictionlessCheckinStatusQuery>,
278
+ GetFrictionlessCheckinStatusPath {}
278
279
 
279
- // GET /frictionless/checkin/{id_checkin}/status - Fetch CheckIn Status
280
+ // GET /frictionless/checkin/{id_checkin} - Fetch CheckIn
280
281
 
281
- export interface GetFrictionlessCheckinStatusPath {
282
+ export interface GetFrictionlessCheckinPath {
282
283
  id_checkin: string;
283
284
  }
284
285
 
285
- export interface GetFrictionlessCheckinStatusQuery {
286
+ export interface GetFrictionlessCheckinQuery {
286
287
  // Graphql query string
287
288
  _query?: string;
288
289
  }
289
290
 
290
- export type GetFrictionlessCheckinStatusResponse = GetCheckInStatusResponseDTO;
291
+ export type GetFrictionlessCheckinResponse = GetCheckinResponseDTO;
291
292
 
292
- export interface GetFrictionlessCheckinStatusRequest
293
+ export interface GetFrictionlessCheckinRequest
293
294
  extends BaseRequest,
294
- RequestQuery<GetFrictionlessCheckinStatusQuery>,
295
- GetFrictionlessCheckinStatusPath {}
295
+ RequestQuery<GetFrictionlessCheckinQuery>,
296
+ GetFrictionlessCheckinPath {}
296
297
 
297
298
  // GET /frictionless/users/{user_id}/checkins/payment-issues - List check-ins with update payment required per user
298
299
 
@@ -312,6 +313,31 @@ export interface GetFrictionlessUsersPaymentIssuesRequest
312
313
  RequestQuery<GetFrictionlessUsersPaymentIssuesQuery>,
313
314
  GetFrictionlessUsersPaymentIssuesPath {}
314
315
 
316
+ // GET /frictionless/failed-checkins - List check-ins on error
317
+
318
+ export interface GetFrictionlessFailedCheckinsQuery {
319
+ // Graphql query string
320
+ _query?: string;
321
+ }
322
+
323
+ export type GetFrictionlessFailedCheckinsResponse = FailedCheckInDTO[];
324
+
325
+ export interface GetFrictionlessFailedCheckinsRequest
326
+ extends BaseRequest,
327
+ RequestQuery<GetFrictionlessFailedCheckinsQuery> {}
328
+
329
+ // POST /frictionless/checkins/{id_checkin}/reprocess - Reprocess checkin on error
330
+
331
+ export interface PostFrictionlessCheckinsReprocessPath {
332
+ id_checkin: string;
333
+ }
334
+
335
+ export type PostFrictionlessCheckinsReprocessResponse = {};
336
+
337
+ export interface PostFrictionlessCheckinsReprocessRequest
338
+ extends BaseRequest,
339
+ PostFrictionlessCheckinsReprocessPath {}
340
+
315
341
  // POST /frictionless/checkins/{checkin_id}/reprocess-payment - Update payment at checkin and trigger reprocessing
316
342
 
317
343
  export interface PostFrictionlessCheckinReprocessPaymentPath {
@@ -328,20 +354,36 @@ export interface PostFrictionlessCheckinReprocessPaymentRequest
328
354
  body: PostFrictionlessCheckinReprocessPaymentBody;
329
355
  }
330
356
 
331
- // GET /frictionless/checkin/{id_checkin} - Fetch CheckIn
357
+ // POST /frictionless/amazon-jwo-connector/v1/identity/identity-keys - Amazon JWO Identity Key Connector
332
358
 
333
- export interface GetFrictionlessCheckinPath {
334
- id_checkin: string;
359
+ export type PostFrictionlessAmazonJwoConnectorV1IdentityIdentityKeysBody =
360
+ AmazonJWOIdentityKeysRequestDTO;
361
+
362
+ export type PostFrictionlessAmazonJwoConnectorV1IdentityIdentityKeysResponse =
363
+ AmazonJWOIdentityKeysResponseDTO;
364
+
365
+ export interface PostFrictionlessAmazonJwoConnectorV1IdentityIdentityKeysRequest
366
+ extends BaseRequest {
367
+ body: PostFrictionlessAmazonJwoConnectorV1IdentityIdentityKeysBody;
335
368
  }
336
369
 
337
- export interface GetFrictionlessCheckinQuery {
338
- // Graphql query string
339
- _query?: string;
370
+ // POST /frictionless/amazon-jwo-connector/v1/order/purchases - Amazon JWO Ordering Connector
371
+
372
+ export type PostFrictionlessAmazonJwoConnectorV1OrderPurchasesBody = AmazonJWOOrderingRequestDTO;
373
+
374
+ export type PostFrictionlessAmazonJwoConnectorV1OrderPurchasesResponse =
375
+ AmazonJWOOrderingResponseDTO;
376
+
377
+ export interface PostFrictionlessAmazonJwoConnectorV1OrderPurchasesRequest extends BaseRequest {
378
+ body: PostFrictionlessAmazonJwoConnectorV1OrderPurchasesBody;
340
379
  }
341
380
 
342
- export type GetFrictionlessCheckinResponse = GetCheckinResponseDTO;
381
+ // POST /frictionless/webhook/standardcognition - Receive frictionless standard cognition events
343
382
 
344
- export interface GetFrictionlessCheckinRequest
345
- extends BaseRequest,
346
- RequestQuery<GetFrictionlessCheckinQuery>,
347
- GetFrictionlessCheckinPath {}
383
+ export type PostFrictionlessWebhookStandardcognitionBody = StandardCognitionEventDTO;
384
+
385
+ export type PostFrictionlessWebhookStandardcognitionResponse = {};
386
+
387
+ export interface PostFrictionlessWebhookStandardcognitionRequest extends BaseRequest {
388
+ body: PostFrictionlessWebhookStandardcognitionBody;
389
+ }
@@ -85,7 +85,9 @@ export interface Brand {
85
85
  };
86
86
  timezone?: string;
87
87
  description?: string;
88
+ //@deprecated
88
89
  latitude?: number;
90
+ //@deprecated
89
91
  longitude?: number;
90
92
  address?: Address;
91
93
  menus?: MenuHours[];
@@ -141,6 +143,7 @@ export interface Brand {
141
143
  group?: string;
142
144
  // payment
143
145
  payment_provider?: string;
146
+ //@deprecated
144
147
  location_description?: string;
145
148
  // company
146
149
  company?: string;
@@ -341,6 +344,7 @@ export interface Locations {
341
344
  }
342
345
 
343
346
  export interface Multigroups {
347
+ //@deprecated
344
348
  groups?: MultiGroup[];
345
349
  multigroups?: MultiGroup[];
346
350
  }
@@ -815,8 +819,6 @@ export interface GetLocationGroupWaittimesPath {
815
819
  }
816
820
 
817
821
  export interface GetLocationGroupWaittimesQuery {
818
- // show additional hidden properties/entities
819
- extended?: boolean;
820
822
  // Graphql query string
821
823
  _query?: string;
822
824
  nocache?: boolean;
@@ -72,8 +72,6 @@ export interface AuthPayload {
72
72
  export interface PostMealplanPath {
73
73
  // Meal plan ID
74
74
  id: string;
75
- // Tender ID
76
- tender: string;
77
75
  }
78
76
 
79
77
  export interface PostMealplanBody {
@@ -97,8 +95,6 @@ export interface PostMealplanRequest extends BaseRequest, PostMealplanPath {
97
95
  export interface PutMealplanPath {
98
96
  // Meal plan ID
99
97
  id: string;
100
- // Tender ID
101
- tender: string;
102
98
  }
103
99
 
104
100
  export interface PutMealplanBody {
@@ -118,8 +114,6 @@ export interface PutMealplanRequest extends BaseRequest, PutMealplanPath {
118
114
  export interface GetMealplanPath {
119
115
  // Meal plan ID
120
116
  id: string;
121
- // Tender ID
122
- tender: string;
123
117
  }
124
118
 
125
119
  export interface GetMealplanQuery {
@@ -139,8 +133,6 @@ export interface GetMealplanRequest
139
133
  export interface DeleteMealplanPath {
140
134
  // Meal plan ID
141
135
  id: string;
142
- // Tender ID
143
- tender: string;
144
136
  }
145
137
 
146
138
  export interface DeleteMealplanBody {
@@ -174,7 +166,7 @@ export interface PostMealplanCallbackBody {
174
166
 
175
167
  export interface PostMealplanCallbackResponse {
176
168
  token?: string;
177
- // DH 1.0 format for returning the token
169
+ //@deprecated
178
170
  cardNumber?: string;
179
171
  }
180
172
 
@@ -34,6 +34,7 @@ export interface Menu {
34
34
  item_desc_edit_enabled?: boolean;
35
35
  calories_edit_enabled?: boolean;
36
36
  item_label_edit_enabled?: boolean;
37
+ frictionless?: boolean;
37
38
  };
38
39
  meta?: {
39
40
  // User ID
@@ -73,6 +74,7 @@ export interface Item {
73
74
  ingredients?: Record<string, any>[];
74
75
  amount_off_exclusions?: AmountOffExclusionTypes[];
75
76
  nutrition?: {
77
+ //@deprecated
76
78
  kcal?: number;
77
79
  calories?: Nutrition;
78
80
  serving_size?: Nutrition;
@@ -151,6 +153,7 @@ export interface Item {
151
153
  unit?: string;
152
154
  amount?: number;
153
155
  };
156
+ //@deprecated
154
157
  is_deleted?: boolean;
155
158
  is?: {
156
159
  disabled?: boolean;
@@ -170,7 +173,9 @@ export interface Group {
170
173
  fr?: string;
171
174
  };
172
175
  items?: Item[];
176
+ //@deprecated
173
177
  is_disabled?: boolean;
178
+ //@deprecated
174
179
  name?: string;
175
180
  is?: {
176
181
  disabled?: boolean;
@@ -201,6 +206,7 @@ export interface Option {
201
206
  };
202
207
  sku?: number;
203
208
  nutrition?: {
209
+ //@deprecated
204
210
  kcal?: number;
205
211
  calories?: Nutrition;
206
212
  };
@@ -1744,11 +1750,11 @@ export interface DraftModifierEntityDTO {
1744
1750
  brand_id: string;
1745
1751
  menu_works?: MenuWorksDTO;
1746
1752
  is_out_of_stock?: boolean;
1747
- price_for_none: number;
1748
- price_for_less: number;
1749
- price_for_more: number;
1750
- pre_surcharge: number;
1751
- post_surcharge: number;
1753
+ price_for_none?: number;
1754
+ price_for_less?: number;
1755
+ price_for_more?: number;
1756
+ pre_surcharge?: number;
1757
+ post_surcharge?: number;
1752
1758
  applied_diff_snapshot?: Record<string, any>;
1753
1759
  version?: number;
1754
1760
  brand?: DraftBrandDTO;
@@ -5968,11 +5974,11 @@ export interface PostMenuV3DraftModifierBody {
5968
5974
  brand_id: string;
5969
5975
  menu_works?: MenuWorksDTO;
5970
5976
  is_out_of_stock?: boolean;
5971
- price_for_none: number;
5972
- price_for_less: number;
5973
- price_for_more: number;
5974
- pre_surcharge: number;
5975
- post_surcharge: number;
5977
+ price_for_none?: number;
5978
+ price_for_less?: number;
5979
+ price_for_more?: number;
5980
+ pre_surcharge?: number;
5981
+ post_surcharge?: number;
5976
5982
  id?: Record<string, any>;
5977
5983
  applied_diff_snapshot?: Record<string, any>;
5978
5984
  brand?: DraftBrandDTO;
@@ -6124,11 +6130,11 @@ export type PostMenuV3DraftModifiersBody = {
6124
6130
  brand_id: string;
6125
6131
  menu_works?: MenuWorksDTO;
6126
6132
  is_out_of_stock?: boolean;
6127
- price_for_none: number;
6128
- price_for_less: number;
6129
- price_for_more: number;
6130
- pre_surcharge: number;
6131
- post_surcharge: number;
6133
+ price_for_none?: number;
6134
+ price_for_less?: number;
6135
+ price_for_more?: number;
6136
+ pre_surcharge?: number;
6137
+ post_surcharge?: number;
6132
6138
  id?: Record<string, any>;
6133
6139
  applied_diff_snapshot?: Record<string, any>;
6134
6140
  brand?: DraftBrandDTO;