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

package/src/models/components/dashboard.ts

@@ -8,10 +8,25 @@ import { safeParse } from "../../lib/schemas.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
+/**
+ * Basic information about a dashboard.
+ */
 export type Dashboard = {
+  /**
+   * Superset embedded ID of the dashboard
+   */
   embeddedId: string;
+  /**
+   * Superset guest token of the dashboard
+   */
   guestToken: string;
+  /**
+   * Name of the dashboard
+   */
   name: string;
+  /**
+   * Superset URL of the dashboard
+   */
   supersetUrl: string;
 };
 

package/src/models/components/event.ts

@@ -10,16 +10,49 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type Attributes = {};
 
+/**
+ * An event represents a specific occurrence during a session.
+ */
 export type Event = {
+  /**
+   * Timestamp at which the event occurred
+   */
   timestamp: Date;
+  /**
+   * ID of the session in which the event occurred
+   */
   sessionId?: string | null | undefined;
+  /**
+   * ID of the conversation associated with the session in which the event occurred
+   */
   conversationId?: string | null | undefined;
+  /**
+   * Source of the event (either a tool call or an LLM prompt)
+   */
   source?: string | null | undefined;
+  /**
+   * ID of the source of the event (either a tool ID or a prompt ID)
+   */
   sourceId?: string | null | undefined;
+  /**
+   * Broad categorization of the event
+   */
   category?: string | null | undefined;
+  /**
+   * More specific class of the event
+   */
   type?: string | null | undefined;
+  /**
+   * ID of the user interacting with the system when the event occurred (e.g., their       phone number)
+   */
   userId?: string | null | undefined;
+  /**
+   * Human-readable description of the event
+   */
   description?: string | null | undefined;
+  /**
+   * Arbitrary additional metadata for the event
+   */
   attributes?: Attributes | null | undefined;
 };
 

package/src/models/components/index.ts

@@ -2,7 +2,6 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
-export * from "./agent.js";
 export * from "./agentcreate.js";
 export * from "./agentproperties.js";
 export * from "./agentresponse.js";
@@ -13,56 +12,45 @@ export * from "./agentvoice.js";
 export * from "./agentvoicevarname.js";
 export * from "./availabletarget.js";
 export * from "./availabletargetproperties.js";
-export * from "./bodydirectorymemberbulkload.js";
 export * from "./channel.js";
 export * from "./channelproperties.js";
 export * from "./channelservices.js";
-export * from "./channeltarget.js";
 export * from "./channeltargetcreaterequest.js";
 export * from "./channeltargetproperties.js";
+export * from "./channeltargetresponse.js";
 export * from "./channeltargetupdaterequest.js";
 export * from "./conversation.js";
 export * from "./conversationproperties.js";
-export * from "./custommessage.js";
 export * from "./custommessagecreaterequest.js";
 export * from "./custommessageproperties.js";
 export * from "./custommessageresponse.js";
+export * from "./custommessagerule.js";
 export * from "./custommessageupdaterequest.js";
-export * from "./daochanneltargetagent.js";
-export * from "./daocustommessagerule.js";
 export * from "./dashboard.js";
 export * from "./dayofweek.js";
-export * from "./directoryextension.js";
-export * from "./directorymember.js";
-export * from "./directorymembercreate.js";
-export * from "./directorymemberproperties.js";
 export * from "./event.js";
 export * from "./eventproperties.js";
-export * from "./function.js";
-export * from "./httpendpoint.js";
+export * from "./internaltool.js";
 export * from "./listresponseagentresponse.js";
 export * from "./listresponseavailabletarget.js";
 export * from "./listresponsechannel.js";
-export * from "./listresponsechanneltarget.js";
+export * from "./listresponsechanneltargetresponse.js";
 export * from "./listresponseconversation.js";
 export * from "./listresponsecustommessageresponse.js";
-export * from "./listresponsedirectorymember.js";
 export * from "./listresponseevent.js";
