syllable-sdk 0.1.0-alpha.48 → 0.1.0-alpha.49

package/src/models/components/agentresponse.ts

@@ -25,6 +25,12 @@ import {
   CustomMessageResponse$Outbound,
   CustomMessageResponse$outboundSchema,
 } from "./custommessageresponse.js";
+import {
+  LanguageGroupResponse,
+  LanguageGroupResponse$inboundSchema,
+  LanguageGroupResponse$Outbound,
+  LanguageGroupResponse$outboundSchema,
+} from "./languagegroupresponse.js";
 import {
   PromptResponse,
   PromptResponse$inboundSchema,
@@ -70,6 +76,10 @@ export type AgentResponse = {
    * ID of the custom message that should be delivered at the beginning of a conversation with the agent
    */
   customMessageId: number;
+  /**
+   * ID of the language group associated with the agent
+   */
+  languageGroupId?: number | null | undefined;
   /**
    * The time zone in which the agent operates
    */
@@ -80,6 +90,8 @@ export type AgentResponse = {
   promptToolDefaults?: Array<AgentToolDefaults> | undefined;
   /**
    * BCP 47 codes of languages the agent supports
+   *
+   * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
    */
   languages?: Array<string> | undefined;
   /**
@@ -122,6 +134,10 @@ export type AgentResponse = {
    * Tools associated with the agent
    */
   tools?: Array<ToolResponse> | null | undefined;
+  /**
+   * The language group associated with the agent
+   */
+  languageGroup?: LanguageGroupResponse | null | undefined;
 };
 
 /** @internal */
@@ -136,6 +152,7 @@ export const AgentResponse$inboundSchema: z.ZodType<
   type: z.string(),
   prompt_id: z.number().int(),
   custom_message_id: z.number().int(),
+  language_group_id: z.nullable(z.number().int()).optional(),
   timezone: z.string(),
   prompt_tool_defaults: z.array(AgentToolDefaults$inboundSchema).optional(),
   languages: z.array(z.string()).optional(),
@@ -151,10 +168,12 @@ export const AgentResponse$inboundSchema: z.ZodType<
     z.array(z.lazy(() => ChannelTargetResponse$inboundSchema)),
   ).optional(),
   tools: z.nullable(z.array(ToolResponse$inboundSchema)).optional(),
+  language_group: z.nullable(LanguageGroupResponse$inboundSchema).optional(),
 }).transform((v) => {
   return remap$(v, {
     "prompt_id": "promptId",
     "custom_message_id": "customMessageId",
+    "language_group_id": "languageGroupId",
     "prompt_tool_defaults": "promptToolDefaults",
     "tool_headers": "toolHeaders",
     "agent_initiated": "agentInitiated",
@@ -162,6 +181,7 @@ export const AgentResponse$inboundSchema: z.ZodType<
     "last_updated_by": "lastUpdatedBy",
     "custom_message": "customMessage",
     "channel_targets": "channelTargets",
+    "language_group": "languageGroup",
   });
 });
 
@@ -173,6 +193,7 @@ export type AgentResponse$Outbound = {
   type: string;
   prompt_id: number;
   custom_message_id: number;
+  language_group_id?: number | null | undefined;
   timezone: string;
   prompt_tool_defaults?: Array<AgentToolDefaults$Outbound> | undefined;
   languages?: Array<string> | undefined;
@@ -186,6 +207,7 @@ export type AgentResponse$Outbound = {
   custom_message?: CustomMessageResponse$Outbound | null | undefined;
   channel_targets?: Array<ChannelTargetResponse$Outbound> | null | undefined;
   tools?: Array<ToolResponse$Outbound> | null | undefined;
+  language_group?: LanguageGroupResponse$Outbound | null | undefined;
 };
 
 /** @internal */
@@ -200,6 +222,7 @@ export const AgentResponse$outboundSchema: z.ZodType<
   type: z.string(),
   promptId: z.number().int(),
   customMessageId: z.number().int(),
+  languageGroupId: z.nullable(z.number().int()).optional(),
   timezone: z.string(),
   promptToolDefaults: z.array(AgentToolDefaults$outboundSchema).optional(),
   languages: z.array(z.string()).optional(),
@@ -215,10 +238,12 @@ export const AgentResponse$outboundSchema: z.ZodType<
     z.array(z.lazy(() => ChannelTargetResponse$outboundSchema)),
   ).optional(),
   tools: z.nullable(z.array(ToolResponse$outboundSchema)).optional(),
