@shipengine/js-api 1.17.1 → 1.19.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/labels/api.d.ts +2 -2
- package/labels/types.d.ts +7 -1
- package/package.json +1 -1
package/labels/api.d.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { AxiosInstance } from "axios";
|
|
2
2
|
import { CreationRangeQuery, PageableQuery, PageableResult, SortableQuery } from "../resources";
|
|
3
|
-
import { Label, LabelLayout, VoidRequest } from "./types";
|
|
3
|
+
import { Label, LabelLayout, LabelStatus, VoidRequest } from "./types";
|
|
4
4
|
/**
|
|
5
5
|
* # Labels API - Create Label Options
|
|
6
6
|
*/
|
|
@@ -57,7 +57,7 @@ export type ListLabelsParams = {
|
|
|
57
57
|
/**
|
|
58
58
|
* `labelStatus` optionally allows filtering results to a specific status.
|
|
59
59
|
*/
|
|
60
|
-
labelStatus?:
|
|
60
|
+
labelStatus?: LabelStatus;
|
|
61
61
|
/**
|
|
62
62
|
* `rateId` is an optional string to return labels purchased with a
|
|
63
63
|
* specific rate.
|
package/labels/types.d.ts
CHANGED
|
@@ -2,6 +2,7 @@ import { Money } from "../payments";
|
|
|
2
2
|
import { RelayPoint } from "../relay-points";
|
|
3
3
|
import { Download, LinkedResource } from "../resources";
|
|
4
4
|
import { ShipmentPackage } from "../shipments";
|
|
5
|
+
import { RateDetail } from "../types";
|
|
5
6
|
/**
|
|
6
7
|
* @category Entities
|
|
7
8
|
*/
|
|
@@ -18,6 +19,10 @@ export type LabelFormat = "pdf" | "png" | "zpl";
|
|
|
18
19
|
* @category Entities
|
|
19
20
|
*/
|
|
20
21
|
export type LabelLayout = "4x6" | "letter";
|
|
22
|
+
/**
|
|
23
|
+
* @category Entities
|
|
24
|
+
*/
|
|
25
|
+
export type LabelStatus = "processing" | "completed" | "error" | "voided";
|
|
21
26
|
/**
|
|
22
27
|
* @category Entities
|
|
23
28
|
*/
|
|
@@ -41,6 +46,7 @@ export type Label = {
|
|
|
41
46
|
packageCode: string;
|
|
42
47
|
packages: ShipmentPackage[];
|
|
43
48
|
paperlessDownload: PaperlessDownload | null;
|
|
49
|
+
rateDetails: RateDetail[];
|
|
44
50
|
relayPoints: {
|
|
45
51
|
shipFrom: RelayPoint;
|
|
46
52
|
shipTo: RelayPoint;
|
|
@@ -50,7 +56,7 @@ export type Label = {
|
|
|
50
56
|
shipDate: string;
|
|
51
57
|
shipmentCost: Money;
|
|
52
58
|
shipmentId: string;
|
|
53
|
-
status:
|
|
59
|
+
status: LabelStatus;
|
|
54
60
|
trackable: boolean;
|
|
55
61
|
trackingNumber: string;
|
|
56
62
|
trackingStatus: string;
|