@unofficialbox/box-open-sdk 0.1.2 → 0.2.0

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

package/docs/managers/retention_policy_assignments.md

@@ -17,6 +17,14 @@ Reach these methods through the `retentionPolicyAssignments` field on `Client`.
 
 **Returns:** `RetentionPolicyAssignments`
 
+**Example**
+
+```ts
+for await (const item of client.retentionPolicyAssignments.listRetentionPolicyAssignments("RETENTION_POLICY_ID")) {
+  // use item
+}
+```
+
 Paginated — `listRetentionPolicyAssignments(...)` 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
@@ -27,6 +35,12 @@ Paginated — `listRetentionPolicyAssignments(...)` is an async iterable that yi
 
 **Returns:** `RetentionPolicyAssignment`
 
+**Example**
+
+```ts
+const result = await client.retentionPolicyAssignments.create({ /* … */ });
+```
+
 ## get
 
 `GET /retention_policy_assignments/{retention_policy_assignment_id}`
@@ -38,6 +52,12 @@ Paginated — `listRetentionPolicyAssignments(...)` is an async iterable that yi
 
 **Returns:** `RetentionPolicyAssignment`
 
+**Example**
+
+```ts
+const result = await client.retentionPolicyAssignments.get("RETENTION_POLICY_ASSIGNMENT_ID");
+```
+
 ## delete_
 
 `DELETE /retention_policy_assignments/{retention_policy_assignment_id}`
@@ -48,6 +68,12 @@ Paginated — `listRetentionPolicyAssignments(...)` is an async iterable that yi
 
 **Returns:** `void`
 
+**Example**
+
+```ts
+await client.retentionPolicyAssignments.delete_("RETENTION_POLICY_ASSIGNMENT_ID");
+```
+
 ## listFileUnderRetention
 
 `GET /retention_policy_assignments/{retention_policy_assignment_id}/files_under_retention`
@@ -60,6 +86,14 @@ Paginated — `listRetentionPolicyAssignments(...)` is an async iterable that yi
 
 **Returns:** `FilesUnderRetention`
 
+**Example**
+
+```ts
+for await (const item of client.retentionPolicyAssignments.listFileUnderRetention("RETENTION_POLICY_ASSIGNMENT_ID")) {
+  // use item
+}
+```
+
 Paginated — `listFileUnderRetention(...)` 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).
 
 ## listFileVersionUnderRetention
@@ -74,5 +108,13 @@ Paginated — `listFileUnderRetention(...)` is an async iterable that yields eac
 
 **Returns:** `FilesUnderRetention`
 
+**Example**
+
+```ts
+for await (const item of client.retentionPolicyAssignments.listFileVersionUnderRetention("RETENTION_POLICY_ASSIGNMENT_ID")) {
+  // use item
+}
+```
+
 Paginated — `listFileVersionUnderRetention(...)` 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/search.md

@@ -3,7 +3,7 @@
 
 Reach these methods through the `search` field on `Client`.
 
-## createMetadataQueryExecuteRead
+## queryByMetadata
 
 `POST /metadata_queries/execute_read`
 
@@ -11,6 +11,12 @@ Reach these methods through the `search` field on `Client`.
 
 **Returns:** `MetadataQueryResults`
 
+**Example**
+
+```ts
+const result = await client.search.queryByMetadata({ /* … */ });
+```
+
 ## get
 
 `GET /search`
@@ -41,3 +47,9 @@ Reach these methods through the `search` field on `Client`.
 
 **Returns:** `SearchResultsResponse`
 
+**Example**
+
+```ts
+const result = await client.search.get();
+```
+

package/docs/managers/session_termination.md

@@ -11,6 +11,12 @@ Reach these methods through the `sessionTermination` field on `Client`.
 
 **Returns:** `SessionTerminationMessage`
 
+**Example**
+
+```ts
+const result = await client.sessionTermination.createUserTerminateSessions({ /* … */ });
+```
+
 ## createGroupTerminateSessions
 
 `POST /groups/terminate_sessions`
@@ -19,3 +25,9 @@ Reach these methods through the `sessionTermination` field on `Client`.
 
 **Returns:** `SessionTerminationMessage`
 
+**Example**
+
+```ts
+const result = await client.sessionTermination.createGroupTerminateSessions({ /* … */ });
+```
+

