@qlik/api 1.45.0 → 1.47.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 (492) 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-Do2Z8IEt.js → auth-BgDh43gP.js} +1 -1
  27. package/chunks/{auth-DH6Zx6GE.js → auth-Bgj9KHYv.js} +1 -1
  28. package/chunks/{auth-DFOXWfqh.d.ts → auth-DKv6n_GN.d.ts} +1 -1
  29. package/chunks/{auth-functions-By9Ryr3H.js → auth-functions-KuUL5VnO.js} +32 -2
  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/dist-CKkIPLEp.js +115 -0
  54. package/chunks/{encryption-CjBmNQDZ.d.ts → encryption-1JNNXFB7.d.ts} +3 -3
  55. package/chunks/{extensions-D05y2FWk.d.ts → extensions-qbclNpnA.d.ts} +3 -3
  56. package/chunks/{glossaries-vYbykU3r.d.ts → glossaries-g1PPnHoM.d.ts} +17 -17
  57. package/chunks/{groups-BapgngJf.d.ts → groups-DrqKqkAv.d.ts} +3 -3
  58. package/chunks/{identity-providers-CAxsp9hP.d.ts → identity-providers-iRAccwIg.d.ts} +3 -3
  59. package/chunks/{interceptors-BF556LaK.d.ts → interceptors-DHkfs1ua.d.ts} +1 -1
  60. package/chunks/{invoke-fetch-hML-5n7w.js → invoke-fetch-COIxoXL6.js} +1 -1
  61. package/chunks/{invoke-fetch-DLQ5LN79.js → invoke-fetch-Z1aRlURh.js} +2 -2
  62. package/chunks/{items-CjVrNg57.d.ts → items-N3gAR5AS.d.ts} +3 -3
  63. package/chunks/{knowledgebases-BFiV7Fwh.d.ts → knowledgebases-B0tcNrg8.d.ts} +3 -3
  64. package/chunks/{licenses-yZKgQ2k6.d.ts → licenses-CrB0eiUU.d.ts} +3 -3
  65. package/chunks/{lineage-graphs-Bkc04N-t.d.ts → lineage-graphs-BL1kIsvQ.d.ts} +3 -3
  66. package/chunks/{ml-CPzq_j0K.d.ts → ml-CQQZV57e.d.ts} +3 -3
  67. package/chunks/{notes-C5HjmBeI.d.ts → notes-BWDOf71L.d.ts} +3 -3
  68. package/chunks/{notifications-DfP7aWPH.d.ts → notifications--FW8kp8T.d.ts} +3 -3
  69. package/chunks/{oauth-clients-BmMEDuET.d.ts → oauth-clients-BDI9_NJw.d.ts} +3 -3
  70. package/chunks/{oauth-tokens-Dimf19DE.d.ts → oauth-tokens-CqViLZD0.d.ts} +3 -3
  71. package/chunks/public-runtime-modules-BBAJOUvT.js +31 -0
  72. package/chunks/{qix-Wsz3JE_a.js → qix-0TV95g_d.js} +3 -3
  73. package/chunks/{qix-CbiHOu7Z.d.ts → qix-8oI6W8Iq.d.ts} +3 -3
  74. package/chunks/{qix-B_hHiSSK.js → qix-DLKCrPFH.js} +1 -1
  75. package/chunks/{qix-chunk-entrypoint-w25mSjTi.js → qix-chunk-entrypoint-CJ9R1CLV.js} +1 -1
  76. package/chunks/{questions-CFN7BgWt.d.ts → questions-DAXXmfTM.d.ts} +3 -3
  77. package/chunks/{quotas-BUH2e2K_.d.ts → quotas-BV0q47cU.d.ts} +3 -3
  78. package/chunks/{reload-tasks-DN3X2-30.d.ts → reload-tasks-DORwZo4c.d.ts} +3 -3
  79. package/chunks/{reloads-CpY6F3Y0.d.ts → reloads-C7RAAgAu.d.ts} +3 -3
  80. package/chunks/{report-templates-D5KOFkRi.d.ts → report-templates-C3P0_-D3.d.ts} +3 -3
  81. package/chunks/{reports-CRwCogRL.d.ts → reports-C7saF89N.d.ts} +3 -3
  82. package/chunks/{roles-DCzyiLdU.d.ts → roles-DBdOYajz.d.ts} +3 -3
  83. package/chunks/{sharing-tasks-DsxFrADQ.d.ts → sharing-tasks-Dm9L1sMF.d.ts} +3 -3
  84. package/chunks/{spaces-B0cx23Nc.d.ts → spaces-CjF6Q30z.d.ts} +3 -3
  85. package/chunks/{tasks-DWfE5JM_.d.ts → tasks-CX1ohkzr.d.ts} +3 -3
  86. package/chunks/{temp-contents-CU94UTZU.d.ts → temp-contents-D-NhmvhI.d.ts} +3 -3
  87. package/chunks/{tenants-DvtbiwAP.d.ts → tenants-BbFJ4gEC.d.ts} +3 -3
  88. package/chunks/{themes-BPkyCLWS.d.ts → themes-DCHwpvan.d.ts} +3 -3
  89. package/chunks/{transports-DlRmSWLj.d.ts → transports-CQoT2abX.d.ts} +15 -15
  90. package/chunks/{ui-config-BqX-bPjf.d.ts → ui-config-8gkgFE8J.d.ts} +3 -3
  91. package/chunks/{users-CuQ0nboa.d.ts → users-D7kk0z77.d.ts} +3 -3
  92. package/chunks/{web-integrations-D54LCd0Z.d.ts → web-integrations-BMiMloLY.d.ts} +3 -3
  93. package/chunks/{web-notifications-sUlHGnmy.d.ts → web-notifications-CGGnIRRw.d.ts} +3 -3
  94. package/chunks/{webhooks-Dw0FIeFq.d.ts → webhooks-tylLbUkb.d.ts} +3 -3
  95. package/collections.d.ts +2 -2
  96. package/collections.js +2 -2
  97. package/conditions.d.ts +2 -2
  98. package/conditions.js +2 -2
  99. package/consumption.d.ts +2 -2
  100. package/consumption.js +2 -2
  101. package/csp-origins.d.ts +2 -2
  102. package/csp-origins.js +2 -2
  103. package/csrf-token.d.ts +2 -2
  104. package/csrf-token.js +2 -2
  105. package/data-alerts.d.ts +2 -2
  106. package/data-alerts.js +2 -2
  107. package/data-assets.d.ts +2 -2
  108. package/data-assets.js +2 -2
  109. package/data-connections.d.ts +2 -2
  110. package/data-connections.js +2 -2
  111. package/data-credentials.d.ts +2 -2
  112. package/data-credentials.js +2 -2
  113. package/data-files.d.ts +2 -2
  114. package/data-files.js +2 -2
  115. package/data-qualities.d.ts +2 -2
  116. package/data-qualities.js +2 -2
  117. package/data-sets.d.ts +2 -2
  118. package/data-sets.js +2 -2
  119. package/data-sources.d.ts +2 -2
  120. package/data-sources.js +2 -2
  121. package/data-stores.d.ts +2 -2
  122. package/data-stores.js +2 -2
  123. package/dcaas.d.ts +2 -2
  124. package/dcaas.js +2 -2
  125. package/di-projects.d.ts +2 -2
  126. package/di-projects.js +2 -2
  127. package/direct-access-agents.d.ts +2 -2
  128. package/direct-access-agents.js +2 -2
  129. package/encryption.d.ts +2 -2
  130. package/encryption.js +2 -2
  131. package/extensions.d.ts +2 -2
  132. package/extensions.js +2 -2
  133. package/global-types.d.ts +1 -1
  134. package/glossaries.d.ts +2 -2
  135. package/glossaries.js +9 -9
  136. package/groups.d.ts +2 -2
  137. package/groups.js +2 -2
  138. package/identity-providers.d.ts +2 -2
  139. package/identity-providers.js +2 -2
  140. package/index.d.ts +79 -79
  141. package/index.js +188 -185
  142. package/interceptors.d.ts +2 -2
  143. package/invoke-fetch-types.d.ts +1 -1
  144. package/items.d.ts +2 -2
  145. package/items.js +2 -2
  146. package/knowledgebases.d.ts +2 -2
  147. package/knowledgebases.js +2 -2
  148. package/licenses.d.ts +2 -2
  149. package/licenses.js +2 -2
  150. package/lineage-graphs.d.ts +2 -2
  151. package/lineage-graphs.js +2 -2
  152. package/ml.d.ts +2 -2
  153. package/ml.js +2 -2
  154. package/notes.d.ts +2 -2
  155. package/notes.js +2 -2
  156. package/notifications.d.ts +2 -2
  157. package/notifications.js +2 -2
  158. package/oauth-clients.d.ts +2 -2
  159. package/oauth-clients.js +2 -2
  160. package/oauth-tokens.d.ts +2 -2
  161. package/oauth-tokens.js +2 -2
  162. package/package.json +3 -3
  163. package/qix.d.ts +3 -3
  164. package/qix.js +2 -2
  165. package/questions.d.ts +2 -2
  166. package/questions.js +2 -2
  167. package/quotas.d.ts +2 -2
  168. package/quotas.js +2 -2
  169. package/reload-tasks.d.ts +2 -2
  170. package/reload-tasks.js +2 -2
  171. package/reloads.d.ts +2 -2
  172. package/reloads.js +2 -2
  173. package/report-templates.d.ts +2 -2
  174. package/report-templates.js +2 -2
  175. package/reports.d.ts +2 -2
  176. package/reports.js +2 -2
  177. package/roles.d.ts +2 -2
  178. package/roles.js +2 -2
  179. package/sharing-tasks.d.ts +2 -2
  180. package/sharing-tasks.js +2 -2
  181. package/spaces.d.ts +2 -2
  182. package/spaces.js +2 -2
  183. package/tasks.d.ts +2 -2
  184. package/tasks.js +2 -2
  185. package/temp-contents.d.ts +2 -2
  186. package/temp-contents.js +2 -2
  187. package/tenants.d.ts +2 -2
  188. package/tenants.js +2 -2
  189. package/themes.d.ts +2 -2
  190. package/themes.js +2 -2
  191. package/transports.d.ts +2 -2
  192. package/transports.js +8 -8
  193. package/ui-config.d.ts +2 -2
  194. package/ui-config.js +2 -2
  195. package/users.d.ts +2 -2
  196. package/users.js +2 -2
  197. package/web-integrations.d.ts +2 -2
  198. package/web-integrations.js +2 -2
  199. package/web-notifications.d.ts +2 -2
  200. package/web-notifications.js +2 -2
  201. package/webhooks.d.ts +2 -2
  202. package/webhooks.js +2 -2
  203. package/website/assets/navigation.js +1 -1
  204. package/website/assets/search.js +1 -1
  205. package/website/functions/assistants.getAssistantStarters.html +3 -3
  206. package/website/functions/assistants.getAssistantThreads.html +3 -3
  207. package/website/functions/assistants.getAssistants.html +3 -3
  208. package/website/functions/automations.getAutomations.html +3 -3
  209. package/website/functions/glossaries.changeGlossaryTermStatus.html +1 -1
  210. package/website/functions/glossaries.createGlossary.html +1 -1
  211. package/website/functions/glossaries.createGlossaryTermLink.html +1 -1
  212. package/website/functions/glossaries.importGlossary.html +2 -2
  213. package/website/functions/glossaries.patchGlossary.html +1 -1
  214. package/website/functions/glossaries.patchGlossaryCategory.html +1 -1
  215. package/website/functions/knowledgebases.getKnowledgebases.html +3 -3
  216. package/website/functions/transports.deleteEmailConfig.html +1 -1
  217. package/website/functions/transports.getEmailConfig.html +1 -1
  218. package/website/functions/transports.patchEmailConfig.html +1 -1
  219. package/website/functions/transports.sendTestEmail.html +1 -1
  220. package/website/functions/transports.validateEmailConfig.html +1 -1
  221. package/website/functions/transports.verifyEmailConfigConnection.html +1 -1
  222. package/website/interfaces/index.QlikAPI.html +60 -60
  223. package/website/interfaces/qix.GenericObject.html +1 -1
  224. package/website/modules/api-keys.html +1 -1
  225. package/website/modules/apps.html +1 -1
  226. package/website/modules/assistants.html +1 -1
  227. package/website/modules/audits.html +1 -1
  228. package/website/modules/automation-connections.html +1 -1
  229. package/website/modules/automations.html +1 -1
  230. package/website/modules/automl-deployments.html +1 -1
  231. package/website/modules/automl-predictions.html +1 -1
  232. package/website/modules/brands.html +1 -1
  233. package/website/modules/collections.html +1 -1
  234. package/website/modules/conditions.html +1 -1
  235. package/website/modules/consumption.html +1 -1
  236. package/website/modules/csp-origins.html +1 -1
  237. package/website/modules/csrf-token.html +1 -1
  238. package/website/modules/data-alerts.html +1 -1
  239. package/website/modules/data-assets.html +1 -1
  240. package/website/modules/data-connections.html +1 -1
  241. package/website/modules/data-credentials.html +1 -1
  242. package/website/modules/data-files.html +1 -1
  243. package/website/modules/data-qualities.html +1 -1
  244. package/website/modules/data-sets.html +1 -1
  245. package/website/modules/data-sources.html +1 -1
  246. package/website/modules/data-stores.html +1 -1
  247. package/website/modules/dcaas.html +1 -1
  248. package/website/modules/di-projects.html +1 -1
  249. package/website/modules/direct-access-agents.html +1 -1
  250. package/website/modules/encryption.html +1 -1
  251. package/website/modules/extensions.html +1 -1
  252. package/website/modules/glossaries.html +1 -1
  253. package/website/modules/groups.html +1 -1
  254. package/website/modules/identity-providers.html +1 -1
  255. package/website/modules/items.html +1 -1
  256. package/website/modules/knowledgebases.html +1 -1
  257. package/website/modules/licenses.html +1 -1
  258. package/website/modules/lineage-graphs.html +1 -1
  259. package/website/modules/ml.html +1 -1
  260. package/website/modules/notes.html +1 -1
  261. package/website/modules/notifications.html +1 -1
  262. package/website/modules/oauth-clients.html +1 -1
  263. package/website/modules/oauth-tokens.html +1 -1
  264. package/website/modules/questions.html +1 -1
  265. package/website/modules/quotas.html +1 -1
  266. package/website/modules/reload-tasks.html +1 -1
  267. package/website/modules/reloads.html +1 -1
  268. package/website/modules/report-templates.html +1 -1
  269. package/website/modules/reports.html +1 -1
  270. package/website/modules/roles.html +1 -1
  271. package/website/modules/sharing-tasks.html +1 -1
  272. package/website/modules/spaces.html +1 -1
  273. package/website/modules/tasks.html +1 -1
  274. package/website/modules/temp-contents.html +1 -1
  275. package/website/modules/tenants.html +1 -1
  276. package/website/modules/themes.html +1 -1
  277. package/website/modules/transports.html +1 -1
  278. package/website/modules/ui-config.html +1 -1
  279. package/website/modules/users.html +1 -1
  280. package/website/modules/web-integrations.html +1 -1
  281. package/website/modules/web-notifications.html +1 -1
  282. package/website/modules/webhooks.html +1 -1
  283. package/website/types/api-keys.ApiKeysAPI.html +34 -0
  284. package/website/types/apps.AppsAPI.html +241 -0
  285. package/website/types/assistants.AssistantsAPI.html +156 -0
  286. package/website/types/assistants.CreateAssistantHttpError.html +2 -2
  287. package/website/types/assistants.CreateAssistantStarterHttpError.html +2 -2
  288. package/website/types/assistants.CreateAssistantThreadHttpError.html +2 -2
  289. package/website/types/assistants.CreateAssistantThreadInteractionFeedbackHttpError.html +2 -2
  290. package/website/types/assistants.CreateAssistantThreadInteractionHttpError.html +2 -2
  291. package/website/types/assistants.CreateAssistantThreadInteractionReviewHttpError.html +2 -2
  292. package/website/types/assistants.DeleteAssistantHttpError.html +2 -2
  293. package/website/types/assistants.DeleteAssistantStarterFollowupHttpError.html +2 -2
  294. package/website/types/assistants.DeleteAssistantStarterHttpError.html +2 -2
  295. package/website/types/assistants.DeleteAssistantThreadHttpError.html +2 -2
  296. package/website/types/assistants.DeleteAssistantThreadInteractionHttpError.html +2 -2
  297. package/website/types/assistants.ErrorResponseCode.html +1 -11
  298. package/website/types/assistants.ErrorResponseCodeCopy.html +11 -1
  299. package/website/types/assistants.GetAssistantFeedbackHttpError.html +2 -2
  300. package/website/types/assistants.GetAssistantHttpError.html +2 -2
  301. package/website/types/assistants.GetAssistantSourcesHttpError.html +2 -2
  302. package/website/types/assistants.GetAssistantStarterHttpError.html +2 -2
  303. package/website/types/assistants.GetAssistantStartersHttpError.html +2 -2
  304. package/website/types/assistants.GetAssistantThreadHttpError.html +2 -2
  305. package/website/types/assistants.GetAssistantThreadInteractionHttpError.html +2 -2
  306. package/website/types/assistants.GetAssistantThreadInteractionsHttpError.html +2 -2
  307. package/website/types/assistants.GetAssistantThreadsHttpError.html +2 -2
  308. package/website/types/assistants.GetAssistantsHttpError.html +2 -2
  309. package/website/types/assistants.InvokeAssistantThreadHttpError.html +2 -2
  310. package/website/types/assistants.PatchAssistantHttpError.html +2 -2
  311. package/website/types/assistants.PatchAssistantThreadHttpError.html +2 -2
  312. package/website/types/assistants.PatchAssistantThreadInteractionFeedbackHttpError.html +2 -2
  313. package/website/types/assistants.StreamAssistantThreadHttpError.html +2 -2
  314. package/website/types/assistants.UpdateAssistantStarterFollowupHttpError.html +2 -2
  315. package/website/types/assistants.UpdateAssistantStarterHttpError.html +2 -2
  316. package/website/types/audits.AuditsAPI.html +27 -0
  317. package/website/types/automation-connections.AutomationConnectionsAPI.html +39 -0
  318. package/website/types/automations.AutomationsAPI.html +100 -0
  319. package/website/types/automl-deployments.AutomlDeploymentsAPI.html +9 -0
  320. package/website/types/automl-predictions.AutomlPredictionsAPI.html +32 -0
  321. package/website/types/brands.BrandsAPI.html +59 -0
  322. package/website/types/collections.CollectionsAPI.html +53 -0
  323. package/website/types/conditions.ConditionsAPI.html +50 -0
  324. package/website/types/consumption.ConsumptionAPI.html +7 -0
  325. package/website/types/csp-origins.CspOriginsAPI.html +27 -0
  326. package/website/{interfaces → types}/csrf-token.CsrfTokenAPI.html +4 -7
  327. package/website/types/data-alerts.DataAlertsAPI.html +73 -0
  328. package/website/types/data-assets.DataAssetsAPI.html +23 -0
  329. package/website/types/data-connections.DataConnectionsAPI.html +54 -0
  330. package/website/types/data-credentials.DataCredentialsAPI.html +35 -0
  331. package/website/types/data-files.DataFilesAPI.html +86 -0
  332. package/website/types/data-qualities.DataQualitiesAPI.html +18 -0
  333. package/website/types/data-sets.DataSetsAPI.html +27 -0
  334. package/website/types/data-sources.DataSourcesAPI.html +25 -0
  335. package/website/types/data-stores.DataStoresAPI.html +47 -0
  336. package/website/types/dcaas.DcaasAPI.html +15 -0
  337. package/website/types/di-projects.DiProjectsAPI.html +104 -0
  338. package/website/types/direct-access-agents.DirectAccessAgentsAPI.html +72 -0
  339. package/website/types/encryption.EncryptionAPI.html +40 -0
  340. package/website/types/extensions.ExtensionsAPI.html +32 -0
  341. package/website/types/glossaries.GlossariesAPI.html +127 -0
  342. package/website/types/groups.GroupsAPI.html +36 -0
  343. package/website/types/identity-providers.IdentityProvidersAPI.html +33 -0
  344. package/website/types/items.ItemsAPI.html +37 -0
  345. package/website/types/knowledgebases.KnowledgebasesAPI.html +90 -0
  346. package/website/types/licenses.LicensesAPI.html +36 -0
  347. package/website/types/lineage-graphs.LineageGraphsAPI.html +60 -0
  348. package/website/types/ml.MlAPI.html +230 -0
  349. package/website/{interfaces → types}/notes.NotesAPI.html +7 -13
  350. package/website/{interfaces → types}/notifications.NotificationsAPI.html +5 -12
  351. package/website/types/oauth-clients.OauthClientsAPI.html +53 -0
  352. package/website/types/oauth-tokens.OauthTokensAPI.html +11 -0
  353. package/website/types/qix.NativeGenericObjectFunctions.html +1 -1
  354. package/website/types/qix.RpcObject.html +1 -1
  355. package/website/types/qix.VariableListItem.html +1 -1
  356. package/website/types/questions.QuestionsAPI.html +12 -0
  357. package/website/types/quotas.QuotasAPI.html +12 -0
  358. package/website/types/reload-tasks.ReloadTasksAPI.html +24 -0
  359. package/website/types/reloads.ReloadsAPI.html +22 -0
  360. package/website/types/report-templates.ReportTemplatesAPI.html +33 -0
  361. package/website/types/reports.ReportsAPI.html +17 -0
  362. package/website/types/roles.RolesAPI.html +24 -0
  363. package/website/types/sharing-tasks.SharingTasksAPI.html +62 -0
  364. package/website/types/spaces.SpacesAPI.html +84 -0
  365. package/website/types/tasks.TasksAPI.html +49 -0
  366. package/website/types/temp-contents.TempContentsAPI.html +17 -0
  367. package/website/types/tenants.TenantsAPI.html +29 -0
  368. package/website/types/themes.ThemesAPI.html +32 -0
  369. package/website/types/transports.TransportsAPI.html +23 -0
  370. package/website/types/ui-config.UiConfigAPI.html +30 -0
  371. package/website/types/users.UsersAPI.html +41 -0
  372. package/website/types/web-integrations.WebIntegrationsAPI.html +24 -0
  373. package/website/types/web-notifications.WebNotificationsAPI.html +30 -0
  374. package/website/types/webhooks.WebhooksAPI.html +47 -0
  375. package/website/variables/index.apiKeys.html +1 -1
  376. package/website/variables/index.apps.html +1 -1
  377. package/website/variables/index.assistants.html +1 -1
  378. package/website/variables/index.audits.html +1 -1
  379. package/website/variables/index.automationConnections.html +1 -1
  380. package/website/variables/index.automations.html +1 -1
  381. package/website/variables/index.automlDeployments.html +1 -1
  382. package/website/variables/index.automlPredictions.html +1 -1
  383. package/website/variables/index.brands.html +1 -1
  384. package/website/variables/index.collections.html +1 -1
  385. package/website/variables/index.conditions.html +1 -1
  386. package/website/variables/index.consumption.html +1 -1
  387. package/website/variables/index.cspOrigins.html +1 -1
  388. package/website/variables/index.csrfToken.html +1 -1
  389. package/website/variables/index.dataAlerts.html +1 -1
  390. package/website/variables/index.dataAssets.html +1 -1
  391. package/website/variables/index.dataConnections.html +1 -1
  392. package/website/variables/index.dataCredentials.html +1 -1
  393. package/website/variables/index.dataFiles.html +1 -1
  394. package/website/variables/index.dataQualities.html +1 -1
  395. package/website/variables/index.dataSets.html +1 -1
  396. package/website/variables/index.dataSources.html +1 -1
  397. package/website/variables/index.dataStores.html +1 -1
  398. package/website/variables/index.dcaas.html +1 -1
  399. package/website/variables/index.diProjects.html +1 -1
  400. package/website/variables/index.directAccessAgents.html +1 -1
  401. package/website/variables/index.encryption.html +1 -1
  402. package/website/variables/index.extensions.html +1 -1
  403. package/website/variables/index.glossaries.html +1 -1
  404. package/website/variables/index.groups.html +1 -1
  405. package/website/variables/index.identityProviders.html +1 -1
  406. package/website/variables/index.items.html +1 -1
  407. package/website/variables/index.knowledgebases.html +1 -1
  408. package/website/variables/index.licenses.html +1 -1
  409. package/website/variables/index.lineageGraphs.html +1 -1
  410. package/website/variables/index.ml.html +1 -1
  411. package/website/variables/index.notes.html +1 -1
  412. package/website/variables/index.notifications.html +1 -1
  413. package/website/variables/index.oauthClients.html +1 -1
  414. package/website/variables/index.oauthTokens.html +1 -1
  415. package/website/variables/index.questions.html +1 -1
  416. package/website/variables/index.quotas.html +1 -1
  417. package/website/variables/index.reloadTasks.html +1 -1
  418. package/website/variables/index.reloads.html +1 -1
  419. package/website/variables/index.reportTemplates.html +1 -1
  420. package/website/variables/index.reports.html +1 -1
  421. package/website/variables/index.roles.html +1 -1
  422. package/website/variables/index.sharingTasks.html +1 -1
  423. package/website/variables/index.spaces.html +1 -1
  424. package/website/variables/index.tasks.html +1 -1
  425. package/website/variables/index.tempContents.html +1 -1
  426. package/website/variables/index.tenants.html +1 -1
  427. package/website/variables/index.themes.html +1 -1
  428. package/website/variables/index.transports.html +1 -1
  429. package/website/variables/index.uiConfig.html +1 -1
  430. package/website/variables/index.users.html +1 -1
  431. package/website/variables/index.webIntegrations.html +1 -1
  432. package/website/variables/index.webNotifications.html +1 -1
  433. package/website/variables/index.webhooks.html +1 -1
  434. package/website/variables/qix.QIX_SCHEMA_VERSION.html +1 -1
  435. package/chunks/dist-DtYihfwd.js +0 -58
  436. package/chunks/public-runtime-modules-n0gcxl0_.js +0 -28
  437. package/website/interfaces/api-keys.ApiKeysAPI.html +0 -66
  438. package/website/interfaces/apps.AppsAPI.html +0 -486
  439. package/website/interfaces/assistants.AssistantsAPI.html +0 -300
  440. package/website/interfaces/audits.AuditsAPI.html +0 -55
  441. package/website/interfaces/automation-connections.AutomationConnectionsAPI.html +0 -73
  442. package/website/interfaces/automations.AutomationsAPI.html +0 -199
  443. package/website/interfaces/automl-deployments.AutomlDeploymentsAPI.html +0 -19
  444. package/website/interfaces/automl-predictions.AutomlPredictionsAPI.html +0 -56
  445. package/website/interfaces/brands.BrandsAPI.html +0 -115
  446. package/website/interfaces/collections.CollectionsAPI.html +0 -119
  447. package/website/interfaces/conditions.ConditionsAPI.html +0 -87
  448. package/website/interfaces/consumption.ConsumptionAPI.html +0 -20
  449. package/website/interfaces/csp-origins.CspOriginsAPI.html +0 -65
  450. package/website/interfaces/data-alerts.DataAlertsAPI.html +0 -162
  451. package/website/interfaces/data-assets.DataAssetsAPI.html +0 -40
  452. package/website/interfaces/data-connections.DataConnectionsAPI.html +0 -125
  453. package/website/interfaces/data-credentials.DataCredentialsAPI.html +0 -67
  454. package/website/interfaces/data-files.DataFilesAPI.html +0 -268
  455. package/website/interfaces/data-qualities.DataQualitiesAPI.html +0 -33
  456. package/website/interfaces/data-sets.DataSetsAPI.html +0 -50
  457. package/website/interfaces/data-sources.DataSourcesAPI.html +0 -50
  458. package/website/interfaces/data-stores.DataStoresAPI.html +0 -92
  459. package/website/interfaces/dcaas.DcaasAPI.html +0 -26
  460. package/website/interfaces/di-projects.DiProjectsAPI.html +0 -192
  461. package/website/interfaces/direct-access-agents.DirectAccessAgentsAPI.html +0 -131
  462. package/website/interfaces/encryption.EncryptionAPI.html +0 -68
  463. package/website/interfaces/extensions.ExtensionsAPI.html +0 -59
  464. package/website/interfaces/glossaries.GlossariesAPI.html +0 -271
  465. package/website/interfaces/groups.GroupsAPI.html +0 -73
  466. package/website/interfaces/identity-providers.IdentityProvidersAPI.html +0 -60
  467. package/website/interfaces/items.ItemsAPI.html +0 -97
  468. package/website/interfaces/knowledgebases.KnowledgebasesAPI.html +0 -175
  469. package/website/interfaces/licenses.LicensesAPI.html +0 -70
  470. package/website/interfaces/lineage-graphs.LineageGraphsAPI.html +0 -133
  471. package/website/interfaces/ml.MlAPI.html +0 -552
  472. package/website/interfaces/oauth-clients.OauthClientsAPI.html +0 -99
  473. package/website/interfaces/oauth-tokens.OauthTokensAPI.html +0 -22
  474. package/website/interfaces/questions.QuestionsAPI.html +0 -23
  475. package/website/interfaces/quotas.QuotasAPI.html +0 -22
  476. package/website/interfaces/reload-tasks.ReloadTasksAPI.html +0 -46
  477. package/website/interfaces/reloads.ReloadsAPI.html +0 -56
  478. package/website/interfaces/report-templates.ReportTemplatesAPI.html +0 -63
  479. package/website/interfaces/reports.ReportsAPI.html +0 -36
  480. package/website/interfaces/roles.RolesAPI.html +0 -47
  481. package/website/interfaces/sharing-tasks.SharingTasksAPI.html +0 -131
  482. package/website/interfaces/spaces.SpacesAPI.html +0 -171
  483. package/website/interfaces/tasks.TasksAPI.html +0 -102
  484. package/website/interfaces/temp-contents.TempContentsAPI.html +0 -33
  485. package/website/interfaces/tenants.TenantsAPI.html +0 -50
  486. package/website/interfaces/themes.ThemesAPI.html +0 -59
  487. package/website/interfaces/transports.TransportsAPI.html +0 -38
  488. package/website/interfaces/ui-config.UiConfigAPI.html +0 -51
  489. package/website/interfaces/users.UsersAPI.html +0 -112
  490. package/website/interfaces/web-integrations.WebIntegrationsAPI.html +0 -46
  491. package/website/interfaces/web-notifications.WebNotificationsAPI.html +0 -57
  492. package/website/interfaces/webhooks.WebhooksAPI.html +0 -101