-export * from "./listresponseprompt.js";
+export * from "./listresponsepromptresponse.js";
 export * from "./listresponseservice.js";
 export * from "./listresponsesession.js";
 export * from "./listresponsesessionlabel.js";
-export * from "./listresponsetool.js";
-export * from "./llmconfig.js";
+export * from "./listresponsetoolresponse.js";
 export * from "./orderbydirection.js";
-export * from "./prompt.js";
-export * from "./promptcreate.js";
+export * from "./promptcreaterequest.js";
 export * from "./prompthistory.js";
+export * from "./promptllmconfig.js";
+export * from "./promptllmprovider.js";
 export * from "./promptproperties.js";
-export * from "./promptupdate.js";
-export * from "./provider.js";
-export * from "./sdkinternaltool.js";
-export * from "./sdktooldefinition.js";
+export * from "./promptresponse.js";
+export * from "./promptupdaterequest.js";
 export * from "./security.js";
 export * from "./service.js";
 export * from "./servicecreate.js";
@@ -78,16 +66,20 @@ export * from "./sessionrecordingresponse.js";
 export * from "./sessiontext.js";
 export * from "./sessiontranscriptionresponse.js";
 export * from "./sttprovider.js";
-export * from "./target.js";
 export * from "./targetmodes.js";
 export * from "./testmessage.js";
 export * from "./testmessageresponse.js";
-export * from "./tool.js";
-export * from "./toolcreate.js";
+export * from "./toolargumentlocation.js";
+export * from "./toolcreaterequest.js";
+export * from "./tooldefinition.js";
 export * from "./tooldetailresponse.js";
+export * from "./toolfunction.js";
+export * from "./toolhttpendpoint.js";
+export * from "./toolhttpmethod.js";
 export * from "./toolparameterdefault.js";
 export * from "./toolparametertransform.js";
 export * from "./toolparametertransformcondition.js";
 export * from "./toolproperties.js";
-export * from "./toolupdate.js";
+export * from "./toolresponse.js";
+export * from "./toolupdaterequest.js";
 export * from "./validationerror.js";

package/src/models/components/internaltool.ts

