syllable-sdk 1.0.8-rc.2 → 1.0.8

package/src/models/components/daotoolresponse.ts

@@ -0,0 +1,171 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+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 {
+  ToolAgentInfo,
+  ToolAgentInfo$inboundSchema,
+  ToolAgentInfo$Outbound,
+  ToolAgentInfo$outboundSchema,
+} from "./toolagentinfo.js";
+import {
+  ToolDefinition,
+  ToolDefinition$inboundSchema,
+  ToolDefinition$Outbound,
+  ToolDefinition$outboundSchema,
+} from "./tooldefinition.js";
+import {
+  ToolPromptInfo,
+  ToolPromptInfo$inboundSchema,
+  ToolPromptInfo$Outbound,
+  ToolPromptInfo$outboundSchema,
+} from "./toolpromptinfo.js";
+
+export type DaoToolResponse = {
+  /**
+   * The name of the tool
+   */
+  name: string;
+  /**
+   * A tool that can be called from an LLM during the conversation. See https://docs.syllable.ai/Resources/Tools.
+   */
+  definition: ToolDefinition;
+  /**
+   * Internal ID of the service to which the tool belongs
+   */
+  serviceId: number;
+  /**
+   * The internal ID of the tool
+   */
+  id: number;
+  /**
+   * Comments for the most recent edit to the tool.
+   */
+  lastUpdatedComments?: string | null | undefined;
+  /**
+   * The name of the service to which the tool belongs
+   */
+  serviceName?: string | null | undefined;
+  /**
+   * IDs and names of the prompts linked to the tool
+   */
+  promptsInfo?: Array<ToolPromptInfo> | null | undefined;
+  /**
+   * IDs and names of the agents linked to the tool via a prompt
+   */
+  agentsInfo?: Array<ToolAgentInfo> | null | undefined;
+  /**
+   * The timestamp of the most recent update to the tool
+   */
+  lastUpdated: Date;
+  /**
+   * The email of the user who last updated the tool
+   */
+  lastUpdatedBy: string;
+};
+
+/** @internal */
+export const DaoToolResponse$inboundSchema: z.ZodType<
+  DaoToolResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  name: z.string(),
+  definition: ToolDefinition$inboundSchema,
+  service_id: z.number().int(),
+  id: z.number().int(),
+  last_updated_comments: z.nullable(z.string()).optional(),
+  service_name: z.nullable(z.string()).optional(),
+  prompts_info: z.nullable(z.array(ToolPromptInfo$inboundSchema)).optional(),
+  agents_info: z.nullable(z.array(ToolAgentInfo$inboundSchema)).optional(),
+  last_updated: z.string().datetime({ offset: true }).transform(v =>
+    new Date(v)
+  ),
+  last_updated_by: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "service_id": "serviceId",
+    "last_updated_comments": "lastUpdatedComments",
+    "service_name": "serviceName",
+    "prompts_info": "promptsInfo",
+    "agents_info": "agentsInfo",
+    "last_updated": "lastUpdated",
+    "last_updated_by": "lastUpdatedBy",
+  });
+});
+
+/** @internal */
+export type DaoToolResponse$Outbound = {
+  name: string;
+  definition: ToolDefinition$Outbound;
+  service_id: number;
+  id: number;
+  last_updated_comments?: string | null | undefined;
+  service_name?: string | null | undefined;
+  prompts_info?: Array<ToolPromptInfo$Outbound> | null | undefined;
+  agents_info?: Array<ToolAgentInfo$Outbound> | null | undefined;
+  last_updated: string;
+  last_updated_by: string;
+};
+
+/** @internal */
+export const DaoToolResponse$outboundSchema: z.ZodType<
+  DaoToolResponse$Outbound,
+  z.ZodTypeDef,
+  DaoToolResponse
+> = z.object({
+  name: z.string(),
+  definition: ToolDefinition$outboundSchema,
+  serviceId: z.number().int(),
+  id: z.number().int(),
+  lastUpdatedComments: z.nullable(z.string()).optional(),
+  serviceName: z.nullable(z.string()).optional(),
+  promptsInfo: z.nullable(z.array(ToolPromptInfo$outboundSchema)).optional(),
+  agentsInfo: z.nullable(z.array(ToolAgentInfo$outboundSchema)).optional(),
+  lastUpdated: z.date().transform(v => v.toISOString()),
+  lastUpdatedBy: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    serviceId: "service_id",
+    lastUpdatedComments: "last_updated_comments",
+    serviceName: "service_name",
+    promptsInfo: "prompts_info",
+    agentsInfo: "agents_info",
+    lastUpdated: "last_updated",
+    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 DaoToolResponse$ {
+  /** @deprecated use `DaoToolResponse$inboundSchema` instead. */
+  export const inboundSchema = DaoToolResponse$inboundSchema;
+  /** @deprecated use `DaoToolResponse$outboundSchema` instead. */
+  export const outboundSchema = DaoToolResponse$outboundSchema;
+  /** @deprecated use `DaoToolResponse$Outbound` instead. */
+  export type Outbound = DaoToolResponse$Outbound;
+}
+
+export function daoToolResponseToJSON(
+  daoToolResponse: DaoToolResponse,
+): string {
+  return JSON.stringify(DaoToolResponse$outboundSchema.parse(daoToolResponse));
+}
+
+export function daoToolResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<DaoToolResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => DaoToolResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'DaoToolResponse' from JSON`,
+  );
+}

package/src/models/components/index.ts

@@ -51,6 +51,7 @@ export * from "./custommessageproperties.js";
 export * from "./custommessageresponse.js";
 export * from "./custommessagerule.js";
 export * from "./custommessageupdaterequest.js";
+export * from "./daotoolresponse.js";
 export * from "./dashboard.js";
 export * from "./dashboardproperties.js";
 export * from "./dashboardresponse.js";

package/src/models/components/promptcreaterequest.ts

@@ -46,6 +46,10 @@ export type PromptCreateRequest = {
    * Whether session end functionality is enabled for this prompt
    */
   sessionEndEnabled?: boolean | undefined;
+  /**
+   * ID of the optional session end tool associated with the prompt
+   */
+  sessionEndToolId?: number | null | undefined;
   /**
    * The comments for the most recent edit to the prompt
    */
@@ -69,12 +73,14 @@ export const PromptCreateRequest$inboundSchema: z.ZodType<
   tools: z.array(z.string()).optional(),
   llm_config: PromptLlmConfig$inboundSchema,
   session_end_enabled: z.boolean().default(false),
+  session_end_tool_id: z.nullable(z.number().int()).optional(),
   edit_comments: z.nullable(z.string()).optional(),
   include_default_tools: z.boolean().default(true),
 }).transform((v) => {
   return remap$(v, {
     "llm_config": "llmConfig",
     "session_end_enabled": "sessionEndEnabled",
+    "session_end_tool_id": "sessionEndToolId",
     "edit_comments": "editComments",
     "include_default_tools": "includeDefaultTools",
   });
@@ -89,6 +95,7 @@ export type PromptCreateRequest$Outbound = {
   tools?: Array<string> | undefined;
   llm_config: PromptLlmConfig$Outbound;
   session_end_enabled: boolean;
+  session_end_tool_id?: number | null | undefined;
   edit_comments?: string | null | undefined;
   include_default_tools: boolean;
 };
@@ -106,12 +113,14 @@ export const PromptCreateRequest$outboundSchema: z.ZodType<
   tools: z.array(z.string()).optional(),
   llmConfig: PromptLlmConfig$outboundSchema,
   sessionEndEnabled: z.boolean().default(false),
+  sessionEndToolId: z.nullable(z.number().int()).optional(),
   editComments: z.nullable(z.string()).optional(),
   includeDefaultTools: z.boolean().default(true),
 }).transform((v) => {
   return remap$(v, {
     llmConfig: "llm_config",
     sessionEndEnabled: "session_end_enabled",
+    sessionEndToolId: "session_end_tool_id",
     editComments: "edit_comments",
     includeDefaultTools: "include_default_tools",
   });

package/src/models/components/promptresponse.ts

@@ -7,6 +7,12 @@ 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 {
+  DaoToolResponse,
+  DaoToolResponse$inboundSchema,
+  DaoToolResponse$Outbound,
+  DaoToolResponse$outboundSchema,
+} from "./daotoolresponse.js";
 import {
   PromptLlmConfig,
   PromptLlmConfig$inboundSchema,
@@ -60,6 +66,10 @@ export type PromptResponse = {
    * Whether session end functionality is enabled for this prompt
    */
   sessionEndEnabled?: boolean | undefined;
+  /**
+   * ID of the optional session end tool associated with the prompt
+   */
+  sessionEndToolId?: number | null | undefined;
   /**
    * The comments for the most recent edit to the prompt
    */
@@ -76,6 +86,10 @@ export type PromptResponse = {
    * Email address of the user who most recently updated the prompt
    */
   lastUpdatedBy?: string | null | undefined;
+  /**
+   * The session end tool associated with the prompt
+   */
+  sessionEndTool?: DaoToolResponse | null | undefined;
   /**
    * The number of agents using the prompt
    */
@@ -103,10 +117,12 @@ export const PromptResponse$inboundSchema: z.ZodType<
   tools: z.array(z.string()).optional(),
   llm_config: PromptLlmConfig$inboundSchema,
   session_end_enabled: z.boolean().default(false),
+  session_end_tool_id: z.nullable(z.number().int()).optional(),
   edit_comments: z.nullable(z.string()).optional(),
   id: z.number().int(),
   last_updated: z.nullable(z.string()),
   last_updated_by: z.nullable(z.string()).optional(),
+  session_end_tool: z.nullable(DaoToolResponse$inboundSchema).optional(),
   agent_count: z.nullable(z.number().int()).optional(),
   version_number: z.nullable(z.number().int()).optional(),
   tools_full: z.nullable(z.array(ToolResponse$inboundSchema)).optional(),
@@ -114,9 +130,11 @@ export const PromptResponse$inboundSchema: z.ZodType<
   return remap$(v, {
     "llm_config": "llmConfig",
     "session_end_enabled": "sessionEndEnabled",
+    "session_end_tool_id": "sessionEndToolId",
     "edit_comments": "editComments",
     "last_updated": "lastUpdated",
     "last_updated_by": "lastUpdatedBy",
+    "session_end_tool": "sessionEndTool",
     "agent_count": "agentCount",
     "version_number": "versionNumber",
     "tools_full": "toolsFull",
@@ -132,10 +150,12 @@ export type PromptResponse$Outbound = {
   tools?: Array<string> | undefined;
   llm_config: PromptLlmConfig$Outbound;
   session_end_enabled: boolean;
+  session_end_tool_id?: number | null | undefined;
   edit_comments?: string | null | undefined;
   id: number;
   last_updated: string | null;
   last_updated_by?: string | null | undefined;
+  session_end_tool?: DaoToolResponse$Outbound | null | undefined;
   agent_count?: number | null | undefined;
   version_number?: number | null | undefined;
   tools_full?: Array<ToolResponse$Outbound> | null | undefined;
@@ -154,10 +174,12 @@ export const PromptResponse$outboundSchema: z.ZodType<
   tools: z.array(z.string()).optional(),
   llmConfig: PromptLlmConfig$outboundSchema,
   sessionEndEnabled: z.boolean().default(false),
+  sessionEndToolId: z.nullable(z.number().int()).optional(),
   editComments: z.nullable(z.string()).optional(),
   id: z.number().int(),
   lastUpdated: z.nullable(z.string()),
   lastUpdatedBy: z.nullable(z.string()).optional(),
+  sessionEndTool: z.nullable(DaoToolResponse$outboundSchema).optional(),
   agentCount: z.nullable(z.number().int()).optional(),
   versionNumber: z.nullable(z.number().int()).optional(),
   toolsFull: z.nullable(z.array(ToolResponse$outboundSchema)).optional(),
@@ -165,9 +187,11 @@ export const PromptResponse$outboundSchema: z.ZodType<
   return remap$(v, {
     llmConfig: "llm_config",
     sessionEndEnabled: "session_end_enabled",
+    sessionEndToolId: "session_end_tool_id",
     editComments: "edit_comments",
     lastUpdated: "last_updated",
     lastUpdatedBy: "last_updated_by",
+    sessionEndTool: "session_end_tool",
     agentCount: "agent_count",
     versionNumber: "version_number",
     toolsFull: "tools_full",

package/src/models/components/promptupdaterequest.ts

@@ -46,6 +46,10 @@ export type PromptUpdateRequest = {
    * Whether session end functionality is enabled for this prompt
    */
   sessionEndEnabled?: boolean | undefined;
+  /**
+   * ID of the optional session end tool associated with the prompt
+   */
+  sessionEndToolId?: number | null | undefined;
   /**
    * The comments for the most recent edit to the prompt
    */
@@ -73,6 +77,7 @@ export const PromptUpdateRequest$inboundSchema: z.ZodType<
   tools: z.array(z.string()).optional(),
   llm_config: PromptLlmConfig$inboundSchema,
   session_end_enabled: z.boolean().default(false),
+  session_end_tool_id: z.nullable(z.number().int()).optional(),
   edit_comments: z.nullable(z.string()).optional(),
   id: z.number().int(),
   include_default_tools: z.boolean().default(true),
@@ -80,6 +85,7 @@ export const PromptUpdateRequest$inboundSchema: z.ZodType<
   return remap$(v, {
     "llm_config": "llmConfig",
     "session_end_enabled": "sessionEndEnabled",
+    "session_end_tool_id": "sessionEndToolId",
     "edit_comments": "editComments",
     "include_default_tools": "includeDefaultTools",
   });
@@ -94,6 +100,7 @@ export type PromptUpdateRequest$Outbound = {
   tools?: Array<string> | undefined;
   llm_config: PromptLlmConfig$Outbound;
   session_end_enabled: boolean;
+  session_end_tool_id?: number | null | undefined;
   edit_comments?: string | null | undefined;
   id: number;
   include_default_tools: boolean;
@@ -112,6 +119,7 @@ export const PromptUpdateRequest$outboundSchema: z.ZodType<
   tools: z.array(z.string()).optional(),
   llmConfig: PromptLlmConfig$outboundSchema,
   sessionEndEnabled: z.boolean().default(false),
+  sessionEndToolId: z.nullable(z.number().int()).optional(),
   editComments: z.nullable(z.string()).optional(),
   id: z.number().int(),
   includeDefaultTools: z.boolean().default(true),
@@ -119,6 +127,7 @@ export const PromptUpdateRequest$outboundSchema: z.ZodType<
   return remap$(v, {
     llmConfig: "llm_config",
     sessionEndEnabled: "session_end_enabled",
+    sessionEndToolId: "session_end_tool_id",
     editComments: "edit_comments",
     includeDefaultTools: "include_default_tools",
   });