@qlik/api 2.2.0 → 2.3.1

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.
Files changed (232) hide show
  1. package/analytics/change-stores.d.ts +386 -0
  2. package/analytics/change-stores.js +123 -0
  3. package/analytics.d.ts +14 -0
  4. package/analytics.js +13 -0
  5. package/api-keys.d.ts +362 -3
  6. package/api-keys.js +2 -3
  7. package/apps.d.ts +2673 -3
  8. package/apps.js +2 -3
  9. package/assistants.d.ts +1370 -3
  10. package/assistants.js +2 -3
  11. package/audits.d.ts +318 -3
  12. package/audits.js +4 -4
  13. package/auth-types.d.ts +1 -1
  14. package/auth-types.js +1 -2
  15. package/auth.d.ts +94 -2
  16. package/auth.js +63 -3
  17. package/automation-connections.d.ts +366 -3
  18. package/automation-connections.js +2 -3
  19. package/automation-connectors.d.ts +84 -3
  20. package/automation-connectors.js +2 -3
  21. package/automations.d.ts +805 -3
  22. package/automations.js +2 -3
  23. package/automl-deployments.d.ts +101 -3
  24. package/automl-deployments.js +2 -3
  25. package/automl-predictions.d.ts +238 -3
  26. package/automl-predictions.js +2 -3
  27. package/banners.d.ts +184 -3
  28. package/banners.js +2 -3
  29. package/brands.d.ts +670 -3
  30. package/brands.js +2 -3
  31. package/chunks/auth-XusKk8IA.js +32 -0
  32. package/chunks/{chunk-EtTptKIv.js → chunk-D3vHIbds.js} +2 -2
  33. package/chunks/{dist-gXLIqDJW.js → dist-n3iOVn1W.js} +4 -4
  34. package/chunks/{auth-functions-BmZgZYSs.js → interceptors-2VSXImC9.js} +498 -146
  35. package/chunks/{invoke-fetch-PcVIxLW4.js → invoke-fetch-CckTK7bh.js} +3 -3
  36. package/chunks/{invoke-fetch-CucBpA1C.js → invoke-fetch-D9lpiAb-.js} +1 -5
  37. package/chunks/{public-runtime-modules-Dwjzb3l8.js → public-runtime-modules-BqxAMJ9M.js} +7 -7
  38. package/chunks/{qix-DI5o5XF4.d.ts → qix-CrqXv44x.d.ts} +6 -2
  39. package/chunks/{qix-DjxuPCX0.js → qix-DpvHvpx7.js} +11 -10
  40. package/chunks/{qix-chunk-entrypoint-tmTo-kpa.js → qix-chunk-entrypoint-BXZPnE6J.js} +48 -50
  41. package/collections.d.ts +582 -3
  42. package/collections.js +2 -3
  43. package/conditions.d.ts +662 -3
  44. package/conditions.js +2 -3
  45. package/consumption.d.ts +182 -3
  46. package/consumption.js +2 -3
  47. package/core/ip-policies.d.ts +328 -4
  48. package/core/ip-policies.js +108 -5
  49. package/core.d.ts +13 -4
  50. package/core.js +3 -4
  51. package/csp-origins.d.ts +273 -3
  52. package/csp-origins.js +2 -3
  53. package/csrf-token.d.ts +62 -3
  54. package/csrf-token.js +2 -3
  55. package/data-alerts.d.ts +1004 -3
  56. package/data-alerts.js +2 -3
  57. package/data-assets.d.ts +207 -3
  58. package/data-assets.js +2 -3
  59. package/data-connections.d.ts +678 -3
  60. package/data-connections.js +2 -3
  61. package/data-credentials.d.ts +292 -3
  62. package/data-credentials.js +2 -3
  63. package/data-files.d.ts +860 -3
  64. package/data-files.js +2 -3
  65. package/data-qualities.d.ts +175 -3
  66. package/data-qualities.js +2 -3
  67. package/data-sets.d.ts +424 -3
  68. package/data-sets.js +2 -3
  69. package/data-sources.d.ts +348 -3
  70. package/data-sources.js +2 -3
  71. package/data-stores.d.ts +537 -3
  72. package/data-stores.js +2 -3
  73. package/dcaas.d.ts +192 -3
  74. package/dcaas.js +2 -3
  75. package/di-projects.d.ts +812 -4
  76. package/di-projects.js +25 -4
  77. package/direct-access-agents.d.ts +710 -4
  78. package/direct-access-agents.js +37 -5
  79. package/docs/authentication.md +1 -1
  80. package/encryption.d.ts +372 -3
  81. package/encryption.js +2 -3
  82. package/extensions.d.ts +295 -3
  83. package/extensions.js +2 -3
  84. package/global-types.d.ts +1 -1
  85. package/global-types.js +0 -2
  86. package/glossaries.d.ts +1223 -3
  87. package/glossaries.js +2 -3
  88. package/groups.d.ts +510 -3
  89. package/groups.js +2 -3
  90. package/identity-providers.d.ts +711 -3
  91. package/identity-providers.js +2 -3
  92. package/index.d.ts +78 -69
  93. package/index.js +28 -10
  94. package/interceptors.d.ts +52 -3
  95. package/interceptors.js +1 -2
  96. package/invoke-fetch-types.d.ts +1 -1
  97. package/items.d.ts +536 -3
  98. package/items.js +2 -3
  99. package/knowledgebases.d.ts +976 -3
  100. package/knowledgebases.js +2 -3
  101. package/licenses.d.ts +663 -3
  102. package/licenses.js +2 -3
  103. package/lineage-graphs.d.ts +704 -3
  104. package/lineage-graphs.js +2 -3
  105. package/ml.d.ts +2808 -3
  106. package/ml.js +2 -3
  107. package/notes.d.ts +110 -3
  108. package/notes.js +2 -3
  109. package/notifications.d.ts +98 -3
  110. package/notifications.js +2 -3
  111. package/oauth-callback.iife.js +1151 -0
  112. package/oauth-clients.d.ts +562 -3
  113. package/oauth-clients.js +2 -3
  114. package/oauth-tokens.d.ts +126 -3
  115. package/oauth-tokens.js +2 -3
  116. package/package.json +5 -4
  117. package/qix.d.ts +3 -3
  118. package/qix.js +38 -3
  119. package/questions.d.ts +364 -3
  120. package/questions.js +2 -3
  121. package/quotas.d.ts +112 -3
  122. package/quotas.js +2 -3
  123. package/reload-tasks.d.ts +249 -3
  124. package/reload-tasks.js +2 -3
  125. package/reloads.d.ts +260 -3
  126. package/reloads.js +2 -3
  127. package/report-templates.d.ts +287 -3
  128. package/report-templates.js +2 -3
  129. package/reports.d.ts +863 -3
  130. package/reports.js +2 -3
  131. package/roles.d.ts +312 -3
  132. package/roles.js +2 -3
  133. package/sharing-tasks.d.ts +1164 -3
  134. package/sharing-tasks.js +2 -3
  135. package/spaces.d.ts +779 -3
  136. package/spaces.js +2 -3
  137. package/tasks.d.ts +564 -3
  138. package/tasks.js +2 -3
  139. package/temp-contents.d.ts +167 -3
  140. package/temp-contents.js +2 -3
  141. package/tenants.d.ts +360 -3
  142. package/tenants.js +2 -3
  143. package/themes.d.ts +270 -3
  144. package/themes.js +2 -3
  145. package/transports.d.ts +435 -4
  146. package/transports.js +20 -5
  147. package/ui-config.d.ts +274 -3
  148. package/ui-config.js +2 -3
  149. package/users.d.ts +674 -3
  150. package/users.js +2 -3
  151. package/web-integrations.d.ts +294 -3
  152. package/web-integrations.js +2 -3
  153. package/web-notifications.d.ts +273 -3
  154. package/web-notifications.js +2 -3
  155. package/webhooks.d.ts +505 -3
  156. package/webhooks.js +2 -3
  157. package/chunks/api-keys-D6Rqaov4.d.ts +0 -365
  158. package/chunks/apps-BwpXUGDb.d.ts +0 -2673
  159. package/chunks/assistants-wh6Qe7l6.d.ts +0 -1366
  160. package/chunks/audits-DakwzT97.d.ts +0 -316
  161. package/chunks/auth-6mptVm5Q.d.ts +0 -95
  162. package/chunks/auth-Cle0_tmz.js +0 -32
  163. package/chunks/auth-D11iO7ZV.js +0 -65
  164. package/chunks/automation-connections-k2G_n9rj.d.ts +0 -366
  165. package/chunks/automation-connectors-J5OE-1P0.d.ts +0 -84
  166. package/chunks/automations-BGy83EBO.d.ts +0 -797
  167. package/chunks/automl-deployments-CWEpX2pk.d.ts +0 -101
  168. package/chunks/automl-predictions-BNIjRhBm.d.ts +0 -238
  169. package/chunks/banners-CgBRnZGv.d.ts +0 -184
  170. package/chunks/brands-DCgk6Gqx.d.ts +0 -671
  171. package/chunks/collections-BpYjcpIY.d.ts +0 -582
  172. package/chunks/conditions-CJJG7Uph.d.ts +0 -662
  173. package/chunks/consumption-DerFk437.d.ts +0 -182
  174. package/chunks/core-DQXNZdnf.d.ts +0 -12
  175. package/chunks/csp-origins-3NJlh_n9.d.ts +0 -273
  176. package/chunks/csrf-token-DoaoOQzH.d.ts +0 -63
  177. package/chunks/data-alerts-CILSEFbQ.d.ts +0 -1004
  178. package/chunks/data-assets-CJDcssoX.d.ts +0 -207
  179. package/chunks/data-connections-VSB13K6g.d.ts +0 -678
  180. package/chunks/data-credentials-ChEp_hyU.d.ts +0 -292
  181. package/chunks/data-files-CVzn9M6V.d.ts +0 -860
  182. package/chunks/data-qualities-DBrot957.d.ts +0 -176
  183. package/chunks/data-sets-CFzxgWnO.d.ts +0 -424
  184. package/chunks/data-sources-IsAaof_C.d.ts +0 -346
  185. package/chunks/data-stores-DFOPdgfz.d.ts +0 -537
  186. package/chunks/dcaas-qyv7YlrN.d.ts +0 -192
  187. package/chunks/di-projects-DVQTxASr.d.ts +0 -777
  188. package/chunks/direct-access-agents-B77OhzZi.d.ts +0 -580
  189. package/chunks/encryption-BjA6xbCO.d.ts +0 -372
  190. package/chunks/extensions-OO0WtInj.d.ts +0 -294
  191. package/chunks/glossaries-CIX7-KT_.d.ts +0 -1213
  192. package/chunks/groups-C86-UG7S.d.ts +0 -511
  193. package/chunks/identity-providers-h0dKNxGZ.d.ts +0 -711
  194. package/chunks/interceptors-Csx2tEi5.d.ts +0 -52
  195. package/chunks/interceptors-DTYm37AU.js +0 -104
  196. package/chunks/ip-policies-CKRIlbP7.d.ts +0 -327
  197. package/chunks/ip-policies-DXlf172B.js +0 -108
  198. package/chunks/items-C-jzqvFW.d.ts +0 -536
  199. package/chunks/knowledgebases-CyQtVcZN.d.ts +0 -977
  200. package/chunks/licenses-xzjnkitW.d.ts +0 -663
  201. package/chunks/lineage-graphs-CViCCzKy.d.ts +0 -697
  202. package/chunks/ml-Abt2MUva.d.ts +0 -2809
  203. package/chunks/notes-BZxuyDgt.d.ts +0 -111
  204. package/chunks/notifications-Bd_gp4jU.d.ts +0 -99
  205. package/chunks/oauth-clients-B5QPr4IM.d.ts +0 -563
  206. package/chunks/oauth-tokens-1b7V8182.d.ts +0 -127
  207. package/chunks/qix-CYQsLyGQ.js +0 -40
  208. package/chunks/questions-BVp0tvNs.d.ts +0 -364
  209. package/chunks/quotas-CfAebRJd.d.ts +0 -113
  210. package/chunks/reload-tasks-DfwUTetn.d.ts +0 -249
  211. package/chunks/reloads-CwmagnFx.d.ts +0 -260
  212. package/chunks/report-templates-DjQYj5dn.d.ts +0 -287
  213. package/chunks/reports-DzNC6Uq3.d.ts +0 -861
  214. package/chunks/roles-BYFIY6E7.d.ts +0 -312
  215. package/chunks/sharing-tasks-BMGIQ-FO.d.ts +0 -1164
  216. package/chunks/spaces-BK823t-b.d.ts +0 -780
  217. package/chunks/tasks-COKDfShO.d.ts +0 -564
  218. package/chunks/temp-contents-zDomB-g6.d.ts +0 -168
  219. package/chunks/tenants-Bhn86519.d.ts +0 -361
  220. package/chunks/themes-v9NbhiBo.d.ts +0 -269
  221. package/chunks/transports-CqEiFxD3.d.ts +0 -362
  222. package/chunks/ui-config-Crs0mVMp.d.ts +0 -274
  223. package/chunks/users-BSOBU_fg.d.ts +0 -675
  224. package/chunks/web-integrations-MisPAHod.d.ts +0 -295
  225. package/chunks/web-notifications-DVy6FHYh.d.ts +0 -274
  226. package/chunks/webhooks-Dr4EiXqy.d.ts +0 -505
  227. /package/chunks/{auth-types-E99tzdN0.d.ts → auth-types-YrlH_R9f.d.ts} +0 -0
  228. /package/chunks/{auth-types-JehqruDP.js → auth-types-h43TVDpB.js} +0 -0
  229. /package/chunks/{global-types-CrOvI33z.js → global-types-CEVAJebk.js} +0 -0
  230. /package/chunks/{invoke-fetch-CbU2Dgqr.d.ts → invoke-fetch-C1Z0RJYU.d.ts} +0 -0
  231. /package/chunks/{utils-BnC4lrlq.js → utils-vv-xFm06.js} +0 -0
  232. /package/chunks/{websocket-errors-DSbO6kDZ.js → websocket-errors-CRTDTtBL.js} +0 -0
