@compassdigital/sdk.typescript 4.22.0 → 4.23.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.
@@ -1073,6 +1073,24 @@ export interface PostLocationBrandRequest extends BaseRequest {
1073
1073
  body: PostLocationBrandBody;
1074
1074
  }
1075
1075
 
1076
+ // PATCH /location/brand/bulk - Update multiple brands
1077
+
1078
+ export interface PatchLocationBrandBulkBody {
1079
+ brands: Brands;
1080
+ }
1081
+
1082
+ export interface PatchLocationBrandBulkResponse {
1083
+ message?: string;
1084
+ // List of updated brands
1085
+ updated_brands?: Brand[];
1086
+ // List of brands that failed to update
1087
+ failed_brand_updates?: Brand[];
1088
+ }
1089
+
1090
+ export interface PatchLocationBrandBulkRequest extends BaseRequest {
1091
+ body: PatchLocationBrandBulkBody;
1092
+ }
1093
+
1076
1094
  // GET /location/brand/{id} - Get location brand
1077
1095
 
1078
1096
  export interface GetLocationBrandPath {
@@ -588,6 +588,7 @@ export interface DraftItemDTO {
588
588
  brand_id?: string;
589
589
  line_route?: FilterFieldDTO;
590
590
  posid_segment?: FilterFieldDTO;
591
+ menu_works?: Record<string, any>;
591
592
  applied_diff_snapshot?: FilterFieldDTO;
592
593
  brand?: Record<string, any>;
593
594
  categories?: Record<string, any>[];
@@ -632,6 +633,7 @@ export interface DraftModifierGroupDTO {
632
633
  is_active?: boolean;
633
634
  limit?: number;
634
635
  brand_id?: string;
636
+ type?: "normal" | "limit_enabled" | "sizing_enabled";
635
637
  applied_diff_snapshot?: FilterFieldDTO;
636
638
  brand?: Record<string, any>;
637
639
  changes?: ModifierGroupChangeDTO[];
@@ -677,6 +679,7 @@ export interface DraftModifierDTO {
677
679
  posid_segment?: FilterFieldDTO;
678
680
  brand_id?: string;
679
681
  sizing?: FilterFieldDTO[];
682
+ menu_works?: MenuWorksDTO;
680
683
  applied_diff_snapshot?: FilterFieldDTO;
681
684
  brand?: Record<string, any>;
682
685
  changes?: ModifierChangeDTO[];
@@ -723,6 +726,17 @@ export interface FileAttachmentsDTO {
723
726
  [index: string]: any;
724
727
  }
725
728
 
729
+ export interface MenuWorksDTO {
730
+ MRN?: FilterFieldDTO;
731
+ unit_id?: FilterFieldDTO;
732
+ GTIN?: FilterFieldDTO;
733
+ cost?: number;
734
+ ingredients?: FilterFieldDTO[];
735
+ smart_tags?: FilterFieldDTO[];
736
+ id?: Record<string, any>;
737
+ [index: string]: any;
738
+ }
739
+
726
740
  export interface ModifierGroupToModifierRelationshipChangeDTO {
727
741
  id?: string;
728
742
  insert?: FilterFieldDTO;
@@ -853,6 +867,7 @@ export interface DraftModifierDraftModifierDTO {
853
867
  reporting?: ReportingMetadataDTO;
854
868
  weight?: WeightDTO;
855
869
  attachments?: FileAttachmentsDTO;
870
+ menu_works?: MenuWorksDTO;
856
871
  permissions?: FilterFieldDTO;
857
872
  [index: string]: any;
858
873
  }
@@ -867,6 +882,7 @@ export interface DraftModifierGroupDraftModifierGroupDTO {
867
882
  is_active?: FilterFieldDTO;
868
883
  limit?: FilterFieldDTO;
869
884
  brand_id?: FilterFieldDTO;
885
+ type?: FilterFieldDTO;
870
886
  id?: FilterFieldDTO;
871
887
  version?: FilterFieldDTO;
872
888
  created_at?: FilterFieldDTO;
@@ -914,6 +930,7 @@ export interface DraftItemDraftItemDTO {
914
930
  reporting?: ReportingMetadataDTO;
915
931
  attachments?: FileAttachmentsDTO;
916
932
  weight?: WeightDTO;
933
+ menu_works?: MenuWorksDTO;
917
934
  permissions?: FilterFieldDTO;
918
935
  [index: string]: any;
919
936
  }
@@ -1061,6 +1078,7 @@ export interface PublishedModifierGroupDTO {
1061
1078
  is_active?: boolean;
1062
1079
  limit?: number;
1063
1080
  brand_id?: string;
1081
+ type?: "normal" | "limit_enabled" | "sizing_enabled";
1064
1082
  permissions?: Record<string, any>;
1065
1083
  [index: string]: any;
1066
1084
  }
@@ -1265,6 +1283,7 @@ export interface DraftItemEntityDTO {
1265
1283
  brand_id: string;
1266
1284
  line_route?: string;
1267
1285
  posid_segment?: string;
1286
+ menu_works?: MenuWorksDTO;
1268
1287
  applied_diff_snapshot?: Record<string, any>;
1269
1288
  version?: number;
1270
1289
  brand?: DraftBrandDTO;
@@ -1305,6 +1324,7 @@ export interface PublishedItemPublishedItemDTO {
1305
1324
  reporting?: ReportingMetadataDTO;
1306
1325
  attachments?: FileAttachmentsDTO;
1307
1326
  weight?: WeightDTO;
1327
+ menu_works?: MenuWorksDTO;
1308
1328
  permissions?: FilterFieldDTO;
1309
1329
  [index: string]: any;
1310
1330
  }
@@ -1361,6 +1381,7 @@ export interface PublishedModifierGroupPublishedModifierGroupDTO {
1361
1381
  is_active?: FilterFieldDTO;
1362
1382
  limit?: FilterFieldDTO;
1363
1383
  brand_id?: FilterFieldDTO;
1384
+ type?: FilterFieldDTO;
1364
1385
  id?: FilterFieldDTO;
1365
1386
  version?: FilterFieldDTO;
1366
1387
  created_at?: FilterFieldDTO;
@@ -1439,6 +1460,7 @@ export interface DraftModifierEntityDTO {
1439
1460
  posid_segment?: string;
1440
1461
  brand_id: string;
1441
1462
  sizing?: Record<string, any>[];
1463
+ menu_works?: MenuWorksDTO;
1442
1464
  applied_diff_snapshot?: Record<string, any>;
1443
1465
  version?: number;
1444
1466
  brand?: DraftBrandDTO;
@@ -1475,6 +1497,7 @@ export interface PublishedModifierPublishedModifierDTO {
1475
1497
  reporting?: ReportingMetadataDTO;
1476
1498
  weight?: WeightDTO;
1477
1499
  attachments?: FileAttachmentsDTO;
1500
+ menu_works?: MenuWorksDTO;
1478
1501
  permissions?: FilterFieldDTO;
1479
1502
  [index: string]: any;
1480
1503
  }
@@ -3523,55 +3546,6 @@ export interface GetMenuV3BrandItemsRequest
3523
3546
  RequestQuery<GetMenuV3BrandItemsQuery>,
3524
3547
  GetMenuV3BrandItemsPath {}
3525
3548
 
3526
- // POST /menu/v3/brand/{id}/local
3527
-
3528
- export interface PostMenuV3BrandLocalPath {
3529
- id: string;
3530
- }
3531
-
3532
- export interface PostMenuV3BrandLocalQuery {
3533
- nocache?: boolean;
3534
- }
3535
-
3536
- export interface PostMenuV3BrandLocalResponse {
3537
- parent?: DraftBrandDTO;
3538
- children?: DraftBrandDTO[];
3539
- menus?: DraftMenuDTO[];
3540
- categories?: DraftCategoryDTO[];
3541
- category_to_item_relationships?: DraftCategoryToItemRelationshipDTO[];
3542
- items?: DraftItemDTO[];
3543
- item_to_modifier_group_relationships?: DraftItemToModifierGroupRelationshipDTO[];
3544
- modifier_groups?: DraftModifierGroupDTO[];
3545
- modifier_group_to_modifier_relationships?: DraftModifierGroupToModifierRelationshipDTO[];
3546
- modifiers?: DraftModifierDTO[];
3547
- statuses?: BrandStatusDTO[];
3548
- id?: string;
3549
- created_at?: string;
3550
- updated_at?: string;
3551
- deleted_at?: string;
3552
- name: string;
3553
- description?: string;
3554
- is_active?: boolean;
3555
- type?: "global" | "local";
3556
- parent_id?: string;
3557
- local_menu_group_id?: string;
3558
- global_menu_group_id?: string;
3559
- posid_segment?: string;
3560
- version?: number;
3561
- changes?: BrandChangeDTO[];
3562
- local_menu_group?: LocalMenuGroupDTO;
3563
- global_menu_group?: GlobalMenuGroupDTO;
3564
- vendor_metadata?: VendorMetadataDTO[];
3565
- attachments?: FileAttachmentsDTO;
3566
- permissions?: Record<string, any>;
3567
- [index: string]: any;
3568
- }
3569
-
3570
- export interface PostMenuV3BrandLocalRequest
3571
- extends BaseRequest,
3572
- RequestQuery<PostMenuV3BrandLocalQuery>,
3573
- PostMenuV3BrandLocalPath {}
3574
-
3575
3549
  // POST /menu/v3/draft/menu
3576
3550
 
3577
3551
  export interface PostMenuV3DraftMenuBody {
@@ -4406,6 +4380,7 @@ export interface PostMenuV3DraftItemBody {
4406
4380
  brand_id: string;
4407
4381
  line_route?: string;
4408
4382
  posid_segment?: string;
4383
+ menu_works?: MenuWorksDTO;
4409
4384
  id?: Record<string, any>;
4410
4385
  applied_diff_snapshot?: Record<string, any>;
4411
4386
  brand?: DraftBrandDTO;
@@ -4472,6 +4447,7 @@ export interface PatchMenuV3DraftItemBody {
4472
4447
  brand_id?: string;
4473
4448
  line_route?: string;
4474
4449
  posid_segment?: string;
4450
+ menu_works?: MenuWorksDTO;
4475
4451
  applied_diff_snapshot?: Record<string, any>;
4476
4452
  version?: number;
4477
4453
  brand?: DraftBrandDTO;
@@ -4554,6 +4530,7 @@ export type PostMenuV3DraftItemsBody = {
4554
4530
  brand_id: string;
4555
4531
  line_route?: string;
4556
4532
  posid_segment?: string;
4533
+ menu_works?: MenuWorksDTO;
4557
4534
  id?: Record<string, any>;
4558
4535
  applied_diff_snapshot?: Record<string, any>;
4559
4536
  brand?: DraftBrandDTO;
@@ -4640,6 +4617,7 @@ export interface PatchMenuV3DraftItemsBulkUpdateBody {
4640
4617
  brand_id?: string;
4641
4618
  line_route?: string;
4642
4619
  posid_segment?: string;
4620
+ menu_works?: MenuWorksDTO;
4643
4621
  applied_diff_snapshot?: Record<string, any>;
4644
4622
  brand?: DraftBrandDTO;
4645
4623
  categories?: DraftCategoryToItemRelationshipDTO[];
@@ -5083,6 +5061,7 @@ export interface PostMenuV3DraftModifierGroupBody {
5083
5061
  is_active?: boolean;
5084
5062
  limit?: number;
5085
5063
  brand_id: string;
5064
+ type?: "normal" | "limit_enabled" | "sizing_enabled";
5086
5065
  id?: Record<string, any>;
5087
5066
  applied_diff_snapshot?: Record<string, any>;
5088
5067
  brand?: DraftBrandDTO;
@@ -5140,6 +5119,7 @@ export interface PatchMenuV3DraftModifierGroupBody {
5140
5119
  is_active?: boolean;
5141
5120
  limit?: number;
5142
5121
  brand_id?: string;
5122
+ type?: "normal" | "limit_enabled" | "sizing_enabled";
5143
5123
  applied_diff_snapshot?: Record<string, any>;
5144
5124
  version?: number;
5145
5125
  brand?: DraftBrandDTO;
@@ -5217,6 +5197,7 @@ export type PostMenuV3DraftModifierGroupsBody = {
5217
5197
  is_active?: boolean;
5218
5198
  limit?: number;
5219
5199
  brand_id: string;
5200
+ type?: "normal" | "limit_enabled" | "sizing_enabled";
5220
5201
  id?: Record<string, any>;
5221
5202
  applied_diff_snapshot?: Record<string, any>;
5222
5203
  brand?: DraftBrandDTO;
@@ -5279,6 +5260,7 @@ export interface PostMenuV3DraftModifierGroupDuplicateResponse {
5279
5260
  is_active?: boolean;
5280
5261
  limit?: number;
5281
5262
  brand_id: string;
5263
+ type?: "normal" | "limit_enabled" | "sizing_enabled";
5282
5264
  applied_diff_snapshot?: Record<string, any>;
5283
5265
  version?: number;
5284
5266
  brand?: DraftBrandDTO;
@@ -5651,6 +5633,7 @@ export interface PostMenuV3DraftModifierBody {
5651
5633
  posid_segment?: string;
5652
5634
  brand_id: string;
5653
5635
  sizing?: Record<string, any>[];
5636
+ menu_works?: MenuWorksDTO;
5654
5637
  id?: Record<string, any>;
5655
5638
  applied_diff_snapshot?: Record<string, any>;
5656
5639
  brand?: DraftBrandDTO;
@@ -5714,6 +5697,7 @@ export interface PatchMenuV3DraftModifierBody {
5714
5697
  posid_segment?: string;
5715
5698
  brand_id?: string;
5716
5699
  sizing?: Record<string, any>[];
5700
+ menu_works?: MenuWorksDTO;
5717
5701
  applied_diff_snapshot?: Record<string, any>;
5718
5702
  version?: number;
5719
5703
  brand?: DraftBrandDTO;
@@ -5795,6 +5779,7 @@ export type PostMenuV3DraftModifiersBody = {
5795
5779
  posid_segment?: string;
5796
5780
  brand_id: string;
5797
5781
  sizing?: Record<string, any>[];
5782
+ menu_works?: MenuWorksDTO;
5798
5783
  id?: Record<string, any>;
5799
5784
  applied_diff_snapshot?: Record<string, any>;
5800
5785
  brand?: DraftBrandDTO;
@@ -5857,6 +5842,7 @@ export interface PatchMenuV3DraftModifiersBulkUpdateBody {
5857
5842
  posid_segment?: string;
5858
5843
  brand_id?: string;
5859
5844
  sizing?: Record<string, any>[];
5845
+ menu_works?: MenuWorksDTO;
5860
5846
  applied_diff_snapshot?: Record<string, any>;
5861
5847
  brand?: DraftBrandDTO;
5862
5848
  changes?: ModifierChangeDTO[];
@@ -184,6 +184,23 @@ export interface HpcIframe {
184
184
  sessionKey?: string;
185
185
  }
186
186
 
187
+ export interface ApplePayMerchantSession {
188
+ merchant_session?: {
189
+ epochTimestamp?: number;
190
+ expiresAt?: number;
191
+ nonce?: string;
192
+ merchantIdentifier?: string;
193
+ merchantSessionIdentifier?: string;
194
+ operationalAnalyticsIdentifier?: string;
195
+ domainName?: string;
196
+ displayName?: string;
197
+ signature?: string;
198
+ retries?: number;
199
+ pspId?: string;
200
+ [index: string]: any;
201
+ };
202
+ }
203
+
187
204
  // POST /payment/{id}/transaction
188
205
 
189
206
  export interface PostPaymentTransactionPath {
@@ -515,3 +532,16 @@ export type PostPaymentConfigvalidateResponse = Success;
515
532
  export interface PostPaymentConfigvalidateRequest extends BaseRequest {
516
533
  body: PostPaymentConfigvalidateBody;
517
534
  }
535
+
536
+ // POST /payment/validatemerchant
537
+
538
+ export interface PostPaymentValidatemerchantBody {
539
+ validation_url: string;
540
+ display_name: string;
541
+ }
542
+
543
+ export type PostPaymentValidatemerchantResponse = ApplePayMerchantSession;
544
+
545
+ export interface PostPaymentValidatemerchantRequest extends BaseRequest {
546
+ body: PostPaymentValidatemerchantBody;
547
+ }
@@ -413,7 +413,7 @@ export type MonetaryValue = number;
413
413
 
414
414
  export type IntegerValue = number;
415
415
 
416
- export type Quantity = IntegerValue;
416
+ export type Quantity = number;
417
417
 
418
418
  export type PaymentType = string;
419
419