feat: Support Hub Document API (box/box-codegen#930) (#1443)

Author: box-sdk-build

.codegen.json

@@ -1 +1 @@
-{ "engineHash": "02fdae4", "specHash": "c8e3a85", "version": "10.5.0" }
+{ "engineHash": "e77f966", "specHash": "c8e3a85", "version": "10.5.0" }

BoxSdkGen/BoxSdkGen.xcodeproj/project.pbxproj

@@ -163,6 +163,8 @@ public class BoxClient {
 
     public let hubItems: HubItemsManager
 
+    public let hubDocument: HubDocumentManager
+
     public let shieldLists: ShieldListsManager
 
     public let archives: ArchivesManager
@@ -251,6 +253,7 @@ public class BoxClient {
         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.hubDocument = HubDocumentManager(auth: self.auth, networkSession: self.networkSession)
         self.shieldLists = ShieldListsManager(auth: self.auth, networkSession: self.networkSession)
         self.archives = ArchivesManager(auth: self.auth, networkSession: self.networkSession)
         self.externalUsers = ExternalUsersManager(auth: self.auth, networkSession: self.networkSession)

BoxSdkGen/Sources/Client/BoxClient.swift

@@ -0,0 +1,20 @@
+import Foundation
+
+public class GetHubDocumentBlocksV2025R0Headers {
+    /// Version header.
+    public let boxVersion: BoxVersionHeaderV2025R0
+
+    /// Extra headers that will be included in the HTTP request.
+    public let extraHeaders: [String: String?]?
+
+    /// Initializer for a GetHubDocumentBlocksV2025R0Headers.
+    ///
+    /// - 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
+    }
+
+}

BoxSdkGen/Sources/Managers/HubDocument/GetHubDocumentBlocksV2025R0Headers.swift

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

BoxSdkGen/Sources/Managers/HubDocument/GetHubDocumentBlocksV2025R0QueryParams.swift

@@ -0,0 +1,20 @@
+import Foundation
+
+public class GetHubDocumentPagesV2025R0Headers {
+    /// Version header.
+    public let boxVersion: BoxVersionHeaderV2025R0
+
+    /// Extra headers that will be included in the HTTP request.
+    public let extraHeaders: [String: String?]?
+
+    /// Initializer for a GetHubDocumentPagesV2025R0Headers.
+    ///
+    /// - 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
+    }
+
+}

BoxSdkGen/Sources/Managers/HubDocument/GetHubDocumentPagesV2025R0Headers.swift

@@ -0,0 +1,39 @@
+import Foundation
+
+public class GetHubDocumentPagesV2025R0QueryParams {
+    /// 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.
+    public let marker: String?
+
+    /// The maximum number of items to return per page.
+    public let limit: Int64?
+
+    /// Initializer for a GetHubDocumentPagesV2025R0QueryParams.
+    ///
+    /// - 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.
+    ///   - 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
+    }
+
+}

BoxSdkGen/Sources/Managers/HubDocument/GetHubDocumentPagesV2025R0QueryParams.swift

@@ -0,0 +1,45 @@
+import Foundation
+
+public class HubDocumentManager {
+    public let auth: Authentication?
+
+    public let networkSession: NetworkSession
+
+    public init(auth: Authentication? = nil, networkSession: NetworkSession = NetworkSession()) {
+        self.auth = auth
+        self.networkSession = networkSession
+    }
+
+    /// Retrieves a list of Hub Document Pages for the specified hub.
+    /// Includes both root-level pages and sub pages.
+    ///
+    /// - Parameters:
+    ///   - queryParams: Query parameters of getHubDocumentPagesV2025R0 method
+    ///   - headers: Headers of getHubDocumentPagesV2025R0 method
+    /// - Returns: The `HubDocumentPagesV2025R0`.
+    /// - Throws: The `GeneralError`.
+    public func getHubDocumentPagesV2025R0(queryParams: GetHubDocumentPagesV2025R0QueryParams, headers: GetHubDocumentPagesV2025R0Headers = GetHubDocumentPagesV2025R0Headers()) async throws -> HubDocumentPagesV2025R0 {
+        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_document_pages")", method: "GET", params: queryParamsMap, headers: headersMap, responseFormat: ResponseFormat.json, auth: self.auth, networkSession: self.networkSession))
+        return try HubDocumentPagesV2025R0.deserialize(from: response.data!)
+    }
+
+    /// Retrieves a sorted list of all Hub Document Blocks on a specified page in the hub document, excluding items.
+    /// Blocks are hierarchically organized by their `parent_id`.
+    /// Blocks are sorted in order based on user specification in the user interface.
+    /// The response will only include content blocks that belong to the specified page. This will not include sub pages or sub page content blocks.
+    ///
+    /// - Parameters:
+    ///   - queryParams: Query parameters of getHubDocumentBlocksV2025R0 method
+    ///   - headers: Headers of getHubDocumentBlocksV2025R0 method
+    /// - Returns: The `HubDocumentBlocksV2025R0`.
+    /// - Throws: The `GeneralError`.
+    public func getHubDocumentBlocksV2025R0(queryParams: GetHubDocumentBlocksV2025R0QueryParams, headers: GetHubDocumentBlocksV2025R0Headers = GetHubDocumentBlocksV2025R0Headers()) async throws -> HubDocumentBlocksV2025R0 {
+        let queryParamsMap: [String: String] = Utils.Dictionary.prepareParams(map: ["hub_id": Utils.Strings.toString(value: queryParams.hubId), "page_id": Utils.Strings.toString(value: queryParams.pageId), "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_document_blocks")", method: "GET", params: queryParamsMap, headers: headersMap, responseFormat: ResponseFormat.json, auth: self.auth, networkSession: self.networkSession))
+        return try HubDocumentBlocksV2025R0.deserialize(from: response.data!)
+    }
+
+}

