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

package/src/models/components/promptupdaterequest.ts

@@ -0,0 +1,132 @@
+/*
+ * 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 {
+  PromptLlmConfig,
+  PromptLlmConfig$inboundSchema,
+  PromptLlmConfig$Outbound,
+  PromptLlmConfig$outboundSchema,
+} from "./promptllmconfig.js";
+
+export type PromptUpdateRequest = {
+  /**
+   * The prompt name
+   */
+  name: string;
+  /**
+   * The description of the prompt
+   */
+  description?: string | null | undefined;
+  /**
+   * The type of the prompt
+   */
+  type: string;
+  /**
+   * The prompt text
+   */
+  context?: string | null | undefined;
+  /**
+   * Names of tools to which the prompt has access
+   */
+  tools?: Array<string> | undefined;
+  llmConfig: PromptLlmConfig;
+  /**
+   * The prompt ID
+   */
+  id: number;
+  /**
+   * The comments for the most recent edit to the prompt
+   */
+  editComments?: string | null | undefined;
+};
+
+/** @internal */
+export const PromptUpdateRequest$inboundSchema: z.ZodType<
+  PromptUpdateRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  name: z.string(),
+  description: z.nullable(z.string()).optional(),
+  type: z.string(),
+  context: z.nullable(z.string()).optional(),
+  tools: z.array(z.string()).optional(),
+  llm_config: PromptLlmConfig$inboundSchema,
+  id: z.number().int(),
+  edit_comments: z.nullable(z.string()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "llm_config": "llmConfig",
+    "edit_comments": "editComments",
+  });
+});
+
+/** @internal */
+export type PromptUpdateRequest$Outbound = {
+  name: string;
+  description?: string | null | undefined;
+  type: string;
+  context?: string | null | undefined;
+  tools?: Array<string> | undefined;
+  llm_config: PromptLlmConfig$Outbound;
+  id: number;
+  edit_comments?: string | null | undefined;
+};
+
+/** @internal */
+export const PromptUpdateRequest$outboundSchema: z.ZodType<
+  PromptUpdateRequest$Outbound,
+  z.ZodTypeDef,
+  PromptUpdateRequest
+> = z.object({
+  name: z.string(),
+  description: z.nullable(z.string()).optional(),
+  type: z.string(),
+  context: z.nullable(z.string()).optional(),
+  tools: z.array(z.string()).optional(),
+  llmConfig: PromptLlmConfig$outboundSchema,
+  id: z.number().int(),
+  editComments: z.nullable(z.string()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    llmConfig: "llm_config",
+    editComments: "edit_comments",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace PromptUpdateRequest$ {
+  /** @deprecated use `PromptUpdateRequest$inboundSchema` instead. */
+  export const inboundSchema = PromptUpdateRequest$inboundSchema;
+  /** @deprecated use `PromptUpdateRequest$outboundSchema` instead. */
+  export const outboundSchema = PromptUpdateRequest$outboundSchema;
+  /** @deprecated use `PromptUpdateRequest$Outbound` instead. */
+  export type Outbound = PromptUpdateRequest$Outbound;
+}
+
+export function promptUpdateRequestToJSON(
+  promptUpdateRequest: PromptUpdateRequest,
+): string {
+  return JSON.stringify(
+    PromptUpdateRequest$outboundSchema.parse(promptUpdateRequest),
+  );
+}
+
+export function promptUpdateRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<PromptUpdateRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PromptUpdateRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PromptUpdateRequest' from JSON`,
+  );
+}

package/src/models/components/security.ts

@@ -4,6 +4,9 @@
 
 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 Security = {
   apiKeyHeader?: string | undefined;
@@ -52,3 +55,17 @@ export namespace Security$ {
   /** @deprecated use `Security$Outbound` instead. */
   export type Outbound = Security$Outbound;
 }
+
+export function securityToJSON(security: Security): string {
+  return JSON.stringify(Security$outboundSchema.parse(security));
+}
+
+export function securityFromJSON(
+  jsonString: string,
+): SafeParseResult<Security, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Security$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Security' from JSON`,
+  );
+}

package/src/models/components/service.ts

