@unofficialbox/box-open-sdk 0.1.0 → 0.2.0

package/docs/managers/tasks.md

@@ -13,6 +13,12 @@ Reach these methods through the `tasks` field on `Client`.
 
 **Returns:** `Tasks`
 
+**Example**
+
+```ts
+const result = await client.tasks.listFile("FILE_ID");
+```
+
 ## create
 
 `POST /tasks`
@@ -21,6 +27,12 @@ Reach these methods through the `tasks` field on `Client`.
 
 **Returns:** `Task`
 
+**Example**
+
+```ts
+const result = await client.tasks.create({ /* … */ });
+```
+
 ## get
 
 `GET /tasks/{task_id}`
@@ -31,6 +43,12 @@ Reach these methods through the `tasks` field on `Client`.
 
 **Returns:** `Task`
 
+**Example**
+
+```ts
+const result = await client.tasks.get("TASK_ID");
+```
+
 ## update
 
 `PUT /tasks/{task_id}`
@@ -43,6 +61,12 @@ Reach these methods through the `tasks` field on `Client`.
 
 **Returns:** `Task`
 
+**Example**
+
+```ts
+const result = await client.tasks.update("TASK_ID", { /* … */ });
+```
+
 ## delete_
 
 `DELETE /tasks/{task_id}`
@@ -53,3 +77,9 @@ Reach these methods through the `tasks` field on `Client`.
 
 **Returns:** `void`
 
+**Example**
+
+```ts
+await client.tasks.delete_("TASK_ID");
+```
+

package/docs/managers/terms_of_service_user_statuses.md

@@ -14,6 +14,12 @@ Reach these methods through the `termsOfServiceUserStatuses` field on `Client`.
 
 **Returns:** `TermsOfServiceUserStatuses`
 
+**Example**
+
+```ts
+const result = await client.termsOfServiceUserStatuses.list("TOS_ID");
+```
+
 ## create
 
 `POST /terms_of_service_user_statuses`
@@ -22,6 +28,12 @@ Reach these methods through the `termsOfServiceUserStatuses` field on `Client`.
 
 **Returns:** `TermsOfServiceUserStatus`
 
+**Example**
+
+```ts
+const result = await client.termsOfServiceUserStatuses.create({ /* … */ });
+```
+
 ## update
 
 `PUT /terms_of_service_user_statuses/{terms_of_service_user_status_id}`
@@ -34,3 +46,9 @@ Reach these methods through the `termsOfServiceUserStatuses` field on `Client`.
 
 **Returns:** `TermsOfServiceUserStatus`
 
+**Example**
+
+```ts
+const result = await client.termsOfServiceUserStatuses.update("TERMS_OF_SERVICE_USER_STATUS_ID", { /* … */ });
+```
+

package/docs/managers/terms_of_services.md

@@ -13,6 +13,12 @@ Reach these methods through the `termsOfServices` field on `Client`.
 
 **Returns:** `TermsOfServices`
 
+**Example**
+
+```ts
+const result = await client.termsOfServices.list();
+```
+
 ## create
 
 `POST /terms_of_services`
@@ -21,6 +27,12 @@ Reach these methods through the `termsOfServices` field on `Client`.
 
 **Returns:** `TermsOfService`
 
+**Example**
+
+```ts
+const result = await client.termsOfServices.create({ /* … */ });
+```
+
 ## get
 
 `GET /terms_of_services/{terms_of_service_id}`
@@ -31,6 +43,12 @@ Reach these methods through the `termsOfServices` field on `Client`.
 
 **Returns:** `TermsOfService`
 
+**Example**
+
+```ts
+const result = await client.termsOfServices.get("TERMS_OF_SERVICE_ID");
+```
+
 ## update
 
 `PUT /terms_of_services/{terms_of_service_id}`
@@ -43,3 +61,9 @@ Reach these methods through the `termsOfServices` field on `Client`.
 
 **Returns:** `TermsOfService`
 
+**Example**
+
+```ts
+const result = await client.termsOfServices.update("TERMS_OF_SERVICE_ID", { /* … */ });
+```
+

package/docs/managers/transfer.md

@@ -3,7 +3,7 @@
 
 Reach these methods through the `transfer` field on `Client`.
 