BoxSdkGen/Sources/Managers/HubDocument/HubDocumentManager.swift

@@ -0,0 +1,68 @@
+import Foundation
+
+/// A callout box block in the Box Hub Document.
+public class HubCalloutBoxTextBlockV2025R0: HubDocumentBlockV2025R0 {
+    private enum CodingKeys: String, CodingKey {
+        case fragment
+        case type
+    }
+
+    /// Internal backing store for rawData. Used to store raw dictionary data associated with the instance.
+    private var _rawData: [String: Any]?
+
+    /// Returns the raw dictionary data associated with the instance. This is a read-only property.
+    public override var rawData: [String: Any]? {
+        return _rawData
+    }
+
+
+    /// Text content of the block. Includes rich text formatting.
+    public let fragment: String
+
+    /// The type of this block. The value is always `callout_box`.
+    public let type: HubCalloutBoxTextBlockV2025R0TypeField
+
+    /// Initializer for a HubCalloutBoxTextBlockV2025R0.
+    ///
+    /// - Parameters:
+    ///   - id: The unique identifier for this block.
+    ///   - fragment: Text content of the block. Includes rich text formatting.
+    ///   - parentId: The unique identifier of the parent block. Null for direct children of the page.
+    ///   - type: The type of this block. The value is always `callout_box`.
+    public init(id: String, fragment: String, parentId: TriStateField<String> = nil, type: HubCalloutBoxTextBlockV2025R0TypeField = HubCalloutBoxTextBlockV2025R0TypeField.calloutBox) {
+        self.fragment = fragment
+        self.type = type
+
+        super.init(id: id, parentId: parentId)
+    }
+
+    required public init(from decoder: Decoder) throws {
+        let container = try decoder.container(keyedBy: CodingKeys.self)
+        fragment = try container.decode(String.self, forKey: .fragment)
+        type = try container.decode(HubCalloutBoxTextBlockV2025R0TypeField.self, forKey: .type)
+
+        try super.init(from: decoder)
+    }
+
+    public override func encode(to encoder: Encoder) throws {
+        var container = encoder.container(keyedBy: CodingKeys.self)
+        try container.encode(fragment, forKey: .fragment)
+        try container.encode(type, forKey: .type)
+        try super.encode(to: encoder)
+    }
+
+    /// Sets the raw JSON data.
+    ///
+    /// - Parameters:
+    ///   - rawData: A dictionary containing the raw JSON data
+    override func setRawData(rawData: [String: Any]?) {
+        self._rawData = rawData
+    }
+
+    /// Gets the raw JSON data
+    /// - Returns: The `[String: Any]?`.
+    override func getRawData() -> [String: Any]? {
+        return self._rawData
+    }
+
+}

BoxSdkGen/Sources/Schemas/V2025R0/HubCalloutBoxTextBlockV2025R0/HubCalloutBoxTextBlockV2025R0.swift

@@ -0,0 +1,25 @@
+import Foundation
+
+public enum HubCalloutBoxTextBlockV2025R0TypeField: CodableStringEnum {
+    case calloutBox
+    case customValue(String)
+
+    public init(rawValue value: String) {
+        switch value.lowercased() {
+        case "callout_box".lowercased():
+            self = .calloutBox
+        default:
+            self = .customValue(value)
+        }
+    }
+
+    public var rawValue: String {
+        switch self {
+        case .calloutBox:
+            return "callout_box"
+        case .customValue(let value):
+            return value
+        }
+    }
+
+}