@unofficialbox/box-open-sdk 0.6.0 → 0.6.1

package/docs/errors.md

@@ -12,10 +12,42 @@ and the raw `body`; transport and decode failures carry the underlying
 ```ts
 import { runtime } from '@unofficialbox/box-open-sdk';
 try {
-await client.files.getFileById(fileId);
+  await client.files.get(fileId);
 } catch (err) {
-if (err instanceof runtime.BoxApiError) {
-// err.status, err.code, err.boxMessage, err.requestId, err.body, err.cause
+  if (err instanceof runtime.BoxApiError) {
+    // err.status, err.code, err.boxMessage, err.requestId, err.body, err.cause
+  }
 }
+```
+
+## Etags: `If-None-Match` and `If-Match`
+
+Files and folders carry an `etag`. Send it back to stay in sync with Box
+(Box's [Ensure consistency](https://developer.box.com/guides/api-calls/ensure-consistency/)
+guide):
+
+- **Reads** — pass the stored etag as `if-none-match` on a file or folder
+  `get` (or a shared-item lookup). Box answers `304 Not Modified` when
+  nothing changed, and the SDK raises it as the error above with status
+  `304`: keep your cached copy.
+- **Writes** — pass it as `if-match` on a file or folder update or delete,
+  or a new file version upload. Box answers `412 Precondition Failed`
+  (code `precondition_failed`) when the item changed since you read it:
+  read it again, reapply your change, retry. `If-Match` can't block a move.
+
+```ts
+try {
+  await client.files.get(fileId, { 'if-none-match': etag });
+} catch (err) {
+  if (err instanceof runtime.BoxApiError && err.status === 304) {
+    // unchanged since etag
+  }
+}
+try {
+  await client.files.update(fileId, body, { 'if-match': etag });
+} catch (err) {
+  if (err instanceof runtime.BoxApiError && err.status === 412) {
+    // changed since etag: re-read and retry
+  }
 }
 ```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@unofficialbox/box-open-sdk",
-  "version": "0.6.0",
+  "version": "0.6.1",
   "description": "Box API client for TypeScript (open source, community, punk rock) — typed models, async managers, and a fetch runtime with retry, backoff, and token refresh.",
   "keywords": ["box", "box-api", "sdk", "api-client", "typescript", "unofficial"],
   "license": "MIT",