syllable-sdk 0.1.0-alpha.70 → 0.1.0-alpha.71

package/src/models/components/createtakeoutresponse.ts

@@ -0,0 +1,81 @@
+/*
+ * 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 CreateTakeoutResponse = {
+  jobId: string;
+  createdAt: Date;
+};
+
+/** @internal */
+export const CreateTakeoutResponse$inboundSchema: z.ZodType<
+  CreateTakeoutResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  job_id: z.string(),
+  created_at: z.string().datetime({ offset: true }).transform(v => new Date(v)),
+}).transform((v) => {
+  return remap$(v, {
+    "job_id": "jobId",
+    "created_at": "createdAt",
+  });
+});
+
+/** @internal */
+export type CreateTakeoutResponse$Outbound = {
+  job_id: string;
+  created_at: string;
+};
+
+/** @internal */
+export const CreateTakeoutResponse$outboundSchema: z.ZodType<
+  CreateTakeoutResponse$Outbound,
+  z.ZodTypeDef,
+  CreateTakeoutResponse
+> = z.object({
+  jobId: z.string(),
+  createdAt: z.date().transform(v => v.toISOString()),
+}).transform((v) => {
+  return remap$(v, {
+    jobId: "job_id",
+    createdAt: "created_at",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace CreateTakeoutResponse$ {
+  /** @deprecated use `CreateTakeoutResponse$inboundSchema` instead. */
+  export const inboundSchema = CreateTakeoutResponse$inboundSchema;
+  /** @deprecated use `CreateTakeoutResponse$outboundSchema` instead. */
+  export const outboundSchema = CreateTakeoutResponse$outboundSchema;
+  /** @deprecated use `CreateTakeoutResponse$Outbound` instead. */
+  export type Outbound = CreateTakeoutResponse$Outbound;
+}
+
+export function createTakeoutResponseToJSON(
+  createTakeoutResponse: CreateTakeoutResponse,
+): string {
+  return JSON.stringify(
+    CreateTakeoutResponse$outboundSchema.parse(createTakeoutResponse),
+  );
+}
+
+export function createTakeoutResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<CreateTakeoutResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CreateTakeoutResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CreateTakeoutResponse' from JSON`,
+  );
+}

package/src/models/components/daotakeoutcreate.ts

@@ -0,0 +1,81 @@
+/*
+ * 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 DaoTakeoutCreate = {
+  subOrganizationId: number;
+  requestedBy?: number | null | undefined;
+};
+
+/** @internal */
+export const DaoTakeoutCreate$inboundSchema: z.ZodType<
+  DaoTakeoutCreate,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  sub_organization_id: z.number().int(),
+  requested_by: z.nullable(z.number().int()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "sub_organization_id": "subOrganizationId",
+    "requested_by": "requestedBy",
+  });
+});
+
+/** @internal */
+export type DaoTakeoutCreate$Outbound = {
+  sub_organization_id: number;
+  requested_by?: number | null | undefined;
+};
+
+/** @internal */
+export const DaoTakeoutCreate$outboundSchema: z.ZodType<
+  DaoTakeoutCreate$Outbound,
+  z.ZodTypeDef,
+  DaoTakeoutCreate
+> = z.object({
+  subOrganizationId: z.number().int(),
+  requestedBy: z.nullable(z.number().int()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    subOrganizationId: "sub_organization_id",
+    requestedBy: "requested_by",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace DaoTakeoutCreate$ {
+  /** @deprecated use `DaoTakeoutCreate$inboundSchema` instead. */
+  export const inboundSchema = DaoTakeoutCreate$inboundSchema;
+  /** @deprecated use `DaoTakeoutCreate$outboundSchema` instead. */
+  export const outboundSchema = DaoTakeoutCreate$outboundSchema;
+  /** @deprecated use `DaoTakeoutCreate$Outbound` instead. */
+  export type Outbound = DaoTakeoutCreate$Outbound;
+}
+
+export function daoTakeoutCreateToJSON(
+  daoTakeoutCreate: DaoTakeoutCreate,
+): string {
+  return JSON.stringify(
+    DaoTakeoutCreate$outboundSchema.parse(daoTakeoutCreate),
+  );
+}
+
+export function daoTakeoutCreateFromJSON(
+  jsonString: string,
+): SafeParseResult<DaoTakeoutCreate, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => DaoTakeoutCreate$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'DaoTakeoutCreate' from JSON`,
+  );
+}

package/src/models/components/index.ts

@@ -27,11 +27,13 @@ export * from "./channeltargetresponse.js";
 export * from "./channeltargetupdaterequest.js";
 export * from "./conversation.js";
 export * from "./conversationproperties.js";
+export * from "./createtakeoutresponse.js";
 export * from "./custommessagecreaterequest.js";
 export * from "./custommessageproperties.js";
 export * from "./custommessageresponse.js";
 export * from "./custommessagerule.js";
 export * from "./custommessageupdaterequest.js";
+export * from "./daotakeoutcreate.js";
 export * from "./dashboard.js";
 export * from "./dashboardproperties.js";
 export * from "./dashboardresponse.js";
@@ -47,6 +49,8 @@ export * from "./dialogrole.js";
 export * from "./dialogtoolcall.js";
 export * from "./event.js";
 export * from "./eventproperties.js";
+export * from "./insightsoutput.js";
+export * from "./insightsproperties.js";
 export * from "./insighttooldefinition.js";
 export * from "./insighttoolinput.js";
 export * from "./insighttooloutput.js";
@@ -71,6 +75,7 @@ export * from "./listresponsecustommessageresponse.js";
 export * from "./listresponsedashboardresponse.js";
 export * from "./listresponsedatasourcemetadataresponse.js";
 export * from "./listresponseevent.js";
+export * from "./listresponseinsightsoutput.js";
 export * from "./listresponseinsighttooloutput.js";
 export * from "./listresponseinsightworkflowoutput.js";
 export * from "./listresponselanguagegroupresponse.js";
@@ -106,6 +111,9 @@ export * from "./sessiontext.js";
 export * from "./sessiontranscriptionresponse.js";
 export * from "./statictoolparameter.js";
 export * from "./statictoolparametertype.js";
+export * from "./supportedllm.js";
+export * from "./takeoutrequeststatus.js";
+export * from "./takeoutstatusresponse.js";
 export * from "./targetmodes.js";
 export * from "./testmessage.js";
 export * from "./testmessageresponse.js";

package/src/models/components/insightsoutput.ts

@@ -0,0 +1,207 @@
+/*
+ * 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";
+
+/**
+ * JSON value of insight tool result
+ */
+export type JsonValue = {};
+
+/**
+ * Response model for an insight tool.
+ */
+export type InsightsOutput = {
+  /**
+   * Unique ID for insight tool
+   */
+  id: number;
+  /**
+   * Unique ID for session
+   */
+  sessionId: number;
+  /**
+   * Unique ID for insight tool
+   */
+  insightToolId: number;
+  /**
+   * Version of insight tool
+   */
+  insightToolVersion: number;
+  /**
+   * Key for insight tool result
+   */
+  insightKey: string;
+  /**
+   * String value of insight tool result
+   */
+  stringValue?: string | null | undefined;
+  /**
+   * Numeric value of insight tool result
+   */
+  numericValue?: number | null | undefined;
+  /**
+   * JSON value of insight tool result
+   */
+  jsonValue: JsonValue;
+  /**
+   * Timestamp at which insight tool result was created
+   */
+  createdAt?: Date | undefined;
+  /**
+   * Timestamp at which insight tool result was last updated
+   */
+  updatedAt?: Date | undefined;
+};
+
+/** @internal */
+export const JsonValue$inboundSchema: z.ZodType<
+  JsonValue,
+  z.ZodTypeDef,
+  unknown
+> = z.object({});
+
+/** @internal */
+export type JsonValue$Outbound = {};
+
+/** @internal */
+export const JsonValue$outboundSchema: z.ZodType<
+  JsonValue$Outbound,
+  z.ZodTypeDef,
+  JsonValue
+> = 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 JsonValue$ {
+  /** @deprecated use `JsonValue$inboundSchema` instead. */
+  export const inboundSchema = JsonValue$inboundSchema;
+  /** @deprecated use `JsonValue$outboundSchema` instead. */
+  export const outboundSchema = JsonValue$outboundSchema;
+  /** @deprecated use `JsonValue$Outbound` instead. */
+  export type Outbound = JsonValue$Outbound;
+}
+
+export function jsonValueToJSON(jsonValue: JsonValue): string {
+  return JSON.stringify(JsonValue$outboundSchema.parse(jsonValue));
+}
+
+export function jsonValueFromJSON(
+  jsonString: string,
+): SafeParseResult<JsonValue, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => JsonValue$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'JsonValue' from JSON`,
+  );
+}
+
+/** @internal */
+export const InsightsOutput$inboundSchema: z.ZodType<
+  InsightsOutput,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: z.number().int(),
+  session_id: z.number().int(),
+  insight_tool_id: z.number().int(),
+  insight_tool_version: z.number().int(),
+  insight_key: z.string(),
+  string_value: z.nullable(z.string()).optional(),
+  numeric_value: z.nullable(z.number()).optional(),
+  json_value: z.lazy(() => JsonValue$inboundSchema),
+  created_at: z.string().datetime({ offset: true }).transform(v => new Date(v))
+    .optional(),
+  updated_at: z.string().datetime({ offset: true }).transform(v => new Date(v))
+    .optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "session_id": "sessionId",
+    "insight_tool_id": "insightToolId",
+    "insight_tool_version": "insightToolVersion",
+    "insight_key": "insightKey",
+    "string_value": "stringValue",
+    "numeric_value": "numericValue",
+    "json_value": "jsonValue",
+    "created_at": "createdAt",
+    "updated_at": "updatedAt",
+  });
+});
+
+/** @internal */
+export type InsightsOutput$Outbound = {
+  id: number;
+  session_id: number;
+  insight_tool_id: number;
+  insight_tool_version: number;
+  insight_key: string;
+  string_value?: string | null | undefined;
+  numeric_value?: number | null | undefined;
+  json_value: JsonValue$Outbound;
+  created_at?: string | undefined;
+  updated_at?: string | undefined;
+};
+
+/** @internal */
+export const InsightsOutput$outboundSchema: z.ZodType<
+  InsightsOutput$Outbound,
+  z.ZodTypeDef,
+  InsightsOutput
+> = z.object({
+  id: z.number().int(),
+  sessionId: z.number().int(),
+  insightToolId: z.number().int(),
+  insightToolVersion: z.number().int(),
+  insightKey: z.string(),
+  stringValue: z.nullable(z.string()).optional(),
+  numericValue: z.nullable(z.number()).optional(),
+  jsonValue: z.lazy(() => JsonValue$outboundSchema),
+  createdAt: z.date().transform(v => v.toISOString()).optional(),
+  updatedAt: z.date().transform(v => v.toISOString()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    sessionId: "session_id",
+    insightToolId: "insight_tool_id",
+    insightToolVersion: "insight_tool_version",
+    insightKey: "insight_key",
+    stringValue: "string_value",
+    numericValue: "numeric_value",
+    jsonValue: "json_value",
+    createdAt: "created_at",
+    updatedAt: "updated_at",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace InsightsOutput$ {
+  /** @deprecated use `InsightsOutput$inboundSchema` instead. */
+  export const inboundSchema = InsightsOutput$inboundSchema;
+  /** @deprecated use `InsightsOutput$outboundSchema` instead. */
+  export const outboundSchema = InsightsOutput$outboundSchema;
+  /** @deprecated use `InsightsOutput$Outbound` instead. */
+  export type Outbound = InsightsOutput$Outbound;
+}
+
+export function insightsOutputToJSON(insightsOutput: InsightsOutput): string {
+  return JSON.stringify(InsightsOutput$outboundSchema.parse(insightsOutput));
+}
+
+export function insightsOutputFromJSON(
+  jsonString: string,
+): SafeParseResult<InsightsOutput, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => InsightsOutput$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'InsightsOutput' from JSON`,
+  );
+}

package/src/models/components/insightsproperties.ts

@@ -0,0 +1,35 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { ClosedEnum } from "../../types/enums.js";
+
+export const InsightsProperties = {
+  Id: "id",
+  SessionId: "session_id",
+  InsightKey: "insight_key",
+  InsightToolId: "insight_tool_id",
+} as const;
+export type InsightsProperties = ClosedEnum<typeof InsightsProperties>;
+
+/** @internal */
+export const InsightsProperties$inboundSchema: z.ZodNativeEnum<
+  typeof InsightsProperties
+> = z.nativeEnum(InsightsProperties);
+
+/** @internal */
+export const InsightsProperties$outboundSchema: z.ZodNativeEnum<
+  typeof InsightsProperties
+> = InsightsProperties$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace InsightsProperties$ {
+  /** @deprecated use `InsightsProperties$inboundSchema` instead. */
+  export const inboundSchema = InsightsProperties$inboundSchema;
+  /** @deprecated use `InsightsProperties$outboundSchema` instead. */
+  export const outboundSchema = InsightsProperties$outboundSchema;
+}

package/src/models/components/listresponseinsightsoutput.ts

@@ -0,0 +1,116 @@
+/*
+ * 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 {
+  InsightsOutput,
+  InsightsOutput$inboundSchema,
+  InsightsOutput$Outbound,
+  InsightsOutput$outboundSchema,
+} from "./insightsoutput.js";
+
+export type ListResponseInsightsOutput = {
+  /**
+   * List of items returned from the query
+   */
+  items: Array<InsightsOutput>;
+  /**
+   * The page number of the results (0-based)
+   */
+  page: number;
+  /**
+   * The number of items returned per page
+   */
+  pageSize: number;
+  /**
+   * The total number of pages of results given the indicated page size
+   */
+  totalPages?: number | null | undefined;
+  /**
+   * The total number of items returned from the query
+   */
+  totalCount?: number | null | undefined;
+};
+
+/** @internal */
+export const ListResponseInsightsOutput$inboundSchema: z.ZodType<
+  ListResponseInsightsOutput,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  items: z.array(InsightsOutput$inboundSchema),
+  page: z.number().int(),
+  page_size: z.number().int(),
+  total_pages: z.nullable(z.number().int()).optional(),
+  total_count: z.nullable(z.number().int()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "page_size": "pageSize",
+    "total_pages": "totalPages",
+    "total_count": "totalCount",
+  });
+});
+
+/** @internal */
+export type ListResponseInsightsOutput$Outbound = {
+  items: Array<InsightsOutput$Outbound>;
+  page: number;
+  page_size: number;
+  total_pages?: number | null | undefined;
+  total_count?: number | null | undefined;
+};
+
+/** @internal */
+export const ListResponseInsightsOutput$outboundSchema: z.ZodType<
+  ListResponseInsightsOutput$Outbound,
+  z.ZodTypeDef,
+  ListResponseInsightsOutput
+> = z.object({
+  items: z.array(InsightsOutput$outboundSchema),
+  page: z.number().int(),
+  pageSize: z.number().int(),
+  totalPages: z.nullable(z.number().int()).optional(),
+  totalCount: z.nullable(z.number().int()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    pageSize: "page_size",
+    totalPages: "total_pages",
+    totalCount: "total_count",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ListResponseInsightsOutput$ {
+  /** @deprecated use `ListResponseInsightsOutput$inboundSchema` instead. */
+  export const inboundSchema = ListResponseInsightsOutput$inboundSchema;
+  /** @deprecated use `ListResponseInsightsOutput$outboundSchema` instead. */
+  export const outboundSchema = ListResponseInsightsOutput$outboundSchema;
+  /** @deprecated use `ListResponseInsightsOutput$Outbound` instead. */
+  export type Outbound = ListResponseInsightsOutput$Outbound;
+}
+
+export function listResponseInsightsOutputToJSON(
+  listResponseInsightsOutput: ListResponseInsightsOutput,
+): string {
+  return JSON.stringify(
+    ListResponseInsightsOutput$outboundSchema.parse(listResponseInsightsOutput),
+  );
+}
+
+export function listResponseInsightsOutputFromJSON(
+  jsonString: string,
+): SafeParseResult<ListResponseInsightsOutput, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListResponseInsightsOutput$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListResponseInsightsOutput' from JSON`,
+  );
+}

package/src/models/components/promptllmconfig.ts

@@ -30,7 +30,7 @@ export type PromptLlmConfig = {
    */
   version?: string | null | undefined;
   /**
-   * Version of the API. (Currently only used for Azure OpenAI.)
+   * Version of the provider's API.
    */
   apiVersion?: string | null | undefined;
   /**

package/src/models/components/supportedllm.ts

@@ -0,0 +1,119 @@
+/*
+ * 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 {
+  PromptLlmProvider,
+  PromptLlmProvider$inboundSchema,
+  PromptLlmProvider$outboundSchema,
+} from "./promptllmprovider.js";
+
+/**
+ * LLM config option that can be used on a prompt.
+ */
+export type SupportedLlm = {
+  /**
+   * LLM API provider.
+   */
+  provider?: PromptLlmProvider | undefined;
+  /**
+   * Name of the model. Must match the deployment name in Azure AI Studio.
+   */
+  model?: string | undefined;
+  /**
+   * Display name of the model. This is used for display purposes in the Console UI.
+   */
+  displayName: string;
+  /**
+   * Model version.
+   */
+  version?: string | null | undefined;
+  /**
+   * Version of the provider's API.
+   */
+  apiVersion?: string | null | undefined;
+  /**
+   * Whether the LLM config is deprecated and should not be used.
+   */
+  deprecated: boolean;
+};
+
+/** @internal */
+export const SupportedLlm$inboundSchema: z.ZodType<
+  SupportedLlm,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  provider: PromptLlmProvider$inboundSchema.optional(),
+  model: z.string().default("gpt-4o"),
+  display_name: z.string(),
+  version: z.nullable(z.string()).optional(),
+  api_version: z.nullable(z.string()).optional(),
+  deprecated: z.boolean(),
+}).transform((v) => {
+  return remap$(v, {
+    "display_name": "displayName",
+    "api_version": "apiVersion",
+  });
+});
+
+/** @internal */
+export type SupportedLlm$Outbound = {
+  provider?: string | undefined;
+  model: string;
+  display_name: string;
+  version?: string | null | undefined;
+  api_version?: string | null | undefined;
+  deprecated: boolean;
+};
+
+/** @internal */
+export const SupportedLlm$outboundSchema: z.ZodType<
+  SupportedLlm$Outbound,
+  z.ZodTypeDef,
+  SupportedLlm
+> = z.object({
+  provider: PromptLlmProvider$outboundSchema.optional(),
+  model: z.string().default("gpt-4o"),
+  displayName: z.string(),
+  version: z.nullable(z.string()).optional(),
+  apiVersion: z.nullable(z.string()).optional(),
+  deprecated: z.boolean(),
+}).transform((v) => {
+  return remap$(v, {
+    displayName: "display_name",
+    apiVersion: "api_version",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace SupportedLlm$ {
+  /** @deprecated use `SupportedLlm$inboundSchema` instead. */
+  export const inboundSchema = SupportedLlm$inboundSchema;
+  /** @deprecated use `SupportedLlm$outboundSchema` instead. */
+  export const outboundSchema = SupportedLlm$outboundSchema;
+  /** @deprecated use `SupportedLlm$Outbound` instead. */
+  export type Outbound = SupportedLlm$Outbound;
+}
+
+export function supportedLlmToJSON(supportedLlm: SupportedLlm): string {
+  return JSON.stringify(SupportedLlm$outboundSchema.parse(supportedLlm));
+}
+
+export function supportedLlmFromJSON(
+  jsonString: string,
+): SafeParseResult<SupportedLlm, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SupportedLlm$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SupportedLlm' from JSON`,
+  );
+}