@unofficialbox/box-open-sdk 0.1.0 → 0.2.0

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

package/docs/managers/legal_hold_policy_assignments.md

@@ -18,6 +18,14 @@ Reach these methods through the `legalHoldPolicyAssignments` field on `Client`.
 
 **Returns:** `LegalHoldPolicyAssignments`
 
+**Example**
+
+```ts
+for await (const item of client.legalHoldPolicyAssignments.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).
 
 ## create
@@ -28,6 +36,12 @@ Paginated — `list(...)` is an async iterable that yields each entry across pag
 
 **Returns:** `LegalHoldPolicyAssignment`
 
+**Example**
+
+```ts
+const result = await client.legalHoldPolicyAssignments.create({ /* … */ });
+```
+
 ## get
 
 `GET /legal_hold_policy_assignments/{legal_hold_policy_assignment_id}`
@@ -38,6 +52,12 @@ Paginated — `list(...)` is an async iterable that yields each entry across pag
 
 **Returns:** `LegalHoldPolicyAssignment`
 
+**Example**
+
+```ts
+const result = await client.legalHoldPolicyAssignments.get("LEGAL_HOLD_POLICY_ASSIGNMENT_ID");
+```
+
 ## delete_
 
 `DELETE /legal_hold_policy_assignments/{legal_hold_policy_assignment_id}`
@@ -48,6 +68,12 @@ Paginated — `list(...)` is an async iterable that yields each entry across pag
 
 **Returns:** `void`
 
+**Example**
+
+```ts
+await client.legalHoldPolicyAssignments.delete_("LEGAL_HOLD_POLICY_ASSIGNMENT_ID");
+```
+
 ## listFileOnHold
 
 `GET /legal_hold_policy_assignments/{legal_hold_policy_assignment_id}/files_on_hold`
@@ -61,6 +87,14 @@ Paginated — `list(...)` is an async iterable that yields each entry across pag
 
 **Returns:** `FilesOnHold`
 
+**Example**
+
+```ts
+for await (const item of client.legalHoldPolicyAssignments.listFileOnHold("LEGAL_HOLD_POLICY_ASSIGNMENT_ID")) {
+  // use item
+}
+```
+
 Paginated — `listFileOnHold(...)` 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).
 
 ## listFileVersionOnHold
@@ -76,5 +110,13 @@ Paginated — `listFileOnHold(...)` is an async iterable that yields each entry
 
 **Returns:** `FileVersionsOnHold`
 
+**Example**
+
+```ts
+for await (const item of client.legalHoldPolicyAssignments.listFileVersionOnHold("LEGAL_HOLD_POLICY_ASSIGNMENT_ID")) {
+  // use item
+}
+```
+
 Paginated — `listFileVersionOnHold(...)` 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/list_collaborations.md

@@ -16,6 +16,14 @@ Reach these methods through the `listCollaborations` field on `Client`.
 
 **Returns:** `Collaborations`
 
+**Example**
+
+```ts
+for await (const item of client.listCollaborations.listFileCollaborations("FILE_ID")) {
+  // use item
+}
+```
+
 Paginated — `listFileCollaborations(...)` 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).
 
 ## listFolderCollaborations
@@ -31,6 +39,14 @@ Paginated — `listFileCollaborations(...)` is an async iterable that yields eac
 
 **Returns:** `Collaborations`
 
+**Example**
+
+```ts
+for await (const item of client.listCollaborations.listFolderCollaborations("FOLDER_ID")) {
+  // use item
+}
+```
+
 Paginated — `listFolderCollaborations(...)` 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).
 
 ## listCollaborations
@@ -46,6 +62,14 @@ Paginated — `listFolderCollaborations(...)` is an async iterable that yields e
 
 **Returns:** `CollaborationsOffsetPaginated`
 
+**Example**
+
+```ts
+for await (const item of client.listCollaborations.listCollaborations("...")) {
+  // use item
+}
+```
+
 Paginated — `listCollaborations(...)` 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).
 
 ## listGroupCollaborations
@@ -60,5 +84,13 @@ Paginated — `listCollaborations(...)` is an async iterable that yields each en
 
 **Returns:** `CollaborationsOffsetPaginated`
 
+**Example**
+
+```ts
+for await (const item of client.listCollaborations.listGroupCollaborations("GROUP_ID")) {
+  // use item
+}
+```
+
 Paginated — `listGroupCollaborations(...)` 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/memberships.md

@@ -15,6 +15,14 @@ Reach these methods through the `memberships` field on `Client`.
 
 **Returns:** `GroupMemberships`
 
+**Example**
+
+```ts
+for await (const item of client.memberships.listUser("USER_ID")) {
+  // use item
+}
+```
+
 Paginated — `listUser(...)` 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).
 
 ## listGroup
@@ -29,6 +37,14 @@ Paginated — `listUser(...)` is an async iterable that yields each entry across
 
 **Returns:** `GroupMemberships`
 
+**Example**
+
+```ts
+for await (const item of client.memberships.listGroup("GROUP_ID")) {
+  // use item
+}
+```
+
 Paginated — `listGroup(...)` 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).
 
 ## createGroup
@@ -43,6 +59,12 @@ Paginated — `listGroup(...)` is an async iterable that yields each entry acros
 
 **Returns:** `GroupMembership`
 
+**Example**
+
+```ts
+const result = await client.memberships.createGroup({ /* … */ });
+```
+
 ## getGroup
 
 `GET /group_memberships/{group_membership_id}`
@@ -54,6 +76,12 @@ Paginated — `listGroup(...)` is an async iterable that yields each entry acros
 
 **Returns:** `GroupMembership`
 
+**Example**
+
+```ts
+const result = await client.memberships.getGroup("GROUP_MEMBERSHIP_ID");
+```
+
 ## updateGroup
 
 `PUT /group_memberships/{group_membership_id}`
@@ -67,6 +95,12 @@ Paginated — `listGroup(...)` is an async iterable that yields each entry acros
 
 **Returns:** `GroupMembership`
 
+**Example**
+
+```ts
+const result = await client.memberships.updateGroup("GROUP_MEMBERSHIP_ID", { /* … */ });
+```
+
 ## deleteGroup
 
 `DELETE /group_memberships/{group_membership_id}`
@@ -77,3 +111,9 @@ Paginated — `listGroup(...)` is an async iterable that yields each entry acros
 
 **Returns:** `void`
 
+**Example**
+
+```ts
+await client.memberships.deleteGroup("GROUP_MEMBERSHIP_ID");
+```
+

package/docs/managers/metadata_cascade_policies.md

@@ -16,6 +16,14 @@ Reach these methods through the `metadataCascadePolicies` field on `Client`.
 
 **Returns:** `MetadataCascadePolicies`
 
+**Example**
+
+```ts
+for await (const item of client.metadataCascadePolicies.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).
 
 ## create
