syllable-sdk 0.1.0-alpha.4 → 0.1.0-alpha.40

package/src/models/components/agentvoice.ts

@@ -0,0 +1,103 @@
+/*
+ * 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 {
+  AgentVoiceVarName,
+  AgentVoiceVarName$inboundSchema,
+  AgentVoiceVarName$outboundSchema,
+} from "./agentvoicevarname.js";
+import {
+  SttProvider,
+  SttProvider$inboundSchema,
+  SttProvider$outboundSchema,
+} from "./sttprovider.js";
+
+/**
+ * Voice option for an agent.
+ */
+export type AgentVoice = {
+  /**
+   * Provider for an agent voice.
+   */
+  provider: SttProvider;
+  /**
+   * The display name of the voice
+   */
+  displayName: string;
+  /**
+   * The variable name of an agent voice (used when procesing messages).
+   */
+  varName: AgentVoiceVarName;
+};
+
+/** @internal */
+export const AgentVoice$inboundSchema: z.ZodType<
+  AgentVoice,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  provider: SttProvider$inboundSchema,
+  display_name: z.string(),
+  var_name: AgentVoiceVarName$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "display_name": "displayName",
+    "var_name": "varName",
+  });
+});
+
+/** @internal */
+export type AgentVoice$Outbound = {
+  provider: string;
+  display_name: string;
+  var_name: string;
+};
+
+/** @internal */
+export const AgentVoice$outboundSchema: z.ZodType<
+  AgentVoice$Outbound,
+  z.ZodTypeDef,
+  AgentVoice
+> = z.object({
+  provider: SttProvider$outboundSchema,
+  displayName: z.string(),
+  varName: AgentVoiceVarName$outboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    displayName: "display_name",
+    varName: "var_name",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace AgentVoice$ {
+  /** @deprecated use `AgentVoice$inboundSchema` instead. */
+  export const inboundSchema = AgentVoice$inboundSchema;
+  /** @deprecated use `AgentVoice$outboundSchema` instead. */
+  export const outboundSchema = AgentVoice$outboundSchema;
+  /** @deprecated use `AgentVoice$Outbound` instead. */
+  export type Outbound = AgentVoice$Outbound;
+}
+
+export function agentVoiceToJSON(agentVoice: AgentVoice): string {
+  return JSON.stringify(AgentVoice$outboundSchema.parse(agentVoice));
+}
+
+export function agentVoiceFromJSON(
+  jsonString: string,
+): SafeParseResult<AgentVoice, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AgentVoice$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AgentVoice' from JSON`,
+  );
+}

package/src/models/components/agentvoicevarname.ts

@@ -0,0 +1,65 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { ClosedEnum } from "../../types/enums.js";
+
+/**
+ * The variable name of an agent voice (used when procesing messages).
+ */
+export const AgentVoiceVarName = {
+  OpenaiAlloy: "openai:alloy",
+  OpenaiEcho: "openai:echo",
+  OpenaiFable: "openai:fable",
+  OpenaiNova: "openai:nova",
+  OpenaiOnyx: "openai:onyx",
+  OpenaiShimmer: "openai:shimmer",
+  ElevenlabsAlice: "elevenlabs:Alice",
+  ElevenlabsBill: "elevenlabs:Bill",
+  ElevenlabsBrian: "elevenlabs:Brian",
+  ElevenlabsCallum: "elevenlabs:Callum",
+  ElevenlabsCharlie: "elevenlabs:Charlie",
+  ElevenlabsCharlotte: "elevenlabs:Charlotte",
+  ElevenlabsChris: "elevenlabs:Chris",
+  ElevenlabsDaniel: "elevenlabs:Daniel",
+  ElevenlabsEric: "elevenlabs:Eric",
+  ElevenlabsGeorge: "elevenlabs:George",
+  ElevenlabsJessica: "elevenlabs:Jessica",
+  ElevenlabsLaura: "elevenlabs:Laura",
+  ElevenlabsLiam: "elevenlabs:Liam",
+  ElevenlabsLily: "elevenlabs:Lily",
+  ElevenlabsMatilda: "elevenlabs:Matilda",
+  ElevenlabsRiver: "elevenlabs:River",
+  ElevenlabsRoger: "elevenlabs:Roger",
+  ElevenlabsSarah: "elevenlabs:Sarah",
+  ElevenlabsWill: "elevenlabs:Will",
+  WavenetFemaleEnUSNeural2F: "wavenet:female/en-US-Neural2-F",
+  WavenetMaleEnUSNeural2D: "wavenet:male/en-US-Neural2-D",
+  WavenetFemaleEnUSStudioO: "wavenet:female/en-US-Studio-O",
+} as const;
+/**
+ * The variable name of an agent voice (used when procesing messages).
+ */
+export type AgentVoiceVarName = ClosedEnum<typeof AgentVoiceVarName>;
+
+/** @internal */
+export const AgentVoiceVarName$inboundSchema: z.ZodNativeEnum<
+  typeof AgentVoiceVarName
+> = z.nativeEnum(AgentVoiceVarName);
+
+/** @internal */
+export const AgentVoiceVarName$outboundSchema: z.ZodNativeEnum<
+  typeof AgentVoiceVarName
+> = AgentVoiceVarName$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace AgentVoiceVarName$ {
+  /** @deprecated use `AgentVoiceVarName$inboundSchema` instead. */
+  export const inboundSchema = AgentVoiceVarName$inboundSchema;
+  /** @deprecated use `AgentVoiceVarName$outboundSchema` instead. */
+  export const outboundSchema = AgentVoiceVarName$outboundSchema;
+}

