@arbol-ai/sdk 2.4.0 → 2.5.0

package/dist/raiz/channels/client.d.ts

@@ -12,14 +12,20 @@ export interface Client {
     /**
      * Add a channel
      *
-     * Add a channel. `whatsapp` creates a pending channel and a setup link
-     * (`setup.url`) where the business connects its WhatsApp number; call
-     * `verify_channel` once that is done. `voice` connects a platform phone
-     * number (`platform_number`) or the organization's own carrier over SIP
-     * (`sip_trunk`) at once (SIP credentials are passed on once and never
-     * stored). `web` creates the chat widget with its configuration. With an
-     * Agent, traffic is on by default. Done in Settings → Channels or the REST
-     * API; not an AI tool.
+     * Add a channel. `web` creates a website chat or form (the widget) from its
+     * complete configuration (`widget`: mode, texts, fields, colors and fonts,
+     * allowed origins, `publicLink` for its own hosted page); it is the one kind
+     * an AI tool creates. Create it with `inboundEnabled: false` to review it
+     * before publishing, then publish or pause it with `update_channel`;
+     * `publication` says whether visitors can reach it and where. `whatsapp`
+     * creates a pending channel and a setup link (`setup.url`) where the business
+     * connects its WhatsApp number; call `verify_channel` once that is done.
+     * `voice` connects a platform phone number (`platform_number`) or the
+     * organization's own carrier over SIP (`sip_trunk`) at once (SIP credentials
+     * are passed on once and never stored). A person adds WhatsApp and voice
+     * channels in Settings → Channels or with the REST API: over MCP they fail
+     * with CHANNEL_CREATION_IN_APP. With an Agent, traffic is on by default. Not
+     * idempotent: after an unknown outcome, `list_channels` before trying again.
      */
     create(request: CreateRequest, options?: RequestOptions): Promise<CreateResponse>;
     /**

package/dist/raiz/channels/index.d.ts

@@ -2,4 +2,4 @@ export { ApiError } from "../../_/index.js";
 export type { RequestOptions } from "../../_/index.js";
 export { createClient } from "./client.js";
 export type { Client, ClientOptions, CreateRequest, CreateResponse, DeleteRequest, DeleteResponse, GetRequest, GetResponse, ListRequest, ListResponse, RenewSetupRequest, RenewSetupResponse, UpdateRequest, UpdateResponse, VerifyRequest, VerifyResponse, } from "./client.js";
-export type { RaizChannel, RaizChannelAgent, RaizChannelPage, RaizWidgetAgentChoice, RaizWidgetClientTool, RaizWidgetCopy, RaizWidgetField, RaizWidgetSettings, RaizWidgetSettingsInput, RaizWidgetTranslations, } from "./models.js";
+export type { RaizChannel, RaizChannelAgent, RaizChannelPage, RaizWidgetAgentChoice, RaizWidgetClientTool, RaizWidgetCopy, RaizWidgetField, RaizWidgetPublication, RaizWidgetSettings, RaizWidgetSettingsInput, RaizWidgetTranslations, } from "./models.js";

package/dist/raiz/channels/models.d.ts

@@ -52,6 +52,7 @@ export interface RaizChannel {
      */
     provider: "phone" | "sip" | "whatsapp" | "web";
     providerAccountId: string | null;
+    publication: RaizWidgetPublication | null;
     /**
      * Active with enabled traffic; WhatsApp outbound notifications do not need an
      * Agent.
@@ -132,12 +133,35 @@ export interface RaizWidgetCopy {
     welcomeTitle?: string;
 }
 export interface RaizWidgetField {
+    /**
+     * Help shown under the label.
+     */
+    description?: string;
     label: string;
     name: string;
     options?: string[];
     placeholder?: string;
     required: boolean;
-    type: "text" | "textarea" | "email" | "tel" | "number" | "date" | "select" | "checkbox";
+    type: "text" | "textarea" | "email" | "tel" | "number" | "date" | "select" | "radio" | "checkbox" | "url";
+    /**
+     * `half` sets two consecutive half fields side by side on wide screens.
+     */
+    width?: "full" | "half";
+}
+export interface RaizWidgetPublication {
+    /**
+     * Visitors can start now: no `problems`. The hosted page answers at `url`,
+     * and the widget runs on its `allowedOrigins`.
+     */
+    live: boolean;
+    /**
+     * Why it is not live: `CHANNEL_INACTIVE` (the channel is not active),
+     * `PAUSED` (`inboundEnabled` is off), `AGENT_REQUIRED` (no Agent assigned),
+     * `AGENT_PAUSED` (its Agent is paused), `NOT_PLACED` (no hosted page and no
+     * https site may embed it).
+     */
+    problems: ("CHANNEL_INACTIVE" | "PAUSED" | "AGENT_REQUIRED" | "AGENT_PAUSED" | "NOT_PLACED")[];
+    url: string | null;
 }
 export interface RaizWidgetSettings {
     /**
@@ -160,9 +184,15 @@ export interface RaizWidgetSettings {
      */
     askFirstMessage?: boolean;
     /**
-     * A color in `#RRGGBB` form.
+     * Background behind the Agent's messages; the background color shows them as
+     * plain text. A color in `#RRGGBB` form.
      */
     assistantColor?: string;
+    /**
+     * Text of the Agent's messages; null: `textColor`. A color in `#RRGGBB` form,
+     * or null to derive it.
+     */
+    assistantTextColor?: string | null;
     attachmentTypes?: ("image/png" | "image/jpeg" | "application/pdf" | "text/plain")[];
     attachmentsEnabled?: boolean;
     avatarUrl?: RaizHttpsUrl | null;
@@ -180,17 +210,35 @@ export interface RaizWidgetSettings {
      */
     clientTools?: RaizWidgetClientTool[];
     consentText?: string;
+    /**
+     * Corner radius of fields and buttons, in pixels; 24 makes pill-shaped
+     * buttons. Null: derived from `radius`.
+     */
+    controlRadius?: number | null;
     /**
      * A stylesheet applied inside the panel only; the launcher uses the style
      * fields.
      */
     customCss?: string;
     /**
-     * Up to 12 pre-chat form fields with unique names.
+     * Field errors and failures the visitor must see. A color in `#RRGGBB` form.
+     */
+    errorColor?: string;
+    /**
+     * Up to 40 form fields with unique names, asked before the conversation (or
+     * alone, in `form` mode).
      */
     fields?: RaizWidgetField[];
     firstMessageLabel?: string;
+    /**
+     * The text typeface: `arbol` (bundled), `system` (the device's), `serif`,
+     * `rounded`, `page` (the embedding page's) or `custom` (`fontFamily`, with an
+     * optional `fontUrl`).
+     */
     font?: "arbol" | "system" | "serif" | "rounded" | "page" | "custom";
+    /**
+     * The CSS font-family of `font: custom`.
+     */
     fontFamily?: string;
     fontSize?: number;
     fontUrl?: RaizHttpsUrl | null;
@@ -204,6 +252,30 @@ export interface RaizWidgetSettings {
      * A color in `#RRGGBB` form.
      */
     headerTextColor?: string;
+    /**
+     * The headings' typeface: `text` (the same as `font`) or one of `font`'s
+     * choices, with `headingFontFamily` and `headingFontUrl` for `custom`.
+     */
+    headingFont?: "text" | "arbol" | "system" | "serif" | "rounded" | "page" | "custom";
+    /**
+     * The CSS font-family of `headingFont: custom`.
+     */
+    headingFontFamily?: string;
+    headingFontUrl?: RaizHttpsUrl | null;
+    /**
+     * The headings' weight, from 300 (light) to 800 (heavy).
+     */
+    headingWeight?: number;
+    /**
+     * The border of form fields and of the message box. A color in `#RRGGBB`
+     * form, or null to derive it.
+     */
+    inputBorderColor?: string | null;
+    /**
+     * The background of form fields and of the message box. A color in `#RRGGBB`
+     * form, or null to derive it.
+     */
+    inputColor?: string | null;
     /**
      * The visitor interface language when the browser asks for none of the
      * translated ones.
@@ -216,6 +288,11 @@ export interface RaizWidgetSettings {
      * accessible name.
      */
     launcherStyle?: "icon" | "label";
+    /**
+     * Links; null: `primaryColor`. A color in `#RRGGBB` form, or null to derive
+     * it.
+     */
+    linkColor?: string | null;
     logoObjectKey?: string | null;
     /**
      * Visitor messages per session.
@@ -227,6 +304,11 @@ export interface RaizWidgetSettings {
      * `form-chat`: the form, then the conversation.
      */
     mode?: "chat" | "form" | "form-chat";
+    /**
+     * Secondary text: descriptions, hints and times. A color in `#RRGGBB` form,
+     * or null to derive it.
+     */
+    mutedTextColor?: string | null;
     /**
      * Increases when a policy field, the channel's Agent or its inbound switch
      * changes; sessions opened under an older revision end.
@@ -275,9 +357,25 @@ export interface RaizWidgetSettings {
     translations?: RaizWidgetTranslations;
     turnsPerDay?: number;
     /**
-     * A color in `#RRGGBB` form.
+     * Text on `primaryColor`: buttons and the launcher. A color in `#RRGGBB`
+     * form.
      */
     userTextColor?: string;
+    /**
+     * Background of the visitor's own messages; null: a light tint of
+     * `textColor`. A color in `#RRGGBB` form, or null to derive it.
+     */
+    visitorColor?: string | null;
+    /**
+     * Text of the visitor's own messages; null: `textColor`. A color in `#RRGGBB`
+     * form, or null to derive it.
+     */
+    visitorTextColor?: string | null;
+    /**
+     * Let visitors record a voice message; Raíz transcribes it and the Agent
+     * answers the transcript.
+     */
+    voiceMessages?: boolean;
     welcomeText?: string;
     welcomeTitle?: string;
 }
@@ -302,9 +400,15 @@ export interface RaizWidgetSettingsInput {
      */
     askFirstMessage?: boolean;
     /**
-     * A color in `#RRGGBB` form.
+     * Background behind the Agent's messages; the background color shows them as
+     * plain text. A color in `#RRGGBB` form.
      */
     assistantColor?: string;
+    /**
+     * Text of the Agent's messages; null: `textColor`. A color in `#RRGGBB` form,
+     * or null to derive it.
+     */
+    assistantTextColor?: string | null;
     attachmentTypes?: ("image/png" | "image/jpeg" | "application/pdf" | "text/plain")[];
     attachmentsEnabled?: boolean;
     avatarUrl?: RaizHttpsUrl | null;
@@ -322,17 +426,35 @@ export interface RaizWidgetSettingsInput {
      */
     clientTools?: RaizWidgetClientTool[];
     consentText?: string;
+    /**
+     * Corner radius of fields and buttons, in pixels; 24 makes pill-shaped
+     * buttons. Null: derived from `radius`.
+     */
+    controlRadius?: number | null;
     /**
      * A stylesheet applied inside the panel only; the launcher uses the style
      * fields.
      */
     customCss?: string;
     /**
-     * Up to 12 pre-chat form fields with unique names.
+     * Field errors and failures the visitor must see. A color in `#RRGGBB` form.
+     */
+    errorColor?: string;
+    /**
+     * Up to 40 form fields with unique names, asked before the conversation (or
+     * alone, in `form` mode).
      */
     fields?: RaizWidgetField[];
     firstMessageLabel?: string;
+    /**
+     * The text typeface: `arbol` (bundled), `system` (the device's), `serif`,
+     * `rounded`, `page` (the embedding page's) or `custom` (`fontFamily`, with an
+     * optional `fontUrl`).
+     */
     font?: "arbol" | "system" | "serif" | "rounded" | "page" | "custom";
+    /**
+     * The CSS font-family of `font: custom`.
+     */
     fontFamily?: string;
     fontSize?: number;
     fontUrl?: RaizHttpsUrl | null;
@@ -346,6 +468,30 @@ export interface RaizWidgetSettingsInput {
      * A color in `#RRGGBB` form.
      */
     headerTextColor?: string;
+    /**
+     * The headings' typeface: `text` (the same as `font`) or one of `font`'s
+     * choices, with `headingFontFamily` and `headingFontUrl` for `custom`.
+     */
+    headingFont?: "text" | "arbol" | "system" | "serif" | "rounded" | "page" | "custom";
+    /**
+     * The CSS font-family of `headingFont: custom`.
+     */
+    headingFontFamily?: string;
+    headingFontUrl?: RaizHttpsUrl | null;
+    /**
+     * The headings' weight, from 300 (light) to 800 (heavy).
+     */
+    headingWeight?: number;
+    /**
+     * The border of form fields and of the message box. A color in `#RRGGBB`
+     * form, or null to derive it.
+     */
+    inputBorderColor?: string | null;
+    /**
+     * The background of form fields and of the message box. A color in `#RRGGBB`
+     * form, or null to derive it.
+     */
+    inputColor?: string | null;
     /**
      * The visitor interface language when the browser asks for none of the
      * translated ones.
@@ -358,6 +504,11 @@ export interface RaizWidgetSettingsInput {
      * accessible name.
      */
     launcherStyle?: "icon" | "label";
+    /**
+     * Links; null: `primaryColor`. A color in `#RRGGBB` form, or null to derive
+     * it.
+     */
+    linkColor?: string | null;
     logoObjectKey?: string | null;
     /**
      * Visitor messages per session.
@@ -369,6 +520,11 @@ export interface RaizWidgetSettingsInput {
      * `form-chat`: the form, then the conversation.
      */
     mode?: "chat" | "form" | "form-chat";
+    /**
+     * Secondary text: descriptions, hints and times. A color in `#RRGGBB` form,
+     * or null to derive it.
+     */
+    mutedTextColor?: string | null;
     position?: "left" | "right";
     /**
      * A color in `#RRGGBB` form.
@@ -412,9 +568,25 @@ export interface RaizWidgetSettingsInput {
     translations?: RaizWidgetTranslations;
     turnsPerDay?: number;
     /**
-     * A color in `#RRGGBB` form.
+     * Text on `primaryColor`: buttons and the launcher. A color in `#RRGGBB`
+     * form.
      */
     userTextColor?: string;
+    /**
+     * Background of the visitor's own messages; null: a light tint of
+     * `textColor`. A color in `#RRGGBB` form, or null to derive it.
+     */
+    visitorColor?: string | null;
+    /**
+     * Text of the visitor's own messages; null: `textColor`. A color in `#RRGGBB`
+     * form, or null to derive it.
+     */
+    visitorTextColor?: string | null;
+    /**
+     * Let visitors record a voice message; Raíz transcribes it and the Agent
+     * answers the transcript.
+     */
+    voiceMessages?: boolean;
     welcomeText?: string;
     welcomeTitle?: string;
 }

package/dist/raiz/models.d.ts

@@ -456,6 +456,13 @@ export interface RaizFailureResponse {
         };
         message: "This Agent cannot serve this channel: voice channels need a voice Agent; WhatsApp and web channels need a text Agent.";
         retryable: false;
+    } | {
+        code: "CHANNEL_CREATION_IN_APP";
+        data: {
+            [key: string]: unknown;
+        };
+        message: "An AI tool creates website chats and forms only. A person adds WhatsApp numbers and phone numbers in Settings → Channels, or through the REST API.";
+        retryable: false;
     } | {
         code: "CHANNEL_AGENT_REQUIRED";
         data: {
@@ -813,6 +820,13 @@ export interface RaizFailureResponse {
         };
         message: "This widget session is unavailable.";
         retryable: false;
+    } | {
+        code: "WIDGET_VOICE_UNHEARD";
+        data: {
+            [key: string]: unknown;
+        };
+        message: "The voice message could not be understood. Record it again or write the message.";
+        retryable: false;
     } | {
         code: "ADDRESS_IN_USE";
         data: {

package/dist/raiz/reports/client.d.ts

@@ -14,12 +14,14 @@ export interface Client {
      * Get the numbers behind a question. `name`: `conversations_daily`
      * (conversations the AI took part in, per day), `booking_outcomes` (verified
      * saved booking receipts by completion day and integration, excluding tests,
-     * imports and deleted conversations; new bookings, reschedules,
-     * cancellations, failures, pending and unverified results separately),
-     * `tool_calls_daily` (Agent tool calls per day), `tool_calls` (each call,
-     * newest first), `assessment_results_daily` (assessment results per day),
-     * each over days in the organization's time zone (`from`, `to`; the last 30
-     * days by default), or `campaign_progress`. Narrow with `agentId`,
+     * imports and deleted conversations; createdCount counts new appointments
+     * created by the AI, not confirmations of existing appointments;
+     * confirmedCount is its compatibility alias and must not be added again;
+     * reschedules, cancellations, failures, pending and unverified results
+     * separately), `tool_calls_daily` (Agent tool calls per day), `tool_calls`
+     * (each call, newest first), `assessment_results_daily` (assessment results
+     * per day), each over days in the organization's time zone (`from`, `to`; the
+     * last 30 days by default), or `campaign_progress`. Narrow with `agentId`,
      * `channelType`, `campaignId` or `definitionId`; unsupported filters fail. At
      * most 1000 rows: `hasMore` means split the range or filter. Booking outcomes
      * return no partial totals when their evidence scan exceeds its bound.

package/dist/raiz/reports/models.d.ts

@@ -63,6 +63,7 @@ export type RaizReport = {
         agentName: string | null;
         cancelledCount: number;
         confirmedCount: number;
+        createdCount: number;
         day: Temporal.PlainDate;
         duplicateCount: number;
         failedCount: number;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arbol-ai/sdk",
-  "version": "2.4.0",
+  "version": "2.5.0",
   "description": "The Arbol API for TypeScript and JavaScript, generated by Cloudflare Forge from the platform's public OpenAPI.",
   "keywords": [
     "arbol",
@@ -50,8 +50,8 @@
   "packageManager": "bun@1.4.3",
   "arbol": {
     "openapi": {
-      "release": "1.20261020.162831",
-      "sha256": "3c0996ddbfb92924b8d8bc8f0ccaef401eb19e2f6168ec412558a37cf0709240"
+      "release": "1.20261021.53505",
+      "sha256": "3dbd465d9ddac7ecd1b00c5694419214ef02e6aa3925085dabaea80077fbfcca"
     }
   }
 }