@unofficialbox/box-open-sdk 0.1.2 → 0.3.1

package/docs/errors.md

@@ -9,11 +9,11 @@ when the failure came with a response, and the underlying `cause` for
 transport or decode failures:
 
 ```ts
-import { BoxApiError } from 'box-gantry-runtime';
+import { runtime } from '@unofficialbox/box-open-sdk';
 try {
 await client.files.getFileById(fileId);
 } catch (err) {
-if (err instanceof BoxApiError) {
+if (err instanceof runtime.BoxApiError) {
 // err.status (number | undefined), err.cause
 }
 }

package/docs/managers/ai.md

@@ -11,6 +11,12 @@ Reach these methods through the `ai` field on `Client`.
 
 **Returns:** `AiResponseFull`
 
+**Example**
+
+```ts
+const result = await client.ai.ask({ /* … */ });
+```
+
 ## createTextGen
 
 `POST /ai/text_gen`
@@ -19,6 +25,12 @@ Reach these methods through the `ai` field on `Client`.
 
 **Returns:** `AiResponse`
 
+**Example**
+
+```ts
+const result = await client.ai.createTextGen({ /* … */ });
+```
+
 ## getAgentDefault
 
 `GET /ai_agent_default`
@@ -31,6 +43,12 @@ Reach these methods through the `ai` field on `Client`.
 
 **Returns:** `AiAgent`
 
+**Example**
+
+```ts
+const result = await client.ai.getAgentDefault("...");
+```
+
 ## extract
 
 `POST /ai/extract`
@@ -39,6 +57,12 @@ Reach these methods through the `ai` field on `Client`.
 
 **Returns:** `AiResponse`
 
+**Example**
+
+```ts
+const result = await client.ai.extract({ /* … */ });
+```
+
 ## createExtractStructured
 
 `POST /ai/extract_structured`
@@ -47,3 +71,9 @@ Reach these methods through the `ai` field on `Client`.
 
 **Returns:** `AiExtractStructuredResponse`
 
+**Example**
+
+```ts
+const result = await client.ai.createExtractStructured({ /* … */ });
+```
+

package/docs/managers/ai_studio.md

@@ -18,6 +18,14 @@ Reach these methods through the `aiStudio` field on `Client`.
 
 **Returns:** `AiMultipleAgentResponse`
 
+**Example**
+
+```ts
+for await (const item of client.aiStudio.listAiAgents()) {
+  // use item
+}
+```
+
 Paginated — `listAiAgents(...)` 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).
 
 ## createAiAgents
@@ -28,6 +36,12 @@ Paginated — `listAiAgents(...)` is an async iterable that yields each entry ac
 
 **Returns:** `AiSingleAgentResponseFull`
 
+**Example**
+
+```ts
+const result = await client.aiStudio.createAiAgents({ /* … */ });
+```
+
 ## getAiAgent
 
 `GET /ai_agents/{agent_id}`
@@ -39,6 +53,12 @@ Paginated — `listAiAgents(...)` is an async iterable that yields each entry ac
 
 **Returns:** `AiSingleAgentResponseFull`
 
+**Example**
+
+```ts
+const result = await client.aiStudio.getAiAgent("AGENT_ID");
+```
+
 ## updateAiAgent
 
 `PUT /ai_agents/{agent_id}`
@@ -51,6 +71,12 @@ Paginated — `listAiAgents(...)` is an async iterable that yields each entry ac
 
 **Returns:** `AiSingleAgentResponseFull`
 
+**Example**
+
+```ts
+const result = await client.aiStudio.updateAiAgent("AGENT_ID", { /* … */ });
+```
+
 ## deleteAiAgent
 
 `DELETE /ai_agents/{agent_id}`
@@ -61,3 +87,9 @@ Paginated — `listAiAgents(...)` is an async iterable that yields each entry ac
 
 **Returns:** `void`
 
+**Example**
+
+```ts
+await client.aiStudio.deleteAiAgent("AGENT_ID");
+```
+

package/docs/managers/app_item_associations.md

@@ -16,6 +16,14 @@ Reach these methods through the `appItemAssociations` field on `Client`.
 
 **Returns:** `AppItemAssociations`
 
+**Example**
+
+```ts
+for await (const item of client.appItemAssociations.listFile("FILE_ID")) {
+  // use item
+}
+```
+
 Paginated — `listFile(...)` 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).
 
 ## listFolder
@@ -31,5 +39,13 @@ Paginated — `listFile(...)` is an async iterable that yields each entry across
 
 **Returns:** `AppItemAssociations`
 
+**Example**
+
+```ts
+for await (const item of client.appItemAssociations.listFolder("FOLDER_ID")) {
+  // use item
+}
+```
+
 Paginated — `listFolder(...)` 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/archives.md

@@ -14,6 +14,14 @@ Reach these methods through the `archives` field on `Client`.
 
 **Returns:** `Archives`
 
+**Example**
+
+```ts
+for await (const item of client.archives.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:** `Archive`
 
+**Example**
+
+```ts
+const result = await client.archives.create({ /* … */ });
+```
+
 ## update
 
 `PUT /archives/{archive_id}`
@@ -36,6 +50,12 @@ Paginated — `list(...)` is an async iterable that yields each entry across pag
 
 **Returns:** `Archive`
 
+**Example**
+
+```ts
+const result = await client.archives.update("ARCHIVE_ID", { /* … */ });
+```
+
 ## delete_
 
 `DELETE /archives/{archive_id}`
@@ -46,3 +66,9 @@ Paginated — `list(...)` is an async iterable that yields each entry across pag
 
 **Returns:** `void`
 
+**Example**
+
+```ts
+await client.archives.delete_("ARCHIVE_ID");
+```
+

package/docs/managers/authorization.md

@@ -17,6 +17,12 @@ Reach these methods through the `authorization` field on `Client`.
 
 **Returns:** text (`string`)
 
+**Example**
+
+```ts
+const result = await client.authorization.authorize("...", "CLIENT_ID");
+```
+
 ## createOauth2Token
 
 `POST /oauth2/token`
@@ -25,6 +31,12 @@ Reach these methods through the `authorization` field on `Client`.
 
 **Returns:** `AccessToken`
 
+**Example**
+
+```ts
+const result = await client.authorization.createOauth2Token({ /* … */ });
+```
+
 ## createOauth2TokenRefresh
 
 `POST /oauth2/token`
@@ -33,6 +45,12 @@ Reach these methods through the `authorization` field on `Client`.
 
 **Returns:** `AccessToken`
 
+**Example**
+
+```ts
+const result = await client.authorization.createOauth2TokenRefresh({ /* … */ });
+```
+
 ## revokeOauth2
 
 `POST /oauth2/revoke`
@@ -41,3 +59,9 @@ Reach these methods through the `authorization` field on `Client`.
 
 **Returns:** `void`
 
+**Example**
+
+```ts
+await client.authorization.revokeOauth2({ /* … */ });
+```
+

package/docs/managers/automate_workflows.md

@@ -15,6 +15,14 @@ Reach these methods through the `automateWorkflows` field on `Client`.
 
 **Returns:** `AutomateWorkflows`
 
+**Example**
+
+```ts
+for await (const item of client.automateWorkflows.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
@@ -29,3 +37,9 @@ Paginated — `list(...)` is an async iterable that yields each entry across pag
 
 **Returns:** `void`
 
+**Example**
+
+```ts
+await client.automateWorkflows.start("WORKFLOW_ID", { /* … */ });
+```
+

package/docs/managers/avatars.md

@@ -13,6 +13,12 @@ Reach these methods through the `avatars` field on `Client`.
 
 **Returns:** a binary stream (`runtime.Stream`)
 
+**Example**
+
+```ts
+const result = await client.avatars.getUserAvatar("USER_ID");
+```
+
 ## createUserAvatar
 
 `POST /users/{user_id}/avatar`
@@ -25,6 +31,12 @@ Reach these methods through the `avatars` field on `Client`.
 
 **Returns:** `UserAvatar`
 
+**Example**
+
+```ts
+const result = await client.avatars.createUserAvatar("USER_ID", { /* … */ });
+```
+
 ## deleteUserAvatar
 
 `DELETE /users/{user_id}/avatar`
@@ -35,3 +47,9 @@ Reach these methods through the `avatars` field on `Client`.
 
 **Returns:** `void`
 
+**Example**
+
+```ts
+await client.avatars.deleteUserAvatar("USER_ID");
+```
+

package/docs/managers/chunked_uploads.md

@@ -3,15 +3,21 @@
 
 Reach these methods through the `chunkedUploads` field on `Client`.
 
-## createFileUploadSessions
+## createFileUploadSession
 
 `POST /files/upload_sessions`
 
-**Request body** (`application/json`): `FileUploadSessionsCreateRequest`
+**Request body** (`application/json`): `FileUploadSessionCreateRequest`
 
 **Returns:** `UploadSession`
 
-## createFileByIdUploadSessions
+**Example**
+
+```ts
+const result = await client.chunkedUploads.createFileUploadSession({ /* … */ });
+```
+
+## createFileVersionUploadSession
 
 `POST /files/{file_id}/upload_sessions`
 
@@ -19,10 +25,16 @@ Reach these methods through the `chunkedUploads` field on `Client`.
 |---|---|---|---|
 | `file_id` | path | `string` | yes |
 
-**Request body** (`application/json`): `FileIdUploadSessionsCreateRequest`
+**Request body** (`application/json`): `FileVersionUploadSessionCreateRequest`
 
 **Returns:** `UploadSession`
 
+**Example**
+
+```ts
+const result = await client.chunkedUploads.createFileVersionUploadSession("FILE_ID", { /* … */ });
+```
+
 ## getFileUploadSession
 
 `GET /files/upload_sessions/{upload_session_id}`
@@ -33,6 +45,12 @@ Reach these methods through the `chunkedUploads` field on `Client`.
 
 **Returns:** `UploadSession`
 
+**Example**
+
+```ts
+const result = await client.chunkedUploads.getFileUploadSession("UPLOAD_SESSION_ID");
+```
+
 ## updateFileUploadSession
 
 `PUT /files/upload_sessions/{upload_session_id}`
@@ -47,6 +65,12 @@ Reach these methods through the `chunkedUploads` field on `Client`.
 
 **Returns:** `UploadedPart`
 
+**Example**
+
+```ts
+const result = await client.chunkedUploads.updateFileUploadSession("UPLOAD_SESSION_ID", "DIGEST", "CONTENT-RANGE", { /* … */ });
+```
+
 ## deleteFileUploadSession
 
 `DELETE /files/upload_sessions/{upload_session_id}`
@@ -57,6 +81,12 @@ Reach these methods through the `chunkedUploads` field on `Client`.
 
 **Returns:** `void`
 
+**Example**
+
+```ts
+await client.chunkedUploads.deleteFileUploadSession("UPLOAD_SESSION_ID");
+```
+
 ## listFileUploadSessionParts
 
 `GET /files/upload_sessions/{upload_session_id}/parts`
@@ -69,6 +99,14 @@ Reach these methods through the `chunkedUploads` field on `Client`.
 
 **Returns:** `UploadParts`
 
+**Example**
+
+```ts
+for await (const item of client.chunkedUploads.listFileUploadSessionParts("UPLOAD_SESSION_ID")) {
+  // use item
+}
+```
+
 Paginated — `listFileUploadSessionParts(...)` 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).
 
 ## commitFileUploadSession
@@ -86,3 +124,9 @@ Paginated — `listFileUploadSessionParts(...)` is an async iterable that yields
 
 **Returns:** `Files`
 
+**Example**
+
+```ts
+const result = await client.chunkedUploads.commitFileUploadSession("UPLOAD_SESSION_ID", "DIGEST", { /* … */ });
+```
+

package/docs/managers/classifications.md

@@ -9,6 +9,12 @@ Reach these methods through the `classifications` field on `Client`.
 
 **Returns:** `ClassificationTemplate`
 
+**Example**
+
+```ts
+const result = await client.classifications.get();
+```
+
 ## updateAdd
 
 `PUT /metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema`
@@ -17,6 +23,12 @@ Reach these methods through the `classifications` field on `Client`.
 
 **Returns:** `ClassificationTemplate`
 
+**Example**
+
+```ts
+const result = await client.classifications.updateAdd([]);
+```
+
 ## updateUpdate
 
 `PUT /metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema`
@@ -25,6 +37,12 @@ Reach these methods through the `classifications` field on `Client`.
 
 **Returns:** `ClassificationTemplate`
 
+**Example**
+
+```ts
+const result = await client.classifications.updateUpdate([]);
+```
+
 ## createMetadataTemplateSchemaClassifications
 
 `POST /metadata_templates/schema`
@@ -33,3 +51,9 @@ Reach these methods through the `classifications` field on `Client`.
 
 **Returns:** `ClassificationTemplate`
 
+**Example**
+
+```ts
+const result = await client.classifications.createMetadataTemplateSchemaClassifications({ /* … */ });
+```
+

package/docs/managers/collaboration_allowlist_entries.md

@@ -14,6 +14,14 @@ Reach these methods through the `collaborationAllowlistEntries` field on `Client
 
 **Returns:** `CollaborationAllowlistEntries`
 
+**Example**
+
+```ts
+for await (const item of client.collaborationAllowlistEntries.listCollaborationWhitelistEntries()) {
+  // use item
+}
+```
+
 Paginated — `listCollaborationWhitelistEntries(...)` 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).
 
 ## createCollaborationWhitelistEntries
