@compassdigital/sdk.typescript 4.88.0 → 4.90.0

package/src/interface/menu.ts

@@ -159,13 +159,13 @@ export interface Item {
 			// menuworks unit id
 			unit_id?: string;
 			// menuworks portion quantity
-			portion_quantity?: number;
+			portion_quantity?: string;
 			// menuworks portion unit name
 			portion_unit_name?: string;
 			// menuworks grams
-			grams?: number;
+			grams?: string;
 			// menuworks cost (per serving)
-			cost?: number;
+			cost?: string;
 			// menuworks ingredients
 			ingredients?: string[];
 			// menuworks smart tags
@@ -306,13 +306,13 @@ export interface Option {
 			// menuworks unit id
 			unit_id?: string;
 			// menuworks portion quantity
-			portion_quantity?: number;
+			portion_quantity?: string;
 			// menuworks portion unit name
 			portion_unit_name?: string;
 			// menuworks grams
-			grams?: number;
+			grams?: string;
 			// menuworks cost (per serving)
-			cost?: number;
+			cost?: string;
 			// menuworks ingredients
 			ingredients?: string[];
 			// menuworks smart tags
@@ -442,7 +442,6 @@ export interface DraftBrandDTO {
 	posid_segment?: string;
 	is_simplified_view?: boolean;
 	frictionless_partner?: string;
-	catalog_id?: number;
 	applied_diff_snapshot?: Record<string, any>;
 	permissions?: Record<string, any>;
 	[index: string]: any;
@@ -460,7 +459,6 @@ export interface PublishedBrandDTO {
 	posid_segment?: string;
 	is_simplified_view?: boolean;
 	frictionless_partner?: string;
-	catalog_id?: number;
 	permissions?: Record<string, any>;
 	[index: string]: any;
 }
@@ -2772,7 +2770,6 @@ export interface PostMenuV3DraftBrandBody {
 	posid_segment?: string;
 	is_simplified_view?: boolean;
 	frictionless_partner?: string;
-	catalog_id?: number;
 	applied_diff_snapshot?: Record<string, any>;
 	changes?: BrandChangeDTO[];
 	local_menu_group?: LocalMenuGroupDTO;
@@ -2841,7 +2838,6 @@ export interface PatchMenuV3DraftBrandBody {
 	posid_segment?: string;
 	is_simplified_view?: boolean;
 	frictionless_partner?: string;
-	catalog_id?: number;
 	applied_diff_snapshot?: Record<string, any>;
 	version?: number;
 	changes?: BrandChangeDTO[];
@@ -2932,7 +2928,6 @@ export type PostMenuV3DraftBrandsBody = {
 	posid_segment?: string;
 	is_simplified_view?: boolean;
 	frictionless_partner?: string;
-	catalog_id?: number;
 	applied_diff_snapshot?: Record<string, any>;
 	changes?: BrandChangeDTO[];
 	local_menu_group?: LocalMenuGroupDTO;
@@ -3378,7 +3373,6 @@ export interface PostMenuV3BrandBody {
 	posid_segment?: string;
 	is_simplified_view?: boolean;
 	frictionless_partner?: string;
-	catalog_id?: number;
 	local_menu_group?: LocalMenuGroupDTO;
 	global_menu_group?: GlobalMenuGroupDTO;
 	attachments?: FileAttachmentsDTO;
@@ -3447,7 +3441,6 @@ export interface PatchMenuV3BrandBody {
 	posid_segment?: string;
 	is_simplified_view?: boolean;
 	frictionless_partner?: string;
-	catalog_id?: number;
 	version?: number;
 	local_menu_group?: LocalMenuGroupDTO;
 	global_menu_group?: GlobalMenuGroupDTO;
@@ -3540,7 +3533,6 @@ export type PostMenuV3BrandsBody = {
 	posid_segment?: string;
 	is_simplified_view?: boolean;
 	frictionless_partner?: string;
-	catalog_id?: number;
 	local_menu_group?: LocalMenuGroupDTO;
 	global_menu_group?: GlobalMenuGroupDTO;
 	attachments?: FileAttachmentsDTO;
@@ -4329,53 +4321,6 @@ export interface PostMenuV3DraftCategoryAttachmentRequest
 		RequestQuery<PostMenuV3DraftCategoryAttachmentQuery>,
 		PostMenuV3DraftCategoryAttachmentPath {}
 
-// POST /menu/v3/draft/category/{id}/duplicate
-
-export interface PostMenuV3DraftCategoryDuplicatePath {
-	id: string;
-}
-
-export interface PostMenuV3DraftCategoryDuplicateBody {
-	name?: string;
-	label?: string;
-	sequence?: number;
-	is_active?: boolean;
-	menu_id?: string;
-	[index: string]: any;
-}
-
-export interface PostMenuV3DraftCategoryDuplicateResponse {
-	parent?: DraftCategoryDTO;
-	children?: DraftCategoryDTO[];
-	id: string;
-	created_at?: string;
-	updated_at?: string;
-	deleted_at?: string;
-	parent_id?: string;
-	name: string;
-	label?: string;
-	sequence?: number;
-	is_active?: boolean;
-	brand_id: string;
-	menu_id: string;
-	applied_diff_snapshot?: Record<string, any>;
-	version?: number;
-	menu?: DraftMenuDTO;
-	items?: DraftCategoryToItemRelationshipDTO[];
-	brand?: DraftBrandDTO;
-	changes?: CategoryChangeDTO[];
-	vendor_metadata?: VendorMetadataDTO[];
-	attachments?: FileAttachmentsDTO;
-	permissions?: Record<string, any>;
-	[index: string]: any;
-}
-
-export interface PostMenuV3DraftCategoryDuplicateRequest
-	extends BaseRequest,
-		PostMenuV3DraftCategoryDuplicatePath {
-	body: PostMenuV3DraftCategoryDuplicateBody;
-}
-
 // GET /menu/v3/category/{id}
 
 export interface GetMenuV3CategoryPath {
@@ -6849,37 +6794,7 @@ export interface PostMenuV3TriggerUpdateRequest extends BaseRequest {}
 // POST /menu/v4/brand
 
 export interface PostMenuV4BrandBody {
-	parent?: DraftBrandDTO;
-	children?: DraftBrandDTO[];
-	menus?: DraftMenuDTO[];
-	categories?: DraftCategoryDTO[];
-	category_to_item_relationships?: DraftCategoryToItemRelationshipDTO[];
-	items?: DraftItemDTO[];
-	item_to_modifier_group_relationships?: DraftItemToModifierGroupRelationshipDTO[];
-	modifier_groups?: DraftModifierGroupDTO[];
-	modifier_group_to_modifier_relationships?: DraftModifierGroupToModifierRelationshipDTO[];
-	modifiers?: DraftModifierDTO[];
-	statuses?: BrandStatusDTO[];
-	audit_logs?: AuditDTO[];
-	name: string;
-	description?: string;
-	is_active?: boolean;
-	type?: 'global' | 'local';
-	parent_id?: string;
-	local_menu_group_id?: string;
-	global_menu_group_id?: string;
-	posid_segment?: string;
-	is_simplified_view?: boolean;
-	frictionless_partner?: string;
-	catalog_id?: number;
-	applied_diff_snapshot?: Record<string, any>;
-	changes?: BrandChangeDTO[];
-	local_menu_group?: LocalMenuGroupDTO;
-	global_menu_group?: GlobalMenuGroupDTO;
-	vendor_metadata?: VendorMetadataDTO[];
-	attachments?: FileAttachmentsDTO;
-	permissions?: Record<string, any>;
-	[index: string]: any;
+	name?: string;
 }
 
 export interface PostMenuV4BrandResponse {
@@ -6909,7 +6824,6 @@ export interface PostMenuV4BrandResponse {
 	posid_segment?: string;
 	is_simplified_view?: boolean;
 	frictionless_partner?: string;
-	catalog_id?: number;
 	applied_diff_snapshot?: Record<string, any>;
 	version?: number;
 	changes?: BrandChangeDTO[];
@@ -6963,7 +6877,6 @@ export interface GetMenuV4BrandResponse {
 	posid_segment?: string;
 	is_simplified_view?: boolean;
 	frictionless_partner?: string;
-	catalog_id?: number;
 	applied_diff_snapshot?: Record<string, any>;
 	version?: number;
 	changes?: BrandChangeDTO[];
@@ -6979,98 +6892,3 @@ export interface GetMenuV4BrandRequest
 	extends BaseRequest,
 		RequestQuery<GetMenuV4BrandQuery>,
 		GetMenuV4BrandPath {}
-
-// POST /menu/v4/brand/{id}/menu
-
-export interface PostMenuV4BrandMenuPath {
-	id: string;
-}
-
-export interface PostMenuV4BrandMenuBody {
-	id?: string;
-	categories?: Record<string, any>;
-	brand_id?: string;
-	name?: string;
-	[index: string]: any;
-}
-
-export interface PostMenuV4BrandMenuResponse {
-	id?: string;
-	categories?: Record<string, any>;
-	brand_id?: string;
-	name?: string;
-	[index: string]: any;
-}
-
-export interface PostMenuV4BrandMenuRequest extends BaseRequest, PostMenuV4BrandMenuPath {
-	body: PostMenuV4BrandMenuBody;
-}
-
-// GET /menu/v4/brand/{id}/category/{category_id}/items
-
-export interface GetMenuV4BrandCategoryItemsPath {
-	id: string;
-	category_id: string;
-}
-
-export interface GetMenuV4BrandCategoryItemsQuery {
-	// If specified, only the selected fields will be returned
-	select?: string[];
-	// List of relationships to load alongside this entity. Can load nested relationships using the pattern 'children.grand_children.foo'
-	relationships?: string[];
-	// Number of records to load per page
-	limit?: number;
-	page?: number;
-	// A field to sort the results based on
-	sort_by?: string;
-	sort_order?: 'DESC' | 'ASC';
-	// How soft deleted records should be shown in the list
-	soft_deleted?: 'include' | 'exclude' | 'only';
-	// Graphql query string
-	_query?: string;
-}
-
-export interface GetMenuV4BrandCategoryItemsResponse {
-	results?: DraftItemEntityDTO[];
-}
-
-export interface GetMenuV4BrandCategoryItemsRequest
-	extends BaseRequest,
-		RequestQuery<GetMenuV4BrandCategoryItemsQuery>,
-		GetMenuV4BrandCategoryItemsPath {}
-
-// POST /menu/v4/brand/{id}/category
-
-export interface PostMenuV4BrandCategoryPath {
-	id: string;
-}
-
-export interface PostMenuV4BrandCategoryBody {
-	id?: string;
-	name: string;
-	label?: string;
-	sequence?: number;
-	is_active?: boolean;
-	brand_id: string;
-	menu_id: string;
-	items?: Record<string, any>;
-	attachments?: Record<string, any>;
-	[index: string]: any;
-}
-
-export interface PostMenuV4BrandCategoryResponse {
-	id?: string;
-	name: string;
-	label?: string;
-	sequence?: number;
-	is_active?: boolean;
-	brand_id: string;
-	menu_id: string;
-	items?: Record<string, any>;
-	attachments?: Record<string, any>;
-	[index: string]: any;
-}
-
-export interface PostMenuV4BrandCategoryRequest extends BaseRequest, PostMenuV4BrandCategoryPath {
-	body: PostMenuV4BrandCategoryBody;
-}

package/src/interface/order.ts

@@ -237,7 +237,8 @@ export interface Order {
 		| 'items_unavailable'
 		| 'refunded_order'
 		| 'modifiers_unavailable'
-		| 'modified_items';
+		| 'modified_items'
+		| 'cancelled_order';
 	refunds?: RefundItem[];
 	latest_refunds?: RefundItem[];
 	[index: string]: any;

package/src/interface/shoppingcart.ts

@@ -117,11 +117,15 @@ export interface ModifierGroupResponse {
 	meta?: {
 		taxes?: string[];
 		original_label?: Label;
+		order_type?: 'selection' | 'option' | 'quantity';
+		surchage_limit_value?: number;
 		[index: string]: any;
 	};
 	items?: ModifierResponse[];
 	is?: {
 		disabled?: boolean;
+		incremental?: boolean;
+		surchage_limit?: boolean;
 	};
 }
 
@@ -171,6 +175,7 @@ export interface Taxes {
 		combined_tax_rate?: MonetaryValue;
 		gst?: MonetaryValue;
 		pst?: MonetaryValue;
+		provider?: string;
 		[index: string]: any;
 	};
 	provider?: string;