@qlik/api 1.41.0 → 1.43.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.
Files changed (499) hide show
  1. package/api-keys.d.ts +2 -2
  2. package/api-keys.js +3 -3
  3. package/apps.d.ts +2 -2
  4. package/apps.js +3 -3
  5. package/assistants.d.ts +2 -2
  6. package/assistants.js +3 -3
  7. package/audits.d.ts +3 -3
  8. package/audits.js +17 -4
  9. package/auth-types.d.ts +1 -1
  10. package/auth-types.js +1 -1
  11. package/auth.d.ts +2 -2
  12. package/auth.js +2 -2
  13. package/automation-connections.d.ts +2 -2
  14. package/automation-connections.js +3 -3
  15. package/automations.d.ts +3 -3
  16. package/automations.js +3 -3
  17. package/automl-deployments.d.ts +2 -2
  18. package/automl-deployments.js +5 -3
  19. package/automl-predictions.d.ts +2 -2
  20. package/automl-predictions.js +15 -3
  21. package/brands.d.ts +2 -2
  22. package/brands.js +3 -3
  23. package/chunks/{api-keys-CI44OuNR.d.ts → api-keys-C-ZqA-wl.d.ts} +1 -1
  24. package/chunks/{apps-BiGof9WJ.d.ts → apps-CJH5JjKB.d.ts} +1 -1
  25. package/chunks/{assistants-CDtI99Yr.d.ts → assistants-BsDbpzl4.d.ts} +7 -1
  26. package/chunks/{audits-C-UDFprK.d.ts → audits-5CBpwcdx.d.ts} +24 -2
  27. package/chunks/{auth-DhI7LQIw.js → auth-CCj082fh.js} +4 -4
  28. package/chunks/{auth-B5Hx9GeQ.d.ts → auth-DFOXWfqh.d.ts} +3 -3
  29. package/chunks/{auth-DBrXfv7D.js → auth-IDN6Z4Nr.js} +2 -2
  30. package/chunks/{auth-functions-DHRxWU6t.js → auth-functions-CZbgZARw.js} +72 -24
  31. package/chunks/{auth-types-BlCWK0FP.d.ts → auth-types-B1c_1Nca.d.ts} +4 -1
  32. package/chunks/{automation-connections-keN9CuNO.d.ts → automation-connections-DRQDgw7Q.d.ts} +1 -1
  33. package/chunks/{automations-CFRnQ8sX.d.ts → automations-arVbySrW.d.ts} +13 -4
  34. package/chunks/{automl-deployments-D05clUGa.d.ts → automl-deployments-B-WuR_zE.d.ts} +5 -1
  35. package/chunks/{automl-predictions-Ddp6PdpE.d.ts → automl-predictions-CewW0eZn.d.ts} +25 -1
  36. package/chunks/{brands-hEcnkdfg.d.ts → brands-C4eALPrs.d.ts} +1 -1
  37. package/chunks/{collections-CuX8Cp8Z.d.ts → collections-Djmd9gof.d.ts} +1 -1
  38. package/chunks/{conditions-DUmPB4Ej.d.ts → conditions-BRDxUbgu.d.ts} +1 -1
  39. package/chunks/{consumption-CSptDhk9.d.ts → consumption-UNw8R7jN.d.ts} +1 -1
  40. package/chunks/{csp-origins-v_UyOSK9.d.ts → csp-origins-_4HBSdgU.d.ts} +1 -1
  41. package/chunks/{csrf-token-DZK6GX6Z.d.ts → csrf-token-CsvbqXyY.d.ts} +1 -1
  42. package/chunks/{data-alerts-DwPcCvHP.d.ts → data-alerts-DSV3VOnW.d.ts} +1 -1
  43. package/chunks/{data-assets-BPMOGSO7.d.ts → data-assets-C3U3T_lj.d.ts} +1 -1
  44. package/chunks/{data-connections-DK1AhSi4.d.ts → data-connections-BYNfX1Fl.d.ts} +1 -1
  45. package/chunks/{data-credentials-BDCHbRwM.d.ts → data-credentials-CgCjw_Cn.d.ts} +1 -1
  46. package/chunks/{data-files-D7mlQnrw.d.ts → data-files-DH19MfYE.d.ts} +1 -1
  47. package/chunks/{data-qualities-Z554f_p6.d.ts → data-qualities-BogHQw4I.d.ts} +1 -1
  48. package/chunks/{data-sets-AcCLu1zw.d.ts → data-sets-B27GmshO.d.ts} +1 -1
  49. package/chunks/{data-sources-DNnmr1Qi.d.ts → data-sources-D_TRdWV-.d.ts} +5 -1
  50. package/chunks/{data-stores-Bofu7fl5.d.ts → data-stores-BjfzMp9W.d.ts} +1 -1
  51. package/chunks/{dcaas-DK4f7Rrs.d.ts → dcaas-A7hfpAI5.d.ts} +1 -1
  52. package/chunks/{di-projects-uem8xKkX.d.ts → di-projects-mdshgyFv.d.ts} +70 -13
  53. package/chunks/{direct-access-agents-BbSiWlMD.d.ts → direct-access-agents-CfUpbi73.d.ts} +74 -5
  54. package/chunks/{dist-CjqdvDf3.js → dist-UZqmL_Q6.js} +15 -10
  55. package/chunks/{encryption-CMJWtMcm.d.ts → encryption-CjBmNQDZ.d.ts} +1 -1
  56. package/chunks/{extensions-Ct2JAsbk.d.ts → extensions-D05y2FWk.d.ts} +1 -1
  57. package/chunks/global-types-BGMD2sDY.js +1 -0
  58. package/chunks/{glossaries-Drx-EwiU.d.ts → glossaries-vYbykU3r.d.ts} +1 -1
  59. package/chunks/{groups-C-R5oUEa.d.ts → groups-BapgngJf.d.ts} +1 -1
  60. package/chunks/{identity-providers-Bj88evsO.d.ts → identity-providers-CAxsp9hP.d.ts} +1 -1
  61. package/chunks/{interceptors-e6hoYE8W.d.ts → interceptors-BF556LaK.d.ts} +1 -1
  62. package/chunks/{interceptors-DD0vKL8_.js → interceptors-DBoV6UkN.js} +1 -1
  63. package/chunks/{invoke-fetch-B-ZucHu9.js → invoke-fetch-09EW5w1d.js} +3 -3
  64. package/chunks/{invoke-fetch-NdtGGVxy.js → invoke-fetch-fXOUPARi.js} +4 -4
  65. package/chunks/{items-BnN6gI0J.d.ts → items-CjVrNg57.d.ts} +1 -1
  66. package/chunks/{knowledgebases-tmPZVD6i.d.ts → knowledgebases-BFiV7Fwh.d.ts} +1 -1
  67. package/chunks/{licenses-DAPVQuFJ.d.ts → licenses-yZKgQ2k6.d.ts} +1 -1
  68. package/chunks/{lineage-graphs-Q4LiGGtL.d.ts → lineage-graphs-Bkc04N-t.d.ts} +1 -1
  69. package/chunks/{ml-C80TkK1J.d.ts → ml-CABYvU_L.d.ts} +8 -14
  70. package/chunks/{notes-CHvadRai.d.ts → notes-C5HjmBeI.d.ts} +1 -1
  71. package/chunks/{notifications-BhS8s4Eo.d.ts → notifications-DfP7aWPH.d.ts} +1 -1
  72. package/chunks/{oauth-clients-D1f8xiFC.d.ts → oauth-clients-BmMEDuET.d.ts} +1 -1
  73. package/chunks/{oauth-tokens-DteoDifd.d.ts → oauth-tokens-Dimf19DE.d.ts} +1 -1
  74. package/chunks/{public-runtime-modules-lsJEDVxt.js → public-runtime-modules-P9LEbn8i.js} +3 -3
  75. package/chunks/{qix-J4MO8SAa.d.ts → qix-C1WaB-67.d.ts} +3 -18
  76. package/chunks/{qix-CwYrlHFT.js → qix-C86sBDw3.js} +1 -1
  77. package/chunks/{qix-bnv1_Kxc.js → qix-Ds6X5svJ.js} +6 -6
  78. package/chunks/{qix-chunk-entrypoint-ByJzCY0D.js → qix-chunk-entrypoint-CpkRq84_.js} +427 -90
  79. package/chunks/{questions-BiR5-mZ4.d.ts → questions-CFN7BgWt.d.ts} +1 -1
  80. package/chunks/{quotas-GTQL9uPt.d.ts → quotas-BUH2e2K_.d.ts} +1 -1
  81. package/chunks/{reload-tasks-CmXJp5va.d.ts → reload-tasks-DN3X2-30.d.ts} +1 -1
  82. package/chunks/{reloads-3XgvVnbq.d.ts → reloads-ClLQO7Vt.d.ts} +1 -1
  83. package/chunks/{report-templates-BowaTti4.d.ts → report-templates-D5KOFkRi.d.ts} +1 -1
  84. package/chunks/{reports-oosnUaFo.d.ts → reports-CRwCogRL.d.ts} +94 -3
  85. package/chunks/{roles-D93ENaRt.d.ts → roles-DCzyiLdU.d.ts} +1 -1
  86. package/chunks/{sharing-tasks-BMDAjWTj.d.ts → sharing-tasks-DsxFrADQ.d.ts} +1 -1
  87. package/chunks/{spaces-DZI6zKZi.d.ts → spaces-B0cx23Nc.d.ts} +4 -4
  88. package/chunks/{tasks-BWmS6L8Y.d.ts → tasks-DWfE5JM_.d.ts} +1 -1
  89. package/chunks/{temp-contents-CZVb5P0V.d.ts → temp-contents-CU94UTZU.d.ts} +1 -1
  90. package/chunks/{tenants-BDH4DmcO.d.ts → tenants-DvtbiwAP.d.ts} +1 -1
  91. package/chunks/{themes-BkubWfOE.d.ts → themes-BPkyCLWS.d.ts} +1 -1
  92. package/chunks/{transports-CO9kRJg5.d.ts → transports-DlRmSWLj.d.ts} +1 -1
  93. package/chunks/{ui-config-DIOnLEV9.d.ts → ui-config-BqX-bPjf.d.ts} +1 -1
  94. package/chunks/{users-DM-ZfzQB.d.ts → users-CuQ0nboa.d.ts} +1 -1
  95. package/chunks/{utils-qEQ6sEXX.js → utils-CAGXTaqJ.js} +14 -1
  96. package/chunks/{web-integrations-BjVMC88M.d.ts → web-integrations-D54LCd0Z.d.ts} +1 -1
  97. package/chunks/{web-notifications-D-eA8h1I.d.ts → web-notifications-sUlHGnmy.d.ts} +1 -1
  98. package/chunks/{webhooks-Dytyr5nk.d.ts → webhooks-Dw0FIeFq.d.ts} +1 -1
  99. package/collections.d.ts +2 -2
  100. package/collections.js +3 -3
  101. package/conditions.d.ts +2 -2
  102. package/conditions.js +3 -3
  103. package/consumption.d.ts +2 -2
  104. package/consumption.js +3 -3
  105. package/csp-origins.d.ts +2 -2
  106. package/csp-origins.js +3 -3
  107. package/csrf-token.d.ts +2 -2
  108. package/csrf-token.js +3 -3
  109. package/data-alerts.d.ts +2 -2
  110. package/data-alerts.js +3 -3
  111. package/data-assets.d.ts +2 -2
  112. package/data-assets.js +3 -3
  113. package/data-connections.d.ts +2 -2
  114. package/data-connections.js +3 -3
  115. package/data-credentials.d.ts +2 -2
  116. package/data-credentials.js +3 -3
  117. package/data-files.d.ts +2 -2
  118. package/data-files.js +3 -3
  119. package/data-qualities.d.ts +2 -2
  120. package/data-qualities.js +3 -3
  121. package/data-sets.d.ts +2 -2
  122. package/data-sets.js +3 -3
  123. package/data-sources.d.ts +2 -2
  124. package/data-sources.js +4 -3
  125. package/data-stores.d.ts +2 -2
  126. package/data-stores.js +3 -3
  127. package/dcaas.d.ts +2 -2
  128. package/dcaas.js +3 -3
  129. package/di-projects.d.ts +3 -3
  130. package/di-projects.js +4 -4
  131. package/direct-access-agents.d.ts +3 -3
  132. package/direct-access-agents.js +46 -5
  133. package/docs/authentication.md +65 -1
  134. package/docs/rest.md +1 -1
  135. package/encryption.d.ts +2 -2
  136. package/encryption.js +3 -3
  137. package/extensions.d.ts +2 -2
  138. package/extensions.js +3 -3
  139. package/global-types.d.ts +1 -1
  140. package/global-types.js +3 -1
  141. package/glossaries.d.ts +2 -2
  142. package/glossaries.js +3 -3
  143. package/groups.d.ts +2 -2
  144. package/groups.js +3 -3
  145. package/identity-providers.d.ts +2 -2
  146. package/identity-providers.js +3 -3
  147. package/index.d.ts +63 -63
  148. package/index.js +74 -69
  149. package/interceptors.d.ts +2 -2
  150. package/interceptors.js +2 -2
  151. package/invoke-fetch-types.d.ts +1 -1
  152. package/items.d.ts +2 -2
  153. package/items.js +3 -3
  154. package/knowledgebases.d.ts +2 -2
  155. package/knowledgebases.js +3 -3
  156. package/licenses.d.ts +2 -2
  157. package/licenses.js +3 -3
  158. package/lineage-graphs.d.ts +2 -2
  159. package/lineage-graphs.js +3 -3
  160. package/ml.d.ts +3 -3
  161. package/ml.js +4 -4
  162. package/notes.d.ts +2 -2
  163. package/notes.js +3 -3
  164. package/notifications.d.ts +2 -2
  165. package/notifications.js +3 -3
  166. package/oauth-clients.d.ts +2 -2
  167. package/oauth-clients.js +3 -3
  168. package/oauth-tokens.d.ts +2 -2
  169. package/oauth-tokens.js +3 -3
  170. package/package.json +2 -2
  171. package/qix.d.ts +4 -4
  172. package/qix.js +2 -2
  173. package/questions.d.ts +2 -2
  174. package/questions.js +3 -3
  175. package/quotas.d.ts +2 -2
  176. package/quotas.js +3 -3
  177. package/reload-tasks.d.ts +2 -2
  178. package/reload-tasks.js +3 -3
  179. package/reloads.d.ts +2 -2
  180. package/reloads.js +3 -3
  181. package/report-templates.d.ts +2 -2
  182. package/report-templates.js +3 -3
  183. package/reports.d.ts +3 -3
  184. package/reports.js +22 -4
  185. package/roles.d.ts +2 -2
  186. package/roles.js +3 -3
  187. package/sharing-tasks.d.ts +2 -2
  188. package/sharing-tasks.js +3 -3
  189. package/spaces.d.ts +2 -2
  190. package/spaces.js +3 -3
  191. package/tasks.d.ts +2 -2
  192. package/tasks.js +3 -3
  193. package/temp-contents.d.ts +2 -2
  194. package/temp-contents.js +3 -3
  195. package/tenants.d.ts +2 -2
  196. package/tenants.js +3 -3
  197. package/themes.d.ts +2 -2
  198. package/themes.js +3 -3
  199. package/transports.d.ts +2 -2
  200. package/transports.js +3 -3
  201. package/ui-config.d.ts +2 -2
  202. package/ui-config.js +3 -3
  203. package/users.d.ts +2 -2
  204. package/users.js +3 -3
  205. package/web-integrations.d.ts +2 -2
  206. package/web-integrations.js +3 -3
  207. package/web-notifications.d.ts +2 -2
  208. package/web-notifications.js +3 -3
  209. package/webhooks.d.ts +2 -2
  210. package/webhooks.js +3 -3
  211. package/website/assets/navigation.js +1 -1
  212. package/website/assets/search.js +1 -1
  213. package/website/functions/audits.fetchConsumptionAppAudits.html +3 -0
  214. package/website/functions/auth.setDefaultHostConfig.html +1 -1
  215. package/website/functions/automations.getAutomationsUsageMetrics.html +5 -1
  216. package/website/functions/automations.updateAutomation.html +2 -2
  217. package/website/functions/automl-deployments.createAutomlDeploymentRealtimePrediction.html +3 -3
  218. package/website/functions/automl-predictions.createAutomlPredictionJob.html +3 -3
  219. package/website/functions/automl-predictions.getAutomlPredictionCoordinateShap.html +3 -3
  220. package/website/functions/automl-predictions.getAutomlPredictionNotPredictedReasons.html +3 -3
  221. package/website/functions/automl-predictions.getAutomlPredictionPredictions.html +3 -3
  222. package/website/functions/automl-predictions.getAutomlPredictionShap.html +3 -3
  223. package/website/functions/automl-predictions.getAutomlPredictionSource.html +3 -3
  224. package/website/functions/data-sources.getDataSources.html +4 -3
  225. package/website/functions/di-projects.getDiProjectDiTaskRuntimeState.html +1 -1
  226. package/website/functions/direct-access-agents.getDirectAccessAgentConnectorCustomDataTypeMappings.html +1 -1
  227. package/website/functions/direct-access-agents.getDirectAccessAgentConnectorFilesAllowedPaths.html +5 -0
  228. package/website/functions/direct-access-agents.putDirectAccessAgentConnectorFilesAllowedPaths.html +6 -0
  229. package/website/functions/ml.getMlDeploymentAliases.html +2 -1
  230. package/website/functions/reports.getReportOutputs.html +13 -0
  231. package/website/interfaces/api-keys.ApiKeysAPI.html +8 -8
  232. package/website/interfaces/apps.AppsAPI.html +45 -45
  233. package/website/interfaces/assistants.AssistantsAPI.html +29 -29
  234. package/website/interfaces/audits.AuditsAPI.html +27 -22
  235. package/website/interfaces/auth.AuthAPI.html +7 -7
  236. package/website/interfaces/automation-connections.AutomationConnectionsAPI.html +9 -9
  237. package/website/interfaces/automations.AutomationsAPI.html +29 -25
  238. package/website/interfaces/automl-deployments.AutomlDeploymentsAPI.html +7 -7
  239. package/website/interfaces/automl-predictions.AutomlPredictionsAPI.html +37 -37
  240. package/website/interfaces/brands.BrandsAPI.html +13 -13
  241. package/website/interfaces/collections.CollectionsAPI.html +12 -12
  242. package/website/interfaces/conditions.ConditionsAPI.html +12 -12
  243. package/website/interfaces/consumption.ConsumptionAPI.html +2 -2
  244. package/website/interfaces/csp-origins.CspOriginsAPI.html +7 -7
  245. package/website/interfaces/csrf-token.CsrfTokenAPI.html +2 -2
  246. package/website/interfaces/data-alerts.DataAlertsAPI.html +17 -17
  247. package/website/interfaces/data-assets.DataAssetsAPI.html +6 -6
  248. package/website/interfaces/data-connections.DataConnectionsAPI.html +10 -10
  249. package/website/interfaces/data-credentials.DataCredentialsAPI.html +6 -6
  250. package/website/interfaces/data-files.DataFilesAPI.html +13 -13
  251. package/website/interfaces/data-qualities.DataQualitiesAPI.html +4 -4
  252. package/website/interfaces/data-sets.DataSetsAPI.html +7 -7
  253. package/website/interfaces/data-sources.DataSourcesAPI.html +10 -9
  254. package/website/interfaces/data-stores.DataStoresAPI.html +11 -11
  255. package/website/interfaces/dcaas.DcaasAPI.html +4 -4
  256. package/website/interfaces/di-projects.DiProjectsAPI.html +18 -18
  257. package/website/interfaces/direct-access-agents.DirectAccessAgentsAPI.html +58 -38
  258. package/website/interfaces/encryption.EncryptionAPI.html +11 -11
  259. package/website/interfaces/extensions.ExtensionsAPI.html +8 -8
  260. package/website/interfaces/glossaries.GlossariesAPI.html +25 -25
  261. package/website/interfaces/groups.GroupsAPI.html +9 -9
  262. package/website/interfaces/identity-providers.IdentityProvidersAPI.html +9 -9
  263. package/website/interfaces/interceptors.InterceptorsAPI.html +3 -3
  264. package/website/interfaces/items.ItemsAPI.html +9 -9
  265. package/website/interfaces/knowledgebases.KnowledgebasesAPI.html +18 -18
  266. package/website/interfaces/licenses.LicensesAPI.html +10 -10
  267. package/website/interfaces/lineage-graphs.LineageGraphsAPI.html +9 -9
  268. package/website/interfaces/ml.MlAPI.html +48 -46
  269. package/website/interfaces/notes.NotesAPI.html +3 -3
  270. package/website/interfaces/notifications.NotificationsAPI.html +2 -2
  271. package/website/interfaces/oauth-clients.OauthClientsAPI.html +12 -12
  272. package/website/interfaces/oauth-tokens.OauthTokensAPI.html +3 -3
  273. package/website/interfaces/qix.GenericObject.html +1 -1
  274. package/website/interfaces/questions.QuestionsAPI.html +3 -3
  275. package/website/interfaces/quotas.QuotasAPI.html +3 -3
  276. package/website/interfaces/reload-tasks.ReloadTasksAPI.html +6 -6
  277. package/website/interfaces/reloads.ReloadsAPI.html +5 -5
  278. package/website/interfaces/report-templates.ReportTemplatesAPI.html +8 -8
  279. package/website/interfaces/reports.ReportsAPI.html +26 -8
  280. package/website/interfaces/roles.RolesAPI.html +6 -6
  281. package/website/interfaces/sharing-tasks.SharingTasksAPI.html +14 -14
  282. package/website/interfaces/spaces.SpacesAPI.html +18 -18
  283. package/website/interfaces/tasks.TasksAPI.html +11 -11
  284. package/website/interfaces/temp-contents.TempContentsAPI.html +4 -4
  285. package/website/interfaces/tenants.TenantsAPI.html +7 -7
  286. package/website/interfaces/themes.ThemesAPI.html +8 -8
  287. package/website/interfaces/transports.TransportsAPI.html +7 -7
  288. package/website/interfaces/ui-config.UiConfigAPI.html +8 -8
  289. package/website/interfaces/users.UsersAPI.html +10 -10
  290. package/website/interfaces/web-integrations.WebIntegrationsAPI.html +6 -6
  291. package/website/interfaces/web-notifications.WebNotificationsAPI.html +7 -7
  292. package/website/interfaces/webhooks.WebhooksAPI.html +11 -11
  293. package/website/modules/audits.html +1 -1
  294. package/website/modules/auth.html +1 -1
  295. package/website/modules/automations.html +1 -1
  296. package/website/modules/automl-deployments.html +1 -1
  297. package/website/modules/automl-predictions.html +1 -1
  298. package/website/modules/di-projects.html +1 -1
  299. package/website/modules/direct-access-agents.html +1 -1
  300. package/website/modules/ml.html +1 -1
  301. package/website/modules/qix.html +1 -1
  302. package/website/modules/reports.html +1 -1
  303. package/website/types/api-keys.Error.html +1 -1
  304. package/website/types/apps.Error.html +1 -1
  305. package/website/types/apps.Evaluation.html +1 -1
  306. package/website/types/apps.RecommendItems.html +1 -1
  307. package/website/types/apps.RecommendedAnalysis.html +1 -1
  308. package/website/types/assistants.Assistant.html +4 -2
  309. package/website/types/assistants.CreateAssistant.html +4 -2
  310. package/website/types/assistants.CreateAssistantWithAvatar.html +4 -2
  311. package/website/types/assistants.PromptInput.html +1 -1
  312. package/website/types/audits.EventExtensions.html +1 -1
  313. package/website/types/audits.FetchConsumptionAppAuditsHttpError.html +4 -0
  314. package/website/types/audits.FetchConsumptionAppAuditsHttpResponse.html +4 -0
  315. package/website/types/audits.GetSettingsResult.html +1 -1
  316. package/website/types/automations.AutomationDetailUpdateRequestObject.html +6 -0
  317. package/website/types/automations.CopyAutomationHttpResponse.html +1 -1
  318. package/website/types/automations.RunDetailResponseObject.html +1 -1
  319. package/website/types/automl-deployments.Error.html +1 -1
  320. package/website/types/automl-predictions.Error.html +1 -1
  321. package/website/types/collections.CollectionByIdPatch.html +1 -1
  322. package/website/types/csp-origins.CSPEntry.html +1 -1
  323. package/website/types/data-alerts.AlertingExecutionListResponse.html +1 -1
  324. package/website/types/data-alerts.AlertingTaskListResponse.html +1 -1
  325. package/website/types/data-connections.ActionDeleteRequest.html +1 -1
  326. package/website/types/data-connections.ActionUpdateRequest.html +1 -1
  327. package/website/types/data-connections.BulkResponse.html +1 -1
  328. package/website/types/data-connections.Link.html +1 -1
  329. package/website/types/data-connections.PatchRequest.html +1 -1
  330. package/website/types/data-connections.TopLevelLink.html +3 -3
  331. package/website/types/data-credentials.Link.html +1 -1
  332. package/website/types/data-credentials.PatchRequest.html +1 -1
  333. package/website/types/data-qualities.DataQualityComputationRequest.html +1 -1
  334. package/website/types/data-sources.GetDataSourceGatewaysHttpResponse.html +1 -1
  335. package/website/types/data-sources.QriDefinition.html +2 -2
  336. package/website/types/di-projects.AsyncActionDetails.html +1 -1
  337. package/website/types/di-projects.DataTaskInstanceState.html +29 -2
  338. package/website/types/di-projects.DataTaskRuntimeState.html +6 -0
  339. package/website/types/di-projects.DataTaskType.html +1 -1
  340. package/website/types/di-projects.GetDiExportProjectVariablesRsp.html +3 -2
  341. package/website/types/di-projects.GetDiProjectDiTaskRuntimeStateHttpResponse.html +2 -2
  342. package/website/types/direct-access-agents.FileConnectorAllowedPath.html +5 -0
  343. package/website/types/direct-access-agents.FileConnectorAllowedPathsResponse.html +3 -0
  344. package/website/types/direct-access-agents.GetDirectAccessAgentConnectorFilesAllowedPathsHttpError.html +4 -0
  345. package/website/types/direct-access-agents.GetDirectAccessAgentConnectorFilesAllowedPathsHttpResponse.html +4 -0
  346. package/website/types/direct-access-agents.Operation.html +2 -2
  347. package/website/types/direct-access-agents.PutDirectAccessAgentConnectorFilesAllowedPathsHttpError.html +4 -0
  348. package/website/types/direct-access-agents.PutDirectAccessAgentConnectorFilesAllowedPathsHttpResponse.html +4 -0
  349. package/website/types/direct-access-agents.UpdateFileConnectorAllowedPathsRequest.html +3 -0
  350. package/website/types/direct-access-agents.UpdateOdbcCustomTypeMappingsRequest.html +2 -1
  351. package/website/types/encryption.KeyProvider.html +1 -1
  352. package/website/types/global-types.PerformInteractiveLoginFn.html +1 -1
  353. package/website/types/groups.AssignedRoles.html +1 -1
  354. package/website/types/groups.AssignedRolesRefIDs.html +1 -1
  355. package/website/types/groups.AssignedRolesRefNames.html +1 -1
  356. package/website/types/groups.Error.html +1 -1
  357. package/website/types/identity-providers.CreateJWTAuthPayload.html +1 -1
  358. package/website/types/identity-providers.CreateOIDCPayload.html +2 -2
  359. package/website/types/identity-providers.CreateSAMLPayload.html +2 -2
  360. package/website/types/identity-providers.Error.html +1 -1
  361. package/website/types/identity-providers.IDPOIDC.html +1 -1
  362. package/website/types/identity-providers.IDPSAML.html +1 -1
  363. package/website/types/identity-providers.IDPsStatus.html +1 -1
  364. package/website/types/identity-providers.Links.html +3 -3
  365. package/website/types/identity-providers.PendingResult.html +1 -1
  366. package/website/types/interceptors.RestInterceptor.html +1 -1
  367. package/website/types/invoke-fetch-types.DownloadableBlob.html +1 -1
  368. package/website/types/items.ItemsSettingsPatch.html +1 -1
  369. package/website/types/licenses.AssignmentsActionsAddRequest.html +1 -1
  370. package/website/types/licenses.AssignmentsActionsAddResponse.html +1 -1
  371. package/website/types/licenses.AssignmentsActionsDeleteRequest.html +1 -1
  372. package/website/types/licenses.AssignmentsActionsDeleteResponse.html +1 -1
  373. package/website/types/licenses.AssignmentsActionsUpdateRequest.html +1 -1
  374. package/website/types/licenses.AssignmentsActionsUpdateResponse.html +1 -1
  375. package/website/types/licenses.AssignmentsResponse.html +1 -1
  376. package/website/types/licenses.ConsumptionEventsResponse.html +1 -1
  377. package/website/types/licenses.ErrorResponse.html +1 -1
  378. package/website/types/licenses.LicenseOverview.html +2 -2
  379. package/website/types/lineage-graphs.ErrorResponse500.html +1 -1
  380. package/website/types/lineage-graphs.Graph.html +1 -1
  381. package/website/types/lineage-graphs.Node.html +1 -1
  382. package/website/types/ml.APIError.html +1 -1
  383. package/website/types/ml.AliasFindResponse.html +1 -1
  384. package/website/types/ml.AliasGetResponse.html +1 -1
  385. package/website/types/ml.AliasPostResponse.html +1 -1
  386. package/website/types/ml.BatchPredictionActionResponse.html +1 -1
  387. package/website/types/ml.BatchPredictionFindResponse.html +1 -1
  388. package/website/types/ml.BatchPredictionGetResponse.html +1 -1
  389. package/website/types/ml.BatchPredictionPatch.html +1 -1
  390. package/website/types/ml.BatchPredictionPostResponse.html +1 -1
  391. package/website/types/ml.BatchPredictionScheduleGetResponse.html +1 -1
  392. package/website/types/ml.BatchPredictionScheduleInput.html +1 -1
  393. package/website/types/ml.BatchPredictionSchedulePatch.html +1 -1
  394. package/website/types/ml.BatchPredictionSchedulePutResponse.html +1 -1
  395. package/website/types/ml.DeploymentFindResponse.html +1 -1
  396. package/website/types/ml.DeploymentGetResponse.html +1 -1
  397. package/website/types/ml.DeploymentPatch.html +1 -1
  398. package/website/types/ml.DeploymentPostResponse.html +1 -1
  399. package/website/types/ml.ExperimentFindResponse.html +1 -1
  400. package/website/types/ml.ExperimentGetResponse.html +1 -1
  401. package/website/types/ml.ExperimentInput.html +1 -1
  402. package/website/types/ml.ExperimentModelRecommendationPostResponse.html +1 -1
  403. package/website/types/ml.ExperimentPostResponse.html +1 -1
  404. package/website/types/ml.ExperimentType.html +1 -1
  405. package/website/types/ml.ExperimentVersionFindResponse.html +1 -1
  406. package/website/types/ml.ExperimentVersionGetResponse.html +1 -1
  407. package/website/types/ml.ExperimentVersionPatch.html +1 -1
  408. package/website/types/ml.ExperimentVersionPostResponse.html +1 -1
  409. package/website/types/ml.Insights.html +1 -1
  410. package/website/types/ml.ModelAlgorithm.html +1 -1
  411. package/website/types/ml.ModelAlgorithmAbbreviation.html +1 -1
  412. package/website/types/ml.ModelFindResponse.html +1 -1
  413. package/website/types/ml.ModelGetResponse.html +1 -1
  414. package/website/types/ml.Pipeline.html +2 -3
  415. package/website/types/ml.ProfileInsights.html +1 -1
  416. package/website/types/ml.ProfileInsightsGetResponse.html +1 -1
  417. package/website/types/ml.ProfileInsightsInput.html +1 -1
  418. package/website/types/ml.ResponseLinks.html +5 -5
  419. package/website/types/notifications.NotificationItem.html +1 -1
  420. package/website/types/oauth-clients.ClientSecrets.html +1 -1
  421. package/website/types/oauth-clients.OAuthClientAdminListItem.html +1 -1
  422. package/website/types/oauth-clients.OAuthClientAdminReadResponse.html +1 -1
  423. package/website/types/oauth-clients.OAuthClientCreateRequest.html +1 -1
  424. package/website/types/oauth-clients.OAuthClientCreateResponse.html +1 -1
  425. package/website/types/oauth-clients.OAuthClientReadResponse.html +1 -1
  426. package/website/types/qix.BookmarkList.html +3 -6
  427. package/website/types/qix.BookmarkListDef.html +2 -5
  428. package/website/types/qix.DocAction.html +1 -1
  429. package/website/types/qix.NativeGenericObjectFunctions.html +1 -1
  430. package/website/types/qix.RpcObject.html +1 -1
  431. package/website/types/qix.UndoInfoObject.html +1 -1
  432. package/website/types/qix.UseAppHook.html +1 -1
  433. package/website/types/questions.Error.html +1 -1
  434. package/website/types/questions.NLMetricsResponse.html +1 -1
  435. package/website/types/quotas.Quota.html +1 -1
  436. package/website/types/reload-tasks.PostTaskBody.html +1 -1
  437. package/website/types/reload-tasks.PutTaskBody.html +1 -1
  438. package/website/types/reload-tasks.Task.html +1 -1
  439. package/website/types/reports.CreateReportHttpResponse.html +2 -2
  440. package/website/types/reports.GetReportOutputsHttpError.html +4 -0
  441. package/website/types/reports.GetReportOutputsHttpResponse.html +6 -0
  442. package/website/types/reports.LinkResponse.html +2 -0
  443. package/website/types/reports.LinksResponse.html +7 -0
  444. package/website/types/reports.OutputList.html +4 -0
  445. package/website/types/reports.OutputListItem.html +13 -0
  446. package/website/types/reports.PdfOutput.html +1 -1
  447. package/website/types/reports.PostReportsResponse.html +7 -0
  448. package/website/types/roles.Error.html +1 -1
  449. package/website/types/sharing-tasks.SharingExecutionListResponse.html +1 -1
  450. package/website/types/sharing-tasks.SharingTaskRecurringListResponse.html +1 -1
  451. package/website/types/sharing-tasks.SharingTaskRecurringResponse.html +1 -1
  452. package/website/types/spaces.Assignments.html +1 -1
  453. package/website/types/spaces.Error.html +1 -1
  454. package/website/types/spaces.Errors.html +1 -1
  455. package/website/types/spaces.SharePatch.html +1 -1
  456. package/website/types/spaces.ShareRoleType.html +2 -2
  457. package/website/types/spaces.Shares.html +1 -1
  458. package/website/types/spaces.Space.html +1 -1
  459. package/website/types/spaces.SpacePatch.html +1 -1
  460. package/website/types/spaces.Spaces.html +1 -1
  461. package/website/types/tasks.Action.html +1 -1
  462. package/website/types/tasks.Crondef.html +1 -1
  463. package/website/types/tasks.Eventstate.html +1 -1
  464. package/website/types/tasks.Functionref.html +1 -1
  465. package/website/types/tasks.GetTaskRunLogHttpResponse.html +1 -1
  466. package/website/types/tasks.Schedule.html +1 -1
  467. package/website/types/temp-contents.Error.html +1 -1
  468. package/website/types/tenants.Error.html +1 -1
  469. package/website/types/tenants.Tenant.html +1 -1
  470. package/website/types/tenants.TenantPatchErrors.html +1 -1
  471. package/website/types/tenants.TenantPatchSchema.html +1 -1
  472. package/website/types/transports.DeleteConfigNotFoundError.html +1 -1
  473. package/website/types/transports.SendTestMailConfigNotFoundError.html +1 -1
  474. package/website/types/transports.TenantAdminError.html +1 -1
  475. package/website/types/transports.UpdateEmailConfigError.html +1 -1
  476. package/website/types/transports.VerifyConnectionConfigNotFoundError.html +1 -1
  477. package/website/types/ui-config.JSONPatchPinnedLinkPayload.html +1 -1
  478. package/website/types/users.AssignedGroups.html +1 -1
  479. package/website/types/users.AssignedGroupsRefNames.html +1 -1
  480. package/website/types/users.AssignedRoles.html +1 -1
  481. package/website/types/users.Error.html +1 -1
  482. package/website/types/users.InviteErrorItem.html +1 -1
  483. package/website/types/users.RefIDs.html +1 -1
  484. package/website/types/users.RefNames.html +1 -1
  485. package/website/types/users.User.html +1 -1
  486. package/website/types/users.Users.html +1 -1
  487. package/website/types/web-integrations.Error.html +1 -1
  488. package/website/types/web-integrations.WebIntegrationPost.html +1 -1
  489. package/website/types/web-integrations.WebIntegrations.html +1 -1
  490. package/website/types/webhooks.Delivery.html +2 -2
  491. package/website/types/webhooks.WebhookPost.html +1 -1
  492. package/website/types/webhooks.WebhookResponse.html +1 -1
  493. package/website/variables/index.auth.html +1 -1
  494. package/website/variables/index.createQlikApi.html +1 -1
  495. package/website/variables/qix.QIX_SCHEMA_VERSION.html +1 -1
  496. package/chunks/global-types-CQrlc6w9.js +0 -0
  497. package/website/types/ml.ConfigurationKey.html +0 -1
  498. package/website/types/ml.DataSchemaConfiguration.html +0 -3
  499. package/website/types/qix.NxGroupMember.html +0 -2
