feat: add DocumentSplitManager and document_splits APIs (box/box-openapi#621)

.codegen.json

@@ -1 +1 @@
-{ "engineHash": "d55532c", "specHash": "e21eebc", "version": "10.20.0" }
+{ "engineHash": "d55532c", "specHash": "fcfcd5d", "version": "10.20.0" }

docs/README.md

@@ -29,6 +29,7 @@ the SDK are available by topic:
 * [Devicepinners](devicepinners.md)
 * [Docgen](docgen.md)
 * [Docgentemplate](docgentemplate.md)
+* [Documentsplit](documentsplit.md)
 * [Downloads](downloads.md)
 * [Emailaliases](emailaliases.md)
 * [Enterpriseconfigurations](enterpriseconfigurations.md)

docs/documentsplit.md

@@ -0,0 +1,101 @@
+# DocumentSplitManager
+
+
+- [Create Document Split job](#create-document-split-job)
+- [List Document Split jobs](#list-document-split-jobs)
+- [Get Document Split job by ID](#get-document-split-job-by-id)
+
+## Create Document Split job
+
+Initiates a Document Split job for the supplied source file. The job runs
+asynchronously; clients can poll the returned job ID to track progress.
+
+All split-specific input lives under `split_input`. When
+`split_input.split_type` is `manual`, provide
+`split_input.split_definition` (continuous page ranges; `version` may be
+omitted or `v_1`). When `split_input.split_type` is `page_selection`,
+provide `split_input.page_selection` (non-linear page segments; `version`
+may be omitted or `v_2`). `split_input.prompt` must not be provided for
+either of those variants. When `split_input.split_type` is `smart`,
+`split_input.prompt` is required and neither
+`split_input.split_definition` nor `split_input.page_selection` must be
+provided.
+
+This operation is performed by calling function `createDocumentSplitV2026R0`.
+
+See the endpoint docs at
+[API Reference](https://developer.box.com/reference/v2026.0/post-document-splits/).
+
+*Currently we don't have an example for calling `createDocumentSplitV2026R0` in integration tests*
+
+### Arguments
+
+- requestBody `DocumentSplitCreateRequestV2026R0`
+  - Request body of createDocumentSplitV2026R0 method
+- headers `CreateDocumentSplitV2026R0Headers`
+  - Headers of createDocumentSplitV2026R0 method
+
+
+### Returns
+
+This function returns a value of type `DocumentSplitCreateResponseV2026R0`.
+
+The Document Split job was accepted for processing. Returns a reference
+to the newly created job.
+
+
+## List Document Split jobs
+
+Returns a paginated list of Document Split jobs accessible to the
+authenticated user.
+
+This operation is performed by calling function `getDocumentSplitsV2026R0`.
+
+See the endpoint docs at
+[API Reference](https://developer.box.com/reference/v2026.0/get-document-splits/).
+
+*Currently we don't have an example for calling `getDocumentSplitsV2026R0` in integration tests*
+
+### Arguments
+
+- queryParams `GetDocumentSplitsV2026R0QueryParams`
+  - Query parameters of getDocumentSplitsV2026R0 method
+- headers `GetDocumentSplitsV2026R0Headers`
+  - Headers of getDocumentSplitsV2026R0 method
+
+
+### Returns
+
+This function returns a value of type `DocumentSplitsV2026R0`.
+
+Returns a paginated list of Document Split jobs.
+
+
+## Get Document Split job by ID
+
+Returns details for a single Document Split job identified by its ID,
+including the current status, the input definition, and any output files
+produced by the job.
+
+This operation is performed by calling function `getDocumentSplitByIdV2026R0`.
+
+See the endpoint docs at
+[API Reference](https://developer.box.com/reference/v2026.0/get-document-splits-id/).
+
+*Currently we don't have an example for calling `getDocumentSplitByIdV2026R0` in integration tests*
+
+### Arguments
+
+- documentSplitId `String`
+  - The unique identifier for the Document Split job. Example: "1748426"
+- headers `GetDocumentSplitByIdV2026R0Headers`
+  - Headers of getDocumentSplitByIdV2026R0 method
+
+
+### Returns
+
+This function returns a value of type `DocumentSplitV2026R0`.
+
+Returns the Document Split job.
+
+

docs/users.md

@@ -201,6 +201,12 @@ still owns any content.
 To proceed, move their owned content first, or use the `force` parameter to delete
 the user and their files.
 
+If the enterprise has a retention policy, including a retired one, or a
+legal hold that is not fully released, you can't delete a user who owns
+content, even with `force`. Transfer the user's content first by using the
+[Transfer owned folders](https://developer.box.com/reference/put-users-id-folders-0)
+endpoint.
+
 This operation is performed by calling function `deleteUserById`.
 
 See the endpoint docs at

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

@@ -19,6 +19,7 @@
 import com.box.sdkgen.managers.devicepinners.DevicePinnersManager;
 import com.box.sdkgen.managers.docgen.DocgenManager;
 import com.box.sdkgen.managers.docgentemplate.DocgenTemplateManager;
+import com.box.sdkgen.managers.documentsplit.DocumentSplitManager;
 import com.box.sdkgen.managers.downloads.DownloadsManager;
 import com.box.sdkgen.managers.emailaliases.EmailAliasesManager;
 import com.box.sdkgen.managers.enterpriseconfigurations.EnterpriseConfigurationsManager;
@@ -277,6 +278,8 @@ public class BoxClient {
 
   public final NotesManager notes;
 
+  public final DocumentSplitManager documentSplit;
+
   public final QueryManager query;
 
   public BoxClient(Authentication auth) {
@@ -634,6 +637,11 @@ public BoxClient(Authentication auth) {
             .build();
     this.notes =
         new NotesManager.Builder().auth(this.auth).networkSession(this.networkSession).build();
+    this.documentSplit =
+        new DocumentSplitManager.Builder()
+            .auth(this.auth)
+            .networkSession(this.networkSession)
+            .build();
     this.query =
         new QueryManager.Builder().auth(this.auth).networkSession(this.networkSession).build();
   }
@@ -993,6 +1001,11 @@ protected BoxClient(Builder builder) {
             .build();
     this.notes =
         new NotesManager.Builder().auth(this.auth).networkSession(this.networkSession).build();
+    this.documentSplit =
+        new DocumentSplitManager.Builder()
+            .auth(this.auth)
+            .networkSession(this.networkSession)
+            .build();
     this.query =
         new QueryManager.Builder().auth(this.auth).networkSession(this.networkSession).build();
   }
@@ -1458,6 +1471,10 @@ public NotesManager getNotes() {
     return notes;
   }
 
+  public DocumentSplitManager getDocumentSplit() {
+    return documentSplit;
+  }
+
   public QueryManager getQuery() {
     return query;
   }

src/main/java/com/box/sdkgen/managers/documentsplit/CreateDocumentSplitV2026R0Headers.java

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