fix: Fix schemas for updating classification on a file and folder (box/box-openapi#423) (#188)

Author: box-sdk-build

.codegen.json

@@ -1 +1 @@
-{ "engineHash": "3d5462a", "specHash": "d5769a1", "version": "0.5.4" }
+{ "engineHash": "c8ba3d9", "specHash": "98bca8f", "version": "0.5.4" }

docs/legalHoldPolicyAssignments.md

@@ -4,7 +4,7 @@
 - [Assign legal hold policy](#assign-legal-hold-policy)
 - [Get legal hold policy assignment](#get-legal-hold-policy-assignment)
 - [Unassign legal hold policy](#unassign-legal-hold-policy)
-- [List current file versions for legal hold policy assignment](#list-current-file-versions-for-legal-hold-policy-assignment)
+- [List files with current file versions for legal hold policy assignment](#list-files-with-current-file-versions-for-legal-hold-policy-assignment)
 
 ## List legal hold policy assignments
 
@@ -134,9 +134,9 @@ This function returns a value of type `undefined`.
 A blank response is returned if the assignment was
 successfully deleted.
 
-## List current file versions for legal hold policy assignment
+## List files with current file versions for legal hold policy assignment
 
-Get a list of current file versions for a legal hold
+Get a list of files with current file versions for a legal hold
 assignment.
 
 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
 
 ### Returns
 
-This function returns a value of type `FileVersionLegalHolds`.
+This function returns a value of type `FilesOnHold`.
 
 Returns the list of current file versions held under legal hold for a
 specific legal hold policy assignment.

package-lock.json

@@ -4,12 +4,15 @@ import { serializeClientError } from '../schemas/clientError.generated.js';
 import { deserializeClientError } from '../schemas/clientError.generated.js';
 import { serializeLegalHoldPolicyAssignment } from '../schemas/legalHoldPolicyAssignment.generated.js';
 import { deserializeLegalHoldPolicyAssignment } from '../schemas/legalHoldPolicyAssignment.generated.js';
-import { serializeFileVersionLegalHolds } from '../schemas/fileVersionLegalHolds.generated.js';
-import { deserializeFileVersionLegalHolds } from '../schemas/fileVersionLegalHolds.generated.js';
+import { serializeFilesOnHold } from '../schemas/filesOnHold.generated.js';
+import { deserializeFilesOnHold } from '../schemas/filesOnHold.generated.js';
+import { serializeFileVersionsOnHold } from '../schemas/fileVersionsOnHold.generated.js';
+import { deserializeFileVersionsOnHold } from '../schemas/fileVersionsOnHold.generated.js';
 import { LegalHoldPolicyAssignments } from '../schemas/legalHoldPolicyAssignments.generated.js';
 import { ClientError } from '../schemas/clientError.generated.js';
 import { LegalHoldPolicyAssignment } from '../schemas/legalHoldPolicyAssignment.generated.js';
-import { FileVersionLegalHolds } from '../schemas/fileVersionLegalHolds.generated.js';
+import { FilesOnHold } from '../schemas/filesOnHold.generated.js';
+import { FileVersionsOnHold } from '../schemas/fileVersionsOnHold.generated.js';
 import { Authentication } from '../networking/auth.generated.js';
 import { NetworkSession } from '../networking/network.generated.js';
 import { prepareParams } from '../internal/utils.js';
@@ -472,7 +475,7 @@ export class LegalHoldPolicyAssignmentsManager {
   async getLegalHoldPolicyAssignmentFileOnHold(
     legalHoldPolicyAssignmentId: string,
     optionalsInput: GetLegalHoldPolicyAssignmentFileOnHoldOptionalsInput = {}
-  ): Promise<FileVersionLegalHolds> {
+  ): Promise<FilesOnHold> {
     const optionals: GetLegalHoldPolicyAssignmentFileOnHoldOptionals =
       new GetLegalHoldPolicyAssignmentFileOnHoldOptionals({
         queryParams: optionalsInput.queryParams,
@@ -511,7 +514,7 @@ export class LegalHoldPolicyAssignmentsManager {
         cancellationToken: cancellationToken,
       } satisfies FetchOptions
     )) as FetchResponse;
-    return deserializeFileVersionLegalHolds(response.data);
+    return deserializeFilesOnHold(response.data);
   }
 }
 export interface LegalHoldPolicyAssignmentsManagerInput {

src/managers/legalHoldPolicyAssignments.generated.ts

@@ -9,16 +9,43 @@ import { sdIsNumber } from '../serialization/json.js';
 import { sdIsString } from '../serialization/json.js';
 import { sdIsList } from '../serialization/json.js';
 import { sdIsMap } from '../serialization/json.js';
+export type EventsNextStreamPositionField = string | number;
 export interface Events {
   readonly chunkSize?: number;
-  readonly nextStreamPosition?: string;
+  readonly nextStreamPosition?: EventsNextStreamPositionField;
   readonly entries?: readonly Event[];
 }
+export function serializeEventsNextStreamPositionField(
+  val: any
+): SerializedData {
+  return val;
+}
+export function deserializeEventsNextStreamPositionField(
+  val: SerializedData
+): EventsNextStreamPositionField {
+  if (!sdIsString(val)) {
+    throw new BoxSdkError({
+      message: 'Expecting a string for "EventsNextStreamPositionField"',
+    });
+  }
+  if (!sdIsNumber(val)) {
+    throw new BoxSdkError({
+      message: 'Expecting a number for "EventsNextStreamPositionField"',
+    });
+  }
+  throw new BoxSdkError({
+    message: ''.concat(
+      'Expected one of string, number type for union EventsNextStreamPositionField'
+    ) as string,
+  });
+}
 export function serializeEvents(val: Events): SerializedData {
   return {
     ['chunk_size']: val.chunkSize == void 0 ? void 0 : val.chunkSize,
     ['next_stream_position']:
-      val.nextStreamPosition == void 0 ? void 0 : val.nextStreamPosition,
+      val.nextStreamPosition == void 0
+        ? void 0
+        : serializeEventsNextStreamPositionField(val.nextStreamPosition),
     ['entries']:
       val.entries == void 0
         ? void 0
@@ -38,16 +65,10 @@ export function deserializeEvents(val: SerializedData): Events {
   }
   const chunkSize: undefined | number =
     val.chunk_size == void 0 ? void 0 : val.chunk_size;
-  if (
-    !(val.next_stream_position == void 0) &&
-    !sdIsString(val.next_stream_position)
-  ) {
-    throw new BoxSdkError({
-      message: 'Expecting string for "next_stream_position" of type "Events"',
-    });
-  }
-  const nextStreamPosition: undefined | string =
-    val.next_stream_position == void 0 ? void 0 : val.next_stream_position;
+  const nextStreamPosition: undefined | EventsNextStreamPositionField =
+    val.next_stream_position == void 0
+      ? void 0
+      : deserializeEventsNextStreamPositionField(val.next_stream_position);
   if (!(val.entries == void 0) && !sdIsList(val.entries)) {
     throw new BoxSdkError({
       message: 'Expecting array for "entries" of type "Events"',

src/schemas/events.generated.ts

@@ -0,0 +1,82 @@
+import { serializeFileVersion } from './fileVersion.generated.js';
+import { deserializeFileVersion } from './fileVersion.generated.js';
+import { FileVersion } from './fileVersion.generated.js';
+import { BoxSdkError } from '../box/errors.js';
+import { SerializedData } from '../serialization/json.js';
+import { sdIsEmpty } from '../serialization/json.js';
+import { sdIsBoolean } from '../serialization/json.js';
+import { sdIsNumber } from '../serialization/json.js';
+import { sdIsString } from '../serialization/json.js';
+import { sdIsList } from '../serialization/json.js';
+import { sdIsMap } from '../serialization/json.js';
+export interface FileVersionsOnHold {
+  readonly limit?: number;
+  readonly nextMarker?: string;
+  readonly prevMarker?: string;
+  readonly entries?: readonly FileVersion[];
+}
+export function serializeFileVersionsOnHold(
+  val: FileVersionsOnHold
+): SerializedData {
+  return {
+    ['limit']: val.limit == void 0 ? void 0 : val.limit,
+    ['next_marker']: val.nextMarker == void 0 ? void 0 : val.nextMarker,
+    ['prev_marker']: val.prevMarker == void 0 ? void 0 : val.prevMarker,
+    ['entries']:
+      val.entries == void 0
+        ? void 0
+        : (val.entries.map(function (item: FileVersion): SerializedData {
+            return serializeFileVersion(item);
+          }) as readonly any[]),
+  };
+}
+export function deserializeFileVersionsOnHold(
+  val: SerializedData
+): FileVersionsOnHold {
+  if (!sdIsMap(val)) {
+    throw new BoxSdkError({
+      message: 'Expecting a map for "FileVersionsOnHold"',
+    });
+  }
+  if (!(val.limit == void 0) && !sdIsNumber(val.limit)) {
+    throw new BoxSdkError({
+      message: 'Expecting number for "limit" of type "FileVersionsOnHold"',
+    });
+  }
+  const limit: undefined | number = val.limit == void 0 ? void 0 : val.limit;
+  if (!(val.next_marker == void 0) && !sdIsString(val.next_marker)) {
+    throw new BoxSdkError({
+      message:
+        'Expecting string for "next_marker" of type "FileVersionsOnHold"',
+    });
+  }
+  const nextMarker: undefined | string =
+    val.next_marker == void 0 ? void 0 : val.next_marker;
+  if (!(val.prev_marker == void 0) && !sdIsString(val.prev_marker)) {
+    throw new BoxSdkError({
+      message:
+        'Expecting string for "prev_marker" of type "FileVersionsOnHold"',
+    });
+  }
+  const prevMarker: undefined | string =
+    val.prev_marker == void 0 ? void 0 : val.prev_marker;
+  if (!(val.entries == void 0) && !sdIsList(val.entries)) {
+    throw new BoxSdkError({
+      message: 'Expecting array for "entries" of type "FileVersionsOnHold"',
+    });
+  }
+  const entries: undefined | readonly FileVersion[] =
+    val.entries == void 0
+      ? void 0
+      : sdIsList(val.entries)
+      ? (val.entries.map(function (itm: SerializedData): FileVersion {
+          return deserializeFileVersion(itm);
+        }) as readonly any[])
+      : [];
+  return {
+    limit: limit,
+    nextMarker: nextMarker,
+    prevMarker: prevMarker,
+    entries: entries,
+  } satisfies FileVersionsOnHold;
+}