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

package/src/models/components/agentcreate.ts

@@ -14,68 +14,57 @@ import {
   AgentToolDefaults$outboundSchema,
 } from "./agenttooldefaults.js";
 
-export type AgentCreateVariables = {};
-
 export type AgentCreate = {
+  /**
+   * The agent name
+   */
   name: string;
-  timezone: string;
+  /**
+   * The agent description
+   */
+  description?: string | null | undefined;
+  /**
+   * The agent label
+   */
+  label?: string | null | undefined;
+  /**
+   * 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?: AgentCreateVariables | null | undefined;
+  /**
+   * BCP 47 codes of languages the agent supports
+   */
+  languages?: Array<string> | undefined;
+  /**
+   * Custom context variables for the conversation session. Keys should be prefixed with "vars.".
+   */
+  variables: { [k: string]: string };
+  /**
+   * Optional headers to include in tool calls for agent.
+   */
+  toolHeaders: { [k: string]: string } | null;
+  /**
+   * Whether the agent initiates conversation with a user after the custom_message is delivered
+   */
+  agentInitiated?: boolean | undefined;
 };
 
-/** @internal */
-export const AgentCreateVariables$inboundSchema: z.ZodType<
-  AgentCreateVariables,
-  z.ZodTypeDef,
-  unknown
-> = z.object({});
-
-/** @internal */
-export type AgentCreateVariables$Outbound = {};
-
-/** @internal */
-export const AgentCreateVariables$outboundSchema: z.ZodType<
-  AgentCreateVariables$Outbound,
-  z.ZodTypeDef,
-  AgentCreateVariables
-> = 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 AgentCreateVariables$ {
-  /** @deprecated use `AgentCreateVariables$inboundSchema` instead. */
-  export const inboundSchema = AgentCreateVariables$inboundSchema;
-  /** @deprecated use `AgentCreateVariables$outboundSchema` instead. */
-  export const outboundSchema = AgentCreateVariables$outboundSchema;
-  /** @deprecated use `AgentCreateVariables$Outbound` instead. */
-  export type Outbound = AgentCreateVariables$Outbound;
-}
-
-export function agentCreateVariablesToJSON(
-  agentCreateVariables: AgentCreateVariables,
-): string {
-  return JSON.stringify(
-    AgentCreateVariables$outboundSchema.parse(agentCreateVariables),
-  );
-}
-
-export function agentCreateVariablesFromJSON(
-  jsonString: string,
-): SafeParseResult<AgentCreateVariables, SDKValidationError> {
-  return safeParse(
-    jsonString,
-    (x) => AgentCreateVariables$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'AgentCreateVariables' from JSON`,
-  );
-}
-
 /** @internal */
 export const AgentCreate$inboundSchema: z.ZodType<
   AgentCreate,
@@ -83,35 +72,41 @@ export const AgentCreate$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   name: z.string(),
-  timezone: z.string(),
+  description: z.nullable(z.string()).optional(),
+  label: z.nullable(z.string()).optional(),
   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.lazy(() => AgentCreateVariables$inboundSchema))
-    .optional(),
+  languages: z.array(z.string()).optional(),
+  variables: z.record(z.string()),
+  tool_headers: z.nullable(z.record(z.string())),
+  agent_initiated: z.boolean().default(false),
 }).transform((v) => {
   return remap$(v, {
     "prompt_id": "promptId",
     "custom_message_id": "customMessageId",
     "prompt_tool_defaults": "promptToolDefaults",
     "tool_headers": "toolHeaders",
+    "agent_initiated": "agentInitiated",
   });
 });
 
 /** @internal */
 export type AgentCreate$Outbound = {
   name: string;
-  timezone: string;
+  description?: string | null | undefined;
+  label?: string | null | undefined;
   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?: AgentCreateVariables$Outbound | null | undefined;
+  languages?: Array<string> | undefined;
+  variables: { [k: string]: string };
+  tool_headers: { [k: string]: string } | null;
+  agent_initiated: boolean;
 };
 
 /** @internal */
@@ -121,21 +116,24 @@ export const AgentCreate$outboundSchema: z.ZodType<
   AgentCreate
 > = z.object({
   name: z.string(),
-  timezone: z.string(),
+  description: z.nullable(z.string()).optional(),
+  label: z.nullable(z.string()).optional(),
   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.lazy(() => AgentCreateVariables$outboundSchema))
-    .optional(),
+  languages: z.array(z.string()).optional(),
+  variables: z.record(z.string()),
+  toolHeaders: z.nullable(z.record(z.string())),
+  agentInitiated: z.boolean().default(false),
 }).transform((v) => {
   return remap$(v, {
     promptId: "prompt_id",
     customMessageId: "custom_message_id",
     promptToolDefaults: "prompt_tool_defaults",
     toolHeaders: "tool_headers",
+    agentInitiated: "agent_initiated",
   });
 });
 

package/src/models/components/agentproperties.ts

@@ -8,14 +8,20 @@ import { ClosedEnum } from "../../types/enums.js";
 export const AgentProperties = {
   Id: "id",
   Name: "name",
+  Description: "description",
+  Label: "label",
+  NameDescription: "name_description",
   Type: "type",
   Timezone: "timezone",
   PromptId: "prompt_id",
+  PromptIdList: "prompt_id_list",
   CustomMessageId: "custom_message_id",
   Languages: "languages",
   Variables: "variables",
   PromptToolDefaults: "prompt_tool_defaults",
   ToolHeaders: "tool_headers",
+  UpdatedAt: "updated_at",
+  LastUpdatedBy: "last_updated_by",
 } as const;
 export type AgentProperties = ClosedEnum<typeof AgentProperties>;
 

package/src/models/components/agentresponse.ts

@@ -0,0 +1,244 @@
+/*
+ * 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 {
+  AgentToolDefaults,
+  AgentToolDefaults$inboundSchema,
+  AgentToolDefaults$Outbound,
+  AgentToolDefaults$outboundSchema,
+} from "./agenttooldefaults.js";
+import {
+  ChannelTargetResponse,
+  ChannelTargetResponse$inboundSchema,
+  ChannelTargetResponse$Outbound,
+  ChannelTargetResponse$outboundSchema,
+} from "./channeltargetresponse.js";
+import {
+  CustomMessageResponse,
+  CustomMessageResponse$inboundSchema,
+  CustomMessageResponse$Outbound,
+  CustomMessageResponse$outboundSchema,
+} from "./custommessageresponse.js";
+import {
+  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
+   */
+  name: string;
+  /**
+   * The agent description
+   */
+  description?: string | null | undefined;
+  /**
+   * The agent label
+   */
+  label?: string | null | undefined;
+  /**
+   * The agent type. Can be an arbitrary string
+   */
+  type: string;
+  /**
+   * ID of the prompt associated with the agent
+   */
+  promptId: number;
+  /**
+   * 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;
+  /**
+   * BCP 47 codes of languages the agent supports
+   */
+  languages?: Array<string> | undefined;
+  /**
+   * Custom context variables for the conversation session. Keys should be prefixed with "vars.".
+   */
+  variables: { [k: string]: string };
+  /**
+   * Optional headers to include in tool calls for agent.
+   */
+  toolHeaders: { [k: string]: string } | null;
+  /**
+   * Whether the agent initiates conversation with a user after the custom_message is delivered
+   */
+  agentInitiated?: boolean | undefined;
+  /**
+   * The agent ID
+   */
+  id: number;
+  /**
+   * Timestamp of most recent update
+   */
+  updatedAt: Date;
+  /**
+   * Email of the user who last updated the agent
+   */
+  lastUpdatedBy: string | null;
+  /**
+   * The prompt associated with the agent.
+   */
+  prompt?: PromptResponse | null | undefined;
+  /**
+   * The custom message associated with the agent. Will be delivered as a greeting at the beginning of a conversation.
+   */
+  customMessage?: CustomMessageResponse | null | undefined;
+  /**
+   * Channel targets associated with the agent
+   */
+  channelTargets?: Array<ChannelTargetResponse> | null | undefined;
+};
+
+/** @internal */
+export const AgentResponse$inboundSchema: z.ZodType<
+  AgentResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  name: z.string(),
+  description: z.nullable(z.string()).optional(),
+  label: z.nullable(z.string()).optional(),
+  type: z.string(),
+  prompt_id: z.number().int(),
+  custom_message_id: z.number().int(),
+  timezone: 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())),
+  agent_initiated: z.boolean().default(false),
+  id: z.number().int(),
+  updated_at: z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  last_updated_by: z.nullable(z.string()),
+  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",
+    "custom_message_id": "customMessageId",
+    "prompt_tool_defaults": "promptToolDefaults",
+    "tool_headers": "toolHeaders",
+    "agent_initiated": "agentInitiated",
+    "updated_at": "updatedAt",
+    "last_updated_by": "lastUpdatedBy",
+    "custom_message": "customMessage",
+    "channel_targets": "channelTargets",
+  });
+});
+
+/** @internal */
+export type AgentResponse$Outbound = {
+  name: string;
+  description?: string | null | undefined;
+  label?: string | null | undefined;
+  type: string;
+  prompt_id: number;
+  custom_message_id: number;
+  timezone: string;
+  prompt_tool_defaults?: Array<AgentToolDefaults$Outbound> | undefined;
+  languages?: Array<string> | undefined;
+  variables: { [k: string]: string };
+  tool_headers: { [k: string]: string } | null;
+  agent_initiated: boolean;
+  id: number;
+  updated_at: string;
+  last_updated_by: string | null;
+  prompt?: PromptResponse$Outbound | null | undefined;
+  custom_message?: CustomMessageResponse$Outbound | null | undefined;
+  channel_targets?: Array<ChannelTargetResponse$Outbound> | null | undefined;
+};
+
+/** @internal */
+export const AgentResponse$outboundSchema: z.ZodType<
+  AgentResponse$Outbound,
+  z.ZodTypeDef,
+  AgentResponse
+> = z.object({
+  name: z.string(),
+  description: z.nullable(z.string()).optional(),
+  label: z.nullable(z.string()).optional(),
+  type: z.string(),
+  promptId: z.number().int(),
+  customMessageId: z.number().int(),
+  timezone: 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())),
+  agentInitiated: z.boolean().default(false),
+  id: z.number().int(),
+  updatedAt: z.date().transform(v => v.toISOString()),
+  lastUpdatedBy: z.nullable(z.string()),
+  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",
+    customMessageId: "custom_message_id",
+    promptToolDefaults: "prompt_tool_defaults",
+    toolHeaders: "tool_headers",
+    agentInitiated: "agent_initiated",
+    updatedAt: "updated_at",
+    lastUpdatedBy: "last_updated_by",
+    customMessage: "custom_message",
+    channelTargets: "channel_targets",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace AgentResponse$ {
+  /** @deprecated use `AgentResponse$inboundSchema` instead. */
+  export const inboundSchema = AgentResponse$inboundSchema;
+  /** @deprecated use `AgentResponse$outboundSchema` instead. */
+  export const outboundSchema = AgentResponse$outboundSchema;
+  /** @deprecated use `AgentResponse$Outbound` instead. */
+  export type Outbound = AgentResponse$Outbound;
+}
+
+export function agentResponseToJSON(agentResponse: AgentResponse): string {
+  return JSON.stringify(AgentResponse$outboundSchema.parse(agentResponse));
+}
+
+export function agentResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<AgentResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AgentResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AgentResponse' from JSON`,
+  );
+}

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

