@unofficialbox/box-open-sdk 0.1.2 → 0.2.0

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

package/docs/managers/folder_locks.md

@@ -13,6 +13,12 @@ Reach these methods through the `folderLocks` field on `Client`.
 
 **Returns:** `FolderLocks`
 
+**Example**
+
+```ts
+const result = await client.folderLocks.list("FOLDER_ID");
+```
+
 ## create
 
 `POST /folder_locks`
@@ -21,6 +27,12 @@ Reach these methods through the `folderLocks` field on `Client`.
 
 **Returns:** `FolderLock`
 
+**Example**
+
+```ts
+const result = await client.folderLocks.create({ /* … */ });
+```
+
 ## delete_
 
 `DELETE /folder_locks/{folder_lock_id}`
@@ -31,3 +43,9 @@ Reach these methods through the `folderLocks` field on `Client`.
 
 **Returns:** `void`
 
+**Example**
+
+```ts
+await client.folderLocks.delete_("FOLDER_LOCK_ID");
+```
+

package/docs/managers/folder_metadata.md

@@ -14,6 +14,12 @@ Reach these methods through the `folderMetadata` field on `Client`.
 
 **Returns:** `Metadatas`
 
+**Example**
+
+```ts
+const result = await client.folderMetadata.listFolderMetadata("FOLDER_ID");
+```
+
 ## getFolderMetadata
 
 `GET /folders/{folder_id}/metadata/{scope}/{template_key}`
@@ -26,6 +32,12 @@ Reach these methods through the `folderMetadata` field on `Client`.
 
 **Returns:** `MetadataFull`
 
+**Example**
+
+```ts
+const result = await client.folderMetadata.getFolderMetadata("FOLDER_ID", "...", "TEMPLATE_KEY");
+```
+
 ## updateFolderMetadata
 
 `PUT /folders/{folder_id}/metadata/{scope}/{template_key}`
@@ -40,6 +52,12 @@ Reach these methods through the `folderMetadata` field on `Client`.
 
 **Returns:** `MetadataFull`
 
+**Example**
+
+```ts
+const result = await client.folderMetadata.updateFolderMetadata("FOLDER_ID", "...", "TEMPLATE_KEY", []);
+```
+
 ## createFolderMetadata
 
 `POST /folders/{folder_id}/metadata/{scope}/{template_key}`
@@ -54,6 +72,12 @@ Reach these methods through the `folderMetadata` field on `Client`.
 
 **Returns:** `MetadataFull`
 
+**Example**
+
+```ts
+const result = await client.folderMetadata.createFolderMetadata("FOLDER_ID", "...", "TEMPLATE_KEY", { /* … */ });
+```
+
 ## deleteFolderMetadata
 
 `DELETE /folders/{folder_id}/metadata/{scope}/{template_key}`
@@ -66,3 +90,9 @@ Reach these methods through the `folderMetadata` field on `Client`.
 
 **Returns:** `void`
 
+**Example**
+
+```ts
+await client.folderMetadata.deleteFolderMetadata("FOLDER_ID", "...", "TEMPLATE_KEY");
+```
+

package/docs/managers/folder_watermarks.md

@@ -13,6 +13,12 @@ Reach these methods through the `folderWatermarks` field on `Client`.
 
 **Returns:** `Watermark`
 
+**Example**
+
+```ts
+const result = await client.folderWatermarks.getFolderWatermark("FOLDER_ID");
+```
+
 ## updateFolderWatermark
 
 `PUT /folders/{folder_id}/watermark`
@@ -25,6 +31,12 @@ Reach these methods through the `folderWatermarks` field on `Client`.
 
 **Returns:** `Watermark`
 
+**Example**
+
+```ts
+const result = await client.folderWatermarks.updateFolderWatermark("FOLDER_ID", { /* … */ });
+```
+
 ## deleteFolderWatermark
 
 `DELETE /folders/{folder_id}/watermark`
@@ -35,3 +47,9 @@ Reach these methods through the `folderWatermarks` field on `Client`.
 
 **Returns:** `void`
 
+**Example**
+
+```ts
+await client.folderWatermarks.deleteFolderWatermark("FOLDER_ID");
+```
+

package/docs/managers/folders.md

@@ -20,6 +20,12 @@ Reach these methods through the `folders` field on `Client`.
 
 **Returns:** `FolderFull`
 
+**Example**
+
+```ts
+const result = await client.folders.get("FOLDER_ID");
+```
+
 ## update
 
 `PUT /folders/{folder_id}`
