@shipengine/js-api 1.30.2 → 2.0.1

package/carriers/api.d.ts

@@ -1,5 +1,6 @@
 import { AxiosInstance } from "axios";
 import { Currency, Money } from "../payments";
+import { SandboxableQuery } from "../resources";
 import { Carrier, CarrierAutoFundingSettings, CarrierAutoFundingSettingsResponse, CarrierConnection, CarrierService, CarrierZone, PackageRatingType } from "./types";
 /**
  * # Carriers API module - /v1/carriers
@@ -10,7 +11,7 @@ export declare class CarriersAPI {
     /**
      * The `list` method retrieves a list of connected carriers for a given user.
      */
-    list: () => Promise<import("axios").AxiosResponse<{
+    list: (props?: SandboxableQuery) => Promise<import("axios").AxiosResponse<{
         carriers: Carrier[];
     }, any>>;
     /**

package/client.d.ts

@@ -21,6 +21,14 @@ import { ShippingRulesAPI } from "./shipping-rules";
 import { ThemesAPI } from "./themes";
 import { WarehousesAPI } from "./warehouses";
 import { WebhooksAPI } from "./webhooks";
+/**
+ * Extends client with custom properties
+ */
+declare module "axios" {
+    interface AxiosRequestConfig {
+        isSandbox?: boolean;
+    }
+}
 /**
  * # ShipEngine API Client Headers
  */
@@ -40,7 +48,11 @@ export interface ShipEngineAPIConfig {
      */
     baseURL?: string;
     /**
-     * `getToken` is an optional callback function that returns a token to used to authenticate all requests.
+     * `getSandboxToken` is an optional callback function that returns a token to be used to authenticate sandbox requests.
+     */
+    getSandboxToken?: () => Promise<string> | string;
+    /**
+     * `getToken` is a callback function that returns a token to used to authenticate all requests.
      */
     getToken: () => Promise<string> | string;
     /**
@@ -60,7 +72,8 @@ export interface ShipEngineAPIConfig {
  */
 export declare class ShipEngineAPI {
     private client;
-    constructor(token: string, { baseURL, headers, getToken, onApiError }: ShipEngineAPIConfig);
+    private sandboxToken?;
+    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.
      */

package/connections/api.d.ts

@@ -26,12 +26,12 @@ export declare class ConnectionsAPI {
     getCarrierConnectionsServicesList: (carrierCode: string) => Promise<import("axios").AxiosResponse<CarrierServicesListResponse, any>>;
     /**
      * The `getCarrierSettings` method retrieves the settings for a given carrier,
-     * identified by the `carrierName` and `carrierCode`.
+     * identified by the `carrierName` and `carrierId`.
      */
-    getCarrierSettings: <T extends ConnectionsCarrierName>(carrierName: T, carrierCode: string) => Promise<import("axios").AxiosResponse<ConnectionsCarrierSettingsResponse<T>, any>>;
+    getCarrierSettings: <T extends ConnectionsCarrierName>(carrierName: T, carrierId: string) => Promise<import("axios").AxiosResponse<ConnectionsCarrierSettingsResponse<T>, any>>;
     /**
      * The `updateCarrierSettings` method updates the settings for a given carrier,
-     * identified by the `carrierName` and `carrierCode`.
+     * identified by the `carrierName` and `carrierId`.
      */
-    updateCarrierSettings: <T extends ConnectionsCarrierName>(carrierName: T, carrierCode: string, formData: ConnectionsCarrierSettingsData<T>) => Promise<import("axios").AxiosResponse<void, any>>;
+    updateCarrierSettings: <T extends ConnectionsCarrierName>(carrierName: T, carrierId: string, formData: ConnectionsCarrierSettingsData<T>) => Promise<import("axios").AxiosResponse<void, any>>;
 }

package/index.js

@@ -1053,8 +1053,10 @@ class CarriersAPI {
     /**
      * The `list` method retrieves a list of connected carriers for a given user.
      */
-    this.list = () => {
-      return this.client.get("/v1/carriers");
+    this.list = (props) => {
+      return this.client.get("/v1/carriers", {
+        isSandbox: props == null ? void 0 : props.isSandbox
+      });
     };
     /**
      * The `get` method retrieves a specific carrier by `carrierId`.
@@ -1223,20 +1225,20 @@ class ConnectionsAPI {
     };
     /**
      * The `getCarrierSettings` method retrieves the settings for a given carrier,
-     * identified by the `carrierName` and `carrierCode`.
+     * identified by the `carrierName` and `carrierId`.
      */
-    this.getCarrierSettings = (carrierName, carrierCode) => {
+    this.getCarrierSettings = (carrierName, carrierId) => {
       return this.client.get(
-        `/v1/connections/carriers/${carrierName}/${carrierCode}/settings`
+        `/v1/connections/carriers/${carrierName}/${carrierId}/settings`
       );
     };
     /**
      * The `updateCarrierSettings` method updates the settings for a given carrier,
-     * identified by the `carrierName` and `carrierCode`.
+     * identified by the `carrierName` and `carrierId`.
      */
-    this.updateCarrierSettings = (carrierName, carrierCode, formData) => {
+    this.updateCarrierSettings = (carrierName, carrierId, formData) => {
       return this.client.put(
-        `/v1/connections/carriers/${carrierName}/${carrierCode}/settings`,
+        `/v1/connections/carriers/${carrierName}/${carrierId}/settings`,
         formData
       );
     };
@@ -3988,42 +3990,55 @@ class ShippingRulesAPI {
     /**
      * The `list` method retrieves the list of shipping rules by seller.
      */
-    this.list = () => {
-      return this.client.get(`/v1/shipping_rules`);
+    this.list = (props) => {
+      return this.client.get(`/v1/shipping_rules`, {
+        isSandbox: props == null ? void 0 : props.isSandbox
+      });
     };
     /**
      * The `get` method retrieves a specific shipping rule by `shippingRuleId`.
      */
-    this.get = (shippingRuleId) => {
-      return this.client.get(`/v1/shipping_rules/${shippingRuleId}`);
+    this.get = (props) => {
+      return this.client.get(`/v1/shipping_rules/${props == null ? void 0 : props.shippingRuleId}`, {
+        isSandbox: props == null ? void 0 : props.isSandbox
+      });
     };
     /**
      * The `create` method creates a new shipping rule for a given user.
      */
-    this.create = (shippingRule) => {
-      return this.client.post("/v1/shipping_rules", shippingRule);
+    this.create = (props) => {
+      return this.client.post("/v1/shipping_rules", props.shippingRule, {
+        isSandbox: props.isSandbox
+      });
     };
     /**
      * The `delete` method deletes a shipping rule by `shippingRuleId`.
      */
-    this.delete = (shippingRuleId) => {
-      return this.client.delete(`/v1/shipping_rules/${shippingRuleId}`);
+    this.delete = (props) => {
+      return this.client.delete(`/v1/shipping_rules/${props.shippingRuleId}`, {
+        isSandbox: props.isSandbox
+      });
     };
     /**
      * The `edit` method edits a specific shipping rule by `shippingRuleId` with a new
      * `ShippingRule`.
      */
-    this.edit = (shippingRule) => {
+    this.edit = (props) => {
       return this.client.put(
-        `/v1/shipping_rules/${shippingRule.shippingRuleId}`,
-        shippingRule
+        `/v1/shipping_rules/${props.shippingRule.shippingRuleId}`,
+        props.shippingRule,
+        {
+          isSandbox: props.isSandbox
+        }
       );
     };
     /**
      * The `getConditionOptions` method retrieves the list of condition options availables for creating shipping rules.
      */
-    this.getConditionOptions = () => {
-      return this.client.get(`/v1/shipping_rules/rule_conditions_options`);
+    this.getConditionOptions = (props) => {
+      return this.client.get(`/v1/shipping_rules/rule_conditions_options`, {
+        isSandbox: props == null ? void 0 : props.isSandbox
+      });
     };
     this.client = client;
   }
@@ -4049,8 +4064,10 @@ class WarehousesAPI {
      * The `list` method retrieves a list of `warehouses` (Ship From Locations)
      * for a given user.
      */
-    this.list = () => {
-      return this.client.get("/v1/warehouses");
+    this.list = (props) => {
+      return this.client.get("/v1/warehouses", {
+        isSandbox: props == null ? void 0 : props.isSandbox
+      });
     };
     /**
      * The `create` method allows for creation of warehouses (Ship From Locations)
@@ -21402,7 +21419,7 @@ const logger = E({
   ]
 });
 class ShipEngineAPI {
-  constructor(token, { baseURL, headers, getToken, onApiError }) {
+  constructor(token, { baseURL, headers, getToken, getSandboxToken, onApiError }) {
     const client = axios.create({
       baseURL,
       headers: __spreadProps(__spreadValues({}, headers), {
@@ -21439,6 +21456,21 @@ class ShipEngineAPI {
       ]
     });
     client.defaults.headers.common["Authorization"] = `Bearer ${token}`;
+    client.interceptors.request.use(
+      (config) => __async(this, null, function* () {
+        if (config.isSandbox) {
+          if (!this.sandboxToken) {
+            this.sandboxToken = yield getSandboxToken == null ? void 0 : getSandboxToken();
+          }
+          config.headers || (config.headers = {});
+          config.headers["Authorization"] = `Bearer ${this.sandboxToken}`;
+        }
+        return config;
+      }),
+      function(error) {
+        return Promise.reject(error);
+      }
+    );
     client.interceptors.response.use(
       (res) => {
         var _a;
@@ -21464,9 +21496,13 @@ class ShipEngineAPI {
           err.message
         );
         if (isInvalidTokenError(err)) {
-          const token2 = yield getToken();
+          const token2 = yield err.config.isSandbox ? getSandboxToken == null ? void 0 : getSandboxToken() : getToken();
           const config = err.config;
-          this.token = token2;
+          if (err.config.isSandbox) {
+            this.sandboxToken = token2;
+          } else {
+            this.token = token2;
+          }
           if (config) {
             config.headers || (config.headers = {});
             config.headers["Authorization"] = `Bearer ${token2}`;

package/index.mjs

@@ -1049,8 +1049,10 @@ class CarriersAPI {
     /**
      * The `list` method retrieves a list of connected carriers for a given user.
      */
-    this.list = () => {
-      return this.client.get("/v1/carriers");
+    this.list = (props) => {
+      return this.client.get("/v1/carriers", {
+        isSandbox: props == null ? void 0 : props.isSandbox
+      });
     };
     /**
      * The `get` method retrieves a specific carrier by `carrierId`.
@@ -1219,20 +1221,20 @@ class ConnectionsAPI {
     };
     /**
      * The `getCarrierSettings` method retrieves the settings for a given carrier,
-     * identified by the `carrierName` and `carrierCode`.
+     * identified by the `carrierName` and `carrierId`.
      */
-    this.getCarrierSettings = (carrierName, carrierCode) => {
+    this.getCarrierSettings = (carrierName, carrierId) => {
       return this.client.get(
-        `/v1/connections/carriers/${carrierName}/${carrierCode}/settings`
+        `/v1/connections/carriers/${carrierName}/${carrierId}/settings`
       );
     };
     /**
      * The `updateCarrierSettings` method updates the settings for a given carrier,
-     * identified by the `carrierName` and `carrierCode`.
+     * identified by the `carrierName` and `carrierId`.
      */
-    this.updateCarrierSettings = (carrierName, carrierCode, formData) => {
+    this.updateCarrierSettings = (carrierName, carrierId, formData) => {
       return this.client.put(
-        `/v1/connections/carriers/${carrierName}/${carrierCode}/settings`,
+        `/v1/connections/carriers/${carrierName}/${carrierId}/settings`,
         formData
       );
     };
@@ -3984,42 +3986,55 @@ class ShippingRulesAPI {
     /**
      * The `list` method retrieves the list of shipping rules by seller.
      */
-    this.list = () => {
-      return this.client.get(`/v1/shipping_rules`);
+    this.list = (props) => {
+      return this.client.get(`/v1/shipping_rules`, {
+        isSandbox: props == null ? void 0 : props.isSandbox
+      });
     };
     /**
      * The `get` method retrieves a specific shipping rule by `shippingRuleId`.
      */
-    this.get = (shippingRuleId) => {
-      return this.client.get(`/v1/shipping_rules/${shippingRuleId}`);
+    this.get = (props) => {
+      return this.client.get(`/v1/shipping_rules/${props == null ? void 0 : props.shippingRuleId}`, {
+        isSandbox: props == null ? void 0 : props.isSandbox
+      });
     };
     /**
      * The `create` method creates a new shipping rule for a given user.
      */
-    this.create = (shippingRule) => {
-      return this.client.post("/v1/shipping_rules", shippingRule);
+    this.create = (props) => {
+      return this.client.post("/v1/shipping_rules", props.shippingRule, {
+        isSandbox: props.isSandbox
+      });
     };
     /**
      * The `delete` method deletes a shipping rule by `shippingRuleId`.
      */
-    this.delete = (shippingRuleId) => {
-      return this.client.delete(`/v1/shipping_rules/${shippingRuleId}`);
+    this.delete = (props) => {
+      return this.client.delete(`/v1/shipping_rules/${props.shippingRuleId}`, {
+        isSandbox: props.isSandbox
+      });
     };
     /**
      * The `edit` method edits a specific shipping rule by `shippingRuleId` with a new
      * `ShippingRule`.
      */
-    this.edit = (shippingRule) => {
+    this.edit = (props) => {
       return this.client.put(
-        `/v1/shipping_rules/${shippingRule.shippingRuleId}`,
-        shippingRule
+        `/v1/shipping_rules/${props.shippingRule.shippingRuleId}`,
+        props.shippingRule,
+        {
+          isSandbox: props.isSandbox
+        }
       );
     };
     /**
      * The `getConditionOptions` method retrieves the list of condition options availables for creating shipping rules.
      */
-    this.getConditionOptions = () => {
-      return this.client.get(`/v1/shipping_rules/rule_conditions_options`);
+    this.getConditionOptions = (props) => {
+      return this.client.get(`/v1/shipping_rules/rule_conditions_options`, {
+        isSandbox: props == null ? void 0 : props.isSandbox
+      });
     };
     this.client = client;
   }
@@ -4045,8 +4060,10 @@ class WarehousesAPI {
      * The `list` method retrieves a list of `warehouses` (Ship From Locations)
      * for a given user.
      */
-    this.list = () => {
-      return this.client.get("/v1/warehouses");
+    this.list = (props) => {
+      return this.client.get("/v1/warehouses", {
+        isSandbox: props == null ? void 0 : props.isSandbox
+      });
     };
     /**
      * The `create` method allows for creation of warehouses (Ship From Locations)
@@ -21398,7 +21415,7 @@ const logger = E({
   ]
 });
 class ShipEngineAPI {
-  constructor(token, { baseURL, headers, getToken, onApiError }) {
+  constructor(token, { baseURL, headers, getToken, getSandboxToken, onApiError }) {
     const client = axios.create({
       baseURL,
       headers: __spreadProps(__spreadValues({}, headers), {
@@ -21435,6 +21452,21 @@ class ShipEngineAPI {
       ]
     });
     client.defaults.headers.common["Authorization"] = `Bearer ${token}`;
+    client.interceptors.request.use(
+      (config) => __async(this, null, function* () {
+        if (config.isSandbox) {
+          if (!this.sandboxToken) {
+            this.sandboxToken = yield getSandboxToken == null ? void 0 : getSandboxToken();
+          }
+          config.headers || (config.headers = {});
+          config.headers["Authorization"] = `Bearer ${this.sandboxToken}`;
+        }
+        return config;
+      }),
+      function(error) {
+        return Promise.reject(error);
+      }
+    );
     client.interceptors.response.use(
       (res) => {
         var _a;
@@ -21460,9 +21492,13 @@ class ShipEngineAPI {
           err.message
         );
         if (isInvalidTokenError(err)) {
-          const token2 = yield getToken();
+          const token2 = yield err.config.isSandbox ? getSandboxToken == null ? void 0 : getSandboxToken() : getToken();
           const config = err.config;
-          this.token = token2;
+          if (err.config.isSandbox) {
+            this.sandboxToken = token2;
+          } else {
+            this.token = token2;
+          }
           if (config) {
             config.headers || (config.headers = {});
             config.headers["Authorization"] = `Bearer ${token2}`;

package/package.json

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

package/resources/types.d.ts

@@ -54,3 +54,9 @@ export type SortableQuery<TSortKeys = "created_at" | "modified_at"> = {
 export type LocaleBasedQuery = {
     locale?: string;
 };
+export type SandboxableQuery<T = unknown> = T & {
+    isSandbox?: boolean;
+};
+export type SandboxableMutation<T = unknown> = T & {
+    isSandbox?: boolean;
+};

package/shipping-rules/api.d.ts

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

package/warehouses/api.d.ts

@@ -1,4 +1,5 @@
 import { AxiosInstance } from "axios";
+import { SandboxableQuery } from "../resources";
 import { Warehouse } from "./types";
 /**
  * # Warehouses API module - /v1/warehouses
@@ -10,7 +11,7 @@ export declare class WarehousesAPI {
      * The `list` method retrieves a list of `warehouses` (Ship From Locations)
      * for a given user.
      */
-    list: () => Promise<import("axios").AxiosResponse<{
+    list: (props?: SandboxableQuery) => Promise<import("axios").AxiosResponse<{
         warehouses: Warehouse[];
     }, any>>;
     /**