syllable-sdk 0.1.0-alpha.28 → 0.1.0-alpha.29

package/src/funcs/v1PostSessionSummaryDashboard.ts

@@ -0,0 +1,111 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { SyllableSDKCore } from "../core.js";
+import * as M from "../lib/matchers.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
+import { pathToFunc } from "../lib/url.js";
+import * as components from "../models/components/index.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import { SDKError } from "../models/errors/sdkerror.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import { Result } from "../types/fp.js";
+
+/**
+ * Post Session Summary
+ *
+ * @remarks
+ * METHOD: POST
+ * URL: /dashboard/session_summary
+ * ARGUMENTS: None
+ * RETURNS: Dashboard info for embedding
+ */
+export async function v1PostSessionSummaryDashboard(
+  client: SyllableSDKCore,
+  options?: RequestOptions,
+): Promise<
+  Result<
+    components.Dashboard,
+    | SDKError
+    | SDKValidationError
+    | UnexpectedClientError
+    | InvalidRequestError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | ConnectionError
+  >
+> {
+  const path = pathToFunc("/api/v1/dashboards/session_summary")();
+
+  const headers = new Headers({
+    Accept: "application/json",
+  });
+
+  const secConfig = await extractSecurity(client._options.apiKeyHeader);
+  const securityInput = secConfig == null ? {} : { apiKeyHeader: secConfig };
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
+  const context = {
+    operationID: "post_session_summary_dashboard",
+    oAuth2Scopes: [],
+
+    resolvedSecurity: requestSecurity,
+
+    securitySource: client._options.apiKeyHeader,
+    retryConfig: options?.retries
+      || client._options.retryConfig
+      || { strategy: "none" },
+    retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
+  };
+
+  const requestRes = client._createRequest(context, {
+    security: requestSecurity,
+    method: "POST",
+    baseURL: options?.serverURL,
+    path: path,
+    headers: headers,
+    timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
+  }, options);
+  if (!requestRes.ok) {
+    return requestRes;
+  }
+  const req = requestRes.value;
+
+  const doResult = await client._do(req, {
+    context,
+    errorCodes: ["4XX", "5XX"],
+    retryConfig: context.retryConfig,
+    retryCodes: context.retryCodes,
+  });
+  if (!doResult.ok) {
+    return doResult;
+  }
+  const response = doResult.value;
+
+  const [result] = await M.match<
+    components.Dashboard,
+    | SDKError
+    | SDKValidationError
+    | UnexpectedClientError
+    | InvalidRequestError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | ConnectionError
+  >(
+    M.json(200, components.Dashboard$inboundSchema),
+    M.fail(["4XX", "5XX"]),
+  )(response);
+  if (!result.ok) {
+    return result;
+  }
+
+  return result;
+}

package/src/funcs/v1PostSessionTransfersDashboard.ts

@@ -0,0 +1,111 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { SyllableSDKCore } from "../core.js";
+import * as M from "../lib/matchers.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
+import { pathToFunc } from "../lib/url.js";
+import * as components from "../models/components/index.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import { SDKError } from "../models/errors/sdkerror.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import { Result } from "../types/fp.js";
+
+/**
+ * Post Session Transfers
+ *
+ * @remarks
+ * METHOD: POST
+ * URL: /dashboard/session_transfers
+ * ARGUMENTS: None
+ * RETURNS: Dashboard info for embedding
+ */
+export async function v1PostSessionTransfersDashboard(
+  client: SyllableSDKCore,
+  options?: RequestOptions,
+): Promise<
+  Result<
+    components.Dashboard,
+    | SDKError
+    | SDKValidationError
+    | UnexpectedClientError
+    | InvalidRequestError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | ConnectionError
+  >
+> {
+  const path = pathToFunc("/api/v1/dashboards/session_transfers")();
+
+  const headers = new Headers({
+    Accept: "application/json",
+  });
+
+  const secConfig = await extractSecurity(client._options.apiKeyHeader);
+  const securityInput = secConfig == null ? {} : { apiKeyHeader: secConfig };
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
+  const context = {
+    operationID: "post_session_transfers_dashboard",
+    oAuth2Scopes: [],
+
+    resolvedSecurity: requestSecurity,
+
+    securitySource: client._options.apiKeyHeader,
+    retryConfig: options?.retries
+      || client._options.retryConfig
+      || { strategy: "none" },
+    retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
+  };
+
+  const requestRes = client._createRequest(context, {
+    security: requestSecurity,
+    method: "POST",
+    baseURL: options?.serverURL,
+    path: path,
+    headers: headers,
+    timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
+  }, options);
+  if (!requestRes.ok) {
+    return requestRes;
+  }
+  const req = requestRes.value;
+
+  const doResult = await client._do(req, {
+    context,
+    errorCodes: ["4XX", "5XX"],
+    retryConfig: context.retryConfig,
+    retryCodes: context.retryCodes,
+  });
+  if (!doResult.ok) {
+    return doResult;
+  }
+  const response = doResult.value;
+
+  const [result] = await M.match<
+    components.Dashboard,
+    | SDKError
+    | SDKValidationError
+    | UnexpectedClientError
+    | InvalidRequestError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | ConnectionError
+  >(
+    M.json(200, components.Dashboard$inboundSchema),
+    M.fail(["4XX", "5XX"]),
+  )(response);
+  if (!result.ok) {
+    return result;
+  }
+
+  return result;
+}

