@compassdigital/sdk.typescript 4.103.0 → 4.105.0

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@compassdigital/sdk.typescript",
-	"version": "4.103.0",
+	"version": "4.105.0",
 	"description": "Compass Digital Labs TypeScript SDK",
 	"type": "commonjs",
 	"main": "./lib/index.js",
@@ -46,7 +46,7 @@
 	},
 	"devDependencies": {
 		"@compassdigital/review": "^7.3.0",
-		"@compassdigital/sdk.typescript.cli": "^4.30.0",
+		"@compassdigital/sdk.typescript.cli": "^4.32.0",
 		"@swc/core": "^1.4.1",
 		"@swc/jest": "^0.2.36",
 		"@types/jest": "^29.2.4",

package/src/base.ts

@@ -25,6 +25,8 @@ export interface RequestOptions {
 	// https.Agent agent to use
 	// Note: we use 'any' type to remain browser compatible
 	agent?: any;
+	// flag to indicate internal requests
+	internal?: boolean;
 }
 
 /**
@@ -484,6 +486,9 @@ export abstract class BaseServiceClient {
 			'Content-Type': 'application/json',
 			...options.headers,
 		};
+		if (options.internal) {
+			headers['X-Request-Type'] = 'internal';
+		}
 		if (options.token) {
 			headers.Authorization = `Bearer ${options.token}`;
 		}

package/src/index.ts

@@ -1144,16 +1144,16 @@ import {
 } from './interface/review';
 
 import {
-	PostDiscountBody,
-	PostDiscountResponse,
-	GetDiscountsQuery,
-	GetDiscountsResponse,
 	GetDiscountQuery,
 	GetDiscountResponse,
 	PutDiscountBody,
 	PutDiscountResponse,
 	DeleteDiscountBody,
 	DeleteDiscountResponse,
+	GetDiscountsQuery,
+	GetDiscountsResponse,
+	PostDiscountBody,
+	PostDiscountResponse,
 	PutDiscountPublishBody,
 	PutDiscountPublishResponse,
 } from './interface/discount';
@@ -11768,32 +11768,6 @@ export class ServiceClient extends BaseServiceClient {
 		return this.request('review', '/review/{id}', 'get', `/review/${id}`, null, options);
 	}
 
-	/**
-	 * POST /discount - Post a discount
-	 *
-	 * @param body
-	 * @param options - additional request options
-	 */
-	post_discount(
-		body: PostDiscountBody,
-		options?: RequestOptions,
-	): ResponsePromise<PostDiscountResponse> {
-		return this.request('discount', '/discount', 'post', `/discount`, body, options);
-	}
-
-	/**
-	 * GET /discount - Get discounts by taxonomy
-	 *
-	 * @param options - additional request options
-	 */
-	get_discounts(
-		options: {
-			query: GetDiscountsQuery;
-		} & RequestOptions,
-	): ResponsePromise<GetDiscountsResponse> {
-		return this.request('discount', '/discount', 'get', `/discount`, null, options);
-	}
-
 	/**
 	 * GET /discount/{id} - Get a discount
 	 *
@@ -11839,6 +11813,32 @@ export class ServiceClient extends BaseServiceClient {
 		return this.request('discount', '/discount/{id}', 'delete', `/discount/${id}`, body, options);
 	}
 
+	/**
+	 * GET /discount - Get discounts by taxonomy
+	 *
+	 * @param options - additional request options
+	 */
+	get_discounts(
+		options: {
+			query: GetDiscountsQuery;
+		} & RequestOptions,
+	): ResponsePromise<GetDiscountsResponse> {
+		return this.request('discount', '/discount', 'get', `/discount`, null, options);
+	}
+
+	/**
+	 * POST /discount - Post a discount
+	 *
+	 * @param body
+	 * @param options - additional request options
+	 */
+	post_discount(
+		body: PostDiscountBody,
+		options?: RequestOptions,
+	): ResponsePromise<PostDiscountResponse> {
+		return this.request('discount', '/discount', 'post', `/discount`, body, options);
+	}
+
 	/**
 	 * PUT /discount/{id}/publish - update and publish a discount
 	 *

package/src/interface/announcement.ts

@@ -24,7 +24,7 @@ export interface AnnouncementPostRequestBody {
 	is_global?: boolean;
 	allowed_resources?: string[];
 	position?: number;
-	//@deprecated
+	// @deprecated
 	active?: boolean;
 	status?: Status;
 	// Announcement Properties
@@ -65,7 +65,7 @@ export interface AnnouncementPatchRequestBody {
 	is_global?: boolean;
 	allowed_resources?: string[];
 	position?: number;
-	//@deprecated
+	// @deprecated
 	active?: boolean;
 	status?: Status;
 	// Announcement Properties
@@ -89,7 +89,7 @@ export interface Announcement {
 	// True if all the sites are linked
 	is_global: boolean;
 	allowed_resources: string[];
-	//@deprecated
+	// @deprecated
 	active: boolean;
 	status?: Status;
 	schedule?: Schedule;
@@ -103,7 +103,7 @@ export interface Announcement {
 		en?: AnnouncementInfo;
 		fr?: AnnouncementInfo;
 	};
-	//@deprecated
+	// @deprecated
 	date?: Record<string, any>;
 	author?: User;
 	edit_history?: EditHistory[];

package/src/interface/discount.ts

@@ -5,6 +5,7 @@ import { RequestQuery, BaseRequest } from './util';
 
 export interface DiscountStatus {
 	live?: boolean;
+	publishedTo3rdParty?: boolean;
 	readyToPublish?: boolean;
 }
 
@@ -15,39 +16,6 @@ export interface DiscountIs {
 	voucherPromo?: boolean;
 }
 
-export interface PostDiscountRequestDTO {
-	// user is of discount creator
-	createdBy?: string;
-	name?: string;
-	status?: DiscountStatus;
-	is?: DiscountIs;
-	app?: string;
-}
-
-export interface PostDiscountResponseDTO {
-	// user is of discount creator
-	createdBy?: string;
-	id: string;
-	createdAt: string;
-	updatedAt: string;
-	name?: string;
-	status?: DiscountStatus;
-	is?: DiscountIs;
-	app?: string;
-}
-
-export interface BadRequestErrorDTO {
-	message: string;
-	code: number;
-	data: Record<string, any>;
-}
-
-export interface UnauthorizedErrorDTO {
-	message: string;
-	code: number;
-	data: Record<string, any>;
-}
-
 export interface VoucherifyMetaDataDiscount {
 	type: string;
 	amountOff?: number;
@@ -74,6 +42,7 @@ export interface GetDiscountResponseDTO {
 	id: string;
 	createdAt: string;
 	updatedAt: string;
+	updatedBy?: string;
 	name?: string;
 	status?: DiscountStatus;
 	is?: DiscountIs;
@@ -81,6 +50,12 @@ export interface GetDiscountResponseDTO {
 	meta?: DiscountMeta;
 }
 
+export interface UnauthorizedErrorDTO {
+	message: string;
+	code: number;
+	data: Record<string, any>;
+}
+
 export interface NotFoundErrorDTO {
 	message: string;
 	code: number;
@@ -93,6 +68,7 @@ export interface DiscountDTO {
 	id: string;
 	createdAt: string;
 	updatedAt: string;
+	updatedBy?: string;
 	name?: string;
 	status?: DiscountStatus;
 	is?: DiscountIs;
@@ -104,9 +80,30 @@ export interface GetDiscountsResponseDTO {
 	discounts: DiscountDTO[];
 }
 
+export interface BadRequestErrorDTO {
+	message: string;
+	code: number;
+	data: Record<string, any>;
+}
+
+export interface PostDiscountRequestDTO {
+	createdBy: string;
+	name: string;
+	app: string;
+}
+
+export interface PostDiscountResponseDTO {
+	createdBy: string;
+	name: string;
+	app: string;
+	id: string;
+	createdAt: string;
+	updatedAt: string;
+}
+
 export interface PutDiscountRequestDTO {
 	taxonomy?: Record<string, any>;
-	id: string;
+	updatedBy?: string;
 	name?: string;
 	status?: DiscountStatus;
 	is?: DiscountIs;
@@ -120,6 +117,7 @@ export interface PutDiscountResponseDTO {
 	id: string;
 	createdAt: string;
 	updatedAt: string;
+	updatedBy?: string;
 	name?: string;
 	status?: DiscountStatus;
 	is?: DiscountIs;
@@ -131,7 +129,7 @@ export type InternalServerErrorException = Record<string, any>;
 
 export interface PutDiscountPublishRequestDTO {
 	taxonomy?: Record<string, any>;
-	id: string;
+	updatedBy?: string;
 	name?: string;
 	status?: DiscountStatus;
 	is?: DiscountIs;
@@ -145,6 +143,7 @@ export interface PutDiscountPublishResponseDTO {
 	id: string;
 	createdAt: string;
 	updatedAt: string;
+	updatedBy?: string;
 	name?: string;
 	status?: DiscountStatus;
 	is?: DiscountIs;
@@ -162,29 +161,6 @@ export interface DeleteDiscountResponseDTO {
 	success: boolean;
 }
 
-// POST /discount - Post a discount
-
-export type PostDiscountBody = PostDiscountRequestDTO;
-
-export type PostDiscountResponse = PostDiscountResponseDTO;
-
-export interface PostDiscountRequest extends BaseRequest {
-	body: PostDiscountBody;
-}
-
-// GET /discount - Get discounts by taxonomy
-
-export interface GetDiscountsQuery {
-	taxonomyFilter: string;
-	active: boolean;
-	// Graphql query string
-	_query?: string;
-}
-
-export type GetDiscountsResponse = GetDiscountsResponseDTO;
-
-export interface GetDiscountsRequest extends BaseRequest, RequestQuery<GetDiscountsQuery> {}
-
 // GET /discount/{id} - Get a discount
 
 export interface GetDiscountPath {
@@ -233,6 +209,29 @@ export interface DeleteDiscountRequest extends BaseRequest, DeleteDiscountPath {
 	body: DeleteDiscountBody;
 }
 
+// GET /discount - Get discounts by taxonomy
+
+export interface GetDiscountsQuery {
+	taxonomyFilter: string;
+	active: boolean;
+	// Graphql query string
+	_query?: string;
+}
+
+export type GetDiscountsResponse = GetDiscountsResponseDTO;
+
+export interface GetDiscountsRequest extends BaseRequest, RequestQuery<GetDiscountsQuery> {}
+
+// POST /discount - Post a discount
+
+export type PostDiscountBody = PostDiscountRequestDTO;
+
+export type PostDiscountResponse = PostDiscountResponseDTO;
+
+export interface PostDiscountRequest extends BaseRequest {
+	body: PostDiscountBody;
+}
+
 // PUT /discount/{id}/publish - update and publish a discount
 
 export interface PutDiscountPublishPath {

package/src/interface/location.ts

@@ -83,9 +83,9 @@ export interface Brand {
 	};
 	timezone?: string;
 	description?: string;
-	//@deprecated
+	// @deprecated
 	latitude?: number;
-	//@deprecated
+	// @deprecated
 	longitude?: number;
 	address?: Address;
 	menus?: MenuHours[];
@@ -154,7 +154,7 @@ export interface Brand {
 	group?: string;
 	// The CDL id representing the payment provider of this brand
 	payment_provider?: string;
-	//@deprecated
+	// @deprecated
 	location_description?: string;
 	// The CDL id representing the company of this brand
 	company?: string;
@@ -368,7 +368,7 @@ export interface Locations {
 }
 
 export interface Multigroups {
-	//@deprecated
+	// @deprecated
 	groups?: MultiGroup[];
 	multigroups?: MultiGroup[];
 }
@@ -510,9 +510,9 @@ export interface PostLocationRequest extends BaseRequest {
 // GET /location/search - Gets Location within a radius of the provided point
 
 export interface GetLocationSearchQuery {
-	//@deprecated
+	// @deprecated
 	lat?: number;
-	//@deprecated
+	// @deprecated
 	long?: number;
 	// Operation id to be used
 	operation_id?: number;
@@ -767,7 +767,7 @@ export interface GetLocationGroupQuery {
 	non_market_places?: boolean;
 	// return only groups with non-scan & go locations/brands
 	non_scan_go?: boolean;
-	//@deprecated
+	// @deprecated
 	include_estimated_wait_time?: boolean;
 	// Graphql query string
 	_query?: string;

package/src/interface/mealplan.ts

@@ -171,7 +171,7 @@ export interface PostMealplanCallbackBody {
 
 export interface PostMealplanCallbackResponse {
 	token?: string;
-	//@deprecated
+	// @deprecated
 	cardNumber?: string;
 }
 

package/src/interface/menu.ts

@@ -84,7 +84,7 @@ export interface Item {
 	ingredients?: Record<string, any>[];
 	amount_off_exclusions?: AmountOffExclusionTypes[];
 	nutrition?: {
-		//@deprecated
+		// @deprecated
 		kcal?: number;
 		calories?: Nutrition;
 		serving_size?: Nutrition;
@@ -195,7 +195,7 @@ export interface Item {
 			secondary?: string;
 		};
 	};
-	//@deprecated
+	// @deprecated
 	is_deleted?: boolean;
 	is?: {
 		disabled?: boolean;
@@ -215,7 +215,7 @@ export interface Group {
 		fr?: string;
 	};
 	items?: Item[];
-	//@deprecated
+	// @deprecated
 	is_disabled?: boolean;
 	is?: {
 		disabled?: boolean;
@@ -270,7 +270,7 @@ export interface Option {
 	};
 	sku?: number;
 	nutrition?: {
-		//@deprecated
+		// @deprecated
 		kcal?: number;
 		calories?: Nutrition;
 	};

package/src/interface/order.ts

@@ -28,9 +28,9 @@ export interface CreateOrder {
 		active_override?: boolean;
 		[index: string]: any;
 	};
-	//@deprecated
+	// @deprecated
 	pickup?: string;
-	//@deprecated
+	// @deprecated
 	pickup_name?: string;
 	requested_date?: string;
 	details?: {
@@ -54,7 +54,7 @@ export interface Error {
 export interface Issue {
 	id?: string;
 	type?: string;
-	//@deprecated
+	// @deprecated
 	item?: Record<string, any>;
 	// Array of Items with issues
 	items?: ItemsWithIssue[];
@@ -134,11 +134,11 @@ export interface Order {
 		// Date order was polled for kds
 		polled?: string;
 	};
-	//@deprecated
+	// @deprecated
 	pickup?: string;
-	//@deprecated
+	// @deprecated
 	pickup_name?: string;
-	//@deprecated
+	// @deprecated
 	pickup_id?: string;
 	requested_date?: string;
 	details?: {
@@ -298,7 +298,7 @@ export interface MealPlan {
 export interface OrderIssue {
 	// Type of issue
 	type?: string;
-	//@deprecated
+	// @deprecated
 	item?: Record<string, any>;
 	// Array of Items with issues
 	items?: ItemsWithIssue[];
@@ -502,9 +502,9 @@ export interface GetOrderCustomerOrdersPath {
 export interface GetOrderCustomerOrdersQuery {
 	// Sort the customers order by order created date, pickup date or requested date. Possible values: created, pickup. Default is created.
 	sort?: string;
-	//@deprecated
+	// @deprecated
 	pickup_start?: number;
-	//@deprecated
+	// @deprecated
 	pickup_end?: number;
 	// Filter orders by their requested date. Only return orders that have a date less than or equal to the date. Default is 24 hours from the current time in milliseconds.
 	end?: number;
@@ -558,9 +558,9 @@ export interface GetOrderLocationBrandPath {
 }
 
 export interface GetOrderLocationBrandQuery {
-	//@deprecated
+	// @deprecated
 	pickup_start?: number;
-	//@deprecated
+	// @deprecated
 	pickup_end?: number;
 	// Filter orders to just those with this ready state
 	ready?: boolean;
@@ -595,9 +595,9 @@ export interface GetOrderLocationOrdersPath {
 }
 
 export interface GetOrderLocationOrdersQuery {
-	//@deprecated
+	// @deprecated
 	pickup_start?: number;
-	//@deprecated
+	// @deprecated
 	pickup_end?: number;
 	// Filter orders to just those with this ready state
 	ready?: boolean;

package/src/interface/partner.ts

@@ -50,7 +50,7 @@ export interface ShoppingCartResponse {
 			}[];
 		};
 	};
-	//@deprecated
+	// @deprecated
 	loyalty?: {
 		coupon?: {
 			code?: string;
@@ -451,9 +451,9 @@ export interface Brand {
 	};
 	timezone?: string;
 	description?: string;
-	//@deprecated
+	// @deprecated
 	latitude?: number;
-	//@deprecated
+	// @deprecated
 	longitude?: number;
 	address?: Address;
 	menus?: MenuHours[];
@@ -522,7 +522,7 @@ export interface Brand {
 	group?: string;
 	// The CDL id representing the payment provider of this brand
 	payment_provider?: string;
-	//@deprecated
+	// @deprecated
 	location_description?: string;
 	// The CDL id representing the company of this brand
 	company?: string;
@@ -747,7 +747,7 @@ export interface Group {
 		ingredients?: Record<string, any>[];
 		amount_off_exclusions?: AmountOffExclusionTypes[];
 		nutrition?: {
-			//@deprecated
+			// @deprecated
 			kcal?: number;
 			calories?: Nutrition;
 			serving_size?: Nutrition;
@@ -831,7 +831,7 @@ export interface Group {
 				};
 				sku?: number;
 				nutrition?: {
-					//@deprecated
+					// @deprecated
 					kcal?: number;
 					calories?: Nutrition;
 				};
@@ -976,7 +976,7 @@ export interface Group {
 				secondary?: string;
 			};
 		};
-		//@deprecated
+		// @deprecated
 		is_deleted?: boolean;
 		is?: {
 			disabled?: boolean;
@@ -987,7 +987,7 @@ export interface Group {
 			featured?: boolean;
 		};
 	}[];
-	//@deprecated
+	// @deprecated
 	is_disabled?: boolean;
 	is?: {
 		disabled?: boolean;

package/src/interface/shoppingcart.ts

@@ -314,7 +314,7 @@ export interface ShoppingCartResponse {
 		amount?: MonetaryValue;
 	};
 	promo?: PromoDetails;
-	//@deprecated
+	// @deprecated
 	loyalty?: {
 		coupon?: {
 			code?: string;

package/src/interface/task.ts

@@ -130,7 +130,7 @@ export interface OrderIssue {
 	// issue
 	id?: string;
 	type?: string;
-	//@deprecated
+	// @deprecated
 	item?: Record<string, any>;
 	// Array of Items with issues
 	items?: Record<string, any>[];

package/src/interface/user.ts

@@ -36,7 +36,7 @@ export interface User {
 		locked_out?: boolean;
 		// If the users email is verified
 		verified?: boolean;
-		//@deprecated
+		// @deprecated
 		phone_verified?: boolean;
 		// User deleted status
 		deleted?: boolean;
@@ -98,7 +98,7 @@ export interface success {
 }
 
 export interface auth {
-	//@deprecated
+	// @deprecated
 	token?: string;
 	access?: {
 		token?: string;
@@ -113,7 +113,7 @@ export interface auth {
 }
 
 export interface guestAuth {
-	//@deprecated
+	// @deprecated
 	token?: string;
 	access?: {
 		token?: string;
@@ -141,7 +141,7 @@ export interface omsauth {
 }
 
 export interface guestAuthToken {
-	//@deprecated
+	// @deprecated
 	token?: string;
 	access?: {
 		token?: string;
@@ -304,7 +304,7 @@ export interface UserMeta {
 		attempts?: number;
 		first_attempted?: string;
 	};
-	//@deprecated
+	// @deprecated
 	phone_verification?: {
 		verification_code?: string;
 		date_generated?: number;