@oway/sdk 0.1.2 → 0.2.1

package/README.md

@@ -44,7 +44,7 @@ const quote = await oway.quotes.create({
     contactPerson: 'Jane Smith',
   },
   orderComponents: [
-    { palletCount: 2, poundsWeight: 1000, palletDimensions: [48, 40, 48] },
+    { palletCount: 2, poundsWeight: 1000, dimensions: { length: 48, width: 40, height: 48 } },
   ],
 });
 
@@ -56,7 +56,7 @@ const shipment = await oway.shipments.create({
   pickupAddress: { /* same as above */ },
   deliveryAddress: { /* same as above */ },
   orderComponents: [
-    { palletCount: 2, poundsWeight: 1000, palletDimensions: [48, 40, 48] },
+    { palletCount: 2, poundsWeight: 1000, dimensions: { length: 48, width: 40, height: 48 } },
   ],
   description: 'Electronics - fragile',
 });
@@ -96,7 +96,7 @@ You provide credentials once at initialization - token management is automatic.
 const quote = await oway.quotes.create({
   pickupAddress: { name, address1, city, state, zipCode, phoneNumber, contactPerson },
   deliveryAddress: { name, address1, city, state, zipCode, phoneNumber, contactPerson },
-  orderComponents: [{ palletCount: 2, poundsWeight: 1000, palletDimensions: [48, 40, 48] }],
+  orderComponents: [{ palletCount: 2, poundsWeight: 1000, dimensions: { length: 48, width: 40, height: 48 } }],
 });
 
 // Retrieve a quote by ID
@@ -111,7 +111,7 @@ const shipment = await oway.shipments.create({
   quoteId: quote.id,           // Optional: lock in quoted price
   pickupAddress: { ... },
   deliveryAddress: { ... },
-  orderComponents: [{ palletCount: 2, poundsWeight: 1000, palletDimensions: [48, 40, 48] }],
+  orderComponents: [{ palletCount: 2, poundsWeight: 1000, dimensions: { length: 48, width: 40, height: 48 } }],
   description: 'Palletized freight',
   poNumber: 'PO-2024-12345',  // Optional
 });
@@ -184,27 +184,39 @@ const oway = new Oway({
 
 ## Error Handling
 
+Every method throws `OwayError` on a non-2xx response. The error carries the parsed RFC 9457 `ProblemDetail`, the server-issued request id, and per-field validation failures when present.
+
 ```typescript
 import { OwayError } from '@oway/sdk';
 
 try {
-  const quote = await oway.quotes.create({ ... });
+  const shipment = await oway.shipments.create({ ... });
 } catch (error) {
   if (error instanceof OwayError) {
-    console.error({
-      message: error.message,
-      code: error.code,             // Error code
-      statusCode: error.statusCode, // HTTP status
-      requestId: error.requestId,   // For support
-    });
+    // Programmatic branching:
+    switch (error.code) {
+      case 'no_coverage':         /* lane not in coverage */ break;
+      case 'account_restriction': /* service not enabled */ break;
+      case 'daily_trip_limit':    /* trip cap hit */         break;
+    }
 
-    if (error.isRetryable()) {
-      // Retry logic - SDK retries automatically up to maxRetries
+    // Per-field validation failures (when present):
+    for (const v of error.violations) {
+      console.error(`  ${v.field}: ${v.reason}`);
     }
+
+    console.error({
+      message: error.message,         // server detail or title
+      statusCode: error.statusCode,   // HTTP status
+      code: error.code,               // machine-readable reason
+      requestId: error.requestId,     // quote when reporting an issue
+    });
   }
 }
 ```
 
+`OwayError.isRetryable()` is true for 408, 429, 500, 502, 503, and 504. The SDK retries those automatically with full-jitter exponential backoff (capped at 30 s); the helper is exposed so callers can decide how to surface failures.
+
 ## TypeScript Support
 
 Full type definitions included: