@unofficialbox/box-open-sdk 0.1.2 → 0.3.1

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

package/docs/managers/shared_links_web_links.md

@@ -15,6 +15,12 @@ Reach these methods through the `sharedLinksWebLinks` field on `Client`.
 
 **Returns:** `WebLink`
 
+**Example**
+
+```ts
+const result = await client.sharedLinksWebLinks.getSharedItemsWebLinks("BOXAPI");
+```
+
 ## getWebLinkGetSharedLink
 
 `GET /web_links/{web_link_id}`
@@ -26,6 +32,12 @@ Reach these methods through the `sharedLinksWebLinks` field on `Client`.
 
 **Returns:** `WebLink`
 
+**Example**
+
+```ts
+const result = await client.sharedLinksWebLinks.getWebLinkGetSharedLink("WEB_LINK_ID", "FIELDS");
+```
+
 ## updateWebLinkAddSharedLink
 
 `PUT /web_links/{web_link_id}`
@@ -39,6 +51,12 @@ Reach these methods through the `sharedLinksWebLinks` field on `Client`.
 
 **Returns:** `WebLink`
 
+**Example**
+
+```ts
+const result = await client.sharedLinksWebLinks.updateWebLinkAddSharedLink("WEB_LINK_ID", "FIELDS", { /* … */ });
+```
+
 ## updateWebLinkUpdateSharedLink
 
 `PUT /web_links/{web_link_id}`
@@ -52,6 +70,12 @@ Reach these methods through the `sharedLinksWebLinks` field on `Client`.
 
 **Returns:** `WebLink`
 
+**Example**
+
+```ts
+const result = await client.sharedLinksWebLinks.updateWebLinkUpdateSharedLink("WEB_LINK_ID", "FIELDS", { /* … */ });
+```
+
 ## updateWebLinkRemoveSharedLink
 
 `PUT /web_links/{web_link_id}`
@@ -65,3 +89,9 @@ Reach these methods through the `sharedLinksWebLinks` field on `Client`.
 
 **Returns:** `WebLink`
 
+**Example**
+
+```ts
+const result = await client.sharedLinksWebLinks.updateWebLinkRemoveSharedLink("WEB_LINK_ID", "FIELDS", { /* … */ });
+```
+

package/docs/managers/shield_information_barrier_reports.md