+  languageGroup: z.nullable(LanguageGroupResponse$outboundSchema).optional(),
 }).transform((v) => {
   return remap$(v, {
     promptId: "prompt_id",
     customMessageId: "custom_message_id",
+    languageGroupId: "language_group_id",
     promptToolDefaults: "prompt_tool_defaults",
     toolHeaders: "tool_headers",
     agentInitiated: "agent_initiated",
@@ -226,6 +251,7 @@ export const AgentResponse$outboundSchema: z.ZodType<
     lastUpdatedBy: "last_updated_by",
     customMessage: "custom_message",
     channelTargets: "channel_targets",
+    languageGroup: "language_group",
   });
 });
 

package/src/models/components/agentupdate.ts

@@ -39,6 +39,10 @@ export type AgentUpdate = {
    * ID of the custom message that should be delivered at the beginning of a conversation with the agent
    */
   customMessageId: number;
+  /**
+   * ID of the language group associated with the agent
+   */
+  languageGroupId?: number | null | undefined;
   /**
    * The time zone in which the agent operates
    */
@@ -49,6 +53,8 @@ export type AgentUpdate = {
   promptToolDefaults?: Array<AgentToolDefaults> | undefined;
   /**
    * BCP 47 codes of languages the agent supports
+   *
+   * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
    */
   languages?: Array<string> | undefined;
   /**
@@ -81,6 +87,7 @@ export const AgentUpdate$inboundSchema: z.ZodType<
   type: z.string(),
   prompt_id: z.number().int(),
   custom_message_id: z.number().int(),
+  language_group_id: z.nullable(z.number().int()).optional(),
   timezone: z.string(),
   prompt_tool_defaults: z.array(AgentToolDefaults$inboundSchema).optional(),
   languages: z.array(z.string()).optional(),
@@ -92,6 +99,7 @@ export const AgentUpdate$inboundSchema: z.ZodType<
   return remap$(v, {
     "prompt_id": "promptId",
     "custom_message_id": "customMessageId",
+    "language_group_id": "languageGroupId",
     "prompt_tool_defaults": "promptToolDefaults",
     "tool_headers": "toolHeaders",
     "agent_initiated": "agentInitiated",
@@ -106,6 +114,7 @@ export type AgentUpdate$Outbound = {
   type: string;
   prompt_id: number;
   custom_message_id: number;
+  language_group_id?: number | null | undefined;
   timezone: string;
   prompt_tool_defaults?: Array<AgentToolDefaults$Outbound> | undefined;
   languages?: Array<string> | undefined;
@@ -127,6 +136,7 @@ export const AgentUpdate$outboundSchema: z.ZodType<
   type: z.string(),
   promptId: z.number().int(),
   customMessageId: z.number().int(),
+  languageGroupId: z.nullable(z.number().int()).optional(),
   timezone: z.string(),
   promptToolDefaults: z.array(AgentToolDefaults$outboundSchema).optional(),
   languages: z.array(z.string()).optional(),
@@ -138,6 +148,7 @@ export const AgentUpdate$outboundSchema: z.ZodType<
   return remap$(v, {
     promptId: "prompt_id",
     customMessageId: "custom_message_id",
+    languageGroupId: "language_group_id",
     promptToolDefaults: "prompt_tool_defaults",
     toolHeaders: "tool_headers",
     agentInitiated: "agent_initiated",

package/src/models/components/agentvoice.ts

@@ -7,33 +7,70 @@ import { remap as remap$ } from "../../lib/primitives.js";
 import { safeParse } from "../../lib/schemas.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  AgentLanguage,
+  AgentLanguage$inboundSchema,
+  AgentLanguage$Outbound,
+  AgentLanguage$outboundSchema,
+} from "./agentlanguage.js";
+import {
+  AgentVoiceDisplayName,
+  AgentVoiceDisplayName$inboundSchema,
+  AgentVoiceDisplayName$outboundSchema,
+} from "./agentvoicedisplayname.js";
+import {
+  AgentVoiceGender,
+  AgentVoiceGender$inboundSchema,
+  AgentVoiceGender$outboundSchema,
+} from "./agentvoicegender.js";
+import {
+  AgentVoiceModel,
+  AgentVoiceModel$inboundSchema,
+  AgentVoiceModel$outboundSchema,
+} from "./agentvoicemodel.js";
 import {
   AgentVoiceVarName,
   AgentVoiceVarName$inboundSchema,
   AgentVoiceVarName$outboundSchema,
 } from "./agentvoicevarname.js";
 import {
-  SttProvider,
-  SttProvider$inboundSchema,
-  SttProvider$outboundSchema,
-} from "./sttprovider.js";
+  TtsProvider,
+  TtsProvider$inboundSchema,
+  TtsProvider$outboundSchema,
+} from "./ttsprovider.js";
 
 /**
  * Voice option for an agent.
  */
 export type AgentVoice = {
   /**
-   * Provider for an agent voice.
+   * TTS provider for an agent voice.
    */
-  provider: SttProvider;
+  provider: TtsProvider;
   /**
-   * The display name of the voice
+   * Display names of voices that Syllable supports.
    */
-  displayName: string;
+  displayName: AgentVoiceDisplayName;
   /**
    * The variable name of an agent voice (used when procesing messages).
    */
   varName: AgentVoiceVarName;
+  /**
+   * Gender for an agent voice.
+   */
+  gender: AgentVoiceGender;
+  /**
+   * Model for an agent voice.
+   */
+  model?: AgentVoiceModel | undefined;
+  /**
+   * Languages supported by the voice
+   */
+  supportedLanguages: Array<AgentLanguage>;
+  /**
+   * Whether the voice is deprecated and should not be used
+   */
+  deprecated: boolean;
 };
 
 /** @internal */
@@ -42,13 +79,18 @@ export const AgentVoice$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  provider: SttProvider$inboundSchema,
-  display_name: z.string(),
+  provider: TtsProvider$inboundSchema,
+  display_name: AgentVoiceDisplayName$inboundSchema,
   var_name: AgentVoiceVarName$inboundSchema,
+  gender: AgentVoiceGender$inboundSchema,
+  model: AgentVoiceModel$inboundSchema.optional(),
+  supported_languages: z.array(AgentLanguage$inboundSchema),
+  deprecated: z.boolean(),
 }).transform((v) => {
   return remap$(v, {
     "display_name": "displayName",
     "var_name": "varName",
+    "supported_languages": "supportedLanguages",
   });
 });
 
