@shipengine/js-api 1.2.0 → 1.4.0

package/client.d.ts

@@ -14,6 +14,7 @@ import { RateCardsAPI } from "./rate-cards";
 import { RatesAPI } from "./rates";
 import { SalesOrderShipmentsAPI } from "./sales-order-shipments";
 import { SalesOrdersAPI } from "./sales-orders";
+import { ServicePointsAPI } from "./service-points";
 import { ShipmentsAPI } from "./shipments";
 import { ShippingRulesAPI } from "./shipping-rules";
 import { ThemesAPI } from "./themes";
@@ -158,6 +159,7 @@ export declare class ShipEngineAPI {
      * @see {@link SalesOrdersAPI | The Sales Orders API module}
      */
     get salesOrders(): SalesOrdersAPI;
+    get servicePoints(): ServicePointsAPI;
     /**
      * The `shipments` method provides access to the Shipment endpoints in ShipEngine
      * API. e.g. Create Shipment, Get Shipment, etc.

package/connections/api.d.ts

@@ -1,7 +1,7 @@
 import { AxiosInstance } from "axios";
-import { GetCarrierConnectionFormParams, GetCarrierConnectionFormResponse, ListCarrierConnectionsParams, ListCarrierConnectionsResponse } from "./types";
+import { ConnectCarrierAccount, ConnectCarrierAccountResponse, GetCarrierConnectionFormParams, GetCarrierConnectionFormResponse, ListCarrierConnectionsParams, ListCarrierConnectionsResponse } from "./types";
 /**
- * # Carriers API module - /v1/carriers
+ * # Connections API module - /v1/connections
  */
 export declare class ConnectionsAPI {
     private client;
@@ -15,4 +15,8 @@ export declare class ConnectionsAPI {
      * information required to connect to the carrier.
      */
     getCarrierConnectionForm: (carrierName: string, params: GetCarrierConnectionFormParams) => Promise<import("axios").AxiosResponse<GetCarrierConnectionFormResponse, any>>;
+    /**
+     * The `connectCarrier` method connects a carrier to account.
+     */
+    connectCarrier: (carrierName: string, formData: ConnectCarrierAccount) => Promise<import("axios").AxiosResponse<ConnectCarrierAccountResponse, any>>;
 }

package/connections/types.d.ts

@@ -1,36 +1,40 @@
 import { GenericObject, LocaleBasedQuery } from "../resources";
 /**
- * @category Requests
+ * @category Entities
  */
+export type CarrierMetadata = {
+    beta: boolean;
+    carrierFeatures?: {
+        country: string;
+        featureList: string[];
+    }[] | null;
+    carrierName: string;
+    description: string;
+    iconUrl: string;
+    logoUrl: string;
+    name: string;
+    searchTerms?: string[] | null;
+};
 export type ListCarrierConnectionsParams = LocaleBasedQuery;
 export type GetCarrierConnectionFormParams = LocaleBasedQuery;
+export type ConnectCarrierAccount = {
+    nickname: string;
+} & GenericObject;
 /**
  * @category Responses
  */
 export type GetCarrierConnectionFormResponse = {
     formMetadata: {
-        connectionNames?: string[];
-        defaultConnectionName?: string;
+        connectionNames?: string[] | null;
+        defaultConnectionName?: string | null;
         formSchema: {
             jsonSchema: GenericObject;
             uiSchema: GenericObject;
         };
     };
 };
-export type ListCarrierConnectionsResponse = [
-    {
-        beta: boolean;
-        carrierFeatures?: [
-            {
-                country: string;
-                featureList: string[];
-            }
-        ];
-        carrierName: string;
-        description: string;
-        iconUrl: string;
-        logoUrl: string;
-        name: string;
-        searchTerms?: string[];
-    }
-];
+export type ListCarrierConnectionsResponse = CarrierMetadata[];
+export type ConnectCarrierAccountResponse = {
+    carrierId?: string;
+    redirectUrl?: string;
+};

package/index.d.ts

@@ -18,6 +18,7 @@ export * from "./relay-points";
 export * from "./resources";
 export * from "./sales-order-shipments";
 export * from "./sales-orders";
+export * from "./service-points";
 export * from "./shipments";
 export * from "./shipping-rules";
 export * from "./utilities";

package/index.js

@@ -10,17 +10,17 @@ var AccountBillingPlanChangeType = /* @__PURE__ */ ((AccountBillingPlanChangeTyp
   return AccountBillingPlanChangeType2;
 })(AccountBillingPlanChangeType || {});
 
-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$2 = (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;
@@ -142,17 +142,17 @@ const types = /*#__PURE__*/Object.freeze(/*#__PURE__*/Object.defineProperty({
   RateCardStatus
 }, Symbol.toStringTag, { value: 'Module' }));
 
-var __getOwnPropSymbols$3 = Object.getOwnPropertySymbols;
-var __hasOwnProp$3 = Object.prototype.hasOwnProperty;
-var __propIsEnum$3 = Object.prototype.propertyIsEnumerable;
+var __getOwnPropSymbols$4 = Object.getOwnPropertySymbols;
+var __hasOwnProp$4 = Object.prototype.hasOwnProperty;
+var __propIsEnum$4 = Object.prototype.propertyIsEnumerable;
 var __objRest$1 = (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;
@@ -964,7 +964,7 @@ var ipaddr = {
 	}).call(commonjsGlobal);
 } (ipaddr));
 
-var __async$4 = (__this, __arguments, generator) => {
+var __async$5 = (__this, __arguments, generator) => {
   return new Promise((resolve, reject) => {
     var fulfilled = (value) => {
       try {
@@ -984,7 +984,7 @@ var __async$4 = (__this, __arguments, generator) => {
     step((generator = generator.apply(__this, __arguments)).next());
   });
 };
-const getEndUserIpAddress = () => __async$4(void 0, null, function* () {
+const getEndUserIpAddress = () => __async$5(void 0, null, function* () {
   try {
     const response = yield axios.get("https://api.ipify.org/?format=json");
     if (response.data.ip && ipaddrExports.isValid(response.data.ip)) {
@@ -996,21 +996,21 @@ const getEndUserIpAddress = () => __async$4(void 0, null, function* () {
   }
 });
 
-var __defProp$2 = Object.defineProperty;
+var __defProp$3 = Object.defineProperty;
 var __defProps$1 = Object.defineProperties;
 var __getOwnPropDescs$1 = Object.getOwnPropertyDescriptors;
-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 __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;
 };
@@ -1018,16 +1018,16 @@ var __spreadProps$1 = (a, b) => __defProps$1(a, __getOwnPropDescs$1(b));
 var __objRest = (source, exclude) => {
   var target = {};
   for (var prop in source)
-    if (__hasOwnProp$2.call(source, prop) && exclude.indexOf(prop) < 0)
+    if (__hasOwnProp$3.call(source, prop) && exclude.indexOf(prop) < 0)
       target[prop] = source[prop];
-  if (source != null && __getOwnPropSymbols$2)
-    for (var prop of __getOwnPropSymbols$2(source)) {
-      if (exclude.indexOf(prop) < 0 && __propIsEnum$2.call(source, prop))
+  if (source != null && __getOwnPropSymbols$3)
+    for (var prop of __getOwnPropSymbols$3(source)) {
+      if (exclude.indexOf(prop) < 0 && __propIsEnum$3.call(source, prop))
         target[prop] = source[prop];
     }
   return target;
 };
-var __async$3 = (__this, __arguments, generator) => {
+var __async$4 = (__this, __arguments, generator) => {
   return new Promise((resolve, reject) => {
     var fulfilled = (value) => {
       try {
@@ -1065,12 +1065,12 @@ class CarriersAPI {
     /**
      * The `connect` method connects a carrier account to a user's ShipEngine account.
      */
-    this.connect = (_a) => __async$3(this, null, function* () {
+    this.connect = (_a) => __async$4(this, null, function* () {
       var _b = _a, { carrierCode } = _b, connection = __objRest(_b, ["carrierCode"]);
       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$2({}, connection), {
+      return yield this.client.post(`/v1/registration/${carrierCode}`, __spreadProps$1(__spreadValues$3({}, connection), {
         endUserIpAddress
       }));
     });
@@ -1149,6 +1149,26 @@ class CarriersAPI {
   }
 }
 
+var __async$3 = (__this, __arguments, generator) => {
+  return new Promise((resolve, reject) => {
+    var fulfilled = (value) => {
+      try {
+        step(generator.next(value));
+      } catch (e) {
+        reject(e);
+      }
+    };
+    var rejected = (value) => {
+      try {
+        step(generator.throw(value));
+      } catch (e) {
+        reject(e);
+      }
+    };
+    var step = (x) => x.done ? resolve(x.value) : Promise.resolve(x.value).then(fulfilled, rejected);
+    step((generator = generator.apply(__this, __arguments)).next());
+  });
+};
 class ConnectionsAPI {
   constructor(client) {
     this.client = client;
@@ -1168,6 +1188,15 @@ class ConnectionsAPI {
         { params }
       );
     };
+    /**
+     * The `connectCarrier` method connects a carrier to account.
+     */
+    this.connectCarrier = (carrierName, formData) => __async$3(this, null, function* () {
+      return yield this.client.post(
+        `/v1/connections/carriers/${carrierName}`,
+        formData
+      );
+    });
     this.client = client;
   }
 }
@@ -3381,19 +3410,19 @@ class CustomPackagesAPI {
   }
 }
 
-var __defProp$1 = Object.defineProperty;
-var __getOwnPropSymbols$1 = Object.getOwnPropertySymbols;
-var __hasOwnProp$1 = Object.prototype.hasOwnProperty;
-var __propIsEnum$1 = Object.prototype.propertyIsEnumerable;
-var __defNormalProp$1 = (obj, key, value) => key in obj ? __defProp$1(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
-var __spreadValues$1 = (a, b) => {
+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$1.call(b, prop))
-      __defNormalProp$1(a, prop, b[prop]);
-  if (__getOwnPropSymbols$1)
-    for (var prop of __getOwnPropSymbols$1(b)) {
-      if (__propIsEnum$1.call(b, prop))
-        __defNormalProp$1(a, prop, b[prop]);
+    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;
 };
@@ -3440,7 +3469,7 @@ class FundingSourcesAPI {
       const endUserIpAddress = yield getEndUserIpAddress();
       if (!endUserIpAddress)
         return Promise.reject([new CodedError("Unable to get IP address")]);
-      return yield this.client.post("/v1/funding_sources", __spreadValues$1({
+      return yield this.client.post("/v1/funding_sources", __spreadValues$2({
         endUserIpAddress
       }, createFundingSource));
     });
@@ -3470,7 +3499,7 @@ class FundingSourcesAPI {
       const endUserIpAddress = yield getEndUserIpAddress();
       if (!endUserIpAddress)
         return Promise.reject([new CodedError("Unable to get IP address")]);
-      return yield this.client.post("/v1/registration/funding_source", __spreadValues$1({
+      return yield this.client.post("/v1/registration/funding_source", __spreadValues$2({
         endUserIpAddress
       }, carrier));
     });
@@ -3745,6 +3774,42 @@ class SalesOrdersAPI {
   }
 }
 
+var __defProp$1 = Object.defineProperty;
+var __getOwnPropSymbols$1 = Object.getOwnPropertySymbols;
+var __hasOwnProp$1 = Object.prototype.hasOwnProperty;
+var __propIsEnum$1 = Object.prototype.propertyIsEnumerable;
+var __defNormalProp$1 = (obj, key, value) => key in obj ? __defProp$1(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __spreadValues$1 = (a, b) => {
+  for (var prop in b || (b = {}))
+    if (__hasOwnProp$1.call(b, prop))
+      __defNormalProp$1(a, prop, b[prop]);
+  if (__getOwnPropSymbols$1)
+    for (var prop of __getOwnPropSymbols$1(b)) {
+      if (__propIsEnum$1.call(b, prop))
+        __defNormalProp$1(a, prop, b[prop]);
+    }
+  return a;
+};
+class ServicePointsAPI {
+  constructor(client) {
+    /**
+     * The `list` method returns a list of service points based on several factors
+     * A providers list that must contain at least one provider but no more than five
+     * Either an address, coordinates, or an address query
+     */
+    this.list = (options) => {
+      return this.client.post("/v1/service_points/list", __spreadValues$1({}, options));
+    };
+    /**
+     * Get a specific service point by its carrier code, country code, and id
+     */
+    this.get = ({ carrierCode, countryCode, id }) => {
+      return this.client.get(`/v1/service_points/${carrierCode}/${countryCode}/${id}`);
+    };
+    this.client = client;
+  }
+}
+
 var __async$1 = (__this, __arguments, generator) => {
   return new Promise((resolve, reject) => {
     var fulfilled = (value) => {
@@ -4162,6 +4227,9 @@ class ShipEngineAPI {
   get salesOrders() {
     return new SalesOrdersAPI(this.client);
   }
+  get servicePoints() {
+    return new ServicePointsAPI(this.client);
+  }
   /**
    * The `shipments` method provides access to the Shipment endpoints in ShipEngine
    * API. e.g. Create Shipment, Get Shipment, etc.
@@ -4224,6 +4292,7 @@ exports.RatesAPI = RatesAPI;
 exports.SE = types;
 exports.SalesOrderShipmentsAPI = SalesOrderShipmentsAPI;
 exports.SalesOrdersAPI = SalesOrdersAPI;
+exports.ServicePointsAPI = ServicePointsAPI;
 exports.ShipEngineAPI = ShipEngineAPI;
 exports.ShipmentsAPI = ShipmentsAPI;
 exports.ShippingRulesAPI = ShippingRulesAPI;

package/index.mjs

@@ -6,17 +6,17 @@ var AccountBillingPlanChangeType = /* @__PURE__ */ ((AccountBillingPlanChangeTyp
   return AccountBillingPlanChangeType2;
 })(AccountBillingPlanChangeType || {});
 
-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$2 = (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;
@@ -138,17 +138,17 @@ const types = /*#__PURE__*/Object.freeze(/*#__PURE__*/Object.defineProperty({
   RateCardStatus
 }, Symbol.toStringTag, { value: 'Module' }));
 
-var __getOwnPropSymbols$3 = Object.getOwnPropertySymbols;
-var __hasOwnProp$3 = Object.prototype.hasOwnProperty;
-var __propIsEnum$3 = Object.prototype.propertyIsEnumerable;
+var __getOwnPropSymbols$4 = Object.getOwnPropertySymbols;
+var __hasOwnProp$4 = Object.prototype.hasOwnProperty;
+var __propIsEnum$4 = Object.prototype.propertyIsEnumerable;
 var __objRest$1 = (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;
@@ -960,7 +960,7 @@ var ipaddr = {
 	}).call(commonjsGlobal);
 } (ipaddr));
 
-var __async$4 = (__this, __arguments, generator) => {
+var __async$5 = (__this, __arguments, generator) => {
   return new Promise((resolve, reject) => {
     var fulfilled = (value) => {
       try {
@@ -980,7 +980,7 @@ var __async$4 = (__this, __arguments, generator) => {
     step((generator = generator.apply(__this, __arguments)).next());
   });
 };
-const getEndUserIpAddress = () => __async$4(void 0, null, function* () {
+const getEndUserIpAddress = () => __async$5(void 0, null, function* () {
   try {
     const response = yield axios.get("https://api.ipify.org/?format=json");
     if (response.data.ip && ipaddrExports.isValid(response.data.ip)) {
@@ -992,21 +992,21 @@ const getEndUserIpAddress = () => __async$4(void 0, null, function* () {
   }
 });
 
-var __defProp$2 = Object.defineProperty;
+var __defProp$3 = Object.defineProperty;
 var __defProps$1 = Object.defineProperties;
 var __getOwnPropDescs$1 = Object.getOwnPropertyDescriptors;
-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 __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;
 };
@@ -1014,16 +1014,16 @@ var __spreadProps$1 = (a, b) => __defProps$1(a, __getOwnPropDescs$1(b));
 var __objRest = (source, exclude) => {
   var target = {};
   for (var prop in source)
-    if (__hasOwnProp$2.call(source, prop) && exclude.indexOf(prop) < 0)
+    if (__hasOwnProp$3.call(source, prop) && exclude.indexOf(prop) < 0)
       target[prop] = source[prop];
-  if (source != null && __getOwnPropSymbols$2)
-    for (var prop of __getOwnPropSymbols$2(source)) {
-      if (exclude.indexOf(prop) < 0 && __propIsEnum$2.call(source, prop))
+  if (source != null && __getOwnPropSymbols$3)
+    for (var prop of __getOwnPropSymbols$3(source)) {
+      if (exclude.indexOf(prop) < 0 && __propIsEnum$3.call(source, prop))
         target[prop] = source[prop];
     }
   return target;
 };
-var __async$3 = (__this, __arguments, generator) => {
+var __async$4 = (__this, __arguments, generator) => {
   return new Promise((resolve, reject) => {
     var fulfilled = (value) => {
       try {
@@ -1061,12 +1061,12 @@ class CarriersAPI {
     /**
      * The `connect` method connects a carrier account to a user's ShipEngine account.
      */
-    this.connect = (_a) => __async$3(this, null, function* () {
+    this.connect = (_a) => __async$4(this, null, function* () {
       var _b = _a, { carrierCode } = _b, connection = __objRest(_b, ["carrierCode"]);
       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$2({}, connection), {
+      return yield this.client.post(`/v1/registration/${carrierCode}`, __spreadProps$1(__spreadValues$3({}, connection), {
         endUserIpAddress
       }));
     });
@@ -1145,6 +1145,26 @@ class CarriersAPI {
   }
 }
 
+var __async$3 = (__this, __arguments, generator) => {
+  return new Promise((resolve, reject) => {
+    var fulfilled = (value) => {
+      try {
+        step(generator.next(value));
+      } catch (e) {
+        reject(e);
+      }
+    };
+    var rejected = (value) => {
+      try {
+        step(generator.throw(value));
+      } catch (e) {
+        reject(e);
+      }
+    };
+    var step = (x) => x.done ? resolve(x.value) : Promise.resolve(x.value).then(fulfilled, rejected);
+    step((generator = generator.apply(__this, __arguments)).next());
+  });
+};
 class ConnectionsAPI {
   constructor(client) {
     this.client = client;
@@ -1164,6 +1184,15 @@ class ConnectionsAPI {
         { params }
       );
     };
+    /**
+     * The `connectCarrier` method connects a carrier to account.
+     */
+    this.connectCarrier = (carrierName, formData) => __async$3(this, null, function* () {
+      return yield this.client.post(
+        `/v1/connections/carriers/${carrierName}`,
+        formData
+      );
+    });
     this.client = client;
   }
 }
@@ -3377,19 +3406,19 @@ class CustomPackagesAPI {
   }
 }
 
-var __defProp$1 = Object.defineProperty;
-var __getOwnPropSymbols$1 = Object.getOwnPropertySymbols;
-var __hasOwnProp$1 = Object.prototype.hasOwnProperty;
-var __propIsEnum$1 = Object.prototype.propertyIsEnumerable;
-var __defNormalProp$1 = (obj, key, value) => key in obj ? __defProp$1(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
-var __spreadValues$1 = (a, b) => {
+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$1.call(b, prop))
-      __defNormalProp$1(a, prop, b[prop]);
-  if (__getOwnPropSymbols$1)
-    for (var prop of __getOwnPropSymbols$1(b)) {
-      if (__propIsEnum$1.call(b, prop))
-        __defNormalProp$1(a, prop, b[prop]);
+    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;
 };
@@ -3436,7 +3465,7 @@ class FundingSourcesAPI {
       const endUserIpAddress = yield getEndUserIpAddress();
       if (!endUserIpAddress)
         return Promise.reject([new CodedError("Unable to get IP address")]);
-      return yield this.client.post("/v1/funding_sources", __spreadValues$1({
+      return yield this.client.post("/v1/funding_sources", __spreadValues$2({
         endUserIpAddress
       }, createFundingSource));
     });
@@ -3466,7 +3495,7 @@ class FundingSourcesAPI {
       const endUserIpAddress = yield getEndUserIpAddress();
       if (!endUserIpAddress)
         return Promise.reject([new CodedError("Unable to get IP address")]);
-      return yield this.client.post("/v1/registration/funding_source", __spreadValues$1({
+      return yield this.client.post("/v1/registration/funding_source", __spreadValues$2({
         endUserIpAddress
       }, carrier));
     });
@@ -3741,6 +3770,42 @@ class SalesOrdersAPI {
   }
 }
 
+var __defProp$1 = Object.defineProperty;
+var __getOwnPropSymbols$1 = Object.getOwnPropertySymbols;
+var __hasOwnProp$1 = Object.prototype.hasOwnProperty;
+var __propIsEnum$1 = Object.prototype.propertyIsEnumerable;
+var __defNormalProp$1 = (obj, key, value) => key in obj ? __defProp$1(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __spreadValues$1 = (a, b) => {
+  for (var prop in b || (b = {}))
+    if (__hasOwnProp$1.call(b, prop))
+      __defNormalProp$1(a, prop, b[prop]);
+  if (__getOwnPropSymbols$1)
+    for (var prop of __getOwnPropSymbols$1(b)) {
+      if (__propIsEnum$1.call(b, prop))
+        __defNormalProp$1(a, prop, b[prop]);
+    }
+  return a;
+};
+class ServicePointsAPI {
+  constructor(client) {
+    /**
+     * The `list` method returns a list of service points based on several factors
+     * A providers list that must contain at least one provider but no more than five
+     * Either an address, coordinates, or an address query
+     */
+    this.list = (options) => {
+      return this.client.post("/v1/service_points/list", __spreadValues$1({}, options));
+    };
+    /**
+     * Get a specific service point by its carrier code, country code, and id
+     */
+    this.get = ({ carrierCode, countryCode, id }) => {
+      return this.client.get(`/v1/service_points/${carrierCode}/${countryCode}/${id}`);
+    };
+    this.client = client;
+  }
+}
+
 var __async$1 = (__this, __arguments, generator) => {
   return new Promise((resolve, reject) => {
     var fulfilled = (value) => {
@@ -4158,6 +4223,9 @@ class ShipEngineAPI {
   get salesOrders() {
     return new SalesOrdersAPI(this.client);
   }
+  get servicePoints() {
+    return new ServicePointsAPI(this.client);
+  }
   /**
    * The `shipments` method provides access to the Shipment endpoints in ShipEngine
    * API. e.g. Create Shipment, Get Shipment, etc.
@@ -4195,4 +4263,4 @@ class ShipEngineAPI {
   }
 }
 
-export { AccountSettingsAPI, AddressesAPI, CarriersAPI, CodedError, ConfirmationType, ConnectionsAPI, CreditCardVendor, Currency, CustomPackagesAPI, CustomsContentsType, CustomsNonDeliveryType, FundingSourcesAPI, InsuranceAPI, InsuranceProviderType, LabelsAPI, MetadataCapability, MetadataRequirement, MetadataSatisfyingFormTypes, OrderSourcesAPI, RateCardStatus, RateCardsAPI, RatesAPI, types as SE, SalesOrderShipmentsAPI, SalesOrdersAPI, ShipEngineAPI, ShipmentsAPI, ShippingRulesAPI, ThemesAPI, WarehousesAPI, getEndUserIpAddress, isCodedError, isCodedErrors, isDataCodedErrors, isInvalidTokenError, parseError };
+export { AccountSettingsAPI, AddressesAPI, CarriersAPI, CodedError, ConfirmationType, ConnectionsAPI, CreditCardVendor, Currency, CustomPackagesAPI, CustomsContentsType, CustomsNonDeliveryType, FundingSourcesAPI, InsuranceAPI, InsuranceProviderType, LabelsAPI, MetadataCapability, MetadataRequirement, MetadataSatisfyingFormTypes, OrderSourcesAPI, RateCardStatus, RateCardsAPI, RatesAPI, types as SE, SalesOrderShipmentsAPI, SalesOrdersAPI, ServicePointsAPI, ShipEngineAPI, ShipmentsAPI, ShippingRulesAPI, ThemesAPI, WarehousesAPI, getEndUserIpAddress, isCodedError, isCodedErrors, isDataCodedErrors, isInvalidTokenError, parseError };

package/labels/api.d.ts

@@ -27,6 +27,14 @@ export interface CreateLabelOptions {
      * e.g. `4x6` or `8.5x11`
      */
     labelLayout?: LabelLayout;
+    /**
+     *  A unique identifier for a carrier drop-off point where a merchant plans to deliver packages. This will take precedence over a shipment's Ship From address.
+     */
+    shipFromServicePointId?: string;
+    /**
+     * A unique identifier for a carrier service point where the shipment will be delivered by the carrier. This will take precedence over a shipment's Ship To address.
+     */
+    shipToServicePointId?: string;
     /**
      * `validateAddress` is an optional string to control address validation during
      * label purchase.

package/package.json

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

package/service-points/api.d.ts

@@ -0,0 +1,19 @@
+import { AxiosInstance } from "axios";
+import type { GetServicePointParams, ListServicePointsOptions, ServicePointsListResponse } from "./types";
+/**
+ * Service points api
+ */
+export declare class ServicePointsAPI {
+    private client;
+    constructor(client: AxiosInstance);
+    /**
+     * The `list` method returns a list of service points based on several factors
+     * A providers list that must contain at least one provider but no more than five
+     * Either an address, coordinates, or an address query
+     */
+    list: (options: ListServicePointsOptions) => Promise<import("axios").AxiosResponse<ServicePointsListResponse, any>>;
+    /**
+     * Get a specific service point by its carrier code, country code, and id
+     */
+    get: ({ carrierCode, countryCode, id }: GetServicePointParams) => Promise<import("axios").AxiosResponse<any, any>>;
+}

package/service-points/index.d.ts

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

package/service-points/types.d.ts

@@ -0,0 +1,74 @@
+import { Address } from "../addresses";
+import type { CodedError } from "../errors";
+/**
+ * Specific error type currently only seen during Service Point requests
+ */
+export type ServicePointCustomError = {
+    message: string;
+    providerId: string;
+    sellerProviderId: number;
+};
+export type ServicePointsListResponse = {
+    errors: CodedError[] | ServicePointCustomError[];
+    lat: number;
+    long: number;
+    servicePoints: {
+        [P in keyof ServicePoint]: ServicePoint[P] | null;
+    }[];
+};
+export type OperatingHours = {
+    close: string;
+    open: string;
+};
+export type DayOfOperation = "monday" | "tuesday" | "wednesday" | "thursday" | "friday" | "saturday" | "sunday";
+export type ServicePointFeature = "drop_off_point" | "pickup_point";
+export type ServicePoint = {
+    addressLine1: string;
+    carrierCode: string;
+    cityLocality: string;
+    companyName: string;
+    countryCode: string;
+    distanceInMeters: number;
+    features: ServicePointFeature[];
+    hoursOfOperation: {
+        [key in DayOfOperation]: OperatingHours;
+    };
+    lat: number;
+    long: number;
+    phoneNumber: string;
+    postalCode: string;
+    serviceCodes: string[];
+    servicePointId: string;
+    stateProvince: string;
+    type: "pudo";
+};
+/**
+ * Types the 3 separate ways to make a request to the list service points endpoint
+ */
+export type ListServicePointsOptions = {
+    maxResults?: number;
+    providers: ServicePointProvider[];
+    radius?: number;
+} & (ListServicePointsOptionAddress | ListServicePointsOptionAddressQuery | ListServicePointsOptionCoordinates);
+export type ListServicePointsOptionCoordinates = {
+    lat: number;
+    long: number;
+};
+export type ListServicePointsOptionAddressQuery = {
+    addressQuery: string;
+};
+export type ListServicePointsOptionAddress = {
+    address: ServicePointAddress;
+};
+export type ServicePointAddress = Omit<Address, "adressResidentialIndicator" | "email" | "name" | "phone" | "companyName" | "stateProvince"> & {
+    stateProvince?: string;
+};
+export type ServicePointProvider = {
+    carrierId: string;
+    serviceCode?: string[];
+};
+export type GetServicePointParams = {
+    carrierCode: string;
+    countryCode: string;
+    id: string;
+};

package/shipping-rules/api.d.ts

@@ -1,5 +1,5 @@
 import { AxiosInstance } from "axios";
-import { RuleConditionsOptions, ShippingRule, ShippingRuleInput } from "./types";
+import { RuleConditionsOptions, ShippingRule, ShippingRuleCreateInput, ShippingRuleEditInput } from "./types";
 /**
  * # Shipping Rules API module - /v1/shipping_rules
  */
@@ -19,7 +19,7 @@ export declare class ShippingRulesAPI {
     /**
      * The `create` method creates a new shipping rule for a given user.
      */
-    create: (shippingRule: ShippingRuleInput) => Promise<import("axios").AxiosResponse<ShippingRule, any>>;
+    create: (shippingRule: ShippingRuleCreateInput) => Promise<import("axios").AxiosResponse<ShippingRule, any>>;
     /**
      * The `delete` method deletes a shipping rule by `shippingRuleId`.
      */
@@ -28,7 +28,7 @@ export declare class ShippingRulesAPI {
      * The `edit` method edits a specific shipping rule by `shippingRuleId` with a new
      * `ShippingRule`.
      */
-    edit: (shippingRule: ShippingRule) => Promise<import("axios").AxiosResponse<ShippingRule, any>>;
+    edit: (shippingRule: ShippingRuleEditInput) => Promise<import("axios").AxiosResponse<ShippingRule, any>>;
     /**
      * The `getConditionOptions` method retrieves the list of condition options availables for creating shipping rules.
      */

package/shipping-rules/types.d.ts

@@ -38,6 +38,13 @@ export interface Rule {
     priority: number;
     service: ShippingRuleSelectedService;
 }
+/**
+ * @category Entities
+ */
+export interface ExclusionRule {
+    conditions: ShippingRulesConditions[];
+    services: ShippingRuleSelectedService[];
+}
 /**
  * @category Entities
  */
@@ -48,20 +55,61 @@ export interface ShippingRuleSelectedService {
 /**
  * @category Entities
  */
-export interface ShippingRule {
-    active?: boolean;
-    code?: string;
+export type ShippingRuleSelectedServiceWithPriority = {
+    priority: number;
+} & ShippingRuleSelectedService;
+export interface CommonShippingRule {
+    code: string;
     createdAt?: ISOString;
-    default?: ShippingRuleSelectedService;
+    modifiedAt?: ISOString;
     name: string;
-    rules?: Rule[];
     shippingRuleId: string;
-    updatedAt?: ISOString;
 }
 /**
  * @category Entities
  */
-export type ShippingRuleInput = Omit<ShippingRule, "shippingRuleId">;
+export interface ConditionalShippingRule extends CommonShippingRule {
+    default?: ShippingRuleSelectedService;
+    rules?: Rule[];
+    type: "CONDITIONAL";
+}
+/**
+ * @category Entities
+ */
+export interface ServiceGroupShippingRule extends CommonShippingRule {
+    exclusionRules?: ExclusionRule[];
+    services: ShippingRuleSelectedServiceWithPriority[];
+    type: "SERVICE_GROUP";
+}
+export type ShippingRule = ConditionalShippingRule | ServiceGroupShippingRule;
+/**
+ * @category Entities
+ */
+export type ShippingRuleType = ShippingRule["type"];
+/**
+ * @category Entities
+ */
+export type ConditionalShippingRuleCreateInput = Omit<ConditionalShippingRule, "shippingRuleId" | "code">;
+/**
+ * @category Entities
+ */
+export type ServiceGroupShippingRuleCreateInput = Omit<ServiceGroupShippingRule, "shippingRuleId" | "code">;
+/**
+ * @category Entities
+ */
+export type ConditionalShippingRuleEditInput = Omit<ConditionalShippingRule, "code">;
+/**
+ * @category Entities
+ */
+export type ServiceGroupShippingRuleEditInput = Omit<ServiceGroupShippingRule, "code">;
+/**
+ * @category Entities
+ */
+export type ShippingRuleCreateInput = ConditionalShippingRuleCreateInput | ServiceGroupShippingRuleCreateInput;
+/**
+ * @category Entities
+ */
+export type ShippingRuleEditInput = ConditionalShippingRuleEditInput | ServiceGroupShippingRuleEditInput;
 /**
  * @category Entities
  */

package/types.d.ts

@@ -18,6 +18,7 @@ export * from "./relay-points/types";
 export * from "./resources/types";
 export * from "./sales-order-shipments/types";
 export * from "./sales-orders/types";
+export * from "./service-points/types";
 export * from "./shipments/types";
 export * from "./shipping-rules/types";
 export * from "./themes/types";