@@ -1,4 +1,710 @@
1
- import "./chunks/auth-types-E99tzdN0.js";
2
- import "./chunks/invoke-fetch-CbU2Dgqr.js";
3
- import { $ as UpdateDirectAccessAgentConnectorFileWithoutQueryHttpError, A as GetDirectAccessAgentConnectorsFileConnectorFilesAllowedPathsHttpResponse, B as PatchDirectAccessAgentConfigurationHttpResponse, C as GetDirectAccessAgentConnectorFileHttpError, D as GetDirectAccessAgentConnectorFilesWithoutQueryHttpError, E as GetDirectAccessAgentConnectorFilesHttpResponse, F as OdbcCustomDataTypeResponse, G as PutDirectAccessAgentConnectorsOdbcConnectorFilesCustomDataTypeMappingsHttpError, H as PatchOperationValidationResult, I as Operation, J as RestartDirectAccessAgentHttpResponse, K as PutDirectAccessAgentConnectorsOdbcConnectorFilesCustomDataTypeMappingsHttpResponse, L as PatchDirectAccessAgentConfiguration204HttpResponse, M as GetDirectAccessAgentConnectorsOdbcConnectorFilesCustomDataTypeMappingsHttpResponse, N as LinkResponseObject, O as GetDirectAccessAgentConnectorFilesWithoutQueryHttpResponse, P as OdbcCustomDataType, Q as UpdateDirectAccessAgentConnectorFileHttpResponse, R as PatchDirectAccessAgentConfiguration207HttpResponse, S as GetDirectAccessAgentConfigurationHttpResponse, T as GetDirectAccessAgentConnectorFilesHttpError, U as PutDirectAccessAgentConnectorsFileConnectorFilesAllowedPathsHttpError, V as PatchOperationResponse, W as PutDirectAccessAgentConnectorsFileConnectorFilesAllowedPathsHttpResponse, X as UpdateConfigurationFlatFileRequest, Y as RunBenchmarkResponse, Z as UpdateDirectAccessAgentConnectorFileHttpError, _ as GetBenchmarkStatusResponse, _t as restartDirectAccessAgent, a as ConfigurationResponse, at as createDirectAccessAgentBenchmarkCancel, b as GetDirectAccessAgentBenchmarkHttpResponse, c as CreateDirectAccessAgentBenchmarkCancelHttpError, ct as getDirectAccessAgentConfiguration, d as CreateDirectAccessAgentBenchmarkHttpResponse, dt as getDirectAccessAgentConnectorFilesWithoutQuery, et as UpdateDirectAccessAgentConnectorFileWithoutQueryHttpResponse, f as DirectAccessAgentsAPI, ft as getDirectAccessAgentConnectorsFileConnectorFilesAllowedPaths, g as FileConnectorAllowedPathsResponse, gt as putDirectAccessAgentConnectorsOdbcConnectorFilesCustomDataTypeMappings, h as FileConnectorAllowedPath, ht as putDirectAccessAgentConnectorsFileConnectorFilesAllowedPaths, i as ConfigurationLineString, it as createDirectAccessAgentBenchmark, j as GetDirectAccessAgentConnectorsOdbcConnectorFilesCustomDataTypeMappingsHttpError, k as GetDirectAccessAgentConnectorsFileConnectorFilesAllowedPathsHttpError, l as CreateDirectAccessAgentBenchmarkCancelHttpResponse, lt as getDirectAccessAgentConnectorFile, m as ErrorResponse, mt as patchDirectAccessAgentConfiguration, n as ConfigurationLineBase, nt as UpdateOdbcCustomTypeMappingsRequest, o as ConnectorFlatFileConfigurationResponse, ot as directAccessAgentsExport, p as ErrorMessage, pt as getDirectAccessAgentConnectorsOdbcConnectorFilesCustomDataTypeMappings, q as RestartDirectAccessAgentHttpError, r as ConfigurationLineNumeric, rt as clearCache, s as ConnectorSettings, st as getDirectAccessAgentBenchmark, t as CancelBenchmarkResponse, tt as UpdateFileConnectorAllowedPathsRequest, u as CreateDirectAccessAgentBenchmarkHttpError, ut as getDirectAccessAgentConnectorFiles, v as GetBenchmarkStatusResults, vt as updateDirectAccessAgentConnectorFile, w as GetDirectAccessAgentConnectorFileHttpResponse, x as GetDirectAccessAgentConfigurationHttpError, y as GetDirectAccessAgentBenchmarkHttpError, yt as updateDirectAccessAgentConnectorFileWithoutQuery, z as PatchDirectAccessAgentConfigurationHttpError } from "./chunks/direct-access-agents-B77OhzZi.js";
4
- export { CancelBenchmarkResponse, ConfigurationLineBase, ConfigurationLineNumeric, ConfigurationLineString, ConfigurationResponse, ConnectorFlatFileConfigurationResponse, ConnectorSettings, CreateDirectAccessAgentBenchmarkCancelHttpError, CreateDirectAccessAgentBenchmarkCancelHttpResponse, CreateDirectAccessAgentBenchmarkHttpError, CreateDirectAccessAgentBenchmarkHttpResponse, DirectAccessAgentsAPI, ErrorMessage, ErrorResponse, FileConnectorAllowedPath, FileConnectorAllowedPathsResponse, GetBenchmarkStatusResponse, GetBenchmarkStatusResults, GetDirectAccessAgentBenchmarkHttpError, GetDirectAccessAgentBenchmarkHttpResponse, GetDirectAccessAgentConfigurationHttpError, GetDirectAccessAgentConfigurationHttpResponse, GetDirectAccessAgentConnectorFileHttpError, GetDirectAccessAgentConnectorFileHttpResponse, GetDirectAccessAgentConnectorFilesHttpError, GetDirectAccessAgentConnectorFilesHttpResponse, GetDirectAccessAgentConnectorFilesWithoutQueryHttpError, GetDirectAccessAgentConnectorFilesWithoutQueryHttpResponse, GetDirectAccessAgentConnectorsFileConnectorFilesAllowedPathsHttpError, GetDirectAccessAgentConnectorsFileConnectorFilesAllowedPathsHttpResponse, GetDirectAccessAgentConnectorsOdbcConnectorFilesCustomDataTypeMappingsHttpError, GetDirectAccessAgentConnectorsOdbcConnectorFilesCustomDataTypeMappingsHttpResponse, LinkResponseObject, OdbcCustomDataType, OdbcCustomDataTypeResponse, Operation, PatchDirectAccessAgentConfiguration204HttpResponse, PatchDirectAccessAgentConfiguration207HttpResponse, PatchDirectAccessAgentConfigurationHttpError, PatchDirectAccessAgentConfigurationHttpResponse, PatchOperationResponse, PatchOperationValidationResult, PutDirectAccessAgentConnectorsFileConnectorFilesAllowedPathsHttpError, PutDirectAccessAgentConnectorsFileConnectorFilesAllowedPathsHttpResponse, PutDirectAccessAgentConnectorsOdbcConnectorFilesCustomDataTypeMappingsHttpError, PutDirectAccessAgentConnectorsOdbcConnectorFilesCustomDataTypeMappingsHttpResponse, RestartDirectAccessAgentHttpError, RestartDirectAccessAgentHttpResponse, RunBenchmarkResponse, UpdateConfigurationFlatFileRequest, UpdateDirectAccessAgentConnectorFileHttpError, UpdateDirectAccessAgentConnectorFileHttpResponse, UpdateDirectAccessAgentConnectorFileWithoutQueryHttpError, UpdateDirectAccessAgentConnectorFileWithoutQueryHttpResponse, UpdateFileConnectorAllowedPathsRequest, UpdateOdbcCustomTypeMappingsRequest, clearCache, createDirectAccessAgentBenchmark, createDirectAccessAgentBenchmarkCancel, directAccessAgentsExport as default, getDirectAccessAgentBenchmark, getDirectAccessAgentConfiguration, getDirectAccessAgentConnectorFile, getDirectAccessAgentConnectorFiles, getDirectAccessAgentConnectorFilesWithoutQuery, getDirectAccessAgentConnectorsFileConnectorFilesAllowedPaths, getDirectAccessAgentConnectorsOdbcConnectorFilesCustomDataTypeMappings, patchDirectAccessAgentConfiguration, putDirectAccessAgentConnectorsFileConnectorFilesAllowedPaths, putDirectAccessAgentConnectorsOdbcConnectorFilesCustomDataTypeMappings, restartDirectAccessAgent, updateDirectAccessAgentConnectorFile, updateDirectAccessAgentConnectorFileWithoutQuery };
1
+ import { y as ApiCallOptions } from "./chunks/auth-types-YrlH_R9f.js";
2
+ import "./chunks/invoke-fetch-C1Z0RJYU.js";
3
+
4
+ //#region src/public/rest/direct-access-agents.d.ts
5
+ type CancelBenchmarkResponse = {
6
+ message?: string;
7
+ statusUrl?: LinkResponseObject;
8
+ };
9
+ type ConfigurationLineBase = ConfigurationLineNumeric | ConfigurationLineString;
10
+ type ConfigurationLineNumeric = {
11
+ allowMultipleValues?: boolean;
12
+ apiActions?: ("Read" | "Write")[];
13
+ applyWithoutRestart?: boolean;
14
+ connector?: string;
15
+ defaultValue?: string;
16
+ description?: string;
17
+ displayName?: string;
18
+ name?: string;
19
+ pendingApplication?: boolean;
20
+ pendingValue?: string;
21
+ permittedRangeEnd?: number;
22
+ permittedRangeStart?: number;
23
+ uiActions?: ("Read" | "Write")[];
24
+ value?: string;
25
+ };
26
+ type ConfigurationLineString = {
27
+ allowMultipleValues?: boolean;
28
+ apiActions?: ("Read" | "Write")[];
29
+ applyWithoutRestart?: boolean;
30
+ connector?: string;
31
+ defaultValue?: string;
32
+ description?: string;
33
+ displayName?: string;
34
+ name?: string;
35
+ pendingApplication?: boolean;
36
+ pendingValue?: string;
37
+ permittedValues?: string[];
38
+ uiActions?: ("Read" | "Write")[];
39
+ value?: string;
40
+ };
41
+ type ConfigurationResponse = {
42
+ connectorAgentSettings?: ConfigurationLineBase[];
43
+ connectors?: ConnectorSettings[];
44
+ dcaasSettings?: ConfigurationLineBase[];
45
+ };
46
+ type ConnectorFlatFileConfigurationResponse = {
47
+ errorMessage?: ErrorResponse;
48
+ result?: string[];
49
+ };
50
+ type ConnectorSettings = {
51
+ connectorName?: string;
52
+ settings?: ConfigurationLineBase[];
53
+ };
54
+ type ErrorMessage = {
55
+ code?: string;
56
+ detail?: string;
57
+ title?: string;
58
+ };
59
+ type ErrorResponse = {
60
+ errors?: ErrorMessage[];
61
+ readonly hasErrors?: boolean;
62
+ traceId?: string;
63
+ };
64
+ type FileConnectorAllowedPath = {
65
+ /** The Path property in the File connector allowed paths file. */
66
+ path: string;
67
+ /** The Spaces property in the Odbc custom type mappings file. */
68
+ spaces?: string[];
69
+ };
70
+ type FileConnectorAllowedPathsResponse = {
71
+ errorMessage?: ErrorResponse;
72
+ result?: FileConnectorAllowedPath[];
73
+ };
74
+ type GetBenchmarkStatusResponse = {
75
+ /** The ISO 8601 formatted timestamp when the benchmark task completed or was cancelled */
76
+ benchmarkEndTime?: string;
77
+ /** The benchmark ID */
78
+ benchmarkId?: string;
79
+ /** The ISO 8601 formatted timestamp when the benchmark task started execution */
80
+ benchmarkStartTime?: string;
81
+ results?: GetBenchmarkStatusResults;
82
+ /** The benchmark status */
83
+ status?: string;
84
+ /** Additional details about the benchmark status */
85
+ statusMessage?: string;
86
+ /** The total bytes requested to be transferred during the benchmark */
87
+ totalBytesRequested?: number;
88
+ };
89
+ type GetBenchmarkStatusResults = {
90
+ /** The ISO 8601 formatted timestamp when data transmission completed */
91
+ dataTransmissionEndTime?: string;
92
+ /** The ISO 8601 formatted timestamp when data transmission start */
93
+ dataTransmissionStartTime?: string;
94
+ /** The latency in ms measured during data transmission */
95
+ latency?: number;
96
+ /** The data throughput in KB/s measured during data transmission */
97
+ throughput?: number;
98
+ /** The total number of bytes successfully transferred during data transmission */
99
+ totalBytesTransferred?: number;
100
+ };
101
+ type LinkResponseObject = {
102
+ /** The URL to the related resource */
103
+ href?: string;
104
+ };
105
+ type MetricsCollectorConnectorConfigurationApiResponse = {
106
+ /** Indicates whether metrics collection is enabled for this connector. */
107
+ metricsCollectionEnabled: boolean;
108
+ /** Frequency in seconds at which metrics are collected from this connector. */
109
+ scrapeIntervalSeconds: number;
110
+ };
111
+ type MetricsCollectorConnectorConfigurationsApiResponse = {
112
+ connectorAgent?: MetricsCollectorConnectorConfigurationApiResponse;
113
+ fileConnector?: MetricsCollectorConnectorConfigurationApiResponse;
114
+ odbcConnector?: MetricsCollectorConnectorConfigurationApiResponse;
115
+ restConnector?: MetricsCollectorConnectorConfigurationApiResponse;
116
+ sapBwConnector?: MetricsCollectorConnectorConfigurationApiResponse;
117
+ sapPackageConnector?: MetricsCollectorConnectorConfigurationApiResponse;
118
+ sapSqlConnector?: MetricsCollectorConnectorConfigurationApiResponse;
119
+ systemMetrics?: MetricsCollectorConnectorConfigurationApiResponse;
120
+ };
121
+ type MetricsCollectorIndividualConnectorConfigurationRequest = {
122
+ /** Indicates whether metrics collection is enabled for this connector. */
123
+ metricsCollectionEnabled: boolean;
124
+ /** Frequency in seconds at which metrics are collected from this connector. */
125
+ scrapeIntervalSeconds: number;
126
+ };
127
+ type MetricsCollectorSettings = {
128
+ /** The base interval in seconds for the metrics collection loop.
129
+ * This defines how frequently the collector checks whether to scrape each connector, not the interval at which each connector is scraped. Must be equal to or less than the lowest individual connector scrape interval. */
130
+ baseScrapeIntervalSeconds: number;
131
+ /** The interval in minutes the metrics collector checks for and deletes old data. */
132
+ dataRetentionCheckIntervalMinutes: number;
133
+ /** Indicates whether the metrics collector is enabled. */
134
+ enabled: boolean;
135
+ /** The number of days to retain local data. */
136
+ localDataRetentionDays: number;
137
+ /** The file location for the local metrics database. If not specified, defaults to `C:\ProgramData\Qlik\Gateway\tmp`. */
138
+ localDatabaseFileLocation?: string;
139
+ /** The port number that the metrics collector API will run on.
140
+ * This must match the port that the SYSTEM connector runs on to enable network metrics collection. */
141
+ port: number;
142
+ };
143
+ type MetricsCollectorSettingsApiResponse = {
144
+ connectorConfigurations?: MetricsCollectorConnectorConfigurationsApiResponse;
145
+ metricsCollectorSettings?: MetricsCollectorSettings;
146
+ };
147
+ type MetricsCollectorSettingsApiResponseConnectorConfigurationResponse = {
148
+ errorMessage?: ErrorResponse;
149
+ result?: MetricsCollectorSettingsApiResponse;
150
+ };
151
+ type OdbcCustomDataType = {
152
+ /** The IsBit property in the ODBC custom data type mapping file. */
153
+ bit?: boolean;
154
+ /** The Identifier property in the ODBC custom data type mapping file. */
155
+ id: string;
156
+ /** The NativeDataType property in the ODBC custom data type mapping file. */
157
+ nativeDataType: string;
158
+ /** The QlikDataType property in the ODBC custom data type mapping file. */
159
+ qlikDataType: string;
160
+ /** The Size property in the ODBC custom data type mapping file. */
161
+ size?: number;
162
+ };
163
+ type OdbcCustomDataTypeResponse = {
164
+ errorMessage?: ErrorResponse;
165
+ result?: OdbcCustomDataType[];
166
+ };
167
+ type Operation = {
168
+ op: "add" | "replace" | "remove";
169
+ 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" | "REST_ALLOW_LOCALHOST_CONNECTION" | "OPTIONAL_CAPABILITIES";
170
+ value: string;
171
+ };
172
+ type PatchOperationResponse = {
173
+ data?: PatchOperationValidationResult[];
174
+ errorMessage?: string;
175
+ failedPatchError?: ErrorResponse;
176
+ httpStatusCode?: number;
177
+ };
178
+ type PatchOperationValidationResult = {
179
+ operation?: Operation;
180
+ valid?: boolean;
181
+ validationResult?: string;
182
+ };
183
+ type RunBenchmarkResponse = {
184
+ benchmarkId?: string;
185
+ };
186
+ /**
187
+ * The request to update a connector flat file
188
+ */
189
+ type UpdateConfigurationFlatFileRequest = {
190
+ contentsToSave?: string[];
191
+ };
192
+ /**
193
+ * The request to update file connector allowed paths configuration
194
+ */
195
+ type UpdateFileConnectorAllowedPathsRequest = {
196
+ fileConnectorAllowedPaths?: FileConnectorAllowedPath[];
197
+ };
198
+ type UpdateMetricsCollectorConnectorConfigurationsRequest = {
199
+ connectorAgent: MetricsCollectorIndividualConnectorConfigurationRequest;
200
+ fileConnector: MetricsCollectorIndividualConnectorConfigurationRequest;
201
+ odbcConnector: MetricsCollectorIndividualConnectorConfigurationRequest;
202
+ restConnector: MetricsCollectorIndividualConnectorConfigurationRequest;
203
+ sapBwConnector: MetricsCollectorIndividualConnectorConfigurationRequest;
204
+ sapPackageConnector: MetricsCollectorIndividualConnectorConfigurationRequest;
205
+ sapSqlConnector: MetricsCollectorIndividualConnectorConfigurationRequest;
206
+ systemMetrics: MetricsCollectorIndividualConnectorConfigurationRequest;
207
+ };
208
+ type UpdateMetricsCollectorSettings = {
209
+ /** The base interval in seconds for the metrics collection loop.
210
+ * This defines how frequently the collector checks whether to scrape each connector, not the interval at which each connector is scraped. Must be equal to or less than the lowest individual connector scrape interval. */
211
+ baseScrapeIntervalSeconds: number;
212
+ /** The interval in minutes the metrics collector checks for and deletes old data. */
213
+ dataRetentionCheckIntervalMinutes: number;
214
+ /** Indicates whether the metrics collector is enabled. */
215
+ enabled: boolean;
216
+ /** The number of days to retain local data. */
217
+ localDataRetentionDays: number;
218
+ /** The file location for the local metrics database. If not specified, defaults to `C:\ProgramData\Qlik\Gateway\tmp`. */
219
+ localDatabaseFileLocation: string;
220
+ /** The port number that the metrics collector API will run on.
221
+ * This must match the port that the SYSTEM connector runs on to enable network metrics collection. */
222
+ port: number;
223
+ };
224
+ type UpdateMetricsCollectorSettingsRequest = {
225
+ connectorConfigurations: UpdateMetricsCollectorConnectorConfigurationsRequest;
226
+ metricsCollectorSettings: UpdateMetricsCollectorSettings;
227
+ };
228
+ type UpdateOdbcCustomTypeMappingsRequest = {
229
+ odbcCustomDataTypes?: OdbcCustomDataType[];
230
+ };
231
+ /**
232
+ * 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+.
233
+ *
234
+ * @param agentId The agent ID
235
+ * @param agentAction The type of action to perform. Permitted values are `restart` (will not restart the agent if a reload is in `RELOADING` status) and `force-restart` (will restart the agent even if a reload is in `RELOADING` status).
236
+ * @throws RestartDirectAccessAgentHttpError
237
+ */
238
+ declare function restartDirectAccessAgent(agentId: string, agentAction: string, options?: ApiCallOptions): Promise<RestartDirectAccessAgentHttpResponse>;
239
+ type RestartDirectAccessAgentHttpResponse = {
240
+ data: void;
241
+ headers: Headers;
242
+ status: 204;
243
+ };
244
+ type RestartDirectAccessAgentHttpError = {
245
+ data: ErrorResponse;
246
+ headers: Headers;
247
+ status: 400 | 403 | 404 | 409 | 500;
248
+ };
249
+ /**
250
+ * Starts a background benchmark task to measure the performance of a Direct Access agent. Use this endpoint to evaluate agent throughput and latency for capacity planning and performance optimization. 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.8+.
251
+ *
252
+ * @param agentId The agent ID
253
+ * @param query an object with query parameters
254
+ * @throws CreateDirectAccessAgentBenchmarkHttpError
255
+ */
256
+ declare function createDirectAccessAgentBenchmark(agentId: string, query: {
257
+ /** Forces the benchmark to start regardless of the state of the agent. Does not override QCS resource limits. Use with caution. */
258
+ force?: boolean;
259
+ /** The volume of data in GB to transfer during the throughput measurement part of the benchmark. */
260
+ gigaBytesToTransfer?: number;
261
+ }, options?: ApiCallOptions): Promise<CreateDirectAccessAgentBenchmarkHttpResponse>;
262
+ type CreateDirectAccessAgentBenchmarkHttpResponse = {
263
+ data: RunBenchmarkResponse;
264
+ headers: Headers;
265
+ status: 201;
266
+ };
267
+ type CreateDirectAccessAgentBenchmarkHttpError = {
268
+ data: ErrorResponse;
269
+ headers: Headers;
270
+ status: 403 | 404 | 500 | 501 | 503;
271
+ };
272
+ /**
273
+ * Retrieves the current status and progress of a running or completed benchmark task. Use this endpoint to monitor benchmark execution and retrieve performance metrics once the task is completed. 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.8+.
274
+ *
275
+ * @param agentId The agent ID
276
+ * @param benchmarkId The benchmark ID
277
+ * @throws GetDirectAccessAgentBenchmarkHttpError
278
+ */
279
+ declare function getDirectAccessAgentBenchmark(agentId: string, benchmarkId: string, options?: ApiCallOptions): Promise<GetDirectAccessAgentBenchmarkHttpResponse>;
280
+ type GetDirectAccessAgentBenchmarkHttpResponse = {
281
+ data: GetBenchmarkStatusResponse;
282
+ headers: Headers;
283
+ status: 200;
284
+ };
285
+ type GetDirectAccessAgentBenchmarkHttpError = {
286
+ data: ErrorResponse;
287
+ headers: Headers;
288
+ status: 403 | 404 | 500 | 503;
289
+ };
290
+ /**
291
+ * Requests a cancellation on a running benchmark by id for the specified agent. 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.8+.
292
+ *
293
+ * @param agentId The agent ID
294
+ * @param benchmarkId The benchmark ID
295
+ * @throws CreateDirectAccessAgentBenchmarkCancelHttpError
296
+ */
297
+ declare function createDirectAccessAgentBenchmarkCancel(agentId: string, benchmarkId: string, options?: ApiCallOptions): Promise<CreateDirectAccessAgentBenchmarkCancelHttpResponse>;
298
+ type CreateDirectAccessAgentBenchmarkCancelHttpResponse = {
299
+ data: CancelBenchmarkResponse;
300
+ headers: Headers;
301
+ status: 202;
302
+ };
303
+ type CreateDirectAccessAgentBenchmarkCancelHttpError = {
304
+ data: ErrorResponse;
305
+ headers: Headers;
306
+ status: 403 | 404 | 500 | 503;
307
+ };
308
+ /**
309
+ * Retrieves the connector agent configuration from the specified agent. 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+.
310
+ *
311
+ * @param agentId The agent ID
312
+ * @param query an object with query parameters
313
+ * @throws GetDirectAccessAgentConfigurationHttpError
314
+ */
315
+ declare function getDirectAccessAgentConfiguration(agentId: string, query: {
316
+ /** Individual properties within the agent configuration */
317
+ queryProperties?: string[];
318
+ }, options?: ApiCallOptions): Promise<GetDirectAccessAgentConfigurationHttpResponse>;
319
+ type GetDirectAccessAgentConfigurationHttpResponse = {
320
+ data: ConfigurationResponse;
321
+ headers: Headers;
322
+ status: 200;
323
+ };
324
+ type GetDirectAccessAgentConfigurationHttpError = {
325
+ data: ErrorResponse;
326
+ headers: Headers;
327
+ status: 403 | 404;
328
+ };
329
+ /**
330
+ * Makes changes to the local agent configuration using JSON Patch. 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+.
331
+ *
332
+ * @param agentId The agent ID
333
+ * @param body an object with the body content
334
+ * @throws PatchDirectAccessAgentConfigurationHttpError
335
+ */
336
+ declare function patchDirectAccessAgentConfiguration(agentId: string, body: Operation[], options?: ApiCallOptions): Promise<PatchDirectAccessAgentConfigurationHttpResponse>;
337
+ type PatchDirectAccessAgentConfigurationHttpResponse = PatchDirectAccessAgentConfiguration204HttpResponse | PatchDirectAccessAgentConfiguration207HttpResponse;
338
+ type PatchDirectAccessAgentConfiguration204HttpResponse = {
339
+ data: void;
340
+ headers: Headers;
341
+ status: 204;
342
+ };
343
+ type PatchDirectAccessAgentConfiguration207HttpResponse = {
344
+ data: PatchOperationResponse;
345
+ headers: Headers;
346
+ status: 207;
347
+ };
348
+ type PatchDirectAccessAgentConfigurationHttpError = {
349
+ data: ErrorResponse;
350
+ headers: Headers;
351
+ status: 400 | 403 | 404 | 415;
352
+ };
353
+ /**
354
+ * Retrieves the allowed paths settings for the File Connector. Requestor must be assigned the `TenantAdmin` role. Available in Direct Access Gateway V1.7.6+.
355
+ *
356
+ * @param agentId The agent ID
357
+ * @throws GetDirectAccessAgentConnectorsFileConnectorFilesAllowedPathsHttpError
358
+ */
359
+ declare function getDirectAccessAgentConnectorsFileConnectorFilesAllowedPaths(agentId: string, options?: ApiCallOptions): Promise<GetDirectAccessAgentConnectorsFileConnectorFilesAllowedPathsHttpResponse>;
360
+ type GetDirectAccessAgentConnectorsFileConnectorFilesAllowedPathsHttpResponse = {
361
+ data: FileConnectorAllowedPathsResponse;
362
+ headers: Headers;
363
+ status: 200;
364
+ };
365
+ type GetDirectAccessAgentConnectorsFileConnectorFilesAllowedPathsHttpError = {
366
+ data: ErrorResponse;
367
+ headers: Headers;
368
+ status: 404;
369
+ };
370
+ /**
371
+ * Completely replaces the contents of the allowed paths configuration file for the File Connector. Partial updates are not supported. Requestor must be assigned the `TenantAdmin` role. Available in Direct Access Gateway V1.7.6+.
372
+ *
373
+ * @param agentId The agent id
374
+ * @param body an object with the body content
375
+ * @throws PutDirectAccessAgentConnectorsFileConnectorFilesAllowedPathsHttpError
376
+ */
377
+ declare function putDirectAccessAgentConnectorsFileConnectorFilesAllowedPaths(agentId: string, body: UpdateFileConnectorAllowedPathsRequest, options?: ApiCallOptions): Promise<PutDirectAccessAgentConnectorsFileConnectorFilesAllowedPathsHttpResponse>;
378
+ type PutDirectAccessAgentConnectorsFileConnectorFilesAllowedPathsHttpResponse = {
379
+ data: void;
380
+ headers: Headers;
381
+ status: 204;
382
+ };
383
+ type PutDirectAccessAgentConnectorsFileConnectorFilesAllowedPathsHttpError = {
384
+ data: ErrorResponse;
385
+ headers: Headers;
386
+ status: 400 | 404 | 409;
387
+ };
388
+ /**
389
+ * Retrieves the 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+.
390
+ *
391
+ * @param agentId The agent ID.
392
+ * @throws GetDirectAccessAgentConnectorsOdbcConnectorFilesCustomDataTypeMappingsHttpError
393
+ */
394
+ declare function getDirectAccessAgentConnectorsOdbcConnectorFilesCustomDataTypeMappings(agentId: string, options?: ApiCallOptions): Promise<GetDirectAccessAgentConnectorsOdbcConnectorFilesCustomDataTypeMappingsHttpResponse>;
395
+ type GetDirectAccessAgentConnectorsOdbcConnectorFilesCustomDataTypeMappingsHttpResponse = {
396
+ data: OdbcCustomDataTypeResponse;
397
+ headers: Headers;
398
+ status: 200;
399
+ };
400
+ type GetDirectAccessAgentConnectorsOdbcConnectorFilesCustomDataTypeMappingsHttpError = {
401
+ data: ErrorResponse;
402
+ headers: Headers;
403
+ status: 404;
404
+ };
405
+ /**
406
+ * 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+.
407
+ *
408
+ * @param agentId The agent ID.
409
+ * @param body an object with the body content
410
+ * @throws PutDirectAccessAgentConnectorsOdbcConnectorFilesCustomDataTypeMappingsHttpError
411
+ */
412
+ declare function putDirectAccessAgentConnectorsOdbcConnectorFilesCustomDataTypeMappings(agentId: string, body: UpdateOdbcCustomTypeMappingsRequest, options?: ApiCallOptions): Promise<PutDirectAccessAgentConnectorsOdbcConnectorFilesCustomDataTypeMappingsHttpResponse>;
413
+ type PutDirectAccessAgentConnectorsOdbcConnectorFilesCustomDataTypeMappingsHttpResponse = {
414
+ data: void;
415
+ headers: Headers;
416
+ status: 204;
417
+ };
418
+ type PutDirectAccessAgentConnectorsOdbcConnectorFilesCustomDataTypeMappingsHttpError = {
419
+ data: ErrorResponse;
420
+ headers: Headers;
421
+ status: 400 | 404 | 409;
422
+ };
423
+ /**
424
+ * Retrieves the configuration files associated with the 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+.
425
+ *
426
+ * @param agentId The agent ID
427
+ * @param connectorType The connector to retrieve the list of files for
428
+ * @param query an object with query parameters
429
+ * @throws GetDirectAccessAgentConnectorFilesHttpError
430
+ */
431
+ declare function getDirectAccessAgentConnectorFiles(agentId: string, connectorType: string, query: Record<string, unknown>, options?: ApiCallOptions): Promise<GetDirectAccessAgentConnectorFilesHttpResponse>;
432
+ type GetDirectAccessAgentConnectorFilesHttpResponse = {
433
+ data: ConnectorFlatFileConfigurationResponse;
434
+ headers: Headers;
435
+ status: 200;
436
+ };
437
+ type GetDirectAccessAgentConnectorFilesHttpError = {
438
+ data: ErrorResponse;
439
+ headers: Headers;
440
+ status: 403 | 404;
441
+ };
442
+ /**
443
+ * Retrieves the configuration files associated with the 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+.
444
+ *
445
+ * @param agentId The agent ID
446
+ * @param connectorType The connector to retrieve the list of files for
447
+ * @throws GetDirectAccessAgentConnectorFilesWithoutQueryHttpError
448
+ */
449
+ declare function getDirectAccessAgentConnectorFilesWithoutQuery(agentId: string, connectorType: string, options?: ApiCallOptions): Promise<GetDirectAccessAgentConnectorFilesWithoutQueryHttpResponse>;
450
+ type GetDirectAccessAgentConnectorFilesWithoutQueryHttpResponse = {
451
+ data: ConnectorFlatFileConfigurationResponse;
452
+ headers: Headers;
453
+ status: 200;
454
+ };
455
+ type GetDirectAccessAgentConnectorFilesWithoutQueryHttpError = {
456
+ data: ErrorResponse;
457
+ headers: Headers;
458
+ status: 403 | 404;
459
+ };
460
+ /**
461
+ * 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+.
462
+ *
463
+ * @param agentId The agent ID
464
+ * @param connectorType The connector type to retrieve
465
+ * @param fileType The type of file to retrieve
466
+ * @throws GetDirectAccessAgentConnectorFileHttpError
467
+ */
468
+ declare function getDirectAccessAgentConnectorFile(agentId: string, connectorType: string, fileType: string, options?: ApiCallOptions): Promise<GetDirectAccessAgentConnectorFileHttpResponse>;
469
+ type GetDirectAccessAgentConnectorFileHttpResponse = {
470
+ data: ConnectorFlatFileConfigurationResponse;
471
+ headers: Headers;
472
+ status: 200;
473
+ };
474
+ type GetDirectAccessAgentConnectorFileHttpError = {
475
+ data: ErrorResponse;
476
+ headers: Headers;
477
+ status: 403 | 404;
478
+ };
479
+ /**
480
+ * Completely replaces the contents of the connector's configuration file. Partial updates are not supported. 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+.
481
+ *
482
+ * @param agentId The agent ID
483
+ * @param connectorType The connector type to update
484
+ * @param fileType The file type to update
485
+ * @param query an object with query parameters
486
+ * @param body an object with the body content
487
+ * @throws UpdateDirectAccessAgentConnectorFileHttpError
488
+ */
489
+ declare function updateDirectAccessAgentConnectorFile(agentId: string, connectorType: string, fileType: string, query: Record<string, unknown>, body: UpdateConfigurationFlatFileRequest, options?: ApiCallOptions): Promise<UpdateDirectAccessAgentConnectorFileHttpResponse>;
490
+ type UpdateDirectAccessAgentConnectorFileHttpResponse = {
491
+ data: void;
492
+ headers: Headers;
493
+ status: 204;
494
+ };
495
+ type UpdateDirectAccessAgentConnectorFileHttpError = {
496
+ data: ErrorResponse;
497
+ headers: Headers;
498
+ status: 400 | 404 | 409;
499
+ };
500
+ /**
501
+ * Completely replaces the contents of the connector's configuration file. Partial updates are not supported. 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+.
502
+ *
503
+ * @param agentId The agent ID
504
+ * @param connectorType The connector type to update
505
+ * @param fileType The file type to update
506
+ * @param body an object with the body content
507
+ * @throws UpdateDirectAccessAgentConnectorFileWithoutQueryHttpError
508
+ */
509
+ declare function updateDirectAccessAgentConnectorFileWithoutQuery(agentId: string, connectorType: string, fileType: string, body: UpdateConfigurationFlatFileRequest, options?: ApiCallOptions): Promise<UpdateDirectAccessAgentConnectorFileWithoutQueryHttpResponse>;
510
+ type UpdateDirectAccessAgentConnectorFileWithoutQueryHttpResponse = {
511
+ data: void;
512
+ headers: Headers;
513
+ status: 204;
514
+ };
515
+ type UpdateDirectAccessAgentConnectorFileWithoutQueryHttpError = {
516
+ data: ErrorResponse;
517
+ headers: Headers;
518
+ status: 400 | 404 | 409;
519
+ };
520
+ /**
521
+ * Retrieves the settings for the metrics collector. Requestor must be assigned the `TenantAdmin` role. Available in Direct Access Gateway V1.7.9+.
522
+ *
523
+ * @param agentId The agent ID.
524
+ * @throws GetDirectAccessAgentToolsMetricsCollectorConfigurationHttpError
525
+ */
526
+ declare function getDirectAccessAgentToolsMetricsCollectorConfiguration(agentId: string, options?: ApiCallOptions): Promise<GetDirectAccessAgentToolsMetricsCollectorConfigurationHttpResponse>;
527
+ type GetDirectAccessAgentToolsMetricsCollectorConfigurationHttpResponse = {
528
+ data: MetricsCollectorSettingsApiResponseConnectorConfigurationResponse;
529
+ headers: Headers;
530
+ status: 200;
531
+ };
532
+ type GetDirectAccessAgentToolsMetricsCollectorConfigurationHttpError = {
533
+ data: ErrorResponse;
534
+ headers: Headers;
535
+ status: 400 | 404;
536
+ };
537
+ /**
538
+ * Completely replaces the contents of the metrics collector settings configuration file. Partial updates are not supported. Requestor must be assigned the `TenantAdmin` role. Available in Direct Access Gateway V1.7.9+.
539
+ *
540
+ * @param agentId The agent ID.
541
+ * @param body an object with the body content
542
+ * @throws SetDirectAccessAgentToolsMetricsCollectorConfigurationHttpError
543
+ */
544
+ declare function setDirectAccessAgentToolsMetricsCollectorConfiguration(agentId: string, body: UpdateMetricsCollectorSettingsRequest, options?: ApiCallOptions): Promise<SetDirectAccessAgentToolsMetricsCollectorConfigurationHttpResponse>;
545
+ type SetDirectAccessAgentToolsMetricsCollectorConfigurationHttpResponse = {
546
+ data: void;
547
+ headers: Headers;
548
+ status: 204;
549
+ };
550
+ type SetDirectAccessAgentToolsMetricsCollectorConfigurationHttpError = {
551
+ data: ErrorResponse;
552
+ headers: Headers;
553
+ status: 400 | 404;
554
+ };
555
+ /**
556
+ * Clears the cache for direct-access-agents api requests.
557
+ */
558
+ declare function clearCache(): void;
559
+ type DirectAccessAgentsAPI = {
560
+ /**
561
+ * 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+.
562
+ *
563
+ * @param agentId The agent ID
564
+ * @param agentAction The type of action to perform. Permitted values are `restart` (will not restart the agent if a reload is in `RELOADING` status) and `force-restart` (will restart the agent even if a reload is in `RELOADING` status).
565
+ * @throws RestartDirectAccessAgentHttpError
566
+ */
567
+ restartDirectAccessAgent: typeof restartDirectAccessAgent;
568
+ /**
569
+ * Starts a background benchmark task to measure the performance of a Direct Access agent. Use this endpoint to evaluate agent throughput and latency for capacity planning and performance optimization. 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.8+.
570
+ *
571
+ * @param agentId The agent ID
572
+ * @param query an object with query parameters
573
+ * @throws CreateDirectAccessAgentBenchmarkHttpError
574
+ */
575
+ createDirectAccessAgentBenchmark: typeof createDirectAccessAgentBenchmark;
576
+ /**
577
+ * Retrieves the current status and progress of a running or completed benchmark task. Use this endpoint to monitor benchmark execution and retrieve performance metrics once the task is completed. 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.8+.
578
+ *
579
+ * @param agentId The agent ID
580
+ * @param benchmarkId The benchmark ID
581
+ * @throws GetDirectAccessAgentBenchmarkHttpError
582
+ */
583
+ getDirectAccessAgentBenchmark: typeof getDirectAccessAgentBenchmark;
584
+ /**
585
+ * Requests a cancellation on a running benchmark by id for the specified agent. 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.8+.
586
+ *
587
+ * @param agentId The agent ID
588
+ * @param benchmarkId The benchmark ID
589
+ * @throws CreateDirectAccessAgentBenchmarkCancelHttpError
590
+ */
591
+ createDirectAccessAgentBenchmarkCancel: typeof createDirectAccessAgentBenchmarkCancel;
592
+ /**
593
+ * Retrieves the connector agent configuration from the specified agent. 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+.
594
+ *
595
+ * @param agentId The agent ID
596
+ * @param query an object with query parameters
597
+ * @throws GetDirectAccessAgentConfigurationHttpError
598
+ */
599
+ getDirectAccessAgentConfiguration: typeof getDirectAccessAgentConfiguration;
600
+ /**
601
+ * Makes changes to the local agent configuration using JSON Patch. 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+.
602
+ *
603
+ * @param agentId The agent ID
604
+ * @param body an object with the body content
605
+ * @throws PatchDirectAccessAgentConfigurationHttpError
606
+ */
607
+ patchDirectAccessAgentConfiguration: typeof patchDirectAccessAgentConfiguration;
608
+ /**
609
+ * Retrieves the allowed paths settings for the File Connector. Requestor must be assigned the `TenantAdmin` role. Available in Direct Access Gateway V1.7.6+.
610
+ *
611
+ * @param agentId The agent ID
612
+ * @throws GetDirectAccessAgentConnectorsFileConnectorFilesAllowedPathsHttpError
613
+ */
614
+ getDirectAccessAgentConnectorsFileConnectorFilesAllowedPaths: typeof getDirectAccessAgentConnectorsFileConnectorFilesAllowedPaths;
615
+ /**
616
+ * Completely replaces the contents of the allowed paths configuration file for the File Connector. Partial updates are not supported. Requestor must be assigned the `TenantAdmin` role. Available in Direct Access Gateway V1.7.6+.
617
+ *
618
+ * @param agentId The agent id
619
+ * @param body an object with the body content
620
+ * @throws PutDirectAccessAgentConnectorsFileConnectorFilesAllowedPathsHttpError
621
+ */
622
+ putDirectAccessAgentConnectorsFileConnectorFilesAllowedPaths: typeof putDirectAccessAgentConnectorsFileConnectorFilesAllowedPaths;
623
+ /**
624
+ * Retrieves the 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+.
625
+ *
626
+ * @param agentId The agent ID.
627
+ * @throws GetDirectAccessAgentConnectorsOdbcConnectorFilesCustomDataTypeMappingsHttpError
628
+ */
629
+ getDirectAccessAgentConnectorsOdbcConnectorFilesCustomDataTypeMappings: typeof getDirectAccessAgentConnectorsOdbcConnectorFilesCustomDataTypeMappings;
630
+ /**
631
+ * 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+.
632
+ *
633
+ * @param agentId The agent ID.
634
+ * @param body an object with the body content
635
+ * @throws PutDirectAccessAgentConnectorsOdbcConnectorFilesCustomDataTypeMappingsHttpError
636
+ */
637
+ putDirectAccessAgentConnectorsOdbcConnectorFilesCustomDataTypeMappings: typeof putDirectAccessAgentConnectorsOdbcConnectorFilesCustomDataTypeMappings;
638
+ /**
639
+ * Retrieves the configuration files associated with the 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+.
640
+ *
641
+ * @param agentId The agent ID
642
+ * @param connectorType The connector to retrieve the list of files for
643
+ * @param query an object with query parameters
644
+ * @throws GetDirectAccessAgentConnectorFilesHttpError
645
+ */
646
+ getDirectAccessAgentConnectorFiles: typeof getDirectAccessAgentConnectorFiles;
647
+ /**
648
+ * Retrieves the configuration files associated with the 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+.
649
+ *
650
+ * @param agentId The agent ID
651
+ * @param connectorType The connector to retrieve the list of files for
652
+ * @throws GetDirectAccessAgentConnectorFilesWithoutQueryHttpError
653
+ */
654
+ getDirectAccessAgentConnectorFilesWithoutQuery: typeof getDirectAccessAgentConnectorFilesWithoutQuery;
655
+ /**
656
+ * 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+.
657
+ *
658
+ * @param agentId The agent ID
659
+ * @param connectorType The connector type to retrieve
660
+ * @param fileType The type of file to retrieve
661
+ * @throws GetDirectAccessAgentConnectorFileHttpError
662
+ */
663
+ getDirectAccessAgentConnectorFile: typeof getDirectAccessAgentConnectorFile;
664
+ /**
665
+ * Completely replaces the contents of the connector's configuration file. Partial updates are not supported. 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+.
666
+ *
667
+ * @param agentId The agent ID
668
+ * @param connectorType The connector type to update
669
+ * @param fileType The file type to update
670
+ * @param query an object with query parameters
671
+ * @param body an object with the body content
672
+ * @throws UpdateDirectAccessAgentConnectorFileHttpError
673
+ */
674
+ updateDirectAccessAgentConnectorFile: typeof updateDirectAccessAgentConnectorFile;
675
+ /**
676
+ * Completely replaces the contents of the connector's configuration file. Partial updates are not supported. 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+.
677
+ *
678
+ * @param agentId The agent ID
679
+ * @param connectorType The connector type to update
680
+ * @param fileType The file type to update
681
+ * @param body an object with the body content
682
+ * @throws UpdateDirectAccessAgentConnectorFileWithoutQueryHttpError
683
+ */
684
+ updateDirectAccessAgentConnectorFileWithoutQuery: typeof updateDirectAccessAgentConnectorFileWithoutQuery;
685
+ /**
686
+ * Retrieves the settings for the metrics collector. Requestor must be assigned the `TenantAdmin` role. Available in Direct Access Gateway V1.7.9+.
687
+ *
688
+ * @param agentId The agent ID.
689
+ * @throws GetDirectAccessAgentToolsMetricsCollectorConfigurationHttpError
690
+ */
691
+ getDirectAccessAgentToolsMetricsCollectorConfiguration: typeof getDirectAccessAgentToolsMetricsCollectorConfiguration;
692
+ /**
693
+ * Completely replaces the contents of the metrics collector settings configuration file. Partial updates are not supported. Requestor must be assigned the `TenantAdmin` role. Available in Direct Access Gateway V1.7.9+.
694
+ *
695
+ * @param agentId The agent ID.
696
+ * @param body an object with the body content
697
+ * @throws SetDirectAccessAgentToolsMetricsCollectorConfigurationHttpError
698
+ */
699
+ setDirectAccessAgentToolsMetricsCollectorConfiguration: typeof setDirectAccessAgentToolsMetricsCollectorConfiguration;
700
+ /**
701
+ * Clears the cache for direct-access-agents api requests.
702
+ */
703
+ clearCache: typeof clearCache;
704
+ };
705
+ /**
706
+ * Functions for the direct-access-agents api
707
+ */
708
+ declare const directAccessAgentsExport: DirectAccessAgentsAPI;
709
+ //#endregion
710
+ export { CancelBenchmarkResponse, ConfigurationLineBase, ConfigurationLineNumeric, ConfigurationLineString, ConfigurationResponse, ConnectorFlatFileConfigurationResponse, ConnectorSettings, CreateDirectAccessAgentBenchmarkCancelHttpError, CreateDirectAccessAgentBenchmarkCancelHttpResponse, CreateDirectAccessAgentBenchmarkHttpError, CreateDirectAccessAgentBenchmarkHttpResponse, DirectAccessAgentsAPI, ErrorMessage, ErrorResponse, FileConnectorAllowedPath, FileConnectorAllowedPathsResponse, GetBenchmarkStatusResponse, GetBenchmarkStatusResults, GetDirectAccessAgentBenchmarkHttpError, GetDirectAccessAgentBenchmarkHttpResponse, GetDirectAccessAgentConfigurationHttpError, GetDirectAccessAgentConfigurationHttpResponse, GetDirectAccessAgentConnectorFileHttpError, GetDirectAccessAgentConnectorFileHttpResponse, GetDirectAccessAgentConnectorFilesHttpError, GetDirectAccessAgentConnectorFilesHttpResponse, GetDirectAccessAgentConnectorFilesWithoutQueryHttpError, GetDirectAccessAgentConnectorFilesWithoutQueryHttpResponse, GetDirectAccessAgentConnectorsFileConnectorFilesAllowedPathsHttpError, GetDirectAccessAgentConnectorsFileConnectorFilesAllowedPathsHttpResponse, GetDirectAccessAgentConnectorsOdbcConnectorFilesCustomDataTypeMappingsHttpError, GetDirectAccessAgentConnectorsOdbcConnectorFilesCustomDataTypeMappingsHttpResponse, GetDirectAccessAgentToolsMetricsCollectorConfigurationHttpError, GetDirectAccessAgentToolsMetricsCollectorConfigurationHttpResponse, LinkResponseObject, MetricsCollectorConnectorConfigurationApiResponse, MetricsCollectorConnectorConfigurationsApiResponse, MetricsCollectorIndividualConnectorConfigurationRequest, MetricsCollectorSettings, MetricsCollectorSettingsApiResponse, MetricsCollectorSettingsApiResponseConnectorConfigurationResponse, OdbcCustomDataType, OdbcCustomDataTypeResponse, Operation, PatchDirectAccessAgentConfiguration204HttpResponse, PatchDirectAccessAgentConfiguration207HttpResponse, PatchDirectAccessAgentConfigurationHttpError, PatchDirectAccessAgentConfigurationHttpResponse, PatchOperationResponse, PatchOperationValidationResult, PutDirectAccessAgentConnectorsFileConnectorFilesAllowedPathsHttpError, PutDirectAccessAgentConnectorsFileConnectorFilesAllowedPathsHttpResponse, PutDirectAccessAgentConnectorsOdbcConnectorFilesCustomDataTypeMappingsHttpError, PutDirectAccessAgentConnectorsOdbcConnectorFilesCustomDataTypeMappingsHttpResponse, RestartDirectAccessAgentHttpError, RestartDirectAccessAgentHttpResponse, RunBenchmarkResponse, SetDirectAccessAgentToolsMetricsCollectorConfigurationHttpError, SetDirectAccessAgentToolsMetricsCollectorConfigurationHttpResponse, UpdateConfigurationFlatFileRequest, UpdateDirectAccessAgentConnectorFileHttpError, UpdateDirectAccessAgentConnectorFileHttpResponse, UpdateDirectAccessAgentConnectorFileWithoutQueryHttpError, UpdateDirectAccessAgentConnectorFileWithoutQueryHttpResponse, UpdateFileConnectorAllowedPathsRequest, UpdateMetricsCollectorConnectorConfigurationsRequest, UpdateMetricsCollectorSettings, UpdateMetricsCollectorSettingsRequest, UpdateOdbcCustomTypeMappingsRequest, clearCache, createDirectAccessAgentBenchmark, createDirectAccessAgentBenchmarkCancel, directAccessAgentsExport as default, getDirectAccessAgentBenchmark, getDirectAccessAgentConfiguration, getDirectAccessAgentConnectorFile, getDirectAccessAgentConnectorFiles, getDirectAccessAgentConnectorFilesWithoutQuery, getDirectAccessAgentConnectorsFileConnectorFilesAllowedPaths, getDirectAccessAgentConnectorsOdbcConnectorFilesCustomDataTypeMappings, getDirectAccessAgentToolsMetricsCollectorConfiguration, patchDirectAccessAgentConfiguration, putDirectAccessAgentConnectorsFileConnectorFilesAllowedPaths, putDirectAccessAgentConnectorsOdbcConnectorFilesCustomDataTypeMappings, restartDirectAccessAgent, setDirectAccessAgentToolsMetricsCollectorConfiguration, updateDirectAccessAgentConnectorFile, updateDirectAccessAgentConnectorFileWithoutQuery };