@athenaintel/sdk 4.3.2250 → 4.3.2252

package/dist/esm/api/resources/workspaces/client/requests/ListUsageSessionsWorkspacesRequest.d.mts

@@ -0,0 +1,22 @@
+/**
+ * @example
+ *     {
+ *         workspace_id: "workspace_eb171baf",
+ *         days: 30,
+ *         limit: 100
+ *     }
+ */
+export interface ListUsageSessionsWorkspacesRequest {
+    /** Unique identifier of the workspace */
+    workspace_id: string;
+    /** First UTC day of the window (YYYY-MM-DD); requires `to` */
+    from?: string | null;
+    /** Last UTC day of the window, inclusive (YYYY-MM-DD); requires `from` */
+    to?: string | null;
+    /** Rolling window in days ending now; ignored when `from`/`to` are given */
+    days?: number;
+    /** `next_cursor` from the previous page */
+    cursor?: string | null;
+    /** Maximum sessions per page (each may yield several rows) */
+    limit?: number;
+}

package/dist/esm/api/resources/workspaces/client/requests/ListUsageSessionsWorkspacesRequest.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/resources/workspaces/client/requests/index.d.mts

@@ -1,6 +1,9 @@
 export type { CreatePresenceTokenWorkspacesRequest } from "./CreatePresenceTokenWorkspacesRequest.mjs";
 export type { GetConfigurationWorkspacesRequest } from "./GetConfigurationWorkspacesRequest.mjs";
 export type { GetToolRegistryWorkspacesRequest } from "./GetToolRegistryWorkspacesRequest.mjs";
+export type { GetUsageWorkspacesRequest } from "./GetUsageWorkspacesRequest.mjs";
+export type { ListMembershipsWorkspacesRequest } from "./ListMembershipsWorkspacesRequest.mjs";
+export type { ListUsageSessionsWorkspacesRequest } from "./ListUsageSessionsWorkspacesRequest.mjs";
 export type { PresenceResolveRequestIn } from "./PresenceResolveRequestIn.mjs";
 export type { SearchMembersWorkspacesRequest } from "./SearchMembersWorkspacesRequest.mjs";
 export type { UpdateWorkspaceConfigurationRequestIn } from "./UpdateWorkspaceConfigurationRequestIn.mjs";

package/dist/esm/api/types/WorkspaceMembershipListResponseOut.d.mts

@@ -0,0 +1,12 @@
+import type * as AthenaIntelligence from "../index.mjs";
+/**
+ * One page of a workspace's membership roster.
+ */
+export interface WorkspaceMembershipListResponseOut {
+    /** Memberships for this page, ordered by user id */
+    memberships: AthenaIntelligence.WorkspaceMembershipOut[];
+    /** Pass as `cursor` to fetch the next page; null on the last page */
+    next_cursor: string | null;
+    /** Workspace the roster belongs to */
+    workspace_id: string;
+}

package/dist/esm/api/types/WorkspaceMembershipListResponseOut.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/WorkspaceMembershipOut.d.mts

@@ -0,0 +1,18 @@
+/**
+ * One member of a workspace and their role.
+ */
+export interface WorkspaceMembershipOut {
+    email: string;
+    first_name: string | null;
+    /** Membership has been removed from the workspace */
+    is_archived: boolean;
+    /** The user account is suspended deployment-wide */
+    is_suspended: boolean;
+    /** When the membership was created */
+    joined_at: string;
+    last_name: string | null;
+    /** Workspace role: owner, manager or user */
+    role: string;
+    /** User id, stable across workspaces */
+    user_id: string;
+}

package/dist/esm/api/types/WorkspaceMembershipOut.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/WorkspaceUsageComputerOut.d.mts

@@ -0,0 +1,22 @@
+import type * as AthenaIntelligence from "../index.mjs";
+/**
+ * Usage attributed to one Computer asset over the window.
+ */
+export interface WorkspaceUsageComputerOut {
+    /** The Computer asset ID */
+    computer_asset_id: string;
+    /** Whether the Computer is archived */
+    is_archived: boolean;
+    /** When the most recent usage session was created */
+    last_session_at?: string | null;
+    /** Number of successful model calls */
+    request_count: number;
+    /** Number of usage sessions */
+    session_count: number;
+    /** The Computer's title */
+    title?: string | null;
+    /** Token counters behind this Computer's usage */
+    tokens: AthenaIntelligence.WorkspaceUsageTokensOut;
+    /** Total LLM cost in USD */
+    total_cost_usd: number;
+}

package/dist/esm/api/types/WorkspaceUsageComputerOut.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/WorkspaceUsageDayOut.d.mts

