@shipengine/js-api 4.5.1 → 4.6.0

package/connections/api.d.ts

@@ -1,5 +1,5 @@
 import { AxiosInstance } from "axios";
-import { CarrierServicesListResponse, ConnectCarrierAccount, ConnectCarrierAccountResponse, ConnectionsCarrierName, ConnectionsCarrierSettingsData, ConnectionsCarrierSettingsResponse, GetCarrierConnectionFormParams, GetCarrierConnectionFormResponse, ListCarrierConnectionsParams, ListCarrierConnectionsResponse } from "./types";
+import { CarrierServicesListResponse, ConnectCarrierAccount, ConnectCarrierAccountResponse, ConnectionsCarrierName, ConnectionsCarrierSettingsData, ConnectionsCarrierSettingsResponse, GetCarrierConnectionFormParams, GetCarrierConnectionFormResponse, ListCarrierConnectionsParams, ListCarrierConnectionsResponse, RequestStampsAccountUrlParams, RequestStampsAccountUrlResponse } from "./types";
 /**
  * # Connections API module - /v1/connections
  */
@@ -34,4 +34,10 @@ export declare class ConnectionsAPI {
      * identified by the `carrierName` and `carrierId`.
      */
     updateCarrierSettings: <T extends ConnectionsCarrierName>(carrierName: T, carrierId: string, formData: ConnectionsCarrierSettingsData<T>) => Promise<import("axios").AxiosResponse<void, any>>;
+    /**
+     * The `requestStampsAccountUrls` method request the Web Client Home URL from Stamps for a given
+     * Stamps SE Carrier ID
+     * @docs https://auctane.atlassian.net/wiki/spaces/SEEU/pages/6228738069/ENGINE-9471+Endicia+web+client+communication
+     */
+    requestStampsAccountUrls: ({ carrierId, ...rest }: RequestStampsAccountUrlParams) => Promise<import("axios").AxiosResponse<RequestStampsAccountUrlResponse, any>>;
 }

package/connections/types.d.ts

@@ -16,14 +16,25 @@ export type CarrierMetadata = {
     name: string;
     searchTerms?: string[] | null;
 };
+export type StampsAccountUrlTypes = "account_settings" | "report_balances" | "manifest_form" | "payment_methods" | "web_client_home";
 export type ListCarrierConnectionsParams = LocaleBasedQuery;
 export type GetCarrierConnectionFormParams = LocaleBasedQuery;
+export type RequestStampsAccountUrlParams = {
+    carrierId: string;
+    urlTypes: StampsAccountUrlTypes[];
+};
 export type ConnectCarrierAccount = {
     nickname: string;
 } & GenericObject;
 /**
  * @category Responses
  */
