@compassdigital/sdk.typescript 4.112.0 → 4.114.0

package/src/interface/menu.ts

@@ -443,6 +443,7 @@ export interface DraftBrandDTO {
 	global_menu_group_id?: string;
 	posid_segment?: string;
 	is_simplified_view?: boolean;
+	auto_push_to_local?: boolean;
 	frictionless_partner?: string;
 	meta?: BrandMeta;
 	applied_diff_snapshot?: Record<string, any>;
@@ -466,6 +467,7 @@ export interface PublishedBrandDTO {
 	global_menu_group_id?: string;
 	posid_segment?: string;
 	is_simplified_view?: boolean;
+	auto_push_to_local?: boolean;
 	frictionless_partner?: string;
 	meta?: Record<string, any>;
 	permissions?: Record<string, any>;
@@ -2942,6 +2944,7 @@ export interface PostMenuV3DraftBrandBody {
 	global_menu_group_id?: string;
 	posid_segment?: string;
 	is_simplified_view?: boolean;
+	auto_push_to_local?: boolean;
 	frictionless_partner?: string;
 	meta?: BrandMeta;
 	applied_diff_snapshot?: Record<string, any>;
@@ -3014,6 +3017,7 @@ export interface PatchMenuV3DraftBrandBody {
 	global_menu_group_id?: string;
 	posid_segment?: string;
 	is_simplified_view?: boolean;
+	auto_push_to_local?: boolean;
 	frictionless_partner?: string;
 	meta?: BrandMeta;
 	applied_diff_snapshot?: Record<string, any>;
@@ -3108,6 +3112,7 @@ export type PostMenuV3DraftBrandsBody = {
 	global_menu_group_id?: string;
 	posid_segment?: string;
 	is_simplified_view?: boolean;
+	auto_push_to_local?: boolean;
 	frictionless_partner?: string;
 	meta?: BrandMeta;
 	applied_diff_snapshot?: Record<string, any>;
@@ -3614,6 +3619,7 @@ export interface PostMenuV3BrandBody {
 	global_menu_group_id?: string;
 	posid_segment?: string;
 	is_simplified_view?: boolean;
+	auto_push_to_local?: boolean;
 	frictionless_partner?: string;
 	meta?: BrandMeta;
 	local_menu_group?: LocalMenuGroupDTO;
@@ -3684,6 +3690,7 @@ export interface PatchMenuV3BrandBody {
 	global_menu_group_id?: string;
 	posid_segment?: string;
 	is_simplified_view?: boolean;
+	auto_push_to_local?: boolean;
 	frictionless_partner?: string;
 	meta?: BrandMeta;
 	version?: number;
@@ -3778,6 +3785,7 @@ export type PostMenuV3BrandsBody = {
 	global_menu_group_id?: string;
 	posid_segment?: string;
 	is_simplified_view?: boolean;
+	auto_push_to_local?: boolean;
 	frictionless_partner?: string;
 	meta?: BrandMeta;
 	local_menu_group?: LocalMenuGroupDTO;
@@ -7236,6 +7244,7 @@ export interface PostMenuV4BrandBody {
 	global_menu_group_id?: string;
 	posid_segment?: string;
 	is_simplified_view?: boolean;
+	auto_push_to_local?: boolean;
 	frictionless_partner?: string;
 	meta?: BrandMeta;
 	applied_diff_snapshot?: Record<string, any>;
@@ -7277,6 +7286,7 @@ export interface PostMenuV4BrandResponse {
 	global_menu_group_id?: string;
 	posid_segment?: string;
 	is_simplified_view?: boolean;
+	auto_push_to_local?: boolean;
 	frictionless_partner?: string;
 	meta?: BrandMeta;
 	applied_diff_snapshot?: Record<string, any>;
@@ -7335,6 +7345,7 @@ export interface GetMenuV4BrandResponse {
 	global_menu_group_id?: string;
 	posid_segment?: string;
 	is_simplified_view?: boolean;
+	auto_push_to_local?: boolean;
 	frictionless_partner?: string;
 	meta?: BrandMeta;
 	applied_diff_snapshot?: Record<string, any>;
@@ -7388,6 +7399,7 @@ export interface DeleteMenuV4BrandResponse {
 	global_menu_group_id?: string;
 	posid_segment?: string;
 	is_simplified_view?: boolean;
+	auto_push_to_local?: boolean;
 	frictionless_partner?: string;
 	meta?: BrandMeta;
 	applied_diff_snapshot?: Record<string, any>;

package/src/interface/shoppingcart.ts

@@ -326,6 +326,7 @@ export interface ShoppingCartResponse {
 		order_loyalty_points?: boolean;
 	};
 	discount?: PromoDetails;
+	discounts?: Discount[];
 	payment_method?: PaymentMethod;
 	taxes?: Taxes;
 	total?: {
@@ -571,6 +572,45 @@ export interface PromoDetails {
 	order?: PromoOrder;
 }
 
+export interface Discount {
+	id: string;
+	// unix epoch timestamp of discount creation in UTC
+	createdAt: string;
+	// unix epoch timestamp of discount update in UTC
+	updatedAt: string;
+	// id of the user who created the discount
+	createdBy: string;
+	// id of the user who updated the discount most recently
+	updatedBy: string;
+	name: string;
+	is?: {
+		badgepayPromo?: boolean;
+		mealplanPromo?: boolean;
+		decliningBalancePromo?: boolean;
+		voucherPromo?: boolean;
+	};
+	status?: {
+		live?: boolean;
+		publishedTo3rdParty?: boolean;
+		readyToPublish?: boolean;
+	};
+	meta?: {
+		provider: {
+			// Voucherify metadata
+			voucherify?: {
+				id?: string;
+				code?: string;
+				discount?: {
+					type: string;
+					amountOff?: number;
+					percentOff?: number;
+				};
+			};
+		};
+		[index: string]: any;
+	};
+}
+
 // POST /shoppingcart - Create a new ShoppingCart
 
 export interface PostShoppingcartCartQuery {

package/lib/interface/delivery.d.ts

@@ -1,92 +0,0 @@
-import { RequestQuery, BaseRequest } from "./util";
-export interface Error {
-    message?: string;
-    code?: number;
-    data?: Record<string, any>;
-}
-export interface Delivery {
-    id?: string;
-    order_id?: string;
-    date?: {
-        created?: string;
-        modified?: string;
-        confirmed?: string;
-        enroute_loading_area?: string;
-        arriving_loading_area?: string;
-        waiting_loading?: string;
-        loading?: string;
-        enroute_customer?: string;
-        arriving_customer?: string;
-        waiting_customer?: string;
-        unloading?: string;
-        completed?: string;
-        cancelled?: string;
-        customer_no_show?: string;
-        no_show_deadline?: string;
-    };
-    assigned_robot?: {
-        name?: string;
-        heading?: number;
-        arrivedDestinationAt?: string;
-        coordinates?: {
-            lat?: number;
-            lng?: number;
-        };
-    };
-    drop_off_location?: {
-        id?: string;
-        starship_id?: string;
-        name?: string;
-        coordinates?: {
-            lat?: number;
-            lng?: number;
-        };
-    };
-    eta?: {
-        loadingAt?: string;
-        destinationAt?: string;
-    };
-    customer?: string;
-    loading_code?: string;
-    state?: "RESERVED" | "CONFIRMED" | "ENROUTE_LOADING_AREA" | "ARRIVING_LOADING_AREA" | "WAITING_LOADING" | "LOADING" | "ENROUTE_CUSTOMER" | "ARRIVING_CUSTOMER" | "WAITING_CUSTOMER" | "UNLOADING" | "COMPLETED" | "CANCELLED" | "CUSTOMER_NO_SHOW";
-    state_reason?: string;
-    tracker_url?: string;
-}
-export interface Available {
-    deliverable: boolean;
-}
-export interface PostAvailabilityBody {
-    destination: {
-        latitude: number;
-        longitude: number;
-    };
-    brand_id: string;
-}
-export interface GetDeliveryOrderPath {
-    id: string;
-    order_id: string;
-}
-export interface GetDeliveryOrderQuery {
-    _query?: string;
-}
-export type GetDeliveryOrderResponse = Delivery;
-export interface GetDeliveryOrderRequest extends BaseRequest, RequestQuery<GetDeliveryOrderQuery>, GetDeliveryOrderPath {
-}
-export interface GetDeliveryPath {
-    id: string;
-}
-export interface GetDeliveryQuery {
-    _query?: string;
-}
-export type GetDeliveryResponse = Delivery;
-export interface GetDeliveryRequest extends BaseRequest, RequestQuery<GetDeliveryQuery>, GetDeliveryPath {
-}
-export interface PostDeliveryAvailabilityPath {
-    id: string;
-}
-export type PostDeliveryAvailabilityBody = PostAvailabilityBody;
-export type PostDeliveryAvailabilityResponse = Available;
-export interface PostDeliveryAvailabilityRequest extends BaseRequest, PostDeliveryAvailabilityPath {
-    body: PostDeliveryAvailabilityBody;
-}
-//# sourceMappingURL=delivery.d.ts.map

package/lib/interface/delivery.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"delivery.d.ts","sourceRoot":"","sources":["../../src/interface/delivery.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,QAAQ,CAAC;AAEnD,MAAM,WAAW,KAAK;IACpB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAC5B;AAED,MAAM,WAAW,QAAQ;IAEvB,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,IAAI,CAAC,EAAE;QACL,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,oBAAoB,CAAC,EAAE,MAAM,CAAC;QAC9B,qBAAqB,CAAC,EAAE,MAAM,CAAC;QAC/B,eAAe,CAAC,EAAE,MAAM,CAAC;QACzB,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,gBAAgB,CAAC,EAAE,MAAM,CAAC;QAC1B,iBAAiB,CAAC,EAAE,MAAM,CAAC;QAC3B,gBAAgB,CAAC,EAAE,MAAM,CAAC;QAC1B,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,gBAAgB,CAAC,EAAE,MAAM,CAAC;QAC1B,gBAAgB,CAAC,EAAE,MAAM,CAAC;KAC3B,CAAC;IACF,cAAc,CAAC,EAAE;QACf,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,oBAAoB,CAAC,EAAE,MAAM,CAAC;QAC9B,WAAW,CAAC,EAAE;YACZ,GAAG,CAAC,EAAE,MAAM,CAAC;YACb,GAAG,CAAC,EAAE,MAAM,CAAC;SACd,CAAC;KACH,CAAC;IACF,iBAAiB,CAAC,EAAE;QAElB,EAAE,CAAC,EAAE,MAAM,CAAC;QAEZ,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,WAAW,CAAC,EAAE;YACZ,GAAG,CAAC,EAAE,MAAM,CAAC;YACb,GAAG,CAAC,EAAE,MAAM,CAAC;SACd,CAAC;KACH,CAAC;IACF,GAAG,CAAC,EAAE;QACJ,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,aAAa,CAAC,EAAE,MAAM,CAAC;KACxB,CAAC;IACF,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,KAAK,CAAC,EACF,UAAU,GACV,WAAW,GACX,sBAAsB,GACtB,uBAAuB,GACvB,iBAAiB,GACjB,SAAS,GACT,kBAAkB,GAClB,mBAAmB,GACnB,kBAAkB,GAClB,WAAW,GACX,WAAW,GACX,WAAW,GACX,kBAAkB,CAAC;IACvB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,SAAS;IACxB,WAAW,EAAE,OAAO,CAAC;CACtB;AAED,MAAM,WAAW,oBAAoB;IACnC,WAAW,EAAE;QACX,QAAQ,EAAE,MAAM,CAAC;QACjB,SAAS,EAAE,MAAM,CAAC;KACnB,CAAC;IACF,QAAQ,EAAE,MAAM,CAAC;CAClB;AAID,MAAM,WAAW,oBAAoB;IAEnC,EAAE,EAAE,MAAM,CAAC;IAEX,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,qBAAqB;IAEpC,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,MAAM,wBAAwB,GAAG,QAAQ,CAAC;AAEhD,MAAM,WAAW,uBACf,SAAQ,WAAW,EACjB,YAAY,CAAC,qBAAqB,CAAC,EACnC,oBAAoB;CAAG;AAI3B,MAAM,WAAW,eAAe;IAE9B,EAAE,EAAE,MAAM,CAAC;CACZ;AAED,MAAM,WAAW,gBAAgB;IAE/B,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,MAAM,mBAAmB,GAAG,QAAQ,CAAC;AAE3C,MAAM,WAAW,kBACf,SAAQ,WAAW,EACjB,YAAY,CAAC,gBAAgB,CAAC,EAC9B,eAAe;CAAG;AAItB,MAAM,WAAW,4BAA4B;IAE3C,EAAE,EAAE,MAAM,CAAC;CACZ;AAED,MAAM,MAAM,4BAA4B,GAAG,oBAAoB,CAAC;AAEhE,MAAM,MAAM,gCAAgC,GAAG,SAAS,CAAC;AAEzD,MAAM,WAAW,+BAAgC,SAAQ,WAAW,EAAE,4BAA4B;IAChG,IAAI,EAAE,4BAA4B,CAAC;CACpC"}

package/lib/interface/delivery.js

@@ -1,5 +0,0 @@
-"use strict";
-/* eslint-disable */
-// THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=delivery.js.map

package/lib/interface/delivery.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"delivery.js","sourceRoot":"","sources":["../../src/interface/delivery.ts"],"names":[],"mappings":";AAAA,oBAAoB;AACpB,sDAAsD"}

package/src/interface/delivery.ts

@@ -1,143 +0,0 @@
-/* eslint-disable */
-// THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
-
-import { RequestQuery, BaseRequest } from "./util";
-
-export interface Error {
-  message?: string;
-  code?: number;
-  data?: Record<string, any>;
-}
-
-export interface Delivery {
-  // starship delivery job
-  id?: string;
-  // order id
-  order_id?: string;
-  date?: {
-    created?: string;
-    modified?: string;
-    confirmed?: string;
-    enroute_loading_area?: string;
-    arriving_loading_area?: string;
-    waiting_loading?: string;
-    loading?: string;
-    enroute_customer?: string;
-    arriving_customer?: string;
-    waiting_customer?: string;
-    unloading?: string;
-    completed?: string;
-    cancelled?: string;
-    customer_no_show?: string;
-    no_show_deadline?: string;
-  };
-  assigned_robot?: {
-    name?: string;
-    heading?: number;
-    arrivedDestinationAt?: string;
-    coordinates?: {
-      lat?: number;
-      lng?: number;
-    };
-  };
-  drop_off_location?: {
-    // drop off location cd id
-    id?: string;
-    // starship delivery location id
-    starship_id?: string;
-    name?: string;
-    coordinates?: {
-      lat?: number;
-      lng?: number;
-    };
-  };
-  eta?: {
-    loadingAt?: string;
-    destinationAt?: string;
-  };
-  customer?: string;
-  loading_code?: string;
-  state?:
-    | "RESERVED"
-    | "CONFIRMED"
-    | "ENROUTE_LOADING_AREA"
-    | "ARRIVING_LOADING_AREA"
-    | "WAITING_LOADING"
-    | "LOADING"
-    | "ENROUTE_CUSTOMER"
-    | "ARRIVING_CUSTOMER"
-    | "WAITING_CUSTOMER"
-    | "UNLOADING"
-    | "COMPLETED"
-    | "CANCELLED"
-    | "CUSTOMER_NO_SHOW";
-  state_reason?: string;
-  tracker_url?: string;
-}
-
-export interface Available {
-  deliverable: boolean;
-}
-
-export interface PostAvailabilityBody {
-  destination: {
-    latitude: number;
-    longitude: number;
-  };
-  brand_id: string;
-}
-
-// GET /delivery/{id}/order/{order_id} - get delivery for order
-
-export interface GetDeliveryOrderPath {
-  // delivery provider id
-  id: string;
-  // order id
-  order_id: string;
-}
-
-export interface GetDeliveryOrderQuery {
-  // Graphql query string
-  _query?: string;
-}
-
-export type GetDeliveryOrderResponse = Delivery;
-
-export interface GetDeliveryOrderRequest
-  extends BaseRequest,
-    RequestQuery<GetDeliveryOrderQuery>,
-    GetDeliveryOrderPath {}
-
-// GET /delivery/{id} - Get all Deliveries for delivery provider
-
-export interface GetDeliveryPath {
-  // delivery provider id
-  id: string;
-}
-
-export interface GetDeliveryQuery {
-  // Graphql query string
-  _query?: string;
-}
-
-export type GetDeliveryResponse = Delivery;
-
-export interface GetDeliveryRequest
-  extends BaseRequest,
-    RequestQuery<GetDeliveryQuery>,
-    GetDeliveryPath {}
-
-// POST /delivery/{id}/availability - Get delivery availability for provided brand and coordinates
-
-export interface PostDeliveryAvailabilityPath {
-  // delivery provider id
-  id: string;
-}
-
-export type PostDeliveryAvailabilityBody = PostAvailabilityBody;
-
-export type PostDeliveryAvailabilityResponse = Available;
-
-export interface PostDeliveryAvailabilityRequest extends BaseRequest, PostDeliveryAvailabilityPath {
-  body: PostDeliveryAvailabilityBody;
-}