@@ -26,6 +34,12 @@ Paginated — `list(...)` is an async iterable that yields each entry across pag
 
 **Returns:** `MetadataCascadePolicy`
 
+**Example**
+
+```ts
+const result = await client.metadataCascadePolicies.create({ /* … */ });
+```
+
 ## get
 
 `GET /metadata_cascade_policies/{metadata_cascade_policy_id}`
@@ -36,6 +50,12 @@ Paginated — `list(...)` is an async iterable that yields each entry across pag
 
 **Returns:** `MetadataCascadePolicy`
 
+**Example**
+
+```ts
+const result = await client.metadataCascadePolicies.get("METADATA_CASCADE_POLICY_ID");
+```
+
 ## delete_
 
 `DELETE /metadata_cascade_policies/{metadata_cascade_policy_id}`
@@ -46,6 +66,12 @@ Paginated — `list(...)` is an async iterable that yields each entry across pag
 
 **Returns:** `void`
 
+**Example**
+
+```ts
+await client.metadataCascadePolicies.delete_("METADATA_CASCADE_POLICY_ID");
+```
+
 ## apply
 
 `POST /metadata_cascade_policies/{metadata_cascade_policy_id}/apply`
@@ -58,3 +84,9 @@ Paginated — `list(...)` is an async iterable that yields each entry across pag
 
 **Returns:** `void`
 
+**Example**
+
+```ts
+await client.metadataCascadePolicies.apply("METADATA_CASCADE_POLICY_ID", { /* … */ });
+```
+