syllable-sdk 1.0.4-rc.1 → 1.0.4-rc.2

package/src/models/components/languagesamplecreaterequest.ts

@@ -0,0 +1,150 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+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 {
+  AgentVoiceDisplayName,
+  AgentVoiceDisplayName$inboundSchema,
+  AgentVoiceDisplayName$outboundSchema,
+} from "./agentvoicedisplayname.js";
+import {
+  LanguageCode,
+  LanguageCode$inboundSchema,
+  LanguageCode$outboundSchema,
+} from "./languagecode.js";
+import {
+  TtsProvider,
+  TtsProvider$inboundSchema,
+  TtsProvider$outboundSchema,
+} from "./ttsprovider.js";
+
+/**
+ * Request model to generate a sample audio file for a given voice and language.
+ */
+export type LanguageSampleCreateRequest = {
+  /**
+   * BCP 47 codes of languages that Syllable supports.
+   */
+  languageCode: LanguageCode;
+  /**
+   * TTS provider for an agent voice.
+   */
+  voiceProvider: TtsProvider;
+  /**
+   * Display names of voices that Syllable supports.
+   */
+  voiceDisplayName: AgentVoiceDisplayName;
+  /**
+   * Speed of the voice in the range of 0.25 to 4.0 (OpenAI and Google) or 0.7 to 1.2 (ElevenLabs). Standard speed is 1.0.
+   */
+  voiceSpeed?: number | null | undefined;
+  /**
+   * Pitch of the voice in the range of -20.0 to 20.0. 20 means increase 20 semitones from the original pitch. -20 means decrease 20 semitones from the original pitch. 0 means use the original pitch. Only supported for Google configs.
+   */
+  voicePitch?: number | null | undefined;
+  /**
+   * Text to generate for this voice.
+   */
+  text?: string | undefined;
+  /**
+   * Apply TTS pronunciation fixes.
+   */
+  applyPronunciationOverrides?: boolean | undefined;
+};
+
+/** @internal */
+export const LanguageSampleCreateRequest$inboundSchema: z.ZodType<
+  LanguageSampleCreateRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  language_code: LanguageCode$inboundSchema,
+  voice_provider: TtsProvider$inboundSchema,
+  voice_display_name: AgentVoiceDisplayName$inboundSchema,
+  voice_speed: z.nullable(z.number()).optional(),
+  voice_pitch: z.nullable(z.number()).optional(),
+  text: z.string().default(""),
+  apply_pronunciation_overrides: z.boolean().default(false),
+}).transform((v) => {
+  return remap$(v, {
+    "language_code": "languageCode",
+    "voice_provider": "voiceProvider",
+    "voice_display_name": "voiceDisplayName",
+    "voice_speed": "voiceSpeed",
+    "voice_pitch": "voicePitch",
+    "apply_pronunciation_overrides": "applyPronunciationOverrides",
+  });
+});
+
+/** @internal */
+export type LanguageSampleCreateRequest$Outbound = {
+  language_code: string;
+  voice_provider: string;
+  voice_display_name: string;
+  voice_speed?: number | null | undefined;
+  voice_pitch?: number | null | undefined;
+  text: string;
+  apply_pronunciation_overrides: boolean;
+};
+
+/** @internal */
+export const LanguageSampleCreateRequest$outboundSchema: z.ZodType<
+  LanguageSampleCreateRequest$Outbound,
+  z.ZodTypeDef,
+  LanguageSampleCreateRequest
+> = z.object({
+  languageCode: LanguageCode$outboundSchema,
+  voiceProvider: TtsProvider$outboundSchema,
+  voiceDisplayName: AgentVoiceDisplayName$outboundSchema,
+  voiceSpeed: z.nullable(z.number()).optional(),
+  voicePitch: z.nullable(z.number()).optional(),
+  text: z.string().default(""),
+  applyPronunciationOverrides: z.boolean().default(false),
+}).transform((v) => {
+  return remap$(v, {
+    languageCode: "language_code",
+    voiceProvider: "voice_provider",
+    voiceDisplayName: "voice_display_name",
+    voiceSpeed: "voice_speed",
+    voicePitch: "voice_pitch",
+    applyPronunciationOverrides: "apply_pronunciation_overrides",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace LanguageSampleCreateRequest$ {
+  /** @deprecated use `LanguageSampleCreateRequest$inboundSchema` instead. */
+  export const inboundSchema = LanguageSampleCreateRequest$inboundSchema;
+  /** @deprecated use `LanguageSampleCreateRequest$outboundSchema` instead. */
+  export const outboundSchema = LanguageSampleCreateRequest$outboundSchema;
+  /** @deprecated use `LanguageSampleCreateRequest$Outbound` instead. */
+  export type Outbound = LanguageSampleCreateRequest$Outbound;
+}
+
+export function languageSampleCreateRequestToJSON(
+  languageSampleCreateRequest: LanguageSampleCreateRequest,
+): string {
+  return JSON.stringify(
+    LanguageSampleCreateRequest$outboundSchema.parse(
+      languageSampleCreateRequest,
+    ),
+  );
+}
+
+export function languageSampleCreateRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<LanguageSampleCreateRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => LanguageSampleCreateRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'LanguageSampleCreateRequest' from JSON`,
+  );
+}

package/src/models/components/listresponsevoicegroupresponse.ts

@@ -0,0 +1,118 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+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 {
+  VoiceGroupResponse,
+  VoiceGroupResponse$inboundSchema,
+  VoiceGroupResponse$Outbound,
+  VoiceGroupResponse$outboundSchema,
+} from "./voicegroupresponse.js";
+
+export type ListResponseVoiceGroupResponse = {
+  /**
+   * List of items returned from the query
+   */
+  items: Array<VoiceGroupResponse>;
+  /**
+   * The page number of the results (0-based)
+   */
+  page: number;
+  /**
+   * The number of items returned per page
+   */
+  pageSize: number;
+  /**
+   * The total number of pages of results given the indicated page size
+   */
+  totalPages?: number | null | undefined;
+  /**
+   * The total number of items returned from the query
+   */
+  totalCount?: number | null | undefined;
+};
+
+/** @internal */
+export const ListResponseVoiceGroupResponse$inboundSchema: z.ZodType<
+  ListResponseVoiceGroupResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  items: z.array(VoiceGroupResponse$inboundSchema),
+  page: z.number().int(),
+  page_size: z.number().int(),
+  total_pages: z.nullable(z.number().int()).optional(),
+  total_count: z.nullable(z.number().int()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "page_size": "pageSize",
+    "total_pages": "totalPages",
+    "total_count": "totalCount",
+  });
+});
+
+/** @internal */
+export type ListResponseVoiceGroupResponse$Outbound = {
+  items: Array<VoiceGroupResponse$Outbound>;
+  page: number;
+  page_size: number;
+  total_pages?: number | null | undefined;
+  total_count?: number | null | undefined;
+};
+
+/** @internal */
+export const ListResponseVoiceGroupResponse$outboundSchema: z.ZodType<
+  ListResponseVoiceGroupResponse$Outbound,
+  z.ZodTypeDef,
+  ListResponseVoiceGroupResponse
+> = z.object({
+  items: z.array(VoiceGroupResponse$outboundSchema),
+  page: z.number().int(),
+  pageSize: z.number().int(),
+  totalPages: z.nullable(z.number().int()).optional(),
+  totalCount: z.nullable(z.number().int()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    pageSize: "page_size",
+    totalPages: "total_pages",
+    totalCount: "total_count",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ListResponseVoiceGroupResponse$ {
+  /** @deprecated use `ListResponseVoiceGroupResponse$inboundSchema` instead. */
+  export const inboundSchema = ListResponseVoiceGroupResponse$inboundSchema;
+  /** @deprecated use `ListResponseVoiceGroupResponse$outboundSchema` instead. */
+  export const outboundSchema = ListResponseVoiceGroupResponse$outboundSchema;
+  /** @deprecated use `ListResponseVoiceGroupResponse$Outbound` instead. */
+  export type Outbound = ListResponseVoiceGroupResponse$Outbound;
+}
+
+export function listResponseVoiceGroupResponseToJSON(
+  listResponseVoiceGroupResponse: ListResponseVoiceGroupResponse,
+): string {
+  return JSON.stringify(
+    ListResponseVoiceGroupResponse$outboundSchema.parse(
+      listResponseVoiceGroupResponse,
+    ),
+  );
+}
+
+export function listResponseVoiceGroupResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<ListResponseVoiceGroupResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListResponseVoiceGroupResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListResponseVoiceGroupResponse' from JSON`,
+  );
+}

package/src/models/components/voicegroupcreaterequest.ts

@@ -0,0 +1,110 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+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 {
+  LanguageConfig,
+  LanguageConfig$inboundSchema,
+  LanguageConfig$Outbound,
+  LanguageConfig$outboundSchema,
+} from "./languageconfig.js";
+
+/**
+ * Request model to create a voice group.
+ */
+export type VoiceGroupCreateRequest = {
+  /**
+   * The name of the language group.
+   */
+  name: string;
+  /**
+   * Description of the language group.
+   */
+  description?: string | null | undefined;
+  /**
+   * Voice and DTMF configurations for each language in the group.
+   */
+  languageConfigs: Array<LanguageConfig>;
+  /**
+   * Whether a custom message using the language group to generate a language DTMF menu should skip the agent's current language in the menu.
+   */
+  skipCurrentLanguageInMessage: boolean;
+};
+
+/** @internal */
+export const VoiceGroupCreateRequest$inboundSchema: z.ZodType<
+  VoiceGroupCreateRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  name: z.string(),
+  description: z.nullable(z.string()).optional(),
+  language_configs: z.array(LanguageConfig$inboundSchema),
+  skip_current_language_in_message: z.boolean(),
+}).transform((v) => {
+  return remap$(v, {
+    "language_configs": "languageConfigs",
+    "skip_current_language_in_message": "skipCurrentLanguageInMessage",
+  });
+});
+
+/** @internal */
+export type VoiceGroupCreateRequest$Outbound = {
+  name: string;
+  description?: string | null | undefined;
+  language_configs: Array<LanguageConfig$Outbound>;
+  skip_current_language_in_message: boolean;
+};
+
+/** @internal */
+export const VoiceGroupCreateRequest$outboundSchema: z.ZodType<
+  VoiceGroupCreateRequest$Outbound,
+  z.ZodTypeDef,
+  VoiceGroupCreateRequest
+> = z.object({
+  name: z.string(),
+  description: z.nullable(z.string()).optional(),
+  languageConfigs: z.array(LanguageConfig$outboundSchema),
+  skipCurrentLanguageInMessage: z.boolean(),
+}).transform((v) => {
+  return remap$(v, {
+    languageConfigs: "language_configs",
+    skipCurrentLanguageInMessage: "skip_current_language_in_message",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace VoiceGroupCreateRequest$ {
+  /** @deprecated use `VoiceGroupCreateRequest$inboundSchema` instead. */
+  export const inboundSchema = VoiceGroupCreateRequest$inboundSchema;
+  /** @deprecated use `VoiceGroupCreateRequest$outboundSchema` instead. */
+  export const outboundSchema = VoiceGroupCreateRequest$outboundSchema;
+  /** @deprecated use `VoiceGroupCreateRequest$Outbound` instead. */
+  export type Outbound = VoiceGroupCreateRequest$Outbound;
+}
+
+export function voiceGroupCreateRequestToJSON(
+  voiceGroupCreateRequest: VoiceGroupCreateRequest,
+): string {
+  return JSON.stringify(
+    VoiceGroupCreateRequest$outboundSchema.parse(voiceGroupCreateRequest),
+  );
+}
+
+export function voiceGroupCreateRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<VoiceGroupCreateRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => VoiceGroupCreateRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'VoiceGroupCreateRequest' from JSON`,
+  );
+}

package/src/models/components/voicegroupproperties.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";
+
+/**
+ * Names of voice group fields supported for filtering/sorting on list endpoint.
+ */
+export const VoiceGroupProperties = {
+  Name: "name",
+  Description: "description",
+  SkipCurrentLanguageInMessage: "skip_current_language_in_message",
+  UpdatedAt: "updated_at",
+  LastUpdatedBy: "last_updated_by",
+} as const;
+/**
+ * Names of voice group fields supported for filtering/sorting on list endpoint.
+ */
+export type VoiceGroupProperties = ClosedEnum<typeof VoiceGroupProperties>;
+
+/** @internal */
+export const VoiceGroupProperties$inboundSchema: z.ZodNativeEnum<
+  typeof VoiceGroupProperties
+> = z.nativeEnum(VoiceGroupProperties);
+
+/** @internal */
+export const VoiceGroupProperties$outboundSchema: z.ZodNativeEnum<
+  typeof VoiceGroupProperties
+> = VoiceGroupProperties$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace VoiceGroupProperties$ {
+  /** @deprecated use `VoiceGroupProperties$inboundSchema` instead. */
+  export const inboundSchema = VoiceGroupProperties$inboundSchema;
+  /** @deprecated use `VoiceGroupProperties$outboundSchema` instead. */
+  export const outboundSchema = VoiceGroupProperties$outboundSchema;
+}

package/src/models/components/voicegroupresponse.ts

@@ -0,0 +1,166 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+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 {
+  LanguageConfig,
+  LanguageConfig$inboundSchema,
+  LanguageConfig$Outbound,
+  LanguageConfig$outboundSchema,
+} from "./languageconfig.js";
+import {
+  LanguageGroupAgentInfo,
+  LanguageGroupAgentInfo$inboundSchema,
+  LanguageGroupAgentInfo$Outbound,
+  LanguageGroupAgentInfo$outboundSchema,
+} from "./languagegroupagentinfo.js";
+
+/**
+ * Response model for voice group operations.
+ *
+ * @remarks
+ * A voice group is a collection of language, voice, and DTMF configuration that can be
+ * linked to an agent to define the languages and voices it supports. For more information, see
+ * [Console docs](https://docs.syllable.ai/Resources/VoiceGroups).
+ */
+export type VoiceGroupResponse = {
+  /**
+   * The name of the language group.
+   */
+  name: string;
+  /**
+   * Description of the language group.
+   */
+  description?: string | null | undefined;
+  /**
+   * Voice and DTMF configurations for each language in the group.
+   */
+  languageConfigs: Array<LanguageConfig>;
+  /**
+   * Whether a custom message using the language group to generate a language DTMF menu should skip the agent's current language in the menu.
+   */
+  skipCurrentLanguageInMessage: boolean;
+  /**
+   * The ID of the language group to update.
+   */
+  id: number;
+  /**
+   * Comments for the most recent edit to the language group.
+   */
+  editComments?: string | null | undefined;
+  /**
+   * IDs and names of the agents linked to the language group
+   */
+  agentsInfo?: Array<LanguageGroupAgentInfo> | null | undefined;
+  /**
+   * Timestamp of the last update to the language group.
+   */
+  updatedAt: Date;
+  /**
+   * Email of the user who last updated the language group.
+   */
+  lastUpdatedBy: string;
+};
+
+/** @internal */
+export const VoiceGroupResponse$inboundSchema: z.ZodType<
+  VoiceGroupResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  name: z.string(),
+  description: z.nullable(z.string()).optional(),
+  language_configs: z.array(LanguageConfig$inboundSchema),
+  skip_current_language_in_message: z.boolean(),
+  id: z.number().int(),
+  edit_comments: z.nullable(z.string()).optional(),
+  agents_info: z.nullable(z.array(LanguageGroupAgentInfo$inboundSchema))
+    .optional(),
+  updated_at: z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  last_updated_by: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "language_configs": "languageConfigs",
+    "skip_current_language_in_message": "skipCurrentLanguageInMessage",
+    "edit_comments": "editComments",
+    "agents_info": "agentsInfo",
+    "updated_at": "updatedAt",
+    "last_updated_by": "lastUpdatedBy",
+  });
+});
+
+/** @internal */
+export type VoiceGroupResponse$Outbound = {
+  name: string;
+  description?: string | null | undefined;
+  language_configs: Array<LanguageConfig$Outbound>;
+  skip_current_language_in_message: boolean;
+  id: number;
+  edit_comments?: string | null | undefined;
+  agents_info?: Array<LanguageGroupAgentInfo$Outbound> | null | undefined;
+  updated_at: string;
+  last_updated_by: string;
+};
+
+/** @internal */
+export const VoiceGroupResponse$outboundSchema: z.ZodType<
+  VoiceGroupResponse$Outbound,
+  z.ZodTypeDef,
+  VoiceGroupResponse
+> = z.object({
+  name: z.string(),
+  description: z.nullable(z.string()).optional(),
+  languageConfigs: z.array(LanguageConfig$outboundSchema),
+  skipCurrentLanguageInMessage: z.boolean(),
+  id: z.number().int(),
+  editComments: z.nullable(z.string()).optional(),
+  agentsInfo: z.nullable(z.array(LanguageGroupAgentInfo$outboundSchema))
+    .optional(),
+  updatedAt: z.date().transform(v => v.toISOString()),
+  lastUpdatedBy: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    languageConfigs: "language_configs",
+    skipCurrentLanguageInMessage: "skip_current_language_in_message",
+    editComments: "edit_comments",
+    agentsInfo: "agents_info",
+    updatedAt: "updated_at",
+    lastUpdatedBy: "last_updated_by",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace VoiceGroupResponse$ {
+  /** @deprecated use `VoiceGroupResponse$inboundSchema` instead. */
+  export const inboundSchema = VoiceGroupResponse$inboundSchema;
+  /** @deprecated use `VoiceGroupResponse$outboundSchema` instead. */
+  export const outboundSchema = VoiceGroupResponse$outboundSchema;
+  /** @deprecated use `VoiceGroupResponse$Outbound` instead. */
+  export type Outbound = VoiceGroupResponse$Outbound;
+}
+
+export function voiceGroupResponseToJSON(
+  voiceGroupResponse: VoiceGroupResponse,
+): string {
+  return JSON.stringify(
+    VoiceGroupResponse$outboundSchema.parse(voiceGroupResponse),
+  );
+}
+
+export function voiceGroupResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<VoiceGroupResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => VoiceGroupResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'VoiceGroupResponse' from JSON`,
+  );
+}