@qlik/api 1.42.0 → 1.44.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 (474) hide show
  1. package/api-keys.d.ts +2 -2
  2. package/api-keys.js +3 -3
  3. package/apps.d.ts +2 -2
  4. package/apps.js +3 -3
  5. package/assistants.d.ts +2 -2
  6. package/assistants.js +3 -3
  7. package/audits.d.ts +3 -3
  8. package/audits.js +17 -4
  9. package/auth-types.d.ts +1 -1
  10. package/auth.d.ts +2 -2
  11. package/auth.js +2 -2
  12. package/automation-connections.d.ts +2 -2
  13. package/automation-connections.js +3 -3
  14. package/automations.d.ts +3 -3
  15. package/automations.js +3 -3
  16. package/automl-deployments.d.ts +2 -2
  17. package/automl-deployments.js +5 -3
  18. package/automl-predictions.d.ts +2 -2
  19. package/automl-predictions.js +15 -3
  20. package/brands.d.ts +2 -2
  21. package/brands.js +3 -3
  22. package/chunks/{api-keys-CI44OuNR.d.ts → api-keys-C-ZqA-wl.d.ts} +1 -1
  23. package/chunks/{apps-BiGof9WJ.d.ts → apps-k7oY1h_6.d.ts} +2 -1
  24. package/chunks/{assistants-CDtI99Yr.d.ts → assistants-BsDbpzl4.d.ts} +7 -1
  25. package/chunks/{audits-C-UDFprK.d.ts → audits-5CBpwcdx.d.ts} +24 -2
  26. package/chunks/{auth-Cl-o3AnG.js → auth-CCj082fh.js} +3 -3
  27. package/chunks/{auth-B5Hx9GeQ.d.ts → auth-DFOXWfqh.d.ts} +3 -3
  28. package/chunks/{auth-DD2ENDUe.js → auth-DM5ilf4I.js} +2 -2
  29. package/chunks/{auth-functions-DHRxWU6t.js → auth-functions-CZbgZARw.js} +72 -24
  30. package/chunks/{auth-types-BlCWK0FP.d.ts → auth-types-B1c_1Nca.d.ts} +4 -1
  31. package/chunks/{automation-connections-keN9CuNO.d.ts → automation-connections-DRQDgw7Q.d.ts} +1 -1
  32. package/chunks/{automations-CFRnQ8sX.d.ts → automations-DQ-dYRFS.d.ts} +13 -4
  33. package/chunks/{automl-deployments-D05clUGa.d.ts → automl-deployments-B-WuR_zE.d.ts} +5 -1
  34. package/chunks/{automl-predictions-Ddp6PdpE.d.ts → automl-predictions-CewW0eZn.d.ts} +25 -1
  35. package/chunks/{brands-hEcnkdfg.d.ts → brands-C4eALPrs.d.ts} +1 -1
  36. package/chunks/{collections-CuX8Cp8Z.d.ts → collections-Djmd9gof.d.ts} +1 -1
  37. package/chunks/{conditions-DUmPB4Ej.d.ts → conditions-BRDxUbgu.d.ts} +1 -1
  38. package/chunks/{consumption-CSptDhk9.d.ts → consumption-UNw8R7jN.d.ts} +1 -1
  39. package/chunks/{csp-origins-v_UyOSK9.d.ts → csp-origins-_4HBSdgU.d.ts} +1 -1
  40. package/chunks/{csrf-token-DZK6GX6Z.d.ts → csrf-token-CsvbqXyY.d.ts} +1 -1
  41. package/chunks/{data-alerts-DwPcCvHP.d.ts → data-alerts-DSV3VOnW.d.ts} +1 -1
  42. package/chunks/{data-assets-BPMOGSO7.d.ts → data-assets-C3U3T_lj.d.ts} +1 -1
  43. package/chunks/{data-connections-DK1AhSi4.d.ts → data-connections-BYNfX1Fl.d.ts} +1 -1
  44. package/chunks/{data-credentials-BDCHbRwM.d.ts → data-credentials-CgCjw_Cn.d.ts} +1 -1
  45. package/chunks/{data-files-D7mlQnrw.d.ts → data-files-DH19MfYE.d.ts} +1 -1
  46. package/chunks/{data-qualities-Z554f_p6.d.ts → data-qualities-BogHQw4I.d.ts} +1 -1
  47. package/chunks/{data-sets-AcCLu1zw.d.ts → data-sets-B27GmshO.d.ts} +1 -1
  48. package/chunks/{data-sources-hfHV7WaV.d.ts → data-sources-D_TRdWV-.d.ts} +1 -1
  49. package/chunks/{data-stores-Bofu7fl5.d.ts → data-stores-BjfzMp9W.d.ts} +1 -1
  50. package/chunks/{dcaas-DK4f7Rrs.d.ts → dcaas-A7hfpAI5.d.ts} +1 -1
  51. package/chunks/{di-projects-DYJgDVfh.d.ts → di-projects-mdshgyFv.d.ts} +69 -13
  52. package/chunks/{direct-access-agents-Pmhjq2z5.d.ts → direct-access-agents-CfUpbi73.d.ts} +1 -1
  53. package/chunks/dist-B_RLj4Dy.js +58 -0
  54. package/chunks/{encryption-CMJWtMcm.d.ts → encryption-CjBmNQDZ.d.ts} +1 -1
  55. package/chunks/{extensions-Ct2JAsbk.d.ts → extensions-D05y2FWk.d.ts} +1 -1
  56. package/chunks/{glossaries-Drx-EwiU.d.ts → glossaries-vYbykU3r.d.ts} +1 -1
  57. package/chunks/{groups-C-R5oUEa.d.ts → groups-BapgngJf.d.ts} +1 -1
  58. package/chunks/{identity-providers-Bj88evsO.d.ts → identity-providers-CAxsp9hP.d.ts} +1 -1
  59. package/chunks/{interceptors-e6hoYE8W.d.ts → interceptors-BF556LaK.d.ts} +1 -1
  60. package/chunks/{interceptors-DD0vKL8_.js → interceptors-DBoV6UkN.js} +1 -1
  61. package/chunks/{invoke-fetch-DbVuX5mE.js → invoke-fetch-DuiAX21K.js} +3 -3
  62. package/chunks/{invoke-fetch-BIh4VnG4.js → invoke-fetch-fXOUPARi.js} +3 -3
  63. package/chunks/{items-BnN6gI0J.d.ts → items-CjVrNg57.d.ts} +1 -1
  64. package/chunks/{knowledgebases-tmPZVD6i.d.ts → knowledgebases-BFiV7Fwh.d.ts} +1 -1
  65. package/chunks/{licenses-DAPVQuFJ.d.ts → licenses-yZKgQ2k6.d.ts} +1 -1
  66. package/chunks/{lineage-graphs-Q4LiGGtL.d.ts → lineage-graphs-Bkc04N-t.d.ts} +1 -1
  67. package/chunks/{ml-C80TkK1J.d.ts → ml-CABYvU_L.d.ts} +8 -14
  68. package/chunks/{notes-CHvadRai.d.ts → notes-C5HjmBeI.d.ts} +1 -1
  69. package/chunks/{notifications-BhS8s4Eo.d.ts → notifications-DfP7aWPH.d.ts} +1 -1
  70. package/chunks/{oauth-clients-D1f8xiFC.d.ts → oauth-clients-BmMEDuET.d.ts} +1 -1
  71. package/chunks/{oauth-tokens-DteoDifd.d.ts → oauth-tokens-Dimf19DE.d.ts} +1 -1
  72. package/chunks/{public-runtime-modules-CNGnt1rU.js → public-runtime-modules-BDwfbach.js} +3 -3
  73. package/chunks/{qix-3nXOY2qw.js → qix-Cb4-XF7V.js} +1 -1
  74. package/chunks/{qix-DbtKisCn.js → qix-Ds6X5svJ.js} +5 -5
  75. package/chunks/{qix-chunk-entrypoint-xeI9UjuJ.js → qix-chunk-entrypoint-CpkRq84_.js} +426 -89
  76. package/chunks/{qix-T3MHM_Lb.d.ts → qix-hgcIF2oL.d.ts} +2 -2
  77. package/chunks/{questions-BiR5-mZ4.d.ts → questions-CFN7BgWt.d.ts} +1 -1
  78. package/chunks/{quotas-GTQL9uPt.d.ts → quotas-BUH2e2K_.d.ts} +1 -1
  79. package/chunks/{reload-tasks-CmXJp5va.d.ts → reload-tasks-DN3X2-30.d.ts} +1 -1
  80. package/chunks/{reloads-3XgvVnbq.d.ts → reloads-ClLQO7Vt.d.ts} +1 -1
  81. package/chunks/{report-templates-BowaTti4.d.ts → report-templates-D5KOFkRi.d.ts} +1 -1
  82. package/chunks/{reports-D-sRL947.d.ts → reports-CRwCogRL.d.ts} +85 -2
  83. package/chunks/{roles-D93ENaRt.d.ts → roles-DCzyiLdU.d.ts} +1 -1
  84. package/chunks/{sharing-tasks-BMDAjWTj.d.ts → sharing-tasks-DsxFrADQ.d.ts} +1 -1
  85. package/chunks/{spaces-DFQCYg41.d.ts → spaces-B0cx23Nc.d.ts} +1 -1
  86. package/chunks/{tasks-BWmS6L8Y.d.ts → tasks-DWfE5JM_.d.ts} +1 -1
  87. package/chunks/{temp-contents-CZVb5P0V.d.ts → temp-contents-CU94UTZU.d.ts} +1 -1
  88. package/chunks/{tenants-BDH4DmcO.d.ts → tenants-DvtbiwAP.d.ts} +1 -1
  89. package/chunks/{themes-BkubWfOE.d.ts → themes-BPkyCLWS.d.ts} +1 -1
  90. package/chunks/{transports-CO9kRJg5.d.ts → transports-DlRmSWLj.d.ts} +1 -1
  91. package/chunks/{ui-config-DIOnLEV9.d.ts → ui-config-BqX-bPjf.d.ts} +1 -1
  92. package/chunks/{users-DM-ZfzQB.d.ts → users-CuQ0nboa.d.ts} +1 -1
  93. package/chunks/{utils-qEQ6sEXX.js → utils-CAGXTaqJ.js} +14 -1
  94. package/chunks/{web-integrations-BjVMC88M.d.ts → web-integrations-D54LCd0Z.d.ts} +1 -1
  95. package/chunks/{web-notifications-D-eA8h1I.d.ts → web-notifications-sUlHGnmy.d.ts} +1 -1
  96. package/chunks/{webhooks-Dytyr5nk.d.ts → webhooks-Dw0FIeFq.d.ts} +1 -1
  97. package/collections.d.ts +2 -2
  98. package/collections.js +3 -3
  99. package/conditions.d.ts +2 -2
  100. package/conditions.js +3 -3
  101. package/consumption.d.ts +2 -2
  102. package/consumption.js +3 -3
  103. package/csp-origins.d.ts +2 -2
  104. package/csp-origins.js +3 -3
  105. package/csrf-token.d.ts +2 -2
  106. package/csrf-token.js +3 -3
  107. package/data-alerts.d.ts +2 -2
  108. package/data-alerts.js +3 -3
  109. package/data-assets.d.ts +2 -2
  110. package/data-assets.js +3 -3
  111. package/data-connections.d.ts +2 -2
  112. package/data-connections.js +3 -3
  113. package/data-credentials.d.ts +2 -2
  114. package/data-credentials.js +3 -3
  115. package/data-files.d.ts +2 -2
  116. package/data-files.js +3 -3
  117. package/data-qualities.d.ts +2 -2
  118. package/data-qualities.js +3 -3
  119. package/data-sets.d.ts +2 -2
  120. package/data-sets.js +3 -3
  121. package/data-sources.d.ts +2 -2
  122. package/data-sources.js +3 -3
  123. package/data-stores.d.ts +2 -2
  124. package/data-stores.js +3 -3
  125. package/dcaas.d.ts +2 -2
  126. package/dcaas.js +3 -3
  127. package/di-projects.d.ts +3 -3
  128. package/di-projects.js +4 -4
  129. package/direct-access-agents.d.ts +2 -2
  130. package/direct-access-agents.js +3 -3
  131. package/docs/authentication.md +65 -1
  132. package/docs/rest.md +1 -1
  133. package/encryption.d.ts +2 -2
  134. package/encryption.js +3 -3
  135. package/extensions.d.ts +2 -2
  136. package/extensions.js +3 -3
  137. package/global-types.d.ts +1 -1
  138. package/glossaries.d.ts +2 -2
  139. package/glossaries.js +3 -3
  140. package/groups.d.ts +2 -2
  141. package/groups.js +3 -3
  142. package/identity-providers.d.ts +2 -2
  143. package/identity-providers.js +3 -3
  144. package/index.d.ts +63 -63
  145. package/index.js +73 -69
  146. package/interceptors.d.ts +2 -2
  147. package/interceptors.js +2 -2
  148. package/invoke-fetch-types.d.ts +1 -1
  149. package/items.d.ts +2 -2
  150. package/items.js +3 -3
  151. package/knowledgebases.d.ts +2 -2
  152. package/knowledgebases.js +3 -3
  153. package/licenses.d.ts +2 -2
  154. package/licenses.js +3 -3
  155. package/lineage-graphs.d.ts +2 -2
  156. package/lineage-graphs.js +3 -3
  157. package/ml.d.ts +3 -3
  158. package/ml.js +4 -4
  159. package/notes.d.ts +2 -2
  160. package/notes.js +3 -3
  161. package/notifications.d.ts +2 -2
  162. package/notifications.js +3 -3
  163. package/oauth-clients.d.ts +2 -2
  164. package/oauth-clients.js +3 -3
  165. package/oauth-tokens.d.ts +2 -2
  166. package/oauth-tokens.js +3 -3
  167. package/package.json +2 -2
  168. package/qix.d.ts +3 -3
  169. package/qix.js +2 -2
  170. package/questions.d.ts +2 -2
  171. package/questions.js +3 -3
  172. package/quotas.d.ts +2 -2
  173. package/quotas.js +3 -3
  174. package/reload-tasks.d.ts +2 -2
  175. package/reload-tasks.js +3 -3
  176. package/reloads.d.ts +2 -2
  177. package/reloads.js +3 -3
  178. package/report-templates.d.ts +2 -2
  179. package/report-templates.js +3 -3
  180. package/reports.d.ts +3 -3
  181. package/reports.js +22 -4
  182. package/roles.d.ts +2 -2
  183. package/roles.js +3 -3
  184. package/sharing-tasks.d.ts +2 -2
  185. package/sharing-tasks.js +3 -3
  186. package/spaces.d.ts +2 -2
  187. package/spaces.js +3 -3
  188. package/tasks.d.ts +2 -2
  189. package/tasks.js +3 -3
  190. package/temp-contents.d.ts +2 -2
  191. package/temp-contents.js +3 -3
  192. package/tenants.d.ts +2 -2
  193. package/tenants.js +3 -3
  194. package/themes.d.ts +2 -2
  195. package/themes.js +3 -3
  196. package/transports.d.ts +2 -2
  197. package/transports.js +3 -3
  198. package/ui-config.d.ts +2 -2
  199. package/ui-config.js +3 -3
  200. package/users.d.ts +2 -2
  201. package/users.js +3 -3
  202. package/web-integrations.d.ts +2 -2
  203. package/web-integrations.js +3 -3
  204. package/web-notifications.d.ts +2 -2
  205. package/web-notifications.js +3 -3
  206. package/webhooks.d.ts +2 -2
  207. package/webhooks.js +3 -3
  208. package/website/assets/navigation.js +1 -1
  209. package/website/assets/search.js +1 -1
  210. package/website/functions/audits.fetchConsumptionAppAudits.html +3 -0
  211. package/website/functions/auth.setDefaultHostConfig.html +1 -1
  212. package/website/functions/automations.getAutomationsUsageMetrics.html +5 -1
  213. package/website/functions/automations.updateAutomation.html +2 -2
  214. package/website/functions/automl-deployments.createAutomlDeploymentRealtimePrediction.html +3 -3
  215. package/website/functions/automl-predictions.createAutomlPredictionJob.html +3 -3
  216. package/website/functions/automl-predictions.getAutomlPredictionCoordinateShap.html +3 -3
  217. package/website/functions/automl-predictions.getAutomlPredictionNotPredictedReasons.html +3 -3
  218. package/website/functions/automl-predictions.getAutomlPredictionPredictions.html +3 -3
  219. package/website/functions/automl-predictions.getAutomlPredictionShap.html +3 -3
  220. package/website/functions/automl-predictions.getAutomlPredictionSource.html +3 -3
  221. package/website/functions/di-projects.getDiProjectDiTaskRuntimeState.html +1 -1
  222. package/website/functions/ml.getMlDeploymentAliases.html +2 -1
  223. package/website/functions/reports.getReportOutputs.html +13 -0
  224. package/website/interfaces/api-keys.ApiKeysAPI.html +8 -8
  225. package/website/interfaces/apps.AppsAPI.html +45 -45
  226. package/website/interfaces/assistants.AssistantsAPI.html +29 -29
  227. package/website/interfaces/audits.AuditsAPI.html +27 -22
  228. package/website/interfaces/auth.AuthAPI.html +7 -7
  229. package/website/interfaces/automation-connections.AutomationConnectionsAPI.html +9 -9
  230. package/website/interfaces/automations.AutomationsAPI.html +29 -25
  231. package/website/interfaces/automl-deployments.AutomlDeploymentsAPI.html +7 -7
  232. package/website/interfaces/automl-predictions.AutomlPredictionsAPI.html +37 -37
  233. package/website/interfaces/brands.BrandsAPI.html +13 -13
  234. package/website/interfaces/collections.CollectionsAPI.html +12 -12
  235. package/website/interfaces/conditions.ConditionsAPI.html +12 -12
  236. package/website/interfaces/consumption.ConsumptionAPI.html +2 -2
  237. package/website/interfaces/csp-origins.CspOriginsAPI.html +7 -7
  238. package/website/interfaces/csrf-token.CsrfTokenAPI.html +2 -2
  239. package/website/interfaces/data-alerts.DataAlertsAPI.html +17 -17
  240. package/website/interfaces/data-assets.DataAssetsAPI.html +6 -6
  241. package/website/interfaces/data-connections.DataConnectionsAPI.html +10 -10
  242. package/website/interfaces/data-credentials.DataCredentialsAPI.html +6 -6
  243. package/website/interfaces/data-files.DataFilesAPI.html +13 -13
  244. package/website/interfaces/data-qualities.DataQualitiesAPI.html +4 -4
  245. package/website/interfaces/data-sets.DataSetsAPI.html +7 -7
  246. package/website/interfaces/data-sources.DataSourcesAPI.html +4 -4
  247. package/website/interfaces/data-stores.DataStoresAPI.html +11 -11
  248. package/website/interfaces/dcaas.DcaasAPI.html +4 -4
  249. package/website/interfaces/di-projects.DiProjectsAPI.html +18 -18
  250. package/website/interfaces/direct-access-agents.DirectAccessAgentsAPI.html +13 -13
  251. package/website/interfaces/encryption.EncryptionAPI.html +11 -11
  252. package/website/interfaces/extensions.ExtensionsAPI.html +8 -8
  253. package/website/interfaces/glossaries.GlossariesAPI.html +25 -25
  254. package/website/interfaces/groups.GroupsAPI.html +9 -9
  255. package/website/interfaces/identity-providers.IdentityProvidersAPI.html +9 -9
  256. package/website/interfaces/interceptors.InterceptorsAPI.html +3 -3
  257. package/website/interfaces/items.ItemsAPI.html +9 -9
  258. package/website/interfaces/knowledgebases.KnowledgebasesAPI.html +18 -18
  259. package/website/interfaces/licenses.LicensesAPI.html +10 -10
  260. package/website/interfaces/lineage-graphs.LineageGraphsAPI.html +9 -9
  261. package/website/interfaces/ml.MlAPI.html +48 -46
  262. package/website/interfaces/notes.NotesAPI.html +3 -3
  263. package/website/interfaces/notifications.NotificationsAPI.html +2 -2
  264. package/website/interfaces/oauth-clients.OauthClientsAPI.html +12 -12
  265. package/website/interfaces/oauth-tokens.OauthTokensAPI.html +3 -3
  266. package/website/interfaces/qix.GenericObject.html +1 -1
  267. package/website/interfaces/questions.QuestionsAPI.html +3 -3
  268. package/website/interfaces/quotas.QuotasAPI.html +3 -3
  269. package/website/interfaces/reload-tasks.ReloadTasksAPI.html +6 -6
  270. package/website/interfaces/reloads.ReloadsAPI.html +5 -5
  271. package/website/interfaces/report-templates.ReportTemplatesAPI.html +8 -8
  272. package/website/interfaces/reports.ReportsAPI.html +26 -8
  273. package/website/interfaces/roles.RolesAPI.html +6 -6
  274. package/website/interfaces/sharing-tasks.SharingTasksAPI.html +14 -14
  275. package/website/interfaces/spaces.SpacesAPI.html +18 -18
  276. package/website/interfaces/tasks.TasksAPI.html +11 -11
  277. package/website/interfaces/temp-contents.TempContentsAPI.html +4 -4
  278. package/website/interfaces/tenants.TenantsAPI.html +7 -7
  279. package/website/interfaces/themes.ThemesAPI.html +8 -8
  280. package/website/interfaces/transports.TransportsAPI.html +7 -7
  281. package/website/interfaces/ui-config.UiConfigAPI.html +8 -8
  282. package/website/interfaces/users.UsersAPI.html +10 -10
  283. package/website/interfaces/web-integrations.WebIntegrationsAPI.html +6 -6
  284. package/website/interfaces/web-notifications.WebNotificationsAPI.html +7 -7
  285. package/website/interfaces/webhooks.WebhooksAPI.html +11 -11
  286. package/website/modules/audits.html +1 -1
  287. package/website/modules/automations.html +1 -1
  288. package/website/modules/automl-deployments.html +1 -1
  289. package/website/modules/automl-predictions.html +1 -1
  290. package/website/modules/di-projects.html +1 -1
  291. package/website/modules/ml.html +1 -1
  292. package/website/modules/reports.html +1 -1
  293. package/website/types/api-keys.Error.html +1 -1
  294. package/website/types/apps.Error.html +1 -1
  295. package/website/types/apps.Evaluation.html +1 -1
  296. package/website/types/apps.RecommendItems.html +1 -1
  297. package/website/types/apps.RecommendedAnalysis.html +1 -1
  298. package/website/types/apps.ScriptMetaList.html +4 -3
  299. package/website/types/assistants.Assistant.html +4 -2
  300. package/website/types/assistants.CreateAssistant.html +4 -2
  301. package/website/types/assistants.CreateAssistantWithAvatar.html +4 -2
  302. package/website/types/assistants.PromptInput.html +1 -1
  303. package/website/types/audits.EventExtensions.html +1 -1
  304. package/website/types/audits.FetchConsumptionAppAuditsHttpError.html +4 -0
  305. package/website/types/audits.FetchConsumptionAppAuditsHttpResponse.html +4 -0
  306. package/website/types/audits.GetSettingsResult.html +1 -1
  307. package/website/types/automations.AutomationDetailUpdateRequestObject.html +6 -0
  308. package/website/types/automations.CopyAutomationHttpResponse.html +1 -1
  309. package/website/types/automations.RunDetailResponseObject.html +1 -1
  310. package/website/types/automl-deployments.Error.html +1 -1
  311. package/website/types/automl-predictions.Error.html +1 -1
  312. package/website/types/collections.CollectionByIdPatch.html +1 -1
  313. package/website/types/csp-origins.CSPEntry.html +1 -1
  314. package/website/types/data-alerts.AlertingExecutionListResponse.html +1 -1
  315. package/website/types/data-alerts.AlertingTaskListResponse.html +1 -1
  316. package/website/types/data-connections.ActionDeleteRequest.html +1 -1
  317. package/website/types/data-connections.ActionUpdateRequest.html +1 -1
  318. package/website/types/data-connections.BulkResponse.html +1 -1
  319. package/website/types/data-connections.Link.html +1 -1
  320. package/website/types/data-connections.PatchRequest.html +1 -1
  321. package/website/types/data-connections.TopLevelLink.html +3 -3
  322. package/website/types/data-credentials.Link.html +1 -1
  323. package/website/types/data-credentials.PatchRequest.html +1 -1
  324. package/website/types/data-qualities.DataQualityComputationRequest.html +1 -1
  325. package/website/types/data-sources.GetDataSourceGatewaysHttpResponse.html +1 -1
  326. package/website/types/data-sources.QriDefinition.html +2 -2
  327. package/website/types/di-projects.AsyncActionDetails.html +1 -1
  328. package/website/types/di-projects.DataTaskInstanceState.html +30 -0
  329. package/website/types/di-projects.DataTaskRuntimeState.html +6 -0
  330. package/website/types/di-projects.GetDiProjectDiTaskRuntimeStateHttpResponse.html +2 -2
  331. package/website/types/encryption.KeyProvider.html +1 -1
  332. package/website/types/global-types.PerformInteractiveLoginFn.html +1 -1
  333. package/website/types/groups.AssignedRoles.html +1 -1
  334. package/website/types/groups.AssignedRolesRefIDs.html +1 -1
  335. package/website/types/groups.AssignedRolesRefNames.html +1 -1
  336. package/website/types/groups.Error.html +1 -1
  337. package/website/types/identity-providers.CreateJWTAuthPayload.html +1 -1
  338. package/website/types/identity-providers.CreateOIDCPayload.html +2 -2
  339. package/website/types/identity-providers.CreateSAMLPayload.html +2 -2
  340. package/website/types/identity-providers.Error.html +1 -1
  341. package/website/types/identity-providers.IDPOIDC.html +1 -1
  342. package/website/types/identity-providers.IDPSAML.html +1 -1
  343. package/website/types/identity-providers.IDPsStatus.html +1 -1
  344. package/website/types/identity-providers.Links.html +3 -3
  345. package/website/types/identity-providers.PendingResult.html +1 -1
  346. package/website/types/interceptors.RestInterceptor.html +1 -1
  347. package/website/types/invoke-fetch-types.DownloadableBlob.html +1 -1
  348. package/website/types/items.ItemsSettingsPatch.html +1 -1
  349. package/website/types/licenses.AssignmentsActionsAddRequest.html +1 -1
  350. package/website/types/licenses.AssignmentsActionsAddResponse.html +1 -1
  351. package/website/types/licenses.AssignmentsActionsDeleteRequest.html +1 -1
  352. package/website/types/licenses.AssignmentsActionsDeleteResponse.html +1 -1
  353. package/website/types/licenses.AssignmentsActionsUpdateRequest.html +1 -1
  354. package/website/types/licenses.AssignmentsActionsUpdateResponse.html +1 -1
  355. package/website/types/licenses.AssignmentsResponse.html +1 -1
  356. package/website/types/licenses.ConsumptionEventsResponse.html +1 -1
  357. package/website/types/licenses.ErrorResponse.html +1 -1
  358. package/website/types/licenses.LicenseOverview.html +2 -2
  359. package/website/types/lineage-graphs.ErrorResponse500.html +1 -1
  360. package/website/types/lineage-graphs.Graph.html +1 -1
  361. package/website/types/lineage-graphs.Node.html +1 -1
  362. package/website/types/ml.APIError.html +1 -1
  363. package/website/types/ml.AliasFindResponse.html +1 -1
  364. package/website/types/ml.AliasGetResponse.html +1 -1
  365. package/website/types/ml.AliasPostResponse.html +1 -1
  366. package/website/types/ml.BatchPredictionActionResponse.html +1 -1
  367. package/website/types/ml.BatchPredictionFindResponse.html +1 -1
  368. package/website/types/ml.BatchPredictionGetResponse.html +1 -1
  369. package/website/types/ml.BatchPredictionPatch.html +1 -1
  370. package/website/types/ml.BatchPredictionPostResponse.html +1 -1
  371. package/website/types/ml.BatchPredictionScheduleGetResponse.html +1 -1
  372. package/website/types/ml.BatchPredictionScheduleInput.html +1 -1
  373. package/website/types/ml.BatchPredictionSchedulePatch.html +1 -1
  374. package/website/types/ml.BatchPredictionSchedulePutResponse.html +1 -1
  375. package/website/types/ml.DeploymentFindResponse.html +1 -1
  376. package/website/types/ml.DeploymentGetResponse.html +1 -1
  377. package/website/types/ml.DeploymentPatch.html +1 -1
  378. package/website/types/ml.DeploymentPostResponse.html +1 -1
  379. package/website/types/ml.ExperimentFindResponse.html +1 -1
  380. package/website/types/ml.ExperimentGetResponse.html +1 -1
  381. package/website/types/ml.ExperimentInput.html +1 -1
  382. package/website/types/ml.ExperimentModelRecommendationPostResponse.html +1 -1
  383. package/website/types/ml.ExperimentPostResponse.html +1 -1
  384. package/website/types/ml.ExperimentType.html +1 -1
  385. package/website/types/ml.ExperimentVersionFindResponse.html +1 -1
  386. package/website/types/ml.ExperimentVersionGetResponse.html +1 -1
  387. package/website/types/ml.ExperimentVersionPatch.html +1 -1
  388. package/website/types/ml.ExperimentVersionPostResponse.html +1 -1
  389. package/website/types/ml.Insights.html +1 -1
  390. package/website/types/ml.ModelAlgorithm.html +1 -1
  391. package/website/types/ml.ModelAlgorithmAbbreviation.html +1 -1
  392. package/website/types/ml.ModelFindResponse.html +1 -1
  393. package/website/types/ml.ModelGetResponse.html +1 -1
  394. package/website/types/ml.Pipeline.html +2 -3
  395. package/website/types/ml.ProfileInsights.html +1 -1
  396. package/website/types/ml.ProfileInsightsGetResponse.html +1 -1
  397. package/website/types/ml.ProfileInsightsInput.html +1 -1
  398. package/website/types/ml.ResponseLinks.html +5 -5
  399. package/website/types/notifications.NotificationItem.html +1 -1
  400. package/website/types/oauth-clients.ClientSecrets.html +1 -1
  401. package/website/types/oauth-clients.OAuthClientAdminListItem.html +1 -1
  402. package/website/types/oauth-clients.OAuthClientAdminReadResponse.html +1 -1
  403. package/website/types/oauth-clients.OAuthClientCreateRequest.html +1 -1
  404. package/website/types/oauth-clients.OAuthClientCreateResponse.html +1 -1
  405. package/website/types/oauth-clients.OAuthClientReadResponse.html +1 -1
  406. package/website/types/qix.DocAction.html +1 -1
  407. package/website/types/qix.NativeGenericObjectFunctions.html +1 -1
  408. package/website/types/qix.RpcObject.html +1 -1
  409. package/website/types/qix.UndoInfoObject.html +1 -1
  410. package/website/types/qix.UseAppHook.html +1 -1
  411. package/website/types/questions.Error.html +1 -1
  412. package/website/types/questions.NLMetricsResponse.html +1 -1
  413. package/website/types/quotas.Quota.html +1 -1
  414. package/website/types/reload-tasks.PostTaskBody.html +1 -1
  415. package/website/types/reload-tasks.PutTaskBody.html +1 -1
  416. package/website/types/reload-tasks.Task.html +1 -1
  417. package/website/types/reports.GetReportOutputsHttpError.html +4 -0
  418. package/website/types/reports.GetReportOutputsHttpResponse.html +6 -0
  419. package/website/types/reports.LinkResponse.html +2 -0
  420. package/website/types/reports.LinksResponse.html +7 -0
  421. package/website/types/reports.OutputList.html +4 -0
  422. package/website/types/reports.OutputListItem.html +13 -0
  423. package/website/types/reports.PdfOutput.html +1 -1
  424. package/website/types/roles.Error.html +1 -1
  425. package/website/types/sharing-tasks.SharingExecutionListResponse.html +1 -1
  426. package/website/types/sharing-tasks.SharingTaskRecurringListResponse.html +1 -1
  427. package/website/types/sharing-tasks.SharingTaskRecurringResponse.html +1 -1
  428. package/website/types/spaces.Assignments.html +1 -1
  429. package/website/types/spaces.Error.html +1 -1
  430. package/website/types/spaces.Errors.html +1 -1
  431. package/website/types/spaces.SharePatch.html +1 -1
  432. package/website/types/spaces.Shares.html +1 -1
  433. package/website/types/spaces.Space.html +1 -1
  434. package/website/types/spaces.SpacePatch.html +1 -1
  435. package/website/types/spaces.Spaces.html +1 -1
  436. package/website/types/tasks.Action.html +1 -1
  437. package/website/types/tasks.Crondef.html +1 -1
  438. package/website/types/tasks.Eventstate.html +1 -1
  439. package/website/types/tasks.Functionref.html +1 -1
  440. package/website/types/tasks.GetTaskRunLogHttpResponse.html +1 -1
  441. package/website/types/tasks.Schedule.html +1 -1
  442. package/website/types/temp-contents.Error.html +1 -1
  443. package/website/types/tenants.Error.html +1 -1
  444. package/website/types/tenants.Tenant.html +1 -1
  445. package/website/types/tenants.TenantPatchErrors.html +1 -1
  446. package/website/types/tenants.TenantPatchSchema.html +1 -1
  447. package/website/types/transports.DeleteConfigNotFoundError.html +1 -1
  448. package/website/types/transports.SendTestMailConfigNotFoundError.html +1 -1
  449. package/website/types/transports.TenantAdminError.html +1 -1
  450. package/website/types/transports.UpdateEmailConfigError.html +1 -1
  451. package/website/types/transports.VerifyConnectionConfigNotFoundError.html +1 -1
  452. package/website/types/ui-config.JSONPatchPinnedLinkPayload.html +1 -1
  453. package/website/types/users.AssignedGroups.html +1 -1
  454. package/website/types/users.AssignedGroupsRefNames.html +1 -1
  455. package/website/types/users.AssignedRoles.html +1 -1
  456. package/website/types/users.Error.html +1 -1
  457. package/website/types/users.InviteErrorItem.html +1 -1
  458. package/website/types/users.RefIDs.html +1 -1
  459. package/website/types/users.RefNames.html +1 -1
  460. package/website/types/users.User.html +1 -1
  461. package/website/types/users.Users.html +1 -1
  462. package/website/types/web-integrations.Error.html +1 -1
  463. package/website/types/web-integrations.WebIntegrationPost.html +1 -1
  464. package/website/types/web-integrations.WebIntegrations.html +1 -1
  465. package/website/types/webhooks.Delivery.html +2 -2
  466. package/website/types/webhooks.WebhookPost.html +1 -1
  467. package/website/types/webhooks.WebhookResponse.html +1 -1
  468. package/website/variables/index.auth.html +1 -1
  469. package/website/variables/index.createQlikApi.html +1 -1
  470. package/website/variables/qix.QIX_SCHEMA_VERSION.html +1 -1
  471. package/chunks/dist-CjqdvDf3.js +0 -52
  472. package/website/types/di-projects.DataTaskInstanceStateOld.html +0 -3
  473. package/website/types/ml.ConfigurationKey.html +0 -1
  474. package/website/types/ml.DataSchemaConfiguration.html +0 -3
