syllable-sdk 0.1.0-alpha.4 → 0.1.0-alpha.40

package/src/models/components/servicecreaterequest.ts

@@ -0,0 +1,76 @@
+/*
+ * 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 ServiceCreateRequest = {
+  /**
+   * The name of the service
+   */
+  name: string;
+  /**
+   * The description of the service
+   */
+  description: string;
+};
+
+/** @internal */
+export const ServiceCreateRequest$inboundSchema: z.ZodType<
+  ServiceCreateRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  name: z.string(),
+  description: z.string(),
+});
+
+/** @internal */
+export type ServiceCreateRequest$Outbound = {
+  name: string;
+  description: string;
+};
+
+/** @internal */
+export const ServiceCreateRequest$outboundSchema: z.ZodType<
+  ServiceCreateRequest$Outbound,
+  z.ZodTypeDef,
+  ServiceCreateRequest
+> = z.object({
+  name: z.string(),
+  description: 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 ServiceCreateRequest$ {
+  /** @deprecated use `ServiceCreateRequest$inboundSchema` instead. */
+  export const inboundSchema = ServiceCreateRequest$inboundSchema;
+  /** @deprecated use `ServiceCreateRequest$outboundSchema` instead. */
+  export const outboundSchema = ServiceCreateRequest$outboundSchema;
+  /** @deprecated use `ServiceCreateRequest$Outbound` instead. */
+  export type Outbound = ServiceCreateRequest$Outbound;
+}
+
+export function serviceCreateRequestToJSON(
+  serviceCreateRequest: ServiceCreateRequest,
+): string {
+  return JSON.stringify(
+    ServiceCreateRequest$outboundSchema.parse(serviceCreateRequest),
+  );
+}
+
+export function serviceCreateRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<ServiceCreateRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ServiceCreateRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ServiceCreateRequest' from JSON`,
+  );
+}

package/src/models/components/serviceproperties.ts

@@ -0,0 +1,36 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { ClosedEnum } from "../../types/enums.js";
+
+export const ServiceProperties = {
+  Id: "id",
+  Name: "name",
+  Description: "description",
+  UpdatedAt: "updated_at",
+  LastUpdatedBy: "last_updated_by",
+} as const;
+export type ServiceProperties = ClosedEnum<typeof ServiceProperties>;
+
+/** @internal */
+export const ServiceProperties$inboundSchema: z.ZodNativeEnum<
+  typeof ServiceProperties
+> = z.nativeEnum(ServiceProperties);
+
+/** @internal */
+export const ServiceProperties$outboundSchema: z.ZodNativeEnum<
+  typeof ServiceProperties
+> = ServiceProperties$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ServiceProperties$ {
+  /** @deprecated use `ServiceProperties$inboundSchema` instead. */
+  export const inboundSchema = ServiceProperties$inboundSchema;
+  /** @deprecated use `ServiceProperties$outboundSchema` instead. */
+  export const outboundSchema = ServiceProperties$outboundSchema;
+}

package/src/models/components/serviceresponse.ts

