@unofficialbox/box-open-sdk 0.1.2 → 0.3.1

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

package/docs/managers/hub_document.md

@@ -15,6 +15,14 @@ Reach these methods through the `hubDocument` field on `Client`.
 
 **Returns:** `HubDocumentPages`
 
+**Example**
+
+```ts
+for await (const item of client.hubDocument.listPages("HUB_ID")) {
+  // use item
+}
+```
+
 Paginated — `listPages(...)` 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).
 
 ## listBlocks
@@ -30,5 +38,13 @@ Paginated — `listPages(...)` is an async iterable that yields each entry acros
 
 **Returns:** `HubDocumentBlocks`
 
+**Example**
+
+```ts
+for await (const item of client.hubDocument.listBlocks("HUB_ID", "PAGE_ID")) {
+  // use item
+}
+```
+
 Paginated — `listBlocks(...)` 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/hub_items.md

@@ -16,6 +16,14 @@ Reach these methods through the `hubItems` field on `Client`.
 
 **Returns:** `HubItems`
 
+**Example**
+
+```ts
+for await (const item of client.hubItems.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).
 
 ## createHubManageItems
@@ -30,3 +38,9 @@ Paginated — `list(...)` is an async iterable that yields each entry across pag
 
 **Returns:** `HubItemsManageResponse`
 
+**Example**
+
+```ts
+const result = await client.hubItems.createHubManageItems("HUB_ID", { /* … */ });
+```
+

package/docs/managers/hubs.md

@@ -18,6 +18,14 @@ Reach these methods through the `hubs` field on `Client`.
 
 **Returns:** `Hubs`
 
+**Example**
+
+```ts
+for await (const item of client.hubs.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
@@ -28,6 +36,12 @@ Paginated — `list(...)` is an async iterable that yields each entry across pag
 
 **Returns:** `Hub`
 
+**Example**
+
+```ts
+const result = await client.hubs.create({ /* … */ });
+```
+
 ## listEnterprise
 
 `GET /enterprise_hubs`
@@ -42,6 +56,14 @@ Paginated — `list(...)` is an async iterable that yields each entry across pag
 
 **Returns:** `Hubs`
 
+**Example**
+
+```ts
+for await (const item of client.hubs.listEnterprise()) {
+  // 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).
 
 ## get
@@ -54,6 +76,12 @@ Paginated — `listEnterprise(...)` is an async iterable that yields each entry
 
 **Returns:** `Hub`
 
+**Example**
+
+```ts
+const result = await client.hubs.get("HUB_ID");
+```
+
 ## update
 
 `PUT /hubs/{hub_id}`
@@ -66,6 +94,12 @@ Paginated — `listEnterprise(...)` is an async iterable that yields each entry
 
 **Returns:** `Hub`
 
+**Example**
+
+```ts
+const result = await client.hubs.update("HUB_ID", { /* … */ });
+```
+
 ## delete_
 
 `DELETE /hubs/{hub_id}`
@@ -76,6 +110,12 @@ Paginated — `listEnterprise(...)` is an async iterable that yields each entry
 
 **Returns:** `void`
 
+**Example**
+
+```ts
+await client.hubs.delete_("HUB_ID");
+```
+
 ## copy
 
 `POST /hubs/{hub_id}/copy`
@@ -88,3 +128,9 @@ Paginated — `listEnterprise(...)` is an async iterable that yields each entry
 
 **Returns:** `Hub`
 
+**Example**
+
+```ts
+const result = await client.hubs.copy("HUB_ID", { /* … */ });
+```
+

package/docs/managers/integration_mappings.md

@@ -19,6 +19,14 @@ Reach these methods through the `integrationMappings` field on `Client`.
 
 **Returns:** `IntegrationMappings`
 
+**Example**
+
+```ts
+for await (const item of client.integrationMappings.listSlack()) {
+  // use item
+}
+```
+
 Paginated — `listSlack(...)` 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).
 
 ## createSlack
@@ -29,6 +37,12 @@ Paginated — `listSlack(...)` is an async iterable that yields each entry acros
 
 **Returns:** `IntegrationMapping`
 
+**Example**
+
+```ts
+const result = await client.integrationMappings.createSlack({ /* … */ });
+```
+
 ## updateSlack
 
 `PUT /integration_mappings/slack/{integration_mapping_id}`
@@ -41,6 +55,12 @@ Paginated — `listSlack(...)` is an async iterable that yields each entry acros
 
 **Returns:** `IntegrationMapping`
 
+**Example**
+
+```ts
+const result = await client.integrationMappings.updateSlack("INTEGRATION_MAPPING_ID", { /* … */ });
+```
+
 ## deleteSlack
 
 `DELETE /integration_mappings/slack/{integration_mapping_id}`
@@ -51,6 +71,12 @@ Paginated — `listSlack(...)` is an async iterable that yields each entry acros
 
 **Returns:** `void`
 
+**Example**
+
+```ts
+await client.integrationMappings.deleteSlack("INTEGRATION_MAPPING_ID");
+```
+
 ## listTeams
 
 `GET /integration_mappings/teams`
@@ -64,6 +90,12 @@ Paginated — `listSlack(...)` is an async iterable that yields each entry acros
 
 **Returns:** `IntegrationMappingsTeams`
 
+**Example**
+
+```ts
+const result = await client.integrationMappings.listTeams();
+```
+
 ## createTeams
 
 `POST /integration_mappings/teams`
@@ -72,6 +104,12 @@ Paginated — `listSlack(...)` is an async iterable that yields each entry acros
 
 **Returns:** `IntegrationMappingTeams`
 
+**Example**
+
+```ts
+const result = await client.integrationMappings.createTeams({ /* … */ });
+```
+
 ## updateTeam
 
 `PUT /integration_mappings/teams/{integration_mapping_id}`
@@ -84,6 +122,12 @@ Paginated — `listSlack(...)` is an async iterable that yields each entry acros
 
 **Returns:** `IntegrationMappingTeams`
 
+**Example**
+
+```ts
+const result = await client.integrationMappings.updateTeam("INTEGRATION_MAPPING_ID", { /* … */ });
+```
+
 ## deleteTeam
 
 `DELETE /integration_mappings/teams/{integration_mapping_id}`
@@ -94,3 +138,9 @@ Paginated — `listSlack(...)` is an async iterable that yields each entry acros
 
 **Returns:** `void`
 
+**Example**
+
+```ts
+await client.integrationMappings.deleteTeam("INTEGRATION_MAPPING_ID");
+```
+

package/docs/managers/invites.md

@@ -15,6 +15,12 @@ Reach these methods through the `invites` field on `Client`.
 
 **Returns:** `Invite`
 
+**Example**
+
+```ts
+const result = await client.invites.create({ /* … */ });
+```
+
 ## get
 
 `GET /invites/{invite_id}`
@@ -26,3 +32,9 @@ Reach these methods through the `invites` field on `Client`.
 
 **Returns:** `Invite`
 
+**Example**
+
+```ts
+const result = await client.invites.get("INVITE_ID");
+```
+

package/docs/managers/legal_hold_policies.md

@@ -16,6 +16,14 @@ Reach these methods through the `legalHoldPolicies` field on `Client`.
 
 **Returns:** `LegalHoldPolicies`
 
+**Example**
+
+```ts
+for await (const item of client.legalHoldPolicies.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
@@ -26,6 +34,12 @@ Paginated — `list(...)` is an async iterable that yields each entry across pag
 
 **Returns:** `LegalHoldPolicy`
 
+**Example**
+
+```ts
+const result = await client.legalHoldPolicies.create({ /* … */ });
+```
+
 ## get
 
 `GET /legal_hold_policies/{legal_hold_policy_id}`
@@ -36,6 +50,12 @@ Paginated — `list(...)` is an async iterable that yields each entry across pag
 
 **Returns:** `LegalHoldPolicy`
 
+**Example**
+
+```ts
+const result = await client.legalHoldPolicies.get("LEGAL_HOLD_POLICY_ID");
+```
+
 ## update
 
 `PUT /legal_hold_policies/{legal_hold_policy_id}`
@@ -48,6 +68,12 @@ Paginated — `list(...)` is an async iterable that yields each entry across pag
 
 **Returns:** `LegalHoldPolicy`
 
+**Example**
+
+```ts
+const result = await client.legalHoldPolicies.update("LEGAL_HOLD_POLICY_ID", { /* … */ });
+```
+
 ## delete_
 
 `DELETE /legal_hold_policies/{legal_hold_policy_id}`
@@ -58,3 +84,9 @@ Paginated — `list(...)` is an async iterable that yields each entry across pag
 
 **Returns:** `void`
 
+**Example**
+
+```ts
+await client.legalHoldPolicies.delete_("LEGAL_HOLD_POLICY_ID");
+```
+