@@ -24,6 +32,12 @@ Paginated — `listCollaborationWhitelistEntries(...)` is an async iterable that
 
 **Returns:** `CollaborationAllowlistEntry`
 
+**Example**
+
+```ts
+const result = await client.collaborationAllowlistEntries.createCollaborationWhitelistEntries({ /* … */ });
+```
+
 ## getCollaborationWhitelistEntry
 
 `GET /collaboration_whitelist_entries/{collaboration_whitelist_entry_id}`
@@ -34,6 +48,12 @@ Paginated — `listCollaborationWhitelistEntries(...)` is an async iterable that
 
 **Returns:** `CollaborationAllowlistEntry`
 
+**Example**
+
+```ts
+const result = await client.collaborationAllowlistEntries.getCollaborationWhitelistEntry("COLLABORATION_WHITELIST_ENTRY_ID");
+```
+
 ## deleteCollaborationWhitelistEntry
 
 `DELETE /collaboration_whitelist_entries/{collaboration_whitelist_entry_id}`
@@ -44,3 +64,9 @@ Paginated — `listCollaborationWhitelistEntries(...)` is an async iterable that
 
 **Returns:** `void`
 
+**Example**
+
+```ts
+await client.collaborationAllowlistEntries.deleteCollaborationWhitelistEntry("COLLABORATION_WHITELIST_ENTRY_ID");
+```
+

