syllable-sdk 1.0.1 → 1.0.2-rc.2

package/src/mcp-server/tools/pronunciationsPronunciationsGetMetadata.ts

@@ -0,0 +1,28 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { pronunciationsPronunciationsGetMetadata } from "../../funcs/pronunciationsPronunciationsGetMetadata.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+export const tool$pronunciationsPronunciationsGetMetadata: ToolDefinition = {
+  name: "pronunciations-pronunciations-get-metadata",
+  description: `Get Pronunciations Metadata`,
+  tool: async (client, ctx) => {
+    const [result, apiCall] = await pronunciationsPronunciationsGetMetadata(
+      client,
+      { fetchOptions: { signal: ctx.signal } },
+    ).$inspect();
+
+    if (!result.ok) {
+      return {
+        content: [{ type: "text", text: result.error.message }],
+        isError: true,
+      };
+    }
+
+    const value = result.value;
+
+    return formatResult(value, apiCall);
+  },
+};

package/src/models/components/dictionarymetadata.ts

@@ -0,0 +1,77 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+/**
+ * Audit metadata associated with a dictionary.
+ */
+export type DictionaryMetadata = {
+  entries: number;
+  hash: string;
+  source?: string | null | undefined;
+};
+
+/** @internal */
+export const DictionaryMetadata$inboundSchema: z.ZodType<
+  DictionaryMetadata,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  entries: z.number().int(),
+  hash: z.string(),
+  source: z.nullable(z.string()).optional(),
+});
+
+/** @internal */
+export type DictionaryMetadata$Outbound = {
+  entries: number;
+  hash: string;
+  source?: string | null | undefined;
+};
+
+/** @internal */
+export const DictionaryMetadata$outboundSchema: z.ZodType<
+  DictionaryMetadata$Outbound,
+  z.ZodTypeDef,
+  DictionaryMetadata
+> = z.object({
+  entries: z.number().int(),
+  hash: z.string(),
+  source: z.nullable(z.string()).optional(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace DictionaryMetadata$ {
+  /** @deprecated use `DictionaryMetadata$inboundSchema` instead. */
+  export const inboundSchema = DictionaryMetadata$inboundSchema;
+  /** @deprecated use `DictionaryMetadata$outboundSchema` instead. */
+  export const outboundSchema = DictionaryMetadata$outboundSchema;
+  /** @deprecated use `DictionaryMetadata$Outbound` instead. */
+  export type Outbound = DictionaryMetadata$Outbound;
+}
+
+export function dictionaryMetadataToJSON(
+  dictionaryMetadata: DictionaryMetadata,
+): string {
+  return JSON.stringify(
+    DictionaryMetadata$outboundSchema.parse(dictionaryMetadata),
+  );
+}
+
+export function dictionaryMetadataFromJSON(
+  jsonString: string,
+): SafeParseResult<DictionaryMetadata, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => DictionaryMetadata$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'DictionaryMetadata' from JSON`,
+  );
+}

package/src/models/components/index.ts

@@ -64,6 +64,7 @@ export * from "./daysofweek.js";
 export * from "./dialogmessage.js";
 export * from "./dialogrole.js";
 export * from "./dialogtoolcall.js";
+export * from "./dictionarymetadata.js";
 export * from "./event.js";
 export * from "./eventproperties.js";
 export * from "./folderdetails.js";
@@ -130,6 +131,7 @@ export * from "./listresponsesessionlabel.js";
 export * from "./listresponsetoolresponse.js";
 export * from "./listresponseuserresponse.js";
 export * from "./logintype.js";
+export * from "./matchtype.js";
 export * from "./orderbydirection.js";
 export * from "./organizationchannelconfig.js";
 export * from "./organizationchannelcreaterequest.js";
@@ -147,6 +149,8 @@ export * from "./promptllmprovider.js";
 export * from "./promptproperties.js";
 export * from "./promptresponse.js";
 export * from "./promptupdaterequest.js";
+export * from "./pronunciationoverride.js";
+export * from "./pronunciationoverridesdictionary.js";
 export * from "./pronunciationscsvuploadresponse.js";
 export * from "./requeststatus.js";
 export * from "./rolecreaterequest.js";
@@ -216,4 +220,5 @@ export * from "./userproperties.js";
 export * from "./userresponse.js";
 export * from "./userupdaterequest.js";
 export * from "./validationerror.js";
+export * from "./voicedisplayinfo.js";
 export * from "./voicesamplecreaterequest.js";

package/src/models/components/matchtype.ts

@@ -0,0 +1,36 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { ClosedEnum } from "../../types/enums.js";
+
+/**
+ * Matching strategy for override text.
+ */
+export const MatchType = {
+  Exact: "exact",
+} as const;
+/**
+ * Matching strategy for override text.
+ */
+export type MatchType = ClosedEnum<typeof MatchType>;
+
+/** @internal */
+export const MatchType$inboundSchema: z.ZodNativeEnum<typeof MatchType> = z
+  .nativeEnum(MatchType);
+
+/** @internal */
+export const MatchType$outboundSchema: z.ZodNativeEnum<typeof MatchType> =
+  MatchType$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace MatchType$ {
+  /** @deprecated use `MatchType$inboundSchema` instead. */
+  export const inboundSchema = MatchType$inboundSchema;
+  /** @deprecated use `MatchType$outboundSchema` instead. */
+  export const outboundSchema = MatchType$outboundSchema;
+}

package/src/models/components/pronunciationoverride.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 {
+  MatchType,
+  MatchType$inboundSchema,
+  MatchType$outboundSchema,
+} from "./matchtype.js";
+
+export type Language = string | Array<string>;
+
+/**
+ * A single text replacement rule.
+ */
+export type PronunciationOverride = {
+  text: string;
+  replacement: string;
+  language?: string | Array<string> | null | undefined;
+  provider?: string | null | undefined;
+  voice?: string | null | undefined;
+  /**
+   * Matching strategy for override text.
+   */
+  matchType?: MatchType | undefined;
+  matchOptions?: Array<string> | undefined;
+  enabled?: boolean | undefined;
+  notes?: string | null | undefined;
+};
+
+/** @internal */
+export const Language$inboundSchema: z.ZodType<
+  Language,
+  z.ZodTypeDef,
+  unknown
+> = z.union([z.string(), z.array(z.string())]);
+
+/** @internal */
+export type Language$Outbound = string | Array<string>;
+
+/** @internal */
+export const Language$outboundSchema: z.ZodType<
+  Language$Outbound,
+  z.ZodTypeDef,
+  Language
+> = z.union([z.string(), z.array(z.string())]);
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace Language$ {
+  /** @deprecated use `Language$inboundSchema` instead. */
+  export const inboundSchema = Language$inboundSchema;
+  /** @deprecated use `Language$outboundSchema` instead. */
+  export const outboundSchema = Language$outboundSchema;
+  /** @deprecated use `Language$Outbound` instead. */
+  export type Outbound = Language$Outbound;
+}
+
+export function languageToJSON(language: Language): string {
+  return JSON.stringify(Language$outboundSchema.parse(language));
+}
+
+export function languageFromJSON(
+  jsonString: string,
+): SafeParseResult<Language, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Language$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Language' from JSON`,
+  );
+}
+
+/** @internal */
+export const PronunciationOverride$inboundSchema: z.ZodType<
+  PronunciationOverride,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  text: z.string(),
+  replacement: z.string(),
+  language: z.nullable(z.union([z.string(), z.array(z.string())])).optional(),
+  provider: z.nullable(z.string()).optional(),
+  voice: z.nullable(z.string()).optional(),
+  match_type: MatchType$inboundSchema.optional(),
+  match_options: z.array(z.string()).optional(),
+  enabled: z.boolean().default(true),
+  notes: z.nullable(z.string()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "match_type": "matchType",
+    "match_options": "matchOptions",
+  });
+});
+
+/** @internal */
+export type PronunciationOverride$Outbound = {
+  text: string;
+  replacement: string;
+  language?: string | Array<string> | null | undefined;
+  provider?: string | null | undefined;
+  voice?: string | null | undefined;
+  match_type?: string | undefined;
+  match_options?: Array<string> | undefined;
+  enabled: boolean;
+  notes?: string | null | undefined;
+};
+
+/** @internal */
+export const PronunciationOverride$outboundSchema: z.ZodType<
+  PronunciationOverride$Outbound,
+  z.ZodTypeDef,
+  PronunciationOverride
+> = z.object({
+  text: z.string(),
+  replacement: z.string(),
+  language: z.nullable(z.union([z.string(), z.array(z.string())])).optional(),
+  provider: z.nullable(z.string()).optional(),
+  voice: z.nullable(z.string()).optional(),
+  matchType: MatchType$outboundSchema.optional(),
+  matchOptions: z.array(z.string()).optional(),
+  enabled: z.boolean().default(true),
+  notes: z.nullable(z.string()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    matchType: "match_type",
+    matchOptions: "match_options",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace PronunciationOverride$ {
+  /** @deprecated use `PronunciationOverride$inboundSchema` instead. */
+  export const inboundSchema = PronunciationOverride$inboundSchema;
+  /** @deprecated use `PronunciationOverride$outboundSchema` instead. */
+  export const outboundSchema = PronunciationOverride$outboundSchema;
+  /** @deprecated use `PronunciationOverride$Outbound` instead. */
+  export type Outbound = PronunciationOverride$Outbound;
+}
+
+export function pronunciationOverrideToJSON(
+  pronunciationOverride: PronunciationOverride,
+): string {
+  return JSON.stringify(
+    PronunciationOverride$outboundSchema.parse(pronunciationOverride),
+  );
+}
+
+export function pronunciationOverrideFromJSON(
+  jsonString: string,
+): SafeParseResult<PronunciationOverride, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PronunciationOverride$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PronunciationOverride' from JSON`,
+  );
+}

package/src/models/components/pronunciationoverridesdictionary.ts

@@ -0,0 +1,124 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  DictionaryMetadata,
+  DictionaryMetadata$inboundSchema,
+  DictionaryMetadata$Outbound,
+  DictionaryMetadata$outboundSchema,
+} from "./dictionarymetadata.js";
+import {
+  PronunciationOverride,
+  PronunciationOverride$inboundSchema,
+  PronunciationOverride$Outbound,
+  PronunciationOverride$outboundSchema,
+} from "./pronunciationoverride.js";
+import {
+  VoiceDisplayInfo,
+  VoiceDisplayInfo$inboundSchema,
+  VoiceDisplayInfo$Outbound,
+  VoiceDisplayInfo$outboundSchema,
+} from "./voicedisplayinfo.js";
+
+/**
+ * Container for all TTS pronunciation overrides belonging to the sub-organisation.
+ *
+ * @remarks
+ *
+ * Stored in the `config_values` table via ConfigDao. The Syllable API persists uploaded CSV
+ * pronunciation rules, and Bubblegum's PronunciationOverridesPlugin reads them to apply text
+ * replacements before TTS processing.
+ *
+ * Example:
+ *     dao = ConfigDao(db_session)
+ *     await dao.register_model('tts.pronunciations', PronunciationOverridesDictionary)
+ *
+ *     pod = PronunciationOverridesDictionary(
+ *         pronunciations=[...],
+ *         metadata=DictionaryMetadata(entries=10, hash='sha256:...'),
+ *     )
+ *     result = await dao.upsert('pronunciations_v1', pod)
+ *
+ *     record = await dao.get('pronunciations_v1', PronunciationOverridesDictionary)
+ *     if record:
+ *         pronunciations = record.value.pronunciations
+ */
+export type PronunciationOverridesDictionary = {
+  type?: string | undefined;
+  pronunciations: Array<PronunciationOverride>;
+  voices?: { [k: string]: VoiceDisplayInfo } | undefined;
+  /**
+   * Audit metadata associated with a dictionary.
+   */
+  metadata: DictionaryMetadata;
+};
+
+/** @internal */
+export const PronunciationOverridesDictionary$inboundSchema: z.ZodType<
+  PronunciationOverridesDictionary,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  type: z.string().default("pronunciations_v1"),
+  pronunciations: z.array(PronunciationOverride$inboundSchema),
+  voices: z.record(VoiceDisplayInfo$inboundSchema).optional(),
+  metadata: DictionaryMetadata$inboundSchema,
+});
+
+/** @internal */
+export type PronunciationOverridesDictionary$Outbound = {
+  type: string;
+  pronunciations: Array<PronunciationOverride$Outbound>;
+  voices?: { [k: string]: VoiceDisplayInfo$Outbound } | undefined;
+  metadata: DictionaryMetadata$Outbound;
+};
+
+/** @internal */
+export const PronunciationOverridesDictionary$outboundSchema: z.ZodType<
+  PronunciationOverridesDictionary$Outbound,
+  z.ZodTypeDef,
+  PronunciationOverridesDictionary
+> = z.object({
+  type: z.string().default("pronunciations_v1"),
+  pronunciations: z.array(PronunciationOverride$outboundSchema),
+  voices: z.record(VoiceDisplayInfo$outboundSchema).optional(),
+  metadata: DictionaryMetadata$outboundSchema,
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace PronunciationOverridesDictionary$ {
+  /** @deprecated use `PronunciationOverridesDictionary$inboundSchema` instead. */
+  export const inboundSchema = PronunciationOverridesDictionary$inboundSchema;
+  /** @deprecated use `PronunciationOverridesDictionary$outboundSchema` instead. */
+  export const outboundSchema = PronunciationOverridesDictionary$outboundSchema;
+  /** @deprecated use `PronunciationOverridesDictionary$Outbound` instead. */
+  export type Outbound = PronunciationOverridesDictionary$Outbound;
+}
+
+export function pronunciationOverridesDictionaryToJSON(
+  pronunciationOverridesDictionary: PronunciationOverridesDictionary,
+): string {
+  return JSON.stringify(
+    PronunciationOverridesDictionary$outboundSchema.parse(
+      pronunciationOverridesDictionary,
+    ),
+  );
+}
+
+export function pronunciationOverridesDictionaryFromJSON(
+  jsonString: string,
+): SafeParseResult<PronunciationOverridesDictionary, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PronunciationOverridesDictionary$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PronunciationOverridesDictionary' from JSON`,
+  );
+}

