@smartspace/api-client 0.1.0-pr.976.50e1dfd → 0.1.0-pr.976.ba8c32f

package/dist/generated/config/models/blocksStateInterface.d.ts

@@ -7,6 +7,10 @@
 import type { BlocksStateInterfaceDefault } from './blocksStateInterfaceDefault';
 import type { BlocksStateInterfaceMetadata } from './blocksStateInterfaceMetadata';
 import type { FlowsBlockPinRef } from './flowsBlockPinRef';
+/**
+ * Model for a block `StateInterface` — a piece of state declared by a
+block interface, with a JSON default value and an optional pin-ref scope.
+ */
 export interface BlocksStateInterface {
     /** @nullable */
     default?: BlocksStateInterfaceDefault;

package/dist/generated/config/models/blocksUsedInWorkspaceRef.d.ts

@@ -4,6 +4,11 @@
  * SmartSpace Admin API
  * OpenAPI spec version: v1
  */
+/**
+ * A workspace that references one of the block set's blocks in its active
+flow definition. Carries the id so the UI can deep-link to the workspace
+designer (e.g. to detach a block before deleting its set).
+ */
 export interface BlocksUsedInWorkspaceRef {
     /** @pattern ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ */
     id: string;

package/dist/generated/config/models/connectorsConnector.d.ts

@@ -4,6 +4,13 @@
  * SmartSpace Admin API
  * OpenAPI spec version: v1
  */
+/**
+ * Admin read shape for a connector. Carries the auth SETTINGS (type, header,
+scheme) because an admin editing the connector needs to see them — but
+never the vault reference and never the value. Collides on the simple name
+with `SmartSpace.App.Data.Entities.Connector`; alias
+`DataEntities = SmartSpace.App.Data.Entities` in files importing both.
+ */
 export interface ConnectorsConnector {
     /** @nullable */
     authHeaderName?: string | null;

package/dist/generated/config/models/connectorsConnectorSummary.d.ts

@@ -4,6 +4,12 @@
  * SmartSpace Admin API
  * OpenAPI spec version: v1
  */
+/**
+ * The shape non-admins are allowed to see: enough to pick a connector from a
+dropdown, and nothing more. No URL (that is infrastructure detail) and no
+auth settings. Used by the workspace MCP tab's picker and embedded in the
+workspace detail response so the flow editor can list what is attached.
+ */
 export interface ConnectorsConnectorSummary {
     /** @pattern ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ */
     id: string;

package/dist/generated/config/models/connectorsCreateConnector.d.ts

@@ -4,6 +4,11 @@
  * SmartSpace Admin API
  * OpenAPI spec version: v1
  */
+/**
+ * Create request. One form writes both rows: the connector (identity) and
+its single shared connection (credential). `Secret` is write-only —
+it goes straight to Key Vault and is never returned by any admin endpoint.
+ */
 export interface ConnectorsCreateConnector {
     /** @nullable */
     authHeaderName?: string | null;

package/dist/generated/config/models/connectorsResolvedConnector.d.ts

@@ -5,6 +5,15 @@
  * OpenAPI spec version: v1
  */
 import type { ConnectorsResolvedConnectorHeaders } from './connectorsResolvedConnectorHeaders';
+/**
+ * The ONLY shape that carries a usable credential out of the service layer.
+Returned exclusively by `IConnectorService.ResolveAsync`, which backs
+the machine-only resolve endpoint (ssaikey-authenticated AI runtime).
+            
+SmartSpace.App.Business.Models.Connectors.ResolvedConnector.Headers is already composed — the caller attaches them
+verbatim and never sees the raw secret, the header name or the scheme as
+separate facts it has to reassemble.
+ */
 export interface ConnectorsResolvedConnector {
     headers: ConnectorsResolvedConnectorHeaders;
     url: string;

package/dist/generated/config/models/connectorsUpdateConnector.d.ts

@@ -4,6 +4,15 @@
  * SmartSpace Admin API
  * OpenAPI spec version: v1
  */
+/**
+ * Update request. `Kind` is absent on purpose — changing what a
+connector IS would invalidate every flow referencing it; delete and
+recreate instead.
+            
+`Secret` null means "leave the credential alone". A non-null value
+rotates it: a new version of the SAME vault secret, so the row's reference
+never changes and no orphan is left behind.
+ */
 export interface ConnectorsUpdateConnector {
     /** @nullable */
     authHeaderName?: string | null;

package/dist/generated/config/models/dataSetsCreateDataSet.d.ts

@@ -5,6 +5,12 @@
  * OpenAPI spec version: v1
  */
 import type { DataSetsCreateDataSetContainer } from './dataSetsCreateDataSetContainer';
+/**
+ * Create-request shape for a DataSet. The DataSpace it belongs to is
+carried on the route (`/DataSpaces/{id}/datasets`) rather than the
+body. Container info is optional — empty list means "file-only" dataset
+with a freshly-created file ingestion flow.
+ */
 export interface DataSetsCreateDataSet {
     /** @nullable */
     containerInfo?: DataSetsCreateDataSetContainer[] | null;

package/dist/generated/config/models/dataSetsCreateDataSetContainer.d.ts

@@ -5,6 +5,12 @@
  * OpenAPI spec version: v1
  */
 import type { DataSourcesContainerFilterModel } from './dataSourcesContainerFilterModel';
+/**
+ * Container reference used in create/update requests — pair of
+`DataSourceId` and a `Path` identifying a specific container
+inside that data source. The service hashes the pair to produce the
+container id. Optional Filters restrict which records are synced.
+ */
 export interface DataSetsCreateDataSetContainer {
     /** @pattern ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ */
     dataSourceId: string;

package/dist/generated/config/models/dataSetsDataSet.d.ts

@@ -6,6 +6,20 @@
  */
 import type { DataSetsDataSetProperty } from './dataSetsDataSetProperty';
 import type { EnumsDataSetScopingMode } from './enumsDataSetScopingMode';
+/**
+ * Model for a DataSet. Collides on the simple name with
+`SmartSpace.App.Data.Entities.DataSet`; alias
+`DataEntities = SmartSpace.App.Data.Entities` in files that import
+both.
+            
+The nested Flow shape on the legacy `SmartSpace.App.Business.Models.DataSet`
+is intentionally dropped here — `FlowId` only. The Flow domain
+hasn't migrated yet and projecting its recursive structure (Flow →
+Triggers → DataSourceContainer → DataSource, Flow → ActiveFlowDefinition
+→ Inputs) into the model layer would couple two unmigrated domains and
+bloat every DataSet read with multiple JOIN fan-outs. Callers that need
+Flow detail fetch it via `IFlowService`.
+ */
 export interface DataSetsDataSet {
     createdAt: string;
     createdByUserId: string;

package/dist/generated/config/models/dataSetsDataSetProperty.d.ts

@@ -4,6 +4,11 @@
  * SmartSpace Admin API
  * OpenAPI spec version: v1
  */
+/**
+ * Model for a property on a DataSet — a named, optionally-vectorised field
+stored on each ingested item. Read-only at the model boundary; writes go
+through SmartSpace.App.Business.Models.DataSets.UpsertDataSetProperty.
+ */
 export interface DataSetsDataSetProperty {
     /** @nullable */
     description?: string | null;

package/dist/generated/config/models/dataSetsSetDataSetScoping.d.ts

@@ -5,6 +5,12 @@
  * OpenAPI spec version: v1
  */
 import type { EnumsDataSetScopingMode } from './enumsDataSetScopingMode';
+/**
+ * Sets the per-document scoping config on a dataset (intelligence-layer
+`scoping` block). When `Mode` is `Unrestricted` the
+`SubjectPath` is cleared; when `PerSubject`, `SubjectPath`
+selects the document field to match (null = the built-in owner envelope).
+ */
 export interface DataSetsSetDataSetScoping {
     mode: EnumsDataSetScopingMode;
     /** @nullable */

package/dist/generated/config/models/dataSetsUpdateDataSet.d.ts

@@ -5,6 +5,12 @@
  * OpenAPI spec version: v1
  */
 import type { DataSetsCreateDataSetContainer } from './dataSetsCreateDataSetContainer';
+/**
+ * Update-request shape for a DataSet — name/description plus optional
+re-binding of containers. Container info null = leave the existing
+flow alone, just update basic fields; empty = disconnect every
+container (soft-deletes all flow triggers).
+ */
 export interface DataSetsUpdateDataSet {
     /** @nullable */
     containerInfo?: DataSetsCreateDataSetContainer[] | null;

package/dist/generated/config/models/dataSetsUpdateDataSetBasicInfo.d.ts

@@ -4,6 +4,10 @@
  * SmartSpace Admin API
  * OpenAPI spec version: v1
  */
+/**
+ * Lightweight update for just the editable basic-info fields. Used by the
+`PUT /DataSets/{id}/basicInfo` endpoint.
+ */
 export interface DataSetsUpdateDataSetBasicInfo {
     /** @nullable */
     description?: string | null;

package/dist/generated/config/models/dataSetsUpsertDataSetProperty.d.ts

@@ -4,10 +4,23 @@
  * SmartSpace Admin API
  * OpenAPI spec version: v1
  */
+/**
+ * Upsert payload for a single DataSet property. `Name` is the key —
+existing property with the same name is updated in place, otherwise a
+new one is added.
+ */
 export interface DataSetsUpsertDataSetProperty {
     /** @nullable */
     description?: string | null;
-    /** @nullable */
+    /**
+     * Unused — the platform no longer reads this field and
+              it has no effect on ingestion or querying. It is retained as an optional
+              property purely for backward compatibility (see the description of
+              `POST /DataSets/{id}/properties`); omit it in new integrations.
+              When omitted, the stored value is preserved on update and defaults to
+              `false` on create.
+     * @nullable
+     */
     isVector?: boolean | null;
     name: string;
 }

package/dist/generated/config/models/dataSourcesCreateDataSource.d.ts

@@ -6,6 +6,12 @@
  */
 import type { EnumsDataSourceCredentialType } from './enumsDataSourceCredentialType';
 import type { DataSourcesCreateDataSourceCredentials } from './dataSourcesCreateDataSourceCredentials';
+/**
+ * Create request shape — paired with SmartSpace.App.Business.Models.DataSources.UpdateDataSource even
+though field overlap is partial; the `[Required]` contract differs.
+Accepts inline credentials at creation time (listed under
+`ModelFolderSafetyTests.ExistingDebtToReview`).
+ */
 export interface DataSourcesCreateDataSource {
     credentialType: EnumsDataSourceCredentialType;
     credentials: DataSourcesCreateDataSourceCredentials;

package/dist/generated/config/models/dataSourcesDataSource.d.ts

@@ -6,6 +6,12 @@
  */
 import type { DataSourceContainer } from './dataSourceContainer';
 import type { EnumsDataSourceCredentialType } from './enumsDataSourceCredentialType';
+/**
+ * Full read shape for a DataSource. Collides on the simple name with
+`SmartSpace.App.Data.Entities.DataSource`; alias
+`DataEntities = SmartSpace.App.Data.Entities` in files that import
+both.
+ */
 export interface DataSourcesDataSource {
     containers: DataSourceContainer[];
     createdAt: string;

package/dist/generated/config/models/dataSourcesDataSourceAdminUser.d.ts

@@ -4,6 +4,12 @@
  * SmartSpace Admin API
  * OpenAPI spec version: v1
  */
+/**
+ * API response shape for "list admin users on a DataSource" — joins the
+junction SmartSpace.App.Business.Models.DataSources.DataSourceAdmin with the user-service principal
+to surface a display name. Composed in the service; not a Mapperly
+projection target (the join crosses an external service boundary).
+ */
 export interface DataSourcesDataSourceAdminUser {
     id: string;
     name: string;

package/dist/generated/config/models/dataSourcesDataSourceCredentialsDefinition.d.ts

@@ -6,6 +6,11 @@
  */
 import type { DataSourcesCredentialsCredentialsType } from './dataSourcesCredentialsCredentialsType';
 import type { DataSourcesDataSourceProperty } from './dataSourcesDataSourceProperty';
+/**
+ * Schema metadata describing the *shape* of credentials a connector type
+requires — not credential values. Exempted from
+`ModelFolderSafetyTests` via `LegitimateSchemaExceptions`.
+ */
 export interface DataSourcesDataSourceCredentialsDefinition {
     credentialsType: DataSourcesCredentialsCredentialsType;
     properties: DataSourcesDataSourceProperty[];

package/dist/generated/config/models/dataSourcesTestDataSourceConnection.d.ts

@@ -5,6 +5,13 @@
  * OpenAPI spec version: v1
  */
 import type { DataSourcesTestDataSourceConnectionCredentials } from './dataSourcesTestDataSourceConnectionCredentials';
+/**
+ * Request shape for the test-connection endpoint and an internal carrier
+for the data-source-type service when probing credentials. Contains an
+inline credentials dictionary — listed under
+`ModelFolderSafetyTests.ExistingDebtToReview`; redesign to a
+KeyVault-ref-only payload is tracked in TODO.md.
+ */
 export interface DataSourcesTestDataSourceConnection {
     credentials: DataSourcesTestDataSourceConnectionCredentials;
     dataSourceTypeId: string;

package/dist/generated/config/models/dataSourcesUpdateDataSourceCredentials.d.ts

@@ -5,6 +5,12 @@
  * OpenAPI spec version: v1
  */
 import type { DataSourcesUpdateDataSourceCredentialsCredentials } from './dataSourcesUpdateDataSourceCredentialsCredentials';
+/**
+ * Partial-update payload for connector credentials — only non-empty
+values overwrite the existing entries (see
+`DataSourceService.UpdateCredentialsAsync`). Listed under
+`ModelFolderSafetyTests.ExistingDebtToReview`.
+ */
 export interface DataSourcesUpdateDataSourceCredentials {
     credentials: DataSourcesUpdateDataSourceCredentialsCredentials;
 }

package/dist/generated/config/models/dataSpacesCreateDataSpace.d.ts

@@ -4,6 +4,11 @@
  * SmartSpace Admin API
  * OpenAPI spec version: v1
  */
+/**
+ * Create-request shape for a DataSpace. `DataSetIds` is an optional
+pre-attachment of existing datasets to the new dataspace; the creating
+principal is implicitly added as the first admin.
+ */
 export interface DataSpacesCreateDataSpace {
     /** @nullable */
     dataSetIds?: string[] | null;

package/dist/generated/config/models/dataSpacesDataSpace.d.ts

@@ -6,6 +6,15 @@
  */
 import type { DataSetsDataSet } from './dataSetsDataSet';
 import type { DataSpacesDataSpaceWorkSpaceRef } from './dataSpacesDataSpaceWorkSpaceRef';
+/**
+ * Model for a DataSpace. Collides on the simple name with
+`SmartSpace.App.Data.Entities.DataSpace`; alias
+`DataEntities = SmartSpace.App.Data.Entities` in files that import
+both. The fully-qualified `DataSets.DataSet` below also
+disambiguates from the legacy unmigrated `Business.Models.DataSet`
+— implicit name resolution prefers the ancestor namespace and would
+otherwise pick up the legacy record.
+ */
 export interface DataSpacesDataSpace {
     createdAt: string;
     createdByUserId: string;

package/dist/generated/config/models/dataSpacesDataSpaceAdmin.d.ts

@@ -4,9 +4,21 @@
  * SmartSpace Admin API
  * OpenAPI spec version: v1
  */
+/**
+ * Model for a DataSpace admin junction record. The composite key is
+(UserId, DataSpaceId) — no surrogate id. Junction entities follow the
+delete+create convention, so there is no `UpdateDataSpaceAdmin`.
+            
+`DisplayName` is filled by the service via `IUserService`
+post-projection — it isn't on the entity and can't be projected, so it
+hangs off the record as an `init`-only property rather than a
+constructor parameter.
+ */
 export interface DataSpacesDataSpaceAdmin {
     /** @pattern ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ */
     dataSpaceId: string;
+    /** Display name resolved from `IUserService.GetPrincipalsByIdsAsync`
+  after projection. Empty string when the principal lookup misses. */
     displayName: string;
     userId: string;
 }

package/dist/generated/config/models/dataSpacesDataSpaceWorkSpaceRef.d.ts

@@ -4,6 +4,11 @@
  * SmartSpace Admin API
  * OpenAPI spec version: v1
  */
+/**
+ * Lightweight reference to a WorkSpace that uses this DataSpace. Avoids
+pulling the full WorkSpace shape (admins, flows, configurations) when a
+caller only needs to surface "what workspaces reference this DataSpace".
+ */
 export interface DataSpacesDataSpaceWorkSpaceRef {
     /** @pattern ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ */
     id: string;

package/dist/generated/config/models/dataSpacesUpdateDataSpace.d.ts

@@ -4,6 +4,12 @@
  * SmartSpace Admin API
  * OpenAPI spec version: v1
  */
+/**
+ * Update-request shape for a DataSpace — rename and re-bind the attached
+datasets. The complete `DataSetIds` list is treated as the desired
+state; datasets present today but missing here are unbound, new ones
+are bound in.
+ */
 export interface DataSpacesUpdateDataSpace {
     dataSetIds: string[];
     /** @pattern ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ */

package/dist/generated/config/models/draftsDraft.d.ts

@@ -5,6 +5,12 @@
  * OpenAPI spec version: v1
  */
 import type { DraftsDraftBlockInterfaces } from './draftsDraftBlockInterfaces';
+/**
+ * A browser-authored Draft Custom block — a `BlockSet` row with
+`IsDraft = true`, scoped to one user. See `ADR-0002` for the
+resolution rule that decides when the owner's draft wins over a published
+Custom at the same `(name, version)`.
+ */
 export interface DraftsDraft {
     blockInterfaces: DraftsDraftBlockInterfaces;
     isActive: boolean;

package/dist/generated/config/models/draftsPublishDraftRequest.d.ts

@@ -4,6 +4,11 @@
  * SmartSpace Admin API
  * OpenAPI spec version: v1
  */
+/**
+ * `ConfirmOverwrite` must be true to replace an already-published set of
+            the same name — the first attempt 409s with the impact details so the user
+            opts in deliberately (see the custom-block rework design, Phase 3).
+ */
 export interface DraftsPublishDraftRequest {
     confirmOverwrite: boolean;
     /** @nullable */

package/dist/generated/config/models/draftsSaveDraftRequest.d.ts

@@ -4,6 +4,11 @@
  * SmartSpace Admin API
  * OpenAPI spec version: v1
  */
+/**
+ * Save a draft's source. `ExpectedRowVersion` is the value the client last saw;
+the server returns 409 if the DB has moved on (eg. another tab). Null is allowed
+only for first-ever creation.
+ */
 export interface DraftsSaveDraftRequest {
     /** @nullable */
     expectedRowVersion?: string | null;

package/dist/generated/config/models/draftsSaveDraftResponse.d.ts

@@ -5,6 +5,11 @@
  * OpenAPI spec version: v1
  */
 import type { DraftsSaveDraftResponseBlockInterfaces } from './draftsSaveDraftResponseBlockInterfaces';
+/**
+ * Response after saving a draft. `ParseError` is non-null when the source
+failed to parse — the text is still persisted, but `BlockInterfaces` is
+empty until parse succeeds (matches the editor's live-preview semantics).
+ */
 export interface DraftsSaveDraftResponse {
     blockInterfaces: DraftsSaveDraftResponseBlockInterfaces;
     /** @nullable */

package/dist/generated/config/models/filesCreateFileFromBlobUri.d.ts

@@ -4,6 +4,12 @@
  * SmartSpace Admin API
  * OpenAPI spec version: v1
  */
+/**
+ * Request to register an existing blob (already uploaded to storage) as a
+SmartSpace.App.Business.Models.Files.File record bound to an optional flow run. Used by the
+SmartSpace AI ingestion pipeline to call back into the API once it has
+staged a file in blob storage.
+ */
 export interface FilesCreateFileFromBlobUri {
     blobUri: string;
     /**

package/dist/generated/config/models/filesFile.d.ts

@@ -4,6 +4,18 @@
  * SmartSpace Admin API
  * OpenAPI spec version: v1
  */
+/**
+ * Model for a stored file blob. The simple name collides with
+`System.IO.File` and `SmartSpace.App.Data.Entities.FileEntity`
+(which is itself named to side-step the BCL collision); the
+`SmartSpace.App.Business.Models.Files` namespace disambiguates. When
+importing both this model and the entity, alias the entity side:
+```using DataEntities = SmartSpace.App.Data.Entities;```
+`ThreadId` reflects the entity column `MessageThreadId`
+(renamed at the model boundary because the API contract has always called
+it `threadId`). `WorkspaceId` keeps the lower-s spelling that
+matches the entity column and is already on the wire.
+ */
 export interface FilesFile {
     createdAt: string;
     createdByUserId: string;

package/dist/generated/config/models/filesFileUriResponse.d.ts

@@ -4,6 +4,13 @@
  * SmartSpace Admin API
  * OpenAPI spec version: v1
  */
+/**
+ * Response shape for `GET /files/{id}/uri` on both the chat-api and
+config-api. Frontends call this with whatever URL the server hands them
+(e.g. as the `sourceUri` on a file MessageValue) and expect a JSON
+object — not a bare string — so the wire format stays extensible (we can
+add e.g. an expiry without breaking clients).
+ */
 export interface FilesFileUriResponse {
     uri: string;
 }

package/dist/generated/config/models/filesIngestedBlob.d.ts

@@ -6,6 +6,13 @@
  */
 import type { FilesFile } from './filesFile';
 import type { EnumsIngestionStatus } from './enumsIngestionStatus';
+/**
+ * Model for an ingested blob — pairs a stored SmartSpace.App.Business.Models.Files.IngestedBlob.File with its
+ingestion lifecycle (status, owning dataset, originating flow run).
+`CreatedByUserName` is filled in by the service post-projection
+(display-name lookup via `IUserService`); it is not part of the EF
+projection because it cannot be expression-tree-translated.
+ */
 export interface FilesIngestedBlob {
     /** @nullable */
     createdAt?: string | null;

package/dist/generated/config/models/managedSecretsCreateManagedSecret.d.ts

@@ -4,6 +4,13 @@
  * SmartSpace Admin API
  * OpenAPI spec version: v1
  */
+/**
+ * Create request shape. `Name` must match the token-safe pattern so it
+embeds cleanly in flow-definition secret tokens; the same rule is enforced
+as a business rule in `ManagedSecretService` (single source:
+`CreateManagedSecret.Pattern`). `Value` is write-only — it goes to
+Key Vault and is never returned by any admin endpoint.
+ */
 export interface ManagedSecretsCreateManagedSecret {
     name: string;
     value: string;

package/dist/generated/config/models/managedSecretsManagedSecret.d.ts

@@ -4,6 +4,14 @@
  * SmartSpace Admin API
  * OpenAPI spec version: v1
  */
+/**
+ * Read/list shape for a managed secret. Deliberately carries NO value property
+and NO vault reference — secret values are write-only through the admin
+surface and only ever leave via the machine-only resolve endpoint
+(SmartSpace.App.Business.Models.ManagedSecrets.ResolvedManagedSecret). Collides on the simple name with
+`SmartSpace.App.Data.Entities.ManagedSecret`; alias
+`DataEntities = SmartSpace.App.Data.Entities` in files that import both.
+ */
 export interface ManagedSecretsManagedSecret {
     createdAt: string;
     createdByUserId: string;

package/dist/generated/config/models/managedSecretsUpdateManagedSecretValue.d.ts

@@ -4,6 +4,10 @@
  * SmartSpace Admin API
  * OpenAPI spec version: v1
  */
+/**
+ * Overwrite-value request shape (rotation). Writes a new version of the same
+Key Vault secret — the row's vault reference is reused, never re-minted.
+ */
 export interface ManagedSecretsUpdateManagedSecretValue {
     value: string;
 }

package/dist/generated/config/models/notificationsNotification.d.ts

@@ -5,6 +5,15 @@
  * OpenAPI spec version: v1
  */
 import type { EnumsNotificationType } from './enumsNotificationType';
+/**
+ * Model for a Notification. Collides on the simple name with
+`SmartSpace.App.Data.Entities.Notification`; alias
+`DataEntities = SmartSpace.App.Data.Entities` in files that import
+both. `CreatedBy` (display name) sits outside the positional ctor
+because it can't be expression-tree-translated — the service hydrates it
+post-projection via `IUserService.GetPrincipalDisplayNameByIdAsync`
+and emits a `with { CreatedBy = ... }`.
+ */
 export interface NotificationsNotification {
     createdAt: string;
     /** @nullable */

package/dist/generated/config/models/notificationsPagedNotifications.d.ts

@@ -5,6 +5,10 @@
  * OpenAPI spec version: v1
  */
 import type { NotificationsNotification } from './notificationsNotification';
+/**
+ * Notification list response shape. Two counts so callers can render an
+"X unread of Y total" badge without a second round-trip.
+ */
 export interface NotificationsPagedNotifications {
     data: NotificationsNotification[];
     total: number;

package/dist/generated/config/models/syncsSyncQueueState.d.ts

@@ -4,6 +4,12 @@
  * SmartSpace Admin API
  * OpenAPI spec version: v1
  */
+/**
+ * Point-in-time view of the sync-requests queue: how many requests are
+waiting and which data sources they are for. Waiting only — a message
+being processed is invisible for its visibility timeout (that state is
+what IsSyncing covers).
+ */
 export interface SyncsSyncQueueState {
     depth: number;
     waitingDataSourceIds: string[];

package/dist/generated/config/models/syncsSyncRunInfo.d.ts

@@ -4,6 +4,11 @@
  * SmartSpace Admin API
  * OpenAPI spec version: v1
  */
+/**
+ * One sync = one configured data source container: the source selection
+(path + filters) the sync service pulls, with its high-water mark and the
+datasets subscribed to it via container flow triggers.
+ */
 export interface SyncsSyncRunInfo {
     end: string;
     itemCount: number;

package/dist/generated/config/models/usersAppAccessUser.d.ts

@@ -4,6 +4,11 @@
  * SmartSpace Admin API
  * OpenAPI spec version: v1
  */
+/**
+ * User model in the context of an access-grant picker — adds an
+`IsAssigned` flag for highlighting users who already have access to
+the target resource.
+ */
 export interface UsersAppAccessUser {
     displayName: string;
     /** @nullable */

package/dist/generated/config/models/usersAppRole.d.ts

@@ -4,6 +4,9 @@
  * SmartSpace Admin API
  * OpenAPI spec version: v1
  */
+/**
+ * Azure AD application-role model. Sourced from AAD; no local EF entity.
+ */
 export interface UsersAppRole {
     description: string;
     /** @pattern ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ */

package/dist/generated/config/models/usersAppUserDetail.d.ts

@@ -5,6 +5,11 @@
  * OpenAPI spec version: v1
  */
 import type { EnumsPermissions } from './enumsPermissions';
+/**
+ * Full per-user detail returned by the admin user-management endpoints.
+Joins the AAD principal with the local SmartSpace.App.Business.Models.Users.UserPermission
+junction state and last-activity timestamp.
+ */
 export interface UsersAppUserDetail {
     /** @nullable */
     emailAddress?: string | null;