@@ -34,6 +40,12 @@ Reach these methods through the `folders` field on `Client`.
 
 **Returns:** `FolderFull`
 
+**Example**
+
+```ts
+const result = await client.folders.update("FOLDER_ID", { /* … */ });
+```
+
 ## delete_
 
 `DELETE /folders/{folder_id}`
@@ -46,6 +58,12 @@ Reach these methods through the `folders` field on `Client`.
 
 **Returns:** `void`
 
+**Example**
+
+```ts
+await client.folders.delete_("FOLDER_ID");
+```
+
 ## listItems
 
 `GET /folders/{folder_id}/items`
@@ -64,6 +82,14 @@ Reach these methods through the `folders` field on `Client`.
 
 **Returns:** `Items`
 
+**Example**
+
+```ts
+for await (const item of client.folders.listItems("FOLDER_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).
 
 ## create
@@ -78,6 +104,12 @@ Paginated — `listItems(...)` is an async iterable that yields each entry acros
 
 **Returns:** `FolderFull`
 
+**Example**
+
+```ts
+const result = await client.folders.create({ /* … */ });
+```
+
 ## copy
 
 `POST /folders/{folder_id}/copy`
@@ -91,3 +123,9 @@ Paginated — `listItems(...)` is an async iterable that yields each entry acros
 
 **Returns:** `FolderFull`
 
+**Example**
+
+```ts
+const result = await client.folders.copy("FOLDER_ID", { /* … */ });
+```
+

package/docs/managers/groups.md

@@ -16,6 +16,14 @@ Reach these methods through the `groups` field on `Client`.
 
 **Returns:** `Groups`
 
+**Example**
+
+```ts
+for await (const item of client.groups.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
@@ -30,6 +38,12 @@ Paginated — `list(...)` is an async iterable that yields each entry across pag
 
 **Returns:** `GroupFull`
 
+**Example**
+
+```ts
+const result = await client.groups.create({ /* … */ });
+```
+
 ## get
 
 `GET /groups/{group_id}`
@@ -41,6 +55,12 @@ Paginated — `list(...)` is an async iterable that yields each entry across pag
 
 **Returns:** `GroupFull`
 
+**Example**
+
+```ts
+const result = await client.groups.get("GROUP_ID");
+```
+
 ## update
 
 `PUT /groups/{group_id}`
@@ -54,6 +74,12 @@ Paginated — `list(...)` is an async iterable that yields each entry across pag
 
 **Returns:** `GroupFull`
 
+**Example**
+
+```ts
+const result = await client.groups.update("GROUP_ID", { /* … */ });
+```
+
 ## delete_
 
 `DELETE /groups/{group_id}`
@@ -64,3 +90,9 @@ Paginated — `list(...)` is an async iterable that yields each entry across pag
 
 **Returns:** `void`
 
+**Example**
+
+```ts
+await client.groups.delete_("GROUP_ID");
+```
+

package/docs/managers/hub_collaborations.md

@@ -15,6 +15,14 @@ Reach these methods through the `hubCollaborations` field on `Client`.
 
 **Returns:** `HubCollaborations`
 
+**Example**
+
+```ts
+for await (const item of client.hubCollaborations.list("HUB_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).
 
 ## create
@@ -25,6 +33,12 @@ Paginated — `list(...)` is an async iterable that yields each entry across pag
 
 **Returns:** `HubCollaboration`
 
+**Example**
+
+```ts
+const result = await client.hubCollaborations.create({ /* … */ });
+```
+
 ## get
 
 `GET /hub_collaborations/{hub_collaboration_id}`
@@ -35,6 +49,12 @@ Paginated — `list(...)` is an async iterable that yields each entry across pag
 
 **Returns:** `HubCollaboration`
 
+**Example**
+
+```ts
+const result = await client.hubCollaborations.get("HUB_COLLABORATION_ID");
+```
+
 ## update
 
 `PUT /hub_collaborations/{hub_collaboration_id}`
@@ -47,6 +67,12 @@ Paginated — `list(...)` is an async iterable that yields each entry across pag
 
 **Returns:** `HubCollaboration`
 
+**Example**
+
+```ts
+const result = await client.hubCollaborations.update("HUB_COLLABORATION_ID", { /* … */ });
+```
+
 ## delete_
 
 `DELETE /hub_collaborations/{hub_collaboration_id}`
@@ -57,3 +83,9 @@ Paginated — `list(...)` is an async iterable that yields each entry across pag
 
 **Returns:** `void`
 
+**Example**
+
+```ts
+await client.hubCollaborations.delete_("HUB_COLLABORATION_ID");
+```
+