@@ -0,0 +1,86 @@
+/*
+ * 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 {
+  ToolFunction,
+  ToolFunction$inboundSchema,
+  ToolFunction$Outbound,
+  ToolFunction$outboundSchema,
+} from "./toolfunction.js";
+
+/**
+ * A tool definition to be used by the OpenAI API.
+ */
+export type InternalTool = {
+  /**
+   * Always `function`.
+   */
+  type?: "function" | undefined;
+  /**
+   * A function available to an agent.
+   *
+   * @remarks
+   *
+   * See:
+   * - https://learn.microsoft.com/en-us/azure/ai-services/openai/how-to/function-calling
+   */
+  function: ToolFunction;
+};
+
+/** @internal */
+export const InternalTool$inboundSchema: z.ZodType<
+  InternalTool,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  type: z.literal("function").default("function"),
+  function: ToolFunction$inboundSchema,
+});
+
+/** @internal */
+export type InternalTool$Outbound = {
+  type: "function";
+  function: ToolFunction$Outbound;
+};
+
+/** @internal */
+export const InternalTool$outboundSchema: z.ZodType<
+  InternalTool$Outbound,
+  z.ZodTypeDef,
+  InternalTool
+> = z.object({
+  type: z.literal("function").default("function" as const),
+  function: ToolFunction$outboundSchema,
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace InternalTool$ {
+  /** @deprecated use `InternalTool$inboundSchema` instead. */
+  export const inboundSchema = InternalTool$inboundSchema;
+  /** @deprecated use `InternalTool$outboundSchema` instead. */
+  export const outboundSchema = InternalTool$outboundSchema;
+  /** @deprecated use `InternalTool$Outbound` instead. */
+  export type Outbound = InternalTool$Outbound;
+}
+
+export function internalToolToJSON(internalTool: InternalTool): string {
+  return JSON.stringify(InternalTool$outboundSchema.parse(internalTool));
+}
+
+export function internalToolFromJSON(
+  jsonString: string,
+): SafeParseResult<InternalTool, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => InternalTool$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'InternalTool' from JSON`,
+  );
+}

package/src/models/components/listresponsechanneltargetresponse.ts

@@ -0,0 +1,104 @@
+/*
+ * 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 {
+  ChannelTargetResponse,
+  ChannelTargetResponse$inboundSchema,
+  ChannelTargetResponse$Outbound,
+  ChannelTargetResponse$outboundSchema,
+} from "./channeltargetresponse.js";
+
+export type ListResponseChannelTargetResponse = {
+  items: Array<ChannelTargetResponse>;
+  page: number;
+  pageSize: number;
+  totalPages?: number | null | undefined;
+  totalCount?: number | null | undefined;
+};
+
+/** @internal */
+export const ListResponseChannelTargetResponse$inboundSchema: z.ZodType<
+  ListResponseChannelTargetResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  items: z.array(ChannelTargetResponse$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 ListResponseChannelTargetResponse$Outbound = {
+  items: Array<ChannelTargetResponse$Outbound>;
+  page: number;
+  page_size: number;
+  total_pages?: number | null | undefined;
+  total_count?: number | null | undefined;
+};
+
+/** @internal */
+export const ListResponseChannelTargetResponse$outboundSchema: z.ZodType<
+  ListResponseChannelTargetResponse$Outbound,
+  z.ZodTypeDef,
+  ListResponseChannelTargetResponse
+> = z.object({
+  items: z.array(ChannelTargetResponse$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 ListResponseChannelTargetResponse$ {
+  /** @deprecated use `ListResponseChannelTargetResponse$inboundSchema` instead. */
+  export const inboundSchema = ListResponseChannelTargetResponse$inboundSchema;
+  /** @deprecated use `ListResponseChannelTargetResponse$outboundSchema` instead. */
+  export const outboundSchema =
+    ListResponseChannelTargetResponse$outboundSchema;
+  /** @deprecated use `ListResponseChannelTargetResponse$Outbound` instead. */
+  export type Outbound = ListResponseChannelTargetResponse$Outbound;
+}
+
+export function listResponseChannelTargetResponseToJSON(
+  listResponseChannelTargetResponse: ListResponseChannelTargetResponse,
+): string {
+  return JSON.stringify(
+    ListResponseChannelTargetResponse$outboundSchema.parse(
+      listResponseChannelTargetResponse,
+    ),
+  );
+}
+
+export function listResponseChannelTargetResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<ListResponseChannelTargetResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListResponseChannelTargetResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListResponseChannelTargetResponse' from JSON`,
+  );
+}

package/src/models/components/{listresponsechanneltarget.ts → listresponsepromptresponse.ts}

@@ -8,14 +8,14 @@ import { safeParse } from "../../lib/schemas.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 import {
-  ChannelTarget,
-  ChannelTarget$inboundSchema,
-  ChannelTarget$Outbound,
-  ChannelTarget$outboundSchema,
-} from "./channeltarget.js";
+  PromptResponse,
+  PromptResponse$inboundSchema,
+  PromptResponse$Outbound,
+  PromptResponse$outboundSchema,
+} from "./promptresponse.js";
 
