@compassdigital/sdk.typescript 4.131.0 → 4.133.0

package/src/index.ts

@@ -1015,6 +1015,8 @@ import {
 	PostNotificationStatusResponse,
 	PostNotificationDevicePushBody,
 	PostNotificationDevicePushResponse,
+	PostNotificationBatchDevicePushBody,
+	PostNotificationBatchDevicePushResponse,
 	GetNotificationSwaggerQuery,
 	GetNotificationSwaggerResponse,
 } from './interface/notification';
@@ -1131,6 +1133,8 @@ import {
 	GetConsumerShoppingcartResponse,
 	PutConsumerShoppingcartBody,
 	PutConsumerShoppingcartResponse,
+	PostConsumerShoppingcartBody,
+	PostConsumerShoppingcartResponse,
 	PostConsumerPromoValidateBody,
 	PostConsumerPromoValidateResponse,
 } from './interface/consumer';
@@ -1178,6 +1182,8 @@ import {
 	GetCentricosDiscountResponse,
 	GetCentricosDiscountAllQuery,
 	GetCentricosDiscountAllResponse,
+	PostDiscountActiveBody,
+	PostDiscountActiveResponse,
 } from './interface/centricos';
 
 import {
@@ -10988,6 +10994,26 @@ export class ServiceClient extends BaseServiceClient {
 		);
 	}
 
