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

package/src/models/components/listresponsesessionlabel.ts

@@ -4,6 +4,9 @@
 
 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 {
   SessionLabel,
   SessionLabel$inboundSchema,
@@ -78,3 +81,21 @@ export namespace ListResponseSessionLabel$ {
   /** @deprecated use `ListResponseSessionLabel$Outbound` instead. */
   export type Outbound = ListResponseSessionLabel$Outbound;
 }
+
+export function listResponseSessionLabelToJSON(
+  listResponseSessionLabel: ListResponseSessionLabel,
+): string {
+  return JSON.stringify(
+    ListResponseSessionLabel$outboundSchema.parse(listResponseSessionLabel),
+  );
+}
+
+export function listResponseSessionLabelFromJSON(
+  jsonString: string,
+): SafeParseResult<ListResponseSessionLabel, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListResponseSessionLabel$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListResponseSessionLabel' from JSON`,
+  );
+}

package/src/models/components/listresponsetoolresponse.ts

@@ -0,0 +1,101 @@
+/*
+ * 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 {
+  ToolResponse,
+  ToolResponse$inboundSchema,
+  ToolResponse$Outbound,
+  ToolResponse$outboundSchema,
+} from "./toolresponse.js";
+
+export type ListResponseToolResponse = {
+  items: Array<ToolResponse>;
+  page: number;
+  pageSize: number;
+  totalPages?: number | null | undefined;
+  totalCount?: number | null | undefined;
+};
+
+/** @internal */
+export const ListResponseToolResponse$inboundSchema: z.ZodType<
+  ListResponseToolResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  items: z.array(ToolResponse$inboundSchema),
+  page: z.number().int(),
+  page_size: z.number().int(),
+  total_pages: z.nullable(z.number().int()).optional(),
+  total_count: z.nullable(z.number().int()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "page_size": "pageSize",
+    "total_pages": "totalPages",
+    "total_count": "totalCount",
+  });
+});
+
+/** @internal */
+export type ListResponseToolResponse$Outbound = {
+  items: Array<ToolResponse$Outbound>;
+  page: number;
+  page_size: number;
+  total_pages?: number | null | undefined;
+  total_count?: number | null | undefined;
+};
+
+/** @internal */
+export const ListResponseToolResponse$outboundSchema: z.ZodType<
+  ListResponseToolResponse$Outbound,
+  z.ZodTypeDef,
+  ListResponseToolResponse
+> = z.object({
+  items: z.array(ToolResponse$outboundSchema),
+  page: z.number().int(),
+  pageSize: z.number().int(),
+  totalPages: z.nullable(z.number().int()).optional(),
+  totalCount: z.nullable(z.number().int()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    pageSize: "page_size",
+    totalPages: "total_pages",
+    totalCount: "total_count",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ListResponseToolResponse$ {
+  /** @deprecated use `ListResponseToolResponse$inboundSchema` instead. */
+  export const inboundSchema = ListResponseToolResponse$inboundSchema;
+  /** @deprecated use `ListResponseToolResponse$outboundSchema` instead. */
+  export const outboundSchema = ListResponseToolResponse$outboundSchema;
+  /** @deprecated use `ListResponseToolResponse$Outbound` instead. */
+  export type Outbound = ListResponseToolResponse$Outbound;
+}
+
+export function listResponseToolResponseToJSON(
+  listResponseToolResponse: ListResponseToolResponse,
+): string {
+  return JSON.stringify(
+    ListResponseToolResponse$outboundSchema.parse(listResponseToolResponse),
+  );
+}
+
+export function listResponseToolResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<ListResponseToolResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListResponseToolResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListResponseToolResponse' from JSON`,
+  );
+}

package/src/models/components/promptcreaterequest.ts

@@ -0,0 +1,116 @@
+/*
+ * 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 {
+  PromptLlmConfig,
+  PromptLlmConfig$inboundSchema,
+  PromptLlmConfig$Outbound,
+  PromptLlmConfig$outboundSchema,
+} from "./promptllmconfig.js";
+
+export type PromptCreateRequest = {
+  /**
+   * The prompt name
+   */
+  name: string;
+  /**
+   * The description of the prompt
+   */
+  description?: string | null | undefined;
+  /**
+   * The type of the prompt
+   */
+  type: string;
+  /**
+   * The prompt text
+   */
+  context?: string | null | undefined;
+  /**
+   * Names of tools to which the prompt has access
+   */
+  tools?: Array<string> | undefined;
+  llmConfig: PromptLlmConfig;
+};
+
+/** @internal */
+export const PromptCreateRequest$inboundSchema: z.ZodType<
+  PromptCreateRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  name: z.string(),
+  description: z.nullable(z.string()).optional(),
+  type: z.string(),
+  context: z.nullable(z.string()).optional(),
+  tools: z.array(z.string()).optional(),
+  llm_config: PromptLlmConfig$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "llm_config": "llmConfig",
+  });
+});
+
+/** @internal */
+export type PromptCreateRequest$Outbound = {
+  name: string;
+  description?: string | null | undefined;
+  type: string;
+  context?: string | null | undefined;
+  tools?: Array<string> | undefined;
+  llm_config: PromptLlmConfig$Outbound;
+};
+
+/** @internal */
+export const PromptCreateRequest$outboundSchema: z.ZodType<
+  PromptCreateRequest$Outbound,
+  z.ZodTypeDef,
+  PromptCreateRequest
+> = z.object({
+  name: z.string(),
+  description: z.nullable(z.string()).optional(),
+  type: z.string(),
+  context: z.nullable(z.string()).optional(),
+  tools: z.array(z.string()).optional(),
+  llmConfig: PromptLlmConfig$outboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    llmConfig: "llm_config",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace PromptCreateRequest$ {
+  /** @deprecated use `PromptCreateRequest$inboundSchema` instead. */
+  export const inboundSchema = PromptCreateRequest$inboundSchema;
+  /** @deprecated use `PromptCreateRequest$outboundSchema` instead. */
+  export const outboundSchema = PromptCreateRequest$outboundSchema;
+  /** @deprecated use `PromptCreateRequest$Outbound` instead. */
+  export type Outbound = PromptCreateRequest$Outbound;
+}
+
+export function promptCreateRequestToJSON(
+  promptCreateRequest: PromptCreateRequest,
+): string {
+  return JSON.stringify(
+    PromptCreateRequest$outboundSchema.parse(promptCreateRequest),
+  );
+}
+
+export function promptCreateRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<PromptCreateRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PromptCreateRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PromptCreateRequest' from JSON`,
+  );
+}

