@shipengine/js-api 1.3.0 → 1.4.0

package/connections/api.d.ts

@@ -1,7 +1,7 @@
 import { AxiosInstance } from "axios";
-import { GetCarrierConnectionFormParams, GetCarrierConnectionFormResponse, ListCarrierConnectionsParams, ListCarrierConnectionsResponse } from "./types";
+import { ConnectCarrierAccount, ConnectCarrierAccountResponse, GetCarrierConnectionFormParams, GetCarrierConnectionFormResponse, ListCarrierConnectionsParams, ListCarrierConnectionsResponse } from "./types";
 /**
- * # Carriers API module - /v1/carriers
+ * # Connections API module - /v1/connections
  */
 export declare class ConnectionsAPI {
     private client;
@@ -15,4 +15,8 @@ export declare class ConnectionsAPI {
      * information required to connect to the carrier.
      */
     getCarrierConnectionForm: (carrierName: string, params: GetCarrierConnectionFormParams) => Promise<import("axios").AxiosResponse<GetCarrierConnectionFormResponse, any>>;
+    /**
+     * The `connectCarrier` method connects a carrier to account.
+     */
+    connectCarrier: (carrierName: string, formData: ConnectCarrierAccount) => Promise<import("axios").AxiosResponse<ConnectCarrierAccountResponse, any>>;
 }

package/connections/types.d.ts

@@ -15,18 +15,18 @@ export type CarrierMetadata = {
     name: string;
     searchTerms?: string[] | null;
 };
-/**
- * @category Requests
- */
 export type ListCarrierConnectionsParams = LocaleBasedQuery;
 export type GetCarrierConnectionFormParams = LocaleBasedQuery;
+export type ConnectCarrierAccount = {
+    nickname: string;
+} & GenericObject;
 /**
  * @category Responses
  */
 export type GetCarrierConnectionFormResponse = {
     formMetadata: {
-        connectionNames?: string[];
-        defaultConnectionName?: string;
+        connectionNames?: string[] | null;
+        defaultConnectionName?: string | null;
         formSchema: {
             jsonSchema: GenericObject;
             uiSchema: GenericObject;
@@ -34,3 +34,7 @@ export type GetCarrierConnectionFormResponse = {
     };
 };
 export type ListCarrierConnectionsResponse = CarrierMetadata[];
+export type ConnectCarrierAccountResponse = {
+    carrierId?: string;
+    redirectUrl?: string;
+};

package/index.js

@@ -964,7 +964,7 @@ var ipaddr = {
 	}).call(commonjsGlobal);
 } (ipaddr));
 
-var __async$4 = (__this, __arguments, generator) => {
+var __async$5 = (__this, __arguments, generator) => {
   return new Promise((resolve, reject) => {
     var fulfilled = (value) => {
       try {
@@ -984,7 +984,7 @@ var __async$4 = (__this, __arguments, generator) => {
     step((generator = generator.apply(__this, __arguments)).next());
   });
 };
-const getEndUserIpAddress = () => __async$4(void 0, null, function* () {
+const getEndUserIpAddress = () => __async$5(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)) {
@@ -1027,7 +1027,7 @@ var __objRest = (source, exclude) => {
     }
   return target;
 };
-var __async$3 = (__this, __arguments, generator) => {
+var __async$4 = (__this, __arguments, generator) => {
   return new Promise((resolve, reject) => {
     var fulfilled = (value) => {
       try {
@@ -1065,7 +1065,7 @@ class CarriersAPI {
     /**
      * The `connect` method connects a carrier account to a user's ShipEngine account.
      */
-    this.connect = (_a) => __async$3(this, null, function* () {
+    this.connect = (_a) => __async$4(this, null, function* () {
       var _b = _a, { carrierCode } = _b, connection = __objRest(_b, ["carrierCode"]);
       const endUserIpAddress = yield getEndUserIpAddress();
       if (!endUserIpAddress)
@@ -1149,6 +1149,26 @@ class CarriersAPI {
   }
 }
 
+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 ConnectionsAPI {
   constructor(client) {
     this.client = client;
@@ -1168,6 +1188,15 @@ class ConnectionsAPI {
         { params }
       );
     };
+    /**
+     * The `connectCarrier` method connects a carrier to account.
+     */
+    this.connectCarrier = (carrierName, formData) => __async$3(this, null, function* () {
+      return yield this.client.post(
+        `/v1/connections/carriers/${carrierName}`,
+        formData
+      );
+    });
     this.client = client;
   }
 }

package/index.mjs

@@ -960,7 +960,7 @@ var ipaddr = {
 	}).call(commonjsGlobal);
 } (ipaddr));
 
-var __async$4 = (__this, __arguments, generator) => {
+var __async$5 = (__this, __arguments, generator) => {
   return new Promise((resolve, reject) => {
     var fulfilled = (value) => {
       try {
@@ -980,7 +980,7 @@ var __async$4 = (__this, __arguments, generator) => {
     step((generator = generator.apply(__this, __arguments)).next());
   });
 };
-const getEndUserIpAddress = () => __async$4(void 0, null, function* () {
+const getEndUserIpAddress = () => __async$5(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)) {
@@ -1023,7 +1023,7 @@ var __objRest = (source, exclude) => {
     }
   return target;
 };
-var __async$3 = (__this, __arguments, generator) => {
+var __async$4 = (__this, __arguments, generator) => {
   return new Promise((resolve, reject) => {
     var fulfilled = (value) => {
       try {
@@ -1061,7 +1061,7 @@ class CarriersAPI {
     /**
      * The `connect` method connects a carrier account to a user's ShipEngine account.
      */
-    this.connect = (_a) => __async$3(this, null, function* () {
+    this.connect = (_a) => __async$4(this, null, function* () {
       var _b = _a, { carrierCode } = _b, connection = __objRest(_b, ["carrierCode"]);
       const endUserIpAddress = yield getEndUserIpAddress();
       if (!endUserIpAddress)
@@ -1145,6 +1145,26 @@ class CarriersAPI {
   }
 }
 
+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 ConnectionsAPI {
   constructor(client) {
     this.client = client;
@@ -1164,6 +1184,15 @@ class ConnectionsAPI {
         { params }
       );
     };
+    /**
+     * The `connectCarrier` method connects a carrier to account.
+     */
+    this.connectCarrier = (carrierName, formData) => __async$3(this, null, function* () {
+      return yield this.client.post(
+        `/v1/connections/carriers/${carrierName}`,
+        formData
+      );
+    });
     this.client = client;
   }
 }

package/package.json

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