box-node-sdk/src/schemas/aiStudioAgentAskResponse.ts

Official SDK for Box Platform APIs

import { serializeAiStudioAgentLongTextToolResponse } from './aiStudioAgentLongTextToolResponse';
import { deserializeAiStudioAgentLongTextToolResponse } from './aiStudioAgentLongTextToolResponse';
import { serializeAiStudioAgentBasicTextToolResponse } from './aiStudioAgentBasicTextToolResponse';
import { deserializeAiStudioAgentBasicTextToolResponse } from './aiStudioAgentBasicTextToolResponse';
import { serializeAiStudioAgentSpreadsheetToolResponse } from './aiStudioAgentSpreadsheetToolResponse';
import { deserializeAiStudioAgentSpreadsheetToolResponse } from './aiStudioAgentSpreadsheetToolResponse';
import { AiStudioAgentLongTextToolResponse } from './aiStudioAgentLongTextToolResponse';
import { AiStudioAgentBasicTextToolResponse } from './aiStudioAgentBasicTextToolResponse';
import { AiStudioAgentSpreadsheetToolResponse } from './aiStudioAgentSpreadsheetToolResponse';
import { BoxSdkError } from '../box/errors';
import { SerializedData } from '../serialization/json';
import { sdIsEmpty } from '../serialization/json';
import { sdIsBoolean } from '../serialization/json';
import { sdIsNumber } from '../serialization/json';
import { sdIsString } from '../serialization/json';
import { sdIsList } from '../serialization/json';
import { sdIsMap } from '../serialization/json';
export type AiStudioAgentAskResponseTypeField = 'ai_agent_ask';
export class AiStudioAgentAskResponse {
  /**
   * The type of AI agent used to ask questions. */
  readonly type: AiStudioAgentAskResponseTypeField =
    'ai_agent_ask' as AiStudioAgentAskResponseTypeField;
  /**
   * The state of the AI Agent capability. Possible values are: `enabled` and `disabled`. */
  readonly accessState!: string;
  /**
   * The description of the AI agent. */
  readonly description!: string;
  /**
   * Custom instructions for the AI agent. */
  readonly customInstructions?: string | null;
  /**
   * Suggested questions for the AI agent. If null, suggested question will be generated. If empty, no suggested questions will be displayed. */
  readonly suggestedQuestions?: readonly string[];
  readonly longText?: AiStudioAgentLongTextToolResponse;
  readonly basicText?: AiStudioAgentBasicTextToolResponse;
  readonly basicImage?: AiStudioAgentBasicTextToolResponse;
  readonly spreadsheet?: AiStudioAgentSpreadsheetToolResponse;
  readonly longTextMulti?: AiStudioAgentLongTextToolResponse;
  readonly basicTextMulti?: AiStudioAgentBasicTextToolResponse;
  readonly basicImageMulti?: AiStudioAgentBasicTextToolResponse;
  readonly rawData?: SerializedData;
  constructor(
    fields: Omit<AiStudioAgentAskResponse, 'type'> &
      Partial<Pick<AiStudioAgentAskResponse, 'type'>>,
  ) {
    if (fields.type !== undefined) {
      this.type = fields.type;
    }
    if (fields.accessState !== undefined) {
      this.accessState = fields.accessState;
    }
    if (fields.description !== undefined) {
      this.description = fields.description;
    }
    if (fields.customInstructions !== undefined) {
      this.customInstructions = fields.customInstructions;
    }
    if (fields.suggestedQuestions !== undefined) {
      this.suggestedQuestions = fields.suggestedQuestions;
    }
    if (fields.longText !== undefined) {
      this.longText = fields.longText;
    }
    if (fields.basicText !== undefined) {
      this.basicText = fields.basicText;
    }
    if (fields.basicImage !== undefined) {
      this.basicImage = fields.basicImage;
    }
    if (fields.spreadsheet !== undefined) {
      this.spreadsheet = fields.spreadsheet;
    }
    if (fields.longTextMulti !== undefined) {
      this.longTextMulti = fields.longTextMulti;
    }
    if (fields.basicTextMulti !== undefined) {
      this.basicTextMulti = fields.basicTextMulti;
    }
    if (fields.basicImageMulti !== undefined) {
      this.basicImageMulti = fields.basicImageMulti;
    }
    if (fields.rawData !== undefined) {
      this.rawData = fields.rawData;
    }
  }
}
export interface AiStudioAgentAskResponseInput {
  /**
   * The type of AI agent used to ask questions. */
  readonly type?: AiStudioAgentAskResponseTypeField;
  /**
   * The state of the AI Agent capability. Possible values are: `enabled` and `disabled`. */
  readonly accessState: string;
  /**
   * The description of the AI agent. */
  readonly description: string;
  /**
   * Custom instructions for the AI agent. */
  readonly customInstructions?: string | null;
  /**
   * Suggested questions for the AI agent. If null, suggested question will be generated. If empty, no suggested questions will be displayed. */
  readonly suggestedQuestions?: readonly string[];
  readonly longText?: AiStudioAgentLongTextToolResponse;
  readonly basicText?: AiStudioAgentBasicTextToolResponse;
  readonly basicImage?: AiStudioAgentBasicTextToolResponse;
  readonly spreadsheet?: AiStudioAgentSpreadsheetToolResponse;
  readonly longTextMulti?: AiStudioAgentLongTextToolResponse;
  readonly basicTextMulti?: AiStudioAgentBasicTextToolResponse;
  readonly basicImageMulti?: AiStudioAgentBasicTextToolResponse;
  readonly rawData?: SerializedData;
}
export function serializeAiStudioAgentAskResponseTypeField(
  val: AiStudioAgentAskResponseTypeField,
): SerializedData {
  return val;
}
export function deserializeAiStudioAgentAskResponseTypeField(
  val: SerializedData,
): AiStudioAgentAskResponseTypeField {
  if (val == 'ai_agent_ask') {
    return val;
  }
  throw new BoxSdkError({
    message: "Can't deserialize AiStudioAgentAskResponseTypeField",
  });
}
export function serializeAiStudioAgentAskResponse(
  val: AiStudioAgentAskResponse,
): SerializedData {
  return {
    ['type']: serializeAiStudioAgentAskResponseTypeField(val.type),
    ['access_state']: val.accessState,
    ['description']: val.description,
    ['custom_instructions']: val.customInstructions,
    ['suggested_questions']:
      val.suggestedQuestions == void 0
        ? val.suggestedQuestions
        : (val.suggestedQuestions.map(function (item: string): SerializedData {
            return item;
          }) as readonly any[]),
    ['long_text']:
      val.longText == void 0
        ? val.longText
        : serializeAiStudioAgentLongTextToolResponse(val.longText),
    ['basic_text']:
      val.basicText == void 0
        ? val.basicText
        : serializeAiStudioAgentBasicTextToolResponse(val.basicText),
    ['basic_image']:
      val.basicImage == void 0
        ? val.basicImage
        : serializeAiStudioAgentBasicTextToolResponse(val.basicImage),
    ['spreadsheet']:
      val.spreadsheet == void 0
        ? val.spreadsheet
        : serializeAiStudioAgentSpreadsheetToolResponse(val.spreadsheet),
    ['long_text_multi']:
      val.longTextMulti == void 0
        ? val.longTextMulti
        : serializeAiStudioAgentLongTextToolResponse(val.longTextMulti),
    ['basic_text_multi']:
      val.basicTextMulti == void 0
        ? val.basicTextMulti
        : serializeAiStudioAgentBasicTextToolResponse(val.basicTextMulti),
    ['basic_image_multi']:
      val.basicImageMulti == void 0
        ? val.basicImageMulti
        : serializeAiStudioAgentBasicTextToolResponse(val.basicImageMulti),
  };
}
export function deserializeAiStudioAgentAskResponse(
  val: SerializedData,
): AiStudioAgentAskResponse {
  if (!sdIsMap(val)) {
    throw new BoxSdkError({
      message: 'Expecting a map for "AiStudioAgentAskResponse"',
    });
  }
  if (val.type == void 0) {
    throw new BoxSdkError({
      message:
        'Expecting "type" of type "AiStudioAgentAskResponse" to be defined',
    });
  }
  const type: AiStudioAgentAskResponseTypeField =
    deserializeAiStudioAgentAskResponseTypeField(val.type);
  if (val.access_state == void 0) {
    throw new BoxSdkError({
      message:
        'Expecting "access_state" of type "AiStudioAgentAskResponse" to be defined',
    });
  }
  if (!sdIsString(val.access_state)) {
    throw new BoxSdkError({
      message:
        'Expecting string for "access_state" of type "AiStudioAgentAskResponse"',
    });
  }
  const accessState: string = val.access_state;
  if (val.description == void 0) {
    throw new BoxSdkError({
      message:
        'Expecting "description" of type "AiStudioAgentAskResponse" to be defined',
    });
  }
  if (!sdIsString(val.description)) {
    throw new BoxSdkError({
      message:
        'Expecting string for "description" of type "AiStudioAgentAskResponse"',
    });
  }
  const description: string = val.description;
  if (
    !(val.custom_instructions == void 0) &&
    !sdIsString(val.custom_instructions)
  ) {
    throw new BoxSdkError({
      message:
        'Expecting string for "custom_instructions" of type "AiStudioAgentAskResponse"',
    });
  }
  const customInstructions: undefined | string =
    val.custom_instructions == void 0 ? void 0 : val.custom_instructions;
  if (
    !(val.suggested_questions == void 0) &&
    !sdIsList(val.suggested_questions)
  ) {
    throw new BoxSdkError({
      message:
        'Expecting array for "suggested_questions" of type "AiStudioAgentAskResponse"',
    });
  }
  const suggestedQuestions: undefined | readonly string[] =
    val.suggested_questions == void 0
      ? void 0
      : sdIsList(val.suggested_questions)
        ? (val.suggested_questions.map(function (itm: SerializedData): string {
            if (!sdIsString(itm)) {
              throw new BoxSdkError({
                message: 'Expecting string for "AiStudioAgentAskResponse"',
              });
            }
            return itm;
          }) as readonly any[])
        : [];
  const longText: undefined | AiStudioAgentLongTextToolResponse =
    val.long_text == void 0
      ? void 0
      : deserializeAiStudioAgentLongTextToolResponse(val.long_text);
  const basicText: undefined | AiStudioAgentBasicTextToolResponse =
    val.basic_text == void 0
      ? void 0
      : deserializeAiStudioAgentBasicTextToolResponse(val.basic_text);
  const basicImage: undefined | AiStudioAgentBasicTextToolResponse =
    val.basic_image == void 0
      ? void 0
      : deserializeAiStudioAgentBasicTextToolResponse(val.basic_image);
  const spreadsheet: undefined | AiStudioAgentSpreadsheetToolResponse =
    val.spreadsheet == void 0
      ? void 0
      : deserializeAiStudioAgentSpreadsheetToolResponse(val.spreadsheet);
  const longTextMulti: undefined | AiStudioAgentLongTextToolResponse =
    val.long_text_multi == void 0
      ? void 0
      : deserializeAiStudioAgentLongTextToolResponse(val.long_text_multi);
  const basicTextMulti: undefined | AiStudioAgentBasicTextToolResponse =
    val.basic_text_multi == void 0
      ? void 0
      : deserializeAiStudioAgentBasicTextToolResponse(val.basic_text_multi);
  const basicImageMulti: undefined | AiStudioAgentBasicTextToolResponse =
    val.basic_image_multi == void 0
      ? void 0
      : deserializeAiStudioAgentBasicTextToolResponse(val.basic_image_multi);
  return {
    type: type,
    accessState: accessState,
    description: description,
    customInstructions: customInstructions,
    suggestedQuestions: suggestedQuestions,
    longText: longText,
    basicText: basicText,
    basicImage: basicImage,
    spreadsheet: spreadsheet,
    longTextMulti: longTextMulti,
    basicTextMulti: basicTextMulti,
    basicImageMulti: basicImageMulti,
  } satisfies AiStudioAgentAskResponse;
}
export function serializeAiStudioAgentAskResponseInput(
  val: AiStudioAgentAskResponseInput,
): SerializedData {
  return {
    ['type']:
      val.type == void 0
        ? val.type
        : serializeAiStudioAgentAskResponseTypeField(val.type),
    ['access_state']: val.accessState,
    ['description']: val.description,
    ['custom_instructions']: val.customInstructions,
    ['suggested_questions']:
      val.suggestedQuestions == void 0
        ? val.suggestedQuestions
        : (val.suggestedQuestions.map(function (item: string): SerializedData {
            return item;
          }) as readonly any[]),
    ['long_text']:
      val.longText == void 0
        ? val.longText
        : serializeAiStudioAgentLongTextToolResponse(val.longText),
    ['basic_text']:
      val.basicText == void 0
        ? val.basicText
        : serializeAiStudioAgentBasicTextToolResponse(val.basicText),
    ['basic_image']:
      val.basicImage == void 0
        ? val.basicImage
        : serializeAiStudioAgentBasicTextToolResponse(val.basicImage),
    ['spreadsheet']:
      val.spreadsheet == void 0
        ? val.spreadsheet
        : serializeAiStudioAgentSpreadsheetToolResponse(val.spreadsheet),
    ['long_text_multi']:
      val.longTextMulti == void 0
        ? val.longTextMulti
        : serializeAiStudioAgentLongTextToolResponse(val.longTextMulti),
    ['basic_text_multi']:
      val.basicTextMulti == void 0
        ? val.basicTextMulti
        : serializeAiStudioAgentBasicTextToolResponse(val.basicTextMulti),
    ['basic_image_multi']:
      val.basicImageMulti == void 0
        ? val.basicImageMulti
        : serializeAiStudioAgentBasicTextToolResponse(val.basicImageMulti),
  };
}
export function deserializeAiStudioAgentAskResponseInput(
  val: SerializedData,
): AiStudioAgentAskResponseInput {
  if (!sdIsMap(val)) {
    throw new BoxSdkError({
      message: 'Expecting a map for "AiStudioAgentAskResponseInput"',
    });
  }
  const type: undefined | AiStudioAgentAskResponseTypeField =
    val.type == void 0
      ? void 0
      : deserializeAiStudioAgentAskResponseTypeField(val.type);
  if (val.access_state == void 0) {
    throw new BoxSdkError({
      message:
        'Expecting "access_state" of type "AiStudioAgentAskResponseInput" to be defined',
    });
  }
  if (!sdIsString(val.access_state)) {
    throw new BoxSdkError({
      message:
        'Expecting string for "access_state" of type "AiStudioAgentAskResponseInput"',
    });
  }
  const accessState: string = val.access_state;
  if (val.description == void 0) {
    throw new BoxSdkError({
      message:
        'Expecting "description" of type "AiStudioAgentAskResponseInput" to be defined',
    });
  }
  if (!sdIsString(val.description)) {
    throw new BoxSdkError({
      message:
        'Expecting string for "description" of type "AiStudioAgentAskResponseInput"',
    });
  }
  const description: string = val.description;
  if (
    !(val.custom_instructions == void 0) &&
    !sdIsString(val.custom_instructions)
  ) {
    throw new BoxSdkError({
      message:
        'Expecting string for "custom_instructions" of type "AiStudioAgentAskResponseInput"',
    });
  }
  const customInstructions: undefined | string =
    val.custom_instructions == void 0 ? void 0 : val.custom_instructions;
  if (
    !(val.suggested_questions == void 0) &&
    !sdIsList(val.suggested_questions)
  ) {
    throw new BoxSdkError({
      message:
        'Expecting array for "suggested_questions" of type "AiStudioAgentAskResponseInput"',
    });
  }
  const suggestedQuestions: undefined | readonly string[] =
    val.suggested_questions == void 0
      ? void 0
      : sdIsList(val.suggested_questions)
        ? (val.suggested_questions.map(function (itm: SerializedData): string {
            if (!sdIsString(itm)) {
              throw new BoxSdkError({
                message: 'Expecting string for "AiStudioAgentAskResponseInput"',
              });
            }
            return itm;
          }) as readonly any[])
        : [];
  const longText: undefined | AiStudioAgentLongTextToolResponse =
    val.long_text == void 0
      ? void 0
      : deserializeAiStudioAgentLongTextToolResponse(val.long_text);
  const basicText: undefined | AiStudioAgentBasicTextToolResponse =
    val.basic_text == void 0
      ? void 0
      : deserializeAiStudioAgentBasicTextToolResponse(val.basic_text);
  const basicImage: undefined | AiStudioAgentBasicTextToolResponse =
    val.basic_image == void 0
      ? void 0
      : deserializeAiStudioAgentBasicTextToolResponse(val.basic_image);
  const spreadsheet: undefined | AiStudioAgentSpreadsheetToolResponse =
    val.spreadsheet == void 0
      ? void 0
      : deserializeAiStudioAgentSpreadsheetToolResponse(val.spreadsheet);
  const longTextMulti: undefined | AiStudioAgentLongTextToolResponse =
    val.long_text_multi == void 0
      ? void 0
      : deserializeAiStudioAgentLongTextToolResponse(val.long_text_multi);
  const basicTextMulti: undefined | AiStudioAgentBasicTextToolResponse =
    val.basic_text_multi == void 0
      ? void 0
      : deserializeAiStudioAgentBasicTextToolResponse(val.basic_text_multi);
  const basicImageMulti: undefined | AiStudioAgentBasicTextToolResponse =
    val.basic_image_multi == void 0
      ? void 0
      : deserializeAiStudioAgentBasicTextToolResponse(val.basic_image_multi);
  return {
    type: type,
    accessState: accessState,
    description: description,
    customInstructions: customInstructions,
    suggestedQuestions: suggestedQuestions,
    longText: longText,
    basicText: basicText,
    basicImage: basicImage,
    spreadsheet: spreadsheet,
    longTextMulti: longTextMulti,
    basicTextMulti: basicTextMulti,
    basicImageMulti: basicImageMulti,
  } satisfies AiStudioAgentAskResponseInput;
}