@qlik/api 1.27.0 → 1.29.0

package/web-integrations.d.ts

@@ -25,6 +25,16 @@ type Error = {
 };
 /**
  * The error response object describing the error from the handling of an HTTP request.
+ * @example
+ * {
+ *   errors: [
+ *     {
+ *       code: "TENANTS-8",
+ *       title: "Not found"
+ *     }
+ *   ],
+ *   traceId: "000000000000000079cf1ebeae103de1"
+ * }
  */
 type Errors = {
     /** An array of errors related to the operation. */
@@ -62,6 +72,16 @@ type WebIntegrationPatch = {
     /** New value to be used for this operation. */
     value: string;
 };
+/**
+ * @example
+ * [
+ *   {
+ *     op: "replace",
+ *     path: "/name",
+ *     value: "New name"
+ *   }
+ * ]
+ */
 type WebIntegrationPatchSchema = WebIntegrationPatch[];
 /**
  * The creation of a web integration response.

package/web-integrations.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/web-integrations.ts

package/web-notifications.d.ts

@@ -70,6 +70,13 @@ type NotificationPatch = {
 };
 /**
  * An array of JSON Patch documents
+ * @example
+ * [
+ *   {
+ *     op: "replace",
+ *     path: "/read"
+ *   }
+ * ]
  */
 type NotificationPatchSchema = NotificationPatch[];
 type Notifications = {
@@ -81,6 +88,12 @@ type Notifications = {
 };
 /**
  * Retrieve notifications matching the query.
+ * @example
+ * getNotifications(
+ *   {
+ *     resourceType: "app,space"
+ *   }
+ * )
  *
  * @param query an object with query parameters
  * @throws GetNotificationsHttpError
@@ -201,6 +214,12 @@ declare function clearCache(): void;
 interface WebNotificationsAPI {
     /**
      * Retrieve notifications matching the query.
+     * @example
+     * getNotifications(
+     *   {
+     *     resourceType: "app,space"
+     *   }
+     * )
      *
      * @param query an object with query parameters
      * @throws GetNotificationsHttpError

package/web-notifications.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/web-notifications.ts

package/webhooks.d.ts

@@ -10,7 +10,7 @@ type Delivery = {
         /** The sent body/payload of the delivery */
         body?: unknown;
         /** Headers sent for this delivery */
-        headers?: unknown;
+        headers?: Record<string, string>;
         /** URL used for this delivery */
         url?: string;
     };
@@ -18,7 +18,7 @@ type Delivery = {
         /** The received body of the delivery */
         body?: string;
         /** Headers received for this delivery */
-        headers?: unknown;
+        headers?: Record<string, string>;
         /** The HTTP status code of the response */
         statusCode?: number;
     };
@@ -94,7 +94,7 @@ type WebhookBase = {
      * For more detailed information regarding the SCIM filter syntax (RFC7644) used please follow the link to external documentation. */
     filter?: string;
     /** Additional headers in the post request */
-    headers?: unknown;
+    headers?: Record<string, string>;
     /** The webhook's unique identifier */
     readonly id?: string;
     /** Defines at what level the webhook should operate: for all resources belonging to a tenant or restricted to only those accessible by the webhook-creator. */

package/webhooks.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/webhooks.ts