@qlik/api 1.45.0 → 1.46.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 (489) hide show
  1. package/api-keys.d.ts +2 -2
  2. package/api-keys.js +2 -2
  3. package/apps.d.ts +2 -2
  4. package/apps.js +2 -2
  5. package/assistants.d.ts +2 -2
  6. package/assistants.js +2 -2
  7. package/audits.d.ts +2 -2
  8. package/audits.js +2 -2
  9. package/auth-types.d.ts +1 -1
  10. package/auth.d.ts +2 -2
  11. package/auth.js +2 -2
  12. package/automation-connections.d.ts +2 -2
  13. package/automation-connections.js +2 -2
  14. package/automations.d.ts +2 -2
  15. package/automations.js +2 -2
  16. package/automl-deployments.d.ts +2 -2
  17. package/automl-deployments.js +2 -2
  18. package/automl-predictions.d.ts +2 -2
  19. package/automl-predictions.js +2 -2
  20. package/brands.d.ts +2 -2
  21. package/brands.js +2 -2
  22. package/chunks/{api-keys-C-ZqA-wl.d.ts → api-keys-D0c8ujRu.d.ts} +3 -3
  23. package/chunks/{apps-k7oY1h_6.d.ts → apps-CdqN0t8i.d.ts} +3 -3
  24. package/chunks/{assistants-BsDbpzl4.d.ts → assistants-BW8V6f0F.d.ts} +36 -36
  25. package/chunks/{audits-5CBpwcdx.d.ts → audits-D0ad6UDR.d.ts} +3 -3
  26. package/chunks/{auth-DFOXWfqh.d.ts → auth-DKv6n_GN.d.ts} +1 -1
  27. package/chunks/{auth-Do2Z8IEt.js → auth-DnVBiC8q.js} +1 -1
  28. package/chunks/{auth-DH6Zx6GE.js → auth-PA8-Loxu.js} +1 -1
  29. package/chunks/{auth-functions-By9Ryr3H.js → auth-functions-B3j26XdM.js} +31 -1
  30. package/chunks/{auth-types-B1c_1Nca.d.ts → auth-types-ua5FEdjz.d.ts} +5 -0
  31. package/chunks/{automation-connections-DRQDgw7Q.d.ts → automation-connections-BJuPyGkj.d.ts} +3 -3
  32. package/chunks/{automations-C0rperoU.d.ts → automations-DDzikXsW.d.ts} +3 -3
  33. package/chunks/{automl-deployments-B-WuR_zE.d.ts → automl-deployments-RC6MYluL.d.ts} +3 -3
  34. package/chunks/{automl-predictions-CewW0eZn.d.ts → automl-predictions-BC_cxfIy.d.ts} +3 -3
  35. package/chunks/{brands-C4eALPrs.d.ts → brands-JtflEMN1.d.ts} +3 -3
  36. package/chunks/{collections-Djmd9gof.d.ts → collections-B17vc2zP.d.ts} +3 -3
  37. package/chunks/{conditions-BRDxUbgu.d.ts → conditions-JgsgLbSx.d.ts} +3 -3
  38. package/chunks/{consumption-UNw8R7jN.d.ts → consumption-BBGQgCsU.d.ts} +3 -3
  39. package/chunks/{csp-origins-_4HBSdgU.d.ts → csp-origins-C2z2ryaw.d.ts} +3 -3
  40. package/chunks/{csrf-token-CsvbqXyY.d.ts → csrf-token-Cwz241tT.d.ts} +3 -3
  41. package/chunks/{data-alerts-DSV3VOnW.d.ts → data-alerts-rxwsP4C7.d.ts} +3 -3
  42. package/chunks/{data-assets-C3U3T_lj.d.ts → data-assets-BRJ0MQgV.d.ts} +3 -3
  43. package/chunks/{data-connections-CYbObLbP.d.ts → data-connections-9H_4Pih5.d.ts} +3 -3
  44. package/chunks/{data-credentials-CgCjw_Cn.d.ts → data-credentials-AULREOtn.d.ts} +3 -3
  45. package/chunks/{data-files-DH19MfYE.d.ts → data-files-CDxGxSIx.d.ts} +3 -3
  46. package/chunks/{data-qualities-BogHQw4I.d.ts → data-qualities-B-v0Njga.d.ts} +3 -3
  47. package/chunks/{data-sets-B27GmshO.d.ts → data-sets-ChmF7dI4.d.ts} +3 -3
  48. package/chunks/{data-sources-3oHpGsDR.d.ts → data-sources-oBO7aHct.d.ts} +3 -3
  49. package/chunks/{data-stores-BjfzMp9W.d.ts → data-stores-C2RE1Aos.d.ts} +3 -3
  50. package/chunks/{dcaas-A7hfpAI5.d.ts → dcaas-D4iZGtLn.d.ts} +3 -3
  51. package/chunks/{di-projects-BmqI8HAl.d.ts → di-projects-BxX0b3lC.d.ts} +3 -3
  52. package/chunks/{direct-access-agents-CfUpbi73.d.ts → direct-access-agents-XxiAo3y9.d.ts} +3 -3
  53. package/chunks/{encryption-CjBmNQDZ.d.ts → encryption-1JNNXFB7.d.ts} +3 -3
  54. package/chunks/{extensions-D05y2FWk.d.ts → extensions-qbclNpnA.d.ts} +3 -3
  55. package/chunks/{glossaries-vYbykU3r.d.ts → glossaries-g1PPnHoM.d.ts} +17 -17
  56. package/chunks/{groups-BapgngJf.d.ts → groups-DrqKqkAv.d.ts} +3 -3
  57. package/chunks/{identity-providers-CAxsp9hP.d.ts → identity-providers-iRAccwIg.d.ts} +3 -3
  58. package/chunks/{interceptors-BF556LaK.d.ts → interceptors-DHkfs1ua.d.ts} +1 -1
  59. package/chunks/{invoke-fetch-hML-5n7w.js → invoke-fetch-BxHtZ6mc.js} +1 -1
  60. package/chunks/{invoke-fetch-DLQ5LN79.js → invoke-fetch-DUEcQxLv.js} +2 -2
  61. package/chunks/{items-CjVrNg57.d.ts → items-N3gAR5AS.d.ts} +3 -3
  62. package/chunks/{knowledgebases-BFiV7Fwh.d.ts → knowledgebases-B0tcNrg8.d.ts} +3 -3
  63. package/chunks/{licenses-yZKgQ2k6.d.ts → licenses-CrB0eiUU.d.ts} +3 -3
  64. package/chunks/{lineage-graphs-Bkc04N-t.d.ts → lineage-graphs-BL1kIsvQ.d.ts} +3 -3
  65. package/chunks/{ml-CPzq_j0K.d.ts → ml-CQQZV57e.d.ts} +3 -3
  66. package/chunks/{notes-C5HjmBeI.d.ts → notes-BWDOf71L.d.ts} +3 -3
  67. package/chunks/{notifications-DfP7aWPH.d.ts → notifications--FW8kp8T.d.ts} +3 -3
  68. package/chunks/{oauth-clients-BmMEDuET.d.ts → oauth-clients-BDI9_NJw.d.ts} +3 -3
  69. package/chunks/{oauth-tokens-Dimf19DE.d.ts → oauth-tokens-CqViLZD0.d.ts} +3 -3
  70. package/chunks/{public-runtime-modules-n0gcxl0_.js → public-runtime-modules-BWdSJoOb.js} +8 -5
  71. package/chunks/{qix-CbiHOu7Z.d.ts → qix-8oI6W8Iq.d.ts} +3 -3
  72. package/chunks/{qix-B_hHiSSK.js → qix-CkFE9Ji0.js} +1 -1
  73. package/chunks/{qix-Wsz3JE_a.js → qix-OogL83RB.js} +3 -3
  74. package/chunks/{qix-chunk-entrypoint-w25mSjTi.js → qix-chunk-entrypoint-BtxQC2m8.js} +1 -1
  75. package/chunks/{questions-CFN7BgWt.d.ts → questions-DAXXmfTM.d.ts} +3 -3
  76. package/chunks/{quotas-BUH2e2K_.d.ts → quotas-BV0q47cU.d.ts} +3 -3
  77. package/chunks/{reload-tasks-DN3X2-30.d.ts → reload-tasks-DORwZo4c.d.ts} +3 -3
  78. package/chunks/{reloads-CpY6F3Y0.d.ts → reloads-C7RAAgAu.d.ts} +3 -3
  79. package/chunks/{report-templates-D5KOFkRi.d.ts → report-templates-C3P0_-D3.d.ts} +3 -3
  80. package/chunks/{reports-CRwCogRL.d.ts → reports-C7saF89N.d.ts} +3 -3
  81. package/chunks/{roles-DCzyiLdU.d.ts → roles-DBdOYajz.d.ts} +3 -3
  82. package/chunks/{sharing-tasks-DsxFrADQ.d.ts → sharing-tasks-Dm9L1sMF.d.ts} +3 -3
  83. package/chunks/{spaces-B0cx23Nc.d.ts → spaces-CjF6Q30z.d.ts} +3 -3
  84. package/chunks/{tasks-DWfE5JM_.d.ts → tasks-CX1ohkzr.d.ts} +3 -3
  85. package/chunks/{temp-contents-CU94UTZU.d.ts → temp-contents-D-NhmvhI.d.ts} +3 -3
  86. package/chunks/{tenants-DvtbiwAP.d.ts → tenants-BbFJ4gEC.d.ts} +3 -3
  87. package/chunks/{themes-BPkyCLWS.d.ts → themes-DCHwpvan.d.ts} +3 -3
  88. package/chunks/{transports-DlRmSWLj.d.ts → transports-CQoT2abX.d.ts} +15 -15
  89. package/chunks/{ui-config-BqX-bPjf.d.ts → ui-config-8gkgFE8J.d.ts} +3 -3
  90. package/chunks/{users-CuQ0nboa.d.ts → users-D7kk0z77.d.ts} +3 -3
  91. package/chunks/{web-integrations-D54LCd0Z.d.ts → web-integrations-BMiMloLY.d.ts} +3 -3
  92. package/chunks/{web-notifications-sUlHGnmy.d.ts → web-notifications-CGGnIRRw.d.ts} +3 -3
  93. package/chunks/{webhooks-Dw0FIeFq.d.ts → webhooks-tylLbUkb.d.ts} +3 -3
  94. package/collections.d.ts +2 -2
  95. package/collections.js +2 -2
  96. package/conditions.d.ts +2 -2
  97. package/conditions.js +2 -2
  98. package/consumption.d.ts +2 -2
  99. package/consumption.js +2 -2
  100. package/csp-origins.d.ts +2 -2
  101. package/csp-origins.js +2 -2
  102. package/csrf-token.d.ts +2 -2
  103. package/csrf-token.js +2 -2
  104. package/data-alerts.d.ts +2 -2
  105. package/data-alerts.js +2 -2
  106. package/data-assets.d.ts +2 -2
  107. package/data-assets.js +2 -2
  108. package/data-connections.d.ts +2 -2
  109. package/data-connections.js +2 -2
  110. package/data-credentials.d.ts +2 -2
  111. package/data-credentials.js +2 -2
  112. package/data-files.d.ts +2 -2
  113. package/data-files.js +2 -2
  114. package/data-qualities.d.ts +2 -2
  115. package/data-qualities.js +2 -2
  116. package/data-sets.d.ts +2 -2
  117. package/data-sets.js +2 -2
  118. package/data-sources.d.ts +2 -2
  119. package/data-sources.js +2 -2
  120. package/data-stores.d.ts +2 -2
  121. package/data-stores.js +2 -2
  122. package/dcaas.d.ts +2 -2
  123. package/dcaas.js +2 -2
  124. package/di-projects.d.ts +2 -2
  125. package/di-projects.js +2 -2
  126. package/direct-access-agents.d.ts +2 -2
  127. package/direct-access-agents.js +2 -2
  128. package/encryption.d.ts +2 -2
  129. package/encryption.js +2 -2
  130. package/extensions.d.ts +2 -2
  131. package/extensions.js +2 -2
  132. package/global-types.d.ts +1 -1
  133. package/glossaries.d.ts +2 -2
  134. package/glossaries.js +9 -9
  135. package/groups.d.ts +2 -2
  136. package/groups.js +2 -2
  137. package/identity-providers.d.ts +2 -2
  138. package/identity-providers.js +2 -2
  139. package/index.d.ts +79 -79
  140. package/index.js +188 -185
  141. package/interceptors.d.ts +2 -2
  142. package/invoke-fetch-types.d.ts +1 -1
  143. package/items.d.ts +2 -2
  144. package/items.js +2 -2
  145. package/knowledgebases.d.ts +2 -2
  146. package/knowledgebases.js +2 -2
  147. package/licenses.d.ts +2 -2
  148. package/licenses.js +2 -2
  149. package/lineage-graphs.d.ts +2 -2
  150. package/lineage-graphs.js +2 -2
  151. package/ml.d.ts +2 -2
  152. package/ml.js +2 -2
  153. package/notes.d.ts +2 -2
  154. package/notes.js +2 -2
  155. package/notifications.d.ts +2 -2
  156. package/notifications.js +2 -2
  157. package/oauth-clients.d.ts +2 -2
  158. package/oauth-clients.js +2 -2
  159. package/oauth-tokens.d.ts +2 -2
  160. package/oauth-tokens.js +2 -2
  161. package/package.json +3 -3
  162. package/qix.d.ts +3 -3
  163. package/qix.js +2 -2
  164. package/questions.d.ts +2 -2
  165. package/questions.js +2 -2
  166. package/quotas.d.ts +2 -2
  167. package/quotas.js +2 -2
  168. package/reload-tasks.d.ts +2 -2
  169. package/reload-tasks.js +2 -2
  170. package/reloads.d.ts +2 -2
  171. package/reloads.js +2 -2
  172. package/report-templates.d.ts +2 -2
  173. package/report-templates.js +2 -2
  174. package/reports.d.ts +2 -2
  175. package/reports.js +2 -2
  176. package/roles.d.ts +2 -2
  177. package/roles.js +2 -2
  178. package/sharing-tasks.d.ts +2 -2
  179. package/sharing-tasks.js +2 -2
  180. package/spaces.d.ts +2 -2
  181. package/spaces.js +2 -2
  182. package/tasks.d.ts +2 -2
  183. package/tasks.js +2 -2
  184. package/temp-contents.d.ts +2 -2
  185. package/temp-contents.js +2 -2
  186. package/tenants.d.ts +2 -2
  187. package/tenants.js +2 -2
  188. package/themes.d.ts +2 -2
  189. package/themes.js +2 -2
  190. package/transports.d.ts +2 -2
  191. package/transports.js +8 -8
  192. package/ui-config.d.ts +2 -2
  193. package/ui-config.js +2 -2
  194. package/users.d.ts +2 -2
  195. package/users.js +2 -2
  196. package/web-integrations.d.ts +2 -2
  197. package/web-integrations.js +2 -2
  198. package/web-notifications.d.ts +2 -2
  199. package/web-notifications.js +2 -2
  200. package/webhooks.d.ts +2 -2
  201. package/webhooks.js +2 -2
  202. package/website/assets/navigation.js +1 -1
  203. package/website/assets/search.js +1 -1
  204. package/website/functions/assistants.getAssistantStarters.html +3 -3
  205. package/website/functions/assistants.getAssistantThreads.html +3 -3
  206. package/website/functions/assistants.getAssistants.html +3 -3
  207. package/website/functions/automations.getAutomations.html +3 -3
  208. package/website/functions/glossaries.changeGlossaryTermStatus.html +1 -1
  209. package/website/functions/glossaries.createGlossary.html +1 -1
  210. package/website/functions/glossaries.createGlossaryTermLink.html +1 -1
  211. package/website/functions/glossaries.importGlossary.html +2 -2
  212. package/website/functions/glossaries.patchGlossary.html +1 -1
  213. package/website/functions/glossaries.patchGlossaryCategory.html +1 -1
  214. package/website/functions/knowledgebases.getKnowledgebases.html +3 -3
  215. package/website/functions/transports.deleteEmailConfig.html +1 -1
  216. package/website/functions/transports.getEmailConfig.html +1 -1
  217. package/website/functions/transports.patchEmailConfig.html +1 -1
  218. package/website/functions/transports.sendTestEmail.html +1 -1
  219. package/website/functions/transports.validateEmailConfig.html +1 -1
  220. package/website/functions/transports.verifyEmailConfigConnection.html +1 -1
  221. package/website/interfaces/index.QlikAPI.html +60 -60
  222. package/website/interfaces/qix.GenericObject.html +1 -1
  223. package/website/modules/api-keys.html +1 -1
  224. package/website/modules/apps.html +1 -1
  225. package/website/modules/assistants.html +1 -1
  226. package/website/modules/audits.html +1 -1
  227. package/website/modules/automation-connections.html +1 -1
  228. package/website/modules/automations.html +1 -1
  229. package/website/modules/automl-deployments.html +1 -1
  230. package/website/modules/automl-predictions.html +1 -1
  231. package/website/modules/brands.html +1 -1
  232. package/website/modules/collections.html +1 -1
  233. package/website/modules/conditions.html +1 -1
  234. package/website/modules/consumption.html +1 -1
  235. package/website/modules/csp-origins.html +1 -1
  236. package/website/modules/csrf-token.html +1 -1
  237. package/website/modules/data-alerts.html +1 -1
  238. package/website/modules/data-assets.html +1 -1
  239. package/website/modules/data-connections.html +1 -1
  240. package/website/modules/data-credentials.html +1 -1
  241. package/website/modules/data-files.html +1 -1
  242. package/website/modules/data-qualities.html +1 -1
  243. package/website/modules/data-sets.html +1 -1
  244. package/website/modules/data-sources.html +1 -1
  245. package/website/modules/data-stores.html +1 -1
  246. package/website/modules/dcaas.html +1 -1
  247. package/website/modules/di-projects.html +1 -1
  248. package/website/modules/direct-access-agents.html +1 -1
  249. package/website/modules/encryption.html +1 -1
  250. package/website/modules/extensions.html +1 -1
  251. package/website/modules/glossaries.html +1 -1
  252. package/website/modules/groups.html +1 -1
  253. package/website/modules/identity-providers.html +1 -1
  254. package/website/modules/items.html +1 -1
  255. package/website/modules/knowledgebases.html +1 -1
  256. package/website/modules/licenses.html +1 -1
  257. package/website/modules/lineage-graphs.html +1 -1
  258. package/website/modules/ml.html +1 -1
  259. package/website/modules/notes.html +1 -1
  260. package/website/modules/notifications.html +1 -1
  261. package/website/modules/oauth-clients.html +1 -1
  262. package/website/modules/oauth-tokens.html +1 -1
  263. package/website/modules/questions.html +1 -1
  264. package/website/modules/quotas.html +1 -1
  265. package/website/modules/reload-tasks.html +1 -1
  266. package/website/modules/reloads.html +1 -1
  267. package/website/modules/report-templates.html +1 -1
  268. package/website/modules/reports.html +1 -1
  269. package/website/modules/roles.html +1 -1
  270. package/website/modules/sharing-tasks.html +1 -1
  271. package/website/modules/spaces.html +1 -1
  272. package/website/modules/tasks.html +1 -1
  273. package/website/modules/temp-contents.html +1 -1
  274. package/website/modules/tenants.html +1 -1
  275. package/website/modules/themes.html +1 -1
  276. package/website/modules/transports.html +1 -1
  277. package/website/modules/ui-config.html +1 -1
  278. package/website/modules/users.html +1 -1
  279. package/website/modules/web-integrations.html +1 -1
  280. package/website/modules/web-notifications.html +1 -1
  281. package/website/modules/webhooks.html +1 -1
  282. package/website/types/api-keys.ApiKeysAPI.html +34 -0
  283. package/website/types/apps.AppsAPI.html +241 -0
  284. package/website/types/assistants.AssistantsAPI.html +156 -0
  285. package/website/types/assistants.CreateAssistantHttpError.html +2 -2
  286. package/website/types/assistants.CreateAssistantStarterHttpError.html +2 -2
  287. package/website/types/assistants.CreateAssistantThreadHttpError.html +2 -2
  288. package/website/types/assistants.CreateAssistantThreadInteractionFeedbackHttpError.html +2 -2
  289. package/website/types/assistants.CreateAssistantThreadInteractionHttpError.html +2 -2
  290. package/website/types/assistants.CreateAssistantThreadInteractionReviewHttpError.html +2 -2
  291. package/website/types/assistants.DeleteAssistantHttpError.html +2 -2
  292. package/website/types/assistants.DeleteAssistantStarterFollowupHttpError.html +2 -2
  293. package/website/types/assistants.DeleteAssistantStarterHttpError.html +2 -2
  294. package/website/types/assistants.DeleteAssistantThreadHttpError.html +2 -2
  295. package/website/types/assistants.DeleteAssistantThreadInteractionHttpError.html +2 -2
  296. package/website/types/assistants.ErrorResponseCode.html +1 -11
  297. package/website/types/assistants.ErrorResponseCodeCopy.html +11 -1
  298. package/website/types/assistants.GetAssistantFeedbackHttpError.html +2 -2
  299. package/website/types/assistants.GetAssistantHttpError.html +2 -2
  300. package/website/types/assistants.GetAssistantSourcesHttpError.html +2 -2
  301. package/website/types/assistants.GetAssistantStarterHttpError.html +2 -2
  302. package/website/types/assistants.GetAssistantStartersHttpError.html +2 -2
  303. package/website/types/assistants.GetAssistantThreadHttpError.html +2 -2
  304. package/website/types/assistants.GetAssistantThreadInteractionHttpError.html +2 -2
  305. package/website/types/assistants.GetAssistantThreadInteractionsHttpError.html +2 -2
  306. package/website/types/assistants.GetAssistantThreadsHttpError.html +2 -2
  307. package/website/types/assistants.GetAssistantsHttpError.html +2 -2
  308. package/website/types/assistants.InvokeAssistantThreadHttpError.html +2 -2
  309. package/website/types/assistants.PatchAssistantHttpError.html +2 -2
  310. package/website/types/assistants.PatchAssistantThreadHttpError.html +2 -2
  311. package/website/types/assistants.PatchAssistantThreadInteractionFeedbackHttpError.html +2 -2
  312. package/website/types/assistants.StreamAssistantThreadHttpError.html +2 -2
  313. package/website/types/assistants.UpdateAssistantStarterFollowupHttpError.html +2 -2
  314. package/website/types/assistants.UpdateAssistantStarterHttpError.html +2 -2
  315. package/website/types/audits.AuditsAPI.html +27 -0
  316. package/website/types/automation-connections.AutomationConnectionsAPI.html +39 -0
  317. package/website/types/automations.AutomationsAPI.html +100 -0
  318. package/website/types/automl-deployments.AutomlDeploymentsAPI.html +9 -0
  319. package/website/types/automl-predictions.AutomlPredictionsAPI.html +32 -0
  320. package/website/types/brands.BrandsAPI.html +59 -0
  321. package/website/types/collections.CollectionsAPI.html +53 -0
  322. package/website/types/conditions.ConditionsAPI.html +50 -0
  323. package/website/types/consumption.ConsumptionAPI.html +7 -0
  324. package/website/types/csp-origins.CspOriginsAPI.html +27 -0
  325. package/website/{interfaces → types}/csrf-token.CsrfTokenAPI.html +4 -7
  326. package/website/types/data-alerts.DataAlertsAPI.html +73 -0
  327. package/website/types/data-assets.DataAssetsAPI.html +23 -0
  328. package/website/types/data-connections.DataConnectionsAPI.html +54 -0
  329. package/website/types/data-credentials.DataCredentialsAPI.html +35 -0
  330. package/website/types/data-files.DataFilesAPI.html +86 -0
  331. package/website/types/data-qualities.DataQualitiesAPI.html +18 -0
  332. package/website/types/data-sets.DataSetsAPI.html +27 -0
  333. package/website/types/data-sources.DataSourcesAPI.html +25 -0
  334. package/website/types/data-stores.DataStoresAPI.html +47 -0
  335. package/website/types/dcaas.DcaasAPI.html +15 -0
  336. package/website/types/di-projects.DiProjectsAPI.html +104 -0
  337. package/website/types/direct-access-agents.DirectAccessAgentsAPI.html +72 -0
  338. package/website/types/encryption.EncryptionAPI.html +40 -0
  339. package/website/types/extensions.ExtensionsAPI.html +32 -0
  340. package/website/types/glossaries.GlossariesAPI.html +127 -0
  341. package/website/types/groups.GroupsAPI.html +36 -0
  342. package/website/types/identity-providers.IdentityProvidersAPI.html +33 -0
  343. package/website/types/items.ItemsAPI.html +37 -0
  344. package/website/types/knowledgebases.KnowledgebasesAPI.html +90 -0
  345. package/website/types/licenses.LicensesAPI.html +36 -0
  346. package/website/types/lineage-graphs.LineageGraphsAPI.html +60 -0
  347. package/website/types/ml.MlAPI.html +230 -0
  348. package/website/{interfaces → types}/notes.NotesAPI.html +7 -13
  349. package/website/{interfaces → types}/notifications.NotificationsAPI.html +5 -12
  350. package/website/types/oauth-clients.OauthClientsAPI.html +53 -0
  351. package/website/types/oauth-tokens.OauthTokensAPI.html +11 -0
  352. package/website/types/qix.NativeGenericObjectFunctions.html +1 -1
  353. package/website/types/qix.RpcObject.html +1 -1
  354. package/website/types/qix.VariableListItem.html +1 -1
  355. package/website/types/questions.QuestionsAPI.html +12 -0
  356. package/website/types/quotas.QuotasAPI.html +12 -0
  357. package/website/types/reload-tasks.ReloadTasksAPI.html +24 -0
  358. package/website/types/reloads.ReloadsAPI.html +22 -0
  359. package/website/types/report-templates.ReportTemplatesAPI.html +33 -0
  360. package/website/types/reports.ReportsAPI.html +17 -0
  361. package/website/types/roles.RolesAPI.html +24 -0
  362. package/website/types/sharing-tasks.SharingTasksAPI.html +62 -0
  363. package/website/types/spaces.SpacesAPI.html +84 -0
  364. package/website/types/tasks.TasksAPI.html +49 -0
  365. package/website/types/temp-contents.TempContentsAPI.html +17 -0
  366. package/website/types/tenants.TenantsAPI.html +29 -0
  367. package/website/types/themes.ThemesAPI.html +32 -0
  368. package/website/types/transports.TransportsAPI.html +23 -0
  369. package/website/types/ui-config.UiConfigAPI.html +30 -0
  370. package/website/types/users.UsersAPI.html +41 -0
  371. package/website/types/web-integrations.WebIntegrationsAPI.html +24 -0
  372. package/website/types/web-notifications.WebNotificationsAPI.html +30 -0
  373. package/website/types/webhooks.WebhooksAPI.html +47 -0
  374. package/website/variables/index.apiKeys.html +1 -1
  375. package/website/variables/index.apps.html +1 -1
  376. package/website/variables/index.assistants.html +1 -1
  377. package/website/variables/index.audits.html +1 -1
  378. package/website/variables/index.automationConnections.html +1 -1
  379. package/website/variables/index.automations.html +1 -1
  380. package/website/variables/index.automlDeployments.html +1 -1
  381. package/website/variables/index.automlPredictions.html +1 -1
  382. package/website/variables/index.brands.html +1 -1
  383. package/website/variables/index.collections.html +1 -1
  384. package/website/variables/index.conditions.html +1 -1
  385. package/website/variables/index.consumption.html +1 -1
  386. package/website/variables/index.cspOrigins.html +1 -1
  387. package/website/variables/index.csrfToken.html +1 -1
  388. package/website/variables/index.dataAlerts.html +1 -1
  389. package/website/variables/index.dataAssets.html +1 -1
  390. package/website/variables/index.dataConnections.html +1 -1
  391. package/website/variables/index.dataCredentials.html +1 -1
  392. package/website/variables/index.dataFiles.html +1 -1
  393. package/website/variables/index.dataQualities.html +1 -1
  394. package/website/variables/index.dataSets.html +1 -1
  395. package/website/variables/index.dataSources.html +1 -1
  396. package/website/variables/index.dataStores.html +1 -1
  397. package/website/variables/index.dcaas.html +1 -1
  398. package/website/variables/index.diProjects.html +1 -1
  399. package/website/variables/index.directAccessAgents.html +1 -1
  400. package/website/variables/index.encryption.html +1 -1
  401. package/website/variables/index.extensions.html +1 -1
  402. package/website/variables/index.glossaries.html +1 -1
  403. package/website/variables/index.groups.html +1 -1
  404. package/website/variables/index.identityProviders.html +1 -1
  405. package/website/variables/index.items.html +1 -1
  406. package/website/variables/index.knowledgebases.html +1 -1
  407. package/website/variables/index.licenses.html +1 -1
  408. package/website/variables/index.lineageGraphs.html +1 -1
  409. package/website/variables/index.ml.html +1 -1
  410. package/website/variables/index.notes.html +1 -1
  411. package/website/variables/index.notifications.html +1 -1
  412. package/website/variables/index.oauthClients.html +1 -1
  413. package/website/variables/index.oauthTokens.html +1 -1
  414. package/website/variables/index.questions.html +1 -1
  415. package/website/variables/index.quotas.html +1 -1
  416. package/website/variables/index.reloadTasks.html +1 -1
  417. package/website/variables/index.reloads.html +1 -1
  418. package/website/variables/index.reportTemplates.html +1 -1
  419. package/website/variables/index.reports.html +1 -1
  420. package/website/variables/index.roles.html +1 -1
  421. package/website/variables/index.sharingTasks.html +1 -1
  422. package/website/variables/index.spaces.html +1 -1
  423. package/website/variables/index.tasks.html +1 -1
  424. package/website/variables/index.tempContents.html +1 -1
  425. package/website/variables/index.tenants.html +1 -1
  426. package/website/variables/index.themes.html +1 -1
  427. package/website/variables/index.transports.html +1 -1
  428. package/website/variables/index.uiConfig.html +1 -1
  429. package/website/variables/index.users.html +1 -1
  430. package/website/variables/index.webIntegrations.html +1 -1
  431. package/website/variables/index.webNotifications.html +1 -1
  432. package/website/variables/index.webhooks.html +1 -1
  433. package/website/variables/qix.QIX_SCHEMA_VERSION.html +1 -1
  434. package/website/interfaces/api-keys.ApiKeysAPI.html +0 -66
  435. package/website/interfaces/apps.AppsAPI.html +0 -486
  436. package/website/interfaces/assistants.AssistantsAPI.html +0 -300
  437. package/website/interfaces/audits.AuditsAPI.html +0 -55
  438. package/website/interfaces/automation-connections.AutomationConnectionsAPI.html +0 -73
  439. package/website/interfaces/automations.AutomationsAPI.html +0 -199
  440. package/website/interfaces/automl-deployments.AutomlDeploymentsAPI.html +0 -19
  441. package/website/interfaces/automl-predictions.AutomlPredictionsAPI.html +0 -56
  442. package/website/interfaces/brands.BrandsAPI.html +0 -115
  443. package/website/interfaces/collections.CollectionsAPI.html +0 -119
  444. package/website/interfaces/conditions.ConditionsAPI.html +0 -87
  445. package/website/interfaces/consumption.ConsumptionAPI.html +0 -20
  446. package/website/interfaces/csp-origins.CspOriginsAPI.html +0 -65
  447. package/website/interfaces/data-alerts.DataAlertsAPI.html +0 -162
  448. package/website/interfaces/data-assets.DataAssetsAPI.html +0 -40
  449. package/website/interfaces/data-connections.DataConnectionsAPI.html +0 -125
  450. package/website/interfaces/data-credentials.DataCredentialsAPI.html +0 -67
  451. package/website/interfaces/data-files.DataFilesAPI.html +0 -268
  452. package/website/interfaces/data-qualities.DataQualitiesAPI.html +0 -33
  453. package/website/interfaces/data-sets.DataSetsAPI.html +0 -50
  454. package/website/interfaces/data-sources.DataSourcesAPI.html +0 -50
  455. package/website/interfaces/data-stores.DataStoresAPI.html +0 -92
  456. package/website/interfaces/dcaas.DcaasAPI.html +0 -26
  457. package/website/interfaces/di-projects.DiProjectsAPI.html +0 -192
  458. package/website/interfaces/direct-access-agents.DirectAccessAgentsAPI.html +0 -131
  459. package/website/interfaces/encryption.EncryptionAPI.html +0 -68
  460. package/website/interfaces/extensions.ExtensionsAPI.html +0 -59
  461. package/website/interfaces/glossaries.GlossariesAPI.html +0 -271
  462. package/website/interfaces/groups.GroupsAPI.html +0 -73
  463. package/website/interfaces/identity-providers.IdentityProvidersAPI.html +0 -60
  464. package/website/interfaces/items.ItemsAPI.html +0 -97
  465. package/website/interfaces/knowledgebases.KnowledgebasesAPI.html +0 -175
  466. package/website/interfaces/licenses.LicensesAPI.html +0 -70
  467. package/website/interfaces/lineage-graphs.LineageGraphsAPI.html +0 -133
  468. package/website/interfaces/ml.MlAPI.html +0 -552
  469. package/website/interfaces/oauth-clients.OauthClientsAPI.html +0 -99
  470. package/website/interfaces/oauth-tokens.OauthTokensAPI.html +0 -22
  471. package/website/interfaces/questions.QuestionsAPI.html +0 -23
  472. package/website/interfaces/quotas.QuotasAPI.html +0 -22
  473. package/website/interfaces/reload-tasks.ReloadTasksAPI.html +0 -46
  474. package/website/interfaces/reloads.ReloadsAPI.html +0 -56
  475. package/website/interfaces/report-templates.ReportTemplatesAPI.html +0 -63
  476. package/website/interfaces/reports.ReportsAPI.html +0 -36
  477. package/website/interfaces/roles.RolesAPI.html +0 -47
  478. package/website/interfaces/sharing-tasks.SharingTasksAPI.html +0 -131
  479. package/website/interfaces/spaces.SpacesAPI.html +0 -171
  480. package/website/interfaces/tasks.TasksAPI.html +0 -102
  481. package/website/interfaces/temp-contents.TempContentsAPI.html +0 -33
  482. package/website/interfaces/tenants.TenantsAPI.html +0 -50
  483. package/website/interfaces/themes.ThemesAPI.html +0 -59
  484. package/website/interfaces/transports.TransportsAPI.html +0 -38
  485. package/website/interfaces/ui-config.UiConfigAPI.html +0 -51
  486. package/website/interfaces/users.UsersAPI.html +0 -112
  487. package/website/interfaces/web-integrations.WebIntegrationsAPI.html +0 -46
  488. package/website/interfaces/web-notifications.WebNotificationsAPI.html +0 -57
  489. package/website/interfaces/webhooks.WebhooksAPI.html +0 -101
