@compassdigital/sdk.typescript 4.96.0 → 4.98.0

package/src/index.ts

@@ -691,6 +691,8 @@ import {
 	PostMenuV3DraftCategoryAttachmentResponse,
 	PostMenuV3DraftCategoryDuplicateBody,
 	PostMenuV3DraftCategoryDuplicateResponse,
+	GetMenuV3DraftCategoryUnattachedItemsQuery,
+	GetMenuV3DraftCategoryUnattachedItemsResponse,
 	GetMenuV3CategoryQuery,
 	GetMenuV3CategoryResponse,
 	GetMenuV3CategorysCountQuery,
@@ -885,10 +887,12 @@ import {
 	PostMenuV4BrandResponse,
 	GetMenuV4BrandQuery,
 	GetMenuV4BrandResponse,
+	DeleteMenuV4BrandResponse,
 	PostMenuV4BrandMenuBody,
 	PostMenuV4BrandMenuResponse,
 	PatchMenuV4BrandMenuBody,
 	PatchMenuV4BrandMenuResponse,
+	DeleteMenuV4BrandMenuResponse,
 	GetMenuV4BrandItemsQuery,
 	GetMenuV4BrandItemsResponse,
 	GetMenuV4BrandModifierGroupsQuery,
@@ -901,13 +905,19 @@ import {
 	PostMenuV4BrandCategoryResponse,
 	PatchMenuV4BrandCategoryBody,
 	PatchMenuV4BrandCategoryResponse,
+	DeleteMenuV4BrandCategoryResponse,
 	PostMenuV4BrandCategoryAttachItemsBody,
 	PostMenuV4BrandCategoryAttachItemsResponse,
 	PostMenuV4BrandPublishResponse,
 	PostMenuV4BrandV3ToV4Response,
-	DeleteMenuV4BrandResponse,
-	DeleteMenuV4BrandMenuResponse,
-	DeleteMenuV4BrandCategoryResponse,
+	PostMenuV4BrandCategoryDuplicateBody,
+	PostMenuV4BrandCategoryDuplicateResponse,
+	PostMenuV4BrandMenuDuplicateBody,
+	PostMenuV4BrandMenuDuplicateResponse,
+	PostMenuV4CategoryAttachmentQuery,
+	PostMenuV4CategoryAttachmentResponse,
+	PostMenuV4ItemAttachmentQuery,
+	PostMenuV4ItemAttachmentResponse,
 	PostMenuV4ItemBody,
 	PostMenuV4ItemResponse,
 	GetMenuV4ItemQuery,
@@ -915,6 +925,10 @@ import {
 	PatchMenuV4ItemBody,
 	PatchMenuV4ItemResponse,
 	DeleteMenuV4ItemResponse,
+	PatchMenuV4ItemsBulkUpdateBody,
+	PatchMenuV4ItemsBulkUpdateResponse,
+	PostMenuV4ItemDuplicateBody,
+	PostMenuV4ItemDuplicateResponse,
 	PostMenuV4ModifierBody,
 	PostMenuV4ModifierResponse,
 	GetMenuV4ModifierQuery,
@@ -922,6 +936,12 @@ import {
 	PatchMenuV4ModifierBody,
 	PatchMenuV4ModifierResponse,
 	DeleteMenuV4ModifierResponse,
+	PostMenuV4ModifierDuplicateBody,
+	PostMenuV4ModifierDuplicateResponse,
+	PatchMenuV4ModifiersBulkUpdateBody,
+	PatchMenuV4ModifiersBulkUpdateResponse,
+	PostMenuV4ModifierAttachmentQuery,
+	PostMenuV4ModifierAttachmentResponse,
 	PostMenuV4ModifierGroupBody,
 	PostMenuV4ModifierGroupResponse,
 	GetMenuV4ModifierGroupQuery,
@@ -931,6 +951,9 @@ import {
 	DeleteMenuV4ModifierGroupResponse,
 	PostMenuV4ModifierGroupAttachModifiersBody,
 	PostMenuV4ModifierGroupAttachModifiersResponse,
+	PostMenuV4ModifierGroupDuplicateQuery,
+	PostMenuV4ModifierGroupDuplicateBody,
+	PostMenuV4ModifierGroupDuplicateResponse,
 } from './interface/menu';
 
 import {
@@ -1017,8 +1040,8 @@ import {
 	GetPaymentListByBrandResponse,
 	GetCustomerOrdersQuery,
 	GetCustomerOrdersResponse,
-	PostReviewOrderItemRatingsBody,
-	PostReviewOrderItemRatingsResponse,
+	PostReviewOrderItemsBody,
+	PostReviewOrderItemsResponse,
 } from './interface/consumer';
 
 import {
@@ -1086,6 +1109,15 @@ import {
 	GetAuthSsoExchangeResponse,
 } from './interface/auth';
 
+import {
+	GetReviewsQuery,
+	GetReviewsResponse,
+	PostReviewBody,
+	PostReviewResponse,
+	GetReviewQuery,
+	GetReviewResponse,
+} from './interface/review';
+
 import { BaseServiceClient, RequestOptions, ResponsePromise } from './base';
 export * from './base';
 
@@ -7339,6 +7371,28 @@ export class ServiceClient extends BaseServiceClient {
 		);
 	}
 
+	/**
+	 * GET /menu/v3/draft/category/{id}/unattached_items
+	 *
+	 * @param id
+	 * @param options - additional request options
+	 */
+	get_menu_v3_draft_category_unattached_items(
+		id: string,
+		options?: {
+			query?: GetMenuV3DraftCategoryUnattachedItemsQuery;
+		} & RequestOptions,
+	): ResponsePromise<GetMenuV3DraftCategoryUnattachedItemsResponse> {
+		return this.request(
+			'menu',
+			'/menu/v3/draft/category/{id}/unattached_items',
+			'get',
+			`/menu/v3/draft/category/${id}/unattached_items`,
+			null,
+			options,
+		);
+	}
+
 	/**
 	 * GET /menu/v3/category/{id}
 	 *
@@ -9408,6 +9462,26 @@ export class ServiceClient extends BaseServiceClient {
 		);
 	}
 
+	/**
+	 * DELETE /menu/v4/brand/{id}
+	 *
+	 * @param id
+	 * @param options - additional request options
+	 */
+	delete_menu_v4_brand(
+		id: string,
+		options?: RequestOptions,
+	): ResponsePromise<DeleteMenuV4BrandResponse> {
+		return this.request(
+			'menu',
+			'/menu/v4/brand/{id}',
+			'delete',
+			`/menu/v4/brand/${id}`,
+			null,
+			options,
+		);
+	}
+
 	/**
 	 * POST /menu/v4/brand/{id}/menu
 	 *
@@ -9454,6 +9528,28 @@ export class ServiceClient extends BaseServiceClient {
 		);
 	}
 
+	/**
+	 * DELETE /menu/v4/brand/{brand_id}/menu/{menu_id}
+	 *
+	 * @param brand_id
+	 * @param menu_id
+	 * @param options - additional request options
+	 */
+	delete_menu_v4_brand_menu(
+		brand_id: string,
+		menu_id: string,
+		options?: RequestOptions,
+	): ResponsePromise<DeleteMenuV4BrandMenuResponse> {
+		return this.request(
+			'menu',
+			'/menu/v4/brand/{brand_id}/menu/{menu_id}',
+			'delete',
+			`/menu/v4/brand/${brand_id}/menu/${menu_id}`,
+			null,
+			options,
+		);
+	}
+
 	/**
 	 * GET /menu/v4/brand/{id}/items
 	 *
@@ -9590,6 +9686,28 @@ export class ServiceClient extends BaseServiceClient {
 		);
 	}
 
+	/**
+	 * DELETE /menu/v4/brand/{brand_id}/category/{category_id}
+	 *
+	 * @param brand_id
+	 * @param category_id
+	 * @param options - additional request options
+	 */
+	delete_menu_v4_brand_category(
+		brand_id: string,
+		category_id: string,
+		options?: RequestOptions,
+	): ResponsePromise<DeleteMenuV4BrandCategoryResponse> {
+		return this.request(
+			'menu',
+			'/menu/v4/brand/{brand_id}/category/{category_id}',
+			'delete',
+			`/menu/v4/brand/${brand_id}/category/${category_id}`,
+			null,
+			options,
+		);
+	}
+
 	/**
 	 * POST /menu/v4/brand/{id}/category/attach-items
 	 *
@@ -9613,7 +9731,7 @@ export class ServiceClient extends BaseServiceClient {
 	}
 
 	/**
-	 * POST menu/v4/brand/{id}/publish
+	 * POST /menu/v4/brand/{id}/publish
 	 *
 	 * @param id
 	 * @param options - additional request options
@@ -9624,16 +9742,16 @@ export class ServiceClient extends BaseServiceClient {
 	): ResponsePromise<PostMenuV4BrandPublishResponse> {
 		return this.request(
 			'menu',
-			'menu/v4/brand/{id}/publish',
+			'/menu/v4/brand/{id}/publish',
 			'post',
-			`menu/v4/brand/${id}/publish`,
+			`/menu/v4/brand/${id}/publish`,
 			null,
 			options,
 		);
 	}
 
 	/**
-	 * POST menu/v4/brand/{id}/v3-to-v4
+	 * POST /menu/v4/brand/{id}/v3-to-v4
 	 *
 	 * @param id
 	 * @param options - additional request options
@@ -9644,73 +9762,105 @@ export class ServiceClient extends BaseServiceClient {
 	): ResponsePromise<PostMenuV4BrandV3ToV4Response> {
 		return this.request(
 			'menu',
-			'menu/v4/brand/{id}/v3-to-v4',
+			'/menu/v4/brand/{id}/v3-to-v4',
 			'post',
-			`menu/v4/brand/${id}/v3-to-v4`,
+			`/menu/v4/brand/${id}/v3-to-v4`,
 			null,
 			options,
 		);
 	}
 
 	/**
-	 * DELETE menu/v4/brand/{id}
+	 * POST /menu/v4/brand/{brand_id}/category/{category_id}/duplicate
 	 *
-	 * @param id
+	 * @param brand_id
+	 * @param category_id
+	 * @param body
 	 * @param options - additional request options
 	 */
-	delete_menu_v4_brand(
-		id: string,
+	post_menu_v4_brand_category_duplicate(
+		brand_id: string,
+		category_id: string,
+		body: PostMenuV4BrandCategoryDuplicateBody,
 		options?: RequestOptions,
-	): ResponsePromise<DeleteMenuV4BrandResponse> {
+	): ResponsePromise<PostMenuV4BrandCategoryDuplicateResponse> {
 		return this.request(
 			'menu',
-			'menu/v4/brand/{id}',
-			'delete',
-			`menu/v4/brand/${id}`,
-			null,
+			'/menu/v4/brand/{brand_id}/category/{category_id}/duplicate',
+			'post',
+			`/menu/v4/brand/${brand_id}/category/${category_id}/duplicate`,
+			body,
 			options,
 		);
 	}
 
 	/**
-	 * DELETE menu/v4/brand/{brand_id}/menu/{menu_id}
+	 * POST /menu/v4/brand/{brand_id}/menu/{menu_id}/duplicate
 	 *
 	 * @param brand_id
 	 * @param menu_id
+	 * @param body
 	 * @param options - additional request options
 	 */
-	delete_menu_v4_brand_menu(
+	post_menu_v4_brand_menu_duplicate(
 		brand_id: string,
 		menu_id: string,
+		body: PostMenuV4BrandMenuDuplicateBody,
 		options?: RequestOptions,
-	): ResponsePromise<DeleteMenuV4BrandMenuResponse> {
+	): ResponsePromise<PostMenuV4BrandMenuDuplicateResponse> {
 		return this.request(
 			'menu',
-			'menu/v4/brand/{brand_id}/menu/{menu_id}',
-			'delete',
-			`menu/v4/brand/${brand_id}/menu/${menu_id}`,
+			'/menu/v4/brand/{brand_id}/menu/{menu_id}/duplicate',
+			'post',
+			`/menu/v4/brand/${brand_id}/menu/${menu_id}/duplicate`,
+			body,
+			options,
+		);
+	}
+
+	/**
+	 * POST /menu/v4/category/{id}/attachment/{name}
+	 *
+	 * @param id
+	 * @param name
+	 * @param options - additional request options
+	 */
+	post_menu_v4_category_attachment(
+		id: string,
+		name: 'thumbnail',
+		options?: {
+			query?: PostMenuV4CategoryAttachmentQuery;
+		} & RequestOptions,
+	): ResponsePromise<PostMenuV4CategoryAttachmentResponse> {
+		return this.request(
+			'menu',
+			'/menu/v4/category/{id}/attachment/{name}',
+			'post',
+			`/menu/v4/category/${id}/attachment/${name}`,
 			null,
 			options,
 		);
 	}
 
 	/**
-	 * DELETE menu/v4/brand/{brand_id}/category/{category_id}
+	 * POST /menu/v4/item/{id}/attachment/{name}
 	 *
-	 * @param brand_id
-	 * @param category_id
+	 * @param id
+	 * @param name
 	 * @param options - additional request options
 	 */
-	delete_menu_v4_brand_category(
-		brand_id: string,
-		category_id: string,
-		options?: RequestOptions,
-	): ResponsePromise<DeleteMenuV4BrandCategoryResponse> {
+	post_menu_v4_item_attachment(
+		id: string,
+		name: 'thumbnail',
+		options?: {
+			query?: PostMenuV4ItemAttachmentQuery;
+		} & RequestOptions,
+	): ResponsePromise<PostMenuV4ItemAttachmentResponse> {
 		return this.request(
 			'menu',
-			'menu/v4/brand/{brand_id}/category/{category_id}',
-			'delete',
-			`menu/v4/brand/${brand_id}/category/${category_id}`,
+			'/menu/v4/item/{id}/attachment/{name}',
+			'post',
+			`/menu/v4/item/${id}/attachment/${name}`,
 			null,
 			options,
 		);
@@ -9786,6 +9936,48 @@ export class ServiceClient extends BaseServiceClient {
 		);
 	}
 
+	/**
+	 * PATCH /menu/v4/items/bulk-update
+	 *
+	 * @param body
+	 * @param options - additional request options
+	 */
+	patch_menu_v4_items_bulk_update(
+		body: PatchMenuV4ItemsBulkUpdateBody,
+		options?: RequestOptions,
+	): ResponsePromise<PatchMenuV4ItemsBulkUpdateResponse> {
+		return this.request(
+			'menu',
+			'/menu/v4/items/bulk-update',
+			'patch',
+			`/menu/v4/items/bulk-update`,
+			body,
+			options,
+		);
+	}
+
+	/**
+	 * POST /menu/v4/item/{id}/duplicate
+	 *
+	 * @param id
+	 * @param body
+	 * @param options - additional request options
+	 */
+	post_menu_v4_item_duplicate(
+		id: string,
+		body: PostMenuV4ItemDuplicateBody,
+		options?: RequestOptions,
+	): ResponsePromise<PostMenuV4ItemDuplicateResponse> {
+		return this.request(
+			'menu',
+			'/menu/v4/item/{id}/duplicate',
+			'post',
+			`/menu/v4/item/${id}/duplicate`,
+			body,
+			options,
+		);
+	}
+
 	/**
 	 * POST /menu/v4/modifier
 	 *
@@ -9863,6 +10055,72 @@ export class ServiceClient extends BaseServiceClient {
 		);
 	}
 
+	/**
+	 * POST /menu/v4/modifier/{id}/duplicate
+	 *
+	 * @param id
+	 * @param body
+	 * @param options - additional request options
+	 */
+	post_menu_v4_modifier_duplicate(
+		id: string,
+		body: PostMenuV4ModifierDuplicateBody,
+		options?: RequestOptions,
+	): ResponsePromise<PostMenuV4ModifierDuplicateResponse> {
+		return this.request(
+			'menu',
+			'/menu/v4/modifier/{id}/duplicate',
+			'post',
+			`/menu/v4/modifier/${id}/duplicate`,
+			body,
+			options,
+		);
+	}
+
+	/**
+	 * PATCH /menu/v4/modifiers/bulk-update
+	 *
+	 * @param body
+	 * @param options - additional request options
+	 */
+	patch_menu_v4_modifiers_bulk_update(
+		body: PatchMenuV4ModifiersBulkUpdateBody,
+		options?: RequestOptions,
+	): ResponsePromise<PatchMenuV4ModifiersBulkUpdateResponse> {
+		return this.request(
+			'menu',
+			'/menu/v4/modifiers/bulk-update',
+			'patch',
+			`/menu/v4/modifiers/bulk-update`,
+			body,
+			options,
+		);
+	}
+
+	/**
+	 * POST /menu/v4/modifier/{id}/attachment/{name}
+	 *
+	 * @param id
+	 * @param name
+	 * @param options - additional request options
+	 */
+	post_menu_v4_modifier_attachment(
+		id: string,
+		name: 'thumbnail',
+		options?: {
+			query?: PostMenuV4ModifierAttachmentQuery;
+		} & RequestOptions,
+	): ResponsePromise<PostMenuV4ModifierAttachmentResponse> {
+		return this.request(
+			'menu',
+			'/menu/v4/modifier/{id}/attachment/{name}',
+			'post',
+			`/menu/v4/modifier/${id}/attachment/${name}`,
+			null,
+			options,
+		);
+	}
+
 	/**
 	 * POST /menu/v4/modifier-group
 	 *
@@ -9969,6 +10227,30 @@ export class ServiceClient extends BaseServiceClient {
 		);
 	}
 
+	/**
+	 * POST /menu/v4/modifier-group/{id}/duplicate
+	 *
+	 * @param id
+	 * @param body
+	 * @param options - additional request options
+	 */
+	post_menu_v4_modifier_group_duplicate(
+		id: string,
+		body: PostMenuV4ModifierGroupDuplicateBody,
+		options?: {
+			query?: PostMenuV4ModifierGroupDuplicateQuery;
+		} & RequestOptions,
+	): ResponsePromise<PostMenuV4ModifierGroupDuplicateResponse> {
+		return this.request(
+			'menu',
+			'/menu/v4/modifier-group/{id}/duplicate',
+			'post',
+			`/menu/v4/modifier-group/${id}/duplicate`,
+			body,
+			options,
+		);
+	}
+
 	/**
 	 * GET /notification - Get all notifications
 	 *
@@ -10657,40 +10939,42 @@ export class ServiceClient extends BaseServiceClient {
 	}
 
 	/**
-	 * GET /consumer/customer-orders - Get customer orders
+	 * GET /consumer/customer-orders/{userId} - Get customer orders
 	 *
+	 * @param userId - TODO: add parameter to swagger.json
 	 * @param options - additional request options
 	 */
 	get_customer_orders(
+		userId: string,
 		options?: {
 			query?: GetCustomerOrdersQuery;
 		} & RequestOptions,
 	): ResponsePromise<GetCustomerOrdersResponse> {
 		return this.request(
 			'consumer',
-			'/consumer/customer-orders',
+			'/consumer/customer-orders/{userId}',
 			'get',
-			`/consumer/customer-orders`,
+			`/consumer/customer-orders/${userId}`,
 			null,
 			options,
 		);
 	}
 
 	/**
-	 * POST /consumer/review/order/item-ratings - Submit review containing order item ratings
+	 * POST /consumer/review/order-items - Submit reviews for order items
 	 *
 	 * @param body
 	 * @param options - additional request options
 	 */
-	post_review_order_item_ratings(
-		body: PostReviewOrderItemRatingsBody,
+	post_review_order_items(
+		body: PostReviewOrderItemsBody,
 		options?: RequestOptions,
-	): ResponsePromise<PostReviewOrderItemRatingsResponse> {
+	): ResponsePromise<PostReviewOrderItemsResponse> {
 		return this.request(
 			'consumer',
-			'/consumer/review/order/item-ratings',
+			'/consumer/review/order-items',
 			'post',
-			`/consumer/review/order/item-ratings`,
+			`/consumer/review/order-items`,
 			body,
 			options,
 		);
@@ -11137,4 +11421,42 @@ export class ServiceClient extends BaseServiceClient {
 	): ResponsePromise<GetAuthSsoExchangeResponse> {
 		return this.request('auth', '/auth/sso/exchange', 'get', `/auth/sso/exchange`, null, options);
 	}
+
+	/**
+	 * GET /review - Get reviews by taxonomy
+	 *
+	 * @param options - additional request options
+	 */
+	get_reviews(
+		options: {
+			query: GetReviewsQuery;
+		} & RequestOptions,
+	): ResponsePromise<GetReviewsResponse> {
+		return this.request('review', '/review', 'get', `/review`, null, options);
+	}
+
+	/**
+	 * POST /review - Post a review
+	 *
+	 * @param body
+	 * @param options - additional request options
+	 */
+	post_review(body: PostReviewBody, options?: RequestOptions): ResponsePromise<PostReviewResponse> {
+		return this.request('review', '/review', 'post', `/review`, body, options);
+	}
+
+	/**
+	 * GET /review/{id} - Get a review
+	 *
+	 * @param id
+	 * @param options - additional request options
+	 */
+	get_review(
+		id: string,
+		options?: {
+			query?: GetReviewQuery;
+		} & RequestOptions,
+	): ResponsePromise<GetReviewResponse> {
+		return this.request('review', '/review/{id}', 'get', `/review/${id}`, null, options);
+	}
 }

package/src/interface/announcement.ts

@@ -83,7 +83,7 @@ export interface Announcement {
 	name: string;
 	// Announcement Type
 	type: string;
-	key?: string;
+	key: string;
 	// App name
 	app: 'Boost' | 'Thrive' | 'Nourish' | 'JJKitchen' | 'Rogers';
 	// True if all the sites are linked
@@ -97,7 +97,7 @@ export interface Announcement {
 	created_at: string;
 	// Date modified
 	last_modified: string;
-	position?: number;
+	position: number;
 	// Announcement Properties
 	info?: {
 		en?: AnnouncementInfo;

package/src/interface/centricos.ts

@@ -109,7 +109,7 @@ export interface GetSitesResponse {
 
 export interface ReviewOrderItemsResponseDTO {
 	// List of reviews
-	reviews: string[];
+	reviews: Record<string, any>[][];
 }
 
 // POST /centricos/ai/item/description - Generate item description