syllable-sdk 1.0.3 → 1.0.4-rc.2

package/src/models/components/voicegroupupdaterequest.ts

@@ -0,0 +1,126 @@
+/*
+ * 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 update an existing voice group.
+ */
+export type VoiceGroupUpdateRequest = {
+  /**
+   * 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;
+};
+
+/** @internal */
+export const VoiceGroupUpdateRequest$inboundSchema: z.ZodType<
+  VoiceGroupUpdateRequest,
+  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(),
+}).transform((v) => {
+  return remap$(v, {
+    "language_configs": "languageConfigs",
+    "skip_current_language_in_message": "skipCurrentLanguageInMessage",
+    "edit_comments": "editComments",
+  });
+});
+
+/** @internal */
+export type VoiceGroupUpdateRequest$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;
+};
+
+/** @internal */
+export const VoiceGroupUpdateRequest$outboundSchema: z.ZodType<
+  VoiceGroupUpdateRequest$Outbound,
+  z.ZodTypeDef,
+  VoiceGroupUpdateRequest
+> = 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(),
+}).transform((v) => {
+  return remap$(v, {
+    languageConfigs: "language_configs",
+    skipCurrentLanguageInMessage: "skip_current_language_in_message",
+    editComments: "edit_comments",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace VoiceGroupUpdateRequest$ {
+  /** @deprecated use `VoiceGroupUpdateRequest$inboundSchema` instead. */
+  export const inboundSchema = VoiceGroupUpdateRequest$inboundSchema;
+  /** @deprecated use `VoiceGroupUpdateRequest$outboundSchema` instead. */
+  export const outboundSchema = VoiceGroupUpdateRequest$outboundSchema;
+  /** @deprecated use `VoiceGroupUpdateRequest$Outbound` instead. */
+  export type Outbound = VoiceGroupUpdateRequest$Outbound;
+}
+
+export function voiceGroupUpdateRequestToJSON(
+  voiceGroupUpdateRequest: VoiceGroupUpdateRequest,
+): string {
+  return JSON.stringify(
+    VoiceGroupUpdateRequest$outboundSchema.parse(voiceGroupUpdateRequest),
+  );
+}
+
+export function voiceGroupUpdateRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<VoiceGroupUpdateRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => VoiceGroupUpdateRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'VoiceGroupUpdateRequest' from JSON`,
+  );
+}

package/src/models/operations/index.ts

@@ -93,3 +93,6 @@ export * from "./toollist.js";
 export * from "./usersgetbyemail.js";
 export * from "./userslist.js";
 export * from "./userssendemail.js";
+export * from "./voicegroupsdelete.js";
+export * from "./voicegroupsgetbyid.js";
+export * from "./voicegroupslist.js";

package/src/models/operations/voicegroupsdelete.ts

@@ -0,0 +1,79 @@
+/*
+ * 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 VoiceGroupsDeleteRequest = {
+  voiceGroupId: number;
+  reason: string;
+};
+
+/** @internal */
+export const VoiceGroupsDeleteRequest$inboundSchema: z.ZodType<
+  VoiceGroupsDeleteRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  voice_group_id: z.number().int(),
+  reason: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "voice_group_id": "voiceGroupId",
+  });
+});
+
+/** @internal */
+export type VoiceGroupsDeleteRequest$Outbound = {
+  voice_group_id: number;
+  reason: string;
+};
+
+/** @internal */
+export const VoiceGroupsDeleteRequest$outboundSchema: z.ZodType<
+  VoiceGroupsDeleteRequest$Outbound,
+  z.ZodTypeDef,
+  VoiceGroupsDeleteRequest
+> = z.object({
+  voiceGroupId: z.number().int(),
+  reason: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    voiceGroupId: "voice_group_id",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace VoiceGroupsDeleteRequest$ {
+  /** @deprecated use `VoiceGroupsDeleteRequest$inboundSchema` instead. */
+  export const inboundSchema = VoiceGroupsDeleteRequest$inboundSchema;
+  /** @deprecated use `VoiceGroupsDeleteRequest$outboundSchema` instead. */
+  export const outboundSchema = VoiceGroupsDeleteRequest$outboundSchema;
+  /** @deprecated use `VoiceGroupsDeleteRequest$Outbound` instead. */
+  export type Outbound = VoiceGroupsDeleteRequest$Outbound;
+}
+
+export function voiceGroupsDeleteRequestToJSON(
+  voiceGroupsDeleteRequest: VoiceGroupsDeleteRequest,
+): string {
+  return JSON.stringify(
+    VoiceGroupsDeleteRequest$outboundSchema.parse(voiceGroupsDeleteRequest),
+  );
+}
+
+export function voiceGroupsDeleteRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<VoiceGroupsDeleteRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => VoiceGroupsDeleteRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'VoiceGroupsDeleteRequest' from JSON`,
+  );
+}

package/src/models/operations/voicegroupsgetbyid.ts

@@ -0,0 +1,75 @@
+/*
+ * 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 VoiceGroupsGetByIdRequest = {
+  voiceGroupId: number;
+};
+
+/** @internal */
+export const VoiceGroupsGetByIdRequest$inboundSchema: z.ZodType<
+  VoiceGroupsGetByIdRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  voice_group_id: z.number().int(),
+}).transform((v) => {
+  return remap$(v, {
+    "voice_group_id": "voiceGroupId",
+  });
+});
+
+/** @internal */
+export type VoiceGroupsGetByIdRequest$Outbound = {
+  voice_group_id: number;
+};
+
+/** @internal */
+export const VoiceGroupsGetByIdRequest$outboundSchema: z.ZodType<
+  VoiceGroupsGetByIdRequest$Outbound,
+  z.ZodTypeDef,
+  VoiceGroupsGetByIdRequest
+> = z.object({
+  voiceGroupId: z.number().int(),
+}).transform((v) => {
+  return remap$(v, {
+    voiceGroupId: "voice_group_id",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace VoiceGroupsGetByIdRequest$ {
+  /** @deprecated use `VoiceGroupsGetByIdRequest$inboundSchema` instead. */
+  export const inboundSchema = VoiceGroupsGetByIdRequest$inboundSchema;
+  /** @deprecated use `VoiceGroupsGetByIdRequest$outboundSchema` instead. */
+  export const outboundSchema = VoiceGroupsGetByIdRequest$outboundSchema;
+  /** @deprecated use `VoiceGroupsGetByIdRequest$Outbound` instead. */
+  export type Outbound = VoiceGroupsGetByIdRequest$Outbound;
+}
+
+export function voiceGroupsGetByIdRequestToJSON(
+  voiceGroupsGetByIdRequest: VoiceGroupsGetByIdRequest,
+): string {
+  return JSON.stringify(
+    VoiceGroupsGetByIdRequest$outboundSchema.parse(voiceGroupsGetByIdRequest),
+  );
+}
+
+export function voiceGroupsGetByIdRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<VoiceGroupsGetByIdRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => VoiceGroupsGetByIdRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'VoiceGroupsGetByIdRequest' from JSON`,
+  );
+}

package/src/models/operations/voicegroupslist.ts

@@ -0,0 +1,153 @@
+/*
+ * 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 * as components from "../components/index.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type VoiceGroupsListRequest = {
+  /**
+   * The page number from which to start (0-based)
+   */
+  page?: number | null | undefined;
+  /**
+   * The maximum number of items to return
+   */
+  limit?: number | undefined;
+  /**
+   * String names of fields to search. Correspond by index to search field values
+   */
+  searchFields?: Array<components.VoiceGroupProperties> | undefined;
+  /**
+   * Values of fields to search. Correspond by index to search fields. Unless field name contains "list", an individual search field value cannot be a list
+   */
+  searchFieldValues?: Array<string> | undefined;
+  /**
+   * The field whose value should be used to order the results
+   */
+  orderBy?: components.VoiceGroupProperties | null | undefined;
+  /**
+   * The direction in which to order the results
+   */
+  orderByDirection?: components.OrderByDirection | null | undefined;
+  /**
+   * The fields to include in the response
+   */
+  fields?: Array<components.VoiceGroupProperties> | null | undefined;
+  /**
+   * The start datetime for filtering results
+   */
+  startDatetime?: string | null | undefined;
+  /**
+   * The end datetime for filtering results
+   */
+  endDatetime?: string | null | undefined;
+};
+
+/** @internal */
+export const VoiceGroupsListRequest$inboundSchema: z.ZodType<
+  VoiceGroupsListRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  page: z.nullable(z.number().int()).optional(),
+  limit: z.number().int().default(25),
+  search_fields: z.array(components.VoiceGroupProperties$inboundSchema)
+    .optional(),
+  search_field_values: z.array(z.string()).optional(),
+  order_by: z.nullable(components.VoiceGroupProperties$inboundSchema)
+    .optional(),
+  order_by_direction: z.nullable(components.OrderByDirection$inboundSchema)
+    .optional(),
+  fields: z.nullable(z.array(components.VoiceGroupProperties$inboundSchema))
+    .optional(),
+  start_datetime: z.nullable(z.string()).optional(),
+  end_datetime: z.nullable(z.string()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "search_fields": "searchFields",
+    "search_field_values": "searchFieldValues",
+    "order_by": "orderBy",
+    "order_by_direction": "orderByDirection",
+    "start_datetime": "startDatetime",
+    "end_datetime": "endDatetime",
+  });
+});
+
+/** @internal */
+export type VoiceGroupsListRequest$Outbound = {
+  page?: number | null | undefined;
+  limit: number;
+  search_fields?: Array<string> | undefined;
+  search_field_values?: Array<string> | undefined;
+  order_by?: string | null | undefined;
+  order_by_direction?: string | null | undefined;
+  fields?: Array<string> | null | undefined;
+  start_datetime?: string | null | undefined;
+  end_datetime?: string | null | undefined;
+};
+
+/** @internal */
+export const VoiceGroupsListRequest$outboundSchema: z.ZodType<
+  VoiceGroupsListRequest$Outbound,
+  z.ZodTypeDef,
+  VoiceGroupsListRequest
+> = z.object({
+  page: z.nullable(z.number().int()).optional(),
+  limit: z.number().int().default(25),
+  searchFields: z.array(components.VoiceGroupProperties$outboundSchema)
+    .optional(),
+  searchFieldValues: z.array(z.string()).optional(),
+  orderBy: z.nullable(components.VoiceGroupProperties$outboundSchema)
+    .optional(),
+  orderByDirection: z.nullable(components.OrderByDirection$outboundSchema)
+    .optional(),
+  fields: z.nullable(z.array(components.VoiceGroupProperties$outboundSchema))
+    .optional(),
+  startDatetime: z.nullable(z.string()).optional(),
+  endDatetime: z.nullable(z.string()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    searchFields: "search_fields",
+    searchFieldValues: "search_field_values",
+    orderBy: "order_by",
+    orderByDirection: "order_by_direction",
+    startDatetime: "start_datetime",
+    endDatetime: "end_datetime",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace VoiceGroupsListRequest$ {
+  /** @deprecated use `VoiceGroupsListRequest$inboundSchema` instead. */
+  export const inboundSchema = VoiceGroupsListRequest$inboundSchema;
+  /** @deprecated use `VoiceGroupsListRequest$outboundSchema` instead. */
+  export const outboundSchema = VoiceGroupsListRequest$outboundSchema;
+  /** @deprecated use `VoiceGroupsListRequest$Outbound` instead. */
+  export type Outbound = VoiceGroupsListRequest$Outbound;
+}
+
+export function voiceGroupsListRequestToJSON(
+  voiceGroupsListRequest: VoiceGroupsListRequest,
+): string {
+  return JSON.stringify(
+    VoiceGroupsListRequest$outboundSchema.parse(voiceGroupsListRequest),
+  );
+}
+
+export function voiceGroupsListRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<VoiceGroupsListRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => VoiceGroupsListRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'VoiceGroupsListRequest' from JSON`,
+  );
+}

package/src/sdk/languagegroups.ts

@@ -18,7 +18,9 @@ export class LanguageGroups extends ClientSDK {
    * List Language Groups
    *
    * @remarks
-   * Fetch language groups.
+   * Deprecated alias for `GET /api/v1/voice_groups/`.
+   *
+   * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible.
    */
   async list(
     request: operations.LanguageGroupsListRequest,
@@ -35,7 +37,9 @@ export class LanguageGroups extends ClientSDK {
    * Create Language Group
    *
    * @remarks
-   * Create a new language group.
+   * Deprecated alias for `POST /api/v1/voice_groups/`.
+   *
+   * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible.
    */
   async create(
     request: components.LanguageGroupCreateRequest,
@@ -52,7 +56,9 @@ export class LanguageGroups extends ClientSDK {
    * Update Language Group
    *
    * @remarks
-   * Update an existing language group
+   * Deprecated alias for `PUT /api/v1/voice_groups/`.
+   *
+   * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible.
    */
   async update(
     request: components.LanguageGroupUpdateRequest,
@@ -69,7 +75,9 @@ export class LanguageGroups extends ClientSDK {
    * Get Language Group
    *
    * @remarks
-   * Fetch a given language group.
+   * Deprecated alias for `GET /api/v1/voice_groups/{voice_group_id}`.
+   *
+   * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible.
    */
   async getById(
     request: operations.LanguageGroupsGetByIdRequest,
@@ -86,7 +94,9 @@ export class LanguageGroups extends ClientSDK {
    * Delete Language Group
    *
    * @remarks
-   * Delete a language group.
+   * Deprecated alias for `DELETE /api/v1/voice_groups/{voice_group_id}`.
+   *
+   * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible.
    */
   async delete(
     request: operations.LanguageGroupsDeleteRequest,
@@ -103,10 +113,12 @@ export class LanguageGroups extends ClientSDK {
    * Create Voice Sample
    *
    * @remarks
-   * Generate voice sample.
+   * Deprecated alias for `POST /api/v1/voice_groups/voices/sample`.
+   *
+   * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible.
    */
   async languageGroupsCreateVoiceSample(
-    request: components.VoiceSampleCreateRequest,
+    request: components.LanguageSampleCreateRequest,
     options?: RequestOptions,
   ): Promise<ReadableStream<Uint8Array>> {
     return unwrapAsync(languageGroupsLanguageGroupsCreateVoiceSample(

package/src/sdk/sdk.ts

@@ -27,6 +27,7 @@ import { Takeouts } from "./takeouts.js";
 import { Tools } from "./tools.js";
 import { Users } from "./users.js";
 import { V1 } from "./v1.js";
+import { VoiceGroups } from "./voicegroups.js";
 
 export class SyllableSDK extends ClientSDK {
   private _agents?: Agents;
@@ -134,6 +135,11 @@ export class SyllableSDK extends ClientSDK {
     return (this._languageGroups ??= new LanguageGroups(this._options));
   }
 
+  private _voiceGroups?: VoiceGroups;
+  get voiceGroups(): VoiceGroups {
+    return (this._voiceGroups ??= new VoiceGroups(this._options));
+  }
+
   private _takeouts?: Takeouts;
   get takeouts(): Takeouts {
     return (this._takeouts ??= new Takeouts(this._options));

package/src/sdk/voicegroups.ts

@@ -0,0 +1,118 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { voiceGroupsCreate } from "../funcs/voiceGroupsCreate.js";
+import { voiceGroupsDelete } from "../funcs/voiceGroupsDelete.js";
+import { voiceGroupsGetById } from "../funcs/voiceGroupsGetById.js";
+import { voiceGroupsList } from "../funcs/voiceGroupsList.js";
+import { voiceGroupsUpdate } from "../funcs/voiceGroupsUpdate.js";
+import { voiceGroupsVoiceGroupsCreateVoiceSample } from "../funcs/voiceGroupsVoiceGroupsCreateVoiceSample.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 VoiceGroups extends ClientSDK {
+  /**
+   * List Voice Groups
+   *
+   * @remarks
+   * Fetch voice groups.
+   */
+  async list(
+    request: operations.VoiceGroupsListRequest,
+    options?: RequestOptions,
+  ): Promise<components.ListResponseVoiceGroupResponse> {
+    return unwrapAsync(voiceGroupsList(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Create Voice Group
+   *
+   * @remarks
+   * Create a new voice group.
+   */
+  async create(
+    request: components.VoiceGroupCreateRequest,
+    options?: RequestOptions,
+  ): Promise<components.VoiceGroupResponse> {
+    return unwrapAsync(voiceGroupsCreate(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Update Voice Group
+   *
+   * @remarks
+   * Update an existing voice group
+   */
+  async update(
+    request: components.VoiceGroupUpdateRequest,
+    options?: RequestOptions,
+  ): Promise<components.VoiceGroupResponse> {
+    return unwrapAsync(voiceGroupsUpdate(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Get Voice Group
+   *
+   * @remarks
+   * Fetch a given voice group.
+   */
+  async getById(
+    request: operations.VoiceGroupsGetByIdRequest,
+    options?: RequestOptions,
+  ): Promise<components.VoiceGroupResponse> {
+    return unwrapAsync(voiceGroupsGetById(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Delete Voice Group
+   *
+   * @remarks
+   * Delete a voice group.
+   */
+  async delete(
+    request: operations.VoiceGroupsDeleteRequest,
+    options?: RequestOptions,
+  ): Promise<any> {
+    return unwrapAsync(voiceGroupsDelete(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Create Voice Sample
+   *
+   * @remarks
+   * Generate voice sample.
+   */
+  async voiceGroupsCreateVoiceSample(
+    request: components.VoiceSampleCreateRequest,
+    options?: RequestOptions,
+  ): Promise<ReadableStream<Uint8Array>> {
+    return unwrapAsync(voiceGroupsVoiceGroupsCreateVoiceSample(
+      this,
+      request,
+      options,
+    ));
+  }
+}