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

package/src/models/components/sessionmessage.ts

@@ -26,9 +26,18 @@ import {
 } from "./dialogtoolcall.js";
 
 export type SessionMessage = {
+  /**
+   * Role of dialog
+   */
   role: DialogRole;
   dialog: DialogMessage;
+  /**
+   * Tool calls
+   */
   toolCalls: Array<DialogToolCall>;
+  /**
+   * Message timestamp
+   */
   timestamp: Date;
 };
 

package/src/models/components/sessionproperties.ts

@@ -5,6 +5,9 @@
 import * as z from "zod";
 import { ClosedEnum } from "../../types/enums.js";
 
+/**
+ * Names of session fields supported for filtering/sorting on list endpoint.
+ */
 export const SessionProperties = {
   Timestamp: "timestamp",
   SessionId: "session_id",
@@ -23,6 +26,9 @@ export const SessionProperties = {
   IsLegacy: "is_legacy",
   IsTest: "is_test",
 } as const;
+/**
+ * Names of session fields supported for filtering/sorting on list endpoint.
+ */
 export type SessionProperties = ClosedEnum<typeof SessionProperties>;
 
 /** @internal */

package/src/models/components/sessionsummaryresponse.ts

@@ -8,7 +8,7 @@ import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 /**
- * Summary for a given session.
+ * AI summary information for a given session.
  */
 export type SessionSummaryResponse = {
   /**

package/src/models/components/testmessage.ts

@@ -17,7 +17,7 @@ export type TestMessage = {
    */
   serviceName: string;
   /**
-   * Name of the source of the message, should identify the user, like an email or username
+   * Name of the source of the message - identifies the user, like an email or username.
    */
   source: string;
   /**

package/src/models/components/testmessageresponse.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";
 
+/**
+ * The response from the agent
+ */
 export type Response = {};
 
 /**
@@ -26,6 +29,9 @@ export type TestMessageResponse = {
    * The text of the message that elicited the response
    */
   text?: string | undefined;
+  /**
+   * The response from the agent
+   */
   response?: Response | undefined;
   /**
    * The text of the response

package/src/models/components/toolagentinfo.ts

@@ -12,7 +12,7 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
  */
 export type ToolAgentInfo = {
   /**
-   * The ID of the agent
+   * The internal ID of the agent
    */
   id: number;
   /**

package/src/models/components/toolcreaterequest.ts

@@ -14,6 +14,9 @@ import {
   ToolDefinition$outboundSchema,
 } from "./tooldefinition.js";
 
+/**
+ * Request model to create a tool.
+ */
 export type ToolCreateRequest = {
   /**
    * The name of the tool
@@ -24,7 +27,7 @@ export type ToolCreateRequest = {
    */
   definition: ToolDefinition;
   /**
-   * The service to which this tool belongs
+   * Internal ID of the service to which the tool belongs
    */
   serviceId: number;
 };

package/src/models/components/tooldetailresponse.ts

@@ -27,9 +27,10 @@ import {
 } from "./toolpromptinfo.js";
 
 /**
- * A tool is a function that an agent can call to perform actions like accessing databases,
+ * Response model for tool detail endpoint.
  *
  * @remarks
+ * A tool is a function that an agent can call to perform actions like accessing databases,
  * 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).
@@ -44,15 +45,15 @@ export type ToolDetailResponse = {
    */
   definition: ToolDefinition;
   /**
-   * The service to which this tool belongs
+   * Internal ID of the service to which the tool belongs
    */
   serviceId: number;
   /**
-   * The ID of the tool
+   * The internal ID of the tool
    */
   id: number;
   /**
-   * Update comments
+   * Comments for the most recent edit to the tool.
    */
   lastUpdatedComments?: string | null | undefined;
   /**

package/src/models/components/toolparametertransform.ts

@@ -15,7 +15,7 @@ import {
 } from "./toolparametertransformcondition.js";
 
 /**
- * The action to perform on the tool parameter value: `default` means only set the value (using the `format` field) if the parameter doesn't exist or is empty, `override` means always set the value, and `remove` means remove the parameter value.
+ * The action to perform on the tool parameter value: `default` means only set the value (using the `format` field) if the parameter doesn't exist or is empty, `override` means always set the value," and `remove` means "remove the parameter value."
  */
 export const Action = {
   Default: "default",
@@ -23,7 +23,7 @@ export const Action = {
   Remove: "remove",
 } as const;
 /**
- * The action to perform on the tool parameter value: `default` means only set the value (using the `format` field) if the parameter doesn't exist or is empty, `override` means always set the value, and `remove` means remove the parameter value.
+ * The action to perform on the tool parameter value: `default` means only set the value (using the `format` field) if the parameter doesn't exist or is empty, `override` means always set the value," and `remove` means "remove the parameter value."
  */
 export type Action = ClosedEnum<typeof Action>;
 
@@ -38,7 +38,7 @@ export type Action = ClosedEnum<typeof Action>;
  */
 export type ToolParameterTransform = {
   /**
-   * The action to perform on the tool parameter value: `default` means only set the value (using the `format` field) if the parameter doesn't exist or is empty, `override` means always set the value, and `remove` means remove the parameter value.
+   * The action to perform on the tool parameter value: `default` means only set the value (using the `format` field) if the parameter doesn't exist or is empty, `override` means always set the value," and `remove` means "remove the parameter value."
    */
   action?: Action | undefined;
   /**

package/src/models/components/toolparametertransformcondition.ts

@@ -20,7 +20,7 @@ export type ToolParameterTransformCondition = {
    */
   value: string;
   /**
-   * The operator to use for the comparison.
+   * The operator to use for the comparison. Currently only supports "eq"
    */
   operator?: "eq" | null | undefined;
 };

package/src/models/components/toolproperties.ts

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

package/src/models/components/toolresponse.ts

@@ -27,9 +27,10 @@ import {
 } from "./toolpromptinfo.js";
 
 /**
- * A tool is a function that an agent can call to perform actions like accessing databases,
+ * Response model for tool operations.
  *
  * @remarks
+ * A tool is a function that an agent can call to perform actions like accessing databases,
  * 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).
@@ -44,15 +45,15 @@ export type ToolResponse = {
    */
   definition: ToolDefinition;
   /**
-   * The service to which this tool belongs
+   * Internal ID of the service to which the tool belongs
    */
   serviceId: number;
   /**
-   * The ID of the tool
+   * The internal ID of the tool
    */
   id: number;
   /**
-   * Update comments
+   * Comments for the most recent edit to the tool.
    */
   lastUpdatedComments?: string | null | undefined;
   /**

package/src/models/components/toolresultdata.ts

@@ -9,7 +9,13 @@ import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type ToolResultData = {
+  /**
+   * Tool name
+   */
   toolName: string;
+  /**
+   * Tool result data
+   */
   toolResult?: any | undefined;
 };
 

package/src/models/components/toolupdaterequest.ts

@@ -14,6 +14,9 @@ import {
   ToolDefinition$outboundSchema,
 } from "./tooldefinition.js";
 
+/**
+ * Request model to update an existing tool.
+ */
 export type ToolUpdateRequest = {
   /**
    * The name of the tool
@@ -24,15 +27,15 @@ export type ToolUpdateRequest = {
    */
   definition: ToolDefinition;
   /**
-   * The service to which this tool belongs
+   * Internal ID of the service to which the tool belongs
    */
   serviceId: number;
   /**
-   * The ID of the tool
+   * The internal ID of the tool
    */
   id: number;
   /**
-   * Update comments
+   * Comments for the most recent edit to the tool.
    */
   lastUpdatedComments?: string | null | undefined;
 };

package/src/models/operations/agentlist.ts

@@ -11,7 +11,7 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type AgentListRequest = {
   /**
-   * The page number from which to start (0-indexed)
+   * The page number from which to start (0-based)
    */
   page?: number | null | undefined;
   /**

package/src/models/operations/availabletargets.ts

@@ -11,7 +11,7 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type AvailableTargetsRequest = {
   /**
-   * The page number from which to start (0-indexed)
+   * The page number from which to start (0-based)
    */
   page?: number | null | undefined;
   /**

package/src/models/operations/channelslist.ts

@@ -11,7 +11,7 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type ChannelsListRequest = {
   /**
-   * The page number from which to start (0-indexed)
+   * The page number from which to start (0-based)
    */
   page?: number | null | undefined;
   /**

package/src/models/operations/channeltargetslist.ts

@@ -11,7 +11,7 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type ChannelTargetsListRequest = {
   /**
-   * The page number from which to start (0-indexed)
+   * The page number from which to start (0-based)
    */
   page?: number | null | undefined;
   /**

package/src/models/operations/conversationslist.ts

@@ -11,7 +11,7 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type ConversationsListRequest = {
   /**
-   * The page number from which to start (0-indexed)
+   * The page number from which to start (0-based)
    */
   page?: number | null | undefined;
   /**

package/src/models/operations/custommessageslist.ts

@@ -11,7 +11,7 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type CustomMessagesListRequest = {
   /**
-   * The page number from which to start (0-indexed)
+   * The page number from which to start (0-based)
    */
   page?: number | null | undefined;
   /**

package/src/models/operations/datasourceslist.ts

@@ -11,7 +11,7 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type DataSourcesListRequest = {
   /**
-   * The page number from which to start (0-indexed)
+   * The page number from which to start (0-based)
    */
   page?: number | null | undefined;
   /**

package/src/models/operations/eventslist.ts

@@ -11,7 +11,7 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type EventsListRequest = {
   /**
-   * The page number from which to start (0-indexed)
+   * The page number from which to start (0-based)
    */
   page?: number | null | undefined;
   /**

package/src/models/operations/insightsworkflowlist.ts

@@ -11,7 +11,7 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type InsightsWorkflowListRequest = {
   /**
-   * The page number from which to start (0-indexed)
+   * The page number from which to start (0-based)
    */
   page?: number | null | undefined;
   /**

package/src/models/operations/insighttoollist.ts

@@ -11,7 +11,7 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type InsightToolListRequest = {
   /**
-   * The page number from which to start (0-indexed)
+   * The page number from which to start (0-based)
    */
   page?: number | null | undefined;
   /**

package/src/models/operations/languagegroupslist.ts

@@ -11,7 +11,7 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type LanguageGroupsListRequest = {
   /**
-   * The page number from which to start (0-indexed)
+   * The page number from which to start (0-based)
    */
   page?: number | null | undefined;
   /**

package/src/models/operations/postlistdashboard.ts

@@ -11,7 +11,7 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type PostListDashboardRequest = {
   /**
-   * The page number from which to start (0-indexed)
+   * The page number from which to start (0-based)
    */
   page?: number | null | undefined;
   /**

package/src/models/operations/promptslist.ts

@@ -11,7 +11,7 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type PromptsListRequest = {
   /**
-   * The page number from which to start (0-indexed)
+   * The page number from which to start (0-based)
    */
   page?: number | null | undefined;
   /**

package/src/models/operations/servicelist.ts

@@ -11,7 +11,7 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type ServiceListRequest = {
   /**
-   * The page number from which to start (0-indexed)
+   * The page number from which to start (0-based)
    */
   page?: number | null | undefined;
   /**

package/src/models/operations/sessionlabelslist.ts

@@ -11,7 +11,7 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type SessionLabelsListRequest = {
   /**
-   * The page number from which to start (0-indexed)
+   * The page number from which to start (0-based)
    */
   page?: number | null | undefined;
   /**

package/src/models/operations/sessionslist.ts

@@ -11,7 +11,7 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type SessionsListRequest = {
   /**
-   * The page number from which to start (0-indexed)
+   * The page number from which to start (0-based)
    */
   page?: number | null | undefined;
   /**

package/src/models/operations/toollist.ts

@@ -11,7 +11,7 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type ToolListRequest = {
   /**
-   * The page number from which to start (0-indexed)
+   * The page number from which to start (0-based)
    */
   page?: number | null | undefined;
   /**