@compassdigital/sdk.typescript 4.92.0 → 4.94.0

package/src/index.ts

@@ -652,6 +652,8 @@ import {
 	PostMenuV3DraftMenuPublishResponse,
 	GetMenuV3DraftMenusVerifyPublishQuery,
 	GetMenuV3DraftMenusVerifyPublishResponse,
+	PostMenuV3DraftMenuDuplicateBody,
+	PostMenuV3DraftMenuDuplicateResponse,
 	GetMenuV3MenuQuery,
 	GetMenuV3MenuResponse,
 	GetMenuV3MenusQuery,
@@ -679,6 +681,8 @@ import {
 	PostMenuV3DraftCategoryRecoverResponse,
 	PostMenuV3DraftCategoryAttachmentQuery,
 	PostMenuV3DraftCategoryAttachmentResponse,
+	PostMenuV3DraftCategoryDuplicateBody,
+	PostMenuV3DraftCategoryDuplicateResponse,
 	GetMenuV3CategoryQuery,
 	GetMenuV3CategoryResponse,
 	GetMenuV3CategorysCountQuery,
@@ -873,6 +877,44 @@ import {
 	PostMenuV4BrandResponse,
 	GetMenuV4BrandQuery,
 	GetMenuV4BrandResponse,
+	PostMenuV4BrandMenuBody,
+	PostMenuV4BrandMenuResponse,
+	GetMenuV4BrandItemsQuery,
+	GetMenuV4BrandItemsResponse,
+	GetMenuV4BrandModifierGroupsQuery,
+	GetMenuV4BrandModifierGroupsResponse,
+	GetMenuV4BrandModifiersQuery,
+	GetMenuV4BrandModifiersResponse,
+	GetMenuV4BrandCategoryItemsQuery,
+	GetMenuV4BrandCategoryItemsResponse,
+	PostMenuV4BrandCategoryBody,
+	PostMenuV4BrandCategoryResponse,
+	PatchMenuV4BrandCategoryBody,
+	PatchMenuV4BrandCategoryResponse,
+	PostMenuV4BrandCategoryAttachItemsBody,
+	PostMenuV4BrandCategoryAttachItemsResponse,
+	PostMenuV4BrandPublishResponse,
+	PostMenuV4BrandV3ToV4Response,
+	PostMenuV4ItemBody,
+	PostMenuV4ItemResponse,
+	GetMenuV4ItemQuery,
+	GetMenuV4ItemResponse,
+	PatchMenuV4ItemBody,
+	PatchMenuV4ItemResponse,
+	PostMenuV4ModifierBody,
+	PostMenuV4ModifierResponse,
+	GetMenuV4ModifierQuery,
+	GetMenuV4ModifierResponse,
+	PatchMenuV4ModifierBody,
+	PatchMenuV4ModifierResponse,
+	PostMenuV4ModifierGroupBody,
+	PostMenuV4ModifierGroupResponse,
+	GetMenuV4ModifierGroupQuery,
+	GetMenuV4ModifierGroupResponse,
+	PatchMenuV4ModifierGroupBody,
+	PatchMenuV4ModifierGroupResponse,
+	PostMenuV4ModifierGroupAttachModifiersBody,
+	PostMenuV4ModifierGroupAttachModifiersResponse,
 } from './interface/menu';
 
 import {
@@ -1420,7 +1462,7 @@ export class ServiceClient extends BaseServiceClient {
 	 * PATCH /order/{id}/cancel - Cancel and issue a refund on an existing order
 	 *
 	 * @param id - The order ID
-	 * @param body - Items with pricing and quanitity to be refunded
+	 * @param body - Reason for cancellation
 	 * @param options - additional request options
 	 */
 	patch_order_cancel(
@@ -6875,6 +6917,28 @@ export class ServiceClient extends BaseServiceClient {
 		);
 	}
 
+	/**
+	 * POST /menu/v3/draft/menu/{id}/duplicate
+	 *
+	 * @param id
+	 * @param body - Optional properties to be updated on the duplicated menu.
+	 * @param options - additional request options
+	 */
+	post_menu_v3_draft_menu_duplicate(
+		id: string,
+		body: PostMenuV3DraftMenuDuplicateBody,
+		options?: RequestOptions,
+	): ResponsePromise<PostMenuV3DraftMenuDuplicateResponse> {
+		return this.request(
+			'menu',
+			'/menu/v3/draft/menu/{id}/duplicate',
+			'post',
+			`/menu/v3/draft/menu/${id}/duplicate`,
+			body,
+			options,
+		);
+	}
+
 	/**
 	 * GET /menu/v3/menu/{id}
 	 *
@@ -7159,6 +7223,28 @@ export class ServiceClient extends BaseServiceClient {
 		);
 	}
 
+	/**
+	 * POST /menu/v3/draft/category/{id}/duplicate
+	 *
+	 * @param id
+	 * @param body - Optional properties to be updated on the duplicated category.
+	 * @param options - additional request options
+	 */
+	post_menu_v3_draft_category_duplicate(
+		id: string,
+		body: PostMenuV3DraftCategoryDuplicateBody,
+		options?: RequestOptions,
+	): ResponsePromise<PostMenuV3DraftCategoryDuplicateResponse> {
+		return this.request(
+			'menu',
+			'/menu/v3/draft/category/{id}/duplicate',
+			'post',
+			`/menu/v3/draft/category/${id}/duplicate`,
+			body,
+			options,
+		);
+	}
+
 	/**
 	 * GET /menu/v3/category/{id}
 	 *
@@ -9228,6 +9314,419 @@ export class ServiceClient extends BaseServiceClient {
 		);
 	}
 
+	/**
+	 * POST /menu/v4/brand/{id}/menu
+	 *
+	 * @param id
+	 * @param body
+	 * @param options - additional request options
+	 */
+	post_menu_v4_brand_menu(
+		id: string,
+		body: PostMenuV4BrandMenuBody,
+		options?: RequestOptions,
+	): ResponsePromise<PostMenuV4BrandMenuResponse> {
+		return this.request(
+			'menu',
+			'/menu/v4/brand/{id}/menu',
+			'post',
+			`/menu/v4/brand/${id}/menu`,
+			body,
+			options,
+		);
+	}
+
+	/**
+	 * GET /menu/v4/brand/{id}/items
+	 *
+	 * @param id
+	 * @param options - additional request options
+	 */
+	get_menu_v4_brand_items(
+		id: string,
+		options?: {
+			query?: GetMenuV4BrandItemsQuery;
+		} & RequestOptions,
+	): ResponsePromise<GetMenuV4BrandItemsResponse> {
+		return this.request(
+			'menu',
+			'/menu/v4/brand/{id}/items',
+			'get',
+			`/menu/v4/brand/${id}/items`,
+			null,
+			options,
+		);
+	}
+
+	/**
+	 * GET /menu/v4/brand/{id}/modifier-groups
+	 *
+	 * @param id
+	 * @param options - additional request options
+	 */
+	get_menu_v4_brand_modifier_groups(
+		id: string,
+		options?: {
+			query?: GetMenuV4BrandModifierGroupsQuery;
+		} & RequestOptions,
+	): ResponsePromise<GetMenuV4BrandModifierGroupsResponse> {
+		return this.request(
+			'menu',
+			'/menu/v4/brand/{id}/modifier-groups',
+			'get',
+			`/menu/v4/brand/${id}/modifier-groups`,
+			null,
+			options,
+		);
+	}
+
+	/**
+	 * GET /menu/v4/brand/{id}/modifiers
+	 *
+	 * @param id
+	 * @param options - additional request options
+	 */
+	get_menu_v4_brand_modifiers(
+		id: string,
+		options?: {
+			query?: GetMenuV4BrandModifiersQuery;
+		} & RequestOptions,
+	): ResponsePromise<GetMenuV4BrandModifiersResponse> {
+		return this.request(
+			'menu',
+			'/menu/v4/brand/{id}/modifiers',
+			'get',
+			`/menu/v4/brand/${id}/modifiers`,
+			null,
+			options,
+		);
+	}
+
+	/**
+	 * GET /menu/v4/brand/{id}/category/{category_id}/items
+	 *
+	 * @param id
+	 * @param category_id
+	 * @param options - additional request options
+	 */
+	get_menu_v4_brand_category_items(
+		id: string,
+		category_id: string,
+		options?: {
+			query?: GetMenuV4BrandCategoryItemsQuery;
+		} & RequestOptions,
+	): ResponsePromise<GetMenuV4BrandCategoryItemsResponse> {
+		return this.request(
+			'menu',
+			'/menu/v4/brand/{id}/category/{category_id}/items',
+			'get',
+			`/menu/v4/brand/${id}/category/${category_id}/items`,
+			null,
+			options,
+		);
+	}
+
+	/**
+	 * POST /menu/v4/brand/{id}/category
+	 *
+	 * @param id
+	 * @param body
+	 * @param options - additional request options
+	 */
+	post_menu_v4_brand_category(
+		id: string,
+		body: PostMenuV4BrandCategoryBody,
+		options?: RequestOptions,
+	): ResponsePromise<PostMenuV4BrandCategoryResponse> {
+		return this.request(
+			'menu',
+			'/menu/v4/brand/{id}/category',
+			'post',
+			`/menu/v4/brand/${id}/category`,
+			body,
+			options,
+		);
+	}
+
+	/**
+	 * PATCH /menu/v4/brand/{brand_id}/category/{category_id}
+	 *
+	 * @param brand_id
+	 * @param category_id
+	 * @param body
+	 * @param options - additional request options
+	 */
+	patch_menu_v4_brand_category(
+		brand_id: string,
+		category_id: string,
+		body: PatchMenuV4BrandCategoryBody,
+		options?: RequestOptions,
+	): ResponsePromise<PatchMenuV4BrandCategoryResponse> {
+		return this.request(
+			'menu',
+			'/menu/v4/brand/{brand_id}/category/{category_id}',
+			'patch',
+			`/menu/v4/brand/${brand_id}/category/${category_id}`,
+			body,
+			options,
+		);
+	}
+
+	/**
+	 * POST /menu/v4/brand/{id}/category/attach-items
+	 *
+	 * @param id
+	 * @param body
+	 * @param options - additional request options
+	 */
+	post_menu_v4_brand_category_attach_items(
+		id: string,
+		body: PostMenuV4BrandCategoryAttachItemsBody,
+		options?: RequestOptions,
+	): ResponsePromise<PostMenuV4BrandCategoryAttachItemsResponse> {
+		return this.request(
+			'menu',
+			'/menu/v4/brand/{id}/category/attach-items',
+			'post',
+			`/menu/v4/brand/${id}/category/attach-items`,
+			body,
+			options,
+		);
+	}
+
+	/**
+	 * POST menu/v4/brand/{id}/publish
+	 *
+	 * @param id
+	 * @param options - additional request options
+	 */
+	post_menu_v4_brand_publish(
+		id: string,
+		options?: RequestOptions,
+	): ResponsePromise<PostMenuV4BrandPublishResponse> {
+		return this.request(
+			'menu',
+			'menu/v4/brand/{id}/publish',
+			'post',
+			`menu/v4/brand/${id}/publish`,
+			null,
+			options,
+		);
+	}
+
+	/**
+	 * POST menu/v4/brand/{id}/v3-to-v4
+	 *
+	 * @param id
+	 * @param options - additional request options
+	 */
+	post_menu_v4_brand_v3_to_v4(
+		id: string,
+		options?: RequestOptions,
+	): ResponsePromise<PostMenuV4BrandV3ToV4Response> {
+		return this.request(
+			'menu',
+			'menu/v4/brand/{id}/v3-to-v4',
+			'post',
+			`menu/v4/brand/${id}/v3-to-v4`,
+			null,
+			options,
+		);
+	}
+
+	/**
+	 * POST /menu/v4/item
+	 *
+	 * @param body
+	 * @param options - additional request options
+	 */
+	post_menu_v4_item(
+		body: PostMenuV4ItemBody,
+		options?: RequestOptions,
+	): ResponsePromise<PostMenuV4ItemResponse> {
+		return this.request('menu', '/menu/v4/item', 'post', `/menu/v4/item`, body, options);
+	}
+
+	/**
+	 * GET /menu/v4/item/{id}
+	 *
+	 * @param id
+	 * @param options - additional request options
+	 */
+	get_menu_v4_item(
+		id: string,
+		options?: {
+			query?: GetMenuV4ItemQuery;
+		} & RequestOptions,
+	): ResponsePromise<GetMenuV4ItemResponse> {
+		return this.request('menu', '/menu/v4/item/{id}', 'get', `/menu/v4/item/${id}`, null, options);
+	}
+
+	/**
+	 * PATCH /menu/v4/item/{id}
+	 *
+	 * @param id
+	 * @param body
+	 * @param options - additional request options
+	 */
+	patch_menu_v4_item(
+		id: string,
+		body: PatchMenuV4ItemBody,
+		options?: RequestOptions,
+	): ResponsePromise<PatchMenuV4ItemResponse> {
+		return this.request(
+			'menu',
+			'/menu/v4/item/{id}',
+			'patch',
+			`/menu/v4/item/${id}`,
+			body,
+			options,
+		);
+	}
+
+	/**
+	 * POST /menu/v4/modifier
+	 *
+	 * @param body
+	 * @param options - additional request options
+	 */
+	post_menu_v4_modifier(
+		body: PostMenuV4ModifierBody,
+		options?: RequestOptions,
+	): ResponsePromise<PostMenuV4ModifierResponse> {
+		return this.request('menu', '/menu/v4/modifier', 'post', `/menu/v4/modifier`, body, options);
+	}
+
+	/**
+	 * GET /menu/v4/modifier/{id}
+	 *
+	 * @param id
+	 * @param options - additional request options
+	 */
+	get_menu_v4_modifier(
+		id: string,
+		options?: {
+			query?: GetMenuV4ModifierQuery;
+		} & RequestOptions,
+	): ResponsePromise<GetMenuV4ModifierResponse> {
+		return this.request(
+			'menu',
+			'/menu/v4/modifier/{id}',
+			'get',
+			`/menu/v4/modifier/${id}`,
+			null,
+			options,
+		);
+	}
+
+	/**
+	 * PATCH /menu/v4/modifier/{id}
+	 *
+	 * @param id
+	 * @param body
+	 * @param options - additional request options
+	 */
+	patch_menu_v4_modifier(
+		id: string,
+		body: PatchMenuV4ModifierBody,
+		options?: RequestOptions,
+	): ResponsePromise<PatchMenuV4ModifierResponse> {
+		return this.request(
+			'menu',
+			'/menu/v4/modifier/{id}',
+			'patch',
+			`/menu/v4/modifier/${id}`,
+			body,
+			options,
+		);
+	}
+
+	/**
+	 * POST /menu/v4/modifier-group
+	 *
+	 * @param body
+	 * @param options - additional request options
+	 */
+	post_menu_v4_modifier_group(
+		body: PostMenuV4ModifierGroupBody,
+		options?: RequestOptions,
+	): ResponsePromise<PostMenuV4ModifierGroupResponse> {
+		return this.request(
+			'menu',
+			'/menu/v4/modifier-group',
+			'post',
+			`/menu/v4/modifier-group`,
+			body,
+			options,
+		);
+	}
+
+	/**
+	 * GET /menu/v4/modifier-group/{id}
+	 *
+	 * @param id
+	 * @param options - additional request options
+	 */
+	get_menu_v4_modifier_group(
+		id: string,
+		options?: {
+			query?: GetMenuV4ModifierGroupQuery;
+		} & RequestOptions,
+	): ResponsePromise<GetMenuV4ModifierGroupResponse> {
+		return this.request(
+			'menu',
+			'/menu/v4/modifier-group/{id}',
+			'get',
+			`/menu/v4/modifier-group/${id}`,
+			null,
+			options,
+		);
+	}
+
+	/**
+	 * PATCH /menu/v4/modifier-group/{id}
+	 *
+	 * @param id
+	 * @param body
+	 * @param options - additional request options
+	 */
+	patch_menu_v4_modifier_group(
+		id: string,
+		body: PatchMenuV4ModifierGroupBody,
+		options?: RequestOptions,
+	): ResponsePromise<PatchMenuV4ModifierGroupResponse> {
+		return this.request(
+			'menu',
+			'/menu/v4/modifier-group/{id}',
+			'patch',
+			`/menu/v4/modifier-group/${id}`,
+			body,
+			options,
+		);
+	}
+
+	/**
+	 * POST /menu/v4/modifier-group/{id}/attach-modifiers
+	 *
+	 * @param id
+	 * @param body
+	 * @param options - additional request options
+	 */
+	post_menu_v4_modifier_group_attach_modifiers(
+		id: string,
+		body: PostMenuV4ModifierGroupAttachModifiersBody,
+		options?: RequestOptions,
+	): ResponsePromise<PostMenuV4ModifierGroupAttachModifiersResponse> {
+		return this.request(
+			'menu',
+			'/menu/v4/modifier-group/{id}/attach-modifiers',
+			'post',
+			`/menu/v4/modifier-group/${id}/attach-modifiers`,
+			body,
+			options,
+		);
+	}
+
 	/**
 	 * GET /notification - Get all notifications
 	 *

package/src/interface/announcement.ts

@@ -13,21 +13,45 @@ export interface Success {
 	success?: boolean;
 }
 
-export interface AnnouncementRequest {
+export interface AnnouncementPostRequestBody {
 	// Name of Announcement
 	name: string;
 	// Announcement Type
 	type: string;
-	key: string;
 	// App name
-	app: string;
+	app: 'Boost' | 'Thrive' | 'Nourish' | 'JJKitchen' | 'Rogers';
 	// True if all the sites are linked
 	is_global?: boolean;
 	allowed_resources?: string[];
 	position: number;
-	active: boolean;
+	//@deprecated
+	active?: boolean;
+	// Status of the announcement
+	status?: 'draft' | 'active' | 'disabled';
 	// Announcement Properties
-	info: {
+	info?: {
+		en?: AnnouncementInfo;
+		fr?: AnnouncementInfo;
+	};
+	schedule?: Schedule;
+	[index: string]: any;
+}
+
+export interface AnnouncementPutRequestBody {
+	// Name of Announcement
+	name: string;
+	// Announcement Type
+	type: string;
+	// True if all the sites are linked
+	is_global?: boolean;
+	allowed_resources?: string[];
+	position: number;
+	//@deprecated
+	active?: boolean;
+	// Status of the announcement
+	status?: 'draft' | 'active' | 'disabled';
+	// Announcement Properties
+	info?: {
 		en?: AnnouncementInfo;
 		fr?: AnnouncementInfo;
 	};
@@ -40,14 +64,14 @@ export interface AnnouncementPatchRequestBody {
 	name?: string;
 	// Announcement Type
 	type?: string;
-	key?: string;
-	// App name
-	app?: string;
 	// True if all the sites are linked
 	is_global?: boolean;
 	allowed_resources?: string[];
 	position?: number;
+	//@deprecated
 	active?: boolean;
+	// Status of the announcement
+	status?: 'draft' | 'active' | 'disabled';
 	// Announcement Properties
 	info?: {
 		en?: AnnouncementInfo;
@@ -65,11 +89,14 @@ export interface Announcement {
 	type: string;
 	key: string;
 	// App name
-	app: string;
+	app: 'Boost' | 'Thrive' | 'Nourish' | 'JJKitchen' | 'Rogers';
 	// True if all the sites are linked
 	is_global: boolean;
 	allowed_resources: string[];
+	//@deprecated
 	active: boolean;
+	// Status of the announcement
+	status?: 'draft' | 'active' | 'disabled';
 	schedule: Schedule;
 	// Date created
 	created_at: string;
@@ -117,18 +144,20 @@ export interface Schedule {
 	// If true, refer to `sites`, if false, refer to start/end times below
 	variable: boolean;
 	start_datetime?: string;
+	// Maximum 1 year from today
 	end_datetime?: string;
 	sites?: {
 		// group
 		id: string;
 		start_datetime: string;
+		// Maximum 1 year from today
 		end_datetime: string;
 	}[];
 }
 
 // POST /announcement - Create Announcement
 
-export type PostAnnouncementBody = AnnouncementRequest;
+export type PostAnnouncementBody = AnnouncementPostRequestBody;
 
 export type PostAnnouncementResponse = Announcement;
 
@@ -204,7 +233,7 @@ export interface PutAnnouncementPath {
 	id: string;
 }
 
-export type PutAnnouncementBody = AnnouncementRequest;
+export type PutAnnouncementBody = AnnouncementPutRequestBody;
 
 export type PutAnnouncementResponse = Announcement;
 

package/src/interface/calendar.ts

@@ -69,7 +69,6 @@ export interface OperationHours {
 }
 
 export interface Hours {
-	// hours
 	id?: string;
 	date?: {
 		deleted?: string;
@@ -84,7 +83,6 @@ export interface Hours {
 }
 
 export interface MenuHours {
-	// menu
 	id?: string;
 	label?: {
 		en?: string;