feat: Add new Hubs APIs and Hubs items API (box/box-openapi#538) (#503)

Co-authored-by: box-sdk-build <box-sdk-build@box.com>

Author: box-sdk-build

.codegen.json

@@ -1 +1 @@
-{ "engineHash": "fe7a2b2", "specHash": "719cda2", "version": "0.6.1" }
+{ "engineHash": "fe7a2b2", "specHash": "7871ded", "version": "0.6.1" }

BoxSdkGen.xcodeproj/project.pbxproj

@@ -157,6 +157,8 @@ public class BoxClient {
 
     public let hubCollaborations: HubCollaborationsManager
 
+    public let hubItems: HubItemsManager
+
     public let shieldLists: ShieldListsManager
 
     public init(auth: Authentication, networkSession: NetworkSession = NetworkSession(baseUrls: BaseUrls())) {
@@ -238,6 +240,7 @@ public class BoxClient {
         self.docgen = DocgenManager(auth: self.auth, networkSession: self.networkSession)
         self.hubs = HubsManager(auth: self.auth, networkSession: self.networkSession)
         self.hubCollaborations = HubCollaborationsManager(auth: self.auth, networkSession: self.networkSession)
+        self.hubItems = HubItemsManager(auth: self.auth, networkSession: self.networkSession)
         self.shieldLists = ShieldListsManager(auth: self.auth, networkSession: self.networkSession)
     }
 

Sources/Client/BoxClient.swift

@@ -0,0 +1,20 @@
+import Foundation
+
+public class CreateHubManageItemV2025R0Headers {
+    /// Version header.
+    public let boxVersion: BoxVersionHeaderV2025R0
+
+    /// Extra headers that will be included in the HTTP request.
+    public let extraHeaders: [String: String?]?
+
+    /// Initializer for a CreateHubManageItemV2025R0Headers.
+    ///
+    /// - Parameters:
+    ///   - boxVersion: Version header.
+    ///   - extraHeaders: Extra headers that will be included in the HTTP request.
+    public init(boxVersion: BoxVersionHeaderV2025R0 = BoxVersionHeaderV2025R0._20250, extraHeaders: [String: String?]? = [:]) {
+        self.boxVersion = boxVersion
+        self.extraHeaders = extraHeaders
+    }
+
+}

Sources/Managers/HubItems/CreateHubManageItemV2025R0Headers.swift

@@ -0,0 +1,20 @@
+import Foundation
+
+public class GetHubItemsV2025R0Headers {
+    /// Version header.
+    public let boxVersion: BoxVersionHeaderV2025R0
+
+    /// Extra headers that will be included in the HTTP request.
+    public let extraHeaders: [String: String?]?
+
+    /// Initializer for a GetHubItemsV2025R0Headers.
+    ///
+    /// - Parameters:
+    ///   - boxVersion: Version header.
+    ///   - extraHeaders: Extra headers that will be included in the HTTP request.
+    public init(boxVersion: BoxVersionHeaderV2025R0 = BoxVersionHeaderV2025R0._20250, extraHeaders: [String: String?]? = [:]) {
+        self.boxVersion = boxVersion
+        self.extraHeaders = extraHeaders
+    }
+
+}

Sources/Managers/HubItems/GetHubItemsV2025R0Headers.swift

@@ -0,0 +1,43 @@
+import Foundation
+
+public class GetHubItemsV2025R0QueryParams {
+    /// 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`.
+    public let hubId: String
+
+    /// Defines the position marker at which to begin returning results. This is
+    /// used when paginating using marker-based pagination.
+    /// 
+    /// This requires `usemarker` to be set to `true`.
+    public let marker: String?
+
+    /// The maximum number of items to return per page.
+    public let limit: Int64?
+
+    /// Initializer for a GetHubItemsV2025R0QueryParams.
+    ///
+    /// - Parameters:
+    ///   - hubId: 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`.
+    ///   - marker: Defines the position marker at which to begin returning results. This is
+    ///     used when paginating using marker-based pagination.
+    ///     
+    ///     This requires `usemarker` to be set to `true`.
+    ///   - limit: The maximum number of items to return per page.
+    public init(hubId: String, marker: String? = nil, limit: Int64? = nil) {
+        self.hubId = hubId
+        self.marker = marker
+        self.limit = limit
+    }
+
+}

Sources/Managers/HubItems/GetHubItemsV2025R0QueryParams.swift

@@ -0,0 +1,48 @@
+import Foundation
+
+public class HubItemsManager {
+    public let auth: Authentication?
+
+    public let networkSession: NetworkSession
+
+    public init(auth: Authentication? = nil, networkSession: NetworkSession = NetworkSession()) {
+        self.auth = auth
+        self.networkSession = networkSession
+    }
+
+    /// Retrieves all items associated with a Hub.
+    ///
+    /// - Parameters:
+    ///   - queryParams: Query parameters of getHubItemsV2025R0 method
+    ///   - headers: Headers of getHubItemsV2025R0 method
+    /// - Returns: The `HubItemsV2025R0`.
+    /// - Throws: The `GeneralError`.
+    public func getHubItemsV2025R0(queryParams: GetHubItemsV2025R0QueryParams, headers: GetHubItemsV2025R0Headers = GetHubItemsV2025R0Headers()) async throws -> HubItemsV2025R0 {
+        let queryParamsMap: [String: String] = Utils.Dictionary.prepareParams(map: ["hub_id": Utils.Strings.toString(value: queryParams.hubId), "marker": Utils.Strings.toString(value: queryParams.marker), "limit": Utils.Strings.toString(value: queryParams.limit)])
+        let headersMap: [String: String] = Utils.Dictionary.prepareParams(map: Utils.Dictionary.merge(["box-version": Utils.Strings.toString(value: headers.boxVersion)], headers.extraHeaders))
+        let response: FetchResponse = try await self.networkSession.networkClient.fetch(options: FetchOptions(url: "\(self.networkSession.baseUrls.baseUrl)\("/2.0/hub_items")", method: "GET", params: queryParamsMap, headers: headersMap, responseFormat: ResponseFormat.json, auth: self.auth, networkSession: self.networkSession))
+        return try HubItemsV2025R0.deserialize(from: response.data!)
+    }
+
+    /// Adds and/or removes Hub items from a Hub.
+    ///
+    /// - Parameters:
+    ///   - hubId: 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"
+    ///   - requestBody: Request body of createHubManageItemV2025R0 method
+    ///   - headers: Headers of createHubManageItemV2025R0 method
+    /// - Returns: The `HubItemsManageResponseV2025R0`.
+    /// - Throws: The `GeneralError`.
+    public func createHubManageItemV2025R0(hubId: String, requestBody: HubItemsManageRequestV2025R0, headers: CreateHubManageItemV2025R0Headers = CreateHubManageItemV2025R0Headers()) async throws -> HubItemsManageResponseV2025R0 {
+        let headersMap: [String: String] = Utils.Dictionary.prepareParams(map: Utils.Dictionary.merge(["box-version": Utils.Strings.toString(value: headers.boxVersion)], headers.extraHeaders))
+        let response: FetchResponse = try await self.networkSession.networkClient.fetch(options: FetchOptions(url: "\(self.networkSession.baseUrls.baseUrl)\("/2.0/hubs/")\(hubId)\("/manage_items")", method: "POST", headers: headersMap, data: try requestBody.serialize(), contentType: "application/json", responseFormat: ResponseFormat.json, auth: self.auth, networkSession: self.networkSession))
+        return try HubItemsManageResponseV2025R0.deserialize(from: response.data!)
+    }
+
+}

Sources/Managers/HubItems/HubItemsManager.swift

@@ -0,0 +1,20 @@
+import Foundation
+
+public class CreateHubCopyV2025R0Headers {
+    /// Version header.
+    public let boxVersion: BoxVersionHeaderV2025R0
+
+    /// Extra headers that will be included in the HTTP request.
+    public let extraHeaders: [String: String?]?
+
+    /// Initializer for a CreateHubCopyV2025R0Headers.
+    ///
+    /// - Parameters:
+    ///   - boxVersion: Version header.
+    ///   - extraHeaders: Extra headers that will be included in the HTTP request.
+    public init(boxVersion: BoxVersionHeaderV2025R0 = BoxVersionHeaderV2025R0._20250, extraHeaders: [String: String?]? = [:]) {
+        self.boxVersion = boxVersion
+        self.extraHeaders = extraHeaders
+    }
+
+}

Sources/Managers/Hubs/CreateHubCopyV2025R0Headers.swift

@@ -0,0 +1,20 @@
+import Foundation
+
+public class CreateHubV2025R0Headers {
+    /// Version header.
+    public let boxVersion: BoxVersionHeaderV2025R0
+
+    /// Extra headers that will be included in the HTTP request.
+    public let extraHeaders: [String: String?]?
+
+    /// Initializer for a CreateHubV2025R0Headers.
+    ///
+    /// - Parameters:
+    ///   - boxVersion: Version header.
+    ///   - extraHeaders: Extra headers that will be included in the HTTP request.
+    public init(boxVersion: BoxVersionHeaderV2025R0 = BoxVersionHeaderV2025R0._20250, extraHeaders: [String: String?]? = [:]) {
+        self.boxVersion = boxVersion
+        self.extraHeaders = extraHeaders
+    }
+
+}

Sources/Managers/Hubs/CreateHubV2025R0Headers.swift

@@ -24,6 +24,19 @@ public class HubsManager {
         return try HubsV2025R0.deserialize(from: response.data!)
     }
 
+    /// Creates a new Hub.
+    ///
+    /// - Parameters:
+    ///   - requestBody: Request body of createHubV2025R0 method
+    ///   - headers: Headers of createHubV2025R0 method
+    /// - Returns: The `HubV2025R0`.
+    /// - Throws: The `GeneralError`.
+    public func createHubV2025R0(requestBody: HubCreateRequestV2025R0, headers: CreateHubV2025R0Headers = CreateHubV2025R0Headers()) async throws -> HubV2025R0 {
+        let headersMap: [String: String] = Utils.Dictionary.prepareParams(map: Utils.Dictionary.merge(["box-version": Utils.Strings.toString(value: headers.boxVersion)], headers.extraHeaders))
+        let response: FetchResponse = try await self.networkSession.networkClient.fetch(options: FetchOptions(url: "\(self.networkSession.baseUrls.baseUrl)\("/2.0/hubs")", method: "POST", headers: headersMap, data: try requestBody.serialize(), contentType: "application/json", responseFormat: ResponseFormat.json, auth: self.auth, networkSession: self.networkSession))
+        return try HubV2025R0.deserialize(from: response.data!)
+    }
+
     /// Retrieves all hubs for a given enterprise.
     /// 
     /// Admins or Hub Co-admins of an enterprise
@@ -61,6 +74,27 @@ public class HubsManager {
         return try HubV2025R0.deserialize(from: response.data!)
     }
 
+    /// Updates a Hub. Can be used to change title, description, or Hub settings.
+    ///
+    /// - Parameters:
+    ///   - hubId: 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"
+    ///   - requestBody: Request body of updateHubByIdV2025R0 method
+    ///   - headers: Headers of updateHubByIdV2025R0 method
+    /// - Returns: The `HubV2025R0`.
+    /// - Throws: The `GeneralError`.
+    public func updateHubByIdV2025R0(hubId: String, requestBody: HubUpdateRequestV2025R0, headers: UpdateHubByIdV2025R0Headers = UpdateHubByIdV2025R0Headers()) async throws -> HubV2025R0 {
+        let headersMap: [String: String] = Utils.Dictionary.prepareParams(map: Utils.Dictionary.merge(["box-version": Utils.Strings.toString(value: headers.boxVersion)], headers.extraHeaders))
+        let response: FetchResponse = try await self.networkSession.networkClient.fetch(options: FetchOptions(url: "\(self.networkSession.baseUrls.baseUrl)\("/2.0/hubs/")\(hubId)", method: "PUT", headers: headersMap, data: try requestBody.serialize(), contentType: "application/json", responseFormat: ResponseFormat.json, auth: self.auth, networkSession: self.networkSession))
+        return try HubV2025R0.deserialize(from: response.data!)
+    }
+
     /// Deletes a single hub.
     ///
     /// - Parameters:
@@ -79,4 +113,27 @@ public class HubsManager {
         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))
     }
 
+    /// Creates a copy of a Hub.
+    /// 
+    /// The original Hub will not be modified.
+    ///
+    /// - Parameters:
+    ///   - hubId: 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"
+    ///   - requestBody: Request body of createHubCopyV2025R0 method
+    ///   - headers: Headers of createHubCopyV2025R0 method
+    /// - Returns: The `HubV2025R0`.
+    /// - Throws: The `GeneralError`.
+    public func createHubCopyV2025R0(hubId: String, requestBody: HubCopyRequestV2025R0, headers: CreateHubCopyV2025R0Headers = CreateHubCopyV2025R0Headers()) async throws -> HubV2025R0 {
+        let headersMap: [String: String] = Utils.Dictionary.prepareParams(map: Utils.Dictionary.merge(["box-version": Utils.Strings.toString(value: headers.boxVersion)], headers.extraHeaders))
+        let response: FetchResponse = try await self.networkSession.networkClient.fetch(options: FetchOptions(url: "\(self.networkSession.baseUrls.baseUrl)\("/2.0/hubs/")\(hubId)\("/copy")", method: "POST", headers: headersMap, data: try requestBody.serialize(), contentType: "application/json", responseFormat: ResponseFormat.json, auth: self.auth, networkSession: self.networkSession))
+        return try HubV2025R0.deserialize(from: response.data!)
+    }
+
 }