@@ -0,0 +1,127 @@
+/*
+ * 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";
+
+/**
+ * A service is a collection of tools.
+ */
+export type ServiceResponse = {
+  /**
+   * The name of the service
+   */
+  name: string;
+  /**
+   * The description of the service
+   */
+  description: string;
+  /**
+   * The ID of the service
+   */
+  id: number;
+  /**
+   * Update comments
+   */
+  lastUpdatedComments?: string | null | undefined;
+  /**
+   * The timestamp of the most recent update to the service
+   */
+  lastUpdated: Date;
+  /**
+   * The email of the user who last updated the service
+   */
+  lastUpdatedBy: string;
+  /**
+   * Names of tools that belong to the service
+   */
+  tools: Array<string>;
+};
+
+/** @internal */
+export const ServiceResponse$inboundSchema: z.ZodType<
+  ServiceResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  name: z.string(),
+  description: z.string(),
+  id: z.number().int(),
+  last_updated_comments: z.nullable(z.string()).optional(),
+  last_updated: z.string().datetime({ offset: true }).transform(v =>
+    new Date(v)
+  ),
+  last_updated_by: z.string(),
+  tools: z.array(z.string()),
+}).transform((v) => {
+  return remap$(v, {
+    "last_updated_comments": "lastUpdatedComments",
+    "last_updated": "lastUpdated",
+    "last_updated_by": "lastUpdatedBy",
+  });
+});
+
+/** @internal */
+export type ServiceResponse$Outbound = {
+  name: string;
+  description: string;
+  id: number;
+  last_updated_comments?: string | null | undefined;
+  last_updated: string;
+  last_updated_by: string;
+  tools: Array<string>;
+};
+
+/** @internal */
+export const ServiceResponse$outboundSchema: z.ZodType<
+  ServiceResponse$Outbound,
+  z.ZodTypeDef,
+  ServiceResponse
+> = z.object({
+  name: z.string(),
+  description: z.string(),
+  id: z.number().int(),
+  lastUpdatedComments: z.nullable(z.string()).optional(),
+  lastUpdated: z.date().transform(v => v.toISOString()),
+  lastUpdatedBy: z.string(),
+  tools: z.array(z.string()),
+}).transform((v) => {
+  return remap$(v, {
+    lastUpdatedComments: "last_updated_comments",
+    lastUpdated: "last_updated",
+    lastUpdatedBy: "last_updated_by",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ServiceResponse$ {
+  /** @deprecated use `ServiceResponse$inboundSchema` instead. */
+  export const inboundSchema = ServiceResponse$inboundSchema;
+  /** @deprecated use `ServiceResponse$outboundSchema` instead. */
+  export const outboundSchema = ServiceResponse$outboundSchema;
+  /** @deprecated use `ServiceResponse$Outbound` instead. */
+  export type Outbound = ServiceResponse$Outbound;
+}
+
+export function serviceResponseToJSON(
+  serviceResponse: ServiceResponse,
+): string {
+  return JSON.stringify(ServiceResponse$outboundSchema.parse(serviceResponse));
+}
+
+export function serviceResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<ServiceResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ServiceResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ServiceResponse' from JSON`,
+  );
+}

package/src/models/components/serviceupdaterequest.ts

@@ -0,0 +1,99 @@
+/*
+ * 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 ServiceUpdateRequest = {
+  /**
+   * The name of the service
+   */
+  name: string;
+  /**
+   * The description of the service
+   */
+  description: string;
+  /**
+   * The ID of the service
+   */
+  id: number;
+  /**
+   * Update comments
+   */
+  lastUpdatedComments?: string | null | undefined;
+};
+
+/** @internal */
+export const ServiceUpdateRequest$inboundSchema: z.ZodType<
+  ServiceUpdateRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  name: z.string(),
+  description: z.string(),
+  id: z.number().int(),
+  last_updated_comments: z.nullable(z.string()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "last_updated_comments": "lastUpdatedComments",
+  });
+});
+
+/** @internal */
+export type ServiceUpdateRequest$Outbound = {
+  name: string;
+  description: string;
+  id: number;
+  last_updated_comments?: string | null | undefined;
+};
+
+/** @internal */
+export const ServiceUpdateRequest$outboundSchema: z.ZodType<
+  ServiceUpdateRequest$Outbound,
+  z.ZodTypeDef,
+  ServiceUpdateRequest
+> = z.object({
+  name: z.string(),
+  description: z.string(),
+  id: z.number().int(),
+  lastUpdatedComments: z.nullable(z.string()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    lastUpdatedComments: "last_updated_comments",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ServiceUpdateRequest$ {
+  /** @deprecated use `ServiceUpdateRequest$inboundSchema` instead. */
+  export const inboundSchema = ServiceUpdateRequest$inboundSchema;
+  /** @deprecated use `ServiceUpdateRequest$outboundSchema` instead. */
+  export const outboundSchema = ServiceUpdateRequest$outboundSchema;
+  /** @deprecated use `ServiceUpdateRequest$Outbound` instead. */
+  export type Outbound = ServiceUpdateRequest$Outbound;
+}
+
+export function serviceUpdateRequestToJSON(
+  serviceUpdateRequest: ServiceUpdateRequest,
+): string {
+  return JSON.stringify(
+    ServiceUpdateRequest$outboundSchema.parse(serviceUpdateRequest),
+  );
+}
+
+export function serviceUpdateRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<ServiceUpdateRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ServiceUpdateRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ServiceUpdateRequest' from JSON`,
+  );
+}

package/src/models/components/session.ts

@@ -8,23 +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;
 };
 
