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

package/src/models/components/custommessagerule.ts

@@ -0,0 +1,129 @@
+/*
+ * 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 {
+  DayOfWeek,
+  DayOfWeek$inboundSchema,
+  DayOfWeek$outboundSchema,
+} from "./dayofweek.js";
+
+export type CustomMessageRule = {
+  /**
+   * The description of the rule
+   */
+  description: string;
+  /**
+   * The start of the time range for the rule in 24-hour format hh:mm (should be null for "all day" cases)
+   */
+  timeRangeStart?: string | null | undefined;
+  /**
+   * The end of the time range for the rule in 24-hour format hh:mm (should be null for "all day" cases)
+   */
+  timeRangeEnd?: string | null | undefined;
+  /**
+   * The date for the rule in YYYY-MM-DD format
+   */
+  date?: string | null | undefined;
+  /**
+   * The days of the week for the rule
+   */
+  daysOfWeek?: Array<DayOfWeek> | null | undefined;
+  /**
+   * Whether the rule logic should be inverted (i.e. "not")
+   */
+  invert: boolean;
+  /**
+   * Message text associated with the rule
+   */
+  text: string;
+};
+
+/** @internal */
+export const CustomMessageRule$inboundSchema: z.ZodType<
+  CustomMessageRule,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  description: z.string(),
+  time_range_start: z.nullable(z.string()).optional(),
+  time_range_end: z.nullable(z.string()).optional(),
+  date: z.nullable(z.string()).optional(),
+  days_of_week: z.nullable(z.array(DayOfWeek$inboundSchema)).optional(),
+  invert: z.boolean(),
+  text: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "time_range_start": "timeRangeStart",
+    "time_range_end": "timeRangeEnd",
+    "days_of_week": "daysOfWeek",
+  });
+});
+
+/** @internal */
+export type CustomMessageRule$Outbound = {
+  description: string;
+  time_range_start?: string | null | undefined;
+  time_range_end?: string | null | undefined;
+  date?: string | null | undefined;
+  days_of_week?: Array<string> | null | undefined;
+  invert: boolean;
+  text: string;
+};
+
+/** @internal */
+export const CustomMessageRule$outboundSchema: z.ZodType<
+  CustomMessageRule$Outbound,
+  z.ZodTypeDef,
+  CustomMessageRule
+> = z.object({
+  description: z.string(),
+  timeRangeStart: z.nullable(z.string()).optional(),
+  timeRangeEnd: z.nullable(z.string()).optional(),
+  date: z.nullable(z.string()).optional(),
+  daysOfWeek: z.nullable(z.array(DayOfWeek$outboundSchema)).optional(),
+  invert: z.boolean(),
+  text: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    timeRangeStart: "time_range_start",
+    timeRangeEnd: "time_range_end",
+    daysOfWeek: "days_of_week",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace CustomMessageRule$ {
+  /** @deprecated use `CustomMessageRule$inboundSchema` instead. */
+  export const inboundSchema = CustomMessageRule$inboundSchema;
+  /** @deprecated use `CustomMessageRule$outboundSchema` instead. */
+  export const outboundSchema = CustomMessageRule$outboundSchema;
+  /** @deprecated use `CustomMessageRule$Outbound` instead. */
+  export type Outbound = CustomMessageRule$Outbound;
+}
+
+export function customMessageRuleToJSON(
+  customMessageRule: CustomMessageRule,
+): string {
+  return JSON.stringify(
+    CustomMessageRule$outboundSchema.parse(customMessageRule),
+  );
+}
+
+export function customMessageRuleFromJSON(
+  jsonString: string,
+): SafeParseResult<CustomMessageRule, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CustomMessageRule$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CustomMessageRule' from JSON`,
+  );
+}

package/src/models/components/custommessageupdaterequest.ts