@@ -0,0 +1,172 @@
+/*
+ * 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 {
+  AgentToolDefaults,
+  AgentToolDefaults$inboundSchema,
+  AgentToolDefaults$Outbound,
+  AgentToolDefaults$outboundSchema,
+} from "./agenttooldefaults.js";
+
+export type AgentUpdate = {
+  /**
+   * The agent name
+   */
+  name: string;
+  /**
+   * The agent description
+   */
+  description?: string | null | undefined;
+  /**
+   * The agent label
+   */
+  label?: string | null | undefined;
+  /**
+   * The agent type. Can be an arbitrary string
+   */
+  type: string;
+  /**
+   * ID of the prompt associated with the agent
+   */
+  promptId: number;
+  /**
+   * 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;
+  /**
+   * BCP 47 codes of languages the agent supports
+   */
+  languages?: Array<string> | undefined;
+  /**
+   * Custom context variables for the conversation session. Keys should be prefixed with "vars.".
+   */
+  variables: { [k: string]: string };
+  /**
+   * Optional headers to include in tool calls for agent.
+   */
+  toolHeaders: { [k: string]: string } | null;
+  /**
+   * Whether the agent initiates conversation with a user after the custom_message is delivered
+   */
+  agentInitiated?: boolean | undefined;
+  /**
+   * The agent ID
+   */
+  id: number;
+};
+
+/** @internal */
+export const AgentUpdate$inboundSchema: z.ZodType<
+  AgentUpdate,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  name: z.string(),
+  description: z.nullable(z.string()).optional(),
+  label: z.nullable(z.string()).optional(),
+  type: z.string(),
+  prompt_id: z.number().int(),
+  custom_message_id: z.number().int(),
+  timezone: 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())),
+  agent_initiated: z.boolean().default(false),
+  id: z.number().int(),
+}).transform((v) => {
+  return remap$(v, {
+    "prompt_id": "promptId",
+    "custom_message_id": "customMessageId",
+    "prompt_tool_defaults": "promptToolDefaults",
+    "tool_headers": "toolHeaders",
+    "agent_initiated": "agentInitiated",
+  });
+});
+
+/** @internal */
+export type AgentUpdate$Outbound = {
+  name: string;
+  description?: string | null | undefined;
+  label?: string | null | undefined;
+  type: string;
+  prompt_id: number;
+  custom_message_id: number;
+  timezone: string;
+  prompt_tool_defaults?: Array<AgentToolDefaults$Outbound> | undefined;
+  languages?: Array<string> | undefined;
+  variables: { [k: string]: string };
+  tool_headers: { [k: string]: string } | null;
+  agent_initiated: boolean;
+  id: number;
+};
+
+/** @internal */
+export const AgentUpdate$outboundSchema: z.ZodType<
+  AgentUpdate$Outbound,
+  z.ZodTypeDef,
+  AgentUpdate
+> = z.object({
+  name: z.string(),
+  description: z.nullable(z.string()).optional(),
+  label: z.nullable(z.string()).optional(),
+  type: z.string(),
+  promptId: z.number().int(),
+  customMessageId: z.number().int(),
+  timezone: 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())),
+  agentInitiated: z.boolean().default(false),
+  id: z.number().int(),
+}).transform((v) => {
+  return remap$(v, {
+    promptId: "prompt_id",
+    customMessageId: "custom_message_id",
+    promptToolDefaults: "prompt_tool_defaults",
+    toolHeaders: "tool_headers",
+    agentInitiated: "agent_initiated",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace AgentUpdate$ {
+  /** @deprecated use `AgentUpdate$inboundSchema` instead. */
+  export const inboundSchema = AgentUpdate$inboundSchema;
+  /** @deprecated use `AgentUpdate$outboundSchema` instead. */
+  export const outboundSchema = AgentUpdate$outboundSchema;
+  /** @deprecated use `AgentUpdate$Outbound` instead. */
+  export type Outbound = AgentUpdate$Outbound;
+}
+
+export function agentUpdateToJSON(agentUpdate: AgentUpdate): string {
+  return JSON.stringify(AgentUpdate$outboundSchema.parse(agentUpdate));
+}
+
+export function agentUpdateFromJSON(
+  jsonString: string,
+): SafeParseResult<AgentUpdate, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AgentUpdate$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AgentUpdate' from JSON`,
+  );
+}