@unofficialbox/box-open-sdk 0.1.2 → 0.3.1

package/docs/managers/web_links.md

@@ -11,6 +11,12 @@ Reach these methods through the `webLinks` field on `Client`.
 
 **Returns:** `WebLink`
 
+**Example**
+
+```ts
+const result = await client.webLinks.create({ /* … */ });
+```
+
 ## get
 
 `GET /web_links/{web_link_id}`
@@ -22,6 +28,12 @@ Reach these methods through the `webLinks` field on `Client`.
 
 **Returns:** `WebLink`
 
+**Example**
+
+```ts
+const result = await client.webLinks.get("WEB_LINK_ID");
+```
+
 ## update
 
 `PUT /web_links/{web_link_id}`
@@ -34,6 +46,12 @@ Reach these methods through the `webLinks` field on `Client`.
 
 **Returns:** `WebLink`
 
+**Example**
+
+```ts
+const result = await client.webLinks.update("WEB_LINK_ID", { /* … */ });
+```
+
 ## delete_
 
 `DELETE /web_links/{web_link_id}`
@@ -44,3 +62,9 @@ Reach these methods through the `webLinks` field on `Client`.
 
 **Returns:** `void`
 
+**Example**
+
+```ts
+await client.webLinks.delete_("WEB_LINK_ID");
+```
+

package/docs/managers/webhooks.md

@@ -14,6 +14,14 @@ Reach these methods through the `webhooks` field on `Client`.
 
 **Returns:** `Webhooks`
 
+**Example**
+
+```ts
+for await (const item of client.webhooks.list()) {
+  // use item
+}
+```
+
 Paginated — `list(...)` is an async iterable that yields each entry across pages (`for await (const item of ...)`), threading the cursor for you. See the [pagination guide](../pagination.md).
 
 ## create
@@ -24,6 +32,12 @@ Paginated — `list(...)` is an async iterable that yields each entry across pag
 
 **Returns:** `Webhook`
 
+**Example**
+
+```ts
+const result = await client.webhooks.create({ /* … */ });
+```
+
 ## get
 
 `GET /webhooks/{webhook_id}`
@@ -34,6 +48,12 @@ Paginated — `list(...)` is an async iterable that yields each entry across pag
 
 **Returns:** `Webhook`
 
+**Example**
+
+```ts
+const result = await client.webhooks.get("WEBHOOK_ID");
+```
+
 ## update
 
 `PUT /webhooks/{webhook_id}`
@@ -46,6 +66,12 @@ Paginated — `list(...)` is an async iterable that yields each entry across pag
 
 **Returns:** `Webhook`
 
+**Example**
+
+```ts
+const result = await client.webhooks.update("WEBHOOK_ID", { /* … */ });
+```
+
 ## delete_
 
 `DELETE /webhooks/{webhook_id}`
@@ -56,3 +82,9 @@ Paginated — `list(...)` is an async iterable that yields each entry across pag
 
 **Returns:** `void`
 
+**Example**
+
+```ts
+await client.webhooks.delete_("WEBHOOK_ID");
+```
+

package/docs/managers/workflows.md

@@ -16,6 +16,14 @@ Reach these methods through the `workflows` field on `Client`.
 
 **Returns:** `Workflows`
 
+**Example**
+
+```ts
+for await (const item of client.workflows.list("FOLDER_ID")) {
+  // use item
+}
+```
+
 Paginated — `list(...)` is an async iterable that yields each entry across pages (`for await (const item of ...)`), threading the cursor for you. See the [pagination guide](../pagination.md).
 
 ## start
@@ -30,3 +38,9 @@ Paginated — `list(...)` is an async iterable that yields each entry across pag
 
 **Returns:** `void`
 
+**Example**
+
+```ts
+await client.workflows.start("WORKFLOW_ID", { /* … */ });
+```
+

package/docs/managers/zip_downloads.md

@@ -11,6 +11,12 @@ Reach these methods through the `zipDownloads` field on `Client`.
 
 **Returns:** `ZipDownload`
 
+**Example**
+
+```ts
+const result = await client.zipDownloads.create({ /* … */ });
+```
+
 ## getContent
 
 `GET /zip_downloads/{zip_download_id}/content`
@@ -21,6 +27,12 @@ Reach these methods through the `zipDownloads` field on `Client`.
 
 **Returns:** a binary stream (`runtime.Stream`)
 
+**Example**
+
+```ts
+const result = await client.zipDownloads.getContent("ZIP_DOWNLOAD_ID");
+```
+
 ## getStatus
 
 `GET /zip_downloads/{zip_download_id}/status`
@@ -31,3 +43,9 @@ Reach these methods through the `zipDownloads` field on `Client`.
 
 **Returns:** `ZipDownloadStatus`
 
+**Example**
+
+```ts
+const result = await client.zipDownloads.getStatus("ZIP_DOWNLOAD_ID");
+```
+

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "@unofficialbox/box-open-sdk",
-  "version": "0.1.2",
-  "description": "Community, unofficial Box API client for TypeScript — typed models, async managers, and a fetch runtime with retry, backoff, and token refresh.",
+  "version": "0.3.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",
-  "repository": { "type": "git", "url": "git+https://github.com/unofficialbox/box-open-ts-sdk.git" },
+  "repository": { "type": "git", "url": "git+https://github.com/unofficialbox/box-gantry.git" },
   "homepage": "https://github.com/unofficialbox/box-open-ts-sdk",
   "type": "module",
   "sideEffects": false,