@@ -6,28 +6,28 @@
6
6
  <a href="#patchdataset" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>patch<wbr/>Data<wbr/>Set</span></a>
7
7
  <a href="#updatedataset" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>update<wbr/>Data<wbr/>Set</span></a>
8
8
  </div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Properties</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="clearcache"><span>clear<wbr/>Cache</span><a href="#clearcache" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">clearCache</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span></div><div class="tsd-comment tsd-typography"><p>Clears the cache for data-sets api requests.</p>
9
- </div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Clears the cache for data-sets api requests.</p>
9
+ </div><div class="tsd-type-declaration"><h4>Type Declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Clears the cache for data-sets api requests.</p>
10
10
  </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="createdataset"><span>create<wbr/>Data<wbr/>Set</span><a href="#createdataset" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">createDataSet</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">body</span><span class="tsd-signature-symbol">:</span> <a href="../types/data-sets.DataSet.html" class="tsd-signature-type tsd-kind-type-alias">DataSet</a><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/data-sets.CreateDataSetHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">CreateDataSetHttpResponse</a><span class="tsd-signature-symbol">&gt;</span></div><div class="tsd-comment tsd-typography"><p>Save new data set</p>
11
- </div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">body</span><span class="tsd-signature-symbol">:</span> <a href="../types/data-sets.DataSet.html" class="tsd-signature-type tsd-kind-type-alias">DataSet</a><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/data-sets.CreateDataSetHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">CreateDataSetHttpResponse</a><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Save new data set</p>
11
+ </div><div class="tsd-type-declaration"><h4>Type Declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">body</span><span class="tsd-signature-symbol">:</span> <a href="../types/data-sets.DataSet.html" class="tsd-signature-type tsd-kind-type-alias">DataSet</a><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/data-sets.CreateDataSetHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">CreateDataSetHttpResponse</a><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Save new data set</p>
12
12
  </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">body</span>: <a href="../types/data-sets.DataSet.html" class="tsd-signature-type tsd-kind-type-alias">DataSet</a></span><div class="tsd-comment tsd-typography"><p>an object with the body content</p>
