syllable-sdk 0.1.0-alpha.29 → 0.1.0-alpha.30

package/src/models/components/agentcreate.ts

@@ -14,20 +14,99 @@ import {
   AgentToolDefaults$outboundSchema,
 } from "./agenttooldefaults.js";
 
+export type Variables = {};
+
 export type AgentCreate = {
+  /**
+   * The agent name
+   */
   name: string;
+  /**
+   * The agent description
+   */
   description?: string | null | undefined;
+  /**
+   * The agent label
+   */
   label?: string | null | undefined;
-  timezone: string;
+  /**
+   * The agent type. Can be an arbitrary string
+   */
   type: string;
+  /**
+   * ID of the prompt associated with the agent
+   */
   promptId: number;
-  customMessageId: number | null;
-  languages: Array<string>;
+  /**
+   * ID of the custom message that should be delivered at the beginning of a conversation with the agent
+   */
+  customMessageId: number;
+  /**
+   * The time zone in which the agent operates
+   */
+  timezone: string;
+  /**
+   * The prompt tool defaults
+   */
   promptToolDefaults?: Array<AgentToolDefaults> | undefined;
-  toolHeaders?: { [k: string]: string } | null | undefined;
-  variables?: { [k: string]: string } | null | undefined;
+  /**
+   * BCP 47 codes of languages the agent supports
+   */
+  languages?: Array<string> | undefined;
+  /**
+   * Custom context variables for the conversation session. Should be prefixed with "vars.".
+   */
+  variables: Variables | null;
+  /**
+   * Optional headers to include in tool calls for agent.
+   */
+  toolHeaders: { [k: string]: string } | null;
 };
 
+/** @internal */
+export const Variables$inboundSchema: z.ZodType<
+  Variables,
+  z.ZodTypeDef,
+  unknown
+> = z.object({});
+
+/** @internal */
+export type Variables$Outbound = {};
+
+/** @internal */
+export const Variables$outboundSchema: z.ZodType<
+  Variables$Outbound,
+  z.ZodTypeDef,
+  Variables
+> = z.object({});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace Variables$ {
+  /** @deprecated use `Variables$inboundSchema` instead. */
+  export const inboundSchema = Variables$inboundSchema;
+  /** @deprecated use `Variables$outboundSchema` instead. */
+  export const outboundSchema = Variables$outboundSchema;
+  /** @deprecated use `Variables$Outbound` instead. */
+  export type Outbound = Variables$Outbound;
+}
+
+export function variablesToJSON(variables: Variables): string {
+  return JSON.stringify(Variables$outboundSchema.parse(variables));
+}
+
+export function variablesFromJSON(
+  jsonString: string,
+): SafeParseResult<Variables, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Variables$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Variables' from JSON`,
+  );
+}
+
 /** @internal */
 export const AgentCreate$inboundSchema: z.ZodType<
   AgentCreate,
@@ -37,14 +116,14 @@ export const AgentCreate$inboundSchema: z.ZodType<
   name: z.string(),
   description: z.nullable(z.string()).optional(),
   label: z.nullable(z.string()).optional(),
-  timezone: z.string(),
   type: z.string(),
   prompt_id: z.number().int(),
-  custom_message_id: z.nullable(z.number().int()),
-  languages: z.array(z.string()),
+  custom_message_id: z.number().int(),
+  timezone: z.string(),
   prompt_tool_defaults: z.array(AgentToolDefaults$inboundSchema).optional(),
