@compassdigital/sdk.typescript 4.108.0 → 4.110.0

package/src/interface/consumer.ts

@@ -771,18 +771,156 @@ export interface HomePageRequest {
 	end: number;
 	// current date as a long
 	date: number;
+	reorderEligible: boolean;
+}
+
+export interface LocalizedGreetingMessage {
+	en: string;
+	fr: string;
+	es: string;
+}
+
+export interface DiverseGreetingMessages {
+	start: string;
+	end: string;
+	messages: LocalizedGreetingMessage[];
+}
+
+export interface HeroImage {
+	start: string;
+	end: string;
+	images: string[];
 }
 
 export interface HomePageResponse {
-	// valid diverse greeting messages
-	greetingMessage: Record<string, any>[];
-	// valid hero images
-	heroImages: Record<string, any>[];
+	greetingMessage: DiverseGreetingMessages;
+	heroImages: HeroImage;
 	orders: Record<string, any>[][];
 	// location object for the site
 	location: Record<string, any>;
 }
 
+export interface FrictionlessCheckinResponse {
+	id: string;
+	provider: Record<string, any>;
+	status: Record<string, any>;
+	reasonOfFail?: string;
+	thirdPartyCorrelatedID?: string;
+	shoppingCartID?: string;
+	brandID: string;
+	userID: string;
+}
+
+export interface FrictionlessQrCodeRequest {
+	// brand id
+	brandId: string;
+	// payment method
+	paymentMethod: Record<string, any>;
+}
+
+export interface FrictionlessQrCodeResponse {
+	qrcode: string;
+	expiration: number;
+	id: string;
+}
+
+export interface ForgotPasswordRequest {
+	// email
+	email: string;
+}
+
+export interface ForgotPasswordResponse {
+	code?: number;
+	success?: boolean;
+}
+
+export interface AddUserSecretResponse {
+	key?: string;
+}
+
+export interface GetConsumerLocationGroupResponse {
+	// id
+	id: string;
+	date?: {
+		created?: string;
+		modified?: string;
+	};
+	// name
+	name: string;
+	label?: {
+		en?: string;
+		fr?: string;
+	};
+	// distance in meters from the group
+	distance?: number;
+	// list of locations
+	locations?: Record<string, any>[];
+	// location address
+	address?: Record<string, any>;
+	// meta data
+	meta?: Record<string, any>;
+	style?: {
+		logo?: string | null;
+		main_logo?: string | null;
+		alt_logo?: string | null;
+	};
+	// timezone
+	timezone?: string;
+}
+
+export interface GetConsumerLocationMultiGroupResponse {
+	// id
+	id: string;
+	// name
+	name: string;
+	// groups
+	groups: Record<string, any>[];
+}
+
+export interface ConsumerGetActiveMenusResponse {
+	// menus
+	menus: Record<string, any>[];
+}
+
+export interface GetConsumerMenuResponse {
+	// menu id
+	id: string;
+	date?: {
+		created?: string;
+		modified?: string;
+		published?: string;
+	};
+	label?: {
+		en?: string;
+	};
+	// menu groups
+	groups: Record<string, any>[];
+	// menu parent id
+	parent_id: string;
+	// menu location brand
+	location_brand?: string;
+	// menu company
+	company?: string;
+	// menu sector
+	sector?: string;
+	is?: {
+		disabled?: boolean;
+		hidden?: boolean;
+		linked?: boolean;
+		promo_exemptions_enabled?: boolean;
+		plu_enabled?: boolean;
+		item_images_enabled?: boolean;
+		item_showcase_enabled?: boolean;
+		item_desc_edit_enabled?: boolean;
+		calories_edit_enabled?: boolean;
+		item_label_edit_enabled?: boolean;
+		frictionless?: boolean;
+		category_images_enabled?: boolean;
+	};
+	// menu meta
+	meta?: Record<string, any>;
+}
+
 // GET /consumer/v1/health-check
 
 export interface HealthCheckControllerExecuteQuery {
@@ -792,10 +930,6 @@ export interface HealthCheckControllerExecuteQuery {
 
 export type HealthCheckControllerExecuteResponse = {};
 
-export interface HealthCheckControllerExecuteRequest
-	extends BaseRequest,
-		RequestQuery<HealthCheckControllerExecuteQuery> {}
-
 // GET /consumer/v1/payment-methods - List payment methods available in a given brand
 
 export interface GetPaymentListByBrandQuery {
@@ -809,10 +943,6 @@ export interface GetPaymentListByBrandQuery {
 
 export type GetPaymentListByBrandResponse = ListAvailablePaymentsResponseDTO;
 
-export interface GetPaymentListByBrandRequest
-	extends BaseRequest,
-		RequestQuery<GetPaymentListByBrandQuery> {}
-
 // GET /consumer/customer-orders/{userId} - Get customer orders
 
 export interface GetCustomerOrdersPath {
@@ -831,27 +961,151 @@ export interface GetCustomerOrdersQuery {
 
 export type GetCustomerOrdersResponse = GetCustomerOrdersResponseDTO;
 
-export interface GetCustomerOrdersRequest
-	extends BaseRequest,
-		RequestQuery<GetCustomerOrdersQuery>,
-		GetCustomerOrdersPath {}
-
 // POST /consumer/review/order-items - Submit reviews for order items
 
 export type PostReviewOrderItemsBody = PostReviewOrderItemsRequestDTO;
 
 export type PostReviewOrderItemsResponse = PostReviewOrderItemsResponseDTO;
 
-export interface PostReviewOrderItemsRequest extends BaseRequest {
-	body: PostReviewOrderItemsBody;
-}
-
 // POST /consumer/home - Provide the front end all the data required to render the home page
 
 export type PostHomePageBody = HomePageRequest;
 
 export type PostHomePageResponse = HomePageResponse;
 
-export interface PostHomePageRequest extends BaseRequest {
-	body: PostHomePageBody;
+// GET /consumer/frictionless/checkin/{id} - Allow a user to check in to a location using frictionless technology
+
+export interface GetConsumerFrictionlessCheckinPath {
+	id: string;
+}
+
+export interface GetConsumerFrictionlessCheckinQuery {
+	// Graphql query string
+	_query?: string;
+}
+
+export type GetConsumerFrictionlessCheckinResponse = FrictionlessCheckinResponse;
+
+// POST /consumer/frictionless/qrCode - Create a QR code for a frictionless checkin
+
+export type PostFrictionlessQrcodeBody = FrictionlessQrCodeRequest;
+
+export type PostFrictionlessQrcodeResponse = FrictionlessQrCodeResponse;
+
+// POST /consumer/forgotpassword - Forgot password
+
+export type PostConsumerForgotPasswordBody = ForgotPasswordRequest;
+
+export type PostConsumerForgotPasswordResponse = ForgotPasswordResponse;
+
+// POST /consumer/secret - Add user secret
+
+export type PostConsumerAddSecretResponse = AddUserSecretResponse;
+
+// GET /consumer/location-group/{id} - Get location group
+
+export interface GetConsumerLocationGroupPath {
+	// TODO: add parameter to swagger.json
+	id: string;
 }
+
+export interface GetConsumerLocationGroupQuery {
+	// Latitude of the user
+	latitude?: number;
+	// Show disabled marketplace
+	show_disabled_marketplace?: boolean;
+	// Longitude of the user
+	longitude?: number;
+	// Include brands config
+	include_brands_config?: boolean;
+	// Public config only
+	public_config_only?: boolean;
+	// Extended
+	extended?: boolean;
+	// Web
+	web?: boolean;
+	// Non marketplace
+	non_market_places?: boolean;
+	// Non scan go
+	non_scan_go?: boolean;
+	// Include estimated wait time
+	include_estimated_wait_time?: boolean;
+	// Graphql query string
+	_query?: string;
+	// Latitude of the user
+	nocache?: boolean;
+	// Location Group ID as Encoded CDL ID
+	id?: string;
+}
+
+export type GetConsumerLocationGroupResponse$0 = GetConsumerLocationGroupResponse;
+
+// GET /consumer/location-multigroup/{id} - Get location multi group
+
+export interface GetConsumerLocationMultigroupPath {
+	// TODO: add parameter to swagger.json
+	id: string;
+}
+
+export interface GetConsumerLocationMultigroupQuery {
+	// Latitude of the user
+	latitude?: number;
+	// Longitude of the user
+	longitude?: number;
+	// Show disabled marketplace
+	merge?: string;
+	// Include brands config
+	expanded?: boolean;
+	// Extended
+	extended?: boolean;
+	// Public config only
+	hours?: boolean;
+	// Web
+	web?: boolean;
+	// Non marketplace
+	non_market_places?: boolean;
+	// Non scan go
+	non_scan_go?: boolean;
+	// Graphql query string
+	_query?: string;
+	nocache?: boolean;
+	// Location Group ID as Encoded CDL ID
+	id?: string;
+}
+
+export type GetConsumerLocationMultigroupResponse = GetConsumerLocationMultiGroupResponse;
+
+// GET /consumer/active-menus/{stationId} - Get current menu
+
+export interface GetConsumerActiveMenusPath {
+	// TODO: add parameter to swagger.json
+	stationId: string;
+}
+
+export interface GetConsumerActiveMenusQuery {
+	// Station ID as Encoded CDL ID
+	id?: string;
+	// current time in epoch time
+	currentTime: number;
+	// is pickup
+	isPickUp?: boolean;
+	// is drop off
+	isDropOff?: boolean;
+	// Graphql query string
+	_query?: string;
+}
+
+export type GetConsumerActiveMenusResponse = ConsumerGetActiveMenusResponse;
+
+// GET /consumer/menu/{id} - Provide the front end all the data required to render the home page
+
+export interface GetConsumerMenuPath {
+	id: string;
+}
+
+export interface GetConsumerMenuQuery {
+	// Graphql query string
+	_query?: string;
+}
+
+export type GetConsumerMenuResponse$0 = GetConsumerMenuResponse;

package/src/interface/discount.ts

@@ -37,11 +37,12 @@ export interface DiscountMeta {
 }
 
 export interface GetDiscountResponseDTO {
+	// discount id
+	id: string;
 	// user id of discount creator
 	createdBy: string;
 	// user id of most recent update
 	updatedBy: string;
-	id: string;
 	createdAt: string;
 	updatedAt: string;
 	name: string;
@@ -50,6 +51,12 @@ export interface GetDiscountResponseDTO {
 	meta?: DiscountMeta;
 }
 
+export interface BadRequestErrorDTO {
+	message: string;
+	code: number;
+	data: Record<string, any>;
+}
+
 export interface UnauthorizedErrorDTO {
 	message: string;
 	code: number;
@@ -62,12 +69,15 @@ export interface NotFoundErrorDTO {
 	data: Record<string, any>;
 }
 
+export type InternalServerErrorException = Record<string, any>;
+
 export interface DiscountDTO {
+	// discount id
+	id: string;
 	// user id of discount creator
 	createdBy: string;
 	// user id of most recent update
 	updatedBy: string;
-	id: string;
 	createdAt: string;
 	updatedAt: string;
 	name: string;
@@ -80,30 +90,38 @@ export interface GetDiscountsResponseDTO {
 	discounts: DiscountDTO[];
 }
 
-export interface BadRequestErrorDTO {
-	message: string;
-	code: number;
-	data: Record<string, any>;
+export interface DiscountTaxonomy {
+	site?: string[];
+	brand?: string[];
 }
 
 export interface PostDiscountRequestDTO {
 	createdBy: string;
+	updatedBy?: string;
 	name: string;
+	status?: DiscountStatus;
+	is?: DiscountIs;
+	meta?: DiscountMeta;
+	taxonomy?: DiscountTaxonomy;
 }
 
 export interface PostDiscountResponseDTO {
-	createdBy: string;
-	name: string;
 	id: string;
 	createdAt: string;
 	updatedAt: string;
 	updatedBy: string;
+	name: string;
+	status?: DiscountStatus;
+	is?: DiscountIs;
+	meta?: DiscountMeta;
+	taxonomy?: DiscountTaxonomy;
+	createdBy: string;
 }
 
 export interface PutDiscountRequestDTO {
 	// user id of most recent update
 	updatedBy: string;
-	taxonomy?: Record<string, any>;
+	taxonomy?: DiscountTaxonomy;
 	name: string;
 	status?: DiscountStatus;
 	is?: DiscountIs;
@@ -111,11 +129,12 @@ export interface PutDiscountRequestDTO {
 }
 
 export interface PutDiscountResponseDTO {
+	// discount id
+	id: string;
 	// user id of discount creator
 	createdBy: string;
 	// user id of most recent update
 	updatedBy: string;
-	id: string;
 	createdAt: string;
 	updatedAt: string;
 	name: string;
@@ -124,19 +143,18 @@ export interface PutDiscountResponseDTO {
 	meta?: DiscountMeta;
 }
 
-export type InternalServerErrorException = Record<string, any>;
-
 export interface PutDiscountPublishRequestDTO {
 	// user id of most recent update
 	updatedBy: string;
 }
 
 export interface PutDiscountPublishResponseDTO {
+	// discount id
+	id: string;
 	// user id of discount creator
 	createdBy: string;
 	// user id of most recent update
 	updatedBy: string;
-	id: string;
 	createdAt: string;
 	updatedAt: string;
 	name: string;
@@ -152,6 +170,7 @@ export interface DeleteDiscountResponseDTO {
 // GET /discount/{id} - Get a discount
 
 export interface GetDiscountPath {
+	// a discount id
 	id: string;
 }
 
@@ -162,11 +181,6 @@ export interface GetDiscountQuery {
 
 export type GetDiscountResponse = GetDiscountResponseDTO;
 
-export interface GetDiscountRequest
-	extends BaseRequest,
-		RequestQuery<GetDiscountQuery>,
-		GetDiscountPath {}
-
 // PUT /discount/{id} - update a discount
 
 export interface PutDiscountPath {
@@ -178,10 +192,6 @@ export type PutDiscountBody = PutDiscountRequestDTO;
 
 export type PutDiscountResponse = PutDiscountResponseDTO;
 
-export interface PutDiscountRequest extends BaseRequest, PutDiscountPath {
-	body: PutDiscountBody;
-}
-
 // DELETE /discount/{id} - delete a discount
 
 export interface DeleteDiscountPath {
@@ -191,31 +201,22 @@ export interface DeleteDiscountPath {
 
 export type DeleteDiscountResponse = DeleteDiscountResponseDTO;
 
-export interface DeleteDiscountRequest extends BaseRequest, DeleteDiscountPath {}
-
 // GET /discount - Get discounts by taxonomy
 
 export interface GetDiscountsQuery {
 	taxonomyFilter: string;
-	active: boolean;
 	// Graphql query string
 	_query?: string;
 }
 
 export type GetDiscountsResponse = GetDiscountsResponseDTO;
 
-export interface GetDiscountsRequest extends BaseRequest, RequestQuery<GetDiscountsQuery> {}
-
 // POST /discount - Post a discount
 
 export type PostDiscountBody = PostDiscountRequestDTO;
 
 export type PostDiscountResponse = PostDiscountResponseDTO;
 
-export interface PostDiscountRequest extends BaseRequest {
-	body: PostDiscountBody;
-}
-
 // PUT /discount/{id}/publish - update and publish a discount
 
 export interface PutDiscountPublishPath {
@@ -226,7 +227,3 @@ export interface PutDiscountPublishPath {
 export type PutDiscountPublishBody = PutDiscountPublishRequestDTO;
 
 export type PutDiscountPublishResponse = PutDiscountPublishResponseDTO;
-
-export interface PutDiscountPublishRequest extends BaseRequest, PutDiscountPublishPath {
-	body: PutDiscountPublishBody;
-}

package/src/interface/frictionless.ts

@@ -221,21 +221,12 @@ export interface GetFrictionlessBrandFrictionlessStatusQuery {
 
 export type GetFrictionlessBrandFrictionlessStatusResponse = FrictionlessSupportResponseDTO;
 
-export interface GetFrictionlessBrandFrictionlessStatusRequest
-	extends BaseRequest,
-		RequestQuery<GetFrictionlessBrandFrictionlessStatusQuery>,
-		GetFrictionlessBrandFrictionlessStatusPath {}
-
 // POST /frictionless/qrcode - Create Frictionless QR Code to make user able to check in
 
 export type PostFrictionlessQrCodeBody = CreateFrictionlessQRCodeCommandDTO;
 
 export type PostFrictionlessQrCodeResponse = QRCodeCreationResponseDTO;
 
-export interface PostFrictionlessQrCodeRequest extends BaseRequest {
-	body: PostFrictionlessQrCodeBody;
-}
-
 // GET /frictionless/checkin/{id_checkin}/status - Fetch CheckIn Status
 
 export interface GetFrictionlessCheckinStatusPath {
@@ -249,11 +240,6 @@ export interface GetFrictionlessCheckinStatusQuery {
 
 export type GetFrictionlessCheckinStatusResponse = GetCheckInStatusResponseDTO;
 
-export interface GetFrictionlessCheckinStatusRequest
-	extends BaseRequest,
-		RequestQuery<GetFrictionlessCheckinStatusQuery>,
-		GetFrictionlessCheckinStatusPath {}
-
 // GET /frictionless/checkin/{id_checkin} - Fetch CheckIn
 
 export interface GetFrictionlessCheckinPath {
@@ -267,11 +253,6 @@ export interface GetFrictionlessCheckinQuery {
 
 export type GetFrictionlessCheckinResponse = GetCheckinResponseDTO;
 
-export interface GetFrictionlessCheckinRequest
-	extends BaseRequest,
-		RequestQuery<GetFrictionlessCheckinQuery>,
-		GetFrictionlessCheckinPath {}
-
 // GET /frictionless/users/{user_id}/checkins/payment-issues - List check-ins with update payment required per user
 
 export interface GetFrictionlessUsersPaymentIssuesPath {
@@ -285,11 +266,6 @@ export interface GetFrictionlessUsersPaymentIssuesQuery {
 
 export type GetFrictionlessUsersPaymentIssuesResponse = CheckInPaymentRequiredDTO[];
 
-export interface GetFrictionlessUsersPaymentIssuesRequest
-	extends BaseRequest,
-		RequestQuery<GetFrictionlessUsersPaymentIssuesQuery>,
-		GetFrictionlessUsersPaymentIssuesPath {}
-
 // GET /frictionless/failed-checkins - List check-ins on error
 
 export interface GetFrictionlessFailedCheckinsQuery {
@@ -299,10 +275,6 @@ export interface GetFrictionlessFailedCheckinsQuery {
 
 export type GetFrictionlessFailedCheckinsResponse = FailedCheckInDTO[];
 
-export interface GetFrictionlessFailedCheckinsRequest
-	extends BaseRequest,
-		RequestQuery<GetFrictionlessFailedCheckinsQuery> {}
-
 // POST /frictionless/checkins/{id_checkin}/reprocess - Reprocess checkin on error
 
 export interface PostFrictionlessCheckinsReprocessPath {
@@ -311,10 +283,6 @@ export interface PostFrictionlessCheckinsReprocessPath {
 
 export type PostFrictionlessCheckinsReprocessResponse = {};
 
-export interface PostFrictionlessCheckinsReprocessRequest
-	extends BaseRequest,
-		PostFrictionlessCheckinsReprocessPath {}
-
 // POST /frictionless/checkins/{checkin_id}/reprocess-payment - Update payment at checkin and trigger reprocessing
 
 export interface PostFrictionlessCheckinReprocessPaymentPath {
@@ -325,12 +293,6 @@ export type PostFrictionlessCheckinReprocessPaymentBody = PaymentMethodDTO;
 
 export type PostFrictionlessCheckinReprocessPaymentResponse = {};
 
-export interface PostFrictionlessCheckinReprocessPaymentRequest
-	extends BaseRequest,
-		PostFrictionlessCheckinReprocessPaymentPath {
-	body: PostFrictionlessCheckinReprocessPaymentBody;
-}
-
 // POST /frictionless/amazon-jwo-connector/v1/identity/identity-keys - Amazon JWO Identity Key Connector
 
 export type PostFrictionlessAmazonJwoConnectorV1IdentityIdentityKeysBody =
@@ -339,18 +301,9 @@ export type PostFrictionlessAmazonJwoConnectorV1IdentityIdentityKeysBody =
 export type PostFrictionlessAmazonJwoConnectorV1IdentityIdentityKeysResponse =
 	AmazonJWOIdentityKeysResponseDTO;
 
-export interface PostFrictionlessAmazonJwoConnectorV1IdentityIdentityKeysRequest
-	extends BaseRequest {
-	body: PostFrictionlessAmazonJwoConnectorV1IdentityIdentityKeysBody;
-}
-
 // POST /frictionless/amazon-jwo-connector/v1/order/purchases - Amazon JWO Ordering Connector
 
 export type PostFrictionlessAmazonJwoConnectorV1OrderPurchasesBody = AmazonJWOOrderingRequestDTO;
 
 export type PostFrictionlessAmazonJwoConnectorV1OrderPurchasesResponse =
 	AmazonJWOOrderingResponseDTO;
-
-export interface PostFrictionlessAmazonJwoConnectorV1OrderPurchasesRequest extends BaseRequest {
-	body: PostFrictionlessAmazonJwoConnectorV1OrderPurchasesBody;
-}