@compassdigital/sdk.typescript 4.552.0 → 4.554.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.
@@ -31,6 +31,23 @@ export interface GetReviewPingResponseDTO {
31
31
  timestamp?: string;
32
32
  service?: string;
33
33
  }
34
+ export interface DependencyHealthDTO {
35
+ name: string;
36
+ status: 'healthy' | 'unhealthy';
37
+ responseTimeMs: number | null;
38
+ details: string | null;
39
+ }
40
+ export interface HealthMetadataDTO {
41
+ region?: string;
42
+ service?: string;
43
+ }
44
+ export interface HealthResponseDTO {
45
+ status: 'healthy' | 'unhealthy';
46
+ timestamp: string;
47
+ version: string;
48
+ dependencies: DependencyHealthDTO[];
49
+ metadata: HealthMetadataDTO;
50
+ }
34
51
  export interface GetReviewResponseDTO {
35
52
  taxonomy?: Record<string, string>;
36
53
  id: string;
@@ -71,6 +88,7 @@ export type GetReviewsResponse = GetReviewsResponseDTO;
71
88
  export type PostReviewBody = PostReviewRequestDTO;
72
89
  export type PostReviewResponse = PostReviewResponseDTO;
73
90
  export type GetReviewPingResponse = GetReviewPingResponseDTO;
91
+ export type GetReviewHealthResponse = HealthResponseDTO;
74
92
  export interface GetReviewPath {
75
93
  id: string;
76
94
  }
@@ -1 +1 @@
1
- {"version":3,"file":"review.d.ts","sourceRoot":"","sources":["../../src/interface/review.ts"],"names":[],"mappings":"AAKA,MAAM,WAAW,SAAS;IACzB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAClC,EAAE,EAAE,MAAM,CAAC;IACX,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;CAClB;AAED,MAAM,WAAW,qBAAqB;IACrC,OAAO,EAAE,SAAS,EAAE,CAAC;CACrB;AAED,MAAM,WAAW,mBAAmB;IAEnC,KAAK,EAAE,MAAM,CAAC;IAEd,WAAW,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,SAAS;IAEzB,UAAU,EAAE,MAAM,CAAC;IAEnB,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;IAElB,cAAc,EAAE,mBAAmB,CAAC;CACpC;AAED,MAAM,WAAW,KAAK;IAErB,IAAI,EAAE,MAAM,CAAC;IAEb,OAAO,EAAE,MAAM,CAAC;IAEhB,IAAI,EAAE,SAAS,CAAC;CAChB;AAED,MAAM,WAAW,wBAAwB;IACxC,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,oBAAoB;IACpC,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAClC,EAAE,EAAE,MAAM,CAAC;IACX,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;CAClB;AAED,MAAM,WAAW,oBAAoB;IACpC,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAClC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;CAClB;AAED,MAAM,WAAW,qBAAqB;IACrC,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAClC,EAAE,EAAE,MAAM,CAAC;IACX,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;CAClB;AAED,MAAM,WAAW,uBAAuB;IACvC,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAClC,EAAE,EAAE,MAAM,CAAC;IACX,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;CAClB;AAID,MAAM,WAAW,eAAe;IAC/B,cAAc,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,MAAM,kBAAkB,GAAG,qBAAqB,CAAC;AAIvD,MAAM,MAAM,cAAc,GAAG,oBAAoB,CAAC;AAElD,MAAM,MAAM,kBAAkB,GAAG,qBAAqB,CAAC;AAIvD,MAAM,MAAM,qBAAqB,GAAG,wBAAwB,CAAC;AAI7D,MAAM,WAAW,aAAa;IAC7B,EAAE,EAAE,MAAM,CAAC;CACX;AAED,MAAM,MAAM,iBAAiB,GAAG,oBAAoB,CAAC;AAIrD,MAAM,WAAW,gBAAgB;IAEhC,EAAE,EAAE,MAAM,CAAC;CACX;AAED,MAAM,MAAM,oBAAoB,GAAG,uBAAuB,CAAC"}
1
+ {"version":3,"file":"review.d.ts","sourceRoot":"","sources":["../../src/interface/review.ts"],"names":[],"mappings":"AAKA,MAAM,WAAW,SAAS;IACzB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAClC,EAAE,EAAE,MAAM,CAAC;IACX,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;CAClB;AAED,MAAM,WAAW,qBAAqB;IACrC,OAAO,EAAE,SAAS,EAAE,CAAC;CACrB;AAED,MAAM,WAAW,mBAAmB;IAEnC,KAAK,EAAE,MAAM,CAAC;IAEd,WAAW,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,SAAS;IAEzB,UAAU,EAAE,MAAM,CAAC;IAEnB,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;IAElB,cAAc,EAAE,mBAAmB,CAAC;CACpC;AAED,MAAM,WAAW,KAAK;IAErB,IAAI,EAAE,MAAM,CAAC;IAEb,OAAO,EAAE,MAAM,CAAC;IAEhB,IAAI,EAAE,SAAS,CAAC;CAChB;AAED,MAAM,WAAW,wBAAwB;IACxC,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,mBAAmB;IACnC,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,SAAS,GAAG,WAAW,CAAC;IAChC,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB;AAED,MAAM,WAAW,iBAAiB;IACjC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,iBAAiB;IACjC,MAAM,EAAE,SAAS,GAAG,WAAW,CAAC;IAChC,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;IAChB,YAAY,EAAE,mBAAmB,EAAE,CAAC;IACpC,QAAQ,EAAE,iBAAiB,CAAC;CAC5B;AAED,MAAM,WAAW,oBAAoB;IACpC,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAClC,EAAE,EAAE,MAAM,CAAC;IACX,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;CAClB;AAED,MAAM,WAAW,oBAAoB;IACpC,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAClC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;CAClB;AAED,MAAM,WAAW,qBAAqB;IACrC,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAClC,EAAE,EAAE,MAAM,CAAC;IACX,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;CAClB;AAED,MAAM,WAAW,uBAAuB;IACvC,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAClC,EAAE,EAAE,MAAM,CAAC;IACX,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;CAClB;AAID,MAAM,WAAW,eAAe;IAC/B,cAAc,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,MAAM,kBAAkB,GAAG,qBAAqB,CAAC;AAIvD,MAAM,MAAM,cAAc,GAAG,oBAAoB,CAAC;AAElD,MAAM,MAAM,kBAAkB,GAAG,qBAAqB,CAAC;AAIvD,MAAM,MAAM,qBAAqB,GAAG,wBAAwB,CAAC;AAI7D,MAAM,MAAM,uBAAuB,GAAG,iBAAiB,CAAC;AAIxD,MAAM,WAAW,aAAa;IAC7B,EAAE,EAAE,MAAM,CAAC;CACX;AAED,MAAM,MAAM,iBAAiB,GAAG,oBAAoB,CAAC;AAIrD,MAAM,WAAW,gBAAgB;IAEhC,EAAE,EAAE,MAAM,CAAC;CACX;AAED,MAAM,MAAM,oBAAoB,GAAG,uBAAuB,CAAC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@compassdigital/sdk.typescript",
3
- "version": "4.552.0",
3
+ "version": "4.554.0",
4
4
  "description": "Compass Digital Labs TypeScript SDK",
5
5
  "type": "commonjs",
6
6
  "main": "./lib/index.js",
package/src/index.ts CHANGED
@@ -542,6 +542,8 @@ import {
542
542
  GetMenuV3LocalMenuGroupsCountQuery,
543
543
  GetMenuV3LocalMenuGroupsCountResponse,
544
544
  PostMenuV3LocalMenuGroupRecoverResponse,
545
+ PostMenuV3LocalMenuGroupFetchBySitesBody,
546
+ PostMenuV3LocalMenuGroupFetchBySitesResponse,
545
547
  GetMenuV3DraftLocalMenuGroupBrandsQuery,
546
548
  GetMenuV3DraftLocalMenuGroupBrandsResponse,
547
549
  GetMenuV3DraftLocalMenuGroupItemsQuery,
@@ -1390,6 +1392,7 @@ import {
1390
1392
  PostReviewBody,
1391
1393
  PostReviewResponse,
1392
1394
  GetReviewPingResponse,
1395
+ GetReviewHealthResponse,
1393
1396
  GetReviewResponse,
1394
1397
  DeleteReviewResponse,
1395
1398
  } from './interface/review';
@@ -6485,6 +6488,26 @@ export class ServiceClient extends BaseServiceClient {
6485
6488
  );
6486
6489
  }
6487
6490
 
6491
+ /**
6492
+ * POST /menu/v3/local-menu-group/fetch-by-sites
6493
+ *
6494
+ * @param body
6495
+ * @param options - additional request options
6496
+ */
6497
+ post_menu_v3_local_menu_group_fetch_by_sites(
6498
+ body: PostMenuV3LocalMenuGroupFetchBySitesBody,
6499
+ options?: RequestOptions,
6500
+ ): ResponsePromise<PostMenuV3LocalMenuGroupFetchBySitesResponse> {
6501
+ return this.request(
6502
+ 'menu',
6503
+ '/menu/v3/local-menu-group/fetch-by-sites',
6504
+ 'POST',
6505
+ `/menu/v3/local-menu-group/fetch-by-sites`,
6506
+ body,
6507
+ options,
6508
+ );
6509
+ }
6510
+
6488
6511
  /**
6489
6512
  * GET /menu/v3/draft/local-menu-group/{id}/brands
6490
6513
  *
@@ -15732,6 +15755,15 @@ export class ServiceClient extends BaseServiceClient {
15732
15755
  return this.request('review', '/review/ping', 'GET', `/review/ping`, null, options);
15733
15756
  }
15734
15757
 
15758
+ /**
15759
+ * GET /review/health - Review service readiness check
15760
+ *
15761
+ * @param options - additional request options
15762
+ */
15763
+ get_review_health(options?: RequestOptions): ResponsePromise<GetReviewHealthResponse> {
15764
+ return this.request('review', '/review/health', 'GET', `/review/health`, null, options);
15765
+ }
15766
+
15735
15767
  /**
15736
15768
  * GET /review/{id} - Get a review
15737
15769
  *
@@ -730,6 +730,15 @@ export interface LocalMenuGroupDTO {
730
730
  [index: string]: any;
731
731
  }
732
732
 
733
+ export interface SiteGroupWithMenuGroupNameResponseDTO {
734
+ site_id: string;
735
+ local_menu_group_id: string;
736
+ local_menu_group_name: string;
737
+ created_at?: string;
738
+ updated_at?: string;
739
+ [index: string]: any;
740
+ }
741
+
733
742
  export interface BrandChangeDTO {
734
743
  id?: string;
735
744
  created_at?: string;
@@ -1279,15 +1288,6 @@ export interface AuditDTO {
1279
1288
  [index: string]: any;
1280
1289
  }
1281
1290
 
1282
- export interface SiteGroupWithMenuGroupNameResponseDTO {
1283
- site_id: string;
1284
- local_menu_group_id: string;
1285
- local_menu_group_name: string;
1286
- created_at?: string;
1287
- updated_at?: string;
1288
- [index: string]: any;
1289
- }
1290
-
1291
1291
  export interface SiteGroupDTO {
1292
1292
  site_id: string;
1293
1293
  local_menu_group_id: string;
@@ -2995,6 +2995,21 @@ export interface PostMenuV3LocalMenuGroupRecoverRequest
2995
2995
  extends BaseRequest,
2996
2996
  PostMenuV3LocalMenuGroupRecoverPath {}
2997
2997
 
2998
+ // POST /menu/v3/local-menu-group/fetch-by-sites
2999
+
3000
+ export interface PostMenuV3LocalMenuGroupFetchBySitesBody {
3001
+ site_ids: string[];
3002
+ [index: string]: any;
3003
+ }
3004
+
3005
+ export interface PostMenuV3LocalMenuGroupFetchBySitesResponse {
3006
+ results?: SiteGroupWithMenuGroupNameResponseDTO[];
3007
+ }
3008
+
3009
+ export interface PostMenuV3LocalMenuGroupFetchBySitesRequest extends BaseRequest {
3010
+ body: PostMenuV3LocalMenuGroupFetchBySitesBody;
3011
+ }
3012
+
2998
3013
  // GET /menu/v3/draft/local-menu-group/{id}/brands
2999
3014
 
3000
3015
  export interface GetMenuV3DraftLocalMenuGroupBrandsPath {
@@ -50,6 +50,26 @@ export interface GetReviewPingResponseDTO {
50
50
  service?: string;
51
51
  }
52
52
 
53
+ export interface DependencyHealthDTO {
54
+ name: string;
55
+ status: 'healthy' | 'unhealthy';
56
+ responseTimeMs: number | null;
57
+ details: string | null;
58
+ }
59
+
60
+ export interface HealthMetadataDTO {
61
+ region?: string;
62
+ service?: string;
63
+ }
64
+
65
+ export interface HealthResponseDTO {
66
+ status: 'healthy' | 'unhealthy';
67
+ timestamp: string;
68
+ version: string;
69
+ dependencies: DependencyHealthDTO[];
70
+ metadata: HealthMetadataDTO;
71
+ }
72
+
53
73
  export interface GetReviewResponseDTO {
54
74
  taxonomy?: Record<string, string>;
55
75
  id: string;
@@ -105,6 +125,10 @@ export type PostReviewResponse = PostReviewResponseDTO;
105
125
 
106
126
  export type GetReviewPingResponse = GetReviewPingResponseDTO;
107
127
 
128
+ // GET /review/health - Review service readiness check
129
+
130
+ export type GetReviewHealthResponse = HealthResponseDTO;
131
+
108
132
  // GET /review/{id} - Get a review
109
133
 
110
134
  export interface GetReviewPath {