feat(boxsdkgen): Support new Hub Document API (box/box-codegen#930) (#1756)

Author: box-sdk-build

.codegen.json

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

docs/sdkgen/README.md

@@ -48,6 +48,7 @@ the SDK are available by topic:
 * [Folderwatermarks](folderwatermarks.md)
 * [Groups](groups.md)
 * [Hubcollaborations](hubcollaborations.md)
+* [Hubdocument](hubdocument.md)
 * [Hubitems](hubitems.md)
 * [Hubs](hubs.md)
 * [Integrationmappings](integrationmappings.md)

docs/sdkgen/hubdocument.md

@@ -0,0 +1,69 @@
+# HubDocumentManager
+
+
+- [List Hub Document Pages](#list-hub-document-pages)
+- [List Hub Document blocks for page](#list-hub-document-blocks-for-page)
+
+## List Hub Document Pages
+
+Retrieves a list of Hub Document Pages for the specified hub.
+Includes both root-level pages and sub pages.
+
+This operation is performed by calling function `getHubDocumentPagesV2025R0`.
+
+See the endpoint docs at
+[API Reference](https://developer.box.com/reference/v2025.0/get-hub-document-pages/).
+
+<!-- sample get_hub_document_pages_v2025.0 -->
+```
+client.getHubDocument().getHubDocumentPagesV2025R0(new GetHubDocumentPagesV2025R0QueryParams(hubId))
+```
+
+### Arguments
+
+- queryParams `GetHubDocumentPagesV2025R0QueryParams`
+  - Query parameters of getHubDocumentPagesV2025R0 method
+- headers `GetHubDocumentPagesV2025R0Headers`
+  - Headers of getHubDocumentPagesV2025R0 method
+
+
+### Returns
+
+This function returns a value of type `HubDocumentPagesV2025R0`.
+
+Returns a Hub Document Pages response whose `entries` array contains root-level pages and sub pages. Includes pagination when more results are available.
+
+
+## List Hub Document blocks for page
+
+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.
+
+This operation is performed by calling function `getHubDocumentBlocksV2025R0`.
+
+See the endpoint docs at
+[API Reference](https://developer.box.com/reference/v2025.0/get-hub-document-blocks/).
+
+<!-- sample get_hub_document_blocks_v2025.0 -->
+```
+client.getHubDocument().getHubDocumentBlocksV2025R0(new GetHubDocumentBlocksV2025R0QueryParams(hubId, pageId))
+```
+
+### Arguments
+
+- queryParams `GetHubDocumentBlocksV2025R0QueryParams`
+  - Query parameters of getHubDocumentBlocksV2025R0 method
+- headers `GetHubDocumentBlocksV2025R0Headers`
+  - Headers of getHubDocumentBlocksV2025R0 method
+
+
+### Returns
+
+This function returns a value of type `HubDocumentBlocksV2025R0`.
+
+Returns a Hub Document Blocks response whose `entries` array contains all content blocks of the specified page, except for items.
+To retrieve items, use the `GET /hub_items` endpoint.
+
+

src/intTest/java/com/box/sdkgen/hubdocument/HubDocumentITest.java

@@ -0,0 +1,48 @@
+package com.box.sdkgen.hubdocument;
+
+import static com.box.sdkgen.commons.CommonsManager.getDefaultClientWithUserSubject;
+import static com.box.sdkgen.internal.utils.UtilsManager.convertToString;
+import static com.box.sdkgen.internal.utils.UtilsManager.getEnvVar;
+import static com.box.sdkgen.internal.utils.UtilsManager.getUuid;
+
+import com.box.sdkgen.client.BoxClient;
+import com.box.sdkgen.managers.hubdocument.GetHubDocumentBlocksV2025R0QueryParams;
+import com.box.sdkgen.managers.hubdocument.GetHubDocumentPagesV2025R0QueryParams;
+import com.box.sdkgen.schemas.v2025r0.hubcreaterequestv2025r0.HubCreateRequestV2025R0;
+import com.box.sdkgen.schemas.v2025r0.hubdocumentblockentryv2025r0.HubDocumentBlockEntryV2025R0;
+import com.box.sdkgen.schemas.v2025r0.hubdocumentblocksv2025r0.HubDocumentBlocksV2025R0;
+import com.box.sdkgen.schemas.v2025r0.hubdocumentpagesv2025r0.HubDocumentPagesV2025R0;
+import com.box.sdkgen.schemas.v2025r0.hubdocumentpagev2025r0.HubDocumentPageV2025R0;
+import com.box.sdkgen.schemas.v2025r0.hubv2025r0.HubV2025R0;
+import org.junit.jupiter.api.Test;
+
+public class HubDocumentITest {
+
+  private static final BoxClient client = getDefaultClientWithUserSubject(getEnvVar("USER_ID"));
+
+  @Test
+  public void testGetHubDocumentPagesAndBlocks() {
+    String hubTitle = getUuid();
+    HubV2025R0 createdHub =
+        client.getHubs().createHubV2025R0(new HubCreateRequestV2025R0(hubTitle));
+    String hubId = createdHub.getId();
+    HubDocumentPagesV2025R0 pages =
+        client
+            .getHubDocument()
+            .getHubDocumentPagesV2025R0(new GetHubDocumentPagesV2025R0QueryParams(hubId));
+    assert pages.getEntries().size() > 0;
+    assert convertToString(pages.getType()).equals("document_pages");
+    HubDocumentPageV2025R0 firstPage = pages.getEntries().get(0);
+    assert convertToString(firstPage.getType()).equals("page");
+    String pageId = firstPage.getId();
+    HubDocumentBlocksV2025R0 blocks =
+        client
+            .getHubDocument()
+            .getHubDocumentBlocksV2025R0(new GetHubDocumentBlocksV2025R0QueryParams(hubId, pageId));
+    assert convertToString(blocks.getType()).equals("document_blocks");
+    assert blocks.getEntries().size() > 0;
+    HubDocumentBlockEntryV2025R0 firstBlock = blocks.getEntries().get(0);
+    assert convertToString(firstBlock.getType()).equals("item_list");
+    client.getHubs().deleteHubByIdV2025R0(hubId);
+  }
+}

src/main/java/com/box/sdkgen/client/BoxClient.java

@@ -38,6 +38,7 @@
 import com.box.sdkgen.managers.folderwatermarks.FolderWatermarksManager;
 import com.box.sdkgen.managers.groups.GroupsManager;
 import com.box.sdkgen.managers.hubcollaborations.HubCollaborationsManager;
+import com.box.sdkgen.managers.hubdocument.HubDocumentManager;
 import com.box.sdkgen.managers.hubitems.HubItemsManager;
 import com.box.sdkgen.managers.hubs.HubsManager;
 import com.box.sdkgen.managers.integrationmappings.IntegrationMappingsManager;
@@ -261,6 +262,8 @@ public class BoxClient {
 
   public final HubItemsManager hubItems;
 
+  public final HubDocumentManager hubDocument;
+
   public final ShieldListsManager shieldLists;
 
   public final ArchivesManager archives;
@@ -598,6 +601,11 @@ public BoxClient(Authentication auth) {
             .build();
     this.hubItems =
         new HubItemsManager.Builder().auth(this.auth).networkSession(this.networkSession).build();
+    this.hubDocument =
+        new HubDocumentManager.Builder()
+            .auth(this.auth)
+            .networkSession(this.networkSession)
+            .build();
     this.shieldLists =
         new ShieldListsManager.Builder()
             .auth(this.auth)
@@ -943,6 +951,11 @@ protected BoxClient(Builder builder) {
             .build();
     this.hubItems =
         new HubItemsManager.Builder().auth(this.auth).networkSession(this.networkSession).build();
+    this.hubDocument =
+        new HubDocumentManager.Builder()
+            .auth(this.auth)
+            .networkSession(this.networkSession)
+            .build();
     this.shieldLists =
         new ShieldListsManager.Builder()
             .auth(this.auth)
@@ -1394,6 +1407,10 @@ public HubItemsManager getHubItems() {
     return hubItems;
   }
 
+  public HubDocumentManager getHubDocument() {
+    return hubDocument;
+  }
+
   public ShieldListsManager getShieldLists() {
     return shieldLists;
   }

src/main/java/com/box/sdkgen/managers/hubdocument/GetHubDocumentBlocksV2025R0Headers.java

@@ -0,0 +1,68 @@
+package com.box.sdkgen.managers.hubdocument;
+
+import static com.box.sdkgen.internal.utils.UtilsManager.mapOf;
+
+import com.box.sdkgen.parameters.v2025r0.boxversionheaderv2025r0.BoxVersionHeaderV2025R0;
+import com.box.sdkgen.serialization.json.EnumWrapper;
+import java.util.Map;
+
+public class GetHubDocumentBlocksV2025R0Headers {
+
+  /** Version header. */
+  public EnumWrapper<BoxVersionHeaderV2025R0> boxVersion;
+
+  /** Extra headers that will be included in the HTTP request. */
+  public Map<String, String> extraHeaders;
+
+  public GetHubDocumentBlocksV2025R0Headers() {
+    this.boxVersion = new EnumWrapper<BoxVersionHeaderV2025R0>(BoxVersionHeaderV2025R0._2025_0);
+    this.extraHeaders = mapOf();
+  }
+
+  protected GetHubDocumentBlocksV2025R0Headers(Builder builder) {
+    this.boxVersion = builder.boxVersion;
+    this.extraHeaders = builder.extraHeaders;
+  }
+
+  public EnumWrapper<BoxVersionHeaderV2025R0> getBoxVersion() {
+    return boxVersion;
+  }
+
+  public Map<String, String> getExtraHeaders() {
+    return extraHeaders;
+  }
+
+  public static class Builder {
+
+    protected EnumWrapper<BoxVersionHeaderV2025R0> boxVersion;
+
+    protected Map<String, String> extraHeaders;
+
+    public Builder() {}
+
+    public Builder boxVersion(BoxVersionHeaderV2025R0 boxVersion) {
+      this.boxVersion = new EnumWrapper<BoxVersionHeaderV2025R0>(boxVersion);
+      return this;
+    }
+
+    public Builder boxVersion(EnumWrapper<BoxVersionHeaderV2025R0> boxVersion) {
+      this.boxVersion = boxVersion;
+      return this;
+    }
+
+    public Builder extraHeaders(Map<String, String> extraHeaders) {
+      this.extraHeaders = extraHeaders;
+      return this;
+    }
+
+    public GetHubDocumentBlocksV2025R0Headers build() {
+      if (this.boxVersion == null) {
+        this.boxVersion = new EnumWrapper<BoxVersionHeaderV2025R0>(BoxVersionHeaderV2025R0._2025_0);
+      }
+      if (this.extraHeaders == null) {
+        this.extraHeaders = mapOf();
+      }
+      return new GetHubDocumentBlocksV2025R0Headers(this);
+    }
+  }
+}

src/main/java/com/box/sdkgen/managers/hubdocument/GetHubDocumentBlocksV2025R0QueryParams.java

@@ -0,0 +1,83 @@
+package com.box.sdkgen.managers.hubdocument;
+
+public class GetHubDocumentBlocksV2025R0QueryParams {
+
+  /**
+   * The unique identifier that represent a hub.
+   *
+   * <p>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 final String hubId;
+
+  /** The unique identifier of a page within the Box Hub. */
+  public final String pageId;
+
+  /**
+   * Defines the position marker at which to begin returning results. This is used when paginating
+   * using marker-based pagination.
+   */
+  public String marker;
+
+  /** The maximum number of items to return per page. */
+  public Long limit;
+
+  public GetHubDocumentBlocksV2025R0QueryParams(String hubId, String pageId) {
+    this.hubId = hubId;
+    this.pageId = pageId;
+  }
+
+  protected GetHubDocumentBlocksV2025R0QueryParams(Builder builder) {
+    this.hubId = builder.hubId;
+    this.pageId = builder.pageId;
+    this.marker = builder.marker;
+    this.limit = builder.limit;
+  }
+
+  public String getHubId() {
+    return hubId;
+  }
+
+  public String getPageId() {
+    return pageId;
+  }
+
+  public String getMarker() {
+    return marker;
+  }
+
+  public Long getLimit() {
+    return limit;
+  }
+
+  public static class Builder {
+
+    protected final String hubId;
+
+    protected final String pageId;
+
+    protected String marker;
+
+    protected Long limit;
+
+    public Builder(String hubId, String pageId) {
+      this.hubId = hubId;
+      this.pageId = pageId;
+    }
+
+    public Builder marker(String marker) {
+      this.marker = marker;
+      return this;
+    }
+
+    public Builder limit(Long limit) {
+      this.limit = limit;
+      return this;
+    }
+
+    public GetHubDocumentBlocksV2025R0QueryParams build() {
+      return new GetHubDocumentBlocksV2025R0QueryParams(this);
+    }
+  }
+}