@qlik/api 1.27.0 → 1.29.0

package/data-connections.js

@@ -1,8 +1,8 @@
 import {
   clearApiCache,
   invokeFetch
-} from "./chunks/WY7IOA3Q.js";
-import "./chunks/V3TZ54UE.js";
+} from "./chunks/WQYEWU54.js";
+import "./chunks/2B7YWDQC.js";
 import "./chunks/2ZQ3ZX7F.js";
 
 // src/public/rest/data-connections.ts

package/data-credentials.d.ts

@@ -123,6 +123,13 @@ type FilterOrphanedDataCredentialsHttpError = {
 };
 /**
  * Deletes the specified credential by ID (or by name when type=credentialname is set in query)
+ * @example
+ * deleteDataCredential(
+ *   "027d2703-e745-43ec-8876-a2e6ac341700",
+ *   {
+ *     byCredentialName: false
+ *   }
+ * )
  *
  * @param qID Credential ID
  * @param query an object with query parameters
@@ -144,6 +151,13 @@ type DeleteDataCredentialHttpError = {
 };
 /**
  * Gets a credential by ID (or by name when bycredentialname=true is set in query)
+ * @example
+ * getDataCredential(
+ *   "027d2703-e745-43ec-8876-a2e6ac341700",
+ *   {
+ *     byCredentialName: false
+ *   }
+ * )
  *
  * @param qID Credential ID
  * @param query an object with query parameters
@@ -221,6 +235,13 @@ interface DataCredentialsAPI {
     filterOrphanedDataCredentials: typeof filterOrphanedDataCredentials;
     /**
      * Deletes the specified credential by ID (or by name when type=credentialname is set in query)
+     * @example
+     * deleteDataCredential(
+     *   "027d2703-e745-43ec-8876-a2e6ac341700",
+     *   {
+     *     byCredentialName: false
+     *   }
+     * )
      *
      * @param qID Credential ID
      * @param query an object with query parameters
@@ -229,6 +250,13 @@ interface DataCredentialsAPI {
     deleteDataCredential: typeof deleteDataCredential;
     /**
      * Gets a credential by ID (or by name when bycredentialname=true is set in query)
+     * @example
+     * getDataCredential(
+     *   "027d2703-e745-43ec-8876-a2e6ac341700",
+     *   {
+     *     byCredentialName: false
+     *   }
+     * )
      *
      * @param qID Credential ID
      * @param query an object with query parameters

package/data-credentials.js

@@ -1,8 +1,8 @@
 import {
   clearApiCache,
   invokeFetch
-} from "./chunks/WY7IOA3Q.js";
-import "./chunks/V3TZ54UE.js";
+} from "./chunks/WQYEWU54.js";
+import "./chunks/2B7YWDQC.js";
 import "./chunks/2ZQ3ZX7F.js";
 
 // src/public/rest/data-credentials.ts

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/data-files.js

@@ -1,8 +1,8 @@
 import {
   clearApiCache,
   invokeFetch
-} from "./chunks/WY7IOA3Q.js";
-import "./chunks/V3TZ54UE.js";
+} from "./chunks/WQYEWU54.js";
+import "./chunks/2B7YWDQC.js";
 import "./chunks/2ZQ3ZX7F.js";
 
 // src/public/rest/data-files.ts

package/extensions.js

@@ -1,8 +1,8 @@
 import {
   clearApiCache,
   invokeFetch
-} from "./chunks/WY7IOA3Q.js";
-import "./chunks/V3TZ54UE.js";
+} from "./chunks/WQYEWU54.js";
+import "./chunks/2B7YWDQC.js";
 import "./chunks/2ZQ3ZX7F.js";
 
 // src/public/rest/extensions.ts

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 = {
@@ -193,6 +206,7 @@ type ErrorResponseCode = {
 /**
  * ### Custom error codes
  * * BG-3 - Access denied, no read access
+ * * BG-30 - Feature not enabled on tenant.
  */
 type ErrorResponseForbidden = {
     errors?: ErrorResponseCode[];
@@ -865,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/glossaries.js

@@ -1,8 +1,8 @@
 import {
   clearApiCache,
   invokeFetch
-} from "./chunks/WY7IOA3Q.js";
-import "./chunks/V3TZ54UE.js";
+} from "./chunks/WQYEWU54.js";
+import "./chunks/2B7YWDQC.js";
 import "./chunks/2ZQ3ZX7F.js";
 
 // src/public/rest/glossaries.ts

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/groups.js

@@ -1,8 +1,8 @@
 import {
   clearApiCache,
   invokeFetch
-} from "./chunks/WY7IOA3Q.js";
-import "./chunks/V3TZ54UE.js";
+} from "./chunks/WQYEWU54.js";
+import "./chunks/2B7YWDQC.js";
 import "./chunks/2ZQ3ZX7F.js";
 
 // src/public/rest/groups.ts

package/identity-providers.js

@@ -1,8 +1,8 @@
 import {
   clearApiCache,
   invokeFetch
-} from "./chunks/WY7IOA3Q.js";
-import "./chunks/V3TZ54UE.js";
+} from "./chunks/WQYEWU54.js";
+import "./chunks/2B7YWDQC.js";
 import "./chunks/2ZQ3ZX7F.js";
 
 // src/public/rest/identity-providers.ts

package/index.js

@@ -1,17 +1,17 @@
 import {
   qix_default
-} from "./chunks/55SZVSAG.js";
+} from "./chunks/5XNSGPGZ.js";
 import {
   auth_default
-} from "./chunks/EOGHK2R4.js";
+} from "./chunks/KYCIMQ4L.js";
 import {
   interceptors_default
 } from "./chunks/3RGGGGAR.js";
 import {
   clearApiCache,
   invokeFetch
-} from "./chunks/WY7IOA3Q.js";
-import "./chunks/V3TZ54UE.js";
+} from "./chunks/WQYEWU54.js";
+import "./chunks/2B7YWDQC.js";
 import "./chunks/2ZQ3ZX7F.js";
 
 // src/runtime-api-generator/runtime-api-generator-common.ts
@@ -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/items.js

@@ -1,8 +1,8 @@
 import {
   clearApiCache,
   invokeFetch
-} from "./chunks/WY7IOA3Q.js";
-import "./chunks/V3TZ54UE.js";
+} from "./chunks/WQYEWU54.js";
+import "./chunks/2B7YWDQC.js";
 import "./chunks/2ZQ3ZX7F.js";
 
 // src/public/rest/items.ts