docspace-api-sdk 4.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (1122) hide show
  1. checksums.yaml +7 -0
  2. data/AUTHORS.md +3 -0
  3. data/CHANGELOG.md +50 -0
  4. data/LICENSE +201 -0
  5. data/README.md +5310 -0
  6. data/lib/docspace-api-sdk/api/AI/agents-api.rb +605 -0
  7. data/lib/docspace-api-sdk/api/AI/ai-api.rb +517 -0
  8. data/lib/docspace-api-sdk/api/AI/assignments-api.rb +573 -0
  9. data/lib/docspace-api-sdk/api/AI/attachments-api.rb +585 -0
  10. data/lib/docspace-api-sdk/api/AI/context-api.rb +233 -0
  11. data/lib/docspace-api-sdk/api/AI/editor-tools-api.rb +156 -0
  12. data/lib/docspace-api-sdk/api/AI/export-api.rb +97 -0
  13. data/lib/docspace-api-sdk/api/AI/open-ai-passthrough-api.rb +179 -0
  14. data/lib/docspace-api-sdk/api/AI/preferences-api.rb +555 -0
  15. data/lib/docspace-api-sdk/api/AI/profiles-api.rb +568 -0
  16. data/lib/docspace-api-sdk/api/AI/prompts-api.rb +899 -0
  17. data/lib/docspace-api-sdk/api/AI/settings-api.rb +473 -0
  18. data/lib/docspace-api-sdk/api/AI/threads-api.rb +1005 -0
  19. data/lib/docspace-api-sdk/api/AI/tools-api.rb +923 -0
  20. data/lib/docspace-api-sdk/api/AI/vectorization-api.rb +97 -0
  21. data/lib/docspace-api-sdk/api/AI/web-search-api.rb +571 -0
  22. data/lib/docspace-api-sdk/api/ApiKeys/api-keys-api.rb +411 -0
  23. data/lib/docspace-api-sdk/api/Apps/apps-api.rb +368 -0
  24. data/lib/docspace-api-sdk/api/Authentication/authentication-api.rb +481 -0
  25. data/lib/docspace-api-sdk/api/Backup/backup-api.rb +916 -0
  26. data/lib/docspace-api-sdk/api/Capabilities/capabilities-api.rb +86 -0
  27. data/lib/docspace-api-sdk/api/Docs/docs-api.rb +159 -0
  28. data/lib/docspace-api-sdk/api/Files/files-api.rb +3705 -0
  29. data/lib/docspace-api-sdk/api/Files/folders-api.rb +2611 -0
  30. data/lib/docspace-api-sdk/api/Files/metadata-api.rb +1465 -0
  31. data/lib/docspace-api-sdk/api/Files/operations-api.rb +1722 -0
  32. data/lib/docspace-api-sdk/api/Files/quota-api.rb +159 -0
  33. data/lib/docspace-api-sdk/api/Files/settings-api.rb +1973 -0
  34. data/lib/docspace-api-sdk/api/Files/sharing-api.rb +1126 -0
  35. data/lib/docspace-api-sdk/api/Files/third-party-integration-api.rb +522 -0
  36. data/lib/docspace-api-sdk/api/Group/group-api.rb +830 -0
  37. data/lib/docspace-api-sdk/api/Group/search-api.rb +282 -0
  38. data/lib/docspace-api-sdk/api/Migration/migration-api.rb +519 -0
  39. data/lib/docspace-api-sdk/api/OAuth20/authorization-api.rb +262 -0
  40. data/lib/docspace-api-sdk/api/OAuth20/client-management-api.rb +582 -0
  41. data/lib/docspace-api-sdk/api/OAuth20/client-querying-api.rb +467 -0
  42. data/lib/docspace-api-sdk/api/OAuth20/discovery-api.rb +84 -0
  43. data/lib/docspace-api-sdk/api/OAuth20/scope-management-api.rb +86 -0
  44. data/lib/docspace-api-sdk/api/People/email-api.rb +169 -0
  45. data/lib/docspace-api-sdk/api/People/guests-api.rb +159 -0
  46. data/lib/docspace-api-sdk/api/People/password-api.rb +169 -0
  47. data/lib/docspace-api-sdk/api/People/photos-api.rb +389 -0
  48. data/lib/docspace-api-sdk/api/People/profiles-api.rb +986 -0
  49. data/lib/docspace-api-sdk/api/People/quota-api.rb +159 -0
  50. data/lib/docspace-api-sdk/api/People/search-api.rb +1150 -0
  51. data/lib/docspace-api-sdk/api/People/theme-api.rb +152 -0
  52. data/lib/docspace-api-sdk/api/People/third-party-accounts-api.rb +292 -0
  53. data/lib/docspace-api-sdk/api/People/user-data-api.rb +663 -0
  54. data/lib/docspace-api-sdk/api/People/user-status-api.rb +273 -0
  55. data/lib/docspace-api-sdk/api/People/user-type-api.rb +300 -0
  56. data/lib/docspace-api-sdk/api/Portal/guests-api.rb +92 -0
  57. data/lib/docspace-api-sdk/api/Portal/payment-api.rb +2571 -0
  58. data/lib/docspace-api-sdk/api/Portal/quota-api.rb +328 -0
  59. data/lib/docspace-api-sdk/api/Portal/settings-api.rb +502 -0
  60. data/lib/docspace-api-sdk/api/Portal/users-api.rb +611 -0
  61. data/lib/docspace-api-sdk/api/Rooms/groups-api.rb +442 -0
  62. data/lib/docspace-api-sdk/api/Rooms/privacy-room-api.rb +348 -0
  63. data/lib/docspace-api-sdk/api/Rooms/rooms-api.rb +3121 -0
  64. data/lib/docspace-api-sdk/api/Security/access-to-dev-tools-api.rb +93 -0
  65. data/lib/docspace-api-sdk/api/Security/active-connections-api.rb +334 -0
  66. data/lib/docspace-api-sdk/api/Security/audit-trail-data-api.rb +618 -0
  67. data/lib/docspace-api-sdk/api/Security/banners-visibility-api.rb +93 -0
  68. data/lib/docspace-api-sdk/api/Security/csp-api.rb +152 -0
  69. data/lib/docspace-api-sdk/api/Security/firebase-api.rb +159 -0
  70. data/lib/docspace-api-sdk/api/Security/login-history-api.rb +357 -0
  71. data/lib/docspace-api-sdk/api/Security/o-auth2-api.rb +86 -0
  72. data/lib/docspace-api-sdk/api/Security/smtp-settings-api.rb +329 -0
  73. data/lib/docspace-api-sdk/api/Settings/access-to-dev-tools-api.rb +86 -0
  74. data/lib/docspace-api-sdk/api/Settings/authorization-api.rb +218 -0
  75. data/lib/docspace-api-sdk/api/Settings/banners-visibility-api.rb +86 -0
  76. data/lib/docspace-api-sdk/api/Settings/common-settings-api.rb +1398 -0
  77. data/lib/docspace-api-sdk/api/Settings/cookies-api.rb +152 -0
  78. data/lib/docspace-api-sdk/api/Settings/docs-cloud-api.rb +771 -0
  79. data/lib/docspace-api-sdk/api/Settings/encryption-api.rb +211 -0
  80. data/lib/docspace-api-sdk/api/Settings/greeting-settings-api.rb +270 -0
  81. data/lib/docspace-api-sdk/api/Settings/ip-restrictions-api.rb +277 -0
  82. data/lib/docspace-api-sdk/api/Settings/license-api.rb +275 -0
  83. data/lib/docspace-api-sdk/api/Settings/login-settings-api.rb +211 -0
  84. data/lib/docspace-api-sdk/api/Settings/messages-api.rb +225 -0
  85. data/lib/docspace-api-sdk/api/Settings/notifications-api.rb +342 -0
  86. data/lib/docspace-api-sdk/api/Settings/owner-api.rb +159 -0
  87. data/lib/docspace-api-sdk/api/Settings/quota-api.rb +284 -0
  88. data/lib/docspace-api-sdk/api/Settings/rebranding-api.rb +1112 -0
  89. data/lib/docspace-api-sdk/api/Settings/security-api.rb +674 -0
  90. data/lib/docspace-api-sdk/api/Settings/sso-api.rb +329 -0
  91. data/lib/docspace-api-sdk/api/Settings/statistics-api.rb +92 -0
  92. data/lib/docspace-api-sdk/api/Settings/storage-api.rb +575 -0
  93. data/lib/docspace-api-sdk/api/Settings/telegram-api.rb +204 -0
  94. data/lib/docspace-api-sdk/api/Settings/tfa-settings-api.rb +586 -0
  95. data/lib/docspace-api-sdk/api/Settings/webhooks-api.rb +636 -0
  96. data/lib/docspace-api-sdk/api/Settings/webplugins-api.rb +422 -0
  97. data/lib/docspace-api-sdk/api/ThirdParty/third-party-api.rb +92 -0
  98. data/lib/docspace-api-sdk/api-client.rb +407 -0
  99. data/lib/docspace-api-sdk/api-error.rb +63 -0
  100. data/lib/docspace-api-sdk/api-model-base.rb +91 -0
  101. data/lib/docspace-api-sdk/configuration.rb +367 -0
  102. data/lib/docspace-api-sdk/models/access-request-key-dto.rb +173 -0
  103. data/lib/docspace-api-sdk/models/account-entry-array-wrapper.rb +196 -0
  104. data/lib/docspace-api-sdk/models/account-entry-dto.rb +108 -0
  105. data/lib/docspace-api-sdk/models/account-info-array-wrapper.rb +196 -0
  106. data/lib/docspace-api-sdk/models/account-info-dto.rb +195 -0
  107. data/lib/docspace-api-sdk/models/account-login-type.rb +44 -0
  108. data/lib/docspace-api-sdk/models/account-search-area.rb +44 -0
  109. data/lib/docspace-api-sdk/models/ace-short-array-wrapper.rb +196 -0
  110. data/lib/docspace-api-sdk/models/ace-short-dto.rb +174 -0
  111. data/lib/docspace-api-sdk/models/action-link-action-request.rb +212 -0
  112. data/lib/docspace-api-sdk/models/action-link-request.rb +152 -0
  113. data/lib/docspace-api-sdk/models/action-type.rb +61 -0
  114. data/lib/docspace-api-sdk/models/active-connections-dto.rb +182 -0
  115. data/lib/docspace-api-sdk/models/active-connections-item-dto.rb +309 -0
  116. data/lib/docspace-api-sdk/models/active-connections-wrapper.rb +194 -0
  117. data/lib/docspace-api-sdk/models/active-service-array-wrapper.rb +196 -0
  118. data/lib/docspace-api-sdk/models/active-service-dto.rb +207 -0
  119. data/lib/docspace-api-sdk/models/additional-resources-dto.rb +212 -0
  120. data/lib/docspace-api-sdk/models/additional-resources-wrapper.rb +194 -0
  121. data/lib/docspace-api-sdk/models/additional-white-label-settings-dto.rb +331 -0
  122. data/lib/docspace-api-sdk/models/additional-white-label-settings-request-dto.rb +152 -0
  123. data/lib/docspace-api-sdk/models/additional-white-label-settings-wrapper.rb +194 -0
  124. data/lib/docspace-api-sdk/models/admin-message-base-settings-request-dto.rb +190 -0
  125. data/lib/docspace-api-sdk/models/admin-message-settings-request-dto.rb +270 -0
  126. data/lib/docspace-api-sdk/models/ai-action-args-prompt.rb +218 -0
  127. data/lib/docspace-api-sdk/models/ai-action-args.rb +204 -0
  128. data/lib/docspace-api-sdk/models/ai-action-type.rb +51 -0
  129. data/lib/docspace-api-sdk/models/ai-agent-new-items-dto.rb +184 -0
  130. data/lib/docspace-api-sdk/models/ai-agents-create-request.rb +329 -0
  131. data/lib/docspace-api-sdk/models/ai-agents-delete-request.rb +151 -0
  132. data/lib/docspace-api-sdk/models/ai-agents-get200-response-all-of-response.rb +151 -0
  133. data/lib/docspace-api-sdk/models/ai-agents-get200-response.rb +199 -0
  134. data/lib/docspace-api-sdk/models/ai-agents-reset-quota-request.rb +170 -0
  135. data/lib/docspace-api-sdk/models/ai-agents-update-quota-request-room-ids-inner.rb +107 -0
  136. data/lib/docspace-api-sdk/models/ai-agents-update-quota-request.rb +197 -0
  137. data/lib/docspace-api-sdk/models/ai-agents-update-request.rb +283 -0
  138. data/lib/docspace-api-sdk/models/ai-api-date-time.rb +162 -0
  139. data/lib/docspace-api-sdk/models/ai-approve-tool-call-request.rb +301 -0
  140. data/lib/docspace-api-sdk/models/ai-assignment-mutation-result.rb +179 -0
  141. data/lib/docspace-api-sdk/models/ai-assignments-assign-request.rb +217 -0
  142. data/lib/docspace-api-sdk/models/ai-assignments-cascade-profile-delete-request.rb +168 -0
  143. data/lib/docspace-api-sdk/models/ai-attachment-form-keys-inner.rb +193 -0
  144. data/lib/docspace-api-sdk/models/ai-attachment.rb +388 -0
  145. data/lib/docspace-api-sdk/models/ai-attachments-link-to-message-request.rb +224 -0
  146. data/lib/docspace-api-sdk/models/ai-attachments-save-file-request-input.rb +233 -0
  147. data/lib/docspace-api-sdk/models/ai-attachments-save-file-request.rb +177 -0
  148. data/lib/docspace-api-sdk/models/ai-attachments-save-files-many-request.rb +178 -0
  149. data/lib/docspace-api-sdk/models/ai-builtin-provider-type.rb +58 -0
  150. data/lib/docspace-api-sdk/models/ai-bulk-assignment-result-errors-inner.rb +215 -0
  151. data/lib/docspace-api-sdk/models/ai-bulk-assignment-result.rb +181 -0
  152. data/lib/docspace-api-sdk/models/ai-chat-event.rb +273 -0
  153. data/lib/docspace-api-sdk/models/ai-chat-price-dto.rb +195 -0
  154. data/lib/docspace-api-sdk/models/ai-chat-settings-dto.rb +153 -0
  155. data/lib/docspace-api-sdk/models/ai-chat-tool-permission-mode.rb +44 -0
  156. data/lib/docspace-api-sdk/models/ai-chat-tool-prefs-scope.rb +43 -0
  157. data/lib/docspace-api-sdk/models/ai-config-dto.rb +152 -0
  158. data/lib/docspace-api-sdk/models/ai-create-profile-input.rb +374 -0
  159. data/lib/docspace-api-sdk/models/ai-create-prompt-input.rb +207 -0
  160. data/lib/docspace-api-sdk/models/ai-distributed-task-status.rb +46 -0
  161. data/lib/docspace-api-sdk/models/ai-editor-tools-call-request.rb +190 -0
  162. data/lib/docspace-api-sdk/models/ai-editor-tools-call200-response.rb +168 -0
  163. data/lib/docspace-api-sdk/models/ai-editor-tools-list200-response-tools-inner.rb +251 -0
  164. data/lib/docspace-api-sdk/models/ai-editor-tools-list200-response.rb +170 -0
  165. data/lib/docspace-api-sdk/models/ai-embedding-price-dto.rb +152 -0
  166. data/lib/docspace-api-sdk/models/ai-embedding-provider-type.rb +45 -0
  167. data/lib/docspace-api-sdk/models/ai-employee-dto.rb +249 -0
  168. data/lib/docspace-api-sdk/models/ai-entry-pricing-dto-ai-chat-price-dto.rb +234 -0
  169. data/lib/docspace-api-sdk/models/ai-entry-pricing-dto-ai-embedding-price-dto.rb +234 -0
  170. data/lib/docspace-api-sdk/models/ai-entry-pricing-dto-ai-image-price-dto.rb +234 -0
  171. data/lib/docspace-api-sdk/models/ai-entry-pricing-dto-decimal.rb +234 -0
  172. data/lib/docspace-api-sdk/models/ai-error-code.rb +45 -0
  173. data/lib/docspace-api-sdk/models/ai-error-data.rb +230 -0
  174. data/lib/docspace-api-sdk/models/ai-error-response.rb +169 -0
  175. data/lib/docspace-api-sdk/models/ai-export-text-to-docx-request-folder-id.rb +107 -0
  176. data/lib/docspace-api-sdk/models/ai-export-text-to-docx-request.rb +221 -0
  177. data/lib/docspace-api-sdk/models/ai-export-text-to-docx202-response.rb +168 -0
  178. data/lib/docspace-api-sdk/models/ai-file-entry-base-dto.rb +391 -0
  179. data/lib/docspace-api-sdk/models/ai-file-entry-dto-all-of-available-share-rights.rb +197 -0
  180. data/lib/docspace-api-sdk/models/ai-file-entry-dto-all-of-security.rb +565 -0
  181. data/lib/docspace-api-sdk/models/ai-file-entry-dto-all-of-share-settings.rb +187 -0
  182. data/lib/docspace-api-sdk/models/ai-file-entry-dto.rb +562 -0
  183. data/lib/docspace-api-sdk/models/ai-file-entry-type.rb +43 -0
  184. data/lib/docspace-api-sdk/models/ai-file-operation-dto.rb +331 -0
  185. data/lib/docspace-api-sdk/models/ai-file-operation-type.rb +50 -0
  186. data/lib/docspace-api-sdk/models/ai-file-operation-wrapper.rb +194 -0
  187. data/lib/docspace-api-sdk/models/ai-file-share.rb +53 -0
  188. data/lib/docspace-api-sdk/models/ai-folder-array-wrapper.rb +196 -0
  189. data/lib/docspace-api-sdk/models/ai-folder-content-dto.rb +247 -0
  190. data/lib/docspace-api-sdk/models/ai-folder-content-wrapper.rb +194 -0
  191. data/lib/docspace-api-sdk/models/ai-folder-dto.rb +838 -0
  192. data/lib/docspace-api-sdk/models/ai-folder-mutation-result.rb +189 -0
  193. data/lib/docspace-api-sdk/models/ai-folder-type.rb +72 -0
  194. data/lib/docspace-api-sdk/models/ai-folder-wrapper.rb +194 -0
  195. data/lib/docspace-api-sdk/models/ai-image-price-dto.rb +172 -0
  196. data/lib/docspace-api-sdk/models/ai-import-error.rb +247 -0
  197. data/lib/docspace-api-sdk/models/ai-import-mode.rb +43 -0
  198. data/lib/docspace-api-sdk/models/ai-import-result-imported.rb +194 -0
  199. data/lib/docspace-api-sdk/models/ai-import-result.rb +190 -0
  200. data/lib/docspace-api-sdk/models/ai-logo-cover-dto.rb +168 -0
  201. data/lib/docspace-api-sdk/models/ai-logo-dto.rb +215 -0
  202. data/lib/docspace-api-sdk/models/ai-mcp-item.rb +263 -0
  203. data/lib/docspace-api-sdk/models/ai-metadata-match-dto.rb +186 -0
  204. data/lib/docspace-api-sdk/models/ai-model.rb +263 -0
  205. data/lib/docspace-api-sdk/models/ai-new-items-agent-new-items-array-wrapper.rb +196 -0
  206. data/lib/docspace-api-sdk/models/ai-new-items-dto-agent-new-items-dto.rb +184 -0
  207. data/lib/docspace-api-sdk/models/ai-open-ai-chat-completion-chunk.rb +303 -0
  208. data/lib/docspace-api-sdk/models/ai-open-ai-choice-delta.rb +209 -0
  209. data/lib/docspace-api-sdk/models/ai-open-ai-chunk-choice.rb +231 -0
  210. data/lib/docspace-api-sdk/models/ai-open-ai-finish-reason.rb +45 -0
  211. data/lib/docspace-api-sdk/models/ai-open-ai-stream-chunk.rb +107 -0
  212. data/lib/docspace-api-sdk/models/ai-open-ai-stream-error-error.rb +218 -0
  213. data/lib/docspace-api-sdk/models/ai-open-ai-stream-error.rb +168 -0
  214. data/lib/docspace-api-sdk/models/ai-open-ai-tool-call-delta-function.rb +160 -0
  215. data/lib/docspace-api-sdk/models/ai-open-ai-tool-call-delta.rb +232 -0
  216. data/lib/docspace-api-sdk/models/ai-open-or-create-result.rb +225 -0
  217. data/lib/docspace-api-sdk/models/ai-openai-chat-completions403-response-error.rb +217 -0
  218. data/lib/docspace-api-sdk/models/ai-openai-chat-completions403-response.rb +167 -0
  219. data/lib/docspace-api-sdk/models/ai-openai-images-generations403-response-error.rb +217 -0
  220. data/lib/docspace-api-sdk/models/ai-openai-images-generations403-response.rb +167 -0
  221. data/lib/docspace-api-sdk/models/ai-preferences-set-deep-mode-request.rb +177 -0
  222. data/lib/docspace-api-sdk/models/ai-preferences-set-reasoning-level-request.rb +199 -0
  223. data/lib/docspace-api-sdk/models/ai-preferences-set-tool-permission-mode-request.rb +199 -0
  224. data/lib/docspace-api-sdk/models/ai-price-currency-dto.rb +168 -0
  225. data/lib/docspace-api-sdk/models/ai-prices-dto.rb +229 -0
  226. data/lib/docspace-api-sdk/models/ai-prices-wrapper.rb +194 -0
  227. data/lib/docspace-api-sdk/models/ai-profile-mutation-result.rb +189 -0
  228. data/lib/docspace-api-sdk/models/ai-profile.rb +411 -0
  229. data/lib/docspace-api-sdk/models/ai-profiles-create400-response.rb +106 -0
  230. data/lib/docspace-api-sdk/models/ai-profiles-get-by-id200-response.rb +388 -0
  231. data/lib/docspace-api-sdk/models/ai-profiles-list-provider-models-request.rb +205 -0
  232. data/lib/docspace-api-sdk/models/ai-profiles-list-provider-models400-response-any-of.rb +195 -0
  233. data/lib/docspace-api-sdk/models/ai-profiles-list-provider-models400-response.rb +106 -0
  234. data/lib/docspace-api-sdk/models/ai-profiles-test-connection200-response-any-of.rb +150 -0
  235. data/lib/docspace-api-sdk/models/ai-profiles-test-connection200-response.rb +106 -0
  236. data/lib/docspace-api-sdk/models/ai-prompt-bundle.rb +251 -0
  237. data/lib/docspace-api-sdk/models/ai-prompt-folder.rb +250 -0
  238. data/lib/docspace-api-sdk/models/ai-prompt-mutation-result.rb +189 -0
  239. data/lib/docspace-api-sdk/models/ai-prompt.rb +287 -0
  240. data/lib/docspace-api-sdk/models/ai-prompts-import-bundle-request-options.rb +173 -0
  241. data/lib/docspace-api-sdk/models/ai-prompts-import-bundle-request.rb +177 -0
  242. data/lib/docspace-api-sdk/models/ai-prompts-move-request.rb +181 -0
  243. data/lib/docspace-api-sdk/models/ai-prompts-rename-folder-request.rb +195 -0
  244. data/lib/docspace-api-sdk/models/ai-prompts-update-request-updates.rb +170 -0
  245. data/lib/docspace-api-sdk/models/ai-prompts-update-request.rb +194 -0
  246. data/lib/docspace-api-sdk/models/ai-provider-type.rb +107 -0
  247. data/lib/docspace-api-sdk/models/ai-provider.rb +233 -0
  248. data/lib/docspace-api-sdk/models/ai-reasoning-depth.rb +45 -0
  249. data/lib/docspace-api-sdk/models/ai-reasoning-level.rb +46 -0
  250. data/lib/docspace-api-sdk/models/ai-reasoning-support.rb +257 -0
  251. data/lib/docspace-api-sdk/models/ai-regenerate-stream-request.rb +198 -0
  252. data/lib/docspace-api-sdk/models/ai-resolved-assignment.rb +196 -0
  253. data/lib/docspace-api-sdk/models/ai-room-data-lifetime-dto.rb +230 -0
  254. data/lib/docspace-api-sdk/models/ai-room-data-lifetime-period.rb +44 -0
  255. data/lib/docspace-api-sdk/models/ai-room-type.rb +47 -0
  256. data/lib/docspace-api-sdk/models/ai-send-custom-request.rb +231 -0
  257. data/lib/docspace-api-sdk/models/ai-send-request.rb +237 -0
  258. data/lib/docspace-api-sdk/models/ai-send-stream-body.rb +209 -0
  259. data/lib/docspace-api-sdk/models/ai-settings-dto.rb +238 -0
  260. data/lib/docspace-api-sdk/models/ai-settings-wrapper.rb +194 -0
  261. data/lib/docspace-api-sdk/models/ai-success-response.rb +169 -0
  262. data/lib/docspace-api-sdk/models/ai-thread-message-like-content-any-of-inner.rb +176 -0
  263. data/lib/docspace-api-sdk/models/ai-thread-message-like-content.rb +107 -0
  264. data/lib/docspace-api-sdk/models/ai-thread-message-like-status.rb +168 -0
  265. data/lib/docspace-api-sdk/models/ai-thread-message-like.rb +270 -0
  266. data/lib/docspace-api-sdk/models/ai-thread.rb +219 -0
  267. data/lib/docspace-api-sdk/models/ai-threads-append-user-message-request.rb +203 -0
  268. data/lib/docspace-api-sdk/models/ai-threads-append-user-message200-response.rb +168 -0
  269. data/lib/docspace-api-sdk/models/ai-threads-create-request.rb +188 -0
  270. data/lib/docspace-api-sdk/models/ai-threads-open-or-create-request-entity-meta.rb +160 -0
  271. data/lib/docspace-api-sdk/models/ai-threads-open-or-create-request.rb +249 -0
  272. data/lib/docspace-api-sdk/models/ai-threads-regenerate-title-request.rb +203 -0
  273. data/lib/docspace-api-sdk/models/ai-threads-regenerate-title200-response.rb +168 -0
  274. data/lib/docspace-api-sdk/models/ai-threads-rename-request.rb +194 -0
  275. data/lib/docspace-api-sdk/models/ai-threads-touch-request.rb +176 -0
  276. data/lib/docspace-api-sdk/models/ai-threads-update-message-request.rb +194 -0
  277. data/lib/docspace-api-sdk/models/ai-tool-annotations.rb +187 -0
  278. data/lib/docspace-api-sdk/models/ai-tool-call-data.rb +280 -0
  279. data/lib/docspace-api-sdk/models/ai-tool-permission-mode.rb +44 -0
  280. data/lib/docspace-api-sdk/models/ai-tools-add-custom-server-request.rb +204 -0
  281. data/lib/docspace-api-sdk/models/ai-tools-bulk-result-errors-inner.rb +193 -0
  282. data/lib/docspace-api-sdk/models/ai-tools-bulk-result.rb +181 -0
  283. data/lib/docspace-api-sdk/models/ai-tools-list-system-tools200-response.rb +228 -0
  284. data/lib/docspace-api-sdk/models/ai-tools-mutation-result.rb +179 -0
  285. data/lib/docspace-api-sdk/models/ai-tools-remove-custom-server-request.rb +176 -0
  286. data/lib/docspace-api-sdk/models/ai-tools-replace-all-custom-servers-request.rb +179 -0
  287. data/lib/docspace-api-sdk/models/ai-tools-set-allow-always-request.rb +229 -0
  288. data/lib/docspace-api-sdk/models/ai-tools-set-disabled-request.rb +237 -0
  289. data/lib/docspace-api-sdk/models/ai-tools-update-custom-server-request.rb +203 -0
  290. data/lib/docspace-api-sdk/models/ai-user-settings-dto.rb +184 -0
  291. data/lib/docspace-api-sdk/models/ai-user-settings-wrapper.rb +194 -0
  292. data/lib/docspace-api-sdk/models/ai-vectorization-settings-dto.rb +184 -0
  293. data/lib/docspace-api-sdk/models/ai-vectorization-settings-wrapper.rb +194 -0
  294. data/lib/docspace-api-sdk/models/ai-vectorization-start-task-request.rb +170 -0
  295. data/lib/docspace-api-sdk/models/ai-vectorization-start-task200-response.rb +222 -0
  296. data/lib/docspace-api-sdk/models/ai-watermark-additions.rb +46 -0
  297. data/lib/docspace-api-sdk/models/ai-watermark-dto.rb +321 -0
  298. data/lib/docspace-api-sdk/models/ai-web-search-config.rb +211 -0
  299. data/lib/docspace-api-sdk/models/ai-web-search-configure-request.rb +176 -0
  300. data/lib/docspace-api-sdk/models/ai-web-search-configure400-response.rb +106 -0
  301. data/lib/docspace-api-sdk/models/ai-web-search-mutation-result.rb +189 -0
  302. data/lib/docspace-api-sdk/models/ai-web-search-set-active-config-request.rb +176 -0
  303. data/lib/docspace-api-sdk/models/amazon-s3-region-array-wrapper.rb +196 -0
  304. data/lib/docspace-api-sdk/models/amazon-s3-region-dto.rb +208 -0
  305. data/lib/docspace-api-sdk/models/anonymous-config-dto.rb +169 -0
  306. data/lib/docspace-api-sdk/models/api-date-time.rb +162 -0
  307. data/lib/docspace-api-sdk/models/api-key-response-array-wrapper.rb +196 -0
  308. data/lib/docspace-api-sdk/models/api-key-response-dto.rb +288 -0
  309. data/lib/docspace-api-sdk/models/api-key-response-wrapper.rb +194 -0
  310. data/lib/docspace-api-sdk/models/app-array-wrapper.rb +196 -0
  311. data/lib/docspace-api-sdk/models/app-dto.rb +173 -0
  312. data/lib/docspace-api-sdk/models/app-wrapper.rb +194 -0
  313. data/lib/docspace-api-sdk/models/apply-filter-option.rb +44 -0
  314. data/lib/docspace-api-sdk/models/archive-room-request.rb +152 -0
  315. data/lib/docspace-api-sdk/models/array-array-wrapper.rb +196 -0
  316. data/lib/docspace-api-sdk/models/assign-metadata-templates.rb +199 -0
  317. data/lib/docspace-api-sdk/models/audit-event-array-wrapper.rb +196 -0
  318. data/lib/docspace-api-sdk/models/audit-event-dto.rb +359 -0
  319. data/lib/docspace-api-sdk/models/audit-report-format.rb +43 -0
  320. data/lib/docspace-api-sdk/models/audit-trail-action-dto.rb +175 -0
  321. data/lib/docspace-api-sdk/models/audit-trail-module-dto.rb +166 -0
  322. data/lib/docspace-api-sdk/models/audit-trail-product-array-wrapper.rb +196 -0
  323. data/lib/docspace-api-sdk/models/audit-trail-product-dto.rb +166 -0
  324. data/lib/docspace-api-sdk/models/audit-trail-types-dto.rb +207 -0
  325. data/lib/docspace-api-sdk/models/audit-trail-types-wrapper.rb +194 -0
  326. data/lib/docspace-api-sdk/models/auth-key-dto.rb +249 -0
  327. data/lib/docspace-api-sdk/models/auth-key-request.rb +249 -0
  328. data/lib/docspace-api-sdk/models/auth-request-dto.rb +293 -0
  329. data/lib/docspace-api-sdk/models/auth-service-array-wrapper.rb +196 -0
  330. data/lib/docspace-api-sdk/models/auth-service-dto.rb +219 -0
  331. data/lib/docspace-api-sdk/models/auth-with-code-request-dto.rb +302 -0
  332. data/lib/docspace-api-sdk/models/authentication-token-dto.rb +216 -0
  333. data/lib/docspace-api-sdk/models/authentication-token-wrapper.rb +194 -0
  334. data/lib/docspace-api-sdk/models/auto-clean-up-data-dto.rb +184 -0
  335. data/lib/docspace-api-sdk/models/auto-clean-up-data-wrapper.rb +194 -0
  336. data/lib/docspace-api-sdk/models/auto-cleanup-request-dto.rb +184 -0
  337. data/lib/docspace-api-sdk/models/backup-cron-request.rb +195 -0
  338. data/lib/docspace-api-sdk/models/backup-history-record-array-wrapper.rb +196 -0
  339. data/lib/docspace-api-sdk/models/backup-history-record-dto.rb +285 -0
  340. data/lib/docspace-api-sdk/models/backup-period.rb +44 -0
  341. data/lib/docspace-api-sdk/models/backup-progress-dto.rb +258 -0
  342. data/lib/docspace-api-sdk/models/backup-progress-enum.rb +44 -0
  343. data/lib/docspace-api-sdk/models/backup-progress-wrapper.rb +194 -0
  344. data/lib/docspace-api-sdk/models/backup-service-state-dto.rb +152 -0
  345. data/lib/docspace-api-sdk/models/backup-service-state-wrapper.rb +194 -0
  346. data/lib/docspace-api-sdk/models/backup-storage-type.rb +47 -0
  347. data/lib/docspace-api-sdk/models/backups-count-result-dto.rb +162 -0
  348. data/lib/docspace-api-sdk/models/backups-count-result-wrapper.rb +194 -0
  349. data/lib/docspace-api-sdk/models/balance-dto.rb +207 -0
  350. data/lib/docspace-api-sdk/models/balance-wrapper.rb +194 -0
  351. data/lib/docspace-api-sdk/models/base-batch-request-dto-all-of-file-ids.rb +106 -0
  352. data/lib/docspace-api-sdk/models/base-batch-request-dto-all-of-folder-ids.rb +106 -0
  353. data/lib/docspace-api-sdk/models/base-batch-request-dto.rb +185 -0
  354. data/lib/docspace-api-sdk/models/batch-request-dto-all-of-dest-folder-id.rb +108 -0
  355. data/lib/docspace-api-sdk/models/batch-request-dto-all-of-file-ids.rb +106 -0
  356. data/lib/docspace-api-sdk/models/batch-request-dto-all-of-folder-ids.rb +106 -0
  357. data/lib/docspace-api-sdk/models/batch-request-dto.rb +256 -0
  358. data/lib/docspace-api-sdk/models/batch-tags-request-dto.rb +171 -0
  359. data/lib/docspace-api-sdk/models/boolean-wrapper.rb +194 -0
  360. data/lib/docspace-api-sdk/models/capabilities-dto.rb +275 -0
  361. data/lib/docspace-api-sdk/models/capabilities-wrapper.rb +194 -0
  362. data/lib/docspace-api-sdk/models/change-client-activation-request.rb +169 -0
  363. data/lib/docspace-api-sdk/models/change-email-request.rb +188 -0
  364. data/lib/docspace-api-sdk/models/change-history-request.rb +179 -0
  365. data/lib/docspace-api-sdk/models/change-owner-request-dto.rb +195 -0
  366. data/lib/docspace-api-sdk/models/change-password-request.rb +164 -0
  367. data/lib/docspace-api-sdk/models/change-wallet-service-state-request-dto.rb +184 -0
  368. data/lib/docspace-api-sdk/models/chat-settings-dto.rb +153 -0
  369. data/lib/docspace-api-sdk/models/chat-settings.rb +184 -0
  370. data/lib/docspace-api-sdk/models/check-confirm-request-dto.rb +250 -0
  371. data/lib/docspace-api-sdk/models/check-conversion-request-dto.rb +214 -0
  372. data/lib/docspace-api-sdk/models/check-dest-folder-dto.rb +187 -0
  373. data/lib/docspace-api-sdk/models/check-dest-folder-result.rb +44 -0
  374. data/lib/docspace-api-sdk/models/check-dest-folder-wrapper.rb +194 -0
  375. data/lib/docspace-api-sdk/models/check-doc-service-url-request-dto.rb +210 -0
  376. data/lib/docspace-api-sdk/models/check-fill-form-draft-request.rb +200 -0
  377. data/lib/docspace-api-sdk/models/check-move-or-copy-batch-items-dest-folder-id-parameter.rb +108 -0
  378. data/lib/docspace-api-sdk/models/check-move-or-copy-batch-items-folder-ids-parameter-inner.rb +106 -0
  379. data/lib/docspace-api-sdk/models/check-upload-request.rb +155 -0
  380. data/lib/docspace-api-sdk/models/chunked-upload-session-dto.rb +207 -0
  381. data/lib/docspace-api-sdk/models/chunked-upload-session-result-dto.rb +162 -0
  382. data/lib/docspace-api-sdk/models/chunked-upload-session-result-wrapper.rb +194 -0
  383. data/lib/docspace-api-sdk/models/chunked-upload-session-wrapper.rb +194 -0
  384. data/lib/docspace-api-sdk/models/client-info-response.rb +306 -0
  385. data/lib/docspace-api-sdk/models/client-response.rb +402 -0
  386. data/lib/docspace-api-sdk/models/client-secret-response.rb +152 -0
  387. data/lib/docspace-api-sdk/models/co-editing-config-dto.rb +194 -0
  388. data/lib/docspace-api-sdk/models/co-editing-config-mode.rb +43 -0
  389. data/lib/docspace-api-sdk/models/color-theme-colors-dto.rb +164 -0
  390. data/lib/docspace-api-sdk/models/color-theme-colors-request-dto.rb +164 -0
  391. data/lib/docspace-api-sdk/models/company-white-label-settings-dto.rb +288 -0
  392. data/lib/docspace-api-sdk/models/company-white-label-settings-request-dto.rb +152 -0
  393. data/lib/docspace-api-sdk/models/company-white-label-settings-wrapper.rb +194 -0
  394. data/lib/docspace-api-sdk/models/configuration-dto.rb +394 -0
  395. data/lib/docspace-api-sdk/models/configuration-wrapper.rb +194 -0
  396. data/lib/docspace-api-sdk/models/confirm-data.rb +175 -0
  397. data/lib/docspace-api-sdk/models/confirm-dto.rb +234 -0
  398. data/lib/docspace-api-sdk/models/confirm-type.rb +61 -0
  399. data/lib/docspace-api-sdk/models/confirm-wrapper.rb +194 -0
  400. data/lib/docspace-api-sdk/models/connection-test-result-dto.rb +163 -0
  401. data/lib/docspace-api-sdk/models/connection-test-result-wrapper.rb +194 -0
  402. data/lib/docspace-api-sdk/models/contact.rb +164 -0
  403. data/lib/docspace-api-sdk/models/conversation-result-array-wrapper.rb +196 -0
  404. data/lib/docspace-api-sdk/models/conversation-result-dto.rb +274 -0
  405. data/lib/docspace-api-sdk/models/convert-document-layout-request.rb +175 -0
  406. data/lib/docspace-api-sdk/models/convert-document-renderer-request.rb +153 -0
  407. data/lib/docspace-api-sdk/models/convert-file-request-dto.rb +287 -0
  408. data/lib/docspace-api-sdk/models/convert-pdf-request.rb +152 -0
  409. data/lib/docspace-api-sdk/models/convert-spreadsheet-layout-request.rb +239 -0
  410. data/lib/docspace-api-sdk/models/convert-spreadsheet-margins-request.rb +186 -0
  411. data/lib/docspace-api-sdk/models/convert-spreadsheet-page-size-request.rb +164 -0
  412. data/lib/docspace-api-sdk/models/convert-thumbnail-request.rb +186 -0
  413. data/lib/docspace-api-sdk/models/cookie-settings-dto.rb +196 -0
  414. data/lib/docspace-api-sdk/models/cookie-settings-request-dto.rb +162 -0
  415. data/lib/docspace-api-sdk/models/cookie-settings-wrapper.rb +194 -0
  416. data/lib/docspace-api-sdk/models/copy-as-request-dest-folder-id.rb +108 -0
  417. data/lib/docspace-api-sdk/models/copy-as-request.rb +212 -0
  418. data/lib/docspace-api-sdk/models/cover-request-dto.rb +181 -0
  419. data/lib/docspace-api-sdk/models/covers-result-array-wrapper.rb +196 -0
  420. data/lib/docspace-api-sdk/models/covers-result-dto.rb +168 -0
  421. data/lib/docspace-api-sdk/models/create-api-key-request-dto.rb +235 -0
  422. data/lib/docspace-api-sdk/models/create-backup-schedule-request-dto.rb +218 -0
  423. data/lib/docspace-api-sdk/models/create-client-request.rb +612 -0
  424. data/lib/docspace-api-sdk/models/create-file-request-template-id.rb +108 -0
  425. data/lib/docspace-api-sdk/models/create-file-request.rb +208 -0
  426. data/lib/docspace-api-sdk/models/create-folder-request.rb +179 -0
  427. data/lib/docspace-api-sdk/models/create-metadata-template-request-dto.rb +178 -0
  428. data/lib/docspace-api-sdk/models/create-room-from-template-dto.rb +373 -0
  429. data/lib/docspace-api-sdk/models/create-room-request-dto.rb +422 -0
  430. data/lib/docspace-api-sdk/models/create-tag-request-dto.rb +179 -0
  431. data/lib/docspace-api-sdk/models/create-text-or-html-file-request.rb +200 -0
  432. data/lib/docspace-api-sdk/models/create-third-party-room-request.rb +289 -0
  433. data/lib/docspace-api-sdk/models/create-webhooks-config-request-dto.rb +345 -0
  434. data/lib/docspace-api-sdk/models/cron-params-dto.rb +194 -0
  435. data/lib/docspace-api-sdk/models/csp-dto.rb +170 -0
  436. data/lib/docspace-api-sdk/models/csp-request-dto.rb +155 -0
  437. data/lib/docspace-api-sdk/models/csp-wrapper.rb +194 -0
  438. data/lib/docspace-api-sdk/models/currencies-array-wrapper.rb +196 -0
  439. data/lib/docspace-api-sdk/models/currencies-dto.rb +175 -0
  440. data/lib/docspace-api-sdk/models/current-license-info.rb +196 -0
  441. data/lib/docspace-api-sdk/models/custom-color-theme-dto.rb +183 -0
  442. data/lib/docspace-api-sdk/models/custom-color-theme-request-dto.rb +183 -0
  443. data/lib/docspace-api-sdk/models/custom-color-themes-settings-dto.rb +175 -0
  444. data/lib/docspace-api-sdk/models/custom-color-themes-settings-request-dto.rb +163 -0
  445. data/lib/docspace-api-sdk/models/custom-color-themes-settings-wrapper.rb +194 -0
  446. data/lib/docspace-api-sdk/models/custom-field-request.rb +166 -0
  447. data/lib/docspace-api-sdk/models/custom-field-value-array-wrapper.rb +196 -0
  448. data/lib/docspace-api-sdk/models/custom-field-value-dto.rb +164 -0
  449. data/lib/docspace-api-sdk/models/custom-filter-request.rb +152 -0
  450. data/lib/docspace-api-sdk/models/customer-config-dto.rb +208 -0
  451. data/lib/docspace-api-sdk/models/customer-info-dto.rb +227 -0
  452. data/lib/docspace-api-sdk/models/customer-info-wrapper.rb +194 -0
  453. data/lib/docspace-api-sdk/models/customer-monthly-usage-array-wrapper.rb +196 -0
  454. data/lib/docspace-api-sdk/models/customer-monthly-usage-dto.rb +193 -0
  455. data/lib/docspace-api-sdk/models/customer-monthly-usage-report-request-dto.rb +164 -0
  456. data/lib/docspace-api-sdk/models/customer-operations-report-request-dto.rb +273 -0
  457. data/lib/docspace-api-sdk/models/customer-service-usage-dto.rb +236 -0
  458. data/lib/docspace-api-sdk/models/customer-service-usage-report-dto.rb +205 -0
  459. data/lib/docspace-api-sdk/models/customer-service-usage-report-request-dto.rb +253 -0
  460. data/lib/docspace-api-sdk/models/customer-service-usage-report-wrapper.rb +194 -0
  461. data/lib/docspace-api-sdk/models/customization-config-dto.rb +263 -0
  462. data/lib/docspace-api-sdk/models/dark-theme-settings-dto.rb +184 -0
  463. data/lib/docspace-api-sdk/models/dark-theme-settings-request-dto.rb +191 -0
  464. data/lib/docspace-api-sdk/models/dark-theme-settings-type.rb +44 -0
  465. data/lib/docspace-api-sdk/models/dark-theme-settings-wrapper.rb +194 -0
  466. data/lib/docspace-api-sdk/models/date-to-auto-clean-up.rb +47 -0
  467. data/lib/docspace-api-sdk/models/deep-link-configuration-request-dto.rb +152 -0
  468. data/lib/docspace-api-sdk/models/deep-link-dto.rb +181 -0
  469. data/lib/docspace-api-sdk/models/deep-link-handling-mode.rb +44 -0
  470. data/lib/docspace-api-sdk/models/deep-link-settings-request-dto.rb +184 -0
  471. data/lib/docspace-api-sdk/models/default-product-request-dto.rb +191 -0
  472. data/lib/docspace-api-sdk/models/default-template-item-dto.rb +210 -0
  473. data/lib/docspace-api-sdk/models/default-template-settings-dto.rb +157 -0
  474. data/lib/docspace-api-sdk/models/default-template-settings-request-dto-selected-file.rb +108 -0
  475. data/lib/docspace-api-sdk/models/default-template-settings-request-dto.rb +181 -0
  476. data/lib/docspace-api-sdk/models/default-template-settings-reset-request-dto.rb +155 -0
  477. data/lib/docspace-api-sdk/models/default-template-settings-wrapper.rb +194 -0
  478. data/lib/docspace-api-sdk/models/delete-batch-request-dto-all-of-file-ids.rb +106 -0
  479. data/lib/docspace-api-sdk/models/delete-batch-request-dto-all-of-folder-ids.rb +106 -0
  480. data/lib/docspace-api-sdk/models/delete-batch-request-dto.rb +205 -0
  481. data/lib/docspace-api-sdk/models/delete-file-request.rb +162 -0
  482. data/lib/docspace-api-sdk/models/delete-folder-request.rb +162 -0
  483. data/lib/docspace-api-sdk/models/delete-room-request.rb +152 -0
  484. data/lib/docspace-api-sdk/models/delete-version-batch-request-dto.rb +211 -0
  485. data/lib/docspace-api-sdk/models/discount-category-dto.rb +183 -0
  486. data/lib/docspace-api-sdk/models/display-request-dto.rb +152 -0
  487. data/lib/docspace-api-sdk/models/distributed-task-status.rb +46 -0
  488. data/lib/docspace-api-sdk/models/dns-settings-request-dto.rb +163 -0
  489. data/lib/docspace-api-sdk/models/doc-service-url-dto.rb +287 -0
  490. data/lib/docspace-api-sdk/models/doc-service-url-wrapper.rb +194 -0
  491. data/lib/docspace-api-sdk/models/docs-cloud-config-dto.rb +217 -0
  492. data/lib/docspace-api-sdk/models/docs-cloud-config-request-dto.rb +217 -0
  493. data/lib/docspace-api-sdk/models/docs-cloud-config-wrapper.rb +194 -0
  494. data/lib/docspace-api-sdk/models/docs-cloud-dev-pack-request-dto.rb +180 -0
  495. data/lib/docspace-api-sdk/models/docs-cloud-ip-filter-config-dto.rb +155 -0
  496. data/lib/docspace-api-sdk/models/docs-cloud-ip-filter-config-request.rb +155 -0
  497. data/lib/docspace-api-sdk/models/docs-cloud-ip-filter-rule-dto.rb +187 -0
  498. data/lib/docspace-api-sdk/models/docs-cloud-ip-filter-rule-request.rb +187 -0
  499. data/lib/docspace-api-sdk/models/docs-cloud-license-info-dto.rb +172 -0
  500. data/lib/docspace-api-sdk/models/docs-cloud-payment-dto.rb +224 -0
  501. data/lib/docspace-api-sdk/models/docs-cloud-quota-dto.rb +168 -0
  502. data/lib/docspace-api-sdk/models/docs-cloud-quota-user-dto.rb +164 -0
  503. data/lib/docspace-api-sdk/models/docs-cloud-quota-wrapper.rb +194 -0
  504. data/lib/docspace-api-sdk/models/docs-cloud-security-config-dto.rb +212 -0
  505. data/lib/docspace-api-sdk/models/docs-cloud-security-config-request.rb +212 -0
  506. data/lib/docspace-api-sdk/models/docs-cloud-server-config-dto.rb +190 -0
  507. data/lib/docspace-api-sdk/models/docs-cloud-server-config-request.rb +190 -0
  508. data/lib/docspace-api-sdk/models/docs-cloud-server-info-dto.rb +174 -0
  509. data/lib/docspace-api-sdk/models/docs-cloud-stats-dto.rb +172 -0
  510. data/lib/docspace-api-sdk/models/docs-cloud-tenant-dto.rb +257 -0
  511. data/lib/docspace-api-sdk/models/docs-cloud-tenant-info-dto.rb +182 -0
  512. data/lib/docspace-api-sdk/models/docs-cloud-tenant-info-wrapper.rb +194 -0
  513. data/lib/docspace-api-sdk/models/docs-cloud-tenant-wrapper.rb +194 -0
  514. data/lib/docspace-api-sdk/models/docs-cloud-usage-dto.rb +162 -0
  515. data/lib/docspace-api-sdk/models/docs-cloud-usage-wrapper.rb +194 -0
  516. data/lib/docspace-api-sdk/models/docs-cloud-user-stats-dto.rb +192 -0
  517. data/lib/docspace-api-sdk/models/docs-cloud-users-limit-dto.rb +162 -0
  518. data/lib/docspace-api-sdk/models/docs-cloud-wopi-config-dto.rb +152 -0
  519. data/lib/docspace-api-sdk/models/docs-cloud-wopi-config-request.rb +152 -0
  520. data/lib/docspace-api-sdk/models/document-builder-task-dto.rb +309 -0
  521. data/lib/docspace-api-sdk/models/document-builder-task-wrapper.rb +194 -0
  522. data/lib/docspace-api-sdk/models/document-config-dto.rb +268 -0
  523. data/lib/docspace-api-sdk/models/document-options-dto.rb +152 -0
  524. data/lib/docspace-api-sdk/models/domain-name-rules-dto.rb +173 -0
  525. data/lib/docspace-api-sdk/models/double-nullable-wrapper.rb +195 -0
  526. data/lib/docspace-api-sdk/models/double-wrapper.rb +194 -0
  527. data/lib/docspace-api-sdk/models/download-request-dto-all-of-file-ids.rb +106 -0
  528. data/lib/docspace-api-sdk/models/download-request-dto-all-of-folder-ids.rb +106 -0
  529. data/lib/docspace-api-sdk/models/download-request-dto.rb +198 -0
  530. data/lib/docspace-api-sdk/models/download-request-item-dto-key.rb +108 -0
  531. data/lib/docspace-api-sdk/models/download-request-item-dto.rb +192 -0
  532. data/lib/docspace-api-sdk/models/draft-location.rb +184 -0
  533. data/lib/docspace-api-sdk/models/duplicate-request-dto-all-of-file-ids.rb +106 -0
  534. data/lib/docspace-api-sdk/models/duplicate-request-dto-all-of-folder-ids.rb +106 -0
  535. data/lib/docspace-api-sdk/models/duplicate-request-dto.rb +185 -0
  536. data/lib/docspace-api-sdk/models/edit-history-array-wrapper.rb +196 -0
  537. data/lib/docspace-api-sdk/models/edit-history-author-dto.rb +166 -0
  538. data/lib/docspace-api-sdk/models/edit-history-changes-dto.rb +173 -0
  539. data/lib/docspace-api-sdk/models/edit-history-data-dto.rb +240 -0
  540. data/lib/docspace-api-sdk/models/edit-history-data-wrapper.rb +194 -0
  541. data/lib/docspace-api-sdk/models/edit-history-dto.rb +238 -0
  542. data/lib/docspace-api-sdk/models/edit-history-url-dto.rb +175 -0
  543. data/lib/docspace-api-sdk/models/editor-configuration-dto.rb +289 -0
  544. data/lib/docspace-api-sdk/models/editor-tool-call-parameters-dto.rb +109 -0
  545. data/lib/docspace-api-sdk/models/editor-tool-call-state-dto.rb +182 -0
  546. data/lib/docspace-api-sdk/models/editor-type.rb +44 -0
  547. data/lib/docspace-api-sdk/models/email-activation-settings-dto.rb +162 -0
  548. data/lib/docspace-api-sdk/models/email-activation-settings-request-dto.rb +162 -0
  549. data/lib/docspace-api-sdk/models/email-activation-settings-wrapper.rb +194 -0
  550. data/lib/docspace-api-sdk/models/email-invitation-dto.rb +168 -0
  551. data/lib/docspace-api-sdk/models/email-member-request-dto.rb +230 -0
  552. data/lib/docspace-api-sdk/models/embedded-config-dto.rb +197 -0
  553. data/lib/docspace-api-sdk/models/employee-activation-status.rb +45 -0
  554. data/lib/docspace-api-sdk/models/employee-array-wrapper.rb +196 -0
  555. data/lib/docspace-api-sdk/models/employee-dto.rb +249 -0
  556. data/lib/docspace-api-sdk/models/employee-full-array-wrapper.rb +196 -0
  557. data/lib/docspace-api-sdk/models/employee-full-dto.rb +637 -0
  558. data/lib/docspace-api-sdk/models/employee-full-wrapper.rb +194 -0
  559. data/lib/docspace-api-sdk/models/employee-status.rb +46 -0
  560. data/lib/docspace-api-sdk/models/employee-type.rb +46 -0
  561. data/lib/docspace-api-sdk/models/employee-wrapper.rb +194 -0
  562. data/lib/docspace-api-sdk/models/enabled-module-array-wrapper.rb +196 -0
  563. data/lib/docspace-api-sdk/models/enabled-module-dto.rb +164 -0
  564. data/lib/docspace-api-sdk/models/encryption-key-array-wrapper.rb +196 -0
  565. data/lib/docspace-api-sdk/models/encryption-key-dto.rb +205 -0
  566. data/lib/docspace-api-sdk/models/encryption-key-request-dto.rb +174 -0
  567. data/lib/docspace-api-sdk/models/encryption-settings-dto.rb +195 -0
  568. data/lib/docspace-api-sdk/models/encryption-settings-wrapper.rb +194 -0
  569. data/lib/docspace-api-sdk/models/encryption-status.rb +45 -0
  570. data/lib/docspace-api-sdk/models/entity-quota-dto.rb +173 -0
  571. data/lib/docspace-api-sdk/models/entity-quota-settings-dto.rb +189 -0
  572. data/lib/docspace-api-sdk/models/entity-quota-settings-wrapper.rb +194 -0
  573. data/lib/docspace-api-sdk/models/entry-field-dto.rb +228 -0
  574. data/lib/docspace-api-sdk/models/entry-metadata-dto.rb +168 -0
  575. data/lib/docspace-api-sdk/models/entry-metadata-wrapper.rb +194 -0
  576. data/lib/docspace-api-sdk/models/entry-template-dto.rb +228 -0
  577. data/lib/docspace-api-sdk/models/entry-type.rb +49 -0
  578. data/lib/docspace-api-sdk/models/error-api-response-error.rb +182 -0
  579. data/lib/docspace-api-sdk/models/error-api-response.rb +171 -0
  580. data/lib/docspace-api-sdk/models/exchange-token200-response.rb +181 -0
  581. data/lib/docspace-api-sdk/models/external-database-connection-request-dto.rb +260 -0
  582. data/lib/docspace-api-sdk/models/external-database-type.rb +43 -0
  583. data/lib/docspace-api-sdk/models/external-db-sync-form-result-dto.rb +184 -0
  584. data/lib/docspace-api-sdk/models/external-db-sync-task-dto.rb +284 -0
  585. data/lib/docspace-api-sdk/models/external-db-sync-task-wrapper.rb +194 -0
  586. data/lib/docspace-api-sdk/models/external-resource-dto.rb +165 -0
  587. data/lib/docspace-api-sdk/models/external-resources-dto.rb +242 -0
  588. data/lib/docspace-api-sdk/models/external-share-dto.rb +384 -0
  589. data/lib/docspace-api-sdk/models/external-share-request-param.rb +153 -0
  590. data/lib/docspace-api-sdk/models/external-share-status.rb +47 -0
  591. data/lib/docspace-api-sdk/models/external-share-wrapper.rb +194 -0
  592. data/lib/docspace-api-sdk/models/external-sharing-settings-dto.rb +192 -0
  593. data/lib/docspace-api-sdk/models/external-sharing-settings-request-dto.rb +192 -0
  594. data/lib/docspace-api-sdk/models/external-sharing-settings-wrapper.rb +194 -0
  595. data/lib/docspace-api-sdk/models/feature-used-dto.rb +165 -0
  596. data/lib/docspace-api-sdk/models/feedback-config-dto.rb +163 -0
  597. data/lib/docspace-api-sdk/models/field-error.rb +172 -0
  598. data/lib/docspace-api-sdk/models/file-array-wrapper.rb +196 -0
  599. data/lib/docspace-api-sdk/models/file-conflict-resolve-type.rb +44 -0
  600. data/lib/docspace-api-sdk/models/file-dto-all-of-view-accessibility.rb +232 -0
  601. data/lib/docspace-api-sdk/models/file-dto.rb +927 -0
  602. data/lib/docspace-api-sdk/models/file-encryption-info-dto.rb +168 -0
  603. data/lib/docspace-api-sdk/models/file-encryption-info-wrapper.rb +194 -0
  604. data/lib/docspace-api-sdk/models/file-entry-array-wrapper.rb +196 -0
  605. data/lib/docspace-api-sdk/models/file-entry-base-array-wrapper.rb +196 -0
  606. data/lib/docspace-api-sdk/models/file-entry-base-dto.rb +391 -0
  607. data/lib/docspace-api-sdk/models/file-entry-base-wrapper.rb +194 -0
  608. data/lib/docspace-api-sdk/models/file-entry-dto.rb +562 -0
  609. data/lib/docspace-api-sdk/models/file-entry-type.rb +43 -0
  610. data/lib/docspace-api-sdk/models/file-keys-dto.rb +203 -0
  611. data/lib/docspace-api-sdk/models/file-link-dto.rb +179 -0
  612. data/lib/docspace-api-sdk/models/file-link-request.rb +294 -0
  613. data/lib/docspace-api-sdk/models/file-link-wrapper.rb +194 -0
  614. data/lib/docspace-api-sdk/models/file-operation-array-wrapper.rb +196 -0
  615. data/lib/docspace-api-sdk/models/file-operation-dto.rb +331 -0
  616. data/lib/docspace-api-sdk/models/file-operation-request-base-dto.rb +152 -0
  617. data/lib/docspace-api-sdk/models/file-operation-type.rb +50 -0
  618. data/lib/docspace-api-sdk/models/file-operation-wrapper.rb +194 -0
  619. data/lib/docspace-api-sdk/models/file-reference-data-dto.rb +185 -0
  620. data/lib/docspace-api-sdk/models/file-reference-dto.rb +229 -0
  621. data/lib/docspace-api-sdk/models/file-reference-wrapper.rb +194 -0
  622. data/lib/docspace-api-sdk/models/file-share-array-wrapper.rb +196 -0
  623. data/lib/docspace-api-sdk/models/file-share-dto.rb +430 -0
  624. data/lib/docspace-api-sdk/models/file-share-link.rb +303 -0
  625. data/lib/docspace-api-sdk/models/file-share-params.rb +220 -0
  626. data/lib/docspace-api-sdk/models/file-share-response-array-wrapper.rb +196 -0
  627. data/lib/docspace-api-sdk/models/file-share-wrapper.rb +194 -0
  628. data/lib/docspace-api-sdk/models/file-share.rb +53 -0
  629. data/lib/docspace-api-sdk/models/file-status.rb +51 -0
  630. data/lib/docspace-api-sdk/models/file-type.rb +51 -0
  631. data/lib/docspace-api-sdk/models/file-upload-result-dto.rb +173 -0
  632. data/lib/docspace-api-sdk/models/file-upload-result-wrapper.rb +194 -0
  633. data/lib/docspace-api-sdk/models/file-wrapper.rb +194 -0
  634. data/lib/docspace-api-sdk/models/files-settings-dto-internal-formats.rb +232 -0
  635. data/lib/docspace-api-sdk/models/files-settings-dto.rb +892 -0
  636. data/lib/docspace-api-sdk/models/files-settings-wrapper.rb +194 -0
  637. data/lib/docspace-api-sdk/models/files-statistics-folder.rb +163 -0
  638. data/lib/docspace-api-sdk/models/files-statistics-result-dto.rb +202 -0
  639. data/lib/docspace-api-sdk/models/files-statistics-result-wrapper.rb +194 -0
  640. data/lib/docspace-api-sdk/models/filling-form-result-dto.rb +236 -0
  641. data/lib/docspace-api-sdk/models/filling-form-result-wrapper.rb +194 -0
  642. data/lib/docspace-api-sdk/models/filter-type.rb +62 -0
  643. data/lib/docspace-api-sdk/models/finish-dto.rb +169 -0
  644. data/lib/docspace-api-sdk/models/firebase-device-dto.rb +205 -0
  645. data/lib/docspace-api-sdk/models/firebase-device-wrapper.rb +194 -0
  646. data/lib/docspace-api-sdk/models/firebase-dto.rb +246 -0
  647. data/lib/docspace-api-sdk/models/firebase-request-dto.rb +163 -0
  648. data/lib/docspace-api-sdk/models/folder-array-wrapper.rb +196 -0
  649. data/lib/docspace-api-sdk/models/folder-content-array-wrapper.rb +196 -0
  650. data/lib/docspace-api-sdk/models/folder-content-dto.rb +247 -0
  651. data/lib/docspace-api-sdk/models/folder-content-wrapper.rb +194 -0
  652. data/lib/docspace-api-sdk/models/folder-dto.rb +838 -0
  653. data/lib/docspace-api-sdk/models/folder-link-request.rb +294 -0
  654. data/lib/docspace-api-sdk/models/folder-metadata-search.rb +328 -0
  655. data/lib/docspace-api-sdk/models/folder-type.rb +72 -0
  656. data/lib/docspace-api-sdk/models/folder-wrapper.rb +194 -0
  657. data/lib/docspace-api-sdk/models/form-filling-manage-action.rb +45 -0
  658. data/lib/docspace-api-sdk/models/form-filling-status.rb +47 -0
  659. data/lib/docspace-api-sdk/models/form-gallery-dto.rb +233 -0
  660. data/lib/docspace-api-sdk/models/form-metadata-dto.rb +188 -0
  661. data/lib/docspace-api-sdk/models/form-results-dto.rb +165 -0
  662. data/lib/docspace-api-sdk/models/form-role-array-wrapper.rb +196 -0
  663. data/lib/docspace-api-sdk/models/form-role-dto.rb +284 -0
  664. data/lib/docspace-api-sdk/models/form-role-request.rb +224 -0
  665. data/lib/docspace-api-sdk/models/form-submissions-dto.rb +168 -0
  666. data/lib/docspace-api-sdk/models/form-submissions-wrapper.rb +194 -0
  667. data/lib/docspace-api-sdk/models/forms-item-array-wrapper.rb +196 -0
  668. data/lib/docspace-api-sdk/models/forms-item-data-dto.rb +186 -0
  669. data/lib/docspace-api-sdk/models/forms-item-dto.rb +164 -0
  670. data/lib/docspace-api-sdk/models/generate-docx-tool-call-parameters-dto.rb +155 -0
  671. data/lib/docspace-api-sdk/models/generate-form-tool-call-parameters-dto.rb +155 -0
  672. data/lib/docspace-api-sdk/models/generate-presentation-tool-call-parameters-dto.rb +175 -0
  673. data/lib/docspace-api-sdk/models/get-portal-prices200-response-links-inner.rb +161 -0
  674. data/lib/docspace-api-sdk/models/get-portal-prices200-response.rb +196 -0
  675. data/lib/docspace-api-sdk/models/get-reference-data-dto.rb +200 -0
  676. data/lib/docspace-api-sdk/models/goback-config-dto.rb +153 -0
  677. data/lib/docspace-api-sdk/models/greeting-settings-request-dto.rb +179 -0
  678. data/lib/docspace-api-sdk/models/group-array-wrapper.rb +196 -0
  679. data/lib/docspace-api-sdk/models/group-dto.rb +302 -0
  680. data/lib/docspace-api-sdk/models/group-member-security-array-wrapper.rb +196 -0
  681. data/lib/docspace-api-sdk/models/group-member-security-dto.rb +309 -0
  682. data/lib/docspace-api-sdk/models/group-request-dto.rb +202 -0
  683. data/lib/docspace-api-sdk/models/group-summary-array-wrapper.rb +196 -0
  684. data/lib/docspace-api-sdk/models/group-summary-dto.rb +204 -0
  685. data/lib/docspace-api-sdk/models/group-wrapper.rb +194 -0
  686. data/lib/docspace-api-sdk/models/hide-confirm-convert-request-dto.rb +152 -0
  687. data/lib/docspace-api-sdk/models/history-action-dto.rb +185 -0
  688. data/lib/docspace-api-sdk/models/history-array-wrapper.rb +196 -0
  689. data/lib/docspace-api-sdk/models/history-data-dto.rb +153 -0
  690. data/lib/docspace-api-sdk/models/history-dto.rb +273 -0
  691. data/lib/docspace-api-sdk/models/i-compress-wrapper.rb +194 -0
  692. data/lib/docspace-api-sdk/models/icon-request.rb +153 -0
  693. data/lib/docspace-api-sdk/models/image-size-dto.rb +162 -0
  694. data/lib/docspace-api-sdk/models/importable-api-entity.rb +152 -0
  695. data/lib/docspace-api-sdk/models/info-config-dto.rb +231 -0
  696. data/lib/docspace-api-sdk/models/int32-wrapper.rb +194 -0
  697. data/lib/docspace-api-sdk/models/int64-wrapper.rb +194 -0
  698. data/lib/docspace-api-sdk/models/invitation-link-create-request-dto.rb +237 -0
  699. data/lib/docspace-api-sdk/models/invitation-link-delete-request-dto.rb +169 -0
  700. data/lib/docspace-api-sdk/models/invitation-link-dto.rb +253 -0
  701. data/lib/docspace-api-sdk/models/invitation-link-update-request-dto.rb +215 -0
  702. data/lib/docspace-api-sdk/models/invitation-link-wrapper.rb +194 -0
  703. data/lib/docspace-api-sdk/models/invite-users-request-dto.rb +182 -0
  704. data/lib/docspace-api-sdk/models/ip-restriction-array-wrapper.rb +196 -0
  705. data/lib/docspace-api-sdk/models/ip-restriction-dto.rb +185 -0
  706. data/lib/docspace-api-sdk/models/ip-restriction-entry-dto.rb +165 -0
  707. data/lib/docspace-api-sdk/models/ip-restrictions-dto.rb +168 -0
  708. data/lib/docspace-api-sdk/models/ip-restrictions-settings-dto.rb +162 -0
  709. data/lib/docspace-api-sdk/models/ip-restrictions-settings-wrapper.rb +194 -0
  710. data/lib/docspace-api-sdk/models/ip-restrictions-wrapper.rb +194 -0
  711. data/lib/docspace-api-sdk/models/is-default-white-label-logos-array-wrapper.rb +196 -0
  712. data/lib/docspace-api-sdk/models/is-default-white-label-logos-dto.rb +182 -0
  713. data/lib/docspace-api-sdk/models/is-default-white-label-logos-wrapper.rb +194 -0
  714. data/lib/docspace-api-sdk/models/item-key-value-pair-boolean-string-wrapper.rb +194 -0
  715. data/lib/docspace-api-sdk/models/item-key-value-pair-boolean-string.rb +163 -0
  716. data/lib/docspace-api-sdk/models/item-key-value-pair-object-object.rb +162 -0
  717. data/lib/docspace-api-sdk/models/item-key-value-pair-string-boolean.rb +163 -0
  718. data/lib/docspace-api-sdk/models/item-key-value-pair-string-logo-request-dto.rb +163 -0
  719. data/lib/docspace-api-sdk/models/item-key-value-pair-string-string.rb +164 -0
  720. data/lib/docspace-api-sdk/models/json-value-wrapper.rb +194 -0
  721. data/lib/docspace-api-sdk/models/licensor-details-array-wrapper.rb +196 -0
  722. data/lib/docspace-api-sdk/models/licensor-details-dto.rb +347 -0
  723. data/lib/docspace-api-sdk/models/licensor-details-wrapper.rb +194 -0
  724. data/lib/docspace-api-sdk/models/link-account-request-dto.rb +153 -0
  725. data/lib/docspace-api-sdk/models/link-type.rb +43 -0
  726. data/lib/docspace-api-sdk/models/location-type.rb +49 -0
  727. data/lib/docspace-api-sdk/models/lock-file-request.rb +152 -0
  728. data/lib/docspace-api-sdk/models/login-event-array-wrapper.rb +196 -0
  729. data/lib/docspace-api-sdk/models/login-event-dto.rb +303 -0
  730. data/lib/docspace-api-sdk/models/login-provider.rb +56 -0
  731. data/lib/docspace-api-sdk/models/login-settings-dto.rb +250 -0
  732. data/lib/docspace-api-sdk/models/login-settings-request-dto.rb +256 -0
  733. data/lib/docspace-api-sdk/models/login-settings-wrapper.rb +194 -0
  734. data/lib/docspace-api-sdk/models/logo-config-dto.rb +207 -0
  735. data/lib/docspace-api-sdk/models/logo-cover-dto.rb +168 -0
  736. data/lib/docspace-api-sdk/models/logo-dto.rb +215 -0
  737. data/lib/docspace-api-sdk/models/logo-request-dto.rb +164 -0
  738. data/lib/docspace-api-sdk/models/logo-request.rb +330 -0
  739. data/lib/docspace-api-sdk/models/mail-domain-settings-request-dto.rb +233 -0
  740. data/lib/docspace-api-sdk/models/manage-form-filling-dto.rb +201 -0
  741. data/lib/docspace-api-sdk/models/member-request-dto.rb +424 -0
  742. data/lib/docspace-api-sdk/models/members-request.rb +155 -0
  743. data/lib/docspace-api-sdk/models/mention-array-wrapper.rb +196 -0
  744. data/lib/docspace-api-sdk/models/mention-dto.rb +206 -0
  745. data/lib/docspace-api-sdk/models/mention-message-request.rb +200 -0
  746. data/lib/docspace-api-sdk/models/message-action.rb +403 -0
  747. data/lib/docspace-api-sdk/models/metadata-conflict-resolve-type.rb +43 -0
  748. data/lib/docspace-api-sdk/models/metadata-field-dto.rb +228 -0
  749. data/lib/docspace-api-sdk/models/metadata-field-option-dto.rb +163 -0
  750. data/lib/docspace-api-sdk/models/metadata-field-option-request.rb +164 -0
  751. data/lib/docspace-api-sdk/models/metadata-field-request.rb +209 -0
  752. data/lib/docspace-api-sdk/models/metadata-field-type.rb +46 -0
  753. data/lib/docspace-api-sdk/models/metadata-field-wrapper.rb +194 -0
  754. data/lib/docspace-api-sdk/models/metadata-filter-condition-request.rb +220 -0
  755. data/lib/docspace-api-sdk/models/metadata-match-dto.rb +186 -0
  756. data/lib/docspace-api-sdk/models/metadata-operation-dto.rb +197 -0
  757. data/lib/docspace-api-sdk/models/metadata-operation-wrapper.rb +194 -0
  758. data/lib/docspace-api-sdk/models/metadata-template-array-wrapper.rb +196 -0
  759. data/lib/docspace-api-sdk/models/metadata-template-dto.rb +226 -0
  760. data/lib/docspace-api-sdk/models/metadata-template-wrapper.rb +194 -0
  761. data/lib/docspace-api-sdk/models/metadata-value-dto.rb +187 -0
  762. data/lib/docspace-api-sdk/models/metadata-value-request.rb +215 -0
  763. data/lib/docspace-api-sdk/models/migrating-api-files.rb +172 -0
  764. data/lib/docspace-api-sdk/models/migrating-api-group.rb +194 -0
  765. data/lib/docspace-api-sdk/models/migrating-api-user.rb +256 -0
  766. data/lib/docspace-api-sdk/models/migration-api-info.rb +335 -0
  767. data/lib/docspace-api-sdk/models/migration-status-dto.rb +183 -0
  768. data/lib/docspace-api-sdk/models/migration-status-wrapper.rb +194 -0
  769. data/lib/docspace-api-sdk/models/mobile-phone-activation-status.rb +43 -0
  770. data/lib/docspace-api-sdk/models/mobile-request-dto.rb +153 -0
  771. data/lib/docspace-api-sdk/models/model-module.rb +239 -0
  772. data/lib/docspace-api-sdk/models/module-wrapper.rb +194 -0
  773. data/lib/docspace-api-sdk/models/multi-size-logo-cover-dto.rb +184 -0
  774. data/lib/docspace-api-sdk/models/new-items-dto-file-entry-base-dto.rb +184 -0
  775. data/lib/docspace-api-sdk/models/new-items-dto-room-new-items-dto.rb +184 -0
  776. data/lib/docspace-api-sdk/models/new-items-file-entry-base-array-wrapper.rb +196 -0
  777. data/lib/docspace-api-sdk/models/new-items-room-new-items-array-wrapper.rb +196 -0
  778. data/lib/docspace-api-sdk/models/notification-channel-dto.rb +182 -0
  779. data/lib/docspace-api-sdk/models/notification-channel-status-dto.rb +155 -0
  780. data/lib/docspace-api-sdk/models/notification-channel-status-wrapper.rb +194 -0
  781. data/lib/docspace-api-sdk/models/notification-settings-dto.rb +184 -0
  782. data/lib/docspace-api-sdk/models/notification-settings-request-dto.rb +201 -0
  783. data/lib/docspace-api-sdk/models/notification-settings-wrapper.rb +194 -0
  784. data/lib/docspace-api-sdk/models/notification-type.rb +45 -0
  785. data/lib/docspace-api-sdk/models/object-array-wrapper.rb +196 -0
  786. data/lib/docspace-api-sdk/models/operation-dto.rb +345 -0
  787. data/lib/docspace-api-sdk/models/operation-order-type.rb +43 -0
  788. data/lib/docspace-api-sdk/models/operation-status.rb +45 -0
  789. data/lib/docspace-api-sdk/models/operation-token-usage-dto.rb +212 -0
  790. data/lib/docspace-api-sdk/models/operation-type.rb +61 -0
  791. data/lib/docspace-api-sdk/models/order-by-dto.rb +184 -0
  792. data/lib/docspace-api-sdk/models/order-request-dto.rb +180 -0
  793. data/lib/docspace-api-sdk/models/orders-item-request-dto.rb +263 -0
  794. data/lib/docspace-api-sdk/models/orders-request-dto.rb +157 -0
  795. data/lib/docspace-api-sdk/models/owner-change-instructions-dto.rb +163 -0
  796. data/lib/docspace-api-sdk/models/owner-change-instructions-wrapper.rb +194 -0
  797. data/lib/docspace-api-sdk/models/owner-id-settings-request-dto.rb +169 -0
  798. data/lib/docspace-api-sdk/models/pageable-client-info-response.rb +184 -0
  799. data/lib/docspace-api-sdk/models/pageable-client-response.rb +184 -0
  800. data/lib/docspace-api-sdk/models/pageable-modification-response.rb +172 -0
  801. data/lib/docspace-api-sdk/models/pageable-response.rb +182 -0
  802. data/lib/docspace-api-sdk/models/password-hash-settings-dto.rb +173 -0
  803. data/lib/docspace-api-sdk/models/password-settings-dto.rb +302 -0
  804. data/lib/docspace-api-sdk/models/password-settings-request-dto.rb +199 -0
  805. data/lib/docspace-api-sdk/models/password-settings-wrapper.rb +194 -0
  806. data/lib/docspace-api-sdk/models/payment-calculation-dto.rb +183 -0
  807. data/lib/docspace-api-sdk/models/payment-calculation-wrapper.rb +194 -0
  808. data/lib/docspace-api-sdk/models/payment-method-status.rb +44 -0
  809. data/lib/docspace-api-sdk/models/payment-settings-dto.rb +260 -0
  810. data/lib/docspace-api-sdk/models/payment-settings-wrapper.rb +194 -0
  811. data/lib/docspace-api-sdk/models/payment-url-request-dto.rb +279 -0
  812. data/lib/docspace-api-sdk/models/payments.rb +43 -0
  813. data/lib/docspace-api-sdk/models/permissions-config-dto.rb +242 -0
  814. data/lib/docspace-api-sdk/models/plugins-config-dto.rb +155 -0
  815. data/lib/docspace-api-sdk/models/plugins-dto.rb +172 -0
  816. data/lib/docspace-api-sdk/models/portal-user-dto.rb +496 -0
  817. data/lib/docspace-api-sdk/models/portal-user-wrapper.rb +194 -0
  818. data/lib/docspace-api-sdk/models/price-dto.rb +175 -0
  819. data/lib/docspace-api-sdk/models/price-status.rb +44 -0
  820. data/lib/docspace-api-sdk/models/price-time-unit.rb +48 -0
  821. data/lib/docspace-api-sdk/models/problem-detail.rb +216 -0
  822. data/lib/docspace-api-sdk/models/product-administrator-dto.rb +223 -0
  823. data/lib/docspace-api-sdk/models/product-administrator-wrapper.rb +194 -0
  824. data/lib/docspace-api-sdk/models/product-quantity-type.rb +45 -0
  825. data/lib/docspace-api-sdk/models/product-type.rb +45 -0
  826. data/lib/docspace-api-sdk/models/provider-array-wrapper.rb +196 -0
  827. data/lib/docspace-api-sdk/models/provider-dto.rb +216 -0
  828. data/lib/docspace-api-sdk/models/provider-filter.rb +51 -0
  829. data/lib/docspace-api-sdk/models/quantity-request-dto.rb +189 -0
  830. data/lib/docspace-api-sdk/models/quota-array-wrapper.rb +196 -0
  831. data/lib/docspace-api-sdk/models/quota-dto.rb +354 -0
  832. data/lib/docspace-api-sdk/models/quota-filter.rb +44 -0
  833. data/lib/docspace-api-sdk/models/quota-scope.rb +44 -0
  834. data/lib/docspace-api-sdk/models/quota-settings-request-dto-default-quota.rb +108 -0
  835. data/lib/docspace-api-sdk/models/quota-settings-request-dto.rb +178 -0
  836. data/lib/docspace-api-sdk/models/quota-state.rb +43 -0
  837. data/lib/docspace-api-sdk/models/quota-wrapper.rb +194 -0
  838. data/lib/docspace-api-sdk/models/recaptcha-type.rb +45 -0
  839. data/lib/docspace-api-sdk/models/recent-config-dto.rb +175 -0
  840. data/lib/docspace-api-sdk/models/reg-status.rb +44 -0
  841. data/lib/docspace-api-sdk/models/report-dto.rb +205 -0
  842. data/lib/docspace-api-sdk/models/report-wrapper.rb +194 -0
  843. data/lib/docspace-api-sdk/models/request-location.rb +44 -0
  844. data/lib/docspace-api-sdk/models/restricted-ai-models-dto.rb +157 -0
  845. data/lib/docspace-api-sdk/models/restricted-ai-models-wrapper.rb +194 -0
  846. data/lib/docspace-api-sdk/models/review-config-dto.rb +153 -0
  847. data/lib/docspace-api-sdk/models/room-data-lifetime-dto.rb +230 -0
  848. data/lib/docspace-api-sdk/models/room-data-lifetime-period.rb +44 -0
  849. data/lib/docspace-api-sdk/models/room-from-template-status-dto.rb +236 -0
  850. data/lib/docspace-api-sdk/models/room-from-template-status-wrapper.rb +194 -0
  851. data/lib/docspace-api-sdk/models/room-group-array-wrapper.rb +196 -0
  852. data/lib/docspace-api-sdk/models/room-group-dto.rb +238 -0
  853. data/lib/docspace-api-sdk/models/room-group-request-dto.rb +293 -0
  854. data/lib/docspace-api-sdk/models/room-group-wrapper.rb +194 -0
  855. data/lib/docspace-api-sdk/models/room-invitation-request.rb +197 -0
  856. data/lib/docspace-api-sdk/models/room-invitation.rb +220 -0
  857. data/lib/docspace-api-sdk/models/room-link-request.rb +339 -0
  858. data/lib/docspace-api-sdk/models/room-new-items-dto.rb +165 -0
  859. data/lib/docspace-api-sdk/models/room-privacy-filter.rb +44 -0
  860. data/lib/docspace-api-sdk/models/room-security-dto.rb +198 -0
  861. data/lib/docspace-api-sdk/models/room-security-error.rb +43 -0
  862. data/lib/docspace-api-sdk/models/room-security-wrapper.rb +194 -0
  863. data/lib/docspace-api-sdk/models/room-template-dto.rb +364 -0
  864. data/lib/docspace-api-sdk/models/room-template-status-dto.rb +234 -0
  865. data/lib/docspace-api-sdk/models/room-template-status-wrapper.rb +194 -0
  866. data/lib/docspace-api-sdk/models/room-type.rb +47 -0
  867. data/lib/docspace-api-sdk/models/rooms-metadata-search-request-dto.rb +330 -0
  868. data/lib/docspace-api-sdk/models/rooms-notification-settings-dto.rb +155 -0
  869. data/lib/docspace-api-sdk/models/rooms-notification-settings-wrapper.rb +194 -0
  870. data/lib/docspace-api-sdk/models/rooms-notifications-settings-request-dto.rb +162 -0
  871. data/lib/docspace-api-sdk/models/run-builder-script-output-request.rb +175 -0
  872. data/lib/docspace-api-sdk/models/run-builder-script-request-dto-argument.rb +108 -0
  873. data/lib/docspace-api-sdk/models/run-builder-script-request-dto.rb +211 -0
  874. data/lib/docspace-api-sdk/models/sales-request-dto.rb +277 -0
  875. data/lib/docspace-api-sdk/models/save-additional-resources-request.rb +212 -0
  876. data/lib/docspace-api-sdk/models/save-as-pdf-request.rb +182 -0
  877. data/lib/docspace-api-sdk/models/save-auth-keys-request-dto.rb +219 -0
  878. data/lib/docspace-api-sdk/models/save-company-info-request.rb +347 -0
  879. data/lib/docspace-api-sdk/models/save-form-role-mapping-dto.rb +184 -0
  880. data/lib/docspace-api-sdk/models/schedule-dto.rb +312 -0
  881. data/lib/docspace-api-sdk/models/schedule-wrapper.rb +194 -0
  882. data/lib/docspace-api-sdk/models/scope-response.rb +172 -0
  883. data/lib/docspace-api-sdk/models/search-area.rb +51 -0
  884. data/lib/docspace-api-sdk/models/security-array-wrapper.rb +196 -0
  885. data/lib/docspace-api-sdk/models/security-dto.rb +199 -0
  886. data/lib/docspace-api-sdk/models/security-info-request-dto.rb +226 -0
  887. data/lib/docspace-api-sdk/models/security-info-simple-request-dto.rb +200 -0
  888. data/lib/docspace-api-sdk/models/security-request-dto.rb +206 -0
  889. data/lib/docspace-api-sdk/models/service-price-array-wrapper.rb +196 -0
  890. data/lib/docspace-api-sdk/models/service-price-dto.rb +296 -0
  891. data/lib/docspace-api-sdk/models/session-request.rb +206 -0
  892. data/lib/docspace-api-sdk/models/set-app-enabled-request.rb +169 -0
  893. data/lib/docspace-api-sdk/models/set-app-settings-request.rb +152 -0
  894. data/lib/docspace-api-sdk/models/set-audit-lifetime-settings-request.rb +172 -0
  895. data/lib/docspace-api-sdk/models/set-custom-fields.rb +171 -0
  896. data/lib/docspace-api-sdk/models/set-manager-request.rb +169 -0
  897. data/lib/docspace-api-sdk/models/set-metadata-values.rb +171 -0
  898. data/lib/docspace-api-sdk/models/set-public-dto.rb +197 -0
  899. data/lib/docspace-api-sdk/models/set-restricted-ai-models-request-dto.rb +171 -0
  900. data/lib/docspace-api-sdk/models/set-wallet-top-up-settings-request.rb +269 -0
  901. data/lib/docspace-api-sdk/models/settings-dto.rb +684 -0
  902. data/lib/docspace-api-sdk/models/settings-request-dto.rb +152 -0
  903. data/lib/docspace-api-sdk/models/settings-wrapper.rb +194 -0
  904. data/lib/docspace-api-sdk/models/share-filter-type.rb +49 -0
  905. data/lib/docspace-api-sdk/models/signup-account-request-dto.rb +211 -0
  906. data/lib/docspace-api-sdk/models/smtp-operation-status-dto.rb +195 -0
  907. data/lib/docspace-api-sdk/models/smtp-operation-status-wrapper.rb +194 -0
  908. data/lib/docspace-api-sdk/models/smtp-settings-dto.rb +368 -0
  909. data/lib/docspace-api-sdk/models/smtp-settings-wrapper.rb +194 -0
  910. data/lib/docspace-api-sdk/models/socket-settings-dto.rb +153 -0
  911. data/lib/docspace-api-sdk/models/socket-settings-wrapper.rb +194 -0
  912. data/lib/docspace-api-sdk/models/sort-order.rb +43 -0
  913. data/lib/docspace-api-sdk/models/sorted-by-type.rb +54 -0
  914. data/lib/docspace-api-sdk/models/sso-binding-type-dto.rb +164 -0
  915. data/lib/docspace-api-sdk/models/sso-certificate-dto.rb +216 -0
  916. data/lib/docspace-api-sdk/models/sso-encrypt-algorithm-type-dto.rb +175 -0
  917. data/lib/docspace-api-sdk/models/sso-field-mapping-dto.rb +208 -0
  918. data/lib/docspace-api-sdk/models/sso-idp-certificate-action-type-dto.rb +175 -0
  919. data/lib/docspace-api-sdk/models/sso-idp-certificate-advanced-dto.rb +204 -0
  920. data/lib/docspace-api-sdk/models/sso-idp-settings-dto.rb +208 -0
  921. data/lib/docspace-api-sdk/models/sso-name-id-format-type-dto.rb +252 -0
  922. data/lib/docspace-api-sdk/models/sso-settings-constants-dto.rb +202 -0
  923. data/lib/docspace-api-sdk/models/sso-settings-constants-wrapper.rb +194 -0
  924. data/lib/docspace-api-sdk/models/sso-settings-dto.rb +270 -0
  925. data/lib/docspace-api-sdk/models/sso-settings-request-dto.rb +155 -0
  926. data/lib/docspace-api-sdk/models/sso-settings-wrapper.rb +194 -0
  927. data/lib/docspace-api-sdk/models/sso-signing-algorithm-type-dto.rb +175 -0
  928. data/lib/docspace-api-sdk/models/sso-sp-certificate-action-type-dto.rb +175 -0
  929. data/lib/docspace-api-sdk/models/sso-sp-certificate-advanced-dto.rb +215 -0
  930. data/lib/docspace-api-sdk/models/start-backup-request-dto.rb +197 -0
  931. data/lib/docspace-api-sdk/models/start-backup-restore-request-dto.rb +220 -0
  932. data/lib/docspace-api-sdk/models/start-edit-request.rb +152 -0
  933. data/lib/docspace-api-sdk/models/start-filling-form.rb +153 -0
  934. data/lib/docspace-api-sdk/models/start-filling-mode.rb +45 -0
  935. data/lib/docspace-api-sdk/models/start-reassign-request-dto.rb +206 -0
  936. data/lib/docspace-api-sdk/models/start-update-user-type-dto.rb +195 -0
  937. data/lib/docspace-api-sdk/models/storage-array-wrapper.rb +196 -0
  938. data/lib/docspace-api-sdk/models/storage-dto.rb +235 -0
  939. data/lib/docspace-api-sdk/models/storage-encryption-request-dto.rb +152 -0
  940. data/lib/docspace-api-sdk/models/storage-filter.rb +44 -0
  941. data/lib/docspace-api-sdk/models/storage-request-dto.rb +168 -0
  942. data/lib/docspace-api-sdk/models/storage-settings-dto.rb +175 -0
  943. data/lib/docspace-api-sdk/models/storage-settings-wrapper.rb +194 -0
  944. data/lib/docspace-api-sdk/models/string-array-wrapper.rb +196 -0
  945. data/lib/docspace-api-sdk/models/string-wrapper.rb +194 -0
  946. data/lib/docspace-api-sdk/models/studio-default-page-settings-dto.rb +184 -0
  947. data/lib/docspace-api-sdk/models/studio-default-page-settings-wrapper.rb +194 -0
  948. data/lib/docspace-api-sdk/models/sub-account-dto.rb +163 -0
  949. data/lib/docspace-api-sdk/models/subject-type.rb +46 -0
  950. data/lib/docspace-api-sdk/models/submit-form-dto.rb +163 -0
  951. data/lib/docspace-api-sdk/models/subscription-balance-dto.rb +234 -0
  952. data/lib/docspace-api-sdk/models/subscription-balance-wrapper.rb +194 -0
  953. data/lib/docspace-api-sdk/models/tariff-dto.rb +271 -0
  954. data/lib/docspace-api-sdk/models/tariff-quota-dto.rb +246 -0
  955. data/lib/docspace-api-sdk/models/tariff-state.rb +45 -0
  956. data/lib/docspace-api-sdk/models/tariff-wrapper.rb +194 -0
  957. data/lib/docspace-api-sdk/models/task-progress-response-dto.rb +269 -0
  958. data/lib/docspace-api-sdk/models/task-progress-response-wrapper.rb +194 -0
  959. data/lib/docspace-api-sdk/models/telegram-status-dto.rb +202 -0
  960. data/lib/docspace-api-sdk/models/telegram-status-wrapper.rb +194 -0
  961. data/lib/docspace-api-sdk/models/templates-config-dto.rb +175 -0
  962. data/lib/docspace-api-sdk/models/templates-request-dto.rb +155 -0
  963. data/lib/docspace-api-sdk/models/tenant-ai-access-settings-dto.rb +162 -0
  964. data/lib/docspace-api-sdk/models/tenant-ai-access-settings-request-dto.rb +152 -0
  965. data/lib/docspace-api-sdk/models/tenant-ai-access-settings-wrapper.rb +194 -0
  966. data/lib/docspace-api-sdk/models/tenant-audit-settings-dto.rb +172 -0
  967. data/lib/docspace-api-sdk/models/tenant-audit-settings-request-dto.rb +152 -0
  968. data/lib/docspace-api-sdk/models/tenant-audit-settings-wrapper.rb +194 -0
  969. data/lib/docspace-api-sdk/models/tenant-banner-settings-dto.rb +162 -0
  970. data/lib/docspace-api-sdk/models/tenant-banner-settings-request-dto.rb +152 -0
  971. data/lib/docspace-api-sdk/models/tenant-banner-settings-wrapper.rb +194 -0
  972. data/lib/docspace-api-sdk/models/tenant-deep-link-settings-dto.rb +184 -0
  973. data/lib/docspace-api-sdk/models/tenant-deep-link-settings-wrapper.rb +194 -0
  974. data/lib/docspace-api-sdk/models/tenant-dev-tools-access-settings-dto.rb +162 -0
  975. data/lib/docspace-api-sdk/models/tenant-dev-tools-access-settings-request-dto.rb +152 -0
  976. data/lib/docspace-api-sdk/models/tenant-dev-tools-access-settings-wrapper.rb +194 -0
  977. data/lib/docspace-api-sdk/models/tenant-dto.rb +418 -0
  978. data/lib/docspace-api-sdk/models/tenant-industry.rb +58 -0
  979. data/lib/docspace-api-sdk/models/tenant-quota-dto.rb +610 -0
  980. data/lib/docspace-api-sdk/models/tenant-quota-feature-dto.rb +217 -0
  981. data/lib/docspace-api-sdk/models/tenant-quota-settings-dto.rb +183 -0
  982. data/lib/docspace-api-sdk/models/tenant-quota-settings-request-dto.rb +179 -0
  983. data/lib/docspace-api-sdk/models/tenant-quota-settings-wrapper.rb +194 -0
  984. data/lib/docspace-api-sdk/models/tenant-quota-wrapper.rb +194 -0
  985. data/lib/docspace-api-sdk/models/tenant-status.rb +49 -0
  986. data/lib/docspace-api-sdk/models/tenant-trusted-domains-type.rb +44 -0
  987. data/lib/docspace-api-sdk/models/tenant-user-invitation-settings-dto.rb +196 -0
  988. data/lib/docspace-api-sdk/models/tenant-user-invitation-settings-request-dto.rb +162 -0
  989. data/lib/docspace-api-sdk/models/tenant-user-invitation-settings-wrapper.rb +194 -0
  990. data/lib/docspace-api-sdk/models/tenant-wallet-service-settings-dto.rb +187 -0
  991. data/lib/docspace-api-sdk/models/tenant-wallet-service-settings-wrapper.rb +194 -0
  992. data/lib/docspace-api-sdk/models/tenant-wallet-service.rb +48 -0
  993. data/lib/docspace-api-sdk/models/tenant-wallet-settings-dto.rb +213 -0
  994. data/lib/docspace-api-sdk/models/tenant-wallet-settings-request-dto.rb +152 -0
  995. data/lib/docspace-api-sdk/models/tenant-wallet-settings-wrapper.rb +194 -0
  996. data/lib/docspace-api-sdk/models/tenant-wrapper.rb +194 -0
  997. data/lib/docspace-api-sdk/models/terminate-request-dto.rb +169 -0
  998. data/lib/docspace-api-sdk/models/tfa-app-code-array-wrapper.rb +196 -0
  999. data/lib/docspace-api-sdk/models/tfa-app-code-dto.rb +163 -0
  1000. data/lib/docspace-api-sdk/models/tfa-confirm-data-dto.rb +175 -0
  1001. data/lib/docspace-api-sdk/models/tfa-confirm-data-wrapper.rb +194 -0
  1002. data/lib/docspace-api-sdk/models/tfa-request-dto.rb +223 -0
  1003. data/lib/docspace-api-sdk/models/tfa-settings-array-wrapper.rb +196 -0
  1004. data/lib/docspace-api-sdk/models/tfa-settings-dto.rb +261 -0
  1005. data/lib/docspace-api-sdk/models/tfa-setup-code-dto.rb +175 -0
  1006. data/lib/docspace-api-sdk/models/tfa-setup-code-wrapper.rb +194 -0
  1007. data/lib/docspace-api-sdk/models/tfa-type.rb +44 -0
  1008. data/lib/docspace-api-sdk/models/tfa-validate-request-dto.rb +165 -0
  1009. data/lib/docspace-api-sdk/models/third-party-account-array-wrapper.rb +196 -0
  1010. data/lib/docspace-api-sdk/models/third-party-account-dto.rb +195 -0
  1011. data/lib/docspace-api-sdk/models/third-party-backup-request-dto.rb +208 -0
  1012. data/lib/docspace-api-sdk/models/third-party-check-conversion-request-dto.rb +215 -0
  1013. data/lib/docspace-api-sdk/models/third-party-chunked-upload-session-dto.rb +207 -0
  1014. data/lib/docspace-api-sdk/models/third-party-chunked-upload-session-result-dto.rb +162 -0
  1015. data/lib/docspace-api-sdk/models/third-party-chunked-upload-session-result-wrapper.rb +194 -0
  1016. data/lib/docspace-api-sdk/models/third-party-chunked-upload-session-wrapper.rb +194 -0
  1017. data/lib/docspace-api-sdk/models/third-party-configuration-dto.rb +394 -0
  1018. data/lib/docspace-api-sdk/models/third-party-configuration-wrapper.rb +194 -0
  1019. data/lib/docspace-api-sdk/models/third-party-draft-location.rb +186 -0
  1020. data/lib/docspace-api-sdk/models/third-party-file-array-wrapper.rb +196 -0
  1021. data/lib/docspace-api-sdk/models/third-party-file-dto.rb +928 -0
  1022. data/lib/docspace-api-sdk/models/third-party-file-entry-dto.rb +566 -0
  1023. data/lib/docspace-api-sdk/models/third-party-file-wrapper.rb +194 -0
  1024. data/lib/docspace-api-sdk/models/third-party-folder-array-wrapper.rb +196 -0
  1025. data/lib/docspace-api-sdk/models/third-party-folder-content-dto.rb +247 -0
  1026. data/lib/docspace-api-sdk/models/third-party-folder-content-wrapper.rb +194 -0
  1027. data/lib/docspace-api-sdk/models/third-party-folder-dto.rb +839 -0
  1028. data/lib/docspace-api-sdk/models/third-party-folder-wrapper.rb +194 -0
  1029. data/lib/docspace-api-sdk/models/third-party-request-dto.rb +223 -0
  1030. data/lib/docspace-api-sdk/models/third-party-save-as-pdf-request.rb +168 -0
  1031. data/lib/docspace-api-sdk/models/third-party-upload-session-response-dto.rb +216 -0
  1032. data/lib/docspace-api-sdk/models/third-party-upload-session-response-wrapper.rb +194 -0
  1033. data/lib/docspace-api-sdk/models/thumbnail.rb +46 -0
  1034. data/lib/docspace-api-sdk/models/thumbnails-data-dto.rb +208 -0
  1035. data/lib/docspace-api-sdk/models/thumbnails-data-wrapper.rb +194 -0
  1036. data/lib/docspace-api-sdk/models/thumbnails-request.rb +193 -0
  1037. data/lib/docspace-api-sdk/models/time-bound-dto.rb +163 -0
  1038. data/lib/docspace-api-sdk/models/timezone-array-wrapper.rb +196 -0
  1039. data/lib/docspace-api-sdk/models/timezone-dto.rb +168 -0
  1040. data/lib/docspace-api-sdk/models/token-diagnostics-dto.rb +166 -0
  1041. data/lib/docspace-api-sdk/models/token-diagnostics-wrapper.rb +194 -0
  1042. data/lib/docspace-api-sdk/models/top-up-deposit-request-dto.rb +215 -0
  1043. data/lib/docspace-api-sdk/models/transaction-info-dto.rb +173 -0
  1044. data/lib/docspace-api-sdk/models/turn-on-admin-message-settings-request-dto.rb +152 -0
  1045. data/lib/docspace-api-sdk/models/upcoming-payment-array-wrapper.rb +196 -0
  1046. data/lib/docspace-api-sdk/models/upcoming-payment-dto.rb +236 -0
  1047. data/lib/docspace-api-sdk/models/update-api-key-request.rb +212 -0
  1048. data/lib/docspace-api-sdk/models/update-client-request.rb +424 -0
  1049. data/lib/docspace-api-sdk/models/update-comment-request.rb +222 -0
  1050. data/lib/docspace-api-sdk/models/update-file-request.rb +187 -0
  1051. data/lib/docspace-api-sdk/models/update-folder-metadata-template-request.rb +184 -0
  1052. data/lib/docspace-api-sdk/models/update-group-request.rb +213 -0
  1053. data/lib/docspace-api-sdk/models/update-member-culture-request.rb +187 -0
  1054. data/lib/docspace-api-sdk/models/update-member-request-dto.rb +350 -0
  1055. data/lib/docspace-api-sdk/models/update-members-quota-request-dto-quota.rb +108 -0
  1056. data/lib/docspace-api-sdk/models/update-members-quota-request-dto.rb +164 -0
  1057. data/lib/docspace-api-sdk/models/update-members-request-dto.rb +165 -0
  1058. data/lib/docspace-api-sdk/models/update-metadata-field-request.rb +209 -0
  1059. data/lib/docspace-api-sdk/models/update-metadata-template.rb +164 -0
  1060. data/lib/docspace-api-sdk/models/update-photo-member-request.rb +153 -0
  1061. data/lib/docspace-api-sdk/models/update-room-group-request.rb +203 -0
  1062. data/lib/docspace-api-sdk/models/update-room-request.rb +348 -0
  1063. data/lib/docspace-api-sdk/models/update-rooms-quota-request-dto.rb +165 -0
  1064. data/lib/docspace-api-sdk/models/update-rooms-room-ids-request-dto.rb +155 -0
  1065. data/lib/docspace-api-sdk/models/update-tag-request-dto.rb +216 -0
  1066. data/lib/docspace-api-sdk/models/update-webhooks-config-request-dto.rb +385 -0
  1067. data/lib/docspace-api-sdk/models/upload-result-dto.rb +173 -0
  1068. data/lib/docspace-api-sdk/models/upload-result-wrapper.rb +194 -0
  1069. data/lib/docspace-api-sdk/models/upload-session-response-dto.rb +214 -0
  1070. data/lib/docspace-api-sdk/models/upload-session-response-wrapper.rb +194 -0
  1071. data/lib/docspace-api-sdk/models/usage-space-stat-item-array-wrapper.rb +196 -0
  1072. data/lib/docspace-api-sdk/models/usage-space-stat-item-dto.rb +196 -0
  1073. data/lib/docspace-api-sdk/models/user-config-dto.rb +199 -0
  1074. data/lib/docspace-api-sdk/models/user-exists-response-dto.rb +201 -0
  1075. data/lib/docspace-api-sdk/models/user-exists-response-wrapper.rb +194 -0
  1076. data/lib/docspace-api-sdk/models/user-invitation-request-dto.rb +210 -0
  1077. data/lib/docspace-api-sdk/models/user-invitation.rb +165 -0
  1078. data/lib/docspace-api-sdk/models/validation-error-response.rb +174 -0
  1079. data/lib/docspace-api-sdk/models/validation-result.rb +48 -0
  1080. data/lib/docspace-api-sdk/models/vectorization-status.rb +44 -0
  1081. data/lib/docspace-api-sdk/models/wallet-quantity-request-dto.rb +221 -0
  1082. data/lib/docspace-api-sdk/models/wallet-service-array-wrapper.rb +196 -0
  1083. data/lib/docspace-api-sdk/models/wallet-service-dto.rb +397 -0
  1084. data/lib/docspace-api-sdk/models/wallet-service-wrapper.rb +194 -0
  1085. data/lib/docspace-api-sdk/models/watermark-additions.rb +46 -0
  1086. data/lib/docspace-api-sdk/models/watermark-dto.rb +321 -0
  1087. data/lib/docspace-api-sdk/models/watermark-on-draw-dto.rb +219 -0
  1088. data/lib/docspace-api-sdk/models/watermark-paragraph-dto.rb +165 -0
  1089. data/lib/docspace-api-sdk/models/watermark-request-dto.rb +271 -0
  1090. data/lib/docspace-api-sdk/models/watermark-text-run-dto.rb +177 -0
  1091. data/lib/docspace-api-sdk/models/web-item-security-request-dto.rb +178 -0
  1092. data/lib/docspace-api-sdk/models/web-items-security-request-dto.rb +155 -0
  1093. data/lib/docspace-api-sdk/models/web-plugin-array-wrapper.rb +196 -0
  1094. data/lib/docspace-api-sdk/models/web-plugin-dto.rb +452 -0
  1095. data/lib/docspace-api-sdk/models/web-plugin-request.rb +189 -0
  1096. data/lib/docspace-api-sdk/models/web-plugin-wrapper.rb +194 -0
  1097. data/lib/docspace-api-sdk/models/webhook-group-status.rb +47 -0
  1098. data/lib/docspace-api-sdk/models/webhook-retry-request-dto.rb +155 -0
  1099. data/lib/docspace-api-sdk/models/webhook-trigger-array-wrapper.rb +196 -0
  1100. data/lib/docspace-api-sdk/models/webhook-trigger-dto.rb +173 -0
  1101. data/lib/docspace-api-sdk/models/webhook-trigger.rb +73 -0
  1102. data/lib/docspace-api-sdk/models/webhooks-config-dto.rb +329 -0
  1103. data/lib/docspace-api-sdk/models/webhooks-config-with-status-array-wrapper.rb +196 -0
  1104. data/lib/docspace-api-sdk/models/webhooks-config-with-status-dto.rb +162 -0
  1105. data/lib/docspace-api-sdk/models/webhooks-config-wrapper.rb +194 -0
  1106. data/lib/docspace-api-sdk/models/webhooks-log-array-wrapper.rb +196 -0
  1107. data/lib/docspace-api-sdk/models/webhooks-log-dto.rb +309 -0
  1108. data/lib/docspace-api-sdk/models/webhooks-log-wrapper.rb +194 -0
  1109. data/lib/docspace-api-sdk/models/white-label-item-array-wrapper.rb +196 -0
  1110. data/lib/docspace-api-sdk/models/white-label-item-dto.rb +205 -0
  1111. data/lib/docspace-api-sdk/models/white-label-item-path-dto.rb +164 -0
  1112. data/lib/docspace-api-sdk/models/white-label-item-size-dto.rb +252 -0
  1113. data/lib/docspace-api-sdk/models/white-label-logo-type.rb +57 -0
  1114. data/lib/docspace-api-sdk/models/white-label-request-dto.rb +190 -0
  1115. data/lib/docspace-api-sdk/models/wizard-request-dto.rb +211 -0
  1116. data/lib/docspace-api-sdk/models/wizard-settings-dto.rb +162 -0
  1117. data/lib/docspace-api-sdk/models/wizard-settings-wrapper.rb +194 -0
  1118. data/lib/docspace-api-sdk/models/xlsx-report-response-dto.rb +172 -0
  1119. data/lib/docspace-api-sdk/models/xlsx-report-response-wrapper.rb +194 -0
  1120. data/lib/docspace-api-sdk/version.rb +20 -0
  1121. data/lib/docspace-api-sdk.rb +1153 -0
  1122. metadata +1208 -0
@@ -0,0 +1,2611 @@
1
+ # (c) Copyright Ascensio System SIA 2026
2
+ #
3
+ # Licensed under the Apache License, Version 2.0 (the "License");
4
+ # you may not use this file except in compliance with the License.
5
+ # You may obtain a copy of the License at
6
+ #
7
+ # http://www.apache.org/licenses/LICENSE-2.0
8
+ #
9
+ # Unless required by applicable law or agreed to in writing, software
10
+ # distributed under the License is distributed on an "AS IS" BASIS,
11
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
+ # See the License for the specific language governing permissions and
13
+ # limitations under the License.
14
+
15
+
16
+ require 'cgi'
17
+
18
+ module DocspaceApiSdk
19
+ module Files
20
+ class FoldersApi
21
+ attr_accessor :api_client
22
+
23
+ def initialize(api_client = ApiClient.default)
24
+ @api_client = api_client
25
+ end
26
+ # Check for upload conflicts
27
+ # Reports which of the submitted titles already belong to a file in the folder, so an upload can decide in advance whether to overwrite or to ask for another name. Only the clashing titles come back, unordered and without repetitions, and an empty array means every name is free. Matching is by title and ignores case, so a name that differs only in capitalisation is still reported; an existing file that is encrypted is left out, because an upload cannot take it over. The call changes nothing. It needs the same right as the upload itself, the right to add content to the folder, which room managers and content creators have and readers, editors and guests do not; an archived room, a section root and a folder the caller cannot write to are all refused, while an unknown folder is answered as missing. A request without `filesTitle` is rejected as an invalid request, an empty list is accepted and answers with an empty array.
28
+ # See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/check-upload/
29
+ # @param folder_id [Integer, String] The folder whose contents the names are tested against; take the id from a listing such as `GET api/2.0/files/@root`.
30
+ # @param check_upload_request [CheckUploadRequest] The names to test against the files the folder already holds.
31
+ # @param [Hash] opts the optional parameters
32
+ # @return [StringArrayWrapper]
33
+ def check_upload(folder_id, check_upload_request, opts = {})
34
+ data, _status_code, _headers = check_upload_with_http_info(folder_id, check_upload_request, opts)
35
+ data
36
+ end
37
+
38
+ # Check for upload conflicts
39
+ # Reports which of the submitted titles already belong to a file in the folder, so an upload can decide in advance whether to overwrite or to ask for another name. Only the clashing titles come back, unordered and without repetitions, and an empty array means every name is free. Matching is by title and ignores case, so a name that differs only in capitalisation is still reported; an existing file that is encrypted is left out, because an upload cannot take it over. The call changes nothing. It needs the same right as the upload itself, the right to add content to the folder, which room managers and content creators have and readers, editors and guests do not; an archived room, a section root and a folder the caller cannot write to are all refused, while an unknown folder is answered as missing. A request without `filesTitle` is rejected as an invalid request, an empty list is accepted and answers with an empty array.
40
+ # See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/check-upload/
41
+ # @param folder_id [Integer, String] The folder whose contents the names are tested against; take the id from a listing such as `GET api/2.0/files/@root`.
42
+ # @param check_upload_request [CheckUploadRequest] The names to test against the files the folder already holds.
43
+ # @param [Hash] opts the optional parameters
44
+ # @return [Array<(StringArrayWrapper, Integer, Hash)>] StringArrayWrapper data, response status code and response headers
45
+ def check_upload_with_http_info(folder_id, check_upload_request, opts = {})
46
+ if @api_client.config.debugging
47
+ @api_client.config.logger.debug 'Calling API: Files::FoldersApi.check_upload ...'
48
+ end
49
+ # verify the required parameter 'folder_id' is set
50
+ if @api_client.config.client_side_validation && folder_id.nil?
51
+ fail ArgumentError, "Missing the required parameter 'folder_id' when calling Files::FoldersApi.check_upload"
52
+ end
53
+ # verify the required parameter 'check_upload_request' is set
54
+ if @api_client.config.client_side_validation && check_upload_request.nil?
55
+ fail ArgumentError, "Missing the required parameter 'check_upload_request' when calling Files::FoldersApi.check_upload"
56
+ end
57
+ # resource path
58
+ local_var_path = '/api/2.0/files/{folderId}/upload/check'.sub('{' + 'folderId' + '}', CGI.escape(folder_id.to_s))
59
+
60
+ # query parameters
61
+ query_params = opts[:query_params] || {}
62
+
63
+ # header parameters
64
+ header_params = opts[:header_params] || {}
65
+ # HTTP header 'Accept' (if needed)
66
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
67
+ # HTTP header 'Content-Type'
68
+ content_type = @api_client.select_header_content_type(['application/json'])
69
+ if !content_type.nil?
70
+ header_params['Content-Type'] = content_type
71
+ end
72
+
73
+ # form parameters
74
+ form_params = opts[:form_params] || {}
75
+
76
+ # http body (model)
77
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(check_upload_request)
78
+
79
+ # return_type
80
+ return_type = opts[:debug_return_type] || 'StringArrayWrapper'
81
+
82
+ # auth_names
83
+ auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
84
+
85
+ new_options = opts.merge(
86
+ :operation => :"Files::FoldersApi.check_upload",
87
+ :header_params => header_params,
88
+ :query_params => query_params,
89
+ :form_params => form_params,
90
+ :body => post_body,
91
+ :auth_names => auth_names,
92
+ :return_type => return_type
93
+ )
94
+
95
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
96
+ if @api_client.config.debugging
97
+ @api_client.config.logger.debug "API called: Files::FoldersApi#check_upload\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
98
+ end
99
+ return data, status_code, headers
100
+ end
101
+
102
+ # Create a folder
103
+ # Creates a folder inside the folder named in the path and answers with the folder as it was stored. The title is trimmed, may not be blank and is refused when it is longer than the limit the schema prints; titles are not required to be unique, so creating the same title twice leaves two folders side by side, which makes the call mutating and not idempotent. The caller needs the right to create content in the parent, which the room manager, a content creator and the owner of a personal section have; a member without that right, an archived parent, and a section root that only holds rooms - Rooms, Forms and AI agents - are all refused, as is a parent that does not exist. Rooms are not created here: use `POST api/2.0/files/rooms` for those, and this operation for ordinary folders within them. Members of the room are notified of the new folder. Read the identifier of the new folder from `id` and fill it with `POST api/2.0/files/{folderId}/upload`.
104
+ # See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/create-folder/
105
+ # @param folder_id [Integer, String] The folder the request is addressed to: when a folder is created it is the parent that receives the new folder, and when a folder is renamed it is the folder that gets the new title.
106
+ # @param create_folder_request [CreateFolderRequest] The title carried by the request body.
107
+ # @param [Hash] opts the optional parameters
108
+ # @return [FolderWrapper, ThirdPartyFolderWrapper]
109
+ def create_folder(folder_id, create_folder_request, opts = {})
110
+ data, _status_code, _headers = create_folder_with_http_info(folder_id, create_folder_request, opts)
111
+ data
112
+ end
113
+
114
+ # Create a folder
115
+ # Creates a folder inside the folder named in the path and answers with the folder as it was stored. The title is trimmed, may not be blank and is refused when it is longer than the limit the schema prints; titles are not required to be unique, so creating the same title twice leaves two folders side by side, which makes the call mutating and not idempotent. The caller needs the right to create content in the parent, which the room manager, a content creator and the owner of a personal section have; a member without that right, an archived parent, and a section root that only holds rooms - Rooms, Forms and AI agents - are all refused, as is a parent that does not exist. Rooms are not created here: use `POST api/2.0/files/rooms` for those, and this operation for ordinary folders within them. Members of the room are notified of the new folder. Read the identifier of the new folder from `id` and fill it with `POST api/2.0/files/{folderId}/upload`.
116
+ # See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/create-folder/
117
+ # @param folder_id [Integer, String] The folder the request is addressed to: when a folder is created it is the parent that receives the new folder, and when a folder is renamed it is the folder that gets the new title.
118
+ # @param create_folder_request [CreateFolderRequest] The title carried by the request body.
119
+ # @param [Hash] opts the optional parameters
120
+ # @return [Array<(FolderWrapper, ThirdPartyFolderWrapper, Integer, Hash)>] FolderWrapper, ThirdPartyFolderWrapper data, response status code and response headers
121
+ def create_folder_with_http_info(folder_id, create_folder_request, opts = {})
122
+ if @api_client.config.debugging
123
+ @api_client.config.logger.debug 'Calling API: Files::FoldersApi.create_folder ...'
124
+ end
125
+ # verify the required parameter 'folder_id' is set
126
+ if @api_client.config.client_side_validation && folder_id.nil?
127
+ fail ArgumentError, "Missing the required parameter 'folder_id' when calling Files::FoldersApi.create_folder"
128
+ end
129
+ # verify the required parameter 'create_folder_request' is set
130
+ if @api_client.config.client_side_validation && create_folder_request.nil?
131
+ fail ArgumentError, "Missing the required parameter 'create_folder_request' when calling Files::FoldersApi.create_folder"
132
+ end
133
+ # resource path
134
+ local_var_path = '/api/2.0/files/folder/{folderId}'.sub('{' + 'folderId' + '}', CGI.escape(folder_id.to_s))
135
+
136
+ # query parameters
137
+ query_params = opts[:query_params] || {}
138
+
139
+ # header parameters
140
+ header_params = opts[:header_params] || {}
141
+ # HTTP header 'Accept' (if needed)
142
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
143
+ # HTTP header 'Content-Type'
144
+ content_type = @api_client.select_header_content_type(['application/json'])
145
+ if !content_type.nil?
146
+ header_params['Content-Type'] = content_type
147
+ end
148
+
149
+ # form parameters
150
+ form_params = opts[:form_params] || {}
151
+
152
+ # http body (model)
153
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(create_folder_request)
154
+
155
+ # return_type
156
+ return_type = opts[:debug_return_type] || (folder_id.is_a?(String) ? 'ThirdPartyFolderWrapper' : 'FolderWrapper')
157
+
158
+ # auth_names
159
+ auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
160
+
161
+ new_options = opts.merge(
162
+ :operation => :"Files::FoldersApi.create_folder",
163
+ :header_params => header_params,
164
+ :query_params => query_params,
165
+ :form_params => form_params,
166
+ :body => post_body,
167
+ :auth_names => auth_names,
168
+ :return_type => return_type
169
+ )
170
+
171
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
172
+ if @api_client.config.debugging
173
+ @api_client.config.logger.debug "API called: Files::FoldersApi#create_folder\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
174
+ end
175
+ return data, status_code, headers
176
+ end
177
+
178
+ # Create the folder primary external link
179
+ # Answers with the primary external link of a folder or a room, creating it on the first call and returning the one that already exists afterwards, so the operation is idempotent in effect: a second call with other parameters does not reconfigure the existing link, and changing one is the business of `PUT api/2.0/files/folder/{id}/links`. The parameters therefore only shape the link at the moment it is born - `access` its rights, `title` its name, `expirationDate` its lifetime, which is unlimited here unless one is given, `internal` whether only signed-in members may follow it, `denyDownload` whether the contents may only be viewed, and `password` a secret to be asked for. Sending `access` with the value that grants nothing creates no link and answers with nothing. The caller needs the right to manage the links of the room the folder belongs to, which its manager and a portal administrator acting as room manager have, and a member with content-creator or read access is refused with 403; an unknown folder is answered with 404. Read the address from `sharedTo.shareLink`.
180
+ # See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/create-folder-primary-external-link/
181
+ # @param id [Integer, String] The folder or room the link belongs to.
182
+ # @param folder_link_request [FolderLinkRequest] The link and the way it is to be shaped.
183
+ # @param [Hash] opts the optional parameters
184
+ # @return [FileShareWrapper]
185
+ def create_folder_primary_external_link(id, folder_link_request, opts = {})
186
+ data, _status_code, _headers = create_folder_primary_external_link_with_http_info(id, folder_link_request, opts)
187
+ data
188
+ end
189
+
190
+ # Create the folder primary external link
191
+ # Answers with the primary external link of a folder or a room, creating it on the first call and returning the one that already exists afterwards, so the operation is idempotent in effect: a second call with other parameters does not reconfigure the existing link, and changing one is the business of `PUT api/2.0/files/folder/{id}/links`. The parameters therefore only shape the link at the moment it is born - `access` its rights, `title` its name, `expirationDate` its lifetime, which is unlimited here unless one is given, `internal` whether only signed-in members may follow it, `denyDownload` whether the contents may only be viewed, and `password` a secret to be asked for. Sending `access` with the value that grants nothing creates no link and answers with nothing. The caller needs the right to manage the links of the room the folder belongs to, which its manager and a portal administrator acting as room manager have, and a member with content-creator or read access is refused with 403; an unknown folder is answered with 404. Read the address from `sharedTo.shareLink`.
192
+ # See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/create-folder-primary-external-link/
193
+ # @param id [Integer, String] The folder or room the link belongs to.
194
+ # @param folder_link_request [FolderLinkRequest] The link and the way it is to be shaped.
195
+ # @param [Hash] opts the optional parameters
196
+ # @return [Array<(FileShareWrapper, Integer, Hash)>] FileShareWrapper data, response status code and response headers
197
+ def create_folder_primary_external_link_with_http_info(id, folder_link_request, opts = {})
198
+ if @api_client.config.debugging
199
+ @api_client.config.logger.debug 'Calling API: Files::FoldersApi.create_folder_primary_external_link ...'
200
+ end
201
+ # verify the required parameter 'id' is set
202
+ if @api_client.config.client_side_validation && id.nil?
203
+ fail ArgumentError, "Missing the required parameter 'id' when calling Files::FoldersApi.create_folder_primary_external_link"
204
+ end
205
+ # verify the required parameter 'folder_link_request' is set
206
+ if @api_client.config.client_side_validation && folder_link_request.nil?
207
+ fail ArgumentError, "Missing the required parameter 'folder_link_request' when calling Files::FoldersApi.create_folder_primary_external_link"
208
+ end
209
+ # resource path
210
+ local_var_path = '/api/2.0/files/folder/{id}/link'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
211
+
212
+ # query parameters
213
+ query_params = opts[:query_params] || {}
214
+
215
+ # header parameters
216
+ header_params = opts[:header_params] || {}
217
+ # HTTP header 'Accept' (if needed)
218
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
219
+ # HTTP header 'Content-Type'
220
+ content_type = @api_client.select_header_content_type(['application/json'])
221
+ if !content_type.nil?
222
+ header_params['Content-Type'] = content_type
223
+ end
224
+
225
+ # form parameters
226
+ form_params = opts[:form_params] || {}
227
+
228
+ # http body (model)
229
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(folder_link_request)
230
+
231
+ # return_type
232
+ return_type = opts[:debug_return_type] || 'FileShareWrapper'
233
+
234
+ # auth_names
235
+ auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
236
+
237
+ new_options = opts.merge(
238
+ :operation => :"Files::FoldersApi.create_folder_primary_external_link",
239
+ :header_params => header_params,
240
+ :query_params => query_params,
241
+ :form_params => form_params,
242
+ :body => post_body,
243
+ :auth_names => auth_names,
244
+ :return_type => return_type
245
+ )
246
+
247
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
248
+ if @api_client.config.debugging
249
+ @api_client.config.logger.debug "API called: Files::FoldersApi#create_folder_primary_external_link\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
250
+ end
251
+ return data, status_code, headers
252
+ end
253
+
254
+ # Start the folder history report generation
255
+ # Queues a background job that renders the history of a folder into a spreadsheet, or into a CSV file when `format` asks for one, and saves the result in the caller's My documents. The answer is the queued task, not the report: poll `GET api/2.0/files/folder/{folderId}/log/report` until `isCompleted` is true, then take the file from `resultFileId`, `resultFileName` and `resultFileUrl`; the URL of a CSV file too large for the editor downloads it instead of opening it. An XLSX report keeps only the most recent events, at most 200,000 by default and fewer when the events are long, and its header says how many were left out; `format=Csv` exports every event of the period. `from` and `to` limit the exported period; leaving both out exports the whole history. While a report for the same folder and caller is still running, this call joins it and answers with the running task instead of starting a second one, so retrying is safe. The caller needs read access to the folder and may not be a guest - otherwise the call is refused with 403, and a folder that does not exist with 404; the report is available on every pricing plan, and 402 comes only when the login history and audit trail section is turned off for the portal. Only a portal administrator gets the address, browser and platform columns. Give up a running report with `DELETE api/2.0/files/folder/{folderId}/log/report`.
256
+ # See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/create-report-folder-history/
257
+ # @param folder_id [Integer] The folder whose history is exported; the report covers the folder itself and the entries inside it.
258
+ # @param [Hash] opts the optional parameters
259
+ # @option opts [AuditReportFormat] :format The shape the report is written in: `Xlsx` produces a spreadsheet and `Csv` a comma-separated text file, and either is saved as a file in My documents.
260
+ # @option opts [Time] :from The earliest moment an exported entry may have, read in the time zone of the portal; left out, the report starts at the oldest entry the portal still keeps.
261
+ # @option opts [Time] :to The latest moment an exported entry may have, read in the time zone of the portal; left out, the report ends at the newest entry.
262
+ # @return [DocumentBuilderTaskWrapper]
263
+ def create_report_folder_history(folder_id, opts = {})
264
+ data, _status_code, _headers = create_report_folder_history_with_http_info(folder_id, opts)
265
+ data
266
+ end
267
+
268
+ # Start the folder history report generation
269
+ # Queues a background job that renders the history of a folder into a spreadsheet, or into a CSV file when `format` asks for one, and saves the result in the caller's My documents. The answer is the queued task, not the report: poll `GET api/2.0/files/folder/{folderId}/log/report` until `isCompleted` is true, then take the file from `resultFileId`, `resultFileName` and `resultFileUrl`; the URL of a CSV file too large for the editor downloads it instead of opening it. An XLSX report keeps only the most recent events, at most 200,000 by default and fewer when the events are long, and its header says how many were left out; `format=Csv` exports every event of the period. `from` and `to` limit the exported period; leaving both out exports the whole history. While a report for the same folder and caller is still running, this call joins it and answers with the running task instead of starting a second one, so retrying is safe. The caller needs read access to the folder and may not be a guest - otherwise the call is refused with 403, and a folder that does not exist with 404; the report is available on every pricing plan, and 402 comes only when the login history and audit trail section is turned off for the portal. Only a portal administrator gets the address, browser and platform columns. Give up a running report with `DELETE api/2.0/files/folder/{folderId}/log/report`.
270
+ # See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/create-report-folder-history/
271
+ # @param folder_id [Integer] The folder whose history is exported; the report covers the folder itself and the entries inside it.
272
+ # @param [Hash] opts the optional parameters
273
+ # @option opts [AuditReportFormat] :format The shape the report is written in: `Xlsx` produces a spreadsheet and `Csv` a comma-separated text file, and either is saved as a file in My documents.
274
+ # @option opts [Time] :from The earliest moment an exported entry may have, read in the time zone of the portal; left out, the report starts at the oldest entry the portal still keeps.
275
+ # @option opts [Time] :to The latest moment an exported entry may have, read in the time zone of the portal; left out, the report ends at the newest entry.
276
+ # @return [Array<(DocumentBuilderTaskWrapper, Integer, Hash)>] DocumentBuilderTaskWrapper data, response status code and response headers
277
+ def create_report_folder_history_with_http_info(folder_id, opts = {})
278
+ if @api_client.config.debugging
279
+ @api_client.config.logger.debug 'Calling API: Files::FoldersApi.create_report_folder_history ...'
280
+ end
281
+ # verify the required parameter 'folder_id' is set
282
+ if @api_client.config.client_side_validation && folder_id.nil?
283
+ fail ArgumentError, "Missing the required parameter 'folder_id' when calling Files::FoldersApi.create_report_folder_history"
284
+ end
285
+ # resource path
286
+ local_var_path = '/api/2.0/files/folder/{folderId}/log/report'.sub('{' + 'folderId' + '}', CGI.escape(folder_id.to_s))
287
+
288
+ # query parameters
289
+ query_params = opts[:query_params] || {}
290
+ query_params[:'format'] = opts[:'format'] if !opts[:'format'].nil?
291
+ query_params[:'from'] = opts[:'from'] if !opts[:'from'].nil?
292
+ query_params[:'to'] = opts[:'to'] if !opts[:'to'].nil?
293
+
294
+ # header parameters
295
+ header_params = opts[:header_params] || {}
296
+ # HTTP header 'Accept' (if needed)
297
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
298
+
299
+ # form parameters
300
+ form_params = opts[:form_params] || {}
301
+
302
+ # http body (model)
303
+ post_body = opts[:debug_body]
304
+
305
+ # return_type
306
+ return_type = opts[:debug_return_type] || 'DocumentBuilderTaskWrapper'
307
+
308
+ # auth_names
309
+ auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
310
+
311
+ new_options = opts.merge(
312
+ :operation => :"Files::FoldersApi.create_report_folder_history",
313
+ :header_params => header_params,
314
+ :query_params => query_params,
315
+ :form_params => form_params,
316
+ :body => post_body,
317
+ :auth_names => auth_names,
318
+ :return_type => return_type
319
+ )
320
+
321
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
322
+ if @api_client.config.debugging
323
+ @api_client.config.logger.debug "API called: Files::FoldersApi#create_report_folder_history\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
324
+ end
325
+ return data, status_code, headers
326
+ end
327
+
328
+ # Delete a folder
329
+ # Queues the deletion of one folder together with everything inside it, and answers with the file operations of the caller, the one just created among them. The folder is not gone when the response arrives: poll `GET api/2.0/files/fileops` until the operation reports `finished`, and read its `error` to learn whether the deletion succeeded. By default the folder is moved to the Trash section, from where it can be restored; `immediately=true` discards it for good instead, and inside a room, where there is no Trash, deletion is always final. `deleteAfter=true` postpones the deletion until the editing sessions on the contents have ended, so files somebody is working on are not pulled away. The caller needs the right to delete the folder, which the room manager, a portal administrator acting as room manager and a content creator acting on a folder of their own have; editing access alone, read access and a guest are refused. The call is destructive. To delete several items at once use `PUT api/2.0/files/fileops/delete`.
330
+ # See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/delete-folder/
331
+ # @param folder_id [Integer, String] The folder to delete, together with everything it holds.
332
+ # @param delete_folder_request [DeleteFolderRequest] How the deletion is to be carried out.
333
+ # @param [Hash] opts the optional parameters
334
+ # @return [FileOperationArrayWrapper]
335
+ def delete_folder(folder_id, delete_folder_request, opts = {})
336
+ data, _status_code, _headers = delete_folder_with_http_info(folder_id, delete_folder_request, opts)
337
+ data
338
+ end
339
+
340
+ # Delete a folder
341
+ # Queues the deletion of one folder together with everything inside it, and answers with the file operations of the caller, the one just created among them. The folder is not gone when the response arrives: poll `GET api/2.0/files/fileops` until the operation reports `finished`, and read its `error` to learn whether the deletion succeeded. By default the folder is moved to the Trash section, from where it can be restored; `immediately=true` discards it for good instead, and inside a room, where there is no Trash, deletion is always final. `deleteAfter=true` postpones the deletion until the editing sessions on the contents have ended, so files somebody is working on are not pulled away. The caller needs the right to delete the folder, which the room manager, a portal administrator acting as room manager and a content creator acting on a folder of their own have; editing access alone, read access and a guest are refused. The call is destructive. To delete several items at once use `PUT api/2.0/files/fileops/delete`.
342
+ # See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/delete-folder/
343
+ # @param folder_id [Integer, String] The folder to delete, together with everything it holds.
344
+ # @param delete_folder_request [DeleteFolderRequest] How the deletion is to be carried out.
345
+ # @param [Hash] opts the optional parameters
346
+ # @return [Array<(FileOperationArrayWrapper, Integer, Hash)>] FileOperationArrayWrapper data, response status code and response headers
347
+ def delete_folder_with_http_info(folder_id, delete_folder_request, opts = {})
348
+ if @api_client.config.debugging
349
+ @api_client.config.logger.debug 'Calling API: Files::FoldersApi.delete_folder ...'
350
+ end
351
+ # verify the required parameter 'folder_id' is set
352
+ if @api_client.config.client_side_validation && folder_id.nil?
353
+ fail ArgumentError, "Missing the required parameter 'folder_id' when calling Files::FoldersApi.delete_folder"
354
+ end
355
+ # verify the required parameter 'delete_folder_request' is set
356
+ if @api_client.config.client_side_validation && delete_folder_request.nil?
357
+ fail ArgumentError, "Missing the required parameter 'delete_folder_request' when calling Files::FoldersApi.delete_folder"
358
+ end
359
+ # resource path
360
+ local_var_path = '/api/2.0/files/folder/{folderId}'.sub('{' + 'folderId' + '}', CGI.escape(folder_id.to_s))
361
+
362
+ # query parameters
363
+ query_params = opts[:query_params] || {}
364
+
365
+ # header parameters
366
+ header_params = opts[:header_params] || {}
367
+ # HTTP header 'Accept' (if needed)
368
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
369
+ # HTTP header 'Content-Type'
370
+ content_type = @api_client.select_header_content_type(['application/json'])
371
+ if !content_type.nil?
372
+ header_params['Content-Type'] = content_type
373
+ end
374
+
375
+ # form parameters
376
+ form_params = opts[:form_params] || {}
377
+
378
+ # http body (model)
379
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(delete_folder_request)
380
+
381
+ # return_type
382
+ return_type = opts[:debug_return_type] || 'FileOperationArrayWrapper'
383
+
384
+ # auth_names
385
+ auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
386
+
387
+ new_options = opts.merge(
388
+ :operation => :"Files::FoldersApi.delete_folder",
389
+ :header_params => header_params,
390
+ :query_params => query_params,
391
+ :form_params => form_params,
392
+ :body => post_body,
393
+ :auth_names => auth_names,
394
+ :return_type => return_type
395
+ )
396
+
397
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
398
+ if @api_client.config.debugging
399
+ @api_client.config.logger.debug "API called: Files::FoldersApi#delete_folder\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
400
+ end
401
+ return data, status_code, headers
402
+ end
403
+
404
+ # Generate XLSX report by folder
405
+ # Rebuilds the spreadsheet that gathers the answers submitted to a form, starting from the Complete folder that holds the filled copies. The answer names the original form the results belong to, says in `isNewFile` whether the spreadsheet is being created or an existing one rewritten in place, and carries the queued job in `task`; the file itself is not ready yet, so poll `GET api/2.0/files/file/{fileId}/xlsx` with the identifier of the form until the task reports completion. The folder has to be the Complete folder of a form-filling room and has to hold at least one submitted copy whose original form still exists, and the caller needs the right to maintain that form, which the room manager has. A folder that does not exist, or one that holds nothing to report on, is answered with 404, and a folder of the wrong kind or a caller without those rights with 403. The call is mutating: it writes the results file of the form.
406
+ # See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/generate-xlsx-by-folder/
407
+ # @param folder_id [Integer] The folder the operation acts on. Take the identifier from a listing such as `GET api/2.0/files/@root` or `GET api/2.0/files/{folderId}`: a folder stored in the portal is numbered, while a folder in a connected third-party account is named by an opaque string.
408
+ # @param [Hash] opts the optional parameters
409
+ # @return [XlsxReportResponseWrapper]
410
+ def generate_xlsx_by_folder(folder_id, opts = {})
411
+ data, _status_code, _headers = generate_xlsx_by_folder_with_http_info(folder_id, opts)
412
+ data
413
+ end
414
+
415
+ # Generate XLSX report by folder
416
+ # Rebuilds the spreadsheet that gathers the answers submitted to a form, starting from the Complete folder that holds the filled copies. The answer names the original form the results belong to, says in `isNewFile` whether the spreadsheet is being created or an existing one rewritten in place, and carries the queued job in `task`; the file itself is not ready yet, so poll `GET api/2.0/files/file/{fileId}/xlsx` with the identifier of the form until the task reports completion. The folder has to be the Complete folder of a form-filling room and has to hold at least one submitted copy whose original form still exists, and the caller needs the right to maintain that form, which the room manager has. A folder that does not exist, or one that holds nothing to report on, is answered with 404, and a folder of the wrong kind or a caller without those rights with 403. The call is mutating: it writes the results file of the form.
417
+ # See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/generate-xlsx-by-folder/
418
+ # @param folder_id [Integer] The folder the operation acts on. Take the identifier from a listing such as `GET api/2.0/files/@root` or `GET api/2.0/files/{folderId}`: a folder stored in the portal is numbered, while a folder in a connected third-party account is named by an opaque string.
419
+ # @param [Hash] opts the optional parameters
420
+ # @return [Array<(XlsxReportResponseWrapper, Integer, Hash)>] XlsxReportResponseWrapper data, response status code and response headers
421
+ def generate_xlsx_by_folder_with_http_info(folder_id, opts = {})
422
+ if @api_client.config.debugging
423
+ @api_client.config.logger.debug 'Calling API: Files::FoldersApi.generate_xlsx_by_folder ...'
424
+ end
425
+ # verify the required parameter 'folder_id' is set
426
+ if @api_client.config.client_side_validation && folder_id.nil?
427
+ fail ArgumentError, "Missing the required parameter 'folder_id' when calling Files::FoldersApi.generate_xlsx_by_folder"
428
+ end
429
+ # resource path
430
+ local_var_path = '/api/2.0/files/folder/{folderId}/xlsx'.sub('{' + 'folderId' + '}', CGI.escape(folder_id.to_s))
431
+
432
+ # query parameters
433
+ query_params = opts[:query_params] || {}
434
+
435
+ # header parameters
436
+ header_params = opts[:header_params] || {}
437
+ # HTTP header 'Accept' (if needed)
438
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
439
+
440
+ # form parameters
441
+ form_params = opts[:form_params] || {}
442
+
443
+ # http body (model)
444
+ post_body = opts[:debug_body]
445
+
446
+ # return_type
447
+ return_type = opts[:debug_return_type] || 'XlsxReportResponseWrapper'
448
+
449
+ # auth_names
450
+ auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
451
+
452
+ new_options = opts.merge(
453
+ :operation => :"Files::FoldersApi.generate_xlsx_by_folder",
454
+ :header_params => header_params,
455
+ :query_params => query_params,
456
+ :form_params => form_params,
457
+ :body => post_body,
458
+ :auth_names => auth_names,
459
+ :return_type => return_type
460
+ )
461
+
462
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
463
+ if @api_client.config.debugging
464
+ @api_client.config.logger.debug "API called: Files::FoldersApi#generate_xlsx_by_folder\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
465
+ end
466
+ return data, status_code, headers
467
+ end
468
+
469
+ # Get the Favorites section
470
+ # Returns the caller's own Favorites section: the files and folders this account has marked as favorite, together with the section folder itself. Favorites are per-account, so the entries another member marked are not listed here, and a guest sees only their own, usually empty, list. Mark a single file with `GET api/2.0/files/favorites/{fileId}`, or add and remove batches of files and folders with `POST api/2.0/files/favorites` and `DELETE api/2.0/files/favorites`. Nothing in the section is modified, though passing `sortBy` saves the requested order as the default order for this account. Entries the caller can no longer read, and entries that have been moved to the Trash section, drop out of the listing even though their favorite mark stays, so the section can shrink without an explicit unmark. `folders` and `files` hold one page of the section, `total` counts the entries matching the request before `count` and `startIndex` are applied, and `current` describes the section folder itself.
471
+ # See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-favorites-folder/
472
+ # @param [Hash] opts the optional parameters
473
+ # @option opts [String] :user_id_or_group_id Restricts the listing to the entries authored by this portal member, or by the members of this group; the same parameter accepts either kind of identifier. Omit it to list everything the caller can read.
474
+ # @option opts [FilterType] :filter_type Narrows the listing to a single kind of entry, such as documents, images or one type of room. Omit it to list every kind the section holds.
475
+ # @option opts [Integer] :count The size of one page of section content. Pair it with `startIndex` to walk the listing, and compare the two with `total` in the response to see when the last page has been read.
476
+ # @option opts [Integer] :start_index The number of matching entries to skip before the returned page begins; add `count` to it to ask for the next page.
477
+ # @option opts [String] :sort_by The name of the field the entries are ordered by, matched case-insensitively against the file sort fields: `DateAndTime`, `AZ`, `Size`, `Author`, `Type`, `New`, `DateAndTimeCreation`, `RoomType`, `Tags`, `Room`, `CustomOrder`, `LastOpened` and `UsedSpace`. A recognized value is also saved as the default order of the account and reused by later listings that omit the parameter, while a value matching none of the fields leaves that saved order in place.
478
+ # @option opts [SortOrder] :sort_order The direction in which the `sortBy` field is ordered. It is saved together with `sortBy` as the default order of the account.
479
+ # @option opts [String] :filter_value The search string the section is filtered by: it is matched as a substring of entry titles and, for files, against the indexed document content as well. Omit it to list the section unfiltered.
480
+ # @option opts [Integer] :metadata_template_id The ID of the metadata template the entries must be assigned to. On its own it narrows the listing to the entries carrying the template; together with the metadata filters it also pins the template the filtered fields belong to. The third-party entries never carry metadata and are left out when the filter is set.
481
+ # @option opts [String] :metadata_filters The URL-encoded JSON array of the metadata filter conditions, e.g. [{fieldId:1,op:contains,value:ACME},{fieldId:2,op:range,from:2026-01-01,to:2026-06-30},{fieldId:3,op:in,optionIds:[...]}]. A string field takes eq or contains; a number or a date field takes range with inclusive bounds, or gt, gte, lt, lte with the bound in value; a date-only bound covers the whole day. A custom field is addressed by its name instead of the fieldId: {name:Client,op:eq,value:ACME}.
482
+ # @option opts [Boolean] :include_hidden_metadata Whether the text search, and the metadataMatches it reports, also look at the values of the hidden metadata templates (created with visible false for the metadata a service keeps for itself, which the web client never shows). False, the default, leaves them out, so an entry is not found by such a value; true takes them in. metadataTemplateId and metadataFilters are not concerned: a hidden template or field named there is searched either way.
483
+ # @return [FolderContentWrapper]
484
+ def get_favorites_folder(opts = {})
485
+ data, _status_code, _headers = get_favorites_folder_with_http_info(opts)
486
+ data
487
+ end
488
+
489
+ # Get the Favorites section
490
+ # Returns the caller's own Favorites section: the files and folders this account has marked as favorite, together with the section folder itself. Favorites are per-account, so the entries another member marked are not listed here, and a guest sees only their own, usually empty, list. Mark a single file with `GET api/2.0/files/favorites/{fileId}`, or add and remove batches of files and folders with `POST api/2.0/files/favorites` and `DELETE api/2.0/files/favorites`. Nothing in the section is modified, though passing `sortBy` saves the requested order as the default order for this account. Entries the caller can no longer read, and entries that have been moved to the Trash section, drop out of the listing even though their favorite mark stays, so the section can shrink without an explicit unmark. `folders` and `files` hold one page of the section, `total` counts the entries matching the request before `count` and `startIndex` are applied, and `current` describes the section folder itself.
491
+ # See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-favorites-folder/
492
+ # @param [Hash] opts the optional parameters
493
+ # @option opts [String] :user_id_or_group_id Restricts the listing to the entries authored by this portal member, or by the members of this group; the same parameter accepts either kind of identifier. Omit it to list everything the caller can read.
494
+ # @option opts [FilterType] :filter_type Narrows the listing to a single kind of entry, such as documents, images or one type of room. Omit it to list every kind the section holds.
495
+ # @option opts [Integer] :count The size of one page of section content. Pair it with `startIndex` to walk the listing, and compare the two with `total` in the response to see when the last page has been read.
496
+ # @option opts [Integer] :start_index The number of matching entries to skip before the returned page begins; add `count` to it to ask for the next page.
497
+ # @option opts [String] :sort_by The name of the field the entries are ordered by, matched case-insensitively against the file sort fields: `DateAndTime`, `AZ`, `Size`, `Author`, `Type`, `New`, `DateAndTimeCreation`, `RoomType`, `Tags`, `Room`, `CustomOrder`, `LastOpened` and `UsedSpace`. A recognized value is also saved as the default order of the account and reused by later listings that omit the parameter, while a value matching none of the fields leaves that saved order in place.
498
+ # @option opts [SortOrder] :sort_order The direction in which the `sortBy` field is ordered. It is saved together with `sortBy` as the default order of the account.
499
+ # @option opts [String] :filter_value The search string the section is filtered by: it is matched as a substring of entry titles and, for files, against the indexed document content as well. Omit it to list the section unfiltered.
500
+ # @option opts [Integer] :metadata_template_id The ID of the metadata template the entries must be assigned to. On its own it narrows the listing to the entries carrying the template; together with the metadata filters it also pins the template the filtered fields belong to. The third-party entries never carry metadata and are left out when the filter is set.
501
+ # @option opts [String] :metadata_filters The URL-encoded JSON array of the metadata filter conditions, e.g. [{fieldId:1,op:contains,value:ACME},{fieldId:2,op:range,from:2026-01-01,to:2026-06-30},{fieldId:3,op:in,optionIds:[...]}]. A string field takes eq or contains; a number or a date field takes range with inclusive bounds, or gt, gte, lt, lte with the bound in value; a date-only bound covers the whole day. A custom field is addressed by its name instead of the fieldId: {name:Client,op:eq,value:ACME}.
502
+ # @option opts [Boolean] :include_hidden_metadata Whether the text search, and the metadataMatches it reports, also look at the values of the hidden metadata templates (created with visible false for the metadata a service keeps for itself, which the web client never shows). False, the default, leaves them out, so an entry is not found by such a value; true takes them in. metadataTemplateId and metadataFilters are not concerned: a hidden template or field named there is searched either way.
503
+ # @return [Array<(FolderContentWrapper, Integer, Hash)>] FolderContentWrapper data, response status code and response headers
504
+ def get_favorites_folder_with_http_info(opts = {})
505
+ if @api_client.config.debugging
506
+ @api_client.config.logger.debug 'Calling API: Files::FoldersApi.get_favorites_folder ...'
507
+ end
508
+ if @api_client.config.client_side_validation && !opts[:'count'].nil? && opts[:'count'] > 100
509
+ fail ArgumentError, 'invalid value for "opts[:"count"]" when calling Files::FoldersApi.get_favorites_folder, must be smaller than or equal to 100.'
510
+ end
511
+
512
+ if @api_client.config.client_side_validation && !opts[:'count'].nil? && opts[:'count'] < 1
513
+ fail ArgumentError, 'invalid value for "opts[:"count"]" when calling Files::FoldersApi.get_favorites_folder, must be greater than or equal to 1.'
514
+ end
515
+
516
+ # resource path
517
+ local_var_path = '/api/2.0/files/@favorites'
518
+
519
+ # query parameters
520
+ query_params = opts[:query_params] || {}
521
+ query_params[:'userIdOrGroupId'] = opts[:'user_id_or_group_id'] if !opts[:'user_id_or_group_id'].nil?
522
+ query_params[:'filterType'] = opts[:'filter_type'] if !opts[:'filter_type'].nil?
523
+ query_params[:'count'] = opts[:'count'] if !opts[:'count'].nil?
524
+ query_params[:'startIndex'] = opts[:'start_index'] if !opts[:'start_index'].nil?
525
+ query_params[:'sortBy'] = opts[:'sort_by'] if !opts[:'sort_by'].nil?
526
+ query_params[:'sortOrder'] = opts[:'sort_order'] if !opts[:'sort_order'].nil?
527
+ query_params[:'filterValue'] = opts[:'filter_value'] if !opts[:'filter_value'].nil?
528
+ query_params[:'metadataTemplateId'] = opts[:'metadata_template_id'] if !opts[:'metadata_template_id'].nil?
529
+ query_params[:'metadataFilters'] = opts[:'metadata_filters'] if !opts[:'metadata_filters'].nil?
530
+ query_params[:'includeHiddenMetadata'] = opts[:'include_hidden_metadata'] if !opts[:'include_hidden_metadata'].nil?
531
+
532
+ # header parameters
533
+ header_params = opts[:header_params] || {}
534
+ # HTTP header 'Accept' (if needed)
535
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
536
+
537
+ # form parameters
538
+ form_params = opts[:form_params] || {}
539
+
540
+ # http body (model)
541
+ post_body = opts[:debug_body]
542
+
543
+ # return_type
544
+ return_type = opts[:debug_return_type] || 'FolderContentWrapper'
545
+
546
+ # auth_names
547
+ auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
548
+
549
+ new_options = opts.merge(
550
+ :operation => :"Files::FoldersApi.get_favorites_folder",
551
+ :header_params => header_params,
552
+ :query_params => query_params,
553
+ :form_params => form_params,
554
+ :body => post_body,
555
+ :auth_names => auth_names,
556
+ :return_type => return_type
557
+ )
558
+
559
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
560
+ if @api_client.config.debugging
561
+ @api_client.config.logger.debug "API called: Files::FoldersApi#get_favorites_folder\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
562
+ end
563
+ return data, status_code, headers
564
+ end
565
+
566
+ # Get used space of files
567
+ # Reports how much storage the portal spends on documents, split by section - My documents, Trash, Rooms, Archive and, where the feature is on, AI agents - each entry naming the section and the space it takes in bytes. The figures cover the whole portal rather than the calling account, and moving an entry between sections moves its space with it, which is why deleting a file to the Trash does not free anything until the Trash is emptied. Only a caller who may change portal settings, that is the owner and the portal administrators, is allowed here; a room administrator, an ordinary member and a guest are all refused. The call is read-only, takes no parameters and answers with the sections in a fixed order. The quota of the portal as a whole, storage outside documents included, is not part of this answer.
568
+ # See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-files-used-space/
569
+ # @param [Hash] opts the optional parameters
570
+ # @return [FilesStatisticsResultWrapper]
571
+ def get_files_used_space(opts = {})
572
+ data, _status_code, _headers = get_files_used_space_with_http_info(opts)
573
+ data
574
+ end
575
+
576
+ # Get used space of files
577
+ # Reports how much storage the portal spends on documents, split by section - My documents, Trash, Rooms, Archive and, where the feature is on, AI agents - each entry naming the section and the space it takes in bytes. The figures cover the whole portal rather than the calling account, and moving an entry between sections moves its space with it, which is why deleting a file to the Trash does not free anything until the Trash is emptied. Only a caller who may change portal settings, that is the owner and the portal administrators, is allowed here; a room administrator, an ordinary member and a guest are all refused. The call is read-only, takes no parameters and answers with the sections in a fixed order. The quota of the portal as a whole, storage outside documents included, is not part of this answer.
578
+ # See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-files-used-space/
579
+ # @param [Hash] opts the optional parameters
580
+ # @return [Array<(FilesStatisticsResultWrapper, Integer, Hash)>] FilesStatisticsResultWrapper data, response status code and response headers
581
+ def get_files_used_space_with_http_info(opts = {})
582
+ if @api_client.config.debugging
583
+ @api_client.config.logger.debug 'Calling API: Files::FoldersApi.get_files_used_space ...'
584
+ end
585
+ # resource path
586
+ local_var_path = '/api/2.0/files/filesusedspace'
587
+
588
+ # query parameters
589
+ query_params = opts[:query_params] || {}
590
+
591
+ # header parameters
592
+ header_params = opts[:header_params] || {}
593
+ # HTTP header 'Accept' (if needed)
594
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
595
+
596
+ # form parameters
597
+ form_params = opts[:form_params] || {}
598
+
599
+ # http body (model)
600
+ post_body = opts[:debug_body]
601
+
602
+ # return_type
603
+ return_type = opts[:debug_return_type] || 'FilesStatisticsResultWrapper'
604
+
605
+ # auth_names
606
+ auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
607
+
608
+ new_options = opts.merge(
609
+ :operation => :"Files::FoldersApi.get_files_used_space",
610
+ :header_params => header_params,
611
+ :query_params => query_params,
612
+ :form_params => form_params,
613
+ :body => post_body,
614
+ :auth_names => auth_names,
615
+ :return_type => return_type
616
+ )
617
+
618
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
619
+ if @api_client.config.debugging
620
+ @api_client.config.logger.debug "API called: Files::FoldersApi#get_files_used_space\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
621
+ end
622
+ return data, status_code, headers
623
+ end
624
+
625
+ # Get folder form filter
626
+ # Lists the fields the completed forms of a form-filling room carry, each of them a key and the kind of value behind it, so that a client can offer them as filters. Feed a pair from this list back as `formsItemKey` and `formsItemType` of `GET api/2.0/files/{folderId}` to keep only the completed forms whose field of that name holds a value. The fields are read from the search index of one of the forms already gathered, so they appear once indexing has caught up with the first submission. Only the Complete folder of a form-filling room carries such fields: for any other folder, for a folder that does not exist and for one that has been deleted the answer is an empty list rather than a refusal, and the same holds while nothing has been submitted yet. The operation reads the index alone, changes nothing and needs no authorization.
627
+ # See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-folder/
628
+ # @param folder_id [Integer] The folder the operation acts on. Take the identifier from a listing such as `GET api/2.0/files/@root` or `GET api/2.0/files/{folderId}`: a folder stored in the portal is numbered, while a folder in a connected third-party account is named by an opaque string.
629
+ # @param [Hash] opts the optional parameters
630
+ # @return [FormsItemArrayWrapper]
631
+ def get_folder(folder_id, opts = {})
632
+ data, _status_code, _headers = get_folder_with_http_info(folder_id, opts)
633
+ data
634
+ end
635
+
636
+ # Get folder form filter
637
+ # Lists the fields the completed forms of a form-filling room carry, each of them a key and the kind of value behind it, so that a client can offer them as filters. Feed a pair from this list back as `formsItemKey` and `formsItemType` of `GET api/2.0/files/{folderId}` to keep only the completed forms whose field of that name holds a value. The fields are read from the search index of one of the forms already gathered, so they appear once indexing has caught up with the first submission. Only the Complete folder of a form-filling room carries such fields: for any other folder, for a folder that does not exist and for one that has been deleted the answer is an empty list rather than a refusal, and the same holds while nothing has been submitted yet. The operation reads the index alone, changes nothing and needs no authorization.
638
+ # See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-folder/
639
+ # @param folder_id [Integer] The folder the operation acts on. Take the identifier from a listing such as `GET api/2.0/files/@root` or `GET api/2.0/files/{folderId}`: a folder stored in the portal is numbered, while a folder in a connected third-party account is named by an opaque string.
640
+ # @param [Hash] opts the optional parameters
641
+ # @return [Array<(FormsItemArrayWrapper, Integer, Hash)>] FormsItemArrayWrapper data, response status code and response headers
642
+ def get_folder_with_http_info(folder_id, opts = {})
643
+ if @api_client.config.debugging
644
+ @api_client.config.logger.debug 'Calling API: Files::FoldersApi.get_folder ...'
645
+ end
646
+ # verify the required parameter 'folder_id' is set
647
+ if @api_client.config.client_side_validation && folder_id.nil?
648
+ fail ArgumentError, "Missing the required parameter 'folder_id' when calling Files::FoldersApi.get_folder"
649
+ end
650
+ # resource path
651
+ local_var_path = '/api/2.0/files/{folderId}/formfilter'.sub('{' + 'folderId' + '}', CGI.escape(folder_id.to_s))
652
+
653
+ # query parameters
654
+ query_params = opts[:query_params] || {}
655
+
656
+ # header parameters
657
+ header_params = opts[:header_params] || {}
658
+ # HTTP header 'Accept' (if needed)
659
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
660
+
661
+ # form parameters
662
+ form_params = opts[:form_params] || {}
663
+
664
+ # http body (model)
665
+ post_body = opts[:debug_body]
666
+
667
+ # return_type
668
+ return_type = opts[:debug_return_type] || 'FormsItemArrayWrapper'
669
+
670
+ # auth_names
671
+ auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
672
+
673
+ new_options = opts.merge(
674
+ :operation => :"Files::FoldersApi.get_folder",
675
+ :header_params => header_params,
676
+ :query_params => query_params,
677
+ :form_params => form_params,
678
+ :body => post_body,
679
+ :auth_names => auth_names,
680
+ :return_type => return_type
681
+ )
682
+
683
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
684
+ if @api_client.config.debugging
685
+ @api_client.config.logger.debug "API called: Files::FoldersApi#get_folder\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
686
+ end
687
+ return data, status_code, headers
688
+ end
689
+
690
+ # Get a folder by ID
691
+ # Returns one page of the contents of a folder - its subfolders in `folders`, its files in `files`, the folder itself in `current` and the chain of parents in `pathParts` - and is the operation a client browses the file tree with. `filterType`, `filterValue`, `extension`, `userIdOrGroupId`, `sharedBy` and `folderType` narrow what is listed, `applyFilterOption` decides whether those filters bite on the files, on the folders or on both, and `withSubFolders`, which is on unless it is switched off, lets a narrowed request descend through the whole subtree instead of the top level alone. `filterValue` is matched against titles and against indexed document content, and indexing is asynchronous, so a file uploaded a moment ago can be missing from a search for a short while. `count` and `startIndex` page through the result while `total` counts everything that matches, and `sortBy` with `sortOrder` both order the page and are saved as the default order of the account. Reading a room or an ordinary folder clears its new-item marks for the caller. A caller who may not read the folder is answered with 403, and a folder that does not exist with 404.
692
+ # See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-folder-by-folder-id/
693
+ # @param folder_id [Integer, String] The folder whose contents are listed. Each section root has an operation of its own, such as `GET api/2.0/files/@my`, and every other folder is opened by the identifier a listing gave for it.
694
+ # @param [Hash] opts the optional parameters
695
+ # @option opts [String] :user_id_or_group_id Restricts the listing to the entries authored by this portal member, or by the members of this group; the same parameter accepts either kind of identifier. Omit it to list everything the caller can read.
696
+ # @option opts [String] :shared_by Restricts the listing to the entries this member shared, which narrows a shared listing down to what one person handed out.
697
+ # @option opts [FilterType] :filter_type Narrows the listing to a single kind of entry, such as documents, spreadsheets, images or one type of room. Omit it to list every kind the folder holds.
698
+ # @option opts [Integer, String] :room_id Keeps only the entries that lie in this room, which matters when the listing being read gathers entries from more than one of them.
699
+ # @option opts [Array<Integer>] :folder_type Keeps only the folders of these kinds, each given as the number of a folder type; it is how a listing is narrowed down to, say, the form-filling folders of a room.
700
+ # @option opts [Boolean] :exclude_subject Turns `userIdOrGroupId` around: with true the entries of that member or group are the ones left out, with false they are the only ones kept.
701
+ # @option opts [ApplyFilterOption] :apply_filter_option Chooses which half of the listing `filterType` and `filterValue` are applied to: with `Files` the folders come back unfiltered, with `Folders` the files do, and with `All` both halves are filtered.
702
+ # @option opts [Boolean] :with_sub_folders Whether a narrowed request reaches into the subfolders: with true, which is what an omitted parameter means, matching entries are gathered from the whole subtree, with false only the top level is read. It makes a difference only once `filterType`, `userIdOrGroupId` or `filterValue` narrows the request, because an unfiltered listing always shows the top level alone.
703
+ # @option opts [String] :extension Keeps only the files carrying one of these extensions, several of them separated by commas; the leading dot is optional.
704
+ # @option opts [SearchArea] :search_area Which area a listing that spans several of them is taken from - the active rooms, the archive, the room templates or the form-filling rooms. A folder that belongs to one area only settles the area itself and ignores the parameter.
705
+ # @option opts [String] :forms_item_key Keeps only the completed forms whose form field of this name holds a value. Take the name from `GET api/2.0/files/{folderId}/formfilter`, and use it in the folder that gathers the completed copies of a form-filling room.
706
+ # @option opts [String] :forms_item_type The kind of the form field named by `formsItemKey`, taken from the same list; the two are sent together.
707
+ # @option opts [Integer] :count The size of one page of the listing. Pair it with `startIndex` to walk through the result, and compare the two with `total` in the response to see when the last page has been read.
708
+ # @option opts [Integer] :start_index The number of matching entries to skip before the returned page begins; add `count` to it to ask for the next page.
709
+ # @option opts [String] :sort_by The name of the field the entries are ordered by, matched case-insensitively against the file sort fields: `DateAndTime`, `AZ`, `Size`, `Author`, `Type`, `New`, `DateAndTimeCreation`, `RoomType`, `Tags`, `Room`, `CustomOrder`, `LastOpened` and `UsedSpace`. A recognized value is also saved as the default order of the account and reused by later listings that omit the parameter, while a value matching none of the fields leaves that saved order in place.
710
+ # @option opts [SortOrder] :sort_order The direction in which the `sortBy` field is ordered. It is saved together with `sortBy` as the default order of the account.
711
+ # @option opts [String] :filter_value The search string the listing is filtered by: it is matched as a substring of entry titles and, for files, against the indexed document content as well. Omit it to list the folder unfiltered.
712
+ # @option opts [RequestLocation] :location Where the entries of a tag-based listing have to live to be kept: `Room` keeps what lies in a room, `Documents` what lies in a personal section, and `Link` what was reached through an external link that is still valid. It shapes the Favorites and Recent listings and does nothing in an ordinary folder.
713
+ # @option opts [Integer] :metadata_template_id The ID of the metadata template the entries must be assigned to. On its own it narrows the listing to the entries carrying the template; together with the metadata filters it also pins the template the filtered fields belong to. Supported for the rooms, the trash, the regular folders and the Shared with me, Recent and Favorites sections (the third-party entries never carry metadata and are left out); the Templates and Private sections reject it with 400.
714
+ # @option opts [String] :metadata_filters The URL-encoded JSON array of the metadata filter conditions, e.g. [{fieldId:1,op:contains,value:ACME},{fieldId:2,op:range,from:2026-01-01,to:2026-06-30},{fieldId:3,op:in,optionIds:[...]}]. A string field takes eq (the whole value) or contains (a part of it); a number or a date field takes range with inclusive bounds, or gt, gte, lt, lte with the single bound in value; a choice field takes in. A date-only bound covers the whole day, so to:2026-06-30 includes the values stored on 30 June and gt:2026-06-30 starts after it. A custom field is addressed by its name instead of the fieldId: {name:Client,op:eq,value:ACME}. The same filter is taken as a typed request body by POST api/2.0/files/{folderId}/search.
715
+ # @option opts [Boolean] :include_hidden_metadata Whether the text search, and the metadataMatches it reports, also look at the values of the hidden metadata templates (created with visible false for the metadata a service keeps for itself, which the web client never shows). False, the default, leaves them out, so an entry is not found by such a value; true takes them in. metadataTemplateId and metadataFilters are not concerned: a hidden template or field named there is searched either way.
716
+ # @return [FolderContentWrapper, ThirdPartyFolderContentWrapper]
717
+ def get_folder_by_folder_id(folder_id, opts = {})
718
+ data, _status_code, _headers = get_folder_by_folder_id_with_http_info(folder_id, opts)
719
+ data
720
+ end
721
+
722
+ # Get a folder by ID
723
+ # Returns one page of the contents of a folder - its subfolders in `folders`, its files in `files`, the folder itself in `current` and the chain of parents in `pathParts` - and is the operation a client browses the file tree with. `filterType`, `filterValue`, `extension`, `userIdOrGroupId`, `sharedBy` and `folderType` narrow what is listed, `applyFilterOption` decides whether those filters bite on the files, on the folders or on both, and `withSubFolders`, which is on unless it is switched off, lets a narrowed request descend through the whole subtree instead of the top level alone. `filterValue` is matched against titles and against indexed document content, and indexing is asynchronous, so a file uploaded a moment ago can be missing from a search for a short while. `count` and `startIndex` page through the result while `total` counts everything that matches, and `sortBy` with `sortOrder` both order the page and are saved as the default order of the account. Reading a room or an ordinary folder clears its new-item marks for the caller. A caller who may not read the folder is answered with 403, and a folder that does not exist with 404.
724
+ # See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-folder-by-folder-id/
725
+ # @param folder_id [Integer, String] The folder whose contents are listed. Each section root has an operation of its own, such as `GET api/2.0/files/@my`, and every other folder is opened by the identifier a listing gave for it.
726
+ # @param [Hash] opts the optional parameters
727
+ # @option opts [String] :user_id_or_group_id Restricts the listing to the entries authored by this portal member, or by the members of this group; the same parameter accepts either kind of identifier. Omit it to list everything the caller can read.
728
+ # @option opts [String] :shared_by Restricts the listing to the entries this member shared, which narrows a shared listing down to what one person handed out.
729
+ # @option opts [FilterType] :filter_type Narrows the listing to a single kind of entry, such as documents, spreadsheets, images or one type of room. Omit it to list every kind the folder holds.
730
+ # @option opts [Integer, String] :room_id Keeps only the entries that lie in this room, which matters when the listing being read gathers entries from more than one of them.
731
+ # @option opts [Array<Integer>] :folder_type Keeps only the folders of these kinds, each given as the number of a folder type; it is how a listing is narrowed down to, say, the form-filling folders of a room.
732
+ # @option opts [Boolean] :exclude_subject Turns `userIdOrGroupId` around: with true the entries of that member or group are the ones left out, with false they are the only ones kept.
733
+ # @option opts [ApplyFilterOption] :apply_filter_option Chooses which half of the listing `filterType` and `filterValue` are applied to: with `Files` the folders come back unfiltered, with `Folders` the files do, and with `All` both halves are filtered.
734
+ # @option opts [Boolean] :with_sub_folders Whether a narrowed request reaches into the subfolders: with true, which is what an omitted parameter means, matching entries are gathered from the whole subtree, with false only the top level is read. It makes a difference only once `filterType`, `userIdOrGroupId` or `filterValue` narrows the request, because an unfiltered listing always shows the top level alone.
735
+ # @option opts [String] :extension Keeps only the files carrying one of these extensions, several of them separated by commas; the leading dot is optional.
736
+ # @option opts [SearchArea] :search_area Which area a listing that spans several of them is taken from - the active rooms, the archive, the room templates or the form-filling rooms. A folder that belongs to one area only settles the area itself and ignores the parameter.
737
+ # @option opts [String] :forms_item_key Keeps only the completed forms whose form field of this name holds a value. Take the name from `GET api/2.0/files/{folderId}/formfilter`, and use it in the folder that gathers the completed copies of a form-filling room.
738
+ # @option opts [String] :forms_item_type The kind of the form field named by `formsItemKey`, taken from the same list; the two are sent together.
739
+ # @option opts [Integer] :count The size of one page of the listing. Pair it with `startIndex` to walk through the result, and compare the two with `total` in the response to see when the last page has been read.
740
+ # @option opts [Integer] :start_index The number of matching entries to skip before the returned page begins; add `count` to it to ask for the next page.
741
+ # @option opts [String] :sort_by The name of the field the entries are ordered by, matched case-insensitively against the file sort fields: `DateAndTime`, `AZ`, `Size`, `Author`, `Type`, `New`, `DateAndTimeCreation`, `RoomType`, `Tags`, `Room`, `CustomOrder`, `LastOpened` and `UsedSpace`. A recognized value is also saved as the default order of the account and reused by later listings that omit the parameter, while a value matching none of the fields leaves that saved order in place.
742
+ # @option opts [SortOrder] :sort_order The direction in which the `sortBy` field is ordered. It is saved together with `sortBy` as the default order of the account.
743
+ # @option opts [String] :filter_value The search string the listing is filtered by: it is matched as a substring of entry titles and, for files, against the indexed document content as well. Omit it to list the folder unfiltered.
744
+ # @option opts [RequestLocation] :location Where the entries of a tag-based listing have to live to be kept: `Room` keeps what lies in a room, `Documents` what lies in a personal section, and `Link` what was reached through an external link that is still valid. It shapes the Favorites and Recent listings and does nothing in an ordinary folder.
745
+ # @option opts [Integer] :metadata_template_id The ID of the metadata template the entries must be assigned to. On its own it narrows the listing to the entries carrying the template; together with the metadata filters it also pins the template the filtered fields belong to. Supported for the rooms, the trash, the regular folders and the Shared with me, Recent and Favorites sections (the third-party entries never carry metadata and are left out); the Templates and Private sections reject it with 400.
746
+ # @option opts [String] :metadata_filters The URL-encoded JSON array of the metadata filter conditions, e.g. [{fieldId:1,op:contains,value:ACME},{fieldId:2,op:range,from:2026-01-01,to:2026-06-30},{fieldId:3,op:in,optionIds:[...]}]. A string field takes eq (the whole value) or contains (a part of it); a number or a date field takes range with inclusive bounds, or gt, gte, lt, lte with the single bound in value; a choice field takes in. A date-only bound covers the whole day, so to:2026-06-30 includes the values stored on 30 June and gt:2026-06-30 starts after it. A custom field is addressed by its name instead of the fieldId: {name:Client,op:eq,value:ACME}. The same filter is taken as a typed request body by POST api/2.0/files/{folderId}/search.
747
+ # @option opts [Boolean] :include_hidden_metadata Whether the text search, and the metadataMatches it reports, also look at the values of the hidden metadata templates (created with visible false for the metadata a service keeps for itself, which the web client never shows). False, the default, leaves them out, so an entry is not found by such a value; true takes them in. metadataTemplateId and metadataFilters are not concerned: a hidden template or field named there is searched either way.
748
+ # @return [Array<(FolderContentWrapper, ThirdPartyFolderContentWrapper, Integer, Hash)>] FolderContentWrapper, ThirdPartyFolderContentWrapper data, response status code and response headers
749
+ def get_folder_by_folder_id_with_http_info(folder_id, opts = {})
750
+ if @api_client.config.debugging
751
+ @api_client.config.logger.debug 'Calling API: Files::FoldersApi.get_folder_by_folder_id ...'
752
+ end
753
+ # verify the required parameter 'folder_id' is set
754
+ if @api_client.config.client_side_validation && folder_id.nil?
755
+ fail ArgumentError, "Missing the required parameter 'folder_id' when calling Files::FoldersApi.get_folder_by_folder_id"
756
+ end
757
+ allowable_values = [0, 1, 2, 3, 5, 6, 8, 10, 11, 12, 13, 14, 15, 16, 19, 20, 21, 22, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37]
758
+ if @api_client.config.client_side_validation && opts[:'folder_type'] && !opts[:'folder_type'].all? { |item| allowable_values.include?(item) }
759
+ fail ArgumentError, "invalid value for \"folder_type\", must include one of #{allowable_values}"
760
+ end
761
+ if @api_client.config.client_side_validation && !opts[:'count'].nil? && opts[:'count'] > 100
762
+ fail ArgumentError, 'invalid value for "opts[:"count"]" when calling Files::FoldersApi.get_folder_by_folder_id, must be smaller than or equal to 100.'
763
+ end
764
+
765
+ if @api_client.config.client_side_validation && !opts[:'count'].nil? && opts[:'count'] < 1
766
+ fail ArgumentError, 'invalid value for "opts[:"count"]" when calling Files::FoldersApi.get_folder_by_folder_id, must be greater than or equal to 1.'
767
+ end
768
+
769
+ # resource path
770
+ local_var_path = '/api/2.0/files/{folderId}'.sub('{' + 'folderId' + '}', CGI.escape(folder_id.to_s))
771
+
772
+ # query parameters
773
+ query_params = opts[:query_params] || {}
774
+ query_params[:'userIdOrGroupId'] = opts[:'user_id_or_group_id'] if !opts[:'user_id_or_group_id'].nil?
775
+ query_params[:'sharedBy'] = opts[:'shared_by'] if !opts[:'shared_by'].nil?
776
+ query_params[:'filterType'] = opts[:'filter_type'] if !opts[:'filter_type'].nil?
777
+ query_params[:'roomId'] = opts[:'room_id'] if !opts[:'room_id'].nil?
778
+ query_params[:'folderType'] = @api_client.build_collection_param(opts[:'folder_type'], :multi) if !opts[:'folder_type'].nil?
779
+ query_params[:'excludeSubject'] = opts[:'exclude_subject'] if !opts[:'exclude_subject'].nil?
780
+ query_params[:'applyFilterOption'] = opts[:'apply_filter_option'] if !opts[:'apply_filter_option'].nil?
781
+ query_params[:'withSubFolders'] = opts[:'with_sub_folders'] if !opts[:'with_sub_folders'].nil?
782
+ query_params[:'extension'] = opts[:'extension'] if !opts[:'extension'].nil?
783
+ query_params[:'searchArea'] = opts[:'search_area'] if !opts[:'search_area'].nil?
784
+ query_params[:'formsItemKey'] = opts[:'forms_item_key'] if !opts[:'forms_item_key'].nil?
785
+ query_params[:'formsItemType'] = opts[:'forms_item_type'] if !opts[:'forms_item_type'].nil?
786
+ query_params[:'count'] = opts[:'count'] if !opts[:'count'].nil?
787
+ query_params[:'startIndex'] = opts[:'start_index'] if !opts[:'start_index'].nil?
788
+ query_params[:'sortBy'] = opts[:'sort_by'] if !opts[:'sort_by'].nil?
789
+ query_params[:'sortOrder'] = opts[:'sort_order'] if !opts[:'sort_order'].nil?
790
+ query_params[:'filterValue'] = opts[:'filter_value'] if !opts[:'filter_value'].nil?
791
+ query_params[:'location'] = opts[:'location'] if !opts[:'location'].nil?
792
+ query_params[:'metadataTemplateId'] = opts[:'metadata_template_id'] if !opts[:'metadata_template_id'].nil?
793
+ query_params[:'metadataFilters'] = opts[:'metadata_filters'] if !opts[:'metadata_filters'].nil?
794
+ query_params[:'includeHiddenMetadata'] = opts[:'include_hidden_metadata'] if !opts[:'include_hidden_metadata'].nil?
795
+
796
+ # header parameters
797
+ header_params = opts[:header_params] || {}
798
+ # HTTP header 'Accept' (if needed)
799
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
800
+
801
+ # form parameters
802
+ form_params = opts[:form_params] || {}
803
+
804
+ # http body (model)
805
+ post_body = opts[:debug_body]
806
+
807
+ # return_type
808
+ return_type = opts[:debug_return_type] || (folder_id.is_a?(String) ? 'ThirdPartyFolderContentWrapper' : 'FolderContentWrapper')
809
+
810
+ # auth_names
811
+ auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
812
+
813
+ new_options = opts.merge(
814
+ :operation => :"Files::FoldersApi.get_folder_by_folder_id",
815
+ :header_params => header_params,
816
+ :query_params => query_params,
817
+ :form_params => form_params,
818
+ :body => post_body,
819
+ :auth_names => auth_names,
820
+ :return_type => return_type
821
+ )
822
+
823
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
824
+ if @api_client.config.debugging
825
+ @api_client.config.logger.debug "API called: Files::FoldersApi#get_folder_by_folder_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
826
+ end
827
+ return data, status_code, headers
828
+ end
829
+
830
+ # Get folder history
831
+ # Lists what has happened to a folder and to the entries inside it - creations, renames, uploads, moves, deletions and changes of access - each record naming the action, the moment it happened and the member behind it. Records that belong to one action are grouped, so a batch arrives as a single entry carrying the rest of itself in `related`, and the list runs from the most recent record backwards. `fromDate` and `toDate` narrow the period, `startIndex` and `count` page through the result, and the number of records matching the request is reported in the response headers rather than in the body. Any member who can read the folder may read its history; a caller without access is answered with 403 and a folder that does not exist with 404. When the folder is a form-filling folder the caller reached through a filling invitation, the history is narrowed to what that caller may see. The call is read-only. To take the same history away as a spreadsheet, start a report with `POST api/2.0/files/folder/{folderId}/log/report`.
832
+ # See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-folder-history/
833
+ # @param folder_id [Integer] The folder whose activity log is read; the log covers the folder itself and the entries inside it.
834
+ # @param [Hash] opts the optional parameters
835
+ # @option opts [Time] :from_date The earliest moment an entry may have, read in the time zone of the portal; left out, the log starts at the oldest entry the portal still keeps.
836
+ # @option opts [Time] :to_date The latest moment an entry may have, read in the time zone of the portal; left out, the log ends at the newest entry.
837
+ # @option opts [Integer] :count How many entries one page holds. The number of entries that match the query is reported in the response headers, not in the body.
838
+ # @option opts [Integer] :start_index How many entries to skip before the page begins, counted from the newest one, so pages are taken by adding the page size to it.
839
+ # @return [HistoryArrayWrapper]
840
+ def get_folder_history(folder_id, opts = {})
841
+ data, _status_code, _headers = get_folder_history_with_http_info(folder_id, opts)
842
+ data
843
+ end
844
+
845
+ # Get folder history
846
+ # Lists what has happened to a folder and to the entries inside it - creations, renames, uploads, moves, deletions and changes of access - each record naming the action, the moment it happened and the member behind it. Records that belong to one action are grouped, so a batch arrives as a single entry carrying the rest of itself in `related`, and the list runs from the most recent record backwards. `fromDate` and `toDate` narrow the period, `startIndex` and `count` page through the result, and the number of records matching the request is reported in the response headers rather than in the body. Any member who can read the folder may read its history; a caller without access is answered with 403 and a folder that does not exist with 404. When the folder is a form-filling folder the caller reached through a filling invitation, the history is narrowed to what that caller may see. The call is read-only. To take the same history away as a spreadsheet, start a report with `POST api/2.0/files/folder/{folderId}/log/report`.
847
+ # See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-folder-history/
848
+ # @param folder_id [Integer] The folder whose activity log is read; the log covers the folder itself and the entries inside it.
849
+ # @param [Hash] opts the optional parameters
850
+ # @option opts [Time] :from_date The earliest moment an entry may have, read in the time zone of the portal; left out, the log starts at the oldest entry the portal still keeps.
851
+ # @option opts [Time] :to_date The latest moment an entry may have, read in the time zone of the portal; left out, the log ends at the newest entry.
852
+ # @option opts [Integer] :count How many entries one page holds. The number of entries that match the query is reported in the response headers, not in the body.
853
+ # @option opts [Integer] :start_index How many entries to skip before the page begins, counted from the newest one, so pages are taken by adding the page size to it.
854
+ # @return [Array<(HistoryArrayWrapper, Integer, Hash)>] HistoryArrayWrapper data, response status code and response headers
855
+ def get_folder_history_with_http_info(folder_id, opts = {})
856
+ if @api_client.config.debugging
857
+ @api_client.config.logger.debug 'Calling API: Files::FoldersApi.get_folder_history ...'
858
+ end
859
+ # verify the required parameter 'folder_id' is set
860
+ if @api_client.config.client_side_validation && folder_id.nil?
861
+ fail ArgumentError, "Missing the required parameter 'folder_id' when calling Files::FoldersApi.get_folder_history"
862
+ end
863
+ if @api_client.config.client_side_validation && !opts[:'count'].nil? && opts[:'count'] > 100
864
+ fail ArgumentError, 'invalid value for "opts[:"count"]" when calling Files::FoldersApi.get_folder_history, must be smaller than or equal to 100.'
865
+ end
866
+
867
+ if @api_client.config.client_side_validation && !opts[:'count'].nil? && opts[:'count'] < 1
868
+ fail ArgumentError, 'invalid value for "opts[:"count"]" when calling Files::FoldersApi.get_folder_history, must be greater than or equal to 1.'
869
+ end
870
+
871
+ # resource path
872
+ local_var_path = '/api/2.0/files/folder/{folderId}/log'.sub('{' + 'folderId' + '}', CGI.escape(folder_id.to_s))
873
+
874
+ # query parameters
875
+ query_params = opts[:query_params] || {}
876
+ query_params[:'fromDate'] = opts[:'from_date'] if !opts[:'from_date'].nil?
877
+ query_params[:'toDate'] = opts[:'to_date'] if !opts[:'to_date'].nil?
878
+ query_params[:'count'] = opts[:'count'] if !opts[:'count'].nil?
879
+ query_params[:'startIndex'] = opts[:'start_index'] if !opts[:'start_index'].nil?
880
+
881
+ # header parameters
882
+ header_params = opts[:header_params] || {}
883
+ # HTTP header 'Accept' (if needed)
884
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
885
+
886
+ # form parameters
887
+ form_params = opts[:form_params] || {}
888
+
889
+ # http body (model)
890
+ post_body = opts[:debug_body]
891
+
892
+ # return_type
893
+ return_type = opts[:debug_return_type] || 'HistoryArrayWrapper'
894
+
895
+ # auth_names
896
+ auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
897
+
898
+ new_options = opts.merge(
899
+ :operation => :"Files::FoldersApi.get_folder_history",
900
+ :header_params => header_params,
901
+ :query_params => query_params,
902
+ :form_params => form_params,
903
+ :body => post_body,
904
+ :auth_names => auth_names,
905
+ :return_type => return_type
906
+ )
907
+
908
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
909
+ if @api_client.config.debugging
910
+ @api_client.config.logger.debug "API called: Files::FoldersApi#get_folder_history\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
911
+ end
912
+ return data, status_code, headers
913
+ end
914
+
915
+ # Get folder information
916
+ # Returns one folder as an object - its title, its parent, the moments it was created and last changed, the access the caller has to it, the number of items that are new for them, and the room settings when the folder is a room - without listing anything inside it. Use it to resolve a folder identifier into something displayable, and `GET api/2.0/files/{folderId}` when the contents are what is wanted; unlike that operation, this one leaves the new-item marks of the folder alone. Any member who can read the folder may call it, and an anonymous caller only through an external link that grants access, everybody else being refused; a folder that does not exist is answered as not found. The call is read-only. The chain of parents above the folder is not part of the answer and is read with `GET api/2.0/files/folder/{folderId}/path`.
917
+ # See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-folder-info/
918
+ # @param folder_id [Integer, String] The folder the operation acts on. Take the identifier from a listing such as `GET api/2.0/files/@root` or `GET api/2.0/files/{folderId}`: a folder stored in the portal is numbered, while a folder in a connected third-party account is named by an opaque string.
919
+ # @param [Hash] opts the optional parameters
920
+ # @return [FolderWrapper, ThirdPartyFolderWrapper]
921
+ def get_folder_info(folder_id, opts = {})
922
+ data, _status_code, _headers = get_folder_info_with_http_info(folder_id, opts)
923
+ data
924
+ end
925
+
926
+ # Get folder information
927
+ # Returns one folder as an object - its title, its parent, the moments it was created and last changed, the access the caller has to it, the number of items that are new for them, and the room settings when the folder is a room - without listing anything inside it. Use it to resolve a folder identifier into something displayable, and `GET api/2.0/files/{folderId}` when the contents are what is wanted; unlike that operation, this one leaves the new-item marks of the folder alone. Any member who can read the folder may call it, and an anonymous caller only through an external link that grants access, everybody else being refused; a folder that does not exist is answered as not found. The call is read-only. The chain of parents above the folder is not part of the answer and is read with `GET api/2.0/files/folder/{folderId}/path`.
928
+ # See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-folder-info/
929
+ # @param folder_id [Integer, String] The folder the operation acts on. Take the identifier from a listing such as `GET api/2.0/files/@root` or `GET api/2.0/files/{folderId}`: a folder stored in the portal is numbered, while a folder in a connected third-party account is named by an opaque string.
930
+ # @param [Hash] opts the optional parameters
931
+ # @return [Array<(FolderWrapper, ThirdPartyFolderWrapper, Integer, Hash)>] FolderWrapper, ThirdPartyFolderWrapper data, response status code and response headers
932
+ def get_folder_info_with_http_info(folder_id, opts = {})
933
+ if @api_client.config.debugging
934
+ @api_client.config.logger.debug 'Calling API: Files::FoldersApi.get_folder_info ...'
935
+ end
936
+ # verify the required parameter 'folder_id' is set
937
+ if @api_client.config.client_side_validation && folder_id.nil?
938
+ fail ArgumentError, "Missing the required parameter 'folder_id' when calling Files::FoldersApi.get_folder_info"
939
+ end
940
+ # resource path
941
+ local_var_path = '/api/2.0/files/folder/{folderId}'.sub('{' + 'folderId' + '}', CGI.escape(folder_id.to_s))
942
+
943
+ # query parameters
944
+ query_params = opts[:query_params] || {}
945
+
946
+ # header parameters
947
+ header_params = opts[:header_params] || {}
948
+ # HTTP header 'Accept' (if needed)
949
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
950
+
951
+ # form parameters
952
+ form_params = opts[:form_params] || {}
953
+
954
+ # http body (model)
955
+ post_body = opts[:debug_body]
956
+
957
+ # return_type
958
+ return_type = opts[:debug_return_type] || (folder_id.is_a?(String) ? 'ThirdPartyFolderWrapper' : 'FolderWrapper')
959
+
960
+ # auth_names
961
+ auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
962
+
963
+ new_options = opts.merge(
964
+ :operation => :"Files::FoldersApi.get_folder_info",
965
+ :header_params => header_params,
966
+ :query_params => query_params,
967
+ :form_params => form_params,
968
+ :body => post_body,
969
+ :auth_names => auth_names,
970
+ :return_type => return_type
971
+ )
972
+
973
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
974
+ if @api_client.config.debugging
975
+ @api_client.config.logger.debug "API called: Files::FoldersApi#get_folder_info\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
976
+ end
977
+ return data, status_code, headers
978
+ end
979
+
980
+ # Get folder external links
981
+ # Lists the external links of a folder or a room, each with its identifier, title, address, rights, expiration date, password flag and download restriction, the primary link among them once it exists. At most the first hundred links are answered and the number returned is reported in the response headers; there are no paging parameters here. A folder that has never been shared by link answers with an empty list, and so does a member who may read the folder but not manage its links - the empty answer therefore means nothing to show you rather than no links exist. A member without access to the room is refused, an anonymous caller is rejected, and a folder that does not exist is answered as not found. The call is read-only. Take an identifier from here to `PUT api/2.0/files/folder/{id}/links` to change or remove that link, and read the primary one alone with `GET api/2.0/files/folder/{id}/link`.
982
+ # See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-folder-links/
983
+ # @param id [Integer, String] The folder or room whose external links are listed.
984
+ # @param [Hash] opts the optional parameters
985
+ # @return [FileShareArrayWrapper]
986
+ def get_folder_links(id, opts = {})
987
+ data, _status_code, _headers = get_folder_links_with_http_info(id, opts)
988
+ data
989
+ end
990
+
991
+ # Get folder external links
992
+ # Lists the external links of a folder or a room, each with its identifier, title, address, rights, expiration date, password flag and download restriction, the primary link among them once it exists. At most the first hundred links are answered and the number returned is reported in the response headers; there are no paging parameters here. A folder that has never been shared by link answers with an empty list, and so does a member who may read the folder but not manage its links - the empty answer therefore means nothing to show you rather than no links exist. A member without access to the room is refused, an anonymous caller is rejected, and a folder that does not exist is answered as not found. The call is read-only. Take an identifier from here to `PUT api/2.0/files/folder/{id}/links` to change or remove that link, and read the primary one alone with `GET api/2.0/files/folder/{id}/link`.
993
+ # See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-folder-links/
994
+ # @param id [Integer, String] The folder or room whose external links are listed.
995
+ # @param [Hash] opts the optional parameters
996
+ # @return [Array<(FileShareArrayWrapper, Integer, Hash)>] FileShareArrayWrapper data, response status code and response headers
997
+ def get_folder_links_with_http_info(id, opts = {})
998
+ if @api_client.config.debugging
999
+ @api_client.config.logger.debug 'Calling API: Files::FoldersApi.get_folder_links ...'
1000
+ end
1001
+ # verify the required parameter 'id' is set
1002
+ if @api_client.config.client_side_validation && id.nil?
1003
+ fail ArgumentError, "Missing the required parameter 'id' when calling Files::FoldersApi.get_folder_links"
1004
+ end
1005
+ # resource path
1006
+ local_var_path = '/api/2.0/files/folder/{id}/links'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
1007
+
1008
+ # query parameters
1009
+ query_params = opts[:query_params] || {}
1010
+
1011
+ # header parameters
1012
+ header_params = opts[:header_params] || {}
1013
+ # HTTP header 'Accept' (if needed)
1014
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
1015
+
1016
+ # form parameters
1017
+ form_params = opts[:form_params] || {}
1018
+
1019
+ # http body (model)
1020
+ post_body = opts[:debug_body]
1021
+
1022
+ # return_type
1023
+ return_type = opts[:debug_return_type] || 'FileShareArrayWrapper'
1024
+
1025
+ # auth_names
1026
+ auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
1027
+
1028
+ new_options = opts.merge(
1029
+ :operation => :"Files::FoldersApi.get_folder_links",
1030
+ :header_params => header_params,
1031
+ :query_params => query_params,
1032
+ :form_params => form_params,
1033
+ :body => post_body,
1034
+ :auth_names => auth_names,
1035
+ :return_type => return_type
1036
+ )
1037
+
1038
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
1039
+ if @api_client.config.debugging
1040
+ @api_client.config.logger.debug "API called: Files::FoldersApi#get_folder_links\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1041
+ end
1042
+ return data, status_code, headers
1043
+ end
1044
+
1045
+ # Get the folder path
1046
+ # Returns the chain of folders that leads to the folder named in the path, ordered from the section root down to the folder itself, which is the last entry. It is what a breadcrumb trail is built from, and it also tells a client which section - a room, the personal section, the archive - a bare folder identifier belongs to. Only the folders the caller may see are part of the chain, so a member who was given access to a folder deep inside a room gets a shorter path than the room manager does. The caller needs read access to the folder and is otherwise answered with 403, while a folder that does not exist is answered as not found. The call is read-only and takes no paging parameters. To go the other way, from a folder down into its contents, call `GET api/2.0/files/{folderId}`.
1047
+ # See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-folder-path/
1048
+ # @param folder_id [Integer, String] The folder the operation acts on. Take the identifier from a listing such as `GET api/2.0/files/@root` or `GET api/2.0/files/{folderId}`: a folder stored in the portal is numbered, while a folder in a connected third-party account is named by an opaque string.
1049
+ # @param [Hash] opts the optional parameters
1050
+ # @return [FileEntryBaseArrayWrapper]
1051
+ def get_folder_path(folder_id, opts = {})
1052
+ data, _status_code, _headers = get_folder_path_with_http_info(folder_id, opts)
1053
+ data
1054
+ end
1055
+
1056
+ # Get the folder path
1057
+ # Returns the chain of folders that leads to the folder named in the path, ordered from the section root down to the folder itself, which is the last entry. It is what a breadcrumb trail is built from, and it also tells a client which section - a room, the personal section, the archive - a bare folder identifier belongs to. Only the folders the caller may see are part of the chain, so a member who was given access to a folder deep inside a room gets a shorter path than the room manager does. The caller needs read access to the folder and is otherwise answered with 403, while a folder that does not exist is answered as not found. The call is read-only and takes no paging parameters. To go the other way, from a folder down into its contents, call `GET api/2.0/files/{folderId}`.
1058
+ # See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-folder-path/
1059
+ # @param folder_id [Integer, String] The folder the operation acts on. Take the identifier from a listing such as `GET api/2.0/files/@root` or `GET api/2.0/files/{folderId}`: a folder stored in the portal is numbered, while a folder in a connected third-party account is named by an opaque string.
1060
+ # @param [Hash] opts the optional parameters
1061
+ # @return [Array<(FileEntryBaseArrayWrapper, Integer, Hash)>] FileEntryBaseArrayWrapper data, response status code and response headers
1062
+ def get_folder_path_with_http_info(folder_id, opts = {})
1063
+ if @api_client.config.debugging
1064
+ @api_client.config.logger.debug 'Calling API: Files::FoldersApi.get_folder_path ...'
1065
+ end
1066
+ # verify the required parameter 'folder_id' is set
1067
+ if @api_client.config.client_side_validation && folder_id.nil?
1068
+ fail ArgumentError, "Missing the required parameter 'folder_id' when calling Files::FoldersApi.get_folder_path"
1069
+ end
1070
+ # resource path
1071
+ local_var_path = '/api/2.0/files/folder/{folderId}/path'.sub('{' + 'folderId' + '}', CGI.escape(folder_id.to_s))
1072
+
1073
+ # query parameters
1074
+ query_params = opts[:query_params] || {}
1075
+
1076
+ # header parameters
1077
+ header_params = opts[:header_params] || {}
1078
+ # HTTP header 'Accept' (if needed)
1079
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
1080
+
1081
+ # form parameters
1082
+ form_params = opts[:form_params] || {}
1083
+
1084
+ # http body (model)
1085
+ post_body = opts[:debug_body]
1086
+
1087
+ # return_type
1088
+ return_type = opts[:debug_return_type] || 'FileEntryBaseArrayWrapper'
1089
+
1090
+ # auth_names
1091
+ auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
1092
+
1093
+ new_options = opts.merge(
1094
+ :operation => :"Files::FoldersApi.get_folder_path",
1095
+ :header_params => header_params,
1096
+ :query_params => query_params,
1097
+ :form_params => form_params,
1098
+ :body => post_body,
1099
+ :auth_names => auth_names,
1100
+ :return_type => return_type
1101
+ )
1102
+
1103
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
1104
+ if @api_client.config.debugging
1105
+ @api_client.config.logger.debug "API called: Files::FoldersApi#get_folder_path\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1106
+ end
1107
+ return data, status_code, headers
1108
+ end
1109
+
1110
+ # Get the folder primary external link
1111
+ # Answers with the primary external link of a folder or a room - the one the Copy link action of a client hands out - with its address in `sharedTo.shareLink`, its rights in `access`, and its title, expiration date, password flag and download restriction beside them. The link is created on the first read if the folder has none, with read rights, no password and no expiry, so this operation mutates on that first call and is a plain read afterwards; repeated calls answer with the same link identifier. The caller needs the right to manage the links of the room the folder belongs to, which its manager and a portal administrator acting as room manager have; a member with read access alone is refused with 403 and an anonymous caller is rejected, while a link that was deliberately revoked is answered with 404 rather than being recreated. The paging parameters are accepted for compatibility and leave the single link answered here unchanged. Every external link of the same folder is listed by `GET api/2.0/files/folder/{id}/links`.
1112
+ # See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-folder-primary-external-link/
1113
+ # @param id [Integer, String] The folder or room the operation addresses. A folder stored on the portal is numbered, while a folder in a connected third-party account is named by an opaque string.
1114
+ # @param [Hash] opts the optional parameters
1115
+ # @option opts [Integer] :count How many entries at most to answer with, in the operations of this folder that return a list; an operation that answers with a single object is not affected by it.
1116
+ # @option opts [Integer] :start_index How many entries of such a list to skip before answering, used together with `count` to walk through it page by page.
1117
+ # @return [FileShareWrapper]
1118
+ def get_folder_primary_external_link(id, opts = {})
1119
+ data, _status_code, _headers = get_folder_primary_external_link_with_http_info(id, opts)
1120
+ data
1121
+ end
1122
+
1123
+ # Get the folder primary external link
1124
+ # Answers with the primary external link of a folder or a room - the one the Copy link action of a client hands out - with its address in `sharedTo.shareLink`, its rights in `access`, and its title, expiration date, password flag and download restriction beside them. The link is created on the first read if the folder has none, with read rights, no password and no expiry, so this operation mutates on that first call and is a plain read afterwards; repeated calls answer with the same link identifier. The caller needs the right to manage the links of the room the folder belongs to, which its manager and a portal administrator acting as room manager have; a member with read access alone is refused with 403 and an anonymous caller is rejected, while a link that was deliberately revoked is answered with 404 rather than being recreated. The paging parameters are accepted for compatibility and leave the single link answered here unchanged. Every external link of the same folder is listed by `GET api/2.0/files/folder/{id}/links`.
1125
+ # See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-folder-primary-external-link/
1126
+ # @param id [Integer, String] The folder or room the operation addresses. A folder stored on the portal is numbered, while a folder in a connected third-party account is named by an opaque string.
1127
+ # @param [Hash] opts the optional parameters
1128
+ # @option opts [Integer] :count How many entries at most to answer with, in the operations of this folder that return a list; an operation that answers with a single object is not affected by it.
1129
+ # @option opts [Integer] :start_index How many entries of such a list to skip before answering, used together with `count` to walk through it page by page.
1130
+ # @return [Array<(FileShareWrapper, Integer, Hash)>] FileShareWrapper data, response status code and response headers
1131
+ def get_folder_primary_external_link_with_http_info(id, opts = {})
1132
+ if @api_client.config.debugging
1133
+ @api_client.config.logger.debug 'Calling API: Files::FoldersApi.get_folder_primary_external_link ...'
1134
+ end
1135
+ # verify the required parameter 'id' is set
1136
+ if @api_client.config.client_side_validation && id.nil?
1137
+ fail ArgumentError, "Missing the required parameter 'id' when calling Files::FoldersApi.get_folder_primary_external_link"
1138
+ end
1139
+ if @api_client.config.client_side_validation && !opts[:'count'].nil? && opts[:'count'] > 100
1140
+ fail ArgumentError, 'invalid value for "opts[:"count"]" when calling Files::FoldersApi.get_folder_primary_external_link, must be smaller than or equal to 100.'
1141
+ end
1142
+
1143
+ if @api_client.config.client_side_validation && !opts[:'count'].nil? && opts[:'count'] < 1
1144
+ fail ArgumentError, 'invalid value for "opts[:"count"]" when calling Files::FoldersApi.get_folder_primary_external_link, must be greater than or equal to 1.'
1145
+ end
1146
+
1147
+ # resource path
1148
+ local_var_path = '/api/2.0/files/folder/{id}/link'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
1149
+
1150
+ # query parameters
1151
+ query_params = opts[:query_params] || {}
1152
+ query_params[:'count'] = opts[:'count'] if !opts[:'count'].nil?
1153
+ query_params[:'startIndex'] = opts[:'start_index'] if !opts[:'start_index'].nil?
1154
+
1155
+ # header parameters
1156
+ header_params = opts[:header_params] || {}
1157
+ # HTTP header 'Accept' (if needed)
1158
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
1159
+
1160
+ # form parameters
1161
+ form_params = opts[:form_params] || {}
1162
+
1163
+ # http body (model)
1164
+ post_body = opts[:debug_body]
1165
+
1166
+ # return_type
1167
+ return_type = opts[:debug_return_type] || 'FileShareWrapper'
1168
+
1169
+ # auth_names
1170
+ auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
1171
+
1172
+ new_options = opts.merge(
1173
+ :operation => :"Files::FoldersApi.get_folder_primary_external_link",
1174
+ :header_params => header_params,
1175
+ :query_params => query_params,
1176
+ :form_params => form_params,
1177
+ :body => post_body,
1178
+ :auth_names => auth_names,
1179
+ :return_type => return_type
1180
+ )
1181
+
1182
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
1183
+ if @api_client.config.debugging
1184
+ @api_client.config.logger.debug "API called: Files::FoldersApi#get_folder_primary_external_link\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1185
+ end
1186
+ return data, status_code, headers
1187
+ end
1188
+
1189
+ # Get subfolders
1190
+ # Lists the folders that sit directly inside the folder named in the path, ordered by title, without their own contents and without the files that lie beside them. The whole list arrives at once - there are no paging or filtering parameters here - so for a large folder, or when the files are wanted as well, use `GET api/2.0/files/{folderId}`, which pages and filters. A folder that holds no subfolders answers with an empty list. The caller needs read access to the folder, and only the subfolders they may see are listed, so a member of a room can get fewer entries than its manager; a caller without access is answered with 403, and a folder that does not exist, or one that has been deleted for good, is answered as not found. The call is read-only and leaves the new-item marks of the folder alone.
1191
+ # See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-folders/
1192
+ # @param folder_id [Integer, String] The folder the operation acts on. Take the identifier from a listing such as `GET api/2.0/files/@root` or `GET api/2.0/files/{folderId}`: a folder stored in the portal is numbered, while a folder in a connected third-party account is named by an opaque string.
1193
+ # @param [Hash] opts the optional parameters
1194
+ # @return [FileEntryBaseArrayWrapper]
1195
+ def get_folders(folder_id, opts = {})
1196
+ data, _status_code, _headers = get_folders_with_http_info(folder_id, opts)
1197
+ data
1198
+ end
1199
+
1200
+ # Get subfolders
1201
+ # Lists the folders that sit directly inside the folder named in the path, ordered by title, without their own contents and without the files that lie beside them. The whole list arrives at once - there are no paging or filtering parameters here - so for a large folder, or when the files are wanted as well, use `GET api/2.0/files/{folderId}`, which pages and filters. A folder that holds no subfolders answers with an empty list. The caller needs read access to the folder, and only the subfolders they may see are listed, so a member of a room can get fewer entries than its manager; a caller without access is answered with 403, and a folder that does not exist, or one that has been deleted for good, is answered as not found. The call is read-only and leaves the new-item marks of the folder alone.
1202
+ # See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-folders/
1203
+ # @param folder_id [Integer, String] The folder the operation acts on. Take the identifier from a listing such as `GET api/2.0/files/@root` or `GET api/2.0/files/{folderId}`: a folder stored in the portal is numbered, while a folder in a connected third-party account is named by an opaque string.
1204
+ # @param [Hash] opts the optional parameters
1205
+ # @return [Array<(FileEntryBaseArrayWrapper, Integer, Hash)>] FileEntryBaseArrayWrapper data, response status code and response headers
1206
+ def get_folders_with_http_info(folder_id, opts = {})
1207
+ if @api_client.config.debugging
1208
+ @api_client.config.logger.debug 'Calling API: Files::FoldersApi.get_folders ...'
1209
+ end
1210
+ # verify the required parameter 'folder_id' is set
1211
+ if @api_client.config.client_side_validation && folder_id.nil?
1212
+ fail ArgumentError, "Missing the required parameter 'folder_id' when calling Files::FoldersApi.get_folders"
1213
+ end
1214
+ # resource path
1215
+ local_var_path = '/api/2.0/files/{folderId}/subfolders'.sub('{' + 'folderId' + '}', CGI.escape(folder_id.to_s))
1216
+
1217
+ # query parameters
1218
+ query_params = opts[:query_params] || {}
1219
+
1220
+ # header parameters
1221
+ header_params = opts[:header_params] || {}
1222
+ # HTTP header 'Accept' (if needed)
1223
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
1224
+
1225
+ # form parameters
1226
+ form_params = opts[:form_params] || {}
1227
+
1228
+ # http body (model)
1229
+ post_body = opts[:debug_body]
1230
+
1231
+ # return_type
1232
+ return_type = opts[:debug_return_type] || 'FileEntryBaseArrayWrapper'
1233
+
1234
+ # auth_names
1235
+ auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
1236
+
1237
+ new_options = opts.merge(
1238
+ :operation => :"Files::FoldersApi.get_folders",
1239
+ :header_params => header_params,
1240
+ :query_params => query_params,
1241
+ :form_params => form_params,
1242
+ :body => post_body,
1243
+ :auth_names => auth_names,
1244
+ :return_type => return_type
1245
+ )
1246
+
1247
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
1248
+ if @api_client.config.debugging
1249
+ @api_client.config.logger.debug "API called: Files::FoldersApi#get_folders\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1250
+ end
1251
+ return data, status_code, headers
1252
+ end
1253
+
1254
+ # Get the Forms section
1255
+ # Returns the Forms section: the flat list of form-filling rooms the caller may read. Such rooms are stored under the Rooms tree but are surfaced only here, so `GET api/2.0/files/rooms` leaves them out of the active area and lists them when `searchArea` names the forms area instead. The section is not expanded into room content, so `folders` carries the rooms while `files` comes back empty; to read what is inside one of them, call `GET api/2.0/files/{folderId}` with the room identifier. Nothing is modified, though passing `sortBy` saves the requested order as the default order for this account. `filterType`, `filterValue`, `userIdOrGroupId` and the sorting parameters narrow and order the room list, `metadataTemplateId` and `metadataFilters` keep only the rooms carrying the template and matching the conditions (an unknown template or field, or a malformed condition, is refused with 400), `count` and `startIndex` page through it, `total` reports how many rooms match the request in full, and `current` describes the section folder itself.
1256
+ # See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-forms-folder/
1257
+ # @param [Hash] opts the optional parameters
1258
+ # @option opts [String] :user_id_or_group_id Restricts the listing to the entries authored by this portal member, or by the members of this group; the same parameter accepts either kind of identifier. Omit it to list everything the caller can read.
1259
+ # @option opts [FilterType] :filter_type Narrows the listing to a single kind of entry, such as documents, images or one type of room. Omit it to list every kind the section holds.
1260
+ # @option opts [Integer] :count The size of one page of section content. Pair it with `startIndex` to walk the listing, and compare the two with `total` in the response to see when the last page has been read.
1261
+ # @option opts [Integer] :start_index The number of matching entries to skip before the returned page begins; add `count` to it to ask for the next page.
1262
+ # @option opts [String] :sort_by The name of the field the entries are ordered by, matched case-insensitively against the file sort fields: `DateAndTime`, `AZ`, `Size`, `Author`, `Type`, `New`, `DateAndTimeCreation`, `RoomType`, `Tags`, `Room`, `CustomOrder`, `LastOpened` and `UsedSpace`. A recognized value is also saved as the default order of the account and reused by later listings that omit the parameter, while a value matching none of the fields leaves that saved order in place.
1263
+ # @option opts [SortOrder] :sort_order The direction in which the `sortBy` field is ordered. It is saved together with `sortBy` as the default order of the account.
1264
+ # @option opts [String] :filter_value The search string the section is filtered by: it is matched as a substring of entry titles and, for files, against the indexed document content as well. Omit it to list the section unfiltered.
1265
+ # @option opts [Integer] :metadata_template_id The ID of the metadata template the entries must be assigned to. On its own it narrows the listing to the entries carrying the template; together with the metadata filters it also pins the template the filtered fields belong to. The third-party entries never carry metadata and are left out when the filter is set.
1266
+ # @option opts [String] :metadata_filters The URL-encoded JSON array of the metadata filter conditions, e.g. [{fieldId:1,op:contains,value:ACME},{fieldId:2,op:range,from:2026-01-01,to:2026-06-30},{fieldId:3,op:in,optionIds:[...]}]. A string field takes eq or contains; a number or a date field takes range with inclusive bounds, or gt, gte, lt, lte with the bound in value; a date-only bound covers the whole day. A custom field is addressed by its name instead of the fieldId: {name:Client,op:eq,value:ACME}.
1267
+ # @option opts [Boolean] :include_hidden_metadata Whether the text search, and the metadataMatches it reports, also look at the values of the hidden metadata templates (created with visible false for the metadata a service keeps for itself, which the web client never shows). False, the default, leaves them out, so an entry is not found by such a value; true takes them in. metadataTemplateId and metadataFilters are not concerned: a hidden template or field named there is searched either way.
1268
+ # @return [FolderContentWrapper]
1269
+ def get_forms_folder(opts = {})
1270
+ data, _status_code, _headers = get_forms_folder_with_http_info(opts)
1271
+ data
1272
+ end
1273
+
1274
+ # Get the Forms section
1275
+ # Returns the Forms section: the flat list of form-filling rooms the caller may read. Such rooms are stored under the Rooms tree but are surfaced only here, so `GET api/2.0/files/rooms` leaves them out of the active area and lists them when `searchArea` names the forms area instead. The section is not expanded into room content, so `folders` carries the rooms while `files` comes back empty; to read what is inside one of them, call `GET api/2.0/files/{folderId}` with the room identifier. Nothing is modified, though passing `sortBy` saves the requested order as the default order for this account. `filterType`, `filterValue`, `userIdOrGroupId` and the sorting parameters narrow and order the room list, `metadataTemplateId` and `metadataFilters` keep only the rooms carrying the template and matching the conditions (an unknown template or field, or a malformed condition, is refused with 400), `count` and `startIndex` page through it, `total` reports how many rooms match the request in full, and `current` describes the section folder itself.
1276
+ # See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-forms-folder/
1277
+ # @param [Hash] opts the optional parameters
1278
+ # @option opts [String] :user_id_or_group_id Restricts the listing to the entries authored by this portal member, or by the members of this group; the same parameter accepts either kind of identifier. Omit it to list everything the caller can read.
1279
+ # @option opts [FilterType] :filter_type Narrows the listing to a single kind of entry, such as documents, images or one type of room. Omit it to list every kind the section holds.
1280
+ # @option opts [Integer] :count The size of one page of section content. Pair it with `startIndex` to walk the listing, and compare the two with `total` in the response to see when the last page has been read.
1281
+ # @option opts [Integer] :start_index The number of matching entries to skip before the returned page begins; add `count` to it to ask for the next page.
1282
+ # @option opts [String] :sort_by The name of the field the entries are ordered by, matched case-insensitively against the file sort fields: `DateAndTime`, `AZ`, `Size`, `Author`, `Type`, `New`, `DateAndTimeCreation`, `RoomType`, `Tags`, `Room`, `CustomOrder`, `LastOpened` and `UsedSpace`. A recognized value is also saved as the default order of the account and reused by later listings that omit the parameter, while a value matching none of the fields leaves that saved order in place.
1283
+ # @option opts [SortOrder] :sort_order The direction in which the `sortBy` field is ordered. It is saved together with `sortBy` as the default order of the account.
1284
+ # @option opts [String] :filter_value The search string the section is filtered by: it is matched as a substring of entry titles and, for files, against the indexed document content as well. Omit it to list the section unfiltered.
1285
+ # @option opts [Integer] :metadata_template_id The ID of the metadata template the entries must be assigned to. On its own it narrows the listing to the entries carrying the template; together with the metadata filters it also pins the template the filtered fields belong to. The third-party entries never carry metadata and are left out when the filter is set.
1286
+ # @option opts [String] :metadata_filters The URL-encoded JSON array of the metadata filter conditions, e.g. [{fieldId:1,op:contains,value:ACME},{fieldId:2,op:range,from:2026-01-01,to:2026-06-30},{fieldId:3,op:in,optionIds:[...]}]. A string field takes eq or contains; a number or a date field takes range with inclusive bounds, or gt, gte, lt, lte with the bound in value; a date-only bound covers the whole day. A custom field is addressed by its name instead of the fieldId: {name:Client,op:eq,value:ACME}.
1287
+ # @option opts [Boolean] :include_hidden_metadata Whether the text search, and the metadataMatches it reports, also look at the values of the hidden metadata templates (created with visible false for the metadata a service keeps for itself, which the web client never shows). False, the default, leaves them out, so an entry is not found by such a value; true takes them in. metadataTemplateId and metadataFilters are not concerned: a hidden template or field named there is searched either way.
1288
+ # @return [Array<(FolderContentWrapper, Integer, Hash)>] FolderContentWrapper data, response status code and response headers
1289
+ def get_forms_folder_with_http_info(opts = {})
1290
+ if @api_client.config.debugging
1291
+ @api_client.config.logger.debug 'Calling API: Files::FoldersApi.get_forms_folder ...'
1292
+ end
1293
+ if @api_client.config.client_side_validation && !opts[:'count'].nil? && opts[:'count'] > 100
1294
+ fail ArgumentError, 'invalid value for "opts[:"count"]" when calling Files::FoldersApi.get_forms_folder, must be smaller than or equal to 100.'
1295
+ end
1296
+
1297
+ if @api_client.config.client_side_validation && !opts[:'count'].nil? && opts[:'count'] < 1
1298
+ fail ArgumentError, 'invalid value for "opts[:"count"]" when calling Files::FoldersApi.get_forms_folder, must be greater than or equal to 1.'
1299
+ end
1300
+
1301
+ # resource path
1302
+ local_var_path = '/api/2.0/files/@forms'
1303
+
1304
+ # query parameters
1305
+ query_params = opts[:query_params] || {}
1306
+ query_params[:'userIdOrGroupId'] = opts[:'user_id_or_group_id'] if !opts[:'user_id_or_group_id'].nil?
1307
+ query_params[:'filterType'] = opts[:'filter_type'] if !opts[:'filter_type'].nil?
1308
+ query_params[:'count'] = opts[:'count'] if !opts[:'count'].nil?
1309
+ query_params[:'startIndex'] = opts[:'start_index'] if !opts[:'start_index'].nil?
1310
+ query_params[:'sortBy'] = opts[:'sort_by'] if !opts[:'sort_by'].nil?
1311
+ query_params[:'sortOrder'] = opts[:'sort_order'] if !opts[:'sort_order'].nil?
1312
+ query_params[:'filterValue'] = opts[:'filter_value'] if !opts[:'filter_value'].nil?
1313
+ query_params[:'metadataTemplateId'] = opts[:'metadata_template_id'] if !opts[:'metadata_template_id'].nil?
1314
+ query_params[:'metadataFilters'] = opts[:'metadata_filters'] if !opts[:'metadata_filters'].nil?
1315
+ query_params[:'includeHiddenMetadata'] = opts[:'include_hidden_metadata'] if !opts[:'include_hidden_metadata'].nil?
1316
+
1317
+ # header parameters
1318
+ header_params = opts[:header_params] || {}
1319
+ # HTTP header 'Accept' (if needed)
1320
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
1321
+
1322
+ # form parameters
1323
+ form_params = opts[:form_params] || {}
1324
+
1325
+ # http body (model)
1326
+ post_body = opts[:debug_body]
1327
+
1328
+ # return_type
1329
+ return_type = opts[:debug_return_type] || 'FolderContentWrapper'
1330
+
1331
+ # auth_names
1332
+ auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
1333
+
1334
+ new_options = opts.merge(
1335
+ :operation => :"Files::FoldersApi.get_forms_folder",
1336
+ :header_params => header_params,
1337
+ :query_params => query_params,
1338
+ :form_params => form_params,
1339
+ :body => post_body,
1340
+ :auth_names => auth_names,
1341
+ :return_type => return_type
1342
+ )
1343
+
1344
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
1345
+ if @api_client.config.debugging
1346
+ @api_client.config.logger.debug "API called: Files::FoldersApi#get_forms_folder\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1347
+ end
1348
+ return data, status_code, headers
1349
+ end
1350
+
1351
+ # Get the My documents section
1352
+ # Returns the contents of the caller's My documents section, the personal storage that belongs to this account alone and stays invisible to other members until something in it is shared explicitly. Any authenticated member that has a personal section can read it; guest accounts are not given one, and the call then answers 404. Nothing in the section is modified, though passing `sortBy` saves the requested order as the default order for this account. Without a filter only the top level of the section is listed; as soon as `filterType`, `userIdOrGroupId`, `filterValue` or a metadata filter narrows the request, the search descends through the whole subtree. `filterValue` is matched against titles and against indexed document content, and the index is written asynchronously, so a file uploaded a moment ago can be missing from a search for a short while. `metadataTemplateId` and `metadataFilters` keep only the entries carrying the template and matching the conditions, the same way `GET api/2.0/files/{folderId}` does; an unknown template or field, or a malformed condition, is refused with 400. `folders` and `files` hold one page of the result, `total` counts everything that matches before `count` and `startIndex` are applied, and `current` describes the section folder. To open a folder inside the section, call `GET api/2.0/files/{folderId}` with its identifier.
1353
+ # See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-my-folder/
1354
+ # @param [Hash] opts the optional parameters
1355
+ # @option opts [String] :user_id_or_group_id Restricts the listing to the entries authored by this portal member, or by the members of this group; the same parameter accepts either kind of identifier. Omit it to list everything the caller can read.
1356
+ # @option opts [FilterType] :filter_type Narrows the listing to a single kind of entry, such as documents, images or one type of room. Omit it to list every kind the section holds.
1357
+ # @option opts [ApplyFilterOption] :apply_filter_option Chooses which half of the listing `filterType` and `filterValue` are applied to: with `Files` the folders come back unfiltered, with `Folders` the files do, and with `All` both halves are filtered.
1358
+ # @option opts [Integer] :count The size of one page of section content. Pair it with `startIndex` to walk the listing, and compare the two with `total` in the response to see when the last page has been read.
1359
+ # @option opts [Integer] :start_index The number of matching entries to skip before the returned page begins; add `count` to it to ask for the next page.
1360
+ # @option opts [String] :sort_by The name of the field the entries are ordered by, matched case-insensitively against the file sort fields: `DateAndTime`, `AZ`, `Size`, `Author`, `Type`, `New`, `DateAndTimeCreation`, `RoomType`, `Tags`, `Room`, `CustomOrder`, `LastOpened` and `UsedSpace`. A recognized value is also saved as the default order of the account and reused by later listings that omit the parameter, while a value matching none of the fields leaves that saved order in place.
1361
+ # @option opts [SortOrder] :sort_order The direction in which the `sortBy` field is ordered. It is saved together with `sortBy` as the default order of the account.
1362
+ # @option opts [String] :filter_value The search string the section is filtered by, matched as a substring of entry titles. Omit it to list the section unfiltered.
1363
+ # @option opts [Integer] :metadata_template_id The ID of the metadata template the entries must be assigned to. On its own it narrows the listing to the entries carrying the template; together with the metadata filters it also pins the template the filtered fields belong to. The third-party entries never carry metadata and are left out when the filter is set.
1364
+ # @option opts [String] :metadata_filters The URL-encoded JSON array of the metadata filter conditions, e.g. [{fieldId:1,op:contains,value:ACME},{fieldId:2,op:range,from:2026-01-01,to:2026-06-30},{fieldId:3,op:in,optionIds:[...]}]. A string field takes eq or contains; a number or a date field takes range with inclusive bounds, or gt, gte, lt, lte with the bound in value; a date-only bound covers the whole day. A custom field is addressed by its name instead of the fieldId: {name:Client,op:eq,value:ACME}.
1365
+ # @option opts [Boolean] :include_hidden_metadata Whether the text search, and the metadataMatches it reports, also look at the values of the hidden metadata templates (created with visible false for the metadata a service keeps for itself, which the web client never shows). False, the default, leaves them out, so an entry is not found by such a value; true takes them in. metadataTemplateId and metadataFilters are not concerned: a hidden template or field named there is searched either way.
1366
+ # @return [FolderContentWrapper]
1367
+ def get_my_folder(opts = {})
1368
+ data, _status_code, _headers = get_my_folder_with_http_info(opts)
1369
+ data
1370
+ end
1371
+
1372
+ # Get the My documents section
1373
+ # Returns the contents of the caller's My documents section, the personal storage that belongs to this account alone and stays invisible to other members until something in it is shared explicitly. Any authenticated member that has a personal section can read it; guest accounts are not given one, and the call then answers 404. Nothing in the section is modified, though passing `sortBy` saves the requested order as the default order for this account. Without a filter only the top level of the section is listed; as soon as `filterType`, `userIdOrGroupId`, `filterValue` or a metadata filter narrows the request, the search descends through the whole subtree. `filterValue` is matched against titles and against indexed document content, and the index is written asynchronously, so a file uploaded a moment ago can be missing from a search for a short while. `metadataTemplateId` and `metadataFilters` keep only the entries carrying the template and matching the conditions, the same way `GET api/2.0/files/{folderId}` does; an unknown template or field, or a malformed condition, is refused with 400. `folders` and `files` hold one page of the result, `total` counts everything that matches before `count` and `startIndex` are applied, and `current` describes the section folder. To open a folder inside the section, call `GET api/2.0/files/{folderId}` with its identifier.
1374
+ # See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-my-folder/
1375
+ # @param [Hash] opts the optional parameters
1376
+ # @option opts [String] :user_id_or_group_id Restricts the listing to the entries authored by this portal member, or by the members of this group; the same parameter accepts either kind of identifier. Omit it to list everything the caller can read.
1377
+ # @option opts [FilterType] :filter_type Narrows the listing to a single kind of entry, such as documents, images or one type of room. Omit it to list every kind the section holds.
1378
+ # @option opts [ApplyFilterOption] :apply_filter_option Chooses which half of the listing `filterType` and `filterValue` are applied to: with `Files` the folders come back unfiltered, with `Folders` the files do, and with `All` both halves are filtered.
1379
+ # @option opts [Integer] :count The size of one page of section content. Pair it with `startIndex` to walk the listing, and compare the two with `total` in the response to see when the last page has been read.
1380
+ # @option opts [Integer] :start_index The number of matching entries to skip before the returned page begins; add `count` to it to ask for the next page.
1381
+ # @option opts [String] :sort_by The name of the field the entries are ordered by, matched case-insensitively against the file sort fields: `DateAndTime`, `AZ`, `Size`, `Author`, `Type`, `New`, `DateAndTimeCreation`, `RoomType`, `Tags`, `Room`, `CustomOrder`, `LastOpened` and `UsedSpace`. A recognized value is also saved as the default order of the account and reused by later listings that omit the parameter, while a value matching none of the fields leaves that saved order in place.
1382
+ # @option opts [SortOrder] :sort_order The direction in which the `sortBy` field is ordered. It is saved together with `sortBy` as the default order of the account.
1383
+ # @option opts [String] :filter_value The search string the section is filtered by, matched as a substring of entry titles. Omit it to list the section unfiltered.
1384
+ # @option opts [Integer] :metadata_template_id The ID of the metadata template the entries must be assigned to. On its own it narrows the listing to the entries carrying the template; together with the metadata filters it also pins the template the filtered fields belong to. The third-party entries never carry metadata and are left out when the filter is set.
1385
+ # @option opts [String] :metadata_filters The URL-encoded JSON array of the metadata filter conditions, e.g. [{fieldId:1,op:contains,value:ACME},{fieldId:2,op:range,from:2026-01-01,to:2026-06-30},{fieldId:3,op:in,optionIds:[...]}]. A string field takes eq or contains; a number or a date field takes range with inclusive bounds, or gt, gte, lt, lte with the bound in value; a date-only bound covers the whole day. A custom field is addressed by its name instead of the fieldId: {name:Client,op:eq,value:ACME}.
1386
+ # @option opts [Boolean] :include_hidden_metadata Whether the text search, and the metadataMatches it reports, also look at the values of the hidden metadata templates (created with visible false for the metadata a service keeps for itself, which the web client never shows). False, the default, leaves them out, so an entry is not found by such a value; true takes them in. metadataTemplateId and metadataFilters are not concerned: a hidden template or field named there is searched either way.
1387
+ # @return [Array<(FolderContentWrapper, Integer, Hash)>] FolderContentWrapper data, response status code and response headers
1388
+ def get_my_folder_with_http_info(opts = {})
1389
+ if @api_client.config.debugging
1390
+ @api_client.config.logger.debug 'Calling API: Files::FoldersApi.get_my_folder ...'
1391
+ end
1392
+ if @api_client.config.client_side_validation && !opts[:'count'].nil? && opts[:'count'] > 100
1393
+ fail ArgumentError, 'invalid value for "opts[:"count"]" when calling Files::FoldersApi.get_my_folder, must be smaller than or equal to 100.'
1394
+ end
1395
+
1396
+ if @api_client.config.client_side_validation && !opts[:'count'].nil? && opts[:'count'] < 1
1397
+ fail ArgumentError, 'invalid value for "opts[:"count"]" when calling Files::FoldersApi.get_my_folder, must be greater than or equal to 1.'
1398
+ end
1399
+
1400
+ # resource path
1401
+ local_var_path = '/api/2.0/files/@my'
1402
+
1403
+ # query parameters
1404
+ query_params = opts[:query_params] || {}
1405
+ query_params[:'userIdOrGroupId'] = opts[:'user_id_or_group_id'] if !opts[:'user_id_or_group_id'].nil?
1406
+ query_params[:'filterType'] = opts[:'filter_type'] if !opts[:'filter_type'].nil?
1407
+ query_params[:'applyFilterOption'] = opts[:'apply_filter_option'] if !opts[:'apply_filter_option'].nil?
1408
+ query_params[:'count'] = opts[:'count'] if !opts[:'count'].nil?
1409
+ query_params[:'startIndex'] = opts[:'start_index'] if !opts[:'start_index'].nil?
1410
+ query_params[:'sortBy'] = opts[:'sort_by'] if !opts[:'sort_by'].nil?
1411
+ query_params[:'sortOrder'] = opts[:'sort_order'] if !opts[:'sort_order'].nil?
1412
+ query_params[:'filterValue'] = opts[:'filter_value'] if !opts[:'filter_value'].nil?
1413
+ query_params[:'metadataTemplateId'] = opts[:'metadata_template_id'] if !opts[:'metadata_template_id'].nil?
1414
+ query_params[:'metadataFilters'] = opts[:'metadata_filters'] if !opts[:'metadata_filters'].nil?
1415
+ query_params[:'includeHiddenMetadata'] = opts[:'include_hidden_metadata'] if !opts[:'include_hidden_metadata'].nil?
1416
+
1417
+ # header parameters
1418
+ header_params = opts[:header_params] || {}
1419
+ # HTTP header 'Accept' (if needed)
1420
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
1421
+
1422
+ # form parameters
1423
+ form_params = opts[:form_params] || {}
1424
+
1425
+ # http body (model)
1426
+ post_body = opts[:debug_body]
1427
+
1428
+ # return_type
1429
+ return_type = opts[:debug_return_type] || 'FolderContentWrapper'
1430
+
1431
+ # auth_names
1432
+ auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
1433
+
1434
+ new_options = opts.merge(
1435
+ :operation => :"Files::FoldersApi.get_my_folder",
1436
+ :header_params => header_params,
1437
+ :query_params => query_params,
1438
+ :form_params => form_params,
1439
+ :body => post_body,
1440
+ :auth_names => auth_names,
1441
+ :return_type => return_type
1442
+ )
1443
+
1444
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
1445
+ if @api_client.config.debugging
1446
+ @api_client.config.logger.debug "API called: Files::FoldersApi#get_my_folder\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1447
+ end
1448
+ return data, status_code, headers
1449
+ end
1450
+
1451
+ # Get new folder items
1452
+ # Lists the entries of a folder that are new for the calling member - the files and folders created or changed there since they last opened it - ordered from the most recently changed backwards. It is what the badge of a room is filled from, and it is personal: two members of the same room get different answers. Reading this list does not clear the marks, so the same entries come back until the folder itself is opened with `GET api/2.0/files/{folderId}`, which does clear them. A folder with nothing new answers with an empty list, and marks disappear on their own when the entry behind them is deleted or moved out of reach. The caller needs read access to the folder and is otherwise answered with 403. The whole list arrives at once, without paging or filtering, and the call is read-only.
1453
+ # See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-new-folder-items/
1454
+ # @param folder_id [Integer, String] The folder the operation acts on. Take the identifier from a listing such as `GET api/2.0/files/@root` or `GET api/2.0/files/{folderId}`: a folder stored in the portal is numbered, while a folder in a connected third-party account is named by an opaque string.
1455
+ # @param [Hash] opts the optional parameters
1456
+ # @return [FileEntryBaseArrayWrapper]
1457
+ def get_new_folder_items(folder_id, opts = {})
1458
+ data, _status_code, _headers = get_new_folder_items_with_http_info(folder_id, opts)
1459
+ data
1460
+ end
1461
+
1462
+ # Get new folder items
1463
+ # Lists the entries of a folder that are new for the calling member - the files and folders created or changed there since they last opened it - ordered from the most recently changed backwards. It is what the badge of a room is filled from, and it is personal: two members of the same room get different answers. Reading this list does not clear the marks, so the same entries come back until the folder itself is opened with `GET api/2.0/files/{folderId}`, which does clear them. A folder with nothing new answers with an empty list, and marks disappear on their own when the entry behind them is deleted or moved out of reach. The caller needs read access to the folder and is otherwise answered with 403. The whole list arrives at once, without paging or filtering, and the call is read-only.
1464
+ # See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-new-folder-items/
1465
+ # @param folder_id [Integer, String] The folder the operation acts on. Take the identifier from a listing such as `GET api/2.0/files/@root` or `GET api/2.0/files/{folderId}`: a folder stored in the portal is numbered, while a folder in a connected third-party account is named by an opaque string.
1466
+ # @param [Hash] opts the optional parameters
1467
+ # @return [Array<(FileEntryBaseArrayWrapper, Integer, Hash)>] FileEntryBaseArrayWrapper data, response status code and response headers
1468
+ def get_new_folder_items_with_http_info(folder_id, opts = {})
1469
+ if @api_client.config.debugging
1470
+ @api_client.config.logger.debug 'Calling API: Files::FoldersApi.get_new_folder_items ...'
1471
+ end
1472
+ # verify the required parameter 'folder_id' is set
1473
+ if @api_client.config.client_side_validation && folder_id.nil?
1474
+ fail ArgumentError, "Missing the required parameter 'folder_id' when calling Files::FoldersApi.get_new_folder_items"
1475
+ end
1476
+ # resource path
1477
+ local_var_path = '/api/2.0/files/{folderId}/news'.sub('{' + 'folderId' + '}', CGI.escape(folder_id.to_s))
1478
+
1479
+ # query parameters
1480
+ query_params = opts[:query_params] || {}
1481
+
1482
+ # header parameters
1483
+ header_params = opts[:header_params] || {}
1484
+ # HTTP header 'Accept' (if needed)
1485
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
1486
+
1487
+ # form parameters
1488
+ form_params = opts[:form_params] || {}
1489
+
1490
+ # http body (model)
1491
+ post_body = opts[:debug_body]
1492
+
1493
+ # return_type
1494
+ return_type = opts[:debug_return_type] || 'FileEntryBaseArrayWrapper'
1495
+
1496
+ # auth_names
1497
+ auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
1498
+
1499
+ new_options = opts.merge(
1500
+ :operation => :"Files::FoldersApi.get_new_folder_items",
1501
+ :header_params => header_params,
1502
+ :query_params => query_params,
1503
+ :form_params => form_params,
1504
+ :body => post_body,
1505
+ :auth_names => auth_names,
1506
+ :return_type => return_type
1507
+ )
1508
+
1509
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
1510
+ if @api_client.config.debugging
1511
+ @api_client.config.logger.debug "API called: Files::FoldersApi#get_new_folder_items\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1512
+ end
1513
+ return data, status_code, headers
1514
+ end
1515
+
1516
+ # Get the Recent section
1517
+ # Returns the Recent section: the files the calling account has opened lately. The section holds files only, so `folders` comes back empty, and it is personal, so another member's history is not visible here. A file is added when it is opened and can also be added explicitly with `POST api/2.0/files/file/{fileId}/recent`; `DELETE api/2.0/files/recent` clears the whole history, and `PUT api/2.0/files/displayrecent` switches the section on and off for the account, which also decides whether `GET api/2.0/files/@root` includes it. Nothing in the section is modified, though passing `sortBy` saves the requested order as the default order for this account. The listing is ordered by the moment the caller last opened each file, newest first, and `sortBy` and `sortOrder` do not change that order. `files` holds one page, `total` counts the files matching the request before `count` and `startIndex` are applied, and `current` describes the section folder itself.
1518
+ # See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-recent-folder/
1519
+ # @param [Hash] opts the optional parameters
1520
+ # @option opts [String] :user_id_or_group_id Restricts the listing to the files authored by this portal member, or by the members of this group; the same parameter accepts either kind of identifier. Omit it to list the whole history.
1521
+ # @option opts [FilterType] :filter_type Narrows the listing to a single kind of file, such as documents, spreadsheets or images. Omit it to list every kind the history holds.
1522
+ # @option opts [Boolean] :exclude_subject Inverts `userIdOrGroupId`: with `true` the files of that member or group are the ones left out of the listing instead of the only ones kept.
1523
+ # @option opts [ApplyFilterOption] :apply_filter_option Chooses which half of a listing `filterType` and `filterValue` are applied to. The Recent section holds files only, so the value does not change what comes back.
1524
+ # @option opts [SearchArea] :search_area The area a listing is taken from. The Recent section is assembled from the caller's own open history rather than from an area, so the value does not change which files are returned.
1525
+ # @option opts [Array<String>] :extension The file extensions the listing is limited to, matched against the end of the file name. The leading dot is optional, and the parameter is repeated once per extension.
1526
+ # @option opts [Integer] :count The size of one page of section content. Pair it with `startIndex` to walk the listing, and compare the two with `total` in the response to see when the last page has been read.
1527
+ # @option opts [Integer] :start_index The number of matching entries to skip before the returned page begins; add `count` to it to ask for the next page.
1528
+ # @option opts [String] :sort_by The name of the field the entries are ordered by, matched case-insensitively against the file sort fields: `DateAndTime`, `AZ`, `Size`, `Author`, `Type`, `New`, `DateAndTimeCreation`, `RoomType`, `Tags`, `Room`, `CustomOrder`, `LastOpened` and `UsedSpace`. A recognized value is also saved as the default order of the account and reused by later listings that omit the parameter, while a value matching none of the fields leaves that saved order in place. The Recent section keeps its own newest-first order, so the value does not reorder this listing.
1529
+ # @option opts [SortOrder] :sort_order The direction in which the `sortBy` field is ordered. It is saved together with `sortBy` as the default order of the account. The Recent section keeps its own newest-first order, so the value does not reorder this listing.
1530
+ # @option opts [String] :filter_value The search string the history is filtered by: it is matched as a substring of file titles and against the indexed document content as well. Omit it to list the whole history.
1531
+ # @option opts [Integer] :metadata_template_id The ID of the metadata template the recent files must be assigned to. On its own it narrows the listing to the files carrying the template; together with the metadata filters it also pins the template the filtered fields belong to. The third-party files never carry metadata and are left out when the filter is set.
1532
+ # @option opts [String] :metadata_filters The URL-encoded JSON array of the metadata filter conditions, e.g. [{fieldId:1,op:contains,value:ACME},{fieldId:2,op:range,from:2026-01-01,to:2026-06-30},{fieldId:3,op:in,optionIds:[...]}]. A string field takes eq or contains; a number or a date field takes range with inclusive bounds, or gt, gte, lt, lte with the bound in value; a date-only bound covers the whole day. A custom field is addressed by its name instead of the fieldId: {name:Client,op:eq,value:ACME}.
1533
+ # @option opts [Boolean] :include_hidden_metadata Whether the text search, and the metadataMatches it reports, also look at the values of the hidden metadata templates (created with visible false for the metadata a service keeps for itself, which the web client never shows). False, the default, leaves them out, so an entry is not found by such a value; true takes them in. metadataTemplateId and metadataFilters are not concerned: a hidden template or field named there is searched either way.
1534
+ # @return [FolderContentWrapper]
1535
+ def get_recent_folder(opts = {})
1536
+ data, _status_code, _headers = get_recent_folder_with_http_info(opts)
1537
+ data
1538
+ end
1539
+
1540
+ # Get the Recent section
1541
+ # Returns the Recent section: the files the calling account has opened lately. The section holds files only, so `folders` comes back empty, and it is personal, so another member's history is not visible here. A file is added when it is opened and can also be added explicitly with `POST api/2.0/files/file/{fileId}/recent`; `DELETE api/2.0/files/recent` clears the whole history, and `PUT api/2.0/files/displayrecent` switches the section on and off for the account, which also decides whether `GET api/2.0/files/@root` includes it. Nothing in the section is modified, though passing `sortBy` saves the requested order as the default order for this account. The listing is ordered by the moment the caller last opened each file, newest first, and `sortBy` and `sortOrder` do not change that order. `files` holds one page, `total` counts the files matching the request before `count` and `startIndex` are applied, and `current` describes the section folder itself.
1542
+ # See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-recent-folder/
1543
+ # @param [Hash] opts the optional parameters
1544
+ # @option opts [String] :user_id_or_group_id Restricts the listing to the files authored by this portal member, or by the members of this group; the same parameter accepts either kind of identifier. Omit it to list the whole history.
1545
+ # @option opts [FilterType] :filter_type Narrows the listing to a single kind of file, such as documents, spreadsheets or images. Omit it to list every kind the history holds.
1546
+ # @option opts [Boolean] :exclude_subject Inverts `userIdOrGroupId`: with `true` the files of that member or group are the ones left out of the listing instead of the only ones kept.
1547
+ # @option opts [ApplyFilterOption] :apply_filter_option Chooses which half of a listing `filterType` and `filterValue` are applied to. The Recent section holds files only, so the value does not change what comes back.
1548
+ # @option opts [SearchArea] :search_area The area a listing is taken from. The Recent section is assembled from the caller's own open history rather than from an area, so the value does not change which files are returned.
1549
+ # @option opts [Array<String>] :extension The file extensions the listing is limited to, matched against the end of the file name. The leading dot is optional, and the parameter is repeated once per extension.
1550
+ # @option opts [Integer] :count The size of one page of section content. Pair it with `startIndex` to walk the listing, and compare the two with `total` in the response to see when the last page has been read.
1551
+ # @option opts [Integer] :start_index The number of matching entries to skip before the returned page begins; add `count` to it to ask for the next page.
1552
+ # @option opts [String] :sort_by The name of the field the entries are ordered by, matched case-insensitively against the file sort fields: `DateAndTime`, `AZ`, `Size`, `Author`, `Type`, `New`, `DateAndTimeCreation`, `RoomType`, `Tags`, `Room`, `CustomOrder`, `LastOpened` and `UsedSpace`. A recognized value is also saved as the default order of the account and reused by later listings that omit the parameter, while a value matching none of the fields leaves that saved order in place. The Recent section keeps its own newest-first order, so the value does not reorder this listing.
1553
+ # @option opts [SortOrder] :sort_order The direction in which the `sortBy` field is ordered. It is saved together with `sortBy` as the default order of the account. The Recent section keeps its own newest-first order, so the value does not reorder this listing.
1554
+ # @option opts [String] :filter_value The search string the history is filtered by: it is matched as a substring of file titles and against the indexed document content as well. Omit it to list the whole history.
1555
+ # @option opts [Integer] :metadata_template_id The ID of the metadata template the recent files must be assigned to. On its own it narrows the listing to the files carrying the template; together with the metadata filters it also pins the template the filtered fields belong to. The third-party files never carry metadata and are left out when the filter is set.
1556
+ # @option opts [String] :metadata_filters The URL-encoded JSON array of the metadata filter conditions, e.g. [{fieldId:1,op:contains,value:ACME},{fieldId:2,op:range,from:2026-01-01,to:2026-06-30},{fieldId:3,op:in,optionIds:[...]}]. A string field takes eq or contains; a number or a date field takes range with inclusive bounds, or gt, gte, lt, lte with the bound in value; a date-only bound covers the whole day. A custom field is addressed by its name instead of the fieldId: {name:Client,op:eq,value:ACME}.
1557
+ # @option opts [Boolean] :include_hidden_metadata Whether the text search, and the metadataMatches it reports, also look at the values of the hidden metadata templates (created with visible false for the metadata a service keeps for itself, which the web client never shows). False, the default, leaves them out, so an entry is not found by such a value; true takes them in. metadataTemplateId and metadataFilters are not concerned: a hidden template or field named there is searched either way.
1558
+ # @return [Array<(FolderContentWrapper, Integer, Hash)>] FolderContentWrapper data, response status code and response headers
1559
+ def get_recent_folder_with_http_info(opts = {})
1560
+ if @api_client.config.debugging
1561
+ @api_client.config.logger.debug 'Calling API: Files::FoldersApi.get_recent_folder ...'
1562
+ end
1563
+ if @api_client.config.client_side_validation && !opts[:'count'].nil? && opts[:'count'] > 100
1564
+ fail ArgumentError, 'invalid value for "opts[:"count"]" when calling Files::FoldersApi.get_recent_folder, must be smaller than or equal to 100.'
1565
+ end
1566
+
1567
+ if @api_client.config.client_side_validation && !opts[:'count'].nil? && opts[:'count'] < 1
1568
+ fail ArgumentError, 'invalid value for "opts[:"count"]" when calling Files::FoldersApi.get_recent_folder, must be greater than or equal to 1.'
1569
+ end
1570
+
1571
+ # resource path
1572
+ local_var_path = '/api/2.0/files/recent'
1573
+
1574
+ # query parameters
1575
+ query_params = opts[:query_params] || {}
1576
+ query_params[:'userIdOrGroupId'] = opts[:'user_id_or_group_id'] if !opts[:'user_id_or_group_id'].nil?
1577
+ query_params[:'filterType'] = opts[:'filter_type'] if !opts[:'filter_type'].nil?
1578
+ query_params[:'excludeSubject'] = opts[:'exclude_subject'] if !opts[:'exclude_subject'].nil?
1579
+ query_params[:'applyFilterOption'] = opts[:'apply_filter_option'] if !opts[:'apply_filter_option'].nil?
1580
+ query_params[:'searchArea'] = opts[:'search_area'] if !opts[:'search_area'].nil?
1581
+ query_params[:'extension'] = @api_client.build_collection_param(opts[:'extension'], :multi) if !opts[:'extension'].nil?
1582
+ query_params[:'count'] = opts[:'count'] if !opts[:'count'].nil?
1583
+ query_params[:'startIndex'] = opts[:'start_index'] if !opts[:'start_index'].nil?
1584
+ query_params[:'sortBy'] = opts[:'sort_by'] if !opts[:'sort_by'].nil?
1585
+ query_params[:'sortOrder'] = opts[:'sort_order'] if !opts[:'sort_order'].nil?
1586
+ query_params[:'filterValue'] = opts[:'filter_value'] if !opts[:'filter_value'].nil?
1587
+ query_params[:'metadataTemplateId'] = opts[:'metadata_template_id'] if !opts[:'metadata_template_id'].nil?
1588
+ query_params[:'metadataFilters'] = opts[:'metadata_filters'] if !opts[:'metadata_filters'].nil?
1589
+ query_params[:'includeHiddenMetadata'] = opts[:'include_hidden_metadata'] if !opts[:'include_hidden_metadata'].nil?
1590
+
1591
+ # header parameters
1592
+ header_params = opts[:header_params] || {}
1593
+ # HTTP header 'Accept' (if needed)
1594
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
1595
+
1596
+ # form parameters
1597
+ form_params = opts[:form_params] || {}
1598
+
1599
+ # http body (model)
1600
+ post_body = opts[:debug_body]
1601
+
1602
+ # return_type
1603
+ return_type = opts[:debug_return_type] || 'FolderContentWrapper'
1604
+
1605
+ # auth_names
1606
+ auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
1607
+
1608
+ new_options = opts.merge(
1609
+ :operation => :"Files::FoldersApi.get_recent_folder",
1610
+ :header_params => header_params,
1611
+ :query_params => query_params,
1612
+ :form_params => form_params,
1613
+ :body => post_body,
1614
+ :auth_names => auth_names,
1615
+ :return_type => return_type
1616
+ )
1617
+
1618
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
1619
+ if @api_client.config.debugging
1620
+ @api_client.config.logger.debug "API called: Files::FoldersApi#get_recent_folder\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1621
+ end
1622
+ return data, status_code, headers
1623
+ end
1624
+
1625
+ # Get the folder history report generation status
1626
+ # Reports how far the history report of a folder has got, and is the operation to poll after `POST api/2.0/files/folder/{folderId}/log/report` has queued one. `percentage` climbs to 100, `isCompleted` turns true when the job is over however it ended, `error` carries the reason when it failed, and `resultFileId`, `resultFileName` and `resultFileUrl` name the file that was saved in the caller's My documents. An empty answer means there is no report for this folder and caller, either because none was started or because a finished one has already been picked up by an earlier poll. The caller needs read access to the folder and may not be a guest; a caller who fails the access rule is answered with 403, a folder that does not exist with 404, and a portal with the login history and audit trail section turned off with 402. The call is read-only, and each caller sees only their own report.
1627
+ # See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-report-folder-history/
1628
+ # @param folder_id [Integer] The folder whose history report is being polled. It is the folder that was passed to the operation that started the report.
1629
+ # @param [Hash] opts the optional parameters
1630
+ # @return [DocumentBuilderTaskWrapper]
1631
+ def get_report_folder_history(folder_id, opts = {})
1632
+ data, _status_code, _headers = get_report_folder_history_with_http_info(folder_id, opts)
1633
+ data
1634
+ end
1635
+
1636
+ # Get the folder history report generation status
1637
+ # Reports how far the history report of a folder has got, and is the operation to poll after `POST api/2.0/files/folder/{folderId}/log/report` has queued one. `percentage` climbs to 100, `isCompleted` turns true when the job is over however it ended, `error` carries the reason when it failed, and `resultFileId`, `resultFileName` and `resultFileUrl` name the file that was saved in the caller's My documents. An empty answer means there is no report for this folder and caller, either because none was started or because a finished one has already been picked up by an earlier poll. The caller needs read access to the folder and may not be a guest; a caller who fails the access rule is answered with 403, a folder that does not exist with 404, and a portal with the login history and audit trail section turned off with 402. The call is read-only, and each caller sees only their own report.
1638
+ # See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-report-folder-history/
1639
+ # @param folder_id [Integer] The folder whose history report is being polled. It is the folder that was passed to the operation that started the report.
1640
+ # @param [Hash] opts the optional parameters
1641
+ # @return [Array<(DocumentBuilderTaskWrapper, Integer, Hash)>] DocumentBuilderTaskWrapper data, response status code and response headers
1642
+ def get_report_folder_history_with_http_info(folder_id, opts = {})
1643
+ if @api_client.config.debugging
1644
+ @api_client.config.logger.debug 'Calling API: Files::FoldersApi.get_report_folder_history ...'
1645
+ end
1646
+ # verify the required parameter 'folder_id' is set
1647
+ if @api_client.config.client_side_validation && folder_id.nil?
1648
+ fail ArgumentError, "Missing the required parameter 'folder_id' when calling Files::FoldersApi.get_report_folder_history"
1649
+ end
1650
+ # resource path
1651
+ local_var_path = '/api/2.0/files/folder/{folderId}/log/report'.sub('{' + 'folderId' + '}', CGI.escape(folder_id.to_s))
1652
+
1653
+ # query parameters
1654
+ query_params = opts[:query_params] || {}
1655
+
1656
+ # header parameters
1657
+ header_params = opts[:header_params] || {}
1658
+ # HTTP header 'Accept' (if needed)
1659
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
1660
+
1661
+ # form parameters
1662
+ form_params = opts[:form_params] || {}
1663
+
1664
+ # http body (model)
1665
+ post_body = opts[:debug_body]
1666
+
1667
+ # return_type
1668
+ return_type = opts[:debug_return_type] || 'DocumentBuilderTaskWrapper'
1669
+
1670
+ # auth_names
1671
+ auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
1672
+
1673
+ new_options = opts.merge(
1674
+ :operation => :"Files::FoldersApi.get_report_folder_history",
1675
+ :header_params => header_params,
1676
+ :query_params => query_params,
1677
+ :form_params => form_params,
1678
+ :body => post_body,
1679
+ :auth_names => auth_names,
1680
+ :return_type => return_type
1681
+ )
1682
+
1683
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
1684
+ if @api_client.config.debugging
1685
+ @api_client.config.logger.debug "API called: Files::FoldersApi#get_report_folder_history\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1686
+ end
1687
+ return data, status_code, headers
1688
+ end
1689
+
1690
+ # Get filtered sections
1691
+ # Returns every top-level section the calling account can see in one response, each of them a full section object carrying its own first page of content: Favorites, Recent, Shared with me, My documents, Trash, Rooms, Forms, Archive and, while AI access is enabled for the portal, AI agents. A section is left out when the account has none of it, which is why a guest gets no personal section, and Recent is listed only while it is switched on with `PUT api/2.0/files/displayrecent`. Pass `withoutTrash=true` to drop the Trash section. The filters, `count` and `startIndex` are applied to each section separately, so `count=1` returns one entry per section and every section reports its own `total`. Because it builds the content of all of them, this is the most expensive listing in the module: when a single section is enough, read it directly, for example with `GET api/2.0/files/@my`. The call modifies nothing in the sections and leaves their new-item badges untouched, though passing `sortBy` saves the requested order as the default order for this account.
1692
+ # See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-root-folders/
1693
+ # @param [Hash] opts the optional parameters
1694
+ # @option opts [String] :user_id_or_group_id Restricts the listing to the entries authored by this portal member, or by the members of this group; the same parameter accepts either kind of identifier. Omit it to list everything the caller can read.
1695
+ # @option opts [FilterType] :filter_type Narrows the content listed inside every returned section to a single kind of entry, such as documents, images or one type of room. Omit it to list every kind the sections hold.
1696
+ # @option opts [Boolean] :without_trash Set it to `true` to leave the Trash section out of the returned set of sections; with `false`, or when the parameter is omitted, the section is returned whenever the account has one of its own.
1697
+ # @option opts [Integer] :count The size of the content page returned for each section separately, so a value of 1 yields one entry per section rather than one entry in total.
1698
+ # @option opts [Integer] :start_index The number of matching entries skipped in each section before its page begins; add `count` to it to ask for the next page of every section.
1699
+ # @option opts [String] :sort_by The name of the field the entries are ordered by, matched case-insensitively against the file sort fields: `DateAndTime`, `AZ`, `Size`, `Author`, `Type`, `New`, `DateAndTimeCreation`, `RoomType`, `Tags`, `Room`, `CustomOrder`, `LastOpened` and `UsedSpace`. A recognized value is also saved as the default order of the account and reused by later listings that omit the parameter, while a value matching none of the fields leaves that saved order in place.
1700
+ # @option opts [SortOrder] :sort_order The direction in which the `sortBy` field is ordered. It is saved together with `sortBy` as the default order of the account.
1701
+ # @option opts [String] :filter_value The search string the content of every section is filtered by: it is matched as a substring of entry titles and, for files, against the indexed document content as well. Omit it to list the sections unfiltered.
1702
+ # @return [FolderContentArrayWrapper]
1703
+ def get_root_folders(opts = {})
1704
+ data, _status_code, _headers = get_root_folders_with_http_info(opts)
1705
+ data
1706
+ end
1707
+
1708
+ # Get filtered sections
1709
+ # Returns every top-level section the calling account can see in one response, each of them a full section object carrying its own first page of content: Favorites, Recent, Shared with me, My documents, Trash, Rooms, Forms, Archive and, while AI access is enabled for the portal, AI agents. A section is left out when the account has none of it, which is why a guest gets no personal section, and Recent is listed only while it is switched on with `PUT api/2.0/files/displayrecent`. Pass `withoutTrash=true` to drop the Trash section. The filters, `count` and `startIndex` are applied to each section separately, so `count=1` returns one entry per section and every section reports its own `total`. Because it builds the content of all of them, this is the most expensive listing in the module: when a single section is enough, read it directly, for example with `GET api/2.0/files/@my`. The call modifies nothing in the sections and leaves their new-item badges untouched, though passing `sortBy` saves the requested order as the default order for this account.
1710
+ # See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-root-folders/
1711
+ # @param [Hash] opts the optional parameters
1712
+ # @option opts [String] :user_id_or_group_id Restricts the listing to the entries authored by this portal member, or by the members of this group; the same parameter accepts either kind of identifier. Omit it to list everything the caller can read.
1713
+ # @option opts [FilterType] :filter_type Narrows the content listed inside every returned section to a single kind of entry, such as documents, images or one type of room. Omit it to list every kind the sections hold.
1714
+ # @option opts [Boolean] :without_trash Set it to `true` to leave the Trash section out of the returned set of sections; with `false`, or when the parameter is omitted, the section is returned whenever the account has one of its own.
1715
+ # @option opts [Integer] :count The size of the content page returned for each section separately, so a value of 1 yields one entry per section rather than one entry in total.
1716
+ # @option opts [Integer] :start_index The number of matching entries skipped in each section before its page begins; add `count` to it to ask for the next page of every section.
1717
+ # @option opts [String] :sort_by The name of the field the entries are ordered by, matched case-insensitively against the file sort fields: `DateAndTime`, `AZ`, `Size`, `Author`, `Type`, `New`, `DateAndTimeCreation`, `RoomType`, `Tags`, `Room`, `CustomOrder`, `LastOpened` and `UsedSpace`. A recognized value is also saved as the default order of the account and reused by later listings that omit the parameter, while a value matching none of the fields leaves that saved order in place.
1718
+ # @option opts [SortOrder] :sort_order The direction in which the `sortBy` field is ordered. It is saved together with `sortBy` as the default order of the account.
1719
+ # @option opts [String] :filter_value The search string the content of every section is filtered by: it is matched as a substring of entry titles and, for files, against the indexed document content as well. Omit it to list the sections unfiltered.
1720
+ # @return [Array<(FolderContentArrayWrapper, Integer, Hash)>] FolderContentArrayWrapper data, response status code and response headers
1721
+ def get_root_folders_with_http_info(opts = {})
1722
+ if @api_client.config.debugging
1723
+ @api_client.config.logger.debug 'Calling API: Files::FoldersApi.get_root_folders ...'
1724
+ end
1725
+ if @api_client.config.client_side_validation && !opts[:'count'].nil? && opts[:'count'] > 100
1726
+ fail ArgumentError, 'invalid value for "opts[:"count"]" when calling Files::FoldersApi.get_root_folders, must be smaller than or equal to 100.'
1727
+ end
1728
+
1729
+ if @api_client.config.client_side_validation && !opts[:'count'].nil? && opts[:'count'] < 1
1730
+ fail ArgumentError, 'invalid value for "opts[:"count"]" when calling Files::FoldersApi.get_root_folders, must be greater than or equal to 1.'
1731
+ end
1732
+
1733
+ # resource path
1734
+ local_var_path = '/api/2.0/files/@root'
1735
+
1736
+ # query parameters
1737
+ query_params = opts[:query_params] || {}
1738
+ query_params[:'userIdOrGroupId'] = opts[:'user_id_or_group_id'] if !opts[:'user_id_or_group_id'].nil?
1739
+ query_params[:'filterType'] = opts[:'filter_type'] if !opts[:'filter_type'].nil?
1740
+ query_params[:'withoutTrash'] = opts[:'without_trash'] if !opts[:'without_trash'].nil?
1741
+ query_params[:'count'] = opts[:'count'] if !opts[:'count'].nil?
1742
+ query_params[:'startIndex'] = opts[:'start_index'] if !opts[:'start_index'].nil?
1743
+ query_params[:'sortBy'] = opts[:'sort_by'] if !opts[:'sort_by'].nil?
1744
+ query_params[:'sortOrder'] = opts[:'sort_order'] if !opts[:'sort_order'].nil?
1745
+ query_params[:'filterValue'] = opts[:'filter_value'] if !opts[:'filter_value'].nil?
1746
+
1747
+ # header parameters
1748
+ header_params = opts[:header_params] || {}
1749
+ # HTTP header 'Accept' (if needed)
1750
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
1751
+
1752
+ # form parameters
1753
+ form_params = opts[:form_params] || {}
1754
+
1755
+ # http body (model)
1756
+ post_body = opts[:debug_body]
1757
+
1758
+ # return_type
1759
+ return_type = opts[:debug_return_type] || 'FolderContentArrayWrapper'
1760
+
1761
+ # auth_names
1762
+ auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
1763
+
1764
+ new_options = opts.merge(
1765
+ :operation => :"Files::FoldersApi.get_root_folders",
1766
+ :header_params => header_params,
1767
+ :query_params => query_params,
1768
+ :form_params => form_params,
1769
+ :body => post_body,
1770
+ :auth_names => auth_names,
1771
+ :return_type => return_type
1772
+ )
1773
+
1774
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
1775
+ if @api_client.config.debugging
1776
+ @api_client.config.logger.debug "API called: Files::FoldersApi#get_root_folders\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1777
+ end
1778
+ return data, status_code, headers
1779
+ end
1780
+
1781
+ # Get the Trash section
1782
+ # Returns the caller's Trash section: the files and folders this account has deleted, kept there until they are restored or discarded. Each member has a Trash of their own and sees only what they deleted themselves. Restore an entry by moving it back with `PUT api/2.0/files/fileops/move`, or discard the whole section with `PUT api/2.0/files/fileops/emptytrash`; both start a background operation that is polled through `GET api/2.0/files/fileops`. This call itself modifies nothing, though passing `sortBy` saves the requested order as the default order for this account. Only the top level of the section is listed, so the contents of a deleted folder are not expanded into it, and `filterValue` is matched against titles alone here rather than against document content. `metadataTemplateId` and `metadataFilters` keep only the deleted entries carrying the template and matching the conditions, the same way `GET api/2.0/files/{folderId}` does; an unknown template or field, or a malformed condition, is refused with 400. `folders` and `files` hold one page of the result, `total` counts everything that matches before `count` and `startIndex` are applied, and `current` describes the section folder. An account that is given no Trash of its own, an outsider for instance, receives 404.
1783
+ # See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-trash-folder/
1784
+ # @param [Hash] opts the optional parameters
1785
+ # @option opts [String] :user_id_or_group_id Restricts the listing to the entries authored by this portal member, or by the members of this group; the same parameter accepts either kind of identifier. Omit it to list everything the caller can read.
1786
+ # @option opts [FilterType] :filter_type Narrows the listing to a single kind of entry, such as documents, images or one type of room. Omit it to list every kind the section holds.
1787
+ # @option opts [ApplyFilterOption] :apply_filter_option Chooses which half of the listing `filterType` and `filterValue` are applied to: with `Files` the folders come back unfiltered, with `Folders` the files do, and with `All` both halves are filtered.
1788
+ # @option opts [Integer] :count The size of one page of section content. Pair it with `startIndex` to walk the listing, and compare the two with `total` in the response to see when the last page has been read.
1789
+ # @option opts [Integer] :start_index The number of matching entries to skip before the returned page begins; add `count` to it to ask for the next page.
1790
+ # @option opts [String] :sort_by The name of the field the entries are ordered by, matched case-insensitively against the file sort fields: `DateAndTime`, `AZ`, `Size`, `Author`, `Type`, `New`, `DateAndTimeCreation`, `RoomType`, `Tags`, `Room`, `CustomOrder`, `LastOpened` and `UsedSpace`. A recognized value is also saved as the default order of the account and reused by later listings that omit the parameter, while a value matching none of the fields leaves that saved order in place.
1791
+ # @option opts [SortOrder] :sort_order The direction in which the `sortBy` field is ordered. It is saved together with `sortBy` as the default order of the account.
1792
+ # @option opts [String] :filter_value The search string the section is filtered by, matched as a substring of entry titles. Omit it to list the section unfiltered.
1793
+ # @option opts [Integer] :metadata_template_id The ID of the metadata template the entries must be assigned to. On its own it narrows the listing to the entries carrying the template; together with the metadata filters it also pins the template the filtered fields belong to. The third-party entries never carry metadata and are left out when the filter is set.
1794
+ # @option opts [String] :metadata_filters The URL-encoded JSON array of the metadata filter conditions, e.g. [{fieldId:1,op:contains,value:ACME},{fieldId:2,op:range,from:2026-01-01,to:2026-06-30},{fieldId:3,op:in,optionIds:[...]}]. A string field takes eq or contains; a number or a date field takes range with inclusive bounds, or gt, gte, lt, lte with the bound in value; a date-only bound covers the whole day. A custom field is addressed by its name instead of the fieldId: {name:Client,op:eq,value:ACME}.
1795
+ # @option opts [Boolean] :include_hidden_metadata Whether the text search, and the metadataMatches it reports, also look at the values of the hidden metadata templates (created with visible false for the metadata a service keeps for itself, which the web client never shows). False, the default, leaves them out, so an entry is not found by such a value; true takes them in. metadataTemplateId and metadataFilters are not concerned: a hidden template or field named there is searched either way.
1796
+ # @return [FolderContentWrapper]
1797
+ def get_trash_folder(opts = {})
1798
+ data, _status_code, _headers = get_trash_folder_with_http_info(opts)
1799
+ data
1800
+ end
1801
+
1802
+ # Get the Trash section
1803
+ # Returns the caller's Trash section: the files and folders this account has deleted, kept there until they are restored or discarded. Each member has a Trash of their own and sees only what they deleted themselves. Restore an entry by moving it back with `PUT api/2.0/files/fileops/move`, or discard the whole section with `PUT api/2.0/files/fileops/emptytrash`; both start a background operation that is polled through `GET api/2.0/files/fileops`. This call itself modifies nothing, though passing `sortBy` saves the requested order as the default order for this account. Only the top level of the section is listed, so the contents of a deleted folder are not expanded into it, and `filterValue` is matched against titles alone here rather than against document content. `metadataTemplateId` and `metadataFilters` keep only the deleted entries carrying the template and matching the conditions, the same way `GET api/2.0/files/{folderId}` does; an unknown template or field, or a malformed condition, is refused with 400. `folders` and `files` hold one page of the result, `total` counts everything that matches before `count` and `startIndex` are applied, and `current` describes the section folder. An account that is given no Trash of its own, an outsider for instance, receives 404.
1804
+ # See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-trash-folder/
1805
+ # @param [Hash] opts the optional parameters
1806
+ # @option opts [String] :user_id_or_group_id Restricts the listing to the entries authored by this portal member, or by the members of this group; the same parameter accepts either kind of identifier. Omit it to list everything the caller can read.
1807
+ # @option opts [FilterType] :filter_type Narrows the listing to a single kind of entry, such as documents, images or one type of room. Omit it to list every kind the section holds.
1808
+ # @option opts [ApplyFilterOption] :apply_filter_option Chooses which half of the listing `filterType` and `filterValue` are applied to: with `Files` the folders come back unfiltered, with `Folders` the files do, and with `All` both halves are filtered.
1809
+ # @option opts [Integer] :count The size of one page of section content. Pair it with `startIndex` to walk the listing, and compare the two with `total` in the response to see when the last page has been read.
1810
+ # @option opts [Integer] :start_index The number of matching entries to skip before the returned page begins; add `count` to it to ask for the next page.
1811
+ # @option opts [String] :sort_by The name of the field the entries are ordered by, matched case-insensitively against the file sort fields: `DateAndTime`, `AZ`, `Size`, `Author`, `Type`, `New`, `DateAndTimeCreation`, `RoomType`, `Tags`, `Room`, `CustomOrder`, `LastOpened` and `UsedSpace`. A recognized value is also saved as the default order of the account and reused by later listings that omit the parameter, while a value matching none of the fields leaves that saved order in place.
1812
+ # @option opts [SortOrder] :sort_order The direction in which the `sortBy` field is ordered. It is saved together with `sortBy` as the default order of the account.
1813
+ # @option opts [String] :filter_value The search string the section is filtered by, matched as a substring of entry titles. Omit it to list the section unfiltered.
1814
+ # @option opts [Integer] :metadata_template_id The ID of the metadata template the entries must be assigned to. On its own it narrows the listing to the entries carrying the template; together with the metadata filters it also pins the template the filtered fields belong to. The third-party entries never carry metadata and are left out when the filter is set.
1815
+ # @option opts [String] :metadata_filters The URL-encoded JSON array of the metadata filter conditions, e.g. [{fieldId:1,op:contains,value:ACME},{fieldId:2,op:range,from:2026-01-01,to:2026-06-30},{fieldId:3,op:in,optionIds:[...]}]. A string field takes eq or contains; a number or a date field takes range with inclusive bounds, or gt, gte, lt, lte with the bound in value; a date-only bound covers the whole day. A custom field is addressed by its name instead of the fieldId: {name:Client,op:eq,value:ACME}.
1816
+ # @option opts [Boolean] :include_hidden_metadata Whether the text search, and the metadataMatches it reports, also look at the values of the hidden metadata templates (created with visible false for the metadata a service keeps for itself, which the web client never shows). False, the default, leaves them out, so an entry is not found by such a value; true takes them in. metadataTemplateId and metadataFilters are not concerned: a hidden template or field named there is searched either way.
1817
+ # @return [Array<(FolderContentWrapper, Integer, Hash)>] FolderContentWrapper data, response status code and response headers
1818
+ def get_trash_folder_with_http_info(opts = {})
1819
+ if @api_client.config.debugging
1820
+ @api_client.config.logger.debug 'Calling API: Files::FoldersApi.get_trash_folder ...'
1821
+ end
1822
+ if @api_client.config.client_side_validation && !opts[:'count'].nil? && opts[:'count'] > 100
1823
+ fail ArgumentError, 'invalid value for "opts[:"count"]" when calling Files::FoldersApi.get_trash_folder, must be smaller than or equal to 100.'
1824
+ end
1825
+
1826
+ if @api_client.config.client_side_validation && !opts[:'count'].nil? && opts[:'count'] < 1
1827
+ fail ArgumentError, 'invalid value for "opts[:"count"]" when calling Files::FoldersApi.get_trash_folder, must be greater than or equal to 1.'
1828
+ end
1829
+
1830
+ # resource path
1831
+ local_var_path = '/api/2.0/files/@trash'
1832
+
1833
+ # query parameters
1834
+ query_params = opts[:query_params] || {}
1835
+ query_params[:'userIdOrGroupId'] = opts[:'user_id_or_group_id'] if !opts[:'user_id_or_group_id'].nil?
1836
+ query_params[:'filterType'] = opts[:'filter_type'] if !opts[:'filter_type'].nil?
1837
+ query_params[:'applyFilterOption'] = opts[:'apply_filter_option'] if !opts[:'apply_filter_option'].nil?
1838
+ query_params[:'count'] = opts[:'count'] if !opts[:'count'].nil?
1839
+ query_params[:'startIndex'] = opts[:'start_index'] if !opts[:'start_index'].nil?
1840
+ query_params[:'sortBy'] = opts[:'sort_by'] if !opts[:'sort_by'].nil?
1841
+ query_params[:'sortOrder'] = opts[:'sort_order'] if !opts[:'sort_order'].nil?
1842
+ query_params[:'filterValue'] = opts[:'filter_value'] if !opts[:'filter_value'].nil?
1843
+ query_params[:'metadataTemplateId'] = opts[:'metadata_template_id'] if !opts[:'metadata_template_id'].nil?
1844
+ query_params[:'metadataFilters'] = opts[:'metadata_filters'] if !opts[:'metadata_filters'].nil?
1845
+ query_params[:'includeHiddenMetadata'] = opts[:'include_hidden_metadata'] if !opts[:'include_hidden_metadata'].nil?
1846
+
1847
+ # header parameters
1848
+ header_params = opts[:header_params] || {}
1849
+ # HTTP header 'Accept' (if needed)
1850
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
1851
+
1852
+ # form parameters
1853
+ form_params = opts[:form_params] || {}
1854
+
1855
+ # http body (model)
1856
+ post_body = opts[:debug_body]
1857
+
1858
+ # return_type
1859
+ return_type = opts[:debug_return_type] || 'FolderContentWrapper'
1860
+
1861
+ # auth_names
1862
+ auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
1863
+
1864
+ new_options = opts.merge(
1865
+ :operation => :"Files::FoldersApi.get_trash_folder",
1866
+ :header_params => header_params,
1867
+ :query_params => query_params,
1868
+ :form_params => form_params,
1869
+ :body => post_body,
1870
+ :auth_names => auth_names,
1871
+ :return_type => return_type
1872
+ )
1873
+
1874
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
1875
+ if @api_client.config.debugging
1876
+ @api_client.config.logger.debug "API called: Files::FoldersApi#get_trash_folder\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1877
+ end
1878
+ return data, status_code, headers
1879
+ end
1880
+
1881
+ # Insert a file
1882
+ # Stores a file in the folder named by the path in a single request, taking its name from `title` rather than from the uploaded part, which is what separates it from `POST api/2.0/files/{folderId}/upload`. The content may arrive either as a multipart part or as the raw request body. The name is stripped of characters a title cannot hold and truncated, and `createNewIfExist` settles the clash: false adds a new version to the file that already carries the name, true keeps both by giving the new one a numeric suffix. The caller needs the right to add content to the folder, so a reader, an editor and a guest get 403, a section root and an archived room are refused as well, and an unknown folder gives 404. Formats the portal converts are converted afterwards in the background; pass `keepConvertStatus` to keep the outcome readable through `GET api/2.0/files/file/{fileId}/checkconversion`. The answer is the stored file. A large payload belongs in a chunked session instead.
1883
+ # See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/insert-file/
1884
+ # @param folder_id [Integer, String] The folder that receives the file; take the id from a listing such as `GET api/2.0/files/@root`. A room or an ordinary folder inside one is accepted, a section root is not.
1885
+ # @param [Hash] opts the optional parameters
1886
+ # @option opts [File] :insert_file_file The content to store, sent as a `multipart/form-data` part. The same content may instead be sent as the raw request body, which is what a client that cannot build a form does; when both are present the form part wins.
1887
+ # @option opts [String] :insert_file_title The name to store the file under, extension included. It wins over the name of the uploaded part, which is the reason to choose this operation over the plain upload, and it is the only name available when the content arrives as a raw body. Characters a title cannot hold are replaced with underscores and the name is cut to 170 characters before the file is stored.
1888
+ # @option opts [Boolean] :insert_file_create_new_if_exist Settles the clash with a file already carrying that title: left out, the content is written as the next version of that file; set to true, both survive and the new one gets a numeric suffix in its title.
1889
+ # @option opts [Boolean] :insert_file_keep_convert_status Decides whether the outcome of the background conversion outlives the conversion itself. True keeps the queue record, so `GET api/2.0/files/file/{fileId}/checkconversion` can still report the result or the error; left out, the record is cleared the moment the conversion ends and that call finds nothing.
1890
+ # @option opts [Boolean] :insert_file_stream_can_read
1891
+ # @option opts [Boolean] :insert_file_stream_can_write
1892
+ # @option opts [Boolean] :insert_file_stream_can_seek
1893
+ # @option opts [Boolean] :insert_file_stream_can_timeout
1894
+ # @option opts [Integer] :insert_file_stream_length
1895
+ # @option opts [Integer] :insert_file_stream_position
1896
+ # @option opts [Integer] :insert_file_stream_read_timeout
1897
+ # @option opts [Integer] :insert_file_stream_write_timeout
1898
+ # @return [FileWrapper, ThirdPartyFileWrapper]
1899
+ def insert_file(folder_id, opts = {})
1900
+ data, _status_code, _headers = insert_file_with_http_info(folder_id, opts)
1901
+ data
1902
+ end
1903
+
1904
+ # Insert a file
1905
+ # Stores a file in the folder named by the path in a single request, taking its name from `title` rather than from the uploaded part, which is what separates it from `POST api/2.0/files/{folderId}/upload`. The content may arrive either as a multipart part or as the raw request body. The name is stripped of characters a title cannot hold and truncated, and `createNewIfExist` settles the clash: false adds a new version to the file that already carries the name, true keeps both by giving the new one a numeric suffix. The caller needs the right to add content to the folder, so a reader, an editor and a guest get 403, a section root and an archived room are refused as well, and an unknown folder gives 404. Formats the portal converts are converted afterwards in the background; pass `keepConvertStatus` to keep the outcome readable through `GET api/2.0/files/file/{fileId}/checkconversion`. The answer is the stored file. A large payload belongs in a chunked session instead.
1906
+ # See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/insert-file/
1907
+ # @param folder_id [Integer, String] The folder that receives the file; take the id from a listing such as `GET api/2.0/files/@root`. A room or an ordinary folder inside one is accepted, a section root is not.
1908
+ # @param [Hash] opts the optional parameters
1909
+ # @option opts [File] :insert_file_file The content to store, sent as a `multipart/form-data` part. The same content may instead be sent as the raw request body, which is what a client that cannot build a form does; when both are present the form part wins.
1910
+ # @option opts [String] :insert_file_title The name to store the file under, extension included. It wins over the name of the uploaded part, which is the reason to choose this operation over the plain upload, and it is the only name available when the content arrives as a raw body. Characters a title cannot hold are replaced with underscores and the name is cut to 170 characters before the file is stored.
1911
+ # @option opts [Boolean] :insert_file_create_new_if_exist Settles the clash with a file already carrying that title: left out, the content is written as the next version of that file; set to true, both survive and the new one gets a numeric suffix in its title.
1912
+ # @option opts [Boolean] :insert_file_keep_convert_status Decides whether the outcome of the background conversion outlives the conversion itself. True keeps the queue record, so `GET api/2.0/files/file/{fileId}/checkconversion` can still report the result or the error; left out, the record is cleared the moment the conversion ends and that call finds nothing.
1913
+ # @option opts [Boolean] :insert_file_stream_can_read
1914
+ # @option opts [Boolean] :insert_file_stream_can_write
1915
+ # @option opts [Boolean] :insert_file_stream_can_seek
1916
+ # @option opts [Boolean] :insert_file_stream_can_timeout
1917
+ # @option opts [Integer] :insert_file_stream_length
1918
+ # @option opts [Integer] :insert_file_stream_position
1919
+ # @option opts [Integer] :insert_file_stream_read_timeout
1920
+ # @option opts [Integer] :insert_file_stream_write_timeout
1921
+ # @return [Array<(FileWrapper, ThirdPartyFileWrapper, Integer, Hash)>] FileWrapper, ThirdPartyFileWrapper data, response status code and response headers
1922
+ def insert_file_with_http_info(folder_id, opts = {})
1923
+ if @api_client.config.debugging
1924
+ @api_client.config.logger.debug 'Calling API: Files::FoldersApi.insert_file ...'
1925
+ end
1926
+ # verify the required parameter 'folder_id' is set
1927
+ if @api_client.config.client_side_validation && folder_id.nil?
1928
+ fail ArgumentError, "Missing the required parameter 'folder_id' when calling Files::FoldersApi.insert_file"
1929
+ end
1930
+ # resource path
1931
+ local_var_path = '/api/2.0/files/{folderId}/insert'.sub('{' + 'folderId' + '}', CGI.escape(folder_id.to_s))
1932
+
1933
+ # query parameters
1934
+ query_params = opts[:query_params] || {}
1935
+
1936
+ # header parameters
1937
+ header_params = opts[:header_params] || {}
1938
+ # HTTP header 'Accept' (if needed)
1939
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
1940
+ # HTTP header 'Content-Type'
1941
+ content_type = @api_client.select_header_content_type(['multipart/form-data'])
1942
+ if !content_type.nil?
1943
+ header_params['Content-Type'] = content_type
1944
+ end
1945
+
1946
+ # form parameters
1947
+ form_params = opts[:form_params] || {}
1948
+ form_params['insertFile.file'] = opts[:'insert_file_file'] if !opts[:'insert_file_file'].nil?
1949
+ form_params['insertFile.title'] = opts[:'insert_file_title'] if !opts[:'insert_file_title'].nil?
1950
+ form_params['insertFile.createNewIfExist'] = opts[:'insert_file_create_new_if_exist'] if !opts[:'insert_file_create_new_if_exist'].nil?
1951
+ form_params['insertFile.keepConvertStatus'] = opts[:'insert_file_keep_convert_status'] if !opts[:'insert_file_keep_convert_status'].nil?
1952
+ form_params['insertFile.stream.canRead'] = opts[:'insert_file_stream_can_read'] if !opts[:'insert_file_stream_can_read'].nil?
1953
+ form_params['insertFile.stream.canWrite'] = opts[:'insert_file_stream_can_write'] if !opts[:'insert_file_stream_can_write'].nil?
1954
+ form_params['insertFile.stream.canSeek'] = opts[:'insert_file_stream_can_seek'] if !opts[:'insert_file_stream_can_seek'].nil?
1955
+ form_params['insertFile.stream.canTimeout'] = opts[:'insert_file_stream_can_timeout'] if !opts[:'insert_file_stream_can_timeout'].nil?
1956
+ form_params['insertFile.stream.length'] = opts[:'insert_file_stream_length'] if !opts[:'insert_file_stream_length'].nil?
1957
+ form_params['insertFile.stream.position'] = opts[:'insert_file_stream_position'] if !opts[:'insert_file_stream_position'].nil?
1958
+ form_params['insertFile.stream.readTimeout'] = opts[:'insert_file_stream_read_timeout'] if !opts[:'insert_file_stream_read_timeout'].nil?
1959
+ form_params['insertFile.stream.writeTimeout'] = opts[:'insert_file_stream_write_timeout'] if !opts[:'insert_file_stream_write_timeout'].nil?
1960
+
1961
+ # http body (model)
1962
+ post_body = opts[:debug_body]
1963
+
1964
+ # return_type
1965
+ return_type = opts[:debug_return_type] || (folder_id.is_a?(String) ? 'ThirdPartyFileWrapper' : 'FileWrapper')
1966
+
1967
+ # auth_names
1968
+ auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
1969
+
1970
+ new_options = opts.merge(
1971
+ :operation => :"Files::FoldersApi.insert_file",
1972
+ :header_params => header_params,
1973
+ :query_params => query_params,
1974
+ :form_params => form_params,
1975
+ :body => post_body,
1976
+ :auth_names => auth_names,
1977
+ :return_type => return_type
1978
+ )
1979
+
1980
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
1981
+ if @api_client.config.debugging
1982
+ @api_client.config.logger.debug "API called: Files::FoldersApi#insert_file\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1983
+ end
1984
+ return data, status_code, headers
1985
+ end
1986
+
1987
+ # Insert a file into My documents
1988
+ # Stores one file in the caller's own My documents section, the personal storage every portal member has, and returns the stored file. The destination takes no identifier: it is resolved from the calling account and created on first use, while a guest account has none and is answered as missing (404). Send the content as a `multipart/form-data` part or as the raw request body, and name it with `title`, which wins over the name of the uploaded part and has invalid characters replaced before storing. The call is not idempotent: by default a file of the same title is overwritten as a new version, while `createNewIfExist=true` stores a separate copy under a title made unique with a numeric suffix; a title held by a file that is locked or open in the editor cannot be overwritten either, and a second file appears under the same title. Formats listed in `extsMustConvert` of `GET api/2.0/files/settings` are converted after the response is sent; `keepConvertStatus=true` keeps that result readable through `GET api/2.0/files/file/{fileId}/checkconversion`, which otherwise drops it. Files over the single-request size limit or the account's storage quota are refused: send those through `POST api/2.0/files/{folderId}/upload/create_session`, and use `POST api/2.0/files/{folderId}/insert` for any other destination.
1989
+ # See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/insert-file-to-my-from-body/
1990
+ # @param [Hash] opts the optional parameters
1991
+ # @option opts [File] :file The content to store, sent as a `multipart/form-data` part. The same content may instead be sent as the raw request body, which is what a client that cannot build a form does; when both are present the form part wins.
1992
+ # @option opts [String] :title The name to store the file under, extension included. It wins over the name of the uploaded part, which is the reason to choose this operation over the plain upload, and it is the only name available when the content arrives as a raw body. Characters a title cannot hold are replaced with underscores and the name is cut to 170 characters before the file is stored.
1993
+ # @option opts [Boolean] :create_new_if_exist Settles the clash with a file already carrying that title: left out, the content is written as the next version of that file; set to true, both survive and the new one gets a numeric suffix in its title.
1994
+ # @option opts [Boolean] :keep_convert_status Decides whether the outcome of the background conversion outlives the conversion itself. True keeps the queue record, so `GET api/2.0/files/file/{fileId}/checkconversion` can still report the result or the error; left out, the record is cleared the moment the conversion ends and that call finds nothing.
1995
+ # @option opts [Boolean] :stream_can_read
1996
+ # @option opts [Boolean] :stream_can_write
1997
+ # @option opts [Boolean] :stream_can_seek
1998
+ # @option opts [Boolean] :stream_can_timeout
1999
+ # @option opts [Integer] :stream_length
2000
+ # @option opts [Integer] :stream_position
2001
+ # @option opts [Integer] :stream_read_timeout
2002
+ # @option opts [Integer] :stream_write_timeout
2003
+ # @return [FileWrapper]
2004
+ def insert_file_to_my_from_body(opts = {})
2005
+ data, _status_code, _headers = insert_file_to_my_from_body_with_http_info(opts)
2006
+ data
2007
+ end
2008
+
2009
+ # Insert a file into My documents
2010
+ # Stores one file in the caller's own My documents section, the personal storage every portal member has, and returns the stored file. The destination takes no identifier: it is resolved from the calling account and created on first use, while a guest account has none and is answered as missing (404). Send the content as a `multipart/form-data` part or as the raw request body, and name it with `title`, which wins over the name of the uploaded part and has invalid characters replaced before storing. The call is not idempotent: by default a file of the same title is overwritten as a new version, while `createNewIfExist=true` stores a separate copy under a title made unique with a numeric suffix; a title held by a file that is locked or open in the editor cannot be overwritten either, and a second file appears under the same title. Formats listed in `extsMustConvert` of `GET api/2.0/files/settings` are converted after the response is sent; `keepConvertStatus=true` keeps that result readable through `GET api/2.0/files/file/{fileId}/checkconversion`, which otherwise drops it. Files over the single-request size limit or the account's storage quota are refused: send those through `POST api/2.0/files/{folderId}/upload/create_session`, and use `POST api/2.0/files/{folderId}/insert` for any other destination.
2011
+ # See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/insert-file-to-my-from-body/
2012
+ # @param [Hash] opts the optional parameters
2013
+ # @option opts [File] :file The content to store, sent as a `multipart/form-data` part. The same content may instead be sent as the raw request body, which is what a client that cannot build a form does; when both are present the form part wins.
2014
+ # @option opts [String] :title The name to store the file under, extension included. It wins over the name of the uploaded part, which is the reason to choose this operation over the plain upload, and it is the only name available when the content arrives as a raw body. Characters a title cannot hold are replaced with underscores and the name is cut to 170 characters before the file is stored.
2015
+ # @option opts [Boolean] :create_new_if_exist Settles the clash with a file already carrying that title: left out, the content is written as the next version of that file; set to true, both survive and the new one gets a numeric suffix in its title.
2016
+ # @option opts [Boolean] :keep_convert_status Decides whether the outcome of the background conversion outlives the conversion itself. True keeps the queue record, so `GET api/2.0/files/file/{fileId}/checkconversion` can still report the result or the error; left out, the record is cleared the moment the conversion ends and that call finds nothing.
2017
+ # @option opts [Boolean] :stream_can_read
2018
+ # @option opts [Boolean] :stream_can_write
2019
+ # @option opts [Boolean] :stream_can_seek
2020
+ # @option opts [Boolean] :stream_can_timeout
2021
+ # @option opts [Integer] :stream_length
2022
+ # @option opts [Integer] :stream_position
2023
+ # @option opts [Integer] :stream_read_timeout
2024
+ # @option opts [Integer] :stream_write_timeout
2025
+ # @return [Array<(FileWrapper, Integer, Hash)>] FileWrapper data, response status code and response headers
2026
+ def insert_file_to_my_from_body_with_http_info(opts = {})
2027
+ if @api_client.config.debugging
2028
+ @api_client.config.logger.debug 'Calling API: Files::FoldersApi.insert_file_to_my_from_body ...'
2029
+ end
2030
+ # resource path
2031
+ local_var_path = '/api/2.0/files/@my/insert'
2032
+
2033
+ # query parameters
2034
+ query_params = opts[:query_params] || {}
2035
+
2036
+ # header parameters
2037
+ header_params = opts[:header_params] || {}
2038
+ # HTTP header 'Accept' (if needed)
2039
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
2040
+ # HTTP header 'Content-Type'
2041
+ content_type = @api_client.select_header_content_type(['multipart/form-data'])
2042
+ if !content_type.nil?
2043
+ header_params['Content-Type'] = content_type
2044
+ end
2045
+
2046
+ # form parameters
2047
+ form_params = opts[:form_params] || {}
2048
+ form_params['file'] = opts[:'file'] if !opts[:'file'].nil?
2049
+ form_params['title'] = opts[:'title'] if !opts[:'title'].nil?
2050
+ form_params['createNewIfExist'] = opts[:'create_new_if_exist'] if !opts[:'create_new_if_exist'].nil?
2051
+ form_params['keepConvertStatus'] = opts[:'keep_convert_status'] if !opts[:'keep_convert_status'].nil?
2052
+ form_params['stream.canRead'] = opts[:'stream_can_read'] if !opts[:'stream_can_read'].nil?
2053
+ form_params['stream.canWrite'] = opts[:'stream_can_write'] if !opts[:'stream_can_write'].nil?
2054
+ form_params['stream.canSeek'] = opts[:'stream_can_seek'] if !opts[:'stream_can_seek'].nil?
2055
+ form_params['stream.canTimeout'] = opts[:'stream_can_timeout'] if !opts[:'stream_can_timeout'].nil?
2056
+ form_params['stream.length'] = opts[:'stream_length'] if !opts[:'stream_length'].nil?
2057
+ form_params['stream.position'] = opts[:'stream_position'] if !opts[:'stream_position'].nil?
2058
+ form_params['stream.readTimeout'] = opts[:'stream_read_timeout'] if !opts[:'stream_read_timeout'].nil?
2059
+ form_params['stream.writeTimeout'] = opts[:'stream_write_timeout'] if !opts[:'stream_write_timeout'].nil?
2060
+
2061
+ # http body (model)
2062
+ post_body = opts[:debug_body]
2063
+
2064
+ # return_type
2065
+ return_type = opts[:debug_return_type] || 'FileWrapper'
2066
+
2067
+ # auth_names
2068
+ auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
2069
+
2070
+ new_options = opts.merge(
2071
+ :operation => :"Files::FoldersApi.insert_file_to_my_from_body",
2072
+ :header_params => header_params,
2073
+ :query_params => query_params,
2074
+ :form_params => form_params,
2075
+ :body => post_body,
2076
+ :auth_names => auth_names,
2077
+ :return_type => return_type
2078
+ )
2079
+
2080
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
2081
+ if @api_client.config.debugging
2082
+ @api_client.config.logger.debug "API called: Files::FoldersApi#insert_file_to_my_from_body\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2083
+ end
2084
+ return data, status_code, headers
2085
+ end
2086
+
2087
+ # Rename a folder
2088
+ # Gives a folder a new title and answers with the folder as it now stands. The title is trimmed, may not be blank and is refused when it is longer than the limit the schema prints; a title that matches the current one leaves the folder untouched, and titles need not be unique among the neighbours. The caller needs the right to rename the folder, which the room manager, a content creator acting on a folder of their own and the owner of a personal section have, while a guest is refused with 403 whatever their access; a folder in the Trash section or in an archived room cannot be renamed either, and a folder that does not exist is answered as not found. A room may be renamed here as well, in which case the caller needs the right to edit the room, and `PUT api/2.0/files/rooms/{id}` is the operation that changes its other settings. The call is mutating and idempotent; on a folder stored in a connected third-party account the identifier of the folder may change with the title.
2089
+ # See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/rename-folder/
2090
+ # @param folder_id [Integer, String] The folder the request is addressed to: when a folder is created it is the parent that receives the new folder, and when a folder is renamed it is the folder that gets the new title.
2091
+ # @param create_folder_request [CreateFolderRequest] The title carried by the request body.
2092
+ # @param [Hash] opts the optional parameters
2093
+ # @return [FolderWrapper, ThirdPartyFolderWrapper]
2094
+ def rename_folder(folder_id, create_folder_request, opts = {})
2095
+ data, _status_code, _headers = rename_folder_with_http_info(folder_id, create_folder_request, opts)
2096
+ data
2097
+ end
2098
+
2099
+ # Rename a folder
2100
+ # Gives a folder a new title and answers with the folder as it now stands. The title is trimmed, may not be blank and is refused when it is longer than the limit the schema prints; a title that matches the current one leaves the folder untouched, and titles need not be unique among the neighbours. The caller needs the right to rename the folder, which the room manager, a content creator acting on a folder of their own and the owner of a personal section have, while a guest is refused with 403 whatever their access; a folder in the Trash section or in an archived room cannot be renamed either, and a folder that does not exist is answered as not found. A room may be renamed here as well, in which case the caller needs the right to edit the room, and `PUT api/2.0/files/rooms/{id}` is the operation that changes its other settings. The call is mutating and idempotent; on a folder stored in a connected third-party account the identifier of the folder may change with the title.
2101
+ # See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/rename-folder/
2102
+ # @param folder_id [Integer, String] The folder the request is addressed to: when a folder is created it is the parent that receives the new folder, and when a folder is renamed it is the folder that gets the new title.
2103
+ # @param create_folder_request [CreateFolderRequest] The title carried by the request body.
2104
+ # @param [Hash] opts the optional parameters
2105
+ # @return [Array<(FolderWrapper, ThirdPartyFolderWrapper, Integer, Hash)>] FolderWrapper, ThirdPartyFolderWrapper data, response status code and response headers
2106
+ def rename_folder_with_http_info(folder_id, create_folder_request, opts = {})
2107
+ if @api_client.config.debugging
2108
+ @api_client.config.logger.debug 'Calling API: Files::FoldersApi.rename_folder ...'
2109
+ end
2110
+ # verify the required parameter 'folder_id' is set
2111
+ if @api_client.config.client_side_validation && folder_id.nil?
2112
+ fail ArgumentError, "Missing the required parameter 'folder_id' when calling Files::FoldersApi.rename_folder"
2113
+ end
2114
+ # verify the required parameter 'create_folder_request' is set
2115
+ if @api_client.config.client_side_validation && create_folder_request.nil?
2116
+ fail ArgumentError, "Missing the required parameter 'create_folder_request' when calling Files::FoldersApi.rename_folder"
2117
+ end
2118
+ # resource path
2119
+ local_var_path = '/api/2.0/files/folder/{folderId}'.sub('{' + 'folderId' + '}', CGI.escape(folder_id.to_s))
2120
+
2121
+ # query parameters
2122
+ query_params = opts[:query_params] || {}
2123
+
2124
+ # header parameters
2125
+ header_params = opts[:header_params] || {}
2126
+ # HTTP header 'Accept' (if needed)
2127
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
2128
+ # HTTP header 'Content-Type'
2129
+ content_type = @api_client.select_header_content_type(['application/json'])
2130
+ if !content_type.nil?
2131
+ header_params['Content-Type'] = content_type
2132
+ end
2133
+
2134
+ # form parameters
2135
+ form_params = opts[:form_params] || {}
2136
+
2137
+ # http body (model)
2138
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(create_folder_request)
2139
+
2140
+ # return_type
2141
+ return_type = opts[:debug_return_type] || (folder_id.is_a?(String) ? 'ThirdPartyFolderWrapper' : 'FolderWrapper')
2142
+
2143
+ # auth_names
2144
+ auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
2145
+
2146
+ new_options = opts.merge(
2147
+ :operation => :"Files::FoldersApi.rename_folder",
2148
+ :header_params => header_params,
2149
+ :query_params => query_params,
2150
+ :form_params => form_params,
2151
+ :body => post_body,
2152
+ :auth_names => auth_names,
2153
+ :return_type => return_type
2154
+ )
2155
+
2156
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
2157
+ if @api_client.config.debugging
2158
+ @api_client.config.logger.debug "API called: Files::FoldersApi#rename_folder\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2159
+ end
2160
+ return data, status_code, headers
2161
+ end
2162
+
2163
+ # Search a folder by metadata
2164
+ # Searches the folder by metadata. The same filter the folder listing takes in the metadataTemplateId and metadataFilters query parameters, here as a typed request body for the clients that build the conditions as objects rather than as a JSON string.
2165
+ # See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/search-folder/
2166
+ # @param folder_id [Integer, String] The folder ID.
2167
+ # @param folder_metadata_search [FolderMetadataSearch] The search parameters.
2168
+ # @param [Hash] opts the optional parameters
2169
+ # @return [FolderContentWrapper, ThirdPartyFolderContentWrapper]
2170
+ def search_folder(folder_id, folder_metadata_search, opts = {})
2171
+ data, _status_code, _headers = search_folder_with_http_info(folder_id, folder_metadata_search, opts)
2172
+ data
2173
+ end
2174
+
2175
+ # Search a folder by metadata
2176
+ # Searches the folder by metadata. The same filter the folder listing takes in the metadataTemplateId and metadataFilters query parameters, here as a typed request body for the clients that build the conditions as objects rather than as a JSON string.
2177
+ # See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/search-folder/
2178
+ # @param folder_id [Integer, String] The folder ID.
2179
+ # @param folder_metadata_search [FolderMetadataSearch] The search parameters.
2180
+ # @param [Hash] opts the optional parameters
2181
+ # @return [Array<(FolderContentWrapper, ThirdPartyFolderContentWrapper, Integer, Hash)>] FolderContentWrapper, ThirdPartyFolderContentWrapper data, response status code and response headers
2182
+ def search_folder_with_http_info(folder_id, folder_metadata_search, opts = {})
2183
+ if @api_client.config.debugging
2184
+ @api_client.config.logger.debug 'Calling API: Files::FoldersApi.search_folder ...'
2185
+ end
2186
+ # verify the required parameter 'folder_id' is set
2187
+ if @api_client.config.client_side_validation && folder_id.nil?
2188
+ fail ArgumentError, "Missing the required parameter 'folder_id' when calling Files::FoldersApi.search_folder"
2189
+ end
2190
+ # verify the required parameter 'folder_metadata_search' is set
2191
+ if @api_client.config.client_side_validation && folder_metadata_search.nil?
2192
+ fail ArgumentError, "Missing the required parameter 'folder_metadata_search' when calling Files::FoldersApi.search_folder"
2193
+ end
2194
+ # resource path
2195
+ local_var_path = '/api/2.0/files/{folderId}/search'.sub('{' + 'folderId' + '}', CGI.escape(folder_id.to_s))
2196
+
2197
+ # query parameters
2198
+ query_params = opts[:query_params] || {}
2199
+
2200
+ # header parameters
2201
+ header_params = opts[:header_params] || {}
2202
+ # HTTP header 'Accept' (if needed)
2203
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
2204
+ # HTTP header 'Content-Type'
2205
+ content_type = @api_client.select_header_content_type(['application/json'])
2206
+ if !content_type.nil?
2207
+ header_params['Content-Type'] = content_type
2208
+ end
2209
+
2210
+ # form parameters
2211
+ form_params = opts[:form_params] || {}
2212
+
2213
+ # http body (model)
2214
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(folder_metadata_search)
2215
+
2216
+ # return_type
2217
+ return_type = opts[:debug_return_type] || (folder_id.is_a?(String) ? 'ThirdPartyFolderContentWrapper' : 'FolderContentWrapper')
2218
+
2219
+ # auth_names
2220
+ auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
2221
+
2222
+ new_options = opts.merge(
2223
+ :operation => :"Files::FoldersApi.search_folder",
2224
+ :header_params => header_params,
2225
+ :query_params => query_params,
2226
+ :form_params => form_params,
2227
+ :body => post_body,
2228
+ :auth_names => auth_names,
2229
+ :return_type => return_type
2230
+ )
2231
+
2232
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
2233
+ if @api_client.config.debugging
2234
+ @api_client.config.logger.debug "API called: Files::FoldersApi#search_folder\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2235
+ end
2236
+ return data, status_code, headers
2237
+ end
2238
+
2239
+ # Set folder order
2240
+ # Puts a folder at a given position among the entries of its parent and answers with the folder, its `order` reporting where it now stands. Positions count from 1, and the entry that held the wanted position, together with everything after it, is shifted to make room, so the numbering of the parent stays without gaps; a position beyond the end places the folder last. The value may also be sent as a dotted path, as in 1.2.3, in which case only its last segment is read. Ordering is what the manual arrangement of a room is built on, and it only means something in rooms whose contents are indexed - elsewhere the value is stored and ignored. The caller needs edit access to the folder, which room managers and content creators have, and a member without it is refused, while a folder that does not exist is answered as not found. The call is mutating and idempotent. To move several entries in one go use `PUT api/2.0/files/order`.
2241
+ # See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/set-folder-order/
2242
+ # @param folder_id [Integer, String] The folder to move.
2243
+ # @param [Hash] opts the optional parameters
2244
+ # @option opts [OrderRequestDto] :order_request_dto The position the folder is to take.
2245
+ # @return [FolderWrapper, ThirdPartyFolderWrapper]
2246
+ def set_folder_order(folder_id, opts = {})
2247
+ data, _status_code, _headers = set_folder_order_with_http_info(folder_id, opts)
2248
+ data
2249
+ end
2250
+
2251
+ # Set folder order
2252
+ # Puts a folder at a given position among the entries of its parent and answers with the folder, its `order` reporting where it now stands. Positions count from 1, and the entry that held the wanted position, together with everything after it, is shifted to make room, so the numbering of the parent stays without gaps; a position beyond the end places the folder last. The value may also be sent as a dotted path, as in 1.2.3, in which case only its last segment is read. Ordering is what the manual arrangement of a room is built on, and it only means something in rooms whose contents are indexed - elsewhere the value is stored and ignored. The caller needs edit access to the folder, which room managers and content creators have, and a member without it is refused, while a folder that does not exist is answered as not found. The call is mutating and idempotent. To move several entries in one go use `PUT api/2.0/files/order`.
2253
+ # See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/set-folder-order/
2254
+ # @param folder_id [Integer, String] The folder to move.
2255
+ # @param [Hash] opts the optional parameters
2256
+ # @option opts [OrderRequestDto] :order_request_dto The position the folder is to take.
2257
+ # @return [Array<(FolderWrapper, ThirdPartyFolderWrapper, Integer, Hash)>] FolderWrapper, ThirdPartyFolderWrapper data, response status code and response headers
2258
+ def set_folder_order_with_http_info(folder_id, opts = {})
2259
+ if @api_client.config.debugging
2260
+ @api_client.config.logger.debug 'Calling API: Files::FoldersApi.set_folder_order ...'
2261
+ end
2262
+ # verify the required parameter 'folder_id' is set
2263
+ if @api_client.config.client_side_validation && folder_id.nil?
2264
+ fail ArgumentError, "Missing the required parameter 'folder_id' when calling Files::FoldersApi.set_folder_order"
2265
+ end
2266
+ # resource path
2267
+ local_var_path = '/api/2.0/files/folder/{folderId}/order'.sub('{' + 'folderId' + '}', CGI.escape(folder_id.to_s))
2268
+
2269
+ # query parameters
2270
+ query_params = opts[:query_params] || {}
2271
+
2272
+ # header parameters
2273
+ header_params = opts[:header_params] || {}
2274
+ # HTTP header 'Accept' (if needed)
2275
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
2276
+ # HTTP header 'Content-Type'
2277
+ content_type = @api_client.select_header_content_type(['application/json'])
2278
+ if !content_type.nil?
2279
+ header_params['Content-Type'] = content_type
2280
+ end
2281
+
2282
+ # form parameters
2283
+ form_params = opts[:form_params] || {}
2284
+
2285
+ # http body (model)
2286
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'order_request_dto'])
2287
+
2288
+ # return_type
2289
+ return_type = opts[:debug_return_type] || (folder_id.is_a?(String) ? 'ThirdPartyFolderWrapper' : 'FolderWrapper')
2290
+
2291
+ # auth_names
2292
+ auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
2293
+
2294
+ new_options = opts.merge(
2295
+ :operation => :"Files::FoldersApi.set_folder_order",
2296
+ :header_params => header_params,
2297
+ :query_params => query_params,
2298
+ :form_params => form_params,
2299
+ :body => post_body,
2300
+ :auth_names => auth_names,
2301
+ :return_type => return_type
2302
+ )
2303
+
2304
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
2305
+ if @api_client.config.debugging
2306
+ @api_client.config.logger.debug "API called: Files::FoldersApi#set_folder_order\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2307
+ end
2308
+ return data, status_code, headers
2309
+ end
2310
+
2311
+ # Set the folder external link
2312
+ # Creates an external link to a folder or a room, or changes or revokes an existing one, and answers with the link as it now stands. `linkId` decides which: an identifier that is not yet in use, the empty one included, creates a link, while the identifier of an existing link rewrites it, so the whole set of parameters is applied every time and a field left out is reset rather than kept. `access` carries the rights the link grants, and `access` set to the value that denies everything revokes the link instead - the answer is then empty, and a revoked primary link is not recreated by a later read. `title` names the link for the people who manage it, `expirationDate` limits its lifetime and is ignored when it lies in the past, `password` asks visitors for a secret, `denyDownload` leaves them with viewing only, `internal` admits signed-in members alone, and `primary=true` makes it the primary link of the folder. The caller needs the right to manage the links of the room, which its manager and a portal administrator acting as room manager have; anyone else is refused and an unknown folder is answered as not found. The call is mutating.
2313
+ # See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/set-folder-primary-external-link/
2314
+ # @param id [Integer, String] The folder or room the link belongs to.
2315
+ # @param folder_link_request [FolderLinkRequest] The link and the way it is to be shaped.
2316
+ # @param [Hash] opts the optional parameters
2317
+ # @return [FileShareWrapper]
2318
+ def set_folder_primary_external_link(id, folder_link_request, opts = {})
2319
+ data, _status_code, _headers = set_folder_primary_external_link_with_http_info(id, folder_link_request, opts)
2320
+ data
2321
+ end
2322
+
2323
+ # Set the folder external link
2324
+ # Creates an external link to a folder or a room, or changes or revokes an existing one, and answers with the link as it now stands. `linkId` decides which: an identifier that is not yet in use, the empty one included, creates a link, while the identifier of an existing link rewrites it, so the whole set of parameters is applied every time and a field left out is reset rather than kept. `access` carries the rights the link grants, and `access` set to the value that denies everything revokes the link instead - the answer is then empty, and a revoked primary link is not recreated by a later read. `title` names the link for the people who manage it, `expirationDate` limits its lifetime and is ignored when it lies in the past, `password` asks visitors for a secret, `denyDownload` leaves them with viewing only, `internal` admits signed-in members alone, and `primary=true` makes it the primary link of the folder. The caller needs the right to manage the links of the room, which its manager and a portal administrator acting as room manager have; anyone else is refused and an unknown folder is answered as not found. The call is mutating.
2325
+ # See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/set-folder-primary-external-link/
2326
+ # @param id [Integer, String] The folder or room the link belongs to.
2327
+ # @param folder_link_request [FolderLinkRequest] The link and the way it is to be shaped.
2328
+ # @param [Hash] opts the optional parameters
2329
+ # @return [Array<(FileShareWrapper, Integer, Hash)>] FileShareWrapper data, response status code and response headers
2330
+ def set_folder_primary_external_link_with_http_info(id, folder_link_request, opts = {})
2331
+ if @api_client.config.debugging
2332
+ @api_client.config.logger.debug 'Calling API: Files::FoldersApi.set_folder_primary_external_link ...'
2333
+ end
2334
+ # verify the required parameter 'id' is set
2335
+ if @api_client.config.client_side_validation && id.nil?
2336
+ fail ArgumentError, "Missing the required parameter 'id' when calling Files::FoldersApi.set_folder_primary_external_link"
2337
+ end
2338
+ # verify the required parameter 'folder_link_request' is set
2339
+ if @api_client.config.client_side_validation && folder_link_request.nil?
2340
+ fail ArgumentError, "Missing the required parameter 'folder_link_request' when calling Files::FoldersApi.set_folder_primary_external_link"
2341
+ end
2342
+ # resource path
2343
+ local_var_path = '/api/2.0/files/folder/{id}/links'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
2344
+
2345
+ # query parameters
2346
+ query_params = opts[:query_params] || {}
2347
+
2348
+ # header parameters
2349
+ header_params = opts[:header_params] || {}
2350
+ # HTTP header 'Accept' (if needed)
2351
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
2352
+ # HTTP header 'Content-Type'
2353
+ content_type = @api_client.select_header_content_type(['application/json'])
2354
+ if !content_type.nil?
2355
+ header_params['Content-Type'] = content_type
2356
+ end
2357
+
2358
+ # form parameters
2359
+ form_params = opts[:form_params] || {}
2360
+
2361
+ # http body (model)
2362
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(folder_link_request)
2363
+
2364
+ # return_type
2365
+ return_type = opts[:debug_return_type] || 'FileShareWrapper'
2366
+
2367
+ # auth_names
2368
+ auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
2369
+
2370
+ new_options = opts.merge(
2371
+ :operation => :"Files::FoldersApi.set_folder_primary_external_link",
2372
+ :header_params => header_params,
2373
+ :query_params => query_params,
2374
+ :form_params => form_params,
2375
+ :body => post_body,
2376
+ :auth_names => auth_names,
2377
+ :return_type => return_type
2378
+ )
2379
+
2380
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
2381
+ if @api_client.config.debugging
2382
+ @api_client.config.logger.debug "API called: Files::FoldersApi#set_folder_primary_external_link\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2383
+ end
2384
+ return data, status_code, headers
2385
+ end
2386
+
2387
+ # Terminate the folder history report generation
2388
+ # Gives up the history report the caller has started for a folder with `POST api/2.0/files/folder/{folderId}/log/report`. The request only asks the background worker to stop, and the answer carries no body, so a following `GET api/2.0/files/folder/{folderId}/log/report` is what shows the task ending as cancelled. Asking to terminate when nothing is running is accepted and changes nothing, which makes the call safe to repeat. A report that has already finished is not undone by this call and its file stays in My documents. The caller needs read access to the folder and may not be a guest; a caller who fails the access rule is answered with 403, a folder that does not exist with 404, and a portal with the login history and audit trail section turned off with 402. Each caller can only terminate their own report.
2389
+ # See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/terminate-report-folder-history/
2390
+ # @param folder_id [Integer] The folder whose running history report is to be given up. It is the folder that was passed to the operation that started the report.
2391
+ # @param [Hash] opts the optional parameters
2392
+ # @return [nil]
2393
+ def terminate_report_folder_history(folder_id, opts = {})
2394
+ terminate_report_folder_history_with_http_info(folder_id, opts)
2395
+ nil
2396
+ end
2397
+
2398
+ # Terminate the folder history report generation
2399
+ # Gives up the history report the caller has started for a folder with `POST api/2.0/files/folder/{folderId}/log/report`. The request only asks the background worker to stop, and the answer carries no body, so a following `GET api/2.0/files/folder/{folderId}/log/report` is what shows the task ending as cancelled. Asking to terminate when nothing is running is accepted and changes nothing, which makes the call safe to repeat. A report that has already finished is not undone by this call and its file stays in My documents. The caller needs read access to the folder and may not be a guest; a caller who fails the access rule is answered with 403, a folder that does not exist with 404, and a portal with the login history and audit trail section turned off with 402. Each caller can only terminate their own report.
2400
+ # See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/terminate-report-folder-history/
2401
+ # @param folder_id [Integer] The folder whose running history report is to be given up. It is the folder that was passed to the operation that started the report.
2402
+ # @param [Hash] opts the optional parameters
2403
+ # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
2404
+ def terminate_report_folder_history_with_http_info(folder_id, opts = {})
2405
+ if @api_client.config.debugging
2406
+ @api_client.config.logger.debug 'Calling API: Files::FoldersApi.terminate_report_folder_history ...'
2407
+ end
2408
+ # verify the required parameter 'folder_id' is set
2409
+ if @api_client.config.client_side_validation && folder_id.nil?
2410
+ fail ArgumentError, "Missing the required parameter 'folder_id' when calling Files::FoldersApi.terminate_report_folder_history"
2411
+ end
2412
+ # resource path
2413
+ local_var_path = '/api/2.0/files/folder/{folderId}/log/report'.sub('{' + 'folderId' + '}', CGI.escape(folder_id.to_s))
2414
+
2415
+ # query parameters
2416
+ query_params = opts[:query_params] || {}
2417
+
2418
+ # header parameters
2419
+ header_params = opts[:header_params] || {}
2420
+ # HTTP header 'Accept' (if needed)
2421
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
2422
+
2423
+ # form parameters
2424
+ form_params = opts[:form_params] || {}
2425
+
2426
+ # http body (model)
2427
+ post_body = opts[:debug_body]
2428
+
2429
+ # return_type
2430
+ return_type = opts[:debug_return_type]
2431
+
2432
+ # auth_names
2433
+ auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
2434
+
2435
+ new_options = opts.merge(
2436
+ :operation => :"Files::FoldersApi.terminate_report_folder_history",
2437
+ :header_params => header_params,
2438
+ :query_params => query_params,
2439
+ :form_params => form_params,
2440
+ :body => post_body,
2441
+ :auth_names => auth_names,
2442
+ :return_type => return_type
2443
+ )
2444
+
2445
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
2446
+ if @api_client.config.debugging
2447
+ @api_client.config.logger.debug "API called: Files::FoldersApi#terminate_report_folder_history\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2448
+ end
2449
+ return data, status_code, headers
2450
+ end
2451
+
2452
+ # Upload a file
2453
+ # Stores a file in the folder named by the path in a single multipart request, taking its name from the uploaded part; use `POST api/2.0/files/{folderId}/insert` when the name has to be given separately or the content is sent as a raw body. The answer is a list that always holds exactly one file. `createNewIfExist` settles the clash: false adds a new version to the file that already carries the name, true keeps both by giving the new one a numeric suffix. `storeOriginalFile` reaches further than this call, because it saves the setting on the calling account, the same one `PUT api/2.0/files/storeoriginal` writes, and it stays in force for later uploads. The caller needs the right to add content to the folder, so a reader, an editor and a guest get 403, a section root and an archived room are refused as well, and an unknown folder gives 404. A request without a file is rejected as invalid, and a payload above the portal upload limit is refused.
2454
+ # See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/upload-file/
2455
+ # @param folder_id [Integer, String] The folder that receives the file; take the id from a listing such as `GET api/2.0/files/@root`. A room or an ordinary folder inside one is accepted, a section root is not.
2456
+ # @param [Hash] opts the optional parameters
2457
+ # @option opts [Boolean] :create_new_if_exist Settles the clash with a file already carrying that title: left out, the content is written as the next version of that file; set to true, both survive and the new one gets a numeric suffix in its title.
2458
+ # @option opts [Boolean] :store_original_file Reaches further than this request: it writes a setting on the calling account, the same one `PUT api/2.0/files/storeoriginal` writes, and it stays in force for later uploads. True keeps both the uploaded file and the copy the portal converts it into, false replaces the uploaded file with the converted one, and leaving it out keeps whatever the account already has.
2459
+ # @option opts [Boolean] :keep_convert_status Decides whether the outcome of the background conversion outlives the conversion itself. True keeps the queue record, so `GET api/2.0/files/file/{fileId}/checkconversion` can still report the result or the error; left out, the record is cleared the moment the conversion ends and that call finds nothing.
2460
+ # @option opts [File] :file The content to store, sent as a `multipart/form-data` part; the name of that part becomes the title of the stored file, with characters a title cannot hold replaced and the name cut to 170 characters. A request without it is rejected as invalid.
2461
+ # @return [FileArrayWrapper, ThirdPartyFileArrayWrapper]
2462
+ def upload_file(folder_id, opts = {})
2463
+ data, _status_code, _headers = upload_file_with_http_info(folder_id, opts)
2464
+ data
2465
+ end
2466
+
2467
+ # Upload a file
2468
+ # Stores a file in the folder named by the path in a single multipart request, taking its name from the uploaded part; use `POST api/2.0/files/{folderId}/insert` when the name has to be given separately or the content is sent as a raw body. The answer is a list that always holds exactly one file. `createNewIfExist` settles the clash: false adds a new version to the file that already carries the name, true keeps both by giving the new one a numeric suffix. `storeOriginalFile` reaches further than this call, because it saves the setting on the calling account, the same one `PUT api/2.0/files/storeoriginal` writes, and it stays in force for later uploads. The caller needs the right to add content to the folder, so a reader, an editor and a guest get 403, a section root and an archived room are refused as well, and an unknown folder gives 404. A request without a file is rejected as invalid, and a payload above the portal upload limit is refused.
2469
+ # See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/upload-file/
2470
+ # @param folder_id [Integer, String] The folder that receives the file; take the id from a listing such as `GET api/2.0/files/@root`. A room or an ordinary folder inside one is accepted, a section root is not.
2471
+ # @param [Hash] opts the optional parameters
2472
+ # @option opts [Boolean] :create_new_if_exist Settles the clash with a file already carrying that title: left out, the content is written as the next version of that file; set to true, both survive and the new one gets a numeric suffix in its title.
2473
+ # @option opts [Boolean] :store_original_file Reaches further than this request: it writes a setting on the calling account, the same one `PUT api/2.0/files/storeoriginal` writes, and it stays in force for later uploads. True keeps both the uploaded file and the copy the portal converts it into, false replaces the uploaded file with the converted one, and leaving it out keeps whatever the account already has.
2474
+ # @option opts [Boolean] :keep_convert_status Decides whether the outcome of the background conversion outlives the conversion itself. True keeps the queue record, so `GET api/2.0/files/file/{fileId}/checkconversion` can still report the result or the error; left out, the record is cleared the moment the conversion ends and that call finds nothing.
2475
+ # @option opts [File] :file The content to store, sent as a `multipart/form-data` part; the name of that part becomes the title of the stored file, with characters a title cannot hold replaced and the name cut to 170 characters. A request without it is rejected as invalid.
2476
+ # @return [Array<(FileArrayWrapper, ThirdPartyFileArrayWrapper, Integer, Hash)>] FileArrayWrapper, ThirdPartyFileArrayWrapper data, response status code and response headers
2477
+ def upload_file_with_http_info(folder_id, opts = {})
2478
+ if @api_client.config.debugging
2479
+ @api_client.config.logger.debug 'Calling API: Files::FoldersApi.upload_file ...'
2480
+ end
2481
+ # verify the required parameter 'folder_id' is set
2482
+ if @api_client.config.client_side_validation && folder_id.nil?
2483
+ fail ArgumentError, "Missing the required parameter 'folder_id' when calling Files::FoldersApi.upload_file"
2484
+ end
2485
+ # resource path
2486
+ local_var_path = '/api/2.0/files/{folderId}/upload'.sub('{' + 'folderId' + '}', CGI.escape(folder_id.to_s))
2487
+
2488
+ # query parameters
2489
+ query_params = opts[:query_params] || {}
2490
+ query_params[:'createNewIfExist'] = opts[:'create_new_if_exist'] if !opts[:'create_new_if_exist'].nil?
2491
+ query_params[:'storeOriginalFile'] = opts[:'store_original_file'] if !opts[:'store_original_file'].nil?
2492
+ query_params[:'keepConvertStatus'] = opts[:'keep_convert_status'] if !opts[:'keep_convert_status'].nil?
2493
+
2494
+ # header parameters
2495
+ header_params = opts[:header_params] || {}
2496
+ # HTTP header 'Accept' (if needed)
2497
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
2498
+ # HTTP header 'Content-Type'
2499
+ content_type = @api_client.select_header_content_type(['multipart/form-data'])
2500
+ if !content_type.nil?
2501
+ header_params['Content-Type'] = content_type
2502
+ end
2503
+
2504
+ # form parameters
2505
+ form_params = opts[:form_params] || {}
2506
+ form_params['file'] = opts[:'file'] if !opts[:'file'].nil?
2507
+
2508
+ # http body (model)
2509
+ post_body = opts[:debug_body]
2510
+
2511
+ # return_type
2512
+ return_type = opts[:debug_return_type] || (folder_id.is_a?(String) ? 'ThirdPartyFileArrayWrapper' : 'FileArrayWrapper')
2513
+
2514
+ # auth_names
2515
+ auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
2516
+
2517
+ new_options = opts.merge(
2518
+ :operation => :"Files::FoldersApi.upload_file",
2519
+ :header_params => header_params,
2520
+ :query_params => query_params,
2521
+ :form_params => form_params,
2522
+ :body => post_body,
2523
+ :auth_names => auth_names,
2524
+ :return_type => return_type
2525
+ )
2526
+
2527
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
2528
+ if @api_client.config.debugging
2529
+ @api_client.config.logger.debug "API called: Files::FoldersApi#upload_file\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2530
+ end
2531
+ return data, status_code, headers
2532
+ end
2533
+
2534
+ # Upload a file to My documents
2535
+ # Uploads one file into the caller's own My documents section and returns it inside a single-element array; one request stores exactly one file. The destination takes no identifier: it is resolved from the calling account and created on first use, while a guest account has none and is answered as missing (404). The body has to be `multipart/form-data` carrying the file part; a request without it is rejected as invalid, and the stored name comes from that part, since unlike `POST api/2.0/files/@my/insert` there is no separate title. The call is not idempotent: by default a file of the same title is overwritten as a new version, while `createNewIfExist=true` stores a separate copy under a title made unique with a numeric suffix. `storeOriginalFile` is not a per-request switch: it writes the same account setting as `PUT api/2.0/files/storeoriginal`, which decides what happens to the formats listed in `extsMustConvert` of `GET api/2.0/files/settings` when they are converted after the response - false replaces the uploaded file with the converted one, true keeps both; `keepConvertStatus=true` keeps that conversion result readable through `GET api/2.0/files/file/{fileId}/checkconversion`. Files over the single-request size limit or the account's storage quota are refused; send those through `POST api/2.0/files/{folderId}/upload/create_session`.
2536
+ # See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/upload-file-to-my/
2537
+ # @param [Hash] opts the optional parameters
2538
+ # @option opts [Boolean] :create_new_if_exist Settles the clash with a file already carrying that title: left out, the content is written as the next version of that file; set to true, both survive and the new one gets a numeric suffix in its title.
2539
+ # @option opts [Boolean] :store_original_file Reaches further than this request: it writes a setting on the calling account, the same one `PUT api/2.0/files/storeoriginal` writes, and it stays in force for later uploads. True keeps both the uploaded file and the copy the portal converts it into, false replaces the uploaded file with the converted one, and leaving it out keeps whatever the account already has.
2540
+ # @option opts [Boolean] :keep_convert_status Decides whether the outcome of the background conversion outlives the conversion itself. True keeps the queue record, so `GET api/2.0/files/file/{fileId}/checkconversion` can still report the result or the error; left out, the record is cleared the moment the conversion ends and that call finds nothing.
2541
+ # @option opts [File] :file The content to store, sent as a `multipart/form-data` part; the name of that part becomes the title of the stored file, with characters a title cannot hold replaced and the name cut to 170 characters. A request without it is rejected as invalid.
2542
+ # @return [FileArrayWrapper]
2543
+ def upload_file_to_my(opts = {})
2544
+ data, _status_code, _headers = upload_file_to_my_with_http_info(opts)
2545
+ data
2546
+ end
2547
+
2548
+ # Upload a file to My documents
2549
+ # Uploads one file into the caller's own My documents section and returns it inside a single-element array; one request stores exactly one file. The destination takes no identifier: it is resolved from the calling account and created on first use, while a guest account has none and is answered as missing (404). The body has to be `multipart/form-data` carrying the file part; a request without it is rejected as invalid, and the stored name comes from that part, since unlike `POST api/2.0/files/@my/insert` there is no separate title. The call is not idempotent: by default a file of the same title is overwritten as a new version, while `createNewIfExist=true` stores a separate copy under a title made unique with a numeric suffix. `storeOriginalFile` is not a per-request switch: it writes the same account setting as `PUT api/2.0/files/storeoriginal`, which decides what happens to the formats listed in `extsMustConvert` of `GET api/2.0/files/settings` when they are converted after the response - false replaces the uploaded file with the converted one, true keeps both; `keepConvertStatus=true` keeps that conversion result readable through `GET api/2.0/files/file/{fileId}/checkconversion`. Files over the single-request size limit or the account's storage quota are refused; send those through `POST api/2.0/files/{folderId}/upload/create_session`.
2550
+ # See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/upload-file-to-my/
2551
+ # @param [Hash] opts the optional parameters
2552
+ # @option opts [Boolean] :create_new_if_exist Settles the clash with a file already carrying that title: left out, the content is written as the next version of that file; set to true, both survive and the new one gets a numeric suffix in its title.
2553
+ # @option opts [Boolean] :store_original_file Reaches further than this request: it writes a setting on the calling account, the same one `PUT api/2.0/files/storeoriginal` writes, and it stays in force for later uploads. True keeps both the uploaded file and the copy the portal converts it into, false replaces the uploaded file with the converted one, and leaving it out keeps whatever the account already has.
2554
+ # @option opts [Boolean] :keep_convert_status Decides whether the outcome of the background conversion outlives the conversion itself. True keeps the queue record, so `GET api/2.0/files/file/{fileId}/checkconversion` can still report the result or the error; left out, the record is cleared the moment the conversion ends and that call finds nothing.
2555
+ # @option opts [File] :file The content to store, sent as a `multipart/form-data` part; the name of that part becomes the title of the stored file, with characters a title cannot hold replaced and the name cut to 170 characters. A request without it is rejected as invalid.
2556
+ # @return [Array<(FileArrayWrapper, Integer, Hash)>] FileArrayWrapper data, response status code and response headers
2557
+ def upload_file_to_my_with_http_info(opts = {})
2558
+ if @api_client.config.debugging
2559
+ @api_client.config.logger.debug 'Calling API: Files::FoldersApi.upload_file_to_my ...'
2560
+ end
2561
+ # resource path
2562
+ local_var_path = '/api/2.0/files/@my/upload'
2563
+
2564
+ # query parameters
2565
+ query_params = opts[:query_params] || {}
2566
+ query_params[:'createNewIfExist'] = opts[:'create_new_if_exist'] if !opts[:'create_new_if_exist'].nil?
2567
+ query_params[:'storeOriginalFile'] = opts[:'store_original_file'] if !opts[:'store_original_file'].nil?
2568
+ query_params[:'keepConvertStatus'] = opts[:'keep_convert_status'] if !opts[:'keep_convert_status'].nil?
2569
+
2570
+ # header parameters
2571
+ header_params = opts[:header_params] || {}
2572
+ # HTTP header 'Accept' (if needed)
2573
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
2574
+ # HTTP header 'Content-Type'
2575
+ content_type = @api_client.select_header_content_type(['multipart/form-data'])
2576
+ if !content_type.nil?
2577
+ header_params['Content-Type'] = content_type
2578
+ end
2579
+
2580
+ # form parameters
2581
+ form_params = opts[:form_params] || {}
2582
+ form_params['file'] = opts[:'file'] if !opts[:'file'].nil?
2583
+
2584
+ # http body (model)
2585
+ post_body = opts[:debug_body]
2586
+
2587
+ # return_type
2588
+ return_type = opts[:debug_return_type] || 'FileArrayWrapper'
2589
+
2590
+ # auth_names
2591
+ auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
2592
+
2593
+ new_options = opts.merge(
2594
+ :operation => :"Files::FoldersApi.upload_file_to_my",
2595
+ :header_params => header_params,
2596
+ :query_params => query_params,
2597
+ :form_params => form_params,
2598
+ :body => post_body,
2599
+ :auth_names => auth_names,
2600
+ :return_type => return_type
2601
+ )
2602
+
2603
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
2604
+ if @api_client.config.debugging
2605
+ @api_client.config.logger.debug "API called: Files::FoldersApi#upload_file_to_my\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2606
+ end
2607
+ return data, status_code, headers
2608
+ end
2609
+ end
2610
+ end
2611
+ end