@unofficialbox/box-open-sdk 0.1.2 → 0.2.0

package/docs/managers/chunked_uploads.md

@@ -11,6 +11,12 @@ Reach these methods through the `chunkedUploads` field on `Client`.
 
 **Returns:** `UploadSession`
 
+**Example**
+
+```ts
+const result = await client.chunkedUploads.createFileUploadSessions({ /* … */ });
+```
+
 ## createFileByIdUploadSessions
 
 `POST /files/{file_id}/upload_sessions`
@@ -23,6 +29,12 @@ Reach these methods through the `chunkedUploads` field on `Client`.
 
 **Returns:** `UploadSession`
 
+**Example**
+
+```ts
+const result = await client.chunkedUploads.createFileByIdUploadSessions("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({ /* … */ });
+```
+

package/docs/managers/device_pinners.md

@@ -13,6 +13,12 @@ Reach these methods through the `devicePinners` field on `Client`.
 
 **Returns:** `DevicePinner`
 
+**Example**
+
+```ts
+const result = await client.devicePinners.get("DEVICE_PINNER_ID");
+```
+
 ## delete_
 
 `DELETE /device_pinners/{device_pinner_id}`
@@ -23,6 +29,12 @@ Reach these methods through the `devicePinners` field on `Client`.
 
 **Returns:** `void`
 
+**Example**
+
+```ts
+await client.devicePinners.delete_("DEVICE_PINNER_ID");
+```
+
 ## listEnterprise
 
 `GET /enterprises/{enterprise_id}/device_pinners`
@@ -36,5 +48,13 @@ Reach these methods through the `devicePinners` field on `Client`.
 
 **Returns:** `DevicePinners`
 
+**Example**
+
+```ts
+for await (const item of client.devicePinners.listEnterprise("ENTERPRISE_ID")) {
+  // use item
+}
+```
+
 Paginated — `listEnterprise(...)` 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/docgen.md

@@ -13,6 +13,12 @@ Reach these methods through the `docgen` field on `Client`.
 
 **Returns:** `DocGenJob`
 
+**Example**
+
+```ts
+const result = await client.docgen.getJob("JOB_ID");
+```
+
 ## listJobs
 
 `GET /docgen_jobs`
@@ -24,6 +30,14 @@ Reach these methods through the `docgen` field on `Client`.
 
 **Returns:** `DocGenJobsFull`
 
+**Example**
+
+```ts
+for await (const item of client.docgen.listJobs()) {
+  // use item
+}
+```
+
 Paginated — `listJobs(...)` 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).
 
 ## listBatchJob
@@ -38,6 +52,14 @@ Paginated — `listJobs(...)` is an async iterable that yields each entry across
 
 **Returns:** `DocGenJobs`
 
+**Example**
+
+```ts
+for await (const item of client.docgen.listBatchJob("BATCH_ID")) {
+  // use item
+}
+```
+
 Paginated — `listBatchJob(...)` 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).
 
 ## createBatches
@@ -48,3 +70,9 @@ Paginated — `listBatchJob(...)` is an async iterable that yields each entry ac
 
 **Returns:** `DocGenBatchBase`
 
+**Example**
+
+```ts
+const result = await client.docgen.createBatches({ /* … */ });
+```
+

package/docs/managers/docgen_template.md

@@ -14,6 +14,14 @@ Reach these methods through the `docgenTemplate` field on `Client`.
 
 **Returns:** `DocGenTemplates`
 
+**Example**
+
+```ts
+for await (const item of client.docgenTemplate.listDocgenTemplates()) {
+  // use item
+}
+```
+
 Paginated — `listDocgenTemplates(...)` 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).
 
 ## createDocgenTemplates
@@ -24,6 +32,12 @@ Paginated — `listDocgenTemplates(...)` is an async iterable that yields each e
 
 **Returns:** `DocGenTemplateBase`
 
+**Example**
+
+```ts
+const result = await client.docgenTemplate.createDocgenTemplates({ /* … */ });
+```
+
 ## getDocgenTemplate
 
 `GET /docgen_templates/{template_id}`
@@ -34,6 +48,12 @@ Paginated — `listDocgenTemplates(...)` is an async iterable that yields each e
 
 **Returns:** `DocGenTemplate`
 
+**Example**
+
+```ts
+const result = await client.docgenTemplate.getDocgenTemplate("TEMPLATE_ID");
+```
+
 ## deleteDocgenTemplate
 
 `DELETE /docgen_templates/{template_id}`
@@ -44,6 +64,12 @@ Paginated — `listDocgenTemplates(...)` is an async iterable that yields each e
 
 **Returns:** `void`
 
+**Example**
+
+```ts
+await client.docgenTemplate.deleteDocgenTemplate("TEMPLATE_ID");
+```
+
 ## listDocgenTemplateTags
 
 `GET /docgen_templates/{template_id}/tags`
