feat: Add AI spreadsheet processor (box/box-openapi#533) (#649)

Author: box-sdk-build

.codegen.json

@@ -1 +1 @@
-{ "engineHash": "c7328b5", "specHash": "83a5340", "version": "1.16.0" }
+{ "engineHash": "fc1155c", "specHash": "b5422f4", "version": "1.16.0" }

package-lock.json

@@ -2,8 +2,11 @@ import { serializeAiAgentLongTextTool } from './aiAgentLongTextTool.generated.js
 import { deserializeAiAgentLongTextTool } from './aiAgentLongTextTool.generated.js';
 import { serializeAiAgentBasicTextTool } from './aiAgentBasicTextTool.generated.js';
 import { deserializeAiAgentBasicTextTool } from './aiAgentBasicTextTool.generated.js';
+import { serializeAiAgentSpreadsheetTool } from './aiAgentSpreadsheetTool.generated.js';
+import { deserializeAiAgentSpreadsheetTool } from './aiAgentSpreadsheetTool.generated.js';
 import { AiAgentLongTextTool } from './aiAgentLongTextTool.generated.js';
 import { AiAgentBasicTextTool } from './aiAgentBasicTextTool.generated.js';
+import { AiAgentSpreadsheetTool } from './aiAgentSpreadsheetTool.generated.js';
 import { BoxSdkError } from '../box/errors.js';
 import { SerializedData } from '../serialization/json.js';
 import { sdIsEmpty } from '../serialization/json.js';
@@ -19,6 +22,7 @@ export class AiAgentAsk {
   readonly type: AiAgentAskTypeField = 'ai_agent_ask' as AiAgentAskTypeField;
   readonly longText?: AiAgentLongTextTool;
   readonly basicText?: AiAgentBasicTextTool;
+  readonly spreadsheet?: AiAgentSpreadsheetTool;
   readonly longTextMulti?: AiAgentLongTextTool;
   readonly basicTextMulti?: AiAgentBasicTextTool;
   readonly basicImage?: AiAgentBasicTextTool;
@@ -36,6 +40,9 @@ export class AiAgentAsk {
     if (fields.basicText !== undefined) {
       this.basicText = fields.basicText;
     }
+    if (fields.spreadsheet !== undefined) {
+      this.spreadsheet = fields.spreadsheet;
+    }
     if (fields.longTextMulti !== undefined) {
       this.longTextMulti = fields.longTextMulti;
     }
@@ -59,6 +66,7 @@ export interface AiAgentAskInput {
   readonly type?: AiAgentAskTypeField;
   readonly longText?: AiAgentLongTextTool;
   readonly basicText?: AiAgentBasicTextTool;
+  readonly spreadsheet?: AiAgentSpreadsheetTool;
   readonly longTextMulti?: AiAgentLongTextTool;
   readonly basicTextMulti?: AiAgentBasicTextTool;
   readonly basicImage?: AiAgentBasicTextTool;
@@ -89,6 +97,10 @@ export function serializeAiAgentAsk(val: AiAgentAsk): SerializedData {
       val.basicText == void 0
         ? val.basicText
         : serializeAiAgentBasicTextTool(val.basicText),
+    ['spreadsheet']:
+      val.spreadsheet == void 0
+        ? val.spreadsheet
+        : serializeAiAgentSpreadsheetTool(val.spreadsheet),
     ['long_text_multi']:
       val.longTextMulti == void 0
         ? val.longTextMulti
@@ -125,6 +137,10 @@ export function deserializeAiAgentAsk(val: SerializedData): AiAgentAsk {
     val.basic_text == void 0
       ? void 0
       : deserializeAiAgentBasicTextTool(val.basic_text);
+  const spreadsheet: undefined | AiAgentSpreadsheetTool =
+    val.spreadsheet == void 0
+      ? void 0
+      : deserializeAiAgentSpreadsheetTool(val.spreadsheet);
   const longTextMulti: undefined | AiAgentLongTextTool =
     val.long_text_multi == void 0
       ? void 0
@@ -145,6 +161,7 @@ export function deserializeAiAgentAsk(val: SerializedData): AiAgentAsk {
     type: type,
     longText: longText,
     basicText: basicText,
+    spreadsheet: spreadsheet,
     longTextMulti: longTextMulti,
     basicTextMulti: basicTextMulti,
     basicImage: basicImage,
@@ -163,6 +180,10 @@ export function serializeAiAgentAskInput(val: AiAgentAskInput): SerializedData {
       val.basicText == void 0
         ? val.basicText
         : serializeAiAgentBasicTextTool(val.basicText),
+    ['spreadsheet']:
+      val.spreadsheet == void 0
+        ? val.spreadsheet
+        : serializeAiAgentSpreadsheetTool(val.spreadsheet),
     ['long_text_multi']:
       val.longTextMulti == void 0
         ? val.longTextMulti
@@ -197,6 +218,10 @@ export function deserializeAiAgentAskInput(
     val.basic_text == void 0
       ? void 0
       : deserializeAiAgentBasicTextTool(val.basic_text);
+  const spreadsheet: undefined | AiAgentSpreadsheetTool =
+    val.spreadsheet == void 0
+      ? void 0
+      : deserializeAiAgentSpreadsheetTool(val.spreadsheet);
   const longTextMulti: undefined | AiAgentLongTextTool =
     val.long_text_multi == void 0
       ? void 0
@@ -217,6 +242,7 @@ export function deserializeAiAgentAskInput(
     type: type,
     longText: longText,
     basicText: basicText,
+    spreadsheet: spreadsheet,
     longTextMulti: longTextMulti,
     basicTextMulti: basicTextMulti,
     basicImage: basicImage,

src/schemas/aiAgentAsk.generated.ts

@@ -0,0 +1,70 @@
+import { serializeAiLlmEndpointParams } from './aiLlmEndpointParams.generated.js';
+import { deserializeAiLlmEndpointParams } from './aiLlmEndpointParams.generated.js';
+import { AiLlmEndpointParams } from './aiLlmEndpointParams.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 AiAgentSpreadsheetTool {
+  /**
+   * The model used for the AI agent for spreadsheets. For specific model values, see the [available models list](g://box-ai/supported-models). */
+  readonly model?: string;
+  /**
+   * The number of tokens for completion. */
+  readonly numTokensForCompletion?: number;
+  readonly llmEndpointParams?: AiLlmEndpointParams;
+  readonly rawData?: SerializedData;
+}
+export function serializeAiAgentSpreadsheetTool(
+  val: AiAgentSpreadsheetTool,
+): SerializedData {
+  return {
+    ['model']: val.model,
+    ['num_tokens_for_completion']: val.numTokensForCompletion,
+    ['llm_endpoint_params']:
+      val.llmEndpointParams == void 0
+        ? val.llmEndpointParams
+        : serializeAiLlmEndpointParams(val.llmEndpointParams),
+  };
+}
+export function deserializeAiAgentSpreadsheetTool(
+  val: SerializedData,
+): AiAgentSpreadsheetTool {
+  if (!sdIsMap(val)) {
+    throw new BoxSdkError({
+      message: 'Expecting a map for "AiAgentSpreadsheetTool"',
+    });
+  }
+  if (!(val.model == void 0) && !sdIsString(val.model)) {
+    throw new BoxSdkError({
+      message: 'Expecting string for "model" of type "AiAgentSpreadsheetTool"',
+    });
+  }
+  const model: undefined | string = val.model == void 0 ? void 0 : val.model;
+  if (
+    !(val.num_tokens_for_completion == void 0) &&
+    !sdIsNumber(val.num_tokens_for_completion)
+  ) {
+    throw new BoxSdkError({
+      message:
+        'Expecting number for "num_tokens_for_completion" of type "AiAgentSpreadsheetTool"',
+    });
+  }
+  const numTokensForCompletion: undefined | number =
+    val.num_tokens_for_completion == void 0
+      ? void 0
+      : val.num_tokens_for_completion;
+  const llmEndpointParams: undefined | AiLlmEndpointParams =
+    val.llm_endpoint_params == void 0
+      ? void 0
+      : deserializeAiLlmEndpointParams(val.llm_endpoint_params);
+  return {
+    model: model,
+    numTokensForCompletion: numTokensForCompletion,
+    llmEndpointParams: llmEndpointParams,
+  } satisfies AiAgentSpreadsheetTool;
+}