@qlik/api 1.28.0 → 1.30.0

package/users.d.ts

@@ -16,6 +16,13 @@ type AssignedGroups = {
 }[];
 /**
  * An array of group reference names and provider type.
+ * @example
+ * [
+ *   {
+ *     name: "Developers",
+ *     providerType: "custom"
+ *   }
+ * ]
  */
 type AssignedGroupsRefNames = {
     /** The name of the group */
@@ -75,6 +82,17 @@ type ErrorItem = {
 };
 /**
  * The error response object describing the error from the handling of an HTTP request.
+ * @example
+ * {
+ *   errors: [
+ *     {
+ *       code: "USERS-7",
+ *       status: 404,
+ *       title: "Not found"
+ *     }
+ *   ],
+ *   traceId: "000000000000000079cf1ebeae103de1"
+ * }
  */
 type Errors = {
     /** An array of errors related to the operation. */
@@ -136,10 +154,58 @@ type JSONPatch = {
 };
 /**
  * An array of JSON Patch documents
+ * @example
+ * [
+ *   {
+ *     op: "replace",
+ *     path: "/name",
+ *     value: "John"
+ *   },
+ *   {
+ *     op: "replace",
+ *     path: "/assignedRoles",
+ *     value: [
+ *       {
+ *         "name": "Developer"
+ *       }
+ *     ]
+ *   },
+ *   {
+ *     op: "replace",
+ *     value: "unicorn@corp.example"
+ *   },
+ *   {
+ *     op: "replace",
+ *     value: "America/Halifax"
+ *   },
+ *   {
+ *     op: "replace",
+ *     path: "/preferredLocale",
+ *     value: "en_US_POSIX"
+ *   },
+ *   {
+ *     op: "replace",
+ *     path: "/status",
+ *     value: "active"
+ *   },
+ *   {
+ *     op: "add"
+ *   },
+ *   {
+ *     op: "remove-value",
+ *     path: "/assignedRoles"
+ *   }
+ * ]
  */
 type JSONPatchArray = JSONPatch[];
 /**
  * An array of entity reference identifiers (e.g. roles, groups).
+ * @example
+ * [
+ *   {
+ *     id: "507f191e810c19729de860ea"
+ *   }
+ * ]
  */
 type RefIDs = {
     /** The unique identitier */
@@ -147,6 +213,12 @@ type RefIDs = {
 }[];
 /**
  * An array of reference names (e.g. roles).
+ * @example
+ * [
+ *   {
+ *     name: "TenantAdmin"
+ *   }
+ * ]
  */
 type RefNames = {
     /** The name of the entity */
@@ -228,6 +300,22 @@ type UserCount = {
     /** The total number of users in the tenant. */
     total: number;
 };
+/**
+ * @example
+ * {
+ *   assignedRoles: [
+ *     {
+ *       name: "Developer"
+ *     }
+ *   ],
+ *   email: "john.smith@corp.example",
+ *   name: "John Smith",
+ *   picture: "https://corp.example/docs/jsmith.png",
+ *   status: "invited",
+ *   subject: "1234asdasa6789",
+ *   tenantId: "q3VRZ4YMixRaLKEPhkZWM-XMIDN7cO8f"
+ * }
+ */
 type UserPostSchema = {
     /** The roles to assign to the user. */
     assignedRoles?: RefIDs | RefNames;

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

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/WQYEWU54.js";
-import "./chunks/2B7YWDQC.js";
+} from "./chunks/PTDXR7AY.js";
+import "./chunks/TXC5XORK.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/WQYEWU54.js";
-import "./chunks/2B7YWDQC.js";
+} from "./chunks/PTDXR7AY.js";
+import "./chunks/TXC5XORK.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/WQYEWU54.js";
-import "./chunks/2B7YWDQC.js";
+} from "./chunks/PTDXR7AY.js";
+import "./chunks/TXC5XORK.js";
 import "./chunks/2ZQ3ZX7F.js";
 
 // src/public/rest/webhooks.ts