@unofficialbox/box-open-sdk 0.1.2 → 0.3.1

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", { /* … */ });
+```
+

package/docs/managers/metadata_taxonomies.md

@@ -11,6 +11,12 @@ Reach these methods through the `metadataTaxonomies` field on `Client`.
 
 **Returns:** `MetadataTaxonomy`
 
+**Example**
+
+```ts
+const result = await client.metadataTaxonomies.create({ /* … */ });
+```
+
 ## list
 
 `GET /metadata_taxonomies/{namespace}`
@@ -23,6 +29,14 @@ Reach these methods through the `metadataTaxonomies` field on `Client`.
 
 **Returns:** `MetadataTaxonomies`
 
+**Example**
+
+```ts
+for await (const item of client.metadataTaxonomies.list("NAMESPACE")) {
+  // 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
@@ -36,6 +50,12 @@ Paginated — `list(...)` is an async iterable that yields each entry across pag
 
 **Returns:** `MetadataTaxonomy`
 
+**Example**
+
+```ts
+const result = await client.metadataTaxonomies.get("NAMESPACE", "TAXONOMY_KEY");
+```
+
 ## delete_
 
 `DELETE /metadata_taxonomies/{namespace}/{taxonomy_key}`
@@ -47,6 +67,12 @@ Paginated — `list(...)` is an async iterable that yields each entry across pag
 
 **Returns:** `void`
 
+**Example**
+
+```ts
+await client.metadataTaxonomies.delete_("NAMESPACE", "TAXONOMY_KEY");
+```
+
 ## update
 
 `PATCH /metadata_taxonomies/{namespace}/{taxonomy_key}`
@@ -60,6 +86,12 @@ Paginated — `list(...)` is an async iterable that yields each entry across pag
 
 **Returns:** `MetadataTaxonomy`
 
+**Example**
+
+```ts
+const result = await client.metadataTaxonomies.update("NAMESPACE", "TAXONOMY_KEY", { /* … */ });
+```
+
 ## createLevels
 
 `POST /metadata_taxonomies/{namespace}/{taxonomy_key}/levels`
@@ -73,6 +105,12 @@ Paginated — `list(...)` is an async iterable that yields each entry across pag
 
 **Returns:** `MetadataTaxonomyLevels`
 
+**Example**
+
+```ts
+const result = await client.metadataTaxonomies.createLevels("NAMESPACE", "TAXONOMY_KEY", []);
+```
+
 ## updateLevel
 
 `PATCH /metadata_taxonomies/{namespace}/{taxonomy_key}/levels/{level_index}`
@@ -87,6 +125,12 @@ Paginated — `list(...)` is an async iterable that yields each entry across pag
 
 **Returns:** `MetadataTaxonomyLevel`
 
+**Example**
+
+```ts
+const result = await client.metadataTaxonomies.updateLevel("NAMESPACE", "TAXONOMY_KEY", 0, { /* … */ });
+```
+
 ## appendLevels
 
 `POST /metadata_taxonomies/{namespace}/{taxonomy_key}/levels:append`
@@ -100,6 +144,12 @@ Paginated — `list(...)` is an async iterable that yields each entry across pag
 
 **Returns:** `MetadataTaxonomyLevels`
 
+**Example**
+
+```ts
+const result = await client.metadataTaxonomies.appendLevels("NAMESPACE", "TAXONOMY_KEY", { /* … */ });
+```
+
 ## trimLevels
 
 `POST /metadata_taxonomies/{namespace}/{taxonomy_key}/levels:trim`
@@ -111,6 +161,12 @@ Paginated — `list(...)` is an async iterable that yields each entry across pag
 
 **Returns:** `MetadataTaxonomyLevels`
 
+**Example**
+
+```ts
+const result = await client.metadataTaxonomies.trimLevels("NAMESPACE", "TAXONOMY_KEY");
+```
+
 ## listNodes
 
 `GET /metadata_taxonomies/{namespace}/{taxonomy_key}/nodes`
@@ -129,6 +185,14 @@ Paginated — `list(...)` is an async iterable that yields each entry across pag
 
 **Returns:** `MetadataTaxonomyNodes`
 
+**Example**
+
+```ts
+for await (const item of client.metadataTaxonomies.listNodes("NAMESPACE", "TAXONOMY_KEY")) {
+  // use item
+}
+```
+
 Paginated — `listNodes(...)` 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).
 
 ## createNodes
@@ -144,6 +208,12 @@ Paginated — `listNodes(...)` is an async iterable that yields each entry acros
 
 **Returns:** `MetadataTaxonomyNode`
 
+**Example**
+
+```ts
+const result = await client.metadataTaxonomies.createNodes("NAMESPACE", "TAXONOMY_KEY", { /* … */ });
+```
+
 ## getNode
 
 `GET /metadata_taxonomies/{namespace}/{taxonomy_key}/nodes/{node_id}`
@@ -156,6 +226,12 @@ Paginated — `listNodes(...)` is an async iterable that yields each entry acros
 
 **Returns:** `MetadataTaxonomyNode`
 
+**Example**
+
+```ts
+const result = await client.metadataTaxonomies.getNode("NAMESPACE", "TAXONOMY_KEY", "NODE_ID");
+```
+
 ## deleteNode
 
 `DELETE /metadata_taxonomies/{namespace}/{taxonomy_key}/nodes/{node_id}`
@@ -168,6 +244,12 @@ Paginated — `listNodes(...)` is an async iterable that yields each entry acros
 
 **Returns:** `void`
 
+**Example**
+
+```ts
+await client.metadataTaxonomies.deleteNode("NAMESPACE", "TAXONOMY_KEY", "NODE_ID");
+```
+
 ## updateNode
 
 `PATCH /metadata_taxonomies/{namespace}/{taxonomy_key}/nodes/{node_id}`