package/src/funcs/v1PostSessionsDashboard.ts

@@ -0,0 +1,111 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { SyllableSDKCore } from "../core.js";
+import * as M from "../lib/matchers.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
+import { pathToFunc } from "../lib/url.js";
+import * as components from "../models/components/index.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import { SDKError } from "../models/errors/sdkerror.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import { Result } from "../types/fp.js";
+
+/**
+ * Post Sessions
+ *
+ * @remarks
+ * METHOD: POST
+ * URL: /dashboard/sessions
+ * ARGUMENTS: None
+ * RETURNS: Dashboard info for embedding
+ */
+export async function v1PostSessionsDashboard(
+  client: SyllableSDKCore,
+  options?: RequestOptions,
+): Promise<
+  Result<
+    components.Dashboard,
+    | SDKError
+    | SDKValidationError
+    | UnexpectedClientError
+    | InvalidRequestError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | ConnectionError
+  >
+> {
+  const path = pathToFunc("/api/v1/dashboards/sessions")();
+
+  const headers = new Headers({
+    Accept: "application/json",
+  });
+
+  const secConfig = await extractSecurity(client._options.apiKeyHeader);
+  const securityInput = secConfig == null ? {} : { apiKeyHeader: secConfig };
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
+  const context = {
+    operationID: "post_sessions_dashboard",
+    oAuth2Scopes: [],
+
+    resolvedSecurity: requestSecurity,
+
+    securitySource: client._options.apiKeyHeader,
+    retryConfig: options?.retries
+      || client._options.retryConfig
+      || { strategy: "none" },
+    retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
+  };
+
+  const requestRes = client._createRequest(context, {
+    security: requestSecurity,
+    method: "POST",
+    baseURL: options?.serverURL,
+    path: path,
+    headers: headers,
+    timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
+  }, options);
+  if (!requestRes.ok) {
+    return requestRes;
+  }
+  const req = requestRes.value;
+
+  const doResult = await client._do(req, {
+    context,
+    errorCodes: ["4XX", "5XX"],
+    retryConfig: context.retryConfig,
+    retryCodes: context.retryCodes,
+  });
+  if (!doResult.ok) {
+    return doResult;
+  }
+  const response = doResult.value;
+
+  const [result] = await M.match<
+    components.Dashboard,
+    | SDKError
+    | SDKValidationError
+    | UnexpectedClientError
+    | InvalidRequestError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | ConnectionError
+  >(
+    M.json(200, components.Dashboard$inboundSchema),
+    M.fail(["4XX", "5XX"]),
+  )(response);
+  if (!result.ok) {
+    return result;
+  }
+
+  return result;
+}

package/src/lib/config.ts

@@ -61,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.28",
-  genVersion: "2.481.0",
+  sdkVersion: "0.1.0-alpha.29",
+  genVersion: "2.492.3",
   userAgent:
