@compassdigital/sdk.typescript 4.268.0 → 4.270.0

package/lib/messages/events/ReviewCreatedEvent.d.ts

@@ -9,7 +9,6 @@ export interface ReviewCreatedEvent {
     payload: {
         review: {
             id: string;
-            userId: string;
             createdAt: string;
             updatedAt: string;
             score?: number;

package/lib/messages/events/ReviewCreatedEvent.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ReviewCreatedEvent.d.ts","sourceRoot":"","sources":["../../../src/messages/events/ReviewCreatedEvent.ts"],"names":[],"mappings":"AAEA,MAAM,WAAW,kBAAkB;IAClC,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,oBAAoB,CAAC;IAC3B,OAAO,EAAE,OAAO,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,YAAY,EAAE;QACb,OAAO,CAAC,EAAE,MAAM,CAAC;KACjB,CAAC;IACF,OAAO,EAAE;QACR,MAAM,EAAE;YAEP,EAAE,EAAE,MAAM,CAAC;YAEX,MAAM,EAAE,MAAM,CAAC;YAEf,SAAS,EAAE,MAAM,CAAC;YAElB,SAAS,EAAE,MAAM,CAAC;YAElB,KAAK,CAAC,EAAE,MAAM,CAAC;YAEf,OAAO,CAAC,EAAE,MAAM,CAAC;YAEjB,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;YAElB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;SAClC,CAAC;KACF,CAAC;IACF,MAAM,EAAE,MAAM,CAAC;CACf"}
+{"version":3,"file":"ReviewCreatedEvent.d.ts","sourceRoot":"","sources":["../../../src/messages/events/ReviewCreatedEvent.ts"],"names":[],"mappings":"AAEA,MAAM,WAAW,kBAAkB;IAClC,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,oBAAoB,CAAC;IAC3B,OAAO,EAAE,OAAO,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,YAAY,EAAE;QACb,OAAO,CAAC,EAAE,MAAM,CAAC;KACjB,CAAC;IACF,OAAO,EAAE;QACR,MAAM,EAAE;YAEP,EAAE,EAAE,MAAM,CAAC;YAEX,SAAS,EAAE,MAAM,CAAC;YAElB,SAAS,EAAE,MAAM,CAAC;YAElB,KAAK,CAAC,EAAE,MAAM,CAAC;YAEf,OAAO,CAAC,EAAE,MAAM,CAAC;YAEjB,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;YAElB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;SAClC,CAAC;KACF,CAAC;IACF,MAAM,EAAE,MAAM,CAAC;CACf"}

package/package.json

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

package/src/index.ts

@@ -535,6 +535,10 @@ import {
 	PostMenuPartialGroupItemOptionsQuery,
 	PostMenuPartialGroupItemOptionsBody,
 	PostMenuPartialGroupItemOptionsResponse,
+	PingQuery,
+	PingResponse$0,
+	HealthQuery,
+	HealthResponse$0,
 	PostMenuV3LocalMenuGroupBody,
 	PostMenuV3LocalMenuGroupResponse,
 	GetMenuV3LocalMenuGroupQuery,
@@ -1036,8 +1040,10 @@ import {
 	DeleteMenuV4CategoryDetachItemsResponse,
 	GetMenuV4CategoryAttachableItemsQuery,
 	GetMenuV4CategoryAttachableItemsResponse,
-	GetMenuPingQuery,
-	GetMenuPingResponse,
+	GetMenuV3PingQuery,
+	GetMenuV3PingResponse,
+	GetMenuV3HealthQuery,
+	GetMenuV3HealthResponse,
 } from './interface/menu';
 
 import {
@@ -5945,6 +5951,32 @@ export class ServiceClient extends BaseServiceClient {
 		);
 	}
 
+	/**
+	 * GET /menu/ping - Service ping endpoint for basic connectivity check
+	 *
+	 * @param options - additional request options
+	 */
+	ping(
+		options?: {
+			query?: PingQuery;
+		} & RequestOptions,
+	): ResponsePromise<PingResponse$0> {
+		return this.request('menu', '/menu/ping', 'GET', `/menu/ping`, null, options);
+	}
+
+	/**
+	 * GET /menu/health - Service health check endpoint
+	 *
+	 * @param options - additional request options
+	 */
+	health(
+		options?: {
+			query?: HealthQuery;
+		} & RequestOptions,
+	): ResponsePromise<HealthResponse$0> {
+		return this.request('menu', '/menu/health', 'GET', `/menu/health`, null, options);
+	}
+
 	/**
 	 * POST /menu/v3/local-menu-group
 	 *
@@ -11350,16 +11382,29 @@ export class ServiceClient extends BaseServiceClient {
 	}
 
 	/**
-	 * GET /menu/ping
+	 * GET /menu/v3/ping
 	 *
 	 * @param options - additional request options
 	 */
-	get_menu_ping(
+	get_menu_v3_ping(
 		options?: {
-			query?: GetMenuPingQuery;
+			query?: GetMenuV3PingQuery;
 		} & RequestOptions,
-	): ResponsePromise<GetMenuPingResponse> {
-		return this.request('menu', '/menu/ping', 'GET', `/menu/ping`, null, options);
+	): ResponsePromise<GetMenuV3PingResponse> {
+		return this.request('menu', '/menu/v3/ping', 'GET', `/menu/v3/ping`, null, options);
+	}
+
+	/**
+	 * GET /menu/v3/health
+	 *
+	 * @param options - additional request options
+	 */
+	get_menu_v3_health(
+		options?: {
+			query?: GetMenuV3HealthQuery;
+		} & RequestOptions,
+	): ResponsePromise<GetMenuV3HealthResponse> {
+		return this.request('menu', '/menu/v3/health', 'GET', `/menu/v3/health`, null, options);
 	}
 
 	/**

package/src/interface/menu.ts

@@ -425,6 +425,45 @@ export interface ZippedExcelExport {
 	format?: string;
 }
 
+export interface PingResponse {
+	// Status of the service
+	status: string;
+	// Response message
+	message: string;
+	// ISO timestamp of the response
+	timestamp: string;
+	// Service identifier
+	service: string;
+}
+
+export interface HealthResponse {
+	// Overall health status of the service
+	status: 'healthy' | 'unhealthy' | 'degraded';
+	// ISO timestamp of the health check
+	timestamp: string;
+	// Service version
+	version: string;
+	// Status of service dependencies
+	dependencies: HealthDependency[];
+	metadata: {
+		// AWS region
+		region: string;
+		// Service identifier
+		service: string;
+	};
+}
+
+export interface HealthDependency {
+	// Name of the dependency
+	name: string;
+	// Health status of the dependency
+	status: 'healthy' | 'unhealthy' | 'degraded';
+	// Response time in milliseconds
+	responseTimeMs: number;
+	// Additional details about the dependency status
+	details: string | null;
+}
+
 export interface GlobalMenuGroupDTO {
 	name?: string;
 	is_active?: boolean;
@@ -1860,6 +1899,20 @@ export interface CategoryItemRelationshipDTO {
 	[index: string]: any;
 }
 
+export interface HealthDependencyDTO {
+	name: string;
+	status: string;
+	responseTimeMs?: number;
+	details?: string;
+	[index: string]: any;
+}
+
+export interface HealthMetadataDTO {
+	region: string;
+	service: string;
+	[index: string]: any;
+}
+
 // GET /menu - Get Menus or search for Menus
 
 export interface GetMenusQuery {
@@ -2269,6 +2322,28 @@ export interface PostMenuPartialGroupItemOptionsRequest
 	body: PostMenuPartialGroupItemOptionsBody;
 }
 
+// GET /menu/ping - Service ping endpoint for basic connectivity check
+
+export interface PingQuery {
+	// Graphql query string
+	_query?: string;
+}
+
+export type PingResponse$0 = PingResponse;
+
+export interface PingRequest extends BaseRequest, RequestQuery<PingQuery> {}
+
+// GET /menu/health - Service health check endpoint
+
+export interface HealthQuery {
+	// Graphql query string
+	_query?: string;
+}
+
+export type HealthResponse$0 = HealthResponse;
+
+export interface HealthRequest extends BaseRequest, RequestQuery<HealthQuery> {}
+
 // POST /menu/v3/local-menu-group
 
 export interface PostMenuV3LocalMenuGroupBody {
@@ -10503,14 +10578,14 @@ export interface GetMenuV4CategoryAttachableItemsRequest
 		RequestQuery<GetMenuV4CategoryAttachableItemsQuery>,
 		GetMenuV4CategoryAttachableItemsPath {}
 
-// GET /menu/ping
+// GET /menu/v3/ping
 
-export interface GetMenuPingQuery {
+export interface GetMenuV3PingQuery {
 	// Graphql query string
 	_query?: string;
 }
 
-export interface GetMenuPingResponse {
+export interface GetMenuV3PingResponse {
 	status: string;
 	message: string;
 	timestamp: string;
@@ -10518,4 +10593,22 @@ export interface GetMenuPingResponse {
 	[index: string]: any;
 }
 
-export interface GetMenuPingRequest extends BaseRequest, RequestQuery<GetMenuPingQuery> {}
+export interface GetMenuV3PingRequest extends BaseRequest, RequestQuery<GetMenuV3PingQuery> {}
+
+// GET /menu/v3/health
+
+export interface GetMenuV3HealthQuery {
+	// Graphql query string
+	_query?: string;
+}
+
+export interface GetMenuV3HealthResponse {
+	status: string;
+	timestamp: string;
+	version: string;
+	dependencies: HealthDependencyDTO[];
+	metadata: HealthMetadataDTO;
+	[index: string]: any;
+}
+
+export interface GetMenuV3HealthRequest extends BaseRequest, RequestQuery<GetMenuV3HealthQuery> {}

package/src/messages/events/ReviewCreatedEvent.ts

@@ -12,8 +12,6 @@ export interface ReviewCreatedEvent {
 		review: {
 			// review id
 			id: string;
-			// user who created the review
-			userId: string;
 			// when the review was created
 			createdAt: string;
 			// when the review was last updated