@shipengine/js-api 3.1.0 → 3.3.0

package/addresses/types.d.ts

@@ -1,18 +1,28 @@
 export type AddressResidentialIndicator = "yes" | "no" | "unknown";
+/**
+ * @category Entities
+ */
+export interface ShippingAddress extends Address {
+    instructions?: string | null;
+}
+/**
+ * @category Entities
+ */
+export interface ShippingAddressTo extends ShippingAddress {
+    geolocation?: AddressGeolocation[] | null;
+}
 /**
  * @category Entities
  */
 export interface Address {
     addressLine1: string;
-    addressLine2?: string;
-    addressLine3?: string;
+    addressLine2?: string | null;
+    addressLine3?: string | null;
     addressResidentialIndicator?: AddressResidentialIndicator;
     cityLocality: string;
     companyName?: string;
     countryCode: string;
     email?: string;
-    geolocation?: AddressGeolocation[];
-    instructions?: string;
     name: string;
     phone: string;
     postalCode: string;

package/client.d.ts

@@ -8,6 +8,7 @@ import { CustomPackagesAPI } from "./custom-packages";
 import { CodedError } from "./errors";
 import { FundingSourcesAPI } from "./funding-sources";
 import { InsuranceAPI } from "./insurance";
+import { InvoiceAddressAPI } from "./invoice-address";
 import { LabelsAPI } from "./labels";
 import { OrderSourcesAPI } from "./order-sources";
 import { RateCardsAPI } from "./rate-cards";
@@ -143,6 +144,13 @@ export declare class ShipEngineAPI {
      * @see {@link InsuranceAPI | The Insurance API module}
      */
     get insurance(): InsuranceAPI;
+    /**
+     * The `invoiceAddress` method provides access to the Invoice Address endpoints
+     * in ShipEngine API.
+     *
+     * @see {@link InvoiceAddress | The Invoice Address API module}
+     */
+    get invoiceAddress(): InvoiceAddressAPI;
     /**
      * The `labels` method provides access to the Label endpoints in ShipEngine API.
      * e.g. Create Label, Get Label, Void Label, etc.

package/funding-sources/api.d.ts

@@ -3,6 +3,7 @@ import { Money } from "../payments";
 import { CreationRangeQuery, PageableQuery } from "../resources";
 import { AddFundsResponse, CarrierRegistration, CarrierRegistrationResponse, CreateFundingSource, CreditCardInfo, FundingSource, FundingSourceAddress, FundingSourceCreateResponse, FundingSourceTransactionsResponse, InsuranceFundingSourceAcceptedTermsResponse, MetadataResponse } from "./types";
 /**
+ * @internal
  * # Funding Sources API module - /v1/funding_sources
  * Docs: https://auctane.atlassian.net/wiki/spaces/SE/pages/3628370266/ShipEngine+Funding+Sources+API
  */

package/funding-sources/types.d.ts

@@ -1,9 +1,11 @@
 import { PageableResult } from "../resources";
 /**
+ * @internal
  * An encoded device fingerprint string containing information about the end-user's computing device such as OS, browser, etc.
  * Required for carrier registration and US Wallet creation.
  */
 type IovationBlackBox = string;
+/** @internal */
 export type CreateFundingSource = {
     acceptedTerms: Term[];
     agreeToTerms: boolean;
@@ -13,7 +15,9 @@ export type CreateFundingSource = {
         creditCardInfo: CreditCardInfo;
     };
 };
+/** @internal */
 export type FundingSource = {
+    balance: number;
     billingInfo: FundingSourceAddress;
     currencyCode: string;
     defaultCarrierId: string;
@@ -22,16 +26,21 @@ export type FundingSource = {
         creditCardInfo: AbbreviatedCreditCardInfo | null;
     };
 };
+/** @internal */
 export type AbbreviatedCreditCardInfo = {
     cardNumberLastFour: string;
     provider: Provider;
 };
+/** @internal */
 export type FundingSourceInsuranceProvider = "parcelguard" | "x_cover";
+/** @internal */
 export type Provider = "visa" | "mastercard" | "americanExpress" | "discover";
+/** @internal */
 export interface FundingSourcePickupAddress extends Omit<FundingSourceAddress, "email" | "phone"> {
     email?: string;
     phone?: string;
 }
+/** @internal */
 export type FundingSourceCarrier = {
     acceptedTerms: Term[];
     agreeToTerms: boolean;
@@ -40,19 +49,22 @@ export type FundingSourceCarrier = {
     iovationBlackBox: IovationBlackBox;
     pickupAddress?: FundingSourcePickupAddress;
 };
+/** @internal */
 export type CarrierRegistrationInsuranceProvider = {
     acceptedTerms: Term[];
     agreeToTerms: boolean;
     fundingSourceId: string;
     provider: FundingSourceInsuranceProvider;
 };
+/** @internal */
 export interface CarrierRegistration {
     carriers?: FundingSourceCarrier[];
     insuranceProviders?: CarrierRegistrationInsuranceProvider[];
 }
+/** @internal */
 export interface FundingSourceAddress {
     addressLine1: string;
-    addressLine2?: string;
+    addressLine2?: string | null;
     cityLocality: string;
     company?: string;
     countryCode: string;
@@ -62,6 +74,7 @@ export interface FundingSourceAddress {
     postalCode: string;
     stateProvince: string;
 }
+/** @internal */
 export interface CreditCardInfo {
     cardNumber: string;
     cvv: string;
@@ -70,21 +83,26 @@ export interface CreditCardInfo {
     name: string;
     provider: Provider;
 }
+/** @internal */
 export interface Term {
     termType: string;
     version: string;
 }
+/** @internal */
 export interface MetadataTermLink {
     link: string;
     locale: string;
     title: string;
 }
+/** @internal */
 export interface MetadataOptionalTerm extends Term {
     links: MetadataTermLink[];
 }
+/** @internal */
 export interface MetadataRequiredTerm extends Term {
     links: MetadataTermLink[];
 }
+/** @internal */
 export declare enum MetadataCapability {
     AutoFunding = "auto_funding",
     UpdatePaymentMethod = "update_payment_method",
@@ -97,6 +115,7 @@ export declare enum MetadataCapability {
     AccountSettingsLink = "account_settings_link",
     Unknown = "unknown"
 }
+/** @internal */
 export declare enum MetadataRequirement {
     BillingAddress = "billing_address",
     CurrencyCode = "currency_code",
@@ -106,6 +125,7 @@ export declare enum MetadataRequirement {
     PickupAddress = "pickup_address",
     Unknown = "unknown"
 }
+/** @internal */
 export declare enum MetadataSatisfyingFormTypes {
     Address = "address",
     CreditCard = "credit_card",
@@ -113,17 +133,21 @@ export declare enum MetadataSatisfyingFormTypes {
     StampsSellerLabelProvider = "stamps_seller_label_provider",
     Unknown = "unknown"
 }
+/** @internal */
 export type MetadataRegistrationRequirement = {
     requirementType: MetadataRequirement;
     satisfyingFormTypes: MetadataSatisfyingFormTypes[];
 };
+/** @internal */
 export type MetadataCarrierProfile = {
     capabilities: MetadataCapability[] | null;
     carrierCode: string;
     registrationRequirements: MetadataRegistrationRequirement[];
     requiredTerms: MetadataRequiredTerm[];
 };
+/** @internal */
 export type TransactionCategory = "adjustment" | "credit" | "debit" | "funds_added" | "insurance" | "label" | "refund" | "service_charge" | "unknown";
+/** @internal */
 export type FundingSourceTransactionInvoice = {
     invoiceDownload: {
         pdf: string;
@@ -131,6 +155,7 @@ export type FundingSourceTransactionInvoice = {
     invoiceId: string;
     reference: string;
 };
+/** @internal */
 export type FundingSourceTransaction = {
     description?: string | null;
     endingBalance: {
@@ -151,16 +176,19 @@ export type FundingSourceTransaction = {
     transactionCategory: TransactionCategory;
     transactionDate: string;
 };
+/** @internal */
 export interface FundingSourceInsuranceProviderResponse {
     errorMessage: null | string;
     fundingSourceId: string;
     isSuccessful: boolean;
     provider: FundingSourceInsuranceProvider;
 }
+/** @internal */
 export interface FundingSourceCreateResponse {
     fundingSource: FundingSource;
     insuranceProviderAttachmentResults: FundingSourceInsuranceProviderResponse[];
 }
+/** @internal */
 export interface CarrierRegistrationResponse {
     carrierAttachmentResults: [
         {
@@ -173,6 +201,7 @@ export interface CarrierRegistrationResponse {
     ];
     insuranceProviderAttachmentResults: FundingSourceInsuranceProviderResponse[];
 }
+/** @internal */
 export interface MetadataResponse {
     defaultFundingSourceProfile: {
         capabilities: MetadataCapability[] | null;
@@ -188,15 +217,18 @@ export interface MetadataResponse {
         currencyCode: string;
     };
 }
+/** @internal */
 export type AddFundsResponse = {
     balance: {
         amount: number;
         currency: string;
     };
 };
+/** @internal */
 export type FundingSourceTransactionsResponse = {
     transactions: FundingSourceTransaction[];
 } & PageableResult;
+/** @internal */
 export type InsuranceFundingSourceAcceptedTermsResponse = {
     acceptedTerms: Term[];
 };

package/index.d.ts

@@ -9,6 +9,7 @@ export * from "./dimensions";
 export * from "./errors";
 export * from "./funding-sources";
 export * from "./insurance";
+export * from "./invoice-address";
 export * from "./labels";
 export * from "./order-sources";
 export * from "./payments";

package/index.js

@@ -975,7 +975,7 @@ var ipaddr = {
 	}).call(commonjsGlobal);
 } (ipaddr));
 
-var __async$6 = (__this, __arguments, generator) => {
+var __async$7 = (__this, __arguments, generator) => {
   return new Promise((resolve, reject) => {
     var fulfilled = (value) => {
       try {
@@ -995,7 +995,7 @@ var __async$6 = (__this, __arguments, generator) => {
     step((generator = generator.apply(__this, __arguments)).next());
   });
 };
-const getEndUserIpAddress = () => __async$6(void 0, null, function* () {
+const getEndUserIpAddress = () => __async$7(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)) {
@@ -1007,6 +1007,37 @@ const getEndUserIpAddress = () => __async$6(void 0, null, function* () {
   }
 });
 
+const camelizeKeys = (obj) => {
+  if (Array.isArray(obj)) {
+    return obj.map(camelizeKeys);
+  } else if (obj !== null && typeof obj === "object") {
+    const newObj = {};
+    for (const key in obj) {
+      if (Object.prototype.hasOwnProperty.call(obj, key)) {
+        const newKey = key.replace(/_([a-z])/g, (match, letter) => letter.toUpperCase());
+        newObj[newKey] = camelizeKeys(obj[key]);
+      }
+    }
+    return newObj;
+  }
+  return obj;
+};
+const decamelizeKeys = (obj, separator = "_") => {
+  if (Array.isArray(obj)) {
+    return obj.map((item) => decamelizeKeys(item, separator));
+  } else if (obj !== null && typeof obj === "object") {
+    const newObj = {};
+    for (const key in obj) {
+      if (Object.prototype.hasOwnProperty.call(obj, key)) {
+        const newKey = key.replace(/([A-Z])/g, (match) => separator + match.toLowerCase());
+        newObj[newKey] = decamelizeKeys(obj[key], separator);
+      }
+    }
+    return newObj;
+  }
+  return obj;
+};
+
 var __defProp$4 = Object.defineProperty;
 var __defProps$1 = Object.defineProperties;
 var __getOwnPropDescs$1 = Object.getOwnPropertyDescriptors;
@@ -1038,7 +1069,7 @@ var __objRest$1 = (source, exclude) => {
     }
   return target;
 };
-var __async$5 = (__this, __arguments, generator) => {
+var __async$6 = (__this, __arguments, generator) => {
   return new Promise((resolve, reject) => {
     var fulfilled = (value) => {
       try {
@@ -1078,7 +1109,7 @@ class CarriersAPI {
     /**
      * The `connect` method connects a carrier account to a user's ShipEngine account.
      */
-    this.connect = (_a) => __async$5(this, null, function* () {
+    this.connect = (_a) => __async$6(this, null, function* () {
       var _b = _a, { carrierCode } = _b, connection = __objRest$1(_b, ["carrierCode"]);
       const endUserIpAddress = yield getEndUserIpAddress();
       if (!endUserIpAddress)
@@ -1169,7 +1200,7 @@ class CarriersAPI {
   }
 }
 
-var __async$4 = (__this, __arguments, generator) => {
+var __async$5 = (__this, __arguments, generator) => {
   return new Promise((resolve, reject) => {
     var fulfilled = (value) => {
       try {
@@ -1211,7 +1242,7 @@ class ConnectionsAPI {
     /**
      * The `connectCarrier` method connects a carrier to account.
      */
-    this.connectCarrier = (carrierName, formData) => __async$4(this, null, function* () {
+    this.connectCarrier = (carrierName, formData) => __async$5(this, null, function* () {
       return yield this.client.post(
         `/v1/connections/carriers/${carrierName}`,
         formData,
@@ -1259,144 +1290,6 @@ class ConnectionsAPI {
 
 var o={trace:10,debug:20,info:30,warn:40,error:50,fatal:60},l={};function a(e){return "string"==typeof e?o[e.toLowerCase()]:e}function c(e,r){return c=Object.setPrototypeOf||function(e,r){return e.__proto__=r,e},c(e,r)}function u(){if("undefined"==typeof Reflect||!Reflect.construct)return !1;if(Reflect.construct.sham)return !1;if("function"==typeof Proxy)return !0;try{return Boolean.prototype.valueOf.call(Reflect.construct(Boolean,[],function(){})),!0}catch(e){return !1}}function f(e,r,t){return f=u()?Reflect.construct:function(e,r,t){var s=[null];s.push.apply(s,r);var i=new(Function.bind.apply(e,s));return t&&c(i,t.prototype),i},f.apply(null,arguments)}function h(e){if(null==e)return e;if(Array.isArray(e))return e.slice();if("object"==typeof e){var r={};return Object.keys(e).forEach(function(t){r[t]=e[t];}),r}return e}function v(e){return void 0===e?"undefined":null===e?"null":Array.isArray(e)?"[ "+e.map(function(e){return v(e)}).join(", ")+" ]":"object"==typeof e?JSON.stringify(e):"function"==typeof e?"[Function: "+e.name+"]":"boolean"==typeof e||"number"==typeof e?e:"'"+e.toString()+"'"}function p(e){if("string"!=typeof e){for(var r=new Array(arguments.length),t=0;t<arguments.length;t++)r[t]=v(arguments[t]);return r.join(" ")}for(var s=/%[sdj%]/g,i=1,n=arguments,o=n.length,l=String(e).replace(s,function(e){if("%%"===e)return "%";if(i>=o)return e;switch(e){case"%s":return String(n[i++]);case"%d":return Number(n[i++]);case"%j":try{return JSON.stringify(n[i++])}catch(e){return "[Circular]"}default:return e}}),a=n[i];i<o;a=n[++i])l+=null===a||"object"!=typeof a?" "+a:" "+v(a);return l}function m(e,r){var t=e.split("\n");t[0]&&t[0].indexOf("call-stack-error")>=0&&t.shift();var s=t[r],i=null;if(s){var n=/^\s*(at|.*@)\s*(.+)?$/.exec(s);i=Array.isArray(n)&&n[2]?n[2]:s;}return i}Object.keys(o).forEach(function(e){l[o[e]]=e;});var y={};function d(e,r){if(r){if(y[r])return;y[r]=!0;}console.error(e+"\n");}function g(e){return y[e]}function w(){var e=[];return function(r,t){return t&&"object"==typeof t?-1!==e.indexOf(t)?"[Circular]":(e.push(t),t):t}}var b=/*#__PURE__*/function(){function e(){}return e.prototype.write=function(e){e.level<30?console.log(e):e.level<40?console.info(e):e.level<50?console.warn(e):console.error(e),e.err&&e.err.stack&&console.error(e.err.stack),e.obj&&console.log(e.obj);},e}(),j=/*#__PURE__*/function(){function e(r,t,s){var i,n,o,l,a=this;if(!(this instanceof e))return new e(r,t);if(void 0!==t&&(i=r,r=t,!(i instanceof e)))throw new TypeError("invalid Logger creation: do not pass a second arg");if(!r)throw new TypeError("options (object) is required");if(i){if(r.name)throw new TypeError("invalid options.name: child cannot set logger name")}else if(!r.name)throw new TypeError("options.name (string) is required");if(r.stream&&r.streams)throw new TypeError('cannot mix "streams" and "stream" options');if(r.streams&&!Array.isArray(r.streams))throw new TypeError("invalid options.streams: must be an array");if(r.serializers&&("object"!=typeof r.serializers||Array.isArray(r.serializers)))throw new TypeError("invalid options.serializers: must be an object");if(i&&s){this._level=i._level,this.streams=i.streams,this.serializers=i.serializers,this.src=i.src,n=this.fields={};var c=Object.keys(i.fields);for(l=0;l<c.length;l++)n[o=c[l]]=i.fields[o];var u=Object.keys(r);for(l=0;l<u.length;l++)n[o=u[l]]=r[o];}else {if(i){for(this._level=i._level,this.streams=[],l=0;l<i.streams.length;l++){var f=h(i.streams[l]);this.streams.push(f);}this.serializers=h(i.serializers),this.src=i.src,this.fields=h(i.fields),r.level&&this.level(r.level);}else this._level=Number.POSITIVE_INFINITY,this.streams=[],this.serializers=null,this.src=!1,this.fields={};r.stream?this.addStream({type:"stream",stream:r.stream,level:r.level}):r.streams?r.streams.forEach(function(e){a.addStream(e,r.level);}):i&&r.level?this.level(r.level):i||this.addStream({type:"raw",stream:new b,level:r.level}),r.serializers&&this.addSerializers(r.serializers),r.src&&(this.src=!0),delete(n=h(r)).stream,delete n.level,delete n.streams,delete n.serializers,delete n.src,this.serializers&&this._applySerializers(n),Object.keys(n).forEach(function(e){a.fields[e]=n[e];});}}var r=e.prototype;return r.addStream=function(e,r){void 0===r&&(r=30),(e=h(e)).type="raw",e.level=a(e.level||r),e.level<this._level&&(this._level=e.level),this.streams.push(e),delete this.haveNonRawStreams;},r.addSerializers=function(e){var r=this;this.serializers||(this.serializers={}),Object.keys(e).forEach(function(t){var s=e[t];if("function"!=typeof s)throw new TypeError(p('invalid serializer for "%s" field: must be a function',t));r.serializers[t]=s;});},r.child=function(e,r){return new this.constructor(this,e||{},r)},r.level=function(e){if(void 0===e)return this._level;for(var r=a(e),t=this.streams.length,s=0;s<t;s++)this.streams[s].level=r;this._level=r;},r.levels=function(e,r){if(void 0===e)return this.streams.map(function(e){return e.level});var t;if("number"==typeof e){if(void 0===(t=this.streams[e]))throw new Error("invalid stream index: "+e)}else {for(var s=this.streams.length,i=0;i<s;i++){var n=this.streams[i];if(n.name===e){t=n;break}}if(!t)throw new Error(p('no stream with name "%s"',e))}if(void 0===r)return t.level;var o=a(r);t.level=o,o<this._level&&(this._level=o);},r._applySerializers=function(e,r){var t=this;Object.keys(this.serializers).forEach(function(s){if(!(void 0===e[s]||r&&r[s]))try{e[s]=t.serializers[s](e[s]);}catch(r){d(p('bunyan: ERROR: Exception thrown from the "%s" Bunyan serializer. This should never happen. This is a bugin that serializer function.\n%s',s,r.stack||r)),e[s]=p('(Error in Bunyan log "%s" serializer broke field. See stderr for details.)',s);}});},r._emit=function(e,r){var t,s;if(void 0===this.haveNonRawStreams)for(this.haveNonRawStreams=!1,t=0;t<this.streams.length;t++)if(!this.streams[t].raw){this.haveNonRawStreams=!0;break}if(r||this.haveNonRawStreams)try{s=JSON.stringify(e,w())+"\n";}catch(r){var i=r.stack.split(/\n/g,2).join("\n");d('bunyan: ERROR: Exception in `JSON.stringify(rec)`. You can install the "safe-json-stringify" module to have Bunyan fallback to safer stringification. Record:\n'+function(e,r){return r||(r="    "),r+e.split(/\r?\n/g).join("\n"+r)}(p("%s\n%s",e,r.stack)),i),s=p("(Exception in JSON.stringify(rec): %j. See stderr for details.)\n",r.message);}if(r)return s;var n=e.level;for(t=0;t<this.streams.length;t++){var o=this.streams[t];o.level<=n&&o.stream.write(e);}return s},e}();function z(e){return function(){var r=this;function t(t){var n;t[0]instanceof Error?(s={err:r.serializers&&r.serializers.err?r.serializers.err(t[0]):k.err(t[0])},n={err:!0},i=1===t.length?[s.err.message]:Array.prototype.slice.call(t,1)):"object"!=typeof t[0]&&null!==t[0]||Array.isArray(t[0])?(s=null,i=Array.prototype.slice.call(t)):(s=t[0],i=1===t.length&&s.err&&s.err instanceof Error?[s.err.message]:Array.prototype.slice.call(t,1));var o=h(r.fields);o.level=e;var a=s?h(s):null;if(a&&(r.serializers&&r._applySerializers(a,n),Object.keys(a).forEach(function(e){o[e]=a[e];})),o.levelName=l[e],o.msg=i.length?p.apply(r,i):"",o.time||(o.time=new Date),r.src&&!o.src)try{throw new Error("call-stack-error")}catch(e){var c=e.stack?m(e.stack,2):"";c||g("src")||d("Unable to determine src line info","src"),o.src=c||"";}return o.v=1,o}var s=null,i=arguments,n=null;if(0===arguments.length)return this._level<=e;this._level>e||(n=t(i),this._emit(n));}}function S(e){var r=e.stack||e.toString();if(e.cause&&"function"==typeof e.cause){var t=e.cause();t&&(r+="\nCaused by: "+S(t));}return r}j.prototype.trace=z(10),j.prototype.debug=z(20),j.prototype.info=z(30),j.prototype.warn=z(40),j.prototype.error=z(50),j.prototype.fatal=z(60);var k={err:function(e){return e&&e.stack?{message:e.message,name:e.name,stack:S(e),code:e.code,signal:e.signal}:e}};function E(){return f(j,[].slice.call(arguments))}var A={levels:{trace:"color: DeepPink",debug:"color: GoldenRod",info:"color: DarkTurquoise",warn:"color: Purple",error:"color: Crimson",fatal:"color: Black"},def:"color: DimGray",msg:"color: SteelBlue",src:"color: DimGray; font-style: italic; font-size: 0.9em"},R=/*#__PURE__*/function(){function e(e){var r=void 0===e?{}:e,t=r.logByLevel,s=r.css,i=void 0===s?A:s;this.logByLevel=void 0!==t&&t,this.css=i;}return e.prototype.write=function(e){var r,t,s=this.css.def,i=this.css.msg,n=this.css.src,o=e.childName?e.name+"/"+e.childName:e.name,a=l[e.level],c=(Array(6-a.length).join(" ")+a).toUpperCase();this.logByLevel?(10===e.level?a="debug":60===e.level&&(a="error"),t="function"==typeof console[a]?console[a]:console.log):t=console.log,r=e.level<20?this.css.levels.trace:e.level<30?this.css.levels.debug:e.level<40?this.css.levels.info:e.level<50?this.css.levels.warn:e.level<60?this.css.levels.error:this.css.levels.fatal;var u=function(e,r){return Array(r+1-(e+"").length).join("0")+e},f=[];f.push("[%s:%s:%s:%s] %c%s%c: %s: %c%s "+(e.src?"%c%s":"")),f.push(u(e.time.getHours(),2)),f.push(u(e.time.getMinutes(),2)),f.push(u(e.time.getSeconds(),2)),f.push(u(e.time.getMilliseconds(),4)),f.push(r),f.push(c),f.push(s),f.push(o),f.push(i),f.push(e.msg),e.src&&(f.push(n),f.push(e.src)),e.obj&&(f.push("\n"),f.push(e.obj)),e.err&&e.err.stack&&(f.push("\n"),f.push(e.err.stack)),t.apply(console,f);},e.getDefaultCss=function(){return A},e}();
 
-var humpsExports = {};
-var humps = {
-  get exports(){ return humpsExports; },
-  set exports(v){ humpsExports = v; },
-};
-
-(function (module) {
-(function(global) {
-
-	  var _processKeys = function(convert, obj, options) {
-	    if(!_isObject(obj) || _isDate(obj) || _isRegExp(obj) || _isBoolean(obj) || _isFunction(obj)) {
-	      return obj;
-	    }
-
-	    var output,
-	        i = 0,
-	        l = 0;
-
-	    if(_isArray(obj)) {
-	      output = [];
-	      for(l=obj.length; i<l; i++) {
-	        output.push(_processKeys(convert, obj[i], options));
-	      }
-	    }
-	    else {
-	      output = {};
-	      for(var key in obj) {
-	        if(Object.prototype.hasOwnProperty.call(obj, key)) {
-	          output[convert(key, options)] = _processKeys(convert, obj[key], options);
-	        }
-	      }
-	    }
-	    return output;
-	  };
-
-	  // String conversion methods
-
-	  var separateWords = function(string, options) {
-	    options = options || {};
-	    var separator = options.separator || '_';
-	    var split = options.split || /(?=[A-Z])/;
-
-	    return string.split(split).join(separator);
-	  };
-
-	  var camelize = function(string) {
-	    if (_isNumerical(string)) {
-	      return string;
-	    }
-	    string = string.replace(/[\-_\s]+(.)?/g, function(match, chr) {
-	      return chr ? chr.toUpperCase() : '';
-	    });
-	    // Ensure 1st char is always lowercase
-	    return string.substr(0, 1).toLowerCase() + string.substr(1);
-	  };
-
-	  var pascalize = function(string) {
-	    var camelized = camelize(string);
-	    // Ensure 1st char is always uppercase
-	    return camelized.substr(0, 1).toUpperCase() + camelized.substr(1);
-	  };
-
-	  var decamelize = function(string, options) {
-	    return separateWords(string, options).toLowerCase();
-	  };
-
-	  // Utilities
-	  // Taken from Underscore.js
-
-	  var toString = Object.prototype.toString;
-
-	  var _isFunction = function(obj) {
-	    return typeof(obj) === 'function';
-	  };
-	  var _isObject = function(obj) {
-	    return obj === Object(obj);
-	  };
-	  var _isArray = function(obj) {
-	    return toString.call(obj) == '[object Array]';
-	  };
-	  var _isDate = function(obj) {
-	    return toString.call(obj) == '[object Date]';
-	  };
-	  var _isRegExp = function(obj) {
-	    return toString.call(obj) == '[object RegExp]';
-	  };
-	  var _isBoolean = function(obj) {
-	    return toString.call(obj) == '[object Boolean]';
-	  };
-
-	  // Performant way to determine if obj coerces to a number
-	  var _isNumerical = function(obj) {
-	    obj = obj - 0;
-	    return obj === obj;
-	  };
-
-	  // Sets up function which handles processing keys
-	  // allowing the convert function to be modified by a callback
-	  var _processor = function(convert, options) {
-	    var callback = options && 'process' in options ? options.process : options;
-
-	    if(typeof(callback) !== 'function') {
-	      return convert;
-	    }
-
-	    return function(string, options) {
-	      return callback(string, convert, options);
-	    }
-	  };
-
-	  var humps = {
-	    camelize: camelize,
-	    decamelize: decamelize,
-	    pascalize: pascalize,
-	    depascalize: decamelize,
-	    camelizeKeys: function(object, options) {
-	      return _processKeys(_processor(camelize, options), object);
-	    },
-	    decamelizeKeys: function(object, options) {
-	      return _processKeys(_processor(decamelize, options), object, options);
-	    },
-	    pascalizeKeys: function(object, options) {
-	      return _processKeys(_processor(pascalize, options), object);
-	    },
-	    depascalizeKeys: function () {
-	      return this.decamelizeKeys.apply(this, arguments);
-	    }
-	  };
-
-	  if (module.exports) {
-	    module.exports = humps;
-	  } else {
-	    global.humps = humps;
-	  }
-
-	})(commonjsGlobal);
-} (humps));
-
 class InvalidTokenError extends Error {
 }
 InvalidTokenError.prototype.name = "InvalidTokenError";
@@ -3540,7 +3433,7 @@ var __spreadValues$3 = (a, b) => {
     }
   return a;
 };
-var __async$3 = (__this, __arguments, generator) => {
+var __async$4 = (__this, __arguments, generator) => {
   return new Promise((resolve, reject) => {
     var fulfilled = (value) => {
       try {
@@ -3579,7 +3472,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$3(this, null, function* () {
+    this.create = (createFundingSource) => __async$4(this, null, function* () {
       const endUserIpAddress = yield getEndUserIpAddress();
       if (!endUserIpAddress) {
         return Promise.reject([new CodedError("Unable to get IP address")]);
@@ -3593,7 +3486,7 @@ class FundingSourcesAPI {
      * user to update the billing address or payment information associated with the
      * funding source.
      */
-    this.update = (billingInfo, creditCardInfo, fundingSourceId) => __async$3(this, null, function* () {
+    this.update = (billingInfo, creditCardInfo, fundingSourceId) => __async$4(this, null, function* () {
       const endUserIpAddress = yield getEndUserIpAddress();
       if (!endUserIpAddress) {
         return Promise.reject([new CodedError("Unable to get IP address")]);
@@ -3611,7 +3504,7 @@ class FundingSourcesAPI {
      * The `registerCarrier` method registers a carrier account and associates
      * it with a given funding source.
      */
-    this.registerCarrier = (carrier) => __async$3(this, null, function* () {
+    this.registerCarrier = (carrier) => __async$4(this, null, function* () {
       const endUserIpAddress = yield getEndUserIpAddress();
       if (!endUserIpAddress) {
         return Promise.reject([new CodedError("Unable to get IP address")]);
@@ -3623,7 +3516,7 @@ class FundingSourcesAPI {
     /**
      * The `addFunds` method allows you to add funds to a funding source.
      */
-    this.addFunds = (amount, fundingSourceId) => __async$3(this, null, function* () {
+    this.addFunds = (amount, fundingSourceId) => __async$4(this, null, function* () {
       return yield this.client.put(
         `/v1/funding_sources/${fundingSourceId}/add_funds`,
         amount
@@ -3633,7 +3526,7 @@ class FundingSourcesAPI {
      * The `metadata` method returns seller-specific requirements for creating funding sources
      * and attaching carriers
      */
-    this.metadata = () => __async$3(this, null, function* () {
+    this.metadata = () => __async$4(this, null, function* () {
       return yield this.client.get("/v1/funding_sources/metadata");
     });
     /**
@@ -3685,6 +3578,55 @@ class InsuranceAPI {
   }
 }
 
+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 InvoiceAddressAPI {
+  constructor(client) {
+    this.client = client;
+    /**
+     * The `get` method retrieves the invoice address for a given user.
+     */
+    this.get = () => {
+      return this.client.get("/v1/invoice_address");
+    };
+    /**
+     * The `create` method creates a new invoice address for a given user.
+     */
+    this.create = (invoiceAddress) => __async$3(this, null, function* () {
+      return yield this.client.post("/v1/invoice_address", {
+        invoiceAddress
+      });
+    });
+    /**
+     * The `update` method updates a invoice address for a given user.
+     */
+    this.update = (invoiceAddress) => __async$3(this, null, function* () {
+      return yield this.client.put("/v1/invoice_address", {
+        invoiceAddress
+      });
+    });
+    this.client = client;
+  }
+}
+
 class LabelsAPI {
   constructor(client) {
     this.client = client;
@@ -3897,10 +3839,14 @@ class SalesOrderShipmentsAPI {
     /**
      * The `list` method retrieves a list of sales order shipments for a given user.
      */
-    this.list = (body = {}, params) => {
-      return this.client.post("/v-beta/shipments/list", body, {
-        params
-      });
+    this.list = (body) => {
+      return this.client.post("/v-beta/shipments/list", body);
+    };
+    /**
+     * The `listShipmentsByExternalOrderId` method retrieves a list of shipments associated to a sales order that matches `externalOrderId`
+     */
+    this.listShipmentsByExternalOrderId = (externalOrderId) => {
+      return this.client.get(`/v-beta/shipments/external_order_id/${externalOrderId}`);
     };
     /**
      * The `get` method retrieves a specific sales order shipment by `shipmentId`.
@@ -3942,6 +3888,13 @@ class SalesOrdersAPI {
     this.get = (salesOrderId) => {
       return this.client.get(`/v-beta/sales_orders/${salesOrderId}`);
     };
+    /**
+     * The `getByExternalId` method retrieves a specific sales order by its `externalOrderId`.
+     * @param externalOrderId Id that matches that of the desired sales order.
+     */
+    this.getByExternalId = (externalOrderId) => {
+      return this.client.get(`/v-beta/sales_orders/external_order_id/${externalOrderId}`);
+    };
     /**
      * The `notifyShipped` method notifies order source that the order has been
      * shipped. Typically, the order source will then notify the user based on
@@ -21611,11 +21564,11 @@ class ShipEngineAPI {
       headers: __spreadProps(__spreadValues({}, headers), {
         "Content-Type": "application/json"
       }),
-      paramsSerializer: (params) => lib.stringify(humpsExports.decamelizeKeys(params), { arrayFormat: "brackets" }),
+      paramsSerializer: (params) => lib.stringify(decamelizeKeys(params), { arrayFormat: "brackets" }),
       transformRequest: [
         (data) => {
           if (data && !(data instanceof FormData))
-            return humpsExports.decamelizeKeys(data);
+            return decamelizeKeys(data);
           else
             return data;
         },
@@ -21635,7 +21588,7 @@ class ShipEngineAPI {
         },
         (data) => {
           if (data && !(data instanceof Blob))
-            return humpsExports.camelizeKeys(data);
+            return camelizeKeys(data);
           else
             return data;
         }
@@ -21808,6 +21761,15 @@ class ShipEngineAPI {
   get insurance() {
     return new InsuranceAPI(this.client);
   }
+  /**
+   * The `invoiceAddress` method provides access to the Invoice Address endpoints
+   * in ShipEngine API.
+   *
+   * @see {@link InvoiceAddress | The Invoice Address API module}
+   */
+  get invoiceAddress() {
+    return new InvoiceAddressAPI(this.client);
+  }
   /**
    * The `labels` method provides access to the Label endpoints in ShipEngine API.
    * e.g. Create Label, Get Label, Void Label, etc.
@@ -21937,6 +21899,7 @@ exports.CustomsNonDeliveryType = CustomsNonDeliveryType;
 exports.FundingSourcesAPI = FundingSourcesAPI;
 exports.InsuranceAPI = InsuranceAPI;
 exports.InsuranceProviderType = InsuranceProviderType;
+exports.InvoiceAddressAPI = InvoiceAddressAPI;
 exports.LabelsAPI = LabelsAPI;
 exports.MetadataCapability = MetadataCapability;
 exports.MetadataRequirement = MetadataRequirement;
@@ -21957,6 +21920,8 @@ exports.ShippingRulesAPI = ShippingRulesAPI;
 exports.ThemesAPI = ThemesAPI;
 exports.WarehousesAPI = WarehousesAPI;
 exports.WebhooksAPI = WebhooksAPI;
+exports.camelizeKeys = camelizeKeys;
+exports.decamelizeKeys = decamelizeKeys;
 exports.getEndUserIpAddress = getEndUserIpAddress;
 exports.isCodedError = isCodedError;
 exports.isCodedErrors = isCodedErrors;

package/index.mjs

@@ -971,7 +971,7 @@ var ipaddr = {
 	}).call(commonjsGlobal);
 } (ipaddr));
 
-var __async$6 = (__this, __arguments, generator) => {
+var __async$7 = (__this, __arguments, generator) => {
   return new Promise((resolve, reject) => {
     var fulfilled = (value) => {
       try {
@@ -991,7 +991,7 @@ var __async$6 = (__this, __arguments, generator) => {
     step((generator = generator.apply(__this, __arguments)).next());
   });
 };
-const getEndUserIpAddress = () => __async$6(void 0, null, function* () {
+const getEndUserIpAddress = () => __async$7(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)) {
@@ -1003,6 +1003,37 @@ const getEndUserIpAddress = () => __async$6(void 0, null, function* () {
   }
 });
 
+const camelizeKeys = (obj) => {
+  if (Array.isArray(obj)) {
+    return obj.map(camelizeKeys);
+  } else if (obj !== null && typeof obj === "object") {
+    const newObj = {};
+    for (const key in obj) {
+      if (Object.prototype.hasOwnProperty.call(obj, key)) {
+        const newKey = key.replace(/_([a-z])/g, (match, letter) => letter.toUpperCase());
+        newObj[newKey] = camelizeKeys(obj[key]);
+      }
+    }
+    return newObj;
+  }
+  return obj;
+};
+const decamelizeKeys = (obj, separator = "_") => {
+  if (Array.isArray(obj)) {
+    return obj.map((item) => decamelizeKeys(item, separator));
+  } else if (obj !== null && typeof obj === "object") {
+    const newObj = {};
+    for (const key in obj) {
+      if (Object.prototype.hasOwnProperty.call(obj, key)) {
+        const newKey = key.replace(/([A-Z])/g, (match) => separator + match.toLowerCase());
+        newObj[newKey] = decamelizeKeys(obj[key], separator);
+      }
+    }
+    return newObj;
+  }
+  return obj;
+};
+
 var __defProp$4 = Object.defineProperty;
 var __defProps$1 = Object.defineProperties;
 var __getOwnPropDescs$1 = Object.getOwnPropertyDescriptors;
@@ -1034,7 +1065,7 @@ var __objRest$1 = (source, exclude) => {
     }
   return target;
 };
-var __async$5 = (__this, __arguments, generator) => {
+var __async$6 = (__this, __arguments, generator) => {
   return new Promise((resolve, reject) => {
     var fulfilled = (value) => {
       try {
@@ -1074,7 +1105,7 @@ class CarriersAPI {
     /**
      * The `connect` method connects a carrier account to a user's ShipEngine account.
      */
-    this.connect = (_a) => __async$5(this, null, function* () {
+    this.connect = (_a) => __async$6(this, null, function* () {
       var _b = _a, { carrierCode } = _b, connection = __objRest$1(_b, ["carrierCode"]);
       const endUserIpAddress = yield getEndUserIpAddress();
       if (!endUserIpAddress)
@@ -1165,7 +1196,7 @@ class CarriersAPI {
   }
 }
 
-var __async$4 = (__this, __arguments, generator) => {
+var __async$5 = (__this, __arguments, generator) => {
   return new Promise((resolve, reject) => {
     var fulfilled = (value) => {
       try {
@@ -1207,7 +1238,7 @@ class ConnectionsAPI {
     /**
      * The `connectCarrier` method connects a carrier to account.
      */
-    this.connectCarrier = (carrierName, formData) => __async$4(this, null, function* () {
+    this.connectCarrier = (carrierName, formData) => __async$5(this, null, function* () {
       return yield this.client.post(
         `/v1/connections/carriers/${carrierName}`,
         formData,
@@ -1255,144 +1286,6 @@ class ConnectionsAPI {
 
 var o={trace:10,debug:20,info:30,warn:40,error:50,fatal:60},l={};function a(e){return "string"==typeof e?o[e.toLowerCase()]:e}function c(e,r){return c=Object.setPrototypeOf||function(e,r){return e.__proto__=r,e},c(e,r)}function u(){if("undefined"==typeof Reflect||!Reflect.construct)return !1;if(Reflect.construct.sham)return !1;if("function"==typeof Proxy)return !0;try{return Boolean.prototype.valueOf.call(Reflect.construct(Boolean,[],function(){})),!0}catch(e){return !1}}function f(e,r,t){return f=u()?Reflect.construct:function(e,r,t){var s=[null];s.push.apply(s,r);var i=new(Function.bind.apply(e,s));return t&&c(i,t.prototype),i},f.apply(null,arguments)}function h(e){if(null==e)return e;if(Array.isArray(e))return e.slice();if("object"==typeof e){var r={};return Object.keys(e).forEach(function(t){r[t]=e[t];}),r}return e}function v(e){return void 0===e?"undefined":null===e?"null":Array.isArray(e)?"[ "+e.map(function(e){return v(e)}).join(", ")+" ]":"object"==typeof e?JSON.stringify(e):"function"==typeof e?"[Function: "+e.name+"]":"boolean"==typeof e||"number"==typeof e?e:"'"+e.toString()+"'"}function p(e){if("string"!=typeof e){for(var r=new Array(arguments.length),t=0;t<arguments.length;t++)r[t]=v(arguments[t]);return r.join(" ")}for(var s=/%[sdj%]/g,i=1,n=arguments,o=n.length,l=String(e).replace(s,function(e){if("%%"===e)return "%";if(i>=o)return e;switch(e){case"%s":return String(n[i++]);case"%d":return Number(n[i++]);case"%j":try{return JSON.stringify(n[i++])}catch(e){return "[Circular]"}default:return e}}),a=n[i];i<o;a=n[++i])l+=null===a||"object"!=typeof a?" "+a:" "+v(a);return l}function m(e,r){var t=e.split("\n");t[0]&&t[0].indexOf("call-stack-error")>=0&&t.shift();var s=t[r],i=null;if(s){var n=/^\s*(at|.*@)\s*(.+)?$/.exec(s);i=Array.isArray(n)&&n[2]?n[2]:s;}return i}Object.keys(o).forEach(function(e){l[o[e]]=e;});var y={};function d(e,r){if(r){if(y[r])return;y[r]=!0;}console.error(e+"\n");}function g(e){return y[e]}function w(){var e=[];return function(r,t){return t&&"object"==typeof t?-1!==e.indexOf(t)?"[Circular]":(e.push(t),t):t}}var b=/*#__PURE__*/function(){function e(){}return e.prototype.write=function(e){e.level<30?console.log(e):e.level<40?console.info(e):e.level<50?console.warn(e):console.error(e),e.err&&e.err.stack&&console.error(e.err.stack),e.obj&&console.log(e.obj);},e}(),j=/*#__PURE__*/function(){function e(r,t,s){var i,n,o,l,a=this;if(!(this instanceof e))return new e(r,t);if(void 0!==t&&(i=r,r=t,!(i instanceof e)))throw new TypeError("invalid Logger creation: do not pass a second arg");if(!r)throw new TypeError("options (object) is required");if(i){if(r.name)throw new TypeError("invalid options.name: child cannot set logger name")}else if(!r.name)throw new TypeError("options.name (string) is required");if(r.stream&&r.streams)throw new TypeError('cannot mix "streams" and "stream" options');if(r.streams&&!Array.isArray(r.streams))throw new TypeError("invalid options.streams: must be an array");if(r.serializers&&("object"!=typeof r.serializers||Array.isArray(r.serializers)))throw new TypeError("invalid options.serializers: must be an object");if(i&&s){this._level=i._level,this.streams=i.streams,this.serializers=i.serializers,this.src=i.src,n=this.fields={};var c=Object.keys(i.fields);for(l=0;l<c.length;l++)n[o=c[l]]=i.fields[o];var u=Object.keys(r);for(l=0;l<u.length;l++)n[o=u[l]]=r[o];}else {if(i){for(this._level=i._level,this.streams=[],l=0;l<i.streams.length;l++){var f=h(i.streams[l]);this.streams.push(f);}this.serializers=h(i.serializers),this.src=i.src,this.fields=h(i.fields),r.level&&this.level(r.level);}else this._level=Number.POSITIVE_INFINITY,this.streams=[],this.serializers=null,this.src=!1,this.fields={};r.stream?this.addStream({type:"stream",stream:r.stream,level:r.level}):r.streams?r.streams.forEach(function(e){a.addStream(e,r.level);}):i&&r.level?this.level(r.level):i||this.addStream({type:"raw",stream:new b,level:r.level}),r.serializers&&this.addSerializers(r.serializers),r.src&&(this.src=!0),delete(n=h(r)).stream,delete n.level,delete n.streams,delete n.serializers,delete n.src,this.serializers&&this._applySerializers(n),Object.keys(n).forEach(function(e){a.fields[e]=n[e];});}}var r=e.prototype;return r.addStream=function(e,r){void 0===r&&(r=30),(e=h(e)).type="raw",e.level=a(e.level||r),e.level<this._level&&(this._level=e.level),this.streams.push(e),delete this.haveNonRawStreams;},r.addSerializers=function(e){var r=this;this.serializers||(this.serializers={}),Object.keys(e).forEach(function(t){var s=e[t];if("function"!=typeof s)throw new TypeError(p('invalid serializer for "%s" field: must be a function',t));r.serializers[t]=s;});},r.child=function(e,r){return new this.constructor(this,e||{},r)},r.level=function(e){if(void 0===e)return this._level;for(var r=a(e),t=this.streams.length,s=0;s<t;s++)this.streams[s].level=r;this._level=r;},r.levels=function(e,r){if(void 0===e)return this.streams.map(function(e){return e.level});var t;if("number"==typeof e){if(void 0===(t=this.streams[e]))throw new Error("invalid stream index: "+e)}else {for(var s=this.streams.length,i=0;i<s;i++){var n=this.streams[i];if(n.name===e){t=n;break}}if(!t)throw new Error(p('no stream with name "%s"',e))}if(void 0===r)return t.level;var o=a(r);t.level=o,o<this._level&&(this._level=o);},r._applySerializers=function(e,r){var t=this;Object.keys(this.serializers).forEach(function(s){if(!(void 0===e[s]||r&&r[s]))try{e[s]=t.serializers[s](e[s]);}catch(r){d(p('bunyan: ERROR: Exception thrown from the "%s" Bunyan serializer. This should never happen. This is a bugin that serializer function.\n%s',s,r.stack||r)),e[s]=p('(Error in Bunyan log "%s" serializer broke field. See stderr for details.)',s);}});},r._emit=function(e,r){var t,s;if(void 0===this.haveNonRawStreams)for(this.haveNonRawStreams=!1,t=0;t<this.streams.length;t++)if(!this.streams[t].raw){this.haveNonRawStreams=!0;break}if(r||this.haveNonRawStreams)try{s=JSON.stringify(e,w())+"\n";}catch(r){var i=r.stack.split(/\n/g,2).join("\n");d('bunyan: ERROR: Exception in `JSON.stringify(rec)`. You can install the "safe-json-stringify" module to have Bunyan fallback to safer stringification. Record:\n'+function(e,r){return r||(r="    "),r+e.split(/\r?\n/g).join("\n"+r)}(p("%s\n%s",e,r.stack)),i),s=p("(Exception in JSON.stringify(rec): %j. See stderr for details.)\n",r.message);}if(r)return s;var n=e.level;for(t=0;t<this.streams.length;t++){var o=this.streams[t];o.level<=n&&o.stream.write(e);}return s},e}();function z(e){return function(){var r=this;function t(t){var n;t[0]instanceof Error?(s={err:r.serializers&&r.serializers.err?r.serializers.err(t[0]):k.err(t[0])},n={err:!0},i=1===t.length?[s.err.message]:Array.prototype.slice.call(t,1)):"object"!=typeof t[0]&&null!==t[0]||Array.isArray(t[0])?(s=null,i=Array.prototype.slice.call(t)):(s=t[0],i=1===t.length&&s.err&&s.err instanceof Error?[s.err.message]:Array.prototype.slice.call(t,1));var o=h(r.fields);o.level=e;var a=s?h(s):null;if(a&&(r.serializers&&r._applySerializers(a,n),Object.keys(a).forEach(function(e){o[e]=a[e];})),o.levelName=l[e],o.msg=i.length?p.apply(r,i):"",o.time||(o.time=new Date),r.src&&!o.src)try{throw new Error("call-stack-error")}catch(e){var c=e.stack?m(e.stack,2):"";c||g("src")||d("Unable to determine src line info","src"),o.src=c||"";}return o.v=1,o}var s=null,i=arguments,n=null;if(0===arguments.length)return this._level<=e;this._level>e||(n=t(i),this._emit(n));}}function S(e){var r=e.stack||e.toString();if(e.cause&&"function"==typeof e.cause){var t=e.cause();t&&(r+="\nCaused by: "+S(t));}return r}j.prototype.trace=z(10),j.prototype.debug=z(20),j.prototype.info=z(30),j.prototype.warn=z(40),j.prototype.error=z(50),j.prototype.fatal=z(60);var k={err:function(e){return e&&e.stack?{message:e.message,name:e.name,stack:S(e),code:e.code,signal:e.signal}:e}};function E(){return f(j,[].slice.call(arguments))}var A={levels:{trace:"color: DeepPink",debug:"color: GoldenRod",info:"color: DarkTurquoise",warn:"color: Purple",error:"color: Crimson",fatal:"color: Black"},def:"color: DimGray",msg:"color: SteelBlue",src:"color: DimGray; font-style: italic; font-size: 0.9em"},R=/*#__PURE__*/function(){function e(e){var r=void 0===e?{}:e,t=r.logByLevel,s=r.css,i=void 0===s?A:s;this.logByLevel=void 0!==t&&t,this.css=i;}return e.prototype.write=function(e){var r,t,s=this.css.def,i=this.css.msg,n=this.css.src,o=e.childName?e.name+"/"+e.childName:e.name,a=l[e.level],c=(Array(6-a.length).join(" ")+a).toUpperCase();this.logByLevel?(10===e.level?a="debug":60===e.level&&(a="error"),t="function"==typeof console[a]?console[a]:console.log):t=console.log,r=e.level<20?this.css.levels.trace:e.level<30?this.css.levels.debug:e.level<40?this.css.levels.info:e.level<50?this.css.levels.warn:e.level<60?this.css.levels.error:this.css.levels.fatal;var u=function(e,r){return Array(r+1-(e+"").length).join("0")+e},f=[];f.push("[%s:%s:%s:%s] %c%s%c: %s: %c%s "+(e.src?"%c%s":"")),f.push(u(e.time.getHours(),2)),f.push(u(e.time.getMinutes(),2)),f.push(u(e.time.getSeconds(),2)),f.push(u(e.time.getMilliseconds(),4)),f.push(r),f.push(c),f.push(s),f.push(o),f.push(i),f.push(e.msg),e.src&&(f.push(n),f.push(e.src)),e.obj&&(f.push("\n"),f.push(e.obj)),e.err&&e.err.stack&&(f.push("\n"),f.push(e.err.stack)),t.apply(console,f);},e.getDefaultCss=function(){return A},e}();
 
-var humpsExports = {};
-var humps = {
-  get exports(){ return humpsExports; },
-  set exports(v){ humpsExports = v; },
-};
-
-(function (module) {
-(function(global) {
-
-	  var _processKeys = function(convert, obj, options) {
-	    if(!_isObject(obj) || _isDate(obj) || _isRegExp(obj) || _isBoolean(obj) || _isFunction(obj)) {
-	      return obj;
-	    }
-
-	    var output,
-	        i = 0,
-	        l = 0;
-
-	    if(_isArray(obj)) {
-	      output = [];
-	      for(l=obj.length; i<l; i++) {
-	        output.push(_processKeys(convert, obj[i], options));
-	      }
-	    }
-	    else {
-	      output = {};
-	      for(var key in obj) {
-	        if(Object.prototype.hasOwnProperty.call(obj, key)) {
-	          output[convert(key, options)] = _processKeys(convert, obj[key], options);
-	        }
-	      }
-	    }
-	    return output;
-	  };
-
-	  // String conversion methods
-
-	  var separateWords = function(string, options) {
-	    options = options || {};
-	    var separator = options.separator || '_';
-	    var split = options.split || /(?=[A-Z])/;
-
-	    return string.split(split).join(separator);
-	  };
-
-	  var camelize = function(string) {
-	    if (_isNumerical(string)) {
-	      return string;
-	    }
-	    string = string.replace(/[\-_\s]+(.)?/g, function(match, chr) {
-	      return chr ? chr.toUpperCase() : '';
-	    });
-	    // Ensure 1st char is always lowercase
-	    return string.substr(0, 1).toLowerCase() + string.substr(1);
-	  };
-
-	  var pascalize = function(string) {
-	    var camelized = camelize(string);
-	    // Ensure 1st char is always uppercase
-	    return camelized.substr(0, 1).toUpperCase() + camelized.substr(1);
-	  };
-
-	  var decamelize = function(string, options) {
-	    return separateWords(string, options).toLowerCase();
-	  };
-
-	  // Utilities
-	  // Taken from Underscore.js
-
-	  var toString = Object.prototype.toString;
-
-	  var _isFunction = function(obj) {
-	    return typeof(obj) === 'function';
-	  };
-	  var _isObject = function(obj) {
-	    return obj === Object(obj);
-	  };
-	  var _isArray = function(obj) {
-	    return toString.call(obj) == '[object Array]';
-	  };
-	  var _isDate = function(obj) {
-	    return toString.call(obj) == '[object Date]';
-	  };
-	  var _isRegExp = function(obj) {
-	    return toString.call(obj) == '[object RegExp]';
-	  };
-	  var _isBoolean = function(obj) {
-	    return toString.call(obj) == '[object Boolean]';
-	  };
-
-	  // Performant way to determine if obj coerces to a number
-	  var _isNumerical = function(obj) {
-	    obj = obj - 0;
-	    return obj === obj;
-	  };
-
-	  // Sets up function which handles processing keys
-	  // allowing the convert function to be modified by a callback
-	  var _processor = function(convert, options) {
-	    var callback = options && 'process' in options ? options.process : options;
-
-	    if(typeof(callback) !== 'function') {
-	      return convert;
-	    }
-
-	    return function(string, options) {
-	      return callback(string, convert, options);
-	    }
-	  };
-
-	  var humps = {
-	    camelize: camelize,
-	    decamelize: decamelize,
-	    pascalize: pascalize,
-	    depascalize: decamelize,
-	    camelizeKeys: function(object, options) {
-	      return _processKeys(_processor(camelize, options), object);
-	    },
-	    decamelizeKeys: function(object, options) {
-	      return _processKeys(_processor(decamelize, options), object, options);
-	    },
-	    pascalizeKeys: function(object, options) {
-	      return _processKeys(_processor(pascalize, options), object);
-	    },
-	    depascalizeKeys: function () {
-	      return this.decamelizeKeys.apply(this, arguments);
-	    }
-	  };
-
-	  if (module.exports) {
-	    module.exports = humps;
-	  } else {
-	    global.humps = humps;
-	  }
-
-	})(commonjsGlobal);
-} (humps));
-
 class InvalidTokenError extends Error {
 }
 InvalidTokenError.prototype.name = "InvalidTokenError";
@@ -3536,7 +3429,7 @@ var __spreadValues$3 = (a, b) => {
     }
   return a;
 };
-var __async$3 = (__this, __arguments, generator) => {
+var __async$4 = (__this, __arguments, generator) => {
   return new Promise((resolve, reject) => {
     var fulfilled = (value) => {
       try {
@@ -3575,7 +3468,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$3(this, null, function* () {
+    this.create = (createFundingSource) => __async$4(this, null, function* () {
       const endUserIpAddress = yield getEndUserIpAddress();
       if (!endUserIpAddress) {
         return Promise.reject([new CodedError("Unable to get IP address")]);
@@ -3589,7 +3482,7 @@ class FundingSourcesAPI {
      * user to update the billing address or payment information associated with the
      * funding source.
      */
-    this.update = (billingInfo, creditCardInfo, fundingSourceId) => __async$3(this, null, function* () {
+    this.update = (billingInfo, creditCardInfo, fundingSourceId) => __async$4(this, null, function* () {
       const endUserIpAddress = yield getEndUserIpAddress();
       if (!endUserIpAddress) {
         return Promise.reject([new CodedError("Unable to get IP address")]);
@@ -3607,7 +3500,7 @@ class FundingSourcesAPI {
      * The `registerCarrier` method registers a carrier account and associates
      * it with a given funding source.
      */
-    this.registerCarrier = (carrier) => __async$3(this, null, function* () {
+    this.registerCarrier = (carrier) => __async$4(this, null, function* () {
       const endUserIpAddress = yield getEndUserIpAddress();
       if (!endUserIpAddress) {
         return Promise.reject([new CodedError("Unable to get IP address")]);
@@ -3619,7 +3512,7 @@ class FundingSourcesAPI {
     /**
      * The `addFunds` method allows you to add funds to a funding source.
      */
-    this.addFunds = (amount, fundingSourceId) => __async$3(this, null, function* () {
+    this.addFunds = (amount, fundingSourceId) => __async$4(this, null, function* () {
       return yield this.client.put(
         `/v1/funding_sources/${fundingSourceId}/add_funds`,
         amount
@@ -3629,7 +3522,7 @@ class FundingSourcesAPI {
      * The `metadata` method returns seller-specific requirements for creating funding sources
      * and attaching carriers
      */
-    this.metadata = () => __async$3(this, null, function* () {
+    this.metadata = () => __async$4(this, null, function* () {
       return yield this.client.get("/v1/funding_sources/metadata");
     });
     /**
@@ -3681,6 +3574,55 @@ class InsuranceAPI {
   }
 }
 
+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 InvoiceAddressAPI {
+  constructor(client) {
+    this.client = client;
+    /**
+     * The `get` method retrieves the invoice address for a given user.
+     */
+    this.get = () => {
+      return this.client.get("/v1/invoice_address");
+    };
+    /**
+     * The `create` method creates a new invoice address for a given user.
+     */
+    this.create = (invoiceAddress) => __async$3(this, null, function* () {
+      return yield this.client.post("/v1/invoice_address", {
+        invoiceAddress
+      });
+    });
+    /**
+     * The `update` method updates a invoice address for a given user.
+     */
+    this.update = (invoiceAddress) => __async$3(this, null, function* () {
+      return yield this.client.put("/v1/invoice_address", {
+        invoiceAddress
+      });
+    });
+    this.client = client;
+  }
+}
+
 class LabelsAPI {
   constructor(client) {
     this.client = client;
@@ -3893,10 +3835,14 @@ class SalesOrderShipmentsAPI {
     /**
      * The `list` method retrieves a list of sales order shipments for a given user.
      */
-    this.list = (body = {}, params) => {
-      return this.client.post("/v-beta/shipments/list", body, {
-        params
-      });
+    this.list = (body) => {
+      return this.client.post("/v-beta/shipments/list", body);
+    };
+    /**
+     * The `listShipmentsByExternalOrderId` method retrieves a list of shipments associated to a sales order that matches `externalOrderId`
+     */
+    this.listShipmentsByExternalOrderId = (externalOrderId) => {
+      return this.client.get(`/v-beta/shipments/external_order_id/${externalOrderId}`);
     };
     /**
      * The `get` method retrieves a specific sales order shipment by `shipmentId`.
@@ -3938,6 +3884,13 @@ class SalesOrdersAPI {
     this.get = (salesOrderId) => {
       return this.client.get(`/v-beta/sales_orders/${salesOrderId}`);
     };
+    /**
+     * The `getByExternalId` method retrieves a specific sales order by its `externalOrderId`.
+     * @param externalOrderId Id that matches that of the desired sales order.
+     */
+    this.getByExternalId = (externalOrderId) => {
+      return this.client.get(`/v-beta/sales_orders/external_order_id/${externalOrderId}`);
+    };
     /**
      * The `notifyShipped` method notifies order source that the order has been
      * shipped. Typically, the order source will then notify the user based on
@@ -21607,11 +21560,11 @@ class ShipEngineAPI {
       headers: __spreadProps(__spreadValues({}, headers), {
         "Content-Type": "application/json"
       }),
-      paramsSerializer: (params) => lib.stringify(humpsExports.decamelizeKeys(params), { arrayFormat: "brackets" }),
+      paramsSerializer: (params) => lib.stringify(decamelizeKeys(params), { arrayFormat: "brackets" }),
       transformRequest: [
         (data) => {
           if (data && !(data instanceof FormData))
-            return humpsExports.decamelizeKeys(data);
+            return decamelizeKeys(data);
           else
             return data;
         },
@@ -21631,7 +21584,7 @@ class ShipEngineAPI {
         },
         (data) => {
           if (data && !(data instanceof Blob))
-            return humpsExports.camelizeKeys(data);
+            return camelizeKeys(data);
           else
             return data;
         }
@@ -21804,6 +21757,15 @@ class ShipEngineAPI {
   get insurance() {
     return new InsuranceAPI(this.client);
   }
+  /**
+   * The `invoiceAddress` method provides access to the Invoice Address endpoints
+   * in ShipEngine API.
+   *
+   * @see {@link InvoiceAddress | The Invoice Address API module}
+   */
+  get invoiceAddress() {
+    return new InvoiceAddressAPI(this.client);
+  }
   /**
    * The `labels` method provides access to the Label endpoints in ShipEngine API.
    * e.g. Create Label, Get Label, Void Label, etc.
@@ -21919,4 +21881,4 @@ class ShipEngineAPI {
   }
 }
 
-export { AccountSettingsAPI, AddressesAPI, CarriersAPI, CodedError, ConfirmationType, ConnectionsAPI, CreditCardVendor, Currency, CustomPackagesAPI, CustomsContentsType, CustomsNonDeliveryType, FundingSourcesAPI, InsuranceAPI, InsuranceProviderType, LabelsAPI, MetadataCapability, MetadataRequirement, MetadataSatisfyingFormTypes, MovementIndicator, OrderSourcesAPI, RateCardStatus, RateCardsAPI, RatesAPI, types as SE, SalesOrderShipmentsAPI, SalesOrdersAPI, SellersAPI, ServicePointsAPI, ShipEngineAPI, ShipmentsAPI, ShippingRulesAPI, ThemesAPI, WarehousesAPI, WebhooksAPI, getEndUserIpAddress, isCodedError, isCodedErrors, isDataCodedErrors, isInvalidTokenError, parseError };
+export { AccountSettingsAPI, AddressesAPI, CarriersAPI, CodedError, ConfirmationType, ConnectionsAPI, CreditCardVendor, Currency, CustomPackagesAPI, CustomsContentsType, CustomsNonDeliveryType, FundingSourcesAPI, InsuranceAPI, InsuranceProviderType, InvoiceAddressAPI, LabelsAPI, MetadataCapability, MetadataRequirement, MetadataSatisfyingFormTypes, MovementIndicator, OrderSourcesAPI, RateCardStatus, RateCardsAPI, RatesAPI, types as SE, SalesOrderShipmentsAPI, SalesOrdersAPI, SellersAPI, ServicePointsAPI, ShipEngineAPI, ShipmentsAPI, ShippingRulesAPI, ThemesAPI, WarehousesAPI, WebhooksAPI, camelizeKeys, decamelizeKeys, getEndUserIpAddress, isCodedError, isCodedErrors, isDataCodedErrors, isInvalidTokenError, parseError };

package/invoice-address/api.d.ts

@@ -0,0 +1,28 @@
+import { AxiosInstance } from "axios";
+import { InvoiceAddress } from "./types";
+/**
+ * @internal
+ * # Invoice Address API module - /v1/invoice_address
+ */
+export declare class InvoiceAddressAPI {
+    private client;
+    constructor(client: AxiosInstance);
+    /**
+     * The `get` method retrieves the invoice address for a given user.
+     */
+    get: () => Promise<import("axios").AxiosResponse<{
+        invoiceAddress: InvoiceAddress;
+    }, any>>;
+    /**
+     * The `create` method creates a new invoice address for a given user.
+     */
+    create: (invoiceAddress: InvoiceAddress) => Promise<import("axios").AxiosResponse<{
+        invoiceAddress: InvoiceAddress;
+    }, any>>;
+    /**
+     * The `update` method updates a invoice address for a given user.
+     */
+    update: (invoiceAddress: InvoiceAddress) => Promise<import("axios").AxiosResponse<{
+        invoiceAddress: InvoiceAddress;
+    }, any>>;
+}

package/invoice-address/index.d.ts

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

package/invoice-address/types.d.ts

@@ -0,0 +1,13 @@
+/** @internal */
+export interface InvoiceAddress {
+    addressLine1: string;
+    addressLine2?: string;
+    cityLocality: string;
+    company?: string;
+    countryCode: string;
+    email: string;
+    fullName: string;
+    phone: string;
+    postalCode: string;
+    stateProvince: string;
+}

package/package.json

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

package/sales-order-shipments/api.d.ts

@@ -60,15 +60,19 @@ export type ListSalesOrderShipmentsParams = {
  * # Sales Order Shipments - List Sales Order Shipments Body
  */
 export type ListSalesOrderShipmentBody = {
+    /**
+     * `externalOrderIds` is an array of non-unique external ids that match to a sales order
+     */
+    externalOrderIds?: string[];
     /**
      * `salesOrderIds` is an array of sales order IDs to be used when listing sales
      * orders.
      */
     salesOrderIds?: string[];
     /**
-     * `shipments` is an array of shipments associated with the sales orders.
+     * `shipmentIds` is an array of shipments associated with the sales orders.
      */
-    shipments?: SalesOrderShipment[];
+    shipmentIds?: string[];
 };
 /**
  * # Sales Order Shipments - List Sales Order Shipments Result
@@ -88,7 +92,11 @@ export declare class SalesOrderShipmentsAPI {
     /**
      * The `list` method retrieves a list of sales order shipments for a given user.
      */
-    list: (body?: ListSalesOrderShipmentBody | undefined, params?: ListSalesOrderShipmentsParams) => Promise<import("axios").AxiosResponse<ListSalesOrderShipmentsResult, any>>;
+    list: (body: ListSalesOrderShipmentBody) => Promise<import("axios").AxiosResponse<ListSalesOrderShipmentsResult, any>>;
+    /**
+     * The `listShipmentsByExternalOrderId` method retrieves a list of shipments associated to a sales order that matches `externalOrderId`
+     */
+    listShipmentsByExternalOrderId: (externalOrderId: string) => Promise<import("axios").AxiosResponse<ListSalesOrderShipmentsResult, any>>;
     /**
      * The `get` method retrieves a specific sales order shipment by `shipmentId`.
      */

package/sales-orders/api.d.ts

@@ -31,6 +31,11 @@ export declare class SalesOrdersAPI {
      * The `get` method retrieves a specific sales order by `salesOrderId`.
      */
     get: (salesOrderId: string) => Promise<import("axios").AxiosResponse<SalesOrder, any>>;
+    /**
+     * The `getByExternalId` method retrieves a specific sales order by its `externalOrderId`.
+     * @param externalOrderId Id that matches that of the desired sales order.
+     */
+    getByExternalId: (externalOrderId: string) => Promise<import("axios").AxiosResponse<SalesOrder, any>>;
     /**
      * The `notifyShipped` method notifies order source that the order has been
      * shipped. Typically, the order source will then notify the user based on

package/shipments/types.d.ts

@@ -1,4 +1,4 @@
-import { Address, AddressValidation } from "../addresses";
+import { Address, AddressValidation, ShippingAddress, ShippingAddressTo } from "../addresses";
 import { CarrierPackage } from "../carriers";
 import { CodedError } from "../errors";
 import { OrderSourceCode } from "../order-sources";
@@ -203,36 +203,47 @@ export interface Shipment {
         useUpsGroundFreightPricing?: boolean;
         windsorFrameworkDetails?: WindsorFrameworkDetails;
     };
+    amountPaid: Money;
+    assignedUser?: string | null;
     carrierId: string;
-    comparisonRateType?: string;
+    comparisonRateType?: string | null;
     confirmation: ConfirmationType;
     createdAt: string;
     customs?: Customs;
-    externalOrderId?: string;
-    externalShipmentId?: string;
+    externalOrderId?: string | null;
+    externalShipmentId?: string | null;
+    holdUntilDate?: string | null;
     insuranceProvider: InsuranceProviderType;
+    isGift?: boolean;
     isReturn?: boolean;
     items: ShipmentItem[];
     modifiedAt: string;
+    notesForGift?: string | null;
+    notesFromBuyer?: string | null;
     orderSourceCode: OrderSourceCode | null;
     originType?: OriginTypes;
     packages: ShipmentPackage[];
-    returnTo: Address | null;
+    requestedShipmentService?: string | null;
+    retailRate?: number | null;
+    returnTo: ShippingAddress | null;
     serviceCode: string | null;
+    shipByDate?: string | null;
     shipDate?: string;
-    shipFrom: Address | null;
+    shipFrom: ShippingAddress;
     shipmentId: string;
     shipmentNumber?: string;
     shipmentStatus: ShipmentStatus;
-    shippingRuleId?: string;
-    shipTo: Address;
+    shippingPaid: Money;
+    shippingRuleId?: string | null;
+    shipTo: ShippingAddressTo;
     tags: {
         name: string;
     }[];
     taxIdentifiers?: TaxIdentifier[];
+    taxPaid: Money;
     totalWeight: WeightWithUnit;
     validateAddress?: AddressValidationOptions;
-    warehouseId?: string;
+    warehouseId?: string | null;
 }
 export type ShipmentRateResponse = {
     createdAt: string;

package/types.d.ts

@@ -9,6 +9,7 @@ export * from "./dimensions/types";
 export * from "./errors/types";
 export * from "./funding-sources/types";
 export * from "./insurance/types";
+export * from "./invoice-address/types";
 export * from "./labels/types";
 export * from "./order-sources/types";
 export * from "./payments/types";

package/utilities/casing.d.ts

@@ -0,0 +1,2 @@
+export declare const camelizeKeys: (obj: any) => any;
+export declare const decamelizeKeys: (obj: any, separator?: string) => any;

package/utilities/index.d.ts

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