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

package/src/funcs/{conversationsGetById.ts → sessionsTranscriptGetById.ts}

@@ -24,15 +24,15 @@ import * as operations from "../models/operations/index.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Get Conversation By Id
+ * Get Session Transcript By Id
  */
-export async function conversationsGetById(
+export async function sessionsTranscriptGetById(
   client: SyllableSDKCore,
-  request: operations.ConversationGetByIdRequest,
+  request: operations.SessionTranscriptGetByIdRequest,
   options?: RequestOptions,
 ): Promise<
   Result<
-    components.ConversationTranscriptionResponse,
+    components.SessionTranscriptionResponse,
     | errors.HTTPValidationError
     | SDKError
     | SDKValidationError
@@ -46,7 +46,7 @@ export async function conversationsGetById(
   const parsed = safeParse(
     request,
     (value) =>
-      operations.ConversationGetByIdRequest$outboundSchema.parse(value),
+      operations.SessionTranscriptGetByIdRequest$outboundSchema.parse(value),
     "Input validation failed",
   );
   if (!parsed.ok) {
@@ -56,13 +56,13 @@ export async function conversationsGetById(
   const body = null;
 
   const pathParams = {
-    conversation_id: encodeSimple("conversation_id", payload.conversation_id, {
+    session_id: encodeSimple("session_id", payload.session_id, {
       explode: false,
       charEncoding: "percent",
     }),
   };
 
-  const path = pathToFunc("/api/v1/conversations/{conversation_id}")(
+  const path = pathToFunc("/api/v1/sessions/transcript/{session_id}")(
     pathParams,
   );
 
@@ -75,8 +75,11 @@ export async function conversationsGetById(
   const requestSecurity = resolveGlobalSecurity(securityInput);
 
   const context = {
-    operationID: "conversation_get_by_id",
+    operationID: "session_transcript_get_by_id",
     oAuth2Scopes: [],
+
+    resolvedSecurity: requestSecurity,
+
     securitySource: client._options.apiKeyHeader,
     retryConfig: options?.retries
       || client._options.retryConfig
@@ -113,7 +116,7 @@ export async function conversationsGetById(
   };
 
   const [result] = await M.match<
-    components.ConversationTranscriptionResponse,
+    components.SessionTranscriptionResponse,
     | errors.HTTPValidationError
     | SDKError
     | SDKValidationError
@@ -123,7 +126,7 @@ export async function conversationsGetById(
     | RequestTimeoutError
     | ConnectionError
   >(
-    M.json(200, components.ConversationTranscriptionResponse$inboundSchema),
+    M.json(200, components.SessionTranscriptionResponse$inboundSchema),
     M.jsonErr(422, errors.HTTPValidationError$inboundSchema),
     M.fail(["4XX", "5XX"]),
   )(response, { extraFields: responseFields });

package/src/funcs/toolsGetByName.ts

@@ -77,6 +77,9 @@ export async function toolsGetByName(
   const context = {
     operationID: "tool_get_by_name",
     oAuth2Scopes: [],
+
+    resolvedSecurity: requestSecurity,
+
     securitySource: client._options.apiKeyHeader,
     retryConfig: options?.retries
       || client._options.retryConfig

package/src/funcs/toolsList.ts

@@ -82,6 +82,9 @@ export async function toolsList(
   const context = {
     operationID: "tool_list",
     oAuth2Scopes: [],
+
+    resolvedSecurity: requestSecurity,
+
     securitySource: client._options.apiKeyHeader,
     retryConfig: options?.retries
       || client._options.retryConfig

package/src/hooks/types.ts

@@ -4,12 +4,14 @@
 
 import { HTTPClient, RequestInput } from "../lib/http.js";
 import { RetryConfig } from "../lib/retries.js";
+import { SecurityState } from "../lib/security.js";
 
 export type HookContext = {
   operationID: string;
   oAuth2Scopes?: string[];
   securitySource?: any | (() => Promise<any>);
   retryConfig: RetryConfig;
+  resolvedSecurity: SecurityState | null;
 };
 
 export type Awaitable<T> = T | Promise<T>;

package/src/lib/config.ts

@@ -11,7 +11,14 @@ import { Params, pathToFunc } from "./url.js";
  * Contains the list of servers available to the SDK
  */
 export const ServerList = [
-  "http://127.0.0.1:8001",
+  /**
+   * dev server
+   */
+  "http://localhost:8001",
+  /**
+   * dev / port-forwarding server
+   */
+  "http://localhost:8001",
 ] as const;
 
 export type SDKOptions = {
@@ -54,8 +61,8 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
 export const SDK_METADATA = {
   language: "typescript",
   openapiDocVersion: "0.0.2",
-  sdkVersion: "0.1.0-alpha.1",
-  genVersion: "2.452.0",
+  sdkVersion: "0.1.0-alpha.3",
+  genVersion: "2.457.2",
   userAgent:
-    "speakeasy-sdk/typescript 0.1.0-alpha.1 2.452.0 0.0.2 syllable-sdk",
+    "speakeasy-sdk/typescript 0.1.0-alpha.3 2.457.2 0.0.2 syllable-sdk",
 } as const;

package/src/lib/env.ts

@@ -13,11 +13,10 @@ export interface Env {
 }
 
 export const envSchema: z.ZodType<Env, z.ZodTypeDef, unknown> = z.object({
-  SYLLABLESDK_API_KEY_HEADER: z.string(),
+  SYLLABLESDK_API_KEY_HEADER: z.string().optional(),
 
-  SYLLABLESDK_DEBUG: z.coerce.boolean(),
-})
-  .partial();
+  SYLLABLESDK_DEBUG: z.coerce.boolean().optional(),
+});
 
 let envMemo: Env | undefined = undefined;
 /**

package/src/lib/primitives.ts

@@ -2,6 +2,26 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
+class InvariantError extends Error {
+  constructor(message: string) {
+    super(message);
+    this.name = "InvariantError";
+  }
+}
+
+export function invariant(
+  condition: unknown,
+  message: string,
+): asserts condition {
+  if (!condition) {
+    throw new InvariantError(message);
+  }
+}
+
+export type ExactPartial<T> = {
+  [P in keyof T]?: T[P] | undefined;
+};
+
 export type Remap<Inp, Mapping extends { [k in keyof Inp]?: string | null }> = {
   [k in keyof Inp as Mapping[k] extends string /* if we have a string mapping for this key then use it */
     ? Mapping[k]

package/src/lib/security.ts

@@ -5,6 +5,14 @@
 import * as components from "../models/components/index.js";
 import { env } from "./env.js";
 
+type OAuth2PasswordFlow = {
+  username: string;
+  password?: string | undefined;
+  clientID: string;
+  clientSecret?: string | undefined;
+  tokenURL: string;
+};
+
 export enum SecurityErrorCode {
   Incomplete = "incomplete",
   UnrecognisedSecurityType = "unrecognized_security_type",
@@ -38,6 +46,7 @@ export type SecurityState = {
   headers: Record<string, string>;
   queryParams: Record<string, string>;
   cookies: Record<string, string>;
+  oauth2: ({ type: "password" } & OAuth2PasswordFlow) | { type: "none" };
 };
 
 type SecurityInputBasic = {
@@ -74,7 +83,18 @@ type SecurityInputOAuth2 = {
 
 type SecurityInputOAuth2ClientCredentials = {
   type: "oauth2:client_credentials";
-  value: string | null | undefined;
+  value:
+    | { clientID?: string | undefined; clientSecret?: string | undefined }
+    | null
+    | undefined;
+};
+
+type SecurityInputOAuth2PasswordCredentials = {
+  type: "oauth2:password";
+  value:
+    | string
+    | null
+    | undefined;
   fieldName: string;
 };
 
@@ -90,6 +110,7 @@ export type SecurityInput =
   | SecurityInputAPIKey
   | SecurityInputOAuth2
   | SecurityInputOAuth2ClientCredentials
+  | SecurityInputOAuth2PasswordCredentials
   | SecurityInputOIDC
   | SecurityInputCustom;
 
@@ -101,6 +122,7 @@ export function resolveSecurity(
     headers: {},
     queryParams: {},
     cookies: {},
+    oauth2: { type: "none" },
   };
 
   const option = options.find((opts) => {
@@ -111,6 +133,12 @@ export function resolveSecurity(
         return o.value.username != null || o.value.password != null;
       } else if (o.type === "http:custom") {
         return null;
+      } else if (o.type === "oauth2:password") {
+        return (
+          typeof o.value === "string" && !!o.value
+        );
+      } else if (o.type === "oauth2:client_credentials") {
+        return o.value.clientID != null || o.value.clientSecret != null;
       } else if (typeof o.value === "string") {
         return !!o.value;
       } else {
@@ -153,6 +181,9 @@ export function resolveSecurity(
       case "oauth2":
         applyBearer(state, spec);
         break;
+      case "oauth2:password":
+        applyBearer(state, spec);
+        break;
       case "oauth2:client_credentials":
         break;
       case "openIdConnect":
@@ -180,9 +211,13 @@ function applyBasic(
 
 function applyBearer(
   state: SecurityState,
-  spec: SecurityInputBearer | SecurityInputOAuth2 | SecurityInputOIDC,
+  spec:
+    | SecurityInputBearer
+    | SecurityInputOAuth2
+    | SecurityInputOIDC
+    | SecurityInputOAuth2PasswordCredentials,
 ) {
-  if (spec.value == null) {
+  if (typeof spec.value !== "string" || !spec.value) {
     return;
   }
 
@@ -193,6 +228,7 @@ function applyBearer(
 
   state.headers[spec.fieldName] = value;
 }
+
 export function resolveGlobalSecurity(
   security: Partial<components.Security> | null | undefined,
 ): SecurityState | null {

package/src/models/components/availabletarget.ts

@@ -6,7 +6,7 @@ import * as z from "zod";
 import { remap as remap$ } from "../../lib/primitives.js";
 
 export type AvailableTarget = {
-  subOrganizationId: number;
+  organizationId: number;
   channelId: number;
   channelName: string | null;
   target: string;
@@ -18,13 +18,13 @@ export const AvailableTarget$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  sub_organization_id: z.number().int(),
+  organization_id: z.number().int(),
   channel_id: z.number().int(),
   channel_name: z.nullable(z.string()),
   target: z.string(),
 }).transform((v) => {
   return remap$(v, {
-    "sub_organization_id": "subOrganizationId",
+    "organization_id": "organizationId",
     "channel_id": "channelId",
     "channel_name": "channelName",
   });
@@ -32,7 +32,7 @@ export const AvailableTarget$inboundSchema: z.ZodType<
 
 /** @internal */
 export type AvailableTarget$Outbound = {
-  sub_organization_id: number;
+  organization_id: number;
   channel_id: number;
   channel_name: string | null;
   target: string;
@@ -44,13 +44,13 @@ export const AvailableTarget$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   AvailableTarget
 > = z.object({
-  subOrganizationId: z.number().int(),
+  organizationId: z.number().int(),
   channelId: z.number().int(),
   channelName: z.nullable(z.string()),
   target: z.string(),
 }).transform((v) => {
   return remap$(v, {
-    subOrganizationId: "sub_organization_id",
+    organizationId: "organization_id",
     channelId: "channel_id",
     channelName: "channel_name",
   });

package/src/models/components/channel.ts

@@ -4,21 +4,35 @@
 
 import * as z from "zod";
 import { remap as remap$ } from "../../lib/primitives.js";
+import {
+  ChannelServices,
+  ChannelServices$inboundSchema,
+  ChannelServices$outboundSchema,
+} from "./channelservices.js";
 
 export type Channel = {
-  id: string;
+  /**
+   * The channel name
+   */
   name: string;
-  channelService: string;
-  supportedModes: string;
+  channelService: ChannelServices;
+  /**
+   * The comma-delimited list of supported modes for the channel
+   */
+  supportedModes?: string | null | undefined;
+  /**
+   * The channel ID
+   */
+  id: number;
 };
 
 /** @internal */
 export const Channel$inboundSchema: z.ZodType<Channel, z.ZodTypeDef, unknown> =
   z.object({
-    id: z.string(),
     name: z.string(),
-    channel_service: z.string(),
-    supported_modes: z.string(),
+    channel_service: ChannelServices$inboundSchema,
+    supported_modes: z.nullable(z.string()).optional(),
+    id: z.number().int(),
   }).transform((v) => {
     return remap$(v, {
       "channel_service": "channelService",
@@ -28,10 +42,10 @@ export const Channel$inboundSchema: z.ZodType<Channel, z.ZodTypeDef, unknown> =
 
 /** @internal */
 export type Channel$Outbound = {
-  id: string;
   name: string;
   channel_service: string;
-  supported_modes: string;
+  supported_modes?: string | null | undefined;
+  id: number;
 };
 
 /** @internal */
@@ -40,10 +54,10 @@ export const Channel$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   Channel
 > = z.object({
-  id: z.string(),
   name: z.string(),
-  channelService: z.string(),
-  supportedModes: z.string(),
+  channelService: ChannelServices$outboundSchema,
+  supportedModes: z.nullable(z.string()).optional(),
+  id: z.number().int(),
 }).transform((v) => {
   return remap$(v, {
     channelService: "channel_service",

package/src/models/components/channelservices.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 ChannelServices = {
+  Sip: "sip",
+  Twilio: "twilio",
+  Email: "email",
+  Webchat: "webchat",
+} as const;
+export type ChannelServices = ClosedEnum<typeof ChannelServices>;
+
+/** @internal */
+export const ChannelServices$inboundSchema: z.ZodNativeEnum<
+  typeof ChannelServices
+> = z.nativeEnum(ChannelServices);
+
+/** @internal */
+export const ChannelServices$outboundSchema: z.ZodNativeEnum<
+  typeof ChannelServices
+> = ChannelServices$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ChannelServices$ {
+  /** @deprecated use `ChannelServices$inboundSchema` instead. */
+  export const inboundSchema = ChannelServices$inboundSchema;
+  /** @deprecated use `ChannelServices$outboundSchema` instead. */
+  export const outboundSchema = ChannelServices$outboundSchema;
+}

package/src/models/components/channeltargetcreaterequest.ts

@@ -7,7 +7,6 @@ import { remap as remap$ } from "../../lib/primitives.js";
 
 export type ChannelTargetCreateRequest = {
   channelId: number | null;
-  channelName: string | null;
   agentId: number | null;
   target: string | null;
   targetMode: string | null;
@@ -22,7 +21,6 @@ export const ChannelTargetCreateRequest$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   channel_id: z.nullable(z.number().int()),
-  channel_name: z.nullable(z.string()),
   agent_id: z.nullable(z.number().int()),
   target: z.nullable(z.string()),
   target_mode: z.nullable(z.string()),
@@ -31,7 +29,6 @@ export const ChannelTargetCreateRequest$inboundSchema: z.ZodType<
 }).transform((v) => {
   return remap$(v, {
     "channel_id": "channelId",
-    "channel_name": "channelName",
     "agent_id": "agentId",
     "target_mode": "targetMode",
     "fallback_target": "fallbackTarget",
@@ -42,7 +39,6 @@ export const ChannelTargetCreateRequest$inboundSchema: z.ZodType<
 /** @internal */
 export type ChannelTargetCreateRequest$Outbound = {
   channel_id: number | null;
-  channel_name: string | null;
   agent_id: number | null;
   target: string | null;
   target_mode: string | null;
@@ -57,7 +53,6 @@ export const ChannelTargetCreateRequest$outboundSchema: z.ZodType<
   ChannelTargetCreateRequest
 > = z.object({
   channelId: z.nullable(z.number().int()),
-  channelName: z.nullable(z.string()),
   agentId: z.nullable(z.number().int()),
   target: z.nullable(z.string()),
   targetMode: z.nullable(z.string()),
@@ -66,7 +61,6 @@ export const ChannelTargetCreateRequest$outboundSchema: z.ZodType<
 }).transform((v) => {
   return remap$(v, {
     channelId: "channel_id",
-    channelName: "channel_name",
     agentId: "agent_id",
     targetMode: "target_mode",
     fallbackTarget: "fallback_target",

package/src/models/components/conversation.ts

@@ -8,18 +8,16 @@ import { remap as remap$ } from "../../lib/primitives.js";
 export type Conversation = {
   timestamp: Date;
   conversationId: string;
-  sessionId?: string | null | undefined;
   agentId?: string | null | undefined;
   agentName?: string | null | undefined;
   agentType?: string | null | undefined;
   promptId?: string | null | undefined;
   promptName?: string | null | undefined;
   promptVersion?: string | null | undefined;
-  callId?: string | null | undefined;
-  source?: string | null | undefined;
-  target?: string | null | undefined;
+  llmProvider?: string | null | undefined;
+  llmModel?: string | null | undefined;
+  llmVersion?: string | null | undefined;
   isLegacy?: boolean | null | undefined;
-  isTest?: boolean | null | undefined;
 };
 
 /** @internal */
@@ -30,31 +28,29 @@ export const Conversation$inboundSchema: z.ZodType<
 > = z.object({
   timestamp: z.string().datetime({ offset: true }).transform(v => new Date(v)),
   conversation_id: z.string(),
-  session_id: 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(),
   prompt_id: z.nullable(z.string()).optional(),
   prompt_name: z.nullable(z.string()).optional(),
   prompt_version: z.nullable(z.string()).optional(),
-  call_id: z.nullable(z.string()).optional(),
-  source: z.nullable(z.string()).optional(),
-  target: z.nullable(z.string()).optional(),
+  llm_provider: z.nullable(z.string()).optional(),
+  llm_model: z.nullable(z.string()).optional(),
+  llm_version: z.nullable(z.string()).optional(),
   is_legacy: z.nullable(z.boolean()).optional(),
-  is_test: z.nullable(z.boolean()).optional(),
 }).transform((v) => {
   return remap$(v, {
     "conversation_id": "conversationId",
-    "session_id": "sessionId",
     "agent_id": "agentId",
     "agent_name": "agentName",
     "agent_type": "agentType",
     "prompt_id": "promptId",
     "prompt_name": "promptName",
     "prompt_version": "promptVersion",
-    "call_id": "callId",
+    "llm_provider": "llmProvider",
+    "llm_model": "llmModel",
+    "llm_version": "llmVersion",
     "is_legacy": "isLegacy",
-    "is_test": "isTest",
   });
 });
 
@@ -62,18 +58,16 @@ export const Conversation$inboundSchema: z.ZodType<
 export type Conversation$Outbound = {
   timestamp: string;
   conversation_id: string;
-  session_id?: string | null | undefined;
   agent_id?: string | null | undefined;
   agent_name?: string | null | undefined;
   agent_type?: string | null | undefined;
   prompt_id?: string | null | undefined;
   prompt_name?: string | null | undefined;
   prompt_version?: string | null | undefined;
-  call_id?: string | null | undefined;
-  source?: string | null | undefined;
-  target?: string | null | undefined;
+  llm_provider?: string | null | undefined;
+  llm_model?: string | null | undefined;
+  llm_version?: string | null | undefined;
   is_legacy?: boolean | null | undefined;
-  is_test?: boolean | null | undefined;
 };
 
 /** @internal */
@@ -84,31 +78,29 @@ export const Conversation$outboundSchema: z.ZodType<
 > = z.object({
   timestamp: z.date().transform(v => v.toISOString()),
   conversationId: z.string(),
-  sessionId: z.nullable(z.string()).optional(),
   agentId: z.nullable(z.string()).optional(),
   agentName: z.nullable(z.string()).optional(),
   agentType: z.nullable(z.string()).optional(),
   promptId: z.nullable(z.string()).optional(),
   promptName: z.nullable(z.string()).optional(),
   promptVersion: z.nullable(z.string()).optional(),
-  callId: z.nullable(z.string()).optional(),
-  source: z.nullable(z.string()).optional(),
-  target: z.nullable(z.string()).optional(),
+  llmProvider: z.nullable(z.string()).optional(),
+  llmModel: z.nullable(z.string()).optional(),
+  llmVersion: z.nullable(z.string()).optional(),
   isLegacy: z.nullable(z.boolean()).optional(),
-  isTest: z.nullable(z.boolean()).optional(),
 }).transform((v) => {
   return remap$(v, {
     conversationId: "conversation_id",
-    sessionId: "session_id",
     agentId: "agent_id",
     agentName: "agent_name",
     agentType: "agent_type",
     promptId: "prompt_id",
     promptName: "prompt_name",
     promptVersion: "prompt_version",
-    callId: "call_id",
+    llmProvider: "llm_provider",
+    llmModel: "llm_model",
+    llmVersion: "llm_version",
     isLegacy: "is_legacy",
-    isTest: "is_test",
   });
 });
 

package/src/models/components/conversationproperties.ts

@@ -12,11 +12,10 @@ export const ConversationProperties = {
   AgentName: "agent_name",
   PromptId: "prompt_id",
   PromptName: "prompt_name",
-  CallId: "call_id",
-  Source: "source",
-  Target: "target",
+  LlmProvider: "llm_provider",
+  LlmModel: "llm_model",
+  LlmVersion: "llm_version",
   IsLegacy: "is_legacy",
-  IsTest: "is_test",
 } as const;
 export type ConversationProperties = ClosedEnum<typeof ConversationProperties>;
 

package/src/models/components/index.ts

@@ -11,21 +11,17 @@ 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 "./conversation.js";
-export * from "./conversationaction.js";
 export * from "./conversationproperties.js";
-export * from "./conversationtext.js";
-export * from "./conversationtranscriptionresponse.js";
 export * from "./custommessage.js";
 export * from "./custommessagecreate.js";
 export * from "./custommessageproperties.js";
 export * from "./event.js";
 export * from "./eventproperties.js";
-export * from "./function.js";
-export * from "./httpendpoint.js";
 export * from "./listresponseagent.js";
 export * from "./listresponseavailabletarget.js";
 export * from "./listresponsechannel.js";
@@ -35,23 +31,26 @@ export * from "./listresponsecustommessage.js";
 export * from "./listresponseevent.js";
 export * from "./listresponseprompt.js";
 export * from "./listresponsesession.js";
+export * from "./listresponsesessionlabel.js";
 export * from "./listresponsetool.js";
 export * from "./llmconfig.js";
-export * from "./organization.js";
+export * from "./orderbydirection.js";
 export * from "./prompt.js";
 export * from "./promptcreate.js";
 export * from "./promptproperties.js";
-export * from "./schemasbubblegumv2toolstool.js";
-export * from "./schemascortexv1toolstool.js";
+export * from "./provider.js";
 export * from "./security.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 "./sessiontext.js";
+export * from "./sessiontranscriptionresponse.js";
 export * from "./testmessage.js";
 export * from "./testmessageresponse.js";
-export * from "./tooldefinition.js";
+export * from "./tool.js";
 export * from "./tooldetailresponse.js";
-export * from "./toolparameterdefault.js";
-export * from "./toolparametertransform.js";
-export * from "./toolparametertransformcondition.js";
 export * from "./toolproperties.js";
 export * from "./validationerror.js";