@@ -0,0 +1,14 @@
+import type * as AthenaIntelligence from "../index.mjs";
+/**
+ * Usage of the workspace on one UTC day.
+ */
+export interface WorkspaceUsageDayOut {
+    /** Date in YYYY-MM-DD format (UTC) */
+    date: string;
+    /** Number of sessions created on the day */
+    session_count: number;
+    /** Token counters for the day */
+    tokens: AthenaIntelligence.WorkspaceUsageTokensOut;
+    /** Total LLM cost in USD for the day */
+    total_cost_usd: number;
+}

package/dist/esm/api/types/WorkspaceUsageDayOut.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/WorkspaceUsageResponseOut.d.mts

@@ -0,0 +1,36 @@
+import type * as AthenaIntelligence from "../index.mjs";
+/**
+ * Aggregated LLM token and cost usage for one workspace.
+ */
+export interface WorkspaceUsageResponseOut {
+    /** Users with at least one session */
+    active_users: number;
+    /** Portion of total_cost_usd produced by Computers */
+    computer_cost_usd: number;
+    /** Number of Computer usage sessions */
+    computer_sessions: number;
+    /** Portion of tokens produced by Computers' LLM usage (already included in tokens, never additive) */
+    computer_tokens: AthenaIntelligence.WorkspaceUsageTokensOut;
+    /** Per-day breakdown, oldest first */
+    daily: AthenaIntelligence.WorkspaceUsageDayOut[];
+    /** Length of the reporting window in days */
+    days: number;
+    /** Cost of dry-run (test) sessions */
+    dry_run_cost_usd: number;
+    /** Number of dry-run (test) sessions */
+    dry_run_sessions: number;
+    /** Token counters from dry-run (test) sessions, excluded from tokens */
+    dry_run_tokens: AthenaIntelligence.WorkspaceUsageTokensOut;
+    /** Per-Computer breakdown, highest cost first */
+    per_computer: AthenaIntelligence.WorkspaceUsageComputerOut[];
+    /** Per-member breakdown, highest cost first */
+    per_user: AthenaIntelligence.WorkspaceUsageUserOut[];
+    /** Token counters across the workspace's sessions in the window, excluding dry-run (test) sessions */
+    tokens: AthenaIntelligence.WorkspaceUsageTokensOut;
+    /** Total LLM cost in USD */
+    total_cost_usd: number;
+    /** Number of sessions in the window */
+    total_sessions: number;
+    /** The workspace ID */
+    workspace_id: string;
+}

package/dist/esm/api/types/WorkspaceUsageResponseOut.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/WorkspaceUsageSessionRowOut.d.mts

@@ -0,0 +1,65 @@
+/**
+ * Token usage of one session for one provider/model/status combination.
+ */
+export interface WorkspaceUsageSessionRowOut {
+    /** AOP asset id when started by an AOP run */
+    aop_id: string | null;
+    /** Title of that AOP */
+    aop_title: string | null;
+    /** Billing attribution of the session */
+    billed_to: string | null;
+    /** Null for an `untracked` row */
+    cache_creation_input_tokens: number | null;
+    /** Null for an `untracked` row */
+    cache_read_input_tokens: number | null;
+    /** Earliest model call in the row */
+    first_event_at: string | null;
+    /** Null for an `untracked` row */
+    input_tokens: number | null;
+    /** Latest model call in the row */
+    last_event_at: string | null;
+    /** How the session was started (user_chat, aop_execution, public_api, ...) */
+    origin_kind: string | null;
+    /** Human label for origin_kind */
+    origin_kind_label: string | null;
+    /** Null for an `untracked` row */
+    output_tokens: number | null;
+    /** Project asset id, if any */
+    project_id: string | null;
+    /** Title of that project */
+    project_title: string | null;
+    /** LLM provider */
+    provider: string;
+    /** Null for an `untracked` row */
+    reasoning_output_tokens: number | null;
+    /** Model the session asked for */
+    requested_model: string | null;
+    /** Model that actually served the calls */
+    resolved_model: string;
+    /** Billed cost of this row in USD; safe to sum across rows */
+    row_total_cost_usd: number;
+    /** Model calls aggregated into this row */
+    run_count: number;
+    /** When the session was created */
+    session_created_at: string;
+    /** Session (conversation) asset id */
+    session_id: string;
+    /** Billed cost of the whole session in USD, carried by the session's first row only and null on its other rows, so summing the column never double-counts (same convention as the CSV export) */
+    session_total_cost_usd: number | null;
+    /** Outcome of the aggregated calls; `untracked` marks a session metered before token tracking existed, whose token counters are null */
+    status: string;
+    /** Null for an `untracked` row */
+    total_tokens: number | null;
+    /** AOP trigger type, if any */
+    trigger_type: string | null;
+    /** Null for an `untracked` row */
+    uncached_input_tokens: number | null;
+    /** Window end (exclusive) the row was bounded to */
+    usage_period_end_exclusive: string | null;
+    /** Window start the row was bounded to */
+    usage_period_start: string;
+    /** Email of the member who ran the session */
+    user_email: string | null;
+    /** Display name of that member */
+    user_name: string | null;
+}