package/docs/managers/collaboration_allowlist_exempt_targets.md

@@ -14,6 +14,14 @@ Reach these methods through the `collaborationAllowlistExemptTargets` field on `
 
 **Returns:** `CollaborationAllowlistExemptTargets`
 
+**Example**
+
+```ts
+for await (const item of client.collaborationAllowlistExemptTargets.listCollaborationWhitelistExemptTargets()) {
+  // use item
+}
+```
+
 Paginated — `listCollaborationWhitelistExemptTargets(...)` 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).
 
 ## createCollaborationWhitelistExemptTargets
@@ -24,6 +32,12 @@ Paginated — `listCollaborationWhitelistExemptTargets(...)` is an async iterabl
 
 **Returns:** `CollaborationAllowlistExemptTarget`
 
+**Example**
+
+```ts
+const result = await client.collaborationAllowlistExemptTargets.createCollaborationWhitelistExemptTargets({ /* … */ });
+```
+
 ## getCollaborationWhitelistExemptTarget
 
 `GET /collaboration_whitelist_exempt_targets/{collaboration_whitelist_exempt_target_id}`
@@ -34,6 +48,12 @@ Paginated — `listCollaborationWhitelistExemptTargets(...)` is an async iterabl
 
 **Returns:** `CollaborationAllowlistExemptTarget`
 
+**Example**
+
+```ts
+const result = await client.collaborationAllowlistExemptTargets.getCollaborationWhitelistExemptTarget("COLLABORATION_WHITELIST_EXEMPT_TARGET_ID");
+```
+
 ## deleteCollaborationWhitelistExemptTarget
 
 `DELETE /collaboration_whitelist_exempt_targets/{collaboration_whitelist_exempt_target_id}`
@@ -44,3 +64,9 @@ Paginated — `listCollaborationWhitelistExemptTargets(...)` is an async iterabl
 
 **Returns:** `void`
 
+**Example**
+
+```ts
+await client.collaborationAllowlistExemptTargets.deleteCollaborationWhitelistExemptTarget("COLLABORATION_WHITELIST_EXEMPT_TARGET_ID");
+```
+

package/docs/managers/collections.md

@@ -15,6 +15,14 @@ Reach these methods through the `collections` field on `Client`.
 
 **Returns:** `Collections`
 
+**Example**
+
+```ts
+for await (const item of client.collections.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).
 
 ## listItems