-## updateUserFolder0
+## transferFolders
 
 `PUT /users/{user_id}/folders/0`
 
@@ -17,3 +17,9 @@ Reach these methods through the `transfer` field on `Client`.
 
 **Returns:** `FolderFull`
 
+**Example**
+
+```ts
+const result = await client.transfer.transferFolders("USER_ID", { /* … */ });
+```
+

package/docs/managers/trashed_files.md

@@ -16,6 +16,12 @@ Reach these methods through the `trashedFiles` field on `Client`.
 
 **Returns:** `TrashFileRestored`
 
+**Example**
+
+```ts
+const result = await client.trashedFiles.createFile("FILE_ID", { /* … */ });
+```
+
 ## getFileTrash
 
 `GET /files/{file_id}/trash`
@@ -27,6 +33,12 @@ Reach these methods through the `trashedFiles` field on `Client`.
 
 **Returns:** `TrashFile`
 
+**Example**
+
+```ts
+const result = await client.trashedFiles.getFileTrash("FILE_ID");
+```
+
 ## deleteFileTrash
 
 `DELETE /files/{file_id}/trash`
@@ -37,3 +49,9 @@ Reach these methods through the `trashedFiles` field on `Client`.
 
 **Returns:** `void`
 
+**Example**
+
+```ts
+await client.trashedFiles.deleteFileTrash("FILE_ID");
+```
+

package/docs/managers/trashed_folders.md

@@ -16,6 +16,12 @@ Reach these methods through the `trashedFolders` field on `Client`.
 
 **Returns:** `TrashFolderRestored`
 
+**Example**
+
+```ts
+const result = await client.trashedFolders.createFolder("FOLDER_ID", { /* … */ });
+```
+
 ## getFolderTrash
 
 `GET /folders/{folder_id}/trash`
@@ -27,6 +33,12 @@ Reach these methods through the `trashedFolders` field on `Client`.
 
 **Returns:** `TrashFolder`
 
+**Example**
+
+```ts
+const result = await client.trashedFolders.getFolderTrash("FOLDER_ID");
+```
+
 ## deleteFolderTrash
 
 `DELETE /folders/{folder_id}/trash`
@@ -37,3 +49,9 @@ Reach these methods through the `trashedFolders` field on `Client`.
 
 **Returns:** `void`
 
+**Example**
+
+```ts
+await client.trashedFolders.deleteFolderTrash("FOLDER_ID");
+```
+

package/docs/managers/trashed_items.md

@@ -19,5 +19,13 @@ Reach these methods through the `trashedItems` field on `Client`.
 
 **Returns:** `Items`
 
+**Example**
+
+```ts
+for await (const item of client.trashedItems.listFolderTrashItems()) {
+  // use item
+}
+```
+
 Paginated — `listFolderTrashItems(...)` 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).
 

package/docs/managers/trashed_web_links.md

@@ -16,6 +16,12 @@ Reach these methods through the `trashedWebLinks` field on `Client`.
 
 **Returns:** `TrashWebLinkRestored`
 
+**Example**
+
+```ts
+const result = await client.trashedWebLinks.createWebLink("WEB_LINK_ID", { /* … */ });
+```
+
 ## getWebLinkTrash
 
 `GET /web_links/{web_link_id}/trash`
@@ -27,6 +33,12 @@ Reach these methods through the `trashedWebLinks` field on `Client`.
 
 **Returns:** `TrashWebLink`
 
+**Example**
+
+```ts
+const result = await client.trashedWebLinks.getWebLinkTrash("WEB_LINK_ID");
+```
+
 ## deleteWebLinkTrash
 
 `DELETE /web_links/{web_link_id}/trash`
@@ -37,3 +49,9 @@ Reach these methods through the `trashedWebLinks` field on `Client`.
 
 **Returns:** `void`
 
+**Example**
+
+```ts
+await client.trashedWebLinks.deleteWebLinkTrash("WEB_LINK_ID");
+```
+

package/docs/managers/uploads.md

@@ -3,7 +3,7 @@
 
 Reach these methods through the `uploads` field on `Client`.
 
-## createFileContent
+## uploadFileVersion
 
 `POST /files/{file_id}/content`
 
@@ -18,7 +18,13 @@ Reach these methods through the `uploads` field on `Client`.
 
 **Returns:** `Files`
 
