@qlik/api 1.26.0 → 1.28.0

package/data-files.d.ts

@@ -313,14 +313,14 @@ declare const getDataFiles: (query: {
 type GetDataFilesHttpResponse = {
     data: GetDataFileInfosResponse;
     headers: Headers;
-    status: number;
+    status: 200;
     prev?: (options?: ApiCallOptions) => Promise<GetDataFilesHttpResponse>;
     next?: (options?: ApiCallOptions) => Promise<GetDataFilesHttpResponse>;
 };
 type GetDataFilesHttpError = {
     data: ErrorResponse;
     headers: Headers;
-    status: number;
+    status: 400 | 403;
 };
 /**
  * Upload a new data file or create a new folder.
@@ -370,12 +370,12 @@ declare const uploadDataFile: (body: {
 type UploadDataFileHttpResponse = {
     data: DataFileUploadResponse;
     headers: Headers;
-    status: number;
+    status: 201;
 };
 type UploadDataFileHttpError = {
     data: ErrorResponse;
     headers: Headers;
-    status: number;
+    status: 400 | 403 | 409 | 413 | 423 | 501;
 };
 /**
  * This is to allow for a separate admin type of operation that is more global in terms of access in cases
@@ -390,12 +390,12 @@ declare const moveDataFiles: (body: DataFileBatchChangeSpaceRequest, options?: A
 type MoveDataFilesHttpResponse = {
     data: MultiStatusResponse;
     headers: Headers;
-    status: number;
+    status: 207;
 };
 type MoveDataFilesHttpError = {
     data: ErrorResponse;
     headers: Headers;
-    status: number;
+    status: 400;
 };
 /**
  * Delete the specified set of data files and/or folders as a single batch.
@@ -407,12 +407,12 @@ declare const deleteDataFiles: (body: DataFileBatchDeleteRequest, options?: ApiC
 type DeleteDataFilesHttpResponse = {
     data: MultiStatusResponse;
     headers: Headers;
-    status: number;
+    status: 207;
 };
 type DeleteDataFilesHttpError = {
     data: ErrorResponse;
     headers: Headers;
-    status: number;
+    status: 400;
 };
 /**
  * The non-filtered list contains a set of hardcoded connections, along with one connection per team space that
@@ -444,14 +444,14 @@ declare const getDataFilesConnections: (query: {
 type GetDataFilesConnectionsHttpResponse = {
     data: GetConnectionsResponse;
     headers: Headers;
-    status: number;
+    status: 200;
     prev?: (options?: ApiCallOptions) => Promise<GetDataFilesConnectionsHttpResponse>;
     next?: (options?: ApiCallOptions) => Promise<GetDataFilesConnectionsHttpResponse>;
 };
 type GetDataFilesConnectionsHttpError = {
     data: ErrorResponse;
     headers: Headers;
-    status: number;
+    status: 400 | 403;
 };
 /**
  * Get the built-in connection used by the engine to load/write data files given a connection ID.
@@ -463,12 +463,12 @@ declare const getDataFileConnection: (id: string, options?: ApiCallOptions) => P
 type GetDataFileConnectionHttpResponse = {
     data: ConnectionsResponse;
     headers: Headers;
-    status: number;
+    status: 200;
 };
 type GetDataFileConnectionHttpError = {
     data: ErrorResponse;
     headers: Headers;
-    status: number;
+    status: 403 | 404;
 };
 /**
  * Get quota information for the calling user.
@@ -479,12 +479,12 @@ declare const getDataFilesQuotas: (options?: ApiCallOptions) => Promise<GetDataF
 type GetDataFilesQuotasHttpResponse = {
     data: QuotaResponse;
     headers: Headers;
-    status: number;
+    status: 200;
 };
 type GetDataFilesQuotasHttpError = {
     data: ErrorResponse;
     headers: Headers;
-    status: number;
+    status: 400 | 403;
 };
 /**
  * Delete the specified data file or folder.  Deleting a folder will also recursively delete all files and
@@ -497,12 +497,12 @@ declare const deleteDataFile: (id: string, options?: ApiCallOptions) => Promise<
 type DeleteDataFileHttpResponse = {
     data: void;
     headers: Headers;
-    status: number;
+    status: 204;
 };
 type DeleteDataFileHttpError = {
     data: ErrorResponse;
     headers: Headers;
-    status: number;
+    status: 400 | 403 | 404;
 };
 /**
  * Get descriptive info for the specified data file.
@@ -514,12 +514,12 @@ declare const getDataFile: (id: string, options?: ApiCallOptions) => Promise<Get
 type GetDataFileHttpResponse = {
     data: DataFileUploadResponse;
     headers: Headers;
-    status: number;
+    status: 200;
 };
 type GetDataFileHttpError = {
     data: ErrorResponse;
     headers: Headers;
-    status: number;
+    status: 400 | 403 | 404;
 };
 /**
  * Re-upload an existing data file or update an existing folder.
@@ -582,12 +582,12 @@ declare const reuploadDataFile: (id: string, body: {
 type ReuploadDataFileHttpResponse = {
     data: DataFileUploadResponse;
     headers: Headers;
-    status: number;
+    status: 201;
 };
 type ReuploadDataFileHttpError = {
     data: ErrorResponse;
     headers: Headers;
-    status: number;
+    status: 400 | 403 | 404 | 409 | 413 | 423;
 };
 /**
  * This is primarily an admin type of operation.  In general, the owner of a data file or folder is implicitly
@@ -606,12 +606,12 @@ declare const changeDataFileOwner: (id: string, body: ChangeDataFileOwnerRequest
 type ChangeDataFileOwnerHttpResponse = {
     data: void;
     headers: Headers;
-    status: number;
+    status: 204;
 };
 type ChangeDataFileOwnerHttpError = {
     data: ErrorResponse;
     headers: Headers;
-    status: number;
+    status: 400 | 403 | 404 | 409 | 423;
 };
 /**
  * This is to allow for a separate admin type of operation that is more global in terms of access in cases
@@ -631,12 +631,12 @@ declare const moveDataFile: (id: string, body: ChangeDataFileSpaceRequest, optio
 type MoveDataFileHttpResponse = {
     data: void;
     headers: Headers;
-    status: number;
+    status: 204;
 };
 type MoveDataFileHttpError = {
     data: ErrorResponse;
     headers: Headers;
-    status: number;
+    status: 400 | 403 | 404 | 409 | 423;
 };
 /**
  * Clears the cache for data-files api requests.

package/data-files.js

@@ -1,8 +1,8 @@
 import {
   clearApiCache,
   invokeFetch
-} from "./chunks/AMO5NATA.js";
-import "./chunks/UV5COPU3.js";
+} from "./chunks/WQYEWU54.js";
+import "./chunks/2B7YWDQC.js";
 import "./chunks/2ZQ3ZX7F.js";
 
 // src/public/rest/data-files.ts

package/docs/authentication.md

@@ -52,7 +52,7 @@ As an alternative to the methods above it is also possible to create an instance
 Example:
 
 ```ts
-import { createQlikApi } from "@qlik-trial/qmfe-api";
+import { createQlikApi } from "@qlik/api";
 
 const api = createQlikApi({
   authType: "apikey"

package/extensions.d.ts

@@ -104,7 +104,7 @@ declare const getExtensions: (options?: ApiCallOptions) => Promise<GetExtensions
 type GetExtensionsHttpResponse = {
     data: Extensions;
     headers: Headers;
-    status: number;
+    status: 200;
 };
 type GetExtensionsHttpError = {
     data: unknown;
@@ -126,7 +126,7 @@ declare const uploadExtension: (body: {
 type UploadExtensionHttpResponse = {
     data: Extension;
     headers: Headers;
-    status: number;
+    status: 201;
 };
 type UploadExtensionHttpError = {
     data: Error;
@@ -143,12 +143,12 @@ declare const deleteExtension: (id: string, options?: ApiCallOptions) => Promise
 type DeleteExtensionHttpResponse = {
     data: void;
     headers: Headers;
-    status: number;
+    status: 204;
 };
 type DeleteExtensionHttpError = {
     data: Error;
     headers: Headers;
-    status: number;
+    status: 403 | 404 | 410;
 };
 /**
  * Returns a specific extension matching either extension ID or extension name.
@@ -160,12 +160,12 @@ declare const getExtension: (id: string, options?: ApiCallOptions) => Promise<Ge
 type GetExtensionHttpResponse = {
     data: Extension;
     headers: Headers;
-    status: number;
+    status: 200;
 };
 type GetExtensionHttpError = {
     data: Error;
     headers: Headers;
-    status: number;
+    status: 403 | 404 | 410;
 };
 /**
  * Updates a specific extension matching either extension ID or extension name. Accepts either provided file or data object.
@@ -183,7 +183,7 @@ declare const patchExtension: (id: string, body: {
 type PatchExtensionHttpResponse = {
     data: Extension;
     headers: Headers;
-    status: number;
+    status: 200;
 };
 type PatchExtensionHttpError = {
     data: Error;
@@ -200,12 +200,12 @@ declare const downloadExtension: (id: string, options?: ApiCallOptions) => Promi
 type DownloadExtensionHttpResponse = {
     data: void;
     headers: Headers;
-    status: number;
+    status: 200;
 };
 type DownloadExtensionHttpError = {
     data: Error;
     headers: Headers;
-    status: number;
+    status: 403 | 404 | 410;
 };
 /**
  * Downloads a specific file from the extension matching either extension ID or extension name, identified by the file path within the imported extension.
@@ -218,12 +218,12 @@ declare const downloadFileFromExtension: (id: string, filepath: string, options?
 type DownloadFileFromExtensionHttpResponse = {
     data: void;
     headers: Headers;
-    status: number;
+    status: 200;
 };
 type DownloadFileFromExtensionHttpError = {
     data: Error;
     headers: Headers;
-    status: number;
+    status: 403 | 404 | 410;
 };
 /**
  * Clears the cache for extensions api requests.

package/extensions.js

@@ -1,8 +1,8 @@
 import {
   clearApiCache,
   invokeFetch
-} from "./chunks/AMO5NATA.js";
-import "./chunks/UV5COPU3.js";
+} from "./chunks/WQYEWU54.js";
+import "./chunks/2B7YWDQC.js";
 import "./chunks/2ZQ3ZX7F.js";
 
 // src/public/rest/extensions.ts

package/glossaries.d.ts

@@ -193,6 +193,7 @@ type ErrorResponseCode = {
 /**
  * ### Custom error codes
  * * BG-3 - Access denied, no read access
+ * * BG-30 - Feature not enabled on tenant.
  */
 type ErrorResponseForbidden = {
     errors?: ErrorResponseCode[];
@@ -446,14 +447,14 @@ declare const getGlossaries: (query: {
 type GetGlossariesHttpResponse = {
     data: GlossariesResult;
     headers: Headers;
-    status: number;
+    status: 200;
     prev?: (options?: ApiCallOptions) => Promise<GetGlossariesHttpResponse>;
     next?: (options?: ApiCallOptions) => Promise<GetGlossariesHttpResponse>;
 };
 type GetGlossariesHttpError = {
     data: ErrorResponse;
     headers: Headers;
-    status: number;
+    status: 400 | 403;
 };
 /**
  * Creates a new glossary. Only a steward can create a glossary.
@@ -465,12 +466,12 @@ declare const createGlossary: (body: CreateGlossary, options?: ApiCallOptions) =
 type CreateGlossaryHttpResponse = {
     data: Glossary;
     headers: Headers;
-    status: number;
+    status: 201;
 };
 type CreateGlossaryHttpError = {
     data: ErrorResponse;
     headers: Headers;
-    status: number;
+    status: 400 | 403;
 };
 /**
  * Creates a new glossary, including categories and terms, based on a glossary definition file.
@@ -491,8 +492,9 @@ declare const importGlossary: (query: {
 type ImportGlossaryHttpResponse = {
     data: Glossary;
     headers: Headers;
-    status: number;
+    status: 201;
 };
+type ImportGlossaryHttpError = ImportGlossary400HttpError | ImportGlossary403HttpError | ImportGlossary404HttpError;
 type ImportGlossary400HttpError = {
     data: ErrorResponseBadRequest;
     headers: Headers;
@@ -508,7 +510,6 @@ type ImportGlossary404HttpError = {
     headers: Headers;
     status: 404;
 };
-type ImportGlossaryHttpError = ImportGlossary400HttpError | ImportGlossary403HttpError | ImportGlossary404HttpError;
 /**
  * Deletes a glossary and all of its terms.
  *
@@ -519,12 +520,12 @@ declare const deleteGlossary: (id: string, options?: ApiCallOptions) => Promise<
 type DeleteGlossaryHttpResponse = {
     data: void;
     headers: Headers;
-    status: number;
+    status: 204;
 };
 type DeleteGlossaryHttpError = {
     data: ErrorResponse;
     headers: Headers;
-    status: number;
+    status: 400 | 403 | 404;
 };
 /**
  * Retrieves a glossary.
@@ -536,12 +537,12 @@ declare const getGlossary: (id: string, options?: ApiCallOptions) => Promise<Get
 type GetGlossaryHttpResponse = {
     data: Glossary;
     headers: Headers;
-    status: number;
+    status: 200;
 };
 type GetGlossaryHttpError = {
     data: ErrorResponse;
     headers: Headers;
-    status: number;
+    status: 400 | 403 | 404;
 };
 /**
  * Updates glossary properties with json-patch formated data
@@ -554,12 +555,12 @@ declare const patchGlossary: (id: string, body: JSONPatchArray, options?: ApiCal
 type PatchGlossaryHttpResponse = {
     data: void;
     headers: Headers;
-    status: number;
+    status: 204;
 };
 type PatchGlossaryHttpError = {
     data: ErrorResponse;
     headers: Headers;
-    status: number;
+    status: 400 | 401 | 403 | 404 | 429;
 };
 /**
  * Updates a glossary.
@@ -572,12 +573,12 @@ declare const updateGlossary: (id: string, body: CreateGlossary, options?: ApiCa
 type UpdateGlossaryHttpResponse = {
     data: Glossary;
     headers: Headers;
-    status: number;
+    status: 200;
 };
 type UpdateGlossaryHttpError = {
     data: ErrorResponse;
     headers: Headers;
-    status: number;
+    status: 400 | 403 | 404;
 };
 /**
  * Exports a glossary.
@@ -589,12 +590,12 @@ declare const exportGlossary: (id: string, options?: ApiCallOptions) => Promise<
 type ExportGlossaryHttpResponse = {
     data: ExportGlossary;
     headers: Headers;
-    status: number;
+    status: 200;
 };
 type ExportGlossaryHttpError = {
     data: ErrorResponse;
     headers: Headers;
-    status: number;
+    status: 400 | 403 | 404;
 };
 /**
  * Returns a list of categories for a glossary.
@@ -618,14 +619,14 @@ declare const getGlossaryCategories: (id: string, query: {
 type GetGlossaryCategoriesHttpResponse = {
     data: CategoriesResult;
     headers: Headers;
-    status: number;
+    status: 200;
     prev?: (options?: ApiCallOptions) => Promise<GetGlossaryCategoriesHttpResponse>;
     next?: (options?: ApiCallOptions) => Promise<GetGlossaryCategoriesHttpResponse>;
 };
 type GetGlossaryCategoriesHttpError = {
     data: ErrorResponse;
     headers: Headers;
-    status: number;
+    status: 400 | 403 | 404;
 };
 /**
  * Creates a new category.
@@ -638,12 +639,12 @@ declare const createGlossaryCategory: (id: string, body: CreateCategory, options
 type CreateGlossaryCategoryHttpResponse = {
     data: Category;
     headers: Headers;
-    status: number;
+    status: 201;
 };
 type CreateGlossaryCategoryHttpError = {
     data: ErrorResponse;
     headers: Headers;
-    status: number;
+    status: 400 | 403 | 404;
 };
 /**
  * Deletes a category.
@@ -656,12 +657,12 @@ declare const deleteGlossaryCategory: (id: string, categoryId: string, options?:
 type DeleteGlossaryCategoryHttpResponse = {
     data: void;
     headers: Headers;
-    status: number;
+    status: 204;
 };
 type DeleteGlossaryCategoryHttpError = {
     data: ErrorResponse;
     headers: Headers;
-    status: number;
+    status: 400 | 403 | 404;
 };
 /**
  * Retrieves a category.
@@ -674,12 +675,12 @@ declare const getGlossaryCategory: (id: string, categoryId: string, options?: Ap
 type GetGlossaryCategoryHttpResponse = {
     data: Category;
     headers: Headers;
-    status: number;
+    status: 200;
 };
 type GetGlossaryCategoryHttpError = {
     data: ErrorResponse;
     headers: Headers;
-    status: number;
+    status: 400 | 403 | 404;
 };
 /**
  * Updates category properties with json-patch formated data
@@ -693,12 +694,12 @@ declare const patchGlossaryCategory: (id: string, categoryId: string, body: JSON
 type PatchGlossaryCategoryHttpResponse = {
     data: void;
     headers: Headers;
-    status: number;
+    status: 204;
 };
 type PatchGlossaryCategoryHttpError = {
     data: ErrorResponse;
     headers: Headers;
-    status: number;
+    status: 400 | 401 | 403 | 404 | 429;
 };
 /**
  * Updates a category.
@@ -712,12 +713,12 @@ declare const updateGlossaryCategory: (id: string, categoryId: string, body: Cre
 type UpdateGlossaryCategoryHttpResponse = {
     data: Category;
     headers: Headers;
-    status: number;
+    status: 200;
 };
 type UpdateGlossaryCategoryHttpError = {
     data: ErrorResponse;
     headers: Headers;
-    status: number;
+    status: 400 | 403 | 404;
 };
 /**
  * Returns a list of terms for a glossary.
@@ -754,14 +755,14 @@ declare const getGlossaryTerms: (id: string, query: {
 type GetGlossaryTermsHttpResponse = {
     data: TermsResult;
     headers: Headers;
-    status: number;
+    status: 200;
     prev?: (options?: ApiCallOptions) => Promise<GetGlossaryTermsHttpResponse>;
     next?: (options?: ApiCallOptions) => Promise<GetGlossaryTermsHttpResponse>;
 };
 type GetGlossaryTermsHttpError = {
     data: ErrorResponse;
     headers: Headers;
-    status: number;
+    status: 400 | 403 | 404;
 };
 /**
  * Creates a new term.
@@ -774,12 +775,12 @@ declare const createGlossaryTerm: (id: string, body: CreateTerm, options?: ApiCa
 type CreateGlossaryTermHttpResponse = {
     data: Term;
     headers: Headers;
-    status: number;
+    status: 201;
 };
 type CreateGlossaryTermHttpError = {
     data: ErrorResponse;
     headers: Headers;
-    status: number;
+    status: 400 | 403 | 404;
 };
 /**
  * Deletes a term.
@@ -792,12 +793,12 @@ declare const deleteGlossaryTerm: (id: string, termId: string, options?: ApiCall
 type DeleteGlossaryTermHttpResponse = {
     data: void;
     headers: Headers;
-    status: number;
+    status: 204;
 };
 type DeleteGlossaryTermHttpError = {
     data: ErrorResponse;
     headers: Headers;
-    status: number;
+    status: 400 | 403 | 404;
 };
 /**
  * Retrieves a term.
@@ -810,12 +811,12 @@ declare const getGlossaryTerm: (id: string, termId: string, options?: ApiCallOpt
 type GetGlossaryTermHttpResponse = {
     data: Term;
     headers: Headers;
-    status: number;
+    status: 200;
 };
 type GetGlossaryTermHttpError = {
     data: ErrorResponse;
     headers: Headers;
-    status: number;
+    status: 400 | 403 | 404;
 };
 /**
  * Updates term properties with json-patch formated data
@@ -829,12 +830,12 @@ declare const patchGlossaryTerm: (id: string, termId: string, body: JSONPatchArr
 type PatchGlossaryTermHttpResponse = {
     data: void;
     headers: Headers;
-    status: number;
+    status: 204;
 };
 type PatchGlossaryTermHttpError = {
     data: ErrorResponse;
     headers: Headers;
-    status: number;
+    status: 400 | 401 | 403 | 404 | 412 | 429;
 };
 /**
  * Updates a term.
@@ -848,12 +849,12 @@ declare const updateGlossaryTerm: (id: string, termId: string, body: CreateTerm,
 type UpdateGlossaryTermHttpResponse = {
     data: Term;
     headers: Headers;
-    status: number;
+    status: 200;
 };
 type UpdateGlossaryTermHttpError = {
     data: ErrorResponse;
     headers: Headers;
-    status: number;
+    status: 400 | 403 | 404 | 412;
 };
 /**
  * Changes the status of the term. Only a steward can verify a term. Once the term is verified only a steward can modify the term.
@@ -870,12 +871,12 @@ declare const changeGlossaryTermStatus: (id: string, termId: string, query: {
 type ChangeGlossaryTermStatusHttpResponse = {
     data: Term;
     headers: Headers;
-    status: number;
+    status: 200;
 };
 type ChangeGlossaryTermStatusHttpError = {
     data: ErrorResponse;
     headers: Headers;
-    status: number;
+    status: 400 | 403 | 404 | 412;
 };
 /**
  * Returns a list of links assigned to a term.
@@ -902,14 +903,14 @@ declare const getGlossaryTermLinks: (id: string, termId: string, query: {
 type GetGlossaryTermLinksHttpResponse = {
     data: LinksResult;
     headers: Headers;
-    status: number;
+    status: 200;
     prev?: (options?: ApiCallOptions) => Promise<GetGlossaryTermLinksHttpResponse>;
     next?: (options?: ApiCallOptions) => Promise<GetGlossaryTermLinksHttpResponse>;
 };
 type GetGlossaryTermLinksHttpError = {
     data: ErrorResponse;
     headers: Headers;
-    status: number;
+    status: 400 | 403 | 404;
 };
 /**
  * Creates a new link to a term.
@@ -923,12 +924,12 @@ declare const createGlossaryTermLink: (id: string, termId: string, body: TermCre
 type CreateGlossaryTermLinkHttpResponse = {
     data: TermLinksTo;
     headers: Headers;
-    status: number;
+    status: 201;
 };
 type CreateGlossaryTermLinkHttpError = {
     data: ErrorResponse;
     headers: Headers;
-    status: number;
+    status: 400 | 403 | 404 | 412;
 };
 /**
  * Retrieves previous revisions of a term.
@@ -953,14 +954,14 @@ declare const getGlossaryTermRevisions: (id: string, termId: string, query: {
 type GetGlossaryTermRevisionsHttpResponse = {
     data: TermsResult;
     headers: Headers;
-    status: number;
+    status: 200;
     prev?: (options?: ApiCallOptions) => Promise<GetGlossaryTermRevisionsHttpResponse>;
     next?: (options?: ApiCallOptions) => Promise<GetGlossaryTermRevisionsHttpResponse>;
 };
 type GetGlossaryTermRevisionsHttpError = {
     data: ErrorResponse;
     headers: Headers;
-    status: number;
+    status: 400 | 403 | 404;
 };
 /**
  * Clears the cache for glossaries api requests.

package/glossaries.js

@@ -1,8 +1,8 @@
 import {
   clearApiCache,
   invokeFetch
-} from "./chunks/AMO5NATA.js";
-import "./chunks/UV5COPU3.js";
+} from "./chunks/WQYEWU54.js";
+import "./chunks/2B7YWDQC.js";
 import "./chunks/2ZQ3ZX7F.js";
 
 // src/public/rest/glossaries.ts