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,916 @@
|
|
|
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 Backup
|
|
20
|
+
class BackupApi
|
|
21
|
+
attr_accessor :api_client
|
|
22
|
+
|
|
23
|
+
def initialize(api_client = ApiClient.default)
|
|
24
|
+
@api_client = api_client
|
|
25
|
+
end
|
|
26
|
+
# Cancel the running backup
|
|
27
|
+
# Drops the backup job of the current portal from the queue, which cancels it if it is still running. The caller needs the portal settings permission. It answers false, not an error, when there is nothing to cancel, so the result says whether a job was actually dropped rather than whether the call succeeded. This affects backup jobs only: a restoring job cannot be cancelled through the API. The cancelled job leaves the queue, so a following `GET api/2.0/backup/getbackupprogress` reports no job at all rather than a job with the `Canceled` status.
|
|
28
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/cancel-backup/
|
|
29
|
+
# @param [Hash] opts the optional parameters
|
|
30
|
+
# @return [BooleanWrapper]
|
|
31
|
+
def cancel_backup(opts = {})
|
|
32
|
+
data, _status_code, _headers = cancel_backup_with_http_info(opts)
|
|
33
|
+
data
|
|
34
|
+
end
|
|
35
|
+
|
|
36
|
+
# Cancel the running backup
|
|
37
|
+
# Drops the backup job of the current portal from the queue, which cancels it if it is still running. The caller needs the portal settings permission. It answers false, not an error, when there is nothing to cancel, so the result says whether a job was actually dropped rather than whether the call succeeded. This affects backup jobs only: a restoring job cannot be cancelled through the API. The cancelled job leaves the queue, so a following `GET api/2.0/backup/getbackupprogress` reports no job at all rather than a job with the `Canceled` status.
|
|
38
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/cancel-backup/
|
|
39
|
+
# @param [Hash] opts the optional parameters
|
|
40
|
+
# @return [Array<(BooleanWrapper, Integer, Hash)>] BooleanWrapper data, response status code and response headers
|
|
41
|
+
def cancel_backup_with_http_info(opts = {})
|
|
42
|
+
if @api_client.config.debugging
|
|
43
|
+
@api_client.config.logger.debug 'Calling API: Backup::BackupApi.cancel_backup ...'
|
|
44
|
+
end
|
|
45
|
+
# resource path
|
|
46
|
+
local_var_path = '/api/2.0/backup/cancelbackup'
|
|
47
|
+
|
|
48
|
+
# query parameters
|
|
49
|
+
query_params = opts[:query_params] || {}
|
|
50
|
+
|
|
51
|
+
# header parameters
|
|
52
|
+
header_params = opts[:header_params] || {}
|
|
53
|
+
# HTTP header 'Accept' (if needed)
|
|
54
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
55
|
+
|
|
56
|
+
# form parameters
|
|
57
|
+
form_params = opts[:form_params] || {}
|
|
58
|
+
|
|
59
|
+
# http body (model)
|
|
60
|
+
post_body = opts[:debug_body]
|
|
61
|
+
|
|
62
|
+
# return_type
|
|
63
|
+
return_type = opts[:debug_return_type] || 'BooleanWrapper'
|
|
64
|
+
|
|
65
|
+
# auth_names
|
|
66
|
+
auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
|
|
67
|
+
|
|
68
|
+
new_options = opts.merge(
|
|
69
|
+
:operation => :"Backup::BackupApi.cancel_backup",
|
|
70
|
+
:header_params => header_params,
|
|
71
|
+
:query_params => query_params,
|
|
72
|
+
:form_params => form_params,
|
|
73
|
+
:body => post_body,
|
|
74
|
+
:auth_names => auth_names,
|
|
75
|
+
:return_type => return_type
|
|
76
|
+
)
|
|
77
|
+
|
|
78
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
79
|
+
if @api_client.config.debugging
|
|
80
|
+
@api_client.config.logger.debug "API called: Backup::BackupApi#cancel_backup\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
81
|
+
end
|
|
82
|
+
return data, status_code, headers
|
|
83
|
+
end
|
|
84
|
+
|
|
85
|
+
# Create the backup schedule
|
|
86
|
+
# Sets the backup schedule of the current portal. A portal keeps at most one schedule, so this replaces the existing one rather than adding a second, and `dump` writes the schedule of the whole server instead, which requires the space access permission and works on a standalone installation only. Scheduled backups have to be allowed by the pricing plan of a portal that is not a standalone installation. `cronParams` is a period plus a time rather than a cron string: `hour` is the hour of the day from 0 to 23, and `day` has to be given for `EveryWeek`, where it is the day of the week from 1 to 7 with Sunday as 1, and for `EveryMonth`, where it is the day of the month from 1 to 31. It is left out for `EveryDay`, and a weekly or monthly schedule sent without it is rejected with 400 instead of falling back to a default. `backupsStored` is the number of scheduled copies to keep, from 1 to 30, and it defaults to 1. Older copies are removed by a background cleaner, and only the ones this schedule created: archives made by `POST api/2.0/backup/startbackup` are not counted and not removed. A portal whose subscription stops covering backups has its schedule deleted by the scheduler, not suspended, and its administrators are notified that the scheduled backup failed. The keys expected in `storageParams` are the same as for `POST api/2.0/backup/startbackup`, except that they are sent as an array of key and value pairs here and returned as an object by `GET api/2.0/backup/getbackupschedule`.
|
|
87
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/create-backup-schedule/
|
|
88
|
+
# @param [Hash] opts the optional parameters
|
|
89
|
+
# @option opts [CreateBackupScheduleRequestDto] :create_backup_schedule_request_dto
|
|
90
|
+
# @return [BooleanWrapper]
|
|
91
|
+
def create_backup_schedule(opts = {})
|
|
92
|
+
data, _status_code, _headers = create_backup_schedule_with_http_info(opts)
|
|
93
|
+
data
|
|
94
|
+
end
|
|
95
|
+
|
|
96
|
+
# Create the backup schedule
|
|
97
|
+
# Sets the backup schedule of the current portal. A portal keeps at most one schedule, so this replaces the existing one rather than adding a second, and `dump` writes the schedule of the whole server instead, which requires the space access permission and works on a standalone installation only. Scheduled backups have to be allowed by the pricing plan of a portal that is not a standalone installation. `cronParams` is a period plus a time rather than a cron string: `hour` is the hour of the day from 0 to 23, and `day` has to be given for `EveryWeek`, where it is the day of the week from 1 to 7 with Sunday as 1, and for `EveryMonth`, where it is the day of the month from 1 to 31. It is left out for `EveryDay`, and a weekly or monthly schedule sent without it is rejected with 400 instead of falling back to a default. `backupsStored` is the number of scheduled copies to keep, from 1 to 30, and it defaults to 1. Older copies are removed by a background cleaner, and only the ones this schedule created: archives made by `POST api/2.0/backup/startbackup` are not counted and not removed. A portal whose subscription stops covering backups has its schedule deleted by the scheduler, not suspended, and its administrators are notified that the scheduled backup failed. The keys expected in `storageParams` are the same as for `POST api/2.0/backup/startbackup`, except that they are sent as an array of key and value pairs here and returned as an object by `GET api/2.0/backup/getbackupschedule`.
|
|
98
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/create-backup-schedule/
|
|
99
|
+
# @param [Hash] opts the optional parameters
|
|
100
|
+
# @option opts [CreateBackupScheduleRequestDto] :create_backup_schedule_request_dto
|
|
101
|
+
# @return [Array<(BooleanWrapper, Integer, Hash)>] BooleanWrapper data, response status code and response headers
|
|
102
|
+
def create_backup_schedule_with_http_info(opts = {})
|
|
103
|
+
if @api_client.config.debugging
|
|
104
|
+
@api_client.config.logger.debug 'Calling API: Backup::BackupApi.create_backup_schedule ...'
|
|
105
|
+
end
|
|
106
|
+
# resource path
|
|
107
|
+
local_var_path = '/api/2.0/backup/createbackupschedule'
|
|
108
|
+
|
|
109
|
+
# query parameters
|
|
110
|
+
query_params = opts[:query_params] || {}
|
|
111
|
+
|
|
112
|
+
# header parameters
|
|
113
|
+
header_params = opts[:header_params] || {}
|
|
114
|
+
# HTTP header 'Accept' (if needed)
|
|
115
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
116
|
+
# HTTP header 'Content-Type'
|
|
117
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
118
|
+
if !content_type.nil?
|
|
119
|
+
header_params['Content-Type'] = content_type
|
|
120
|
+
end
|
|
121
|
+
|
|
122
|
+
# form parameters
|
|
123
|
+
form_params = opts[:form_params] || {}
|
|
124
|
+
|
|
125
|
+
# http body (model)
|
|
126
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'create_backup_schedule_request_dto'])
|
|
127
|
+
|
|
128
|
+
# return_type
|
|
129
|
+
return_type = opts[:debug_return_type] || 'BooleanWrapper'
|
|
130
|
+
|
|
131
|
+
# auth_names
|
|
132
|
+
auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
|
|
133
|
+
|
|
134
|
+
new_options = opts.merge(
|
|
135
|
+
:operation => :"Backup::BackupApi.create_backup_schedule",
|
|
136
|
+
:header_params => header_params,
|
|
137
|
+
:query_params => query_params,
|
|
138
|
+
:form_params => form_params,
|
|
139
|
+
:body => post_body,
|
|
140
|
+
:auth_names => auth_names,
|
|
141
|
+
:return_type => return_type
|
|
142
|
+
)
|
|
143
|
+
|
|
144
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
145
|
+
if @api_client.config.debugging
|
|
146
|
+
@api_client.config.logger.debug "API called: Backup::BackupApi#create_backup_schedule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
147
|
+
end
|
|
148
|
+
return data, status_code, headers
|
|
149
|
+
end
|
|
150
|
+
|
|
151
|
+
# Delete the backup
|
|
152
|
+
# Deletes one backup: first its history record, then the archive in the storage the record points at. The ID is the one listed by `GET api/2.0/backup/getbackuphistory`, which is also the `taskId` the backup was started with. Deleting a backup of the whole server rather than of one portal additionally requires the space access permission. A record that belongs to another portal is left untouched and the call still answers true, so the result confirms that the request was accepted rather than that anything was deleted - check with `GET api/2.0/backup/getbackuphistory` if it matters. The record is removed before the archive, so when the storage can no longer be reached the archive stays behind with nothing pointing at it. An ID that no backup has ever had is answered with 404.
|
|
153
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/delete-backup/
|
|
154
|
+
# @param id [String] The ID of the backup to delete, taken from the route. It is the `id` of a record listed by `GET api/2.0/backup/getbackuphistory`, which is also the `taskId` the backup was started with.
|
|
155
|
+
# @param [Hash] opts the optional parameters
|
|
156
|
+
# @return [BooleanWrapper]
|
|
157
|
+
def delete_backup(id, opts = {})
|
|
158
|
+
data, _status_code, _headers = delete_backup_with_http_info(id, opts)
|
|
159
|
+
data
|
|
160
|
+
end
|
|
161
|
+
|
|
162
|
+
# Delete the backup
|
|
163
|
+
# Deletes one backup: first its history record, then the archive in the storage the record points at. The ID is the one listed by `GET api/2.0/backup/getbackuphistory`, which is also the `taskId` the backup was started with. Deleting a backup of the whole server rather than of one portal additionally requires the space access permission. A record that belongs to another portal is left untouched and the call still answers true, so the result confirms that the request was accepted rather than that anything was deleted - check with `GET api/2.0/backup/getbackuphistory` if it matters. The record is removed before the archive, so when the storage can no longer be reached the archive stays behind with nothing pointing at it. An ID that no backup has ever had is answered with 404.
|
|
164
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/delete-backup/
|
|
165
|
+
# @param id [String] The ID of the backup to delete, taken from the route. It is the `id` of a record listed by `GET api/2.0/backup/getbackuphistory`, which is also the `taskId` the backup was started with.
|
|
166
|
+
# @param [Hash] opts the optional parameters
|
|
167
|
+
# @return [Array<(BooleanWrapper, Integer, Hash)>] BooleanWrapper data, response status code and response headers
|
|
168
|
+
def delete_backup_with_http_info(id, opts = {})
|
|
169
|
+
if @api_client.config.debugging
|
|
170
|
+
@api_client.config.logger.debug 'Calling API: Backup::BackupApi.delete_backup ...'
|
|
171
|
+
end
|
|
172
|
+
# verify the required parameter 'id' is set
|
|
173
|
+
if @api_client.config.client_side_validation && id.nil?
|
|
174
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling Backup::BackupApi.delete_backup"
|
|
175
|
+
end
|
|
176
|
+
# resource path
|
|
177
|
+
local_var_path = '/api/2.0/backup/deletebackup/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
|
178
|
+
|
|
179
|
+
# query parameters
|
|
180
|
+
query_params = opts[:query_params] || {}
|
|
181
|
+
|
|
182
|
+
# header parameters
|
|
183
|
+
header_params = opts[:header_params] || {}
|
|
184
|
+
# HTTP header 'Accept' (if needed)
|
|
185
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
186
|
+
|
|
187
|
+
# form parameters
|
|
188
|
+
form_params = opts[:form_params] || {}
|
|
189
|
+
|
|
190
|
+
# http body (model)
|
|
191
|
+
post_body = opts[:debug_body]
|
|
192
|
+
|
|
193
|
+
# return_type
|
|
194
|
+
return_type = opts[:debug_return_type] || 'BooleanWrapper'
|
|
195
|
+
|
|
196
|
+
# auth_names
|
|
197
|
+
auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
|
|
198
|
+
|
|
199
|
+
new_options = opts.merge(
|
|
200
|
+
:operation => :"Backup::BackupApi.delete_backup",
|
|
201
|
+
:header_params => header_params,
|
|
202
|
+
:query_params => query_params,
|
|
203
|
+
:form_params => form_params,
|
|
204
|
+
:body => post_body,
|
|
205
|
+
:auth_names => auth_names,
|
|
206
|
+
:return_type => return_type
|
|
207
|
+
)
|
|
208
|
+
|
|
209
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
|
|
210
|
+
if @api_client.config.debugging
|
|
211
|
+
@api_client.config.logger.debug "API called: Backup::BackupApi#delete_backup\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
212
|
+
end
|
|
213
|
+
return data, status_code, headers
|
|
214
|
+
end
|
|
215
|
+
|
|
216
|
+
# Delete the backup history
|
|
217
|
+
# Deletes every backup of the current portal, both the history records and the archives themselves, and leaves the backup schedule alone. `dump` clears the backups of the whole server instead and requires the space access permission. The records are walked one by one and a failure on any of them is swallowed, so the result is always true even when some archives could not be deleted: it does not mean the history is now empty. Call `GET api/2.0/backup/getbackuphistory` afterwards to see what is left. Each record is removed before its archive, so an archive whose deletion fails stays in the storage with nothing pointing at it.
|
|
218
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/delete-backup-history/
|
|
219
|
+
# @param [Hash] opts the optional parameters
|
|
220
|
+
# @option opts [Boolean] :dump Applies the operation to the whole server rather than to the current portal, which requires the space access permission and works on a standalone installation only. Server-wide backups and schedules are kept apart from the ones of a portal, so the two values address different data.
|
|
221
|
+
# @return [BooleanWrapper]
|
|
222
|
+
def delete_backup_history(opts = {})
|
|
223
|
+
data, _status_code, _headers = delete_backup_history_with_http_info(opts)
|
|
224
|
+
data
|
|
225
|
+
end
|
|
226
|
+
|
|
227
|
+
# Delete the backup history
|
|
228
|
+
# Deletes every backup of the current portal, both the history records and the archives themselves, and leaves the backup schedule alone. `dump` clears the backups of the whole server instead and requires the space access permission. The records are walked one by one and a failure on any of them is swallowed, so the result is always true even when some archives could not be deleted: it does not mean the history is now empty. Call `GET api/2.0/backup/getbackuphistory` afterwards to see what is left. Each record is removed before its archive, so an archive whose deletion fails stays in the storage with nothing pointing at it.
|
|
229
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/delete-backup-history/
|
|
230
|
+
# @param [Hash] opts the optional parameters
|
|
231
|
+
# @option opts [Boolean] :dump Applies the operation to the whole server rather than to the current portal, which requires the space access permission and works on a standalone installation only. Server-wide backups and schedules are kept apart from the ones of a portal, so the two values address different data.
|
|
232
|
+
# @return [Array<(BooleanWrapper, Integer, Hash)>] BooleanWrapper data, response status code and response headers
|
|
233
|
+
def delete_backup_history_with_http_info(opts = {})
|
|
234
|
+
if @api_client.config.debugging
|
|
235
|
+
@api_client.config.logger.debug 'Calling API: Backup::BackupApi.delete_backup_history ...'
|
|
236
|
+
end
|
|
237
|
+
# resource path
|
|
238
|
+
local_var_path = '/api/2.0/backup/deletebackuphistory'
|
|
239
|
+
|
|
240
|
+
# query parameters
|
|
241
|
+
query_params = opts[:query_params] || {}
|
|
242
|
+
query_params[:'dump'] = opts[:'dump'] if !opts[:'dump'].nil?
|
|
243
|
+
|
|
244
|
+
# header parameters
|
|
245
|
+
header_params = opts[:header_params] || {}
|
|
246
|
+
# HTTP header 'Accept' (if needed)
|
|
247
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
248
|
+
|
|
249
|
+
# form parameters
|
|
250
|
+
form_params = opts[:form_params] || {}
|
|
251
|
+
|
|
252
|
+
# http body (model)
|
|
253
|
+
post_body = opts[:debug_body]
|
|
254
|
+
|
|
255
|
+
# return_type
|
|
256
|
+
return_type = opts[:debug_return_type] || 'BooleanWrapper'
|
|
257
|
+
|
|
258
|
+
# auth_names
|
|
259
|
+
auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
|
|
260
|
+
|
|
261
|
+
new_options = opts.merge(
|
|
262
|
+
:operation => :"Backup::BackupApi.delete_backup_history",
|
|
263
|
+
:header_params => header_params,
|
|
264
|
+
:query_params => query_params,
|
|
265
|
+
:form_params => form_params,
|
|
266
|
+
:body => post_body,
|
|
267
|
+
:auth_names => auth_names,
|
|
268
|
+
:return_type => return_type
|
|
269
|
+
)
|
|
270
|
+
|
|
271
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
|
|
272
|
+
if @api_client.config.debugging
|
|
273
|
+
@api_client.config.logger.debug "API called: Backup::BackupApi#delete_backup_history\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
274
|
+
end
|
|
275
|
+
return data, status_code, headers
|
|
276
|
+
end
|
|
277
|
+
|
|
278
|
+
# Delete the backup schedule
|
|
279
|
+
# Deletes the backup schedule of the current portal, which stops the scheduled backups; `dump` deletes the schedule of the whole server instead and requires the space access permission. The archives the schedule has already produced are kept and stay listed by `GET api/2.0/backup/getbackuphistory` - delete them through `DELETE api/2.0/backup/deletebackup/{id}` if they are no longer wanted. The result is always true, including when there was no schedule to delete, so it confirms that the portal now has none rather than that anything was removed. The deletion is written to the audit trail either way.
|
|
280
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/delete-backup-schedule/
|
|
281
|
+
# @param [Hash] opts the optional parameters
|
|
282
|
+
# @option opts [Boolean] :dump Applies the operation to the whole server rather than to the current portal, which requires the space access permission and works on a standalone installation only. Server-wide backups and schedules are kept apart from the ones of a portal, so the two values address different data.
|
|
283
|
+
# @return [BooleanWrapper]
|
|
284
|
+
def delete_backup_schedule(opts = {})
|
|
285
|
+
data, _status_code, _headers = delete_backup_schedule_with_http_info(opts)
|
|
286
|
+
data
|
|
287
|
+
end
|
|
288
|
+
|
|
289
|
+
# Delete the backup schedule
|
|
290
|
+
# Deletes the backup schedule of the current portal, which stops the scheduled backups; `dump` deletes the schedule of the whole server instead and requires the space access permission. The archives the schedule has already produced are kept and stay listed by `GET api/2.0/backup/getbackuphistory` - delete them through `DELETE api/2.0/backup/deletebackup/{id}` if they are no longer wanted. The result is always true, including when there was no schedule to delete, so it confirms that the portal now has none rather than that anything was removed. The deletion is written to the audit trail either way.
|
|
291
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/delete-backup-schedule/
|
|
292
|
+
# @param [Hash] opts the optional parameters
|
|
293
|
+
# @option opts [Boolean] :dump Applies the operation to the whole server rather than to the current portal, which requires the space access permission and works on a standalone installation only. Server-wide backups and schedules are kept apart from the ones of a portal, so the two values address different data.
|
|
294
|
+
# @return [Array<(BooleanWrapper, Integer, Hash)>] BooleanWrapper data, response status code and response headers
|
|
295
|
+
def delete_backup_schedule_with_http_info(opts = {})
|
|
296
|
+
if @api_client.config.debugging
|
|
297
|
+
@api_client.config.logger.debug 'Calling API: Backup::BackupApi.delete_backup_schedule ...'
|
|
298
|
+
end
|
|
299
|
+
# resource path
|
|
300
|
+
local_var_path = '/api/2.0/backup/deletebackupschedule'
|
|
301
|
+
|
|
302
|
+
# query parameters
|
|
303
|
+
query_params = opts[:query_params] || {}
|
|
304
|
+
query_params[:'dump'] = opts[:'dump'] if !opts[:'dump'].nil?
|
|
305
|
+
|
|
306
|
+
# header parameters
|
|
307
|
+
header_params = opts[:header_params] || {}
|
|
308
|
+
# HTTP header 'Accept' (if needed)
|
|
309
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
310
|
+
|
|
311
|
+
# form parameters
|
|
312
|
+
form_params = opts[:form_params] || {}
|
|
313
|
+
|
|
314
|
+
# http body (model)
|
|
315
|
+
post_body = opts[:debug_body]
|
|
316
|
+
|
|
317
|
+
# return_type
|
|
318
|
+
return_type = opts[:debug_return_type] || 'BooleanWrapper'
|
|
319
|
+
|
|
320
|
+
# auth_names
|
|
321
|
+
auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
|
|
322
|
+
|
|
323
|
+
new_options = opts.merge(
|
|
324
|
+
:operation => :"Backup::BackupApi.delete_backup_schedule",
|
|
325
|
+
:header_params => header_params,
|
|
326
|
+
:query_params => query_params,
|
|
327
|
+
:form_params => form_params,
|
|
328
|
+
:body => post_body,
|
|
329
|
+
:auth_names => auth_names,
|
|
330
|
+
:return_type => return_type
|
|
331
|
+
)
|
|
332
|
+
|
|
333
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
|
|
334
|
+
if @api_client.config.debugging
|
|
335
|
+
@api_client.config.logger.debug "API called: Backup::BackupApi#delete_backup_schedule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
336
|
+
end
|
|
337
|
+
return data, status_code, headers
|
|
338
|
+
end
|
|
339
|
+
|
|
340
|
+
# Get the backup history
|
|
341
|
+
# Lists the backups of the current portal whose archive is still present in the storage it was written to. The records come back in no particular order, so sort them by `createdOn` if the newest one is wanted. `dump` lists the backups of the whole server instead and requires the space access permission. Despite being a read operation, this prunes the history as it goes: a record whose archive is no longer in its storage is deleted outright, so the list can shrink between two calls without anybody deleting anything. A record whose storage can no longer be reached at all - a disconnected third-party account, for instance - is neither returned nor deleted, so it stays invisible while still occupying the history. The `id` of a record is the same value as the `taskId` that `POST api/2.0/backup/startbackup` returned for it, and it is what `DELETE api/2.0/backup/deletebackup/{id}` and the `backupId` of `POST api/2.0/backup/startrestore` expect.
|
|
342
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-backup-history/
|
|
343
|
+
# @param [Hash] opts the optional parameters
|
|
344
|
+
# @option opts [Boolean] :dump Applies the operation to the whole server rather than to the current portal, which requires the space access permission and works on a standalone installation only. Server-wide backups and schedules are kept apart from the ones of a portal, so the two values address different data.
|
|
345
|
+
# @return [BackupHistoryRecordArrayWrapper]
|
|
346
|
+
def get_backup_history(opts = {})
|
|
347
|
+
data, _status_code, _headers = get_backup_history_with_http_info(opts)
|
|
348
|
+
data
|
|
349
|
+
end
|
|
350
|
+
|
|
351
|
+
# Get the backup history
|
|
352
|
+
# Lists the backups of the current portal whose archive is still present in the storage it was written to. The records come back in no particular order, so sort them by `createdOn` if the newest one is wanted. `dump` lists the backups of the whole server instead and requires the space access permission. Despite being a read operation, this prunes the history as it goes: a record whose archive is no longer in its storage is deleted outright, so the list can shrink between two calls without anybody deleting anything. A record whose storage can no longer be reached at all - a disconnected third-party account, for instance - is neither returned nor deleted, so it stays invisible while still occupying the history. The `id` of a record is the same value as the `taskId` that `POST api/2.0/backup/startbackup` returned for it, and it is what `DELETE api/2.0/backup/deletebackup/{id}` and the `backupId` of `POST api/2.0/backup/startrestore` expect.
|
|
353
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-backup-history/
|
|
354
|
+
# @param [Hash] opts the optional parameters
|
|
355
|
+
# @option opts [Boolean] :dump Applies the operation to the whole server rather than to the current portal, which requires the space access permission and works on a standalone installation only. Server-wide backups and schedules are kept apart from the ones of a portal, so the two values address different data.
|
|
356
|
+
# @return [Array<(BackupHistoryRecordArrayWrapper, Integer, Hash)>] BackupHistoryRecordArrayWrapper data, response status code and response headers
|
|
357
|
+
def get_backup_history_with_http_info(opts = {})
|
|
358
|
+
if @api_client.config.debugging
|
|
359
|
+
@api_client.config.logger.debug 'Calling API: Backup::BackupApi.get_backup_history ...'
|
|
360
|
+
end
|
|
361
|
+
# resource path
|
|
362
|
+
local_var_path = '/api/2.0/backup/getbackuphistory'
|
|
363
|
+
|
|
364
|
+
# query parameters
|
|
365
|
+
query_params = opts[:query_params] || {}
|
|
366
|
+
query_params[:'dump'] = opts[:'dump'] if !opts[:'dump'].nil?
|
|
367
|
+
|
|
368
|
+
# header parameters
|
|
369
|
+
header_params = opts[:header_params] || {}
|
|
370
|
+
# HTTP header 'Accept' (if needed)
|
|
371
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
372
|
+
|
|
373
|
+
# form parameters
|
|
374
|
+
form_params = opts[:form_params] || {}
|
|
375
|
+
|
|
376
|
+
# http body (model)
|
|
377
|
+
post_body = opts[:debug_body]
|
|
378
|
+
|
|
379
|
+
# return_type
|
|
380
|
+
return_type = opts[:debug_return_type] || 'BackupHistoryRecordArrayWrapper'
|
|
381
|
+
|
|
382
|
+
# auth_names
|
|
383
|
+
auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
|
|
384
|
+
|
|
385
|
+
new_options = opts.merge(
|
|
386
|
+
:operation => :"Backup::BackupApi.get_backup_history",
|
|
387
|
+
:header_params => header_params,
|
|
388
|
+
:query_params => query_params,
|
|
389
|
+
:form_params => form_params,
|
|
390
|
+
:body => post_body,
|
|
391
|
+
:auth_names => auth_names,
|
|
392
|
+
:return_type => return_type
|
|
393
|
+
)
|
|
394
|
+
|
|
395
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
396
|
+
if @api_client.config.debugging
|
|
397
|
+
@api_client.config.logger.debug "API called: Backup::BackupApi#get_backup_history\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
398
|
+
end
|
|
399
|
+
return data, status_code, headers
|
|
400
|
+
end
|
|
401
|
+
|
|
402
|
+
# Get the backup progress
|
|
403
|
+
# Reports the state of the backup job of the current portal, and is the operation to poll after `POST api/2.0/backup/startbackup`. The queue holds one job per portal, so no job ID is passed in; `dump` asks for the state of the server-wide job instead and requires the space access permission. When there is no such job - none was ever started, or the finished one has already been dropped from the queue - the call still answers 200, but the body carries no `response` member at all, so a client has to treat the payload as optional rather than expect an empty object. While the job runs, `isCompleted` is false, `error` and `link` are empty strings and `progress` grows from 0 to 100. Once it stops, `isCompleted` turns true and `status` says how it ended: a non-empty `error` is the only report of a failure, `warning` is set when the archive was written but some files could not be read or when the job was cancelled, and `link` becomes the download link to the stored archive.
|
|
404
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-backup-progress/
|
|
405
|
+
# @param [Hash] opts the optional parameters
|
|
406
|
+
# @option opts [Boolean] :dump Applies the operation to the whole server rather than to the current portal, which requires the space access permission and works on a standalone installation only. Server-wide backups and schedules are kept apart from the ones of a portal, so the two values address different data.
|
|
407
|
+
# @return [BackupProgressWrapper]
|
|
408
|
+
def get_backup_progress(opts = {})
|
|
409
|
+
data, _status_code, _headers = get_backup_progress_with_http_info(opts)
|
|
410
|
+
data
|
|
411
|
+
end
|
|
412
|
+
|
|
413
|
+
# Get the backup progress
|
|
414
|
+
# Reports the state of the backup job of the current portal, and is the operation to poll after `POST api/2.0/backup/startbackup`. The queue holds one job per portal, so no job ID is passed in; `dump` asks for the state of the server-wide job instead and requires the space access permission. When there is no such job - none was ever started, or the finished one has already been dropped from the queue - the call still answers 200, but the body carries no `response` member at all, so a client has to treat the payload as optional rather than expect an empty object. While the job runs, `isCompleted` is false, `error` and `link` are empty strings and `progress` grows from 0 to 100. Once it stops, `isCompleted` turns true and `status` says how it ended: a non-empty `error` is the only report of a failure, `warning` is set when the archive was written but some files could not be read or when the job was cancelled, and `link` becomes the download link to the stored archive.
|
|
415
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-backup-progress/
|
|
416
|
+
# @param [Hash] opts the optional parameters
|
|
417
|
+
# @option opts [Boolean] :dump Applies the operation to the whole server rather than to the current portal, which requires the space access permission and works on a standalone installation only. Server-wide backups and schedules are kept apart from the ones of a portal, so the two values address different data.
|
|
418
|
+
# @return [Array<(BackupProgressWrapper, Integer, Hash)>] BackupProgressWrapper data, response status code and response headers
|
|
419
|
+
def get_backup_progress_with_http_info(opts = {})
|
|
420
|
+
if @api_client.config.debugging
|
|
421
|
+
@api_client.config.logger.debug 'Calling API: Backup::BackupApi.get_backup_progress ...'
|
|
422
|
+
end
|
|
423
|
+
# resource path
|
|
424
|
+
local_var_path = '/api/2.0/backup/getbackupprogress'
|
|
425
|
+
|
|
426
|
+
# query parameters
|
|
427
|
+
query_params = opts[:query_params] || {}
|
|
428
|
+
query_params[:'dump'] = opts[:'dump'] if !opts[:'dump'].nil?
|
|
429
|
+
|
|
430
|
+
# header parameters
|
|
431
|
+
header_params = opts[:header_params] || {}
|
|
432
|
+
# HTTP header 'Accept' (if needed)
|
|
433
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
434
|
+
|
|
435
|
+
# form parameters
|
|
436
|
+
form_params = opts[:form_params] || {}
|
|
437
|
+
|
|
438
|
+
# http body (model)
|
|
439
|
+
post_body = opts[:debug_body]
|
|
440
|
+
|
|
441
|
+
# return_type
|
|
442
|
+
return_type = opts[:debug_return_type] || 'BackupProgressWrapper'
|
|
443
|
+
|
|
444
|
+
# auth_names
|
|
445
|
+
auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
|
|
446
|
+
|
|
447
|
+
new_options = opts.merge(
|
|
448
|
+
:operation => :"Backup::BackupApi.get_backup_progress",
|
|
449
|
+
:header_params => header_params,
|
|
450
|
+
:query_params => query_params,
|
|
451
|
+
:form_params => form_params,
|
|
452
|
+
:body => post_body,
|
|
453
|
+
:auth_names => auth_names,
|
|
454
|
+
:return_type => return_type
|
|
455
|
+
)
|
|
456
|
+
|
|
457
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
458
|
+
if @api_client.config.debugging
|
|
459
|
+
@api_client.config.logger.debug "API called: Backup::BackupApi#get_backup_progress\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
460
|
+
end
|
|
461
|
+
return data, status_code, headers
|
|
462
|
+
end
|
|
463
|
+
|
|
464
|
+
# Get the backup schedule
|
|
465
|
+
# Returns the backup schedule of the current portal. A portal keeps at most one schedule, so no ID is passed in, and when none is set the call still answers 200 with a body that carries no `response` member at all. `dump` asks for the schedule of the whole server instead of the one of this portal and requires the space access permission. The answer cannot be sent back unchanged: `storageParams` is returned as an object keyed by parameter name, while `POST api/2.0/backup/createbackupschedule` expects an array of key and value pairs. For every storage type except `ThirdPartyConsumer` the `folderId` key of the answer is built from the stored base path rather than read back from the saved parameters, and a schedule that keeps an unlimited number of copies reports `backupsStored` as null instead of 0.
|
|
466
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-backup-schedule/
|
|
467
|
+
# @param [Hash] opts the optional parameters
|
|
468
|
+
# @option opts [Boolean] :dump Applies the operation to the whole server rather than to the current portal, which requires the space access permission and works on a standalone installation only. Server-wide backups and schedules are kept apart from the ones of a portal, so the two values address different data.
|
|
469
|
+
# @return [ScheduleWrapper]
|
|
470
|
+
def get_backup_schedule(opts = {})
|
|
471
|
+
data, _status_code, _headers = get_backup_schedule_with_http_info(opts)
|
|
472
|
+
data
|
|
473
|
+
end
|
|
474
|
+
|
|
475
|
+
# Get the backup schedule
|
|
476
|
+
# Returns the backup schedule of the current portal. A portal keeps at most one schedule, so no ID is passed in, and when none is set the call still answers 200 with a body that carries no `response` member at all. `dump` asks for the schedule of the whole server instead of the one of this portal and requires the space access permission. The answer cannot be sent back unchanged: `storageParams` is returned as an object keyed by parameter name, while `POST api/2.0/backup/createbackupschedule` expects an array of key and value pairs. For every storage type except `ThirdPartyConsumer` the `folderId` key of the answer is built from the stored base path rather than read back from the saved parameters, and a schedule that keeps an unlimited number of copies reports `backupsStored` as null instead of 0.
|
|
477
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-backup-schedule/
|
|
478
|
+
# @param [Hash] opts the optional parameters
|
|
479
|
+
# @option opts [Boolean] :dump Applies the operation to the whole server rather than to the current portal, which requires the space access permission and works on a standalone installation only. Server-wide backups and schedules are kept apart from the ones of a portal, so the two values address different data.
|
|
480
|
+
# @return [Array<(ScheduleWrapper, Integer, Hash)>] ScheduleWrapper data, response status code and response headers
|
|
481
|
+
def get_backup_schedule_with_http_info(opts = {})
|
|
482
|
+
if @api_client.config.debugging
|
|
483
|
+
@api_client.config.logger.debug 'Calling API: Backup::BackupApi.get_backup_schedule ...'
|
|
484
|
+
end
|
|
485
|
+
# resource path
|
|
486
|
+
local_var_path = '/api/2.0/backup/getbackupschedule'
|
|
487
|
+
|
|
488
|
+
# query parameters
|
|
489
|
+
query_params = opts[:query_params] || {}
|
|
490
|
+
query_params[:'dump'] = opts[:'dump'] if !opts[:'dump'].nil?
|
|
491
|
+
|
|
492
|
+
# header parameters
|
|
493
|
+
header_params = opts[:header_params] || {}
|
|
494
|
+
# HTTP header 'Accept' (if needed)
|
|
495
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
496
|
+
|
|
497
|
+
# form parameters
|
|
498
|
+
form_params = opts[:form_params] || {}
|
|
499
|
+
|
|
500
|
+
# http body (model)
|
|
501
|
+
post_body = opts[:debug_body]
|
|
502
|
+
|
|
503
|
+
# return_type
|
|
504
|
+
return_type = opts[:debug_return_type] || 'ScheduleWrapper'
|
|
505
|
+
|
|
506
|
+
# auth_names
|
|
507
|
+
auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
|
|
508
|
+
|
|
509
|
+
new_options = opts.merge(
|
|
510
|
+
:operation => :"Backup::BackupApi.get_backup_schedule",
|
|
511
|
+
:header_params => header_params,
|
|
512
|
+
:query_params => query_params,
|
|
513
|
+
:form_params => form_params,
|
|
514
|
+
:body => post_body,
|
|
515
|
+
:auth_names => auth_names,
|
|
516
|
+
:return_type => return_type
|
|
517
|
+
)
|
|
518
|
+
|
|
519
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
520
|
+
if @api_client.config.debugging
|
|
521
|
+
@api_client.config.logger.debug "API called: Backup::BackupApi#get_backup_schedule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
522
|
+
end
|
|
523
|
+
return data, status_code, headers
|
|
524
|
+
end
|
|
525
|
+
|
|
526
|
+
# Get the number of backups
|
|
527
|
+
# Counts the backups of the current portal that were created within a period, and `paid` chooses which kind is counted: false, the default, counts the ones covered by the free monthly allowance, and true counts the ones charged to the portal wallet. The period defaults to the current calendar month - `from` becomes the first day of the month at 00:00 UTC and `to` becomes the moment of the call. Both bounds are UTC and inclusive, and a `from` later than `to` is rejected. Called with no parameters at all, this returns exactly the figure the free monthly allowance is measured against. The count is over history records rather than over stored archives, so it includes backups that have already been deleted; use `GET api/2.0/backup/getbackuphistory` to see what can still be restored.
|
|
528
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-backups-count/
|
|
529
|
+
# @param [Hash] opts the optional parameters
|
|
530
|
+
# @option opts [Time] :from The start of the period, in UTC and inclusive. It defaults to the first day of the current calendar month at 00:00 UTC, and it has to be no later than `to`.
|
|
531
|
+
# @option opts [Time] :to The end of the period, in UTC and inclusive. It defaults to the moment of the call.
|
|
532
|
+
# @option opts [Boolean] :paid Counts the backups charged to the portal wallet when true, and the ones covered by the free monthly allowance when false, which is the default. It is read only by `GET api/2.0/backup/getbackupscount` and is ignored by `GET api/2.0/backup/getbackupscountbypaid`, which always reports both.
|
|
533
|
+
# @return [Int32Wrapper]
|
|
534
|
+
def get_backups_count(opts = {})
|
|
535
|
+
data, _status_code, _headers = get_backups_count_with_http_info(opts)
|
|
536
|
+
data
|
|
537
|
+
end
|
|
538
|
+
|
|
539
|
+
# Get the number of backups
|
|
540
|
+
# Counts the backups of the current portal that were created within a period, and `paid` chooses which kind is counted: false, the default, counts the ones covered by the free monthly allowance, and true counts the ones charged to the portal wallet. The period defaults to the current calendar month - `from` becomes the first day of the month at 00:00 UTC and `to` becomes the moment of the call. Both bounds are UTC and inclusive, and a `from` later than `to` is rejected. Called with no parameters at all, this returns exactly the figure the free monthly allowance is measured against. The count is over history records rather than over stored archives, so it includes backups that have already been deleted; use `GET api/2.0/backup/getbackuphistory` to see what can still be restored.
|
|
541
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-backups-count/
|
|
542
|
+
# @param [Hash] opts the optional parameters
|
|
543
|
+
# @option opts [Time] :from The start of the period, in UTC and inclusive. It defaults to the first day of the current calendar month at 00:00 UTC, and it has to be no later than `to`.
|
|
544
|
+
# @option opts [Time] :to The end of the period, in UTC and inclusive. It defaults to the moment of the call.
|
|
545
|
+
# @option opts [Boolean] :paid Counts the backups charged to the portal wallet when true, and the ones covered by the free monthly allowance when false, which is the default. It is read only by `GET api/2.0/backup/getbackupscount` and is ignored by `GET api/2.0/backup/getbackupscountbypaid`, which always reports both.
|
|
546
|
+
# @return [Array<(Int32Wrapper, Integer, Hash)>] Int32Wrapper data, response status code and response headers
|
|
547
|
+
def get_backups_count_with_http_info(opts = {})
|
|
548
|
+
if @api_client.config.debugging
|
|
549
|
+
@api_client.config.logger.debug 'Calling API: Backup::BackupApi.get_backups_count ...'
|
|
550
|
+
end
|
|
551
|
+
# resource path
|
|
552
|
+
local_var_path = '/api/2.0/backup/getbackupscount'
|
|
553
|
+
|
|
554
|
+
# query parameters
|
|
555
|
+
query_params = opts[:query_params] || {}
|
|
556
|
+
query_params[:'from'] = opts[:'from'] if !opts[:'from'].nil?
|
|
557
|
+
query_params[:'to'] = opts[:'to'] if !opts[:'to'].nil?
|
|
558
|
+
query_params[:'paid'] = opts[:'paid'] if !opts[:'paid'].nil?
|
|
559
|
+
|
|
560
|
+
# header parameters
|
|
561
|
+
header_params = opts[:header_params] || {}
|
|
562
|
+
# HTTP header 'Accept' (if needed)
|
|
563
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
564
|
+
|
|
565
|
+
# form parameters
|
|
566
|
+
form_params = opts[:form_params] || {}
|
|
567
|
+
|
|
568
|
+
# http body (model)
|
|
569
|
+
post_body = opts[:debug_body]
|
|
570
|
+
|
|
571
|
+
# return_type
|
|
572
|
+
return_type = opts[:debug_return_type] || 'Int32Wrapper'
|
|
573
|
+
|
|
574
|
+
# auth_names
|
|
575
|
+
auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
|
|
576
|
+
|
|
577
|
+
new_options = opts.merge(
|
|
578
|
+
:operation => :"Backup::BackupApi.get_backups_count",
|
|
579
|
+
:header_params => header_params,
|
|
580
|
+
:query_params => query_params,
|
|
581
|
+
:form_params => form_params,
|
|
582
|
+
:body => post_body,
|
|
583
|
+
:auth_names => auth_names,
|
|
584
|
+
:return_type => return_type
|
|
585
|
+
)
|
|
586
|
+
|
|
587
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
588
|
+
if @api_client.config.debugging
|
|
589
|
+
@api_client.config.logger.debug "API called: Backup::BackupApi#get_backups_count\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
590
|
+
end
|
|
591
|
+
return data, status_code, headers
|
|
592
|
+
end
|
|
593
|
+
|
|
594
|
+
# Get free and paid backup counts
|
|
595
|
+
# Counts the backups of the current portal created within a period and splits the result into the ones covered by the free monthly allowance and the ones charged to the portal wallet, which saves calling `GET api/2.0/backup/getbackupscount` twice. The `paid` query parameter is accepted but not read here: the answer always carries both figures. The period behaves as it does for `GET api/2.0/backup/getbackupscount` - it defaults to the current calendar month, both bounds are UTC and inclusive, and a `from` later than `to` is rejected. The counts are over history records rather than over stored archives, so they include backups that have already been deleted.
|
|
596
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-backups-counts/
|
|
597
|
+
# @param [Hash] opts the optional parameters
|
|
598
|
+
# @option opts [Time] :from The start of the period, in UTC and inclusive. It defaults to the first day of the current calendar month at 00:00 UTC, and it has to be no later than `to`.
|
|
599
|
+
# @option opts [Time] :to The end of the period, in UTC and inclusive. It defaults to the moment of the call.
|
|
600
|
+
# @option opts [Boolean] :paid Counts the backups charged to the portal wallet when true, and the ones covered by the free monthly allowance when false, which is the default. It is read only by `GET api/2.0/backup/getbackupscount` and is ignored by `GET api/2.0/backup/getbackupscountbypaid`, which always reports both.
|
|
601
|
+
# @return [BackupsCountResultWrapper]
|
|
602
|
+
def get_backups_counts(opts = {})
|
|
603
|
+
data, _status_code, _headers = get_backups_counts_with_http_info(opts)
|
|
604
|
+
data
|
|
605
|
+
end
|
|
606
|
+
|
|
607
|
+
# Get free and paid backup counts
|
|
608
|
+
# Counts the backups of the current portal created within a period and splits the result into the ones covered by the free monthly allowance and the ones charged to the portal wallet, which saves calling `GET api/2.0/backup/getbackupscount` twice. The `paid` query parameter is accepted but not read here: the answer always carries both figures. The period behaves as it does for `GET api/2.0/backup/getbackupscount` - it defaults to the current calendar month, both bounds are UTC and inclusive, and a `from` later than `to` is rejected. The counts are over history records rather than over stored archives, so they include backups that have already been deleted.
|
|
609
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-backups-counts/
|
|
610
|
+
# @param [Hash] opts the optional parameters
|
|
611
|
+
# @option opts [Time] :from The start of the period, in UTC and inclusive. It defaults to the first day of the current calendar month at 00:00 UTC, and it has to be no later than `to`.
|
|
612
|
+
# @option opts [Time] :to The end of the period, in UTC and inclusive. It defaults to the moment of the call.
|
|
613
|
+
# @option opts [Boolean] :paid Counts the backups charged to the portal wallet when true, and the ones covered by the free monthly allowance when false, which is the default. It is read only by `GET api/2.0/backup/getbackupscount` and is ignored by `GET api/2.0/backup/getbackupscountbypaid`, which always reports both.
|
|
614
|
+
# @return [Array<(BackupsCountResultWrapper, Integer, Hash)>] BackupsCountResultWrapper data, response status code and response headers
|
|
615
|
+
def get_backups_counts_with_http_info(opts = {})
|
|
616
|
+
if @api_client.config.debugging
|
|
617
|
+
@api_client.config.logger.debug 'Calling API: Backup::BackupApi.get_backups_counts ...'
|
|
618
|
+
end
|
|
619
|
+
# resource path
|
|
620
|
+
local_var_path = '/api/2.0/backup/getbackupscountbypaid'
|
|
621
|
+
|
|
622
|
+
# query parameters
|
|
623
|
+
query_params = opts[:query_params] || {}
|
|
624
|
+
query_params[:'from'] = opts[:'from'] if !opts[:'from'].nil?
|
|
625
|
+
query_params[:'to'] = opts[:'to'] if !opts[:'to'].nil?
|
|
626
|
+
query_params[:'paid'] = opts[:'paid'] if !opts[:'paid'].nil?
|
|
627
|
+
|
|
628
|
+
# header parameters
|
|
629
|
+
header_params = opts[:header_params] || {}
|
|
630
|
+
# HTTP header 'Accept' (if needed)
|
|
631
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
632
|
+
|
|
633
|
+
# form parameters
|
|
634
|
+
form_params = opts[:form_params] || {}
|
|
635
|
+
|
|
636
|
+
# http body (model)
|
|
637
|
+
post_body = opts[:debug_body]
|
|
638
|
+
|
|
639
|
+
# return_type
|
|
640
|
+
return_type = opts[:debug_return_type] || 'BackupsCountResultWrapper'
|
|
641
|
+
|
|
642
|
+
# auth_names
|
|
643
|
+
auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
|
|
644
|
+
|
|
645
|
+
new_options = opts.merge(
|
|
646
|
+
:operation => :"Backup::BackupApi.get_backups_counts",
|
|
647
|
+
:header_params => header_params,
|
|
648
|
+
:query_params => query_params,
|
|
649
|
+
:form_params => form_params,
|
|
650
|
+
:body => post_body,
|
|
651
|
+
:auth_names => auth_names,
|
|
652
|
+
:return_type => return_type
|
|
653
|
+
)
|
|
654
|
+
|
|
655
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
656
|
+
if @api_client.config.debugging
|
|
657
|
+
@api_client.config.logger.debug "API called: Backup::BackupApi#get_backups_counts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
658
|
+
end
|
|
659
|
+
return data, status_code, headers
|
|
660
|
+
end
|
|
661
|
+
|
|
662
|
+
# Check whether backups are enabled
|
|
663
|
+
# Reports whether the paid backup service is switched on for the current portal. This is a wallet setting of the portal, not the health of the backup service or of the worker that runs the jobs, so a false answer does not mean backups are unavailable and a true one does not mean they are working. While it is on, backups beyond the free monthly allowance are charged to the portal wallet. While it is off and that allowance is used up, `POST api/2.0/backup/startbackup` and `POST api/2.0/backup/createbackupschedule` answer 402. Starting a backup once the allowance is used up switches the service on by itself, as soon as a billing session opens for the portal, so this flag can change without anybody editing the portal settings.
|
|
664
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-backups-service-state/
|
|
665
|
+
# @param [Hash] opts the optional parameters
|
|
666
|
+
# @return [BackupServiceStateWrapper]
|
|
667
|
+
def get_backups_service_state(opts = {})
|
|
668
|
+
data, _status_code, _headers = get_backups_service_state_with_http_info(opts)
|
|
669
|
+
data
|
|
670
|
+
end
|
|
671
|
+
|
|
672
|
+
# Check whether backups are enabled
|
|
673
|
+
# Reports whether the paid backup service is switched on for the current portal. This is a wallet setting of the portal, not the health of the backup service or of the worker that runs the jobs, so a false answer does not mean backups are unavailable and a true one does not mean they are working. While it is on, backups beyond the free monthly allowance are charged to the portal wallet. While it is off and that allowance is used up, `POST api/2.0/backup/startbackup` and `POST api/2.0/backup/createbackupschedule` answer 402. Starting a backup once the allowance is used up switches the service on by itself, as soon as a billing session opens for the portal, so this flag can change without anybody editing the portal settings.
|
|
674
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-backups-service-state/
|
|
675
|
+
# @param [Hash] opts the optional parameters
|
|
676
|
+
# @return [Array<(BackupServiceStateWrapper, Integer, Hash)>] BackupServiceStateWrapper data, response status code and response headers
|
|
677
|
+
def get_backups_service_state_with_http_info(opts = {})
|
|
678
|
+
if @api_client.config.debugging
|
|
679
|
+
@api_client.config.logger.debug 'Calling API: Backup::BackupApi.get_backups_service_state ...'
|
|
680
|
+
end
|
|
681
|
+
# resource path
|
|
682
|
+
local_var_path = '/api/2.0/backup/getservicestate'
|
|
683
|
+
|
|
684
|
+
# query parameters
|
|
685
|
+
query_params = opts[:query_params] || {}
|
|
686
|
+
|
|
687
|
+
# header parameters
|
|
688
|
+
header_params = opts[:header_params] || {}
|
|
689
|
+
# HTTP header 'Accept' (if needed)
|
|
690
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
691
|
+
|
|
692
|
+
# form parameters
|
|
693
|
+
form_params = opts[:form_params] || {}
|
|
694
|
+
|
|
695
|
+
# http body (model)
|
|
696
|
+
post_body = opts[:debug_body]
|
|
697
|
+
|
|
698
|
+
# return_type
|
|
699
|
+
return_type = opts[:debug_return_type] || 'BackupServiceStateWrapper'
|
|
700
|
+
|
|
701
|
+
# auth_names
|
|
702
|
+
auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
|
|
703
|
+
|
|
704
|
+
new_options = opts.merge(
|
|
705
|
+
:operation => :"Backup::BackupApi.get_backups_service_state",
|
|
706
|
+
:header_params => header_params,
|
|
707
|
+
:query_params => query_params,
|
|
708
|
+
:form_params => form_params,
|
|
709
|
+
:body => post_body,
|
|
710
|
+
:auth_names => auth_names,
|
|
711
|
+
:return_type => return_type
|
|
712
|
+
)
|
|
713
|
+
|
|
714
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
715
|
+
if @api_client.config.debugging
|
|
716
|
+
@api_client.config.logger.debug "API called: Backup::BackupApi#get_backups_service_state\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
717
|
+
end
|
|
718
|
+
return data, status_code, headers
|
|
719
|
+
end
|
|
720
|
+
|
|
721
|
+
# Get the restoring progress
|
|
722
|
+
# Reports the state of the restoring job, and is the operation to poll after `POST api/2.0/backup/startrestore`. It is the only operation of this service that needs no authorization and the only one that stays reachable while the portal is being restored, which is exactly the state a client polls it in - every other operation of the service answers 403 then. `dump` is read as three states rather than as a flag: omit it to get whichever restoring job concerns this portal, including a server-wide one, pass false to get the job of this portal only, and pass true to get the server-wide job; on a portal that is not a standalone installation the value is forced to false. When there is no matching job the call still answers 200, but the body carries no `response` member at all. `isCompleted` is the field to poll, a non-empty `error` is the only report of a failure, and neither `link` nor `warning` is ever filled in for a restoring job.
|
|
723
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-restore-progress/
|
|
724
|
+
# @param [Hash] opts the optional parameters
|
|
725
|
+
# @option opts [Boolean] :dump Which restoring job to look for, read as three states rather than as a flag: leave it out for whichever job concerns this portal, including a server-wide one, send false for the job of this portal alone, and send true for the server-wide job. On a portal that is not a standalone installation the value is forced to false.
|
|
726
|
+
# @return [BackupProgressWrapper]
|
|
727
|
+
def get_restore_progress(opts = {})
|
|
728
|
+
data, _status_code, _headers = get_restore_progress_with_http_info(opts)
|
|
729
|
+
data
|
|
730
|
+
end
|
|
731
|
+
|
|
732
|
+
# Get the restoring progress
|
|
733
|
+
# Reports the state of the restoring job, and is the operation to poll after `POST api/2.0/backup/startrestore`. It is the only operation of this service that needs no authorization and the only one that stays reachable while the portal is being restored, which is exactly the state a client polls it in - every other operation of the service answers 403 then. `dump` is read as three states rather than as a flag: omit it to get whichever restoring job concerns this portal, including a server-wide one, pass false to get the job of this portal only, and pass true to get the server-wide job; on a portal that is not a standalone installation the value is forced to false. When there is no matching job the call still answers 200, but the body carries no `response` member at all. `isCompleted` is the field to poll, a non-empty `error` is the only report of a failure, and neither `link` nor `warning` is ever filled in for a restoring job.
|
|
734
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-restore-progress/
|
|
735
|
+
# @param [Hash] opts the optional parameters
|
|
736
|
+
# @option opts [Boolean] :dump Which restoring job to look for, read as three states rather than as a flag: leave it out for whichever job concerns this portal, including a server-wide one, send false for the job of this portal alone, and send true for the server-wide job. On a portal that is not a standalone installation the value is forced to false.
|
|
737
|
+
# @return [Array<(BackupProgressWrapper, Integer, Hash)>] BackupProgressWrapper data, response status code and response headers
|
|
738
|
+
def get_restore_progress_with_http_info(opts = {})
|
|
739
|
+
if @api_client.config.debugging
|
|
740
|
+
@api_client.config.logger.debug 'Calling API: Backup::BackupApi.get_restore_progress ...'
|
|
741
|
+
end
|
|
742
|
+
# resource path
|
|
743
|
+
local_var_path = '/api/2.0/backup/getrestoreprogress'
|
|
744
|
+
|
|
745
|
+
# query parameters
|
|
746
|
+
query_params = opts[:query_params] || {}
|
|
747
|
+
query_params[:'dump'] = opts[:'dump'] if !opts[:'dump'].nil?
|
|
748
|
+
|
|
749
|
+
# header parameters
|
|
750
|
+
header_params = opts[:header_params] || {}
|
|
751
|
+
# HTTP header 'Accept' (if needed)
|
|
752
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
753
|
+
|
|
754
|
+
# form parameters
|
|
755
|
+
form_params = opts[:form_params] || {}
|
|
756
|
+
|
|
757
|
+
# http body (model)
|
|
758
|
+
post_body = opts[:debug_body]
|
|
759
|
+
|
|
760
|
+
# return_type
|
|
761
|
+
return_type = opts[:debug_return_type] || 'BackupProgressWrapper'
|
|
762
|
+
|
|
763
|
+
# auth_names
|
|
764
|
+
auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
|
|
765
|
+
|
|
766
|
+
new_options = opts.merge(
|
|
767
|
+
:operation => :"Backup::BackupApi.get_restore_progress",
|
|
768
|
+
:header_params => header_params,
|
|
769
|
+
:query_params => query_params,
|
|
770
|
+
:form_params => form_params,
|
|
771
|
+
:body => post_body,
|
|
772
|
+
:auth_names => auth_names,
|
|
773
|
+
:return_type => return_type
|
|
774
|
+
)
|
|
775
|
+
|
|
776
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
777
|
+
if @api_client.config.debugging
|
|
778
|
+
@api_client.config.logger.debug "API called: Backup::BackupApi#get_restore_progress\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
779
|
+
end
|
|
780
|
+
return data, status_code, headers
|
|
781
|
+
end
|
|
782
|
+
|
|
783
|
+
# Start the backup
|
|
784
|
+
# Queues a backup of the current portal and returns straight away: the archive itself is written by the separate backup worker service, which picks the job up from an integration event, so the response reports a progress of 0 and the `Created` status, and its `taskId` is the handle to poll with `GET api/2.0/backup/getbackupprogress`. The caller needs the portal settings permission, and `dump` - a backup of the whole server instead of this one portal - additionally requires the space access permission and is rejected outside a standalone installation. The keys expected in `storageParams` depend on `storageType`: `Documents` takes an integer `folderId`, `ThridpartyDocuments` takes a provider-specific non-integer `folderId`, `Local` takes `filePath` and works on a standalone installation only, `ThirdPartyConsumer` takes `module` together with the settings of that consumer, and `DataStore` takes no keys at all; the `subdir` key is added by the operation itself and must not be sent. A portal that has already used up the free backups of the current calendar month is charged through the paid backup service instead, and the call is rejected with 402 when that service is not available to it.
|
|
785
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/start-backup/
|
|
786
|
+
# @param [Hash] opts the optional parameters
|
|
787
|
+
# @option opts [StartBackupRequestDto] :start_backup_request_dto
|
|
788
|
+
# @return [BackupProgressWrapper]
|
|
789
|
+
def start_backup(opts = {})
|
|
790
|
+
data, _status_code, _headers = start_backup_with_http_info(opts)
|
|
791
|
+
data
|
|
792
|
+
end
|
|
793
|
+
|
|
794
|
+
# Start the backup
|
|
795
|
+
# Queues a backup of the current portal and returns straight away: the archive itself is written by the separate backup worker service, which picks the job up from an integration event, so the response reports a progress of 0 and the `Created` status, and its `taskId` is the handle to poll with `GET api/2.0/backup/getbackupprogress`. The caller needs the portal settings permission, and `dump` - a backup of the whole server instead of this one portal - additionally requires the space access permission and is rejected outside a standalone installation. The keys expected in `storageParams` depend on `storageType`: `Documents` takes an integer `folderId`, `ThridpartyDocuments` takes a provider-specific non-integer `folderId`, `Local` takes `filePath` and works on a standalone installation only, `ThirdPartyConsumer` takes `module` together with the settings of that consumer, and `DataStore` takes no keys at all; the `subdir` key is added by the operation itself and must not be sent. A portal that has already used up the free backups of the current calendar month is charged through the paid backup service instead, and the call is rejected with 402 when that service is not available to it.
|
|
796
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/start-backup/
|
|
797
|
+
# @param [Hash] opts the optional parameters
|
|
798
|
+
# @option opts [StartBackupRequestDto] :start_backup_request_dto
|
|
799
|
+
# @return [Array<(BackupProgressWrapper, Integer, Hash)>] BackupProgressWrapper data, response status code and response headers
|
|
800
|
+
def start_backup_with_http_info(opts = {})
|
|
801
|
+
if @api_client.config.debugging
|
|
802
|
+
@api_client.config.logger.debug 'Calling API: Backup::BackupApi.start_backup ...'
|
|
803
|
+
end
|
|
804
|
+
# resource path
|
|
805
|
+
local_var_path = '/api/2.0/backup/startbackup'
|
|
806
|
+
|
|
807
|
+
# query parameters
|
|
808
|
+
query_params = opts[:query_params] || {}
|
|
809
|
+
|
|
810
|
+
# header parameters
|
|
811
|
+
header_params = opts[:header_params] || {}
|
|
812
|
+
# HTTP header 'Accept' (if needed)
|
|
813
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
814
|
+
# HTTP header 'Content-Type'
|
|
815
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
816
|
+
if !content_type.nil?
|
|
817
|
+
header_params['Content-Type'] = content_type
|
|
818
|
+
end
|
|
819
|
+
|
|
820
|
+
# form parameters
|
|
821
|
+
form_params = opts[:form_params] || {}
|
|
822
|
+
|
|
823
|
+
# http body (model)
|
|
824
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'start_backup_request_dto'])
|
|
825
|
+
|
|
826
|
+
# return_type
|
|
827
|
+
return_type = opts[:debug_return_type] || 'BackupProgressWrapper'
|
|
828
|
+
|
|
829
|
+
# auth_names
|
|
830
|
+
auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
|
|
831
|
+
|
|
832
|
+
new_options = opts.merge(
|
|
833
|
+
:operation => :"Backup::BackupApi.start_backup",
|
|
834
|
+
:header_params => header_params,
|
|
835
|
+
:query_params => query_params,
|
|
836
|
+
:form_params => form_params,
|
|
837
|
+
:body => post_body,
|
|
838
|
+
:auth_names => auth_names,
|
|
839
|
+
:return_type => return_type
|
|
840
|
+
)
|
|
841
|
+
|
|
842
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
843
|
+
if @api_client.config.debugging
|
|
844
|
+
@api_client.config.logger.debug "API called: Backup::BackupApi#start_backup\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
845
|
+
end
|
|
846
|
+
return data, status_code, headers
|
|
847
|
+
end
|
|
848
|
+
|
|
849
|
+
# Start the restoring process
|
|
850
|
+
# Queues the restoring of the current portal from a backup and returns straight away: the work itself is done by the separate backup worker service, which picks the job up from an integration event, so the response reports a progress of 0 and the `Created` status, and the returned `taskId` is the handle to poll with `GET api/2.0/backup/getrestoreprogress` - the one operation of this service that stays reachable while the portal is being restored, because every other one answers 403 in that state. The source is given either by `backupId`, which is the ID of a record from `GET api/2.0/backup/getbackuphistory`, or, when `backupId` is not a GUID, by the `filePath` key of `storageParams` together with the matching `storageType`; an all-zero GUID is parsed as a GUID and therefore reaches neither branch. The caller needs the portal settings permission, restoring has to be allowed by the pricing plan of a portal that is not a standalone installation, and `dump` - restoring the whole server rather than this one portal - additionally requires the space access permission.
|
|
851
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/start-backup-restore/
|
|
852
|
+
# @param [Hash] opts the optional parameters
|
|
853
|
+
# @option opts [StartBackupRestoreRequestDto] :start_backup_restore_request_dto
|
|
854
|
+
# @return [BackupProgressWrapper]
|
|
855
|
+
def start_backup_restore(opts = {})
|
|
856
|
+
data, _status_code, _headers = start_backup_restore_with_http_info(opts)
|
|
857
|
+
data
|
|
858
|
+
end
|
|
859
|
+
|
|
860
|
+
# Start the restoring process
|
|
861
|
+
# Queues the restoring of the current portal from a backup and returns straight away: the work itself is done by the separate backup worker service, which picks the job up from an integration event, so the response reports a progress of 0 and the `Created` status, and the returned `taskId` is the handle to poll with `GET api/2.0/backup/getrestoreprogress` - the one operation of this service that stays reachable while the portal is being restored, because every other one answers 403 in that state. The source is given either by `backupId`, which is the ID of a record from `GET api/2.0/backup/getbackuphistory`, or, when `backupId` is not a GUID, by the `filePath` key of `storageParams` together with the matching `storageType`; an all-zero GUID is parsed as a GUID and therefore reaches neither branch. The caller needs the portal settings permission, restoring has to be allowed by the pricing plan of a portal that is not a standalone installation, and `dump` - restoring the whole server rather than this one portal - additionally requires the space access permission.
|
|
862
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/start-backup-restore/
|
|
863
|
+
# @param [Hash] opts the optional parameters
|
|
864
|
+
# @option opts [StartBackupRestoreRequestDto] :start_backup_restore_request_dto
|
|
865
|
+
# @return [Array<(BackupProgressWrapper, Integer, Hash)>] BackupProgressWrapper data, response status code and response headers
|
|
866
|
+
def start_backup_restore_with_http_info(opts = {})
|
|
867
|
+
if @api_client.config.debugging
|
|
868
|
+
@api_client.config.logger.debug 'Calling API: Backup::BackupApi.start_backup_restore ...'
|
|
869
|
+
end
|
|
870
|
+
# resource path
|
|
871
|
+
local_var_path = '/api/2.0/backup/startrestore'
|
|
872
|
+
|
|
873
|
+
# query parameters
|
|
874
|
+
query_params = opts[:query_params] || {}
|
|
875
|
+
|
|
876
|
+
# header parameters
|
|
877
|
+
header_params = opts[:header_params] || {}
|
|
878
|
+
# HTTP header 'Accept' (if needed)
|
|
879
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
880
|
+
# HTTP header 'Content-Type'
|
|
881
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
882
|
+
if !content_type.nil?
|
|
883
|
+
header_params['Content-Type'] = content_type
|
|
884
|
+
end
|
|
885
|
+
|
|
886
|
+
# form parameters
|
|
887
|
+
form_params = opts[:form_params] || {}
|
|
888
|
+
|
|
889
|
+
# http body (model)
|
|
890
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'start_backup_restore_request_dto'])
|
|
891
|
+
|
|
892
|
+
# return_type
|
|
893
|
+
return_type = opts[:debug_return_type] || 'BackupProgressWrapper'
|
|
894
|
+
|
|
895
|
+
# auth_names
|
|
896
|
+
auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
|
|
897
|
+
|
|
898
|
+
new_options = opts.merge(
|
|
899
|
+
:operation => :"Backup::BackupApi.start_backup_restore",
|
|
900
|
+
:header_params => header_params,
|
|
901
|
+
:query_params => query_params,
|
|
902
|
+
:form_params => form_params,
|
|
903
|
+
:body => post_body,
|
|
904
|
+
:auth_names => auth_names,
|
|
905
|
+
:return_type => return_type
|
|
906
|
+
)
|
|
907
|
+
|
|
908
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
909
|
+
if @api_client.config.debugging
|
|
910
|
+
@api_client.config.logger.debug "API called: Backup::BackupApi#start_backup_restore\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
911
|
+
end
|
|
912
|
+
return data, status_code, headers
|
|
913
|
+
end
|
|
914
|
+
end
|
|
915
|
+
end
|
|
916
|
+
end
|