13
13
  </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/data-sets.CreateDataSetHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">CreateDataSetHttpResponse</a><span class="tsd-signature-symbol">&gt;</span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws">Throws<a href="#throws" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>CreateDataSetHttpError</p>
14
14
  </div></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-body">Param: body<a href="#param-body" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>an object with the body content</p>
15
15
  </div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-1">Throws<a href="#throws-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>CreateDataSetHttpError</p>
16
16
  </div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="deletedatasets"><span>delete<wbr/>Data<wbr/>Sets</span><a href="#deletedatasets" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">deleteDataSets</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">body</span><span class="tsd-signature-symbol">:</span> <a href="../types/data-sets.BatchIdDto.html" class="tsd-signature-type tsd-kind-type-alias">BatchIdDto</a><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/data-sets.DeleteDataSetsHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">DeleteDataSetsHttpResponse</a><span class="tsd-signature-symbol">&gt;</span></div><div class="tsd-comment tsd-typography"><p>Batch delete data sets.</p>
17
- </div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">body</span><span class="tsd-signature-symbol">:</span> <a href="../types/data-sets.BatchIdDto.html" class="tsd-signature-type tsd-kind-type-alias">BatchIdDto</a><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/data-sets.DeleteDataSetsHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">DeleteDataSetsHttpResponse</a><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Batch delete data sets.</p>
17
+ </div><div class="tsd-type-declaration"><h4>Type Declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">body</span><span class="tsd-signature-symbol">:</span> <a href="../types/data-sets.BatchIdDto.html" class="tsd-signature-type tsd-kind-type-alias">BatchIdDto</a><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/data-sets.DeleteDataSetsHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">DeleteDataSetsHttpResponse</a><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Batch delete data sets.</p>
18
18
  </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">body</span>: <a href="../types/data-sets.BatchIdDto.html" class="tsd-signature-type tsd-kind-type-alias">BatchIdDto</a></span><div class="tsd-comment tsd-typography"><p>an object with the body content</p>