-export type ListResponseChannelTarget = {
-  items: Array<ChannelTarget>;
+export type ListResponsePromptResponse = {
+  items: Array<PromptResponse>;
   page: number;
   pageSize: number;
   totalPages?: number | null | undefined;
@@ -23,12 +23,12 @@ export type ListResponseChannelTarget = {
 };
 
 /** @internal */
-export const ListResponseChannelTarget$inboundSchema: z.ZodType<
-  ListResponseChannelTarget,
+export const ListResponsePromptResponse$inboundSchema: z.ZodType<
+  ListResponsePromptResponse,
   z.ZodTypeDef,
   unknown
 > = z.object({
-  items: z.array(ChannelTarget$inboundSchema),
+  items: z.array(PromptResponse$inboundSchema),
   page: z.number().int(),
   page_size: z.number().int(),
   total_pages: z.nullable(z.number().int()).optional(),
@@ -42,8 +42,8 @@ export const ListResponseChannelTarget$inboundSchema: z.ZodType<
 });
 
 /** @internal */
-export type ListResponseChannelTarget$Outbound = {
-  items: Array<ChannelTarget$Outbound>;
+export type ListResponsePromptResponse$Outbound = {
+  items: Array<PromptResponse$Outbound>;
   page: number;
   page_size: number;
   total_pages?: number | null | undefined;
@@ -51,12 +51,12 @@ export type ListResponseChannelTarget$Outbound = {
 };
 
 /** @internal */
-export const ListResponseChannelTarget$outboundSchema: z.ZodType<
-  ListResponseChannelTarget$Outbound,
+export const ListResponsePromptResponse$outboundSchema: z.ZodType<
+  ListResponsePromptResponse$Outbound,
   z.ZodTypeDef,
-  ListResponseChannelTarget
+  ListResponsePromptResponse
 > = z.object({
-  items: z.array(ChannelTarget$outboundSchema),
+  items: z.array(PromptResponse$outboundSchema),
   page: z.number().int(),
   pageSize: z.number().int(),
   totalPages: z.nullable(z.number().int()).optional(),
@@ -73,29 +73,29 @@ export const ListResponseChannelTarget$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 ListResponseChannelTarget$ {
-  /** @deprecated use `ListResponseChannelTarget$inboundSchema` instead. */
-  export const inboundSchema = ListResponseChannelTarget$inboundSchema;
-  /** @deprecated use `ListResponseChannelTarget$outboundSchema` instead. */
-  export const outboundSchema = ListResponseChannelTarget$outboundSchema;
-  /** @deprecated use `ListResponseChannelTarget$Outbound` instead. */
-  export type Outbound = ListResponseChannelTarget$Outbound;
+export namespace ListResponsePromptResponse$ {
+  /** @deprecated use `ListResponsePromptResponse$inboundSchema` instead. */
+  export const inboundSchema = ListResponsePromptResponse$inboundSchema;
+  /** @deprecated use `ListResponsePromptResponse$outboundSchema` instead. */
+  export const outboundSchema = ListResponsePromptResponse$outboundSchema;
+  /** @deprecated use `ListResponsePromptResponse$Outbound` instead. */
+  export type Outbound = ListResponsePromptResponse$Outbound;
 }
 
-export function listResponseChannelTargetToJSON(
-  listResponseChannelTarget: ListResponseChannelTarget,
+export function listResponsePromptResponseToJSON(
+  listResponsePromptResponse: ListResponsePromptResponse,
 ): string {
   return JSON.stringify(
-    ListResponseChannelTarget$outboundSchema.parse(listResponseChannelTarget),
+    ListResponsePromptResponse$outboundSchema.parse(listResponsePromptResponse),
   );
 }
 
-export function listResponseChannelTargetFromJSON(
+export function listResponsePromptResponseFromJSON(
   jsonString: string,
-): SafeParseResult<ListResponseChannelTarget, SDKValidationError> {
+): SafeParseResult<ListResponsePromptResponse, SDKValidationError> {
   return safeParse(
     jsonString,
-    (x) => ListResponseChannelTarget$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'ListResponseChannelTarget' from JSON`,
+    (x) => ListResponsePromptResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListResponsePromptResponse' from JSON`,
   );
 }

package/src/models/components/{listresponseprompt.ts → listresponsetoolresponse.ts}

@@ -8,14 +8,14 @@ import { safeParse } from "../../lib/schemas.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 import {
-  Prompt,
-  Prompt$inboundSchema,
-  Prompt$Outbound,
-  Prompt$outboundSchema,
-} from "./prompt.js";
+  ToolResponse,
+  ToolResponse$inboundSchema,
+  ToolResponse$Outbound,
+  ToolResponse$outboundSchema,
+} from "./toolresponse.js";
 
-export type ListResponsePrompt = {
-  items: Array<Prompt>;
+export type ListResponseToolResponse = {
+  items: Array<ToolResponse>;
   page: number;
   pageSize: number;
   totalPages?: number | null | undefined;
@@ -23,12 +23,12 @@ export type ListResponsePrompt = {
 };
 
 /** @internal */
-export const ListResponsePrompt$inboundSchema: z.ZodType<
-  ListResponsePrompt,
+export const ListResponseToolResponse$inboundSchema: z.ZodType<
+  ListResponseToolResponse,
   z.ZodTypeDef,
   unknown
 > = z.object({
-  items: z.array(Prompt$inboundSchema),
+  items: z.array(ToolResponse$inboundSchema),
   page: z.number().int(),
   page_size: z.number().int(),
   total_pages: z.nullable(z.number().int()).optional(),
@@ -42,8 +42,8 @@ export const ListResponsePrompt$inboundSchema: z.ZodType<
 });
 
 /** @internal */
-export type ListResponsePrompt$Outbound = {
-  items: Array<Prompt$Outbound>;
+export type ListResponseToolResponse$Outbound = {
+  items: Array<ToolResponse$Outbound>;
   page: number;
   page_size: number;
   total_pages?: number | null | undefined;
@@ -51,12 +51,12 @@ export type ListResponsePrompt$Outbound = {
 };
 
 /** @internal */
-export const ListResponsePrompt$outboundSchema: z.ZodType<
-  ListResponsePrompt$Outbound,
+export const ListResponseToolResponse$outboundSchema: z.ZodType<
+  ListResponseToolResponse$Outbound,
   z.ZodTypeDef,
-  ListResponsePrompt
+  ListResponseToolResponse
 > = z.object({
-  items: z.array(Prompt$outboundSchema),
+  items: z.array(ToolResponse$outboundSchema),
   page: z.number().int(),
   pageSize: z.number().int(),
   totalPages: z.nullable(z.number().int()).optional(),
@@ -73,29 +73,29 @@ export const ListResponsePrompt$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 ListResponsePrompt$ {
-  /** @deprecated use `ListResponsePrompt$inboundSchema` instead. */
-  export const inboundSchema = ListResponsePrompt$inboundSchema;
-  /** @deprecated use `ListResponsePrompt$outboundSchema` instead. */
-  export const outboundSchema = ListResponsePrompt$outboundSchema;
-  /** @deprecated use `ListResponsePrompt$Outbound` instead. */
-  export type Outbound = ListResponsePrompt$Outbound;
+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 listResponsePromptToJSON(
-  listResponsePrompt: ListResponsePrompt,
+export function listResponseToolResponseToJSON(
+  listResponseToolResponse: ListResponseToolResponse,
 ): string {
   return JSON.stringify(
-    ListResponsePrompt$outboundSchema.parse(listResponsePrompt),
+    ListResponseToolResponse$outboundSchema.parse(listResponseToolResponse),
   );
 }
 
-export function listResponsePromptFromJSON(
+export function listResponseToolResponseFromJSON(
   jsonString: string,
-): SafeParseResult<ListResponsePrompt, SDKValidationError> {
+): SafeParseResult<ListResponseToolResponse, SDKValidationError> {
   return safeParse(
     jsonString,
-    (x) => ListResponsePrompt$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'ListResponsePrompt' from JSON`,
+    (x) => ListResponseToolResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListResponseToolResponse' from JSON`,
   );
 }