@compassdigital/sdk.typescript 4.95.0 → 4.97.0

package/lib/interface/review.d.ts

@@ -0,0 +1,74 @@
+import { RequestQuery, BaseRequest } from './util';
+export interface ReviewDTO {
+    taxonomy?: Record<string, string>;
+    id: string;
+    createdAt: string;
+    updatedAt: string;
+    score?: number;
+    comment?: string;
+    reason?: string[];
+}
+export interface GetReviewsResponseDTO {
+    reviews: ReviewDTO[];
+}
+export interface BadRequestErrorDTO {
+    message: string;
+    code: number;
+    data: Record<string, any>;
+}
+export interface UnauthorizedErrorDTO {
+    message: string;
+    code: number;
+    data: Record<string, any>;
+}
+export interface GetReviewResponseDTO {
+    taxonomy?: Record<string, string>;
+    id: string;
+    createdAt: string;
+    updatedAt: string;
+    score?: number;
+    comment?: string;
+    reason?: string[];
+}
+export interface NotFoundErrorDTO {
+    message: string;
+    code: number;
+    data: Record<string, any>;
+}
+export interface PostReviewRequestDTO {
+    taxonomy?: Record<string, string>;
+    score?: number;
+    comment?: string;
+    reason?: string[];
+}
+export interface PostReviewResponseDTO {
+    taxonomy?: Record<string, string>;
+    id: string;
+    createdAt: string;
+    updatedAt: string;
+    score?: number;
+    comment?: string;
+    reason?: string[];
+}
+export interface GetReviewsQuery {
+    taxonomyFilter: string;
+    _query?: string;
+}
+export type GetReviewsResponse = GetReviewsResponseDTO;
+export interface GetReviewsRequest extends BaseRequest, RequestQuery<GetReviewsQuery> {
+}
+export type PostReviewBody = PostReviewRequestDTO;
+export type PostReviewResponse = PostReviewResponseDTO;
+export interface PostReviewRequest extends BaseRequest {
+    body: PostReviewBody;
+}
+export interface GetReviewPath {
+    id: string;
+}
+export interface GetReviewQuery {
+    _query?: string;
+}
+export type GetReviewResponse = GetReviewResponseDTO;
+export interface GetReviewRequest extends BaseRequest, RequestQuery<GetReviewQuery>, GetReviewPath {
+}
+//# sourceMappingURL=review.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"review.d.ts","sourceRoot":"","sources":["../../src/interface/review.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,QAAQ,CAAC;AAEnD,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,kBAAkB;IAClC,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAC1B;AAED,MAAM,WAAW,oBAAoB;IACpC,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAC1B;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,gBAAgB;IAChC,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAC1B;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;AAID,MAAM,WAAW,eAAe;IAC/B,cAAc,EAAE,MAAM,CAAC;IAEvB,MAAM,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,MAAM,kBAAkB,GAAG,qBAAqB,CAAC;AAEvD,MAAM,WAAW,iBAAkB,SAAQ,WAAW,EAAE,YAAY,CAAC,eAAe,CAAC;CAAG;AAIxF,MAAM,MAAM,cAAc,GAAG,oBAAoB,CAAC;AAElD,MAAM,MAAM,kBAAkB,GAAG,qBAAqB,CAAC;AAEvD,MAAM,WAAW,iBAAkB,SAAQ,WAAW;IACrD,IAAI,EAAE,cAAc,CAAC;CACrB;AAID,MAAM,WAAW,aAAa;IAC7B,EAAE,EAAE,MAAM,CAAC;CACX;AAED,MAAM,WAAW,cAAc;IAE9B,MAAM,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,MAAM,iBAAiB,GAAG,oBAAoB,CAAC;AAErD,MAAM,WAAW,gBAChB,SAAQ,WAAW,EAClB,YAAY,CAAC,cAAc,CAAC,EAC5B,aAAa;CAAG"}

package/lib/interface/review.js

@@ -0,0 +1,5 @@
+"use strict";
+/* eslint-disable */
+// THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=review.js.map

