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

package/src/models/components/service.ts

@@ -7,6 +7,9 @@ import { safeParse } from "../../lib/schemas.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
+/**
+ * A service is a collection of tools.
+ */
 export type Service = {
   /**
    * The name of the service
@@ -21,7 +24,7 @@ export type Service = {
    */
   id: number;
   /**
-   * The tools of the service
+   * Names of the tools that belong to the service
    */
   tools: Array<string>;
 };

package/src/models/components/session.ts

@@ -8,25 +8,85 @@ import { safeParse } from "../../lib/schemas.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
+/**
+ * A session is a building block of a conversation.
+ */
 export type Session = {
+  /**
+   * Timestamp of the session
+   */
   timestamp: Date;
+  /**
+   * Internal ID of the session, generated based on interaction details
+   */
   sessionId?: string | null | undefined;
+  /**
+   * ID of the conversation of which the session is a part
+   */
   conversationId?: string | null | undefined;
+  /**
+   * Name of the service used to facilitate the session
+   */
   channelManagerService?: string | null | undefined;
+  /**
+   * Type of the service used to facilitate the session
+   */
   channelManagerType?: string | null | undefined;
+  /**
+   * Channel-manager-side ID of the session (different from session_id)
+   */
   channelManagerSid?: string | null | undefined;
+  /**
+   * ID of the agent with which the session occurred
+   */
   agentId?: string | null | undefined;
+  /**
+   * Name of the agent with which the session occurred
+   */
   agentName?: string | null | undefined;
+  /**
+   * Type of the agent with which the session occurred
+   */
   agentType?: string | null | undefined;
+  /**
+   * Timezone of the agent with which the session occurred
+   */
   agentTimezone?: string | null | undefined;
+  /**
+   * ID of the prompt used by the agent with which the session occurred
+   */
   promptId?: string | null | undefined;
+  /**
+   * Name of the prompt used by the agent with which the session occurred
+   */
   promptName?: string | null | undefined;
+  /**
+   * Version of the prompt used by the agent with which the session occurred
+   */
   promptVersion?: string | null | undefined;
+  /**
+   * Duration of the session in seconds
+   */
   duration?: number | null | undefined;
+  /**
+   * ID of the label (listing the quality of the session and any issues that occurred) associated with the session
+   */
   sessionLabelId?: string | null | undefined;
+  /**
+   * Source of the session (e.g., for an inbound session, the user's phone number/username/email)
+   */
   source?: string | null | undefined;
+  /**
+   * The name of the channel target associated with the agent at the time of the session (see ChannelTargetResponse.target)
+   */
   target?: string | null | undefined;
+  /**
+   * Whether the session occurred on the legacy Syllable system
+   */
   isLegacy?: boolean | null | undefined;
+  /**
+   * Whether the session is a test session
+   */
   isTest?: boolean | null | undefined;
 };
 

package/src/models/components/sessionaction.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";
 
+/**
+ * Information about a given tool invocation as part of a session.
+ */
 export type SessionAction = {
+  /**
+   * Timestamp of the tool invocation
+   */
   timestamp: Date;
+  /**
+   * Name of the tool that was invoked
+   */
   toolName?: string | null | undefined;
+  /**
+   * Request sent to the tool API, if applicable
+   */
   toolRequest?: string | null | undefined;
+  /**
+   * Response received from the tool API, if applicable
+   */
   toolResult?: string | null | undefined;
 };
 

package/src/models/components/sessionlabel.ts

@@ -8,15 +8,39 @@ import { safeParse } from "../../lib/schemas.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
+/**
+ * A session label is associated with a given session and contains an evaluation of quality and
+ *
+ * @remarks
+ * descriptions of issues the user encountered in that session or other details.
+ */
 export type SessionLabel = {
+  /**
+   * The internal ID of the session (see Session.session_id)
+   */
   sessionId: number;
+  /**
+   * The type of the label
+   */
   type: string;
+  /**
+   * A code describing the quality of the labeled session
+   */
   code: string;
+  /**
+   * The email of the user who created the label
+   */
   userEmail: string;
+  /**
+   * Comment string describing additional details about the session
+   */
   comments?: string | null | undefined;
+  /**
+   * Descriptions of issues occurring in the labeled call
+   */
   issueCategories?: Array<string> | null | undefined;
   /**
-   * The label ID
+   * The internal ID of the label
    */
   id: number;
   /**

package/src/models/components/sessionlabelcreate.ts

@@ -9,11 +9,29 @@ import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type SessionLabelCreate = {
+  /**
+   * The internal ID of the session (see Session.session_id)
+   */
   sessionId: number;
+  /**
+   * The type of the label
+   */
   type: string;
+  /**
+   * A code describing the quality of the labeled session
+   */
   code: string;
+  /**
+   * The email of the user who created the label
+   */
   userEmail: string;
+  /**
+   * Comment string describing additional details about the session
+   */
   comments?: string | null | undefined;
+  /**
+   * Descriptions of issues occurring in the labeled call
+   */
   issueCategories?: Array<string> | null | undefined;
 };
 

