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

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

@@ -4,6 +4,11 @@
  * SmartSpace Admin API
  * OpenAPI spec version: v1
  */
+/**
+ * Minimal user search result for autocomplete / picker UIs. Drops every
+field that isn't needed to render a row — the picker only needs id, name,
+and email.
+ */
 export interface UsersAppUserSearchResult {
     /** @nullable */
     emailAddress?: string | null;

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

@@ -4,6 +4,12 @@
  * SmartSpace Admin API
  * OpenAPI spec version: v1
  */
+/**
+ * Lighter user model used by role-membership lookups and permission-based
+filters where the full per-user activity and permission set isn't needed.
+Drops the heavier SmartSpace.App.Business.Models.Users.AppUserDetail fields to keep
+role-membership payloads tight.
+ */
 export interface UsersAppUserSummary {
     /** @nullable */
     emailAddress?: string | null;

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

@@ -4,6 +4,10 @@
  * SmartSpace Admin API
  * OpenAPI spec version: v1
  */
+/**
+ * Service-principal counterpart of SmartSpace.App.Business.Models.Users.AppUserSearchResult for
+the same picker UI.
+ */
 export interface UsersServicePrincipalSearchResult {
     displayName: string;
     id: string;

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

@@ -4,6 +4,12 @@
  * SmartSpace Admin API
  * OpenAPI spec version: v1
  */
+/**
+ * Cross-domain lightweight workspace pointer (id + name) embedded in
+shapes owned by other domains (e.g. SmartSpace.App.Business.Models.DataSpace). Stays
+in the legacy `SmartSpace.App.Business.Models` namespace until
+those domains migrate.
+ */
 export interface WorkSpaceInfo {
     /** @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/workSpacesCreateWorkSpace.d.ts

@@ -5,6 +5,11 @@
  * OpenAPI spec version: v1
  */
 import type { CreateModelConfiguration } from './createModelConfiguration';
+/**
+ * Request shape for creating a workspace. SmartSpace.App.Business.Models.WorkSpaces.CreateWorkSpace.Id is optional —
+callers may pre-allocate the id (e.g. for idempotency / client-side
+optimistic UI) or let the service generate one.
+ */
 export interface WorkSpacesCreateWorkSpace {
     dataSpaces: string[];
     /**

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

@@ -4,6 +4,11 @@
  * SmartSpace Admin API
  * OpenAPI spec version: v1
  */
+/**
+ * Request shape for the basic-info PUT endpoint. Replaces the legacy
+`WorkSpaceBasicInfo` record (which lacked DataAnnotations); shape
+unchanged so the wire contract is preserved.
+ */
 export interface WorkSpacesUpdateWorkSpaceBasicInfo {
     /** @nullable */
     firstPrompt?: string | null;

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

@@ -9,6 +9,15 @@ import type { DataSpace } from './dataSpace';
 import type { WorkSpacesWorkSpaceInputs } from './workSpacesWorkSpaceInputs';
 import type { ModelConfiguration } from './modelConfiguration';
 import type { WorkSpacesWorkSpaceVariables } from './workSpacesWorkSpaceVariables';
+/**
+ * Full read model for a WorkSpace. Collides on the simple name with
+`SmartSpace.App.Data.Entities.WorkSpace`; alias
+`DataEntities = SmartSpace.App.Data.Entities` in files that import
+both. References pre-existing cross-domain models
+(SmartSpace.App.Business.Models.DataSpace, SmartSpace.App.Business.Models.ModelConfiguration,
+SmartSpace.App.Business.Models.Flows.FlowInput, SmartSpace.App.Business.Models.Flows.FlowVariable) — those are not
+re-modelled by this PR.
+ */
 export interface WorkSpacesWorkSpace {
     connectors: ConnectorsConnectorSummary[];
     createdAt: string;

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

@@ -4,6 +4,12 @@
  * SmartSpace Admin API
  * OpenAPI spec version: v1
  */
+/**
+ * User-on-workspace projection: the user's id, display name, and whether
+they are a workspace admin. Composed by the service from
+`EntityAccess` + `WorkspaceAdmin` records + the user-directory
+display name — not a direct entity projection.
+ */
 export interface WorkSpacesWorkSpaceUser {
     id: string;
     isAdmin: boolean;