Skip to content

Commit e79c803

Browse files
fix: Brand Hubs as Box Hubs (box/box-openapi#553) (#1045)
1 parent 4978d91 commit e79c803

File tree

25 files changed

+152
-152
lines changed

25 files changed

+152
-152
lines changed

.codegen.json

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

BoxSdkGen/Sources/Managers/HubCollaborations/HubCollaborationsManager.swift

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ public class HubCollaborationsManager {
1010
self.networkSession = networkSession
1111
}
1212

13-
/// Retrieves all collaborations for a hub.
13+
/// Retrieves all collaborations for a Box Hub.
1414
///
1515
/// - Parameters:
1616
/// - queryParams: Query parameters of getHubCollaborationsV2025R0 method
@@ -24,7 +24,7 @@ public class HubCollaborationsManager {
2424
return try HubCollaborationsV2025R0.deserialize(from: response.data!)
2525
}
2626

27-
/// Adds a collaboration for a single user or a single group to a hub.
27+
/// Adds a collaboration for a single user or a single group to a Box Hub.
2828
///
2929
/// Collaborations can be created using email address, user IDs, or group IDs.
3030
///
@@ -39,7 +39,7 @@ public class HubCollaborationsManager {
3939
return try HubCollaborationV2025R0.deserialize(from: response.data!)
4040
}
4141

42-
/// Retrieves details for a hub collaboration by collaboration ID.
42+
/// Retrieves details for a Box Hub collaboration by collaboration ID.
4343
///
4444
/// - Parameters:
4545
/// - hubCollaborationId: The ID of the hub collaboration.
@@ -53,8 +53,8 @@ public class HubCollaborationsManager {
5353
return try HubCollaborationV2025R0.deserialize(from: response.data!)
5454
}
5555

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
///
5959
/// - Parameters:
6060
/// - hubCollaborationId: The ID of the hub collaboration.
@@ -69,7 +69,7 @@ public class HubCollaborationsManager {
6969
return try HubCollaborationV2025R0.deserialize(from: response.data!)
7070
}
7171

72-
/// Deletes a single hub collaboration.
72+
/// Deletes a single Box Hub collaboration.
7373
///
7474
/// - Parameters:
7575
/// - hubCollaborationId: The ID of the hub collaboration.

BoxSdkGen/Sources/Managers/HubItems/HubItemsManager.swift

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ public class HubItemsManager {
1010
self.networkSession = networkSession
1111
}
1212

13-
/// Retrieves all items associated with a Hub.
13+
/// Retrieves all items associated with a Box Hub.
1414
///
1515
/// - Parameters:
1616
/// - queryParams: Query parameters of getHubItemsV2025R0 method
@@ -24,7 +24,7 @@ public class HubItemsManager {
2424
return try HubItemsV2025R0.deserialize(from: response.data!)
2525
}
2626

27-
/// Adds and/or removes Hub items from a Hub.
27+
/// Adds and/or removes Box Hub items from a Box Hub.
2828
///
2929
/// - Parameters:
3030
/// - hubId: The unique identifier that represent a hub.

BoxSdkGen/Sources/Managers/Hubs/GetEnterpriseHubsV2025R0QueryParams.swift

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
import Foundation
22

33
public class GetEnterpriseHubsV2025R0QueryParams {
4-
/// The query string to search for hubs.
4+
/// The query string to search for Box Hubs.
55
public let query: String?
66

77
/// The field to sort results by.
@@ -24,7 +24,7 @@ public class GetEnterpriseHubsV2025R0QueryParams {
2424
/// Initializer for a GetEnterpriseHubsV2025R0QueryParams.
2525
///
2626
/// - Parameters:
27-
/// - query: The query string to search for hubs.
27+
/// - query: The query string to search for Box Hubs.
2828
/// - sort: The field to sort results by.
2929
/// Possible values include `name`, `updated_at`,
3030
/// `last_accessed_at`, `view_count`, and `relevance`.

BoxSdkGen/Sources/Managers/Hubs/GetHubsV2025R0QueryParams.swift

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
import Foundation
22

33
public class GetHubsV2025R0QueryParams {
4-
/// The query string to search for hubs.
4+
/// The query string to search for Box Hubs.
55
public let query: String?
66

7-
/// The scope of the hubs to retrieve. Possible values include `editable`,
7+
/// The scope of the Box Hubs to retrieve. Possible values include `editable`,
88
/// `view_only`, and `all`. Default is `all`.
99
public let scope: String?
1010

@@ -28,8 +28,8 @@ public class GetHubsV2025R0QueryParams {
2828
/// Initializer for a GetHubsV2025R0QueryParams.
2929
///
3030
/// - Parameters:
31-
/// - query: The query string to search for hubs.
32-
/// - scope: The scope of the hubs to retrieve. Possible values include `editable`,
31+
/// - query: The query string to search for Box Hubs.
32+
/// - scope: The scope of the Box Hubs to retrieve. Possible values include `editable`,
3333
/// `view_only`, and `all`. Default is `all`.
3434
/// - sort: The field to sort results by.
3535
/// Possible values include `name`, `updated_at`,

BoxSdkGen/Sources/Managers/Hubs/HubsManager.swift

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ public class HubsManager {
1010
self.networkSession = networkSession
1111
}
1212

13-
/// Retrieves all hubs for requesting user.
13+
/// Retrieves all Box Hubs for requesting user.
1414
///
1515
/// - Parameters:
1616
/// - queryParams: Query parameters of getHubsV2025R0 method
@@ -24,7 +24,7 @@ public class HubsManager {
2424
return try HubsV2025R0.deserialize(from: response.data!)
2525
}
2626

27-
/// Creates a new Hub.
27+
/// Creates a new Box Hub.
2828
///
2929
/// - Parameters:
3030
/// - requestBody: Request body of createHubV2025R0 method
@@ -37,7 +37,7 @@ public class HubsManager {
3737
return try HubV2025R0.deserialize(from: response.data!)
3838
}
3939

40-
/// Retrieves all hubs for a given enterprise.
40+
/// Retrieves all Box Hubs for a given enterprise.
4141
///
4242
/// Admins or Hub Co-admins of an enterprise
4343
/// with GCM scope can make this call.
@@ -54,7 +54,7 @@ public class HubsManager {
5454
return try HubsV2025R0.deserialize(from: response.data!)
5555
}
5656

57-
/// Retrieves details for a hub by its ID.
57+
/// Retrieves details for a Box Hub by its ID.
5858
///
5959
/// - Parameters:
6060
/// - hubId: The unique identifier that represent a hub.
@@ -74,7 +74,7 @@ public class HubsManager {
7474
return try HubV2025R0.deserialize(from: response.data!)
7575
}
7676

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
///
7979
/// - Parameters:
8080
/// - hubId: The unique identifier that represent a hub.
@@ -95,7 +95,7 @@ public class HubsManager {
9595
return try HubV2025R0.deserialize(from: response.data!)
9696
}
9797

98-
/// Deletes a single hub.
98+
/// Deletes a single Box Hub.
9999
///
100100
/// - Parameters:
101101
/// - hubId: The unique identifier that represent a hub.
@@ -113,9 +113,9 @@ public class HubsManager {
113113
let response: FetchResponse = try await self.networkSession.networkClient.fetch(options: FetchOptions(url: "\(self.networkSession.baseUrls.baseUrl)\("/2.0/hubs/")\(hubId)", method: "DELETE", headers: headersMap, responseFormat: ResponseFormat.noContent, auth: self.auth, networkSession: self.networkSession))
114114
}
115115

116-
/// Creates a copy of a Hub.
116+
/// Creates a copy of a Box Hub.
117117
///
118-
/// The original Hub will not be modified.
118+
/// The original Box Hub will not be modified.
119119
///
120120
/// - Parameters:
121121
/// - hubId: The unique identifier that represent a hub.

BoxSdkGen/Sources/Schemas/V2025R0/HubBaseV2025R0/HubBaseV2025R0.swift

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
import Foundation
22

3-
/// The bare basic representation of a hub.
3+
/// The bare basic representation of a Box Hub.
44
public class HubBaseV2025R0: Codable, RawJSONReadable {
55
private enum CodingKeys: String, CodingKey {
66
case id
@@ -16,10 +16,10 @@ public class HubBaseV2025R0: Codable, RawJSONReadable {
1616
}
1717

1818

19-
/// The unique identifier that represent a hub.
19+
/// The unique identifier that represent a Box Hub.
2020
///
21-
/// The ID for any hub can be determined
22-
/// by visiting a hub in the web application
21+
/// The ID for any Box Hub can be determined
22+
/// by visiting a Box Hub in the web application
2323
/// and copying the ID from the URL. For example,
2424
/// for the URL `https://*.app.box.com/hubs/123`
2525
/// the `hub_id` is `123`.
@@ -31,10 +31,10 @@ public class HubBaseV2025R0: Codable, RawJSONReadable {
3131
/// Initializer for a HubBaseV2025R0.
3232
///
3333
/// - Parameters:
34-
/// - id: The unique identifier that represent a hub.
34+
/// - id: The unique identifier that represent a Box Hub.
3535
///
36-
/// The ID for any hub can be determined
37-
/// by visiting a hub in the web application
36+
/// The ID for any Box Hub can be determined
37+
/// by visiting a Box Hub in the web application
3838
/// and copying the ID from the URL. For example,
3939
/// for the URL `https://*.app.box.com/hubs/123`
4040
/// the `hub_id` is `123`.

BoxSdkGen/Sources/Schemas/V2025R0/HubCollaborationCreateRequestV2025R0/HubCollaborationCreateRequestV2025R0.swift

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
import Foundation
22

3-
/// Request body for creating a new Hub collaboration.
3+
/// Request body for creating a new Box Hub collaboration.
44
public class HubCollaborationCreateRequestV2025R0: Codable, RawJSONReadable {
55
private enum CodingKeys: String, CodingKey {
66
case hub
@@ -17,22 +17,22 @@ public class HubCollaborationCreateRequestV2025R0: Codable, RawJSONReadable {
1717
}
1818

1919

20-
/// Hubs reference.
20+
/// Box Hubs reference.
2121
public let hub: HubCollaborationCreateRequestV2025R0HubField
2222

2323
/// The user or group who gets access to the item.
2424
public let accessibleBy: HubCollaborationCreateRequestV2025R0AccessibleByField
2525

26-
/// The level of access granted to hub.
26+
/// The level of access granted to a Box Hub.
2727
/// Possible values are `editor`, `viewer`, and `co-owner`.
2828
public let role: String
2929

3030
/// Initializer for a HubCollaborationCreateRequestV2025R0.
3131
///
3232
/// - Parameters:
33-
/// - hub: Hubs reference.
33+
/// - hub: Box Hubs reference.
3434
/// - accessibleBy: The user or group who gets access to the item.
35-
/// - role: The level of access granted to hub.
35+
/// - role: The level of access granted to a Box Hub.
3636
/// Possible values are `editor`, `viewer`, and `co-owner`.
3737
public init(hub: HubCollaborationCreateRequestV2025R0HubField, accessibleBy: HubCollaborationCreateRequestV2025R0AccessibleByField, role: String) {
3838
self.hub = hub

BoxSdkGen/Sources/Schemas/V2025R0/HubCollaborationUpdateRequestV2025R0/HubCollaborationUpdateRequestV2025R0.swift

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
import Foundation
22

3-
/// Request body for updating an existing Hub collaboration.
3+
/// Request body for updating an existing Box Hub collaboration.
44
public class HubCollaborationUpdateRequestV2025R0: Codable, RawJSONReadable {
55
private enum CodingKeys: String, CodingKey {
66
case role
@@ -15,14 +15,14 @@ public class HubCollaborationUpdateRequestV2025R0: Codable, RawJSONReadable {
1515
}
1616

1717

18-
/// The level of access granted to hub.
18+
/// The level of access granted to a Box Hub.
1919
/// Possible values are `editor`, `viewer`, and `co-owner`.
2020
public let role: String?
2121

2222
/// Initializer for a HubCollaborationUpdateRequestV2025R0.
2323
///
2424
/// - Parameters:
25-
/// - role: The level of access granted to hub.
25+
/// - role: The level of access granted to a Box Hub.
2626
/// Possible values are `editor`, `viewer`, and `co-owner`.
2727
public init(role: String? = nil) {
2828
self.role = role

BoxSdkGen/Sources/Schemas/V2025R0/HubCollaborationV2025R0/HubCollaborationV2025R0.swift

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
import Foundation
22

3-
/// A hub collaboration object grants a user or group access
4-
/// to a hub with permissions defined by a specific role.
3+
/// A Box Hub collaboration object grants a user or group access
4+
/// to a Box Hub with permissions defined by a specific role.
55
public class HubCollaborationV2025R0: Codable, RawJSONReadable {
66
private enum CodingKeys: String, CodingKey {
77
case id
@@ -32,7 +32,7 @@ public class HubCollaborationV2025R0: Codable, RawJSONReadable {
3232

3333
public let accessibleBy: HubAccessGranteeV2025R0?
3434

35-
/// The level of access granted to hub.
35+
/// The level of access granted to a Box Hub.
3636
/// Possible values are `editor`, `viewer`, and `co-owner`.
3737
public let role: String?
3838

@@ -49,7 +49,7 @@ public class HubCollaborationV2025R0: Codable, RawJSONReadable {
4949
/// - type: The value will always be `hub_collaboration`.
5050
/// - hub:
5151
/// - accessibleBy:
52-
/// - role: The level of access granted to hub.
52+
/// - role: The level of access granted to a Box Hub.
5353
/// Possible values are `editor`, `viewer`, and `co-owner`.
5454
/// - status: The status of the collaboration invitation. If the status
5555
/// is `pending`, `login` and `name` return an empty string.

0 commit comments

Comments
 (0)