-  tool_headers: z.nullable(z.record(z.string())).optional(),
-  variables: z.nullable(z.record(z.string())).optional(),
+  languages: z.array(z.string()).optional(),
+  variables: z.nullable(z.lazy(() => Variables$inboundSchema)),
+  tool_headers: z.nullable(z.record(z.string())),
 }).transform((v) => {
   return remap$(v, {
     "prompt_id": "promptId",
@@ -59,14 +138,14 @@ export type AgentCreate$Outbound = {
   name: string;
   description?: string | null | undefined;
   label?: string | null | undefined;
-  timezone: string;
   type: string;
   prompt_id: number;
-  custom_message_id: number | null;
-  languages: Array<string>;
+  custom_message_id: number;
+  timezone: string;
   prompt_tool_defaults?: Array<AgentToolDefaults$Outbound> | undefined;
-  tool_headers?: { [k: string]: string } | null | undefined;
-  variables?: { [k: string]: string } | null | undefined;
+  languages?: Array<string> | undefined;
+  variables: Variables$Outbound | null;
+  tool_headers: { [k: string]: string } | null;
 };
 
 /** @internal */
@@ -78,14 +157,14 @@ export const AgentCreate$outboundSchema: z.ZodType<
   name: z.string(),
   description: z.nullable(z.string()).optional(),
   label: z.nullable(z.string()).optional(),
-  timezone: z.string(),
   type: z.string(),
   promptId: z.number().int(),
-  customMessageId: z.nullable(z.number().int()),
-  languages: z.array(z.string()),
+  customMessageId: z.number().int(),
+  timezone: z.string(),
   promptToolDefaults: z.array(AgentToolDefaults$outboundSchema).optional(),
-  toolHeaders: z.nullable(z.record(z.string())).optional(),
-  variables: z.nullable(z.record(z.string())).optional(),
+  languages: z.array(z.string()).optional(),
+  variables: z.nullable(z.lazy(() => Variables$outboundSchema)),
+  toolHeaders: z.nullable(z.record(z.string())),
 }).transform((v) => {
   return remap$(v, {
     promptId: "prompt_id",

package/src/models/components/agentresponse.ts

@@ -14,62 +14,78 @@ import {
   AgentToolDefaults$outboundSchema,
 } from "./agenttooldefaults.js";
 import {
-  CustomMessage,
-  CustomMessage$inboundSchema,
-  CustomMessage$Outbound,
-  CustomMessage$outboundSchema,
-} from "./custommessage.js";
+  ChannelTargetResponse,
+  ChannelTargetResponse$inboundSchema,
+  ChannelTargetResponse$Outbound,
+  ChannelTargetResponse$outboundSchema,
+} from "./channeltargetresponse.js";
 import {
-  Prompt,
-  Prompt$inboundSchema,
-  Prompt$Outbound,
-  Prompt$outboundSchema,
-} from "./prompt.js";
+  CustomMessageResponse,
+  CustomMessageResponse$inboundSchema,
+  CustomMessageResponse$Outbound,
+  CustomMessageResponse$outboundSchema,
+} from "./custommessageresponse.js";
 import {
-  Target,
-  Target$inboundSchema,
-  Target$Outbound,
-  Target$outboundSchema,
-} from "./target.js";
+  PromptResponse,
+  PromptResponse$inboundSchema,
+  PromptResponse$Outbound,
+  PromptResponse$outboundSchema,
+} from "./promptresponse.js";
 
+/**
+ * When a user interacts with the Syllable system, they do so by communicating with an agent.
+ *
+ * @remarks
+ * An agent is linked to a prompt, a custom message, and one or more channel targets to define its
+ * behavior and capabilities.
+ */
 export type AgentResponse = {
   /**
-   * The Agent name
+   * The agent name
    */
   name: string;
   /**
-   * The Agent description
+   * The agent description
    */
   description?: string | null | undefined;
   /**
-   * The Agent label
+   * The agent label
    */
   label?: string | null | undefined;
   /**
-   * The Agent type
+   * The agent type. Can be an arbitrary string
    */
   type: string;
   /**
-   * The Agent's prompt id
+   * ID of the prompt associated with the agent
    */
   promptId: number;
   /**
-   * The Agent's custom message id
+   * ID of the custom message that should be delivered at the beginning of a conversation with the agent
    */
-  customMessageId?: number | null | undefined;
+  customMessageId: number;
   /**
-   * The time zone the bot operates in
+   * The time zone in which the agent operates
    */
   timezone: string;
-  promptToolDefaults: Array<AgentToolDefaults>;
-  languages: Array<string>;
+  /**
+   * The prompt tool defaults
+   */
+  promptToolDefaults?: Array<AgentToolDefaults> | undefined;
+  /**
+   * BCP 47 codes of languages the agent supports
+   */
+  languages?: Array<string> | undefined;
+  /**
+   * Custom context variables for the conversation session. Should be prefixed with "vars.".
+   */
   variables: { [k: string]: string };
   /**
-   * Optional headers to include in tool calls.
+   * Optional headers to include in tool calls for agent.
    */
   toolHeaders: { [k: string]: string } | null;
   /**
-   * The Agent ID
+   * The agent ID
    */
   id: number;
   /**
@@ -81,17 +97,17 @@ export type AgentResponse = {
    */
   lastUpdatedBy: string | null;
   /**
-   * Channel targets associated with the agent
+   * The prompt associated with the agent.
    */
-  channelTargets?: Array<Target> | null | undefined;
+  prompt?: PromptResponse | null | undefined;
   /**
-   * The prompt associated with the agent
+   * The custom message associated with the agent. Will be delivered as a greeting at the beginning of a conversation.
    */
-  prompt?: Prompt | null | undefined;
+  customMessage?: CustomMessageResponse | null | undefined;
   /**
-   * The custom message associated with the agent
+   * Channel targets associated with the agent
    */
-  customMessage?: CustomMessage | null | undefined;
+  channelTargets?: Array<ChannelTargetResponse> | null | undefined;
 };
 
 /** @internal */
@@ -105,18 +121,20 @@ export const AgentResponse$inboundSchema: z.ZodType<
   label: z.nullable(z.string()).optional(),
   type: z.string(),
   prompt_id: z.number().int(),
-  custom_message_id: z.nullable(z.number().int()).optional(),
+  custom_message_id: z.number().int(),
   timezone: z.string(),
-  prompt_tool_defaults: z.array(AgentToolDefaults$inboundSchema),
-  languages: z.array(z.string()),
+  prompt_tool_defaults: z.array(AgentToolDefaults$inboundSchema).optional(),
+  languages: z.array(z.string()).optional(),
   variables: z.record(z.string()),
   tool_headers: z.nullable(z.record(z.string())),
   id: z.number().int(),
   updated_at: z.string().datetime({ offset: true }).transform(v => new Date(v)),
   last_updated_by: z.nullable(z.string()),
-  channel_targets: z.nullable(z.array(Target$inboundSchema)).optional(),
-  prompt: z.nullable(Prompt$inboundSchema).optional(),
-  custom_message: z.nullable(CustomMessage$inboundSchema).optional(),
+  prompt: z.nullable(PromptResponse$inboundSchema).optional(),
+  custom_message: z.nullable(CustomMessageResponse$inboundSchema).optional(),
+  channel_targets: z.nullable(
+    z.array(z.lazy(() => ChannelTargetResponse$inboundSchema)),
+  ).optional(),
 }).transform((v) => {
   return remap$(v, {
     "prompt_id": "promptId",
@@ -125,8 +143,8 @@ export const AgentResponse$inboundSchema: z.ZodType<
     "tool_headers": "toolHeaders",
     "updated_at": "updatedAt",
     "last_updated_by": "lastUpdatedBy",
-    "channel_targets": "channelTargets",
     "custom_message": "customMessage",
+    "channel_targets": "channelTargets",
   });
 });
 
@@ -137,18 +155,18 @@ export type AgentResponse$Outbound = {
   label?: string | null | undefined;
   type: string;
   prompt_id: number;
-  custom_message_id?: number | null | undefined;
+  custom_message_id: number;
   timezone: string;
-  prompt_tool_defaults: Array<AgentToolDefaults$Outbound>;
-  languages: Array<string>;
+  prompt_tool_defaults?: Array<AgentToolDefaults$Outbound> | undefined;
+  languages?: Array<string> | undefined;
   variables: { [k: string]: string };
   tool_headers: { [k: string]: string } | null;
   id: number;
   updated_at: string;
   last_updated_by: string | null;
-  channel_targets?: Array<Target$Outbound> | null | undefined;
-  prompt?: Prompt$Outbound | null | undefined;
-  custom_message?: CustomMessage$Outbound | null | undefined;
+  prompt?: PromptResponse$Outbound | null | undefined;
+  custom_message?: CustomMessageResponse$Outbound | null | undefined;
+  channel_targets?: Array<ChannelTargetResponse$Outbound> | null | undefined;
 };
 
 /** @internal */
@@ -162,18 +180,20 @@ export const AgentResponse$outboundSchema: z.ZodType<
   label: z.nullable(z.string()).optional(),
   type: z.string(),
   promptId: z.number().int(),
-  customMessageId: z.nullable(z.number().int()).optional(),
+  customMessageId: z.number().int(),
   timezone: z.string(),
-  promptToolDefaults: z.array(AgentToolDefaults$outboundSchema),
-  languages: z.array(z.string()),
+  promptToolDefaults: z.array(AgentToolDefaults$outboundSchema).optional(),
+  languages: z.array(z.string()).optional(),
   variables: z.record(z.string()),
   toolHeaders: z.nullable(z.record(z.string())),
   id: z.number().int(),
   updatedAt: z.date().transform(v => v.toISOString()),
   lastUpdatedBy: z.nullable(z.string()),
-  channelTargets: z.nullable(z.array(Target$outboundSchema)).optional(),
-  prompt: z.nullable(Prompt$outboundSchema).optional(),
-  customMessage: z.nullable(CustomMessage$outboundSchema).optional(),
+  prompt: z.nullable(PromptResponse$outboundSchema).optional(),
+  customMessage: z.nullable(CustomMessageResponse$outboundSchema).optional(),
+  channelTargets: z.nullable(
+    z.array(z.lazy(() => ChannelTargetResponse$outboundSchema)),
+  ).optional(),
 }).transform((v) => {
   return remap$(v, {
     promptId: "prompt_id",
@@ -182,8 +202,8 @@ export const AgentResponse$outboundSchema: z.ZodType<
     toolHeaders: "tool_headers",
     updatedAt: "updated_at",
     lastUpdatedBy: "last_updated_by",
-    channelTargets: "channel_targets",
     customMessage: "custom_message",
+    channelTargets: "channel_targets",
   });
 });
 

