@thinkai/tai-api-contract 2.53.0 → 2.54.0

package/src/generated/openapi.ts

@@ -1132,6 +1132,66 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/workspaces/{workspaceId}/integrations/ai-tool/{provider}/summary": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * AI-tool provider summary for a date window
+         * @description Pre-aggregated spend, token, and active-user totals plus weekly buckets for the AI Usage & Spend overview. Replaces downloading the full `/snapshot` payload for KPI cards and sparklines.
+         */
+        get: operations["getWorkspaceAiToolProviderSummary"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/workspaces/{workspaceId}/integrations/ai-tool/{provider}/daily-series": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * AI-tool daily spend and usage series for charts
+         * @description Daily chart points (spend and tokens) with optional product/model breakdown. Scoped to the requested date window; intended for the overview trend chart.
+         */
+        get: operations["getWorkspaceAiToolProviderDailySeries"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/workspaces/{workspaceId}/integrations/ai-tool/{provider}/model-breakdown": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * AI-tool model spend rollup for a date window
+         * @description Aggregated spend and token totals per LLM model for the Costs by LLM Model page and team drill-downs. Optionally scoped to specific member external IDs.
+         */
+        get: operations["getWorkspaceAiToolProviderModelBreakdown"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/workspaces/{workspaceId}/integrations/ai-tool/{provider}/status": {
         parameters: {
             query?: never;
@@ -3579,6 +3639,97 @@ export interface components {
             days?: components["schemas"]["AiUsageSpendUsageTrendsDayDto"][];
             weeks?: components["schemas"]["AiUsageSpendUsageTrendsWeekDto"][];
         };
+        AiToolProviderSummaryWeekBucketDto: {
+            weekLabel: string;
+            spendCents: number;
+            tokenCount: number;
+            activeUsers: number;
+        };
+        AiToolProviderSummaryTopMoverDto: {
+            externalId: string;
+            label: string;
+            deltaSpendCents: number;
+            currentSpendCents: number;
+        };
+        AiToolProviderSummaryDto: {
+            provider: string;
+            /** Format: date */
+            from: string;
+            /** Format: date */
+            to: string;
+            status?: components["schemas"]["AiToolRefreshStatusDto"];
+            seatCounts: {
+                total: number;
+                active: number;
+                removed: number;
+            };
+            totals: {
+                spendCents: number;
+                tokenCount: number;
+                activeUsers: number;
+                totalEngineers: number;
+            };
+            weekBuckets: components["schemas"]["AiToolProviderSummaryWeekBucketDto"][];
+            topMovers?: components["schemas"]["AiToolProviderSummaryTopMoverDto"][];
+            hasTokenMetrics?: boolean;
+            /** Format: date-time */
+            generatedAt: string;
+        };
+        AiToolDailySeriesPointDto: {
+            /** Format: date */
+            day: string;
+            label: string;
+            spendCents: number;
+            tokenCount: number;
+            /** @description Spend cents by product label. */
+            products: {
+                [key: string]: number;
+            };
+            /** @description Spend cents by model name. */
+            models: {
+                [key: string]: number;
+            };
+        };
+        AiToolDailySeriesDto: {
+            provider: string;
+            /** Format: date */
+            from: string;
+            /** Format: date */
+            to: string;
+            points: components["schemas"]["AiToolDailySeriesPointDto"][];
+            productKeys: string[];
+            modelKeys: string[];
+            totals: {
+                spendCents: number;
+                tokenCount: number;
+            };
+            hasProductBreakdown?: boolean;
+            hasModelBreakdown?: boolean;
+            hasSpend?: boolean;
+            hasTokens?: boolean;
+            /** Format: date-time */
+            generatedAt: string;
+        };
+        AiToolModelBreakdownItemDto: {
+            modelName: string;
+            spendCents: number;
+            tokenCount: number;
+            activeUsers: number;
+        };
+        AiToolModelBreakdownDto: {
+            provider: string;
+            /** Format: date */
+            from: string;
+            /** Format: date */
+            to: string;
+            models: components["schemas"]["AiToolModelBreakdownItemDto"][];
+            totals: {
+                spendCents: number;
+                tokenCount: number;
+            };
+            /** Format: date-time */
+            generatedAt: string;
+        };
         AiToolMemberSummaryDto: {
             externalId: string;
             email: string;
@@ -3588,6 +3739,10 @@ export interface components {
             tokenCount: number;
             activeDays: number;
             mostUsedModel?: string;
+            /** @description Per-product spend in cents for the requested window (Claude Enterprise). Omitted when no product-level daily rows exist for the member. */
+            productBreakdownCents?: {
+                [key: string]: number;
+            };
         };
         AiToolMembersListDto: {
             members: components["schemas"]["AiToolMemberSummaryDto"][];
@@ -5477,6 +5632,13 @@ export type AiUsageSpendUsageTrendsProviderWeekDto = components['schemas']['AiUs
 export type AiUsageSpendUsageTrendsDayDto = components['schemas']['AiUsageSpendUsageTrendsDayDto'];
 export type AiUsageSpendUsageTrendsWeekDto = components['schemas']['AiUsageSpendUsageTrendsWeekDto'];
 export type AiUsageSpendUsageTrendsDto = components['schemas']['AiUsageSpendUsageTrendsDto'];
+export type AiToolProviderSummaryWeekBucketDto = components['schemas']['AiToolProviderSummaryWeekBucketDto'];
+export type AiToolProviderSummaryTopMoverDto = components['schemas']['AiToolProviderSummaryTopMoverDto'];
+export type AiToolProviderSummaryDto = components['schemas']['AiToolProviderSummaryDto'];
+export type AiToolDailySeriesPointDto = components['schemas']['AiToolDailySeriesPointDto'];
+export type AiToolDailySeriesDto = components['schemas']['AiToolDailySeriesDto'];
+export type AiToolModelBreakdownItemDto = components['schemas']['AiToolModelBreakdownItemDto'];
+export type AiToolModelBreakdownDto = components['schemas']['AiToolModelBreakdownDto'];
 export type AiToolMemberSummaryDto = components['schemas']['AiToolMemberSummaryDto'];
 export type AiToolMembersListDto = components['schemas']['AiToolMembersListDto'];
 export type AiToolTeamSummaryDto = components['schemas']['AiToolTeamSummaryDto'];
@@ -7808,8 +7970,10 @@ export interface operations {
                 windowEnd?: string;
                 /** @description When set, aggregate engagement metrics for a single AI-tool member (user detail pages). Mutually exclusive with `scopeTeamId`. */
                 memberExternalId?: string;
-                /** @description Org-chart team id — aggregate engagement for members mapped to that team (team detail pages). Mutually exclusive with `memberExternalId`. */
+                /** @description Org-chart team id — aggregate engagement for members mapped to that team (team detail pages). Mutually exclusive with `memberExternalId` and `scopeExternalIds`. */
                 scopeTeamId?: string;
+                /** @description Comma-separated AI-tool member external IDs — aggregate engagement for exactly those seats (team detail when scoped via slim reads). Mutually exclusive with `memberExternalId` and `scopeTeamId`. */
+                scopeExternalIds?: string;
                 /** @description Optional provider id filter (`cursor`, `claude`) for detail pages. */
                 provider?: "cursor" | "claude";
             };
@@ -8081,6 +8245,10 @@ export interface operations {
         parameters: {
             query?: {
                 rangeId?: "4w" | "8w" | "q";
+                /** @description Inclusive start day (YYYY-MM-DD). When set with `to`, overrides `rangeId` calendar buckets for the aggregation window. */
+                from?: string;
+                /** @description Inclusive end day (YYYY-MM-DD). Requires `from`. */
+                to?: string;
                 windowEnd?: string;
                 page?: number;
                 pageSize?: number;
@@ -8133,6 +8301,10 @@ export interface operations {
         parameters: {
             query?: {
                 rangeId?: "4w" | "8w" | "q";
+                /** @description Inclusive start day (YYYY-MM-DD). When set with `to`, overrides `rangeId`. */
+                from?: string;
+                /** @description Inclusive end day (YYYY-MM-DD). Requires `from`. */
+                to?: string;
                 windowEnd?: string;
             };
             header?: never;
@@ -8180,6 +8352,10 @@ export interface operations {
         parameters: {
             query?: {
                 rangeId?: "4w" | "8w" | "q";
+                /** @description Inclusive start day (YYYY-MM-DD). When set with `to`, overrides `rangeId`. */
+                from?: string;
+                /** @description Inclusive end day (YYYY-MM-DD). Requires `from`. */
+                to?: string;
                 windowEnd?: string;
             };
             header?: never;
@@ -8783,6 +8959,130 @@ export interface operations {
             403: components["responses"]["Forbidden"];
         };
     };
+    getWorkspaceAiToolProviderSummary: {
+        parameters: {
+            query: {
+                from: string;
+                to: string;
+            };
+            header?: never;
+            path: {
+                workspaceId: components["parameters"]["WorkspaceId"];
+                provider: "cursor" | "claude";
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Provider summary */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["AiToolProviderSummaryDto"];
+                };
+            };
+            /** @description Invalid query */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        /** @example invalid_query */
+                        error: string;
+                    };
+                };
+            };
+            401: components["responses"]["Unauthorized"];
+            403: components["responses"]["Forbidden"];
+        };
+    };
+    getWorkspaceAiToolProviderDailySeries: {
+        parameters: {
+            query: {
+                from: string;
+                to: string;
+                /** @description Optional member external IDs. When set, the series includes only those members (team drill-down, user detail). Repeat the parameter or pass comma-separated values. */
+                externalId?: string[];
+            };
+            header?: never;
+            path: {
+                workspaceId: components["parameters"]["WorkspaceId"];
+                provider: "cursor" | "claude";
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Daily series */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["AiToolDailySeriesDto"];
+                };
+            };
+            /** @description Invalid query */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        /** @example invalid_query */
+                        error: string;
+                    };
+                };
+            };
+            401: components["responses"]["Unauthorized"];
+            403: components["responses"]["Forbidden"];
+        };
+    };
+    getWorkspaceAiToolProviderModelBreakdown: {
+        parameters: {
+            query: {
+                from: string;
+                to: string;
+                /** @description Optional member external IDs to scope the rollup (org/team filter). */
+                externalId?: string[];
+            };
+            header?: never;
+            path: {
+                workspaceId: components["parameters"]["WorkspaceId"];
+                provider: "cursor" | "claude";
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Model breakdown */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["AiToolModelBreakdownDto"];
+                };
+            };
+            /** @description Invalid query */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        /** @example invalid_query */
+                        error: string;
+                    };
+                };
+            };
+            401: components["responses"]["Unauthorized"];
+            403: components["responses"]["Forbidden"];
+        };
+    };
     getWorkspaceAiToolRefreshStatus: {
         parameters: {
             query?: never;

package/src/index.ts

@@ -1254,6 +1254,85 @@ export interface HrisTriggerSyncResultDto {
   providers?: HrisProviderSyncResultDto[];
 }
 
+/** Weekly bucket in GET .../integrations/ai-tool/:provider/summary */
+export interface AiToolProviderSummaryWeekBucketDto {
+  weekLabel: string;
+  spendCents: number;
+  tokenCount: number;
+  activeUsers: number;
+}
+
+/** Top spend mover between first and second half of the summary window. */
+export interface AiToolProviderSummaryTopMoverDto {
+  externalId: string;
+  label: string;
+  deltaSpendCents: number;
+  currentSpendCents: number;
+}
+
+/** Response for GET .../integrations/ai-tool/:provider/summary */
+export interface AiToolProviderSummaryDto {
+  provider: string;
+  from: string;
+  to: string;
+  status?: import("./generated/openapi.js").components["schemas"]["AiToolRefreshStatusDto"];
+  seatCounts: { total: number; active: number; removed: number };
+  totals: {
+    spendCents: number;
+    tokenCount: number;
+    activeUsers: number;
+    totalEngineers: number;
+  };
+  weekBuckets: AiToolProviderSummaryWeekBucketDto[];
+  topMovers?: AiToolProviderSummaryTopMoverDto[];
+  hasTokenMetrics?: boolean;
+  generatedAt: string;
+}
+
+/** One day in GET .../integrations/ai-tool/:provider/daily-series */
+export interface AiToolDailySeriesPointDto {
+  day: string;
+  label: string;
+  spendCents: number;
+  tokenCount: number;
+  products: Record<string, number>;
+  models: Record<string, number>;
+}
+
+/** Response for GET .../integrations/ai-tool/:provider/daily-series */
+export interface AiToolDailySeriesDto {
+  provider: string;
+  from: string;
+  to: string;
+  points: AiToolDailySeriesPointDto[];
+  productKeys: string[];
+  modelKeys: string[];
+  totals: { spendCents: number; tokenCount: number };
+  hasProductBreakdown?: boolean;
+  hasModelBreakdown?: boolean;
+  hasSpend?: boolean;
+  hasTokens?: boolean;
+  generatedAt: string;
+}
+
+/** One model row in GET .../integrations/ai-tool/:provider/model-breakdown */
+export interface AiToolModelBreakdownItemDto {
+  modelName: string;
+  spendCents: number;
+  tokenCount: number;
+  activeUsers: number;
+}
+
+/** Response for GET .../integrations/ai-tool/:provider/model-breakdown */
+export interface AiToolModelBreakdownDto {
+  provider: string;
+  from: string;
+  to: string;
+  models: AiToolModelBreakdownItemDto[];
+  totals: { spendCents: number; tokenCount: number };
+  generatedAt: string;
+}
+
 /** Single AI-tool seat with usage totals for a time range. */
 export interface AiToolMemberSummaryDto {
   externalId: string;
@@ -1264,6 +1343,8 @@ export interface AiToolMemberSummaryDto {
   tokenCount: number;
   activeDays: number;
   mostUsedModel?: string;
+  /** Per-product spend in cents for the window (Claude Enterprise). */
+  productBreakdownCents?: Record<string, number>;
 }
 
 /** Paginated response for GET .../integrations/ai-tool/:provider/members */