@compassdigital/sdk.typescript 4.751.0 → 4.753.0

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@compassdigital/sdk.typescript",
-	"version": "4.751.0",
+	"version": "4.753.0",
 	"description": "Compass Digital Labs TypeScript SDK",
 	"type": "commonjs",
 	"main": "./lib/index.js",

package/src/index.ts

@@ -961,6 +961,7 @@ import {
 	DeleteMenuV4BrandMenuResponse,
 	PatchMenuV4BrandMenusReorderBody,
 	PatchMenuV4BrandMenusReorderResponse,
+	GetMenuV4BrandGenerateBarcodeResponse,
 	GetMenuV4BrandItemsQuery,
 	GetMenuV4BrandItemsResponse,
 	GetMenuV4BrandModifierGroupsQuery,
@@ -1389,6 +1390,7 @@ import {
 	GetYesterdaysSnapshotResponse,
 	GetCentricosStationResponse,
 	DeleteCentricosStationResponse,
+	PutCentricosStationIntegrationBody,
 	PutCentricosStationIntegrationResponse,
 	DeleteCentricosStationIntegrationResponse,
 	PutCentricosDiscountVoucherifyBody,
@@ -11366,6 +11368,26 @@ export class ServiceClient extends BaseServiceClient {
 		);
 	}
 
+	/**
+	 * GET /menu/v4/brand/{id}/generate-barcode
+	 *
+	 * @param id
+	 * @param options - additional request options
+	 */
+	get_menu_v4_brand_generate_barcode(
+		id: string,
+		options?: RequestOptions,
+	): ResponsePromise<GetMenuV4BrandGenerateBarcodeResponse> {
+		return this.request(
+			'menu',
+			'/menu/v4/brand/{id}/generate-barcode',
+			'GET',
+			`/menu/v4/brand/${id}/generate-barcode`,
+			null,
+			options,
+		);
+	}
+
 	/**
 	 * GET /menu/v4/brand/{id}/items
 	 *
@@ -16152,11 +16174,13 @@ export class ServiceClient extends BaseServiceClient {
 	 *
 	 * @param station_id - TODO: cannot use CompassLongID as path parameter
 	 * @param integration_type
+	 * @param body
 	 * @param options - additional request options
 	 */
 	put_centricos_station_integration(
 		station_id: string,
 		integration_type: string,
+		body: PutCentricosStationIntegrationBody,
 		options?: RequestOptions,
 	): ResponsePromise<PutCentricosStationIntegrationResponse> {
 		return this.request(
@@ -16164,7 +16188,7 @@ export class ServiceClient extends BaseServiceClient {
 			'/centricos/station/{station_id}/integration/{integration_type}',
 			'PUT',
 			`/centricos/station/${station_id}/integration/${integration_type}`,
-			null,
+			body,
 			options,
 		);
 	}

package/src/interface/centricos.ts

@@ -430,6 +430,80 @@ export interface GetStationResponse {
 	closure_schedules: ClosureSchedule[];
 }
 
+export interface PickupSectionDto {
+	// Whether the station accepts pickup orders
+	enabled: boolean;
+	// Length of a pickup timeslot, in minutes. Required when enabled.
+	timeslot_length_minutes?: number;
+	// Average order prep time, in minutes. Required when enabled.
+	average_prep_time_minutes?: number;
+	// Orders accepted per pickup timeslot. Required when enabled.
+	customers_per_slot?: number;
+	// Whether guests must check in on arrival
+	guest_checkin?: boolean;
+}
+
+export interface CustomDropOffTimeslotDto {
+	// Window start, HH:mm on a 24 hour clock
+	start_time: string;
+	// Window end, HH:mm on a 24 hour clock
+	end_time: string;
+	// Delivery destination ids served during this window
+	destinations: string[];
+}
+
+export interface DropOffSectionDto {
+	// Whether the station accepts drop-off orders
+	enabled: boolean;
+	// How drop-off timeslots are generated. Required when enabled.
+	mode?: 'automatic' | 'custom' | 'robot';
+	// Drop-off prep time, in minutes. Required when enabled.
+	prep_time_minutes?: number;
+	// Orders accepted per drop-off timeslot. Required when enabled.
+	customers_per_slot?: number;
+	// Timeslot interval in minutes. Required in automatic mode.
+	auto_time_minutes?: number;
+	// Destination ids served all day. Required in automatic mode.
+	destinations?: string[];
+	// Caller-defined delivery windows. Required in custom mode.
+	custom_timeslots?: CustomDropOffTimeslotDto[];
+	// Fee in dollars. Send null to remove it; omit to leave it as is.
+	fee?: number | null;
+	// Whether guests can leave drop-off instructions
+	show_instructions?: boolean;
+	// Whether guests see a single timeslot instead of a list
+	show_single_timeslot?: boolean;
+	// Whether orders are handed to the runner app
+	runner_app_enabled?: boolean;
+}
+
+export interface ScanAndPaySectionDto {
+	// Canteen (System365) location id for this station
+	canteen_location_id: string;
+}
+
+export interface JustWalkOutSectionDto {
+	// Whether the store is live. Drives frictionless_supported and pickup_supported.
+	enabled: boolean;
+	// Frictionless vendor operating the store
+	third_party_partner?: string;
+	// Amazon Just Walk Out store id
+	amazon_store_id?: string;
+}
+
+export interface PutStationIntegrationRequest {
+	// How the station takes orders
+	order_method?: 'pre-order' | 'scan-n-pay' | 'just-walk-out';
+	// Pickup setup
+	pickup?: PickupSectionDto;
+	// Drop-off setup
+	drop_off?: DropOffSectionDto;
+	// Scan & Pay setup
+	scan_and_pay?: ScanAndPaySectionDto;
+	// Just Walk Out setup
+	just_walk_out?: JustWalkOutSectionDto;
+}
+
 export interface PutStationIntegrationResponse {
 	success: boolean;
 }
@@ -1453,6 +1527,8 @@ export interface PutCentricosStationIntegrationPath {
 	integration_type: string;
 }
 
+export type PutCentricosStationIntegrationBody = PutStationIntegrationRequest;
+
 export type PutCentricosStationIntegrationResponse = PutStationIntegrationResponse;
 
 // DELETE /centricos/station/{station_id}/{integration_type} - Delete station integration

package/src/interface/menu.ts

@@ -8717,6 +8717,20 @@ export interface PatchMenuV4BrandMenusReorderRequest
 	body: PatchMenuV4BrandMenusReorderBody;
 }
 
+// GET /menu/v4/brand/{id}/generate-barcode
+
+export interface GetMenuV4BrandGenerateBarcodePath {
+	id: string;
+}
+
+export interface GetMenuV4BrandGenerateBarcodeResponse {
+	barcode?: string;
+}
+
+export interface GetMenuV4BrandGenerateBarcodeRequest
+	extends BaseRequest,
+		GetMenuV4BrandGenerateBarcodePath {}
+
 // GET /menu/v4/brand/{id}/items
 
 export interface GetMenuV4BrandItemsPath {