@meetkai/mka1 0.55.34 → 0.55.35

package/src/models/components/createwebagentconnectorrequest.ts

@@ -0,0 +1,202 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+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 Appearance = {
+  /**
+   * Trimmed before the length check.
+   */
+  title?: string | undefined;
+  /**
+   * Opening message; an empty string shows none.
+   */
+  greeting?: string | undefined;
+  /**
+   * Trimmed before the length check.
+   */
+  placeholder?: string | undefined;
+  primaryColor?: string | undefined;
+  /**
+   * An https image URL shown in the widget header.
+   */
+  logoUrl?: string | undefined;
+};
+
+export type Web = {
+  /**
+   * Exact https origins (scheme, host and optional port, no path) allowed to frame the widget. Empty allows any site to frame it (frame-ancestors *); a non-empty list is enforced by the browser through the page's CSP frame-ancestors directive, and the session mint also checks the request's Origin header. Neither allowed_origins nor allow_direct_link limits non-browser callers; spend is bounded by the per-embed and per-session limits.
+   */
+  allowedOrigins?: Array<string> | undefined;
+  /**
+   * Whether the iframe URL also works as a standalone chat page when opened directly. Setting it to false requires a non-empty allowed_origins list. This is a browser-side rule only; it does not limit non-browser callers.
+   */
+  allowDirectLink?: boolean | undefined;
+  appearance?: Appearance | undefined;
+};
+
+/**
+ * Web chat widget connector configuration. Appearance and origins are fixed at creation; recreate the connector to change them. Visitors are anonymous and every message runs the agent with this API key's identity, so use a dedicated, minimally scoped key for agents with tools.
+ */
+export type CreateWebAgentConnectorRequest = {
+  /**
+   * Embeddable text-only web chat served from the connector worker at /widget/agent/v1.
+   */
+  provider: "web";
+  name?: string | undefined;
+  web?: Web | undefined;
+};
+
+/** @internal */
+export const Appearance$inboundSchema: z.ZodType<
+  Appearance,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  title: z.string().default("Chat"),
+  greeting: z.string().default("Hi! How can I help?"),
+  placeholder: z.string().default("Type a message"),
+  primary_color: z.string().default("#0f0f10"),
+  logo_url: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "primary_color": "primaryColor",
+    "logo_url": "logoUrl",
+  });
+});
+/** @internal */
+export type Appearance$Outbound = {
+  title: string;
+  greeting: string;
+  placeholder: string;
+  primary_color: string;
+  logo_url?: string | undefined;
+};
+
+/** @internal */
+export const Appearance$outboundSchema: z.ZodType<
+  Appearance$Outbound,
+  z.ZodTypeDef,
+  Appearance
+> = z.object({
+  title: z.string().default("Chat"),
+  greeting: z.string().default("Hi! How can I help?"),
+  placeholder: z.string().default("Type a message"),
+  primaryColor: z.string().default("#0f0f10"),
+  logoUrl: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    primaryColor: "primary_color",
+    logoUrl: "logo_url",
+  });
+});
+
+export function appearanceToJSON(appearance: Appearance): string {
+  return JSON.stringify(Appearance$outboundSchema.parse(appearance));
+}
+export function appearanceFromJSON(
+  jsonString: string,
+): SafeParseResult<Appearance, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Appearance$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Appearance' from JSON`,
+  );
+}
+
+/** @internal */
+export const Web$inboundSchema: z.ZodType<Web, z.ZodTypeDef, unknown> = z
+  .object({
+    allowed_origins: z.array(z.string()).optional(),
+    allow_direct_link: z.boolean().default(true),
+    appearance: z.lazy(() => Appearance$inboundSchema).optional(),
+  }).transform((v) => {
+    return remap$(v, {
+      "allowed_origins": "allowedOrigins",
+      "allow_direct_link": "allowDirectLink",
+    });
+  });
+/** @internal */
+export type Web$Outbound = {
+  allowed_origins?: Array<string> | undefined;
+  allow_direct_link: boolean;
+  appearance?: Appearance$Outbound | undefined;
+};
+
+/** @internal */
+export const Web$outboundSchema: z.ZodType<Web$Outbound, z.ZodTypeDef, Web> = z
+  .object({
+    allowedOrigins: z.array(z.string()).optional(),
+    allowDirectLink: z.boolean().default(true),
+    appearance: z.lazy(() => Appearance$outboundSchema).optional(),
+  }).transform((v) => {
+    return remap$(v, {
+      allowedOrigins: "allowed_origins",
+      allowDirectLink: "allow_direct_link",
+    });
+  });
+
+export function webToJSON(web: Web): string {
+  return JSON.stringify(Web$outboundSchema.parse(web));
+}
+export function webFromJSON(
+  jsonString: string,
+): SafeParseResult<Web, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Web$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Web' from JSON`,
+  );
+}
+
+/** @internal */
+export const CreateWebAgentConnectorRequest$inboundSchema: z.ZodType<
+  CreateWebAgentConnectorRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  provider: z.literal("web"),
+  name: z.string().optional(),
+  web: z.lazy(() => Web$inboundSchema).optional(),
+});
+/** @internal */
+export type CreateWebAgentConnectorRequest$Outbound = {
+  provider: "web";
+  name?: string | undefined;
+  web?: Web$Outbound | undefined;
+};
+
+/** @internal */
+export const CreateWebAgentConnectorRequest$outboundSchema: z.ZodType<
+  CreateWebAgentConnectorRequest$Outbound,
+  z.ZodTypeDef,
+  CreateWebAgentConnectorRequest
+> = z.object({
+  provider: z.literal("web"),
+  name: z.string().optional(),
+  web: z.lazy(() => Web$outboundSchema).optional(),
+});
+
+export function createWebAgentConnectorRequestToJSON(
+  createWebAgentConnectorRequest: CreateWebAgentConnectorRequest,
+): string {
+  return JSON.stringify(
+    CreateWebAgentConnectorRequest$outboundSchema.parse(
+      createWebAgentConnectorRequest,
+    ),
+  );
+}
+export function createWebAgentConnectorRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<CreateWebAgentConnectorRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CreateWebAgentConnectorRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CreateWebAgentConnectorRequest' from JSON`,
+  );
+}

