@compassdigital/sdk.typescript 4.6.0 → 4.7.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.
@@ -542,6 +542,7 @@ export interface DraftCategoryDTO {
542
542
  brand?: Record<string, any>;
543
543
  changes?: CategoryChangeDTO[];
544
544
  vendor_metadata?: VendorMetadataDTO[];
545
+ attachments?: Record<string, any>;
545
546
  permissions?: FilterFieldDTO;
546
547
  [index: string]: any;
547
548
  }
@@ -589,7 +590,7 @@ export interface DraftItemDTO {
589
590
  categories?: Record<string, any>[];
590
591
  changes?: ItemChangeDTO[];
591
592
  vendor_metadata?: VendorMetadataDTO[];
592
- attachments?: FileAttachmentsDTO;
593
+ attachments?: Record<string, any>;
593
594
  weight?: Record<string, any>;
594
595
  permissions?: FilterFieldDTO;
595
596
  [index: string]: any;
@@ -671,11 +672,13 @@ export interface DraftModifierDTO {
671
672
  reporting?: ReportingMetadataDTO;
672
673
  posid_segment?: FilterFieldDTO;
673
674
  brand_id?: string;
675
+ sizing?: FilterFieldDTO[];
674
676
  applied_diff_snapshot?: FilterFieldDTO;
675
677
  brand?: Record<string, any>;
676
678
  changes?: ModifierChangeDTO[];
677
679
  vendor_metadata?: VendorMetadataDTO[];
678
680
  weight?: WeightDTO;
681
+ attachments?: FileAttachmentsDTO;
679
682
  permissions?: FilterFieldDTO;
680
683
  [index: string]: any;
681
684
  }
@@ -710,6 +713,12 @@ export interface WeightDTO {
710
713
  [index: string]: any;
711
714
  }
712
715
 
716
+ export interface FileAttachmentsDTO {
717
+ thumbnail?: FilterFieldDTO;
718
+ id?: Record<string, any>;
719
+ [index: string]: any;
720
+ }
721
+
713
722
  export interface ModifierGroupToModifierRelationshipChangeDTO {
714
723
  id?: string;
715
724
  insert?: FilterFieldDTO;
@@ -750,12 +759,6 @@ export interface ItemChangeDTO {
750
759
  [index: string]: any;
751
760
  }
752
761
 
753
- export interface FileAttachmentsDTO {
754
- thumbnail?: FilterFieldDTO;
755
- id?: Record<string, any>;
756
- [index: string]: any;
757
- }
758
-
759
762
  export interface CategoryToItemRelationshipChangeDTO {
760
763
  id?: string;
761
764
  insert?: FilterFieldDTO;
@@ -830,6 +833,7 @@ export interface DraftModifierDraftModifierDTO {
830
833
  posid?: FilterFieldDTO;
831
834
  posid_segment?: FilterFieldDTO;
832
835
  brand_id?: FilterFieldDTO;
836
+ sizing?: FilterFieldDTO[];
833
837
  id?: FilterFieldDTO;
834
838
  version?: FilterFieldDTO;
835
839
  created_at?: FilterFieldDTO;
@@ -843,6 +847,7 @@ export interface DraftModifierDraftModifierDTO {
843
847
  vendor_metadata?: VendorMetadataDTO[];
844
848
  reporting?: ReportingMetadataDTO;
845
849
  weight?: WeightDTO;
850
+ attachments?: FileAttachmentsDTO;
846
851
  permissions?: FilterFieldDTO;
847
852
  [index: string]: any;
848
853
  }
@@ -1073,6 +1078,7 @@ export interface PublishedModifierDTO {
1073
1078
  posid?: string;
1074
1079
  posid_segment?: string;
1075
1080
  brand_id?: string;
1081
+ sizing?: Record<string, any>[];
1076
1082
  permissions?: Record<string, any>;
1077
1083
  [index: string]: any;
1078
1084
  }
@@ -1129,6 +1135,7 @@ export interface DraftCategoryDraftCategoryDTO {
1129
1135
  brand?: DraftBrandDTO;
1130
1136
  changes?: CategoryChangeDTO[];
1131
1137
  vendor_metadata?: VendorMetadataDTO[];
1138
+ attachments?: FileAttachmentsDTO;
1132
1139
  permissions?: FilterFieldDTO;
1133
1140
  [index: string]: any;
1134
1141
  }
@@ -1168,6 +1175,7 @@ export interface PublishedCategoryPublishedCategoryDTO {
1168
1175
  menu?: PublishedMenuDTO;
1169
1176
  items?: PublishedCategoryToItemRelationshipDTO[];
1170
1177
  brand?: PublishedBrandDTO;
1178
+ attachments?: FileAttachmentsDTO;
1171
1179
  permissions?: FilterFieldDTO;
1172
1180
  [index: string]: any;
1173
1181
  }
@@ -1215,6 +1223,11 @@ export interface PublishedCategoryToItemRelationshipPublishedCategoryToItemRelat
1215
1223
  [index: string]: any;
1216
1224
  }
1217
1225
 
1226
+ export interface LineRouteSuggestion {
1227
+ line_route?: string;
1228
+ occurrences?: number;
1229
+ }
1230
+
1218
1231
  export interface DraftItemEntityDTO {
1219
1232
  parent?: DraftItemDTO;
1220
1233
  children?: DraftItemDTO[];
@@ -1408,12 +1421,14 @@ export interface DraftModifierEntityDTO {
1408
1421
  reporting: ReportingMetadataDTO;
1409
1422
  posid_segment?: string;
1410
1423
  brand_id: string;
1424
+ sizing?: Record<string, any>[];
1411
1425
  applied_diff_snapshot?: Record<string, any>;
1412
1426
  version?: number;
1413
1427
  brand?: DraftBrandDTO;
1414
1428
  changes?: ModifierChangeDTO[];
1415
1429
  vendor_metadata?: VendorMetadataDTO[];
1416
1430
  weight?: WeightDTO;
1431
+ attachments?: FileAttachmentsDTO;
1417
1432
  permissions?: Record<string, any>;
1418
1433
  [index: string]: any;
1419
1434
  }
@@ -1430,6 +1445,7 @@ export interface PublishedModifierPublishedModifierDTO {
1430
1445
  posid?: FilterFieldDTO;
1431
1446
  posid_segment?: FilterFieldDTO;
1432
1447
  brand_id?: FilterFieldDTO;
1448
+ sizing?: FilterFieldDTO[];
1433
1449
  id?: FilterFieldDTO;
1434
1450
  version?: FilterFieldDTO;
1435
1451
  created_at?: FilterFieldDTO;
@@ -1441,6 +1457,7 @@ export interface PublishedModifierPublishedModifierDTO {
1441
1457
  brand?: PublishedBrandDTO;
1442
1458
  reporting?: ReportingMetadataDTO;
1443
1459
  weight?: WeightDTO;
1460
+ attachments?: FileAttachmentsDTO;
1444
1461
  permissions?: FilterFieldDTO;
1445
1462
  [index: string]: any;
1446
1463
  }
@@ -3885,6 +3902,7 @@ export interface PostMenuV3DraftCategoryBody {
3885
3902
  brand?: DraftBrandDTO;
3886
3903
  changes?: CategoryChangeDTO[];
3887
3904
  vendor_metadata?: VendorMetadataDTO[];
3905
+ attachments?: FileAttachmentsDTO;
3888
3906
  permissions?: Record<string, any>;
3889
3907
  [index: string]: any;
3890
3908
  }
@@ -3941,6 +3959,7 @@ export interface PatchMenuV3DraftCategoryBody {
3941
3959
  brand?: DraftBrandDTO;
3942
3960
  changes?: CategoryChangeDTO[];
3943
3961
  vendor_metadata?: VendorMetadataDTO[];
3962
+ attachments?: FileAttachmentsDTO;
3944
3963
  permissions?: Record<string, any>;
3945
3964
  [index: string]: any;
3946
3965
  }
@@ -4002,6 +4021,7 @@ export type PostMenuV3DraftCategoriesBody = {
4002
4021
  brand?: DraftBrandDTO;
4003
4022
  changes?: CategoryChangeDTO[];
4004
4023
  vendor_metadata?: VendorMetadataDTO[];
4024
+ attachments?: FileAttachmentsDTO;
4005
4025
  permissions?: Record<string, any>;
4006
4026
  [index: string]: any;
4007
4027
  }[];
@@ -4016,6 +4036,26 @@ export interface PostMenuV3DraftCategoriesRequest extends BaseRequest {
4016
4036
  body: PostMenuV3DraftCategoriesBody;
4017
4037
  }
4018
4038
 
4039
+ // POST /menu/v3/draft/category/{id}/attachment/{name}
4040
+
4041
+ export interface PostMenuV3DraftCategoryAttachmentPath {
4042
+ id: string;
4043
+ name: "thumbnail";
4044
+ }
4045
+
4046
+ export interface PostMenuV3DraftCategoryAttachmentQuery {
4047
+ "body.data"?: string;
4048
+ }
4049
+
4050
+ export interface PostMenuV3DraftCategoryAttachmentResponse {
4051
+ status?: string;
4052
+ }
4053
+
4054
+ export interface PostMenuV3DraftCategoryAttachmentRequest
4055
+ extends BaseRequest,
4056
+ RequestQuery<PostMenuV3DraftCategoryAttachmentQuery>,
4057
+ PostMenuV3DraftCategoryAttachmentPath {}
4058
+
4019
4059
  // GET /menu/v3/category/{id}
4020
4060
 
4021
4061
  export interface GetMenuV3CategoryPath {
@@ -4525,6 +4565,27 @@ export interface GetMenuV3DraftItemsCountRequest
4525
4565
  extends BaseRequest,
4526
4566
  RequestQuery<GetMenuV3DraftItemsCountQuery> {}
4527
4567
 
4568
+ // GET /menu/v3/draft/item/{id}/line-routes
4569
+
4570
+ export interface GetMenuV3DraftItemLineRoutesPath {
4571
+ id: string;
4572
+ }
4573
+
4574
+ export interface GetMenuV3DraftItemLineRoutesQuery {
4575
+ search?: string;
4576
+ // Graphql query string
4577
+ _query?: string;
4578
+ }
4579
+
4580
+ export interface GetMenuV3DraftItemLineRoutesResponse {
4581
+ results?: LineRouteSuggestion[];
4582
+ }
4583
+
4584
+ export interface GetMenuV3DraftItemLineRoutesRequest
4585
+ extends BaseRequest,
4586
+ RequestQuery<GetMenuV3DraftItemLineRoutesQuery>,
4587
+ GetMenuV3DraftItemLineRoutesPath {}
4588
+
4528
4589
  // PATCH /menu/v3/draft/items/bulk-update
4529
4590
 
4530
4591
  export interface PatchMenuV3DraftItemsBulkUpdateBody {
@@ -4566,74 +4627,74 @@ export interface PatchMenuV3DraftItemsBulkUpdateRequest extends BaseRequest {
4566
4627
  body: PatchMenuV3DraftItemsBulkUpdateBody;
4567
4628
  }
4568
4629
 
4569
- // POST /menu/v3/item/{id}/attachment/{name}
4630
+ // POST /menu/v3/draft/item/{id}/attachment/{name}
4570
4631
 
4571
- export interface PostMenuV3ItemAttachmentPath {
4632
+ export interface PostMenuV3DraftItemAttachmentPath {
4572
4633
  id: string;
4573
4634
  name: "thumbnail";
4574
4635
  }
4575
4636
 
4576
- export interface PostMenuV3ItemAttachmentQuery {
4637
+ export interface PostMenuV3DraftItemAttachmentQuery {
4577
4638
  "body.data"?: string;
4578
4639
  }
4579
4640
 
4580
- export interface PostMenuV3ItemAttachmentResponse {
4641
+ export interface PostMenuV3DraftItemAttachmentResponse {
4581
4642
  status?: string;
4582
4643
  }
4583
4644
 
4584
- export interface PostMenuV3ItemAttachmentRequest
4645
+ export interface PostMenuV3DraftItemAttachmentRequest
4585
4646
  extends BaseRequest,
4586
- RequestQuery<PostMenuV3ItemAttachmentQuery>,
4587
- PostMenuV3ItemAttachmentPath {}
4647
+ RequestQuery<PostMenuV3DraftItemAttachmentQuery>,
4648
+ PostMenuV3DraftItemAttachmentPath {}
4588
4649
 
4589
- // POST /menu/v3/items/validate
4650
+ // POST /menu/v3/draft/items/validate
4590
4651
 
4591
- export interface PostMenuV3ItemsValidateBody {
4652
+ export interface PostMenuV3DraftItemsValidateBody {
4592
4653
  brand_id: string;
4593
4654
  category_id?: string;
4594
4655
  data: string;
4595
4656
  [index: string]: any;
4596
4657
  }
4597
4658
 
4598
- export interface PostMenuV3ItemsValidateResponse {
4659
+ export interface PostMenuV3DraftItemsValidateResponse {
4599
4660
  s3_link?: string;
4600
4661
  }
4601
4662
 
4602
- export interface PostMenuV3ItemsValidateRequest extends BaseRequest {
4603
- body: PostMenuV3ItemsValidateBody;
4663
+ export interface PostMenuV3DraftItemsValidateRequest extends BaseRequest {
4664
+ body: PostMenuV3DraftItemsValidateBody;
4604
4665
  }
4605
4666
 
4606
- // POST /menu/v3/items/import
4667
+ // POST /menu/v3/draft/items/import
4607
4668
 
4608
- export interface PostMenuV3ItemsImportBody {
4669
+ export interface PostMenuV3DraftItemsImportBody {
4609
4670
  brand_id: string;
4610
4671
  category_id?: string;
4611
4672
  data: string;
4612
4673
  [index: string]: any;
4613
4674
  }
4614
4675
 
4615
- export interface PostMenuV3ItemsImportResponse {
4676
+ export interface PostMenuV3DraftItemsImportResponse {
4616
4677
  status?: string;
4617
4678
  }
4618
4679
 
4619
- export interface PostMenuV3ItemsImportRequest extends BaseRequest {
4620
- body: PostMenuV3ItemsImportBody;
4680
+ export interface PostMenuV3DraftItemsImportRequest extends BaseRequest {
4681
+ body: PostMenuV3DraftItemsImportBody;
4621
4682
  }
4622
4683
 
4623
- // POST /menu/v3/items/export
4684
+ // POST /menu/v3/draft/items/export
4624
4685
 
4625
- export interface PostMenuV3ItemsExportBody {
4686
+ export interface PostMenuV3DraftItemsExportBody {
4626
4687
  brand_id: string;
4627
4688
  category_id?: string;
4628
4689
  [index: string]: any;
4629
4690
  }
4630
4691
 
4631
- export interface PostMenuV3ItemsExportResponse {
4692
+ export interface PostMenuV3DraftItemsExportResponse {
4632
4693
  s3_link?: string;
4633
4694
  }
4634
4695
 
4635
- export interface PostMenuV3ItemsExportRequest extends BaseRequest {
4636
- body: PostMenuV3ItemsExportBody;
4696
+ export interface PostMenuV3DraftItemsExportRequest extends BaseRequest {
4697
+ body: PostMenuV3DraftItemsExportBody;
4637
4698
  }
4638
4699
 
4639
4700
  // GET /menu/v3/item/{id}
@@ -5552,12 +5613,14 @@ export interface PostMenuV3DraftModifierBody {
5552
5613
  reporting: ReportingMetadataDTO;
5553
5614
  posid_segment?: string;
5554
5615
  brand_id: string;
5616
+ sizing?: Record<string, any>[];
5555
5617
  id?: Record<string, any>;
5556
5618
  applied_diff_snapshot?: Record<string, any>;
5557
5619
  brand?: DraftBrandDTO;
5558
5620
  changes?: ModifierChangeDTO[];
5559
5621
  vendor_metadata?: VendorMetadataDTO[];
5560
5622
  weight?: WeightDTO;
5623
+ attachments?: FileAttachmentsDTO;
5561
5624
  permissions?: Record<string, any>;
5562
5625
  [index: string]: any;
5563
5626
  }
@@ -5613,12 +5676,14 @@ export interface PatchMenuV3DraftModifierBody {
5613
5676
  reporting?: ReportingMetadataDTO;
5614
5677
  posid_segment?: string;
5615
5678
  brand_id?: string;
5679
+ sizing?: Record<string, any>[];
5616
5680
  applied_diff_snapshot?: Record<string, any>;
5617
5681
  version?: number;
5618
5682
  brand?: DraftBrandDTO;
5619
5683
  changes?: ModifierChangeDTO[];
5620
5684
  vendor_metadata?: VendorMetadataDTO[];
5621
5685
  weight?: WeightDTO;
5686
+ attachments?: FileAttachmentsDTO;
5622
5687
  permissions?: Record<string, any>;
5623
5688
  [index: string]: any;
5624
5689
  }
@@ -5692,12 +5757,14 @@ export type PostMenuV3DraftModifiersBody = {
5692
5757
  reporting: ReportingMetadataDTO;
5693
5758
  posid_segment?: string;
5694
5759
  brand_id: string;
5760
+ sizing?: Record<string, any>[];
5695
5761
  id?: Record<string, any>;
5696
5762
  applied_diff_snapshot?: Record<string, any>;
5697
5763
  brand?: DraftBrandDTO;
5698
5764
  changes?: ModifierChangeDTO[];
5699
5765
  vendor_metadata?: VendorMetadataDTO[];
5700
5766
  weight?: WeightDTO;
5767
+ attachments?: FileAttachmentsDTO;
5701
5768
  permissions?: Record<string, any>;
5702
5769
  [index: string]: any;
5703
5770
  }[];
@@ -5752,11 +5819,13 @@ export interface PatchMenuV3DraftModifiersBulkUpdateBody {
5752
5819
  reporting?: ReportingMetadataDTO;
5753
5820
  posid_segment?: string;
5754
5821
  brand_id?: string;
5822
+ sizing?: Record<string, any>[];
5755
5823
  applied_diff_snapshot?: Record<string, any>;
5756
5824
  brand?: DraftBrandDTO;
5757
5825
  changes?: ModifierChangeDTO[];
5758
5826
  vendor_metadata?: VendorMetadataDTO[];
5759
5827
  weight?: WeightDTO;
5828
+ attachments?: FileAttachmentsDTO;
5760
5829
  permissions?: Record<string, any>;
5761
5830
  [index: string]: any;
5762
5831
  }
@@ -5769,6 +5838,26 @@ export interface PatchMenuV3DraftModifiersBulkUpdateRequest extends BaseRequest
5769
5838
  body: PatchMenuV3DraftModifiersBulkUpdateBody;
5770
5839
  }
5771
5840
 
5841
+ // POST /menu/v3/draft/modifiers/{id}/attachment/{name}
5842
+
5843
+ export interface PostMenuV3DraftModifiersAttachmentPath {
5844
+ id: string;
5845
+ name: "thumbnail";
5846
+ }
5847
+
5848
+ export interface PostMenuV3DraftModifiersAttachmentQuery {
5849
+ "body.data"?: string;
5850
+ }
5851
+
5852
+ export interface PostMenuV3DraftModifiersAttachmentResponse {
5853
+ status?: string;
5854
+ }
5855
+
5856
+ export interface PostMenuV3DraftModifiersAttachmentRequest
5857
+ extends BaseRequest,
5858
+ RequestQuery<PostMenuV3DraftModifiersAttachmentQuery>,
5859
+ PostMenuV3DraftModifiersAttachmentPath {}
5860
+
5772
5861
  // GET /menu/v3/modifier/{id}
5773
5862
 
5774
5863
  export interface GetMenuV3ModifierPath {