@qlik/api 0.0.4 → 0.0.6
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/README.md +83 -2
- package/api-keys.d.mts +1 -1
- package/api-keys.d.ts +1 -1
- package/api-keys.js +10 -10
- package/api-keys.mjs +2 -2
- package/apps.d.mts +21 -62
- package/apps.d.ts +21 -62
- package/apps.js +46 -46
- package/apps.mjs +2 -2
- package/audits.d.mts +1 -1
- package/audits.d.ts +1 -1
- package/audits.js +9 -9
- package/audits.mjs +2 -2
- package/auth-6VOJ5YIL.js +41 -0
- package/{auth-CPBNNC7S.mjs → auth-7HMK2Q6F.mjs} +1 -1
- package/auth.js +3 -3
- package/auth.mjs +2 -2
- package/automations.d.mts +1 -1
- package/automations.d.ts +1 -1
- package/automations.js +21 -21
- package/automations.mjs +2 -2
- package/brands.d.mts +1 -1
- package/brands.d.ts +1 -1
- package/brands.js +15 -15
- package/brands.mjs +2 -2
- package/{chunk-D52VW5UN.js → chunk-2II4JNZO.js} +17 -13
- package/{chunk-GV5SRHY2.js → chunk-2NSUC46G.js} +4 -4
- package/{chunk-7RY3NO6N.js → chunk-7PAVHCQG.js} +2 -2
- package/{chunk-GNWU6SP2.mjs → chunk-EDRFS7GY.mjs} +1 -1
- package/{chunk-3SVRHJII.mjs → chunk-GLWHVX4M.mjs} +3 -3
- package/{chunk-2STFUQKQ.js → chunk-JZAPZIPR.js} +3 -3
- package/{chunk-TE7XMBT5.mjs → chunk-PUBPF4EZ.mjs} +1 -1
- package/{chunk-CYRLVHU3.mjs → chunk-QLS6D4AX.mjs} +17 -13
- package/{chunk-67GJTTPV.mjs → chunk-UXRTUKY5.mjs} +1 -1
- package/{chunk-JNGURO23.js → chunk-XJKF347C.js} +3 -3
- package/collections.d.mts +1 -1
- package/collections.d.ts +1 -1
- package/collections.js +14 -14
- package/collections.mjs +2 -2
- package/csp-origins.d.mts +1 -1
- package/csp-origins.d.ts +1 -1
- package/csp-origins.js +9 -9
- package/csp-origins.mjs +2 -2
- package/data-assets.d.mts +1 -1
- package/data-assets.d.ts +1 -1
- package/data-assets.js +8 -8
- package/data-assets.mjs +2 -2
- package/data-connections.d.mts +1 -1
- package/data-connections.d.ts +1 -1
- package/data-connections.js +12 -12
- package/data-connections.mjs +2 -2
- package/data-credentials.d.mts +1 -1
- package/data-credentials.d.ts +1 -1
- package/data-credentials.js +7 -7
- package/data-credentials.mjs +2 -2
- package/data-files.d.mts +1 -1
- package/data-files.d.ts +1 -1
- package/data-files.js +15 -15
- package/data-files.mjs +2 -2
- package/docs/authentication.md +220 -0
- package/docs/examples/create-app.md +51 -0
- package/docs/examples/create-session-app.md +88 -0
- package/docs/examples/fetch-spaces.md +104 -0
- package/docs/examples/show-sheet-list.md +81 -0
- package/docs/examples.md +10 -2
- package/docs/features.md +129 -0
- package/docs/qix.md +85 -0
- package/docs/rest.md +64 -0
- package/{enigma-session-XPXDQAIV.js → enigma-session-2OXUKTWL.js} +4 -4
- package/{enigma-session-ZH6MYA54.mjs → enigma-session-L4P4IJWW.mjs} +1 -1
- package/{esm-OY4XVIJB.mjs → esm-HMY2LVVZ.mjs} +1 -1
- package/{esm-3VXX2GKL.js → esm-PXQUPJYJ.js} +1 -1
- package/extensions.d.mts +1 -1
- package/extensions.d.ts +1 -1
- package/extensions.js +10 -10
- package/extensions.mjs +2 -2
- package/{global.types-hIvp-WdX.d.ts → global.types-1rNhDH7j.d.ts} +9 -0
- package/{global.types-Eto4uYwy.d.mts → global.types-4jzAvW7R.d.mts} +9 -0
- package/glossaries.d.mts +1 -1
- package/glossaries.d.ts +1 -1
- package/glossaries.js +27 -27
- package/glossaries.mjs +2 -2
- package/groups.d.mts +1 -1
- package/groups.d.ts +1 -1
- package/groups.js +11 -11
- package/groups.mjs +2 -2
- package/identity-providers.d.mts +1 -1
- package/identity-providers.d.ts +1 -1
- package/identity-providers.js +11 -11
- package/identity-providers.mjs +2 -2
- package/index.d.mts +1 -1
- package/index.d.ts +1 -1
- package/index.js +8 -8
- package/index.mjs +4 -4
- package/{invoke-fetch-3WZWAAZH.mjs → invoke-fetch-CK5Y37H3.mjs} +1 -1
- package/invoke-fetch-D52L5Y7B.js +17 -0
- package/items.d.mts +1 -1
- package/items.d.ts +1 -1
- package/items.js +11 -11
- package/items.mjs +2 -2
- package/licenses.d.mts +1 -1
- package/licenses.d.ts +1 -1
- package/licenses.js +12 -12
- package/licenses.mjs +2 -2
- package/package.json +4 -4
- package/{qix-UNWXPGMA.js → qix-FLNSZRQX.js} +8 -8
- package/{qix-ZSJ4PIK3.mjs → qix-MP65NOTD.mjs} +2 -2
- package/qix.d.mts +2 -2
- package/qix.d.ts +2 -2
- package/qix.js +3 -3
- package/qix.mjs +2 -2
- package/quotas.d.mts +1 -1
- package/quotas.d.ts +1 -1
- package/quotas.js +5 -5
- package/quotas.mjs +2 -2
- package/reload-tasks.d.mts +1 -1
- package/reload-tasks.d.ts +1 -1
- package/reload-tasks.js +8 -8
- package/reload-tasks.mjs +2 -2
- package/reloads.d.mts +1 -1
- package/reloads.d.ts +1 -1
- package/reloads.js +7 -7
- package/reloads.mjs +2 -2
- package/roles.d.mts +1 -1
- package/roles.d.ts +1 -1
- package/roles.js +5 -5
- package/roles.mjs +2 -2
- package/spaces.d.mts +1 -1
- package/spaces.d.ts +1 -1
- package/spaces.js +15 -15
- package/spaces.mjs +2 -2
- package/temp-contents.d.mts +1 -1
- package/temp-contents.d.ts +1 -1
- package/temp-contents.js +6 -6
- package/temp-contents.mjs +2 -2
- package/tenants.d.mts +1 -1
- package/tenants.d.ts +1 -1
- package/tenants.js +9 -9
- package/tenants.mjs +2 -2
- package/themes.d.mts +1 -1
- package/themes.d.ts +1 -1
- package/themes.js +10 -10
- package/themes.mjs +2 -2
- package/transports.d.mts +1 -1
- package/transports.d.ts +1 -1
- package/transports.js +9 -9
- package/transports.mjs +2 -2
- package/users.d.mts +1 -1
- package/users.d.ts +1 -1
- package/users.js +13 -13
- package/users.mjs +2 -2
- package/web-integrations.d.mts +1 -1
- package/web-integrations.d.ts +1 -1
- package/web-integrations.js +8 -8
- package/web-integrations.mjs +2 -2
- package/web-notifications.d.mts +1 -1
- package/web-notifications.d.ts +1 -1
- package/web-notifications.js +9 -9
- package/web-notifications.mjs +2 -2
- package/webhooks.d.mts +1 -1
- package/webhooks.d.ts +1 -1
- package/webhooks.js +13 -13
- package/webhooks.mjs +2 -2
- package/auth-AWZV4DPP.js +0 -41
- package/invoke-fetch-UNTAUR7O.js +0 -17
package/README.md
CHANGED
|
@@ -1,6 +1,87 @@
|
|
|
1
1
|
# @qlik/api
|
|
2
2
|
|
|
3
|
+
[](https://www.npmjs.com/package/@qlik/api)
|
|
4
|
+
[](https://opensource.org/licenses/ISC)
|
|
5
|
+
|
|
3
6
|
> **Warning**
|
|
4
|
-
> This package is
|
|
7
|
+
> This package is currently in pre-release mode and will likely change and break until the version number 1.0.0 is released.
|
|
8
|
+
|
|
9
|
+
This package provides a JavaScript API for interacting with Qlik Sense REST APIs includin the QIX Engine from a single package that can be used in both Node.js and browser contexts.
|
|
10
|
+
|
|
11
|
+
## Table of Contents
|
|
12
|
+
|
|
13
|
+
- [Getting Started](#getting-started)
|
|
14
|
+
- [Module Structure](#module-structure)
|
|
15
|
+
- [REST API](./docs/rest.md)
|
|
16
|
+
- [QIX API](./docs/qix.md)
|
|
17
|
+
- [Features](./docs/features.md)
|
|
18
|
+
- [Authentication](./docs/authentication.md)
|
|
19
|
+
- [Examples](./docs/examples.md)
|
|
20
|
+
|
|
21
|
+
## Getting Started
|
|
22
|
+
|
|
23
|
+
For NodeJS applications or in the case of building a web app with a bundler use:
|
|
24
|
+
|
|
25
|
+
```sh
|
|
26
|
+
npm install --save @qlik/api
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
If code will run directly in a browser it is recommended to load the code directly from a CDN.
|
|
30
|
+
|
|
31
|
+
```html
|
|
32
|
+
<script type="module">
|
|
33
|
+
import qlikApi from "https://cdn.jsdelivr.net/npm/@qlik/api/index.mjs";
|
|
34
|
+
...
|
|
35
|
+
</script>
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
### Module structure
|
|
39
|
+
|
|
40
|
+
`@qlik/api` is a collection of javascript modules which each exposes an api built to make the integration process for javascript solutions as easy as possible. The library is built for both browser and NodeJS usage and will seamlessly integrate with `@qlik/embed` libraries.
|
|
41
|
+
|
|
42
|
+
The modules can be imported in a few different ways. Either directly through a sub module
|
|
43
|
+
|
|
44
|
+
```ts
|
|
45
|
+
import subModule, { namedExport, type NamedType } from "@qlik/api/sub-module";
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
Or through the main module. If types from a sub module is needed they can only be imported directly from the sub module itself. They can't be imported from the main module.
|
|
49
|
+
|
|
50
|
+
```ts
|
|
51
|
+
import { subModuleA, subModuleB } from "@qlik/api";
|
|
52
|
+
import type { SubModuleAType } from "@qlik/api/sub-module-a";
|
|
53
|
+
import type { SubModuleBType } from "@qlik/api/sub-module-b";
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
`@qlik/api` also has a default export with each sub module as properties.
|
|
57
|
+
|
|
58
|
+
```ts
|
|
59
|
+
import qlikApi from "@qlik/api";
|
|
60
|
+
|
|
61
|
+
qlikApi.subModuleA;
|
|
62
|
+
qlikApi.subModuleB;
|
|
63
|
+
```
|
|
64
|
+
|
|
65
|
+
The modules that can be imported from `@qlik/api` are the rest entities, the `qix` sub module and an `auth` module. All described below.
|
|
66
|
+
|
|
67
|
+
## REST API
|
|
68
|
+
|
|
69
|
+
`@qlik/api` library is generated from open-api specifications released from those Qlik Cloud services that exposes a restful API. The code generation tool runs using the specs building typescript for all api calls specified in the specs. One module per api is generated.
|
|
70
|
+
|
|
71
|
+
More info can be found in the [rest](./docs/rest.md) section.
|
|
72
|
+
|
|
73
|
+
## QIX API
|
|
74
|
+
|
|
75
|
+
One of the most important services available is Qlik's Analytics Engine Service which is also known as the QIX engine. `@qlik/api` offers a fully typed api for connecting to and consuming Qlik Sense Applications including "Qlik Sense mixins" which previously only was used internally by in-house Qlik developers. More info about QIX can be found in the [qix](./docs/qix.md) section.
|
|
76
|
+
|
|
77
|
+
## Authentication
|
|
78
|
+
|
|
79
|
+
`@qlik/api` comes with several authentication options to make the integration experience as easy as possible for external users. Go to the [authentication](./docs/authentication.md) section for more.
|
|
80
|
+
|
|
81
|
+
## Features
|
|
82
|
+
|
|
83
|
+
`@qlik/api` comes with some handy features to make the development experience as good as possible. Some of them are described in the [features](./docs/features.md) section.
|
|
84
|
+
|
|
85
|
+
## Examples
|
|
5
86
|
|
|
6
|
-
|
|
87
|
+
Check out the [examples](./docs/examples.md) section.
|
package/api-keys.d.mts
CHANGED
package/api-keys.d.ts
CHANGED
package/api-keys.js
CHANGED
|
@@ -1,31 +1,31 @@
|
|
|
1
1
|
"use strict";Object.defineProperty(exports, "__esModule", {value: true});
|
|
2
2
|
|
|
3
3
|
|
|
4
|
-
var
|
|
5
|
-
require('./chunk-
|
|
4
|
+
var _chunkXJKF347Cjs = require('./chunk-XJKF347C.js');
|
|
5
|
+
require('./chunk-JZAPZIPR.js');
|
|
6
6
|
require('./chunk-P57PW2II.js');
|
|
7
7
|
|
|
8
8
|
// src/public/rest/api-keys.ts
|
|
9
|
-
var getApiKeys = async (query, options) =>
|
|
9
|
+
var getApiKeys = async (query, options) => _chunkXJKF347Cjs.invokeFetch.call(void 0, "api-keys", {
|
|
10
10
|
method: "get",
|
|
11
11
|
pathTemplate: "/api/v1/api-keys",
|
|
12
12
|
query,
|
|
13
13
|
options
|
|
14
14
|
});
|
|
15
|
-
var createApiKey = async (body, options) =>
|
|
15
|
+
var createApiKey = async (body, options) => _chunkXJKF347Cjs.invokeFetch.call(void 0, "api-keys", {
|
|
16
16
|
method: "post",
|
|
17
17
|
pathTemplate: "/api/v1/api-keys",
|
|
18
18
|
body,
|
|
19
19
|
contentType: "application/json",
|
|
20
20
|
options
|
|
21
21
|
});
|
|
22
|
-
var getApiKeysConfig = async (tenantId, options) =>
|
|
22
|
+
var getApiKeysConfig = async (tenantId, options) => _chunkXJKF347Cjs.invokeFetch.call(void 0, "api-keys", {
|
|
23
23
|
method: "get",
|
|
24
24
|
pathTemplate: "/api/v1/api-keys/configs/{tenantId}",
|
|
25
25
|
pathVariables: { tenantId },
|
|
26
26
|
options
|
|
27
27
|
});
|
|
28
|
-
var patchApiKeysConfig = async (tenantId, body, options) =>
|
|
28
|
+
var patchApiKeysConfig = async (tenantId, body, options) => _chunkXJKF347Cjs.invokeFetch.call(void 0, "api-keys", {
|
|
29
29
|
method: "patch",
|
|
30
30
|
pathTemplate: "/api/v1/api-keys/configs/{tenantId}",
|
|
31
31
|
pathVariables: { tenantId },
|
|
@@ -33,19 +33,19 @@ var patchApiKeysConfig = async (tenantId, body, options) => _chunkJNGURO23js.inv
|
|
|
33
33
|
contentType: "application/json",
|
|
34
34
|
options
|
|
35
35
|
});
|
|
36
|
-
var deleteApiKey = async (id, options) =>
|
|
36
|
+
var deleteApiKey = async (id, options) => _chunkXJKF347Cjs.invokeFetch.call(void 0, "api-keys", {
|
|
37
37
|
method: "delete",
|
|
38
38
|
pathTemplate: "/api/v1/api-keys/{id}",
|
|
39
39
|
pathVariables: { id },
|
|
40
40
|
options
|
|
41
41
|
});
|
|
42
|
-
var getApiKey = async (id, options) =>
|
|
42
|
+
var getApiKey = async (id, options) => _chunkXJKF347Cjs.invokeFetch.call(void 0, "api-keys", {
|
|
43
43
|
method: "get",
|
|
44
44
|
pathTemplate: "/api/v1/api-keys/{id}",
|
|
45
45
|
pathVariables: { id },
|
|
46
46
|
options
|
|
47
47
|
});
|
|
48
|
-
var patchApiKey = async (id, body, options) =>
|
|
48
|
+
var patchApiKey = async (id, body, options) => _chunkXJKF347Cjs.invokeFetch.call(void 0, "api-keys", {
|
|
49
49
|
method: "patch",
|
|
50
50
|
pathTemplate: "/api/v1/api-keys/{id}",
|
|
51
51
|
pathVariables: { id },
|
|
@@ -54,7 +54,7 @@ var patchApiKey = async (id, body, options) => _chunkJNGURO23js.invokeFetch.call
|
|
|
54
54
|
options
|
|
55
55
|
});
|
|
56
56
|
function clearCache() {
|
|
57
|
-
return
|
|
57
|
+
return _chunkXJKF347Cjs.clearApiCache.call(void 0, "api-keys");
|
|
58
58
|
}
|
|
59
59
|
var apiKeysExport = {
|
|
60
60
|
getApiKeys,
|
package/api-keys.mjs
CHANGED
package/apps.d.mts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { A as ApiCallOptions } from './global.types-
|
|
1
|
+
import { A as ApiCallOptions } from './global.types-4jzAvW7R.mjs';
|
|
2
2
|
import './auth-types-nnUcWhuU.mjs';
|
|
3
3
|
|
|
4
4
|
type Analysis = "breakdown" | "changePoint" | "comparison" | "contribution" | "correlation" | "fact" | "mutualInfo" | "rank" | "spike" | "trend" | "values";
|
|
@@ -88,12 +88,7 @@ type AppAttributes = {
|
|
|
88
88
|
name?: string;
|
|
89
89
|
/** The space ID of the application */
|
|
90
90
|
spaceId?: string;
|
|
91
|
-
|
|
92
|
-
*
|
|
93
|
-
* One of:
|
|
94
|
-
* * ANALYTICS
|
|
95
|
-
* * DATA_PREPARATION */
|
|
96
|
-
usage?: "ANALYTICS" | "DATA_PREPARATION";
|
|
91
|
+
usage?: UsageEnum;
|
|
97
92
|
};
|
|
98
93
|
type AppContentList = {
|
|
99
94
|
/** Content list items. */
|
|
@@ -113,6 +108,7 @@ type AppContentListItem = {
|
|
|
113
108
|
/** Content type. */
|
|
114
109
|
type?: string;
|
|
115
110
|
};
|
|
111
|
+
type AppObjectGenericType = "genericObject" | "genericBookmark" | "genericMeasure" | "genericDimension" | "genericVariable";
|
|
116
112
|
type AppUpdateAttributes = {
|
|
117
113
|
/** The description of the application. */
|
|
118
114
|
description?: string;
|
|
@@ -141,11 +137,7 @@ type DataModelMetadata = {
|
|
|
141
137
|
tables?: TableMetadata[];
|
|
142
138
|
/** Profiling data of the tables in the app. */
|
|
143
139
|
tables_profiling_data?: TableProfilingData[];
|
|
144
|
-
|
|
145
|
-
* One of:
|
|
146
|
-
* * ANALYTICS
|
|
147
|
-
* * DATA_PREPARATION */
|
|
148
|
-
usage?: "ANALYTICS" | "DATA_PREPARATION";
|
|
140
|
+
usage?: UsageEnum;
|
|
149
141
|
};
|
|
150
142
|
type Error = {
|
|
151
143
|
/** The error code. */
|
|
@@ -174,6 +166,7 @@ type EvaluatorError = {
|
|
|
174
166
|
title?: string;
|
|
175
167
|
}[];
|
|
176
168
|
};
|
|
169
|
+
type FieldAttrType = "U" | "A" | "I" | "R" | "F" | "M" | "D" | "T" | "TS" | "IV";
|
|
177
170
|
type FieldAttributes = {
|
|
178
171
|
/** Defines the decimal separator.
|
|
179
172
|
* Example: **.** */
|
|
@@ -187,21 +180,7 @@ type FieldAttributes = {
|
|
|
187
180
|
* Is used if **qUseThou** is set to 1.
|
|
188
181
|
* Example: **,** */
|
|
189
182
|
Thou?: string;
|
|
190
|
-
|
|
191
|
-
* Default is U.
|
|
192
|
-
*
|
|
193
|
-
* One of:
|
|
194
|
-
* * U or UNKNOWN
|
|
195
|
-
* * A or ASCII
|
|
196
|
-
* * I or INTEGER
|
|
197
|
-
* * R or REAL
|
|
198
|
-
* * F or FIX
|
|
199
|
-
* * M or MONEY
|
|
200
|
-
* * D or DATE
|
|
201
|
-
* * T or TIME
|
|
202
|
-
* * TS or TIMESTAMP
|
|
203
|
-
* * IV or INTERVAL */
|
|
204
|
-
Type?: "UNKNOWN" | "ASCII" | "INTEGER" | "REAL" | "FIX" | "MONEY" | "DATE" | "TIME" | "TIMESTAMP" | "INTERVAL";
|
|
183
|
+
Type?: FieldAttrType;
|
|
205
184
|
/** Defines whether or not a thousands separator must be used.
|
|
206
185
|
* Default is 0. */
|
|
207
186
|
UseThou?: number;
|
|
@@ -601,11 +580,7 @@ type NxAttributes = {
|
|
|
601
580
|
published?: boolean;
|
|
602
581
|
/** App thumbnail. */
|
|
603
582
|
thumbnail?: string;
|
|
604
|
-
|
|
605
|
-
* One of:
|
|
606
|
-
* * ANALYTICS
|
|
607
|
-
* * DATA_PREPARATION */
|
|
608
|
-
usage?: "ANALYTICS" | "DATA_PREPARATION";
|
|
583
|
+
usage?: UsageEnum;
|
|
609
584
|
};
|
|
610
585
|
type NxObjectAttributes = {
|
|
611
586
|
/** True if the object is approved. */
|
|
@@ -614,15 +589,7 @@ type NxObjectAttributes = {
|
|
|
614
589
|
createdAt?: string;
|
|
615
590
|
/** Object description. */
|
|
616
591
|
description?: string;
|
|
617
|
-
|
|
618
|
-
*
|
|
619
|
-
* One of:
|
|
620
|
-
* * genericObject
|
|
621
|
-
* * genericBookmark
|
|
622
|
-
* * genericMeasure
|
|
623
|
-
* * genericDimension
|
|
624
|
-
* * genericVariable */
|
|
625
|
-
genericType?: "genericObject" | "genericBookmark" | "genericMeasure" | "genericDimension" | "genericVariable";
|
|
592
|
+
genericType?: AppObjectGenericType;
|
|
626
593
|
/** The object Id. */
|
|
627
594
|
id?: string;
|
|
628
595
|
/** Object name. */
|
|
@@ -637,13 +604,7 @@ type NxObjectAttributes = {
|
|
|
637
604
|
updatedAt?: string;
|
|
638
605
|
};
|
|
639
606
|
type NxPatch = {
|
|
640
|
-
|
|
641
|
-
*
|
|
642
|
-
* One of:
|
|
643
|
-
* * add or Add
|
|
644
|
-
* * remove or Remove
|
|
645
|
-
* * replace or Replace */
|
|
646
|
-
Op?: "Add" | "Remove" | "Replace";
|
|
607
|
+
Op?: NxPatchOperationType;
|
|
647
608
|
/** Path to the property to add, remove or replace. */
|
|
648
609
|
Path?: string;
|
|
649
610
|
/** This parameter is not used in a remove operation.
|
|
@@ -652,6 +613,7 @@ type NxPatch = {
|
|
|
652
613
|
* "false", "2", "\"New title\"" */
|
|
653
614
|
Value?: string;
|
|
654
615
|
};
|
|
616
|
+
type NxPatchOperationType = "add" | "remove" | "replace";
|
|
655
617
|
type PartialNluInfo = {
|
|
656
618
|
/** Qlik sense application field selected for given token or phrase */
|
|
657
619
|
fieldName?: string;
|
|
@@ -666,12 +628,7 @@ type PartialNluInfo = {
|
|
|
666
628
|
};
|
|
667
629
|
type PublishApp = {
|
|
668
630
|
attributes?: AppUpdateAttributes;
|
|
669
|
-
|
|
670
|
-
* The default is source.
|
|
671
|
-
*
|
|
672
|
-
* * source: Publish with source data
|
|
673
|
-
* * target: Publish with target data */
|
|
674
|
-
data?: "source" | "target";
|
|
631
|
+
data?: PublishData;
|
|
675
632
|
/** The original is moved instead of copied. The current published state of all objects is kept. */
|
|
676
633
|
moveApp?: boolean;
|
|
677
634
|
/** If app is moved, originAppId needs to be provided. */
|
|
@@ -679,6 +636,7 @@ type PublishApp = {
|
|
|
679
636
|
/** The managed space ID where the app will be published. */
|
|
680
637
|
spaceId?: string;
|
|
681
638
|
};
|
|
639
|
+
type PublishData = "source" | "target";
|
|
682
640
|
type RecommendFieldItem = {
|
|
683
641
|
name?: string;
|
|
684
642
|
overrides?: FieldOverride;
|
|
@@ -719,6 +677,10 @@ type ReloadListMetadata = {
|
|
|
719
677
|
data?: ReloadMeta[];
|
|
720
678
|
};
|
|
721
679
|
type ReloadMeta = {
|
|
680
|
+
/** A Base64-encoded hash value of the new section access database. */
|
|
681
|
+
accessDbHash?: string;
|
|
682
|
+
/** A Base64-encoded hash value of the new app database. */
|
|
683
|
+
appDbHash?: string;
|
|
722
684
|
/** Duration of reload (ms). */
|
|
723
685
|
duration?: number;
|
|
724
686
|
/** Time when reload ended. */
|
|
@@ -770,12 +732,7 @@ type RepublishApp = {
|
|
|
770
732
|
attributes?: AppUpdateAttributes;
|
|
771
733
|
/** Validate that source app is same as originally published. */
|
|
772
734
|
checkOriginAppId?: boolean;
|
|
773
|
-
|
|
774
|
-
* The default is source.
|
|
775
|
-
*
|
|
776
|
-
* * source: Publish with source data
|
|
777
|
-
* * target: Publish with target data */
|
|
778
|
-
data?: "source" | "target";
|
|
735
|
+
data?: PublishData;
|
|
779
736
|
/** The target ID to be republished. */
|
|
780
737
|
targetId?: string;
|
|
781
738
|
};
|
|
@@ -867,6 +824,8 @@ type UpdateOwner = {
|
|
|
867
824
|
type UpdateSpace = {
|
|
868
825
|
spaceId?: string;
|
|
869
826
|
};
|
|
827
|
+
type UsageEnum = "ANALYTICS" | "DATA_PREPARATION";
|
|
828
|
+
type UserPrivileges = "can_create_app" | "can_import_app" | "can_create_session_app";
|
|
870
829
|
type Classification = {
|
|
871
830
|
absoluteDiff?: number;
|
|
872
831
|
diff?: number;
|
|
@@ -1231,7 +1190,7 @@ type ImportAppHttpError = {
|
|
|
1231
1190
|
*/
|
|
1232
1191
|
declare const getAppsPrivileges: (options?: ApiCallOptions) => Promise<GetAppsPrivilegesHttpResponse>;
|
|
1233
1192
|
type GetAppsPrivilegesHttpResponse = {
|
|
1234
|
-
data:
|
|
1193
|
+
data: UserPrivileges[];
|
|
1235
1194
|
headers: Headers;
|
|
1236
1195
|
status: number;
|
|
1237
1196
|
};
|
|
@@ -2333,4 +2292,4 @@ interface AppsAPI {
|
|
|
2333
2292
|
*/
|
|
2334
2293
|
declare const appsExport: AppsAPI;
|
|
2335
2294
|
|
|
2336
|
-
export { type Analysis, type AnalysisComposition, type AnalysisDescriptor, type AnalysisDescriptorResponse, type AnalysisDetails, type AnalysisGroup, type AnalysisModelItemField, type AnalysisModelItemMasterItem, type AnalysisModelResponse, type AnalysisModelResponseDetail, type AnalysisRecommendRequest, type AnalysisRecommendationResponse, type AnalysisRecommendationResponseDetail, type AppAttributes, type AppContentList, type AppContentListItem, type AppUpdateAttributes, type AppsAPI, type ChartType, type Classification, type Classifications, type Cmpbool, type Cmpfloat, type Cmpint, type Comparison, type Comparisonfields, type Comparisonobjresponsetime, type Comparisonoobjheavy, type Comparisontables, type CompositionMinMax, type CopyAppHttpError, type CopyAppHttpResponse, type CountAppReportFiltersHttpError, type CountAppReportFiltersHttpResponse, type CreateApp, type CreateAppHttpError, type CreateAppHttpResponse, type CreateAppReportFilterHttpError, type CreateAppReportFilterHttpResponse, type DataModelMetadata, type DeleteAppHttpError, type DeleteAppHttpResponse, type DeleteAppMediaHttpError, type DeleteAppMediaHttpResponse, type DeleteAppReportFilterHttpError, type DeleteAppReportFilterHttpResponse, type DeleteAppScriptHttpError, type DeleteAppScriptHttpResponse, type Error, type Errors, type Evaluation, type Evaluations, type EvaluatorError, type Event, type ExportAppHttpError, type ExportAppHttpResponse, type FieldAttributes, type FieldInTableProfilingData, type FieldMetadata, type FieldOverride, type FileData, type Filter, type FilterError, type FilterErrors, type FilterField, type FilterFieldValue, type FilterList, type FilterListItem, type FilterRequest, type FilterType, type FilterV10, type FilterVariable, type FiltersCount, type Float64, type FrequencyDistributionData, type GetAppDataLineageHttpError, type GetAppDataLineageHttpResponse, type GetAppDataMetadataHttpError, type GetAppDataMetadataHttpResponse, type GetAppEvaluationComparisonHttpError, type GetAppEvaluationComparisonHttpResponse, type GetAppEvaluationComparisonXmlHttpError, type GetAppEvaluationComparisonXmlHttpResponse, type GetAppEvaluationHttpError, type GetAppEvaluationHttpResponse, type GetAppEvaluationXmlHttpError, type GetAppEvaluationXmlHttpResponse, type GetAppEvaluationsHttpError, type GetAppEvaluationsHttpResponse, type GetAppInfoHttpError, type GetAppInfoHttpResponse, type GetAppInsightAnalysesHttpError, type GetAppInsightAnalysesHttpResponse, type GetAppInsightAnalysisModelHttpError, type GetAppInsightAnalysisModelHttpResponse, type GetAppInsightAnalysisRecommendationsHttpError, type GetAppInsightAnalysisRecommendationsHttpResponse, type GetAppMediaHttpError, type GetAppMediaHttpResponse, type GetAppMediaListHttpError, type GetAppMediaListHttpResponse, type GetAppReloadLogHttpError, type GetAppReloadLogHttpResponse, type GetAppReloadLogsHttpError, type GetAppReloadLogsHttpResponse, type GetAppReloadMetadataHttpError, type GetAppReloadMetadataHttpResponse, type GetAppReportFilterHttpError, type GetAppReportFilterHttpResponse, type GetAppReportFiltersHttpError, type GetAppReportFiltersHttpResponse, type GetAppScriptHistoryHttpError, type GetAppScriptHistoryHttpResponse, type GetAppScriptHttpError, type GetAppScriptHttpResponse, type GetAppThumbnailHttpError, type GetAppThumbnailHttpResponse, type GetAppsPrivilegesHttpError, type GetAppsPrivilegesHttpResponse, type HardwareMeta, type Href, type ImportAppHttpError, type ImportAppHttpResponse, type JsonObject, type LastReloadMetadata, type LineageInfoRest, type LinkResponse, type Links, type LinksResponse, type Log, type Metadata, type MoveAppToSpaceHttpError, type MoveAppToSpaceHttpResponse, type NavigationLink, type NavigationLinks, type NumberFormat, type NxApp, type NxAppCreatePrivileges, type NxAppObject, type NxAttributes, type NxObjectAttributes, type NxPatch, type Objectmetrics, type Objectspec, type Objecttopspec, type PartialNluInfo, type PatchAppScriptHttpError, type PatchAppScriptHttpResponse, type PublishApp, type PublishAppHttpError, type PublishAppHttpResponse, type QueueAppEvaluationHttpError, type QueueAppEvaluationHttpResponse, type RecommendFieldItem, type RecommendItems, type RecommendMasterItem, type RecommendNaturalLangQuery, type RecommendedAnalysis, type RecommendedAnalysisCore, type ReloadListMetadata, type ReloadMeta, type ReloadStatements, type RemoveAppFromSpaceHttpError, type RemoveAppFromSpaceHttpResponse, type RepublishApp, type RepublishAppHttpError, type RepublishAppHttpResponse, type Result, type Resultentry, type Resultmetadatatopfields, type Resultmetadatatoptables, type Resultobjresponsetime, type Resultobjsheet, type Resultobjsinglethreaded, type Resultsingle, type ScriptLogList, type ScriptLogMeta, type ScriptMeta, type ScriptMetaList, type ScriptVersion, type SimplifiedClassifications, type Sortedcomparisonfields, type Sortedcomparisonobjresponsetime, type Sortedcomparisonoobjheavy, type Sortedcomparisontables, type SymbolFrequency, type SymbolValue, type TableMetadata, type TableProfilingData, type UpdateApp, type UpdateAppInfoHttpError, type UpdateAppInfoHttpResponse, type UpdateAppObjectOwnerHttpError, type UpdateAppObjectOwnerHttpResponse, type UpdateAppOwnerHttpError, type UpdateAppOwnerHttpResponse, type UpdateAppScriptHttpError, type UpdateAppScriptHttpResponse, type UpdateOwner, type UpdateSpace, type UploadAppMediaHttpError, type UploadAppMediaHttpResponse, clearCache, copyApp, countAppReportFilters, createApp, createAppReportFilter, appsExport as default, deleteApp, deleteAppMedia, deleteAppReportFilter, deleteAppScript, exportApp, getAppDataLineage, getAppDataMetadata, getAppEvaluation, getAppEvaluationComparison, getAppEvaluationComparisonXml, getAppEvaluationXml, getAppEvaluations, getAppInfo, getAppInsightAnalyses, getAppInsightAnalysisModel, getAppInsightAnalysisRecommendations, getAppMedia, getAppMediaList, getAppReloadLog, getAppReloadLogs, getAppReloadMetadata, getAppReportFilter, getAppReportFilters, getAppScript, getAppScriptHistory, getAppThumbnail, getAppsPrivileges, importApp, moveAppToSpace, patchAppScript, publishApp, queueAppEvaluation, removeAppFromSpace, republishApp, updateAppInfo, updateAppObjectOwner, updateAppOwner, updateAppScript, uploadAppMedia };
|
|
2295
|
+
export { type Analysis, type AnalysisComposition, type AnalysisDescriptor, type AnalysisDescriptorResponse, type AnalysisDetails, type AnalysisGroup, type AnalysisModelItemField, type AnalysisModelItemMasterItem, type AnalysisModelResponse, type AnalysisModelResponseDetail, type AnalysisRecommendRequest, type AnalysisRecommendationResponse, type AnalysisRecommendationResponseDetail, type AppAttributes, type AppContentList, type AppContentListItem, type AppObjectGenericType, type AppUpdateAttributes, type AppsAPI, type ChartType, type Classification, type Classifications, type Cmpbool, type Cmpfloat, type Cmpint, type Comparison, type Comparisonfields, type Comparisonobjresponsetime, type Comparisonoobjheavy, type Comparisontables, type CompositionMinMax, type CopyAppHttpError, type CopyAppHttpResponse, type CountAppReportFiltersHttpError, type CountAppReportFiltersHttpResponse, type CreateApp, type CreateAppHttpError, type CreateAppHttpResponse, type CreateAppReportFilterHttpError, type CreateAppReportFilterHttpResponse, type DataModelMetadata, type DeleteAppHttpError, type DeleteAppHttpResponse, type DeleteAppMediaHttpError, type DeleteAppMediaHttpResponse, type DeleteAppReportFilterHttpError, type DeleteAppReportFilterHttpResponse, type DeleteAppScriptHttpError, type DeleteAppScriptHttpResponse, type Error, type Errors, type Evaluation, type Evaluations, type EvaluatorError, type Event, type ExportAppHttpError, type ExportAppHttpResponse, type FieldAttrType, type FieldAttributes, type FieldInTableProfilingData, type FieldMetadata, type FieldOverride, type FileData, type Filter, type FilterError, type FilterErrors, type FilterField, type FilterFieldValue, type FilterList, type FilterListItem, type FilterRequest, type FilterType, type FilterV10, type FilterVariable, type FiltersCount, type Float64, type FrequencyDistributionData, type GetAppDataLineageHttpError, type GetAppDataLineageHttpResponse, type GetAppDataMetadataHttpError, type GetAppDataMetadataHttpResponse, type GetAppEvaluationComparisonHttpError, type GetAppEvaluationComparisonHttpResponse, type GetAppEvaluationComparisonXmlHttpError, type GetAppEvaluationComparisonXmlHttpResponse, type GetAppEvaluationHttpError, type GetAppEvaluationHttpResponse, type GetAppEvaluationXmlHttpError, type GetAppEvaluationXmlHttpResponse, type GetAppEvaluationsHttpError, type GetAppEvaluationsHttpResponse, type GetAppInfoHttpError, type GetAppInfoHttpResponse, type GetAppInsightAnalysesHttpError, type GetAppInsightAnalysesHttpResponse, type GetAppInsightAnalysisModelHttpError, type GetAppInsightAnalysisModelHttpResponse, type GetAppInsightAnalysisRecommendationsHttpError, type GetAppInsightAnalysisRecommendationsHttpResponse, type GetAppMediaHttpError, type GetAppMediaHttpResponse, type GetAppMediaListHttpError, type GetAppMediaListHttpResponse, type GetAppReloadLogHttpError, type GetAppReloadLogHttpResponse, type GetAppReloadLogsHttpError, type GetAppReloadLogsHttpResponse, type GetAppReloadMetadataHttpError, type GetAppReloadMetadataHttpResponse, type GetAppReportFilterHttpError, type GetAppReportFilterHttpResponse, type GetAppReportFiltersHttpError, type GetAppReportFiltersHttpResponse, type GetAppScriptHistoryHttpError, type GetAppScriptHistoryHttpResponse, type GetAppScriptHttpError, type GetAppScriptHttpResponse, type GetAppThumbnailHttpError, type GetAppThumbnailHttpResponse, type GetAppsPrivilegesHttpError, type GetAppsPrivilegesHttpResponse, type HardwareMeta, type Href, type ImportAppHttpError, type ImportAppHttpResponse, type JsonObject, type LastReloadMetadata, type LineageInfoRest, type LinkResponse, type Links, type LinksResponse, type Log, type Metadata, type MoveAppToSpaceHttpError, type MoveAppToSpaceHttpResponse, type NavigationLink, type NavigationLinks, type NumberFormat, type NxApp, type NxAppCreatePrivileges, type NxAppObject, type NxAttributes, type NxObjectAttributes, type NxPatch, type NxPatchOperationType, type Objectmetrics, type Objectspec, type Objecttopspec, type PartialNluInfo, type PatchAppScriptHttpError, type PatchAppScriptHttpResponse, type PublishApp, type PublishAppHttpError, type PublishAppHttpResponse, type PublishData, type QueueAppEvaluationHttpError, type QueueAppEvaluationHttpResponse, type RecommendFieldItem, type RecommendItems, type RecommendMasterItem, type RecommendNaturalLangQuery, type RecommendedAnalysis, type RecommendedAnalysisCore, type ReloadListMetadata, type ReloadMeta, type ReloadStatements, type RemoveAppFromSpaceHttpError, type RemoveAppFromSpaceHttpResponse, type RepublishApp, type RepublishAppHttpError, type RepublishAppHttpResponse, type Result, type Resultentry, type Resultmetadatatopfields, type Resultmetadatatoptables, type Resultobjresponsetime, type Resultobjsheet, type Resultobjsinglethreaded, type Resultsingle, type ScriptLogList, type ScriptLogMeta, type ScriptMeta, type ScriptMetaList, type ScriptVersion, type SimplifiedClassifications, type Sortedcomparisonfields, type Sortedcomparisonobjresponsetime, type Sortedcomparisonoobjheavy, type Sortedcomparisontables, type SymbolFrequency, type SymbolValue, type TableMetadata, type TableProfilingData, type UpdateApp, type UpdateAppInfoHttpError, type UpdateAppInfoHttpResponse, type UpdateAppObjectOwnerHttpError, type UpdateAppObjectOwnerHttpResponse, type UpdateAppOwnerHttpError, type UpdateAppOwnerHttpResponse, type UpdateAppScriptHttpError, type UpdateAppScriptHttpResponse, type UpdateOwner, type UpdateSpace, type UploadAppMediaHttpError, type UploadAppMediaHttpResponse, type UsageEnum, type UserPrivileges, clearCache, copyApp, countAppReportFilters, createApp, createAppReportFilter, appsExport as default, deleteApp, deleteAppMedia, deleteAppReportFilter, deleteAppScript, exportApp, getAppDataLineage, getAppDataMetadata, getAppEvaluation, getAppEvaluationComparison, getAppEvaluationComparisonXml, getAppEvaluationXml, getAppEvaluations, getAppInfo, getAppInsightAnalyses, getAppInsightAnalysisModel, getAppInsightAnalysisRecommendations, getAppMedia, getAppMediaList, getAppReloadLog, getAppReloadLogs, getAppReloadMetadata, getAppReportFilter, getAppReportFilters, getAppScript, getAppScriptHistory, getAppThumbnail, getAppsPrivileges, importApp, moveAppToSpace, patchAppScript, publishApp, queueAppEvaluation, removeAppFromSpace, republishApp, updateAppInfo, updateAppObjectOwner, updateAppOwner, updateAppScript, uploadAppMedia };
|
package/apps.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { A as ApiCallOptions } from './global.types-
|
|
1
|
+
import { A as ApiCallOptions } from './global.types-1rNhDH7j.js';
|
|
2
2
|
import './auth-types-nnUcWhuU.js';
|
|
3
3
|
|
|
4
4
|
type Analysis = "breakdown" | "changePoint" | "comparison" | "contribution" | "correlation" | "fact" | "mutualInfo" | "rank" | "spike" | "trend" | "values";
|
|
@@ -88,12 +88,7 @@ type AppAttributes = {
|
|
|
88
88
|
name?: string;
|
|
89
89
|
/** The space ID of the application */
|
|
90
90
|
spaceId?: string;
|
|
91
|
-
|
|
92
|
-
*
|
|
93
|
-
* One of:
|
|
94
|
-
* * ANALYTICS
|
|
95
|
-
* * DATA_PREPARATION */
|
|
96
|
-
usage?: "ANALYTICS" | "DATA_PREPARATION";
|
|
91
|
+
usage?: UsageEnum;
|
|
97
92
|
};
|
|
98
93
|
type AppContentList = {
|
|
99
94
|
/** Content list items. */
|
|
@@ -113,6 +108,7 @@ type AppContentListItem = {
|
|
|
113
108
|
/** Content type. */
|
|
114
109
|
type?: string;
|
|
115
110
|
};
|
|
111
|
+
type AppObjectGenericType = "genericObject" | "genericBookmark" | "genericMeasure" | "genericDimension" | "genericVariable";
|
|
116
112
|
type AppUpdateAttributes = {
|
|
117
113
|
/** The description of the application. */
|
|
118
114
|
description?: string;
|
|
@@ -141,11 +137,7 @@ type DataModelMetadata = {
|
|
|
141
137
|
tables?: TableMetadata[];
|
|
142
138
|
/** Profiling data of the tables in the app. */
|
|
143
139
|
tables_profiling_data?: TableProfilingData[];
|
|
144
|
-
|
|
145
|
-
* One of:
|
|
146
|
-
* * ANALYTICS
|
|
147
|
-
* * DATA_PREPARATION */
|
|
148
|
-
usage?: "ANALYTICS" | "DATA_PREPARATION";
|
|
140
|
+
usage?: UsageEnum;
|
|
149
141
|
};
|
|
150
142
|
type Error = {
|
|
151
143
|
/** The error code. */
|
|
@@ -174,6 +166,7 @@ type EvaluatorError = {
|
|
|
174
166
|
title?: string;
|
|
175
167
|
}[];
|
|
176
168
|
};
|
|
169
|
+
type FieldAttrType = "U" | "A" | "I" | "R" | "F" | "M" | "D" | "T" | "TS" | "IV";
|
|
177
170
|
type FieldAttributes = {
|
|
178
171
|
/** Defines the decimal separator.
|
|
179
172
|
* Example: **.** */
|
|
@@ -187,21 +180,7 @@ type FieldAttributes = {
|
|
|
187
180
|
* Is used if **qUseThou** is set to 1.
|
|
188
181
|
* Example: **,** */
|
|
189
182
|
Thou?: string;
|
|
190
|
-
|
|
191
|
-
* Default is U.
|
|
192
|
-
*
|
|
193
|
-
* One of:
|
|
194
|
-
* * U or UNKNOWN
|
|
195
|
-
* * A or ASCII
|
|
196
|
-
* * I or INTEGER
|
|
197
|
-
* * R or REAL
|
|
198
|
-
* * F or FIX
|
|
199
|
-
* * M or MONEY
|
|
200
|
-
* * D or DATE
|
|
201
|
-
* * T or TIME
|
|
202
|
-
* * TS or TIMESTAMP
|
|
203
|
-
* * IV or INTERVAL */
|
|
204
|
-
Type?: "UNKNOWN" | "ASCII" | "INTEGER" | "REAL" | "FIX" | "MONEY" | "DATE" | "TIME" | "TIMESTAMP" | "INTERVAL";
|
|
183
|
+
Type?: FieldAttrType;
|
|
205
184
|
/** Defines whether or not a thousands separator must be used.
|
|
206
185
|
* Default is 0. */
|
|
207
186
|
UseThou?: number;
|
|
@@ -601,11 +580,7 @@ type NxAttributes = {
|
|
|
601
580
|
published?: boolean;
|
|
602
581
|
/** App thumbnail. */
|
|
603
582
|
thumbnail?: string;
|
|
604
|
-
|
|
605
|
-
* One of:
|
|
606
|
-
* * ANALYTICS
|
|
607
|
-
* * DATA_PREPARATION */
|
|
608
|
-
usage?: "ANALYTICS" | "DATA_PREPARATION";
|
|
583
|
+
usage?: UsageEnum;
|
|
609
584
|
};
|
|
610
585
|
type NxObjectAttributes = {
|
|
611
586
|
/** True if the object is approved. */
|
|
@@ -614,15 +589,7 @@ type NxObjectAttributes = {
|
|
|
614
589
|
createdAt?: string;
|
|
615
590
|
/** Object description. */
|
|
616
591
|
description?: string;
|
|
617
|
-
|
|
618
|
-
*
|
|
619
|
-
* One of:
|
|
620
|
-
* * genericObject
|
|
621
|
-
* * genericBookmark
|
|
622
|
-
* * genericMeasure
|
|
623
|
-
* * genericDimension
|
|
624
|
-
* * genericVariable */
|
|
625
|
-
genericType?: "genericObject" | "genericBookmark" | "genericMeasure" | "genericDimension" | "genericVariable";
|
|
592
|
+
genericType?: AppObjectGenericType;
|
|
626
593
|
/** The object Id. */
|
|
627
594
|
id?: string;
|
|
628
595
|
/** Object name. */
|
|
@@ -637,13 +604,7 @@ type NxObjectAttributes = {
|
|
|
637
604
|
updatedAt?: string;
|
|
638
605
|
};
|
|
639
606
|
type NxPatch = {
|
|
640
|
-
|
|
641
|
-
*
|
|
642
|
-
* One of:
|
|
643
|
-
* * add or Add
|
|
644
|
-
* * remove or Remove
|
|
645
|
-
* * replace or Replace */
|
|
646
|
-
Op?: "Add" | "Remove" | "Replace";
|
|
607
|
+
Op?: NxPatchOperationType;
|
|
647
608
|
/** Path to the property to add, remove or replace. */
|
|
648
609
|
Path?: string;
|
|
649
610
|
/** This parameter is not used in a remove operation.
|
|
@@ -652,6 +613,7 @@ type NxPatch = {
|
|
|
652
613
|
* "false", "2", "\"New title\"" */
|
|
653
614
|
Value?: string;
|
|
654
615
|
};
|
|
616
|
+
type NxPatchOperationType = "add" | "remove" | "replace";
|
|
655
617
|
type PartialNluInfo = {
|
|
656
618
|
/** Qlik sense application field selected for given token or phrase */
|
|
657
619
|
fieldName?: string;
|
|
@@ -666,12 +628,7 @@ type PartialNluInfo = {
|
|
|
666
628
|
};
|
|
667
629
|
type PublishApp = {
|
|
668
630
|
attributes?: AppUpdateAttributes;
|
|
669
|
-
|
|
670
|
-
* The default is source.
|
|
671
|
-
*
|
|
672
|
-
* * source: Publish with source data
|
|
673
|
-
* * target: Publish with target data */
|
|
674
|
-
data?: "source" | "target";
|
|
631
|
+
data?: PublishData;
|
|
675
632
|
/** The original is moved instead of copied. The current published state of all objects is kept. */
|
|
676
633
|
moveApp?: boolean;
|
|
677
634
|
/** If app is moved, originAppId needs to be provided. */
|
|
@@ -679,6 +636,7 @@ type PublishApp = {
|
|
|
679
636
|
/** The managed space ID where the app will be published. */
|
|
680
637
|
spaceId?: string;
|
|
681
638
|
};
|
|
639
|
+
type PublishData = "source" | "target";
|
|
682
640
|
type RecommendFieldItem = {
|
|
683
641
|
name?: string;
|
|
684
642
|
overrides?: FieldOverride;
|
|
@@ -719,6 +677,10 @@ type ReloadListMetadata = {
|
|
|
719
677
|
data?: ReloadMeta[];
|
|
720
678
|
};
|
|
721
679
|
type ReloadMeta = {
|
|
680
|
+
/** A Base64-encoded hash value of the new section access database. */
|
|
681
|
+
accessDbHash?: string;
|
|
682
|
+
/** A Base64-encoded hash value of the new app database. */
|
|
683
|
+
appDbHash?: string;
|
|
722
684
|
/** Duration of reload (ms). */
|
|
723
685
|
duration?: number;
|
|
724
686
|
/** Time when reload ended. */
|
|
@@ -770,12 +732,7 @@ type RepublishApp = {
|
|
|
770
732
|
attributes?: AppUpdateAttributes;
|
|
771
733
|
/** Validate that source app is same as originally published. */
|
|
772
734
|
checkOriginAppId?: boolean;
|
|
773
|
-
|
|
774
|
-
* The default is source.
|
|
775
|
-
*
|
|
776
|
-
* * source: Publish with source data
|
|
777
|
-
* * target: Publish with target data */
|
|
778
|
-
data?: "source" | "target";
|
|
735
|
+
data?: PublishData;
|
|
779
736
|
/** The target ID to be republished. */
|
|
780
737
|
targetId?: string;
|
|
781
738
|
};
|
|
@@ -867,6 +824,8 @@ type UpdateOwner = {
|
|
|
867
824
|
type UpdateSpace = {
|
|
868
825
|
spaceId?: string;
|
|
869
826
|
};
|
|
827
|
+
type UsageEnum = "ANALYTICS" | "DATA_PREPARATION";
|
|
828
|
+
type UserPrivileges = "can_create_app" | "can_import_app" | "can_create_session_app";
|
|
870
829
|
type Classification = {
|
|
871
830
|
absoluteDiff?: number;
|
|
872
831
|
diff?: number;
|
|
@@ -1231,7 +1190,7 @@ type ImportAppHttpError = {
|
|
|
1231
1190
|
*/
|
|
1232
1191
|
declare const getAppsPrivileges: (options?: ApiCallOptions) => Promise<GetAppsPrivilegesHttpResponse>;
|
|
1233
1192
|
type GetAppsPrivilegesHttpResponse = {
|
|
1234
|
-
data:
|
|
1193
|
+
data: UserPrivileges[];
|
|
1235
1194
|
headers: Headers;
|
|
1236
1195
|
status: number;
|
|
1237
1196
|
};
|
|
@@ -2333,4 +2292,4 @@ interface AppsAPI {
|
|
|
2333
2292
|
*/
|
|
2334
2293
|
declare const appsExport: AppsAPI;
|
|
2335
2294
|
|
|
2336
|
-
export { type Analysis, type AnalysisComposition, type AnalysisDescriptor, type AnalysisDescriptorResponse, type AnalysisDetails, type AnalysisGroup, type AnalysisModelItemField, type AnalysisModelItemMasterItem, type AnalysisModelResponse, type AnalysisModelResponseDetail, type AnalysisRecommendRequest, type AnalysisRecommendationResponse, type AnalysisRecommendationResponseDetail, type AppAttributes, type AppContentList, type AppContentListItem, type AppUpdateAttributes, type AppsAPI, type ChartType, type Classification, type Classifications, type Cmpbool, type Cmpfloat, type Cmpint, type Comparison, type Comparisonfields, type Comparisonobjresponsetime, type Comparisonoobjheavy, type Comparisontables, type CompositionMinMax, type CopyAppHttpError, type CopyAppHttpResponse, type CountAppReportFiltersHttpError, type CountAppReportFiltersHttpResponse, type CreateApp, type CreateAppHttpError, type CreateAppHttpResponse, type CreateAppReportFilterHttpError, type CreateAppReportFilterHttpResponse, type DataModelMetadata, type DeleteAppHttpError, type DeleteAppHttpResponse, type DeleteAppMediaHttpError, type DeleteAppMediaHttpResponse, type DeleteAppReportFilterHttpError, type DeleteAppReportFilterHttpResponse, type DeleteAppScriptHttpError, type DeleteAppScriptHttpResponse, type Error, type Errors, type Evaluation, type Evaluations, type EvaluatorError, type Event, type ExportAppHttpError, type ExportAppHttpResponse, type FieldAttributes, type FieldInTableProfilingData, type FieldMetadata, type FieldOverride, type FileData, type Filter, type FilterError, type FilterErrors, type FilterField, type FilterFieldValue, type FilterList, type FilterListItem, type FilterRequest, type FilterType, type FilterV10, type FilterVariable, type FiltersCount, type Float64, type FrequencyDistributionData, type GetAppDataLineageHttpError, type GetAppDataLineageHttpResponse, type GetAppDataMetadataHttpError, type GetAppDataMetadataHttpResponse, type GetAppEvaluationComparisonHttpError, type GetAppEvaluationComparisonHttpResponse, type GetAppEvaluationComparisonXmlHttpError, type GetAppEvaluationComparisonXmlHttpResponse, type GetAppEvaluationHttpError, type GetAppEvaluationHttpResponse, type GetAppEvaluationXmlHttpError, type GetAppEvaluationXmlHttpResponse, type GetAppEvaluationsHttpError, type GetAppEvaluationsHttpResponse, type GetAppInfoHttpError, type GetAppInfoHttpResponse, type GetAppInsightAnalysesHttpError, type GetAppInsightAnalysesHttpResponse, type GetAppInsightAnalysisModelHttpError, type GetAppInsightAnalysisModelHttpResponse, type GetAppInsightAnalysisRecommendationsHttpError, type GetAppInsightAnalysisRecommendationsHttpResponse, type GetAppMediaHttpError, type GetAppMediaHttpResponse, type GetAppMediaListHttpError, type GetAppMediaListHttpResponse, type GetAppReloadLogHttpError, type GetAppReloadLogHttpResponse, type GetAppReloadLogsHttpError, type GetAppReloadLogsHttpResponse, type GetAppReloadMetadataHttpError, type GetAppReloadMetadataHttpResponse, type GetAppReportFilterHttpError, type GetAppReportFilterHttpResponse, type GetAppReportFiltersHttpError, type GetAppReportFiltersHttpResponse, type GetAppScriptHistoryHttpError, type GetAppScriptHistoryHttpResponse, type GetAppScriptHttpError, type GetAppScriptHttpResponse, type GetAppThumbnailHttpError, type GetAppThumbnailHttpResponse, type GetAppsPrivilegesHttpError, type GetAppsPrivilegesHttpResponse, type HardwareMeta, type Href, type ImportAppHttpError, type ImportAppHttpResponse, type JsonObject, type LastReloadMetadata, type LineageInfoRest, type LinkResponse, type Links, type LinksResponse, type Log, type Metadata, type MoveAppToSpaceHttpError, type MoveAppToSpaceHttpResponse, type NavigationLink, type NavigationLinks, type NumberFormat, type NxApp, type NxAppCreatePrivileges, type NxAppObject, type NxAttributes, type NxObjectAttributes, type NxPatch, type Objectmetrics, type Objectspec, type Objecttopspec, type PartialNluInfo, type PatchAppScriptHttpError, type PatchAppScriptHttpResponse, type PublishApp, type PublishAppHttpError, type PublishAppHttpResponse, type QueueAppEvaluationHttpError, type QueueAppEvaluationHttpResponse, type RecommendFieldItem, type RecommendItems, type RecommendMasterItem, type RecommendNaturalLangQuery, type RecommendedAnalysis, type RecommendedAnalysisCore, type ReloadListMetadata, type ReloadMeta, type ReloadStatements, type RemoveAppFromSpaceHttpError, type RemoveAppFromSpaceHttpResponse, type RepublishApp, type RepublishAppHttpError, type RepublishAppHttpResponse, type Result, type Resultentry, type Resultmetadatatopfields, type Resultmetadatatoptables, type Resultobjresponsetime, type Resultobjsheet, type Resultobjsinglethreaded, type Resultsingle, type ScriptLogList, type ScriptLogMeta, type ScriptMeta, type ScriptMetaList, type ScriptVersion, type SimplifiedClassifications, type Sortedcomparisonfields, type Sortedcomparisonobjresponsetime, type Sortedcomparisonoobjheavy, type Sortedcomparisontables, type SymbolFrequency, type SymbolValue, type TableMetadata, type TableProfilingData, type UpdateApp, type UpdateAppInfoHttpError, type UpdateAppInfoHttpResponse, type UpdateAppObjectOwnerHttpError, type UpdateAppObjectOwnerHttpResponse, type UpdateAppOwnerHttpError, type UpdateAppOwnerHttpResponse, type UpdateAppScriptHttpError, type UpdateAppScriptHttpResponse, type UpdateOwner, type UpdateSpace, type UploadAppMediaHttpError, type UploadAppMediaHttpResponse, clearCache, copyApp, countAppReportFilters, createApp, createAppReportFilter, appsExport as default, deleteApp, deleteAppMedia, deleteAppReportFilter, deleteAppScript, exportApp, getAppDataLineage, getAppDataMetadata, getAppEvaluation, getAppEvaluationComparison, getAppEvaluationComparisonXml, getAppEvaluationXml, getAppEvaluations, getAppInfo, getAppInsightAnalyses, getAppInsightAnalysisModel, getAppInsightAnalysisRecommendations, getAppMedia, getAppMediaList, getAppReloadLog, getAppReloadLogs, getAppReloadMetadata, getAppReportFilter, getAppReportFilters, getAppScript, getAppScriptHistory, getAppThumbnail, getAppsPrivileges, importApp, moveAppToSpace, patchAppScript, publishApp, queueAppEvaluation, removeAppFromSpace, republishApp, updateAppInfo, updateAppObjectOwner, updateAppOwner, updateAppScript, uploadAppMedia };
|
|
2295
|
+
export { type Analysis, type AnalysisComposition, type AnalysisDescriptor, type AnalysisDescriptorResponse, type AnalysisDetails, type AnalysisGroup, type AnalysisModelItemField, type AnalysisModelItemMasterItem, type AnalysisModelResponse, type AnalysisModelResponseDetail, type AnalysisRecommendRequest, type AnalysisRecommendationResponse, type AnalysisRecommendationResponseDetail, type AppAttributes, type AppContentList, type AppContentListItem, type AppObjectGenericType, type AppUpdateAttributes, type AppsAPI, type ChartType, type Classification, type Classifications, type Cmpbool, type Cmpfloat, type Cmpint, type Comparison, type Comparisonfields, type Comparisonobjresponsetime, type Comparisonoobjheavy, type Comparisontables, type CompositionMinMax, type CopyAppHttpError, type CopyAppHttpResponse, type CountAppReportFiltersHttpError, type CountAppReportFiltersHttpResponse, type CreateApp, type CreateAppHttpError, type CreateAppHttpResponse, type CreateAppReportFilterHttpError, type CreateAppReportFilterHttpResponse, type DataModelMetadata, type DeleteAppHttpError, type DeleteAppHttpResponse, type DeleteAppMediaHttpError, type DeleteAppMediaHttpResponse, type DeleteAppReportFilterHttpError, type DeleteAppReportFilterHttpResponse, type DeleteAppScriptHttpError, type DeleteAppScriptHttpResponse, type Error, type Errors, type Evaluation, type Evaluations, type EvaluatorError, type Event, type ExportAppHttpError, type ExportAppHttpResponse, type FieldAttrType, type FieldAttributes, type FieldInTableProfilingData, type FieldMetadata, type FieldOverride, type FileData, type Filter, type FilterError, type FilterErrors, type FilterField, type FilterFieldValue, type FilterList, type FilterListItem, type FilterRequest, type FilterType, type FilterV10, type FilterVariable, type FiltersCount, type Float64, type FrequencyDistributionData, type GetAppDataLineageHttpError, type GetAppDataLineageHttpResponse, type GetAppDataMetadataHttpError, type GetAppDataMetadataHttpResponse, type GetAppEvaluationComparisonHttpError, type GetAppEvaluationComparisonHttpResponse, type GetAppEvaluationComparisonXmlHttpError, type GetAppEvaluationComparisonXmlHttpResponse, type GetAppEvaluationHttpError, type GetAppEvaluationHttpResponse, type GetAppEvaluationXmlHttpError, type GetAppEvaluationXmlHttpResponse, type GetAppEvaluationsHttpError, type GetAppEvaluationsHttpResponse, type GetAppInfoHttpError, type GetAppInfoHttpResponse, type GetAppInsightAnalysesHttpError, type GetAppInsightAnalysesHttpResponse, type GetAppInsightAnalysisModelHttpError, type GetAppInsightAnalysisModelHttpResponse, type GetAppInsightAnalysisRecommendationsHttpError, type GetAppInsightAnalysisRecommendationsHttpResponse, type GetAppMediaHttpError, type GetAppMediaHttpResponse, type GetAppMediaListHttpError, type GetAppMediaListHttpResponse, type GetAppReloadLogHttpError, type GetAppReloadLogHttpResponse, type GetAppReloadLogsHttpError, type GetAppReloadLogsHttpResponse, type GetAppReloadMetadataHttpError, type GetAppReloadMetadataHttpResponse, type GetAppReportFilterHttpError, type GetAppReportFilterHttpResponse, type GetAppReportFiltersHttpError, type GetAppReportFiltersHttpResponse, type GetAppScriptHistoryHttpError, type GetAppScriptHistoryHttpResponse, type GetAppScriptHttpError, type GetAppScriptHttpResponse, type GetAppThumbnailHttpError, type GetAppThumbnailHttpResponse, type GetAppsPrivilegesHttpError, type GetAppsPrivilegesHttpResponse, type HardwareMeta, type Href, type ImportAppHttpError, type ImportAppHttpResponse, type JsonObject, type LastReloadMetadata, type LineageInfoRest, type LinkResponse, type Links, type LinksResponse, type Log, type Metadata, type MoveAppToSpaceHttpError, type MoveAppToSpaceHttpResponse, type NavigationLink, type NavigationLinks, type NumberFormat, type NxApp, type NxAppCreatePrivileges, type NxAppObject, type NxAttributes, type NxObjectAttributes, type NxPatch, type NxPatchOperationType, type Objectmetrics, type Objectspec, type Objecttopspec, type PartialNluInfo, type PatchAppScriptHttpError, type PatchAppScriptHttpResponse, type PublishApp, type PublishAppHttpError, type PublishAppHttpResponse, type PublishData, type QueueAppEvaluationHttpError, type QueueAppEvaluationHttpResponse, type RecommendFieldItem, type RecommendItems, type RecommendMasterItem, type RecommendNaturalLangQuery, type RecommendedAnalysis, type RecommendedAnalysisCore, type ReloadListMetadata, type ReloadMeta, type ReloadStatements, type RemoveAppFromSpaceHttpError, type RemoveAppFromSpaceHttpResponse, type RepublishApp, type RepublishAppHttpError, type RepublishAppHttpResponse, type Result, type Resultentry, type Resultmetadatatopfields, type Resultmetadatatoptables, type Resultobjresponsetime, type Resultobjsheet, type Resultobjsinglethreaded, type Resultsingle, type ScriptLogList, type ScriptLogMeta, type ScriptMeta, type ScriptMetaList, type ScriptVersion, type SimplifiedClassifications, type Sortedcomparisonfields, type Sortedcomparisonobjresponsetime, type Sortedcomparisonoobjheavy, type Sortedcomparisontables, type SymbolFrequency, type SymbolValue, type TableMetadata, type TableProfilingData, type UpdateApp, type UpdateAppInfoHttpError, type UpdateAppInfoHttpResponse, type UpdateAppObjectOwnerHttpError, type UpdateAppObjectOwnerHttpResponse, type UpdateAppOwnerHttpError, type UpdateAppOwnerHttpResponse, type UpdateAppScriptHttpError, type UpdateAppScriptHttpResponse, type UpdateOwner, type UpdateSpace, type UploadAppMediaHttpError, type UploadAppMediaHttpResponse, type UsageEnum, type UserPrivileges, clearCache, copyApp, countAppReportFilters, createApp, createAppReportFilter, appsExport as default, deleteApp, deleteAppMedia, deleteAppReportFilter, deleteAppScript, exportApp, getAppDataLineage, getAppDataMetadata, getAppEvaluation, getAppEvaluationComparison, getAppEvaluationComparisonXml, getAppEvaluationXml, getAppEvaluations, getAppInfo, getAppInsightAnalyses, getAppInsightAnalysisModel, getAppInsightAnalysisRecommendations, getAppMedia, getAppMediaList, getAppReloadLog, getAppReloadLogs, getAppReloadMetadata, getAppReportFilter, getAppReportFilters, getAppScript, getAppScriptHistory, getAppThumbnail, getAppsPrivileges, importApp, moveAppToSpace, patchAppScript, publishApp, queueAppEvaluation, removeAppFromSpace, republishApp, updateAppInfo, updateAppObjectOwner, updateAppOwner, updateAppScript, uploadAppMedia };
|