@compassdigital/sdk.typescript 4.128.0 → 4.130.0

package/src/interface/ai.ts

@@ -22,19 +22,29 @@ export interface GenerateTextResponse {
 	messages: MessageDTO[];
 }
 
-export interface BadRequestErrorDTO {
-	message: string;
-	code: number;
-	data: Record<string, any>;
+export interface ErrorDisplayMessage {
+	// user message title
+	title: string;
+	// user message description
+	description: string;
 }
 
-export interface UnauthorizedErrorDTO {
-	message: string;
-	code: number;
-	data: Record<string, any>;
+export interface ErrorData {
+	// http status code
+	statusCode: number;
+	// http status text
+	statusText: string;
+	timestamp: string;
+	displayMessage: ErrorDisplayMessage;
 }
 
-export type InternalServerErrorException = Record<string, any>;
+export interface Error {
+	// business error code
+	code: number;
+	// business error description
+	message: string;
+	data: ErrorData;
+}
 
 export interface GenerateImageRequest {
 	prompt: string;

package/src/interface/centricos.ts

@@ -12,19 +12,29 @@ export interface AIItemDescriptionResponse {
 	description: string;
 }
 
-export interface BadRequestErrorDTO {
-	message: string;
-	code: number;
-	data: Record<string, any>;
+export interface ErrorDisplayMessage {
+	// user message title
+	title: string;
+	// user message description
+	description: string;
 }
 
-export interface UnauthorizedErrorDTO {
-	message: string;
-	code: number;
-	data: Record<string, any>;
+export interface ErrorData {
+	// http status code
+	statusCode: number;
+	// http status text
+	statusText: string;
+	timestamp: string;
+	displayMessage: ErrorDisplayMessage;
 }
 
-export type InternalServerErrorException = Record<string, any>;
+export interface Error {
+	// business error code
+	code: number;
+	// business error description
+	message: string;
+	data: ErrorData;
+}
 
 export interface AIItemImageRequest {
 	name?: string;
@@ -65,6 +75,8 @@ export interface ReportGroupConfigResponse {
 	is_default: boolean;
 }
 
+export type InternalServerErrorException = Record<string, any>;
+
 export interface ReportGroupConfigRequest {
 	day_time: string;
 	day_parts: DayPart[];
@@ -276,10 +288,6 @@ export interface PutDiscountVoucherifyResponseDTO {
 	discount: DiscountResponseDTO;
 }
 
-export type DiscountValidationError = Record<string, any>;
-
-export type DiscountCreateError = Record<string, any>;
-
 export interface SiteDTO {
 	// The ID of the site
 	id: string;
@@ -306,14 +314,10 @@ export interface PutDiscountVoucherifyPublishResponseDTO {
 	is?: CentricDiscountIs;
 }
 
-export type DiscountPublishError = Record<string, any>;
-
 export interface DeleteDiscountsVoucherifyResponseDTO {
 	success: boolean;
 }
 
-export type DiscountDeleteError = Record<string, any>;
-
 export interface DiscountDTO {
 	// user is of discount creator
 	createdBy: string;

package/src/interface/consumer.ts

@@ -64,16 +64,28 @@ export interface ListAvailablePaymentsResponseDTO {
 	digital_wallet_pay: DigitalWallet;
 }
 
-export interface UnauthorizedErrorDTO {
-	message: string;
-	code: number;
-	data: Record<string, any>;
+export interface ErrorDisplayMessage {
+	// user message title
+	title: string;
+	// user message description
+	description: string;
 }
 
-export interface NotFoundErrorDTO {
-	message: string;
+export interface ErrorData {
+	// http status code
+	statusCode: number;
+	// http status text
+	statusText: string;
+	timestamp: string;
+	displayMessage: ErrorDisplayMessage;
+}
+
+export interface Error {
+	// business error code
 	code: number;
-	data: Record<string, any>;
+	// business error description
+	message: string;
+	data: ErrorData;
 }
 
 export interface OrderTotals {
@@ -736,12 +748,6 @@ export interface GetCustomerOrdersResponseDTO {
 	orders: CustomerOrder[];
 }
 
-export interface BadRequestErrorDTO {
-	message: string;
-	code: number;
-	data: Record<string, any>;
-}
-
 export interface PostReviewOrderItemRequest {
 	// rating score
 	score: number;

package/src/interface/discount.ts

@@ -52,26 +52,30 @@ export interface GetDiscountResponseDTO {
 	meta?: DiscountMeta;
 }
 
-export interface BadRequestErrorDTO {
-	message: string;
-	code: number;
-	data: Record<string, any>;
+export interface ErrorDisplayMessage {
+	// user message title
+	title: string;
+	// user message description
+	description: string;
 }
 
-export interface UnauthorizedErrorDTO {
-	message: string;
-	code: number;
-	data: Record<string, any>;
+export interface ErrorData {
+	// http status code
+	statusCode: number;
+	// http status text
+	statusText: string;
+	timestamp: string;
+	displayMessage: ErrorDisplayMessage;
 }
 
-export interface NotFoundErrorDTO {
-	message: string;
+export interface Error {
+	// business error code
 	code: number;
-	data: Record<string, any>;
+	// business error description
+	message: string;
+	data: ErrorData;
 }
 
-export type InternalServerErrorException = Record<string, any>;
-
 export interface DiscountDTO {
 	// discount id
 	id: string;
@@ -226,6 +230,7 @@ export type DeleteDiscountResponse = DeleteDiscountResponseDTO;
 
 export interface GetDiscountsQuery {
 	taxonomyFilter: string;
+	statusFilter?: string;
 	// Graphql query string
 	_query?: string;
 }
@@ -238,7 +243,7 @@ export type PostDiscountBody = PostDiscountRequestDTO;
 
 export type PostDiscountResponse = PostDiscountResponseDTO;
 
-// GET /discount/all - Get all discount
+// GET /discount/all - Get all discounts
 
 export interface GetDiscountsAllQuery {
 	// Graphql query string

package/src/interface/frictionless.ts

@@ -147,12 +147,6 @@ export interface AmazonJWOIdentityKeysRequestDTO {
 
 export type AmazonJWOIdentityKeysResponseDTO = Record<string, any>;
 
-export interface BadRequestError {
-	message: string;
-	code: number;
-	data: Record<string, any>;
-}
-
 export interface ShoppingTrip {
 	// Contains a timestamp for the time the shopping trip starts. This value is not validated on our service.
 	startTime: string;

package/src/interface/menu.ts

@@ -425,6 +425,7 @@ export interface GlobalMenuGroupDTO {
 	posid_segment?: string;
 	auto_push_to_local?: boolean;
 	price_levels?: Record<string, any>;
+	show_v4?: boolean;
 	id?: string;
 	permissions?: Record<string, any>;
 	[index: string]: any;
@@ -585,6 +586,7 @@ export interface LocalMenuGroupDTO {
 	draft_brands?: DraftBrandDTO[];
 	published_brands?: PublishedBrandDTO[];
 	price_levels?: Record<string, any>;
+	show_v4?: boolean;
 	id: string;
 	created_at?: string;
 	updated_at?: string;
@@ -2096,6 +2098,7 @@ export interface PostMenuV3LocalMenuGroupBody {
 	draft_brands?: DraftBrandDTO[];
 	published_brands?: PublishedBrandDTO[];
 	price_levels?: Record<string, any>;
+	show_v4?: boolean;
 	vendor_metadata?: VendorMetadataDTO[];
 	permissions?: Record<string, any>;
 	[index: string]: any;
@@ -2108,6 +2111,7 @@ export interface PostMenuV3LocalMenuGroupResponse {
 	draft_brands?: DraftBrandDTO[];
 	published_brands?: PublishedBrandDTO[];
 	price_levels?: Record<string, any>;
+	show_v4?: boolean;
 	id: string;
 	created_at?: string;
 	updated_at?: string;
@@ -2144,6 +2148,7 @@ export interface GetMenuV3LocalMenuGroupResponse {
 	draft_brands?: DraftBrandDTO[];
 	published_brands?: PublishedBrandDTO[];
 	price_levels?: Record<string, any>;
+	show_v4?: boolean;
 	id: string;
 	created_at?: string;
 	updated_at?: string;
@@ -2172,6 +2177,7 @@ export interface PatchMenuV3LocalMenuGroupBody {
 	draft_brands?: DraftBrandDTO[];
 	published_brands?: PublishedBrandDTO[];
 	price_levels?: Record<string, any>;
+	show_v4?: boolean;
 	id?: string;
 	version?: number;
 	vendor_metadata?: VendorMetadataDTO[];
@@ -2186,6 +2192,7 @@ export interface PatchMenuV3LocalMenuGroupResponse {
 	draft_brands?: DraftBrandDTO[];
 	published_brands?: PublishedBrandDTO[];
 	price_levels?: Record<string, any>;
+	show_v4?: boolean;
 	id: string;
 	created_at?: string;
 	updated_at?: string;
@@ -2220,6 +2227,7 @@ export interface DeleteMenuV3LocalMenuGroupResponse {
 	draft_brands?: DraftBrandDTO[];
 	published_brands?: PublishedBrandDTO[];
 	price_levels?: Record<string, any>;
+	show_v4?: boolean;
 	id: string;
 	created_at?: string;
 	updated_at?: string;
@@ -2275,6 +2283,7 @@ export type PostMenuV3LocalMenuGroupsBody = {
 	draft_brands?: DraftBrandDTO[];
 	published_brands?: PublishedBrandDTO[];
 	price_levels?: Record<string, any>;
+	show_v4?: boolean;
 	vendor_metadata?: VendorMetadataDTO[];
 	permissions?: Record<string, any>;
 	[index: string]: any;
@@ -2655,6 +2664,7 @@ export interface PostMenuV3GlobalMenuGroupBody {
 	posid_segment: string;
 	auto_push_to_local?: boolean;
 	price_levels?: Record<string, any>;
+	show_v4?: boolean;
 	vendor_metadata?: VendorMetadataDTO[];
 	permissions?: Record<string, any>;
 	[index: string]: any;
@@ -2703,6 +2713,7 @@ export interface PatchMenuV3GlobalMenuGroupBody {
 	posid_segment?: string;
 	auto_push_to_local?: boolean;
 	price_levels?: Record<string, any>;
+	show_v4?: boolean;
 	id?: string;
 	version?: number;
 	vendor_metadata?: VendorMetadataDTO[];
@@ -2738,6 +2749,7 @@ export interface DeleteMenuV3GlobalMenuGroupResponse {
 	posid_segment: string;
 	auto_push_to_local?: boolean;
 	price_levels?: Record<string, any>;
+	show_v4?: boolean;
 	id: string;
 	created_at?: string;
 	updated_at?: string;
@@ -2795,6 +2807,7 @@ export type PostMenuV3GlobalMenuGroupsBody = {
 	posid_segment: string;
 	auto_push_to_local?: boolean;
 	price_levels?: Record<string, any>;
+	show_v4?: boolean;
 	vendor_metadata?: VendorMetadataDTO[];
 	permissions?: Record<string, any>;
 	[index: string]: any;

package/src/interface/promo.ts

@@ -298,6 +298,21 @@ export interface PromoReverseRequest {
 	redemption?: Redemption;
 }
 
+export interface PromoReverseStackableRequest {
+	reason?: string;
+	app?: string;
+	location_brand?: string;
+	totals?: {
+		amount?: number;
+		currency?: string;
+	};
+	shoppingcart?: {
+		id?: string;
+		date_created?: string;
+	};
+	redemptions?: Redemption[];
+}
+
 export interface Customer {
 	id?: string;
 	source_id?: string;
@@ -686,7 +701,7 @@ export interface PostPromoVoucherReverseStackablePath {
 	redemption_id: string;
 }
 
-export type PostPromoVoucherReverseStackableBody = PromoReverseRequest;
+export type PostPromoVoucherReverseStackableBody = PromoReverseStackableRequest;
 
 export type PostPromoVoucherReverseStackableResponse = RedemptionReversal;
 

package/src/interface/review.ts

@@ -17,16 +17,28 @@ export interface GetReviewsResponseDTO {
 	reviews: ReviewDTO[];
 }
 
-export interface BadRequestErrorDTO {
-	message: string;
-	code: number;
-	data: Record<string, any>;
+export interface ErrorDisplayMessage {
+	// user message title
+	title: string;
+	// user message description
+	description: string;
 }
 
-export interface UnauthorizedErrorDTO {
-	message: string;
+export interface ErrorData {
+	// http status code
+	statusCode: number;
+	// http status text
+	statusText: string;
+	timestamp: string;
+	displayMessage: ErrorDisplayMessage;
+}
+
+export interface Error {
+	// business error code
 	code: number;
-	data: Record<string, any>;
+	// business error description
+	message: string;
+	data: ErrorData;
 }
 
 export interface GetReviewResponseDTO {
@@ -39,7 +51,7 @@ export interface GetReviewResponseDTO {
 	reason?: string[];
 }
 
-export interface NotFoundErrorDTO {
+export interface NotFoundError {
 	message: string;
 	code: number;
 	data: Record<string, any>;

package/src/interface/shoppingcart.ts

@@ -326,7 +326,11 @@ export interface ShoppingCartResponse {
 		order_loyalty_points?: boolean;
 	};
 	discount?: PromoDetails;
-	discounts?: Discount[];
+	discounts?: {
+		stacked_total?: MonetaryValue;
+		stacked_discounts?: Discount[];
+		app?: string;
+	};
 	payment_method?: PaymentMethod;
 	taxes?: Taxes;
 	total?: {
@@ -609,6 +613,7 @@ export interface Discount {
 		};
 		[index: string]: any;
 	};
+	applied_amount: MonetaryValue;
 }
 
 // POST /shoppingcart - Create a new ShoppingCart

package/src/interface/tax.ts

@@ -80,22 +80,28 @@ export interface TaxResponseDTO {
 	provider: string;
 }
 
-export interface BadRequestErrorDTO {
-	message: string;
-	code: number;
-	data: Record<string, any>;
+export interface ErrorDisplayMessage {
+	// user message title
+	title: string;
+	// user message description
+	description: string;
 }
 
-export interface UnauthorizedErrorDTO {
-	message: string;
-	code: number;
-	data: Record<string, any>;
+export interface ErrorData {
+	// http status code
+	statusCode: number;
+	// http status text
+	statusText: string;
+	timestamp: string;
+	displayMessage: ErrorDisplayMessage;
 }
 
-export interface ServiceUnavailableErrorDTO {
-	message: string;
+export interface Error {
+	// business error code
 	code: number;
-	data: Record<string, any>;
+	// business error description
+	message: string;
+	data: ErrorData;
 }
 
 // GET /tax/v1/health-check - Health Check

package/src/interface/vendor.ts

@@ -252,11 +252,16 @@ export interface PatchVendorApplicationRequest extends BaseRequest, PatchVendorA
 
 // POST /vendor - Create new vendor
 
+export interface PostVendorQuery {
+	// Send email notification to vendor (default true)
+	email?: boolean;
+}
+
 export type PostVendorBody = VendorPostBody;
 
 export type PostVendorResponse = Vendor;
 
-export interface PostVendorRequest extends BaseRequest {
+export interface PostVendorRequest extends BaseRequest, RequestQuery<PostVendorQuery> {
 	body: PostVendorBody;
 }
 
@@ -409,9 +414,17 @@ export interface DeleteVendorKeyPath {
 	key: string;
 }
 
+export interface DeleteVendorKeyQuery {
+	// If true, performs a hard delete instead of marking as expired
+	hard?: boolean;
+}
+
 export type DeleteVendorKeyResponse = Key;
 
-export interface DeleteVendorKeyRequest extends BaseRequest, DeleteVendorKeyPath {}
+export interface DeleteVendorKeyRequest
+	extends BaseRequest,
+		RequestQuery<DeleteVendorKeyQuery>,
+		DeleteVendorKeyPath {}
 
 // POST /vendor/{id}/key/{key}/rotate - Rotate vendor key
 

package/test/client.test.ts

@@ -29,7 +29,7 @@ describe('ServiceClient', () => {
 			route: '/task/{id}',
 			service: 'task',
 			url: 'https://dev.api.compassdigital.org/task/some_id',
-			method: 'get',
+			method: 'GET',
 			headers: {
 				'User-Agent': 'CDL/ServiceClient',
 			},