@roarkanalytics/sdk 5.8.0 → 5.10.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,
@@ -77,6 +83,7 @@ export {
   type CallListResponse,
   type CallAppendToolInvocationsResponse,
   type CallGetByIDResponse,
+  type CallGetCostResponse,
   type CallGetTranscriptResponse,
   type CallListMetricsResponse,
   type CallListSentimentRunsResponse,
@@ -126,6 +133,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,
@@ -261,6 +288,7 @@ export {
   type SimulationRunPlanJobCancelResponse,
   type SimulationRunPlanJobCreateDebriefResponse,
   type SimulationRunPlanJobGetByIDResponse,
+  type SimulationRunPlanJobGetCostResponse,
   type SimulationRunPlanJobGetResultsResponse,
   type SimulationRunPlanJobStartResponse,
   type SimulationRunPlanJobListParams,
@@ -279,6 +307,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/simulation-run-plan-job.ts

@@ -81,6 +81,24 @@ export class SimulationRunPlanJob extends APIResource {
     return this._client.get(path`/v1/simulation/plan/job/${jobID}`, options);
   }
 
+  /**
+   * The billable spend for one simulation run (run plan job), split by cost type,
+   * with the spend of each simulated call in it. Safe to call while the run is in
+   * progress: totals reflect the costs recorded so far. Amounts are billable spend
+   * only, in exact micro-dollars (`\*UsdMicros`) and dollars (`\*Usd`, for display).
+   * Requires an API key with the `billing:read` permission.
+   *
+   * @example
+   * ```ts
+   * const response = await client.simulationRunPlanJob.getCost(
+   *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   * );
+   * ```
+   */
+  getCost(jobID: string, options?: RequestOptions): APIPromise<SimulationRunPlanJobGetCostResponse> {
+    return this._client.get(path`/v1/simulation/plan/job/${jobID}/cost`, options);
+  }
+
   /**
    * Everything the run report shows, in one request: the summary and score, the
    * pass/fail verdict, per-metric aggregates, every simulation with its check
@@ -1552,6 +1570,128 @@ export namespace SimulationRunPlanJobGetByIDResponse {
   }
 }
 
+export interface SimulationRunPlanJobGetCostResponse {
+  data: SimulationRunPlanJobGetCostResponse.Data;
+}
+
+export namespace SimulationRunPlanJobGetCostResponse {
+  export interface Data {
+    /**
+     * Spend by cost type. Sums to totalUsdMicros.
+     */
+    breakdown: Array<Data.Breakdown>;
+
+    /**
+     * Spend per simulated call in the run.
+     */
+    calls: Array<Data.Call>;
+
+    currency: 'usd';
+
+    jobId: string;
+
+    totalUsd: number;
+
+    /**
+     * Total billable spend for the run, in micro-dollars.
+     */
+    totalUsdMicros: number;
+  }
+
+  export namespace Data {
+    export interface Breakdown {
+      /**
+       * The same figure in US dollars.
+       */
+      amountUsd: number;
+
+      /**
+       * Billable spend for this type, in micro-dollars.
+       */
+      amountUsdMicros: number;
+
+      /**
+       * Units billed (see the line items for the unit).
+       */
+      quantity: number;
+
+      /**
+       * The cost source, e.g. SIM_PLATFORM_FEE, SIM_LLM, METRIC.
+       */
+      source:
+        | 'SIM_PLATFORM_FEE'
+        | 'SIM_TTS'
+        | 'SIM_STT'
+        | 'SIM_LLM'
+        | 'SIM_TELEPHONY'
+        | 'METRIC'
+        | 'TRANSCRIPTION'
+        | 'INTERNAL_LLM'
+        | 'INTERNAL_STT';
+
+      /**
+       * SIMULATION or POST_CALL.
+       */
+      surface: 'SIMULATION' | 'POST_CALL';
+    }
+
+    export interface Call {
+      amountUsd: number;
+
+      amountUsdMicros: number;
+
+      breakdown: Array<Call.Breakdown>;
+
+      /**
+       * The call (voice runs) or chat (chat runs) the spend is attributed to. Null for
+       * costs incurred before the conversation existed; use simulationJobId to join
+       * those.
+       */
+      conversationId: string | null;
+
+      simulationJobId: string | null;
+    }
+
+    export namespace Call {
+      export interface Breakdown {
+        /**
+         * The same figure in US dollars.
+         */
+        amountUsd: number;
+
+        /**
+         * Billable spend for this type, in micro-dollars.
+         */
+        amountUsdMicros: number;
+
+        /**
+         * Units billed (see the line items for the unit).
+         */
+        quantity: number;
+
+        /**
+         * The cost source, e.g. SIM_PLATFORM_FEE, SIM_LLM, METRIC.
+         */
+        source:
+          | 'SIM_PLATFORM_FEE'
+          | 'SIM_TTS'
+          | 'SIM_STT'
+          | 'SIM_LLM'
+          | 'SIM_TELEPHONY'
+          | 'METRIC'
+          | 'TRANSCRIPTION'
+          | 'INTERNAL_LLM'
+          | 'INTERNAL_STT';
+
+        /**
+         * SIMULATION or POST_CALL.
+         */
+        surface: 'SIMULATION' | 'POST_CALL';
+      }
+    }
+  }
+}
+
 export interface SimulationRunPlanJobGetResultsResponse {
   /**
    * Everything the run report shows, in one response.
@@ -2882,6 +3022,7 @@ export declare namespace SimulationRunPlanJob {
     type SimulationRunPlanJobCancelResponse as SimulationRunPlanJobCancelResponse,
     type SimulationRunPlanJobCreateDebriefResponse as SimulationRunPlanJobCreateDebriefResponse,
     type SimulationRunPlanJobGetByIDResponse as SimulationRunPlanJobGetByIDResponse,
+    type SimulationRunPlanJobGetCostResponse as SimulationRunPlanJobGetCostResponse,
     type SimulationRunPlanJobGetResultsResponse as SimulationRunPlanJobGetResultsResponse,
     type SimulationRunPlanJobStartResponse as SimulationRunPlanJobStartResponse,
     type SimulationRunPlanJobListParams as SimulationRunPlanJobListParams,

package/src/resources/usage.ts

@@ -0,0 +1,149 @@
+// 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 either
+   * an organization API key with the `usage:read` permission (any project in the
+   * organization), or a project API key with the `billing:read` permission (that
+   * key's own project only; any other `projectId` is a 403).
+   *
+   * @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.8.0'; // x-release-please-version
+export const VERSION = '5.10.0'; // x-release-please-version

package/version.d.mts

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

package/version.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"version.d.mts","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,OAAO,UAAU,CAAC"}
+{"version":3,"file":"version.d.mts","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,OAAO,WAAW,CAAC"}

package/version.d.ts

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

package/version.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"version.d.ts","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,OAAO,UAAU,CAAC"}
+{"version":3,"file":"version.d.ts","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,OAAO,WAAW,CAAC"}

package/version.js

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

package/version.js.map

@@ -1 +1 @@
-{"version":3,"file":"version.js","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":";;;AAAa,QAAA,OAAO,GAAG,OAAO,CAAC,CAAC,2BAA2B"}
+{"version":3,"file":"version.js","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":";;;AAAa,QAAA,OAAO,GAAG,QAAQ,CAAC,CAAC,2BAA2B"}

package/version.mjs

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

package/version.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"version.mjs","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,OAAO,GAAG,OAAO,CAAC,CAAC,2BAA2B"}
+{"version":3,"file":"version.mjs","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,OAAO,GAAG,QAAQ,CAAC,CAAC,2BAA2B"}