@@ -0,0 +1,107 @@
+/*
+ * 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";
+import {
+  CustomMessageRule,
+  CustomMessageRule$inboundSchema,
+  CustomMessageRule$Outbound,
+  CustomMessageRule$outboundSchema,
+} from "./custommessagerule.js";
+
+export type CustomMessageUpdateRequest = {
+  /**
+   * The name of the custom message
+   */
+  name: string;
+  /**
+   * The text of the custom message
+   */
+  text: string;
+  /**
+   * The label of the custom message
+   */
+  label?: string | null | undefined;
+  /**
+   * Rules for time-specific message variants
+   */
+  rules?: Array<CustomMessageRule> | undefined;
+  /**
+   * The ID of the custom message
+   */
+  id: number;
+  type?: string | undefined;
+};
+
+/** @internal */
+export const CustomMessageUpdateRequest$inboundSchema: z.ZodType<
+  CustomMessageUpdateRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  name: z.string(),
+  text: z.string(),
+  label: z.nullable(z.string()).optional(),
+  rules: z.array(CustomMessageRule$inboundSchema).optional(),
+  id: z.number().int(),
+  type: z.string().default("greeting"),
+});
+
+/** @internal */
+export type CustomMessageUpdateRequest$Outbound = {
+  name: string;
+  text: string;
+  label?: string | null | undefined;
+  rules?: Array<CustomMessageRule$Outbound> | undefined;
+  id: number;
+  type: string;
+};
+
+/** @internal */
+export const CustomMessageUpdateRequest$outboundSchema: z.ZodType<
+  CustomMessageUpdateRequest$Outbound,
+  z.ZodTypeDef,
+  CustomMessageUpdateRequest
+> = z.object({
+  name: z.string(),
+  text: z.string(),
+  label: z.nullable(z.string()).optional(),
+  rules: z.array(CustomMessageRule$outboundSchema).optional(),
+  id: z.number().int(),
+  type: z.string().default("greeting"),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace CustomMessageUpdateRequest$ {
+  /** @deprecated use `CustomMessageUpdateRequest$inboundSchema` instead. */
+  export const inboundSchema = CustomMessageUpdateRequest$inboundSchema;
+  /** @deprecated use `CustomMessageUpdateRequest$outboundSchema` instead. */
+  export const outboundSchema = CustomMessageUpdateRequest$outboundSchema;
+  /** @deprecated use `CustomMessageUpdateRequest$Outbound` instead. */
+  export type Outbound = CustomMessageUpdateRequest$Outbound;
+}
+
+export function customMessageUpdateRequestToJSON(
+  customMessageUpdateRequest: CustomMessageUpdateRequest,
+): string {
+  return JSON.stringify(
+    CustomMessageUpdateRequest$outboundSchema.parse(customMessageUpdateRequest),
+  );
+}
+
+export function customMessageUpdateRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<CustomMessageUpdateRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CustomMessageUpdateRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CustomMessageUpdateRequest' from JSON`,
+  );
+}

package/src/models/components/dashboard.ts

@@ -0,0 +1,102 @@
+/*
+ * 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";
+
+/**
+ * Basic information about a dashboard.
+ */
+export type Dashboard = {
+  /**
+   * Superset embedded ID of the dashboard
+   */
+  embeddedId: string;
+  /**
+   * Superset guest token of the dashboard
+   */
+  guestToken: string;
+  /**
+   * Name of the dashboard
+   */
+  name: string;
+  /**
+   * Superset URL of the dashboard
+   */
+  supersetUrl: string;
+};
+
+/** @internal */
+export const Dashboard$inboundSchema: z.ZodType<
+  Dashboard,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  embedded_id: z.string(),
+  guest_token: z.string(),
+  name: z.string(),
+  superset_url: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "embedded_id": "embeddedId",
+    "guest_token": "guestToken",
+    "superset_url": "supersetUrl",
+  });
+});
+
+/** @internal */
+export type Dashboard$Outbound = {
+  embedded_id: string;
+  guest_token: string;
+  name: string;
+  superset_url: string;
+};
+
+/** @internal */
+export const Dashboard$outboundSchema: z.ZodType<
+  Dashboard$Outbound,
+  z.ZodTypeDef,
+  Dashboard
+> = z.object({
+  embeddedId: z.string(),
+  guestToken: z.string(),
+  name: z.string(),
+  supersetUrl: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    embeddedId: "embedded_id",
+    guestToken: "guest_token",
+    supersetUrl: "superset_url",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace Dashboard$ {
+  /** @deprecated use `Dashboard$inboundSchema` instead. */
+  export const inboundSchema = Dashboard$inboundSchema;
+  /** @deprecated use `Dashboard$outboundSchema` instead. */
+  export const outboundSchema = Dashboard$outboundSchema;
+  /** @deprecated use `Dashboard$Outbound` instead. */
+  export type Outbound = Dashboard$Outbound;
+}
+
+export function dashboardToJSON(dashboard: Dashboard): string {
+  return JSON.stringify(Dashboard$outboundSchema.parse(dashboard));
+}
+
+export function dashboardFromJSON(
+  jsonString: string,
+): SafeParseResult<Dashboard, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Dashboard$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Dashboard' from JSON`,
+  );
+}

