@qlik/api 1.28.0 → 1.30.0

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

package/glossaries.d.ts

@@ -2,7 +2,7 @@ import { A as ApiCallOptions } from './invoke-fetch-types-BXn-uSF5.js';
 import './auth-types-PkN9CAF_.js';
 
 /**
- * A JSON Patch document as defined in http://tools.ietf.org/html/rfc6902.
+ * A JSON Patch document as defined in https://tools.ietf.org/html/rfc6902.
  */
 type JSONPatch = {
     /** The operation to be performed. */
@@ -14,6 +14,19 @@ type JSONPatch = {
 };
 /**
  * An array of JSON Patch documents
+ * @example
+ * [
+ *   {
+ *     op: "replace",
+ *     path: "/name",
+ *     value: "new name"
+ *   },
+ *   {
+ *     op: "replace",
+ *     path: "/description",
+ *     value: "new description"
+ *   }
+ * ]
  */
 type JSONPatchArray = JSONPatch[];
 type AtlanEntity = {
@@ -102,6 +115,7 @@ type AtlasTerm = {
 };
 type CategoriesResult = {
     data: Category[];
+    /** URLs to a resource request */
     links?: PageLinks;
     meta?: ResultMeta;
 };
@@ -115,7 +129,7 @@ type Category = {
     id: string;
     name: string;
     parentId?: string;
-    /** This list contains the uids of the stewards of the category. */
+    /** This list contains the UIDs of the stewards of the category. */
     stewards?: string[];
     readonly updatedAt: string;
     /** The uid of the user who last updated the category */
@@ -126,7 +140,7 @@ type CreateCategory = {
     /** The name of the category. May not be identical to another category belonging to the same parent. */
     name?: string;
     parentId?: string;
-    /** This list contains the uids of the stewards of the category. */
+    /** This list contains the UIDs of the stewards of the category. */
     stewards?: string[];
 };
 type CreateGlossary = {
@@ -151,7 +165,7 @@ type CreateTerm = {
     name: string;
     relatedInformation?: string;
     relatesTo?: TermRelatesTo[];
-    /** This list contain the uids for the term's stewards */
+    /** This list contain the UIDs for the term's stewards */
     stewards?: string[];
     tags?: string[];
 };
@@ -253,6 +267,7 @@ type ExportTerm = {
 };
 type GlossariesResult = {
     data?: Glossary[];
+    /** URLs to a resource request */
     links?: PageLinks;
     meta?: ResultMeta;
 };
@@ -271,7 +286,7 @@ type Glossary = {
     overview: string;
     /** The unique identifier of the glossary owner */
     ownerId: string;
-    /** The unique identifier of the space containg the glossary */
+    /** The unique identifier of the space containing the glossary */
     spaceId: string;
     /** List of tags associated with the glossary. */
     tags: string[];
@@ -314,12 +329,16 @@ type ImportTerm = {
 };
 type LinksResult = {
     data?: TermLinksTo[];
+    /** URLs to a resource request */
     links?: PageLinks;
     meta?: ResultMeta;
 };
 type PageLink = {
     href?: string;
 };
+/**
+ * URLs to a resource request
+ */
 type PageLinks = {
     next?: PageLink;
     prev?: PageLink;
@@ -344,7 +363,7 @@ type StewardDetail = {
     userId?: string;
 };
 type Term = {
-    abbreviation?: string;
+    abbreviation: string;
     categories?: string[];
     readonly createdAt: string;
     readonly createdBy: string;
@@ -358,7 +377,7 @@ type Term = {
     revision: number;
     /** Terms status is used determine the status of a term */
     status: TermStatus;
-    /** This list contains the uids of the terms data stewards. */
+    /** This list contains the UIDs of the terms data stewards. */
     stewards: string[];
     tags: string[];
     readonly updatedAt: string;
@@ -423,6 +442,7 @@ type TermTemplate = {
 };
 type TermsResult = {
     data: Term[];
+    /** URLs to a resource request */
     links?: PageLinks;
     meta?: ResultMeta;
 };
@@ -545,7 +565,7 @@ type GetGlossaryHttpError = {
     status: 400 | 403 | 404;
 };
 /**
- * Updates glossary properties with json-patch formated data
+ * Updates glossary properties with json-patch formatted data
  *
  * @param id The glossary id.
  * @param body an object with the body content
@@ -683,7 +703,7 @@ type GetGlossaryCategoryHttpError = {
     status: 400 | 403 | 404;
 };
 /**
- * Updates category properties with json-patch formated data
+ * Updates category properties with json-patch formatted data
  *
  * @param id The glossary id.
  * @param categoryId The category id.
@@ -819,7 +839,7 @@ type GetGlossaryTermHttpError = {
     status: 400 | 403 | 404;
 };
 /**
- * Updates term properties with json-patch formated data
+ * Updates term properties with json-patch formatted data
  *
  * @param id The glossary id.
  * @param termId The term id.
@@ -866,7 +886,7 @@ type UpdateGlossaryTermHttpError = {
  */
 declare const changeGlossaryTermStatus: (id: string, termId: string, query: {
     /** The status to update to. */
-    status?: "draft" | "verified" | "deprecated";
+    status: "draft" | "verified" | "deprecated";
 }, options?: ApiCallOptions) => Promise<ChangeGlossaryTermStatusHttpResponse>;
 type ChangeGlossaryTermStatusHttpResponse = {
     data: Term;
@@ -1006,7 +1026,7 @@ interface GlossariesAPI {
      */
     getGlossary: typeof getGlossary;
     /**
-     * Updates glossary properties with json-patch formated data
+     * Updates glossary properties with json-patch formatted data
      *
      * @param id The glossary id.
      * @param body an object with the body content
@@ -1061,7 +1081,7 @@ interface GlossariesAPI {
      */
     getGlossaryCategory: typeof getGlossaryCategory;
     /**
-     * Updates category properties with json-patch formated data
+     * Updates category properties with json-patch formatted data
      *
      * @param id The glossary id.
      * @param categoryId The category id.
@@ -1111,7 +1131,7 @@ interface GlossariesAPI {
      */
     getGlossaryTerm: typeof getGlossaryTerm;
     /**
-     * Updates term properties with json-patch formated data
+     * Updates term properties with json-patch formatted data
      *
      * @param id The glossary id.
      * @param termId The term id.

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

package/groups.d.ts

@@ -16,6 +16,12 @@ type AssignedRoles = {
 }[];
 /**
  * An array of role reference identifiers.
+ * @example
+ * [
+ *   {
+ *     id: "507f191e810c19729de860ea"
+ *   }
+ * ]
  */
 type AssignedRolesRefIDs = {
     /** The unique role identitier */
@@ -23,6 +29,12 @@ type AssignedRolesRefIDs = {
 }[];
 /**
  * An array of role reference names.
+ * @example
+ * [
+ *   {
+ *     name: "TenantAdmin"
+ *   }
+ * ]
  */
 type AssignedRolesRefNames = {
     /** The name of the role */
@@ -52,6 +64,17 @@ type Error = {
 };
 /**
  * The error response object describing the error from the handling of an HTTP request.
+ * @example
+ * {
+ *   errors: [
+ *     {
+ *       code: "GROUPS-7",
+ *       status: 404,
+ *       title: "Not found"
+ *     }
+ *   ],
+ *   traceId: "00000000000000000137b213cf12a77b"
+ * }
  */
 type Errors = {
     /** An array of errors related to the operation. */
@@ -113,8 +136,34 @@ type GroupPatch = {
 };
 /**
  * An array of JSON Patches for a group.
+ * @example
+ * [
+ *   {
+ *     op: "replace",
+ *     value: [
+ *       {
+ *         name: "TenantAdmin"
+ *       },
+ *       {
+ *         name: "AnalyticsAdmin"
+ *       }
+ *     ]
+ *   }
+ * ]
  */
 type GroupPatchSchema = GroupPatch[];
+/**
+ * @example
+ * {
+ *   assignedRoles: [
+ *     {
+ *       name: "Developer"
+ *     }
+ *   ],
+ *   name: "Development",
+ *   status: "active"
+ * }
+ */
 type GroupPostSchema = {
     /** The roles to assign to the group (limit of 100 roles per group). */
     assignedRoles?: AssignedRolesRefIDs | AssignedRolesRefNames;
@@ -197,6 +246,27 @@ type SettingsPatch = {
 };
 /**
  * An array of JSON Patches for the groups settings.
+ * @example
+ * [
+ *   {
+ *     op: "replace",
+ *     path: "/syncIdpGroups",
+ *     value: true
+ *   },
+ *   {
+ *     op: "replace",
+ *     path: "/autoCreateGroups",
+ *     value: true
+ *   },
+ *   {
+ *     op: "replace",
+ *     value: [
+ *       {
+ *         name: "Steward"
+ *       }
+ *     ]
+ *   }
+ * ]
  */
 type SettingsPatchSchema = SettingsPatch[];
 /**

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

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

package/index.d.ts

@@ -1,5 +1,5 @@
 import { InterceptorsAPI, createInterceptors } from './interceptors.js';
-import { registerAuthModule, setDefaultHostConfig, getAccessToken, AuthAPI } from './auth.js';
+import { AuthAPI, registerAuthModule, setDefaultHostConfig, getAccessToken } from './auth.js';
 import { QixAPI } from './qix.js';
 import { ApiKeysAPI } from './api-keys.js';
 import { AppsAPI } from './apps.js';
@@ -18,6 +18,7 @@ import { GroupsAPI } from './groups.js';
 import { IdentityProvidersAPI } from './identity-providers.js';
 import { ItemsAPI } from './items.js';
 import { LicensesAPI } from './licenses.js';
+import { OauthClientsAPI } from './oauth-clients.js';
 import { QuotasAPI } from './quotas.js';
 import { ReloadTasksAPI } from './reload-tasks.js';
 import { ReloadsAPI } from './reloads.js';
@@ -60,6 +61,7 @@ declare const interceptors: InterceptorsAPI & {
 };
 declare const items: ItemsAPI;
 declare const licenses: LicensesAPI;
+declare const oauthClients: OauthClientsAPI;
 declare const qix: QixAPI & {
     withHostConfig: (hostConfig: HostConfig | undefined) => QixAPI;
 };
@@ -116,6 +118,8 @@ interface QlikAPI {
     items: ItemsAPI;
     /** Functions for the licenses api */
     licenses: LicensesAPI;
+    /** Functions for the oauthClients api */
+    oauthClients: OauthClientsAPI;
     /** Functions for the qix api */
     qix: QixAPI;
     /** Functions for the quotas api */
@@ -158,4 +162,4 @@ declare const api: QlikAPI & {
     }) => QlikAPI;
 };
 
-export { type CreateQlikApiProps, type QlikAPI, apiKeys, apps, audits, auth, automations, brands, collections, createQlikApi, cspOrigins, dataAssets, dataConnections, dataCredentials, dataFiles, api as default, extensions, glossaries, groups, identityProviders, interceptors, items, licenses, qix, quotas, reloadTasks, reloads, reports, roles, spaces, tempContents, tenants, themes, transports, users, webIntegrations, webNotifications, webhooks };
+export { type CreateQlikApiProps, type QlikAPI, apiKeys, apps, audits, auth, automations, brands, collections, createQlikApi, cspOrigins, dataAssets, dataConnections, dataCredentials, dataFiles, api as default, extensions, glossaries, groups, identityProviders, interceptors, items, licenses, oauthClients, qix, quotas, reloadTasks, reloads, reports, roles, spaces, tempContents, tenants, themes, transports, users, webIntegrations, webNotifications, webhooks };

package/index.js

@@ -1,17 +1,17 @@
 import {
   qix_default
-} from "./chunks/5XNSGPGZ.js";
+} from "./chunks/IQBP2PKS.js";
 import {
   auth_default
-} from "./chunks/KYCIMQ4L.js";
+} from "./chunks/QK4TMJ64.js";
 import {
   interceptors_default
 } from "./chunks/3RGGGGAR.js";
 import {
   clearApiCache,
   invokeFetch
-} from "./chunks/WQYEWU54.js";
-import "./chunks/2B7YWDQC.js";
+} from "./chunks/PTDXR7AY.js";
+import "./chunks/TXC5XORK.js";
 import "./chunks/2ZQ3ZX7F.js";
 
 // src/runtime-api-generator/runtime-api-generator-common.ts
@@ -533,6 +533,27 @@ var licensesMiniModule = apiDefToApiPublic("licenses", {
     }
   }
 });
+var oauthClientsMiniModule = apiDefToApiPublic("oauth-clients", {
+  api: {
+    v1: {
+      "oauth-clients": {
+        "": ["getOAuthClients:GQ:", "createOAuthClient:PBJ:"],
+        "{id}": {
+          "": ["deleteOAuthClient:D:", "getOAuthClient:G:", "patchOAuthClient:ABJ:"],
+          actions: { publish: ["publishOAuthClient:P:"] },
+          "client-secrets": { "": ["createOAuthClientSecret:P:"], "{hint}": ["deleteOAuthClientSecret:D:"] },
+          "connection-configs": {
+            me: [
+              "deleteOAuthClientConnectionConfig:D:",
+              "getOAuthClientConnectionConfig:G:",
+              "patchOAuthClientConnectionConfig:ABJ:"
+            ]
+          }
+        }
+      }
+    }
+  }
+});
 var quotasMiniModule = apiDefToApiPublic("quotas", {
   api: { v1: { quotas: { "": ["getQuotas:GQ:"], "{id}": ["getQuota:GQ:"] } } }
 });
@@ -577,6 +598,10 @@ var spacesMiniModule = apiDefToApiPublic("spaces", {
           assignments: {
             "": ["getSpaceAssignments:GQ:", "createSpaceAssignment:PBJ:"],
             "{assignmentId}": ["deleteSpaceAssignment:D:", "getSpaceAssignment:G:", "updateSpaceAssignment:UBJ:"]
+          },
+          shares: {
+            "": ["getSpaceShares:GQ:", "createSpaceShare:PBJ:"],
+            "{shareId}": ["deleteSpaceShare:D:", "getSpaceShare:G:", "patchShare:ABJ:"]
           }
         }
       }
@@ -705,6 +730,7 @@ var identityProviders = identityProvidersMiniModule(void 0, interceptors_default
 var interceptors = interceptors_default;
 var items = itemsMiniModule(void 0, interceptors_default);
 var licenses = licensesMiniModule(void 0, interceptors_default);
+var oauthClients = oauthClientsMiniModule(void 0, interceptors_default);
 var qix = qix_default;
 var quotas = quotasMiniModule(void 0, interceptors_default);
 var reloadTasks = reloadTasksMiniModule(void 0, interceptors_default);
@@ -742,6 +768,7 @@ var createQlikApi = (props) => {
     interceptors: scopedInterceptors,
     items: itemsMiniModule(props?.hostConfig, scopedInterceptors),
     licenses: licensesMiniModule(props?.hostConfig, scopedInterceptors),
+    oauthClients: oauthClientsMiniModule(props?.hostConfig, scopedInterceptors),
     qix: qix_default.withHostConfig(props?.hostConfig),
     quotas: quotasMiniModule(props?.hostConfig, scopedInterceptors),
     reloadTasks: reloadTasksMiniModule(props?.hostConfig, scopedInterceptors),
@@ -779,6 +806,7 @@ var api = {
   interceptors,
   items,
   licenses,
+  oauthClients,
   qix,
   quotas,
   reloadTasks,
@@ -819,6 +847,7 @@ export {
   interceptors,
   items,
   licenses,
+  oauthClients,
   qix,
   quotas,
   reloadTasks,

package/items.d.ts

@@ -129,7 +129,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/items.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/items.ts