@shipengine/js-api 1.21.0 → 1.23.0

package/connections/api.d.ts

@@ -1,5 +1,5 @@
 import { AxiosInstance } from "axios";
-import { CarrierServicesListResponse, ConnectCarrierAccount, ConnectCarrierAccountResponse, GetCarrierConnectionFormParams, GetCarrierConnectionFormResponse, ListCarrierConnectionsParams, ListCarrierConnectionsResponse } from "./types";
+import { CarrierServicesListResponse, ConnectCarrierAccount, ConnectCarrierAccountResponse, ConnectionsCarrierName, ConnectionsCarrierSettingsData, ConnectionsCarrierSettingsResponse, GetCarrierConnectionFormParams, GetCarrierConnectionFormResponse, ListCarrierConnectionsParams, ListCarrierConnectionsResponse } from "./types";
 /**
  * # Connections API module - /v1/connections
  */
@@ -24,4 +24,14 @@ export declare class ConnectionsAPI {
      * identified by the `carrier_code`.
      */
     getCarrierConnectionsServicesList: (carrierCode: string) => Promise<import("axios").AxiosResponse<CarrierServicesListResponse, any>>;
+    /**
+     * The `getCarrierSettings` method retrieves the settings for a given carrier,
+     * identified by the `carrierName` and `carrierCode`.
+     */
+    getCarrierSettings: <T extends ConnectionsCarrierName>(carrierName: T, carrierCode: string) => Promise<import("axios").AxiosResponse<ConnectionsCarrierSettingsResponse<T>, any>>;
+    /**
+     * The `updateCarrierSettings` method updates the settings for a given carrier,
+     * identified by the `carrierName` and `carrierCode`.
+     */
+    updateCarrierSettings: <T extends ConnectionsCarrierName>(carrierName: T, carrierCode: string, formData: ConnectionsCarrierSettingsData<T>) => Promise<import("axios").AxiosResponse<void, any>>;
 }

package/connections/settings-types.d.ts

@@ -0,0 +1,42 @@
+export type DHLExpressSettings = {
+    isPrimaryAccount: boolean;
+    nickname: string;
+    shouldHideAccountNumberOnArchiveDoc: boolean;
+};
+export type FedexSettings = {
+    isPrimaryAccount: boolean;
+    letterheadImage?: string;
+    nickname: string;
+    pickupType: "none" | "regular_pickup" | "request_courier" | "drop_box" | "business_service_center" | "station";
+    signatureImage?: string;
+    smartPostEndorsement: "none" | "return_service_requested" | "forwarding_service_requested" | "address_service_requested" | "change_service_requested" | "leave_if_no_response";
+    smartPostHub: "none" | "allentown_pa" | "atlanta_ga" | "baltimore_md" | "charlotte_nc" | "chino_ca" | "dallas_tx" | "denver_co" | "detroit_mi" | "edison_nj" | "grove_city_oh" | "groveport_oh" | "houston_tx" | "indianapolis_in" | "kansas_city_ks" | "los_angeles_ca" | "martinsburg_wv" | "memphis_tn" | "minneapolis_mn" | "new_berlin_wi" | "northborough_ma" | "orlando_fl" | "phoneix_az" | "pittsburgh_pa" | "reno_nv" | "sacramento_ca" | "salt_lake_city_ut" | "seattle_wa" | "st_louis_mo" | "windsor_ct" | "newark_ny" | "south_brunswick_nj" | "scranton_pa" | "wheeling_il";
+};
+export type UPSSettings = {
+    accountCountryCode: string;
+    accountNumber: string;
+    accountPostalCode: string;
+    invoice?: {
+        controlId: string;
+        invoiceAmount: number;
+        invoiceCurrencyCode: string;
+        invoiceDate: string;
+        invoiceNumber: string;
+    };
+    isPrimaryAccount: boolean;
+    mailInnovationsCostCenter?: string;
+    mailInnovationsCustomerGuid?: string;
+    mailInnovationsCustomerId?: string;
+    mailInnovationsEndorsement: "none" | "return_service_requested" | "forwarding_service_requested" | "address_service_requested" | "change_service_requested" | "leave_if_no_response";
+    nickname: string;
+    pickupType: "daily_pickup" | "occasional_pickup" | "customer_counter";
+    useCarbonNeutralShippingProgram: boolean;
+    useConsolidationServices: boolean;
+    useGroundFreightPricing: boolean;
+    useNegotiatedRates: boolean;
+    useOrderNumberOnMailInnovationsLabels: boolean;
+};
+export type UPSUpdateSettings = Omit<UPSSettings, "accountNumber">;
+export type ConnectionsCarrierName = "dhl_express" | "fedex" | "ups";
+export type ConnectionsCarrierSettingsResponse<Name extends ConnectionsCarrierName = ConnectionsCarrierName> = Name extends "dhl_express" ? DHLExpressSettings : Name extends "fedex" ? FedexSettings : Name extends "ups" ? UPSSettings : never;
+export type ConnectionsCarrierSettingsData<Name extends ConnectionsCarrierName = ConnectionsCarrierName> = Name extends "dhl_express" ? DHLExpressSettings : Name extends "fedex" ? FedexSettings : Name extends "ups" ? UPSUpdateSettings : never;

