@shipengine/js-api 4.0.0 → 4.1.0

package/auctane-pay/types.d.ts

@@ -24,16 +24,16 @@ export type AuctanePayTransactionCategory = "add_funds" | "subscription" | "stor
  * @category Entities
  */
 export interface CreateSessionRequest {
+    /**
+     * Category of the transaction
+     * @example "add_funds"
+     */
+    paymentPreferences: AuctanePayTransactionCategory[];
     /**
      * URL to redirect after payment session completion
      * @example "https://dashboard.shipengine.com/?sessionId=:id"
      */
     returnUrl?: string;
-    /**
-     * Category of the transaction
-     * @example "add_funds"
-     */
-    transactionCategory: AuctanePayTransactionCategory;
 }
 /**
  * @category Entities

package/index.js

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

package/index.mjs

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

package/labels/api.d.ts

@@ -1,5 +1,5 @@
 import { AxiosInstance } from "axios";
-import { CreateLabelOptions, Label, ListLabelsParams, ListLabelsResult, VoidRequest } from "./types";
+import { CreateLabelOptions, DownloadLabelsParams, Label, ListLabelsParams, ListLabelsResult, VoidRequest } from "./types";
 /**
  * # Labels API module - /v1/labels
  */
@@ -32,4 +32,8 @@ export declare class LabelsAPI {
      * The `void` method allows a user to void a label by `labelId`.
      */
     void: (labelId: string) => Promise<import("axios").AxiosResponse<VoidRequest, any>>;
+    /**
+     * The `download` method allows for downloading a CSV document of labels based on the provided parameters.
+     */
+    download: (params?: DownloadLabelsParams) => Promise<import("axios").AxiosResponse<Blob, any>>;
 }

package/labels/types.d.ts

@@ -10,6 +10,7 @@ export type LabelFormat = "pdf" | "png" | "zpl";
 export type LabelLayout = "4x6" | "letter";
 export type LabelStatus = "processing" | "completed" | "error" | "voided";
 export type LabelTrackingStatus = "unknown" | "in_transit" | "delivered" | "error";
+export type LabelColumns = "shipment_id" | "label_id" | "external_order_id" | "external_shipment_id" | "packages" | "recipient" | "shipping_service" | "created_date" | "ship_date" | "status" | "tracking_status";
 export type Label = {
     alternativeIdentifiers?: string[];
     batchId: string;
@@ -142,3 +143,13 @@ export interface CreateLabelOptions {
      */
     validateAddress?: string;
 }
+export type DownloadLabelsParams = {
+    /**
+     * CSV column names to export
+     */
+    columns?: LabelColumns[];
+    /**
+     * Specific label ID to filter by
+     */
+    labelId?: string;
+} & ListLabelsParams;

package/package.json

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