@qlik/api 1.12.0 → 1.13.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/chunks/5V4BMSM2.js +1 -1
- package/groups.d.ts +4 -8
- package/licenses.d.ts +8 -4
- package/package.json +1 -1
- package/qix.d.ts +1 -1
- package/reports.d.ts +9 -7
- package/tenants.d.ts +2 -0
- package/users.d.ts +3 -3
package/chunks/5V4BMSM2.js
CHANGED
|
@@ -6,7 +6,7 @@ import {
|
|
|
6
6
|
} from "./2ZQ3ZX7F.js";
|
|
7
7
|
|
|
8
8
|
// src/public/invoke-fetch.ts
|
|
9
|
-
var defaultUserAgent = "qlik-api/1.
|
|
9
|
+
var defaultUserAgent = "qlik-api/1.13.0";
|
|
10
10
|
async function invokeFetch(api, props) {
|
|
11
11
|
const hostConfig = props.options?.hostConfig;
|
|
12
12
|
let userAgent;
|
package/groups.d.ts
CHANGED
|
@@ -2,7 +2,7 @@ import { A as ApiCallOptions } from './global.types-Xt6XzwlN.js';
|
|
|
2
2
|
import './auth-types-Bqw3vbLs.js';
|
|
3
3
|
|
|
4
4
|
/**
|
|
5
|
-
* An array of role references.
|
|
5
|
+
* An array of role references. Visibility dependant on access level. Must have access to roles to view other users' assigned roles.
|
|
6
6
|
*/
|
|
7
7
|
type AssignedRoles = {
|
|
8
8
|
/** The unique role identitier */
|
|
@@ -70,12 +70,8 @@ type Filter = {
|
|
|
70
70
|
* represents a Group document
|
|
71
71
|
*/
|
|
72
72
|
type Group = {
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
readonly level: "admin" | "user";
|
|
76
|
-
readonly name: string;
|
|
77
|
-
readonly type: "default";
|
|
78
|
-
}[];
|
|
73
|
+
/** An array of role references. Visibility dependant on access level. Must have access to roles to view other users' assigned roles. */
|
|
74
|
+
assignedRoles?: AssignedRoles;
|
|
79
75
|
/** The timestamp for when the group record was created. */
|
|
80
76
|
createdAt: string;
|
|
81
77
|
/** The unique identifier for the group */
|
|
@@ -136,7 +132,7 @@ type GroupSettings = {
|
|
|
136
132
|
syncIdpGroups: boolean;
|
|
137
133
|
systemGroups?: {
|
|
138
134
|
"000000000000000000000001"?: {
|
|
139
|
-
/** An array of role references. */
|
|
135
|
+
/** An array of role references. Visibility dependant on access level. Must have access to roles to view other users' assigned roles. */
|
|
140
136
|
assignedRoles?: AssignedRoles;
|
|
141
137
|
/** The timestamp for when the Everyone group was created. */
|
|
142
138
|
createdAt?: string;
|
package/licenses.d.ts
CHANGED
|
@@ -52,23 +52,27 @@ type AssignmentsActionsDeleteResponse = {
|
|
|
52
52
|
};
|
|
53
53
|
type AssignmentsActionsUpdateRequest = {
|
|
54
54
|
update: {
|
|
55
|
+
/** The current user subject, in case that should be patched. */
|
|
56
|
+
sourceSubject?: string;
|
|
55
57
|
/** Current assignment type. */
|
|
56
|
-
sourceType
|
|
57
|
-
/** User subject */
|
|
58
|
+
sourceType?: string;
|
|
59
|
+
/** User subject, the current or the desired after the patch. */
|
|
58
60
|
subject: string;
|
|
59
61
|
/** Target assignment type. */
|
|
60
|
-
type
|
|
62
|
+
type?: string;
|
|
61
63
|
}[];
|
|
62
64
|
};
|
|
63
65
|
type AssignmentsActionsUpdateResponse = {
|
|
64
66
|
data: {
|
|
65
67
|
/** Error code */
|
|
66
68
|
code?: string;
|
|
69
|
+
/** Current subject. */
|
|
70
|
+
sourceSubject?: string;
|
|
67
71
|
/** Current allotment type. */
|
|
68
72
|
sourceType?: string;
|
|
69
73
|
/** Response status */
|
|
70
74
|
status: number;
|
|
71
|
-
/**
|
|
75
|
+
/** Target subject. */
|
|
72
76
|
subject?: string;
|
|
73
77
|
/** Error title */
|
|
74
78
|
title?: string;
|
package/package.json
CHANGED
package/qix.d.ts
CHANGED
package/reports.d.ts
CHANGED
|
@@ -299,14 +299,16 @@ type ReportRequest = {
|
|
|
299
299
|
/** Define the request metadata. It includes priority, deadline and future settings on execution policy of the request. */
|
|
300
300
|
meta?: Meta;
|
|
301
301
|
output: OutputItem;
|
|
302
|
-
/** Used to
|
|
303
|
-
senseExcelTemplate?:
|
|
302
|
+
/** Used to produce reports from a template file. */
|
|
303
|
+
senseExcelTemplate?: SenseFileTemplate;
|
|
304
304
|
/** Used to export a single visualization as pdf, pptx or png. */
|
|
305
305
|
senseImageTemplate?: SenseImageTemplate;
|
|
306
|
+
/** Used to produce reports from a template file. */
|
|
307
|
+
sensePixelPerfectTemplate?: SenseFileTemplate;
|
|
306
308
|
/** Used to export a sheet as pdf or pptx. */
|
|
307
309
|
senseSheetTemplate?: SenseSheetTemplate;
|
|
308
310
|
/** Template type and version using semantic versioning. It must have the following name convention: dashed-separated-template-name-MAJOR.MINOR.
|
|
309
|
-
* Please note that sense-story-x.0, sense-data-x.0 and qv-data-x.0 are only for internal use.
|
|
311
|
+
* Please note that sense-pixel-perfect-template-1.0, sense-story-x.0, sense-data-x.0 and qv-data-x.0 are only for internal use.
|
|
310
312
|
*
|
|
311
313
|
* Each type requires a specific template to be provided:
|
|
312
314
|
* - composition-1.0 requires compositionTemplates to be set
|
|
@@ -319,7 +321,7 @@ type ReportRequest = {
|
|
|
319
321
|
* - sense-excel-template-1.0 supports excel and pdf output type
|
|
320
322
|
* - sense-image-1.0 supports pdf, pptx and png output types
|
|
321
323
|
* - sense-sheet-1.0 supports pdf, pptx output type */
|
|
322
|
-
type: "composition-1.0" | "sense-image-1.0" | "sense-data-1.0" | "sense-sheet-1.0" | "sense-story-1.0" | "qv-data-1.0" | "qv-data-2.0" | "sense-excel-template-1.0";
|
|
324
|
+
type: "composition-1.0" | "sense-image-1.0" | "sense-data-1.0" | "sense-sheet-1.0" | "sense-story-1.0" | "qv-data-1.0" | "qv-data-2.0" | "sense-excel-template-1.0" | "sense-pixel-perfect-template-1.0";
|
|
323
325
|
};
|
|
324
326
|
type ReportStatus = {
|
|
325
327
|
/** Present when status is failed. */
|
|
@@ -377,9 +379,9 @@ type SelectionFilter = {
|
|
|
377
379
|
};
|
|
378
380
|
type SelectionStrategy = "failOnErrors" | "ignoreErrorsReturnDetails" | "ignoreErrorsNoDetails";
|
|
379
381
|
/**
|
|
380
|
-
* Used to
|
|
382
|
+
* Used to produce reports from a template file.
|
|
381
383
|
*/
|
|
382
|
-
type
|
|
384
|
+
type SenseFileTemplate = {
|
|
383
385
|
/** A JSON object that is passed as-is to the mashup page while rendering, this will be applied to all charts within the sheet. It includes properties of the whole sheet such as theme, gradient etc. Currently only the "theme" property is supported. */
|
|
384
386
|
jsOpts?: unknown;
|
|
385
387
|
/** Choose the reloadTimestamp constraint to apply. An empty value leads to the default noCheck. */
|
|
@@ -541,4 +543,4 @@ interface ReportsAPI {
|
|
|
541
543
|
*/
|
|
542
544
|
declare const reportsExport: ReportsAPI;
|
|
543
545
|
|
|
544
|
-
export { type AppError, type AppErrors, type CallBackAction, type ChainableSelection, type ChainableSelectionType, type ComposableTemplate, type CreateReportHttpError, type CreateReportHttpResponse, type Definitions, type DocProperties, type Error, type ExcelOutput, type ExportError, type ExportErrors, type Float64, type GetReportStatusHttpError, type GetReportStatusHttpResponse, type HttpRequest, type ImageOutput, type Meta, type MetaExportError, type NxPatch, type OutputItem, type PdfCompositionOutput, type PdfOutput, type PptxCompositionOutput, type PptxOutput, type QFieldValue, type QSelection, type Reason, type ReloadTimestampMatchType, type ReportRequest, type ReportStatus, type ReportsAPI, type Result, type SelectionChain, type SelectionError, type SelectionErrors, type SelectionFilter, type SelectionStrategy, type
|
|
546
|
+
export { type AppError, type AppErrors, type CallBackAction, type ChainableSelection, type ChainableSelectionType, type ComposableTemplate, type CreateReportHttpError, type CreateReportHttpResponse, type Definitions, type DocProperties, type Error, type ExcelOutput, type ExportError, type ExportErrors, type Float64, type GetReportStatusHttpError, type GetReportStatusHttpResponse, type HttpRequest, type ImageOutput, type Meta, type MetaExportError, type NxPatch, type OutputItem, type PdfCompositionOutput, type PdfOutput, type PptxCompositionOutput, type PptxOutput, type QFieldValue, type QSelection, type Reason, type ReloadTimestampMatchType, type ReportRequest, type ReportStatus, type ReportsAPI, type Result, type SelectionChain, type SelectionError, type SelectionErrors, type SelectionFilter, type SelectionStrategy, type SenseFileTemplate, type SenseImageTemplate, type SensePersistentBookmark, type SenseSheetTemplate, type SenseTemporaryBookmarkV2, type Sheet, type TemplateLocation, type Visualization, clearCache, createReport, reportsExport as default, getReportStatus };
|
package/tenants.d.ts
CHANGED
|
@@ -45,6 +45,8 @@ type Tenant = {
|
|
|
45
45
|
enableAnalyticCreation?: boolean;
|
|
46
46
|
/** List of case insensitive hostnames that are mapped to the tenant. The first record maps to the display name and the subsequent entries are aliases. */
|
|
47
47
|
hostnames?: string[];
|
|
48
|
+
/** The unique tenant identifier. */
|
|
49
|
+
readonly id: string;
|
|
48
50
|
/** The timestamp for when the tenant record was last updated (1970-01-01T00:00:00.001Z for static tenants). */
|
|
49
51
|
readonly lastUpdated?: string;
|
|
50
52
|
readonly links?: {
|
package/users.d.ts
CHANGED
|
@@ -5,7 +5,7 @@ import './auth-types-Bqw3vbLs.js';
|
|
|
5
5
|
* An array of group references.
|
|
6
6
|
*/
|
|
7
7
|
type AssignedGroups = {
|
|
8
|
-
/** An array of role references. */
|
|
8
|
+
/** An array of role references. Visibility dependant on access level. Must have access to roles to view other users' assigned roles. */
|
|
9
9
|
assignedRoles?: AssignedRoles;
|
|
10
10
|
/** The unique group identitier */
|
|
11
11
|
id: string;
|
|
@@ -13,7 +13,7 @@ type AssignedGroups = {
|
|
|
13
13
|
readonly name: string;
|
|
14
14
|
}[];
|
|
15
15
|
/**
|
|
16
|
-
* An array of role references.
|
|
16
|
+
* An array of role references. Visibility dependant on access level. Must have access to roles to view other users' assigned roles.
|
|
17
17
|
*/
|
|
18
18
|
type AssignedRoles = {
|
|
19
19
|
/** The unique role identitier */
|
|
@@ -169,7 +169,7 @@ type ResultItem = {
|
|
|
169
169
|
type User = {
|
|
170
170
|
/** An array of group references. */
|
|
171
171
|
assignedGroups?: AssignedGroups;
|
|
172
|
-
/** An array of role references. */
|
|
172
|
+
/** An array of role references. Visibility dependant on access level. Must have access to roles to view other users' assigned roles. */
|
|
173
173
|
assignedRoles?: AssignedRoles;
|
|
174
174
|
/** An array of scopes assigned to user */
|
|
175
175
|
readonly assignedScopes?: AssignedScopes;
|