@@ -57,6 +83,14 @@ Paginated — `listDocgenTemplates(...)` is an async iterable that yields each e
 
 **Returns:** `DocGenTags`
 
+**Example**
+
+```ts
+for await (const item of client.docgenTemplate.listDocgenTemplateTags("TEMPLATE_ID")) {
+  // use item
+}
+```
+
 Paginated — `listDocgenTemplateTags(...)` 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).
 
 ## listJob
@@ -71,5 +105,13 @@ Paginated — `listDocgenTemplateTags(...)` is an async iterable that yields eac
 
 **Returns:** `DocGenJobs`
 
+**Example**
+
+```ts
+for await (const item of client.docgenTemplate.listJob("TEMPLATE_ID")) {
+  // use item
+}
+```
+
 Paginated — `listJob(...)` 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/downloads.md

@@ -17,3 +17,9 @@ Reach these methods through the `downloads` field on `Client`.
 
 **Returns:** a binary stream (`runtime.Stream`)
 
+**Example**
+
+```ts
+const result = await client.downloads.getFileContent("FILE_ID");
+```
+

package/docs/managers/email_aliases.md

@@ -13,6 +13,12 @@ Reach these methods through the `emailAliases` field on `Client`.
 
 **Returns:** `EmailAliases`
 
+**Example**
+
+```ts
+const result = await client.emailAliases.listUser("USER_ID");
+```
+
 ## createUser
 
 `POST /users/{user_id}/email_aliases`
@@ -25,6 +31,12 @@ Reach these methods through the `emailAliases` field on `Client`.
 
 **Returns:** `EmailAlias`
 
+**Example**
+
+```ts
+const result = await client.emailAliases.createUser("USER_ID", { /* … */ });
+```
+
 ## deleteUser
 
 `DELETE /users/{user_id}/email_aliases/{email_alias_id}`
@@ -36,3 +48,9 @@ Reach these methods through the `emailAliases` field on `Client`.
 
 **Returns:** `void`
 
+**Example**
+
+```ts
+await client.emailAliases.deleteUser("USER_ID", "EMAIL_ALIAS_ID");
+```
+

package/docs/managers/enterprise_configurations.md

@@ -14,3 +14,9 @@ Reach these methods through the `enterpriseConfigurations` field on `Client`.
 
 **Returns:** `EnterpriseConfiguration`
 
+**Example**
+
+```ts
+const result = await client.enterpriseConfigurations.get("ENTERPRISE_ID", []);
+```
+

package/docs/managers/events.md

@@ -18,9 +18,21 @@ Reach these methods through the `events` field on `Client`.
 
 **Returns:** `Events`
 
+**Example**
+
+```ts
+const result = await client.events.list();
+```
+
 ## options
 
 `OPTIONS /events`
 
 **Returns:** `RealtimeServers`
 
+**Example**
+
+```ts
+const result = await client.events.options();
+```
+

package/docs/managers/external_users.md

@@ -11,3 +11,9 @@ Reach these methods through the `externalUsers` field on `Client`.
 
 **Returns:** `ExternalUsersSubmitDeleteJobResponse`
 
+**Example**
+
+```ts
+const result = await client.externalUsers.createSubmitDeleteJob({ /* … */ });
+```
+

package/docs/managers/file_classifications.md

@@ -13,6 +13,12 @@ Reach these methods through the `fileClassifications` field on `Client`.
 
 **Returns:** `Classification`
 
+**Example**
+
+```ts
+const result = await client.fileClassifications.get("FILE_ID");
+```
+
 ## update
 
 `PUT /files/{file_id}/metadata/enterprise/securityClassification-6VMVochwUWo`
@@ -25,6 +31,12 @@ Reach these methods through the `fileClassifications` field on `Client`.
 
 **Returns:** `Classification`
 
+**Example**
+
+```ts
+const result = await client.fileClassifications.update("FILE_ID", []);
+```
+
 ## create
 
 `POST /files/{file_id}/metadata/enterprise/securityClassification-6VMVochwUWo`
@@ -37,6 +49,12 @@ Reach these methods through the `fileClassifications` field on `Client`.
 
 **Returns:** `Classification`
 
+**Example**
+
+```ts
+const result = await client.fileClassifications.create("FILE_ID", { /* … */ });
+```
+
 ## delete_
 
 `DELETE /files/{file_id}/metadata/enterprise/securityClassification-6VMVochwUWo`
@@ -47,3 +65,9 @@ Reach these methods through the `fileClassifications` field on `Client`.
 
 **Returns:** `void`
 
+**Example**
+
+```ts
+await client.fileClassifications.delete_("FILE_ID");
+```
+