@roarkanalytics/sdk 5.7.0 → 5.9.0

package/src/resources/index.ts

@@ -42,6 +42,12 @@ export {
   type AgentPromptUpdateParams,
   type AgentPromptListVersionsParams,
 } from './agent-prompt';
+export {
+  Analytics,
+  type AnalyticsGetSchemaResponse,
+  type AnalyticsQueryResponse,
+  type AnalyticsQueryParams,
+} from './analytics';
 export {
   AutoimproveJob,
   type AutoimproveLogEntry,
@@ -126,6 +132,26 @@ export {
   type CustomerFlowEdgeCasePromoteParams,
   type CustomerFlowEdgeCaseRemoveParams,
 } from './customer-flow-edge-case';
+export {
+  Dashboard,
+  type DashboardCreateResponse,
+  type DashboardUpdateResponse,
+  type DashboardListResponse,
+  type DashboardDeleteResponse,
+  type DashboardCreateWidgetResponse,
+  type DashboardDeleteWidgetResponse,
+  type DashboardGetByIDResponse,
+  type DashboardGetDataResponse,
+  type DashboardGetWidgetDataResponse,
+  type DashboardUpdateWidgetResponse,
+  type DashboardCreateParams,
+  type DashboardUpdateParams,
+  type DashboardCreateWidgetParams,
+  type DashboardDeleteWidgetParams,
+  type DashboardGetDataParams,
+  type DashboardGetWidgetDataParams,
+  type DashboardUpdateWidgetParams,
+} from './dashboard';
 export {
   HTTPRequestDefinition,
   type HTTPRequestDefinitionCreateResponse,
@@ -279,6 +305,7 @@ export {
   type SimulationToolFixtureUpdateParams,
   type SimulationToolFixtureListParams,
 } from './simulation-tool-fixture';
+export { Usage, type UsageGetResponse, type UsageGetParams } from './usage';
 export {
   Webhook,
   type WebhookCreateResponse,

package/src/resources/metric-policy.ts

@@ -181,6 +181,63 @@ export namespace MetricPolicyCreateResponse {
 
     export interface Metric {
       id: string;
+
+      /**
+       * The metric's per-collector setting. A metric takes at most one field, and which
+       * one depends on the metric: verifiedProperties for Property Verification,
+       * excludedPhrases for voice consistency, voicemailScript for voicemail,
+       * screeningBrief for call screening, toolDefinitionIds for tool invocation,
+       * knowledgeBaseDocumentIds for knowledge grounding. A field the metric doesn't
+       * take is rejected with a 400.
+       */
+      settings: Metric.Settings | null;
+    }
+
+    export namespace Metric {
+      /**
+       * The metric's per-collector setting. A metric takes at most one field, and which
+       * one depends on the metric: verifiedProperties for Property Verification,
+       * excludedPhrases for voice consistency, voicemailScript for voicemail,
+       * screeningBrief for call screening, toolDefinitionIds for tool invocation,
+       * knowledgeBaseDocumentIds for knowledge grounding. A field the metric doesn't
+       * take is rejected with a 400.
+       */
+      export interface Settings {
+        /**
+         * Voice consistency metrics: phrases whose agent lines are not judged, such as a
+         * recorded prompt in a different voice.
+         */
+        excludedPhrases?: Array<string>;
+
+        /**
+         * Knowledge grounding metrics: the knowledge base documents to ground against, in
+         * priority order. Empty or omitted uses every knowledge base in the project.
+         */
+        knowledgeBaseDocumentIds?: Array<string>;
+
+        /**
+         * Call screening metrics: what the agent should say when a screener asks who is
+         * calling and why.
+         */
+        screeningBrief?: string;
+
+        /**
+         * Tool invocation metrics: the tool definitions to score. Empty or omitted scores
+         * every tool the agent has.
+         */
+        toolDefinitionIds?: Array<string>;
+
+        /**
+         * Property Verification metrics: the conversation properties to check against the
+         * transcript. Empty or omitted checks every custom property.
+         */
+        verifiedProperties?: Array<string>;
+
+        /**
+         * Voicemail metrics: the message the agent is expected to leave on voicemail.
+         */
+        voicemailScript?: string;
+      }
     }
   }
 }
@@ -280,6 +337,63 @@ export namespace MetricPolicyUpdateResponse {
 
     export interface Metric {
       id: string;
+
+      /**
+       * The metric's per-collector setting. A metric takes at most one field, and which
+       * one depends on the metric: verifiedProperties for Property Verification,
+       * excludedPhrases for voice consistency, voicemailScript for voicemail,
+       * screeningBrief for call screening, toolDefinitionIds for tool invocation,
+       * knowledgeBaseDocumentIds for knowledge grounding. A field the metric doesn't
+       * take is rejected with a 400.
+       */
+      settings: Metric.Settings | null;
+    }
+
+    export namespace Metric {
+      /**
+       * The metric's per-collector setting. A metric takes at most one field, and which
+       * one depends on the metric: verifiedProperties for Property Verification,
+       * excludedPhrases for voice consistency, voicemailScript for voicemail,
+       * screeningBrief for call screening, toolDefinitionIds for tool invocation,
+       * knowledgeBaseDocumentIds for knowledge grounding. A field the metric doesn't
+       * take is rejected with a 400.
+       */
+      export interface Settings {
+        /**
+         * Voice consistency metrics: phrases whose agent lines are not judged, such as a
+         * recorded prompt in a different voice.
+         */
+        excludedPhrases?: Array<string>;
+
+        /**
+         * Knowledge grounding metrics: the knowledge base documents to ground against, in
+         * priority order. Empty or omitted uses every knowledge base in the project.
+         */
+        knowledgeBaseDocumentIds?: Array<string>;
+
+        /**
+         * Call screening metrics: what the agent should say when a screener asks who is
+         * calling and why.
+         */
+        screeningBrief?: string;
+
+        /**
+         * Tool invocation metrics: the tool definitions to score. Empty or omitted scores
+         * every tool the agent has.
+         */
+        toolDefinitionIds?: Array<string>;
+
+        /**
+         * Property Verification metrics: the conversation properties to check against the
+         * transcript. Empty or omitted checks every custom property.
+         */
+        verifiedProperties?: Array<string>;
+
+        /**
+         * Voicemail metrics: the message the agent is expected to leave on voicemail.
+         */
+        voicemailScript?: string;
+      }
     }
   }
 }
@@ -381,6 +495,63 @@ export namespace MetricPolicyListResponse {
 
     export interface Metric {
       id: string;
+
+      /**
+       * The metric's per-collector setting. A metric takes at most one field, and which
+       * one depends on the metric: verifiedProperties for Property Verification,
+       * excludedPhrases for voice consistency, voicemailScript for voicemail,
+       * screeningBrief for call screening, toolDefinitionIds for tool invocation,
+       * knowledgeBaseDocumentIds for knowledge grounding. A field the metric doesn't
+       * take is rejected with a 400.
+       */
+      settings: Metric.Settings | null;
+    }
+
+    export namespace Metric {
+      /**
+       * The metric's per-collector setting. A metric takes at most one field, and which
+       * one depends on the metric: verifiedProperties for Property Verification,
+       * excludedPhrases for voice consistency, voicemailScript for voicemail,
+       * screeningBrief for call screening, toolDefinitionIds for tool invocation,
+       * knowledgeBaseDocumentIds for knowledge grounding. A field the metric doesn't
+       * take is rejected with a 400.
+       */
+      export interface Settings {
+        /**
+         * Voice consistency metrics: phrases whose agent lines are not judged, such as a
+         * recorded prompt in a different voice.
+         */
+        excludedPhrases?: Array<string>;
+
+        /**
+         * Knowledge grounding metrics: the knowledge base documents to ground against, in
+         * priority order. Empty or omitted uses every knowledge base in the project.
+         */
+        knowledgeBaseDocumentIds?: Array<string>;
+
+        /**
+         * Call screening metrics: what the agent should say when a screener asks who is
+         * calling and why.
+         */
+        screeningBrief?: string;
+
+        /**
+         * Tool invocation metrics: the tool definitions to score. Empty or omitted scores
+         * every tool the agent has.
+         */
+        toolDefinitionIds?: Array<string>;
+
+        /**
+         * Property Verification metrics: the conversation properties to check against the
+         * transcript. Empty or omitted checks every custom property.
+         */
+        verifiedProperties?: Array<string>;
+
+        /**
+         * Voicemail metrics: the message the agent is expected to leave on voicemail.
+         */
+        voicemailScript?: string;
+      }
     }
   }
 
@@ -510,13 +681,71 @@ export namespace MetricPolicyGetByIDResponse {
 
     export interface Metric {
       id: string;
+
+      /**
+       * The metric's per-collector setting. A metric takes at most one field, and which
+       * one depends on the metric: verifiedProperties for Property Verification,
+       * excludedPhrases for voice consistency, voicemailScript for voicemail,
+       * screeningBrief for call screening, toolDefinitionIds for tool invocation,
+       * knowledgeBaseDocumentIds for knowledge grounding. A field the metric doesn't
+       * take is rejected with a 400.
+       */
+      settings: Metric.Settings | null;
+    }
+
+    export namespace Metric {
+      /**
+       * The metric's per-collector setting. A metric takes at most one field, and which
+       * one depends on the metric: verifiedProperties for Property Verification,
+       * excludedPhrases for voice consistency, voicemailScript for voicemail,
+       * screeningBrief for call screening, toolDefinitionIds for tool invocation,
+       * knowledgeBaseDocumentIds for knowledge grounding. A field the metric doesn't
+       * take is rejected with a 400.
+       */
+      export interface Settings {
+        /**
+         * Voice consistency metrics: phrases whose agent lines are not judged, such as a
+         * recorded prompt in a different voice.
+         */
+        excludedPhrases?: Array<string>;
+
+        /**
+         * Knowledge grounding metrics: the knowledge base documents to ground against, in
+         * priority order. Empty or omitted uses every knowledge base in the project.
+         */
+        knowledgeBaseDocumentIds?: Array<string>;
+
+        /**
+         * Call screening metrics: what the agent should say when a screener asks who is
+         * calling and why.
+         */
+        screeningBrief?: string;
+
+        /**
+         * Tool invocation metrics: the tool definitions to score. Empty or omitted scores
+         * every tool the agent has.
+         */
+        toolDefinitionIds?: Array<string>;
+
+        /**
+         * Property Verification metrics: the conversation properties to check against the
+         * transcript. Empty or omitted checks every custom property.
+         */
+        verifiedProperties?: Array<string>;
+
+        /**
+         * Voicemail metrics: the message the agent is expected to leave on voicemail.
+         */
+        voicemailScript?: string;
+      }
     }
   }
 }
 
 export interface MetricPolicyCreateParams {
   /**
-   * Metric definitions to collect when this policy matches
+   * Metric definitions to collect when this policy matches, each with an optional
+   * setting
    */
   metrics: Array<MetricPolicyCreateParams.Metric>;
 
@@ -544,7 +773,67 @@ export interface MetricPolicyCreateParams {
 
 export namespace MetricPolicyCreateParams {
   export interface Metric {
+    /**
+     * The metric definition to collect
+     */
     id: string;
+
+    /**
+     * The metric's per-collector setting. A metric takes at most one field, and which
+     * one depends on the metric: verifiedProperties for Property Verification,
+     * excludedPhrases for voice consistency, voicemailScript for voicemail,
+     * screeningBrief for call screening, toolDefinitionIds for tool invocation,
+     * knowledgeBaseDocumentIds for knowledge grounding. A field the metric doesn't
+     * take is rejected with a 400.
+     */
+    settings?: Metric.Settings | null;
+  }
+
+  export namespace Metric {
+    /**
+     * The metric's per-collector setting. A metric takes at most one field, and which
+     * one depends on the metric: verifiedProperties for Property Verification,
+     * excludedPhrases for voice consistency, voicemailScript for voicemail,
+     * screeningBrief for call screening, toolDefinitionIds for tool invocation,
+     * knowledgeBaseDocumentIds for knowledge grounding. A field the metric doesn't
+     * take is rejected with a 400.
+     */
+    export interface Settings {
+      /**
+       * Voice consistency metrics: phrases whose agent lines are not judged, such as a
+       * recorded prompt in a different voice.
+       */
+      excludedPhrases?: Array<string>;
+
+      /**
+       * Knowledge grounding metrics: the knowledge base documents to ground against, in
+       * priority order. Empty or omitted uses every knowledge base in the project.
+       */
+      knowledgeBaseDocumentIds?: Array<string>;
+
+      /**
+       * Call screening metrics: what the agent should say when a screener asks who is
+       * calling and why.
+       */
+      screeningBrief?: string;
+
+      /**
+       * Tool invocation metrics: the tool definitions to score. Empty or omitted scores
+       * every tool the agent has.
+       */
+      toolDefinitionIds?: Array<string>;
+
+      /**
+       * Property Verification metrics: the conversation properties to check against the
+       * transcript. Empty or omitted checks every custom property.
+       */
+      verifiedProperties?: Array<string>;
+
+      /**
+       * Voicemail metrics: the message the agent is expected to leave on voicemail.
+       */
+      voicemailScript?: string;
+    }
   }
 
   export interface Condition {
@@ -595,7 +884,9 @@ export interface MetricPolicyUpdateParams {
   conditions?: Array<MetricPolicyUpdateParams.Condition>;
 
   /**
-   * Metric definitions to collect when this policy matches
+   * Metric definitions to collect when this policy matches. Replaces the policy's
+   * whole metric list: a metric sent without settings goes back to its default, so
+   * resend a metric's settings to keep them. Omit to keep the current metrics.
    */
   metrics?: Array<MetricPolicyUpdateParams.Metric>;
 
@@ -651,7 +942,67 @@ export namespace MetricPolicyUpdateParams {
   }
 
   export interface Metric {
+    /**
+     * The metric definition to collect
+     */
     id: string;
+
+    /**
+     * The metric's per-collector setting. A metric takes at most one field, and which
+     * one depends on the metric: verifiedProperties for Property Verification,
+     * excludedPhrases for voice consistency, voicemailScript for voicemail,
+     * screeningBrief for call screening, toolDefinitionIds for tool invocation,
+     * knowledgeBaseDocumentIds for knowledge grounding. A field the metric doesn't
+     * take is rejected with a 400.
+     */
+    settings?: Metric.Settings | null;
+  }
+
+  export namespace Metric {
+    /**
+     * The metric's per-collector setting. A metric takes at most one field, and which
+     * one depends on the metric: verifiedProperties for Property Verification,
+     * excludedPhrases for voice consistency, voicemailScript for voicemail,
+     * screeningBrief for call screening, toolDefinitionIds for tool invocation,
+     * knowledgeBaseDocumentIds for knowledge grounding. A field the metric doesn't
+     * take is rejected with a 400.
+     */
+    export interface Settings {
+      /**
+       * Voice consistency metrics: phrases whose agent lines are not judged, such as a
+       * recorded prompt in a different voice.
+       */
+      excludedPhrases?: Array<string>;
+
+      /**
+       * Knowledge grounding metrics: the knowledge base documents to ground against, in
+       * priority order. Empty or omitted uses every knowledge base in the project.
+       */
+      knowledgeBaseDocumentIds?: Array<string>;
+
+      /**
+       * Call screening metrics: what the agent should say when a screener asks who is
+       * calling and why.
+       */
+      screeningBrief?: string;
+
+      /**
+       * Tool invocation metrics: the tool definitions to score. Empty or omitted scores
+       * every tool the agent has.
+       */
+      toolDefinitionIds?: Array<string>;
+
+      /**
+       * Property Verification metrics: the conversation properties to check against the
+       * transcript. Empty or omitted checks every custom property.
+       */
+      verifiedProperties?: Array<string>;
+
+      /**
+       * Voicemail metrics: the message the agent is expected to leave on voicemail.
+       */
+      voicemailScript?: string;
+    }
   }
 }
 

package/src/resources/usage.ts

@@ -0,0 +1,147 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import { APIPromise } from '../core/api-promise';
+import { RequestOptions } from '../internal/request-options';
+
+export class Usage extends APIResource {
+  /**
+   * Report billable usage and cost for the organization over a time window, broken
+   * down by project (highest spend first). Pass `from`/`to` as ISO 8601 timestamps;
+   * optionally pass `projectId` to scope the report to one project. Amounts are
+   * billable spend only (what we absorb is never included). Authenticated by an
+   * organization API key with the `usage:read` permission.
+   *
+   * @example
+   * ```ts
+   * const usage = await client.usage.get({
+   *   from: '2026-09-01T00:00:00Z',
+   *   to: '2026-10-01T00:00:00Z',
+   * });
+   * ```
+   */
+  get(query: UsageGetParams, options?: RequestOptions): APIPromise<UsageGetResponse> {
+    return this._client.get('/v1/usage', { query, ...options });
+  }
+}
+
+export interface UsageGetResponse {
+  data: UsageGetResponse.Data;
+}
+
+export namespace UsageGetResponse {
+  export interface Data {
+    currency: 'usd';
+
+    /**
+     * The resolved window start, echoed back as ISO 8601.
+     */
+    from: string;
+
+    /**
+     * Per-project billable spend, highest first. Only projects with spend in the
+     * window appear.
+     */
+    projects: Array<Data.Project>;
+
+    /**
+     * The resolved window end, echoed back as ISO 8601.
+     */
+    to: string;
+
+    /**
+     * The same total in US dollars.
+     */
+    totalUsd: number;
+
+    /**
+     * Total billable spend across the organization (or the single project) in
+     * micro-dollars.
+     */
+    totalUsdMicros: number;
+  }
+
+  export namespace Data {
+    export interface Project {
+      /**
+       * The same billable spend in US dollars. For display; use amountUsdMicros to
+       * reconcile.
+       */
+      amountUsd: number;
+
+      /**
+       * Billable spend in integer micro-dollars (1,000,000 = $1). The exact value.
+       */
+      amountUsdMicros: number;
+
+      /**
+       * This project's spend split by cost type, highest first. Sums to amountUsdMicros.
+       */
+      breakdown: Array<Project.Breakdown>;
+
+      projectId: string;
+
+      /**
+       * Null only if the project no longer exists in this organization.
+       */
+      projectName: string | null;
+    }
+
+    export namespace Project {
+      export interface Breakdown {
+        /**
+         * The same figure in US dollars.
+         */
+        amountUsd: number;
+
+        /**
+         * Billable spend for this type, in micro-dollars.
+         */
+        amountUsdMicros: number;
+
+        /**
+         * The cost source, e.g. SIM*PLATFORM_FEE, SIM_LLM, SIM_TTS, SIM_STT,
+         * SIM_TELEPHONY, METRIC, or TRANSCRIPTION. These are the granular sources behind
+         * the Billing screen categories (SIM*\* roll up into "Simulation").
+         */
+        source:
+          | 'SIM_PLATFORM_FEE'
+          | 'SIM_TTS'
+          | 'SIM_STT'
+          | 'SIM_LLM'
+          | 'SIM_TELEPHONY'
+          | 'METRIC'
+          | 'TRANSCRIPTION'
+          | 'INTERNAL_LLM'
+          | 'INTERNAL_STT';
+
+        /**
+         * Whether this cost came from a SIMULATION or a production call (POST_CALL).
+         */
+        surface: 'SIMULATION' | 'POST_CALL';
+      }
+    }
+  }
+}
+
+export interface UsageGetParams {
+  /**
+   * Start of the window (inclusive), ISO 8601.
+   */
+  from: string;
+
+  /**
+   * End of the window (exclusive), ISO 8601. Must be after `from`, and the window
+   * may not exceed 366 days.
+   */
+  to: string;
+
+  /**
+   * Limit the report to a single project. Omit for the whole organization.
+   */
+  projectId?: string;
+}
+
+export declare namespace Usage {
+  export { type UsageGetResponse as UsageGetResponse, type UsageGetParams as UsageGetParams };
+}

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '5.7.0'; // x-release-please-version
+export const VERSION = '5.9.0'; // x-release-please-version

package/version.d.mts

@@ -1,2 +1,2 @@
-export declare const VERSION = "5.7.0";
+export declare const VERSION = "5.9.0";
 //# sourceMappingURL=version.d.mts.map

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "5.7.0";
+export declare const VERSION = "5.9.0";
 //# sourceMappingURL=version.d.ts.map

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '5.7.0'; // x-release-please-version
+exports.VERSION = '5.9.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '5.7.0'; // x-release-please-version
+export const VERSION = '5.9.0'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map