package/connections/types.d.ts

@@ -49,3 +49,4 @@ export type CarrierProviderService = Pick<CarrierService, "name" | "serviceCode"
 export type CarrierServicesListResponse = {
     services: CarrierProviderService[];
 };
+export * from "./settings-types";

package/index.js

@@ -10,17 +10,17 @@ var AccountBillingPlanChangeType = /* @__PURE__ */ ((AccountBillingPlanChangeTyp
   return AccountBillingPlanChangeType2;
 })(AccountBillingPlanChangeType || {});
 
-var __getOwnPropSymbols$5 = Object.getOwnPropertySymbols;
-var __hasOwnProp$5 = Object.prototype.hasOwnProperty;
-var __propIsEnum$5 = Object.prototype.propertyIsEnumerable;
+var __getOwnPropSymbols$6 = Object.getOwnPropertySymbols;
+var __hasOwnProp$6 = Object.prototype.hasOwnProperty;
+var __propIsEnum$6 = Object.prototype.propertyIsEnumerable;
 var __objRest$2 = (source, exclude) => {
   var target = {};
   for (var prop in source)
-    if (__hasOwnProp$5.call(source, prop) && exclude.indexOf(prop) < 0)
+    if (__hasOwnProp$6.call(source, prop) && exclude.indexOf(prop) < 0)
       target[prop] = source[prop];
-  if (source != null && __getOwnPropSymbols$5)
-    for (var prop of __getOwnPropSymbols$5(source)) {
-      if (exclude.indexOf(prop) < 0 && __propIsEnum$5.call(source, prop))
+  if (source != null && __getOwnPropSymbols$6)
+    for (var prop of __getOwnPropSymbols$6(source)) {
+      if (exclude.indexOf(prop) < 0 && __propIsEnum$6.call(source, prop))
         target[prop] = source[prop];
     }
   return target;
@@ -142,17 +142,17 @@ const types = /*#__PURE__*/Object.freeze(/*#__PURE__*/Object.defineProperty({
   RateCardStatus
 }, Symbol.toStringTag, { value: 'Module' }));
 
-var __getOwnPropSymbols$4 = Object.getOwnPropertySymbols;
-var __hasOwnProp$4 = Object.prototype.hasOwnProperty;
-var __propIsEnum$4 = Object.prototype.propertyIsEnumerable;
+var __getOwnPropSymbols$5 = Object.getOwnPropertySymbols;
+var __hasOwnProp$5 = Object.prototype.hasOwnProperty;
+var __propIsEnum$5 = Object.prototype.propertyIsEnumerable;
 var __objRest$1 = (source, exclude) => {
   var target = {};
   for (var prop in source)
-    if (__hasOwnProp$4.call(source, prop) && exclude.indexOf(prop) < 0)
+    if (__hasOwnProp$5.call(source, prop) && exclude.indexOf(prop) < 0)
       target[prop] = source[prop];
-  if (source != null && __getOwnPropSymbols$4)
-    for (var prop of __getOwnPropSymbols$4(source)) {
-      if (exclude.indexOf(prop) < 0 && __propIsEnum$4.call(source, prop))
+  if (source != null && __getOwnPropSymbols$5)
+    for (var prop of __getOwnPropSymbols$5(source)) {
+      if (exclude.indexOf(prop) < 0 && __propIsEnum$5.call(source, prop))
         target[prop] = source[prop];
     }
   return target;
@@ -996,21 +996,21 @@ const getEndUserIpAddress = () => __async$5(void 0, null, function* () {
   }
 });
 
-var __defProp$3 = Object.defineProperty;
+var __defProp$4 = Object.defineProperty;
 var __defProps$1 = Object.defineProperties;
 var __getOwnPropDescs$1 = Object.getOwnPropertyDescriptors;
-var __getOwnPropSymbols$3 = Object.getOwnPropertySymbols;
-var __hasOwnProp$3 = Object.prototype.hasOwnProperty;
-var __propIsEnum$3 = Object.prototype.propertyIsEnumerable;
-var __defNormalProp$3 = (obj, key, value) => key in obj ? __defProp$3(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
-var __spreadValues$3 = (a, b) => {
+var __getOwnPropSymbols$4 = Object.getOwnPropertySymbols;
+var __hasOwnProp$4 = Object.prototype.hasOwnProperty;
+var __propIsEnum$4 = Object.prototype.propertyIsEnumerable;
+var __defNormalProp$4 = (obj, key, value) => key in obj ? __defProp$4(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __spreadValues$4 = (a, b) => {
   for (var prop in b || (b = {}))
-    if (__hasOwnProp$3.call(b, prop))
-      __defNormalProp$3(a, prop, b[prop]);
-  if (__getOwnPropSymbols$3)
-    for (var prop of __getOwnPropSymbols$3(b)) {
-      if (__propIsEnum$3.call(b, prop))
-        __defNormalProp$3(a, prop, b[prop]);
+    if (__hasOwnProp$4.call(b, prop))
+      __defNormalProp$4(a, prop, b[prop]);
+  if (__getOwnPropSymbols$4)
+    for (var prop of __getOwnPropSymbols$4(b)) {
+      if (__propIsEnum$4.call(b, prop))
+        __defNormalProp$4(a, prop, b[prop]);
     }
   return a;
 };
@@ -1018,11 +1018,11 @@ var __spreadProps$1 = (a, b) => __defProps$1(a, __getOwnPropDescs$1(b));
 var __objRest = (source, exclude) => {
   var target = {};
   for (var prop in source)
-    if (__hasOwnProp$3.call(source, prop) && exclude.indexOf(prop) < 0)
+    if (__hasOwnProp$4.call(source, prop) && exclude.indexOf(prop) < 0)
       target[prop] = source[prop];
-  if (source != null && __getOwnPropSymbols$3)
-    for (var prop of __getOwnPropSymbols$3(source)) {
-      if (exclude.indexOf(prop) < 0 && __propIsEnum$3.call(source, prop))
+  if (source != null && __getOwnPropSymbols$4)
+    for (var prop of __getOwnPropSymbols$4(source)) {
+      if (exclude.indexOf(prop) < 0 && __propIsEnum$4.call(source, prop))
         target[prop] = source[prop];
     }
   return target;
@@ -1070,7 +1070,7 @@ class CarriersAPI {
       const endUserIpAddress = yield getEndUserIpAddress();
       if (!endUserIpAddress)
         return Promise.reject([new CodedError("Unable to get IP address")]);
-      return yield this.client.post(`/v1/registration/${carrierCode}`, __spreadProps$1(__spreadValues$3({}, connection), {
+      return yield this.client.post(`/v1/registration/${carrierCode}`, __spreadProps$1(__spreadValues$4({}, connection), {
         endUserIpAddress
       }));
     });
@@ -1221,6 +1221,25 @@ class ConnectionsAPI {
         `/v1/connections/carriers/${carrierCode}/services`
       );
     };
+    /**
+     * The `getCarrierSettings` method retrieves the settings for a given carrier,
+     * identified by the `carrierName` and `carrierCode`.
+     */
+    this.getCarrierSettings = (carrierName, carrierCode) => {
+      return this.client.get(
+        `/v1/connections/carriers/${carrierName}/${carrierCode}/settings`
+      );
+    };
+    /**
+     * The `updateCarrierSettings` method updates the settings for a given carrier,
+     * identified by the `carrierName` and `carrierCode`.
+     */
+    this.updateCarrierSettings = (carrierName, carrierCode, formData) => {
+      return this.client.put(
+        `/v1/connections/carriers/${carrierName}/${carrierCode}/settings`,
+        formData
+      );
+    };
     this.client = client;
   }
 }
@@ -3434,19 +3453,19 @@ class CustomPackagesAPI {
   }
 }
 
-var __defProp$2 = Object.defineProperty;
-var __getOwnPropSymbols$2 = Object.getOwnPropertySymbols;
-var __hasOwnProp$2 = Object.prototype.hasOwnProperty;
-var __propIsEnum$2 = Object.prototype.propertyIsEnumerable;
-var __defNormalProp$2 = (obj, key, value) => key in obj ? __defProp$2(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
-var __spreadValues$2 = (a, b) => {
+var __defProp$3 = Object.defineProperty;
+var __getOwnPropSymbols$3 = Object.getOwnPropertySymbols;
+var __hasOwnProp$3 = Object.prototype.hasOwnProperty;
+var __propIsEnum$3 = Object.prototype.propertyIsEnumerable;
+var __defNormalProp$3 = (obj, key, value) => key in obj ? __defProp$3(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __spreadValues$3 = (a, b) => {
   for (var prop in b || (b = {}))
-    if (__hasOwnProp$2.call(b, prop))
-      __defNormalProp$2(a, prop, b[prop]);
-  if (__getOwnPropSymbols$2)
-    for (var prop of __getOwnPropSymbols$2(b)) {
-      if (__propIsEnum$2.call(b, prop))
-        __defNormalProp$2(a, prop, b[prop]);
+    if (__hasOwnProp$3.call(b, prop))
+      __defNormalProp$3(a, prop, b[prop]);
+  if (__getOwnPropSymbols$3)
+    for (var prop of __getOwnPropSymbols$3(b)) {
+      if (__propIsEnum$3.call(b, prop))
+        __defNormalProp$3(a, prop, b[prop]);
     }
   return a;
 };
@@ -3494,7 +3513,7 @@ class FundingSourcesAPI {
       if (!endUserIpAddress) {
         return Promise.reject([new CodedError("Unable to get IP address")]);
       }
-      return yield this.client.post("/v1/funding_sources", __spreadValues$2({
+      return yield this.client.post("/v1/funding_sources", __spreadValues$3({
         endUserIpAddress
       }, createFundingSource));
     });
@@ -3526,7 +3545,7 @@ class FundingSourcesAPI {
       if (!endUserIpAddress) {
         return Promise.reject([new CodedError("Unable to get IP address")]);
       }
-      return yield this.client.post("/v1/registration/funding_source", __spreadValues$2({
+      return yield this.client.post("/v1/registration/funding_source", __spreadValues$3({
         endUserIpAddress
       }, carrier));
     });
@@ -3731,6 +3750,22 @@ class RateCardsAPI {
   }
 }
 
+var __defProp$2 = Object.defineProperty;
+var __getOwnPropSymbols$2 = Object.getOwnPropertySymbols;
+var __hasOwnProp$2 = Object.prototype.hasOwnProperty;
+var __propIsEnum$2 = Object.prototype.propertyIsEnumerable;
+var __defNormalProp$2 = (obj, key, value) => key in obj ? __defProp$2(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __spreadValues$2 = (a, b) => {
+  for (var prop in b || (b = {}))
+    if (__hasOwnProp$2.call(b, prop))
+      __defNormalProp$2(a, prop, b[prop]);
+  if (__getOwnPropSymbols$2)
+    for (var prop of __getOwnPropSymbols$2(b)) {
+      if (__propIsEnum$2.call(b, prop))
+        __defNormalProp$2(a, prop, b[prop]);
+    }
+  return a;
+};
 class RatesAPI {
   constructor(client) {
     this.client = client;
@@ -3744,6 +3779,13 @@ class RatesAPI {
         shipmentId
       });
     };
+    /**
+     * The `estimate` endpoint allows us to obtain estimated rates based on the payload that is attached to the POST
+     * method.
+     */
+    this.estimate = (params) => {
+      return this.client.post("/v1/rates/estimate", __spreadValues$2({}, params));
+    };
     this.client = client;
   }
 }

package/index.mjs

@@ -6,17 +6,17 @@ var AccountBillingPlanChangeType = /* @__PURE__ */ ((AccountBillingPlanChangeTyp
   return AccountBillingPlanChangeType2;
 })(AccountBillingPlanChangeType || {});
 
-var __getOwnPropSymbols$5 = Object.getOwnPropertySymbols;
-var __hasOwnProp$5 = Object.prototype.hasOwnProperty;
-var __propIsEnum$5 = Object.prototype.propertyIsEnumerable;
+var __getOwnPropSymbols$6 = Object.getOwnPropertySymbols;
+var __hasOwnProp$6 = Object.prototype.hasOwnProperty;
+var __propIsEnum$6 = Object.prototype.propertyIsEnumerable;
 var __objRest$2 = (source, exclude) => {
   var target = {};
   for (var prop in source)
-    if (__hasOwnProp$5.call(source, prop) && exclude.indexOf(prop) < 0)
+    if (__hasOwnProp$6.call(source, prop) && exclude.indexOf(prop) < 0)
       target[prop] = source[prop];
-  if (source != null && __getOwnPropSymbols$5)
-    for (var prop of __getOwnPropSymbols$5(source)) {
-      if (exclude.indexOf(prop) < 0 && __propIsEnum$5.call(source, prop))
+  if (source != null && __getOwnPropSymbols$6)
+    for (var prop of __getOwnPropSymbols$6(source)) {
+      if (exclude.indexOf(prop) < 0 && __propIsEnum$6.call(source, prop))
         target[prop] = source[prop];
     }
   return target;
@@ -138,17 +138,17 @@ const types = /*#__PURE__*/Object.freeze(/*#__PURE__*/Object.defineProperty({
   RateCardStatus
 }, Symbol.toStringTag, { value: 'Module' }));
 
-var __getOwnPropSymbols$4 = Object.getOwnPropertySymbols;
-var __hasOwnProp$4 = Object.prototype.hasOwnProperty;
-var __propIsEnum$4 = Object.prototype.propertyIsEnumerable;
+var __getOwnPropSymbols$5 = Object.getOwnPropertySymbols;
+var __hasOwnProp$5 = Object.prototype.hasOwnProperty;
+var __propIsEnum$5 = Object.prototype.propertyIsEnumerable;
 var __objRest$1 = (source, exclude) => {
   var target = {};
   for (var prop in source)
-    if (__hasOwnProp$4.call(source, prop) && exclude.indexOf(prop) < 0)
+    if (__hasOwnProp$5.call(source, prop) && exclude.indexOf(prop) < 0)
       target[prop] = source[prop];
-  if (source != null && __getOwnPropSymbols$4)
-    for (var prop of __getOwnPropSymbols$4(source)) {
-      if (exclude.indexOf(prop) < 0 && __propIsEnum$4.call(source, prop))
+  if (source != null && __getOwnPropSymbols$5)
+    for (var prop of __getOwnPropSymbols$5(source)) {
+      if (exclude.indexOf(prop) < 0 && __propIsEnum$5.call(source, prop))
         target[prop] = source[prop];
     }
   return target;
@@ -992,21 +992,21 @@ const getEndUserIpAddress = () => __async$5(void 0, null, function* () {
   }
 });
 
-var __defProp$3 = Object.defineProperty;
+var __defProp$4 = Object.defineProperty;
 var __defProps$1 = Object.defineProperties;
 var __getOwnPropDescs$1 = Object.getOwnPropertyDescriptors;
-var __getOwnPropSymbols$3 = Object.getOwnPropertySymbols;
-var __hasOwnProp$3 = Object.prototype.hasOwnProperty;
-var __propIsEnum$3 = Object.prototype.propertyIsEnumerable;
-var __defNormalProp$3 = (obj, key, value) => key in obj ? __defProp$3(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
-var __spreadValues$3 = (a, b) => {
+var __getOwnPropSymbols$4 = Object.getOwnPropertySymbols;
+var __hasOwnProp$4 = Object.prototype.hasOwnProperty;
+var __propIsEnum$4 = Object.prototype.propertyIsEnumerable;
+var __defNormalProp$4 = (obj, key, value) => key in obj ? __defProp$4(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __spreadValues$4 = (a, b) => {
   for (var prop in b || (b = {}))
-    if (__hasOwnProp$3.call(b, prop))
-      __defNormalProp$3(a, prop, b[prop]);
-  if (__getOwnPropSymbols$3)
-    for (var prop of __getOwnPropSymbols$3(b)) {
-      if (__propIsEnum$3.call(b, prop))
-        __defNormalProp$3(a, prop, b[prop]);
+    if (__hasOwnProp$4.call(b, prop))
+      __defNormalProp$4(a, prop, b[prop]);
+  if (__getOwnPropSymbols$4)
+    for (var prop of __getOwnPropSymbols$4(b)) {
+      if (__propIsEnum$4.call(b, prop))
+        __defNormalProp$4(a, prop, b[prop]);
     }
   return a;
 };
@@ -1014,11 +1014,11 @@ var __spreadProps$1 = (a, b) => __defProps$1(a, __getOwnPropDescs$1(b));
 var __objRest = (source, exclude) => {
   var target = {};
   for (var prop in source)
-    if (__hasOwnProp$3.call(source, prop) && exclude.indexOf(prop) < 0)
+    if (__hasOwnProp$4.call(source, prop) && exclude.indexOf(prop) < 0)
       target[prop] = source[prop];
-  if (source != null && __getOwnPropSymbols$3)
-    for (var prop of __getOwnPropSymbols$3(source)) {
-      if (exclude.indexOf(prop) < 0 && __propIsEnum$3.call(source, prop))
+  if (source != null && __getOwnPropSymbols$4)
+    for (var prop of __getOwnPropSymbols$4(source)) {
+      if (exclude.indexOf(prop) < 0 && __propIsEnum$4.call(source, prop))
         target[prop] = source[prop];
     }
   return target;
@@ -1066,7 +1066,7 @@ class CarriersAPI {
       const endUserIpAddress = yield getEndUserIpAddress();
       if (!endUserIpAddress)
         return Promise.reject([new CodedError("Unable to get IP address")]);
-      return yield this.client.post(`/v1/registration/${carrierCode}`, __spreadProps$1(__spreadValues$3({}, connection), {
+      return yield this.client.post(`/v1/registration/${carrierCode}`, __spreadProps$1(__spreadValues$4({}, connection), {
         endUserIpAddress
       }));
     });
@@ -1217,6 +1217,25 @@ class ConnectionsAPI {
         `/v1/connections/carriers/${carrierCode}/services`
       );
     };
+    /**
+     * The `getCarrierSettings` method retrieves the settings for a given carrier,
+     * identified by the `carrierName` and `carrierCode`.
+     */
+    this.getCarrierSettings = (carrierName, carrierCode) => {
+      return this.client.get(
+        `/v1/connections/carriers/${carrierName}/${carrierCode}/settings`
+      );
+    };
+    /**
+     * The `updateCarrierSettings` method updates the settings for a given carrier,
+     * identified by the `carrierName` and `carrierCode`.
+     */
+    this.updateCarrierSettings = (carrierName, carrierCode, formData) => {
+      return this.client.put(
+        `/v1/connections/carriers/${carrierName}/${carrierCode}/settings`,
+        formData
+      );
+    };
     this.client = client;
   }
 }
@@ -3430,19 +3449,19 @@ class CustomPackagesAPI {
   }
 }
 
-var __defProp$2 = Object.defineProperty;
-var __getOwnPropSymbols$2 = Object.getOwnPropertySymbols;
-var __hasOwnProp$2 = Object.prototype.hasOwnProperty;
-var __propIsEnum$2 = Object.prototype.propertyIsEnumerable;
-var __defNormalProp$2 = (obj, key, value) => key in obj ? __defProp$2(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
-var __spreadValues$2 = (a, b) => {
+var __defProp$3 = Object.defineProperty;
+var __getOwnPropSymbols$3 = Object.getOwnPropertySymbols;
+var __hasOwnProp$3 = Object.prototype.hasOwnProperty;
+var __propIsEnum$3 = Object.prototype.propertyIsEnumerable;
+var __defNormalProp$3 = (obj, key, value) => key in obj ? __defProp$3(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __spreadValues$3 = (a, b) => {
   for (var prop in b || (b = {}))
-    if (__hasOwnProp$2.call(b, prop))
-      __defNormalProp$2(a, prop, b[prop]);
-  if (__getOwnPropSymbols$2)
-    for (var prop of __getOwnPropSymbols$2(b)) {
-      if (__propIsEnum$2.call(b, prop))
-        __defNormalProp$2(a, prop, b[prop]);
+    if (__hasOwnProp$3.call(b, prop))
+      __defNormalProp$3(a, prop, b[prop]);
+  if (__getOwnPropSymbols$3)
+    for (var prop of __getOwnPropSymbols$3(b)) {
+      if (__propIsEnum$3.call(b, prop))
+        __defNormalProp$3(a, prop, b[prop]);
     }
   return a;
 };
@@ -3490,7 +3509,7 @@ class FundingSourcesAPI {
       if (!endUserIpAddress) {
         return Promise.reject([new CodedError("Unable to get IP address")]);
       }
-      return yield this.client.post("/v1/funding_sources", __spreadValues$2({
+      return yield this.client.post("/v1/funding_sources", __spreadValues$3({
         endUserIpAddress
       }, createFundingSource));
     });
@@ -3522,7 +3541,7 @@ class FundingSourcesAPI {
       if (!endUserIpAddress) {
         return Promise.reject([new CodedError("Unable to get IP address")]);
       }
-      return yield this.client.post("/v1/registration/funding_source", __spreadValues$2({
+      return yield this.client.post("/v1/registration/funding_source", __spreadValues$3({
         endUserIpAddress
       }, carrier));
     });
@@ -3727,6 +3746,22 @@ class RateCardsAPI {
   }
 }
 
+var __defProp$2 = Object.defineProperty;
+var __getOwnPropSymbols$2 = Object.getOwnPropertySymbols;
+var __hasOwnProp$2 = Object.prototype.hasOwnProperty;
+var __propIsEnum$2 = Object.prototype.propertyIsEnumerable;
+var __defNormalProp$2 = (obj, key, value) => key in obj ? __defProp$2(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __spreadValues$2 = (a, b) => {
+  for (var prop in b || (b = {}))
+    if (__hasOwnProp$2.call(b, prop))
+      __defNormalProp$2(a, prop, b[prop]);
+  if (__getOwnPropSymbols$2)
+    for (var prop of __getOwnPropSymbols$2(b)) {
+      if (__propIsEnum$2.call(b, prop))
+        __defNormalProp$2(a, prop, b[prop]);
+    }
+  return a;
+};
 class RatesAPI {
   constructor(client) {
     this.client = client;
@@ -3740,6 +3775,13 @@ class RatesAPI {
         shipmentId
       });
     };
+    /**
+     * The `estimate` endpoint allows us to obtain estimated rates based on the payload that is attached to the POST
+     * method.
+     */
+    this.estimate = (params) => {
+      return this.client.post("/v1/rates/estimate", __spreadValues$2({}, params));
+    };
     this.client = client;
   }
 }

package/package.json

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

package/rates/api.d.ts

@@ -1,32 +1,5 @@
 import { AxiosInstance } from "axios";
-import { Currency } from "../payments";
-import { RateResponse } from "./types";
-/**
- * # Rates API - Calculate Rates Options
- */
-export interface CalculateRatesOptions {
-    /**
-     * `calculateTaxAmount` is an optional boolean that indicates rates returned
-     * should include the tax amount.
-     */
-    calculateTaxAmount?: boolean;
-    /**
-     * `carrierIds` is an array of carrier IDs to filter rates by.
-     */
-    carrierIds: string[];
-    /**
-     * `packageTypes` is an optional array of package types to filter rates by.
-     */
-    packageTypes?: string[];
-    /**
-     * `preferredCurrency` is an optional indicator of the currency to return rates in.
-     */
-    preferredCurrency?: Currency;
-    /**
-     * `serviceCodes` is an optional array of specific carrier service codes to filter rates by.
-     */
-    serviceCodes?: string[];
-}
+import { CalculateRatesOptions, RateResponse, RatesEstimateParams, RatesEstimateResponse } from "./types";
 /**
  * # Rates API module - /v1/rates
  */
@@ -43,4 +16,9 @@ export declare class RatesAPI {
     } & {
         rateResponse: RateResponse;
     }, any>>;
+    /**
+     * The `estimate` endpoint allows us to obtain estimated rates based on the payload that is attached to the POST
+     * method.
+     */
+    estimate: (params: RatesEstimateParams) => Promise<import("axios").AxiosResponse<RatesEstimateResponse, any>>;
 }

package/rates/types.d.ts

@@ -1,28 +1,15 @@
+import { DimensionsWithUnit } from "../dimensions";
 import { CodedError } from "../errors";
-import { Money } from "../payments";
-/**
- * @category Entities
- */
+import { Currency, Money } from "../payments";
+import { WeightWithUnit } from "../weight";
 export type RateType = "check" | "shipment";
-/**
- * @category Entities
- */
 export type RateDetailType = "uncategorized" | "shipping" | "insurance" | "confirmation" | "discount" | "fuel_charge" | "additional_fees" | "tariff" | "tax" | "delivery" | "handling" | "special_goods" | "pickup" | "location_fee" | "oversize" | "returns" | "notifications" | "tip" | "duties_and_taxes" | "brokerage_fee" | "admin_fee" | "adjustment";
-/**
- * @category Entities
- */
 export type TaxType = "VAT";
-/**
- * @category Entities
- */
 export type RateDetailAttributes = {
     taxCode: string;
     taxPercentage: number;
     taxType: TaxType;
 };
-/**
- * @category Entities
- */
 export type RateDetail = {
     amount: Money;
     carrierBillingCode: string | null;
@@ -31,13 +18,7 @@ export type RateDetail = {
     rateDetailAttributes: RateDetailAttributes | null;
     rateDetailType: RateDetailType;
 };
-/**
- * @category Entities
- */
 export type RateValidationStatus = "valid" | "invalid" | "has_warnings" | "unknown";
-/**
- * @category Entities
- */
 export interface Rate {
     carrierCode: string;
     carrierDeliveryDays: string;
@@ -66,9 +47,6 @@ export interface Rate {
     warningMessages: string[];
     zone?: number;
 }
-/**
- * @category Entities
- */
 export interface RateResponse {
     createdAt: string;
     errors: CodedError[];
@@ -78,3 +56,43 @@ export interface RateResponse {
     shipmentId: string;
     status: "working" | "completed" | "partial" | "error";
 }
+export type RatesEstimateResponse = Array<Omit<Rate, "rateId">>;
+export interface CalculateRatesOptions {
+    /**
+     * `calculateTaxAmount` is an optional boolean that indicates rates returned
+     * should include the tax amount.
+     */
+    calculateTaxAmount?: boolean;
+    /**
+     * `carrierIds` is an array of carrier IDs to filter rates by.
+     */
+    carrierIds: string[];
+    /**
+     * `packageTypes` is an optional array of package types to filter rates by.
+     */
+    packageTypes?: string[];
+    /**
+     * `preferredCurrency` is an optional indicator of the currency to return rates in.
+     */
+    preferredCurrency?: Currency;
+    /**
+     * `serviceCodes` is an optional array of specific carrier service codes to filter rates by.
+     */
+    serviceCodes?: string[];
+}
+export interface RatesEstimateParams {
+    addressResidentialIndicator: string;
+    carrierIds: string[];
+    confirmation: string;
+    dimensions: DimensionsWithUnit;
+    fromCityLocality: string;
+    fromCountryCode: string;
+    fromPostalCode: string;
+    fromStateProvince: string;
+    shipDate: string;
+    toCityLocality: string;
+    toCountryCode: string;
+    toPostalCode: string;
+    toStateProvince: string;
+    weight: WeightWithUnit;
+}