@qlik/api 1.39.0 → 1.40.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/chunks/{direct-access-agents-CGxApxBP.d.ts → direct-access-agents-BbSiWlMD.d.ts} +74 -1
- package/chunks/invoke-fetch-B-ZucHu9.js +1 -1
- package/chunks/{ml-gl8COKfn.d.ts → ml-C80TkK1J.d.ts} +32 -0
- package/chunks/{qix-x9gZqE4P.d.ts → qix-Cc6k8Gz2.d.ts} +1 -1
- package/chunks/{reloads-B_U6GYDf.d.ts → reloads-3XgvVnbq.d.ts} +3 -3
- package/chunks/{sharing-tasks-BiTNvcFe.d.ts → sharing-tasks-BMDAjWTj.d.ts} +203 -2
- package/chunks/{spaces-yzYYGUw8.d.ts → spaces-DZI6zKZi.d.ts} +1 -5
- package/chunks/{tenants-BB6W-Hlf.d.ts → tenants-BDH4DmcO.d.ts} +2 -0
- package/direct-access-agents.d.ts +2 -2
- package/direct-access-agents.js +42 -1
- package/index.d.ts +7 -7
- package/index.js +9 -1
- package/ml.d.ts +1 -1
- package/package.json +2 -2
- package/qix.d.ts +1 -1
- package/reloads.d.ts +1 -1
- package/sharing-tasks.d.ts +2 -2
- package/sharing-tasks.js +62 -1
- package/spaces.d.ts +1 -1
- package/tenants.d.ts +1 -1
- package/website/assets/navigation.js +1 -1
- package/website/assets/search.js +1 -1
- package/website/functions/direct-access-agents.getDirectAccessAgentConnectorCustomDataTypeMappings.html +5 -0
- package/website/functions/direct-access-agents.putDirectAccessAgentConnectorCustomDataTypeMappings.html +6 -0
- package/website/functions/sharing-tasks.getSharingTaskExecution.html +7 -0
- package/website/functions/sharing-tasks.getSharingTaskExecutionFile.html +8 -0
- package/website/functions/sharing-tasks.getSharingTaskExecutions.html +11 -0
- package/website/functions/spaces.getSpaceAssignments.html +2 -4
- package/website/interfaces/direct-access-agents.DirectAccessAgentsAPI.html +50 -30
- package/website/interfaces/qix.GenericObject.html +1 -1
- package/website/interfaces/sharing-tasks.SharingTasksAPI.html +53 -12
- package/website/interfaces/spaces.SpacesAPI.html +4 -6
- package/website/modules/direct-access-agents.html +1 -1
- package/website/modules/sharing-tasks.html +1 -1
- package/website/types/direct-access-agents.GetDirectAccessAgentConnectorCustomDataTypeMappingsHttpError.html +4 -0
- package/website/types/direct-access-agents.GetDirectAccessAgentConnectorCustomDataTypeMappingsHttpResponse.html +4 -0
- package/website/types/direct-access-agents.OdbcCustomDataType.html +11 -0
- package/website/types/direct-access-agents.OdbcCustomDataTypeResponse.html +3 -0
- package/website/types/direct-access-agents.PutDirectAccessAgentConnectorCustomDataTypeMappingsHttpError.html +4 -0
- package/website/types/direct-access-agents.PutDirectAccessAgentConnectorCustomDataTypeMappingsHttpResponse.html +4 -0
- package/website/types/direct-access-agents.UpdateOdbcCustomTypeMappingsRequest.html +2 -0
- package/website/types/ml.ModelMetricsTimeseries.html +35 -3
- package/website/types/qix.NativeGenericObjectFunctions.html +1 -1
- package/website/types/qix.RpcObject.html +1 -1
- package/website/types/reloads.Reload.html +1 -1
- package/website/types/reloads.ReloadRequest.html +1 -1
- package/website/types/reloads.Weight.html +1 -1
- package/website/types/sharing-tasks.GetSharingTaskExecutionFileHttpError.html +4 -0
- package/website/types/sharing-tasks.GetSharingTaskExecutionFileHttpResponse.html +4 -0
- package/website/types/sharing-tasks.GetSharingTaskExecutionHttpError.html +4 -0
- package/website/types/sharing-tasks.GetSharingTaskExecutionHttpResponse.html +4 -0
- package/website/types/sharing-tasks.GetSharingTaskExecutionsHttpError.html +4 -0
- package/website/types/sharing-tasks.GetSharingTaskExecutionsHttpResponse.html +6 -0
- package/website/types/sharing-tasks.SharingExecutionError.html +7 -0
- package/website/types/sharing-tasks.SharingExecutionErrors.html +1 -0
- package/website/types/sharing-tasks.SharingExecutionFile.html +9 -0
- package/website/types/sharing-tasks.SharingExecutionListResponse.html +2 -0
- package/website/types/sharing-tasks.SharingExecutionPersist.html +52 -0
- package/website/types/sharing-tasks.SharingExecutionResponse.html +1 -0
- package/website/types/sharing-tasks.TargetUser.html +10 -0
- package/website/types/spaces.AssignmentType.html +1 -1
- package/website/types/tenants.Tenant.html +4 -2
- package/website/variables/qix.QIX_SCHEMA_VERSION.html +1 -1
|
@@ -56,6 +56,22 @@ type ErrorResponse = {
|
|
|
56
56
|
readonly hasErrors?: boolean;
|
|
57
57
|
traceId?: string;
|
|
58
58
|
};
|
|
59
|
+
type OdbcCustomDataType = {
|
|
60
|
+
/** The IsBit property in the ODBC custom data type mapping file. */
|
|
61
|
+
bit?: boolean;
|
|
62
|
+
/** The Identifier property in the ODBC custom data type mapping file. */
|
|
63
|
+
id: string;
|
|
64
|
+
/** The NativeDataType property in the ODBC custom data type mapping file. */
|
|
65
|
+
nativeDataType: string;
|
|
66
|
+
/** The QlikDataType property in the ODBC custom data type mapping file. */
|
|
67
|
+
qlikDataType: string;
|
|
68
|
+
/** The Size property in the ODBC custom data type mapping file. */
|
|
69
|
+
size?: number;
|
|
70
|
+
};
|
|
71
|
+
type OdbcCustomDataTypeResponse = {
|
|
72
|
+
errorMessage?: ErrorResponse;
|
|
73
|
+
result?: OdbcCustomDataType[];
|
|
74
|
+
};
|
|
59
75
|
type Operation = {
|
|
60
76
|
op: "add" | "replace" | "remove";
|
|
61
77
|
path: "AGENT_LOG_LEVEL" | "AGENT_HEALTH_FAIL_MINUTES_LIMIT" | "AGENT_LOG_OPTIONS" | "EXTEND_FIRST_REQUEST_TIMEOUT" | "RELOAD_CACHE_MEMORY_MB" | "DCAAS_LOG_LEVEL" | "ODBC_LOG_LEVEL" | "ODBC_MAX_PROCESS_COUNT" | "ODBC_PROCESS_ISOLATION_MODE" | "ODBC_RELOAD_SESSION_LIFE" | "SAPBW_LOG_LEVEL" | "SAPBW_MAX_PROCESS_COUNT" | "SAPBW_PROCESS_ISOLATION_MODE" | "SAPSQL_LOG_LEVEL" | "SAPSQL_MAX_PROCESS_COUNT" | "SAPSQL_PROCESS_ISOLATION_MODE" | "SAPPACKAGE_LOG_LEVEL" | "SAPPACKAGE_MAX_PROCESS_COUNT" | "SAPPACKAGE_PROCESS_ISOLATION_MODE" | "FILE_LOG_LEVEL" | "FILE_MAX_PROCESS_COUNT" | "FILE_PROCESS_ISOLATION_MODE" | "REST_LOG_LEVEL" | "REST_MAX_PROCESS_COUNT" | "REST_PROCESS_ISOLATION_MODE" | "ODBC_TABLES_LIMIT_FOR_GENERICODBC" | "OVERRIDE_CHUNKS_CACHE_DIR" | "CHUNK_RECOVERY_RESUME_THRESHOLD_MINUTES";
|
|
@@ -78,6 +94,9 @@ type PatchOperationValidationResult = {
|
|
|
78
94
|
type UpdateConfigurationFlatFileRequest = {
|
|
79
95
|
contentsToSave?: string[];
|
|
80
96
|
};
|
|
97
|
+
type UpdateOdbcCustomTypeMappingsRequest = {
|
|
98
|
+
odbcCustomDataTypes?: OdbcCustomDataType[];
|
|
99
|
+
};
|
|
81
100
|
/**
|
|
82
101
|
* Restarts the specified agent. If a reload is in `RELOADING` status the `restart` action will be ignored. Use `force-restart` to restart the agent even if a reload is in `RELOADING` status. Requestor must be assigned the `TenantAdmin` role and needs to be either a Gateway's space owner or a member in the Gateway's space with `Can Consume Data` role. Available in Direct Access Gateway V1.7.2+.
|
|
83
102
|
*
|
|
@@ -178,6 +197,43 @@ type GetDirectAccessAgentConnectorFilesWithoutQueryHttpError = {
|
|
|
178
197
|
headers: Headers;
|
|
179
198
|
status: 403 | 404;
|
|
180
199
|
};
|
|
200
|
+
/**
|
|
201
|
+
* Retrieves custom data type mapping settings for the Generic ODBC Connector. Requestor must be assigned the `TenantAdmin` role. Available in Direct Access Gateway V1.7.5+.
|
|
202
|
+
*
|
|
203
|
+
* @param agentId The agent ID.
|
|
204
|
+
* @param connectorType The connector type. Must be `odbc-connector` for this endpoint.
|
|
205
|
+
* @throws GetDirectAccessAgentConnectorCustomDataTypeMappingsHttpError
|
|
206
|
+
*/
|
|
207
|
+
declare function getDirectAccessAgentConnectorCustomDataTypeMappings(agentId: string, connectorType: string, options?: ApiCallOptions): Promise<GetDirectAccessAgentConnectorCustomDataTypeMappingsHttpResponse>;
|
|
208
|
+
type GetDirectAccessAgentConnectorCustomDataTypeMappingsHttpResponse = {
|
|
209
|
+
data: OdbcCustomDataTypeResponse;
|
|
210
|
+
headers: Headers;
|
|
211
|
+
status: 200;
|
|
212
|
+
};
|
|
213
|
+
type GetDirectAccessAgentConnectorCustomDataTypeMappingsHttpError = {
|
|
214
|
+
data: ErrorResponse;
|
|
215
|
+
headers: Headers;
|
|
216
|
+
status: 404;
|
|
217
|
+
};
|
|
218
|
+
/**
|
|
219
|
+
* Completely replaces the contents of the custom data type mapping configuration file for the Generic ODBC connector. Partial updates are not supported. There are property naming differences between the API and the file contents. Use the API property format when making changes. Requestor must be assigned the `TenantAdmin` role. Available in Direct Access Gateway V1.7.5+.
|
|
220
|
+
*
|
|
221
|
+
* @param agentId The agent ID.
|
|
222
|
+
* @param connectorType The connector type. Must be `odbc-connector` for this endpoint.
|
|
223
|
+
* @param body an object with the body content
|
|
224
|
+
* @throws PutDirectAccessAgentConnectorCustomDataTypeMappingsHttpError
|
|
225
|
+
*/
|
|
226
|
+
declare function putDirectAccessAgentConnectorCustomDataTypeMappings(agentId: string, connectorType: string, body: UpdateOdbcCustomTypeMappingsRequest, options?: ApiCallOptions): Promise<PutDirectAccessAgentConnectorCustomDataTypeMappingsHttpResponse>;
|
|
227
|
+
type PutDirectAccessAgentConnectorCustomDataTypeMappingsHttpResponse = {
|
|
228
|
+
data: void;
|
|
229
|
+
headers: Headers;
|
|
230
|
+
status: 204;
|
|
231
|
+
};
|
|
232
|
+
type PutDirectAccessAgentConnectorCustomDataTypeMappingsHttpError = {
|
|
233
|
+
data: ErrorResponse;
|
|
234
|
+
headers: Headers;
|
|
235
|
+
status: 400 | 404 | 409;
|
|
236
|
+
};
|
|
181
237
|
/**
|
|
182
238
|
* Retrieves the configuration items in the flat file for the specified connector. Requestor must be assigned the `TenantAdmin` role and needs to be either a Gateway's space owner or a member in the Gateway's space with `Can Consume Data` role. Available in Direct Access Gateway V1.7.4+.
|
|
183
239
|
*
|
|
@@ -284,6 +340,23 @@ interface DirectAccessAgentsAPI {
|
|
|
284
340
|
* @throws GetDirectAccessAgentConnectorFilesWithoutQueryHttpError
|
|
285
341
|
*/
|
|
286
342
|
getDirectAccessAgentConnectorFilesWithoutQuery: typeof getDirectAccessAgentConnectorFilesWithoutQuery;
|
|
343
|
+
/**
|
|
344
|
+
* Retrieves custom data type mapping settings for the Generic ODBC Connector. Requestor must be assigned the `TenantAdmin` role. Available in Direct Access Gateway V1.7.5+.
|
|
345
|
+
*
|
|
346
|
+
* @param agentId The agent ID.
|
|
347
|
+
* @param connectorType The connector type. Must be `odbc-connector` for this endpoint.
|
|
348
|
+
* @throws GetDirectAccessAgentConnectorCustomDataTypeMappingsHttpError
|
|
349
|
+
*/
|
|
350
|
+
getDirectAccessAgentConnectorCustomDataTypeMappings: typeof getDirectAccessAgentConnectorCustomDataTypeMappings;
|
|
351
|
+
/**
|
|
352
|
+
* Completely replaces the contents of the custom data type mapping configuration file for the Generic ODBC connector. Partial updates are not supported. There are property naming differences between the API and the file contents. Use the API property format when making changes. Requestor must be assigned the `TenantAdmin` role. Available in Direct Access Gateway V1.7.5+.
|
|
353
|
+
*
|
|
354
|
+
* @param agentId The agent ID.
|
|
355
|
+
* @param connectorType The connector type. Must be `odbc-connector` for this endpoint.
|
|
356
|
+
* @param body an object with the body content
|
|
357
|
+
* @throws PutDirectAccessAgentConnectorCustomDataTypeMappingsHttpError
|
|
358
|
+
*/
|
|
359
|
+
putDirectAccessAgentConnectorCustomDataTypeMappings: typeof putDirectAccessAgentConnectorCustomDataTypeMappings;
|
|
287
360
|
/**
|
|
288
361
|
* Retrieves the configuration items in the flat file for the specified connector. Requestor must be assigned the `TenantAdmin` role and needs to be either a Gateway's space owner or a member in the Gateway's space with `Can Consume Data` role. Available in Direct Access Gateway V1.7.4+.
|
|
289
362
|
*
|
|
@@ -324,4 +397,4 @@ interface DirectAccessAgentsAPI {
|
|
|
324
397
|
*/
|
|
325
398
|
declare const directAccessAgentsExport: DirectAccessAgentsAPI;
|
|
326
399
|
//#endregion
|
|
327
|
-
export { ConfigurationLineBase, ConfigurationLineNumeric, ConfigurationLineString, ConfigurationResponse, ConnectorFlatFileConfigurationResponse, ConnectorSettings, DirectAccessAgentsAPI, ErrorMessage, ErrorResponse, GetDirectAccessAgentConfigurationHttpError, GetDirectAccessAgentConfigurationHttpResponse, GetDirectAccessAgentConnectorFileHttpError, GetDirectAccessAgentConnectorFileHttpResponse, GetDirectAccessAgentConnectorFilesHttpError, GetDirectAccessAgentConnectorFilesHttpResponse, GetDirectAccessAgentConnectorFilesWithoutQueryHttpError, GetDirectAccessAgentConnectorFilesWithoutQueryHttpResponse, Operation, PatchDirectAccessAgentConfiguration204HttpResponse, PatchDirectAccessAgentConfiguration207HttpResponse, PatchDirectAccessAgentConfigurationHttpError, PatchDirectAccessAgentConfigurationHttpResponse, PatchOperationResponse, PatchOperationValidationResult, RestartDirectAccessAgentHttpError, RestartDirectAccessAgentHttpResponse, UpdateConfigurationFlatFileRequest, UpdateDirectAccessAgentConnectorFileHttpError, UpdateDirectAccessAgentConnectorFileHttpResponse, UpdateDirectAccessAgentConnectorFileWithoutQueryHttpError, UpdateDirectAccessAgentConnectorFileWithoutQueryHttpResponse, clearCache, directAccessAgentsExport, getDirectAccessAgentConfiguration, getDirectAccessAgentConnectorFile, getDirectAccessAgentConnectorFiles, getDirectAccessAgentConnectorFilesWithoutQuery, patchDirectAccessAgentConfiguration, restartDirectAccessAgent, updateDirectAccessAgentConnectorFile, updateDirectAccessAgentConnectorFileWithoutQuery };
|
|
400
|
+
export { ConfigurationLineBase, ConfigurationLineNumeric, ConfigurationLineString, ConfigurationResponse, ConnectorFlatFileConfigurationResponse, ConnectorSettings, DirectAccessAgentsAPI, ErrorMessage, ErrorResponse, GetDirectAccessAgentConfigurationHttpError, GetDirectAccessAgentConfigurationHttpResponse, GetDirectAccessAgentConnectorCustomDataTypeMappingsHttpError, GetDirectAccessAgentConnectorCustomDataTypeMappingsHttpResponse, GetDirectAccessAgentConnectorFileHttpError, GetDirectAccessAgentConnectorFileHttpResponse, GetDirectAccessAgentConnectorFilesHttpError, GetDirectAccessAgentConnectorFilesHttpResponse, GetDirectAccessAgentConnectorFilesWithoutQueryHttpError, GetDirectAccessAgentConnectorFilesWithoutQueryHttpResponse, OdbcCustomDataType, OdbcCustomDataTypeResponse, Operation, PatchDirectAccessAgentConfiguration204HttpResponse, PatchDirectAccessAgentConfiguration207HttpResponse, PatchDirectAccessAgentConfigurationHttpError, PatchDirectAccessAgentConfigurationHttpResponse, PatchOperationResponse, PatchOperationValidationResult, PutDirectAccessAgentConnectorCustomDataTypeMappingsHttpError, PutDirectAccessAgentConnectorCustomDataTypeMappingsHttpResponse, RestartDirectAccessAgentHttpError, RestartDirectAccessAgentHttpResponse, UpdateConfigurationFlatFileRequest, UpdateDirectAccessAgentConnectorFileHttpError, UpdateDirectAccessAgentConnectorFileHttpResponse, UpdateDirectAccessAgentConnectorFileWithoutQueryHttpError, UpdateDirectAccessAgentConnectorFileWithoutQueryHttpResponse, UpdateOdbcCustomTypeMappingsRequest, clearCache, directAccessAgentsExport, getDirectAccessAgentConfiguration, getDirectAccessAgentConnectorCustomDataTypeMappings, getDirectAccessAgentConnectorFile, getDirectAccessAgentConnectorFiles, getDirectAccessAgentConnectorFilesWithoutQuery, patchDirectAccessAgentConfiguration, putDirectAccessAgentConnectorCustomDataTypeMappings, restartDirectAccessAgent, updateDirectAccessAgentConnectorFile, updateDirectAccessAgentConnectorFileWithoutQuery };
|
|
@@ -2,7 +2,7 @@ import { isBrowser } from "./utils-qEQ6sEXX.js";
|
|
|
2
2
|
import { getInvokeFetchRuntimeModule } from "./public-runtime-modules-lsJEDVxt.js";
|
|
3
3
|
|
|
4
4
|
//#region src/public/invoke-fetch.ts
|
|
5
|
-
const defaultUserAgent = "qlik-api/1.
|
|
5
|
+
const defaultUserAgent = "qlik-api/1.40.0";
|
|
6
6
|
async function invokeFetch(api, props) {
|
|
7
7
|
const hostConfig = props.options?.hostConfig;
|
|
8
8
|
let userAgent;
|
|
@@ -1198,10 +1198,42 @@ type ModelMetricsRegression = {
|
|
|
1198
1198
|
* Timeseries metrics experiments valid for timeseries forecasting.
|
|
1199
1199
|
*/
|
|
1200
1200
|
type ModelMetricsTimeseries = {
|
|
1201
|
+
/** Mean absolute error (training data) */
|
|
1202
|
+
mae?: number;
|
|
1203
|
+
/** Mean absolute error (test data) */
|
|
1204
|
+
maeTest?: number;
|
|
1201
1205
|
/** Mean absolute percentage error (training data) */
|
|
1202
1206
|
mape?: number;
|
|
1203
1207
|
/** Mean absolute percentage error (test data) */
|
|
1204
1208
|
mapeTest?: number;
|
|
1209
|
+
/** Mean absolute scaled error (training data) */
|
|
1210
|
+
mase?: number;
|
|
1211
|
+
/** Mean absolute scaled error (test data) */
|
|
1212
|
+
maseTest?: number;
|
|
1213
|
+
/** Median absolute percentage error (training data) */
|
|
1214
|
+
mdape?: number;
|
|
1215
|
+
/** Median absolute percentage error (test data) */
|
|
1216
|
+
mdapeTest?: number;
|
|
1217
|
+
/** Median root mean squared error (training data) */
|
|
1218
|
+
mdnrmse?: number;
|
|
1219
|
+
/** Median root mean squared error (test data) */
|
|
1220
|
+
mdnrmseTest?: number;
|
|
1221
|
+
/** Mean root mean squared error (training data) */
|
|
1222
|
+
mnrmse?: number;
|
|
1223
|
+
/** Mean root mean squared error (test data) */
|
|
1224
|
+
mnrmseTest?: number;
|
|
1225
|
+
/** Root mean squared error (training data) */
|
|
1226
|
+
rmse?: number;
|
|
1227
|
+
/** Root mean squared error (test data) */
|
|
1228
|
+
rmseTest?: number;
|
|
1229
|
+
/** Symmetric mean absolute percentage error (training data) */
|
|
1230
|
+
smape?: number;
|
|
1231
|
+
/** Symmetric mean absolute percentage error (test data) */
|
|
1232
|
+
smapeTest?: number;
|
|
1233
|
+
/** Weighted mean absolute percentage error (training data) */
|
|
1234
|
+
wmape?: number;
|
|
1235
|
+
/** Weighted mean absolute percentage error (test data) */
|
|
1236
|
+
wmapeTest?: number;
|
|
1205
1237
|
};
|
|
1206
1238
|
/**
|
|
1207
1239
|
* Model state. These are the state of the model in relation to
|
|
@@ -66,7 +66,7 @@ type Reload = {
|
|
|
66
66
|
type: Type;
|
|
67
67
|
/** The ID of the user who created the reload. */
|
|
68
68
|
userId: string;
|
|
69
|
-
/** The weight of the reload for the same tenant. The higher the weight, the sooner the reload will be scheduled relative to other reloads for the same tenant. The personal app will be always set as 1
|
|
69
|
+
/** The weight of the reload for the same tenant. The higher the weight, the sooner the reload will be scheduled relative to other reloads for the same tenant. The personal app will be always set as 1. */
|
|
70
70
|
weight?: Weight;
|
|
71
71
|
};
|
|
72
72
|
type ReloadLinks = {
|
|
@@ -79,7 +79,7 @@ type ReloadRequest = {
|
|
|
79
79
|
partial?: boolean;
|
|
80
80
|
/** The variables to be used in the load script. */
|
|
81
81
|
variables?: Record<string, string>;
|
|
82
|
-
/** The weight of the reload for the same tenant. The higher the weight, the sooner the reload will be scheduled relative to other reloads for the same tenant. The personal app will be always set as 1
|
|
82
|
+
/** The weight of the reload for the same tenant. The higher the weight, the sooner the reload will be scheduled relative to other reloads for the same tenant. The personal app will be always set as 1. */
|
|
83
83
|
weight?: Weight;
|
|
84
84
|
};
|
|
85
85
|
type Reloads = {
|
|
@@ -103,7 +103,7 @@ type Status = "QUEUED" | "RELOADING" | "CANCELING" | "SUCCEEDED" | "FAILED" | "C
|
|
|
103
103
|
*/
|
|
104
104
|
type Type = "hub" | "external" | "chronos" | "automations" | "data-refresh" | "choreographer";
|
|
105
105
|
/**
|
|
106
|
-
* The weight of the reload for the same tenant. The higher the weight, the sooner the reload will be scheduled relative to other reloads for the same tenant. The personal app will be always set as 1
|
|
106
|
+
* The weight of the reload for the same tenant. The higher the weight, the sooner the reload will be scheduled relative to other reloads for the same tenant. The personal app will be always set as 1.
|
|
107
107
|
*/
|
|
108
108
|
type Weight = number;
|
|
109
109
|
/**
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { ApiCallOptions } from "./auth-types-BlCWK0FP.js";
|
|
1
|
+
import { ApiCallOptions, DownloadableBlob } from "./auth-types-BlCWK0FP.js";
|
|
2
2
|
|
|
3
3
|
//#region src/public/rest/sharing-tasks.d.ts
|
|
4
4
|
type APISettingsUpload = {
|
|
@@ -216,6 +216,88 @@ type Self = {
|
|
|
216
216
|
type SharingActionsTriggerCreateRequest = {
|
|
217
217
|
sharingTaskID: string;
|
|
218
218
|
};
|
|
219
|
+
type SharingExecutionError = {
|
|
220
|
+
/** Error code specific to sharing service. */
|
|
221
|
+
readonly code?: string;
|
|
222
|
+
/** Error cause. */
|
|
223
|
+
readonly detail?: string;
|
|
224
|
+
/** Error title. */
|
|
225
|
+
readonly title?: string;
|
|
226
|
+
};
|
|
227
|
+
type SharingExecutionErrors = SharingExecutionError[];
|
|
228
|
+
type SharingExecutionFile = {
|
|
229
|
+
fileAlias?: string;
|
|
230
|
+
fileID?: string;
|
|
231
|
+
tempContentsLocation?: string;
|
|
232
|
+
/** identify the source task template */
|
|
233
|
+
readonly templateId?: string;
|
|
234
|
+
type?: "image" | "pdf" | "pptx" | "xlsx" | "html";
|
|
235
|
+
/** userId associated with the file */
|
|
236
|
+
readonly userId?: string;
|
|
237
|
+
};
|
|
238
|
+
type SharingExecutionListResponse = StandardListResponseProps & {
|
|
239
|
+
/** Gets a list of sharing-executions. */
|
|
240
|
+
executions?: SharingExecutionResponse[];
|
|
241
|
+
links?: ListLinks;
|
|
242
|
+
};
|
|
243
|
+
type SharingExecutionPersist = {
|
|
244
|
+
/** appId associated to sharing task execution */
|
|
245
|
+
readonly appId?: string;
|
|
246
|
+
/** @deprecated
|
|
247
|
+
* The ID of a filter in a reporting request */
|
|
248
|
+
readonly bookmarkId?: string;
|
|
249
|
+
readonly bookmarkIds?: string[];
|
|
250
|
+
/** Total count of cancelled reports in this execution */
|
|
251
|
+
readonly cancelledCount?: number;
|
|
252
|
+
/** Timestamp of execution cancel */
|
|
253
|
+
readonly cancelledTime?: string;
|
|
254
|
+
/** Timestamp of execution successful stop */
|
|
255
|
+
readonly endTime?: string;
|
|
256
|
+
errors?: SharingExecutionErrors;
|
|
257
|
+
/** eventID of the trigger NATS event */
|
|
258
|
+
readonly eventID?: string;
|
|
259
|
+
/** eventTime of the trigger NATS event */
|
|
260
|
+
readonly eventTime?: string;
|
|
261
|
+
/** Total count of failed reports in this execution */
|
|
262
|
+
readonly failedCount?: number;
|
|
263
|
+
/** Timestamp of execution stop */
|
|
264
|
+
readonly failedTime?: string;
|
|
265
|
+
/** Total count of failed uploaded reports in this execution */
|
|
266
|
+
readonly failedUploadCount?: number;
|
|
267
|
+
readonly files?: SharingExecutionFile[];
|
|
268
|
+
/** Gets the execution identifier. */
|
|
269
|
+
readonly id?: string;
|
|
270
|
+
/** Owner of the execution */
|
|
271
|
+
readonly ownerId?: string;
|
|
272
|
+
/** If this execution was triggered by an app reload. This will contain the reloadId from reloads service. Otherwise it is empty or omitted. */
|
|
273
|
+
readonly reloadId?: string;
|
|
274
|
+
/** If this execution was triggered by an app reload. This will contain the reload time to compare with reporting service when the report is requested. */
|
|
275
|
+
readonly reloadTime?: string;
|
|
276
|
+
/** ID for the sharing task that this execution references */
|
|
277
|
+
readonly sharingTaskID?: string;
|
|
278
|
+
/** Timestamp of execution start */
|
|
279
|
+
readonly startTime?: string;
|
|
280
|
+
/** Status of the task execution */
|
|
281
|
+
readonly status?: "initialized" | "in-progress" | "successful" | "failed" | "cancelled" | "invalid" | "presuccessful" | "cancelling";
|
|
282
|
+
/** Total count of successfully generated reports in this execution */
|
|
283
|
+
readonly successCount?: number;
|
|
284
|
+
/** Total count of successfully uploaded reports in this execution */
|
|
285
|
+
readonly successUploadCount?: number;
|
|
286
|
+
/** User that this execution is targeting as a recipient */
|
|
287
|
+
targetUser?: TargetUser;
|
|
288
|
+
/** The tenant that this execution belongs to */
|
|
289
|
+
readonly tenantId?: string;
|
|
290
|
+
/** Total count of reports in this execution */
|
|
291
|
+
readonly totalCount?: number;
|
|
292
|
+
/** Total count of reports to be uploaded in this execution */
|
|
293
|
+
readonly totalUploadCount?: number;
|
|
294
|
+
/** Workflow that the execution belongs to. Note that in a multi-recipient context we can have multiple executions (one per recipient) that share the same unique workflow. */
|
|
295
|
+
readonly workflowID?: string;
|
|
296
|
+
};
|
|
297
|
+
type SharingExecutionResponse = SharingExecutionPersist & {
|
|
298
|
+
fileLocations?: string[];
|
|
299
|
+
links?: Links;
|
|
300
|
+
};
|
|
219
301
|
type SharingSettings = {
|
|
220
302
|
/** true if report-subscription feature is enabled for this tenant */
|
|
221
303
|
"enable-report-subscription": boolean;
|
|
@@ -574,6 +656,20 @@ type StoryTemplate = {
|
|
|
574
656
|
/** ID of story */
|
|
575
657
|
storyId?: string;
|
|
576
658
|
};
|
|
659
|
+
/**
|
|
660
|
+
* User that this execution is targeting as a recipient
|
|
661
|
+
*/
|
|
662
|
+
type TargetUser = {
|
|
663
|
+
/** @deprecated */
|
|
664
|
+
filterName?: string;
|
|
665
|
+
filterNames?: string[];
|
|
666
|
+
/** timezone for the timestamp on the attached file name */
|
|
667
|
+
timezone?: string;
|
|
668
|
+
/** type of user eg email, userId, groupId */
|
|
669
|
+
type?: string;
|
|
670
|
+
/** contains the value of user type e.g. abc@xyz.com, 213efewr3 */
|
|
671
|
+
value?: string;
|
|
672
|
+
};
|
|
577
673
|
type TaskError = {
|
|
578
674
|
/** Timestamp for the creation of the error */
|
|
579
675
|
timestamp?: string;
|
|
@@ -863,6 +959,84 @@ type CancelSharingTaskHttpError = {
|
|
|
863
959
|
headers: Headers;
|
|
864
960
|
status: number;
|
|
865
961
|
};
|
|
962
|
+
/**
|
|
963
|
+
* Lists executions for the specified sharing task.
|
|
964
|
+
*
|
|
965
|
+
* @param taskId The sharing task identifier.
|
|
966
|
+
* @param query an object with query parameters
|
|
967
|
+
* @throws GetSharingTaskExecutionsHttpError
|
|
968
|
+
*/
|
|
969
|
+
declare function getSharingTaskExecutions(taskId: string, query: {
|
|
970
|
+
/** Limit the returned result set */
|
|
971
|
+
limit?: number;
|
|
972
|
+
/** The cursor to the next page of data. Only one of next or previous may be specified. */
|
|
973
|
+
next?: string;
|
|
974
|
+
/** Offset for pagination - how many elements to skip */
|
|
975
|
+
offset?: number;
|
|
976
|
+
/** The cursor to the previous page of data. Only one of next or previous may be specified. */
|
|
977
|
+
prev?: string;
|
|
978
|
+
/** Sort the returned result set by the specified field */
|
|
979
|
+
sort?: ("starttime" | "-starttime" | "+starttime")[];
|
|
980
|
+
/** Specifies a filter for a particular field and value of an execution */
|
|
981
|
+
status?: "successful" | "failed";
|
|
982
|
+
}, options?: ApiCallOptions): Promise<GetSharingTaskExecutionsHttpResponse>;
|
|
983
|
+
type GetSharingTaskExecutionsHttpResponse = {
|
|
984
|
+
data: SharingExecutionListResponse;
|
|
985
|
+
headers: Headers;
|
|
986
|
+
status: 200;
|
|
987
|
+
prev?: (options?: ApiCallOptions) => Promise<GetSharingTaskExecutionsHttpResponse>;
|
|
988
|
+
next?: (options?: ApiCallOptions) => Promise<GetSharingTaskExecutionsHttpResponse>;
|
|
989
|
+
};
|
|
990
|
+
type GetSharingTaskExecutionsHttpError = {
|
|
991
|
+
data: Errors;
|
|
992
|
+
headers: Headers;
|
|
993
|
+
status: number;
|
|
994
|
+
};
|
|
995
|
+
/**
|
|
996
|
+
* Retrieves a specific sharing task execution.
|
|
997
|
+
*
|
|
998
|
+
* @param taskId The sharing task identifier.
|
|
999
|
+
* @param executionId The execution identifier. If value is "latest", the latest execution will be returned
|
|
1000
|
+
* @param query an object with query parameters
|
|
1001
|
+
* @throws GetSharingTaskExecutionHttpError
|
|
1002
|
+
*/
|
|
1003
|
+
declare function getSharingTaskExecution(taskId: string, executionId: string, query: {
|
|
1004
|
+
/** Filter by status. If not present then no filtering is done on the status. This is only relevant when requesting latest execution. */
|
|
1005
|
+
status?: "successful" | "failed" | "cancelled";
|
|
1006
|
+
}, options?: ApiCallOptions): Promise<GetSharingTaskExecutionHttpResponse>;
|
|
1007
|
+
type GetSharingTaskExecutionHttpResponse = {
|
|
1008
|
+
data: SharingExecutionResponse;
|
|
1009
|
+
headers: Headers;
|
|
1010
|
+
status: 200;
|
|
1011
|
+
};
|
|
1012
|
+
type GetSharingTaskExecutionHttpError = {
|
|
1013
|
+
data: Errors;
|
|
1014
|
+
headers: Headers;
|
|
1015
|
+
status: number;
|
|
1016
|
+
};
|
|
1017
|
+
/**
|
|
1018
|
+
* Retrieves the file content for the requested execution and file type.
|
|
1019
|
+
*
|
|
1020
|
+
* @param taskId The sharing task identifier.
|
|
1021
|
+
* @param executionId The execution identifier.
|
|
1022
|
+
* @param fileAlias The execution identifier. If value is "latest", the latest execution will be returned
|
|
1023
|
+
* @param query an object with query parameters
|
|
1024
|
+
* @throws GetSharingTaskExecutionFileHttpError
|
|
1025
|
+
*/
|
|
1026
|
+
declare function getSharingTaskExecutionFile(taskId: string, executionId: string, fileAlias: string, query: {
|
|
1027
|
+
/** Filter by status. If not present then no filtering is done on the status. This is only relevant when requesting latest execution. */
|
|
1028
|
+
status?: "successful" | "failed" | "cancelled";
|
|
1029
|
+
}, options?: ApiCallOptions): Promise<GetSharingTaskExecutionFileHttpResponse>;
|
|
1030
|
+
type GetSharingTaskExecutionFileHttpResponse = {
|
|
1031
|
+
data: DownloadableBlob;
|
|
1032
|
+
headers: Headers;
|
|
1033
|
+
status: 200;
|
|
1034
|
+
};
|
|
1035
|
+
type GetSharingTaskExecutionFileHttpError = {
|
|
1036
|
+
data: Errors;
|
|
1037
|
+
headers: Headers;
|
|
1038
|
+
status: number;
|
|
1039
|
+
};
|
|
866
1040
|
/**
|
|
867
1041
|
* Clears the cache for sharing-tasks api requests.
|
|
868
1042
|
*/
|
|
@@ -939,6 +1113,33 @@ interface SharingTasksAPI {
|
|
|
939
1113
|
* @throws CancelSharingTaskHttpError
|
|
940
1114
|
*/
|
|
941
1115
|
cancelSharingTask: typeof cancelSharingTask;
|
|
1116
|
+
/**
|
|
1117
|
+
* Lists executions for the specified sharing task.
|
|
1118
|
+
*
|
|
1119
|
+
* @param taskId The sharing task identifier.
|
|
1120
|
+
* @param query an object with query parameters
|
|
1121
|
+
* @throws GetSharingTaskExecutionsHttpError
|
|
1122
|
+
*/
|
|
1123
|
+
getSharingTaskExecutions: typeof getSharingTaskExecutions;
|
|
1124
|
+
/**
|
|
1125
|
+
* Retrieves a specific sharing task execution.
|
|
1126
|
+
*
|
|
1127
|
+
* @param taskId The sharing task identifier.
|
|
1128
|
+
* @param executionId The execution identifier. If value is "latest", the latest execution will be returned
|
|
1129
|
+
* @param query an object with query parameters
|
|
1130
|
+
* @throws GetSharingTaskExecutionHttpError
|
|
1131
|
+
*/
|
|
1132
|
+
getSharingTaskExecution: typeof getSharingTaskExecution;
|
|
1133
|
+
/**
|
|
1134
|
+
* Retrieves the file content for the requested execution and file type.
|
|
1135
|
+
*
|
|
1136
|
+
* @param taskId The sharing task identifier.
|
|
1137
|
+
* @param executionId The execution identifier.
|
|
1138
|
+
* @param fileAlias The execution identifier. If value is "latest", the latest execution will be returned
|
|
1139
|
+
* @param query an object with query parameters
|
|
1140
|
+
* @throws GetSharingTaskExecutionFileHttpError
|
|
1141
|
+
*/
|
|
1142
|
+
getSharingTaskExecutionFile: typeof getSharingTaskExecutionFile;
|
|
942
1143
|
/**
|
|
943
1144
|
* Clears the cache for sharing-tasks api requests.
|
|
944
1145
|
*/
|
|
@@ -949,4 +1150,4 @@ interface SharingTasksAPI {
|
|
|
949
1150
|
*/
|
|
950
1151
|
declare const sharingTasksExport: SharingTasksAPI;
|
|
951
1152
|
//#endregion
|
|
952
|
-
export { APISettingsUpload, AlertingTaskGroupRecipientError, AlertingTaskRecipientError, CancelSharingTaskHttpError, CancelSharingTaskHttpResponse, ChartTemplate, ConfigureSharingTasksSettingsHttpError, ConfigureSharingTasksSettingsHttpResponse, CreateSharingTaskHttpError, CreateSharingTaskHttpResponse, DeleteSharingTaskHttpError, DeleteSharingTaskHttpResponse, EmailAddressRecipientPersist, EmailComposition, EncryptedProperty, Error, ErrorMeta, Errors, ExecuteSharingTasksHttpError, ExecuteSharingTasksHttpResponse, GetSharingTaskHttpError, GetSharingTaskHttpResponse, GetSharingTasksHttpError, GetSharingTasksHttpResponse, GetSharingTasksSettingsHttpError, GetSharingTasksSettingsHttpResponse, GroupIDRecipientPersist, InsightURL, Links, ListLinks, MultiSheetTemplate, Page, PatchSharingTaskHttpError, PatchSharingTaskHttpResponse, RecipientsPersist, RetentionPolicy, ScheduleOptions, Selection, Self, SharingActionsTriggerCreateRequest, SharingSettings, SharingSettingsPatchCompliant, SharingSettingsPatchCompliantList, SharingTaskPatchRequestCompliantList, SharingTaskRecurringCreateRequest, SharingTaskRecurringListResponse, SharingTaskRecurringPatchRequestCompliant, SharingTaskRecurringPersist, SharingTaskRecurringPersistEncryptedEmailContent, SharingTaskRecurringRecipients, SharingTaskRecurringResponse, SharingTasksAPI, SheetTemplate, StandardListResponseProps, State, StoryTemplate, TaskError, TaskGroupRecipientError, TaskRecipientError, TemplatePersist, TemplateResult, Trigger, UpdateSharingTasksSettingsHttpError, UpdateSharingTasksSettingsHttpResponse, UserIDRecipient, UserIDRecipientPersist, cancelSharingTask, clearCache, configureSharingTasksSettings, createSharingTask, deleteSharingTask, executeSharingTasks, getSharingTask, getSharingTasks, getSharingTasksSettings, patchSharingTask, sharingTasksExport, updateSharingTasksSettings };
|
|
1153
|
+
export { APISettingsUpload, AlertingTaskGroupRecipientError, AlertingTaskRecipientError, CancelSharingTaskHttpError, CancelSharingTaskHttpResponse, ChartTemplate, ConfigureSharingTasksSettingsHttpError, ConfigureSharingTasksSettingsHttpResponse, CreateSharingTaskHttpError, CreateSharingTaskHttpResponse, DeleteSharingTaskHttpError, DeleteSharingTaskHttpResponse, EmailAddressRecipientPersist, EmailComposition, EncryptedProperty, Error, ErrorMeta, Errors, ExecuteSharingTasksHttpError, ExecuteSharingTasksHttpResponse, GetSharingTaskExecutionFileHttpError, GetSharingTaskExecutionFileHttpResponse, GetSharingTaskExecutionHttpError, GetSharingTaskExecutionHttpResponse, GetSharingTaskExecutionsHttpError, GetSharingTaskExecutionsHttpResponse, GetSharingTaskHttpError, GetSharingTaskHttpResponse, GetSharingTasksHttpError, GetSharingTasksHttpResponse, GetSharingTasksSettingsHttpError, GetSharingTasksSettingsHttpResponse, GroupIDRecipientPersist, InsightURL, Links, ListLinks, MultiSheetTemplate, Page, PatchSharingTaskHttpError, PatchSharingTaskHttpResponse, RecipientsPersist, RetentionPolicy, ScheduleOptions, Selection, Self, SharingActionsTriggerCreateRequest, SharingExecutionError, SharingExecutionErrors, SharingExecutionFile, SharingExecutionListResponse, SharingExecutionPersist, SharingExecutionResponse, SharingSettings, SharingSettingsPatchCompliant, SharingSettingsPatchCompliantList, SharingTaskPatchRequestCompliantList, SharingTaskRecurringCreateRequest, SharingTaskRecurringListResponse, SharingTaskRecurringPatchRequestCompliant, SharingTaskRecurringPersist, SharingTaskRecurringPersistEncryptedEmailContent, SharingTaskRecurringRecipients, SharingTaskRecurringResponse, SharingTasksAPI, SheetTemplate, StandardListResponseProps, State, StoryTemplate, TargetUser, TaskError, TaskGroupRecipientError, TaskRecipientError, TemplatePersist, TemplateResult, Trigger, UpdateSharingTasksSettingsHttpError, UpdateSharingTasksSettingsHttpResponse, UserIDRecipient, UserIDRecipientPersist, cancelSharingTask, clearCache, configureSharingTasksSettings, createSharingTask, deleteSharingTask, executeSharingTasks, getSharingTask, getSharingTaskExecution, getSharingTaskExecutionFile, getSharingTaskExecutions, getSharingTasks, getSharingTasksSettings, patchSharingTask, sharingTasksExport, updateSharingTasksSettings };
|
|
@@ -42,7 +42,7 @@ type AssignmentCreate = {
|
|
|
42
42
|
/**
|
|
43
43
|
* The type of assignment such as user or group
|
|
44
44
|
*/
|
|
45
|
-
type AssignmentType = "user" | "group";
|
|
45
|
+
type AssignmentType = "user" | "group" | "bot";
|
|
46
46
|
type AssignmentUpdate = {
|
|
47
47
|
/** The roles assigned to the assigneeId. For the full list of roles assignable in this space type, call `GET /spaces/{spaceId}` and inspect the `meta.assignableRoles` object. */
|
|
48
48
|
roles?: RoleType[];
|
|
@@ -424,16 +424,12 @@ type UpdateSpaceHttpError = {
|
|
|
424
424
|
declare function getSpaceAssignments(spaceId: string, query: {
|
|
425
425
|
/** Filters assignment for a specific assigneeid. */
|
|
426
426
|
assigneeId?: string;
|
|
427
|
-
/** The bot user of the assignment. The value should be a boolean, for example ?botUser=true */
|
|
428
|
-
botUser?: boolean;
|
|
429
427
|
/** Maximum number of assignments to return. */
|
|
430
428
|
limit?: number;
|
|
431
429
|
/** The next page cursor. Next links make use of this. */
|
|
432
430
|
next?: string;
|
|
433
431
|
/** The previous page cursor. Previous links make use of this. */
|
|
434
432
|
prev?: string;
|
|
435
|
-
/** The roles of the assignment. The value should be a comma separated list of roles, for example ?roles=facilitator,contributor */
|
|
436
|
-
roles?: RoleType[];
|
|
437
433
|
/** The type of assignment. Supported values are user or group. */
|
|
438
434
|
type?: AssignmentType;
|
|
439
435
|
}, options?: ApiCallOptions): Promise<GetSpaceAssignmentsHttpResponse>;
|
|
@@ -1,3 +1,3 @@
|
|
|
1
1
|
import "./chunks/auth-types-BlCWK0FP.js";
|
|
2
|
-
import { ConfigurationLineBase, ConfigurationLineNumeric, ConfigurationLineString, ConfigurationResponse, ConnectorFlatFileConfigurationResponse, ConnectorSettings, DirectAccessAgentsAPI, ErrorMessage, ErrorResponse, GetDirectAccessAgentConfigurationHttpError, GetDirectAccessAgentConfigurationHttpResponse, GetDirectAccessAgentConnectorFileHttpError, GetDirectAccessAgentConnectorFileHttpResponse, GetDirectAccessAgentConnectorFilesHttpError, GetDirectAccessAgentConnectorFilesHttpResponse, GetDirectAccessAgentConnectorFilesWithoutQueryHttpError, GetDirectAccessAgentConnectorFilesWithoutQueryHttpResponse, Operation, PatchDirectAccessAgentConfiguration204HttpResponse, PatchDirectAccessAgentConfiguration207HttpResponse, PatchDirectAccessAgentConfigurationHttpError, PatchDirectAccessAgentConfigurationHttpResponse, PatchOperationResponse, PatchOperationValidationResult, RestartDirectAccessAgentHttpError, RestartDirectAccessAgentHttpResponse, UpdateConfigurationFlatFileRequest, UpdateDirectAccessAgentConnectorFileHttpError, UpdateDirectAccessAgentConnectorFileHttpResponse, UpdateDirectAccessAgentConnectorFileWithoutQueryHttpError, UpdateDirectAccessAgentConnectorFileWithoutQueryHttpResponse, clearCache, directAccessAgentsExport, getDirectAccessAgentConfiguration, getDirectAccessAgentConnectorFile, getDirectAccessAgentConnectorFiles, getDirectAccessAgentConnectorFilesWithoutQuery, patchDirectAccessAgentConfiguration, restartDirectAccessAgent, updateDirectAccessAgentConnectorFile, updateDirectAccessAgentConnectorFileWithoutQuery } from "./chunks/direct-access-agents-
|
|
3
|
-
export { ConfigurationLineBase, ConfigurationLineNumeric, ConfigurationLineString, ConfigurationResponse, ConnectorFlatFileConfigurationResponse, ConnectorSettings, DirectAccessAgentsAPI, ErrorMessage, ErrorResponse, GetDirectAccessAgentConfigurationHttpError, GetDirectAccessAgentConfigurationHttpResponse, GetDirectAccessAgentConnectorFileHttpError, GetDirectAccessAgentConnectorFileHttpResponse, GetDirectAccessAgentConnectorFilesHttpError, GetDirectAccessAgentConnectorFilesHttpResponse, GetDirectAccessAgentConnectorFilesWithoutQueryHttpError, GetDirectAccessAgentConnectorFilesWithoutQueryHttpResponse, Operation, PatchDirectAccessAgentConfiguration204HttpResponse, PatchDirectAccessAgentConfiguration207HttpResponse, PatchDirectAccessAgentConfigurationHttpError, PatchDirectAccessAgentConfigurationHttpResponse, PatchOperationResponse, PatchOperationValidationResult, RestartDirectAccessAgentHttpError, RestartDirectAccessAgentHttpResponse, UpdateConfigurationFlatFileRequest, UpdateDirectAccessAgentConnectorFileHttpError, UpdateDirectAccessAgentConnectorFileHttpResponse, UpdateDirectAccessAgentConnectorFileWithoutQueryHttpError, UpdateDirectAccessAgentConnectorFileWithoutQueryHttpResponse, clearCache, directAccessAgentsExport as default, getDirectAccessAgentConfiguration, getDirectAccessAgentConnectorFile, getDirectAccessAgentConnectorFiles, getDirectAccessAgentConnectorFilesWithoutQuery, patchDirectAccessAgentConfiguration, restartDirectAccessAgent, updateDirectAccessAgentConnectorFile, updateDirectAccessAgentConnectorFileWithoutQuery };
|
|
2
|
+
import { ConfigurationLineBase, ConfigurationLineNumeric, ConfigurationLineString, ConfigurationResponse, ConnectorFlatFileConfigurationResponse, ConnectorSettings, DirectAccessAgentsAPI, ErrorMessage, ErrorResponse, GetDirectAccessAgentConfigurationHttpError, GetDirectAccessAgentConfigurationHttpResponse, GetDirectAccessAgentConnectorCustomDataTypeMappingsHttpError, GetDirectAccessAgentConnectorCustomDataTypeMappingsHttpResponse, GetDirectAccessAgentConnectorFileHttpError, GetDirectAccessAgentConnectorFileHttpResponse, GetDirectAccessAgentConnectorFilesHttpError, GetDirectAccessAgentConnectorFilesHttpResponse, GetDirectAccessAgentConnectorFilesWithoutQueryHttpError, GetDirectAccessAgentConnectorFilesWithoutQueryHttpResponse, OdbcCustomDataType, OdbcCustomDataTypeResponse, Operation, PatchDirectAccessAgentConfiguration204HttpResponse, PatchDirectAccessAgentConfiguration207HttpResponse, PatchDirectAccessAgentConfigurationHttpError, PatchDirectAccessAgentConfigurationHttpResponse, PatchOperationResponse, PatchOperationValidationResult, PutDirectAccessAgentConnectorCustomDataTypeMappingsHttpError, PutDirectAccessAgentConnectorCustomDataTypeMappingsHttpResponse, RestartDirectAccessAgentHttpError, RestartDirectAccessAgentHttpResponse, UpdateConfigurationFlatFileRequest, UpdateDirectAccessAgentConnectorFileHttpError, UpdateDirectAccessAgentConnectorFileHttpResponse, UpdateDirectAccessAgentConnectorFileWithoutQueryHttpError, UpdateDirectAccessAgentConnectorFileWithoutQueryHttpResponse, UpdateOdbcCustomTypeMappingsRequest, clearCache, directAccessAgentsExport, getDirectAccessAgentConfiguration, getDirectAccessAgentConnectorCustomDataTypeMappings, getDirectAccessAgentConnectorFile, getDirectAccessAgentConnectorFiles, getDirectAccessAgentConnectorFilesWithoutQuery, patchDirectAccessAgentConfiguration, putDirectAccessAgentConnectorCustomDataTypeMappings, restartDirectAccessAgent, updateDirectAccessAgentConnectorFile, updateDirectAccessAgentConnectorFileWithoutQuery } from "./chunks/direct-access-agents-BbSiWlMD.js";
|
|
3
|
+
export { ConfigurationLineBase, ConfigurationLineNumeric, ConfigurationLineString, ConfigurationResponse, ConnectorFlatFileConfigurationResponse, ConnectorSettings, DirectAccessAgentsAPI, ErrorMessage, ErrorResponse, GetDirectAccessAgentConfigurationHttpError, GetDirectAccessAgentConfigurationHttpResponse, GetDirectAccessAgentConnectorCustomDataTypeMappingsHttpError, GetDirectAccessAgentConnectorCustomDataTypeMappingsHttpResponse, GetDirectAccessAgentConnectorFileHttpError, GetDirectAccessAgentConnectorFileHttpResponse, GetDirectAccessAgentConnectorFilesHttpError, GetDirectAccessAgentConnectorFilesHttpResponse, GetDirectAccessAgentConnectorFilesWithoutQueryHttpError, GetDirectAccessAgentConnectorFilesWithoutQueryHttpResponse, OdbcCustomDataType, OdbcCustomDataTypeResponse, Operation, PatchDirectAccessAgentConfiguration204HttpResponse, PatchDirectAccessAgentConfiguration207HttpResponse, PatchDirectAccessAgentConfigurationHttpError, PatchDirectAccessAgentConfigurationHttpResponse, PatchOperationResponse, PatchOperationValidationResult, PutDirectAccessAgentConnectorCustomDataTypeMappingsHttpError, PutDirectAccessAgentConnectorCustomDataTypeMappingsHttpResponse, RestartDirectAccessAgentHttpError, RestartDirectAccessAgentHttpResponse, UpdateConfigurationFlatFileRequest, UpdateDirectAccessAgentConnectorFileHttpError, UpdateDirectAccessAgentConnectorFileHttpResponse, UpdateDirectAccessAgentConnectorFileWithoutQueryHttpError, UpdateDirectAccessAgentConnectorFileWithoutQueryHttpResponse, UpdateOdbcCustomTypeMappingsRequest, clearCache, directAccessAgentsExport as default, getDirectAccessAgentConfiguration, getDirectAccessAgentConnectorCustomDataTypeMappings, getDirectAccessAgentConnectorFile, getDirectAccessAgentConnectorFiles, getDirectAccessAgentConnectorFilesWithoutQuery, patchDirectAccessAgentConfiguration, putDirectAccessAgentConnectorCustomDataTypeMappings, restartDirectAccessAgent, updateDirectAccessAgentConnectorFile, updateDirectAccessAgentConnectorFileWithoutQuery };
|
package/direct-access-agents.js
CHANGED
|
@@ -93,6 +93,45 @@ async function getDirectAccessAgentConnectorFilesWithoutQuery(agentId, connector
|
|
|
93
93
|
});
|
|
94
94
|
}
|
|
95
95
|
/**
|
|
96
|
+
* Retrieves custom data type mapping settings for the Generic ODBC Connector. Requestor must be assigned the `TenantAdmin` role. Available in Direct Access Gateway V1.7.5+.
|
|
97
|
+
*
|
|
98
|
+
* @param agentId The agent ID.
|
|
99
|
+
* @param connectorType The connector type. Must be `odbc-connector` for this endpoint.
|
|
100
|
+
* @throws GetDirectAccessAgentConnectorCustomDataTypeMappingsHttpError
|
|
101
|
+
*/
|
|
102
|
+
async function getDirectAccessAgentConnectorCustomDataTypeMappings(agentId, connectorType, options) {
|
|
103
|
+
return invokeFetch("direct-access-agents", {
|
|
104
|
+
method: "get",
|
|
105
|
+
pathTemplate: "/api/v1/direct-access-agents/{agentId}/connectors/{connectorType}/files/custom-data-type-mappings",
|
|
106
|
+
pathVariables: {
|
|
107
|
+
agentId,
|
|
108
|
+
connectorType
|
|
109
|
+
},
|
|
110
|
+
options
|
|
111
|
+
});
|
|
112
|
+
}
|
|
113
|
+
/**
|
|
114
|
+
* Completely replaces the contents of the custom data type mapping configuration file for the Generic ODBC connector. Partial updates are not supported. There are property naming differences between the API and the file contents. Use the API property format when making changes. Requestor must be assigned the `TenantAdmin` role. Available in Direct Access Gateway V1.7.5+.
|
|
115
|
+
*
|
|
116
|
+
* @param agentId The agent ID.
|
|
117
|
+
* @param connectorType The connector type. Must be `odbc-connector` for this endpoint.
|
|
118
|
+
* @param body an object with the body content
|
|
119
|
+
* @throws PutDirectAccessAgentConnectorCustomDataTypeMappingsHttpError
|
|
120
|
+
*/
|
|
121
|
+
async function putDirectAccessAgentConnectorCustomDataTypeMappings(agentId, connectorType, body, options) {
|
|
122
|
+
return invokeFetch("direct-access-agents", {
|
|
123
|
+
method: "put",
|
|
124
|
+
pathTemplate: "/api/v1/direct-access-agents/{agentId}/connectors/{connectorType}/files/custom-data-type-mappings",
|
|
125
|
+
pathVariables: {
|
|
126
|
+
agentId,
|
|
127
|
+
connectorType
|
|
128
|
+
},
|
|
129
|
+
body,
|
|
130
|
+
contentType: "application/json",
|
|
131
|
+
options
|
|
132
|
+
});
|
|
133
|
+
}
|
|
134
|
+
/**
|
|
96
135
|
* Retrieves the configuration items in the flat file for the specified connector. Requestor must be assigned the `TenantAdmin` role and needs to be either a Gateway's space owner or a member in the Gateway's space with `Can Consume Data` role. Available in Direct Access Gateway V1.7.4+.
|
|
97
136
|
*
|
|
98
137
|
* @param agentId The agent ID
|
|
@@ -175,6 +214,8 @@ const directAccessAgentsExport = {
|
|
|
175
214
|
patchDirectAccessAgentConfiguration,
|
|
176
215
|
getDirectAccessAgentConnectorFiles,
|
|
177
216
|
getDirectAccessAgentConnectorFilesWithoutQuery,
|
|
217
|
+
getDirectAccessAgentConnectorCustomDataTypeMappings,
|
|
218
|
+
putDirectAccessAgentConnectorCustomDataTypeMappings,
|
|
178
219
|
getDirectAccessAgentConnectorFile,
|
|
179
220
|
updateDirectAccessAgentConnectorFile,
|
|
180
221
|
updateDirectAccessAgentConnectorFileWithoutQuery,
|
|
@@ -183,4 +224,4 @@ const directAccessAgentsExport = {
|
|
|
183
224
|
var direct_access_agents_default = directAccessAgentsExport;
|
|
184
225
|
|
|
185
226
|
//#endregion
|
|
186
|
-
export { clearCache, direct_access_agents_default as default, getDirectAccessAgentConfiguration, getDirectAccessAgentConnectorFile, getDirectAccessAgentConnectorFiles, getDirectAccessAgentConnectorFilesWithoutQuery, patchDirectAccessAgentConfiguration, restartDirectAccessAgent, updateDirectAccessAgentConnectorFile, updateDirectAccessAgentConnectorFileWithoutQuery };
|
|
227
|
+
export { clearCache, direct_access_agents_default as default, getDirectAccessAgentConfiguration, getDirectAccessAgentConnectorCustomDataTypeMappings, getDirectAccessAgentConnectorFile, getDirectAccessAgentConnectorFiles, getDirectAccessAgentConnectorFilesWithoutQuery, patchDirectAccessAgentConfiguration, putDirectAccessAgentConnectorCustomDataTypeMappings, restartDirectAccessAgent, updateDirectAccessAgentConnectorFile, updateDirectAccessAgentConnectorFileWithoutQuery };
|
package/index.d.ts
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { HostConfig } from "./chunks/auth-types-BlCWK0FP.js";
|
|
2
2
|
import { InterceptorsAPI, createInterceptors } from "./chunks/interceptors-e6hoYE8W.js";
|
|
3
3
|
import { AuthAPI, getAccessToken, getWebResourceAuthParams, registerAuthModule, registerHostConfig, setDefaultHostConfig, unregisterHostConfig } from "./chunks/auth-B5Hx9GeQ.js";
|
|
4
|
-
import { QixAPI } from "./chunks/qix-
|
|
4
|
+
import { QixAPI } from "./chunks/qix-Cc6k8Gz2.js";
|
|
5
5
|
import { ApiKeysAPI } from "./chunks/api-keys-CI44OuNR.js";
|
|
6
6
|
import { AppsAPI } from "./chunks/apps-BiGof9WJ.js";
|
|
7
7
|
import { AssistantsAPI } from "./chunks/assistants-2UX0GzZ7.js";
|
|
@@ -27,7 +27,7 @@ import { DataSourcesAPI } from "./chunks/data-sources-DNnmr1Qi.js";
|
|
|
27
27
|
import { DataStoresAPI } from "./chunks/data-stores-Bofu7fl5.js";
|
|
28
28
|
import { DcaasAPI } from "./chunks/dcaas-DK4f7Rrs.js";
|
|
29
29
|
import { DiProjectsAPI } from "./chunks/di-projects-uem8xKkX.js";
|
|
30
|
-
import { DirectAccessAgentsAPI } from "./chunks/direct-access-agents-
|
|
30
|
+
import { DirectAccessAgentsAPI } from "./chunks/direct-access-agents-BbSiWlMD.js";
|
|
31
31
|
import { EncryptionAPI } from "./chunks/encryption-CMJWtMcm.js";
|
|
32
32
|
import { ExtensionsAPI } from "./chunks/extensions-Ct2JAsbk.js";
|
|
33
33
|
import { GlossariesAPI } from "./chunks/glossaries-Drx-EwiU.js";
|
|
@@ -37,7 +37,7 @@ import { ItemsAPI } from "./chunks/items-BnN6gI0J.js";
|
|
|
37
37
|
import { KnowledgebasesAPI } from "./chunks/knowledgebases-tmPZVD6i.js";
|
|
38
38
|
import { LicensesAPI } from "./chunks/licenses-jecAKovb.js";
|
|
39
39
|
import { LineageGraphsAPI } from "./chunks/lineage-graphs-Q4LiGGtL.js";
|
|
40
|
-
import { MlAPI } from "./chunks/ml-
|
|
40
|
+
import { MlAPI } from "./chunks/ml-C80TkK1J.js";
|
|
41
41
|
import { NotesAPI } from "./chunks/notes-CHvadRai.js";
|
|
42
42
|
import { NotificationsAPI } from "./chunks/notifications-BhS8s4Eo.js";
|
|
43
43
|
import { OauthClientsAPI } from "./chunks/oauth-clients-D1f8xiFC.js";
|
|
@@ -45,15 +45,15 @@ import { OauthTokensAPI } from "./chunks/oauth-tokens-DteoDifd.js";
|
|
|
45
45
|
import { QuestionsAPI } from "./chunks/questions-BiR5-mZ4.js";
|
|
46
46
|
import { QuotasAPI } from "./chunks/quotas-GTQL9uPt.js";
|
|
47
47
|
import { ReloadTasksAPI } from "./chunks/reload-tasks-CmXJp5va.js";
|
|
48
|
-
import { ReloadsAPI } from "./chunks/reloads-
|
|
48
|
+
import { ReloadsAPI } from "./chunks/reloads-3XgvVnbq.js";
|
|
49
49
|
import { ReportTemplatesAPI } from "./chunks/report-templates-BowaTti4.js";
|
|
50
50
|
import { ReportsAPI } from "./chunks/reports-oosnUaFo.js";
|
|
51
51
|
import { RolesAPI } from "./chunks/roles-D93ENaRt.js";
|
|
52
|
-
import { SharingTasksAPI } from "./chunks/sharing-tasks-
|
|
53
|
-
import { SpacesAPI } from "./chunks/spaces-
|
|
52
|
+
import { SharingTasksAPI } from "./chunks/sharing-tasks-BMDAjWTj.js";
|
|
53
|
+
import { SpacesAPI } from "./chunks/spaces-DZI6zKZi.js";
|
|
54
54
|
import { TasksAPI } from "./chunks/tasks-BWmS6L8Y.js";
|
|
55
55
|
import { TempContentsAPI } from "./chunks/temp-contents-CZVb5P0V.js";
|
|
56
|
-
import { TenantsAPI } from "./chunks/tenants-
|
|
56
|
+
import { TenantsAPI } from "./chunks/tenants-BDH4DmcO.js";
|
|
57
57
|
import { ThemesAPI } from "./chunks/themes-BkubWfOE.js";
|
|
58
58
|
import { TransportsAPI } from "./chunks/transports-CO9kRJg5.js";
|
|
59
59
|
import { UiConfigAPI } from "./chunks/ui-config-DIOnLEV9.js";
|
package/index.js
CHANGED
|
@@ -613,6 +613,7 @@ const directAccessAgentsMiniModule = apiDefToApiPublic("direct-access-agents", {
|
|
|
613
613
|
configurations: ["getDirectAccessAgentConfiguration:GQ:", "patchDirectAccessAgentConfiguration:ABJ:"],
|
|
614
614
|
connectors: { "{connectorType}": { files: {
|
|
615
615
|
"": ["getDirectAccessAgentConnectorFiles:GQ:", "getDirectAccessAgentConnectorFilesWithoutQuery:G:"],
|
|
616
|
+
"custom-data-type-mappings": ["getDirectAccessAgentConnectorCustomDataTypeMappings:G:", "putDirectAccessAgentConnectorCustomDataTypeMappings:UBJ:"],
|
|
616
617
|
"{fileType}": [
|
|
617
618
|
"getDirectAccessAgentConnectorFile:G:",
|
|
618
619
|
"updateDirectAccessAgentConnectorFile:UQBJ:",
|
|
@@ -948,7 +949,14 @@ const sharingTasksMiniModule = apiDefToApiPublic("sharing-tasks", { api: { v1: {
|
|
|
948
949
|
"getSharingTask:GQ:",
|
|
949
950
|
"patchSharingTask:ABJ:"
|
|
950
951
|
],
|
|
951
|
-
actions: { cancel: ["cancelSharingTask:P:"] }
|
|
952
|
+
actions: { cancel: ["cancelSharingTask:P:"] },
|
|
953
|
+
executions: {
|
|
954
|
+
"": ["getSharingTaskExecutions:GQ:"],
|
|
955
|
+
"{executionId}": {
|
|
956
|
+
"": ["getSharingTaskExecution:GQ:"],
|
|
957
|
+
files: { "{fileAlias}": ["getSharingTaskExecutionFile:GQ:"] }
|
|
958
|
+
}
|
|
959
|
+
}
|
|
952
960
|
}
|
|
953
961
|
} } } });
|
|
954
962
|
const spacesMiniModule = apiDefToApiPublic("spaces", { api: { v1: { spaces: {
|