@@ -57,6 +99,10 @@ export type AgentVoice$Outbound = {
   provider: string;
   display_name: string;
   var_name: string;
+  gender: string;
+  model?: string | undefined;
+  supported_languages: Array<AgentLanguage$Outbound>;
+  deprecated: boolean;
 };
 
 /** @internal */
@@ -65,13 +111,18 @@ export const AgentVoice$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   AgentVoice
 > = z.object({
-  provider: SttProvider$outboundSchema,
-  displayName: z.string(),
+  provider: TtsProvider$outboundSchema,
+  displayName: AgentVoiceDisplayName$outboundSchema,
   varName: AgentVoiceVarName$outboundSchema,
+  gender: AgentVoiceGender$outboundSchema,
+  model: AgentVoiceModel$outboundSchema.optional(),
+  supportedLanguages: z.array(AgentLanguage$outboundSchema),
+  deprecated: z.boolean(),
 }).transform((v) => {
   return remap$(v, {
     displayName: "display_name",
     varName: "var_name",
+    supportedLanguages: "supported_languages",
   });
 });
 

package/src/models/components/agentvoicedisplayname.ts

@@ -0,0 +1,75 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { ClosedEnum } from "../../types/enums.js";
+
+/**
+ * Display names of voices that Syllable supports.
+ */
+export const AgentVoiceDisplayName = {
+  Alejandro: "Alejandro",
+  Alice: "Alice",
+  Alloy: "Alloy",
+  Ash: "Ash",
+  Bill: "Bill",
+  Brian: "Brian",
+  Callum: "Callum",
+  Charlie: "Charlie",
+  Charlotte: "Charlotte",
+  Chris: "Chris",
+  Clara: "Clara",
+  Coral: "Coral",
+  Daniel: "Daniel",
+  Echo: "Echo",
+  Eric: "Eric",
+  Fable: "Fable",
+  George: "George",
+  Isabella: "Isabella",
+  Jerry: "Jerry",
+  Jessica: "Jessica",
+  Laura: "Laura",
+  Liam: "Liam",
+  Lily: "Lily",
+  Lina: "Lina",
+  Mark: "Mark",
+  Matilda: "Matilda",
+  Melanie: "Melanie",
+  Mila: "Mila",
+  Nova: "Nova",
+  Onyx: "Onyx",
+  River: "River",
+  Roger: "Roger",
+  Sarah: "Sarah",
+  Sage: "Sage",
+  Shimmer: "Shimmer",
+  Sienna: "Sienna",
+  Tara: "Tara",
+  Will: "Will",
+} as const;
+/**
+ * Display names of voices that Syllable supports.
+ */
+export type AgentVoiceDisplayName = ClosedEnum<typeof AgentVoiceDisplayName>;
+
+/** @internal */
+export const AgentVoiceDisplayName$inboundSchema: z.ZodNativeEnum<
+  typeof AgentVoiceDisplayName
+> = z.nativeEnum(AgentVoiceDisplayName);
+
+/** @internal */
+export const AgentVoiceDisplayName$outboundSchema: z.ZodNativeEnum<
+  typeof AgentVoiceDisplayName
+> = AgentVoiceDisplayName$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace AgentVoiceDisplayName$ {
+  /** @deprecated use `AgentVoiceDisplayName$inboundSchema` instead. */
+  export const inboundSchema = AgentVoiceDisplayName$inboundSchema;
+  /** @deprecated use `AgentVoiceDisplayName$outboundSchema` instead. */
+  export const outboundSchema = AgentVoiceDisplayName$outboundSchema;
+}

