@shipengine/js-api 0.16.2 → 0.18.0

package/carriers/api.d.ts

@@ -1,6 +1,6 @@
 import { AxiosInstance } from "axios";
 import { Currency, Money } from "../payments";
-import { Carrier, CarrierAutoFundingSettings, CarrierAutoFundingSettingsResponse, CarrierConnection, WalletTransactionHistory } from "./types";
+import { Carrier, CarrierAutoFundingSettings, CarrierAutoFundingSettingsResponse, CarrierConnection, CarrierRatePackageFormat, CarrierService, WalletTransactionHistory } from "./types";
 export declare class CarriersAPI {
     private client;
     constructor(client: AxiosInstance);
@@ -15,6 +15,12 @@ export declare class CarriersAPI {
     updateAutoFunding: (carrierId: string, options: CarrierAutoFundingSettings) => Promise<import("axios").AxiosResponse<CarrierAutoFundingSettingsResponse, any>>;
     getAutoFunding: (carrierId: string) => Promise<import("axios").AxiosResponse<CarrierAutoFundingSettingsResponse, any>>;
     getWalletHistory: (startDate: Date, endDate: Date, page: number) => Promise<import("axios").AxiosResponse<WalletTransactionHistory, any>>;
+    getServices: (carrierId: string) => Promise<import("axios").AxiosResponse<{
+        services: CarrierService[];
+    }, any>>;
+    getRatePackageFormats: (carrierId: string) => Promise<import("axios").AxiosResponse<{
+        ratePackageFormats: CarrierRatePackageFormat[];
+    }, any>>;
     getCountries: (carrierId: string) => Promise<import("axios").AxiosResponse<{
         countries: string[];
     }, any>>;

package/carriers/types.d.ts

@@ -1,6 +1,7 @@
 import { Address } from "../addresses";
 import { DimensionsWithUnit } from "../dimensions";
 import { CreditCard, Money } from "../payments";
+import { WeightWithUnit } from "../weight";
 /**
  * @category Entities
  */
@@ -47,6 +48,20 @@ export interface CarrierPackage {
     packageCode: string;
     packageId?: string;
 }
+/**
+ * @category Entities
+ */
+export interface CarrierRatePackageFormat {
+    apiCode: string;
+    carrierPackageTypeCode: string;
+    description?: string;
+    dimensions?: DimensionsWithUnit;
+    id: string;
+    name: string;
+    packageTypeId?: string;
+    status: string;
+    weight: WeightWithUnit;
+}
 /**
  * @category Entities
  */

package/dimensions/types.d.ts

@@ -6,8 +6,13 @@ export type DimensionUnit = "inch" | "centimeter";
  * @category Entities
  */
 export interface Dimensions {
+    girth?: number;
     height: number;
     length: number;
+    lengthPlusGirth?: number;
+    noThreeSidesExceed?: number;
+    noTwoSidesExceed?: number;
+    volume?: number;
     width: number;
 }
 /**

package/index.js

@@ -952,6 +952,14 @@ class CarriersAPI {
         }
       });
     };
+    this.getServices = (carrierId) => {
+      return this.client.get(`/v1/carriers/${carrierId}/services`);
+    };
+    this.getRatePackageFormats = (carrierId) => {
+      return this.client.get(
+        `/v1/carriers/${carrierId}/rate_package_formats`
+      );
+    };
     this.getCountries = (carrierId) => {
       return this.client.get(`/v1/carriers/${carrierId}/countries`);
     };
@@ -3280,6 +3288,9 @@ class RateCardsAPI {
         `/v1/rate_cards?carrier_ids=${carrierIds.toString()}`
       );
     };
+    this.create = (rateCardInput) => {
+      return this.client.post("/v1/rate_cards", rateCardInput);
+    };
     this.client = client;
   }
 }

package/index.mjs

@@ -948,6 +948,14 @@ class CarriersAPI {
         }
       });
     };
+    this.getServices = (carrierId) => {
+      return this.client.get(`/v1/carriers/${carrierId}/services`);
+    };
+    this.getRatePackageFormats = (carrierId) => {
+      return this.client.get(
+        `/v1/carriers/${carrierId}/rate_package_formats`
+      );
+    };
     this.getCountries = (carrierId) => {
       return this.client.get(`/v1/carriers/${carrierId}/countries`);
     };
@@ -3276,6 +3284,9 @@ class RateCardsAPI {
         `/v1/rate_cards?carrier_ids=${carrierIds.toString()}`
       );
     };
+    this.create = (rateCardInput) => {
+      return this.client.post("/v1/rate_cards", rateCardInput);
+    };
     this.client = client;
   }
 }

package/package.json

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

package/rate-cards/api.d.ts

@@ -1,9 +1,10 @@
 import { AxiosInstance } from "axios";
-import { RateCard } from "./types";
+import { RateCard, RateCardInput } from "./types";
 export declare class RateCardsAPI {
     private client;
     constructor(client: AxiosInstance);
     list: (carrierIds: string[]) => Promise<import("axios").AxiosResponse<{
         rateCards: RateCard[];
     }, any>>;
+    create: (rateCardInput: RateCardInput) => Promise<import("axios").AxiosResponse<RateCard, any>>;
 }

package/rate-cards/types.d.ts

@@ -1,4 +1,6 @@
+import { CarrierRatePackageFormat, CarrierService } from "../carriers";
 import { Currency } from "../payments";
+import { WeightBandIncremental, WeightBandMinMax } from "../weight-band";
 /**
  * @category Entities
  */
@@ -6,16 +8,36 @@ export interface ShipFromLocation {
     countryCode: string;
     postalCode?: string;
 }
+/**
+ * @category Entities
+ */
+export type RateService = Pick<CarrierService, "serviceCode"> & {
+    packageTypes: RatePackageType[];
+};
+/**
+ * @category Entities
+ */
+export type RatePackageType = CarrierRatePackageFormat & {
+    weightBands: {
+        incrementalBands: WeightBandIncremental[];
+        minMaxBands: WeightBandMinMax[];
+    };
+};
 /**
  * @category Entities
  */
 export interface RateCard {
     carrierId: string;
-    currency: Currency;
+    currency?: Currency;
     endDate?: string;
     id: string;
     name: string;
-    shipFrom: ShipFromLocation;
-    startDate: string;
-    status: string;
+    services?: RateService[];
+    shipFrom?: ShipFromLocation;
+    startDate?: string;
+    status?: string;
 }
+/**
+ * @category Entities
+ */
+export type RateCardInput = Partial<RateCard> & Pick<RateCard, "carrierId" | "name">;

package/types.d.ts

@@ -18,3 +18,4 @@ export * from "./sales-orders/types";
 export * from "./shipments/types";
 export * from "./warehouses/types";
 export * from "./weight/types";
+export * from "./weight-band/types";

package/utilities/index.d.ts

@@ -1 +1,2 @@
 export * from "./ip-address";
+export * from "./types";

package/utilities/types.d.ts

@@ -0,0 +1 @@
+export type RequireField<T, K extends keyof T> = T & Required<Pick<T, K>>;

package/weight-band/index.d.ts

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

package/weight-band/types.d.ts

@@ -0,0 +1,17 @@
+import { WeightUnit } from "../weight";
+/**
+ * @category Entities
+ */
+export type WeightBandIncremental = {
+    increment: number;
+    minimum: number;
+    unit: WeightUnit;
+};
+/**
+ * @category Entities
+ */
+export type WeightBandMinMax = {
+    maximum: number;
+    minimum: number;
+    unit: WeightUnit;
+};