-## createFileContent2
+**Example**
+
+```ts
+const result = await client.uploads.uploadFileVersion("FILE_ID", { /* … */ });
+```
+
+## uploadFile
 
 `POST /files/content`
 
@@ -31,6 +37,12 @@ Reach these methods through the `uploads` field on `Client`.
 
 **Returns:** `Files`
 
+**Example**
+
+```ts
+const result = await client.uploads.uploadFile({ /* … */ });
+```
+
 ## optionFileContent
 
 `OPTIONS /files/content`
@@ -39,3 +51,9 @@ Reach these methods through the `uploads` field on `Client`.
 
 **Returns:** `UploadUrl`
 
+**Example**
+
+```ts
+const result = await client.uploads.optionFileContent({ /* … */ });
+```
+

package/docs/managers/user_collaborations.md

@@ -14,6 +14,12 @@ Reach these methods through the `userCollaborations` field on `Client`.
 
 **Returns:** `Collaboration`
 
+**Example**
+
+```ts
+const result = await client.userCollaborations.getCollaboration("COLLABORATION_ID");
+```
+
 ## updateCollaboration
 
 `PUT /collaborations/{collaboration_id}`
@@ -26,6 +32,12 @@ Reach these methods through the `userCollaborations` field on `Client`.
 
 **Returns:** `Collaboration`
 
+**Example**
+
+```ts
+const result = await client.userCollaborations.updateCollaboration("COLLABORATION_ID", { /* … */ });
+```
+
 ## deleteCollaboration
 
 `DELETE /collaborations/{collaboration_id}`
@@ -36,6 +48,12 @@ Reach these methods through the `userCollaborations` field on `Client`.
 
 **Returns:** `void`
 
+**Example**
+
+```ts
+await client.userCollaborations.deleteCollaboration("COLLABORATION_ID");
+```
+
 ## createCollaborations
 
 `POST /collaborations`
@@ -49,3 +67,9 @@ Reach these methods through the `userCollaborations` field on `Client`.
 
 **Returns:** `Collaboration`
 
+**Example**
+
+```ts
+const result = await client.userCollaborations.createCollaborations({ /* … */ });
+```
+

package/docs/managers/users.md

@@ -20,6 +20,14 @@ Reach these methods through the `users` field on `Client`.
 
 **Returns:** `Users`
 
+**Example**
+
+```ts
+for await (const item of client.users.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
@@ -34,6 +42,12 @@ Paginated — `list(...)` is an async iterable that yields each entry across pag
 
 **Returns:** `UserFull`
 
+**Example**
+
+```ts
+const result = await client.users.create({ /* … */ });
+```
+
 ## getMe
 
 `GET /users/me`
@@ -44,6 +58,12 @@ Paginated — `list(...)` is an async iterable that yields each entry across pag
 
 **Returns:** `UserFull`
 
+**Example**
+
+```ts
+const result = await client.users.getMe();
+```
+
 ## get
 
 `GET /users/{user_id}`
@@ -55,6 +75,12 @@ Paginated — `list(...)` is an async iterable that yields each entry across pag
 
 **Returns:** `UserFull`
 
+**Example**
+
+```ts
+const result = await client.users.get("USER_ID");
+```
+
 ## update
 
 `PUT /users/{user_id}`
@@ -68,6 +94,12 @@ Paginated — `list(...)` is an async iterable that yields each entry across pag
 
 **Returns:** `UserFull`
 
+**Example**
+
+```ts
+const result = await client.users.update("USER_ID", { /* … */ });
+```
+
 ## delete_
 
 `DELETE /users/{user_id}`
@@ -80,3 +112,9 @@ Paginated — `list(...)` is an async iterable that yields each entry across pag
 
 **Returns:** `void`
 
+**Example**
+
+```ts
+await client.users.delete_("USER_ID");
+```
+

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,7 +1,8 @@
 {
   "name": "@unofficialbox/box-open-sdk",
-  "version": "0.1.0",
-  "description": "Generated TypeScript SDK for the Box API (community, unofficial).",
+  "version": "0.2.0",
+  "description": "Community, unofficial Box API client for TypeScript — 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" },
   "homepage": "https://github.com/unofficialbox/box-open-ts-sdk",