|
1 | 1 | # HubsManager
|
2 | 2 |
|
3 | 3 | - [List all hubs](#list-all-hubs)
|
| 4 | +- [Create hub](#create-hub) |
4 | 5 | - [List all hubs for requesting enterprise](#list-all-hubs-for-requesting-enterprise)
|
5 | 6 | - [Get hub information by ID](#get-hub-information-by-id)
|
| 7 | +- [Update hub information by ID](#update-hub-information-by-id) |
6 | 8 | - [Delete hub](#delete-hub)
|
| 9 | +- [Copy hub](#copy-hub) |
7 | 10 |
|
8 | 11 | ## List all hubs
|
9 | 12 |
|
@@ -39,6 +42,30 @@ This function returns a value of type `HubsV2025R0`.
|
39 | 42 |
|
40 | 43 | Returns all hubs for the given user or enterprise.
|
41 | 44 |
|
| 45 | +## Create hub |
| 46 | + |
| 47 | +Creates a new Hub. |
| 48 | + |
| 49 | +This operation is performed by calling function `createHubV2025R0`. |
| 50 | + |
| 51 | +See the endpoint docs at |
| 52 | +[API Reference](https://developer.box.com/reference/v2025.0/post-hubs/). |
| 53 | + |
| 54 | +_Currently we don't have an example for calling `createHubV2025R0` in integration tests_ |
| 55 | + |
| 56 | +### Arguments |
| 57 | + |
| 58 | +- requestBody `HubCreateRequestV2025R0` |
| 59 | + - Request body of createHubV2025R0 method |
| 60 | +- optionalsInput `CreateHubV2025R0OptionalsInput` |
| 61 | + - |
| 62 | + |
| 63 | +### Returns |
| 64 | + |
| 65 | +This function returns a value of type `HubV2025R0`. |
| 66 | + |
| 67 | +Returns a new Hub object. |
| 68 | + |
42 | 69 | ## List all hubs for requesting enterprise
|
43 | 70 |
|
44 | 71 | Retrieves all hubs for a given enterprise.
|
@@ -103,6 +130,32 @@ This function returns a value of type `HubV2025R0`.
|
103 | 130 |
|
104 | 131 | Returns a hub object.
|
105 | 132 |
|
| 133 | +## Update hub information by ID |
| 134 | + |
| 135 | +Updates a Hub. Can be used to change title, description, or Hub settings. |
| 136 | + |
| 137 | +This operation is performed by calling function `updateHubByIdV2025R0`. |
| 138 | + |
| 139 | +See the endpoint docs at |
| 140 | +[API Reference](https://developer.box.com/reference/v2025.0/put-hubs-id/). |
| 141 | + |
| 142 | +_Currently we don't have an example for calling `updateHubByIdV2025R0` in integration tests_ |
| 143 | + |
| 144 | +### Arguments |
| 145 | + |
| 146 | +- hubId `string` |
| 147 | + - The unique identifier that represent a hub. The ID for any hub can be determined by visiting this hub in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/hubs/123` the `hub_id` is `123`. Example: "12345" |
| 148 | +- requestBody `HubUpdateRequestV2025R0` |
| 149 | + - Request body of updateHubByIdV2025R0 method |
| 150 | +- optionalsInput `UpdateHubByIdV2025R0OptionalsInput` |
| 151 | + - |
| 152 | + |
| 153 | +### Returns |
| 154 | + |
| 155 | +This function returns a value of type `HubV2025R0`. |
| 156 | + |
| 157 | +Returns a Hub object. |
| 158 | + |
106 | 159 | ## Delete hub
|
107 | 160 |
|
108 | 161 | Deletes a single hub.
|
@@ -131,3 +184,31 @@ This function returns a value of type `undefined`.
|
131 | 184 |
|
132 | 185 | A blank response is returned if the hub was
|
133 | 186 | successfully deleted.
|
| 187 | + |
| 188 | +## Copy hub |
| 189 | + |
| 190 | +Creates a copy of a Hub. |
| 191 | + |
| 192 | +The original Hub will not be modified. |
| 193 | + |
| 194 | +This operation is performed by calling function `createHubCopyV2025R0`. |
| 195 | + |
| 196 | +See the endpoint docs at |
| 197 | +[API Reference](https://developer.box.com/reference/v2025.0/post-hubs-id-copy/). |
| 198 | + |
| 199 | +_Currently we don't have an example for calling `createHubCopyV2025R0` in integration tests_ |
| 200 | + |
| 201 | +### Arguments |
| 202 | + |
| 203 | +- hubId `string` |
| 204 | + - The unique identifier that represent a hub. The ID for any hub can be determined by visiting this hub in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/hubs/123` the `hub_id` is `123`. Example: "12345" |
| 205 | +- requestBody `HubCopyRequestV2025R0` |
| 206 | + - Request body of createHubCopyV2025R0 method |
| 207 | +- optionalsInput `CreateHubCopyV2025R0OptionalsInput` |
| 208 | + - |
| 209 | + |
| 210 | +### Returns |
| 211 | + |
| 212 | +This function returns a value of type `HubV2025R0`. |
| 213 | + |
| 214 | +Returns a new Hub object. |
0 commit comments