@shipengine/js-api 0.19.1 → 0.21.0

package/carriers/types.d.ts

@@ -52,15 +52,15 @@ export interface CarrierPackage {
  * @category Entities
  */
 export interface CarrierRatePackageFormat {
-    apiCode: string;
-    carrierPackageTypeCode: string;
-    description?: string;
-    dimensions?: DimensionsWithUnit;
-    id: string;
+    apiCode?: string;
+    carrierPackageTypeCode?: string;
+    description: string;
+    dimensions: DimensionsWithUnit;
+    maxWeight: WeightWithUnit;
     name: string;
+    packageId: string;
     packageTypeId?: string;
     status: string;
-    weight: WeightWithUnit;
 }
 /**
  * @category Entities

package/index.d.ts

@@ -21,3 +21,4 @@ export * from "./shipments";
 export * from "./utilities";
 export * from "./warehouses";
 export * from "./weight";
+export * from "./zones";

package/index.js

@@ -3291,6 +3291,14 @@ class RateCardsAPI {
     this.create = (rateCardInput) => {
       return this.client.post("/v1/rate_cards", rateCardInput);
     };
+    this.update = (rateCard) => {
+      return this.client.put(`/v1/rate_cards/${rateCard.id}`, rateCard);
+    };
+    this.download = (rateCardId) => {
+      return this.client.get(`/v1/rate_cards/${rateCardId}/rates/download`, {
+        responseType: "blob"
+      });
+    };
     this.client = client;
   }
 }
@@ -3482,12 +3490,17 @@ class ShipEngineAPI {
       transformRequest: [(data) => humpsExports.decamelizeKeys(data), (data) => JSON.stringify(data)],
       transformResponse: [
         (data) => {
-          if (data)
+          if (data && !(data instanceof Blob))
             return JSON.parse(data);
           else
-            return;
+            return data;
         },
-        (data) => humpsExports.camelizeKeys(data)
+        (data) => {
+          if (data && !(data instanceof Blob))
+            return humpsExports.camelizeKeys(data);
+          else
+            return data;
+        }
       ]
     });
     client.interceptors.response.use(

package/index.mjs

@@ -3287,6 +3287,14 @@ class RateCardsAPI {
     this.create = (rateCardInput) => {
       return this.client.post("/v1/rate_cards", rateCardInput);
     };
+    this.update = (rateCard) => {
+      return this.client.put(`/v1/rate_cards/${rateCard.id}`, rateCard);
+    };
+    this.download = (rateCardId) => {
+      return this.client.get(`/v1/rate_cards/${rateCardId}/rates/download`, {
+        responseType: "blob"
+      });
+    };
     this.client = client;
   }
 }
@@ -3478,12 +3486,17 @@ class ShipEngineAPI {
       transformRequest: [(data) => humpsExports.decamelizeKeys(data), (data) => JSON.stringify(data)],
       transformResponse: [
         (data) => {
-          if (data)
+          if (data && !(data instanceof Blob))
             return JSON.parse(data);
           else
-            return;
+            return data;
         },
-        (data) => humpsExports.camelizeKeys(data)
+        (data) => {
+          if (data && !(data instanceof Blob))
+            return humpsExports.camelizeKeys(data);
+          else
+            return data;
+        }
       ]
     });
     client.interceptors.response.use(

package/package.json

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

package/rate-cards/api.d.ts

@@ -7,4 +7,6 @@ export declare class RateCardsAPI {
         rateCards: RateCard[];
     }, any>>;
     create: (rateCardInput: RateCardInput) => Promise<import("axios").AxiosResponse<RateCard, any>>;
+    update: (rateCard: RateCard) => Promise<import("axios").AxiosResponse<RateCard, any>>;
+    download: (rateCardId: string) => Promise<import("axios").AxiosResponse<Blob, any>>;
 }

package/rate-cards/types.d.ts

@@ -1,6 +1,8 @@
 import { CarrierRatePackageFormat, CarrierService } from "../carriers";
 import { Currency } from "../payments";
+import { ISOString } from "../resources";
 import { WeightBandIncremental, WeightBandMinMax } from "../weight-band";
+import { Zone } from "../zones";
 /**
  * @category Entities
  */
@@ -8,19 +10,58 @@ export interface ShipFromLocation {
     countryCode: string;
     postalCode?: string;
 }
+/**
+ * @category Entities
+ */
+export interface RateSurcharge {
+    fixedAmount: {
+        currency: Currency;
+        value: number;
+    };
+    name: string;
+    surchargeCode: string;
+    surchargeId: string;
+}
 /**
  * @category Entities
  */
 export type RateService = Pick<CarrierService, "serviceCode" | "name"> & {
-    packageTypes: RatePackageType[];
+    packageTypes?: RatePackageType[];
+    surcharges?: RateSurcharge[];
+};
+/**
+ * @category Entities
+ */
+export type RateCardRate = {
+    currency: Currency;
+    value: number;
+};
+/**
+ * @category Entities
+ */
+export type ZoneWithRate = Zone & {
+    rate?: RateCardRate;
+    surcharges?: RateSurcharge[];
+};
+/**
+ * @category Entities
+ */
+export type RateWeightBandMinMax = WeightBandMinMax & {
+    zones?: ZoneWithRate[];
+};
+/**
+ * @category Entities
+ */
+export type RateWeightBandIncremental = WeightBandIncremental & {
+    zones?: ZoneWithRate[];
 };
 /**
  * @category Entities
  */
-export type RatePackageType = CarrierRatePackageFormat & {
-    weightBands: {
-        incrementalBands: WeightBandIncremental[];
-        minMaxBands: WeightBandMinMax[];
+export type RatePackageType = Pick<CarrierRatePackageFormat, "packageId" | "name" | "description" | "dimensions" | "maxWeight"> & {
+    weightBands?: {
+        incrementalBands?: RateWeightBandIncremental[];
+        minMaxBands?: RateWeightBandMinMax[];
     };
 };
 /**
@@ -28,14 +69,17 @@ export type RatePackageType = CarrierRatePackageFormat & {
  */
 export interface RateCard {
     carrierId: string;
+    createdAt?: ISOString;
     currency?: Currency;
-    endDate?: string;
+    endDate?: ISOString;
     id: string;
     name: string;
+    publishedAt?: ISOString;
     services?: RateService[];
     shipFrom?: ShipFromLocation;
-    startDate?: string;
+    startDate?: ISOString;
     status?: string;
+    surcharges?: RateSurcharge[];
 }
 /**
  * @category Entities

package/types.d.ts

@@ -19,3 +19,4 @@ export * from "./shipments/types";
 export * from "./warehouses/types";
 export * from "./weight/types";
 export * from "./weight-band/types";
+export * from "./zones/types";

package/zones/index.d.ts

@@ -0,0 +1 @@
+export * from "./types";

package/zones/types.d.ts

@@ -0,0 +1,8 @@
+/**
+ * @category Entities
+ */
+export type Zone = {
+    name: string;
+    zoneCode: string;
+    zoneId: string;
+};