@@ -0,0 +1,86 @@
+/*
+ * 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";
+
+/**
+ * A service is a collection of tools.
+ */
+export type Service = {
+  /**
+   * The name of the service
+   */
+  name: string;
+  /**
+   * The description of the service
+   */
+  description: string;
+  /**
+   * The ID of the service
+   */
+  id: number;
+  /**
+   * Names of the tools that belong to the service
+   */
+  tools: Array<string>;
+};
+
+/** @internal */
+export const Service$inboundSchema: z.ZodType<Service, z.ZodTypeDef, unknown> =
+  z.object({
+    name: z.string(),
+    description: z.string(),
+    id: z.number().int(),
+    tools: z.array(z.string()),
+  });
+
+/** @internal */
+export type Service$Outbound = {
+  name: string;
+  description: string;
+  id: number;
+  tools: Array<string>;
+};
+
+/** @internal */
+export const Service$outboundSchema: z.ZodType<
+  Service$Outbound,
+  z.ZodTypeDef,
+  Service
+> = z.object({
+  name: z.string(),
+  description: z.string(),
+  id: z.number().int(),
+  tools: z.array(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 Service$ {
+  /** @deprecated use `Service$inboundSchema` instead. */
+  export const inboundSchema = Service$inboundSchema;
+  /** @deprecated use `Service$outboundSchema` instead. */
+  export const outboundSchema = Service$outboundSchema;
+  /** @deprecated use `Service$Outbound` instead. */
+  export type Outbound = Service$Outbound;
+}
+
+export function serviceToJSON(service: Service): string {
+  return JSON.stringify(Service$outboundSchema.parse(service));
+}
+
+export function serviceFromJSON(
+  jsonString: string,
+): SafeParseResult<Service, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Service$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Service' from JSON`,
+  );
+}

package/src/models/components/servicecreate.ts

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

package/src/models/components/serviceproperties.ts

@@ -0,0 +1,33 @@
+/*
+ * 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",
+} 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/serviceupdate.ts

@@ -0,0 +1,79 @@
+/*
+ * 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 ServiceUpdate = {
+  /**
+   * The name of the service
+   */
+  name: string;
+  /**
+   * The description of the service
+   */
+  description: string;
+  /**
+   * The ID of the service
+   */
+  id: number;
+};
+
+/** @internal */
+export const ServiceUpdate$inboundSchema: z.ZodType<
+  ServiceUpdate,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  name: z.string(),
+  description: z.string(),
+  id: z.number().int(),
+});
+
+/** @internal */
+export type ServiceUpdate$Outbound = {
+  name: string;
+  description: string;
+  id: number;
+};
+
+/** @internal */
+export const ServiceUpdate$outboundSchema: z.ZodType<
+  ServiceUpdate$Outbound,
+  z.ZodTypeDef,
+  ServiceUpdate
+> = z.object({
+  name: z.string(),
+  description: z.string(),
+  id: z.number().int(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ServiceUpdate$ {
+  /** @deprecated use `ServiceUpdate$inboundSchema` instead. */
+  export const inboundSchema = ServiceUpdate$inboundSchema;
+  /** @deprecated use `ServiceUpdate$outboundSchema` instead. */
+  export const outboundSchema = ServiceUpdate$outboundSchema;
+  /** @deprecated use `ServiceUpdate$Outbound` instead. */
+  export type Outbound = ServiceUpdate$Outbound;
+}
+
+export function serviceUpdateToJSON(serviceUpdate: ServiceUpdate): string {
+  return JSON.stringify(ServiceUpdate$outboundSchema.parse(serviceUpdate));
+}
+
+export function serviceUpdateFromJSON(
+  jsonString: string,
+): SafeParseResult<ServiceUpdate, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ServiceUpdate$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ServiceUpdate' from JSON`,
+  );
+}

package/src/models/components/session.ts

@@ -4,24 +4,89 @@
 
 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 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;
 };
 
@@ -36,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(),
@@ -54,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",
@@ -73,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;
@@ -98,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(),
@@ -116,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",
@@ -139,3 +214,17 @@ export namespace Session$ {
   /** @deprecated use `Session$Outbound` instead. */
   export type Outbound = Session$Outbound;
 }
+
+export function sessionToJSON(session: Session): string {
+  return JSON.stringify(Session$outboundSchema.parse(session));
+}
+
+export function sessionFromJSON(
+  jsonString: string,
+): SafeParseResult<Session, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Session$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Session' from JSON`,
+  );
+}

package/src/models/components/sessionaction.ts

@@ -4,11 +4,29 @@
 
 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";
 
+/**
+ * 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;
 };
 
@@ -68,3 +86,17 @@ export namespace SessionAction$ {
   /** @deprecated use `SessionAction$Outbound` instead. */
   export type Outbound = SessionAction$Outbound;
 }
+
+export function sessionActionToJSON(sessionAction: SessionAction): string {
+  return JSON.stringify(SessionAction$outboundSchema.parse(sessionAction));
+}
+
+export function sessionActionFromJSON(
+  jsonString: string,
+): SafeParseResult<SessionAction, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SessionAction$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SessionAction' from JSON`,
+  );
+}

package/src/models/components/sessionlabel.ts

@@ -4,16 +4,43 @@
 
 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 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;
   /**
@@ -90,3 +117,17 @@ export namespace SessionLabel$ {
   /** @deprecated use `SessionLabel$Outbound` instead. */
   export type Outbound = SessionLabel$Outbound;
 }
+
+export function sessionLabelToJSON(sessionLabel: SessionLabel): string {
+  return JSON.stringify(SessionLabel$outboundSchema.parse(sessionLabel));
+}
+
+export function sessionLabelFromJSON(
+  jsonString: string,
+): SafeParseResult<SessionLabel, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SessionLabel$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SessionLabel' from JSON`,
+  );
+}