19
19
  </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/data-sets.DeleteDataSetsHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">DeleteDataSetsHttpResponse</a><span class="tsd-signature-symbol">&gt;</span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-2">Throws<a href="#throws-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>DeleteDataSetsHttpError</p>
20
20
  </div></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-body-1">Param: body<a href="#param-body-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>an object with the body content</p>
21
21
  </div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-3">Throws<a href="#throws-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>DeleteDataSetsHttpError</p>
22
22
  </div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getdataset"><span>get<wbr/>Data<wbr/>Set</span><a href="#getdataset" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">getDataSet</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">dataSetId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">query</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">projections</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/data-sets.GetDataSetHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetDataSetHttpResponse</a><span class="tsd-signature-symbol">&gt;</span></div><div class="tsd-comment tsd-typography"><p>Get data set by ID.</p>
23
- </div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">dataSetId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">query</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">projections</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/data-sets.GetDataSetHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetDataSetHttpResponse</a><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get data set by ID.</p>
23
+ </div><div class="tsd-type-declaration"><h4>Type Declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">dataSetId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">query</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">projections</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/data-sets.GetDataSetHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetDataSetHttpResponse</a><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get data set by ID.</p>
24
24
  </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">dataSetId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">query</span>: <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">projections</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span> <span class="tsd-signature-symbol">}</span></span><div class="tsd-comment tsd-typography"><p>an object with query parameters</p>
