@oway/sdk 0.1.1 → 0.2.0

package/README.md

@@ -179,32 +179,44 @@ const oway = new Oway({
 
 | Environment | Constant | URL |
 |-------------|----------|-----|
-| Sandbox | `OwayEnvironments.SANDBOX` | `https://rest-api.sandbox.oway.io` |
-| Production | `OwayEnvironments.PRODUCTION` | `https://rest-api.oway.io` |
+| Sandbox | `OwayEnvironments.SANDBOX` | `https://api.sandbox.oway.io` |
+| Production | `OwayEnvironments.PRODUCTION` | `https://api.oway.io` |
 
 ## 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:
@@ -216,7 +228,7 @@ import type { Quote, Shipment, Tracking, Invoice, QuoteRequest, ShipmentRequest,
 ## Support
 
 - **Documentation**: [docs.shipoway.com](https://docs.shipoway.com)
-- **API Reference**: [rest-api.oway.io/api-docs](https://rest-api.oway.io/api-docs)
+- **API Reference**: [api.oway.io/api-docs](https://api.oway.io/api-docs)
 - **Email**: support@oway.io
 
 ## License