@compassdigital/sdk.typescript 4.798.0 → 4.800.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.
@@ -778,7 +778,7 @@ export interface CentricDiscountSchedule {
778
778
  endTime: string;
779
779
  }
780
780
 
781
- export interface PutDiscountVoucherifyRequestDiscount {
781
+ export interface PutCentricDiscountRequestDiscount {
782
782
  // name of the discount
783
783
  name: string;
784
784
  // Discount method configuration
@@ -788,7 +788,7 @@ export interface PutDiscountVoucherifyRequestDiscount {
788
788
  // item level config of the discount
789
789
  itemLevelConfig?: CentricDiscountItemLevelConfig;
790
790
  is?: CentricDiscountIs;
791
- // Voucherify metadata
791
+ // discount metadata
792
792
  meta?: CentricVoucherifyMetaDataDiscount;
793
793
  // discount schedule
794
794
  schedule?: CentricDiscountSchedule;
@@ -849,9 +849,9 @@ export interface DiscountBrand {
849
849
  meta: DiscountBrandMeta;
850
850
  }
851
851
 
852
- export interface PutDiscountVoucherifyRequestDTO {
852
+ export interface PutCentricDiscountRequestDTO {
853
853
  // Discount to update
854
- discount: PutDiscountVoucherifyRequestDiscount;
854
+ discount: PutCentricDiscountRequestDiscount;
855
855
  // List of sites with metadata
856
856
  sites?: DiscountSite[];
857
857
  // List of brands with metadata
@@ -886,7 +886,7 @@ export interface DiscountResponseDTO {
886
886
  type: 'Total Order' | 'Single Items' | 'Bundle';
887
887
  // item level config of the discount
888
888
  itemLevelConfig?: CentricDiscountItemLevelConfig;
889
- // Voucherify metadata
889
+ // discount metadata
890
890
  meta?: CentricVoucherifyMetaDataDiscount;
891
891
  id: string;
892
892
  createdAt: string;
@@ -895,7 +895,7 @@ export interface DiscountResponseDTO {
895
895
  schedule?: Record<string, any>;
896
896
  }
897
897
 
898
- export interface PutDiscountVoucherifyResponseDTO {
898
+ export interface PutCentricDiscountResponseDTO {
899
899
  // Discount details
900
900
  discount: DiscountResponseDTO;
901
901
  // List of sites with metadata
@@ -919,6 +919,73 @@ export interface CentricDiscountMeta {
919
919
  provider: CentricMetaProvider;
920
920
  }
921
921
 
922
+ export interface PutCentricDiscountPublishResponseDTO {
923
+ // user is of discount creator
924
+ createdBy: string;
925
+ // last user who updated the discount
926
+ updatedBy: string;
927
+ // name of the discount
928
+ name: string;
929
+ // status of the discount
930
+ status: CentricDiscountStatus;
931
+ // Discount method configuration
932
+ method: CentricDiscountMethod;
933
+ // channel config of the discount
934
+ channelConfig: CentricDiscountChannelConfig;
935
+ // type of the discount
936
+ type: 'Total Order' | 'Single Items' | 'Bundle';
937
+ // item level config of the discount
938
+ itemLevelConfig?: CentricDiscountItemLevelConfig;
939
+ // discount metadata
940
+ meta?: CentricDiscountMeta;
941
+ // List of sites where discount is published
942
+ sites?: CentricDiscountEntityBase[];
943
+ id: string;
944
+ createdAt: string;
945
+ updatedAt: string;
946
+ is?: CentricDiscountIs;
947
+ schedule?: Record<string, any>;
948
+ }
949
+
950
+ export interface PutDiscountVoucherifyRequestDiscount {
951
+ // name of the discount
952
+ name: string;
953
+ // Discount method configuration
954
+ method: CentricDiscountMethod;
955
+ // channel config of the discount
956
+ channelConfig: CentricDiscountChannelConfig;
957
+ // item level config of the discount
958
+ itemLevelConfig?: CentricDiscountItemLevelConfig;
959
+ is?: CentricDiscountIs;
960
+ // discount metadata
961
+ meta?: CentricVoucherifyMetaDataDiscount;
962
+ // discount schedule
963
+ schedule?: CentricDiscountSchedule;
964
+ id?: string;
965
+ // discount active status flag
966
+ active?: boolean;
967
+ // type of the discount
968
+ type?: 'Total Order' | 'Single Items' | 'Bundle';
969
+ }
970
+
971
+ export interface PutDiscountVoucherifyRequestDTO {
972
+ // Discount to update
973
+ discount: PutDiscountVoucherifyRequestDiscount;
974
+ // List of sites with metadata
975
+ sites?: DiscountSite[];
976
+ // List of brands with metadata
977
+ brands?: DiscountBrand[];
978
+ }
979
+
980
+ export interface PutDiscountVoucherifyResponseDTO {
981
+ // Discount details
982
+ discount: DiscountResponseDTO;
983
+ // List of sites with metadata
984
+ sites: DiscountSite[];
985
+ // List of brands with metadata
986
+ brands: DiscountBrand[];
987
+ }
988
+
922
989
  export interface PutDiscountVoucherifyPublishResponseDTO {
923
990
  // user is of discount creator
924
991
  createdBy: string;
@@ -947,6 +1014,10 @@ export interface PutDiscountVoucherifyPublishResponseDTO {
947
1014
  schedule?: Record<string, any>;
948
1015
  }
949
1016
 
1017
+ export interface DeleteCentricDiscountResponseDTO {
1018
+ success: boolean;
1019
+ }
1020
+
950
1021
  export interface DeleteDiscountsVoucherifyResponseDTO {
951
1022
  success: boolean;
952
1023
  }
@@ -1146,6 +1217,36 @@ export interface DeleteBusinessUnitResponse {
1146
1217
  success: boolean;
1147
1218
  }
1148
1219
 
1220
+ export interface BusinessUnitCustomTimeslotDto {
1221
+ // Window start, HH:mm on a 24 hour clock
1222
+ start_time: string;
1223
+ // Window end, HH:mm on a 24 hour clock
1224
+ end_time: string;
1225
+ // Delivery destination names served during this window
1226
+ destinations: string[];
1227
+ }
1228
+
1229
+ export interface PutBusinessUnitDropOffRequest {
1230
+ // How drop-off timeslots are generated for the business unit
1231
+ mode?: 'automatic' | 'custom';
1232
+ // Delivery destination names served all day. Replaces the stored list.
1233
+ destinations?: string[];
1234
+ // Caller-defined delivery windows. Replaces the stored list.
1235
+ custom_timeslots?: BusinessUnitCustomTimeslotDto[];
1236
+ // Whether guests see a single timeslot instead of a list
1237
+ show_single_timeslot?: boolean;
1238
+ // Whether guests can leave drop-off instructions
1239
+ show_instructions?: boolean;
1240
+ // Whether the runner app is enabled for the business unit
1241
+ runner_app_enabled?: boolean;
1242
+ // Delivery fee in dollars. Send null to remove it; omit to leave it as is.
1243
+ fee?: number | null;
1244
+ }
1245
+
1246
+ export interface PutBusinessUnitDropOffResponse {
1247
+ success: boolean;
1248
+ }
1249
+
1149
1250
  export interface GlobalMenuGroupPublishedBrand {
1150
1251
  id: string;
1151
1252
  name: string;
@@ -1708,6 +1809,21 @@ export interface DeleteCentricosStationIntegrationPath {
1708
1809
 
1709
1810
  export type DeleteCentricosStationIntegrationResponse = DeleteStationIntegrationResponse;
1710
1811
 
1812
+ // PUT /centricos/discount - Add or Update a discount and assign it to multiple sites
1813
+
1814
+ export type PutCentricosDiscountBody = PutCentricDiscountRequestDTO;
1815
+
1816
+ export type PutCentricosDiscountResponse = PutCentricDiscountResponseDTO;
1817
+
1818
+ // PUT /centricos/discount/{id}/publish - Update and publish a discount and assign it to multiple sites
1819
+
1820
+ export interface PutCentricosDiscountPublishPath {
1821
+ // Discount ID
1822
+ id: string;
1823
+ }
1824
+
1825
+ export type PutCentricosDiscountPublishResponse = PutCentricDiscountPublishResponseDTO;
1826
+
1711
1827
  // PUT /centricos/discount/voucherify - Add or Update a voucherify discount and assign it to multiple sites
1712
1828
 
1713
1829
  export type PutCentricosDiscountVoucherifyBody = PutDiscountVoucherifyRequestDTO;
@@ -1723,14 +1839,14 @@ export interface PutCentricosDiscountVoucherifyPublishPath {
1723
1839
 
1724
1840
  export type PutCentricosDiscountVoucherifyPublishResponse = PutDiscountVoucherifyPublishResponseDTO;
1725
1841
 
1726
- // DELETE /centricos/discount/{id}/voucherify - Delete a discount from voucherify and all of its entity associations
1842
+ // DELETE /centricos/discount/{id} - Delete a discount and all of its entity associations
1727
1843
 
1728
- export interface DeleteCentricosDiscountsVoucherifyPath {
1844
+ export interface DeleteCentricosDiscountPath {
1729
1845
  // Discount ID
1730
1846
  id: string;
1731
1847
  }
1732
1848
 
1733
- export type DeleteCentricosDiscountsVoucherifyResponse = DeleteDiscountsVoucherifyResponseDTO;
1849
+ export type DeleteCentricosDiscountResponse = DeleteCentricDiscountResponseDTO;
1734
1850
 
1735
1851
  // GET /centricos/discount/{id} - Get discount information by ID
1736
1852
 
@@ -1741,6 +1857,15 @@ export interface GetCentricosDiscountPath {
1741
1857
 
1742
1858
  export type GetCentricosDiscountResponse = GetDiscountResponseDTO;
1743
1859
 
1860
+ // DELETE /centricos/discount/{id}/voucherify - Delete a discount from voucherify and all of its entity associations
1861
+
1862
+ export interface DeleteCentricosDiscountsVoucherifyPath {
1863
+ // Discount ID
1864
+ id: string;
1865
+ }
1866
+
1867
+ export type DeleteCentricosDiscountsVoucherifyResponse = DeleteDiscountsVoucherifyResponseDTO;
1868
+
1744
1869
  // GET /centricos/discounts - Get discounts with pagination and filtering
1745
1870
 
1746
1871
  export interface GetCentricosDiscountsQuery {
@@ -1846,6 +1971,17 @@ export interface DeleteCentricosBusinessUnitPath {
1846
1971
 
1847
1972
  export type DeleteCentricosBusinessUnitResponse = DeleteBusinessUnitResponse;
1848
1973
 
1974
+ // PUT /centricos/business-unit/{bu_id}/drop-off - Update shared drop-off settings for a business unit
1975
+
1976
+ export interface PutCentricosBusinessUnitDropOffPath {
1977
+ // TODO: cannot use CompassLongID as path parameter
1978
+ bu_id: string;
1979
+ }
1980
+
1981
+ export type PutCentricosBusinessUnitDropOffBody = PutBusinessUnitDropOffRequest;
1982
+
1983
+ export type PutCentricosBusinessUnitDropOffResponse = PutBusinessUnitDropOffResponse;
1984
+
1849
1985
  // GET /centricos/menu/global-menu-groups - Get a paginated list of global menu groups with filtering, sorting, and relationships
1850
1986
 
1851
1987
  export interface GetCentricosMenuGlobalMenuGroupsQuery {
@@ -4660,7 +4660,6 @@ export interface GetConsumerHomePageQuery {
4660
4660
  end: number;
4661
4661
  // current date in epoch time
4662
4662
  date: number;
4663
- location_multigroup_id: string;
4664
4663
  timezoneOffset: string;
4665
4664
  // app name
4666
4665
  appName?: string;
@@ -4708,7 +4707,6 @@ export interface GetConsumerHomePageV3Query {
4708
4707
  end: number;
4709
4708
  // current date in epoch time
4710
4709
  date: number;
4711
- location_multigroup_id: string;
4712
4710
  timezoneOffset: string;
4713
4711
  // app name
4714
4712
  appName?: string;