@qlik/api 1.38.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/api-keys.js +2 -2
- package/apps.js +2 -2
- package/assistants.d.ts +1 -1
- package/assistants.js +2 -2
- package/audits.js +2 -2
- package/auth.js +2 -2
- package/automation-connections.js +2 -2
- package/automations.js +2 -2
- package/automl-deployments.js +2 -2
- package/automl-predictions.js +2 -2
- package/brands.js +2 -2
- package/chunks/{assistants-CDtI99Yr.d.ts → assistants-2UX0GzZ7.d.ts} +33 -33
- package/chunks/{auth-BzhoWKwN.js → auth-DBrXfv7D.js} +1 -1
- package/chunks/{data-alerts-Bx5sDVGI.d.ts → data-alerts-DwPcCvHP.d.ts} +32 -32
- package/chunks/{direct-access-agents-CGxApxBP.d.ts → direct-access-agents-BbSiWlMD.d.ts} +74 -1
- package/chunks/{dist-P1twboQp.js → dist-CjqdvDf3.js} +1 -1
- package/chunks/{invoke-fetch-DJFDz11x.js → invoke-fetch-B-ZucHu9.js} +2 -2
- package/chunks/{ml-gl8COKfn.d.ts → ml-C80TkK1J.d.ts} +32 -0
- package/chunks/{public-runtime-modules-Bfh2smA7.js → public-runtime-modules-lsJEDVxt.js} +3 -3
- package/chunks/{qix-DggPusot.d.ts → qix-Cc6k8Gz2.d.ts} +1 -1
- package/chunks/{qix-f5SasQCg.js → qix-CwYrlHFT.js} +1 -1
- package/chunks/{reloads-CA7KjqJO.d.ts → reloads-3XgvVnbq.d.ts} +9 -1
- package/chunks/{sharing-tasks-QKSzROsB.d.ts → sharing-tasks-BMDAjWTj.d.ts} +222 -21
- 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/collections.js +2 -2
- package/conditions.js +2 -2
- package/consumption.js +2 -2
- package/csp-origins.js +2 -2
- package/csrf-token.js +2 -2
- package/data-alerts.d.ts +1 -1
- package/data-alerts.js +18 -18
- package/data-assets.js +2 -2
- package/data-connections.js +2 -2
- package/data-credentials.js +2 -2
- package/data-files.js +2 -2
- package/data-qualities.js +2 -2
- package/data-sets.js +2 -2
- package/data-sources.js +2 -2
- package/data-stores.js +2 -2
- package/dcaas.js +2 -2
- package/di-projects.js +2 -2
- package/direct-access-agents.d.ts +2 -2
- package/direct-access-agents.js +44 -3
- package/encryption.js +2 -2
- package/extensions.js +2 -2
- package/glossaries.js +2 -2
- package/groups.js +2 -2
- package/identity-providers.js +2 -2
- package/index.d.ts +9 -9
- package/index.js +13 -5
- package/items.js +2 -2
- package/knowledgebases.js +2 -2
- package/licenses.js +2 -2
- package/lineage-graphs.js +2 -2
- package/ml.d.ts +1 -1
- package/ml.js +2 -2
- package/notes.js +2 -2
- package/notifications.js +2 -2
- package/oauth-clients.js +2 -2
- package/oauth-tokens.js +2 -2
- package/package.json +2 -2
- package/qix.d.ts +1 -1
- package/qix.js +2 -2
- package/questions.js +2 -2
- package/quotas.js +2 -2
- package/reload-tasks.js +2 -2
- package/reloads.d.ts +2 -2
- package/reloads.js +2 -2
- package/report-templates.js +2 -2
- package/reports.js +2 -2
- package/roles.js +2 -2
- package/sharing-tasks.d.ts +2 -2
- package/sharing-tasks.js +73 -12
- package/spaces.d.ts +1 -1
- package/spaces.js +2 -2
- package/tasks.js +2 -2
- package/temp-contents.js +2 -2
- package/tenants.d.ts +1 -1
- package/tenants.js +2 -2
- package/themes.js +2 -2
- package/transports.js +2 -2
- package/ui-config.js +2 -2
- package/users.js +2 -2
- package/web-integrations.js +2 -2
- package/web-notifications.js +2 -2
- package/webhooks.js +2 -2
- package/website/assets/navigation.js +1 -1
- package/website/assets/search.js +1 -1
- package/website/functions/data-alerts.createDataAlert.html +1 -1
- package/website/functions/data-alerts.deleteDataAlert.html +1 -1
- package/website/functions/data-alerts.deleteDataAlertExecution.html +1 -1
- package/website/functions/data-alerts.getDataAlert.html +1 -1
- package/website/functions/data-alerts.getDataAlertCondition.html +1 -1
- package/website/functions/data-alerts.getDataAlertExecution.html +1 -1
- package/website/functions/data-alerts.getDataAlertExecutionEvaluations.html +1 -1
- package/website/functions/data-alerts.getDataAlertExecutions.html +1 -1
- package/website/functions/data-alerts.getDataAlertExecutionsStats.html +1 -1
- package/website/functions/data-alerts.getDataAlertRecipientStats.html +1 -1
- package/website/functions/data-alerts.getDataAlerts.html +1 -1
- package/website/functions/data-alerts.getDataAlertsSettings.html +1 -1
- package/website/functions/data-alerts.patchDataAlert.html +1 -1
- package/website/functions/data-alerts.setDataAlertsSettings.html +1 -1
- package/website/functions/data-alerts.triggerDataAlerts.html +1 -1
- package/website/functions/data-alerts.validateDataAlerts.html +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.cancelSharingTask.html +1 -1
- package/website/functions/sharing-tasks.configureSharingTasksSettings.html +1 -1
- package/website/functions/sharing-tasks.deleteSharingTask.html +1 -1
- package/website/functions/sharing-tasks.executeSharingTasks.html +1 -1
- package/website/functions/sharing-tasks.getSharingTask.html +2 -2
- 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/sharing-tasks.getSharingTasks.html +1 -1
- package/website/functions/sharing-tasks.getSharingTasksSettings.html +1 -1
- package/website/functions/sharing-tasks.patchSharingTask.html +1 -1
- package/website/functions/sharing-tasks.updateSharingTasksSettings.html +1 -1
- package/website/functions/spaces.getSpaceAssignments.html +2 -4
- package/website/interfaces/data-alerts.DataAlertsAPI.html +32 -32
- 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 +72 -31
- package/website/interfaces/spaces.SpacesAPI.html +4 -6
- package/website/modules/direct-access-agents.html +1 -1
- package/website/modules/reloads.html +1 -1
- package/website/modules/sharing-tasks.html +1 -1
- package/website/types/assistants.CreateAssistantHttpError.html +2 -2
- package/website/types/assistants.CreateAssistantStarterHttpError.html +2 -2
- package/website/types/assistants.CreateAssistantThreadHttpError.html +2 -2
- package/website/types/assistants.CreateAssistantThreadInteractionFeedbackHttpError.html +2 -2
- package/website/types/assistants.CreateAssistantThreadInteractionHttpError.html +2 -2
- package/website/types/assistants.CreateAssistantThreadInteractionReviewHttpError.html +2 -2
- package/website/types/assistants.DeleteAssistantHttpError.html +2 -2
- package/website/types/assistants.DeleteAssistantStarterFollowupHttpError.html +2 -2
- package/website/types/assistants.DeleteAssistantStarterHttpError.html +2 -2
- package/website/types/assistants.DeleteAssistantThreadHttpError.html +2 -2
- package/website/types/assistants.DeleteAssistantThreadInteractionHttpError.html +2 -2
- package/website/types/assistants.ErrorResponseCode.html +1 -11
- package/website/types/assistants.ErrorResponseCodeCopy.html +11 -1
- package/website/types/assistants.GetAssistantFeedbackHttpError.html +2 -2
- package/website/types/assistants.GetAssistantHttpError.html +2 -2
- package/website/types/assistants.GetAssistantSourcesHttpError.html +2 -2
- package/website/types/assistants.GetAssistantStarterHttpError.html +2 -2
- package/website/types/assistants.GetAssistantStartersHttpError.html +2 -2
- package/website/types/assistants.GetAssistantThreadHttpError.html +2 -2
- package/website/types/assistants.GetAssistantThreadInteractionHttpError.html +2 -2
- package/website/types/assistants.GetAssistantThreadInteractionsHttpError.html +2 -2
- package/website/types/assistants.GetAssistantThreadsHttpError.html +2 -2
- package/website/types/assistants.GetAssistantsHttpError.html +2 -2
- package/website/types/assistants.InvokeAssistantThreadHttpError.html +2 -2
- package/website/types/assistants.PatchAssistantHttpError.html +2 -2
- package/website/types/assistants.PatchAssistantThreadHttpError.html +2 -2
- package/website/types/assistants.PatchAssistantThreadInteractionFeedbackHttpError.html +2 -2
- package/website/types/assistants.StreamAssistantThreadHttpError.html +2 -2
- package/website/types/assistants.UpdateAssistantStarterFollowupHttpError.html +2 -2
- package/website/types/assistants.UpdateAssistantStarterHttpError.html +2 -2
- 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 +4 -2
- package/website/types/reloads.ReloadRequest.html +4 -2
- package/website/types/reloads.Weight.html +2 -0
- 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 };
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
//#region node_modules/.pnpm/@qlik+runtime-module-loader@1.0.
|
|
1
|
+
//#region node_modules/.pnpm/@qlik+runtime-module-loader@1.0.23/node_modules/@qlik/runtime-module-loader/dist/index.js
|
|
2
2
|
window.__qlikMainPrivateResolvers = window.__qlikMainPrivateResolvers || {};
|
|
3
3
|
window.__qlikMainPrivateResolvers.mainUrlPromise = window.__qlikMainPrivateResolvers.mainUrlPromise || new Promise((resolve) => {
|
|
4
4
|
window.__qlikMainPrivateResolvers.resolveMainJsUrl = (value) => resolve(value);
|
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
import { isBrowser } from "./utils-qEQ6sEXX.js";
|
|
2
|
-
import { getInvokeFetchRuntimeModule } from "./public-runtime-modules-
|
|
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
|
|
@@ -5,17 +5,17 @@
|
|
|
5
5
|
*/
|
|
6
6
|
function getAuthRuntimeModule(hostConfig) {
|
|
7
7
|
const isNode = !!globalThis.process?.argv;
|
|
8
|
-
return isNode ? import("./auth-DhI7LQIw.js") : import("./dist-
|
|
8
|
+
return isNode ? import("./auth-DhI7LQIw.js") : import("./dist-CjqdvDf3.js").then((mod) => mod.importRuntimeModule("auth@v1", hostConfig));
|
|
9
9
|
}
|
|
10
10
|
async function getQixRuntimeModule(hostConfig) {
|
|
11
11
|
await getAuthRuntimeModule(hostConfig);
|
|
12
12
|
const isNode = !!globalThis.process?.argv;
|
|
13
|
-
return isNode ? import("./qix-bnv1_Kxc.js") : import("./dist-
|
|
13
|
+
return isNode ? import("./qix-bnv1_Kxc.js") : import("./dist-CjqdvDf3.js").then((mod) => mod.importRuntimeModule("qix@v1", hostConfig));
|
|
14
14
|
}
|
|
15
15
|
async function getInvokeFetchRuntimeModule(hostConfig) {
|
|
16
16
|
await getAuthRuntimeModule(hostConfig);
|
|
17
17
|
const isNode = !!globalThis.process?.argv;
|
|
18
|
-
return isNode ? import("./invoke-fetch-NdtGGVxy.js") : import("./dist-
|
|
18
|
+
return isNode ? import("./invoke-fetch-NdtGGVxy.js") : import("./dist-CjqdvDf3.js").then((mod) => mod.importRuntimeModule("invoke-fetch@v1", hostConfig));
|
|
19
19
|
}
|
|
20
20
|
|
|
21
21
|
//#endregion
|
|
@@ -66,6 +66,8 @@ 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. */
|
|
70
|
+
weight?: Weight;
|
|
69
71
|
};
|
|
70
72
|
type ReloadLinks = {
|
|
71
73
|
self?: Href;
|
|
@@ -77,6 +79,8 @@ type ReloadRequest = {
|
|
|
77
79
|
partial?: boolean;
|
|
78
80
|
/** The variables to be used in the load script. */
|
|
79
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. */
|
|
83
|
+
weight?: Weight;
|
|
80
84
|
};
|
|
81
85
|
type Reloads = {
|
|
82
86
|
data: Reload[];
|
|
@@ -98,6 +102,10 @@ type Status = "QUEUED" | "RELOADING" | "CANCELING" | "SUCCEEDED" | "FAILED" | "C
|
|
|
98
102
|
* "chronos"
|
|
99
103
|
*/
|
|
100
104
|
type Type = "hub" | "external" | "chronos" | "automations" | "data-refresh" | "choreographer";
|
|
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.
|
|
107
|
+
*/
|
|
108
|
+
type Weight = number;
|
|
101
109
|
/**
|
|
102
110
|
* Finds and returns the reloads that the user has access to.
|
|
103
111
|
* @example
|
|
@@ -249,4 +257,4 @@ interface ReloadsAPI {
|
|
|
249
257
|
*/
|
|
250
258
|
declare const reloadsExport: ReloadsAPI;
|
|
251
259
|
//#endregion
|
|
252
|
-
export { CancelReloadHttpError, CancelReloadHttpResponse, Error, Errors, GetReloadHttpError, GetReloadHttpResponse, GetReloadsHttpError, GetReloadsHttpResponse, Href, Partial, QueueReloadHttpError, QueueReloadHttpResponse, Reload, ReloadLinks, ReloadRequest, Reloads, ReloadsAPI, ReloadsLinks, Status, Type, cancelReload, clearCache, getReload, getReloads, queueReload, reloadsExport };
|
|
260
|
+
export { CancelReloadHttpError, CancelReloadHttpResponse, Error, Errors, GetReloadHttpError, GetReloadHttpResponse, GetReloadsHttpError, GetReloadsHttpResponse, Href, Partial, QueueReloadHttpError, QueueReloadHttpResponse, Reload, ReloadLinks, ReloadRequest, Reloads, ReloadsAPI, ReloadsLinks, Status, Type, Weight, cancelReload, clearCache, getReload, getReloads, queueReload, reloadsExport };
|
|
@@ -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;
|
|
@@ -659,7 +755,7 @@ type UserIDRecipientPersist = {
|
|
|
659
755
|
value?: string;
|
|
660
756
|
};
|
|
661
757
|
/**
|
|
662
|
-
*
|
|
758
|
+
* Retrieves all sharing tasks accessible to the user. Users assigned the `TenantAdmin` or `AnalyticsAdmin` role can view all tasks.
|
|
663
759
|
*
|
|
664
760
|
* @param query an object with query parameters
|
|
665
761
|
* @throws GetSharingTasksHttpError
|
|
@@ -724,7 +820,7 @@ type CreateSharingTaskHttpError = {
|
|
|
724
820
|
status: number;
|
|
725
821
|
};
|
|
726
822
|
/**
|
|
727
|
-
*
|
|
823
|
+
* Requests execution of the specified recurring sharing task.
|
|
728
824
|
*
|
|
729
825
|
* @param body an object with the body content
|
|
730
826
|
* @throws ExecuteSharingTasksHttpError
|
|
@@ -741,7 +837,7 @@ type ExecuteSharingTasksHttpError = {
|
|
|
741
837
|
status: number;
|
|
742
838
|
};
|
|
743
839
|
/**
|
|
744
|
-
*
|
|
840
|
+
* Retrieves the current settings for sharing tasks, reports, and other related configuration.
|
|
745
841
|
*
|
|
746
842
|
* @throws GetSharingTasksSettingsHttpError
|
|
747
843
|
*/
|
|
@@ -757,7 +853,7 @@ type GetSharingTasksSettingsHttpError = {
|
|
|
757
853
|
status: number;
|
|
758
854
|
};
|
|
759
855
|
/**
|
|
760
|
-
* Patches sharing
|
|
856
|
+
* Patches the toggle settings for sharing tasks, reports, and other related configuration in the tenant. User must be assigned the `TenantAdmin` role.
|
|
761
857
|
*
|
|
762
858
|
* @param body an object with the body content
|
|
763
859
|
* @throws UpdateSharingTasksSettingsHttpError
|
|
@@ -774,7 +870,7 @@ type UpdateSharingTasksSettingsHttpError = {
|
|
|
774
870
|
status: number;
|
|
775
871
|
};
|
|
776
872
|
/**
|
|
777
|
-
* Updates
|
|
873
|
+
* Updates the settings for sharing tasks, reports, and other related configuration in the tenant. User must be assigned the `TenantAdmin` role.
|
|
778
874
|
*
|
|
779
875
|
* @param body an object with the body content
|
|
780
876
|
* @throws ConfigureSharingTasksSettingsHttpError
|
|
@@ -791,7 +887,7 @@ type ConfigureSharingTasksSettingsHttpError = {
|
|
|
791
887
|
status: number;
|
|
792
888
|
};
|
|
793
889
|
/**
|
|
794
|
-
* Deletes a sharing task.
|
|
890
|
+
* Deletes a specific sharing task.
|
|
795
891
|
*
|
|
796
892
|
* @param taskId The sharing task identifier.
|
|
797
893
|
* @throws DeleteSharingTaskHttpError
|
|
@@ -808,14 +904,14 @@ type DeleteSharingTaskHttpError = {
|
|
|
808
904
|
status: number;
|
|
809
905
|
};
|
|
810
906
|
/**
|
|
811
|
-
*
|
|
907
|
+
* Returns the details of a specific sharing task.
|
|
812
908
|
*
|
|
813
909
|
* @param taskId The sharing task identifier.
|
|
814
910
|
* @param query an object with query parameters
|
|
815
911
|
* @throws GetSharingTaskHttpError
|
|
816
912
|
*/
|
|
817
913
|
declare function getSharingTask(taskId: string, query: {
|
|
818
|
-
/**
|
|
914
|
+
/** Determines whether to update the `lastViewed` property for the sharing task, which is used to determine whether the sharing task is still in use. If set to `true`, this will be updated to current time. */
|
|
819
915
|
isViewChart?: boolean;
|
|
820
916
|
}, options?: ApiCallOptions): Promise<GetSharingTaskHttpResponse>;
|
|
821
917
|
type GetSharingTaskHttpResponse = {
|
|
@@ -829,7 +925,7 @@ type GetSharingTaskHttpError = {
|
|
|
829
925
|
status: number;
|
|
830
926
|
};
|
|
831
927
|
/**
|
|
832
|
-
* Updates
|
|
928
|
+
* Updates one or more properties of a specific sharing task.
|
|
833
929
|
*
|
|
834
930
|
* @param taskId The sharing task identifier.
|
|
835
931
|
* @param body an object with the body content
|
|
@@ -847,7 +943,7 @@ type PatchSharingTaskHttpError = {
|
|
|
847
943
|
status: number;
|
|
848
944
|
};
|
|
849
945
|
/**
|
|
850
|
-
*
|
|
946
|
+
* Requests cancellation of an execution of the specified recurring sharing task.
|
|
851
947
|
*
|
|
852
948
|
* @param taskId The sharing task identifier.
|
|
853
949
|
* @throws CancelSharingTaskHttpError
|
|
@@ -863,13 +959,91 @@ 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
|
*/
|
|
869
1043
|
declare function clearCache(): void;
|
|
870
1044
|
interface SharingTasksAPI {
|
|
871
1045
|
/**
|
|
872
|
-
*
|
|
1046
|
+
* Retrieves all sharing tasks accessible to the user. Users assigned the `TenantAdmin` or `AnalyticsAdmin` role can view all tasks.
|
|
873
1047
|
*
|
|
874
1048
|
* @param query an object with query parameters
|
|
875
1049
|
* @throws GetSharingTasksHttpError
|
|
@@ -883,41 +1057,41 @@ interface SharingTasksAPI {
|
|
|
883
1057
|
*/
|
|
884
1058
|
createSharingTask: typeof createSharingTask;
|
|
885
1059
|
/**
|
|
886
|
-
*
|
|
1060
|
+
* Requests execution of the specified recurring sharing task.
|
|
887
1061
|
*
|
|
888
1062
|
* @param body an object with the body content
|
|
889
1063
|
* @throws ExecuteSharingTasksHttpError
|
|
890
1064
|
*/
|
|
891
1065
|
executeSharingTasks: typeof executeSharingTasks;
|
|
892
1066
|
/**
|
|
893
|
-
*
|
|
1067
|
+
* Retrieves the current settings for sharing tasks, reports, and other related configuration.
|
|
894
1068
|
*
|
|
895
1069
|
* @throws GetSharingTasksSettingsHttpError
|
|
896
1070
|
*/
|
|
897
1071
|
getSharingTasksSettings: typeof getSharingTasksSettings;
|
|
898
1072
|
/**
|
|
899
|
-
* Patches sharing
|
|
1073
|
+
* Patches the toggle settings for sharing tasks, reports, and other related configuration in the tenant. User must be assigned the `TenantAdmin` role.
|
|
900
1074
|
*
|
|
901
1075
|
* @param body an object with the body content
|
|
902
1076
|
* @throws UpdateSharingTasksSettingsHttpError
|
|
903
1077
|
*/
|
|
904
1078
|
updateSharingTasksSettings: typeof updateSharingTasksSettings;
|
|
905
1079
|
/**
|
|
906
|
-
* Updates
|
|
1080
|
+
* Updates the settings for sharing tasks, reports, and other related configuration in the tenant. User must be assigned the `TenantAdmin` role.
|
|
907
1081
|
*
|
|
908
1082
|
* @param body an object with the body content
|
|
909
1083
|
* @throws ConfigureSharingTasksSettingsHttpError
|
|
910
1084
|
*/
|
|
911
1085
|
configureSharingTasksSettings: typeof configureSharingTasksSettings;
|
|
912
1086
|
/**
|
|
913
|
-
* Deletes a sharing task.
|
|
1087
|
+
* Deletes a specific sharing task.
|
|
914
1088
|
*
|
|
915
1089
|
* @param taskId The sharing task identifier.
|
|
916
1090
|
* @throws DeleteSharingTaskHttpError
|
|
917
1091
|
*/
|
|
918
1092
|
deleteSharingTask: typeof deleteSharingTask;
|
|
919
1093
|
/**
|
|
920
|
-
*
|
|
1094
|
+
* Returns the details of a specific sharing task.
|
|
921
1095
|
*
|
|
922
1096
|
* @param taskId The sharing task identifier.
|
|
923
1097
|
* @param query an object with query parameters
|
|
@@ -925,7 +1099,7 @@ interface SharingTasksAPI {
|
|
|
925
1099
|
*/
|
|
926
1100
|
getSharingTask: typeof getSharingTask;
|
|
927
1101
|
/**
|
|
928
|
-
* Updates
|
|
1102
|
+
* Updates one or more properties of a specific sharing task.
|
|
929
1103
|
*
|
|
930
1104
|
* @param taskId The sharing task identifier.
|
|
931
1105
|
* @param body an object with the body content
|
|
@@ -933,12 +1107,39 @@ interface SharingTasksAPI {
|
|
|
933
1107
|
*/
|
|
934
1108
|
patchSharingTask: typeof patchSharingTask;
|
|
935
1109
|
/**
|
|
936
|
-
*
|
|
1110
|
+
* Requests cancellation of an execution of the specified recurring sharing task.
|
|
937
1111
|
*
|
|
938
1112
|
* @param taskId The sharing task identifier.
|
|
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 };
|