25
25
  </div><div class="tsd-comment tsd-typography"></div><ul class="tsd-parameters"><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">projections</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5><div class="tsd-comment tsd-typography"><p>Comma-separated fields to return in the response.</p>
26
26
  </div><div class="tsd-comment tsd-typography"></div></li></ul></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/data-sets.GetDataSetHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetDataSetHttpResponse</a><span class="tsd-signature-symbol">&gt;</span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-4">Throws<a href="#throws-4" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>GetDataSetHttpError</p>
27
27
  </div></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-datasetid">Param: dataSetId<a href="#param-datasetid" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4></div><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-query">Param: query<a href="#param-query" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>an object with query parameters</p>
28
28
  </div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-5">Throws<a href="#throws-5" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>GetDataSetHttpError</p>
29
29
  </div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getdatasetprofiles"><span>get<wbr/>Data<wbr/>Set<wbr/>Profiles</span><a href="#getdatasetprofiles" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">getDataSetProfiles</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">dataSetId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">query</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span><br/>        <span class="tsd-kind-property">dataConnectionIds</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/>        <span class="tsd-kind-property">limit</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/>        <span class="tsd-kind-property">page</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/>        <span class="tsd-kind-property">projections</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/>        <span class="tsd-kind-property">sort</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/>    <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/data-sets.GetDataSetProfilesHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetDataSetProfilesHttpResponse</a><span class="tsd-signature-symbol">&gt;</span></div><div class="tsd-comment tsd-typography"><p>Get profile for the given dataset and connection Id pair, if the profile already exists in the system. Profile returned can be either latest or Stale one based on when it was computed.</p>
