@shipengine/js-api 0.47.0 → 0.47.2

package/README.md

@@ -0,0 +1,30 @@
+# ShipEngine JS Api
+
+The `shipengine/js-api` library instantiates a batteries-included, vanilla JavaScript client for interacting with the [ShipEngine API](https://shipengine.github.io/shipengine-openapi/). The client provides a set of fully-typed methods that map directly to ShipEngine API operations[^1], bound to a user specified via platform token.
+
+## Features:
+
+- Converts all outbound JSON keys to `snake_case` for consumption by the ShipEngine API.
+- Converts all inbound JSON keys to `camelCase` for use in JS.
+- Attempts to refresh expired tokens on `401 Unauthorized` responses, followed by retrying the original request.
+- Logs all requests and responses to the console.
+
+In addition to the client, the `shipengine/js-api` lib provides TypeScript types for all ShipEngine API entities.
+
+## Basic Usage
+
+```tsx
+import { ShipEngineAPI } from "@shipengine/js-api";
+
+const client = new ShipEngineAPI("your-platform-token", {
+  // Used when attempting to refresh the token on 401 responses
+  getToken: async () => {
+    return "your-platform-token";
+  },
+});
+
+client.shipments.list().then((response) => {
+  console.log(response.data);
+  // > an object matching the response schema of https://shipengine.github.io/shipengine-openapi/#operation/list_shipments
+});
+```

package/index.js

@@ -3774,7 +3774,10 @@ class ShippingRulesAPI {
      * `ShippingRule`.
      */
     this.edit = (shippingRule) => {
-      return this.client.put(`/v1/shipping_rules/${shippingRule.id}`, shippingRule);
+      return this.client.put(
+        `/v1/shipping_rules/${shippingRule.shippingRuleId}`,
+        shippingRule
+      );
     };
     this.client = client;
   }

package/index.mjs

@@ -3770,7 +3770,10 @@ class ShippingRulesAPI {
      * `ShippingRule`.
      */
     this.edit = (shippingRule) => {
-      return this.client.put(`/v1/shipping_rules/${shippingRule.id}`, shippingRule);
+      return this.client.put(
+        `/v1/shipping_rules/${shippingRule.shippingRuleId}`,
+        shippingRule
+      );
     };
     this.client = client;
   }

package/package.json

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

package/shipping-rules/types.d.ts

@@ -28,7 +28,7 @@ export interface Rule {
  */
 export interface ShippingRuleSelectedService {
     carrierId: string;
-    carrierServiceCode: string;
+    serviceCode: string;
 }
 /**
  * @category Entities
@@ -40,13 +40,13 @@ export interface ShippingRule {
     default: ShippingRuleSelectedService;
     deleted?: boolean;
     deletedAt?: ISOString;
-    id: string;
     name: string;
     rules?: Rule[];
+    shippingRuleId: string;
     updatedAt?: ISOString;
 }
 /**
  * @category Entities
  */
-export type ShippingRuleInput = Omit<ShippingRule, "id">;
+export type ShippingRuleInput = Omit<ShippingRule, "shippingRuleId">;
 export {};