@unofficialbox/box-open-sdk 0.1.2 → 0.3.1

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");
+```
+

package/docs/managers/file_metadata.md

@@ -14,6 +14,12 @@ Reach these methods through the `fileMetadata` field on `Client`.
 
 **Returns:** `Metadatas`
 
+**Example**
+
+```ts
+const result = await client.fileMetadata.listFileMetadata("FILE_ID");
+```
+
 ## getFileMetadata
 
 `GET /files/{file_id}/metadata/{scope}/{template_key}`
@@ -27,6 +33,12 @@ Reach these methods through the `fileMetadata` field on `Client`.
 
 **Returns:** `MetadataFull`
 
+**Example**
+
+```ts
+const result = await client.fileMetadata.getFileMetadata("FILE_ID", "...", "TEMPLATE_KEY");
+```
+
 ## updateFileMetadata
 
 `PUT /files/{file_id}/metadata/{scope}/{template_key}`
@@ -41,6 +53,12 @@ Reach these methods through the `fileMetadata` field on `Client`.
 
 **Returns:** `MetadataFull`
 
+**Example**
+
+```ts
+const result = await client.fileMetadata.updateFileMetadata("FILE_ID", "...", "TEMPLATE_KEY", []);
+```
+
 ## createFileMetadata
 
 `POST /files/{file_id}/metadata/{scope}/{template_key}`
@@ -55,6 +73,12 @@ Reach these methods through the `fileMetadata` field on `Client`.
 
 **Returns:** `MetadataFull`
 
+**Example**
+
+```ts
+const result = await client.fileMetadata.createFileMetadata("FILE_ID", "...", "TEMPLATE_KEY", { /* … */ });
+```
+
 ## deleteFileMetadata
 
 `DELETE /files/{file_id}/metadata/{scope}/{template_key}`
@@ -67,3 +91,9 @@ Reach these methods through the `fileMetadata` field on `Client`.
 
 **Returns:** `void`
 
+**Example**
+
+```ts
+await client.fileMetadata.deleteFileMetadata("FILE_ID", "...", "TEMPLATE_KEY");
+```
+

package/docs/managers/file_requests.md

@@ -13,6 +13,12 @@ Reach these methods through the `fileRequests` field on `Client`.
 
 **Returns:** `FileRequest`
 
+**Example**
+
+```ts
+const result = await client.fileRequests.get("FILE_REQUEST_ID");
+```
+
 ## update
 
 `PUT /file_requests/{file_request_id}`
@@ -26,6 +32,12 @@ Reach these methods through the `fileRequests` field on `Client`.
 
 **Returns:** `FileRequest`
 
+**Example**
+
+```ts
+const result = await client.fileRequests.update("FILE_REQUEST_ID", { /* … */ });
+```
+
 ## delete_
 
 `DELETE /file_requests/{file_request_id}`
@@ -36,6 +48,12 @@ Reach these methods through the `fileRequests` field on `Client`.
 
 **Returns:** `void`
 
+**Example**
+
+```ts
+await client.fileRequests.delete_("FILE_REQUEST_ID");
+```
+
 ## copy
 
 `POST /file_requests/{file_request_id}/copy`
@@ -48,3 +66,9 @@ Reach these methods through the `fileRequests` field on `Client`.
 
 **Returns:** `FileRequest`
 
+**Example**
+
+```ts
+const result = await client.fileRequests.copy("FILE_REQUEST_ID", { /* … */ });
+```
+

package/docs/managers/file_version_legal_holds.md

@@ -13,6 +13,12 @@ Reach these methods through the `fileVersionLegalHolds` field on `Client`.
 
 **Returns:** `FileVersionLegalHold`
 
+**Example**
+
+```ts
+const result = await client.fileVersionLegalHolds.get("FILE_VERSION_LEGAL_HOLD_ID");
+```
+
 ## list
 
 `GET /file_version_legal_holds`
@@ -25,5 +31,13 @@ Reach these methods through the `fileVersionLegalHolds` field on `Client`.
 
 **Returns:** `FileVersionLegalHolds`
 
+**Example**
+
+```ts
+for await (const item of client.fileVersionLegalHolds.list("POLICY_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).
 

package/docs/managers/file_version_retentions.md

@@ -20,6 +20,14 @@ Reach these methods through the `fileVersionRetentions` field on `Client`.
 
 **Returns:** `FileVersionRetentions`
 
+**Example**
+
+```ts
+for await (const item of client.fileVersionRetentions.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).
 
 ## get
@@ -32,3 +40,9 @@ Paginated — `list(...)` is an async iterable that yields each entry across pag
 
 **Returns:** `FileVersionRetention`
 
+**Example**
+
+```ts
+const result = await client.fileVersionRetentions.get("FILE_VERSION_RETENTION_ID");
+```
+

package/docs/managers/file_versions.md

@@ -16,6 +16,14 @@ Reach these methods through the `fileVersions` field on `Client`.
 
 **Returns:** `FileVersions`
 
+**Example**
+
+```ts
+for await (const item of client.fileVersions.listFileVersions("FILE_ID")) {
+  // use item
+}
+```
+
 Paginated — `listFileVersions(...)` 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).
 
 ## getFileVersion
@@ -30,6 +38,12 @@ Paginated — `listFileVersions(...)` is an async iterable that yields each entr
 
 **Returns:** `FileVersionFull`
 
+**Example**
+
+```ts
+const result = await client.fileVersions.getFileVersion("FILE_ID", "FILE_VERSION_ID");
+```
+
 ## updateFileVersion
 
 `PUT /files/{file_id}/versions/{file_version_id}`
@@ -43,6 +57,12 @@ Paginated — `listFileVersions(...)` is an async iterable that yields each entr
 
 **Returns:** `FileVersionFull`
 
+**Example**
+
+```ts
+const result = await client.fileVersions.updateFileVersion("FILE_ID", "FILE_VERSION_ID", { /* … */ });
+```
+
 ## deleteFileVersion
 
 `DELETE /files/{file_id}/versions/{file_version_id}`
@@ -55,6 +75,12 @@ Paginated — `listFileVersions(...)` is an async iterable that yields each entr
 
 **Returns:** `void`
 
+**Example**
+
+```ts
+await client.fileVersions.deleteFileVersion("FILE_ID", "FILE_VERSION_ID");
+```
+
 ## createFileVersionCurrent
 
 `POST /files/{file_id}/versions/current`
@@ -68,3 +94,9 @@ Paginated — `listFileVersions(...)` is an async iterable that yields each entr
 
 **Returns:** `FileVersionFull`
 
+**Example**
+
+```ts
+const result = await client.fileVersions.createFileVersionCurrent("FILE_ID", { /* … */ });
+```
+

package/docs/managers/file_watermarks.md

@@ -13,6 +13,12 @@ Reach these methods through the `fileWatermarks` field on `Client`.
 
 **Returns:** `Watermark`
 
+**Example**
+
+```ts
+const result = await client.fileWatermarks.getFileWatermark("FILE_ID");
+```
+
 ## updateFileWatermark
 
 `PUT /files/{file_id}/watermark`
@@ -25,6 +31,12 @@ Reach these methods through the `fileWatermarks` field on `Client`.
 
 **Returns:** `Watermark`
 
+**Example**
+
+```ts
+const result = await client.fileWatermarks.updateFileWatermark("FILE_ID", { /* … */ });
+```
+
 ## deleteFileWatermark
 
 `DELETE /files/{file_id}/watermark`
@@ -35,3 +47,9 @@ Reach these methods through the `fileWatermarks` field on `Client`.
 
 **Returns:** `void`
 
+**Example**
+
+```ts
+await client.fileWatermarks.deleteFileWatermark("FILE_ID");
+```
+

package/docs/managers/files.md

@@ -17,6 +17,12 @@ Reach these methods through the `files` field on `Client`.
 
 **Returns:** `FileFull`
 
+**Example**
+
+```ts
+const result = await client.files.get("FILE_ID");
+```
+
 ## update
 
 `PUT /files/{file_id}`
@@ -31,6 +37,12 @@ Reach these methods through the `files` field on `Client`.
 
 **Returns:** `FileFull`
 
+**Example**
+
+```ts
+const result = await client.files.update("FILE_ID", { /* … */ });
+```
+
 ## delete_
 
 `DELETE /files/{file_id}`
@@ -42,6 +54,12 @@ Reach these methods through the `files` field on `Client`.
 
 **Returns:** `void`
 
+**Example**
+
+```ts
+await client.files.delete_("FILE_ID");
+```
+
 ## copy
 
 `POST /files/{file_id}/copy`
@@ -55,6 +73,12 @@ Reach these methods through the `files` field on `Client`.
 
 **Returns:** `FileFull`
 
+**Example**
+
+```ts
+const result = await client.files.copy("FILE_ID", { /* … */ });
+```
+
 ## getThumbnail
 
 `GET /files/{file_id}/thumbnail.{extension}`
@@ -70,3 +94,9 @@ Reach these methods through the `files` field on `Client`.
 
 **Returns:** a binary stream (`runtime.Stream`)
 
+**Example**
+
+```ts
+const result = await client.files.getThumbnail("FILE_ID", "...");
+```
+

package/docs/managers/folder_classifications.md

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