package/src/models/components/agentvoicegender.ts

@@ -0,0 +1,39 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { ClosedEnum } from "../../types/enums.js";
+
+/**
+ * Gender for an agent voice.
+ */
+export const AgentVoiceGender = {
+  Female: "female",
+  Male: "male",
+} as const;
+/**
+ * Gender for an agent voice.
+ */
+export type AgentVoiceGender = ClosedEnum<typeof AgentVoiceGender>;
+
+/** @internal */
+export const AgentVoiceGender$inboundSchema: z.ZodNativeEnum<
+  typeof AgentVoiceGender
+> = z.nativeEnum(AgentVoiceGender);
+
+/** @internal */
+export const AgentVoiceGender$outboundSchema: z.ZodNativeEnum<
+  typeof AgentVoiceGender
+> = AgentVoiceGender$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace AgentVoiceGender$ {
+  /** @deprecated use `AgentVoiceGender$inboundSchema` instead. */
+  export const inboundSchema = AgentVoiceGender$inboundSchema;
+  /** @deprecated use `AgentVoiceGender$outboundSchema` instead. */
+  export const outboundSchema = AgentVoiceGender$outboundSchema;
+}

package/src/models/components/agentvoicemodel.ts

@@ -0,0 +1,43 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { ClosedEnum } from "../../types/enums.js";
+
+/**
+ * Model for an agent voice.
+ */
+export const AgentVoiceModel = {
+  MultilingualV2: "Multilingual_v2",
+  Neural2: "Neural2",
+  Standard: "Standard",
+  Studio: "Studio",
+  WaveNet: "WaveNet",
+  Whisper: "Whisper",
+} as const;
+/**
+ * Model for an agent voice.
+ */
+export type AgentVoiceModel = ClosedEnum<typeof AgentVoiceModel>;
+
+/** @internal */
+export const AgentVoiceModel$inboundSchema: z.ZodNativeEnum<
+  typeof AgentVoiceModel
+> = z.nativeEnum(AgentVoiceModel);
+
+/** @internal */
+export const AgentVoiceModel$outboundSchema: z.ZodNativeEnum<
+  typeof AgentVoiceModel
+> = AgentVoiceModel$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace AgentVoiceModel$ {
+  /** @deprecated use `AgentVoiceModel$inboundSchema` instead. */
+  export const inboundSchema = AgentVoiceModel$inboundSchema;
+  /** @deprecated use `AgentVoiceModel$outboundSchema` instead. */
+  export const outboundSchema = AgentVoiceModel$outboundSchema;
+}

package/src/models/components/agentvoicevarname.ts