package/website/types/tenants.TenantsAPI.html ADDED
@@ -0,0 +1,29 @@
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>TenantsAPI | @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/tenants.html">tenants</a></li><li><a href="" aria-current="page">TenantsAPI</a></li></ul><h1>Type Alias TenantsAPI</h1></div><div class="tsd-signature"><span class="tsd-signature-keyword">type</span> <span class="tsd-kind-type-alias">TenantsAPI</span> <span class="tsd-signature-symbol">=</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-keyword">typeof</span> <a href="../functions/tenants.clearCache.html" class="tsd-signature-type tsd-kind-function">clearCache</a><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#createtenant">createTenant</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">typeof</span> <a href="../functions/tenants.createTenant.html" class="tsd-signature-type tsd-kind-function">createTenant</a><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#deactivatetenant">deactivateTenant</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">typeof</span> <a href="../functions/tenants.deactivateTenant.html" class="tsd-signature-type tsd-kind-function">deactivateTenant</a><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#getmytenant">getMyTenant</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">typeof</span> <a href="../functions/tenants.getMyTenant.html" class="tsd-signature-type tsd-kind-function">getMyTenant</a><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#gettenant">getTenant</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">typeof</span> <a href="../functions/tenants.getTenant.html" class="tsd-signature-type tsd-kind-function">getTenant</a><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#patchtenant">patchTenant</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">typeof</span> <a href="../functions/tenants.patchTenant.html" class="tsd-signature-type tsd-kind-function">patchTenant</a><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#reactivatetenant">reactivateTenant</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">typeof</span> <a href="../functions/tenants.reactivateTenant.html" class="tsd-signature-type tsd-kind-function">reactivateTenant</a><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
+ <a href="#createtenant" 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>create<wbr/>Tenant</span></a>
3
+ <a href="#deactivatetenant" 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>deactivate<wbr/>Tenant</span></a>
4
+ <a href="#getmytenant" 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/>My<wbr/>Tenant</span></a>
5
+ <a href="#gettenant" 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/>Tenant</span></a>
6
+ <a href="#patchtenant" 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/>Tenant</span></a>
7
+ <a href="#reactivatetenant" 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>reactivate<wbr/>Tenant</span></a>
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-keyword">typeof</span> <a href="../functions/tenants.clearCache.html" class="tsd-signature-type tsd-kind-function">clearCache</a></div><div class="tsd-comment tsd-typography"><p>Clears the cache for tenants api requests.</p>
9
+ </div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="createtenant"><span>create<wbr/>Tenant</span><a href="#createtenant" 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">createTenant</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">typeof</span> <a href="../functions/tenants.createTenant.html" class="tsd-signature-type tsd-kind-function">createTenant</a></div><div class="tsd-comment tsd-typography"><p>Creates a tenant in the requested region, linked to the provided license key. You must use a regional OAuth client generated via the <a href="https://account.myqlik.qlik.com/account">My Qlik portal</a> to call this endpoint. Tenant creation, deactivation, and reactivation requests must be sent to the register endpoint in the relevant Qlik Cloud region, e.g. <code>https://register.us.qlikcloud.com/api/v1/tenants</code> if interacting with tenants in the <code>us</code> region.</p>
10
+ </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>
11
+ </div><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>CreateTenantHttpError</p>
12
+ </div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="deactivatetenant"><span>deactivate<wbr/>Tenant</span><a href="#deactivatetenant" 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">deactivateTenant</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">typeof</span> <a href="../functions/tenants.deactivateTenant.html" class="tsd-signature-type tsd-kind-function">deactivateTenant</a></div><div class="tsd-comment tsd-typography"><p>Deactivates a specific tenant. Once deactivated, tenant will be deleted on or after <code>estimatedPurgeDate</code>. Tenant can be reactivated using <code>/v1/tenants/{tenantId}/actions/reactivate</code> until this date. You must use a regional OAuth client generated via the <a href="https://account.myqlik.qlik.com/account">My Qlik portal</a> to call this endpoint. Tenant creation, deactivation, and reactivation requests must be sent to the register endpoint in the relevant Qlik Cloud region, e.g. <code>https://register.us.qlikcloud.com/api/v1/tenants/{tenantId}/actions/deactivate</code> if interacting with tenants in the <code>us</code> region.</p>
13
+ </div><div class="tsd-comment tsd-typography"><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-tenantid">Param: tenantId<a href="#param-tenantid" 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>The id of the tenant to deactivate</p>
14
+ </div><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>
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>DeactivateTenantHttpError</p>
16
+ </div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getmytenant"><span>get<wbr/>My<wbr/>Tenant</span><a href="#getmytenant" 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">getMyTenant</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">typeof</span> <a href="../functions/tenants.getMyTenant.html" class="tsd-signature-type tsd-kind-function">getMyTenant</a></div><div class="tsd-comment tsd-typography"><p>Redirects to current tenant.</p>
17
+ </div><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>GetMyTenantHttpError</p>
18
+ </div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="gettenant"><span>get<wbr/>Tenant</span><a href="#gettenant" 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">getTenant</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">typeof</span> <a href="../functions/tenants.getTenant.html" class="tsd-signature-type tsd-kind-function">getTenant</a></div><div class="tsd-comment tsd-typography"><p>Retrieves a specific tenant by ID.</p>
19
+ </div><div class="tsd-comment tsd-typography"><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-tenantid-1">Param: tenantId<a href="#param-tenantid-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>The ID of the tenant to retrieve</p>
20
+ </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>GetTenantHttpError</p>
21
+ </div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="patchtenant"><span>patch<wbr/>Tenant</span><a href="#patchtenant" 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">patchTenant</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">typeof</span> <a href="../functions/tenants.patchTenant.html" class="tsd-signature-type tsd-kind-function">patchTenant</a></div><div class="tsd-comment tsd-typography"><p>Updates properties of a specific tenant by ID.</p>
22
+ </div><div class="tsd-comment tsd-typography"><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-tenantid-2">Param: tenantId<a href="#param-tenantid-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>The ID of the tenant to update</p>
23
+ </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>
24
+ </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>PatchTenantHttpError</p>
25
+ </div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="reactivatetenant"><span>reactivate<wbr/>Tenant</span><a href="#reactivatetenant" 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">reactivateTenant</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">typeof</span> <a href="../functions/tenants.reactivateTenant.html" class="tsd-signature-type tsd-kind-function">reactivateTenant</a></div><div class="tsd-comment tsd-typography"><p>Reactivates a deactivated tenant. Tenants can be reactivated until the <code>estimatedPurgeDate</code> provided at time of deactivation. You must use a regional OAuth client generated via the <a href="https://account.myqlik.qlik.com/account">My Qlik portal</a> to call this endpoint. Tenant creation, deactivation, and reactivation requests must be sent to the register endpoint in the relevant Qlik Cloud region, e.g. <code>https://register.us.qlikcloud.com/api/v1/tenants/{tenantId}/actions/reactivate</code> if interacting with tenants in the <code>us</code> region.</p>
26
+ </div><div class="tsd-comment tsd-typography"><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-tenantid-3">Param: tenantId<a href="#param-tenantid-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>The id of the tenant to reactivate</p>
27
+ </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>
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>ReactivateTenantHttpError</p>
29
+ </div></div></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-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><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-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><h3>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><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>Properties</summary><div><a href="#clearcache"><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><a href="#createtenant"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>create<wbr/>Tenant</span></a><a href="#deactivatetenant"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>deactivate<wbr/>Tenant</span></a><a href="#getmytenant"><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/>My<wbr/>Tenant</span></a><a href="#gettenant"><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/>Tenant</span></a><a href="#patchtenant"><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/>Tenant</span></a><a href="#reactivatetenant"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>reactivate<wbr/>Tenant</span></a></div></details></div></details></div><div class="site-menu"><nav id="tsd-sidebar-links" class="tsd-navigation"><a href="https://qlik.dev/embed/" class="tsd-nav-link">Embed</a><a href="https://qlik.dev/extend/" class="tsd-nav-link">Extend</a><a href="https://qlik.dev/manage/" class="tsd-nav-link">Manage</a><a href="https://qlik.dev/apis/" class="tsd-nav-link">APIs</a><a href="https://qlik.dev/toolkits/" class="tsd-nav-link">Toolkits</a></nav><nav class="tsd-navigation"><a href="../index.html">@qlik/api reference</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><div class="wrapper"><div><img alt="Qlik logo" src="../assets/logo-footer.svg"/></div><div class="social"><a class="text" href="https://community.qlik.com/">Qlik Community</a><div class="icons"><a href="https://qlikdeveloper.slack.com/join/shared_invite/zt-1t4vc1qee-3P6R0ERUNfNeE7O6DPnN_Q#/shared-invite/email" aria-label="Qlik developer on slack"><svg viewBox="0 0 54 54" fill="currentColor" aria-hidden="true" height="1.7rem"><path fill="currentColor" d="M19.712.133a5.381 5.381 0 0 0-5.376 5.387 5.381 5.381 0 0 0 5.376 5.386h5.376V5.52A5.381 5.381 0 0 0 19.712.133m0 14.365H5.376A5.381 5.381 0 0 0 0 19.884a5.381 5.381 0 0 0 5.376 5.387h14.336a5.381 5.381 0 0 0 5.376-5.387 5.381 5.381 0 0 0-5.376-5.386"></path><path d="M53.76 19.884a5.381 5.381 0 0 0-5.376-5.386 5.381 5.381 0 0 0-5.376 5.386v5.387h5.376a5.381 5.381 0 0 0 5.376-5.387m-14.336 0V5.52A5.381 5.381 0 0 0 34.048.133a5.381 5.381 0 0 0-5.376 5.387v14.364a5.381 5.381 0 0 0 5.376 5.387 5.381 5.381 0 0 0 5.376-5.387"></path><path d="M34.048 54a5.381 5.381 0 0 0 5.376-5.387 5.381 5.381 0 0 0-5.376-5.386h-5.376v5.386A5.381 5.381 0 0 0 34.048 54m0-14.365h14.336a5.381 5.381 0 0 0 5.376-5.386 5.381 5.381 0 0 0-5.376-5.387H34.048a5.381 5.381 0 0 0-5.376 5.387 5.381 5.381 0 0 0 5.376 5.386"></path><path d="M0 34.249a5.381 5.381 0 0 0 5.376 5.386 5.381 5.381 0 0 0 5.376-5.386v-5.387H5.376A5.381 5.381 0 0 0 0 34.25m14.336-.001v14.364A5.381 5.381 0 0 0 19.712 54a5.381 5.381 0 0 0 5.376-5.387V34.25a5.381 5.381 0 0 0-5.376-5.387 5.381 5.381 0 0 0-5.376 5.387"></path></svg></a><a href="https://www.facebook.com/qlik" aria-label="Qlik on Facebook"><svg viewBox="0 0 21 21" fill="currentColor" aria-hidden="true" height="1.7rem"><path fill="currentColor" d="M20.05 10.345C20.05 4.812 15.56.32 10.025.32 4.491.32 0 4.812 0 10.345c0 4.852 3.449 8.893 8.02 9.825v-6.817H6.015v-3.008H8.02V7.84A3.513 3.513 0 0 1 11.53 4.33h2.506v3.008H12.03c-.551 0-1.002.451-1.002 1.002v2.005h3.007v3.008h-3.007v6.967c5.062-.5 9.022-4.772 9.022-9.975Z"/></svg></a><a href="https://www.linkedin.com/company/qlik" aria-label="Qlik on LinkedIn"><svg viewBox="0 0 21 21" fill="currentColor" aria-hidden="true" height="1.7rem"><path fill="currentColor" d="M17.286.32H3.952A3.334 3.334 0 0 0 .62 3.654v13.333a3.334 3.334 0 0 0 3.333 3.333h13.334a3.334 3.334 0 0 0 3.333-3.333V3.654A3.334 3.334 0 0 0 17.286.32Zm-10 16.25H5.202V8.237h2.084v8.333Zm.013-9.995c-.271.273-.623.412-1.055.412-.427 0-.777-.141-1.05-.425a1.46 1.46 0 0 1-.408-1.046c0-.426.137-.773.408-1.042.273-.27.623-.404 1.05-.404.432 0 .784.135 1.055.404.269.27.403.616.403 1.042 0 .43-.134.783-.403 1.059Zm9.57 9.995h-2.083v-4.63c0-1.292-.745-2.036-1.667-2.036-.445 0-.948.269-1.235.612-.288.342-.431.777-.431 1.302v4.752H9.369V8.237h2.084v1.317h.032c.614-1.013 1.506-1.517 2.678-1.521 1.665-.004 2.706 1.246 2.706 3.435v5.102Z"/></svg></a><a href="https://x.com/qlikdeveloper" aria-label="Qlik on X.com"><svg viewBox="0 0 21 21" fill="currentColor" aria-hidden="true" height="1.7rem"><path fill="currentColor" d="M11.698 8.789 18.983.32h-1.727l-6.325 7.354L5.878.32H.051l7.64 11.12-7.64 8.88h1.726l6.68-7.765 5.336 7.765h5.828L11.697 8.79Zm-2.365 2.749-.774-1.108-6.16-8.81h2.652l4.97 7.11.775 1.107 6.461 9.243h-2.652l-5.272-7.542Z"/></svg></a></div></div><div class="legal"><div class="links"><a href="https://www.qlik.com/us/legal/legal-agreements">Legal Agreements</a> /<a href="https://www.qlik.com/us/legal/legal-policies">Legal Policies</a> /<a href="https://www.qlik.com/us/legal/privacy-and-cookie-notice">Privacy &amp; Cookie Notice</a> /<a href="https://qlik.dev/qlik-developer-portal-terms-of-use.pdf">Terms of Use</a></div><div class="copyright">Copyright © 1993-2025 QlikTech International AB. All rights reserved.</div></div></div></footer><div class="overlay"></div></body></html>
package/website/types/themes.ThemesAPI.html ADDED
@@ -0,0 +1,32 @@
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>ThemesAPI | @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/themes.html">themes</a></li><li><a href="" aria-current="page">ThemesAPI</a></li></ul><h1>Type Alias ThemesAPI</h1></div><div class="tsd-signature"><span class="tsd-signature-keyword">type</span> <span class="tsd-kind-type-alias">ThemesAPI</span> <span class="tsd-signature-symbol">=</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-keyword">typeof</span> <a href="../functions/themes.clearCache.html" class="tsd-signature-type tsd-kind-function">clearCache</a><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#deletetheme">deleteTheme</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">typeof</span> <a href="../functions/themes.deleteTheme.html" class="tsd-signature-type tsd-kind-function">deleteTheme</a><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#downloadfilefromtheme">downloadFileFromTheme</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">typeof</span> <a href="../functions/themes.downloadFileFromTheme.html" class="tsd-signature-type tsd-kind-function">downloadFileFromTheme</a><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#downloadtheme">downloadTheme</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">typeof</span> <a href="../functions/themes.downloadTheme.html" class="tsd-signature-type tsd-kind-function">downloadTheme</a><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#gettheme">getTheme</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">typeof</span> <a href="../functions/themes.getTheme.html" class="tsd-signature-type tsd-kind-function">getTheme</a><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#getthemes">getThemes</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">typeof</span> <a href="../functions/themes.getThemes.html" class="tsd-signature-type tsd-kind-function">getThemes</a><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#patchtheme">patchTheme</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">typeof</span> <a href="../functions/themes.patchTheme.html" class="tsd-signature-type tsd-kind-function">patchTheme</a><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#uploadtheme">uploadTheme</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">typeof</span> <a href="../functions/themes.uploadTheme.html" class="tsd-signature-type tsd-kind-function">uploadTheme</a><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
+ <a href="#deletetheme" 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>delete<wbr/>Theme</span></a>
3
+ <a href="#downloadfilefromtheme" 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>download<wbr/>File<wbr/>From<wbr/>Theme</span></a>
4
+ <a href="#downloadtheme" 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>download<wbr/>Theme</span></a>
5
+ <a href="#gettheme" 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/>Theme</span></a>
6
+ <a href="#getthemes" 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/>Themes</span></a>
7
+ <a href="#patchtheme" 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/>Theme</span></a>
8
+ <a href="#uploadtheme" 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>upload<wbr/>Theme</span></a>
9
+ </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-keyword">typeof</span> <a href="../functions/themes.clearCache.html" class="tsd-signature-type tsd-kind-function">clearCache</a></div><div class="tsd-comment tsd-typography"><p>Clears the cache for themes api requests.</p>
10
+ </div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="deletetheme"><span>delete<wbr/>Theme</span><a href="#deletetheme" 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">deleteTheme</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">typeof</span> <a href="../functions/themes.deleteTheme.html" class="tsd-signature-type tsd-kind-function">deleteTheme</a></div><div class="tsd-comment tsd-typography"><p>Deletes a specific theme matching either theme ID or theme name.</p>
11
+ </div><div class="tsd-comment tsd-typography"><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-id">Param: id<a href="#param-id" 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>Theme identifier or its qextFilename.</p>
12
+ </div><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>DeleteThemeHttpError</p>
13
+ </div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="downloadfilefromtheme"><span>download<wbr/>File<wbr/>From<wbr/>Theme</span><a href="#downloadfilefromtheme" 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">downloadFileFromTheme</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">typeof</span> <a href="../functions/themes.downloadFileFromTheme.html" class="tsd-signature-type tsd-kind-function">downloadFileFromTheme</a></div><div class="tsd-comment tsd-typography"><p>Downloads a file from the theme matching either theme ID or theme name, identified by the file path within the imported extension.</p>
14
+ </div><div class="tsd-comment tsd-typography"><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-id-1">Param: id<a href="#param-id-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>Theme identifier or its qextFilename.</p>
15
+ </div><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-filepath">Param: filepath<a href="#param-filepath" 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>Path to the file location within the specified theme archive. Folders separated with forward slashes.</p>
16
+ </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>DownloadFileFromThemeHttpError</p>
17
+ </div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="downloadtheme"><span>download<wbr/>Theme</span><a href="#downloadtheme" 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">downloadTheme</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">typeof</span> <a href="../functions/themes.downloadTheme.html" class="tsd-signature-type tsd-kind-function">downloadTheme</a></div><div class="tsd-comment tsd-typography"><p>Downloads all files in the theme matching either theme ID or theme name as a <code>.zip</code> archive.</p>
18
+ </div><div class="tsd-comment tsd-typography"><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-id-2">Param: id<a href="#param-id-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>Theme identifier or its qextFilename</p>
19
+ </div><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>DownloadThemeHttpError</p>
20
+ </div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="gettheme"><span>get<wbr/>Theme</span><a href="#gettheme" 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">getTheme</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">typeof</span> <a href="../functions/themes.getTheme.html" class="tsd-signature-type tsd-kind-function">getTheme</a></div><div class="tsd-comment tsd-typography"><p>Returns a specific theme matching either theme ID or theme name.</p>
21
+ </div><div class="tsd-comment tsd-typography"><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-id-3">Param: id<a href="#param-id-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>Theme identifier or its qextFilename</p>
22
+ </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>GetThemeHttpError</p>
23
+ </div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getthemes"><span>get<wbr/>Themes</span><a href="#getthemes" 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">getThemes</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">typeof</span> <a href="../functions/themes.getThemes.html" class="tsd-signature-type tsd-kind-function">getThemes</a></div><div class="tsd-comment tsd-typography"><p>Lists all imported themes in the tenant.</p>
24
+ </div><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>GetThemesHttpError</p>
25
+ </div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="patchtheme"><span>patch<wbr/>Theme</span><a href="#patchtheme" 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">patchTheme</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">typeof</span> <a href="../functions/themes.patchTheme.html" class="tsd-signature-type tsd-kind-function">patchTheme</a></div><div class="tsd-comment tsd-typography"><p>Updates a specific theme matching either theme ID or theme name. Accepts either provided file or data object.</p>
26
+ </div><div class="tsd-comment tsd-typography"><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-id-4">Param: id<a href="#param-id-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>Theme identifier or its qextFilename.</p>
27
+ </div><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>
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>PatchThemeHttpError</p>
29
+ </div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="uploadtheme"><span>upload<wbr/>Theme</span><a href="#uploadtheme" 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">uploadTheme</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">typeof</span> <a href="../functions/themes.uploadTheme.html" class="tsd-signature-type tsd-kind-function">uploadTheme</a></div><div class="tsd-comment tsd-typography"><p>Creates a new theme. Accepts either provided file or data object. The name of the new theme must be different to any existing themes.</p>
30
+ </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>
31
+ </div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-6">Throws<a href="#throws-6" 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>UploadThemeHttpError</p>
32
+ </div></div></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-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><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-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><h3>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><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>Properties</summary><div><a href="#clearcache"><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><a href="#deletetheme"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>delete<wbr/>Theme</span></a><a href="#downloadfilefromtheme"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>download<wbr/>File<wbr/>From<wbr/>Theme</span></a><a href="#downloadtheme"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>download<wbr/>Theme</span></a><a href="#gettheme"><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/>Theme</span></a><a href="#getthemes"><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/>Themes</span></a><a href="#patchtheme"><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/>Theme</span></a><a href="#uploadtheme"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>upload<wbr/>Theme</span></a></div></details></div></details></div><div class="site-menu"><nav id="tsd-sidebar-links" class="tsd-navigation"><a href="https://qlik.dev/embed/" class="tsd-nav-link">Embed</a><a href="https://qlik.dev/extend/" class="tsd-nav-link">Extend</a><a href="https://qlik.dev/manage/" class="tsd-nav-link">Manage</a><a href="https://qlik.dev/apis/" class="tsd-nav-link">APIs</a><a href="https://qlik.dev/toolkits/" class="tsd-nav-link">Toolkits</a></nav><nav class="tsd-navigation"><a href="../index.html">@qlik/api reference</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><div class="wrapper"><div><img alt="Qlik logo" src="../assets/logo-footer.svg"/></div><div class="social"><a class="text" href="https://community.qlik.com/">Qlik Community</a><div class="icons"><a href="https://qlikdeveloper.slack.com/join/shared_invite/zt-1t4vc1qee-3P6R0ERUNfNeE7O6DPnN_Q#/shared-invite/email" aria-label="Qlik developer on slack"><svg viewBox="0 0 54 54" fill="currentColor" aria-hidden="true" height="1.7rem"><path fill="currentColor" d="M19.712.133a5.381 5.381 0 0 0-5.376 5.387 5.381 5.381 0 0 0 5.376 5.386h5.376V5.52A5.381 5.381 0 0 0 19.712.133m0 14.365H5.376A5.381 5.381 0 0 0 0 19.884a5.381 5.381 0 0 0 5.376 5.387h14.336a5.381 5.381 0 0 0 5.376-5.387 5.381 5.381 0 0 0-5.376-5.386"></path><path d="M53.76 19.884a5.381 5.381 0 0 0-5.376-5.386 5.381 5.381 0 0 0-5.376 5.386v5.387h5.376a5.381 5.381 0 0 0 5.376-5.387m-14.336 0V5.52A5.381 5.381 0 0 0 34.048.133a5.381 5.381 0 0 0-5.376 5.387v14.364a5.381 5.381 0 0 0 5.376 5.387 5.381 5.381 0 0 0 5.376-5.387"></path><path d="M34.048 54a5.381 5.381 0 0 0 5.376-5.387 5.381 5.381 0 0 0-5.376-5.386h-5.376v5.386A5.381 5.381 0 0 0 34.048 54m0-14.365h14.336a5.381 5.381 0 0 0 5.376-5.386 5.381 5.381 0 0 0-5.376-5.387H34.048a5.381 5.381 0 0 0-5.376 5.387 5.381 5.381 0 0 0 5.376 5.386"></path><path d="M0 34.249a5.381 5.381 0 0 0 5.376 5.386 5.381 5.381 0 0 0 5.376-5.386v-5.387H5.376A5.381 5.381 0 0 0 0 34.25m14.336-.001v14.364A5.381 5.381 0 0 0 19.712 54a5.381 5.381 0 0 0 5.376-5.387V34.25a5.381 5.381 0 0 0-5.376-5.387 5.381 5.381 0 0 0-5.376 5.387"></path></svg></a><a href="https://www.facebook.com/qlik" aria-label="Qlik on Facebook"><svg viewBox="0 0 21 21" fill="currentColor" aria-hidden="true" height="1.7rem"><path fill="currentColor" d="M20.05 10.345C20.05 4.812 15.56.32 10.025.32 4.491.32 0 4.812 0 10.345c0 4.852 3.449 8.893 8.02 9.825v-6.817H6.015v-3.008H8.02V7.84A3.513 3.513 0 0 1 11.53 4.33h2.506v3.008H12.03c-.551 0-1.002.451-1.002 1.002v2.005h3.007v3.008h-3.007v6.967c5.062-.5 9.022-4.772 9.022-9.975Z"/></svg></a><a href="https://www.linkedin.com/company/qlik" aria-label="Qlik on LinkedIn"><svg viewBox="0 0 21 21" fill="currentColor" aria-hidden="true" height="1.7rem"><path fill="currentColor" d="M17.286.32H3.952A3.334 3.334 0 0 0 .62 3.654v13.333a3.334 3.334 0 0 0 3.333 3.333h13.334a3.334 3.334 0 0 0 3.333-3.333V3.654A3.334 3.334 0 0 0 17.286.32Zm-10 16.25H5.202V8.237h2.084v8.333Zm.013-9.995c-.271.273-.623.412-1.055.412-.427 0-.777-.141-1.05-.425a1.46 1.46 0 0 1-.408-1.046c0-.426.137-.773.408-1.042.273-.27.623-.404 1.05-.404.432 0 .784.135 1.055.404.269.27.403.616.403 1.042 0 .43-.134.783-.403 1.059Zm9.57 9.995h-2.083v-4.63c0-1.292-.745-2.036-1.667-2.036-.445 0-.948.269-1.235.612-.288.342-.431.777-.431 1.302v4.752H9.369V8.237h2.084v1.317h.032c.614-1.013 1.506-1.517 2.678-1.521 1.665-.004 2.706 1.246 2.706 3.435v5.102Z"/></svg></a><a href="https://x.com/qlikdeveloper" aria-label="Qlik on X.com"><svg viewBox="0 0 21 21" fill="currentColor" aria-hidden="true" height="1.7rem"><path fill="currentColor" d="M11.698 8.789 18.983.32h-1.727l-6.325 7.354L5.878.32H.051l7.64 11.12-7.64 8.88h1.726l6.68-7.765 5.336 7.765h5.828L11.697 8.79Zm-2.365 2.749-.774-1.108-6.16-8.81h2.652l4.97 7.11.775 1.107 6.461 9.243h-2.652l-5.272-7.542Z"/></svg></a></div></div><div class="legal"><div class="links"><a href="https://www.qlik.com/us/legal/legal-agreements">Legal Agreements</a> /<a href="https://www.qlik.com/us/legal/legal-policies">Legal Policies</a> /<a href="https://www.qlik.com/us/legal/privacy-and-cookie-notice">Privacy &amp; Cookie Notice</a> /<a href="https://qlik.dev/qlik-developer-portal-terms-of-use.pdf">Terms of Use</a></div><div class="copyright">Copyright © 1993-2025 QlikTech International AB. All rights reserved.</div></div></div></footer><div class="overlay"></div></body></html>
package/website/types/transports.TransportsAPI.html ADDED
@@ -0,0 +1,23 @@
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>TransportsAPI | @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/transports.html">transports</a></li><li><a href="" aria-current="page">TransportsAPI</a></li></ul><h1>Type Alias TransportsAPI</h1></div><div class="tsd-signature"><span class="tsd-signature-keyword">type</span> <span class="tsd-kind-type-alias">TransportsAPI</span> <span class="tsd-signature-symbol">=</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-keyword">typeof</span> <a href="../functions/transports.clearCache.html" class="tsd-signature-type tsd-kind-function">clearCache</a><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#deleteemailconfig">deleteEmailConfig</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">typeof</span> <a href="../functions/transports.deleteEmailConfig.html" class="tsd-signature-type tsd-kind-function">deleteEmailConfig</a><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#getemailconfig">getEmailConfig</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">typeof</span> <a href="../functions/transports.getEmailConfig.html" class="tsd-signature-type tsd-kind-function">getEmailConfig</a><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#patchemailconfig">patchEmailConfig</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">typeof</span> <a href="../functions/transports.patchEmailConfig.html" class="tsd-signature-type tsd-kind-function">patchEmailConfig</a><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#sendtestemail">sendTestEmail</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">typeof</span> <a href="../functions/transports.sendTestEmail.html" class="tsd-signature-type tsd-kind-function">sendTestEmail</a><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#validateemailconfig">validateEmailConfig</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">typeof</span> <a href="../functions/transports.validateEmailConfig.html" class="tsd-signature-type tsd-kind-function">validateEmailConfig</a><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#verifyemailconfigconnection">verifyEmailConfigConnection</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">typeof</span> <a href="../functions/transports.verifyEmailConfigConnection.html" class="tsd-signature-type tsd-kind-function">verifyEmailConfigConnection</a><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
+ <a href="#deleteemailconfig" 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>delete<wbr/>Email<wbr/>Config</span></a>
3
+ <a href="#getemailconfig" 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/>Email<wbr/>Config</span></a>
4
+ <a href="#patchemailconfig" 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/>Email<wbr/>Config</span></a>
5
+ <a href="#sendtestemail" 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>send<wbr/>Test<wbr/>Email</span></a>
6
+ <a href="#validateemailconfig" 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>validate<wbr/>Email<wbr/>Config</span></a>
7
+ <a href="#verifyemailconfigconnection" 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>verify<wbr/>Email<wbr/>Config<wbr/>Connection</span></a>
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-keyword">typeof</span> <a href="../functions/transports.clearCache.html" class="tsd-signature-type tsd-kind-function">clearCache</a></div><div class="tsd-comment tsd-typography"><p>Clears the cache for transports api requests.</p>
9
+ </div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="deleteemailconfig"><span>delete<wbr/>Email<wbr/>Config</span><a href="#deleteemailconfig" 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">deleteEmailConfig</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">typeof</span> <a href="../functions/transports.deleteEmailConfig.html" class="tsd-signature-type tsd-kind-function">deleteEmailConfig</a></div><div class="tsd-comment tsd-typography"><p>Deletes the email configuration for the tenant.</p>
10
+ </div><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>DeleteEmailConfigHttpError</p>
11
+ </div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getemailconfig"><span>get<wbr/>Email<wbr/>Config</span><a href="#getemailconfig" 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">getEmailConfig</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">typeof</span> <a href="../functions/transports.getEmailConfig.html" class="tsd-signature-type tsd-kind-function">getEmailConfig</a></div><div class="tsd-comment tsd-typography"><p>Returns the current email configuration and configuration status for the tenant.</p>
12
+ </div><div class="tsd-comment tsd-typography"><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>GetEmailConfigHttpError</p>
13
+ </div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="patchemailconfig"><span>patch<wbr/>Email<wbr/>Config</span><a href="#patchemailconfig" 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">patchEmailConfig</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">typeof</span> <a href="../functions/transports.patchEmailConfig.html" class="tsd-signature-type tsd-kind-function">patchEmailConfig</a></div><div class="tsd-comment tsd-typography"><p>Patch the email configuration for the tenant.</p>
14
+ </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
+ </div><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>PatchEmailConfigHttpError</p>
16
+ </div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="sendtestemail"><span>send<wbr/>Test<wbr/>Email</span><a href="#sendtestemail" 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">sendTestEmail</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">typeof</span> <a href="../functions/transports.sendTestEmail.html" class="tsd-signature-type tsd-kind-function">sendTestEmail</a></div><div class="tsd-comment tsd-typography"><p>Attempts to sends a test email using the active configuration, with the supplied email info (subject, body, recipient).</p>
17
+ </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>
18
+ </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>SendTestEmailHttpError</p>
19
+ </div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="validateemailconfig"><span>validate<wbr/>Email<wbr/>Config</span><a href="#validateemailconfig" 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">validateEmailConfig</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">typeof</span> <a href="../functions/transports.validateEmailConfig.html" class="tsd-signature-type tsd-kind-function">validateEmailConfig</a></div><div class="tsd-comment tsd-typography"><p>Returns the current isValid value for the email configuration for the tenant. Does not attempt to connect to a server to verify the connection or send a test email. Will return false if no email configuration exists.</p>
20
+ </div><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>ValidateEmailConfigHttpError</p>
21
+ </div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="verifyemailconfigconnection"><span>verify<wbr/>Email<wbr/>Config<wbr/>Connection</span><a href="#verifyemailconfigconnection" 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">verifyEmailConfigConnection</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">typeof</span> <a href="../functions/transports.verifyEmailConfigConnection.html" class="tsd-signature-type tsd-kind-function">verifyEmailConfigConnection</a></div><div class="tsd-comment tsd-typography"><p>Attempts to verify connection to email server using a low-level protocol handshake to confirm the server is reachable and the credentials are valid, without sending a test email.</p>
22
+ </div><div class="tsd-comment tsd-typography"><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>VerifyEmailConfigConnectionHttpError</p>
23
+ </div></div></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-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><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-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><h3>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><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>Properties</summary><div><a href="#clearcache"><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><a href="#deleteemailconfig"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>delete<wbr/>Email<wbr/>Config</span></a><a href="#getemailconfig"><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/>Email<wbr/>Config</span></a><a href="#patchemailconfig"><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/>Email<wbr/>Config</span></a><a href="#sendtestemail"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>send<wbr/>Test<wbr/>Email</span></a><a href="#validateemailconfig"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>validate<wbr/>Email<wbr/>Config</span></a><a href="#verifyemailconfigconnection"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>verify<wbr/>Email<wbr/>Config<wbr/>Connection</span></a></div></details></div></details></div><div class="site-menu"><nav id="tsd-sidebar-links" class="tsd-navigation"><a href="https://qlik.dev/embed/" class="tsd-nav-link">Embed</a><a href="https://qlik.dev/extend/" class="tsd-nav-link">Extend</a><a href="https://qlik.dev/manage/" class="tsd-nav-link">Manage</a><a href="https://qlik.dev/apis/" class="tsd-nav-link">APIs</a><a href="https://qlik.dev/toolkits/" class="tsd-nav-link">Toolkits</a></nav><nav class="tsd-navigation"><a href="../index.html">@qlik/api reference</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><div class="wrapper"><div><img alt="Qlik logo" src="../assets/logo-footer.svg"/></div><div class="social"><a class="text" href="https://community.qlik.com/">Qlik Community</a><div class="icons"><a href="https://qlikdeveloper.slack.com/join/shared_invite/zt-1t4vc1qee-3P6R0ERUNfNeE7O6DPnN_Q#/shared-invite/email" aria-label="Qlik developer on slack"><svg viewBox="0 0 54 54" fill="currentColor" aria-hidden="true" height="1.7rem"><path fill="currentColor" d="M19.712.133a5.381 5.381 0 0 0-5.376 5.387 5.381 5.381 0 0 0 5.376 5.386h5.376V5.52A5.381 5.381 0 0 0 19.712.133m0 14.365H5.376A5.381 5.381 0 0 0 0 19.884a5.381 5.381 0 0 0 5.376 5.387h14.336a5.381 5.381 0 0 0 5.376-5.387 5.381 5.381 0 0 0-5.376-5.386"></path><path d="M53.76 19.884a5.381 5.381 0 0 0-5.376-5.386 5.381 5.381 0 0 0-5.376 5.386v5.387h5.376a5.381 5.381 0 0 0 5.376-5.387m-14.336 0V5.52A5.381 5.381 0 0 0 34.048.133a5.381 5.381 0 0 0-5.376 5.387v14.364a5.381 5.381 0 0 0 5.376 5.387 5.381 5.381 0 0 0 5.376-5.387"></path><path d="M34.048 54a5.381 5.381 0 0 0 5.376-5.387 5.381 5.381 0 0 0-5.376-5.386h-5.376v5.386A5.381 5.381 0 0 0 34.048 54m0-14.365h14.336a5.381 5.381 0 0 0 5.376-5.386 5.381 5.381 0 0 0-5.376-5.387H34.048a5.381 5.381 0 0 0-5.376 5.387 5.381 5.381 0 0 0 5.376 5.386"></path><path d="M0 34.249a5.381 5.381 0 0 0 5.376 5.386 5.381 5.381 0 0 0 5.376-5.386v-5.387H5.376A5.381 5.381 0 0 0 0 34.25m14.336-.001v14.364A5.381 5.381 0 0 0 19.712 54a5.381 5.381 0 0 0 5.376-5.387V34.25a5.381 5.381 0 0 0-5.376-5.387 5.381 5.381 0 0 0-5.376 5.387"></path></svg></a><a href="https://www.facebook.com/qlik" aria-label="Qlik on Facebook"><svg viewBox="0 0 21 21" fill="currentColor" aria-hidden="true" height="1.7rem"><path fill="currentColor" d="M20.05 10.345C20.05 4.812 15.56.32 10.025.32 4.491.32 0 4.812 0 10.345c0 4.852 3.449 8.893 8.02 9.825v-6.817H6.015v-3.008H8.02V7.84A3.513 3.513 0 0 1 11.53 4.33h2.506v3.008H12.03c-.551 0-1.002.451-1.002 1.002v2.005h3.007v3.008h-3.007v6.967c5.062-.5 9.022-4.772 9.022-9.975Z"/></svg></a><a href="https://www.linkedin.com/company/qlik" aria-label="Qlik on LinkedIn"><svg viewBox="0 0 21 21" fill="currentColor" aria-hidden="true" height="1.7rem"><path fill="currentColor" d="M17.286.32H3.952A3.334 3.334 0 0 0 .62 3.654v13.333a3.334 3.334 0 0 0 3.333 3.333h13.334a3.334 3.334 0 0 0 3.333-3.333V3.654A3.334 3.334 0 0 0 17.286.32Zm-10 16.25H5.202V8.237h2.084v8.333Zm.013-9.995c-.271.273-.623.412-1.055.412-.427 0-.777-.141-1.05-.425a1.46 1.46 0 0 1-.408-1.046c0-.426.137-.773.408-1.042.273-.27.623-.404 1.05-.404.432 0 .784.135 1.055.404.269.27.403.616.403 1.042 0 .43-.134.783-.403 1.059Zm9.57 9.995h-2.083v-4.63c0-1.292-.745-2.036-1.667-2.036-.445 0-.948.269-1.235.612-.288.342-.431.777-.431 1.302v4.752H9.369V8.237h2.084v1.317h.032c.614-1.013 1.506-1.517 2.678-1.521 1.665-.004 2.706 1.246 2.706 3.435v5.102Z"/></svg></a><a href="https://x.com/qlikdeveloper" aria-label="Qlik on X.com"><svg viewBox="0 0 21 21" fill="currentColor" aria-hidden="true" height="1.7rem"><path fill="currentColor" d="M11.698 8.789 18.983.32h-1.727l-6.325 7.354L5.878.32H.051l7.64 11.12-7.64 8.88h1.726l6.68-7.765 5.336 7.765h5.828L11.697 8.79Zm-2.365 2.749-.774-1.108-6.16-8.81h2.652l4.97 7.11.775 1.107 6.461 9.243h-2.652l-5.272-7.542Z"/></svg></a></div></div><div class="legal"><div class="links"><a href="https://www.qlik.com/us/legal/legal-agreements">Legal Agreements</a> /<a href="https://www.qlik.com/us/legal/legal-policies">Legal Policies</a> /<a href="https://www.qlik.com/us/legal/privacy-and-cookie-notice">Privacy &amp; Cookie Notice</a> /<a href="https://qlik.dev/qlik-developer-portal-terms-of-use.pdf">Terms of Use</a></div><div class="copyright">Copyright © 1993-2025 QlikTech International AB. All rights reserved.</div></div></div></footer><div class="overlay"></div></body></html>
package/website/types/ui-config.UiConfigAPI.html ADDED
@@ -0,0 +1,30 @@
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>UiConfigAPI | @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/ui-config.html">ui-config</a></li><li><a href="" aria-current="page">UiConfigAPI</a></li></ul><h1>Type Alias UiConfigAPI</h1></div><div class="tsd-signature"><span class="tsd-signature-keyword">type</span> <span class="tsd-kind-type-alias">UiConfigAPI</span> <span class="tsd-signature-symbol">=</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-keyword">typeof</span> <a href="../functions/ui-config.clearCache.html" class="tsd-signature-type tsd-kind-function">clearCache</a><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#createuiconfigpinnedlink">createUiConfigPinnedLink</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">typeof</span> <a href="../functions/ui-config.createUiConfigPinnedLink.html" class="tsd-signature-type tsd-kind-function">createUiConfigPinnedLink</a><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#createuiconfigpinnedlinks">createUiConfigPinnedLinks</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">typeof</span> <a href="../functions/ui-config.createUiConfigPinnedLinks.html" class="tsd-signature-type tsd-kind-function">createUiConfigPinnedLinks</a><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#deletealluiconfigpinnedlinks">deleteAllUiConfigPinnedLinks</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">typeof</span> <a href="../functions/ui-config.deleteAllUiConfigPinnedLinks.html" class="tsd-signature-type tsd-kind-function">deleteAllUiConfigPinnedLinks</a><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#deleteuiconfigpinnedlink">deleteUiConfigPinnedLink</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">typeof</span> <a href="../functions/ui-config.deleteUiConfigPinnedLink.html" class="tsd-signature-type tsd-kind-function">deleteUiConfigPinnedLink</a><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#getuiconfigpinnedlink">getUiConfigPinnedLink</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">typeof</span> <a href="../functions/ui-config.getUiConfigPinnedLink.html" class="tsd-signature-type tsd-kind-function">getUiConfigPinnedLink</a><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#getuiconfigpinnedlinks">getUiConfigPinnedLinks</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">typeof</span> <a href="../functions/ui-config.getUiConfigPinnedLinks.html" class="tsd-signature-type tsd-kind-function">getUiConfigPinnedLinks</a><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#patchuiconfigpinnedlink">patchUiConfigPinnedLink</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">typeof</span> <a href="../functions/ui-config.patchUiConfigPinnedLink.html" class="tsd-signature-type tsd-kind-function">patchUiConfigPinnedLink</a><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
+ <a href="#createuiconfigpinnedlink" 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>create<wbr/>Ui<wbr/>Config<wbr/>Pinned<wbr/>Link</span></a>
3
+ <a href="#createuiconfigpinnedlinks" 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>create<wbr/>Ui<wbr/>Config<wbr/>Pinned<wbr/>Links</span></a>
4
+ <a href="#deletealluiconfigpinnedlinks" 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>delete<wbr/>All<wbr/>Ui<wbr/>Config<wbr/>Pinned<wbr/>Links</span></a>
5
+ <a href="#deleteuiconfigpinnedlink" 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>delete<wbr/>Ui<wbr/>Config<wbr/>Pinned<wbr/>Link</span></a>
6
+ <a href="#getuiconfigpinnedlink" 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/>Ui<wbr/>Config<wbr/>Pinned<wbr/>Link</span></a>
7
+ <a href="#getuiconfigpinnedlinks" 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/>Ui<wbr/>Config<wbr/>Pinned<wbr/>Links</span></a>
8
+ <a href="#patchuiconfigpinnedlink" 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/>Ui<wbr/>Config<wbr/>Pinned<wbr/>Link</span></a>
9
+ </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-keyword">typeof</span> <a href="../functions/ui-config.clearCache.html" class="tsd-signature-type tsd-kind-function">clearCache</a></div><div class="tsd-comment tsd-typography"><p>Clears the cache for ui-config api requests.</p>
10
+ </div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="createuiconfigpinnedlink"><span>create<wbr/>Ui<wbr/>Config<wbr/>Pinned<wbr/>Link</span><a href="#createuiconfigpinnedlink" 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">createUiConfigPinnedLink</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">typeof</span> <a href="../functions/ui-config.createUiConfigPinnedLink.html" class="tsd-signature-type tsd-kind-function">createUiConfigPinnedLink</a></div><div class="tsd-comment tsd-typography"><p>Creates a pinned link, which will appear below any existing pinned links in the tenant. Requires calling user to be assigned the <code>TenantAdmin</code> role. A tenant can have a maximum of 50 pinned links.</p>
11
+ </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>
12
+ </div><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>CreateUiConfigPinnedLinkHttpError</p>
13
+ </div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="createuiconfigpinnedlinks"><span>create<wbr/>Ui<wbr/>Config<wbr/>Pinned<wbr/>Links</span><a href="#createuiconfigpinnedlinks" 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">createUiConfigPinnedLinks</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">typeof</span> <a href="../functions/ui-config.createUiConfigPinnedLinks.html" class="tsd-signature-type tsd-kind-function">createUiConfigPinnedLinks</a></div><div class="tsd-comment tsd-typography"><p>Creates one or more pinned links for navigation, an alternative method to multiple calls to <code>/ui-config/pinned-links</code>. Links are displayed below any existing pinned links, and will be added in the order sent in the request. Requires calling user to be assigned the <code>TenantAdmin</code> role. A tenant can have a maximum of 50 pinned links.</p>
14
+ </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>
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>CreateUiConfigPinnedLinksHttpError</p>
16
+ </div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="deletealluiconfigpinnedlinks"><span>delete<wbr/>All<wbr/>Ui<wbr/>Config<wbr/>Pinned<wbr/>Links</span><a href="#deletealluiconfigpinnedlinks" 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">deleteAllUiConfigPinnedLinks</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">typeof</span> <a href="../functions/ui-config.deleteAllUiConfigPinnedLinks.html" class="tsd-signature-type tsd-kind-function">deleteAllUiConfigPinnedLinks</a></div><div class="tsd-comment tsd-typography"><p>Deletes all pinned links in the tenant. Requires calling user to be assigned the <code>TenantAdmin</code> role.</p>
17
+ </div><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>DeleteAllUiConfigPinnedLinksHttpError</p>
18
+ </div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="deleteuiconfigpinnedlink"><span>delete<wbr/>Ui<wbr/>Config<wbr/>Pinned<wbr/>Link</span><a href="#deleteuiconfigpinnedlink" 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">deleteUiConfigPinnedLink</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">typeof</span> <a href="../functions/ui-config.deleteUiConfigPinnedLink.html" class="tsd-signature-type tsd-kind-function">deleteUiConfigPinnedLink</a></div><div class="tsd-comment tsd-typography"><p>Deletes a specific pinned link. Requires calling user to be assigned the <code>TenantAdmin</code> role.</p>
19
+ </div><div class="tsd-comment tsd-typography"><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-id">Param: id<a href="#param-id" 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>The pinned link identifier.</p>
20
+ </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>DeleteUiConfigPinnedLinkHttpError</p>
21
+ </div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getuiconfigpinnedlink"><span>get<wbr/>Ui<wbr/>Config<wbr/>Pinned<wbr/>Link</span><a href="#getuiconfigpinnedlink" 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">getUiConfigPinnedLink</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">typeof</span> <a href="../functions/ui-config.getUiConfigPinnedLink.html" class="tsd-signature-type tsd-kind-function">getUiConfigPinnedLink</a></div><div class="tsd-comment tsd-typography"><p>Retrieves a specific pinned link.</p>
22
+ </div><div class="tsd-comment tsd-typography"><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-id-1">Param: id<a href="#param-id-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>The pinned link identifier.</p>
23
+ </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>GetUiConfigPinnedLinkHttpError</p>
24
+ </div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getuiconfigpinnedlinks"><span>get<wbr/>Ui<wbr/>Config<wbr/>Pinned<wbr/>Links</span><a href="#getuiconfigpinnedlinks" 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">getUiConfigPinnedLinks</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">typeof</span> <a href="../functions/ui-config.getUiConfigPinnedLinks.html" class="tsd-signature-type tsd-kind-function">getUiConfigPinnedLinks</a></div><div class="tsd-comment tsd-typography"><p>Retrieves a list of all pinned links. All users can list pinned links. This endpoint does not support pagination as a tenant can have a maximum of 50 pinned links at one time.</p>
25
+ </div><div class="tsd-comment tsd-typography"><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>GetUiConfigPinnedLinksHttpError</p>
26
+ </div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="patchuiconfigpinnedlink"><span>patch<wbr/>Ui<wbr/>Config<wbr/>Pinned<wbr/>Link</span><a href="#patchuiconfigpinnedlink" 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">patchUiConfigPinnedLink</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">typeof</span> <a href="../functions/ui-config.patchUiConfigPinnedLink.html" class="tsd-signature-type tsd-kind-function">patchUiConfigPinnedLink</a></div><div class="tsd-comment tsd-typography"><p>Updates a specific pinned link with an array of JSON patches. Requires calling user to be assigned the <code>TenantAdmin</code> role.</p>
27
+ </div><div class="tsd-comment tsd-typography"><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-id-2">Param: id<a href="#param-id-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>The pinned link identifier.</p>
28
+ </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>
29
+ </div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-6">Throws<a href="#throws-6" 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>PatchUiConfigPinnedLinkHttpError</p>
30
+ </div></div></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-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><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-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><h3>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><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>Properties</summary><div><a href="#clearcache"><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><a href="#createuiconfigpinnedlink"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>create<wbr/>Ui<wbr/>Config<wbr/>Pinned<wbr/>Link</span></a><a href="#createuiconfigpinnedlinks"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>create<wbr/>Ui<wbr/>Config<wbr/>Pinned<wbr/>Links</span></a><a href="#deletealluiconfigpinnedlinks"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>delete<wbr/>All<wbr/>Ui<wbr/>Config<wbr/>Pinned<wbr/>Links</span></a><a href="#deleteuiconfigpinnedlink"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>delete<wbr/>Ui<wbr/>Config<wbr/>Pinned<wbr/>Link</span></a><a href="#getuiconfigpinnedlink"><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/>Ui<wbr/>Config<wbr/>Pinned<wbr/>Link</span></a><a href="#getuiconfigpinnedlinks"><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/>Ui<wbr/>Config<wbr/>Pinned<wbr/>Links</span></a><a href="#patchuiconfigpinnedlink"><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/>Ui<wbr/>Config<wbr/>Pinned<wbr/>Link</span></a></div></details></div></details></div><div class="site-menu"><nav id="tsd-sidebar-links" class="tsd-navigation"><a href="https://qlik.dev/embed/" class="tsd-nav-link">Embed</a><a href="https://qlik.dev/extend/" class="tsd-nav-link">Extend</a><a href="https://qlik.dev/manage/" class="tsd-nav-link">Manage</a><a href="https://qlik.dev/apis/" class="tsd-nav-link">APIs</a><a href="https://qlik.dev/toolkits/" class="tsd-nav-link">Toolkits</a></nav><nav class="tsd-navigation"><a href="../index.html">@qlik/api reference</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><div class="wrapper"><div><img alt="Qlik logo" src="../assets/logo-footer.svg"/></div><div class="social"><a class="text" href="https://community.qlik.com/">Qlik Community</a><div class="icons"><a href="https://qlikdeveloper.slack.com/join/shared_invite/zt-1t4vc1qee-3P6R0ERUNfNeE7O6DPnN_Q#/shared-invite/email" aria-label="Qlik developer on slack"><svg viewBox="0 0 54 54" fill="currentColor" aria-hidden="true" height="1.7rem"><path fill="currentColor" d="M19.712.133a5.381 5.381 0 0 0-5.376 5.387 5.381 5.381 0 0 0 5.376 5.386h5.376V5.52A5.381 5.381 0 0 0 19.712.133m0 14.365H5.376A5.381 5.381 0 0 0 0 19.884a5.381 5.381 0 0 0 5.376 5.387h14.336a5.381 5.381 0 0 0 5.376-5.387 5.381 5.381 0 0 0-5.376-5.386"></path><path d="M53.76 19.884a5.381 5.381 0 0 0-5.376-5.386 5.381 5.381 0 0 0-5.376 5.386v5.387h5.376a5.381 5.381 0 0 0 5.376-5.387m-14.336 0V5.52A5.381 5.381 0 0 0 34.048.133a5.381 5.381 0 0 0-5.376 5.387v14.364a5.381 5.381 0 0 0 5.376 5.387 5.381 5.381 0 0 0 5.376-5.387"></path><path d="M34.048 54a5.381 5.381 0 0 0 5.376-5.387 5.381 5.381 0 0 0-5.376-5.386h-5.376v5.386A5.381 5.381 0 0 0 34.048 54m0-14.365h14.336a5.381 5.381 0 0 0 5.376-5.386 5.381 5.381 0 0 0-5.376-5.387H34.048a5.381 5.381 0 0 0-5.376 5.387 5.381 5.381 0 0 0 5.376 5.386"></path><path d="M0 34.249a5.381 5.381 0 0 0 5.376 5.386 5.381 5.381 0 0 0 5.376-5.386v-5.387H5.376A5.381 5.381 0 0 0 0 34.25m14.336-.001v14.364A5.381 5.381 0 0 0 19.712 54a5.381 5.381 0 0 0 5.376-5.387V34.25a5.381 5.381 0 0 0-5.376-5.387 5.381 5.381 0 0 0-5.376 5.387"></path></svg></a><a href="https://www.facebook.com/qlik" aria-label="Qlik on Facebook"><svg viewBox="0 0 21 21" fill="currentColor" aria-hidden="true" height="1.7rem"><path fill="currentColor" d="M20.05 10.345C20.05 4.812 15.56.32 10.025.32 4.491.32 0 4.812 0 10.345c0 4.852 3.449 8.893 8.02 9.825v-6.817H6.015v-3.008H8.02V7.84A3.513 3.513 0 0 1 11.53 4.33h2.506v3.008H12.03c-.551 0-1.002.451-1.002 1.002v2.005h3.007v3.008h-3.007v6.967c5.062-.5 9.022-4.772 9.022-9.975Z"/></svg></a><a href="https://www.linkedin.com/company/qlik" aria-label="Qlik on LinkedIn"><svg viewBox="0 0 21 21" fill="currentColor" aria-hidden="true" height="1.7rem"><path fill="currentColor" d="M17.286.32H3.952A3.334 3.334 0 0 0 .62 3.654v13.333a3.334 3.334 0 0 0 3.333 3.333h13.334a3.334 3.334 0 0 0 3.333-3.333V3.654A3.334 3.334 0 0 0 17.286.32Zm-10 16.25H5.202V8.237h2.084v8.333Zm.013-9.995c-.271.273-.623.412-1.055.412-.427 0-.777-.141-1.05-.425a1.46 1.46 0 0 1-.408-1.046c0-.426.137-.773.408-1.042.273-.27.623-.404 1.05-.404.432 0 .784.135 1.055.404.269.27.403.616.403 1.042 0 .43-.134.783-.403 1.059Zm9.57 9.995h-2.083v-4.63c0-1.292-.745-2.036-1.667-2.036-.445 0-.948.269-1.235.612-.288.342-.431.777-.431 1.302v4.752H9.369V8.237h2.084v1.317h.032c.614-1.013 1.506-1.517 2.678-1.521 1.665-.004 2.706 1.246 2.706 3.435v5.102Z"/></svg></a><a href="https://x.com/qlikdeveloper" aria-label="Qlik on X.com"><svg viewBox="0 0 21 21" fill="currentColor" aria-hidden="true" height="1.7rem"><path fill="currentColor" d="M11.698 8.789 18.983.32h-1.727l-6.325 7.354L5.878.32H.051l7.64 11.12-7.64 8.88h1.726l6.68-7.765 5.336 7.765h5.828L11.697 8.79Zm-2.365 2.749-.774-1.108-6.16-8.81h2.652l4.97 7.11.775 1.107 6.461 9.243h-2.652l-5.272-7.542Z"/></svg></a></div></div><div class="legal"><div class="links"><a href="https://www.qlik.com/us/legal/legal-agreements">Legal Agreements</a> /<a href="https://www.qlik.com/us/legal/legal-policies">Legal Policies</a> /<a href="https://www.qlik.com/us/legal/privacy-and-cookie-notice">Privacy &amp; Cookie Notice</a> /<a href="https://qlik.dev/qlik-developer-portal-terms-of-use.pdf">Terms of Use</a></div><div class="copyright">Copyright © 1993-2025 QlikTech International AB. All rights reserved.</div></div></div></footer><div class="overlay"></div></body></html>