@fonoster/types 0.26.0 → 0.30.0

package/dist/applications.types.d.ts

@@ -19,26 +19,60 @@
 import { BaseApiObject, ListRequest, ListResponse } from "./common";
 import { Flatten } from "./utils";
 declare enum ApplicationType {
-    EXTERNAL = "EXTERNAL",
+    STREAM = "STREAM",
     AUTOPILOT = "AUTOPILOT"
 }
 declare enum ExpectedTextType {
     EXACT = "EXACT",
     SIMILAR = "SIMILAR"
 }
-type Application = {
+/** Speech defaults of an application; voices and models are catalog ids. */
+type SpeechDefaults = {
+    voice?: string;
+    language?: string;
+    sttModel?: string;
+    ttsModel?: string;
+    silenceTimeoutMs?: number;
+    patience?: "low" | "normal" | "high";
+};
+type AudioFormat = {
+    codec: "pcm16" | "pcmu";
+    rate: number;
+};
+type AppListener = {
+    url: string;
+    tracks?: "inbound" | "outbound" | "both";
+};
+type RecordingPolicy = "off" | "on" | "consent";
+/** Answering-machine detection: one `amd.result` event per call. */
+type AmdSettings = {
+    enabled: boolean;
+    /** Caller audio to classify in ms (default 4000; 500 to 15000). */
+    windowMs?: number;
+};
+/** The application model (voice-session G2): a stream or an Autopilot agent. */
+type SessionAppFields = {
+    /** ws:// or wss:// URL the gateway dials (Autopilot agents: the hosted Autopilot). */
+    url?: string;
+    /** The stream's wire protocol (default fonoster). */
+    protocol?: "fonoster" | "twilio";
+    speech?: SpeechDefaults;
+    audio?: AudioFormat;
+    fallbackAppRef?: string;
+    fallbackMessage?: string;
+    listeners?: AppListener[];
+    /** Empty inherits the workspace's policy. */
+    recording?: RecordingPolicy | "";
+    /** Off when unset. */
+    amd?: AmdSettings;
+};
+type Application = SessionAppFields & {
     ref: string;
     name: string;
     type: ApplicationType;
+    /** The last characters of the signing secret; the secret itself is never read back. */
+    signingSecretHint?: string;
     endpoint?: string;
-    textToSpeech?: {
-        productRef: string;
-        config: Record<string, unknown>;
-    };
-    speechToText?: {
-        productRef: string;
-        config: Record<string, unknown>;
-    };
     intelligence?: {
         productRef: string;
         config: Record<string, unknown>;
@@ -46,30 +80,41 @@ type Application = {
     createdAt: Date;
     updatedAt: Date;
 };
-type CreateApplicationRequest = {
+type CreateApplicationRequest = SessionAppFields & {
     name: string;
     type: ApplicationType;
     endpoint?: string;
-    textToSpeech?: {
-        productRef: string;
-        config: Record<string, unknown>;
-    };
-    speechToText?: {
-        productRef: string;
-        config: Record<string, unknown>;
-    };
+    /** Autopilot apps: the assistant (sessionAssistantSchema); productRef is derived from its model. */
     intelligence?: {
-        productRef: string;
-        credentials: Record<string, unknown>;
+        productRef?: string;
         config: Record<string, unknown>;
     };
 };
 type UpdateApplicationRequest = Flatten<BaseApiObject & Partial<CreateApplicationRequest>>;
 type ListApplicationsRequest = ListRequest;
+type CreateApplicationResponse = {
+    ref: string;
+    /** Shown only here and on rotation. */
+    signingSecret?: string;
+    signingSecretHint?: string;
+};
+type UpdateApplicationResponse = {
+    ref: string;
+    /** Set only when the update generated a new secret (the app stopped being an Autopilot app). */
+    signingSecret?: string;
+    signingSecretHint?: string;
+};
+type RotateSigningSecretResponse = {
+    ref: string;
+    signingSecret: string;
+    signingSecretHint: string;
+};
 type ListApplicationsResponse = ListResponse<Application>;
 type EvaluateIntelligenceRequest = {
     intelligence: {
-        productRef: string;
+        /** Ignored: the assistant's catalog id names the provider. */
+        productRef?: string;
+        /** A session assistant with testCases. */
         config: Record<string, unknown>;
     };
 };
@@ -122,4 +167,4 @@ type CreateTestTokenResponse = {
     username: string;
     token: string;
 };
-export { Application, ApplicationType, CreateApplicationRequest, CreateTestTokenResponse, ListApplicationsRequest, ListApplicationsResponse, UpdateApplicationRequest, EvaluateIntelligenceRequest, EvaluateIntelligenceEvent, ScenarioEvaluationReport, StepEvaluationReport, ToolEvaluationReport, ExpectedTextType };
+export { AmdSettings, AppListener, AudioFormat, CreateApplicationResponse, UpdateApplicationResponse, RecordingPolicy, RotateSigningSecretResponse, SessionAppFields, SpeechDefaults, Application, ApplicationType, CreateApplicationRequest, CreateTestTokenResponse, ListApplicationsRequest, ListApplicationsResponse, UpdateApplicationRequest, EvaluateIntelligenceRequest, EvaluateIntelligenceEvent, ScenarioEvaluationReport, StepEvaluationReport, ToolEvaluationReport, ExpectedTextType };

package/dist/applications.types.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.ExpectedTextType = exports.ApplicationType = void 0;
 var ApplicationType;
 (function (ApplicationType) {
-    ApplicationType["EXTERNAL"] = "EXTERNAL";
+    ApplicationType["STREAM"] = "STREAM";
     ApplicationType["AUTOPILOT"] = "AUTOPILOT";
 })(ApplicationType || (exports.ApplicationType = ApplicationType = {}));
 var ExpectedTextType;

package/dist/identity.types.d.ts

@@ -54,7 +54,10 @@ type CreateApiKeyResponse = {
 type UpdateUserRequest = {
     ref: string;
     name?: string;
+    /** A new password; requires currentPassword. */
     password?: string;
+    /** The account's current password, required to set a new one. */
+    currentPassword?: string;
     avatar?: string;
     phone?: string;
 };
@@ -77,7 +80,8 @@ type ApiKey = {
 };
 type SendResetPasswordCodeRequest = {
     username: string;
-    resetPasswordUrl: string;
+    /** Deprecated and ignored: Identity links to its configured reset page. */
+    resetPasswordUrl?: string;
 };
 type ResetPasswordRequest = {
     username: string;

package/dist/index.d.ts

@@ -28,3 +28,7 @@ export * from "./numbers.types";
 export * from "./secrets.types";
 export * from "./trunks.types";
 export * from "./workspaces.types";
+export * from "./providers.types";
+export * from "./webhooks.types";
+export * from "./records.types";
+export * from "./regions.types";

package/dist/index.js

@@ -44,3 +44,7 @@ __exportStar(require("./numbers.types"), exports);
 __exportStar(require("./secrets.types"), exports);
 __exportStar(require("./trunks.types"), exports);
 __exportStar(require("./workspaces.types"), exports);
+__exportStar(require("./providers.types"), exports);
+__exportStar(require("./webhooks.types"), exports);
+__exportStar(require("./records.types"), exports);
+__exportStar(require("./regions.types"), exports);

package/dist/providers.types.d.ts

@@ -0,0 +1,83 @@
+/**
+ * Copyright (C) 2025 by Fonoster Inc (https://fonoster.com)
+ * http://github.com/fonoster/fonoster
+ *
+ * This file is part of Fonoster
+ *
+ * Licensed under the MIT License (the "License");
+ * you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ *    https://opensource.org/licenses/MIT
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+/** A catalog entry visible to the workspace (add-provider-registry). */
+type CatalogItem = {
+    /** Catalog id, e.g. deepgram/nova-3; a provider's id has no slash. */
+    id: string;
+    kind: "provider" | "model" | "voice";
+    state: "active" | "deprecated";
+    providerId: string;
+    /** Models: stt, tts or llm. */
+    type?: "stt" | "tts" | "llm";
+    capabilities?: string[];
+    languages?: string[];
+    features?: string[];
+    models?: string[];
+    gender?: string;
+    replacement?: string;
+    retireOn?: string;
+};
+type ListCatalogRequest = {
+    kind?: "provider" | "model" | "voice";
+    type?: "stt" | "tts" | "llm";
+};
+type ListCatalogResponse = {
+    items: CatalogItem[];
+};
+/** A workspace's own vendor key; the key is only in its write-only Secret. */
+type ProviderKey = {
+    ref: string;
+    providerId: string;
+    secretRef: string;
+    createdAt: Date;
+    updatedAt: Date;
+};
+type SetProviderKeyRequest = {
+    providerId: string;
+    key: string;
+};
+type ListProviderKeysResponse = {
+    items: ProviderKey[];
+};
+/** Where a warned item is used in the workspace. */
+type WarningUse = {
+    kind: "app" | "assistant";
+    ref: string;
+    name: string;
+    /** voice, ttsModel, sttModel or llm */
+    field: string;
+    /** For a TTS model: the voice the config uses with it. */
+    voice?: string;
+};
+/** A deprecated or retired catalog item the workspace uses (dashboard warnings). */
+type CatalogWarning = {
+    id: string;
+    kind: "provider" | "model" | "voice";
+    state: "deprecated" | "retired";
+    replacement?: string;
+    retireOn?: string;
+    usedBy: WarningUse[];
+    runtimeApps: string[];
+    runtimeSessions: number;
+    lastUsedAt?: string;
+};
+type ListWarningsResponse = {
+    items: CatalogWarning[];
+};
+export { CatalogWarning, ListWarningsResponse, WarningUse, CatalogItem, ListCatalogRequest, ListCatalogResponse, ListProviderKeysResponse, ProviderKey, SetProviderKeyRequest };

package/dist/providers.types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/records.types.d.ts

@@ -0,0 +1,73 @@
+/**
+ * Copyright (C) 2025 by Fonoster Inc (https://fonoster.com)
+ * http://github.com/fonoster/fonoster
+ *
+ * This file is part of Fonoster
+ *
+ * Licensed under the MIT License (the "License");
+ * you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ *    https://opensource.org/licenses/MIT
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+/** A call record's index entry (add-call-record, /api/records). */
+type CallRecordSummary = {
+    callRef: string;
+    appRef: string | null;
+    from: string | null;
+    to: string | null;
+    direction: string | null;
+    /** completed, failed, erased, ... */
+    status: string;
+    endReason: string | null;
+    failureReason: string | null;
+    sipStatus: number | null;
+    startedAt: string;
+    endedAt: string | null;
+    durationSeconds: number;
+    region: string;
+    version: number;
+    size: number;
+    parts: string[];
+};
+type ListCallRecordsRequest = {
+    /** ISO time bounds on startedAt. */
+    after?: string;
+    before?: string;
+    /** Matches the from or to number. */
+    number?: string;
+    appRef?: string;
+    status?: string;
+    pageSize?: number;
+    pageToken?: string;
+};
+type ListCallRecordsResponse = {
+    items: CallRecordSummary[];
+    nextPageToken?: string;
+};
+/** One version of a record: the vCon (redacted unless `original`) and its signature. */
+type CallRecordDetail = CallRecordSummary & {
+    currentVersion: number;
+    redacted: boolean;
+    vcon: Record<string, unknown>;
+    jws: unknown;
+};
+type CallRecordAuditEntry = {
+    action: string;
+    part: string;
+    reason: string;
+    actor: string;
+    version: number;
+    at: string;
+};
+type RetentionPolicy = {
+    part: string;
+    days: number | null;
+};
+export { CallRecordAuditEntry, CallRecordDetail, CallRecordSummary, ListCallRecordsRequest, ListCallRecordsResponse, RetentionPolicy };

package/dist/records.types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/regions.types.d.ts

@@ -0,0 +1,139 @@
+/**
+ * Copyright (C) 2025 by Fonoster Inc (https://fonoster.com)
+ * http://github.com/fonoster/fonoster
+ *
+ * This file is part of Fonoster
+ *
+ * Licensed under the MIT License (the "License");
+ * you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ *    https://opensource.org/licenses/MIT
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+/** Regions (add-private-regions). */
+type RegionStatus = "waiting" | "connected" | "degraded" | "offline" | "unsupported";
+type RegionKind = "public" | "private";
+/** A region in a list (`GET /api/regions`): offered public regions and the caller's own. */
+type RegionSummary = {
+    /** Absent for a configured public region. */
+    ref?: string;
+    id: string;
+    /** Same as displayName. */
+    name: string;
+    displayName: string;
+    kind: RegionKind;
+    default: boolean;
+    status: RegionStatus;
+    /** Same as status. */
+    state: RegionStatus;
+    sipDomain?: string;
+    /** The caller's private regions: how many workspaces use it. */
+    workspaces?: number;
+    published?: boolean;
+};
+/** @deprecated use RegionSummary */
+type PublicRegion = RegionSummary;
+type ListRegionsResponse = {
+    items: RegionSummary[];
+};
+type RegionSecret = {
+    name: string;
+    usedBy: string[];
+    set: boolean;
+};
+type SipTransport = "udp" | "tcp" | "tls" | "ws" | "wss";
+/** Where carriers and softphones reach a region (contract §3 `region.R.endpoints`, §3a). */
+type RegionEndpoints = {
+    sip: {
+        host: string;
+        port: number;
+        transport: SipTransport;
+    }[];
+    /** Public addresses carriers must allowlist for signaling. */
+    signalingAddresses: string[];
+    /** Public addresses media (RTP) comes from. */
+    mediaAddresses: string[];
+    rtpPorts?: {
+        min: number;
+        max: number;
+    };
+    /** The region's SIP domain (PR-16): workspaces get subdomains of it. */
+    sipDomain?: string;
+    updatedAt?: string;
+};
+type RegionWorkspace = {
+    ref: string;
+    accessKeyId: string;
+    name: string;
+    /** The workspace's SIP domain in this region (`<label>.<sipDomain>`). */
+    domain?: string;
+};
+/** A region and its status (contract §0 `Region`). */
+type Region = {
+    ref: string;
+    id: string;
+    kind: RegionKind;
+    name: string;
+    displayName: string;
+    default?: boolean;
+    sipDomain?: string;
+    ownerRef?: string;
+    published?: boolean;
+    status: RegionStatus;
+    /** Same as status (alias). */
+    state: RegionStatus;
+    reason?: string;
+    unsupportedReason?: string;
+    requiredVersion?: string;
+    version?: string;
+    lastHeartbeatAt?: string;
+    /** Same as lastHeartbeatAt. */
+    lastSeenAt?: string;
+    enrolledAt?: string;
+    components?: {
+        mediaNodes: number;
+        gateways: number;
+        autopilot: boolean;
+    };
+    mediaNodes?: number;
+    gateways?: number;
+    activeCalls?: number;
+    configVersion?: number;
+    /** Owner views: the workspaces the region serves. */
+    workspaces?: RegionWorkspace[];
+    /** `getRegion()` of the current workspace: its SIP domain in the region. */
+    workspaceDomain?: string;
+    secretsNeeded?: string[];
+    secretsSet?: string[];
+    secrets: RegionSecret[];
+    /** Connection details; absent until a region's cell reports them. */
+    endpoints?: RegionEndpoints;
+    /** Private regions on the cloud: the flat monthly fee (PR-11); null when billing is off. */
+    monthlyFeeCents?: number | null;
+    /** Private regions: minutes reported this calendar month (UTC); shown, not billed. */
+    minutesThisMonth?: number;
+};
+type CreateRegionRequest = {
+    /** 3-32 lowercase letters, digits, hyphens; starts with a letter; never changes (PR-18). */
+    id: string;
+    displayName: string;
+    /** Your SIP domain (PR-16), e.g. sip.acme.com; point *.sip.acme.com at the region. */
+    sipDomain: string;
+};
+/** A one-time enrollment token (shown once); `enrollmentToken` is the same value. */
+type RegionEnrollmentToken = {
+    token: string;
+    enrollmentToken: string;
+    expiresAt: string;
+};
+type CreateRegionResponse = RegionEnrollmentToken & {
+    ref: string;
+    id: string;
+};
+export { CreateRegionRequest, CreateRegionResponse, ListRegionsResponse, RegionKind, RegionSummary, RegionWorkspace, PublicRegion, Region, RegionEndpoints, RegionEnrollmentToken, RegionSecret, RegionStatus, SipTransport };

package/dist/regions.types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/webhooks.types.d.ts

@@ -0,0 +1,73 @@
+/**
+ * Copyright (C) 2025 by Fonoster Inc (https://fonoster.com)
+ * http://github.com/fonoster/fonoster
+ *
+ * This file is part of Fonoster
+ *
+ * Licensed under the MIT License (the "License");
+ * you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ *    https://opensource.org/licenses/MIT
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { ListRequest, ListResponse } from "./common";
+/** A workspace webhook endpoint (add-workspace-webhooks). */
+type Webhook = {
+    ref: string;
+    url: string;
+    events: string[];
+    /** The last characters of the current secret. */
+    secretHint: string;
+    /** Until when the previous secret still verifies (after a rotation). */
+    previousSecretUntil?: Date;
+    createdAt: Date;
+    updatedAt: Date;
+};
+type CreateWebhookRequest = {
+    url: string;
+    events: string[];
+};
+type CreateWebhookResponse = {
+    ref: string;
+    /** Shown only here and on rotation. */
+    secret: string;
+};
+type UpdateWebhookRequest = {
+    ref: string;
+    url?: string;
+    events?: string[];
+};
+type ListWebhooksRequest = ListRequest;
+type ListWebhooksResponse = ListResponse<Webhook>;
+type RotateWebhookSecretResponse = {
+    ref: string;
+    secret: string;
+    previousSecretUntil: Date;
+};
+type WebhookDelivery = {
+    ref: string;
+    webhookRef: string;
+    eventId: string;
+    eventType: string;
+    status: "pending" | "succeeded" | "failed";
+    attempts: number;
+    /** HTTP status of the last attempt (0: no response). */
+    lastStatus?: number;
+    lastAttemptAt?: Date;
+    nextAttemptAt?: Date;
+    createdAt: Date;
+};
+type ListWebhookDeliveriesRequest = {
+    webhookRef?: string;
+    pageSize?: number;
+};
+type ListWebhookDeliveriesResponse = {
+    items: WebhookDelivery[];
+};
+export { CreateWebhookRequest, CreateWebhookResponse, ListWebhookDeliveriesRequest, ListWebhookDeliveriesResponse, ListWebhooksRequest, ListWebhooksResponse, RotateWebhookSecretResponse, UpdateWebhookRequest, Webhook, WebhookDelivery };

package/dist/webhooks.types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/workspaces.types.d.ts

@@ -34,6 +34,8 @@ type Workspace = {
     accessKeyId: string;
     createdAt: Date;
     updatedAt: Date;
+    /** A public region id (`default`, `us-east-1`) or a private region ref (`rg_…`). Immutable. */
+    region?: string;
     owner?: {
         ref: string;
         name: string;
@@ -42,6 +44,15 @@ type Workspace = {
 };
 type CreateWorkspaceRequest = {
     name: string;
+    /**
+     * An offered public region id (default `default`) or one of your private regions (id or ref),
+     * created first with `sdk.regions.createRegion`. Fixed for life.
+     */
+    region?: string;
+};
+type CreateWorkspaceResponse = {
+    ref: string;
+    region?: string;
 };
 type UpdateWorkspaceRequest = {
     ref: string;
@@ -70,4 +81,4 @@ type ResendWorkspaceMembershipInvitationRequest = {
 type ResendWorkspaceMembershipInvitationResponse = {
     userRef: string;
 };
-export { CreateWorkspaceRequest, InviteUserToWorkspaceRequest, InviteUserToWorkspaceResponse, ListWorkspacesResponse, RemoveUserFromWorkspaceRequest, RemoveUserFromWorkspaceResponse, ResendWorkspaceMembershipInvitationRequest, ResendWorkspaceMembershipInvitationResponse, UpdateWorkspaceRequest, Workspace, WorkspaceMemberStatus, Role };
+export { CreateWorkspaceResponse, CreateWorkspaceRequest, InviteUserToWorkspaceRequest, InviteUserToWorkspaceResponse, ListWorkspacesResponse, RemoveUserFromWorkspaceRequest, RemoveUserFromWorkspaceResponse, ResendWorkspaceMembershipInvitationRequest, ResendWorkspaceMembershipInvitationResponse, UpdateWorkspaceRequest, Workspace, WorkspaceMemberStatus, Role };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fonoster/types",
-  "version": "0.26.0",
+  "version": "0.30.0",
   "description": "Common types for Fonoster projects",
   "author": "Pedro Sanders <psanders@fonoster.com>",
   "homepage": "https://github.com/fonoster/fonoster#readme",
@@ -29,5 +29,5 @@
   "bugs": {
     "url": "https://github.com/fonoster/fonoster/issues"
   },
-  "gitHead": "d14f414d791a33f92e8c4225f7e462abc440a142"
+  "gitHead": "08c9cfd7932675b6b16111daa4d03f14b4e287d1"
 }