@@ -182,6 +264,12 @@ Paginated — `listNodes(...)` is an async iterable that yields each entry acros
 
 **Returns:** `MetadataTaxonomyNode`
 
+**Example**
+
+```ts
+const result = await client.metadataTaxonomies.updateNode("NAMESPACE", "TAXONOMY_KEY", "NODE_ID", { /* … */ });
+```
+
 ## listMetadataTemplateFieldOptions
 
 `GET /metadata_templates/{namespace}/{template_key}/fields/{field_key}/options`
@@ -202,5 +290,13 @@ Paginated — `listNodes(...)` is an async iterable that yields each entry acros
 
 **Returns:** `MetadataTaxonomyNodes`
 
+**Example**
+
+```ts
+for await (const item of client.metadataTaxonomies.listMetadataTemplateFieldOptions("NAMESPACE", "TEMPLATE_KEY", "FIELD_KEY")) {
+  // use item
+}
+```
+
 Paginated — `listMetadataTemplateFieldOptions(...)` 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/metadata_templates.md

@@ -15,6 +15,14 @@ Reach these methods through the `metadataTemplates` field on `Client`.
 
 **Returns:** `MetadataTemplates`
 
+**Example**
+
+```ts
+for await (const item of client.metadataTemplates.list("METADATA_INSTANCE_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).
 
 ## getSchema
@@ -28,6 +36,12 @@ Paginated — `list(...)` is an async iterable that yields each entry across pag
 
 **Returns:** `MetadataTemplate`
 
+**Example**
+
+```ts
+const result = await client.metadataTemplates.getSchema("...", "TEMPLATE_KEY");
+```
+
 ## updateSchema
 
 `PUT /metadata_templates/{scope}/{template_key}/schema`
@@ -41,6 +55,12 @@ Paginated — `list(...)` is an async iterable that yields each entry across pag
 
 **Returns:** `MetadataTemplate`
 
+**Example**
+
+```ts
+const result = await client.metadataTemplates.updateSchema("...", "TEMPLATE_KEY", []);
+```
+
 ## deleteSchema
 
 `DELETE /metadata_templates/{scope}/{template_key}/schema`
@@ -52,6 +72,12 @@ Paginated — `list(...)` is an async iterable that yields each entry across pag
 
 **Returns:** `void`
 
+**Example**
+
+```ts
+await client.metadataTemplates.deleteSchema("...", "TEMPLATE_KEY");
+```
+
 ## get
 
 `GET /metadata_templates/{template_id}`
@@ -62,6 +88,12 @@ Paginated — `list(...)` is an async iterable that yields each entry across pag
 
 **Returns:** `MetadataTemplate`
 
+**Example**
+
+```ts
+const result = await client.metadataTemplates.get("TEMPLATE_ID");
+```
+
 ## listGlobal
 
 `GET /metadata_templates/global`
@@ -73,6 +105,14 @@ Paginated — `list(...)` is an async iterable that yields each entry across pag
 
 **Returns:** `MetadataTemplates`
 
+**Example**
+
+```ts
+for await (const item of client.metadataTemplates.listGlobal()) {
+  // use item
+}
+```
+
 Paginated — `listGlobal(...)` 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).
 
 ## listEnterprise
@@ -86,6 +126,14 @@ Paginated — `listGlobal(...)` is an async iterable that yields each entry acro
 
 **Returns:** `MetadataTemplates`
 
+**Example**
+
+```ts
+for await (const item of client.metadataTemplates.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).
 
 ## createSchema
@@ -96,3 +144,9 @@ Paginated — `listEnterprise(...)` is an async iterable that yields each entry
 
 **Returns:** `MetadataTemplate`
 
+**Example**
+
+```ts
+const result = await client.metadataTemplates.createSchema({ /* … */ });
+```
+

package/docs/managers/notes.md

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

package/docs/managers/recent_items.md

@@ -15,5 +15,13 @@ Reach these methods through the `recentItems` field on `Client`.
 
 **Returns:** `RecentItems`
 
+**Example**
+
+```ts
+for await (const item of client.recentItems.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).
 

package/docs/managers/retention_policies.md

@@ -18,6 +18,14 @@ Reach these methods through the `retentionPolicies` field on `Client`.
 
 **Returns:** `RetentionPolicies`
 
+**Example**
+
+```ts
+for await (const item of client.retentionPolicies.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:** `RetentionPolicy`
 
+**Example**
+
+```ts
+const result = await client.retentionPolicies.create({ /* … */ });
+```
+
 ## get
 
 `GET /retention_policies/{retention_policy_id}`
@@ -39,6 +53,12 @@ Paginated — `list(...)` is an async iterable that yields each entry across pag
 
 **Returns:** `RetentionPolicy`
 
+**Example**
+
+```ts
+const result = await client.retentionPolicies.get("RETENTION_POLICY_ID");
+```
+
 ## update
 
 `PUT /retention_policies/{retention_policy_id}`
@@ -51,6 +71,12 @@ Paginated — `list(...)` is an async iterable that yields each entry across pag
 
 **Returns:** `RetentionPolicy`
 
+**Example**
+
+```ts
+const result = await client.retentionPolicies.update("RETENTION_POLICY_ID", { /* … */ });
+```
+
 ## delete_
 
 `DELETE /retention_policies/{retention_policy_id}`
@@ -61,3 +87,9 @@ Paginated — `list(...)` is an async iterable that yields each entry across pag
 
 **Returns:** `void`
 
+**Example**
+
+```ts
+await client.retentionPolicies.delete_("RETENTION_POLICY_ID");
+```
+