@compassdigital/sdk.typescript 4.795.0 → 4.797.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/lib/index.d.ts +3 -32
- package/lib/index.d.ts.map +1 -1
- package/lib/index.js +3 -40
- package/lib/index.js.map +1 -1
- package/lib/interface/centricos.d.ts +8 -80
- package/lib/interface/centricos.d.ts.map +1 -1
- package/package.json +1 -1
- package/src/index.ts +6 -94
- package/src/interface/centricos.ts +13 -145
|
@@ -423,6 +423,8 @@ export interface GetStationResponse {
|
|
|
423
423
|
name: string;
|
|
424
424
|
station_location: string;
|
|
425
425
|
business_unit: string;
|
|
426
|
+
// Whether the station's business unit has Marketplace enabled
|
|
427
|
+
business_unit_marketplace_enabled: boolean;
|
|
426
428
|
integrations: Integrations;
|
|
427
429
|
menu_schedules: MenuSchedule[];
|
|
428
430
|
closure_schedules: ClosureSchedule[];
|
|
@@ -460,6 +462,8 @@ export interface CustomDropOffTimeslotDto {
|
|
|
460
462
|
export interface DropOffSectionDto {
|
|
461
463
|
// Whether the station accepts drop-off orders
|
|
462
464
|
enabled: boolean;
|
|
465
|
+
// Marks a save from a station whose business unit manages the shared drop-off settings. Relaxes the required-when-enabled rules below; the server verifies the station's business unit has Marketplace enabled and rejects the save otherwise.
|
|
466
|
+
marketplace_managed?: boolean;
|
|
463
467
|
// How drop-off timeslots are generated. Required when enabled.
|
|
464
468
|
mode?: 'automatic' | 'custom' | 'robot';
|
|
465
469
|
// Drop-off prep time, in minutes. Required when enabled.
|
|
@@ -774,7 +778,7 @@ export interface CentricDiscountSchedule {
|
|
|
774
778
|
endTime: string;
|
|
775
779
|
}
|
|
776
780
|
|
|
777
|
-
export interface
|
|
781
|
+
export interface PutDiscountVoucherifyRequestDiscount {
|
|
778
782
|
// name of the discount
|
|
779
783
|
name: string;
|
|
780
784
|
// Discount method configuration
|
|
@@ -784,7 +788,7 @@ export interface PutCentricDiscountRequestDiscount {
|
|
|
784
788
|
// item level config of the discount
|
|
785
789
|
itemLevelConfig?: CentricDiscountItemLevelConfig;
|
|
786
790
|
is?: CentricDiscountIs;
|
|
787
|
-
//
|
|
791
|
+
// Voucherify metadata
|
|
788
792
|
meta?: CentricVoucherifyMetaDataDiscount;
|
|
789
793
|
// discount schedule
|
|
790
794
|
schedule?: CentricDiscountSchedule;
|
|
@@ -845,9 +849,9 @@ export interface DiscountBrand {
|
|
|
845
849
|
meta: DiscountBrandMeta;
|
|
846
850
|
}
|
|
847
851
|
|
|
848
|
-
export interface
|
|
852
|
+
export interface PutDiscountVoucherifyRequestDTO {
|
|
849
853
|
// Discount to update
|
|
850
|
-
discount:
|
|
854
|
+
discount: PutDiscountVoucherifyRequestDiscount;
|
|
851
855
|
// List of sites with metadata
|
|
852
856
|
sites?: DiscountSite[];
|
|
853
857
|
// List of brands with metadata
|
|
@@ -882,7 +886,7 @@ export interface DiscountResponseDTO {
|
|
|
882
886
|
type: 'Total Order' | 'Single Items' | 'Bundle';
|
|
883
887
|
// item level config of the discount
|
|
884
888
|
itemLevelConfig?: CentricDiscountItemLevelConfig;
|
|
885
|
-
//
|
|
889
|
+
// Voucherify metadata
|
|
886
890
|
meta?: CentricVoucherifyMetaDataDiscount;
|
|
887
891
|
id: string;
|
|
888
892
|
createdAt: string;
|
|
@@ -891,7 +895,7 @@ export interface DiscountResponseDTO {
|
|
|
891
895
|
schedule?: Record<string, any>;
|
|
892
896
|
}
|
|
893
897
|
|
|
894
|
-
export interface
|
|
898
|
+
export interface PutDiscountVoucherifyResponseDTO {
|
|
895
899
|
// Discount details
|
|
896
900
|
discount: DiscountResponseDTO;
|
|
897
901
|
// List of sites with metadata
|
|
@@ -915,73 +919,6 @@ export interface CentricDiscountMeta {
|
|
|
915
919
|
provider: CentricMetaProvider;
|
|
916
920
|
}
|
|
917
921
|
|
|
918
|
-
export interface PutCentricDiscountPublishResponseDTO {
|
|
919
|
-
// user is of discount creator
|
|
920
|
-
createdBy: string;
|
|
921
|
-
// last user who updated the discount
|
|
922
|
-
updatedBy: string;
|
|
923
|
-
// name of the discount
|
|
924
|
-
name: string;
|
|
925
|
-
// status of the discount
|
|
926
|
-
status: CentricDiscountStatus;
|
|
927
|
-
// Discount method configuration
|
|
928
|
-
method: CentricDiscountMethod;
|
|
929
|
-
// channel config of the discount
|
|
930
|
-
channelConfig: CentricDiscountChannelConfig;
|
|
931
|
-
// type of the discount
|
|
932
|
-
type: 'Total Order' | 'Single Items' | 'Bundle';
|
|
933
|
-
// item level config of the discount
|
|
934
|
-
itemLevelConfig?: CentricDiscountItemLevelConfig;
|
|
935
|
-
// discount metadata
|
|
936
|
-
meta?: CentricDiscountMeta;
|
|
937
|
-
// List of sites where discount is published
|
|
938
|
-
sites?: CentricDiscountEntityBase[];
|
|
939
|
-
id: string;
|
|
940
|
-
createdAt: string;
|
|
941
|
-
updatedAt: string;
|
|
942
|
-
is?: CentricDiscountIs;
|
|
943
|
-
schedule?: Record<string, any>;
|
|
944
|
-
}
|
|
945
|
-
|
|
946
|
-
export interface PutDiscountVoucherifyRequestDiscount {
|
|
947
|
-
// name of the discount
|
|
948
|
-
name: string;
|
|
949
|
-
// Discount method configuration
|
|
950
|
-
method: CentricDiscountMethod;
|
|
951
|
-
// channel config of the discount
|
|
952
|
-
channelConfig: CentricDiscountChannelConfig;
|
|
953
|
-
// item level config of the discount
|
|
954
|
-
itemLevelConfig?: CentricDiscountItemLevelConfig;
|
|
955
|
-
is?: CentricDiscountIs;
|
|
956
|
-
// discount metadata
|
|
957
|
-
meta?: CentricVoucherifyMetaDataDiscount;
|
|
958
|
-
// discount schedule
|
|
959
|
-
schedule?: CentricDiscountSchedule;
|
|
960
|
-
id?: string;
|
|
961
|
-
// discount active status flag
|
|
962
|
-
active?: boolean;
|
|
963
|
-
// type of the discount
|
|
964
|
-
type?: 'Total Order' | 'Single Items' | 'Bundle';
|
|
965
|
-
}
|
|
966
|
-
|
|
967
|
-
export interface PutDiscountVoucherifyRequestDTO {
|
|
968
|
-
// Discount to update
|
|
969
|
-
discount: PutDiscountVoucherifyRequestDiscount;
|
|
970
|
-
// List of sites with metadata
|
|
971
|
-
sites?: DiscountSite[];
|
|
972
|
-
// List of brands with metadata
|
|
973
|
-
brands?: DiscountBrand[];
|
|
974
|
-
}
|
|
975
|
-
|
|
976
|
-
export interface PutDiscountVoucherifyResponseDTO {
|
|
977
|
-
// Discount details
|
|
978
|
-
discount: DiscountResponseDTO;
|
|
979
|
-
// List of sites with metadata
|
|
980
|
-
sites: DiscountSite[];
|
|
981
|
-
// List of brands with metadata
|
|
982
|
-
brands: DiscountBrand[];
|
|
983
|
-
}
|
|
984
|
-
|
|
985
922
|
export interface PutDiscountVoucherifyPublishResponseDTO {
|
|
986
923
|
// user is of discount creator
|
|
987
924
|
createdBy: string;
|
|
@@ -1010,10 +947,6 @@ export interface PutDiscountVoucherifyPublishResponseDTO {
|
|
|
1010
947
|
schedule?: Record<string, any>;
|
|
1011
948
|
}
|
|
1012
949
|
|
|
1013
|
-
export interface DeleteCentricDiscountResponseDTO {
|
|
1014
|
-
success: boolean;
|
|
1015
|
-
}
|
|
1016
|
-
|
|
1017
950
|
export interface DeleteDiscountsVoucherifyResponseDTO {
|
|
1018
951
|
success: boolean;
|
|
1019
952
|
}
|
|
@@ -1213,36 +1146,6 @@ export interface DeleteBusinessUnitResponse {
|
|
|
1213
1146
|
success: boolean;
|
|
1214
1147
|
}
|
|
1215
1148
|
|
|
1216
|
-
export interface BusinessUnitCustomTimeslotDto {
|
|
1217
|
-
// Window start, HH:mm on a 24 hour clock
|
|
1218
|
-
start_time: string;
|
|
1219
|
-
// Window end, HH:mm on a 24 hour clock
|
|
1220
|
-
end_time: string;
|
|
1221
|
-
// Delivery destination names served during this window
|
|
1222
|
-
destinations: string[];
|
|
1223
|
-
}
|
|
1224
|
-
|
|
1225
|
-
export interface PutBusinessUnitDropOffRequest {
|
|
1226
|
-
// How drop-off timeslots are generated for the business unit
|
|
1227
|
-
mode?: 'automatic' | 'custom';
|
|
1228
|
-
// Delivery destination names served all day. Replaces the stored list.
|
|
1229
|
-
destinations?: string[];
|
|
1230
|
-
// Caller-defined delivery windows. Replaces the stored list.
|
|
1231
|
-
custom_timeslots?: BusinessUnitCustomTimeslotDto[];
|
|
1232
|
-
// Whether guests see a single timeslot instead of a list
|
|
1233
|
-
show_single_timeslot?: boolean;
|
|
1234
|
-
// Whether guests can leave drop-off instructions
|
|
1235
|
-
show_instructions?: boolean;
|
|
1236
|
-
// Whether the runner app is enabled for the business unit
|
|
1237
|
-
runner_app_enabled?: boolean;
|
|
1238
|
-
// Delivery fee in dollars. Send null to remove it; omit to leave it as is.
|
|
1239
|
-
fee?: number | null;
|
|
1240
|
-
}
|
|
1241
|
-
|
|
1242
|
-
export interface PutBusinessUnitDropOffResponse {
|
|
1243
|
-
success: boolean;
|
|
1244
|
-
}
|
|
1245
|
-
|
|
1246
1149
|
export interface GlobalMenuGroupPublishedBrand {
|
|
1247
1150
|
id: string;
|
|
1248
1151
|
name: string;
|
|
@@ -1805,21 +1708,6 @@ export interface DeleteCentricosStationIntegrationPath {
|
|
|
1805
1708
|
|
|
1806
1709
|
export type DeleteCentricosStationIntegrationResponse = DeleteStationIntegrationResponse;
|
|
1807
1710
|
|
|
1808
|
-
// PUT /centricos/discount - Add or Update a discount and assign it to multiple sites
|
|
1809
|
-
|
|
1810
|
-
export type PutCentricosDiscountBody = PutCentricDiscountRequestDTO;
|
|
1811
|
-
|
|
1812
|
-
export type PutCentricosDiscountResponse = PutCentricDiscountResponseDTO;
|
|
1813
|
-
|
|
1814
|
-
// PUT /centricos/discount/{id}/publish - Update and publish a discount and assign it to multiple sites
|
|
1815
|
-
|
|
1816
|
-
export interface PutCentricosDiscountPublishPath {
|
|
1817
|
-
// Discount ID
|
|
1818
|
-
id: string;
|
|
1819
|
-
}
|
|
1820
|
-
|
|
1821
|
-
export type PutCentricosDiscountPublishResponse = PutCentricDiscountPublishResponseDTO;
|
|
1822
|
-
|
|
1823
1711
|
// PUT /centricos/discount/voucherify - Add or Update a voucherify discount and assign it to multiple sites
|
|
1824
1712
|
|
|
1825
1713
|
export type PutCentricosDiscountVoucherifyBody = PutDiscountVoucherifyRequestDTO;
|
|
@@ -1835,14 +1723,14 @@ export interface PutCentricosDiscountVoucherifyPublishPath {
|
|
|
1835
1723
|
|
|
1836
1724
|
export type PutCentricosDiscountVoucherifyPublishResponse = PutDiscountVoucherifyPublishResponseDTO;
|
|
1837
1725
|
|
|
1838
|
-
// DELETE /centricos/discount/{id} - Delete a discount and all of its entity associations
|
|
1726
|
+
// DELETE /centricos/discount/{id}/voucherify - Delete a discount from voucherify and all of its entity associations
|
|
1839
1727
|
|
|
1840
|
-
export interface
|
|
1728
|
+
export interface DeleteCentricosDiscountsVoucherifyPath {
|
|
1841
1729
|
// Discount ID
|
|
1842
1730
|
id: string;
|
|
1843
1731
|
}
|
|
1844
1732
|
|
|
1845
|
-
export type
|
|
1733
|
+
export type DeleteCentricosDiscountsVoucherifyResponse = DeleteDiscountsVoucherifyResponseDTO;
|
|
1846
1734
|
|
|
1847
1735
|
// GET /centricos/discount/{id} - Get discount information by ID
|
|
1848
1736
|
|
|
@@ -1853,15 +1741,6 @@ export interface GetCentricosDiscountPath {
|
|
|
1853
1741
|
|
|
1854
1742
|
export type GetCentricosDiscountResponse = GetDiscountResponseDTO;
|
|
1855
1743
|
|
|
1856
|
-
// DELETE /centricos/discount/{id}/voucherify - Delete a discount from voucherify and all of its entity associations
|
|
1857
|
-
|
|
1858
|
-
export interface DeleteCentricosDiscountsVoucherifyPath {
|
|
1859
|
-
// Discount ID
|
|
1860
|
-
id: string;
|
|
1861
|
-
}
|
|
1862
|
-
|
|
1863
|
-
export type DeleteCentricosDiscountsVoucherifyResponse = DeleteDiscountsVoucherifyResponseDTO;
|
|
1864
|
-
|
|
1865
1744
|
// GET /centricos/discounts - Get discounts with pagination and filtering
|
|
1866
1745
|
|
|
1867
1746
|
export interface GetCentricosDiscountsQuery {
|
|
@@ -1967,17 +1846,6 @@ export interface DeleteCentricosBusinessUnitPath {
|
|
|
1967
1846
|
|
|
1968
1847
|
export type DeleteCentricosBusinessUnitResponse = DeleteBusinessUnitResponse;
|
|
1969
1848
|
|
|
1970
|
-
// PUT /centricos/business-unit/{bu_id}/drop-off - Update shared drop-off settings for a business unit
|
|
1971
|
-
|
|
1972
|
-
export interface PutCentricosBusinessUnitDropOffPath {
|
|
1973
|
-
// TODO: cannot use CompassLongID as path parameter
|
|
1974
|
-
bu_id: string;
|
|
1975
|
-
}
|
|
1976
|
-
|
|
1977
|
-
export type PutCentricosBusinessUnitDropOffBody = PutBusinessUnitDropOffRequest;
|
|
1978
|
-
|
|
1979
|
-
export type PutCentricosBusinessUnitDropOffResponse = PutBusinessUnitDropOffResponse;
|
|
1980
|
-
|
|
1981
1849
|
// GET /centricos/menu/global-menu-groups - Get a paginated list of global menu groups with filtering, sorting, and relationships
|
|
1982
1850
|
|
|
1983
1851
|
export interface GetCentricosMenuGlobalMenuGroupsQuery {
|