@shipengine/js-api 2.3.1 → 2.5.0

package/client.d.ts

@@ -72,12 +72,23 @@ export interface ShipEngineAPIConfig {
  */
 export declare class ShipEngineAPI {
     private client;
-    private sandboxToken?;
+    private getSandboxToken?;
+    sandboxToken?: string;
     constructor(token: string, { baseURL, headers, getToken, getSandboxToken, onApiError }: ShipEngineAPIConfig);
     /**
      * The `token` method takes in a string and sets it as the Authorization header for all requests.
      */
     set token(token: string);
+    get token(): string;
+    /**
+     * The `getTenant` method get the current token (based on `isSandbox` prop) and will get the Tenant ID from
+     * that token (also known as Seller ID)
+     */
+    getTenant(isSandbox?: boolean): Promise<string | null>;
+    /**
+     * The `getTenantFromToken` method receives a token and returns the Tenant ID associated with it.
+     */
+    private getTenantFromToken;
     /**
      * The `accountSettings` method provides access to the Account Settings endpoints
      * in ShipEngine API.

package/index.js

@@ -127,6 +127,8 @@ var CustomsNonDeliveryType = /* @__PURE__ */ ((CustomsNonDeliveryType2) => {
 })(CustomsNonDeliveryType || {});
 var InsuranceProviderType = /* @__PURE__ */ ((InsuranceProviderType2) => {
   InsuranceProviderType2["FUNDING_SOURCE"] = "funding_source";
+  InsuranceProviderType2["PARCELGUARD"] = "parcelguard";
+  InsuranceProviderType2["X_COVER"] = "x_cover";
   InsuranceProviderType2["SHIPSURANCE"] = "shipsurance";
   InsuranceProviderType2["CARRIER"] = "carrier";
   InsuranceProviderType2["THIRD_PARTY"] = "third_party";
@@ -973,7 +975,7 @@ var ipaddr = {
 	}).call(commonjsGlobal);
 } (ipaddr));
 
-var __async$5 = (__this, __arguments, generator) => {
+var __async$6 = (__this, __arguments, generator) => {
   return new Promise((resolve, reject) => {
     var fulfilled = (value) => {
       try {
@@ -993,7 +995,7 @@ var __async$5 = (__this, __arguments, generator) => {
     step((generator = generator.apply(__this, __arguments)).next());
   });
 };
-const getEndUserIpAddress = () => __async$5(void 0, null, function* () {
+const getEndUserIpAddress = () => __async$6(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)) {
@@ -1036,7 +1038,7 @@ var __objRest = (source, exclude) => {
     }
   return target;
 };
-var __async$4 = (__this, __arguments, generator) => {
+var __async$5 = (__this, __arguments, generator) => {
   return new Promise((resolve, reject) => {
     var fulfilled = (value) => {
       try {
@@ -1076,7 +1078,7 @@ class CarriersAPI {
     /**
      * The `connect` method connects a carrier account to a user's ShipEngine account.
      */
-    this.connect = (_a) => __async$4(this, null, function* () {
+    this.connect = (_a) => __async$5(this, null, function* () {
       var _b = _a, { carrierCode } = _b, connection = __objRest(_b, ["carrierCode"]);
       const endUserIpAddress = yield getEndUserIpAddress();
       if (!endUserIpAddress)
@@ -1167,7 +1169,7 @@ class CarriersAPI {
   }
 }
 
-var __async$3 = (__this, __arguments, generator) => {
+var __async$4 = (__this, __arguments, generator) => {
   return new Promise((resolve, reject) => {
     var fulfilled = (value) => {
       try {
@@ -1209,7 +1211,7 @@ class ConnectionsAPI {
     /**
      * The `connectCarrier` method connects a carrier to account.
      */
-    this.connectCarrier = (carrierName, formData) => __async$3(this, null, function* () {
+    this.connectCarrier = (carrierName, formData) => __async$4(this, null, function* () {
       return yield this.client.post(
         `/v1/connections/carriers/${carrierName}`,
         formData,
@@ -1395,6 +1397,64 @@ var humps = {
 	})(commonjsGlobal);
 } (humps));
 
+class InvalidTokenError extends Error {
+}
+InvalidTokenError.prototype.name = "InvalidTokenError";
+function b64DecodeUnicode(str) {
+    return decodeURIComponent(atob(str).replace(/(.)/g, (m, p) => {
+        let code = p.charCodeAt(0).toString(16).toUpperCase();
+        if (code.length < 2) {
+            code = "0" + code;
+        }
+        return "%" + code;
+    }));
+}
+function base64UrlDecode(str) {
+    let output = str.replace(/-/g, "+").replace(/_/g, "/");
+    switch (output.length % 4) {
+        case 0:
+            break;
+        case 2:
+            output += "==";
+            break;
+        case 3:
+            output += "=";
+            break;
+        default:
+            throw new Error("base64 string is not of the correct length");
+    }
+    try {
+        return b64DecodeUnicode(output);
+    }
+    catch (err) {
+        return atob(output);
+    }
+}
+function jwtDecode(token, options) {
+    if (typeof token !== "string") {
+        throw new InvalidTokenError("Invalid token specified: must be a string");
+    }
+    options || (options = {});
+    const pos = options.header === true ? 0 : 1;
+    const part = token.split(".")[pos];
+    if (typeof part !== "string") {
+        throw new InvalidTokenError(`Invalid token specified: missing part #${pos + 1}`);
+    }
+    let decoded;
+    try {
+        decoded = base64UrlDecode(part);
+    }
+    catch (e) {
+        throw new InvalidTokenError(`Invalid token specified: invalid base64 for part #${pos + 1} (${e.message})`);
+    }
+    try {
+        return JSON.parse(decoded);
+    }
+    catch (e) {
+        throw new InvalidTokenError(`Invalid token specified: invalid json for part #${pos + 1} (${e.message})`);
+    }
+}
+
 /* eslint complexity: [2, 18], max-statements: [2, 33] */
 var shams = function hasSymbols() {
 	if (typeof Symbol !== 'function' || typeof Object.getOwnPropertySymbols !== 'function') { return false; }
@@ -3480,7 +3540,7 @@ var __spreadValues$3 = (a, b) => {
     }
   return a;
 };
-var __async$2 = (__this, __arguments, generator) => {
+var __async$3 = (__this, __arguments, generator) => {
   return new Promise((resolve, reject) => {
     var fulfilled = (value) => {
       try {
@@ -3519,7 +3579,7 @@ class FundingSourcesAPI {
      * The `create` method creates a new funding source for a given user. This requires
      * payment information to be collected from the user.
      */
-    this.create = (createFundingSource) => __async$2(this, null, function* () {
+    this.create = (createFundingSource) => __async$3(this, null, function* () {
       const endUserIpAddress = yield getEndUserIpAddress();
       if (!endUserIpAddress) {
         return Promise.reject([new CodedError("Unable to get IP address")]);
@@ -3533,7 +3593,7 @@ class FundingSourcesAPI {
      * user to update the billing address or payment information associated with the
      * funding source.
      */
-    this.update = (billingInfo, creditCardInfo, fundingSourceId) => __async$2(this, null, function* () {
+    this.update = (billingInfo, creditCardInfo, fundingSourceId) => __async$3(this, null, function* () {
       const endUserIpAddress = yield getEndUserIpAddress();
       if (!endUserIpAddress) {
         return Promise.reject([new CodedError("Unable to get IP address")]);
@@ -3551,7 +3611,7 @@ class FundingSourcesAPI {
      * The `registerCarrier` method registers a carrier account and associates
      * it with a given funding source.
      */
-    this.registerCarrier = (carrier) => __async$2(this, null, function* () {
+    this.registerCarrier = (carrier) => __async$3(this, null, function* () {
       const endUserIpAddress = yield getEndUserIpAddress();
       if (!endUserIpAddress) {
         return Promise.reject([new CodedError("Unable to get IP address")]);
@@ -3563,7 +3623,7 @@ class FundingSourcesAPI {
     /**
      * The `addFunds` method allows you to add funds to a funding source.
      */
-    this.addFunds = (amount, fundingSourceId) => __async$2(this, null, function* () {
+    this.addFunds = (amount, fundingSourceId) => __async$3(this, null, function* () {
       return yield this.client.put(
         `/v1/funding_sources/${fundingSourceId}/add_funds`,
         amount
@@ -3573,7 +3633,7 @@ class FundingSourcesAPI {
      * The `metadata` method returns seller-specific requirements for creating funding sources
      * and attaching carriers
      */
-    this.metadata = () => __async$2(this, null, function* () {
+    this.metadata = () => __async$3(this, null, function* () {
       return yield this.client.get("/v1/funding_sources/metadata");
     });
     /**
@@ -3872,6 +3932,26 @@ class SalesOrdersAPI {
   }
 }
 
+var __async$2 = (__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 SellersAPI {
   constructor(client) {
     /**
@@ -3880,6 +3960,55 @@ class SellersAPI {
     this.listSandboxSellerIds = ({ sellerId }) => {
       return this.client.get(`/v1/sellers/sandbox_sellers/${sellerId}`);
     };
+    /**
+     * Given a seller ID, returns a list of API Keys created for that seller.
+     */
+    this.listSellerApiKeys = (props) => {
+      return this.client.get(`/v1/sellers/api_keys?sellerId=${props.sellerId}`, {
+        isSandbox: props.isSandbox
+      });
+    };
+    /**
+     * Creates an API Key for a Seller ID
+     */
+    this.createSellerApiKey = ({
+      description,
+      sellerId,
+      isSandbox
+    }) => {
+      return this.client.post(
+        "/v1/sellers/create_key",
+        {
+          description,
+          sellerId
+        },
+        {
+          isSandbox
+        }
+      );
+    };
+    /**
+     * Deletes an API Key
+     */
+    this.deleteSellerApiKey = (_0) => __async$2(this, [_0], function* ({
+      encryptedApiKey,
+      sellerId,
+      isSandbox
+    }) {
+      const sellerApiKeys = yield this.listSellerApiKeys({ isSandbox, sellerId });
+      if (!sellerApiKeys.data.find((sellerApiKey) => sellerApiKey.encryptedApiKey === encryptedApiKey)) {
+        return Promise.reject([
+          new CodedError("Missing Seller ID from Token", {
+            errorCode: "unauthorized",
+            errorSource: "client",
+            errorType: "security"
+          })
+        ]);
+      }
+      return this.client.delete("/v1/sellers", {
+        data: encryptedApiKey
+      });
+    });
     /**
      * Creates a sandbox seller account for a given seller ID
      * you can pass in a flag to try to reuse the carrier connection.
@@ -21443,6 +21572,7 @@ const logger = E({
 });
 class ShipEngineAPI {
   constructor(token, { baseURL, headers, getToken, getSandboxToken, onApiError }) {
+    this.getSandboxToken = getSandboxToken;
     const client = axios.create({
       baseURL,
       headers: __spreadProps(__spreadValues({}, headers), {
@@ -21546,6 +21676,35 @@ class ShipEngineAPI {
   set token(token) {
     this.client.defaults.headers.common["Authorization"] = `Bearer ${token}`;
   }
+  get token() {
+    return this.client.defaults.headers.common["Authorization"];
+  }
+  /**
+   * The `getTenant` method get the current token (based on `isSandbox` prop) and will get the Tenant ID from
+   * that token (also known as Seller ID)
+   */
+  getTenant(isSandbox) {
+    return __async(this, null, function* () {
+      var _a;
+      if (!isSandbox) {
+        return this.getTenantFromToken(this.token);
+      }
+      if (!this.sandboxToken) {
+        this.sandboxToken = yield (_a = this.getSandboxToken) == null ? void 0 : _a.call(this);
+      }
+      return this.getTenantFromToken(this.sandboxToken);
+    });
+  }
+  /**
+   * The `getTenantFromToken` method receives a token and returns the Tenant ID associated with it.
+   */
+  getTenantFromToken(token) {
+    try {
+      return jwtDecode(token).tenant;
+    } catch (e) {
+      return null;
+    }
+  }
   /**
    * The `accountSettings` method provides access to the Account Settings endpoints
    * in ShipEngine API.

package/index.mjs

@@ -123,6 +123,8 @@ var CustomsNonDeliveryType = /* @__PURE__ */ ((CustomsNonDeliveryType2) => {
 })(CustomsNonDeliveryType || {});
 var InsuranceProviderType = /* @__PURE__ */ ((InsuranceProviderType2) => {
   InsuranceProviderType2["FUNDING_SOURCE"] = "funding_source";
+  InsuranceProviderType2["PARCELGUARD"] = "parcelguard";
+  InsuranceProviderType2["X_COVER"] = "x_cover";
   InsuranceProviderType2["SHIPSURANCE"] = "shipsurance";
   InsuranceProviderType2["CARRIER"] = "carrier";
   InsuranceProviderType2["THIRD_PARTY"] = "third_party";
@@ -969,7 +971,7 @@ var ipaddr = {
 	}).call(commonjsGlobal);
 } (ipaddr));
 
-var __async$5 = (__this, __arguments, generator) => {
+var __async$6 = (__this, __arguments, generator) => {
   return new Promise((resolve, reject) => {
     var fulfilled = (value) => {
       try {
@@ -989,7 +991,7 @@ var __async$5 = (__this, __arguments, generator) => {
     step((generator = generator.apply(__this, __arguments)).next());
   });
 };
-const getEndUserIpAddress = () => __async$5(void 0, null, function* () {
+const getEndUserIpAddress = () => __async$6(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)) {
@@ -1032,7 +1034,7 @@ var __objRest = (source, exclude) => {
     }
   return target;
 };
-var __async$4 = (__this, __arguments, generator) => {
+var __async$5 = (__this, __arguments, generator) => {
   return new Promise((resolve, reject) => {
     var fulfilled = (value) => {
       try {
@@ -1072,7 +1074,7 @@ class CarriersAPI {
     /**
      * The `connect` method connects a carrier account to a user's ShipEngine account.
      */
-    this.connect = (_a) => __async$4(this, null, function* () {
+    this.connect = (_a) => __async$5(this, null, function* () {
       var _b = _a, { carrierCode } = _b, connection = __objRest(_b, ["carrierCode"]);
       const endUserIpAddress = yield getEndUserIpAddress();
       if (!endUserIpAddress)
@@ -1163,7 +1165,7 @@ class CarriersAPI {
   }
 }
 
-var __async$3 = (__this, __arguments, generator) => {
+var __async$4 = (__this, __arguments, generator) => {
   return new Promise((resolve, reject) => {
     var fulfilled = (value) => {
       try {
@@ -1205,7 +1207,7 @@ class ConnectionsAPI {
     /**
      * The `connectCarrier` method connects a carrier to account.
      */
-    this.connectCarrier = (carrierName, formData) => __async$3(this, null, function* () {
+    this.connectCarrier = (carrierName, formData) => __async$4(this, null, function* () {
       return yield this.client.post(
         `/v1/connections/carriers/${carrierName}`,
         formData,
@@ -1391,6 +1393,64 @@ var humps = {
 	})(commonjsGlobal);
 } (humps));
 
+class InvalidTokenError extends Error {
+}
+InvalidTokenError.prototype.name = "InvalidTokenError";
+function b64DecodeUnicode(str) {
+    return decodeURIComponent(atob(str).replace(/(.)/g, (m, p) => {
+        let code = p.charCodeAt(0).toString(16).toUpperCase();
+        if (code.length < 2) {
+            code = "0" + code;
+        }
+        return "%" + code;
+    }));
+}
+function base64UrlDecode(str) {
+    let output = str.replace(/-/g, "+").replace(/_/g, "/");
+    switch (output.length % 4) {
+        case 0:
+            break;
+        case 2:
+            output += "==";
+            break;
+        case 3:
+            output += "=";
+            break;
+        default:
+            throw new Error("base64 string is not of the correct length");
+    }
+    try {
+        return b64DecodeUnicode(output);
+    }
+    catch (err) {
+        return atob(output);
+    }
+}
+function jwtDecode(token, options) {
+    if (typeof token !== "string") {
+        throw new InvalidTokenError("Invalid token specified: must be a string");
+    }
+    options || (options = {});
+    const pos = options.header === true ? 0 : 1;
+    const part = token.split(".")[pos];
+    if (typeof part !== "string") {
+        throw new InvalidTokenError(`Invalid token specified: missing part #${pos + 1}`);
+    }
+    let decoded;
+    try {
+        decoded = base64UrlDecode(part);
+    }
+    catch (e) {
+        throw new InvalidTokenError(`Invalid token specified: invalid base64 for part #${pos + 1} (${e.message})`);
+    }
+    try {
+        return JSON.parse(decoded);
+    }
+    catch (e) {
+        throw new InvalidTokenError(`Invalid token specified: invalid json for part #${pos + 1} (${e.message})`);
+    }
+}
+
 /* eslint complexity: [2, 18], max-statements: [2, 33] */
 var shams = function hasSymbols() {
 	if (typeof Symbol !== 'function' || typeof Object.getOwnPropertySymbols !== 'function') { return false; }
@@ -3476,7 +3536,7 @@ var __spreadValues$3 = (a, b) => {
     }
   return a;
 };
-var __async$2 = (__this, __arguments, generator) => {
+var __async$3 = (__this, __arguments, generator) => {
   return new Promise((resolve, reject) => {
     var fulfilled = (value) => {
       try {
@@ -3515,7 +3575,7 @@ class FundingSourcesAPI {
      * The `create` method creates a new funding source for a given user. This requires
      * payment information to be collected from the user.
      */
-    this.create = (createFundingSource) => __async$2(this, null, function* () {
+    this.create = (createFundingSource) => __async$3(this, null, function* () {
       const endUserIpAddress = yield getEndUserIpAddress();
       if (!endUserIpAddress) {
         return Promise.reject([new CodedError("Unable to get IP address")]);
@@ -3529,7 +3589,7 @@ class FundingSourcesAPI {
      * user to update the billing address or payment information associated with the
      * funding source.
      */
-    this.update = (billingInfo, creditCardInfo, fundingSourceId) => __async$2(this, null, function* () {
+    this.update = (billingInfo, creditCardInfo, fundingSourceId) => __async$3(this, null, function* () {
       const endUserIpAddress = yield getEndUserIpAddress();
       if (!endUserIpAddress) {
         return Promise.reject([new CodedError("Unable to get IP address")]);
@@ -3547,7 +3607,7 @@ class FundingSourcesAPI {
      * The `registerCarrier` method registers a carrier account and associates
      * it with a given funding source.
      */
-    this.registerCarrier = (carrier) => __async$2(this, null, function* () {
+    this.registerCarrier = (carrier) => __async$3(this, null, function* () {
       const endUserIpAddress = yield getEndUserIpAddress();
       if (!endUserIpAddress) {
         return Promise.reject([new CodedError("Unable to get IP address")]);
@@ -3559,7 +3619,7 @@ class FundingSourcesAPI {
     /**
      * The `addFunds` method allows you to add funds to a funding source.
      */
-    this.addFunds = (amount, fundingSourceId) => __async$2(this, null, function* () {
+    this.addFunds = (amount, fundingSourceId) => __async$3(this, null, function* () {
       return yield this.client.put(
         `/v1/funding_sources/${fundingSourceId}/add_funds`,
         amount
@@ -3569,7 +3629,7 @@ class FundingSourcesAPI {
      * The `metadata` method returns seller-specific requirements for creating funding sources
      * and attaching carriers
      */
-    this.metadata = () => __async$2(this, null, function* () {
+    this.metadata = () => __async$3(this, null, function* () {
       return yield this.client.get("/v1/funding_sources/metadata");
     });
     /**
@@ -3868,6 +3928,26 @@ class SalesOrdersAPI {
   }
 }
 
+var __async$2 = (__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 SellersAPI {
   constructor(client) {
     /**
@@ -3876,6 +3956,55 @@ class SellersAPI {
     this.listSandboxSellerIds = ({ sellerId }) => {
       return this.client.get(`/v1/sellers/sandbox_sellers/${sellerId}`);
     };
+    /**
+     * Given a seller ID, returns a list of API Keys created for that seller.
+     */
+    this.listSellerApiKeys = (props) => {
+      return this.client.get(`/v1/sellers/api_keys?sellerId=${props.sellerId}`, {
+        isSandbox: props.isSandbox
+      });
+    };
+    /**
+     * Creates an API Key for a Seller ID
+     */
+    this.createSellerApiKey = ({
+      description,
+      sellerId,
+      isSandbox
+    }) => {
+      return this.client.post(
+        "/v1/sellers/create_key",
+        {
+          description,
+          sellerId
+        },
+        {
+          isSandbox
+        }
+      );
+    };
+    /**
+     * Deletes an API Key
+     */
+    this.deleteSellerApiKey = (_0) => __async$2(this, [_0], function* ({
+      encryptedApiKey,
+      sellerId,
+      isSandbox
+    }) {
+      const sellerApiKeys = yield this.listSellerApiKeys({ isSandbox, sellerId });
+      if (!sellerApiKeys.data.find((sellerApiKey) => sellerApiKey.encryptedApiKey === encryptedApiKey)) {
+        return Promise.reject([
+          new CodedError("Missing Seller ID from Token", {
+            errorCode: "unauthorized",
+            errorSource: "client",
+            errorType: "security"
+          })
+        ]);
+      }
+      return this.client.delete("/v1/sellers", {
+        data: encryptedApiKey
+      });
+    });
     /**
      * Creates a sandbox seller account for a given seller ID
      * you can pass in a flag to try to reuse the carrier connection.
@@ -21439,6 +21568,7 @@ const logger = E({
 });
 class ShipEngineAPI {
   constructor(token, { baseURL, headers, getToken, getSandboxToken, onApiError }) {
+    this.getSandboxToken = getSandboxToken;
     const client = axios.create({
       baseURL,
       headers: __spreadProps(__spreadValues({}, headers), {
@@ -21542,6 +21672,35 @@ class ShipEngineAPI {
   set token(token) {
     this.client.defaults.headers.common["Authorization"] = `Bearer ${token}`;
   }
+  get token() {
+    return this.client.defaults.headers.common["Authorization"];
+  }
+  /**
+   * The `getTenant` method get the current token (based on `isSandbox` prop) and will get the Tenant ID from
+   * that token (also known as Seller ID)
+   */
+  getTenant(isSandbox) {
+    return __async(this, null, function* () {
+      var _a;
+      if (!isSandbox) {
+        return this.getTenantFromToken(this.token);
+      }
+      if (!this.sandboxToken) {
+        this.sandboxToken = yield (_a = this.getSandboxToken) == null ? void 0 : _a.call(this);
+      }
+      return this.getTenantFromToken(this.sandboxToken);
+    });
+  }
+  /**
+   * The `getTenantFromToken` method receives a token and returns the Tenant ID associated with it.
+   */
+  getTenantFromToken(token) {
+    try {
+      return jwtDecode(token).tenant;
+    } catch (e) {
+      return null;
+    }
+  }
   /**
    * The `accountSettings` method provides access to the Account Settings endpoints
    * in ShipEngine API.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shipengine/js-api",
-  "version": "2.3.1",
+  "version": "2.5.0",
   "main": "./index.js",
   "types": "./index.d.ts",
   "exports": {
@@ -17,6 +17,7 @@
     "tsconfig": "./tsconfig.lib.json"
   },
   "peerDependencies": {
-    "axios": "^0.26.1"
+    "axios": "^0.26.1",
+    "jwt-decode": "^4.0.0"
   }
 }

package/sellers/api.d.ts

@@ -1,6 +1,6 @@
 import { AxiosInstance } from "axios";
-import { SandboxableMutation } from "../resources";
-import type { ListSandboxSellersParams, SandboxMethodParams } from "./types";
+import { SandboxableMutation, SandboxableQuery } from "../resources";
+import type { CreateSellerApiKeyParams, DeleteSellerApiKeyParams, ListSandboxSellersParams, SandboxMethodParams, SellerApiKey } from "./types";
 /**
  * Sellers API endpoints
  */
@@ -11,6 +11,20 @@ export declare class SellersAPI {
      * Given a seller ID, returns a list of sandbox seller IDs for that seller.
      */
     listSandboxSellerIds: ({ sellerId }: ListSandboxSellersParams) => Promise<import("axios").AxiosResponse<string[], any>>;
+    /**
+     * Given a seller ID, returns a list of API Keys created for that seller.
+     */
+    listSellerApiKeys: (props: SandboxableQuery<{
+        sellerId: string;
+    }>) => Promise<import("axios").AxiosResponse<SellerApiKey[], any>>;
+    /**
+     * Creates an API Key for a Seller ID
+     */
+    createSellerApiKey: ({ description, sellerId, isSandbox, }: SandboxableMutation<CreateSellerApiKeyParams>) => Promise<import("axios").AxiosResponse<SellerApiKey, any>>;
+    /**
+     * Deletes an API Key
+     */
+    deleteSellerApiKey: ({ encryptedApiKey, sellerId, isSandbox, }: SandboxableMutation<DeleteSellerApiKeyParams>) => Promise<import("axios").AxiosResponse<void, any>>;
     /**
      * Creates a sandbox seller account for a given seller ID
      * you can pass in a flag to try to reuse the carrier connection.

package/sellers/types.d.ts

@@ -1,7 +1,25 @@
 export type ListSandboxSellersParams = {
     sellerId: string;
 };
+export type ListSellerApiKeysParams = {
+    sellerId: string;
+};
 export type SandboxMethodParams = {
     sellerId: string;
     tryReuseCarrierConnection?: boolean;
 };
+export type DeleteSellerApiKeyParams = {
+    encryptedApiKey: string;
+    sellerId: string;
+};
+export type CreateSellerApiKeyParams = {
+    description?: string;
+    sellerId: string;
+};
+export type SellerApiKey = {
+    accountId: number;
+    apiKeyId: number;
+    createdAt: string;
+    description?: string;
+    encryptedApiKey: string;
+};

package/shipments/types.d.ts

@@ -74,6 +74,8 @@ export type DangerousGoodsRegulationLevel = "lightly_regulated" | "fully_regulat
 export type DangerousGoodsTransportMean = "ground" | "water" | "cargo_aircraft_only" | "passenger_aircraft";
 export declare enum InsuranceProviderType {
     FUNDING_SOURCE = "funding_source",
+    PARCELGUARD = "parcelguard",
+    X_COVER = "x_cover",
     SHIPSURANCE = "shipsurance",
     CARRIER = "carrier",
     THIRD_PARTY = "third_party",
@@ -172,6 +174,7 @@ export interface Shipment {
         billToCountryCode?: string;
         billToParty?: BillToParties;
         billToPostalCode?: string;
+        canadaDeliveredDuty?: "sender_prepay" | null;
         collectOnDelivery?: {
             paymentAmount: Money;
             paymentType: PaymentTypes;