@compassdigital/sdk.typescript 4.96.0 → 4.98.0

package/src/interface/order.ts

@@ -4,11 +4,8 @@
 import { RequestQuery, BaseRequest } from './util';
 
 export interface CreateOrder {
-	// brand
 	location_brand?: string;
-	// location
 	location?: string;
-	// shoppingcart
 	shoppingcart?: string;
 	payment?: {
 		token?: string;
@@ -19,7 +16,6 @@ export interface CreateOrder {
 		coupon_voucher?: CashlessPayment;
 	};
 	mealplan?: MealPlan;
-	// user
 	customer?: string;
 	is?: {
 		in_progress?: boolean;
@@ -56,7 +52,6 @@ export interface Error {
 }
 
 export interface Issue {
-	// issue
 	id?: string;
 	type?: string;
 	//@deprecated
@@ -72,16 +67,11 @@ export interface Issue {
 }
 
 export interface Order {
-	// order
 	id?: string;
-	// brand
 	location_brand?: string;
-	// location
 	location?: string;
-	// shoppingcart
 	shoppingcart?: string;
 	payment?: {
-		// payment
 		token?: string;
 		credit_card?: CreditCard;
 		digital_wallet_pay?: string;
@@ -91,23 +81,18 @@ export interface Order {
 		coupon_voucher?: CashlessPayment;
 	};
 	mealplan?: {
-		// mealplan
 		id?: string;
-		// tender
 		tender?: string;
 		name?: string;
 	};
 	meal_swipes?: {
-		// mealplan
 		id?: string;
-		// tender
 		tender?: string;
 		tender_name?: string;
 		swipes?: number;
 		total?: number;
 	};
 	meal_exchange?: MealPlan;
-	// user
 	customer?: string;
 	is?: {
 		accepted?: boolean;
@@ -203,7 +188,6 @@ export interface Order {
 		active_override?: boolean;
 		// Delivery details
 		delivery?: {
-			// provider
 			provider?: string;
 			tracker_url?: string;
 			loading_code?: string;
@@ -255,10 +239,8 @@ export interface Cancel {
 }
 
 export interface RefundTransaction {
-	// shoppingcart
 	original_shoppingcart?: string;
 	refund_date?: string;
-	// user
 	issued_by?: string;
 	amount?: number;
 	refund_amount?: number;
@@ -302,9 +284,7 @@ export interface CashlessPayment {
 }
 
 export interface MealPlan {
-	// mealplan
 	id?: string;
-	// tender
 	tender?: string;
 	name?: string;
 }
@@ -323,9 +303,7 @@ export interface OrderIssue {
 }
 
 export interface OrderedItem {
-	// item
 	id: string;
-	// index
 	_index: string;
 	quantity?: number;
 	unit?: number;
@@ -346,9 +324,7 @@ export interface OrderedItem {
 			en?: string;
 		};
 		items?: {
-			// option
 			id?: string;
-			// index
 			_index?: string;
 			meta?: Record<string, any>;
 		}[];

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 {}