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,1722 @@
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 OperationsApi
21
+ attr_accessor :api_client
22
+
23
+ def initialize(api_client = ApiClient.default)
24
+ @api_client = api_client
25
+ end
26
+ # Abort an upload session
27
+ # Cancels a chunked upload opened with `POST api/2.0/files/{folderId}/session` and discards the parts already received, so nothing of it reaches the folder. The session is found by the id in the path alone: the folder segment is not matched against it, and neither is the account that opened it, which makes the id the only secret protecting the transfer. The call is destructive and is not safe to repeat, because the record is gone afterwards: a second attempt, a session already closed by `PUT api/2.0/files/{folderId}/session/{sessionId}/finalize` and a session that expired after twelve hours of silence all fail rather than answer as missing. Finalizing removes the session too, so there is nothing left to abort once the file exists. The answer carries no body. An upload that is simply abandoned needs no call at all, since the session and its buffered parts are dropped when it expires.
28
+ # See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/abort-upload-session/
29
+ # @param session_id [String] The session to cancel, as returned in `id` when it was created: a 32-character hexadecimal string that identifies the session on its own.
30
+ # @param folder_id [Integer, String] The folder the session was opened against. It is part of the route only and is not matched against the session, which is found by its own id.
31
+ # @param [Hash] opts the optional parameters
32
+ # @return [nil]
33
+ def abort_upload_session(session_id, folder_id, opts = {})
34
+ abort_upload_session_with_http_info(session_id, folder_id, opts)
35
+ nil
36
+ end
37
+
38
+ # Abort an upload session
39
+ # Cancels a chunked upload opened with `POST api/2.0/files/{folderId}/session` and discards the parts already received, so nothing of it reaches the folder. The session is found by the id in the path alone: the folder segment is not matched against it, and neither is the account that opened it, which makes the id the only secret protecting the transfer. The call is destructive and is not safe to repeat, because the record is gone afterwards: a second attempt, a session already closed by `PUT api/2.0/files/{folderId}/session/{sessionId}/finalize` and a session that expired after twelve hours of silence all fail rather than answer as missing. Finalizing removes the session too, so there is nothing left to abort once the file exists. The answer carries no body. An upload that is simply abandoned needs no call at all, since the session and its buffered parts are dropped when it expires.
40
+ # See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/abort-upload-session/
41
+ # @param session_id [String] The session to cancel, as returned in `id` when it was created: a 32-character hexadecimal string that identifies the session on its own.
42
+ # @param folder_id [Integer, String] The folder the session was opened against. It is part of the route only and is not matched against the session, which is found by its own id.
43
+ # @param [Hash] opts the optional parameters
44
+ # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
45
+ def abort_upload_session_with_http_info(session_id, folder_id, opts = {})
46
+ if @api_client.config.debugging
47
+ @api_client.config.logger.debug 'Calling API: Files::OperationsApi.abort_upload_session ...'
48
+ end
49
+ # verify the required parameter 'session_id' is set
50
+ if @api_client.config.client_side_validation && session_id.nil?
51
+ fail ArgumentError, "Missing the required parameter 'session_id' when calling Files::OperationsApi.abort_upload_session"
52
+ end
53
+ # verify the required parameter 'folder_id' is set
54
+ if @api_client.config.client_side_validation && folder_id.nil?
55
+ fail ArgumentError, "Missing the required parameter 'folder_id' when calling Files::OperationsApi.abort_upload_session"
56
+ end
57
+ # resource path
58
+ local_var_path = '/api/2.0/files/{folderId}/session/{sessionId}'.sub('{' + 'sessionId' + '}', CGI.escape(session_id.to_s)).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
+
68
+ # form parameters
69
+ form_params = opts[:form_params] || {}
70
+
71
+ # http body (model)
72
+ post_body = opts[:debug_body]
73
+
74
+ # return_type
75
+ return_type = opts[:debug_return_type]
76
+
77
+ # auth_names
78
+ auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
79
+
80
+ new_options = opts.merge(
81
+ :operation => :"Files::OperationsApi.abort_upload_session",
82
+ :header_params => header_params,
83
+ :query_params => query_params,
84
+ :form_params => form_params,
85
+ :body => post_body,
86
+ :auth_names => auth_names,
87
+ :return_type => return_type
88
+ )
89
+
90
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
91
+ if @api_client.config.debugging
92
+ @api_client.config.logger.debug "API called: Files::OperationsApi#abort_upload_session\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
93
+ end
94
+ return data, status_code, headers
95
+ end
96
+
97
+ # Add favorite files and folders
98
+ # Marks the listed files and folders as favorites for the calling account. The favorite list is personal: nothing changes for other members, and the entries stay where they are stored. Read access to each item is enough, so a room member with view-only rights and a guest may call it. Items the caller cannot read, ids that do not exist and encrypted files of a private room are skipped without a word, and the answer is `true` even when nothing was marked, so read the outcome back from `GET api/2.0/files/@favorites` instead of trusting it. Numeric ids address entries stored in the portal itself, string ids entries on a connected third-party account, and both kinds may be sent in one request. The call is mutating but safe to repeat: an item already marked stays listed once. An entry moved to the Trash keeps its mark and is left out of the listing until it is restored. `returnSingleOperation` arrives with the shared body and does nothing here. Use `DELETE api/2.0/files/favorites` to undo, or `GET api/2.0/files/favorites/{fileId}` for a single file.
99
+ # See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/add-favorites/
100
+ # @param [Hash] opts the optional parameters
101
+ # @option opts [BaseBatchRequestDto] :base_batch_request_dto
102
+ # @return [BooleanWrapper]
103
+ def add_favorites(opts = {})
104
+ data, _status_code, _headers = add_favorites_with_http_info(opts)
105
+ data
106
+ end
107
+
108
+ # Add favorite files and folders
109
+ # Marks the listed files and folders as favorites for the calling account. The favorite list is personal: nothing changes for other members, and the entries stay where they are stored. Read access to each item is enough, so a room member with view-only rights and a guest may call it. Items the caller cannot read, ids that do not exist and encrypted files of a private room are skipped without a word, and the answer is `true` even when nothing was marked, so read the outcome back from `GET api/2.0/files/@favorites` instead of trusting it. Numeric ids address entries stored in the portal itself, string ids entries on a connected third-party account, and both kinds may be sent in one request. The call is mutating but safe to repeat: an item already marked stays listed once. An entry moved to the Trash keeps its mark and is left out of the listing until it is restored. `returnSingleOperation` arrives with the shared body and does nothing here. Use `DELETE api/2.0/files/favorites` to undo, or `GET api/2.0/files/favorites/{fileId}` for a single file.
110
+ # See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/add-favorites/
111
+ # @param [Hash] opts the optional parameters
112
+ # @option opts [BaseBatchRequestDto] :base_batch_request_dto
113
+ # @return [Array<(BooleanWrapper, Integer, Hash)>] BooleanWrapper data, response status code and response headers
114
+ def add_favorites_with_http_info(opts = {})
115
+ if @api_client.config.debugging
116
+ @api_client.config.logger.debug 'Calling API: Files::OperationsApi.add_favorites ...'
117
+ end
118
+ # resource path
119
+ local_var_path = '/api/2.0/files/favorites'
120
+
121
+ # query parameters
122
+ query_params = opts[:query_params] || {}
123
+
124
+ # header parameters
125
+ header_params = opts[:header_params] || {}
126
+ # HTTP header 'Accept' (if needed)
127
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
128
+ # HTTP header 'Content-Type'
129
+ content_type = @api_client.select_header_content_type(['application/json'])
130
+ if !content_type.nil?
131
+ header_params['Content-Type'] = content_type
132
+ end
133
+
134
+ # form parameters
135
+ form_params = opts[:form_params] || {}
136
+
137
+ # http body (model)
138
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'base_batch_request_dto'])
139
+
140
+ # return_type
141
+ return_type = opts[:debug_return_type] || 'BooleanWrapper'
142
+
143
+ # auth_names
144
+ auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
145
+
146
+ new_options = opts.merge(
147
+ :operation => :"Files::OperationsApi.add_favorites",
148
+ :header_params => header_params,
149
+ :query_params => query_params,
150
+ :form_params => form_params,
151
+ :body => post_body,
152
+ :auth_names => auth_names,
153
+ :return_type => return_type
154
+ )
155
+
156
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
157
+ if @api_client.config.debugging
158
+ @api_client.config.logger.debug "API called: Files::OperationsApi#add_favorites\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
159
+ end
160
+ return data, status_code, headers
161
+ end
162
+
163
+ # Bulk download
164
+ # Queues a background job that packs the requested files and folders into a single archive, and answers with the caller's download operations, including the one just started. The archive is not ready when the response arrives: poll `GET api/2.0/files/fileops` until the operation reports `finished`, then take the address of the archive from its `url`. Items listed in `fileConvertIds` are converted to the format named there before they are packed, while the items of `fileIds` are packed as they are. Read access to every listed item is required: an item the caller may not read fails the whole call with 403, and an id that resolves to nothing is answered as missing, so filter the selection beforehand. Only one download at a time is allowed per caller, and a second call made while the first is still running is refused with 403 as well. An empty selection queues nothing and simply answers with the operations that are already there. An anonymous caller may use the call for the items covered by the external link they hold.
165
+ # See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/bulk-download/
166
+ # @param [Hash] opts the optional parameters
167
+ # @option opts [DownloadRequestDto] :download_request_dto
168
+ # @return [FileOperationArrayWrapper]
169
+ def bulk_download(opts = {})
170
+ data, _status_code, _headers = bulk_download_with_http_info(opts)
171
+ data
172
+ end
173
+
174
+ # Bulk download
175
+ # Queues a background job that packs the requested files and folders into a single archive, and answers with the caller's download operations, including the one just started. The archive is not ready when the response arrives: poll `GET api/2.0/files/fileops` until the operation reports `finished`, then take the address of the archive from its `url`. Items listed in `fileConvertIds` are converted to the format named there before they are packed, while the items of `fileIds` are packed as they are. Read access to every listed item is required: an item the caller may not read fails the whole call with 403, and an id that resolves to nothing is answered as missing, so filter the selection beforehand. Only one download at a time is allowed per caller, and a second call made while the first is still running is refused with 403 as well. An empty selection queues nothing and simply answers with the operations that are already there. An anonymous caller may use the call for the items covered by the external link they hold.
176
+ # See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/bulk-download/
177
+ # @param [Hash] opts the optional parameters
178
+ # @option opts [DownloadRequestDto] :download_request_dto
179
+ # @return [Array<(FileOperationArrayWrapper, Integer, Hash)>] FileOperationArrayWrapper data, response status code and response headers
180
+ def bulk_download_with_http_info(opts = {})
181
+ if @api_client.config.debugging
182
+ @api_client.config.logger.debug 'Calling API: Files::OperationsApi.bulk_download ...'
183
+ end
184
+ # resource path
185
+ local_var_path = '/api/2.0/files/fileops/bulkdownload'
186
+
187
+ # query parameters
188
+ query_params = opts[:query_params] || {}
189
+
190
+ # header parameters
191
+ header_params = opts[:header_params] || {}
192
+ # HTTP header 'Accept' (if needed)
193
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
194
+ # HTTP header 'Content-Type'
195
+ content_type = @api_client.select_header_content_type(['application/json'])
196
+ if !content_type.nil?
197
+ header_params['Content-Type'] = content_type
198
+ end
199
+
200
+ # form parameters
201
+ form_params = opts[:form_params] || {}
202
+
203
+ # http body (model)
204
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'download_request_dto'])
205
+
206
+ # return_type
207
+ return_type = opts[:debug_return_type] || 'FileOperationArrayWrapper'
208
+
209
+ # auth_names
210
+ auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
211
+
212
+ new_options = opts.merge(
213
+ :operation => :"Files::OperationsApi.bulk_download",
214
+ :header_params => header_params,
215
+ :query_params => query_params,
216
+ :form_params => form_params,
217
+ :body => post_body,
218
+ :auth_names => auth_names,
219
+ :return_type => return_type
220
+ )
221
+
222
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
223
+ if @api_client.config.debugging
224
+ @api_client.config.logger.debug "API called: Files::OperationsApi#bulk_download\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
225
+ end
226
+ return data, status_code, headers
227
+ end
228
+
229
+ # Get conversion status
230
+ # Reports how far the conversion of a file has got, as a list that holds one entry while the portal still knows about that conversion and nothing once it is over. Read `progress`, which counts from 0 to 100, `error` for the reason a conversion failed, and `file`, which carries the converted file as soon as it exists. Queue the conversion with `PUT api/2.0/files/file/{fileId}/checkconversion` and poll this operation until the entry reaches 100 or disappears: a finished entry is handed out once and then dropped, and an entry whose conversion stopped is discarded a few minutes later, so an empty list means either already reported or never started rather than an error. The same empty list is the answer for an identifier no file matches. Passing `start=true` starts the conversion as well, with the format from the portal settings and no password, which makes that one flag mutating; without it the operation is read-only. The caller needs read access to the file, and anyone else is refused.
231
+ # See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/check-conversion-status/
232
+ # @param file_id [Integer, String] The file whose conversion is asked about.
233
+ # @param [Hash] opts the optional parameters
234
+ # @option opts [Boolean] :start Whether to start the conversion as well: `true` queues it with the default output format and no password, `false` only reports what the portal already knows.
235
+ # @return [ConversationResultArrayWrapper]
236
+ def check_conversion_status(file_id, opts = {})
237
+ data, _status_code, _headers = check_conversion_status_with_http_info(file_id, opts)
238
+ data
239
+ end
240
+
241
+ # Get conversion status
242
+ # Reports how far the conversion of a file has got, as a list that holds one entry while the portal still knows about that conversion and nothing once it is over. Read `progress`, which counts from 0 to 100, `error` for the reason a conversion failed, and `file`, which carries the converted file as soon as it exists. Queue the conversion with `PUT api/2.0/files/file/{fileId}/checkconversion` and poll this operation until the entry reaches 100 or disappears: a finished entry is handed out once and then dropped, and an entry whose conversion stopped is discarded a few minutes later, so an empty list means either already reported or never started rather than an error. The same empty list is the answer for an identifier no file matches. Passing `start=true` starts the conversion as well, with the format from the portal settings and no password, which makes that one flag mutating; without it the operation is read-only. The caller needs read access to the file, and anyone else is refused.
243
+ # See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/check-conversion-status/
244
+ # @param file_id [Integer, String] The file whose conversion is asked about.
245
+ # @param [Hash] opts the optional parameters
246
+ # @option opts [Boolean] :start Whether to start the conversion as well: `true` queues it with the default output format and no password, `false` only reports what the portal already knows.
247
+ # @return [Array<(ConversationResultArrayWrapper, Integer, Hash)>] ConversationResultArrayWrapper data, response status code and response headers
248
+ def check_conversion_status_with_http_info(file_id, opts = {})
249
+ if @api_client.config.debugging
250
+ @api_client.config.logger.debug 'Calling API: Files::OperationsApi.check_conversion_status ...'
251
+ end
252
+ # verify the required parameter 'file_id' is set
253
+ if @api_client.config.client_side_validation && file_id.nil?
254
+ fail ArgumentError, "Missing the required parameter 'file_id' when calling Files::OperationsApi.check_conversion_status"
255
+ end
256
+ # resource path
257
+ local_var_path = '/api/2.0/files/file/{fileId}/checkconversion'.sub('{' + 'fileId' + '}', CGI.escape(file_id.to_s))
258
+
259
+ # query parameters
260
+ query_params = opts[:query_params] || {}
261
+ query_params[:'start'] = opts[:'start'] if !opts[:'start'].nil?
262
+
263
+ # header parameters
264
+ header_params = opts[:header_params] || {}
265
+ # HTTP header 'Accept' (if needed)
266
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
267
+
268
+ # form parameters
269
+ form_params = opts[:form_params] || {}
270
+
271
+ # http body (model)
272
+ post_body = opts[:debug_body]
273
+
274
+ # return_type
275
+ return_type = opts[:debug_return_type] || 'ConversationResultArrayWrapper'
276
+
277
+ # auth_names
278
+ auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
279
+
280
+ new_options = opts.merge(
281
+ :operation => :"Files::OperationsApi.check_conversion_status",
282
+ :header_params => header_params,
283
+ :query_params => query_params,
284
+ :form_params => form_params,
285
+ :body => post_body,
286
+ :auth_names => auth_names,
287
+ :return_type => return_type
288
+ )
289
+
290
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
291
+ if @api_client.config.debugging
292
+ @api_client.config.logger.debug "API called: Files::OperationsApi#check_conversion_status\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
293
+ end
294
+ return data, status_code, headers
295
+ end
296
+
297
+ # Check move or copy conflicts
298
+ # Reports which of the requested files and folders already have a same-named entry in `destFolderId`, so that the clash can be settled before the move or the copy is started. Nothing is moved, copied or changed by the call, although the address is shared with `PUT api/2.0/files/fileops/move`: the answer is the part of the request that clashes, and an empty array means the batch would go through without one. The `conflictResolveType` of the request is not taken into account — clashing items are reported whatever it says — and encrypted files are left out of the report. A source id that resolves to nothing is not an error and is passed over. The caller needs create access to the destination: an archived room and a room the caller cannot write to are refused with 403, a destination that does not exist is answered as missing, and a request without `destFolderId` is rejected as an invalid request. To learn whether the destination accepts the files at all use `GET api/2.0/files/fileops/checkdestfolder`.
299
+ # See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/check-move-or-copy-batch-items/
300
+ # @param [Hash] opts the optional parameters
301
+ # @option opts [Boolean] :return_single_operation Which operations the answer carries: `true` returns the operation this call started and nothing else, `false` returns every operation of the same kind that the caller has running or unread. When nothing was queued, which happens for an empty selection, `true` falls back to the full list.
302
+ # @option opts [Array<CheckMoveOrCopyBatchItemsFolderIdsParameterInner>] :folder_ids The folders to move or copy, by id. A number addresses a folder stored in the portal itself, a string addresses a folder on a connected third-party account, and both kinds may be sent in one list.
303
+ # @option opts [Array<CheckMoveOrCopyBatchItemsFolderIdsParameterInner>] :file_ids The files to move or copy, by id. A number addresses a file stored in the portal itself, a string addresses a file on a connected third-party account, and both kinds may be sent in one list.
304
+ # @option opts [CheckMoveOrCopyBatchItemsDestFolderIdParameter] :dest_folder_id The folder the items go to, by id — a number for a folder stored in the portal itself, a string for a folder on a connected third-party account. Take it from a folder listing such as `GET api/2.0/files/@root`; the caller has to be allowed to create items in it, and the id of a room addresses the root of that room.
305
+ # @option opts [FileConflictResolveType] :conflict_resolve_type What happens to an item whose name is already taken in the destination folder: `skip` leaves it where it is, `overwrite` replaces the entry at the destination, and `duplicate` places it beside that entry under a name with a numeric suffix. `GET api/2.0/files/fileops/move` reports which items would clash.
306
+ # @option opts [Boolean] :delete_after Whether the finished operation is still reported: `false` keeps its final record readable through `GET api/2.0/files/fileops` until it has been read once, `true` drops the record as soon as the work is done. It deletes nothing: a move takes the sources away in any case, and a copy always leaves them.
307
+ # @option opts [Boolean] :content What is taken from a listed folder: `false` moves or copies the folder itself, `true` takes only what it contains, so its files and subfolders land in the destination and the folder is not recreated there.
308
+ # @option opts [Boolean] :to_fill_out Marks every copied PDF form as a draft prepared for filling, which is how such a copy reports its filling status in a virtual data room. Files that are not forms are left unaffected.
309
+ # @return [FileEntryBaseArrayWrapper]
310
+ def check_move_or_copy_batch_items(opts = {})
311
+ data, _status_code, _headers = check_move_or_copy_batch_items_with_http_info(opts)
312
+ data
313
+ end
314
+
315
+ # Check move or copy conflicts
316
+ # Reports which of the requested files and folders already have a same-named entry in `destFolderId`, so that the clash can be settled before the move or the copy is started. Nothing is moved, copied or changed by the call, although the address is shared with `PUT api/2.0/files/fileops/move`: the answer is the part of the request that clashes, and an empty array means the batch would go through without one. The `conflictResolveType` of the request is not taken into account — clashing items are reported whatever it says — and encrypted files are left out of the report. A source id that resolves to nothing is not an error and is passed over. The caller needs create access to the destination: an archived room and a room the caller cannot write to are refused with 403, a destination that does not exist is answered as missing, and a request without `destFolderId` is rejected as an invalid request. To learn whether the destination accepts the files at all use `GET api/2.0/files/fileops/checkdestfolder`.
317
+ # See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/check-move-or-copy-batch-items/
318
+ # @param [Hash] opts the optional parameters
319
+ # @option opts [Boolean] :return_single_operation Which operations the answer carries: `true` returns the operation this call started and nothing else, `false` returns every operation of the same kind that the caller has running or unread. When nothing was queued, which happens for an empty selection, `true` falls back to the full list.
320
+ # @option opts [Array<CheckMoveOrCopyBatchItemsFolderIdsParameterInner>] :folder_ids The folders to move or copy, by id. A number addresses a folder stored in the portal itself, a string addresses a folder on a connected third-party account, and both kinds may be sent in one list.
321
+ # @option opts [Array<CheckMoveOrCopyBatchItemsFolderIdsParameterInner>] :file_ids The files to move or copy, by id. A number addresses a file stored in the portal itself, a string addresses a file on a connected third-party account, and both kinds may be sent in one list.
322
+ # @option opts [CheckMoveOrCopyBatchItemsDestFolderIdParameter] :dest_folder_id The folder the items go to, by id — a number for a folder stored in the portal itself, a string for a folder on a connected third-party account. Take it from a folder listing such as `GET api/2.0/files/@root`; the caller has to be allowed to create items in it, and the id of a room addresses the root of that room.
323
+ # @option opts [FileConflictResolveType] :conflict_resolve_type What happens to an item whose name is already taken in the destination folder: `skip` leaves it where it is, `overwrite` replaces the entry at the destination, and `duplicate` places it beside that entry under a name with a numeric suffix. `GET api/2.0/files/fileops/move` reports which items would clash.
324
+ # @option opts [Boolean] :delete_after Whether the finished operation is still reported: `false` keeps its final record readable through `GET api/2.0/files/fileops` until it has been read once, `true` drops the record as soon as the work is done. It deletes nothing: a move takes the sources away in any case, and a copy always leaves them.
325
+ # @option opts [Boolean] :content What is taken from a listed folder: `false` moves or copies the folder itself, `true` takes only what it contains, so its files and subfolders land in the destination and the folder is not recreated there.
326
+ # @option opts [Boolean] :to_fill_out Marks every copied PDF form as a draft prepared for filling, which is how such a copy reports its filling status in a virtual data room. Files that are not forms are left unaffected.
327
+ # @return [Array<(FileEntryBaseArrayWrapper, Integer, Hash)>] FileEntryBaseArrayWrapper data, response status code and response headers
328
+ def check_move_or_copy_batch_items_with_http_info(opts = {})
329
+ if @api_client.config.debugging
330
+ @api_client.config.logger.debug 'Calling API: Files::OperationsApi.check_move_or_copy_batch_items ...'
331
+ end
332
+ # resource path
333
+ local_var_path = '/api/2.0/files/fileops/move'
334
+
335
+ # query parameters
336
+ query_params = opts[:query_params] || {}
337
+ query_params[:'returnSingleOperation'] = opts[:'return_single_operation'] if !opts[:'return_single_operation'].nil?
338
+ query_params[:'folderIds'] = @api_client.build_collection_param(opts[:'folder_ids'], :multi) if !opts[:'folder_ids'].nil?
339
+ query_params[:'fileIds'] = @api_client.build_collection_param(opts[:'file_ids'], :multi) if !opts[:'file_ids'].nil?
340
+ query_params[:'destFolderId'] = opts[:'dest_folder_id'] if !opts[:'dest_folder_id'].nil?
341
+ query_params[:'conflictResolveType'] = opts[:'conflict_resolve_type'] if !opts[:'conflict_resolve_type'].nil?
342
+ query_params[:'deleteAfter'] = opts[:'delete_after'] if !opts[:'delete_after'].nil?
343
+ query_params[:'content'] = opts[:'content'] if !opts[:'content'].nil?
344
+ query_params[:'toFillOut'] = opts[:'to_fill_out'] if !opts[:'to_fill_out'].nil?
345
+
346
+ # header parameters
347
+ header_params = opts[:header_params] || {}
348
+ # HTTP header 'Accept' (if needed)
349
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
350
+
351
+ # form parameters
352
+ form_params = opts[:form_params] || {}
353
+
354
+ # http body (model)
355
+ post_body = opts[:debug_body]
356
+
357
+ # return_type
358
+ return_type = opts[:debug_return_type] || 'FileEntryBaseArrayWrapper'
359
+
360
+ # auth_names
361
+ auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
362
+
363
+ new_options = opts.merge(
364
+ :operation => :"Files::OperationsApi.check_move_or_copy_batch_items",
365
+ :header_params => header_params,
366
+ :query_params => query_params,
367
+ :form_params => form_params,
368
+ :body => post_body,
369
+ :auth_names => auth_names,
370
+ :return_type => return_type
371
+ )
372
+
373
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
374
+ if @api_client.config.debugging
375
+ @api_client.config.logger.debug "API called: Files::OperationsApi#check_move_or_copy_batch_items\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
376
+ end
377
+ return data, status_code, headers
378
+ end
379
+
380
+ # Check the destination folder
381
+ # Reports whether the destination folder accepts the listed files, before a move or a copy is started. Only `fileIds` and `destFolderId` are read from the request: `result` says whether all of the files are accepted, only some of them or none, and `files` names the ones that are. The check is about what the destination allows to be stored in it rather than about name clashes — everywhere except a form-filling room every file is accepted, while a form-filling room accepts only PDF forms, so a text document offered to one comes back as none accepted. The caller needs create access to the destination, so a room the caller cannot write to and an archived room are refused with 403, a destination that does not exist is answered as missing, and a request without `destFolderId` is rejected as an invalid request. Folder ids and the copying options of the request play no part here. The call changes nothing; for same-named entries at the destination use `GET api/2.0/files/fileops/move`.
382
+ # See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/check-move-or-copy-dest-folder/
383
+ # @param [Hash] opts the optional parameters
384
+ # @option opts [Boolean] :return_single_operation Which operations the answer carries: `true` returns the operation this call started and nothing else, `false` returns every operation of the same kind that the caller has running or unread. When nothing was queued, which happens for an empty selection, `true` falls back to the full list.
385
+ # @option opts [Array<CheckMoveOrCopyBatchItemsFolderIdsParameterInner>] :folder_ids The folders to move or copy, by id. A number addresses a folder stored in the portal itself, a string addresses a folder on a connected third-party account, and both kinds may be sent in one list.
386
+ # @option opts [Array<CheckMoveOrCopyBatchItemsFolderIdsParameterInner>] :file_ids The files to move or copy, by id. A number addresses a file stored in the portal itself, a string addresses a file on a connected third-party account, and both kinds may be sent in one list.
387
+ # @option opts [CheckMoveOrCopyBatchItemsDestFolderIdParameter] :dest_folder_id The folder the items go to, by id — a number for a folder stored in the portal itself, a string for a folder on a connected third-party account. Take it from a folder listing such as `GET api/2.0/files/@root`; the caller has to be allowed to create items in it, and the id of a room addresses the root of that room.
388
+ # @option opts [FileConflictResolveType] :conflict_resolve_type What happens to an item whose name is already taken in the destination folder: `skip` leaves it where it is, `overwrite` replaces the entry at the destination, and `duplicate` places it beside that entry under a name with a numeric suffix. `GET api/2.0/files/fileops/move` reports which items would clash.
389
+ # @option opts [Boolean] :delete_after Whether the finished operation is still reported: `false` keeps its final record readable through `GET api/2.0/files/fileops` until it has been read once, `true` drops the record as soon as the work is done. It deletes nothing: a move takes the sources away in any case, and a copy always leaves them.
390
+ # @option opts [Boolean] :content What is taken from a listed folder: `false` moves or copies the folder itself, `true` takes only what it contains, so its files and subfolders land in the destination and the folder is not recreated there.
391
+ # @option opts [Boolean] :to_fill_out Marks every copied PDF form as a draft prepared for filling, which is how such a copy reports its filling status in a virtual data room. Files that are not forms are left unaffected.
392
+ # @return [CheckDestFolderWrapper]
393
+ def check_move_or_copy_dest_folder(opts = {})
394
+ data, _status_code, _headers = check_move_or_copy_dest_folder_with_http_info(opts)
395
+ data
396
+ end
397
+
398
+ # Check the destination folder
399
+ # Reports whether the destination folder accepts the listed files, before a move or a copy is started. Only `fileIds` and `destFolderId` are read from the request: `result` says whether all of the files are accepted, only some of them or none, and `files` names the ones that are. The check is about what the destination allows to be stored in it rather than about name clashes — everywhere except a form-filling room every file is accepted, while a form-filling room accepts only PDF forms, so a text document offered to one comes back as none accepted. The caller needs create access to the destination, so a room the caller cannot write to and an archived room are refused with 403, a destination that does not exist is answered as missing, and a request without `destFolderId` is rejected as an invalid request. Folder ids and the copying options of the request play no part here. The call changes nothing; for same-named entries at the destination use `GET api/2.0/files/fileops/move`.
400
+ # See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/check-move-or-copy-dest-folder/
401
+ # @param [Hash] opts the optional parameters
402
+ # @option opts [Boolean] :return_single_operation Which operations the answer carries: `true` returns the operation this call started and nothing else, `false` returns every operation of the same kind that the caller has running or unread. When nothing was queued, which happens for an empty selection, `true` falls back to the full list.
403
+ # @option opts [Array<CheckMoveOrCopyBatchItemsFolderIdsParameterInner>] :folder_ids The folders to move or copy, by id. A number addresses a folder stored in the portal itself, a string addresses a folder on a connected third-party account, and both kinds may be sent in one list.
404
+ # @option opts [Array<CheckMoveOrCopyBatchItemsFolderIdsParameterInner>] :file_ids The files to move or copy, by id. A number addresses a file stored in the portal itself, a string addresses a file on a connected third-party account, and both kinds may be sent in one list.
405
+ # @option opts [CheckMoveOrCopyBatchItemsDestFolderIdParameter] :dest_folder_id The folder the items go to, by id — a number for a folder stored in the portal itself, a string for a folder on a connected third-party account. Take it from a folder listing such as `GET api/2.0/files/@root`; the caller has to be allowed to create items in it, and the id of a room addresses the root of that room.
406
+ # @option opts [FileConflictResolveType] :conflict_resolve_type What happens to an item whose name is already taken in the destination folder: `skip` leaves it where it is, `overwrite` replaces the entry at the destination, and `duplicate` places it beside that entry under a name with a numeric suffix. `GET api/2.0/files/fileops/move` reports which items would clash.
407
+ # @option opts [Boolean] :delete_after Whether the finished operation is still reported: `false` keeps its final record readable through `GET api/2.0/files/fileops` until it has been read once, `true` drops the record as soon as the work is done. It deletes nothing: a move takes the sources away in any case, and a copy always leaves them.
408
+ # @option opts [Boolean] :content What is taken from a listed folder: `false` moves or copies the folder itself, `true` takes only what it contains, so its files and subfolders land in the destination and the folder is not recreated there.
409
+ # @option opts [Boolean] :to_fill_out Marks every copied PDF form as a draft prepared for filling, which is how such a copy reports its filling status in a virtual data room. Files that are not forms are left unaffected.
410
+ # @return [Array<(CheckDestFolderWrapper, Integer, Hash)>] CheckDestFolderWrapper data, response status code and response headers
411
+ def check_move_or_copy_dest_folder_with_http_info(opts = {})
412
+ if @api_client.config.debugging
413
+ @api_client.config.logger.debug 'Calling API: Files::OperationsApi.check_move_or_copy_dest_folder ...'
414
+ end
415
+ # resource path
416
+ local_var_path = '/api/2.0/files/fileops/checkdestfolder'
417
+
418
+ # query parameters
419
+ query_params = opts[:query_params] || {}
420
+ query_params[:'returnSingleOperation'] = opts[:'return_single_operation'] if !opts[:'return_single_operation'].nil?
421
+ query_params[:'folderIds'] = @api_client.build_collection_param(opts[:'folder_ids'], :multi) if !opts[:'folder_ids'].nil?
422
+ query_params[:'fileIds'] = @api_client.build_collection_param(opts[:'file_ids'], :multi) if !opts[:'file_ids'].nil?
423
+ query_params[:'destFolderId'] = opts[:'dest_folder_id'] if !opts[:'dest_folder_id'].nil?
424
+ query_params[:'conflictResolveType'] = opts[:'conflict_resolve_type'] if !opts[:'conflict_resolve_type'].nil?
425
+ query_params[:'deleteAfter'] = opts[:'delete_after'] if !opts[:'delete_after'].nil?
426
+ query_params[:'content'] = opts[:'content'] if !opts[:'content'].nil?
427
+ query_params[:'toFillOut'] = opts[:'to_fill_out'] if !opts[:'to_fill_out'].nil?
428
+
429
+ # header parameters
430
+ header_params = opts[:header_params] || {}
431
+ # HTTP header 'Accept' (if needed)
432
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
433
+
434
+ # form parameters
435
+ form_params = opts[:form_params] || {}
436
+
437
+ # http body (model)
438
+ post_body = opts[:debug_body]
439
+
440
+ # return_type
441
+ return_type = opts[:debug_return_type] || 'CheckDestFolderWrapper'
442
+
443
+ # auth_names
444
+ auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
445
+
446
+ new_options = opts.merge(
447
+ :operation => :"Files::OperationsApi.check_move_or_copy_dest_folder",
448
+ :header_params => header_params,
449
+ :query_params => query_params,
450
+ :form_params => form_params,
451
+ :body => post_body,
452
+ :auth_names => auth_names,
453
+ :return_type => return_type
454
+ )
455
+
456
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
457
+ if @api_client.config.debugging
458
+ @api_client.config.logger.debug "API called: Files::OperationsApi#check_move_or_copy_dest_folder\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
459
+ end
460
+ return data, status_code, headers
461
+ end
462
+
463
+ # Copy files and folders
464
+ # Queues a background job that copies the requested files and folders into `destFolderId`, leaving the originals where they are, and answers with the caller's move and copy operations, including the one just started. Poll `GET api/2.0/files/fileops` until the operation reports `finished`; its `files` and `folders` then name what was produced. Before starting, `GET api/2.0/files/fileops/move` reports which items already have a same-named entry at the destination and `conflictResolveType` decides what happens to them, while `GET api/2.0/files/fileops/checkdestfolder` reports whether the destination accepts the files at all. The caller needs create access to the destination — room manager or content-creator rights inside a room — and read access to every source item; anything less is refused with 403. With `content=true` each listed folder is replaced by its own files and subfolders, so the folder itself is not recreated at the destination. An empty selection queues nothing and answers with the operations that are already there. To remove the originals instead use `PUT api/2.0/files/fileops/move`.
465
+ # See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/copy-batch-items/
466
+ # @param [Hash] opts the optional parameters
467
+ # @option opts [BatchRequestDto] :batch_request_dto
468
+ # @return [FileOperationArrayWrapper]
469
+ def copy_batch_items(opts = {})
470
+ data, _status_code, _headers = copy_batch_items_with_http_info(opts)
471
+ data
472
+ end
473
+
474
+ # Copy files and folders
475
+ # Queues a background job that copies the requested files and folders into `destFolderId`, leaving the originals where they are, and answers with the caller's move and copy operations, including the one just started. Poll `GET api/2.0/files/fileops` until the operation reports `finished`; its `files` and `folders` then name what was produced. Before starting, `GET api/2.0/files/fileops/move` reports which items already have a same-named entry at the destination and `conflictResolveType` decides what happens to them, while `GET api/2.0/files/fileops/checkdestfolder` reports whether the destination accepts the files at all. The caller needs create access to the destination — room manager or content-creator rights inside a room — and read access to every source item; anything less is refused with 403. With `content=true` each listed folder is replaced by its own files and subfolders, so the folder itself is not recreated at the destination. An empty selection queues nothing and answers with the operations that are already there. To remove the originals instead use `PUT api/2.0/files/fileops/move`.
476
+ # See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/copy-batch-items/
477
+ # @param [Hash] opts the optional parameters
478
+ # @option opts [BatchRequestDto] :batch_request_dto
479
+ # @return [Array<(FileOperationArrayWrapper, Integer, Hash)>] FileOperationArrayWrapper data, response status code and response headers
480
+ def copy_batch_items_with_http_info(opts = {})
481
+ if @api_client.config.debugging
482
+ @api_client.config.logger.debug 'Calling API: Files::OperationsApi.copy_batch_items ...'
483
+ end
484
+ # resource path
485
+ local_var_path = '/api/2.0/files/fileops/copy'
486
+
487
+ # query parameters
488
+ query_params = opts[:query_params] || {}
489
+
490
+ # header parameters
491
+ header_params = opts[:header_params] || {}
492
+ # HTTP header 'Accept' (if needed)
493
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
494
+ # HTTP header 'Content-Type'
495
+ content_type = @api_client.select_header_content_type(['application/json'])
496
+ if !content_type.nil?
497
+ header_params['Content-Type'] = content_type
498
+ end
499
+
500
+ # form parameters
501
+ form_params = opts[:form_params] || {}
502
+
503
+ # http body (model)
504
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'batch_request_dto'])
505
+
506
+ # return_type
507
+ return_type = opts[:debug_return_type] || 'FileOperationArrayWrapper'
508
+
509
+ # auth_names
510
+ auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
511
+
512
+ new_options = opts.merge(
513
+ :operation => :"Files::OperationsApi.copy_batch_items",
514
+ :header_params => header_params,
515
+ :query_params => query_params,
516
+ :form_params => form_params,
517
+ :body => post_body,
518
+ :auth_names => auth_names,
519
+ :return_type => return_type
520
+ )
521
+
522
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
523
+ if @api_client.config.debugging
524
+ @api_client.config.logger.debug "API called: Files::OperationsApi#copy_batch_items\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
525
+ end
526
+ return data, status_code, headers
527
+ end
528
+
529
+ # Chunked upload
530
+ # Deprecated in favour of `POST api/2.0/files/{folderId}/session`, which opens the same session and returns it without the success envelope used here; new callers should go there. Reserves a chunked upload of a file in the folder named by the path: the title comes from `fileName`, the declared payload size from `fileSize`, and the answer carries the session id every later call quotes, the address of the standalone chunk handler, the moment an idle session is dropped and the reserved byte count. No content is stored yet. Send the payload as multipart parts to `POST api/2.0/files/{folderId}/session/{sessionId}/upload`, keeping each part within `chunkUploadSize` from `GET api/2.0/files/settings`, then close the session with `PUT api/2.0/files/{folderId}/session/{sessionId}/finalize`. The caller needs the right to add content to the target folder, which room managers and content creators have and readers, editors and guests do not: they get 403, as does a section root such as Rooms or Archive, while an unknown folder is answered as missing. A payload above the portal limit for chunked uploads is refused before the session exists.
531
+ # See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/create-upload-session/
532
+ # @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.
533
+ # @param session_request [SessionRequest] The file the session is opened for, and how a clash with an existing name is settled.
534
+ # @param [Hash] opts the optional parameters
535
+ # @return [ChunkedUploadSessionResultWrapper, ThirdPartyChunkedUploadSessionResultWrapper]
536
+ def create_upload_session(folder_id, session_request, opts = {})
537
+ data, _status_code, _headers = create_upload_session_with_http_info(folder_id, session_request, opts)
538
+ data
539
+ end
540
+
541
+ # Chunked upload
542
+ # Deprecated in favour of `POST api/2.0/files/{folderId}/session`, which opens the same session and returns it without the success envelope used here; new callers should go there. Reserves a chunked upload of a file in the folder named by the path: the title comes from `fileName`, the declared payload size from `fileSize`, and the answer carries the session id every later call quotes, the address of the standalone chunk handler, the moment an idle session is dropped and the reserved byte count. No content is stored yet. Send the payload as multipart parts to `POST api/2.0/files/{folderId}/session/{sessionId}/upload`, keeping each part within `chunkUploadSize` from `GET api/2.0/files/settings`, then close the session with `PUT api/2.0/files/{folderId}/session/{sessionId}/finalize`. The caller needs the right to add content to the target folder, which room managers and content creators have and readers, editors and guests do not: they get 403, as does a section root such as Rooms or Archive, while an unknown folder is answered as missing. A payload above the portal limit for chunked uploads is refused before the session exists.
543
+ # See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/create-upload-session/
544
+ # @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.
545
+ # @param session_request [SessionRequest] The file the session is opened for, and how a clash with an existing name is settled.
546
+ # @param [Hash] opts the optional parameters
547
+ # @return [Array<(ChunkedUploadSessionResultWrapper, ThirdPartyChunkedUploadSessionResultWrapper, Integer, Hash)>] ChunkedUploadSessionResultWrapper, ThirdPartyChunkedUploadSessionResultWrapper data, response status code and response headers
548
+ def create_upload_session_with_http_info(folder_id, session_request, opts = {})
549
+ if @api_client.config.debugging
550
+ @api_client.config.logger.debug 'Calling API: Files::OperationsApi.create_upload_session ...'
551
+ end
552
+ # verify the required parameter 'folder_id' is set
553
+ if @api_client.config.client_side_validation && folder_id.nil?
554
+ fail ArgumentError, "Missing the required parameter 'folder_id' when calling Files::OperationsApi.create_upload_session"
555
+ end
556
+ # verify the required parameter 'session_request' is set
557
+ if @api_client.config.client_side_validation && session_request.nil?
558
+ fail ArgumentError, "Missing the required parameter 'session_request' when calling Files::OperationsApi.create_upload_session"
559
+ end
560
+ # resource path
561
+ local_var_path = '/api/2.0/files/{folderId}/upload/create_session'.sub('{' + 'folderId' + '}', CGI.escape(folder_id.to_s))
562
+
563
+ # query parameters
564
+ query_params = opts[:query_params] || {}
565
+
566
+ # header parameters
567
+ header_params = opts[:header_params] || {}
568
+ # HTTP header 'Accept' (if needed)
569
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
570
+ # HTTP header 'Content-Type'
571
+ content_type = @api_client.select_header_content_type(['application/json'])
572
+ if !content_type.nil?
573
+ header_params['Content-Type'] = content_type
574
+ end
575
+
576
+ # form parameters
577
+ form_params = opts[:form_params] || {}
578
+
579
+ # http body (model)
580
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(session_request)
581
+
582
+ # return_type
583
+ return_type = opts[:debug_return_type] || (folder_id.is_a?(String) ? 'ThirdPartyChunkedUploadSessionResultWrapper' : 'ChunkedUploadSessionResultWrapper')
584
+
585
+ # auth_names
586
+ auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
587
+
588
+ new_options = opts.merge(
589
+ :operation => :"Files::OperationsApi.create_upload_session",
590
+ :header_params => header_params,
591
+ :query_params => query_params,
592
+ :form_params => form_params,
593
+ :body => post_body,
594
+ :auth_names => auth_names,
595
+ :return_type => return_type
596
+ )
597
+
598
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
599
+ if @api_client.config.debugging
600
+ @api_client.config.logger.debug "API called: Files::OperationsApi#create_upload_session\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
601
+ end
602
+ return data, status_code, headers
603
+ end
604
+
605
+ # Create an upload session
606
+ # Opens a chunked upload session for a file in the folder named by the path and returns the session itself, which is the difference from the deprecated `POST api/2.0/files/{folderId}/upload/create_session` and its success envelope. The answer gives `id`, quoted by every later call, `location` for the standalone chunk handler used by clients that bypass this API, `expired`, and `bytes_total` echoing the reserved size. Whether parts are really needed follows from `fileSize`: below `chunkUploadSize` from `GET api/2.0/files/settings` the whole payload goes in one `POST api/2.0/files/{folderId}/session/{sessionId}`, which stores the file and answers 201, and above it the parts go one by one to `POST api/2.0/files/{folderId}/session/{sessionId}/upload` and the file appears only after `PUT api/2.0/files/{folderId}/session/{sessionId}/finalize`. The caller must be allowed to add content to the folder, so readers, editors and guests are refused, a section root is refused as well, and an unknown folder is answered as missing. Nothing is written until the parts arrive, and an abandoned session disappears twelve hours later.
607
+ # See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/create-upload-session-in-folder/
608
+ # @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.
609
+ # @param session_request [SessionRequest] The file the session is opened for, and how a clash with an existing name is settled.
610
+ # @param [Hash] opts the optional parameters
611
+ # @return [ChunkedUploadSessionWrapper, ThirdPartyChunkedUploadSessionWrapper]
612
+ def create_upload_session_in_folder(folder_id, session_request, opts = {})
613
+ data, _status_code, _headers = create_upload_session_in_folder_with_http_info(folder_id, session_request, opts)
614
+ data
615
+ end
616
+
617
+ # Create an upload session
618
+ # Opens a chunked upload session for a file in the folder named by the path and returns the session itself, which is the difference from the deprecated `POST api/2.0/files/{folderId}/upload/create_session` and its success envelope. The answer gives `id`, quoted by every later call, `location` for the standalone chunk handler used by clients that bypass this API, `expired`, and `bytes_total` echoing the reserved size. Whether parts are really needed follows from `fileSize`: below `chunkUploadSize` from `GET api/2.0/files/settings` the whole payload goes in one `POST api/2.0/files/{folderId}/session/{sessionId}`, which stores the file and answers 201, and above it the parts go one by one to `POST api/2.0/files/{folderId}/session/{sessionId}/upload` and the file appears only after `PUT api/2.0/files/{folderId}/session/{sessionId}/finalize`. The caller must be allowed to add content to the folder, so readers, editors and guests are refused, a section root is refused as well, and an unknown folder is answered as missing. Nothing is written until the parts arrive, and an abandoned session disappears twelve hours later.
619
+ # See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/create-upload-session-in-folder/
620
+ # @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.
621
+ # @param session_request [SessionRequest] The file the session is opened for, and how a clash with an existing name is settled.
622
+ # @param [Hash] opts the optional parameters
623
+ # @return [Array<(ChunkedUploadSessionWrapper, ThirdPartyChunkedUploadSessionWrapper, Integer, Hash)>] ChunkedUploadSessionWrapper, ThirdPartyChunkedUploadSessionWrapper data, response status code and response headers
624
+ def create_upload_session_in_folder_with_http_info(folder_id, session_request, opts = {})
625
+ if @api_client.config.debugging
626
+ @api_client.config.logger.debug 'Calling API: Files::OperationsApi.create_upload_session_in_folder ...'
627
+ end
628
+ # verify the required parameter 'folder_id' is set
629
+ if @api_client.config.client_side_validation && folder_id.nil?
630
+ fail ArgumentError, "Missing the required parameter 'folder_id' when calling Files::OperationsApi.create_upload_session_in_folder"
631
+ end
632
+ # verify the required parameter 'session_request' is set
633
+ if @api_client.config.client_side_validation && session_request.nil?
634
+ fail ArgumentError, "Missing the required parameter 'session_request' when calling Files::OperationsApi.create_upload_session_in_folder"
635
+ end
636
+ # resource path
637
+ local_var_path = '/api/2.0/files/{folderId}/session'.sub('{' + 'folderId' + '}', CGI.escape(folder_id.to_s))
638
+
639
+ # query parameters
640
+ query_params = opts[:query_params] || {}
641
+
642
+ # header parameters
643
+ header_params = opts[:header_params] || {}
644
+ # HTTP header 'Accept' (if needed)
645
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
646
+ # HTTP header 'Content-Type'
647
+ content_type = @api_client.select_header_content_type(['application/json'])
648
+ if !content_type.nil?
649
+ header_params['Content-Type'] = content_type
650
+ end
651
+
652
+ # form parameters
653
+ form_params = opts[:form_params] || {}
654
+
655
+ # http body (model)
656
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(session_request)
657
+
658
+ # return_type
659
+ return_type = opts[:debug_return_type] || (folder_id.is_a?(String) ? 'ThirdPartyChunkedUploadSessionWrapper' : 'ChunkedUploadSessionWrapper')
660
+
661
+ # auth_names
662
+ auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
663
+
664
+ new_options = opts.merge(
665
+ :operation => :"Files::OperationsApi.create_upload_session_in_folder",
666
+ :header_params => header_params,
667
+ :query_params => query_params,
668
+ :form_params => form_params,
669
+ :body => post_body,
670
+ :auth_names => auth_names,
671
+ :return_type => return_type
672
+ )
673
+
674
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
675
+ if @api_client.config.debugging
676
+ @api_client.config.logger.debug "API called: Files::OperationsApi#create_upload_session_in_folder\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
677
+ end
678
+ return data, status_code, headers
679
+ end
680
+
681
+ # Delete files and folders
682
+ # Queues a background job that deletes the requested files and folders, and answers with the caller's delete operations, including the one just started. Poll `GET api/2.0/files/fileops` until the operation reports `finished`, and read its `error`: a failure on a single item is reported there rather than as a status code. With `immediately=false` the items are moved to the caller's Trash and can be restored from it, while `immediately=true` removes them at once and for good; deleting a folder takes everything inside it either way. The call is destructive and it is not a no-op on repetition — a second call with the same ids deletes whatever has been restored in the meantime. Access is checked before the job is queued: deleting from a room requires room manager or content-creator rights, editing or read rights are refused with 403, and an id that resolves to nothing is answered as missing. An empty selection queues nothing and answers with the operations that are already there. To clear the Trash itself use `PUT api/2.0/files/fileops/emptytrash`.
683
+ # See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/delete-batch-items/
684
+ # @param [Hash] opts the optional parameters
685
+ # @option opts [DeleteBatchRequestDto] :delete_batch_request_dto
686
+ # @return [FileOperationArrayWrapper]
687
+ def delete_batch_items(opts = {})
688
+ data, _status_code, _headers = delete_batch_items_with_http_info(opts)
689
+ data
690
+ end
691
+
692
+ # Delete files and folders
693
+ # Queues a background job that deletes the requested files and folders, and answers with the caller's delete operations, including the one just started. Poll `GET api/2.0/files/fileops` until the operation reports `finished`, and read its `error`: a failure on a single item is reported there rather than as a status code. With `immediately=false` the items are moved to the caller's Trash and can be restored from it, while `immediately=true` removes them at once and for good; deleting a folder takes everything inside it either way. The call is destructive and it is not a no-op on repetition — a second call with the same ids deletes whatever has been restored in the meantime. Access is checked before the job is queued: deleting from a room requires room manager or content-creator rights, editing or read rights are refused with 403, and an id that resolves to nothing is answered as missing. An empty selection queues nothing and answers with the operations that are already there. To clear the Trash itself use `PUT api/2.0/files/fileops/emptytrash`.
694
+ # See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/delete-batch-items/
695
+ # @param [Hash] opts the optional parameters
696
+ # @option opts [DeleteBatchRequestDto] :delete_batch_request_dto
697
+ # @return [Array<(FileOperationArrayWrapper, Integer, Hash)>] FileOperationArrayWrapper data, response status code and response headers
698
+ def delete_batch_items_with_http_info(opts = {})
699
+ if @api_client.config.debugging
700
+ @api_client.config.logger.debug 'Calling API: Files::OperationsApi.delete_batch_items ...'
701
+ end
702
+ # resource path
703
+ local_var_path = '/api/2.0/files/fileops/delete'
704
+
705
+ # query parameters
706
+ query_params = opts[:query_params] || {}
707
+
708
+ # header parameters
709
+ header_params = opts[:header_params] || {}
710
+ # HTTP header 'Accept' (if needed)
711
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
712
+ # HTTP header 'Content-Type'
713
+ content_type = @api_client.select_header_content_type(['application/json'])
714
+ if !content_type.nil?
715
+ header_params['Content-Type'] = content_type
716
+ end
717
+
718
+ # form parameters
719
+ form_params = opts[:form_params] || {}
720
+
721
+ # http body (model)
722
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'delete_batch_request_dto'])
723
+
724
+ # return_type
725
+ return_type = opts[:debug_return_type] || 'FileOperationArrayWrapper'
726
+
727
+ # auth_names
728
+ auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
729
+
730
+ new_options = opts.merge(
731
+ :operation => :"Files::OperationsApi.delete_batch_items",
732
+ :header_params => header_params,
733
+ :query_params => query_params,
734
+ :form_params => form_params,
735
+ :body => post_body,
736
+ :auth_names => auth_names,
737
+ :return_type => return_type
738
+ )
739
+
740
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
741
+ if @api_client.config.debugging
742
+ @api_client.config.logger.debug "API called: Files::OperationsApi#delete_batch_items\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
743
+ end
744
+ return data, status_code, headers
745
+ end
746
+
747
+ # Delete favorite files and folders
748
+ # Removes the favorite mark from the listed files and folders for the calling account. Nothing is deleted from storage: the entries keep their place, their content and their sharing, and only disappear from `GET api/2.0/files/@favorites`; to delete the entries themselves call `PUT api/2.0/files/fileops/delete` instead. Marks of other members are untouched, and read access to each item is enough to call it. The ids go into the JSON body documented here; the same route also accepts them as repeated `fileIds` and `folderIds` query parameters, but only in a request that carries no JSON body at all. Numeric ids address entries stored in the portal itself, string ids entries on a connected third-party account. The answer is `true` whenever the request was understood, which an empty request, an id that does not exist and an item that was never marked all achieve, so it does not report how many marks were dropped. `returnSingleOperation` arrives with the shared body and does nothing here. Repeating the call is safe. Use `POST api/2.0/files/favorites` to mark entries again.
749
+ # See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/delete-favorites-from-body/
750
+ # @param [Hash] opts the optional parameters
751
+ # @option opts [BaseBatchRequestDto] :base_batch_request_dto
752
+ # @return [BooleanWrapper]
753
+ def delete_favorites_from_body(opts = {})
754
+ data, _status_code, _headers = delete_favorites_from_body_with_http_info(opts)
755
+ data
756
+ end
757
+
758
+ # Delete favorite files and folders
759
+ # Removes the favorite mark from the listed files and folders for the calling account. Nothing is deleted from storage: the entries keep their place, their content and their sharing, and only disappear from `GET api/2.0/files/@favorites`; to delete the entries themselves call `PUT api/2.0/files/fileops/delete` instead. Marks of other members are untouched, and read access to each item is enough to call it. The ids go into the JSON body documented here; the same route also accepts them as repeated `fileIds` and `folderIds` query parameters, but only in a request that carries no JSON body at all. Numeric ids address entries stored in the portal itself, string ids entries on a connected third-party account. The answer is `true` whenever the request was understood, which an empty request, an id that does not exist and an item that was never marked all achieve, so it does not report how many marks were dropped. `returnSingleOperation` arrives with the shared body and does nothing here. Repeating the call is safe. Use `POST api/2.0/files/favorites` to mark entries again.
760
+ # See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/delete-favorites-from-body/
761
+ # @param [Hash] opts the optional parameters
762
+ # @option opts [BaseBatchRequestDto] :base_batch_request_dto
763
+ # @return [Array<(BooleanWrapper, Integer, Hash)>] BooleanWrapper data, response status code and response headers
764
+ def delete_favorites_from_body_with_http_info(opts = {})
765
+ if @api_client.config.debugging
766
+ @api_client.config.logger.debug 'Calling API: Files::OperationsApi.delete_favorites_from_body ...'
767
+ end
768
+ # resource path
769
+ local_var_path = '/api/2.0/files/favorites'
770
+
771
+ # query parameters
772
+ query_params = opts[:query_params] || {}
773
+
774
+ # header parameters
775
+ header_params = opts[:header_params] || {}
776
+ # HTTP header 'Accept' (if needed)
777
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
778
+ # HTTP header 'Content-Type'
779
+ content_type = @api_client.select_header_content_type(['application/json'])
780
+ if !content_type.nil?
781
+ header_params['Content-Type'] = content_type
782
+ end
783
+
784
+ # form parameters
785
+ form_params = opts[:form_params] || {}
786
+
787
+ # http body (model)
788
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'base_batch_request_dto'])
789
+
790
+ # return_type
791
+ return_type = opts[:debug_return_type] || 'BooleanWrapper'
792
+
793
+ # auth_names
794
+ auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
795
+
796
+ new_options = opts.merge(
797
+ :operation => :"Files::OperationsApi.delete_favorites_from_body",
798
+ :header_params => header_params,
799
+ :query_params => query_params,
800
+ :form_params => form_params,
801
+ :body => post_body,
802
+ :auth_names => auth_names,
803
+ :return_type => return_type
804
+ )
805
+
806
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
807
+ if @api_client.config.debugging
808
+ @api_client.config.logger.debug "API called: Files::OperationsApi#delete_favorites_from_body\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
809
+ end
810
+ return data, status_code, headers
811
+ end
812
+
813
+ # Delete file versions
814
+ # Queues a background job that removes the listed versions from the history of one file, and answers with the caller's delete operations, including the one just started. Poll `GET api/2.0/files/fileops` until the operation reports `finished`; a failure met while the job runs is reported in its `error` rather than as a status code. Removal is permanent — deleted versions do not travel through Trash and cannot be restored, while the file itself stays in place with the versions that are left. Send the numbers that `GET api/2.0/files/file/{fileId}/history` reports, and send at least one: an empty list is not an empty request, it deletes the whole file instead. The number of the current version is refused before anything is queued, while numbers that no longer exist are passed over without a complaint. The caller needs the rights that deleting the file itself would need, so a member with read-only rights is refused, as are a file in an archived room and a file that is already in Trash, and a file that does not exist is answered as missing. To delete the file itself use `PUT api/2.0/files/fileops/delete`.
815
+ # See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/delete-file-versions/
816
+ # @param [Hash] opts the optional parameters
817
+ # @option opts [DeleteVersionBatchRequestDto] :delete_version_batch_request_dto
818
+ # @return [FileOperationArrayWrapper]
819
+ def delete_file_versions(opts = {})
820
+ data, _status_code, _headers = delete_file_versions_with_http_info(opts)
821
+ data
822
+ end
823
+
824
+ # Delete file versions
825
+ # Queues a background job that removes the listed versions from the history of one file, and answers with the caller's delete operations, including the one just started. Poll `GET api/2.0/files/fileops` until the operation reports `finished`; a failure met while the job runs is reported in its `error` rather than as a status code. Removal is permanent — deleted versions do not travel through Trash and cannot be restored, while the file itself stays in place with the versions that are left. Send the numbers that `GET api/2.0/files/file/{fileId}/history` reports, and send at least one: an empty list is not an empty request, it deletes the whole file instead. The number of the current version is refused before anything is queued, while numbers that no longer exist are passed over without a complaint. The caller needs the rights that deleting the file itself would need, so a member with read-only rights is refused, as are a file in an archived room and a file that is already in Trash, and a file that does not exist is answered as missing. To delete the file itself use `PUT api/2.0/files/fileops/delete`.
826
+ # See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/delete-file-versions/
827
+ # @param [Hash] opts the optional parameters
828
+ # @option opts [DeleteVersionBatchRequestDto] :delete_version_batch_request_dto
829
+ # @return [Array<(FileOperationArrayWrapper, Integer, Hash)>] FileOperationArrayWrapper data, response status code and response headers
830
+ def delete_file_versions_with_http_info(opts = {})
831
+ if @api_client.config.debugging
832
+ @api_client.config.logger.debug 'Calling API: Files::OperationsApi.delete_file_versions ...'
833
+ end
834
+ # resource path
835
+ local_var_path = '/api/2.0/files/fileops/deleteversion'
836
+
837
+ # query parameters
838
+ query_params = opts[:query_params] || {}
839
+
840
+ # header parameters
841
+ header_params = opts[:header_params] || {}
842
+ # HTTP header 'Accept' (if needed)
843
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
844
+ # HTTP header 'Content-Type'
845
+ content_type = @api_client.select_header_content_type(['application/json'])
846
+ if !content_type.nil?
847
+ header_params['Content-Type'] = content_type
848
+ end
849
+
850
+ # form parameters
851
+ form_params = opts[:form_params] || {}
852
+
853
+ # http body (model)
854
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'delete_version_batch_request_dto'])
855
+
856
+ # return_type
857
+ return_type = opts[:debug_return_type] || 'FileOperationArrayWrapper'
858
+
859
+ # auth_names
860
+ auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
861
+
862
+ new_options = opts.merge(
863
+ :operation => :"Files::OperationsApi.delete_file_versions",
864
+ :header_params => header_params,
865
+ :query_params => query_params,
866
+ :form_params => form_params,
867
+ :body => post_body,
868
+ :auth_names => auth_names,
869
+ :return_type => return_type
870
+ )
871
+
872
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
873
+ if @api_client.config.debugging
874
+ @api_client.config.logger.debug "API called: Files::OperationsApi#delete_file_versions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
875
+ end
876
+ return data, status_code, headers
877
+ end
878
+
879
+ # Duplicate files and folders
880
+ # Queues a background job that copies each requested file and folder next to itself, into the folder where it already is, and answers with the caller's duplicate operations, including the one just started. Poll `GET api/2.0/files/fileops` until the operation reports `finished`. The copies keep the name of the original with a numeric suffix, so nothing is overwritten and every repetition adds one more copy; duplicating a folder duplicates its content as well. No destination is taken — to place a copy somewhere else use `PUT api/2.0/files/fileops/copy`. The caller needs the rights that creating an item in that folder would need, which inside a room means room manager or content-creator rights: read or editing rights, and an item the caller has no access to at all, are refused with 403. An empty selection queues nothing and answers with the operations that are already there.
881
+ # See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/duplicate-batch-items/
882
+ # @param [Hash] opts the optional parameters
883
+ # @option opts [DuplicateRequestDto] :duplicate_request_dto
884
+ # @return [FileOperationArrayWrapper]
885
+ def duplicate_batch_items(opts = {})
886
+ data, _status_code, _headers = duplicate_batch_items_with_http_info(opts)
887
+ data
888
+ end
889
+
890
+ # Duplicate files and folders
891
+ # Queues a background job that copies each requested file and folder next to itself, into the folder where it already is, and answers with the caller's duplicate operations, including the one just started. Poll `GET api/2.0/files/fileops` until the operation reports `finished`. The copies keep the name of the original with a numeric suffix, so nothing is overwritten and every repetition adds one more copy; duplicating a folder duplicates its content as well. No destination is taken — to place a copy somewhere else use `PUT api/2.0/files/fileops/copy`. The caller needs the rights that creating an item in that folder would need, which inside a room means room manager or content-creator rights: read or editing rights, and an item the caller has no access to at all, are refused with 403. An empty selection queues nothing and answers with the operations that are already there.
892
+ # See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/duplicate-batch-items/
893
+ # @param [Hash] opts the optional parameters
894
+ # @option opts [DuplicateRequestDto] :duplicate_request_dto
895
+ # @return [Array<(FileOperationArrayWrapper, Integer, Hash)>] FileOperationArrayWrapper data, response status code and response headers
896
+ def duplicate_batch_items_with_http_info(opts = {})
897
+ if @api_client.config.debugging
898
+ @api_client.config.logger.debug 'Calling API: Files::OperationsApi.duplicate_batch_items ...'
899
+ end
900
+ # resource path
901
+ local_var_path = '/api/2.0/files/fileops/duplicate'
902
+
903
+ # query parameters
904
+ query_params = opts[:query_params] || {}
905
+
906
+ # header parameters
907
+ header_params = opts[:header_params] || {}
908
+ # HTTP header 'Accept' (if needed)
909
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
910
+ # HTTP header 'Content-Type'
911
+ content_type = @api_client.select_header_content_type(['application/json'])
912
+ if !content_type.nil?
913
+ header_params['Content-Type'] = content_type
914
+ end
915
+
916
+ # form parameters
917
+ form_params = opts[:form_params] || {}
918
+
919
+ # http body (model)
920
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'duplicate_request_dto'])
921
+
922
+ # return_type
923
+ return_type = opts[:debug_return_type] || 'FileOperationArrayWrapper'
924
+
925
+ # auth_names
926
+ auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
927
+
928
+ new_options = opts.merge(
929
+ :operation => :"Files::OperationsApi.duplicate_batch_items",
930
+ :header_params => header_params,
931
+ :query_params => query_params,
932
+ :form_params => form_params,
933
+ :body => post_body,
934
+ :auth_names => auth_names,
935
+ :return_type => return_type
936
+ )
937
+
938
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
939
+ if @api_client.config.debugging
940
+ @api_client.config.logger.debug "API called: Files::OperationsApi#duplicate_batch_items\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
941
+ end
942
+ return data, status_code, headers
943
+ end
944
+
945
+ # Empty the Trash folder
946
+ # Queues a background job that permanently removes the content of the caller's own Trash, and answers with the caller's delete operations, including the one just started. Poll `GET api/2.0/files/fileops` until the operation reports `finished`. Every authenticated account may empty its own Trash and only its own: no per-item access check takes place because nothing outside the caller's Trash is touched. With `folderType` the sweep is narrowed to the items that were originally stored in sections and rooms of the named types, so clearing what came from personal documents leaves what came from rooms untouched; without the parameter the whole Trash is emptied. What is removed here cannot be restored afterwards, which is the difference from `PUT api/2.0/files/fileops/delete`, where `immediately=false` puts items into Trash in the first place. Calling it on an already empty Trash queues nothing and answers with the operations that are already there.
947
+ # See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/empty-trash/
948
+ # @param [Hash] opts the optional parameters
949
+ # @option opts [Boolean] :single Which operations the answer carries: `true` returns the operation this call started and nothing else, `false` returns every delete operation that the caller has running or unread.
950
+ # @option opts [Array<Integer>] :folder_type Limits the sweep to the items whose original location was inside a section or a room of one of the named types, leaving the rest of the Trash untouched; without the parameter the whole Trash is emptied. `5` covers what was deleted from personal documents, `14` what was deleted from rooms.
951
+ # @return [FileOperationArrayWrapper]
952
+ def empty_trash(opts = {})
953
+ data, _status_code, _headers = empty_trash_with_http_info(opts)
954
+ data
955
+ end
956
+
957
+ # Empty the Trash folder
958
+ # Queues a background job that permanently removes the content of the caller's own Trash, and answers with the caller's delete operations, including the one just started. Poll `GET api/2.0/files/fileops` until the operation reports `finished`. Every authenticated account may empty its own Trash and only its own: no per-item access check takes place because nothing outside the caller's Trash is touched. With `folderType` the sweep is narrowed to the items that were originally stored in sections and rooms of the named types, so clearing what came from personal documents leaves what came from rooms untouched; without the parameter the whole Trash is emptied. What is removed here cannot be restored afterwards, which is the difference from `PUT api/2.0/files/fileops/delete`, where `immediately=false` puts items into Trash in the first place. Calling it on an already empty Trash queues nothing and answers with the operations that are already there.
959
+ # See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/empty-trash/
960
+ # @param [Hash] opts the optional parameters
961
+ # @option opts [Boolean] :single Which operations the answer carries: `true` returns the operation this call started and nothing else, `false` returns every delete operation that the caller has running or unread.
962
+ # @option opts [Array<Integer>] :folder_type Limits the sweep to the items whose original location was inside a section or a room of one of the named types, leaving the rest of the Trash untouched; without the parameter the whole Trash is emptied. `5` covers what was deleted from personal documents, `14` what was deleted from rooms.
963
+ # @return [Array<(FileOperationArrayWrapper, Integer, Hash)>] FileOperationArrayWrapper data, response status code and response headers
964
+ def empty_trash_with_http_info(opts = {})
965
+ if @api_client.config.debugging
966
+ @api_client.config.logger.debug 'Calling API: Files::OperationsApi.empty_trash ...'
967
+ end
968
+ 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]
969
+ if @api_client.config.client_side_validation && opts[:'folder_type'] && !opts[:'folder_type'].all? { |item| allowable_values.include?(item) }
970
+ fail ArgumentError, "invalid value for \"folder_type\", must include one of #{allowable_values}"
971
+ end
972
+ # resource path
973
+ local_var_path = '/api/2.0/files/fileops/emptytrash'
974
+
975
+ # query parameters
976
+ query_params = opts[:query_params] || {}
977
+ query_params[:'single'] = opts[:'single'] if !opts[:'single'].nil?
978
+ query_params[:'folderType'] = @api_client.build_collection_param(opts[:'folder_type'], :multi) if !opts[:'folder_type'].nil?
979
+
980
+ # header parameters
981
+ header_params = opts[:header_params] || {}
982
+ # HTTP header 'Accept' (if needed)
983
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
984
+
985
+ # form parameters
986
+ form_params = opts[:form_params] || {}
987
+
988
+ # http body (model)
989
+ post_body = opts[:debug_body]
990
+
991
+ # return_type
992
+ return_type = opts[:debug_return_type] || 'FileOperationArrayWrapper'
993
+
994
+ # auth_names
995
+ auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
996
+
997
+ new_options = opts.merge(
998
+ :operation => :"Files::OperationsApi.empty_trash",
999
+ :header_params => header_params,
1000
+ :query_params => query_params,
1001
+ :form_params => form_params,
1002
+ :body => post_body,
1003
+ :auth_names => auth_names,
1004
+ :return_type => return_type
1005
+ )
1006
+
1007
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
1008
+ if @api_client.config.debugging
1009
+ @api_client.config.logger.debug "API called: Files::OperationsApi#empty_trash\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1010
+ end
1011
+ return data, status_code, headers
1012
+ end
1013
+
1014
+ # Finalize an upload session
1015
+ # Assembles the parts received so far into the file the session was opened for and closes the session. What comes out depends on how the session started: one opened against an existing file through `POST api/2.0/files/file/{fileId}/edit_session` replaces that content in place and keeps the version number, while one opened against a folder either creates the file or, when a file of the same name was taken over, stores the content as its next version. A form loses its filling state on the way in. The answer arrives with 201 and carries the identifiers of the file together with the file itself. The call ends the session: the record and the buffered parts are removed, so it cannot be repeated and there is nothing left to abort afterwards. Running it before all the declared bytes have arrived assembles whatever is there, so read the progress from the chunk calls first. An unknown, already closed or expired session id fails instead of answering as missing.
1016
+ # See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/finalize-session/
1017
+ # @param folder_id [Integer, String] The folder the session was opened against. It is part of the route only and is not matched against the session, which is found by its own id.
1018
+ # @param session_id [String] The session to assemble, as returned in `id` when it was created: a 32-character hexadecimal string that identifies the session on its own.
1019
+ # @param [Hash] opts the optional parameters
1020
+ # @return [UploadSessionResponseWrapper, ThirdPartyUploadSessionResponseWrapper]
1021
+ def finalize_session(folder_id, session_id, opts = {})
1022
+ data, _status_code, _headers = finalize_session_with_http_info(folder_id, session_id, opts)
1023
+ data
1024
+ end
1025
+
1026
+ # Finalize an upload session
1027
+ # Assembles the parts received so far into the file the session was opened for and closes the session. What comes out depends on how the session started: one opened against an existing file through `POST api/2.0/files/file/{fileId}/edit_session` replaces that content in place and keeps the version number, while one opened against a folder either creates the file or, when a file of the same name was taken over, stores the content as its next version. A form loses its filling state on the way in. The answer arrives with 201 and carries the identifiers of the file together with the file itself. The call ends the session: the record and the buffered parts are removed, so it cannot be repeated and there is nothing left to abort afterwards. Running it before all the declared bytes have arrived assembles whatever is there, so read the progress from the chunk calls first. An unknown, already closed or expired session id fails instead of answering as missing.
1028
+ # See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/finalize-session/
1029
+ # @param folder_id [Integer, String] The folder the session was opened against. It is part of the route only and is not matched against the session, which is found by its own id.
1030
+ # @param session_id [String] The session to assemble, as returned in `id` when it was created: a 32-character hexadecimal string that identifies the session on its own.
1031
+ # @param [Hash] opts the optional parameters
1032
+ # @return [Array<(UploadSessionResponseWrapper, ThirdPartyUploadSessionResponseWrapper, Integer, Hash)>] UploadSessionResponseWrapper, ThirdPartyUploadSessionResponseWrapper data, response status code and response headers
1033
+ def finalize_session_with_http_info(folder_id, session_id, opts = {})
1034
+ if @api_client.config.debugging
1035
+ @api_client.config.logger.debug 'Calling API: Files::OperationsApi.finalize_session ...'
1036
+ end
1037
+ # verify the required parameter 'folder_id' is set
1038
+ if @api_client.config.client_side_validation && folder_id.nil?
1039
+ fail ArgumentError, "Missing the required parameter 'folder_id' when calling Files::OperationsApi.finalize_session"
1040
+ end
1041
+ # verify the required parameter 'session_id' is set
1042
+ if @api_client.config.client_side_validation && session_id.nil?
1043
+ fail ArgumentError, "Missing the required parameter 'session_id' when calling Files::OperationsApi.finalize_session"
1044
+ end
1045
+ # resource path
1046
+ local_var_path = '/api/2.0/files/{folderId}/session/{sessionId}/finalize'.sub('{' + 'folderId' + '}', CGI.escape(folder_id.to_s)).sub('{' + 'sessionId' + '}', CGI.escape(session_id.to_s))
1047
+
1048
+ # query parameters
1049
+ query_params = opts[:query_params] || {}
1050
+
1051
+ # header parameters
1052
+ header_params = opts[:header_params] || {}
1053
+ # HTTP header 'Accept' (if needed)
1054
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
1055
+
1056
+ # form parameters
1057
+ form_params = opts[:form_params] || {}
1058
+
1059
+ # http body (model)
1060
+ post_body = opts[:debug_body]
1061
+
1062
+ # return_type
1063
+ return_type = opts[:debug_return_type] || (folder_id.is_a?(String) ? 'ThirdPartyUploadSessionResponseWrapper' : 'UploadSessionResponseWrapper')
1064
+
1065
+ # auth_names
1066
+ auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
1067
+
1068
+ new_options = opts.merge(
1069
+ :operation => :"Files::OperationsApi.finalize_session",
1070
+ :header_params => header_params,
1071
+ :query_params => query_params,
1072
+ :form_params => form_params,
1073
+ :body => post_body,
1074
+ :auth_names => auth_names,
1075
+ :return_type => return_type
1076
+ )
1077
+
1078
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
1079
+ if @api_client.config.debugging
1080
+ @api_client.config.logger.debug "API called: Files::OperationsApi#finalize_session\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1081
+ end
1082
+ return data, status_code, headers
1083
+ end
1084
+
1085
+ # Get active file operations
1086
+ # Returns the background file operations of the caller that are still running or whose finished result has not been read yet, grouped by kind: duplications first, then moves and copies, deletions, downloads, mark-as-read and builder runs. This is the polling target for every operation in this section — an operation appears here as soon as it is queued and carries `progress` from 0 to 100, `finished`, the `error` of a failed item and, for a download, the address of the archive in `url`. A record is dropped once its finished state has been handed out, so a completed operation is reported once and an empty array means there is nothing left to report rather than that the work failed. Pass `id` to follow a single operation; an id that is not among the caller's operations gives an empty array. Operations are private to the account that started them, an anonymous caller being scoped to the session of the external link. The call changes nothing. To follow one kind only use `GET api/2.0/files/fileops/{operationType}`.
1087
+ # See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-operation-statuses/
1088
+ # @param [Hash] opts the optional parameters
1089
+ # @option opts [String] :id The operation to report on, as returned in `id` when it was started; without it every operation of the caller is reported. An id that is not among the caller's operations gives an empty answer rather than an error.
1090
+ # @return [FileOperationArrayWrapper]
1091
+ def get_operation_statuses(opts = {})
1092
+ data, _status_code, _headers = get_operation_statuses_with_http_info(opts)
1093
+ data
1094
+ end
1095
+
1096
+ # Get active file operations
1097
+ # Returns the background file operations of the caller that are still running or whose finished result has not been read yet, grouped by kind: duplications first, then moves and copies, deletions, downloads, mark-as-read and builder runs. This is the polling target for every operation in this section — an operation appears here as soon as it is queued and carries `progress` from 0 to 100, `finished`, the `error` of a failed item and, for a download, the address of the archive in `url`. A record is dropped once its finished state has been handed out, so a completed operation is reported once and an empty array means there is nothing left to report rather than that the work failed. Pass `id` to follow a single operation; an id that is not among the caller's operations gives an empty array. Operations are private to the account that started them, an anonymous caller being scoped to the session of the external link. The call changes nothing. To follow one kind only use `GET api/2.0/files/fileops/{operationType}`.
1098
+ # See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-operation-statuses/
1099
+ # @param [Hash] opts the optional parameters
1100
+ # @option opts [String] :id The operation to report on, as returned in `id` when it was started; without it every operation of the caller is reported. An id that is not among the caller's operations gives an empty answer rather than an error.
1101
+ # @return [Array<(FileOperationArrayWrapper, Integer, Hash)>] FileOperationArrayWrapper data, response status code and response headers
1102
+ def get_operation_statuses_with_http_info(opts = {})
1103
+ if @api_client.config.debugging
1104
+ @api_client.config.logger.debug 'Calling API: Files::OperationsApi.get_operation_statuses ...'
1105
+ end
1106
+ # resource path
1107
+ local_var_path = '/api/2.0/files/fileops'
1108
+
1109
+ # query parameters
1110
+ query_params = opts[:query_params] || {}
1111
+ query_params[:'id'] = opts[:'id'] if !opts[:'id'].nil?
1112
+
1113
+ # header parameters
1114
+ header_params = opts[:header_params] || {}
1115
+ # HTTP header 'Accept' (if needed)
1116
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
1117
+
1118
+ # form parameters
1119
+ form_params = opts[:form_params] || {}
1120
+
1121
+ # http body (model)
1122
+ post_body = opts[:debug_body]
1123
+
1124
+ # return_type
1125
+ return_type = opts[:debug_return_type] || 'FileOperationArrayWrapper'
1126
+
1127
+ # auth_names
1128
+ auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
1129
+
1130
+ new_options = opts.merge(
1131
+ :operation => :"Files::OperationsApi.get_operation_statuses",
1132
+ :header_params => header_params,
1133
+ :query_params => query_params,
1134
+ :form_params => form_params,
1135
+ :body => post_body,
1136
+ :auth_names => auth_names,
1137
+ :return_type => return_type
1138
+ )
1139
+
1140
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
1141
+ if @api_client.config.debugging
1142
+ @api_client.config.logger.debug "API called: Files::OperationsApi#get_operation_statuses\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1143
+ end
1144
+ return data, status_code, headers
1145
+ end
1146
+
1147
+ # Get file operations by type
1148
+ # Returns the background file operations of the caller that are of one kind, named by the number in the route: `1` for a copy, `2` for a deletion, `3` for a download, `4` for a mark-as-read, `7` for a duplication and `8` for a document builder run. The answer carries the same records as `GET api/2.0/files/fileops`, with the same rule that a finished operation is reported once and then dropped, and `id` narrows it further to a single operation. Moves, kind `0`, cannot be read through this route: the address `api/2.0/files/fileops/move` belongs to another operation, so read moves from `GET api/2.0/files/fileops` and pick the records whose `operation` is `0`. A kind that has no queue of its own — `5` for an import, `6` for a conversion — is accepted and answers with an empty array, while a number outside the operation type is rejected as an invalid request. The call changes nothing and never shows another account's operations.
1149
+ # See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-operation-statuses-by-type/
1150
+ # @param operation_type [FileOperationType] The kind of operation the answer is limited to. Only the kinds that have a queue of their own ever carry records — a copy, a deletion, a download, a mark-as-read and a duplication — and moves cannot be read through this route at all, because its address belongs to another operation.
1151
+ # @param [Hash] opts the optional parameters
1152
+ # @option opts [String] :id The operation to report on, as returned in `id` when it was started; without it every operation of the caller is reported. An id that is not among the caller's operations gives an empty answer rather than an error.
1153
+ # @return [FileOperationArrayWrapper]
1154
+ def get_operation_statuses_by_type(operation_type, opts = {})
1155
+ data, _status_code, _headers = get_operation_statuses_by_type_with_http_info(operation_type, opts)
1156
+ data
1157
+ end
1158
+
1159
+ # Get file operations by type
1160
+ # Returns the background file operations of the caller that are of one kind, named by the number in the route: `1` for a copy, `2` for a deletion, `3` for a download, `4` for a mark-as-read, `7` for a duplication and `8` for a document builder run. The answer carries the same records as `GET api/2.0/files/fileops`, with the same rule that a finished operation is reported once and then dropped, and `id` narrows it further to a single operation. Moves, kind `0`, cannot be read through this route: the address `api/2.0/files/fileops/move` belongs to another operation, so read moves from `GET api/2.0/files/fileops` and pick the records whose `operation` is `0`. A kind that has no queue of its own — `5` for an import, `6` for a conversion — is accepted and answers with an empty array, while a number outside the operation type is rejected as an invalid request. The call changes nothing and never shows another account's operations.
1161
+ # See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-operation-statuses-by-type/
1162
+ # @param operation_type [FileOperationType] The kind of operation the answer is limited to. Only the kinds that have a queue of their own ever carry records — a copy, a deletion, a download, a mark-as-read and a duplication — and moves cannot be read through this route at all, because its address belongs to another operation.
1163
+ # @param [Hash] opts the optional parameters
1164
+ # @option opts [String] :id The operation to report on, as returned in `id` when it was started; without it every operation of the caller is reported. An id that is not among the caller's operations gives an empty answer rather than an error.
1165
+ # @return [Array<(FileOperationArrayWrapper, Integer, Hash)>] FileOperationArrayWrapper data, response status code and response headers
1166
+ def get_operation_statuses_by_type_with_http_info(operation_type, opts = {})
1167
+ if @api_client.config.debugging
1168
+ @api_client.config.logger.debug 'Calling API: Files::OperationsApi.get_operation_statuses_by_type ...'
1169
+ end
1170
+ # verify the required parameter 'operation_type' is set
1171
+ if @api_client.config.client_side_validation && operation_type.nil?
1172
+ fail ArgumentError, "Missing the required parameter 'operation_type' when calling Files::OperationsApi.get_operation_statuses_by_type"
1173
+ end
1174
+ # resource path
1175
+ local_var_path = '/api/2.0/files/fileops/{operationType}'.sub('{' + 'operationType' + '}', CGI.escape(operation_type.to_s))
1176
+
1177
+ # query parameters
1178
+ query_params = opts[:query_params] || {}
1179
+ query_params[:'id'] = opts[:'id'] if !opts[:'id'].nil?
1180
+
1181
+ # header parameters
1182
+ header_params = opts[:header_params] || {}
1183
+ # HTTP header 'Accept' (if needed)
1184
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
1185
+
1186
+ # form parameters
1187
+ form_params = opts[:form_params] || {}
1188
+
1189
+ # http body (model)
1190
+ post_body = opts[:debug_body]
1191
+
1192
+ # return_type
1193
+ return_type = opts[:debug_return_type] || 'FileOperationArrayWrapper'
1194
+
1195
+ # auth_names
1196
+ auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
1197
+
1198
+ new_options = opts.merge(
1199
+ :operation => :"Files::OperationsApi.get_operation_statuses_by_type",
1200
+ :header_params => header_params,
1201
+ :query_params => query_params,
1202
+ :form_params => form_params,
1203
+ :body => post_body,
1204
+ :auth_names => auth_names,
1205
+ :return_type => return_type
1206
+ )
1207
+
1208
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
1209
+ if @api_client.config.debugging
1210
+ @api_client.config.logger.debug "API called: Files::OperationsApi#get_operation_statuses_by_type\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1211
+ end
1212
+ return data, status_code, headers
1213
+ end
1214
+
1215
+ # Mark files and folders as read
1216
+ # Queues a background job that clears the new-item badge from the requested files and folders for the calling account, and answers with the caller's mark-as-read operations, including the one just started. Poll `GET api/2.0/files/fileops` until the operation reports `finished`. Marking a folder clears the badges of everything inside it as well. Items the caller cannot read are passed over in silence rather than refused, so the call succeeds even when the whole selection is inaccessible, and an empty selection queues nothing and answers with the operations that are already there. Repeating the call on items that are already read changes nothing, and nothing is opened, moved or modified by it — only the caller's own badges are affected, while other members keep theirs. To see what is currently marked as new use `GET api/2.0/files/{folderId}/news` for one folder and `GET api/2.0/files/rooms/news` for the rooms of the caller.
1217
+ # See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/mark-as-read/
1218
+ # @param [Hash] opts the optional parameters
1219
+ # @option opts [BaseBatchRequestDto] :base_batch_request_dto
1220
+ # @return [FileOperationArrayWrapper]
1221
+ def mark_as_read(opts = {})
1222
+ data, _status_code, _headers = mark_as_read_with_http_info(opts)
1223
+ data
1224
+ end
1225
+
1226
+ # Mark files and folders as read
1227
+ # Queues a background job that clears the new-item badge from the requested files and folders for the calling account, and answers with the caller's mark-as-read operations, including the one just started. Poll `GET api/2.0/files/fileops` until the operation reports `finished`. Marking a folder clears the badges of everything inside it as well. Items the caller cannot read are passed over in silence rather than refused, so the call succeeds even when the whole selection is inaccessible, and an empty selection queues nothing and answers with the operations that are already there. Repeating the call on items that are already read changes nothing, and nothing is opened, moved or modified by it — only the caller's own badges are affected, while other members keep theirs. To see what is currently marked as new use `GET api/2.0/files/{folderId}/news` for one folder and `GET api/2.0/files/rooms/news` for the rooms of the caller.
1228
+ # See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/mark-as-read/
1229
+ # @param [Hash] opts the optional parameters
1230
+ # @option opts [BaseBatchRequestDto] :base_batch_request_dto
1231
+ # @return [Array<(FileOperationArrayWrapper, Integer, Hash)>] FileOperationArrayWrapper data, response status code and response headers
1232
+ def mark_as_read_with_http_info(opts = {})
1233
+ if @api_client.config.debugging
1234
+ @api_client.config.logger.debug 'Calling API: Files::OperationsApi.mark_as_read ...'
1235
+ end
1236
+ # resource path
1237
+ local_var_path = '/api/2.0/files/fileops/markasread'
1238
+
1239
+ # query parameters
1240
+ query_params = opts[:query_params] || {}
1241
+
1242
+ # header parameters
1243
+ header_params = opts[:header_params] || {}
1244
+ # HTTP header 'Accept' (if needed)
1245
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
1246
+ # HTTP header 'Content-Type'
1247
+ content_type = @api_client.select_header_content_type(['application/json'])
1248
+ if !content_type.nil?
1249
+ header_params['Content-Type'] = content_type
1250
+ end
1251
+
1252
+ # form parameters
1253
+ form_params = opts[:form_params] || {}
1254
+
1255
+ # http body (model)
1256
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'base_batch_request_dto'])
1257
+
1258
+ # return_type
1259
+ return_type = opts[:debug_return_type] || 'FileOperationArrayWrapper'
1260
+
1261
+ # auth_names
1262
+ auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
1263
+
1264
+ new_options = opts.merge(
1265
+ :operation => :"Files::OperationsApi.mark_as_read",
1266
+ :header_params => header_params,
1267
+ :query_params => query_params,
1268
+ :form_params => form_params,
1269
+ :body => post_body,
1270
+ :auth_names => auth_names,
1271
+ :return_type => return_type
1272
+ )
1273
+
1274
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
1275
+ if @api_client.config.debugging
1276
+ @api_client.config.logger.debug "API called: Files::OperationsApi#mark_as_read\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1277
+ end
1278
+ return data, status_code, headers
1279
+ end
1280
+
1281
+ # Move files and folders
1282
+ # Queues a background job that moves the requested files and folders into `destFolderId`, removing them from where they were, and answers with the caller's move and copy operations, including the one just started. Poll `GET api/2.0/files/fileops` until the operation reports `finished`. Before starting, `GET api/2.0/files/fileops/move` reports which items already have a same-named entry at the destination and `conflictResolveType` decides what happens to them, while `GET api/2.0/files/fileops/checkdestfolder` reports whether the destination accepts the files at all. The caller needs create access to the destination and the right to take the items out of their source, which is why room members with editing or review rights are refused with 403, and why content-creator rights inside a room allow copying an item out of it but not moving it. A room cannot be moved this way — use `PUT api/2.0/files/rooms/{id}/archive` instead. To keep the originals use `PUT api/2.0/files/fileops/copy`. An empty selection queues nothing.
1283
+ # See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/move-batch-items/
1284
+ # @param [Hash] opts the optional parameters
1285
+ # @option opts [BatchRequestDto] :batch_request_dto
1286
+ # @return [FileOperationArrayWrapper]
1287
+ def move_batch_items(opts = {})
1288
+ data, _status_code, _headers = move_batch_items_with_http_info(opts)
1289
+ data
1290
+ end
1291
+
1292
+ # Move files and folders
1293
+ # Queues a background job that moves the requested files and folders into `destFolderId`, removing them from where they were, and answers with the caller's move and copy operations, including the one just started. Poll `GET api/2.0/files/fileops` until the operation reports `finished`. Before starting, `GET api/2.0/files/fileops/move` reports which items already have a same-named entry at the destination and `conflictResolveType` decides what happens to them, while `GET api/2.0/files/fileops/checkdestfolder` reports whether the destination accepts the files at all. The caller needs create access to the destination and the right to take the items out of their source, which is why room members with editing or review rights are refused with 403, and why content-creator rights inside a room allow copying an item out of it but not moving it. A room cannot be moved this way — use `PUT api/2.0/files/rooms/{id}/archive` instead. To keep the originals use `PUT api/2.0/files/fileops/copy`. An empty selection queues nothing.
1294
+ # See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/move-batch-items/
1295
+ # @param [Hash] opts the optional parameters
1296
+ # @option opts [BatchRequestDto] :batch_request_dto
1297
+ # @return [Array<(FileOperationArrayWrapper, Integer, Hash)>] FileOperationArrayWrapper data, response status code and response headers
1298
+ def move_batch_items_with_http_info(opts = {})
1299
+ if @api_client.config.debugging
1300
+ @api_client.config.logger.debug 'Calling API: Files::OperationsApi.move_batch_items ...'
1301
+ end
1302
+ # resource path
1303
+ local_var_path = '/api/2.0/files/fileops/move'
1304
+
1305
+ # query parameters
1306
+ query_params = opts[:query_params] || {}
1307
+
1308
+ # header parameters
1309
+ header_params = opts[:header_params] || {}
1310
+ # HTTP header 'Accept' (if needed)
1311
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
1312
+ # HTTP header 'Content-Type'
1313
+ content_type = @api_client.select_header_content_type(['application/json'])
1314
+ if !content_type.nil?
1315
+ header_params['Content-Type'] = content_type
1316
+ end
1317
+
1318
+ # form parameters
1319
+ form_params = opts[:form_params] || {}
1320
+
1321
+ # http body (model)
1322
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'batch_request_dto'])
1323
+
1324
+ # return_type
1325
+ return_type = opts[:debug_return_type] || 'FileOperationArrayWrapper'
1326
+
1327
+ # auth_names
1328
+ auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
1329
+
1330
+ new_options = opts.merge(
1331
+ :operation => :"Files::OperationsApi.move_batch_items",
1332
+ :header_params => header_params,
1333
+ :query_params => query_params,
1334
+ :form_params => form_params,
1335
+ :body => post_body,
1336
+ :auth_names => auth_names,
1337
+ :return_type => return_type
1338
+ )
1339
+
1340
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
1341
+ if @api_client.config.debugging
1342
+ @api_client.config.logger.debug "API called: Files::OperationsApi#move_batch_items\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1343
+ end
1344
+ return data, status_code, headers
1345
+ end
1346
+
1347
+ # Start file conversion
1348
+ # Queues the conversion of a file into the portal's own editable format and answers with the conversion entry the caller is to poll. The whole body may be omitted, in which case the defaults apply. `outputType` names the target format and, left empty, the portal's default for that kind of document is used; `password` unlocks a protected source file; `version` converts an older version instead of the current one. `createNewIfExist` decides where the result goes: with `true` a new file is created beside the source, while with `false`, the default, the converted file that already exists is replaced. `sync=true` converts inside the request and answers with the finished result instead of a queue entry, which is only sensible for small documents. Otherwise poll `GET api/2.0/files/file/{fileId}/checkconversion` until `progress` reaches 100 and take the converted file from `file`. Only formats the portal has to convert are accepted; anything already editable, and anything it cannot convert, is answered without work being queued or rejected as an invalid request. The caller needs read access to the file. The call is mutating and not idempotent.
1349
+ # See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/start-file-conversion/
1350
+ # @param file_id [Integer, String] The file to convert.
1351
+ # @param [Hash] opts the optional parameters
1352
+ # @option opts [CheckConversionRequestDto, ThirdPartyCheckConversionRequestDto] :check_conversion_request_dto The parameters of the conversion. The whole body may be omitted, in which case the defaults of the portal apply.
1353
+ # @return [ConversationResultArrayWrapper]
1354
+ def start_file_conversion(file_id, opts = {})
1355
+ data, _status_code, _headers = start_file_conversion_with_http_info(file_id, opts)
1356
+ data
1357
+ end
1358
+
1359
+ # Start file conversion
1360
+ # Queues the conversion of a file into the portal's own editable format and answers with the conversion entry the caller is to poll. The whole body may be omitted, in which case the defaults apply. `outputType` names the target format and, left empty, the portal's default for that kind of document is used; `password` unlocks a protected source file; `version` converts an older version instead of the current one. `createNewIfExist` decides where the result goes: with `true` a new file is created beside the source, while with `false`, the default, the converted file that already exists is replaced. `sync=true` converts inside the request and answers with the finished result instead of a queue entry, which is only sensible for small documents. Otherwise poll `GET api/2.0/files/file/{fileId}/checkconversion` until `progress` reaches 100 and take the converted file from `file`. Only formats the portal has to convert are accepted; anything already editable, and anything it cannot convert, is answered without work being queued or rejected as an invalid request. The caller needs read access to the file. The call is mutating and not idempotent.
1361
+ # See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/start-file-conversion/
1362
+ # @param file_id [Integer, String] The file to convert.
1363
+ # @param [Hash] opts the optional parameters
1364
+ # @option opts [CheckConversionRequestDto, ThirdPartyCheckConversionRequestDto] :check_conversion_request_dto The parameters of the conversion. The whole body may be omitted, in which case the defaults of the portal apply.
1365
+ # @return [Array<(ConversationResultArrayWrapper, Integer, Hash)>] ConversationResultArrayWrapper data, response status code and response headers
1366
+ def start_file_conversion_with_http_info(file_id, opts = {})
1367
+ if @api_client.config.debugging
1368
+ @api_client.config.logger.debug 'Calling API: Files::OperationsApi.start_file_conversion ...'
1369
+ end
1370
+ # verify the required parameter 'file_id' is set
1371
+ if @api_client.config.client_side_validation && file_id.nil?
1372
+ fail ArgumentError, "Missing the required parameter 'file_id' when calling Files::OperationsApi.start_file_conversion"
1373
+ end
1374
+ # resource path
1375
+ local_var_path = '/api/2.0/files/file/{fileId}/checkconversion'.sub('{' + 'fileId' + '}', CGI.escape(file_id.to_s))
1376
+
1377
+ # query parameters
1378
+ query_params = opts[:query_params] || {}
1379
+
1380
+ # header parameters
1381
+ header_params = opts[:header_params] || {}
1382
+ # HTTP header 'Accept' (if needed)
1383
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
1384
+ # HTTP header 'Content-Type'
1385
+ content_type = @api_client.select_header_content_type(['application/json'])
1386
+ if !content_type.nil?
1387
+ header_params['Content-Type'] = content_type
1388
+ end
1389
+
1390
+ # form parameters
1391
+ form_params = opts[:form_params] || {}
1392
+
1393
+ # http body (model)
1394
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'check_conversion_request_dto'])
1395
+
1396
+ # return_type
1397
+ return_type = opts[:debug_return_type] || 'ConversationResultArrayWrapper'
1398
+
1399
+ # auth_names
1400
+ auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
1401
+
1402
+ new_options = opts.merge(
1403
+ :operation => :"Files::OperationsApi.start_file_conversion",
1404
+ :header_params => header_params,
1405
+ :query_params => query_params,
1406
+ :form_params => form_params,
1407
+ :body => post_body,
1408
+ :auth_names => auth_names,
1409
+ :return_type => return_type
1410
+ )
1411
+
1412
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
1413
+ if @api_client.config.debugging
1414
+ @api_client.config.logger.debug "API called: Files::OperationsApi#start_file_conversion\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1415
+ end
1416
+ return data, status_code, headers
1417
+ end
1418
+
1419
+ # Cancel file operations
1420
+ # Cancels a background file operation of the caller and answers with the operations that are left. Pass the `id` that was reported when the operation started to stop that one; a call that leaves the trailing route segment out stops every operation the caller has running, of every kind. Cancelling stops the job where it stands and does not undo it: what has already been copied, moved or deleted stays that way, so a cancelled batch can leave part of itself at the destination and part of it at the source, and the result has to be read back rather than assumed. The cancelled record is dropped from `GET api/2.0/files/fileops` at once, which is why the answer here is usually empty. An id that is not among the caller's operations cancels nothing and is not an error. Operations are private to the account that started them, an anonymous caller being scoped to the session of the external link, so the call can never reach an operation of anyone else.
1421
+ # See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/terminate-tasks/
1422
+ # @param id [String] The operation to cancel, as returned in `id` when it was started. A call that leaves the route segment out cancels every operation of the caller, and an id that is not among their operations cancels nothing without being an error.
1423
+ # @param [Hash] opts the optional parameters
1424
+ # @return [FileOperationArrayWrapper]
1425
+ def terminate_tasks(id, opts = {})
1426
+ data, _status_code, _headers = terminate_tasks_with_http_info(id, opts)
1427
+ data
1428
+ end
1429
+
1430
+ # Cancel file operations
1431
+ # Cancels a background file operation of the caller and answers with the operations that are left. Pass the `id` that was reported when the operation started to stop that one; a call that leaves the trailing route segment out stops every operation the caller has running, of every kind. Cancelling stops the job where it stands and does not undo it: what has already been copied, moved or deleted stays that way, so a cancelled batch can leave part of itself at the destination and part of it at the source, and the result has to be read back rather than assumed. The cancelled record is dropped from `GET api/2.0/files/fileops` at once, which is why the answer here is usually empty. An id that is not among the caller's operations cancels nothing and is not an error. Operations are private to the account that started them, an anonymous caller being scoped to the session of the external link, so the call can never reach an operation of anyone else.
1432
+ # See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/terminate-tasks/
1433
+ # @param id [String] The operation to cancel, as returned in `id` when it was started. A call that leaves the route segment out cancels every operation of the caller, and an id that is not among their operations cancels nothing without being an error.
1434
+ # @param [Hash] opts the optional parameters
1435
+ # @return [Array<(FileOperationArrayWrapper, Integer, Hash)>] FileOperationArrayWrapper data, response status code and response headers
1436
+ def terminate_tasks_with_http_info(id, opts = {})
1437
+ if @api_client.config.debugging
1438
+ @api_client.config.logger.debug 'Calling API: Files::OperationsApi.terminate_tasks ...'
1439
+ end
1440
+ # verify the required parameter 'id' is set
1441
+ if @api_client.config.client_side_validation && id.nil?
1442
+ fail ArgumentError, "Missing the required parameter 'id' when calling Files::OperationsApi.terminate_tasks"
1443
+ end
1444
+ # resource path
1445
+ local_var_path = '/api/2.0/files/fileops/terminate/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
1446
+
1447
+ # query parameters
1448
+ query_params = opts[:query_params] || {}
1449
+
1450
+ # header parameters
1451
+ header_params = opts[:header_params] || {}
1452
+ # HTTP header 'Accept' (if needed)
1453
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
1454
+
1455
+ # form parameters
1456
+ form_params = opts[:form_params] || {}
1457
+
1458
+ # http body (model)
1459
+ post_body = opts[:debug_body]
1460
+
1461
+ # return_type
1462
+ return_type = opts[:debug_return_type] || 'FileOperationArrayWrapper'
1463
+
1464
+ # auth_names
1465
+ auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
1466
+
1467
+ new_options = opts.merge(
1468
+ :operation => :"Files::OperationsApi.terminate_tasks",
1469
+ :header_params => header_params,
1470
+ :query_params => query_params,
1471
+ :form_params => form_params,
1472
+ :body => post_body,
1473
+ :auth_names => auth_names,
1474
+ :return_type => return_type
1475
+ )
1476
+
1477
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
1478
+ if @api_client.config.debugging
1479
+ @api_client.config.logger.debug "API called: Files::OperationsApi#terminate_tasks\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1480
+ end
1481
+ return data, status_code, headers
1482
+ end
1483
+
1484
+ # Update a comment
1485
+ # Replaces the comment stored on one version of a file - the note that explains what changed in it - and answers with the comment as it was stored, which is the text cut to the length the portal keeps. `version` names the version and has to be an existing one: a version that does not exist is rejected as an invalid request, while a file that does not exist at all is answered as not found. Sending an empty comment clears the note. The caller needs the right to edit the history of the file, which the room admin, a DocSpace admin acting as room manager and a member with content-creator rights have; a member with editing access to somebody else's file, read-only access, a guest and an anonymous caller are all refused. A file that is locked by somebody else or lies in Trash is refused as well. The call is mutating and idempotent - repeating it with the same text leaves the same comment. The comments of all versions come back with `GET api/2.0/files/file/{fileId}/edit/history`.
1486
+ # See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/update-file-comment/
1487
+ # @param file_id [Integer, String] The file whose version comment is replaced.
1488
+ # @param update_comment_request [UpdateCommentRequest] The version and the comment to store on it.
1489
+ # @param [Hash] opts the optional parameters
1490
+ # @return [StringWrapper]
1491
+ def update_file_comment(file_id, update_comment_request, opts = {})
1492
+ data, _status_code, _headers = update_file_comment_with_http_info(file_id, update_comment_request, opts)
1493
+ data
1494
+ end
1495
+
1496
+ # Update a comment
1497
+ # Replaces the comment stored on one version of a file - the note that explains what changed in it - and answers with the comment as it was stored, which is the text cut to the length the portal keeps. `version` names the version and has to be an existing one: a version that does not exist is rejected as an invalid request, while a file that does not exist at all is answered as not found. Sending an empty comment clears the note. The caller needs the right to edit the history of the file, which the room admin, a DocSpace admin acting as room manager and a member with content-creator rights have; a member with editing access to somebody else's file, read-only access, a guest and an anonymous caller are all refused. A file that is locked by somebody else or lies in Trash is refused as well. The call is mutating and idempotent - repeating it with the same text leaves the same comment. The comments of all versions come back with `GET api/2.0/files/file/{fileId}/edit/history`.
1498
+ # See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/update-file-comment/
1499
+ # @param file_id [Integer, String] The file whose version comment is replaced.
1500
+ # @param update_comment_request [UpdateCommentRequest] The version and the comment to store on it.
1501
+ # @param [Hash] opts the optional parameters
1502
+ # @return [Array<(StringWrapper, Integer, Hash)>] StringWrapper data, response status code and response headers
1503
+ def update_file_comment_with_http_info(file_id, update_comment_request, opts = {})
1504
+ if @api_client.config.debugging
1505
+ @api_client.config.logger.debug 'Calling API: Files::OperationsApi.update_file_comment ...'
1506
+ end
1507
+ # verify the required parameter 'file_id' is set
1508
+ if @api_client.config.client_side_validation && file_id.nil?
1509
+ fail ArgumentError, "Missing the required parameter 'file_id' when calling Files::OperationsApi.update_file_comment"
1510
+ end
1511
+ # verify the required parameter 'update_comment_request' is set
1512
+ if @api_client.config.client_side_validation && update_comment_request.nil?
1513
+ fail ArgumentError, "Missing the required parameter 'update_comment_request' when calling Files::OperationsApi.update_file_comment"
1514
+ end
1515
+ # resource path
1516
+ local_var_path = '/api/2.0/files/file/{fileId}/comment'.sub('{' + 'fileId' + '}', CGI.escape(file_id.to_s))
1517
+
1518
+ # query parameters
1519
+ query_params = opts[:query_params] || {}
1520
+
1521
+ # header parameters
1522
+ header_params = opts[:header_params] || {}
1523
+ # HTTP header 'Accept' (if needed)
1524
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
1525
+ # HTTP header 'Content-Type'
1526
+ content_type = @api_client.select_header_content_type(['application/json'])
1527
+ if !content_type.nil?
1528
+ header_params['Content-Type'] = content_type
1529
+ end
1530
+
1531
+ # form parameters
1532
+ form_params = opts[:form_params] || {}
1533
+
1534
+ # http body (model)
1535
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(update_comment_request)
1536
+
1537
+ # return_type
1538
+ return_type = opts[:debug_return_type] || 'StringWrapper'
1539
+
1540
+ # auth_names
1541
+ auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
1542
+
1543
+ new_options = opts.merge(
1544
+ :operation => :"Files::OperationsApi.update_file_comment",
1545
+ :header_params => header_params,
1546
+ :query_params => query_params,
1547
+ :form_params => form_params,
1548
+ :body => post_body,
1549
+ :auth_names => auth_names,
1550
+ :return_type => return_type
1551
+ )
1552
+
1553
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
1554
+ if @api_client.config.debugging
1555
+ @api_client.config.logger.debug "API called: Files::OperationsApi#update_file_comment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1556
+ end
1557
+ return data, status_code, headers
1558
+ end
1559
+
1560
+ # Upload a numbered chunk
1561
+ # Stores one part of a file under the number given in `chunkNumber`, which is what the ordinary chunked flow uses: parts are kept by their number rather than by arrival, so a part that failed can be resent under the same number without restarting the session. Numbering starts at 1, and leaving the number out makes the server count the parts itself. The answer is always the session, never the file, and this call never completes the upload: the file appears only after `PUT api/2.0/files/{folderId}/session/{sessionId}/finalize`. Use `POST api/2.0/files/{folderId}/session/{sessionId}` instead when the parts go strictly in order and the upload should complete by itself. A part bigger than `chunkUploadSize` from `GET api/2.0/files/settings` is refused, so that value is also the size to split the payload by. The first part of a PDF is inspected, and a PDF that is not a fillable form is refused when the session targets a form-filling room. The session is found by its id alone.
1562
+ # See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/upload-async-session/
1563
+ # @param folder_id [Integer, String] The folder the session was opened against. It is part of the route only and is not matched against the session, which is found by its own id.
1564
+ # @param session_id [String] The session this part belongs to, as returned in `id` when it was created; a 32-character hexadecimal string.
1565
+ # @param [Hash] opts the optional parameters
1566
+ # @option opts [Integer] :chunk_number The position of this part in the file, counted from 1. Sending the same number again replaces that part instead of adding one, which is how a failed part is retried; leaving the number out makes the server count the parts itself.
1567
+ # @option opts [File] :file The part of the file to store, sent as the multipart field of the same name. It is kept under the number given beside it, and a part larger than the portal chunk size is refused.
1568
+ # @return [ChunkedUploadSessionWrapper, ThirdPartyChunkedUploadSessionWrapper]
1569
+ def upload_async_session(folder_id, session_id, opts = {})
1570
+ data, _status_code, _headers = upload_async_session_with_http_info(folder_id, session_id, opts)
1571
+ data
1572
+ end
1573
+
1574
+ # Upload a numbered chunk
1575
+ # Stores one part of a file under the number given in `chunkNumber`, which is what the ordinary chunked flow uses: parts are kept by their number rather than by arrival, so a part that failed can be resent under the same number without restarting the session. Numbering starts at 1, and leaving the number out makes the server count the parts itself. The answer is always the session, never the file, and this call never completes the upload: the file appears only after `PUT api/2.0/files/{folderId}/session/{sessionId}/finalize`. Use `POST api/2.0/files/{folderId}/session/{sessionId}` instead when the parts go strictly in order and the upload should complete by itself. A part bigger than `chunkUploadSize` from `GET api/2.0/files/settings` is refused, so that value is also the size to split the payload by. The first part of a PDF is inspected, and a PDF that is not a fillable form is refused when the session targets a form-filling room. The session is found by its id alone.
1576
+ # See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/upload-async-session/
1577
+ # @param folder_id [Integer, String] The folder the session was opened against. It is part of the route only and is not matched against the session, which is found by its own id.
1578
+ # @param session_id [String] The session this part belongs to, as returned in `id` when it was created; a 32-character hexadecimal string.
1579
+ # @param [Hash] opts the optional parameters
1580
+ # @option opts [Integer] :chunk_number The position of this part in the file, counted from 1. Sending the same number again replaces that part instead of adding one, which is how a failed part is retried; leaving the number out makes the server count the parts itself.
1581
+ # @option opts [File] :file The part of the file to store, sent as the multipart field of the same name. It is kept under the number given beside it, and a part larger than the portal chunk size is refused.
1582
+ # @return [Array<(ChunkedUploadSessionWrapper, ThirdPartyChunkedUploadSessionWrapper, Integer, Hash)>] ChunkedUploadSessionWrapper, ThirdPartyChunkedUploadSessionWrapper data, response status code and response headers
1583
+ def upload_async_session_with_http_info(folder_id, session_id, opts = {})
1584
+ if @api_client.config.debugging
1585
+ @api_client.config.logger.debug 'Calling API: Files::OperationsApi.upload_async_session ...'
1586
+ end
1587
+ # verify the required parameter 'folder_id' is set
1588
+ if @api_client.config.client_side_validation && folder_id.nil?
1589
+ fail ArgumentError, "Missing the required parameter 'folder_id' when calling Files::OperationsApi.upload_async_session"
1590
+ end
1591
+ # verify the required parameter 'session_id' is set
1592
+ if @api_client.config.client_side_validation && session_id.nil?
1593
+ fail ArgumentError, "Missing the required parameter 'session_id' when calling Files::OperationsApi.upload_async_session"
1594
+ end
1595
+ # resource path
1596
+ local_var_path = '/api/2.0/files/{folderId}/session/{sessionId}/upload'.sub('{' + 'folderId' + '}', CGI.escape(folder_id.to_s)).sub('{' + 'sessionId' + '}', CGI.escape(session_id.to_s))
1597
+
1598
+ # query parameters
1599
+ query_params = opts[:query_params] || {}
1600
+ query_params[:'chunkNumber'] = opts[:'chunk_number'] if !opts[:'chunk_number'].nil?
1601
+
1602
+ # header parameters
1603
+ header_params = opts[:header_params] || {}
1604
+ # HTTP header 'Accept' (if needed)
1605
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
1606
+ # HTTP header 'Content-Type'
1607
+ content_type = @api_client.select_header_content_type(['multipart/form-data'])
1608
+ if !content_type.nil?
1609
+ header_params['Content-Type'] = content_type
1610
+ end
1611
+
1612
+ # form parameters
1613
+ form_params = opts[:form_params] || {}
1614
+ form_params['file'] = opts[:'file'] if !opts[:'file'].nil?
1615
+
1616
+ # http body (model)
1617
+ post_body = opts[:debug_body]
1618
+
1619
+ # return_type
1620
+ return_type = opts[:debug_return_type] || (folder_id.is_a?(String) ? 'ThirdPartyChunkedUploadSessionWrapper' : 'ChunkedUploadSessionWrapper')
1621
+
1622
+ # auth_names
1623
+ auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
1624
+
1625
+ new_options = opts.merge(
1626
+ :operation => :"Files::OperationsApi.upload_async_session",
1627
+ :header_params => header_params,
1628
+ :query_params => query_params,
1629
+ :form_params => form_params,
1630
+ :body => post_body,
1631
+ :auth_names => auth_names,
1632
+ :return_type => return_type
1633
+ )
1634
+
1635
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
1636
+ if @api_client.config.debugging
1637
+ @api_client.config.logger.debug "API called: Files::OperationsApi#upload_async_session\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1638
+ end
1639
+ return data, status_code, headers
1640
+ end
1641
+
1642
+ # Upload the next chunk
1643
+ # Sends the next part of a file into the session opened for it, as the multipart `File` field, and lets the server keep count: parts are appended in the order they arrive, so two of these calls must never run in parallel on one session. While bytes are still missing the answer describes the session and `uploaded` is false; when the last part completes the declared size the file is written, its upload links are cleared, it is marked as new for the room, and the answer comes back with 201, `uploaded` true and the whole file in `file`. A session created for a payload smaller than `chunkUploadSize` from `GET api/2.0/files/settings` finishes on the first such call and needs no separate finalize step. A part larger than that limit is refused. The first part of a PDF is inspected, and a PDF that is not a fillable form is refused when the session targets a form-filling room. The session is addressed by its id, and the folder in the path is not matched against it.
1644
+ # See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/upload-session/
1645
+ # @param folder_id [Integer, String] The folder the session was opened against. It is part of the route only and is not matched against the session, which is found by its own id.
1646
+ # @param session_id [String] The session this part belongs to, as returned in `id` when it was created; the parts of one session must be sent one after another, not in parallel.
1647
+ # @param [Hash] opts the optional parameters
1648
+ # @option opts [File] :file The next part of the file, sent as the multipart field of the same name. Parts are appended in the order they arrive, and a part larger than the portal chunk size is refused.
1649
+ # @return [UploadSessionResponseWrapper, ThirdPartyUploadSessionResponseWrapper]
1650
+ def upload_session(folder_id, session_id, opts = {})
1651
+ data, _status_code, _headers = upload_session_with_http_info(folder_id, session_id, opts)
1652
+ data
1653
+ end
1654
+
1655
+ # Upload the next chunk
1656
+ # Sends the next part of a file into the session opened for it, as the multipart `File` field, and lets the server keep count: parts are appended in the order they arrive, so two of these calls must never run in parallel on one session. While bytes are still missing the answer describes the session and `uploaded` is false; when the last part completes the declared size the file is written, its upload links are cleared, it is marked as new for the room, and the answer comes back with 201, `uploaded` true and the whole file in `file`. A session created for a payload smaller than `chunkUploadSize` from `GET api/2.0/files/settings` finishes on the first such call and needs no separate finalize step. A part larger than that limit is refused. The first part of a PDF is inspected, and a PDF that is not a fillable form is refused when the session targets a form-filling room. The session is addressed by its id, and the folder in the path is not matched against it.
1657
+ # See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/upload-session/
1658
+ # @param folder_id [Integer, String] The folder the session was opened against. It is part of the route only and is not matched against the session, which is found by its own id.
1659
+ # @param session_id [String] The session this part belongs to, as returned in `id` when it was created; the parts of one session must be sent one after another, not in parallel.
1660
+ # @param [Hash] opts the optional parameters
1661
+ # @option opts [File] :file The next part of the file, sent as the multipart field of the same name. Parts are appended in the order they arrive, and a part larger than the portal chunk size is refused.
1662
+ # @return [Array<(UploadSessionResponseWrapper, ThirdPartyUploadSessionResponseWrapper, Integer, Hash)>] UploadSessionResponseWrapper, ThirdPartyUploadSessionResponseWrapper data, response status code and response headers
1663
+ def upload_session_with_http_info(folder_id, session_id, opts = {})
1664
+ if @api_client.config.debugging
1665
+ @api_client.config.logger.debug 'Calling API: Files::OperationsApi.upload_session ...'
1666
+ end
1667
+ # verify the required parameter 'folder_id' is set
1668
+ if @api_client.config.client_side_validation && folder_id.nil?
1669
+ fail ArgumentError, "Missing the required parameter 'folder_id' when calling Files::OperationsApi.upload_session"
1670
+ end
1671
+ # verify the required parameter 'session_id' is set
1672
+ if @api_client.config.client_side_validation && session_id.nil?
1673
+ fail ArgumentError, "Missing the required parameter 'session_id' when calling Files::OperationsApi.upload_session"
1674
+ end
1675
+ # resource path
1676
+ local_var_path = '/api/2.0/files/{folderId}/session/{sessionId}'.sub('{' + 'folderId' + '}', CGI.escape(folder_id.to_s)).sub('{' + 'sessionId' + '}', CGI.escape(session_id.to_s))
1677
+
1678
+ # query parameters
1679
+ query_params = opts[:query_params] || {}
1680
+
1681
+ # header parameters
1682
+ header_params = opts[:header_params] || {}
1683
+ # HTTP header 'Accept' (if needed)
1684
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
1685
+ # HTTP header 'Content-Type'
1686
+ content_type = @api_client.select_header_content_type(['multipart/form-data'])
1687
+ if !content_type.nil?
1688
+ header_params['Content-Type'] = content_type
1689
+ end
1690
+
1691
+ # form parameters
1692
+ form_params = opts[:form_params] || {}
1693
+ form_params['file'] = opts[:'file'] if !opts[:'file'].nil?
1694
+
1695
+ # http body (model)
1696
+ post_body = opts[:debug_body]
1697
+
1698
+ # return_type
1699
+ return_type = opts[:debug_return_type] || (folder_id.is_a?(String) ? 'ThirdPartyUploadSessionResponseWrapper' : 'UploadSessionResponseWrapper')
1700
+
1701
+ # auth_names
1702
+ auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
1703
+
1704
+ new_options = opts.merge(
1705
+ :operation => :"Files::OperationsApi.upload_session",
1706
+ :header_params => header_params,
1707
+ :query_params => query_params,
1708
+ :form_params => form_params,
1709
+ :body => post_body,
1710
+ :auth_names => auth_names,
1711
+ :return_type => return_type
1712
+ )
1713
+
1714
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
1715
+ if @api_client.config.debugging
1716
+ @api_client.config.logger.debug "API called: Files::OperationsApi#upload_session\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1717
+ end
1718
+ return data, status_code, headers
1719
+ end
1720
+ end
1721
+ end
1722
+ end