@@ -39,8 +101,10 @@ export const Session$inboundSchema: z.ZodType<Session, z.ZodTypeDef, unknown> =
     channel_manager_service: z.nullable(z.string()).optional(),
     channel_manager_type: z.nullable(z.string()).optional(),
     channel_manager_sid: z.nullable(z.string()).optional(),
+    agent_id: z.nullable(z.string()).optional(),
     agent_name: z.nullable(z.string()).optional(),
     agent_type: z.nullable(z.string()).optional(),
+    agent_timezone: z.nullable(z.string()).optional(),
     prompt_id: z.nullable(z.string()).optional(),
     prompt_name: z.nullable(z.string()).optional(),
     prompt_version: z.nullable(z.string()).optional(),
@@ -57,8 +121,10 @@ export const Session$inboundSchema: z.ZodType<Session, z.ZodTypeDef, unknown> =
       "channel_manager_service": "channelManagerService",
       "channel_manager_type": "channelManagerType",
       "channel_manager_sid": "channelManagerSid",
+      "agent_id": "agentId",
       "agent_name": "agentName",
       "agent_type": "agentType",
+      "agent_timezone": "agentTimezone",
       "prompt_id": "promptId",
       "prompt_name": "promptName",
       "prompt_version": "promptVersion",
@@ -76,8 +142,10 @@ export type Session$Outbound = {
   channel_manager_service?: string | null | undefined;
   channel_manager_type?: string | null | undefined;
   channel_manager_sid?: string | null | undefined;
+  agent_id?: string | null | undefined;
   agent_name?: string | null | undefined;
   agent_type?: string | null | undefined;
+  agent_timezone?: string | null | undefined;
   prompt_id?: string | null | undefined;
   prompt_name?: string | null | undefined;
   prompt_version?: string | null | undefined;
@@ -101,8 +169,10 @@ export const Session$outboundSchema: z.ZodType<
   channelManagerService: z.nullable(z.string()).optional(),
   channelManagerType: z.nullable(z.string()).optional(),
   channelManagerSid: z.nullable(z.string()).optional(),
+  agentId: z.nullable(z.string()).optional(),
   agentName: z.nullable(z.string()).optional(),
   agentType: z.nullable(z.string()).optional(),
+  agentTimezone: z.nullable(z.string()).optional(),
   promptId: z.nullable(z.string()).optional(),
   promptName: z.nullable(z.string()).optional(),
   promptVersion: z.nullable(z.string()).optional(),
@@ -119,8 +189,10 @@ export const Session$outboundSchema: z.ZodType<
     channelManagerService: "channel_manager_service",
     channelManagerType: "channel_manager_type",
     channelManagerSid: "channel_manager_sid",
+    agentId: "agent_id",
     agentName: "agent_name",
     agentType: "agent_type",
+    agentTimezone: "agent_timezone",
     promptId: "prompt_id",
     promptName: "prompt_name",
     promptVersion: "prompt_version",

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/sessionproperties.ts

@@ -19,6 +19,7 @@ export const SessionProperties = {
   PromptName: "prompt_name",
   Source: "source",
   Target: "target",
+  Duration: "duration",
   IsLegacy: "is_legacy",
   IsTest: "is_test",
 } as const;

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

@@ -0,0 +1,38 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+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 */
+export const SttProvider$inboundSchema: z.ZodNativeEnum<typeof SttProvider> = z
+  .nativeEnum(SttProvider);
+
+/** @internal */
+export const SttProvider$outboundSchema: z.ZodNativeEnum<typeof SttProvider> =
+  SttProvider$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace SttProvider$ {
+  /** @deprecated use `SttProvider$inboundSchema` instead. */
+  export const inboundSchema = SttProvider$inboundSchema;
+  /** @deprecated use `SttProvider$outboundSchema` instead. */
+  export const outboundSchema = SttProvider$outboundSchema;
+}