@compassdigital/sdk.typescript 4.696.0 → 4.697.0

package/lib/interface/delivery.d.ts

@@ -100,6 +100,24 @@ export interface OrderStatusResponseDto {
     status: string;
     updatedAt: string;
 }
+export interface PostOrderPointDto {
+    address?: string;
+    lat: number;
+    lon: number;
+}
+export interface PostOrderRequestDto {
+    orderId: string;
+    orderNumber: string;
+    siteId: string;
+    stationId: string;
+    pickUp: PostOrderPointDto;
+    dropOff: PostOrderPointDto;
+    scheduledPickUp?: string;
+}
+export interface PostOrderResponseDto {
+    partnerOrderId: string;
+    partnerOrderStatus: string;
+}
 export type GetDeliveryHealthResponse = HealthResponseDto;
 export interface GetDeliveryHealthRequest extends BaseRequest {
 }
@@ -129,4 +147,15 @@ export type PostDeliveryOrderStatusResponse = OrderStatusResponseDto;
 export interface PostDeliveryOrderStatusRequest extends BaseRequest, PostDeliveryOrderStatusPath {
     body: PostDeliveryOrderStatusBody;
 }
+export type PostDeliveryOrderCreateBody = PostOrderRequestDto;
+export type PostDeliveryOrderCreateResponse = PostOrderResponseDto;
+export interface PostDeliveryOrderCreateRequest extends BaseRequest {
+    body: PostDeliveryOrderCreateBody;
+}
+export interface PostDeliveryOrderCancelPath {
+    id: string;
+}
+export type PostDeliveryOrderCancelResponse = {};
+export interface PostDeliveryOrderCancelRequest extends BaseRequest, PostDeliveryOrderCancelPath {
+}
 //# 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,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;AAED,MAAM,WAAW,WAAW;IAE3B,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb,GAAG,CAAC,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,MAAM;IAEtB,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,MAAM,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,kBAAkB;IAElC,OAAO,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,UAAU;IAE1B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,GAAG,CAAC,EAAE,kBAAkB,CAAC;IACzB,GAAG,CAAC,EAAE,kBAAkB,CAAC;CACzB;AAED,MAAM,WAAW,gBAAgB;IAEhC,GAAG,EAAE,MAAM,CAAC;IAEZ,GAAG,EAAE,MAAM,CAAC;IAEZ,GAAG,EAAE,MAAM,CAAC;CACZ;AAED,MAAM,WAAW,aAAa;IAE7B,GAAG,EAAE,MAAM,CAAC;IAEZ,GAAG,EAAE,MAAM,CAAC;CACZ;AAED,MAAM,WAAW,QAAQ;IAExB,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAEhC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,gBAAgB,CAAC;IAC5B,KAAK,CAAC,EAAE,aAAa,EAAE,CAAC;CACxB;AAED,MAAM,WAAW,uBAAuB;IAEvC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,GAAG,EAAE,WAAW,CAAC;IACjB,GAAG,EAAE,MAAM,CAAC;IAEZ,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,EAAE,EAAE,MAAM,CAAC;IAEX,KAAK,EAAE,OAAO,CAAC;IACf,OAAO,CAAC,EAAE,UAAU,CAAC;IACrB,MAAM,CAAC,EAAE,QAAQ,EAAE,CAAC;IAEpB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,GAAG,CAAC,EAAE,WAAW,CAAC;IAElB,MAAM,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,mBAAmB;IACnC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,sBAAsB;IACtC,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;CACZ;AAED,MAAM,WAAW,cAAc;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,sBAAsB,CAAC;CACjC;AAED,MAAM,WAAW,oBAAoB;IACpC,MAAM,EACH,KAAK,GACL,UAAU,GACV,QAAQ,GACR,mBAAmB,GACnB,cAAc,GACd,SAAS,GACT,oBAAoB,GACpB,WAAW,GACX,oBAAoB,GACpB,eAAe,GACf,mBAAmB,GACnB,iBAAiB,GACjB,UAAU,CAAC;IACd,GAAG,CAAC,EAAE,mBAAmB,CAAC;IAC1B,MAAM,CAAC,EAAE,cAAc,EAAE,CAAC;CAC1B;AAED,MAAM,WAAW,sBAAsB;IAEtC,OAAO,EAAE,MAAM,CAAC;IAEhB,MAAM,EAAE,MAAM,CAAC;IAEf,SAAS,EAAE,MAAM,CAAC;CAClB;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;AAIjG,MAAM,WAAW,4BAA4B;IAC5C,EAAE,EAAE,MAAM,CAAC;CACX;AAED,MAAM,MAAM,gCAAgC,GAAG,uBAAuB,CAAC;AAEvE,MAAM,WAAW,+BAChB,SAAQ,WAAW,EAClB,4BAA4B;CAAG;AAIjC,MAAM,WAAW,6BAA6B;IAC7C,EAAE,EAAE,MAAM,CAAC;CACX;AAED,MAAM,MAAM,iCAAiC,GAAG,uBAAuB,CAAC;AAExE,MAAM,WAAW,gCAChB,SAAQ,WAAW,EAClB,6BAA6B;CAAG;AAIlC,MAAM,WAAW,2BAA2B;IAC3C,EAAE,EAAE,MAAM,CAAC;CACX;AAED,MAAM,MAAM,2BAA2B,GAAG,oBAAoB,CAAC;AAE/D,MAAM,MAAM,+BAA+B,GAAG,sBAAsB,CAAC;AAErE,MAAM,WAAW,8BAA+B,SAAQ,WAAW,EAAE,2BAA2B;IAC/F,IAAI,EAAE,2BAA2B,CAAC;CAClC"}