package/dist/esm/api/types/WorkspaceUsageSessionRowOut.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/WorkspaceUsageSessionsResponseOut.d.mts

@@ -0,0 +1,13 @@
+import type * as AthenaIntelligence from "../index.mjs";
+/**
+ * One page of per-session token usage for a workspace.
+ */
+export interface WorkspaceUsageSessionsResponseOut {
+    /** Pass as `cursor` to fetch the next page; null when the window is exhausted */
+    next_cursor: string | null;
+    /** Rows for this page, newest session first */
+    sessions: AthenaIntelligence.WorkspaceUsageSessionRowOut[];
+    window: AthenaIntelligence.WorkspaceUsageWindowOut;
+    /** Workspace the rows belong to */
+    workspace_id: string;
+}

package/dist/esm/api/types/WorkspaceUsageSessionsResponseOut.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/WorkspaceUsageTokensOut.d.mts

@@ -0,0 +1,17 @@
+/**
+ * Token counters summed from the sessions' LLM usage ledgers.
+ */
+export interface WorkspaceUsageTokensOut {
+    /** Input tokens written to the provider's prompt cache */
+    cache_creation_input_tokens: number;
+    /** Input tokens served from the provider's prompt cache */
+    cache_read_input_tokens: number;
+    /** Input (prompt) tokens, including cached reads */
+    input_tokens: number;
+    /** Output (completion) tokens, including reasoning tokens */
+    output_tokens: number;
+    /** Output tokens spent on reasoning */
+    reasoning_output_tokens: number;
+    /** Total tokens (input + output) */
+    total_tokens: number;
+}

package/dist/esm/api/types/WorkspaceUsageTokensOut.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/WorkspaceUsageUserOut.d.mts

@@ -0,0 +1,22 @@
+import type * as AthenaIntelligence from "../index.mjs";
+/**
+ * Usage of one workspace member over the window.
+ */
+export interface WorkspaceUsageUserOut {
+    /** The user's email */
+    email: string;
+    /** First name */
+    first_name?: string | null;
+    /** Last name */
+    last_name?: string | null;
+    /** When the user's most recent session was created */
+    last_session_at?: string | null;
+    /** Number of sessions */
+    session_count: number;
+    /** Token counters across the user's sessions */
+    tokens: AthenaIntelligence.WorkspaceUsageTokensOut;
+    /** Total LLM cost in USD */
+    total_cost_usd: number;
+    /** The user ID */
+    user_id: string;
+}

package/dist/esm/api/types/WorkspaceUsageUserOut.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/WorkspaceUsageWindowOut.d.mts

@@ -0,0 +1,15 @@
+/**
+ * The reporting window a usage page covers.
+ */
+export interface WorkspaceUsageWindowOut {
+    /** Number of days the window spans */
+    days: number;
+    /** Last UTC day (inclusive) of an explicit window; null for a rolling window */
+    end_date: string | null;
+    /** First UTC day of an explicit `from`/`to` window; null for a rolling window */
+    start_date: string | null;
+    /** Window end (exclusive); null means 'now' for a rolling window */
+    usage_period_end_exclusive: string | null;
+    /** Window start (inclusive) */
+    usage_period_start: string;
+}

package/dist/esm/api/types/WorkspaceUsageWindowOut.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/index.d.mts

@@ -165,7 +165,17 @@ export * from "./WorkspaceDisclaimerOut.mjs";
 export * from "./WorkspaceInfoOut.mjs";
 export * from "./WorkspaceMemberOut.mjs";
 export * from "./WorkspaceMemberSearchResponseOut.mjs";
+export * from "./WorkspaceMembershipListResponseOut.mjs";
+export * from "./WorkspaceMembershipOut.mjs";
 export * from "./WorkspaceShareAccess.mjs";
 export * from "./WorkspaceToolRegistryResponseOut.mjs";
 export * from "./WorkspaceToolRegistryToolOut.mjs";
+export * from "./WorkspaceUsageComputerOut.mjs";
+export * from "./WorkspaceUsageDayOut.mjs";
+export * from "./WorkspaceUsageResponseOut.mjs";
+export * from "./WorkspaceUsageSessionRowOut.mjs";
+export * from "./WorkspaceUsageSessionsResponseOut.mjs";
+export * from "./WorkspaceUsageTokensOut.mjs";
+export * from "./WorkspaceUsageUserOut.mjs";
+export * from "./WorkspaceUsageWindowOut.mjs";
 export * from "./WrapStrategy.mjs";