package/src/models/components/sessionrecordingresponse.ts

@@ -8,9 +8,21 @@ import { safeParse } from "../../lib/schemas.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
+/**
+ * Recording URLs for a given session.
+ */
 export type SessionRecordingResponse = {
+  /**
+   * The internal ID of the session
+   */
   sessionId?: string | null | undefined;
+  /**
+   * List of recording URLs
+   */
   recordings?: Array<string> | null | undefined;
+  /**
+   * Expiration timestamp of the URLs
+   */
   expiration?: string | null | undefined;
 };
 

package/src/models/components/sessiontext.ts

@@ -7,10 +7,25 @@ import { safeParse } from "../../lib/schemas.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
+/**
+ * Information about a given message from a user to an agent or vice-versa.
+ */
 export type SessionText = {
+  /**
+   * Timestamp of the message
+   */
   timestamp: Date;
+  /**
+   * ISO 639 code of the language used for the message (may appear as "unset" if was not conclusively determined)
+   */
   lang?: string | null | undefined;
+  /**
+   * Whether the user or agent sent the message
+   */
   source?: string | null | undefined;
+  /**
+   * Content of the message
+   */
   text?: string | null | undefined;
 };
 

package/src/models/components/sessiontranscriptionresponse.ts

@@ -20,9 +20,21 @@ import {
   SessionText$outboundSchema,
 } from "./sessiontext.js";
 
+/**
+ * Text transcript of a given session.
+ */
 export type SessionTranscriptionResponse = {
+  /**
+   * Internal ID of the session
+   */
   sessionId: string;
+  /**
+   * Transcriptions of all messages in the session
+   */
   transcription: Array<SessionText>;
+  /**
+   * Tool invocations that occurred during the session
+   */
   actions: Array<SessionAction>;
 };
 

package/src/models/components/sttprovider.ts

@@ -5,11 +5,17 @@
 import * as z from "zod";
 import { ClosedEnum } from "../../types/enums.js";
 
+/**
+ * Provider for an agent voice.
+ */
 export const SttProvider = {
   OpenAI: "OpenAI",
   ElevenLabs: "ElevenLabs",
   Google: "Google",
 } as const;
+/**
+ * Provider for an agent voice.
+ */
 export type SttProvider = ClosedEnum<typeof SttProvider>;
 
 /** @internal */

package/src/models/components/targetmodes.ts

@@ -5,12 +5,18 @@
 import * as z from "zod";
 import { ClosedEnum } from "../../types/enums.js";
 
+/**
+ * Available modes (communication methods) for channel targets.
+ */
 export const TargetModes = {
   Voice: "voice",
   Chat: "chat",
   Sms: "sms",
   Email: "email",
 } as const;
+/**
+ * Available modes (communication methods) for channel targets.
+ */
 export type TargetModes = ClosedEnum<typeof TargetModes>;
 
 /** @internal */

package/src/models/components/testmessage.ts

@@ -8,6 +8,9 @@ import { safeParse } from "../../lib/schemas.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
+/**
+ * Message sent in a test chat with an agent.
+ */
 export type TestMessage = {
   /**
    * Name of the service producing the message
@@ -17,11 +20,29 @@ export type TestMessage = {
    * Name of the source of the message, should identify the user, like an email or username
    */
   source: string;
+  /**
+   * The text of the message
+   */
   text?: string | null | undefined;
+  /**
+   * Channel-manager-side ID of the session (see Session.channel_manager_sid)
+   */
   testId: string;
+  /**
+   * ID of the agent with which the chat is taking place
+   */
   agentId: string;
+  /**
+   * Name of the organization associated with the agent
+   */
   orgName: string;
+  /**
+   * Override for the timestamp of the message
+   */
   overrideTimestamp?: string | null | undefined;
+  /**
+   * Whether this message is the start of a new session
+   */
   sessionStart?: boolean | undefined;
 };
 

