@compassdigital/sdk.typescript 4.435.0 → 4.437.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/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@compassdigital/sdk.typescript",
3
- "version": "4.435.0",
3
+ "version": "4.437.0",
4
4
  "description": "Compass Digital Labs TypeScript SDK",
5
5
  "type": "commonjs",
6
6
  "main": "./lib/index.js",
package/src/index.ts CHANGED
@@ -887,6 +887,7 @@ import {
887
887
  PostMenuV3GlobalDiffRecoverResponse,
888
888
  GetMenuV3MenuworksQuery,
889
889
  GetMenuV3MenuworksResponse,
890
+ GetMenuV3MenuworksBusinessUnitsResponse,
890
891
  GetMenuV3UniversalItemsQuery,
891
892
  GetMenuV3UniversalItemsResponse,
892
893
  PutMenuV3UniversalItemsBody,
@@ -10238,6 +10239,24 @@ export class ServiceClient extends BaseServiceClient {
10238
10239
  );
10239
10240
  }
10240
10241
 
10242
+ /**
10243
+ * GET /menu/v3/menuworks/business_units
10244
+ *
10245
+ * @param options - additional request options
10246
+ */
10247
+ get_menu_v3_menuworks_business_units(
10248
+ options?: RequestOptions,
10249
+ ): ResponsePromise<GetMenuV3MenuworksBusinessUnitsResponse> {
10250
+ return this.request(
10251
+ 'menu',
10252
+ '/menu/v3/menuworks/business_units',
10253
+ 'GET',
10254
+ `/menu/v3/menuworks/business_units`,
10255
+ null,
10256
+ options,
10257
+ );
10258
+ }
10259
+
10241
10260
  /**
10242
10261
  * GET /menu/v3/universal-items
10243
10262
  *
@@ -294,6 +294,57 @@ export interface CentricDiscountChannelConfig {
294
294
  agilysys: boolean;
295
295
  }
296
296
 
297
+ export interface CentricItem {
298
+ id: string;
299
+ name: string;
300
+ }
301
+
302
+ export interface CentricCategory {
303
+ id: string;
304
+ name: string;
305
+ items: CentricItem[];
306
+ }
307
+
308
+ export interface CentricMenu {
309
+ id: string;
310
+ name: string;
311
+ categories: CentricCategory[];
312
+ }
313
+
314
+ export interface CentricStation {
315
+ id: string;
316
+ name: string;
317
+ menus?: CentricMenu[];
318
+ }
319
+
320
+ export interface CentricSite {
321
+ id: string;
322
+ name: string;
323
+ stations: CentricStation[];
324
+ }
325
+
326
+ export interface CentricMenuBrand {
327
+ id: string;
328
+ name: string;
329
+ menus: CentricMenu[];
330
+ }
331
+
332
+ export interface CentricItemLevelConfigDetails {
333
+ // minimum number of items to satisfy the bundle
334
+ minimum: number;
335
+ bundleGroupName?: string;
336
+ sites?: CentricSite[];
337
+ menuBrands?: CentricMenuBrand[];
338
+ }
339
+
340
+ export interface CentricItemLevelConfig {
341
+ // details of the item level config
342
+ details: CentricItemLevelConfigDetails[];
343
+ globalMenuGroupId?: string;
344
+ globalMenuGroupName?: string;
345
+ sectorName?: string;
346
+ }
347
+
297
348
  export interface CentricVoucherifyMetaDataDiscount {
298
349
  // The type of the voucherify discount
299
350
  type: 'AMOUNT_OFF' | 'PERCENT_OFF';
@@ -324,12 +375,20 @@ export interface PutDiscountVoucherifyRequestDiscount {
324
375
  channelConfig: CentricDiscountChannelConfig;
325
376
  // what the discount applies to
326
377
  appliesTo: 'order' | 'items';
378
+ // item level config of the discount
379
+ itemLevelConfig?: CentricItemLevelConfig;
327
380
  // Voucherify metadata
328
381
  meta?: CentricVoucherifyMetaDataDiscount;
329
382
  // discount schedule
330
383
  schedule?: CentricDiscountSchedule;
331
384
  // discount active status flag
332
385
  active?: boolean;
386
+ // type of the discount
387
+ type?: 'Total Order' | 'Single Items' | 'Bundle';
388
+ // number of sites associated with the discount
389
+ siteCount?: number;
390
+ // number of brands associated with the discount
391
+ brandCount?: number;
333
392
  is?: CentricDiscountIs;
334
393
  id?: string;
335
394
  }
@@ -367,6 +426,14 @@ export interface DiscountResponseDTO {
367
426
  channelConfig: CentricDiscountChannelConfig;
368
427
  // what the discount applies to
369
428
  appliesTo: 'order' | 'items';
429
+ // type of the discount
430
+ type: 'Total Order' | 'Single Items' | 'Bundle';
431
+ // item level config of the discount
432
+ itemLevelConfig?: CentricItemLevelConfig;
433
+ // number of sites associated with the discount
434
+ siteCount: number;
435
+ // number of brands associated with the discount
436
+ brandCount: number;
370
437
  // Voucherify metadata
371
438
  meta?: CentricVoucherifyMetaDataDiscount;
372
439
  id: string;
@@ -419,6 +486,14 @@ export interface PutDiscountVoucherifyPublishResponseDTO {
419
486
  channelConfig: CentricDiscountChannelConfig;
420
487
  // what the discount applies to
421
488
  appliesTo: 'order' | 'items';
489
+ // type of the discount
490
+ type: 'Total Order' | 'Single Items' | 'Bundle';
491
+ // item level config of the discount
492
+ itemLevelConfig?: CentricItemLevelConfig;
493
+ // number of sites associated with the discount
494
+ siteCount: number;
495
+ // number of brands associated with the discount
496
+ brandCount: number;
422
497
  // Voucherify metadata
423
498
  meta?: CentricDiscountMeta;
424
499
  // List of sites where discount is published
@@ -447,6 +522,14 @@ export interface DiscountDTO {
447
522
  channelConfig: CentricDiscountChannelConfig;
448
523
  // what the discount applies to
449
524
  appliesTo: 'order' | 'items';
525
+ // type of the discount
526
+ type: 'Total Order' | 'Single Items' | 'Bundle';
527
+ // item level config of the discount
528
+ itemLevelConfig?: CentricItemLevelConfig;
529
+ // number of sites associated with the discount
530
+ siteCount: number;
531
+ // number of brands associated with the discount
532
+ brandCount: number;
450
533
  id: string;
451
534
  createdAt: string;
452
535
  updatedAt: string;
@@ -495,6 +578,14 @@ export interface PostDiscountActiveResponseDTO {
495
578
  channelConfig: CentricDiscountChannelConfig;
496
579
  // what the discount applies to
497
580
  appliesTo: 'order' | 'items';
581
+ // type of the discount
582
+ type: 'Total Order' | 'Single Items' | 'Bundle';
583
+ // item level config of the discount
584
+ itemLevelConfig?: CentricItemLevelConfig;
585
+ // number of sites associated with the discount
586
+ siteCount: number;
587
+ // number of brands associated with the discount
588
+ brandCount: number;
498
589
  id: string;
499
590
  createdAt: string;
500
591
  updatedAt: string;
@@ -516,6 +607,14 @@ export interface GetDiscountsDiscountResponseDTO {
516
607
  channelConfig: CentricDiscountChannelConfig;
517
608
  // what the discount applies to
518
609
  appliesTo: 'order' | 'items';
610
+ // type of the discount
611
+ type: 'Total Order' | 'Single Items' | 'Bundle';
612
+ // item level config of the discount
613
+ itemLevelConfig?: CentricItemLevelConfig;
614
+ // number of sites associated with the discount
615
+ siteCount: number;
616
+ // number of brands associated with the discount
617
+ brandCount: number;
519
618
  sites: string[];
520
619
  brands: string[];
521
620
  id: string;
@@ -1905,6 +1905,13 @@ export interface DraftModifierEntityDTO {
1905
1905
  [index: string]: any;
1906
1906
  }
1907
1907
 
1908
+ export interface BusinessUnitDTO {
1909
+ id: string;
1910
+ name: string;
1911
+ sector_name: string;
1912
+ [index: string]: any;
1913
+ }
1914
+
1908
1915
  export interface UniversalItemWithoutIdDTO {
1909
1916
  barcode: string;
1910
1917
  name: string;
@@ -7557,6 +7564,16 @@ export interface GetMenuV3MenuworksRequest
7557
7564
  extends BaseRequest,
7558
7565
  RequestQuery<GetMenuV3MenuworksQuery> {}
7559
7566
 
7567
+ // GET /menu/v3/menuworks/business_units
7568
+
7569
+ export interface GetMenuV3MenuworksBusinessUnitsResponse {
7570
+ results: BusinessUnitDTO[];
7571
+ meta?: ListResponseMetadataDTO;
7572
+ [index: string]: any;
7573
+ }
7574
+
7575
+ export interface GetMenuV3MenuworksBusinessUnitsRequest extends BaseRequest {}
7576
+
7560
7577
  // GET /menu/v3/universal-items
7561
7578
 
7562
7579
  export interface GetMenuV3UniversalItemsQuery {