feat: Add Hub Document API (box/box-openapi#587)

Author: box-sdk-build

.codegen.json

@@ -1 +1 @@
-{ "engineHash": "bc04b80", "specHash": "f2523d5", "version": "10.6.0" }
+{ "engineHash": "bc04b80", "specHash": "57b3004", "version": "10.6.0" }

Box.Sdk.Gen.Net/Client/BoxClient.cs

@@ -167,6 +167,8 @@ public class BoxClient : IBoxClient {
 
         public IHubItemsManager HubItems { get; }
 
+        public IHubDocumentManager HubDocument { get; }
+
         public IShieldListsManager ShieldLists { get; }
 
         public IArchivesManager Archives { get; }
@@ -255,6 +257,7 @@ public BoxClient(IAuthentication auth, NetworkSession? networkSession = default)
             Hubs = new HubsManager(networkSession: this.NetworkSession) { Auth = this.Auth };
             HubCollaborations = new HubCollaborationsManager(networkSession: this.NetworkSession) { Auth = this.Auth };
             HubItems = new HubItemsManager(networkSession: this.NetworkSession) { Auth = this.Auth };
+            HubDocument = new HubDocumentManager(networkSession: this.NetworkSession) { Auth = this.Auth };
             ShieldLists = new ShieldListsManager(networkSession: this.NetworkSession) { Auth = this.Auth };
             Archives = new ArchivesManager(networkSession: this.NetworkSession) { Auth = this.Auth };
             ExternalUsers = new ExternalUsersManager(networkSession: this.NetworkSession) { Auth = this.Auth };

Box.Sdk.Gen.Net/Client/IBoxClient.cs

@@ -165,6 +165,8 @@ public interface IBoxClient {
 
         public IHubItemsManager HubItems { get => throw new System.NotImplementedException("This method needs to be implemented by the derived class before calling it."); }
 
+        public IHubDocumentManager HubDocument { get => throw new System.NotImplementedException("This method needs to be implemented by the derived class before calling it."); }
+
         public IShieldListsManager ShieldLists { get => throw new System.NotImplementedException("This method needs to be implemented by the derived class before calling it."); }
 
         public IArchivesManager Archives { get => throw new System.NotImplementedException("This method needs to be implemented by the derived class before calling it."); }

Box.Sdk.Gen.Net/Managers/HubDocument/GetHubDocumentBlocksV2025R0Headers.cs

@@ -0,0 +1,25 @@
+using Box.Sdk.Gen;
+using System.Collections.Generic;
+using System.Collections.ObjectModel;
+using Box.Sdk.Gen.Internal;
+using Box.Sdk.Gen.Schemas;
+using Box.Sdk.Gen.Parameters;
+
+namespace Box.Sdk.Gen.Managers {
+    public class GetHubDocumentBlocksV2025R0Headers {
+        /// <summary>
+        /// Version header.
+        /// </summary>
+        public StringEnum<BoxVersionHeaderV2025R0> BoxVersion { get; }
+
+        /// <summary>
+        /// Extra headers that will be included in the HTTP request.
+        /// </summary>
+        public Dictionary<string, string?> ExtraHeaders { get; }
+
+        public GetHubDocumentBlocksV2025R0Headers(BoxVersionHeaderV2025R0 boxVersion = BoxVersionHeaderV2025R0._20250, Dictionary<string, string?>? extraHeaders = default) {
+            BoxVersion = boxVersion;
+            ExtraHeaders = extraHeaders ?? new Dictionary<string, string?>() {  };
+        }
+    }
+}

Box.Sdk.Gen.Net/Managers/HubDocument/GetHubDocumentBlocksV2025R0QueryParams.cs

@@ -0,0 +1,42 @@
+using Box.Sdk.Gen;
+using System.Collections.Generic;
+using System.Collections.ObjectModel;
+using Box.Sdk.Gen.Internal;
+using Box.Sdk.Gen.Schemas;
+using Box.Sdk.Gen.Parameters;
+
+namespace Box.Sdk.Gen.Managers {
+    public class GetHubDocumentBlocksV2025R0QueryParams {
+        /// <summary>
+        /// 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`.
+        /// </summary>
+        public string HubId { get; }
+
+        /// <summary>
+        /// The unique identifier of a page within the Box Hub.
+        /// </summary>
+        public string PageId { get; }
+
+        /// <summary>
+        /// Defines the position marker at which to begin returning results. This is
+        /// used when paginating using marker-based pagination.
+        /// </summary>
+        public string? Marker { get; init; }
+
+        /// <summary>
+        /// The maximum number of items to return per page.
+        /// </summary>
+        public long? Limit { get; init; }
+
+        public GetHubDocumentBlocksV2025R0QueryParams(string hubId, string pageId) {
+            HubId = hubId;
+            PageId = pageId;
+        }
+    }
+}

Box.Sdk.Gen.Net/Managers/HubDocument/GetHubDocumentPagesV2025R0Headers.cs

@@ -0,0 +1,25 @@
+using Box.Sdk.Gen;
+using System.Collections.Generic;
+using System.Collections.ObjectModel;
+using Box.Sdk.Gen.Internal;
+using Box.Sdk.Gen.Schemas;
+using Box.Sdk.Gen.Parameters;
+
+namespace Box.Sdk.Gen.Managers {
+    public class GetHubDocumentPagesV2025R0Headers {
+        /// <summary>
+        /// Version header.
+        /// </summary>
+        public StringEnum<BoxVersionHeaderV2025R0> BoxVersion { get; }
+
+        /// <summary>
+        /// Extra headers that will be included in the HTTP request.
+        /// </summary>
+        public Dictionary<string, string?> ExtraHeaders { get; }
+
+        public GetHubDocumentPagesV2025R0Headers(BoxVersionHeaderV2025R0 boxVersion = BoxVersionHeaderV2025R0._20250, Dictionary<string, string?>? extraHeaders = default) {
+            BoxVersion = boxVersion;
+            ExtraHeaders = extraHeaders ?? new Dictionary<string, string?>() {  };
+        }
+    }
+}

Box.Sdk.Gen.Net/Managers/HubDocument/GetHubDocumentPagesV2025R0QueryParams.cs

@@ -0,0 +1,36 @@
+using Box.Sdk.Gen;
+using System.Collections.Generic;
+using System.Collections.ObjectModel;
+using Box.Sdk.Gen.Internal;
+using Box.Sdk.Gen.Schemas;
+using Box.Sdk.Gen.Parameters;
+
+namespace Box.Sdk.Gen.Managers {
+    public class GetHubDocumentPagesV2025R0QueryParams {
+        /// <summary>
+        /// 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`.
+        /// </summary>
+        public string HubId { get; }
+
+        /// <summary>
+        /// Defines the position marker at which to begin returning results. This is
+        /// used when paginating using marker-based pagination.
+        /// </summary>
+        public string? Marker { get; init; }
+
+        /// <summary>
+        /// The maximum number of items to return per page.
+        /// </summary>
+        public long? Limit { get; init; }
+
+        public GetHubDocumentPagesV2025R0QueryParams(string hubId) {
+            HubId = hubId;
+        }
+    }
+}

Box.Sdk.Gen.Net/Managers/HubDocument/HubDocumentManager.cs

@@ -0,0 +1,62 @@
+using Box.Sdk.Gen;
+using System.Collections.Generic;
+using System.Collections.ObjectModel;
+using Box.Sdk.Gen.Internal;
+using Box.Sdk.Gen.Schemas;
+using Box.Sdk.Gen.Parameters;
+
+namespace Box.Sdk.Gen.Managers {
+    public class HubDocumentManager : IHubDocumentManager {
+        public IAuthentication? Auth { get; init; }
+
+        public NetworkSession NetworkSession { get; }
+
+        public HubDocumentManager(NetworkSession? networkSession = default) {
+            NetworkSession = networkSession ?? new NetworkSession();
+        }
+        /// <summary>
+        /// Retrieves a list of Hub Document Pages for the specified hub.
+        /// Includes both root-level pages and sub pages.
+        /// </summary>
+        /// <param name="queryParams">
+        /// Query parameters of getHubDocumentPagesV2025R0 method
+        /// </param>
+        /// <param name="headers">
+        /// Headers of getHubDocumentPagesV2025R0 method
+        /// </param>
+        /// <param name="cancellationToken">
+        /// Token used for request cancellation.
+        /// </param>
+        public async System.Threading.Tasks.Task<HubDocumentPagesV2025R0> GetHubDocumentPagesV2025R0Async(GetHubDocumentPagesV2025R0QueryParams queryParams, GetHubDocumentPagesV2025R0Headers? headers = default, System.Threading.CancellationToken? cancellationToken = null) {
+            headers = headers ?? new GetHubDocumentPagesV2025R0Headers();
+            Dictionary<string, string> queryParamsMap = Utils.PrepareParams(map: new Dictionary<string, string?>() { { "hub_id", StringUtils.ToStringRepresentation(queryParams.HubId) }, { "marker", StringUtils.ToStringRepresentation(queryParams.Marker) }, { "limit", StringUtils.ToStringRepresentation(queryParams.Limit) } });
+            Dictionary<string, string> headersMap = Utils.PrepareParams(map: DictionaryUtils.MergeDictionaries(new Dictionary<string, string?>() { { "box-version", StringUtils.ToStringRepresentation(headers.BoxVersion) } }, headers.ExtraHeaders));
+            FetchResponse response = await this.NetworkSession.NetworkClient.FetchAsync(options: new FetchOptions(url: string.Concat(this.NetworkSession.BaseUrls.BaseUrl, "/2.0/hub_document_pages"), method: "GET", responseFormat: Box.Sdk.Gen.ResponseFormat.Json) { Parameters = queryParamsMap, Headers = headersMap, Auth = this.Auth, NetworkSession = this.NetworkSession, CancellationToken = cancellationToken }).ConfigureAwait(false);
+            return SimpleJsonSerializer.Deserialize<HubDocumentPagesV2025R0>(NullableUtils.Unwrap(response.Data));
+        }
+
+        /// <summary>
+        /// 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.
+        /// </summary>
+        /// <param name="queryParams">
+        /// Query parameters of getHubDocumentBlocksV2025R0 method
+        /// </param>
+        /// <param name="headers">
+        /// Headers of getHubDocumentBlocksV2025R0 method
+        /// </param>
+        /// <param name="cancellationToken">
+        /// Token used for request cancellation.
+        /// </param>
+        public async System.Threading.Tasks.Task<HubDocumentBlocksV2025R0> GetHubDocumentBlocksV2025R0Async(GetHubDocumentBlocksV2025R0QueryParams queryParams, GetHubDocumentBlocksV2025R0Headers? headers = default, System.Threading.CancellationToken? cancellationToken = null) {
+            headers = headers ?? new GetHubDocumentBlocksV2025R0Headers();
+            Dictionary<string, string> queryParamsMap = Utils.PrepareParams(map: new Dictionary<string, string?>() { { "hub_id", StringUtils.ToStringRepresentation(queryParams.HubId) }, { "page_id", StringUtils.ToStringRepresentation(queryParams.PageId) }, { "marker", StringUtils.ToStringRepresentation(queryParams.Marker) }, { "limit", StringUtils.ToStringRepresentation(queryParams.Limit) } });
+            Dictionary<string, string> headersMap = Utils.PrepareParams(map: DictionaryUtils.MergeDictionaries(new Dictionary<string, string?>() { { "box-version", StringUtils.ToStringRepresentation(headers.BoxVersion) } }, headers.ExtraHeaders));
+            FetchResponse response = await this.NetworkSession.NetworkClient.FetchAsync(options: new FetchOptions(url: string.Concat(this.NetworkSession.BaseUrls.BaseUrl, "/2.0/hub_document_blocks"), method: "GET", responseFormat: Box.Sdk.Gen.ResponseFormat.Json) { Parameters = queryParamsMap, Headers = headersMap, Auth = this.Auth, NetworkSession = this.NetworkSession, CancellationToken = cancellationToken }).ConfigureAwait(false);
+            return SimpleJsonSerializer.Deserialize<HubDocumentBlocksV2025R0>(NullableUtils.Unwrap(response.Data));
+        }
+
+    }
+}

Box.Sdk.Gen.Net/Managers/HubDocument/IHubDocumentManager.cs

@@ -0,0 +1,43 @@
+using Box.Sdk.Gen;
+using System.Collections.Generic;
+using System.Collections.ObjectModel;
+using Box.Sdk.Gen.Internal;
+using Box.Sdk.Gen.Schemas;
+using Box.Sdk.Gen.Parameters;
+
+namespace Box.Sdk.Gen.Managers {
+    public interface IHubDocumentManager {
+        /// <summary>
+    /// Retrieves a list of Hub Document Pages for the specified hub.
+    /// Includes both root-level pages and sub pages.
+    /// </summary>
+    /// <param name="queryParams">
+    /// Query parameters of getHubDocumentPagesV2025R0 method
+    /// </param>
+    /// <param name="headers">
+    /// Headers of getHubDocumentPagesV2025R0 method
+    /// </param>
+    /// <param name="cancellationToken">
+    /// Token used for request cancellation.
+    /// </param>
+    public System.Threading.Tasks.Task<HubDocumentPagesV2025R0> GetHubDocumentPagesV2025R0Async(GetHubDocumentPagesV2025R0QueryParams queryParams, GetHubDocumentPagesV2025R0Headers? headers = default, System.Threading.CancellationToken? cancellationToken = null) => throw new System.NotImplementedException("This method needs to be implemented by the derived class before calling it.");
+
+        /// <summary>
+    /// 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.
+    /// </summary>
+    /// <param name="queryParams">
+    /// Query parameters of getHubDocumentBlocksV2025R0 method
+    /// </param>
+    /// <param name="headers">
+    /// Headers of getHubDocumentBlocksV2025R0 method
+    /// </param>
+    /// <param name="cancellationToken">
+    /// Token used for request cancellation.
+    /// </param>
+    public System.Threading.Tasks.Task<HubDocumentBlocksV2025R0> GetHubDocumentBlocksV2025R0Async(GetHubDocumentBlocksV2025R0QueryParams queryParams, GetHubDocumentBlocksV2025R0Headers? headers = default, System.Threading.CancellationToken? cancellationToken = null) => throw new System.NotImplementedException("This method needs to be implemented by the derived class before calling it.");
+
+    }
+}

Box.Sdk.Gen.Net/Schemas/V2025R0/HubCalloutBoxTextBlockV2025R0/HubCalloutBoxTextBlockV2025R0.cs

@@ -0,0 +1,50 @@
+using Box.Sdk.Gen;
+using System.Text.Json.Serialization;
+using Box.Sdk.Gen.Internal;
+using System.Collections.Generic;
+using Box.Sdk.Gen.Schemas;
+
+namespace Box.Sdk.Gen.Schemas {
+    public class HubCalloutBoxTextBlockV2025R0 : HubDocumentBlockV2025R0, ISerializable {
+        /// <summary>
+        /// The type of this block. The value is always `callout_box`.
+        /// </summary>
+        [JsonPropertyName("type")]
+        [JsonConverter(typeof(StringEnumConverter<HubCalloutBoxTextBlockV2025R0TypeField>))]
+        public StringEnum<HubCalloutBoxTextBlockV2025R0TypeField> Type { get; }
+
+        /// <summary>
+        /// Text content of the block. Includes rich text formatting.
+        /// </summary>
+        [JsonPropertyName("fragment")]
+        public string Fragment { get; }
+
+        public HubCalloutBoxTextBlockV2025R0(string id, string fragment, HubCalloutBoxTextBlockV2025R0TypeField type = HubCalloutBoxTextBlockV2025R0TypeField.CalloutBox) : base(id) {
+            Type = type;
+            Fragment = fragment;
+        }
+        
+        [JsonConstructorAttribute]
+        internal HubCalloutBoxTextBlockV2025R0(string id, string fragment, StringEnum<HubCalloutBoxTextBlockV2025R0TypeField> type) : base(id) {
+            Type = HubCalloutBoxTextBlockV2025R0TypeField.CalloutBox;
+            Fragment = fragment;
+        }
+        internal new string? RawJson { get; set; } = default;
+
+        void ISerializable.SetJson(string json) {
+            RawJson = json;
+        }
+
+        string? ISerializable.GetJson() {
+            return RawJson;
+        }
+
+        /// <summary>
+        /// Returns raw json response returned from the API.
+        /// </summary>
+        public new Dictionary<string, object?>? GetRawData() {
+            return SimpleJsonSerializer.GetAllFields(this);
+        }
+
+    }
+}