@compassdigital/sdk.typescript 4.722.0 → 4.723.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/lib/index.d.ts +8 -1
- package/lib/index.d.ts.map +1 -1
- package/lib/index.js +9 -0
- package/lib/index.js.map +1 -1
- package/lib/interface/delivery.d.ts +35 -4
- package/lib/interface/delivery.d.ts.map +1 -1
- package/package.json +1 -1
- package/src/index.ts +21 -0
- package/src/interface/delivery.ts +70 -7
|
@@ -9,10 +9,30 @@ export interface HealthResponseDto {
|
|
|
9
9
|
version: string;
|
|
10
10
|
metadata: HealthMetadataDto;
|
|
11
11
|
}
|
|
12
|
-
export interface
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
12
|
+
export interface GetDeliveryOrderLocationDto {
|
|
13
|
+
address?: string;
|
|
14
|
+
lat: number;
|
|
15
|
+
lon: number;
|
|
16
|
+
}
|
|
17
|
+
export interface GetDeliveryOrderRobotPositionDto {
|
|
18
|
+
lat: number;
|
|
19
|
+
lon: number;
|
|
20
|
+
}
|
|
21
|
+
export interface GetDeliveryOrderRobotDto {
|
|
22
|
+
name: string;
|
|
23
|
+
position: GetDeliveryOrderRobotPositionDto;
|
|
24
|
+
}
|
|
25
|
+
export interface GetDeliveryOrderResponseDto {
|
|
26
|
+
orderId: string;
|
|
27
|
+
orderNumber: string;
|
|
28
|
+
status: 'pending' | 'assigned' | 'out_for_delivery' | 'arrived' | 'delivered' | 'returning' | 'no_show' | 'cancelled';
|
|
29
|
+
etaAt?: Record<string, any> | null;
|
|
30
|
+
pickUp?: GetDeliveryOrderLocationDto;
|
|
31
|
+
dropOff?: GetDeliveryOrderLocationDto;
|
|
32
|
+
dropOffArrivedAt?: Record<string, any> | null;
|
|
33
|
+
leaveTimeAt?: Record<string, any> | null;
|
|
34
|
+
robot?: GetDeliveryOrderRobotDto;
|
|
35
|
+
updatedAt: string;
|
|
16
36
|
}
|
|
17
37
|
export interface ErrorDisplayMessage {
|
|
18
38
|
title: string;
|
|
@@ -29,6 +49,11 @@ export interface Error {
|
|
|
29
49
|
message: string;
|
|
30
50
|
data: ErrorData;
|
|
31
51
|
}
|
|
52
|
+
export interface OrderReadyResponseDto {
|
|
53
|
+
id: string;
|
|
54
|
+
status: string;
|
|
55
|
+
ready?: boolean;
|
|
56
|
+
}
|
|
32
57
|
export interface LocationDto {
|
|
33
58
|
address?: string;
|
|
34
59
|
extId?: string;
|
|
@@ -133,6 +158,12 @@ export interface GetDeliveryOrdersResponseDto {
|
|
|
133
158
|
export type GetDeliveryHealthResponse = HealthResponseDto;
|
|
134
159
|
export interface GetDeliveryHealthRequest extends BaseRequest {
|
|
135
160
|
}
|
|
161
|
+
export interface GetDeliveryOrderPath {
|
|
162
|
+
id: string;
|
|
163
|
+
}
|
|
164
|
+
export type GetDeliveryOrderResponse = GetDeliveryOrderResponseDto;
|
|
165
|
+
export interface GetDeliveryOrderRequest extends BaseRequest, GetDeliveryOrderPath {
|
|
166
|
+
}
|
|
136
167
|
export interface PostDeliveryOrderReadyPath {
|
|
137
168
|
id: string;
|
|
138
169
|
}
|
|
@@ -1 +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,
|
|
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,2BAA2B;IAE3C,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB,GAAG,EAAE,MAAM,CAAC;IAEZ,GAAG,EAAE,MAAM,CAAC;CACZ;AAED,MAAM,WAAW,gCAAgC;IAEhD,GAAG,EAAE,MAAM,CAAC;IAEZ,GAAG,EAAE,MAAM,CAAC;CACZ;AAED,MAAM,WAAW,wBAAwB;IAExC,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,gCAAgC,CAAC;CAC3C;AAED,MAAM,WAAW,2BAA2B;IAE3C,OAAO,EAAE,MAAM,CAAC;IAEhB,WAAW,EAAE,MAAM,CAAC;IAEpB,MAAM,EACH,SAAS,GACT,UAAU,GACV,kBAAkB,GAClB,SAAS,GACT,WAAW,GACX,WAAW,GACX,SAAS,GACT,WAAW,CAAC;IAEf,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,IAAI,CAAC;IAEnC,MAAM,CAAC,EAAE,2BAA2B,CAAC;IAErC,OAAO,CAAC,EAAE,2BAA2B,CAAC;IAEtC,gBAAgB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,IAAI,CAAC;IAE9C,WAAW,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,IAAI,CAAC;IAEzC,KAAK,CAAC,EAAE,wBAAwB,CAAC;IAEjC,SAAS,EAAE,MAAM,CAAC;CAClB;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,qBAAqB;IAErC,EAAE,EAAE,MAAM,CAAC;IAEX,MAAM,EAAE,MAAM,CAAC;IAEf,KAAK,CAAC,EAAE,OAAO,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;AAED,MAAM,WAAW,gBAAgB;IAEhC,OAAO,EAAE,MAAM,CAAC;IAEhB,WAAW,EAAE,MAAM,CAAC;IAEpB,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,IAAI,CAAC;IAEpC,SAAS,EAAE,MAAM,CAAC;IAElB,MAAM,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,4BAA4B;IAE5C,MAAM,EAAE,MAAM,CAAC;IAEf,WAAW,EAAE,MAAM,CAAC;IAEpB,MAAM,EAAE,gBAAgB,EAAE,CAAC;CAC3B;AAID,MAAM,MAAM,yBAAyB,GAAG,iBAAiB,CAAC;AAE1D,MAAM,WAAW,wBAAyB,SAAQ,WAAW;CAAG;AAIhE,MAAM,WAAW,oBAAoB;IACpC,EAAE,EAAE,MAAM,CAAC;CACX;AAED,MAAM,MAAM,wBAAwB,GAAG,2BAA2B,CAAC;AAEnE,MAAM,WAAW,uBAAwB,SAAQ,WAAW,EAAE,oBAAoB;CAAG;AAIrF,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;AAInG,MAAM,WAAW,qBAAqB;IACrC,MAAM,EAAE,MAAM,CAAC;CACf;AAED,MAAM,MAAM,yBAAyB,GAAG,4BAA4B,CAAC;AAErE,MAAM,WAAW,wBAAyB,SAAQ,WAAW,EAAE,qBAAqB;CAAG"}
|
package/package.json
CHANGED
package/src/index.ts
CHANGED
|
@@ -1597,6 +1597,7 @@ import {
|
|
|
1597
1597
|
|
|
1598
1598
|
import {
|
|
1599
1599
|
GetDeliveryHealthResponse,
|
|
1600
|
+
GetDeliveryOrderResponse,
|
|
1600
1601
|
PostDeliveryOrderReadyResponse,
|
|
1601
1602
|
PostDeliveryOrderOpenLidResponse,
|
|
1602
1603
|
PostDeliveryOrderCloseLidResponse,
|
|
@@ -18189,6 +18190,26 @@ export class ServiceClient extends BaseServiceClient {
|
|
|
18189
18190
|
);
|
|
18190
18191
|
}
|
|
18191
18192
|
|
|
18193
|
+
/**
|
|
18194
|
+
* GET /delivery/order/{id} - Get guest-facing delivery status and ETAs for an order
|
|
18195
|
+
*
|
|
18196
|
+
* @param id
|
|
18197
|
+
* @param options - additional request options
|
|
18198
|
+
*/
|
|
18199
|
+
get_delivery_order(
|
|
18200
|
+
id: string,
|
|
18201
|
+
options?: RequestOptions,
|
|
18202
|
+
): ResponsePromise<GetDeliveryOrderResponse> {
|
|
18203
|
+
return this.request(
|
|
18204
|
+
'delivery',
|
|
18205
|
+
'/delivery/order/{id}',
|
|
18206
|
+
'GET',
|
|
18207
|
+
`/delivery/order/${id}`,
|
|
18208
|
+
null,
|
|
18209
|
+
options,
|
|
18210
|
+
);
|
|
18211
|
+
}
|
|
18212
|
+
|
|
18192
18213
|
/**
|
|
18193
18214
|
* POST /delivery/order/{id}/ready - Mark an AVRIDE order ready for robot pickup
|
|
18194
18215
|
*
|
|
@@ -20,13 +20,57 @@ export interface HealthResponseDto {
|
|
|
20
20
|
metadata: HealthMetadataDto;
|
|
21
21
|
}
|
|
22
22
|
|
|
23
|
-
export interface
|
|
24
|
-
//
|
|
25
|
-
|
|
26
|
-
//
|
|
27
|
-
|
|
28
|
-
//
|
|
29
|
-
|
|
23
|
+
export interface GetDeliveryOrderLocationDto {
|
|
24
|
+
// Street address
|
|
25
|
+
address?: string;
|
|
26
|
+
// Latitude
|
|
27
|
+
lat: number;
|
|
28
|
+
// Longitude
|
|
29
|
+
lon: number;
|
|
30
|
+
}
|
|
31
|
+
|
|
32
|
+
export interface GetDeliveryOrderRobotPositionDto {
|
|
33
|
+
// Latitude
|
|
34
|
+
lat: number;
|
|
35
|
+
// Longitude
|
|
36
|
+
lon: number;
|
|
37
|
+
}
|
|
38
|
+
|
|
39
|
+
export interface GetDeliveryOrderRobotDto {
|
|
40
|
+
// Robot name
|
|
41
|
+
name: string;
|
|
42
|
+
position: GetDeliveryOrderRobotPositionDto;
|
|
43
|
+
}
|
|
44
|
+
|
|
45
|
+
export interface GetDeliveryOrderResponseDto {
|
|
46
|
+
// CDL order id
|
|
47
|
+
orderId: string;
|
|
48
|
+
// Human-readable order number
|
|
49
|
+
orderNumber: string;
|
|
50
|
+
// Guest-facing delivery status
|
|
51
|
+
status:
|
|
52
|
+
| 'pending'
|
|
53
|
+
| 'assigned'
|
|
54
|
+
| 'out_for_delivery'
|
|
55
|
+
| 'arrived'
|
|
56
|
+
| 'delivered'
|
|
57
|
+
| 'returning'
|
|
58
|
+
| 'no_show'
|
|
59
|
+
| 'cancelled';
|
|
60
|
+
// ETA timestamp for the current status, when applicable
|
|
61
|
+
etaAt?: Record<string, any> | null;
|
|
62
|
+
// Station pick-up location
|
|
63
|
+
pickUp?: GetDeliveryOrderLocationDto;
|
|
64
|
+
// Guest's drop-off location
|
|
65
|
+
dropOff?: GetDeliveryOrderLocationDto;
|
|
66
|
+
// When the robot reached drop-off
|
|
67
|
+
dropOffArrivedAt?: Record<string, any> | null;
|
|
68
|
+
// dropOffArrivedAt plus delivery discard wait time
|
|
69
|
+
leaveTimeAt?: Record<string, any> | null;
|
|
70
|
+
// Assigned robot; null once the delivery is terminal
|
|
71
|
+
robot?: GetDeliveryOrderRobotDto;
|
|
72
|
+
// Last time this record changed
|
|
73
|
+
updatedAt: string;
|
|
30
74
|
}
|
|
31
75
|
|
|
32
76
|
export interface ErrorDisplayMessage {
|
|
@@ -55,6 +99,15 @@ export interface Error {
|
|
|
55
99
|
data: ErrorData;
|
|
56
100
|
}
|
|
57
101
|
|
|
102
|
+
export interface OrderReadyResponseDto {
|
|
103
|
+
// AVRIDE order id (same as the CDL order id)
|
|
104
|
+
id: string;
|
|
105
|
+
// AVRIDE order status after the ready call
|
|
106
|
+
status: string;
|
|
107
|
+
// Whether AVRIDE confirmed the order as ready
|
|
108
|
+
ready?: boolean;
|
|
109
|
+
}
|
|
110
|
+
|
|
58
111
|
export interface LocationDto {
|
|
59
112
|
// Street address
|
|
60
113
|
address?: string;
|
|
@@ -236,6 +289,16 @@ export type GetDeliveryHealthResponse = HealthResponseDto;
|
|
|
236
289
|
|
|
237
290
|
export interface GetDeliveryHealthRequest extends BaseRequest {}
|
|
238
291
|
|
|
292
|
+
// GET /delivery/order/{id} - Get guest-facing delivery status and ETAs for an order
|
|
293
|
+
|
|
294
|
+
export interface GetDeliveryOrderPath {
|
|
295
|
+
id: string;
|
|
296
|
+
}
|
|
297
|
+
|
|
298
|
+
export type GetDeliveryOrderResponse = GetDeliveryOrderResponseDto;
|
|
299
|
+
|
|
300
|
+
export interface GetDeliveryOrderRequest extends BaseRequest, GetDeliveryOrderPath {}
|
|
301
|
+
|
|
239
302
|
// POST /delivery/order/{id}/ready - Mark an AVRIDE order ready for robot pickup
|
|
240
303
|
|
|
241
304
|
export interface PostDeliveryOrderReadyPath {
|