package/src/models/components/dayofweek.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 DayOfWeek = {
+  Mo: "mo",
+  Tu: "tu",
+  We: "we",
+  Th: "th",
+  Fr: "fr",
+  Sa: "sa",
+  Su: "su",
+} as const;
+export type DayOfWeek = ClosedEnum<typeof DayOfWeek>;
+
+/** @internal */
+export const DayOfWeek$inboundSchema: z.ZodNativeEnum<typeof DayOfWeek> = z
+  .nativeEnum(DayOfWeek);
+
+/** @internal */
+export const DayOfWeek$outboundSchema: z.ZodNativeEnum<typeof DayOfWeek> =
+  DayOfWeek$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace DayOfWeek$ {
+  /** @deprecated use `DayOfWeek$inboundSchema` instead. */
+  export const inboundSchema = DayOfWeek$inboundSchema;
+  /** @deprecated use `DayOfWeek$outboundSchema` instead. */
+  export const outboundSchema = DayOfWeek$outboundSchema;
+}

package/src/models/components/event.ts

@@ -4,19 +4,55 @@
 
 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 Attributes = {};
 
+/**
+ * An event represents a specific occurrence during a session.
+ */
 export type Event = {
+  /**
+   * Timestamp at which the event occurred
+   */
   timestamp: Date;
+  /**
+   * ID of the session in which the event occurred
+   */
   sessionId?: string | null | undefined;
+  /**
+   * ID of the conversation associated with the session in which the event occurred
+   */
   conversationId?: string | null | undefined;
+  /**
+   * Source of the event (either a tool call or an LLM prompt)
+   */
   source?: string | null | undefined;
+  /**
+   * ID of the source of the event (either a tool ID or a prompt ID)
+   */
   sourceId?: string | null | undefined;
+  /**
+   * Broad categorization of the event
+   */
   category?: string | null | undefined;
+  /**
+   * More specific class of the event
+   */
   type?: string | null | undefined;
+  /**
+   * ID of the user interacting with the system when the event occurred (e.g., their       phone number)
+   */
   userId?: string | null | undefined;
+  /**
+   * Human-readable description of the event
+   */
   description?: string | null | undefined;
+  /**
+   * Arbitrary additional metadata for the event
+   */
   attributes?: Attributes | null | undefined;
 };
 
@@ -50,6 +86,20 @@ export namespace Attributes$ {
   export type Outbound = Attributes$Outbound;
 }
 
+export function attributesToJSON(attributes: Attributes): string {
+  return JSON.stringify(Attributes$outboundSchema.parse(attributes));
+}
+
+export function attributesFromJSON(
+  jsonString: string,
+): SafeParseResult<Attributes, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Attributes$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Attributes' from JSON`,
+  );
+}
+
 /** @internal */
 export const Event$inboundSchema: z.ZodType<Event, z.ZodTypeDef, unknown> = z
   .object({
@@ -125,3 +175,17 @@ export namespace Event$ {
   /** @deprecated use `Event$Outbound` instead. */
   export type Outbound = Event$Outbound;
 }
+
+export function eventToJSON(event: Event): string {
+  return JSON.stringify(Event$outboundSchema.parse(event));
+}
+
+export function eventFromJSON(
+  jsonString: string,
+): SafeParseResult<Event, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Event$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Event' from JSON`,
+  );
+}

package/src/models/components/index.ts

@@ -2,55 +2,84 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
-export * from "./agent.js";
 export * from "./agentcreate.js";
 export * from "./agentproperties.js";
+export * from "./agentresponse.js";
 export * from "./agenttooldefaults.js";
 export * from "./agenttoolfielddefault.js";
+export * from "./agentupdate.js";
+export * from "./agentvoice.js";
+export * from "./agentvoicevarname.js";
 export * from "./availabletarget.js";
 export * from "./availabletargetproperties.js";
 export * from "./channel.js";
 export * from "./channelproperties.js";
 export * from "./channelservices.js";
-export * from "./channeltarget.js";
 export * from "./channeltargetcreaterequest.js";
 export * from "./channeltargetproperties.js";
+export * from "./channeltargetresponse.js";
+export * from "./channeltargetupdaterequest.js";
 export * from "./conversation.js";
 export * from "./conversationproperties.js";
-export * from "./custommessage.js";
-export * from "./custommessagecreate.js";
+export * from "./custommessagecreaterequest.js";
 export * from "./custommessageproperties.js";
+export * from "./custommessageresponse.js";
+export * from "./custommessagerule.js";
+export * from "./custommessageupdaterequest.js";
+export * from "./dashboard.js";
+export * from "./dayofweek.js";
 export * from "./event.js";
 export * from "./eventproperties.js";