package/src/models/components/agenttooldefaults.ts

@@ -14,8 +14,17 @@ import {
   AgentToolFieldDefault$outboundSchema,
 } from "./agenttoolfielddefault.js";
 
+/**
+ * An agent-level configuration of default values for tool parameters for its tools.
+ */
 export type AgentToolDefaults = {
+  /**
+   * The name of the tool
+   */
   toolName: string;
+  /**
+   * The default values for fields used in the tool
+   */
   defaultValues: Array<AgentToolFieldDefault>;
 };
 

package/src/models/components/agenttoolfielddefault.ts

@@ -8,8 +8,17 @@ import { safeParse } from "../../lib/schemas.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
+/**
+ * An agent-level configuration of default values for tool parameters for a given tool.
+ */
 export type AgentToolFieldDefault = {
+  /**
+   * The name of the field
+   */
   fieldName: string;
+  /**
+   * The default value for the field
+   */
   defaultValue?: any | undefined;
 };
 

package/src/models/components/agentupdate.ts

@@ -14,24 +14,107 @@ import {
   AgentToolDefaults$outboundSchema,
 } from "./agenttooldefaults.js";
 
+export type AgentUpdateVariables = {};
+
 export type AgentUpdate = {
+  /**
+   * The agent name
+   */
   name: string;
+  /**
+   * The agent description
+   */
   description?: string | null | undefined;
+  /**
+   * The agent label
+   */
   label?: string | null | undefined;
-  timezone: string;
+  /**
+   * The agent type. Can be an arbitrary string
+   */
   type: string;
+  /**
+   * ID of the prompt associated with the agent
+   */
   promptId: number;
-  customMessageId: number | null;
-  languages: Array<string>;
+  /**
+   * ID of the custom message that should be delivered at the beginning of a conversation with the agent
+   */
+  customMessageId: number;
+  /**
+   * The time zone in which the agent operates
+   */
+  timezone: string;
+  /**
+   * The prompt tool defaults
+   */
   promptToolDefaults?: Array<AgentToolDefaults> | undefined;
-  toolHeaders?: { [k: string]: string } | null | undefined;
-  variables?: { [k: string]: string } | null | undefined;
   /**
-   * The Agent ID
+   * BCP 47 codes of languages the agent supports
+   */
+  languages?: Array<string> | undefined;
+  /**
+   * Custom context variables for the conversation session. Should be prefixed with "vars.".
+   */
+  variables: AgentUpdateVariables | null;
+  /**
+   * Optional headers to include in tool calls for agent.
+   */
+  toolHeaders: { [k: string]: string } | null;
+  /**
+   * The agent ID
    */
   id: number;
 };
 
