@openfilz-sdk/typescript-ee 1.3.5

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 (507) hide show
  1. package/.openapi-generator/FILES +167 -0
  2. package/.openapi-generator/VERSION +1 -0
  3. package/.openapi-generator/openfilz-api-generate-typescript-sdk.sha256 +1 -0
  4. package/.openapi-generator-ignore +23 -0
  5. package/LICENSE +148 -0
  6. package/README.md +211 -0
  7. package/api/audit-controller-api.ts +283 -0
  8. package/api/collaboration-controller-api.ts +1172 -0
  9. package/api/comments-api.ts +284 -0
  10. package/api/dashboard-api.ts +121 -0
  11. package/api/document-controller-api.ts +1287 -0
  12. package/api/document-suggestion-controller-api.ts +149 -0
  13. package/api/favorites-api.ts +340 -0
  14. package/api/file-controller-api.ts +363 -0
  15. package/api/folder-controller-api.ts +605 -0
  16. package/api/notifications-api.ts +386 -0
  17. package/api/scan-agent-api.ts +206 -0
  18. package/api/scanner-proxy-api.ts +428 -0
  19. package/api/search-administration-api.ts +314 -0
  20. package/api/settings-api.ts +196 -0
  21. package/api/tus-controller-api.ts +738 -0
  22. package/api.ts +32 -0
  23. package/base.ts +62 -0
  24. package/common.ts +127 -0
  25. package/configuration.ts +121 -0
  26. package/dist/api/audit-controller-api.d.ts +138 -0
  27. package/dist/api/audit-controller-api.js +275 -0
  28. package/dist/api/collaboration-controller-api.d.ts +534 -0
  29. package/dist/api/collaboration-controller-api.js +1120 -0
  30. package/dist/api/comments-api.d.ts +137 -0
  31. package/dist/api/comments-api.js +278 -0
  32. package/dist/api/dashboard-api.d.ts +63 -0
  33. package/dist/api/dashboard-api.js +125 -0
  34. package/dist/api/document-controller-api.d.ts +594 -0
  35. package/dist/api/document-controller-api.js +1219 -0
  36. package/dist/api/document-suggestion-controller-api.d.ts +73 -0
  37. package/dist/api/document-suggestion-controller-api.js +146 -0
  38. package/dist/api/favorites-api.d.ts +162 -0
  39. package/dist/api/favorites-api.js +337 -0
  40. package/dist/api/file-controller-api.d.ts +172 -0
  41. package/dist/api/file-controller-api.js +348 -0
  42. package/dist/api/folder-controller-api.d.ts +282 -0
  43. package/dist/api/folder-controller-api.js +573 -0
  44. package/dist/api/notifications-api.d.ts +179 -0
  45. package/dist/api/notifications-api.js +378 -0
  46. package/dist/api/scan-agent-api.d.ts +108 -0
  47. package/dist/api/scan-agent-api.js +208 -0
  48. package/dist/api/scanner-proxy-api.d.ts +202 -0
  49. package/dist/api/scanner-proxy-api.js +414 -0
  50. package/dist/api/search-administration-api.d.ts +146 -0
  51. package/dist/api/search-administration-api.js +311 -0
  52. package/dist/api/settings-api.d.ts +96 -0
  53. package/dist/api/settings-api.js +195 -0
  54. package/dist/api/tus-controller-api.d.ts +338 -0
  55. package/dist/api/tus-controller-api.js +712 -0
  56. package/dist/api.d.ts +26 -0
  57. package/dist/api.js +44 -0
  58. package/dist/base.d.ts +42 -0
  59. package/dist/base.js +46 -0
  60. package/dist/common.d.ts +34 -0
  61. package/dist/common.js +139 -0
  62. package/dist/configuration.d.ts +98 -0
  63. package/dist/configuration.js +44 -0
  64. package/dist/esm/api/audit-controller-api.d.ts +138 -0
  65. package/dist/esm/api/audit-controller-api.js +268 -0
  66. package/dist/esm/api/collaboration-controller-api.d.ts +534 -0
  67. package/dist/esm/api/collaboration-controller-api.js +1113 -0
  68. package/dist/esm/api/comments-api.d.ts +137 -0
  69. package/dist/esm/api/comments-api.js +271 -0
  70. package/dist/esm/api/dashboard-api.d.ts +63 -0
  71. package/dist/esm/api/dashboard-api.js +118 -0
  72. package/dist/esm/api/document-controller-api.d.ts +594 -0
  73. package/dist/esm/api/document-controller-api.js +1212 -0
  74. package/dist/esm/api/document-suggestion-controller-api.d.ts +73 -0
  75. package/dist/esm/api/document-suggestion-controller-api.js +139 -0
  76. package/dist/esm/api/favorites-api.d.ts +162 -0
  77. package/dist/esm/api/favorites-api.js +330 -0
  78. package/dist/esm/api/file-controller-api.d.ts +172 -0
  79. package/dist/esm/api/file-controller-api.js +341 -0
  80. package/dist/esm/api/folder-controller-api.d.ts +282 -0
  81. package/dist/esm/api/folder-controller-api.js +566 -0
  82. package/dist/esm/api/notifications-api.d.ts +179 -0
  83. package/dist/esm/api/notifications-api.js +371 -0
  84. package/dist/esm/api/scan-agent-api.d.ts +108 -0
  85. package/dist/esm/api/scan-agent-api.js +201 -0
  86. package/dist/esm/api/scanner-proxy-api.d.ts +202 -0
  87. package/dist/esm/api/scanner-proxy-api.js +407 -0
  88. package/dist/esm/api/search-administration-api.d.ts +146 -0
  89. package/dist/esm/api/search-administration-api.js +304 -0
  90. package/dist/esm/api/settings-api.d.ts +96 -0
  91. package/dist/esm/api/settings-api.js +188 -0
  92. package/dist/esm/api/tus-controller-api.d.ts +338 -0
  93. package/dist/esm/api/tus-controller-api.js +705 -0
  94. package/dist/esm/api.d.ts +26 -0
  95. package/dist/esm/api.js +28 -0
  96. package/dist/esm/base.d.ts +42 -0
  97. package/dist/esm/base.js +41 -0
  98. package/dist/esm/common.d.ts +34 -0
  99. package/dist/esm/common.js +126 -0
  100. package/dist/esm/configuration.d.ts +98 -0
  101. package/dist/esm/configuration.js +40 -0
  102. package/dist/esm/index.d.ts +14 -0
  103. package/dist/esm/index.js +16 -0
  104. package/dist/esm/models/ancestor-info.d.ts +16 -0
  105. package/dist/esm/models/ancestor-info.js +14 -0
  106. package/dist/esm/models/audit-log-details-one-of.d.ts +42 -0
  107. package/dist/esm/models/audit-log-details-one-of.js +14 -0
  108. package/dist/esm/models/audit-log-details.d.ts +14 -0
  109. package/dist/esm/models/audit-log-details.js +14 -0
  110. package/dist/esm/models/audit-log.d.ts +63 -0
  111. package/dist/esm/models/audit-log.js +49 -0
  112. package/dist/esm/models/audit-verification-result.d.ts +28 -0
  113. package/dist/esm/models/audit-verification-result.js +18 -0
  114. package/dist/esm/models/broken-link.d.ts +16 -0
  115. package/dist/esm/models/broken-link.js +14 -0
  116. package/dist/esm/models/comment-dto.d.ts +22 -0
  117. package/dist/esm/models/comment-dto.js +14 -0
  118. package/dist/esm/models/copy-audit.d.ts +17 -0
  119. package/dist/esm/models/copy-audit.js +14 -0
  120. package/dist/esm/models/copy-request.d.ts +25 -0
  121. package/dist/esm/models/copy-request.js +14 -0
  122. package/dist/esm/models/copy-response.d.ts +21 -0
  123. package/dist/esm/models/copy-response.js +14 -0
  124. package/dist/esm/models/create-blank-document-request.d.ts +29 -0
  125. package/dist/esm/models/create-blank-document-request.js +19 -0
  126. package/dist/esm/models/create-comment-request.d.ts +25 -0
  127. package/dist/esm/models/create-comment-request.js +14 -0
  128. package/dist/esm/models/create-folder-audit.d.ts +17 -0
  129. package/dist/esm/models/create-folder-audit.js +14 -0
  130. package/dist/esm/models/create-folder-request.d.ts +18 -0
  131. package/dist/esm/models/create-folder-request.js +14 -0
  132. package/dist/esm/models/create-team-request.d.ts +15 -0
  133. package/dist/esm/models/create-team-request.js +14 -0
  134. package/dist/esm/models/dashboard-statistics-response.d.ts +19 -0
  135. package/dist/esm/models/dashboard-statistics-response.js +14 -0
  136. package/dist/esm/models/delete-audit.d.ts +17 -0
  137. package/dist/esm/models/delete-audit.js +14 -0
  138. package/dist/esm/models/delete-metadata-audit.d.ts +17 -0
  139. package/dist/esm/models/delete-metadata-audit.js +14 -0
  140. package/dist/esm/models/delete-metadata-request.d.ts +17 -0
  141. package/dist/esm/models/delete-metadata-request.js +14 -0
  142. package/dist/esm/models/delete-request.d.ts +17 -0
  143. package/dist/esm/models/delete-request.js +14 -0
  144. package/dist/esm/models/delete-share-request.d.ts +18 -0
  145. package/dist/esm/models/delete-share-request.js +14 -0
  146. package/dist/esm/models/document-info.d.ts +44 -0
  147. package/dist/esm/models/document-info.js +17 -0
  148. package/dist/esm/models/document-position.d.ts +17 -0
  149. package/dist/esm/models/document-position.js +14 -0
  150. package/dist/esm/models/element-info.d.ts +16 -0
  151. package/dist/esm/models/element-info.js +14 -0
  152. package/dist/esm/models/file-type-stats.d.ts +16 -0
  153. package/dist/esm/models/file-type-stats.js +14 -0
  154. package/dist/esm/models/filter-input.d.ts +15 -0
  155. package/dist/esm/models/filter-input.js +14 -0
  156. package/dist/esm/models/folder-element-info.d.ts +30 -0
  157. package/dist/esm/models/folder-element-info.js +17 -0
  158. package/dist/esm/models/folder-response.d.ts +16 -0
  159. package/dist/esm/models/folder-response.js +14 -0
  160. package/dist/esm/models/index.d.ts +62 -0
  161. package/dist/esm/models/index.js +62 -0
  162. package/dist/esm/models/ingestion-status-dto.d.ts +22 -0
  163. package/dist/esm/models/ingestion-status-dto.js +14 -0
  164. package/dist/esm/models/move-audit.d.ts +17 -0
  165. package/dist/esm/models/move-audit.js +14 -0
  166. package/dist/esm/models/move-request.d.ts +25 -0
  167. package/dist/esm/models/move-request.js +14 -0
  168. package/dist/esm/models/notification-dto.d.ts +29 -0
  169. package/dist/esm/models/notification-dto.js +19 -0
  170. package/dist/esm/models/rename-audit.d.ts +17 -0
  171. package/dist/esm/models/rename-audit.js +14 -0
  172. package/dist/esm/models/rename-request.d.ts +14 -0
  173. package/dist/esm/models/rename-request.js +14 -0
  174. package/dist/esm/models/replace-audit.d.ts +17 -0
  175. package/dist/esm/models/replace-audit.js +14 -0
  176. package/dist/esm/models/scan-job-status-dto.d.ts +20 -0
  177. package/dist/esm/models/scan-job-status-dto.js +14 -0
  178. package/dist/esm/models/scan-request-dto.d.ts +18 -0
  179. package/dist/esm/models/scan-request-dto.js +14 -0
  180. package/dist/esm/models/scanner-info-dto.d.ts +22 -0
  181. package/dist/esm/models/scanner-info-dto.js +14 -0
  182. package/dist/esm/models/search-by-audit-log-request.d.ts +76 -0
  183. package/dist/esm/models/search-by-audit-log-request.js +49 -0
  184. package/dist/esm/models/search-by-metadata-request.d.ts +43 -0
  185. package/dist/esm/models/search-by-metadata-request.js +17 -0
  186. package/dist/esm/models/search-metadata-request.d.ts +17 -0
  187. package/dist/esm/models/search-metadata-request.js +14 -0
  188. package/dist/esm/models/settings.d.ts +19 -0
  189. package/dist/esm/models/settings.js +14 -0
  190. package/dist/esm/models/share-request.d.ts +35 -0
  191. package/dist/esm/models/share-request.js +18 -0
  192. package/dist/esm/models/share-result-error.d.ts +26 -0
  193. package/dist/esm/models/share-result-error.js +22 -0
  194. package/dist/esm/models/share-result-item.d.ts +15 -0
  195. package/dist/esm/models/share-result-item.js +14 -0
  196. package/dist/esm/models/share-result-response.d.ts +18 -0
  197. package/dist/esm/models/share-result-response.js +14 -0
  198. package/dist/esm/models/sort-input.d.ts +20 -0
  199. package/dist/esm/models/sort-input.js +17 -0
  200. package/dist/esm/models/storage-breakdown.d.ts +17 -0
  201. package/dist/esm/models/storage-breakdown.js +14 -0
  202. package/dist/esm/models/suggest.d.ts +17 -0
  203. package/dist/esm/models/suggest.js +14 -0
  204. package/dist/esm/models/team-member-info.d.ts +23 -0
  205. package/dist/esm/models/team-member-info.js +18 -0
  206. package/dist/esm/models/tus-config-response.d.ts +18 -0
  207. package/dist/esm/models/tus-config-response.js +14 -0
  208. package/dist/esm/models/tus-finalize-request.d.ts +19 -0
  209. package/dist/esm/models/tus-finalize-request.js +14 -0
  210. package/dist/esm/models/tus-upload-info.d.ts +18 -0
  211. package/dist/esm/models/tus-upload-info.js +14 -0
  212. package/dist/esm/models/update-comment-request.d.ts +21 -0
  213. package/dist/esm/models/update-comment-request.js +14 -0
  214. package/dist/esm/models/update-metadata-audit.d.ts +17 -0
  215. package/dist/esm/models/update-metadata-audit.js +14 -0
  216. package/dist/esm/models/update-metadata-request.d.ts +19 -0
  217. package/dist/esm/models/update-metadata-request.js +14 -0
  218. package/dist/esm/models/update-team-request.d.ts +15 -0
  219. package/dist/esm/models/update-team-request.js +14 -0
  220. package/dist/esm/models/update-user-request.d.ts +22 -0
  221. package/dist/esm/models/update-user-request.js +18 -0
  222. package/dist/esm/models/upload-audit.d.ts +17 -0
  223. package/dist/esm/models/upload-audit.js +14 -0
  224. package/dist/esm/models/upload-response.d.ts +19 -0
  225. package/dist/esm/models/upload-response.js +14 -0
  226. package/dist/esm/models/user-preferences-request.d.ts +15 -0
  227. package/dist/esm/models/user-preferences-request.js +14 -0
  228. package/dist/esm/models/user-registration-request.d.ts +22 -0
  229. package/dist/esm/models/user-registration-request.js +18 -0
  230. package/dist/index.d.ts +14 -0
  231. package/dist/index.js +32 -0
  232. package/dist/models/ancestor-info.d.ts +16 -0
  233. package/dist/models/ancestor-info.js +15 -0
  234. package/dist/models/audit-log-details-one-of.d.ts +42 -0
  235. package/dist/models/audit-log-details-one-of.js +15 -0
  236. package/dist/models/audit-log-details.d.ts +14 -0
  237. package/dist/models/audit-log-details.js +15 -0
  238. package/dist/models/audit-log.d.ts +63 -0
  239. package/dist/models/audit-log.js +52 -0
  240. package/dist/models/audit-verification-result.d.ts +28 -0
  241. package/dist/models/audit-verification-result.js +21 -0
  242. package/dist/models/broken-link.d.ts +16 -0
  243. package/dist/models/broken-link.js +15 -0
  244. package/dist/models/comment-dto.d.ts +22 -0
  245. package/dist/models/comment-dto.js +15 -0
  246. package/dist/models/copy-audit.d.ts +17 -0
  247. package/dist/models/copy-audit.js +15 -0
  248. package/dist/models/copy-request.d.ts +25 -0
  249. package/dist/models/copy-request.js +15 -0
  250. package/dist/models/copy-response.d.ts +21 -0
  251. package/dist/models/copy-response.js +15 -0
  252. package/dist/models/create-blank-document-request.d.ts +29 -0
  253. package/dist/models/create-blank-document-request.js +22 -0
  254. package/dist/models/create-comment-request.d.ts +25 -0
  255. package/dist/models/create-comment-request.js +15 -0
  256. package/dist/models/create-folder-audit.d.ts +17 -0
  257. package/dist/models/create-folder-audit.js +15 -0
  258. package/dist/models/create-folder-request.d.ts +18 -0
  259. package/dist/models/create-folder-request.js +15 -0
  260. package/dist/models/create-team-request.d.ts +15 -0
  261. package/dist/models/create-team-request.js +15 -0
  262. package/dist/models/dashboard-statistics-response.d.ts +19 -0
  263. package/dist/models/dashboard-statistics-response.js +15 -0
  264. package/dist/models/delete-audit.d.ts +17 -0
  265. package/dist/models/delete-audit.js +15 -0
  266. package/dist/models/delete-metadata-audit.d.ts +17 -0
  267. package/dist/models/delete-metadata-audit.js +15 -0
  268. package/dist/models/delete-metadata-request.d.ts +17 -0
  269. package/dist/models/delete-metadata-request.js +15 -0
  270. package/dist/models/delete-request.d.ts +17 -0
  271. package/dist/models/delete-request.js +15 -0
  272. package/dist/models/delete-share-request.d.ts +18 -0
  273. package/dist/models/delete-share-request.js +15 -0
  274. package/dist/models/document-info.d.ts +44 -0
  275. package/dist/models/document-info.js +20 -0
  276. package/dist/models/document-position.d.ts +17 -0
  277. package/dist/models/document-position.js +15 -0
  278. package/dist/models/element-info.d.ts +16 -0
  279. package/dist/models/element-info.js +15 -0
  280. package/dist/models/file-type-stats.d.ts +16 -0
  281. package/dist/models/file-type-stats.js +15 -0
  282. package/dist/models/filter-input.d.ts +15 -0
  283. package/dist/models/filter-input.js +15 -0
  284. package/dist/models/folder-element-info.d.ts +30 -0
  285. package/dist/models/folder-element-info.js +20 -0
  286. package/dist/models/folder-response.d.ts +16 -0
  287. package/dist/models/folder-response.js +15 -0
  288. package/dist/models/index.d.ts +62 -0
  289. package/dist/models/index.js +78 -0
  290. package/dist/models/ingestion-status-dto.d.ts +22 -0
  291. package/dist/models/ingestion-status-dto.js +15 -0
  292. package/dist/models/move-audit.d.ts +17 -0
  293. package/dist/models/move-audit.js +15 -0
  294. package/dist/models/move-request.d.ts +25 -0
  295. package/dist/models/move-request.js +15 -0
  296. package/dist/models/notification-dto.d.ts +29 -0
  297. package/dist/models/notification-dto.js +22 -0
  298. package/dist/models/rename-audit.d.ts +17 -0
  299. package/dist/models/rename-audit.js +15 -0
  300. package/dist/models/rename-request.d.ts +14 -0
  301. package/dist/models/rename-request.js +15 -0
  302. package/dist/models/replace-audit.d.ts +17 -0
  303. package/dist/models/replace-audit.js +15 -0
  304. package/dist/models/scan-job-status-dto.d.ts +20 -0
  305. package/dist/models/scan-job-status-dto.js +15 -0
  306. package/dist/models/scan-request-dto.d.ts +18 -0
  307. package/dist/models/scan-request-dto.js +15 -0
  308. package/dist/models/scanner-info-dto.d.ts +22 -0
  309. package/dist/models/scanner-info-dto.js +15 -0
  310. package/dist/models/search-by-audit-log-request.d.ts +76 -0
  311. package/dist/models/search-by-audit-log-request.js +52 -0
  312. package/dist/models/search-by-metadata-request.d.ts +43 -0
  313. package/dist/models/search-by-metadata-request.js +20 -0
  314. package/dist/models/search-metadata-request.d.ts +17 -0
  315. package/dist/models/search-metadata-request.js +15 -0
  316. package/dist/models/settings.d.ts +19 -0
  317. package/dist/models/settings.js +15 -0
  318. package/dist/models/share-request.d.ts +35 -0
  319. package/dist/models/share-request.js +21 -0
  320. package/dist/models/share-result-error.d.ts +26 -0
  321. package/dist/models/share-result-error.js +25 -0
  322. package/dist/models/share-result-item.d.ts +15 -0
  323. package/dist/models/share-result-item.js +15 -0
  324. package/dist/models/share-result-response.d.ts +18 -0
  325. package/dist/models/share-result-response.js +15 -0
  326. package/dist/models/sort-input.d.ts +20 -0
  327. package/dist/models/sort-input.js +20 -0
  328. package/dist/models/storage-breakdown.d.ts +17 -0
  329. package/dist/models/storage-breakdown.js +15 -0
  330. package/dist/models/suggest.d.ts +17 -0
  331. package/dist/models/suggest.js +15 -0
  332. package/dist/models/team-member-info.d.ts +23 -0
  333. package/dist/models/team-member-info.js +21 -0
  334. package/dist/models/tus-config-response.d.ts +18 -0
  335. package/dist/models/tus-config-response.js +15 -0
  336. package/dist/models/tus-finalize-request.d.ts +19 -0
  337. package/dist/models/tus-finalize-request.js +15 -0
  338. package/dist/models/tus-upload-info.d.ts +18 -0
  339. package/dist/models/tus-upload-info.js +15 -0
  340. package/dist/models/update-comment-request.d.ts +21 -0
  341. package/dist/models/update-comment-request.js +15 -0
  342. package/dist/models/update-metadata-audit.d.ts +17 -0
  343. package/dist/models/update-metadata-audit.js +15 -0
  344. package/dist/models/update-metadata-request.d.ts +19 -0
  345. package/dist/models/update-metadata-request.js +15 -0
  346. package/dist/models/update-team-request.d.ts +15 -0
  347. package/dist/models/update-team-request.js +15 -0
  348. package/dist/models/update-user-request.d.ts +22 -0
  349. package/dist/models/update-user-request.js +21 -0
  350. package/dist/models/upload-audit.d.ts +17 -0
  351. package/dist/models/upload-audit.js +15 -0
  352. package/dist/models/upload-response.d.ts +19 -0
  353. package/dist/models/upload-response.js +15 -0
  354. package/dist/models/user-preferences-request.d.ts +15 -0
  355. package/dist/models/user-preferences-request.js +15 -0
  356. package/dist/models/user-registration-request.d.ts +22 -0
  357. package/dist/models/user-registration-request.js +21 -0
  358. package/docs/AncestorInfo.md +24 -0
  359. package/docs/AuditControllerApi.md +160 -0
  360. package/docs/AuditLog.md +35 -0
  361. package/docs/AuditLogDetails.md +20 -0
  362. package/docs/AuditLogDetailsOneOf.md +42 -0
  363. package/docs/AuditVerificationResult.md +29 -0
  364. package/docs/BrokenLink.md +24 -0
  365. package/docs/CollaborationControllerApi.md +802 -0
  366. package/docs/CommentDTO.md +36 -0
  367. package/docs/CommentsApi.md +168 -0
  368. package/docs/CopyAudit.md +25 -0
  369. package/docs/CopyRequest.md +24 -0
  370. package/docs/CopyResponse.md +22 -0
  371. package/docs/CreateBlankDocumentRequest.md +24 -0
  372. package/docs/CreateCommentRequest.md +24 -0
  373. package/docs/CreateFolderAudit.md +23 -0
  374. package/docs/CreateFolderRequest.md +22 -0
  375. package/docs/CreateTeamRequest.md +22 -0
  376. package/docs/DashboardApi.md +52 -0
  377. package/docs/DashboardStatisticsResponse.md +26 -0
  378. package/docs/DeleteAudit.md +21 -0
  379. package/docs/DeleteMetadataAudit.md +21 -0
  380. package/docs/DeleteMetadataRequest.md +20 -0
  381. package/docs/DeleteRequest.md +20 -0
  382. package/docs/DeleteShareRequest.md +22 -0
  383. package/docs/DocumentControllerApi.md +834 -0
  384. package/docs/DocumentInfo.md +30 -0
  385. package/docs/DocumentPosition.md +26 -0
  386. package/docs/DocumentSuggestionControllerApi.md +65 -0
  387. package/docs/ElementInfo.md +24 -0
  388. package/docs/FavoritesApi.md +215 -0
  389. package/docs/FileControllerApi.md +222 -0
  390. package/docs/FileTypeStats.md +24 -0
  391. package/docs/FilterInput.md +22 -0
  392. package/docs/FolderControllerApi.md +385 -0
  393. package/docs/FolderElementInfo.md +24 -0
  394. package/docs/FolderResponse.md +24 -0
  395. package/docs/IngestionStatusDto.md +36 -0
  396. package/docs/MoveAudit.md +21 -0
  397. package/docs/MoveRequest.md +24 -0
  398. package/docs/NotificationDTO.md +36 -0
  399. package/docs/NotificationsApi.md +239 -0
  400. package/docs/RenameAudit.md +21 -0
  401. package/docs/RenameRequest.md +20 -0
  402. package/docs/ReplaceAudit.md +23 -0
  403. package/docs/ScanAgentApi.md +110 -0
  404. package/docs/ScanJobStatusDto.md +32 -0
  405. package/docs/ScanRequestDto.md +28 -0
  406. package/docs/ScannerInfoDto.md +36 -0
  407. package/docs/ScannerProxyApi.md +263 -0
  408. package/docs/SearchAdministrationApi.md +187 -0
  409. package/docs/SearchByAuditLogRequest.md +29 -0
  410. package/docs/SearchByMetadataRequest.md +29 -0
  411. package/docs/SearchMetadataRequest.md +20 -0
  412. package/docs/Settings.md +30 -0
  413. package/docs/SettingsApi.md +105 -0
  414. package/docs/ShareRequest.md +26 -0
  415. package/docs/ShareResultError.md +24 -0
  416. package/docs/ShareResultItem.md +22 -0
  417. package/docs/ShareResultResponse.md +24 -0
  418. package/docs/SortInput.md +22 -0
  419. package/docs/StorageBreakdown.md +24 -0
  420. package/docs/Suggest.md +26 -0
  421. package/docs/TeamMemberInfo.md +26 -0
  422. package/docs/TusConfigResponse.md +28 -0
  423. package/docs/TusControllerApi.md +493 -0
  424. package/docs/TusFinalizeRequest.md +26 -0
  425. package/docs/TusUploadInfo.md +28 -0
  426. package/docs/UpdateCommentRequest.md +22 -0
  427. package/docs/UpdateMetadataAudit.md +21 -0
  428. package/docs/UpdateMetadataRequest.md +20 -0
  429. package/docs/UpdateTeamRequest.md +22 -0
  430. package/docs/UpdateUserRequest.md +24 -0
  431. package/docs/UploadAudit.md +25 -0
  432. package/docs/UploadResponse.md +30 -0
  433. package/docs/UserPreferencesRequest.md +22 -0
  434. package/docs/UserRegistrationRequest.md +24 -0
  435. package/git_push.sh +57 -0
  436. package/graphql/analytics.graphqls +101 -0
  437. package/graphql/comment.graphqls +33 -0
  438. package/graphql/document-search.graphqls +44 -0
  439. package/graphql/document.graphqls +116 -0
  440. package/graphql/share.graphqls +168 -0
  441. package/index.ts +18 -0
  442. package/models/ancestor-info.ts +22 -0
  443. package/models/audit-log-details-one-of.ts +70 -0
  444. package/models/audit-log-details.ts +20 -0
  445. package/models/audit-log.ts +75 -0
  446. package/models/audit-verification-result.ts +39 -0
  447. package/models/broken-link.ts +22 -0
  448. package/models/comment-dto.ts +28 -0
  449. package/models/copy-audit.ts +26 -0
  450. package/models/copy-request.ts +31 -0
  451. package/models/copy-response.ts +27 -0
  452. package/models/create-blank-document-request.ts +38 -0
  453. package/models/create-comment-request.ts +31 -0
  454. package/models/create-folder-audit.ts +29 -0
  455. package/models/create-folder-request.ts +24 -0
  456. package/models/create-team-request.ts +21 -0
  457. package/models/dashboard-statistics-response.ts +29 -0
  458. package/models/delete-audit.ts +26 -0
  459. package/models/delete-metadata-audit.ts +26 -0
  460. package/models/delete-metadata-request.ts +23 -0
  461. package/models/delete-request.ts +23 -0
  462. package/models/delete-share-request.ts +24 -0
  463. package/models/document-info.ts +51 -0
  464. package/models/document-position.ts +23 -0
  465. package/models/element-info.ts +22 -0
  466. package/models/file-type-stats.ts +22 -0
  467. package/models/filter-input.ts +21 -0
  468. package/models/folder-element-info.ts +39 -0
  469. package/models/folder-response.ts +22 -0
  470. package/models/index.ts +62 -0
  471. package/models/ingestion-status-dto.ts +28 -0
  472. package/models/move-audit.ts +26 -0
  473. package/models/move-request.ts +31 -0
  474. package/models/notification-dto.ts +38 -0
  475. package/models/rename-audit.ts +26 -0
  476. package/models/rename-request.ts +20 -0
  477. package/models/replace-audit.ts +26 -0
  478. package/models/scan-job-status-dto.ts +26 -0
  479. package/models/scan-request-dto.ts +24 -0
  480. package/models/scanner-info-dto.ts +28 -0
  481. package/models/search-by-audit-log-request.ts +84 -0
  482. package/models/search-by-metadata-request.ts +50 -0
  483. package/models/search-metadata-request.ts +23 -0
  484. package/models/settings.ts +25 -0
  485. package/models/share-request.ts +44 -0
  486. package/models/share-result-error.ts +35 -0
  487. package/models/share-result-item.ts +21 -0
  488. package/models/share-result-response.ts +28 -0
  489. package/models/sort-input.ts +29 -0
  490. package/models/storage-breakdown.ts +25 -0
  491. package/models/suggest.ts +23 -0
  492. package/models/team-member-info.ts +32 -0
  493. package/models/tus-config-response.ts +24 -0
  494. package/models/tus-finalize-request.ts +23 -0
  495. package/models/tus-upload-info.ts +24 -0
  496. package/models/update-comment-request.ts +27 -0
  497. package/models/update-metadata-audit.ts +26 -0
  498. package/models/update-metadata-request.ts +23 -0
  499. package/models/update-team-request.ts +21 -0
  500. package/models/update-user-request.ts +31 -0
  501. package/models/upload-audit.ts +26 -0
  502. package/models/upload-response.ts +25 -0
  503. package/models/user-preferences-request.ts +21 -0
  504. package/models/user-registration-request.ts +31 -0
  505. package/package.json +33 -0
  506. package/tsconfig.esm.json +7 -0
  507. package/tsconfig.json +18 -0
