syllable-sdk 0.1.0-alpha.5 → 0.1.0-alpha.50

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/{llmconfig.ts → promptllmconfig.ts}

@@ -8,16 +8,16 @@ import { safeParse } from "../../lib/schemas.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 import {
-  Provider,
-  Provider$inboundSchema,
-  Provider$outboundSchema,
-} from "./provider.js";
+  PromptLlmProvider,
+  PromptLlmProvider$inboundSchema,
+  PromptLlmProvider$outboundSchema,
+} from "./promptllmprovider.js";
 
-export type LlmConfig = {
+export type PromptLlmConfig = {
   /**
    * LLM API provider.
    */
-  provider?: Provider | undefined;
+  provider?: PromptLlmProvider | undefined;
   /**
    * Name of the model. Must match the deployment name in Azure AI Studio.
    */
@@ -33,12 +33,12 @@ export type LlmConfig = {
 };
 
 /** @internal */
-export const LlmConfig$inboundSchema: z.ZodType<
-  LlmConfig,
+export const PromptLlmConfig$inboundSchema: z.ZodType<
+  PromptLlmConfig,
   z.ZodTypeDef,
   unknown
 > = z.object({
-  provider: Provider$inboundSchema.optional(),
+  provider: PromptLlmProvider$inboundSchema.optional(),
   model: z.string().default("gpt-4o"),
   version: z.nullable(z.string()).optional(),
   api_version: z.nullable(z.string()).optional(),
@@ -49,7 +49,7 @@ export const LlmConfig$inboundSchema: z.ZodType<
 });
 
 /** @internal */
-export type LlmConfig$Outbound = {
+export type PromptLlmConfig$Outbound = {
   provider?: string | undefined;
   model: string;
   version?: string | null | undefined;
@@ -57,12 +57,12 @@ export type LlmConfig$Outbound = {
 };
 
 /** @internal */
-export const LlmConfig$outboundSchema: z.ZodType<
-  LlmConfig$Outbound,
+export const PromptLlmConfig$outboundSchema: z.ZodType<
+  PromptLlmConfig$Outbound,
   z.ZodTypeDef,
-  LlmConfig
+  PromptLlmConfig
 > = z.object({
-  provider: Provider$outboundSchema.optional(),
+  provider: PromptLlmProvider$outboundSchema.optional(),
   model: z.string().default("gpt-4o"),
   version: z.nullable(z.string()).optional(),
   apiVersion: z.nullable(z.string()).optional(),
@@ -76,25 +76,27 @@ export const LlmConfig$outboundSchema: z.ZodType<
  * @internal
  * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
  */
-export namespace LlmConfig$ {
-  /** @deprecated use `LlmConfig$inboundSchema` instead. */
-  export const inboundSchema = LlmConfig$inboundSchema;
-  /** @deprecated use `LlmConfig$outboundSchema` instead. */
-  export const outboundSchema = LlmConfig$outboundSchema;
-  /** @deprecated use `LlmConfig$Outbound` instead. */
-  export type Outbound = LlmConfig$Outbound;
+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 llmConfigToJSON(llmConfig: LlmConfig): string {
-  return JSON.stringify(LlmConfig$outboundSchema.parse(llmConfig));
+export function promptLlmConfigToJSON(
+  promptLlmConfig: PromptLlmConfig,
+): string {
+  return JSON.stringify(PromptLlmConfig$outboundSchema.parse(promptLlmConfig));
 }
 
-export function llmConfigFromJSON(
+export function promptLlmConfigFromJSON(
   jsonString: string,
-): SafeParseResult<LlmConfig, SDKValidationError> {
+): SafeParseResult<PromptLlmConfig, SDKValidationError> {
   return safeParse(
     jsonString,
-    (x) => LlmConfig$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'LlmConfig' from JSON`,
+    (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`,
+  );
+}

package/src/models/components/promptupdaterequest.ts

@@ -0,0 +1,141 @@
+/*
+ * 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 PromptUpdateRequest = {
+  /**
+   * 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;
+  /**
+   * The prompt ID
+   */
+  id: number;
+  /**
+   * The comments for the most recent edit to the prompt
+   */
+  editComments?: string | null | undefined;
+  /**
+   * Whether to include the default tools (`summary`, `hangup`) in the list of tools for the prompt. If you remove one of the default tools from your prompt, you might want to disable this option so that the tool is not added again when updated.
+   */
+  includeDefaultTools?: boolean | undefined;
+};
+
+/** @internal */
+export const PromptUpdateRequest$inboundSchema: z.ZodType<
+  PromptUpdateRequest,
+  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(),
+  include_default_tools: z.boolean().default(true),
+}).transform((v) => {
+  return remap$(v, {
+    "llm_config": "llmConfig",
+    "edit_comments": "editComments",
+    "include_default_tools": "includeDefaultTools",
+  });
+});
+
+/** @internal */
+export type PromptUpdateRequest$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;
+  include_default_tools: boolean;
+};
+
+/** @internal */
+export const PromptUpdateRequest$outboundSchema: z.ZodType<
+  PromptUpdateRequest$Outbound,
+  z.ZodTypeDef,
+  PromptUpdateRequest
+> = 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(),
+  includeDefaultTools: z.boolean().default(true),
+}).transform((v) => {
+  return remap$(v, {
+    llmConfig: "llm_config",
+    editComments: "edit_comments",
+    includeDefaultTools: "include_default_tools",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace PromptUpdateRequest$ {
+  /** @deprecated use `PromptUpdateRequest$inboundSchema` instead. */
+  export const inboundSchema = PromptUpdateRequest$inboundSchema;
+  /** @deprecated use `PromptUpdateRequest$outboundSchema` instead. */
+  export const outboundSchema = PromptUpdateRequest$outboundSchema;
+  /** @deprecated use `PromptUpdateRequest$Outbound` instead. */
+  export type Outbound = PromptUpdateRequest$Outbound;
+}
+
+export function promptUpdateRequestToJSON(
+  promptUpdateRequest: PromptUpdateRequest,
+): string {
+  return JSON.stringify(
+    PromptUpdateRequest$outboundSchema.parse(promptUpdateRequest),
+  );
+}
+
+export function promptUpdateRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<PromptUpdateRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PromptUpdateRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PromptUpdateRequest' from JSON`,
+  );
+}

package/src/models/components/servicecreaterequest.ts

@@ -0,0 +1,76 @@
+/*
+ * 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";
+
+export type ServiceCreateRequest = {
+  /**
+   * The name of the service
+   */
+  name: string;
+  /**
+   * The description of the service
+   */
+  description: string;
+};
+
+/** @internal */
+export const ServiceCreateRequest$inboundSchema: z.ZodType<
+  ServiceCreateRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  name: z.string(),
+  description: z.string(),
+});
+
+/** @internal */
+export type ServiceCreateRequest$Outbound = {
+  name: string;
+  description: string;
+};
+
+/** @internal */
+export const ServiceCreateRequest$outboundSchema: z.ZodType<
+  ServiceCreateRequest$Outbound,
+  z.ZodTypeDef,
+  ServiceCreateRequest
+> = z.object({
+  name: z.string(),
+  description: 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 ServiceCreateRequest$ {
+  /** @deprecated use `ServiceCreateRequest$inboundSchema` instead. */
+  export const inboundSchema = ServiceCreateRequest$inboundSchema;
+  /** @deprecated use `ServiceCreateRequest$outboundSchema` instead. */
+  export const outboundSchema = ServiceCreateRequest$outboundSchema;
+  /** @deprecated use `ServiceCreateRequest$Outbound` instead. */
+  export type Outbound = ServiceCreateRequest$Outbound;
+}
+
+export function serviceCreateRequestToJSON(
+  serviceCreateRequest: ServiceCreateRequest,
+): string {
+  return JSON.stringify(
+    ServiceCreateRequest$outboundSchema.parse(serviceCreateRequest),
+  );
+}
+
+export function serviceCreateRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<ServiceCreateRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ServiceCreateRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ServiceCreateRequest' from JSON`,
+  );
+}