package/website/interfaces/collections.CollectionsAPI.html CHANGED
@@ -11,7 +11,7 @@
11
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
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
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>
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
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
16
  </div><div class="tsd-comment tsd-typography"></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
17
  </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/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>
@@ -19,21 +19,21 @@
19
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
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
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>
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
23
  </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="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>
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
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
26
  </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/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
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
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
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>
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
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
32
  </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/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
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
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
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>
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
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
38
  </div><div class="tsd-comment tsd-typography"></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
39
  </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/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>
@@ -41,13 +41,13 @@
41
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
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
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>
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
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
46
  </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/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
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
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
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>
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
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
52
  </div><div class="tsd-comment tsd-typography"></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
53
  </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/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>
@@ -55,7 +55,7 @@
55
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
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
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>
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
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
60
  </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">query</span>: <span class="tsd-signature-symbol">{</span><br/>    <span class="tsd-kind-property">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
61
  </div><div class="tsd-comment tsd-typography"></div><ul class="tsd-parameters"><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">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>
@@ -76,7 +76,7 @@
76
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
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
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>
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
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
81
  </div><div class="tsd-comment tsd-typography"></div><ul class="tsd-parameters"><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">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
82
  </div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">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>
@@ -97,11 +97,11 @@ respectively.</p>
97
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
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
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>
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
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
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
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>
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
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
106
  </div><div class="tsd-comment tsd-typography"></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
107
  </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/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>
@@ -109,7 +109,7 @@ respectively.</p>
109
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
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
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>
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
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
114
  </div><div class="tsd-comment tsd-typography"></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
115
  </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/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>