package/lib/interface/review.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"review.js","sourceRoot":"","sources":["../../src/interface/review.ts"],"names":[],"mappings":";AAAA,oBAAoB;AACpB,sDAAsD"}

package/manifest.json

@@ -111,6 +111,10 @@
 		{
 			"name": "auth",
 			"swagger": "https://dev.api.compassdigital.org/auth/swagger-json"
+		},
+		{
+			"name": "review",
+			"swagger": "../../platform2/review/swagger.json"
 		}
 	]
 }

package/package.json

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

package/src/index.ts

@@ -1026,6 +1026,8 @@ import {
 	PostAiLanguageGenerateResponse,
 	PostAiImageGenerateBody,
 	PostAiImageGenerateResponse,
+	PostAiTranslateBody,
+	PostAiTranslateResponse,
 } from './interface/ai';
 
 import {
@@ -1048,6 +1050,8 @@ import {
 	GetSiteDevicesResponse,
 	GetCentricosSitesQuery,
 	GetCentricosSitesResponse,
+	GetReviewOrderItemsQuery,
+	GetReviewOrderItemsResponse,
 } from './interface/centricos';
 
 import {
@@ -1082,6 +1086,15 @@ import {
 	GetAuthSsoExchangeResponse,
 } from './interface/auth';
 
+import {
+	GetReviewsQuery,
+	GetReviewsResponse,
+	PostReviewBody,
+	PostReviewResponse,
+	GetReviewQuery,
+	GetReviewResponse,
+} from './interface/review';
+
 import { BaseServiceClient, RequestOptions, ResponsePromise } from './base';
 export * from './base';
 
@@ -10725,6 +10738,19 @@ export class ServiceClient extends BaseServiceClient {
 		return this.request('ai', '/ai/image/generate', 'post', `/ai/image/generate`, body, options);
 	}
 
+	/**
+	 * POST /ai/translate - Translate strings
+	 *
+	 * @param body
+	 * @param options - additional request options
+	 */
+	post_ai_translate(
+		body: PostAiTranslateBody,
+		options?: RequestOptions,
+	): ResponsePromise<PostAiTranslateResponse> {
+		return this.request('ai', '/ai/translate', 'post', `/ai/translate`, body, options);
+	}
+
 	/**
 	 * POST /centricos/ai/item/description - Generate item description
 	 *
@@ -10926,6 +10952,28 @@ export class ServiceClient extends BaseServiceClient {
 		return this.request('centricos', '/centricos/sites', 'get', `/centricos/sites`, null, options);
 	}
 
+	/**
+	 * GET /centricos/review/{orderId}/order-items - Get reviews for items in a given order in an array format
+	 *
+	 * @param orderId
+	 * @param options - additional request options
+	 */
+	get_review_order_items(
+		orderId: string,
+		options?: {
+			query?: GetReviewOrderItemsQuery;
+		} & RequestOptions,
+	): ResponsePromise<GetReviewOrderItemsResponse> {
+		return this.request(
+			'centricos',
+			'/centricos/review/{orderId}/order-items',
+			'get',
+			`/centricos/review/${orderId}/order-items`,
+			null,
+			options,
+		);
+	}
+
 	/**
 	 * GET /tax/v1/health-check - Health Check
 	 *
@@ -11098,4 +11146,42 @@ export class ServiceClient extends BaseServiceClient {
 	): ResponsePromise<GetAuthSsoExchangeResponse> {
 		return this.request('auth', '/auth/sso/exchange', 'get', `/auth/sso/exchange`, null, options);
 	}
+
+	/**
+	 * GET /review - Get reviews by taxonomy
+	 *
+	 * @param options - additional request options
+	 */
+	get_reviews(
+		options: {
+			query: GetReviewsQuery;
+		} & RequestOptions,
+	): ResponsePromise<GetReviewsResponse> {
+		return this.request('review', '/review', 'get', `/review`, null, options);
+	}
+
+	/**
+	 * POST /review - Post a review
+	 *
+	 * @param body
+	 * @param options - additional request options
+	 */
+	post_review(body: PostReviewBody, options?: RequestOptions): ResponsePromise<PostReviewResponse> {
+		return this.request('review', '/review', 'post', `/review`, body, options);
+	}
+
+	/**
+	 * GET /review/{id} - Get a review
+	 *
+	 * @param id
+	 * @param options - additional request options
+	 */
+	get_review(
+		id: string,
+		options?: {
+			query?: GetReviewQuery;
+		} & RequestOptions,
+	): ResponsePromise<GetReviewResponse> {
+		return this.request('review', '/review/{id}', 'get', `/review/${id}`, null, options);
+	}
 }

package/src/interface/ai.ts

@@ -51,6 +51,20 @@ export interface GenerateImageResponse {
 	images: ImageDTO[];
 }
 
+export type TranslationStrings = Record<string, any>;
+
+export interface TranslateRequest {
+	sourceLanguage: string;
+	targetLanguage: string;
+	strings: TranslationStrings;
+}
+
+export interface TranslateResponse {
+	sourceLanguage: string;
+	targetLanguage: string;
+	translations: Record<string, string>;
+}
+
 // POST /ai/language/generate - Generate text from a given prompt
 
 export type PostAiLanguageGenerateBody = GenerateTextRequest;
@@ -70,3 +84,13 @@ export type PostAiImageGenerateResponse = GenerateImageResponse;
 export interface PostAiImageGenerateRequest extends BaseRequest {
 	body: PostAiImageGenerateBody;
 }
+
+// POST /ai/translate - Translate strings
+
+export type PostAiTranslateBody = TranslateRequest;
+
+export type PostAiTranslateResponse = TranslateResponse;
+
+export interface PostAiTranslateRequest extends BaseRequest {
+	body: PostAiTranslateBody;
+}

package/src/interface/announcement.ts

@@ -45,10 +45,8 @@ export interface AnnouncementPutRequestBody {
 	is_global?: boolean;
 	allowed_resources?: string[];
 	position: number;
-	//@deprecated
 	active?: boolean;
-	// Status of the announcement
-	status?: 'draft' | 'active' | 'disabled';
+	status?: Status;
 	// Announcement Properties
 	info?: {
 		en?: AnnouncementInfo;
@@ -69,8 +67,7 @@ export interface AnnouncementPatchRequestBody {
 	position?: number;
 	//@deprecated
 	active?: boolean;
-	// Status of the announcement
-	status?: 'draft' | 'active' | 'disabled';
+	status?: Status;
 	// Announcement Properties
 	info?: {
 		en?: AnnouncementInfo;
@@ -94,8 +91,7 @@ export interface Announcement {
 	allowed_resources: string[];
 	//@deprecated
 	active: boolean;
-	// Status of the announcement
-	status?: 'draft' | 'active' | 'disabled';
+	status?: Status;
 	schedule?: Schedule;
 	// Date created
 	created_at: string;
@@ -141,7 +137,7 @@ export interface EditHistory {
 
 export interface Schedule {
 	// If true, refer to `sites`, if false, refer to start/end times below
-	variable: boolean;
+	variable?: boolean;
 	start_datetime?: string;
 	// Maximum 1 year from today
 	end_datetime?: string;
@@ -154,7 +150,7 @@ export interface Schedule {
 	}[];
 }
 
-export type Status = 'draft' | 'active' | 'disabled';
+export type Status = 'draft' | 'published' | 'active' | 'disabled';
 
 // POST /announcement - Create Announcement
 
@@ -195,7 +191,7 @@ export interface GetAnnouncementsQuery {
 	name?: string;
 	// Filter by announcement position
 	position?: number;
-	// Filter by announcement enabled status
+	// Filter by announcement active status
 	enabled?: boolean;
 	// Filter by announcement purpose
 	purpose?: string;
@@ -205,7 +201,7 @@ export interface GetAnnouncementsQuery {
 	sort_by?: string;
 	// Sort order (ASC or DESC)
 	sort_order?: string;
-	// Filter by status - 'active', 'draft', 'disabled'
+	// Filter by status - 'published', 'draft'
 	status?: string;
 	// Graphql query string
 	_query?: string;

package/src/interface/centricos.ts

@@ -107,6 +107,11 @@ export interface GetSitesResponse {
 	results: Site[];
 }
 
+export interface ReviewOrderItemsResponseDTO {
+	// List of reviews
+	reviews: string[];
+}
+
 // POST /centricos/ai/item/description - Generate item description
 
 export type PostCentricosAiItemDescriptionBody = AIItemDescriptionRequest;
@@ -299,3 +304,21 @@ export type GetCentricosSitesResponse = GetSitesResponse;
 export interface GetCentricosSitesRequest
 	extends BaseRequest,
 		RequestQuery<GetCentricosSitesQuery> {}
+
+// GET /centricos/review/{orderId}/order-items - Get reviews for items in a given order in an array format
+
+export interface GetReviewOrderItemsPath {
+	orderId: string;
+}
+
+export interface GetReviewOrderItemsQuery {
+	// Graphql query string
+	_query?: string;
+}
+
+export type GetReviewOrderItemsResponse = ReviewOrderItemsResponseDTO;
+
+export interface GetReviewOrderItemsRequest
+	extends BaseRequest,
+		RequestQuery<GetReviewOrderItemsQuery>,
+		GetReviewOrderItemsPath {}

package/src/interface/menu.ts

@@ -668,6 +668,7 @@ export interface DraftCategoryToItemRelationshipDTO {
 }
 
 export interface DraftItemDTO {
+	is_published?: boolean;
 	parent?: Record<string, any>;
 	children?: Record<string, any>[];
 	modifier_groups?: DraftItemToModifierGroupRelationshipDTO[];
@@ -1452,6 +1453,7 @@ export interface LineRouteSuggestion {
 }
 
 export interface DraftItemEntityDTO {
+	is_published?: boolean;
 	parent?: DraftItemDTO;
 	children?: DraftItemDTO[];
 	modifier_groups?: DraftItemToModifierGroupRelationshipDTO[];
@@ -4916,6 +4918,7 @@ export interface PostMenuV3CategoryRelationshipsItemRecoverRequest
 // POST /menu/v3/draft/item
 
 export interface PostMenuV3DraftItemBody {
+	is_published?: boolean;
 	parent?: DraftItemDTO;
 	children?: DraftItemDTO[];
 	modifier_groups?: DraftItemToModifierGroupRelationshipDTO[];
@@ -4989,6 +4992,7 @@ export interface PatchMenuV3DraftItemPath {
 }
 
 export interface PatchMenuV3DraftItemBody {
+	is_published?: boolean;
 	parent?: DraftItemDTO;
 	children?: DraftItemDTO[];
 	modifier_groups?: DraftItemToModifierGroupRelationshipDTO[];
@@ -5103,6 +5107,7 @@ export interface GetMenuV3DraftItemsRequest
 // POST /menu/v3/draft/items
 
 export type PostMenuV3DraftItemsBody = {
+	is_published?: boolean;
 	parent?: DraftItemDTO;
 	children?: DraftItemDTO[];
 	modifier_groups?: DraftItemToModifierGroupRelationshipDTO[];
@@ -5206,6 +5211,7 @@ export interface GetMenuV3DraftItemLineRoutesRequest
 
 export interface PatchMenuV3DraftItemsBulkUpdateBody {
 	id_list: string[];
+	is_published?: boolean;
 	parent?: DraftItemDTO;
 	children?: DraftItemDTO[];
 	modifier_groups?: DraftItemToModifierGroupRelationshipDTO[];
@@ -7707,6 +7713,7 @@ export interface DeleteMenuV4BrandCategoryRequest
 // POST /menu/v4/item
 
 export interface PostMenuV4ItemBody {
+	is_published?: boolean;
 	parent?: DraftItemDTO;
 	children?: DraftItemDTO[];
 	modifier_groups?: DraftItemToModifierGroupRelationshipDTO[];
@@ -7747,6 +7754,7 @@ export interface PostMenuV4ItemBody {
 }
 
 export interface PostMenuV4ItemResponse {
+	is_published?: boolean;
 	parent?: DraftItemDTO;
 	children?: DraftItemDTO[];
 	modifier_groups?: DraftItemToModifierGroupRelationshipDTO[];
@@ -7806,6 +7814,7 @@ export interface GetMenuV4ItemQuery {
 }
 
 export interface GetMenuV4ItemResponse {
+	is_published?: boolean;
 	parent?: DraftItemDTO;
 	children?: DraftItemDTO[];
 	modifier_groups?: DraftItemToModifierGroupRelationshipDTO[];
@@ -7862,6 +7871,7 @@ export interface PatchMenuV4ItemPath {
 
 export interface PatchMenuV4ItemBody {
 	base_item_id?: string;
+	is_published?: boolean;
 	parent?: DraftItemDTO;
 	children?: DraftItemDTO[];
 	modifier_groups?: DraftItemToModifierGroupRelationshipDTO[];
@@ -7901,6 +7911,7 @@ export interface PatchMenuV4ItemBody {
 }
 
 export interface PatchMenuV4ItemResponse {
+	is_published?: boolean;
 	parent?: DraftItemDTO;
 	children?: DraftItemDTO[];
 	modifier_groups?: DraftItemToModifierGroupRelationshipDTO[];

package/src/interface/review.ts

@@ -0,0 +1,103 @@
+/* eslint-disable */
+// THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
+
+import { RequestQuery, BaseRequest } from './util';
+
+export interface ReviewDTO {
+	taxonomy?: Record<string, string>;
+	id: string;
+	createdAt: string;
+	updatedAt: string;
+	score?: number;
+	comment?: string;
+	reason?: string[];
+}
+
+export interface GetReviewsResponseDTO {
+	reviews: ReviewDTO[];
+}
+
+export interface BadRequestErrorDTO {
+	message: string;
+	code: number;
+	data: Record<string, any>;
+}
+
+export interface UnauthorizedErrorDTO {
+	message: string;
+	code: number;
+	data: Record<string, any>;
+}
+
+export interface GetReviewResponseDTO {
+	taxonomy?: Record<string, string>;
+	id: string;
+	createdAt: string;
+	updatedAt: string;
+	score?: number;
+	comment?: string;
+	reason?: string[];
+}
+
+export interface NotFoundErrorDTO {
+	message: string;
+	code: number;
+	data: Record<string, any>;
+}
+
+export interface PostReviewRequestDTO {
+	taxonomy?: Record<string, string>;
+	score?: number;
+	comment?: string;
+	reason?: string[];
+}
+
+export interface PostReviewResponseDTO {
+	taxonomy?: Record<string, string>;
+	id: string;
+	createdAt: string;
+	updatedAt: string;
+	score?: number;
+	comment?: string;
+	reason?: string[];
+}
+
+// GET /review - Get reviews by taxonomy
+
+export interface GetReviewsQuery {
+	taxonomyFilter: string;
+	// Graphql query string
+	_query?: string;
+}
+
+export type GetReviewsResponse = GetReviewsResponseDTO;
+
+export interface GetReviewsRequest extends BaseRequest, RequestQuery<GetReviewsQuery> {}
+
+// POST /review - Post a review
+
+export type PostReviewBody = PostReviewRequestDTO;
+
+export type PostReviewResponse = PostReviewResponseDTO;
+
+export interface PostReviewRequest extends BaseRequest {
+	body: PostReviewBody;
+}
+
+// GET /review/{id} - Get a review
+
+export interface GetReviewPath {
+	id: string;
+}
+
+export interface GetReviewQuery {
+	// Graphql query string
+	_query?: string;
+}
+
+export type GetReviewResponse = GetReviewResponseDTO;
+
+export interface GetReviewRequest
+	extends BaseRequest,
+		RequestQuery<GetReviewQuery>,
+		GetReviewPath {}