@compassdigital/sdk.typescript 4.689.0 → 4.690.0

package/lib/interface/delivery.d.ts

@@ -9,6 +9,11 @@ export interface HealthResponseDto {
     version: string;
     metadata: HealthMetadataDto;
 }
+export interface OrderReadyResponseDto {
+    id: string;
+    status: string;
+    ready?: boolean;
+}
 export interface ErrorDisplayMessage {
     title: string;
     description: string;
@@ -27,4 +32,10 @@ export interface Error {
 export type GetDeliveryHealthResponse = HealthResponseDto;
 export interface GetDeliveryHealthRequest extends BaseRequest {
 }
+export interface PostDeliveryOrderReadyPath {
+    id: string;
+}
+export type PostDeliveryOrderReadyResponse = OrderReadyResponseDto;
+export interface PostDeliveryOrderReadyRequest extends BaseRequest, PostDeliveryOrderReadyPath {
+}
 //# sourceMappingURL=delivery.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"delivery.d.ts","sourceRoot":"","sources":["../../src/interface/delivery.ts"],"names":[],"mappings":"AAGA,OAAO,EAAgB,WAAW,EAAE,MAAM,QAAQ,CAAC;AAEnD,MAAM,WAAW,iBAAiB;IAEjC,OAAO,EAAE,MAAM,CAAC;IAEhB,MAAM,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,iBAAiB;IAEjC,MAAM,EAAE,MAAM,CAAC;IAEf,SAAS,EAAE,MAAM,CAAC;IAElB,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,iBAAiB,CAAC;CAC5B;AAED,MAAM,WAAW,mBAAmB;IAEnC,KAAK,EAAE,MAAM,CAAC;IAEd,WAAW,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,SAAS;IAEzB,UAAU,EAAE,MAAM,CAAC;IAEnB,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;IAElB,cAAc,EAAE,mBAAmB,CAAC;CACpC;AAED,MAAM,WAAW,KAAK;IAErB,IAAI,EAAE,MAAM,CAAC;IAEb,OAAO,EAAE,MAAM,CAAC;IAEhB,IAAI,EAAE,SAAS,CAAC;CAChB;AAID,MAAM,MAAM,yBAAyB,GAAG,iBAAiB,CAAC;AAE1D,MAAM,WAAW,wBAAyB,SAAQ,WAAW;CAAG"}
+{"version":3,"file":"delivery.d.ts","sourceRoot":"","sources":["../../src/interface/delivery.ts"],"names":[],"mappings":"AAGA,OAAO,EAAgB,WAAW,EAAE,MAAM,QAAQ,CAAC;AAEnD,MAAM,WAAW,iBAAiB;IAEjC,OAAO,EAAE,MAAM,CAAC;IAEhB,MAAM,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,iBAAiB;IAEjC,MAAM,EAAE,MAAM,CAAC;IAEf,SAAS,EAAE,MAAM,CAAC;IAElB,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,iBAAiB,CAAC;CAC5B;AAED,MAAM,WAAW,qBAAqB;IAErC,EAAE,EAAE,MAAM,CAAC;IAEX,MAAM,EAAE,MAAM,CAAC;IAEf,KAAK,CAAC,EAAE,OAAO,CAAC;CAChB;AAED,MAAM,WAAW,mBAAmB;IAEnC,KAAK,EAAE,MAAM,CAAC;IAEd,WAAW,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,SAAS;IAEzB,UAAU,EAAE,MAAM,CAAC;IAEnB,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;IAElB,cAAc,EAAE,mBAAmB,CAAC;CACpC;AAED,MAAM,WAAW,KAAK;IAErB,IAAI,EAAE,MAAM,CAAC;IAEb,OAAO,EAAE,MAAM,CAAC;IAEhB,IAAI,EAAE,SAAS,CAAC;CAChB;AAID,MAAM,MAAM,yBAAyB,GAAG,iBAAiB,CAAC;AAE1D,MAAM,WAAW,wBAAyB,SAAQ,WAAW;CAAG;AAIhE,MAAM,WAAW,0BAA0B;IAC1C,EAAE,EAAE,MAAM,CAAC;CACX;AAED,MAAM,MAAM,8BAA8B,GAAG,qBAAqB,CAAC;AAEnE,MAAM,WAAW,6BAA8B,SAAQ,WAAW,EAAE,0BAA0B;CAAG"}

package/package.json

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

package/src/index.ts

@@ -1585,7 +1585,7 @@ import {
 	GetForecastingHealthResponse,
 } from './interface/forecasting';
 
-import { GetDeliveryHealthResponse } from './interface/delivery';
+import { GetDeliveryHealthResponse, PostDeliveryOrderReadyResponse } from './interface/delivery';
 
 import { BaseServiceClient, RequestOptions, ServiceClientOptions, ResponsePromise } from './base';
 export * from './base';
@@ -18015,4 +18015,24 @@ export class ServiceClient extends BaseServiceClient {
 			options,
 		);
 	}
+
+	/**
+	 * POST /delivery/order/{id}/ready - Mark an AVRIDE order ready for robot pickup
+	 *
+	 * @param id
+	 * @param options - additional request options
+	 */
+	post_delivery_order_ready(
+		id: string,
+		options?: RequestOptions,
+	): ResponsePromise<PostDeliveryOrderReadyResponse> {
+		return this.request(
+			'delivery',
+			'/delivery/order/{id}/ready',
+			'POST',
+			`/delivery/order/${id}/ready`,
+			null,
+			options,
+		);
+	}
 }

package/src/interface/delivery.ts

@@ -20,6 +20,15 @@ export interface HealthResponseDto {
 	metadata: HealthMetadataDto;
 }
 
+export interface OrderReadyResponseDto {
+	// AVRIDE order id (same as the CDL order id)
+	id: string;
+	// AVRIDE order status after the ready call
+	status: string;
+	// Whether AVRIDE confirmed the order as ready
+	ready?: boolean;
+}
+
 export interface ErrorDisplayMessage {
 	// user message title
 	title: string;
@@ -51,3 +60,13 @@ export interface Error {
 export type GetDeliveryHealthResponse = HealthResponseDto;
 
 export interface GetDeliveryHealthRequest extends BaseRequest {}
+
+// POST /delivery/order/{id}/ready - Mark an AVRIDE order ready for robot pickup
+
+export interface PostDeliveryOrderReadyPath {
+	id: string;
+}
+
+export type PostDeliveryOrderReadyResponse = OrderReadyResponseDto;
+
+export interface PostDeliveryOrderReadyRequest extends BaseRequest, PostDeliveryOrderReadyPath {}