@thinkai/tai-api-contract 2.162.0 → 2.163.0

package/openapi/openapi.yaml

@@ -1,7 +1,7 @@
 openapi: 3.0.3
 info:
   title: ThinkAI API
-  version: 2.162.0
+  version: 2.163.0
   description: >
     Contract surface for the AI Driven SDLC backend used by ThinkAI.
     Workspace-scoped routes use `/workspaces/{workspaceId}/...`.
@@ -6423,6 +6423,91 @@ paths:
               schema:
                 $ref: "#/components/schemas/ErrorMessageDto"
 
+  /workspaces/{workspaceId}/aggregate-use-consent:
+    get:
+      tags: [Workspace]
+      summary: Read anonymized aggregate-use permission
+      operationId: getAggregateUseConsent
+      description: >
+        Returns whether ThinkAI may use this workspace's anonymized aggregate results in
+        marketing and peer benchmarks. A workspace that never chose returns `unset`, which
+        behaves as opted out (`effective: false`). The permission never covers company name,
+        logo, quote, raw report, repository or person identity, or customer reference.
+        Any workspace member may read it.
+      parameters:
+        - $ref: "#/components/parameters/WorkspaceId"
+      responses:
+        "200":
+          description: Current permission and the sentence reports must print
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/AggregateUseConsentDto"
+        "401":
+          $ref: "#/components/responses/Unauthorized"
+        "403":
+          $ref: "#/components/responses/Forbidden"
+        "404":
+          description: Workspace does not exist
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorMessageDto"
+    put:
+      tags: [Workspace]
+      summary: Set anonymized aggregate-use permission
+      operationId: putAggregateUseConsent
+      description: >
+        Workspace admins opt in or out. Every change writes one
+        `workspace.aggregate_use.changed` activity-log row in the same transaction.
+        Moving from `opt_in` to `opt_out` records a withdrawal and stops future extraction.
+        Opt-in requires the current legal-approved notice version; while no notice is
+        approved, opt-in returns `409 aggregate_use_notice_unapproved`. Opt-out is always
+        accepted. A refusal does not change price, delivery, support, or assessment output.
+      parameters:
+        - $ref: "#/components/parameters/WorkspaceId"
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/AggregateUseConsentPutDto"
+      responses:
+        "200":
+          description: Saved permission
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/AggregateUseConsentDto"
+        "400":
+          description: "Invalid body (`code`: `invalid_input`)"
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorMessageDto"
+        "401":
+          $ref: "#/components/responses/Unauthorized"
+        "403":
+          description: "Caller is not a workspace admin (`code`: `workspace_admin_required`)"
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorMessageDto"
+        "404":
+          description: Workspace does not exist
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorMessageDto"
+        "409":
+          description: >
+            Opt-in refused because no notice is approved (`aggregate_use_notice_unapproved`)
+            or the submitted notice version is not current (`aggregate_use_notice_stale`).
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorMessageDto"
+
   /workspaces/{workspaceId}/report-center/exports:
     post:
       tags: [WorkspaceActivity]