package/docs/managers/shared_links_app_items.md

@@ -13,3 +13,9 @@ Reach these methods through the `sharedLinksAppItems` field on `Client`.
 
 **Returns:** `AppItem`
 
+**Example**
+
+```ts
+const result = await client.sharedLinksAppItems.getSharedItemsAppItems("BOXAPI");
+```
+

package/docs/managers/shared_links_files.md

@@ -15,6 +15,12 @@ Reach these methods through the `sharedLinksFiles` field on `Client`.
 
 **Returns:** `FileFull`
 
+**Example**
+
+```ts
+const result = await client.sharedLinksFiles.getSharedItems("BOXAPI");
+```
+
 ## getFileGetSharedLink
 
 `GET /files/{file_id}`
@@ -26,6 +32,12 @@ Reach these methods through the `sharedLinksFiles` field on `Client`.
 
 **Returns:** `FileFull`
 
+**Example**
+
+```ts
+const result = await client.sharedLinksFiles.getFileGetSharedLink("FILE_ID", "FIELDS");
+```
+
 ## updateFileAddSharedLink
 
 `PUT /files/{file_id}`
@@ -39,6 +51,12 @@ Reach these methods through the `sharedLinksFiles` field on `Client`.
 
 **Returns:** `FileFull`
 
+**Example**
+
+```ts
+const result = await client.sharedLinksFiles.updateFileAddSharedLink("FILE_ID", "FIELDS", { /* … */ });
+```
+
 ## updateFileUpdateSharedLink
 
 `PUT /files/{file_id}`
@@ -52,6 +70,12 @@ Reach these methods through the `sharedLinksFiles` field on `Client`.
 
 **Returns:** `FileFull`
 
+**Example**
+
+```ts
+const result = await client.sharedLinksFiles.updateFileUpdateSharedLink("FILE_ID", "FIELDS", { /* … */ });
+```
+
 ## updateFileRemoveSharedLink
 
 `PUT /files/{file_id}`
@@ -65,3 +89,9 @@ Reach these methods through the `sharedLinksFiles` field on `Client`.
 
 **Returns:** `FileFull`
 
+**Example**
+
+```ts
+const result = await client.sharedLinksFiles.updateFileRemoveSharedLink("FILE_ID", "FIELDS", { /* … */ });
+```
+

package/docs/managers/shared_links_folders.md

@@ -15,6 +15,12 @@ Reach these methods through the `sharedLinksFolders` field on `Client`.
 
 **Returns:** `FolderFull`
 
+**Example**
+
+```ts
+const result = await client.sharedLinksFolders.getSharedItemsFolders("BOXAPI");
+```
+
 ## getFolderGetSharedLink
 
 `GET /folders/{folder_id}`
@@ -26,6 +32,12 @@ Reach these methods through the `sharedLinksFolders` field on `Client`.
 
 **Returns:** `FolderFull`
 
+**Example**
+
+```ts
+const result = await client.sharedLinksFolders.getFolderGetSharedLink("FOLDER_ID", "FIELDS");
+```
+
 ## updateFolderAddSharedLink
 
 `PUT /folders/{folder_id}`
@@ -39,6 +51,12 @@ Reach these methods through the `sharedLinksFolders` field on `Client`.
 
 **Returns:** `FolderFull`
 
+**Example**
+
+```ts
+const result = await client.sharedLinksFolders.updateFolderAddSharedLink("FOLDER_ID", "FIELDS", { /* … */ });
+```
+
 ## updateFolderUpdateSharedLink
 
 `PUT /folders/{folder_id}`
@@ -52,6 +70,12 @@ Reach these methods through the `sharedLinksFolders` field on `Client`.
 
 **Returns:** `FolderFull`
 
+**Example**
+
+```ts
+const result = await client.sharedLinksFolders.updateFolderUpdateSharedLink("FOLDER_ID", "FIELDS", { /* … */ });
+```
+
 ## updateFolderRemoveSharedLink
 
 `PUT /folders/{folder_id}`
@@ -65,3 +89,9 @@ Reach these methods through the `sharedLinksFolders` field on `Client`.
 
 **Returns:** `FolderFull`
 
+**Example**
+
+```ts
+const result = await client.sharedLinksFolders.updateFolderRemoveSharedLink("FOLDER_ID", "FIELDS", { /* … */ });
+```
+