@shipengine/js-api 2.6.0 → 3.0.0

package/account-settings/types.d.ts

@@ -1,11 +1,17 @@
 import { DimensionUnit } from "../dimensions";
 import { LabelLayout } from "../labels";
 import { PageableResult } from "../resources";
+import { TaxableIdentifierType } from "../shipments";
 import { WeightUnit } from "../weight";
+export type AccountSettingsTaxIdentifier = {
+    identifierType: TaxableIdentifierType;
+    issuingAuthority: string;
+    value: string;
+};
 export interface ShipEngineAccountSettings {
     defaultLabelLayout: LabelLayout;
     dimensionsUnit: DimensionUnit;
-    taxIdentifier?: string;
+    taxIdentifiers?: AccountSettingsTaxIdentifier[];
     weightUnit: WeightUnit;
 }
 export type AccountImage = {

package/funding-sources/types.d.ts

@@ -124,6 +124,13 @@ export type MetadataCarrierProfile = {
     requiredTerms: MetadataRequiredTerm[];
 };
 export type TransactionCategory = "adjustment" | "credit" | "debit" | "funds_added" | "insurance" | "label" | "refund" | "service_charge" | "unknown";
+export type FundingSourceTransactionInvoice = {
+    invoiceDownload: {
+        pdf: string;
+    };
+    invoiceId: string;
+    reference: string;
+};
 export type FundingSourceTransaction = {
     description?: string | null;
     endingBalance: {
@@ -132,6 +139,7 @@ export type FundingSourceTransaction = {
     };
     fundingSourceId: string;
     fundingSourceTransactionId: string;
+    invoice: FundingSourceTransactionInvoice | null;
     labelIds: string[];
     relatedFundingSourceTransactionIds: string[];
     shipmentIds: string[];

package/index.js

@@ -10,17 +10,17 @@ var AccountBillingPlanChangeType = /* @__PURE__ */ ((AccountBillingPlanChangeTyp
   return AccountBillingPlanChangeType2;
 })(AccountBillingPlanChangeType || {});
 
-var __getOwnPropSymbols$6 = Object.getOwnPropertySymbols;
-var __hasOwnProp$6 = Object.prototype.hasOwnProperty;
-var __propIsEnum$6 = Object.prototype.propertyIsEnumerable;
-var __objRest$2 = (source, exclude) => {
+var __getOwnPropSymbols$7 = Object.getOwnPropertySymbols;
+var __hasOwnProp$7 = Object.prototype.hasOwnProperty;
+var __propIsEnum$7 = Object.prototype.propertyIsEnumerable;
+var __objRest$3 = (source, exclude) => {
   var target = {};
   for (var prop in source)
-    if (__hasOwnProp$6.call(source, prop) && exclude.indexOf(prop) < 0)
+    if (__hasOwnProp$7.call(source, prop) && exclude.indexOf(prop) < 0)
       target[prop] = source[prop];
-  if (source != null && __getOwnPropSymbols$6)
-    for (var prop of __getOwnPropSymbols$6(source)) {
-      if (exclude.indexOf(prop) < 0 && __propIsEnum$6.call(source, prop))
+  if (source != null && __getOwnPropSymbols$7)
+    for (var prop of __getOwnPropSymbols$7(source)) {
+      if (exclude.indexOf(prop) < 0 && __propIsEnum$7.call(source, prop))
         target[prop] = source[prop];
     }
   return target;
@@ -34,7 +34,7 @@ class CodedError {
     this.message = message;
   }
   static fromObject(_a) {
-    var _b = _a, { message } = _b, options = __objRest$2(_b, ["message"]);
+    var _b = _a, { message } = _b, options = __objRest$3(_b, ["message"]);
     return new CodedError(message, options);
   }
 }
@@ -153,17 +153,17 @@ const types = /*#__PURE__*/Object.freeze(/*#__PURE__*/Object.defineProperty({
   RateCardStatus
 }, Symbol.toStringTag, { value: 'Module' }));
 
-var __getOwnPropSymbols$5 = Object.getOwnPropertySymbols;
-var __hasOwnProp$5 = Object.prototype.hasOwnProperty;
-var __propIsEnum$5 = Object.prototype.propertyIsEnumerable;
-var __objRest$1 = (source, exclude) => {
+var __getOwnPropSymbols$6 = Object.getOwnPropertySymbols;
+var __hasOwnProp$6 = Object.prototype.hasOwnProperty;
+var __propIsEnum$6 = Object.prototype.propertyIsEnumerable;
+var __objRest$2 = (source, exclude) => {
   var target = {};
   for (var prop in source)
-    if (__hasOwnProp$5.call(source, prop) && exclude.indexOf(prop) < 0)
+    if (__hasOwnProp$6.call(source, prop) && exclude.indexOf(prop) < 0)
       target[prop] = source[prop];
-  if (source != null && __getOwnPropSymbols$5)
-    for (var prop of __getOwnPropSymbols$5(source)) {
-      if (exclude.indexOf(prop) < 0 && __propIsEnum$5.call(source, prop))
+  if (source != null && __getOwnPropSymbols$6)
+    for (var prop of __getOwnPropSymbols$6(source)) {
+      if (exclude.indexOf(prop) < 0 && __propIsEnum$6.call(source, prop))
         target[prop] = source[prop];
     }
   return target;
@@ -195,7 +195,7 @@ class AccountSettingsAPI {
      * The `updateImage` method updates specific image data for a given image id.
      */
     this.updateImage = (_a) => {
-      var _b = _a, { labelImageId } = _b, data = __objRest$1(_b, ["labelImageId"]);
+      var _b = _a, { labelImageId } = _b, data = __objRest$2(_b, ["labelImageId"]);
       return this.client.put(`/v1/account/settings/images/${labelImageId}`, data);
     };
     /**
@@ -1010,30 +1010,30 @@ const getEndUserIpAddress = () => __async$6(void 0, null, function* () {
 var __defProp$4 = Object.defineProperty;
 var __defProps$1 = Object.defineProperties;
 var __getOwnPropDescs$1 = Object.getOwnPropertyDescriptors;
-var __getOwnPropSymbols$4 = Object.getOwnPropertySymbols;
-var __hasOwnProp$4 = Object.prototype.hasOwnProperty;
-var __propIsEnum$4 = Object.prototype.propertyIsEnumerable;
+var __getOwnPropSymbols$5 = Object.getOwnPropertySymbols;
+var __hasOwnProp$5 = Object.prototype.hasOwnProperty;
+var __propIsEnum$5 = Object.prototype.propertyIsEnumerable;
 var __defNormalProp$4 = (obj, key, value) => key in obj ? __defProp$4(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
 var __spreadValues$4 = (a, b) => {
   for (var prop in b || (b = {}))
-    if (__hasOwnProp$4.call(b, prop))
+    if (__hasOwnProp$5.call(b, prop))
       __defNormalProp$4(a, prop, b[prop]);
-  if (__getOwnPropSymbols$4)
-    for (var prop of __getOwnPropSymbols$4(b)) {
-      if (__propIsEnum$4.call(b, prop))
+  if (__getOwnPropSymbols$5)
+    for (var prop of __getOwnPropSymbols$5(b)) {
+      if (__propIsEnum$5.call(b, prop))
         __defNormalProp$4(a, prop, b[prop]);
     }
   return a;
 };
 var __spreadProps$1 = (a, b) => __defProps$1(a, __getOwnPropDescs$1(b));
-var __objRest = (source, exclude) => {
+var __objRest$1 = (source, exclude) => {
   var target = {};
   for (var prop in source)
-    if (__hasOwnProp$4.call(source, prop) && exclude.indexOf(prop) < 0)
+    if (__hasOwnProp$5.call(source, prop) && exclude.indexOf(prop) < 0)
       target[prop] = source[prop];
-  if (source != null && __getOwnPropSymbols$4)
-    for (var prop of __getOwnPropSymbols$4(source)) {
-      if (exclude.indexOf(prop) < 0 && __propIsEnum$4.call(source, prop))
+  if (source != null && __getOwnPropSymbols$5)
+    for (var prop of __getOwnPropSymbols$5(source)) {
+      if (exclude.indexOf(prop) < 0 && __propIsEnum$5.call(source, prop))
         target[prop] = source[prop];
     }
   return target;
@@ -1079,7 +1079,7 @@ class CarriersAPI {
      * The `connect` method connects a carrier account to a user's ShipEngine account.
      */
     this.connect = (_a) => __async$5(this, null, function* () {
-      var _b = _a, { carrierCode } = _b, connection = __objRest(_b, ["carrierCode"]);
+      var _b = _a, { carrierCode } = _b, connection = __objRest$1(_b, ["carrierCode"]);
       const endUserIpAddress = yield getEndUserIpAddress();
       if (!endUserIpAddress)
         return Promise.reject([new CodedError("Unable to get IP address")]);
@@ -3525,17 +3525,17 @@ class CustomPackagesAPI {
 }
 
 var __defProp$3 = Object.defineProperty;
-var __getOwnPropSymbols$3 = Object.getOwnPropertySymbols;
-var __hasOwnProp$3 = Object.prototype.hasOwnProperty;
-var __propIsEnum$3 = Object.prototype.propertyIsEnumerable;
+var __getOwnPropSymbols$4 = Object.getOwnPropertySymbols;
+var __hasOwnProp$4 = Object.prototype.hasOwnProperty;
+var __propIsEnum$4 = Object.prototype.propertyIsEnumerable;
 var __defNormalProp$3 = (obj, key, value) => key in obj ? __defProp$3(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
 var __spreadValues$3 = (a, b) => {
   for (var prop in b || (b = {}))
-    if (__hasOwnProp$3.call(b, prop))
+    if (__hasOwnProp$4.call(b, prop))
       __defNormalProp$3(a, prop, b[prop]);
-  if (__getOwnPropSymbols$3)
-    for (var prop of __getOwnPropSymbols$3(b)) {
-      if (__propIsEnum$3.call(b, prop))
+  if (__getOwnPropSymbols$4)
+    for (var prop of __getOwnPropSymbols$4(b)) {
+      if (__propIsEnum$4.call(b, prop))
         __defNormalProp$3(a, prop, b[prop]);
     }
   return a;
@@ -3720,6 +3720,21 @@ class LabelsAPI {
   }
 }
 
+var __getOwnPropSymbols$3 = Object.getOwnPropertySymbols;
+var __hasOwnProp$3 = Object.prototype.hasOwnProperty;
+var __propIsEnum$3 = Object.prototype.propertyIsEnumerable;
+var __objRest = (source, exclude) => {
+  var target = {};
+  for (var prop in source)
+    if (__hasOwnProp$3.call(source, prop) && exclude.indexOf(prop) < 0)
+      target[prop] = source[prop];
+  if (source != null && __getOwnPropSymbols$3)
+    for (var prop of __getOwnPropSymbols$3(source)) {
+      if (exclude.indexOf(prop) < 0 && __propIsEnum$3.call(source, prop))
+        target[prop] = source[prop];
+    }
+  return target;
+};
 class OrderSourcesAPI {
   constructor(client) {
     this.client = client;
@@ -3743,6 +3758,13 @@ class OrderSourcesAPI {
     this.get = (orderSourceId) => {
       return this.client.get(`/v-beta/order_sources/${orderSourceId}`);
     };
+    /**
+     * The `update` method will allow the user to update a connected Order Source
+     */
+    this.update = (_a) => {
+      var _b = _a, { orderSourceId } = _b, rest = __objRest(_b, ["orderSourceId"]);
+      return this.client.put(`/v-beta/order_sources/${orderSourceId}`, rest);
+    };
     /**
      * The `refresh` method refreshes a specific order source by `orderSourceId`.
      * This will pull in any `new orders` since the last order import.

package/index.mjs

@@ -6,17 +6,17 @@ var AccountBillingPlanChangeType = /* @__PURE__ */ ((AccountBillingPlanChangeTyp
   return AccountBillingPlanChangeType2;
 })(AccountBillingPlanChangeType || {});
 
-var __getOwnPropSymbols$6 = Object.getOwnPropertySymbols;
-var __hasOwnProp$6 = Object.prototype.hasOwnProperty;
-var __propIsEnum$6 = Object.prototype.propertyIsEnumerable;
-var __objRest$2 = (source, exclude) => {
+var __getOwnPropSymbols$7 = Object.getOwnPropertySymbols;
+var __hasOwnProp$7 = Object.prototype.hasOwnProperty;
+var __propIsEnum$7 = Object.prototype.propertyIsEnumerable;
+var __objRest$3 = (source, exclude) => {
   var target = {};
   for (var prop in source)
-    if (__hasOwnProp$6.call(source, prop) && exclude.indexOf(prop) < 0)
+    if (__hasOwnProp$7.call(source, prop) && exclude.indexOf(prop) < 0)
       target[prop] = source[prop];
-  if (source != null && __getOwnPropSymbols$6)
-    for (var prop of __getOwnPropSymbols$6(source)) {
-      if (exclude.indexOf(prop) < 0 && __propIsEnum$6.call(source, prop))
+  if (source != null && __getOwnPropSymbols$7)
+    for (var prop of __getOwnPropSymbols$7(source)) {
+      if (exclude.indexOf(prop) < 0 && __propIsEnum$7.call(source, prop))
         target[prop] = source[prop];
     }
   return target;
@@ -30,7 +30,7 @@ class CodedError {
     this.message = message;
   }
   static fromObject(_a) {
-    var _b = _a, { message } = _b, options = __objRest$2(_b, ["message"]);
+    var _b = _a, { message } = _b, options = __objRest$3(_b, ["message"]);
     return new CodedError(message, options);
   }
 }
@@ -149,17 +149,17 @@ const types = /*#__PURE__*/Object.freeze(/*#__PURE__*/Object.defineProperty({
   RateCardStatus
 }, Symbol.toStringTag, { value: 'Module' }));
 
-var __getOwnPropSymbols$5 = Object.getOwnPropertySymbols;
-var __hasOwnProp$5 = Object.prototype.hasOwnProperty;
-var __propIsEnum$5 = Object.prototype.propertyIsEnumerable;
-var __objRest$1 = (source, exclude) => {
+var __getOwnPropSymbols$6 = Object.getOwnPropertySymbols;
+var __hasOwnProp$6 = Object.prototype.hasOwnProperty;
+var __propIsEnum$6 = Object.prototype.propertyIsEnumerable;
+var __objRest$2 = (source, exclude) => {
   var target = {};
   for (var prop in source)
-    if (__hasOwnProp$5.call(source, prop) && exclude.indexOf(prop) < 0)
+    if (__hasOwnProp$6.call(source, prop) && exclude.indexOf(prop) < 0)
       target[prop] = source[prop];
-  if (source != null && __getOwnPropSymbols$5)
-    for (var prop of __getOwnPropSymbols$5(source)) {
-      if (exclude.indexOf(prop) < 0 && __propIsEnum$5.call(source, prop))
+  if (source != null && __getOwnPropSymbols$6)
+    for (var prop of __getOwnPropSymbols$6(source)) {
+      if (exclude.indexOf(prop) < 0 && __propIsEnum$6.call(source, prop))
         target[prop] = source[prop];
     }
   return target;
@@ -191,7 +191,7 @@ class AccountSettingsAPI {
      * The `updateImage` method updates specific image data for a given image id.
      */
     this.updateImage = (_a) => {
-      var _b = _a, { labelImageId } = _b, data = __objRest$1(_b, ["labelImageId"]);
+      var _b = _a, { labelImageId } = _b, data = __objRest$2(_b, ["labelImageId"]);
       return this.client.put(`/v1/account/settings/images/${labelImageId}`, data);
     };
     /**
@@ -1006,30 +1006,30 @@ const getEndUserIpAddress = () => __async$6(void 0, null, function* () {
 var __defProp$4 = Object.defineProperty;
 var __defProps$1 = Object.defineProperties;
 var __getOwnPropDescs$1 = Object.getOwnPropertyDescriptors;
-var __getOwnPropSymbols$4 = Object.getOwnPropertySymbols;
-var __hasOwnProp$4 = Object.prototype.hasOwnProperty;
-var __propIsEnum$4 = Object.prototype.propertyIsEnumerable;
+var __getOwnPropSymbols$5 = Object.getOwnPropertySymbols;
+var __hasOwnProp$5 = Object.prototype.hasOwnProperty;
+var __propIsEnum$5 = Object.prototype.propertyIsEnumerable;
 var __defNormalProp$4 = (obj, key, value) => key in obj ? __defProp$4(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
 var __spreadValues$4 = (a, b) => {
   for (var prop in b || (b = {}))
-    if (__hasOwnProp$4.call(b, prop))
+    if (__hasOwnProp$5.call(b, prop))
       __defNormalProp$4(a, prop, b[prop]);
-  if (__getOwnPropSymbols$4)
-    for (var prop of __getOwnPropSymbols$4(b)) {
-      if (__propIsEnum$4.call(b, prop))
+  if (__getOwnPropSymbols$5)
+    for (var prop of __getOwnPropSymbols$5(b)) {
+      if (__propIsEnum$5.call(b, prop))
         __defNormalProp$4(a, prop, b[prop]);
     }
   return a;
 };
 var __spreadProps$1 = (a, b) => __defProps$1(a, __getOwnPropDescs$1(b));
-var __objRest = (source, exclude) => {
+var __objRest$1 = (source, exclude) => {
   var target = {};
   for (var prop in source)
-    if (__hasOwnProp$4.call(source, prop) && exclude.indexOf(prop) < 0)
+    if (__hasOwnProp$5.call(source, prop) && exclude.indexOf(prop) < 0)
       target[prop] = source[prop];
-  if (source != null && __getOwnPropSymbols$4)
-    for (var prop of __getOwnPropSymbols$4(source)) {
-      if (exclude.indexOf(prop) < 0 && __propIsEnum$4.call(source, prop))
+  if (source != null && __getOwnPropSymbols$5)
+    for (var prop of __getOwnPropSymbols$5(source)) {
+      if (exclude.indexOf(prop) < 0 && __propIsEnum$5.call(source, prop))
         target[prop] = source[prop];
     }
   return target;
@@ -1075,7 +1075,7 @@ class CarriersAPI {
      * The `connect` method connects a carrier account to a user's ShipEngine account.
      */
     this.connect = (_a) => __async$5(this, null, function* () {
-      var _b = _a, { carrierCode } = _b, connection = __objRest(_b, ["carrierCode"]);
+      var _b = _a, { carrierCode } = _b, connection = __objRest$1(_b, ["carrierCode"]);
       const endUserIpAddress = yield getEndUserIpAddress();
       if (!endUserIpAddress)
         return Promise.reject([new CodedError("Unable to get IP address")]);
@@ -3521,17 +3521,17 @@ class CustomPackagesAPI {
 }
 
 var __defProp$3 = Object.defineProperty;
-var __getOwnPropSymbols$3 = Object.getOwnPropertySymbols;
-var __hasOwnProp$3 = Object.prototype.hasOwnProperty;
-var __propIsEnum$3 = Object.prototype.propertyIsEnumerable;
+var __getOwnPropSymbols$4 = Object.getOwnPropertySymbols;
+var __hasOwnProp$4 = Object.prototype.hasOwnProperty;
+var __propIsEnum$4 = Object.prototype.propertyIsEnumerable;
 var __defNormalProp$3 = (obj, key, value) => key in obj ? __defProp$3(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
 var __spreadValues$3 = (a, b) => {
   for (var prop in b || (b = {}))
-    if (__hasOwnProp$3.call(b, prop))
+    if (__hasOwnProp$4.call(b, prop))
       __defNormalProp$3(a, prop, b[prop]);
-  if (__getOwnPropSymbols$3)
-    for (var prop of __getOwnPropSymbols$3(b)) {
-      if (__propIsEnum$3.call(b, prop))
+  if (__getOwnPropSymbols$4)
+    for (var prop of __getOwnPropSymbols$4(b)) {
+      if (__propIsEnum$4.call(b, prop))
         __defNormalProp$3(a, prop, b[prop]);
     }
   return a;
@@ -3716,6 +3716,21 @@ class LabelsAPI {
   }
 }
 
+var __getOwnPropSymbols$3 = Object.getOwnPropertySymbols;
+var __hasOwnProp$3 = Object.prototype.hasOwnProperty;
+var __propIsEnum$3 = Object.prototype.propertyIsEnumerable;
+var __objRest = (source, exclude) => {
+  var target = {};
+  for (var prop in source)
+    if (__hasOwnProp$3.call(source, prop) && exclude.indexOf(prop) < 0)
+      target[prop] = source[prop];
+  if (source != null && __getOwnPropSymbols$3)
+    for (var prop of __getOwnPropSymbols$3(source)) {
+      if (exclude.indexOf(prop) < 0 && __propIsEnum$3.call(source, prop))
+        target[prop] = source[prop];
+    }
+  return target;
+};
 class OrderSourcesAPI {
   constructor(client) {
     this.client = client;
@@ -3739,6 +3754,13 @@ class OrderSourcesAPI {
     this.get = (orderSourceId) => {
       return this.client.get(`/v-beta/order_sources/${orderSourceId}`);
     };
+    /**
+     * The `update` method will allow the user to update a connected Order Source
+     */
+    this.update = (_a) => {
+      var _b = _a, { orderSourceId } = _b, rest = __objRest(_b, ["orderSourceId"]);
+      return this.client.put(`/v-beta/order_sources/${orderSourceId}`, rest);
+    };
     /**
      * The `refresh` method refreshes a specific order source by `orderSourceId`.
      * This will pull in any `new orders` since the last order import.

package/order-sources/api.d.ts

@@ -1,5 +1,5 @@
 import { AxiosInstance } from "axios";
-import { OrderSource, OrderSourceConnection } from "./types";
+import { OrderSource, OrderSourceConnection, OrderSourceEditParams } from "./types";
 /**
  * # Order Sources API module - /v-beta/order_sources
  */
@@ -22,6 +22,10 @@ export declare class OrderSourcesAPI {
      * The `get` method retrieves a specific order source by `orderSourceId`.
      */
     get: (orderSourceId: string) => Promise<import("axios").AxiosResponse<OrderSource, any>>;
+    /**
+     * The `update` method will allow the user to update a connected Order Source
+     */
+    update: ({ orderSourceId, ...rest }: OrderSourceEditParams) => Promise<import("axios").AxiosResponse<any, any>>;
     /**
      * The `refresh` method refreshes a specific order source by `orderSourceId`.
      * This will pull in any `new orders` since the last order import.

package/order-sources/types.d.ts

@@ -27,3 +27,4 @@ export interface OrderSourceConnection {
     orderSourceFriendlyName: string;
     orderSourceId: number;
 }
+export type OrderSourceEditParams = Pick<OrderSource, "orderSourceId" | "orderSourceNickname">;

package/package.json

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