syllable-sdk 0.1.0-alpha.27 → 0.1.0-alpha.28

package/src/models/components/sdktooldefinition.ts

@@ -0,0 +1,298 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { safeParse } from "../../lib/schemas.js";
+import { ClosedEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  HttpEndpoint,
+  HttpEndpoint$inboundSchema,
+  HttpEndpoint$Outbound,
+  HttpEndpoint$outboundSchema,
+} from "./httpendpoint.js";
+import {
+  SDKInternalTool,
+  SDKInternalTool$inboundSchema,
+  SDKInternalTool$Outbound,
+  SDKInternalTool$outboundSchema,
+} from "./sdkinternaltool.js";
+import {
+  ToolParameterDefault,
+  ToolParameterDefault$inboundSchema,
+  ToolParameterDefault$Outbound,
+  ToolParameterDefault$outboundSchema,
+} from "./toolparameterdefault.js";
+
+export const Type = {
+  Action: "action",
+  Endpoint: "endpoint",
+  Context: "context",
+  Log: "log",
+} as const;
+export type Type = ClosedEnum<typeof Type>;
+
+export type One = {};
+
+/**
+ * The default values for the parameters of the function/tool call.
+ */
+export type Defaults = One | { [k: string]: ToolParameterDefault };
+
+export type Result = {};
+
+export type SDKToolDefinition = {
+  /**
+   * The action to take when GPT calls the tool.
+   */
+  type?: Type | null | undefined;
+  /**
+   * A tool definition to be used by the OpenAI API.
+   */
+  tool: SDKInternalTool;
+  /**
+   * The configuration for an HTTP API call.
+   */
+  endpoint?: HttpEndpoint | null | undefined;
+  /**
+   * The default values for the parameters of the function/tool call.
+   */
+  defaults?: One | { [k: string]: ToolParameterDefault } | null | undefined;
+  /**
+   * The optional result of the tool call. Only used for `context` tools.
+   */
+  result?: Result | null | undefined;
+};
+
+/** @internal */
+export const Type$inboundSchema: z.ZodNativeEnum<typeof Type> = z.nativeEnum(
+  Type,
+);
+
+/** @internal */
+export const Type$outboundSchema: z.ZodNativeEnum<typeof Type> =
+  Type$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace Type$ {
+  /** @deprecated use `Type$inboundSchema` instead. */
+  export const inboundSchema = Type$inboundSchema;
+  /** @deprecated use `Type$outboundSchema` instead. */
+  export const outboundSchema = Type$outboundSchema;
+}
+
+/** @internal */
+export const One$inboundSchema: z.ZodType<One, z.ZodTypeDef, unknown> = z
+  .object({});
+
+/** @internal */
+export type One$Outbound = {};
+
+/** @internal */
+export const One$outboundSchema: z.ZodType<One$Outbound, z.ZodTypeDef, One> = 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 One$ {
+  /** @deprecated use `One$inboundSchema` instead. */
+  export const inboundSchema = One$inboundSchema;
+  /** @deprecated use `One$outboundSchema` instead. */
+  export const outboundSchema = One$outboundSchema;
+  /** @deprecated use `One$Outbound` instead. */
+  export type Outbound = One$Outbound;
+}
+
+export function oneToJSON(one: One): string {
+  return JSON.stringify(One$outboundSchema.parse(one));
+}
+
+export function oneFromJSON(
+  jsonString: string,
+): SafeParseResult<One, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => One$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'One' from JSON`,
+  );
+}
+
+/** @internal */
+export const Defaults$inboundSchema: z.ZodType<
+  Defaults,
+  z.ZodTypeDef,
+  unknown
+> = z.union([
+  z.lazy(() => One$inboundSchema),
+  z.record(ToolParameterDefault$inboundSchema),
+]);
+
+/** @internal */
+export type Defaults$Outbound = One$Outbound | {
+  [k: string]: ToolParameterDefault$Outbound;
+};
+
+/** @internal */
+export const Defaults$outboundSchema: z.ZodType<
+  Defaults$Outbound,
+  z.ZodTypeDef,
+  Defaults
+> = z.union([
+  z.lazy(() => One$outboundSchema),
+  z.record(ToolParameterDefault$outboundSchema),
+]);
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace Defaults$ {
+  /** @deprecated use `Defaults$inboundSchema` instead. */
+  export const inboundSchema = Defaults$inboundSchema;
+  /** @deprecated use `Defaults$outboundSchema` instead. */
+  export const outboundSchema = Defaults$outboundSchema;
+  /** @deprecated use `Defaults$Outbound` instead. */
+  export type Outbound = Defaults$Outbound;
+}
+
+export function defaultsToJSON(defaults: Defaults): string {
+  return JSON.stringify(Defaults$outboundSchema.parse(defaults));
+}
+
+export function defaultsFromJSON(
+  jsonString: string,
+): SafeParseResult<Defaults, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Defaults$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Defaults' from JSON`,
+  );
+}
+
+/** @internal */
+export const Result$inboundSchema: z.ZodType<Result, z.ZodTypeDef, unknown> = z
+  .object({});
+
+/** @internal */
+export type Result$Outbound = {};
+
+/** @internal */
+export const Result$outboundSchema: z.ZodType<
+  Result$Outbound,
+  z.ZodTypeDef,
+  Result
+> = 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 Result$ {
+  /** @deprecated use `Result$inboundSchema` instead. */
+  export const inboundSchema = Result$inboundSchema;
+  /** @deprecated use `Result$outboundSchema` instead. */
+  export const outboundSchema = Result$outboundSchema;
+  /** @deprecated use `Result$Outbound` instead. */
+  export type Outbound = Result$Outbound;
+}
+
+export function resultToJSON(result: Result): string {
+  return JSON.stringify(Result$outboundSchema.parse(result));
+}
+
+export function resultFromJSON(
+  jsonString: string,
+): SafeParseResult<Result, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Result$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Result' from JSON`,
+  );
+}
+
+/** @internal */
+export const SDKToolDefinition$inboundSchema: z.ZodType<
+  SDKToolDefinition,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  type: z.nullable(Type$inboundSchema).optional(),
+  tool: SDKInternalTool$inboundSchema,
+  endpoint: z.nullable(HttpEndpoint$inboundSchema).optional(),
+  defaults: z.nullable(
+    z.union([
+      z.lazy(() => One$inboundSchema),
+      z.record(ToolParameterDefault$inboundSchema),
+    ]),
+  ).optional(),
+  result: z.nullable(z.lazy(() => Result$inboundSchema)).optional(),
+});
+
+/** @internal */
+export type SDKToolDefinition$Outbound = {
+  type?: string | null | undefined;
+  tool: SDKInternalTool$Outbound;
+  endpoint?: HttpEndpoint$Outbound | null | undefined;
+  defaults?:
+    | One$Outbound
+    | { [k: string]: ToolParameterDefault$Outbound }
+    | null
+    | undefined;
+  result?: Result$Outbound | null | undefined;
+};
+
+/** @internal */
+export const SDKToolDefinition$outboundSchema: z.ZodType<
+  SDKToolDefinition$Outbound,
+  z.ZodTypeDef,
+  SDKToolDefinition
+> = z.object({
+  type: z.nullable(Type$outboundSchema).optional(),
+  tool: SDKInternalTool$outboundSchema,
+  endpoint: z.nullable(HttpEndpoint$outboundSchema).optional(),
+  defaults: z.nullable(
+    z.union([
+      z.lazy(() => One$outboundSchema),
+      z.record(ToolParameterDefault$outboundSchema),
+    ]),
+  ).optional(),
+  result: z.nullable(z.lazy(() => Result$outboundSchema)).optional(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace SDKToolDefinition$ {
+  /** @deprecated use `SDKToolDefinition$inboundSchema` instead. */
+  export const inboundSchema = SDKToolDefinition$inboundSchema;
+  /** @deprecated use `SDKToolDefinition$outboundSchema` instead. */
+  export const outboundSchema = SDKToolDefinition$outboundSchema;
+  /** @deprecated use `SDKToolDefinition$Outbound` instead. */
+  export type Outbound = SDKToolDefinition$Outbound;
+}
+
+export function sdkToolDefinitionToJSON(
+  sdkToolDefinition: SDKToolDefinition,
+): string {
+  return JSON.stringify(
+    SDKToolDefinition$outboundSchema.parse(sdkToolDefinition),
+  );
+}
+
+export function sdkToolDefinitionFromJSON(
+  jsonString: string,
+): SafeParseResult<SDKToolDefinition, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SDKToolDefinition$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SDKToolDefinition' from JSON`,
+  );
+}

package/src/models/components/target.ts

@@ -22,9 +22,6 @@ export type Target = {
    * The Target
    */
   target: string;
-  /**
-   * The target mode
-   */
   targetMode: TargetModes;
   /**
    * The Channel ID

package/src/models/components/tool.ts

@@ -7,21 +7,19 @@ 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";
-
-/**
- * The definition of the tool
- */
-export type Definition = {};
+import {
+  SDKToolDefinition,
+  SDKToolDefinition$inboundSchema,
+  SDKToolDefinition$Outbound,
+  SDKToolDefinition$outboundSchema,
+} from "./sdktooldefinition.js";
 
 export type Tool = {
   /**
    * The name of the tool
    */
   name: string;
-  /**
-   * The definition of the tool
-   */
-  definition?: Definition | undefined;
+  definition: SDKToolDefinition;
   /**
    * The service this tool belongs to
    */
@@ -36,55 +34,11 @@ export type Tool = {
   serviceName?: string | null | undefined;
 };
 
-/** @internal */
-export const Definition$inboundSchema: z.ZodType<
-  Definition,
-  z.ZodTypeDef,
-  unknown
-> = z.object({});
-
-/** @internal */
-export type Definition$Outbound = {};
-
-/** @internal */
-export const Definition$outboundSchema: z.ZodType<
-  Definition$Outbound,
-  z.ZodTypeDef,
-  Definition
-> = 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 Definition$ {
-  /** @deprecated use `Definition$inboundSchema` instead. */
-  export const inboundSchema = Definition$inboundSchema;
-  /** @deprecated use `Definition$outboundSchema` instead. */
-  export const outboundSchema = Definition$outboundSchema;
-  /** @deprecated use `Definition$Outbound` instead. */
-  export type Outbound = Definition$Outbound;
-}
-
-export function definitionToJSON(definition: Definition): string {
-  return JSON.stringify(Definition$outboundSchema.parse(definition));
-}
-
-export function definitionFromJSON(
-  jsonString: string,
-): SafeParseResult<Definition, SDKValidationError> {
-  return safeParse(
-    jsonString,
-    (x) => Definition$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'Definition' from JSON`,
-  );
-}
-
 /** @internal */
 export const Tool$inboundSchema: z.ZodType<Tool, z.ZodTypeDef, unknown> = z
   .object({
     name: z.string(),
-    definition: z.lazy(() => Definition$inboundSchema).optional(),
+    definition: SDKToolDefinition$inboundSchema,
     service_id: z.number().int(),
     id: z.number().int(),
     service_name: z.nullable(z.string()).optional(),
@@ -98,7 +52,7 @@ export const Tool$inboundSchema: z.ZodType<Tool, z.ZodTypeDef, unknown> = z
 /** @internal */
 export type Tool$Outbound = {
   name: string;
-  definition?: Definition$Outbound | undefined;
+  definition: SDKToolDefinition$Outbound;
   service_id: number;
   id: number;
   service_name?: string | null | undefined;
@@ -108,7 +62,7 @@ export type Tool$Outbound = {
 export const Tool$outboundSchema: z.ZodType<Tool$Outbound, z.ZodTypeDef, Tool> =
   z.object({
     name: z.string(),
-    definition: z.lazy(() => Definition$outboundSchema).optional(),
+    definition: SDKToolDefinition$outboundSchema,
     serviceId: z.number().int(),
     id: z.number().int(),
     serviceName: z.nullable(z.string()).optional(),

package/src/models/components/toolcreate.ts

@@ -7,75 +7,25 @@ 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";
-
-/**
- * The definition of the tool
- */
-export type ToolCreateDefinition = {};
+import {
+  SDKToolDefinition,
+  SDKToolDefinition$inboundSchema,
+  SDKToolDefinition$Outbound,
+  SDKToolDefinition$outboundSchema,
+} from "./sdktooldefinition.js";
 
 export type ToolCreate = {
   /**
    * The name of the tool
    */
   name: string;
-  /**
-   * The definition of the tool
-   */
-  definition?: ToolCreateDefinition | undefined;
+  definition: SDKToolDefinition;
   /**
    * The service this tool belongs to
    */
   serviceId: number;
 };
 
-/** @internal */
-export const ToolCreateDefinition$inboundSchema: z.ZodType<
-  ToolCreateDefinition,
-  z.ZodTypeDef,
-  unknown
-> = z.object({});
-
-/** @internal */
-export type ToolCreateDefinition$Outbound = {};
-
-/** @internal */
-export const ToolCreateDefinition$outboundSchema: z.ZodType<
-  ToolCreateDefinition$Outbound,
-  z.ZodTypeDef,
-  ToolCreateDefinition
-> = 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 ToolCreateDefinition$ {
-  /** @deprecated use `ToolCreateDefinition$inboundSchema` instead. */
-  export const inboundSchema = ToolCreateDefinition$inboundSchema;
-  /** @deprecated use `ToolCreateDefinition$outboundSchema` instead. */
-  export const outboundSchema = ToolCreateDefinition$outboundSchema;
-  /** @deprecated use `ToolCreateDefinition$Outbound` instead. */
-  export type Outbound = ToolCreateDefinition$Outbound;
-}
-
-export function toolCreateDefinitionToJSON(
-  toolCreateDefinition: ToolCreateDefinition,
-): string {
-  return JSON.stringify(
-    ToolCreateDefinition$outboundSchema.parse(toolCreateDefinition),
-  );
-}
-
-export function toolCreateDefinitionFromJSON(
-  jsonString: string,
-): SafeParseResult<ToolCreateDefinition, SDKValidationError> {
-  return safeParse(
-    jsonString,
-    (x) => ToolCreateDefinition$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'ToolCreateDefinition' from JSON`,
-  );
-}
-
 /** @internal */
 export const ToolCreate$inboundSchema: z.ZodType<
   ToolCreate,
@@ -83,7 +33,7 @@ export const ToolCreate$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   name: z.string(),
-  definition: z.lazy(() => ToolCreateDefinition$inboundSchema).optional(),
+  definition: SDKToolDefinition$inboundSchema,
   service_id: z.number().int(),
 }).transform((v) => {
   return remap$(v, {
@@ -94,7 +44,7 @@ export const ToolCreate$inboundSchema: z.ZodType<
 /** @internal */
 export type ToolCreate$Outbound = {
   name: string;
-  definition?: ToolCreateDefinition$Outbound | undefined;
+  definition: SDKToolDefinition$Outbound;
   service_id: number;
 };
 
@@ -105,7 +55,7 @@ export const ToolCreate$outboundSchema: z.ZodType<
   ToolCreate
 > = z.object({
   name: z.string(),
-  definition: z.lazy(() => ToolCreateDefinition$outboundSchema).optional(),
+  definition: SDKToolDefinition$outboundSchema,
   serviceId: z.number().int(),
 }).transform((v) => {
   return remap$(v, {

package/src/models/components/toolparameterdefault.ts

@@ -0,0 +1,78 @@
+/*
+ * 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";
+import {
+  ToolParameterTransform,
+  ToolParameterTransform$inboundSchema,
+  ToolParameterTransform$Outbound,
+  ToolParameterTransform$outboundSchema,
+} from "./toolparametertransform.js";
+
+/**
+ * The default value for a parameter of the tool call.
+ */
+export type ToolParameterDefault = {
+  /**
+   * A transform to be applied to the value of a parameter.
+   */
+  transform: ToolParameterTransform;
+};
+
+/** @internal */
+export const ToolParameterDefault$inboundSchema: z.ZodType<
+  ToolParameterDefault,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  transform: ToolParameterTransform$inboundSchema,
+});
+
+/** @internal */
+export type ToolParameterDefault$Outbound = {
+  transform: ToolParameterTransform$Outbound;
+};
+
+/** @internal */
+export const ToolParameterDefault$outboundSchema: z.ZodType<
+  ToolParameterDefault$Outbound,
+  z.ZodTypeDef,
+  ToolParameterDefault
+> = z.object({
+  transform: ToolParameterTransform$outboundSchema,
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ToolParameterDefault$ {
+  /** @deprecated use `ToolParameterDefault$inboundSchema` instead. */
+  export const inboundSchema = ToolParameterDefault$inboundSchema;
+  /** @deprecated use `ToolParameterDefault$outboundSchema` instead. */
+  export const outboundSchema = ToolParameterDefault$outboundSchema;
+  /** @deprecated use `ToolParameterDefault$Outbound` instead. */
+  export type Outbound = ToolParameterDefault$Outbound;
+}
+
+export function toolParameterDefaultToJSON(
+  toolParameterDefault: ToolParameterDefault,
+): string {
+  return JSON.stringify(
+    ToolParameterDefault$outboundSchema.parse(toolParameterDefault),
+  );
+}
+
+export function toolParameterDefaultFromJSON(
+  jsonString: string,
+): SafeParseResult<ToolParameterDefault, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ToolParameterDefault$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ToolParameterDefault' from JSON`,
+  );
+}