@compassdigital/sdk.typescript 4.694.0 → 4.695.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.
Files changed (9) hide show
  1. package/lib/index.d.ts +9 -1
  2. package/lib/index.d.ts.map +1 -1
  3. package/lib/index.js +10 -0
  4. package/lib/index.js.map +1 -1
  5. package/lib/interface/delivery.d.ts +37 -1
  6. package/lib/interface/delivery.d.ts.map +1 -1
  7. package/package.json +1 -1
  8. package/src/index.ts +24 -0
  9. package/src/interface/delivery.ts +67 -1
package/lib/interface/delivery.d.ts CHANGED
@@ -24,7 +24,11 @@ export interface ErrorData {
24
24
  timestamp: string;
25
25
  displayMessage: ErrorDisplayMessage;
26
26
  }
27
- export type Error = Record<string, any>;
27
+ export interface Error {
28
+ code: number;
29
+ message: string;
30
+ data: ErrorData;
31
+ }
28
32
  export interface LocationDto {
29
33
  address?: string;
30
34
  extId?: string;
@@ -72,6 +76,30 @@ export interface OrderOpenLidResponseDto {
72
76
  src?: LocationDto;
73
77
  status: string;
74
78
  }
79
+ export interface DeliveryOrderEtaDto {
80
+ pickUp?: string;
81
+ dropOff?: string;
82
+ return?: string;
83
+ }
84
+ export interface AvrideRobotPositionDto {
85
+ lat: number;
86
+ lon: number;
87
+ yaw: number;
88
+ }
89
+ export interface AvrideRobotDto {
90
+ name: string;
91
+ position: AvrideRobotPositionDto;
92
+ }
93
+ export interface UpdateOrderStatusDto {
94
+ status: 'new' | 'accepted' | 'pickUp' | 'pickUpTransaction' | 'transporting' | 'dropOff' | 'dropOffTransaction' | 'completed' | 'returnTransporting' | 'returnDropOff' | 'returnTransaction' | 'returnCompleted' | 'canceled';
95
+ eta?: DeliveryOrderEtaDto;
96
+ robots?: AvrideRobotDto[];
97
+ }
98
+ export interface OrderStatusResponseDto {
99
+ orderId: string;
100
+ status: string;
101
+ updatedAt: string;
102
+ }
75
103
  export type GetDeliveryHealthResponse = HealthResponseDto;
76
104
  export interface GetDeliveryHealthRequest extends BaseRequest {
77
105
  }
@@ -93,4 +121,12 @@ export interface PostDeliveryOrderCloseLidPath {
93
121
  export type PostDeliveryOrderCloseLidResponse = OrderOpenLidResponseDto;
94
122
  export interface PostDeliveryOrderCloseLidRequest extends BaseRequest, PostDeliveryOrderCloseLidPath {
95
123
  }
124
+ export interface PostDeliveryOrderStatusPath {
125
+ id: string;
126
+ }
127
+ export type PostDeliveryOrderStatusBody = UpdateOrderStatusDto;
128
+ export type PostDeliveryOrderStatusResponse = OrderStatusResponseDto;
129
+ export interface PostDeliveryOrderStatusRequest extends BaseRequest, PostDeliveryOrderStatusPath {
130
+ body: PostDeliveryOrderStatusBody;
131
+ }
96
132
  //# sourceMappingURL=delivery.d.ts.map
package/lib/interface/delivery.d.ts.map CHANGED
@@ -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,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,MAAM,KAAK,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;AAExC,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;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"}
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"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@compassdigital/sdk.typescript",
3
- "version": "4.694.0",
3
+ "version": "4.695.0",
4
4
  "description": "Compass Digital Labs TypeScript SDK",
5
5
  "type": "commonjs",
6
6
  "main": "./lib/index.js",
package/src/index.ts CHANGED
@@ -1590,6 +1590,8 @@ import {
1590
1590
  PostDeliveryOrderReadyResponse,
1591
1591
  PostDeliveryOrderOpenLidResponse,
1592
1592
  PostDeliveryOrderCloseLidResponse,
1593
+ PostDeliveryOrderStatusBody,
1594
+ PostDeliveryOrderStatusResponse,
1593
1595
  } from './interface/delivery';
1594
1596
 
1595
1597
  import { BaseServiceClient, RequestOptions, ServiceClientOptions, ResponsePromise } from './base';
@@ -18080,4 +18082,26 @@ export class ServiceClient extends BaseServiceClient {
18080
18082
  options,
18081
18083
  );
18082
18084
  }
18085
+
18086
+ /**
18087
+ * POST /delivery/order/{id}/status - Update a delivery order's status on its delivery-orders record
18088
+ *
18089
+ * @param id
18090
+ * @param body
18091
+ * @param options - additional request options
18092
+ */
18093
+ post_delivery_order_status(
18094
+ id: string,
18095
+ body: PostDeliveryOrderStatusBody,
18096
+ options?: RequestOptions,
18097
+ ): ResponsePromise<PostDeliveryOrderStatusResponse> {
18098
+ return this.request(
18099
+ 'delivery',
18100
+ '/delivery/order/{id}/status',
18101
+ 'POST',
18102
+ `/delivery/order/${id}/status`,
18103
+ body,
18104
+ options,
18105
+ );
18106
+ }
18083
18107
  }
