syllable-sdk 1.0.1 → 1.0.2-rc.10

package/src/models/components/pronunciationoverride.ts

@@ -0,0 +1,120 @@
+/*
+ * 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";
+
+/**
+ * A single text replacement rule.
+ */
+export type PronunciationOverride = {
+  text: string;
+  replacement: string;
+  languages?: Array<string> | undefined;
+  provider?: string | undefined;
+  voice?: string | undefined;
+  /**
+   * Matching strategy for override text.
+   */
+  matchType?: MatchType | undefined;
+  matchOptions?: Array<string> | undefined;
+  enabled?: boolean | undefined;
+  notes?: string | undefined;
+};
+
+/** @internal */
+export const PronunciationOverride$inboundSchema: z.ZodType<
+  PronunciationOverride,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  text: z.string(),
+  replacement: z.string(),
+  languages: z.array(z.string()).optional(),
+  provider: z.string().default(""),
+  voice: z.string().default(""),
+  match_type: MatchType$inboundSchema.optional(),
+  match_options: z.array(z.string()).optional(),
+  enabled: z.boolean().default(true),
+  notes: z.string().default(""),
+}).transform((v) => {
+  return remap$(v, {
+    "match_type": "matchType",
+    "match_options": "matchOptions",
+  });
+});
+
+/** @internal */
+export type PronunciationOverride$Outbound = {
+  text: string;
+  replacement: string;
+  languages?: Array<string> | undefined;
+  provider: string;
+  voice: string;
+  match_type?: string | undefined;
+  match_options?: Array<string> | undefined;
+  enabled: boolean;
+  notes: string;
+};
+
+/** @internal */
+export const PronunciationOverride$outboundSchema: z.ZodType<
+  PronunciationOverride$Outbound,
+  z.ZodTypeDef,
+  PronunciationOverride
+> = z.object({
+  text: z.string(),
+  replacement: z.string(),
+  languages: z.array(z.string()).optional(),
+  provider: z.string().default(""),
+  voice: z.string().default(""),
+  matchType: MatchType$outboundSchema.optional(),
+  matchOptions: z.array(z.string()).optional(),
+  enabled: z.boolean().default(true),
+  notes: z.string().default(""),
+}).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/pronunciationscsvuploadresponse.ts

@@ -13,10 +13,10 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
  */
 export type PronunciationsCsvUploadResponse = {
   revision: number;
-  hash?: string | null | undefined;
-  entries?: number | null | undefined;
+  hash: string;
+  entries: number;
   uploadedAt?: Date | undefined;
-  uploadedBy?: string | null | undefined;
+  uploadedBy: string;
 };
 
 /** @internal */
@@ -26,11 +26,11 @@ export const PronunciationsCsvUploadResponse$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   revision: z.number().int(),
-  hash: z.nullable(z.string()).optional(),
-  entries: z.nullable(z.number().int()).optional(),
+  hash: z.string(),
+  entries: z.number().int(),
   uploaded_at: z.string().datetime({ offset: true }).transform(v => new Date(v))
     .optional(),
