syllable-sdk 0.0.9

package/src/models/components/schemasbubblegumv2toolstool.ts

@@ -0,0 +1,93 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { remap as remap$ } from "../../lib/primitives.js";
+import {
+  ToolDefinition,
+  ToolDefinition$inboundSchema,
+  ToolDefinition$Outbound,
+  ToolDefinition$outboundSchema,
+} from "./tooldefinition.js";
+
+/**
+ * SchemasBubblegumV2ToolsTool
+ */
+export type SchemasBubblegumV2ToolsTool = {
+  /**
+   * The name of the tool
+   */
+  name: string;
+  /**
+   * The definition of the tool
+   */
+  definition?: ToolDefinition | null | undefined;
+  /**
+   * The service this tool belongs to
+   */
+  serviceId: number;
+  /**
+   * The ID of the tool
+   */
+  id: number;
+  serviceName?: string | null | undefined;
+};
+
+/** @internal */
+export const SchemasBubblegumV2ToolsTool$inboundSchema: z.ZodType<
+  SchemasBubblegumV2ToolsTool,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  name: z.string(),
+  definition: z.nullable(ToolDefinition$inboundSchema).optional(),
+  service_id: z.number().int(),
+  id: z.number().int(),
+  service_name: z.nullable(z.string()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "service_id": "serviceId",
+    "service_name": "serviceName",
+  });
+});
+
+/** @internal */
+export type SchemasBubblegumV2ToolsTool$Outbound = {
+  name: string;
+  definition?: ToolDefinition$Outbound | null | undefined;
+  service_id: number;
+  id: number;
+  service_name?: string | null | undefined;
+};
+
+/** @internal */
+export const SchemasBubblegumV2ToolsTool$outboundSchema: z.ZodType<
+  SchemasBubblegumV2ToolsTool$Outbound,
+  z.ZodTypeDef,
+  SchemasBubblegumV2ToolsTool
+> = z.object({
+  name: z.string(),
+  definition: z.nullable(ToolDefinition$outboundSchema).optional(),
+  serviceId: z.number().int(),
+  id: z.number().int(),
+  serviceName: z.nullable(z.string()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    serviceId: "service_id",
+    serviceName: "service_name",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace SchemasBubblegumV2ToolsTool$ {
+  /** @deprecated use `SchemasBubblegumV2ToolsTool$inboundSchema` instead. */
+  export const inboundSchema = SchemasBubblegumV2ToolsTool$inboundSchema;
+  /** @deprecated use `SchemasBubblegumV2ToolsTool$outboundSchema` instead. */
+  export const outboundSchema = SchemasBubblegumV2ToolsTool$outboundSchema;
+  /** @deprecated use `SchemasBubblegumV2ToolsTool$Outbound` instead. */
+  export type Outbound = SchemasBubblegumV2ToolsTool$Outbound;
+}

package/src/models/components/schemascortexv1toolstool.ts

@@ -0,0 +1,64 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import {
+  FunctionT,
+  FunctionT$inboundSchema,
+  FunctionT$Outbound,
+  FunctionT$outboundSchema,
+} from "./function.js";
+
+/**
+ * A tool definition to be used by the OpenAI API.
+ */
+export type SchemasCortexV1ToolsTool = {
+  /**
+   * Always `function`.
+   */
+  type?: string | null | undefined;
+  /**
+   * The tool definition including the JSON Schema of its parameters.
+   */
+  function: FunctionT;
+};
+
+/** @internal */
+export const SchemasCortexV1ToolsTool$inboundSchema: z.ZodType<
+  SchemasCortexV1ToolsTool,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  type: z.nullable(z.string()).optional(),
+  function: FunctionT$inboundSchema,
+});
+
+/** @internal */
+export type SchemasCortexV1ToolsTool$Outbound = {
+  type?: string | null | undefined;
+  function: FunctionT$Outbound;
+};
+
+/** @internal */
+export const SchemasCortexV1ToolsTool$outboundSchema: z.ZodType<
+  SchemasCortexV1ToolsTool$Outbound,
+  z.ZodTypeDef,
+  SchemasCortexV1ToolsTool
+> = z.object({
+  type: z.nullable(z.string()).optional(),
+  function: FunctionT$outboundSchema,
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace SchemasCortexV1ToolsTool$ {
+  /** @deprecated use `SchemasCortexV1ToolsTool$inboundSchema` instead. */
+  export const inboundSchema = SchemasCortexV1ToolsTool$inboundSchema;
+  /** @deprecated use `SchemasCortexV1ToolsTool$outboundSchema` instead. */
+  export const outboundSchema = SchemasCortexV1ToolsTool$outboundSchema;
+  /** @deprecated use `SchemasCortexV1ToolsTool$Outbound` instead. */
+  export type Outbound = SchemasCortexV1ToolsTool$Outbound;
+}

package/src/models/components/security.ts

@@ -0,0 +1,54 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { remap as remap$ } from "../../lib/primitives.js";
+
+export type Security = {
+  apiKeyHeader?: string | undefined;
+};
+
+/** @internal */
+export const Security$inboundSchema: z.ZodType<
+  Security,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  APIKeyHeader: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "APIKeyHeader": "apiKeyHeader",
+  });
+});
+
+/** @internal */
+export type Security$Outbound = {
+  APIKeyHeader?: string | undefined;
+};
+
+/** @internal */
+export const Security$outboundSchema: z.ZodType<
+  Security$Outbound,
+  z.ZodTypeDef,
+  Security
+> = z.object({
+  apiKeyHeader: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    apiKeyHeader: "APIKeyHeader",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace Security$ {
+  /** @deprecated use `Security$inboundSchema` instead. */
+  export const inboundSchema = Security$inboundSchema;
+  /** @deprecated use `Security$outboundSchema` instead. */
+  export const outboundSchema = Security$outboundSchema;
+  /** @deprecated use `Security$Outbound` instead. */
+  export type Outbound = Security$Outbound;
+}

package/src/models/components/session.ts

@@ -0,0 +1,101 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { remap as remap$ } from "../../lib/primitives.js";
+
+export type Session = {
+  timestamp: Date;
+  sessionId?: string | null | undefined;
+  conversationId?: string | null | undefined;
+  channelManagerService?: string | null | undefined;
+  channelManagerType?: string | null | undefined;
+  channelManagerSid?: string | null | undefined;
+  source?: string | null | undefined;
+  target?: string | null | undefined;
+  isLegacy?: boolean | null | undefined;
+  isTest?: boolean | null | undefined;
+};
+
+/** @internal */
+export const Session$inboundSchema: z.ZodType<Session, z.ZodTypeDef, unknown> =
+  z.object({
+    timestamp: z.string().datetime({ offset: true }).transform(v =>
+      new Date(v)
+    ),
+    session_id: z.nullable(z.string()).optional(),
+    conversation_id: z.nullable(z.string()).optional(),
+    channel_manager_service: z.nullable(z.string()).optional(),
+    channel_manager_type: z.nullable(z.string()).optional(),
+    channel_manager_sid: z.nullable(z.string()).optional(),
+    source: z.nullable(z.string()).optional(),
+    target: z.nullable(z.string()).optional(),
+    is_legacy: z.nullable(z.boolean()).optional(),
+    is_test: z.nullable(z.boolean()).optional(),
+  }).transform((v) => {
+    return remap$(v, {
+      "session_id": "sessionId",
+      "conversation_id": "conversationId",
+      "channel_manager_service": "channelManagerService",
+      "channel_manager_type": "channelManagerType",
+      "channel_manager_sid": "channelManagerSid",
+      "is_legacy": "isLegacy",
+      "is_test": "isTest",
+    });
+  });
+
+/** @internal */
+export type Session$Outbound = {
+  timestamp: string;
+  session_id?: string | null | undefined;
+  conversation_id?: string | null | undefined;
+  channel_manager_service?: string | null | undefined;
+  channel_manager_type?: string | null | undefined;
+  channel_manager_sid?: string | null | undefined;
+  source?: string | null | undefined;
+  target?: string | null | undefined;
+  is_legacy?: boolean | null | undefined;
+  is_test?: boolean | null | undefined;
+};
+
+/** @internal */
+export const Session$outboundSchema: z.ZodType<
+  Session$Outbound,
+  z.ZodTypeDef,
+  Session
+> = z.object({
+  timestamp: z.date().transform(v => v.toISOString()),
+  sessionId: z.nullable(z.string()).optional(),
+  conversationId: z.nullable(z.string()).optional(),
+  channelManagerService: z.nullable(z.string()).optional(),
+  channelManagerType: z.nullable(z.string()).optional(),
+  channelManagerSid: z.nullable(z.string()).optional(),
+  source: z.nullable(z.string()).optional(),
+  target: z.nullable(z.string()).optional(),
+  isLegacy: z.nullable(z.boolean()).optional(),
+  isTest: z.nullable(z.boolean()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    sessionId: "session_id",
+    conversationId: "conversation_id",
+    channelManagerService: "channel_manager_service",
+    channelManagerType: "channel_manager_type",
+    channelManagerSid: "channel_manager_sid",
+    isLegacy: "is_legacy",
+    isTest: "is_test",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace Session$ {
+  /** @deprecated use `Session$inboundSchema` instead. */
+  export const inboundSchema = Session$inboundSchema;
+  /** @deprecated use `Session$outboundSchema` instead. */
+  export const outboundSchema = Session$outboundSchema;
+  /** @deprecated use `Session$Outbound` instead. */
+  export type Outbound = Session$Outbound;
+}

package/src/models/components/sessionproperties.ts

@@ -0,0 +1,41 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { ClosedEnum } from "../../types/enums.js";
+
+export const SessionProperties = {
+  Timestamp: "timestamp",
+  SessionId: "session_id",
+  ConversationId: "conversation_id",
+  ChannelManagerService: "channel_manager_service",
+  ChannelManagerType: "channel_manager_type",
+  ChannelManagerSid: "channel_manager_sid",
+  Source: "source",
+  Target: "target",
+  IsLegacy: "is_legacy",
+  IsTest: "is_test",
+} as const;
+export type SessionProperties = ClosedEnum<typeof SessionProperties>;
+
+/** @internal */
+export const SessionProperties$inboundSchema: z.ZodNativeEnum<
+  typeof SessionProperties
+> = z.nativeEnum(SessionProperties);
+
+/** @internal */
+export const SessionProperties$outboundSchema: z.ZodNativeEnum<
+  typeof SessionProperties
+> = SessionProperties$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace SessionProperties$ {
+  /** @deprecated use `SessionProperties$inboundSchema` instead. */
+  export const inboundSchema = SessionProperties$inboundSchema;
+  /** @deprecated use `SessionProperties$outboundSchema` instead. */
+  export const outboundSchema = SessionProperties$outboundSchema;
+}

package/src/models/components/testmessage.ts

@@ -0,0 +1,86 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { remap as remap$ } from "../../lib/primitives.js";
+
+export type TestMessage = {
+  /**
+   * Name of the service producing the message
+   */
+  serviceName: string;
+  /**
+   * Name of the source of the message, should identify the user, like an email or username
+   */
+  source: string;
+  text?: string | null | undefined;
+  testId: string;
+  agentId: string;
+  orgName: string;
+};
+
+/** @internal */
+export const TestMessage$inboundSchema: z.ZodType<
+  TestMessage,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  service_name: z.string(),
+  source: z.string(),
+  text: z.nullable(z.string()).optional(),
+  test_id: z.string(),
+  agent_id: z.string(),
+  org_name: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "service_name": "serviceName",
+    "test_id": "testId",
+    "agent_id": "agentId",
+    "org_name": "orgName",
+  });
+});
+
+/** @internal */
+export type TestMessage$Outbound = {
+  service_name: string;
+  source: string;
+  text?: string | null | undefined;
+  test_id: string;
+  agent_id: string;
+  org_name: string;
+};
+
+/** @internal */
+export const TestMessage$outboundSchema: z.ZodType<
+  TestMessage$Outbound,
+  z.ZodTypeDef,
+  TestMessage
+> = z.object({
+  serviceName: z.string(),
+  source: z.string(),
+  text: z.nullable(z.string()).optional(),
+  testId: z.string(),
+  agentId: z.string(),
+  orgName: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    serviceName: "service_name",
+    testId: "test_id",
+    agentId: "agent_id",
+    orgName: "org_name",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace TestMessage$ {
+  /** @deprecated use `TestMessage$inboundSchema` instead. */
+  export const inboundSchema = TestMessage$inboundSchema;
+  /** @deprecated use `TestMessage$outboundSchema` instead. */
+  export const outboundSchema = TestMessage$outboundSchema;
+  /** @deprecated use `TestMessage$Outbound` instead. */
+  export type Outbound = TestMessage$Outbound;
+}

package/src/models/components/testmessageresponse.ts

@@ -0,0 +1,100 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { remap as remap$ } from "../../lib/primitives.js";
+
+export type Response = {};
+
+export type TestMessageResponse = {
+  testId: string;
+  agentId: string;
+  text: string;
+  response?: Response | undefined;
+};
+
+/** @internal */
+export const Response$inboundSchema: z.ZodType<
+  Response,
+  z.ZodTypeDef,
+  unknown
+> = z.object({});
+
+/** @internal */
+export type Response$Outbound = {};
+
+/** @internal */
+export const Response$outboundSchema: z.ZodType<
+  Response$Outbound,
+  z.ZodTypeDef,
+  Response
+> = 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 Response$ {
+  /** @deprecated use `Response$inboundSchema` instead. */
+  export const inboundSchema = Response$inboundSchema;
+  /** @deprecated use `Response$outboundSchema` instead. */
+  export const outboundSchema = Response$outboundSchema;
+  /** @deprecated use `Response$Outbound` instead. */
+  export type Outbound = Response$Outbound;
+}
+
+/** @internal */
+export const TestMessageResponse$inboundSchema: z.ZodType<
+  TestMessageResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  test_id: z.string(),
+  agent_id: z.string(),
+  text: z.string(),
+  response: z.lazy(() => Response$inboundSchema).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "test_id": "testId",
+    "agent_id": "agentId",
+  });
+});
+
+/** @internal */
+export type TestMessageResponse$Outbound = {
+  test_id: string;
+  agent_id: string;
+  text: string;
+  response?: Response$Outbound | undefined;
+};
+
+/** @internal */
+export const TestMessageResponse$outboundSchema: z.ZodType<
+  TestMessageResponse$Outbound,
+  z.ZodTypeDef,
+  TestMessageResponse
+> = z.object({
+  testId: z.string(),
+  agentId: z.string(),
+  text: z.string(),
+  response: z.lazy(() => Response$outboundSchema).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    testId: "test_id",
+    agentId: "agent_id",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace TestMessageResponse$ {
+  /** @deprecated use `TestMessageResponse$inboundSchema` instead. */
+  export const inboundSchema = TestMessageResponse$inboundSchema;
+  /** @deprecated use `TestMessageResponse$outboundSchema` instead. */
+  export const outboundSchema = TestMessageResponse$outboundSchema;
+  /** @deprecated use `TestMessageResponse$Outbound` instead. */
+  export type Outbound = TestMessageResponse$Outbound;
+}

package/src/models/components/tooldefinition.ts

@@ -0,0 +1,114 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import {
+  Defaults,
+  Defaults$inboundSchema,
+  Defaults$Outbound,
+  Defaults$outboundSchema,
+} from "./defaults.js";
+import {
+  HttpEndpoint,
+  HttpEndpoint$inboundSchema,
+  HttpEndpoint$Outbound,
+  HttpEndpoint$outboundSchema,
+} from "./httpendpoint.js";
+import {
+  SchemasCortexV1ToolsTool,
+  SchemasCortexV1ToolsTool$inboundSchema,
+  SchemasCortexV1ToolsTool$Outbound,
+  SchemasCortexV1ToolsTool$outboundSchema,
+} from "./schemascortexv1toolstool.js";
+
+export type Result = {};
+
+/**
+ * A tool that can be called from GPT during the conversation.  The tool can result in one of the following actions depending on the `type` field: - `action`:   An `ActionRequest` to return to Bubblegum in `GetResponseResponse`. - `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 GPT 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"     }   } } ```  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}"       }     }   } } ```
+ */
+export type ToolDefinition = {
+  type?: string | null | undefined;
+  /**
+   * The tool definition to be used by the OpenAI API.
+   */
+  tool: SchemasCortexV1ToolsTool;
+  endpoint?: HttpEndpoint | null | undefined;
+  defaults?: Defaults | null | undefined;
+  result?: Result | null | undefined;
+};
+
+/** @internal */
+export const Result$inboundSchema: z.ZodType<Result, z.ZodTypeDef, unknown> = z
+  .object({});
+
+/** @internal */
+export type Result$Outbound = {};
+
+/** @internal */
+export const Result$outboundSchema: z.ZodType<
+  Result$Outbound,
+  z.ZodTypeDef,
+  Result
+> = 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 Result$ {
+  /** @deprecated use `Result$inboundSchema` instead. */
+  export const inboundSchema = Result$inboundSchema;
+  /** @deprecated use `Result$outboundSchema` instead. */
+  export const outboundSchema = Result$outboundSchema;
+  /** @deprecated use `Result$Outbound` instead. */
+  export type Outbound = Result$Outbound;
+}
+
+/** @internal */
+export const ToolDefinition$inboundSchema: z.ZodType<
+  ToolDefinition,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  type: z.nullable(z.string()).optional(),
+  tool: SchemasCortexV1ToolsTool$inboundSchema,
+  endpoint: z.nullable(HttpEndpoint$inboundSchema).optional(),
+  defaults: z.nullable(Defaults$inboundSchema).optional(),
+  result: z.nullable(z.lazy(() => Result$inboundSchema)).optional(),
+});
+
+/** @internal */
+export type ToolDefinition$Outbound = {
+  type?: string | null | undefined;
+  tool: SchemasCortexV1ToolsTool$Outbound;
+  endpoint?: HttpEndpoint$Outbound | null | undefined;
+  defaults?: Defaults$Outbound | null | undefined;
+  result?: Result$Outbound | null | undefined;
+};
+
+/** @internal */
+export const ToolDefinition$outboundSchema: z.ZodType<
+  ToolDefinition$Outbound,
+  z.ZodTypeDef,
+  ToolDefinition
+> = z.object({
+  type: z.nullable(z.string()).optional(),
+  tool: SchemasCortexV1ToolsTool$outboundSchema,
+  endpoint: z.nullable(HttpEndpoint$outboundSchema).optional(),
+  defaults: z.nullable(Defaults$outboundSchema).optional(),
+  result: z.nullable(z.lazy(() => Result$outboundSchema)).optional(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ToolDefinition$ {
+  /** @deprecated use `ToolDefinition$inboundSchema` instead. */
+  export const inboundSchema = ToolDefinition$inboundSchema;
+  /** @deprecated use `ToolDefinition$outboundSchema` instead. */
+  export const outboundSchema = ToolDefinition$outboundSchema;
+  /** @deprecated use `ToolDefinition$Outbound` instead. */
+  export type Outbound = ToolDefinition$Outbound;
+}