Skip to content

Commit c324157

Browse files
committed
fix: brand Hubs as Box Hubs (box/box-openapi#553)
1 parent 5fc1f89 commit c324157

20 files changed

+132
-132
lines changed

.codegen.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
{ "engineHash": "fa469c0", "specHash": "ec8720b", "version": "0.1.0" }
1+
{ "engineHash": "fa469c0", "specHash": "60778fb", "version": "0.1.0" }

box_sdk_gen/managers/hub_collaborations.py

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -133,7 +133,7 @@ def get_hub_collaborations_v2025_r0(
133133
extra_headers: Optional[Dict[str, Optional[str]]] = None
134134
) -> HubCollaborationsV2025R0:
135135
"""
136-
Retrieves all collaborations for a hub.
136+
Retrieves all collaborations for a Box Hub.
137137
:param hub_id: The unique identifier that represent a hub.
138138
139139
The ID for any hub can be determined
@@ -191,15 +191,15 @@ def create_hub_collaboration_v2025_r0(
191191
extra_headers: Optional[Dict[str, Optional[str]]] = None
192192
) -> HubCollaborationV2025R0:
193193
"""
194-
Adds a collaboration for a single user or a single group to a hub.
194+
Adds a collaboration for a single user or a single group to a Box Hub.
195195
196196
Collaborations can be created using email address, user IDs, or group IDs.
197197
198-
:param hub: Hubs reference.
198+
:param hub: Box Hubs reference.
199199
:type hub: CreateHubCollaborationV2025R0Hub
200200
:param accessible_by: The user or group who gets access to the item.
201201
:type accessible_by: CreateHubCollaborationV2025R0AccessibleBy
202-
:param role: The level of access granted to hub.
202+
:param role: The level of access granted to a Box Hub.
203203
Possible values are `editor`, `viewer`, and `co-owner`.
204204
:type role: str
205205
:param box_version: Version header., defaults to BoxVersionHeaderV2025R0._2025_0
@@ -237,7 +237,7 @@ def get_hub_collaboration_by_id_v2025_r0(
237237
extra_headers: Optional[Dict[str, Optional[str]]] = None
238238
) -> HubCollaborationV2025R0:
239239
"""
240-
Retrieves details for a hub collaboration by collaboration ID.
240+
Retrieves details for a Box Hub collaboration by collaboration ID.
241241
:param hub_collaboration_id: The ID of the hub collaboration.
242242
Example: "1234"
243243
:type hub_collaboration_id: str
@@ -278,14 +278,14 @@ def update_hub_collaboration_by_id_v2025_r0(
278278
extra_headers: Optional[Dict[str, Optional[str]]] = None
279279
) -> HubCollaborationV2025R0:
280280
"""
281-
Updates a hub collaboration.
281+
Updates a Box Hub collaboration.
282282
283-
Can be used to change the hub role.
283+
Can be used to change the Box Hub role.
284284
285285
:param hub_collaboration_id: The ID of the hub collaboration.
286286
Example: "1234"
287287
:type hub_collaboration_id: str
288-
:param role: The level of access granted to hub.
288+
:param role: The level of access granted to a Box Hub.
289289
Possible values are `editor`, `viewer`, and `co-owner`., defaults to None
290290
:type role: Optional[str], optional
291291
:param box_version: Version header., defaults to BoxVersionHeaderV2025R0._2025_0
@@ -327,7 +327,7 @@ def delete_hub_collaboration_by_id_v2025_r0(
327327
extra_headers: Optional[Dict[str, Optional[str]]] = None
328328
) -> None:
329329
"""
330-
Deletes a single hub collaboration.
330+
Deletes a single Box Hub collaboration.
331331
:param hub_collaboration_id: The ID of the hub collaboration.
332332
Example: "1234"
333333
:type hub_collaboration_id: str

box_sdk_gen/managers/hub_items.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ def get_hub_items_v2025_r0(
7575
extra_headers: Optional[Dict[str, Optional[str]]] = None
7676
) -> HubItemsV2025R0:
7777
"""
78-
Retrieves all items associated with a Hub.
78+
Retrieves all items associated with a Box Hub.
7979
:param hub_id: The unique identifier that represent a hub.
8080
8181
The ID for any hub can be determined
@@ -132,7 +132,7 @@ def manage_hub_items_v2025_r0(
132132
extra_headers: Optional[Dict[str, Optional[str]]] = None
133133
) -> HubItemsManageResponseV2025R0:
134134
"""
135-
Adds and/or removes Hub items from a Hub.
135+
Adds and/or removes Box Hub items from a Box Hub.
136136
:param hub_id: The unique identifier that represent a hub.
137137
138138
The ID for any hub can be determined
@@ -142,7 +142,7 @@ def manage_hub_items_v2025_r0(
142142
the `hub_id` is `123`.
143143
Example: "12345"
144144
:type hub_id: str
145-
:param operations: List of operations to perform on Hub items., defaults to None
145+
:param operations: List of operations to perform on Box Hub items., defaults to None
146146
:type operations: Optional[List[HubItemOperationV2025R0]], optional
147147
:param box_version: Version header., defaults to BoxVersionHeaderV2025R0._2025_0
148148
:type box_version: BoxVersionHeaderV2025R0, optional

box_sdk_gen/managers/hubs.py

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -88,10 +88,10 @@ def get_hubs_v2025_r0(
8888
extra_headers: Optional[Dict[str, Optional[str]]] = None
8989
) -> HubsV2025R0:
9090
"""
91-
Retrieves all hubs for requesting user.
92-
:param query: The query string to search for hubs., defaults to None
91+
Retrieves all Box Hubs for requesting user.
92+
:param query: The query string to search for Box Hubs., defaults to None
9393
:type query: Optional[str], optional
94-
:param scope: The scope of the hubs to retrieve. Possible values include `editable`,
94+
:param scope: The scope of the Box Hubs to retrieve. Possible values include `editable`,
9595
`view_only`, and `all`. Default is `all`., defaults to None
9696
:type scope: Optional[str], optional
9797
:param sort: The field to sort results by.
@@ -149,10 +149,10 @@ def create_hub_v2025_r0(
149149
extra_headers: Optional[Dict[str, Optional[str]]] = None
150150
) -> HubV2025R0:
151151
"""
152-
Creates a new Hub.
153-
:param title: Title of the Hub. It cannot be empty and should be less than 50 characters.
152+
Creates a new Box Hub.
153+
:param title: Title of the Box Hub. It cannot be empty and should be less than 50 characters.
154154
:type title: str
155-
:param description: Description of the Hub., defaults to None
155+
:param description: Description of the Box Hub., defaults to None
156156
:type description: Optional[str], optional
157157
:param box_version: Version header., defaults to BoxVersionHeaderV2025R0._2025_0
158158
:type box_version: BoxVersionHeaderV2025R0, optional
@@ -191,14 +191,14 @@ def get_enterprise_hubs_v2025_r0(
191191
extra_headers: Optional[Dict[str, Optional[str]]] = None
192192
) -> HubsV2025R0:
193193
"""
194-
Retrieves all hubs for a given enterprise.
194+
Retrieves all Box Hubs for a given enterprise.
195195
196196
Admins or Hub Co-admins of an enterprise
197197
198198
199199
with GCM scope can make this call.
200200
201-
:param query: The query string to search for hubs., defaults to None
201+
:param query: The query string to search for Box Hubs., defaults to None
202202
:type query: Optional[str], optional
203203
:param sort: The field to sort results by.
204204
Possible values include `name`, `updated_at`,
@@ -255,7 +255,7 @@ def get_hub_by_id_v2025_r0(
255255
extra_headers: Optional[Dict[str, Optional[str]]] = None
256256
) -> HubV2025R0:
257257
"""
258-
Retrieves details for a hub by its ID.
258+
Retrieves details for a Box Hub by its ID.
259259
:param hub_id: The unique identifier that represent a hub.
260260
261261
The ID for any hub can be determined
@@ -307,7 +307,7 @@ def update_hub_by_id_v2025_r0(
307307
extra_headers: Optional[Dict[str, Optional[str]]] = None
308308
) -> HubV2025R0:
309309
"""
310-
Updates a Hub. Can be used to change title, description, or Hub settings.
310+
Updates a Box Hub. Can be used to change title, description, or Box Hub settings.
311311
:param hub_id: The unique identifier that represent a hub.
312312
313313
The ID for any hub can be determined
@@ -317,17 +317,17 @@ def update_hub_by_id_v2025_r0(
317317
the `hub_id` is `123`.
318318
Example: "12345"
319319
:type hub_id: str
320-
:param title: Title of the Hub. It cannot be empty and should be less than 50 characters., defaults to None
320+
:param title: Title of the Box Hub. It cannot be empty and should be less than 50 characters., defaults to None
321321
:type title: Optional[str], optional
322-
:param description: Description of the Hub., defaults to None
322+
:param description: Description of the Box Hub., defaults to None
323323
:type description: Optional[str], optional
324-
:param is_ai_enabled: Indicates if AI features are enabled for the Hub., defaults to None
324+
:param is_ai_enabled: Indicates if AI features are enabled for the Box Hub., defaults to None
325325
:type is_ai_enabled: Optional[bool], optional
326326
:param is_collaboration_restricted_to_enterprise: Indicates if collaboration is restricted to the enterprise., defaults to None
327327
:type is_collaboration_restricted_to_enterprise: Optional[bool], optional
328-
:param can_non_owners_invite: Indicates if non-owners can invite others to the Hub., defaults to None
328+
:param can_non_owners_invite: Indicates if non-owners can invite others to the Box Hub., defaults to None
329329
:type can_non_owners_invite: Optional[bool], optional
330-
:param can_shared_link_be_created: Indicates if a shared link can be created for the Hub., defaults to None
330+
:param can_shared_link_be_created: Indicates if a shared link can be created for the Box Hub., defaults to None
331331
:type can_shared_link_be_created: Optional[bool], optional
332332
:param box_version: Version header., defaults to BoxVersionHeaderV2025R0._2025_0
333333
:type box_version: BoxVersionHeaderV2025R0, optional
@@ -377,7 +377,7 @@ def delete_hub_by_id_v2025_r0(
377377
extra_headers: Optional[Dict[str, Optional[str]]] = None
378378
) -> None:
379379
"""
380-
Deletes a single hub.
380+
Deletes a single Box Hub.
381381
:param hub_id: The unique identifier that represent a hub.
382382
383383
The ID for any hub can be determined
@@ -425,9 +425,9 @@ def copy_hub_v2025_r0(
425425
extra_headers: Optional[Dict[str, Optional[str]]] = None
426426
) -> HubV2025R0:
427427
"""
428-
Creates a copy of a Hub.
428+
Creates a copy of a Box Hub.
429429
430-
The original Hub will not be modified.
430+
The original Box Hub will not be modified.
431431
432432
:param hub_id: The unique identifier that represent a hub.
433433
@@ -438,9 +438,9 @@ def copy_hub_v2025_r0(
438438
the `hub_id` is `123`.
439439
Example: "12345"
440440
:type hub_id: str
441-
:param title: Title of the Hub. It cannot be empty and should be less than 50 characters., defaults to None
441+
:param title: Title of the Box Hub. It cannot be empty and should be less than 50 characters., defaults to None
442442
:type title: Optional[str], optional
443-
:param description: Description of the Hub., defaults to None
443+
:param description: Description of the Box Hub., defaults to None
444444
:type description: Optional[str], optional
445445
:param box_version: Version header., defaults to BoxVersionHeaderV2025R0._2025_0
446446
:type box_version: BoxVersionHeaderV2025R0, optional

box_sdk_gen/schemas/v2025_r0/hub_base_v2025_r0.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,10 @@ def __init__(
2020
**kwargs
2121
):
2222
"""
23-
:param id: The unique identifier that represent a hub.
23+
:param id: The unique identifier that represent a Box Hub.
2424
25-
The ID for any hub can be determined
26-
by visiting a hub in the web application
25+
The ID for any Box Hub can be determined
26+
by visiting a Box Hub in the web application
2727
and copying the ID from the URL. For example,
2828
for the URL `https://*.app.box.com/hubs/123`
2929
the `hub_id` is `123`.

box_sdk_gen/schemas/v2025_r0/hub_collaboration_create_request_v2025_r0.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -70,11 +70,11 @@ def __init__(
7070
**kwargs
7171
):
7272
"""
73-
:param hub: Hubs reference.
73+
:param hub: Box Hubs reference.
7474
:type hub: HubCollaborationCreateRequestV2025R0HubField
7575
:param accessible_by: The user or group who gets access to the item.
7676
:type accessible_by: HubCollaborationCreateRequestV2025R0AccessibleByField
77-
:param role: The level of access granted to hub.
77+
:param role: The level of access granted to a Box Hub.
7878
Possible values are `editor`, `viewer`, and `co-owner`.
7979
:type role: str
8080
"""

box_sdk_gen/schemas/v2025_r0/hub_collaboration_update_request_v2025_r0.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
class HubCollaborationUpdateRequestV2025R0(BaseObject):
99
def __init__(self, *, role: Optional[str] = None, **kwargs):
1010
"""
11-
:param role: The level of access granted to hub.
11+
:param role: The level of access granted to a Box Hub.
1212
Possible values are `editor`, `viewer`, and `co-owner`., defaults to None
1313
:type role: Optional[str], optional
1414
"""

box_sdk_gen/schemas/v2025_r0/hub_collaboration_v2025_r0.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -156,7 +156,7 @@ def __init__(
156156
:type id: str
157157
:param type: The value will always be `hub_collaboration`., defaults to HubCollaborationV2025R0TypeField.HUB_COLLABORATION
158158
:type type: HubCollaborationV2025R0TypeField, optional
159-
:param role: The level of access granted to hub.
159+
:param role: The level of access granted to a Box Hub.
160160
Possible values are `editor`, `viewer`, and `co-owner`., defaults to None
161161
:type role: Optional[str], optional
162162
:param status: The status of the collaboration invitation. If the status

box_sdk_gen/schemas/v2025_r0/hub_collaborations_v2025_r0.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ def __init__(
2121
**kwargs
2222
):
2323
"""
24-
:param entries: A list of hub collaborations., defaults to None
24+
:param entries: A list of Box Hub collaborations., defaults to None
2525
:type entries: Optional[List[HubCollaborationV2025R0]], optional
2626
:param limit: The limit that was used for these entries. This will be the same as the
2727
`limit` query parameter unless that value exceeded the maximum value

box_sdk_gen/schemas/v2025_r0/hub_copy_request_v2025_r0.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,9 @@ def __init__(
1414
**kwargs
1515
):
1616
"""
17-
:param title: Title of the Hub. It cannot be empty and should be less than 50 characters., defaults to None
17+
:param title: Title of the Box Hub. It cannot be empty and should be less than 50 characters., defaults to None
1818
:type title: Optional[str], optional
19-
:param description: Description of the Hub., defaults to None
19+
:param description: Description of the Box Hub., defaults to None
2020
:type description: Optional[str], optional
2121
"""
2222
super().__init__(**kwargs)

0 commit comments

Comments
 (0)