-    "speakeasy-sdk/typescript 0.1.0-alpha.28 2.481.0 0.0.2 syllable-sdk",
+    "speakeasy-sdk/typescript 0.1.0-alpha.29 2.492.3 0.0.2 syllable-sdk",
 } as const;

package/src/lib/security.ts

@@ -118,7 +118,7 @@ export function resolveSecurity(
   ...options: SecurityInput[][]
 ): SecurityState | null {
   const state: SecurityState = {
-    basic: { username: "", password: "" },
+    basic: {},
     headers: {},
     queryParams: {},
     cookies: {},

package/src/models/components/channeltargetproperties.ts

@@ -14,6 +14,7 @@ export const ChannelTargetProperties = {
   TargetMode: "target_mode",
   FallbackTarget: "fallback_target",
   IsTest: "is_test",
+  UpdatedAt: "updated_at",
 } as const;
 export type ChannelTargetProperties = ClosedEnum<
   typeof ChannelTargetProperties

package/src/models/components/dashboard.ts

@@ -0,0 +1,87 @@
+/*
+ * 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 Dashboard = {
+  embeddedId: string;
+  guestToken: string;
+  name: string;
+  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/index.ts

@@ -30,6 +30,7 @@ export * from "./custommessageresponse.js";
 export * from "./custommessageupdaterequest.js";
 export * from "./daochanneltargetagent.js";
 export * from "./daocustommessagerule.js";
+export * from "./dashboard.js";
 export * from "./dayofweek.js";
 export * from "./directoryextension.js";
 export * from "./directorymember.js";

package/src/models/components/toolparameterdefault.ts

@@ -19,6 +19,12 @@ import {
 export type ToolParameterDefault = {
   /**
    * A transform to be applied to the value of a parameter.
+   *
+   * @remarks
+   *
+   * Either `value` or `format` must be set:
+   * - `value` is any arbitrary value: string, list or dictionary.
+   * - `format` is a string composed of other parameters or context variables.
    */
   transform: ToolParameterTransform;
 };

package/src/models/components/toolparametertransform.ts

@@ -29,16 +29,26 @@ export type Action = ClosedEnum<typeof Action>;
 
 /**
  * A transform to be applied to the value of a parameter.
+ *
+ * @remarks
+ *
+ * Either `value` or `format` must be set:
+ * - `value` is any arbitrary value: string, list or dictionary.
+ * - `format` is a string composed of other parameters or context variables.
  */
 export type ToolParameterTransform = {
+  /**
+   * The action to perform on the value: `default` means only set the value (using the `format` field) if the parameter doesn't exist or is empty, `override` means always set the value, and `remove` means remove the parameter value.
+   */
+  action?: Action | undefined;
   /**
    * Only apply the transform if the condition is met.
    */
   when?: ToolParameterTransformCondition | null | undefined;
   /**
-   * The action to perform on the value: `default` means only set the value (using the `format` field) if the parameter doesn't exist or is empty, `override` means always set the value, and `remove` means remove the parameter value.
+   * The default value to use for the parameter.
    */
-  action?: Action | undefined;
+  value?: any | null | undefined;
   /**
    * The string value to use for the parameter. The value will be evaluated with the Python `str.format` method, for example, `Hello, {name}!`
    */
@@ -70,15 +80,17 @@ export const ToolParameterTransform$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  when: z.nullable(ToolParameterTransformCondition$inboundSchema).optional(),
   action: Action$inboundSchema.default("default"),
+  when: z.nullable(ToolParameterTransformCondition$inboundSchema).optional(),
+  value: z.nullable(z.any()).optional(),
   format: z.nullable(z.string()).optional(),
 });
 
 /** @internal */
 export type ToolParameterTransform$Outbound = {
-  when?: ToolParameterTransformCondition$Outbound | null | undefined;
   action: string;
+  when?: ToolParameterTransformCondition$Outbound | null | undefined;
+  value?: any | null | undefined;
   format?: string | null | undefined;
 };
 
