syllable-sdk 0.1.0-alpha.42 → 0.1.0-alpha.44

package/src/models/components/statictoolparametertype.ts

@@ -0,0 +1,43 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { ClosedEnum } from "../../types/enums.js";
+
+/**
+ * The expected type for a static tool parameter.
+ */
+export const StaticToolParameterType = {
+  String: "string",
+  Int: "int",
+  Boolean: "boolean",
+  DataSourceList: "data_source_list",
+} as const;
+/**
+ * The expected type for a static tool parameter.
+ */
+export type StaticToolParameterType = ClosedEnum<
+  typeof StaticToolParameterType
+>;
+
+/** @internal */
+export const StaticToolParameterType$inboundSchema: z.ZodNativeEnum<
+  typeof StaticToolParameterType
+> = z.nativeEnum(StaticToolParameterType);
+
+/** @internal */
+export const StaticToolParameterType$outboundSchema: z.ZodNativeEnum<
+  typeof StaticToolParameterType
+> = StaticToolParameterType$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace StaticToolParameterType$ {
+  /** @deprecated use `StaticToolParameterType$inboundSchema` instead. */
+  export const inboundSchema = StaticToolParameterType$inboundSchema;
+  /** @deprecated use `StaticToolParameterType$outboundSchema` instead. */
+  export const outboundSchema = StaticToolParameterType$outboundSchema;
+}

package/src/models/components/tooldefinition.ts

@@ -3,6 +3,7 @@
  */
 
 import * as z from "zod";
+import { remap as remap$ } from "../../lib/primitives.js";
 import { safeParse } from "../../lib/schemas.js";
 import { ClosedEnum } from "../../types/enums.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
@@ -13,6 +14,12 @@ import {
   InternalTool$Outbound,
   InternalTool$outboundSchema,
 } from "./internaltool.js";
+import {
+  StaticToolParameter,
+  StaticToolParameter$inboundSchema,
+  StaticToolParameter$Outbound,
+  StaticToolParameter$outboundSchema,
+} from "./statictoolparameter.js";
 import {
   ToolHttpEndpoint,
   ToolHttpEndpoint$inboundSchema,
@@ -59,6 +66,10 @@ export type ToolDefinition = {
    * The default values for the parameters of the function/tool call.
    */
   defaults?: any | { [k: string]: ToolParameterDefault } | null | undefined;
+  /**
+   * Parameters for the tool whose values should be set at config time (i.e., not provided by the LLM).
+   */
+  staticParameters?: Array<StaticToolParameter> | null | undefined;
   /**
    * The optional result of the tool call. Only used for `context` tools.
    */
@@ -143,7 +154,13 @@ export const ToolDefinition$inboundSchema: z.ZodType<
   defaults: z.nullable(
     z.union([z.any(), z.record(ToolParameterDefault$inboundSchema)]),
   ).optional(),
+  static_parameters: z.nullable(z.array(StaticToolParameter$inboundSchema))
+    .optional(),
   result: z.nullable(z.any()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "static_parameters": "staticParameters",
+  });
 });
 
 /** @internal */
@@ -156,6 +173,7 @@ export type ToolDefinition$Outbound = {
     | { [k: string]: ToolParameterDefault$Outbound }
     | null
     | undefined;
+  static_parameters?: Array<StaticToolParameter$Outbound> | null | undefined;
   result?: any | null | undefined;
 };
 
@@ -171,7 +189,13 @@ export const ToolDefinition$outboundSchema: z.ZodType<
   defaults: z.nullable(
     z.union([z.any(), z.record(ToolParameterDefault$outboundSchema)]),
   ).optional(),
+  staticParameters: z.nullable(z.array(StaticToolParameter$outboundSchema))
+    .optional(),
   result: z.nullable(z.any()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    staticParameters: "static_parameters",
+  });
 });
 
 /**

package/src/models/components/tooldetailresponse.ts

@@ -13,6 +13,12 @@ import {
   ToolDefinition$Outbound,
   ToolDefinition$outboundSchema,
 } from "./tooldefinition.js";
+import {
+  ToolPromptInfo,
+  ToolPromptInfo$inboundSchema,
+  ToolPromptInfo$Outbound,
+  ToolPromptInfo$outboundSchema,
+} from "./toolpromptinfo.js";
 
 /**
  * A tool is a function that an agent can call to perform actions like accessing databases,
@@ -46,6 +52,10 @@ export type ToolDetailResponse = {
    * 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;
   /**
    * The timestamp of the most recent update to the service
    */
@@ -72,6 +82,7 @@ export const ToolDetailResponse$inboundSchema: z.ZodType<
   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(),
   last_updated: z.string().datetime({ offset: true }).transform(v =>
     new Date(v)
   ),
@@ -82,6 +93,7 @@ export const ToolDetailResponse$inboundSchema: z.ZodType<
     "service_id": "serviceId",
     "last_updated_comments": "lastUpdatedComments",
     "service_name": "serviceName",
+    "prompts_info": "promptsInfo",
     "last_updated": "lastUpdated",
     "last_updated_by": "lastUpdatedBy",
   });
