@shipengine/js-api 0.48.1 → 0.48.2
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 +5 -3
- package/package.json +1 -1
package/labels/api.d.ts
CHANGED
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
import { AxiosInstance } from "axios";
|
|
2
|
+
import { PageableResult } from "../resources";
|
|
2
3
|
import { Label, LabelLayout, VoidRequest } from "./types";
|
|
3
4
|
/**
|
|
4
5
|
* # Labels API - Create Label Options
|
|
@@ -42,6 +43,9 @@ export interface ListLabelsParams {
|
|
|
42
43
|
*/
|
|
43
44
|
shipmentId?: string;
|
|
44
45
|
}
|
|
46
|
+
export type ListLabelsResult = {
|
|
47
|
+
labels: Label[];
|
|
48
|
+
} & PageableResult;
|
|
45
49
|
/**
|
|
46
50
|
* # Labels API module - /v1/labels
|
|
47
51
|
*/
|
|
@@ -55,9 +59,7 @@ export declare class LabelsAPI {
|
|
|
55
59
|
/**
|
|
56
60
|
* The `list` method retrieves a list of labels created by a given user.
|
|
57
61
|
*/
|
|
58
|
-
list: (params?: ListLabelsParams) => Promise<import("axios").AxiosResponse<
|
|
59
|
-
labels: Label[];
|
|
60
|
-
}, any>>;
|
|
62
|
+
list: (params?: ListLabelsParams) => Promise<import("axios").AxiosResponse<ListLabelsResult, any>>;
|
|
61
63
|
/**
|
|
62
64
|
* The `createByRateId` allows you to create a shipping label by using a `rateId`
|
|
63
65
|
* which is a unique identifier tied to a specific rate.
|