@qlik/api 0.0.8 → 0.0.10

package/qix.d.ts

@@ -1,7 +1,7 @@
-import './global.types-1rNhDH7j.js';
+import './global.types-TzVhFPid.js';
 import { H as HostConfig } from './auth-types-nnUcWhuU.js';
 
-declare const QIX_SCHEMA_VERSION = "12.1951.0";
+declare const QIX_SCHEMA_VERSION = "12.1958.0";
 type AlfaNumString = {
     /**
      * Calculated value.
@@ -9038,6 +9038,13 @@ type NativeGenericDimensionFunctions = {
      * Stability: *locked*
      */
     approve: () => Promise<void>;
+    /**
+     * Get a cyclic dimension's active field.
+     * <div class=tip>This operation is only possible for cyclic dimensions.</div>
+     *
+     * Stability: *experimental*
+     */
+    getActiveField: () => Promise<number>;
     /**
      * Returns the definition of a dimension.
      *
@@ -9079,6 +9086,17 @@ type NativeGenericDimensionFunctions = {
      * Stability: *locked*
      */
     publish: () => Promise<void>;
+    /**
+     * Set a cyclic dimension's active field directly.
+     * <div class=tip>This operation is only possible for cyclic dimensions.</div>
+     *
+     * Parameters:
+     *
+     * - `ix`   -   Index of the new active field.
+     *
+     * Stability: *experimental*
+     */
+    setActiveField: (ix: number) => Promise<void>;
     /**
      * Sets some properties for a dimension.
      *

package/qix.js

@@ -1,10 +1,10 @@
 "use strict";Object.defineProperty(exports, "__esModule", {value: true});
 
 
-var _chunkGY2TAYQHjs = require('./chunk-GY2TAYQH.js');
-require('./chunk-BRDPNGQ7.js');
-require('./chunk-P57PW2II.js');
+var _3MHXEHLQjs = require('./chunks/3MHXEHLQ.js');
+require('./chunks/FG5GDUSZ.js');
+require('./chunks/4HB3TAEO.js');
 
 
 
-exports.default = _chunkGY2TAYQHjs.qix_default; exports.openAppSession = _chunkGY2TAYQHjs.openAppSession;
+exports.default = _3MHXEHLQjs.qix_default; exports.openAppSession = _3MHXEHLQjs.openAppSession;

package/qix.mjs

@@ -1,9 +1,9 @@
 import {
   openAppSession,
   qix_default
-} from "./chunk-YILVC32M.mjs";
-import "./chunk-LLLEO6K6.mjs";
-import "./chunk-ZFXKCRJC.mjs";
+} from "./chunks/KEPPVUY3.mjs";
+import "./chunks/O5POHH2Q.mjs";
+import "./chunks/VSY5YIQY.mjs";
 export {
   qix_default as default,
   openAppSession

package/quotas.d.mts

@@ -1,6 +1,9 @@
-import { A as ApiCallOptions } from './global.types-4jzAvW7R.mjs';
+import { A as ApiCallOptions } from './global.types-5iFvFJvX.mjs';
 import './auth-types-nnUcWhuU.mjs';
 
+/**
+ * A specific error.
+ */
 type Error = {
     /** The error code. */
     code: string;

package/quotas.d.ts

@@ -1,6 +1,9 @@
-import { A as ApiCallOptions } from './global.types-1rNhDH7j.js';
+import { A as ApiCallOptions } from './global.types-TzVhFPid.js';
 import './auth-types-nnUcWhuU.js';
 
+/**
+ * A specific error.
+ */
 type Error = {
     /** The error code. */
     code: string;

package/quotas.js

@@ -1,18 +1,18 @@
 "use strict";Object.defineProperty(exports, "__esModule", {value: true});
 
 
-var _chunkEALMXU6Sjs = require('./chunk-EALMXU6S.js');
-require('./chunk-BRDPNGQ7.js');
-require('./chunk-P57PW2II.js');
+var _QMWU5E4Djs = require('./chunks/QMWU5E4D.js');
+require('./chunks/FG5GDUSZ.js');
+require('./chunks/4HB3TAEO.js');
 
 // src/public/rest/quotas.ts
-var getQuotas = async (query, options) => _chunkEALMXU6Sjs.invokeFetch.call(void 0, "quotas", {
+var getQuotas = async (query, options) => _QMWU5E4Djs.invokeFetch.call(void 0, "quotas", {
   method: "get",
   pathTemplate: "/api/v1/quotas",
   query,
   options
 });
-var getQuota = async (id, query, options) => _chunkEALMXU6Sjs.invokeFetch.call(void 0, "quotas", {
+var getQuota = async (id, query, options) => _QMWU5E4Djs.invokeFetch.call(void 0, "quotas", {
   method: "get",
   pathTemplate: "/api/v1/quotas/{id}",
   pathVariables: { id },
@@ -20,7 +20,7 @@ var getQuota = async (id, query, options) => _chunkEALMXU6Sjs.invokeFetch.call(v
   options
 });
 function clearCache() {
-  return _chunkEALMXU6Sjs.clearApiCache.call(void 0, "quotas");
+  return _QMWU5E4Djs.clearApiCache.call(void 0, "quotas");
 }
 var quotasExport = { getQuotas, getQuota, clearCache };
 var quotas_default = quotasExport;

package/quotas.mjs

@@ -1,9 +1,9 @@
 import {
   clearApiCache,
   invokeFetch
-} from "./chunk-4MWB2T3C.mjs";
-import "./chunk-LLLEO6K6.mjs";
-import "./chunk-ZFXKCRJC.mjs";
+} from "./chunks/HWZC3PIL.mjs";
+import "./chunks/O5POHH2Q.mjs";
+import "./chunks/VSY5YIQY.mjs";
 
 // src/public/rest/quotas.ts
 var getQuotas = async (query, options) => invokeFetch("quotas", {

package/reload-tasks.d.mts

@@ -1,4 +1,4 @@
-import { A as ApiCallOptions } from './global.types-4jzAvW7R.mjs';
+import { A as ApiCallOptions } from './global.types-5iFvFJvX.mjs';
 import './auth-types-nnUcWhuU.mjs';
 
 type Error = {
@@ -18,7 +18,8 @@ type PaginationLinks = SelfLink & {
     prev?: Href;
 };
 type PostTaskBody = TaskBase & {
-    /** Type of task being created - only contains the "scheduled_reload" value. Type value is not used for creating a schedule reload. It has been deprecated since 2022-04-05. */
+    /** @deprecated
+     * Type of task being created - only contains the "scheduled_reload" value. Type value is not used for creating a schedule reload. It has been deprecated since 2022-04-05. */
     type?: "scheduled_reload";
 };
 type PutTaskBody = TaskBase & {
@@ -31,14 +32,16 @@ type SelfLink = {
 type Task = TaskBase & {
     /** The reason why the task was disabled. */
     disabledCode?: "MANUALLY" | "CONSECUTIVE-FAILURES" | "OWNER-DELETED" | "OWNER-DISABLED";
-    /** The fortress ID of the application */
+    /** @deprecated
+     * The fortress ID of the application */
     fortressId?: string;
     /** The ID of the task. */
     id: string;
     /** The last time the task executed. */
     lastExecutionTime?: string;
     links: SelfLink;
-    /** The reason why the task was disabled. */
+    /** @deprecated
+     * The reason why the task was disabled. */
     log?: string;
     /** The next time the task will execute. */
     nextExecutionTime?: string;

package/reload-tasks.d.ts

@@ -1,4 +1,4 @@
-import { A as ApiCallOptions } from './global.types-1rNhDH7j.js';
+import { A as ApiCallOptions } from './global.types-TzVhFPid.js';
 import './auth-types-nnUcWhuU.js';
 
 type Error = {
@@ -18,7 +18,8 @@ type PaginationLinks = SelfLink & {
     prev?: Href;
 };
 type PostTaskBody = TaskBase & {
-    /** Type of task being created - only contains the "scheduled_reload" value. Type value is not used for creating a schedule reload. It has been deprecated since 2022-04-05. */
+    /** @deprecated
+     * Type of task being created - only contains the "scheduled_reload" value. Type value is not used for creating a schedule reload. It has been deprecated since 2022-04-05. */
     type?: "scheduled_reload";
 };
 type PutTaskBody = TaskBase & {
@@ -31,14 +32,16 @@ type SelfLink = {
 type Task = TaskBase & {
     /** The reason why the task was disabled. */
     disabledCode?: "MANUALLY" | "CONSECUTIVE-FAILURES" | "OWNER-DELETED" | "OWNER-DISABLED";
-    /** The fortress ID of the application */
+    /** @deprecated
+     * The fortress ID of the application */
     fortressId?: string;
     /** The ID of the task. */
     id: string;
     /** The last time the task executed. */
     lastExecutionTime?: string;
     links: SelfLink;
-    /** The reason why the task was disabled. */
+    /** @deprecated
+     * The reason why the task was disabled. */
     log?: string;
     /** The next time the task will execute. */
     nextExecutionTime?: string;

package/reload-tasks.js

@@ -1,37 +1,37 @@
 "use strict";Object.defineProperty(exports, "__esModule", {value: true});
 
 
-var _chunkEALMXU6Sjs = require('./chunk-EALMXU6S.js');
-require('./chunk-BRDPNGQ7.js');
-require('./chunk-P57PW2II.js');
+var _QMWU5E4Djs = require('./chunks/QMWU5E4D.js');
+require('./chunks/FG5GDUSZ.js');
+require('./chunks/4HB3TAEO.js');
 
 // src/public/rest/reload-tasks.ts
-var getReloadTasks = async (query, options) => _chunkEALMXU6Sjs.invokeFetch.call(void 0, "reload-tasks", {
+var getReloadTasks = async (query, options) => _QMWU5E4Djs.invokeFetch.call(void 0, "reload-tasks", {
   method: "get",
   pathTemplate: "/api/v1/reload-tasks",
   query,
   options
 });
-var createReloadTask = async (body, options) => _chunkEALMXU6Sjs.invokeFetch.call(void 0, "reload-tasks", {
+var createReloadTask = async (body, options) => _QMWU5E4Djs.invokeFetch.call(void 0, "reload-tasks", {
   method: "post",
   pathTemplate: "/api/v1/reload-tasks",
   body,
   contentType: "application/json",
   options
 });
-var deleteReloadTask = async (taskId, options) => _chunkEALMXU6Sjs.invokeFetch.call(void 0, "reload-tasks", {
+var deleteReloadTask = async (taskId, options) => _QMWU5E4Djs.invokeFetch.call(void 0, "reload-tasks", {
   method: "delete",
   pathTemplate: "/api/v1/reload-tasks/{taskId}",
   pathVariables: { taskId },
   options
 });
-var getReloadTask = async (taskId, options) => _chunkEALMXU6Sjs.invokeFetch.call(void 0, "reload-tasks", {
+var getReloadTask = async (taskId, options) => _QMWU5E4Djs.invokeFetch.call(void 0, "reload-tasks", {
   method: "get",
   pathTemplate: "/api/v1/reload-tasks/{taskId}",
   pathVariables: { taskId },
   options
 });
-var updateReloadTask = async (taskId, body, options) => _chunkEALMXU6Sjs.invokeFetch.call(void 0, "reload-tasks", {
+var updateReloadTask = async (taskId, body, options) => _QMWU5E4Djs.invokeFetch.call(void 0, "reload-tasks", {
   method: "put",
   pathTemplate: "/api/v1/reload-tasks/{taskId}",
   pathVariables: { taskId },
@@ -40,7 +40,7 @@ var updateReloadTask = async (taskId, body, options) => _chunkEALMXU6Sjs.invokeF
   options
 });
 function clearCache() {
-  return _chunkEALMXU6Sjs.clearApiCache.call(void 0, "reload-tasks");
+  return _QMWU5E4Djs.clearApiCache.call(void 0, "reload-tasks");
 }
 var reloadTasksExport = {
   getReloadTasks,

package/reload-tasks.mjs

@@ -1,9 +1,9 @@
 import {
   clearApiCache,
   invokeFetch
-} from "./chunk-4MWB2T3C.mjs";
-import "./chunk-LLLEO6K6.mjs";
-import "./chunk-ZFXKCRJC.mjs";
+} from "./chunks/HWZC3PIL.mjs";
+import "./chunks/O5POHH2Q.mjs";
+import "./chunks/VSY5YIQY.mjs";
 
 // src/public/rest/reload-tasks.ts
 var getReloadTasks = async (query, options) => invokeFetch("reload-tasks", {

package/reloads.d.mts

@@ -1,4 +1,4 @@
-import { A as ApiCallOptions } from './global.types-4jzAvW7R.mjs';
+import { A as ApiCallOptions } from './global.types-5iFvFJvX.mjs';
 import './auth-types-nnUcWhuU.mjs';
 
 type Error = {
@@ -13,6 +13,9 @@ type Errors = {
 type Href = {
     href?: string;
 };
+/**
+ * The boolean value used to present the reload is partial or not.
+ */
 type Partial = boolean;
 type Reload = {
     /** The ID of the app. */
@@ -58,7 +61,13 @@ type ReloadsLinks = ReloadLinks & {
     next?: Href;
     prev?: Href;
 };
+/**
+ * The status of the reload. There are seven statuses. `QUEUED`, `RELOADING`, `CANCELING` are the active statuses. `SUCCEEDED`, `FAILED`, `CANCELED`, `EXCEEDED_LIMIT` are the end statuses.
+ */
 type Status = "QUEUED" | "RELOADING" | "CANCELING" | "SUCCEEDED" | "FAILED" | "CANCELED" | "EXCEEDED_LIMIT";
+/**
+ * What initiated the reload: hub = one-time reload manually triggered in hub, chronos = time based scheduled reload triggered by chronos, external = reload triggered via external API request, automations = reload triggered in automation, data-refresh = reload triggered by refresh of data.
+ */
 type Type = "hub" | "external" | "chronos" | "automations" | "data-refresh";
 /**
  * Finds and returns the reloads that the user has access to.

package/reloads.d.ts

@@ -1,4 +1,4 @@
-import { A as ApiCallOptions } from './global.types-1rNhDH7j.js';
+import { A as ApiCallOptions } from './global.types-TzVhFPid.js';
 import './auth-types-nnUcWhuU.js';
 
 type Error = {
@@ -13,6 +13,9 @@ type Errors = {
 type Href = {
     href?: string;
 };
+/**
+ * The boolean value used to present the reload is partial or not.
+ */
 type Partial = boolean;
 type Reload = {
     /** The ID of the app. */
@@ -58,7 +61,13 @@ type ReloadsLinks = ReloadLinks & {
     next?: Href;
     prev?: Href;
 };
+/**
+ * The status of the reload. There are seven statuses. `QUEUED`, `RELOADING`, `CANCELING` are the active statuses. `SUCCEEDED`, `FAILED`, `CANCELED`, `EXCEEDED_LIMIT` are the end statuses.
+ */
 type Status = "QUEUED" | "RELOADING" | "CANCELING" | "SUCCEEDED" | "FAILED" | "CANCELED" | "EXCEEDED_LIMIT";
+/**
+ * What initiated the reload: hub = one-time reload manually triggered in hub, chronos = time based scheduled reload triggered by chronos, external = reload triggered via external API request, automations = reload triggered in automation, data-refresh = reload triggered by refresh of data.
+ */
 type Type = "hub" | "external" | "chronos" | "automations" | "data-refresh";
 /**
  * Finds and returns the reloads that the user has access to.

package/reloads.js

@@ -1,38 +1,38 @@
 "use strict";Object.defineProperty(exports, "__esModule", {value: true});
 
 
-var _chunkEALMXU6Sjs = require('./chunk-EALMXU6S.js');
-require('./chunk-BRDPNGQ7.js');
-require('./chunk-P57PW2II.js');
+var _QMWU5E4Djs = require('./chunks/QMWU5E4D.js');
+require('./chunks/FG5GDUSZ.js');
+require('./chunks/4HB3TAEO.js');
 
 // src/public/rest/reloads.ts
-var getReloads = async (query, options) => _chunkEALMXU6Sjs.invokeFetch.call(void 0, "reloads", {
+var getReloads = async (query, options) => _QMWU5E4Djs.invokeFetch.call(void 0, "reloads", {
   method: "get",
   pathTemplate: "/api/v1/reloads",
   query,
   options
 });
-var queueReload = async (body, options) => _chunkEALMXU6Sjs.invokeFetch.call(void 0, "reloads", {
+var queueReload = async (body, options) => _QMWU5E4Djs.invokeFetch.call(void 0, "reloads", {
   method: "post",
   pathTemplate: "/api/v1/reloads",
   body,
   contentType: "application/json",
   options
 });
-var getReload = async (reloadId, options) => _chunkEALMXU6Sjs.invokeFetch.call(void 0, "reloads", {
+var getReload = async (reloadId, options) => _QMWU5E4Djs.invokeFetch.call(void 0, "reloads", {
   method: "get",
   pathTemplate: "/api/v1/reloads/{reloadId}",
   pathVariables: { reloadId },
   options
 });
-var cancelReload = async (reloadId, options) => _chunkEALMXU6Sjs.invokeFetch.call(void 0, "reloads", {
+var cancelReload = async (reloadId, options) => _QMWU5E4Djs.invokeFetch.call(void 0, "reloads", {
   method: "post",
   pathTemplate: "/api/v1/reloads/{reloadId}/actions/cancel",
   pathVariables: { reloadId },
   options
 });
 function clearCache() {
-  return _chunkEALMXU6Sjs.clearApiCache.call(void 0, "reloads");
+  return _QMWU5E4Djs.clearApiCache.call(void 0, "reloads");
 }
 var reloadsExport = { getReloads, queueReload, getReload, cancelReload, clearCache };
 var reloads_default = reloadsExport;

package/reloads.mjs

@@ -1,9 +1,9 @@
 import {
   clearApiCache,
   invokeFetch
-} from "./chunk-4MWB2T3C.mjs";
-import "./chunk-LLLEO6K6.mjs";
-import "./chunk-ZFXKCRJC.mjs";
+} from "./chunks/HWZC3PIL.mjs";
+import "./chunks/O5POHH2Q.mjs";
+import "./chunks/VSY5YIQY.mjs";
 
 // src/public/rest/reloads.ts
 var getReloads = async (query, options) => invokeFetch("reloads", {

package/roles.d.mts

@@ -1,6 +1,9 @@
-import { A as ApiCallOptions } from './global.types-4jzAvW7R.mjs';
+import { A as ApiCallOptions } from './global.types-5iFvFJvX.mjs';
 import './auth-types-nnUcWhuU.mjs';
 
+/**
+ * An error object describing the error.
+ */
 type Error = {
     /** The error code. */
     code: string;
@@ -18,12 +21,18 @@ type Error = {
     /** Summary of the problem. */
     title: string;
 };
+/**
+ * The error response object describing the error from the handling of an HTTP request.
+ */
 type Errors = {
     /** An array of errors related to the operation. */
     errors?: Error[];
     /** A unique identifier for tracing the error. */
     traceId?: string;
 };
+/**
+ * Contains pagination links
+ */
 type Links = {
     /** Link to the next page of items */
     next?: {
@@ -59,7 +68,7 @@ type Role = {
     readonly createdBy?: string;
     /** Descriptive text for the role. */
     description: string;
-    /** Indicate if this role will trigger promotion to full user in STP */
+    /** Indicate whether this role will trigger promotion of a user from a basic to a full user on tenants with a capacity-based subscription. Does not apply to tenants with a user-based subscription. */
     readonly fullUser?: boolean;
     /** The unique identifier for the role. */
     readonly id: string;

package/roles.d.ts

@@ -1,6 +1,9 @@
-import { A as ApiCallOptions } from './global.types-1rNhDH7j.js';
+import { A as ApiCallOptions } from './global.types-TzVhFPid.js';
 import './auth-types-nnUcWhuU.js';
 
+/**
+ * An error object describing the error.
+ */
 type Error = {
     /** The error code. */
     code: string;
@@ -18,12 +21,18 @@ type Error = {
     /** Summary of the problem. */
     title: string;
 };
+/**
+ * The error response object describing the error from the handling of an HTTP request.
+ */
 type Errors = {
     /** An array of errors related to the operation. */
     errors?: Error[];
     /** A unique identifier for tracing the error. */
     traceId?: string;
 };
+/**
+ * Contains pagination links
+ */
 type Links = {
     /** Link to the next page of items */
     next?: {
@@ -59,7 +68,7 @@ type Role = {
     readonly createdBy?: string;
     /** Descriptive text for the role. */
     description: string;
-    /** Indicate if this role will trigger promotion to full user in STP */
+    /** Indicate whether this role will trigger promotion of a user from a basic to a full user on tenants with a capacity-based subscription. Does not apply to tenants with a user-based subscription. */
     readonly fullUser?: boolean;
     /** The unique identifier for the role. */
     readonly id: string;

package/roles.js

@@ -1,25 +1,25 @@
 "use strict";Object.defineProperty(exports, "__esModule", {value: true});
 
 
-var _chunkEALMXU6Sjs = require('./chunk-EALMXU6S.js');
-require('./chunk-BRDPNGQ7.js');
-require('./chunk-P57PW2II.js');
+var _QMWU5E4Djs = require('./chunks/QMWU5E4D.js');
+require('./chunks/FG5GDUSZ.js');
+require('./chunks/4HB3TAEO.js');
 
 // src/public/rest/roles.ts
-var getRoles = async (query, options) => _chunkEALMXU6Sjs.invokeFetch.call(void 0, "roles", {
+var getRoles = async (query, options) => _QMWU5E4Djs.invokeFetch.call(void 0, "roles", {
   method: "get",
   pathTemplate: "/api/v1/roles",
   query,
   options
 });
-var getRole = async (id, options) => _chunkEALMXU6Sjs.invokeFetch.call(void 0, "roles", {
+var getRole = async (id, options) => _QMWU5E4Djs.invokeFetch.call(void 0, "roles", {
   method: "get",
   pathTemplate: "/api/v1/roles/{id}",
   pathVariables: { id },
   options
 });
 function clearCache() {
-  return _chunkEALMXU6Sjs.clearApiCache.call(void 0, "roles");
+  return _QMWU5E4Djs.clearApiCache.call(void 0, "roles");
 }
 var rolesExport = { getRoles, getRole, clearCache };
 var roles_default = rolesExport;

package/roles.mjs

@@ -1,9 +1,9 @@
 import {
   clearApiCache,
   invokeFetch
-} from "./chunk-4MWB2T3C.mjs";
-import "./chunk-LLLEO6K6.mjs";
-import "./chunk-ZFXKCRJC.mjs";
+} from "./chunks/HWZC3PIL.mjs";
+import "./chunks/O5POHH2Q.mjs";
+import "./chunks/VSY5YIQY.mjs";
 
 // src/public/rest/roles.ts
 var getRoles = async (query, options) => invokeFetch("roles", {

package/spaces.d.mts

@@ -1,6 +1,9 @@
-import { A as ApiCallOptions } from './global.types-4jzAvW7R.mjs';
+import { A as ApiCallOptions } from './global.types-5iFvFJvX.mjs';
 import './auth-types-nnUcWhuU.mjs';
 
+/**
+ * The supported actions for user-created spaces like Shared or Managed spaces.
+ */
 type ActionName = "create" | "read" | "update" | "delete" | "publish";
 type Assignment = {
     /** The userId or groupId based on the type. */
@@ -35,6 +38,9 @@ type AssignmentCreate = {
     /** The type of assignment such as user or group */
     type: AssignmentType;
 };
+/**
+ * The type of assignment such as user or group
+ */
 type AssignmentType = "user" | "group";
 type AssignmentUpdate = {
     /** The roles assigned to the assigneeId. */
@@ -52,6 +58,9 @@ type Assignments = {
         count: number;
     };
 };
+/**
+ * An error object.
+ */
 type Error = {
     /** The error code. */
     code: string;
@@ -71,21 +80,26 @@ type Error = {
     title: string;
 };
 type Errors = {
-    /** The error code. */
+    /** @deprecated
+     * The error code. */
     code?: string;
-    /** A human-readable explanation specific to the occurrence of this problem. */
+    /** @deprecated
+     * A human-readable explanation specific to the occurrence of this problem. */
     detail?: string;
     errors?: Error[];
-    /** Additional properties relating to the error. */
+    /** @deprecated
+     * Additional properties relating to the error. */
     meta?: unknown;
-    /** References to the source of the error. */
+    /** @deprecated
+     * References to the source of the error. */
     source?: {
         /** The URI query parameter that caused the error. */
         parameter?: string;
         /** A JSON pointer to the property that caused the error. */
         pointer?: string;
     };
-    /** Summary of the problem. */
+    /** @deprecated
+     * Summary of the problem. */
     title?: string;
     traceId?: string;
 };
@@ -93,8 +107,20 @@ type Link = {
     /** URL that defines the resource. */
     href: string;
 };
+/**
+ * Supported roles by space type:
+ * - Shared: codeveloper, consumer, dataconsumer, facilitator, producer
+ * - Managed: consumer, contributor, dataconsumer, facilitator, publisher, basicconsumer
+ * - Data: consumer, dataconsumer, facilitator, operator, producer, publisher
+ */
 type RoleType = "consumer" | "contributor" | "dataconsumer" | "facilitator" | "operator" | "producer" | "publisher" | "basicconsumer" | "codeveloper";
+/**
+ * The supported roles for Shared spaces.
+ */
 type SharedSpaceRoleType = "facilitator" | "consumer" | "producer" | "dataconsumer" | "codeveloper";
+/**
+ * A space is a security context simplifying the management of access control by allowing users to control it on the containers instead of on the resources themselves.
+ */
 type Space = {
     /** The date and time when the space was created. */
     readonly createdAt?: string;
@@ -147,7 +173,13 @@ type SpacePatch = {
      * - ownerId: The user ID in uid format (string) of the space owner. */
     value: string;
 }[];
+/**
+ * The name of the type.
+ */
 type SpaceType = "shared" | "managed" | "data";
+/**
+ * The distinct types of spaces (shared, managed, and so on).
+ */
 type SpaceTypes = {
     readonly data?: SpaceType[];
 };