@compassdigital/sdk.typescript 4.198.0 → 4.200.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 (9) hide show
  1. package/lib/index.d.ts +10 -1
  2. package/lib/index.d.ts.map +1 -1
  3. package/lib/index.js +9 -0
  4. package/lib/index.js.map +1 -1
  5. package/lib/interface/menu.d.ts +47 -0
  6. package/lib/interface/menu.d.ts.map +1 -1
  7. package/package.json +1 -1
  8. package/src/index.ts +24 -0
  9. package/src/interface/menu.ts +56 -0
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@compassdigital/sdk.typescript",
3
- "version": "4.198.0",
3
+ "version": "4.200.0",
4
4
  "description": "Compass Digital Labs TypeScript SDK",
5
5
  "type": "commonjs",
6
6
  "main": "./lib/index.js",
package/src/index.ts CHANGED
@@ -603,6 +603,8 @@ import {
603
603
  PostMenuV3DraftBrandRecoverResponse,
604
604
  GetMenuV3DraftBrandAuditsQuery,
605
605
  GetMenuV3DraftBrandAuditsResponse,
606
+ GetMenuV3DraftBrandAuditsUsersQuery,
607
+ GetMenuV3DraftBrandAuditsUsersResponse,
606
608
  GetMenuV3DraftBrandMenusQuery,
607
609
  GetMenuV3DraftBrandMenusResponse,
608
610
  GetMenuV3DraftBrandModifiersQuery,
@@ -6670,6 +6672,28 @@ export class ServiceClient extends BaseServiceClient {
6670
6672
  );
6671
6673
  }
6672
6674
 
