@qlik/api 0.0.15 → 0.1.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/README.md +1 -1
- package/api-keys.js +25 -25
- package/apps.js +97 -97
- package/audits.js +23 -23
- package/auth.js +14 -14
- package/automations.js +47 -47
- package/brands.js +35 -35
- package/chunks/4HB3TAEO.js +4 -4
- package/chunks/{EHAANYDL.mjs → 4V5AAWUI.js} +3 -3
- package/chunks/{O4EAKEIN.mjs → D62LI5YU.js} +1 -1
- package/chunks/{6WX5AGKQ.mjs → L2BJNKLV.js} +2 -2
- package/chunks/{3YV6X7S6.mjs → LHCJKIEO.js} +1 -1
- package/chunks/OPRGGO4C.js +8 -8
- package/chunks/{HHOVS7QC.mjs → RNLZBOJU.js} +3 -3
- package/chunks/{BYD63JCG.mjs → SIU6HO6B.js} +5 -3
- package/chunks/{6AD3HYSF.mjs → TFSRDRRS.js} +1 -1
- package/chunks/{HOCTJESP.mjs → VK2CODYY.js} +2 -2
- package/chunks/{UKVTBYP6.mjs → XOVMZWDC.js} +2 -2
- package/collections.js +33 -33
- package/csp-origins.js +23 -23
- package/data-assets.js +21 -21
- package/data-connections.d.ts +97 -61
- package/data-connections.js +29 -29
- package/data-credentials.d.ts +3 -2
- package/data-credentials.js +19 -19
- package/data-files.js +35 -35
- package/docs/authentication.md +5 -5
- package/docs/examples/fetch-spaces.md +1 -15
- package/docs/examples/open-without-data.md +1 -1
- package/docs/examples/show-sheet-list.md +1 -1
- package/docs/features.md +1 -1
- package/extensions.js +25 -25
- package/glossaries.js +59 -59
- package/groups.d.ts +0 -3
- package/groups.js +27 -27
- package/identity-providers.js +27 -27
- package/index.js +53 -53
- package/items.js +27 -27
- package/licenses.js +29 -29
- package/package.json +36 -232
- package/qix.d.ts +1 -1
- package/qix.js +10 -10
- package/quotas.js +15 -15
- package/reload-tasks.js +21 -21
- package/reloads.js +19 -19
- package/roles.js +15 -15
- package/spaces.js +35 -35
- package/temp-contents.js +17 -17
- package/tenants.js +23 -23
- package/themes.js +25 -25
- package/transports.js +23 -23
- package/users.d.ts +1 -3
- package/users.js +31 -31
- package/web-integrations.js +21 -21
- package/web-notifications.js +23 -23
- package/webhooks.js +31 -31
- package/api-keys.d.mts +0 -336
- package/api-keys.mjs +0 -80
- package/apps.d.mts +0 -2431
- package/apps.mjs +0 -398
- package/audits.d.mts +0 -286
- package/audits.mjs +0 -64
- package/auth-types-nnUcWhuU.d.mts +0 -98
- package/auth.d.mts +0 -26
- package/auth.mjs +0 -14
- package/automations.d.mts +0 -682
- package/automations.mjs +0 -173
- package/brands.d.mts +0 -670
- package/brands.mjs +0 -123
- package/chunks/2YWCEGTS.js +0 -21
- package/chunks/34ZKUFEA.js +0 -41
- package/chunks/4WHZ4EIW.js +0 -57
- package/chunks/B4VPD3ZT.js +0 -574
- package/chunks/BM4OSDRZ.js +0 -17
- package/chunks/DCXUEDOW.mjs +0 -67
- package/chunks/MTAQE4WC.js +0 -10411
- package/chunks/PLOSYUG2.js +0 -25
- package/chunks/URIW2U5M.js +0 -17
- package/chunks/VSY5YIQY.mjs +0 -11
- package/chunks/WOYJLK4Y.js +0 -1623
- package/collections.d.mts +0 -581
- package/collections.mjs +0 -114
- package/csp-origins.d.mts +0 -273
- package/csp-origins.mjs +0 -69
- package/data-assets.d.mts +0 -205
- package/data-assets.mjs +0 -66
- package/data-connections.d.mts +0 -558
- package/data-connections.mjs +0 -103
- package/data-credentials.d.mts +0 -203
- package/data-credentials.mjs +0 -59
- package/data-files.d.mts +0 -562
- package/data-files.mjs +0 -123
- package/extensions.d.mts +0 -293
- package/extensions.mjs +0 -77
- package/global.types-5iFvFJvX.d.mts +0 -115
- package/glossaries.d.mts +0 -1173
- package/glossaries.mjs +0 -237
- package/groups.d.mts +0 -434
- package/groups.mjs +0 -88
- package/identity-providers.d.mts +0 -550
- package/identity-providers.mjs +0 -83
- package/index.d.mts +0 -142
- package/index.mjs +0 -716
- package/items.d.mts +0 -535
- package/items.mjs +0 -87
- package/licenses.d.mts +0 -459
- package/licenses.mjs +0 -92
- package/qix.d.mts +0 -11629
- package/qix.mjs +0 -10
- package/quotas.d.mts +0 -112
- package/quotas.mjs +0 -32
- package/reload-tasks.d.mts +0 -227
- package/reload-tasks.mjs +0 -62
- package/reloads.d.mts +0 -207
- package/reloads.mjs +0 -46
- package/roles.d.mts +0 -175
- package/roles.mjs +0 -31
- package/spaces.d.mts +0 -562
- package/spaces.mjs +0 -124
- package/temp-contents.d.mts +0 -167
- package/temp-contents.mjs +0 -41
- package/tenants.d.mts +0 -300
- package/tenants.mjs +0 -73
- package/themes.d.mts +0 -268
- package/themes.mjs +0 -77
- package/transports.d.mts +0 -319
- package/transports.mjs +0 -65
- package/users.d.mts +0 -631
- package/users.mjs +0 -104
- package/web-integrations.d.mts +0 -274
- package/web-integrations.mjs +0 -62
- package/web-notifications.d.mts +0 -250
- package/web-notifications.mjs +0 -69
- package/webhooks.d.mts +0 -445
- package/webhooks.mjs +0 -104
package/collections.js
CHANGED
|
@@ -1,42 +1,42 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
1
|
+
import {
|
|
2
|
+
clearApiCache,
|
|
3
|
+
invokeFetch
|
|
4
|
+
} from "./chunks/LHCJKIEO.js";
|
|
5
|
+
import "./chunks/4V5AAWUI.js";
|
|
6
|
+
import "./chunks/4HB3TAEO.js";
|
|
7
7
|
|
|
8
8
|
// src/public/rest/collections.ts
|
|
9
|
-
var getCollections = async (query, options) =>
|
|
9
|
+
var getCollections = async (query, options) => invokeFetch("collections", {
|
|
10
10
|
method: "get",
|
|
11
11
|
pathTemplate: "/api/v1/collections",
|
|
12
12
|
query,
|
|
13
13
|
options
|
|
14
14
|
});
|
|
15
|
-
var createCollection = async (body, options) =>
|
|
15
|
+
var createCollection = async (body, options) => invokeFetch("collections", {
|
|
16
16
|
method: "post",
|
|
17
17
|
pathTemplate: "/api/v1/collections",
|
|
18
18
|
body,
|
|
19
19
|
contentType: "application/json",
|
|
20
20
|
options
|
|
21
21
|
});
|
|
22
|
-
var getFavoritesCollection = async (options) =>
|
|
22
|
+
var getFavoritesCollection = async (options) => invokeFetch("collections", {
|
|
23
23
|
method: "get",
|
|
24
24
|
pathTemplate: "/api/v1/collections/favorites",
|
|
25
25
|
options
|
|
26
26
|
});
|
|
27
|
-
var deleteCollection = async (collectionId, options) =>
|
|
27
|
+
var deleteCollection = async (collectionId, options) => invokeFetch("collections", {
|
|
28
28
|
method: "delete",
|
|
29
29
|
pathTemplate: "/api/v1/collections/{collectionId}",
|
|
30
30
|
pathVariables: { collectionId },
|
|
31
31
|
options
|
|
32
32
|
});
|
|
33
|
-
var getCollection = async (collectionId, options) =>
|
|
33
|
+
var getCollection = async (collectionId, options) => invokeFetch("collections", {
|
|
34
34
|
method: "get",
|
|
35
35
|
pathTemplate: "/api/v1/collections/{collectionId}",
|
|
36
36
|
pathVariables: { collectionId },
|
|
37
37
|
options
|
|
38
38
|
});
|
|
39
|
-
var patchCollection = async (collectionId, body, options) =>
|
|
39
|
+
var patchCollection = async (collectionId, body, options) => invokeFetch("collections", {
|
|
40
40
|
method: "patch",
|
|
41
41
|
pathTemplate: "/api/v1/collections/{collectionId}",
|
|
42
42
|
pathVariables: { collectionId },
|
|
@@ -44,7 +44,7 @@ var patchCollection = async (collectionId, body, options) => _URIW2U5Mjs.invokeF
|
|
|
44
44
|
contentType: "application/json",
|
|
45
45
|
options
|
|
46
46
|
});
|
|
47
|
-
var updateCollection = async (collectionId, body, options) =>
|
|
47
|
+
var updateCollection = async (collectionId, body, options) => invokeFetch("collections", {
|
|
48
48
|
method: "put",
|
|
49
49
|
pathTemplate: "/api/v1/collections/{collectionId}",
|
|
50
50
|
pathVariables: { collectionId },
|
|
@@ -52,14 +52,14 @@ var updateCollection = async (collectionId, body, options) => _URIW2U5Mjs.invoke
|
|
|
52
52
|
contentType: "application/json",
|
|
53
53
|
options
|
|
54
54
|
});
|
|
55
|
-
var getCollectionItems = async (collectionId, query, options) =>
|
|
55
|
+
var getCollectionItems = async (collectionId, query, options) => invokeFetch("collections", {
|
|
56
56
|
method: "get",
|
|
57
57
|
pathTemplate: "/api/v1/collections/{collectionId}/items",
|
|
58
58
|
pathVariables: { collectionId },
|
|
59
59
|
query,
|
|
60
60
|
options
|
|
61
61
|
});
|
|
62
|
-
var addCollectionItem = async (collectionId, body, options) =>
|
|
62
|
+
var addCollectionItem = async (collectionId, body, options) => invokeFetch("collections", {
|
|
63
63
|
method: "post",
|
|
64
64
|
pathTemplate: "/api/v1/collections/{collectionId}/items",
|
|
65
65
|
pathVariables: { collectionId },
|
|
@@ -67,20 +67,20 @@ var addCollectionItem = async (collectionId, body, options) => _URIW2U5Mjs.invok
|
|
|
67
67
|
contentType: "application/json",
|
|
68
68
|
options
|
|
69
69
|
});
|
|
70
|
-
var deleteCollectionItem = async (collectionId, itemId, options) =>
|
|
70
|
+
var deleteCollectionItem = async (collectionId, itemId, options) => invokeFetch("collections", {
|
|
71
71
|
method: "delete",
|
|
72
72
|
pathTemplate: "/api/v1/collections/{collectionId}/items/{itemId}",
|
|
73
73
|
pathVariables: { collectionId, itemId },
|
|
74
74
|
options
|
|
75
75
|
});
|
|
76
|
-
var getCollectionItem = async (collectionId, itemId, options) =>
|
|
76
|
+
var getCollectionItem = async (collectionId, itemId, options) => invokeFetch("collections", {
|
|
77
77
|
method: "get",
|
|
78
78
|
pathTemplate: "/api/v1/collections/{collectionId}/items/{itemId}",
|
|
79
79
|
pathVariables: { collectionId, itemId },
|
|
80
80
|
options
|
|
81
81
|
});
|
|
82
82
|
function clearCache() {
|
|
83
|
-
return
|
|
83
|
+
return clearApiCache("collections");
|
|
84
84
|
}
|
|
85
85
|
var collectionsExport = {
|
|
86
86
|
getCollections,
|
|
@@ -97,18 +97,18 @@ var collectionsExport = {
|
|
|
97
97
|
clearCache
|
|
98
98
|
};
|
|
99
99
|
var collections_default = collectionsExport;
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
100
|
+
export {
|
|
101
|
+
addCollectionItem,
|
|
102
|
+
clearCache,
|
|
103
|
+
createCollection,
|
|
104
|
+
collections_default as default,
|
|
105
|
+
deleteCollection,
|
|
106
|
+
deleteCollectionItem,
|
|
107
|
+
getCollection,
|
|
108
|
+
getCollectionItem,
|
|
109
|
+
getCollectionItems,
|
|
110
|
+
getCollections,
|
|
111
|
+
getFavoritesCollection,
|
|
112
|
+
patchCollection,
|
|
113
|
+
updateCollection
|
|
114
|
+
};
|
package/csp-origins.js
CHANGED
|
@@ -1,42 +1,42 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
1
|
+
import {
|
|
2
|
+
clearApiCache,
|
|
3
|
+
invokeFetch
|
|
4
|
+
} from "./chunks/LHCJKIEO.js";
|
|
5
|
+
import "./chunks/4V5AAWUI.js";
|
|
6
|
+
import "./chunks/4HB3TAEO.js";
|
|
7
7
|
|
|
8
8
|
// src/public/rest/csp-origins.ts
|
|
9
|
-
var getCSPEntries = async (query, options) =>
|
|
9
|
+
var getCSPEntries = async (query, options) => invokeFetch("csp-origins", {
|
|
10
10
|
method: "get",
|
|
11
11
|
pathTemplate: "/api/v1/csp-origins",
|
|
12
12
|
query,
|
|
13
13
|
options
|
|
14
14
|
});
|
|
15
|
-
var createCSPEntry = async (body, options) =>
|
|
15
|
+
var createCSPEntry = async (body, options) => invokeFetch("csp-origins", {
|
|
16
16
|
method: "post",
|
|
17
17
|
pathTemplate: "/api/v1/csp-origins",
|
|
18
18
|
body,
|
|
19
19
|
contentType: "application/json",
|
|
20
20
|
options
|
|
21
21
|
});
|
|
22
|
-
var getCSPHeader = async (options) =>
|
|
22
|
+
var getCSPHeader = async (options) => invokeFetch("csp-origins", {
|
|
23
23
|
method: "get",
|
|
24
24
|
pathTemplate: "/api/v1/csp-origins/actions/generate-header",
|
|
25
25
|
options
|
|
26
26
|
});
|
|
27
|
-
var deleteCSPEntry = async (id, options) =>
|
|
27
|
+
var deleteCSPEntry = async (id, options) => invokeFetch("csp-origins", {
|
|
28
28
|
method: "delete",
|
|
29
29
|
pathTemplate: "/api/v1/csp-origins/{id}",
|
|
30
30
|
pathVariables: { id },
|
|
31
31
|
options
|
|
32
32
|
});
|
|
33
|
-
var getCSPEntry = async (id, options) =>
|
|
33
|
+
var getCSPEntry = async (id, options) => invokeFetch("csp-origins", {
|
|
34
34
|
method: "get",
|
|
35
35
|
pathTemplate: "/api/v1/csp-origins/{id}",
|
|
36
36
|
pathVariables: { id },
|
|
37
37
|
options
|
|
38
38
|
});
|
|
39
|
-
var updateCSPEntry = async (id, body, options) =>
|
|
39
|
+
var updateCSPEntry = async (id, body, options) => invokeFetch("csp-origins", {
|
|
40
40
|
method: "put",
|
|
41
41
|
pathTemplate: "/api/v1/csp-origins/{id}",
|
|
42
42
|
pathVariables: { id },
|
|
@@ -45,7 +45,7 @@ var updateCSPEntry = async (id, body, options) => _URIW2U5Mjs.invokeFetch.call(v
|
|
|
45
45
|
options
|
|
46
46
|
});
|
|
47
47
|
function clearCache() {
|
|
48
|
-
return
|
|
48
|
+
return clearApiCache("csp-origins");
|
|
49
49
|
}
|
|
50
50
|
var cspOriginsExport = {
|
|
51
51
|
getCSPEntries,
|
|
@@ -57,13 +57,13 @@ var cspOriginsExport = {
|
|
|
57
57
|
clearCache
|
|
58
58
|
};
|
|
59
59
|
var csp_origins_default = cspOriginsExport;
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
60
|
+
export {
|
|
61
|
+
clearCache,
|
|
62
|
+
createCSPEntry,
|
|
63
|
+
csp_origins_default as default,
|
|
64
|
+
deleteCSPEntry,
|
|
65
|
+
getCSPEntries,
|
|
66
|
+
getCSPEntry,
|
|
67
|
+
getCSPHeader,
|
|
68
|
+
updateCSPEntry
|
|
69
|
+
};
|
package/data-assets.js
CHANGED
|
@@ -1,33 +1,33 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
1
|
+
import {
|
|
2
|
+
clearApiCache,
|
|
3
|
+
invokeFetch
|
|
4
|
+
} from "./chunks/LHCJKIEO.js";
|
|
5
|
+
import "./chunks/4V5AAWUI.js";
|
|
6
|
+
import "./chunks/4HB3TAEO.js";
|
|
7
7
|
|
|
8
8
|
// src/public/rest/data-assets.ts
|
|
9
|
-
var deleteDataAssets = async (body, options) =>
|
|
9
|
+
var deleteDataAssets = async (body, options) => invokeFetch("data-assets", {
|
|
10
10
|
method: "delete",
|
|
11
11
|
pathTemplate: "/api/v1/data-assets",
|
|
12
12
|
body,
|
|
13
13
|
contentType: "application/json",
|
|
14
14
|
options
|
|
15
15
|
});
|
|
16
|
-
var createDataAsset = async (body, options) =>
|
|
16
|
+
var createDataAsset = async (body, options) => invokeFetch("data-assets", {
|
|
17
17
|
method: "post",
|
|
18
18
|
pathTemplate: "/api/v1/data-assets",
|
|
19
19
|
body,
|
|
20
20
|
contentType: "application/json",
|
|
21
21
|
options
|
|
22
22
|
});
|
|
23
|
-
var getDataAsset = async (dataAssetId, query, options) =>
|
|
23
|
+
var getDataAsset = async (dataAssetId, query, options) => invokeFetch("data-assets", {
|
|
24
24
|
method: "get",
|
|
25
25
|
pathTemplate: "/api/v1/data-assets/{data-asset-id}",
|
|
26
26
|
pathVariables: { "data-asset-id": dataAssetId },
|
|
27
27
|
query,
|
|
28
28
|
options
|
|
29
29
|
});
|
|
30
|
-
var patchDataAsset = async (dataAssetId, body, options) =>
|
|
30
|
+
var patchDataAsset = async (dataAssetId, body, options) => invokeFetch("data-assets", {
|
|
31
31
|
method: "patch",
|
|
32
32
|
pathTemplate: "/api/v1/data-assets/{data-asset-id}",
|
|
33
33
|
pathVariables: { "data-asset-id": dataAssetId },
|
|
@@ -35,7 +35,7 @@ var patchDataAsset = async (dataAssetId, body, options) => _URIW2U5Mjs.invokeFet
|
|
|
35
35
|
contentType: "application/json",
|
|
36
36
|
options
|
|
37
37
|
});
|
|
38
|
-
var updateDataAsset = async (dataAssetId, body, options) =>
|
|
38
|
+
var updateDataAsset = async (dataAssetId, body, options) => invokeFetch("data-assets", {
|
|
39
39
|
method: "put",
|
|
40
40
|
pathTemplate: "/api/v1/data-assets/{data-asset-id}",
|
|
41
41
|
pathVariables: { "data-asset-id": dataAssetId },
|
|
@@ -44,7 +44,7 @@ var updateDataAsset = async (dataAssetId, body, options) => _URIW2U5Mjs.invokeFe
|
|
|
44
44
|
options
|
|
45
45
|
});
|
|
46
46
|
function clearCache() {
|
|
47
|
-
return
|
|
47
|
+
return clearApiCache("data-assets");
|
|
48
48
|
}
|
|
49
49
|
var dataAssetsExport = {
|
|
50
50
|
deleteDataAssets,
|
|
@@ -55,12 +55,12 @@ var dataAssetsExport = {
|
|
|
55
55
|
clearCache
|
|
56
56
|
};
|
|
57
57
|
var data_assets_default = dataAssetsExport;
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
58
|
+
export {
|
|
59
|
+
clearCache,
|
|
60
|
+
createDataAsset,
|
|
61
|
+
data_assets_default as default,
|
|
62
|
+
deleteDataAssets,
|
|
63
|
+
getDataAsset,
|
|
64
|
+
patchDataAsset,
|
|
65
|
+
updateDataAsset
|
|
66
|
+
};
|
package/data-connections.d.ts
CHANGED
|
@@ -45,55 +45,12 @@ type BulkResponse = {
|
|
|
45
45
|
}[];
|
|
46
46
|
};
|
|
47
47
|
/**
|
|
48
|
-
*
|
|
48
|
+
* Schema used to create a connection with given connection string (i.e. qConnectStatement) along with other metadata
|
|
49
49
|
*/
|
|
50
|
-
type Connection = {
|
|
51
|
-
/** Datetime when the connection was created */
|
|
52
|
-
created: string;
|
|
53
|
-
/** Data source ID */
|
|
54
|
-
datasourceID?: string;
|
|
55
|
-
links?: Link;
|
|
56
|
-
/** Array of string (i.e. update, delete, read) indicating the user's privileges on the associated connection */
|
|
57
|
-
privileges: Privilege[];
|
|
58
|
-
/** 0 or 1 value indicating whether the data connector is 64-bit (0) or 32-bit (1). Defaults to 0 if not specified. */
|
|
59
|
-
qArchitecture: 0 | 1;
|
|
60
|
-
/** Connection string for the data connection */
|
|
61
|
-
qConnectStatement: string;
|
|
62
|
-
/** String that contains connection specific secret (or password). This field will not be included in response of GET /data-connections, will only be included in the response of GET /data-connections/{qID} */
|
|
63
|
-
qConnectionSecret?: string;
|
|
64
|
-
/** ID of the credential associated with the connection */
|
|
65
|
-
qCredentialsID?: string;
|
|
66
|
-
/** Name of the credential associated with the connection */
|
|
67
|
-
qCredentialsName?: string;
|
|
68
|
-
/** Unique identifier (UUID) for the data connection, must be same as qID */
|
|
69
|
-
qEngineObjectID: string;
|
|
70
|
-
/** Unique identifier (UUID) for the data connection, must be same as qEngineObjectID */
|
|
71
|
-
qID: string;
|
|
72
|
-
/** Indicates the type of user associated with the data connection */
|
|
73
|
-
qLogOn: "0" | "1" | "LOG_ON_SERVICE_USER" | "LOG_ON_CURRENT_USER";
|
|
74
|
-
/** Descriptive name of the data connection */
|
|
75
|
-
qName: string;
|
|
76
|
-
/** Reference key of credential in redis */
|
|
77
|
-
qReferenceKey?: string;
|
|
78
|
-
/** Indicates whether or not this is a credential-less connection */
|
|
79
|
-
qSeparateCredentials: boolean;
|
|
80
|
-
/** Type of connection - indicates connection provider type */
|
|
81
|
-
qType: string;
|
|
82
|
-
/** Encrypted base Qri string */
|
|
83
|
-
qri?: string;
|
|
84
|
-
/** ID of the space to which the connection belongs */
|
|
85
|
-
space?: string;
|
|
86
|
-
/** Tenant ID of the connection's creator (Only when extended=true in query) */
|
|
87
|
-
tenant?: string;
|
|
88
|
-
/** Datetime when the connection was last updated */
|
|
89
|
-
updated: string;
|
|
90
|
-
/** User ID of the connection's creator */
|
|
91
|
-
user: string;
|
|
92
|
-
};
|
|
93
50
|
type ConnectionCreate = {
|
|
94
51
|
/** ID of the datasource associated with this connection */
|
|
95
52
|
datasourceID: string;
|
|
96
|
-
/** ID
|
|
53
|
+
/** App ID */
|
|
97
54
|
owner?: string;
|
|
98
55
|
/** 0 or 1 value indicating whether the data connector is 64-bit (0) or 32-bit (1). Defaults to 0 if not specified. */
|
|
99
56
|
qArchitecture?: 0 | 1;
|
|
@@ -113,7 +70,7 @@ type ConnectionCreate = {
|
|
|
113
70
|
qLogOn?: "0" | "1" | "LOG_ON_SERVICE_USER" | "LOG_ON_CURRENT_USER";
|
|
114
71
|
/** Descriptive name of the data connection */
|
|
115
72
|
qName: string;
|
|
116
|
-
/** Any logon password associated with the data connection */
|
|
73
|
+
/** Any logon password associated with the data connection (connector encoded) */
|
|
117
74
|
qPassword?: string;
|
|
118
75
|
/** Indicates whether or not to create a credential-less connection */
|
|
119
76
|
qSeparateCredentials?: boolean;
|
|
@@ -125,6 +82,8 @@ type ConnectionCreate = {
|
|
|
125
82
|
qriInRequest?: string;
|
|
126
83
|
/** ID of the space to which the connection belongs */
|
|
127
84
|
space?: string;
|
|
85
|
+
/** List of tags attached to the connection (allow max 32 tags) */
|
|
86
|
+
tags?: string[];
|
|
128
87
|
};
|
|
129
88
|
/**
|
|
130
89
|
* Essential fields of a connection
|
|
@@ -133,6 +92,7 @@ type ConnectionCreateResponse = {
|
|
|
133
92
|
/** Datetime when the connection was created */
|
|
134
93
|
created?: string;
|
|
135
94
|
links?: Link;
|
|
95
|
+
/** Array of string (i.e. update, delete, read) indicating the user's privileges on the associated connection */
|
|
136
96
|
privileges: Privilege[];
|
|
137
97
|
/** 0 or 1 value indicating whether the data connector is 64-bit (0) or 32-bit (1). Defaults to 0 if not specified. */
|
|
138
98
|
qArchitecture: 0 | 1;
|
|
@@ -163,6 +123,52 @@ type ConnectionCreateResponse = {
|
|
|
163
123
|
/** User ID of the connection's creator */
|
|
164
124
|
user?: string;
|
|
165
125
|
};
|
|
126
|
+
/**
|
|
127
|
+
* Essential fields of a connection
|
|
128
|
+
*/
|
|
129
|
+
type ConnectionGet = {
|
|
130
|
+
/** List of connection parsed from connection string (only available when query parseConnection=true is set) */
|
|
131
|
+
connectionProperties?: unknown;
|
|
132
|
+
/** Datetime when the connection was created */
|
|
133
|
+
created: string;
|
|
134
|
+
/** Data source ID */
|
|
135
|
+
datasourceID?: string;
|
|
136
|
+
links?: Link;
|
|
137
|
+
/** Array of string (i.e. update, delete, read) indicating the user's privileges on the associated connection */
|
|
138
|
+
privileges: Privilege[];
|
|
139
|
+
/** 0 or 1 value indicating whether the data connector is 64-bit (0) or 32-bit (1). Defaults to 0 if not specified. */
|
|
140
|
+
qArchitecture: 0 | 1;
|
|
141
|
+
/** Connection string for the data connection */
|
|
142
|
+
qConnectStatement: string;
|
|
143
|
+
/** String that contains connection specific secret (or password). This field will not be included in response of GET /data-connections, will only be included in the response of GET /data-connections/{qID} */
|
|
144
|
+
qConnectionSecret?: string;
|
|
145
|
+
/** ID of the credential associated with the connection */
|
|
146
|
+
qCredentialsID?: string;
|
|
147
|
+
/** Unique identifier (UUID) for the data connection, must be same as qID */
|
|
148
|
+
qEngineObjectID: string;
|
|
149
|
+
/** Unique identifier (UUID) for the data connection, must be same as qEngineObjectID */
|
|
150
|
+
qID: string;
|
|
151
|
+
/** Indicates the type of user associated with the data connection */
|
|
152
|
+
qLogOn: 0 | 1;
|
|
153
|
+
/** Descriptive name of the data connection */
|
|
154
|
+
qName: string;
|
|
155
|
+
/** Indicates whether or not this is a credential-less connection */
|
|
156
|
+
qSeparateCredentials: boolean;
|
|
157
|
+
/** Type of connection, i.e. provider type of underlying connector */
|
|
158
|
+
qType: string;
|
|
159
|
+
/** Encrypted base Qri string */
|
|
160
|
+
qri?: string;
|
|
161
|
+
/** ID of the space to which the connection belongs */
|
|
162
|
+
space?: string;
|
|
163
|
+
/** List of tags attached to the connection */
|
|
164
|
+
tags?: string[];
|
|
165
|
+
/** Tenant ID of the connection's creator */
|
|
166
|
+
tenant: string;
|
|
167
|
+
/** Datetime when the connection was last updated */
|
|
168
|
+
updated: string;
|
|
169
|
+
/** User ID of the connection's creator */
|
|
170
|
+
user: string;
|
|
171
|
+
};
|
|
166
172
|
type ConnectionUpdate = {
|
|
167
173
|
/** ID of the datasource associated with this connection */
|
|
168
174
|
datasourceID?: string;
|
|
@@ -196,11 +202,35 @@ type ConnectionUpdate = {
|
|
|
196
202
|
space?: string;
|
|
197
203
|
};
|
|
198
204
|
type Connections = {
|
|
199
|
-
data?:
|
|
205
|
+
data?: ConnectionGet[];
|
|
200
206
|
errors?: Errors;
|
|
201
207
|
links?: TopLevelLink;
|
|
202
208
|
meta?: Meta;
|
|
203
209
|
};
|
|
210
|
+
/**
|
|
211
|
+
* Schema used to create a connection using a list of connection properties for given datasource
|
|
212
|
+
*/
|
|
213
|
+
type DcaasConnectionCreate = {
|
|
214
|
+
/** When set to true, only authentication URL will be returned (i.e. no connection will be created) if datasource supports OAuth, and other properties set in the request will ignored. This property will be ignored if the request is not OAuth or datasource doesn't support OAuth */
|
|
215
|
+
authUrlOnly?: boolean;
|
|
216
|
+
/** Connection properties required to create dataconnection for the given datasource, which is defined by the response of 'GET /v1/data-sources/:{datasourceId}/api-specs' */
|
|
217
|
+
connectionProperties: unknown;
|
|
218
|
+
/** ID of the datasource of the connection */
|
|
219
|
+
datasourceID: string;
|
|
220
|
+
/** Descriptive name of the data connection */
|
|
221
|
+
qName: string;
|
|
222
|
+
/** ID of the space in which the connection shall be created. Connection will be created in user's personal space if undefined */
|
|
223
|
+
space?: string;
|
|
224
|
+
/** List of tags attached to the connection (allow max 31 tags) */
|
|
225
|
+
tags?: string[];
|
|
226
|
+
};
|
|
227
|
+
/**
|
|
228
|
+
* Authentication URL response for OAuth datasources (when authUrlOnly is set to true in request)
|
|
229
|
+
*/
|
|
230
|
+
type DcaasConnectionCreateAuthResponse = {
|
|
231
|
+
/** Authentication URL used to generate authentication code for datasources supporting OAuth */
|
|
232
|
+
authUrl: string;
|
|
233
|
+
};
|
|
204
234
|
type Error = {
|
|
205
235
|
/** Unique internal error code */
|
|
206
236
|
code?: string;
|
|
@@ -215,6 +245,7 @@ type Errors = Error[];
|
|
|
215
245
|
type Link = {
|
|
216
246
|
/** Link to cirrent query */
|
|
217
247
|
self: {
|
|
248
|
+
/** URL pointing to the resource */
|
|
218
249
|
href: string;
|
|
219
250
|
};
|
|
220
251
|
};
|
|
@@ -235,21 +266,24 @@ type PatchRequest = {
|
|
|
235
266
|
/**
|
|
236
267
|
* Access type allowed on associated data connection
|
|
237
268
|
*/
|
|
238
|
-
type Privilege = "list" | "update" | "delete" | "read";
|
|
269
|
+
type Privilege = "list" | "update" | "delete" | "read" | "change_owner" | "change_space";
|
|
239
270
|
type ResponseErrors = {
|
|
240
271
|
errors?: Errors;
|
|
241
272
|
};
|
|
242
273
|
type TopLevelLink = {
|
|
243
274
|
/** URL link to next page of requested resources (available to paged request only) */
|
|
244
275
|
next?: {
|
|
276
|
+
/** URL pointing to the next page of resources */
|
|
245
277
|
href: string;
|
|
246
278
|
};
|
|
247
279
|
/** URL link to previous page of requested resources (available to paged request only) */
|
|
248
280
|
prev?: {
|
|
281
|
+
/** URL pointing to the previous page of resources */
|
|
249
282
|
href: string;
|
|
250
283
|
};
|
|
251
284
|
/** Link to cirrent query */
|
|
252
285
|
self: {
|
|
286
|
+
/** URL pointing to the resource */
|
|
253
287
|
href: string;
|
|
254
288
|
};
|
|
255
289
|
};
|
|
@@ -264,25 +298,25 @@ declare const getDataConnections: (query: {
|
|
|
264
298
|
caseinsensitive?: boolean;
|
|
265
299
|
/** Provides an alternate name to be used for data[] element in GET response. */
|
|
266
300
|
dataName?: string;
|
|
267
|
-
/** Returns extended list of properties when set to true. */
|
|
301
|
+
/** Returns extended list of properties (e.g. encrypted credential string) when set to true. */
|
|
268
302
|
extended?: boolean;
|
|
269
303
|
/** Filtering resources by properties (filterable properties only) using SCIM filter string. Note the filter string only applies to connections managed by data-connections service, i.e. filtering doesn't apply to DataFile connections. */
|
|
270
304
|
filter?: string;
|
|
271
305
|
/** Base Qri (encrypted) will be returned when the query is set to true, default is false */
|
|
272
306
|
includeQris?: boolean;
|
|
273
|
-
/** Number of resources to be returned */
|
|
307
|
+
/** Number of resources to be returned (between 1 and 100) */
|
|
274
308
|
limit?: number;
|
|
275
309
|
/** ICU locale ID, used only when caseinsensitive is set to true, default to 'en' if undefined */
|
|
276
310
|
locale?: string;
|
|
277
311
|
/** Datafiles connections will not be returned if set to true */
|
|
278
312
|
noDatafiles?: boolean;
|
|
279
|
-
/** Filtering on
|
|
313
|
+
/** Filtering on connections, return connections owned by the caller if set to true (doesn't apply to datafiles connections) */
|
|
280
314
|
ownedByMe?: boolean;
|
|
281
315
|
/** Filtering on datafile connections by owner (i.e. app) ID. */
|
|
282
316
|
owner?: string;
|
|
283
317
|
/** Pagination sursor string, which is generated auotmatically in previous pagination query. */
|
|
284
318
|
page?: string;
|
|
285
|
-
/** Filtering on connections,
|
|
319
|
+
/** Filtering on personal connections, ignored if spaceId is defined in same request */
|
|
286
320
|
personal?: boolean;
|
|
287
321
|
/** Name of field sort on for pagination, with prefix with + or - indicating ascending or descending order. When used for data-connections, sort field only applies to non-datafiles connections. Whatever sorting order is, datafiles connections will be returned after all regular connections being returned. */
|
|
288
322
|
sort?: string;
|
|
@@ -304,14 +338,14 @@ type GetDataConnectionsHttpError = {
|
|
|
304
338
|
status: number;
|
|
305
339
|
};
|
|
306
340
|
/**
|
|
307
|
-
* Creates a connection.
|
|
341
|
+
* Creates a new connection. Depending on the fields defined in the request body, credentials embedded (or associated) in the connection can be updated or created.
|
|
308
342
|
*
|
|
309
343
|
* @param body an object with the body content
|
|
310
344
|
* @throws CreateDataConnectionHttpError
|
|
311
345
|
*/
|
|
312
|
-
declare const createDataConnection: (body: ConnectionCreate, options?: ApiCallOptions) => Promise<CreateDataConnectionHttpResponse>;
|
|
346
|
+
declare const createDataConnection: (body: ConnectionCreate | DcaasConnectionCreate, options?: ApiCallOptions) => Promise<CreateDataConnectionHttpResponse>;
|
|
313
347
|
type CreateDataConnectionHttpResponse = {
|
|
314
|
-
data: ConnectionCreateResponse;
|
|
348
|
+
data: ConnectionCreateResponse | DcaasConnectionCreateAuthResponse;
|
|
315
349
|
headers: Headers;
|
|
316
350
|
status: number;
|
|
317
351
|
};
|
|
@@ -395,7 +429,7 @@ type DeleteDataConnectionHttpError = {
|
|
|
395
429
|
status: number;
|
|
396
430
|
};
|
|
397
431
|
/**
|
|
398
|
-
*
|
|
432
|
+
* Retrieves a connection by connection ID, or by name when the query parameter "type" is set to "connectionname."
|
|
399
433
|
*
|
|
400
434
|
* @param qID Connection ID
|
|
401
435
|
* @param query an object with query parameters
|
|
@@ -406,17 +440,19 @@ declare const getDataConnection: (qID: string, query: {
|
|
|
406
440
|
byCredentialName?: boolean;
|
|
407
441
|
/** Credential ID */
|
|
408
442
|
credentialId?: string;
|
|
409
|
-
/** Returns extended list of properties when set to true. */
|
|
443
|
+
/** Returns extended list of properties (e.g. encrypted credential string) when set to true. */
|
|
410
444
|
extended?: boolean;
|
|
411
445
|
/** datafiles connections will be returned from cache by default (if data-connections is configured to use cache), this query parameter is used disable this default behavior, e.g. return an update-to-date datafiles connection if the query is set to true */
|
|
412
446
|
noCache?: boolean;
|
|
447
|
+
/** List of connection properties shall be returned when the query is set to true, default is false */
|
|
448
|
+
parseConnection?: boolean;
|
|
413
449
|
/** Filtering on connections by space ID */
|
|
414
450
|
spaceId?: string;
|
|
415
451
|
/** Connection / credential ID defined in path become connection / credential name when this query parameter is set */
|
|
416
452
|
type?: "connectionname" | "credentialname";
|
|
417
453
|
}, options?: ApiCallOptions) => Promise<GetDataConnectionHttpResponse>;
|
|
418
454
|
type GetDataConnectionHttpResponse = {
|
|
419
|
-
data:
|
|
455
|
+
data: ConnectionGet;
|
|
420
456
|
headers: Headers;
|
|
421
457
|
status: number;
|
|
422
458
|
};
|
|
@@ -484,7 +520,7 @@ interface DataConnectionsAPI {
|
|
|
484
520
|
*/
|
|
485
521
|
getDataConnections: typeof getDataConnections;
|
|
486
522
|
/**
|
|
487
|
-
* Creates a connection.
|
|
523
|
+
* Creates a new connection. Depending on the fields defined in the request body, credentials embedded (or associated) in the connection can be updated or created.
|
|
488
524
|
*
|
|
489
525
|
* @param body an object with the body content
|
|
490
526
|
* @throws CreateDataConnectionHttpError
|
|
@@ -520,7 +556,7 @@ interface DataConnectionsAPI {
|
|
|
520
556
|
*/
|
|
521
557
|
deleteDataConnection: typeof deleteDataConnection;
|
|
522
558
|
/**
|
|
523
|
-
*
|
|
559
|
+
* Retrieves a connection by connection ID, or by name when the query parameter "type" is set to "connectionname."
|
|
524
560
|
*
|
|
525
561
|
* @param qID Connection ID
|
|
526
562
|
* @param query an object with query parameters
|
|
@@ -555,4 +591,4 @@ interface DataConnectionsAPI {
|
|
|
555
591
|
*/
|
|
556
592
|
declare const dataConnectionsExport: DataConnectionsAPI;
|
|
557
593
|
|
|
558
|
-
export { type ActionDeleteRequest, type ActionDuplicateRequest, type ActionUpdateRequest, type BulkResponse, type
|
|
594
|
+
export { type ActionDeleteRequest, type ActionDuplicateRequest, type ActionUpdateRequest, type BulkResponse, type ConnectionCreate, type ConnectionCreateResponse, type ConnectionGet, type ConnectionUpdate, type Connections, type CreateDataConnectionHttpError, type CreateDataConnectionHttpResponse, type DataConnectionsAPI, type DcaasConnectionCreate, type DcaasConnectionCreateAuthResponse, type DeleteDataConnectionHttpError, type DeleteDataConnectionHttpResponse, type DeleteDataConnectionsHttpError, type DeleteDataConnectionsHttpResponse, type DuplicateDataAConnectionHttpError, type DuplicateDataAConnectionHttpResponse, type Error, type Errors, type GetDataConnectionHttpError, type GetDataConnectionHttpResponse, type GetDataConnectionsHttpError, type GetDataConnectionsHttpResponse, type Link, type Meta, type PatchDataConnectionHttpError, type PatchDataConnectionHttpResponse, type PatchRequest, type Privilege, type ResponseErrors, type TopLevelLink, type UpdateDataConnectionHttpError, type UpdateDataConnectionHttpResponse, type UpdateDataConnectionsHttpError, type UpdateDataConnectionsHttpResponse, clearCache, createDataConnection, dataConnectionsExport as default, deleteDataConnection, deleteDataConnections, duplicateDataAConnection, getDataConnection, getDataConnections, patchDataConnection, updateDataConnection, updateDataConnections };
|