@compassdigital/sdk.typescript 4.562.0 → 4.563.0

package/lib/interface/email.d.ts

@@ -1,4 +1,27 @@
 import { BaseRequest } from './util';
+export interface PingResponse {
+    status?: string;
+    message?: string;
+    timestamp?: string;
+    service?: string;
+}
+export interface HealthResponse {
+    status: 'healthy' | 'unhealthy' | 'degraded';
+    timestamp: string;
+    version: string;
+    dependencies: HealthDependency[];
+    metadata: HealthMetadata;
+}
+export interface HealthDependency {
+    name: string;
+    status: 'healthy' | 'unhealthy' | 'degraded';
+    responseTimeMs: number;
+    details: string | null;
+}
+export interface HealthMetadata {
+    region?: string;
+    service?: string;
+}
 export interface Error {
     message?: string;
     code?: number;
@@ -20,4 +43,10 @@ export type PostEmailResponse = Success;
 export interface PostEmailRequest extends BaseRequest {
     body: PostEmailBody;
 }
+export type GetEmailPingResponse = PingResponse;
+export interface GetEmailPingRequest extends BaseRequest {
+}
+export type GetEmailHealthResponse = HealthResponse;
+export interface GetEmailHealthRequest extends BaseRequest {
+}
 //# sourceMappingURL=email.d.ts.map

package/lib/interface/email.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"email.d.ts","sourceRoot":"","sources":["../../src/interface/email.ts"],"names":[],"mappings":"AAGA,OAAO,EAAgB,WAAW,EAAE,MAAM,QAAQ,CAAC;AAEnD,MAAM,WAAW,KAAK;IACrB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAC3B;AAED,MAAM,WAAW,OAAO;IACvB,OAAO,CAAC,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,WAAW,YAAY;IAC5B,IAAI,EAAE,MAAM,CAAC;IACb,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAC3B;AAID,MAAM,MAAM,aAAa,GAAG,YAAY,CAAC;AAEzC,MAAM,MAAM,iBAAiB,GAAG,OAAO,CAAC;AAExC,MAAM,WAAW,gBAAiB,SAAQ,WAAW;IACpD,IAAI,EAAE,aAAa,CAAC;CACpB"}
+{"version":3,"file":"email.d.ts","sourceRoot":"","sources":["../../src/interface/email.ts"],"names":[],"mappings":"AAGA,OAAO,EAAgB,WAAW,EAAE,MAAM,QAAQ,CAAC;AAEnD,MAAM,WAAW,YAAY;IAC5B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,cAAc;IAE9B,MAAM,EAAE,SAAS,GAAG,WAAW,GAAG,UAAU,CAAC;IAE7C,SAAS,EAAE,MAAM,CAAC;IAElB,OAAO,EAAE,MAAM,CAAC;IAEhB,YAAY,EAAE,gBAAgB,EAAE,CAAC;IACjC,QAAQ,EAAE,cAAc,CAAC;CACzB;AAED,MAAM,WAAW,gBAAgB;IAEhC,IAAI,EAAE,MAAM,CAAC;IAEb,MAAM,EAAE,SAAS,GAAG,WAAW,GAAG,UAAU,CAAC;IAE7C,cAAc,EAAE,MAAM,CAAC;IAEvB,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB;AAED,MAAM,WAAW,cAAc;IAC9B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,KAAK;IACrB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAC3B;AAED,MAAM,WAAW,OAAO;IACvB,OAAO,CAAC,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,WAAW,YAAY;IAC5B,IAAI,EAAE,MAAM,CAAC;IACb,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAC3B;AAID,MAAM,MAAM,aAAa,GAAG,YAAY,CAAC;AAEzC,MAAM,MAAM,iBAAiB,GAAG,OAAO,CAAC;AAExC,MAAM,WAAW,gBAAiB,SAAQ,WAAW;IACpD,IAAI,EAAE,aAAa,CAAC;CACpB;AAID,MAAM,MAAM,oBAAoB,GAAG,YAAY,CAAC;AAEhD,MAAM,WAAW,mBAAoB,SAAQ,WAAW;CAAG;AAI3D,MAAM,MAAM,sBAAsB,GAAG,cAAc,CAAC;AAEpD,MAAM,WAAW,qBAAsB,SAAQ,WAAW;CAAG"}

package/package.json

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

package/src/index.ts

@@ -224,7 +224,12 @@ import {
 	GetPartnerExternalMenuItemsResponse,
 } from './interface/partner';
 
-import { PostEmailBody, PostEmailResponse } from './interface/email';
+import {
+	PostEmailBody,
+	PostEmailResponse,
+	GetEmailPingResponse,
+	GetEmailHealthResponse,
+} from './interface/email';
 
 import {
 	PostTaskBody,
@@ -3639,6 +3644,24 @@ export class ServiceClient extends BaseServiceClient {
 		return this.request('email', '/email', 'POST', `/email`, body, options);
 	}
 
+	/**
+	 * GET /email/ping - Service ping endpoint for basic connectivity check
+	 *
+	 * @param options - additional request options
+	 */
+	get_email_ping(options?: RequestOptions): ResponsePromise<GetEmailPingResponse> {
+		return this.request('email', '/email/ping', 'GET', `/email/ping`, null, options);
+	}
+
+	/**
+	 * GET /email/health - Service health endpoint for dependency checks
+	 *
+	 * @param options - additional request options
+	 */
+	get_email_health(options?: RequestOptions): ResponsePromise<GetEmailHealthResponse> {
+		return this.request('email', '/email/health', 'GET', `/email/health`, null, options);
+	}
+
 	/**
 	 * POST /task - Create new Task
 	 *

package/src/interface/email.ts

@@ -3,6 +3,41 @@
 
 import { RequestQuery, BaseRequest } from './util';
 
+export interface PingResponse {
+	status?: string;
+	message?: string;
+	timestamp?: string;
+	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: HealthMetadata;
+}
+
+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 HealthMetadata {
+	region?: string;
+	service?: string;
+}
+
 export interface Error {
 	message?: string;
 	code?: number;
@@ -32,3 +67,15 @@ export type PostEmailResponse = Success;
 export interface PostEmailRequest extends BaseRequest {
 	body: PostEmailBody;
 }
+
+// GET /email/ping - Service ping endpoint for basic connectivity check
+
+export type GetEmailPingResponse = PingResponse;
+
+export interface GetEmailPingRequest extends BaseRequest {}
+
+// GET /email/health - Service health endpoint for dependency checks
+
+export type GetEmailHealthResponse = HealthResponse;
+
+export interface GetEmailHealthRequest extends BaseRequest {}