@compassdigital/sdk.typescript 4.153.0 → 4.155.0

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@compassdigital/sdk.typescript",
-	"version": "4.153.0",
+	"version": "4.155.0",
 	"description": "Compass Digital Labs TypeScript SDK",
 	"type": "commonjs",
 	"main": "./lib/index.js",
@@ -57,7 +57,7 @@
 	},
 	"devDependencies": {
 		"@compassdigital/review": "^7.6.3",
-		"@compassdigital/sdk.typescript.cli": "^4.47.0",
+		"@compassdigital/sdk.typescript.cli": "^4.48.0",
 		"@swc/core": "^1.4.1",
 		"@swc/jest": "^0.2.36",
 		"@types/jest": "^29.2.4",

package/src/base.ts

@@ -345,22 +345,19 @@ export abstract class BaseServiceClient {
 	 */
 	private env_options(): RequestOptions {
 		const options: RequestOptions = {};
-		if (typeof process === 'undefined') {
-			return options;
-		}
-		const stage = process.env.P2_SDK_STAGE;
+		const stage = getEnv('P2_SDK_STAGE');
 		if (stage) {
 			options.stage = stage;
 		}
-		const token = process.env.P2_SDK_TOKEN;
+		const token = getEnv('P2_SDK_TOKEN');
 		if (token) {
 			options.token = token;
 		}
-		const debug = process.env.P2_SDK_DEBUG;
+		const debug = getEnv('P2_SDK_DEBUG');
 		if (debug && debug !== '0' && `${debug}`.toLowerCase() !== 'false') {
 			options.debug = true;
 		}
-		const base_url = process.env.P2_SDK_BASE_URL;
+		const base_url = getEnv('P2_SDK_BASE_URL');
 		if (base_url) {
 			if (base_url.includes('=')) {
 				options.base_url = {};
@@ -406,7 +403,7 @@ export abstract class BaseServiceClient {
 		// add query parameters.
 		const query: string[] = [];
 		for (const [name, values] of Object.entries(params)) {
-			if (typeof values === 'undefined') {
+			if (typeof values === 'undefined' && !getEnv('P2_SDK_SEND_UNDEFINED_QUERY')) {
 				continue;
 			}
 			for (const value of Array.isArray(values) ? values : [values]) {
@@ -601,3 +598,10 @@ export abstract class BaseServiceClient {
 		return data;
 	}
 }
+
+function getEnv(name: string): string | undefined {
+	if (typeof process === 'undefined') {
+		return undefined;
+	}
+	return process.env[name];
+}

package/src/index.ts

@@ -142,6 +142,9 @@ import {
 	GetLocationBrandMenuDeliveryTimeslostsResponse,
 	PostLocationBrandBody,
 	PostLocationBrandResponse,
+	PostLocationBrandBatchGetQuery,
+	PostLocationBrandBatchGetBody,
+	PostLocationBrandBatchGetResponse,
 	PatchLocationBrandBulkBody,
 	PatchLocationBrandBulkResponse,
 	GetLocationBrandQuery,
@@ -953,6 +956,8 @@ import {
 	DeleteMenuV4ItemModifierGroupsDetachResponse,
 	PostMenuV4ItemAttachModifierGroupsBody,
 	PostMenuV4ItemAttachModifierGroupsResponse,
+	DeleteMenuV4ItemsBulkDeleteBody,
+	DeleteMenuV4ItemsBulkDeleteResponse,
 	PostMenuV4ModifierBody,
 	PostMenuV4ModifierResponse,
 	GetMenuV4ModifierQuery,
@@ -966,6 +971,8 @@ import {
 	PatchMenuV4ModifiersBulkUpdateResponse,
 	PostMenuV4ModifierAttachmentQuery,
 	PostMenuV4ModifierAttachmentResponse,
+	DeleteMenuV4ModifiersBulkDeleteBody,
+	DeleteMenuV4ModifiersBulkDeleteResponse,
 	PostMenuV4ModifierGroupBody,
 	PostMenuV4ModifierGroupResponse,
 	GetMenuV4ModifierGroupQuery,
@@ -2573,6 +2580,28 @@ export class ServiceClient extends BaseServiceClient {
 		return this.request('location', '/location/brand', 'POST', `/location/brand`, body, options);
 	}
 
+	/**
+	 * POST /location/brand/batch-get - Get multiple brands
+	 *
+	 * @param body
+	 * @param options - additional request options
+	 */
+	post_location_brand_batch_get(
+		body: PostLocationBrandBatchGetBody,
+		options?: {
+			query?: PostLocationBrandBatchGetQuery;
+		} & RequestOptions,
+	): ResponsePromise<PostLocationBrandBatchGetResponse> {
+		return this.request(
+			'location',
+			'/location/brand/batch-get',
+			'POST',
+			`/location/brand/batch-get`,
+			body,
+			options,
+		);
+	}
+
 	/**
 	 * PATCH /location/brand/bulk - Update multiple brands
 	 *
@@ -10410,6 +10439,26 @@ export class ServiceClient extends BaseServiceClient {
 		);
 	}
 
+	/**
+	 * DELETE /menu/v4/items/bulk-delete
+	 *
+	 * @param body
+	 * @param options - additional request options
+	 */
+	delete_menu_v4_items_bulk_delete(
+		body: DeleteMenuV4ItemsBulkDeleteBody,
+		options?: RequestOptions,
+	): ResponsePromise<DeleteMenuV4ItemsBulkDeleteResponse> {
+		return this.request(
+			'menu',
+			'/menu/v4/items/bulk-delete',
+			'DELETE',
+			`/menu/v4/items/bulk-delete`,
+			body,
+			options,
+		);
+	}
+
 	/**
 	 * POST /menu/v4/modifier
 	 *
@@ -10553,6 +10602,26 @@ export class ServiceClient extends BaseServiceClient {
 		);
 	}
 
+	/**
+	 * DELETE /menu/v4/modifiers/bulk-delete
+	 *
+	 * @param body
+	 * @param options - additional request options
+	 */
+	delete_menu_v4_modifiers_bulk_delete(
+		body: DeleteMenuV4ModifiersBulkDeleteBody,
+		options?: RequestOptions,
+	): ResponsePromise<DeleteMenuV4ModifiersBulkDeleteResponse> {
+		return this.request(
+			'menu',
+			'/menu/v4/modifiers/bulk-delete',
+			'DELETE',
+			`/menu/v4/modifiers/bulk-delete`,
+			body,
+			options,
+		);
+	}
+
 	/**
 	 * POST /menu/v4/modifier-group
 	 *

package/src/interface/consumer.ts

@@ -838,6 +838,24 @@ export interface HeroImage {
 	images: string[];
 }
 
+export interface ConsumerAnnouncementDetails {
+	image_url?: string;
+	title?: string;
+	description?: string;
+	sub_text?: string;
+	button_text?: string;
+}
+
+export interface ConsumerAnnouncementInfo {
+	en?: ConsumerAnnouncementDetails;
+	fr?: ConsumerAnnouncementDetails;
+}
+
+export interface ConsumerAnnouncement {
+	app: string;
+	info: ConsumerAnnouncementInfo;
+}
+
 export interface HomePageOrder {
 	meta?: {
 		[index: string]: any;
@@ -1134,6 +1152,8 @@ export interface ConsumerGroup {
 export interface HomePageResponse {
 	greetingMessage: DiverseGreetingMessages;
 	heroImages: HeroImage;
+	// active announcements
+	announcements?: ConsumerAnnouncement[];
 	// array of orders
 	orders?: HomePageOrder[];
 	location?: ConsumerGroup;
@@ -1987,6 +2007,7 @@ export interface GetConsumerHomePageQuery {
 	end: number;
 	// current date in epoch time
 	date: number;
+	location_multigroup_id: string;
 	// reorder eligible
 	reorderEligible: boolean;
 	// Graphql query string

package/src/interface/location.ts

@@ -1167,6 +1167,31 @@ export interface PostLocationBrandRequest extends BaseRequest {
 	body: PostLocationBrandBody;
 }
 
+// POST /location/brand/batch-get - Get multiple brands
+
+export interface PostLocationBrandBatchGetQuery {
+	// If true, includes brand public/private configs into response. Auth should be provided.
+	include_config?: boolean;
+	// show additional hidden properties/entities
+	extended?: boolean;
+	//  determine whether to calculate estimated_wait_time
+	include_estimated_wait_time?: boolean;
+}
+
+export interface PostLocationBrandBatchGetBody {
+	ids?: string[];
+}
+
+export interface PostLocationBrandBatchGetResponse {
+	brands?: Brands;
+}
+
+export interface PostLocationBrandBatchGetRequest
+	extends BaseRequest,
+		RequestQuery<PostLocationBrandBatchGetQuery> {
+	body: PostLocationBrandBatchGetBody;
+}
+
 // PATCH /location/brand/bulk - Update multiple brands
 
 export interface PatchLocationBrandBulkBody {

package/src/interface/menu.ts

@@ -8900,6 +8900,22 @@ export interface PostMenuV4ItemAttachModifierGroupsRequest
 	body: PostMenuV4ItemAttachModifierGroupsBody;
 }
 
+// DELETE /menu/v4/items/bulk-delete
+
+export interface DeleteMenuV4ItemsBulkDeleteBody {
+	id_list: string[];
+	[index: string]: any;
+}
+
+export interface DeleteMenuV4ItemsBulkDeleteResponse {
+	meta?: Record<string, any>;
+	results?: DraftItemEntityDTO[];
+}
+
+export interface DeleteMenuV4ItemsBulkDeleteRequest extends BaseRequest {
+	body: DeleteMenuV4ItemsBulkDeleteBody;
+}
+
 // POST /menu/v4/modifier
 
 export interface PostMenuV4ModifierBody {
@@ -9380,6 +9396,22 @@ export interface PostMenuV4ModifierAttachmentRequest
 		RequestQuery<PostMenuV4ModifierAttachmentQuery>,
 		PostMenuV4ModifierAttachmentPath {}
 
+// DELETE /menu/v4/modifiers/bulk-delete
+
+export interface DeleteMenuV4ModifiersBulkDeleteBody {
+	id_list: string[];
+	[index: string]: any;
+}
+
+export interface DeleteMenuV4ModifiersBulkDeleteResponse {
+	meta?: Record<string, any>;
+	results?: DraftModifierEntityDTO[];
+}
+
+export interface DeleteMenuV4ModifiersBulkDeleteRequest extends BaseRequest {
+	body: DeleteMenuV4ModifiersBulkDeleteBody;
+}
+
 // POST /menu/v4/modifier-group
 
 export interface PostMenuV4ModifierGroupBody {