syllable-sdk 0.1.0-alpha.59 → 0.1.0-alpha.60

package/src/models/components/dialogmessage.ts

@@ -0,0 +1,62 @@
+/*
+ * 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 DialogMessage = {
+  text: string;
+};
+
+/** @internal */
+export const DialogMessage$inboundSchema: z.ZodType<
+  DialogMessage,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  text: z.string(),
+});
+
+/** @internal */
+export type DialogMessage$Outbound = {
+  text: string;
+};
+
+/** @internal */
+export const DialogMessage$outboundSchema: z.ZodType<
+  DialogMessage$Outbound,
+  z.ZodTypeDef,
+  DialogMessage
+> = z.object({
+  text: 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 DialogMessage$ {
+  /** @deprecated use `DialogMessage$inboundSchema` instead. */
+  export const inboundSchema = DialogMessage$inboundSchema;
+  /** @deprecated use `DialogMessage$outboundSchema` instead. */
+  export const outboundSchema = DialogMessage$outboundSchema;
+  /** @deprecated use `DialogMessage$Outbound` instead. */
+  export type Outbound = DialogMessage$Outbound;
+}
+
+export function dialogMessageToJSON(dialogMessage: DialogMessage): string {
+  return JSON.stringify(DialogMessage$outboundSchema.parse(dialogMessage));
+}
+
+export function dialogMessageFromJSON(
+  jsonString: string,
+): SafeParseResult<DialogMessage, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => DialogMessage$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'DialogMessage' from JSON`,
+  );
+}

package/src/models/components/dialogrole.ts

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

package/src/models/components/dialogtoolcall.ts

@@ -0,0 +1,139 @@
+/*
+ * 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";
+
+export type DialogToolCallToolArguments = {};
+
+export type DialogToolCall = {
+  tollCallId: string;
+  toolName: string;
+  toolArguments: DialogToolCallToolArguments;
+  timestamp: Date;
+};
+
+/** @internal */
+export const DialogToolCallToolArguments$inboundSchema: z.ZodType<
+  DialogToolCallToolArguments,
+  z.ZodTypeDef,
+  unknown
+> = z.object({});
+
+/** @internal */
+export type DialogToolCallToolArguments$Outbound = {};
+
+/** @internal */
+export const DialogToolCallToolArguments$outboundSchema: z.ZodType<
+  DialogToolCallToolArguments$Outbound,
+  z.ZodTypeDef,
+  DialogToolCallToolArguments
+> = 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 DialogToolCallToolArguments$ {
+  /** @deprecated use `DialogToolCallToolArguments$inboundSchema` instead. */
+  export const inboundSchema = DialogToolCallToolArguments$inboundSchema;
+  /** @deprecated use `DialogToolCallToolArguments$outboundSchema` instead. */
+  export const outboundSchema = DialogToolCallToolArguments$outboundSchema;
+  /** @deprecated use `DialogToolCallToolArguments$Outbound` instead. */
+  export type Outbound = DialogToolCallToolArguments$Outbound;
+}
+
+export function dialogToolCallToolArgumentsToJSON(
+  dialogToolCallToolArguments: DialogToolCallToolArguments,
+): string {
+  return JSON.stringify(
+    DialogToolCallToolArguments$outboundSchema.parse(
+      dialogToolCallToolArguments,
+    ),
+  );
+}
+
+export function dialogToolCallToolArgumentsFromJSON(
+  jsonString: string,
+): SafeParseResult<DialogToolCallToolArguments, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => DialogToolCallToolArguments$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'DialogToolCallToolArguments' from JSON`,
+  );
+}
+
+/** @internal */
+export const DialogToolCall$inboundSchema: z.ZodType<
+  DialogToolCall,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  toll_call_id: z.string(),
+  tool_name: z.string(),
+  tool_arguments: z.lazy(() => DialogToolCallToolArguments$inboundSchema),
+  timestamp: z.string().datetime({ offset: true }).transform(v => new Date(v)),
+}).transform((v) => {
+  return remap$(v, {
+    "toll_call_id": "tollCallId",
+    "tool_name": "toolName",
+    "tool_arguments": "toolArguments",
+  });
+});
+
+/** @internal */
+export type DialogToolCall$Outbound = {
+  toll_call_id: string;
+  tool_name: string;
+  tool_arguments: DialogToolCallToolArguments$Outbound;
+  timestamp: string;
+};
+
+/** @internal */
+export const DialogToolCall$outboundSchema: z.ZodType<
+  DialogToolCall$Outbound,
+  z.ZodTypeDef,
+  DialogToolCall
+> = z.object({
+  tollCallId: z.string(),
+  toolName: z.string(),
+  toolArguments: z.lazy(() => DialogToolCallToolArguments$outboundSchema),
+  timestamp: z.date().transform(v => v.toISOString()),
+}).transform((v) => {
+  return remap$(v, {
+    tollCallId: "toll_call_id",
+    toolName: "tool_name",
+    toolArguments: "tool_arguments",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace DialogToolCall$ {
+  /** @deprecated use `DialogToolCall$inboundSchema` instead. */
+  export const inboundSchema = DialogToolCall$inboundSchema;
+  /** @deprecated use `DialogToolCall$outboundSchema` instead. */
+  export const outboundSchema = DialogToolCall$outboundSchema;
+  /** @deprecated use `DialogToolCall$Outbound` instead. */
+  export type Outbound = DialogToolCall$Outbound;
+}
+
+export function dialogToolCallToJSON(dialogToolCall: DialogToolCall): string {
+  return JSON.stringify(DialogToolCall$outboundSchema.parse(dialogToolCall));
+}
+
+export function dialogToolCallFromJSON(
+  jsonString: string,
+): SafeParseResult<DialogToolCall, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => DialogToolCall$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'DialogToolCall' from JSON`,
+  );
+}

package/src/models/components/index.ts

@@ -42,6 +42,9 @@ export * from "./datasourcemetadataresponse.js";
 export * from "./datasourceproperties.js";
 export * from "./datasourceupdaterequest.js";
 export * from "./dayofweek.js";
+export * from "./dialogmessage.js";
+export * from "./dialogrole.js";
+export * from "./dialogtoolcall.js";
 export * from "./event.js";
 export * from "./eventproperties.js";
 export * from "./insighttooldefinition.js";
@@ -91,9 +94,11 @@ export * from "./serviceresponse.js";
 export * from "./serviceupdaterequest.js";
 export * from "./session.js";
 export * from "./sessionaction.js";
+export * from "./sessiondata.js";
 export * from "./sessionlabel.js";
 export * from "./sessionlabelcreate.js";
 export * from "./sessionlabelproperties.js";
+export * from "./sessionmessage.js";
 export * from "./sessionproperties.js";
 export * from "./sessionrecordingresponse.js";
 export * from "./sessionsummaryresponse.js";
@@ -118,6 +123,7 @@ export * from "./toolparametertransformcondition.js";
 export * from "./toolpromptinfo.js";
 export * from "./toolproperties.js";
 export * from "./toolresponse.js";
+export * from "./toolresultdata.js";
 export * from "./toolupdaterequest.js";
 export * from "./ttsprovider.js";
 export * from "./validationerror.js";

package/src/models/components/languagegroupresponse.ts

@@ -20,6 +20,13 @@ import {
   LanguageGroupAgentInfo$outboundSchema,
 } from "./languagegroupagentinfo.js";
 
+/**
+ * A language group is a collection of language, voice, and DTMF configuration that can be
+ *
+ * @remarks
+ * linked to an agent to define the languages and voices it supports. For more information, see
+ * [Console docs](https://docs.syllable.ai/Resources/LanguageGroups).
+ */
 export type LanguageGroupResponse = {
   /**
    * The name of the language group.

package/src/models/components/promptresponse.ts

@@ -25,7 +25,8 @@ import {
  *
  * @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.
+ * tools to allow an agent using it to use those tools. For more information, see
+ * [Console docs](https://docs.syllable.ai/Resources/Prompts).
  */
 export type PromptResponse = {
   /**

package/src/models/components/sessiondata.ts

@@ -0,0 +1,95 @@
+/*
+ * 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 {
+  SessionMessage,
+  SessionMessage$inboundSchema,
+  SessionMessage$Outbound,
+  SessionMessage$outboundSchema,
+} from "./sessionmessage.js";
+
+export type SessionData = {
+  sessionId: number;
+  source: string;
+  target: string;
+  isTest: boolean;
+  messages: Array<SessionMessage>;
+};
+
+/** @internal */
+export const SessionData$inboundSchema: z.ZodType<
+  SessionData,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  session_id: z.number().int(),
+  source: z.string(),
+  target: z.string(),
+  is_test: z.boolean(),
+  messages: z.array(SessionMessage$inboundSchema),
+}).transform((v) => {
+  return remap$(v, {
+    "session_id": "sessionId",
+    "is_test": "isTest",
+  });
+});
+
+/** @internal */
+export type SessionData$Outbound = {
+  session_id: number;
+  source: string;
+  target: string;
+  is_test: boolean;
+  messages: Array<SessionMessage$Outbound>;
+};
+
+/** @internal */
+export const SessionData$outboundSchema: z.ZodType<
+  SessionData$Outbound,
+  z.ZodTypeDef,
+  SessionData
+> = z.object({
+  sessionId: z.number().int(),
+  source: z.string(),
+  target: z.string(),
+  isTest: z.boolean(),
+  messages: z.array(SessionMessage$outboundSchema),
+}).transform((v) => {
+  return remap$(v, {
+    sessionId: "session_id",
+    isTest: "is_test",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace SessionData$ {
+  /** @deprecated use `SessionData$inboundSchema` instead. */
+  export const inboundSchema = SessionData$inboundSchema;
+  /** @deprecated use `SessionData$outboundSchema` instead. */
+  export const outboundSchema = SessionData$outboundSchema;
+  /** @deprecated use `SessionData$Outbound` instead. */
+  export type Outbound = SessionData$Outbound;
+}
+
+export function sessionDataToJSON(sessionData: SessionData): string {
+  return JSON.stringify(SessionData$outboundSchema.parse(sessionData));
+}
+
+export function sessionDataFromJSON(
+  jsonString: string,
+): SafeParseResult<SessionData, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SessionData$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SessionData' from JSON`,
+  );
+}

package/src/models/components/sessionmessage.ts

@@ -0,0 +1,100 @@
+/*
+ * 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 {
+  DialogMessage,
+  DialogMessage$inboundSchema,
+  DialogMessage$Outbound,
+  DialogMessage$outboundSchema,
+} from "./dialogmessage.js";
+import {
+  DialogRole,
+  DialogRole$inboundSchema,
+  DialogRole$outboundSchema,
+} from "./dialogrole.js";
+import {
+  DialogToolCall,
+  DialogToolCall$inboundSchema,
+  DialogToolCall$Outbound,
+  DialogToolCall$outboundSchema,
+} from "./dialogtoolcall.js";
+
+export type SessionMessage = {
+  role: DialogRole;
+  dialog: DialogMessage;
+  toolCalls: Array<DialogToolCall>;
+  timestamp: Date;
+};
+
+/** @internal */
+export const SessionMessage$inboundSchema: z.ZodType<
+  SessionMessage,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  role: DialogRole$inboundSchema,
+  dialog: DialogMessage$inboundSchema,
+  tool_calls: z.array(DialogToolCall$inboundSchema),
+  timestamp: z.string().datetime({ offset: true }).transform(v => new Date(v)),
+}).transform((v) => {
+  return remap$(v, {
+    "tool_calls": "toolCalls",
+  });
+});
+
+/** @internal */
+export type SessionMessage$Outbound = {
+  role: string;
+  dialog: DialogMessage$Outbound;
+  tool_calls: Array<DialogToolCall$Outbound>;
+  timestamp: string;
+};
+
+/** @internal */
+export const SessionMessage$outboundSchema: z.ZodType<
+  SessionMessage$Outbound,
+  z.ZodTypeDef,
+  SessionMessage
+> = z.object({
+  role: DialogRole$outboundSchema,
+  dialog: DialogMessage$outboundSchema,
+  toolCalls: z.array(DialogToolCall$outboundSchema),
+  timestamp: z.date().transform(v => v.toISOString()),
+}).transform((v) => {
+  return remap$(v, {
+    toolCalls: "tool_calls",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace SessionMessage$ {
+  /** @deprecated use `SessionMessage$inboundSchema` instead. */
+  export const inboundSchema = SessionMessage$inboundSchema;
+  /** @deprecated use `SessionMessage$outboundSchema` instead. */
+  export const outboundSchema = SessionMessage$outboundSchema;
+  /** @deprecated use `SessionMessage$Outbound` instead. */
+  export type Outbound = SessionMessage$Outbound;
+}
+
+export function sessionMessageToJSON(sessionMessage: SessionMessage): string {
+  return JSON.stringify(SessionMessage$outboundSchema.parse(sessionMessage));
+}
+
+export function sessionMessageFromJSON(
+  jsonString: string,
+): SafeParseResult<SessionMessage, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SessionMessage$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SessionMessage' from JSON`,
+  );
+}

package/src/models/components/sessiontranscriptionresponse.ts

@@ -21,7 +21,10 @@ import {
 } from "./sessiontext.js";
 
 /**
- * Text transcript of a given session.
+ * Text transcript of a given session. For more information, see
+ *
+ * @remarks
+ * [Console docs](https://docs.syllable.ai/workspaces/Sessions).
  */
 export type SessionTranscriptionResponse = {
   /**

package/src/models/components/testmessage.ts

@@ -33,9 +33,11 @@ export type TestMessage = {
    */
   agentId: string;
   /**
-   * Name of the organization associated with the agent
+   * Unused: Name of the organization associated with the agent
+   *
+   * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
    */
-  orgName: string;
+  orgName?: string | null | undefined;
   /**
    * Override for the timestamp of the message
    */
@@ -57,7 +59,7 @@ export const TestMessage$inboundSchema: z.ZodType<
   text: z.nullable(z.string()).optional(),
   test_id: z.string(),
   agent_id: z.string(),
-  org_name: z.string(),
+  org_name: z.nullable(z.string()).optional(),
   override_timestamp: z.nullable(z.string()).optional(),
   session_start: z.boolean().default(false),
 }).transform((v) => {
@@ -78,7 +80,7 @@ export type TestMessage$Outbound = {
   text?: string | null | undefined;
   test_id: string;
   agent_id: string;
-  org_name: string;
+  org_name?: string | null | undefined;
   override_timestamp?: string | null | undefined;
   session_start: boolean;
 };
@@ -94,7 +96,7 @@ export const TestMessage$outboundSchema: z.ZodType<
   text: z.nullable(z.string()).optional(),
   testId: z.string(),
   agentId: z.string(),
-  orgName: z.string(),
+  orgName: z.nullable(z.string()).optional(),
   overrideTimestamp: z.nullable(z.string()).optional(),
   sessionStart: z.boolean().default(false),
 }).transform((v) => {

package/src/models/components/tooldetailresponse.ts

@@ -32,6 +32,7 @@ import {
  * @remarks
  * making API calls, or processing data. For an agent to have access to a tool, the prompt
  * associated with that agent should be linked to the tool and include instructions to use it.
+ * For more information, see [Console docs](https://docs.syllable.ai/Resources/Tools).
  */
 export type ToolDetailResponse = {
   /**

package/src/models/components/toolresponse.ts

@@ -32,6 +32,7 @@ import {
  * @remarks
  * making API calls, or processing data. For an agent to have access to a tool, the prompt
  * associated with that agent should be linked to the tool and include instructions to use it.
+ * For more information, see [Console docs](https://docs.syllable.ai/Resources/Tools).
  */
 export type ToolResponse = {
   /**

package/src/models/components/toolresultdata.ts

@@ -0,0 +1,123 @@
+/*
+ * 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";
+
+export type ToolResult = {};
+
+export type ToolResultData = {
+  toolName: string;
+  toolResult: ToolResult;
+};
+
+/** @internal */
+export const ToolResult$inboundSchema: z.ZodType<
+  ToolResult,
+  z.ZodTypeDef,
+  unknown
+> = z.object({});
+
+/** @internal */
+export type ToolResult$Outbound = {};
+
+/** @internal */
+export const ToolResult$outboundSchema: z.ZodType<
+  ToolResult$Outbound,
+  z.ZodTypeDef,
+  ToolResult
+> = 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 ToolResult$ {
+  /** @deprecated use `ToolResult$inboundSchema` instead. */
+  export const inboundSchema = ToolResult$inboundSchema;
+  /** @deprecated use `ToolResult$outboundSchema` instead. */
+  export const outboundSchema = ToolResult$outboundSchema;
+  /** @deprecated use `ToolResult$Outbound` instead. */
+  export type Outbound = ToolResult$Outbound;
+}
+
+export function toolResultToJSON(toolResult: ToolResult): string {
+  return JSON.stringify(ToolResult$outboundSchema.parse(toolResult));
+}
+
+export function toolResultFromJSON(
+  jsonString: string,
+): SafeParseResult<ToolResult, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ToolResult$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ToolResult' from JSON`,
+  );
+}
+
+/** @internal */
+export const ToolResultData$inboundSchema: z.ZodType<
+  ToolResultData,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  tool_name: z.string(),
+  tool_result: z.lazy(() => ToolResult$inboundSchema),
+}).transform((v) => {
+  return remap$(v, {
+    "tool_name": "toolName",
+    "tool_result": "toolResult",
+  });
+});
+
+/** @internal */
+export type ToolResultData$Outbound = {
+  tool_name: string;
+  tool_result: ToolResult$Outbound;
+};
+
+/** @internal */
+export const ToolResultData$outboundSchema: z.ZodType<
+  ToolResultData$Outbound,
+  z.ZodTypeDef,
+  ToolResultData
+> = z.object({
+  toolName: z.string(),
+  toolResult: z.lazy(() => ToolResult$outboundSchema),
+}).transform((v) => {
+  return remap$(v, {
+    toolName: "tool_name",
+    toolResult: "tool_result",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ToolResultData$ {
+  /** @deprecated use `ToolResultData$inboundSchema` instead. */
+  export const inboundSchema = ToolResultData$inboundSchema;
+  /** @deprecated use `ToolResultData$outboundSchema` instead. */
+  export const outboundSchema = ToolResultData$outboundSchema;
+  /** @deprecated use `ToolResultData$Outbound` instead. */
+  export type Outbound = ToolResultData$Outbound;
+}
+
+export function toolResultDataToJSON(toolResultData: ToolResultData): string {
+  return JSON.stringify(ToolResultData$outboundSchema.parse(toolResultData));
+}
+
+export function toolResultDataFromJSON(
+  jsonString: string,
+): SafeParseResult<ToolResultData, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ToolResultData$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ToolResultData' from JSON`,
+  );
+}