syllable-sdk 0.1.0-alpha.66 → 0.1.0-alpha.68

package/src/models/components/datasourceproperties.ts

@@ -5,6 +5,9 @@
 import * as z from "zod";
 import { ClosedEnum } from "../../types/enums.js";
 
+/**
+ * Names of data source fields supported for filtering/sorting on list endpoint.
+ */
 export const DataSourceProperties = {
   Name: "name",
   Description: "description",
@@ -14,6 +17,9 @@ export const DataSourceProperties = {
   UpdatedAt: "updated_at",
   LastUpdatedBy: "last_updated_by",
 } as const;
+/**
+ * Names of data source fields supported for filtering/sorting on list endpoint.
+ */
 export type DataSourceProperties = ClosedEnum<typeof DataSourceProperties>;
 
 /** @internal */

package/src/models/components/datasourceupdaterequest.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";
 
+/**
+ * Request model to update an existing data source.
+ */
 export type DataSourceUpdateRequest = {
   /**
    * The data source name. Must be unique within suborg. Cannot contain whitespace.
@@ -38,7 +41,7 @@ export type DataSourceUpdateRequest = {
    */
   editComments?: string | null | undefined;
   /**
-   * Information that the data source will provide to the agent accessing it.
+   * Information that the data source will provide to the agent accessing it. It is recommended to include a sentence at the beginning providing context to the LLM for the information in the data source.
    */
   text: string;
 };

package/src/models/components/dayofweek.ts

@@ -5,6 +5,9 @@
 import * as z from "zod";
 import { ClosedEnum } from "../../types/enums.js";
 
+/**
+ * Available options for day of the week for use in message rules.
+ */
 export const DayOfWeek = {
   Mo: "mo",
   Tu: "tu",
@@ -14,6 +17,9 @@ export const DayOfWeek = {
   Sa: "sa",
   Su: "su",
 } as const;
+/**
+ * Available options for day of the week for use in message rules.
+ */
 export type DayOfWeek = ClosedEnum<typeof DayOfWeek>;
 
 /** @internal */

package/src/models/components/dialogmessage.ts

@@ -8,6 +8,9 @@ import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type DialogMessage = {
+  /**
+   * Dialog message text
+   */
   text: string;
 };
 

package/src/models/components/dialogrole.ts

@@ -5,10 +5,16 @@
 import * as z from "zod";
 import { ClosedEnum } from "../../types/enums.js";
 
+/**
+ * Role of dialog
+ */
 export const DialogRole = {
   Agent: "agent",
   User: "user",
 } as const;
+/**
+ * Role of dialog
+ */
 export type DialogRole = ClosedEnum<typeof DialogRole>;
 
 /** @internal */

package/src/models/components/dialogtoolcall.ts

@@ -8,65 +8,25 @@ 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 = {
+  /**
+   * Tool call ID
+   */
   toolCallId: string;
+  /**
+   * Tool name
+   */
   toolName: string;
-  toolArguments: DialogToolCallToolArguments;
+  /**
+   * Tool arguments
+   */
+  toolArguments?: any | undefined;
+  /**
+   * Tool call timestamp
+   */
   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,
@@ -75,7 +35,7 @@ export const DialogToolCall$inboundSchema: z.ZodType<
 > = z.object({
   tool_call_id: z.string(),
   tool_name: z.string(),
-  tool_arguments: z.lazy(() => DialogToolCallToolArguments$inboundSchema),
+  tool_arguments: z.any().optional(),
   timestamp: z.string().datetime({ offset: true }).transform(v => new Date(v)),
 }).transform((v) => {
   return remap$(v, {
@@ -89,7 +49,7 @@ export const DialogToolCall$inboundSchema: z.ZodType<
 export type DialogToolCall$Outbound = {
   tool_call_id: string;
   tool_name: string;
-  tool_arguments: DialogToolCallToolArguments$Outbound;
+  tool_arguments?: any | undefined;
   timestamp: string;
 };
 
@@ -101,7 +61,7 @@ export const DialogToolCall$outboundSchema: z.ZodType<
 > = z.object({
   toolCallId: z.string(),
   toolName: z.string(),
-  toolArguments: z.lazy(() => DialogToolCallToolArguments$outboundSchema),
+  toolArguments: z.any().optional(),
   timestamp: z.date().transform(v => v.toISOString()),
 }).transform((v) => {
   return remap$(v, {

package/src/models/components/insighttooldefinition.ts

@@ -9,38 +9,44 @@ import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 /**
- * Parameters for Insight Tool Definition
+ * Parameters for tools that use this definition and their associated types
  */
 export type ToolParameters = {};
 
 /**
- * Result key/types for Insight Tool Definition
+ * Result key/types for insight tool definition
  */
 export type ToolResultSet = {};
 
+/**
+ * Model for an insight tool definition. This is a template that can be used by multiple insight
+ *
+ * @remarks
+ * tools, each providing their own parameter values.
+ */
 export type InsightToolDefinition = {
   /**
-   * Unique ID for Insight Tool Definition
+   * Unique ID for insight tool definition
    */
   id: number;
   /**
-   * Human readable name of Insight Tool Definition
+   * Human-readable name of insight tool definition
    */
   name: string;
   /**
-   * Type of Insight Tool Definition
+   * Type of insight tool definition
    */
   type: string;
   /**
-   * Text description of Insight Tool Definition
+   * Text description of insight tool definition
    */
   description: string;
   /**
-   * Parameters for Insight Tool Definition
+   * Parameters for tools that use this definition and their associated types
    */
   toolParameters: ToolParameters;
   /**
-   * Result key/types for Insight Tool Definition
+   * Result key/types for insight tool definition
    */
   toolResultSet: ToolResultSet;
 };

package/src/models/components/insighttoolinput.ts

@@ -9,29 +9,32 @@ import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 /**
- * Arguments for Insight Tool
+ * Arguments for calling the insight tool
  */
 export type InsightToolInputToolArguments = {};
 
+/**
+ * Request model to create/update an insight tool.
+ */
 export type InsightToolInput = {
   /**
-   * Human readable name of Insight Tool
+   * Human readable name of insight tool
    */
   name: string;
   /**
-   * Text description of Insight Tool
+   * Text description of insight tool
    */
   description: string;
   /**
-   * Version number of Insight Tool
+   * Version number of insight tool
    */
   version: number;
   /**
-   * Arguments for Insight Tool
+   * Arguments for calling the insight tool
    */
   toolArguments: InsightToolInputToolArguments;
   /**
-   * Unique ID for Insight Tool Definition
+   * Internal ID for the definition used by the insight tool
    */
   insightToolDefinitionId: number;
 };

package/src/models/components/insighttooloutput.ts

@@ -15,33 +15,36 @@ import {
 } from "./insighttooldefinition.js";
 
 /**
- * Arguments for Insight Tool
+ * Arguments for calling the insight tool
  */
 export type ToolArguments = {};
 
+/**
+ * Response model for an insight tool.
+ */
 export type InsightToolOutput = {
   /**
-   * Human readable name of Insight Tool
+   * Human readable name of insight tool
    */
   name: string;
   /**
-   * Text description of Insight Tool
+   * Text description of insight tool
    */
   description: string;
   /**
-   * Version of Insight Tool
+   * Version of insight tool
    */
   version: number;
   /**
-   * Arguments for Insight Tool
+   * Arguments for calling the insight tool
    */
   toolArguments: ToolArguments;
   /**
-   * Unique ID for Insight Tool Definition
+   * Unique ID for insight tool definition used by insight tool
    */
   insightToolDefinitionId: number;
   /**
-   * Unique ID for Insight Tool
+   * Unique ID for insight tool
    */
   id: number;
   /**
@@ -49,15 +52,15 @@ export type InsightToolOutput = {
    */
   insightToolDefinition?: InsightToolDefinition | null | undefined;
   /**
-   * Timestamp of Insight Tool creation
+   * Timestamp of at which insight tool was created
    */
   createdAt?: Date | undefined;
   /**
-   * Timestamp of Insight Tool update
+   * Timestamp at which insight tool was last updated
    */
   updatedAt?: Date | undefined;
   /**
-   * User who last updated Insight Tool
+   * Email of user who last updated insight tool
    */
   lastUpdatedBy: string;
 };

package/src/models/components/insightworkflowinput.ts

@@ -9,29 +9,32 @@ import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 /**
- * Conditions for Insight Workflow
+ * Conditions for insight workflow to trigger on a given call recording.
  */
 export type InsightWorkflowInputConditions = {};
 
+/**
+ * Request model to create/update an insight workflow.
+ */
 export type InsightWorkflowInput = {
   /**
-   * Human readable name of Insight Workflow
+   * Human-readable name of insight workflow
    */
   name: string;
   /**
-   * Text description of Insight Workflow
+   * Text description of insight workflow
    */
   description: string;
   /**
-   * List of Insight Tool IDs
+   * List of IDs of insight tools used in the workflow
    */
   insightToolIds: Array<number>;
   /**
-   * Conditions for Insight Workflow
+   * Conditions for insight workflow to trigger on a given call recording.
    */
   conditions: InsightWorkflowInputConditions;
   /**
-   * Status of the Insight Workflow
+   * Status of the insight workflow
    */
   status: string;
 };

package/src/models/components/insightworkflowoutput.ts

@@ -15,49 +15,52 @@ import {
 } from "./insighttooloutput.js";
 
 /**
- * Conditions for Insight Workflow
+ * Conditions for insight workflow to trigger on a given call recording.
  */
 export type Conditions = {};
 
+/**
+ * Response model for an insight workflow.
+ */
 export type InsightWorkflowOutput = {
   /**
-   * Human readable name of Insight Workflow
+   * Human-readable name of insight workflow
    */
   name: string;
   /**
-   * Text description of Insight Workflow
+   * Text description of insight workflow
    */
   description: string;
   /**
-   * List of Insight Tool IDs
+   * List of IDs of insight tools used in the workflow
    */
   insightToolIds: Array<number>;
   /**
-   * Conditions for Insight Workflow
+   * Conditions for insight workflow to trigger on a given call recording.
    */
   conditions: Conditions;
   /**
-   * Status of the Insight Workflow
+   * Status of the insight workflow
    */
   status: string;
   /**
-   * Unique ID for Insight Workflow
+   * Internal ID of the insight workflow
    */
   id: number;
   /**
-   * List of Insight Tools
+   * List of insight tools used in the workflow
    */
   insightTools: Array<InsightToolOutput>;
   /**
-   * Timestamp of Insight Workflow creation
+   * Timestamp at which the insight workflow was created
    */
   createdAt?: Date | undefined;
   /**
-   * Timestamp of Insight Workflow update
+   * Timestamp of most recent update to the insight workflow
    */
   updatedAt?: Date | undefined;
   /**
-   * User who last updated Insight Workflow
+   * Email of user who last updated Insight Workflow
    */
   lastUpdatedBy: string;
 };

package/src/models/components/languagegroupcreaterequest.ts

@@ -14,6 +14,9 @@ import {
   LanguageConfig$outboundSchema,
 } from "./languageconfig.js";
 
+/**
+ * Request model to create a language group.
+ */
 export type LanguageGroupCreateRequest = {
   /**
    * The name of the language group.
@@ -28,7 +31,7 @@ export type LanguageGroupCreateRequest = {
    */
   languageConfigs: Array<LanguageConfig>;
   /**
-   * Whether a message using the language group to generate a language DTMF menu should skip the agent's current language in the menu.
+   * Whether a custom message using the language group to generate a language DTMF menu should skip the agent's current language in the menu.
    */
   skipCurrentLanguageInMessage: boolean;
 };

package/src/models/components/languagegroupproperties.ts

@@ -5,6 +5,9 @@
 import * as z from "zod";
 import { ClosedEnum } from "../../types/enums.js";
 
+/**
+ * Names of language group fields supported for filtering/sorting on list endpoint.
+ */
 export const LanguageGroupProperties = {
   Name: "name",
   Description: "description",
@@ -12,6 +15,9 @@ export const LanguageGroupProperties = {
   UpdatedAt: "updated_at",
   LastUpdatedBy: "last_updated_by",
 } as const;
+/**
+ * Names of language group fields supported for filtering/sorting on list endpoint.
+ */
 export type LanguageGroupProperties = ClosedEnum<
   typeof LanguageGroupProperties
 >;

package/src/models/components/languagegroupresponse.ts

@@ -21,9 +21,10 @@ import {
 } from "./languagegroupagentinfo.js";
 
 /**
- * A language group is a collection of language, voice, and DTMF configuration that can be
+ * Response model for language group operations.
  *
  * @remarks
+ * A language group is a collection of language, voice, and DTMF configuration that can be
  * linked to an agent to define the languages and voices it supports. For more information, see
  * [Console docs](https://docs.syllable.ai/Resources/LanguageGroups).
  */
@@ -41,7 +42,7 @@ export type LanguageGroupResponse = {
    */
   languageConfigs: Array<LanguageConfig>;
   /**
-   * Whether a message using the language group to generate a language DTMF menu should skip the agent's current language in the menu.
+   * Whether a custom message using the language group to generate a language DTMF menu should skip the agent's current language in the menu.
    */
   skipCurrentLanguageInMessage: boolean;
   /**

package/src/models/components/languagegroupupdaterequest.ts

@@ -14,6 +14,9 @@ import {
   LanguageConfig$outboundSchema,
 } from "./languageconfig.js";
 
+/**
+ * Request model to update an existing language group.
+ */
 export type LanguageGroupUpdateRequest = {
   /**
    * The name of the language group.
@@ -28,7 +31,7 @@ export type LanguageGroupUpdateRequest = {
    */
   languageConfigs: Array<LanguageConfig>;
   /**
-   * Whether a message using the language group to generate a language DTMF menu should skip the agent's current language in the menu.
+   * Whether a custom message using the language group to generate a language DTMF menu should skip the agent's current language in the menu.
    */
   skipCurrentLanguageInMessage: boolean;
   /**

package/src/models/components/listresponseagentresponse.ts

@@ -15,10 +15,25 @@ import {
 } from "./agentresponse.js";
 
 export type ListResponseAgentResponse = {
+  /**
+   * List of items returned from the query
+   */
   items: Array<AgentResponse>;
+  /**
+   * The page number of the results (0-based)
+   */
   page: number;
+  /**
+   * The number of items returned per page
+   */
   pageSize: number;
+  /**
+   * The total number of pages of results given the indicated page size
+   */
   totalPages?: number | null | undefined;
+  /**
+   * The total number of items returned from the query
+   */
   totalCount?: number | null | undefined;
 };
 

package/src/models/components/listresponseavailabletarget.ts

@@ -15,10 +15,25 @@ import {
 } from "./availabletarget.js";
 
 export type ListResponseAvailableTarget = {
+  /**
+   * List of items returned from the query
+   */
   items: Array<AvailableTarget>;
+  /**
+   * The page number of the results (0-based)
+   */
   page: number;
+  /**
+   * The number of items returned per page
+   */
   pageSize: number;
+  /**
+   * The total number of pages of results given the indicated page size
+   */
   totalPages?: number | null | undefined;
+  /**
+   * The total number of items returned from the query
+   */
   totalCount?: number | null | undefined;
 };
 

package/src/models/components/listresponsechannel.ts

@@ -15,10 +15,25 @@ import {
 } from "./channel.js";
 
 export type ListResponseChannel = {
+  /**
+   * List of items returned from the query
+   */
   items: Array<Channel>;
+  /**
+   * The page number of the results (0-based)
+   */
   page: number;
+  /**
+   * The number of items returned per page
+   */
   pageSize: number;
+  /**
+   * The total number of pages of results given the indicated page size
+   */
   totalPages?: number | null | undefined;
+  /**
+   * The total number of items returned from the query
+   */
   totalCount?: number | null | undefined;
 };
 

package/src/models/components/listresponsechanneltargetresponse.ts

@@ -15,10 +15,25 @@ import {
 } from "./channeltargetresponse.js";
 
 export type ListResponseChannelTargetResponse = {
+  /**
+   * List of items returned from the query
+   */
   items: Array<ChannelTargetResponse>;
+  /**
+   * The page number of the results (0-based)
+   */
   page: number;
+  /**
+   * The number of items returned per page
+   */
   pageSize: number;
+  /**
+   * The total number of pages of results given the indicated page size
+   */
   totalPages?: number | null | undefined;
+  /**
+   * The total number of items returned from the query
+   */
   totalCount?: number | null | undefined;
 };
 

package/src/models/components/listresponseconversation.ts

@@ -15,10 +15,25 @@ import {
 } from "./conversation.js";
 
 export type ListResponseConversation = {
+  /**
+   * List of items returned from the query
+   */
   items: Array<Conversation>;
+  /**
+   * The page number of the results (0-based)
+   */
   page: number;
+  /**
+   * The number of items returned per page
+   */
   pageSize: number;
+  /**
+   * The total number of pages of results given the indicated page size
+   */
   totalPages?: number | null | undefined;
+  /**
+   * The total number of items returned from the query
+   */
   totalCount?: number | null | undefined;
 };