docs: bounding boxes&confidence score (box/box-openapi#619)

.codegen.json

@@ -1 +1 @@
-{ "engineHash": "daeb1ea", "specHash": "88cd5aa", "version": "10.16.0" }
+{ "engineHash": "daeb1ea", "specHash": "c5a35a6", "version": "10.16.0" }

src/schemas/aiExtractStructured.ts

@@ -102,10 +102,10 @@ export interface AiExtractStructured {
   readonly fields?: readonly AiExtractStructuredFieldsField[];
   readonly aiAgent?: AiExtractStructuredAgent;
   /**
-   * A flag to indicate whether confidence scores for every extracted field should be returned. */
+   * A flag to indicate whether confidence scores for every extracted field should be returned. Estimates the likelihood that an extracted metadata field value is accurate and correct. Displays a numerical and categorical confidence score to help users and automated systems quickly determine extraction reliability. */
   readonly includeConfidenceScore?: boolean;
   /**
-   * A flag to indicate whether references for every extracted field should be returned. */
+   * A flag to indicate whether references for every extracted field should be returned. References and bounding boxes show where the agent extracted the metadata from. They help you check for accuracy and fix any mistakes. References are short, exact quotes from the original document used to verify results. Bounding boxes highlight the specific areas on the page where that text is found. */
   readonly includeReference?: boolean;
   /**
    * The taxonomy sources to be used for the structured extraction. They can either be an existing file or a taxonomy.

src/schemas/collaboration.ts

@@ -1,9 +1,9 @@
-import { serializeFile } from './file';
-import { deserializeFile } from './file';
-import { serializeFolder } from './folder';
-import { deserializeFolder } from './folder';
-import { serializeWebLink } from './webLink';
-import { deserializeWebLink } from './webLink';
+import { serializeFileMini } from './fileMini';
+import { deserializeFileMini } from './fileMini';
+import { serializeFolderMini } from './folderMini';
+import { deserializeFolderMini } from './folderMini';
+import { serializeWebLinkMini } from './webLinkMini';
+import { deserializeWebLinkMini } from './webLinkMini';
 import { serializeGroupMini } from './groupMini';
 import { deserializeGroupMini } from './groupMini';
 import { serializeCollaborationItem } from './collaborationItem';
@@ -18,9 +18,9 @@ import { serializeTermsOfServiceBase } from './termsOfServiceBase';
 import { deserializeTermsOfServiceBase } from './termsOfServiceBase';
 import { serializeDateTime } from '../internal/utils';
 import { deserializeDateTime } from '../internal/utils';
-import { File } from './file';
-import { Folder } from './folder';
-import { WebLink } from './webLink';
+import { FileMini } from './fileMini';
+import { FolderMini } from './folderMini';
+import { WebLinkMini } from './webLinkMini';
 import { GroupMini } from './groupMini';
 import { CollaborationItem } from './collaborationItem';
 import { AppItem } from './appItem';

src/schemas/collaborationItem.ts

@@ -1,12 +1,12 @@
-import { serializeFile } from './file';
-import { deserializeFile } from './file';
-import { serializeFolder } from './folder';
-import { deserializeFolder } from './folder';
-import { serializeWebLink } from './webLink';
-import { deserializeWebLink } from './webLink';
-import { File } from './file';
-import { Folder } from './folder';
-import { WebLink } from './webLink';
+import { serializeFileMini } from './fileMini';
+import { deserializeFileMini } from './fileMini';
+import { serializeFolderMini } from './folderMini';
+import { deserializeFolderMini } from './folderMini';
+import { serializeWebLinkMini } from './webLinkMini';
+import { deserializeWebLinkMini } from './webLinkMini';
+import { FileMini } from './fileMini';
+import { FolderMini } from './folderMini';
+import { WebLinkMini } from './webLinkMini';
 import { BoxSdkError } from '../box/errors';
 import { SerializedData } from '../serialization/json';
 import { sdIsEmpty } from '../serialization/json';
@@ -15,16 +15,16 @@ import { sdIsNumber } from '../serialization/json';
 import { sdIsString } from '../serialization/json';
 import { sdIsList } from '../serialization/json';
 import { sdIsMap } from '../serialization/json';
-export type CollaborationItem = File | Folder | WebLink;
+export type CollaborationItem = FileMini | FolderMini | WebLinkMini;
 export function serializeCollaborationItem(val: any): SerializedData {
   if (val.type == 'file') {
-    return serializeFile(val);
+    return serializeFileMini(val);
   }
   if (val.type == 'folder') {
-    return serializeFolder(val);
+    return serializeFolderMini(val);
   }
   if (val.type == 'web_link') {
-    return serializeWebLink(val);
+    return serializeWebLinkMini(val);
   }
   throw new BoxSdkError({ message: 'unknown type' });
 }
@@ -37,13 +37,13 @@ export function deserializeCollaborationItem(
     });
   }
   if (val.type == 'file') {
-    return deserializeFile(val);
+    return deserializeFileMini(val);
   }
   if (val.type == 'folder') {
-    return deserializeFolder(val);
+    return deserializeFolderMini(val);
   }
   if (val.type == 'web_link') {
-    return deserializeWebLink(val);
+    return deserializeWebLinkMini(val);
   }
   throw new BoxSdkError({ message: "Can't deserialize CollaborationItem" });
 }

src/schemas/file.ts

@@ -145,7 +145,7 @@ export class File extends FileMini {
   readonly createdBy?: UserMini;
   readonly modifiedBy?: UserMini;
   readonly ownedBy?: UserMini;
-  readonly sharedLink?: FileSharedLinkField;
+  readonly sharedLink?: FileSharedLinkField | null;
   readonly parent?: FolderMini | null;
   readonly itemStatus?: FileItemStatusField;
   constructor(fields: File) {

src/schemas/fileFull.ts

@@ -303,7 +303,7 @@ export class FileFull extends File {
   readonly metadata?: FileFullMetadataField;
   readonly expiresAt?: DateTime | null;
   readonly representations?: FileFullRepresentationsField;
-  readonly classification?: FileFullClassificationField;
+  readonly classification?: FileFullClassificationField | null;
   readonly uploaderDisplayName?: string;
   readonly dispositionAt?: DateTime | null;
   readonly sharedLinkPermissionOptions?:

src/schemas/webLink.ts

@@ -145,7 +145,7 @@ export class WebLink extends WebLinkMini {
   readonly createdBy?: UserMini;
   readonly modifiedBy?: UserMini;
   readonly ownedBy?: UserMini;
-  readonly sharedLink?: WebLinkSharedLinkField;
+  readonly sharedLink?: WebLinkSharedLinkField | null;
   readonly itemStatus?: WebLinkItemStatusField;
   readonly collections?: readonly Collection[];
   readonly allowedSharedLinkAccessLevels?: readonly WebLinkAllowedSharedLinkAccessLevelsField[];