Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .codegen.json
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{ "engineHash": "d55532c", "specHash": "e21eebc", "version": "5.19.0" }
{ "engineHash": "d55532c", "specHash": "ad8dbb8", "version": "5.19.0" }
2 changes: 2 additions & 0 deletions docs/sdkgen/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -78,6 +79,7 @@ the SDK are available by topic:
* [Shieldinformationbarriersegmentrestrictions](shieldinformationbarriersegmentrestrictions.md)
* [Shieldinformationbarriersegments](shieldinformationbarriersegments.md)
* [Shieldlists](shieldlists.md)
* [Shuttle](shuttle.md)
* [Signrequests](signrequests.md)
* [Signtemplates](signtemplates.md)
* [Skills](skills.md)
Expand Down
101 changes: 101 additions & 0 deletions docs/sdkgen/documentsplit.md
Original file line number Diff line number Diff line change
@@ -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.


Loading
Loading