package/dist/esm/api/types/index.mjs

@@ -165,7 +165,17 @@ export * from "./WorkspaceDisclaimerOut.mjs";
 export * from "./WorkspaceInfoOut.mjs";
 export * from "./WorkspaceMemberOut.mjs";
 export * from "./WorkspaceMemberSearchResponseOut.mjs";
+export * from "./WorkspaceMembershipListResponseOut.mjs";
+export * from "./WorkspaceMembershipOut.mjs";
 export * from "./WorkspaceShareAccess.mjs";
 export * from "./WorkspaceToolRegistryResponseOut.mjs";
 export * from "./WorkspaceToolRegistryToolOut.mjs";
+export * from "./WorkspaceUsageComputerOut.mjs";
+export * from "./WorkspaceUsageDayOut.mjs";
+export * from "./WorkspaceUsageResponseOut.mjs";
+export * from "./WorkspaceUsageSessionRowOut.mjs";
+export * from "./WorkspaceUsageSessionsResponseOut.mjs";
+export * from "./WorkspaceUsageTokensOut.mjs";
+export * from "./WorkspaceUsageUserOut.mjs";
+export * from "./WorkspaceUsageWindowOut.mjs";
 export * from "./WrapStrategy.mjs";

package/dist/esm/version.d.mts

@@ -1 +1 @@
-export declare const SDK_VERSION = "4.3.2250";
+export declare const SDK_VERSION = "4.3.2252";

package/dist/esm/version.mjs

@@ -1 +1 @@
-export const SDK_VERSION = "4.3.2250";
+export const SDK_VERSION = "4.3.2252";

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@athenaintel/sdk",
-    "version": "4.3.2250",
+    "version": "4.3.2252",
     "private": false,
     "repository": "github:Athena-Intel/athena-typescript",
     "type": "commonjs",

package/reference.md

@@ -5578,6 +5578,73 @@ await client.workspaces.searchMembers({
 </dl>
 
 
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.workspaces.<a href="/src/api/resources/workspaces/client/Client.ts">listMemberships</a>({ ...params }) -> AthenaIntelligence.WorkspaceMembershipListResponseOut</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+The full membership roster of one workspace with each member's user id, name, email, role and join date — built for usage reporting and licence reconciliation, unlike the share-picker search at `GET /workspaces/{workspace_id}/members`. Removed members are left out unless `include_archived=true`. Pages are ordered by user id; `next_cursor` is returned while more remain. Requires workspace owner or manager (or Athena admin) permissions.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.workspaces.listMemberships({
+    workspace_id: "workspace_eb171baf",
+    include_archived: false,
+    limit: 200
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `AthenaIntelligence.ListMembershipsWorkspacesRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `WorkspacesClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
 </dd>
 </dl>
 </details>
@@ -5847,6 +5914,139 @@ await client.workspaces.updateToolRegistry({
 </dl>
 
 
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.workspaces.<a href="/src/api/resources/workspaces/client/Client.ts">getUsage</a>({ ...params }) -> AthenaIntelligence.WorkspaceUsageResponseOut</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Aggregate LLM token usage (and cost) for one workspace over the last `days` days: workspace totals plus per-member, per-day and per-Computer breakdowns. Token counters are summed from each session's usage ledger; dry-run (test) sessions are reported separately and excluded from the totals. Requires workspace owner or manager (or Athena admin) permissions — the same gate as the in-app Usage page.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.workspaces.getUsage({
+    workspace_id: "workspace_id",
+    days: 30
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `AthenaIntelligence.GetUsageWorkspacesRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `WorkspacesClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.workspaces.<a href="/src/api/resources/workspaces/client/Client.ts">listUsageSessions</a>({ ...params }) -> AthenaIntelligence.WorkspaceUsageSessionsResponseOut</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Per-session LLM token usage for one workspace — the same rows as the workspace usage CSV export, as JSON. Each session yields one row per provider/model/status combination with its token breakdown and billed cost; dry-run (test) sessions are excluded. Pick the window with `from`/`to` (UTC dates, inclusive, at most 365 days) or a rolling `days`. Pages are keyset-paginated newest first: `limit` counts sessions, and `next_cursor` is returned while more sessions remain. Requires workspace owner or manager (or Athena admin) permissions.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.workspaces.listUsageSessions({
+    workspace_id: "workspace_eb171baf",
+    days: 30,
+    limit: 100
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `AthenaIntelligence.ListUsageSessionsWorkspacesRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `WorkspacesClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
 </dd>
 </dl>
 </details>