feat(boxsdkgen): add DocumentSplitManager and document split SDK/docs support (box/box-openapi#621)

.codegen.json

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

docs/sdk-gen/README.md

@@ -29,6 +29,7 @@ the SDK are available by topic:
 * [Device pinners](devicePinners.md)
 * [Docgen](docgen.md)
 * [Docgen template](docgenTemplate.md)
+* [Document split](documentSplit.md)
 * [Downloads](downloads.md)
 * [Email aliases](emailAliases.md)
 * [Enterprise configurations](enterpriseConfigurations.md)

docs/sdk-gen/documentSplit.md

@@ -0,0 +1,103 @@
+# 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
+- optionalsInput `CreateDocumentSplitV2026R0OptionalsInput`
+
+
+
+### 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
+- headersInput `GetDocumentSplitsV2026R0HeadersInput`
+  - Headers of getDocumentSplitsV2026R0 method
+- cancellationToken `undefined | CancellationToken`
+  - Token used for request cancellation.
+
+
+### 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"
+- optionalsInput `GetDocumentSplitByIdV2026R0OptionalsInput`
+
+
+
+### Returns
+
+This function returns a value of type `DocumentSplitV2026R0`.
+
+Returns the Document Split job.
+
+

docs/sdk-gen/users.md

@@ -197,6 +197,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/sdk-gen/client.ts

@@ -87,6 +87,7 @@ import { ArchivesManager } from './managers/archives';
 import { ExternalUsersManager } from './managers/externalUsers';
 import { AutomateWorkflowsManager } from './managers/automateWorkflows';
 import { NotesManager } from './managers/notes';
+import { DocumentSplitManager } from './managers/documentSplit';
 import { QueryManager } from './managers/query';
 import { Authentication } from './networking/auth';
 import { NetworkSession } from './networking/network';
@@ -195,6 +196,7 @@ export class BoxClient {
   readonly externalUsers: ExternalUsersManager;
   readonly automateWorkflows: AutomateWorkflowsManager;
   readonly notes: NotesManager;
+  readonly documentSplit: DocumentSplitManager;
   readonly query: QueryManager;
   constructor(
     fields: Omit<
@@ -284,6 +286,7 @@ export class BoxClient {
       | 'externalUsers'
       | 'automateWorkflows'
       | 'notes'
+      | 'documentSplit'
       | 'query'
       | 'networkSession'
       | 'makeRequest'
@@ -650,6 +653,10 @@ export class BoxClient {
       auth: this.auth,
       networkSession: this.networkSession,
     });
+    this.documentSplit = new DocumentSplitManager({
+      auth: this.auth,
+      networkSession: this.networkSession,
+    });
     this.query = new QueryManager({
       auth: this.auth,
       networkSession: this.networkSession,