@@ -30,6 +38,14 @@ Paginated — `list(...)` is an async iterable that yields each entry across pag
 
 **Returns:** `ItemsOffsetPaginated`
 
+**Example**
+
+```ts
+for await (const item of client.collections.listItems("COLLECTION_ID")) {
+  // use item
+}
+```
+
 Paginated — `listItems(...)` 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).
 
 ## get
@@ -42,3 +58,9 @@ Paginated — `listItems(...)` is an async iterable that yields each entry acros
 
 **Returns:** `Collection`
 
+**Example**
+
+```ts
+const result = await client.collections.get("COLLECTION_ID");
+```
+

package/docs/managers/comments.md

@@ -16,6 +16,14 @@ Reach these methods through the `comments` field on `Client`.
 
 **Returns:** `Comments`
 
+**Example**
+
+```ts
+for await (const item of client.comments.listFile("FILE_ID")) {
+  // use item
+}
+```
+
 Paginated — `listFile(...)` 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).
 
 ## get
@@ -29,6 +37,12 @@ Paginated — `listFile(...)` is an async iterable that yields each entry across
 
 **Returns:** `CommentFull`
 
+**Example**
+
+```ts
+const result = await client.comments.get("COMMENT_ID");
+```
+
 ## update
 
 `PUT /comments/{comment_id}`
@@ -42,6 +56,12 @@ Paginated — `listFile(...)` is an async iterable that yields each entry across
 
 **Returns:** `CommentFull`
 
+**Example**
+
+```ts
+const result = await client.comments.update("COMMENT_ID", { /* … */ });
+```
+
 ## delete_
 
 `DELETE /comments/{comment_id}`
@@ -52,6 +72,12 @@ Paginated — `listFile(...)` is an async iterable that yields each entry across
 
 **Returns:** `void`
 
+**Example**
+
+```ts
+await client.comments.delete_("COMMENT_ID");
+```
+
 ## create
 
 `POST /comments`
@@ -64,3 +90,9 @@ Paginated — `listFile(...)` is an async iterable that yields each entry across
 
 **Returns:** `CommentFull`
 
+**Example**
+
+```ts
+const result = await client.comments.create({ /* … */ });
+```
+