syllable-sdk 0.1.0-alpha.200 → 0.1.0-alpha.207

package/src/lib/matchers.ts

@@ -2,14 +2,14 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
-import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
 import { SDKError } from "../models/errors/sdkerror.js";
-import { ERR, OK, Result } from "../types/fp.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import { Result } from "../types/fp.js";
 import { matchResponse, matchStatusCode, StatusCodePredicate } from "./http.js";
 import { isPlainObject } from "./is-plain-object.js";
+import { safeParse } from "./schemas.js";
 
 export type Encoding =
-  | "jsonl"
   | "json"
   | "text"
   | "bytes"
@@ -19,7 +19,6 @@ export type Encoding =
   | "fail";
 
 const DEFAULT_CONTENT_TYPES: Record<Encoding, string> = {
-  jsonl: "application/jsonl",
   json: "application/json",
   text: "text/plain",
   bytes: "application/octet-stream",
@@ -73,21 +72,6 @@ export function json<T>(
   return { ...options, enc: "json", codes, schema };
 }
 
-export function jsonl<T>(
-  codes: StatusCodePredicate,
-  schema: Schema<T>,
-  options?: MatchOptions,
-): ValueMatcher<T> {
-  return { ...options, enc: "jsonl", codes, schema };
-}
-
-export function jsonlErr<E>(
-  codes: StatusCodePredicate,
-  schema: Schema<E>,
-  options?: MatchOptions,
-): ErrorMatcher<E> {
-  return { ...options, err: true, enc: "jsonl", codes, schema };
-}
 export function textErr<E>(
   codes: StatusCodePredicate,
   schema: Schema<E>,
@@ -175,19 +159,17 @@ export type MatchedError<Matchers> = Matchers extends Matcher<any, infer E>[]
   : never;
 export type MatchFunc<T, E> = (
   response: Response,
-  request: Request,
   options?: { resultKey?: string; extraFields?: Record<string, unknown> },
 ) => Promise<[result: Result<T, E>, raw: unknown]>;
 
 export function match<T, E>(
   ...matchers: Array<Matcher<T, E>>
-): MatchFunc<T, E | SDKError | ResponseValidationError> {
+): MatchFunc<T, E | SDKError | SDKValidationError> {
   return async function matchFunc(
     response: Response,
-    request: Request,
     options?: { resultKey?: string; extraFields?: Record<string, unknown> },
   ): Promise<
-    [result: Result<T, E | SDKError | ResponseValidationError>, raw: unknown]
+    [result: Result<T, E | SDKError | SDKValidationError>, raw: unknown]
   > {
     let raw: unknown;
     let matcher: Matcher<T, E> | undefined;
@@ -206,25 +188,21 @@ export function match<T, E>(
     }
 
     if (!matcher) {
+      const responseBody = await response.text();
       return [{
         ok: false,
-        error: new SDKError("Unexpected Status or Content-Type", {
+        error: new SDKError(
+          "Unexpected API response status or content-type",
           response,
-          request,
-          body: await response.text().catch(() => ""),
-        }),
-      }, raw];
+          responseBody,
+        ),
+      }, responseBody];
     }
 
     const encoding = matcher.enc;
-    let body = "";
     switch (encoding) {
       case "json":
-        body = await response.text();
-        raw = JSON.parse(body);
-        break;
-      case "jsonl":
-        raw = response.body;
+        raw = await response.json();
         break;
       case "bytes":
         raw = new Uint8Array(await response.arrayBuffer());
@@ -233,19 +211,16 @@ export function match<T, E>(
         raw = response.body;
         break;
       case "text":
-        body = await response.text();
-        raw = body;
+        raw = await response.text();
         break;
       case "sse":
         raw = response.body;
         break;
       case "nil":
-        body = await response.text();
-        raw = undefined;
+        raw = await discardResponseBody(response);
         break;
       case "fail":
-        body = await response.text();
-        raw = body;
+        raw = await response.text();
         break;
       default:
         encoding satisfies never;
@@ -255,7 +230,11 @@ export function match<T, E>(
     if (matcher.enc === "fail") {
       return [{
         ok: false,
-        error: new SDKError("API error occurred", { request, response, body }),
+        error: new SDKError(
+          "API error occurred",
+          response,
+          typeof raw === "string" ? raw : "",
+        ),
       }, raw];
     }
 
@@ -267,9 +246,6 @@ export function match<T, E>(
         ...options?.extraFields,
         ...(matcher.hdrs ? { Headers: unpackHeaders(response.headers) } : null),
         ...(isPlainObject(raw) ? raw : null),
-        request$: request,
-        response$: response,
-        body$: body,
       };
     } else if (resultKey) {
       data = {
@@ -288,20 +264,18 @@ export function match<T, E>(
     }
 
     if ("err" in matcher) {
-      const result = safeParseResponse(
+      const result = safeParse(
         data,
         (v: unknown) => matcher.schema.parse(v),
         "Response validation failed",
-        { request, response, body },
       );
       return [result.ok ? { ok: false, error: result.value } : result, raw];
     } else {
       return [
-        safeParseResponse(
+        safeParse(
           data,
           (v: unknown) => matcher.schema.parse(v),
           "Response validation failed",
-          { request, response, body },
         ),
         raw,
       ];
@@ -324,22 +298,25 @@ export function unpackHeaders(headers: Headers): Record<string, string[]> {
   return out;
 }
 
-function safeParseResponse<Inp, Out>(
-  rawValue: Inp,
-  fn: (value: Inp) => Out,
-  errorMessage: string,
-  httpMeta: { response: Response; request: Request; body: string },
-): Result<Out, ResponseValidationError> {
+/**
+ * Discards the response body to free up resources.
+ *
+ * To learn why this is need, see the undici docs:
+ * https://undici.nodejs.org/#/?id=garbage-collection
+ */
+export async function discardResponseBody(res: Response) {
+  const reader = res.body?.getReader();
+  if (reader == null) {
+    return;
+  }
+
   try {
-    return OK(fn(rawValue));
-  } catch (err) {
-    return ERR(
-      new ResponseValidationError(errorMessage, {
-        cause: err,
-        rawValue,
-        rawMessage: errorMessage,
-        ...httpMeta,
-      }),
-    );
+    let done = false;
+    while (!done) {
+      const res = await reader.read();
+      done = res.done;
+    }
+  } finally {
+    reader.releaseLock();
   }
 }

package/src/lib/primitives.ts

@@ -134,17 +134,3 @@ export function compactMap<T>(
 
   return out;
 }
-
-export function allRequired<V extends Record<string, unknown>>(
-  v: V,
-):
-  | {
-      [K in keyof V]: NonNullable<V[K]>;
-    }
-  | undefined {
-  if (Object.values(v).every((x) => x == null)) {
-    return void 0;
-  }
-
-  return v as ReturnType<typeof allRequired<V>>;
-}

package/src/lib/sdks.ts

@@ -47,14 +47,12 @@ export type RequestOptions = {
    */
   serverURL?: string | URL;
   /**
-   * @deprecated `fetchOptions` has been flattened into `RequestOptions`.
-   *
    * Sets various request options on the `fetch` call made by an SDK method.
    *
    * @see {@link https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options|Request}
    */
   fetchOptions?: Omit<RequestInit, "method" | "body">;
-} & Omit<RequestInit, "method" | "body">;
+};
 
 type RequestConfig = {
   method: string;
@@ -65,7 +63,6 @@ type RequestConfig = {
   headers?: HeadersInit;
   security?: SecurityState | null;
   uaHeader?: string;
-  userAgent?: string | undefined;
   timeoutMs?: number;
 };
 
@@ -82,7 +79,7 @@ export class ClientSDK {
   readonly #httpClient: HTTPClient;
   readonly #hooks: SDKHooks;
   readonly #logger?: Logger | undefined;
-  public readonly _baseURL: URL | null;
+  protected readonly _baseURL: URL | null;
   public readonly _options: SDKOptions & { hooks?: SDKHooks };
 
   constructor(options: SDKOptions = {}) {
@@ -97,21 +94,19 @@ export class ClientSDK {
     } else {
       this.#hooks = new SDKHooks();
     }
+    this._options = { ...options, hooks: this.#hooks };
+
     const url = serverURLFromOptions(options);
     if (url) {
       url.pathname = url.pathname.replace(/\/+$/, "") + "/";
     }
-
     const { baseURL, client } = this.#hooks.sdkInit({
       baseURL: url,
       client: options.httpClient || new HTTPClient(),
     });
     this._baseURL = baseURL;
     this.#httpClient = client;
-
-    this._options = { ...options, hooks: this.#hooks };
-
-    this.#logger = this._options.debugLogger;
+    this.#logger = options.debugLogger;
     if (!this.#logger && env().SYLLABLESDK_DEBUG) {
       this.#logger = console;
     }
@@ -177,9 +172,7 @@ export class ClientSDK {
     cookie = cookie.startsWith("; ") ? cookie.slice(2) : cookie;
     headers.set("cookie", cookie);
 
-    const userHeaders = new Headers(
-      options?.headers ?? options?.fetchOptions?.headers,
-    );
+    const userHeaders = new Headers(options?.fetchOptions?.headers);
     for (const [k, v] of userHeaders) {
       headers.set(k, v);
     }
@@ -187,23 +180,29 @@ export class ClientSDK {
     // Only set user agent header in non-browser-like environments since CORS
     // policy disallows setting it in browsers e.g. Chrome throws an error.
     if (!isBrowserLike) {
-      headers.set(
-        conf.uaHeader ?? "user-agent",
-        conf.userAgent ?? SDK_METADATA.userAgent,
-      );
+      headers.set(conf.uaHeader ?? "user-agent", SDK_METADATA.userAgent);
     }
 
-    const fetchOptions: Omit<RequestInit, "method" | "body"> = {
-      ...options?.fetchOptions,
-      ...options,
-    };
+    let fetchOptions = options?.fetchOptions;
     if (!fetchOptions?.signal && conf.timeoutMs && conf.timeoutMs > 0) {
       const timeoutSignal = AbortSignal.timeout(conf.timeoutMs);
-      fetchOptions.signal = timeoutSignal;
+      if (!fetchOptions) {
+        fetchOptions = { signal: timeoutSignal };
+      } else {
+        fetchOptions.signal = timeoutSignal;
+      }
     }
 
     if (conf.body instanceof ReadableStream) {
-      Object.assign(fetchOptions, { duplex: "half" });
+      if (!fetchOptions) {
+        fetchOptions = {
+          // @ts-expect-error see https://github.com/node-fetch/node-fetch/issues/1769
+          duplex: "half",
+        };
+      } else {
+        // @ts-expect-error see https://github.com/node-fetch/node-fetch/issues/1769
+        fetchOptions.duplex = "half";
+      }
     }
 
     let input;
@@ -308,9 +307,7 @@ export class ClientSDK {
   }
 }
 
-const jsonLikeContentTypeRE = /(application|text)\/.*?\+*json.*/;
-const jsonlLikeContentTypeRE =
-  /(application|text)\/(.*?\+*\bjsonl\b.*|.*?\+*\bx-ndjson\b.*)/;
+const jsonLikeContentTypeRE = /^application\/(?:.{0,100}\+)?json/;
 async function logRequest(logger: Logger | undefined, req: Request) {
   if (!logger) {
     return;
@@ -376,13 +373,9 @@ async function logResponse(
   logger.group("Body:");
   switch (true) {
     case matchContentType(res, "application/json")
-      || jsonLikeContentTypeRE.test(ct) && !jsonlLikeContentTypeRE.test(ct):
+      || jsonLikeContentTypeRE.test(ct):
       logger.log(await res.clone().json());
       break;
-    case matchContentType(res, "application/jsonl")
-      || jsonlLikeContentTypeRE.test(ct):
-      logger.log(await res.clone().text());
-      break;
     case matchContentType(res, "text/event-stream"):
       logger.log(`<${contentType}>`);
       break;

package/src/lib/security.ts

@@ -4,11 +4,10 @@
 
 import * as components from "../models/components/index.js";
 import { env } from "./env.js";
-
 type OAuth2PasswordFlow = {
   username: string;
-  password: string;
-  clientID?: string | undefined;
+  password?: string | undefined;
+  clientID: string;
   clientSecret?: string | undefined;
   tokenURL: string;
 };
@@ -86,9 +85,7 @@ type SecurityInputOAuth2ClientCredentials = {
   value:
     | { clientID?: string | undefined; clientSecret?: string | undefined }
     | null
-    | string
     | undefined;
-  fieldName?: string;
 };
 
 type SecurityInputOAuth2PasswordCredentials = {
@@ -97,13 +94,13 @@ type SecurityInputOAuth2PasswordCredentials = {
     | string
     | null
     | undefined;
-  fieldName?: string;
+  fieldName: string;
 };
 
 type SecurityInputCustom = {
   type: "http:custom";
   value: any | null | undefined;
-  fieldName?: string;
+  fieldName: string;
 };
 
 export type SecurityInput =
@@ -140,9 +137,6 @@ export function resolveSecurity(
           typeof o.value === "string" && !!o.value
         );
       } else if (o.type === "oauth2:client_credentials") {
-        if (typeof o.value == "string") {
-          return !!o.value;
-        }
         return o.value.clientID != null || o.value.clientSecret != null;
       } else if (typeof o.value === "string") {
         return !!o.value;
@@ -231,9 +225,7 @@ function applyBearer(
     value = `Bearer ${value}`;
   }
 
-  if (spec.fieldName !== undefined) {
-    state.headers[spec.fieldName] = value;
-  }
+  state.headers[spec.fieldName] = value;
 }
 
 export function resolveGlobalSecurity(

package/src/models/components/agentsttprovider.ts

@@ -9,8 +9,8 @@ import { ClosedEnum } from "../../types/enums.js";
  * Speech-to-text providers supported by agents.
  */
 export const AgentSttProvider = {
-  GoogleSTTV1: "Google STT V1",
   GoogleSTTV2: "Google STT V2",
+  GoogleSTTV1: "Google STT V1",
   DeepgramNova2: "Deepgram Nova 2",
 } as const;
 /**

package/src/models/components/bodyorganizationscreate.ts

@@ -15,22 +15,22 @@ export type BodyOrganizationsCreateLogo = {
 };
 
 export type BodyOrganizationsCreate = {
-  /**
-   * The organization logo image file to upload. Must be a PNG file and 120x120 pixels.
-   */
-  logo: BodyOrganizationsCreateLogo | Blob;
   /**
    * The human-readable display name of the organization
    */
   displayName: string;
-  /**
-   * Description of the organization
-   */
-  description?: string | null | undefined;
   /**
    * Comma-delimited list of domains that users at the organization may have in their email addresses
    */
   domains: string;
+  /**
+   * The organization logo image file to upload. Must be a PNG file and 120x120 pixels.
+   */
+  logo: BodyOrganizationsCreateLogo | Blob;
+  /**
+   * Description of the organization
+   */
+  description?: string | null | undefined;
 };
 
 /** @internal */
@@ -108,10 +108,10 @@ export const BodyOrganizationsCreate$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  logo: z.lazy(() => BodyOrganizationsCreateLogo$inboundSchema),
   display_name: z.string(),
-  description: z.nullable(z.string()).optional(),
   domains: z.string(),
+  logo: z.lazy(() => BodyOrganizationsCreateLogo$inboundSchema),
+  description: z.nullable(z.string()).optional(),
 }).transform((v) => {
   return remap$(v, {
     "display_name": "displayName",
@@ -120,10 +120,10 @@ export const BodyOrganizationsCreate$inboundSchema: z.ZodType<
 
 /** @internal */
 export type BodyOrganizationsCreate$Outbound = {
-  logo: BodyOrganizationsCreateLogo$Outbound | Blob;
   display_name: string;
-  description?: string | null | undefined;
   domains: string;
+  logo: BodyOrganizationsCreateLogo$Outbound | Blob;
+  description?: string | null | undefined;
 };
 
 /** @internal */
@@ -132,12 +132,12 @@ export const BodyOrganizationsCreate$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   BodyOrganizationsCreate
 > = z.object({
+  displayName: z.string(),
+  domains: z.string(),
   logo: z.lazy(() => BodyOrganizationsCreateLogo$outboundSchema).or(
     blobLikeSchema,
   ),
-  displayName: z.string(),
   description: z.nullable(z.string()).optional(),
-  domains: z.string(),
 }).transform((v) => {
   return remap$(v, {
     displayName: "display_name",

package/src/models/components/bodyorganizationsupdate.ts

@@ -15,22 +15,22 @@ export type Logo = {
 };
 
 export type BodyOrganizationsUpdate = {
-  /**
-   * The organization logo image file to upload. Must be a PNG file and 120x120 pixels. If not provided, the logo will not be updated.
-   */
-  logo?: Logo | Blob | undefined;
   /**
    * The human-readable display name of the organization
    */
   displayName: string;
+  /**
+   * Comma-delimited list of domains that users at the organization may have in their email addresses
+   */
+  domains: string;
   /**
    * Description of the organization
    */
   description?: string | null | undefined;
   /**
-   * Comma-delimited list of domains that users at the organization may have in their email addresses
+   * The organization logo image file to upload. Must be a PNG file and 120x120 pixels. If not provided, the logo will not be updated.
    */
-  domains: string;
+  logo?: Logo | Blob | undefined;
   /**
    * Comments about the update
    */
@@ -100,10 +100,10 @@ export const BodyOrganizationsUpdate$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  logo: z.lazy(() => Logo$inboundSchema).optional(),
   display_name: z.string(),
-  description: z.nullable(z.string()).optional(),
   domains: z.string(),
+  description: z.nullable(z.string()).optional(),
+  logo: z.lazy(() => Logo$inboundSchema).optional(),
   update_comments: z.nullable(z.string()).optional(),
 }).transform((v) => {
   return remap$(v, {
@@ -114,10 +114,10 @@ export const BodyOrganizationsUpdate$inboundSchema: z.ZodType<
 
 /** @internal */
 export type BodyOrganizationsUpdate$Outbound = {
-  logo?: Logo$Outbound | Blob | undefined;
   display_name: string;
-  description?: string | null | undefined;
   domains: string;
+  description?: string | null | undefined;
+  logo?: Logo$Outbound | Blob | undefined;
   update_comments?: string | null | undefined;
 };
 
@@ -127,10 +127,10 @@ export const BodyOrganizationsUpdate$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   BodyOrganizationsUpdate
 > = z.object({
-  logo: z.lazy(() => Logo$outboundSchema).or(blobLikeSchema).optional(),
   displayName: z.string(),
-  description: z.nullable(z.string()).optional(),
   domains: z.string(),
+  description: z.nullable(z.string()).optional(),
+  logo: z.lazy(() => Logo$outboundSchema).or(blobLikeSchema).optional(),
   updateComments: z.nullable(z.string()).optional(),
 }).transform((v) => {
   return remap$(v, {

package/src/models/components/insightworkflowcondition.ts

@@ -41,6 +41,10 @@ export type InsightWorkflowCondition = {
    * List of folder IDs
    */
   folderList?: Array<number> | null | undefined;
+  /**
+   * Information about the sheet to be used for the workflow
+   */
+  sheetInfo?: { [k: string]: string } | null | undefined;
 };
 
 /** @internal */
@@ -101,6 +105,7 @@ export const InsightWorkflowCondition$inboundSchema: z.ZodType<
   ).optional(),
   prompt_list: z.nullable(z.array(z.string())).optional(),
   folder_list: z.nullable(z.array(z.number().int())).optional(),
+  sheet_info: z.nullable(z.record(z.string())).optional(),
 }).transform((v) => {
   return remap$(v, {
     "min_duration": "minDuration",
@@ -109,6 +114,7 @@ export const InsightWorkflowCondition$inboundSchema: z.ZodType<
     "agent_list": "agentList",
     "prompt_list": "promptList",
     "folder_list": "folderList",
+    "sheet_info": "sheetInfo",
   });
 });
 
@@ -120,6 +126,7 @@ export type InsightWorkflowCondition$Outbound = {
   agent_list?: Array<number> | Array<string> | null | undefined;
   prompt_list?: Array<string> | null | undefined;
   folder_list?: Array<number> | null | undefined;
+  sheet_info?: { [k: string]: string } | null | undefined;
 };
 
 /** @internal */
@@ -136,6 +143,7 @@ export const InsightWorkflowCondition$outboundSchema: z.ZodType<
   ).optional(),
   promptList: z.nullable(z.array(z.string())).optional(),
   folderList: z.nullable(z.array(z.number().int())).optional(),
+  sheetInfo: z.nullable(z.record(z.string())).optional(),
 }).transform((v) => {
   return remap$(v, {
     minDuration: "min_duration",
@@ -144,6 +152,7 @@ export const InsightWorkflowCondition$outboundSchema: z.ZodType<
     agentList: "agent_list",
     promptList: "prompt_list",
     folderList: "folder_list",
+    sheetInfo: "sheet_info",
   });
 });
 

package/src/models/components/insightworkflowinput.ts

@@ -23,15 +23,15 @@ export type InsightWorkflowInput = {
    */
   name: string;
   /**
-   * Source of the insight workflow
+   * Source of the workflow
    */
   source: string;
   /**
-   * Text description of insight workflow
+   * Text description of workflow
    */
   description: string;
   /**
-   * List of IDs of insight tool configurations used in the workflow
+   * Ordered list of IDs of tool configurations to be executed in the workflow
    */
   insightToolIds: Array<number>;
   /**
@@ -39,11 +39,11 @@ export type InsightWorkflowInput = {
    */
   conditions: InsightWorkflowCondition;
   /**
-   * Timestamp for when the insight workflow should start. An empty value indicates start on activation
+   * Target session timestamp the workflow (backfill) should start. An empty value indicates start on activation - live sessions only
    */
   startDatetime?: Date | null | undefined;
   /**
-   * Timestamp of when the insight workflow should end. An empty value indicates no end
+   * Target session timestamp the workflow (backfill) should end. An empty value indicates no end, i.e., include live sessions until deactivation
    */
   endDatetime?: Date | null | undefined;
 };

package/src/models/components/insightworkflowoutput.ts

@@ -35,15 +35,15 @@ export type InsightWorkflowOutput = {
    */
   name: string;
   /**
-   * Source of the insight workflow
+   * Source of the workflow
    */
   source: string;
   /**
-   * Text description of insight workflow
+   * Text description of workflow
    */
   description: string;
   /**
-   * List of IDs of insight tool configurations used in the workflow
+   * Ordered list of IDs of tool configurations to be executed in the workflow
    */
   insightToolIds: Array<number>;
   /**
@@ -51,11 +51,11 @@ export type InsightWorkflowOutput = {
    */
   conditions: InsightWorkflowCondition;
   /**
-   * Timestamp for when the insight workflow should start. An empty value indicates start on activation
+   * Target session timestamp the workflow (backfill) should start. An empty value indicates start on activation - live sessions only
    */
   startDatetime?: Date | null | undefined;
   /**
-   * Timestamp of when the insight workflow should end. An empty value indicates no end
+   * Target session timestamp the workflow (backfill) should end. An empty value indicates no end, i.e., include live sessions until deactivation
    */
   endDatetime?: Date | null | undefined;
   /**