@qlik/api 1.18.0 → 1.20.0

package/groups.d.ts

@@ -74,6 +74,10 @@ type Group = {
     assignedRoles?: AssignedRoles;
     /** The timestamp for when the group record was created. */
     createdAt: string;
+    /** Id of user that created role. */
+    readonly createdBy?: string;
+    /** A description of a custom group. */
+    description?: string;
     /** The unique identifier for the group */
     readonly id: string;
     /** The timestamp for when the group record was last updated. */
@@ -87,10 +91,14 @@ type Group = {
     };
     /** The name of the group. */
     name: string;
+    /** The type of provider for the group. */
+    providerType?: "idp" | "custom";
     /** The state of the group. */
     status: "active" | "disabled";
     /** The tenant identifier associated with the given group */
     tenantId: string;
+    /** Id of user that last updated this role. */
+    readonly updatedBy?: string;
 };
 /**
  * A JSON Patch document.
@@ -98,8 +106,8 @@ type Group = {
 type GroupPatch = {
     /** The operation to be performed. Currently "replace" is the only supported operation. */
     op: "replace";
-    /** Attribute name of a field of the Groups entity. */
-    path: "assignedRoles";
+    /** Attribute name of a field of the Groups entity. "Name" and "description" is only available for custom groups. */
+    path: "assignedRoles" | "name" | "description";
     /** The roles to assign to the group (limit of 100 roles per group). */
     value: AssignedRolesRefIDs | AssignedRolesRefNames;
 };
@@ -110,8 +118,12 @@ type GroupPatchSchema = GroupPatch[];
 type GroupPostSchema = {
     /** The roles to assign to the group (limit of 100 roles per group). */
     assignedRoles?: AssignedRolesRefIDs | AssignedRolesRefNames;
+    /** The description of the group. */
+    description?: string;
     /** The name of the group (maximum length of 256 characters). */
     name: string;
+    /** The type of group provider. Must be "idp" or "custom". Defaults to "idp" if not provided. */
+    providerType?: "idp" | "custom";
     /** The status of the created group within the tenant. Defaults to active if empty. */
     status?: "active";
 };
@@ -222,7 +234,7 @@ type GetGroupsHttpError = {
     status: number;
 };
 /**
- * Creates a group. The maximum number of groups a tenant can have is 10,000.
+ * Creates a new group. The maximum number of groups a tenant can have is 10,000. Group names are case-sensitive, and must be unique.
  *
  * @param body an object with the body content
  * @throws CreateGroupHttpError
@@ -268,7 +280,7 @@ type FilterGroupsHttpError = {
     status: number;
 };
 /**
- * Returns the active tenant's group settings.
+ * Returns the tenant's group settings, such as whether automatic group creation and IdP group synchronization are enabled or disabled, and roles assigned to system groups.
  *
  * @throws GetGroupsSettingsHttpError
  */