package/src/models/components/channel.ts

@@ -19,11 +19,11 @@ export type Channel = {
    */
   name: string;
   /**
-   * The service for the channel
+   * The communication service for a channel.
    */
   channelService: ChannelServices;
   /**
-   * The comma-delimited list of supported modes for the channel
+   * The comma-delimited list of supported modes for the channel, which defines the       possible communication methods for channel targets linked to it.
    */
   supportedModes?: string | null | undefined;
   /**

package/src/models/components/channelservices.ts

@@ -5,12 +5,18 @@
 import * as z from "zod";
 import { ClosedEnum } from "../../types/enums.js";
 
+/**
+ * The communication service for a channel.
+ */
 export const ChannelServices = {
   Sip: "sip",
   Twilio: "twilio",
   Email: "email",
   Webchat: "webchat",
 } as const;
+/**
+ * The communication service for a channel.
+ */
 export type ChannelServices = ClosedEnum<typeof ChannelServices>;
 
 /** @internal */

package/src/models/components/channeltargetcreaterequest.ts

@@ -7,14 +7,37 @@ 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 {
+  TargetModes,
+  TargetModes$inboundSchema,
+  TargetModes$outboundSchema,
+} from "./targetmodes.js";
 
 export type ChannelTargetCreateRequest = {
-  channelId: number | null;
-  agentId: number | null;
-  target: string | null;
-  targetMode: string | null;
-  fallbackTarget: string | null;
-  isTest: boolean | null;
+  /**
+   * The ID of the agent associated with the channel target
+   */
+  agentId: number;
+  /**
+   * The ID of the channel associated with the channel target
+   */
+  channelId: number;
+  /**
+   * The name of the channel target (must correspond to an organization-level target)
+   */
+  target: string;
+  /**
+   * Available modes (communication methods) for channel targets.
+   */
+  targetMode: TargetModes;
+  /**
+   * The fallback for the channel target (currently only supported for "voice" mode)
+   */
+  fallbackTarget?: string | null | undefined;
+  /**
+   * Whether the channel target is intended for testing. If true, any sessions created through this target will be labeled as test.
+   */
+  isTest?: boolean | undefined;
 };
 
 /** @internal */
@@ -23,16 +46,16 @@ export const ChannelTargetCreateRequest$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  channel_id: z.nullable(z.number().int()),
-  agent_id: z.nullable(z.number().int()),
-  target: z.nullable(z.string()),
-  target_mode: z.nullable(z.string()),
-  fallback_target: z.nullable(z.string()),
-  is_test: z.nullable(z.boolean()),
+  agent_id: z.number().int(),
+  channel_id: z.number().int(),
+  target: z.string(),
+  target_mode: TargetModes$inboundSchema,
+  fallback_target: z.nullable(z.string()).optional(),
+  is_test: z.boolean().default(false),
 }).transform((v) => {
   return remap$(v, {
-    "channel_id": "channelId",
     "agent_id": "agentId",
+    "channel_id": "channelId",
     "target_mode": "targetMode",
     "fallback_target": "fallbackTarget",
     "is_test": "isTest",
@@ -41,12 +64,12 @@ export const ChannelTargetCreateRequest$inboundSchema: z.ZodType<
 
 /** @internal */
 export type ChannelTargetCreateRequest$Outbound = {
-  channel_id: number | null;
-  agent_id: number | null;
-  target: string | null;
-  target_mode: string | null;
-  fallback_target: string | null;
-  is_test: boolean | null;
+  agent_id: number;
+  channel_id: number;
+  target: string;
+  target_mode: string;
+  fallback_target?: string | null | undefined;
+  is_test: boolean;
 };
 
 /** @internal */
@@ -55,16 +78,16 @@ export const ChannelTargetCreateRequest$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   ChannelTargetCreateRequest
 > = z.object({
-  channelId: z.nullable(z.number().int()),
-  agentId: z.nullable(z.number().int()),
-  target: z.nullable(z.string()),
-  targetMode: z.nullable(z.string()),
-  fallbackTarget: z.nullable(z.string()),
-  isTest: z.nullable(z.boolean()),
+  agentId: z.number().int(),
+  channelId: z.number().int(),
+  target: z.string(),
+  targetMode: TargetModes$outboundSchema,
+  fallbackTarget: z.nullable(z.string()).optional(),
+  isTest: z.boolean().default(false),
 }).transform((v) => {
   return remap$(v, {
-    channelId: "channel_id",
     agentId: "agent_id",
+    channelId: "channel_id",
     targetMode: "target_mode",
     fallbackTarget: "fallback_target",
     isTest: "is_test",

package/src/models/components/channeltargetproperties.ts

@@ -14,6 +14,7 @@ export const ChannelTargetProperties = {
   TargetMode: "target_mode",
   FallbackTarget: "fallback_target",
   IsTest: "is_test",
+  UpdatedAt: "updated_at",
 } as const;
 export type ChannelTargetProperties = ClosedEnum<
   typeof ChannelTargetProperties

package/src/models/components/channeltargetresponse.ts

@@ -0,0 +1,179 @@
+/*
+ * 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 {
+  AgentResponse,
+  AgentResponse$inboundSchema,
+  AgentResponse$Outbound,
+  AgentResponse$outboundSchema,
+} from "./agentresponse.js";
+import {
+  TargetModes,
+  TargetModes$inboundSchema,
+  TargetModes$outboundSchema,
+} from "./targetmodes.js";
+
+/**
+ * A channel target links a channel to an agent, allowing users to communicate with the agent
+ *
+ * @remarks
+ * through that channel.
+ */
+export type ChannelTargetResponse = {
+  /**
+   * The ID of the agent associated with the channel target
+   */
+  agentId: number;
+  /**
+   * The ID of the channel associated with the channel target
+   */
+  channelId: number;
+  /**
+   * The name of the channel target (must correspond to an organization-level target)
+   */
+  target: string;
+  /**
+   * Available modes (communication methods) for channel targets.
+   */
+  targetMode: TargetModes;
+  /**
+   * The fallback for the channel target (currently only supported for "voice" mode)
+   */
+  fallbackTarget?: string | null | undefined;
+  /**
+   * Whether the channel target is intended for testing. If true, any sessions created through this target will be labeled as test.
+   */
+  isTest?: boolean | undefined;
+  /**
+   * The ID of the channel target
+   */
+  id: number;
+  /**
+   * The name of the channel associated with the channel target
+   */
+  channelName: string;
+  /**
+   * Timestamp of the most recent update to the channel target
+   */
+  updatedAt: Date;
+  /**
+   * Email of the user who last updated the channel target
+   */
+  lastUpdatedBy: string;
+  /**
+   * Definition of the agent for the channel target
+   */
+  agent?: AgentResponse | null | undefined;
+};
+
+/** @internal */
+export const ChannelTargetResponse$inboundSchema: z.ZodType<
+  ChannelTargetResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  agent_id: z.number().int(),
+  channel_id: z.number().int(),
+  target: z.string(),
+  target_mode: TargetModes$inboundSchema,
+  fallback_target: z.nullable(z.string()).optional(),
+  is_test: z.boolean().default(false),
+  id: z.number().int(),
+  channel_name: z.string(),
+  updated_at: z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  last_updated_by: z.string(),
+  agent: z.nullable(z.lazy(() => AgentResponse$inboundSchema)).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "agent_id": "agentId",
+    "channel_id": "channelId",
+    "target_mode": "targetMode",
+    "fallback_target": "fallbackTarget",
+    "is_test": "isTest",
+    "channel_name": "channelName",
+    "updated_at": "updatedAt",
+    "last_updated_by": "lastUpdatedBy",
+  });
+});
+
+/** @internal */
+export type ChannelTargetResponse$Outbound = {
+  agent_id: number;
+  channel_id: number;
+  target: string;
+  target_mode: string;
+  fallback_target?: string | null | undefined;
+  is_test: boolean;
+  id: number;
+  channel_name: string;
+  updated_at: string;
+  last_updated_by: string;
+  agent?: AgentResponse$Outbound | null | undefined;
+};
+
+/** @internal */
+export const ChannelTargetResponse$outboundSchema: z.ZodType<
+  ChannelTargetResponse$Outbound,
+  z.ZodTypeDef,
+  ChannelTargetResponse
+> = z.object({
+  agentId: z.number().int(),
+  channelId: z.number().int(),
+  target: z.string(),
+  targetMode: TargetModes$outboundSchema,
+  fallbackTarget: z.nullable(z.string()).optional(),
+  isTest: z.boolean().default(false),
+  id: z.number().int(),
+  channelName: z.string(),
+  updatedAt: z.date().transform(v => v.toISOString()),
+  lastUpdatedBy: z.string(),
+  agent: z.nullable(z.lazy(() => AgentResponse$outboundSchema)).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    agentId: "agent_id",
+    channelId: "channel_id",
+    targetMode: "target_mode",
+    fallbackTarget: "fallback_target",
+    isTest: "is_test",
+    channelName: "channel_name",
+    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 ChannelTargetResponse$ {
+  /** @deprecated use `ChannelTargetResponse$inboundSchema` instead. */
+  export const inboundSchema = ChannelTargetResponse$inboundSchema;
+  /** @deprecated use `ChannelTargetResponse$outboundSchema` instead. */
+  export const outboundSchema = ChannelTargetResponse$outboundSchema;
+  /** @deprecated use `ChannelTargetResponse$Outbound` instead. */
+  export type Outbound = ChannelTargetResponse$Outbound;
+}
+
+export function channelTargetResponseToJSON(
+  channelTargetResponse: ChannelTargetResponse,
+): string {
+  return JSON.stringify(
+    ChannelTargetResponse$outboundSchema.parse(channelTargetResponse),
+  );
+}
+
+export function channelTargetResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<ChannelTargetResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ChannelTargetResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ChannelTargetResponse' from JSON`,
+  );
+}

package/src/models/components/channeltargetupdaterequest.ts

@@ -0,0 +1,133 @@
+/*
+ * 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 {
+  TargetModes,
+  TargetModes$inboundSchema,
+  TargetModes$outboundSchema,
+} from "./targetmodes.js";
+
+export type ChannelTargetUpdateRequest = {
+  /**
+   * The ID of the agent associated with the channel target
+   */
+  agentId: number;
+  /**
+   * The ID of the channel associated with the channel target
+   */
+  channelId: number;
+  /**
+   * The name of the channel target (must correspond to an organization-level target)
+   */
+  target: string;
+  /**
+   * Available modes (communication methods) for channel targets.
+   */
+  targetMode: TargetModes;
+  /**
+   * The fallback for the channel target (currently only supported for "voice" mode)
+   */
+  fallbackTarget?: string | null | undefined;
+  /**
+   * Whether the channel target is intended for testing. If true, any sessions created through this target will be labeled as test.
+   */
+  isTest?: boolean | undefined;
+  /**
+   * The ID of the channel target
+   */
+  id: number;
+};
+
+/** @internal */
+export const ChannelTargetUpdateRequest$inboundSchema: z.ZodType<
+  ChannelTargetUpdateRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  agent_id: z.number().int(),
+  channel_id: z.number().int(),
+  target: z.string(),
+  target_mode: TargetModes$inboundSchema,
+  fallback_target: z.nullable(z.string()).optional(),
+  is_test: z.boolean().default(false),
+  id: z.number().int(),
+}).transform((v) => {
+  return remap$(v, {
+    "agent_id": "agentId",
+    "channel_id": "channelId",
+    "target_mode": "targetMode",
+    "fallback_target": "fallbackTarget",
+    "is_test": "isTest",
+  });
+});
+
+/** @internal */
+export type ChannelTargetUpdateRequest$Outbound = {
+  agent_id: number;
+  channel_id: number;
+  target: string;
+  target_mode: string;
+  fallback_target?: string | null | undefined;
+  is_test: boolean;
+  id: number;
+};
+
+/** @internal */
+export const ChannelTargetUpdateRequest$outboundSchema: z.ZodType<
+  ChannelTargetUpdateRequest$Outbound,
+  z.ZodTypeDef,
+  ChannelTargetUpdateRequest
+> = z.object({
+  agentId: z.number().int(),
+  channelId: z.number().int(),
+  target: z.string(),
+  targetMode: TargetModes$outboundSchema,
+  fallbackTarget: z.nullable(z.string()).optional(),
+  isTest: z.boolean().default(false),
+  id: z.number().int(),
+}).transform((v) => {
+  return remap$(v, {
+    agentId: "agent_id",
+    channelId: "channel_id",
+    targetMode: "target_mode",
+    fallbackTarget: "fallback_target",
+    isTest: "is_test",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ChannelTargetUpdateRequest$ {
+  /** @deprecated use `ChannelTargetUpdateRequest$inboundSchema` instead. */
+  export const inboundSchema = ChannelTargetUpdateRequest$inboundSchema;
+  /** @deprecated use `ChannelTargetUpdateRequest$outboundSchema` instead. */
+  export const outboundSchema = ChannelTargetUpdateRequest$outboundSchema;
+  /** @deprecated use `ChannelTargetUpdateRequest$Outbound` instead. */
+  export type Outbound = ChannelTargetUpdateRequest$Outbound;
+}
+
+export function channelTargetUpdateRequestToJSON(
+  channelTargetUpdateRequest: ChannelTargetUpdateRequest,
+): string {
+  return JSON.stringify(
+    ChannelTargetUpdateRequest$outboundSchema.parse(channelTargetUpdateRequest),
+  );
+}
+
+export function channelTargetUpdateRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<ChannelTargetUpdateRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ChannelTargetUpdateRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ChannelTargetUpdateRequest' from JSON`,
+  );
+}

package/src/models/components/conversation.ts

@@ -8,18 +8,60 @@ import { safeParse } from "../../lib/schemas.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
+/**
+ * A conversation is a record of messages between a user and an agent, and is composed of one or
+ *
+ * @remarks
+ * more sessions.
+ */
 export type Conversation = {
+  /**
+   * Timestamp of the conversation
+   */
   timestamp: Date;
+  /**
+   * ID of the conversation
+   */
   conversationId: string;
+  /**
+   * ID of the agent with which the conversation occurred
+   */
   agentId?: string | null | undefined;
+  /**
+   * Name of the agent with which the conversation occurred
+   */
   agentName?: string | null | undefined;
+  /**
+   * Value of the "type" field of the agent with which the conversation occurred
+   */
   agentType?: string | null | undefined;
+  /**
+   * ID of the prompt used in the conversation
+   */
   promptId?: string | null | undefined;
+  /**
+   * Name of the prompt used in the conversation
+   */
   promptName?: string | null | undefined;
+  /**
+   * Version of the prompt used in the conversation
+   */
   promptVersion?: string | null | undefined;
+  /**
+   * Provider for the LLM used in the conversation (see PromptResponse.llm_config.provider)
+   */
   llmProvider?: string | null | undefined;
+  /**
+   * Model for the LLM used in the conversation (see PromptResponse.llm_config.model)
+   */
   llmModel?: string | null | undefined;
+  /**
+   * Version for the LLM used in the conversation (see PromptResponse.llm_config.version)
+   */
   llmVersion?: string | null | undefined;
+  /**
+   * Whether the conversation occurred on the legacy Syllable system
+   */
   isLegacy?: boolean | null | undefined;
 };