+	/**
+	 * POST /notification/batch/device/push - Send a push notification to many user devices
+	 *
+	 * @param body - Push notification to send
+	 * @param options - additional request options
+	 */
+	post_notification_batch_device_push(
+		body: PostNotificationBatchDevicePushBody,
+		options?: RequestOptions,
+	): ResponsePromise<PostNotificationBatchDevicePushResponse> {
+		return this.request(
+			'notification',
+			'/notification/batch/device/push',
+			'POST',
+			`/notification/batch/device/push`,
+			body,
+			options,
+		);
+	}
+
 	/**
 	 * GET /notification/swagger.json - Get a swagger for notification service
 	 *
@@ -12051,6 +12077,26 @@ export class ServiceClient extends BaseServiceClient {
 		);
 	}
 
+	/**
+	 * POST /consumer/shoppingcart - Create a new shopping cart
+	 *
+	 * @param body
+	 * @param options - additional request options
+	 */
+	post_consumer_shoppingcart(
+		body: PostConsumerShoppingcartBody,
+		options?: RequestOptions,
+	): ResponsePromise<PostConsumerShoppingcartResponse> {
+		return this.request(
+			'consumer',
+			'/consumer/shoppingcart',
+			'POST',
+			`/consumer/shoppingcart`,
+			body,
+			options,
+		);
+	}
+
 	/**
 	 * POST /consumer/promo/validate - Validate a promo voucher
 	 *
@@ -12486,6 +12532,28 @@ export class ServiceClient extends BaseServiceClient {
 		);
 	}
 
+	/**
+	 * POST /centricos/discount/{id}/active - Set discount active status flag
+	 *
+	 * @param id - ID of the discount to update
+	 * @param body
+	 * @param options - additional request options
+	 */
+	post_discount_active(
+		id: string,
+		body: PostDiscountActiveBody,
+		options?: RequestOptions,
+	): ResponsePromise<PostDiscountActiveResponse> {
+		return this.request(
+			'centricos',
+			'/centricos/discount/{id}/active',
+			'POST',
+			`/centricos/discount/${id}/active`,
+			body,
+			options,
+		);
+	}
+
 	/**
 	 * GET /tax/v1/health-check - Health Check
 	 *

package/src/interface/centricos.ts

@@ -230,6 +230,7 @@ export interface CentricDiscountStatus {
 	live?: boolean;
 	publishedTo3rdParty?: boolean;
 	readyToPublish?: boolean;
+	active?: boolean;
 }
 
 export interface CentricVoucherifyMetaData {
@@ -255,6 +256,8 @@ export interface PutDiscountVoucherifyRequestDiscount {
 	meta?: {
 		[index: string]: any;
 	} & CentricVoucherifyMetaData;
+	// discount active status flag
+	active?: boolean;
 	is?: CentricDiscountIs;
 	id?: string;
 }
@@ -330,6 +333,7 @@ export interface DiscountDTO {
 	createdAt: string;
 	updatedAt: string;
 	is?: CentricDiscountIs;
+	meta?: Record<string, any>;
 }
 
 export interface GetDiscountResponseDTO {
@@ -348,6 +352,11 @@ export interface GetAllDiscountsResponseDTO {
 	discounts: DiscountWithSitesDTO[];
 }
 
+export interface PostDiscountActiveRequestDTO {
+	// Set discount active status flag
+	active: boolean;
+}
+
 // POST /centricos/ai/item/description - Generate item description
 
 export type PostCentricosAiItemDescriptionBody = AIItemDescriptionRequest;
@@ -584,3 +593,14 @@ export interface GetCentricosDiscountAllQuery {
 }
 
 export type GetCentricosDiscountAllResponse = GetAllDiscountsResponseDTO;
+
+// POST /centricos/discount/{id}/active - Set discount active status flag
+
+export interface PostDiscountActivePath {
+	// ID of the discount to update
+	id: string;
+}
+
+export type PostDiscountActiveBody = PostDiscountActiveRequestDTO;
+
+export type PostDiscountActiveResponse = {};

package/src/interface/consumer.ts

@@ -127,7 +127,7 @@ export interface OrderRefundTransaction {
 }
 
 export interface MultiLanguageLabel {
-	en: string;
+	en?: string;
 	fr?: string;
 	es?: string;
 }
@@ -917,6 +917,22 @@ export interface ConsumerBrand {
 		delivery_prep_time?: string;
 		delivery_is_user_defined?: boolean;
 	};
+	is?: {
+		pickup_supported?: boolean;
+		delivery_supported?: boolean;
+		frictionless_supported?: boolean;
+		plu_enabled?: boolean;
+		promo_exemptions_enabled?: boolean;
+		local_images_enabled?: boolean;
+		hidden?: boolean;
+		show_in_kiosk?: boolean;
+		show_in_pos?: boolean;
+		item_desc_edit_enabled?: boolean;
+		scan_and_go_supported?: boolean;
+		calories_edit_enabled?: boolean;
+		special_instructions_enabled?: boolean;
+		dining_hall?: boolean;
+	};
 	brand?: string;
 	location?: string;
 	group?: string;
@@ -928,6 +944,48 @@ export interface ConsumerBrand {
 		public?: Record<string, any>;
 	};
 	tax_rate?: number;
+	meta?: {
+		scout: {
+			user_id?: string;
+			name?: {
+				first?: string;
+				last?: string;
+			};
+		};
+		partner: {
+			user_id?: string;
+			name?: {
+				first?: string;
+				last?: string;
+			};
+		};
+		contact: {
+			name?: string;
+			role?: string;
+			email?: string;
+			phone?: string;
+		};
+		market_id?: string;
+		partner_type?: string;
+		business_number?: number;
+		website?: string;
+		cuisine_types?: string[];
+		status?: Record<string, any>;
+		active?: boolean;
+		max_showcase_items?: number;
+		jde_category?: string;
+		software_integrations: {
+			system365?: string;
+			jwo?: string;
+			time2eat?: {
+				enabled?: boolean;
+			};
+			nextep?: {
+				mobile_app?: boolean;
+			};
+		};
+		[index: string]: any;
+	};
 	descriptions?: {
 		location: {
 			en?: string;
@@ -1665,6 +1723,80 @@ export interface PutConsumerShoppingCartResponse {
 	};
 }
 
+export interface PostConsumerShoppingCartBodyRequest {
+	location?: string;
+	menu?: string;
+	brand?: string;
+	promo?: ShoppingcartPromoDetails;
+	discount?: ShoppingcartPromoDetails;
+	payment_method?: ShoppingcartPaymentMethod;
+	taxes?: ShoppingcartTaxes;
+	exemptions?: {
+		tax?: boolean;
+	};
+	service_fee?: ShoppingcartMonetaryValue;
+	delivery_fee?: ShoppingcartMonetaryValue;
+	is?: {
+		type?: Record<string, any>;
+		mx_cart?: boolean;
+		email_tax_exempt?: boolean;
+		tax_calculation_required?: boolean;
+		system365?: boolean;
+	};
+	meta?: {
+		vendor?: Record<string, any>;
+		[index: string]: any;
+	};
+}
+
+export interface PostConsumerShoppingCartResponse {
+	id?: string;
+	location?: string;
+	menu?: string;
+	brand?: string;
+	date?: Record<string, any>;
+	items?: ShoppingcartItem[];
+	sub_total?: {
+		amount?: number;
+	};
+	promo?: ShoppingcartPromoDetails;
+	loyalty?: {
+		coupon: {
+			code?: string;
+			amount_off?: number;
+			amount?: number;
+			name?: string;
+		};
+		order_loyalty_points?: boolean;
+	};
+	discount?: ShoppingcartPromoDetails;
+	payment_method?: ShoppingcartPaymentMethod;
+	taxes?: ShoppingcartTaxes;
+	total?: {
+		amount?: number;
+		meals?: number;
+	};
+	exemptions?: {
+		tax?: boolean;
+	};
+	order?: {
+		id?: string;
+	};
+	service_fee?: {
+		amount?: number;
+	};
+	delivery_fee?: {
+		amount?: number;
+	};
+	is?: {
+		type?: Record<string, any>;
+		mx_cart?: boolean;
+		email_tax_exempt?: boolean;
+		tax_calculation_required?: boolean;
+		system365?: boolean;
+	};
+}
+
 export interface PostConsumerPromoValidateRequest {
 	// The code of the promo voucher
 	code?: string;
@@ -2035,6 +2167,12 @@ export type PutConsumerShoppingcartBody = PutConsumerShoppingCartItemsRequest;
 
 export type PutConsumerShoppingcartResponse = PutConsumerShoppingCartResponse;
 
+// POST /consumer/shoppingcart - Create a new shopping cart
+
+export type PostConsumerShoppingcartBody = PostConsumerShoppingCartBodyRequest;
+
+export type PostConsumerShoppingcartResponse = PostConsumerShoppingCartResponse;
+
 // POST /consumer/promo/validate - Validate a promo voucher
 
 export type PostConsumerPromoValidateBody = PostConsumerPromoValidateRequest;

package/src/interface/discount.ts

@@ -48,7 +48,7 @@ export interface GetDiscountResponseDTO {
 	createdAt: string;
 	updatedAt: string;
 	name: string;
-	status?: DiscountStatus;
+	status: DiscountStatus;
 	is?: DiscountIs;
 	meta?: DiscountMeta;
 }
@@ -87,7 +87,7 @@ export interface DiscountDTO {
 	createdAt: string;
 	updatedAt: string;
 	name: string;
-	status?: DiscountStatus;
+	status: DiscountStatus;
 	is?: DiscountIs;
 	meta?: DiscountMeta;
 }
@@ -107,7 +107,7 @@ export interface DiscountWithSites {
 	createdAt: string;
 	updatedAt: string;
 	name: string;
-	status?: DiscountStatus;
+	status: DiscountStatus;
 	is?: DiscountIs;
 	meta?: DiscountMeta;
 }
@@ -125,30 +125,32 @@ export interface PostDiscountRequestDTO {
 	createdBy: string;
 	updatedBy?: string;
 	name: string;
-	status?: DiscountStatus;
 	is?: DiscountIs;
 	meta?: DiscountMeta;
 	taxonomy?: DiscountTaxonomy;
+	status?: DiscountStatus;
 }
 
 export interface PostDiscountResponseDTO {
+	// discount id
 	id: string;
+	// user id of discount creator
+	createdBy: string;
+	// user id of most recent update
+	updatedBy: string;
 	createdAt: string;
 	updatedAt: string;
-	updatedBy: string;
 	name: string;
-	status?: DiscountStatus;
+	status: DiscountStatus;
 	is?: DiscountIs;
 	meta?: DiscountMeta;
-	taxonomy?: DiscountTaxonomy;
-	createdBy: string;
 }
 
 export interface PutDiscountRequestDTO {
 	updatedBy: string;
 	taxonomy?: DiscountTaxonomy;
-	name: string;
 	status?: DiscountStatus;
+	name: string;
 	is?: DiscountIs;
 	meta?: DiscountMeta;
 }
@@ -163,7 +165,7 @@ export interface PutDiscountResponseDTO {
 	createdAt: string;
 	updatedAt: string;
 	name: string;
-	status?: DiscountStatus;
+	status: DiscountStatus;
 	is?: DiscountIs;
 	meta?: DiscountMeta;
 }
@@ -183,7 +185,7 @@ export interface PutDiscountPublishResponseDTO {
 	createdAt: string;
 	updatedAt: string;
 	name: string;
-	status?: DiscountStatus;
+	status: DiscountStatus;
 	is?: DiscountIs;
 	meta?: DiscountMeta;
 }
@@ -194,8 +196,8 @@ export interface DeleteDiscountResponseDTO {
 
 export interface PatchDiscountRequestDTO {
 	updatedBy: string;
-	name?: string;
 	status?: DiscountStatus;
+	name?: string;
 	is?: DiscountIs;
 	meta?: DiscountMeta;
 }
@@ -210,7 +212,7 @@ export interface PatchDiscountResponseDTO {
 	createdAt: string;
 	updatedAt: string;
 	name: string;
-	status?: DiscountStatus;
+	status: DiscountStatus;
 	is?: DiscountIs;
 	meta?: DiscountMeta;
 }

package/src/interface/notification.ts

@@ -35,6 +35,14 @@ export interface PushNotificationBody {
 	data?: Record<string, any>;
 }
 
+export interface BatchPushNotificationBody {
+	title: string;
+	text: string;
+	// Recipients of the notification. Example: user ids
+	targets: string[];
+	data?: Record<string, any>;
+}
+
 export interface NotificationStatus {
 	read?: boolean;
 	released?: boolean;
@@ -126,6 +134,16 @@ export interface PostNotificationDevicePushRequest extends BaseRequest {
 	body: PostNotificationDevicePushBody;
 }
 
+// POST /notification/batch/device/push - Send a push notification to many user devices
+
+export type PostNotificationBatchDevicePushBody = BatchPushNotificationBody;
+
+export type PostNotificationBatchDevicePushResponse = Success;
+
+export interface PostNotificationBatchDevicePushRequest extends BaseRequest {
+	body: PostNotificationBatchDevicePushBody;
+}
+
 // GET /notification/swagger.json - Get a swagger for notification service
 
 export interface GetNotificationSwaggerQuery {

package/src/interface/promo.ts

@@ -231,11 +231,12 @@ export interface Voucher {
 	provider_data?: FPValidationData;
 	redeemables?: Redeemable[];
 	stacked_vouchers?: Redeemable[];
+	inapplicable_redeemables?: Redeemable[];
 	[index: string]: any;
 }
 
 export interface Redeemable {
-	status: 'APPLICABLE';
+	status: 'APPLICABLE' | 'INAPPLICABLE';
 	// redeemable
 	id: string;
 	object: 'voucher' | 'promotion_stack' | 'promotion_tier';