package/src/models/components/testmessageresponse.ts

@@ -10,12 +10,27 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type Response = {};
 
+/**
+ * Response from an agent in a test chat.
+ */
 export type TestMessageResponse = {
+  /**
+   * Channel-manager-side ID of the session (see Session.channel_manager_sid)
+   */
   testId: string;
+  /**
+   * ID of the agent with which the chat is taking place
+   */
   agentId: string;
-  text: string;
+  /**
+   * The text of the message that elicited the response
+   */
+  text?: string | undefined;
   response?: Response | undefined;
-  responseText: string;
+  /**
+   * The text of the response
+   */
+  responseText?: string | undefined;
 };
 
 /** @internal */
@@ -70,9 +85,9 @@ export const TestMessageResponse$inboundSchema: z.ZodType<
 > = z.object({
   test_id: z.string(),
   agent_id: z.string(),
-  text: z.string(),
+  text: z.string().optional(),
   response: z.lazy(() => Response$inboundSchema).optional(),
-  response_text: z.string(),
+  response_text: z.string().optional(),
 }).transform((v) => {
   return remap$(v, {
     "test_id": "testId",
@@ -85,9 +100,9 @@ export const TestMessageResponse$inboundSchema: z.ZodType<
 export type TestMessageResponse$Outbound = {
   test_id: string;
   agent_id: string;
-  text: string;
+  text?: string | undefined;
   response?: Response$Outbound | undefined;
-  response_text: string;
+  response_text?: string | undefined;
 };
 
 /** @internal */
@@ -98,9 +113,9 @@ export const TestMessageResponse$outboundSchema: z.ZodType<
 > = z.object({
   testId: z.string(),
   agentId: z.string(),
-  text: z.string(),
+  text: z.string().optional(),
   response: z.lazy(() => Response$outboundSchema).optional(),
-  responseText: z.string(),
+  responseText: z.string().optional(),
 }).transform((v) => {
   return remap$(v, {
     testId: "test_id",

package/src/models/components/toolargumentlocation.ts

@@ -0,0 +1,53 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { ClosedEnum } from "../../types/enums.js";
+
+/**
+ * The location of the argument in a tool HTTP request.
+ *
+ * @remarks
+ * 'body' is used for JSON data in the POST request body.
+ * 'form' is used for form data in the POST request body.
+ * 'path' is used for URL path parameters.
+ * 'query' is used for query parameters in the URL.
+ */
+export const ToolArgumentLocation = {
+  Body: "body",
+  Form: "form",
+  Path: "path",
+  Query: "query",
+} as const;
+/**
+ * The location of the argument in a tool HTTP request.
+ *
+ * @remarks
+ * 'body' is used for JSON data in the POST request body.
+ * 'form' is used for form data in the POST request body.
+ * 'path' is used for URL path parameters.
+ * 'query' is used for query parameters in the URL.
+ */
+export type ToolArgumentLocation = ClosedEnum<typeof ToolArgumentLocation>;
+
+/** @internal */
+export const ToolArgumentLocation$inboundSchema: z.ZodNativeEnum<
+  typeof ToolArgumentLocation
+> = z.nativeEnum(ToolArgumentLocation);
+
+/** @internal */
+export const ToolArgumentLocation$outboundSchema: z.ZodNativeEnum<
+  typeof ToolArgumentLocation
+> = ToolArgumentLocation$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ToolArgumentLocation$ {
+  /** @deprecated use `ToolArgumentLocation$inboundSchema` instead. */
+  export const inboundSchema = ToolArgumentLocation$inboundSchema;
+  /** @deprecated use `ToolArgumentLocation$outboundSchema` instead. */
+  export const outboundSchema = ToolArgumentLocation$outboundSchema;
+}

package/src/models/components/toolcreaterequest.ts

@@ -0,0 +1,187 @@
+/*
+ * 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 {
+  ToolDefinition,
+  ToolDefinition$inboundSchema,
+  ToolDefinition$Outbound,
+  ToolDefinition$outboundSchema,
+} from "./tooldefinition.js";
+
+export type ToolCreateRequest = {
+  /**
+   * The name of the tool
+   */
+  name: string;
+  /**
+   * A tool that can be called from an LLM during the conversation.
+   *
+   * @remarks
+   *
+   * The tool can result in one of the following actions depending on the `type` field:
+   * - `action`:
+   *   A request to perform an action.
+   * - `endpoint`:
+   *   An HTTP API call to an external tool. Requires the `endpoint` field to be set too.
+   * - `context`:
+   *   Sets context variables based on the tool arguments, e.g. to change the session language. Only
+   *   `language` and `say` context vars are currently supported, but this will be made more generic.
+   *
+   * For example, to change the current session language:
+   * {
+   *   "type": "context",
+   *   "tool": {
+   *     "function": {
+   *       "name": "set_language",
+   *       "parameters": {
+   *         "language": {
+   *           "type": "string",
+   *           "description": "The ISO 639 language code to set for the session e.g. 'en-US'."
+   *         },
+   *         "message": {
+   *           "type": "string",
+   *           "description": "Inform the caller we're now speaking in the new language."
+   *         }
+   *       }
+   *     }
+   *   }
+   * }
+   *
+   * If `defaults` is provided, it will be used as the default values for the parameters of the
+   * tool call, if the LLM doesn't provide them:
+   * "defaults": {
+   *   "hospital": "Queens Hospital"
+   * }
+   *
+   * Some special "transform" handling is supported if the value is a dict with a single `transform`
+   * key. The parameter value will be transformed by the given `action` before being used as the
+   * default value:
+   *
+   * Removing an unwanted parameter:
+   * "defaults": {
+   *   "hospital": {
+   *     "transform": {
+   *       "action": "remove"
+   *     }
+   *   }
+   * }
+   *
+   * Using a value from another parameter and converting it to a dictionary:
+   * "defaults": {
+   *   "tags.hospital": "{vars.hospital}",
+   *   "tags.foo": "{params.foo}",
+   *   "foo": {
+   *     "transform": {
+   *       "action": "remove"
+   *     }
+   *   }
+   * }
+   *
+   * Add custom parameters from other parameters using Python's `format`:
+   * "defaults": {
+   *   "hello": {
+   *     "transform": {
+   *       "format": "Hello, {name}!"
+   *     }
+   *   }
+   * }
+   *
+   * Modify a value conditionally, e.g. change a `city` parameter with value "Bronx" to "The Bronx":
+   * {
+   *   "defaults": {
+   *     "city": {
+   *       "transform": {
+   *         "when": {"operator": "eq", "key": "city", "value": "Bronx"},
+   *         "action": "override",
+   *         "format": "The {city}"
+   *       }
+   *     }
+   *   }
+   * }
+   *
+   * Some common transform actions can be abbreviated using the `@` prefix to support a string syntax:
+   * "defaults": {
+   *   "foo": "@remove",
+   *   "name": "@override Hello, {name}!"
+   * }
+   */
+  definition: ToolDefinition;
+  /**
+   * The service this tool belongs to
+   */
+  serviceId: number;
+};
+
+/** @internal */
+export const ToolCreateRequest$inboundSchema: z.ZodType<
+  ToolCreateRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  name: z.string(),
+  definition: ToolDefinition$inboundSchema,
+  service_id: z.number().int(),
+}).transform((v) => {
+  return remap$(v, {
+    "service_id": "serviceId",
+  });
+});
+
+/** @internal */
+export type ToolCreateRequest$Outbound = {
+  name: string;
+  definition: ToolDefinition$Outbound;
+  service_id: number;
+};
+
+/** @internal */
+export const ToolCreateRequest$outboundSchema: z.ZodType<
+  ToolCreateRequest$Outbound,
+  z.ZodTypeDef,
+  ToolCreateRequest
+> = z.object({
+  name: z.string(),
+  definition: ToolDefinition$outboundSchema,
+  serviceId: z.number().int(),
+}).transform((v) => {
+  return remap$(v, {
+    serviceId: "service_id",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ToolCreateRequest$ {
+  /** @deprecated use `ToolCreateRequest$inboundSchema` instead. */
+  export const inboundSchema = ToolCreateRequest$inboundSchema;
+  /** @deprecated use `ToolCreateRequest$outboundSchema` instead. */
+  export const outboundSchema = ToolCreateRequest$outboundSchema;
+  /** @deprecated use `ToolCreateRequest$Outbound` instead. */
+  export type Outbound = ToolCreateRequest$Outbound;
+}
+
+export function toolCreateRequestToJSON(
+  toolCreateRequest: ToolCreateRequest,
+): string {
+  return JSON.stringify(
+    ToolCreateRequest$outboundSchema.parse(toolCreateRequest),
+  );
+}
+
+export function toolCreateRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<ToolCreateRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ToolCreateRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ToolCreateRequest' from JSON`,
+  );
+}