@@ -6500,7 +6585,7 @@ paths:
           required: false
           description: >
             Coarse product-area grouping filter (#156). `integration` = GitHub + AI-tool key events;
-            `agentic_foundation` = repos, readiness scans, fixes; `workspace_team` = members + HRIS + report exports;
+            `agentic_foundation` = repos, readiness scans, fixes; `workspace_team` = members + HRIS + report exports + workspace settings;
             `productivity` = productivity ingest lifecycle events. Omit (or pass `all`) for every area.
           schema:
             type: string
@@ -20593,6 +20678,7 @@ components:
         - integrations.zelt.added
         - integrations.zelt.removed
         - report.exported
+        - workspace.aggregate_use.changed
 
     UnsetAssessmentDecisionDto:
       type: object
@@ -20603,6 +20689,94 @@ components:
           type: string
           enum: [unset]
 
+    AggregateUseNoticeStatusDto:
+      type: object
+      additionalProperties: false
+      required: [status]
+      description: Current legal-approved opt-in notice, or `unset` while opt-in is unavailable.
+      properties:
+        status:
+          type: string
+          enum: [approved, unset]
+        version:
+          type: string
+          description: Present only when `status` is `approved`. Send it back on opt-in.
+
+    AggregateUseConsentDto:
+      type: object
+      additionalProperties: false
+      required:
+        - aggregateUse
+        - effective
+        - noticeVersion
+        - source
+        - recordedAt
+        - recordedBy
+        - withdrawnAt
+        - currentNotice
+        - reportSentence
+      properties:
+        aggregateUse:
+          type: string
+          enum: [opt_in, opt_out, unset]
+          description: Saved choice. `unset` means the workspace never chose and is treated as opted out.
+        effective:
+          type: boolean
+          description: True only for `opt_in`. Benchmark and marketing extraction must check this.
+        noticeVersion:
+          type: string
+          nullable: true
+          description: Notice version accepted with the current opt-in; null otherwise.
+        source:
+          type: string
+          nullable: true
+          enum: [workspace_settings]
+        recordedAt:
+          type: string
+          format: date-time
+          nullable: true
+          description: When the current choice was saved; null when `unset`.
+        recordedBy:
+          type: object
+          nullable: true
+          additionalProperties: false
+          required: [userId, displayName]
+          properties:
+            userId:
+              type: string
+              format: uuid
+            displayName:
+              type: string
+              nullable: true
+        withdrawnAt:
+          type: string
+          format: date-time
+          nullable: true
+          description: Most recent opt-in withdrawal while the workspace remains opted out.
+        currentNotice:
+          $ref: "#/components/schemas/AggregateUseNoticeStatusDto"
+        reportSentence:
+          type: string
+          nullable: true
+          description: >
+            Exact sentence the assessment PDF prints beside `recordedAt`. Opted-out and unset
+            workspaces get the fixed refusal sentence. Opt-in returns the approved sentence for
+            the accepted notice, or null if that notice is unknown, which blocks validation.
+
+    AggregateUseConsentPutDto:
+      type: object
+      additionalProperties: false
+      required: [aggregateUse]
+      properties:
+        aggregateUse:
+          type: string
+          enum: [opt_in, opt_out]
+        noticeVersion:
+          type: string
+          nullable: true
+          minLength: 1
+          description: Required for `opt_in` and must equal `currentNotice.version`. Ignored for `opt_out`.
+
     AssessmentDictionaryDto:
       type: object
       additionalProperties: false

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thinkai/tai-api-contract",
-  "version": "2.162.0",
+  "version": "2.163.0",
   "private": false,
   "type": "module",
   "main": "dist/index.js",

package/src/generated/openapi.ts

@@ -2420,6 +2420,30 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/workspaces/{workspaceId}/aggregate-use-consent": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Read anonymized aggregate-use permission
+         * @description Returns whether ThinkAI may use this workspace's anonymized aggregate results in marketing and peer benchmarks. A workspace that never chose returns `unset`, which behaves as opted out (`effective: false`). The permission never covers company name, logo, quote, raw report, repository or person identity, or customer reference. Any workspace member may read it.
+         */
+        get: operations["getAggregateUseConsent"];
+        /**
+         * Set anonymized aggregate-use permission
+         * @description Workspace admins opt in or out. Every change writes one `workspace.aggregate_use.changed` activity-log row in the same transaction. Moving from `opt_in` to `opt_out` records a withdrawal and stops future extraction. Opt-in requires the current legal-approved notice version; while no notice is approved, opt-in returns `409 aggregate_use_notice_unapproved`. Opt-out is always accepted. A refusal does not change price, delivery, support, or assessment output.
+         */
+        put: operations["putAggregateUseConsent"];
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/workspaces/{workspaceId}/report-center/exports": {
         parameters: {
             query?: never;
@@ -8725,11 +8749,55 @@ export interface components {
          * @description Type of workspace lifecycle event.
          * @enum {string}
          */
-        ActivityLogEventTypeDto: "repo.added" | "repo.removed" | "repo.readded" | "integration.github.added" | "integration.github.updated" | "integration.github.removed" | "integration.github.permissions_changed" | "integration.github.repo_added" | "integration.github.repo_removed" | "fix.requested" | "fix.generating" | "fix.pr_created" | "fix.merged" | "fix.failed" | "readiness.scan_started" | "readiness.scan_completed" | "readiness.scan_failed" | "readiness.scan_partial" | "code_insights.design_run_started" | "integrations.agent_execution.provider_changed" | "integrations.repo_eligibility.overrides_changed" | "integrations.repo_eligibility.languages_refresh_requested" | "integrations.cursor.platform_key_enabled" | "integrations.cursor.platform_key_disabled" | "member.invited" | "member.invite_accepted" | "member.invite_rejected" | "member.role_changed" | "member.removed" | "hris.personio.sync_started" | "hris.personio.sync_completed" | "hris.personio.sync_failed" | "hris.zenhr.sync_started" | "hris.zenhr.sync_completed" | "hris.zenhr.sync_failed" | "hris.zelt.sync_started" | "hris.zelt.sync_completed" | "hris.zelt.sync_failed" | "hris.hibob.sync_started" | "hris.hibob.sync_completed" | "hris.hibob.sync_failed" | "hris.sync_started" | "hris.sync_completed" | "hris.sync_failed" | "repo.sync_skipped" | "integrations.cursor.execution_key.added" | "integrations.cursor.execution_key.updated" | "integrations.cursor.execution_key.removed" | "integrations.cursor.execution_key.check_failed" | "integrations.cursor.admin_key.added" | "integrations.cursor.admin_key.updated" | "integrations.cursor.admin_key.removed" | "integrations.claude.execution_key.added" | "integrations.claude.execution_key.updated" | "integrations.claude.execution_key.removed" | "integrations.claude.execution_key.check_failed" | "integrations.claude.admin_key.added" | "integrations.claude.admin_key.updated" | "integrations.claude.admin_key.removed" | "integrations.claude.analytics_key.added" | "integrations.claude.analytics_key.updated" | "integrations.claude.analytics_key.removed" | "integrations.code_intelligence.settings_changed" | "integrations.code_intelligence.execution_key.added" | "integrations.code_intelligence.execution_key.updated" | "integrations.code_intelligence.execution_key.removed" | "integrations.code_intelligence.execution_key.check_failed" | "readiness.scan_precheck_failed" | "productivity.ingest.completed" | "productivity.ingest.failed" | "productivity.ingest.skipped" | "productivity.ingest.repo_skipped" | "productivity.ingest.coverage_gap_detected" | "integrations.newrelic.added" | "integrations.newrelic.removed" | "integrations.newrelic.sync_completed" | "integrations.newrelic.sync_failed" | "integrations.prometheus.added" | "integrations.prometheus.removed" | "integrations.prometheus.sync_completed" | "integrations.prometheus.sync_failed" | "integrations.grafana.added" | "integrations.grafana.removed" | "integrations.grafana.sync_completed" | "integrations.grafana.sync_failed" | "integrations.zelt.added" | "integrations.zelt.removed" | "report.exported";
+        ActivityLogEventTypeDto: "repo.added" | "repo.removed" | "repo.readded" | "integration.github.added" | "integration.github.updated" | "integration.github.removed" | "integration.github.permissions_changed" | "integration.github.repo_added" | "integration.github.repo_removed" | "fix.requested" | "fix.generating" | "fix.pr_created" | "fix.merged" | "fix.failed" | "readiness.scan_started" | "readiness.scan_completed" | "readiness.scan_failed" | "readiness.scan_partial" | "code_insights.design_run_started" | "integrations.agent_execution.provider_changed" | "integrations.repo_eligibility.overrides_changed" | "integrations.repo_eligibility.languages_refresh_requested" | "integrations.cursor.platform_key_enabled" | "integrations.cursor.platform_key_disabled" | "member.invited" | "member.invite_accepted" | "member.invite_rejected" | "member.role_changed" | "member.removed" | "hris.personio.sync_started" | "hris.personio.sync_completed" | "hris.personio.sync_failed" | "hris.zenhr.sync_started" | "hris.zenhr.sync_completed" | "hris.zenhr.sync_failed" | "hris.zelt.sync_started" | "hris.zelt.sync_completed" | "hris.zelt.sync_failed" | "hris.hibob.sync_started" | "hris.hibob.sync_completed" | "hris.hibob.sync_failed" | "hris.sync_started" | "hris.sync_completed" | "hris.sync_failed" | "repo.sync_skipped" | "integrations.cursor.execution_key.added" | "integrations.cursor.execution_key.updated" | "integrations.cursor.execution_key.removed" | "integrations.cursor.execution_key.check_failed" | "integrations.cursor.admin_key.added" | "integrations.cursor.admin_key.updated" | "integrations.cursor.admin_key.removed" | "integrations.claude.execution_key.added" | "integrations.claude.execution_key.updated" | "integrations.claude.execution_key.removed" | "integrations.claude.execution_key.check_failed" | "integrations.claude.admin_key.added" | "integrations.claude.admin_key.updated" | "integrations.claude.admin_key.removed" | "integrations.claude.analytics_key.added" | "integrations.claude.analytics_key.updated" | "integrations.claude.analytics_key.removed" | "integrations.code_intelligence.settings_changed" | "integrations.code_intelligence.execution_key.added" | "integrations.code_intelligence.execution_key.updated" | "integrations.code_intelligence.execution_key.removed" | "integrations.code_intelligence.execution_key.check_failed" | "readiness.scan_precheck_failed" | "productivity.ingest.completed" | "productivity.ingest.failed" | "productivity.ingest.skipped" | "productivity.ingest.repo_skipped" | "productivity.ingest.coverage_gap_detected" | "integrations.newrelic.added" | "integrations.newrelic.removed" | "integrations.newrelic.sync_completed" | "integrations.newrelic.sync_failed" | "integrations.prometheus.added" | "integrations.prometheus.removed" | "integrations.prometheus.sync_completed" | "integrations.prometheus.sync_failed" | "integrations.grafana.added" | "integrations.grafana.removed" | "integrations.grafana.sync_completed" | "integrations.grafana.sync_failed" | "integrations.zelt.added" | "integrations.zelt.removed" | "report.exported" | "workspace.aggregate_use.changed";
         UnsetAssessmentDecisionDto: {
             /** @enum {string} */
             status: "unset";
         };
+        /** @description Current legal-approved opt-in notice, or `unset` while opt-in is unavailable. */
+        AggregateUseNoticeStatusDto: {
+            /** @enum {string} */
+            status: "approved" | "unset";
+            /** @description Present only when `status` is `approved`. Send it back on opt-in. */
+            version?: string;
+        };
+        AggregateUseConsentDto: {
+            /**
+             * @description Saved choice. `unset` means the workspace never chose and is treated as opted out.
+             * @enum {string}
+             */
+            aggregateUse: "opt_in" | "opt_out" | "unset";
+            /** @description True only for `opt_in`. Benchmark and marketing extraction must check this. */
+            effective: boolean;
+            /** @description Notice version accepted with the current opt-in; null otherwise. */
+            noticeVersion: string | null;
+            /** @enum {string|null} */
+            source: "workspace_settings" | null;
+            /**
+             * Format: date-time
+             * @description When the current choice was saved; null when `unset`.
+             */
+            recordedAt: string | null;
+            recordedBy: {
+                /** Format: uuid */
+                userId: string;
+                displayName: string | null;
+            } | null;
+            /**
+             * Format: date-time
+             * @description Most recent opt-in withdrawal while the workspace remains opted out.
+             */
+            withdrawnAt: string | null;
+            currentNotice: components["schemas"]["AggregateUseNoticeStatusDto"];
+            /** @description Exact sentence the assessment PDF prints beside `recordedAt`. Opted-out and unset workspaces get the fixed refusal sentence. Opt-in returns the approved sentence for the accepted notice, or null if that notice is unknown, which blocks validation. */
+            reportSentence: string | null;
+        };
+        AggregateUseConsentPutDto: {
+            /** @enum {string} */
+            aggregateUse: "opt_in" | "opt_out";
+            /** @description Required for `opt_in` and must equal `currentNotice.version`. Ignored for `opt_out`. */
+            noticeVersion?: string | null;
+        };
         AssessmentDictionaryDto: {
             /** @enum {string} */
             version: "2026-10-18.1";
@@ -11324,6 +11392,9 @@ export type PutAgenticFoundationRepoScopeFailureDto = components['schemas']['Put
 export type PutAgenticFoundationRepoScopeResponseDto = components['schemas']['PutAgenticFoundationRepoScopeResponseDto'];
 export type ActivityLogEventTypeDto = components['schemas']['ActivityLogEventTypeDto'];
 export type UnsetAssessmentDecisionDto = components['schemas']['UnsetAssessmentDecisionDto'];
+export type AggregateUseNoticeStatusDto = components['schemas']['AggregateUseNoticeStatusDto'];
+export type AggregateUseConsentDto = components['schemas']['AggregateUseConsentDto'];
+export type AggregateUseConsentPutDto = components['schemas']['AggregateUseConsentPutDto'];
 export type AssessmentDictionaryDto = components['schemas']['AssessmentDictionaryDto'];
 export type ReportCenterExportRecordBodyDto = components['schemas']['ReportCenterExportRecordBodyDto'];
 export type ReportCenterExportRecordResponseDto = components['schemas']['ReportCenterExportRecordResponseDto'];
@@ -17984,6 +18055,102 @@ export interface operations {
             };
         };
     };
+    getAggregateUseConsent: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                workspaceId: components["parameters"]["WorkspaceId"];
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Current permission and the sentence reports must print */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["AggregateUseConsentDto"];
+                };
+            };
+            401: components["responses"]["Unauthorized"];
+            403: components["responses"]["Forbidden"];
+            /** @description Workspace does not exist */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ErrorMessageDto"];
+                };
+            };
+        };
+    };
+    putAggregateUseConsent: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                workspaceId: components["parameters"]["WorkspaceId"];
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["AggregateUseConsentPutDto"];
+            };
+        };
+        responses: {
+            /** @description Saved permission */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["AggregateUseConsentDto"];
+                };
+            };
+            /** @description Invalid body (`code`: `invalid_input`) */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ErrorMessageDto"];
+                };
+            };
+            401: components["responses"]["Unauthorized"];
+            /** @description Caller is not a workspace admin (`code`: `workspace_admin_required`) */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ErrorMessageDto"];
+                };
+            };
+            /** @description Workspace does not exist */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ErrorMessageDto"];
+                };
+            };
+            /** @description Opt-in refused because no notice is approved (`aggregate_use_notice_unapproved`) or the submitted notice version is not current (`aggregate_use_notice_stale`). */
+            409: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ErrorMessageDto"];
+                };
+            };
+        };
+    };
     recordReportCenterExport: {
         parameters: {
             query?: never;
@@ -18050,7 +18217,7 @@ export interface operations {
                 order?: components["parameters"]["PaginationOrder"];
                 /** @description Server-side sort column (the activity "5 W's"). Combined with `order` (asc/desc). Defaults to `when` (occurredAt). `occurredAt`/`id` is always the tiebreaker. */
                 sort?: "when" | "who" | "what" | "why" | "where";
-                /** @description Coarse product-area grouping filter (#156). `integration` = GitHub + AI-tool key events; `agentic_foundation` = repos, readiness scans, fixes; `workspace_team` = members + HRIS + report exports; `productivity` = productivity ingest lifecycle events. Omit (or pass `all`) for every area. */
+                /** @description Coarse product-area grouping filter (#156). `integration` = GitHub + AI-tool key events; `agentic_foundation` = repos, readiness scans, fixes; `workspace_team` = members + HRIS + report exports + workspace settings; `productivity` = productivity ingest lifecycle events. Omit (or pass `all`) for every area. */
                 productArea?: "integration" | "agentic_foundation" | "workspace_team" | "productivity" | "all";
                 /** @description Filter to a specific event type. */
                 eventType?: components["schemas"]["ActivityLogEventTypeDto"];