Skip to content

Commit 68ecb04

Browse files
box-sdk-buildbox-sdk-build
authored
fix: Fix schemas for updating classification on a file and folder (box/box-openapi#423) (#188)
1 parent 469afb9 commit 68ecb04

File tree

8 files changed

+242
-62
lines changed

8 files changed

+242
-62
lines changed

‎.codegen.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
{ "engineHash": "3d5462a", "specHash": "d5769a1", "version": "0.5.4" }
1+
{ "engineHash": "c8ba3d9", "specHash": "98bca8f", "version": "0.5.4" }

‎docs/legalHoldPolicyAssignments.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
- [Assign legal hold policy](#assign-legal-hold-policy)
55
- [Get legal hold policy assignment](#get-legal-hold-policy-assignment)
66
- [Unassign legal hold policy](#unassign-legal-hold-policy)
7-
- [List current file versions for legal hold policy assignment](#list-current-file-versions-for-legal-hold-policy-assignment)
7+
- [List files with current file versions for legal hold policy assignment](#list-files-with-current-file-versions-for-legal-hold-policy-assignment)
88

99
## List legal hold policy assignments
1010

@@ -134,9 +134,9 @@ This function returns a value of type `undefined`.
134134
A blank response is returned if the assignment was
135135
successfully deleted.
136136

137-
## List current file versions for legal hold policy assignment
137+
## List files with current file versions for legal hold policy assignment
138138

139-
Get a list of current file versions for a legal hold
139+
Get a list of files with current file versions for a legal hold
140140
assignment.
141141

142142
In some cases you may want to get previous file versions instead. In these
@@ -169,7 +169,7 @@ _Currently we don't have an example for calling `getLegalHoldPolicyAssignmentFil
169169

170170
### Returns
171171

172-
This function returns a value of type `FileVersionLegalHolds`.
172+
This function returns a value of type `FilesOnHold`.
173173

174174
Returns the list of current file versions held under legal hold for a
175175
specific legal hold policy assignment.

‎package-lock.json‎

Lines changed: 32 additions & 32 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎src/managers/legalHoldPolicyAssignments.generated.ts‎

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,15 @@ import { serializeClientError } from '../schemas/clientError.generated.js';
44
import { deserializeClientError } from '../schemas/clientError.generated.js';
55
import { serializeLegalHoldPolicyAssignment } from '../schemas/legalHoldPolicyAssignment.generated.js';
66
import { deserializeLegalHoldPolicyAssignment } from '../schemas/legalHoldPolicyAssignment.generated.js';
7-
import { serializeFileVersionLegalHolds } from '../schemas/fileVersionLegalHolds.generated.js';
8-
import { deserializeFileVersionLegalHolds } from '../schemas/fileVersionLegalHolds.generated.js';
7+
import { serializeFilesOnHold } from '../schemas/filesOnHold.generated.js';
8+
import { deserializeFilesOnHold } from '../schemas/filesOnHold.generated.js';
9+
import { serializeFileVersionsOnHold } from '../schemas/fileVersionsOnHold.generated.js';
10+
import { deserializeFileVersionsOnHold } from '../schemas/fileVersionsOnHold.generated.js';
911
import { LegalHoldPolicyAssignments } from '../schemas/legalHoldPolicyAssignments.generated.js';
1012
import { ClientError } from '../schemas/clientError.generated.js';
1113
import { LegalHoldPolicyAssignment } from '../schemas/legalHoldPolicyAssignment.generated.js';
12-
import { FileVersionLegalHolds } from '../schemas/fileVersionLegalHolds.generated.js';
14+
import { FilesOnHold } from '../schemas/filesOnHold.generated.js';
15+
import { FileVersionsOnHold } from '../schemas/fileVersionsOnHold.generated.js';
1316
import { Authentication } from '../networking/auth.generated.js';
1417
import { NetworkSession } from '../networking/network.generated.js';
1518
import { prepareParams } from '../internal/utils.js';
@@ -472,7 +475,7 @@ export class LegalHoldPolicyAssignmentsManager {
472475
async getLegalHoldPolicyAssignmentFileOnHold(
473476
legalHoldPolicyAssignmentId: string,
474477
optionalsInput: GetLegalHoldPolicyAssignmentFileOnHoldOptionalsInput = {}
475-
): Promise<FileVersionLegalHolds> {
478+
): Promise<FilesOnHold> {
476479
const optionals: GetLegalHoldPolicyAssignmentFileOnHoldOptionals =
477480
new GetLegalHoldPolicyAssignmentFileOnHoldOptionals({
478481
queryParams: optionalsInput.queryParams,
@@ -511,7 +514,7 @@ export class LegalHoldPolicyAssignmentsManager {
511514
cancellationToken: cancellationToken,
512515
} satisfies FetchOptions
513516
)) as FetchResponse;
514-
return deserializeFileVersionLegalHolds(response.data);
517+
return deserializeFilesOnHold(response.data);
515518
}
516519
}
517520
export interface LegalHoldPolicyAssignmentsManagerInput {

‎src/schemas/events.generated.ts‎

Lines changed: 33 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -9,16 +9,43 @@ import { sdIsNumber } from '../serialization/json.js';
99
import { sdIsString } from '../serialization/json.js';
1010
import { sdIsList } from '../serialization/json.js';
1111
import { sdIsMap } from '../serialization/json.js';
12+
export type EventsNextStreamPositionField = string | number;
1213
export interface Events {
1314
readonly chunkSize?: number;
14-
readonly nextStreamPosition?: string;
15+
readonly nextStreamPosition?: EventsNextStreamPositionField;
1516
readonly entries?: readonly Event[];
1617
}
18+
export function serializeEventsNextStreamPositionField(
19+
val: any
20+
): SerializedData {
21+
return val;
22+
}
23+
export function deserializeEventsNextStreamPositionField(
24+
val: SerializedData
25+
): EventsNextStreamPositionField {
26+
if (!sdIsString(val)) {
27+
throw new BoxSdkError({
28+
message: 'Expecting a string for "EventsNextStreamPositionField"',
29+
});
30+
}
31+
if (!sdIsNumber(val)) {
32+
throw new BoxSdkError({
33+
message: 'Expecting a number for "EventsNextStreamPositionField"',
34+
});
35+
}
36+
throw new BoxSdkError({
37+
message: ''.concat(
38+
'Expected one of string, number type for union EventsNextStreamPositionField'
39+
) as string,
40+
});
41+
}
1742
export function serializeEvents(val: Events): SerializedData {
1843
return {
1944
['chunk_size']: val.chunkSize == void 0 ? void 0 : val.chunkSize,
2045
['next_stream_position']:
21-
val.nextStreamPosition == void 0 ? void 0 : val.nextStreamPosition,
46+
val.nextStreamPosition == void 0
47+
? void 0
48+
: serializeEventsNextStreamPositionField(val.nextStreamPosition),
2249
['entries']:
2350
val.entries == void 0
2451
? void 0
@@ -38,16 +65,10 @@ export function deserializeEvents(val: SerializedData): Events {
3865
}
3966
const chunkSize: undefined | number =
4067
val.chunk_size == void 0 ? void 0 : val.chunk_size;
41-
if (
42-
!(val.next_stream_position == void 0) &&
43-
!sdIsString(val.next_stream_position)
44-
) {
45-
throw new BoxSdkError({
46-
message: 'Expecting string for "next_stream_position" of type "Events"',
47-
});
48-
}
49-
const nextStreamPosition: undefined | string =
50-
val.next_stream_position == void 0 ? void 0 : val.next_stream_position;
68+
const nextStreamPosition: undefined | EventsNextStreamPositionField =
69+
val.next_stream_position == void 0
70+
? void 0
71+
: deserializeEventsNextStreamPositionField(val.next_stream_position);
5172
if (!(val.entries == void 0) && !sdIsList(val.entries)) {
5273
throw new BoxSdkError({
5374
message: 'Expecting array for "entries" of type "Events"',

‎src/schemas/fileVersionsOnHold.generated.ts‎

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
import { serializeFileVersion } from './fileVersion.generated.js';
2+
import { deserializeFileVersion } from './fileVersion.generated.js';
3+
import { FileVersion } from './fileVersion.generated.js';
4+
import { BoxSdkError } from '../box/errors.js';
5+
import { SerializedData } from '../serialization/json.js';
6+
import { sdIsEmpty } from '../serialization/json.js';
7+
import { sdIsBoolean } from '../serialization/json.js';
8+
import { sdIsNumber } from '../serialization/json.js';
9+
import { sdIsString } from '../serialization/json.js';
10+
import { sdIsList } from '../serialization/json.js';
11+
import { sdIsMap } from '../serialization/json.js';
12+
export interface FileVersionsOnHold {
13+
readonly limit?: number;
14+
readonly nextMarker?: string;
15+
readonly prevMarker?: string;
16+
readonly entries?: readonly FileVersion[];
17+
}
18+
export function serializeFileVersionsOnHold(
19+
val: FileVersionsOnHold
20+
): SerializedData {
21+
return {
22+
['limit']: val.limit == void 0 ? void 0 : val.limit,
23+
['next_marker']: val.nextMarker == void 0 ? void 0 : val.nextMarker,
24+
['prev_marker']: val.prevMarker == void 0 ? void 0 : val.prevMarker,
25+
['entries']:
26+
val.entries == void 0
27+
? void 0
28+
: (val.entries.map(function (item: FileVersion): SerializedData {
29+
return serializeFileVersion(item);
30+
}) as readonly any[]),
31+
};
32+
}
33+
export function deserializeFileVersionsOnHold(
34+
val: SerializedData
35+
): FileVersionsOnHold {
36+
if (!sdIsMap(val)) {
37+
throw new BoxSdkError({
38+
message: 'Expecting a map for "FileVersionsOnHold"',
39+
});
40+
}
41+
if (!(val.limit == void 0) && !sdIsNumber(val.limit)) {
42+
throw new BoxSdkError({
43+
message: 'Expecting number for "limit" of type "FileVersionsOnHold"',
44+
});
45+
}
46+
const limit: undefined | number = val.limit == void 0 ? void 0 : val.limit;
47+
if (!(val.next_marker == void 0) && !sdIsString(val.next_marker)) {
48+
throw new BoxSdkError({
49+
message:
50+
'Expecting string for "next_marker" of type "FileVersionsOnHold"',
51+
});
52+
}
53+
const nextMarker: undefined | string =
54+
val.next_marker == void 0 ? void 0 : val.next_marker;
55+
if (!(val.prev_marker == void 0) && !sdIsString(val.prev_marker)) {
56+
throw new BoxSdkError({
57+
message:
58+
'Expecting string for "prev_marker" of type "FileVersionsOnHold"',
59+
});
60+
}
61+
const prevMarker: undefined | string =
62+
val.prev_marker == void 0 ? void 0 : val.prev_marker;
63+
if (!(val.entries == void 0) && !sdIsList(val.entries)) {
64+
throw new BoxSdkError({
65+
message: 'Expecting array for "entries" of type "FileVersionsOnHold"',
66+
});
67+
}
68+
const entries: undefined | readonly FileVersion[] =
69+
val.entries == void 0
70+
? void 0
71+
: sdIsList(val.entries)
72+
? (val.entries.map(function (itm: SerializedData): FileVersion {
73+
return deserializeFileVersion(itm);
74+
}) as readonly any[])
75+
: [];
76+
return {
77+
limit: limit,
78+
nextMarker: nextMarker,
79+
prevMarker: prevMarker,
80+
entries: entries,
81+
} satisfies FileVersionsOnHold;
82+
}

0 commit comments

Comments
 (0)