@fonoster/types 0.30.0 → 0.31.0

package/dist/applications.types.d.ts

@@ -44,6 +44,11 @@ type AppListener = {
     tracks?: "inbound" | "outbound" | "both";
 };
 type RecordingPolicy = "off" | "on" | "consent";
+/** An audio filter run on the caller's audio before STT (voice-session, "Audio filters"). */
+type AudioFilter = {
+    name: string;
+    options?: Record<string, unknown>;
+};
 /** Answering-machine detection: one `amd.result` event per call. */
 type AmdSettings = {
     enabled: boolean;
@@ -52,7 +57,7 @@ type AmdSettings = {
 };
 /** 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). */
+    /** ws:// or wss:// URL AppBridge dials (Autopilot agents: the hosted Autopilot). */
     url?: string;
     /** The stream's wire protocol (default fonoster). */
     protocol?: "fonoster" | "twilio";
@@ -65,6 +70,8 @@ type SessionAppFields = {
     recording?: RecordingPolicy | "";
     /** Off when unset. */
     amd?: AmdSettings;
+    /** Audio filters in order. An update replaces the whole app: leave them out and they are cleared. */
+    filters?: AudioFilter[];
 };
 type Application = SessionAppFields & {
     ref: string;
@@ -84,7 +91,7 @@ type CreateApplicationRequest = SessionAppFields & {
     name: string;
     type: ApplicationType;
     endpoint?: string;
-    /** Autopilot apps: the assistant (sessionAssistantSchema); productRef is derived from its model. */
+    /** Autopilot apps: the agent (sessionAgentSchema); productRef is derived from its model. */
     intelligence?: {
         productRef?: string;
         config: Record<string, unknown>;
@@ -112,9 +119,9 @@ type RotateSigningSecretResponse = {
 type ListApplicationsResponse = ListResponse<Application>;
 type EvaluateIntelligenceRequest = {
     intelligence: {
-        /** Ignored: the assistant's catalog id names the provider. */
+        /** Ignored: the agent's catalog id names the provider. */
         productRef?: string;
-        /** A session assistant with testCases. */
+        /** A session agent with testCases. */
         config: Record<string, unknown>;
     };
 };
@@ -167,4 +174,4 @@ type CreateTestTokenResponse = {
     username: string;
     token: string;
 };
-export { AmdSettings, AppListener, AudioFormat, CreateApplicationResponse, UpdateApplicationResponse, RecordingPolicy, RotateSigningSecretResponse, SessionAppFields, SpeechDefaults, Application, ApplicationType, CreateApplicationRequest, CreateTestTokenResponse, ListApplicationsRequest, ListApplicationsResponse, UpdateApplicationRequest, EvaluateIntelligenceRequest, EvaluateIntelligenceEvent, ScenarioEvaluationReport, StepEvaluationReport, ToolEvaluationReport, ExpectedTextType };
+export { AmdSettings, AppListener, AudioFilter, AudioFormat, CreateApplicationResponse, UpdateApplicationResponse, RecordingPolicy, RotateSigningSecretResponse, SessionAppFields, SpeechDefaults, Application, ApplicationType, CreateApplicationRequest, CreateTestTokenResponse, ListApplicationsRequest, ListApplicationsResponse, UpdateApplicationRequest, EvaluateIntelligenceRequest, EvaluateIntelligenceEvent, ScenarioEvaluationReport, StepEvaluationReport, ToolEvaluationReport, ExpectedTextType };

package/dist/billing.types.d.ts

@@ -0,0 +1,61 @@
+/**
+ * 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.
+ */
+/** Where credits came from: the plan, a top-up or the Trial. */
+type CreditSource = {
+    /** plan, topup or trial */
+    kind: string;
+    credits: number;
+    /** ISO 8601; empty when they don't expire */
+    expiresAt: string;
+};
+type BillingSummary = {
+    /** trial or payg */
+    plan: string;
+    /** active, past_due, closed, or ended (a Trial past its 30 days) */
+    status: string;
+    /** Credits; negative while in the overdraft */
+    balance: number;
+    /** How far below zero the balance may go, in credits */
+    overdraft: number;
+    sources: CreditSource[];
+    /** ISO 8601; empty on the Trial */
+    periodEnd: string;
+    autoRecharge: boolean;
+    rechargeThreshold: number;
+    rechargeAmount: number;
+};
+type UpdateAutoRechargeRequest = {
+    enabled: boolean;
+    /** Recharge when the balance falls below this many credits */
+    threshold: number;
+    /** Credits bought each time (at least the smallest top-up) */
+    amount: number;
+};
+type CreateTopUpRequest = {
+    /** Credits to buy (at least the smallest top-up); tax is added on top */
+    credits: number;
+};
+type CreatePortalSessionRequest = {
+    /** Where the Stripe Customer Portal sends the owner back to */
+    returnUrl: string;
+};
+type CreatePortalSessionResponse = {
+    url: string;
+};
+export { BillingSummary, CreateTopUpRequest, CreatePortalSessionRequest, CreatePortalSessionResponse, CreditSource, UpdateAutoRechargeRequest };

package/dist/billing.types.js

@@ -0,0 +1,22 @@
+"use strict";
+/**
+ * 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.
+ */
+// Fonoster Cloud's billing (billing.proto), for the workspace owner. Amounts are credits
+// (1 credit = $0.01). There is no owner field: the account is always the caller's.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/calls.types.d.ts

@@ -62,6 +62,7 @@ type CallDetailRecord = {
     amdDetector?: string;
     amdLatencyMs?: number;
     amdCause?: string;
+    appRef?: string;
 };
 type ListCallsRequest = {
     after?: string;
@@ -70,6 +71,7 @@ type ListCallsRequest = {
     status?: CallStatus;
     from?: string;
     to?: string;
+    appRef?: string;
     pageSize?: number;
     pageToken?: string;
 };

package/dist/index.d.ts

@@ -32,3 +32,5 @@ export * from "./providers.types";
 export * from "./webhooks.types";
 export * from "./records.types";
 export * from "./regions.types";
+export * from "./usage.types";
+export * from "./billing.types";

package/dist/index.js

@@ -48,3 +48,5 @@ __exportStar(require("./providers.types"), exports);
 __exportStar(require("./webhooks.types"), exports);
 __exportStar(require("./records.types"), exports);
 __exportStar(require("./regions.types"), exports);
+__exportStar(require("./usage.types"), exports);
+__exportStar(require("./billing.types"), exports);

package/dist/providers.types.d.ts

@@ -21,11 +21,15 @@ type CatalogItem = {
     /** Catalog id, e.g. deepgram/nova-3; a provider's id has no slash. */
     id: string;
     kind: "provider" | "model" | "voice";
+    /** A display name; absent when the entry has none. */
+    label?: string;
     state: "active" | "deprecated";
     providerId: string;
     /** Models: stt, tts or llm. */
-    type?: "stt" | "tts" | "llm";
+    type?: "stt" | "tts" | "llm" | "nc";
     capabilities?: string[];
+    /** Providers: the adapter needs no key (fake, local models). */
+    keyless?: boolean;
     languages?: string[];
     features?: string[];
     models?: string[];
@@ -35,7 +39,8 @@ type CatalogItem = {
 };
 type ListCatalogRequest = {
     kind?: "provider" | "model" | "voice";
-    type?: "stt" | "tts" | "llm";
+    /** Models by type, or providers serving the capability (`nc`: noise cancelling). */
+    type?: "stt" | "tts" | "llm" | "nc";
 };
 type ListCatalogResponse = {
     items: CatalogItem[];
@@ -57,7 +62,7 @@ type ListProviderKeysResponse = {
 };
 /** Where a warned item is used in the workspace. */
 type WarningUse = {
-    kind: "app" | "assistant";
+    kind: "app" | "agent";
     ref: string;
     name: string;
     /** voice, ttsModel, sttModel or llm */

package/dist/records.types.d.ts

@@ -28,6 +28,8 @@ type CallRecordSummary = {
     endReason: string | null;
     failureReason: string | null;
     sipStatus: number | null;
+    /** Who answered, by AMD: human, voicemail, ivr, machine or unknown; null when AMD didn't run. */
+    amdStatus: string | null;
     startedAt: string;
     endedAt: string | null;
     durationSeconds: number;
@@ -43,6 +45,8 @@ type ListCallRecordsRequest = {
     /** Matches the from or to number. */
     number?: string;
     appRef?: string;
+    /** inbound, outbound or internal. */
+    direction?: string;
     status?: string;
     pageSize?: number;
     pageToken?: string;

package/dist/regions.types.d.ts

@@ -97,12 +97,12 @@ type Region = {
     lastSeenAt?: string;
     enrolledAt?: string;
     components?: {
-        mediaNodes: number;
-        gateways: number;
+        roomrNodes: number;
+        appbridges: number;
         autopilot: boolean;
     };
-    mediaNodes?: number;
-    gateways?: number;
+    roomrNodes?: number;
+    appbridges?: number;
     activeCalls?: number;
     configVersion?: number;
     /** Owner views: the workspaces the region serves. */

package/dist/usage.types.d.ts

@@ -0,0 +1,49 @@
+/**
+ * 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 dimension usage totals can be grouped by (usage.proto). */
+type UsageGroupBy = "day" | "workspace" | "meter" | "provider" | "model" | "key_source" | "origin";
+type GetUsageRequest = {
+    /** YYYY-MM-DD (UTC), inclusive. */
+    fromDay: string;
+    /** YYYY-MM-DD (UTC), inclusive. */
+    toDay: string;
+    /** Totals are always split by meter. */
+    groupBy?: UsageGroupBy[];
+    /** Owners only: every workspace the caller owns. */
+    allOwned?: boolean;
+};
+/** One usage total: quantities only, never money. Unrequested dimensions are empty. */
+type UsageRow = {
+    day: string;
+    workspaceRef: string;
+    meter: string;
+    /** second, character, token, count or byte */
+    unit: string;
+    provider: string;
+    model: string;
+    /** platform or workspace; empty for meters that call no vendor */
+    keySource: string;
+    /** call, browser_test, eval or api */
+    origin: string;
+    quantity: number;
+};
+type GetUsageResponse = {
+    rows: UsageRow[];
+};
+export { GetUsageRequest, GetUsageResponse, UsageGroupBy, UsageRow };

package/dist/usage.types.js

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fonoster/types",
-  "version": "0.30.0",
+  "version": "0.31.0",
   "description": "Common types for Fonoster projects",
   "author": "Pedro Sanders <psanders@fonoster.com>",
   "homepage": "https://github.com/fonoster/fonoster#readme",
@@ -13,8 +13,7 @@
   },
   "scripts": {
     "prebuild": "rimraf ./dist tsconfig.tsbuildinfo",
-    "build": "tsc -b tsconfig.json",
-    "clean": "rimraf ./dist node_modules tsconfig.tsbuildinfo"
+    "build": "tsc -b tsconfig.json"
   },
   "files": [
     "dist"
@@ -29,5 +28,5 @@
   "bugs": {
     "url": "https://github.com/fonoster/fonoster/issues"
   },
-  "gitHead": "08c9cfd7932675b6b16111daa4d03f14b4e287d1"
+  "gitHead": "f0a5102dddeea0f70f659234108805bc10690f2e"
 }