@qlik/api 1.28.0 → 1.30.0

package/chunks/{5MRIMVKS.js → F5UDCCRD.js}

@@ -1,4 +1,4 @@
-// node_modules/.pnpm/@qlik+runtime-module-loader@1.0.17/node_modules/@qlik/runtime-module-loader/dist/index.js
+// node_modules/.pnpm/@qlik+runtime-module-loader@1.0.20/node_modules/@qlik/runtime-module-loader/dist/index.js
 window.__qlikMainPrivateResolvers = window.__qlikMainPrivateResolvers || {};
 window.__qlikMainPrivateResolvers.mainUrlPromise = window.__qlikMainPrivateResolvers.mainUrlPromise || new Promise((resolve) => {
   window.__qlikMainPrivateResolvers.resolveMainJsUrl = (value) => resolve(value);
@@ -7,22 +7,27 @@ window.__qlikMainPrivateResolvers.qlikMainPromise = window.__qlikMainPrivateReso
   if (window.QlikMain) {
     return window.QlikMain;
   }
+  const noHostWarningTimer = setTimeout(() => {
+    console.warn("Waiting for a host parameter pointing to a Qlik runtime system");
+  }, 5e3);
   const url = await window.__qlikMainPrivateResolvers.mainUrlPromise;
+  clearTimeout(noHostWarningTimer);
   return new Promise((resolve) => {
     if (window.QlikMain) {
       resolve(window.QlikMain);
+    } else {
+      const script = window.document.createElement("script");
+      script.src = url;
+      script.addEventListener("error", () => {
+        console.error(`Qlik runtime system not found: ${url}`);
+      });
+      script.addEventListener("load", () => {
+        if (window.QlikMain) {
+          resolve(window.QlikMain);
+        }
+      });
+      window.document.head.appendChild(script);
     }
-    const script = window.document.createElement("script");
-    script.src = url;
-    script.addEventListener("error", () => {
-      console.error(`Qlik runtime system not found: ${url}`);
-    });
-    script.addEventListener("load", () => {
-      if (window.QlikMain) {
-        resolve(window.QlikMain);
-      }
-    });
-    window.document.head.appendChild(script);
   });
 })();
 function provideHostConfigForMainJsUrl(hostConfig) {
@@ -30,9 +35,6 @@ function provideHostConfigForMainJsUrl(hostConfig) {
   function toMainJsUrl(hc) {
     const url = hc?.embedRuntimeUrl || hc?.url || hc?.host;
     if (!url) {
-      window.__qlikMainPrivateResolvers.noHostWarningTimer = setTimeout(() => {
-        console.warn("Waiting for a host parameter pointing to a Qlik runtime system");
-      }, 5e3);
       return void 0;
     }
     let locationUrl;
@@ -46,11 +48,6 @@ function provideHostConfigForMainJsUrl(hostConfig) {
   }
   const potentialMainJsUrl = toMainJsUrl(hostConfig);
   if (potentialMainJsUrl) {
-    const warningTimer = window.__qlikMainPrivateResolvers.noHostWarningTimer;
-    if (warningTimer) {
-      window.__qlikMainPrivateResolvers.noHostWarningTimer = void 0;
-      clearTimeout(warningTimer);
-    }
     window.__qlikMainPrivateResolvers.resolveMainJsUrl(potentialMainJsUrl);
   }
 }

package/chunks/{QOOCP2TS.js → FKCZFVJL.js}

@@ -3,7 +3,7 @@ import {
   getRestCallAuthParams,
   getWebSocketAuthParams,
   toValidWebsocketLocationUrl
-} from "./NBW6PHZU.js";
+} from "./G6QUM5WQ.js";
 import "./3RGGGGAR.js";
 import {
   isNode

package/chunks/{NBW6PHZU.js → G6QUM5WQ.js}

@@ -22,21 +22,21 @@ var getPlatform = async (options = {}) => {
   const deploymentType = (productInfo.composition?.deploymentType || "").toLowerCase();
   const isControlCenter = deploymentType === "controlcenter";
   if (deploymentType === "qliksenseserver") {
-    return result({ isQSE: true, isWindows: true });
+    return result({ isQSE: true, isWindows: true, meta: extractMeta(productInfo) });
   }
   if (deploymentType === "qliksensedesktop") {
-    return result({ isQSD: true, isWindows: true });
+    return result({ isQSD: true, isWindows: true, meta: extractMeta(productInfo) });
   }
   if (deploymentType === "qliksensemobile") {
-    return result({ isQSE: true, isWindows: true });
+    return result({ isQSE: true, isWindows: true, meta: extractMeta(productInfo) });
   }
   if (deploymentType === "cloud-console") {
-    return result({ isCloud: true, isCloudConsole: true });
+    return result({ isCloud: true, isCloudConsole: true, meta: extractMeta(productInfo) });
   }
   if (productInfo.composition?.provider === "fedramp") {
-    return result({ isCloud: true, isQCG: true, isControlCenter });
+    return result({ isCloud: true, isQCG: true, isControlCenter, meta: extractMeta(productInfo) });
   }
-  return result({ isCloud: true, isQCS: true, isControlCenter });
+  return result({ isCloud: true, isQCS: true, isControlCenter, meta: extractMeta(productInfo) });
 };
 var productInfoPromises = {};
 function templateUrl(baseUrl) {
@@ -73,6 +73,27 @@ var getProductInfo = async ({ hostConfig, noCache } = {}) => {
     }
   }
 };
+var extractMeta = (data) => {
+  const urls = data.externalUrls;
+  if (!urls) {
+    return void 0;
+  }
+  const productName = data.composition?.productName ?? "Qlik";
+  const releaseLabel = data.composition?.releaseLabel || "-";
+  const productLabel = releaseLabel === "-" ? productName : `${productName} (${releaseLabel})`;
+  return {
+    productId: data.composition?.senseId ?? "qlik",
+    productLabel,
+    version: data.composition?.version,
+    urls: {
+      personalHelpBaseUrl: urls.personalHelpBaseUrl,
+      personalUpgradeBase: urls.personalUpgradeBase,
+      personalUpgradeUrl: urls.personalUpgradeUrl,
+      serverHelpBaseUrl: urls.serverHelpBaseUrl,
+      qlikWebPageUrl: urls.qlikWebPageUrl
+    }
+  };
+};
 var result = (data) => ({
   isNodeEnv: false,
   isCloud: false,

package/chunks/{5XNSGPGZ.js → IQBP2PKS.js}

@@ -1,6 +1,6 @@
 import {
   getQixRuntimeModule
-} from "./2B7YWDQC.js";
+} from "./TXC5XORK.js";
 
 // src/public/qix.ts
 function openAppSession(appSessionProps) {

package/chunks/{2BRBIRM2.js → JIX6RMFP.js}

@@ -5,7 +5,7 @@ import {
   invokeFetch,
   invoke_fetch_default,
   parseFetchResponse
-} from "./NBW6PHZU.js";
+} from "./G6QUM5WQ.js";
 import "./3RGGGGAR.js";
 import "./2ZQ3ZX7F.js";
 export {

package/chunks/{4D5NADHK.js → OTTC4QSX.js}

@@ -19,7 +19,7 @@ import {
   setDefaultHostConfig,
   toValidLocationUrl,
   toValidWebsocketLocationUrl
-} from "./NBW6PHZU.js";
+} from "./G6QUM5WQ.js";
 import "./3RGGGGAR.js";
 import "./2ZQ3ZX7F.js";
 export {

package/chunks/{WQYEWU54.js → PTDXR7AY.js}

@@ -1,12 +1,12 @@
 import {
   getInvokeFetchRuntimeModule
-} from "./2B7YWDQC.js";
+} from "./TXC5XORK.js";
 import {
   isBrowser
 } from "./2ZQ3ZX7F.js";
 
 // src/public/invoke-fetch.ts
-var defaultUserAgent = "qlik-api/1.28.0";
+var defaultUserAgent = "qlik-api/1.30.0";
 async function invokeFetch(api, props) {
   const hostConfig = props.options?.hostConfig;
   let userAgent;

package/chunks/{KYCIMQ4L.js → QK4TMJ64.js}

@@ -1,6 +1,6 @@
 import {
   getAuthRuntimeModule
-} from "./2B7YWDQC.js";
+} from "./TXC5XORK.js";
 
 // src/public/auth.ts
 function registerAuthModule(name, authModule) {

package/chunks/{MGXEGSJC.js → QWQLGDMI.js}

@@ -4,7 +4,7 @@ import {
   invokeFetch,
   isWindows,
   toValidWebsocketLocationUrl
-} from "./NBW6PHZU.js";
+} from "./G6QUM5WQ.js";
 import "./3RGGGGAR.js";
 import {
   isBrowser
@@ -161,7 +161,7 @@ function listenForWindowsAuthenticationInformation(session) {
   return authSuggestedInWebsocket;
 }
 async function createAndSetupEnigmaSession(props, canRetry) {
-  const { createEnigmaSession } = await import("./QOOCP2TS.js");
+  const { createEnigmaSession } = await import("./FKCZFVJL.js");
   const session = await createEnigmaSession(props);
   setupSessionListeners(session, props);
   let global;

package/chunks/{2B7YWDQC.js → TXC5XORK.js}

@@ -1,21 +1,21 @@
 // src/public/public-runtime-modules.ts
 function getAuthRuntimeModule(hostConfig) {
   const isNode = !!globalThis.process?.argv;
-  return isNode ? import("./4D5NADHK.js") : import("./5MRIMVKS.js").then(
+  return isNode ? import("./OTTC4QSX.js") : import("./F5UDCCRD.js").then(
     (mod) => mod.importRuntimeModule("auth@v1", hostConfig)
   );
 }
 async function getQixRuntimeModule(hostConfig) {
   await getAuthRuntimeModule(hostConfig);
   const isNode = !!globalThis.process?.argv;
-  return isNode ? import("./MGXEGSJC.js") : import("./5MRIMVKS.js").then(
+  return isNode ? import("./QWQLGDMI.js") : import("./F5UDCCRD.js").then(
     (mod) => mod.importRuntimeModule("qix@v1", hostConfig)
   );
 }
 async function getInvokeFetchRuntimeModule(hostConfig) {
   await getAuthRuntimeModule(hostConfig);
   const isNode = !!globalThis.process?.argv;
-  return isNode ? import("./2BRBIRM2.js") : import("./5MRIMVKS.js").then(
+  return isNode ? import("./JIX6RMFP.js") : import("./F5UDCCRD.js").then(
     (mod) => mod.importRuntimeModule("invoke-fetch@v1", hostConfig)
   );
 }

package/collections.d.ts

@@ -121,7 +121,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/collections.js

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

package/csp-origins.js

@@ -1,8 +1,8 @@
 import {
   clearApiCache,
   invokeFetch
-} from "./chunks/WQYEWU54.js";
-import "./chunks/2B7YWDQC.js";
+} from "./chunks/PTDXR7AY.js";
+import "./chunks/TXC5XORK.js";
 import "./chunks/2ZQ3ZX7F.js";
 
 // src/public/rest/csp-origins.ts

package/data-assets.d.ts

@@ -25,7 +25,7 @@ type DataAsset = {
     /** The value is automatically set by the application. */
     ownerId?: string;
     /** A Map of name-value pairs. */
-    properties?: unknown;
+    properties?: Record<string, unknown>;
     spaceId?: string;
     tags?: string[];
     technicalDescription?: string;

package/data-assets.js

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

package/data-connections.d.ts

@@ -156,7 +156,7 @@ type ConnectionGet = {
     qSeparateCredentials: boolean;
     /** Type of connection, i.e. provider type of underlying connector */
     qType: string;
-    /** Encrypted base Qri string */
+    /** Encrypted base Qri string (filterable using SCIM filter, e.g. filter='qri co "snowflake"') */
     qri?: string;
     /** ID of the space to which the connection belongs */
     space?: string;
@@ -265,6 +265,8 @@ type PatchRequest = {
 };
 /**
  * Access type allowed on associated data connection
+ * @example
+ * "list"
  */
 type Privilege = "list" | "update" | "delete" | "read" | "change_owner" | "change_space";
 type ResponseErrors = {
@@ -289,6 +291,25 @@ type TopLevelLink = {
 };
 /**
  * Gets a list of connections
+ * @example
+ * getDataConnections(
+ *   {
+ *     dataName: "data",
+ *     extended: false,
+ *     spaceId: "611bcebaeec1203d88211ac4",
+ *     personal: false,
+ *     owner: "928e2a66-01ba-4678-aa32-e74c213896fa",
+ *     ownedByMe: true,
+ *     limit: 30,
+ *     sort: "+qName",
+ *     page: "page=JwAAAAljcmVhdGVkAPfQ-sx0AQAAB19pZABfb93nZcM4SN1M0e8A",
+ *     noDatafiles: true,
+ *     userId: "6K9xjsItDexffolu5vg1oWYkY8x7f-0G",
+ *     caseinsensitive: true,
+ *     locale: "en",
+ *     includeQris: true
+ *   }
+ * )
  *
  * @param query an object with query parameters
  * @throws GetDataConnectionsHttpError
@@ -407,6 +428,14 @@ type UpdateDataConnectionsHttpError = {
 };
 /**
  * Deletes the specified data connection by ID (or by name when type=connectionname is set in query)
+ * @example
+ * deleteDataConnection(
+ *   "82ee7b44-0c4d-491b-bd38-82640c0430a5",
+ *   {
+ *     type: "connectionname",
+ *     spaceId: "611bcebaeec1203d88211ac4"
+ *   }
+ * )
  *
  * @param qID Connection ID
  * @param query an object with query parameters
@@ -430,6 +459,19 @@ type DeleteDataConnectionHttpError = {
 };
 /**
  * Retrieves a connection by connection ID, or by name when the query parameter "type" is set to "connectionname."
+ * @example
+ * getDataConnection(
+ *   "82ee7b44-0c4d-491b-bd38-82640c0430a5",
+ *   {
+ *     extended: false,
+ *     type: "connectionname",
+ *     credentialId: "22379dc5-076e-4fec-ae20-5529a8a57dc2",
+ *     byCredentialName: false,
+ *     spaceId: "611bcebaeec1203d88211ac4",
+ *     noCache: false,
+ *     parseConnection: true
+ *   }
+ * )
  *
  * @param qID Connection ID
  * @param query an object with query parameters
@@ -514,6 +556,25 @@ declare function clearCache(): void;
 interface DataConnectionsAPI {
     /**
      * Gets a list of connections
+     * @example
+     * getDataConnections(
+     *   {
+     *     dataName: "data",
+     *     extended: false,
+     *     spaceId: "611bcebaeec1203d88211ac4",
+     *     personal: false,
+     *     owner: "928e2a66-01ba-4678-aa32-e74c213896fa",
+     *     ownedByMe: true,
+     *     limit: 30,
+     *     sort: "+qName",
+     *     page: "page=JwAAAAljcmVhdGVkAPfQ-sx0AQAAB19pZABfb93nZcM4SN1M0e8A",
+     *     noDatafiles: true,
+     *     userId: "6K9xjsItDexffolu5vg1oWYkY8x7f-0G",
+     *     caseinsensitive: true,
+     *     locale: "en",
+     *     includeQris: true
+     *   }
+     * )
      *
      * @param query an object with query parameters
      * @throws GetDataConnectionsHttpError
@@ -549,6 +610,14 @@ interface DataConnectionsAPI {
     updateDataConnections: typeof updateDataConnections;
     /**
      * Deletes the specified data connection by ID (or by name when type=connectionname is set in query)
+     * @example
+     * deleteDataConnection(
+     *   "82ee7b44-0c4d-491b-bd38-82640c0430a5",
+     *   {
+     *     type: "connectionname",
+     *     spaceId: "611bcebaeec1203d88211ac4"
+     *   }
+     * )
      *
      * @param qID Connection ID
      * @param query an object with query parameters
@@ -557,6 +626,19 @@ interface DataConnectionsAPI {
     deleteDataConnection: typeof deleteDataConnection;
     /**
      * Retrieves a connection by connection ID, or by name when the query parameter "type" is set to "connectionname."
+     * @example
+     * getDataConnection(
+     *   "82ee7b44-0c4d-491b-bd38-82640c0430a5",
+     *   {
+     *     extended: false,
+     *     type: "connectionname",
+     *     credentialId: "22379dc5-076e-4fec-ae20-5529a8a57dc2",
+     *     byCredentialName: false,
+     *     spaceId: "611bcebaeec1203d88211ac4",
+     *     noCache: false,
+     *     parseConnection: true
+     *   }
+     * )
      *
      * @param qID Connection ID
      * @param query an object with query parameters

package/data-connections.js

@@ -1,8 +1,8 @@
 import {
   clearApiCache,
   invokeFetch
-} from "./chunks/WQYEWU54.js";
-import "./chunks/2B7YWDQC.js";
+} from "./chunks/PTDXR7AY.js";
+import "./chunks/TXC5XORK.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/WQYEWU54.js";
-import "./chunks/2B7YWDQC.js";
+} from "./chunks/PTDXR7AY.js";
+import "./chunks/TXC5XORK.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/WQYEWU54.js";
-import "./chunks/2B7YWDQC.js";
+} from "./chunks/PTDXR7AY.js";
+import "./chunks/TXC5XORK.js";
 import "./chunks/2ZQ3ZX7F.js";
 
 // src/public/rest/data-files.ts