+export type RequestStampsAccountUrlResponse = {
+    urls: Array<{
+        url: string;
+        urlType: string;
+    }>;
+};
 export type GetCarrierConnectionFormResponse = {
     formMetadata: {
         connectionNames?: string[] | null;

package/index.js

@@ -10,17 +10,17 @@ var AccountBillingPlanChangeType = /* @__PURE__ */ ((AccountBillingPlanChangeTyp
   return AccountBillingPlanChangeType2;
 })(AccountBillingPlanChangeType || {});
 
-var __getOwnPropSymbols$7 = Object.getOwnPropertySymbols;
-var __hasOwnProp$7 = Object.prototype.hasOwnProperty;
-var __propIsEnum$7 = Object.prototype.propertyIsEnumerable;
-var __objRest$4 = (source, exclude) => {
+var __getOwnPropSymbols$8 = Object.getOwnPropertySymbols;
+var __hasOwnProp$8 = Object.prototype.hasOwnProperty;
+var __propIsEnum$8 = Object.prototype.propertyIsEnumerable;
+var __objRest$5 = (source, exclude) => {
   var target = {};
   for (var prop in source)
-    if (__hasOwnProp$7.call(source, prop) && exclude.indexOf(prop) < 0)
+    if (__hasOwnProp$8.call(source, prop) && exclude.indexOf(prop) < 0)
       target[prop] = source[prop];
-  if (source != null && __getOwnPropSymbols$7)
-    for (var prop of __getOwnPropSymbols$7(source)) {
-      if (exclude.indexOf(prop) < 0 && __propIsEnum$7.call(source, prop))
+  if (source != null && __getOwnPropSymbols$8)
+    for (var prop of __getOwnPropSymbols$8(source)) {
+      if (exclude.indexOf(prop) < 0 && __propIsEnum$8.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$4(_b, ["message"]);
+    var _b = _a, { message } = _b, options = __objRest$5(_b, ["message"]);
     return new CodedError(message, options);
   }
 }
@@ -155,17 +155,17 @@ const types = /*#__PURE__*/Object.freeze(/*#__PURE__*/Object.defineProperty({
   RateCardStatus
 }, Symbol.toStringTag, { value: 'Module' }));
 
-var __getOwnPropSymbols$6 = Object.getOwnPropertySymbols;
-var __hasOwnProp$6 = Object.prototype.hasOwnProperty;
-var __propIsEnum$6 = Object.prototype.propertyIsEnumerable;
-var __objRest$3 = (source, exclude) => {
+var __getOwnPropSymbols$7 = Object.getOwnPropertySymbols;
+var __hasOwnProp$7 = Object.prototype.hasOwnProperty;
+var __propIsEnum$7 = Object.prototype.propertyIsEnumerable;
+var __objRest$4 = (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;
@@ -197,7 +197,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$3(_b, ["labelImageId"]);
+      var _b = _a, { labelImageId } = _b, data = __objRest$4(_b, ["labelImageId"]);
       return this.client.put(`/v1/account/settings/images/${labelImageId}`, data);
     };
     /**
@@ -1123,30 +1123,30 @@ const decamelizeKeys = (obj, separator = "_") => {
 var __defProp$4 = Object.defineProperty;
 var __defProps$1 = Object.defineProperties;
 var __getOwnPropDescs$1 = Object.getOwnPropertyDescriptors;
-var __getOwnPropSymbols$5 = Object.getOwnPropertySymbols;
-var __hasOwnProp$5 = Object.prototype.hasOwnProperty;
-var __propIsEnum$5 = Object.prototype.propertyIsEnumerable;
+var __getOwnPropSymbols$6 = Object.getOwnPropertySymbols;
+var __hasOwnProp$6 = Object.prototype.hasOwnProperty;
+var __propIsEnum$6 = 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$5.call(b, prop))
+    if (__hasOwnProp$6.call(b, prop))
       __defNormalProp$4(a, prop, b[prop]);
-  if (__getOwnPropSymbols$5)
-    for (var prop of __getOwnPropSymbols$5(b)) {
-      if (__propIsEnum$5.call(b, prop))
+  if (__getOwnPropSymbols$6)
+    for (var prop of __getOwnPropSymbols$6(b)) {
+      if (__propIsEnum$6.call(b, prop))
         __defNormalProp$4(a, prop, b[prop]);
     }
   return a;
 };
 var __spreadProps$1 = (a, b) => __defProps$1(a, __getOwnPropDescs$1(b));
-var __objRest$2 = (source, exclude) => {
+var __objRest$3 = (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;
@@ -1192,7 +1192,7 @@ class CarriersAPI {
      * The `connect` method connects a carrier account to a user's ShipEngine account.
      */
     this.connect = (_a) => __async$6(this, null, function* () {
-      var _b = _a, { carrierCode } = _b, connection = __objRest$2(_b, ["carrierCode"]);
+      var _b = _a, { carrierCode } = _b, connection = __objRest$3(_b, ["carrierCode"]);
       const endUserIpAddress = yield getEndUserIpAddress();
       if (!endUserIpAddress)
         return Promise.reject([new CodedError("Unable to get IP address")]);
@@ -1282,6 +1282,21 @@ class CarriersAPI {
   }
 }
 
+var __getOwnPropSymbols$5 = Object.getOwnPropertySymbols;
+var __hasOwnProp$5 = Object.prototype.hasOwnProperty;
+var __propIsEnum$5 = 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)
+      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))
+        target[prop] = source[prop];
+    }
+  return target;
+};
 var __async$5 = (__this, __arguments, generator) => {
   return new Promise((resolve, reject) => {
     var fulfilled = (value) => {
@@ -1366,6 +1381,18 @@ class ConnectionsAPI {
         formData
       );
     };
+    /**
+     * The `requestStampsAccountUrls` method request the Web Client Home URL from Stamps for a given
+     * Stamps SE Carrier ID
+     * @docs https://auctane.atlassian.net/wiki/spaces/SEEU/pages/6228738069/ENGINE-9471+Endicia+web+client+communication
+     */
+    this.requestStampsAccountUrls = (_a) => {
+      var _b = _a, { carrierId } = _b, rest = __objRest$2(_b, ["carrierId"]);
+      return this.client.put(
+        `v1/connections/carriers/stamps_com/${carrierId}/request_account_url`,
+        rest
+      );
+    };
     this.client = client;
   }
 }

package/index.mjs

@@ -6,17 +6,17 @@ var AccountBillingPlanChangeType = /* @__PURE__ */ ((AccountBillingPlanChangeTyp
   return AccountBillingPlanChangeType2;
 })(AccountBillingPlanChangeType || {});
 
-var __getOwnPropSymbols$7 = Object.getOwnPropertySymbols;
-var __hasOwnProp$7 = Object.prototype.hasOwnProperty;
-var __propIsEnum$7 = Object.prototype.propertyIsEnumerable;
-var __objRest$4 = (source, exclude) => {
+var __getOwnPropSymbols$8 = Object.getOwnPropertySymbols;
+var __hasOwnProp$8 = Object.prototype.hasOwnProperty;
+var __propIsEnum$8 = Object.prototype.propertyIsEnumerable;
+var __objRest$5 = (source, exclude) => {
   var target = {};
   for (var prop in source)
-    if (__hasOwnProp$7.call(source, prop) && exclude.indexOf(prop) < 0)
+    if (__hasOwnProp$8.call(source, prop) && exclude.indexOf(prop) < 0)
       target[prop] = source[prop];
-  if (source != null && __getOwnPropSymbols$7)
-    for (var prop of __getOwnPropSymbols$7(source)) {
-      if (exclude.indexOf(prop) < 0 && __propIsEnum$7.call(source, prop))
+  if (source != null && __getOwnPropSymbols$8)
+    for (var prop of __getOwnPropSymbols$8(source)) {
+      if (exclude.indexOf(prop) < 0 && __propIsEnum$8.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$4(_b, ["message"]);
+    var _b = _a, { message } = _b, options = __objRest$5(_b, ["message"]);
     return new CodedError(message, options);
   }
 }
@@ -151,17 +151,17 @@ const types = /*#__PURE__*/Object.freeze(/*#__PURE__*/Object.defineProperty({
   RateCardStatus
 }, Symbol.toStringTag, { value: 'Module' }));
 
-var __getOwnPropSymbols$6 = Object.getOwnPropertySymbols;
-var __hasOwnProp$6 = Object.prototype.hasOwnProperty;
-var __propIsEnum$6 = Object.prototype.propertyIsEnumerable;
-var __objRest$3 = (source, exclude) => {
+var __getOwnPropSymbols$7 = Object.getOwnPropertySymbols;
+var __hasOwnProp$7 = Object.prototype.hasOwnProperty;
+var __propIsEnum$7 = Object.prototype.propertyIsEnumerable;
+var __objRest$4 = (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;
@@ -193,7 +193,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$3(_b, ["labelImageId"]);
+      var _b = _a, { labelImageId } = _b, data = __objRest$4(_b, ["labelImageId"]);
       return this.client.put(`/v1/account/settings/images/${labelImageId}`, data);
     };
     /**
@@ -1119,30 +1119,30 @@ const decamelizeKeys = (obj, separator = "_") => {
 var __defProp$4 = Object.defineProperty;
 var __defProps$1 = Object.defineProperties;
 var __getOwnPropDescs$1 = Object.getOwnPropertyDescriptors;
-var __getOwnPropSymbols$5 = Object.getOwnPropertySymbols;
-var __hasOwnProp$5 = Object.prototype.hasOwnProperty;
-var __propIsEnum$5 = Object.prototype.propertyIsEnumerable;
+var __getOwnPropSymbols$6 = Object.getOwnPropertySymbols;
+var __hasOwnProp$6 = Object.prototype.hasOwnProperty;
+var __propIsEnum$6 = 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$5.call(b, prop))
+    if (__hasOwnProp$6.call(b, prop))
       __defNormalProp$4(a, prop, b[prop]);
-  if (__getOwnPropSymbols$5)
-    for (var prop of __getOwnPropSymbols$5(b)) {
-      if (__propIsEnum$5.call(b, prop))
+  if (__getOwnPropSymbols$6)
+    for (var prop of __getOwnPropSymbols$6(b)) {
+      if (__propIsEnum$6.call(b, prop))
         __defNormalProp$4(a, prop, b[prop]);
     }
   return a;
 };
 var __spreadProps$1 = (a, b) => __defProps$1(a, __getOwnPropDescs$1(b));
-var __objRest$2 = (source, exclude) => {
+var __objRest$3 = (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;
@@ -1188,7 +1188,7 @@ class CarriersAPI {
      * The `connect` method connects a carrier account to a user's ShipEngine account.
      */
     this.connect = (_a) => __async$6(this, null, function* () {
-      var _b = _a, { carrierCode } = _b, connection = __objRest$2(_b, ["carrierCode"]);
+      var _b = _a, { carrierCode } = _b, connection = __objRest$3(_b, ["carrierCode"]);
       const endUserIpAddress = yield getEndUserIpAddress();
       if (!endUserIpAddress)
         return Promise.reject([new CodedError("Unable to get IP address")]);
@@ -1278,6 +1278,21 @@ class CarriersAPI {
   }
 }
 
+var __getOwnPropSymbols$5 = Object.getOwnPropertySymbols;
+var __hasOwnProp$5 = Object.prototype.hasOwnProperty;
+var __propIsEnum$5 = 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)
+      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))
+        target[prop] = source[prop];
+    }
+  return target;
+};
 var __async$5 = (__this, __arguments, generator) => {
   return new Promise((resolve, reject) => {
     var fulfilled = (value) => {
@@ -1362,6 +1377,18 @@ class ConnectionsAPI {
         formData
       );
     };
+    /**
+     * The `requestStampsAccountUrls` method request the Web Client Home URL from Stamps for a given
+     * Stamps SE Carrier ID
+     * @docs https://auctane.atlassian.net/wiki/spaces/SEEU/pages/6228738069/ENGINE-9471+Endicia+web+client+communication
+     */
+    this.requestStampsAccountUrls = (_a) => {
+      var _b = _a, { carrierId } = _b, rest = __objRest$2(_b, ["carrierId"]);
+      return this.client.put(
+        `v1/connections/carriers/stamps_com/${carrierId}/request_account_url`,
+        rest
+      );
+    };
     this.client = client;
   }
 }

package/package.json

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