@compassdigital/sdk.typescript 4.101.0 → 4.103.0

package/src/interface/discount.ts

@@ -0,0 +1,249 @@
+/* eslint-disable */
+// THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
+
+import { RequestQuery, BaseRequest } from './util';
+
+export interface DiscountStatus {
+	live?: boolean;
+	readyToPublish?: boolean;
+}
+
+export interface DiscountIs {
+	badgepayPromo?: boolean;
+	mealplanPromo?: boolean;
+	decliningBalancePromo?: boolean;
+	voucherPromo?: boolean;
+}
+
+export interface PostDiscountRequestDTO {
+	// user is of discount creator
+	createdBy?: string;
+	name?: string;
+	status?: DiscountStatus;
+	is?: DiscountIs;
+	app?: string;
+}
+
+export interface PostDiscountResponseDTO {
+	// user is of discount creator
+	createdBy?: string;
+	id: string;
+	createdAt: string;
+	updatedAt: string;
+	name?: string;
+	status?: DiscountStatus;
+	is?: DiscountIs;
+	app?: string;
+}
+
+export interface BadRequestErrorDTO {
+	message: string;
+	code: number;
+	data: Record<string, any>;
+}
+
+export interface UnauthorizedErrorDTO {
+	message: string;
+	code: number;
+	data: Record<string, any>;
+}
+
+export interface VoucherifyMetaDataDiscount {
+	type: string;
+	amountOff?: number;
+	percentOff?: number;
+}
+
+export interface VoucherifyMetaData {
+	id?: string;
+	code?: string;
+	discount?: VoucherifyMetaDataDiscount;
+}
+
+export interface MetaProvider {
+	voucherify?: VoucherifyMetaData;
+}
+
+export interface DiscountMeta {
+	provider: MetaProvider;
+}
+
+export interface GetDiscountResponseDTO {
+	// user is of discount creator
+	createdBy?: string;
+	id: string;
+	createdAt: string;
+	updatedAt: string;
+	name?: string;
+	status?: DiscountStatus;
+	is?: DiscountIs;
+	app?: string;
+	meta?: DiscountMeta;
+}
+
+export interface NotFoundErrorDTO {
+	message: string;
+	code: number;
+	data: Record<string, any>;
+}
+
+export interface DiscountDTO {
+	// user is of discount creator
+	createdBy?: string;
+	id: string;
+	createdAt: string;
+	updatedAt: string;
+	name?: string;
+	status?: DiscountStatus;
+	is?: DiscountIs;
+	app?: string;
+	meta?: DiscountMeta;
+}
+
+export interface GetDiscountsResponseDTO {
+	discounts: DiscountDTO[];
+}
+
+export interface PutDiscountRequestDTO {
+	taxonomy?: Record<string, any>;
+	id: string;
+	name?: string;
+	status?: DiscountStatus;
+	is?: DiscountIs;
+	app?: string;
+	meta?: DiscountMeta;
+}
+
+export interface PutDiscountResponseDTO {
+	// user is of discount creator
+	createdBy?: string;
+	id: string;
+	createdAt: string;
+	updatedAt: string;
+	name?: string;
+	status?: DiscountStatus;
+	is?: DiscountIs;
+	app?: string;
+	meta?: DiscountMeta;
+}
+
+export type InternalServerErrorException = Record<string, any>;
+
+export interface PutDiscountPublishRequestDTO {
+	taxonomy?: Record<string, any>;
+	id: string;
+	name?: string;
+	status?: DiscountStatus;
+	is?: DiscountIs;
+	app?: string;
+	meta?: DiscountMeta;
+}
+
+export interface PutDiscountPublishResponseDTO {
+	// user is of discount creator
+	createdBy?: string;
+	id: string;
+	createdAt: string;
+	updatedAt: string;
+	name?: string;
+	status?: DiscountStatus;
+	is?: DiscountIs;
+	app?: string;
+	meta?: DiscountMeta;
+}
+
+export interface DeleteDiscountRequestDTO {
+	id: string;
+	meta?: DiscountMeta;
+	app?: string;
+}
+
+export interface DeleteDiscountResponseDTO {
+	success: boolean;
+}
+
+// POST /discount - Post a discount
+
+export type PostDiscountBody = PostDiscountRequestDTO;
+
+export type PostDiscountResponse = PostDiscountResponseDTO;
+
+export interface PostDiscountRequest extends BaseRequest {
+	body: PostDiscountBody;
+}
+
+// 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> {}
+
+// GET /discount/{id} - Get a discount
+
+export interface GetDiscountPath {
+	id: string;
+}
+
+export interface GetDiscountQuery {
+	// Graphql query string
+	_query?: string;
+}
+
+export type GetDiscountResponse = GetDiscountResponseDTO;
+
+export interface GetDiscountRequest
+	extends BaseRequest,
+		RequestQuery<GetDiscountQuery>,
+		GetDiscountPath {}
+
+// PUT /discount/{id} - update a discount
+
+export interface PutDiscountPath {
+	// Discount id
+	id: string;
+}
+
+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 {
+	// Discount id
+	id: string;
+}
+
+export type DeleteDiscountBody = DeleteDiscountRequestDTO;
+
+export type DeleteDiscountResponse = DeleteDiscountResponseDTO;
+
+export interface DeleteDiscountRequest extends BaseRequest, DeleteDiscountPath {
+	body: DeleteDiscountBody;
+}
+
+// PUT /discount/{id}/publish - update and publish a discount
+
+export interface PutDiscountPublishPath {
+	// Discount id
+	id: string;
+}
+
+export type PutDiscountPublishBody = PutDiscountPublishRequestDTO;
+
+export type PutDiscountPublishResponse = PutDiscountPublishResponseDTO;
+
+export interface PutDiscountPublishRequest extends BaseRequest, PutDiscountPublishPath {
+	body: PutDiscountPublishBody;
+}