-export * from "./listresponseagent.js";
+export * from "./internaltool.js";
+export * from "./listresponseagentresponse.js";
 export * from "./listresponseavailabletarget.js";
 export * from "./listresponsechannel.js";
-export * from "./listresponsechanneltarget.js";
+export * from "./listresponsechanneltargetresponse.js";
 export * from "./listresponseconversation.js";
-export * from "./listresponsecustommessage.js";
+export * from "./listresponsecustommessageresponse.js";
 export * from "./listresponseevent.js";
-export * from "./listresponseprompt.js";
+export * from "./listresponsepromptresponse.js";
+export * from "./listresponseservice.js";
 export * from "./listresponsesession.js";
 export * from "./listresponsesessionlabel.js";
-export * from "./listresponsetool.js";
-export * from "./llmconfig.js";
+export * from "./listresponsetoolresponse.js";
 export * from "./orderbydirection.js";
-export * from "./prompt.js";
-export * from "./promptcreate.js";
+export * from "./promptcreaterequest.js";
+export * from "./prompthistory.js";
+export * from "./promptllmconfig.js";
+export * from "./promptllmprovider.js";
 export * from "./promptproperties.js";
-export * from "./provider.js";
+export * from "./promptresponse.js";
+export * from "./promptupdaterequest.js";
 export * from "./security.js";
+export * from "./service.js";
+export * from "./servicecreate.js";
+export * from "./serviceproperties.js";
+export * from "./serviceupdate.js";
 export * from "./session.js";
 export * from "./sessionaction.js";
 export * from "./sessionlabel.js";
 export * from "./sessionlabelcreate.js";
 export * from "./sessionlabelproperties.js";
 export * from "./sessionproperties.js";
+export * from "./sessionrecordingresponse.js";
 export * from "./sessiontext.js";
 export * from "./sessiontranscriptionresponse.js";
+export * from "./sttprovider.js";
+export * from "./targetmodes.js";
 export * from "./testmessage.js";
 export * from "./testmessageresponse.js";
-export * from "./tool.js";
+export * from "./toolargumentlocation.js";
+export * from "./toolcreaterequest.js";
+export * from "./tooldefinition.js";
 export * from "./tooldetailresponse.js";
+export * from "./toolfunction.js";
+export * from "./toolhttpendpoint.js";
+export * from "./toolhttpmethod.js";
+export * from "./toolparameterdefault.js";
+export * from "./toolparametertransform.js";
+export * from "./toolparametertransformcondition.js";
 export * from "./toolproperties.js";
+export * from "./toolresponse.js";
+export * from "./toolupdaterequest.js";
 export * from "./validationerror.js";

package/src/models/components/internaltool.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";
+import {
+  ToolFunction,
+  ToolFunction$inboundSchema,
+  ToolFunction$Outbound,
+  ToolFunction$outboundSchema,
+} from "./toolfunction.js";
+
+/**
+ * A tool definition to be used by the OpenAI API.
+ */
+export type InternalTool = {
+  /**
+   * Always `function`.
+   */
+  type?: "function" | undefined;
+  /**
+   * A function available to an agent.
+   *
+   * @remarks
+   *
+   * See:
+   * - https://learn.microsoft.com/en-us/azure/ai-services/openai/how-to/function-calling
+   */
+  function: ToolFunction;
+};
+
+/** @internal */
+export const InternalTool$inboundSchema: z.ZodType<
+  InternalTool,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  type: z.literal("function").default("function"),
+  function: ToolFunction$inboundSchema,
+});
+
+/** @internal */
+export type InternalTool$Outbound = {
+  type: "function";
+  function: ToolFunction$Outbound;
+};
+
+/** @internal */
+export const InternalTool$outboundSchema: z.ZodType<
+  InternalTool$Outbound,
+  z.ZodTypeDef,
+  InternalTool
+> = z.object({
+  type: z.literal("function").default("function" as const),
+  function: ToolFunction$outboundSchema,
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace InternalTool$ {
+  /** @deprecated use `InternalTool$inboundSchema` instead. */
+  export const inboundSchema = InternalTool$inboundSchema;
+  /** @deprecated use `InternalTool$outboundSchema` instead. */
+  export const outboundSchema = InternalTool$outboundSchema;
+  /** @deprecated use `InternalTool$Outbound` instead. */
+  export type Outbound = InternalTool$Outbound;
+}
+
+export function internalToolToJSON(internalTool: InternalTool): string {
+  return JSON.stringify(InternalTool$outboundSchema.parse(internalTool));
+}
+
+export function internalToolFromJSON(
+  jsonString: string,
+): SafeParseResult<InternalTool, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => InternalTool$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'InternalTool' from JSON`,
+  );
+}