@compassdigital/sdk.typescript 4.134.0 → 4.136.0

package/src/interface/menu.ts

@@ -427,6 +427,10 @@ export interface GlobalMenuGroupDTO {
 	price_levels?: Record<string, any>;
 	show_v4?: boolean;
 	id?: string;
+	created_at?: string;
+	updated_at?: string;
+	deleted_at?: string;
+	version?: number;
 	permissions?: Record<string, any>;
 	[index: string]: any;
 }
@@ -435,6 +439,9 @@ export interface DraftBrandDTO {
 	catalog_id?: number;
 	published_catalog_id?: number;
 	id?: string;
+	created_at?: string;
+	updated_at?: string;
+	deleted_at?: string;
 	name?: string;
 	description?: string;
 	is_active?: boolean;
@@ -448,6 +455,7 @@ export interface DraftBrandDTO {
 	frictionless_partner?: string;
 	meta?: BrandMeta;
 	applied_diff_snapshot?: Record<string, any>;
+	version?: number;
 	permissions?: Record<string, any>;
 	[index: string]: any;
 }
@@ -459,6 +467,9 @@ export interface BrandMeta {
 export interface PublishedBrandDTO {
 	published_catalog_id?: number;
 	id?: string;
+	created_at?: string;
+	updated_at?: string;
+	deleted_at?: string;
 	name?: string;
 	description?: string;
 	is_active?: boolean;
@@ -471,12 +482,16 @@ export interface PublishedBrandDTO {
 	auto_push_to_local?: boolean;
 	frictionless_partner?: string;
 	meta?: Record<string, any>;
+	version?: number;
 	permissions?: Record<string, any>;
 	[index: string]: any;
 }
 
 export interface VendorMetadataDTO {
 	id?: string;
+	created_at?: string;
+	updated_at?: string;
+	deleted_at?: string;
 	vendor_name?: string;
 	name?: string;
 	value?: string;
@@ -491,6 +506,7 @@ export interface VendorMetadataDTO {
 	modifier_group_id?: string;
 	modifier_group_to_modifier_relationship_id?: string;
 	modifier_id?: string;
+	version?: number;
 	permissions?: Record<string, any>;
 	[index: string]: any;
 }
@@ -599,9 +615,13 @@ export interface LocalMenuGroupDTO {
 
 export interface BrandChangeDTO {
 	id?: string;
+	created_at?: string;
+	updated_at?: string;
+	deleted_at?: string;
 	insert?: Record<string, any>;
 	delete?: Record<string, any>;
 	snapshot_entity_id?: string;
+	version?: number;
 	snapshot_entity?: DraftBrandDTO;
 	permissions?: Record<string, any>;
 	[index: string]: any;
@@ -615,10 +635,14 @@ export interface DraftMenuDTO {
 	station_id?: string;
 	price_level_id?: string;
 	id?: string;
+	created_at?: string;
+	updated_at?: string;
+	deleted_at?: string;
 	parent_id?: string;
 	name?: string;
 	brand_id?: string;
 	applied_diff_snapshot?: Record<string, any>;
+	version?: number;
 	brand?: DraftBrandDTO;
 	changes?: MenuChangeDTO[];
 	vendor_metadata?: VendorMetadataDTO[];
@@ -630,6 +654,9 @@ export interface DraftCategoryDTO {
 	parent?: Record<string, any>;
 	children?: Record<string, any>[];
 	id?: string;
+	created_at?: string;
+	updated_at?: string;
+	deleted_at?: string;
 	parent_id?: string;
 	name?: string;
 	label?: string;
@@ -638,6 +665,7 @@ export interface DraftCategoryDTO {
 	brand_id?: string;
 	menu_id?: string;
 	applied_diff_snapshot?: Record<string, any>;
+	version?: number;
 	menu?: Record<string, any>;
 	items?: DraftCategoryToItemRelationshipDTO[];
 	brand?: DraftBrandDTO;
@@ -652,12 +680,16 @@ export interface DraftCategoryToItemRelationshipDTO {
 	parent?: Record<string, any>;
 	children?: Record<string, any>[];
 	id?: string;
+	created_at?: string;
+	updated_at?: string;
+	deleted_at?: string;
 	parent_id?: string;
 	item_id?: string;
 	category_id?: string;
 	brand_id?: string;
 	sequence?: number;
 	applied_diff_snapshot?: Record<string, any>;
+	version?: number;
 	category?: Record<string, any>;
 	item?: DraftItemDTO;
 	brand?: DraftBrandDTO;
@@ -675,6 +707,9 @@ export interface DraftItemDTO {
 	cpg_item?: UniversalItemDTO;
 	stocks?: StockDTO[];
 	id?: string;
+	created_at?: string;
+	updated_at?: string;
+	deleted_at?: string;
 	parent_id?: string;
 	name?: string;
 	name_on_receipt?: string;
@@ -702,6 +737,7 @@ export interface DraftItemDTO {
 	cpg_item_id?: string;
 	price_levels?: Record<string, any>;
 	applied_diff_snapshot?: Record<string, any>;
+	version?: number;
 	brand?: DraftBrandDTO;
 	categories?: Record<string, any>[];
 	changes?: ItemChangeDTO[];
@@ -716,12 +752,16 @@ export interface DraftItemToModifierGroupRelationshipDTO {
 	parent?: Record<string, any>;
 	children?: Record<string, any>[];
 	id?: string;
+	created_at?: string;
+	updated_at?: string;
+	deleted_at?: string;
 	parent_id?: string;
 	modifier_group_id?: string;
 	item_id?: string;
 	brand_id?: string;
 	sequence?: number;
 	applied_diff_snapshot?: Record<string, any>;
+	version?: number;
 	item?: Record<string, any>;
 	modifier_group?: DraftModifierGroupDTO;
 	brand?: DraftBrandDTO;
@@ -737,6 +777,9 @@ export interface DraftModifierGroupDTO {
 	modifiers?: DraftModifierGroupToModifierRelationshipDTO[];
 	items?: Record<string, any>[];
 	id?: string;
+	created_at?: string;
+	updated_at?: string;
+	deleted_at?: string;
 	parent_id?: string;
 	name?: string;
 	label?: string;
@@ -750,6 +793,7 @@ export interface DraftModifierGroupDTO {
 	is_out_of_stock?: boolean;
 	is_incremental?: boolean;
 	applied_diff_snapshot?: Record<string, any>;
+	version?: number;
 	brand?: DraftBrandDTO;
 	changes?: ModifierGroupChangeDTO[];
 	vendor_metadata?: VendorMetadataDTO[];
@@ -761,12 +805,16 @@ export interface DraftModifierGroupToModifierRelationshipDTO {
 	parent?: Record<string, any>;
 	children?: Record<string, any>[];
 	id?: string;
+	created_at?: string;
+	updated_at?: string;
+	deleted_at?: string;
 	parent_id?: string;
 	modifier_id?: string;
 	modifier_group_id?: string;
 	brand_id?: string;
 	sequence?: number;
 	applied_diff_snapshot?: Record<string, any>;
+	version?: number;
 	modifier?: DraftModifierDTO;
 	modifier_group?: Record<string, any>;
 	brand?: DraftBrandDTO;
@@ -781,6 +829,9 @@ export interface DraftModifierDTO {
 	children?: Record<string, any>[];
 	modifier_groups?: Record<string, any>[];
 	id?: string;
+	created_at?: string;
+	updated_at?: string;
+	deleted_at?: string;
 	parent_id?: string;
 	name?: string;
 	name_on_receipt?: string;
@@ -808,6 +859,7 @@ export interface DraftModifierDTO {
 	unique_id?: number;
 	price_levels?: Record<string, any>;
 	applied_diff_snapshot?: Record<string, any>;
+	version?: number;
 	brand?: DraftBrandDTO;
 	changes?: ModifierChangeDTO[];
 	vendor_metadata?: VendorMetadataDTO[];
@@ -819,9 +871,13 @@ export interface DraftModifierDTO {
 
 export interface ModifierChangeDTO {
 	id?: string;
+	created_at?: string;
+	updated_at?: string;
+	deleted_at?: string;
 	insert?: Record<string, any>;
 	delete?: Record<string, any>;
 	snapshot_entity_id?: string;
+	version?: number;
 	snapshot_entity?: Record<string, any>;
 	permissions?: Record<string, any>;
 	[index: string]: any;
@@ -864,9 +920,13 @@ export interface MenuWorksDTO {
 
 export interface ModifierGroupToModifierRelationshipChangeDTO {
 	id?: string;
+	created_at?: string;
+	updated_at?: string;
+	deleted_at?: string;
 	insert?: Record<string, any>;
 	delete?: Record<string, any>;
 	snapshot_entity_id?: string;
+	version?: number;
 	snapshot_entity?: Record<string, any>;
 	permissions?: Record<string, any>;
 	[index: string]: any;
@@ -874,9 +934,13 @@ export interface ModifierGroupToModifierRelationshipChangeDTO {
 
 export interface ModifierGroupChangeDTO {
 	id?: string;
+	created_at?: string;
+	updated_at?: string;
+	deleted_at?: string;
 	insert?: Record<string, any>;
 	delete?: Record<string, any>;
 	snapshot_entity_id?: string;
+	version?: number;
 	snapshot_entity?: Record<string, any>;
 	permissions?: Record<string, any>;
 	[index: string]: any;
@@ -884,9 +948,13 @@ export interface ModifierGroupChangeDTO {
 
 export interface ItemToModifierGroupRelationshipChangeDTO {
 	id?: string;
+	created_at?: string;
+	updated_at?: string;
+	deleted_at?: string;
 	insert?: Record<string, any>;
 	delete?: Record<string, any>;
 	snapshot_entity_id?: string;
+	version?: number;
 	snapshot_entity?: Record<string, any>;
 	permissions?: Record<string, any>;
 	[index: string]: any;
@@ -894,9 +962,13 @@ export interface ItemToModifierGroupRelationshipChangeDTO {
 
 export interface ItemChangeDTO {
 	id?: string;
+	created_at?: string;
+	updated_at?: string;
+	deleted_at?: string;
 	insert?: Record<string, any>;
 	delete?: Record<string, any>;
 	snapshot_entity_id?: string;
+	version?: number;
 	snapshot_entity?: Record<string, any>;
 	permissions?: Record<string, any>;
 	[index: string]: any;
@@ -907,6 +979,8 @@ export interface UniversalItemDTO {
 	barcode?: string;
 	name?: string;
 	description?: string;
+	created_at?: string;
+	updated_at?: string;
 	is_verified?: boolean;
 	verified_at?: string;
 	verified_by?: string;
@@ -924,7 +998,11 @@ export interface StockDTO {
 	menu_id?: string;
 	brand_id?: string;
 	id?: string;
+	created_at?: string;
+	updated_at?: string;
+	deleted_at?: string;
 	business_unit_id?: string;
+	version?: number;
 	menu?: Record<string, any>;
 	brand?: DraftBrandDTO;
 	permissions?: Record<string, any>;
@@ -933,9 +1011,13 @@ export interface StockDTO {
 
 export interface CategoryToItemRelationshipChangeDTO {
 	id?: string;
+	created_at?: string;
+	updated_at?: string;
+	deleted_at?: string;
 	insert?: Record<string, any>;
 	delete?: Record<string, any>;
 	snapshot_entity_id?: string;
+	version?: number;
 	snapshot_entity?: Record<string, any>;
 	permissions?: Record<string, any>;
 	[index: string]: any;
@@ -943,9 +1025,13 @@ export interface CategoryToItemRelationshipChangeDTO {
 
 export interface CategoryChangeDTO {
 	id?: string;
+	created_at?: string;
+	updated_at?: string;
+	deleted_at?: string;
 	insert?: Record<string, any>;
 	delete?: Record<string, any>;
 	snapshot_entity_id?: string;
+	version?: number;
 	snapshot_entity?: Record<string, any>;
 	permissions?: Record<string, any>;
 	[index: string]: any;
@@ -953,9 +1039,13 @@ export interface CategoryChangeDTO {
 
 export interface MenuChangeDTO {
 	id?: string;
+	created_at?: string;
+	updated_at?: string;
+	deleted_at?: string;
 	insert?: Record<string, any>;
 	delete?: Record<string, any>;
 	snapshot_entity_id?: string;
+	version?: number;
 	snapshot_entity?: Record<string, any>;
 	permissions?: Record<string, any>;
 	[index: string]: any;
@@ -967,6 +1057,10 @@ export interface BrandStatusDTO {
 	status?: string;
 	metadata?: Record<string, any>;
 	id?: string;
+	created_at?: string;
+	updated_at?: string;
+	deleted_at?: string;
+	version?: number;
 	brand?: DraftBrandDTO;
 	permissions?: Record<string, any>;
 	[index: string]: any;
@@ -979,9 +1073,13 @@ export interface AuditDTO {
 	status?: string;
 	message?: string;
 	id?: string;
+	created_at?: string;
+	updated_at?: string;
+	deleted_at?: string;
 	data?: Record<string, any>;
 	s3_link?: string;
 	email?: string;
+	version?: number;
 	brand?: DraftBrandDTO;
 	permissions?: Record<string, any>;
 	[index: string]: any;
@@ -1042,6 +1140,10 @@ export interface GlobalDiffDependencyDTO {
 	depends_on_id?: string;
 	is_depended_by_id?: string;
 	id?: string;
+	created_at?: string;
+	updated_at?: string;
+	deleted_at?: string;
+	version?: number;
 	depends_on?: GlobalDiffDTO;
 	is_depended_by?: Record<string, any>;
 	permissions?: Record<string, any>;
@@ -1051,6 +1153,9 @@ export interface GlobalDiffDependencyDTO {
 export interface GlobalDiffDTO {
 	action?: 'create' | 'update' | 'delete';
 	id?: string;
+	created_at?: string;
+	updated_at?: string;
+	deleted_at?: string;
 	entity_type?: string;
 	local_id?: string;
 	changes?: Record<string, any>;
@@ -1059,6 +1164,7 @@ export interface GlobalDiffDTO {
 	global_id?: string;
 	global_snapshot?: Record<string, any>;
 	brand_id?: string;
+	version?: number;
 	depends_on?: Record<string, any>[];
 	is_depended_by?: Record<string, any>[];
 	brand?: DraftBrandDTO;
@@ -1112,15 +1218,22 @@ export interface WarningItemDTO {
 
 export interface PublishedMenuDTO {
 	id?: string;
+	created_at?: string;
+	updated_at?: string;
+	deleted_at?: string;
 	parent_id?: string;
 	name?: string;
 	brand_id?: string;
+	version?: number;
 	permissions?: Record<string, any>;
 	[index: string]: any;
 }
 
 export interface PublishedCategoryDTO {
 	id?: string;
+	created_at?: string;
+	updated_at?: string;
+	deleted_at?: string;
 	parent_id?: string;
 	name?: string;
 	label?: string;
@@ -1128,17 +1241,22 @@ export interface PublishedCategoryDTO {
 	is_active?: boolean;
 	brand_id?: string;
 	menu_id?: string;
+	version?: number;
 	permissions?: Record<string, any>;
 	[index: string]: any;
 }
 
 export interface PublishedCategoryToItemRelationshipDTO {
 	id?: string;
+	created_at?: string;
+	updated_at?: string;
+	deleted_at?: string;
 	parent_id?: string;
 	item_id?: string;
 	category_id?: string;
 	brand_id?: string;
 	sequence?: number;
+	version?: number;
 	permissions?: Record<string, any>;
 	[index: string]: any;
 }
@@ -1146,6 +1264,9 @@ export interface PublishedCategoryToItemRelationshipDTO {
 export interface PublishedItemDTO {
 	unique_id?: number;
 	id?: string;
+	created_at?: string;
+	updated_at?: string;
+	deleted_at?: string;
 	parent_id?: string;
 	name?: string;
 	name_on_receipt?: string;
@@ -1169,23 +1290,31 @@ export interface PublishedItemDTO {
 	tax_jwo_code?: string;
 	cpg_item_id?: string;
 	price_levels?: Record<string, any>;
+	version?: number;
 	permissions?: Record<string, any>;
 	[index: string]: any;
 }
 
 export interface PublishedItemToModifierGroupRelationshipDTO {
 	id?: string;
+	created_at?: string;
+	updated_at?: string;
+	deleted_at?: string;
 	parent_id?: string;
 	modifier_group_id?: string;
 	item_id?: string;
 	brand_id?: string;
 	sequence?: number;
+	version?: number;
 	permissions?: Record<string, any>;
 	[index: string]: any;
 }
 
 export interface PublishedModifierGroupDTO {
 	id?: string;
+	created_at?: string;
+	updated_at?: string;
+	deleted_at?: string;
 	parent_id?: string;
 	name?: string;
 	label?: string;
@@ -1198,17 +1327,22 @@ export interface PublishedModifierGroupDTO {
 	sizing?: string;
 	is_out_of_stock?: boolean;
 	is_incremental?: boolean;
+	version?: number;
 	permissions?: Record<string, any>;
 	[index: string]: any;
 }
 
 export interface PublishedModifierGroupToModifierRelationshipDTO {
 	id?: string;
+	created_at?: string;
+	updated_at?: string;
+	deleted_at?: string;
 	parent_id?: string;
 	modifier_id?: string;
 	modifier_group_id?: string;
 	brand_id?: string;
 	sequence?: number;
+	version?: number;
 	permissions?: Record<string, any>;
 	[index: string]: any;
 }
@@ -1216,6 +1350,9 @@ export interface PublishedModifierGroupToModifierRelationshipDTO {
 export interface PublishedModifierDTO {
 	unique_id?: number;
 	id?: string;
+	created_at?: string;
+	updated_at?: string;
+	deleted_at?: string;
 	parent_id?: string;
 	name?: string;
 	name_on_receipt?: string;
@@ -1239,6 +1376,7 @@ export interface PublishedModifierDTO {
 	tax_tag_code?: string;
 	tags?: string[];
 	price_levels?: Record<string, any>;
+	version?: number;
 	permissions?: Record<string, any>;
 	[index: string]: any;
 }
@@ -7916,11 +8054,18 @@ export interface PostMenuV4BrandV3ToV4Path {
 	id: string;
 }
 
+export interface PostMenuV4BrandV3ToV4Query {
+	migrate_schedule?: boolean;
+}
+
 export interface PostMenuV4BrandV3ToV4Response {
 	status?: string;
 }
 
-export interface PostMenuV4BrandV3ToV4Request extends BaseRequest, PostMenuV4BrandV3ToV4Path {}
+export interface PostMenuV4BrandV3ToV4Request
+	extends BaseRequest,
+		RequestQuery<PostMenuV4BrandV3ToV4Query>,
+		PostMenuV4BrandV3ToV4Path {}
 
 // POST /menu/v4/brand/{brand_id}/category/{category_id}/duplicate
 

package/src/interface/promo.ts

@@ -244,6 +244,10 @@ export interface Redeemable {
 		discount?: AppliedDiscount;
 		[index: string]: any;
 	};
+	order?: {
+		total_applied_discount_amount?: number;
+		[index: string]: any;
+	};
 	[index: string]: any;
 }
 

package/src/interface/vendor.ts

@@ -99,14 +99,12 @@ export interface Vendor {
 		reset_token?: string;
 		[index: string]: any;
 	};
-	domain?: string;
 }
 
 export interface VendorPostBody {
 	name: string;
 	description?: string;
 	email: string;
-	domain?: string;
 	phone?: string;
 	// Property to store any additional data
 	meta?: {
@@ -141,18 +139,15 @@ export interface Key {
 	client_password?: string;
 	// Date the key becomes expired
 	date_expires?: string;
-	environment?: 'dev' | 'staging' | 'v1';
 	permissions?: string[];
 	// Flag identifying if the key is latest
 	active?: boolean;
-	domain?: string;
 }
 
 export interface KeyPostBody {
 	vendor_id: string;
 	// Date the key becomes expired
 	date_expires: string;
-	environment: 'dev' | 'staging' | 'v1';
 	permissions: string[];
 }
 
@@ -176,15 +171,6 @@ export interface Auth {
 		token?: string;
 		expires?: string;
 	};
-	refresh: {
-		token?: string;
-		expires?: string;
-	};
-}
-
-export interface RefreshPayload {
-	access_token: string;
-	refresh_token: string;
 }
 
 export interface ResetPassword {
@@ -250,10 +236,20 @@ export interface PatchVendorApplicationRequest extends BaseRequest, PatchVendorA
 	body: PatchVendorApplicationBody;
 }
 
+// DELETE /vendor/application/{id} - Delete an application by ID
+
+export interface DeleteVendorApplicationPath {
+	id: string;
+}
+
+export type DeleteVendorApplicationResponse = Success;
+
+export interface DeleteVendorApplicationRequest extends BaseRequest, DeleteVendorApplicationPath {}
+
 // POST /vendor - Create new vendor
 
 export interface PostVendorQuery {
-	// Send email notification to vendor (default true)
+	// Send email notification to vendor
 	email?: boolean;
 }
 
@@ -310,7 +306,18 @@ export interface PatchVendorRequest extends BaseRequest, PatchVendorPath {
 	body: PatchVendorBody;
 }
 
-// GET /vendor/auth - Get access/refresh tokens for accessing our APIs
+// DELETE /vendor/{id} - Delete a vendor and its keys
+
+export interface DeleteVendorPath {
+	// vendor
+	id: string;
+}
+
+export type DeleteVendorResponse = Success;
+
+export interface DeleteVendorRequest extends BaseRequest, DeleteVendorPath {}
+
+// GET /vendor/auth - Get access token for accessing our APIs
 
 export interface GetVendorAuthQuery {
 	// Graphql query string
@@ -321,16 +328,6 @@ export type GetVendorAuthResponse = Auth;
 
 export interface GetVendorAuthRequest extends BaseRequest, RequestQuery<GetVendorAuthQuery> {}
 
-// POST /vendor/auth - Get new access token using refresh token and previous token
-
-export type PostVendorAuthBody = RefreshPayload;
-
-export type PostVendorAuthResponse = Auth;
-
-export interface PostVendorAuthRequest extends BaseRequest {
-	body: PostVendorAuthBody;
-}
-
 // GET /vendor/{id}/key - Get list of Vendor keys
 
 export interface GetVendorKeysPath {
@@ -414,17 +411,9 @@ export interface DeleteVendorKeyPath {
 	key: string;
 }
 
-export interface DeleteVendorKeyQuery {
-	// If true, performs a hard delete instead of marking as expired
-	hard?: boolean;
-}
-
-export type DeleteVendorKeyResponse = Key;
+export type DeleteVendorKeyResponse = Success;
 
-export interface DeleteVendorKeyRequest
-	extends BaseRequest,
-		RequestQuery<DeleteVendorKeyQuery>,
-		DeleteVendorKeyPath {}
+export interface DeleteVendorKeyRequest extends BaseRequest, DeleteVendorKeyPath {}
 
 // POST /vendor/{id}/key/{key}/rotate - Rotate vendor key