@@ -284,7 +296,7 @@ type GetGroupsSettingsHttpError = {
     status: number;
 };
 /**
- * Update group settings
+ * Updates the tenant's group settings, such as whether automatic group creation and IdP group synchronization are enabled or disabled, and roles assigned to system groups.
  *
  * @param body an object with the body content
  * @throws PatchGroupsSettingsHttpError
@@ -301,7 +313,7 @@ type PatchGroupsSettingsHttpError = {
     status: number;
 };
 /**
- * Delete group by id
+ * Deletes the requested group.
  *
  * @param groupId The ID of the group to delete.
  * @throws DeleteGroupHttpError
@@ -335,7 +347,7 @@ type GetGroupHttpError = {
     status: number;
 };
 /**
- * Update group by id
+ * Updates the requested group.
  *
  * @param groupId The ID of the group to update.
  * @param body an object with the body content
@@ -365,7 +377,7 @@ interface GroupsAPI {
      */
     getGroups: typeof getGroups;
     /**
-     * Creates a group. The maximum number of groups a tenant can have is 10,000.
+     * Creates a new group. The maximum number of groups a tenant can have is 10,000. Group names are case-sensitive, and must be unique.
      *
      * @param body an object with the body content
      * @throws CreateGroupHttpError
@@ -380,20 +392,20 @@ interface GroupsAPI {
      */
     filterGroups: typeof filterGroups;
     /**
-     * Returns the active tenant's group settings.
+     * Returns the tenant's group settings, such as whether automatic group creation and IdP group synchronization are enabled or disabled, and roles assigned to system groups.
      *
      * @throws GetGroupsSettingsHttpError
      */
     getGroupsSettings: typeof getGroupsSettings;
     /**
-     * Update group settings
+     * Updates the tenant's group settings, such as whether automatic group creation and IdP group synchronization are enabled or disabled, and roles assigned to system groups.
      *
      * @param body an object with the body content
      * @throws PatchGroupsSettingsHttpError
      */
     patchGroupsSettings: typeof patchGroupsSettings;
     /**
-     * Delete group by id
+     * Deletes the requested group.
      *
      * @param groupId The ID of the group to delete.
      * @throws DeleteGroupHttpError
@@ -407,7 +419,7 @@ interface GroupsAPI {
      */
     getGroup: typeof getGroup;
     /**
-     * Update group by id
+     * Updates the requested group.
      *
      * @param groupId The ID of the group to update.
      * @param body an object with the body content

package/groups.js

@@ -1,8 +1,8 @@
 import {
   clearApiCache,
   invokeFetch
-} from "./chunks/2NXPFUPZ.js";
-import "./chunks/ZLPAS7FC.js";
+} from "./chunks/T6AQ34ZJ.js";
+import "./chunks/IMLCMV4X.js";
 import "./chunks/2ZQ3ZX7F.js";
 
 // src/public/rest/groups.ts

package/identity-providers.js

@@ -1,8 +1,8 @@
 import {
   clearApiCache,
   invokeFetch
-} from "./chunks/2NXPFUPZ.js";
-import "./chunks/ZLPAS7FC.js";
+} from "./chunks/T6AQ34ZJ.js";
+import "./chunks/IMLCMV4X.js";
 import "./chunks/2ZQ3ZX7F.js";
 
 // src/public/rest/identity-providers.ts

package/index.d.ts

@@ -1,5 +1,5 @@
-import { openAppSession } from './qix.js';
-import { registerAuthModule, setDefaultHostConfig, getAccessToken } from './auth.js';
+import { registerAuthModule, setDefaultHostConfig, getAccessToken, AuthAPI } from './auth.js';
+import { QixAPI } from './qix.js';
 import { ApiKeysAPI } from './api-keys.js';
 import { AppsAPI } from './apps.js';
 import { AuditsAPI } from './audits.js';
@@ -31,8 +31,8 @@ import { UsersAPI } from './users.js';
 import { WebIntegrationsAPI } from './web-integrations.js';
 import { WebNotificationsAPI } from './web-notifications.js';
 import { WebhooksAPI } from './webhooks.js';
+import { H as HostConfig } from './auth-types-PkN9CAF_.js';
 import './global.types--37uwGji.js';
-import './auth-types-PkN9CAF_.js';
 
 declare const apiKeys: ApiKeysAPI;
 declare const apps: AppsAPI;
@@ -56,8 +56,8 @@ declare const groups: GroupsAPI;
 declare const identityProviders: IdentityProvidersAPI;
 declare const items: ItemsAPI;
 declare const licenses: LicensesAPI;
-declare const qix: {
-    openAppSession: typeof openAppSession;
+declare const qix: QixAPI & {
+    withHostConfig: (hostConfig: HostConfig | undefined) => QixAPI;
 };
 declare const quotas: QuotasAPI;
 declare const reloadTasks: ReloadTasksAPI;
@@ -75,73 +75,80 @@ declare const webNotifications: WebNotificationsAPI;
 declare const webhooks: WebhooksAPI;
 interface QlikAPI {
     /** Functions for the apiKeys api */
-    apiKeys: typeof apiKeys;
+    apiKeys: ApiKeysAPI;
     /** Functions for the apps api */
-    apps: typeof apps;
+    apps: AppsAPI;
     /** Functions for the audits api */
-    audits: typeof audits;
+    audits: AuditsAPI;
     /** Functions for the auth api */
-    auth: typeof auth;
+    auth: AuthAPI;
     /** Functions for the automations api */
-    automations: typeof automations;
+    automations: AutomationsAPI;
     /** Functions for the brands api */
-    brands: typeof brands;
+    brands: BrandsAPI;
     /** Functions for the collections api */
