@compassdigital/sdk.typescript 4.525.0 → 4.527.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@compassdigital/sdk.typescript",
3
- "version": "4.525.0",
3
+ "version": "4.527.0",
4
4
  "description": "Compass Digital Labs TypeScript SDK",
5
5
  "type": "commonjs",
6
6
  "main": "./lib/index.js",
package/src/index.ts CHANGED
@@ -78,6 +78,7 @@ import {
78
78
 
79
79
  import {
80
80
  GetLocationPingResponse,
81
+ GetHealthResponse,
81
82
  PostLocationBody,
82
83
  PostLocationResponse,
83
84
  GetLocationSearchQuery,
@@ -2088,6 +2089,22 @@ export class ServiceClient extends BaseServiceClient {
2088
2089
  return this.request('location', '/location/ping', 'GET', `/location/ping`, null, options);
2089
2090
  }
2090
2091
 
2092
+ /**
2093
+ * GET /location/health - Readiness check for observability and post-deployment validation
2094
+ *
2095
+ * @param options - additional request options
2096
+ */
2097
+ get_health(options?: RequestOptions): ResponsePromise<GetHealthResponse> {
2098
+ return this.request(
2099
+ 'location',
2100
+ '/location/health',
2101
+ 'GET',
2102
+ `/location/health`,
2103
+ null,
2104
+ options,
2105
+ );
2106
+ }
2107
+
2091
2108
  /**
2092
2109
  * POST /location - Create a new location
2093
2110
  *
@@ -575,12 +575,39 @@ export interface PingResponse {
575
575
  service?: string;
576
576
  }
577
577
 
578
+ export interface HealthResponse {
579
+ status: 'healthy' | 'unhealthy';
580
+ timestamp: string;
581
+ version: string;
582
+ dependencies: HealthDependency[];
583
+ metadata: HealthMetadata;
584
+ }
585
+
586
+ export interface HealthDependency {
587
+ name: string;
588
+ status: 'healthy' | 'unhealthy';
589
+ responseTimeMs: number;
590
+ // Error or status details when unhealthy, null when healthy
591
+ details?: string;
592
+ }
593
+
594
+ export interface HealthMetadata {
595
+ region: string;
596
+ service: string;
597
+ }
598
+
578
599
  // GET /location/ping - Location Service liveness check
579
600
 
580
601
  export type GetLocationPingResponse = PingResponse;
581
602
 
582
603
  export interface GetLocationPingRequest extends BaseRequest {}
583
604
 
605
+ // GET /location/health - Readiness check for observability and post-deployment validation
606
+
607
+ export type GetHealthResponse = HealthResponse;
608
+
609
+ export interface GetHealthRequest extends BaseRequest {}
610
+
584
611
  // POST /location - Create a new location
585
612
 
586
613
  export type PostLocationBody = Location;
@@ -8051,6 +8051,7 @@ export interface GetMenuV4BrandResponse {
8051
8051
  meta?: BrandMeta;
8052
8052
  supported_languages?: SupportedLanguages;
8053
8053
  archived_at?: string;
8054
+ visibility?: Record<string, any>;
8054
8055
  applied_diff_snapshot?: Record<string, any>;
8055
8056
  version?: number;
8056
8057
  changes?: BrandChangeDTO[];