package/src/interface/frictionless.ts

@@ -157,15 +157,7 @@ export interface AmazonJWOIdentityKeysRequestDTO {
 	storeId: string;
 }
 
-export interface VisitorDetailsDTO {
-	// The unique identifier for this visitor on AWS System. Coincides with our Checkin ID
-	id: string;
-	type: 'SHOPPER' | 'ASSOCIATE' | 'CASH_SHOPPER';
-}
-
-export interface AmazonJWOIdentityKeysResponseDTO {
-	visitorDetails: VisitorDetailsDTO;
-}
+export type AmazonJWOIdentityKeysResponseDTO = Record<string, any>;
 
 export interface BadRequestErrorDTO {
 	message: string;
@@ -192,7 +184,7 @@ export interface CartItemDTO {
 	// Contain a unique identifier for the item in the cart. This identifier will be an SKU for Compass
 	id: string;
 	// Contains the type of unique identifier the store uses to identify each item in the cart. This field will be always SKU for Compass
-	type: 'SKU';
+	type: string;
 	quantity: QuantityDTO;
 }
 
@@ -213,9 +205,7 @@ export interface AmazonJWOOrderingRequestDTO {
 	shopperIdentity: ShopperIdentity;
 }
 
-export interface AmazonJWOOrderingResponseDTO {
-	purchaseId: string;
-}
+export type AmazonJWOOrderingResponseDTO = Record<string, any>;
 
 // GET /frictionless/brand/{id_brand}/frictionless-status - Check frictionless support of a given brand
 

package/src/interface/location.ts

@@ -198,9 +198,11 @@ export interface Brand {
 			jwo?: string;
 			time2eat?: {
 				enabled?: boolean;
+				use_timeslots?: boolean;
 			};
 			nextep?: {
 				mobile_app?: boolean;
+				web?: boolean;
 			};
 		};
 		type_of_kds?: {