@compassdigital/sdk.typescript 4.138.0 → 4.140.0

package/src/interface/catalog.ts

@@ -0,0 +1,325 @@
+/* eslint-disable */
+// THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
+
+import { RequestQuery, BaseRequest } from './util';
+
+export interface CatalogResponseDTO {
+	id: number;
+	parent_id: number | null;
+	name: string;
+	display: Record<string, any>;
+	meta: Record<string, any> | null;
+	items: Record<string, any> | null;
+}
+
+export type CatalogItemResponseDTO = Record<string, any>;
+
+export interface PaginationQueryDTO {
+	// Page number
+	page?: number;
+	// Number of items per page
+	limit?: number;
+	// Field to sort by
+	sort_by?: string;
+	// Sort order
+	order?: 'ASC' | 'DESC';
+}
+
+export type FilterQueryDTO = Record<string, any>;
+
+export interface ListParamsDTO {
+	pagination?: PaginationQueryDTO;
+	filter?: FilterQueryDTO;
+}
+
+export type CatalogItemsListResponseDTO = Record<string, any>;
+
+export interface SearchConditionDTO {
+	// Contains search term
+	contains?: string;
+	// Exact match
+	equals?: Record<string, any>;
+	// Value greater than this
+	moreThan?: Record<string, any>;
+	// Value less than this
+	lessThan?: Record<string, any>;
+	// Negate condition (e.g., not equal). Accepts: `true` (boolean), `{ equals: 5 }` (object), `"sample string"` (string), or `123` (number).
+	not?: Record<string, any>;
+	// In the list of values
+	in?: string[];
+	// Array contains these values
+	arrayContains?: string[];
+	// Value greater than or equal to this
+	moreThanOrEqual?: Record<string, any>;
+	// Value less than or equal to this
+	lessThanOrEqual?: Record<string, any>;
+}
+
+export type BaseItemDTO = Record<string, any>;
+
+// GET /catalog/status - Get the status of the Catalog service
+
+export interface GetCatalogStatusQuery {
+	// Graphql query string
+	_query?: string;
+}
+
+export type GetCatalogStatusResponse = {};
+
+export interface GetCatalogStatusRequest extends BaseRequest, RequestQuery<GetCatalogStatusQuery> {}
+
+// GET /catalog/status/connections - Get the status of Catalog database connections
+
+export interface GetCatalogConnectionsStatusQuery {
+	// Graphql query string
+	_query?: string;
+}
+
+export type GetCatalogConnectionsStatusResponse = {};
+
+export interface GetCatalogConnectionsStatusRequest
+	extends BaseRequest,
+		RequestQuery<GetCatalogConnectionsStatusQuery> {}
+
+// POST /catalog/v1/catalog - Create a new catalog
+
+export interface PostCatalogBody {
+	name?: string;
+	display?: Record<string, any>;
+	parent_id?: number | null;
+	meta?: Record<string, any>;
+}
+
+export type PostCatalogResponse = CatalogResponseDTO;
+
+export interface PostCatalogRequest extends BaseRequest {
+	body: PostCatalogBody;
+}
+
+// PATCH /catalog/v1/catalog/{id} - Update a catalog
+
+export interface PatchCatalogPath {
+	id: number;
+}
+
+export interface PatchCatalogBody {
+	name?: string | null;
+	display?: Record<string, any> | null;
+	parent_id?: number | null;
+	meta?: Record<string, any> | null;
+}
+
+export type PatchCatalogResponse = CatalogResponseDTO;
+
+export interface PatchCatalogRequest extends BaseRequest, PatchCatalogPath {
+	body: PatchCatalogBody;
+}
+
+// GET /catalog/v1/catalog/{id} - Get a catalog
+
+export interface GetCatalogPath {
+	id: number;
+}
+
+export interface GetCatalogQuery {
+	// Graphql query string
+	_query?: string;
+}
+
+export type GetCatalogResponse = CatalogResponseDTO;
+
+export interface GetCatalogRequest
+	extends BaseRequest,
+		RequestQuery<GetCatalogQuery>,
+		GetCatalogPath {}
+
+// DELETE /catalog/v1/catalog/{id} - Delete a catalog
+
+export interface DeleteCatalogPath {
+	id: number;
+}
+
+export type DeleteCatalogResponse = CatalogResponseDTO;
+
+export interface DeleteCatalogRequest extends BaseRequest, DeleteCatalogPath {}
+
+// POST /catalog/v1/catalog/{id}/item - Create a new catalog item
+
+export interface PostCatalogItemPath {
+	id: number;
+}
+
+export interface PostCatalogItemBody {
+	base_item_id?: string;
+	name?: string;
+	catalog_item_id?: number | null;
+	label?: string | null;
+	description?: string | null;
+	price?: number | null;
+	overrides?: Record<string, any> | null;
+	options?: Record<string, any> | null;
+	meta?: Record<string, any> | null;
+	is_visible?: boolean | null;
+	is_out_of_stock?: boolean | null;
+}
+
+export type PostCatalogItemResponse = CatalogItemResponseDTO;
+
+export interface PostCatalogItemRequest extends BaseRequest, PostCatalogItemPath {
+	body: PostCatalogItemBody;
+}
+
+// POST /catalog/v1/catalog/{id}/items/bulk - Bulk create catalog items
+
+export interface PostCatalogItemsBulkPath {
+	id: number;
+}
+
+export type PostCatalogItemsBulkBody = string[];
+
+export type PostCatalogItemsBulkResponse = CatalogItemResponseDTO[];
+
+export interface PostCatalogItemsBulkRequest extends BaseRequest, PostCatalogItemsBulkPath {
+	body: PostCatalogItemsBulkBody;
+}
+
+// PATCH /catalog/v1/catalog/{catalog_id}/item/{id} - Update a catalog item
+
+export interface PatchCatalogItemPath {
+	catalog_id: number;
+	id: number;
+}
+
+export interface PatchCatalogItemBody {
+	base_item_id?: string;
+	name?: string | null;
+	label?: string | null;
+	description?: string | null;
+	price?: number | null;
+	overrides?: Record<string, any> | null;
+	options?: Record<string, any> | null;
+	meta?: Record<string, any> | null;
+	is_visible?: boolean | null;
+	is_out_of_stock?: boolean | null;
+}
+
+export type PatchCatalogItemResponse = CatalogItemResponseDTO;
+
+export interface PatchCatalogItemRequest extends BaseRequest, PatchCatalogItemPath {
+	body: PatchCatalogItemBody;
+}
+
+// DELETE /catalog/v1/catalog/{catalog_id}/item/{id} - Delete a catalog item
+
+export interface DeleteCatalogItemPath {
+	catalog_id: number;
+	id: number;
+}
+
+export type DeleteCatalogItemResponse = CatalogItemResponseDTO;
+
+export interface DeleteCatalogItemRequest extends BaseRequest, DeleteCatalogItemPath {}
+
+// POST /catalog/v1/catalog/{id}/items - List catalog items
+
+export interface PostListCatalogItemsPath {
+	id: number;
+}
+
+export type PostListCatalogItemsBody = ListParamsDTO;
+
+export type PostListCatalogItemsResponse = CatalogItemsListResponseDTO;
+
+export interface PostListCatalogItemsRequest extends BaseRequest, PostListCatalogItemsPath {
+	body: PostListCatalogItemsBody;
+}
+
+// GET /catalog/v1/catalog/{id}/items - List catalog items
+
+export interface GetListCatalogItemsPath {
+	id: number;
+}
+
+export interface GetListCatalogItemsQuery {
+	page: number;
+	limit: number;
+	sort_by: string;
+	order: string;
+	filter: FilterQueryDTO;
+	// Graphql query string
+	_query?: string;
+}
+
+export type GetListCatalogItemsResponse = CatalogItemsListResponseDTO;
+
+export interface GetListCatalogItemsRequest
+	extends BaseRequest,
+		RequestQuery<GetListCatalogItemsQuery>,
+		GetListCatalogItemsPath {}
+
+// POST /catalog/v1/catalog/{id}/clone - Clone a catalog
+
+export interface PostCloneCatalogPath {
+	id: number;
+}
+
+export type PostCloneCatalogResponse = CatalogResponseDTO;
+
+export interface PostCloneCatalogRequest extends BaseRequest, PostCloneCatalogPath {}
+
+// POST /catalog/v1/base-item - Create a new base item
+
+export interface PostCatalogBaseItemBody {
+	name?: string;
+	description?: string | null;
+	price?: number | null;
+	barcode?: string | null;
+	reporting?: Record<string, any> | null;
+	tax?: Record<string, any> | null;
+	meta?: Record<string, any> | null;
+}
+
+export type PostCatalogBaseItemResponse = BaseItemDTO;
+
+export interface PostCatalogBaseItemRequest extends BaseRequest {
+	body: PostCatalogBaseItemBody;
+}
+
+// GET /catalog/v1/base-item - List base items
+
+export interface GetCatalogBaseItemsQuery {
+	// Graphql query string
+	_query?: string;
+}
+
+export interface GetCatalogBaseItemsBody {
+	search?: string | null;
+	limit?: number;
+	offset?: number;
+}
+
+export type GetCatalogBaseItemsResponse = BaseItemDTO[];
+
+export interface GetCatalogBaseItemsRequest
+	extends BaseRequest,
+		RequestQuery<GetCatalogBaseItemsQuery> {
+	body: GetCatalogBaseItemsBody;
+}
+
+// GET /catalog/v1/base-item/{id} - Get a base item by id
+
+export interface GetCatalogBaseItemPath {
+	id: string;
+}
+
+export interface GetCatalogBaseItemQuery {
+	// Graphql query string
+	_query?: string;
+}
+
+export type GetCatalogBaseItemResponse = BaseItemDTO;
+
+export interface GetCatalogBaseItemRequest
+	extends BaseRequest,
+		RequestQuery<GetCatalogBaseItemQuery>,
+		GetCatalogBaseItemPath {}