30
- </div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">dataSetId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">query</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span><br/>        <span class="tsd-kind-property">dataConnectionIds</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/>        <span class="tsd-kind-property">limit</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/>        <span class="tsd-kind-property">page</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/>        <span class="tsd-kind-property">projections</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/>        <span class="tsd-kind-property">sort</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/>    <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/data-sets.GetDataSetProfilesHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetDataSetProfilesHttpResponse</a><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get profile for the given dataset and connection Id pair, if the profile already exists in the system. Profile returned can be either latest or Stale one based on when it was computed.</p>
30
+ </div><div class="tsd-type-declaration"><h4>Type Declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">dataSetId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">query</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span><br/>        <span class="tsd-kind-property">dataConnectionIds</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/>        <span class="tsd-kind-property">limit</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/>        <span class="tsd-kind-property">page</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/>        <span class="tsd-kind-property">projections</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/>        <span class="tsd-kind-property">sort</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/>    <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/data-sets.GetDataSetProfilesHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetDataSetProfilesHttpResponse</a><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get profile for the given dataset and connection Id pair, if the profile already exists in the system. Profile returned can be either latest or Stale one based on when it was computed.</p>
31
31
  </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">dataSetId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">query</span>: <span class="tsd-signature-symbol">{</span><br/>    <span class="tsd-kind-property">dataConnectionIds</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/>    <span class="tsd-kind-property">limit</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/>    <span class="tsd-kind-property">page</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/>    <span class="tsd-kind-property">projections</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/>    <span class="tsd-kind-property">sort</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></span><div class="tsd-comment tsd-typography"><p>an object with query parameters</p>
32
32
  </div><div class="tsd-comment tsd-typography"></div><ul class="tsd-parameters"><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">dataConnectionIds</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5><div class="tsd-comment tsd-typography"><p>Comma-separated data connection IDs.</p>
33
33
  </div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">limit</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><p>Page size limit.</p>
@@ -36,13 +36,13 @@
36
36
  </div></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-datasetid-1">Param: dataSetId<a href="#param-datasetid-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4></div><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-query-1">Param: query<a href="#param-query-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>an object with query parameters</p>
37
37
  </div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-7">Throws<a href="#throws-7" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>GetDataSetProfilesHttpError</p>
38
38
  </div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="patchdataset"><span>patch<wbr/>Data<wbr/>Set</span><a href="#patchdataset" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">patchDataSet</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">dataSetId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">body</span><span class="tsd-signature-symbol">:</span> <a href="../types/data-sets.JsonPatch.html" class="tsd-signature-type tsd-kind-type-alias">JsonPatch</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/data-sets.PatchDataSetHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">PatchDataSetHttpResponse</a><span class="tsd-signature-symbol">&gt;</span></div><div class="tsd-comment tsd-typography"><p>Patch data set.</p>
39
- </div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">dataSetId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">body</span><span class="tsd-signature-symbol">:</span> <a href="../types/data-sets.JsonPatch.html" class="tsd-signature-type tsd-kind-type-alias">JsonPatch</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/data-sets.PatchDataSetHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">PatchDataSetHttpResponse</a><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Patch data set.</p>
39
+ </div><div class="tsd-type-declaration"><h4>Type Declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">dataSetId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">body</span><span class="tsd-signature-symbol">:</span> <a href="../types/data-sets.JsonPatch.html" class="tsd-signature-type tsd-kind-type-alias">JsonPatch</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/data-sets.PatchDataSetHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">PatchDataSetHttpResponse</a><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Patch data set.</p>
40
40
  </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">dataSetId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">body</span>: <a href="../types/data-sets.JsonPatch.html" class="tsd-signature-type tsd-kind-type-alias">JsonPatch</a><span class="tsd-signature-symbol">[]</span></span><div class="tsd-comment tsd-typography"><p>an object with the body content</p>
41
41
  </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/data-sets.PatchDataSetHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">PatchDataSetHttpResponse</a><span class="tsd-signature-symbol">&gt;</span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-8">Throws<a href="#throws-8" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>PatchDataSetHttpError</p>
42
42
  </div></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-datasetid-2">Param: dataSetId<a href="#param-datasetid-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4></div><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-body-2">Param: body<a href="#param-body-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>an object with the body content</p>
43
43
  </div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-9">Throws<a href="#throws-9" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>PatchDataSetHttpError</p>
44
44
  </div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="updatedataset"><span>update<wbr/>Data<wbr/>Set</span><a href="#updatedataset" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">updateDataSet</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">dataSetId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">body</span><span class="tsd-signature-symbol">:</span> <a href="../types/data-sets.DataSet.html" class="tsd-signature-type tsd-kind-type-alias">DataSet</a><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/data-sets.UpdateDataSetHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">UpdateDataSetHttpResponse</a><span class="tsd-signature-symbol">&gt;</span></div><div class="tsd-comment tsd-typography"><p>Update data set.</p>
45
- </div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">dataSetId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">body</span><span class="tsd-signature-symbol">:</span> <a href="../types/data-sets.DataSet.html" class="tsd-signature-type tsd-kind-type-alias">DataSet</a><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/data-sets.UpdateDataSetHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">UpdateDataSetHttpResponse</a><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Update data set.</p>
45
+ </div><div class="tsd-type-declaration"><h4>Type Declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">dataSetId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">body</span><span class="tsd-signature-symbol">:</span> <a href="../types/data-sets.DataSet.html" class="tsd-signature-type tsd-kind-type-alias">DataSet</a><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/data-sets.UpdateDataSetHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">UpdateDataSetHttpResponse</a><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Update data set.</p>
46
46
  </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">dataSetId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">body</span>: <a href="../types/data-sets.DataSet.html" class="tsd-signature-type tsd-kind-type-alias">DataSet</a></span><div class="tsd-comment tsd-typography"><p>an object with the body content</p>
47
47
  </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/data-sets.UpdateDataSetHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">UpdateDataSetHttpResponse</a><span class="tsd-signature-symbol">&gt;</span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-10">Throws<a href="#throws-10" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>UpdateDataSetHttpError</p>
48
48
  </div></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-datasetid-3">Param: dataSetId<a href="#param-datasetid-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4></div><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-body-3">Param: body<a href="#param-body-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>an object with the body content</p>
@@ -1,11 +1,11 @@
1
- <!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>DataSourcesAPI | @qlik/api reference</title><meta name="description" content="Documentation for @qlik/api reference"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><meta name="description" content="@qlik/api reference"/><link rel="icon" type="image/x-icon" href="../assets/favicon.svg"/><link rel="stylesheet" href="../assets/typedoc-qlik-style.css"/></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><nav class="tsd-toolbar-nav"><div class="tsd-toolbar-contents container"><div class="tsd-toolbar-left-section"><a class="tsd-toolbar-logo-link" href="https://qlik.dev" target="_blank" rel="noreferrer"><img class="tsd-toolbar-logo" src="../assets/logo-header.svg" alt="Qlik Logo"/></a><a href="../index.html" class="title">@qlik/api reference</a></div><div class="tsd-toolbar-right-section"><input type="checkbox" id="tsd-toolbar-nav-toggle" class="tsd-toolbar-nav-toggle" aria-label="Toggle navigation"/><label for="tsd-toolbar-nav-toggle" class="tsd-toolbar-dropdown" aria-hidden="true"><svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 16 16" fill="currentColor"><path d="m8 9 4.5-4.5L14 6l-4.5 4.5L8 12 2 6l1.5-1.5L8 9Z" /></svg></label><div class="tsd-toolbar-desktop-nav"><div class="tsd-toolbar-links"><ul class="tsd-toolbar-nav-section"><li><a href="https://qlik.dev/embed/">Embed</a></li><li><a href="https://qlik.dev/extend/">Extend</a></li><li><a href="https://qlik.dev/manage/">Manage</a></li><li><a href="https://qlik.dev/apis/">APIs</a></li><li><a href="https://qlik.dev/toolkits/">Toolkits</a></li></ul></div></div><nav class="tsd-toolbar-mobile-nav"><div class="tsd-toolbar-links"><ul class="tsd-toolbar-nav-section"><li><a href="https://qlik.dev/embed/">Embed</a></li><li><a href="https://qlik.dev/extend/">Extend</a></li><li><a href="https://qlik.dev/manage/">Manage</a></li><li><a href="https://qlik.dev/apis/">APIs</a></li><li><a href="https://qlik.dev/toolkits/">Toolkits</a></li></ul></div></nav><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" aria-label="Search the docs" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 16 16" fill="currentColor"><path d="M15,4 L1,4 L1,2 L15,2 L15,4 Z M15,14 L1,14 L1,12 L15,12 L15,14 Z M15,9 L1,9 L1,7 L15,7 L15,9 Z" /></svg></a></div></div></nav><meta name="description" content="@qlik/api reference"/><link rel="icon" type="image/x-icon" href="../assets/favicon.svg"/><link rel="stylesheet" href="../assets/typedoc-qlik-style.css"/></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="../modules/data-sources.html">data-sources</a></li><li><a href="" aria-current="page">DataSourcesAPI</a></li></ul><h1>Interface DataSourcesAPI</h1></div><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">DataSourcesAPI</span> <span class="tsd-signature-symbol">{</span><br/>    <a class="tsd-kind-property" href="#clearcache">clearCache</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#getdatasourceapispecs">getDataSourceApiSpecs</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/>        <span class="tsd-kind-parameter">dataSourceId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>        <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/data-sources.GetDataSourceApiSpecsHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetDataSourceApiSpecsHttpResponse</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#getdatasourcegateways">getDataSourceGateways</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/>        <span class="tsd-kind-parameter">dataSourceId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>        <span class="tsd-kind-parameter">query</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">forceRefresh</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">,</span><br/>        <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/data-sources.GetDataSourceGatewaysHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetDataSourceGatewaysHttpResponse</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#getdatasources">getDataSources</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/>        <span class="tsd-kind-parameter">query</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">dataSourceId</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">detail</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">includeui</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">,</span><br/>        <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/data-sources.GetDataSourcesHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetDataSourcesHttpResponse</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h5 class="tsd-index-heading uppercase">Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="#clearcache" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>clear<wbr/>Cache</span></a>
1
+ <!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>DataSourcesAPI | @qlik/api reference</title><meta name="description" content="Documentation for @qlik/api reference"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><meta name="description" content="@qlik/api reference"/><link rel="icon" type="image/x-icon" href="../assets/favicon.svg"/><link rel="stylesheet" href="../assets/typedoc-qlik-style.css"/></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><nav class="tsd-toolbar-nav"><div class="tsd-toolbar-contents container"><div class="tsd-toolbar-left-section"><a class="tsd-toolbar-logo-link" href="https://qlik.dev" target="_blank" rel="noreferrer"><img class="tsd-toolbar-logo" src="../assets/logo-header.svg" alt="Qlik Logo"/></a><a href="../index.html" class="title">@qlik/api reference</a></div><div class="tsd-toolbar-right-section"><input type="checkbox" id="tsd-toolbar-nav-toggle" class="tsd-toolbar-nav-toggle" aria-label="Toggle navigation"/><label for="tsd-toolbar-nav-toggle" class="tsd-toolbar-dropdown" aria-hidden="true"><svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 16 16" fill="currentColor"><path d="m8 9 4.5-4.5L14 6l-4.5 4.5L8 12 2 6l1.5-1.5L8 9Z" /></svg></label><div class="tsd-toolbar-desktop-nav"><div class="tsd-toolbar-links"><ul class="tsd-toolbar-nav-section"><li><a href="https://qlik.dev/embed/">Embed</a></li><li><a href="https://qlik.dev/extend/">Extend</a></li><li><a href="https://qlik.dev/manage/">Manage</a></li><li><a href="https://qlik.dev/apis/">APIs</a></li><li><a href="https://qlik.dev/toolkits/">Toolkits</a></li></ul></div></div><nav class="tsd-toolbar-mobile-nav"><div class="tsd-toolbar-links"><ul class="tsd-toolbar-nav-section"><li><a href="https://qlik.dev/embed/">Embed</a></li><li><a href="https://qlik.dev/extend/">Extend</a></li><li><a href="https://qlik.dev/manage/">Manage</a></li><li><a href="https://qlik.dev/apis/">APIs</a></li><li><a href="https://qlik.dev/toolkits/">Toolkits</a></li></ul></div></nav><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" aria-label="Search the docs" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 16 16" fill="currentColor"><path d="M15,4 L1,4 L1,2 L15,2 L15,4 Z M15,14 L1,14 L1,12 L15,12 L15,14 Z M15,9 L1,9 L1,7 L15,7 L15,9 Z" /></svg></a></div></div></nav><meta name="description" content="@qlik/api reference"/><link rel="icon" type="image/x-icon" href="../assets/favicon.svg"/><link rel="stylesheet" href="../assets/typedoc-qlik-style.css"/></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="../modules/data-sources.html">data-sources</a></li><li><a href="" aria-current="page">DataSourcesAPI</a></li></ul><h1>Interface DataSourcesAPI</h1></div><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">DataSourcesAPI</span> <span class="tsd-signature-symbol">{</span><br/>    <a class="tsd-kind-property" href="#clearcache">clearCache</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#getdatasourceapispecs">getDataSourceApiSpecs</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/>        <span class="tsd-kind-parameter">dataSourceId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>        <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/data-sources.GetDataSourceApiSpecsHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetDataSourceApiSpecsHttpResponse</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#getdatasourcegateways">getDataSourceGateways</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/>        <span class="tsd-kind-parameter">dataSourceId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>        <span class="tsd-kind-parameter">query</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">forceRefresh</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">,</span><br/>        <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/data-sources.GetDataSourceGatewaysHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetDataSourceGatewaysHttpResponse</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#getdatasources">getDataSources</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/>        <span class="tsd-kind-parameter">query</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span><br/>            <span class="tsd-kind-property">dataSourceId</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/>            <span class="tsd-kind-property">detail</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/>            <span class="tsd-kind-property">includeDisabled</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/>            <span class="tsd-kind-property">includeui</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/>        <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">,</span><br/>        <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/data-sources.GetDataSourcesHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetDataSourcesHttpResponse</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h5 class="tsd-index-heading uppercase">Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="#clearcache" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>clear<wbr/>Cache</span></a>
2
2
  <a href="#getdatasourceapispecs" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>get<wbr/>Data<wbr/>Source<wbr/>Api<wbr/>Specs</span></a>
3
3
  <a href="#getdatasourcegateways" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>get<wbr/>Data<wbr/>Source<wbr/>Gateways</span></a>
4
4
  <a href="#getdatasources" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>get<wbr/>Data<wbr/>Sources</span></a>
5
5
  </div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Properties</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="clearcache"><span>clear<wbr/>Cache</span><a href="#clearcache" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">clearCache</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span></div><div class="tsd-comment tsd-typography"><p>Clears the cache for data-sources api requests.</p>
6
- </div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Clears the cache for data-sources api requests.</p>
6
+ </div><div class="tsd-type-declaration"><h4>Type Declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Clears the cache for data-sources api requests.</p>
7
7
  </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getdatasourceapispecs"><span>get<wbr/>Data<wbr/>Source<wbr/>Api<wbr/>Specs</span><a href="#getdatasourceapispecs" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">getDataSourceApiSpecs</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">dataSourceId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/data-sources.GetDataSourceApiSpecsHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetDataSourceApiSpecsHttpResponse</a><span class="tsd-signature-symbol">&gt;</span></div><div class="tsd-comment tsd-typography"><p>Get 'connectionProperties' for a given datasource</p>
8
- </div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">dataSourceId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/data-sources.GetDataSourceApiSpecsHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetDataSourceApiSpecsHttpResponse</a><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get 'connectionProperties' for a given datasource</p>
8
+ </div><div class="tsd-type-declaration"><h4>Type Declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">dataSourceId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/data-sources.GetDataSourceApiSpecsHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetDataSourceApiSpecsHttpResponse</a><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get 'connectionProperties' for a given datasource</p>
9
9
  </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">dataSourceId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>Datasource ID</p>
10
10
  </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/data-sources.GetDataSourceApiSpecsHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetDataSourceApiSpecsHttpResponse</a><span class="tsd-signature-symbol">&gt;</span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example">Example<a href="#example" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-3">getDataSourceApiSpecs</span><span class="hl-0">(</span><br/><span class="hl-0"> </span><span class="hl-1">&quot;rest&quot;</span><br/><span class="hl-0">)</span>
11
11
  </code><button type="button">Copy</button></pre>
@@ -17,7 +17,7 @@
17
17
  </div><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-datasourceid">Param: dataSourceId<a href="#param-datasourceid" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>Datasource ID</p>
18
18
  </div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-1">Throws<a href="#throws-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>GetDataSourceApiSpecsHttpError</p>
19
19
  </div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getdatasourcegateways"><span>get<wbr/>Data<wbr/>Source<wbr/>Gateways</span><a href="#getdatasourcegateways" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">getDataSourceGateways</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">dataSourceId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">query</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">forceRefresh</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/data-sources.GetDataSourceGatewaysHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetDataSourceGatewaysHttpResponse</a><span class="tsd-signature-symbol">&gt;</span></div><div class="tsd-comment tsd-typography"><p>Get list available gateway ID's for a given datasource</p>
20
- </div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">dataSourceId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">query</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">forceRefresh</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/data-sources.GetDataSourceGatewaysHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetDataSourceGatewaysHttpResponse</a><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get list available gateway ID's for a given datasource</p>
20
+ </div><div class="tsd-type-declaration"><h4>Type Declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">dataSourceId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">query</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">forceRefresh</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/data-sources.GetDataSourceGatewaysHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetDataSourceGatewaysHttpResponse</a><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get list available gateway ID's for a given datasource</p>
21
21
  </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">dataSourceId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>Datasource ID</p>
22
22
  </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">query</span>: <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">forceRefresh</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span> <span class="tsd-signature-symbol">}</span></span><div class="tsd-comment tsd-typography"><p>an object with query parameters</p>
