@compassdigital/sdk.typescript 4.94.2 → 4.96.0

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@compassdigital/sdk.typescript",
-	"version": "4.94.2",
+	"version": "4.96.0",
 	"description": "Compass Digital Labs TypeScript SDK",
 	"type": "commonjs",
 	"main": "./lib/index.js",

package/src/index.ts

@@ -534,6 +534,8 @@ import {
 	GetMenuV3LocalMenuGroupAllowedGlobalBrandsResponse,
 	PostMenuV3LocalMenuGroupImportBrandsQuery,
 	PostMenuV3LocalMenuGroupImportBrandsResponse,
+	PostMenuV4LocalMenuGroupImportBrandsQuery,
+	PostMenuV4LocalMenuGroupImportBrandsResponse,
 	GetMenuV3LocalMenuGroupSiteQuery,
 	GetMenuV3LocalMenuGroupSiteResponse,
 	GetMenuV3LocalMenuGroupMenuGroupQuery,
@@ -607,6 +609,10 @@ import {
 	PostMenuV3DraftBrandGlobalDiffsApplyResponse,
 	PostMenuV3DraftBrandAttachmentQuery,
 	PostMenuV3DraftBrandAttachmentResponse,
+	GetMenuV3DraftBrandExportQuery,
+	GetMenuV3DraftBrandExportResponse,
+	GetMenuV3DraftBrandImportLinkQuery,
+	GetMenuV3DraftBrandImportLinkResponse,
 	PostMenuV3BrandQuery,
 	PostMenuV3BrandBody,
 	PostMenuV3BrandResponse,
@@ -881,6 +887,8 @@ import {
 	GetMenuV4BrandResponse,
 	PostMenuV4BrandMenuBody,
 	PostMenuV4BrandMenuResponse,
+	PatchMenuV4BrandMenuBody,
+	PatchMenuV4BrandMenuResponse,
 	GetMenuV4BrandItemsQuery,
 	GetMenuV4BrandItemsResponse,
 	GetMenuV4BrandModifierGroupsQuery,
@@ -897,24 +905,30 @@ import {
 	PostMenuV4BrandCategoryAttachItemsResponse,
 	PostMenuV4BrandPublishResponse,
 	PostMenuV4BrandV3ToV4Response,
+	DeleteMenuV4BrandResponse,
+	DeleteMenuV4BrandMenuResponse,
+	DeleteMenuV4BrandCategoryResponse,
 	PostMenuV4ItemBody,
 	PostMenuV4ItemResponse,
 	GetMenuV4ItemQuery,
 	GetMenuV4ItemResponse,
 	PatchMenuV4ItemBody,
 	PatchMenuV4ItemResponse,
+	DeleteMenuV4ItemResponse,
 	PostMenuV4ModifierBody,
 	PostMenuV4ModifierResponse,
 	GetMenuV4ModifierQuery,
 	GetMenuV4ModifierResponse,
 	PatchMenuV4ModifierBody,
 	PatchMenuV4ModifierResponse,
+	DeleteMenuV4ModifierResponse,
 	PostMenuV4ModifierGroupBody,
 	PostMenuV4ModifierGroupResponse,
 	GetMenuV4ModifierGroupQuery,
 	GetMenuV4ModifierGroupResponse,
 	PatchMenuV4ModifierGroupBody,
 	PatchMenuV4ModifierGroupResponse,
+	DeleteMenuV4ModifierGroupResponse,
 	PostMenuV4ModifierGroupAttachModifiersBody,
 	PostMenuV4ModifierGroupAttachModifiersResponse,
 } from './interface/menu';
@@ -1003,8 +1017,8 @@ import {
 	GetPaymentListByBrandResponse,
 	GetCustomerOrdersQuery,
 	GetCustomerOrdersResponse,
-	PostOrderReviewsBody,
-	PostOrderReviewsResponse,
+	PostReviewOrderItemRatingsBody,
+	PostReviewOrderItemRatingsResponse,
 } from './interface/consumer';
 
 import {
@@ -1012,6 +1026,8 @@ import {
 	PostAiLanguageGenerateResponse,
 	PostAiImageGenerateBody,
 	PostAiImageGenerateResponse,
+	PostAiTranslateBody,
+	PostAiTranslateResponse,
 } from './interface/ai';
 
 import {
@@ -1034,6 +1050,8 @@ import {
 	GetSiteDevicesResponse,
 	GetCentricosSitesQuery,
 	GetCentricosSitesResponse,
+	GetReviewOrderItemsQuery,
+	GetReviewOrderItemsResponse,
 } from './interface/centricos';
 
 import {
@@ -5646,6 +5664,28 @@ export class ServiceClient extends BaseServiceClient {
 		);
 	}
 
+	/**
+	 * POST /menu/v4/local-menu-group/{id}/import-brands
+	 *
+	 * @param id
+	 * @param options - additional request options
+	 */
+	post_menu_v4_local_menu_group_import_brands(
+		id: string,
+		options?: {
+			query?: PostMenuV4LocalMenuGroupImportBrandsQuery;
+		} & RequestOptions,
+	): ResponsePromise<PostMenuV4LocalMenuGroupImportBrandsResponse> {
+		return this.request(
+			'menu',
+			'/menu/v4/local-menu-group/{id}/import-brands',
+			'post',
+			`/menu/v4/local-menu-group/${id}/import-brands`,
+			null,
+			options,
+		);
+	}
+
 	/**
 	 * GET /menu/v3/local-menu-group/{id}/site
 	 *
@@ -6458,6 +6498,50 @@ export class ServiceClient extends BaseServiceClient {
 		);
 	}
 
+	/**
+	 * GET /menu/v3/draft/brand/{id}/export
+	 *
+	 * @param id
+	 * @param options - additional request options
+	 */
+	get_menu_v3_draft_brand_export(
+		id: string,
+		options?: {
+			query?: GetMenuV3DraftBrandExportQuery;
+		} & RequestOptions,
+	): ResponsePromise<GetMenuV3DraftBrandExportResponse> {
+		return this.request(
+			'menu',
+			'/menu/v3/draft/brand/{id}/export',
+			'get',
+			`/menu/v3/draft/brand/${id}/export`,
+			null,
+			options,
+		);
+	}
+
+	/**
+	 * GET /menu/v3/draft/brand/{id}/import/link
+	 *
+	 * @param id
+	 * @param options - additional request options
+	 */
+	get_menu_v3_draft_brand_import_link(
+		id: string,
+		options?: {
+			query?: GetMenuV3DraftBrandImportLinkQuery;
+		} & RequestOptions,
+	): ResponsePromise<GetMenuV3DraftBrandImportLinkResponse> {
+		return this.request(
+			'menu',
+			'/menu/v3/draft/brand/{id}/import/link',
+			'get',
+			`/menu/v3/draft/brand/${id}/import/link`,
+			null,
+			options,
+		);
+	}
+
 	/**
 	 * POST /menu/v3/brand
 	 *
@@ -9346,6 +9430,30 @@ export class ServiceClient extends BaseServiceClient {
 		);
 	}
 
+	/**
+	 * PATCH /menu/v4/brand/{brand_id}/menu/{menu_id}
+	 *
+	 * @param brand_id
+	 * @param menu_id
+	 * @param body
+	 * @param options - additional request options
+	 */
+	patch_menu_v4_brand_menu(
+		brand_id: string,
+		menu_id: string,
+		body: PatchMenuV4BrandMenuBody,
+		options?: RequestOptions,
+	): ResponsePromise<PatchMenuV4BrandMenuResponse> {
+		return this.request(
+			'menu',
+			'/menu/v4/brand/{brand_id}/menu/{menu_id}',
+			'patch',
+			`/menu/v4/brand/${brand_id}/menu/${menu_id}`,
+			body,
+			options,
+		);
+	}
+
 	/**
 	 * GET /menu/v4/brand/{id}/items
 	 *
@@ -9544,6 +9652,70 @@ 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,
+		);
+	}
+
+	/**
+	 * 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,
+		);
+	}
+
+	/**
+	 * 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/item
 	 *
@@ -9594,6 +9766,26 @@ export class ServiceClient extends BaseServiceClient {
 		);
 	}
 
+	/**
+	 * DELETE /menu/v4/item/{id}
+	 *
+	 * @param id
+	 * @param options - additional request options
+	 */
+	delete_menu_v4_item(
+		id: string,
+		options?: RequestOptions,
+	): ResponsePromise<DeleteMenuV4ItemResponse> {
+		return this.request(
+			'menu',
+			'/menu/v4/item/{id}',
+			'delete',
+			`/menu/v4/item/${id}`,
+			null,
+			options,
+		);
+	}
+
 	/**
 	 * POST /menu/v4/modifier
 	 *
@@ -9651,6 +9843,26 @@ export class ServiceClient extends BaseServiceClient {
 		);
 	}
 
+	/**
+	 * DELETE /menu/v4/modifier/{id}
+	 *
+	 * @param id
+	 * @param options - additional request options
+	 */
+	delete_menu_v4_modifier(
+		id: string,
+		options?: RequestOptions,
+	): ResponsePromise<DeleteMenuV4ModifierResponse> {
+		return this.request(
+			'menu',
+			'/menu/v4/modifier/{id}',
+			'delete',
+			`/menu/v4/modifier/${id}`,
+			null,
+			options,
+		);
+	}
+
 	/**
 	 * POST /menu/v4/modifier-group
 	 *
@@ -9715,6 +9927,26 @@ export class ServiceClient extends BaseServiceClient {
 		);
 	}
 
+	/**
+	 * DELETE /menu/v4/modifier-group/{id}
+	 *
+	 * @param id
+	 * @param options - additional request options
+	 */
+	delete_menu_v4_modifier_group(
+		id: string,
+		options?: RequestOptions,
+	): ResponsePromise<DeleteMenuV4ModifierGroupResponse> {
+		return this.request(
+			'menu',
+			'/menu/v4/modifier-group/{id}',
+			'delete',
+			`/menu/v4/modifier-group/${id}`,
+			null,
+			options,
+		);
+	}
+
 	/**
 	 * POST /menu/v4/modifier-group/{id}/attach-modifiers
 	 *
@@ -10445,15 +10677,15 @@ export class ServiceClient extends BaseServiceClient {
 	}
 
 	/**
-	 * POST /consumer/review/order/item-ratings - Submit order reviews
+	 * POST /consumer/review/order/item-ratings - Submit review containing order item ratings
 	 *
 	 * @param body
 	 * @param options - additional request options
 	 */
-	post_order_reviews(
-		body: PostOrderReviewsBody,
+	post_review_order_item_ratings(
+		body: PostReviewOrderItemRatingsBody,
 		options?: RequestOptions,
-	): ResponsePromise<PostOrderReviewsResponse> {
+	): ResponsePromise<PostReviewOrderItemRatingsResponse> {
 		return this.request(
 			'consumer',
 			'/consumer/review/order/item-ratings',
@@ -10497,6 +10729,19 @@ export class ServiceClient extends BaseServiceClient {
 		return this.request('ai', '/ai/image/generate', 'post', `/ai/image/generate`, body, options);
 	}
 
+	/**
+	 * POST /ai/translate - Translate strings
+	 *
+	 * @param body
+	 * @param options - additional request options
+	 */
+	post_ai_translate(
+		body: PostAiTranslateBody,
+		options?: RequestOptions,
+	): ResponsePromise<PostAiTranslateResponse> {
+		return this.request('ai', '/ai/translate', 'post', `/ai/translate`, body, options);
+	}
+
 	/**
 	 * POST /centricos/ai/item/description - Generate item description
 	 *
@@ -10698,6 +10943,28 @@ export class ServiceClient extends BaseServiceClient {
 		return this.request('centricos', '/centricos/sites', 'get', `/centricos/sites`, null, options);
 	}
 
+	/**
+	 * GET /centricos/review/{orderId}/order-items - Get reviews for items in a given order in an array format
+	 *
+	 * @param orderId
+	 * @param options - additional request options
+	 */
+	get_review_order_items(
+		orderId: string,
+		options?: {
+			query?: GetReviewOrderItemsQuery;
+		} & RequestOptions,
+	): ResponsePromise<GetReviewOrderItemsResponse> {
+		return this.request(
+			'centricos',
+			'/centricos/review/{orderId}/order-items',
+			'get',
+			`/centricos/review/${orderId}/order-items`,
+			null,
+			options,
+		);
+	}
+
 	/**
 	 * GET /tax/v1/health-check - Health Check
 	 *

package/src/interface/ai.ts

@@ -51,6 +51,20 @@ export interface GenerateImageResponse {
 	images: ImageDTO[];
 }
 
+export type TranslationStrings = Record<string, any>;
+
+export interface TranslateRequest {
+	sourceLanguage: string;
+	targetLanguage: string;
+	strings: TranslationStrings;
+}
+
+export interface TranslateResponse {
+	sourceLanguage: string;
+	targetLanguage: string;
+	translations: Record<string, string>;
+}
+
 // POST /ai/language/generate - Generate text from a given prompt
 
 export type PostAiLanguageGenerateBody = GenerateTextRequest;
@@ -70,3 +84,13 @@ export type PostAiImageGenerateResponse = GenerateImageResponse;
 export interface PostAiImageGenerateRequest extends BaseRequest {
 	body: PostAiImageGenerateBody;
 }
+
+// POST /ai/translate - Translate strings
+
+export type PostAiTranslateBody = TranslateRequest;
+
+export type PostAiTranslateResponse = TranslateResponse;
+
+export interface PostAiTranslateRequest extends BaseRequest {
+	body: PostAiTranslateBody;
+}

package/src/interface/announcement.ts

@@ -45,10 +45,8 @@ export interface AnnouncementPutRequestBody {
 	is_global?: boolean;
 	allowed_resources?: string[];
 	position: number;
-	//@deprecated
 	active?: boolean;
-	// Status of the announcement
-	status?: 'draft' | 'active' | 'disabled';
+	status?: Status;
 	// Announcement Properties
 	info?: {
 		en?: AnnouncementInfo;
@@ -69,8 +67,7 @@ export interface AnnouncementPatchRequestBody {
 	position?: number;
 	//@deprecated
 	active?: boolean;
-	// Status of the announcement
-	status?: 'draft' | 'active' | 'disabled';
+	status?: Status;
 	// Announcement Properties
 	info?: {
 		en?: AnnouncementInfo;
@@ -94,8 +91,7 @@ export interface Announcement {
 	allowed_resources: string[];
 	//@deprecated
 	active: boolean;
-	// Status of the announcement
-	status?: 'draft' | 'active' | 'disabled';
+	status?: Status;
 	schedule?: Schedule;
 	// Date created
 	created_at: string;
@@ -141,7 +137,7 @@ export interface EditHistory {
 
 export interface Schedule {
 	// If true, refer to `sites`, if false, refer to start/end times below
-	variable: boolean;
+	variable?: boolean;
 	start_datetime?: string;
 	// Maximum 1 year from today
 	end_datetime?: string;
@@ -154,7 +150,7 @@ export interface Schedule {
 	}[];
 }
 
-export type Status = 'draft' | 'active' | 'disabled';
+export type Status = 'draft' | 'published' | 'active' | 'disabled';
 
 // POST /announcement - Create Announcement
 
@@ -195,7 +191,7 @@ export interface GetAnnouncementsQuery {
 	name?: string;
 	// Filter by announcement position
 	position?: number;
-	// Filter by announcement enabled status
+	// Filter by announcement active status
 	enabled?: boolean;
 	// Filter by announcement purpose
 	purpose?: string;
@@ -205,7 +201,7 @@ export interface GetAnnouncementsQuery {
 	sort_by?: string;
 	// Sort order (ASC or DESC)
 	sort_order?: string;
-	// Filter by status - 'active', 'draft', 'disabled'
+	// Filter by status - 'published', 'draft'
 	status?: string;
 	// Graphql query string
 	_query?: string;

package/src/interface/centricos.ts

@@ -107,6 +107,11 @@ export interface GetSitesResponse {
 	results: Site[];
 }
 
+export interface ReviewOrderItemsResponseDTO {
+	// List of reviews
+	reviews: string[];
+}
+
 // POST /centricos/ai/item/description - Generate item description
 
 export type PostCentricosAiItemDescriptionBody = AIItemDescriptionRequest;
@@ -299,3 +304,21 @@ export type GetCentricosSitesResponse = GetSitesResponse;
 export interface GetCentricosSitesRequest
 	extends BaseRequest,
 		RequestQuery<GetCentricosSitesQuery> {}
+
+// GET /centricos/review/{orderId}/order-items - Get reviews for items in a given order in an array format
+
+export interface GetReviewOrderItemsPath {
+	orderId: string;
+}
+
+export interface GetReviewOrderItemsQuery {
+	// Graphql query string
+	_query?: string;
+}
+
+export type GetReviewOrderItemsResponse = ReviewOrderItemsResponseDTO;
+
+export interface GetReviewOrderItemsRequest
+	extends BaseRequest,
+		RequestQuery<GetReviewOrderItemsQuery>,
+		GetReviewOrderItemsPath {}

package/src/interface/compassconnect.ts

@@ -55,15 +55,6 @@ export interface Auth {
 	refresh_token?: string;
 }
 
-export interface Compassconnect {
-	// compassconnect
-	id: string;
-}
-
-export interface Compassconnects {
-	compassconnects: Compassconnect[];
-}
-
 // GET /compassconnect/oms_token - Gets an OMS token
 
 export interface GetCompassconnectOmsTokenQuery {

package/src/interface/consumer.ts

@@ -167,12 +167,19 @@ export interface ModifierGroup {
 	items?: Modifier[];
 }
 
-export interface CartItemRating {
+export interface OrderItemRating {
+	// order id
 	id: string;
+	// menu id
+	menu: string;
+	// item id
 	item: string;
+	// rating score
 	score: number;
-	comment?: string;
-	tags?: string[];
+	// review comment
+	comment: string;
+	// review tags
+	reason: string[];
 }
 
 export interface CartItem {
@@ -188,7 +195,7 @@ export interface CartItem {
 	options?: ModifierGroup[];
 	label?: Label;
 	name?: string;
-	review: CartItemRating;
+	review: OrderItemRating;
 }
 
 export interface ShoppingCart {
@@ -236,20 +243,26 @@ export interface BadRequestErrorDTO {
 	data: Record<string, any>;
 }
 
-export interface NewCartItemRating {
+export interface ReviewOrderItemRatings {
+	// menu id
+	menu: string;
+	// item id
 	item: string;
+	// rating score
 	score: number;
-	comment?: string;
-	tags?: string[];
+	// review comment
+	comment: string;
+	// review tags
+	reason: string[];
 }
 
-export interface PostOrderItemRatingsRequestDTO {
+export interface PostReviewOrderItemRatingsRequestDTO {
 	orderId: string;
-	reviews: NewCartItemRating[];
+	reviews: ReviewOrderItemRatings[];
 }
 
-export interface PostOrderItemRatingsResponseDTO {
-	reviews: CartItemRating[];
+export interface PostReviewOrderItemRatingsResponseDTO {
+	reviews: OrderItemRating[];
 }
 
 // GET /consumer/v1/health-check
@@ -299,12 +312,12 @@ export interface GetCustomerOrdersRequest
 	extends BaseRequest,
 		RequestQuery<GetCustomerOrdersQuery> {}
 
-// POST /consumer/review/order/item-ratings - Submit order reviews
+// POST /consumer/review/order/item-ratings - Submit review containing order item ratings
 
-export type PostOrderReviewsBody = PostOrderItemRatingsRequestDTO;
+export type PostReviewOrderItemRatingsBody = PostReviewOrderItemRatingsRequestDTO;
 
-export type PostOrderReviewsResponse = PostOrderItemRatingsResponseDTO;
+export type PostReviewOrderItemRatingsResponse = PostReviewOrderItemRatingsResponseDTO;
 
-export interface PostOrderReviewsRequest extends BaseRequest {
-	body: PostOrderReviewsBody;
+export interface PostReviewOrderItemRatingsRequest extends BaseRequest {
+	body: PostReviewOrderItemRatingsBody;
 }