@compassdigital/sdk.typescript 4.683.0 → 4.686.0

package/manifest.json

@@ -171,6 +171,10 @@
 			"options": {
 				"request": false
 			}
+		},
+		{
+			"name": "delivery",
+			"swagger": "../../api/platform2/delivery/swagger.json"
 		}
 	]
 }

package/package.json

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

package/src/index.ts

@@ -948,6 +948,8 @@ import {
 	PatchMenuV4BrandMenuBody,
 	PatchMenuV4BrandMenuResponse,
 	DeleteMenuV4BrandMenuResponse,
+	PatchMenuV4BrandMenusReorderBody,
+	PatchMenuV4BrandMenusReorderResponse,
 	GetMenuV4BrandItemsQuery,
 	GetMenuV4BrandItemsResponse,
 	GetMenuV4BrandModifierGroupsQuery,
@@ -1378,6 +1380,8 @@ import {
 	GetCentricosDiscountResponse,
 	GetCentricosDiscountsQuery,
 	GetCentricosDiscountsResponse,
+	GetCentricosDiscountsSitesQuery,
+	GetCentricosDiscountsSitesResponse,
 	GetRecommendationsBySiteResponse,
 	GetDescriptionRecommendationsQuery,
 	GetDescriptionRecommendationsResponse,
@@ -1580,6 +1584,8 @@ import {
 	GetForecastingHealthResponse,
 } from './interface/forecasting';
 
+import { GetDeliveryHealthResponse } from './interface/delivery';
+
 import { BaseServiceClient, RequestOptions, ResponsePromise } from './base';
 export * from './base';
 
@@ -11132,6 +11138,28 @@ export class ServiceClient extends BaseServiceClient {
 		);
 	}
 
+	/**
+	 * PATCH /menu/v4/brand/{brand_id}/menus/reorder
+	 *
+	 * @param brand_id
+	 * @param body
+	 * @param options - additional request options
+	 */
+	patch_menu_v4_brand_menus_reorder(
+		brand_id: string,
+		body: PatchMenuV4BrandMenusReorderBody,
+		options?: RequestOptions,
+	): ResponsePromise<PatchMenuV4BrandMenusReorderResponse> {
+		return this.request(
+			'menu',
+			'/menu/v4/brand/{brand_id}/menus/reorder',
+			'PATCH',
+			`/menu/v4/brand/${brand_id}/menus/reorder`,
+			body,
+			options,
+		);
+	}
+
 	/**
 	 * GET /menu/v4/brand/{id}/items
 	 *
@@ -15953,6 +15981,26 @@ export class ServiceClient extends BaseServiceClient {
 		);
 	}
 
+	/**
+	 * GET /centricos/discounts/sites - Get sites (id and name only) for the discount site picker
+	 *
+	 * @param options - additional request options
+	 */
+	get_centricos_discounts_sites(
+		options: {
+			query: GetCentricosDiscountsSitesQuery;
+		} & RequestOptions,
+	): ResponsePromise<GetCentricosDiscountsSitesResponse> {
+		return this.request(
+			'centricos',
+			'/centricos/discounts/sites',
+			'GET',
+			`/centricos/discounts/sites`,
+			null,
+			options,
+		);
+	}
+
 	/**
 	 * GET /centricos/recommendations/{siteId} - Get recommendations by site
 	 *
@@ -17930,4 +17978,20 @@ export class ServiceClient extends BaseServiceClient {
 			options,
 		);
 	}
+
+	/**
+	 * GET /delivery/health - Delivery service readiness check
+	 *
+	 * @param options - additional request options
+	 */
+	get_delivery_health(options?: RequestOptions): ResponsePromise<GetDeliveryHealthResponse> {
+		return this.request(
+			'delivery',
+			'/delivery/health',
+			'GET',
+			`/delivery/health`,
+			null,
+			options,
+		);
+	}
 }

package/src/interface/centricos.ts

@@ -816,6 +816,16 @@ export interface GetDiscountsResponseDTO {
 	meta: MetaResultsDTO;
 }
 