package/src/interface/delivery.ts CHANGED
@@ -46,7 +46,14 @@ export interface ErrorData {
46
46
  displayMessage: ErrorDisplayMessage;
47
47
  }
48
48
 
49
- export type Error = Record<string, any>;
49
+ export interface Error {
50
+ // business error code
51
+ code: number;
52
+ // business error description
53
+ message: string;
54
+ // additional error data
55
+ data: ErrorData;
56
+ }
50
57
 
51
58
  export interface LocationDto {
52
59
  // Street address
@@ -125,6 +132,51 @@ export interface OrderOpenLidResponseDto {
125
132
  status: string;
126
133
  }
127
134
 
135
+ export interface DeliveryOrderEtaDto {
136
+ pickUp?: string;
137
+ dropOff?: string;
138
+ return?: string;
139
+ }
140
+
141
+ export interface AvrideRobotPositionDto {
142
+ lat: number;
143
+ lon: number;
144
+ yaw: number;
145
+ }
146
+
147
+ export interface AvrideRobotDto {
148
+ name: string;
149
+ position: AvrideRobotPositionDto;
150
+ }
151
+
152
+ export interface UpdateOrderStatusDto {
153
+ status:
154
+ | 'new'
155
+ | 'accepted'
156
+ | 'pickUp'
157
+ | 'pickUpTransaction'
158
+ | 'transporting'
159
+ | 'dropOff'
160
+ | 'dropOffTransaction'
161
+ | 'completed'
162
+ | 'returnTransporting'
163
+ | 'returnDropOff'
164
+ | 'returnTransaction'
165
+ | 'returnCompleted'
166
+ | 'canceled';
167
+ eta?: DeliveryOrderEtaDto;
168
+ robots?: AvrideRobotDto[];
169
+ }
170
+
171
+ export interface OrderStatusResponseDto {
172
+ // CDL order id
173
+ orderId: string;
174
+ // Stored order status after the update
175
+ status: string;
176
+ // Timestamp the record was last updated
177
+ updatedAt: string;
178
+ }
179
+
128
180
  // GET /delivery/health - Delivery service readiness check
129
181
 
130
182
  export type GetDeliveryHealthResponse = HealthResponseDto;
@@ -164,3 +216,17 @@ export type PostDeliveryOrderCloseLidResponse = OrderOpenLidResponseDto;
164
216
  export interface PostDeliveryOrderCloseLidRequest
165
217
  extends BaseRequest,
166
218
  PostDeliveryOrderCloseLidPath {}
219
+
220
+ // POST /delivery/order/{id}/status - Update a delivery order's status on its delivery-orders record
221
+
222
+ export interface PostDeliveryOrderStatusPath {
223
+ id: string;
224
+ }
225
+
226
+ export type PostDeliveryOrderStatusBody = UpdateOrderStatusDto;
227
+
228
+ export type PostDeliveryOrderStatusResponse = OrderStatusResponseDto;
229
+
230
+ export interface PostDeliveryOrderStatusRequest extends BaseRequest, PostDeliveryOrderStatusPath {
231
+ body: PostDeliveryOrderStatusBody;
232
+ }