@shipengine/js-api 4.1.0 → 4.2.0

package/index.js

@@ -4195,6 +4195,18 @@ class ShipmentsAPI {
     this.cancel = (shipmentId) => {
       return this.client.put(`/v1/shipments/${shipmentId}/cancel`);
     };
+    /**
+     * The `download` method allows for downloading a CSV document of shipments based on the provided parameters.
+     */
+    this.download = (params) => {
+      return this.client.get("/v1/shipments/downloads", {
+        headers: {
+          Accept: "text/csv"
+        },
+        params,
+        responseType: "blob"
+      });
+    };
     this.client = client;
   }
 }

package/index.mjs

@@ -4191,6 +4191,18 @@ class ShipmentsAPI {
     this.cancel = (shipmentId) => {
       return this.client.put(`/v1/shipments/${shipmentId}/cancel`);
     };
+    /**
+     * The `download` method allows for downloading a CSV document of shipments based on the provided parameters.
+     */
+    this.download = (params) => {
+      return this.client.get("/v1/shipments/downloads", {
+        headers: {
+          Accept: "text/csv"
+        },
+        params,
+        responseType: "blob"
+      });
+    };
     this.client = client;
   }
 }

package/package.json

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

package/shipments/api.d.ts

@@ -1,6 +1,6 @@
 import { AxiosInstance } from "axios";
-import { BatchableQuery, CreationRangeQuery, ModificationRangeQuery, PageableQuery, PageableResult, SortableQuery, TaggableQuery } from "../resources";
-import { Shipment, ShipmentRateResponse, ShipmentStatus } from "./types";
+import { PageableResult } from "../resources";
+import { DownloadShipmentsParams, ListShipmentOptions, Shipment, ShipmentRateResponse } from "./types";
 /**
  * # Shipments - Get Shipment Rates Options
  */
@@ -15,17 +15,6 @@ export type GetShipmentRatesOptions = {
      */
     shipmentId: string;
 };
-export type ListShipmentOptions = {
-    /**
-     * `salesOrderIds` is an array of sales order IDs to be used when listing sales
-     * orders.
-     */
-    salesOrderId?: string;
-    /**
-     * `shipmentStatus` is the current fulfillment status of the shipment.
-     */
-    shipmentStatus?: ShipmentStatus;
-} & BatchableQuery & PageableQuery & CreationRangeQuery & ModificationRangeQuery & SortableQuery & TaggableQuery;
 /**
  * # Shipments - List Shipments Result
  */
@@ -82,4 +71,8 @@ export declare class ShipmentsAPI {
      * https://shipengine.github.io/shipengine-openapi/#operation/cancel_shipments
      */
     cancel: (shipmentId: string) => Promise<import("axios").AxiosResponse<any, any>>;
+    /**
+     * The `download` method allows for downloading a CSV document of shipments based on the provided parameters.
+     */
+    download: (params?: DownloadShipmentsParams) => Promise<import("axios").AxiosResponse<Blob, any>>;
 }

package/shipments/types.d.ts

@@ -4,7 +4,7 @@ import { CodedError } from "../errors";
 import { OrderSourceCode } from "../order-sources";
 import { Money } from "../payments";
 import { Rate } from "../rates";
-import { Download, LinkedResource } from "../resources";
+import { BatchableQuery, CreationRangeQuery, Download, LinkedResource, ModificationRangeQuery, PageableQuery, SortableQuery, TaggableQuery } from "../resources";
 import { WeightWithUnit } from "../weight";
 export type AddressValidationOptions = "no_validation" | "validate_only" | "validate_and_clean";
 export type CustomsContents = "documents" | "gift" | "merchandise" | "returned_goods" | "sample";
@@ -254,3 +254,33 @@ export type ShipmentRateResponse = {
     shipmentId: string;
     status: "working" | "completed" | "partial" | "error";
 }[];
+export type ListShipmentOptions = {
+    /**
+     * `batchId` is an optional string to retrieve shipments within a given batch.
+     */
+    batchId?: string;
+    /**
+     * `salesOrderIds` is an array of sales order IDs to be used when listing sales
+     * orders.
+     */
+    salesOrderId?: string;
+    /**
+     * Specific shipment number to filter by
+     */
+    shipmentNumber?: string;
+    /**
+     * `shipmentStatus` is the current fulfillment status of the shipment.
+     */
+    shipmentStatus?: ShipmentStatus;
+} & BatchableQuery & PageableQuery & CreationRangeQuery & ModificationRangeQuery & SortableQuery & TaggableQuery;
+export type ShipmentColumns = "shipment_id" | "packages" | "recipient" | "shipping_service" | "created_date" | "modified_at" | "status";
+export type DownloadShipmentsParams = {
+    /**
+     * CSV column names to export
+     */
+    columns?: ShipmentColumns[];
+    /**
+     * Specific shipment ID to filter by
+     */
+    shipmentId?: string;
+} & ListShipmentOptions;