package/src/models/components/prompthistory.ts

@@ -0,0 +1,136 @@
+/*
+ * 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";
+
+/**
+ * Record of a change to a prompt. Values reflect post-change state.
+ */
+export type PromptHistory = {
+  /**
+   * Timestamp of the change
+   */
+  timestamp: Date;
+  /**
+   * ID of the prompt
+   */
+  promptId: string;
+  /**
+   * Text of the prompt
+   */
+  promptText: string;
+  /**
+   * Description of the prompt
+   */
+  promptDescription?: string | null | undefined;
+  /**
+   * Name of the prompt
+   */
+  promptName: string;
+  /**
+   * String representation of LLM config for the prompt
+   */
+  llmConfig?: string | null | undefined;
+  /**
+   * Comments describing the change
+   */
+  comments?: string | null | undefined;
+  /**
+   * Email address of the user who made the change
+   */
+  userEmail: string;
+};
+
+/** @internal */
+export const PromptHistory$inboundSchema: z.ZodType<
+  PromptHistory,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  timestamp: z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  prompt_id: z.string(),
+  prompt_text: z.string(),
+  prompt_description: z.nullable(z.string()).optional(),
+  prompt_name: z.string(),
+  llm_config: z.nullable(z.string()).optional(),
+  comments: z.nullable(z.string()).optional(),
+  user_email: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "prompt_id": "promptId",
+    "prompt_text": "promptText",
+    "prompt_description": "promptDescription",
+    "prompt_name": "promptName",
+    "llm_config": "llmConfig",
+    "user_email": "userEmail",
+  });
+});
+
+/** @internal */
+export type PromptHistory$Outbound = {
+  timestamp: string;
+  prompt_id: string;
+  prompt_text: string;
+  prompt_description?: string | null | undefined;
+  prompt_name: string;
+  llm_config?: string | null | undefined;
+  comments?: string | null | undefined;
+  user_email: string;
+};
+
+/** @internal */
+export const PromptHistory$outboundSchema: z.ZodType<
+  PromptHistory$Outbound,
+  z.ZodTypeDef,
+  PromptHistory
+> = z.object({
+  timestamp: z.date().transform(v => v.toISOString()),
+  promptId: z.string(),
+  promptText: z.string(),
+  promptDescription: z.nullable(z.string()).optional(),
+  promptName: z.string(),
+  llmConfig: z.nullable(z.string()).optional(),
+  comments: z.nullable(z.string()).optional(),
+  userEmail: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    promptId: "prompt_id",
+    promptText: "prompt_text",
+    promptDescription: "prompt_description",
+    promptName: "prompt_name",
+    llmConfig: "llm_config",
+    userEmail: "user_email",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace PromptHistory$ {
+  /** @deprecated use `PromptHistory$inboundSchema` instead. */
+  export const inboundSchema = PromptHistory$inboundSchema;
+  /** @deprecated use `PromptHistory$outboundSchema` instead. */
+  export const outboundSchema = PromptHistory$outboundSchema;
+  /** @deprecated use `PromptHistory$Outbound` instead. */
+  export type Outbound = PromptHistory$Outbound;
+}
+
+export function promptHistoryToJSON(promptHistory: PromptHistory): string {
+  return JSON.stringify(PromptHistory$outboundSchema.parse(promptHistory));
+}
+
+export function promptHistoryFromJSON(
+  jsonString: string,
+): SafeParseResult<PromptHistory, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PromptHistory$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PromptHistory' from JSON`,
+  );
+}

