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.
- checksums.yaml +7 -0
- data/AUTHORS.md +3 -0
- data/CHANGELOG.md +50 -0
- data/LICENSE +201 -0
- data/README.md +5310 -0
- data/lib/docspace-api-sdk/api/AI/agents-api.rb +605 -0
- data/lib/docspace-api-sdk/api/AI/ai-api.rb +517 -0
- data/lib/docspace-api-sdk/api/AI/assignments-api.rb +573 -0
- data/lib/docspace-api-sdk/api/AI/attachments-api.rb +585 -0
- data/lib/docspace-api-sdk/api/AI/context-api.rb +233 -0
- data/lib/docspace-api-sdk/api/AI/editor-tools-api.rb +156 -0
- data/lib/docspace-api-sdk/api/AI/export-api.rb +97 -0
- data/lib/docspace-api-sdk/api/AI/open-ai-passthrough-api.rb +179 -0
- data/lib/docspace-api-sdk/api/AI/preferences-api.rb +555 -0
- data/lib/docspace-api-sdk/api/AI/profiles-api.rb +568 -0
- data/lib/docspace-api-sdk/api/AI/prompts-api.rb +899 -0
- data/lib/docspace-api-sdk/api/AI/settings-api.rb +473 -0
- data/lib/docspace-api-sdk/api/AI/threads-api.rb +1005 -0
- data/lib/docspace-api-sdk/api/AI/tools-api.rb +923 -0
- data/lib/docspace-api-sdk/api/AI/vectorization-api.rb +97 -0
- data/lib/docspace-api-sdk/api/AI/web-search-api.rb +571 -0
- data/lib/docspace-api-sdk/api/ApiKeys/api-keys-api.rb +411 -0
- data/lib/docspace-api-sdk/api/Apps/apps-api.rb +368 -0
- data/lib/docspace-api-sdk/api/Authentication/authentication-api.rb +481 -0
- data/lib/docspace-api-sdk/api/Backup/backup-api.rb +916 -0
- data/lib/docspace-api-sdk/api/Capabilities/capabilities-api.rb +86 -0
- data/lib/docspace-api-sdk/api/Docs/docs-api.rb +159 -0
- data/lib/docspace-api-sdk/api/Files/files-api.rb +3705 -0
- data/lib/docspace-api-sdk/api/Files/folders-api.rb +2611 -0
- data/lib/docspace-api-sdk/api/Files/metadata-api.rb +1465 -0
- data/lib/docspace-api-sdk/api/Files/operations-api.rb +1722 -0
- data/lib/docspace-api-sdk/api/Files/quota-api.rb +159 -0
- data/lib/docspace-api-sdk/api/Files/settings-api.rb +1973 -0
- data/lib/docspace-api-sdk/api/Files/sharing-api.rb +1126 -0
- data/lib/docspace-api-sdk/api/Files/third-party-integration-api.rb +522 -0
- data/lib/docspace-api-sdk/api/Group/group-api.rb +830 -0
- data/lib/docspace-api-sdk/api/Group/search-api.rb +282 -0
- data/lib/docspace-api-sdk/api/Migration/migration-api.rb +519 -0
- data/lib/docspace-api-sdk/api/OAuth20/authorization-api.rb +262 -0
- data/lib/docspace-api-sdk/api/OAuth20/client-management-api.rb +582 -0
- data/lib/docspace-api-sdk/api/OAuth20/client-querying-api.rb +467 -0
- data/lib/docspace-api-sdk/api/OAuth20/discovery-api.rb +84 -0
- data/lib/docspace-api-sdk/api/OAuth20/scope-management-api.rb +86 -0
- data/lib/docspace-api-sdk/api/People/email-api.rb +169 -0
- data/lib/docspace-api-sdk/api/People/guests-api.rb +159 -0
- data/lib/docspace-api-sdk/api/People/password-api.rb +169 -0
- data/lib/docspace-api-sdk/api/People/photos-api.rb +389 -0
- data/lib/docspace-api-sdk/api/People/profiles-api.rb +986 -0
- data/lib/docspace-api-sdk/api/People/quota-api.rb +159 -0
- data/lib/docspace-api-sdk/api/People/search-api.rb +1150 -0
- data/lib/docspace-api-sdk/api/People/theme-api.rb +152 -0
- data/lib/docspace-api-sdk/api/People/third-party-accounts-api.rb +292 -0
- data/lib/docspace-api-sdk/api/People/user-data-api.rb +663 -0
- data/lib/docspace-api-sdk/api/People/user-status-api.rb +273 -0
- data/lib/docspace-api-sdk/api/People/user-type-api.rb +300 -0
- data/lib/docspace-api-sdk/api/Portal/guests-api.rb +92 -0
- data/lib/docspace-api-sdk/api/Portal/payment-api.rb +2571 -0
- data/lib/docspace-api-sdk/api/Portal/quota-api.rb +328 -0
- data/lib/docspace-api-sdk/api/Portal/settings-api.rb +502 -0
- data/lib/docspace-api-sdk/api/Portal/users-api.rb +611 -0
- data/lib/docspace-api-sdk/api/Rooms/groups-api.rb +442 -0
- data/lib/docspace-api-sdk/api/Rooms/privacy-room-api.rb +348 -0
- data/lib/docspace-api-sdk/api/Rooms/rooms-api.rb +3121 -0
- data/lib/docspace-api-sdk/api/Security/access-to-dev-tools-api.rb +93 -0
- data/lib/docspace-api-sdk/api/Security/active-connections-api.rb +334 -0
- data/lib/docspace-api-sdk/api/Security/audit-trail-data-api.rb +618 -0
- data/lib/docspace-api-sdk/api/Security/banners-visibility-api.rb +93 -0
- data/lib/docspace-api-sdk/api/Security/csp-api.rb +152 -0
- data/lib/docspace-api-sdk/api/Security/firebase-api.rb +159 -0
- data/lib/docspace-api-sdk/api/Security/login-history-api.rb +357 -0
- data/lib/docspace-api-sdk/api/Security/o-auth2-api.rb +86 -0
- data/lib/docspace-api-sdk/api/Security/smtp-settings-api.rb +329 -0
- data/lib/docspace-api-sdk/api/Settings/access-to-dev-tools-api.rb +86 -0
- data/lib/docspace-api-sdk/api/Settings/authorization-api.rb +218 -0
- data/lib/docspace-api-sdk/api/Settings/banners-visibility-api.rb +86 -0
- data/lib/docspace-api-sdk/api/Settings/common-settings-api.rb +1398 -0
- data/lib/docspace-api-sdk/api/Settings/cookies-api.rb +152 -0
- data/lib/docspace-api-sdk/api/Settings/docs-cloud-api.rb +771 -0
- data/lib/docspace-api-sdk/api/Settings/encryption-api.rb +211 -0
- data/lib/docspace-api-sdk/api/Settings/greeting-settings-api.rb +270 -0
- data/lib/docspace-api-sdk/api/Settings/ip-restrictions-api.rb +277 -0
- data/lib/docspace-api-sdk/api/Settings/license-api.rb +275 -0
- data/lib/docspace-api-sdk/api/Settings/login-settings-api.rb +211 -0
- data/lib/docspace-api-sdk/api/Settings/messages-api.rb +225 -0
- data/lib/docspace-api-sdk/api/Settings/notifications-api.rb +342 -0
- data/lib/docspace-api-sdk/api/Settings/owner-api.rb +159 -0
- data/lib/docspace-api-sdk/api/Settings/quota-api.rb +284 -0
- data/lib/docspace-api-sdk/api/Settings/rebranding-api.rb +1112 -0
- data/lib/docspace-api-sdk/api/Settings/security-api.rb +674 -0
- data/lib/docspace-api-sdk/api/Settings/sso-api.rb +329 -0
- data/lib/docspace-api-sdk/api/Settings/statistics-api.rb +92 -0
- data/lib/docspace-api-sdk/api/Settings/storage-api.rb +575 -0
- data/lib/docspace-api-sdk/api/Settings/telegram-api.rb +204 -0
- data/lib/docspace-api-sdk/api/Settings/tfa-settings-api.rb +586 -0
- data/lib/docspace-api-sdk/api/Settings/webhooks-api.rb +636 -0
- data/lib/docspace-api-sdk/api/Settings/webplugins-api.rb +422 -0
- data/lib/docspace-api-sdk/api/ThirdParty/third-party-api.rb +92 -0
- data/lib/docspace-api-sdk/api-client.rb +407 -0
- data/lib/docspace-api-sdk/api-error.rb +63 -0
- data/lib/docspace-api-sdk/api-model-base.rb +91 -0
- data/lib/docspace-api-sdk/configuration.rb +367 -0
- data/lib/docspace-api-sdk/models/access-request-key-dto.rb +173 -0
- data/lib/docspace-api-sdk/models/account-entry-array-wrapper.rb +196 -0
- data/lib/docspace-api-sdk/models/account-entry-dto.rb +108 -0
- data/lib/docspace-api-sdk/models/account-info-array-wrapper.rb +196 -0
- data/lib/docspace-api-sdk/models/account-info-dto.rb +195 -0
- data/lib/docspace-api-sdk/models/account-login-type.rb +44 -0
- data/lib/docspace-api-sdk/models/account-search-area.rb +44 -0
- data/lib/docspace-api-sdk/models/ace-short-array-wrapper.rb +196 -0
- data/lib/docspace-api-sdk/models/ace-short-dto.rb +174 -0
- data/lib/docspace-api-sdk/models/action-link-action-request.rb +212 -0
- data/lib/docspace-api-sdk/models/action-link-request.rb +152 -0
- data/lib/docspace-api-sdk/models/action-type.rb +61 -0
- data/lib/docspace-api-sdk/models/active-connections-dto.rb +182 -0
- data/lib/docspace-api-sdk/models/active-connections-item-dto.rb +309 -0
- data/lib/docspace-api-sdk/models/active-connections-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/active-service-array-wrapper.rb +196 -0
- data/lib/docspace-api-sdk/models/active-service-dto.rb +207 -0
- data/lib/docspace-api-sdk/models/additional-resources-dto.rb +212 -0
- data/lib/docspace-api-sdk/models/additional-resources-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/additional-white-label-settings-dto.rb +331 -0
- data/lib/docspace-api-sdk/models/additional-white-label-settings-request-dto.rb +152 -0
- data/lib/docspace-api-sdk/models/additional-white-label-settings-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/admin-message-base-settings-request-dto.rb +190 -0
- data/lib/docspace-api-sdk/models/admin-message-settings-request-dto.rb +270 -0
- data/lib/docspace-api-sdk/models/ai-action-args-prompt.rb +218 -0
- data/lib/docspace-api-sdk/models/ai-action-args.rb +204 -0
- data/lib/docspace-api-sdk/models/ai-action-type.rb +51 -0
- data/lib/docspace-api-sdk/models/ai-agent-new-items-dto.rb +184 -0
- data/lib/docspace-api-sdk/models/ai-agents-create-request.rb +329 -0
- data/lib/docspace-api-sdk/models/ai-agents-delete-request.rb +151 -0
- data/lib/docspace-api-sdk/models/ai-agents-get200-response-all-of-response.rb +151 -0
- data/lib/docspace-api-sdk/models/ai-agents-get200-response.rb +199 -0
- data/lib/docspace-api-sdk/models/ai-agents-reset-quota-request.rb +170 -0
- data/lib/docspace-api-sdk/models/ai-agents-update-quota-request-room-ids-inner.rb +107 -0
- data/lib/docspace-api-sdk/models/ai-agents-update-quota-request.rb +197 -0
- data/lib/docspace-api-sdk/models/ai-agents-update-request.rb +283 -0
- data/lib/docspace-api-sdk/models/ai-api-date-time.rb +162 -0
- data/lib/docspace-api-sdk/models/ai-approve-tool-call-request.rb +301 -0
- data/lib/docspace-api-sdk/models/ai-assignment-mutation-result.rb +179 -0
- data/lib/docspace-api-sdk/models/ai-assignments-assign-request.rb +217 -0
- data/lib/docspace-api-sdk/models/ai-assignments-cascade-profile-delete-request.rb +168 -0
- data/lib/docspace-api-sdk/models/ai-attachment-form-keys-inner.rb +193 -0
- data/lib/docspace-api-sdk/models/ai-attachment.rb +388 -0
- data/lib/docspace-api-sdk/models/ai-attachments-link-to-message-request.rb +224 -0
- data/lib/docspace-api-sdk/models/ai-attachments-save-file-request-input.rb +233 -0
- data/lib/docspace-api-sdk/models/ai-attachments-save-file-request.rb +177 -0
- data/lib/docspace-api-sdk/models/ai-attachments-save-files-many-request.rb +178 -0
- data/lib/docspace-api-sdk/models/ai-builtin-provider-type.rb +58 -0
- data/lib/docspace-api-sdk/models/ai-bulk-assignment-result-errors-inner.rb +215 -0
- data/lib/docspace-api-sdk/models/ai-bulk-assignment-result.rb +181 -0
- data/lib/docspace-api-sdk/models/ai-chat-event.rb +273 -0
- data/lib/docspace-api-sdk/models/ai-chat-price-dto.rb +195 -0
- data/lib/docspace-api-sdk/models/ai-chat-settings-dto.rb +153 -0
- data/lib/docspace-api-sdk/models/ai-chat-tool-permission-mode.rb +44 -0
- data/lib/docspace-api-sdk/models/ai-chat-tool-prefs-scope.rb +43 -0
- data/lib/docspace-api-sdk/models/ai-config-dto.rb +152 -0
- data/lib/docspace-api-sdk/models/ai-create-profile-input.rb +374 -0
- data/lib/docspace-api-sdk/models/ai-create-prompt-input.rb +207 -0
- data/lib/docspace-api-sdk/models/ai-distributed-task-status.rb +46 -0
- data/lib/docspace-api-sdk/models/ai-editor-tools-call-request.rb +190 -0
- data/lib/docspace-api-sdk/models/ai-editor-tools-call200-response.rb +168 -0
- data/lib/docspace-api-sdk/models/ai-editor-tools-list200-response-tools-inner.rb +251 -0
- data/lib/docspace-api-sdk/models/ai-editor-tools-list200-response.rb +170 -0
- data/lib/docspace-api-sdk/models/ai-embedding-price-dto.rb +152 -0
- data/lib/docspace-api-sdk/models/ai-embedding-provider-type.rb +45 -0
- data/lib/docspace-api-sdk/models/ai-employee-dto.rb +249 -0
- data/lib/docspace-api-sdk/models/ai-entry-pricing-dto-ai-chat-price-dto.rb +234 -0
- data/lib/docspace-api-sdk/models/ai-entry-pricing-dto-ai-embedding-price-dto.rb +234 -0
- data/lib/docspace-api-sdk/models/ai-entry-pricing-dto-ai-image-price-dto.rb +234 -0
- data/lib/docspace-api-sdk/models/ai-entry-pricing-dto-decimal.rb +234 -0
- data/lib/docspace-api-sdk/models/ai-error-code.rb +45 -0
- data/lib/docspace-api-sdk/models/ai-error-data.rb +230 -0
- data/lib/docspace-api-sdk/models/ai-error-response.rb +169 -0
- data/lib/docspace-api-sdk/models/ai-export-text-to-docx-request-folder-id.rb +107 -0
- data/lib/docspace-api-sdk/models/ai-export-text-to-docx-request.rb +221 -0
- data/lib/docspace-api-sdk/models/ai-export-text-to-docx202-response.rb +168 -0
- data/lib/docspace-api-sdk/models/ai-file-entry-base-dto.rb +391 -0
- data/lib/docspace-api-sdk/models/ai-file-entry-dto-all-of-available-share-rights.rb +197 -0
- data/lib/docspace-api-sdk/models/ai-file-entry-dto-all-of-security.rb +565 -0
- data/lib/docspace-api-sdk/models/ai-file-entry-dto-all-of-share-settings.rb +187 -0
- data/lib/docspace-api-sdk/models/ai-file-entry-dto.rb +562 -0
- data/lib/docspace-api-sdk/models/ai-file-entry-type.rb +43 -0
- data/lib/docspace-api-sdk/models/ai-file-operation-dto.rb +331 -0
- data/lib/docspace-api-sdk/models/ai-file-operation-type.rb +50 -0
- data/lib/docspace-api-sdk/models/ai-file-operation-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/ai-file-share.rb +53 -0
- data/lib/docspace-api-sdk/models/ai-folder-array-wrapper.rb +196 -0
- data/lib/docspace-api-sdk/models/ai-folder-content-dto.rb +247 -0
- data/lib/docspace-api-sdk/models/ai-folder-content-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/ai-folder-dto.rb +838 -0
- data/lib/docspace-api-sdk/models/ai-folder-mutation-result.rb +189 -0
- data/lib/docspace-api-sdk/models/ai-folder-type.rb +72 -0
- data/lib/docspace-api-sdk/models/ai-folder-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/ai-image-price-dto.rb +172 -0
- data/lib/docspace-api-sdk/models/ai-import-error.rb +247 -0
- data/lib/docspace-api-sdk/models/ai-import-mode.rb +43 -0
- data/lib/docspace-api-sdk/models/ai-import-result-imported.rb +194 -0
- data/lib/docspace-api-sdk/models/ai-import-result.rb +190 -0
- data/lib/docspace-api-sdk/models/ai-logo-cover-dto.rb +168 -0
- data/lib/docspace-api-sdk/models/ai-logo-dto.rb +215 -0
- data/lib/docspace-api-sdk/models/ai-mcp-item.rb +263 -0
- data/lib/docspace-api-sdk/models/ai-metadata-match-dto.rb +186 -0
- data/lib/docspace-api-sdk/models/ai-model.rb +263 -0
- data/lib/docspace-api-sdk/models/ai-new-items-agent-new-items-array-wrapper.rb +196 -0
- data/lib/docspace-api-sdk/models/ai-new-items-dto-agent-new-items-dto.rb +184 -0
- data/lib/docspace-api-sdk/models/ai-open-ai-chat-completion-chunk.rb +303 -0
- data/lib/docspace-api-sdk/models/ai-open-ai-choice-delta.rb +209 -0
- data/lib/docspace-api-sdk/models/ai-open-ai-chunk-choice.rb +231 -0
- data/lib/docspace-api-sdk/models/ai-open-ai-finish-reason.rb +45 -0
- data/lib/docspace-api-sdk/models/ai-open-ai-stream-chunk.rb +107 -0
- data/lib/docspace-api-sdk/models/ai-open-ai-stream-error-error.rb +218 -0
- data/lib/docspace-api-sdk/models/ai-open-ai-stream-error.rb +168 -0
- data/lib/docspace-api-sdk/models/ai-open-ai-tool-call-delta-function.rb +160 -0
- data/lib/docspace-api-sdk/models/ai-open-ai-tool-call-delta.rb +232 -0
- data/lib/docspace-api-sdk/models/ai-open-or-create-result.rb +225 -0
- data/lib/docspace-api-sdk/models/ai-openai-chat-completions403-response-error.rb +217 -0
- data/lib/docspace-api-sdk/models/ai-openai-chat-completions403-response.rb +167 -0
- data/lib/docspace-api-sdk/models/ai-openai-images-generations403-response-error.rb +217 -0
- data/lib/docspace-api-sdk/models/ai-openai-images-generations403-response.rb +167 -0
- data/lib/docspace-api-sdk/models/ai-preferences-set-deep-mode-request.rb +177 -0
- data/lib/docspace-api-sdk/models/ai-preferences-set-reasoning-level-request.rb +199 -0
- data/lib/docspace-api-sdk/models/ai-preferences-set-tool-permission-mode-request.rb +199 -0
- data/lib/docspace-api-sdk/models/ai-price-currency-dto.rb +168 -0
- data/lib/docspace-api-sdk/models/ai-prices-dto.rb +229 -0
- data/lib/docspace-api-sdk/models/ai-prices-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/ai-profile-mutation-result.rb +189 -0
- data/lib/docspace-api-sdk/models/ai-profile.rb +411 -0
- data/lib/docspace-api-sdk/models/ai-profiles-create400-response.rb +106 -0
- data/lib/docspace-api-sdk/models/ai-profiles-get-by-id200-response.rb +388 -0
- data/lib/docspace-api-sdk/models/ai-profiles-list-provider-models-request.rb +205 -0
- data/lib/docspace-api-sdk/models/ai-profiles-list-provider-models400-response-any-of.rb +195 -0
- data/lib/docspace-api-sdk/models/ai-profiles-list-provider-models400-response.rb +106 -0
- data/lib/docspace-api-sdk/models/ai-profiles-test-connection200-response-any-of.rb +150 -0
- data/lib/docspace-api-sdk/models/ai-profiles-test-connection200-response.rb +106 -0
- data/lib/docspace-api-sdk/models/ai-prompt-bundle.rb +251 -0
- data/lib/docspace-api-sdk/models/ai-prompt-folder.rb +250 -0
- data/lib/docspace-api-sdk/models/ai-prompt-mutation-result.rb +189 -0
- data/lib/docspace-api-sdk/models/ai-prompt.rb +287 -0
- data/lib/docspace-api-sdk/models/ai-prompts-import-bundle-request-options.rb +173 -0
- data/lib/docspace-api-sdk/models/ai-prompts-import-bundle-request.rb +177 -0
- data/lib/docspace-api-sdk/models/ai-prompts-move-request.rb +181 -0
- data/lib/docspace-api-sdk/models/ai-prompts-rename-folder-request.rb +195 -0
- data/lib/docspace-api-sdk/models/ai-prompts-update-request-updates.rb +170 -0
- data/lib/docspace-api-sdk/models/ai-prompts-update-request.rb +194 -0
- data/lib/docspace-api-sdk/models/ai-provider-type.rb +107 -0
- data/lib/docspace-api-sdk/models/ai-provider.rb +233 -0
- data/lib/docspace-api-sdk/models/ai-reasoning-depth.rb +45 -0
- data/lib/docspace-api-sdk/models/ai-reasoning-level.rb +46 -0
- data/lib/docspace-api-sdk/models/ai-reasoning-support.rb +257 -0
- data/lib/docspace-api-sdk/models/ai-regenerate-stream-request.rb +198 -0
- data/lib/docspace-api-sdk/models/ai-resolved-assignment.rb +196 -0
- data/lib/docspace-api-sdk/models/ai-room-data-lifetime-dto.rb +230 -0
- data/lib/docspace-api-sdk/models/ai-room-data-lifetime-period.rb +44 -0
- data/lib/docspace-api-sdk/models/ai-room-type.rb +47 -0
- data/lib/docspace-api-sdk/models/ai-send-custom-request.rb +231 -0
- data/lib/docspace-api-sdk/models/ai-send-request.rb +237 -0
- data/lib/docspace-api-sdk/models/ai-send-stream-body.rb +209 -0
- data/lib/docspace-api-sdk/models/ai-settings-dto.rb +238 -0
- data/lib/docspace-api-sdk/models/ai-settings-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/ai-success-response.rb +169 -0
- data/lib/docspace-api-sdk/models/ai-thread-message-like-content-any-of-inner.rb +176 -0
- data/lib/docspace-api-sdk/models/ai-thread-message-like-content.rb +107 -0
- data/lib/docspace-api-sdk/models/ai-thread-message-like-status.rb +168 -0
- data/lib/docspace-api-sdk/models/ai-thread-message-like.rb +270 -0
- data/lib/docspace-api-sdk/models/ai-thread.rb +219 -0
- data/lib/docspace-api-sdk/models/ai-threads-append-user-message-request.rb +203 -0
- data/lib/docspace-api-sdk/models/ai-threads-append-user-message200-response.rb +168 -0
- data/lib/docspace-api-sdk/models/ai-threads-create-request.rb +188 -0
- data/lib/docspace-api-sdk/models/ai-threads-open-or-create-request-entity-meta.rb +160 -0
- data/lib/docspace-api-sdk/models/ai-threads-open-or-create-request.rb +249 -0
- data/lib/docspace-api-sdk/models/ai-threads-regenerate-title-request.rb +203 -0
- data/lib/docspace-api-sdk/models/ai-threads-regenerate-title200-response.rb +168 -0
- data/lib/docspace-api-sdk/models/ai-threads-rename-request.rb +194 -0
- data/lib/docspace-api-sdk/models/ai-threads-touch-request.rb +176 -0
- data/lib/docspace-api-sdk/models/ai-threads-update-message-request.rb +194 -0
- data/lib/docspace-api-sdk/models/ai-tool-annotations.rb +187 -0
- data/lib/docspace-api-sdk/models/ai-tool-call-data.rb +280 -0
- data/lib/docspace-api-sdk/models/ai-tool-permission-mode.rb +44 -0
- data/lib/docspace-api-sdk/models/ai-tools-add-custom-server-request.rb +204 -0
- data/lib/docspace-api-sdk/models/ai-tools-bulk-result-errors-inner.rb +193 -0
- data/lib/docspace-api-sdk/models/ai-tools-bulk-result.rb +181 -0
- data/lib/docspace-api-sdk/models/ai-tools-list-system-tools200-response.rb +228 -0
- data/lib/docspace-api-sdk/models/ai-tools-mutation-result.rb +179 -0
- data/lib/docspace-api-sdk/models/ai-tools-remove-custom-server-request.rb +176 -0
- data/lib/docspace-api-sdk/models/ai-tools-replace-all-custom-servers-request.rb +179 -0
- data/lib/docspace-api-sdk/models/ai-tools-set-allow-always-request.rb +229 -0
- data/lib/docspace-api-sdk/models/ai-tools-set-disabled-request.rb +237 -0
- data/lib/docspace-api-sdk/models/ai-tools-update-custom-server-request.rb +203 -0
- data/lib/docspace-api-sdk/models/ai-user-settings-dto.rb +184 -0
- data/lib/docspace-api-sdk/models/ai-user-settings-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/ai-vectorization-settings-dto.rb +184 -0
- data/lib/docspace-api-sdk/models/ai-vectorization-settings-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/ai-vectorization-start-task-request.rb +170 -0
- data/lib/docspace-api-sdk/models/ai-vectorization-start-task200-response.rb +222 -0
- data/lib/docspace-api-sdk/models/ai-watermark-additions.rb +46 -0
- data/lib/docspace-api-sdk/models/ai-watermark-dto.rb +321 -0
- data/lib/docspace-api-sdk/models/ai-web-search-config.rb +211 -0
- data/lib/docspace-api-sdk/models/ai-web-search-configure-request.rb +176 -0
- data/lib/docspace-api-sdk/models/ai-web-search-configure400-response.rb +106 -0
- data/lib/docspace-api-sdk/models/ai-web-search-mutation-result.rb +189 -0
- data/lib/docspace-api-sdk/models/ai-web-search-set-active-config-request.rb +176 -0
- data/lib/docspace-api-sdk/models/amazon-s3-region-array-wrapper.rb +196 -0
- data/lib/docspace-api-sdk/models/amazon-s3-region-dto.rb +208 -0
- data/lib/docspace-api-sdk/models/anonymous-config-dto.rb +169 -0
- data/lib/docspace-api-sdk/models/api-date-time.rb +162 -0
- data/lib/docspace-api-sdk/models/api-key-response-array-wrapper.rb +196 -0
- data/lib/docspace-api-sdk/models/api-key-response-dto.rb +288 -0
- data/lib/docspace-api-sdk/models/api-key-response-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/app-array-wrapper.rb +196 -0
- data/lib/docspace-api-sdk/models/app-dto.rb +173 -0
- data/lib/docspace-api-sdk/models/app-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/apply-filter-option.rb +44 -0
- data/lib/docspace-api-sdk/models/archive-room-request.rb +152 -0
- data/lib/docspace-api-sdk/models/array-array-wrapper.rb +196 -0
- data/lib/docspace-api-sdk/models/assign-metadata-templates.rb +199 -0
- data/lib/docspace-api-sdk/models/audit-event-array-wrapper.rb +196 -0
- data/lib/docspace-api-sdk/models/audit-event-dto.rb +359 -0
- data/lib/docspace-api-sdk/models/audit-report-format.rb +43 -0
- data/lib/docspace-api-sdk/models/audit-trail-action-dto.rb +175 -0
- data/lib/docspace-api-sdk/models/audit-trail-module-dto.rb +166 -0
- data/lib/docspace-api-sdk/models/audit-trail-product-array-wrapper.rb +196 -0
- data/lib/docspace-api-sdk/models/audit-trail-product-dto.rb +166 -0
- data/lib/docspace-api-sdk/models/audit-trail-types-dto.rb +207 -0
- data/lib/docspace-api-sdk/models/audit-trail-types-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/auth-key-dto.rb +249 -0
- data/lib/docspace-api-sdk/models/auth-key-request.rb +249 -0
- data/lib/docspace-api-sdk/models/auth-request-dto.rb +293 -0
- data/lib/docspace-api-sdk/models/auth-service-array-wrapper.rb +196 -0
- data/lib/docspace-api-sdk/models/auth-service-dto.rb +219 -0
- data/lib/docspace-api-sdk/models/auth-with-code-request-dto.rb +302 -0
- data/lib/docspace-api-sdk/models/authentication-token-dto.rb +216 -0
- data/lib/docspace-api-sdk/models/authentication-token-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/auto-clean-up-data-dto.rb +184 -0
- data/lib/docspace-api-sdk/models/auto-clean-up-data-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/auto-cleanup-request-dto.rb +184 -0
- data/lib/docspace-api-sdk/models/backup-cron-request.rb +195 -0
- data/lib/docspace-api-sdk/models/backup-history-record-array-wrapper.rb +196 -0
- data/lib/docspace-api-sdk/models/backup-history-record-dto.rb +285 -0
- data/lib/docspace-api-sdk/models/backup-period.rb +44 -0
- data/lib/docspace-api-sdk/models/backup-progress-dto.rb +258 -0
- data/lib/docspace-api-sdk/models/backup-progress-enum.rb +44 -0
- data/lib/docspace-api-sdk/models/backup-progress-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/backup-service-state-dto.rb +152 -0
- data/lib/docspace-api-sdk/models/backup-service-state-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/backup-storage-type.rb +47 -0
- data/lib/docspace-api-sdk/models/backups-count-result-dto.rb +162 -0
- data/lib/docspace-api-sdk/models/backups-count-result-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/balance-dto.rb +207 -0
- data/lib/docspace-api-sdk/models/balance-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/base-batch-request-dto-all-of-file-ids.rb +106 -0
- data/lib/docspace-api-sdk/models/base-batch-request-dto-all-of-folder-ids.rb +106 -0
- data/lib/docspace-api-sdk/models/base-batch-request-dto.rb +185 -0
- data/lib/docspace-api-sdk/models/batch-request-dto-all-of-dest-folder-id.rb +108 -0
- data/lib/docspace-api-sdk/models/batch-request-dto-all-of-file-ids.rb +106 -0
- data/lib/docspace-api-sdk/models/batch-request-dto-all-of-folder-ids.rb +106 -0
- data/lib/docspace-api-sdk/models/batch-request-dto.rb +256 -0
- data/lib/docspace-api-sdk/models/batch-tags-request-dto.rb +171 -0
- data/lib/docspace-api-sdk/models/boolean-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/capabilities-dto.rb +275 -0
- data/lib/docspace-api-sdk/models/capabilities-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/change-client-activation-request.rb +169 -0
- data/lib/docspace-api-sdk/models/change-email-request.rb +188 -0
- data/lib/docspace-api-sdk/models/change-history-request.rb +179 -0
- data/lib/docspace-api-sdk/models/change-owner-request-dto.rb +195 -0
- data/lib/docspace-api-sdk/models/change-password-request.rb +164 -0
- data/lib/docspace-api-sdk/models/change-wallet-service-state-request-dto.rb +184 -0
- data/lib/docspace-api-sdk/models/chat-settings-dto.rb +153 -0
- data/lib/docspace-api-sdk/models/chat-settings.rb +184 -0
- data/lib/docspace-api-sdk/models/check-confirm-request-dto.rb +250 -0
- data/lib/docspace-api-sdk/models/check-conversion-request-dto.rb +214 -0
- data/lib/docspace-api-sdk/models/check-dest-folder-dto.rb +187 -0
- data/lib/docspace-api-sdk/models/check-dest-folder-result.rb +44 -0
- data/lib/docspace-api-sdk/models/check-dest-folder-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/check-doc-service-url-request-dto.rb +210 -0
- data/lib/docspace-api-sdk/models/check-fill-form-draft-request.rb +200 -0
- data/lib/docspace-api-sdk/models/check-move-or-copy-batch-items-dest-folder-id-parameter.rb +108 -0
- data/lib/docspace-api-sdk/models/check-move-or-copy-batch-items-folder-ids-parameter-inner.rb +106 -0
- data/lib/docspace-api-sdk/models/check-upload-request.rb +155 -0
- data/lib/docspace-api-sdk/models/chunked-upload-session-dto.rb +207 -0
- data/lib/docspace-api-sdk/models/chunked-upload-session-result-dto.rb +162 -0
- data/lib/docspace-api-sdk/models/chunked-upload-session-result-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/chunked-upload-session-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/client-info-response.rb +306 -0
- data/lib/docspace-api-sdk/models/client-response.rb +402 -0
- data/lib/docspace-api-sdk/models/client-secret-response.rb +152 -0
- data/lib/docspace-api-sdk/models/co-editing-config-dto.rb +194 -0
- data/lib/docspace-api-sdk/models/co-editing-config-mode.rb +43 -0
- data/lib/docspace-api-sdk/models/color-theme-colors-dto.rb +164 -0
- data/lib/docspace-api-sdk/models/color-theme-colors-request-dto.rb +164 -0
- data/lib/docspace-api-sdk/models/company-white-label-settings-dto.rb +288 -0
- data/lib/docspace-api-sdk/models/company-white-label-settings-request-dto.rb +152 -0
- data/lib/docspace-api-sdk/models/company-white-label-settings-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/configuration-dto.rb +394 -0
- data/lib/docspace-api-sdk/models/configuration-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/confirm-data.rb +175 -0
- data/lib/docspace-api-sdk/models/confirm-dto.rb +234 -0
- data/lib/docspace-api-sdk/models/confirm-type.rb +61 -0
- data/lib/docspace-api-sdk/models/confirm-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/connection-test-result-dto.rb +163 -0
- data/lib/docspace-api-sdk/models/connection-test-result-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/contact.rb +164 -0
- data/lib/docspace-api-sdk/models/conversation-result-array-wrapper.rb +196 -0
- data/lib/docspace-api-sdk/models/conversation-result-dto.rb +274 -0
- data/lib/docspace-api-sdk/models/convert-document-layout-request.rb +175 -0
- data/lib/docspace-api-sdk/models/convert-document-renderer-request.rb +153 -0
- data/lib/docspace-api-sdk/models/convert-file-request-dto.rb +287 -0
- data/lib/docspace-api-sdk/models/convert-pdf-request.rb +152 -0
- data/lib/docspace-api-sdk/models/convert-spreadsheet-layout-request.rb +239 -0
- data/lib/docspace-api-sdk/models/convert-spreadsheet-margins-request.rb +186 -0
- data/lib/docspace-api-sdk/models/convert-spreadsheet-page-size-request.rb +164 -0
- data/lib/docspace-api-sdk/models/convert-thumbnail-request.rb +186 -0
- data/lib/docspace-api-sdk/models/cookie-settings-dto.rb +196 -0
- data/lib/docspace-api-sdk/models/cookie-settings-request-dto.rb +162 -0
- data/lib/docspace-api-sdk/models/cookie-settings-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/copy-as-request-dest-folder-id.rb +108 -0
- data/lib/docspace-api-sdk/models/copy-as-request.rb +212 -0
- data/lib/docspace-api-sdk/models/cover-request-dto.rb +181 -0
- data/lib/docspace-api-sdk/models/covers-result-array-wrapper.rb +196 -0
- data/lib/docspace-api-sdk/models/covers-result-dto.rb +168 -0
- data/lib/docspace-api-sdk/models/create-api-key-request-dto.rb +235 -0
- data/lib/docspace-api-sdk/models/create-backup-schedule-request-dto.rb +218 -0
- data/lib/docspace-api-sdk/models/create-client-request.rb +612 -0
- data/lib/docspace-api-sdk/models/create-file-request-template-id.rb +108 -0
- data/lib/docspace-api-sdk/models/create-file-request.rb +208 -0
- data/lib/docspace-api-sdk/models/create-folder-request.rb +179 -0
- data/lib/docspace-api-sdk/models/create-metadata-template-request-dto.rb +178 -0
- data/lib/docspace-api-sdk/models/create-room-from-template-dto.rb +373 -0
- data/lib/docspace-api-sdk/models/create-room-request-dto.rb +422 -0
- data/lib/docspace-api-sdk/models/create-tag-request-dto.rb +179 -0
- data/lib/docspace-api-sdk/models/create-text-or-html-file-request.rb +200 -0
- data/lib/docspace-api-sdk/models/create-third-party-room-request.rb +289 -0
- data/lib/docspace-api-sdk/models/create-webhooks-config-request-dto.rb +345 -0
- data/lib/docspace-api-sdk/models/cron-params-dto.rb +194 -0
- data/lib/docspace-api-sdk/models/csp-dto.rb +170 -0
- data/lib/docspace-api-sdk/models/csp-request-dto.rb +155 -0
- data/lib/docspace-api-sdk/models/csp-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/currencies-array-wrapper.rb +196 -0
- data/lib/docspace-api-sdk/models/currencies-dto.rb +175 -0
- data/lib/docspace-api-sdk/models/current-license-info.rb +196 -0
- data/lib/docspace-api-sdk/models/custom-color-theme-dto.rb +183 -0
- data/lib/docspace-api-sdk/models/custom-color-theme-request-dto.rb +183 -0
- data/lib/docspace-api-sdk/models/custom-color-themes-settings-dto.rb +175 -0
- data/lib/docspace-api-sdk/models/custom-color-themes-settings-request-dto.rb +163 -0
- data/lib/docspace-api-sdk/models/custom-color-themes-settings-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/custom-field-request.rb +166 -0
- data/lib/docspace-api-sdk/models/custom-field-value-array-wrapper.rb +196 -0
- data/lib/docspace-api-sdk/models/custom-field-value-dto.rb +164 -0
- data/lib/docspace-api-sdk/models/custom-filter-request.rb +152 -0
- data/lib/docspace-api-sdk/models/customer-config-dto.rb +208 -0
- data/lib/docspace-api-sdk/models/customer-info-dto.rb +227 -0
- data/lib/docspace-api-sdk/models/customer-info-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/customer-monthly-usage-array-wrapper.rb +196 -0
- data/lib/docspace-api-sdk/models/customer-monthly-usage-dto.rb +193 -0
- data/lib/docspace-api-sdk/models/customer-monthly-usage-report-request-dto.rb +164 -0
- data/lib/docspace-api-sdk/models/customer-operations-report-request-dto.rb +273 -0
- data/lib/docspace-api-sdk/models/customer-service-usage-dto.rb +236 -0
- data/lib/docspace-api-sdk/models/customer-service-usage-report-dto.rb +205 -0
- data/lib/docspace-api-sdk/models/customer-service-usage-report-request-dto.rb +253 -0
- data/lib/docspace-api-sdk/models/customer-service-usage-report-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/customization-config-dto.rb +263 -0
- data/lib/docspace-api-sdk/models/dark-theme-settings-dto.rb +184 -0
- data/lib/docspace-api-sdk/models/dark-theme-settings-request-dto.rb +191 -0
- data/lib/docspace-api-sdk/models/dark-theme-settings-type.rb +44 -0
- data/lib/docspace-api-sdk/models/dark-theme-settings-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/date-to-auto-clean-up.rb +47 -0
- data/lib/docspace-api-sdk/models/deep-link-configuration-request-dto.rb +152 -0
- data/lib/docspace-api-sdk/models/deep-link-dto.rb +181 -0
- data/lib/docspace-api-sdk/models/deep-link-handling-mode.rb +44 -0
- data/lib/docspace-api-sdk/models/deep-link-settings-request-dto.rb +184 -0
- data/lib/docspace-api-sdk/models/default-product-request-dto.rb +191 -0
- data/lib/docspace-api-sdk/models/default-template-item-dto.rb +210 -0
- data/lib/docspace-api-sdk/models/default-template-settings-dto.rb +157 -0
- data/lib/docspace-api-sdk/models/default-template-settings-request-dto-selected-file.rb +108 -0
- data/lib/docspace-api-sdk/models/default-template-settings-request-dto.rb +181 -0
- data/lib/docspace-api-sdk/models/default-template-settings-reset-request-dto.rb +155 -0
- data/lib/docspace-api-sdk/models/default-template-settings-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/delete-batch-request-dto-all-of-file-ids.rb +106 -0
- data/lib/docspace-api-sdk/models/delete-batch-request-dto-all-of-folder-ids.rb +106 -0
- data/lib/docspace-api-sdk/models/delete-batch-request-dto.rb +205 -0
- data/lib/docspace-api-sdk/models/delete-file-request.rb +162 -0
- data/lib/docspace-api-sdk/models/delete-folder-request.rb +162 -0
- data/lib/docspace-api-sdk/models/delete-room-request.rb +152 -0
- data/lib/docspace-api-sdk/models/delete-version-batch-request-dto.rb +211 -0
- data/lib/docspace-api-sdk/models/discount-category-dto.rb +183 -0
- data/lib/docspace-api-sdk/models/display-request-dto.rb +152 -0
- data/lib/docspace-api-sdk/models/distributed-task-status.rb +46 -0
- data/lib/docspace-api-sdk/models/dns-settings-request-dto.rb +163 -0
- data/lib/docspace-api-sdk/models/doc-service-url-dto.rb +287 -0
- data/lib/docspace-api-sdk/models/doc-service-url-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/docs-cloud-config-dto.rb +217 -0
- data/lib/docspace-api-sdk/models/docs-cloud-config-request-dto.rb +217 -0
- data/lib/docspace-api-sdk/models/docs-cloud-config-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/docs-cloud-dev-pack-request-dto.rb +180 -0
- data/lib/docspace-api-sdk/models/docs-cloud-ip-filter-config-dto.rb +155 -0
- data/lib/docspace-api-sdk/models/docs-cloud-ip-filter-config-request.rb +155 -0
- data/lib/docspace-api-sdk/models/docs-cloud-ip-filter-rule-dto.rb +187 -0
- data/lib/docspace-api-sdk/models/docs-cloud-ip-filter-rule-request.rb +187 -0
- data/lib/docspace-api-sdk/models/docs-cloud-license-info-dto.rb +172 -0
- data/lib/docspace-api-sdk/models/docs-cloud-payment-dto.rb +224 -0
- data/lib/docspace-api-sdk/models/docs-cloud-quota-dto.rb +168 -0
- data/lib/docspace-api-sdk/models/docs-cloud-quota-user-dto.rb +164 -0
- data/lib/docspace-api-sdk/models/docs-cloud-quota-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/docs-cloud-security-config-dto.rb +212 -0
- data/lib/docspace-api-sdk/models/docs-cloud-security-config-request.rb +212 -0
- data/lib/docspace-api-sdk/models/docs-cloud-server-config-dto.rb +190 -0
- data/lib/docspace-api-sdk/models/docs-cloud-server-config-request.rb +190 -0
- data/lib/docspace-api-sdk/models/docs-cloud-server-info-dto.rb +174 -0
- data/lib/docspace-api-sdk/models/docs-cloud-stats-dto.rb +172 -0
- data/lib/docspace-api-sdk/models/docs-cloud-tenant-dto.rb +257 -0
- data/lib/docspace-api-sdk/models/docs-cloud-tenant-info-dto.rb +182 -0
- data/lib/docspace-api-sdk/models/docs-cloud-tenant-info-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/docs-cloud-tenant-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/docs-cloud-usage-dto.rb +162 -0
- data/lib/docspace-api-sdk/models/docs-cloud-usage-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/docs-cloud-user-stats-dto.rb +192 -0
- data/lib/docspace-api-sdk/models/docs-cloud-users-limit-dto.rb +162 -0
- data/lib/docspace-api-sdk/models/docs-cloud-wopi-config-dto.rb +152 -0
- data/lib/docspace-api-sdk/models/docs-cloud-wopi-config-request.rb +152 -0
- data/lib/docspace-api-sdk/models/document-builder-task-dto.rb +309 -0
- data/lib/docspace-api-sdk/models/document-builder-task-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/document-config-dto.rb +268 -0
- data/lib/docspace-api-sdk/models/document-options-dto.rb +152 -0
- data/lib/docspace-api-sdk/models/domain-name-rules-dto.rb +173 -0
- data/lib/docspace-api-sdk/models/double-nullable-wrapper.rb +195 -0
- data/lib/docspace-api-sdk/models/double-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/download-request-dto-all-of-file-ids.rb +106 -0
- data/lib/docspace-api-sdk/models/download-request-dto-all-of-folder-ids.rb +106 -0
- data/lib/docspace-api-sdk/models/download-request-dto.rb +198 -0
- data/lib/docspace-api-sdk/models/download-request-item-dto-key.rb +108 -0
- data/lib/docspace-api-sdk/models/download-request-item-dto.rb +192 -0
- data/lib/docspace-api-sdk/models/draft-location.rb +184 -0
- data/lib/docspace-api-sdk/models/duplicate-request-dto-all-of-file-ids.rb +106 -0
- data/lib/docspace-api-sdk/models/duplicate-request-dto-all-of-folder-ids.rb +106 -0
- data/lib/docspace-api-sdk/models/duplicate-request-dto.rb +185 -0
- data/lib/docspace-api-sdk/models/edit-history-array-wrapper.rb +196 -0
- data/lib/docspace-api-sdk/models/edit-history-author-dto.rb +166 -0
- data/lib/docspace-api-sdk/models/edit-history-changes-dto.rb +173 -0
- data/lib/docspace-api-sdk/models/edit-history-data-dto.rb +240 -0
- data/lib/docspace-api-sdk/models/edit-history-data-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/edit-history-dto.rb +238 -0
- data/lib/docspace-api-sdk/models/edit-history-url-dto.rb +175 -0
- data/lib/docspace-api-sdk/models/editor-configuration-dto.rb +289 -0
- data/lib/docspace-api-sdk/models/editor-tool-call-parameters-dto.rb +109 -0
- data/lib/docspace-api-sdk/models/editor-tool-call-state-dto.rb +182 -0
- data/lib/docspace-api-sdk/models/editor-type.rb +44 -0
- data/lib/docspace-api-sdk/models/email-activation-settings-dto.rb +162 -0
- data/lib/docspace-api-sdk/models/email-activation-settings-request-dto.rb +162 -0
- data/lib/docspace-api-sdk/models/email-activation-settings-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/email-invitation-dto.rb +168 -0
- data/lib/docspace-api-sdk/models/email-member-request-dto.rb +230 -0
- data/lib/docspace-api-sdk/models/embedded-config-dto.rb +197 -0
- data/lib/docspace-api-sdk/models/employee-activation-status.rb +45 -0
- data/lib/docspace-api-sdk/models/employee-array-wrapper.rb +196 -0
- data/lib/docspace-api-sdk/models/employee-dto.rb +249 -0
- data/lib/docspace-api-sdk/models/employee-full-array-wrapper.rb +196 -0
- data/lib/docspace-api-sdk/models/employee-full-dto.rb +637 -0
- data/lib/docspace-api-sdk/models/employee-full-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/employee-status.rb +46 -0
- data/lib/docspace-api-sdk/models/employee-type.rb +46 -0
- data/lib/docspace-api-sdk/models/employee-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/enabled-module-array-wrapper.rb +196 -0
- data/lib/docspace-api-sdk/models/enabled-module-dto.rb +164 -0
- data/lib/docspace-api-sdk/models/encryption-key-array-wrapper.rb +196 -0
- data/lib/docspace-api-sdk/models/encryption-key-dto.rb +205 -0
- data/lib/docspace-api-sdk/models/encryption-key-request-dto.rb +174 -0
- data/lib/docspace-api-sdk/models/encryption-settings-dto.rb +195 -0
- data/lib/docspace-api-sdk/models/encryption-settings-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/encryption-status.rb +45 -0
- data/lib/docspace-api-sdk/models/entity-quota-dto.rb +173 -0
- data/lib/docspace-api-sdk/models/entity-quota-settings-dto.rb +189 -0
- data/lib/docspace-api-sdk/models/entity-quota-settings-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/entry-field-dto.rb +228 -0
- data/lib/docspace-api-sdk/models/entry-metadata-dto.rb +168 -0
- data/lib/docspace-api-sdk/models/entry-metadata-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/entry-template-dto.rb +228 -0
- data/lib/docspace-api-sdk/models/entry-type.rb +49 -0
- data/lib/docspace-api-sdk/models/error-api-response-error.rb +182 -0
- data/lib/docspace-api-sdk/models/error-api-response.rb +171 -0
- data/lib/docspace-api-sdk/models/exchange-token200-response.rb +181 -0
- data/lib/docspace-api-sdk/models/external-database-connection-request-dto.rb +260 -0
- data/lib/docspace-api-sdk/models/external-database-type.rb +43 -0
- data/lib/docspace-api-sdk/models/external-db-sync-form-result-dto.rb +184 -0
- data/lib/docspace-api-sdk/models/external-db-sync-task-dto.rb +284 -0
- data/lib/docspace-api-sdk/models/external-db-sync-task-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/external-resource-dto.rb +165 -0
- data/lib/docspace-api-sdk/models/external-resources-dto.rb +242 -0
- data/lib/docspace-api-sdk/models/external-share-dto.rb +384 -0
- data/lib/docspace-api-sdk/models/external-share-request-param.rb +153 -0
- data/lib/docspace-api-sdk/models/external-share-status.rb +47 -0
- data/lib/docspace-api-sdk/models/external-share-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/external-sharing-settings-dto.rb +192 -0
- data/lib/docspace-api-sdk/models/external-sharing-settings-request-dto.rb +192 -0
- data/lib/docspace-api-sdk/models/external-sharing-settings-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/feature-used-dto.rb +165 -0
- data/lib/docspace-api-sdk/models/feedback-config-dto.rb +163 -0
- data/lib/docspace-api-sdk/models/field-error.rb +172 -0
- data/lib/docspace-api-sdk/models/file-array-wrapper.rb +196 -0
- data/lib/docspace-api-sdk/models/file-conflict-resolve-type.rb +44 -0
- data/lib/docspace-api-sdk/models/file-dto-all-of-view-accessibility.rb +232 -0
- data/lib/docspace-api-sdk/models/file-dto.rb +927 -0
- data/lib/docspace-api-sdk/models/file-encryption-info-dto.rb +168 -0
- data/lib/docspace-api-sdk/models/file-encryption-info-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/file-entry-array-wrapper.rb +196 -0
- data/lib/docspace-api-sdk/models/file-entry-base-array-wrapper.rb +196 -0
- data/lib/docspace-api-sdk/models/file-entry-base-dto.rb +391 -0
- data/lib/docspace-api-sdk/models/file-entry-base-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/file-entry-dto.rb +562 -0
- data/lib/docspace-api-sdk/models/file-entry-type.rb +43 -0
- data/lib/docspace-api-sdk/models/file-keys-dto.rb +203 -0
- data/lib/docspace-api-sdk/models/file-link-dto.rb +179 -0
- data/lib/docspace-api-sdk/models/file-link-request.rb +294 -0
- data/lib/docspace-api-sdk/models/file-link-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/file-operation-array-wrapper.rb +196 -0
- data/lib/docspace-api-sdk/models/file-operation-dto.rb +331 -0
- data/lib/docspace-api-sdk/models/file-operation-request-base-dto.rb +152 -0
- data/lib/docspace-api-sdk/models/file-operation-type.rb +50 -0
- data/lib/docspace-api-sdk/models/file-operation-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/file-reference-data-dto.rb +185 -0
- data/lib/docspace-api-sdk/models/file-reference-dto.rb +229 -0
- data/lib/docspace-api-sdk/models/file-reference-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/file-share-array-wrapper.rb +196 -0
- data/lib/docspace-api-sdk/models/file-share-dto.rb +430 -0
- data/lib/docspace-api-sdk/models/file-share-link.rb +303 -0
- data/lib/docspace-api-sdk/models/file-share-params.rb +220 -0
- data/lib/docspace-api-sdk/models/file-share-response-array-wrapper.rb +196 -0
- data/lib/docspace-api-sdk/models/file-share-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/file-share.rb +53 -0
- data/lib/docspace-api-sdk/models/file-status.rb +51 -0
- data/lib/docspace-api-sdk/models/file-type.rb +51 -0
- data/lib/docspace-api-sdk/models/file-upload-result-dto.rb +173 -0
- data/lib/docspace-api-sdk/models/file-upload-result-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/file-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/files-settings-dto-internal-formats.rb +232 -0
- data/lib/docspace-api-sdk/models/files-settings-dto.rb +892 -0
- data/lib/docspace-api-sdk/models/files-settings-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/files-statistics-folder.rb +163 -0
- data/lib/docspace-api-sdk/models/files-statistics-result-dto.rb +202 -0
- data/lib/docspace-api-sdk/models/files-statistics-result-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/filling-form-result-dto.rb +236 -0
- data/lib/docspace-api-sdk/models/filling-form-result-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/filter-type.rb +62 -0
- data/lib/docspace-api-sdk/models/finish-dto.rb +169 -0
- data/lib/docspace-api-sdk/models/firebase-device-dto.rb +205 -0
- data/lib/docspace-api-sdk/models/firebase-device-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/firebase-dto.rb +246 -0
- data/lib/docspace-api-sdk/models/firebase-request-dto.rb +163 -0
- data/lib/docspace-api-sdk/models/folder-array-wrapper.rb +196 -0
- data/lib/docspace-api-sdk/models/folder-content-array-wrapper.rb +196 -0
- data/lib/docspace-api-sdk/models/folder-content-dto.rb +247 -0
- data/lib/docspace-api-sdk/models/folder-content-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/folder-dto.rb +838 -0
- data/lib/docspace-api-sdk/models/folder-link-request.rb +294 -0
- data/lib/docspace-api-sdk/models/folder-metadata-search.rb +328 -0
- data/lib/docspace-api-sdk/models/folder-type.rb +72 -0
- data/lib/docspace-api-sdk/models/folder-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/form-filling-manage-action.rb +45 -0
- data/lib/docspace-api-sdk/models/form-filling-status.rb +47 -0
- data/lib/docspace-api-sdk/models/form-gallery-dto.rb +233 -0
- data/lib/docspace-api-sdk/models/form-metadata-dto.rb +188 -0
- data/lib/docspace-api-sdk/models/form-results-dto.rb +165 -0
- data/lib/docspace-api-sdk/models/form-role-array-wrapper.rb +196 -0
- data/lib/docspace-api-sdk/models/form-role-dto.rb +284 -0
- data/lib/docspace-api-sdk/models/form-role-request.rb +224 -0
- data/lib/docspace-api-sdk/models/form-submissions-dto.rb +168 -0
- data/lib/docspace-api-sdk/models/form-submissions-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/forms-item-array-wrapper.rb +196 -0
- data/lib/docspace-api-sdk/models/forms-item-data-dto.rb +186 -0
- data/lib/docspace-api-sdk/models/forms-item-dto.rb +164 -0
- data/lib/docspace-api-sdk/models/generate-docx-tool-call-parameters-dto.rb +155 -0
- data/lib/docspace-api-sdk/models/generate-form-tool-call-parameters-dto.rb +155 -0
- data/lib/docspace-api-sdk/models/generate-presentation-tool-call-parameters-dto.rb +175 -0
- data/lib/docspace-api-sdk/models/get-portal-prices200-response-links-inner.rb +161 -0
- data/lib/docspace-api-sdk/models/get-portal-prices200-response.rb +196 -0
- data/lib/docspace-api-sdk/models/get-reference-data-dto.rb +200 -0
- data/lib/docspace-api-sdk/models/goback-config-dto.rb +153 -0
- data/lib/docspace-api-sdk/models/greeting-settings-request-dto.rb +179 -0
- data/lib/docspace-api-sdk/models/group-array-wrapper.rb +196 -0
- data/lib/docspace-api-sdk/models/group-dto.rb +302 -0
- data/lib/docspace-api-sdk/models/group-member-security-array-wrapper.rb +196 -0
- data/lib/docspace-api-sdk/models/group-member-security-dto.rb +309 -0
- data/lib/docspace-api-sdk/models/group-request-dto.rb +202 -0
- data/lib/docspace-api-sdk/models/group-summary-array-wrapper.rb +196 -0
- data/lib/docspace-api-sdk/models/group-summary-dto.rb +204 -0
- data/lib/docspace-api-sdk/models/group-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/hide-confirm-convert-request-dto.rb +152 -0
- data/lib/docspace-api-sdk/models/history-action-dto.rb +185 -0
- data/lib/docspace-api-sdk/models/history-array-wrapper.rb +196 -0
- data/lib/docspace-api-sdk/models/history-data-dto.rb +153 -0
- data/lib/docspace-api-sdk/models/history-dto.rb +273 -0
- data/lib/docspace-api-sdk/models/i-compress-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/icon-request.rb +153 -0
- data/lib/docspace-api-sdk/models/image-size-dto.rb +162 -0
- data/lib/docspace-api-sdk/models/importable-api-entity.rb +152 -0
- data/lib/docspace-api-sdk/models/info-config-dto.rb +231 -0
- data/lib/docspace-api-sdk/models/int32-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/int64-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/invitation-link-create-request-dto.rb +237 -0
- data/lib/docspace-api-sdk/models/invitation-link-delete-request-dto.rb +169 -0
- data/lib/docspace-api-sdk/models/invitation-link-dto.rb +253 -0
- data/lib/docspace-api-sdk/models/invitation-link-update-request-dto.rb +215 -0
- data/lib/docspace-api-sdk/models/invitation-link-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/invite-users-request-dto.rb +182 -0
- data/lib/docspace-api-sdk/models/ip-restriction-array-wrapper.rb +196 -0
- data/lib/docspace-api-sdk/models/ip-restriction-dto.rb +185 -0
- data/lib/docspace-api-sdk/models/ip-restriction-entry-dto.rb +165 -0
- data/lib/docspace-api-sdk/models/ip-restrictions-dto.rb +168 -0
- data/lib/docspace-api-sdk/models/ip-restrictions-settings-dto.rb +162 -0
- data/lib/docspace-api-sdk/models/ip-restrictions-settings-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/ip-restrictions-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/is-default-white-label-logos-array-wrapper.rb +196 -0
- data/lib/docspace-api-sdk/models/is-default-white-label-logos-dto.rb +182 -0
- data/lib/docspace-api-sdk/models/is-default-white-label-logos-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/item-key-value-pair-boolean-string-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/item-key-value-pair-boolean-string.rb +163 -0
- data/lib/docspace-api-sdk/models/item-key-value-pair-object-object.rb +162 -0
- data/lib/docspace-api-sdk/models/item-key-value-pair-string-boolean.rb +163 -0
- data/lib/docspace-api-sdk/models/item-key-value-pair-string-logo-request-dto.rb +163 -0
- data/lib/docspace-api-sdk/models/item-key-value-pair-string-string.rb +164 -0
- data/lib/docspace-api-sdk/models/json-value-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/licensor-details-array-wrapper.rb +196 -0
- data/lib/docspace-api-sdk/models/licensor-details-dto.rb +347 -0
- data/lib/docspace-api-sdk/models/licensor-details-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/link-account-request-dto.rb +153 -0
- data/lib/docspace-api-sdk/models/link-type.rb +43 -0
- data/lib/docspace-api-sdk/models/location-type.rb +49 -0
- data/lib/docspace-api-sdk/models/lock-file-request.rb +152 -0
- data/lib/docspace-api-sdk/models/login-event-array-wrapper.rb +196 -0
- data/lib/docspace-api-sdk/models/login-event-dto.rb +303 -0
- data/lib/docspace-api-sdk/models/login-provider.rb +56 -0
- data/lib/docspace-api-sdk/models/login-settings-dto.rb +250 -0
- data/lib/docspace-api-sdk/models/login-settings-request-dto.rb +256 -0
- data/lib/docspace-api-sdk/models/login-settings-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/logo-config-dto.rb +207 -0
- data/lib/docspace-api-sdk/models/logo-cover-dto.rb +168 -0
- data/lib/docspace-api-sdk/models/logo-dto.rb +215 -0
- data/lib/docspace-api-sdk/models/logo-request-dto.rb +164 -0
- data/lib/docspace-api-sdk/models/logo-request.rb +330 -0
- data/lib/docspace-api-sdk/models/mail-domain-settings-request-dto.rb +233 -0
- data/lib/docspace-api-sdk/models/manage-form-filling-dto.rb +201 -0
- data/lib/docspace-api-sdk/models/member-request-dto.rb +424 -0
- data/lib/docspace-api-sdk/models/members-request.rb +155 -0
- data/lib/docspace-api-sdk/models/mention-array-wrapper.rb +196 -0
- data/lib/docspace-api-sdk/models/mention-dto.rb +206 -0
- data/lib/docspace-api-sdk/models/mention-message-request.rb +200 -0
- data/lib/docspace-api-sdk/models/message-action.rb +403 -0
- data/lib/docspace-api-sdk/models/metadata-conflict-resolve-type.rb +43 -0
- data/lib/docspace-api-sdk/models/metadata-field-dto.rb +228 -0
- data/lib/docspace-api-sdk/models/metadata-field-option-dto.rb +163 -0
- data/lib/docspace-api-sdk/models/metadata-field-option-request.rb +164 -0
- data/lib/docspace-api-sdk/models/metadata-field-request.rb +209 -0
- data/lib/docspace-api-sdk/models/metadata-field-type.rb +46 -0
- data/lib/docspace-api-sdk/models/metadata-field-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/metadata-filter-condition-request.rb +220 -0
- data/lib/docspace-api-sdk/models/metadata-match-dto.rb +186 -0
- data/lib/docspace-api-sdk/models/metadata-operation-dto.rb +197 -0
- data/lib/docspace-api-sdk/models/metadata-operation-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/metadata-template-array-wrapper.rb +196 -0
- data/lib/docspace-api-sdk/models/metadata-template-dto.rb +226 -0
- data/lib/docspace-api-sdk/models/metadata-template-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/metadata-value-dto.rb +187 -0
- data/lib/docspace-api-sdk/models/metadata-value-request.rb +215 -0
- data/lib/docspace-api-sdk/models/migrating-api-files.rb +172 -0
- data/lib/docspace-api-sdk/models/migrating-api-group.rb +194 -0
- data/lib/docspace-api-sdk/models/migrating-api-user.rb +256 -0
- data/lib/docspace-api-sdk/models/migration-api-info.rb +335 -0
- data/lib/docspace-api-sdk/models/migration-status-dto.rb +183 -0
- data/lib/docspace-api-sdk/models/migration-status-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/mobile-phone-activation-status.rb +43 -0
- data/lib/docspace-api-sdk/models/mobile-request-dto.rb +153 -0
- data/lib/docspace-api-sdk/models/model-module.rb +239 -0
- data/lib/docspace-api-sdk/models/module-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/multi-size-logo-cover-dto.rb +184 -0
- data/lib/docspace-api-sdk/models/new-items-dto-file-entry-base-dto.rb +184 -0
- data/lib/docspace-api-sdk/models/new-items-dto-room-new-items-dto.rb +184 -0
- data/lib/docspace-api-sdk/models/new-items-file-entry-base-array-wrapper.rb +196 -0
- data/lib/docspace-api-sdk/models/new-items-room-new-items-array-wrapper.rb +196 -0
- data/lib/docspace-api-sdk/models/notification-channel-dto.rb +182 -0
- data/lib/docspace-api-sdk/models/notification-channel-status-dto.rb +155 -0
- data/lib/docspace-api-sdk/models/notification-channel-status-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/notification-settings-dto.rb +184 -0
- data/lib/docspace-api-sdk/models/notification-settings-request-dto.rb +201 -0
- data/lib/docspace-api-sdk/models/notification-settings-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/notification-type.rb +45 -0
- data/lib/docspace-api-sdk/models/object-array-wrapper.rb +196 -0
- data/lib/docspace-api-sdk/models/operation-dto.rb +345 -0
- data/lib/docspace-api-sdk/models/operation-order-type.rb +43 -0
- data/lib/docspace-api-sdk/models/operation-status.rb +45 -0
- data/lib/docspace-api-sdk/models/operation-token-usage-dto.rb +212 -0
- data/lib/docspace-api-sdk/models/operation-type.rb +61 -0
- data/lib/docspace-api-sdk/models/order-by-dto.rb +184 -0
- data/lib/docspace-api-sdk/models/order-request-dto.rb +180 -0
- data/lib/docspace-api-sdk/models/orders-item-request-dto.rb +263 -0
- data/lib/docspace-api-sdk/models/orders-request-dto.rb +157 -0
- data/lib/docspace-api-sdk/models/owner-change-instructions-dto.rb +163 -0
- data/lib/docspace-api-sdk/models/owner-change-instructions-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/owner-id-settings-request-dto.rb +169 -0
- data/lib/docspace-api-sdk/models/pageable-client-info-response.rb +184 -0
- data/lib/docspace-api-sdk/models/pageable-client-response.rb +184 -0
- data/lib/docspace-api-sdk/models/pageable-modification-response.rb +172 -0
- data/lib/docspace-api-sdk/models/pageable-response.rb +182 -0
- data/lib/docspace-api-sdk/models/password-hash-settings-dto.rb +173 -0
- data/lib/docspace-api-sdk/models/password-settings-dto.rb +302 -0
- data/lib/docspace-api-sdk/models/password-settings-request-dto.rb +199 -0
- data/lib/docspace-api-sdk/models/password-settings-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/payment-calculation-dto.rb +183 -0
- data/lib/docspace-api-sdk/models/payment-calculation-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/payment-method-status.rb +44 -0
- data/lib/docspace-api-sdk/models/payment-settings-dto.rb +260 -0
- data/lib/docspace-api-sdk/models/payment-settings-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/payment-url-request-dto.rb +279 -0
- data/lib/docspace-api-sdk/models/payments.rb +43 -0
- data/lib/docspace-api-sdk/models/permissions-config-dto.rb +242 -0
- data/lib/docspace-api-sdk/models/plugins-config-dto.rb +155 -0
- data/lib/docspace-api-sdk/models/plugins-dto.rb +172 -0
- data/lib/docspace-api-sdk/models/portal-user-dto.rb +496 -0
- data/lib/docspace-api-sdk/models/portal-user-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/price-dto.rb +175 -0
- data/lib/docspace-api-sdk/models/price-status.rb +44 -0
- data/lib/docspace-api-sdk/models/price-time-unit.rb +48 -0
- data/lib/docspace-api-sdk/models/problem-detail.rb +216 -0
- data/lib/docspace-api-sdk/models/product-administrator-dto.rb +223 -0
- data/lib/docspace-api-sdk/models/product-administrator-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/product-quantity-type.rb +45 -0
- data/lib/docspace-api-sdk/models/product-type.rb +45 -0
- data/lib/docspace-api-sdk/models/provider-array-wrapper.rb +196 -0
- data/lib/docspace-api-sdk/models/provider-dto.rb +216 -0
- data/lib/docspace-api-sdk/models/provider-filter.rb +51 -0
- data/lib/docspace-api-sdk/models/quantity-request-dto.rb +189 -0
- data/lib/docspace-api-sdk/models/quota-array-wrapper.rb +196 -0
- data/lib/docspace-api-sdk/models/quota-dto.rb +354 -0
- data/lib/docspace-api-sdk/models/quota-filter.rb +44 -0
- data/lib/docspace-api-sdk/models/quota-scope.rb +44 -0
- data/lib/docspace-api-sdk/models/quota-settings-request-dto-default-quota.rb +108 -0
- data/lib/docspace-api-sdk/models/quota-settings-request-dto.rb +178 -0
- data/lib/docspace-api-sdk/models/quota-state.rb +43 -0
- data/lib/docspace-api-sdk/models/quota-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/recaptcha-type.rb +45 -0
- data/lib/docspace-api-sdk/models/recent-config-dto.rb +175 -0
- data/lib/docspace-api-sdk/models/reg-status.rb +44 -0
- data/lib/docspace-api-sdk/models/report-dto.rb +205 -0
- data/lib/docspace-api-sdk/models/report-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/request-location.rb +44 -0
- data/lib/docspace-api-sdk/models/restricted-ai-models-dto.rb +157 -0
- data/lib/docspace-api-sdk/models/restricted-ai-models-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/review-config-dto.rb +153 -0
- data/lib/docspace-api-sdk/models/room-data-lifetime-dto.rb +230 -0
- data/lib/docspace-api-sdk/models/room-data-lifetime-period.rb +44 -0
- data/lib/docspace-api-sdk/models/room-from-template-status-dto.rb +236 -0
- data/lib/docspace-api-sdk/models/room-from-template-status-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/room-group-array-wrapper.rb +196 -0
- data/lib/docspace-api-sdk/models/room-group-dto.rb +238 -0
- data/lib/docspace-api-sdk/models/room-group-request-dto.rb +293 -0
- data/lib/docspace-api-sdk/models/room-group-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/room-invitation-request.rb +197 -0
- data/lib/docspace-api-sdk/models/room-invitation.rb +220 -0
- data/lib/docspace-api-sdk/models/room-link-request.rb +339 -0
- data/lib/docspace-api-sdk/models/room-new-items-dto.rb +165 -0
- data/lib/docspace-api-sdk/models/room-privacy-filter.rb +44 -0
- data/lib/docspace-api-sdk/models/room-security-dto.rb +198 -0
- data/lib/docspace-api-sdk/models/room-security-error.rb +43 -0
- data/lib/docspace-api-sdk/models/room-security-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/room-template-dto.rb +364 -0
- data/lib/docspace-api-sdk/models/room-template-status-dto.rb +234 -0
- data/lib/docspace-api-sdk/models/room-template-status-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/room-type.rb +47 -0
- data/lib/docspace-api-sdk/models/rooms-metadata-search-request-dto.rb +330 -0
- data/lib/docspace-api-sdk/models/rooms-notification-settings-dto.rb +155 -0
- data/lib/docspace-api-sdk/models/rooms-notification-settings-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/rooms-notifications-settings-request-dto.rb +162 -0
- data/lib/docspace-api-sdk/models/run-builder-script-output-request.rb +175 -0
- data/lib/docspace-api-sdk/models/run-builder-script-request-dto-argument.rb +108 -0
- data/lib/docspace-api-sdk/models/run-builder-script-request-dto.rb +211 -0
- data/lib/docspace-api-sdk/models/sales-request-dto.rb +277 -0
- data/lib/docspace-api-sdk/models/save-additional-resources-request.rb +212 -0
- data/lib/docspace-api-sdk/models/save-as-pdf-request.rb +182 -0
- data/lib/docspace-api-sdk/models/save-auth-keys-request-dto.rb +219 -0
- data/lib/docspace-api-sdk/models/save-company-info-request.rb +347 -0
- data/lib/docspace-api-sdk/models/save-form-role-mapping-dto.rb +184 -0
- data/lib/docspace-api-sdk/models/schedule-dto.rb +312 -0
- data/lib/docspace-api-sdk/models/schedule-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/scope-response.rb +172 -0
- data/lib/docspace-api-sdk/models/search-area.rb +51 -0
- data/lib/docspace-api-sdk/models/security-array-wrapper.rb +196 -0
- data/lib/docspace-api-sdk/models/security-dto.rb +199 -0
- data/lib/docspace-api-sdk/models/security-info-request-dto.rb +226 -0
- data/lib/docspace-api-sdk/models/security-info-simple-request-dto.rb +200 -0
- data/lib/docspace-api-sdk/models/security-request-dto.rb +206 -0
- data/lib/docspace-api-sdk/models/service-price-array-wrapper.rb +196 -0
- data/lib/docspace-api-sdk/models/service-price-dto.rb +296 -0
- data/lib/docspace-api-sdk/models/session-request.rb +206 -0
- data/lib/docspace-api-sdk/models/set-app-enabled-request.rb +169 -0
- data/lib/docspace-api-sdk/models/set-app-settings-request.rb +152 -0
- data/lib/docspace-api-sdk/models/set-audit-lifetime-settings-request.rb +172 -0
- data/lib/docspace-api-sdk/models/set-custom-fields.rb +171 -0
- data/lib/docspace-api-sdk/models/set-manager-request.rb +169 -0
- data/lib/docspace-api-sdk/models/set-metadata-values.rb +171 -0
- data/lib/docspace-api-sdk/models/set-public-dto.rb +197 -0
- data/lib/docspace-api-sdk/models/set-restricted-ai-models-request-dto.rb +171 -0
- data/lib/docspace-api-sdk/models/set-wallet-top-up-settings-request.rb +269 -0
- data/lib/docspace-api-sdk/models/settings-dto.rb +684 -0
- data/lib/docspace-api-sdk/models/settings-request-dto.rb +152 -0
- data/lib/docspace-api-sdk/models/settings-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/share-filter-type.rb +49 -0
- data/lib/docspace-api-sdk/models/signup-account-request-dto.rb +211 -0
- data/lib/docspace-api-sdk/models/smtp-operation-status-dto.rb +195 -0
- data/lib/docspace-api-sdk/models/smtp-operation-status-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/smtp-settings-dto.rb +368 -0
- data/lib/docspace-api-sdk/models/smtp-settings-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/socket-settings-dto.rb +153 -0
- data/lib/docspace-api-sdk/models/socket-settings-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/sort-order.rb +43 -0
- data/lib/docspace-api-sdk/models/sorted-by-type.rb +54 -0
- data/lib/docspace-api-sdk/models/sso-binding-type-dto.rb +164 -0
- data/lib/docspace-api-sdk/models/sso-certificate-dto.rb +216 -0
- data/lib/docspace-api-sdk/models/sso-encrypt-algorithm-type-dto.rb +175 -0
- data/lib/docspace-api-sdk/models/sso-field-mapping-dto.rb +208 -0
- data/lib/docspace-api-sdk/models/sso-idp-certificate-action-type-dto.rb +175 -0
- data/lib/docspace-api-sdk/models/sso-idp-certificate-advanced-dto.rb +204 -0
- data/lib/docspace-api-sdk/models/sso-idp-settings-dto.rb +208 -0
- data/lib/docspace-api-sdk/models/sso-name-id-format-type-dto.rb +252 -0
- data/lib/docspace-api-sdk/models/sso-settings-constants-dto.rb +202 -0
- data/lib/docspace-api-sdk/models/sso-settings-constants-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/sso-settings-dto.rb +270 -0
- data/lib/docspace-api-sdk/models/sso-settings-request-dto.rb +155 -0
- data/lib/docspace-api-sdk/models/sso-settings-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/sso-signing-algorithm-type-dto.rb +175 -0
- data/lib/docspace-api-sdk/models/sso-sp-certificate-action-type-dto.rb +175 -0
- data/lib/docspace-api-sdk/models/sso-sp-certificate-advanced-dto.rb +215 -0
- data/lib/docspace-api-sdk/models/start-backup-request-dto.rb +197 -0
- data/lib/docspace-api-sdk/models/start-backup-restore-request-dto.rb +220 -0
- data/lib/docspace-api-sdk/models/start-edit-request.rb +152 -0
- data/lib/docspace-api-sdk/models/start-filling-form.rb +153 -0
- data/lib/docspace-api-sdk/models/start-filling-mode.rb +45 -0
- data/lib/docspace-api-sdk/models/start-reassign-request-dto.rb +206 -0
- data/lib/docspace-api-sdk/models/start-update-user-type-dto.rb +195 -0
- data/lib/docspace-api-sdk/models/storage-array-wrapper.rb +196 -0
- data/lib/docspace-api-sdk/models/storage-dto.rb +235 -0
- data/lib/docspace-api-sdk/models/storage-encryption-request-dto.rb +152 -0
- data/lib/docspace-api-sdk/models/storage-filter.rb +44 -0
- data/lib/docspace-api-sdk/models/storage-request-dto.rb +168 -0
- data/lib/docspace-api-sdk/models/storage-settings-dto.rb +175 -0
- data/lib/docspace-api-sdk/models/storage-settings-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/string-array-wrapper.rb +196 -0
- data/lib/docspace-api-sdk/models/string-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/studio-default-page-settings-dto.rb +184 -0
- data/lib/docspace-api-sdk/models/studio-default-page-settings-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/sub-account-dto.rb +163 -0
- data/lib/docspace-api-sdk/models/subject-type.rb +46 -0
- data/lib/docspace-api-sdk/models/submit-form-dto.rb +163 -0
- data/lib/docspace-api-sdk/models/subscription-balance-dto.rb +234 -0
- data/lib/docspace-api-sdk/models/subscription-balance-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/tariff-dto.rb +271 -0
- data/lib/docspace-api-sdk/models/tariff-quota-dto.rb +246 -0
- data/lib/docspace-api-sdk/models/tariff-state.rb +45 -0
- data/lib/docspace-api-sdk/models/tariff-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/task-progress-response-dto.rb +269 -0
- data/lib/docspace-api-sdk/models/task-progress-response-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/telegram-status-dto.rb +202 -0
- data/lib/docspace-api-sdk/models/telegram-status-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/templates-config-dto.rb +175 -0
- data/lib/docspace-api-sdk/models/templates-request-dto.rb +155 -0
- data/lib/docspace-api-sdk/models/tenant-ai-access-settings-dto.rb +162 -0
- data/lib/docspace-api-sdk/models/tenant-ai-access-settings-request-dto.rb +152 -0
- data/lib/docspace-api-sdk/models/tenant-ai-access-settings-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/tenant-audit-settings-dto.rb +172 -0
- data/lib/docspace-api-sdk/models/tenant-audit-settings-request-dto.rb +152 -0
- data/lib/docspace-api-sdk/models/tenant-audit-settings-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/tenant-banner-settings-dto.rb +162 -0
- data/lib/docspace-api-sdk/models/tenant-banner-settings-request-dto.rb +152 -0
- data/lib/docspace-api-sdk/models/tenant-banner-settings-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/tenant-deep-link-settings-dto.rb +184 -0
- data/lib/docspace-api-sdk/models/tenant-deep-link-settings-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/tenant-dev-tools-access-settings-dto.rb +162 -0
- data/lib/docspace-api-sdk/models/tenant-dev-tools-access-settings-request-dto.rb +152 -0
- data/lib/docspace-api-sdk/models/tenant-dev-tools-access-settings-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/tenant-dto.rb +418 -0
- data/lib/docspace-api-sdk/models/tenant-industry.rb +58 -0
- data/lib/docspace-api-sdk/models/tenant-quota-dto.rb +610 -0
- data/lib/docspace-api-sdk/models/tenant-quota-feature-dto.rb +217 -0
- data/lib/docspace-api-sdk/models/tenant-quota-settings-dto.rb +183 -0
- data/lib/docspace-api-sdk/models/tenant-quota-settings-request-dto.rb +179 -0
- data/lib/docspace-api-sdk/models/tenant-quota-settings-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/tenant-quota-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/tenant-status.rb +49 -0
- data/lib/docspace-api-sdk/models/tenant-trusted-domains-type.rb +44 -0
- data/lib/docspace-api-sdk/models/tenant-user-invitation-settings-dto.rb +196 -0
- data/lib/docspace-api-sdk/models/tenant-user-invitation-settings-request-dto.rb +162 -0
- data/lib/docspace-api-sdk/models/tenant-user-invitation-settings-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/tenant-wallet-service-settings-dto.rb +187 -0
- data/lib/docspace-api-sdk/models/tenant-wallet-service-settings-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/tenant-wallet-service.rb +48 -0
- data/lib/docspace-api-sdk/models/tenant-wallet-settings-dto.rb +213 -0
- data/lib/docspace-api-sdk/models/tenant-wallet-settings-request-dto.rb +152 -0
- data/lib/docspace-api-sdk/models/tenant-wallet-settings-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/tenant-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/terminate-request-dto.rb +169 -0
- data/lib/docspace-api-sdk/models/tfa-app-code-array-wrapper.rb +196 -0
- data/lib/docspace-api-sdk/models/tfa-app-code-dto.rb +163 -0
- data/lib/docspace-api-sdk/models/tfa-confirm-data-dto.rb +175 -0
- data/lib/docspace-api-sdk/models/tfa-confirm-data-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/tfa-request-dto.rb +223 -0
- data/lib/docspace-api-sdk/models/tfa-settings-array-wrapper.rb +196 -0
- data/lib/docspace-api-sdk/models/tfa-settings-dto.rb +261 -0
- data/lib/docspace-api-sdk/models/tfa-setup-code-dto.rb +175 -0
- data/lib/docspace-api-sdk/models/tfa-setup-code-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/tfa-type.rb +44 -0
- data/lib/docspace-api-sdk/models/tfa-validate-request-dto.rb +165 -0
- data/lib/docspace-api-sdk/models/third-party-account-array-wrapper.rb +196 -0
- data/lib/docspace-api-sdk/models/third-party-account-dto.rb +195 -0
- data/lib/docspace-api-sdk/models/third-party-backup-request-dto.rb +208 -0
- data/lib/docspace-api-sdk/models/third-party-check-conversion-request-dto.rb +215 -0
- data/lib/docspace-api-sdk/models/third-party-chunked-upload-session-dto.rb +207 -0
- data/lib/docspace-api-sdk/models/third-party-chunked-upload-session-result-dto.rb +162 -0
- data/lib/docspace-api-sdk/models/third-party-chunked-upload-session-result-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/third-party-chunked-upload-session-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/third-party-configuration-dto.rb +394 -0
- data/lib/docspace-api-sdk/models/third-party-configuration-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/third-party-draft-location.rb +186 -0
- data/lib/docspace-api-sdk/models/third-party-file-array-wrapper.rb +196 -0
- data/lib/docspace-api-sdk/models/third-party-file-dto.rb +928 -0
- data/lib/docspace-api-sdk/models/third-party-file-entry-dto.rb +566 -0
- data/lib/docspace-api-sdk/models/third-party-file-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/third-party-folder-array-wrapper.rb +196 -0
- data/lib/docspace-api-sdk/models/third-party-folder-content-dto.rb +247 -0
- data/lib/docspace-api-sdk/models/third-party-folder-content-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/third-party-folder-dto.rb +839 -0
- data/lib/docspace-api-sdk/models/third-party-folder-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/third-party-request-dto.rb +223 -0
- data/lib/docspace-api-sdk/models/third-party-save-as-pdf-request.rb +168 -0
- data/lib/docspace-api-sdk/models/third-party-upload-session-response-dto.rb +216 -0
- data/lib/docspace-api-sdk/models/third-party-upload-session-response-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/thumbnail.rb +46 -0
- data/lib/docspace-api-sdk/models/thumbnails-data-dto.rb +208 -0
- data/lib/docspace-api-sdk/models/thumbnails-data-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/thumbnails-request.rb +193 -0
- data/lib/docspace-api-sdk/models/time-bound-dto.rb +163 -0
- data/lib/docspace-api-sdk/models/timezone-array-wrapper.rb +196 -0
- data/lib/docspace-api-sdk/models/timezone-dto.rb +168 -0
- data/lib/docspace-api-sdk/models/token-diagnostics-dto.rb +166 -0
- data/lib/docspace-api-sdk/models/token-diagnostics-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/top-up-deposit-request-dto.rb +215 -0
- data/lib/docspace-api-sdk/models/transaction-info-dto.rb +173 -0
- data/lib/docspace-api-sdk/models/turn-on-admin-message-settings-request-dto.rb +152 -0
- data/lib/docspace-api-sdk/models/upcoming-payment-array-wrapper.rb +196 -0
- data/lib/docspace-api-sdk/models/upcoming-payment-dto.rb +236 -0
- data/lib/docspace-api-sdk/models/update-api-key-request.rb +212 -0
- data/lib/docspace-api-sdk/models/update-client-request.rb +424 -0
- data/lib/docspace-api-sdk/models/update-comment-request.rb +222 -0
- data/lib/docspace-api-sdk/models/update-file-request.rb +187 -0
- data/lib/docspace-api-sdk/models/update-folder-metadata-template-request.rb +184 -0
- data/lib/docspace-api-sdk/models/update-group-request.rb +213 -0
- data/lib/docspace-api-sdk/models/update-member-culture-request.rb +187 -0
- data/lib/docspace-api-sdk/models/update-member-request-dto.rb +350 -0
- data/lib/docspace-api-sdk/models/update-members-quota-request-dto-quota.rb +108 -0
- data/lib/docspace-api-sdk/models/update-members-quota-request-dto.rb +164 -0
- data/lib/docspace-api-sdk/models/update-members-request-dto.rb +165 -0
- data/lib/docspace-api-sdk/models/update-metadata-field-request.rb +209 -0
- data/lib/docspace-api-sdk/models/update-metadata-template.rb +164 -0
- data/lib/docspace-api-sdk/models/update-photo-member-request.rb +153 -0
- data/lib/docspace-api-sdk/models/update-room-group-request.rb +203 -0
- data/lib/docspace-api-sdk/models/update-room-request.rb +348 -0
- data/lib/docspace-api-sdk/models/update-rooms-quota-request-dto.rb +165 -0
- data/lib/docspace-api-sdk/models/update-rooms-room-ids-request-dto.rb +155 -0
- data/lib/docspace-api-sdk/models/update-tag-request-dto.rb +216 -0
- data/lib/docspace-api-sdk/models/update-webhooks-config-request-dto.rb +385 -0
- data/lib/docspace-api-sdk/models/upload-result-dto.rb +173 -0
- data/lib/docspace-api-sdk/models/upload-result-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/upload-session-response-dto.rb +214 -0
- data/lib/docspace-api-sdk/models/upload-session-response-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/usage-space-stat-item-array-wrapper.rb +196 -0
- data/lib/docspace-api-sdk/models/usage-space-stat-item-dto.rb +196 -0
- data/lib/docspace-api-sdk/models/user-config-dto.rb +199 -0
- data/lib/docspace-api-sdk/models/user-exists-response-dto.rb +201 -0
- data/lib/docspace-api-sdk/models/user-exists-response-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/user-invitation-request-dto.rb +210 -0
- data/lib/docspace-api-sdk/models/user-invitation.rb +165 -0
- data/lib/docspace-api-sdk/models/validation-error-response.rb +174 -0
- data/lib/docspace-api-sdk/models/validation-result.rb +48 -0
- data/lib/docspace-api-sdk/models/vectorization-status.rb +44 -0
- data/lib/docspace-api-sdk/models/wallet-quantity-request-dto.rb +221 -0
- data/lib/docspace-api-sdk/models/wallet-service-array-wrapper.rb +196 -0
- data/lib/docspace-api-sdk/models/wallet-service-dto.rb +397 -0
- data/lib/docspace-api-sdk/models/wallet-service-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/watermark-additions.rb +46 -0
- data/lib/docspace-api-sdk/models/watermark-dto.rb +321 -0
- data/lib/docspace-api-sdk/models/watermark-on-draw-dto.rb +219 -0
- data/lib/docspace-api-sdk/models/watermark-paragraph-dto.rb +165 -0
- data/lib/docspace-api-sdk/models/watermark-request-dto.rb +271 -0
- data/lib/docspace-api-sdk/models/watermark-text-run-dto.rb +177 -0
- data/lib/docspace-api-sdk/models/web-item-security-request-dto.rb +178 -0
- data/lib/docspace-api-sdk/models/web-items-security-request-dto.rb +155 -0
- data/lib/docspace-api-sdk/models/web-plugin-array-wrapper.rb +196 -0
- data/lib/docspace-api-sdk/models/web-plugin-dto.rb +452 -0
- data/lib/docspace-api-sdk/models/web-plugin-request.rb +189 -0
- data/lib/docspace-api-sdk/models/web-plugin-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/webhook-group-status.rb +47 -0
- data/lib/docspace-api-sdk/models/webhook-retry-request-dto.rb +155 -0
- data/lib/docspace-api-sdk/models/webhook-trigger-array-wrapper.rb +196 -0
- data/lib/docspace-api-sdk/models/webhook-trigger-dto.rb +173 -0
- data/lib/docspace-api-sdk/models/webhook-trigger.rb +73 -0
- data/lib/docspace-api-sdk/models/webhooks-config-dto.rb +329 -0
- data/lib/docspace-api-sdk/models/webhooks-config-with-status-array-wrapper.rb +196 -0
- data/lib/docspace-api-sdk/models/webhooks-config-with-status-dto.rb +162 -0
- data/lib/docspace-api-sdk/models/webhooks-config-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/webhooks-log-array-wrapper.rb +196 -0
- data/lib/docspace-api-sdk/models/webhooks-log-dto.rb +309 -0
- data/lib/docspace-api-sdk/models/webhooks-log-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/white-label-item-array-wrapper.rb +196 -0
- data/lib/docspace-api-sdk/models/white-label-item-dto.rb +205 -0
- data/lib/docspace-api-sdk/models/white-label-item-path-dto.rb +164 -0
- data/lib/docspace-api-sdk/models/white-label-item-size-dto.rb +252 -0
- data/lib/docspace-api-sdk/models/white-label-logo-type.rb +57 -0
- data/lib/docspace-api-sdk/models/white-label-request-dto.rb +190 -0
- data/lib/docspace-api-sdk/models/wizard-request-dto.rb +211 -0
- data/lib/docspace-api-sdk/models/wizard-settings-dto.rb +162 -0
- data/lib/docspace-api-sdk/models/wizard-settings-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/xlsx-report-response-dto.rb +172 -0
- data/lib/docspace-api-sdk/models/xlsx-report-response-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/version.rb +20 -0
- data/lib/docspace-api-sdk.rb +1153 -0
- metadata +1208 -0
|
@@ -0,0 +1,1973 @@
|
|
|
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 SettingsApi
|
|
21
|
+
attr_accessor :api_client
|
|
22
|
+
|
|
23
|
+
def initialize(api_client = ApiClient.default)
|
|
24
|
+
@api_client = api_client
|
|
25
|
+
end
|
|
26
|
+
# Change the third-party settings access
|
|
27
|
+
# Turns the portal-wide permission to connect third-party storages such as Google Drive, Dropbox or Nextcloud on or off, and returns the value that is now stored. Only the portal owner and a DocSpace administrator may change it: a room administrator, a member or a guest is refused, and so is an unauthenticated caller. This is a single setting for the whole portal rather than a preference of the caller, so it changes what every account sees. While it is off, connecting an account through `POST api/2.0/files/thirdparty` is refused and the contents of an already connected provider folder cannot be listed; the stored connections themselves survive and work again once it is turned back on. The providers this portal can offer are listed by `GET api/2.0/files/thirdparty/capabilities`. The same value is published as `enableThirdParty` by `GET api/2.0/files/settings`. Sending the same value again is safe. The response is the value read back from the portal, not a success flag.
|
|
28
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/change-access-to-thirdparty/
|
|
29
|
+
# @param [Hash] opts the optional parameters
|
|
30
|
+
# @option opts [SettingsRequestDto] :settings_request_dto
|
|
31
|
+
# @return [BooleanWrapper]
|
|
32
|
+
def change_access_to_thirdparty(opts = {})
|
|
33
|
+
data, _status_code, _headers = change_access_to_thirdparty_with_http_info(opts)
|
|
34
|
+
data
|
|
35
|
+
end
|
|
36
|
+
|
|
37
|
+
# Change the third-party settings access
|
|
38
|
+
# Turns the portal-wide permission to connect third-party storages such as Google Drive, Dropbox or Nextcloud on or off, and returns the value that is now stored. Only the portal owner and a DocSpace administrator may change it: a room administrator, a member or a guest is refused, and so is an unauthenticated caller. This is a single setting for the whole portal rather than a preference of the caller, so it changes what every account sees. While it is off, connecting an account through `POST api/2.0/files/thirdparty` is refused and the contents of an already connected provider folder cannot be listed; the stored connections themselves survive and work again once it is turned back on. The providers this portal can offer are listed by `GET api/2.0/files/thirdparty/capabilities`. The same value is published as `enableThirdParty` by `GET api/2.0/files/settings`. Sending the same value again is safe. The response is the value read back from the portal, not a success flag.
|
|
39
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/change-access-to-thirdparty/
|
|
40
|
+
# @param [Hash] opts the optional parameters
|
|
41
|
+
# @option opts [SettingsRequestDto] :settings_request_dto
|
|
42
|
+
# @return [Array<(BooleanWrapper, Integer, Hash)>] BooleanWrapper data, response status code and response headers
|
|
43
|
+
def change_access_to_thirdparty_with_http_info(opts = {})
|
|
44
|
+
if @api_client.config.debugging
|
|
45
|
+
@api_client.config.logger.debug 'Calling API: Files::SettingsApi.change_access_to_thirdparty ...'
|
|
46
|
+
end
|
|
47
|
+
# resource path
|
|
48
|
+
local_var_path = '/api/2.0/files/thirdparty'
|
|
49
|
+
|
|
50
|
+
# query parameters
|
|
51
|
+
query_params = opts[:query_params] || {}
|
|
52
|
+
|
|
53
|
+
# header parameters
|
|
54
|
+
header_params = opts[:header_params] || {}
|
|
55
|
+
# HTTP header 'Accept' (if needed)
|
|
56
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
57
|
+
# HTTP header 'Content-Type'
|
|
58
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
59
|
+
if !content_type.nil?
|
|
60
|
+
header_params['Content-Type'] = content_type
|
|
61
|
+
end
|
|
62
|
+
|
|
63
|
+
# form parameters
|
|
64
|
+
form_params = opts[:form_params] || {}
|
|
65
|
+
|
|
66
|
+
# http body (model)
|
|
67
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'settings_request_dto'])
|
|
68
|
+
|
|
69
|
+
# return_type
|
|
70
|
+
return_type = opts[:debug_return_type] || 'BooleanWrapper'
|
|
71
|
+
|
|
72
|
+
# auth_names
|
|
73
|
+
auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
|
|
74
|
+
|
|
75
|
+
new_options = opts.merge(
|
|
76
|
+
:operation => :"Files::SettingsApi.change_access_to_thirdparty",
|
|
77
|
+
:header_params => header_params,
|
|
78
|
+
:query_params => query_params,
|
|
79
|
+
:form_params => form_params,
|
|
80
|
+
:body => post_body,
|
|
81
|
+
:auth_names => auth_names,
|
|
82
|
+
:return_type => return_type
|
|
83
|
+
)
|
|
84
|
+
|
|
85
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
|
|
86
|
+
if @api_client.config.debugging
|
|
87
|
+
@api_client.config.logger.debug "API called: Files::SettingsApi#change_access_to_thirdparty\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
88
|
+
end
|
|
89
|
+
return data, status_code, headers
|
|
90
|
+
end
|
|
91
|
+
|
|
92
|
+
# Update the trash bin auto-clearing setting
|
|
93
|
+
# Writes the trash auto-clearing setting of the calling account and returns the pair that is now stored. Both fields are written together from the request, so a call that omits `gap` stores an interval outside the published list rather than keeping the previous one - always send the interval, including when `set` is false. While clearing is on, an item is removed from the caller's trash for good once it has been there longer than the interval, and each trashed entry reports the moment it is due to disappear in its own `autoDelete` field; switching clearing off stops that and leaves whatever is in the trash. The setting belongs to the calling account alone: every authenticated role down to a guest may change its own, one member's choice never affects another, and an unauthenticated caller is refused. Items already removed are not recoverable. Read the pair back with `GET api/2.0/files/settings/autocleanup`.
|
|
94
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/change-automatically-clean-up/
|
|
95
|
+
# @param [Hash] opts the optional parameters
|
|
96
|
+
# @option opts [AutoCleanupRequestDto] :auto_cleanup_request_dto
|
|
97
|
+
# @return [AutoCleanUpDataWrapper]
|
|
98
|
+
def change_automatically_clean_up(opts = {})
|
|
99
|
+
data, _status_code, _headers = change_automatically_clean_up_with_http_info(opts)
|
|
100
|
+
data
|
|
101
|
+
end
|
|
102
|
+
|
|
103
|
+
# Update the trash bin auto-clearing setting
|
|
104
|
+
# Writes the trash auto-clearing setting of the calling account and returns the pair that is now stored. Both fields are written together from the request, so a call that omits `gap` stores an interval outside the published list rather than keeping the previous one - always send the interval, including when `set` is false. While clearing is on, an item is removed from the caller's trash for good once it has been there longer than the interval, and each trashed entry reports the moment it is due to disappear in its own `autoDelete` field; switching clearing off stops that and leaves whatever is in the trash. The setting belongs to the calling account alone: every authenticated role down to a guest may change its own, one member's choice never affects another, and an unauthenticated caller is refused. Items already removed are not recoverable. Read the pair back with `GET api/2.0/files/settings/autocleanup`.
|
|
105
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/change-automatically-clean-up/
|
|
106
|
+
# @param [Hash] opts the optional parameters
|
|
107
|
+
# @option opts [AutoCleanupRequestDto] :auto_cleanup_request_dto
|
|
108
|
+
# @return [Array<(AutoCleanUpDataWrapper, Integer, Hash)>] AutoCleanUpDataWrapper data, response status code and response headers
|
|
109
|
+
def change_automatically_clean_up_with_http_info(opts = {})
|
|
110
|
+
if @api_client.config.debugging
|
|
111
|
+
@api_client.config.logger.debug 'Calling API: Files::SettingsApi.change_automatically_clean_up ...'
|
|
112
|
+
end
|
|
113
|
+
# resource path
|
|
114
|
+
local_var_path = '/api/2.0/files/settings/autocleanup'
|
|
115
|
+
|
|
116
|
+
# query parameters
|
|
117
|
+
query_params = opts[:query_params] || {}
|
|
118
|
+
|
|
119
|
+
# header parameters
|
|
120
|
+
header_params = opts[:header_params] || {}
|
|
121
|
+
# HTTP header 'Accept' (if needed)
|
|
122
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
123
|
+
# HTTP header 'Content-Type'
|
|
124
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
125
|
+
if !content_type.nil?
|
|
126
|
+
header_params['Content-Type'] = content_type
|
|
127
|
+
end
|
|
128
|
+
|
|
129
|
+
# form parameters
|
|
130
|
+
form_params = opts[:form_params] || {}
|
|
131
|
+
|
|
132
|
+
# http body (model)
|
|
133
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'auto_cleanup_request_dto'])
|
|
134
|
+
|
|
135
|
+
# return_type
|
|
136
|
+
return_type = opts[:debug_return_type] || 'AutoCleanUpDataWrapper'
|
|
137
|
+
|
|
138
|
+
# auth_names
|
|
139
|
+
auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
|
|
140
|
+
|
|
141
|
+
new_options = opts.merge(
|
|
142
|
+
:operation => :"Files::SettingsApi.change_automatically_clean_up",
|
|
143
|
+
:header_params => header_params,
|
|
144
|
+
:query_params => query_params,
|
|
145
|
+
:form_params => form_params,
|
|
146
|
+
:body => post_body,
|
|
147
|
+
:auth_names => auth_names,
|
|
148
|
+
:return_type => return_type
|
|
149
|
+
)
|
|
150
|
+
|
|
151
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
|
|
152
|
+
if @api_client.config.debugging
|
|
153
|
+
@api_client.config.logger.debug "API called: Files::SettingsApi#change_automatically_clean_up\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
154
|
+
end
|
|
155
|
+
return data, status_code, headers
|
|
156
|
+
end
|
|
157
|
+
|
|
158
|
+
# Change the default access rights
|
|
159
|
+
# Stores the access rights the sharing dialog offers the calling account by default, and returns the set that was actually stored. The body is a bare array of access-right values, not an object. The portal normalises the array instead of keeping it as sent: it keeps the fill-forms, custom-filter and review entries, then adds read-and-write or comment - whichever is present, in that order - and stops there, and it falls back to read alone when nothing else applies, so the response can be shorter than the request and its order can differ. An empty array clears the setting, after which read alone is reported. A value outside the published list is rejected as an invalid request. The set belongs to the calling account alone: every authenticated role down to a guest may store its own, and an unauthenticated caller is refused. Nothing already shared is changed. The stored set is published as `defaultSharingAccessRights` by `GET api/2.0/files/settings`.
|
|
160
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/change-default-access-rights/
|
|
161
|
+
# @param [Hash] opts the optional parameters
|
|
162
|
+
# @option opts [Array<Integer>] :default_access_rights_request_dto The access rights the sharing dialog should offer by default. The array is the whole request body rather than a field of an object, and the portal stores a normalised subset of it instead of the array as sent, so read the answer to learn what was kept. An empty array clears the setting, after which the portal reports read access alone. A value outside the published list is rejected as an invalid request.
|
|
163
|
+
# @return [FileShareResponseArrayWrapper]
|
|
164
|
+
def change_default_access_rights(opts = {})
|
|
165
|
+
data, _status_code, _headers = change_default_access_rights_with_http_info(opts)
|
|
166
|
+
data
|
|
167
|
+
end
|
|
168
|
+
|
|
169
|
+
# Change the default access rights
|
|
170
|
+
# Stores the access rights the sharing dialog offers the calling account by default, and returns the set that was actually stored. The body is a bare array of access-right values, not an object. The portal normalises the array instead of keeping it as sent: it keeps the fill-forms, custom-filter and review entries, then adds read-and-write or comment - whichever is present, in that order - and stops there, and it falls back to read alone when nothing else applies, so the response can be shorter than the request and its order can differ. An empty array clears the setting, after which read alone is reported. A value outside the published list is rejected as an invalid request. The set belongs to the calling account alone: every authenticated role down to a guest may store its own, and an unauthenticated caller is refused. Nothing already shared is changed. The stored set is published as `defaultSharingAccessRights` by `GET api/2.0/files/settings`.
|
|
171
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/change-default-access-rights/
|
|
172
|
+
# @param [Hash] opts the optional parameters
|
|
173
|
+
# @option opts [Array<Integer>] :default_access_rights_request_dto The access rights the sharing dialog should offer by default. The array is the whole request body rather than a field of an object, and the portal stores a normalised subset of it instead of the array as sent, so read the answer to learn what was kept. An empty array clears the setting, after which the portal reports read access alone. A value outside the published list is rejected as an invalid request.
|
|
174
|
+
# @return [Array<(FileShareResponseArrayWrapper, Integer, Hash)>] FileShareResponseArrayWrapper data, response status code and response headers
|
|
175
|
+
def change_default_access_rights_with_http_info(opts = {})
|
|
176
|
+
if @api_client.config.debugging
|
|
177
|
+
@api_client.config.logger.debug 'Calling API: Files::SettingsApi.change_default_access_rights ...'
|
|
178
|
+
end
|
|
179
|
+
# resource path
|
|
180
|
+
local_var_path = '/api/2.0/files/settings/dafaultaccessrights'
|
|
181
|
+
|
|
182
|
+
# query parameters
|
|
183
|
+
query_params = opts[:query_params] || {}
|
|
184
|
+
|
|
185
|
+
# header parameters
|
|
186
|
+
header_params = opts[:header_params] || {}
|
|
187
|
+
# HTTP header 'Accept' (if needed)
|
|
188
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
189
|
+
# HTTP header 'Content-Type'
|
|
190
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
191
|
+
if !content_type.nil?
|
|
192
|
+
header_params['Content-Type'] = content_type
|
|
193
|
+
end
|
|
194
|
+
|
|
195
|
+
# form parameters
|
|
196
|
+
form_params = opts[:form_params] || {}
|
|
197
|
+
|
|
198
|
+
# http body (model)
|
|
199
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'default_access_rights_request_dto'])
|
|
200
|
+
|
|
201
|
+
# return_type
|
|
202
|
+
return_type = opts[:debug_return_type] || 'FileShareResponseArrayWrapper'
|
|
203
|
+
|
|
204
|
+
# auth_names
|
|
205
|
+
auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
|
|
206
|
+
|
|
207
|
+
new_options = opts.merge(
|
|
208
|
+
:operation => :"Files::SettingsApi.change_default_access_rights",
|
|
209
|
+
:header_params => header_params,
|
|
210
|
+
:query_params => query_params,
|
|
211
|
+
:form_params => form_params,
|
|
212
|
+
:body => post_body,
|
|
213
|
+
:auth_names => auth_names,
|
|
214
|
+
:return_type => return_type
|
|
215
|
+
)
|
|
216
|
+
|
|
217
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
|
|
218
|
+
if @api_client.config.debugging
|
|
219
|
+
@api_client.config.logger.debug "API called: Files::SettingsApi#change_default_access_rights\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
220
|
+
end
|
|
221
|
+
return data, status_code, headers
|
|
222
|
+
end
|
|
223
|
+
|
|
224
|
+
# Ask for delete confirmation
|
|
225
|
+
# Stores whether the caller wants to be asked for confirmation before files and folders are deleted, and returns the value that is now stored. The setting belongs to the calling account alone: every authenticated role down to a guest may change its own copy, one member's choice never affects another, and an unauthenticated caller is refused. It is a hint for the interface, not a server-side guard: the delete operations under `api/2.0/files/fileops` remove whatever they are given regardless of this value, so a client that skips its own prompt loses nothing but the prompt. Pass `set=true` to be asked again, `set=false` to delete without a prompt. The same value is published as `confirmDelete` by `GET api/2.0/files/settings`, which is the only way to read it back. Repeating the call with the same value writes it again and is safe. A new account starts with the confirmation switched on, and the value says nothing about where deleted items land: they go to the trash and are cleared from there according to `GET api/2.0/files/settings/autocleanup`.
|
|
226
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/change-delete-confirm/
|
|
227
|
+
# @param [Hash] opts the optional parameters
|
|
228
|
+
# @option opts [SettingsRequestDto] :settings_request_dto
|
|
229
|
+
# @return [BooleanWrapper]
|
|
230
|
+
def change_delete_confirm(opts = {})
|
|
231
|
+
data, _status_code, _headers = change_delete_confirm_with_http_info(opts)
|
|
232
|
+
data
|
|
233
|
+
end
|
|
234
|
+
|
|
235
|
+
# Ask for delete confirmation
|
|
236
|
+
# Stores whether the caller wants to be asked for confirmation before files and folders are deleted, and returns the value that is now stored. The setting belongs to the calling account alone: every authenticated role down to a guest may change its own copy, one member's choice never affects another, and an unauthenticated caller is refused. It is a hint for the interface, not a server-side guard: the delete operations under `api/2.0/files/fileops` remove whatever they are given regardless of this value, so a client that skips its own prompt loses nothing but the prompt. Pass `set=true` to be asked again, `set=false` to delete without a prompt. The same value is published as `confirmDelete` by `GET api/2.0/files/settings`, which is the only way to read it back. Repeating the call with the same value writes it again and is safe. A new account starts with the confirmation switched on, and the value says nothing about where deleted items land: they go to the trash and are cleared from there according to `GET api/2.0/files/settings/autocleanup`.
|
|
237
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/change-delete-confirm/
|
|
238
|
+
# @param [Hash] opts the optional parameters
|
|
239
|
+
# @option opts [SettingsRequestDto] :settings_request_dto
|
|
240
|
+
# @return [Array<(BooleanWrapper, Integer, Hash)>] BooleanWrapper data, response status code and response headers
|
|
241
|
+
def change_delete_confirm_with_http_info(opts = {})
|
|
242
|
+
if @api_client.config.debugging
|
|
243
|
+
@api_client.config.logger.debug 'Calling API: Files::SettingsApi.change_delete_confirm ...'
|
|
244
|
+
end
|
|
245
|
+
# resource path
|
|
246
|
+
local_var_path = '/api/2.0/files/changedeleteconfrim'
|
|
247
|
+
|
|
248
|
+
# query parameters
|
|
249
|
+
query_params = opts[:query_params] || {}
|
|
250
|
+
|
|
251
|
+
# header parameters
|
|
252
|
+
header_params = opts[:header_params] || {}
|
|
253
|
+
# HTTP header 'Accept' (if needed)
|
|
254
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
255
|
+
# HTTP header 'Content-Type'
|
|
256
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
257
|
+
if !content_type.nil?
|
|
258
|
+
header_params['Content-Type'] = content_type
|
|
259
|
+
end
|
|
260
|
+
|
|
261
|
+
# form parameters
|
|
262
|
+
form_params = opts[:form_params] || {}
|
|
263
|
+
|
|
264
|
+
# http body (model)
|
|
265
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'settings_request_dto'])
|
|
266
|
+
|
|
267
|
+
# return_type
|
|
268
|
+
return_type = opts[:debug_return_type] || 'BooleanWrapper'
|
|
269
|
+
|
|
270
|
+
# auth_names
|
|
271
|
+
auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
|
|
272
|
+
|
|
273
|
+
new_options = opts.merge(
|
|
274
|
+
:operation => :"Files::SettingsApi.change_delete_confirm",
|
|
275
|
+
:header_params => header_params,
|
|
276
|
+
:query_params => query_params,
|
|
277
|
+
:form_params => form_params,
|
|
278
|
+
:body => post_body,
|
|
279
|
+
:auth_names => auth_names,
|
|
280
|
+
:return_type => return_type
|
|
281
|
+
)
|
|
282
|
+
|
|
283
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
|
|
284
|
+
if @api_client.config.debugging
|
|
285
|
+
@api_client.config.logger.debug "API called: Files::SettingsApi#change_delete_confirm\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
286
|
+
end
|
|
287
|
+
return data, status_code, headers
|
|
288
|
+
end
|
|
289
|
+
|
|
290
|
+
# Change the download archive format
|
|
291
|
+
# Selects the archive format the portal packs the caller's multi-item downloads into: `set=true` switches to `.tar.gz`, `set=false` back to `.zip`. The choice is stored for the calling account only, so every authenticated role down to a guest may set its own, while an unauthenticated caller is refused. It takes effect on the archives built by `PUT api/2.0/files/fileops/bulkdownload` and by the download links that operation returns; archives already produced keep the format they were packed with. The returned archive object carries no readable fields of its own, so it cannot be used to confirm the change: read `downloadTarGz` from `GET api/2.0/files/settings` instead. Writing the same value again is safe and changes nothing else. A new account starts on `.zip`. The format decides only how the archive is packed: which items go into it, and the access needed to take them, are decided by the bulk-download operation itself, and a single file is downloaded as it is whatever is stored here.
|
|
292
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/change-download-zip/
|
|
293
|
+
# @param [Hash] opts the optional parameters
|
|
294
|
+
# @option opts [DisplayRequestDto] :display_request_dto
|
|
295
|
+
# @return [ICompressWrapper]
|
|
296
|
+
def change_download_zip(opts = {})
|
|
297
|
+
data, _status_code, _headers = change_download_zip_with_http_info(opts)
|
|
298
|
+
data
|
|
299
|
+
end
|
|
300
|
+
|
|
301
|
+
# Change the download archive format
|
|
302
|
+
# Selects the archive format the portal packs the caller's multi-item downloads into: `set=true` switches to `.tar.gz`, `set=false` back to `.zip`. The choice is stored for the calling account only, so every authenticated role down to a guest may set its own, while an unauthenticated caller is refused. It takes effect on the archives built by `PUT api/2.0/files/fileops/bulkdownload` and by the download links that operation returns; archives already produced keep the format they were packed with. The returned archive object carries no readable fields of its own, so it cannot be used to confirm the change: read `downloadTarGz` from `GET api/2.0/files/settings` instead. Writing the same value again is safe and changes nothing else. A new account starts on `.zip`. The format decides only how the archive is packed: which items go into it, and the access needed to take them, are decided by the bulk-download operation itself, and a single file is downloaded as it is whatever is stored here.
|
|
303
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/change-download-zip/
|
|
304
|
+
# @param [Hash] opts the optional parameters
|
|
305
|
+
# @option opts [DisplayRequestDto] :display_request_dto
|
|
306
|
+
# @return [Array<(ICompressWrapper, Integer, Hash)>] ICompressWrapper data, response status code and response headers
|
|
307
|
+
def change_download_zip_with_http_info(opts = {})
|
|
308
|
+
if @api_client.config.debugging
|
|
309
|
+
@api_client.config.logger.debug 'Calling API: Files::SettingsApi.change_download_zip ...'
|
|
310
|
+
end
|
|
311
|
+
# resource path
|
|
312
|
+
local_var_path = '/api/2.0/files/settings/downloadtargz'
|
|
313
|
+
|
|
314
|
+
# query parameters
|
|
315
|
+
query_params = opts[:query_params] || {}
|
|
316
|
+
|
|
317
|
+
# header parameters
|
|
318
|
+
header_params = opts[:header_params] || {}
|
|
319
|
+
# HTTP header 'Accept' (if needed)
|
|
320
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
321
|
+
# HTTP header 'Content-Type'
|
|
322
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
323
|
+
if !content_type.nil?
|
|
324
|
+
header_params['Content-Type'] = content_type
|
|
325
|
+
end
|
|
326
|
+
|
|
327
|
+
# form parameters
|
|
328
|
+
form_params = opts[:form_params] || {}
|
|
329
|
+
|
|
330
|
+
# http body (model)
|
|
331
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'display_request_dto'])
|
|
332
|
+
|
|
333
|
+
# return_type
|
|
334
|
+
return_type = opts[:debug_return_type] || 'ICompressWrapper'
|
|
335
|
+
|
|
336
|
+
# auth_names
|
|
337
|
+
auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
|
|
338
|
+
|
|
339
|
+
new_options = opts.merge(
|
|
340
|
+
:operation => :"Files::SettingsApi.change_download_zip",
|
|
341
|
+
:header_params => header_params,
|
|
342
|
+
:query_params => query_params,
|
|
343
|
+
:form_params => form_params,
|
|
344
|
+
:body => post_body,
|
|
345
|
+
:auth_names => auth_names,
|
|
346
|
+
:return_type => return_type
|
|
347
|
+
)
|
|
348
|
+
|
|
349
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
|
|
350
|
+
if @api_client.config.debugging
|
|
351
|
+
@api_client.config.logger.debug "API called: Files::SettingsApi#change_download_zip\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
352
|
+
end
|
|
353
|
+
return data, status_code, headers
|
|
354
|
+
end
|
|
355
|
+
|
|
356
|
+
# Configure external sharing
|
|
357
|
+
# Writes the portal's whole external-sharing policy in one request and returns the set that is now in force. Only the portal owner and a DocSpace administrator may call it; everyone else is refused, including an unauthenticated caller. Every field of the request is applied, so send the complete set rather than the field being changed - an omitted boolean is read as false. The portal keeps the set consistent: with `externalShare` false the default link type is forced to users of this portal only and sharing on social networks is turned off, and the three restriction fields only matter while external sharing is off. `blockExistingLinksOnRestrict` decides what happens to links that already exist, so it is the field that changes access to data already shared. The new set is pushed to the connected clients of the portal as well, and is published field by field by `GET api/2.0/files/settings`. Sending the same set again is safe.
|
|
358
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/change-external-sharing-settings/
|
|
359
|
+
# @param [Hash] opts the optional parameters
|
|
360
|
+
# @option opts [ExternalSharingSettingsRequestDto] :external_sharing_settings_request_dto
|
|
361
|
+
# @return [ExternalSharingSettingsWrapper]
|
|
362
|
+
def change_external_sharing_settings(opts = {})
|
|
363
|
+
data, _status_code, _headers = change_external_sharing_settings_with_http_info(opts)
|
|
364
|
+
data
|
|
365
|
+
end
|
|
366
|
+
|
|
367
|
+
# Configure external sharing
|
|
368
|
+
# Writes the portal's whole external-sharing policy in one request and returns the set that is now in force. Only the portal owner and a DocSpace administrator may call it; everyone else is refused, including an unauthenticated caller. Every field of the request is applied, so send the complete set rather than the field being changed - an omitted boolean is read as false. The portal keeps the set consistent: with `externalShare` false the default link type is forced to users of this portal only and sharing on social networks is turned off, and the three restriction fields only matter while external sharing is off. `blockExistingLinksOnRestrict` decides what happens to links that already exist, so it is the field that changes access to data already shared. The new set is pushed to the connected clients of the portal as well, and is published field by field by `GET api/2.0/files/settings`. Sending the same set again is safe.
|
|
369
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/change-external-sharing-settings/
|
|
370
|
+
# @param [Hash] opts the optional parameters
|
|
371
|
+
# @option opts [ExternalSharingSettingsRequestDto] :external_sharing_settings_request_dto
|
|
372
|
+
# @return [Array<(ExternalSharingSettingsWrapper, Integer, Hash)>] ExternalSharingSettingsWrapper data, response status code and response headers
|
|
373
|
+
def change_external_sharing_settings_with_http_info(opts = {})
|
|
374
|
+
if @api_client.config.debugging
|
|
375
|
+
@api_client.config.logger.debug 'Calling API: Files::SettingsApi.change_external_sharing_settings ...'
|
|
376
|
+
end
|
|
377
|
+
# resource path
|
|
378
|
+
local_var_path = '/api/2.0/files/settings/externalsharingsettings'
|
|
379
|
+
|
|
380
|
+
# query parameters
|
|
381
|
+
query_params = opts[:query_params] || {}
|
|
382
|
+
|
|
383
|
+
# header parameters
|
|
384
|
+
header_params = opts[:header_params] || {}
|
|
385
|
+
# HTTP header 'Accept' (if needed)
|
|
386
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
387
|
+
# HTTP header 'Content-Type'
|
|
388
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
389
|
+
if !content_type.nil?
|
|
390
|
+
header_params['Content-Type'] = content_type
|
|
391
|
+
end
|
|
392
|
+
|
|
393
|
+
# form parameters
|
|
394
|
+
form_params = opts[:form_params] || {}
|
|
395
|
+
|
|
396
|
+
# http body (model)
|
|
397
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'external_sharing_settings_request_dto'])
|
|
398
|
+
|
|
399
|
+
# return_type
|
|
400
|
+
return_type = opts[:debug_return_type] || 'ExternalSharingSettingsWrapper'
|
|
401
|
+
|
|
402
|
+
# auth_names
|
|
403
|
+
auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
|
|
404
|
+
|
|
405
|
+
new_options = opts.merge(
|
|
406
|
+
:operation => :"Files::SettingsApi.change_external_sharing_settings",
|
|
407
|
+
:header_params => header_params,
|
|
408
|
+
:query_params => query_params,
|
|
409
|
+
:form_params => form_params,
|
|
410
|
+
:body => post_body,
|
|
411
|
+
:auth_names => auth_names,
|
|
412
|
+
:return_type => return_type
|
|
413
|
+
)
|
|
414
|
+
|
|
415
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
|
|
416
|
+
if @api_client.config.debugging
|
|
417
|
+
@api_client.config.logger.debug "API called: Files::SettingsApi#change_external_sharing_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
418
|
+
end
|
|
419
|
+
return data, status_code, headers
|
|
420
|
+
end
|
|
421
|
+
|
|
422
|
+
# Set the document service address
|
|
423
|
+
# Writes the portal-wide ONLYOFFICE Docs connection settings - the public Document Server address, its address inside the private network, the address it calls this portal back on, the request signature secret and header, and SSL verification - then verifies them against the running Document Server before keeping them. Every address is optional: an empty value drops the portal's own setting so that the deployment default takes over again. An address gets `http://` prepended when it carries no scheme, while an absolute address with a query string is rejected with 400, as is a signature secret sent without its header. Only the portal owner and a DocSpace administrator may call this; a room administrator, a user and a guest are refused with 403. The call is mutating and safe to repeat with the same body. Verification is live - the editor api script, the healthcheck, a test conversion, the command service and the document builder are all exercised - and when it fails the previous settings are restored in full and nothing is changed. The answer is what `GET api/2.0/files/docservice` returns with no version requested, so `version` comes back empty and the signature secret is not echoed back.
|
|
424
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/check-doc-service-url/
|
|
425
|
+
# @param [Hash] opts the optional parameters
|
|
426
|
+
# @option opts [CheckDocServiceUrlRequestDto] :check_doc_service_url_request_dto
|
|
427
|
+
# @return [DocServiceUrlWrapper]
|
|
428
|
+
def check_doc_service_url(opts = {})
|
|
429
|
+
data, _status_code, _headers = check_doc_service_url_with_http_info(opts)
|
|
430
|
+
data
|
|
431
|
+
end
|
|
432
|
+
|
|
433
|
+
# Set the document service address
|
|
434
|
+
# Writes the portal-wide ONLYOFFICE Docs connection settings - the public Document Server address, its address inside the private network, the address it calls this portal back on, the request signature secret and header, and SSL verification - then verifies them against the running Document Server before keeping them. Every address is optional: an empty value drops the portal's own setting so that the deployment default takes over again. An address gets `http://` prepended when it carries no scheme, while an absolute address with a query string is rejected with 400, as is a signature secret sent without its header. Only the portal owner and a DocSpace administrator may call this; a room administrator, a user and a guest are refused with 403. The call is mutating and safe to repeat with the same body. Verification is live - the editor api script, the healthcheck, a test conversion, the command service and the document builder are all exercised - and when it fails the previous settings are restored in full and nothing is changed. The answer is what `GET api/2.0/files/docservice` returns with no version requested, so `version` comes back empty and the signature secret is not echoed back.
|
|
435
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/check-doc-service-url/
|
|
436
|
+
# @param [Hash] opts the optional parameters
|
|
437
|
+
# @option opts [CheckDocServiceUrlRequestDto] :check_doc_service_url_request_dto
|
|
438
|
+
# @return [Array<(DocServiceUrlWrapper, Integer, Hash)>] DocServiceUrlWrapper data, response status code and response headers
|
|
439
|
+
def check_doc_service_url_with_http_info(opts = {})
|
|
440
|
+
if @api_client.config.debugging
|
|
441
|
+
@api_client.config.logger.debug 'Calling API: Files::SettingsApi.check_doc_service_url ...'
|
|
442
|
+
end
|
|
443
|
+
# resource path
|
|
444
|
+
local_var_path = '/api/2.0/files/docservice'
|
|
445
|
+
|
|
446
|
+
# query parameters
|
|
447
|
+
query_params = opts[:query_params] || {}
|
|
448
|
+
|
|
449
|
+
# header parameters
|
|
450
|
+
header_params = opts[:header_params] || {}
|
|
451
|
+
# HTTP header 'Accept' (if needed)
|
|
452
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
453
|
+
# HTTP header 'Content-Type'
|
|
454
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
455
|
+
if !content_type.nil?
|
|
456
|
+
header_params['Content-Type'] = content_type
|
|
457
|
+
end
|
|
458
|
+
|
|
459
|
+
# form parameters
|
|
460
|
+
form_params = opts[:form_params] || {}
|
|
461
|
+
|
|
462
|
+
# http body (model)
|
|
463
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'check_doc_service_url_request_dto'])
|
|
464
|
+
|
|
465
|
+
# return_type
|
|
466
|
+
return_type = opts[:debug_return_type] || 'DocServiceUrlWrapper'
|
|
467
|
+
|
|
468
|
+
# auth_names
|
|
469
|
+
auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
|
|
470
|
+
|
|
471
|
+
new_options = opts.merge(
|
|
472
|
+
:operation => :"Files::SettingsApi.check_doc_service_url",
|
|
473
|
+
:header_params => header_params,
|
|
474
|
+
:query_params => query_params,
|
|
475
|
+
:form_params => form_params,
|
|
476
|
+
:body => post_body,
|
|
477
|
+
:auth_names => auth_names,
|
|
478
|
+
:return_type => return_type
|
|
479
|
+
)
|
|
480
|
+
|
|
481
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
|
|
482
|
+
if @api_client.config.debugging
|
|
483
|
+
@api_client.config.logger.debug "API called: Files::SettingsApi#check_doc_service_url\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
484
|
+
end
|
|
485
|
+
return data, status_code, headers
|
|
486
|
+
end
|
|
487
|
+
|
|
488
|
+
# Display a file extension
|
|
489
|
+
# Stores whether file titles are shown to the caller with their extension, and returns the value that is now stored. It is a preference of the calling account: every authenticated role down to a guest may change its own copy, and an unauthenticated caller is refused. Only the presentation changes - the titles kept by the portal always include the extension, and the listing and file operations keep returning them in full, so a client that trims the extension for display must add it back before it renames or searches for anything. Writing a value that is already stored is accepted and leaves the setting untouched. The value is published as `displayFileExtension` by `GET api/2.0/files/settings`, which is the only way to read it back. A new account starts with extensions hidden. This governs display alone: which extensions may be uploaded, viewed or edited at all is published by the same settings operation as separate format lists.
|
|
490
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/display-file-extension/
|
|
491
|
+
# @param [Hash] opts the optional parameters
|
|
492
|
+
# @option opts [SettingsRequestDto] :settings_request_dto
|
|
493
|
+
# @return [BooleanWrapper]
|
|
494
|
+
def display_file_extension(opts = {})
|
|
495
|
+
data, _status_code, _headers = display_file_extension_with_http_info(opts)
|
|
496
|
+
data
|
|
497
|
+
end
|
|
498
|
+
|
|
499
|
+
# Display a file extension
|
|
500
|
+
# Stores whether file titles are shown to the caller with their extension, and returns the value that is now stored. It is a preference of the calling account: every authenticated role down to a guest may change its own copy, and an unauthenticated caller is refused. Only the presentation changes - the titles kept by the portal always include the extension, and the listing and file operations keep returning them in full, so a client that trims the extension for display must add it back before it renames or searches for anything. Writing a value that is already stored is accepted and leaves the setting untouched. The value is published as `displayFileExtension` by `GET api/2.0/files/settings`, which is the only way to read it back. A new account starts with extensions hidden. This governs display alone: which extensions may be uploaded, viewed or edited at all is published by the same settings operation as separate format lists.
|
|
501
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/display-file-extension/
|
|
502
|
+
# @param [Hash] opts the optional parameters
|
|
503
|
+
# @option opts [SettingsRequestDto] :settings_request_dto
|
|
504
|
+
# @return [Array<(BooleanWrapper, Integer, Hash)>] BooleanWrapper data, response status code and response headers
|
|
505
|
+
def display_file_extension_with_http_info(opts = {})
|
|
506
|
+
if @api_client.config.debugging
|
|
507
|
+
@api_client.config.logger.debug 'Calling API: Files::SettingsApi.display_file_extension ...'
|
|
508
|
+
end
|
|
509
|
+
# resource path
|
|
510
|
+
local_var_path = '/api/2.0/files/displayfileextension'
|
|
511
|
+
|
|
512
|
+
# query parameters
|
|
513
|
+
query_params = opts[:query_params] || {}
|
|
514
|
+
|
|
515
|
+
# header parameters
|
|
516
|
+
header_params = opts[:header_params] || {}
|
|
517
|
+
# HTTP header 'Accept' (if needed)
|
|
518
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
519
|
+
# HTTP header 'Content-Type'
|
|
520
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
521
|
+
if !content_type.nil?
|
|
522
|
+
header_params['Content-Type'] = content_type
|
|
523
|
+
end
|
|
524
|
+
|
|
525
|
+
# form parameters
|
|
526
|
+
form_params = opts[:form_params] || {}
|
|
527
|
+
|
|
528
|
+
# http body (model)
|
|
529
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'settings_request_dto'])
|
|
530
|
+
|
|
531
|
+
# return_type
|
|
532
|
+
return_type = opts[:debug_return_type] || 'BooleanWrapper'
|
|
533
|
+
|
|
534
|
+
# auth_names
|
|
535
|
+
auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
|
|
536
|
+
|
|
537
|
+
new_options = opts.merge(
|
|
538
|
+
:operation => :"Files::SettingsApi.display_file_extension",
|
|
539
|
+
:header_params => header_params,
|
|
540
|
+
:query_params => query_params,
|
|
541
|
+
:form_params => form_params,
|
|
542
|
+
:body => post_body,
|
|
543
|
+
:auth_names => auth_names,
|
|
544
|
+
:return_type => return_type
|
|
545
|
+
)
|
|
546
|
+
|
|
547
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
|
|
548
|
+
if @api_client.config.debugging
|
|
549
|
+
@api_client.config.logger.debug "API called: Files::SettingsApi#display_file_extension\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
550
|
+
end
|
|
551
|
+
return data, status_code, headers
|
|
552
|
+
end
|
|
553
|
+
|
|
554
|
+
# Show the Recent section
|
|
555
|
+
# Stores whether the Recent section is offered to the calling account, and returns the value that is now stored. The setting belongs to that account alone: every authenticated role down to a guest may change its own copy, and an unauthenticated caller is refused. Hiding the section removes it from the list of section roots returned by `GET api/2.0/files/@root`, and the document editor stops offering the recent-files entry; the section itself keeps being maintained, and `GET api/2.0/files/recent` still returns its contents. Pass `set=true` to show it again. The same value is published as `recentSection` by `GET api/2.0/files/settings`, which is the only way to read it back. Repeating the call with the same value writes it again and is safe. A new account starts with the section shown. Hiding it neither clears the recent history nor stops it being recorded, so showing the section again brings the same entries back.
|
|
556
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/display-recent/
|
|
557
|
+
# @param [Hash] opts the optional parameters
|
|
558
|
+
# @option opts [DisplayRequestDto] :display_request_dto
|
|
559
|
+
# @return [BooleanWrapper]
|
|
560
|
+
def display_recent(opts = {})
|
|
561
|
+
data, _status_code, _headers = display_recent_with_http_info(opts)
|
|
562
|
+
data
|
|
563
|
+
end
|
|
564
|
+
|
|
565
|
+
# Show the Recent section
|
|
566
|
+
# Stores whether the Recent section is offered to the calling account, and returns the value that is now stored. The setting belongs to that account alone: every authenticated role down to a guest may change its own copy, and an unauthenticated caller is refused. Hiding the section removes it from the list of section roots returned by `GET api/2.0/files/@root`, and the document editor stops offering the recent-files entry; the section itself keeps being maintained, and `GET api/2.0/files/recent` still returns its contents. Pass `set=true` to show it again. The same value is published as `recentSection` by `GET api/2.0/files/settings`, which is the only way to read it back. Repeating the call with the same value writes it again and is safe. A new account starts with the section shown. Hiding it neither clears the recent history nor stops it being recorded, so showing the section again brings the same entries back.
|
|
567
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/display-recent/
|
|
568
|
+
# @param [Hash] opts the optional parameters
|
|
569
|
+
# @option opts [DisplayRequestDto] :display_request_dto
|
|
570
|
+
# @return [Array<(BooleanWrapper, Integer, Hash)>] BooleanWrapper data, response status code and response headers
|
|
571
|
+
def display_recent_with_http_info(opts = {})
|
|
572
|
+
if @api_client.config.debugging
|
|
573
|
+
@api_client.config.logger.debug 'Calling API: Files::SettingsApi.display_recent ...'
|
|
574
|
+
end
|
|
575
|
+
# resource path
|
|
576
|
+
local_var_path = '/api/2.0/files/displayrecent'
|
|
577
|
+
|
|
578
|
+
# query parameters
|
|
579
|
+
query_params = opts[:query_params] || {}
|
|
580
|
+
|
|
581
|
+
# header parameters
|
|
582
|
+
header_params = opts[:header_params] || {}
|
|
583
|
+
# HTTP header 'Accept' (if needed)
|
|
584
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
585
|
+
# HTTP header 'Content-Type'
|
|
586
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
587
|
+
if !content_type.nil?
|
|
588
|
+
header_params['Content-Type'] = content_type
|
|
589
|
+
end
|
|
590
|
+
|
|
591
|
+
# form parameters
|
|
592
|
+
form_params = opts[:form_params] || {}
|
|
593
|
+
|
|
594
|
+
# http body (model)
|
|
595
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'display_request_dto'])
|
|
596
|
+
|
|
597
|
+
# return_type
|
|
598
|
+
return_type = opts[:debug_return_type] || 'BooleanWrapper'
|
|
599
|
+
|
|
600
|
+
# auth_names
|
|
601
|
+
auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
|
|
602
|
+
|
|
603
|
+
new_options = opts.merge(
|
|
604
|
+
:operation => :"Files::SettingsApi.display_recent",
|
|
605
|
+
:header_params => header_params,
|
|
606
|
+
:query_params => query_params,
|
|
607
|
+
:form_params => form_params,
|
|
608
|
+
:body => post_body,
|
|
609
|
+
:auth_names => auth_names,
|
|
610
|
+
:return_type => return_type
|
|
611
|
+
)
|
|
612
|
+
|
|
613
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
|
|
614
|
+
if @api_client.config.debugging
|
|
615
|
+
@api_client.config.logger.debug "API called: Files::SettingsApi#display_recent\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
616
|
+
end
|
|
617
|
+
return data, status_code, headers
|
|
618
|
+
end
|
|
619
|
+
|
|
620
|
+
# Change the external sharing ability
|
|
621
|
+
# Turns external (public) links on or off for the whole portal and returns the value that is now stored. Only the portal owner and a DocSpace administrator may change it: a room administrator, a member or a guest is refused, and so is an unauthenticated caller. Turning it off also turns sharing on social networks off, so a following read of `externalShareSocialMedia` reports false without a separate call. This operation sets one flag; to write the whole external-sharing policy in one request - the default link type, the sections the restriction applies to and whether existing links are blocked at once - use `PUT api/2.0/files/settings/externalsharingsettings`. The value is published as `externalShare` by `GET api/2.0/files/settings`. Sending the same value again is safe. The response is the value read back from the portal rather than a success flag. External links are allowed in a new portal. Turning them off does not delete the links that already exist - whether those stop working at once is decided by the `blockExistingLinksOnRestrict` field of the settings operation named above.
|
|
622
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/external-share/
|
|
623
|
+
# @param [Hash] opts the optional parameters
|
|
624
|
+
# @option opts [DisplayRequestDto] :display_request_dto
|
|
625
|
+
# @return [BooleanWrapper]
|
|
626
|
+
def external_share(opts = {})
|
|
627
|
+
data, _status_code, _headers = external_share_with_http_info(opts)
|
|
628
|
+
data
|
|
629
|
+
end
|
|
630
|
+
|
|
631
|
+
# Change the external sharing ability
|
|
632
|
+
# Turns external (public) links on or off for the whole portal and returns the value that is now stored. Only the portal owner and a DocSpace administrator may change it: a room administrator, a member or a guest is refused, and so is an unauthenticated caller. Turning it off also turns sharing on social networks off, so a following read of `externalShareSocialMedia` reports false without a separate call. This operation sets one flag; to write the whole external-sharing policy in one request - the default link type, the sections the restriction applies to and whether existing links are blocked at once - use `PUT api/2.0/files/settings/externalsharingsettings`. The value is published as `externalShare` by `GET api/2.0/files/settings`. Sending the same value again is safe. The response is the value read back from the portal rather than a success flag. External links are allowed in a new portal. Turning them off does not delete the links that already exist - whether those stop working at once is decided by the `blockExistingLinksOnRestrict` field of the settings operation named above.
|
|
633
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/external-share/
|
|
634
|
+
# @param [Hash] opts the optional parameters
|
|
635
|
+
# @option opts [DisplayRequestDto] :display_request_dto
|
|
636
|
+
# @return [Array<(BooleanWrapper, Integer, Hash)>] BooleanWrapper data, response status code and response headers
|
|
637
|
+
def external_share_with_http_info(opts = {})
|
|
638
|
+
if @api_client.config.debugging
|
|
639
|
+
@api_client.config.logger.debug 'Calling API: Files::SettingsApi.external_share ...'
|
|
640
|
+
end
|
|
641
|
+
# resource path
|
|
642
|
+
local_var_path = '/api/2.0/files/settings/external'
|
|
643
|
+
|
|
644
|
+
# query parameters
|
|
645
|
+
query_params = opts[:query_params] || {}
|
|
646
|
+
|
|
647
|
+
# header parameters
|
|
648
|
+
header_params = opts[:header_params] || {}
|
|
649
|
+
# HTTP header 'Accept' (if needed)
|
|
650
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
651
|
+
# HTTP header 'Content-Type'
|
|
652
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
653
|
+
if !content_type.nil?
|
|
654
|
+
header_params['Content-Type'] = content_type
|
|
655
|
+
end
|
|
656
|
+
|
|
657
|
+
# form parameters
|
|
658
|
+
form_params = opts[:form_params] || {}
|
|
659
|
+
|
|
660
|
+
# http body (model)
|
|
661
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'display_request_dto'])
|
|
662
|
+
|
|
663
|
+
# return_type
|
|
664
|
+
return_type = opts[:debug_return_type] || 'BooleanWrapper'
|
|
665
|
+
|
|
666
|
+
# auth_names
|
|
667
|
+
auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
|
|
668
|
+
|
|
669
|
+
new_options = opts.merge(
|
|
670
|
+
:operation => :"Files::SettingsApi.external_share",
|
|
671
|
+
:header_params => header_params,
|
|
672
|
+
:query_params => query_params,
|
|
673
|
+
:form_params => form_params,
|
|
674
|
+
:body => post_body,
|
|
675
|
+
:auth_names => auth_names,
|
|
676
|
+
:return_type => return_type
|
|
677
|
+
)
|
|
678
|
+
|
|
679
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
|
|
680
|
+
if @api_client.config.debugging
|
|
681
|
+
@api_client.config.logger.debug "API called: Files::SettingsApi#external_share\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
682
|
+
end
|
|
683
|
+
return data, status_code, headers
|
|
684
|
+
end
|
|
685
|
+
|
|
686
|
+
# Change the external sharing ability on social networks
|
|
687
|
+
# Turns the social-network sharing buttons on or off for the whole portal and returns the value that is now in force. Only the portal owner and a DocSpace administrator may change it; a room administrator, a member or a guest is refused, and so is an unauthenticated caller. The requested value is combined with the state of external sharing itself: while that is off, enabling this setting has no effect and the response comes back false, so turn external sharing on with `PUT api/2.0/files/settings/external` first and only then this one. Turning external sharing off later switches this setting off again on its own. The value is published as `externalShareSocialMedia` by `GET api/2.0/files/settings`. Sending the same value again is safe. Read the response instead of assuming the requested value was stored. The setting governs the share-to-network buttons offered next to an external link; it neither creates nor revokes links, and the links themselves keep working either way.
|
|
688
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/external-share-social-media/
|
|
689
|
+
# @param [Hash] opts the optional parameters
|
|
690
|
+
# @option opts [DisplayRequestDto] :display_request_dto
|
|
691
|
+
# @return [BooleanWrapper]
|
|
692
|
+
def external_share_social_media(opts = {})
|
|
693
|
+
data, _status_code, _headers = external_share_social_media_with_http_info(opts)
|
|
694
|
+
data
|
|
695
|
+
end
|
|
696
|
+
|
|
697
|
+
# Change the external sharing ability on social networks
|
|
698
|
+
# Turns the social-network sharing buttons on or off for the whole portal and returns the value that is now in force. Only the portal owner and a DocSpace administrator may change it; a room administrator, a member or a guest is refused, and so is an unauthenticated caller. The requested value is combined with the state of external sharing itself: while that is off, enabling this setting has no effect and the response comes back false, so turn external sharing on with `PUT api/2.0/files/settings/external` first and only then this one. Turning external sharing off later switches this setting off again on its own. The value is published as `externalShareSocialMedia` by `GET api/2.0/files/settings`. Sending the same value again is safe. Read the response instead of assuming the requested value was stored. The setting governs the share-to-network buttons offered next to an external link; it neither creates nor revokes links, and the links themselves keep working either way.
|
|
699
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/external-share-social-media/
|
|
700
|
+
# @param [Hash] opts the optional parameters
|
|
701
|
+
# @option opts [DisplayRequestDto] :display_request_dto
|
|
702
|
+
# @return [Array<(BooleanWrapper, Integer, Hash)>] BooleanWrapper data, response status code and response headers
|
|
703
|
+
def external_share_social_media_with_http_info(opts = {})
|
|
704
|
+
if @api_client.config.debugging
|
|
705
|
+
@api_client.config.logger.debug 'Calling API: Files::SettingsApi.external_share_social_media ...'
|
|
706
|
+
end
|
|
707
|
+
# resource path
|
|
708
|
+
local_var_path = '/api/2.0/files/settings/externalsocialmedia'
|
|
709
|
+
|
|
710
|
+
# query parameters
|
|
711
|
+
query_params = opts[:query_params] || {}
|
|
712
|
+
|
|
713
|
+
# header parameters
|
|
714
|
+
header_params = opts[:header_params] || {}
|
|
715
|
+
# HTTP header 'Accept' (if needed)
|
|
716
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
717
|
+
# HTTP header 'Content-Type'
|
|
718
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
719
|
+
if !content_type.nil?
|
|
720
|
+
header_params['Content-Type'] = content_type
|
|
721
|
+
end
|
|
722
|
+
|
|
723
|
+
# form parameters
|
|
724
|
+
form_params = opts[:form_params] || {}
|
|
725
|
+
|
|
726
|
+
# http body (model)
|
|
727
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'display_request_dto'])
|
|
728
|
+
|
|
729
|
+
# return_type
|
|
730
|
+
return_type = opts[:debug_return_type] || 'BooleanWrapper'
|
|
731
|
+
|
|
732
|
+
# auth_names
|
|
733
|
+
auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
|
|
734
|
+
|
|
735
|
+
new_options = opts.merge(
|
|
736
|
+
:operation => :"Files::SettingsApi.external_share_social_media",
|
|
737
|
+
:header_params => header_params,
|
|
738
|
+
:query_params => query_params,
|
|
739
|
+
:form_params => form_params,
|
|
740
|
+
:body => post_body,
|
|
741
|
+
:auth_names => auth_names,
|
|
742
|
+
:return_type => return_type
|
|
743
|
+
)
|
|
744
|
+
|
|
745
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
|
|
746
|
+
if @api_client.config.debugging
|
|
747
|
+
@api_client.config.logger.debug "API called: Files::SettingsApi#external_share_social_media\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
748
|
+
end
|
|
749
|
+
return data, status_code, headers
|
|
750
|
+
end
|
|
751
|
+
|
|
752
|
+
# Change the forcesaving ability
|
|
753
|
+
# Reports that forcesaving is on for this portal. The operation is a stub kept for compatibility: it takes no request body, stores nothing and always answers true, so calling it neither turns forcesaving on nor off and repeating it changes nothing. Forcesaving itself - the editor writing the document back to storage while the session is still open - is on for every portal and cannot be switched off through the API. Any authenticated role down to a guest may call it; an unauthenticated caller is refused. The same constant is published as `forcesave` by `GET api/2.0/files/settings`, which is the cheaper way to read it together with the rest of the settings. A companion stub, `PUT api/2.0/files/storeforcesave`, answers for the storing of forcesaved versions in the same way. Nothing in this call reaches a document: to have the current state of an editing session written to storage, drive the document through the editor operations of the file itself rather than through this setting.
|
|
754
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/forcesave/
|
|
755
|
+
# @param [Hash] opts the optional parameters
|
|
756
|
+
# @return [BooleanWrapper]
|
|
757
|
+
def forcesave(opts = {})
|
|
758
|
+
data, _status_code, _headers = forcesave_with_http_info(opts)
|
|
759
|
+
data
|
|
760
|
+
end
|
|
761
|
+
|
|
762
|
+
# Change the forcesaving ability
|
|
763
|
+
# Reports that forcesaving is on for this portal. The operation is a stub kept for compatibility: it takes no request body, stores nothing and always answers true, so calling it neither turns forcesaving on nor off and repeating it changes nothing. Forcesaving itself - the editor writing the document back to storage while the session is still open - is on for every portal and cannot be switched off through the API. Any authenticated role down to a guest may call it; an unauthenticated caller is refused. The same constant is published as `forcesave` by `GET api/2.0/files/settings`, which is the cheaper way to read it together with the rest of the settings. A companion stub, `PUT api/2.0/files/storeforcesave`, answers for the storing of forcesaved versions in the same way. Nothing in this call reaches a document: to have the current state of an editing session written to storage, drive the document through the editor operations of the file itself rather than through this setting.
|
|
764
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/forcesave/
|
|
765
|
+
# @param [Hash] opts the optional parameters
|
|
766
|
+
# @return [Array<(BooleanWrapper, Integer, Hash)>] BooleanWrapper data, response status code and response headers
|
|
767
|
+
def forcesave_with_http_info(opts = {})
|
|
768
|
+
if @api_client.config.debugging
|
|
769
|
+
@api_client.config.logger.debug 'Calling API: Files::SettingsApi.forcesave ...'
|
|
770
|
+
end
|
|
771
|
+
# resource path
|
|
772
|
+
local_var_path = '/api/2.0/files/forcesave'
|
|
773
|
+
|
|
774
|
+
# query parameters
|
|
775
|
+
query_params = opts[:query_params] || {}
|
|
776
|
+
|
|
777
|
+
# header parameters
|
|
778
|
+
header_params = opts[:header_params] || {}
|
|
779
|
+
# HTTP header 'Accept' (if needed)
|
|
780
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
781
|
+
|
|
782
|
+
# form parameters
|
|
783
|
+
form_params = opts[:form_params] || {}
|
|
784
|
+
|
|
785
|
+
# http body (model)
|
|
786
|
+
post_body = opts[:debug_body]
|
|
787
|
+
|
|
788
|
+
# return_type
|
|
789
|
+
return_type = opts[:debug_return_type] || 'BooleanWrapper'
|
|
790
|
+
|
|
791
|
+
# auth_names
|
|
792
|
+
auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
|
|
793
|
+
|
|
794
|
+
new_options = opts.merge(
|
|
795
|
+
:operation => :"Files::SettingsApi.forcesave",
|
|
796
|
+
:header_params => header_params,
|
|
797
|
+
:query_params => query_params,
|
|
798
|
+
:form_params => form_params,
|
|
799
|
+
:body => post_body,
|
|
800
|
+
:auth_names => auth_names,
|
|
801
|
+
:return_type => return_type
|
|
802
|
+
)
|
|
803
|
+
|
|
804
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
|
|
805
|
+
if @api_client.config.debugging
|
|
806
|
+
@api_client.config.logger.debug "API called: Files::SettingsApi#forcesave\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
807
|
+
end
|
|
808
|
+
return data, status_code, headers
|
|
809
|
+
end
|
|
810
|
+
|
|
811
|
+
# Get the trash bin auto-clearing setting
|
|
812
|
+
# Returns the trash auto-clearing setting of the calling account: whether it is on, and after which interval an item that sits in the trash is removed for good. The setting belongs to that account alone, so every authenticated role down to a guest reads its own value and an unauthenticated caller is refused. The first call for an account is not read-only: when nothing has been stored yet the portal writes the default - clearing on, thirty days - and returns it, so the answer never comes back empty and a following call reports the same pair. The interval is the age of an entry in the trash, not a schedule; each trashed entry also reports the moment it is due to disappear in its own `autoDelete` field. Use `PUT api/2.0/files/settings/autocleanup` to change the pair, or read it together with the rest of the configuration from `GET api/2.0/files/settings`.
|
|
813
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-automatically-clean-up/
|
|
814
|
+
# @param [Hash] opts the optional parameters
|
|
815
|
+
# @return [AutoCleanUpDataWrapper]
|
|
816
|
+
def get_automatically_clean_up(opts = {})
|
|
817
|
+
data, _status_code, _headers = get_automatically_clean_up_with_http_info(opts)
|
|
818
|
+
data
|
|
819
|
+
end
|
|
820
|
+
|
|
821
|
+
# Get the trash bin auto-clearing setting
|
|
822
|
+
# Returns the trash auto-clearing setting of the calling account: whether it is on, and after which interval an item that sits in the trash is removed for good. The setting belongs to that account alone, so every authenticated role down to a guest reads its own value and an unauthenticated caller is refused. The first call for an account is not read-only: when nothing has been stored yet the portal writes the default - clearing on, thirty days - and returns it, so the answer never comes back empty and a following call reports the same pair. The interval is the age of an entry in the trash, not a schedule; each trashed entry also reports the moment it is due to disappear in its own `autoDelete` field. Use `PUT api/2.0/files/settings/autocleanup` to change the pair, or read it together with the rest of the configuration from `GET api/2.0/files/settings`.
|
|
823
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-automatically-clean-up/
|
|
824
|
+
# @param [Hash] opts the optional parameters
|
|
825
|
+
# @return [Array<(AutoCleanUpDataWrapper, Integer, Hash)>] AutoCleanUpDataWrapper data, response status code and response headers
|
|
826
|
+
def get_automatically_clean_up_with_http_info(opts = {})
|
|
827
|
+
if @api_client.config.debugging
|
|
828
|
+
@api_client.config.logger.debug 'Calling API: Files::SettingsApi.get_automatically_clean_up ...'
|
|
829
|
+
end
|
|
830
|
+
# resource path
|
|
831
|
+
local_var_path = '/api/2.0/files/settings/autocleanup'
|
|
832
|
+
|
|
833
|
+
# query parameters
|
|
834
|
+
query_params = opts[:query_params] || {}
|
|
835
|
+
|
|
836
|
+
# header parameters
|
|
837
|
+
header_params = opts[:header_params] || {}
|
|
838
|
+
# HTTP header 'Accept' (if needed)
|
|
839
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
840
|
+
|
|
841
|
+
# form parameters
|
|
842
|
+
form_params = opts[:form_params] || {}
|
|
843
|
+
|
|
844
|
+
# http body (model)
|
|
845
|
+
post_body = opts[:debug_body]
|
|
846
|
+
|
|
847
|
+
# return_type
|
|
848
|
+
return_type = opts[:debug_return_type] || 'AutoCleanUpDataWrapper'
|
|
849
|
+
|
|
850
|
+
# auth_names
|
|
851
|
+
auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
|
|
852
|
+
|
|
853
|
+
new_options = opts.merge(
|
|
854
|
+
:operation => :"Files::SettingsApi.get_automatically_clean_up",
|
|
855
|
+
:header_params => header_params,
|
|
856
|
+
:query_params => query_params,
|
|
857
|
+
:form_params => form_params,
|
|
858
|
+
:body => post_body,
|
|
859
|
+
:auth_names => auth_names,
|
|
860
|
+
:return_type => return_type
|
|
861
|
+
)
|
|
862
|
+
|
|
863
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
864
|
+
if @api_client.config.debugging
|
|
865
|
+
@api_client.config.logger.debug "API called: Files::SettingsApi#get_automatically_clean_up\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
866
|
+
end
|
|
867
|
+
return data, status_code, headers
|
|
868
|
+
end
|
|
869
|
+
|
|
870
|
+
# Get the default template setting
|
|
871
|
+
# Returns the blank document the portal creates for each format: one entry per extension the built-in template set covers, with the file that has been chosen as the blank for it, if any. An entry whose `selectedFile` is null means no custom template has been set and the built-in blank is used; the remaining fields - title, size, modification moment and view address - are filled only for a custom one. The list is assembled from the portal's built-in template set on every call, so an extension the set no longer covers disappears from it. Entries come in the order the interface shows them: the text document, spreadsheet, presentation and PDF formats first, the rest by extension. Reading the setting requires the portal settings permission, so only the portal owner and a DocSpace administrator may call it. Use `PUT api/2.0/files/settings/defaulttemplate` to choose an existing file and the matching POST to upload one.
|
|
872
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-default-templates/
|
|
873
|
+
# @param [Hash] opts the optional parameters
|
|
874
|
+
# @return [DefaultTemplateSettingsWrapper]
|
|
875
|
+
def get_default_templates(opts = {})
|
|
876
|
+
data, _status_code, _headers = get_default_templates_with_http_info(opts)
|
|
877
|
+
data
|
|
878
|
+
end
|
|
879
|
+
|
|
880
|
+
# Get the default template setting
|
|
881
|
+
# Returns the blank document the portal creates for each format: one entry per extension the built-in template set covers, with the file that has been chosen as the blank for it, if any. An entry whose `selectedFile` is null means no custom template has been set and the built-in blank is used; the remaining fields - title, size, modification moment and view address - are filled only for a custom one. The list is assembled from the portal's built-in template set on every call, so an extension the set no longer covers disappears from it. Entries come in the order the interface shows them: the text document, spreadsheet, presentation and PDF formats first, the rest by extension. Reading the setting requires the portal settings permission, so only the portal owner and a DocSpace administrator may call it. Use `PUT api/2.0/files/settings/defaulttemplate` to choose an existing file and the matching POST to upload one.
|
|
882
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-default-templates/
|
|
883
|
+
# @param [Hash] opts the optional parameters
|
|
884
|
+
# @return [Array<(DefaultTemplateSettingsWrapper, Integer, Hash)>] DefaultTemplateSettingsWrapper data, response status code and response headers
|
|
885
|
+
def get_default_templates_with_http_info(opts = {})
|
|
886
|
+
if @api_client.config.debugging
|
|
887
|
+
@api_client.config.logger.debug 'Calling API: Files::SettingsApi.get_default_templates ...'
|
|
888
|
+
end
|
|
889
|
+
# resource path
|
|
890
|
+
local_var_path = '/api/2.0/files/settings/defaulttemplate'
|
|
891
|
+
|
|
892
|
+
# query parameters
|
|
893
|
+
query_params = opts[:query_params] || {}
|
|
894
|
+
|
|
895
|
+
# header parameters
|
|
896
|
+
header_params = opts[:header_params] || {}
|
|
897
|
+
# HTTP header 'Accept' (if needed)
|
|
898
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
899
|
+
|
|
900
|
+
# form parameters
|
|
901
|
+
form_params = opts[:form_params] || {}
|
|
902
|
+
|
|
903
|
+
# http body (model)
|
|
904
|
+
post_body = opts[:debug_body]
|
|
905
|
+
|
|
906
|
+
# return_type
|
|
907
|
+
return_type = opts[:debug_return_type] || 'DefaultTemplateSettingsWrapper'
|
|
908
|
+
|
|
909
|
+
# auth_names
|
|
910
|
+
auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
|
|
911
|
+
|
|
912
|
+
new_options = opts.merge(
|
|
913
|
+
:operation => :"Files::SettingsApi.get_default_templates",
|
|
914
|
+
:header_params => header_params,
|
|
915
|
+
:query_params => query_params,
|
|
916
|
+
:form_params => form_params,
|
|
917
|
+
:body => post_body,
|
|
918
|
+
:auth_names => auth_names,
|
|
919
|
+
:return_type => return_type
|
|
920
|
+
)
|
|
921
|
+
|
|
922
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
923
|
+
if @api_client.config.debugging
|
|
924
|
+
@api_client.config.logger.debug "API called: Files::SettingsApi#get_default_templates\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
925
|
+
end
|
|
926
|
+
return data, status_code, headers
|
|
927
|
+
end
|
|
928
|
+
|
|
929
|
+
# Get the document service address
|
|
930
|
+
# Reports where this portal expects ONLYOFFICE Docs to be: the public Document Server address, the URL of the editor api script and of the preload page a client loads before opening a document, the address used inside the private network, the address the Document Server calls this portal back on, the name of the request signature header, whether SSL verification is on, and whether all of it is still at the deployment default. The call is read-only and needs no authorization: an anonymous caller and every role from the portal owner down to a guest read the same values. Pass `version=true` to have the editor version of the running Document Server included in `version`; left out, `version` comes back empty and the portal answers without contacting the Document Server at all. A version request never fails the call - when the Document Server does not answer, a fallback version string is reported instead of an error, so the value is no proof that the server is reachable. The signature secret is not part of the answer, only the header name it travels in. To change any of these settings use `PUT api/2.0/files/docservice`.
|
|
931
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-doc-service-url/
|
|
932
|
+
# @param [Hash] opts the optional parameters
|
|
933
|
+
# @option opts [Boolean] :version Whether the running Document Server is asked for its editor version so that `version` can report it. Left off, the portal answers from its own settings without contacting the Document Server and `version` comes back empty.
|
|
934
|
+
# @return [DocServiceUrlWrapper]
|
|
935
|
+
def get_doc_service_url(opts = {})
|
|
936
|
+
data, _status_code, _headers = get_doc_service_url_with_http_info(opts)
|
|
937
|
+
data
|
|
938
|
+
end
|
|
939
|
+
|
|
940
|
+
# Get the document service address
|
|
941
|
+
# Reports where this portal expects ONLYOFFICE Docs to be: the public Document Server address, the URL of the editor api script and of the preload page a client loads before opening a document, the address used inside the private network, the address the Document Server calls this portal back on, the name of the request signature header, whether SSL verification is on, and whether all of it is still at the deployment default. The call is read-only and needs no authorization: an anonymous caller and every role from the portal owner down to a guest read the same values. Pass `version=true` to have the editor version of the running Document Server included in `version`; left out, `version` comes back empty and the portal answers without contacting the Document Server at all. A version request never fails the call - when the Document Server does not answer, a fallback version string is reported instead of an error, so the value is no proof that the server is reachable. The signature secret is not part of the answer, only the header name it travels in. To change any of these settings use `PUT api/2.0/files/docservice`.
|
|
942
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-doc-service-url/
|
|
943
|
+
# @param [Hash] opts the optional parameters
|
|
944
|
+
# @option opts [Boolean] :version Whether the running Document Server is asked for its editor version so that `version` can report it. Left off, the portal answers from its own settings without contacting the Document Server and `version` comes back empty.
|
|
945
|
+
# @return [Array<(DocServiceUrlWrapper, Integer, Hash)>] DocServiceUrlWrapper data, response status code and response headers
|
|
946
|
+
def get_doc_service_url_with_http_info(opts = {})
|
|
947
|
+
if @api_client.config.debugging
|
|
948
|
+
@api_client.config.logger.debug 'Calling API: Files::SettingsApi.get_doc_service_url ...'
|
|
949
|
+
end
|
|
950
|
+
# resource path
|
|
951
|
+
local_var_path = '/api/2.0/files/docservice'
|
|
952
|
+
|
|
953
|
+
# query parameters
|
|
954
|
+
query_params = opts[:query_params] || {}
|
|
955
|
+
query_params[:'version'] = opts[:'version'] if !opts[:'version'].nil?
|
|
956
|
+
|
|
957
|
+
# header parameters
|
|
958
|
+
header_params = opts[:header_params] || {}
|
|
959
|
+
# HTTP header 'Accept' (if needed)
|
|
960
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
961
|
+
|
|
962
|
+
# form parameters
|
|
963
|
+
form_params = opts[:form_params] || {}
|
|
964
|
+
|
|
965
|
+
# http body (model)
|
|
966
|
+
post_body = opts[:debug_body]
|
|
967
|
+
|
|
968
|
+
# return_type
|
|
969
|
+
return_type = opts[:debug_return_type] || 'DocServiceUrlWrapper'
|
|
970
|
+
|
|
971
|
+
# auth_names
|
|
972
|
+
auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
|
|
973
|
+
|
|
974
|
+
new_options = opts.merge(
|
|
975
|
+
:operation => :"Files::SettingsApi.get_doc_service_url",
|
|
976
|
+
:header_params => header_params,
|
|
977
|
+
:query_params => query_params,
|
|
978
|
+
:form_params => form_params,
|
|
979
|
+
:body => post_body,
|
|
980
|
+
:auth_names => auth_names,
|
|
981
|
+
:return_type => return_type
|
|
982
|
+
)
|
|
983
|
+
|
|
984
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
985
|
+
if @api_client.config.debugging
|
|
986
|
+
@api_client.config.logger.debug "API called: Files::SettingsApi#get_doc_service_url\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
987
|
+
end
|
|
988
|
+
return data, status_code, headers
|
|
989
|
+
end
|
|
990
|
+
|
|
991
|
+
# Get the Documents module information
|
|
992
|
+
# Returns the descriptor of the Documents module of this portal: its identifier, display title and description, the address of its start page, the icon and image addresses, the address of its help section, and whether it is the portal's primary module. It is meant for building navigation to the module, not for working with documents: nothing about files, rooms or permissions comes back, and nothing is changed by the call. The values follow the portal's own configuration and branding, so the title and the description arrive already translated for the caller. Any authenticated role down to a guest may read it; an unauthenticated caller is refused. The content is the same for everyone in the portal and changes only when the portal is reconfigured, so it can be fetched once and cached rather than requested per screen. Only the Documents module is described here; this document carries no listing of the other modules of the portal. The file-related configuration a client needs alongside it - the format tables, the editor addresses and the upload limits - comes from `GET api/2.0/files/settings`.
|
|
993
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-files-module/
|
|
994
|
+
# @param [Hash] opts the optional parameters
|
|
995
|
+
# @return [ModuleWrapper]
|
|
996
|
+
def get_files_module(opts = {})
|
|
997
|
+
data, _status_code, _headers = get_files_module_with_http_info(opts)
|
|
998
|
+
data
|
|
999
|
+
end
|
|
1000
|
+
|
|
1001
|
+
# Get the Documents module information
|
|
1002
|
+
# Returns the descriptor of the Documents module of this portal: its identifier, display title and description, the address of its start page, the icon and image addresses, the address of its help section, and whether it is the portal's primary module. It is meant for building navigation to the module, not for working with documents: nothing about files, rooms or permissions comes back, and nothing is changed by the call. The values follow the portal's own configuration and branding, so the title and the description arrive already translated for the caller. Any authenticated role down to a guest may read it; an unauthenticated caller is refused. The content is the same for everyone in the portal and changes only when the portal is reconfigured, so it can be fetched once and cached rather than requested per screen. Only the Documents module is described here; this document carries no listing of the other modules of the portal. The file-related configuration a client needs alongside it - the format tables, the editor addresses and the upload limits - comes from `GET api/2.0/files/settings`.
|
|
1003
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-files-module/
|
|
1004
|
+
# @param [Hash] opts the optional parameters
|
|
1005
|
+
# @return [Array<(ModuleWrapper, Integer, Hash)>] ModuleWrapper data, response status code and response headers
|
|
1006
|
+
def get_files_module_with_http_info(opts = {})
|
|
1007
|
+
if @api_client.config.debugging
|
|
1008
|
+
@api_client.config.logger.debug 'Calling API: Files::SettingsApi.get_files_module ...'
|
|
1009
|
+
end
|
|
1010
|
+
# resource path
|
|
1011
|
+
local_var_path = '/api/2.0/files/info'
|
|
1012
|
+
|
|
1013
|
+
# query parameters
|
|
1014
|
+
query_params = opts[:query_params] || {}
|
|
1015
|
+
|
|
1016
|
+
# header parameters
|
|
1017
|
+
header_params = opts[:header_params] || {}
|
|
1018
|
+
# HTTP header 'Accept' (if needed)
|
|
1019
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
1020
|
+
|
|
1021
|
+
# form parameters
|
|
1022
|
+
form_params = opts[:form_params] || {}
|
|
1023
|
+
|
|
1024
|
+
# http body (model)
|
|
1025
|
+
post_body = opts[:debug_body]
|
|
1026
|
+
|
|
1027
|
+
# return_type
|
|
1028
|
+
return_type = opts[:debug_return_type] || 'ModuleWrapper'
|
|
1029
|
+
|
|
1030
|
+
# auth_names
|
|
1031
|
+
auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
|
|
1032
|
+
|
|
1033
|
+
new_options = opts.merge(
|
|
1034
|
+
:operation => :"Files::SettingsApi.get_files_module",
|
|
1035
|
+
:header_params => header_params,
|
|
1036
|
+
:query_params => query_params,
|
|
1037
|
+
:form_params => form_params,
|
|
1038
|
+
:body => post_body,
|
|
1039
|
+
:auth_names => auth_names,
|
|
1040
|
+
:return_type => return_type
|
|
1041
|
+
)
|
|
1042
|
+
|
|
1043
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
1044
|
+
if @api_client.config.debugging
|
|
1045
|
+
@api_client.config.logger.debug "API called: Files::SettingsApi#get_files_module\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1046
|
+
end
|
|
1047
|
+
return data, status_code, headers
|
|
1048
|
+
end
|
|
1049
|
+
|
|
1050
|
+
# Get file settings
|
|
1051
|
+
# Returns the whole Files configuration in one object: the caller's own preferences (trash auto-clearing, default sharing rights, hidden confirmation dialogs, archive format, section visibility), the portal-wide switches an administrator controls (third-party storages, external sharing), and the static tables a client needs to work with documents - which extensions can be viewed, edited, converted or uploaded, the URL templates for the viewer, editor and thumbnails, and the upload limits. This is the read side of the setting operations in this section: each of those answers with the one value it wrote, and only the trash auto-clearing and default-template settings have a GET of their own. Marked as allowing anonymous access because the external-link pages read the extension tables before signing in, but a caller with neither a session nor a valid link key is still rejected. The result is not filtered by role and is not paginated; fetch it once per session rather than before each file action.
|
|
1052
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-files-settings/
|
|
1053
|
+
# @param [Hash] opts the optional parameters
|
|
1054
|
+
# @return [FilesSettingsWrapper]
|
|
1055
|
+
def get_files_settings(opts = {})
|
|
1056
|
+
data, _status_code, _headers = get_files_settings_with_http_info(opts)
|
|
1057
|
+
data
|
|
1058
|
+
end
|
|
1059
|
+
|
|
1060
|
+
# Get file settings
|
|
1061
|
+
# Returns the whole Files configuration in one object: the caller's own preferences (trash auto-clearing, default sharing rights, hidden confirmation dialogs, archive format, section visibility), the portal-wide switches an administrator controls (third-party storages, external sharing), and the static tables a client needs to work with documents - which extensions can be viewed, edited, converted or uploaded, the URL templates for the viewer, editor and thumbnails, and the upload limits. This is the read side of the setting operations in this section: each of those answers with the one value it wrote, and only the trash auto-clearing and default-template settings have a GET of their own. Marked as allowing anonymous access because the external-link pages read the extension tables before signing in, but a caller with neither a session nor a valid link key is still rejected. The result is not filtered by role and is not paginated; fetch it once per session rather than before each file action.
|
|
1062
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-files-settings/
|
|
1063
|
+
# @param [Hash] opts the optional parameters
|
|
1064
|
+
# @return [Array<(FilesSettingsWrapper, Integer, Hash)>] FilesSettingsWrapper data, response status code and response headers
|
|
1065
|
+
def get_files_settings_with_http_info(opts = {})
|
|
1066
|
+
if @api_client.config.debugging
|
|
1067
|
+
@api_client.config.logger.debug 'Calling API: Files::SettingsApi.get_files_settings ...'
|
|
1068
|
+
end
|
|
1069
|
+
# resource path
|
|
1070
|
+
local_var_path = '/api/2.0/files/settings'
|
|
1071
|
+
|
|
1072
|
+
# query parameters
|
|
1073
|
+
query_params = opts[:query_params] || {}
|
|
1074
|
+
|
|
1075
|
+
# header parameters
|
|
1076
|
+
header_params = opts[:header_params] || {}
|
|
1077
|
+
# HTTP header 'Accept' (if needed)
|
|
1078
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
1079
|
+
|
|
1080
|
+
# form parameters
|
|
1081
|
+
form_params = opts[:form_params] || {}
|
|
1082
|
+
|
|
1083
|
+
# http body (model)
|
|
1084
|
+
post_body = opts[:debug_body]
|
|
1085
|
+
|
|
1086
|
+
# return_type
|
|
1087
|
+
return_type = opts[:debug_return_type] || 'FilesSettingsWrapper'
|
|
1088
|
+
|
|
1089
|
+
# auth_names
|
|
1090
|
+
auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
|
|
1091
|
+
|
|
1092
|
+
new_options = opts.merge(
|
|
1093
|
+
:operation => :"Files::SettingsApi.get_files_settings",
|
|
1094
|
+
:header_params => header_params,
|
|
1095
|
+
:query_params => query_params,
|
|
1096
|
+
:form_params => form_params,
|
|
1097
|
+
:body => post_body,
|
|
1098
|
+
:auth_names => auth_names,
|
|
1099
|
+
:return_type => return_type
|
|
1100
|
+
)
|
|
1101
|
+
|
|
1102
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
1103
|
+
if @api_client.config.debugging
|
|
1104
|
+
@api_client.config.logger.debug "API called: Files::SettingsApi#get_files_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1105
|
+
end
|
|
1106
|
+
return data, status_code, headers
|
|
1107
|
+
end
|
|
1108
|
+
|
|
1109
|
+
# Hide confirmation dialog when canceling operations
|
|
1110
|
+
# Stores whether the caller is asked to confirm cancelling a running file operation, and returns the value that is now stored. The setting belongs to the calling account alone: every authenticated role down to a guest may change its own copy, and an unauthenticated caller is refused. Unlike the conversion prompt of `PUT api/2.0/files/hideconfirmconvert`, this one works in both directions - `set=true` hides the confirmation, `set=false` brings it back. It is a hint for the interface only: cancelling an operation through the API is unaffected, and the operations themselves keep being reported by `GET api/2.0/files/fileops`. The value is published as `hideConfirmCancelOperation` by `GET api/2.0/files/settings`, which is the only way to read it back. Writing a value that is already stored is accepted and leaves the setting untouched. A new account starts with the confirmation shown. The prompt it hides is the one raised when a running copy, move or download is about to be abandoned, not the one raised before a deletion - that one is `PUT api/2.0/files/changedeleteconfrim`.
|
|
1111
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/hide-confirm-cancel-operation/
|
|
1112
|
+
# @param [Hash] opts the optional parameters
|
|
1113
|
+
# @option opts [SettingsRequestDto] :settings_request_dto
|
|
1114
|
+
# @return [BooleanWrapper]
|
|
1115
|
+
def hide_confirm_cancel_operation(opts = {})
|
|
1116
|
+
data, _status_code, _headers = hide_confirm_cancel_operation_with_http_info(opts)
|
|
1117
|
+
data
|
|
1118
|
+
end
|
|
1119
|
+
|
|
1120
|
+
# Hide confirmation dialog when canceling operations
|
|
1121
|
+
# Stores whether the caller is asked to confirm cancelling a running file operation, and returns the value that is now stored. The setting belongs to the calling account alone: every authenticated role down to a guest may change its own copy, and an unauthenticated caller is refused. Unlike the conversion prompt of `PUT api/2.0/files/hideconfirmconvert`, this one works in both directions - `set=true` hides the confirmation, `set=false` brings it back. It is a hint for the interface only: cancelling an operation through the API is unaffected, and the operations themselves keep being reported by `GET api/2.0/files/fileops`. The value is published as `hideConfirmCancelOperation` by `GET api/2.0/files/settings`, which is the only way to read it back. Writing a value that is already stored is accepted and leaves the setting untouched. A new account starts with the confirmation shown. The prompt it hides is the one raised when a running copy, move or download is about to be abandoned, not the one raised before a deletion - that one is `PUT api/2.0/files/changedeleteconfrim`.
|
|
1122
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/hide-confirm-cancel-operation/
|
|
1123
|
+
# @param [Hash] opts the optional parameters
|
|
1124
|
+
# @option opts [SettingsRequestDto] :settings_request_dto
|
|
1125
|
+
# @return [Array<(BooleanWrapper, Integer, Hash)>] BooleanWrapper data, response status code and response headers
|
|
1126
|
+
def hide_confirm_cancel_operation_with_http_info(opts = {})
|
|
1127
|
+
if @api_client.config.debugging
|
|
1128
|
+
@api_client.config.logger.debug 'Calling API: Files::SettingsApi.hide_confirm_cancel_operation ...'
|
|
1129
|
+
end
|
|
1130
|
+
# resource path
|
|
1131
|
+
local_var_path = '/api/2.0/files/hideconfirmcanceloperation'
|
|
1132
|
+
|
|
1133
|
+
# query parameters
|
|
1134
|
+
query_params = opts[:query_params] || {}
|
|
1135
|
+
|
|
1136
|
+
# header parameters
|
|
1137
|
+
header_params = opts[:header_params] || {}
|
|
1138
|
+
# HTTP header 'Accept' (if needed)
|
|
1139
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
1140
|
+
# HTTP header 'Content-Type'
|
|
1141
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
1142
|
+
if !content_type.nil?
|
|
1143
|
+
header_params['Content-Type'] = content_type
|
|
1144
|
+
end
|
|
1145
|
+
|
|
1146
|
+
# form parameters
|
|
1147
|
+
form_params = opts[:form_params] || {}
|
|
1148
|
+
|
|
1149
|
+
# http body (model)
|
|
1150
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'settings_request_dto'])
|
|
1151
|
+
|
|
1152
|
+
# return_type
|
|
1153
|
+
return_type = opts[:debug_return_type] || 'BooleanWrapper'
|
|
1154
|
+
|
|
1155
|
+
# auth_names
|
|
1156
|
+
auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
|
|
1157
|
+
|
|
1158
|
+
new_options = opts.merge(
|
|
1159
|
+
:operation => :"Files::SettingsApi.hide_confirm_cancel_operation",
|
|
1160
|
+
:header_params => header_params,
|
|
1161
|
+
:query_params => query_params,
|
|
1162
|
+
:form_params => form_params,
|
|
1163
|
+
:body => post_body,
|
|
1164
|
+
:auth_names => auth_names,
|
|
1165
|
+
:return_type => return_type
|
|
1166
|
+
)
|
|
1167
|
+
|
|
1168
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
|
|
1169
|
+
if @api_client.config.debugging
|
|
1170
|
+
@api_client.config.logger.debug "API called: Files::SettingsApi#hide_confirm_cancel_operation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1171
|
+
end
|
|
1172
|
+
return data, status_code, headers
|
|
1173
|
+
end
|
|
1174
|
+
|
|
1175
|
+
# Hide the confirmation dialog when converting
|
|
1176
|
+
# Hides one of the two prompts the interface shows around file conversion, for the calling account only. The `save` field chooses which prompt, and is not the value being written: `save=true` hides the prompt that offers to keep a copy in the original format when a file is converted, `save=false` hides the prompt that offers to open the conversion result. Both flags are one-way - the operation can only hide a prompt, and there is no API to show it again - so the answer is always true and repeating the call changes nothing. The two flags are independent: hiding one leaves the other as it was. Every authenticated role down to a guest may set its own, and an unauthenticated caller is refused. The stored flags are published as `hideConfirmConvertSave` and `hideConfirmConvertOpen` by `GET api/2.0/files/settings`. Conversion itself is started by `PUT api/2.0/files/file/{fileId}/checkconversion` and is not affected by either flag.
|
|
1177
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/hide-confirm-convert/
|
|
1178
|
+
# @param [Hash] opts the optional parameters
|
|
1179
|
+
# @option opts [HideConfirmConvertRequestDto] :hide_confirm_convert_request_dto
|
|
1180
|
+
# @return [BooleanWrapper]
|
|
1181
|
+
def hide_confirm_convert(opts = {})
|
|
1182
|
+
data, _status_code, _headers = hide_confirm_convert_with_http_info(opts)
|
|
1183
|
+
data
|
|
1184
|
+
end
|
|
1185
|
+
|
|
1186
|
+
# Hide the confirmation dialog when converting
|
|
1187
|
+
# Hides one of the two prompts the interface shows around file conversion, for the calling account only. The `save` field chooses which prompt, and is not the value being written: `save=true` hides the prompt that offers to keep a copy in the original format when a file is converted, `save=false` hides the prompt that offers to open the conversion result. Both flags are one-way - the operation can only hide a prompt, and there is no API to show it again - so the answer is always true and repeating the call changes nothing. The two flags are independent: hiding one leaves the other as it was. Every authenticated role down to a guest may set its own, and an unauthenticated caller is refused. The stored flags are published as `hideConfirmConvertSave` and `hideConfirmConvertOpen` by `GET api/2.0/files/settings`. Conversion itself is started by `PUT api/2.0/files/file/{fileId}/checkconversion` and is not affected by either flag.
|
|
1188
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/hide-confirm-convert/
|
|
1189
|
+
# @param [Hash] opts the optional parameters
|
|
1190
|
+
# @option opts [HideConfirmConvertRequestDto] :hide_confirm_convert_request_dto
|
|
1191
|
+
# @return [Array<(BooleanWrapper, Integer, Hash)>] BooleanWrapper data, response status code and response headers
|
|
1192
|
+
def hide_confirm_convert_with_http_info(opts = {})
|
|
1193
|
+
if @api_client.config.debugging
|
|
1194
|
+
@api_client.config.logger.debug 'Calling API: Files::SettingsApi.hide_confirm_convert ...'
|
|
1195
|
+
end
|
|
1196
|
+
# resource path
|
|
1197
|
+
local_var_path = '/api/2.0/files/hideconfirmconvert'
|
|
1198
|
+
|
|
1199
|
+
# query parameters
|
|
1200
|
+
query_params = opts[:query_params] || {}
|
|
1201
|
+
|
|
1202
|
+
# header parameters
|
|
1203
|
+
header_params = opts[:header_params] || {}
|
|
1204
|
+
# HTTP header 'Accept' (if needed)
|
|
1205
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
1206
|
+
# HTTP header 'Content-Type'
|
|
1207
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
1208
|
+
if !content_type.nil?
|
|
1209
|
+
header_params['Content-Type'] = content_type
|
|
1210
|
+
end
|
|
1211
|
+
|
|
1212
|
+
# form parameters
|
|
1213
|
+
form_params = opts[:form_params] || {}
|
|
1214
|
+
|
|
1215
|
+
# http body (model)
|
|
1216
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'hide_confirm_convert_request_dto'])
|
|
1217
|
+
|
|
1218
|
+
# return_type
|
|
1219
|
+
return_type = opts[:debug_return_type] || 'BooleanWrapper'
|
|
1220
|
+
|
|
1221
|
+
# auth_names
|
|
1222
|
+
auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
|
|
1223
|
+
|
|
1224
|
+
new_options = opts.merge(
|
|
1225
|
+
:operation => :"Files::SettingsApi.hide_confirm_convert",
|
|
1226
|
+
:header_params => header_params,
|
|
1227
|
+
:query_params => query_params,
|
|
1228
|
+
:form_params => form_params,
|
|
1229
|
+
:body => post_body,
|
|
1230
|
+
:auth_names => auth_names,
|
|
1231
|
+
:return_type => return_type
|
|
1232
|
+
)
|
|
1233
|
+
|
|
1234
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
|
|
1235
|
+
if @api_client.config.debugging
|
|
1236
|
+
@api_client.config.logger.debug "API called: Files::SettingsApi#hide_confirm_convert\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1237
|
+
end
|
|
1238
|
+
return data, status_code, headers
|
|
1239
|
+
end
|
|
1240
|
+
|
|
1241
|
+
# Hide confirmation dialog when changing room lifetime settings
|
|
1242
|
+
# Stores whether the caller is warned before the lifetime settings of a room are changed, and returns the value that is now stored. A room lifetime moves the files of the room to the trash once they reach the configured age, which is why the interface confirms the change; this setting decides whether that confirmation is shown to the calling account. It belongs to that account alone: every authenticated role down to a guest may change its own copy, and an unauthenticated caller is refused. It works in both directions - `set=true` hides the warning, `set=false` brings it back - and is a hint for the interface only, so changing a room lifetime through `PUT api/2.0/files/rooms/{id}` is unaffected. The value is published as `hideConfirmRoomLifetime` by `GET api/2.0/files/settings`, which is the only way to read it back. A new account starts with the warning shown, and writing a value that is already stored is accepted and leaves the setting untouched. Hiding the warning does not shorten or extend any lifetime: what a room does with ageing files is decided by the room itself.
|
|
1243
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/hide-confirm-room-lifetime/
|
|
1244
|
+
# @param [Hash] opts the optional parameters
|
|
1245
|
+
# @option opts [SettingsRequestDto] :settings_request_dto
|
|
1246
|
+
# @return [BooleanWrapper]
|
|
1247
|
+
def hide_confirm_room_lifetime(opts = {})
|
|
1248
|
+
data, _status_code, _headers = hide_confirm_room_lifetime_with_http_info(opts)
|
|
1249
|
+
data
|
|
1250
|
+
end
|
|
1251
|
+
|
|
1252
|
+
# Hide confirmation dialog when changing room lifetime settings
|
|
1253
|
+
# Stores whether the caller is warned before the lifetime settings of a room are changed, and returns the value that is now stored. A room lifetime moves the files of the room to the trash once they reach the configured age, which is why the interface confirms the change; this setting decides whether that confirmation is shown to the calling account. It belongs to that account alone: every authenticated role down to a guest may change its own copy, and an unauthenticated caller is refused. It works in both directions - `set=true` hides the warning, `set=false` brings it back - and is a hint for the interface only, so changing a room lifetime through `PUT api/2.0/files/rooms/{id}` is unaffected. The value is published as `hideConfirmRoomLifetime` by `GET api/2.0/files/settings`, which is the only way to read it back. A new account starts with the warning shown, and writing a value that is already stored is accepted and leaves the setting untouched. Hiding the warning does not shorten or extend any lifetime: what a room does with ageing files is decided by the room itself.
|
|
1254
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/hide-confirm-room-lifetime/
|
|
1255
|
+
# @param [Hash] opts the optional parameters
|
|
1256
|
+
# @option opts [SettingsRequestDto] :settings_request_dto
|
|
1257
|
+
# @return [Array<(BooleanWrapper, Integer, Hash)>] BooleanWrapper data, response status code and response headers
|
|
1258
|
+
def hide_confirm_room_lifetime_with_http_info(opts = {})
|
|
1259
|
+
if @api_client.config.debugging
|
|
1260
|
+
@api_client.config.logger.debug 'Calling API: Files::SettingsApi.hide_confirm_room_lifetime ...'
|
|
1261
|
+
end
|
|
1262
|
+
# resource path
|
|
1263
|
+
local_var_path = '/api/2.0/files/hideconfirmroomlifetime'
|
|
1264
|
+
|
|
1265
|
+
# query parameters
|
|
1266
|
+
query_params = opts[:query_params] || {}
|
|
1267
|
+
|
|
1268
|
+
# header parameters
|
|
1269
|
+
header_params = opts[:header_params] || {}
|
|
1270
|
+
# HTTP header 'Accept' (if needed)
|
|
1271
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
1272
|
+
# HTTP header 'Content-Type'
|
|
1273
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
1274
|
+
if !content_type.nil?
|
|
1275
|
+
header_params['Content-Type'] = content_type
|
|
1276
|
+
end
|
|
1277
|
+
|
|
1278
|
+
# form parameters
|
|
1279
|
+
form_params = opts[:form_params] || {}
|
|
1280
|
+
|
|
1281
|
+
# http body (model)
|
|
1282
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'settings_request_dto'])
|
|
1283
|
+
|
|
1284
|
+
# return_type
|
|
1285
|
+
return_type = opts[:debug_return_type] || 'BooleanWrapper'
|
|
1286
|
+
|
|
1287
|
+
# auth_names
|
|
1288
|
+
auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
|
|
1289
|
+
|
|
1290
|
+
new_options = opts.merge(
|
|
1291
|
+
:operation => :"Files::SettingsApi.hide_confirm_room_lifetime",
|
|
1292
|
+
:header_params => header_params,
|
|
1293
|
+
:query_params => query_params,
|
|
1294
|
+
:form_params => form_params,
|
|
1295
|
+
:body => post_body,
|
|
1296
|
+
:auth_names => auth_names,
|
|
1297
|
+
:return_type => return_type
|
|
1298
|
+
)
|
|
1299
|
+
|
|
1300
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
|
|
1301
|
+
if @api_client.config.debugging
|
|
1302
|
+
@api_client.config.logger.debug "API called: Files::SettingsApi#hide_confirm_room_lifetime\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1303
|
+
end
|
|
1304
|
+
return data, status_code, headers
|
|
1305
|
+
end
|
|
1306
|
+
|
|
1307
|
+
# Keep the default file name
|
|
1308
|
+
# Stores whether the caller wants new documents created with the default name instead of being asked for one, and returns the value that is now stored. It is a preference of the calling account: every authenticated role down to a guest may change its own copy, one member's choice never affects another, and an unauthenticated caller is refused. The portal only keeps the value and reports it - the creation operations, `POST api/2.0/files/{folderId}/file` among them, always use the title they are given, so this setting changes what an interface asks for rather than what the server does. Writing a value that is already stored is accepted and leaves the setting and the audit trail untouched. The value is published as `keepNewFileName` by `GET api/2.0/files/settings`, which is the only way to read it back. A new account starts with the prompt in place. The title a created document actually gets, and how a clash with an existing title is resolved, are decided by the creation request rather than here.
|
|
1309
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/keep-new-file-name/
|
|
1310
|
+
# @param [Hash] opts the optional parameters
|
|
1311
|
+
# @option opts [SettingsRequestDto] :settings_request_dto
|
|
1312
|
+
# @return [BooleanWrapper]
|
|
1313
|
+
def keep_new_file_name(opts = {})
|
|
1314
|
+
data, _status_code, _headers = keep_new_file_name_with_http_info(opts)
|
|
1315
|
+
data
|
|
1316
|
+
end
|
|
1317
|
+
|
|
1318
|
+
# Keep the default file name
|
|
1319
|
+
# Stores whether the caller wants new documents created with the default name instead of being asked for one, and returns the value that is now stored. It is a preference of the calling account: every authenticated role down to a guest may change its own copy, one member's choice never affects another, and an unauthenticated caller is refused. The portal only keeps the value and reports it - the creation operations, `POST api/2.0/files/{folderId}/file` among them, always use the title they are given, so this setting changes what an interface asks for rather than what the server does. Writing a value that is already stored is accepted and leaves the setting and the audit trail untouched. The value is published as `keepNewFileName` by `GET api/2.0/files/settings`, which is the only way to read it back. A new account starts with the prompt in place. The title a created document actually gets, and how a clash with an existing title is resolved, are decided by the creation request rather than here.
|
|
1320
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/keep-new-file-name/
|
|
1321
|
+
# @param [Hash] opts the optional parameters
|
|
1322
|
+
# @option opts [SettingsRequestDto] :settings_request_dto
|
|
1323
|
+
# @return [Array<(BooleanWrapper, Integer, Hash)>] BooleanWrapper data, response status code and response headers
|
|
1324
|
+
def keep_new_file_name_with_http_info(opts = {})
|
|
1325
|
+
if @api_client.config.debugging
|
|
1326
|
+
@api_client.config.logger.debug 'Calling API: Files::SettingsApi.keep_new_file_name ...'
|
|
1327
|
+
end
|
|
1328
|
+
# resource path
|
|
1329
|
+
local_var_path = '/api/2.0/files/keepnewfilename'
|
|
1330
|
+
|
|
1331
|
+
# query parameters
|
|
1332
|
+
query_params = opts[:query_params] || {}
|
|
1333
|
+
|
|
1334
|
+
# header parameters
|
|
1335
|
+
header_params = opts[:header_params] || {}
|
|
1336
|
+
# HTTP header 'Accept' (if needed)
|
|
1337
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
1338
|
+
# HTTP header 'Content-Type'
|
|
1339
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
1340
|
+
if !content_type.nil?
|
|
1341
|
+
header_params['Content-Type'] = content_type
|
|
1342
|
+
end
|
|
1343
|
+
|
|
1344
|
+
# form parameters
|
|
1345
|
+
form_params = opts[:form_params] || {}
|
|
1346
|
+
|
|
1347
|
+
# http body (model)
|
|
1348
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'settings_request_dto'])
|
|
1349
|
+
|
|
1350
|
+
# return_type
|
|
1351
|
+
return_type = opts[:debug_return_type] || 'BooleanWrapper'
|
|
1352
|
+
|
|
1353
|
+
# auth_names
|
|
1354
|
+
auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
|
|
1355
|
+
|
|
1356
|
+
new_options = opts.merge(
|
|
1357
|
+
:operation => :"Files::SettingsApi.keep_new_file_name",
|
|
1358
|
+
:header_params => header_params,
|
|
1359
|
+
:query_params => query_params,
|
|
1360
|
+
:form_params => form_params,
|
|
1361
|
+
:body => post_body,
|
|
1362
|
+
:auth_names => auth_names,
|
|
1363
|
+
:return_type => return_type
|
|
1364
|
+
)
|
|
1365
|
+
|
|
1366
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
|
|
1367
|
+
if @api_client.config.debugging
|
|
1368
|
+
@api_client.config.logger.debug "API called: Files::SettingsApi#keep_new_file_name\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1369
|
+
end
|
|
1370
|
+
return data, status_code, headers
|
|
1371
|
+
end
|
|
1372
|
+
|
|
1373
|
+
# Reset the default template setting
|
|
1374
|
+
# Drops the custom blank document configured for one extension and returns the full set of templates as it now stands. New documents of that extension are created from the portal's built-in blank again, and the file that served as the custom one is deleted from the template storage - the original the template was copied from is untouched. The extension is named in the request body, and the entry for it comes back with `selectedFile` null. Resetting an extension that has no custom blank is accepted and changes nothing, which makes a repeated call safe; an extension the built-in template set does not cover is ignored in the same way. Requires the portal settings permission, so only the portal owner and a DocSpace administrator may call it. To set a blank instead of dropping it, use `PUT api/2.0/files/settings/defaulttemplate`. Documents already created from the custom blank are left as they are - the reset only decides what the next new document of that extension starts from. The set as it stands can also be read with `GET api/2.0/files/settings/defaulttemplate`.
|
|
1375
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/reset-default-template/
|
|
1376
|
+
# @param [Hash] opts the optional parameters
|
|
1377
|
+
# @option opts [DefaultTemplateSettingsResetRequestDto] :default_template_settings_reset_request_dto
|
|
1378
|
+
# @return [DefaultTemplateSettingsWrapper]
|
|
1379
|
+
def reset_default_template(opts = {})
|
|
1380
|
+
data, _status_code, _headers = reset_default_template_with_http_info(opts)
|
|
1381
|
+
data
|
|
1382
|
+
end
|
|
1383
|
+
|
|
1384
|
+
# Reset the default template setting
|
|
1385
|
+
# Drops the custom blank document configured for one extension and returns the full set of templates as it now stands. New documents of that extension are created from the portal's built-in blank again, and the file that served as the custom one is deleted from the template storage - the original the template was copied from is untouched. The extension is named in the request body, and the entry for it comes back with `selectedFile` null. Resetting an extension that has no custom blank is accepted and changes nothing, which makes a repeated call safe; an extension the built-in template set does not cover is ignored in the same way. Requires the portal settings permission, so only the portal owner and a DocSpace administrator may call it. To set a blank instead of dropping it, use `PUT api/2.0/files/settings/defaulttemplate`. Documents already created from the custom blank are left as they are - the reset only decides what the next new document of that extension starts from. The set as it stands can also be read with `GET api/2.0/files/settings/defaulttemplate`.
|
|
1386
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/reset-default-template/
|
|
1387
|
+
# @param [Hash] opts the optional parameters
|
|
1388
|
+
# @option opts [DefaultTemplateSettingsResetRequestDto] :default_template_settings_reset_request_dto
|
|
1389
|
+
# @return [Array<(DefaultTemplateSettingsWrapper, Integer, Hash)>] DefaultTemplateSettingsWrapper data, response status code and response headers
|
|
1390
|
+
def reset_default_template_with_http_info(opts = {})
|
|
1391
|
+
if @api_client.config.debugging
|
|
1392
|
+
@api_client.config.logger.debug 'Calling API: Files::SettingsApi.reset_default_template ...'
|
|
1393
|
+
end
|
|
1394
|
+
# resource path
|
|
1395
|
+
local_var_path = '/api/2.0/files/settings/defaulttemplate'
|
|
1396
|
+
|
|
1397
|
+
# query parameters
|
|
1398
|
+
query_params = opts[:query_params] || {}
|
|
1399
|
+
|
|
1400
|
+
# header parameters
|
|
1401
|
+
header_params = opts[:header_params] || {}
|
|
1402
|
+
# HTTP header 'Accept' (if needed)
|
|
1403
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
1404
|
+
# HTTP header 'Content-Type'
|
|
1405
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
1406
|
+
if !content_type.nil?
|
|
1407
|
+
header_params['Content-Type'] = content_type
|
|
1408
|
+
end
|
|
1409
|
+
|
|
1410
|
+
# form parameters
|
|
1411
|
+
form_params = opts[:form_params] || {}
|
|
1412
|
+
|
|
1413
|
+
# http body (model)
|
|
1414
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'default_template_settings_reset_request_dto'])
|
|
1415
|
+
|
|
1416
|
+
# return_type
|
|
1417
|
+
return_type = opts[:debug_return_type] || 'DefaultTemplateSettingsWrapper'
|
|
1418
|
+
|
|
1419
|
+
# auth_names
|
|
1420
|
+
auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
|
|
1421
|
+
|
|
1422
|
+
new_options = opts.merge(
|
|
1423
|
+
:operation => :"Files::SettingsApi.reset_default_template",
|
|
1424
|
+
:header_params => header_params,
|
|
1425
|
+
:query_params => query_params,
|
|
1426
|
+
:form_params => form_params,
|
|
1427
|
+
:body => post_body,
|
|
1428
|
+
:auth_names => auth_names,
|
|
1429
|
+
:return_type => return_type
|
|
1430
|
+
)
|
|
1431
|
+
|
|
1432
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
|
|
1433
|
+
if @api_client.config.debugging
|
|
1434
|
+
@api_client.config.logger.debug "API called: Files::SettingsApi#reset_default_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1435
|
+
end
|
|
1436
|
+
return data, status_code, headers
|
|
1437
|
+
end
|
|
1438
|
+
|
|
1439
|
+
# Change the default template setting
|
|
1440
|
+
# Makes an existing document the blank the portal creates for one extension, and returns the full set of templates as it now stands. The file is copied into the portal's template storage, so later edits of the original do not change the blank, and the file that served as the previous custom blank for that extension is deleted. `selectedFile` takes the identifier of a file the caller may copy - a number for a document stored in the portal, a string for one in a connected third-party storage - and its extension must be the one named in `fileExtension`; a mismatch or an identifier of another kind answers 400, a file the caller may not copy answers 403, and a file that is not there is answered as missing. An extension the built-in template set does not cover is not an error: the call succeeds and changes nothing, so compare the answer with what was asked for. Requires the portal settings permission.
|
|
1441
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/set-default-template/
|
|
1442
|
+
# @param [Hash] opts the optional parameters
|
|
1443
|
+
# @option opts [DefaultTemplateSettingsRequestDto] :default_template_settings_request_dto
|
|
1444
|
+
# @return [DefaultTemplateSettingsWrapper]
|
|
1445
|
+
def set_default_template(opts = {})
|
|
1446
|
+
data, _status_code, _headers = set_default_template_with_http_info(opts)
|
|
1447
|
+
data
|
|
1448
|
+
end
|
|
1449
|
+
|
|
1450
|
+
# Change the default template setting
|
|
1451
|
+
# Makes an existing document the blank the portal creates for one extension, and returns the full set of templates as it now stands. The file is copied into the portal's template storage, so later edits of the original do not change the blank, and the file that served as the previous custom blank for that extension is deleted. `selectedFile` takes the identifier of a file the caller may copy - a number for a document stored in the portal, a string for one in a connected third-party storage - and its extension must be the one named in `fileExtension`; a mismatch or an identifier of another kind answers 400, a file the caller may not copy answers 403, and a file that is not there is answered as missing. An extension the built-in template set does not cover is not an error: the call succeeds and changes nothing, so compare the answer with what was asked for. Requires the portal settings permission.
|
|
1452
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/set-default-template/
|
|
1453
|
+
# @param [Hash] opts the optional parameters
|
|
1454
|
+
# @option opts [DefaultTemplateSettingsRequestDto] :default_template_settings_request_dto
|
|
1455
|
+
# @return [Array<(DefaultTemplateSettingsWrapper, Integer, Hash)>] DefaultTemplateSettingsWrapper data, response status code and response headers
|
|
1456
|
+
def set_default_template_with_http_info(opts = {})
|
|
1457
|
+
if @api_client.config.debugging
|
|
1458
|
+
@api_client.config.logger.debug 'Calling API: Files::SettingsApi.set_default_template ...'
|
|
1459
|
+
end
|
|
1460
|
+
# resource path
|
|
1461
|
+
local_var_path = '/api/2.0/files/settings/defaulttemplate'
|
|
1462
|
+
|
|
1463
|
+
# query parameters
|
|
1464
|
+
query_params = opts[:query_params] || {}
|
|
1465
|
+
|
|
1466
|
+
# header parameters
|
|
1467
|
+
header_params = opts[:header_params] || {}
|
|
1468
|
+
# HTTP header 'Accept' (if needed)
|
|
1469
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
1470
|
+
# HTTP header 'Content-Type'
|
|
1471
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
1472
|
+
if !content_type.nil?
|
|
1473
|
+
header_params['Content-Type'] = content_type
|
|
1474
|
+
end
|
|
1475
|
+
|
|
1476
|
+
# form parameters
|
|
1477
|
+
form_params = opts[:form_params] || {}
|
|
1478
|
+
|
|
1479
|
+
# http body (model)
|
|
1480
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'default_template_settings_request_dto'])
|
|
1481
|
+
|
|
1482
|
+
# return_type
|
|
1483
|
+
return_type = opts[:debug_return_type] || 'DefaultTemplateSettingsWrapper'
|
|
1484
|
+
|
|
1485
|
+
# auth_names
|
|
1486
|
+
auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
|
|
1487
|
+
|
|
1488
|
+
new_options = opts.merge(
|
|
1489
|
+
:operation => :"Files::SettingsApi.set_default_template",
|
|
1490
|
+
:header_params => header_params,
|
|
1491
|
+
:query_params => query_params,
|
|
1492
|
+
:form_params => form_params,
|
|
1493
|
+
:body => post_body,
|
|
1494
|
+
:auth_names => auth_names,
|
|
1495
|
+
:return_type => return_type
|
|
1496
|
+
)
|
|
1497
|
+
|
|
1498
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
|
|
1499
|
+
if @api_client.config.debugging
|
|
1500
|
+
@api_client.config.logger.debug "API called: Files::SettingsApi#set_default_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1501
|
+
end
|
|
1502
|
+
return data, status_code, headers
|
|
1503
|
+
end
|
|
1504
|
+
|
|
1505
|
+
# Open document in the same browser tab
|
|
1506
|
+
# Stores whether the caller wants documents opened in the current browser tab instead of a new one, and returns the value that is now stored. It is a preference of the calling account: every authenticated role down to a guest may change its own copy, and an unauthenticated caller is refused. The portal only keeps the value - the editor addresses returned by the file operations are the same either way, so this setting changes how a client opens them rather than what it receives. Writing a value that is already stored is accepted and leaves the setting untouched. The value is published as `openEditorInSameTab` by `GET api/2.0/files/settings`, which is the only way to read it back. A new account starts with documents opening in a new tab. Nothing about the document changes with it: the editing session, the access rights that apply and the addresses handed out are the same whichever tab a client uses.
|
|
1507
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/set-open-editor-in-same-tab/
|
|
1508
|
+
# @param [Hash] opts the optional parameters
|
|
1509
|
+
# @option opts [SettingsRequestDto] :settings_request_dto
|
|
1510
|
+
# @return [BooleanWrapper]
|
|
1511
|
+
def set_open_editor_in_same_tab(opts = {})
|
|
1512
|
+
data, _status_code, _headers = set_open_editor_in_same_tab_with_http_info(opts)
|
|
1513
|
+
data
|
|
1514
|
+
end
|
|
1515
|
+
|
|
1516
|
+
# Open document in the same browser tab
|
|
1517
|
+
# Stores whether the caller wants documents opened in the current browser tab instead of a new one, and returns the value that is now stored. It is a preference of the calling account: every authenticated role down to a guest may change its own copy, and an unauthenticated caller is refused. The portal only keeps the value - the editor addresses returned by the file operations are the same either way, so this setting changes how a client opens them rather than what it receives. Writing a value that is already stored is accepted and leaves the setting untouched. The value is published as `openEditorInSameTab` by `GET api/2.0/files/settings`, which is the only way to read it back. A new account starts with documents opening in a new tab. Nothing about the document changes with it: the editing session, the access rights that apply and the addresses handed out are the same whichever tab a client uses.
|
|
1518
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/set-open-editor-in-same-tab/
|
|
1519
|
+
# @param [Hash] opts the optional parameters
|
|
1520
|
+
# @option opts [SettingsRequestDto] :settings_request_dto
|
|
1521
|
+
# @return [Array<(BooleanWrapper, Integer, Hash)>] BooleanWrapper data, response status code and response headers
|
|
1522
|
+
def set_open_editor_in_same_tab_with_http_info(opts = {})
|
|
1523
|
+
if @api_client.config.debugging
|
|
1524
|
+
@api_client.config.logger.debug 'Calling API: Files::SettingsApi.set_open_editor_in_same_tab ...'
|
|
1525
|
+
end
|
|
1526
|
+
# resource path
|
|
1527
|
+
local_var_path = '/api/2.0/files/settings/openeditorinsametab'
|
|
1528
|
+
|
|
1529
|
+
# query parameters
|
|
1530
|
+
query_params = opts[:query_params] || {}
|
|
1531
|
+
|
|
1532
|
+
# header parameters
|
|
1533
|
+
header_params = opts[:header_params] || {}
|
|
1534
|
+
# HTTP header 'Accept' (if needed)
|
|
1535
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
1536
|
+
# HTTP header 'Content-Type'
|
|
1537
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
1538
|
+
if !content_type.nil?
|
|
1539
|
+
header_params['Content-Type'] = content_type
|
|
1540
|
+
end
|
|
1541
|
+
|
|
1542
|
+
# form parameters
|
|
1543
|
+
form_params = opts[:form_params] || {}
|
|
1544
|
+
|
|
1545
|
+
# http body (model)
|
|
1546
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'settings_request_dto'])
|
|
1547
|
+
|
|
1548
|
+
# return_type
|
|
1549
|
+
return_type = opts[:debug_return_type] || 'BooleanWrapper'
|
|
1550
|
+
|
|
1551
|
+
# auth_names
|
|
1552
|
+
auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
|
|
1553
|
+
|
|
1554
|
+
new_options = opts.merge(
|
|
1555
|
+
:operation => :"Files::SettingsApi.set_open_editor_in_same_tab",
|
|
1556
|
+
:header_params => header_params,
|
|
1557
|
+
:query_params => query_params,
|
|
1558
|
+
:form_params => form_params,
|
|
1559
|
+
:body => post_body,
|
|
1560
|
+
:auth_names => auth_names,
|
|
1561
|
+
:return_type => return_type
|
|
1562
|
+
)
|
|
1563
|
+
|
|
1564
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
|
|
1565
|
+
if @api_client.config.debugging
|
|
1566
|
+
@api_client.config.logger.debug "API called: Files::SettingsApi#set_open_editor_in_same_tab\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1567
|
+
end
|
|
1568
|
+
return data, status_code, headers
|
|
1569
|
+
end
|
|
1570
|
+
|
|
1571
|
+
# Organize rooms grouping
|
|
1572
|
+
# Stores whether the caller sees rooms arranged by the groups they belong to instead of one flat list, and returns the value that is now stored. It is a preference of the calling account: every authenticated role down to a guest may change its own copy, and an unauthenticated caller is refused. The groups themselves are the room groups managed under `api/2.0/files/group`, and they exist whether or not this setting is on - the portal only records the preference, while `GET api/2.0/files/rooms` keeps returning the same rooms either way, so the arrangement is done by the client. Writing a value that is already stored is accepted and leaves the setting untouched. The value is published as `organizeRoomsGrouping` by `GET api/2.0/files/settings`, which is the only way to read it back. A new account starts with the grouping on. Turning it off changes no group: the groups, the rooms in them and who may see them stay exactly as they were, and are still read through the room group operations.
|
|
1573
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/set-organize-rooms-grouping/
|
|
1574
|
+
# @param [Hash] opts the optional parameters
|
|
1575
|
+
# @option opts [SettingsRequestDto] :settings_request_dto
|
|
1576
|
+
# @return [BooleanWrapper]
|
|
1577
|
+
def set_organize_rooms_grouping(opts = {})
|
|
1578
|
+
data, _status_code, _headers = set_organize_rooms_grouping_with_http_info(opts)
|
|
1579
|
+
data
|
|
1580
|
+
end
|
|
1581
|
+
|
|
1582
|
+
# Organize rooms grouping
|
|
1583
|
+
# Stores whether the caller sees rooms arranged by the groups they belong to instead of one flat list, and returns the value that is now stored. It is a preference of the calling account: every authenticated role down to a guest may change its own copy, and an unauthenticated caller is refused. The groups themselves are the room groups managed under `api/2.0/files/group`, and they exist whether or not this setting is on - the portal only records the preference, while `GET api/2.0/files/rooms` keeps returning the same rooms either way, so the arrangement is done by the client. Writing a value that is already stored is accepted and leaves the setting untouched. The value is published as `organizeRoomsGrouping` by `GET api/2.0/files/settings`, which is the only way to read it back. A new account starts with the grouping on. Turning it off changes no group: the groups, the rooms in them and who may see them stay exactly as they were, and are still read through the room group operations.
|
|
1584
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/set-organize-rooms-grouping/
|
|
1585
|
+
# @param [Hash] opts the optional parameters
|
|
1586
|
+
# @option opts [SettingsRequestDto] :settings_request_dto
|
|
1587
|
+
# @return [Array<(BooleanWrapper, Integer, Hash)>] BooleanWrapper data, response status code and response headers
|
|
1588
|
+
def set_organize_rooms_grouping_with_http_info(opts = {})
|
|
1589
|
+
if @api_client.config.debugging
|
|
1590
|
+
@api_client.config.logger.debug 'Calling API: Files::SettingsApi.set_organize_rooms_grouping ...'
|
|
1591
|
+
end
|
|
1592
|
+
# resource path
|
|
1593
|
+
local_var_path = '/api/2.0/files/settings/organizegrouping'
|
|
1594
|
+
|
|
1595
|
+
# query parameters
|
|
1596
|
+
query_params = opts[:query_params] || {}
|
|
1597
|
+
|
|
1598
|
+
# header parameters
|
|
1599
|
+
header_params = opts[:header_params] || {}
|
|
1600
|
+
# HTTP header 'Accept' (if needed)
|
|
1601
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
1602
|
+
# HTTP header 'Content-Type'
|
|
1603
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
1604
|
+
if !content_type.nil?
|
|
1605
|
+
header_params['Content-Type'] = content_type
|
|
1606
|
+
end
|
|
1607
|
+
|
|
1608
|
+
# form parameters
|
|
1609
|
+
form_params = opts[:form_params] || {}
|
|
1610
|
+
|
|
1611
|
+
# http body (model)
|
|
1612
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'settings_request_dto'])
|
|
1613
|
+
|
|
1614
|
+
# return_type
|
|
1615
|
+
return_type = opts[:debug_return_type] || 'BooleanWrapper'
|
|
1616
|
+
|
|
1617
|
+
# auth_names
|
|
1618
|
+
auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
|
|
1619
|
+
|
|
1620
|
+
new_options = opts.merge(
|
|
1621
|
+
:operation => :"Files::SettingsApi.set_organize_rooms_grouping",
|
|
1622
|
+
:header_params => header_params,
|
|
1623
|
+
:query_params => query_params,
|
|
1624
|
+
:form_params => form_params,
|
|
1625
|
+
:body => post_body,
|
|
1626
|
+
:auth_names => auth_names,
|
|
1627
|
+
:return_type => return_type
|
|
1628
|
+
)
|
|
1629
|
+
|
|
1630
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
|
|
1631
|
+
if @api_client.config.debugging
|
|
1632
|
+
@api_client.config.logger.debug "API called: Files::SettingsApi#set_organize_rooms_grouping\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1633
|
+
end
|
|
1634
|
+
return data, status_code, headers
|
|
1635
|
+
end
|
|
1636
|
+
|
|
1637
|
+
# Display quick actions
|
|
1638
|
+
# Turns the quick action buttons shown next to a file name on or off, and answers with the value that was sent. This is a preference of the calling account rather than a portal setting, so it changes what the caller sees and nothing for anybody else; any authenticated role down to a guest may set it, while an unauthenticated caller is refused. The value is written only when it differs from the one already stored, and only then is the change recorded in the audit trail, so repeating the same call is harmless and leaves no trace. An account that has never set it is treated as having the buttons on. The answer echoes the request instead of re-reading what was stored, so read the setting back through `GET api/2.0/files/settings`, which publishes it as `showQuickActions`.
|
|
1639
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/show-quick-actions/
|
|
1640
|
+
# @param [Hash] opts the optional parameters
|
|
1641
|
+
# @option opts [SettingsRequestDto] :settings_request_dto
|
|
1642
|
+
# @return [BooleanWrapper]
|
|
1643
|
+
def show_quick_actions(opts = {})
|
|
1644
|
+
data, _status_code, _headers = show_quick_actions_with_http_info(opts)
|
|
1645
|
+
data
|
|
1646
|
+
end
|
|
1647
|
+
|
|
1648
|
+
# Display quick actions
|
|
1649
|
+
# Turns the quick action buttons shown next to a file name on or off, and answers with the value that was sent. This is a preference of the calling account rather than a portal setting, so it changes what the caller sees and nothing for anybody else; any authenticated role down to a guest may set it, while an unauthenticated caller is refused. The value is written only when it differs from the one already stored, and only then is the change recorded in the audit trail, so repeating the same call is harmless and leaves no trace. An account that has never set it is treated as having the buttons on. The answer echoes the request instead of re-reading what was stored, so read the setting back through `GET api/2.0/files/settings`, which publishes it as `showQuickActions`.
|
|
1650
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/show-quick-actions/
|
|
1651
|
+
# @param [Hash] opts the optional parameters
|
|
1652
|
+
# @option opts [SettingsRequestDto] :settings_request_dto
|
|
1653
|
+
# @return [Array<(BooleanWrapper, Integer, Hash)>] BooleanWrapper data, response status code and response headers
|
|
1654
|
+
def show_quick_actions_with_http_info(opts = {})
|
|
1655
|
+
if @api_client.config.debugging
|
|
1656
|
+
@api_client.config.logger.debug 'Calling API: Files::SettingsApi.show_quick_actions ...'
|
|
1657
|
+
end
|
|
1658
|
+
# resource path
|
|
1659
|
+
local_var_path = '/api/2.0/files/showquickactions'
|
|
1660
|
+
|
|
1661
|
+
# query parameters
|
|
1662
|
+
query_params = opts[:query_params] || {}
|
|
1663
|
+
|
|
1664
|
+
# header parameters
|
|
1665
|
+
header_params = opts[:header_params] || {}
|
|
1666
|
+
# HTTP header 'Accept' (if needed)
|
|
1667
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
1668
|
+
# HTTP header 'Content-Type'
|
|
1669
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
1670
|
+
if !content_type.nil?
|
|
1671
|
+
header_params['Content-Type'] = content_type
|
|
1672
|
+
end
|
|
1673
|
+
|
|
1674
|
+
# form parameters
|
|
1675
|
+
form_params = opts[:form_params] || {}
|
|
1676
|
+
|
|
1677
|
+
# http body (model)
|
|
1678
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'settings_request_dto'])
|
|
1679
|
+
|
|
1680
|
+
# return_type
|
|
1681
|
+
return_type = opts[:debug_return_type] || 'BooleanWrapper'
|
|
1682
|
+
|
|
1683
|
+
# auth_names
|
|
1684
|
+
auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
|
|
1685
|
+
|
|
1686
|
+
new_options = opts.merge(
|
|
1687
|
+
:operation => :"Files::SettingsApi.show_quick_actions",
|
|
1688
|
+
:header_params => header_params,
|
|
1689
|
+
:query_params => query_params,
|
|
1690
|
+
:form_params => form_params,
|
|
1691
|
+
:body => post_body,
|
|
1692
|
+
:auth_names => auth_names,
|
|
1693
|
+
:return_type => return_type
|
|
1694
|
+
)
|
|
1695
|
+
|
|
1696
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
|
|
1697
|
+
if @api_client.config.debugging
|
|
1698
|
+
@api_client.config.logger.debug "API called: Files::SettingsApi#show_quick_actions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1699
|
+
end
|
|
1700
|
+
return data, status_code, headers
|
|
1701
|
+
end
|
|
1702
|
+
|
|
1703
|
+
# Change the ability to store the forcesaved files
|
|
1704
|
+
# Reports that forcesaved versions are not kept as separate file versions in this portal. The operation is a stub kept for compatibility: it takes no request body, stores nothing and always answers false, so it neither turns the behaviour on nor off and repeating it changes nothing. What it describes is what happens to the intermediate saves the editor makes while a document is still open - they update the current version instead of piling up as new ones in `GET api/2.0/files/file/{fileId}/history`. Any authenticated role down to a guest may call it; an unauthenticated caller is refused. The same constant is published as `storeForcesave` by `GET api/2.0/files/settings`, which is the cheaper way to read it. Its companion stub `PUT api/2.0/files/forcesave` answers for forcesaving itself in the same way. Version history is not affected by this call either: the versions a document really has are the ones the file history operation lists, and a new one appears when the editing session is closed.
|
|
1705
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/store-forcesave/
|
|
1706
|
+
# @param [Hash] opts the optional parameters
|
|
1707
|
+
# @return [BooleanWrapper]
|
|
1708
|
+
def store_forcesave(opts = {})
|
|
1709
|
+
data, _status_code, _headers = store_forcesave_with_http_info(opts)
|
|
1710
|
+
data
|
|
1711
|
+
end
|
|
1712
|
+
|
|
1713
|
+
# Change the ability to store the forcesaved files
|
|
1714
|
+
# Reports that forcesaved versions are not kept as separate file versions in this portal. The operation is a stub kept for compatibility: it takes no request body, stores nothing and always answers false, so it neither turns the behaviour on nor off and repeating it changes nothing. What it describes is what happens to the intermediate saves the editor makes while a document is still open - they update the current version instead of piling up as new ones in `GET api/2.0/files/file/{fileId}/history`. Any authenticated role down to a guest may call it; an unauthenticated caller is refused. The same constant is published as `storeForcesave` by `GET api/2.0/files/settings`, which is the cheaper way to read it. Its companion stub `PUT api/2.0/files/forcesave` answers for forcesaving itself in the same way. Version history is not affected by this call either: the versions a document really has are the ones the file history operation lists, and a new one appears when the editing session is closed.
|
|
1715
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/store-forcesave/
|
|
1716
|
+
# @param [Hash] opts the optional parameters
|
|
1717
|
+
# @return [Array<(BooleanWrapper, Integer, Hash)>] BooleanWrapper data, response status code and response headers
|
|
1718
|
+
def store_forcesave_with_http_info(opts = {})
|
|
1719
|
+
if @api_client.config.debugging
|
|
1720
|
+
@api_client.config.logger.debug 'Calling API: Files::SettingsApi.store_forcesave ...'
|
|
1721
|
+
end
|
|
1722
|
+
# resource path
|
|
1723
|
+
local_var_path = '/api/2.0/files/storeforcesave'
|
|
1724
|
+
|
|
1725
|
+
# query parameters
|
|
1726
|
+
query_params = opts[:query_params] || {}
|
|
1727
|
+
|
|
1728
|
+
# header parameters
|
|
1729
|
+
header_params = opts[:header_params] || {}
|
|
1730
|
+
# HTTP header 'Accept' (if needed)
|
|
1731
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
1732
|
+
|
|
1733
|
+
# form parameters
|
|
1734
|
+
form_params = opts[:form_params] || {}
|
|
1735
|
+
|
|
1736
|
+
# http body (model)
|
|
1737
|
+
post_body = opts[:debug_body]
|
|
1738
|
+
|
|
1739
|
+
# return_type
|
|
1740
|
+
return_type = opts[:debug_return_type] || 'BooleanWrapper'
|
|
1741
|
+
|
|
1742
|
+
# auth_names
|
|
1743
|
+
auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
|
|
1744
|
+
|
|
1745
|
+
new_options = opts.merge(
|
|
1746
|
+
:operation => :"Files::SettingsApi.store_forcesave",
|
|
1747
|
+
:header_params => header_params,
|
|
1748
|
+
:query_params => query_params,
|
|
1749
|
+
:form_params => form_params,
|
|
1750
|
+
:body => post_body,
|
|
1751
|
+
:auth_names => auth_names,
|
|
1752
|
+
:return_type => return_type
|
|
1753
|
+
)
|
|
1754
|
+
|
|
1755
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
|
|
1756
|
+
if @api_client.config.debugging
|
|
1757
|
+
@api_client.config.logger.debug "API called: Files::SettingsApi#store_forcesave\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1758
|
+
end
|
|
1759
|
+
return data, status_code, headers
|
|
1760
|
+
end
|
|
1761
|
+
|
|
1762
|
+
# Change the ability to upload original formats
|
|
1763
|
+
# Stores whether the caller's uploads keep the original file when the portal converts them into an editable format, and returns the value that is now stored. With `set=true` the converted document is saved as a new file next to the upload, so both the original and the converted copy stay in the folder; with `set=false` the conversion replaces the uploaded file with a new version of it whenever the caller may edit that file. The setting belongs to the calling account alone: every authenticated role down to a guest may change its own copy, and an unauthenticated caller is refused. It applies to conversion on upload and to `PUT api/2.0/files/file/{fileId}/checkconversion`, not to files already stored. The value is published as `storeOriginalFiles` by `GET api/2.0/files/settings`, which is the only way to read it back. The change is recorded in the portal audit trail.
|
|
1764
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/store-original/
|
|
1765
|
+
# @param [Hash] opts the optional parameters
|
|
1766
|
+
# @option opts [SettingsRequestDto] :settings_request_dto
|
|
1767
|
+
# @return [BooleanWrapper]
|
|
1768
|
+
def store_original(opts = {})
|
|
1769
|
+
data, _status_code, _headers = store_original_with_http_info(opts)
|
|
1770
|
+
data
|
|
1771
|
+
end
|
|
1772
|
+
|
|
1773
|
+
# Change the ability to upload original formats
|
|
1774
|
+
# Stores whether the caller's uploads keep the original file when the portal converts them into an editable format, and returns the value that is now stored. With `set=true` the converted document is saved as a new file next to the upload, so both the original and the converted copy stay in the folder; with `set=false` the conversion replaces the uploaded file with a new version of it whenever the caller may edit that file. The setting belongs to the calling account alone: every authenticated role down to a guest may change its own copy, and an unauthenticated caller is refused. It applies to conversion on upload and to `PUT api/2.0/files/file/{fileId}/checkconversion`, not to files already stored. The value is published as `storeOriginalFiles` by `GET api/2.0/files/settings`, which is the only way to read it back. The change is recorded in the portal audit trail.
|
|
1775
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/store-original/
|
|
1776
|
+
# @param [Hash] opts the optional parameters
|
|
1777
|
+
# @option opts [SettingsRequestDto] :settings_request_dto
|
|
1778
|
+
# @return [Array<(BooleanWrapper, Integer, Hash)>] BooleanWrapper data, response status code and response headers
|
|
1779
|
+
def store_original_with_http_info(opts = {})
|
|
1780
|
+
if @api_client.config.debugging
|
|
1781
|
+
@api_client.config.logger.debug 'Calling API: Files::SettingsApi.store_original ...'
|
|
1782
|
+
end
|
|
1783
|
+
# resource path
|
|
1784
|
+
local_var_path = '/api/2.0/files/storeoriginal'
|
|
1785
|
+
|
|
1786
|
+
# query parameters
|
|
1787
|
+
query_params = opts[:query_params] || {}
|
|
1788
|
+
|
|
1789
|
+
# header parameters
|
|
1790
|
+
header_params = opts[:header_params] || {}
|
|
1791
|
+
# HTTP header 'Accept' (if needed)
|
|
1792
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
1793
|
+
# HTTP header 'Content-Type'
|
|
1794
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
1795
|
+
if !content_type.nil?
|
|
1796
|
+
header_params['Content-Type'] = content_type
|
|
1797
|
+
end
|
|
1798
|
+
|
|
1799
|
+
# form parameters
|
|
1800
|
+
form_params = opts[:form_params] || {}
|
|
1801
|
+
|
|
1802
|
+
# http body (model)
|
|
1803
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'settings_request_dto'])
|
|
1804
|
+
|
|
1805
|
+
# return_type
|
|
1806
|
+
return_type = opts[:debug_return_type] || 'BooleanWrapper'
|
|
1807
|
+
|
|
1808
|
+
# auth_names
|
|
1809
|
+
auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
|
|
1810
|
+
|
|
1811
|
+
new_options = opts.merge(
|
|
1812
|
+
:operation => :"Files::SettingsApi.store_original",
|
|
1813
|
+
:header_params => header_params,
|
|
1814
|
+
:query_params => query_params,
|
|
1815
|
+
:form_params => form_params,
|
|
1816
|
+
:body => post_body,
|
|
1817
|
+
:auth_names => auth_names,
|
|
1818
|
+
:return_type => return_type
|
|
1819
|
+
)
|
|
1820
|
+
|
|
1821
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
|
|
1822
|
+
if @api_client.config.debugging
|
|
1823
|
+
@api_client.config.logger.debug "API called: Files::SettingsApi#store_original\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1824
|
+
end
|
|
1825
|
+
return data, status_code, headers
|
|
1826
|
+
end
|
|
1827
|
+
|
|
1828
|
+
# Update a file version if it exists
|
|
1829
|
+
# Reports that uploading a file under a name that already exists does not update the existing file. The operation is a stub kept for compatibility: the request body is read but ignored, nothing is stored, and the answer is always false, so calling it changes no behaviour and repeating it changes nothing. What actually decides the outcome of a name clash is the parameter of the upload itself - see the `createNewIfExist` and conflict-resolution parameters of the operations under `api/2.0/files/{folderId}/upload` and of `PUT api/2.0/files/fileops/copy`. Any authenticated role down to a guest may call it; an unauthenticated caller is refused. Because the value is a constant, there is nothing to read back afterwards, and `GET api/2.0/files/settings` does not publish it. To add a version to a document that is already stored, address the file directly through the update operations under `api/2.0/files/file/{fileId}` instead of uploading under the same name and relying on this setting.
|
|
1830
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/update-file-if-exist/
|
|
1831
|
+
# @param [Hash] opts the optional parameters
|
|
1832
|
+
# @option opts [SettingsRequestDto] :settings_request_dto
|
|
1833
|
+
# @return [BooleanWrapper]
|
|
1834
|
+
def update_file_if_exist(opts = {})
|
|
1835
|
+
data, _status_code, _headers = update_file_if_exist_with_http_info(opts)
|
|
1836
|
+
data
|
|
1837
|
+
end
|
|
1838
|
+
|
|
1839
|
+
# Update a file version if it exists
|
|
1840
|
+
# Reports that uploading a file under a name that already exists does not update the existing file. The operation is a stub kept for compatibility: the request body is read but ignored, nothing is stored, and the answer is always false, so calling it changes no behaviour and repeating it changes nothing. What actually decides the outcome of a name clash is the parameter of the upload itself - see the `createNewIfExist` and conflict-resolution parameters of the operations under `api/2.0/files/{folderId}/upload` and of `PUT api/2.0/files/fileops/copy`. Any authenticated role down to a guest may call it; an unauthenticated caller is refused. Because the value is a constant, there is nothing to read back afterwards, and `GET api/2.0/files/settings` does not publish it. To add a version to a document that is already stored, address the file directly through the update operations under `api/2.0/files/file/{fileId}` instead of uploading under the same name and relying on this setting.
|
|
1841
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/update-file-if-exist/
|
|
1842
|
+
# @param [Hash] opts the optional parameters
|
|
1843
|
+
# @option opts [SettingsRequestDto] :settings_request_dto
|
|
1844
|
+
# @return [Array<(BooleanWrapper, Integer, Hash)>] BooleanWrapper data, response status code and response headers
|
|
1845
|
+
def update_file_if_exist_with_http_info(opts = {})
|
|
1846
|
+
if @api_client.config.debugging
|
|
1847
|
+
@api_client.config.logger.debug 'Calling API: Files::SettingsApi.update_file_if_exist ...'
|
|
1848
|
+
end
|
|
1849
|
+
# resource path
|
|
1850
|
+
local_var_path = '/api/2.0/files/updateifexist'
|
|
1851
|
+
|
|
1852
|
+
# query parameters
|
|
1853
|
+
query_params = opts[:query_params] || {}
|
|
1854
|
+
|
|
1855
|
+
# header parameters
|
|
1856
|
+
header_params = opts[:header_params] || {}
|
|
1857
|
+
# HTTP header 'Accept' (if needed)
|
|
1858
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
1859
|
+
# HTTP header 'Content-Type'
|
|
1860
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
1861
|
+
if !content_type.nil?
|
|
1862
|
+
header_params['Content-Type'] = content_type
|
|
1863
|
+
end
|
|
1864
|
+
|
|
1865
|
+
# form parameters
|
|
1866
|
+
form_params = opts[:form_params] || {}
|
|
1867
|
+
|
|
1868
|
+
# http body (model)
|
|
1869
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'settings_request_dto'])
|
|
1870
|
+
|
|
1871
|
+
# return_type
|
|
1872
|
+
return_type = opts[:debug_return_type] || 'BooleanWrapper'
|
|
1873
|
+
|
|
1874
|
+
# auth_names
|
|
1875
|
+
auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
|
|
1876
|
+
|
|
1877
|
+
new_options = opts.merge(
|
|
1878
|
+
:operation => :"Files::SettingsApi.update_file_if_exist",
|
|
1879
|
+
:header_params => header_params,
|
|
1880
|
+
:query_params => query_params,
|
|
1881
|
+
:form_params => form_params,
|
|
1882
|
+
:body => post_body,
|
|
1883
|
+
:auth_names => auth_names,
|
|
1884
|
+
:return_type => return_type
|
|
1885
|
+
)
|
|
1886
|
+
|
|
1887
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
|
|
1888
|
+
if @api_client.config.debugging
|
|
1889
|
+
@api_client.config.logger.debug "API called: Files::SettingsApi#update_file_if_exist\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1890
|
+
end
|
|
1891
|
+
return data, status_code, headers
|
|
1892
|
+
end
|
|
1893
|
+
|
|
1894
|
+
# Upload a file as the default template setting
|
|
1895
|
+
# Uploads a document and makes it the blank the portal creates for one extension, and returns the full set of templates as it now stands. The request is multipart form data carrying the file, while the extension travels in the `FileExtension` query parameter; the extension of the uploaded file name must be exactly that one, or the call answers 403. A PDF is additionally checked to be a fillable form, and answers 403 as well when it is not one. The upload is capped at 100 MB and a larger body answers 400 while it is still streaming in. The file is stored in the portal's template storage and the file that served as the previous custom blank for that extension is deleted; an extension the built-in template set does not cover leaves everything unchanged. Requires the portal settings permission. Use `PUT api/2.0/files/settings/defaulttemplate` to reuse a document that is already in the portal.
|
|
1896
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/upload-default-template/
|
|
1897
|
+
# @param file_extension [String] The extension the uploaded blank is set for, written in lower case with the leading dot, and travelling in the query string rather than in the form. It must match the extension of the uploaded file name. Only the extensions the portal's built-in template set covers are accepted, and `GET api/2.0/files/settings/defaulttemplate` returns exactly that list; an extension outside it leaves the settings unchanged instead of failing.
|
|
1898
|
+
# @param file [File] The template document itself. Its file name must end with the extension named above, a PDF must be a fillable form, and the body is capped at 100 MB - a larger one is refused while it is still streaming in.
|
|
1899
|
+
# @param [Hash] opts the optional parameters
|
|
1900
|
+
# @return [DefaultTemplateSettingsWrapper]
|
|
1901
|
+
def upload_default_template(file_extension, file, opts = {})
|
|
1902
|
+
data, _status_code, _headers = upload_default_template_with_http_info(file_extension, file, opts)
|
|
1903
|
+
data
|
|
1904
|
+
end
|
|
1905
|
+
|
|
1906
|
+
# Upload a file as the default template setting
|
|
1907
|
+
# Uploads a document and makes it the blank the portal creates for one extension, and returns the full set of templates as it now stands. The request is multipart form data carrying the file, while the extension travels in the `FileExtension` query parameter; the extension of the uploaded file name must be exactly that one, or the call answers 403. A PDF is additionally checked to be a fillable form, and answers 403 as well when it is not one. The upload is capped at 100 MB and a larger body answers 400 while it is still streaming in. The file is stored in the portal's template storage and the file that served as the previous custom blank for that extension is deleted; an extension the built-in template set does not cover leaves everything unchanged. Requires the portal settings permission. Use `PUT api/2.0/files/settings/defaulttemplate` to reuse a document that is already in the portal.
|
|
1908
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/upload-default-template/
|
|
1909
|
+
# @param file_extension [String] The extension the uploaded blank is set for, written in lower case with the leading dot, and travelling in the query string rather than in the form. It must match the extension of the uploaded file name. Only the extensions the portal's built-in template set covers are accepted, and `GET api/2.0/files/settings/defaulttemplate` returns exactly that list; an extension outside it leaves the settings unchanged instead of failing.
|
|
1910
|
+
# @param file [File] The template document itself. Its file name must end with the extension named above, a PDF must be a fillable form, and the body is capped at 100 MB - a larger one is refused while it is still streaming in.
|
|
1911
|
+
# @param [Hash] opts the optional parameters
|
|
1912
|
+
# @return [Array<(DefaultTemplateSettingsWrapper, Integer, Hash)>] DefaultTemplateSettingsWrapper data, response status code and response headers
|
|
1913
|
+
def upload_default_template_with_http_info(file_extension, file, opts = {})
|
|
1914
|
+
if @api_client.config.debugging
|
|
1915
|
+
@api_client.config.logger.debug 'Calling API: Files::SettingsApi.upload_default_template ...'
|
|
1916
|
+
end
|
|
1917
|
+
# verify the required parameter 'file_extension' is set
|
|
1918
|
+
if @api_client.config.client_side_validation && file_extension.nil?
|
|
1919
|
+
fail ArgumentError, "Missing the required parameter 'file_extension' when calling Files::SettingsApi.upload_default_template"
|
|
1920
|
+
end
|
|
1921
|
+
# verify the required parameter 'file' is set
|
|
1922
|
+
if @api_client.config.client_side_validation && file.nil?
|
|
1923
|
+
fail ArgumentError, "Missing the required parameter 'file' when calling Files::SettingsApi.upload_default_template"
|
|
1924
|
+
end
|
|
1925
|
+
# resource path
|
|
1926
|
+
local_var_path = '/api/2.0/files/settings/defaulttemplate'
|
|
1927
|
+
|
|
1928
|
+
# query parameters
|
|
1929
|
+
query_params = opts[:query_params] || {}
|
|
1930
|
+
query_params[:'fileExtension'] = file_extension
|
|
1931
|
+
|
|
1932
|
+
# header parameters
|
|
1933
|
+
header_params = opts[:header_params] || {}
|
|
1934
|
+
# HTTP header 'Accept' (if needed)
|
|
1935
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
1936
|
+
# HTTP header 'Content-Type'
|
|
1937
|
+
content_type = @api_client.select_header_content_type(['multipart/form-data'])
|
|
1938
|
+
if !content_type.nil?
|
|
1939
|
+
header_params['Content-Type'] = content_type
|
|
1940
|
+
end
|
|
1941
|
+
|
|
1942
|
+
# form parameters
|
|
1943
|
+
form_params = opts[:form_params] || {}
|
|
1944
|
+
form_params['file'] = file
|
|
1945
|
+
|
|
1946
|
+
# http body (model)
|
|
1947
|
+
post_body = opts[:debug_body]
|
|
1948
|
+
|
|
1949
|
+
# return_type
|
|
1950
|
+
return_type = opts[:debug_return_type] || 'DefaultTemplateSettingsWrapper'
|
|
1951
|
+
|
|
1952
|
+
# auth_names
|
|
1953
|
+
auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
|
|
1954
|
+
|
|
1955
|
+
new_options = opts.merge(
|
|
1956
|
+
:operation => :"Files::SettingsApi.upload_default_template",
|
|
1957
|
+
:header_params => header_params,
|
|
1958
|
+
:query_params => query_params,
|
|
1959
|
+
:form_params => form_params,
|
|
1960
|
+
:body => post_body,
|
|
1961
|
+
:auth_names => auth_names,
|
|
1962
|
+
:return_type => return_type
|
|
1963
|
+
)
|
|
1964
|
+
|
|
1965
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
1966
|
+
if @api_client.config.debugging
|
|
1967
|
+
@api_client.config.logger.debug "API called: Files::SettingsApi#upload_default_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1968
|
+
end
|
|
1969
|
+
return data, status_code, headers
|
|
1970
|
+
end
|
|
1971
|
+
end
|
|
1972
|
+
end
|
|
1973
|
+
end
|