@openfilz-sdk/typescript 1.1.5-SNAPSHOT

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