feat: add AI agents warnings; allow for more types of metadata value (box/box-openapi#520)

.codegen.json

@@ -1 +1 @@
-{ "engineHash": "42b7a5b", "specHash": "f737b7b", "version": "1.15.1" }
+{ "engineHash": "c2a365c", "specHash": "6a332e7", "version": "1.15.1" }

docs/folders.md

@@ -92,10 +92,10 @@ Not all available fields are returned by default. Use the
 [fields](#param-fields) query parameter to explicitly request
 any specific fields.
 
-This call will return synchronously. This holds true even when
-moving folders with a large a large number of items in all of its
-descendants. For very large folders, this means the call could
-take minutes or hours to return.
+If the user is moving folders with a large number of items in all of
+their descendants, the call will be run asynchronously. If the
+operation is not completed within 10 minutes, the user will receive
+a 200 OK response, and the operation will continue running.
 
 ## Delete folder
 

docs/transfer.md

@@ -17,8 +17,9 @@ during the operation. Please note that while collaborations at the individual
 file-level are transferred during the operation, the collaborations are
 deleted when the original user is deleted.
 
-This call will be performed synchronously which might lead to a slow response
-when the source user has a large number of items in all of its folders.
+If the user has a large number of items across all folders, the call will
+be run asynchronously. If the operation is not completed within 10 minutes,
+the user will receive a 200 OK response, and the operation will continue running.
 
 If the destination path has a metadata cascade policy attached to any of
 the parent folders, a metadata cascade operation will be kicked off

src/managers/fileMetadata.generated.ts

@@ -4,10 +4,13 @@ import { serializeClientError } from '../schemas/clientError.generated.js';
 import { deserializeClientError } from '../schemas/clientError.generated.js';
 import { serializeMetadataFull } from '../schemas/metadataFull.generated.js';
 import { deserializeMetadataFull } from '../schemas/metadataFull.generated.js';
+import { serializeMetadataInstanceValue } from '../schemas/metadataInstanceValue.generated.js';
+import { deserializeMetadataInstanceValue } from '../schemas/metadataInstanceValue.generated.js';
 import { ResponseFormat } from '../networking/fetchOptions.generated.js';
 import { Metadatas } from '../schemas/metadatas.generated.js';
 import { ClientError } from '../schemas/clientError.generated.js';
 import { MetadataFull } from '../schemas/metadataFull.generated.js';
+import { MetadataInstanceValue } from '../schemas/metadataInstanceValue.generated.js';
 import { BoxSdkError } from '../box/errors.js';
 import { Authentication } from '../networking/auth.generated.js';
 import { NetworkSession } from '../networking/network.generated.js';
@@ -245,17 +248,7 @@ export interface UpdateFileMetadataByIdRequestBody {
    * of the template. The characters `~` and `/` are reserved
    * characters and must be escaped in the key. */
   readonly path?: string;
-  /**
-   * The value to be set or tested.
-   *
-   * Required for `add`, `replace`, and `test` operations. For `add`,
-   * if the value exists already the previous value will be overwritten
-   * by the new value. For `replace`, the value must exist before
-   * replacing.
-   *
-   * For `test`, the existing value at the `path` location must match
-   * the specified value. */
-  readonly value?: string;
+  readonly value?: MetadataInstanceValue;
   /**
    * The location in the metadata JSON object to move or copy a value
    * from. Required for `move` or `copy` operations and must be in the
@@ -773,7 +766,10 @@ export function serializeUpdateFileMetadataByIdRequestBody(
         ? val.op
         : serializeUpdateFileMetadataByIdRequestBodyOpField(val.op),
     ['path']: val.path,
-    ['value']: val.value,
+    ['value']:
+      val.value == void 0
+        ? val.value
+        : serializeMetadataInstanceValue(val.value),
     ['from']: val.from,
   };
 }
@@ -796,13 +792,8 @@ export function deserializeUpdateFileMetadataByIdRequestBody(
     });
   }
   const path: undefined | string = val.path == void 0 ? void 0 : val.path;
-  if (!(val.value == void 0) && !sdIsString(val.value)) {
-    throw new BoxSdkError({
-      message:
-        'Expecting string for "value" of type "UpdateFileMetadataByIdRequestBody"',
-    });
-  }
-  const value: undefined | string = val.value == void 0 ? void 0 : val.value;
+  const value: undefined | MetadataInstanceValue =
+    val.value == void 0 ? void 0 : deserializeMetadataInstanceValue(val.value);
   if (!(val.from == void 0) && !sdIsString(val.from)) {
     throw new BoxSdkError({
       message:

src/managers/folderMetadata.generated.ts

@@ -4,10 +4,13 @@ import { serializeClientError } from '../schemas/clientError.generated.js';
 import { deserializeClientError } from '../schemas/clientError.generated.js';
 import { serializeMetadataFull } from '../schemas/metadataFull.generated.js';
 import { deserializeMetadataFull } from '../schemas/metadataFull.generated.js';
+import { serializeMetadataInstanceValue } from '../schemas/metadataInstanceValue.generated.js';
+import { deserializeMetadataInstanceValue } from '../schemas/metadataInstanceValue.generated.js';
 import { ResponseFormat } from '../networking/fetchOptions.generated.js';
 import { Metadatas } from '../schemas/metadatas.generated.js';
 import { ClientError } from '../schemas/clientError.generated.js';
 import { MetadataFull } from '../schemas/metadataFull.generated.js';
+import { MetadataInstanceValue } from '../schemas/metadataInstanceValue.generated.js';
 import { BoxSdkError } from '../box/errors.js';
 import { Authentication } from '../networking/auth.generated.js';
 import { NetworkSession } from '../networking/network.generated.js';
@@ -246,17 +249,7 @@ export interface UpdateFolderMetadataByIdRequestBody {
    * of the template. The characters `~` and `/` are reserved
    * characters and must be escaped in the key. */
   readonly path?: string;
-  /**
-   * The value to be set or tested.
-   *
-   * Required for `add`, `replace`, and `test` operations. For `add`,
-   * if the value exists already the previous value will be overwritten
-   * by the new value. For `replace`, the value must exist before
-   * replacing.
-   *
-   * For `test`, the existing value at the `path` location must match
-   * the specified value. */
-  readonly value?: string;
+  readonly value?: MetadataInstanceValue;
   /**
    * The location in the metadata JSON object to move or copy a value
    * from. Required for `move` or `copy` operations and must be in the
@@ -795,7 +788,10 @@ export function serializeUpdateFolderMetadataByIdRequestBody(
         ? val.op
         : serializeUpdateFolderMetadataByIdRequestBodyOpField(val.op),
     ['path']: val.path,
-    ['value']: val.value,
+    ['value']:
+      val.value == void 0
+        ? val.value
+        : serializeMetadataInstanceValue(val.value),
     ['from']: val.from,
   };
 }
@@ -818,13 +814,8 @@ export function deserializeUpdateFolderMetadataByIdRequestBody(
     });
   }
   const path: undefined | string = val.path == void 0 ? void 0 : val.path;
-  if (!(val.value == void 0) && !sdIsString(val.value)) {
-    throw new BoxSdkError({
-      message:
-        'Expecting string for "value" of type "UpdateFolderMetadataByIdRequestBody"',
-    });
-  }
-  const value: undefined | string = val.value == void 0 ? void 0 : val.value;
+  const value: undefined | MetadataInstanceValue =
+    val.value == void 0 ? void 0 : deserializeMetadataInstanceValue(val.value);
   if (!(val.from == void 0) && !sdIsString(val.from)) {
     throw new BoxSdkError({
       message:

src/managers/transfer.generated.ts

@@ -139,8 +139,9 @@ export class TransferManager {
      * file-level are transferred during the operation, the collaborations are
      * deleted when the original user is deleted.
      *
-     * This call will be performed synchronously which might lead to a slow response
-     * when the source user has a large number of items in all of its folders.
+     * If the user has a large number of items across all folders, the call will
+     * be run asynchronously. If the operation is not completed within 10 minutes,
+     * the user will receive a 200 OK response, and the operation will continue running.
      *
      * If the destination path has a metadata cascade policy attached to any of
      * the parent folders, a metadata cascade operation will be kicked off

src/schemas/aiSingleAgentResponseFull.generated.ts

@@ -8,20 +8,20 @@ import { serializeAiAgentAllowedEntity } from './aiAgentAllowedEntity.generated.
 import { deserializeAiAgentAllowedEntity } from './aiAgentAllowedEntity.generated.js';
 import { serializeAiSingleAgentResponse } from './aiSingleAgentResponse.generated.js';
 import { deserializeAiSingleAgentResponse } from './aiSingleAgentResponse.generated.js';
-import { serializeAiStudioAgentAsk } from './aiStudioAgentAsk.generated.js';
-import { deserializeAiStudioAgentAsk } from './aiStudioAgentAsk.generated.js';
-import { serializeAiStudioAgentTextGen } from './aiStudioAgentTextGen.generated.js';
-import { deserializeAiStudioAgentTextGen } from './aiStudioAgentTextGen.generated.js';
-import { serializeAiStudioAgentExtract } from './aiStudioAgentExtract.generated.js';
-import { deserializeAiStudioAgentExtract } from './aiStudioAgentExtract.generated.js';
+import { serializeAiStudioAgentAskResponse } from './aiStudioAgentAskResponse.generated.js';
+import { deserializeAiStudioAgentAskResponse } from './aiStudioAgentAskResponse.generated.js';
+import { serializeAiStudioAgentTextGenResponse } from './aiStudioAgentTextGenResponse.generated.js';
+import { deserializeAiStudioAgentTextGenResponse } from './aiStudioAgentTextGenResponse.generated.js';
+import { serializeAiStudioAgentExtractResponse } from './aiStudioAgentExtractResponse.generated.js';
+import { deserializeAiStudioAgentExtractResponse } from './aiStudioAgentExtractResponse.generated.js';
 import { AiSingleAgentResponseTypeField } from './aiSingleAgentResponse.generated.js';
 import { UserBase } from './userBase.generated.js';
 import { DateTime } from '../internal/utils.js';
 import { AiAgentAllowedEntity } from './aiAgentAllowedEntity.generated.js';
 import { AiSingleAgentResponse } from './aiSingleAgentResponse.generated.js';
-import { AiStudioAgentAsk } from './aiStudioAgentAsk.generated.js';
-import { AiStudioAgentTextGen } from './aiStudioAgentTextGen.generated.js';
-import { AiStudioAgentExtract } from './aiStudioAgentExtract.generated.js';
+import { AiStudioAgentAskResponse } from './aiStudioAgentAskResponse.generated.js';
+import { AiStudioAgentTextGenResponse } from './aiStudioAgentTextGenResponse.generated.js';
+import { AiStudioAgentExtractResponse } from './aiStudioAgentExtractResponse.generated.js';
 import { BoxSdkError } from '../box/errors.js';
 import { SerializedData } from '../serialization/json.js';
 import { sdIsEmpty } from '../serialization/json.js';
@@ -31,9 +31,9 @@ import { sdIsString } from '../serialization/json.js';
 import { sdIsList } from '../serialization/json.js';
 import { sdIsMap } from '../serialization/json.js';
 export type AiSingleAgentResponseFull = AiSingleAgentResponse & {
-  readonly ask?: AiStudioAgentAsk;
-  readonly textGen?: AiStudioAgentTextGen;
-  readonly extract?: AiStudioAgentExtract;
+  readonly ask?: AiStudioAgentAskResponse;
+  readonly textGen?: AiStudioAgentTextGenResponse;
+  readonly extract?: AiStudioAgentExtractResponse;
 };
 export function serializeAiSingleAgentResponseFull(
   val: AiSingleAgentResponseFull,
@@ -47,15 +47,18 @@ export function serializeAiSingleAgentResponseFull(
   return {
     ...base,
     ...{
-      ['ask']: val.ask == void 0 ? val.ask : serializeAiStudioAgentAsk(val.ask),
+      ['ask']:
+        val.ask == void 0
+          ? val.ask
+          : serializeAiStudioAgentAskResponse(val.ask),
       ['text_gen']:
         val.textGen == void 0
           ? val.textGen
-          : serializeAiStudioAgentTextGen(val.textGen),
+          : serializeAiStudioAgentTextGenResponse(val.textGen),
       ['extract']:
         val.extract == void 0
           ? val.extract
-          : serializeAiStudioAgentExtract(val.extract),
+          : serializeAiStudioAgentExtractResponse(val.extract),
     },
   };
 }
@@ -67,16 +70,16 @@ export function deserializeAiSingleAgentResponseFull(
       message: 'Expecting a map for "AiSingleAgentResponseFull"',
     });
   }
-  const ask: undefined | AiStudioAgentAsk =
-    val.ask == void 0 ? void 0 : deserializeAiStudioAgentAsk(val.ask);
-  const textGen: undefined | AiStudioAgentTextGen =
+  const ask: undefined | AiStudioAgentAskResponse =
+    val.ask == void 0 ? void 0 : deserializeAiStudioAgentAskResponse(val.ask);
+  const textGen: undefined | AiStudioAgentTextGenResponse =
     val.text_gen == void 0
       ? void 0
-      : deserializeAiStudioAgentTextGen(val.text_gen);
-  const extract: undefined | AiStudioAgentExtract =
+      : deserializeAiStudioAgentTextGenResponse(val.text_gen);
+  const extract: undefined | AiStudioAgentExtractResponse =
     val.extract == void 0
       ? void 0
-      : deserializeAiStudioAgentExtract(val.extract);
+      : deserializeAiStudioAgentExtractResponse(val.extract);
   if (val.id == void 0) {
     throw new BoxSdkError({
       message: