@smartspace/api-client 0.1.0-pr.973.b9f6d9f → 0.1.0-pr.976.ba8c32f

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (101) hide show
  1. package/dist/generated/chat/api.d.ts +2 -0
  2. package/dist/generated/chat/api.js +10 -1
  3. package/dist/generated/chat/api.msw.d.ts +1 -0
  4. package/dist/generated/chat/api.msw.js +14 -2
  5. package/dist/generated/chat/models/accessAccess.d.ts +11 -0
  6. package/dist/generated/chat/models/aiIModelProperty.d.ts +6 -0
  7. package/dist/generated/chat/models/aiModel.d.ts +7 -0
  8. package/dist/generated/chat/models/aiModelSummary.d.ts +5 -0
  9. package/dist/generated/chat/models/commentComment.d.ts +9 -0
  10. package/dist/generated/chat/models/commentCreateComment.d.ts +7 -0
  11. package/dist/generated/chat/models/connectorsConnectorSummary.d.ts +6 -0
  12. package/dist/generated/chat/models/filesFile.d.ts +12 -0
  13. package/dist/generated/chat/models/filesFileUriResponse.d.ts +7 -0
  14. package/dist/generated/chat/models/mentionsMention.d.ts +7 -0
  15. package/dist/generated/chat/models/notificationsNotification.d.ts +9 -0
  16. package/dist/generated/chat/models/notificationsPagedNotifications.d.ts +4 -0
  17. package/dist/generated/chat/models/usersAppUser.d.ts +5 -0
  18. package/dist/generated/chat/models/workSpaceInfo.d.ts +6 -0
  19. package/dist/generated/chat/models/workSpacesWorkSpace.d.ts +9 -0
  20. package/dist/generated/chat/zod.d.ts +9 -0
  21. package/dist/generated/chat/zod.js +39 -30
  22. package/dist/generated/config/api.d.ts +3 -1
  23. package/dist/generated/config/api.js +19 -1
  24. package/dist/generated/config/api.msw.d.ts +3 -1
  25. package/dist/generated/config/api.msw.js +19 -5
  26. package/dist/generated/config/models/accessAccess.d.ts +11 -0
  27. package/dist/generated/config/models/accessAccessWorkSpace.d.ts +6 -0
  28. package/dist/generated/config/models/accessCreateAccess.d.ts +4 -0
  29. package/dist/generated/config/models/activitiesActivityWorkSpace.d.ts +8 -0
  30. package/dist/generated/config/models/aiIModelProperty.d.ts +6 -0
  31. package/dist/generated/config/models/aiModel.d.ts +7 -0
  32. package/dist/generated/config/models/aiModelSummary.d.ts +5 -0
  33. package/dist/generated/config/models/blocksBlockInfo.d.ts +6 -0
  34. package/dist/generated/config/models/blocksBlockInterface.d.ts +9 -0
  35. package/dist/generated/config/models/blocksBlockSet.d.ts +7 -0
  36. package/dist/generated/config/models/blocksInputPinInterface.d.ts +6 -0
  37. package/dist/generated/config/models/blocksOutputPinInterface.d.ts +6 -0
  38. package/dist/generated/config/models/blocksPortInterface.d.ts +5 -0
  39. package/dist/generated/config/models/blocksStateInterface.d.ts +4 -0
  40. package/dist/generated/config/models/blocksUsedInWorkspaceRef.d.ts +5 -0
  41. package/dist/generated/config/models/connectorsConnector.d.ts +7 -0
  42. package/dist/generated/config/models/connectorsConnectorSummary.d.ts +6 -0
  43. package/dist/generated/config/models/connectorsCreateConnector.d.ts +5 -0
  44. package/dist/generated/config/models/connectorsResolvedConnector.d.ts +9 -0
  45. package/dist/generated/config/models/connectorsUpdateConnector.d.ts +9 -0
  46. package/dist/generated/config/models/dataSetsCreateDataSet.d.ts +6 -0
  47. package/dist/generated/config/models/dataSetsCreateDataSetContainer.d.ts +6 -0
  48. package/dist/generated/config/models/dataSetsDataSet.d.ts +14 -0
  49. package/dist/generated/config/models/dataSetsDataSetProperty.d.ts +5 -0
  50. package/dist/generated/config/models/dataSetsSetDataSetScoping.d.ts +6 -0
  51. package/dist/generated/config/models/dataSetsUpdateDataSet.d.ts +6 -0
  52. package/dist/generated/config/models/dataSetsUpdateDataSetBasicInfo.d.ts +4 -0
  53. package/dist/generated/config/models/dataSetsUpsertDataSetProperty.d.ts +15 -1
  54. package/dist/generated/config/models/dataSourcesCreateDataSource.d.ts +6 -0
  55. package/dist/generated/config/models/dataSourcesDataSource.d.ts +6 -0
  56. package/dist/generated/config/models/dataSourcesDataSourceAdminUser.d.ts +6 -0
  57. package/dist/generated/config/models/dataSourcesDataSourceCredentialsDefinition.d.ts +5 -0
  58. package/dist/generated/config/models/dataSourcesTestDataSourceConnection.d.ts +7 -0
  59. package/dist/generated/config/models/dataSourcesUpdateDataSourceCredentials.d.ts +6 -0
  60. package/dist/generated/config/models/dataSpacesCreateDataSpace.d.ts +5 -0
  61. package/dist/generated/config/models/dataSpacesDataSpace.d.ts +9 -0
  62. package/dist/generated/config/models/dataSpacesDataSpaceAdmin.d.ts +12 -0
  63. package/dist/generated/config/models/dataSpacesDataSpaceWorkSpaceRef.d.ts +5 -0
  64. package/dist/generated/config/models/dataSpacesUpdateDataSpace.d.ts +6 -0
  65. package/dist/generated/config/models/draftsDraft.d.ts +6 -0
  66. package/dist/generated/config/models/draftsPublishDraftRequest.d.ts +5 -0
  67. package/dist/generated/config/models/draftsSaveDraftRequest.d.ts +5 -0
  68. package/dist/generated/config/models/draftsSaveDraftResponse.d.ts +5 -0
  69. package/dist/generated/config/models/filesCreateFileFromBlobUri.d.ts +6 -0
  70. package/dist/generated/config/models/filesFile.d.ts +12 -0
  71. package/dist/generated/config/models/filesFileUriResponse.d.ts +7 -0
  72. package/dist/generated/config/models/filesIngestedBlob.d.ts +7 -0
  73. package/dist/generated/config/models/flowRunsGetWorkspaceRunsParams.d.ts +16 -0
  74. package/dist/generated/config/models/flowRunsGetWorkspaceRunsParams.js +8 -0
  75. package/dist/generated/config/models/index.d.ts +3 -0
  76. package/dist/generated/config/models/index.js +3 -0
  77. package/dist/generated/config/models/integrationsSmartSpaceAiSmartSpaceAiPagedDataSystemCollectionsGenericICollectionIntegrationsSmartSpaceAiWorkspaceRun.d.ts +11 -0
  78. package/dist/generated/config/models/integrationsSmartSpaceAiSmartSpaceAiPagedDataSystemCollectionsGenericICollectionIntegrationsSmartSpaceAiWorkspaceRun.js +2 -0
  79. package/dist/generated/config/models/integrationsSmartSpaceAiWorkspaceRun.d.ts +27 -0
  80. package/dist/generated/config/models/integrationsSmartSpaceAiWorkspaceRun.js +8 -0
  81. package/dist/generated/config/models/managedSecretsCreateManagedSecret.d.ts +7 -0
  82. package/dist/generated/config/models/managedSecretsManagedSecret.d.ts +8 -0
  83. package/dist/generated/config/models/managedSecretsUpdateManagedSecretValue.d.ts +4 -0
  84. package/dist/generated/config/models/notificationsNotification.d.ts +9 -0
  85. package/dist/generated/config/models/notificationsPagedNotifications.d.ts +4 -0
  86. package/dist/generated/config/models/syncsSyncQueueState.d.ts +6 -0
  87. package/dist/generated/config/models/syncsSyncRunInfo.d.ts +5 -0
  88. package/dist/generated/config/models/usersAppAccessUser.d.ts +5 -0
  89. package/dist/generated/config/models/usersAppRole.d.ts +3 -0
  90. package/dist/generated/config/models/usersAppUserDetail.d.ts +5 -0
  91. package/dist/generated/config/models/usersAppUserSearchResult.d.ts +5 -0
  92. package/dist/generated/config/models/usersAppUserSummary.d.ts +6 -0
  93. package/dist/generated/config/models/usersServicePrincipalSearchResult.d.ts +4 -0
  94. package/dist/generated/config/models/workSpaceInfo.d.ts +6 -0
  95. package/dist/generated/config/models/workSpacesCreateWorkSpace.d.ts +5 -0
  96. package/dist/generated/config/models/workSpacesUpdateWorkSpaceBasicInfo.d.ts +5 -0
  97. package/dist/generated/config/models/workSpacesWorkSpace.d.ts +9 -0
  98. package/dist/generated/config/models/workSpacesWorkSpaceUser.d.ts +6 -0
  99. package/dist/generated/config/zod.d.ts +40 -2
  100. package/dist/generated/config/zod.js +168 -130
  101. package/package.json +1 -1
@@ -6,6 +6,14 @@
6
6
  */
7
7
  import type { EnumsActivityType } from './enumsActivityType';
8
8
  import type { ActivitiesLlmUsageMetrics } from './activitiesLlmUsageMetrics';
9
+ /**
10
+ * Workspace-scoped activity row returned by the activity log endpoint. The
11
+ `EventDescription`, `Prompt`, `Response`, and
12
+ `QueryNumber` are deserialised from the activity's
13
+ `DisplayName` (a JSON-serialised `WorkSpaceConfiguration`);
14
+ `LlmUsages` and `DurationMs` from `MetricsJson`. Build
15
+ happens in service code — see `ActivityService.GetLogWorkSpaceAsync`.
16
+ */
9
17
  export interface ActivitiesActivityWorkSpace {
10
18
  activityType?: EnumsActivityType;
11
19
  /** @nullable */
@@ -5,6 +5,12 @@
5
5
  * OpenAPI spec version: v1
6
6
  */
7
7
  import type { EnumsModelPropertyType } from './enumsModelPropertyType';
8
+ /**
9
+ * Polymorphic AI-model parameter (Number / Boolean / String) — discriminator
10
+ lives on `Type`. The shape is kept because the public JSON contract
11
+ returns the variant-specific fields under one collection; flattening to a
12
+ single record would be a breaking wire-shape change for the admin UI.
13
+ */
8
14
  export interface AiIModelProperty {
9
15
  readonly name: string;
10
16
  type: EnumsModelPropertyType;
@@ -8,6 +8,13 @@ import type { AiModelDeployment } from './aiModelDeployment';
8
8
  import type { EnumsModelDeploymentProviderType } from './enumsModelDeploymentProviderType';
9
9
  import type { EnumsModelPublisher } from './enumsModelPublisher';
10
10
  import type { AiIModelProperty } from './aiIModelProperty';
11
+ /**
12
+ * Full read model for an AI Model. Collides on the simple name with
13
+ `SmartSpace.App.Data.Entities.Model`; alias
14
+ `DataEntities = SmartSpace.App.Data.Entities` in files that import
15
+ both. The folder is named `AiModels` to avoid the second namespace
16
+ collision with `SmartSpace.App.Business.Models` itself.
17
+ */
11
18
  export interface AiModel {
12
19
  /** @nullable */
13
20
  createdAt?: string | null;
@@ -8,6 +8,11 @@ import type { EnumsModelDeploymentStatus } from './enumsModelDeploymentStatus';
8
8
  import type { EnumsModelDeploymentProviderType } from './enumsModelDeploymentProviderType';
9
9
  import type { EnumsModelPublisher } from './enumsModelPublisher';
10
10
  import type { AiIModelProperty } from './aiIModelProperty';
11
+ /**
12
+ * Lighter list-endpoint shape — drops the nested `Deployment.Steps`
13
+ collection and keeps a flat `DeploymentStatus` + provider type for
14
+ the AI Models grid.
15
+ */
11
16
  export interface AiModelSummary {
12
17
  /** @nullable */
13
18
  createdAt?: string | null;
@@ -6,6 +6,12 @@
6
6
  */
7
7
  import type { BlocksBlockInterface } from './blocksBlockInterface';
8
8
  import type { EnumsBlockType } from './enumsBlockType';
9
+ /**
10
+ * Flattened block descriptor — one `BlockInfo` per (name, version) pair
11
+ across every visible `BlockSet`. This is the shape the
12
+ `BlocksController` returns; the dictionary-of-dictionaries layout is
13
+ reconstructed by the service from the underlying interfaces.
14
+ */
9
15
  export interface BlocksBlockInfo {
10
16
  /** @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}$ */
11
17
  blockSetId: string;
@@ -8,6 +8,15 @@ import type { BlocksBlockInterfaceMetadata } from './blocksBlockInterfaceMetadat
8
8
  import type { BlocksBlockInterfacePorts } from './blocksBlockInterfacePorts';
9
9
  import type { EnumsBlockScope } from './enumsBlockScope';
10
10
  import type { BlocksBlockInterfaceState } from './blocksBlockInterfaceState';
11
+ /**
12
+ * Model for a block interface — the schema that describes a single
13
+ (name, version) pair of a block (ports, state, scope). Collides on the
14
+ simple name with `SmartSpace.App.Data.Entities.BlockInterface`; alias
15
+ `DataEntities = SmartSpace.App.Data.Entities` in files that import
16
+ both. `Name` and `Version` live on the entity but are surfaced
17
+ here too so the wire shape is self-describing (the same model travels via
18
+ SignalR debug payloads where the keys are stripped).
19
+ */
11
20
  export interface BlocksBlockInterface {
12
21
  metadata: BlocksBlockInterfaceMetadata;
13
22
  ports: BlocksBlockInterfacePorts;
@@ -7,6 +7,13 @@
7
7
  import type { BlocksBlockSetBlockInterfaces } from './blocksBlockSetBlockInterfaces';
8
8
  import type { EnumsBlockType } from './enumsBlockType';
9
9
  import type { BlocksUsedInWorkspaceRef } from './blocksUsedInWorkspaceRef';
10
+ /**
11
+ * Model for a `BlockSet` — a versioned collection of block interfaces.
12
+ Collides on the simple name with `SmartSpace.App.Data.Entities.BlockSet`;
13
+ alias `DataEntities = SmartSpace.App.Data.Entities` in files that
14
+ import both. `BlockInterfaces` is keyed by block name then version to
15
+ match the API shape consumers expect.
16
+ */
10
17
  export interface BlocksBlockSet {
11
18
  blockInterfaces: BlocksBlockSetBlockInterfaces;
12
19
  /** @nullable */
@@ -9,6 +9,12 @@ import type { BlocksInputPinInterfaceGenerics } from './blocksInputPinInterfaceG
9
9
  import type { BlocksInputPinInterfaceMetadata } from './blocksInputPinInterfaceMetadata';
10
10
  import type { BlocksInputPinInterfaceSchema } from './blocksInputPinInterfaceSchema';
11
11
  import type { EnumsPinType } from './enumsPinType';
12
+ /**
13
+ * Model for an input pin on a block port. Mirrors the live
14
+ `SmartSpace.App.Data.Entities.InputPinInterface` shape but exposes the
15
+ parsed JSON payloads (`Metadata`, `Schema`, `Generics`,
16
+ `Default`) rather than the raw `*Json` columns.
17
+ */
12
18
  export interface BlocksInputPinInterface {
13
19
  channel: boolean;
14
20
  /** @nullable */
@@ -8,6 +8,12 @@ import type { BlocksOutputPinInterfaceGenerics } from './blocksOutputPinInterfac
8
8
  import type { BlocksOutputPinInterfaceMetadata } from './blocksOutputPinInterfaceMetadata';
9
9
  import type { BlocksOutputPinInterfaceSchema } from './blocksOutputPinInterfaceSchema';
10
10
  import type { EnumsPinType } from './enumsPinType';
11
+ /**
12
+ * Model for an output pin on a block port. Mirrors the live
13
+ `SmartSpace.App.Data.Entities.OutputPinInterface` shape but exposes the
14
+ parsed JSON payloads (`Metadata`, `Schema`, `Generics`)
15
+ rather than the raw `*Json` columns.
16
+ */
11
17
  export interface BlocksOutputPinInterface {
12
18
  channel: boolean;
13
19
  /** @nullable */
@@ -8,6 +8,11 @@ import type { BlocksPortInterfaceInputs } from './blocksPortInterfaceInputs';
8
8
  import type { BlocksPortInterfaceMetadata } from './blocksPortInterfaceMetadata';
9
9
  import type { BlocksPortInterfaceOutputs } from './blocksPortInterfaceOutputs';
10
10
  import type { EnumsPortType } from './enumsPortType';
11
+ /**
12
+ * Model for a block `PortInterface`. Inputs and Outputs are keyed by pin
13
+ name (entities store them as `List<...>` with a `Key`
14
+ column; the model exposes them as dictionaries to match the API shape).
15
+ */
11
16
  export interface BlocksPortInterface {
12
17
  inputs: BlocksPortInterfaceInputs;
13
18
  isFunction: boolean;
@@ -7,6 +7,10 @@
7
7
  import type { BlocksStateInterfaceDefault } from './blocksStateInterfaceDefault';
8
8
  import type { BlocksStateInterfaceMetadata } from './blocksStateInterfaceMetadata';
9
9
  import type { FlowsBlockPinRef } from './flowsBlockPinRef';
10
+ /**
11
+ * Model for a block `StateInterface` — a piece of state declared by a
12
+ block interface, with a JSON default value and an optional pin-ref scope.
13
+ */
10
14
  export interface BlocksStateInterface {
11
15
  /** @nullable */
12
16
  default?: BlocksStateInterfaceDefault;
@@ -4,6 +4,11 @@
4
4
  * SmartSpace Admin API
5
5
  * OpenAPI spec version: v1
6
6
  */
7
+ /**
8
+ * A workspace that references one of the block set's blocks in its active
9
+ flow definition. Carries the id so the UI can deep-link to the workspace
10
+ designer (e.g. to detach a block before deleting its set).
11
+ */
7
12
  export interface BlocksUsedInWorkspaceRef {
8
13
  /** @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}$ */
9
14
  id: string;
@@ -4,6 +4,13 @@
4
4
  * SmartSpace Admin API
5
5
  * OpenAPI spec version: v1
6
6
  */
7
+ /**
8
+ * Admin read shape for a connector. Carries the auth SETTINGS (type, header,
9
+ scheme) because an admin editing the connector needs to see them — but
10
+ never the vault reference and never the value. Collides on the simple name
11
+ with `SmartSpace.App.Data.Entities.Connector`; alias
12
+ `DataEntities = SmartSpace.App.Data.Entities` in files importing both.
13
+ */
7
14
  export interface ConnectorsConnector {
8
15
  /** @nullable */
9
16
  authHeaderName?: string | null;
@@ -4,6 +4,12 @@
4
4
  * SmartSpace Admin API
5
5
  * OpenAPI spec version: v1
6
6
  */
7
+ /**
8
+ * The shape non-admins are allowed to see: enough to pick a connector from a
9
+ dropdown, and nothing more. No URL (that is infrastructure detail) and no
10
+ auth settings. Used by the workspace MCP tab's picker and embedded in the
11
+ workspace detail response so the flow editor can list what is attached.
12
+ */
7
13
  export interface ConnectorsConnectorSummary {
8
14
  /** @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}$ */
9
15
  id: string;
@@ -4,6 +4,11 @@
4
4
  * SmartSpace Admin API
5
5
  * OpenAPI spec version: v1
6
6
  */
7
+ /**
8
+ * Create request. One form writes both rows: the connector (identity) and
9
+ its single shared connection (credential). `Secret` is write-only —
10
+ it goes straight to Key Vault and is never returned by any admin endpoint.
11
+ */
7
12
  export interface ConnectorsCreateConnector {
8
13
  /** @nullable */
9
14
  authHeaderName?: string | null;
@@ -5,6 +5,15 @@
5
5
  * OpenAPI spec version: v1
6
6
  */
7
7
  import type { ConnectorsResolvedConnectorHeaders } from './connectorsResolvedConnectorHeaders';
8
+ /**
9
+ * The ONLY shape that carries a usable credential out of the service layer.
10
+ Returned exclusively by `IConnectorService.ResolveAsync`, which backs
11
+ the machine-only resolve endpoint (ssaikey-authenticated AI runtime).
12
+
13
+ SmartSpace.App.Business.Models.Connectors.ResolvedConnector.Headers is already composed — the caller attaches them
14
+ verbatim and never sees the raw secret, the header name or the scheme as
15
+ separate facts it has to reassemble.
16
+ */
8
17
  export interface ConnectorsResolvedConnector {
9
18
  headers: ConnectorsResolvedConnectorHeaders;
10
19
  url: string;
@@ -4,6 +4,15 @@
4
4
  * SmartSpace Admin API
5
5
  * OpenAPI spec version: v1
6
6
  */
7
+ /**
8
+ * Update request. `Kind` is absent on purpose — changing what a
9
+ connector IS would invalidate every flow referencing it; delete and
10
+ recreate instead.
11
+
12
+ `Secret` null means "leave the credential alone". A non-null value
13
+ rotates it: a new version of the SAME vault secret, so the row's reference
14
+ never changes and no orphan is left behind.
15
+ */
7
16
  export interface ConnectorsUpdateConnector {
8
17
  /** @nullable */
9
18
  authHeaderName?: string | null;
@@ -5,6 +5,12 @@
5
5
  * OpenAPI spec version: v1
6
6
  */
7
7
  import type { DataSetsCreateDataSetContainer } from './dataSetsCreateDataSetContainer';
8
+ /**
9
+ * Create-request shape for a DataSet. The DataSpace it belongs to is
10
+ carried on the route (`/DataSpaces/{id}/datasets`) rather than the
11
+ body. Container info is optional — empty list means "file-only" dataset
12
+ with a freshly-created file ingestion flow.
13
+ */
8
14
  export interface DataSetsCreateDataSet {
9
15
  /** @nullable */
10
16
  containerInfo?: DataSetsCreateDataSetContainer[] | null;
@@ -5,6 +5,12 @@
5
5
  * OpenAPI spec version: v1
6
6
  */
7
7
  import type { DataSourcesContainerFilterModel } from './dataSourcesContainerFilterModel';
8
+ /**
9
+ * Container reference used in create/update requests — pair of
10
+ `DataSourceId` and a `Path` identifying a specific container
11
+ inside that data source. The service hashes the pair to produce the
12
+ container id. Optional Filters restrict which records are synced.
13
+ */
8
14
  export interface DataSetsCreateDataSetContainer {
9
15
  /** @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}$ */
10
16
  dataSourceId: string;
@@ -6,6 +6,20 @@
6
6
  */
7
7
  import type { DataSetsDataSetProperty } from './dataSetsDataSetProperty';
8
8
  import type { EnumsDataSetScopingMode } from './enumsDataSetScopingMode';
9
+ /**
10
+ * Model for a DataSet. Collides on the simple name with
11
+ `SmartSpace.App.Data.Entities.DataSet`; alias
12
+ `DataEntities = SmartSpace.App.Data.Entities` in files that import
13
+ both.
14
+
15
+ The nested Flow shape on the legacy `SmartSpace.App.Business.Models.DataSet`
16
+ is intentionally dropped here — `FlowId` only. The Flow domain
17
+ hasn't migrated yet and projecting its recursive structure (Flow →
18
+ Triggers → DataSourceContainer → DataSource, Flow → ActiveFlowDefinition
19
+ → Inputs) into the model layer would couple two unmigrated domains and
20
+ bloat every DataSet read with multiple JOIN fan-outs. Callers that need
21
+ Flow detail fetch it via `IFlowService`.
22
+ */
9
23
  export interface DataSetsDataSet {
10
24
  createdAt: string;
11
25
  createdByUserId: string;
@@ -4,6 +4,11 @@
4
4
  * SmartSpace Admin API
5
5
  * OpenAPI spec version: v1
6
6
  */
7
+ /**
8
+ * Model for a property on a DataSet — a named, optionally-vectorised field
9
+ stored on each ingested item. Read-only at the model boundary; writes go
10
+ through SmartSpace.App.Business.Models.DataSets.UpsertDataSetProperty.
11
+ */
7
12
  export interface DataSetsDataSetProperty {
8
13
  /** @nullable */
9
14
  description?: string | null;
@@ -5,6 +5,12 @@
5
5
  * OpenAPI spec version: v1
6
6
  */
7
7
  import type { EnumsDataSetScopingMode } from './enumsDataSetScopingMode';
8
+ /**
9
+ * Sets the per-document scoping config on a dataset (intelligence-layer
10
+ `scoping` block). When `Mode` is `Unrestricted` the
11
+ `SubjectPath` is cleared; when `PerSubject`, `SubjectPath`
12
+ selects the document field to match (null = the built-in owner envelope).
13
+ */
8
14
  export interface DataSetsSetDataSetScoping {
9
15
  mode: EnumsDataSetScopingMode;
10
16
  /** @nullable */
@@ -5,6 +5,12 @@
5
5
  * OpenAPI spec version: v1
6
6
  */
7
7
  import type { DataSetsCreateDataSetContainer } from './dataSetsCreateDataSetContainer';
8
+ /**
9
+ * Update-request shape for a DataSet — name/description plus optional
10
+ re-binding of containers. Container info null = leave the existing
11
+ flow alone, just update basic fields; empty = disconnect every
12
+ container (soft-deletes all flow triggers).
13
+ */
8
14
  export interface DataSetsUpdateDataSet {
9
15
  /** @nullable */
10
16
  containerInfo?: DataSetsCreateDataSetContainer[] | null;
@@ -4,6 +4,10 @@
4
4
  * SmartSpace Admin API
5
5
  * OpenAPI spec version: v1
6
6
  */
7
+ /**
8
+ * Lightweight update for just the editable basic-info fields. Used by the
9
+ `PUT /DataSets/{id}/basicInfo` endpoint.
10
+ */
7
11
  export interface DataSetsUpdateDataSetBasicInfo {
8
12
  /** @nullable */
9
13
  description?: string | null;
@@ -4,9 +4,23 @@
4
4
  * SmartSpace Admin API
5
5
  * OpenAPI spec version: v1
6
6
  */
7
+ /**
8
+ * Upsert payload for a single DataSet property. `Name` is the key —
9
+ existing property with the same name is updated in place, otherwise a
10
+ new one is added.
11
+ */
7
12
  export interface DataSetsUpsertDataSetProperty {
8
13
  /** @nullable */
9
14
  description?: string | null;
10
- isVector: boolean;
15
+ /**
16
+ * Unused — the platform no longer reads this field and
17
+ it has no effect on ingestion or querying. It is retained as an optional
18
+ property purely for backward compatibility (see the description of
19
+ `POST /DataSets/{id}/properties`); omit it in new integrations.
20
+ When omitted, the stored value is preserved on update and defaults to
21
+ `false` on create.
22
+ * @nullable
23
+ */
24
+ isVector?: boolean | null;
11
25
  name: string;
12
26
  }
@@ -6,6 +6,12 @@
6
6
  */
7
7
  import type { EnumsDataSourceCredentialType } from './enumsDataSourceCredentialType';
8
8
  import type { DataSourcesCreateDataSourceCredentials } from './dataSourcesCreateDataSourceCredentials';
9
+ /**
10
+ * Create request shape — paired with SmartSpace.App.Business.Models.DataSources.UpdateDataSource even
11
+ though field overlap is partial; the `[Required]` contract differs.
12
+ Accepts inline credentials at creation time (listed under
13
+ `ModelFolderSafetyTests.ExistingDebtToReview`).
14
+ */
9
15
  export interface DataSourcesCreateDataSource {
10
16
  credentialType: EnumsDataSourceCredentialType;
11
17
  credentials: DataSourcesCreateDataSourceCredentials;
@@ -6,6 +6,12 @@
6
6
  */
7
7
  import type { DataSourceContainer } from './dataSourceContainer';
8
8
  import type { EnumsDataSourceCredentialType } from './enumsDataSourceCredentialType';
9
+ /**
10
+ * Full read shape for a DataSource. Collides on the simple name with
11
+ `SmartSpace.App.Data.Entities.DataSource`; alias
12
+ `DataEntities = SmartSpace.App.Data.Entities` in files that import
13
+ both.
14
+ */
9
15
  export interface DataSourcesDataSource {
10
16
  containers: DataSourceContainer[];
11
17
  createdAt: string;
@@ -4,6 +4,12 @@
4
4
  * SmartSpace Admin API
5
5
  * OpenAPI spec version: v1
6
6
  */
7
+ /**
8
+ * API response shape for "list admin users on a DataSource" — joins the
9
+ junction SmartSpace.App.Business.Models.DataSources.DataSourceAdmin with the user-service principal
10
+ to surface a display name. Composed in the service; not a Mapperly
11
+ projection target (the join crosses an external service boundary).
12
+ */
7
13
  export interface DataSourcesDataSourceAdminUser {
8
14
  id: string;
9
15
  name: string;
@@ -6,6 +6,11 @@
6
6
  */
7
7
  import type { DataSourcesCredentialsCredentialsType } from './dataSourcesCredentialsCredentialsType';
8
8
  import type { DataSourcesDataSourceProperty } from './dataSourcesDataSourceProperty';
9
+ /**
10
+ * Schema metadata describing the *shape* of credentials a connector type
11
+ requires — not credential values. Exempted from
12
+ `ModelFolderSafetyTests` via `LegitimateSchemaExceptions`.
13
+ */
9
14
  export interface DataSourcesDataSourceCredentialsDefinition {
10
15
  credentialsType: DataSourcesCredentialsCredentialsType;
11
16
  properties: DataSourcesDataSourceProperty[];
@@ -5,6 +5,13 @@
5
5
  * OpenAPI spec version: v1
6
6
  */
7
7
  import type { DataSourcesTestDataSourceConnectionCredentials } from './dataSourcesTestDataSourceConnectionCredentials';
8
+ /**
9
+ * Request shape for the test-connection endpoint and an internal carrier
10
+ for the data-source-type service when probing credentials. Contains an
11
+ inline credentials dictionary — listed under
12
+ `ModelFolderSafetyTests.ExistingDebtToReview`; redesign to a
13
+ KeyVault-ref-only payload is tracked in TODO.md.
14
+ */
8
15
  export interface DataSourcesTestDataSourceConnection {
9
16
  credentials: DataSourcesTestDataSourceConnectionCredentials;
10
17
  dataSourceTypeId: string;
@@ -5,6 +5,12 @@
5
5
  * OpenAPI spec version: v1
6
6
  */
7
7
  import type { DataSourcesUpdateDataSourceCredentialsCredentials } from './dataSourcesUpdateDataSourceCredentialsCredentials';
8
+ /**
9
+ * Partial-update payload for connector credentials — only non-empty
10
+ values overwrite the existing entries (see
11
+ `DataSourceService.UpdateCredentialsAsync`). Listed under
12
+ `ModelFolderSafetyTests.ExistingDebtToReview`.
13
+ */
8
14
  export interface DataSourcesUpdateDataSourceCredentials {
9
15
  credentials: DataSourcesUpdateDataSourceCredentialsCredentials;
10
16
  }
@@ -4,6 +4,11 @@
4
4
  * SmartSpace Admin API
5
5
  * OpenAPI spec version: v1
6
6
  */
7
+ /**
8
+ * Create-request shape for a DataSpace. `DataSetIds` is an optional
9
+ pre-attachment of existing datasets to the new dataspace; the creating
10
+ principal is implicitly added as the first admin.
11
+ */
7
12
  export interface DataSpacesCreateDataSpace {
8
13
  /** @nullable */
9
14
  dataSetIds?: string[] | null;
@@ -6,6 +6,15 @@
6
6
  */
7
7
  import type { DataSetsDataSet } from './dataSetsDataSet';
8
8
  import type { DataSpacesDataSpaceWorkSpaceRef } from './dataSpacesDataSpaceWorkSpaceRef';
9
+ /**
10
+ * Model for a DataSpace. Collides on the simple name with
11
+ `SmartSpace.App.Data.Entities.DataSpace`; alias
12
+ `DataEntities = SmartSpace.App.Data.Entities` in files that import
13
+ both. The fully-qualified `DataSets.DataSet` below also
14
+ disambiguates from the legacy unmigrated `Business.Models.DataSet`
15
+ — implicit name resolution prefers the ancestor namespace and would
16
+ otherwise pick up the legacy record.
17
+ */
9
18
  export interface DataSpacesDataSpace {
10
19
  createdAt: string;
11
20
  createdByUserId: string;
@@ -4,9 +4,21 @@
4
4
  * SmartSpace Admin API
5
5
  * OpenAPI spec version: v1
6
6
  */
7
+ /**
8
+ * Model for a DataSpace admin junction record. The composite key is
9
+ (UserId, DataSpaceId) — no surrogate id. Junction entities follow the
10
+ delete+create convention, so there is no `UpdateDataSpaceAdmin`.
11
+
12
+ `DisplayName` is filled by the service via `IUserService`
13
+ post-projection — it isn't on the entity and can't be projected, so it
14
+ hangs off the record as an `init`-only property rather than a
15
+ constructor parameter.
16
+ */
7
17
  export interface DataSpacesDataSpaceAdmin {
8
18
  /** @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}$ */
9
19
  dataSpaceId: string;
20
+ /** Display name resolved from `IUserService.GetPrincipalsByIdsAsync`
21
+ after projection. Empty string when the principal lookup misses. */
10
22
  displayName: string;
11
23
  userId: string;
12
24
  }
@@ -4,6 +4,11 @@
4
4
  * SmartSpace Admin API
5
5
  * OpenAPI spec version: v1
6
6
  */
7
+ /**
8
+ * Lightweight reference to a WorkSpace that uses this DataSpace. Avoids
9
+ pulling the full WorkSpace shape (admins, flows, configurations) when a
10
+ caller only needs to surface "what workspaces reference this DataSpace".
11
+ */
7
12
  export interface DataSpacesDataSpaceWorkSpaceRef {
8
13
  /** @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}$ */
9
14
  id: string;
@@ -4,6 +4,12 @@
4
4
  * SmartSpace Admin API
5
5
  * OpenAPI spec version: v1
6
6
  */
7
+ /**
8
+ * Update-request shape for a DataSpace — rename and re-bind the attached
9
+ datasets. The complete `DataSetIds` list is treated as the desired
10
+ state; datasets present today but missing here are unbound, new ones
11
+ are bound in.
12
+ */
7
13
  export interface DataSpacesUpdateDataSpace {
8
14
  dataSetIds: string[];
9
15
  /** @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}$ */
@@ -5,6 +5,12 @@
5
5
  * OpenAPI spec version: v1
6
6
  */
7
7
  import type { DraftsDraftBlockInterfaces } from './draftsDraftBlockInterfaces';
8
+ /**
9
+ * A browser-authored Draft Custom block — a `BlockSet` row with
10
+ `IsDraft = true`, scoped to one user. See `ADR-0002` for the
11
+ resolution rule that decides when the owner's draft wins over a published
12
+ Custom at the same `(name, version)`.
13
+ */
8
14
  export interface DraftsDraft {
9
15
  blockInterfaces: DraftsDraftBlockInterfaces;
10
16
  isActive: boolean;
@@ -4,6 +4,11 @@
4
4
  * SmartSpace Admin API
5
5
  * OpenAPI spec version: v1
6
6
  */
7
+ /**
8
+ * `ConfirmOverwrite` must be true to replace an already-published set of
9
+ the same name — the first attempt 409s with the impact details so the user
10
+ opts in deliberately (see the custom-block rework design, Phase 3).
11
+ */
7
12
  export interface DraftsPublishDraftRequest {
8
13
  confirmOverwrite: boolean;
9
14
  /** @nullable */
@@ -4,6 +4,11 @@
4
4
  * SmartSpace Admin API
5
5
  * OpenAPI spec version: v1
6
6
  */
7
+ /**
8
+ * Save a draft's source. `ExpectedRowVersion` is the value the client last saw;
9
+ the server returns 409 if the DB has moved on (eg. another tab). Null is allowed
10
+ only for first-ever creation.
11
+ */
7
12
  export interface DraftsSaveDraftRequest {
8
13
  /** @nullable */
9
14
  expectedRowVersion?: string | null;
@@ -5,6 +5,11 @@
5
5
  * OpenAPI spec version: v1
6
6
  */
7
7
  import type { DraftsSaveDraftResponseBlockInterfaces } from './draftsSaveDraftResponseBlockInterfaces';
8
+ /**
9
+ * Response after saving a draft. `ParseError` is non-null when the source
10
+ failed to parse — the text is still persisted, but `BlockInterfaces` is
11
+ empty until parse succeeds (matches the editor's live-preview semantics).
12
+ */
8
13
  export interface DraftsSaveDraftResponse {
9
14
  blockInterfaces: DraftsSaveDraftResponseBlockInterfaces;
10
15
  /** @nullable */
@@ -4,6 +4,12 @@
4
4
  * SmartSpace Admin API
5
5
  * OpenAPI spec version: v1
6
6
  */
7
+ /**
8
+ * Request to register an existing blob (already uploaded to storage) as a
9
+ SmartSpace.App.Business.Models.Files.File record bound to an optional flow run. Used by the
10
+ SmartSpace AI ingestion pipeline to call back into the API once it has
11
+ staged a file in blob storage.
12
+ */
7
13
  export interface FilesCreateFileFromBlobUri {
8
14
  blobUri: string;
9
15
  /**
@@ -4,6 +4,18 @@
4
4
  * SmartSpace Admin API
5
5
  * OpenAPI spec version: v1
6
6
  */
7
+ /**
8
+ * Model for a stored file blob. The simple name collides with
9
+ `System.IO.File` and `SmartSpace.App.Data.Entities.FileEntity`
10
+ (which is itself named to side-step the BCL collision); the
11
+ `SmartSpace.App.Business.Models.Files` namespace disambiguates. When
12
+ importing both this model and the entity, alias the entity side:
13
+ ```using DataEntities = SmartSpace.App.Data.Entities;```
14
+ `ThreadId` reflects the entity column `MessageThreadId`
15
+ (renamed at the model boundary because the API contract has always called
16
+ it `threadId`). `WorkspaceId` keeps the lower-s spelling that
17
+ matches the entity column and is already on the wire.
18
+ */
7
19
  export interface FilesFile {
8
20
  createdAt: string;
9
21
  createdByUserId: string;
@@ -4,6 +4,13 @@
4
4
  * SmartSpace Admin API
5
5
  * OpenAPI spec version: v1
6
6
  */
7
+ /**
8
+ * Response shape for `GET /files/{id}/uri` on both the chat-api and
9
+ config-api. Frontends call this with whatever URL the server hands them
10
+ (e.g. as the `sourceUri` on a file MessageValue) and expect a JSON
11
+ object — not a bare string — so the wire format stays extensible (we can
12
+ add e.g. an expiry without breaking clients).
13
+ */
7
14
  export interface FilesFileUriResponse {
8
15
  uri: string;
9
16
  }