@compassdigital/sdk.typescript 4.279.0 → 4.281.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.279.0",
3
+ "version": "4.281.0",
4
4
  "description": "Compass Digital Labs TypeScript SDK",
5
5
  "type": "commonjs",
6
6
  "main": "./lib/index.js",
package/src/index.ts CHANGED
@@ -654,6 +654,7 @@ import {
654
654
  PostMenuV3DraftBrandImportResponse,
655
655
  GetMenuV3DraftBrandVerifyPublishQuery,
656
656
  GetMenuV3DraftBrandVerifyPublishResponse,
657
+ PostMenuV3DraftBrandArchiveResponse,
657
658
  PostMenuV3BrandQuery,
658
659
  PostMenuV3BrandBody,
659
660
  PostMenuV3BrandResponse,
@@ -7231,6 +7232,26 @@ export class ServiceClient extends BaseServiceClient {
7231
7232
  );
7232
7233
  }
7233
7234
 
7235
+ /**
7236
+ * POST /menu/v3/draft/brand/{id}/archive
7237
+ *
7238
+ * @param id
7239
+ * @param options - additional request options
7240
+ */
7241
+ post_menu_v3_draft_brand_archive(
7242
+ id: string,
7243
+ options?: RequestOptions,
7244
+ ): ResponsePromise<PostMenuV3DraftBrandArchiveResponse> {
7245
+ return this.request(
7246
+ 'menu',
7247
+ '/menu/v3/draft/brand/{id}/archive',
7248
+ 'POST',
7249
+ `/menu/v3/draft/brand/${id}/archive`,
7250
+ null,
7251
+ options,
7252
+ );
7253
+ }
7254
+
7234
7255
  /**
7235
7256
  * POST /menu/v3/brand
7236
7257
  *
@@ -449,9 +449,18 @@ export interface GetDiscountsResponseDTO {
449
449
  meta: MetaResultsDTO;
450
450
  }
451
451
 
452
- export interface Recommendation {
453
- // Unique identifier for the site complex
454
- complex_key: number;
452
+ export interface Transcript {
453
+ // Header text for the recommendation
454
+ header: string;
455
+ // Description text for the recommendation
456
+ description: string;
457
+ // CTA text for the recommendation
458
+ action: string;
459
+ // Link to relevant CentricOS page
460
+ actionUrl: string;
461
+ }
462
+
463
+ export interface GetRecommendationsResponseDto {
455
464
  // UUID for the recommendation instance
456
465
  recommendation_id: string;
457
466
  // Start date of the recommendation timeframe
@@ -460,10 +469,10 @@ export interface Recommendation {
460
469
  end_date: string;
461
470
  // Type of recommendation
462
471
  rec_type: string;
463
- // HTML summary of the recommendation for display
464
- transcript_html: string;
465
- // HTML version for expanded view with more details
466
- expand_html: string;
472
+ // Original raw HTML content of the recommendation
473
+ centric_html: string;
474
+ // Object containing the header, description, action, and actionUrl of the recommendation
475
+ parsed_transcript: Transcript;
467
476
  // Link to relevant CentricOS page for action
468
477
  url: string;
469
478
  // Human-readable timeframe of the recommendation
@@ -472,11 +481,6 @@ export interface Recommendation {
472
481
  visual: string;
473
482
  }
474
483
 
475
- export interface GetRecommendationsResponseDto {
476
- // Array of recommendations for the site
477
- recommendations: Recommendation[];
478
- }
479
-
480
484
  // POST /centricos/ai/item/description - Generate item description
481
485
 
482
486
  export type PostCentricosAiItemDescriptionBody = AIItemDescriptionRequest;
@@ -779,4 +783,4 @@ export interface GetRecommendationsBySiteQuery {
779
783
  _query?: string;
780
784
  }
781
785
 
782
- export type GetRecommendationsBySiteResponse = GetRecommendationsResponseDto;
786
+ export type GetRecommendationsBySiteResponse = GetRecommendationsResponseDto[];
@@ -4028,6 +4028,21 @@ export interface GetMenuV3DraftBrandVerifyPublishRequest
4028
4028
  RequestQuery<GetMenuV3DraftBrandVerifyPublishQuery>,
4029
4029
  GetMenuV3DraftBrandVerifyPublishPath {}
4030
4030
 
4031
+ // POST /menu/v3/draft/brand/{id}/archive
4032
+
4033
+ export interface PostMenuV3DraftBrandArchivePath {
4034
+ id: string;
4035
+ }
4036
+
4037
+ export interface PostMenuV3DraftBrandArchiveResponse {
4038
+ brand: Record<string, any>;
4039
+ [index: string]: any;
4040
+ }
4041
+
4042
+ export interface PostMenuV3DraftBrandArchiveRequest
4043
+ extends BaseRequest,
4044
+ PostMenuV3DraftBrandArchivePath {}
4045
+
4031
4046
  // POST /menu/v3/brand
4032
4047
 
4033
4048
  export interface PostMenuV3BrandQuery {