Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .codegen.json
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{ "engineHash": "7c01dda", "specHash": "2bd751f", "version": "4.5.0" }
{ "engineHash": "e77f966", "specHash": "c8e3a85", "version": "4.5.0" }
1 change: 1 addition & 0 deletions docs/sdk-gen/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@ the SDK are available by topic:
* [Folders](folders.md)
* [Groups](groups.md)
* [Hub collaborations](hubCollaborations.md)
* [Hub document](hubDocument.md)
* [Hub items](hubItems.md)
* [Hubs](hubs.md)
* [Integration mappings](integrationMappings.md)
Expand Down
69 changes: 69 additions & 0 deletions docs/sdk-gen/hubDocument.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
# HubDocumentManager


- [List Hub Document Pages](#list-hub-document-pages)
- [List Hub Document blocks for page](#list-hub-document-blocks-for-page)

## List Hub Document Pages

Retrieves a list of Hub Document Pages for the specified hub.
Includes both root-level pages and sub pages.

This operation is performed by calling function `getHubDocumentPagesV2025R0`.

See the endpoint docs at
[API Reference](https://developer.box.com/reference/v2025.0/get-hub-document-pages/).

<!-- sample get_hub_document_pages_v2025.0 -->
```ts
await client.hubDocument.getHubDocumentPagesV2025R0({ hubId: hubId } satisfies GetHubDocumentPagesV2025R0QueryParams)
```

### Arguments

- queryParams `GetHubDocumentPagesV2025R0QueryParams`
- Query parameters of getHubDocumentPagesV2025R0 method
- optionalsInput `GetHubDocumentPagesV2025R0OptionalsInput`



### Returns

This function returns a value of type `HubDocumentPagesV2025R0`.

Returns a Hub Document Pages response whose `entries` array contains root-level pages and sub pages. Includes pagination when more results are available.


## List Hub Document blocks for page

Retrieves a sorted list of all Hub Document Blocks on a specified page in the hub document, excluding items.
Blocks are hierarchically organized by their `parent_id`.
Blocks are sorted in order based on user specification in the user interface.
The response will only include content blocks that belong to the specified page. This will not include sub pages or sub page content blocks.

This operation is performed by calling function `getHubDocumentBlocksV2025R0`.

See the endpoint docs at
[API Reference](https://developer.box.com/reference/v2025.0/get-hub-document-blocks/).

<!-- sample get_hub_document_blocks_v2025.0 -->
```ts
await client.hubDocument.getHubDocumentBlocksV2025R0({ hubId: hubId, pageId: pageId } satisfies GetHubDocumentBlocksV2025R0QueryParams)
```

### Arguments

- queryParams `GetHubDocumentBlocksV2025R0QueryParams`
- Query parameters of getHubDocumentBlocksV2025R0 method
- optionalsInput `GetHubDocumentBlocksV2025R0OptionalsInput`



### Returns

This function returns a value of type `HubDocumentBlocksV2025R0`.

Returns a Hub Document Blocks response whose `entries` array contains all content blocks of the specified page, except for items.
To retrieve items, use the `GET /hub_items` endpoint.


4 changes: 3 additions & 1 deletion docs/sdk-gen/trashedItems.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,9 @@ in with the `fields` parameter to retrieve those specific
attributes that are not returned by default.

This endpoint defaults to use offset-based pagination, yet also supports
marker-based pagination using the `marker` parameter.
marker-based pagination using the `marker` parameter.

The number of entries returned may be less than `total_count`. For example, if a user deletes items from a shared folder and is later removed as a collaborator, those deleted items will no longer appear in this endpoint’s results, even though they are still included in `total_count`.

This operation is performed by calling function `getTrashedItems`.

Expand Down
7 changes: 7 additions & 0 deletions src/sdk-gen/client.ts
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,7 @@ import { EnterpriseConfigurationsManager } from './managers/enterpriseConfigurat
import { HubsManager } from './managers/hubs';
import { HubCollaborationsManager } from './managers/hubCollaborations';
import { HubItemsManager } from './managers/hubItems';
import { HubDocumentManager } from './managers/hubDocument';
import { ShieldListsManager } from './managers/shieldLists';
import { ArchivesManager } from './managers/archives';
import { ExternalUsersManager } from './managers/externalUsers';
Expand Down Expand Up @@ -185,6 +186,7 @@ export class BoxClient {
readonly hubs: HubsManager;
readonly hubCollaborations: HubCollaborationsManager;
readonly hubItems: HubItemsManager;
readonly hubDocument: HubDocumentManager;
readonly shieldLists: ShieldListsManager;
readonly archives: ArchivesManager;
readonly externalUsers: ExternalUsersManager;
Expand Down Expand Up @@ -270,6 +272,7 @@ export class BoxClient {
| 'hubs'
| 'hubCollaborations'
| 'hubItems'
| 'hubDocument'
| 'shieldLists'
| 'archives'
| 'externalUsers'
Expand Down Expand Up @@ -614,6 +617,10 @@ export class BoxClient {
auth: this.auth,
networkSession: this.networkSession,
});
this.hubDocument = new HubDocumentManager({
auth: this.auth,
networkSession: this.networkSession,
});
this.shieldLists = new ShieldListsManager({
auth: this.auth,
networkSession: this.networkSession,
Expand Down
Loading
Loading