Skip to content

Commit 8b1c541

Browse files
test: Add tests for FileVersionLegalHoldsManager (#60)
1 parent 208eef8 commit 8b1c541

File tree

2 files changed

+51
-2
lines changed

2 files changed

+51
-2
lines changed

docs/fileVersionLegalHolds.md

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,13 @@ This operation is performed by calling function `getFileVersionLegalHoldById`.
1313
See the endpoint docs at
1414
[API Reference](https://developer.box.com/reference/get-file-version-legal-holds-id/).
1515

16-
_Currently we don't have an example for calling `getFileVersionLegalHoldById` in integration tests_
16+
<!-- sample get_file_version_legal_holds_id -->
17+
18+
```ts
19+
await client.fileVersionLegalHolds.getFileVersionLegalHoldById(
20+
fileVersionLegalHoldId
21+
);
22+
```
1723

1824
### Arguments
1925

@@ -58,7 +64,13 @@ This operation is performed by calling function `getFileVersionLegalHolds`.
5864
See the endpoint docs at
5965
[API Reference](https://developer.box.com/reference/get-file-version-legal-holds/).
6066

61-
_Currently we don't have an example for calling `getFileVersionLegalHolds` in integration tests_
67+
<!-- sample get_file_version_legal_holds -->
68+
69+
```ts
70+
await client.fileVersionLegalHolds.getFileVersionLegalHolds({
71+
policyId: policyId,
72+
} satisfies GetFileVersionLegalHoldsQueryParams);
73+
```
6274

6375
### Arguments
6476

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
import { serializeFileVersionLegalHolds } from '../schemas.generated.js';
2+
import { deserializeFileVersionLegalHolds } from '../schemas.generated.js';
3+
import { FileVersionLegalHolds } from '../schemas.generated.js';
4+
import { GetFileVersionLegalHoldsQueryParams } from '../managers/fileVersionLegalHolds.generated.js';
5+
import { generateByteStream } from '../internal/utils.js';
6+
import { getUuid } from '../internal/utils.js';
7+
import { BoxClient } from '../client.generated.js';
8+
import { getDefaultClient } from './commons.generated.js';
9+
import { SerializedData } from '../serialization/json.js';
10+
import { sdIsEmpty } from '../serialization/json.js';
11+
import { sdIsBoolean } from '../serialization/json.js';
12+
import { sdIsNumber } from '../serialization/json.js';
13+
import { sdIsString } from '../serialization/json.js';
14+
import { sdIsList } from '../serialization/json.js';
15+
import { sdIsMap } from '../serialization/json.js';
16+
const client: BoxClient = getDefaultClient();
17+
test('getFileVersionLegalHolds', async function getFileVersionLegalHolds(): Promise<any> {
18+
const policyId: string = '1234567890';
19+
const fileVersionLegalHolds: FileVersionLegalHolds =
20+
await client.fileVersionLegalHolds.getFileVersionLegalHolds({
21+
policyId: policyId,
22+
} satisfies GetFileVersionLegalHoldsQueryParams);
23+
const fileVersionLegalHoldsCount: number =
24+
fileVersionLegalHolds.entries!.length;
25+
if (!(fileVersionLegalHoldsCount >= 0)) {
26+
throw new Error('Assertion failed');
27+
}
28+
});
29+
test('getFileVersionLegalHoldById', async function getFileVersionLegalHoldById(): Promise<any> {
30+
const fileVersionLegalHoldId: string = '987654321';
31+
await expect(async () => {
32+
await client.fileVersionLegalHolds.getFileVersionLegalHoldById(
33+
fileVersionLegalHoldId
34+
);
35+
}).rejects.toThrow();
36+
});
37+
export {};

0 commit comments

Comments
 (0)