@shipengine/js-api 0.48.1 → 0.48.3

package/labels/api.d.ts

@@ -1,4 +1,5 @@
 import { AxiosInstance } from "axios";
+import { CreationRangeQuery, PageableQuery, PageableResult, SortableQuery } from "../resources";
 import { Label, LabelLayout, VoidRequest } from "./types";
 /**
  * # Labels API - Create Label Options
@@ -35,13 +36,47 @@ export interface CreateLabelOptions {
 /**
  * # Labels API - List Labels Params
  */
-export interface ListLabelsParams {
+export type ListLabelsParams = {
+    /**
+     * `batchId` is an optional string to retrieve labels within a given batch.
+     */
+    batchId?: string;
+    /**
+     * `carrierId` is an optional string to limit results to only lables for
+     * a specific carrier.
+     */
+    carrierId?: string;
+    /**
+     * `labelStatus` optionally allows filtering results to a specific status.
+     */
+    labelStatus?: Label["status"];
+    /**
+     * `rateId` is an optional string to return labels purchased with a
+     * specific rate.
+     */
+    rateId?: string;
+    /**
+     * `serviceCode` is an optional string to limit results to only labels for
+     * a specific carrier service.
+     */
+    serviceCode?: string;
     /**
      * `shipmentId` is an optional string to filter labels by shipment ID. This
      * is a unique identifier that ShipEngine API associates with your shipment.
      */
     shipmentId?: string;
-}
+    /** `trackingNumber` is an optional string to retrieve labels for a specific
+     * tracking number
+     */
+    trackingNumber?: string;
+    /** `warehouseId` is an optional string to limit results to only those
+     * originating from a specific warehouse.
+     */
+    warehouseId?: string;
+} & PageableQuery & CreationRangeQuery & SortableQuery<"created_at" | "modified_at" | "order_date">;
+export type ListLabelsResult = {
+    labels: Label[];
+} & PageableResult;
 /**
  * # Labels API module - /v1/labels
  */
@@ -55,9 +90,7 @@ export declare class LabelsAPI {
     /**
      * The `list` method retrieves a list of labels created by a given user.
      */
-    list: (params?: ListLabelsParams) => Promise<import("axios").AxiosResponse<{
-        labels: Label[];
-    }, any>>;
+    list: (params?: ListLabelsParams) => Promise<import("axios").AxiosResponse<ListLabelsResult, any>>;
     /**
      * The `createByRateId` allows you to create a shipping label by using a `rateId`
      * which is a unique identifier tied to a specific rate.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shipengine/js-api",
-  "version": "0.48.1",
+  "version": "0.48.3",
   "main": "./index.js",
   "types": "./index.d.ts",
   "exports": {

package/sales-order-shipments/api.d.ts

@@ -51,6 +51,10 @@ export type ListSalesOrderShipmentsParams = {
      * querying sales orders.
      */
     salesOrderIds?: string[];
+    /**
+     * `shipmentIds` is an optional array of shipment IDs to fetch.
+     */
+    shipmentIds?: string[];
 } & PageableQuery & CreationRangeQuery & ModificationRangeQuery & SortableQuery<"created_at" | "modified_at" | "order_date">;
 /**
  * # Sales Order Shipments - List Sales Order Shipments Body