+export interface DiscountSiteDTO {
+	id: string;
+	name: string;
+}
+
+export interface GetDiscountSitesResponseDTO {
+	meta: PageMetadata;
+	results: DiscountSiteDTO[];
+}
+
 export interface VisualDataset {
 	// Label for the dataset
 	label: string;
@@ -1528,6 +1538,22 @@ export interface GetCentricosDiscountsQuery {
 
 export type GetCentricosDiscountsResponse = GetDiscountsResponseDTO;
 
+// GET /centricos/discounts/sites - Get sites (id and name only) for the discount site picker
+
+export interface GetCentricosDiscountsSitesQuery {
+	id_multigroups?: string[];
+	filter?: string;
+	limit: number;
+	page: number;
+	sortOrder: string;
+	sortBy?: string;
+	sector_name?: string;
+	// Site statuses. Use repeated query params. Allowed values: active, inactive, archived.
+	status?: string[];
+}
+
+export type GetCentricosDiscountsSitesResponse = GetDiscountSitesResponseDTO;
+
 // GET /centricos/recommendations/{siteId} - Get recommendations by site
 
 export interface GetRecommendationsBySitePath {

package/src/interface/delivery.ts

@@ -0,0 +1,53 @@
+/* eslint-disable */
+// THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
+
+import { RequestQuery, BaseRequest } from './util';
+
+export interface HealthMetadataDto {
+	// Service name
+	service: string;
+	// AWS region
+	region?: string;
+}
+
+export interface HealthResponseDto {
+	// Health status
+	status: string;
+	// ISO timestamp of the health check
+	timestamp: string;
+	// Deployed git SHA or service version
+	version: string;
+	metadata: HealthMetadataDto;
+}
+
+export interface ErrorDisplayMessage {
+	// user message title
+	title: string;
+	// user message description
+	description: string;
+}
+
+export interface ErrorData {
+	// http status code
+	statusCode: number;
+	// http status text
+	statusText: string;
+	timestamp: string;
+	// user friendly error message
+	displayMessage: ErrorDisplayMessage;
+}
+
+export interface Error {
+	// business error code
+	code: number;
+	// business error description
+	message: string;
+	// additional error data
+	data: ErrorData;
+}
+
+// GET /delivery/health - Delivery service readiness check
+
+export type GetDeliveryHealthResponse = HealthResponseDto;
+
+export interface GetDeliveryHealthRequest extends BaseRequest {}

package/src/interface/menu.ts

@@ -770,6 +770,7 @@ export interface DraftMenuDTO {
 	deleted_at?: string;
 	parent_id?: string;
 	name?: string;
+	sequence?: number;
 	brand_id?: string;
 	translation?: NameTranslation;
 	applied_diff_snapshot?: Record<string, any>;
@@ -1429,6 +1430,7 @@ export interface PublishedMenuDTO {
 	deleted_at?: string;
 	parent_id?: string;
 	name?: string;
+	sequence?: number;
 	brand_id?: string;
 	translation?: NameTranslation;
 	version?: number;
@@ -2075,6 +2077,12 @@ export interface BrandStatusEntityDTO {
 	[index: string]: any;
 }
 
+export interface ReorderMenuItemDTO {
+	id: string;
+	sequence: number;
+	[index: string]: any;
+}
+
 export interface DraftModifierGroupEntityDTO {
 	parent?: DraftModifierGroupDTO;
 	children?: DraftModifierGroupDTO[];
@@ -4860,6 +4868,7 @@ export interface PostMenuV3DraftMenuBody {
 	price_level_id?: string;
 	parent_id?: string;
 	name: string;
+	sequence?: number;
 	brand_id: string;
 	translation?: NameTranslation;
 	applied_diff_snapshot?: Record<string, any>;
@@ -4914,6 +4923,7 @@ export interface PatchMenuV3DraftMenuBody {
 	id?: string;
 	parent_id?: string;
 	name?: string;
+	sequence?: number;
 	brand_id?: string;
 	translation?: NameTranslation;
 	applied_diff_snapshot?: Record<string, any>;
@@ -4990,6 +5000,7 @@ export type PostMenuV3DraftMenusBody = {
 	price_level_id?: string;
 	parent_id?: string;
 	name: string;
+	sequence?: number;
 	brand_id: string;
 	translation?: NameTranslation;
 	applied_diff_snapshot?: Record<string, any>;
@@ -5127,6 +5138,7 @@ export interface PostMenuV3DraftMenuDuplicateResponse {
 	deleted_at?: string;
 	parent_id?: string;
 	name: string;
+	sequence?: number;
 	brand_id: string;
 	translation?: NameTranslation;
 	applied_diff_snapshot?: Record<string, any>;
@@ -8512,6 +8524,7 @@ export interface PostMenuV4BrandMenuResponse {
 	deleted_at?: string;
 	parent_id?: string;
 	name: string;
+	sequence?: number;
 	brand_id: string;
 	translation?: NameTranslation;
 	applied_diff_snapshot?: Record<string, any>;
@@ -8572,6 +8585,7 @@ export interface PatchMenuV4BrandMenuResponse {
 	deleted_at?: string;
 	parent_id?: string;
 	name: string;
+	sequence?: number;
 	brand_id: string;
 	translation?: NameTranslation;
 	applied_diff_snapshot?: Record<string, any>;
@@ -8609,6 +8623,7 @@ export interface DeleteMenuV4BrandMenuResponse {
 	deleted_at?: string;
 	parent_id?: string;
 	name: string;
+	sequence?: number;
 	brand_id: string;
 	translation?: NameTranslation;
 	applied_diff_snapshot?: Record<string, any>;
@@ -8624,6 +8639,28 @@ export interface DeleteMenuV4BrandMenuResponse {
 
 export interface DeleteMenuV4BrandMenuRequest extends BaseRequest, DeleteMenuV4BrandMenuPath {}
 
+// PATCH /menu/v4/brand/{brand_id}/menus/reorder
+
+export interface PatchMenuV4BrandMenusReorderPath {
+	brand_id: string;
+}
+
+export interface PatchMenuV4BrandMenusReorderBody {
+	menus: ReorderMenuItemDTO[];
+	[index: string]: any;
+}
+
+export interface PatchMenuV4BrandMenusReorderResponse {
+	status: string;
+	[index: string]: any;
+}
+
+export interface PatchMenuV4BrandMenusReorderRequest
+	extends BaseRequest,
+		PatchMenuV4BrandMenusReorderPath {
+	body: PatchMenuV4BrandMenusReorderBody;
+}
+
 // GET /menu/v4/brand/{id}/items
 
 export interface GetMenuV4BrandItemsPath {
@@ -9268,6 +9305,7 @@ export interface PostMenuV4BrandMenuDuplicateResponse {
 	deleted_at?: string;
 	parent_id?: string;
 	name: string;
+	sequence?: number;
 	brand_id: string;
 	translation?: NameTranslation;
 	applied_diff_snapshot?: Record<string, any>;
@@ -11175,6 +11213,7 @@ export interface PostMenuV4ScheduleMenuResponse {
 	deleted_at?: string;
 	parent_id?: string;
 	name: string;
+	sequence?: number;
 	brand_id: string;
 	translation?: NameTranslation;
 	applied_diff_snapshot?: Record<string, any>;
@@ -11213,6 +11252,7 @@ export interface PostMenuV4UnscheduleMenuResponse {
 	deleted_at?: string;
 	parent_id?: string;
 	name: string;
+	sequence?: number;
 	brand_id: string;
 	translation?: NameTranslation;
 	applied_diff_snapshot?: Record<string, any>;
@@ -11253,6 +11293,7 @@ export interface GetMenuV4MenuResponse {
 	deleted_at?: string;
 	parent_id?: string;
 	name: string;
+	sequence?: number;
 	brand_id?: string;
 	translation?: NameTranslation;
 	applied_diff_snapshot?: Record<string, any>;