@compassdigital/sdk.typescript 3.15.0 → 3.16.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 +18 -64
- package/lib/index.d.ts.map +1 -1
- package/lib/index.js +16 -66
- package/lib/index.js.map +1 -1
- package/lib/interface/location.d.ts +3 -0
- package/lib/interface/location.d.ts.map +1 -1
- package/lib/interface/order.d.ts +13 -0
- package/lib/interface/order.d.ts.map +1 -1
- package/lib/interface/partner.d.ts +6 -13
- package/lib/interface/partner.d.ts.map +1 -1
- package/lib/interface/report.d.ts +0 -102
- package/lib/interface/report.d.ts.map +1 -1
- package/lib/interface/shoppingcart.d.ts +2 -0
- package/lib/interface/shoppingcart.d.ts.map +1 -1
- package/lib/interface/user.d.ts +0 -2
- package/lib/interface/user.d.ts.map +1 -1
- package/manifest.json +1 -1
- package/package.json +1 -1
- package/src/index.ts +30 -162
- package/src/interface/location.ts +3 -0
- package/src/interface/order.ts +24 -0
- package/src/interface/partner.ts +8 -19
- package/src/interface/report.ts +0 -145
- package/src/interface/shoppingcart.ts +5 -1
- package/src/interface/user.ts +1 -5
package/src/interface/partner.ts
CHANGED
|
@@ -164,6 +164,8 @@ export interface ShoppingCart {
|
|
|
164
164
|
type?: string;
|
|
165
165
|
// If an order should be paid with meal exchange. If true, this will calculate meals total.
|
|
166
166
|
mx_cart?: boolean;
|
|
167
|
+
// If a user's email domain is a match in a sites list of tax exempt domains
|
|
168
|
+
domain_tax_exempt?: boolean;
|
|
167
169
|
};
|
|
168
170
|
meta?: {
|
|
169
171
|
// Raw request from any vendor integrated with CDL
|
|
@@ -358,7 +360,6 @@ export interface LocationGroup {
|
|
|
358
360
|
fr?: string;
|
|
359
361
|
};
|
|
360
362
|
};
|
|
361
|
-
external_id?: string;
|
|
362
363
|
[index: string]: any;
|
|
363
364
|
}[];
|
|
364
365
|
meta?: any;
|
|
@@ -392,6 +393,7 @@ export interface LocationGroup {
|
|
|
392
393
|
show_instructions?: boolean;
|
|
393
394
|
runner_app_enabled?: boolean;
|
|
394
395
|
};
|
|
396
|
+
delivery_destinations?: string[];
|
|
395
397
|
pickup_instruction?: {
|
|
396
398
|
en?: string;
|
|
397
399
|
fr?: string;
|
|
@@ -691,14 +693,14 @@ export type CoolrImages = any[];
|
|
|
691
693
|
// POST /partner/standardcognition/shoppingcart - Calculates a shoppingcart
|
|
692
694
|
|
|
693
695
|
export interface PostPartnerStandardcognitionShoppingcartBody {
|
|
694
|
-
items
|
|
696
|
+
items?: {
|
|
695
697
|
sku?: string;
|
|
696
698
|
quantity?: number;
|
|
697
699
|
}[];
|
|
698
700
|
// brand
|
|
699
|
-
location_brand
|
|
700
|
-
//
|
|
701
|
-
shoppingcart
|
|
701
|
+
location_brand?: string;
|
|
702
|
+
// shoppingcart
|
|
703
|
+
shoppingcart?: string;
|
|
702
704
|
// Meta data from Standard Cognition shoppingcart
|
|
703
705
|
meta?: any;
|
|
704
706
|
}
|
|
@@ -725,22 +727,9 @@ export type GetPartnerStandardcognitionStoresRequest = {};
|
|
|
725
727
|
|
|
726
728
|
// POST /partner/standardcognition/menu - Create new Standard Cognition menu from JSON files
|
|
727
729
|
|
|
728
|
-
export interface PostPartnerStandardcognitionMenuBody {
|
|
729
|
-
// CDL company ID
|
|
730
|
-
company: string;
|
|
731
|
-
// CDL sector ID
|
|
732
|
-
sector: string;
|
|
733
|
-
// CDL location brand ID
|
|
734
|
-
location_brand: string;
|
|
735
|
-
// Link for S3 menu file provided by Standard Cognition
|
|
736
|
-
s3_link: string;
|
|
737
|
-
}
|
|
738
|
-
|
|
739
730
|
export type PostPartnerStandardcognitionMenuResponse = Menu;
|
|
740
731
|
|
|
741
|
-
export
|
|
742
|
-
body: PostPartnerStandardcognitionMenuBody;
|
|
743
|
-
}
|
|
732
|
+
export type PostPartnerStandardcognitionMenuRequest = {};
|
|
744
733
|
|
|
745
734
|
// GET /partner/coolr/locations - Gets the locations where Coolr is available
|
|
746
735
|
|
package/src/interface/report.ts
CHANGED
|
@@ -284,17 +284,6 @@ export interface SAReport {
|
|
|
284
284
|
};
|
|
285
285
|
}
|
|
286
286
|
|
|
287
|
-
export interface DiscrepancySubscriber {
|
|
288
|
-
subscribers_response?: {
|
|
289
|
-
id?: string;
|
|
290
|
-
email?: string;
|
|
291
|
-
type?: string;
|
|
292
|
-
}[];
|
|
293
|
-
[index: string]: any;
|
|
294
|
-
}
|
|
295
|
-
|
|
296
|
-
export type DiscrepancySubscriberRequest = any[];
|
|
297
|
-
|
|
298
287
|
export interface P2AnalyticsReport {
|
|
299
288
|
message?: string;
|
|
300
289
|
date_resolved?: string;
|
|
@@ -316,54 +305,6 @@ export interface P2AnalyticsReport {
|
|
|
316
305
|
}[];
|
|
317
306
|
}
|
|
318
307
|
|
|
319
|
-
export interface DiscrepancyTotals {
|
|
320
|
-
message?: string;
|
|
321
|
-
date_resolved?: string;
|
|
322
|
-
payload?: {
|
|
323
|
-
unitid?: string;
|
|
324
|
-
date?: string;
|
|
325
|
-
exact_total?: number;
|
|
326
|
-
mobile_total?: number;
|
|
327
|
-
difference?: number;
|
|
328
|
-
}[];
|
|
329
|
-
}
|
|
330
|
-
|
|
331
|
-
export interface DiscrepancyCount {
|
|
332
|
-
message?: string;
|
|
333
|
-
date_resolved?: string;
|
|
334
|
-
payload?: {
|
|
335
|
-
discrepancy_count?: number;
|
|
336
|
-
};
|
|
337
|
-
}
|
|
338
|
-
|
|
339
|
-
export interface DiscrepancyTranscation {
|
|
340
|
-
message?: string;
|
|
341
|
-
date_resolved?: string;
|
|
342
|
-
payload?: {
|
|
343
|
-
unitid?: string;
|
|
344
|
-
exact_tag?: string;
|
|
345
|
-
exact_order_time?: string;
|
|
346
|
-
exact_card_type?: string;
|
|
347
|
-
exact_pickup_name?: string;
|
|
348
|
-
exact_transcation_type?: string;
|
|
349
|
-
exact_total?: number;
|
|
350
|
-
exact_merchant_name?: string;
|
|
351
|
-
exact_status?: string;
|
|
352
|
-
mobile_orderid?: string;
|
|
353
|
-
mobile_order_time?: string;
|
|
354
|
-
mobile_payment_type?: string;
|
|
355
|
-
mobile_pickup_name?: string;
|
|
356
|
-
mobile_total?: number;
|
|
357
|
-
}[];
|
|
358
|
-
}
|
|
359
|
-
|
|
360
|
-
export interface TrackerReport {
|
|
361
|
-
// Base64 encoded file
|
|
362
|
-
file?: string;
|
|
363
|
-
// Base64 encoded file format
|
|
364
|
-
format?: string;
|
|
365
|
-
}
|
|
366
|
-
|
|
367
308
|
// GET /report/analytics/group/{location_group}/{report_type}
|
|
368
309
|
|
|
369
310
|
export interface GetReportAnalyticsGroupPath {
|
|
@@ -378,7 +319,6 @@ export interface GetReportAnalyticsGroupQuery {
|
|
|
378
319
|
end_date: string;
|
|
379
320
|
time_frame: string;
|
|
380
321
|
order_type?: string;
|
|
381
|
-
nocache?: boolean;
|
|
382
322
|
}
|
|
383
323
|
|
|
384
324
|
export type GetReportAnalyticsGroupResponse = P2AnalyticsReport;
|
|
@@ -408,59 +348,6 @@ export interface GetReportAnalyticsCombinedGroupRequest
|
|
|
408
348
|
extends RequestQuery<GetReportAnalyticsCombinedGroupQuery>,
|
|
409
349
|
GetReportAnalyticsCombinedGroupPath {}
|
|
410
350
|
|
|
411
|
-
// GET /report/analytics/exactmobile/totals
|
|
412
|
-
|
|
413
|
-
export interface GetReportAnalyticsExactmobileTotalsQuery {
|
|
414
|
-
start_date: string;
|
|
415
|
-
end_date: string;
|
|
416
|
-
unitids: number[];
|
|
417
|
-
offset: number;
|
|
418
|
-
}
|
|
419
|
-
|
|
420
|
-
export type GetReportAnalyticsExactmobileTotalsResponse = DiscrepancyTotals;
|
|
421
|
-
|
|
422
|
-
export interface GetReportAnalyticsExactmobileTotalsRequest
|
|
423
|
-
extends RequestQuery<GetReportAnalyticsExactmobileTotalsQuery> {}
|
|
424
|
-
|
|
425
|
-
// GET /report/analytics/exactmobile/transactions
|
|
426
|
-
|
|
427
|
-
export interface GetReportAnalyticsExactmobileTransactionsQuery {
|
|
428
|
-
start_date: string;
|
|
429
|
-
end_date: string;
|
|
430
|
-
unitids: number[];
|
|
431
|
-
offset: number;
|
|
432
|
-
}
|
|
433
|
-
|
|
434
|
-
export type GetReportAnalyticsExactmobileTransactionsResponse = DiscrepancyTranscation;
|
|
435
|
-
|
|
436
|
-
export interface GetReportAnalyticsExactmobileTransactionsRequest
|
|
437
|
-
extends RequestQuery<GetReportAnalyticsExactmobileTransactionsQuery> {}
|
|
438
|
-
|
|
439
|
-
// GET /report/analytics/exactmobile/discrepancies
|
|
440
|
-
|
|
441
|
-
export interface GetReportAnalyticsExactmobileDiscrepanciesQuery {
|
|
442
|
-
start_date: string;
|
|
443
|
-
end_date: string;
|
|
444
|
-
unitids: number[];
|
|
445
|
-
offset: number;
|
|
446
|
-
}
|
|
447
|
-
|
|
448
|
-
export type GetReportAnalyticsExactmobileDiscrepanciesResponse = DiscrepancyCount;
|
|
449
|
-
|
|
450
|
-
export interface GetReportAnalyticsExactmobileDiscrepanciesRequest
|
|
451
|
-
extends RequestQuery<GetReportAnalyticsExactmobileDiscrepanciesQuery> {}
|
|
452
|
-
|
|
453
|
-
// GET /report/analytics/tracker/report/{id}
|
|
454
|
-
|
|
455
|
-
export interface GetReportAnalyticsTrackerReportPath {
|
|
456
|
-
id: string;
|
|
457
|
-
}
|
|
458
|
-
|
|
459
|
-
export type GetReportAnalyticsTrackerReportResponse = TrackerReport;
|
|
460
|
-
|
|
461
|
-
export interface GetReportAnalyticsTrackerReportRequest
|
|
462
|
-
extends GetReportAnalyticsTrackerReportPath {}
|
|
463
|
-
|
|
464
351
|
// GET /report/eod/group/{id} - Get reports for selected location group
|
|
465
352
|
|
|
466
353
|
export interface GetReportEodGroupPath {
|
|
@@ -533,35 +420,3 @@ export type PutReportEodGroupSubscribersResponse = EODSubscribers;
|
|
|
533
420
|
export interface PutReportEodGroupSubscribersRequest extends PutReportEodGroupSubscribersPath {
|
|
534
421
|
body: PutReportEodGroupSubscribersBody;
|
|
535
422
|
}
|
|
536
|
-
|
|
537
|
-
// GET /report/discrepancy/subscribers - Get subscribers for discrepency widget
|
|
538
|
-
|
|
539
|
-
export interface GetReportDiscrepancySubscribersQuery {
|
|
540
|
-
email?: string;
|
|
541
|
-
}
|
|
542
|
-
|
|
543
|
-
export type GetReportDiscrepancySubscribersResponse = DiscrepancySubscriber;
|
|
544
|
-
|
|
545
|
-
export interface GetReportDiscrepancySubscribersRequest
|
|
546
|
-
extends RequestQuery<GetReportDiscrepancySubscribersQuery> {}
|
|
547
|
-
|
|
548
|
-
// DELETE /report/discrepancy/subscribers - deletes subscriber from discrepency
|
|
549
|
-
|
|
550
|
-
export interface DeleteReportDiscrepancySubscribersQuery {
|
|
551
|
-
emailid: string;
|
|
552
|
-
}
|
|
553
|
-
|
|
554
|
-
export type DeleteReportDiscrepancySubscribersResponse = Success;
|
|
555
|
-
|
|
556
|
-
export interface DeleteReportDiscrepancySubscribersRequest
|
|
557
|
-
extends RequestQuery<DeleteReportDiscrepancySubscribersQuery> {}
|
|
558
|
-
|
|
559
|
-
// POST /report/discrepancy/subscribers - Create new discrepancy subscriber
|
|
560
|
-
|
|
561
|
-
export type PostReportDiscrepancySubscribersBody = DiscrepancySubscriberRequest;
|
|
562
|
-
|
|
563
|
-
export type PostReportDiscrepancySubscribersResponse = DiscrepancySubscriber;
|
|
564
|
-
|
|
565
|
-
export interface PostReportDiscrepancySubscribersRequest {
|
|
566
|
-
body: PostReportDiscrepancySubscribersBody;
|
|
567
|
-
}
|
|
@@ -290,9 +290,13 @@ export interface PatchShoppingcartCartPath {
|
|
|
290
290
|
id: string;
|
|
291
291
|
}
|
|
292
292
|
|
|
293
|
+
export type PatchShoppingcartCartBody = ShoppingCart;
|
|
294
|
+
|
|
293
295
|
export type PatchShoppingcartCartResponse = ShoppingCart;
|
|
294
296
|
|
|
295
|
-
export interface PatchShoppingcartCartRequest extends PatchShoppingcartCartPath {
|
|
297
|
+
export interface PatchShoppingcartCartRequest extends PatchShoppingcartCartPath {
|
|
298
|
+
body: PatchShoppingcartCartBody;
|
|
299
|
+
}
|
|
296
300
|
|
|
297
301
|
// PUT /shoppingcart/{id}/promo - Put a promo in a ShoppingCart
|
|
298
302
|
|
package/src/interface/user.ts
CHANGED
|
@@ -372,13 +372,9 @@ export interface PatchUserAuthKdsPath {
|
|
|
372
372
|
device_id: string;
|
|
373
373
|
}
|
|
374
374
|
|
|
375
|
-
export type PatchUserAuthKdsBody = KDSDevice["device"];
|
|
376
|
-
|
|
377
375
|
export type PatchUserAuthKdsResponse = KDSDevice;
|
|
378
376
|
|
|
379
|
-
export interface PatchUserAuthKdsRequest extends PatchUserAuthKdsPath {
|
|
380
|
-
body: PatchUserAuthKdsBody;
|
|
381
|
-
}
|
|
377
|
+
export interface PatchUserAuthKdsRequest extends PatchUserAuthKdsPath {}
|
|
382
378
|
|
|
383
379
|
// POST /user/{id}/changepassword - Change the users password
|
|
384
380
|
|