package/website/interfaces/collections.CollectionsAPI.html DELETED
@@ -1,119 +0,0 @@
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>CollectionsAPI | @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/collections.html">collections</a></li><li><a href="" aria-current="page">CollectionsAPI</a></li></ul><h1>Interface CollectionsAPI</h1></div><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">CollectionsAPI</span> <span class="tsd-signature-symbol">{</span><br/>    <a class="tsd-kind-property" href="#addcollectionitem">addCollectionItem</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/>        <span class="tsd-kind-parameter">collectionId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>        <span class="tsd-kind-parameter">body</span><span class="tsd-signature-symbol">:</span> <a href="../types/collections.CollectionsAddCollectionItemRequestBody.html" class="tsd-signature-type tsd-kind-type-alias">CollectionsAddCollectionItemRequestBody</a><span class="tsd-signature-symbol">,</span><br/>        <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/collections.AddCollectionItemHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">AddCollectionItemHttpResponse</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#clearcache">clearCache</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#createcollection">createCollection</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/>        <span class="tsd-kind-parameter">body</span><span class="tsd-signature-symbol">:</span> <a href="../types/collections.CollectionsCreateCollectionRequestBody.html" class="tsd-signature-type tsd-kind-type-alias">CollectionsCreateCollectionRequestBody</a><span class="tsd-signature-symbol">,</span><br/>        <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/collections.CreateCollectionHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">CreateCollectionHttpResponse</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#deletecollection">deleteCollection</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/>        <span class="tsd-kind-parameter">collectionId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>        <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/collections.DeleteCollectionHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">DeleteCollectionHttpResponse</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#deletecollectionitem">deleteCollectionItem</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/>        <span class="tsd-kind-parameter">collectionId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>        <span class="tsd-kind-parameter">itemId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>        <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/collections.DeleteCollectionItemHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">DeleteCollectionItemHttpResponse</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#getcollection">getCollection</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/>        <span class="tsd-kind-parameter">collectionId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>        <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/collections.GetCollectionHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetCollectionHttpResponse</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#getcollectionitem">getCollectionItem</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/>        <span class="tsd-kind-parameter">collectionId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>        <span class="tsd-kind-parameter">itemId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>        <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/collections.GetCollectionItemHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetCollectionItemHttpResponse</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#getcollectionitems">getCollectionItems</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/>        <span class="tsd-kind-parameter">collectionId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>        <span class="tsd-kind-parameter">query</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span><br/>            <span class="tsd-kind-property">limit</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/>            <span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/>            <span class="tsd-kind-property">next</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/>            <span class="tsd-kind-property">noActions</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/>            <span class="tsd-kind-property">prev</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/>            <span class="tsd-kind-property">query</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/>            <span class="tsd-kind-property">resourceId</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/>            <span class="tsd-kind-property">resourceLink</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/>            <span class="tsd-kind-property">resourceType</span><span class="tsd-signature-symbol">?:</span> <a href="../types/collections.ItemResourceTypeEnum.html" class="tsd-signature-type tsd-kind-type-alias">ItemResourceTypeEnum</a><span class="tsd-signature-symbol">;</span><br/>            <span class="tsd-kind-property">shared</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/>            <span class="tsd-kind-property">sort</span><span class="tsd-signature-symbol">?:</span><br/>                <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;-name&quot;</span><br/>                <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;+name&quot;</span><br/>                <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;+createdAt&quot;</span><br/>                <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;-createdAt&quot;</span><br/>                <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;+updatedAt&quot;</span><br/>                <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;-updatedAt&quot;</span><span class="tsd-signature-symbol">;</span><br/>            <span class="tsd-kind-property">spaceId</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/>        <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">,</span><br/>        <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/collections.GetCollectionItemsHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetCollectionItemsHttpResponse</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#getcollections">getCollections</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/>        <span class="tsd-kind-parameter">query</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span><br/>            <span class="tsd-kind-property">creatorId</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/>            <span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/>            <span class="tsd-kind-property">includeItems</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/>            <span class="tsd-kind-property">limit</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/>            <span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/>            <span class="tsd-kind-property">next</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/>            <span class="tsd-kind-property">prev</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/>            <span class="tsd-kind-property">query</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/>            <span class="tsd-kind-property">sort</span><span class="tsd-signature-symbol">?:</span><br/>                <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;-name&quot;</span><br/>                <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;+name&quot;</span><br/>                <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;+createdAt&quot;</span><br/>                <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;-createdAt&quot;</span><br/>                <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;+updatedAt&quot;</span><br/>                <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;-updatedAt&quot;</span><span class="tsd-signature-symbol">;</span><br/>            <span class="tsd-kind-property">type</span><span class="tsd-signature-symbol">?:</span> <a href="../types/collections.CollectionTypes.html" class="tsd-signature-type tsd-kind-type-alias">CollectionTypes</a><span class="tsd-signature-symbol">;</span><br/>            <span class="tsd-kind-property">types</span><span class="tsd-signature-symbol">?:</span> <a href="../types/collections.CollectionTypes.html" class="tsd-signature-type tsd-kind-type-alias">CollectionTypes</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/>        <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">,</span><br/>        <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/collections.GetCollectionsHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetCollectionsHttpResponse</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#getfavoritescollection">getFavoritesCollection</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/>        <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/collections.GetFavoritesCollectionHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetFavoritesCollectionHttpResponse</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#patchcollection">patchCollection</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/>        <span class="tsd-kind-parameter">collectionId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>        <span class="tsd-kind-parameter">body</span><span class="tsd-signature-symbol">:</span> <a href="../types/collections.CollectionByIdPatch.html" class="tsd-signature-type tsd-kind-type-alias">CollectionByIdPatch</a><span class="tsd-signature-symbol">,</span><br/>        <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/collections.PatchCollectionHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">PatchCollectionHttpResponse</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#updatecollection">updateCollection</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/>        <span class="tsd-kind-parameter">collectionId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>        <span class="tsd-kind-parameter">body</span><span class="tsd-signature-symbol">:</span> <a href="../types/collections.CollectionsUpdateCollectionRequestBody.html" class="tsd-signature-type tsd-kind-type-alias">CollectionsUpdateCollectionRequestBody</a><span class="tsd-signature-symbol">,</span><br/>        <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/collections.UpdateCollectionHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">UpdateCollectionHttpResponse</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h5 class="tsd-index-heading uppercase">Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="#addcollectionitem" 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>add<wbr/>Collection<wbr/>Item</span></a>
2
- <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>
3
- <a href="#createcollection" 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/>Collection</span></a>
4
- <a href="#deletecollection" 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/>Collection</span></a>
5
- <a href="#deletecollectionitem" 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/>Collection<wbr/>Item</span></a>
6
- <a href="#getcollection" 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/>Collection</span></a>
7
- <a href="#getcollectionitem" 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/>Collection<wbr/>Item</span></a>
8
- <a href="#getcollectionitems" 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/>Collection<wbr/>Items</span></a>
9
- <a href="#getcollections" 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/>Collections</span></a>
10
- <a href="#getfavoritescollection" 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/>Favorites<wbr/>Collection</span></a>
11
- <a href="#patchcollection" 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/>Collection</span></a>
12
- <a href="#updatecollection" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>update<wbr/>Collection</span></a>
13
- </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="addcollectionitem"><span>add<wbr/>Collection<wbr/>Item</span><a href="#addcollectionitem" 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">addCollectionItem</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">collectionId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">body</span><span class="tsd-signature-symbol">:</span> <a href="../types/collections.CollectionsAddCollectionItemRequestBody.html" class="tsd-signature-type tsd-kind-type-alias">CollectionsAddCollectionItemRequestBody</a><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/collections.AddCollectionItemHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">AddCollectionItemHttpResponse</a><span class="tsd-signature-symbol">&gt;</span></div><div class="tsd-comment tsd-typography"><p>Adds an item to a collection and returns the item.</p>
14
- </div><div class="tsd-type-declaration"><h4>Type Declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">collectionId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">body</span><span class="tsd-signature-symbol">:</span> <a href="../types/collections.CollectionsAddCollectionItemRequestBody.html" class="tsd-signature-type tsd-kind-type-alias">CollectionsAddCollectionItemRequestBody</a><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/collections.AddCollectionItemHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">AddCollectionItemHttpResponse</a><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Adds an item to a collection and returns the item.</p>
15
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">collectionId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The collection's unique identifier.</p>
16
- </div></li><li><span><span class="tsd-kind-parameter">body</span>: <a href="../types/collections.CollectionsAddCollectionItemRequestBody.html" class="tsd-signature-type tsd-kind-type-alias">CollectionsAddCollectionItemRequestBody</a></span><div class="tsd-comment tsd-typography"><p>an object with the body content</p>
17
- </div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/collections.AddCollectionItemHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">AddCollectionItemHttpResponse</a><span class="tsd-signature-symbol">&gt;</span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws">Throws<a href="#throws" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>AddCollectionItemHttpError</p>
18
- </div></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-collectionid">Param: collectionId<a href="#param-collectionid" 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 collection's unique identifier.</p>
19
- </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>
20
- </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>AddCollectionItemHttpError</p>
21
- </div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="clearcache"><span>clear<wbr/>Cache</span><a href="#clearcache" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">clearCache</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span></div><div class="tsd-comment tsd-typography"><p>Clears the cache for collections api requests.</p>
22
- </div><div class="tsd-type-declaration"><h4>Type Declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Clears the cache for collections api requests.</p>
23
- </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="createcollection"><span>create<wbr/>Collection</span><a href="#createcollection" 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">createCollection</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">body</span><span class="tsd-signature-symbol">:</span> <a href="../types/collections.CollectionsCreateCollectionRequestBody.html" class="tsd-signature-type tsd-kind-type-alias">CollectionsCreateCollectionRequestBody</a><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/collections.CreateCollectionHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">CreateCollectionHttpResponse</a><span class="tsd-signature-symbol">&gt;</span></div><div class="tsd-comment tsd-typography"><p>Creates and returns a new collection. Collections of type <code>public</code> (shown as tags in the user interface) must have unique names. Other collection types can reuse names.</p>
24
- </div><div class="tsd-type-declaration"><h4>Type Declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">body</span><span class="tsd-signature-symbol">:</span> <a href="../types/collections.CollectionsCreateCollectionRequestBody.html" class="tsd-signature-type tsd-kind-type-alias">CollectionsCreateCollectionRequestBody</a><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/collections.CreateCollectionHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">CreateCollectionHttpResponse</a><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Creates and returns a new collection. Collections of type <code>public</code> (shown as tags in the user interface) must have unique names. Other collection types can reuse names.</p>
25
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">body</span>: <a href="../types/collections.CollectionsCreateCollectionRequestBody.html" class="tsd-signature-type tsd-kind-type-alias">CollectionsCreateCollectionRequestBody</a></span><div class="tsd-comment tsd-typography"><p>an object with the body content</p>
26
- </div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/collections.CreateCollectionHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">CreateCollectionHttpResponse</a><span class="tsd-signature-symbol">&gt;</span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-2">Throws<a href="#throws-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>CreateCollectionHttpError</p>
27
- </div></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-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>
28
- </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>CreateCollectionHttpError</p>
29
- </div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="deletecollection"><span>delete<wbr/>Collection</span><a href="#deletecollection" 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">deleteCollection</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">collectionId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/collections.DeleteCollectionHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">DeleteCollectionHttpResponse</a><span class="tsd-signature-symbol">&gt;</span></div><div class="tsd-comment tsd-typography"><p>Deletes a collection and removes all items from the collection.</p>
30
- </div><div class="tsd-type-declaration"><h4>Type Declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">collectionId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/collections.DeleteCollectionHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">DeleteCollectionHttpResponse</a><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Deletes a collection and removes all items from the collection.</p>
31
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">collectionId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The collection's unique identifier.</p>
32
- </div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/collections.DeleteCollectionHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">DeleteCollectionHttpResponse</a><span class="tsd-signature-symbol">&gt;</span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-4">Throws<a href="#throws-4" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>DeleteCollectionHttpError</p>
33
- </div></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-collectionid-1">Param: collectionId<a href="#param-collectionid-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 collection's unique identifier.</p>
34
- </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>DeleteCollectionHttpError</p>
35
- </div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="deletecollectionitem"><span>delete<wbr/>Collection<wbr/>Item</span><a href="#deletecollectionitem" 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">deleteCollectionItem</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">collectionId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">itemId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/collections.DeleteCollectionItemHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">DeleteCollectionItemHttpResponse</a><span class="tsd-signature-symbol">&gt;</span></div><div class="tsd-comment tsd-typography"><p>Removes an item from a collection.</p>
36
- </div><div class="tsd-type-declaration"><h4>Type Declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">collectionId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">itemId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/collections.DeleteCollectionItemHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">DeleteCollectionItemHttpResponse</a><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Removes an item from a collection.</p>
37
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">collectionId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The collection's unique identifier.</p>
38
- </div></li><li><span><span class="tsd-kind-parameter">itemId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The item's unique identifier.</p>
39
- </div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/collections.DeleteCollectionItemHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">DeleteCollectionItemHttpResponse</a><span class="tsd-signature-symbol">&gt;</span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-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>DeleteCollectionItemHttpError</p>
40
- </div></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-collectionid-2">Param: collectionId<a href="#param-collectionid-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 collection's unique identifier.</p>
41
- </div><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-itemid">Param: itemId<a href="#param-itemid" 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 item's unique identifier.</p>
42
- </div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-7">Throws<a href="#throws-7" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>DeleteCollectionItemHttpError</p>
43
- </div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getcollection"><span>get<wbr/>Collection</span><a href="#getcollection" 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">getCollection</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">collectionId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/collections.GetCollectionHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetCollectionHttpResponse</a><span class="tsd-signature-symbol">&gt;</span></div><div class="tsd-comment tsd-typography"><p>Finds and returns a collection.</p>
44
- </div><div class="tsd-type-declaration"><h4>Type Declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">collectionId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/collections.GetCollectionHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetCollectionHttpResponse</a><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Finds and returns a collection.</p>
45
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">collectionId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The collection's unique identifier.</p>
46
- </div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/collections.GetCollectionHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetCollectionHttpResponse</a><span class="tsd-signature-symbol">&gt;</span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-8">Throws<a href="#throws-8" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>GetCollectionHttpError</p>
47
- </div></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-collectionid-3">Param: collectionId<a href="#param-collectionid-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 collection's unique identifier.</p>
48
- </div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-9">Throws<a href="#throws-9" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>GetCollectionHttpError</p>
49
- </div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getcollectionitem"><span>get<wbr/>Collection<wbr/>Item</span><a href="#getcollectionitem" 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">getCollectionItem</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">collectionId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">itemId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/collections.GetCollectionItemHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetCollectionItemHttpResponse</a><span class="tsd-signature-symbol">&gt;</span></div><div class="tsd-comment tsd-typography"><p>Finds and returns an item in a specific collection. See GET <code>/items/{id}</code>.</p>
50
- </div><div class="tsd-type-declaration"><h4>Type Declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">collectionId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">itemId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/collections.GetCollectionItemHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetCollectionItemHttpResponse</a><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Finds and returns an item in a specific collection. See GET <code>/items/{id}</code>.</p>
51
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">collectionId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The collection's unique identifier.</p>
52
- </div></li><li><span><span class="tsd-kind-parameter">itemId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The item's unique identifier.</p>
53
- </div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/collections.GetCollectionItemHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetCollectionItemHttpResponse</a><span class="tsd-signature-symbol">&gt;</span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-10">Throws<a href="#throws-10" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>GetCollectionItemHttpError</p>
54
- </div></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-collectionid-4">Param: collectionId<a href="#param-collectionid-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>The collection's unique identifier.</p>
55
- </div><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-itemid-1">Param: itemId<a href="#param-itemid-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 item's unique identifier.</p>
56
- </div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-11">Throws<a href="#throws-11" 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>GetCollectionItemHttpError</p>
57
- </div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getcollectionitems"><span>get<wbr/>Collection<wbr/>Items</span><a href="#getcollectionitems" 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">getCollectionItems</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">collectionId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">query</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span><br/>        <span class="tsd-kind-property">limit</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/>        <span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/>        <span class="tsd-kind-property">next</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/>        <span class="tsd-kind-property">noActions</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/>        <span class="tsd-kind-property">prev</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/>        <span class="tsd-kind-property">query</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/>        <span class="tsd-kind-property">resourceId</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/>        <span class="tsd-kind-property">resourceLink</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/>        <span class="tsd-kind-property">resourceType</span><span class="tsd-signature-symbol">?:</span> <a href="../types/collections.ItemResourceTypeEnum.html" class="tsd-signature-type tsd-kind-type-alias">ItemResourceTypeEnum</a><span class="tsd-signature-symbol">;</span><br/>        <span class="tsd-kind-property">shared</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/>        <span class="tsd-kind-property">sort</span><span class="tsd-signature-symbol">?:</span><br/>            <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;-name&quot;</span><br/>            <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;+name&quot;</span><br/>            <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;+createdAt&quot;</span><br/>            <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;-createdAt&quot;</span><br/>            <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;+updatedAt&quot;</span><br/>            <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;-updatedAt&quot;</span><span class="tsd-signature-symbol">;</span><br/>        <span class="tsd-kind-property">spaceId</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/>    <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/collections.GetCollectionItemsHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetCollectionItemsHttpResponse</a><span class="tsd-signature-symbol">&gt;</span></div><div class="tsd-comment tsd-typography"><p>Retrieves items from a collection that the user has access to.</p>
58
- </div><div class="tsd-type-declaration"><h4>Type Declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">collectionId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">query</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span><br/>        <span class="tsd-kind-property">limit</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/>        <span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/>        <span class="tsd-kind-property">next</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/>        <span class="tsd-kind-property">noActions</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/>        <span class="tsd-kind-property">prev</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/>        <span class="tsd-kind-property">query</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/>        <span class="tsd-kind-property">resourceId</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/>        <span class="tsd-kind-property">resourceLink</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/>        <span class="tsd-kind-property">resourceType</span><span class="tsd-signature-symbol">?:</span> <a href="../types/collections.ItemResourceTypeEnum.html" class="tsd-signature-type tsd-kind-type-alias">ItemResourceTypeEnum</a><span class="tsd-signature-symbol">;</span><br/>        <span class="tsd-kind-property">shared</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/>        <span class="tsd-kind-property">sort</span><span class="tsd-signature-symbol">?:</span><br/>            <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;-name&quot;</span><br/>            <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;+name&quot;</span><br/>            <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;+createdAt&quot;</span><br/>            <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;-createdAt&quot;</span><br/>            <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;+updatedAt&quot;</span><br/>            <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;-updatedAt&quot;</span><span class="tsd-signature-symbol">;</span><br/>        <span class="tsd-kind-property">spaceId</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/>    <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/collections.GetCollectionItemsHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetCollectionItemsHttpResponse</a><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Retrieves items from a collection that the user has access to.</p>
59
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">collectionId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The collection's unique identifier. (This query also supports 'favorites' as the collectionID).</p>
60
- </div></li><li><span><span class="tsd-kind-parameter">query</span>: <span class="tsd-signature-symbol">{</span><br/>    <span class="tsd-kind-property">limit</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/>    <span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/>    <span class="tsd-kind-property">next</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/>    <span class="tsd-kind-property">noActions</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/>    <span class="tsd-kind-property">prev</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/>    <span class="tsd-kind-property">query</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/>    <span class="tsd-kind-property">resourceId</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/>    <span class="tsd-kind-property">resourceLink</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/>    <span class="tsd-kind-property">resourceType</span><span class="tsd-signature-symbol">?:</span> <a href="../types/collections.ItemResourceTypeEnum.html" class="tsd-signature-type tsd-kind-type-alias">ItemResourceTypeEnum</a><span class="tsd-signature-symbol">;</span><br/>    <span class="tsd-kind-property">shared</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/>    <span class="tsd-kind-property">sort</span><span class="tsd-signature-symbol">?:</span><br/>        <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;-name&quot;</span><br/>        <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;+name&quot;</span><br/>        <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;+createdAt&quot;</span><br/>        <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;-createdAt&quot;</span><br/>        <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;+updatedAt&quot;</span><br/>        <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;-updatedAt&quot;</span><span class="tsd-signature-symbol">;</span><br/>    <span class="tsd-kind-property">spaceId</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></span><div class="tsd-comment tsd-typography"><p>an object with query parameters</p>
61
- </div><ul class="tsd-parameters"><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">limit</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><p>The maximum number of resources to return for a request. The limit must be an integer between 1 and 100 (inclusive).</p>
62
- </div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>The case-insensitive string used to search for a resource by name.</p>
63
- </div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">next</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>The cursor to the next page of resources. Provide either the next or prev cursor, but not both.</p>
64
- </div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">noActions</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><p>If set to true, the user's available actions for each item will not be evaluated meaning the actions-array will be omitted from the response (reduces response time).</p>
65
- </div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">prev</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>The cursor to the previous page of resources. Provide either the next or prev cursor, but not both.</p>
66
- </div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">query</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>The case-insensitive string used to search for a resource by name or description.</p>
67
- </div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">resourceId</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>The case-sensitive string used to search for an item by resourceId. If resourceId is provided, then resourceType must be provided. Provide either the resourceId or resourceLink, but not both.</p>
68
- </div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">resourceLink</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>The case-sensitive string used to search for an item by resourceLink. If resourceLink is provided, then resourceType must be provided. Provide either the resourceId or resourceLink, but not both.</p>
69
- </div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">resourceType</span><span class="tsd-signature-symbol">?: </span><a href="../types/collections.ItemResourceTypeEnum.html" class="tsd-signature-type tsd-kind-type-alias">ItemResourceTypeEnum</a></h5><div class="tsd-comment tsd-typography"><p>The case-sensitive string used to search for an item by resourceType.</p>
70
- </div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">shared</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><div class="tsd-tag-deprecated"><h4 class="tsd-anchor-link" id="deprecated">Deprecated<a href="#deprecated" 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>Whether or not to return items in a shared space.</p>
71
- </div></div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">sort</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">&quot;-name&quot;</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;+name&quot;</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;+createdAt&quot;</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;-createdAt&quot;</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;+updatedAt&quot;</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;-updatedAt&quot;</span></h5><div class="tsd-comment tsd-typography"><p>The property of a resource to sort on (default sort is +createdAt). The supported properties are createdAt, updatedAt, and name. A property must be prefixed by + or - to indicate ascending or descending sort order respectively.</p>
72
- </div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">spaceId</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>The space's unique identifier (supports 'personal' as spaceId).</p>
73
- </div></li></ul></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/collections.GetCollectionItemsHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetCollectionItemsHttpResponse</a><span class="tsd-signature-symbol">&gt;</span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-12">Throws<a href="#throws-12" 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>GetCollectionItemsHttpError</p>
74
- </div></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-collectionid-5">Param: collectionId<a href="#param-collectionid-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>The collection's unique identifier. (This query also supports 'favorites' as the collectionID).
75
- *</p>
76
- </div><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-query">Param: query<a href="#param-query" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>an object with query parameters</p>
77
- </div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-13">Throws<a href="#throws-13" 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>GetCollectionItemsHttpError</p>
78
- </div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getcollections"><span>get<wbr/>Collections</span><a href="#getcollections" 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">getCollections</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">query</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span><br/>        <span class="tsd-kind-property">creatorId</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/>        <span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/>        <span class="tsd-kind-property">includeItems</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/>        <span class="tsd-kind-property">limit</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/>        <span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/>        <span class="tsd-kind-property">next</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/>        <span class="tsd-kind-property">prev</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/>        <span class="tsd-kind-property">query</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/>        <span class="tsd-kind-property">sort</span><span class="tsd-signature-symbol">?:</span><br/>            <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;-name&quot;</span><br/>            <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;+name&quot;</span><br/>            <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;+createdAt&quot;</span><br/>            <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;-createdAt&quot;</span><br/>            <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;+updatedAt&quot;</span><br/>            <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;-updatedAt&quot;</span><span class="tsd-signature-symbol">;</span><br/>        <span class="tsd-kind-property">type</span><span class="tsd-signature-symbol">?:</span> <a href="../types/collections.CollectionTypes.html" class="tsd-signature-type tsd-kind-type-alias">CollectionTypes</a><span class="tsd-signature-symbol">;</span><br/>        <span class="tsd-kind-property">types</span><span class="tsd-signature-symbol">?:</span> <a href="../types/collections.CollectionTypes.html" class="tsd-signature-type tsd-kind-type-alias">CollectionTypes</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/>    <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/collections.GetCollectionsHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetCollectionsHttpResponse</a><span class="tsd-signature-symbol">&gt;</span></div><div class="tsd-comment tsd-typography"><p>Retrieves the collections that the user has access to. This endpoint does not return the user's favorites collection, which can be retrieved with <code>/v1/collections/favorites</code>.</p>
79
- </div><div class="tsd-type-declaration"><h4>Type Declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">query</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span><br/>        <span class="tsd-kind-property">creatorId</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/>        <span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/>        <span class="tsd-kind-property">includeItems</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/>        <span class="tsd-kind-property">limit</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/>        <span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/>        <span class="tsd-kind-property">next</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/>        <span class="tsd-kind-property">prev</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/>        <span class="tsd-kind-property">query</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/>        <span class="tsd-kind-property">sort</span><span class="tsd-signature-symbol">?:</span><br/>            <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;-name&quot;</span><br/>            <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;+name&quot;</span><br/>            <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;+createdAt&quot;</span><br/>            <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;-createdAt&quot;</span><br/>            <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;+updatedAt&quot;</span><br/>            <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;-updatedAt&quot;</span><span class="tsd-signature-symbol">;</span><br/>        <span class="tsd-kind-property">type</span><span class="tsd-signature-symbol">?:</span> <a href="../types/collections.CollectionTypes.html" class="tsd-signature-type tsd-kind-type-alias">CollectionTypes</a><span class="tsd-signature-symbol">;</span><br/>        <span class="tsd-kind-property">types</span><span class="tsd-signature-symbol">?:</span> <a href="../types/collections.CollectionTypes.html" class="tsd-signature-type tsd-kind-type-alias">CollectionTypes</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/>    <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/collections.GetCollectionsHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetCollectionsHttpResponse</a><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Retrieves the collections that the user has access to. This endpoint does not return the user's favorites collection, which can be retrieved with <code>/v1/collections/favorites</code>.</p>
80
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">query</span>: <span class="tsd-signature-symbol">{</span><br/>    <span class="tsd-kind-property">creatorId</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/>    <span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/>    <span class="tsd-kind-property">includeItems</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/>    <span class="tsd-kind-property">limit</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/>    <span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/>    <span class="tsd-kind-property">next</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/>    <span class="tsd-kind-property">prev</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/>    <span class="tsd-kind-property">query</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/>    <span class="tsd-kind-property">sort</span><span class="tsd-signature-symbol">?:</span><br/>        <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;-name&quot;</span><br/>        <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;+name&quot;</span><br/>        <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;+createdAt&quot;</span><br/>        <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;-createdAt&quot;</span><br/>        <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;+updatedAt&quot;</span><br/>        <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;-updatedAt&quot;</span><span class="tsd-signature-symbol">;</span><br/>    <span class="tsd-kind-property">type</span><span class="tsd-signature-symbol">?:</span> <a href="../types/collections.CollectionTypes.html" class="tsd-signature-type tsd-kind-type-alias">CollectionTypes</a><span class="tsd-signature-symbol">;</span><br/>    <span class="tsd-kind-property">types</span><span class="tsd-signature-symbol">?:</span> <a href="../types/collections.CollectionTypes.html" class="tsd-signature-type tsd-kind-type-alias">CollectionTypes</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></span><div class="tsd-comment tsd-typography"><p>an object with query parameters</p>
81
- </div><ul class="tsd-parameters"><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">creatorId</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>The case-sensitive string used to search for a resource by creatorId.</p>
82
- </div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>The collection's unique identifier.</p>
83
- </div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">includeItems</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>Includes the list of items belonging to the collections. Supported parameters are 'limit', 'sort' and 'resourceType'. Supported formats are json formatted string or deep object style using square brackets.</p>
84
- </div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">limit</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><p>The maximum number of resources to return for a request. The limit must be an integer between 1 and 100 (inclusive).</p>
85
- </div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>The case-sensitive string used to search for a collection by name.</p>
86
- </div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">next</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>The cursor to the next page of resources. Provide either the
87
- next or prev cursor, but not both.</p>
88
- </div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">prev</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>The cursor to the previous page of resources. Provide either the next or prev cursor, but not both.</p>
89
- </div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">query</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>The case-insensitive string used to search for a resource by name or description.</p>
90
- </div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">sort</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">&quot;-name&quot;</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;+name&quot;</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;+createdAt&quot;</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;-createdAt&quot;</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;+updatedAt&quot;</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;-updatedAt&quot;</span></h5><div class="tsd-comment tsd-typography"><p>The property of a resource to sort on (default sort is +createdAt).
91
- The supported properties are createdAt, updatedAt, and name. A property
92
- must be prefixed by + or - to indicate ascending or descending sort order
93
- respectively.</p>
94
- </div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">type</span><span class="tsd-signature-symbol">?: </span><a href="../types/collections.CollectionTypes.html" class="tsd-signature-type tsd-kind-type-alias">CollectionTypes</a></h5><div class="tsd-comment tsd-typography"><p>The case-sensitive string used to filter for a collection by type. Retrieve private collections with <code>private</code>, public collections with <code>publicgoverned</code>, and tags with <code>public</code>.</p>
95
- </div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">types</span><span class="tsd-signature-symbol">?: </span><a href="../types/collections.CollectionTypes.html" class="tsd-signature-type tsd-kind-type-alias">CollectionTypes</a><span class="tsd-signature-symbol">[]</span></h5><div class="tsd-comment tsd-typography"><p>A comma-separated case-sensitive string used to filter by multiple types.</p>
96
- </div></li></ul></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/collections.GetCollectionsHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetCollectionsHttpResponse</a><span class="tsd-signature-symbol">&gt;</span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-14">Throws<a href="#throws-14" 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>GetCollectionsHttpError</p>
97
- </div></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-query-1">Param: query<a href="#param-query-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>an object with query parameters</p>
98
- </div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-15">Throws<a href="#throws-15" 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>GetCollectionsHttpError</p>
99
- </div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getfavoritescollection"><span>get<wbr/>Favorites<wbr/>Collection</span><a href="#getfavoritescollection" 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">getFavoritesCollection</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/collections.GetFavoritesCollectionHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetFavoritesCollectionHttpResponse</a><span class="tsd-signature-symbol">&gt;</span></div><div class="tsd-comment tsd-typography"><p>Lists the user's favorites collection.</p>
100
- </div><div class="tsd-type-declaration"><h4>Type Declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/collections.GetFavoritesCollectionHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetFavoritesCollectionHttpResponse</a><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Lists the user's favorites collection.</p>
101
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/collections.GetFavoritesCollectionHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetFavoritesCollectionHttpResponse</a><span class="tsd-signature-symbol">&gt;</span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-16">Throws<a href="#throws-16" 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>GetFavoritesCollectionHttpError</p>
102
- </div></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-17">Throws<a href="#throws-17" 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>GetFavoritesCollectionHttpError</p>
103
- </div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="patchcollection"><span>patch<wbr/>Collection</span><a href="#patchcollection" 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">patchCollection</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">collectionId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">body</span><span class="tsd-signature-symbol">:</span> <a href="../types/collections.CollectionByIdPatch.html" class="tsd-signature-type tsd-kind-type-alias">CollectionByIdPatch</a><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/collections.PatchCollectionHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">PatchCollectionHttpResponse</a><span class="tsd-signature-symbol">&gt;</span></div><div class="tsd-comment tsd-typography"><p>Updates the name, description, or type fields provided in the patch body. Can be used to publish a <code>private</code> collection as a <code>publicgoverned</code> collection by patching <code>/type</code> with <code>publicgoverned</code> once the collection contains at least 1 item. Can also be used to return a <code>publicgoverned</code> collection to <code>private</code>. Cannot be used to change between <code>public</code> (tag) and <code>private / publicgoverned</code> (collection).</p>
104
- </div><div class="tsd-type-declaration"><h4>Type Declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">collectionId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">body</span><span class="tsd-signature-symbol">:</span> <a href="../types/collections.CollectionByIdPatch.html" class="tsd-signature-type tsd-kind-type-alias">CollectionByIdPatch</a><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/collections.PatchCollectionHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">PatchCollectionHttpResponse</a><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Updates the name, description, or type fields provided in the patch body. Can be used to publish a <code>private</code> collection as a <code>publicgoverned</code> collection by patching <code>/type</code> with <code>publicgoverned</code> once the collection contains at least 1 item. Can also be used to return a <code>publicgoverned</code> collection to <code>private</code>. Cannot be used to change between <code>public</code> (tag) and <code>private / publicgoverned</code> (collection).</p>
105
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">collectionId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The collection's unique identifier.</p>
106
- </div></li><li><span><span class="tsd-kind-parameter">body</span>: <a href="../types/collections.CollectionByIdPatch.html" class="tsd-signature-type tsd-kind-type-alias">CollectionByIdPatch</a></span><div class="tsd-comment tsd-typography"><p>an object with the body content</p>
107
- </div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/collections.PatchCollectionHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">PatchCollectionHttpResponse</a><span class="tsd-signature-symbol">&gt;</span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-18">Throws<a href="#throws-18" 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>PatchCollectionHttpError</p>
108
- </div></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-collectionid-6">Param: collectionId<a href="#param-collectionid-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>The collection's unique identifier.</p>
109
- </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>
110
- </div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-19">Throws<a href="#throws-19" 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>PatchCollectionHttpError</p>
111
- </div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="updatecollection"><span>update<wbr/>Collection</span><a href="#updatecollection" 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">updateCollection</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">collectionId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">body</span><span class="tsd-signature-symbol">:</span> <a href="../types/collections.CollectionsUpdateCollectionRequestBody.html" class="tsd-signature-type tsd-kind-type-alias">CollectionsUpdateCollectionRequestBody</a><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/collections.UpdateCollectionHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">UpdateCollectionHttpResponse</a><span class="tsd-signature-symbol">&gt;</span></div><div class="tsd-comment tsd-typography"><p>Updates a collection's name and description and returns the updated collection. Omitted and unsupported fields are ignored. To unset a field, provide the field's zero value.</p>
112
- </div><div class="tsd-type-declaration"><h4>Type Declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">collectionId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">body</span><span class="tsd-signature-symbol">:</span> <a href="../types/collections.CollectionsUpdateCollectionRequestBody.html" class="tsd-signature-type tsd-kind-type-alias">CollectionsUpdateCollectionRequestBody</a><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/collections.UpdateCollectionHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">UpdateCollectionHttpResponse</a><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Updates a collection's name and description and returns the updated collection. Omitted and unsupported fields are ignored. To unset a field, provide the field's zero value.</p>
113
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">collectionId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The collection's unique identifier.</p>
114
- </div></li><li><span><span class="tsd-kind-parameter">body</span>: <a href="../types/collections.CollectionsUpdateCollectionRequestBody.html" class="tsd-signature-type tsd-kind-type-alias">CollectionsUpdateCollectionRequestBody</a></span><div class="tsd-comment tsd-typography"><p>an object with the body content</p>
115
- </div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/collections.UpdateCollectionHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">UpdateCollectionHttpResponse</a><span class="tsd-signature-symbol">&gt;</span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-20">Throws<a href="#throws-20" 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>UpdateCollectionHttpError</p>
116
- </div></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-collectionid-7">Param: collectionId<a href="#param-collectionid-7" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>The collection's unique identifier.</p>
117
- </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>
118
- </div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-21">Throws<a href="#throws-21" 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>UpdateCollectionHttpError</p>
119
- </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="#addcollectionitem"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>add<wbr/>Collection<wbr/>Item</span></a><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="#createcollection"><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/>Collection</span></a><a href="#deletecollection"><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/>Collection</span></a><a href="#deletecollectionitem"><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/>Collection<wbr/>Item</span></a><a href="#getcollection"><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/>Collection</span></a><a href="#getcollectionitem"><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/>Collection<wbr/>Item</span></a><a href="#getcollectionitems"><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/>Collection<wbr/>Items</span></a><a href="#getcollections"><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/>Collections</span></a><a href="#getfavoritescollection"><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/>Favorites<wbr/>Collection</span></a><a href="#patchcollection"><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/>Collection</span></a><a href="#updatecollection"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>update<wbr/>Collection</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>