-    collections: typeof collections;
+    collections: CollectionsAPI;
     /** Functions for the cspOrigins api */
-    cspOrigins: typeof cspOrigins;
+    cspOrigins: CspOriginsAPI;
     /** Functions for the dataAssets api */
-    dataAssets: typeof dataAssets;
+    dataAssets: DataAssetsAPI;
     /** Functions for the dataConnections api */
-    dataConnections: typeof dataConnections;
+    dataConnections: DataConnectionsAPI;
     /** Functions for the dataCredentials api */
-    dataCredentials: typeof dataCredentials;
+    dataCredentials: DataCredentialsAPI;
     /** Functions for the dataFiles api */
-    dataFiles: typeof dataFiles;
+    dataFiles: DataFilesAPI;
     /** Functions for the extensions api */
-    extensions: typeof extensions;
+    extensions: ExtensionsAPI;
     /** Functions for the glossaries api */
-    glossaries: typeof glossaries;
+    glossaries: GlossariesAPI;
     /** Functions for the groups api */
-    groups: typeof groups;
+    groups: GroupsAPI;
     /** Functions for the identityProviders api */
-    identityProviders: typeof identityProviders;
+    identityProviders: IdentityProvidersAPI;
     /** Functions for the items api */
-    items: typeof items;
+    items: ItemsAPI;
     /** Functions for the licenses api */
-    licenses: typeof licenses;
+    licenses: LicensesAPI;
     /** Functions for the qix api */
-    qix: typeof qix;
+    qix: QixAPI;
     /** Functions for the quotas api */
-    quotas: typeof quotas;
+    quotas: QuotasAPI;
     /** Functions for the reloadTasks api */
-    reloadTasks: typeof reloadTasks;
+    reloadTasks: ReloadTasksAPI;
     /** Functions for the reloads api */
-    reloads: typeof reloads;
+    reloads: ReloadsAPI;
     /** Functions for the reports api */
-    reports: typeof reports;
+    reports: ReportsAPI;
     /** Functions for the roles api */
-    roles: typeof roles;
+    roles: RolesAPI;
     /** Functions for the spaces api */
-    spaces: typeof spaces;
+    spaces: SpacesAPI;
     /** Functions for the tempContents api */
-    tempContents: typeof tempContents;
+    tempContents: TempContentsAPI;
     /** Functions for the tenants api */
-    tenants: typeof tenants;
+    tenants: TenantsAPI;
     /** Functions for the themes api */
-    themes: typeof themes;
+    themes: ThemesAPI;
     /** Functions for the transports api */
-    transports: typeof transports;
+    transports: TransportsAPI;
     /** Functions for the users api */
-    users: typeof users;
+    users: UsersAPI;
     /** Functions for the webIntegrations api */
-    webIntegrations: typeof webIntegrations;
+    webIntegrations: WebIntegrationsAPI;
     /** Functions for the webNotifications api */
-    webNotifications: typeof webNotifications;
+    webNotifications: WebNotificationsAPI;
     /** Functions for the webhooks api */
-    webhooks: typeof webhooks;
+    webhooks: WebhooksAPI;
 }
+declare const createQlikApi: (props?: {
+    hostConfig?: HostConfig;
+}) => QlikAPI;
 /** Javascript/Typescript bindings to Qlik's platform API's */
-declare const api: QlikAPI;
+declare const api: QlikAPI & {
+    createQlikApi: (props?: {
+        hostConfig?: HostConfig;
+    }) => QlikAPI;
+};
 
-export { type QlikAPI, apiKeys, apps, audits, auth, automations, brands, collections, cspOrigins, dataAssets, dataConnections, dataCredentials, dataFiles, api as default, extensions, glossaries, groups, identityProviders, items, licenses, qix, quotas, reloadTasks, reloads, reports, roles, spaces, tempContents, tenants, themes, transports, users, webIntegrations, webNotifications, webhooks };
+export { type QlikAPI, apiKeys, apps, audits, auth, automations, brands, collections, createQlikApi, cspOrigins, dataAssets, dataConnections, dataCredentials, dataFiles, api as default, extensions, glossaries, groups, identityProviders, items, licenses, qix, quotas, reloadTasks, reloads, reports, roles, spaces, tempContents, tenants, themes, transports, users, webIntegrations, webNotifications, webhooks };