+/** @internal */
+export const AgentUpdateVariables$inboundSchema: z.ZodType<
+  AgentUpdateVariables,
+  z.ZodTypeDef,
+  unknown
+> = z.object({});
+
+/** @internal */
+export type AgentUpdateVariables$Outbound = {};
+
+/** @internal */
+export const AgentUpdateVariables$outboundSchema: z.ZodType<
+  AgentUpdateVariables$Outbound,
+  z.ZodTypeDef,
+  AgentUpdateVariables
+> = z.object({});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace AgentUpdateVariables$ {
+  /** @deprecated use `AgentUpdateVariables$inboundSchema` instead. */
+  export const inboundSchema = AgentUpdateVariables$inboundSchema;
+  /** @deprecated use `AgentUpdateVariables$outboundSchema` instead. */
+  export const outboundSchema = AgentUpdateVariables$outboundSchema;
+  /** @deprecated use `AgentUpdateVariables$Outbound` instead. */
+  export type Outbound = AgentUpdateVariables$Outbound;
+}
+
+export function agentUpdateVariablesToJSON(
+  agentUpdateVariables: AgentUpdateVariables,
+): string {
+  return JSON.stringify(
+    AgentUpdateVariables$outboundSchema.parse(agentUpdateVariables),
+  );
+}
+
+export function agentUpdateVariablesFromJSON(
+  jsonString: string,
+): SafeParseResult<AgentUpdateVariables, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AgentUpdateVariables$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AgentUpdateVariables' from JSON`,
+  );
+}
+
 /** @internal */
 export const AgentUpdate$inboundSchema: z.ZodType<
   AgentUpdate,
