@compassdigital/sdk.typescript 4.318.0 → 4.320.0

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@compassdigital/sdk.typescript",
-	"version": "4.318.0",
+	"version": "4.320.0",
 	"description": "Compass Digital Labs TypeScript SDK",
 	"type": "commonjs",
 	"main": "./lib/index.js",
@@ -57,7 +57,7 @@
 	},
 	"devDependencies": {
 		"@compassdigital/review": "^7.6.3",
-		"@compassdigital/sdk.typescript.cli": "^4.52.0",
+		"@compassdigital/sdk.typescript.cli": "^4.54.0",
 		"@swc/core": "^1.4.1",
 		"@swc/jest": "^0.2.36",
 		"@types/jest": "^30.0.0",

package/src/interface/calendar.ts

@@ -54,9 +54,43 @@ export interface Success {
 }
 
 export interface Schedule {
-	duration?: number;
+	// Start timestamp in milliseconds (Unix epoch).
+	start?: number;
+	// End timestamp in milliseconds (Unix epoch). If omitted, the schedule continues indefinitely.
+	end?: number;
+	// Array of time strings specifying the start time of the event each day it occurs.
 	times?: string[];
+	// Duration of the event, combined with times to calculate the end time.
+	duration?: number;
+	// Duration unit for the schedule.
+	durationUnit?: 'minutes' | 'hours' | 'days' | 'weeks';
+	// Creates discrete, repeating time windows when the schedule is active. The system uses 'start' to determine which month/week/day/year to begin counting from, then snaps to the beginning of that time unit before applying the interval.
+	every?:
+		| {
+				week?: number;
+				day?: number;
+				month?: number;
+				year?: number;
+		  }
+		| false;
+	// Array of specific years when schedule applies (full year values, e.g., 2024).
+	year?: number[];
+	// Array of specific months when schedule applies (0-indexed, 0 = January, 11 = December).
+	month?: number[];
+	// Array of days of the week when this schedule is active.
 	dayOfWeek?: number[];
+	// Array of specific weeks of the month when schedule applies.
+	weekOfMonth?: number[];
+	// Array of specific weeks of the year when schedule applies (ISO week numbers).
+	weekOfYear?: number[];
+	// Array of week spans within the month (0-indexed week blocks).
+	weekspanOfMonth?: number[];
+	// Array of week spans within the year (0-indexed week blocks).
+	weekspanOfYear?: number[];
+	// Array of specific days of the year when schedule applies.
+	dayOfYear?: number[];
+	// Array of specific days of month when schedule applies.
+	dayOfMonth?: number[];
 	[index: string]: any;
 }
 

package/src/interface/menu.ts

@@ -799,6 +799,7 @@ export interface DraftItemDTO {
 	unique_id?: number;
 	cpg_item_id?: string;
 	price_levels?: Record<string, any>;
+	menu_labels?: Record<string, any>;
 	translation?: Record<string, any>;
 	applied_diff_snapshot?: Record<string, any>;
 	version?: number;
@@ -924,6 +925,7 @@ export interface DraftModifierDTO {
 	tags?: string[];
 	unique_id?: number;
 	price_levels?: Record<string, any>;
+	menu_labels?: Record<string, any>;
 	translation?: Record<string, any>;
 	applied_diff_snapshot?: Record<string, any>;
 	version?: number;
@@ -1367,6 +1369,7 @@ export interface PublishedItemDTO {
 	tax_jwo_code?: string;
 	cpg_item_id?: string;
 	price_levels?: Record<string, any>;
+	menu_labels?: Record<string, any>;
 	translation?: Record<string, any>;
 	version?: number;
 	permissions?: Record<string, any>;
@@ -1456,6 +1459,7 @@ export interface PublishedModifierDTO {
 	tax_tag_code?: string;
 	tags?: string[];
 	price_levels?: Record<string, any>;
+	menu_labels?: Record<string, any>;
 	translation?: Record<string, any>;
 	version?: number;
 	permissions?: Record<string, any>;
@@ -1740,6 +1744,7 @@ export interface DraftItemEntityDTO {
 	unique_id?: number;
 	cpg_item_id?: string;
 	price_levels?: Record<string, any>;
+	menu_labels?: Record<string, any>;
 	translation?: Record<string, any>;
 	applied_diff_snapshot?: Record<string, any>;
 	version?: number;
@@ -1793,6 +1798,7 @@ export interface DraftModifierEntityDTO {
 	tags?: string[];
 	unique_id?: number;
 	price_levels?: Record<string, any>;
+	menu_labels?: Record<string, any>;
 	translation?: Record<string, any>;
 	applied_diff_snapshot?: Record<string, any>;
 	version?: number;
@@ -1939,6 +1945,7 @@ export interface PartialItemDTO {
 	unique_id?: number;
 	cpg_item_id?: string;
 	price_levels?: Record<string, any>;
+	menu_labels?: Record<string, any>;
 	translation?: Record<string, any>;
 	applied_diff_snapshot?: Record<string, any>;
 	brand?: DraftBrandDTO;
@@ -1982,6 +1989,7 @@ export interface PartialModifierDTO {
 	tags?: string[];
 	unique_id?: number;
 	price_levels?: Record<string, any>;
+	menu_labels?: Record<string, any>;
 	translation?: Record<string, any>;
 	applied_diff_snapshot?: Record<string, any>;
 	brand?: DraftBrandDTO;
@@ -5649,6 +5657,7 @@ export interface PostMenuV3DraftItemBody {
 	unique_id?: number;
 	cpg_item_id?: string;
 	price_levels?: Record<string, any>;
+	menu_labels?: Record<string, any>;
 	translation?: Record<string, any>;
 	applied_diff_snapshot?: Record<string, any>;
 	brand?: DraftBrandDTO;
@@ -5730,6 +5739,7 @@ export interface PatchMenuV3DraftItemBody {
 	unique_id?: number;
 	cpg_item_id?: string;
 	price_levels?: Record<string, any>;
+	menu_labels?: Record<string, any>;
 	translation?: Record<string, any>;
 	applied_diff_snapshot?: Record<string, any>;
 	version?: number;
@@ -5850,6 +5860,7 @@ export type PostMenuV3DraftItemsBody = {
 	unique_id?: number;
 	cpg_item_id?: string;
 	price_levels?: Record<string, any>;
+	menu_labels?: Record<string, any>;
 	translation?: Record<string, any>;
 	applied_diff_snapshot?: Record<string, any>;
 	brand?: DraftBrandDTO;
@@ -5961,6 +5972,7 @@ export interface PatchMenuV3DraftItemsBulkUpdateBody {
 	unique_id?: number;
 	cpg_item_id?: string;
 	price_levels?: Record<string, any>;
+	menu_labels?: Record<string, any>;
 	translation?: Record<string, any>;
 	applied_diff_snapshot?: Record<string, any>;
 	brand?: DraftBrandDTO;
@@ -7101,6 +7113,7 @@ export interface PostMenuV3DraftModifierBody {
 	tags?: string[];
 	unique_id?: number;
 	price_levels?: Record<string, any>;
+	menu_labels?: Record<string, any>;
 	translation?: Record<string, any>;
 	applied_diff_snapshot?: Record<string, any>;
 	brand?: DraftBrandDTO;
@@ -7178,6 +7191,7 @@ export interface PatchMenuV3DraftModifierBody {
 	tags?: string[];
 	unique_id?: number;
 	price_levels?: Record<string, any>;
+	menu_labels?: Record<string, any>;
 	translation?: Record<string, any>;
 	applied_diff_snapshot?: Record<string, any>;
 	version?: number;
@@ -7294,6 +7308,7 @@ export type PostMenuV3DraftModifiersBody = {
 	tags?: string[];
 	unique_id?: number;
 	price_levels?: Record<string, any>;
+	menu_labels?: Record<string, any>;
 	translation?: Record<string, any>;
 	applied_diff_snapshot?: Record<string, any>;
 	brand?: DraftBrandDTO;
@@ -7401,6 +7416,7 @@ export interface PatchMenuV3DraftModifiersBulkUpdateBody {
 	tags?: string[];
 	unique_id?: number;
 	price_levels?: Record<string, any>;
+	menu_labels?: Record<string, any>;
 	translation?: Record<string, any>;
 	applied_diff_snapshot?: Record<string, any>;
 	brand?: DraftBrandDTO;
@@ -8818,6 +8834,7 @@ export interface PostMenuV4ItemBody {
 	unique_id?: number;
 	cpg_item_id?: string;
 	price_levels?: Record<string, any>;
+	menu_labels?: Record<string, any>;
 	translation?: Record<string, any>;
 	base_item_id?: string;
 	applied_diff_snapshot?: Record<string, any>;
@@ -8869,6 +8886,7 @@ export interface PostMenuV4ItemResponse {
 	unique_id?: number;
 	cpg_item_id?: string;
 	price_levels?: Record<string, any>;
+	menu_labels?: Record<string, any>;
 	translation?: Record<string, any>;
 	applied_diff_snapshot?: Record<string, any>;
 	version?: number;
@@ -8922,6 +8940,7 @@ export type PostMenuV4ItemsBulkCreateBody = {
 	unique_id?: number;
 	cpg_item_id?: string;
 	price_levels?: Record<string, any>;
+	menu_labels?: Record<string, any>;
 	translation?: Record<string, any>;
 	base_item_id?: string;
 	applied_diff_snapshot?: Record<string, any>;
@@ -8994,6 +9013,7 @@ export interface GetMenuV4ItemResponse {
 	unique_id?: number;
 	cpg_item_id?: string;
 	price_levels?: Record<string, any>;
+	menu_labels?: Record<string, any>;
 	translation?: Record<string, any>;
 	applied_diff_snapshot?: Record<string, any>;
 	version?: number;
@@ -9053,6 +9073,7 @@ export interface PatchMenuV4ItemBody {
 	unique_id?: number;
 	cpg_item_id?: string;
 	price_levels?: Record<string, any>;
+	menu_labels?: Record<string, any>;
 	translation?: Record<string, any>;
 	applied_diff_snapshot?: Record<string, any>;
 	brand?: DraftBrandDTO;
@@ -9103,6 +9124,7 @@ export interface PatchMenuV4ItemResponse {
 	unique_id?: number;
 	cpg_item_id?: string;
 	price_levels?: Record<string, any>;
+	menu_labels?: Record<string, any>;
 	translation?: Record<string, any>;
 	applied_diff_snapshot?: Record<string, any>;
 	version?: number;
@@ -9164,6 +9186,7 @@ export interface DeleteMenuV4ItemResponse {
 	unique_id?: number;
 	cpg_item_id?: string;
 	price_levels?: Record<string, any>;
+	menu_labels?: Record<string, any>;
 	translation?: Record<string, any>;
 	applied_diff_snapshot?: Record<string, any>;
 	version?: number;
@@ -9217,6 +9240,7 @@ export interface PatchMenuV4ItemsBulkUpdateBody {
 	unique_id?: number;
 	cpg_item_id?: string;
 	price_levels?: Record<string, any>;
+	menu_labels?: Record<string, any>;
 	translation?: Record<string, any>;
 	applied_diff_snapshot?: Record<string, any>;
 	brand?: DraftBrandDTO;
@@ -9277,6 +9301,7 @@ export interface PatchMenuV4ItemsBulkPriceUpdateBody {
 	unique_id?: number;
 	cpg_item_id?: string;
 	price_levels?: Record<string, any>;
+	menu_labels?: Record<string, any>;
 	translation?: Record<string, any>;
 	applied_diff_snapshot?: Record<string, any>;
 	brand?: DraftBrandDTO;
@@ -9347,6 +9372,7 @@ export interface PostMenuV4ItemDuplicateResponse {
 	unique_id?: number;
 	cpg_item_id?: string;
 	price_levels?: Record<string, any>;
+	menu_labels?: Record<string, any>;
 	translation?: Record<string, any>;
 	applied_diff_snapshot?: Record<string, any>;
 	version?: number;
@@ -9487,6 +9513,7 @@ export interface PostMenuV4ModifierBody {
 	tags?: string[];
 	unique_id?: number;
 	price_levels?: Record<string, any>;
+	menu_labels?: Record<string, any>;
 	translation?: Record<string, any>;
 	applied_diff_snapshot?: Record<string, any>;
 	brand?: DraftBrandDTO;
@@ -9533,6 +9560,7 @@ export interface PostMenuV4ModifierResponse {
 	tags?: string[];
 	unique_id?: number;
 	price_levels?: Record<string, any>;
+	menu_labels?: Record<string, any>;
 	translation?: Record<string, any>;
 	applied_diff_snapshot?: Record<string, any>;
 	version?: number;
@@ -9596,6 +9624,7 @@ export interface GetMenuV4ModifierResponse {
 	tags?: string[];
 	unique_id?: number;
 	price_levels?: Record<string, any>;
+	menu_labels?: Record<string, any>;
 	translation?: Record<string, any>;
 	applied_diff_snapshot?: Record<string, any>;
 	version?: number;
@@ -9650,6 +9679,7 @@ export interface PatchMenuV4ModifierBody {
 	tags?: string[];
 	unique_id?: number;
 	price_levels?: Record<string, any>;
+	menu_labels?: Record<string, any>;
 	translation?: Record<string, any>;
 	applied_diff_snapshot?: Record<string, any>;
 	brand?: DraftBrandDTO;
@@ -9696,6 +9726,7 @@ export interface PatchMenuV4ModifierResponse {
 	tags?: string[];
 	unique_id?: number;
 	price_levels?: Record<string, any>;
+	menu_labels?: Record<string, any>;
 	translation?: Record<string, any>;
 	applied_diff_snapshot?: Record<string, any>;
 	version?: number;
@@ -9753,6 +9784,7 @@ export interface DeleteMenuV4ModifierResponse {
 	tags?: string[];
 	unique_id?: number;
 	price_levels?: Record<string, any>;
+	menu_labels?: Record<string, any>;
 	translation?: Record<string, any>;
 	applied_diff_snapshot?: Record<string, any>;
 	version?: number;
@@ -9814,6 +9846,7 @@ export interface PostMenuV4ModifierDuplicateResponse {
 	tags?: string[];
 	unique_id?: number;
 	price_levels?: Record<string, any>;
+	menu_labels?: Record<string, any>;
 	translation?: Record<string, any>;
 	applied_diff_snapshot?: Record<string, any>;
 	version?: number;
@@ -9867,6 +9900,7 @@ export interface PatchMenuV4ModifiersBulkUpdateBody {
 	tags?: string[];
 	unique_id?: number;
 	price_levels?: Record<string, any>;
+	menu_labels?: Record<string, any>;
 	translation?: Record<string, any>;
 	applied_diff_snapshot?: Record<string, any>;
 	brand?: DraftBrandDTO;