@@ -95,6 +107,7 @@ export type ToolDetailResponse$Outbound = {
   id: number;
   last_updated_comments?: string | null | undefined;
   service_name?: string | null | undefined;
+  prompts_info?: Array<ToolPromptInfo$Outbound> | null | undefined;
   last_updated: string;
   last_updated_by: string;
   fields: Array<string>;
@@ -112,6 +125,7 @@ export const ToolDetailResponse$outboundSchema: z.ZodType<
   id: z.number().int(),
   lastUpdatedComments: z.nullable(z.string()).optional(),
   serviceName: z.nullable(z.string()).optional(),
+  promptsInfo: z.nullable(z.array(ToolPromptInfo$outboundSchema)).optional(),
   lastUpdated: z.date().transform(v => v.toISOString()),
   lastUpdatedBy: z.string(),
   fields: z.array(z.string()),
@@ -120,6 +134,7 @@ export const ToolDetailResponse$outboundSchema: z.ZodType<
     serviceId: "service_id",
     lastUpdatedComments: "last_updated_comments",
     serviceName: "service_name",
+    promptsInfo: "prompts_info",
     lastUpdated: "last_updated",
     lastUpdatedBy: "last_updated_by",
   });

package/src/models/components/toolpromptinfo.ts

@@ -0,0 +1,75 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+/**
+ * Information about a prompt linked to a tool.
+ */
+export type ToolPromptInfo = {
+  /**
+   * The ID of the prompt
+   */
+  id: number;
+  /**
+   * The name of the prompt
+   */
+  name: string;
+};
+
+/** @internal */
+export const ToolPromptInfo$inboundSchema: z.ZodType<
+  ToolPromptInfo,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: z.number().int(),
+  name: z.string(),
+});
+
+/** @internal */
+export type ToolPromptInfo$Outbound = {
+  id: number;
+  name: string;
+};
+
+/** @internal */
+export const ToolPromptInfo$outboundSchema: z.ZodType<
+  ToolPromptInfo$Outbound,
+  z.ZodTypeDef,
+  ToolPromptInfo
+> = z.object({
+  id: z.number().int(),
+  name: z.string(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ToolPromptInfo$ {
+  /** @deprecated use `ToolPromptInfo$inboundSchema` instead. */
+  export const inboundSchema = ToolPromptInfo$inboundSchema;
+  /** @deprecated use `ToolPromptInfo$outboundSchema` instead. */
+  export const outboundSchema = ToolPromptInfo$outboundSchema;
+  /** @deprecated use `ToolPromptInfo$Outbound` instead. */
+  export type Outbound = ToolPromptInfo$Outbound;
+}
+
+export function toolPromptInfoToJSON(toolPromptInfo: ToolPromptInfo): string {
+  return JSON.stringify(ToolPromptInfo$outboundSchema.parse(toolPromptInfo));
+}
+
+export function toolPromptInfoFromJSON(
+  jsonString: string,
+): SafeParseResult<ToolPromptInfo, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ToolPromptInfo$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ToolPromptInfo' from JSON`,
+  );
+}

package/src/models/components/toolresponse.ts

@@ -13,6 +13,12 @@ import {
   ToolDefinition$Outbound,
   ToolDefinition$outboundSchema,
 } from "./tooldefinition.js";
+import {
+  ToolPromptInfo,
+  ToolPromptInfo$inboundSchema,
+  ToolPromptInfo$Outbound,
+  ToolPromptInfo$outboundSchema,
+} from "./toolpromptinfo.js";
 
 /**
  * A tool is a function that an agent can call to perform actions like accessing databases,
@@ -46,6 +52,10 @@ export type ToolResponse = {
    * 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;
   /**
    * The timestamp of the most recent update to the service
    */
@@ -68,6 +78,7 @@ export const ToolResponse$inboundSchema: z.ZodType<
   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(),
   last_updated: z.string().datetime({ offset: true }).transform(v =>
     new Date(v)
   ),
@@ -77,6 +88,7 @@ export const ToolResponse$inboundSchema: z.ZodType<
     "service_id": "serviceId",
     "last_updated_comments": "lastUpdatedComments",
     "service_name": "serviceName",
+    "prompts_info": "promptsInfo",
     "last_updated": "lastUpdated",
     "last_updated_by": "lastUpdatedBy",
   });
@@ -90,6 +102,7 @@ export type ToolResponse$Outbound = {
   id: number;
   last_updated_comments?: string | null | undefined;
   service_name?: string | null | undefined;
+  prompts_info?: Array<ToolPromptInfo$Outbound> | null | undefined;
   last_updated: string;
   last_updated_by: string;
 };
@@ -106,6 +119,7 @@ export const ToolResponse$outboundSchema: z.ZodType<
   id: z.number().int(),
   lastUpdatedComments: z.nullable(z.string()).optional(),
   serviceName: z.nullable(z.string()).optional(),
+  promptsInfo: z.nullable(z.array(ToolPromptInfo$outboundSchema)).optional(),
   lastUpdated: z.date().transform(v => v.toISOString()),
   lastUpdatedBy: z.string(),
 }).transform((v) => {
@@ -113,6 +127,7 @@ export const ToolResponse$outboundSchema: z.ZodType<
     serviceId: "service_id",
     lastUpdatedComments: "last_updated_comments",
     serviceName: "service_name",
+    promptsInfo: "prompts_info",
     lastUpdated: "last_updated",
     lastUpdatedBy: "last_updated_by",
   });