6675
+ /**
6676
+ * GET /menu/v3/draft/brand/{id}/audits/users
6677
+ *
6678
+ * @param id
6679
+ * @param options - additional request options
6680
+ */
6681
+ get_menu_v3_draft_brand_audits_users(
6682
+ id: string,
6683
+ options?: {
6684
+ query?: GetMenuV3DraftBrandAuditsUsersQuery;
6685
+ } & RequestOptions,
6686
+ ): ResponsePromise<GetMenuV3DraftBrandAuditsUsersResponse> {
6687
+ return this.request(
6688
+ 'menu',
6689
+ '/menu/v3/draft/brand/{id}/audits/users',
6690
+ 'GET',
6691
+ `/menu/v3/draft/brand/${id}/audits/users`,
6692
+ null,
6693
+ options,
6694
+ );
6695
+ }
6696
+
6673
6697
  /**
6674
6698
  * GET /menu/v3/draft/brand/{id}/menus
6675
6699
  *
package/src/interface/menu.ts CHANGED
@@ -728,6 +728,7 @@ export interface DraftItemDTO {
728
728
  name?: string;
729
729
  name_on_receipt?: string;
730
730
  name_on_kds?: string;
731
+ name_on_pos?: string;
731
732
  label?: string;
732
733
  description?: string;
733
734
  reporting?: Record<string, any>;
@@ -852,6 +853,7 @@ export interface DraftModifierDTO {
852
853
  name?: string;
853
854
  name_on_receipt?: string;
854
855
  name_on_kds?: string;
856
+ name_on_pos?: string;
855
857
  label?: string;
856
858
  description?: string;
857
859
  price?: number;
@@ -1290,6 +1292,7 @@ export interface PublishedItemDTO {
1290
1292
  name?: string;
1291
1293
  name_on_receipt?: string;
1292
1294
  name_on_kds?: string;
1295
+ name_on_pos?: string;
1293
1296
  label?: string;
1294
1297
  description?: string;
1295
1298
  price?: number;
@@ -1378,6 +1381,7 @@ export interface PublishedModifierDTO {
1378
1381
  name?: string;
1379
1382
  name_on_receipt?: string;
1380
1383
  name_on_kds?: string;
1384
+ name_on_pos?: string;
1381
1385
  label?: string;
1382
1386
  description?: string;
1383
1387
  price?: number;
@@ -1658,6 +1662,7 @@ export interface DraftItemEntityDTO {
1658
1662
  name: string;
1659
1663
  name_on_receipt?: string;
1660
1664
  name_on_kds?: string;
1665
+ name_on_pos?: string;
1661
1666
  label?: string;
1662
1667
  description?: string;
1663
1668
  reporting: ReportingMetadataDTO;
@@ -1710,6 +1715,7 @@ export interface DraftModifierEntityDTO {
1710
1715
  name: string;
1711
1716
  name_on_receipt?: string;
1712
1717
  name_on_kds?: string;
1718
+ name_on_pos?: string;
1713
1719
  label?: string;
1714
1720
  description?: string;
1715
1721
  price: number;
@@ -3373,6 +3379,28 @@ export interface GetMenuV3DraftBrandAuditsRequest
3373
3379
  RequestQuery<GetMenuV3DraftBrandAuditsQuery>,
3374
3380
  GetMenuV3DraftBrandAuditsPath {}
3375
3381
 
3382
+ // GET /menu/v3/draft/brand/{id}/audits/users
3383
+
3384
+ export interface GetMenuV3DraftBrandAuditsUsersPath {
3385
+ id: string;
3386
+ }
3387
+
3388
+ export interface GetMenuV3DraftBrandAuditsUsersQuery {
3389
+ date_from?: string;
3390
+ date_to?: string;
3391
+ // Graphql query string
3392
+ _query?: string;
3393
+ }
3394
+
3395
+ export interface GetMenuV3DraftBrandAuditsUsersResponse {
3396
+ users?: string[];
3397
+ }
3398
+
3399
+ export interface GetMenuV3DraftBrandAuditsUsersRequest
3400
+ extends BaseRequest,
3401
+ RequestQuery<GetMenuV3DraftBrandAuditsUsersQuery>,
3402
+ GetMenuV3DraftBrandAuditsUsersPath {}
3403
+
3376
3404
  // GET /menu/v3/draft/brand/{id}/menus
3377
3405
 
3378
3406
  export interface GetMenuV3DraftBrandMenusPath {
@@ -5265,6 +5293,7 @@ export interface PostMenuV3DraftItemBody {
5265
5293
  name: string;
5266
5294
  name_on_receipt?: string;
5267
5295
  name_on_kds?: string;
5296
+ name_on_pos?: string;
5268
5297
  label?: string;
5269
5298
  description?: string;
5270
5299
  reporting: ReportingMetadataDTO;
@@ -5345,6 +5374,7 @@ export interface PatchMenuV3DraftItemBody {
5345
5374
  name?: string;
5346
5375
  name_on_receipt?: string;
5347
5376
  name_on_kds?: string;
5377
+ name_on_pos?: string;
5348
5378
  label?: string;
5349
5379
  description?: string;
5350
5380
  reporting?: ReportingMetadataDTO;
@@ -5464,6 +5494,7 @@ export type PostMenuV3DraftItemsBody = {
5464
5494
  name: string;
5465
5495
  name_on_receipt?: string;
5466
5496
  name_on_kds?: string;
5497
+ name_on_pos?: string;
5467
5498
  label?: string;
5468
5499
  description?: string;
5469
5500
  reporting: ReportingMetadataDTO;
@@ -5574,6 +5605,7 @@ export interface PatchMenuV3DraftItemsBulkUpdateBody {
5574
5605
  name?: string;
5575
5606
  name_on_receipt?: string;
5576
5607
  name_on_kds?: string;
5608
+ name_on_pos?: string;
5577
5609
  label?: string;
5578
5610
  description?: string;
5579
5611
  reporting?: ReportingMetadataDTO;
@@ -6713,6 +6745,7 @@ export interface PostMenuV3DraftModifierBody {
6713
6745
  name: string;
6714
6746
  name_on_receipt?: string;
6715
6747
  name_on_kds?: string;
6748
+ name_on_pos?: string;
6716
6749
  label?: string;
6717
6750
  description?: string;
6718
6751
  price: number;
@@ -6789,6 +6822,7 @@ export interface PatchMenuV3DraftModifierBody {
6789
6822
  name?: string;
6790
6823
  name_on_receipt?: string;
6791
6824
  name_on_kds?: string;
6825
+ name_on_pos?: string;
6792
6826
  label?: string;
6793
6827
  description?: string;
6794
6828
  price?: number;
@@ -6904,6 +6938,7 @@ export type PostMenuV3DraftModifiersBody = {
6904
6938
  name: string;
6905
6939
  name_on_receipt?: string;
6906
6940
  name_on_kds?: string;
6941
+ name_on_pos?: string;
6907
6942
  label?: string;
6908
6943
  description?: string;
6909
6944
  price: number;
@@ -7010,6 +7045,7 @@ export interface PatchMenuV3DraftModifiersBulkUpdateBody {
7010
7045
  name?: string;
7011
7046
  name_on_receipt?: string;
7012
7047
  name_on_kds?: string;
7048
+ name_on_pos?: string;
7013
7049
  label?: string;
7014
7050
  description?: string;
7015
7051
  price?: number;
@@ -8420,6 +8456,7 @@ export interface PostMenuV4ItemBody {
8420
8456
  name: string;
8421
8457
  name_on_receipt?: string;
8422
8458
  name_on_kds?: string;
8459
+ name_on_pos?: string;
8423
8460
  label?: string;
8424
8461
  description?: string;
8425
8462
  reporting: ReportingMetadataDTO;
@@ -8470,6 +8507,7 @@ export interface PostMenuV4ItemResponse {
8470
8507
  name: string;
8471
8508
  name_on_receipt?: string;
8472
8509
  name_on_kds?: string;
8510
+ name_on_pos?: string;
8473
8511
  label?: string;
8474
8512
  description?: string;
8475
8513
  reporting: ReportingMetadataDTO;
@@ -8522,6 +8560,7 @@ export type PostMenuV4ItemsBulkCreateBody = {
8522
8560
  name: string;
8523
8561
  name_on_receipt?: string;
8524
8562
  name_on_kds?: string;
8563
+ name_on_pos?: string;
8525
8564
  label?: string;
8526
8565
  description?: string;
8527
8566
  reporting: ReportingMetadataDTO;
@@ -8593,6 +8632,7 @@ export interface GetMenuV4ItemResponse {
8593
8632
  name: string;
8594
8633
  name_on_receipt?: string;
8595
8634
  name_on_kds?: string;
8635
+ name_on_pos?: string;
8596
8636
  label?: string;
8597
8637
  description?: string;
8598
8638
  reporting: ReportingMetadataDTO;
@@ -8651,6 +8691,7 @@ export interface PatchMenuV4ItemBody {
8651
8691
  name?: string;
8652
8692
  name_on_receipt?: string;
8653
8693
  name_on_kds?: string;
8694
+ name_on_pos?: string;
8654
8695
  label?: string;
8655
8696
  description?: string;
8656
8697
  reporting?: ReportingMetadataDTO;
@@ -8700,6 +8741,7 @@ export interface PatchMenuV4ItemResponse {
8700
8741
  name: string;
8701
8742
  name_on_receipt?: string;
8702
8743
  name_on_kds?: string;
8744
+ name_on_pos?: string;
8703
8745
  label?: string;
8704
8746
  description?: string;
8705
8747
  reporting: ReportingMetadataDTO;
@@ -8760,6 +8802,7 @@ export interface DeleteMenuV4ItemResponse {
8760
8802
  name: string;
8761
8803
  name_on_receipt?: string;
8762
8804
  name_on_kds?: string;
8805
+ name_on_pos?: string;
8763
8806
  label?: string;
8764
8807
  description?: string;
8765
8808
  reporting: ReportingMetadataDTO;
@@ -8812,6 +8855,7 @@ export interface PatchMenuV4ItemsBulkUpdateBody {
8812
8855
  name?: string;
8813
8856
  name_on_receipt?: string;
8814
8857
  name_on_kds?: string;
8858
+ name_on_pos?: string;
8815
8859
  label?: string;
8816
8860
  description?: string;
8817
8861
  reporting?: ReportingMetadataDTO;
@@ -8871,6 +8915,7 @@ export interface PatchMenuV4ItemsBulkPriceUpdateBody {
8871
8915
  name?: string;
8872
8916
  name_on_receipt?: string;
8873
8917
  name_on_kds?: string;
8918
+ name_on_pos?: string;
8874
8919
  label?: string;
8875
8920
  description?: string;
8876
8921
  reporting?: ReportingMetadataDTO;
@@ -8931,6 +8976,7 @@ export interface PostMenuV4ItemDuplicateBody {
8931
8976
  name?: string;
8932
8977
  name_on_receipt?: string;
8933
8978
  name_on_kds?: string;
8979
+ name_on_pos?: string;
8934
8980
  label?: string;
8935
8981
  description?: string;
8936
8982
  reporting?: ReportingMetadataDTO;
@@ -8980,6 +9026,7 @@ export interface PostMenuV4ItemDuplicateResponse {
8980
9026
  name: string;
8981
9027
  name_on_receipt?: string;
8982
9028
  name_on_kds?: string;
9029
+ name_on_pos?: string;
8983
9030
  label?: string;
8984
9031
  description?: string;
8985
9032
  reporting: ReportingMetadataDTO;
@@ -9119,6 +9166,7 @@ export interface PostMenuV4ModifierBody {
9119
9166
  name: string;
9120
9167
  name_on_receipt?: string;
9121
9168
  name_on_kds?: string;
9169
+ name_on_pos?: string;
9122
9170
  label?: string;
9123
9171
  description?: string;
9124
9172
  price: number;
@@ -9164,6 +9212,7 @@ export interface PostMenuV4ModifierResponse {
9164
9212
  name: string;
9165
9213
  name_on_receipt?: string;
9166
9214
  name_on_kds?: string;
9215
+ name_on_pos?: string;
9167
9216
  label?: string;
9168
9217
  description?: string;
9169
9218
  price: number;
@@ -9226,6 +9275,7 @@ export interface GetMenuV4ModifierResponse {
9226
9275
  name: string;
9227
9276
  name_on_receipt?: string;
9228
9277
  name_on_kds?: string;
9278
+ name_on_pos?: string;
9229
9279
  label?: string;
9230
9280
  description?: string;
9231
9281
  price: number;
@@ -9279,6 +9329,7 @@ export interface PatchMenuV4ModifierBody {
9279
9329
  name?: string;
9280
9330
  name_on_receipt?: string;
9281
9331
  name_on_kds?: string;
9332
+ name_on_pos?: string;
9282
9333
  label?: string;
9283
9334
  description?: string;
9284
9335
  price?: number;
@@ -9324,6 +9375,7 @@ export interface PatchMenuV4ModifierResponse {
9324
9375
  name: string;
9325
9376
  name_on_receipt?: string;
9326
9377
  name_on_kds?: string;
9378
+ name_on_pos?: string;
9327
9379
  label?: string;
9328
9380
  description?: string;
9329
9381
  price: number;
@@ -9380,6 +9432,7 @@ export interface DeleteMenuV4ModifierResponse {
9380
9432
  name: string;
9381
9433
  name_on_receipt?: string;
9382
9434
  name_on_kds?: string;
9435
+ name_on_pos?: string;
9383
9436
  label?: string;
9384
9437
  description?: string;
9385
9438
  price: number;
@@ -9430,6 +9483,7 @@ export interface PostMenuV4ModifierDuplicateBody {
9430
9483
  name?: string;
9431
9484
  name_on_receipt?: string;
9432
9485
  name_on_kds?: string;
9486
+ name_on_pos?: string;
9433
9487
  label?: string;
9434
9488
  description?: string;
9435
9489
  price?: number;
@@ -9475,6 +9529,7 @@ export interface PostMenuV4ModifierDuplicateResponse {
9475
9529
  name: string;
9476
9530
  name_on_receipt?: string;
9477
9531
  name_on_kds?: string;
9532
+ name_on_pos?: string;
9478
9533
  label?: string;
9479
9534
  description?: string;
9480
9535
  price: number;
@@ -9527,6 +9582,7 @@ export interface PatchMenuV4ModifiersBulkUpdateBody {
9527
9582
  name?: string;
9528
9583
  name_on_receipt?: string;
9529
9584
  name_on_kds?: string;
9585
+ name_on_pos?: string;
9530
9586
  label?: string;
9531
9587
  description?: string;
9532
9588
  price?: number;