test(boxsdkgen): add integration tests for documentSplit endpoints and examples (box/box-codegen#999)

.codegen.json

@@ -1 +1 @@
-{ "engineHash": "976bbb9", "specHash": "a0e8038", "version": "4.18.0" }
+{ "engineHash": "88c0ae7", "specHash": "a0e8038", "version": "4.18.0" }

docs/sdk-gen/documentSplit.md

@@ -26,7 +26,10 @@ 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*
+<!-- sample post_document_splits_v2026.0 -->
+```ts
+await client.documentSplit.createDocumentSplitV2026R0({ sourceFileId: file.id, destinationFolderId: folder.id, inputSource: "api" as DocumentSplitCreateRequestV2026R0InputSourceField, splitInput: new DocumentSplitCreateRequestManualV2026R0({ splitType: "manual" as DocumentSplitCreateRequestManualV2026R0SplitTypeField, splitDefinition: [{ start: 1, end: 1 } satisfies DocumentSplitPageRangeV2026R0] }), externalId: externalId } satisfies DocumentSplitCreateRequestV2026R0)
+```
 
 ### Arguments
 
@@ -54,7 +57,10 @@ 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*
+<!-- sample get_document_splits_v2026.0 -->
+```ts
+await client.documentSplit.getDocumentSplitsV2026R0({ limit: 10 } satisfies GetDocumentSplitsV2026R0QueryParams)
+```
 
 ### Arguments
 
@@ -84,7 +90,10 @@ 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*
+<!-- sample get_document_splits_id_v2026.0 -->
+```ts
+await client.documentSplit.getDocumentSplitByIdV2026R0(createdDocumentSplit.id)
+```
 
 ### Arguments
 

tests/sdk-gen/documentSplit.test.ts

@@ -0,0 +1,113 @@
+import { serializeFileFull } from '@/schemas/fileFull';
+import { deserializeFileFull } from '@/schemas/fileFull';
+import { serializeFolderFull } from '@/schemas/folderFull';
+import { deserializeFolderFull } from '@/schemas/folderFull';
+import { serializeDocumentSplitCreateResponseV2026R0 } from '@/schemas/v2026R0/documentSplitCreateResponseV2026R0';
+import { deserializeDocumentSplitCreateResponseV2026R0 } from '@/schemas/v2026R0/documentSplitCreateResponseV2026R0';
+import { serializeDocumentSplitCreateRequestV2026R0 } from '@/schemas/v2026R0/documentSplitCreateRequestV2026R0';
+import { deserializeDocumentSplitCreateRequestV2026R0 } from '@/schemas/v2026R0/documentSplitCreateRequestV2026R0';
+import { serializeDocumentSplitCreateRequestV2026R0InputSourceField } from '@/schemas/v2026R0/documentSplitCreateRequestV2026R0';
+import { deserializeDocumentSplitCreateRequestV2026R0InputSourceField } from '@/schemas/v2026R0/documentSplitCreateRequestV2026R0';
+import { serializeDocumentSplitCreateRequestManualV2026R0SplitTypeField } from '@/schemas/v2026R0/documentSplitCreateRequestManualV2026R0';
+import { deserializeDocumentSplitCreateRequestManualV2026R0SplitTypeField } from '@/schemas/v2026R0/documentSplitCreateRequestManualV2026R0';
+import { serializeDocumentSplitPageRangeV2026R0 } from '@/schemas/v2026R0/documentSplitPageRangeV2026R0';
+import { deserializeDocumentSplitPageRangeV2026R0 } from '@/schemas/v2026R0/documentSplitPageRangeV2026R0';
+import { serializeDocumentSplitV2026R0 } from '@/schemas/v2026R0/documentSplitV2026R0';
+import { deserializeDocumentSplitV2026R0 } from '@/schemas/v2026R0/documentSplitV2026R0';
+import { serializeDocumentSplitsV2026R0 } from '@/schemas/v2026R0/documentSplitsV2026R0';
+import { deserializeDocumentSplitsV2026R0 } from '@/schemas/v2026R0/documentSplitsV2026R0';
+import { serializeDocumentSplitCreateRequestManualV2026R0 } from '@/schemas/v2026R0/documentSplitCreateRequestManualV2026R0';
+import { deserializeDocumentSplitCreateRequestManualV2026R0 } from '@/schemas/v2026R0/documentSplitCreateRequestManualV2026R0';
+import { DeleteFolderByIdOptionalsInput } from '@/managers/folders';
+import { DeleteFolderByIdOptionals } from '@/managers/folders';
+import { BoxClient } from '@/client';
+import { FileFull } from '@/schemas/fileFull';
+import { FolderFull } from '@/schemas/folderFull';
+import { DocumentSplitCreateResponseV2026R0 } from '@/schemas/v2026R0/documentSplitCreateResponseV2026R0';
+import { DocumentSplitCreateRequestV2026R0 } from '@/schemas/v2026R0/documentSplitCreateRequestV2026R0';
+import { DocumentSplitCreateRequestV2026R0InputSourceField } from '@/schemas/v2026R0/documentSplitCreateRequestV2026R0';
+import { DocumentSplitCreateRequestManualV2026R0SplitTypeField } from '@/schemas/v2026R0/documentSplitCreateRequestManualV2026R0';
+import { DocumentSplitPageRangeV2026R0 } from '@/schemas/v2026R0/documentSplitPageRangeV2026R0';
+import { DocumentSplitV2026R0 } from '@/schemas/v2026R0/documentSplitV2026R0';
+import { DeleteFolderByIdQueryParams } from '@/managers/folders';
+import { DocumentSplitsV2026R0 } from '@/schemas/v2026R0/documentSplitsV2026R0';
+import { GetDocumentSplitsV2026R0QueryParams } from '@/managers/documentSplit';
+import { getUuid } from '@/internal/utils';
+import { getDefaultClient } from './commons';
+import { uploadNewFile } from './commons';
+import { createNewFolder } from './commons';
+import { DocumentSplitCreateRequestManualV2026R0 } from '@/schemas/v2026R0/documentSplitCreateRequestManualV2026R0';
+import { toString } from '@/internal/utils';
+import { sdToJson } from '@/serialization/json';
+import { SerializedData } from '@/serialization/json';
+import { sdIsEmpty } from '@/serialization/json';
+import { sdIsBoolean } from '@/serialization/json';
+import { sdIsNumber } from '@/serialization/json';
+import { sdIsString } from '@/serialization/json';
+import { sdIsList } from '@/serialization/json';
+import { sdIsMap } from '@/serialization/json';
+export const client: BoxClient = getDefaultClient();
+test('testCreateDocumentSplitV2026R0', async function testCreateDocumentSplitV2026R0(): Promise<any> {
+  const file: FileFull = await uploadNewFile();
+  const folder: FolderFull = await createNewFolder();
+  const externalId: string = getUuid();
+  const createdDocumentSplit: DocumentSplitCreateResponseV2026R0 =
+    await client.documentSplit.createDocumentSplitV2026R0({
+      sourceFileId: file.id,
+      destinationFolderId: folder.id,
+      inputSource: 'api' as DocumentSplitCreateRequestV2026R0InputSourceField,
+      splitInput: new DocumentSplitCreateRequestManualV2026R0({
+        splitType:
+          'manual' as DocumentSplitCreateRequestManualV2026R0SplitTypeField,
+        splitDefinition: [
+          { start: 1, end: 1 } satisfies DocumentSplitPageRangeV2026R0,
+        ],
+      }),
+      externalId: externalId,
+    } satisfies DocumentSplitCreateRequestV2026R0);
+  if (!!(createdDocumentSplit.id == '')) {
+    throw new Error('Assertion failed');
+  }
+  if (!((toString(createdDocumentSplit.type) as string) == 'document_split')) {
+    throw new Error('Assertion failed');
+  }
+  const documentSplit: DocumentSplitV2026R0 =
+    await client.documentSplit.getDocumentSplitByIdV2026R0(
+      createdDocumentSplit.id
+    );
+  if (!(documentSplit.id == createdDocumentSplit.id)) {
+    throw new Error('Assertion failed');
+  }
+  if (!((toString(documentSplit.type) as string) == 'document_split')) {
+    throw new Error('Assertion failed');
+  }
+  if (!(documentSplit.sourceFile.id == file.id)) {
+    throw new Error('Assertion failed');
+  }
+  if (!(documentSplit.destinationFolder.id == folder.id)) {
+    throw new Error('Assertion failed');
+  }
+  if (!((toString(documentSplit.inputSource) as string) == 'api')) {
+    throw new Error('Assertion failed');
+  }
+  if (!!((toString(documentSplit.status) as string) == '')) {
+    throw new Error('Assertion failed');
+  }
+  if (!(documentSplit.externalId == externalId)) {
+    throw new Error('Assertion failed');
+  }
+  await client.folders.deleteFolderById(folder.id, {
+    queryParams: { recursive: true } satisfies DeleteFolderByIdQueryParams,
+  } satisfies DeleteFolderByIdOptionalsInput);
+  await client.files.deleteFileById(file.id);
+});
+test('testGetDocumentSplitsV2026R0', async function testGetDocumentSplitsV2026R0(): Promise<any> {
+  const documentSplits: DocumentSplitsV2026R0 =
+    await client.documentSplit.getDocumentSplitsV2026R0({
+      limit: 10,
+    } satisfies GetDocumentSplitsV2026R0QueryParams);
+  if (!(documentSplits.entries!.length >= 0)) {
+    throw new Error('Assertion failed');
+  }
+});
+export {};