-  uploaded_by: z.nullable(z.string()).optional(),
+  uploaded_by: z.string(),
 }).transform((v) => {
   return remap$(v, {
     "uploaded_at": "uploadedAt",
@@ -41,10 +41,10 @@ export const PronunciationsCsvUploadResponse$inboundSchema: z.ZodType<
 /** @internal */
 export type PronunciationsCsvUploadResponse$Outbound = {
   revision: number;
-  hash?: string | null | undefined;
-  entries?: number | null | undefined;
+  hash: string;
+  entries: number;
   uploaded_at?: string | undefined;
-  uploaded_by?: string | null | undefined;
+  uploaded_by: string;
 };
 
 /** @internal */
@@ -54,10 +54,10 @@ export const PronunciationsCsvUploadResponse$outboundSchema: z.ZodType<
   PronunciationsCsvUploadResponse
 > = z.object({
   revision: z.number().int(),
-  hash: z.nullable(z.string()).optional(),
-  entries: z.nullable(z.number().int()).optional(),
+  hash: z.string(),
+  entries: z.number().int(),
   uploadedAt: z.date().transform(v => v.toISOString()).optional(),
-  uploadedBy: z.nullable(z.string()).optional(),
+  uploadedBy: z.string(),
 }).transform((v) => {
   return remap$(v, {
     uploadedAt: "uploaded_at",

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/models/operations/index.ts

@@ -70,6 +70,7 @@ export * from "./promptsdelete.js";
 export * from "./promptsgetbyid.js";
 export * from "./promptshistory.js";
 export * from "./promptslist.js";
+export * from "./pronunciationsdownloadcsv.js";
 export * from "./rolesdelete.js";
 export * from "./rolesgetbyid.js";
 export * from "./roleslist.js";

package/src/models/operations/pronunciationsdownloadcsv.ts

@@ -0,0 +1,84 @@
+/*
+ * 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";
+
+export type PronunciationsDownloadCsvResponse = {
+  headers: { [k: string]: Array<string> };
+  result: ReadableStream<Uint8Array>;
+};
+
+/** @internal */
+export const PronunciationsDownloadCsvResponse$inboundSchema: z.ZodType<
+  PronunciationsDownloadCsvResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  Headers: z.record(z.array(z.string())),
+  Result: z.instanceof(ReadableStream<Uint8Array>),
+}).transform((v) => {
+  return remap$(v, {
+    "Headers": "headers",
+    "Result": "result",
+  });
+});
+
+/** @internal */
+export type PronunciationsDownloadCsvResponse$Outbound = {
+  Headers: { [k: string]: Array<string> };
+  Result: ReadableStream<Uint8Array>;
+};
+
+/** @internal */
+export const PronunciationsDownloadCsvResponse$outboundSchema: z.ZodType<
+  PronunciationsDownloadCsvResponse$Outbound,
+  z.ZodTypeDef,
+  PronunciationsDownloadCsvResponse
+> = z.object({
+  headers: z.record(z.array(z.string())),
+  result: z.instanceof(ReadableStream<Uint8Array>),
+}).transform((v) => {
+  return remap$(v, {
+    headers: "Headers",
+    result: "Result",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace PronunciationsDownloadCsvResponse$ {
+  /** @deprecated use `PronunciationsDownloadCsvResponse$inboundSchema` instead. */
+  export const inboundSchema = PronunciationsDownloadCsvResponse$inboundSchema;
+  /** @deprecated use `PronunciationsDownloadCsvResponse$outboundSchema` instead. */
+  export const outboundSchema =
+    PronunciationsDownloadCsvResponse$outboundSchema;
+  /** @deprecated use `PronunciationsDownloadCsvResponse$Outbound` instead. */
+  export type Outbound = PronunciationsDownloadCsvResponse$Outbound;
+}
+
+export function pronunciationsDownloadCsvResponseToJSON(
+  pronunciationsDownloadCsvResponse: PronunciationsDownloadCsvResponse,
+): string {
+  return JSON.stringify(
+    PronunciationsDownloadCsvResponse$outboundSchema.parse(
+      pronunciationsDownloadCsvResponse,
+    ),
+  );
+}
+
+export function pronunciationsDownloadCsvResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<PronunciationsDownloadCsvResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PronunciationsDownloadCsvResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PronunciationsDownloadCsvResponse' from JSON`,
+  );
+}

package/src/sdk/pronunciations.ts

@@ -2,12 +2,53 @@
  * 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 * as operations from "../models/operations/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<operations.PronunciationsDownloadCsvResponse> {
+    return unwrapAsync(pronunciationsPronunciationsDownloadCsv(
+      this,
+      options,
+    ));
+  }
+
   /**
    * Upload Pronunciations Csv
    */
@@ -21,4 +62,16 @@ export class Pronunciations extends ClientSDK {
       options,
     ));
   }
+
+  /**
+   * Delete Pronunciations Dictionary
+   */
+  async pronunciationsDeleteCsv(
+    options?: RequestOptions,
+  ): Promise<void> {
+    return unwrapAsync(pronunciationsPronunciationsDeleteCsv(
+      this,
+      options,
+    ));
+  }
 }