|
| 1 | +# HubDocumentManager |
| 2 | + |
| 3 | +- [List Hub Document Pages](#list-hub-document-pages) |
| 4 | +- [List Hub Document blocks for page](#list-hub-document-blocks-for-page) |
| 5 | + |
| 6 | +## List Hub Document Pages |
| 7 | + |
| 8 | +Retrieves a list of Hub Document Pages for the specified hub. |
| 9 | +Includes both root-level pages and sub pages. |
| 10 | + |
| 11 | +This operation is performed by calling function `getHubDocumentPagesV2025R0`. |
| 12 | + |
| 13 | +See the endpoint docs at |
| 14 | +[API Reference](https://developer.box.com/reference/v2025.0/get-hub-document-pages/). |
| 15 | + |
| 16 | +<!-- sample get_hub_document_pages_v2025.0 --> |
| 17 | + |
| 18 | +```ts |
| 19 | +await client.hubDocument.getHubDocumentPagesV2025R0({ |
| 20 | + hubId: hubId, |
| 21 | +} satisfies GetHubDocumentPagesV2025R0QueryParams); |
| 22 | +``` |
| 23 | + |
| 24 | +### Arguments |
| 25 | + |
| 26 | +- queryParams `GetHubDocumentPagesV2025R0QueryParams` |
| 27 | + - Query parameters of getHubDocumentPagesV2025R0 method |
| 28 | +- optionalsInput `GetHubDocumentPagesV2025R0OptionalsInput` |
| 29 | + |
| 30 | +### Returns |
| 31 | + |
| 32 | +This function returns a value of type `HubDocumentPagesV2025R0`. |
| 33 | + |
| 34 | +Returns a Hub Document Pages response whose `entries` array contains root-level pages and sub pages. Includes pagination when more results are available. |
| 35 | + |
| 36 | +## List Hub Document blocks for page |
| 37 | + |
| 38 | +Retrieves a sorted list of all Hub Document Blocks on a specified page in the hub document, excluding items. |
| 39 | +Blocks are hierarchically organized by their `parent_id`. |
| 40 | +Blocks are sorted in order based on user specification in the user interface. |
| 41 | +The response will only include content blocks that belong to the specified page. This will not include sub pages or sub page content blocks. |
| 42 | + |
| 43 | +This operation is performed by calling function `getHubDocumentBlocksV2025R0`. |
| 44 | + |
| 45 | +See the endpoint docs at |
| 46 | +[API Reference](https://developer.box.com/reference/v2025.0/get-hub-document-blocks/). |
| 47 | + |
| 48 | +<!-- sample get_hub_document_blocks_v2025.0 --> |
| 49 | + |
| 50 | +```ts |
| 51 | +await client.hubDocument.getHubDocumentBlocksV2025R0({ |
| 52 | + hubId: hubId, |
| 53 | + pageId: pageId, |
| 54 | +} satisfies GetHubDocumentBlocksV2025R0QueryParams); |
| 55 | +``` |
| 56 | + |
| 57 | +### Arguments |
| 58 | + |
| 59 | +- queryParams `GetHubDocumentBlocksV2025R0QueryParams` |
| 60 | + - Query parameters of getHubDocumentBlocksV2025R0 method |
| 61 | +- optionalsInput `GetHubDocumentBlocksV2025R0OptionalsInput` |
| 62 | + |
| 63 | +### Returns |
| 64 | + |
| 65 | +This function returns a value of type `HubDocumentBlocksV2025R0`. |
| 66 | + |
| 67 | +Returns a Hub Document Blocks response whose `entries` array contains all content blocks of the specified page, except for items. |
| 68 | +To retrieve items, use the `GET /hub_items` endpoint. |
0 commit comments