package/src/models/components/promptllmconfig.ts

@@ -0,0 +1,102 @@
+/*
+ * 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 {
+  PromptLlmProvider,
+  PromptLlmProvider$inboundSchema,
+  PromptLlmProvider$outboundSchema,
+} from "./promptllmprovider.js";
+
+export type PromptLlmConfig = {
+  /**
+   * LLM API provider.
+   */
+  provider?: PromptLlmProvider | undefined;
+  /**
+   * Name of the model. Must match the deployment name in Azure AI Studio.
+   */
+  model?: string | undefined;
+  /**
+   * Optional model version.
+   */
+  version?: string | null | undefined;
+  /**
+   * Version of the API. (Currently only used for Azure OpenAI.)
+   */
+  apiVersion?: string | null | undefined;
+};
+
+/** @internal */
+export const PromptLlmConfig$inboundSchema: z.ZodType<
+  PromptLlmConfig,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  provider: PromptLlmProvider$inboundSchema.optional(),
+  model: z.string().default("gpt-4o"),
+  version: z.nullable(z.string()).optional(),
+  api_version: z.nullable(z.string()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "api_version": "apiVersion",
+  });
+});
+
+/** @internal */
+export type PromptLlmConfig$Outbound = {
+  provider?: string | undefined;
+  model: string;
+  version?: string | null | undefined;
+  api_version?: string | null | undefined;
+};
+
+/** @internal */
+export const PromptLlmConfig$outboundSchema: z.ZodType<
+  PromptLlmConfig$Outbound,
+  z.ZodTypeDef,
+  PromptLlmConfig
+> = z.object({
+  provider: PromptLlmProvider$outboundSchema.optional(),
+  model: z.string().default("gpt-4o"),
+  version: z.nullable(z.string()).optional(),
+  apiVersion: z.nullable(z.string()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    apiVersion: "api_version",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace PromptLlmConfig$ {
+  /** @deprecated use `PromptLlmConfig$inboundSchema` instead. */
+  export const inboundSchema = PromptLlmConfig$inboundSchema;
+  /** @deprecated use `PromptLlmConfig$outboundSchema` instead. */
+  export const outboundSchema = PromptLlmConfig$outboundSchema;
+  /** @deprecated use `PromptLlmConfig$Outbound` instead. */
+  export type Outbound = PromptLlmConfig$Outbound;
+}
+
+export function promptLlmConfigToJSON(
+  promptLlmConfig: PromptLlmConfig,
+): string {
+  return JSON.stringify(PromptLlmConfig$outboundSchema.parse(promptLlmConfig));
+}
+
+export function promptLlmConfigFromJSON(
+  jsonString: string,
+): SafeParseResult<PromptLlmConfig, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PromptLlmConfig$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PromptLlmConfig' from JSON`,
+  );
+}

package/src/models/components/promptllmprovider.ts

@@ -0,0 +1,39 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { ClosedEnum } from "../../types/enums.js";
+
+/**
+ * LLM API provider.
+ */
+export const PromptLlmProvider = {
+  AzureOpenai: "azure_openai",
+  Openai: "openai",
+} as const;
+/**
+ * LLM API provider.
+ */
+export type PromptLlmProvider = ClosedEnum<typeof PromptLlmProvider>;
+
+/** @internal */
+export const PromptLlmProvider$inboundSchema: z.ZodNativeEnum<
+  typeof PromptLlmProvider
+> = z.nativeEnum(PromptLlmProvider);
+
+/** @internal */
+export const PromptLlmProvider$outboundSchema: z.ZodNativeEnum<
+  typeof PromptLlmProvider
+> = PromptLlmProvider$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace PromptLlmProvider$ {
+  /** @deprecated use `PromptLlmProvider$inboundSchema` instead. */
+  export const inboundSchema = PromptLlmProvider$inboundSchema;
+  /** @deprecated use `PromptLlmProvider$outboundSchema` instead. */
+  export const outboundSchema = PromptLlmProvider$outboundSchema;
+}

package/src/models/components/promptproperties.ts

@@ -8,9 +8,14 @@ import { ClosedEnum } from "../../types/enums.js";
 export const PromptProperties = {
   Id: "id",
   Name: "name",
+  Description: "description",
+  NameDescription: "name_description",
   Context: "context",
   Tools: "tools",
   LlmConfig: "llm_config",
+  LastUpdated: "last_updated",
+  LastUpdatedBy: "last_updated_by",
+  AgentCount: "agent_count",
 } as const;
 export type PromptProperties = ClosedEnum<typeof PromptProperties>;
 

package/src/models/components/promptresponse.ts

@@ -0,0 +1,162 @@
+/*
+ * 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 {
+  PromptLlmConfig,
+  PromptLlmConfig$inboundSchema,
+  PromptLlmConfig$Outbound,
+  PromptLlmConfig$outboundSchema,
+} from "./promptllmconfig.js";
+
+/**
+ * A prompt defines the behavior of an agent by delivering instructions to the LLM about how the
+ *
+ * @remarks
+ * agent should behave. A prompt can be linked to one or more agents. A prompt can also be linked to
+ * tools to allow an agent using it to use those tools.
+ */
+export type PromptResponse = {
+  /**
+   * The prompt name
+   */
+  name: string;
+  /**
+   * The description of the prompt
+   */
+  description?: string | null | undefined;
+  /**
+   * The type of the prompt
+   */
+  type: string;
+  /**
+   * The prompt text
+   */
+  context?: string | null | undefined;
+  /**
+   * Names of the tools to which the prompt has access
+   */
+  tools?: Array<string> | undefined;
+  llmConfig: PromptLlmConfig;
+  /**
+   * The prompt ID
+   */
+  id: number;
+  /**
+   * The comments for the most recent edit to the prompt
+   */
+  editComments?: string | null | undefined;
+  /**
+   * The last updated date of the prompt
+   */
+  lastUpdated: string | null;
+  /**
+   * Email address of the user who most recently updated the prompt
+   */
+  lastUpdatedBy?: string | null | undefined;
+  /**
+   * The number of agents using the prompt
+   */
+  agentCount?: number | null | undefined;
+};
+
+/** @internal */
+export const PromptResponse$inboundSchema: z.ZodType<
+  PromptResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  name: z.string(),
+  description: z.nullable(z.string()).optional(),
+  type: z.string(),
+  context: z.nullable(z.string()).optional(),
+  tools: z.array(z.string()).optional(),
+  llm_config: PromptLlmConfig$inboundSchema,
+  id: z.number().int(),
+  edit_comments: z.nullable(z.string()).optional(),
+  last_updated: z.nullable(z.string()),
+  last_updated_by: z.nullable(z.string()).optional(),
+  agent_count: z.nullable(z.number().int()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "llm_config": "llmConfig",
+    "edit_comments": "editComments",
+    "last_updated": "lastUpdated",
+    "last_updated_by": "lastUpdatedBy",
+    "agent_count": "agentCount",
+  });
+});
+
+/** @internal */
+export type PromptResponse$Outbound = {
+  name: string;
+  description?: string | null | undefined;
+  type: string;
+  context?: string | null | undefined;
+  tools?: Array<string> | undefined;
+  llm_config: PromptLlmConfig$Outbound;
+  id: number;
+  edit_comments?: string | null | undefined;
+  last_updated: string | null;
+  last_updated_by?: string | null | undefined;
+  agent_count?: number | null | undefined;
+};
+
+/** @internal */
+export const PromptResponse$outboundSchema: z.ZodType<
+  PromptResponse$Outbound,
+  z.ZodTypeDef,
+  PromptResponse
+> = z.object({
+  name: z.string(),
+  description: z.nullable(z.string()).optional(),
+  type: z.string(),
+  context: z.nullable(z.string()).optional(),
+  tools: z.array(z.string()).optional(),
+  llmConfig: PromptLlmConfig$outboundSchema,
+  id: z.number().int(),
+  editComments: z.nullable(z.string()).optional(),
+  lastUpdated: z.nullable(z.string()),
+  lastUpdatedBy: z.nullable(z.string()).optional(),
+  agentCount: z.nullable(z.number().int()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    llmConfig: "llm_config",
+    editComments: "edit_comments",
+    lastUpdated: "last_updated",
+    lastUpdatedBy: "last_updated_by",
+    agentCount: "agent_count",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace PromptResponse$ {
+  /** @deprecated use `PromptResponse$inboundSchema` instead. */
+  export const inboundSchema = PromptResponse$inboundSchema;
+  /** @deprecated use `PromptResponse$outboundSchema` instead. */
+  export const outboundSchema = PromptResponse$outboundSchema;
+  /** @deprecated use `PromptResponse$Outbound` instead. */
+  export type Outbound = PromptResponse$Outbound;
+}
+
+export function promptResponseToJSON(promptResponse: PromptResponse): string {
+  return JSON.stringify(PromptResponse$outboundSchema.parse(promptResponse));
+}
+
+export function promptResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<PromptResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PromptResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PromptResponse' from JSON`,
+  );
+}