@@ -41,14 +124,14 @@ export const AgentUpdate$inboundSchema: z.ZodType<
   name: z.string(),
   description: z.nullable(z.string()).optional(),
   label: z.nullable(z.string()).optional(),
-  timezone: z.string(),
   type: z.string(),
   prompt_id: z.number().int(),
-  custom_message_id: z.nullable(z.number().int()),
-  languages: z.array(z.string()),
+  custom_message_id: z.number().int(),
+  timezone: z.string(),
   prompt_tool_defaults: z.array(AgentToolDefaults$inboundSchema).optional(),
-  tool_headers: z.nullable(z.record(z.string())).optional(),
-  variables: z.nullable(z.record(z.string())).optional(),
+  languages: z.array(z.string()).optional(),
+  variables: z.nullable(z.lazy(() => AgentUpdateVariables$inboundSchema)),
+  tool_headers: z.nullable(z.record(z.string())),
   id: z.number().int(),
 }).transform((v) => {
   return remap$(v, {
@@ -64,14 +147,14 @@ export type AgentUpdate$Outbound = {
   name: string;
   description?: string | null | undefined;
   label?: string | null | undefined;
-  timezone: string;
   type: string;
   prompt_id: number;
-  custom_message_id: number | null;
-  languages: Array<string>;
+  custom_message_id: number;
+  timezone: string;
   prompt_tool_defaults?: Array<AgentToolDefaults$Outbound> | undefined;
-  tool_headers?: { [k: string]: string } | null | undefined;
-  variables?: { [k: string]: string } | null | undefined;
+  languages?: Array<string> | undefined;
+  variables: AgentUpdateVariables$Outbound | null;
+  tool_headers: { [k: string]: string } | null;
   id: number;
 };
 
@@ -84,14 +167,14 @@ export const AgentUpdate$outboundSchema: z.ZodType<
   name: z.string(),
   description: z.nullable(z.string()).optional(),
   label: z.nullable(z.string()).optional(),
-  timezone: z.string(),
   type: z.string(),
   promptId: z.number().int(),
-  customMessageId: z.nullable(z.number().int()),
-  languages: z.array(z.string()),
+  customMessageId: z.number().int(),
+  timezone: z.string(),
   promptToolDefaults: z.array(AgentToolDefaults$outboundSchema).optional(),
-  toolHeaders: z.nullable(z.record(z.string())).optional(),
-  variables: z.nullable(z.record(z.string())).optional(),
+  languages: z.array(z.string()).optional(),
+  variables: z.nullable(z.lazy(() => AgentUpdateVariables$outboundSchema)),
+  toolHeaders: z.nullable(z.record(z.string())),
   id: z.number().int(),
 }).transform((v) => {
   return remap$(v, {

package/src/models/components/agentvoice.ts

@@ -18,9 +18,21 @@ import {
   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;
 };
 

package/src/models/components/agentvoicevarname.ts

@@ -5,6 +5,9 @@
 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",
@@ -35,6 +38,9 @@ export const AgentVoiceVarName = {
   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 */

package/src/models/components/channel.ts

@@ -18,9 +18,12 @@ export type Channel = {
    * The channel name
    */
   name: string;
+  /**
+   * 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 */