23
23
  </div><div class="tsd-comment tsd-typography"></div><ul class="tsd-parameters"><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">forceRefresh</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><p>Force to get a refreshed list from backend. Cached list will be returned if not set or set to false.</p>
@@ -31,17 +31,18 @@
31
31
  </div><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-datasourceid-1">Param: dataSourceId<a href="#param-datasourceid-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>Datasource ID</p>
32
32
  </div><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-query">Param: query<a href="#param-query" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>an object with query parameters</p>
33
33
  </div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-3">Throws<a href="#throws-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>GetDataSourceGatewaysHttpError</p>
34
- </div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getdatasources"><span>get<wbr/>Data<wbr/>Sources</span><a href="#getdatasources" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">getDataSources</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">query</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">dataSourceId</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">detail</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">includeui</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/data-sources.GetDataSourcesHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetDataSourcesHttpResponse</a><span class="tsd-signature-symbol">&gt;</span></div><div class="tsd-comment tsd-typography"><p>Gets the list of data sources available on the node.</p>
35
- </div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">query</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">dataSourceId</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">detail</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">includeui</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/data-sources.GetDataSourcesHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetDataSourcesHttpResponse</a><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Gets the list of data sources available on the node.</p>
36
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">query</span>: <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">dataSourceId</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">detail</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">includeui</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span> <span class="tsd-signature-symbol">}</span></span><div class="tsd-comment tsd-typography"><p>an object with query parameters</p>
34
+ </div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getdatasources"><span>get<wbr/>Data<wbr/>Sources</span><a href="#getdatasources" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">getDataSources</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">query</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span><br/>        <span class="tsd-kind-property">dataSourceId</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/>        <span class="tsd-kind-property">detail</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/>        <span class="tsd-kind-property">includeDisabled</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/>        <span class="tsd-kind-property">includeui</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/>    <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/data-sources.GetDataSourcesHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetDataSourcesHttpResponse</a><span class="tsd-signature-symbol">&gt;</span></div><div class="tsd-comment tsd-typography"><p>Gets the list of data sources available on the node.</p>
35
+ </div><div class="tsd-type-declaration"><h4>Type Declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">query</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span><br/>        <span class="tsd-kind-property">dataSourceId</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/>        <span class="tsd-kind-property">detail</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/>        <span class="tsd-kind-property">includeDisabled</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/>        <span class="tsd-kind-property">includeui</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/>    <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/data-sources.GetDataSourcesHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetDataSourcesHttpResponse</a><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Gets the list of data sources available on the node.</p>
36
+ </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">query</span>: <span class="tsd-signature-symbol">{</span><br/>    <span class="tsd-kind-property">dataSourceId</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/>    <span class="tsd-kind-property">detail</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/>    <span class="tsd-kind-property">includeDisabled</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/>    <span class="tsd-kind-property">includeui</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></span><div class="tsd-comment tsd-typography"><p>an object with query parameters</p>
37
37
  </div><div class="tsd-comment tsd-typography"></div><ul class="tsd-parameters"><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">dataSourceId</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>Filtering on datasourceID, when multiple dataSourceId are set in query, last dataSourceId will be used</p>
