@compassdigital/sdk.typescript 4.157.0 → 4.159.0

package/lib/messages/commands/SendPushNotificationCommand.d.ts

@@ -7,8 +7,8 @@ export interface SendPushNotificationCommand {
         traceId?: string;
     };
     payload: {
-        notification?: {
-            targets: Record<string, any>[];
+        notification: {
+            targets: string[];
             createdAt: string;
             updatedAt: string;
             title: string;

package/lib/messages/commands/SendPushNotificationCommand.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"SendPushNotificationCommand.d.ts","sourceRoot":"","sources":["../../../src/messages/commands/SendPushNotificationCommand.ts"],"names":[],"mappings":"AAEA,MAAM,WAAW,2BAA2B;IAC3C,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,6BAA6B,CAAC;IACpC,OAAO,EAAE,OAAO,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,YAAY,EAAE;QACb,OAAO,CAAC,EAAE,MAAM,CAAC;KACjB,CAAC;IACF,OAAO,EAAE;QACR,YAAY,CAAC,EAAE;YACd,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE,CAAC;YAC/B,SAAS,EAAE,MAAM,CAAC;YAClB,SAAS,EAAE,MAAM,CAAC;YAClB,KAAK,EAAE,MAAM,CAAC;YACd,IAAI,EAAE,MAAM,CAAC;YACb,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;SAC3B,CAAC;KACF,CAAC;IACF,MAAM,EAAE,MAAM,CAAC;CACf"}
+{"version":3,"file":"SendPushNotificationCommand.d.ts","sourceRoot":"","sources":["../../../src/messages/commands/SendPushNotificationCommand.ts"],"names":[],"mappings":"AAEA,MAAM,WAAW,2BAA2B;IAC3C,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,6BAA6B,CAAC;IACpC,OAAO,EAAE,OAAO,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,YAAY,EAAE;QACb,OAAO,CAAC,EAAE,MAAM,CAAC;KACjB,CAAC;IACF,OAAO,EAAE;QACR,YAAY,EAAE;YACb,OAAO,EAAE,MAAM,EAAE,CAAC;YAClB,SAAS,EAAE,MAAM,CAAC;YAClB,SAAS,EAAE,MAAM,CAAC;YAClB,KAAK,EAAE,MAAM,CAAC;YACd,IAAI,EAAE,MAAM,CAAC;YACb,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;SAC3B,CAAC;KACF,CAAC;IACF,MAAM,EAAE,MAAM,CAAC;CACf"}

package/package.json

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

package/src/index.ts

@@ -909,7 +909,11 @@ import {
 	PostMenuV4BrandResponse,
 	GetMenuV4BrandQuery,
 	GetMenuV4BrandResponse,
+	PatchMenuV4BrandBody,
+	PatchMenuV4BrandResponse,
 	DeleteMenuV4BrandResponse,
+	PostMenuV4BrandAttachmentQuery,
+	PostMenuV4BrandAttachmentResponse,
 	PostMenuV4BrandMenuBody,
 	PostMenuV4BrandMenuResponse,
 	PatchMenuV4BrandMenuBody,
@@ -1137,6 +1141,8 @@ import {
 	GetPaymentListByBrandResponse,
 	GetCustomerOrdersQuery,
 	GetCustomerOrdersResponse,
+	PostConsumerOrderBody,
+	PostConsumerOrderResponse,
 	PostReviewOrderItemsBody,
 	PostReviewOrderItemsResponse,
 	GetConsumerHomePageQuery,
@@ -9881,6 +9887,28 @@ export class ServiceClient extends BaseServiceClient {
 		);
 	}
 
+	/**
+	 * PATCH /menu/v4/brand/{id}
+	 *
+	 * @param id
+	 * @param body
+	 * @param options - additional request options
+	 */
+	patch_menu_v4_brand(
+		id: string,
+		body: PatchMenuV4BrandBody,
+		options?: RequestOptions,
+	): ResponsePromise<PatchMenuV4BrandResponse> {
+		return this.request(
+			'menu',
+			'/menu/v4/brand/{id}',
+			'PATCH',
+			`/menu/v4/brand/${id}`,
+			body,
+			options,
+		);
+	}
+
 	/**
 	 * DELETE /menu/v4/brand/{id}
 	 *
@@ -9901,6 +9929,30 @@ export class ServiceClient extends BaseServiceClient {
 		);
 	}
 
+	/**
+	 * POST /menu/v4/brand/{id}/attachment/{name}
+	 *
+	 * @param id
+	 * @param name
+	 * @param options - additional request options
+	 */
+	post_menu_v4_brand_attachment(
+		id: string,
+		name: 'thumbnail',
+		options?: {
+			query?: PostMenuV4BrandAttachmentQuery;
+		} & RequestOptions,
+	): ResponsePromise<PostMenuV4BrandAttachmentResponse> {
+		return this.request(
+			'menu',
+			'/menu/v4/brand/{id}/attachment/{name}',
+			'POST',
+			`/menu/v4/brand/${id}/attachment/${name}`,
+			null,
+			options,
+		);
+	}
+
 	/**
 	 * POST /menu/v4/brand/{id}/menu
 	 *
@@ -12148,6 +12200,19 @@ export class ServiceClient extends BaseServiceClient {
 		);
 	}
 
+	/**
+	 * POST /consumer/order - Create a new order
+	 *
+	 * @param body
+	 * @param options - additional request options
+	 */
+	post_consumer_order(
+		body: PostConsumerOrderBody,
+		options?: RequestOptions,
+	): ResponsePromise<PostConsumerOrderResponse> {
+		return this.request('consumer', '/consumer/order', 'POST', `/consumer/order`, body, options);
+	}
+
 	/**
 	 * POST /consumer/review/order-items - Submit reviews for order items
 	 *

package/src/interface/announcement.ts

@@ -24,7 +24,6 @@ export interface AnnouncementPostRequestBody {
 	is_global?: boolean;
 	allowed_resources?: string[];
 	position?: number;
-	// @deprecated
 	active?: boolean;
 	status?: Status;
 	// Announcement Properties
@@ -65,7 +64,6 @@ export interface AnnouncementPatchRequestBody {
 	is_global?: boolean;
 	allowed_resources?: string[];
 	position?: number;
-	// @deprecated
 	active?: boolean;
 	status?: Status;
 	// Announcement Properties
@@ -89,7 +87,6 @@ export interface Announcement {
 	// True if all the sites are linked
 	is_global: boolean;
 	allowed_resources: string[];
-	// @deprecated
 	active: boolean;
 	status?: Status;
 	schedule?: Schedule;

package/src/interface/centricos.ts

@@ -238,8 +238,6 @@ export interface CentricVoucherifyMetaData {
 export interface CentricDiscountIs {
 	badgepayPromo?: boolean;
 	mealplanPromo?: boolean;
-	decliningBalancePromo?: boolean;
-	voucherPromo?: boolean;
 }
 
 export interface PutDiscountVoucherifyRequestDiscount {
@@ -258,6 +256,8 @@ export interface PutDiscountVoucherifyRequestDTO {
 	discount: PutDiscountVoucherifyRequestDiscount;
 	// List of site IDs
 	sites?: string[];
+	// List of brand IDs
+	brands?: string[];
 }
 
 export interface CentricDiscountStatus {
@@ -287,10 +287,12 @@ export interface DiscountResponseDTO {
 export interface PutDiscountVoucherifyResponseDTO {
 	// List of site IDs
 	sites: string[];
+	// List of brand IDs
+	brands: string[];
 	discount: DiscountResponseDTO;
 }
 
-export interface SiteDTO {
+export interface DiscountEntityDTO {
 	// The ID of the site
 	id: string;
 	// The name of the site
@@ -309,7 +311,7 @@ export interface PutDiscountVoucherifyPublishResponseDTO {
 		[index: string]: any;
 	} & CentricVoucherifyMetaData;
 	// List of sites where discount is published
-	sites?: SiteDTO[];
+	sites?: DiscountEntityDTO[];
 	id: string;
 	createdAt: string;
 	updatedAt: string;
@@ -338,17 +340,21 @@ export interface DiscountDTO {
 export interface GetDiscountResponseDTO {
 	discount: DiscountDTO;
 	// The sites associated with the discount
-	sites: SiteDTO[];
+	sites: DiscountEntityDTO[];
+	// The brands associated with the discount
+	brands: DiscountEntityDTO[];
 }
 
-export interface DiscountWithSitesDTO {
+export interface DiscountWithEntitiesDTO {
 	discount: DiscountDTO;
 	// The sites associated with the discount
-	sites: SiteDTO[];
+	sites: DiscountEntityDTO[];
+	// The brands associated with the discount
+	brands: DiscountEntityDTO[];
 }
 
 export interface GetAllDiscountsResponseDTO {
-	discounts: DiscountWithSitesDTO[];
+	discounts: DiscountWithEntitiesDTO[];
 }
 
 // POST /centricos/ai/item/description - Generate item description

package/src/interface/consumer.ts

@@ -235,7 +235,7 @@ export interface OrderRefundItem {
 }
 
 export interface OrderCreditCard {
-	// The credit card type (Amex, Visa, Mastercard, etc...
+	// The credit card type (Amex, Visa, Mastercard, etc...)
 	card_type?: string;
 	// The last 4 digits of the card number
 	last4?: string;
@@ -267,6 +267,7 @@ export interface OrderMealplan {
 	id?: string;
 	// tender
 	tender?: string;
+	// mealplan name
 	name?: string;
 }
 
@@ -553,7 +554,7 @@ export interface ConsumerDiscountIs {
 }
 
 export interface ConsumerVoucherifyMetaDataDiscount {
-	type: Record<string, any>;
+	type: 'AMOUNT_OFF' | 'PERCENT_OFF';
 	amountOff?: number;
 	percentOff?: number;
 }
@@ -582,7 +583,7 @@ export interface ConsumerStackedDiscount {
 	status?: ConsumerDiscountStatus;
 	is?: ConsumerDiscountIs;
 	meta?: ConsumerDiscountMeta;
-	applied_amount?: number;
+	applied_amount: number;
 }
 
 export interface Discounts {
@@ -800,6 +801,138 @@ export interface GetCustomerOrdersResponseDTO {
 	orders: CustomerOrder[];
 }
 
+export interface CreateOrderPayment {
+	token?: string;
+	credit_card?: OrderCreditCard;
+	badge_pay?: OrderCashlessPayment;
+	stipend?: OrderCashlessPayment;
+	voucher?: OrderCashlessPayment;
+	coupon_voucher?: OrderCashlessPayment;
+}
+
+export interface CreateOrderIs {
+	in_progress?: boolean;
+	ready?: boolean;
+}
+
+export interface CreateOrderMeta {
+	// which ui the order was placed on
+	source?: 'web' | 'mobile';
+	// Override for meta.active for testing purposes
+	active_override?: boolean;
+}
+
+export interface CreateOrderDetails {
+	name?: string;
+	contact_number?: string;
+	country_code?: string;
+	order_type?: string;
+	duration?: string;
+	destination?: string;
+	// Pickup or delivery instructions
+	instructions?: string;
+}
+
+export interface PostOrderBodyDto {
+	// The location brand
+	location_brand?: string;
+	// The location
+	location?: string;
+	// The shoppingcart
+	shoppingcart?: string;
+	payment?: CreateOrderPayment;
+	mealplan?: OrderMealplan;
+	// User ID
+	customer?: string;
+	is?: CreateOrderIs;
+	meta?: {
+		[index: string]: any;
+	} & CreateOrderMeta;
+	// Pickup (deprecated)
+	pickup?: string;
+	// Pickup name (deprecated)
+	pickup_name?: string;
+	// Requested date
+	requested_date?: string;
+	details?: CreateOrderDetails;
+}
+
+export interface PlacedOrderMeta {
+	// Check-in UUID for frictionless orders
+	checkin_uuid?: string;
+	// which ui the order was placed on
+	source?: 'web' | 'mobile';
+	transaction?: OrderTransaction;
+	shoppingcart?: OrderMetaShoppingcart;
+	// Indicate whether the order is active or inactive
+	active?: boolean;
+	// Override for meta.active for testing purposes
+	active_override?: boolean;
+	delivery?: OrderDelivery;
+	discount?: OrderDiscount;
+	// The type of kds that the brand uses
+	type_of_kds?: string;
+	// Indicate whether the order is eligible for cancellation
+	cancel_eligible?: boolean;
+	refunds?: OrderRefundTransaction[];
+}
+
+export interface PostOrderResponseDto {
+	// Order ID
+	id?: string;
+	// Brand/location ID
+	location_brand?: string;
+	// Location ID
+	location?: string;
+	// Shopping cart ID
+	shoppingcart?: string;
+	payment?: OrderPayment;
+	mealplan?: OrderMealplan;
+	meal_swipes?: OrderMealSwipes;
+	meal_exchange?: OrderMealplan;
+	// User ID
+	customer?: string;
+	is?: OrderIs;
+	date?: OrderDate;
+	// Pickup (deprecated)
+	pickup?: string;
+	// Pickup name (deprecated)
+	pickup_name?: string;
+	// Pickup ID (deprecated)
+	pickup_id?: string;
+	// Requested date
+	requested_date?: string;
+	details?: OrderDetails;
+	meta?: {
+		[index: string]: any;
+	} & PlacedOrderMeta;
+	issue?: OrderIssue;
+	// Past issues
+	past_issues?: OrderIssue[];
+	// Delivery user
+	runner?: string;
+	// Reorder eligibility
+	reorder_eligibility?:
+		| 'eligible'
+		| 'order_type_ineligible'
+		| 'location_ineligible'
+		| 'active_order'
+		| 'old_order'
+		| 'marketplace_order'
+		| 'duplicate_order'
+		| 'brand_unavailable'
+		| 'menu_unavailable'
+		| 'items_unavailable'
+		| 'refunded_order'
+		| 'modifiers_unavailable'
+		| 'modified_items'
+		| 'cancelled_order';
+	// Refunds
+	refunds?: OrderRefundItem[];
+	// Latest refunds
+	latest_refunds?: OrderRefundItem[];
+}
+
 export interface PostReviewOrderItemRequest {
 	// rating score
 	score: number;
@@ -1987,6 +2120,12 @@ export interface GetCustomerOrdersQuery {
 
 export type GetCustomerOrdersResponse = GetCustomerOrdersResponseDTO;
 
+// POST /consumer/order - Create a new order
+
+export type PostConsumerOrderBody = PostOrderBodyDto;
+
+export type PostConsumerOrderResponse = PostOrderResponseDto;
+
 // POST /consumer/review/order-items - Submit reviews for order items
 
 export type PostReviewOrderItemsBody = PostReviewOrderItemsRequestDTO;

package/src/interface/discount.ts

@@ -14,8 +14,6 @@ export interface DiscountStatus {
 export interface DiscountIs {
 	badgepayPromo?: boolean;
 	mealplanPromo?: boolean;
-	decliningBalancePromo?: boolean;
-	voucherPromo?: boolean;
 }
 
 export interface VoucherifyMetaDataDiscount {

package/src/interface/menu.ts

@@ -7578,6 +7578,99 @@ export interface GetMenuV4BrandRequest
 		RequestQuery<GetMenuV4BrandQuery>,
 		GetMenuV4BrandPath {}
 
+// PATCH /menu/v4/brand/{id}
+
+export interface PatchMenuV4BrandPath {
+	id: string;
+}
+
+export interface PatchMenuV4BrandBody {
+	parent?: DraftBrandDTO;
+	children?: DraftBrandDTO[];
+	menus?: DraftMenuDTO[];
+	categories?: DraftCategoryDTO[];
+	category_to_item_relationships?: DraftCategoryToItemRelationshipDTO[];
+	items?: DraftItemDTO[];
+	item_to_modifier_group_relationships?: DraftItemToModifierGroupRelationshipDTO[];
+	modifier_groups?: DraftModifierGroupDTO[];
+	modifier_group_to_modifier_relationships?: DraftModifierGroupToModifierRelationshipDTO[];
+	modifiers?: DraftModifierDTO[];
+	statuses?: BrandStatusDTO[];
+	audit_logs?: AuditDTO[];
+	catalog_id?: number;
+	published_catalog_id?: number;
+	stocks?: StockDTO[];
+	name: string;
+	description?: string;
+	is_active?: boolean;
+	type?: 'global' | 'local';
+	parent_id?: string;
+	local_menu_group_id?: string;
+	global_menu_group_id?: string;
+	posid_segment?: string;
+	is_simplified_view?: boolean;
+	auto_push_to_local?: boolean;
+	frictionless_partner?: string;
+	meta?: BrandMeta;
+	supported_languages?: SupportedLanguages;
+	applied_diff_snapshot?: Record<string, any>;
+	changes?: BrandChangeDTO[];
+	local_menu_group?: LocalMenuGroupDTO;
+	global_menu_group?: GlobalMenuGroupDTO;
+	vendor_metadata?: VendorMetadataDTO[];
+	attachments?: FileAttachmentsDTO;
+	permissions?: Record<string, any>;
+	[index: string]: any;
+}
+
+export interface PatchMenuV4BrandResponse {
+	parent?: DraftBrandDTO;
+	children?: DraftBrandDTO[];
+	menus?: DraftMenuDTO[];
+	categories?: DraftCategoryDTO[];
+	category_to_item_relationships?: DraftCategoryToItemRelationshipDTO[];
+	items?: DraftItemDTO[];
+	item_to_modifier_group_relationships?: DraftItemToModifierGroupRelationshipDTO[];
+	modifier_groups?: DraftModifierGroupDTO[];
+	modifier_group_to_modifier_relationships?: DraftModifierGroupToModifierRelationshipDTO[];
+	modifiers?: DraftModifierDTO[];
+	statuses?: BrandStatusDTO[];
+	audit_logs?: AuditDTO[];
+	catalog_id?: number;
+	published_catalog_id?: number;
+	stocks?: StockDTO[];
+	id: string;
+	created_at?: string;
+	updated_at?: string;
+	deleted_at?: string;
+	name: string;
+	description?: string;
+	is_active?: boolean;
+	type?: 'global' | 'local';
+	parent_id?: string;
+	local_menu_group_id?: string;
+	global_menu_group_id?: string;
+	posid_segment?: string;
+	is_simplified_view?: boolean;
+	auto_push_to_local?: boolean;
+	frictionless_partner?: string;
+	meta?: BrandMeta;
+	supported_languages?: SupportedLanguages;
+	applied_diff_snapshot?: Record<string, any>;
+	version?: number;
+	changes?: BrandChangeDTO[];
+	local_menu_group?: LocalMenuGroupDTO;
+	global_menu_group?: GlobalMenuGroupDTO;
+	vendor_metadata?: VendorMetadataDTO[];
+	attachments?: FileAttachmentsDTO;
+	permissions?: Record<string, any>;
+	[index: string]: any;
+}
+
+export interface PatchMenuV4BrandRequest extends BaseRequest, PatchMenuV4BrandPath {
+	body: PatchMenuV4BrandBody;
+}
+
 // DELETE /menu/v4/brand/{id}
 
 export interface DeleteMenuV4BrandPath {
@@ -7630,6 +7723,26 @@ export interface DeleteMenuV4BrandResponse {
 
 export interface DeleteMenuV4BrandRequest extends BaseRequest, DeleteMenuV4BrandPath {}
 
+// POST /menu/v4/brand/{id}/attachment/{name}
+
+export interface PostMenuV4BrandAttachmentPath {
+	name: 'thumbnail';
+	id: string;
+}
+
+export interface PostMenuV4BrandAttachmentQuery {
+	'body.data'?: string;
+}
+
+export interface PostMenuV4BrandAttachmentResponse {
+	status?: string;
+}
+
+export interface PostMenuV4BrandAttachmentRequest
+	extends BaseRequest,
+		RequestQuery<PostMenuV4BrandAttachmentQuery>,
+		PostMenuV4BrandAttachmentPath {}
+
 // POST /menu/v4/brand/{id}/menu
 
 export interface PostMenuV4BrandMenuPath {

package/src/messages/commands/SendPushNotificationCommand.ts

@@ -9,8 +9,8 @@ export interface SendPushNotificationCommand {
 		traceId?: string;
 	};
 	payload: {
-		notification?: {
-			targets: Record<string, any>[];
+		notification: {
+			targets: string[];
 			createdAt: string;
 			updatedAt: string;
 			title: string;