@@ -0,0 +1,1287 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * openfilz-api
5
+ * API for Document Management System
6
+ *
7
+ * The version of the OpenAPI document: 1.0.0
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+
16
+ import type { Configuration } from '../configuration';
17
+ import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
18
+ import globalAxios from 'axios';
19
+ // Some imports not used depending on template conditions
20
+ // @ts-ignore
21
+ import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction, replaceWithSerializableTypeIfNeeded } from '../common';
22
+ // @ts-ignore
23
+ import { BASE_PATH, COLLECTION_FORMATS, type RequestArgs, BaseAPI, RequiredError, operationServerMap } from '../base';
24
+ // @ts-ignore
25
+ import type { AncestorInfo } from '../models';
26
+ // @ts-ignore
27
+ import type { CreateBlankDocumentRequest } from '../models';
28
+ // @ts-ignore
29
+ import type { DeleteMetadataRequest } from '../models';
30
+ // @ts-ignore
31
+ import type { DocumentInfo } from '../models';
32
+ // @ts-ignore
33
+ import type { DocumentPosition } from '../models';
34
+ // @ts-ignore
35
+ import type { ElementInfo } from '../models';
36
+ // @ts-ignore
37
+ import type { SearchByMetadataRequest } from '../models';
38
+ // @ts-ignore
39
+ import type { SearchMetadataRequest } from '../models';
40
+ // @ts-ignore
41
+ import type { UpdateMetadataRequest } from '../models';
42
+ // @ts-ignore
43
+ import type { UploadResponse } from '../models';
44
+ /**
45
+ * DocumentControllerApi - axios parameter creator
46
+ */
47
+ export const DocumentControllerApiAxiosParamCreator = function (configuration?: Configuration) {
48
+ return {
49
+ /**
50
+ * Creates a new blank document (Word, Excel, PowerPoint, or Text) from a template in the specified folder.
51
+ * @summary Create a blank document from template
52
+ * @param {CreateBlankDocumentRequest} createBlankDocumentRequest
53
+ * @param {*} [options] Override http request option.
54
+ * @throws {RequiredError}
55
+ */
56
+ createBlankDocument: async (createBlankDocumentRequest: CreateBlankDocumentRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
57
+ // verify required parameter 'createBlankDocumentRequest' is not null or undefined
58
+ assertParamExists('createBlankDocument', 'createBlankDocumentRequest', createBlankDocumentRequest)
59
+ const localVarPath = `/api/v1/documents/create-blank`;
60
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
61
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
62
+ let baseOptions;
63
+ if (configuration) {
64
+ baseOptions = configuration.baseOptions;
65
+ }
66
+
67
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
68
+ const localVarHeaderParameter = {} as any;
69
+ const localVarQueryParameter = {} as any;
70
+
71
+ // authentication keycloak_auth required
72
+ // http bearer authentication required
73
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
74
+
75
+ localVarHeaderParameter['Content-Type'] = 'application/json';
76
+ localVarHeaderParameter['Accept'] = '*/*';
77
+
78
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
79
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
80
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
81
+ localVarRequestOptions.data = serializeDataIfNeeded(createBlankDocumentRequest, localVarRequestOptions, configuration)
82
+
83
+ return {
84
+ url: toPathString(localVarUrlObj),
85
+ options: localVarRequestOptions,
86
+ };
87
+ },
88
+ /**
89
+ * Deletes specified metadata keys from a document.
90
+ * @summary Delete specific metadata keys
91
+ * @param {string} documentId
92
+ * @param {DeleteMetadataRequest} deleteMetadataRequest
93
+ * @param {*} [options] Override http request option.
94
+ * @throws {RequiredError}
95
+ */
96
+ deleteDocumentMetadata: async (documentId: string, deleteMetadataRequest: DeleteMetadataRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
97
+ // verify required parameter 'documentId' is not null or undefined
98
+ assertParamExists('deleteDocumentMetadata', 'documentId', documentId)
99
+ // verify required parameter 'deleteMetadataRequest' is not null or undefined
100
+ assertParamExists('deleteDocumentMetadata', 'deleteMetadataRequest', deleteMetadataRequest)
101
+ const localVarPath = `/api/v1/documents/{documentId}/metadata`
102
+ .replace(`{${"documentId"}}`, encodeURIComponent(String(documentId)));
103
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
104
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
105
+ let baseOptions;
106
+ if (configuration) {
107
+ baseOptions = configuration.baseOptions;
108
+ }
109
+
110
+ const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
111
+ const localVarHeaderParameter = {} as any;
112
+ const localVarQueryParameter = {} as any;
113
+
114
+ // authentication keycloak_auth required
115
+ // http bearer authentication required
116
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
117
+
118
+ localVarHeaderParameter['Content-Type'] = 'application/json';
119
+
120
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
121
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
122
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
123
+ localVarRequestOptions.data = serializeDataIfNeeded(deleteMetadataRequest, localVarRequestOptions, configuration)
124
+
125
+ return {
126
+ url: toPathString(localVarUrlObj),
127
+ options: localVarRequestOptions,
128
+ };
129
+ },
130
+ /**
131
+ * Downloads a single file document.
132
+ * @summary Download a document
133
+ * @param {string} documentId
134
+ * @param {*} [options] Override http request option.
135
+ * @throws {RequiredError}
136
+ */
137
+ downloadDocument: async (documentId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
138
+ // verify required parameter 'documentId' is not null or undefined
139
+ assertParamExists('downloadDocument', 'documentId', documentId)
140
+ const localVarPath = `/api/v1/documents/{documentId}/download`
141
+ .replace(`{${"documentId"}}`, encodeURIComponent(String(documentId)));
142
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
143
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
144
+ let baseOptions;
145
+ if (configuration) {
146
+ baseOptions = configuration.baseOptions;
147
+ }
148
+
149
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
150
+ const localVarHeaderParameter = {} as any;
151
+ const localVarQueryParameter = {} as any;
152
+
153
+ // authentication keycloak_auth required
154
+ // http bearer authentication required
155
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
156
+
157
+ localVarHeaderParameter['Accept'] = '*/*';
158
+
159
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
160
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
161
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
162
+
163
+ return {
164
+ url: toPathString(localVarUrlObj),
165
+ options: localVarRequestOptions,
166
+ };
167
+ },
168
+ /**
169
+ * Internal endpoint for OnlyOffice DocumentServer to fetch document content. Uses token-based authentication.
170
+ * @summary Download document for OnlyOffice
171
+ * @param {string} documentId
172
+ * @param {string} token
173
+ * @param {*} [options] Override http request option.
174
+ * @throws {RequiredError}
175
+ */
176
+ downloadForOnlyOffice: async (documentId: string, token: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
177
+ // verify required parameter 'documentId' is not null or undefined
178
+ assertParamExists('downloadForOnlyOffice', 'documentId', documentId)
179
+ // verify required parameter 'token' is not null or undefined
180
+ assertParamExists('downloadForOnlyOffice', 'token', token)
181
+ const localVarPath = `/api/v1/documents/{documentId}/onlyoffice-download`
182
+ .replace(`{${"documentId"}}`, encodeURIComponent(String(documentId)));
183
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
184
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
185
+ let baseOptions;
186
+ if (configuration) {
187
+ baseOptions = configuration.baseOptions;
188
+ }
189
+
190
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
191
+ const localVarHeaderParameter = {} as any;
192
+ const localVarQueryParameter = {} as any;
193
+
194
+ // authentication keycloak_auth required
195
+ // http bearer authentication required
196
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
197
+
198
+ if (token !== undefined) {
199
+ localVarQueryParameter['token'] = token;
200
+ }
201
+
202
+ localVarHeaderParameter['Accept'] = '*/*';
203
+
204
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
205
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
206
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
207
+
208
+ return {
209
+ url: toPathString(localVarUrlObj),
210
+ options: localVarRequestOptions,
211
+ };
212
+ },
213
+ /**
214
+ * Downloads multiple documents as a single ZIP file.
215
+ * @summary Download multiple documents as ZIP
216
+ * @param {Array<string>} requestBody
217
+ * @param {*} [options] Override http request option.
218
+ * @throws {RequiredError}
219
+ */
220
+ downloadMultipleDocumentsAsZip: async (requestBody: Array<string>, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
221
+ // verify required parameter 'requestBody' is not null or undefined
222
+ assertParamExists('downloadMultipleDocumentsAsZip', 'requestBody', requestBody)
223
+ const localVarPath = `/api/v1/documents/download-multiple`;
224
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
225
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
226
+ let baseOptions;
227
+ if (configuration) {
228
+ baseOptions = configuration.baseOptions;
229
+ }
230
+
231
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
232
+ const localVarHeaderParameter = {} as any;
233
+ const localVarQueryParameter = {} as any;
234
+
235
+ // authentication keycloak_auth required
236
+ // http bearer authentication required
237
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
238
+
239
+ localVarHeaderParameter['Content-Type'] = 'application/json';
240
+ localVarHeaderParameter['Accept'] = '*/*';
241
+
242
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
243
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
244
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
245
+ localVarRequestOptions.data = serializeDataIfNeeded(requestBody, localVarRequestOptions, configuration)
246
+
247
+ return {
248
+ url: toPathString(localVarUrlObj),
249
+ options: localVarRequestOptions,
250
+ };
251
+ },
252
+ /**
253
+ * Retrieves all ancestor folders (parent path) of a document, ordered from root to immediate parent.
254
+ * @summary Get document ancestors
255
+ * @param {string} documentId
256
+ * @param {*} [options] Override http request option.
257
+ * @throws {RequiredError}
258
+ */
259
+ getDocumentAncestors: async (documentId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
260
+ // verify required parameter 'documentId' is not null or undefined
261
+ assertParamExists('getDocumentAncestors', 'documentId', documentId)
262
+ const localVarPath = `/api/v1/documents/{documentId}/ancestors`
263
+ .replace(`{${"documentId"}}`, encodeURIComponent(String(documentId)));
264
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
265
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
266
+ let baseOptions;
267
+ if (configuration) {
268
+ baseOptions = configuration.baseOptions;
269
+ }
270
+
271
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
272
+ const localVarHeaderParameter = {} as any;
273
+ const localVarQueryParameter = {} as any;
274
+
275
+ // authentication keycloak_auth required
276
+ // http bearer authentication required
277
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
278
+
279
+ localVarHeaderParameter['Accept'] = '*/*';
280
+
281
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
282
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
283
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
284
+
285
+ return {
286
+ url: toPathString(localVarUrlObj),
287
+ options: localVarRequestOptions,
288
+ };
289
+ },
290
+ /**
291
+ * Retrieves information for a document.
292
+ * @summary Get information of a document
293
+ * @param {string} documentId
294
+ * @param {boolean} [withMetadata] if false : only name, type and parentId are sent (when not null) - if true : metadata and size are added in the response
295
+ * @param {*} [options] Override http request option.
296
+ * @throws {RequiredError}
297
+ */
298
+ getDocumentInfo: async (documentId: string, withMetadata?: boolean, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
299
+ // verify required parameter 'documentId' is not null or undefined
300
+ assertParamExists('getDocumentInfo', 'documentId', documentId)
301
+ const localVarPath = `/api/v1/documents/{documentId}/info`
302
+ .replace(`{${"documentId"}}`, encodeURIComponent(String(documentId)));
303
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
304
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
305
+ let baseOptions;
306
+ if (configuration) {
307
+ baseOptions = configuration.baseOptions;
308
+ }
309
+
310
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
311
+ const localVarHeaderParameter = {} as any;
312
+ const localVarQueryParameter = {} as any;
313
+
314
+ // authentication keycloak_auth required
315
+ // http bearer authentication required
316
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
317
+
318
+ if (withMetadata !== undefined) {
319
+ localVarQueryParameter['withMetadata'] = withMetadata;
320
+ }
321
+
322
+ localVarHeaderParameter['Accept'] = '*/*';
323
+
324
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
325
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
326
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
327
+
328
+ return {
329
+ url: toPathString(localVarUrlObj),
330
+ options: localVarRequestOptions,
331
+ };
332
+ },
333
+ /**
334
+ * Retrieves metadata for a document. Can filter by keys.
335
+ * @summary Search metadata of a document
336
+ * @param {string} documentId
337
+ * @param {SearchMetadataRequest} [searchMetadataRequest]
338
+ * @param {*} [options] Override http request option.
339
+ * @throws {RequiredError}
340
+ */
341
+ getDocumentMetadata: async (documentId: string, searchMetadataRequest?: SearchMetadataRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
342
+ // verify required parameter 'documentId' is not null or undefined
343
+ assertParamExists('getDocumentMetadata', 'documentId', documentId)
344
+ const localVarPath = `/api/v1/documents/{documentId}/search/metadata`
345
+ .replace(`{${"documentId"}}`, encodeURIComponent(String(documentId)));
346
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
347
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
348
+ let baseOptions;
349
+ if (configuration) {
350
+ baseOptions = configuration.baseOptions;
351
+ }
352
+
353
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
354
+ const localVarHeaderParameter = {} as any;
355
+ const localVarQueryParameter = {} as any;
356
+
357
+ // authentication keycloak_auth required
358
+ // http bearer authentication required
359
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
360
+
361
+ localVarHeaderParameter['Content-Type'] = 'application/json';
362
+ localVarHeaderParameter['Accept'] = '*/*';
363
+
364
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
365
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
366
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
367
+ localVarRequestOptions.data = serializeDataIfNeeded(searchMetadataRequest, localVarRequestOptions, configuration)
368
+
369
+ return {
370
+ url: toPathString(localVarUrlObj),
371
+ options: localVarRequestOptions,
372
+ };
373
+ },
374
+ /**
375
+ * Retrieves the position of a document within its parent folder, useful for pagination.
376
+ * @summary Get document position in folder
377
+ * @param {string} documentId
378
+ * @param {string} [sortBy] Field to sort by (name, updated_at, created_at, size, type). Defaults to \&#39;name\&#39;.
379
+ * @param {string} [sortOrder] Sort order (ASC or DESC). Defaults to \&#39;ASC\&#39;.
380
+ * @param {*} [options] Override http request option.
381
+ * @throws {RequiredError}
382
+ */
383
+ getDocumentPosition: async (documentId: string, sortBy?: string, sortOrder?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
384
+ // verify required parameter 'documentId' is not null or undefined
385
+ assertParamExists('getDocumentPosition', 'documentId', documentId)
386
+ const localVarPath = `/api/v1/documents/{documentId}/position`
387
+ .replace(`{${"documentId"}}`, encodeURIComponent(String(documentId)));
388
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
389
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
390
+ let baseOptions;
391
+ if (configuration) {
392
+ baseOptions = configuration.baseOptions;
393
+ }
394
+
395
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
396
+ const localVarHeaderParameter = {} as any;
397
+ const localVarQueryParameter = {} as any;
398
+
399
+ // authentication keycloak_auth required
400
+ // http bearer authentication required
401
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
402
+
403
+ if (sortBy !== undefined) {
404
+ localVarQueryParameter['sortBy'] = sortBy;
405
+ }
406
+
407
+ if (sortOrder !== undefined) {
408
+ localVarQueryParameter['sortOrder'] = sortOrder;
409
+ }
410
+
411
+ localVarHeaderParameter['Accept'] = '*/*';
412
+
413
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
414
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
415
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
416
+
417
+ return {
418
+ url: toPathString(localVarUrlObj),
419
+ options: localVarRequestOptions,
420
+ };
421
+ },
422
+ /**
423
+ * Replaces the content of an existing file document.
424
+ * @summary Replace document content
425
+ * @param {string} documentId
426
+ * @param {File} file
427
+ * @param {*} [options] Override http request option.
428
+ * @throws {RequiredError}
429
+ */
430
+ replaceDocumentContent: async (documentId: string, file: File, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
431
+ // verify required parameter 'documentId' is not null or undefined
432
+ assertParamExists('replaceDocumentContent', 'documentId', documentId)
433
+ // verify required parameter 'file' is not null or undefined
434
+ assertParamExists('replaceDocumentContent', 'file', file)
435
+ const localVarPath = `/api/v1/documents/{documentId}/replace-content`
436
+ .replace(`{${"documentId"}}`, encodeURIComponent(String(documentId)));
437
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
438
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
439
+ let baseOptions;
440
+ if (configuration) {
441
+ baseOptions = configuration.baseOptions;
442
+ }
443
+
444
+ const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
445
+ const localVarHeaderParameter = {} as any;
446
+ const localVarQueryParameter = {} as any;
447
+ const localVarFormParams = new ((configuration && configuration.formDataCtor) || FormData)();
448
+
449
+ // authentication keycloak_auth required
450
+ // http bearer authentication required
451
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
452
+
453
+
454
+ if (file !== undefined) {
455
+ localVarFormParams.append('file', file as any);
456
+ }
457
+ localVarHeaderParameter['Content-Type'] = 'multipart/form-data';
458
+ localVarHeaderParameter['Accept'] = '*/*';
459
+
460
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
461
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
462
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
463
+ localVarRequestOptions.data = localVarFormParams;
464
+
465
+ return {
466
+ url: toPathString(localVarUrlObj),
467
+ options: localVarRequestOptions,
468
+ };
469
+ },
470
+ /**
471
+ * Replaces all metadata of a document (file or folder).
472
+ * @summary Replace document metadata
473
+ * @param {string} documentId
474
+ * @param {{ [key: string]: any; }} requestBody New metadata map. Replaces all existing metadata.
475
+ * @param {*} [options] Override http request option.
476
+ * @throws {RequiredError}
477
+ */
478
+ replaceDocumentMetadata: async (documentId: string, requestBody: { [key: string]: any; }, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
479
+ // verify required parameter 'documentId' is not null or undefined
480
+ assertParamExists('replaceDocumentMetadata', 'documentId', documentId)
481
+ // verify required parameter 'requestBody' is not null or undefined
482
+ assertParamExists('replaceDocumentMetadata', 'requestBody', requestBody)
483
+ const localVarPath = `/api/v1/documents/{documentId}/replace-metadata`
484
+ .replace(`{${"documentId"}}`, encodeURIComponent(String(documentId)));
485
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
486
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
487
+ let baseOptions;
488
+ if (configuration) {
489
+ baseOptions = configuration.baseOptions;
490
+ }
491
+
492
+ const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
493
+ const localVarHeaderParameter = {} as any;
494
+ const localVarQueryParameter = {} as any;
495
+
496
+ // authentication keycloak_auth required
497
+ // http bearer authentication required
498
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
499
+
500
+ localVarHeaderParameter['Content-Type'] = 'application/json';
501
+ localVarHeaderParameter['Accept'] = '*/*';
502
+
503
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
504
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
505
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
506
+ localVarRequestOptions.data = serializeDataIfNeeded(requestBody, localVarRequestOptions, configuration)
507
+
508
+ return {
509
+ url: toPathString(localVarUrlObj),
510
+ options: localVarRequestOptions,
511
+ };
512
+ },
513
+ /**
514
+ * Finds document IDs matching all provided metadata criteria.
515
+ * @summary Search document IDs by metadata
516
+ * @param {SearchByMetadataRequest} searchByMetadataRequest
517
+ * @param {*} [options] Override http request option.
518
+ * @throws {RequiredError}
519
+ */
520
+ searchDocumentIdsByMetadata: async (searchByMetadataRequest: SearchByMetadataRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
521
+ // verify required parameter 'searchByMetadataRequest' is not null or undefined
522
+ assertParamExists('searchDocumentIdsByMetadata', 'searchByMetadataRequest', searchByMetadataRequest)
523
+ const localVarPath = `/api/v1/documents/search/ids-by-metadata`;
524
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
525
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
526
+ let baseOptions;
527
+ if (configuration) {
528
+ baseOptions = configuration.baseOptions;
529
+ }
530
+
531
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
532
+ const localVarHeaderParameter = {} as any;
533
+ const localVarQueryParameter = {} as any;
534
+
535
+ // authentication keycloak_auth required
536
+ // http bearer authentication required
537
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
538
+
539
+ localVarHeaderParameter['Content-Type'] = 'application/json';
540
+ localVarHeaderParameter['Accept'] = '*/*';
541
+
542
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
543
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
544
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
545
+ localVarRequestOptions.data = serializeDataIfNeeded(searchByMetadataRequest, localVarRequestOptions, configuration)
546
+
547
+ return {
548
+ url: toPathString(localVarUrlObj),
549
+ options: localVarRequestOptions,
550
+ };
551
+ },
552
+ /**
553
+ * Updates or adds specific metadata fields for a document.
554
+ * @summary Update document metadata
555
+ * @param {string} documentId
556
+ * @param {UpdateMetadataRequest} updateMetadataRequest
557
+ * @param {*} [options] Override http request option.
558
+ * @throws {RequiredError}
559
+ */
560
+ updateDocumentMetadata: async (documentId: string, updateMetadataRequest: UpdateMetadataRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
561
+ // verify required parameter 'documentId' is not null or undefined
562
+ assertParamExists('updateDocumentMetadata', 'documentId', documentId)
563
+ // verify required parameter 'updateMetadataRequest' is not null or undefined
564
+ assertParamExists('updateDocumentMetadata', 'updateMetadataRequest', updateMetadataRequest)
565
+ const localVarPath = `/api/v1/documents/{documentId}/metadata`
566
+ .replace(`{${"documentId"}}`, encodeURIComponent(String(documentId)));
567
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
568
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
569
+ let baseOptions;
570
+ if (configuration) {
571
+ baseOptions = configuration.baseOptions;
572
+ }
573
+
574
+ const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...options};
575
+ const localVarHeaderParameter = {} as any;
576
+ const localVarQueryParameter = {} as any;
577
+
578
+ // authentication keycloak_auth required
579
+ // http bearer authentication required
580
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
581
+
582
+ localVarHeaderParameter['Content-Type'] = 'application/json';
583
+ localVarHeaderParameter['Accept'] = '*/*';
584
+
585
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
586
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
587
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
588
+ localVarRequestOptions.data = serializeDataIfNeeded(updateMetadataRequest, localVarRequestOptions, configuration)
589
+
590
+ return {
591
+ url: toPathString(localVarUrlObj),
592
+ options: localVarRequestOptions,
593
+ };
594
+ },
595
+ /**
596
+ * Uploads multiple files, optionally with metadata and a parent folder ID. Returns HTTP 200 if all uploads succeed, HTTP 207 (Multi-Status) if some succeed and some fail, or an appropriate error status (404, 409, 403, 500) if all uploads fail.
597
+ * @summary Upload multiple documents
598
+ * @param {Array<File>} file
599
+ * @param {boolean} [allowDuplicateFileNames] when true : if a file with the same name already exists in the target parent folder, a 409 error is raised. When false : the file will be stored (but no existing file with same name will be overwritten)
600
+ * @param {string} [parametersByFilename] Paste the JSON array here&lt;br&gt;This array provides optional metadata and attributes for the uploaded files&lt;br&gt;&lt;section&gt; &lt;h3&gt;Each object in the array must contain:&lt;/h3&gt; &lt;table&gt; &lt;thead&gt; &lt;tr&gt; &lt;th&gt;Field&lt;/th&gt; &lt;th&gt;Type&lt;/th&gt; &lt;th&gt;Description&lt;/th&gt; &lt;/tr&gt; &lt;/thead&gt; &lt;tbody&gt; &lt;tr&gt; &lt;td&gt;&lt;code&gt;filename&lt;/code&gt;&lt;/td&gt; &lt;td&gt;&lt;code&gt;String&lt;/code&gt;&lt;/td&gt; &lt;td&gt;Must match the filename of one of the uploaded files. Filenames must be unique in the upload request.&lt;/td&gt; &lt;/tr&gt; &lt;tr&gt; &lt;td&gt;&lt;code&gt;fileAttributes&lt;/code&gt;&lt;/td&gt; &lt;td&gt;&lt;code&gt;JSON Object&lt;/code&gt;&lt;/td&gt; &lt;td&gt;Container for metadata and other file-specific attributes.&lt;/td&gt; &lt;/tr&gt; &lt;/tbody&gt; &lt;/table&gt; &lt;h4&gt;Inside &lt;code&gt;fileAttributes&lt;/code&gt;:&lt;/h4&gt; &lt;table&gt; &lt;thead&gt; &lt;tr&gt; &lt;th&gt;Field&lt;/th&gt; &lt;th&gt;Type&lt;/th&gt; &lt;th&gt;Description&lt;/th&gt; &lt;/tr&gt; &lt;/thead&gt; &lt;tbody&gt; &lt;tr&gt; &lt;td&gt;&lt;code&gt;parentFolderId&lt;/code&gt;&lt;/td&gt; &lt;td&gt;&lt;code&gt;UUID&lt;/code&gt;&lt;/td&gt; &lt;td&gt;UUID of the target folder to upload the file (if not provided : the file will be uploaded at the root level)&lt;/td&gt; &lt;/tr&gt; &lt;tr&gt; &lt;td&gt;&lt;code&gt;metadata&lt;/code&gt;&lt;/td&gt; &lt;td&gt;&lt;code&gt;Map&amp;lt;String, JSON Object&amp;gt;&lt;/code&gt;&lt;/td&gt; &lt;td&gt;Arbitrary metadata to associate with the file (key/value pairs).&lt;/td&gt; &lt;/tr&gt; &lt;/tbody&gt; &lt;/table&gt; &lt;h4&gt;Example of &lt;code&gt;parametersByFilename&lt;/code&gt; JSON array :&lt;/h4&gt; &lt;pre&gt;&lt;code&gt;[ { \\\&quot;filename\\\&quot;: \\\&quot;file1.txt\\\&quot;, \\\&quot;fileAttributes\\\&quot;: { \\\&quot;parentFolderId\\\&quot;: \\\&quot;f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454\\\&quot;, \\\&quot;metadata\\\&quot;: { \\\&quot;country\\\&quot;: \\\&quot;UK\\\&quot;, \\\&quot;owner\\\&quot;: { \\\&quot;name\\\&quot;: \\\&quot;Joe\\\&quot;, \\\&quot;owner_id\\\&quot;: 1234568 } } } }, { \\\&quot;filename\\\&quot;: \\\&quot;file2.md\\\&quot;, \\\&quot;fileAttributes\\\&quot;: { \\\&quot;metadata\\\&quot;: { \\\&quot;key1\\\&quot;: \\\&quot;value1\\\&quot;, \\\&quot;key2\\\&quot;: \\\&quot;value2\\\&quot;, \\\&quot;key3\\\&quot;: \\\&quot;value3\\\&quot; } } } ]&lt;/code&gt;&lt;/pre&gt; &lt;/section&gt;
601
+ * @param {*} [options] Override http request option.
602
+ * @throws {RequiredError}
603
+ */
604
+ uploadDocument: async (file: Array<File>, allowDuplicateFileNames?: boolean, parametersByFilename?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
605
+ // verify required parameter 'file' is not null or undefined
606
+ assertParamExists('uploadDocument', 'file', file)
607
+ const localVarPath = `/api/v1/documents/upload-multiple`;
608
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
609
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
610
+ let baseOptions;
611
+ if (configuration) {
612
+ baseOptions = configuration.baseOptions;
613
+ }
614
+
615
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
616
+ const localVarHeaderParameter = {} as any;
617
+ const localVarQueryParameter = {} as any;
618
+ const localVarFormParams = new ((configuration && configuration.formDataCtor) || FormData)();
619
+
620
+ // authentication keycloak_auth required
621
+ // http bearer authentication required
622
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
623
+
624
+ if (allowDuplicateFileNames !== undefined) {
625
+ localVarQueryParameter['allowDuplicateFileNames'] = allowDuplicateFileNames;
626
+ }
627
+
628
+ if (file) {
629
+ file.forEach((element) => {
630
+ localVarFormParams.append('file', element as any);
631
+ })
632
+ }
633
+
634
+
635
+ if (parametersByFilename !== undefined) {
636
+ localVarFormParams.append('parametersByFilename', parametersByFilename as any);
637
+ }
638
+ localVarHeaderParameter['Content-Type'] = 'multipart/form-data';
639
+ localVarHeaderParameter['Accept'] = '*/*';
640
+
641
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
642
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
643
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
644
+ localVarRequestOptions.data = localVarFormParams;
645
+
646
+ return {
647
+ url: toPathString(localVarUrlObj),
648
+ options: localVarRequestOptions,
649
+ };
650
+ },
651
+ /**
652
+ * Uploads a single file, optionally with metadata and a parent folder ID.
653
+ * @summary Upload a single document
654
+ * @param {File} file
655
+ * @param {boolean} [allowDuplicateFileNames] when true : if a file with the same name already exists in the target parent folder, a 409 error is raised. When false : the file will be stored (but no existing file with same name will be overwritten)
656
+ * @param {string} [parentFolderId] Target parent folder ID to store the file; if not sent or null, the file is stored at the root level
657
+ * @param {string} [metadata]
658
+ * @param {*} [options] Override http request option.
659
+ * @throws {RequiredError}
660
+ */
661
+ uploadDocument1: async (file: File, allowDuplicateFileNames?: boolean, parentFolderId?: string, metadata?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
662
+ // verify required parameter 'file' is not null or undefined
663
+ assertParamExists('uploadDocument1', 'file', file)
664
+ const localVarPath = `/api/v1/documents/upload`;
665
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
666
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
667
+ let baseOptions;
668
+ if (configuration) {
669
+ baseOptions = configuration.baseOptions;
670
+ }
671
+
672
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
673
+ const localVarHeaderParameter = {} as any;
674
+ const localVarQueryParameter = {} as any;
675
+ const localVarFormParams = new ((configuration && configuration.formDataCtor) || FormData)();
676
+
677
+ // authentication keycloak_auth required
678
+ // http bearer authentication required
679
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
680
+
681
+ if (allowDuplicateFileNames !== undefined) {
682
+ localVarQueryParameter['allowDuplicateFileNames'] = allowDuplicateFileNames;
683
+ }
684
+
685
+
686
+ if (file !== undefined) {
687
+ localVarFormParams.append('file', file as any);
688
+ }
689
+
690
+ if (parentFolderId !== undefined) {
691
+ localVarFormParams.append('parentFolderId', parentFolderId as any);
692
+ }
693
+
694
+ if (metadata !== undefined) {
695
+ localVarFormParams.append('metadata', metadata as any);
696
+ }
697
+ localVarHeaderParameter['Content-Type'] = 'multipart/form-data';
698
+ localVarHeaderParameter['Accept'] = '*/*';
699
+
700
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
701
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
702
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
703
+ localVarRequestOptions.data = localVarFormParams;
704
+
705
+ return {
706
+ url: toPathString(localVarUrlObj),
707
+ options: localVarRequestOptions,
708
+ };
709
+ },
710
+ }
711
+ };
712
+
713
+ /**
714
+ * DocumentControllerApi - functional programming interface
715
+ */
716
+ export const DocumentControllerApiFp = function(configuration?: Configuration) {
717
+ const localVarAxiosParamCreator = DocumentControllerApiAxiosParamCreator(configuration)
718
+ return {
719
+ /**
720
+ * Creates a new blank document (Word, Excel, PowerPoint, or Text) from a template in the specified folder.
721
+ * @summary Create a blank document from template
722
+ * @param {CreateBlankDocumentRequest} createBlankDocumentRequest
723
+ * @param {*} [options] Override http request option.
724
+ * @throws {RequiredError}
725
+ */
726
+ async createBlankDocument(createBlankDocumentRequest: CreateBlankDocumentRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UploadResponse>> {
727
+ const localVarAxiosArgs = await localVarAxiosParamCreator.createBlankDocument(createBlankDocumentRequest, options);
728
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
729
+ const localVarOperationServerBasePath = operationServerMap['DocumentControllerApi.createBlankDocument']?.[localVarOperationServerIndex]?.url;
730
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
731
+ },
732
+ /**
733
+ * Deletes specified metadata keys from a document.
734
+ * @summary Delete specific metadata keys
735
+ * @param {string} documentId
736
+ * @param {DeleteMetadataRequest} deleteMetadataRequest
737
+ * @param {*} [options] Override http request option.
738
+ * @throws {RequiredError}
739
+ */
740
+ async deleteDocumentMetadata(documentId: string, deleteMetadataRequest: DeleteMetadataRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
741
+ const localVarAxiosArgs = await localVarAxiosParamCreator.deleteDocumentMetadata(documentId, deleteMetadataRequest, options);
742
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
743
+ const localVarOperationServerBasePath = operationServerMap['DocumentControllerApi.deleteDocumentMetadata']?.[localVarOperationServerIndex]?.url;
744
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
745
+ },
746
+ /**
747
+ * Downloads a single file document.
748
+ * @summary Download a document
749
+ * @param {string} documentId
750
+ * @param {*} [options] Override http request option.
751
+ * @throws {RequiredError}
752
+ */
753
+ async downloadDocument(documentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>> {
754
+ const localVarAxiosArgs = await localVarAxiosParamCreator.downloadDocument(documentId, options);
755
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
756
+ const localVarOperationServerBasePath = operationServerMap['DocumentControllerApi.downloadDocument']?.[localVarOperationServerIndex]?.url;
757
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
758
+ },
759
+ /**
760
+ * Internal endpoint for OnlyOffice DocumentServer to fetch document content. Uses token-based authentication.
761
+ * @summary Download document for OnlyOffice
762
+ * @param {string} documentId
763
+ * @param {string} token
764
+ * @param {*} [options] Override http request option.
765
+ * @throws {RequiredError}
766
+ */
767
+ async downloadForOnlyOffice(documentId: string, token: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>> {
768
+ const localVarAxiosArgs = await localVarAxiosParamCreator.downloadForOnlyOffice(documentId, token, options);
769
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
770
+ const localVarOperationServerBasePath = operationServerMap['DocumentControllerApi.downloadForOnlyOffice']?.[localVarOperationServerIndex]?.url;
771
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
772
+ },
773
+ /**
774
+ * Downloads multiple documents as a single ZIP file.
775
+ * @summary Download multiple documents as ZIP
776
+ * @param {Array<string>} requestBody
777
+ * @param {*} [options] Override http request option.
778
+ * @throws {RequiredError}
779
+ */
780
+ async downloadMultipleDocumentsAsZip(requestBody: Array<string>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>> {
781
+ const localVarAxiosArgs = await localVarAxiosParamCreator.downloadMultipleDocumentsAsZip(requestBody, options);
782
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
783
+ const localVarOperationServerBasePath = operationServerMap['DocumentControllerApi.downloadMultipleDocumentsAsZip']?.[localVarOperationServerIndex]?.url;
784
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
785
+ },
786
+ /**
787
+ * Retrieves all ancestor folders (parent path) of a document, ordered from root to immediate parent.
788
+ * @summary Get document ancestors
789
+ * @param {string} documentId
790
+ * @param {*} [options] Override http request option.
791
+ * @throws {RequiredError}
792
+ */
793
+ async getDocumentAncestors(documentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<AncestorInfo>>> {
794
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getDocumentAncestors(documentId, options);
795
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
796
+ const localVarOperationServerBasePath = operationServerMap['DocumentControllerApi.getDocumentAncestors']?.[localVarOperationServerIndex]?.url;
797
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
798
+ },
799
+ /**
800
+ * Retrieves information for a document.
801
+ * @summary Get information of a document
802
+ * @param {string} documentId
803
+ * @param {boolean} [withMetadata] if false : only name, type and parentId are sent (when not null) - if true : metadata and size are added in the response
804
+ * @param {*} [options] Override http request option.
805
+ * @throws {RequiredError}
806
+ */
807
+ async getDocumentInfo(documentId: string, withMetadata?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DocumentInfo>> {
808
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getDocumentInfo(documentId, withMetadata, options);
809
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
810
+ const localVarOperationServerBasePath = operationServerMap['DocumentControllerApi.getDocumentInfo']?.[localVarOperationServerIndex]?.url;
811
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
812
+ },
813
+ /**
814
+ * Retrieves metadata for a document. Can filter by keys.
815
+ * @summary Search metadata of a document
816
+ * @param {string} documentId
817
+ * @param {SearchMetadataRequest} [searchMetadataRequest]
818
+ * @param {*} [options] Override http request option.
819
+ * @throws {RequiredError}
820
+ */
821
+ async getDocumentMetadata(documentId: string, searchMetadataRequest?: SearchMetadataRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{ [key: string]: any; }>> {
822
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getDocumentMetadata(documentId, searchMetadataRequest, options);
823
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
824
+ const localVarOperationServerBasePath = operationServerMap['DocumentControllerApi.getDocumentMetadata']?.[localVarOperationServerIndex]?.url;
825
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
826
+ },
827
+ /**
828
+ * Retrieves the position of a document within its parent folder, useful for pagination.
829
+ * @summary Get document position in folder
830
+ * @param {string} documentId
831
+ * @param {string} [sortBy] Field to sort by (name, updated_at, created_at, size, type). Defaults to \&#39;name\&#39;.
832
+ * @param {string} [sortOrder] Sort order (ASC or DESC). Defaults to \&#39;ASC\&#39;.
833
+ * @param {*} [options] Override http request option.
834
+ * @throws {RequiredError}
835
+ */
836
+ async getDocumentPosition(documentId: string, sortBy?: string, sortOrder?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DocumentPosition>> {
837
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getDocumentPosition(documentId, sortBy, sortOrder, options);
838
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
839
+ const localVarOperationServerBasePath = operationServerMap['DocumentControllerApi.getDocumentPosition']?.[localVarOperationServerIndex]?.url;
840
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
841
+ },
842
+ /**
843
+ * Replaces the content of an existing file document.
844
+ * @summary Replace document content
845
+ * @param {string} documentId
846
+ * @param {File} file
847
+ * @param {*} [options] Override http request option.
848
+ * @throws {RequiredError}
849
+ */
850
+ async replaceDocumentContent(documentId: string, file: File, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ElementInfo>> {
851
+ const localVarAxiosArgs = await localVarAxiosParamCreator.replaceDocumentContent(documentId, file, options);
852
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
853
+ const localVarOperationServerBasePath = operationServerMap['DocumentControllerApi.replaceDocumentContent']?.[localVarOperationServerIndex]?.url;
854
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
855
+ },
856
+ /**
857
+ * Replaces all metadata of a document (file or folder).
858
+ * @summary Replace document metadata
859
+ * @param {string} documentId
860
+ * @param {{ [key: string]: any; }} requestBody New metadata map. Replaces all existing metadata.
861
+ * @param {*} [options] Override http request option.
862
+ * @throws {RequiredError}
863
+ */
864
+ async replaceDocumentMetadata(documentId: string, requestBody: { [key: string]: any; }, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ElementInfo>> {
865
+ const localVarAxiosArgs = await localVarAxiosParamCreator.replaceDocumentMetadata(documentId, requestBody, options);
866
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
867
+ const localVarOperationServerBasePath = operationServerMap['DocumentControllerApi.replaceDocumentMetadata']?.[localVarOperationServerIndex]?.url;
868
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
869
+ },
870
+ /**
871
+ * Finds document IDs matching all provided metadata criteria.
872
+ * @summary Search document IDs by metadata
873
+ * @param {SearchByMetadataRequest} searchByMetadataRequest
874
+ * @param {*} [options] Override http request option.
875
+ * @throws {RequiredError}
876
+ */
877
+ async searchDocumentIdsByMetadata(searchByMetadataRequest: SearchByMetadataRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<string>>> {
878
+ const localVarAxiosArgs = await localVarAxiosParamCreator.searchDocumentIdsByMetadata(searchByMetadataRequest, options);
879
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
880
+ const localVarOperationServerBasePath = operationServerMap['DocumentControllerApi.searchDocumentIdsByMetadata']?.[localVarOperationServerIndex]?.url;
881
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
882
+ },
883
+ /**
884
+ * Updates or adds specific metadata fields for a document.
885
+ * @summary Update document metadata
886
+ * @param {string} documentId
887
+ * @param {UpdateMetadataRequest} updateMetadataRequest
888
+ * @param {*} [options] Override http request option.
889
+ * @throws {RequiredError}
890
+ */
891
+ async updateDocumentMetadata(documentId: string, updateMetadataRequest: UpdateMetadataRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ElementInfo>> {
892
+ const localVarAxiosArgs = await localVarAxiosParamCreator.updateDocumentMetadata(documentId, updateMetadataRequest, options);
893
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
894
+ const localVarOperationServerBasePath = operationServerMap['DocumentControllerApi.updateDocumentMetadata']?.[localVarOperationServerIndex]?.url;
895
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
896
+ },
897
+ /**
898
+ * Uploads multiple files, optionally with metadata and a parent folder ID. Returns HTTP 200 if all uploads succeed, HTTP 207 (Multi-Status) if some succeed and some fail, or an appropriate error status (404, 409, 403, 500) if all uploads fail.
899
+ * @summary Upload multiple documents
900
+ * @param {Array<File>} file
901
+ * @param {boolean} [allowDuplicateFileNames] when true : if a file with the same name already exists in the target parent folder, a 409 error is raised. When false : the file will be stored (but no existing file with same name will be overwritten)
902
+ * @param {string} [parametersByFilename] Paste the JSON array here&lt;br&gt;This array provides optional metadata and attributes for the uploaded files&lt;br&gt;&lt;section&gt; &lt;h3&gt;Each object in the array must contain:&lt;/h3&gt; &lt;table&gt; &lt;thead&gt; &lt;tr&gt; &lt;th&gt;Field&lt;/th&gt; &lt;th&gt;Type&lt;/th&gt; &lt;th&gt;Description&lt;/th&gt; &lt;/tr&gt; &lt;/thead&gt; &lt;tbody&gt; &lt;tr&gt; &lt;td&gt;&lt;code&gt;filename&lt;/code&gt;&lt;/td&gt; &lt;td&gt;&lt;code&gt;String&lt;/code&gt;&lt;/td&gt; &lt;td&gt;Must match the filename of one of the uploaded files. Filenames must be unique in the upload request.&lt;/td&gt; &lt;/tr&gt; &lt;tr&gt; &lt;td&gt;&lt;code&gt;fileAttributes&lt;/code&gt;&lt;/td&gt; &lt;td&gt;&lt;code&gt;JSON Object&lt;/code&gt;&lt;/td&gt; &lt;td&gt;Container for metadata and other file-specific attributes.&lt;/td&gt; &lt;/tr&gt; &lt;/tbody&gt; &lt;/table&gt; &lt;h4&gt;Inside &lt;code&gt;fileAttributes&lt;/code&gt;:&lt;/h4&gt; &lt;table&gt; &lt;thead&gt; &lt;tr&gt; &lt;th&gt;Field&lt;/th&gt; &lt;th&gt;Type&lt;/th&gt; &lt;th&gt;Description&lt;/th&gt; &lt;/tr&gt; &lt;/thead&gt; &lt;tbody&gt; &lt;tr&gt; &lt;td&gt;&lt;code&gt;parentFolderId&lt;/code&gt;&lt;/td&gt; &lt;td&gt;&lt;code&gt;UUID&lt;/code&gt;&lt;/td&gt; &lt;td&gt;UUID of the target folder to upload the file (if not provided : the file will be uploaded at the root level)&lt;/td&gt; &lt;/tr&gt; &lt;tr&gt; &lt;td&gt;&lt;code&gt;metadata&lt;/code&gt;&lt;/td&gt; &lt;td&gt;&lt;code&gt;Map&amp;lt;String, JSON Object&amp;gt;&lt;/code&gt;&lt;/td&gt; &lt;td&gt;Arbitrary metadata to associate with the file (key/value pairs).&lt;/td&gt; &lt;/tr&gt; &lt;/tbody&gt; &lt;/table&gt; &lt;h4&gt;Example of &lt;code&gt;parametersByFilename&lt;/code&gt; JSON array :&lt;/h4&gt; &lt;pre&gt;&lt;code&gt;[ { \\\&quot;filename\\\&quot;: \\\&quot;file1.txt\\\&quot;, \\\&quot;fileAttributes\\\&quot;: { \\\&quot;parentFolderId\\\&quot;: \\\&quot;f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454\\\&quot;, \\\&quot;metadata\\\&quot;: { \\\&quot;country\\\&quot;: \\\&quot;UK\\\&quot;, \\\&quot;owner\\\&quot;: { \\\&quot;name\\\&quot;: \\\&quot;Joe\\\&quot;, \\\&quot;owner_id\\\&quot;: 1234568 } } } }, { \\\&quot;filename\\\&quot;: \\\&quot;file2.md\\\&quot;, \\\&quot;fileAttributes\\\&quot;: { \\\&quot;metadata\\\&quot;: { \\\&quot;key1\\\&quot;: \\\&quot;value1\\\&quot;, \\\&quot;key2\\\&quot;: \\\&quot;value2\\\&quot;, \\\&quot;key3\\\&quot;: \\\&quot;value3\\\&quot; } } } ]&lt;/code&gt;&lt;/pre&gt; &lt;/section&gt;
903
+ * @param {*} [options] Override http request option.
904
+ * @throws {RequiredError}
905
+ */
906
+ async uploadDocument(file: Array<File>, allowDuplicateFileNames?: boolean, parametersByFilename?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<UploadResponse>>> {
907
+ const localVarAxiosArgs = await localVarAxiosParamCreator.uploadDocument(file, allowDuplicateFileNames, parametersByFilename, options);
908
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
909
+ const localVarOperationServerBasePath = operationServerMap['DocumentControllerApi.uploadDocument']?.[localVarOperationServerIndex]?.url;
910
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
911
+ },
912
+ /**
913
+ * Uploads a single file, optionally with metadata and a parent folder ID.
914
+ * @summary Upload a single document
915
+ * @param {File} file
916
+ * @param {boolean} [allowDuplicateFileNames] when true : if a file with the same name already exists in the target parent folder, a 409 error is raised. When false : the file will be stored (but no existing file with same name will be overwritten)
917
+ * @param {string} [parentFolderId] Target parent folder ID to store the file; if not sent or null, the file is stored at the root level
918
+ * @param {string} [metadata]
919
+ * @param {*} [options] Override http request option.
920
+ * @throws {RequiredError}
921
+ */
922
+ async uploadDocument1(file: File, allowDuplicateFileNames?: boolean, parentFolderId?: string, metadata?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UploadResponse>> {
923
+ const localVarAxiosArgs = await localVarAxiosParamCreator.uploadDocument1(file, allowDuplicateFileNames, parentFolderId, metadata, options);
924
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
925
+ const localVarOperationServerBasePath = operationServerMap['DocumentControllerApi.uploadDocument1']?.[localVarOperationServerIndex]?.url;
926
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
927
+ },
928
+ }
929
+ };
930
+
931
+ /**
932
+ * DocumentControllerApi - factory interface
933
+ */
934
+ export const DocumentControllerApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
935
+ const localVarFp = DocumentControllerApiFp(configuration)
936
+ return {
937
+ /**
938
+ * Creates a new blank document (Word, Excel, PowerPoint, or Text) from a template in the specified folder.
939
+ * @summary Create a blank document from template
940
+ * @param {CreateBlankDocumentRequest} createBlankDocumentRequest
941
+ * @param {*} [options] Override http request option.
942
+ * @throws {RequiredError}
943
+ */
944
+ createBlankDocument(createBlankDocumentRequest: CreateBlankDocumentRequest, options?: RawAxiosRequestConfig): AxiosPromise<UploadResponse> {
945
+ return localVarFp.createBlankDocument(createBlankDocumentRequest, options).then((request) => request(axios, basePath));
946
+ },
947
+ /**
948
+ * Deletes specified metadata keys from a document.
949
+ * @summary Delete specific metadata keys
950
+ * @param {string} documentId
951
+ * @param {DeleteMetadataRequest} deleteMetadataRequest
952
+ * @param {*} [options] Override http request option.
953
+ * @throws {RequiredError}
954
+ */
955
+ deleteDocumentMetadata(documentId: string, deleteMetadataRequest: DeleteMetadataRequest, options?: RawAxiosRequestConfig): AxiosPromise<void> {
956
+ return localVarFp.deleteDocumentMetadata(documentId, deleteMetadataRequest, options).then((request) => request(axios, basePath));
957
+ },
958
+ /**
959
+ * Downloads a single file document.
960
+ * @summary Download a document
961
+ * @param {string} documentId
962
+ * @param {*} [options] Override http request option.
963
+ * @throws {RequiredError}
964
+ */
965
+ downloadDocument(documentId: string, options?: RawAxiosRequestConfig): AxiosPromise<File> {
966
+ return localVarFp.downloadDocument(documentId, options).then((request) => request(axios, basePath));
967
+ },
968
+ /**
969
+ * Internal endpoint for OnlyOffice DocumentServer to fetch document content. Uses token-based authentication.
970
+ * @summary Download document for OnlyOffice
971
+ * @param {string} documentId
972
+ * @param {string} token
973
+ * @param {*} [options] Override http request option.
974
+ * @throws {RequiredError}
975
+ */
976
+ downloadForOnlyOffice(documentId: string, token: string, options?: RawAxiosRequestConfig): AxiosPromise<File> {
977
+ return localVarFp.downloadForOnlyOffice(documentId, token, options).then((request) => request(axios, basePath));
978
+ },
979
+ /**
980
+ * Downloads multiple documents as a single ZIP file.
981
+ * @summary Download multiple documents as ZIP
982
+ * @param {Array<string>} requestBody
983
+ * @param {*} [options] Override http request option.
984
+ * @throws {RequiredError}
985
+ */
986
+ downloadMultipleDocumentsAsZip(requestBody: Array<string>, options?: RawAxiosRequestConfig): AxiosPromise<File> {
987
+ return localVarFp.downloadMultipleDocumentsAsZip(requestBody, options).then((request) => request(axios, basePath));
988
+ },
989
+ /**
990
+ * Retrieves all ancestor folders (parent path) of a document, ordered from root to immediate parent.
991
+ * @summary Get document ancestors
992
+ * @param {string} documentId
993
+ * @param {*} [options] Override http request option.
994
+ * @throws {RequiredError}
995
+ */
996
+ getDocumentAncestors(documentId: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<AncestorInfo>> {
997
+ return localVarFp.getDocumentAncestors(documentId, options).then((request) => request(axios, basePath));
998
+ },
999
+ /**
1000
+ * Retrieves information for a document.
1001
+ * @summary Get information of a document
1002
+ * @param {string} documentId
1003
+ * @param {boolean} [withMetadata] if false : only name, type and parentId are sent (when not null) - if true : metadata and size are added in the response
1004
+ * @param {*} [options] Override http request option.
1005
+ * @throws {RequiredError}
1006
+ */
1007
+ getDocumentInfo(documentId: string, withMetadata?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<DocumentInfo> {
1008
+ return localVarFp.getDocumentInfo(documentId, withMetadata, options).then((request) => request(axios, basePath));
1009
+ },
1010
+ /**
1011
+ * Retrieves metadata for a document. Can filter by keys.
1012
+ * @summary Search metadata of a document
1013
+ * @param {string} documentId
1014
+ * @param {SearchMetadataRequest} [searchMetadataRequest]
1015
+ * @param {*} [options] Override http request option.
1016
+ * @throws {RequiredError}
1017
+ */
1018
+ getDocumentMetadata(documentId: string, searchMetadataRequest?: SearchMetadataRequest, options?: RawAxiosRequestConfig): AxiosPromise<{ [key: string]: any; }> {
1019
+ return localVarFp.getDocumentMetadata(documentId, searchMetadataRequest, options).then((request) => request(axios, basePath));
1020
+ },
1021
+ /**
1022
+ * Retrieves the position of a document within its parent folder, useful for pagination.
1023
+ * @summary Get document position in folder
1024
+ * @param {string} documentId
1025
+ * @param {string} [sortBy] Field to sort by (name, updated_at, created_at, size, type). Defaults to \&#39;name\&#39;.
1026
+ * @param {string} [sortOrder] Sort order (ASC or DESC). Defaults to \&#39;ASC\&#39;.
1027
+ * @param {*} [options] Override http request option.
1028
+ * @throws {RequiredError}
1029
+ */
1030
+ getDocumentPosition(documentId: string, sortBy?: string, sortOrder?: string, options?: RawAxiosRequestConfig): AxiosPromise<DocumentPosition> {
1031
+ return localVarFp.getDocumentPosition(documentId, sortBy, sortOrder, options).then((request) => request(axios, basePath));
1032
+ },
1033
+ /**
1034
+ * Replaces the content of an existing file document.
1035
+ * @summary Replace document content
1036
+ * @param {string} documentId
1037
+ * @param {File} file
1038
+ * @param {*} [options] Override http request option.
1039
+ * @throws {RequiredError}
1040
+ */
1041
+ replaceDocumentContent(documentId: string, file: File, options?: RawAxiosRequestConfig): AxiosPromise<ElementInfo> {
1042
+ return localVarFp.replaceDocumentContent(documentId, file, options).then((request) => request(axios, basePath));
1043
+ },
1044
+ /**
1045
+ * Replaces all metadata of a document (file or folder).
1046
+ * @summary Replace document metadata
1047
+ * @param {string} documentId
1048
+ * @param {{ [key: string]: any; }} requestBody New metadata map. Replaces all existing metadata.
1049
+ * @param {*} [options] Override http request option.
1050
+ * @throws {RequiredError}
1051
+ */
1052
+ replaceDocumentMetadata(documentId: string, requestBody: { [key: string]: any; }, options?: RawAxiosRequestConfig): AxiosPromise<ElementInfo> {
1053
+ return localVarFp.replaceDocumentMetadata(documentId, requestBody, options).then((request) => request(axios, basePath));
1054
+ },
1055
+ /**
1056
+ * Finds document IDs matching all provided metadata criteria.
1057
+ * @summary Search document IDs by metadata
1058
+ * @param {SearchByMetadataRequest} searchByMetadataRequest
1059
+ * @param {*} [options] Override http request option.
1060
+ * @throws {RequiredError}
1061
+ */
1062
+ searchDocumentIdsByMetadata(searchByMetadataRequest: SearchByMetadataRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<string>> {
1063
+ return localVarFp.searchDocumentIdsByMetadata(searchByMetadataRequest, options).then((request) => request(axios, basePath));
1064
+ },
1065
+ /**
1066
+ * Updates or adds specific metadata fields for a document.
1067
+ * @summary Update document metadata
1068
+ * @param {string} documentId
1069
+ * @param {UpdateMetadataRequest} updateMetadataRequest
1070
+ * @param {*} [options] Override http request option.
1071
+ * @throws {RequiredError}
1072
+ */
1073
+ updateDocumentMetadata(documentId: string, updateMetadataRequest: UpdateMetadataRequest, options?: RawAxiosRequestConfig): AxiosPromise<ElementInfo> {
1074
+ return localVarFp.updateDocumentMetadata(documentId, updateMetadataRequest, options).then((request) => request(axios, basePath));
1075
+ },
1076
+ /**
1077
+ * Uploads multiple files, optionally with metadata and a parent folder ID. Returns HTTP 200 if all uploads succeed, HTTP 207 (Multi-Status) if some succeed and some fail, or an appropriate error status (404, 409, 403, 500) if all uploads fail.
1078
+ * @summary Upload multiple documents
1079
+ * @param {Array<File>} file
1080
+ * @param {boolean} [allowDuplicateFileNames] when true : if a file with the same name already exists in the target parent folder, a 409 error is raised. When false : the file will be stored (but no existing file with same name will be overwritten)
1081
+ * @param {string} [parametersByFilename] Paste the JSON array here&lt;br&gt;This array provides optional metadata and attributes for the uploaded files&lt;br&gt;&lt;section&gt; &lt;h3&gt;Each object in the array must contain:&lt;/h3&gt; &lt;table&gt; &lt;thead&gt; &lt;tr&gt; &lt;th&gt;Field&lt;/th&gt; &lt;th&gt;Type&lt;/th&gt; &lt;th&gt;Description&lt;/th&gt; &lt;/tr&gt; &lt;/thead&gt; &lt;tbody&gt; &lt;tr&gt; &lt;td&gt;&lt;code&gt;filename&lt;/code&gt;&lt;/td&gt; &lt;td&gt;&lt;code&gt;String&lt;/code&gt;&lt;/td&gt; &lt;td&gt;Must match the filename of one of the uploaded files. Filenames must be unique in the upload request.&lt;/td&gt; &lt;/tr&gt; &lt;tr&gt; &lt;td&gt;&lt;code&gt;fileAttributes&lt;/code&gt;&lt;/td&gt; &lt;td&gt;&lt;code&gt;JSON Object&lt;/code&gt;&lt;/td&gt; &lt;td&gt;Container for metadata and other file-specific attributes.&lt;/td&gt; &lt;/tr&gt; &lt;/tbody&gt; &lt;/table&gt; &lt;h4&gt;Inside &lt;code&gt;fileAttributes&lt;/code&gt;:&lt;/h4&gt; &lt;table&gt; &lt;thead&gt; &lt;tr&gt; &lt;th&gt;Field&lt;/th&gt; &lt;th&gt;Type&lt;/th&gt; &lt;th&gt;Description&lt;/th&gt; &lt;/tr&gt; &lt;/thead&gt; &lt;tbody&gt; &lt;tr&gt; &lt;td&gt;&lt;code&gt;parentFolderId&lt;/code&gt;&lt;/td&gt; &lt;td&gt;&lt;code&gt;UUID&lt;/code&gt;&lt;/td&gt; &lt;td&gt;UUID of the target folder to upload the file (if not provided : the file will be uploaded at the root level)&lt;/td&gt; &lt;/tr&gt; &lt;tr&gt; &lt;td&gt;&lt;code&gt;metadata&lt;/code&gt;&lt;/td&gt; &lt;td&gt;&lt;code&gt;Map&amp;lt;String, JSON Object&amp;gt;&lt;/code&gt;&lt;/td&gt; &lt;td&gt;Arbitrary metadata to associate with the file (key/value pairs).&lt;/td&gt; &lt;/tr&gt; &lt;/tbody&gt; &lt;/table&gt; &lt;h4&gt;Example of &lt;code&gt;parametersByFilename&lt;/code&gt; JSON array :&lt;/h4&gt; &lt;pre&gt;&lt;code&gt;[ { \\\&quot;filename\\\&quot;: \\\&quot;file1.txt\\\&quot;, \\\&quot;fileAttributes\\\&quot;: { \\\&quot;parentFolderId\\\&quot;: \\\&quot;f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454\\\&quot;, \\\&quot;metadata\\\&quot;: { \\\&quot;country\\\&quot;: \\\&quot;UK\\\&quot;, \\\&quot;owner\\\&quot;: { \\\&quot;name\\\&quot;: \\\&quot;Joe\\\&quot;, \\\&quot;owner_id\\\&quot;: 1234568 } } } }, { \\\&quot;filename\\\&quot;: \\\&quot;file2.md\\\&quot;, \\\&quot;fileAttributes\\\&quot;: { \\\&quot;metadata\\\&quot;: { \\\&quot;key1\\\&quot;: \\\&quot;value1\\\&quot;, \\\&quot;key2\\\&quot;: \\\&quot;value2\\\&quot;, \\\&quot;key3\\\&quot;: \\\&quot;value3\\\&quot; } } } ]&lt;/code&gt;&lt;/pre&gt; &lt;/section&gt;
1082
+ * @param {*} [options] Override http request option.
1083
+ * @throws {RequiredError}
1084
+ */
1085
+ uploadDocument(file: Array<File>, allowDuplicateFileNames?: boolean, parametersByFilename?: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<UploadResponse>> {
1086
+ return localVarFp.uploadDocument(file, allowDuplicateFileNames, parametersByFilename, options).then((request) => request(axios, basePath));
1087
+ },
1088
+ /**
1089
+ * Uploads a single file, optionally with metadata and a parent folder ID.
1090
+ * @summary Upload a single document
1091
+ * @param {File} file
1092
+ * @param {boolean} [allowDuplicateFileNames] when true : if a file with the same name already exists in the target parent folder, a 409 error is raised. When false : the file will be stored (but no existing file with same name will be overwritten)
1093
+ * @param {string} [parentFolderId] Target parent folder ID to store the file; if not sent or null, the file is stored at the root level
1094
+ * @param {string} [metadata]
1095
+ * @param {*} [options] Override http request option.
1096
+ * @throws {RequiredError}
1097
+ */
1098
+ uploadDocument1(file: File, allowDuplicateFileNames?: boolean, parentFolderId?: string, metadata?: string, options?: RawAxiosRequestConfig): AxiosPromise<UploadResponse> {
1099
+ return localVarFp.uploadDocument1(file, allowDuplicateFileNames, parentFolderId, metadata, options).then((request) => request(axios, basePath));
1100
+ },
1101
+ };
1102
+ };
1103
+
1104
+ /**
1105
+ * DocumentControllerApi - object-oriented interface
1106
+ */
1107
+ export class DocumentControllerApi extends BaseAPI {
1108
+ /**
1109
+ * Creates a new blank document (Word, Excel, PowerPoint, or Text) from a template in the specified folder.
1110
+ * @summary Create a blank document from template
1111
+ * @param {CreateBlankDocumentRequest} createBlankDocumentRequest
1112
+ * @param {*} [options] Override http request option.
1113
+ * @throws {RequiredError}
1114
+ */
1115
+ public createBlankDocument(createBlankDocumentRequest: CreateBlankDocumentRequest, options?: RawAxiosRequestConfig) {
1116
+ return DocumentControllerApiFp(this.configuration).createBlankDocument(createBlankDocumentRequest, options).then((request) => request(this.axios, this.basePath));
1117
+ }
1118
+
1119
+ /**
1120
+ * Deletes specified metadata keys from a document.
1121
+ * @summary Delete specific metadata keys
1122
+ * @param {string} documentId
1123
+ * @param {DeleteMetadataRequest} deleteMetadataRequest
1124
+ * @param {*} [options] Override http request option.
1125
+ * @throws {RequiredError}
1126
+ */
1127
+ public deleteDocumentMetadata(documentId: string, deleteMetadataRequest: DeleteMetadataRequest, options?: RawAxiosRequestConfig) {
1128
+ return DocumentControllerApiFp(this.configuration).deleteDocumentMetadata(documentId, deleteMetadataRequest, options).then((request) => request(this.axios, this.basePath));
1129
+ }
1130
+
1131
+ /**
1132
+ * Downloads a single file document.
1133
+ * @summary Download a document
1134
+ * @param {string} documentId
1135
+ * @param {*} [options] Override http request option.
1136
+ * @throws {RequiredError}
1137
+ */
1138
+ public downloadDocument(documentId: string, options?: RawAxiosRequestConfig) {
1139
+ return DocumentControllerApiFp(this.configuration).downloadDocument(documentId, options).then((request) => request(this.axios, this.basePath));
1140
+ }
1141
+
1142
+ /**
1143
+ * Internal endpoint for OnlyOffice DocumentServer to fetch document content. Uses token-based authentication.
1144
+ * @summary Download document for OnlyOffice
1145
+ * @param {string} documentId
1146
+ * @param {string} token
1147
+ * @param {*} [options] Override http request option.
1148
+ * @throws {RequiredError}
1149
+ */
1150
+ public downloadForOnlyOffice(documentId: string, token: string, options?: RawAxiosRequestConfig) {
1151
+ return DocumentControllerApiFp(this.configuration).downloadForOnlyOffice(documentId, token, options).then((request) => request(this.axios, this.basePath));
1152
+ }
1153
+
1154
+ /**
1155
+ * Downloads multiple documents as a single ZIP file.
1156
+ * @summary Download multiple documents as ZIP
1157
+ * @param {Array<string>} requestBody
1158
+ * @param {*} [options] Override http request option.
1159
+ * @throws {RequiredError}
1160
+ */
1161
+ public downloadMultipleDocumentsAsZip(requestBody: Array<string>, options?: RawAxiosRequestConfig) {
1162
+ return DocumentControllerApiFp(this.configuration).downloadMultipleDocumentsAsZip(requestBody, options).then((request) => request(this.axios, this.basePath));
1163
+ }
1164
+
1165
+ /**
1166
+ * Retrieves all ancestor folders (parent path) of a document, ordered from root to immediate parent.
1167
+ * @summary Get document ancestors
1168
+ * @param {string} documentId
1169
+ * @param {*} [options] Override http request option.
1170
+ * @throws {RequiredError}
1171
+ */
1172
+ public getDocumentAncestors(documentId: string, options?: RawAxiosRequestConfig) {
1173
+ return DocumentControllerApiFp(this.configuration).getDocumentAncestors(documentId, options).then((request) => request(this.axios, this.basePath));
1174
+ }
1175
+
1176
+ /**
1177
+ * Retrieves information for a document.
1178
+ * @summary Get information of a document
1179
+ * @param {string} documentId
1180
+ * @param {boolean} [withMetadata] if false : only name, type and parentId are sent (when not null) - if true : metadata and size are added in the response
1181
+ * @param {*} [options] Override http request option.
1182
+ * @throws {RequiredError}
1183
+ */
1184
+ public getDocumentInfo(documentId: string, withMetadata?: boolean, options?: RawAxiosRequestConfig) {
1185
+ return DocumentControllerApiFp(this.configuration).getDocumentInfo(documentId, withMetadata, options).then((request) => request(this.axios, this.basePath));
1186
+ }
1187
+
1188
+ /**
1189
+ * Retrieves metadata for a document. Can filter by keys.
1190
+ * @summary Search metadata of a document
1191
+ * @param {string} documentId
1192
+ * @param {SearchMetadataRequest} [searchMetadataRequest]
1193
+ * @param {*} [options] Override http request option.
1194
+ * @throws {RequiredError}
1195
+ */
1196
+ public getDocumentMetadata(documentId: string, searchMetadataRequest?: SearchMetadataRequest, options?: RawAxiosRequestConfig) {
1197
+ return DocumentControllerApiFp(this.configuration).getDocumentMetadata(documentId, searchMetadataRequest, options).then((request) => request(this.axios, this.basePath));
1198
+ }
1199
+
1200
+ /**
1201
+ * Retrieves the position of a document within its parent folder, useful for pagination.
1202
+ * @summary Get document position in folder
1203
+ * @param {string} documentId
1204
+ * @param {string} [sortBy] Field to sort by (name, updated_at, created_at, size, type). Defaults to \&#39;name\&#39;.
1205
+ * @param {string} [sortOrder] Sort order (ASC or DESC). Defaults to \&#39;ASC\&#39;.
1206
+ * @param {*} [options] Override http request option.
1207
+ * @throws {RequiredError}
1208
+ */
1209
+ public getDocumentPosition(documentId: string, sortBy?: string, sortOrder?: string, options?: RawAxiosRequestConfig) {
1210
+ return DocumentControllerApiFp(this.configuration).getDocumentPosition(documentId, sortBy, sortOrder, options).then((request) => request(this.axios, this.basePath));
1211
+ }
1212
+
1213
+ /**
1214
+ * Replaces the content of an existing file document.
1215
+ * @summary Replace document content
1216
+ * @param {string} documentId
1217
+ * @param {File} file
1218
+ * @param {*} [options] Override http request option.
1219
+ * @throws {RequiredError}
1220
+ */
1221
+ public replaceDocumentContent(documentId: string, file: File, options?: RawAxiosRequestConfig) {
1222
+ return DocumentControllerApiFp(this.configuration).replaceDocumentContent(documentId, file, options).then((request) => request(this.axios, this.basePath));
1223
+ }
1224
+
1225
+ /**
1226
+ * Replaces all metadata of a document (file or folder).
1227
+ * @summary Replace document metadata
1228
+ * @param {string} documentId
1229
+ * @param {{ [key: string]: any; }} requestBody New metadata map. Replaces all existing metadata.
1230
+ * @param {*} [options] Override http request option.
1231
+ * @throws {RequiredError}
1232
+ */
1233
+ public replaceDocumentMetadata(documentId: string, requestBody: { [key: string]: any; }, options?: RawAxiosRequestConfig) {
1234
+ return DocumentControllerApiFp(this.configuration).replaceDocumentMetadata(documentId, requestBody, options).then((request) => request(this.axios, this.basePath));
1235
+ }
1236
+
1237
+ /**
1238
+ * Finds document IDs matching all provided metadata criteria.
1239
+ * @summary Search document IDs by metadata
1240
+ * @param {SearchByMetadataRequest} searchByMetadataRequest
1241
+ * @param {*} [options] Override http request option.
1242
+ * @throws {RequiredError}
1243
+ */
1244
+ public searchDocumentIdsByMetadata(searchByMetadataRequest: SearchByMetadataRequest, options?: RawAxiosRequestConfig) {
1245
+ return DocumentControllerApiFp(this.configuration).searchDocumentIdsByMetadata(searchByMetadataRequest, options).then((request) => request(this.axios, this.basePath));
1246
+ }
1247
+
1248
+ /**
1249
+ * Updates or adds specific metadata fields for a document.
1250
+ * @summary Update document metadata
1251
+ * @param {string} documentId
1252
+ * @param {UpdateMetadataRequest} updateMetadataRequest
1253
+ * @param {*} [options] Override http request option.
1254
+ * @throws {RequiredError}
1255
+ */
1256
+ public updateDocumentMetadata(documentId: string, updateMetadataRequest: UpdateMetadataRequest, options?: RawAxiosRequestConfig) {
1257
+ return DocumentControllerApiFp(this.configuration).updateDocumentMetadata(documentId, updateMetadataRequest, options).then((request) => request(this.axios, this.basePath));
1258
+ }
1259
+
1260
+ /**
1261
+ * Uploads multiple files, optionally with metadata and a parent folder ID. Returns HTTP 200 if all uploads succeed, HTTP 207 (Multi-Status) if some succeed and some fail, or an appropriate error status (404, 409, 403, 500) if all uploads fail.
1262
+ * @summary Upload multiple documents
1263
+ * @param {Array<File>} file
1264
+ * @param {boolean} [allowDuplicateFileNames] when true : if a file with the same name already exists in the target parent folder, a 409 error is raised. When false : the file will be stored (but no existing file with same name will be overwritten)
1265
+ * @param {string} [parametersByFilename] Paste the JSON array here&lt;br&gt;This array provides optional metadata and attributes for the uploaded files&lt;br&gt;&lt;section&gt; &lt;h3&gt;Each object in the array must contain:&lt;/h3&gt; &lt;table&gt; &lt;thead&gt; &lt;tr&gt; &lt;th&gt;Field&lt;/th&gt; &lt;th&gt;Type&lt;/th&gt; &lt;th&gt;Description&lt;/th&gt; &lt;/tr&gt; &lt;/thead&gt; &lt;tbody&gt; &lt;tr&gt; &lt;td&gt;&lt;code&gt;filename&lt;/code&gt;&lt;/td&gt; &lt;td&gt;&lt;code&gt;String&lt;/code&gt;&lt;/td&gt; &lt;td&gt;Must match the filename of one of the uploaded files. Filenames must be unique in the upload request.&lt;/td&gt; &lt;/tr&gt; &lt;tr&gt; &lt;td&gt;&lt;code&gt;fileAttributes&lt;/code&gt;&lt;/td&gt; &lt;td&gt;&lt;code&gt;JSON Object&lt;/code&gt;&lt;/td&gt; &lt;td&gt;Container for metadata and other file-specific attributes.&lt;/td&gt; &lt;/tr&gt; &lt;/tbody&gt; &lt;/table&gt; &lt;h4&gt;Inside &lt;code&gt;fileAttributes&lt;/code&gt;:&lt;/h4&gt; &lt;table&gt; &lt;thead&gt; &lt;tr&gt; &lt;th&gt;Field&lt;/th&gt; &lt;th&gt;Type&lt;/th&gt; &lt;th&gt;Description&lt;/th&gt; &lt;/tr&gt; &lt;/thead&gt; &lt;tbody&gt; &lt;tr&gt; &lt;td&gt;&lt;code&gt;parentFolderId&lt;/code&gt;&lt;/td&gt; &lt;td&gt;&lt;code&gt;UUID&lt;/code&gt;&lt;/td&gt; &lt;td&gt;UUID of the target folder to upload the file (if not provided : the file will be uploaded at the root level)&lt;/td&gt; &lt;/tr&gt; &lt;tr&gt; &lt;td&gt;&lt;code&gt;metadata&lt;/code&gt;&lt;/td&gt; &lt;td&gt;&lt;code&gt;Map&amp;lt;String, JSON Object&amp;gt;&lt;/code&gt;&lt;/td&gt; &lt;td&gt;Arbitrary metadata to associate with the file (key/value pairs).&lt;/td&gt; &lt;/tr&gt; &lt;/tbody&gt; &lt;/table&gt; &lt;h4&gt;Example of &lt;code&gt;parametersByFilename&lt;/code&gt; JSON array :&lt;/h4&gt; &lt;pre&gt;&lt;code&gt;[ { \\\&quot;filename\\\&quot;: \\\&quot;file1.txt\\\&quot;, \\\&quot;fileAttributes\\\&quot;: { \\\&quot;parentFolderId\\\&quot;: \\\&quot;f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454\\\&quot;, \\\&quot;metadata\\\&quot;: { \\\&quot;country\\\&quot;: \\\&quot;UK\\\&quot;, \\\&quot;owner\\\&quot;: { \\\&quot;name\\\&quot;: \\\&quot;Joe\\\&quot;, \\\&quot;owner_id\\\&quot;: 1234568 } } } }, { \\\&quot;filename\\\&quot;: \\\&quot;file2.md\\\&quot;, \\\&quot;fileAttributes\\\&quot;: { \\\&quot;metadata\\\&quot;: { \\\&quot;key1\\\&quot;: \\\&quot;value1\\\&quot;, \\\&quot;key2\\\&quot;: \\\&quot;value2\\\&quot;, \\\&quot;key3\\\&quot;: \\\&quot;value3\\\&quot; } } } ]&lt;/code&gt;&lt;/pre&gt; &lt;/section&gt;
1266
+ * @param {*} [options] Override http request option.
1267
+ * @throws {RequiredError}
1268
+ */
1269
+ public uploadDocument(file: Array<File>, allowDuplicateFileNames?: boolean, parametersByFilename?: string, options?: RawAxiosRequestConfig) {
1270
+ return DocumentControllerApiFp(this.configuration).uploadDocument(file, allowDuplicateFileNames, parametersByFilename, options).then((request) => request(this.axios, this.basePath));
1271
+ }
1272
+
1273
+ /**
1274
+ * Uploads a single file, optionally with metadata and a parent folder ID.
1275
+ * @summary Upload a single document
1276
+ * @param {File} file
1277
+ * @param {boolean} [allowDuplicateFileNames] when true : if a file with the same name already exists in the target parent folder, a 409 error is raised. When false : the file will be stored (but no existing file with same name will be overwritten)
1278
+ * @param {string} [parentFolderId] Target parent folder ID to store the file; if not sent or null, the file is stored at the root level
1279
+ * @param {string} [metadata]
1280
+ * @param {*} [options] Override http request option.
1281
+ * @throws {RequiredError}
1282
+ */
1283
+ public uploadDocument1(file: File, allowDuplicateFileNames?: boolean, parentFolderId?: string, metadata?: string, options?: RawAxiosRequestConfig) {
1284
+ return DocumentControllerApiFp(this.configuration).uploadDocument1(file, allowDuplicateFileNames, parentFolderId, metadata, options).then((request) => request(this.axios, this.basePath));
1285
+ }
1286
+ }
1287
+