@compassdigital/sdk.typescript 4.94.1 → 4.95.0

package/src/interface/announcement.ts

@@ -23,11 +23,10 @@ export interface AnnouncementPostRequestBody {
 	// True if all the sites are linked
 	is_global?: boolean;
 	allowed_resources?: string[];
-	position: number;
+	position?: number;
 	//@deprecated
 	active?: boolean;
-	// Status of the announcement
-	status?: 'draft' | 'active' | 'disabled';
+	status?: Status;
 	// Announcement Properties
 	info?: {
 		en?: AnnouncementInfo;
@@ -87,7 +86,7 @@ export interface Announcement {
 	name: string;
 	// Announcement Type
 	type: string;
-	key: string;
+	key?: string;
 	// App name
 	app: 'Boost' | 'Thrive' | 'Nourish' | 'JJKitchen' | 'Rogers';
 	// True if all the sites are linked
@@ -97,7 +96,7 @@ export interface Announcement {
 	active: boolean;
 	// Status of the announcement
 	status?: 'draft' | 'active' | 'disabled';
-	schedule: Schedule;
+	schedule?: Schedule;
 	// Date created
 	created_at: string;
 	// Date modified
@@ -121,9 +120,9 @@ export interface Announcements {
 
 export interface AnnouncementInfo {
 	image_url?: string;
-	title: string;
-	description: string;
-	sub_text: string;
+	title?: string;
+	description?: string;
+	sub_text?: string;
 	button_text?: string;
 }
 
@@ -155,13 +154,20 @@ export interface Schedule {
 	}[];
 }
 
+export type Status = 'draft' | 'active' | 'disabled';
+
 // POST /announcement - Create Announcement
 
+export interface PostAnnouncementQuery {
+	// Bypasses the default schedule creation logic
+	no_default_schedule?: boolean;
+}
+
 export type PostAnnouncementBody = AnnouncementPostRequestBody;
 
 export type PostAnnouncementResponse = Announcement;
 
-export interface PostAnnouncementRequest extends BaseRequest {
+export interface PostAnnouncementRequest extends BaseRequest, RequestQuery<PostAnnouncementQuery> {
 	body: PostAnnouncementBody;
 }
 
@@ -199,6 +205,8 @@ export interface GetAnnouncementsQuery {
 	sort_by?: string;
 	// Sort order (ASC or DESC)
 	sort_order?: string;
+	// Filter by status - 'active', 'draft', 'disabled'
+	status?: string;
 	// Graphql query string
 	_query?: string;
 }
@@ -233,11 +241,19 @@ export interface PutAnnouncementPath {
 	id: string;
 }
 
+export interface PutAnnouncementQuery {
+	// Bypasses the default schedule creation logic
+	no_default_schedule?: boolean;
+}
+
 export type PutAnnouncementBody = AnnouncementPutRequestBody;
 
 export type PutAnnouncementResponse = Announcement;
 
-export interface PutAnnouncementRequest extends BaseRequest, PutAnnouncementPath {
+export interface PutAnnouncementRequest
+	extends BaseRequest,
+		RequestQuery<PutAnnouncementQuery>,
+		PutAnnouncementPath {
 	body: PutAnnouncementBody;
 }
 

package/src/interface/compassconnect.ts

@@ -55,15 +55,6 @@ export interface Auth {
 	refresh_token?: string;
 }
 
-export interface Compassconnect {
-	// compassconnect
-	id: string;
-}
-
-export interface Compassconnects {
-	compassconnects: Compassconnect[];
-}
-
 // GET /compassconnect/oms_token - Gets an OMS token
 
 export interface GetCompassconnectOmsTokenQuery {

package/src/interface/consumer.ts

@@ -3,7 +3,7 @@
 
 import { RequestQuery, BaseRequest } from './util';
 
-export interface IsStatus {
+export interface PaymentMethodIsStatus {
 	eligible: boolean;
 	validated?: boolean;
 	preferred?: boolean;
@@ -16,7 +16,7 @@ export interface Tender {
 	type?: string;
 	currency?: string;
 	tender_number?: string;
-	is: IsStatus;
+	is: PaymentMethodIsStatus;
 }
 
 export interface TenderList {
@@ -36,7 +36,7 @@ export interface CreditCard {
 	billing_address?: BillingAddress;
 	card_type?: string;
 	expiry?: ExpiryDate;
-	is: IsStatus;
+	is: PaymentMethodIsStatus;
 	masked_card_number?: string;
 	name_on_card?: string;
 	nickname?: string;
@@ -49,7 +49,7 @@ export interface CreditCardData {
 }
 
 export interface DigitalWalletFlavor {
-	is: IsStatus;
+	is: PaymentMethodIsStatus;
 }
 
 export interface DigitalWallet {
@@ -76,6 +76,195 @@ export interface NotFoundErrorDTO {
 	data: Record<string, any>;
 }
 
+export interface Brand {
+	id: string;
+	name?: string;
+}
+
+export interface OrderDate {
+	accepted?: string;
+	created?: string;
+	modified?: string;
+	should_start?: string;
+	completion_warning?: string;
+	ready?: string;
+	started?: string;
+	show_as_active_until?: string;
+	no_show?: string;
+	collected?: string;
+	delivered?: string;
+	pickup?: string;
+	cancelled?: string;
+}
+
+export interface OrderDetails {
+	name?: string;
+	display_id?: string;
+	contact_number?: string;
+	country_code?: string;
+	order_type?: string;
+	duration?: string;
+	destination?: string;
+	instructions?: string;
+}
+
+export interface Price {
+	amount?: number;
+}
+
+export interface RefundItem {
+	id?: string;
+	_index?: string;
+	quantity?: number;
+	price?: Price;
+	reason?: string;
+}
+
+export interface OrderIsStatus {
+	accepted?: boolean;
+	in_progress?: boolean;
+	ready?: boolean;
+	out_for_delivery?: boolean;
+	delivered?: boolean;
+	checkin_order?: boolean;
+	dining_hall_order?: boolean;
+	no_show?: boolean;
+	collected?: boolean;
+	cancelled?: boolean;
+}
+
+export interface CartTotal {
+	amount?: number;
+	meals?: number;
+}
+
+export interface Label {
+	en?: string;
+	fr?: string;
+}
+
+export interface QuantityByWeight {
+	unit?: string;
+	value?: number;
+}
+
+export interface SalePrice {
+	active?: boolean;
+	amount?: number;
+}
+
+export interface Modifier {
+	id: string;
+	price?: Price;
+	quantity?: number;
+	label?: Label;
+	_index?: string;
+}
+
+export interface ModifierGroup {
+	id: string;
+	label?: Label;
+	items?: Modifier[];
+}
+
+export interface OrderItemRating {
+	// order id
+	id: string;
+	// menu id
+	menu: string;
+	// item id
+	item: string;
+	// rating score
+	score: number;
+	// review comment
+	comment: string;
+	// review tags
+	reason: string[];
+}
+
+export interface CartItem {
+	id: string;
+	description?: Label;
+	_index?: string;
+	quantity: number;
+	quantity_by_weight?: QuantityByWeight;
+	price?: Price;
+	sale_price?: SalePrice;
+	weighed_price?: Price;
+	_subtotal?: Price;
+	options?: ModifierGroup[];
+	label?: Label;
+	name?: string;
+	review: OrderItemRating;
+}
+
+export interface ShoppingCart {
+	id: string;
+	total?: CartTotal;
+	items?: CartItem[];
+}
+
+export interface Order {
+	id?: string;
+	reorder_eligibility?:
+		| 'eligible'
+		| 'order_type_ineligible'
+		| 'location_ineligible'
+		| 'active_order'
+		| 'old_order'
+		| 'marketplace_order'
+		| 'duplicate_order'
+		| 'brand_unavailable'
+		| 'menu_unavailable'
+		| 'items_unavailable'
+		| 'refunded_order'
+		| 'modifiers_unavailable'
+		| 'modified_items'
+		| 'cancelled_order';
+	location_brand?: Brand;
+	location?: string;
+	date?: OrderDate;
+	details?: OrderDetails;
+	pickup?: string;
+	requested_date?: string;
+	refunds?: RefundItem[];
+	pickup_id?: string;
+	is?: OrderIsStatus;
+	shoppingcart?: ShoppingCart;
+}
+
+export interface GetCustomerOrdersResponseDTO {
+	orders: Order[];
+}
+
+export interface BadRequestErrorDTO {
+	message: string;
+	code: number;
+	data: Record<string, any>;
+}
+
+export interface ReviewOrderItemRatings {
+	// menu id
+	menu: string;
+	// item id
+	item: string;
+	// rating score
+	score: number;
+	// review comment
+	comment: string;
+	// review tags
+	reason: string[];
+}
+
+export interface PostReviewOrderItemRatingsRequestDTO {
+	orderId: string;
+	reviews: ReviewOrderItemRatings[];
+}
+
+export interface PostReviewOrderItemRatingsResponseDTO {
+	reviews: OrderItemRating[];
+}
+
 // GET /consumer/v1/health-check
 
 export interface HealthCheckControllerExecuteQuery {
@@ -105,3 +294,30 @@ export type GetPaymentListByBrandResponse = ListAvailablePaymentsResponseDTO;
 export interface GetPaymentListByBrandRequest
 	extends BaseRequest,
 		RequestQuery<GetPaymentListByBrandQuery> {}
+
+// GET /consumer/customer-orders - Get customer orders
+
+export interface GetCustomerOrdersQuery {
+	// Filter orders by their requested date. Only return orders that have a date greater than or equal to the date. Default is the current time in milliseconds.
+	start?: number;
+	// Filter orders by their requested date. Only return orders that have a date less than or equal to the date. Default is 24 hours from the current time in milliseconds.
+	end?: number;
+	// Graphql query string
+	_query?: string;
+}
+
+export type GetCustomerOrdersResponse = GetCustomerOrdersResponseDTO;
+
+export interface GetCustomerOrdersRequest
+	extends BaseRequest,
+		RequestQuery<GetCustomerOrdersQuery> {}
+
+// POST /consumer/review/order/item-ratings - Submit review containing order item ratings
+
+export type PostReviewOrderItemRatingsBody = PostReviewOrderItemRatingsRequestDTO;
+
+export type PostReviewOrderItemRatingsResponse = PostReviewOrderItemRatingsResponseDTO;
+
+export interface PostReviewOrderItemRatingsRequest extends BaseRequest {
+	body: PostReviewOrderItemRatingsBody;
+}