+{"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;AAED,MAAM,WAAW,WAAW;IAE3B,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb,GAAG,CAAC,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,MAAM;IAEtB,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,MAAM,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,kBAAkB;IAElC,OAAO,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,UAAU;IAE1B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,GAAG,CAAC,EAAE,kBAAkB,CAAC;IACzB,GAAG,CAAC,EAAE,kBAAkB,CAAC;CACzB;AAED,MAAM,WAAW,gBAAgB;IAEhC,GAAG,EAAE,MAAM,CAAC;IAEZ,GAAG,EAAE,MAAM,CAAC;IAEZ,GAAG,EAAE,MAAM,CAAC;CACZ;AAED,MAAM,WAAW,aAAa;IAE7B,GAAG,EAAE,MAAM,CAAC;IAEZ,GAAG,EAAE,MAAM,CAAC;CACZ;AAED,MAAM,WAAW,QAAQ;IAExB,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAEhC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,gBAAgB,CAAC;IAC5B,KAAK,CAAC,EAAE,aAAa,EAAE,CAAC;CACxB;AAED,MAAM,WAAW,uBAAuB;IAEvC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,GAAG,EAAE,WAAW,CAAC;IACjB,GAAG,EAAE,MAAM,CAAC;IAEZ,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,EAAE,EAAE,MAAM,CAAC;IAEX,KAAK,EAAE,OAAO,CAAC;IACf,OAAO,CAAC,EAAE,UAAU,CAAC;IACrB,MAAM,CAAC,EAAE,QAAQ,EAAE,CAAC;IAEpB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,GAAG,CAAC,EAAE,WAAW,CAAC;IAElB,MAAM,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,mBAAmB;IACnC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,sBAAsB;IACtC,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;CACZ;AAED,MAAM,WAAW,cAAc;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,sBAAsB,CAAC;CACjC;AAED,MAAM,WAAW,oBAAoB;IACpC,MAAM,EACH,KAAK,GACL,UAAU,GACV,QAAQ,GACR,mBAAmB,GACnB,cAAc,GACd,SAAS,GACT,oBAAoB,GACpB,WAAW,GACX,oBAAoB,GACpB,eAAe,GACf,mBAAmB,GACnB,iBAAiB,GACjB,UAAU,CAAC;IACd,GAAG,CAAC,EAAE,mBAAmB,CAAC;IAC1B,MAAM,CAAC,EAAE,cAAc,EAAE,CAAC;CAC1B;AAED,MAAM,WAAW,sBAAsB;IAEtC,OAAO,EAAE,MAAM,CAAC;IAEhB,MAAM,EAAE,MAAM,CAAC;IAEf,SAAS,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,iBAAiB;IAEjC,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB,GAAG,EAAE,MAAM,CAAC;IAEZ,GAAG,EAAE,MAAM,CAAC;CACZ;AAED,MAAM,WAAW,mBAAmB;IAEnC,OAAO,EAAE,MAAM,CAAC;IAEhB,WAAW,EAAE,MAAM,CAAC;IAEpB,MAAM,EAAE,MAAM,CAAC;IAEf,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,iBAAiB,CAAC;IAC1B,OAAO,EAAE,iBAAiB,CAAC;IAE3B,eAAe,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,oBAAoB;IAEpC,cAAc,EAAE,MAAM,CAAC;IAEvB,kBAAkB,EAAE,MAAM,CAAC;CAC3B;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;AAIjG,MAAM,WAAW,4BAA4B;IAC5C,EAAE,EAAE,MAAM,CAAC;CACX;AAED,MAAM,MAAM,gCAAgC,GAAG,uBAAuB,CAAC;AAEvE,MAAM,WAAW,+BAChB,SAAQ,WAAW,EAClB,4BAA4B;CAAG;AAIjC,MAAM,WAAW,6BAA6B;IAC7C,EAAE,EAAE,MAAM,CAAC;CACX;AAED,MAAM,MAAM,iCAAiC,GAAG,uBAAuB,CAAC;AAExE,MAAM,WAAW,gCAChB,SAAQ,WAAW,EAClB,6BAA6B;CAAG;AAIlC,MAAM,WAAW,2BAA2B;IAC3C,EAAE,EAAE,MAAM,CAAC;CACX;AAED,MAAM,MAAM,2BAA2B,GAAG,oBAAoB,CAAC;AAE/D,MAAM,MAAM,+BAA+B,GAAG,sBAAsB,CAAC;AAErE,MAAM,WAAW,8BAA+B,SAAQ,WAAW,EAAE,2BAA2B;IAC/F,IAAI,EAAE,2BAA2B,CAAC;CAClC;AAID,MAAM,MAAM,2BAA2B,GAAG,mBAAmB,CAAC;AAE9D,MAAM,MAAM,+BAA+B,GAAG,oBAAoB,CAAC;AAEnE,MAAM,WAAW,8BAA+B,SAAQ,WAAW;IAClE,IAAI,EAAE,2BAA2B,CAAC;CAClC;AAID,MAAM,WAAW,2BAA2B;IAC3C,EAAE,EAAE,MAAM,CAAC;CACX;AAED,MAAM,MAAM,+BAA+B,GAAG,EAAE,CAAC;AAEjD,MAAM,WAAW,8BAA+B,SAAQ,WAAW,EAAE,2BAA2B;CAAG"}