package/src/models/components/index.ts

@@ -14,6 +14,7 @@ export * from "./agent.js";
 export * from "./agentcompactioncontextmanagement.js";
 export * from "./agentconnector.js";
 export * from "./agentconnectordeleted.js";
+export * from "./agentconnectorembed.js";
 export * from "./agentconnectorlist.js";
 export * from "./agentlist.js";
 export * from "./agentreasoningconfiguration.js";
@@ -243,6 +244,7 @@ export * from "./createvectorstorefilerequest.js";
 export * from "./createvectorstorepermissionrequest.js";
 export * from "./createvectorstorerequest.js";
 export * from "./createversionresponse.js";
+export * from "./createwebagentconnectorrequest.js";
 export * from "./createwhatsappagentconnectorrequest.js";
 export * from "./customtoolcall.js";
 export * from "./customtoolcalloutput.js";

package/src/react-query/agentConnectorsActivateAgentConnector.ts

@@ -51,7 +51,7 @@ export type AgentConnectorsActivateAgentConnectorMutationError =
  * Activate a connector
  *
  * @remarks
- * Revalidates the stored provider credentials and registers the provider webhook. Use this to retry a connector left in an error state. API-key authentication with every listed scope is required; session authentication is rejected, and the key must belong to the connector's original user or service-account principal so existing conversations keep the same owner.
+ * Revalidates the stored provider credentials and registers the provider webhook. Use this to retry a connector left in an error state. API-key authentication with every listed scope is required; session authentication is rejected, and the key must belong to the connector's original user or service-account principal so existing conversations keep the same owner. Web connectors have no provider webhook; activation only re-authorizes the stored API-key identity.
  */
 export function useAgentConnectorsActivateAgentConnectorMutation(
   options?: MutationHookOptions<

package/src/react-query/agentConnectorsCreateAgentConnector.ts

@@ -51,7 +51,7 @@ export type AgentConnectorsCreateAgentConnectorMutationError =
  * Create a connector
  *
  * @remarks
- * Connects the agent to a Telegram bot or WhatsApp Business phone number, validates the provider credentials, and registers the agent's webhook. WhatsApp connector support is beta. Text, photos, and gateway-supported documents can invoke the agent; inbound media additionally requires write:files. Managed outbound files require read:files, and generated images require both file scopes so their transient provider URLs can be materialized before delivery. The optional write:feedback scope enables native thumbs reaction synchronization to gateway response feedback. These conditional scopes are deliberately not part of x-required-scopes because text-only connectors do not need them. An API key with every listed scope is required; its identity tuple and current scopes are stored as a non-widening ceiling, then revalidated with mk-authentication before every connector run; session and delegated end-user contexts are rejected. The required access policy controls which provider users or chats may invoke the agent.
+ * Connects the agent to a Telegram bot or WhatsApp Business phone number, validates the provider credentials, and registers the agent's webhook. WhatsApp connector support is beta. Text, photos, and gateway-supported documents can invoke the agent; inbound media additionally requires write:files. Managed outbound files require read:files, and generated images require both file scopes so their transient provider URLs can be materialized before delivery. The optional write:feedback scope enables native thumbs reaction synchronization to gateway response feedback. These conditional scopes are deliberately not part of x-required-scopes because text-only connectors do not need them. An API key with every listed scope is required; its identity tuple and current scopes are stored as a non-widening ceiling, then revalidated with mk-authentication before every connector run; session and delegated end-user contexts are rejected. The required access policy controls which provider users or chats may invoke the agent. A web connector (provider web) needs no provider credentials or access policy: it is active immediately and returns an embed object with an iframe URL and snippet for an anonymous web chat widget whose visitors are limited by signed sessions, rate limits and the optional allowed_origins list. Creating a web connector returns 409 when the deployment has not enabled web chat.
  */
 export function useAgentConnectorsCreateAgentConnectorMutation(
   options?: MutationHookOptions<

package/src/react-query/agentConnectorsDeleteAgentConnector.ts

@@ -51,7 +51,7 @@ export type AgentConnectorsDeleteAgentConnectorMutationError =
  * Delete a connector
  *
  * @remarks
- * Unregisters the connector-specific provider webhook and deletes the stored connector credentials. Telegram pending updates are dropped; WhatsApp deletion clears only the phone-number callback and does not unsubscribe other numbers in the business account.
+ * Unregisters the connector-specific provider webhook and deletes the stored connector credentials. Telegram pending updates are dropped; WhatsApp deletion clears only the phone-number callback and does not unsubscribe other numbers in the business account. Deleting a web connector disables its embed immediately.
  */
 export function useAgentConnectorsDeleteAgentConnectorMutation(
   options?: MutationHookOptions<

package/src/sdk/agentconnectors.ts

@@ -35,7 +35,7 @@ export class AgentConnectors extends ClientSDK {
    * Create a connector
    *
    * @remarks
-   * Connects the agent to a Telegram bot or WhatsApp Business phone number, validates the provider credentials, and registers the agent's webhook. WhatsApp connector support is beta. Text, photos, and gateway-supported documents can invoke the agent; inbound media additionally requires write:files. Managed outbound files require read:files, and generated images require both file scopes so their transient provider URLs can be materialized before delivery. The optional write:feedback scope enables native thumbs reaction synchronization to gateway response feedback. These conditional scopes are deliberately not part of x-required-scopes because text-only connectors do not need them. An API key with every listed scope is required; its identity tuple and current scopes are stored as a non-widening ceiling, then revalidated with mk-authentication before every connector run; session and delegated end-user contexts are rejected. The required access policy controls which provider users or chats may invoke the agent.
+   * Connects the agent to a Telegram bot or WhatsApp Business phone number, validates the provider credentials, and registers the agent's webhook. WhatsApp connector support is beta. Text, photos, and gateway-supported documents can invoke the agent; inbound media additionally requires write:files. Managed outbound files require read:files, and generated images require both file scopes so their transient provider URLs can be materialized before delivery. The optional write:feedback scope enables native thumbs reaction synchronization to gateway response feedback. These conditional scopes are deliberately not part of x-required-scopes because text-only connectors do not need them. An API key with every listed scope is required; its identity tuple and current scopes are stored as a non-widening ceiling, then revalidated with mk-authentication before every connector run; session and delegated end-user contexts are rejected. The required access policy controls which provider users or chats may invoke the agent. A web connector (provider web) needs no provider credentials or access policy: it is active immediately and returns an embed object with an iframe URL and snippet for an anonymous web chat widget whose visitors are limited by signed sessions, rate limits and the optional allowed_origins list. Creating a web connector returns 409 when the deployment has not enabled web chat.
    */
   async createAgentConnector(
     request: operations.CreateAgentConnectorRequest,
@@ -86,7 +86,7 @@ export class AgentConnectors extends ClientSDK {
    * Delete a connector
    *
    * @remarks
-   * Unregisters the connector-specific provider webhook and deletes the stored connector credentials. Telegram pending updates are dropped; WhatsApp deletion clears only the phone-number callback and does not unsubscribe other numbers in the business account.
+   * Unregisters the connector-specific provider webhook and deletes the stored connector credentials. Telegram pending updates are dropped; WhatsApp deletion clears only the phone-number callback and does not unsubscribe other numbers in the business account. Deleting a web connector disables its embed immediately.
    */
   async deleteAgentConnector(
     request: operations.DeleteAgentConnectorRequest,
@@ -103,7 +103,7 @@ export class AgentConnectors extends ClientSDK {
    * Activate a connector
    *
    * @remarks
-   * Revalidates the stored provider credentials and registers the provider webhook. Use this to retry a connector left in an error state. API-key authentication with every listed scope is required; session authentication is rejected, and the key must belong to the connector's original user or service-account principal so existing conversations keep the same owner.
+   * Revalidates the stored provider credentials and registers the provider webhook. Use this to retry a connector left in an error state. API-key authentication with every listed scope is required; session authentication is rejected, and the key must belong to the connector's original user or service-account principal so existing conversations keep the same owner. Web connectors have no provider webhook; activation only re-authorizes the stored API-key identity.
    */
   async activateAgentConnector(
     request: operations.ActivateAgentConnectorRequest,