@shipengine/js-api 4.2.1 → 4.3.0

package/index.js

@@ -3725,10 +3725,10 @@ class LabelsAPI {
       return this.client.put(`/v1/labels/${labelId}/void`);
     };
     /**
-     * The `download` method allows for downloading a CSV document of labels based on the provided parameters.
+     * The `export` method allows to export a CSV document of labels based on the provided parameters.
      */
-    this.download = (params) => {
-      return this.client.get("/v1/labels/downloads", {
+    this.export = (params) => {
+      return this.client.get("/v1/labels/export", {
         headers: {
           Accept: "text/csv"
         },
@@ -4197,10 +4197,10 @@ class ShipmentsAPI {
       return this.client.put(`/v1/shipments/${shipmentId}/cancel`);
     };
     /**
-     * The `download` method allows for downloading a CSV document of shipments based on the provided parameters.
+     * The `export` method allows to export a CSV document of shipments based on the provided parameters.
      */
-    this.download = (params) => {
-      return this.client.get("/v1/shipments/downloads", {
+    this.export = (params) => {
+      return this.client.get("/v1/shipments/export", {
         headers: {
           Accept: "text/csv"
         },

package/index.mjs

@@ -3721,10 +3721,10 @@ class LabelsAPI {
       return this.client.put(`/v1/labels/${labelId}/void`);
     };
     /**
-     * The `download` method allows for downloading a CSV document of labels based on the provided parameters.
+     * The `export` method allows to export a CSV document of labels based on the provided parameters.
      */
-    this.download = (params) => {
-      return this.client.get("/v1/labels/downloads", {
+    this.export = (params) => {
+      return this.client.get("/v1/labels/export", {
         headers: {
           Accept: "text/csv"
         },
@@ -4193,10 +4193,10 @@ class ShipmentsAPI {
       return this.client.put(`/v1/shipments/${shipmentId}/cancel`);
     };
     /**
-     * The `download` method allows for downloading a CSV document of shipments based on the provided parameters.
+     * The `export` method allows to export a CSV document of shipments based on the provided parameters.
      */
-    this.download = (params) => {
-      return this.client.get("/v1/shipments/downloads", {
+    this.export = (params) => {
+      return this.client.get("/v1/shipments/export", {
         headers: {
           Accept: "text/csv"
         },

package/labels/api.d.ts

@@ -1,5 +1,5 @@
 import { AxiosInstance } from "axios";
-import { CreateLabelOptions, DownloadLabelsParams, Label, ListLabelsParams, ListLabelsResult, VoidRequest } from "./types";
+import { CreateLabelOptions, ExportLabelsParams, Label, ListLabelsParams, ListLabelsResult, VoidRequest } from "./types";
 /**
  * # Labels API module - /v1/labels
  */
@@ -33,7 +33,7 @@ export declare class LabelsAPI {
      */
     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.
+     * The `export` method allows to export a CSV document of labels based on the provided parameters.
      */
-    download: (params?: DownloadLabelsParams) => Promise<import("axios").AxiosResponse<Blob, any>>;
+    export: (params?: ExportLabelsParams) => Promise<import("axios").AxiosResponse<Blob, any>>;
 }

package/labels/types.d.ts

@@ -143,7 +143,7 @@ export interface CreateLabelOptions {
      */
     validateAddress?: string;
 }
-export type DownloadLabelsParams = {
+export type ExportLabelsParams = {
     /**
      * CSV column names to export
      */

package/package.json

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

package/shipments/api.d.ts

@@ -1,6 +1,6 @@
 import { AxiosInstance } from "axios";
 import { PageableResult } from "../resources";
-import { DownloadShipmentsParams, ListShipmentOptions, Shipment, ShipmentRateResponse } from "./types";
+import { ExportShipmentsParams, ListShipmentOptions, Shipment, ShipmentRateResponse } from "./types";
 /**
  * # Shipments - Get Shipment Rates Options
  */
@@ -72,7 +72,7 @@ export declare class ShipmentsAPI {
      */
     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.
+     * The `export` method allows to export a CSV document of shipments based on the provided parameters.
      */
-    download: (params?: DownloadShipmentsParams) => Promise<import("axios").AxiosResponse<Blob, any>>;
+    export: (params?: ExportShipmentsParams) => Promise<import("axios").AxiosResponse<Blob, any>>;
 }

package/shipments/types.d.ts

@@ -274,7 +274,7 @@ export type ListShipmentOptions = {
     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 = {
+export type ExportShipmentsParams = {
     /**
      * CSV column names to export
      */