Skip to content

Commit aa74ca7

Browse files
box-sdk-buildbox-sdk-build
authored
docs: Brand Hubs as Box Hubs (box/box-openapi#553) (#599)
1 parent 08ba0d7 commit aa74ca7

File tree

25 files changed

+116
-116
lines changed

25 files changed

+116
-116
lines changed

‎.codegen.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
{ "engineHash": "c0b8367", "specHash": "5bf3652", "version": "1.11.0" }
1+
{ "engineHash": "fa469c0", "specHash": "fcb097e", "version": "1.11.0" }

‎Box.Sdk.Gen/Managers/HubCollaborations/HubCollaborationsManager.cs

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ public HubCollaborationsManager(NetworkSession? networkSession = default) {
1515
NetworkSession = networkSession ?? new NetworkSession();
1616
}
1717
/// <summary>
18-
/// Retrieves all collaborations for a hub.
18+
/// Retrieves all collaborations for a Box Hub.
1919
/// </summary>
2020
/// <param name="queryParams">
2121
/// Query parameters of getHubCollaborationsV2025R0 method
@@ -35,7 +35,7 @@ public async System.Threading.Tasks.Task<HubCollaborationsV2025R0> GetHubCollabo
3535
}
3636

3737
/// <summary>
38-
/// Adds a collaboration for a single user or a single group to a hub.
38+
/// Adds a collaboration for a single user or a single group to a Box Hub.
3939
///
4040
/// Collaborations can be created using email address, user IDs, or group IDs.
4141
/// </summary>
@@ -56,7 +56,7 @@ public async System.Threading.Tasks.Task<HubCollaborationV2025R0> CreateHubColla
5656
}
5757

5858
/// <summary>
59-
/// Retrieves details for a hub collaboration by collaboration ID.
59+
/// Retrieves details for a Box Hub collaboration by collaboration ID.
6060
/// </summary>
6161
/// <param name="hubCollaborationId">
6262
/// The ID of the hub collaboration.
@@ -76,8 +76,8 @@ public async System.Threading.Tasks.Task<HubCollaborationV2025R0> GetHubCollabor
7676
}
7777

7878
/// <summary>
79-
/// Updates a hub collaboration.
80-
/// Can be used to change the hub role.
79+
/// Updates a Box Hub collaboration.
80+
/// Can be used to change the Box Hub role.
8181
/// </summary>
8282
/// <param name="hubCollaborationId">
8383
/// The ID of the hub collaboration.
@@ -100,7 +100,7 @@ public async System.Threading.Tasks.Task<HubCollaborationV2025R0> UpdateHubColla
100100
}
101101

102102
/// <summary>
103-
/// Deletes a single hub collaboration.
103+
/// Deletes a single Box Hub collaboration.
104104
/// </summary>
105105
/// <param name="hubCollaborationId">
106106
/// The ID of the hub collaboration.