package/src/models/components/voicedisplayinfo.ts

@@ -0,0 +1,82 @@
+/*
+ * 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";
+
+/**
+ * Display metadata for a canonical voice identifier.
+ */
+export type VoiceDisplayInfo = {
+  displayName: string;
+  provider: string;
+};
+
+/** @internal */
+export const VoiceDisplayInfo$inboundSchema: z.ZodType<
+  VoiceDisplayInfo,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  display_name: z.string(),
+  provider: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "display_name": "displayName",
+  });
+});
+
+/** @internal */
+export type VoiceDisplayInfo$Outbound = {
+  display_name: string;
+  provider: string;
+};
+
+/** @internal */
+export const VoiceDisplayInfo$outboundSchema: z.ZodType<
+  VoiceDisplayInfo$Outbound,
+  z.ZodTypeDef,
+  VoiceDisplayInfo
+> = z.object({
+  displayName: z.string(),
+  provider: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    displayName: "display_name",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace VoiceDisplayInfo$ {
+  /** @deprecated use `VoiceDisplayInfo$inboundSchema` instead. */
+  export const inboundSchema = VoiceDisplayInfo$inboundSchema;
+  /** @deprecated use `VoiceDisplayInfo$outboundSchema` instead. */
+  export const outboundSchema = VoiceDisplayInfo$outboundSchema;
+  /** @deprecated use `VoiceDisplayInfo$Outbound` instead. */
+  export type Outbound = VoiceDisplayInfo$Outbound;
+}
+
+export function voiceDisplayInfoToJSON(
+  voiceDisplayInfo: VoiceDisplayInfo,
+): string {
+  return JSON.stringify(
+    VoiceDisplayInfo$outboundSchema.parse(voiceDisplayInfo),
+  );
+}
+
+export function voiceDisplayInfoFromJSON(
+  jsonString: string,
+): SafeParseResult<VoiceDisplayInfo, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => VoiceDisplayInfo$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'VoiceDisplayInfo' from JSON`,
+  );
+}

package/src/sdk/pronunciations.ts

@@ -2,12 +2,52 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
+import { pronunciationsPronunciationsDeleteCsv } from "../funcs/pronunciationsPronunciationsDeleteCsv.js";
+import { pronunciationsPronunciationsDownloadCsv } from "../funcs/pronunciationsPronunciationsDownloadCsv.js";
+import { pronunciationsPronunciationsGet } from "../funcs/pronunciationsPronunciationsGet.js";
+import { pronunciationsPronunciationsGetMetadata } from "../funcs/pronunciationsPronunciationsGetMetadata.js";
 import { pronunciationsPronunciationsUploadCsv } from "../funcs/pronunciationsPronunciationsUploadCsv.js";
 import { ClientSDK, RequestOptions } from "../lib/sdks.js";
 import * as components from "../models/components/index.js";
 import { unwrapAsync } from "../types/fp.js";
 
 export class Pronunciations extends ClientSDK {
+  /**
+   * Get Pronunciations Dictionary
+   */
+  async pronunciationsGet(
+    options?: RequestOptions,
+  ): Promise<components.PronunciationOverridesDictionary> {
+    return unwrapAsync(pronunciationsPronunciationsGet(
+      this,
+      options,
+    ));
+  }
+
+  /**
+   * Get Pronunciations Metadata
+   */
+  async pronunciationsGetMetadata(
+    options?: RequestOptions,
+  ): Promise<components.DictionaryMetadata> {
+    return unwrapAsync(pronunciationsPronunciationsGetMetadata(
+      this,
+      options,
+    ));
+  }
+
+  /**
+   * Download Pronunciations Csv
+   */
+  async pronunciationsDownloadCsv(
+    options?: RequestOptions,
+  ): Promise<void> {
+    return unwrapAsync(pronunciationsPronunciationsDownloadCsv(
+      this,
+      options,
+    ));
+  }
+
   /**
    * Upload Pronunciations Csv
    */
@@ -21,4 +61,16 @@ export class Pronunciations extends ClientSDK {
       options,
     ));
   }
+
+  /**
+   * Delete Pronunciations Dictionary
+   */
+  async pronunciationsDeleteCsv(
+    options?: RequestOptions,
+  ): Promise<void> {
+    return unwrapAsync(pronunciationsPronunciationsDeleteCsv(
+      this,
+      options,
+    ));
+  }
 }