@qlik/api 1.28.0 → 1.29.0

package/data-files.d.ts

@@ -253,6 +253,27 @@ type SpaceStatsResponse = {
 };
 /**
  * Get descriptive info for the specified data files.
+ * @example
+ * getDataFiles(
+ *   {
+ *     allowInternalFiles: false,
+ *     appId: "f34b91a1-0dc3-44ac-a847-51cb84122c84",
+ *     baseNameWildcard: "*SomeFileName*",
+ *     connectionId: "ee6a390c-5d33-11e8-9c2d-fa7ae01bbebc",
+ *     excludeFiles: false,
+ *     excludeSubFolders: false,
+ *     folderId: "ee6a390c-5d33-11e8-9c2d-fa7ae01bbebc",
+ *     folderPath: "some/folder",
+ *     includeAllSpaces: false,
+ *     includeFolders: false,
+ *     includeFolderStats: false,
+ *     limit: 5,
+ *     name: "MyFile.csv",
+ *     notOwnerId: "lDL4DIINndhL_iJkcbqWyJenuwizP-2D",
+ *     ownerId: "lDL4DIINndhL_iJkcbqWyJenuwizP-2D",
+ *     page: "NzlmNzI5NWMtZGJlZC00Y2Y4LThkNDAtMzQ5ZDU3YzNjMzQ1"
+ *   }
+ * )
  *
  * @param query an object with query parameters
  * @throws GetDataFilesHttpError
@@ -417,6 +438,18 @@ type DeleteDataFilesHttpError = {
 /**
  * The non-filtered list contains a set of hardcoded connections, along with one connection per team space that
  * the given user has access to.
+ * @example
+ * getDataFilesConnections(
+ *   {
+ *     appId: "f34b91a1-0dc3-44ac-a847-51cb84122c84",
+ *     includeSpaceStats: false,
+ *     limit: 5,
+ *     name: "MySenseApp",
+ *     page: "NzlmNzI5NWMtZGJlZC00Y2Y4LThkNDAtMzQ5ZDU3YzNjMzQ1",
+ *     personal: true,
+ *     spaceId: "617979737a9f56e49dea2e6e"
+ *   }
+ * )
  *
  * @param query an object with query parameters
  * @throws GetDataFilesConnectionsHttpError
@@ -455,6 +488,10 @@ type GetDataFilesConnectionsHttpError = {
 };
 /**
  * Get the built-in connection used by the engine to load/write data files given a connection ID.
+ * @example
+ * getDataFileConnection(
+ *   "ee6a390c-5d33-11e8-9c2d-fa7ae01bbebc"
+ * )
  *
  * @param id The ID of the connection.
  * @throws GetDataFileConnectionHttpError
@@ -489,6 +526,10 @@ type GetDataFilesQuotasHttpError = {
 /**
  * Delete the specified data file or folder.  Deleting a folder will also recursively delete all files and
  * subfolders that reside within the specified folder.
+ * @example
+ * deleteDataFile(
+ *   "ee6a390c-5d33-11e8-9c2d-fa7ae01bbebc"
+ * )
  *
  * @param id The ID of the data file or folder to delete.
  * @throws DeleteDataFileHttpError
@@ -506,6 +547,10 @@ type DeleteDataFileHttpError = {
 };
 /**
  * Get descriptive info for the specified data file.
+ * @example
+ * getDataFile(
+ *   "ee6a390c-5d33-11e8-9c2d-fa7ae01bbebc"
+ * )
  *
  * @param id The ID of the data file.
  * @throws GetDataFileHttpError
@@ -645,6 +690,27 @@ declare function clearCache(): void;
 interface DataFilesAPI {
     /**
      * Get descriptive info for the specified data files.
+     * @example
+     * getDataFiles(
+     *   {
+     *     allowInternalFiles: false,
+     *     appId: "f34b91a1-0dc3-44ac-a847-51cb84122c84",
+     *     baseNameWildcard: "*SomeFileName*",
+     *     connectionId: "ee6a390c-5d33-11e8-9c2d-fa7ae01bbebc",
+     *     excludeFiles: false,
+     *     excludeSubFolders: false,
+     *     folderId: "ee6a390c-5d33-11e8-9c2d-fa7ae01bbebc",
+     *     folderPath: "some/folder",
+     *     includeAllSpaces: false,
+     *     includeFolders: false,
+     *     includeFolderStats: false,
+     *     limit: 5,
+     *     name: "MyFile.csv",
+     *     notOwnerId: "lDL4DIINndhL_iJkcbqWyJenuwizP-2D",
+     *     ownerId: "lDL4DIINndhL_iJkcbqWyJenuwizP-2D",
+     *     page: "NzlmNzI5NWMtZGJlZC00Y2Y4LThkNDAtMzQ5ZDU3YzNjMzQ1"
+     *   }
+     * )
      *
      * @param query an object with query parameters
      * @throws GetDataFilesHttpError
@@ -677,6 +743,18 @@ interface DataFilesAPI {
     /**
      * The non-filtered list contains a set of hardcoded connections, along with one connection per team space that
      * the given user has access to.
+     * @example
+     * getDataFilesConnections(
+     *   {
+     *     appId: "f34b91a1-0dc3-44ac-a847-51cb84122c84",
+     *     includeSpaceStats: false,
+     *     limit: 5,
+     *     name: "MySenseApp",
+     *     page: "NzlmNzI5NWMtZGJlZC00Y2Y4LThkNDAtMzQ5ZDU3YzNjMzQ1",
+     *     personal: true,
+     *     spaceId: "617979737a9f56e49dea2e6e"
+     *   }
+     * )
      *
      * @param query an object with query parameters
      * @throws GetDataFilesConnectionsHttpError
@@ -684,6 +762,10 @@ interface DataFilesAPI {
     getDataFilesConnections: typeof getDataFilesConnections;
     /**
      * Get the built-in connection used by the engine to load/write data files given a connection ID.
+     * @example
+     * getDataFileConnection(
+     *   "ee6a390c-5d33-11e8-9c2d-fa7ae01bbebc"
+     * )
      *
      * @param id The ID of the connection.
      * @throws GetDataFileConnectionHttpError
@@ -698,6 +780,10 @@ interface DataFilesAPI {
     /**
      * Delete the specified data file or folder.  Deleting a folder will also recursively delete all files and
      * subfolders that reside within the specified folder.
+     * @example
+     * deleteDataFile(
+     *   "ee6a390c-5d33-11e8-9c2d-fa7ae01bbebc"
+     * )
      *
      * @param id The ID of the data file or folder to delete.
      * @throws DeleteDataFileHttpError
@@ -705,6 +791,10 @@ interface DataFilesAPI {
     deleteDataFile: typeof deleteDataFile;
     /**
      * Get descriptive info for the specified data file.
+     * @example
+     * getDataFile(
+     *   "ee6a390c-5d33-11e8-9c2d-fa7ae01bbebc"
+     * )
      *
      * @param id The ID of the data file.
      * @throws GetDataFileHttpError

package/glossaries.d.ts

@@ -14,6 +14,19 @@ type JSONPatch = {
 };
 /**
  * An array of JSON Patch documents
+ * @example
+ * [
+ *   {
+ *     op: "replace",
+ *     path: "/name",
+ *     value: "new name"
+ *   },
+ *   {
+ *     op: "replace",
+ *     path: "/description",
+ *     value: "new description"
+ *   }
+ * ]
  */
 type JSONPatchArray = JSONPatch[];
 type AtlanEntity = {
@@ -866,7 +879,7 @@ type UpdateGlossaryTermHttpError = {
  */
 declare const changeGlossaryTermStatus: (id: string, termId: string, query: {
     /** The status to update to. */
-    status?: "draft" | "verified" | "deprecated";
+    status: "draft" | "verified" | "deprecated";
 }, options?: ApiCallOptions) => Promise<ChangeGlossaryTermStatusHttpResponse>;
 type ChangeGlossaryTermStatusHttpResponse = {
     data: Term;

package/groups.d.ts

@@ -16,6 +16,12 @@ type AssignedRoles = {
 }[];
 /**
  * An array of role reference identifiers.
+ * @example
+ * [
+ *   {
+ *     id: "507f191e810c19729de860ea"
+ *   }
+ * ]
  */
 type AssignedRolesRefIDs = {
     /** The unique role identitier */
@@ -23,6 +29,12 @@ type AssignedRolesRefIDs = {
 }[];
 /**
  * An array of role reference names.
+ * @example
+ * [
+ *   {
+ *     name: "TenantAdmin"
+ *   }
+ * ]
  */
 type AssignedRolesRefNames = {
     /** The name of the role */
@@ -52,6 +64,17 @@ type Error = {
 };
 /**
  * The error response object describing the error from the handling of an HTTP request.
+ * @example
+ * {
+ *   errors: [
+ *     {
+ *       code: "GROUPS-7",
+ *       status: 404,
+ *       title: "Not found"
+ *     }
+ *   ],
+ *   traceId: "00000000000000000137b213cf12a77b"
+ * }
  */
 type Errors = {
     /** An array of errors related to the operation. */
@@ -113,8 +136,34 @@ type GroupPatch = {
 };
 /**
  * An array of JSON Patches for a group.
+ * @example
+ * [
+ *   {
+ *     op: "replace",
+ *     value: [
+ *       {
+ *         name: "TenantAdmin"
+ *       },
+ *       {
+ *         name: "AnalyticsAdmin"
+ *       }
+ *     ]
+ *   }
+ * ]
  */
 type GroupPatchSchema = GroupPatch[];
+/**
+ * @example
+ * {
+ *   assignedRoles: [
+ *     {
+ *       name: "Developer"
+ *     }
+ *   ],
+ *   name: "Development",
+ *   status: "active"
+ * }
+ */
 type GroupPostSchema = {
     /** The roles to assign to the group (limit of 100 roles per group). */
     assignedRoles?: AssignedRolesRefIDs | AssignedRolesRefNames;
@@ -197,6 +246,27 @@ type SettingsPatch = {
 };
 /**
  * An array of JSON Patches for the groups settings.
+ * @example
+ * [
+ *   {
+ *     op: "replace",
+ *     path: "/syncIdpGroups",
+ *     value: true
+ *   },
+ *   {
+ *     op: "replace",
+ *     path: "/autoCreateGroups",
+ *     value: true
+ *   },
+ *   {
+ *     op: "replace",
+ *     value: [
+ *       {
+ *         name: "Steward"
+ *       }
+ *     ]
+ *   }
+ * ]
  */
 type SettingsPatchSchema = SettingsPatch[];
 /**

package/index.js

@@ -577,6 +577,10 @@ var spacesMiniModule = apiDefToApiPublic("spaces", {
           assignments: {
             "": ["getSpaceAssignments:GQ:", "createSpaceAssignment:PBJ:"],
             "{assignmentId}": ["deleteSpaceAssignment:D:", "getSpaceAssignment:G:", "updateSpaceAssignment:UBJ:"]
+          },
+          shares: {
+            "": ["getSpaceShares:GQ:", "createSpaceShare:PBJ:"],
+            "{shareId}": ["deleteSpaceShare:D:", "getSpaceShare:G:", "patchShare:ABJ:"]
           }
         }
       }

package/items.d.ts

@@ -129,7 +129,7 @@ type ItemMetaResponseBody = {
 /**
  * The case-sensitive string defining the item's type.
  */
-type ItemResourceTypeEnum = "app" | "collection" | "qlikview" | "insight" | "qvapp" | "genericlink" | "sharingservicetask" | "note" | "dataasset" | "dataset" | "automation" | "automl-experiment" | "automl-deployment";
+type ItemResourceTypeEnum = "app" | "qlikview" | "qvapp" | "genericlink" | "sharingservicetask" | "note" | "dataasset" | "dataset" | "automation" | "automl-experiment" | "automl-deployment";
 /**
  * An item.
  */

package/licenses.d.ts

@@ -1,6 +1,21 @@
 import { A as ApiCallOptions } from './invoke-fetch-types-BXn-uSF5.js';
 import './auth-types-PkN9CAF_.js';
 
+/**
+ * @example
+ * {
+ *   add: [
+ *     {
+ *       subject: "qlik\kalle",
+ *       type: "professional"
+ *     },
+ *     {
+ *       subject: "qlik\nalle",
+ *       type: "analyzer"
+ *     }
+ *   ]
+ * }
+ */
 type AssignmentsActionsAddRequest = {
     add: {
         /** User name */
@@ -14,6 +29,25 @@ type AssignmentsActionsAddRequest = {
         userId?: string;
     }[];
 };
+/**
+ * @example
+ * {
+ *   data: [
+ *     {
+ *       status: 201,
+ *       subject: "qlik\kalle",
+ *       type: "professional"
+ *     },
+ *     {
+ *       code: "LICENSES-011",
+ *       status: 403,
+ *       subject: "qlik\nalle",
+ *       title: "No available allotment error, No available allotment.",
+ *       type: "analyzer"
+ *     }
+ *   ]
+ * }
+ */
 type AssignmentsActionsAddResponse = {
     data: {
         /** Error code */
@@ -28,6 +62,17 @@ type AssignmentsActionsAddResponse = {
         type?: string;
     }[];
 };
+/**
+ * @example
+ * {
+ *   delete: [
+ *     {
+ *       subject: "qlik\malik",
+ *       type: "analyzer"
+ *     }
+ *   ]
+ * }
+ */
 type AssignmentsActionsDeleteRequest = {
     delete: {
         /** User subject */
@@ -36,6 +81,25 @@ type AssignmentsActionsDeleteRequest = {
         type: string;
     }[];
 };
+/**
+ * @example
+ * {
+ *   data: [
+ *     {
+ *       status: 200,
+ *       subject: "qlik\malik",
+ *       type: "professional"
+ *     },
+ *     {
+ *       code: "LICENSES-016",
+ *       status: 404,
+ *       subject: "qlik\no",
+ *       title: "Assignment not found.",
+ *       type: "analyzer"
+ *     }
+ *   ]
+ * }
+ */
 type AssignmentsActionsDeleteResponse = {
     data: {
         /** Error code */
@@ -50,6 +114,18 @@ type AssignmentsActionsDeleteResponse = {
         type?: string;
     }[];
 };
+/**
+ * @example
+ * {
+ *   update: [
+ *     {
+ *       sourceType: "analyzer",
+ *       subject: "qlik\malik",
+ *       type: "professional"
+ *     }
+ *   ]
+ * }
+ */
 type AssignmentsActionsUpdateRequest = {
     update: {
         /** The current user subject, in case that should be patched. */
@@ -62,6 +138,26 @@ type AssignmentsActionsUpdateRequest = {
         type?: string;
     }[];
 };
+/**
+ * @example
+ * {
+ *   data: [
+ *     {
+ *       sourceType: "analyzer",
+ *       status: 200,
+ *       subject: "qlik\malik",
+ *       type: "professional"
+ *     },
+ *     {
+ *       code: "LICENSES-016",
+ *       sourceType: "analyzer",
+ *       status: 404,
+ *       subject: "qlik/sara",
+ *       title: "Assignment not found."
+ *     }
+ *   ]
+ * }
+ */
 type AssignmentsActionsUpdateResponse = {
     data: {
         /** Error code */
@@ -80,6 +176,31 @@ type AssignmentsActionsUpdateResponse = {
         type?: string;
     }[];
 };
+/**
+ * @example
+ * {
+ *   data: [
+ *     {
+ *       created: "2020-12-03T09:24:48.114Z",
+ *       excess: false,
+ *       subject: "qlik\kalle",
+ *       type: "analyzer"
+ *     },
+ *     {
+ *       created: "2020-12-03T09:24:48.114Z",
+ *       subject: "qlik\nalle"
+ *     }
+ *   ],
+ *   links: {
+ *     next: {
+ *       href: "http://license/v1/licenses/assignments?limit=4&page=bmV4dDpGZ0FBQUFkZmFXUUFYOHBUcTlpM1U4UU1YWHZrQUE%3D"
+ *     },
+ *     prev: {
+ *       href: "http://license/v1/licenses/assignments?limit=4&page=cHJldjpGZ0FBQUFkZmFXUUFYOHBUcTlpM1U4UU1YWHZ0QUE%3D"
+ *     }
+ *   }
+ * }
+ */
 type AssignmentsResponse = {
     data: {
         /** Assignment created date. */
@@ -124,6 +245,19 @@ type ConsumptionEventsResponse = {
         prev?: Href;
     };
 };
+/**
+ * @example
+ * {
+ *   error: "util.Error",
+ *   errors: [
+ *     {
+ *       code: "LICENSES-123",
+ *       title: "error title"
+ *     }
+ *   ],
+ *   message: "error message"
+ * }
+ */
 type ErrorResponse = {
     /** @deprecated
      * Error type */
@@ -144,6 +278,43 @@ type Href = {
     /** link */
     href?: string;
 };
+/**
+ * @example
+ * {
+ *   allotments: [
+ *     {
+ *       name: "analyzer_time",
+ *       overage: 100,
+ *       units: 300,
+ *       unitsUsed: 242,
+ *       usageClass: "time"
+ *     },
+ *     {
+ *       name: "professional",
+ *       units: 200,
+ *       unitsUsed: 15,
+ *       usageClass: "assigned"
+ *     }
+ *   ],
+ *   licenseKey: "hejhbGciOiJSUzUxMiIsInR5cCI6IkpXVCIsImtpZCI6IktFWTEifQ.eyJqdGkiOiIxZjZkZTc0Zi04MDcyLTRjMTQtYjc1OS02ZjlkYmJmYWM5MjAiLCJsaWNlbnNlIjoiOTk5OTAwMDAwMDAwMTIzNCJ9.fwa6l6gY1MR_Ja2OMnV65V68fbzQYW5OAKUFnLfG9oZjNAbjhdDkZvS2S2zHaBnSrSva1ARh5iq_S0KTBOKKcJJDTb7jRVURyaAvbCuBDk_0ITrUudHaT9U_Mc9EKkfT8mR6vthhZxVzEhyYPFS7gDw7M6bav2ntpDsoJFPgous",
+ *   licenseNumber: "9999000000001204",
+ *   origin: "Internal",
+ *   parameters: [
+ *     {
+ *       name: "qlikAlerting",
+ *       valid: "./.",
+ *       values: {
+ *         "saas_alerting": "FULL"
+ *       }
+ *     }
+ *   ],
+ *   product: "Qlik Sense Enterprise SaaS",
+ *   secondaryNumber: "12345",
+ *   status: "Ok",
+ *   trial: false,
+ *   valid: "2018-01-01/2018-12-31"
+ * }
+ */
 type LicenseOverview = {
     allotments: {
         name: "professional" | "analyzer" | "analyzer_time";
@@ -153,6 +324,8 @@ type LicenseOverview = {
         unitsUsed: number;
         usageClass: string;
     }[];
+    /** the capability bank id */
+    capabilityBankId?: string;
     /** An ISO 8601 timestamp for when the license was last changed. */
     changeTime?: string;
     /** An ISO 8601 timestamp for when the latest time the license has been known to be valid, a missing value indicates the indefinite future. */
@@ -191,6 +364,17 @@ type LicenseOverview = {
     /** Period that the license is currently set to be active. Represented as an ISO 8601 time interval with start and end. */
     valid: string;
 };
+/**
+ * @example
+ * {
+ *   origin: "Internal",
+ *   product: "Qlik Sense Business",
+ *   status: "Ok",
+ *   trial: false,
+ *   type: "Signed",
+ *   valid: "2018-01-01/2018-12-31"
+ * }
+ */
 type LicenseStatus = {
     /** Origin of license key. */
     origin: "Internal" | "External";
@@ -205,6 +389,13 @@ type LicenseStatus = {
     /** Period that the license is currently set to be active. Represented as an ISO 8601 time interval with start and end. */
     valid: string;
 };
+/**
+ * @example
+ * {
+ *   autoAssignAnalyzer: true,
+ *   autoAssignProfessional: false
+ * }
+ */
 type SettingsBody = {
     /** If analyzer users are available, they will be automatically assigned. Otherwise, analyzer capacity will be assigned, if available. */
     autoAssignAnalyzer?: boolean;

package/package.json

@@ -14,11 +14,11 @@
     "enigma.js": "^2.14.0",
     "lodash": "^4.17.21",
     "nanoid": "^5.0.9",
-    "ws": "^8.18.0"
+    "ws": "^8.18.1"
   },
-  "packageManager": "pnpm@9.15.4",
+  "packageManager": "pnpm@10.4.1",
   "engines": {
-    "node": ">=18"
+    "node": ">=20"
   },
   "exports": {
     ".": "./index.js",
@@ -56,5 +56,5 @@
     "./qix": "./qix.js",
     "./auth": "./auth.js"
   },
-  "version": "1.28.0"
+  "version": "1.29.0"
 }

package/qix.d.ts

@@ -1,7 +1,7 @@
 import { H as HostConfig } from './auth-types-PkN9CAF_.js';
 import './invoke-fetch-types-BXn-uSF5.js';
 
-declare const QIX_SCHEMA_VERSION = "12.2309.0";
+declare const QIX_SCHEMA_VERSION = "12.2351.0";
 type AlfaNumString = {
     /**
      * Calculated value.
@@ -3752,6 +3752,12 @@ type NxDimensionInfo = {
      * Refers to a dimension stored in the library.
      */
     qLibraryId?: string;
+    /**
+     * The expanded and stripped dimension name used internally in engine.
+     *
+     * Stability: *experimental*
+     */
+    qEffectiveDimensionName?: string;
 };
 type NxDimensionType = "D" | "NX_DIMENSION_TYPE_DISCRETE" | "N" | "NX_DIMENSION_TYPE_NUMERIC" | "T" | "NX_DIMENSION_TYPE_TIME";
 type NxDownloadInfo = {
@@ -4156,6 +4162,7 @@ type NxLibraryDimension = {
      * Alias of the dimension.
      */
     qAlias?: string;
+    qScriptGenerated?: boolean;
 };
 type NxLibraryDimensionDef = {
     /**
@@ -4180,6 +4187,7 @@ type NxLibraryDimensionDef = {
      * Alias of the dimension.
      */
     qAlias?: string;
+    qScriptGenerated?: boolean;
 };
 /**
  * Information about the library measure. Is the layout for _NxLibraryMeasureDef_.
@@ -4203,6 +4211,7 @@ type NxLibraryMeasure = {
      * This parameter is optional.
      */
     qNumFormat?: FieldAttributes;
+    qScriptGenerated?: boolean;
 };
 type NxLibraryMeasureDef = {
     /**
@@ -4241,6 +4250,7 @@ type NxLibraryMeasureDef = {
      * This parameter is optional.
      */
     qNumFormat?: FieldAttributes;
+    qScriptGenerated?: boolean;
 };
 type NxLinkedObjectInfo = {
     /**
@@ -5187,6 +5197,12 @@ type NxTreeDimensionInfo = {
      * Refers to a dimension stored in the library.
      */
     qLibraryId?: string;
+    /**
+     * The expanded and stripped dimension name used internally in engine.
+     *
+     * Stability: *experimental*
+     */
+    qEffectiveDimensionName?: string;
 };
 type NxTreeMultiRangeSelectInfo = {
     /**

package/reload-tasks.d.ts

@@ -6,10 +6,28 @@ type Error = {
     detail?: string;
     title: string;
 };
+/**
+ * @example
+ * {
+ *   errors: [
+ *     {
+ *       code: "TASKS-123",
+ *       title: "short error message"
+ *     }
+ *   ],
+ *   traceId: "7975401f3954aa47"
+ * }
+ */
 type Errors = {
     errors?: Error[];
     traceId?: string;
 };
+/**
+ * @example
+ * {
+ *   href: "http://example.com"
+ * }
+ */
 type Href = {
     href: string;
 };
@@ -43,6 +61,8 @@ type Task = TaskBase & {
     /** @deprecated
      * The reason why the task was disabled. */
     log?: string;
+    /** A flag indicating whether the task has been migrated to the new scheduling service. */
+    migrated?: boolean;
     /** The next time the task will execute. */
     nextExecutionTime?: string;
     /** The space ID of the application */