package/package.json

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

package/src/index.ts

@@ -1592,6 +1592,9 @@ import {
 	PostDeliveryOrderCloseLidResponse,
 	PostDeliveryOrderStatusBody,
 	PostDeliveryOrderStatusResponse,
+	PostDeliveryOrderCreateBody,
+	PostDeliveryOrderCreateResponse,
+	PostDeliveryOrderCancelResponse,
 } from './interface/delivery';
 
 import { BaseServiceClient, RequestOptions, ServiceClientOptions, ResponsePromise } from './base';
@@ -18104,4 +18107,44 @@ export class ServiceClient extends BaseServiceClient {
 			options,
 		);
 	}
+
+	/**
+	 * POST /delivery/order - Create an AVRIDE scheduled order before payment processing
+	 *
+	 * @param body
+	 * @param options - additional request options
+	 */
+	post_delivery_order_create(
+		body: PostDeliveryOrderCreateBody,
+		options?: RequestOptions,
+	): ResponsePromise<PostDeliveryOrderCreateResponse> {
+		return this.request(
+			'delivery',
+			'/delivery/order',
+			'POST',
+			`/delivery/order`,
+			body,
+			options,
+		);
+	}
+
+	/**
+	 * POST /delivery/order/{id}/cancel - Cancel an AVRIDE order (payment-failure compensation)
+	 *
+	 * @param id
+	 * @param options - additional request options
+	 */
+	post_delivery_order_cancel(
+		id: string,
+		options?: RequestOptions,
+	): ResponsePromise<PostDeliveryOrderCancelResponse> {
+		return this.request(
+			'delivery',
+			'/delivery/order/{id}/cancel',
+			'POST',
+			`/delivery/order/${id}/cancel`,
+			null,
+			options,
+		);
+	}
 }

package/src/interface/delivery.ts

@@ -177,6 +177,37 @@ export interface OrderStatusResponseDto {
 	updatedAt: string;
 }
 
+export interface PostOrderPointDto {
+	// Human-readable address
+	address?: string;
+	// Latitude
+	lat: number;
+	// Longitude
+	lon: number;
+}
+
+export interface PostOrderRequestDto {
+	// CDL-encoded order id
+	orderId: string;
+	// Order number for display/audit
+	orderNumber: string;
+	// Site id the order belongs to
+	siteId: string;
+	// Station id the order belongs to
+	stationId: string;
+	pickUp: PostOrderPointDto;
+	dropOff: PostOrderPointDto;
+	// Guest-requested pickup time, forwarded to AVRIDE as scheduledPickUp
+	scheduledPickUp?: string;
+}
+
+export interface PostOrderResponseDto {
+	// AVRIDE order id (same as the decoded CDL order id)
+	partnerOrderId: string;
+	// AVRIDE order status immediately after creation
+	partnerOrderStatus: string;
+}
+
 // GET /delivery/health - Delivery service readiness check
 
 export type GetDeliveryHealthResponse = HealthResponseDto;
@@ -230,3 +261,23 @@ export type PostDeliveryOrderStatusResponse = OrderStatusResponseDto;
 export interface PostDeliveryOrderStatusRequest extends BaseRequest, PostDeliveryOrderStatusPath {
 	body: PostDeliveryOrderStatusBody;
 }
+
+// POST /delivery/order - Create an AVRIDE scheduled order before payment processing
+
+export type PostDeliveryOrderCreateBody = PostOrderRequestDto;
+
+export type PostDeliveryOrderCreateResponse = PostOrderResponseDto;
+
+export interface PostDeliveryOrderCreateRequest extends BaseRequest {
+	body: PostDeliveryOrderCreateBody;
+}
+
+// POST /delivery/order/{id}/cancel - Cancel an AVRIDE order (payment-failure compensation)
+
+export interface PostDeliveryOrderCancelPath {
+	id: string;
+}
+
+export type PostDeliveryOrderCancelResponse = {};
+
+export interface PostDeliveryOrderCancelRequest extends BaseRequest, PostDeliveryOrderCancelPath {}