@shipengine/js-api 2.0.0 → 2.1.0

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

@@ -1225,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
       );
     };
@@ -3875,10 +3875,16 @@ class SellersAPI {
     /**
      * Adds sandbox carriers to a seller, you can pass in a flag to try to reuse the carrier connection.
      */
-    this.addSandboxCarriers = ({ sellerId, tryReuseCarrierConnection }) => {
-      return this.client.post(`/v1/sellers/add_sandbox_carriers/${sellerId}`, {
-        tryReuseCarrierConnection
-      });
+    this.addSandboxCarriers = (props) => {
+      return this.client.post(
+        `/v1/sellers/add_sandbox_carriers/${props.sellerId}`,
+        {
+          tryReuseCarrierConnection: props.tryReuseCarrierConnection
+        },
+        {
+          isSandbox: props.isSandbox
+        }
+      );
     };
     this.client = client;
   }

package/index.mjs

@@ -1221,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
       );
     };
@@ -3871,10 +3871,16 @@ class SellersAPI {
     /**
      * Adds sandbox carriers to a seller, you can pass in a flag to try to reuse the carrier connection.
      */
-    this.addSandboxCarriers = ({ sellerId, tryReuseCarrierConnection }) => {
-      return this.client.post(`/v1/sellers/add_sandbox_carriers/${sellerId}`, {
-        tryReuseCarrierConnection
-      });
+    this.addSandboxCarriers = (props) => {
+      return this.client.post(
+        `/v1/sellers/add_sandbox_carriers/${props.sellerId}`,
+        {
+          tryReuseCarrierConnection: props.tryReuseCarrierConnection
+        },
+        {
+          isSandbox: props.isSandbox
+        }
+      );
     };
     this.client = client;
   }

package/package.json

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

package/sellers/api.d.ts

@@ -1,4 +1,5 @@
 import { AxiosInstance } from "axios";
+import { SandboxableMutation } from "../resources";
 import type { ListSandboxSellersParams, SandboxMethodParams } from "./types";
 /**
  * Sellers API endpoints
@@ -18,5 +19,5 @@ export declare class SellersAPI {
     /**
      * Adds sandbox carriers to a seller, you can pass in a flag to try to reuse the carrier connection.
      */
-    addSandboxCarriers: ({ sellerId, tryReuseCarrierConnection }: SandboxMethodParams) => Promise<import("axios").AxiosResponse<void, any>>;
+    addSandboxCarriers: (props: SandboxableMutation<SandboxMethodParams>) => Promise<import("axios").AxiosResponse<void, any>>;
 }