feat: qlik api updates (#114)

Co-authored-by: qlikossbuild <open_source@qlik.com>
qlik-oss · Mar 3, 2025 · 4ff1dec · 4ff1dec
1 parent 8baaefd
commit 4ff1dec
Show file tree

Hide file tree

Showing 26 changed files with 1,356 additions and 72 deletions.
diff --git a/api-keys.d.ts b/api-keys.d.ts
@@ -89,7 +89,27 @@ type ApiKeysConfig = {
     /** The expiry of the scim `externalClient` token in ISO8601 duration format, e.g. `P365D` for 365 days. Used during the creation of an `externalClient` API key for configuring a SCIM compatible Identity Provider. */
     scim_externalClient_expiry?: string;
 };
+/**
+ * @example
+ * [
+ *   {
+ *     op: "replace",
+ *     path: "/api_keys_enabled",
+ *     value: true
+ *   }
+ * ]
+ */
 type ApiKeysConfigPatchSchema = ApiKeyConfigPatch[];
+/**
+ * @example
+ * [
+ *   {
+ *     op: "replace",
+ *     path: "/description",
+ *     value: "my new description"
+ *   }
+ * ]
+ */
 type ApiKeysPatchSchema = ApiKeyPatch[];
 /**
  * An error object.

diff --git a/apps.d.ts b/apps.d.ts
diff --git a/audits.d.ts b/audits.d.ts
@@ -156,7 +156,7 @@ type GetAuditsHttpError = {
  */
 declare const getArchivedAudits: (query: {
     /** Date to be used as filter and criteria during extraction. */
-    date?: string;
+    date: string;
 }, options?: ApiCallOptions) => Promise<GetArchivedAuditsHttpResponse>;
 type GetArchivedAuditsHttpResponse = {
     data: GetArchiveResult;

diff --git a/automations.d.ts b/automations.d.ts
@@ -189,6 +189,12 @@ type UsageObject = {
 };
 /**
  * Retrieves a list of automations
+ * @example
+ * getAutomations(
+ *   {
+ *     fields: "lastRun,lastRunStatus,runMode,createdAt,updatedAt"
+ *   }
+ * )
  *
  * @param query an object with query parameters
  * @throws GetAutomationsHttpError
@@ -242,7 +248,7 @@ declare const getAutomationsUsageMetrics: (query: {
     /** If specified, result will be broken apart for each automation */
     breakdownBy?: string;
     /** Indicates how the metrics should be filtered */
-    filter?: string;
+    filter: string;
 }, options?: ApiCallOptions) => Promise<GetAutomationsUsageMetricsHttpResponse>;
 type GetAutomationsUsageMetricsHttpResponse = {
     data: UsageList;
@@ -557,6 +563,12 @@ declare function clearCache(): void;
 interface AutomationsAPI {
     /**
      * Retrieves a list of automations
+     * @example
+     * getAutomations(
+     *   {
+     *     fields: "lastRun,lastRunStatus,runMode,createdAt,updatedAt"
+     *   }
+     * )
      *
      * @param query an object with query parameters
      * @throws GetAutomationsHttpError

diff --git a/data-assets.d.ts b/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;

diff --git a/data-connections.d.ts b/data-connections.d.ts
@@ -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

diff --git a/data-credentials.d.ts b/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