@qlik/api 2.3.0 → 2.4.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/analytics/change-stores.d.ts +40 -76
- package/analytics/change-stores.js +9 -10
- package/analytics.d.ts +1 -2
- package/analytics.js +5 -6
- package/api-keys.d.ts +46 -100
- package/api-keys.js +3 -4
- package/apps.d.ts +334 -461
- package/apps.js +74 -6
- package/assistants.d.ts +172 -337
- package/assistants.js +3 -4
- package/audits.d.ts +41 -85
- package/audits.js +3 -4
- package/auth-types.d.ts +110 -1
- package/auth-types.js +22 -1
- package/auth.d.ts +1 -2
- package/auth.js +1 -1
- package/automation-connections.d.ts +44 -95
- package/automation-connections.js +3 -4
- package/automation-connectors.d.ts +10 -20
- package/automation-connectors.js +3 -4
- package/automations.d.ts +54 -112
- package/automations.js +3 -4
- package/automl-deployments.d.ts +17 -36
- package/automl-deployments.js +3 -4
- package/automl-predictions.d.ts +12 -24
- package/automl-predictions.js +3 -4
- package/banners.d.ts +8 -14
- package/banners.js +3 -4
- package/brands.d.ts +19 -39
- package/brands.js +3 -4
- package/chunks/auth-B8lJw7rm.js +31 -0
- package/chunks/{interceptors-DipDBQQ5.js → boot-interceptors-DqRxTczb.js} +296 -248
- package/chunks/{chunk-D3vHIbds.js → chunk-BdHzlgOL.js} +3 -3
- package/chunks/{invoke-fetch-B7lGscuQ.js → invoke-fetch-DMAi6Fg3.js} +3 -3
- package/chunks/{invoke-fetch-DhdyFZ0F.js → invoke-fetch-pMN6iqup.js} +2 -3
- package/chunks/platform-types-CECrZkOF.d.ts +29 -0
- package/chunks/{public-runtime-modules-QhLPeQr5.js → public-runtime-modules-2KfyI2qM.js} +5 -5
- package/chunks/{qix-RCUslia8.js → qix-BdNrIA4s.js} +19 -20
- package/chunks/{qix-chunk-entrypoint-WAS4NVTf.js → qix-chunk-entrypoint-L9RpWwLK.js} +52 -58
- package/chunks/{qix-CrqXv44x.d.ts → qix-types-y_di0roE.d.ts} +33 -115
- package/collections.d.ts +67 -144
- package/collections.js +3 -4
- package/conditions.d.ts +87 -190
- package/conditions.js +3 -4
- package/consumption.d.ts +35 -72
- package/consumption.js +3 -4
- package/core/ip-policies.d.ts +43 -93
- package/core/ip-policies.js +5 -6
- package/core.d.ts +1 -2
- package/core.js +5 -6
- package/csp-origins.d.ts +42 -85
- package/csp-origins.js +3 -4
- package/csrf-token.d.ts +6 -11
- package/csrf-token.js +3 -4
- package/data-alerts.d.ts +152 -325
- package/data-alerts.js +3 -4
- package/data-assets.d.ts +16 -31
- package/data-assets.js +3 -4
- package/data-connections.d.ts +123 -257
- package/data-connections.js +3 -4
- package/data-credentials.d.ts +36 -76
- package/data-credentials.js +3 -4
- package/data-files.d.ts +60 -121
- package/data-files.js +3 -4
- package/data-governance/data-products.d.ts +429 -0
- package/data-governance/data-products.js +212 -0
- package/data-governance.d.ts +13 -0
- package/data-governance.js +12 -0
- package/data-qualities.d.ts +11 -25
- package/data-qualities.js +3 -4
- package/data-sets.d.ts +28 -57
- package/data-sets.js +3 -4
- package/data-sources.d.ts +45 -97
- package/data-sources.js +3 -4
- package/data-stores.d.ts +53 -107
- package/data-stores.js +3 -4
- package/dcaas.d.ts +32 -67
- package/dcaas.js +3 -4
- package/di-projects.d.ts +111 -136
- package/di-projects.js +25 -4
- package/direct-access-agents.d.ts +29 -63
- package/direct-access-agents.js +3 -4
- package/encryption.d.ts +28 -59
- package/encryption.js +3 -4
- package/extensions.d.ts +35 -73
- package/extensions.js +3 -4
- package/global-types.d.ts +139 -1
- package/glossaries.d.ts +75 -158
- package/glossaries.js +3 -4
- package/groups.d.ts +58 -125
- package/groups.js +3 -4
- package/identity-providers.d.ts +148 -324
- package/identity-providers.js +3 -4
- package/index.d.ts +18 -4
- package/index.js +64 -19
- package/interceptors.d.ts +2 -3
- package/interceptors.js +104 -2
- package/invoke-fetch-types.d.ts +97 -1
- package/items.d.ts +85 -181
- package/items.js +3 -4
- package/knowledgebases.d.ts +137 -270
- package/knowledgebases.js +3 -4
- package/licenses.d.ts +71 -153
- package/licenses.js +3 -4
- package/lineage-graphs.d.ts +39 -85
- package/lineage-graphs.js +3 -4
- package/ml.d.ts +290 -621
- package/ml.js +3 -4
- package/notes.d.ts +9 -18
- package/notes.js +3 -4
- package/notifications.d.ts +14 -30
- package/notifications.js +3 -4
- package/oauth-clients.d.ts +98 -159
- package/oauth-clients.js +4 -5
- package/oauth-tokens.d.ts +16 -33
- package/oauth-tokens.js +3 -4
- package/package.json +6 -4
- package/qix.d.ts +46 -2
- package/qix.js +2 -3
- package/questions.d.ts +53 -110
- package/questions.js +3 -4
- package/quotas.d.ts +13 -26
- package/quotas.js +3 -4
- package/reload-tasks.d.ts +23 -46
- package/reload-tasks.js +3 -4
- package/reloads.d.ts +26 -52
- package/reloads.js +3 -4
- package/report-templates.d.ts +30 -63
- package/report-templates.js +3 -4
- package/reports.d.ts +111 -238
- package/reports.js +3 -4
- package/roles.d.ts +36 -77
- package/roles.js +3 -4
- package/sharing-tasks.d.ts +201 -427
- package/sharing-tasks.js +3 -4
- package/spaces.d.ts +71 -157
- package/spaces.js +3 -4
- package/tasks.d.ts +76 -164
- package/tasks.js +3 -4
- package/temp-contents.d.ts +17 -35
- package/temp-contents.js +3 -4
- package/tenant-settings.d.ts +298 -0
- package/tenant-settings.js +107 -0
- package/tenants.d.ts +31 -67
- package/tenants.js +3 -4
- package/themes.d.ts +27 -55
- package/themes.js +3 -4
- package/transports.d.ts +46 -106
- package/transports.js +3 -4
- package/ui-config.d.ts +8 -17
- package/ui-config.js +3 -4
- package/users.d.ts +80 -170
- package/users.js +3 -4
- package/web-integrations.d.ts +38 -83
- package/web-integrations.js +3 -4
- package/web-notifications.d.ts +14 -29
- package/web-notifications.js +3 -4
- package/webhooks.d.ts +77 -162
- package/webhooks.js +3 -4
- package/chunks/auth-BowS4SUR.js +0 -28
- package/chunks/auth-types-YrlH_R9f.d.ts +0 -416
- package/chunks/auth-types-h43TVDpB.js +0 -24
- package/chunks/global-types-CEVAJebk.js +0 -1
- /package/chunks/{dist-n3iOVn1W.js → dist-DR758NU5.js} +0 -0
- /package/chunks/{invoke-fetch-C1Z0RJYU.d.ts → invoke-fetch-DFc3yzaj.d.ts} +0 -0
- /package/chunks/{utils-vv-xFm06.js → utils-jkpLuYZR.js} +0 -0
- /package/chunks/{websocket-errors-CRTDTtBL.js → websocket-errors-C5U1tba-.js} +0 -0
package/data-qualities.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import {
|
|
2
|
-
import "./chunks/invoke-fetch-
|
|
1
|
+
import { ApiCallOptions } from "./invoke-fetch-types.js";
|
|
2
|
+
import "./chunks/invoke-fetch-DFc3yzaj.js";
|
|
3
3
|
|
|
4
4
|
//#region src/public/rest/data-qualities.d.ts
|
|
5
5
|
/**
|
|
@@ -24,9 +24,7 @@ type ConnectionIdType = string;
|
|
|
24
24
|
* }
|
|
25
25
|
*/
|
|
26
26
|
type DataQualityComputationRequest = {
|
|
27
|
-
/** The ID of the connection */
|
|
28
|
-
connectionId?: ConnectionIdType;
|
|
29
|
-
/** The ID of the dataset */
|
|
27
|
+
/** The ID of the connection */connectionId?: ConnectionIdType; /** The ID of the dataset */
|
|
30
28
|
datasetId?: DatasetIdType;
|
|
31
29
|
} & SamplingConfiguration;
|
|
32
30
|
/**
|
|
@@ -34,14 +32,12 @@ type DataQualityComputationRequest = {
|
|
|
34
32
|
*/
|
|
35
33
|
type DatasetIdType = string;
|
|
36
34
|
type DatasetQualityGlobalResultsResponse = {
|
|
37
|
-
/** The ID of the dataset */
|
|
38
|
-
datasetId: string;
|
|
35
|
+
/** The ID of the dataset */datasetId: string;
|
|
39
36
|
qualities: QualitiesGlobalResultsResponse[];
|
|
40
37
|
};
|
|
41
38
|
type Error = {
|
|
42
39
|
code?: string;
|
|
43
40
|
detail?: string;
|
|
44
|
-
status?: string;
|
|
45
41
|
title?: string;
|
|
46
42
|
};
|
|
47
43
|
type ErrorResponse = {
|
|
@@ -50,27 +46,19 @@ type ErrorResponse = {
|
|
|
50
46
|
};
|
|
51
47
|
type ExecutionStatus = "PROFILE_REQUESTED" | "PROFILE_FAILED" | "REQUESTED" | "SUBMITTED" | "SUCCEEDED" | "FAILED";
|
|
52
48
|
type QualitiesGlobalResultsResponse = {
|
|
53
|
-
/** The ID of the connection */
|
|
54
|
-
connectionId: string;
|
|
49
|
+
/** The ID of the connection */connectionId: string;
|
|
55
50
|
quality: QualityGlobalResultsResponse;
|
|
56
51
|
};
|
|
57
52
|
type QualityGlobalResultsResponse = {
|
|
58
|
-
/** Number of empty sample cells */
|
|
59
|
-
|
|
60
|
-
/** Number of invalid sample cells */
|
|
61
|
-
invalid: number;
|
|
62
|
-
/** Total number of cells in the sample */
|
|
53
|
+
/** Number of empty sample cells */empty: number; /** Number of invalid sample cells */
|
|
54
|
+
invalid: number; /** Total number of cells in the sample */
|
|
63
55
|
total: number;
|
|
64
|
-
updatedAt: string;
|
|
65
|
-
/** Number of valid sample cells */
|
|
56
|
+
updatedAt: string; /** Number of valid sample cells */
|
|
66
57
|
valid: number;
|
|
67
58
|
};
|
|
68
59
|
type SamplingConfiguration = {
|
|
69
|
-
/** Specifies where the data quality computation takes place. In PUSHDOWN mode, it runs within the Cloud Data Warehouse (e.g., Snowflake, Databricks), whereas in PULLUP mode, it runs in Qlik Cloud. */
|
|
70
|
-
|
|
71
|
-
/** Specifies how the dataset is sampled. ABSOLUTE represents a fixed number of rows, while RELATIVE refers to a percentage of the total dataset rows. */
|
|
72
|
-
sampleMode?: "ABSOLUTE" | "RELATIVE";
|
|
73
|
-
/** The actual value of the selected sampling method size (either a fixed number for ABSOLUTE mode or a percentage for RELATIVE mode). */
|
|
60
|
+
/** Specifies where the data quality computation takes place. In PUSHDOWN mode, it runs within the Cloud Data Warehouse (e.g., Snowflake, Databricks), whereas in PULLUP mode, it runs in Qlik Cloud. */executionMode?: "PUSHDOWN" | "PULLUP"; /** Specifies how the dataset is sampled. ABSOLUTE represents a fixed number of rows, while RELATIVE refers to a percentage of the total dataset rows. */
|
|
61
|
+
sampleMode?: "ABSOLUTE" | "RELATIVE"; /** The actual value of the selected sampling method size (either a fixed number for ABSOLUTE mode or a percentage for RELATIVE mode). */
|
|
74
62
|
sampleSize?: number;
|
|
75
63
|
};
|
|
76
64
|
/**
|
|
@@ -118,9 +106,7 @@ type GetDataQualitiesComputationHttpError = {
|
|
|
118
106
|
* @throws GetDataQualitiesGlobalResultsHttpError
|
|
119
107
|
*/
|
|
120
108
|
declare function getDataQualitiesGlobalResults(query: {
|
|
121
|
-
/** The connection ID */
|
|
122
|
-
connectionId?: ConnectionIdType;
|
|
123
|
-
/** The ID of the dataset */
|
|
109
|
+
/** The connection ID */connectionId?: ConnectionIdType; /** The ID of the dataset */
|
|
124
110
|
datasetId: DatasetIdType;
|
|
125
111
|
}, options?: ApiCallOptions): Promise<GetDataQualitiesGlobalResultsHttpResponse>;
|
|
126
112
|
type GetDataQualitiesGlobalResultsHttpResponse = {
|
package/data-qualities.js
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import "./chunks/public-runtime-modules-
|
|
2
|
-
import { n as invokeFetch, t as clearApiCache } from "./chunks/invoke-fetch-
|
|
1
|
+
import "./chunks/public-runtime-modules-2KfyI2qM.js";
|
|
2
|
+
import { n as invokeFetch, t as clearApiCache } from "./chunks/invoke-fetch-DMAi6Fg3.js";
|
|
3
3
|
|
|
4
4
|
//#region src/public/rest/data-qualities.ts
|
|
5
5
|
/**
|
|
@@ -64,7 +64,6 @@ const dataQualitiesExport = {
|
|
|
64
64
|
getDataQualitiesGlobalResults,
|
|
65
65
|
clearCache
|
|
66
66
|
};
|
|
67
|
-
var data_qualities_default = dataQualitiesExport;
|
|
68
67
|
|
|
69
68
|
//#endregion
|
|
70
|
-
export { clearCache,
|
|
69
|
+
export { clearCache, dataQualitiesExport as default, getDataQualitiesComputation, getDataQualitiesGlobalResults, triggerDataQualitiesComputation };
|
package/data-sets.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import {
|
|
2
|
-
import "./chunks/invoke-fetch-
|
|
1
|
+
import { ApiCallOptions } from "./invoke-fetch-types.js";
|
|
2
|
+
import "./chunks/invoke-fetch-DFc3yzaj.js";
|
|
3
3
|
|
|
4
4
|
//#region src/public/rest/data-sets.d.ts
|
|
5
5
|
type BatchIdDto = {
|
|
@@ -32,50 +32,34 @@ type DataField = {
|
|
|
32
32
|
orphan?: boolean;
|
|
33
33
|
primaryKey?: boolean;
|
|
34
34
|
properties?: Record<string, unknown>;
|
|
35
|
-
sensitive?: boolean;
|
|
36
|
-
/** An array of
|
|
37
|
-
tags?: string[];
|
|
38
|
-
/** An array of user-supplied tags */
|
|
35
|
+
sensitive?: boolean; /** An array of system tags */
|
|
36
|
+
tags?: string[]; /** An array of user-supplied tags */
|
|
39
37
|
userTags?: UserTag[];
|
|
40
38
|
};
|
|
41
39
|
type DataSet = {
|
|
42
|
-
/** Optional field to specify additional schemas for files where multiple tables or sheets are available. User must define primary schema in 'schema' attribute and rest of the sheets/ tables can be defined using this field. This field is not populated for the dataSets with single schema */
|
|
43
|
-
|
|
44
|
-
/**
|
|
45
|
-
|
|
46
|
-
/** The value is automatically set by the application. User defined value is ignored. */
|
|
47
|
-
readonly createdBy?: string;
|
|
48
|
-
/** The connectionId that created the Dataset. Optional. */
|
|
49
|
-
createdByConnectionId?: string;
|
|
50
|
-
/** The value is automatically set by the application. User defined value is ignored. */
|
|
40
|
+
/** Optional field to specify additional schemas for files where multiple tables or sheets are available. User must define primary schema in 'schema' attribute and rest of the sheets/ tables can be defined using this field. This field is not populated for the dataSets with single schema */additionalSchemas?: Schema[]; /** Optional override of DataAsset appType. */
|
|
41
|
+
appTypeOverride?: string; /** The value is automatically set by the application. User defined value is ignored. */
|
|
42
|
+
readonly createdBy?: string; /** The connectionId that created the Dataset. Optional. */
|
|
43
|
+
createdByConnectionId?: string; /** The value is automatically set by the application. User defined value is ignored. */
|
|
51
44
|
readonly createdTime?: string;
|
|
52
45
|
dataAssetInfo: DataAssetInfo;
|
|
53
|
-
description?: string;
|
|
54
|
-
/**
|
|
55
|
-
|
|
56
|
-
/** The value is automatically set by the application. User defined value is ignored. */
|
|
57
|
-
readonly lastModifiedBy?: string;
|
|
58
|
-
/** The value is automatically set by the application. User defined value is ignored. */
|
|
46
|
+
description?: string; /** Only required when updating the resource. Must be null for new resources. */
|
|
47
|
+
id?: string; /** The value is automatically set by the application. User defined value is ignored. */
|
|
48
|
+
readonly lastModifiedBy?: string; /** The value is automatically set by the application. User defined value is ignored. */
|
|
59
49
|
readonly lastModifiedTime?: string;
|
|
60
50
|
name?: string;
|
|
61
|
-
operational?: Operational;
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
/**
|
|
65
|
-
properties?: Record<string, unknown>;
|
|
66
|
-
/** NOTE: this will be deprecated after migration to secureQri. Required user defined field. All the parts in the format must be separated by ':'. The first part denotes the resourceType, followed by dataStoreType and tenant guid. The spaceGuid or userGuid is to be populated based on if the dataset is in shared or private space and finally the full file name. This field is auto populated for the dataSet generated for qix-datafiles. */
|
|
67
|
-
qri: string;
|
|
68
|
-
/** Optional field to specify additional schemas for files where multiple tables or sheets are available. User must define primary schema in 'schema' attribute and rest of the sheets/ tables can be defined using this field. This field is not populated for the dataSets with single schema */
|
|
51
|
+
operational?: Operational; /** The value is automatically set by the application. */
|
|
52
|
+
ownerId?: string; /** A Map of name-value pairs. */
|
|
53
|
+
properties?: Record<string, unknown>; /** NOTE: this will be deprecated after migration to secureQri. Required user defined field. All the parts in the format must be separated by ':'. The first part denotes the resourceType, followed by dataStoreType and tenant guid. The spaceGuid or userGuid is to be populated based on if the dataset is in shared or private space and finally the full file name. This field is auto populated for the dataSet generated for qix-datafiles. */
|
|
54
|
+
qri: string; /** Optional field to specify additional schemas for files where multiple tables or sheets are available. User must define primary schema in 'schema' attribute and rest of the sheets/ tables can be defined using this field. This field is not populated for the dataSets with single schema */
|
|
69
55
|
schema?: Schema;
|
|
70
56
|
secureQri: string;
|
|
71
57
|
spaceId?: string;
|
|
72
58
|
tags?: string[];
|
|
73
59
|
technicalDescription?: string;
|
|
74
|
-
technicalName: string;
|
|
75
|
-
/** The value is automatically set by the application. User defined value is ignored. */
|
|
60
|
+
technicalName: string; /** The value is automatically set by the application. User defined value is ignored. */
|
|
76
61
|
readonly tenantId?: string;
|
|
77
|
-
type?: string;
|
|
78
|
-
/** Only required when updating the resource. Must be null for new resources. */
|
|
62
|
+
type?: string; /** Only required when updating the resource. Must be null for new resources. */
|
|
79
63
|
version?: number;
|
|
80
64
|
};
|
|
81
65
|
type DataSetProfile = {
|
|
@@ -99,10 +83,8 @@ type ErrorResponse = {
|
|
|
99
83
|
traceId?: string;
|
|
100
84
|
};
|
|
101
85
|
type FieldDataType = {
|
|
102
|
-
originalType?: string;
|
|
103
|
-
|
|
104
|
-
properties?: Record<string, unknown>;
|
|
105
|
-
/** Each datatype may vary in terms of required properties. Example: Datatype DECIMAL requires two mandatory properties to be defined - precision and scale, each one accepts integer value. All other datatypes does not have any required properties. */
|
|
86
|
+
originalType?: string; /** The properties map key is string and the value is of type object. Please note, Datatype DECIMAL requires two mandatory properties to be defined; these properties must be named: precision and scale, each of these property accepts integer value. All other datatypes does not require any manadatory properties to be defined. */
|
|
87
|
+
properties?: Record<string, unknown>; /** Each datatype may vary in terms of required properties. Example: Datatype DECIMAL requires two mandatory properties to be defined - precision and scale, each one accepts integer value. All other datatypes does not have any required properties. */
|
|
106
88
|
type: "DATE" | "TIME" | "DATETIME" | "TIMESTAMP" | "STRING" | "DOUBLE" | "DECIMAL" | "INTEGER" | "BOOLEAN" | "BINARY" | "CUSTOM";
|
|
107
89
|
};
|
|
108
90
|
type FieldProfile = {
|
|
@@ -146,13 +128,9 @@ type Frequency = {
|
|
|
146
128
|
value?: string;
|
|
147
129
|
};
|
|
148
130
|
type JsonPatch = {
|
|
149
|
-
/** A JSON Pointer path pointing to the location to move/copy from. */
|
|
150
|
-
|
|
151
|
-
/** The
|
|
152
|
-
op: "add" | "remove" | "replace" | "move" | "copy" | "test";
|
|
153
|
-
/** A JSON pointer to the property being affected. */
|
|
154
|
-
path: string;
|
|
155
|
-
/** The value to add, replace or test. */
|
|
131
|
+
/** A JSON Pointer path pointing to the location to move/copy from. */from?: string; /** The operation to be performed. */
|
|
132
|
+
op: "add" | "remove" | "replace" | "move" | "copy" | "test"; /** A JSON pointer to the property being affected. */
|
|
133
|
+
path: string; /** The value to add, replace or test. */
|
|
156
134
|
value?: unknown;
|
|
157
135
|
};
|
|
158
136
|
type Link = {
|
|
@@ -201,11 +179,9 @@ type ProfileMetadata = {
|
|
|
201
179
|
* Optional field to specify additional schemas for files where multiple tables or sheets are available. User must define primary schema in 'schema' attribute and rest of the sheets/ tables can be defined using this field. This field is not populated for the dataSets with single schema
|
|
202
180
|
*/
|
|
203
181
|
type Schema = {
|
|
204
|
-
/** Anomalies associated with this schema. Example: $warning-unknown-headers */
|
|
205
|
-
anomalies?: string[];
|
|
182
|
+
/** Anomalies associated with this schema. Example: $warning-unknown-headers */anomalies?: string[];
|
|
206
183
|
dataFields: DataField[];
|
|
207
|
-
readonly effectiveDate?: string;
|
|
208
|
-
/** Options for loading files. Example: "qLabel": "embedded labels" */
|
|
184
|
+
readonly effectiveDate?: string; /** Options for loading files. Example: "qLabel": "embedded labels" */
|
|
209
185
|
loadOptions?: Record<string, unknown>;
|
|
210
186
|
overrideSchemaAnomalies?: boolean;
|
|
211
187
|
schemaName?: string;
|
|
@@ -237,8 +213,7 @@ type Tag = {
|
|
|
237
213
|
* An array of user-supplied tags
|
|
238
214
|
*/
|
|
239
215
|
type UserTag = {
|
|
240
|
-
/** The id of the tag in Collections */
|
|
241
|
-
id?: string;
|
|
216
|
+
/** The id of the tag in Collections */id?: string;
|
|
242
217
|
name?: string;
|
|
243
218
|
};
|
|
244
219
|
/**
|
|
@@ -283,8 +258,7 @@ type CreateDataSetHttpError = {
|
|
|
283
258
|
* @throws GetDataSetHttpError
|
|
284
259
|
*/
|
|
285
260
|
declare function getDataSet(dataSetId: string, query: {
|
|
286
|
-
/** Comma-separated fields to return in the response. */
|
|
287
|
-
projections?: string[];
|
|
261
|
+
/** Comma-separated fields to return in the response. */projections?: string[];
|
|
288
262
|
}, options?: ApiCallOptions): Promise<GetDataSetHttpResponse>;
|
|
289
263
|
type GetDataSetHttpResponse = {
|
|
290
264
|
data: DataSet;
|
|
@@ -340,12 +314,9 @@ type UpdateDataSetHttpError = {
|
|
|
340
314
|
* @throws GetDataSetProfilesHttpError
|
|
341
315
|
*/
|
|
342
316
|
declare function getDataSetProfiles(dataSetId: string, query: {
|
|
343
|
-
/** Comma-separated data connection IDs. */
|
|
344
|
-
dataConnectionIds?: string[];
|
|
345
|
-
/** Page size limit. */
|
|
317
|
+
/** Comma-separated data connection IDs. */dataConnectionIds?: string[]; /** Page size limit. */
|
|
346
318
|
limit?: number;
|
|
347
|
-
page?: number;
|
|
348
|
-
/** Comma-separated fields to return in the response. */
|
|
319
|
+
page?: number; /** Comma-separated fields to return in the response. */
|
|
349
320
|
projections?: string[];
|
|
350
321
|
sort?: string[];
|
|
351
322
|
}, options?: ApiCallOptions): Promise<GetDataSetProfilesHttpResponse>;
|
package/data-sets.js
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import "./chunks/public-runtime-modules-
|
|
2
|
-
import { n as invokeFetch, t as clearApiCache } from "./chunks/invoke-fetch-
|
|
1
|
+
import "./chunks/public-runtime-modules-2KfyI2qM.js";
|
|
2
|
+
import { n as invokeFetch, t as clearApiCache } from "./chunks/invoke-fetch-DMAi6Fg3.js";
|
|
3
3
|
|
|
4
4
|
//#region src/public/rest/data-sets.ts
|
|
5
5
|
/**
|
|
@@ -116,7 +116,6 @@ const dataSetsExport = {
|
|
|
116
116
|
getDataSetProfiles,
|
|
117
117
|
clearCache
|
|
118
118
|
};
|
|
119
|
-
var data_sets_default = dataSetsExport;
|
|
120
119
|
|
|
121
120
|
//#endregion
|
|
122
|
-
export { clearCache, createDataSet,
|
|
121
|
+
export { clearCache, createDataSet, dataSetsExport as default, deleteDataSets, getDataSet, getDataSetProfiles, patchDataSet, updateDataSet };
|
package/data-sources.d.ts
CHANGED
|
@@ -1,89 +1,60 @@
|
|
|
1
|
-
import {
|
|
2
|
-
import "./chunks/invoke-fetch-
|
|
1
|
+
import { ApiCallOptions } from "./invoke-fetch-types.js";
|
|
2
|
+
import "./chunks/invoke-fetch-DFc3yzaj.js";
|
|
3
3
|
|
|
4
4
|
//#region src/public/rest/data-sources.d.ts
|
|
5
5
|
type ApiSpecResponse = {
|
|
6
|
-
/** List of properties required for the given datasource */
|
|
7
|
-
|
|
8
|
-
/** Datasource provider */
|
|
9
|
-
connectorProvider: string;
|
|
10
|
-
/** Datasource provider (i.e. connector) version */
|
|
6
|
+
/** List of properties required for the given datasource */connectionProperties: unknown; /** Datasource provider */
|
|
7
|
+
connectorProvider: string; /** Datasource provider (i.e. connector) version */
|
|
11
8
|
connectorVersion: string;
|
|
12
9
|
};
|
|
13
10
|
/**
|
|
14
11
|
* Datasource metadata
|
|
15
12
|
*/
|
|
16
13
|
type ConnectorNodesInfo = {
|
|
17
|
-
/** List of datasource IDs provided by the provider */
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
dataSourcesUpdated: boolean;
|
|
23
|
-
/** Connector provider name */
|
|
24
|
-
providerName: string;
|
|
25
|
-
/** State of the connector node */
|
|
26
|
-
state: string;
|
|
27
|
-
/** URL of connector node */
|
|
14
|
+
/** List of datasource IDs provided by the provider */cachedDataSources?: string[]; /** Contract type used to communicate with the connector (between 0 and 3) */
|
|
15
|
+
contractType: number; /** Indicates whether the datasources are up to date */
|
|
16
|
+
dataSourcesUpdated: boolean; /** Connector provider name */
|
|
17
|
+
providerName: string; /** State of the connector node */
|
|
18
|
+
state: string; /** URL of connector node */
|
|
28
19
|
url: string;
|
|
29
20
|
};
|
|
30
21
|
/**
|
|
31
22
|
* Datasource metadata
|
|
32
23
|
*/
|
|
33
24
|
type DataSourceNew = {
|
|
34
|
-
/** List of capabilities supported by the datasource */
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
/**
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
/**
|
|
43
|
-
|
|
44
|
-
/** Indicates whether the datasource is disabled */
|
|
45
|
-
disabled?: boolean;
|
|
46
|
-
/** Datasource name */
|
|
47
|
-
name: string;
|
|
48
|
-
/** Connector provider */
|
|
49
|
-
provider: string;
|
|
50
|
-
/** Provider name */
|
|
51
|
-
providerName: string;
|
|
52
|
-
/** Qri definition template */
|
|
53
|
-
qriDefinition?: QriDefinition;
|
|
54
|
-
/** UI related metadata (only present when 'includeui' is set to true in query) */
|
|
25
|
+
/** List of capabilities supported by the datasource */capabilities?: string[]; /** Override value of dataload URL (could be null) */
|
|
26
|
+
dataLoadUrlOverride?: string; /** Unique identifier of datasource */
|
|
27
|
+
dataSourceId: string; /** Datasource property name (could be null) */
|
|
28
|
+
dataSourcePropertyName?: string; /** Type of datasource */
|
|
29
|
+
dataSourceType?: string; /** Indicates whether the datasource is disabled */
|
|
30
|
+
disabled?: boolean; /** Datasource name */
|
|
31
|
+
name: string; /** Connector provider */
|
|
32
|
+
provider: string; /** Provider name */
|
|
33
|
+
providerName: string; /** Qri definition template */
|
|
34
|
+
qriDefinition?: QriDefinition; /** UI related metadata (only present when 'includeui' is set to true in query) */
|
|
55
35
|
uiInfo?: UiInfo;
|
|
56
36
|
};
|
|
57
37
|
/**
|
|
58
38
|
* Defines configuration settings for a data source.
|
|
59
39
|
*/
|
|
60
40
|
type DataSourceSettingsRequest = {
|
|
61
|
-
/** Indicates whether the data source is disabled. */
|
|
62
|
-
disabled: boolean;
|
|
41
|
+
/** Indicates whether the data source is disabled. */disabled: boolean;
|
|
63
42
|
};
|
|
64
43
|
/**
|
|
65
44
|
* Represents the current settings of a data source.
|
|
66
45
|
*/
|
|
67
46
|
type DataSourceSettingsResponse = {
|
|
68
|
-
/** Indicates whether the data source is disabled. */
|
|
69
|
-
disabled?: boolean;
|
|
47
|
+
/** Indicates whether the data source is disabled. */disabled?: boolean;
|
|
70
48
|
};
|
|
71
49
|
type DataSourcesResponseNew = {
|
|
72
|
-
/** List of connector nodes (only present when query parameter 'detail' is set to true) */
|
|
73
|
-
|
|
74
|
-
/** List of datasources metadata object */
|
|
75
|
-
dataSources: DataSourceNew[];
|
|
76
|
-
/** Time stamp of last updated */
|
|
50
|
+
/** List of connector nodes (only present when query parameter 'detail' is set to true) */connectorNodes?: ConnectorNodesInfo[]; /** List of datasources metadata object */
|
|
51
|
+
dataSources: DataSourceNew[]; /** Time stamp of last updated */
|
|
77
52
|
lastUpdated: string;
|
|
78
53
|
};
|
|
79
54
|
type PublicApiError = {
|
|
80
|
-
/** A service specific error code string */
|
|
81
|
-
|
|
82
|
-
/**
|
|
83
|
-
detail?: string;
|
|
84
|
-
/** Additional metadata associated with the error */
|
|
85
|
-
meta?: unknown;
|
|
86
|
-
/** Summary of the error */
|
|
55
|
+
/** A service specific error code string */code: string; /** Concrete detail about the error */
|
|
56
|
+
detail?: string; /** Additional metadata associated with the error */
|
|
57
|
+
meta?: unknown; /** Summary of the error */
|
|
87
58
|
title: string;
|
|
88
59
|
};
|
|
89
60
|
/**
|
|
@@ -92,23 +63,18 @@ type PublicApiError = {
|
|
|
92
63
|
type QriDefinition = {
|
|
93
64
|
connectionPart: unknown & QriTemplate;
|
|
94
65
|
itemPart?: unknown & {
|
|
95
|
-
/** Prefix of the template */
|
|
96
|
-
prefix?: string;
|
|
66
|
+
/** Prefix of the template */prefix?: string;
|
|
97
67
|
} & QriTemplate;
|
|
98
68
|
pathPart: unknown & {
|
|
99
|
-
/** Prefix of the template */
|
|
100
|
-
|
|
101
|
-
} & QriTemplate;
|
|
102
|
-
/** Qri prefix */
|
|
69
|
+
/** Prefix of the template */prefix?: string;
|
|
70
|
+
} & QriTemplate; /** Qri prefix */
|
|
103
71
|
qriPrefix: string;
|
|
104
72
|
};
|
|
105
73
|
/**
|
|
106
74
|
* Connection part of Qri template
|
|
107
75
|
*/
|
|
108
76
|
type QriTemplate = {
|
|
109
|
-
/** List of properties used in template */
|
|
110
|
-
properties: string[];
|
|
111
|
-
/** Qri template */
|
|
77
|
+
/** List of properties used in template */properties: string[]; /** Qri template */
|
|
112
78
|
template: string;
|
|
113
79
|
};
|
|
114
80
|
type ResponseErrors = {
|
|
@@ -118,21 +84,13 @@ type ResponseErrors = {
|
|
|
118
84
|
* UI related metadata (only present when 'includeui' is set to true in query)
|
|
119
85
|
*/
|
|
120
86
|
type UiInfo = {
|
|
121
|
-
/** Connect URL */
|
|
122
|
-
|
|
123
|
-
/**
|
|
124
|
-
|
|
125
|
-
/**
|
|
126
|
-
|
|
127
|
-
/**
|
|
128
|
-
iconRectUrl?: string;
|
|
129
|
-
/** Square icon URL */
|
|
130
|
-
iconSquareUrl?: string;
|
|
131
|
-
/** If support iframe */
|
|
132
|
-
iframe?: boolean;
|
|
133
|
-
/** Indicate if the datasource supports load model */
|
|
134
|
-
loadModelSupport?: string;
|
|
135
|
-
/** Select URL */
|
|
87
|
+
/** Connect URL */connectUrl?: string; /** Connector main URL */
|
|
88
|
+
connectorMainUrl?: string; /** Credentials URL */
|
|
89
|
+
credentialsUrl?: string; /** Icon URL */
|
|
90
|
+
iconRectUrl?: string; /** Square icon URL */
|
|
91
|
+
iconSquareUrl?: string; /** If support iframe */
|
|
92
|
+
iframe?: boolean; /** Indicate if the datasource supports load model */
|
|
93
|
+
loadModelSupport?: string; /** Select URL */
|
|
136
94
|
selectUrl?: string;
|
|
137
95
|
};
|
|
138
96
|
/**
|
|
@@ -151,13 +109,9 @@ type UiInfo = {
|
|
|
151
109
|
* @throws GetDataSourcesHttpError
|
|
152
110
|
*/
|
|
153
111
|
declare function getDataSources(query: {
|
|
154
|
-
/** Filtering on datasourceID, when multiple dataSourceId are set in query, last dataSourceId will be used */
|
|
155
|
-
|
|
156
|
-
/** Determines if
|
|
157
|
-
detail?: boolean;
|
|
158
|
-
/** When true, disabled datasources are also included in the response */
|
|
159
|
-
includeDisabled?: boolean;
|
|
160
|
-
/** Determines if UI info is returned */
|
|
112
|
+
/** Filtering on datasourceID, when multiple dataSourceId are set in query, last dataSourceId will be used */dataSourceId?: string; /** Determines if provider detail is returned */
|
|
113
|
+
detail?: boolean; /** When true, disabled datasources are also included in the response */
|
|
114
|
+
includeDisabled?: boolean; /** Determines if UI info is returned */
|
|
161
115
|
includeui?: boolean;
|
|
162
116
|
}, options?: ApiCallOptions): Promise<GetDataSourcesHttpResponse>;
|
|
163
117
|
type GetDataSourcesHttpResponse = {
|
|
@@ -206,21 +160,15 @@ type GetDataSourceApiSpecsHttpError = {
|
|
|
206
160
|
* @throws GetDataSourceGatewaysHttpError
|
|
207
161
|
*/
|
|
208
162
|
declare function getDataSourceGateways(dataSourceId: string, query: {
|
|
209
|
-
/** Force to get a refreshed list from backend. Cached list will be returned if not set or set to false. */
|
|
210
|
-
forceRefresh?: boolean;
|
|
163
|
+
/** Force to get a refreshed list from backend. Cached list will be returned if not set or set to false. */forceRefresh?: boolean;
|
|
211
164
|
}, options?: ApiCallOptions): Promise<GetDataSourceGatewaysHttpResponse>;
|
|
212
165
|
type GetDataSourceGatewaysHttpResponse = {
|
|
213
166
|
data: {
|
|
214
|
-
/** List of gateway ID's for given datasource ID */
|
|
215
|
-
|
|
216
|
-
|
|
217
|
-
default?: boolean;
|
|
218
|
-
/** Gateway ID */
|
|
219
|
-
id?: string;
|
|
220
|
-
/** Gateway name */
|
|
167
|
+
/** List of gateway ID's for given datasource ID */gateways?: {
|
|
168
|
+
/** Whether the gateway is default */default?: boolean; /** Gateway ID */
|
|
169
|
+
id?: string; /** Gateway name */
|
|
221
170
|
name?: string;
|
|
222
|
-
}[];
|
|
223
|
-
/** Time stamp when the gateways data were refreshed */
|
|
171
|
+
}[]; /** Time stamp when the gateways data were refreshed */
|
|
224
172
|
refreshedAt?: string;
|
|
225
173
|
};
|
|
226
174
|
headers: Headers;
|
package/data-sources.js
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import "./chunks/public-runtime-modules-
|
|
2
|
-
import { n as invokeFetch, t as clearApiCache } from "./chunks/invoke-fetch-
|
|
1
|
+
import "./chunks/public-runtime-modules-2KfyI2qM.js";
|
|
2
|
+
import { n as invokeFetch, t as clearApiCache } from "./chunks/invoke-fetch-DMAi6Fg3.js";
|
|
3
3
|
|
|
4
4
|
//#region src/public/rest/data-sources.ts
|
|
5
5
|
/**
|
|
@@ -118,7 +118,6 @@ const dataSourcesExport = {
|
|
|
118
118
|
putDataSourceSettings,
|
|
119
119
|
clearCache
|
|
120
120
|
};
|
|
121
|
-
var data_sources_default = dataSourcesExport;
|
|
122
121
|
|
|
123
122
|
//#endregion
|
|
124
|
-
export { clearCache,
|
|
123
|
+
export { clearCache, dataSourcesExport as default, getDataSourceApiSpecs, getDataSourceGateways, getDataSourceSettings, getDataSources, putDataSourceSettings };
|