package/src/interface/consumer.ts

@@ -540,6 +540,59 @@ export interface ShoppingcartPromoDetails {
 	order?: ShoppingcartPromoOrder;
 }
 
+export interface ConsumerDiscountStatus {
+	live?: boolean;
+	publishedTo3rdParty?: boolean;
+	readyToPublish?: boolean;
+	active?: boolean;
+}
+
+export interface ConsumerDiscountIs {
+	badgepayPromo?: boolean;
+	mealplanPromo?: boolean;
+	decliningBalancePromo?: boolean;
+	voucherPromo?: boolean;
+}
+
+export interface ConsumerVoucherifyMetaDataDiscount {
+	type: Record<string, any>;
+	amountOff?: number;
+	percentOff?: number;
+}
+
+export interface ConsumerVoucherifyMetaData {
+	id?: string;
+	code?: string;
+	discount?: ConsumerVoucherifyMetaDataDiscount;
+}
+
+export interface ClassMetaProvider {
+	voucherify?: ConsumerVoucherifyMetaData;
+}
+
+export interface ConsumerDiscountMeta {
+	provider: ClassMetaProvider;
+}
+
+export interface ConsumerStackedDiscount {
+	id: string;
+	createdBy: string;
+	updatedBy: string;
+	createdAt: string;
+	updatedAt: string;
+	name: string;
+	status?: ConsumerDiscountStatus;
+	is?: ConsumerDiscountIs;
+	meta?: ConsumerDiscountMeta;
+	applied_amount?: number;
+}
+
+export interface Discounts {
+	applied_amount?: number;
+	app?: string;
+	stacked_discounts?: ConsumerStackedDiscount[];
+}
+
 export interface ShoppingcartPaymentMethodMealplan {
 	id?: string;
 	tender?: string;
@@ -699,6 +752,7 @@ export interface CustomerOrderShoppingcartDTO {
 	sub_total?: ShoppingcartMonetaryValue;
 	promo?: ShoppingcartPromoDetails;
 	discount?: ShoppingcartPromoDetails;
+	discounts?: Discounts;
 	payment_method?: ShoppingcartPaymentMethod;
 	taxes?: ShoppingcartTaxes;
 	total?: ShoppingcartTotal;
@@ -1720,7 +1774,7 @@ export interface PostConsumerRecommendedRequest {
 
 export interface PostConsumerRecommendedResponse {
 	// items
-	items: string[];
+	items: ConsumerItem[];
 }
 
 export interface PostConsumerShoppingCartBodyRequest {

package/src/interface/menu.ts

@@ -8368,6 +8368,7 @@ export interface GetMenuV4ItemPath {
 }
 
 export interface GetMenuV4ItemQuery {
+	with_parent?: boolean;
 	// Graphql query string
 	_query?: string;
 }
@@ -8397,6 +8398,7 @@ export interface GetMenuV4ItemResponse {
 	is_active?: boolean;
 	posid?: string;
 	tax_tags?: string[];
+	brand_id: string;
 	line_route?: string;
 	posid_segment?: number;
 	menu_works?: MenuWorksDTO;
@@ -8918,6 +8920,7 @@ export interface GetMenuV4ModifierPath {
 }
 
 export interface GetMenuV4ModifierQuery {
+	with_parent?: boolean;
 	// Graphql query string
 	_query?: string;
 }
@@ -8943,6 +8946,7 @@ export interface GetMenuV4ModifierResponse {
 	posid?: string;
 	reporting: ReportingMetadataDTO;
 	posid_segment?: number;
+	brand_id: string;
 	line_route?: string;
 	menu_works?: MenuWorksDTO;
 	is_out_of_stock?: boolean;
@@ -9356,6 +9360,7 @@ export interface GetMenuV4ModifierGroupPath {
 }
 
 export interface GetMenuV4ModifierGroupQuery {
+	with_parent?: boolean;
 	// Graphql query string
 	_query?: string;
 }
@@ -9376,6 +9381,7 @@ export interface GetMenuV4ModifierGroupResponse {
 	max?: number;
 	is_active?: boolean;
 	limit?: number;
+	brand_id: string;
 	order_type?: 'selection' | 'option' | 'quantity';
 	sizing?: string;
 	is_out_of_stock?: boolean;
@@ -9880,6 +9886,89 @@ export interface PostMenuV4UnscheduleMenuRequest extends BaseRequest {
 	body: PostMenuV4UnscheduleMenuBody;
 }
 
+// GET /menu/v4/menu/{id}
+
+export interface GetMenuV4MenuPath {
+	id: string;
+}
+
+export interface GetMenuV4MenuQuery {
+	with_parent?: boolean;
+	// Graphql query string
+	_query?: string;
+}
+
+export interface GetMenuV4MenuResponse {
+	parent?: DraftMenuDTO;
+	children?: DraftMenuDTO[];
+	categories?: DraftCategoryDTO[];
+	stocks?: StockDTO[];
+	station_id?: string;
+	price_level_id?: string;
+	id: string;
+	created_at?: string;
+	updated_at?: string;
+	deleted_at?: string;
+	parent_id?: string;
+	name: string;
+	brand_id?: string;
+	applied_diff_snapshot?: Record<string, any>;
+	version?: number;
+	brand?: DraftBrandDTO;
+	changes?: MenuChangeDTO[];
+	vendor_metadata?: VendorMetadataDTO[];
+	permissions?: Record<string, any>;
+	[index: string]: any;
+}
+
+export interface GetMenuV4MenuRequest
+	extends BaseRequest,
+		RequestQuery<GetMenuV4MenuQuery>,
+		GetMenuV4MenuPath {}
+
+// GET /menu/v4/category/{id}
+
+export interface GetMenuV4CategoryPath {
+	id: string;
+}
+
+export interface GetMenuV4CategoryQuery {
+	with_parent?: boolean;
+	// Graphql query string
+	_query?: string;
+}
+
+export interface GetMenuV4CategoryResponse {
+	parent?: DraftCategoryDTO;
+	children?: DraftCategoryDTO[];
+	id: string;
+	created_at?: string;
+	updated_at?: string;
+	deleted_at?: string;
+	parent_id?: string;
+	name: string;
+	label?: string;
+	sequence?: number;
+	is_active?: boolean;
+	brand_id?: string;
+	menu_id: string;
+	applied_diff_snapshot?: Record<string, any>;
+	version?: number;
+	menu?: DraftMenuDTO;
+	items?: DraftCategoryToItemRelationshipDTO[];
+	brand?: DraftBrandDTO;
+	changes?: CategoryChangeDTO[];
+	vendor_metadata?: VendorMetadataDTO[];
+	attachments?: FileAttachmentsDTO;
+	permissions?: Record<string, any>;
+	[index: string]: any;
+}
+
+export interface GetMenuV4CategoryRequest
+	extends BaseRequest,
+		RequestQuery<GetMenuV4CategoryQuery>,
+		GetMenuV4CategoryPath {}
+
 // POST /menu/v4/category/{id}/attachment/{name}
 
 export interface PostMenuV4CategoryAttachmentPath {

package/src/interface/order.ts

@@ -199,6 +199,36 @@ export interface Order {
 			code?: string;
 			[index: string]: any;
 		};
+		discounts?: OrderDiscount[];
+		// Discounts for refunds
+		discounts_refund?: {
+			// Client app that applied the discount
+			app?: string;
+			// Date the discount was refunded
+			date?: string;
+			// Date the order was created
+			order_created_at?: string;
+			// Vocuherify Order ID
+			order_id?: string;
+			// Order items
+			order_items?: {
+				// Compassdigital item id
+				source_id?: string;
+				// Quantity of the item
+				quantity?: number;
+				// Price of the item in cents
+				price?: number;
+			}[];
+			// Order total
+			order_total?: number;
+			// Reason for refund
+			reason?: string;
+			// Voucherify parent redemption id for the stacked discounts
+			redemption_id?: string;
+			// true if refund succeeded
+			result?: boolean;
+			[index: string]: any;
+		};
 		// The type of kds that the brand uses
 		type_of_kds?: string;
 		// Indicate whether the order is eligible for cancellation
@@ -390,6 +420,28 @@ export interface ApexCodes {
 	reclaim_code: ApexCodeProperties;
 }
 
+export interface OrderDiscount {
+	// Voucherify redemption id
+	id?: string;
+	date?: string;
+	// true if redemption succeeded
+	result?: boolean;
+	discount?: {
+		// amount_off | percent_off
+		type?: string;
+		amount_off?: number;
+		// Percentage off
+		percent_off?: number;
+	};
+	// redemption
+	type?: string;
+	// Parent redemption id for refunds
+	original_redemption?: string;
+	// Client app that applied the discount
+	app?: string;
+	[index: string]: any;
+}
+
 // POST /order - Create an Order
 
 export interface PostOrderQuery {

package/src/interface/promo.ts

@@ -236,7 +236,7 @@ export interface Voucher {
 }
 
 export interface Redeemable {
-	status: 'APPLICABLE' | 'INAPPLICABLE';
+	status: string;
 	// redeemable
 	id: string;
 	object: 'voucher' | 'promotion_stack' | 'promotion_tier';

package/src/interface/shoppingcart.ts

@@ -269,6 +269,11 @@ export interface ShoppingCartRequest {
 	brand?: string;
 	promo?: PromoDetails;
 	discount?: PromoDetails;
+	discounts?: {
+		stacked_total?: MonetaryValue;
+		stacked_discounts?: Discount[];
+		app?: string;
+	};
 	payment_method?: PaymentMethod;
 	taxes?: Taxes;
 	exemptions?: {

package/src/messages/commands/SendPushNotificationCommand.ts

@@ -4,7 +4,7 @@ export interface SendPushNotificationCommand {
 	id: string;
 	type: 'SendPushNotificationCommand';
 	version: '0.0.1';
-	emittedAt: string;
+	timestamp: string;
 	traceContext: {
 		traceId?: string;
 	};
@@ -18,4 +18,5 @@ export interface SendPushNotificationCommand {
 			data?: Record<string, any>;
 		};
 	};
+	source: string;
 }