@@ -15,6 +15,14 @@ Reach these methods through the `shieldInformationBarrierReports` field on `Clie
 
 **Returns:** `ShieldInformationBarrierReports`
 
+**Example**
+
+```ts
+for await (const item of client.shieldInformationBarrierReports.list("SHIELD_INFORMATION_BARRIER_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:** `ShieldInformationBarrierReport`
 
+**Example**
+
+```ts
+const result = await client.shieldInformationBarrierReports.create({ /* … */ });
+```
+
 ## get
 
 `GET /shield_information_barrier_reports/{shield_information_barrier_report_id}`
@@ -35,3 +49,9 @@ Paginated — `list(...)` is an async iterable that yields each entry across pag
 
 **Returns:** `ShieldInformationBarrierReport`
 
+**Example**
+
+```ts
+const result = await client.shieldInformationBarrierReports.get("SHIELD_INFORMATION_BARRIER_REPORT_ID");
+```
+

package/docs/managers/shield_information_barrier_segment_members.md

@@ -13,6 +13,12 @@ Reach these methods through the `shieldInformationBarrierSegmentMembers` field o
 
 **Returns:** `ShieldInformationBarrierSegmentMember`
 
+**Example**
+
+```ts
+const result = await client.shieldInformationBarrierSegmentMembers.get("SHIELD_INFORMATION_BARRIER_SEGMENT_MEMBER_ID");
+```
+
 ## delete_
 
 `DELETE /shield_information_barrier_segment_members/{shield_information_barrier_segment_member_id}`
@@ -23,6 +29,12 @@ Reach these methods through the `shieldInformationBarrierSegmentMembers` field o
 
 **Returns:** `void`
 
+**Example**
+
+```ts
+await client.shieldInformationBarrierSegmentMembers.delete_("SHIELD_INFORMATION_BARRIER_SEGMENT_MEMBER_ID");
+```
+
 ## list
 
 `GET /shield_information_barrier_segment_members`
@@ -35,6 +47,14 @@ Reach these methods through the `shieldInformationBarrierSegmentMembers` field o
 
 **Returns:** `ShieldInformationBarrierSegmentMembers`
 
+**Example**
+
+```ts
+for await (const item of client.shieldInformationBarrierSegmentMembers.list("SHIELD_INFORMATION_BARRIER_SEGMENT_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
@@ -45,3 +65,9 @@ Paginated — `list(...)` is an async iterable that yields each entry across pag
 
 **Returns:** `ShieldInformationBarrierSegmentMember`
 
+**Example**
+
+```ts
+const result = await client.shieldInformationBarrierSegmentMembers.create({ /* … */ });
+```
+

package/docs/managers/shield_information_barrier_segment_restrictions.md

@@ -13,6 +13,12 @@ Reach these methods through the `shieldInformationBarrierSegmentRestrictions` fi
 
 **Returns:** `ShieldInformationBarrierSegmentRestriction`
 
+**Example**
+
+```ts
+const result = await client.shieldInformationBarrierSegmentRestrictions.get("SHIELD_INFORMATION_BARRIER_SEGMENT_RESTRICTION_ID");
+```
+
 ## delete_
 
 `DELETE /shield_information_barrier_segment_restrictions/{shield_information_barrier_segment_restriction_id}`
@@ -23,6 +29,12 @@ Reach these methods through the `shieldInformationBarrierSegmentRestrictions` fi
 
 **Returns:** `void`
 
+**Example**
+
+```ts
+await client.shieldInformationBarrierSegmentRestrictions.delete_("SHIELD_INFORMATION_BARRIER_SEGMENT_RESTRICTION_ID");
+```
+
 ## list
 
 `GET /shield_information_barrier_segment_restrictions`
@@ -35,6 +47,14 @@ Reach these methods through the `shieldInformationBarrierSegmentRestrictions` fi
 
 **Returns:** `ShieldInformationBarrierSegmentRestrictions`
 
+**Example**
+
+```ts
+for await (const item of client.shieldInformationBarrierSegmentRestrictions.list("SHIELD_INFORMATION_BARRIER_SEGMENT_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
@@ -45,3 +65,9 @@ Paginated — `list(...)` is an async iterable that yields each entry across pag
 
 **Returns:** `ShieldInformationBarrierSegmentRestriction`
 
+**Example**
+
+```ts
+const result = await client.shieldInformationBarrierSegmentRestrictions.create({ /* … */ });
+```
+

package/docs/managers/shield_information_barrier_segments.md

@@ -13,6 +13,12 @@ Reach these methods through the `shieldInformationBarrierSegments` field on `Cli
 
 **Returns:** `ShieldInformationBarrierSegment`
 
+**Example**
+
+```ts
+const result = await client.shieldInformationBarrierSegments.get("SHIELD_INFORMATION_BARRIER_SEGMENT_ID");
+```
+
 ## update
 
 `PUT /shield_information_barrier_segments/{shield_information_barrier_segment_id}`
@@ -25,6 +31,12 @@ Reach these methods through the `shieldInformationBarrierSegments` field on `Cli
 
 **Returns:** `ShieldInformationBarrierSegment`
 
+**Example**
+
+```ts
+const result = await client.shieldInformationBarrierSegments.update("SHIELD_INFORMATION_BARRIER_SEGMENT_ID", { /* … */ });
+```
+
 ## delete_
 
 `DELETE /shield_information_barrier_segments/{shield_information_barrier_segment_id}`
@@ -35,6 +47,12 @@ Reach these methods through the `shieldInformationBarrierSegments` field on `Cli
 
 **Returns:** `void`
 
+**Example**
+
+```ts
+await client.shieldInformationBarrierSegments.delete_("SHIELD_INFORMATION_BARRIER_SEGMENT_ID");
+```
+
 ## list
 
 `GET /shield_information_barrier_segments`
@@ -47,6 +65,14 @@ Reach these methods through the `shieldInformationBarrierSegments` field on `Cli
 
 **Returns:** `ShieldInformationBarrierSegments`
 
+**Example**
+
+```ts
+for await (const item of client.shieldInformationBarrierSegments.list("SHIELD_INFORMATION_BARRIER_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
@@ -57,3 +83,9 @@ Paginated — `list(...)` is an async iterable that yields each entry across pag
 
 **Returns:** `ShieldInformationBarrierSegment`
 
+**Example**
+
+```ts
+const result = await client.shieldInformationBarrierSegments.create({ /* … */ });
+```
+

package/docs/managers/shield_information_barriers.md

@@ -13,6 +13,12 @@ Reach these methods through the `shieldInformationBarriers` field on `Client`.
 
 **Returns:** `ShieldInformationBarrier`
 
+**Example**
+
+```ts
+const result = await client.shieldInformationBarriers.get("SHIELD_INFORMATION_BARRIER_ID");
+```
+
 ## createChangeStatus
 
 `POST /shield_information_barriers/change_status`
@@ -21,6 +27,12 @@ Reach these methods through the `shieldInformationBarriers` field on `Client`.
 
 **Returns:** `ShieldInformationBarrier`
 
+**Example**
+
+```ts
+const result = await client.shieldInformationBarriers.createChangeStatus({ /* … */ });
+```
+
 ## list
 
 `GET /shield_information_barriers`
@@ -32,6 +44,14 @@ Reach these methods through the `shieldInformationBarriers` field on `Client`.
 
 **Returns:** `ShieldInformationBarriers`
 
+**Example**
+
+```ts
+for await (const item of client.shieldInformationBarriers.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
@@ -42,3 +62,9 @@ Paginated — `list(...)` is an async iterable that yields each entry across pag
 
 **Returns:** `ShieldInformationBarrier`
 
+**Example**
+
+```ts
+const result = await client.shieldInformationBarriers.create({ /* … */ });
+```
+

package/docs/managers/shield_lists.md

@@ -9,6 +9,12 @@ Reach these methods through the `shieldLists` field on `Client`.
 
 **Returns:** `ShieldLists`
 
+**Example**
+
+```ts
+const result = await client.shieldLists.list();
+```
+
 ## create
 
 `POST /shield_lists`
@@ -17,6 +23,12 @@ Reach these methods through the `shieldLists` field on `Client`.
 
 **Returns:** `ShieldList`
 
+**Example**
+
+```ts
+const result = await client.shieldLists.create({ /* … */ });
+```
+
 ## get
 
 `GET /shield_lists/{shield_list_id}`
@@ -27,6 +39,12 @@ Reach these methods through the `shieldLists` field on `Client`.
 
 **Returns:** `ShieldList`
 
+**Example**
+
+```ts
+const result = await client.shieldLists.get("SHIELD_LIST_ID");
+```
+
 ## update
 
 `PUT /shield_lists/{shield_list_id}`
@@ -39,6 +57,12 @@ Reach these methods through the `shieldLists` field on `Client`.
 
 **Returns:** `ShieldList`
 
+**Example**
+
+```ts
+const result = await client.shieldLists.update("SHIELD_LIST_ID", { /* … */ });
+```
+
 ## delete_
 
 `DELETE /shield_lists/{shield_list_id}`
@@ -49,3 +73,9 @@ Reach these methods through the `shieldLists` field on `Client`.
 
 **Returns:** `void`
 
+**Example**
+
+```ts
+await client.shieldLists.delete_("SHIELD_LIST_ID");
+```
+

package/docs/managers/sign_requests.md

@@ -15,6 +15,12 @@ Reach these methods through the `signRequests` field on `Client`.
 
 **Returns:** `SignRequest`
 
+**Example**
+
+```ts
+const result = await client.signRequests.cancel("SIGN_REQUEST_ID", { /* … */ });
+```
+
 ## resend
 
 `POST /sign_requests/{sign_request_id}/resend`
@@ -25,6 +31,12 @@ Reach these methods through the `signRequests` field on `Client`.
 
 **Returns:** `void`
 
+**Example**
+
+```ts
+await client.signRequests.resend("SIGN_REQUEST_ID");
+```
+
 ## get
 
 `GET /sign_requests/{sign_request_id}`
@@ -35,6 +47,12 @@ Reach these methods through the `signRequests` field on `Client`.
 
 **Returns:** `SignRequest`
 
+**Example**
+
+```ts
+const result = await client.signRequests.get("SIGN_REQUEST_ID");
+```
+
 ## list
 
 `GET /sign_requests`
@@ -48,6 +66,14 @@ Reach these methods through the `signRequests` field on `Client`.
 
 **Returns:** `SignRequests`
 
+**Example**
+
+```ts
+for await (const item of client.signRequests.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
@@ -58,3 +84,9 @@ Paginated — `list(...)` is an async iterable that yields each entry across pag
 
 **Returns:** `SignRequest`
 
+**Example**
+
+```ts
+const result = await client.signRequests.create({ /* … */ });
+```
+