38
38
  </div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">detail</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><p>Determines if provider detail is returned</p>
39
+ </div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">includeDisabled</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><p>When true disabled datasources are also included in the response</p>
39
40
  </div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">includeui</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><p>Determines if UI info is returned</p>
40
- </div><div class="tsd-comment tsd-typography"></div></li></ul></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/data-sources.GetDataSourcesHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetDataSourcesHttpResponse</a><span class="tsd-signature-symbol">&gt;</span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-4">Example<a href="#example-4" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-3">getDataSources</span><span class="hl-0">(</span><br/><span class="hl-0"> {</span><br/><span class="hl-0"> dataSourceId: </span><span class="hl-1">&quot;rest&quot;</span><span class="hl-0">,</span><br/><span class="hl-0"> detail: </span><span class="hl-2">true</span><span class="hl-0">,</span><br/><span class="hl-0"> includeui: </span><span class="hl-2">true</span><br/><span class="hl-0"> }</span><br/><span class="hl-0">)</span>
41
+ </div><div class="tsd-comment tsd-typography"></div></li></ul></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/data-sources.GetDataSourcesHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetDataSourcesHttpResponse</a><span class="tsd-signature-symbol">&gt;</span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-4">Example<a href="#example-4" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-3">getDataSources</span><span class="hl-0">(</span><br/><span class="hl-0"> {</span><br/><span class="hl-0"> dataSourceId: </span><span class="hl-1">&quot;rest&quot;</span><span class="hl-0">,</span><br/><span class="hl-0"> detail: </span><span class="hl-2">true</span><span class="hl-0">,</span><br/><span class="hl-0"> includeDisabled: </span><span class="hl-2">true</span><span class="hl-0">,</span><br/><span class="hl-0"> includeui: </span><span class="hl-2">true</span><br/><span class="hl-0"> }</span><br/><span class="hl-0">)</span>
41
42
  </code><button type="button">Copy</button></pre>
42
43
 
43
44
  </div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-4">Throws<a href="#throws-4" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>GetDataSourcesHttpError</p>
44
- </div></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-5">Example<a href="#example-5" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-3">getDataSources</span><span class="hl-0">(</span><br/><span class="hl-0"> {</span><br/><span class="hl-0"> dataSourceId: </span><span class="hl-1">&quot;rest&quot;</span><span class="hl-0">,</span><br/><span class="hl-0"> detail: </span><span class="hl-2">true</span><span class="hl-0">,</span><br/><span class="hl-0"> includeui: </span><span class="hl-2">true</span><br/><span class="hl-0"> }</span><br/><span class="hl-0">)</span>
45
+ </div></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-5">Example<a href="#example-5" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-3">getDataSources</span><span class="hl-0">(</span><br/><span class="hl-0"> {</span><br/><span class="hl-0"> dataSourceId: </span><span class="hl-1">&quot;rest&quot;</span><span class="hl-0">,</span><br/><span class="hl-0"> detail: </span><span class="hl-2">true</span><span class="hl-0">,</span><br/><span class="hl-0"> includeDisabled: </span><span class="hl-2">true</span><span class="hl-0">,</span><br/><span class="hl-0"> includeui: </span><span class="hl-2">true</span><br/><span class="hl-0"> }</span><br/><span class="hl-0">)</span>
45
46
  </code><button type="button">Copy</button></pre>
46
47
 
47
48
  </div><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-query-1">Param: query<a href="#param-query-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>an object with query parameters</p>