@qlik/api 2.3.1 → 2.4.0

package/glossaries.d.ts

@@ -1,16 +1,13 @@
-import { y as ApiCallOptions } from "./chunks/auth-types-YrlH_R9f.js";
-import "./chunks/invoke-fetch-C1Z0RJYU.js";
+import { ApiCallOptions } from "./invoke-fetch-types.js";
+import "./chunks/invoke-fetch-DFc3yzaj.js";
 
 //#region src/public/rest/glossaries.d.ts
 /**
  * A JSON Patch document as defined in https://tools.ietf.org/html/rfc6902.
  */
 type JSONPatch = {
-  /** The operation to be performed. */
-  op: "replace";
-  /** A JSON Pointer. */
-  path: string;
-  /** The value to be used for this operation. */
+  /** The operation to be performed. */op: "replace"; /** A JSON Pointer. */
+  path: string; /** The value to be used for this operation. */
   value: string | number;
 };
 /**
@@ -115,8 +112,7 @@ type AtlasTerm = {
   termGuid?: string;
 };
 type CategoriesResult = {
-  data: Category[];
-  /** URLs to a resource request */
+  data: Category[]; /** URLs to a resource request */
   links?: PageLinks;
   meta?: ResultMeta;
 };
@@ -129,38 +125,29 @@ type Category = {
    * Opposed to the id of terms, id on category are not resolved by backend. Any category referred in the category array in terms will have to be identical to the id property of the category. If not, the category reference will be discarded. */
   id: string;
   name: string;
-  parentId?: string;
-  /** This list contains the UIDs of the stewards of the category. */
+  parentId?: string; /** 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 */
+  readonly updatedAt: string; /** The uid of the user who last updated the category */
   readonly updatedBy: string;
 };
 type CreateCategory = {
-  description?: string;
-  /** The name of the category. May not be identical to another category belonging to the same parent. */
+  description?: string; /** 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. */
+  parentId?: string; /** This list contains the UIDs of the stewards of the category. */
   stewards?: string[];
 };
 type CreateGlossary = {
-  /** Description of the glossary */
-  description?: string;
-  /** Name of the glossary */
+  /** Description of the glossary */description?: string; /** Name of the glossary */
   name: string;
   /** Overview of the glossary content. This is a rich text field represented as a JSON string.
    * The field is typically generated by the UI but can be set programmatically using the rich text format. */
-  overview?: string;
-  /** Unique unique identifier of the space to contain the glossary */
-  spaceId?: string;
-  /** List of tags for glossary */
+  overview?: string; /** Unique unique identifier of the space to contain the glossary */
+  spaceId?: string; /** List of tags for glossary */
   tags?: string[];
   termTemplate?: TermTemplate;
 };
 type CreateTerm = {
-  abbreviation?: string;
-  /** Category Ids that the term belongs to. NOTE! In case of import the string refers to the index of the category in the import document. */
+  abbreviation?: string; /** Category Ids that the term belongs to. NOTE! In case of import the string refers to the index of the category in the import document. */
   categories?: string[];
   description?: string;
   linksTo?: TermCreateLinksTo[];
@@ -168,8 +155,7 @@ type CreateTerm = {
   /** Related information for the term. This is a rich text field represented as a JSON string.
    * The field is typically generated by the UI but can be set programmatically using the rich text format. */
   relatedInformation?: string;
-  relatesTo?: TermRelatesTo[];
-  /** This list contain the UIDs for the term's stewards */
+  relatesTo?: TermRelatesTo[]; /** This list contain the UIDs for the term's stewards */
   stewards?: string[];
   tags?: string[];
 };
@@ -231,8 +217,7 @@ type ExportCategory = {
   description?: string;
   /** The id for resolving updates in future imports/updates.
    * Opposed to the id of terms, id on category are not resolved by backend. Any category referred in the category array in terms will have to be identical to the id property of the category. If not, the category reference will be discarded. */
-  id?: string;
-  /** The name of the category. May not be identical to another category belonging to the same parent. */
+  id?: string; /** The name of the category. May not be identical to another category belonging to the same parent. */
   name?: string;
   parentId?: string;
   stewardDetails?: StewardDetail[];
@@ -252,16 +237,13 @@ type ExportGlossary = {
   tags?: string[];
   termTemplate?: TermTemplate;
   terms?: ExportTerm[];
-  readonly updatedAt?: string;
-  /** The uid of the user who last updated the glossary */
+  readonly updatedAt?: string; /** The uid of the user who last updated the glossary */
   readonly updatedBy?: string;
 };
 type ExportTerm = {
-  abbreviation?: string;
-  /** Categories that the term belongs to. Refers to the `id` property of the category object */
+  abbreviation?: string; /** Categories that the term belongs to. Refers to the `id` property of the category object */
   categories?: string[];
-  description?: string;
-  /** The id of the term. Used to identify the term in future updates. If not provided, will use the leading 30 chars of the term name and an incremental index */
+  description?: string; /** The id of the term. Used to identify the term in future updates. If not provided, will use the leading 30 chars of the term name and an incremental index */
   id?: string;
   linksTo?: TermCreateLinksTo[];
   name?: string;
@@ -272,43 +254,31 @@ type ExportTerm = {
   tags?: string[];
 };
 type GlossariesResult = {
-  data?: Glossary[];
-  /** URLs to a resource request */
+  data?: Glossary[]; /** URLs to a resource request */
   links?: PageLinks;
   meta?: ResultMeta;
 };
 type Glossary = {
-  /** Datetime when the glossary was created */
-  readonly createdAt: string;
-  /** Unique identifier of the user who created the glossary */
-  readonly createdBy: string;
-  /** Description of the glossary */
-  description: string;
-  /** Unique identifier of the glossary */
-  id: string;
-  /** Name of the glossary */
+  /** Datetime when the glossary was created */readonly createdAt: string; /** Unique identifier of the user who created the glossary */
+  readonly createdBy: string; /** Description of the glossary */
+  description: string; /** Unique identifier of the glossary */
+  id: string; /** Name of the glossary */
   name: string;
   /** Overview of the glossary contents. This is a rich text field represented as a JSON string.
    * The field is typically generated by the UI but can be set programmatically using the rich text format. */
-  overview: string;
-  /** The unique identifier of the glossary owner */
-  ownerId: string;
-  /** The unique identifier of the space containing the glossary */
-  spaceId: string;
-  /** List of tags associated with the glossary. */
+  overview: string; /** The unique identifier of the glossary owner */
+  ownerId: string; /** The unique identifier of the space containing the glossary */
+  spaceId: string; /** List of tags associated with the glossary. */
   tags: string[];
-  termTemplate: TermTemplate;
-  /** Datetime when the glossary was updated */
-  readonly updatedAt: string;
-  /** The unique identifier of the user who last updated the glossary */
+  termTemplate: TermTemplate; /** Datetime when the glossary was updated */
+  readonly updatedAt: string; /** The unique identifier of the user who last updated the glossary */
   readonly updatedBy: string;
 };
 type ImportCategory = {
   description?: string;
   /** The id for resolving updates in future imports/updates.
    * Opposed to the id of terms, id on category are not resolved by backend. Any category referred in the category array in terms will have to be identical to the id property of the category. If not, the category reference will be discarded. */
-  id?: string;
-  /** The name of the category. May not be identical to another category belonging to the same parent. */
+  id?: string; /** The name of the category. May not be identical to another category belonging to the same parent. */
   name?: string;
   parentId?: string;
   stewardDetails?: StewardDetail[];
@@ -320,11 +290,9 @@ type ImportOwner = {
   userId?: string;
 };
 type ImportTerm = {
-  abbreviation?: string;
-  /** Categories that the term belongs to. Refers to the `id` property of the category object */
+  abbreviation?: string; /** Categories that the term belongs to. Refers to the `id` property of the category object */
   categories?: string[];
-  description?: string;
-  /** The id of the term. Used to identify the term in future updates. If not provided, will use the leading 30 chars of the term name and an incremental index */
+  description?: string; /** The id of the term. Used to identify the term in future updates. If not provided, will use the leading 30 chars of the term name and an incremental index */
   id?: string;
   linksTo?: TermCreateLinksTo[];
   name?: string;
@@ -335,8 +303,7 @@ type ImportTerm = {
   tags?: string[];
 };
 type LinksResult = {
-  data?: TermLinksTo[];
-  /** URLs to a resource request */
+  data?: TermLinksTo[]; /** URLs to a resource request */
   links?: PageLinks;
   meta?: ResultMeta;
 };
@@ -380,22 +347,17 @@ type Term = {
   glossaryId: string;
   id: string;
   linksTo?: TermLinksTo[];
-  name: string;
-  /** Term relations where this term is the target of the relation. */
+  name: string; /** Term relations where this term is the target of the relation. */
   referredRelations?: TermRelatesTo[];
   /** Related information for the term. This is a rich text field represented as a JSON string.
    * The field is typically generated by the UI but can be set programmatically using the rich text format. */
-  relatedInformation: string;
-  /** Term relations assigned to this term. */
+  relatedInformation: string; /** Term relations assigned to this term. */
   relatesTo?: TermRelatesTo[];
-  revision: number;
-  /** Terms status is used determine the status of a term */
-  status: TermStatus;
-  /** This list contains the UIDs of the terms data stewards. */
+  revision: number; /** Terms status is used determine the status of a term */
+  status: TermStatus; /** This list contains the UIDs of the terms data stewards. */
   stewards: string[];
   tags: string[];
-  readonly updatedAt: string;
-  /** The uid of the user who last updated the term */
+  readonly updatedAt: string; /** The uid of the user who last updated the term */
   readonly updatedBy: string;
 };
 /**
@@ -406,15 +368,10 @@ type Term = {
  * If any one subresource field is specified, all three are required.
  */
 type TermCreateLinksTo = {
-  /** The unique identifier of the resource (app or dataset) to link to the term. */
-  resourceId: string;
-  /** The type of resource being linked to the term. */
-  resourceType: "app" | "dataset";
-  /** Required when subResourceType or subResourceName is provided. The unique identifier of the subresource. */
-  subResourceId?: string;
-  /** Required when subResourceType or subResourceId is provided. The display name of the subresource. */
-  subResourceName?: string;
-  /** Required when subResourceId or subResourceName is provided. The type of the subresource. */
+  /** The unique identifier of the resource (app or dataset) to link to the term. */resourceId: string; /** The type of resource being linked to the term. */
+  resourceType: "app" | "dataset"; /** Required when subResourceType or subResourceName is provided. The unique identifier of the subresource. */
+  subResourceId?: string; /** Required when subResourceType or subResourceId is provided. The display name of the subresource. */
+  subResourceName?: string; /** Required when subResourceId or subResourceName is provided. The type of the subresource. */
   subResourceType?: "master_dimension" | "master_measure" | "field";
   /** The type of relationship between the term and the linked resource:
    * - `definition`: Use when the term provides the formal definition for the linked resource (e.g., a term defines what a master measure or dimension means)
@@ -429,37 +386,28 @@ type TermLinksTo = {
   createdBy?: string;
   id?: string;
   name?: string;
-  openUrl?: string;
-  /** Different formats based on resource type. Could be e.g. OID or UUID. */
+  openUrl?: string; /** Different formats based on resource type. Could be e.g. OID or UUID. */
   resourceId?: string;
   resourceSpaceId?: string;
-  resourceType?: "app" | "dataset";
-  /** Http status code for item during batch operation. */
-  status?: number;
-  /** Different formats based on subresource type. Could be e.g. OID or UUID. */
-  subResourceId?: string;
-  /** Populated and true if no matching subresource is found on parent resource. E.g. if a dataset field no longer exist but a link to that field exists. */
+  resourceType?: "app" | "dataset"; /** Http status code for item during batch operation. */
+  status?: number; /** Different formats based on subresource type. Could be e.g. OID or UUID. */
+  subResourceId?: string; /** Populated and true if no matching subresource is found on parent resource. E.g. if a dataset field no longer exist but a link to that field exists. */
   subResourceInvalid?: boolean;
   subResourceName?: string;
-  subResourceType?: "master_dimension" | "master_measure" | "field";
-  /** Describes reason for item status during batch operation. E.g. why an error occurs during creation. */
+  subResourceType?: "master_dimension" | "master_measure" | "field"; /** Describes reason for item status during batch operation. E.g. why an error occurs during creation. */
   title?: string;
   type?: "definition" | "related";
 };
 type TermRelatesTo = {
-  /** The unique identifier of the related term. NOTE! In case of import the string refers to the index of the term in the import document. */
-  termId: string;
-  /** How the term related to the other object */
+  /** The unique identifier of the related term. NOTE! In case of import the string refers to the index of the term in the import document. */termId: string; /** How the term related to the other object */
   type: "isA" | "hasA" | "seeAlso" | "synonym" | "antonym" | "classifies" | "other" | "replaces" | "replacedBy" | "hasSubtype" | "preferredTerm" | "seeInstead" | "defines" | "definedBy";
 };
 /**
  * Terms status is used determine the status of a term
  */
 type TermStatus = {
-  type: "draft" | "verified" | "deprecated";
-  /** Time when the state was changed */
-  updatedAt: string;
-  /** The unique identifier of the user who last changed the status of the term */
+  type: "draft" | "verified" | "deprecated"; /** Time when the state was changed */
+  updatedAt: string; /** The unique identifier of the user who last changed the status of the term */
   updatedBy: string;
 };
 type TermTemplate = {
@@ -468,8 +416,7 @@ type TermTemplate = {
   relatedInformation?: string;
 };
 type TermsResult = {
-  data: Term[];
-  /** URLs to a resource request */
+  data: Term[]; /** URLs to a resource request */
   links?: PageLinks;
   meta?: ResultMeta;
 };
@@ -480,15 +427,10 @@ type TermsResult = {
  * @throws GetGlossariesHttpError
  */
 declare function getGlossaries(query: {
-  /** Optional parameter to request total count for query */
-  countTotal?: boolean;
-  /** The number of glossaries to get. */
-  limit?: number;
-  /** Optional parameter to request the next page. */
-  next?: string;
-  /** Optional parameter to request the previous page. */
-  prev?: string;
-  /** Optional resource field name to sort on, eg. name. Can be prefixed with +/- to determine order, defaults to (+) ascending. */
+  /** Optional parameter to request total count for query */countTotal?: boolean; /** The number of glossaries to get. */
+  limit?: number; /** Optional parameter to request the next page. */
+  next?: string; /** Optional parameter to request the previous page. */
+  prev?: string; /** Optional resource field name to sort on, eg. name. Can be prefixed with +/- to determine order, defaults to (+) ascending. */
   sort?: "name" | "+name" | "-name" | "description" | "+description" | "-description";
 }, options?: ApiCallOptions): Promise<GetGlossariesHttpResponse>;
 type GetGlossariesHttpResponse = {
@@ -529,11 +471,8 @@ type CreateGlossaryHttpError = {
  * @throws ImportGlossaryHttpError
  */
 declare function importGlossary(query: {
-  /** Appending the current importer user as steward to categories/terms where no steward is defined/not match the identity service. */
-  importerAsFallbackSteward?: boolean;
-  /** Using email in the steward fields to lookup userIds in the identity service */
-  lookupUserOnEmail?: boolean;
-  /** The spaceId (leave blank or omit for personal) */
+  /** Appending the current importer user as steward to categories/terms where no steward is defined/not match the identity service. */importerAsFallbackSteward?: boolean; /** Using email in the steward fields to lookup userIds in the identity service */
+  lookupUserOnEmail?: boolean; /** The spaceId (leave blank or omit for personal) */
   spaceId?: string;
 }, body: QlikGlossary, options?: ApiCallOptions): Promise<ImportGlossaryHttpResponse>;
 type ImportGlossaryHttpResponse = {
@@ -652,15 +591,10 @@ type ExportGlossaryHttpError = {
  * @throws GetGlossaryCategoriesHttpError
  */
 declare function getGlossaryCategories(id: string, query: {
-  /** Optional parameter to request total count for query */
-  countTotal?: boolean;
-  /** The number of terms to get. */
-  limit?: number;
-  /** Optional parameter to request the next page. */
-  next?: string;
-  /** Optional parameter to request the previous page. */
-  prev?: string;
-  /** Optional resource field name to sort on, eg. name. Can be prefixed with +/- to determine order, defaults to (+) ascending. */
+  /** Optional parameter to request total count for query */countTotal?: boolean; /** The number of terms to get. */
+  limit?: number; /** Optional parameter to request the next page. */
+  next?: string; /** Optional parameter to request the previous page. */
+  prev?: string; /** Optional resource field name to sort on, eg. name. Can be prefixed with +/- to determine order, defaults to (+) ascending. */
   sort?: "description" | "+description" | "-description" | "name" | "+name" | "-name" | "update" | "+update" | "-update";
 }, options?: ApiCallOptions): Promise<GetGlossaryCategoriesHttpResponse>;
 type GetGlossaryCategoriesHttpResponse = {
@@ -775,8 +709,7 @@ type UpdateGlossaryCategoryHttpError = {
  * @throws GetGlossaryTermsHttpError
  */
 declare function getGlossaryTerms(id: string, query: {
-  /** Optional parameter to request total count for query */
-  countTotal?: boolean;
+  /** Optional parameter to request total count for query */countTotal?: boolean;
   /** Optional SCIM filter to be used to filter terms
    * Usable fields are
    *
@@ -789,14 +722,10 @@ declare function getGlossaryTerms(id: string, query: {
    * - stewards
    * - status
    * - categories */
-  filter?: string;
-  /** The number of terms to get. */
-  limit?: number;
-  /** Optional parameter to request the next page. */
-  next?: string;
-  /** Optional parameter to request the previous page. */
-  prev?: string;
-  /** Optional resource field name to sort on, eg. name. Can be prefixed with +/- to determine order, defaults to (+) ascending. */
+  filter?: string; /** The number of terms to get. */
+  limit?: number; /** Optional parameter to request the next page. */
+  next?: string; /** Optional parameter to request the previous page. */
+  prev?: string; /** Optional resource field name to sort on, eg. name. Can be prefixed with +/- to determine order, defaults to (+) ascending. */
   sort?: "abbreviation" | "+abbreviation" | "-abbreviation" | "description" | "+description" | "-description" | "name" | "+name" | "-name" | "status" | "+status" | "-status" | "updated" | "+updated" | "-updated";
 }, options?: ApiCallOptions): Promise<GetGlossaryTermsHttpResponse>;
 type GetGlossaryTermsHttpResponse = {
@@ -912,8 +841,7 @@ type UpdateGlossaryTermHttpError = {
  * @throws ChangeGlossaryTermStatusHttpError
  */
 declare function changeGlossaryTermStatus(id: string, termId: string, query: {
-  /** The status to update to. */
-  status: "draft" | "verified" | "deprecated";
+  /** The status to update to. */status: "draft" | "verified" | "deprecated";
 }, options?: ApiCallOptions): Promise<ChangeGlossaryTermStatusHttpResponse>;
 type ChangeGlossaryTermStatusHttpResponse = {
   data: Term;
@@ -934,17 +862,11 @@ type ChangeGlossaryTermStatusHttpError = {
  * @throws GetGlossaryTermLinksHttpError
  */
 declare function getGlossaryTermLinks(id: string, termId: string, query: {
-  /** Optional parameter to request total count for query */
-  countTotal?: boolean;
-  /** Optional SCIM filter to be used to filter terms */
-  filter?: string;
-  /** The number of terms to get. */
-  limit?: number;
-  /** Optional parameter to request the next page. */
-  next?: string;
-  /** Optional parameter to request the previous page. */
-  prev?: string;
-  /** Optional resource field name to sort on, eg. name. Can be prefixed with +/- to determine order, defaults to (+) ascending. */
+  /** Optional parameter to request total count for query */countTotal?: boolean; /** Optional SCIM filter to be used to filter terms */
+  filter?: string; /** The number of terms to get. */
+  limit?: number; /** Optional parameter to request the next page. */
+  next?: string; /** Optional parameter to request the previous page. */
+  prev?: string; /** Optional resource field name to sort on, eg. name. Can be prefixed with +/- to determine order, defaults to (+) ascending. */
   sort?: "type" | "+type" | "-type" | "subtype" | "+subtype" | "-subtype" | "created" | "+created" | "-created";
 }, options?: ApiCallOptions): Promise<GetGlossaryTermLinksHttpResponse>;
 type GetGlossaryTermLinksHttpResponse = {
@@ -987,15 +909,10 @@ type CreateGlossaryTermLinkHttpError = {
  * @throws GetGlossaryTermRevisionsHttpError
  */
 declare function getGlossaryTermRevisions(id: string, termId: string, query: {
-  /** Optional parameter to request total count for query */
-  countTotal?: boolean;
-  /** The number of terms to get. */
-  limit?: number;
-  /** Optional parameter to request the next page. */
-  next?: string;
-  /** Optional parameter to request the previous page. */
-  prev?: string;
-  /** Optional resource field name to sort on, eg. name. Can be prefixed with +/- to determine order, defaults to (+) ascending. */
+  /** Optional parameter to request total count for query */countTotal?: boolean; /** The number of terms to get. */
+  limit?: number; /** Optional parameter to request the next page. */
+  next?: string; /** Optional parameter to request the previous page. */
+  prev?: string; /** Optional resource field name to sort on, eg. name. Can be prefixed with +/- to determine order, defaults to (+) ascending. */
   sort?: "update" | "+update" | "-update";
 }, options?: ApiCallOptions): Promise<GetGlossaryTermRevisionsHttpResponse>;
 type GetGlossaryTermRevisionsHttpResponse = {

package/glossaries.js

@@ -1,5 +1,5 @@
-import "./chunks/public-runtime-modules-BqxAMJ9M.js";
-import { n as invokeFetch, t as clearApiCache } from "./chunks/invoke-fetch-CckTK7bh.js";
+import "./chunks/public-runtime-modules-2KfyI2qM.js";
+import { n as invokeFetch, t as clearApiCache } from "./chunks/invoke-fetch-DMAi6Fg3.js";
 
 //#region src/public/rest/glossaries.ts
 /**
@@ -464,7 +464,6 @@ const glossariesExport = {
 	getGlossaryTermRevisions,
 	clearCache
 };
-var glossaries_default = glossariesExport;
 
 //#endregion
-export { changeGlossaryTermStatus, clearCache, createGlossary, createGlossaryCategory, createGlossaryTerm, createGlossaryTermLink, glossaries_default as default, deleteGlossary, deleteGlossaryCategory, deleteGlossaryTerm, exportGlossary, getGlossaries, getGlossary, getGlossaryCategories, getGlossaryCategory, getGlossaryTerm, getGlossaryTermLinks, getGlossaryTermRevisions, getGlossaryTerms, importGlossary, patchGlossary, patchGlossaryCategory, patchGlossaryTerm, updateGlossary, updateGlossaryCategory, updateGlossaryTerm };
+export { changeGlossaryTermStatus, clearCache, createGlossary, createGlossaryCategory, createGlossaryTerm, createGlossaryTermLink, glossariesExport as default, deleteGlossary, deleteGlossaryCategory, deleteGlossaryTerm, exportGlossary, getGlossaries, getGlossary, getGlossaryCategories, getGlossaryCategory, getGlossaryTerm, getGlossaryTermLinks, getGlossaryTermRevisions, getGlossaryTerms, importGlossary, patchGlossary, patchGlossaryCategory, patchGlossaryTerm, updateGlossary, updateGlossaryCategory, updateGlossaryTerm };