@@ -88,8 +100,9 @@ export const ToolParameterTransform$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   ToolParameterTransform
 > = z.object({
-  when: z.nullable(ToolParameterTransformCondition$outboundSchema).optional(),
   action: Action$outboundSchema.default("default"),
+  when: z.nullable(ToolParameterTransformCondition$outboundSchema).optional(),
+  value: z.nullable(z.any()).optional(),
   format: z.nullable(z.string()).optional(),
 });
 

package/src/sdk/dashboards.ts

@@ -0,0 +1,85 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { dashboardsPostSessionEventsDashboard } from "../funcs/dashboardsPostSessionEventsDashboard.js";
+import { dashboardsPostSessionsDashboard } from "../funcs/dashboardsPostSessionsDashboard.js";
+import { dashboardsPostSessionSummaryDashboard } from "../funcs/dashboardsPostSessionSummaryDashboard.js";
+import { dashboardsPostSessionTransfersDashboard } from "../funcs/dashboardsPostSessionTransfersDashboard.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as components from "../models/components/index.js";
+import { unwrapAsync } from "../types/fp.js";
+
+export class Dashboards extends ClientSDK {
+  /**
+   * Post Session Events
+   *
+   * @remarks
+   * METHOD: POST
+   * URL: /dashboard/session_events
+   * ARGUMENTS: None
+   * RETURNS: Dashboard info for embedding
+   */
+  async postSessionEventsDashboard(
+    options?: RequestOptions,
+  ): Promise<components.Dashboard> {
+    return unwrapAsync(dashboardsPostSessionEventsDashboard(
+      this,
+      options,
+    ));
+  }
+
+  /**
+   * Post Session Summary
+   *
+   * @remarks
+   * METHOD: POST
+   * URL: /dashboard/session_summary
+   * ARGUMENTS: None
+   * RETURNS: Dashboard info for embedding
+   */
+  async postSessionSummaryDashboard(
+    options?: RequestOptions,
+  ): Promise<components.Dashboard> {
+    return unwrapAsync(dashboardsPostSessionSummaryDashboard(
+      this,
+      options,
+    ));
+  }
+
+  /**
+   * Post Session Transfers
+   *
+   * @remarks
+   * METHOD: POST
+   * URL: /dashboard/session_transfers
+   * ARGUMENTS: None
+   * RETURNS: Dashboard info for embedding
+   */
+  async postSessionTransfersDashboard(
+    options?: RequestOptions,
+  ): Promise<components.Dashboard> {
+    return unwrapAsync(dashboardsPostSessionTransfersDashboard(
+      this,
+      options,
+    ));
+  }
+
+  /**
+   * Post Sessions
+   *
+   * @remarks
+   * METHOD: POST
+   * URL: /dashboard/sessions
+   * ARGUMENTS: None
+   * RETURNS: Dashboard info for embedding
+   */
+  async postSessionsDashboard(
+    options?: RequestOptions,
+  ): Promise<components.Dashboard> {
+    return unwrapAsync(dashboardsPostSessionsDashboard(
+      this,
+      options,
+    ));
+  }
+}

package/src/sdk/sdk.ts

@@ -7,6 +7,7 @@ import { Agents } from "./agents.js";
 import { Channels } from "./channels.js";
 import { Conversations } from "./conversations.js";
 import { CustomMessages } from "./custommessages.js";
+import { Dashboards } from "./dashboards.js";
 import { Directory } from "./directory.js";
 import { Events } from "./events.js";
 import { Prompts } from "./prompts.js";
@@ -14,6 +15,7 @@ import { Services } from "./services.js";
 import { SessionLabels } from "./sessionlabels.js";
 import { Sessions } from "./sessions.js";
 import { Tools } from "./tools.js";
+import { V1 } from "./v1.js";
 
 export class SyllableSDK extends ClientSDK {
   private _agents?: Agents;
@@ -70,4 +72,14 @@ export class SyllableSDK extends ClientSDK {
   get directory(): Directory {
     return (this._directory ??= new Directory(this._options));
   }
+
+  private _dashboards?: Dashboards;
+  get dashboards(): Dashboards {
+    return (this._dashboards ??= new Dashboards(this._options));
+  }
+
+  private _v1?: V1;
+  get v1(): V1 {
+    return (this._v1 ??= new V1(this._options));
+  }
 }