@compassdigital/sdk.typescript 4.93.0 → 4.94.0

package/src/interface/order.ts

@@ -22,8 +22,6 @@ export interface CreateOrder {
 	// user
 	customer?: string;
 	is?: {
-		//@deprecated
-		accepted?: boolean;
 		in_progress?: boolean;
 		ready?: boolean;
 	};
@@ -112,7 +110,6 @@ export interface Order {
 	// user
 	customer?: string;
 	is?: {
-		//@deprecated
 		accepted?: boolean;
 		in_progress?: boolean;
 		ready?: boolean;
@@ -189,10 +186,12 @@ export interface Order {
 		shoppingcart?: {
 			total?: {
 				amount?: number;
+				meals?: number;
 			};
 			// Total of first cart on order. Carts can change after refunds, so this is original value
 			original_total?: {
 				amount?: number;
+				meals?: number;
 			};
 			[index: string]: any;
 		};
@@ -570,8 +569,10 @@ export interface GetOrderLocationBrandQuery {
 	order_type?: string;
 	// number of orders per page
 	limit?: number;
-	// return orders with all status types
+	// include not accepted checkin orders
 	all_statuses?: boolean;
+	// return orders with specific statuses. Comma separated list of status:value pairs. Example: ready:true,cancelled:true - will return orders that are ready or cancelled
+	status?: string;
 	// Graphql query string
 	_query?: string;
 }

package/src/interface/partner.ts

@@ -462,6 +462,7 @@ export interface Brand {
 		software_integrations?: {
 			system365?: string;
 			jwo?: string;
+			time2eat?: string;
 		};
 		[index: string]: any;
 	};

package/src/interface/user.ts

@@ -10,7 +10,6 @@ export interface Error {
 }
 
 export interface User {
-	// user
 	id?: string;
 	email?: string;
 	name?: {
@@ -27,7 +26,7 @@ export interface User {
 	phone?: number;
 	// User phone country code in ISO 3166-1 alpha-2 format
 	phone_country_code?: string;
-	// realm
+	// The ID for the realm (Boost, Thrive, etc.) that the user belongs to
 	realm?: string;
 	gender?: 'male' | 'female' | 'non-binary';
 	meta?: UserMeta;
@@ -61,12 +60,12 @@ export interface GuestUserCreate {
 		first?: string;
 		last?: string;
 	};
-	// realm
+	// The ID for the realm (Boost, Thrive, etc.) that the user belongs to
 	realm?: string;
 }
 
 export interface GuestUserToken {
-	// realm
+	// The ID for the realm (Boost, Thrive, etc.) that the user belongs to
 	realm?: string;
 }
 
@@ -109,7 +108,6 @@ export interface auth {
 		token?: string;
 		expires?: string;
 	};
-	// user
 	user?: string;
 	profile?: User;
 }
@@ -121,7 +119,6 @@ export interface guestAuth {
 		token?: string;
 		expires?: string;
 	};
-	// user
 	user?: string;
 	profile?: User;
 }
@@ -139,7 +136,6 @@ export interface omsauth {
 		token?: string;
 		expires?: string;
 	};
-	// user
 	user?: string;
 	profile?: User;
 }
@@ -179,7 +175,7 @@ export interface KDSDevice {
 }
 
 export interface Checkin {
-	// checkin
+	// The ID for user check-in
 	checkin_id?: string;
 	// The colour that identifies the visit in hex code
 	colour?: string;
@@ -198,7 +194,6 @@ export interface Checkin {
 		// If the `User` is near or far from a store (as determined by the backend). If this is `false` for a prolonged period the client should assume the `User` is not in a standard store and stop trying to attach.
 		near_store?: boolean;
 	};
-	// user
 	user_id?: string;
 	date_queued?: string;
 	// The state of the user association process (attaching). Present for NFC check-ins only
@@ -258,7 +253,7 @@ export interface Key {
 }
 
 export interface UserDeviceAuthBody {
-	// KDS IDFA id
+	// The ID for the body of the user device's authentication
 	id?: string;
 	// CDL encoded id of a serial_number
 	serial_number?: string;
@@ -823,7 +818,6 @@ export interface GetUserProfileQuery {
 }
 
 export interface GetUserProfileResponse {
-	// user
 	id: string;
 	name: {
 		first?: string;