‎Box.Sdk.Gen/Managers/HubCollaborations/IHubCollaborationsManager.cs

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
namespace Box.Sdk.Gen.Managers {
99
public interface IHubCollaborationsManager {
1010
/// <summary>
11-
/// Retrieves all collaborations for a hub.
11+
/// Retrieves all collaborations for a Box Hub.
1212
/// </summary>
1313
/// <param name="queryParams">
1414
/// Query parameters of getHubCollaborationsV2025R0 method
@@ -22,7 +22,7 @@ public interface IHubCollaborationsManager {
2222
public System.Threading.Tasks.Task<HubCollaborationsV2025R0> GetHubCollaborationsV2025R0Async(GetHubCollaborationsV2025R0QueryParams queryParams, GetHubCollaborationsV2025R0Headers? headers = default, System.Threading.CancellationToken? cancellationToken = null) => throw new System.NotImplementedException("This method needs to be implemented by the derived class before calling it.");
2323

2424
/// <summary>
25-
/// Adds a collaboration for a single user or a single group to a hub.
25+
/// Adds a collaboration for a single user or a single group to a Box Hub.
2626
///
2727
/// Collaborations can be created using email address, user IDs, or group IDs.
2828
/// </summary>
@@ -38,7 +38,7 @@ public interface IHubCollaborationsManager {
3838
public System.Threading.Tasks.Task<HubCollaborationV2025R0> CreateHubCollaborationV2025R0Async(HubCollaborationCreateRequestV2025R0 requestBody, CreateHubCollaborationV2025R0Headers? headers = default, System.Threading.CancellationToken? cancellationToken = null) => throw new System.NotImplementedException("This method needs to be implemented by the derived class before calling it.");
3939

4040
/// <summary>
41-
/// Retrieves details for a hub collaboration by collaboration ID.
41+
/// Retrieves details for a Box Hub collaboration by collaboration ID.
4242
/// </summary>
4343
/// <param name="hubCollaborationId">
4444
/// The ID of the hub collaboration.
@@ -53,8 +53,8 @@ public interface IHubCollaborationsManager {
5353
public System.Threading.Tasks.Task<HubCollaborationV2025R0> GetHubCollaborationByIdV2025R0Async(string hubCollaborationId, GetHubCollaborationByIdV2025R0Headers? headers = default, System.Threading.CancellationToken? cancellationToken = null) => throw new System.NotImplementedException("This method needs to be implemented by the derived class before calling it.");
5454

5555
/// <summary>
56-
/// Updates a hub collaboration.
57-
/// Can be used to change the hub role.
56+
/// Updates a Box Hub collaboration.
57+
/// Can be used to change the Box Hub role.
5858
/// </summary>
5959
/// <param name="hubCollaborationId">
6060
/// The ID of the hub collaboration.
@@ -72,7 +72,7 @@ public interface IHubCollaborationsManager {
7272
public System.Threading.Tasks.Task<HubCollaborationV2025R0> UpdateHubCollaborationByIdV2025R0Async(string hubCollaborationId, HubCollaborationUpdateRequestV2025R0 requestBody, UpdateHubCollaborationByIdV2025R0Headers? headers = default, System.Threading.CancellationToken? cancellationToken = null) => throw new System.NotImplementedException("This method needs to be implemented by the derived class before calling it.");
7373

7474
/// <summary>
75-
/// Deletes a single hub collaboration.
75+
/// Deletes a single Box Hub collaboration.
7676
/// </summary>
7777
/// <param name="hubCollaborationId">
7878
/// The ID of the hub collaboration.

‎Box.Sdk.Gen/Managers/HubItems/HubItemsManager.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ public HubItemsManager(NetworkSession? networkSession = default) {
1515
NetworkSession = networkSession ?? new NetworkSession();
1616
}
1717
/// <summary>
18-
/// Retrieves all items associated with a Hub.
18+
/// Retrieves all items associated with a Box Hub.
1919
/// </summary>
2020
/// <param name="queryParams">
2121
/// Query parameters of getHubItemsV2025R0 method
@@ -35,7 +35,7 @@ public async System.Threading.Tasks.Task<HubItemsV2025R0> GetHubItemsV2025R0Asyn
3535
}
3636

3737
/// <summary>
38-
/// Adds and/or removes Hub items from a Hub.
38+
/// Adds and/or removes Box Hub items from a Box Hub.
3939
/// </summary>
4040
/// <param name="hubId">
4141
/// The unique identifier that represent a hub.

‎Box.Sdk.Gen/Managers/HubItems/IHubItemsManager.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
namespace Box.Sdk.Gen.Managers {
99
public interface IHubItemsManager {
1010
/// <summary>
11-
/// Retrieves all items associated with a Hub.
11+
/// Retrieves all items associated with a Box Hub.
1212
/// </summary>
1313
/// <param name="queryParams">
1414
/// Query parameters of getHubItemsV2025R0 method
@@ -22,7 +22,7 @@ public interface IHubItemsManager {
2222
public System.Threading.Tasks.Task<HubItemsV2025R0> GetHubItemsV2025R0Async(GetHubItemsV2025R0QueryParams queryParams, GetHubItemsV2025R0Headers? headers = default, System.Threading.CancellationToken? cancellationToken = null) => throw new System.NotImplementedException("This method needs to be implemented by the derived class before calling it.");
2323

2424
/// <summary>
25-
/// Adds and/or removes Hub items from a Hub.
25+
/// Adds and/or removes Box Hub items from a Box Hub.
2626
/// </summary>
2727
/// <param name="hubId">
2828
/// The unique identifier that represent a hub.

‎Box.Sdk.Gen/Managers/Hubs/GetEnterpriseHubsV2025R0QueryParams.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
namespace Box.Sdk.Gen.Managers {
99
public class GetEnterpriseHubsV2025R0QueryParams {
1010
/// <summary>
11-
/// The query string to search for hubs.
11+
/// The query string to search for Box Hubs.
1212
/// </summary>
1313
public string? Query { get; init; }
1414

‎Box.Sdk.Gen/Managers/Hubs/GetHubsV2025R0QueryParams.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,12 +8,12 @@
88
namespace Box.Sdk.Gen.Managers {
99
public class GetHubsV2025R0QueryParams {
1010
/// <summary>
11-
/// The query string to search for hubs.
11+
/// The query string to search for Box Hubs.
1212
/// </summary>
1313
public string? Query { get; init; }
1414

1515
/// <summary>
16-
/// The scope of the hubs to retrieve. Possible values include `editable`,
16+
/// The scope of the Box Hubs to retrieve. Possible values include `editable`,
1717
/// `view_only`, and `all`. Default is `all`.
1818
/// </summary>
1919
public string? Scope { get; init; }

‎Box.Sdk.Gen/Managers/Hubs/HubsManager.cs

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ public HubsManager(NetworkSession? networkSession = default) {
1515
NetworkSession = networkSession ?? new NetworkSession();
1616
}
1717
/// <summary>
18-
/// Retrieves all hubs for requesting user.
18+
/// Retrieves all Box Hubs for requesting user.
1919
/// </summary>
2020
/// <param name="queryParams">
2121
/// Query parameters of getHubsV2025R0 method
@@ -36,7 +36,7 @@ public async System.Threading.Tasks.Task<HubsV2025R0> GetHubsV2025R0Async(GetHub
3636
}
3737

3838
/// <summary>
39-
/// Creates a new Hub.
39+
/// Creates a new Box Hub.
4040
/// </summary>
4141
/// <param name="requestBody">
4242
/// Request body of createHubV2025R0 method
@@ -55,7 +55,7 @@ public async System.Threading.Tasks.Task<HubV2025R0> CreateHubV2025R0Async(HubCr
5555
}
5656

5757
/// <summary>
58-
/// Retrieves all hubs for a given enterprise.
58+
/// Retrieves all Box Hubs for a given enterprise.
5959
///
6060
/// Admins or Hub Co-admins of an enterprise
6161
/// with GCM scope can make this call.
@@ -79,7 +79,7 @@ public async System.Threading.Tasks.Task<HubsV2025R0> GetEnterpriseHubsV2025R0As
7979
}
8080

8181
/// <summary>
82-
/// Retrieves details for a hub by its ID.
82+
/// Retrieves details for a Box Hub by its ID.
8383
/// </summary>
8484
/// <param name="hubId">
8585
/// The unique identifier that represent a hub.
@@ -105,7 +105,7 @@ public async System.Threading.Tasks.Task<HubV2025R0> GetHubByIdV2025R0Async(stri
105105
}
106106

107107
/// <summary>
108-
/// Updates a Hub. Can be used to change title, description, or Hub settings.
108+
/// Updates a Box Hub. Can be used to change title, description, or Box Hub settings.
109109
/// </summary>
110110
/// <param name="hubId">
111111
/// The unique identifier that represent a hub.
@@ -134,7 +134,7 @@ public async System.Threading.Tasks.Task<HubV2025R0> UpdateHubByIdV2025R0Async(s
134134
}
135135

136136
/// <summary>
137-
/// Deletes a single hub.
137+
/// Deletes a single Box Hub.
138138
/// </summary>
139139
/// <param name="hubId">
140140
/// The unique identifier that represent a hub.
@@ -159,9 +159,9 @@ public async System.Threading.Tasks.Task DeleteHubByIdV2025R0Async(string hubId,
159159
}
160160

161161
/// <summary>
162-
/// Creates a copy of a Hub.
162+
/// Creates a copy of a Box Hub.
163163
///
164-
/// The original Hub will not be modified.
164+
/// The original Box Hub will not be modified.
165165
/// </summary>
166166
/// <param name="hubId">
167167
/// The unique identifier that represent a hub.

‎Box.Sdk.Gen/Managers/Hubs/IHubsManager.cs

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
namespace Box.Sdk.Gen.Managers {
99
public interface IHubsManager {
1010
/// <summary>
11-
/// Retrieves all hubs for requesting user.
11+
/// Retrieves all Box Hubs for requesting user.
1212
/// </summary>
1313
/// <param name="queryParams">
1414
/// Query parameters of getHubsV2025R0 method
@@ -22,7 +22,7 @@ public interface IHubsManager {
2222
public System.Threading.Tasks.Task<HubsV2025R0> GetHubsV2025R0Async(GetHubsV2025R0QueryParams? queryParams = default, GetHubsV2025R0Headers? headers = default, System.Threading.CancellationToken? cancellationToken = null) => throw new System.NotImplementedException("This method needs to be implemented by the derived class before calling it.");
2323

2424
/// <summary>
25-
/// Creates a new Hub.
25+
/// Creates a new Box Hub.
2626
/// </summary>
2727
/// <param name="requestBody">
2828
/// Request body of createHubV2025R0 method
@@ -36,7 +36,7 @@ public interface IHubsManager {
3636
public System.Threading.Tasks.Task<HubV2025R0> CreateHubV2025R0Async(HubCreateRequestV2025R0 requestBody, CreateHubV2025R0Headers? headers = default, System.Threading.CancellationToken? cancellationToken = null) => throw new System.NotImplementedException("This method needs to be implemented by the derived class before calling it.");
3737

3838
/// <summary>
39-
/// Retrieves all hubs for a given enterprise.
39+
/// Retrieves all Box Hubs for a given enterprise.
4040
///
4141
/// Admins or Hub Co-admins of an enterprise
4242
/// with GCM scope can make this call.
@@ -53,7 +53,7 @@ public interface IHubsManager {
5353
public System.Threading.Tasks.Task<HubsV2025R0> GetEnterpriseHubsV2025R0Async(GetEnterpriseHubsV2025R0QueryParams? queryParams = default, GetEnterpriseHubsV2025R0Headers? headers = default, System.Threading.CancellationToken? cancellationToken = null) => throw new System.NotImplementedException("This method needs to be implemented by the derived class before calling it.");
5454

5555
/// <summary>
56-
/// Retrieves details for a hub by its ID.
56+
/// Retrieves details for a Box Hub by its ID.
5757
/// </summary>
5858
/// <param name="hubId">
5959
/// The unique identifier that represent a hub.
@@ -74,7 +74,7 @@ public interface IHubsManager {
7474
public System.Threading.Tasks.Task<HubV2025R0> GetHubByIdV2025R0Async(string hubId, GetHubByIdV2025R0Headers? headers = default, System.Threading.CancellationToken? cancellationToken = null) => throw new System.NotImplementedException("This method needs to be implemented by the derived class before calling it.");
7575

7676
/// <summary>
77-
/// Updates a Hub. Can be used to change title, description, or Hub settings.
77+
/// Updates a Box Hub. Can be used to change title, description, or Box Hub settings.
7878
/// </summary>
7979
/// <param name="hubId">
8080
/// The unique identifier that represent a hub.
@@ -98,7 +98,7 @@ public interface IHubsManager {
9898
public System.Threading.Tasks.Task<HubV2025R0> UpdateHubByIdV2025R0Async(string hubId, HubUpdateRequestV2025R0 requestBody, UpdateHubByIdV2025R0Headers? headers = default, System.Threading.CancellationToken? cancellationToken = null) => throw new System.NotImplementedException("This method needs to be implemented by the derived class before calling it.");
9999

100100
/// <summary>
101-
/// Deletes a single hub.
101+
/// Deletes a single Box Hub.
102102
/// </summary>
103103
/// <param name="hubId">
104104
/// The unique identifier that represent a hub.
@@ -119,9 +119,9 @@ public interface IHubsManager {
119119
public System.Threading.Tasks.Task DeleteHubByIdV2025R0Async(string hubId, DeleteHubByIdV2025R0Headers? headers = default, System.Threading.CancellationToken? cancellationToken = null) => throw new System.NotImplementedException("This method needs to be implemented by the derived class before calling it.");
120120

121121
/// <summary>
122-
/// Creates a copy of a Hub.
122+
/// Creates a copy of a Box Hub.
123123
///
124-
/// The original Hub will not be modified.
124+
/// The original Box Hub will not be modified.
125125
/// </summary>
126126
/// <param name="hubId">
127127
/// The unique identifier that represent a hub.

‎Box.Sdk.Gen/Schemas/V2025R0/HubBaseV2025R0/HubBaseV2025R0.cs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,10 @@
66
namespace Box.Sdk.Gen.Schemas {
77
public class HubBaseV2025R0 : ISerializable {
88
/// <summary>
9-
/// The unique identifier that represent a hub.
9+
/// The unique identifier that represent a Box Hub.
1010
///
11-
/// The ID for any hub can be determined
12-
/// by visiting a hub in the web application
11+
/// The ID for any Box Hub can be determined
12+
/// by visiting a Box Hub in the web application
1313
/// and copying the ID from the URL. For example,
1414
/// for the URL `https://*.app.box.com/hubs/123`
1515
/// the `hub_id` is `123`.

0 commit comments

Comments
 (0)