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

Official SDK for Box Platform APIs

import { serializeAiStudioAgentBasicGenTool } from './aiStudioAgentBasicGenTool';
import { deserializeAiStudioAgentBasicGenTool } from './aiStudioAgentBasicGenTool';
import { AiStudioAgentBasicGenTool } from './aiStudioAgentBasicGenTool';
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 AiStudioAgentTextGenTypeField = 'ai_agent_text_gen';
export class AiStudioAgentTextGen {
  /**
   * The type of AI agent used for generating text. */
  readonly type: AiStudioAgentTextGenTypeField =
    'ai_agent_text_gen' as AiStudioAgentTextGenTypeField;
  /**
   * 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 basicGen?: AiStudioAgentBasicGenTool;
  readonly rawData?: SerializedData;
  constructor(
    fields: Omit<AiStudioAgentTextGen, 'type'> &
      Partial<Pick<AiStudioAgentTextGen, '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.basicGen !== undefined) {
      this.basicGen = fields.basicGen;
    }
    if (fields.rawData !== undefined) {
      this.rawData = fields.rawData;
    }
  }
}
export interface AiStudioAgentTextGenInput {
  /**
   * The type of AI agent used for generating text. */
  readonly type?: AiStudioAgentTextGenTypeField;
  /**
   * 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 basicGen?: AiStudioAgentBasicGenTool;
  readonly rawData?: SerializedData;
}
export function serializeAiStudioAgentTextGenTypeField(
  val: AiStudioAgentTextGenTypeField,
): SerializedData {
  return val;
}
export function deserializeAiStudioAgentTextGenTypeField(
  val: SerializedData,
): AiStudioAgentTextGenTypeField {
  if (val == 'ai_agent_text_gen') {
    return val;
  }
  throw new BoxSdkError({
    message: "Can't deserialize AiStudioAgentTextGenTypeField",
  });
}
export function serializeAiStudioAgentTextGen(
  val: AiStudioAgentTextGen,
): SerializedData {
  return {
    ['type']: serializeAiStudioAgentTextGenTypeField(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[]),
    ['basic_gen']:
      val.basicGen == void 0
        ? val.basicGen
        : serializeAiStudioAgentBasicGenTool(val.basicGen),
  };
}
export function deserializeAiStudioAgentTextGen(
  val: SerializedData,
): AiStudioAgentTextGen {
  if (!sdIsMap(val)) {
    throw new BoxSdkError({
      message: 'Expecting a map for "AiStudioAgentTextGen"',
    });
  }
  if (val.type == void 0) {
    throw new BoxSdkError({
      message: 'Expecting "type" of type "AiStudioAgentTextGen" to be defined',
    });
  }
  const type: AiStudioAgentTextGenTypeField =
    deserializeAiStudioAgentTextGenTypeField(val.type);
  if (val.access_state == void 0) {
    throw new BoxSdkError({
      message:
        'Expecting "access_state" of type "AiStudioAgentTextGen" to be defined',
    });
  }
  if (!sdIsString(val.access_state)) {
    throw new BoxSdkError({
      message:
        'Expecting string for "access_state" of type "AiStudioAgentTextGen"',
    });
  }
  const accessState: string = val.access_state;
  if (val.description == void 0) {
    throw new BoxSdkError({
      message:
        'Expecting "description" of type "AiStudioAgentTextGen" to be defined',
    });
  }
  if (!sdIsString(val.description)) {
    throw new BoxSdkError({
      message:
        'Expecting string for "description" of type "AiStudioAgentTextGen"',
    });
  }
  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 "AiStudioAgentTextGen"',
    });
  }
  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 "AiStudioAgentTextGen"',
    });
  }
  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 "AiStudioAgentTextGen"',
              });
            }
            return itm;
          }) as readonly any[])
        : [];
  const basicGen: undefined | AiStudioAgentBasicGenTool =
    val.basic_gen == void 0
      ? void 0
      : deserializeAiStudioAgentBasicGenTool(val.basic_gen);
  return {
    type: type,
    accessState: accessState,
    description: description,
    customInstructions: customInstructions,
    suggestedQuestions: suggestedQuestions,
    basicGen: basicGen,
  } satisfies AiStudioAgentTextGen;
}
export function serializeAiStudioAgentTextGenInput(
  val: AiStudioAgentTextGenInput,
): SerializedData {
  return {
    ['type']:
      val.type == void 0
        ? val.type
        : serializeAiStudioAgentTextGenTypeField(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[]),
    ['basic_gen']:
      val.basicGen == void 0
        ? val.basicGen
        : serializeAiStudioAgentBasicGenTool(val.basicGen),
  };
}
export function deserializeAiStudioAgentTextGenInput(
  val: SerializedData,
): AiStudioAgentTextGenInput {
  if (!sdIsMap(val)) {
    throw new BoxSdkError({
      message: 'Expecting a map for "AiStudioAgentTextGenInput"',
    });
  }
  const type: undefined | AiStudioAgentTextGenTypeField =
    val.type == void 0
      ? void 0
      : deserializeAiStudioAgentTextGenTypeField(val.type);
  if (val.access_state == void 0) {
    throw new BoxSdkError({
      message:
        'Expecting "access_state" of type "AiStudioAgentTextGenInput" to be defined',
    });
  }
  if (!sdIsString(val.access_state)) {
    throw new BoxSdkError({
      message:
        'Expecting string for "access_state" of type "AiStudioAgentTextGenInput"',
    });
  }
  const accessState: string = val.access_state;
  if (val.description == void 0) {
    throw new BoxSdkError({
      message:
        'Expecting "description" of type "AiStudioAgentTextGenInput" to be defined',
    });
  }
  if (!sdIsString(val.description)) {
    throw new BoxSdkError({
      message:
        'Expecting string for "description" of type "AiStudioAgentTextGenInput"',
    });
  }
  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 "AiStudioAgentTextGenInput"',
    });
  }
  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 "AiStudioAgentTextGenInput"',
    });
  }
  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 "AiStudioAgentTextGenInput"',
              });
            }
            return itm;
          }) as readonly any[])
        : [];
  const basicGen: undefined | AiStudioAgentBasicGenTool =
    val.basic_gen == void 0
      ? void 0
      : deserializeAiStudioAgentBasicGenTool(val.basic_gen);
  return {
    type: type,
    accessState: accessState,
    description: description,
    customInstructions: customInstructions,
    suggestedQuestions: suggestedQuestions,
    basicGen: basicGen,
  } satisfies AiStudioAgentTextGenInput;
}