@@ -10,10 +10,13 @@ import { ClosedEnum } from "../../types/enums.js";
  */
 export const AgentVoiceVarName = {
   OpenaiAlloy: "openai:alloy",
+  OpenaiAsh: "openai:ash",
+  OpenaiCoral: "openai:coral",
   OpenaiEcho: "openai:echo",
   OpenaiFable: "openai:fable",
   OpenaiNova: "openai:nova",
   OpenaiOnyx: "openai:onyx",
+  OpenaiSage: "openai:sage",
   OpenaiShimmer: "openai:shimmer",
   ElevenlabsAlice: "elevenlabs:Alice",
   ElevenlabsBill: "elevenlabs:Bill",
@@ -34,9 +37,16 @@ export const AgentVoiceVarName = {
   ElevenlabsRoger: "elevenlabs:Roger",
   ElevenlabsSarah: "elevenlabs:Sarah",
   ElevenlabsWill: "elevenlabs:Will",
+  WavenetMaleEsUSNeural2B: "wavenet:male/es-US-Neural2-B",
   WavenetFemaleEnUSNeural2F: "wavenet:female/en-US-Neural2-F",
+  WavenetFemaleEsUSNeural2A: "wavenet:female/es-US-Neural2-A",
   WavenetMaleEnUSNeural2D: "wavenet:male/en-US-Neural2-D",
+  WavenetFemaleCmnTWWavenetA: "wavenet:female/cmn-TW-Wavenet-A",
+  WavenetMaleEnUSNeural2J: "wavenet:male/en-US-Neural2-J",
+  WavenetFemaleYueHKStandardC: "wavenet:female/yue-HK-Standard-C",
   WavenetFemaleEnUSStudioO: "wavenet:female/en-US-Studio-O",
+  WavenetFemaleKoKRNeural2A: "wavenet:female/ko-KR-Neural2-A",
+  WavenetFemaleViVNNeural2A: "wavenet:female/vi-VN-Neural2-A",
 } as const;
 /**
  * The variable name of an agent voice (used when procesing messages).

package/src/models/components/index.ts

@@ -3,12 +3,16 @@
  */
 
 export * from "./agentcreate.js";
+export * from "./agentlanguage.js";
 export * from "./agentproperties.js";
 export * from "./agentresponse.js";
 export * from "./agenttooldefaults.js";
 export * from "./agenttoolfielddefault.js";
 export * from "./agentupdate.js";
 export * from "./agentvoice.js";
+export * from "./agentvoicedisplayname.js";
+export * from "./agentvoicegender.js";
+export * from "./agentvoicemodel.js";
 export * from "./agentvoicevarname.js";
 export * from "./availabletarget.js";
 export * from "./availabletargetproperties.js";
@@ -46,6 +50,12 @@ export * from "./insightworkflowinput.js";
 export * from "./insightworkflowoutput.js";
 export * from "./insightworkflowproperties.js";
 export * from "./internaltool.js";
+export * from "./languagecode.js";
+export * from "./languageconfig.js";
+export * from "./languagegroupcreaterequest.js";
+export * from "./languagegroupproperties.js";
+export * from "./languagegroupresponse.js";
+export * from "./languagegroupupdaterequest.js";
 export * from "./listresponseagentresponse.js";
 export * from "./listresponseavailabletarget.js";
 export * from "./listresponsechannel.js";
@@ -57,6 +67,7 @@ export * from "./listresponsedatasourcemetadataresponse.js";
 export * from "./listresponseevent.js";
 export * from "./listresponseinsighttooloutput.js";
 export * from "./listresponseinsightworkflowoutput.js";
+export * from "./listresponselanguagegroupresponse.js";
 export * from "./listresponsepromptresponse.js";
 export * from "./listresponseserviceresponse.js";
 export * from "./listresponsesession.js";
@@ -82,11 +93,11 @@ export * from "./sessionlabelcreate.js";
 export * from "./sessionlabelproperties.js";
 export * from "./sessionproperties.js";
 export * from "./sessionrecordingresponse.js";
+export * from "./sessionsummaryresponse.js";
 export * from "./sessiontext.js";
 export * from "./sessiontranscriptionresponse.js";
 export * from "./statictoolparameter.js";
 export * from "./statictoolparametertype.js";
-export * from "./sttprovider.js";
 export * from "./targetmodes.js";
 export * from "./testmessage.js";
 export * from "./testmessageresponse.js";
@@ -105,4 +116,5 @@ export * from "./toolpromptinfo.js";
 export * from "./toolproperties.js";
 export * from "./toolresponse.js";
 export * from "./toolupdaterequest.js";
+export * from "./ttsprovider.js";
 export * from "./validationerror.js";

package/src/models/components/languagecode.ts

@@ -0,0 +1,42 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { ClosedEnum } from "../../types/enums.js";
+
+/**
+ * BCP 47 codes of languages that Syllable supports.
+ */
+export const LanguageCode = {
+  YueHK: "yue-HK",
+  EnUS: "en-US",
+  KoKR: "ko-KR",
+  ZhCN: "zh-CN",
+  EsUS: "es-US",
+  THTH: "th-TH",
+  ViVN: "vi-VN",
+} as const;
+/**
+ * BCP 47 codes of languages that Syllable supports.
+ */
+export type LanguageCode = ClosedEnum<typeof LanguageCode>;
+
+/** @internal */
+export const LanguageCode$inboundSchema: z.ZodNativeEnum<typeof LanguageCode> =
+  z.nativeEnum(LanguageCode);
+
+/** @internal */
+export const LanguageCode$outboundSchema: z.ZodNativeEnum<typeof LanguageCode> =
+  LanguageCode$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace LanguageCode$ {
+  /** @deprecated use `LanguageCode$inboundSchema` instead. */
+  export const inboundSchema = LanguageCode$inboundSchema;
+  /** @deprecated use `LanguageCode$outboundSchema` instead. */
+  export const outboundSchema = LanguageCode$outboundSchema;
+}