@compassdigital/sdk.typescript 4.160.0 → 4.162.0

package/src/interface/discount.ts

@@ -29,10 +29,12 @@ export interface VoucherifyMetaData {
 }
 
 export interface MetaProvider {
+	// Voucherify metadata
 	voucherify?: VoucherifyMetaData;
 }
 
 export interface DiscountMeta {
+	// discount 3rd party provider metadata
 	provider: MetaProvider;
 }
 
@@ -66,6 +68,7 @@ export interface ErrorData {
 	// http status text
 	statusText: string;
 	timestamp: string;
+	// user friendly error message
 	displayMessage: ErrorDisplayMessage;
 }
 
@@ -74,6 +77,7 @@ export interface Error {
 	code: number;
 	// business error description
 	message: string;
+	// additional error data
 	data: ErrorData;
 }
 

package/src/interface/frictionless.ts

@@ -23,6 +23,7 @@ export interface ErrorData {
 	// http status text
 	statusText: string;
 	timestamp: string;
+	// user friendly error message
 	displayMessage: ErrorDisplayMessage;
 }
 
@@ -31,6 +32,7 @@ export interface Error {
 	code: number;
 	// business error description
 	message: string;
+	// additional error data
 	data: ErrorData;
 }
 
@@ -49,7 +51,9 @@ export interface CreditCardDTO {
 }
 
 export interface PaymentMethodDTO {
+	// The mealplan information
 	mealplan?: MealplanDTO;
+	// The credit card information
 	creditCard?: CreditCardDTO;
 	// Token used for identify the payment method
 	token: string;

package/src/interface/menu.ts

@@ -4451,6 +4451,7 @@ export interface PostMenuV3DraftMenuDuplicatePath {
 
 export interface PostMenuV3DraftMenuDuplicateBody {
 	name?: string;
+	translation?: NameTranslation;
 	[index: string]: any;
 }
 
@@ -4841,6 +4842,7 @@ export interface PostMenuV3DraftCategoryDuplicateBody {
 	sequence?: number;
 	is_active?: boolean;
 	menu_id?: string;
+	translation?: NameTranslation;
 	[index: string]: any;
 }
 

package/src/interface/order.ts

@@ -378,9 +378,9 @@ export interface Orders {
 	};
 }
 
-export interface ItemsWithIssue extends OrderedItem {
+export type ItemsWithIssue = OrderedItem & {
 	reason?: string;
-}
+};
 
 export interface ActionResponse {
 	success?: boolean;

package/src/interface/review.ts

@@ -30,6 +30,7 @@ export interface ErrorData {
 	// http status text
 	statusText: string;
 	timestamp: string;
+	// user friendly error message
 	displayMessage: ErrorDisplayMessage;
 }
 
@@ -38,6 +39,7 @@ export interface Error {
 	code: number;
 	// business error description
 	message: string;
+	// additional error data
 	data: ErrorData;
 }
 

package/src/interface/tax.ts

@@ -45,11 +45,13 @@ export interface TaxRequestDTO {
 	id: string;
 	// the app to associate the transaction with
 	appName: string;
+	// the order fulfillment type
 	transactionType: TransactionType;
 	// numeric value of service fee
 	serviceFee?: number;
 	// numeric value of delivery fee
 	deliveryFee?: number;
+	// location data of the transaction
 	locationData: TaxLocationData;
 	// items to calculate tax on
 	items: TaxItemDTO[];
@@ -75,6 +77,7 @@ export interface TaxResponseDTO {
 	amount: number;
 	// the total tax rate applied to the items to determine the total tax of the transaction
 	rate: number;
+	// tax breakdown containing amount for state/province and total taxable amount
 	breakdown: TaxBreakdownDTO;
 	// the name of the tax provider
 	provider: string;
@@ -93,6 +96,7 @@ export interface ErrorData {
 	// http status text
 	statusText: string;
 	timestamp: string;
+	// user friendly error message
 	displayMessage: ErrorDisplayMessage;
 }
 
@@ -101,6 +105,7 @@ export interface Error {
 	code: number;
 	// business error description
 	message: string;
+	// additional error data
 	data: ErrorData;
 }
 

package/src/interface/timeslots.ts

@@ -28,6 +28,7 @@ export interface ErrorData {
 	// http status text
 	statusText: string;
 	timestamp: string;
+	// user friendly error message
 	displayMessage: ErrorDisplayMessage;
 }
 
@@ -36,6 +37,7 @@ export interface Error {
 	code: number;
 	// business error description
 	message: string;
+	// additional error data
 	data: ErrorData;
 }
 

package/src/messages/legacy/CheckinProcessingFailedEvent.ts

@@ -5,7 +5,7 @@
  * Create a new message type respecting the new standards
  */
 export interface CheckinProcessingFailedEvent {
-	name: string;
+	name: 'checkin-processing-failed-event';
 	correlationID: string;
 	checkin: {
 		id: string;

package/src/messages/legacy/FrictionlessCheckinExecutedEvent.ts

@@ -5,7 +5,7 @@
  * Create a new message type respecting the new standards
  */
 export interface FrictionlessCheckinExecutedEvent {
-	name: string;
+	name: 'frictionless-checkin-executed-event';
 	correlationID: string;
 	checkinID: string;
 	thirdPartyCorrelatedID: string;

package/src/messages/legacy/FrictionlessThirdPartyWebhookReceivedEvent.ts

@@ -5,7 +5,7 @@
  * Create a new message type respecting the new standards
  */
 export interface FrictionlessThirdPartyWebhookReceivedEvent {
-	name: string;
+	name: 'frictionless-third-party-webhook-received-event';
 	correlationID: string;
 	webhook: {
 		id: string;

package/src/messages/legacy/ReprocessCheckinCommandArrivedEvent.ts

@@ -5,7 +5,7 @@
  * Create a new message type respecting the new standards
  */
 export interface ReprocessCheckinCommandArrivedEvent {
-	name: string;
+	name: 'reprocess-checkin-command-arrived-event';
 	checkinID: string;
 	correlationID: string;
 	type: 'ReprocessCheckinCommandArrivedEvent';

package/src/messages/legacy/UpdateCheckInPaymentRequiredEvent.ts

@@ -5,7 +5,7 @@
  * Create a new message type respecting the new standards
  */
 export interface UpdateCheckInPaymentRequiredEvent {
-	name: string;
+	name: 'update-checkin-payment-required-event';
 	correlationID: string;
 	checkin: {
 		id: string;