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,1398 @@
|
|
|
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 Settings
|
|
20
|
+
class CommonSettingsApi
|
|
21
|
+
attr_accessor :api_client
|
|
22
|
+
|
|
23
|
+
def initialize(api_client = ApiClient.default)
|
|
24
|
+
@api_client = api_client
|
|
25
|
+
end
|
|
26
|
+
# Close the admin helper
|
|
27
|
+
# Dismisses the administrator helper tip for the caller, so it is not shown again on this account. Available only to a DocSpace administrator, which includes the portal Owner, on a Standalone (self-hosted) installation running outside white-label custom mode; every other caller is refused. This is a mutating, idempotent call scoped to the calling account only; it never affects other administrators. It returns no data on success.
|
|
28
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/close-admin-helper/
|
|
29
|
+
# @param [Hash] opts the optional parameters
|
|
30
|
+
# @return [nil]
|
|
31
|
+
def close_admin_helper(opts = {})
|
|
32
|
+
close_admin_helper_with_http_info(opts)
|
|
33
|
+
nil
|
|
34
|
+
end
|
|
35
|
+
|
|
36
|
+
# Close the admin helper
|
|
37
|
+
# Dismisses the administrator helper tip for the caller, so it is not shown again on this account. Available only to a DocSpace administrator, which includes the portal Owner, on a Standalone (self-hosted) installation running outside white-label custom mode; every other caller is refused. This is a mutating, idempotent call scoped to the calling account only; it never affects other administrators. It returns no data on success.
|
|
38
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/close-admin-helper/
|
|
39
|
+
# @param [Hash] opts the optional parameters
|
|
40
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
41
|
+
def close_admin_helper_with_http_info(opts = {})
|
|
42
|
+
if @api_client.config.debugging
|
|
43
|
+
@api_client.config.logger.debug 'Calling API: Settings::CommonSettingsApi.close_admin_helper ...'
|
|
44
|
+
end
|
|
45
|
+
# resource path
|
|
46
|
+
local_var_path = '/api/2.0/settings/closeadminhelper'
|
|
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]
|
|
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 => :"Settings::CommonSettingsApi.close_admin_helper",
|
|
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(:PUT, local_var_path, new_options)
|
|
79
|
+
if @api_client.config.debugging
|
|
80
|
+
@api_client.config.logger.debug "API called: Settings::CommonSettingsApi#close_admin_helper\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
81
|
+
end
|
|
82
|
+
return data, status_code, headers
|
|
83
|
+
end
|
|
84
|
+
|
|
85
|
+
# Complete the Wizard settings
|
|
86
|
+
# Finishes the initial portal setup wizard: sets the owner's password and locale, applies the supplied license if one is required, and marks the wizard as completed so it is not shown again. This call is not for a normal logged-in session: it requires a confirmation link bearing the Wizard claim, of the kind issued when a new portal is created, and the link is consumed as part of authenticating the request; the caller must also hold the EditPortalSettings permission. An empty password or a malformed email address is rejected without completing the wizard, and so is a missing, invalid, or expired license, or a license whose user quota does not cover the portal. This call is meant to run once per portal; running it again is accepted but has no further effect once the wizard is already completed. It returns the resulting wizard settings, including the completed flag.
|
|
87
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/complete-wizard/
|
|
88
|
+
# @param [Hash] opts the optional parameters
|
|
89
|
+
# @option opts [WizardRequestDto] :wizard_request_dto
|
|
90
|
+
# @return [WizardSettingsWrapper]
|
|
91
|
+
def complete_wizard(opts = {})
|
|
92
|
+
data, _status_code, _headers = complete_wizard_with_http_info(opts)
|
|
93
|
+
data
|
|
94
|
+
end
|
|
95
|
+
|
|
96
|
+
# Complete the Wizard settings
|
|
97
|
+
# Finishes the initial portal setup wizard: sets the owner's password and locale, applies the supplied license if one is required, and marks the wizard as completed so it is not shown again. This call is not for a normal logged-in session: it requires a confirmation link bearing the Wizard claim, of the kind issued when a new portal is created, and the link is consumed as part of authenticating the request; the caller must also hold the EditPortalSettings permission. An empty password or a malformed email address is rejected without completing the wizard, and so is a missing, invalid, or expired license, or a license whose user quota does not cover the portal. This call is meant to run once per portal; running it again is accepted but has no further effect once the wizard is already completed. It returns the resulting wizard settings, including the completed flag.
|
|
98
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/complete-wizard/
|
|
99
|
+
# @param [Hash] opts the optional parameters
|
|
100
|
+
# @option opts [WizardRequestDto] :wizard_request_dto
|
|
101
|
+
# @return [Array<(WizardSettingsWrapper, Integer, Hash)>] WizardSettingsWrapper data, response status code and response headers
|
|
102
|
+
def complete_wizard_with_http_info(opts = {})
|
|
103
|
+
if @api_client.config.debugging
|
|
104
|
+
@api_client.config.logger.debug 'Calling API: Settings::CommonSettingsApi.complete_wizard ...'
|
|
105
|
+
end
|
|
106
|
+
# resource path
|
|
107
|
+
local_var_path = '/api/2.0/settings/wizard/complete'
|
|
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[:'wizard_request_dto'])
|
|
127
|
+
|
|
128
|
+
# return_type
|
|
129
|
+
return_type = opts[:debug_return_type] || 'WizardSettingsWrapper'
|
|
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 => :"Settings::CommonSettingsApi.complete_wizard",
|
|
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(:PUT, local_var_path, new_options)
|
|
145
|
+
if @api_client.config.debugging
|
|
146
|
+
@api_client.config.logger.debug "API called: Settings::CommonSettingsApi#complete_wizard\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
147
|
+
end
|
|
148
|
+
return data, status_code, headers
|
|
149
|
+
end
|
|
150
|
+
|
|
151
|
+
# Configure the deep link settings
|
|
152
|
+
# Sets how the portal responds when a client opens a DocSpace link on a mobile device: always in the browser, always in the native app, or asking the user to choose each time. Requires Owner or DocSpaceAdmin (the EditPortalSettings permission). The handling mode must be one of the documented enum values; anything else is rejected without being saved. This is a mutating, idempotent call: sending the same mode again leaves the setting unchanged. It returns the saved deep link settings, including the timestamp of the last change; read the current value at any time, including anonymously, from `GET api/2.0/settings/deeplink`.
|
|
153
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/configure-deep-link/
|
|
154
|
+
# @param [Hash] opts the optional parameters
|
|
155
|
+
# @option opts [DeepLinkConfigurationRequestDto] :deep_link_configuration_request_dto
|
|
156
|
+
# @return [TenantDeepLinkSettingsWrapper]
|
|
157
|
+
def configure_deep_link(opts = {})
|
|
158
|
+
data, _status_code, _headers = configure_deep_link_with_http_info(opts)
|
|
159
|
+
data
|
|
160
|
+
end
|
|
161
|
+
|
|
162
|
+
# Configure the deep link settings
|
|
163
|
+
# Sets how the portal responds when a client opens a DocSpace link on a mobile device: always in the browser, always in the native app, or asking the user to choose each time. Requires Owner or DocSpaceAdmin (the EditPortalSettings permission). The handling mode must be one of the documented enum values; anything else is rejected without being saved. This is a mutating, idempotent call: sending the same mode again leaves the setting unchanged. It returns the saved deep link settings, including the timestamp of the last change; read the current value at any time, including anonymously, from `GET api/2.0/settings/deeplink`.
|
|
164
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/configure-deep-link/
|
|
165
|
+
# @param [Hash] opts the optional parameters
|
|
166
|
+
# @option opts [DeepLinkConfigurationRequestDto] :deep_link_configuration_request_dto
|
|
167
|
+
# @return [Array<(TenantDeepLinkSettingsWrapper, Integer, Hash)>] TenantDeepLinkSettingsWrapper data, response status code and response headers
|
|
168
|
+
def configure_deep_link_with_http_info(opts = {})
|
|
169
|
+
if @api_client.config.debugging
|
|
170
|
+
@api_client.config.logger.debug 'Calling API: Settings::CommonSettingsApi.configure_deep_link ...'
|
|
171
|
+
end
|
|
172
|
+
# resource path
|
|
173
|
+
local_var_path = '/api/2.0/settings/deeplink'
|
|
174
|
+
|
|
175
|
+
# query parameters
|
|
176
|
+
query_params = opts[:query_params] || {}
|
|
177
|
+
|
|
178
|
+
# header parameters
|
|
179
|
+
header_params = opts[:header_params] || {}
|
|
180
|
+
# HTTP header 'Accept' (if needed)
|
|
181
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
182
|
+
# HTTP header 'Content-Type'
|
|
183
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
184
|
+
if !content_type.nil?
|
|
185
|
+
header_params['Content-Type'] = content_type
|
|
186
|
+
end
|
|
187
|
+
|
|
188
|
+
# form parameters
|
|
189
|
+
form_params = opts[:form_params] || {}
|
|
190
|
+
|
|
191
|
+
# http body (model)
|
|
192
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'deep_link_configuration_request_dto'])
|
|
193
|
+
|
|
194
|
+
# return_type
|
|
195
|
+
return_type = opts[:debug_return_type] || 'TenantDeepLinkSettingsWrapper'
|
|
196
|
+
|
|
197
|
+
# auth_names
|
|
198
|
+
auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
|
|
199
|
+
|
|
200
|
+
new_options = opts.merge(
|
|
201
|
+
:operation => :"Settings::CommonSettingsApi.configure_deep_link",
|
|
202
|
+
:header_params => header_params,
|
|
203
|
+
:query_params => query_params,
|
|
204
|
+
:form_params => form_params,
|
|
205
|
+
:body => post_body,
|
|
206
|
+
:auth_names => auth_names,
|
|
207
|
+
:return_type => return_type
|
|
208
|
+
)
|
|
209
|
+
|
|
210
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
211
|
+
if @api_client.config.debugging
|
|
212
|
+
@api_client.config.logger.debug "API called: Settings::CommonSettingsApi#configure_deep_link\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
213
|
+
end
|
|
214
|
+
return data, status_code, headers
|
|
215
|
+
end
|
|
216
|
+
|
|
217
|
+
# Delete a color theme
|
|
218
|
+
# Removes a custom color theme from the portal by its ID. Requires Owner or DocSpaceAdmin (the EditPortalSettings permission). An ID belonging to one of the built-in default themes is not removable; the call succeeds but leaves the theme list unchanged. If the deleted theme was the currently selected one, the theme with the lowest remaining ID is selected automatically. This is a mutating, idempotent call: deleting an ID that is already gone succeeds without error and again leaves nothing changed. It returns the full updated theme configuration, including the (possibly new) selected theme.
|
|
219
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/delete-portal-color-theme/
|
|
220
|
+
# @param id [Integer] The theme to remove, by theme ID. An ID belonging to a built-in theme leaves the list untouched, and so does one that is already gone - neither is reported as an error. Removing the theme currently in use moves the portal to the remaining theme with the lowest ID.
|
|
221
|
+
# @param [Hash] opts the optional parameters
|
|
222
|
+
# @return [CustomColorThemesSettingsWrapper]
|
|
223
|
+
def delete_portal_color_theme(id, opts = {})
|
|
224
|
+
data, _status_code, _headers = delete_portal_color_theme_with_http_info(id, opts)
|
|
225
|
+
data
|
|
226
|
+
end
|
|
227
|
+
|
|
228
|
+
# Delete a color theme
|
|
229
|
+
# Removes a custom color theme from the portal by its ID. Requires Owner or DocSpaceAdmin (the EditPortalSettings permission). An ID belonging to one of the built-in default themes is not removable; the call succeeds but leaves the theme list unchanged. If the deleted theme was the currently selected one, the theme with the lowest remaining ID is selected automatically. This is a mutating, idempotent call: deleting an ID that is already gone succeeds without error and again leaves nothing changed. It returns the full updated theme configuration, including the (possibly new) selected theme.
|
|
230
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/delete-portal-color-theme/
|
|
231
|
+
# @param id [Integer] The theme to remove, by theme ID. An ID belonging to a built-in theme leaves the list untouched, and so does one that is already gone - neither is reported as an error. Removing the theme currently in use moves the portal to the remaining theme with the lowest ID.
|
|
232
|
+
# @param [Hash] opts the optional parameters
|
|
233
|
+
# @return [Array<(CustomColorThemesSettingsWrapper, Integer, Hash)>] CustomColorThemesSettingsWrapper data, response status code and response headers
|
|
234
|
+
def delete_portal_color_theme_with_http_info(id, opts = {})
|
|
235
|
+
if @api_client.config.debugging
|
|
236
|
+
@api_client.config.logger.debug 'Calling API: Settings::CommonSettingsApi.delete_portal_color_theme ...'
|
|
237
|
+
end
|
|
238
|
+
# verify the required parameter 'id' is set
|
|
239
|
+
if @api_client.config.client_side_validation && id.nil?
|
|
240
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling Settings::CommonSettingsApi.delete_portal_color_theme"
|
|
241
|
+
end
|
|
242
|
+
# resource path
|
|
243
|
+
local_var_path = '/api/2.0/settings/colortheme'
|
|
244
|
+
|
|
245
|
+
# query parameters
|
|
246
|
+
query_params = opts[:query_params] || {}
|
|
247
|
+
query_params[:'id'] = id
|
|
248
|
+
|
|
249
|
+
# header parameters
|
|
250
|
+
header_params = opts[:header_params] || {}
|
|
251
|
+
# HTTP header 'Accept' (if needed)
|
|
252
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
253
|
+
|
|
254
|
+
# form parameters
|
|
255
|
+
form_params = opts[:form_params] || {}
|
|
256
|
+
|
|
257
|
+
# http body (model)
|
|
258
|
+
post_body = opts[:debug_body]
|
|
259
|
+
|
|
260
|
+
# return_type
|
|
261
|
+
return_type = opts[:debug_return_type] || 'CustomColorThemesSettingsWrapper'
|
|
262
|
+
|
|
263
|
+
# auth_names
|
|
264
|
+
auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
|
|
265
|
+
|
|
266
|
+
new_options = opts.merge(
|
|
267
|
+
:operation => :"Settings::CommonSettingsApi.delete_portal_color_theme",
|
|
268
|
+
:header_params => header_params,
|
|
269
|
+
:query_params => query_params,
|
|
270
|
+
:form_params => form_params,
|
|
271
|
+
:body => post_body,
|
|
272
|
+
:auth_names => auth_names,
|
|
273
|
+
:return_type => return_type
|
|
274
|
+
)
|
|
275
|
+
|
|
276
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
|
|
277
|
+
if @api_client.config.debugging
|
|
278
|
+
@api_client.config.logger.debug "API called: Settings::CommonSettingsApi#delete_portal_color_theme\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
279
|
+
end
|
|
280
|
+
return data, status_code, headers
|
|
281
|
+
end
|
|
282
|
+
|
|
283
|
+
# Get the deep link settings
|
|
284
|
+
# Returns how the portal currently responds when a client opens a DocSpace link on a mobile device: always in the browser, always in the native app, or asking the user to choose. No permission is required; anonymous callers can read it too. This is a read-only, idempotent call. The response supports conditional requests: send the standard If-Modified-Since header with the previous `lastModified` value, and an unchanged response comes back empty instead of resending the settings. Change the mode with `POST api/2.0/settings/deeplink`, which requires the EditPortalSettings permission.
|
|
285
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-deep-link-settings/
|
|
286
|
+
# @param [Hash] opts the optional parameters
|
|
287
|
+
# @return [TenantDeepLinkSettingsWrapper]
|
|
288
|
+
def get_deep_link_settings(opts = {})
|
|
289
|
+
data, _status_code, _headers = get_deep_link_settings_with_http_info(opts)
|
|
290
|
+
data
|
|
291
|
+
end
|
|
292
|
+
|
|
293
|
+
# Get the deep link settings
|
|
294
|
+
# Returns how the portal currently responds when a client opens a DocSpace link on a mobile device: always in the browser, always in the native app, or asking the user to choose. No permission is required; anonymous callers can read it too. This is a read-only, idempotent call. The response supports conditional requests: send the standard If-Modified-Since header with the previous `lastModified` value, and an unchanged response comes back empty instead of resending the settings. Change the mode with `POST api/2.0/settings/deeplink`, which requires the EditPortalSettings permission.
|
|
295
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-deep-link-settings/
|
|
296
|
+
# @param [Hash] opts the optional parameters
|
|
297
|
+
# @return [Array<(TenantDeepLinkSettingsWrapper, Integer, Hash)>] TenantDeepLinkSettingsWrapper data, response status code and response headers
|
|
298
|
+
def get_deep_link_settings_with_http_info(opts = {})
|
|
299
|
+
if @api_client.config.debugging
|
|
300
|
+
@api_client.config.logger.debug 'Calling API: Settings::CommonSettingsApi.get_deep_link_settings ...'
|
|
301
|
+
end
|
|
302
|
+
# resource path
|
|
303
|
+
local_var_path = '/api/2.0/settings/deeplink'
|
|
304
|
+
|
|
305
|
+
# query parameters
|
|
306
|
+
query_params = opts[:query_params] || {}
|
|
307
|
+
|
|
308
|
+
# header parameters
|
|
309
|
+
header_params = opts[:header_params] || {}
|
|
310
|
+
# HTTP header 'Accept' (if needed)
|
|
311
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
312
|
+
|
|
313
|
+
# form parameters
|
|
314
|
+
form_params = opts[:form_params] || {}
|
|
315
|
+
|
|
316
|
+
# http body (model)
|
|
317
|
+
post_body = opts[:debug_body]
|
|
318
|
+
|
|
319
|
+
# return_type
|
|
320
|
+
return_type = opts[:debug_return_type] || 'TenantDeepLinkSettingsWrapper'
|
|
321
|
+
|
|
322
|
+
# auth_names
|
|
323
|
+
auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
|
|
324
|
+
|
|
325
|
+
new_options = opts.merge(
|
|
326
|
+
:operation => :"Settings::CommonSettingsApi.get_deep_link_settings",
|
|
327
|
+
:header_params => header_params,
|
|
328
|
+
:query_params => query_params,
|
|
329
|
+
:form_params => form_params,
|
|
330
|
+
:body => post_body,
|
|
331
|
+
:auth_names => auth_names,
|
|
332
|
+
:return_type => return_type
|
|
333
|
+
)
|
|
334
|
+
|
|
335
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
336
|
+
if @api_client.config.debugging
|
|
337
|
+
@api_client.config.logger.debug "API called: Settings::CommonSettingsApi#get_deep_link_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
338
|
+
end
|
|
339
|
+
return data, status_code, headers
|
|
340
|
+
end
|
|
341
|
+
|
|
342
|
+
# Get the payment settings
|
|
343
|
+
# Returns the portal's payment-related configuration: the sales contact email, the URL to buy or extend a subscription, whether the portal is Standalone, the current license's trial status and expiration date, and the maximum quota quantity that can be purchased at once. Requires Owner or DocSpaceAdmin (the EditPortalSettings permission). This is a read-only, idempotent call. It remains reachable even while the portal's own subscription payment is overdue, since this is how the caller finds the link to resolve it.
|
|
344
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-payment-settings/
|
|
345
|
+
# @param [Hash] opts the optional parameters
|
|
346
|
+
# @return [PaymentSettingsWrapper]
|
|
347
|
+
def get_payment_settings(opts = {})
|
|
348
|
+
data, _status_code, _headers = get_payment_settings_with_http_info(opts)
|
|
349
|
+
data
|
|
350
|
+
end
|
|
351
|
+
|
|
352
|
+
# Get the payment settings
|
|
353
|
+
# Returns the portal's payment-related configuration: the sales contact email, the URL to buy or extend a subscription, whether the portal is Standalone, the current license's trial status and expiration date, and the maximum quota quantity that can be purchased at once. Requires Owner or DocSpaceAdmin (the EditPortalSettings permission). This is a read-only, idempotent call. It remains reachable even while the portal's own subscription payment is overdue, since this is how the caller finds the link to resolve it.
|
|
354
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-payment-settings/
|
|
355
|
+
# @param [Hash] opts the optional parameters
|
|
356
|
+
# @return [Array<(PaymentSettingsWrapper, Integer, Hash)>] PaymentSettingsWrapper data, response status code and response headers
|
|
357
|
+
def get_payment_settings_with_http_info(opts = {})
|
|
358
|
+
if @api_client.config.debugging
|
|
359
|
+
@api_client.config.logger.debug 'Calling API: Settings::CommonSettingsApi.get_payment_settings ...'
|
|
360
|
+
end
|
|
361
|
+
# resource path
|
|
362
|
+
local_var_path = '/api/2.0/settings/payment'
|
|
363
|
+
|
|
364
|
+
# query parameters
|
|
365
|
+
query_params = opts[:query_params] || {}
|
|
366
|
+
|
|
367
|
+
# header parameters
|
|
368
|
+
header_params = opts[:header_params] || {}
|
|
369
|
+
# HTTP header 'Accept' (if needed)
|
|
370
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
371
|
+
|
|
372
|
+
# form parameters
|
|
373
|
+
form_params = opts[:form_params] || {}
|
|
374
|
+
|
|
375
|
+
# http body (model)
|
|
376
|
+
post_body = opts[:debug_body]
|
|
377
|
+
|
|
378
|
+
# return_type
|
|
379
|
+
return_type = opts[:debug_return_type] || 'PaymentSettingsWrapper'
|
|
380
|
+
|
|
381
|
+
# auth_names
|
|
382
|
+
auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
|
|
383
|
+
|
|
384
|
+
new_options = opts.merge(
|
|
385
|
+
:operation => :"Settings::CommonSettingsApi.get_payment_settings",
|
|
386
|
+
:header_params => header_params,
|
|
387
|
+
:query_params => query_params,
|
|
388
|
+
:form_params => form_params,
|
|
389
|
+
:body => post_body,
|
|
390
|
+
:auth_names => auth_names,
|
|
391
|
+
:return_type => return_type
|
|
392
|
+
)
|
|
393
|
+
|
|
394
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
395
|
+
if @api_client.config.debugging
|
|
396
|
+
@api_client.config.logger.debug "API called: Settings::CommonSettingsApi#get_payment_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
397
|
+
end
|
|
398
|
+
return data, status_code, headers
|
|
399
|
+
end
|
|
400
|
+
|
|
401
|
+
# Get a color theme
|
|
402
|
+
# Returns the portal's color theme configuration: every saved custom theme, which one is currently selected, and how many custom themes the plan still allows. No permission is required; anonymous callers can read it too. This is a read-only, idempotent call. The response supports conditional requests: send the standard If-Modified-Since header with the previous `lastModified` value, and an unchanged response comes back empty instead of resending the same settings. A `limit` of `0` means the plan does not cap the number of custom themes.
|
|
403
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-portal-color-theme/
|
|
404
|
+
# @param [Hash] opts the optional parameters
|
|
405
|
+
# @return [CustomColorThemesSettingsWrapper]
|
|
406
|
+
def get_portal_color_theme(opts = {})
|
|
407
|
+
data, _status_code, _headers = get_portal_color_theme_with_http_info(opts)
|
|
408
|
+
data
|
|
409
|
+
end
|
|
410
|
+
|
|
411
|
+
# Get a color theme
|
|
412
|
+
# Returns the portal's color theme configuration: every saved custom theme, which one is currently selected, and how many custom themes the plan still allows. No permission is required; anonymous callers can read it too. This is a read-only, idempotent call. The response supports conditional requests: send the standard If-Modified-Since header with the previous `lastModified` value, and an unchanged response comes back empty instead of resending the same settings. A `limit` of `0` means the plan does not cap the number of custom themes.
|
|
413
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-portal-color-theme/
|
|
414
|
+
# @param [Hash] opts the optional parameters
|
|
415
|
+
# @return [Array<(CustomColorThemesSettingsWrapper, Integer, Hash)>] CustomColorThemesSettingsWrapper data, response status code and response headers
|
|
416
|
+
def get_portal_color_theme_with_http_info(opts = {})
|
|
417
|
+
if @api_client.config.debugging
|
|
418
|
+
@api_client.config.logger.debug 'Calling API: Settings::CommonSettingsApi.get_portal_color_theme ...'
|
|
419
|
+
end
|
|
420
|
+
# resource path
|
|
421
|
+
local_var_path = '/api/2.0/settings/colortheme'
|
|
422
|
+
|
|
423
|
+
# query parameters
|
|
424
|
+
query_params = opts[:query_params] || {}
|
|
425
|
+
|
|
426
|
+
# header parameters
|
|
427
|
+
header_params = opts[:header_params] || {}
|
|
428
|
+
# HTTP header 'Accept' (if needed)
|
|
429
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
430
|
+
|
|
431
|
+
# form parameters
|
|
432
|
+
form_params = opts[:form_params] || {}
|
|
433
|
+
|
|
434
|
+
# http body (model)
|
|
435
|
+
post_body = opts[:debug_body]
|
|
436
|
+
|
|
437
|
+
# return_type
|
|
438
|
+
return_type = opts[:debug_return_type] || 'CustomColorThemesSettingsWrapper'
|
|
439
|
+
|
|
440
|
+
# auth_names
|
|
441
|
+
auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
|
|
442
|
+
|
|
443
|
+
new_options = opts.merge(
|
|
444
|
+
:operation => :"Settings::CommonSettingsApi.get_portal_color_theme",
|
|
445
|
+
:header_params => header_params,
|
|
446
|
+
:query_params => query_params,
|
|
447
|
+
:form_params => form_params,
|
|
448
|
+
:body => post_body,
|
|
449
|
+
:auth_names => auth_names,
|
|
450
|
+
:return_type => return_type
|
|
451
|
+
)
|
|
452
|
+
|
|
453
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
454
|
+
if @api_client.config.debugging
|
|
455
|
+
@api_client.config.logger.debug "API called: Settings::CommonSettingsApi#get_portal_color_theme\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
456
|
+
end
|
|
457
|
+
return data, status_code, headers
|
|
458
|
+
end
|
|
459
|
+
|
|
460
|
+
# Get the portal hostname
|
|
461
|
+
# Returns the hostname the current request arrived on, exactly as sent in the HTTP Host header, so a client mid-setup can learn the address the portal is actually reachable at. This call is not for a normal logged-in session: it requires a confirmation link bearing the Wizard claim, of the kind generated during initial portal setup, and the link is consumed as part of authenticating the request. This is a read-only, idempotent call. The value reflects whatever the caller connected through, including a reverse proxy's public name, and is not necessarily the tenant's configured alias or mapped domain.
|
|
462
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-portal-hostname/
|
|
463
|
+
# @param [Hash] opts the optional parameters
|
|
464
|
+
# @return [StringWrapper]
|
|
465
|
+
def get_portal_hostname(opts = {})
|
|
466
|
+
data, _status_code, _headers = get_portal_hostname_with_http_info(opts)
|
|
467
|
+
data
|
|
468
|
+
end
|
|
469
|
+
|
|
470
|
+
# Get the portal hostname
|
|
471
|
+
# Returns the hostname the current request arrived on, exactly as sent in the HTTP Host header, so a client mid-setup can learn the address the portal is actually reachable at. This call is not for a normal logged-in session: it requires a confirmation link bearing the Wizard claim, of the kind generated during initial portal setup, and the link is consumed as part of authenticating the request. This is a read-only, idempotent call. The value reflects whatever the caller connected through, including a reverse proxy's public name, and is not necessarily the tenant's configured alias or mapped domain.
|
|
472
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-portal-hostname/
|
|
473
|
+
# @param [Hash] opts the optional parameters
|
|
474
|
+
# @return [Array<(StringWrapper, Integer, Hash)>] StringWrapper data, response status code and response headers
|
|
475
|
+
def get_portal_hostname_with_http_info(opts = {})
|
|
476
|
+
if @api_client.config.debugging
|
|
477
|
+
@api_client.config.logger.debug 'Calling API: Settings::CommonSettingsApi.get_portal_hostname ...'
|
|
478
|
+
end
|
|
479
|
+
# resource path
|
|
480
|
+
local_var_path = '/api/2.0/settings/machine'
|
|
481
|
+
|
|
482
|
+
# query parameters
|
|
483
|
+
query_params = opts[:query_params] || {}
|
|
484
|
+
|
|
485
|
+
# header parameters
|
|
486
|
+
header_params = opts[:header_params] || {}
|
|
487
|
+
# HTTP header 'Accept' (if needed)
|
|
488
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
489
|
+
|
|
490
|
+
# form parameters
|
|
491
|
+
form_params = opts[:form_params] || {}
|
|
492
|
+
|
|
493
|
+
# http body (model)
|
|
494
|
+
post_body = opts[:debug_body]
|
|
495
|
+
|
|
496
|
+
# return_type
|
|
497
|
+
return_type = opts[:debug_return_type] || 'StringWrapper'
|
|
498
|
+
|
|
499
|
+
# auth_names
|
|
500
|
+
auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
|
|
501
|
+
|
|
502
|
+
new_options = opts.merge(
|
|
503
|
+
:operation => :"Settings::CommonSettingsApi.get_portal_hostname",
|
|
504
|
+
:header_params => header_params,
|
|
505
|
+
:query_params => query_params,
|
|
506
|
+
:form_params => form_params,
|
|
507
|
+
:body => post_body,
|
|
508
|
+
:auth_names => auth_names,
|
|
509
|
+
:return_type => return_type
|
|
510
|
+
)
|
|
511
|
+
|
|
512
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
513
|
+
if @api_client.config.debugging
|
|
514
|
+
@api_client.config.logger.debug "API called: Settings::CommonSettingsApi#get_portal_hostname\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
515
|
+
end
|
|
516
|
+
return data, status_code, headers
|
|
517
|
+
end
|
|
518
|
+
|
|
519
|
+
# Get a portal logo
|
|
520
|
+
# Returns the absolute URL of the portal's current logo image, already resolved against the active white-label branding. Requires an authenticated session; every role, including Guest, can read it. This is a read-only, idempotent call. The response supports conditional requests: send the standard If-Modified-Since header with the previous `lastModified` value, and an unchanged response comes back empty instead of resending the same URL. The URL points at whatever image is currently configured, including the default DocSpace logo when no custom branding has been set.
|
|
521
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-portal-logo/
|
|
522
|
+
# @param [Hash] opts the optional parameters
|
|
523
|
+
# @return [StringWrapper]
|
|
524
|
+
def get_portal_logo(opts = {})
|
|
525
|
+
data, _status_code, _headers = get_portal_logo_with_http_info(opts)
|
|
526
|
+
data
|
|
527
|
+
end
|
|
528
|
+
|
|
529
|
+
# Get a portal logo
|
|
530
|
+
# Returns the absolute URL of the portal's current logo image, already resolved against the active white-label branding. Requires an authenticated session; every role, including Guest, can read it. This is a read-only, idempotent call. The response supports conditional requests: send the standard If-Modified-Since header with the previous `lastModified` value, and an unchanged response comes back empty instead of resending the same URL. The URL points at whatever image is currently configured, including the default DocSpace logo when no custom branding has been set.
|
|
531
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-portal-logo/
|
|
532
|
+
# @param [Hash] opts the optional parameters
|
|
533
|
+
# @return [Array<(StringWrapper, Integer, Hash)>] StringWrapper data, response status code and response headers
|
|
534
|
+
def get_portal_logo_with_http_info(opts = {})
|
|
535
|
+
if @api_client.config.debugging
|
|
536
|
+
@api_client.config.logger.debug 'Calling API: Settings::CommonSettingsApi.get_portal_logo ...'
|
|
537
|
+
end
|
|
538
|
+
# resource path
|
|
539
|
+
local_var_path = '/api/2.0/settings/logo'
|
|
540
|
+
|
|
541
|
+
# query parameters
|
|
542
|
+
query_params = opts[:query_params] || {}
|
|
543
|
+
|
|
544
|
+
# header parameters
|
|
545
|
+
header_params = opts[:header_params] || {}
|
|
546
|
+
# HTTP header 'Accept' (if needed)
|
|
547
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
548
|
+
|
|
549
|
+
# form parameters
|
|
550
|
+
form_params = opts[:form_params] || {}
|
|
551
|
+
|
|
552
|
+
# http body (model)
|
|
553
|
+
post_body = opts[:debug_body]
|
|
554
|
+
|
|
555
|
+
# return_type
|
|
556
|
+
return_type = opts[:debug_return_type] || 'StringWrapper'
|
|
557
|
+
|
|
558
|
+
# auth_names
|
|
559
|
+
auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
|
|
560
|
+
|
|
561
|
+
new_options = opts.merge(
|
|
562
|
+
:operation => :"Settings::CommonSettingsApi.get_portal_logo",
|
|
563
|
+
:header_params => header_params,
|
|
564
|
+
:query_params => query_params,
|
|
565
|
+
:form_params => form_params,
|
|
566
|
+
:body => post_body,
|
|
567
|
+
:auth_names => auth_names,
|
|
568
|
+
:return_type => return_type
|
|
569
|
+
)
|
|
570
|
+
|
|
571
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
572
|
+
if @api_client.config.debugging
|
|
573
|
+
@api_client.config.logger.debug "API called: Settings::CommonSettingsApi#get_portal_logo\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
574
|
+
end
|
|
575
|
+
return data, status_code, headers
|
|
576
|
+
end
|
|
577
|
+
|
|
578
|
+
# Get the portal settings
|
|
579
|
+
# Returns the current portal's general configuration: branding, culture, feature flags, and DocSpace/Standalone mode, everything the client needs to render its shell before or after login. No permission is required, but the response shape depends on the caller's identity. An anonymous caller receives only the public subset (culture, branding, DocSpace/Standalone flags, deep link data, setup-wizard and join-by-domain hints); once authenticated, the response also includes tenant-specific fields such as the owner ID, time zone, invitation limit, AI/banner/dev-tools flags, and, for a DocSpace administrator, the tenant wallet's low-balance flag. This is a read-only, idempotent call. Pass `withPassword=true` to also receive the parameters (`salt`, iteration count, hash size) used to hash the password client-side before it is sent to the authentication endpoints; these are only added for an anonymous caller or when explicitly requested, never as part of the default authenticated response.
|
|
580
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-portal-settings/
|
|
581
|
+
# @param [Hash] opts the optional parameters
|
|
582
|
+
# @option opts [Boolean] :withpassword Whether the answer also carries the salt, iteration count and hash size a client needs to hash a password before sending it to the authentication operations. They are included for an anonymous caller anyway; for a signed-in one they are left out unless this is set.
|
|
583
|
+
# @return [SettingsWrapper]
|
|
584
|
+
def get_portal_settings(opts = {})
|
|
585
|
+
data, _status_code, _headers = get_portal_settings_with_http_info(opts)
|
|
586
|
+
data
|
|
587
|
+
end
|
|
588
|
+
|
|
589
|
+
# Get the portal settings
|
|
590
|
+
# Returns the current portal's general configuration: branding, culture, feature flags, and DocSpace/Standalone mode, everything the client needs to render its shell before or after login. No permission is required, but the response shape depends on the caller's identity. An anonymous caller receives only the public subset (culture, branding, DocSpace/Standalone flags, deep link data, setup-wizard and join-by-domain hints); once authenticated, the response also includes tenant-specific fields such as the owner ID, time zone, invitation limit, AI/banner/dev-tools flags, and, for a DocSpace administrator, the tenant wallet's low-balance flag. This is a read-only, idempotent call. Pass `withPassword=true` to also receive the parameters (`salt`, iteration count, hash size) used to hash the password client-side before it is sent to the authentication endpoints; these are only added for an anonymous caller or when explicitly requested, never as part of the default authenticated response.
|
|
591
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-portal-settings/
|
|
592
|
+
# @param [Hash] opts the optional parameters
|
|
593
|
+
# @option opts [Boolean] :withpassword Whether the answer also carries the salt, iteration count and hash size a client needs to hash a password before sending it to the authentication operations. They are included for an anonymous caller anyway; for a signed-in one they are left out unless this is set.
|
|
594
|
+
# @return [Array<(SettingsWrapper, Integer, Hash)>] SettingsWrapper data, response status code and response headers
|
|
595
|
+
def get_portal_settings_with_http_info(opts = {})
|
|
596
|
+
if @api_client.config.debugging
|
|
597
|
+
@api_client.config.logger.debug 'Calling API: Settings::CommonSettingsApi.get_portal_settings ...'
|
|
598
|
+
end
|
|
599
|
+
# resource path
|
|
600
|
+
local_var_path = '/api/2.0/settings'
|
|
601
|
+
|
|
602
|
+
# query parameters
|
|
603
|
+
query_params = opts[:query_params] || {}
|
|
604
|
+
query_params[:'withpassword'] = opts[:'withpassword'] if !opts[:'withpassword'].nil?
|
|
605
|
+
|
|
606
|
+
# header parameters
|
|
607
|
+
header_params = opts[:header_params] || {}
|
|
608
|
+
# HTTP header 'Accept' (if needed)
|
|
609
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
610
|
+
|
|
611
|
+
# form parameters
|
|
612
|
+
form_params = opts[:form_params] || {}
|
|
613
|
+
|
|
614
|
+
# http body (model)
|
|
615
|
+
post_body = opts[:debug_body]
|
|
616
|
+
|
|
617
|
+
# return_type
|
|
618
|
+
return_type = opts[:debug_return_type] || 'SettingsWrapper'
|
|
619
|
+
|
|
620
|
+
# auth_names
|
|
621
|
+
auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
|
|
622
|
+
|
|
623
|
+
new_options = opts.merge(
|
|
624
|
+
:operation => :"Settings::CommonSettingsApi.get_portal_settings",
|
|
625
|
+
:header_params => header_params,
|
|
626
|
+
:query_params => query_params,
|
|
627
|
+
:form_params => form_params,
|
|
628
|
+
:body => post_body,
|
|
629
|
+
:auth_names => auth_names,
|
|
630
|
+
:return_type => return_type
|
|
631
|
+
)
|
|
632
|
+
|
|
633
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
634
|
+
if @api_client.config.debugging
|
|
635
|
+
@api_client.config.logger.debug "API called: Settings::CommonSettingsApi#get_portal_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
636
|
+
end
|
|
637
|
+
return data, status_code, headers
|
|
638
|
+
end
|
|
639
|
+
|
|
640
|
+
# Get the socket settings
|
|
641
|
+
# Returns the base URL of the portal's real-time notification hub (Socket.IO), which the client connects to for live updates such as file changes, presence, or quota alerts. Requires an authenticated session; every role can read it. This is a read-only, idempotent call. The value comes from server-side configuration and cannot be changed through this API; an empty `url` means the portal has no notification hub configured and the client should not attempt to connect.
|
|
642
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-socket-settings/
|
|
643
|
+
# @param [Hash] opts the optional parameters
|
|
644
|
+
# @return [SocketSettingsWrapper]
|
|
645
|
+
def get_socket_settings(opts = {})
|
|
646
|
+
data, _status_code, _headers = get_socket_settings_with_http_info(opts)
|
|
647
|
+
data
|
|
648
|
+
end
|
|
649
|
+
|
|
650
|
+
# Get the socket settings
|
|
651
|
+
# Returns the base URL of the portal's real-time notification hub (Socket.IO), which the client connects to for live updates such as file changes, presence, or quota alerts. Requires an authenticated session; every role can read it. This is a read-only, idempotent call. The value comes from server-side configuration and cannot be changed through this API; an empty `url` means the portal has no notification hub configured and the client should not attempt to connect.
|
|
652
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-socket-settings/
|
|
653
|
+
# @param [Hash] opts the optional parameters
|
|
654
|
+
# @return [Array<(SocketSettingsWrapper, Integer, Hash)>] SocketSettingsWrapper data, response status code and response headers
|
|
655
|
+
def get_socket_settings_with_http_info(opts = {})
|
|
656
|
+
if @api_client.config.debugging
|
|
657
|
+
@api_client.config.logger.debug 'Calling API: Settings::CommonSettingsApi.get_socket_settings ...'
|
|
658
|
+
end
|
|
659
|
+
# resource path
|
|
660
|
+
local_var_path = '/api/2.0/settings/socket'
|
|
661
|
+
|
|
662
|
+
# query parameters
|
|
663
|
+
query_params = opts[:query_params] || {}
|
|
664
|
+
|
|
665
|
+
# header parameters
|
|
666
|
+
header_params = opts[:header_params] || {}
|
|
667
|
+
# HTTP header 'Accept' (if needed)
|
|
668
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
669
|
+
|
|
670
|
+
# form parameters
|
|
671
|
+
form_params = opts[:form_params] || {}
|
|
672
|
+
|
|
673
|
+
# http body (model)
|
|
674
|
+
post_body = opts[:debug_body]
|
|
675
|
+
|
|
676
|
+
# return_type
|
|
677
|
+
return_type = opts[:debug_return_type] || 'SocketSettingsWrapper'
|
|
678
|
+
|
|
679
|
+
# auth_names
|
|
680
|
+
auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
|
|
681
|
+
|
|
682
|
+
new_options = opts.merge(
|
|
683
|
+
:operation => :"Settings::CommonSettingsApi.get_socket_settings",
|
|
684
|
+
:header_params => header_params,
|
|
685
|
+
:query_params => query_params,
|
|
686
|
+
:form_params => form_params,
|
|
687
|
+
:body => post_body,
|
|
688
|
+
:auth_names => auth_names,
|
|
689
|
+
:return_type => return_type
|
|
690
|
+
)
|
|
691
|
+
|
|
692
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
693
|
+
if @api_client.config.debugging
|
|
694
|
+
@api_client.config.logger.debug "API called: Settings::CommonSettingsApi#get_socket_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
695
|
+
end
|
|
696
|
+
return data, status_code, headers
|
|
697
|
+
end
|
|
698
|
+
|
|
699
|
+
# Get supported languages
|
|
700
|
+
# Returns the two- or four-letter language codes of every culture currently enabled on the portal (for example `en-US`), used to populate a language picker before or after login. No permission is required; anonymous callers can read it too. This is a read-only, idempotent call, and the list is not paginated. The response supports conditional requests: an unchanged result is signaled instead of resending the same list. The set of enabled cultures is a portal-wide configuration value, not a per-user preference.
|
|
701
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-supported-cultures/
|
|
702
|
+
# @param [Hash] opts the optional parameters
|
|
703
|
+
# @return [StringArrayWrapper]
|
|
704
|
+
def get_supported_cultures(opts = {})
|
|
705
|
+
data, _status_code, _headers = get_supported_cultures_with_http_info(opts)
|
|
706
|
+
data
|
|
707
|
+
end
|
|
708
|
+
|
|
709
|
+
# Get supported languages
|
|
710
|
+
# Returns the two- or four-letter language codes of every culture currently enabled on the portal (for example `en-US`), used to populate a language picker before or after login. No permission is required; anonymous callers can read it too. This is a read-only, idempotent call, and the list is not paginated. The response supports conditional requests: an unchanged result is signaled instead of resending the same list. The set of enabled cultures is a portal-wide configuration value, not a per-user preference.
|
|
711
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-supported-cultures/
|
|
712
|
+
# @param [Hash] opts the optional parameters
|
|
713
|
+
# @return [Array<(StringArrayWrapper, Integer, Hash)>] StringArrayWrapper data, response status code and response headers
|
|
714
|
+
def get_supported_cultures_with_http_info(opts = {})
|
|
715
|
+
if @api_client.config.debugging
|
|
716
|
+
@api_client.config.logger.debug 'Calling API: Settings::CommonSettingsApi.get_supported_cultures ...'
|
|
717
|
+
end
|
|
718
|
+
# resource path
|
|
719
|
+
local_var_path = '/api/2.0/settings/cultures'
|
|
720
|
+
|
|
721
|
+
# query parameters
|
|
722
|
+
query_params = opts[:query_params] || {}
|
|
723
|
+
|
|
724
|
+
# header parameters
|
|
725
|
+
header_params = opts[:header_params] || {}
|
|
726
|
+
# HTTP header 'Accept' (if needed)
|
|
727
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
728
|
+
|
|
729
|
+
# form parameters
|
|
730
|
+
form_params = opts[:form_params] || {}
|
|
731
|
+
|
|
732
|
+
# http body (model)
|
|
733
|
+
post_body = opts[:debug_body]
|
|
734
|
+
|
|
735
|
+
# return_type
|
|
736
|
+
return_type = opts[:debug_return_type] || 'StringArrayWrapper'
|
|
737
|
+
|
|
738
|
+
# auth_names
|
|
739
|
+
auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
|
|
740
|
+
|
|
741
|
+
new_options = opts.merge(
|
|
742
|
+
:operation => :"Settings::CommonSettingsApi.get_supported_cultures",
|
|
743
|
+
:header_params => header_params,
|
|
744
|
+
:query_params => query_params,
|
|
745
|
+
:form_params => form_params,
|
|
746
|
+
:body => post_body,
|
|
747
|
+
:auth_names => auth_names,
|
|
748
|
+
:return_type => return_type
|
|
749
|
+
)
|
|
750
|
+
|
|
751
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
752
|
+
if @api_client.config.debugging
|
|
753
|
+
@api_client.config.logger.debug "API called: Settings::CommonSettingsApi#get_supported_cultures\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
754
|
+
end
|
|
755
|
+
return data, status_code, headers
|
|
756
|
+
end
|
|
757
|
+
|
|
758
|
+
# Get the AI access settings
|
|
759
|
+
# Returns whether AI functionality (chat, agents, vectorization) is currently available on the portal at all; AI is enabled by default. Requires an authenticated session; every role can read it. This is a read-only, idempotent call. When the setting is disabled, every AI-specific endpoint and folder is unavailable regardless of the caller's own permissions; this call only reports the portal-wide switch, not any per-user entitlement.
|
|
760
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-tenant-ai-access-settings/
|
|
761
|
+
# @param [Hash] opts the optional parameters
|
|
762
|
+
# @return [TenantAiAccessSettingsWrapper]
|
|
763
|
+
def get_tenant_ai_access_settings(opts = {})
|
|
764
|
+
data, _status_code, _headers = get_tenant_ai_access_settings_with_http_info(opts)
|
|
765
|
+
data
|
|
766
|
+
end
|
|
767
|
+
|
|
768
|
+
# Get the AI access settings
|
|
769
|
+
# Returns whether AI functionality (chat, agents, vectorization) is currently available on the portal at all; AI is enabled by default. Requires an authenticated session; every role can read it. This is a read-only, idempotent call. When the setting is disabled, every AI-specific endpoint and folder is unavailable regardless of the caller's own permissions; this call only reports the portal-wide switch, not any per-user entitlement.
|
|
770
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-tenant-ai-access-settings/
|
|
771
|
+
# @param [Hash] opts the optional parameters
|
|
772
|
+
# @return [Array<(TenantAiAccessSettingsWrapper, Integer, Hash)>] TenantAiAccessSettingsWrapper data, response status code and response headers
|
|
773
|
+
def get_tenant_ai_access_settings_with_http_info(opts = {})
|
|
774
|
+
if @api_client.config.debugging
|
|
775
|
+
@api_client.config.logger.debug 'Calling API: Settings::CommonSettingsApi.get_tenant_ai_access_settings ...'
|
|
776
|
+
end
|
|
777
|
+
# resource path
|
|
778
|
+
local_var_path = '/api/2.0/settings/ai-access'
|
|
779
|
+
|
|
780
|
+
# query parameters
|
|
781
|
+
query_params = opts[:query_params] || {}
|
|
782
|
+
|
|
783
|
+
# header parameters
|
|
784
|
+
header_params = opts[:header_params] || {}
|
|
785
|
+
# HTTP header 'Accept' (if needed)
|
|
786
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
787
|
+
|
|
788
|
+
# form parameters
|
|
789
|
+
form_params = opts[:form_params] || {}
|
|
790
|
+
|
|
791
|
+
# http body (model)
|
|
792
|
+
post_body = opts[:debug_body]
|
|
793
|
+
|
|
794
|
+
# return_type
|
|
795
|
+
return_type = opts[:debug_return_type] || 'TenantAiAccessSettingsWrapper'
|
|
796
|
+
|
|
797
|
+
# auth_names
|
|
798
|
+
auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
|
|
799
|
+
|
|
800
|
+
new_options = opts.merge(
|
|
801
|
+
:operation => :"Settings::CommonSettingsApi.get_tenant_ai_access_settings",
|
|
802
|
+
:header_params => header_params,
|
|
803
|
+
:query_params => query_params,
|
|
804
|
+
:form_params => form_params,
|
|
805
|
+
:body => post_body,
|
|
806
|
+
:auth_names => auth_names,
|
|
807
|
+
:return_type => return_type
|
|
808
|
+
)
|
|
809
|
+
|
|
810
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
811
|
+
if @api_client.config.debugging
|
|
812
|
+
@api_client.config.logger.debug "API called: Settings::CommonSettingsApi#get_tenant_ai_access_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
813
|
+
end
|
|
814
|
+
return data, status_code, headers
|
|
815
|
+
end
|
|
816
|
+
|
|
817
|
+
# Get the user invitation settings
|
|
818
|
+
# Returns whether the portal currently allows inviting new members and new guests at all. No permission is required; anonymous callers can read it too, since the invitation flow itself may run before the caller has signed in. This is a read-only, idempotent call. The response supports conditional requests: send the standard If-Modified-Since header with the previous `lastModified` value, and an unchanged response comes back empty instead of resending the same settings.
|
|
819
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-tenant-user-invitation-settings/
|
|
820
|
+
# @param [Hash] opts the optional parameters
|
|
821
|
+
# @return [TenantUserInvitationSettingsWrapper]
|
|
822
|
+
def get_tenant_user_invitation_settings(opts = {})
|
|
823
|
+
data, _status_code, _headers = get_tenant_user_invitation_settings_with_http_info(opts)
|
|
824
|
+
data
|
|
825
|
+
end
|
|
826
|
+
|
|
827
|
+
# Get the user invitation settings
|
|
828
|
+
# Returns whether the portal currently allows inviting new members and new guests at all. No permission is required; anonymous callers can read it too, since the invitation flow itself may run before the caller has signed in. This is a read-only, idempotent call. The response supports conditional requests: send the standard If-Modified-Since header with the previous `lastModified` value, and an unchanged response comes back empty instead of resending the same settings.
|
|
829
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-tenant-user-invitation-settings/
|
|
830
|
+
# @param [Hash] opts the optional parameters
|
|
831
|
+
# @return [Array<(TenantUserInvitationSettingsWrapper, Integer, Hash)>] TenantUserInvitationSettingsWrapper data, response status code and response headers
|
|
832
|
+
def get_tenant_user_invitation_settings_with_http_info(opts = {})
|
|
833
|
+
if @api_client.config.debugging
|
|
834
|
+
@api_client.config.logger.debug 'Calling API: Settings::CommonSettingsApi.get_tenant_user_invitation_settings ...'
|
|
835
|
+
end
|
|
836
|
+
# resource path
|
|
837
|
+
local_var_path = '/api/2.0/settings/invitationsettings'
|
|
838
|
+
|
|
839
|
+
# query parameters
|
|
840
|
+
query_params = opts[:query_params] || {}
|
|
841
|
+
|
|
842
|
+
# header parameters
|
|
843
|
+
header_params = opts[:header_params] || {}
|
|
844
|
+
# HTTP header 'Accept' (if needed)
|
|
845
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
846
|
+
|
|
847
|
+
# form parameters
|
|
848
|
+
form_params = opts[:form_params] || {}
|
|
849
|
+
|
|
850
|
+
# http body (model)
|
|
851
|
+
post_body = opts[:debug_body]
|
|
852
|
+
|
|
853
|
+
# return_type
|
|
854
|
+
return_type = opts[:debug_return_type] || 'TenantUserInvitationSettingsWrapper'
|
|
855
|
+
|
|
856
|
+
# auth_names
|
|
857
|
+
auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
|
|
858
|
+
|
|
859
|
+
new_options = opts.merge(
|
|
860
|
+
:operation => :"Settings::CommonSettingsApi.get_tenant_user_invitation_settings",
|
|
861
|
+
:header_params => header_params,
|
|
862
|
+
:query_params => query_params,
|
|
863
|
+
:form_params => form_params,
|
|
864
|
+
:body => post_body,
|
|
865
|
+
:auth_names => auth_names,
|
|
866
|
+
:return_type => return_type
|
|
867
|
+
)
|
|
868
|
+
|
|
869
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
870
|
+
if @api_client.config.debugging
|
|
871
|
+
@api_client.config.logger.debug "API called: Settings::CommonSettingsApi#get_tenant_user_invitation_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
872
|
+
end
|
|
873
|
+
return data, status_code, headers
|
|
874
|
+
end
|
|
875
|
+
|
|
876
|
+
# Get time zones
|
|
877
|
+
# Returns every time zone known to the host machine, each with its IANA identifier and a human-readable display name, ordered from the most negative to the most positive UTC offset. This call is not for a normal logged-in session: it requires a confirmation link bearing the Wizard or Administrators claim, of the kind generated during initial portal setup or issued by an administrator, and the link is consumed as part of authenticating the request. This is a read-only, idempotent call, and the list is not paginated. Use the returned `id` values wherever the portal expects a time zone identifier; an unrecognized value is rejected there, not here.
|
|
878
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-time-zones/
|
|
879
|
+
# @param [Hash] opts the optional parameters
|
|
880
|
+
# @return [TimezoneArrayWrapper]
|
|
881
|
+
def get_time_zones(opts = {})
|
|
882
|
+
data, _status_code, _headers = get_time_zones_with_http_info(opts)
|
|
883
|
+
data
|
|
884
|
+
end
|
|
885
|
+
|
|
886
|
+
# Get time zones
|
|
887
|
+
# Returns every time zone known to the host machine, each with its IANA identifier and a human-readable display name, ordered from the most negative to the most positive UTC offset. This call is not for a normal logged-in session: it requires a confirmation link bearing the Wizard or Administrators claim, of the kind generated during initial portal setup or issued by an administrator, and the link is consumed as part of authenticating the request. This is a read-only, idempotent call, and the list is not paginated. Use the returned `id` values wherever the portal expects a time zone identifier; an unrecognized value is rejected there, not here.
|
|
888
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-time-zones/
|
|
889
|
+
# @param [Hash] opts the optional parameters
|
|
890
|
+
# @return [Array<(TimezoneArrayWrapper, Integer, Hash)>] TimezoneArrayWrapper data, response status code and response headers
|
|
891
|
+
def get_time_zones_with_http_info(opts = {})
|
|
892
|
+
if @api_client.config.debugging
|
|
893
|
+
@api_client.config.logger.debug 'Calling API: Settings::CommonSettingsApi.get_time_zones ...'
|
|
894
|
+
end
|
|
895
|
+
# resource path
|
|
896
|
+
local_var_path = '/api/2.0/settings/timezones'
|
|
897
|
+
|
|
898
|
+
# query parameters
|
|
899
|
+
query_params = opts[:query_params] || {}
|
|
900
|
+
|
|
901
|
+
# header parameters
|
|
902
|
+
header_params = opts[:header_params] || {}
|
|
903
|
+
# HTTP header 'Accept' (if needed)
|
|
904
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
905
|
+
|
|
906
|
+
# form parameters
|
|
907
|
+
form_params = opts[:form_params] || {}
|
|
908
|
+
|
|
909
|
+
# http body (model)
|
|
910
|
+
post_body = opts[:debug_body]
|
|
911
|
+
|
|
912
|
+
# return_type
|
|
913
|
+
return_type = opts[:debug_return_type] || 'TimezoneArrayWrapper'
|
|
914
|
+
|
|
915
|
+
# auth_names
|
|
916
|
+
auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
|
|
917
|
+
|
|
918
|
+
new_options = opts.merge(
|
|
919
|
+
:operation => :"Settings::CommonSettingsApi.get_time_zones",
|
|
920
|
+
:header_params => header_params,
|
|
921
|
+
:query_params => query_params,
|
|
922
|
+
:form_params => form_params,
|
|
923
|
+
:body => post_body,
|
|
924
|
+
:auth_names => auth_names,
|
|
925
|
+
:return_type => return_type
|
|
926
|
+
)
|
|
927
|
+
|
|
928
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
929
|
+
if @api_client.config.debugging
|
|
930
|
+
@api_client.config.logger.debug "API called: Settings::CommonSettingsApi#get_time_zones\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
931
|
+
end
|
|
932
|
+
return data, status_code, headers
|
|
933
|
+
end
|
|
934
|
+
|
|
935
|
+
# Set the default folder
|
|
936
|
+
# Sets which folder the current user's account opens into by default, such as My Documents, the rooms list, or favorites. Requires an authenticated session; every role may set its own default, and the change never affects any other user. Only folder types the client actually offers as a landing page are accepted; picking My Documents (`USER`) as a Guest is rejected too, since guests have no personal storage. This is a mutating, idempotent call. It returns the saved setting.
|
|
937
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/save-default-folder/
|
|
938
|
+
# @param [Hash] opts the optional parameters
|
|
939
|
+
# @option opts [DefaultProductRequestDto] :default_product_request_dto
|
|
940
|
+
# @return [StudioDefaultPageSettingsWrapper]
|
|
941
|
+
def save_default_folder(opts = {})
|
|
942
|
+
data, _status_code, _headers = save_default_folder_with_http_info(opts)
|
|
943
|
+
data
|
|
944
|
+
end
|
|
945
|
+
|
|
946
|
+
# Set the default folder
|
|
947
|
+
# Sets which folder the current user's account opens into by default, such as My Documents, the rooms list, or favorites. Requires an authenticated session; every role may set its own default, and the change never affects any other user. Only folder types the client actually offers as a landing page are accepted; picking My Documents (`USER`) as a Guest is rejected too, since guests have no personal storage. This is a mutating, idempotent call. It returns the saved setting.
|
|
948
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/save-default-folder/
|
|
949
|
+
# @param [Hash] opts the optional parameters
|
|
950
|
+
# @option opts [DefaultProductRequestDto] :default_product_request_dto
|
|
951
|
+
# @return [Array<(StudioDefaultPageSettingsWrapper, Integer, Hash)>] StudioDefaultPageSettingsWrapper data, response status code and response headers
|
|
952
|
+
def save_default_folder_with_http_info(opts = {})
|
|
953
|
+
if @api_client.config.debugging
|
|
954
|
+
@api_client.config.logger.debug 'Calling API: Settings::CommonSettingsApi.save_default_folder ...'
|
|
955
|
+
end
|
|
956
|
+
# resource path
|
|
957
|
+
local_var_path = '/api/2.0/settings/defaultfolder'
|
|
958
|
+
|
|
959
|
+
# query parameters
|
|
960
|
+
query_params = opts[:query_params] || {}
|
|
961
|
+
|
|
962
|
+
# header parameters
|
|
963
|
+
header_params = opts[:header_params] || {}
|
|
964
|
+
# HTTP header 'Accept' (if needed)
|
|
965
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
966
|
+
# HTTP header 'Content-Type'
|
|
967
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
968
|
+
if !content_type.nil?
|
|
969
|
+
header_params['Content-Type'] = content_type
|
|
970
|
+
end
|
|
971
|
+
|
|
972
|
+
# form parameters
|
|
973
|
+
form_params = opts[:form_params] || {}
|
|
974
|
+
|
|
975
|
+
# http body (model)
|
|
976
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'default_product_request_dto'])
|
|
977
|
+
|
|
978
|
+
# return_type
|
|
979
|
+
return_type = opts[:debug_return_type] || 'StudioDefaultPageSettingsWrapper'
|
|
980
|
+
|
|
981
|
+
# auth_names
|
|
982
|
+
auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
|
|
983
|
+
|
|
984
|
+
new_options = opts.merge(
|
|
985
|
+
:operation => :"Settings::CommonSettingsApi.save_default_folder",
|
|
986
|
+
:header_params => header_params,
|
|
987
|
+
:query_params => query_params,
|
|
988
|
+
:form_params => form_params,
|
|
989
|
+
:body => post_body,
|
|
990
|
+
:auth_names => auth_names,
|
|
991
|
+
:return_type => return_type
|
|
992
|
+
)
|
|
993
|
+
|
|
994
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
|
|
995
|
+
if @api_client.config.debugging
|
|
996
|
+
@api_client.config.logger.debug "API called: Settings::CommonSettingsApi#save_default_folder\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
997
|
+
end
|
|
998
|
+
return data, status_code, headers
|
|
999
|
+
end
|
|
1000
|
+
|
|
1001
|
+
# Save the DNS settings
|
|
1002
|
+
# Maps a custom domain name onto the current tenant, or clears the mapping, so the portal becomes reachable under the caller's own DNS name instead of only its default alias. Available only on a Standalone (self-hosted) installation; on SaaS the call is always refused. Requires Owner or DocSpaceAdmin (the EditPortalSettings permission). Disable the mapping by passing `enable=false`, in which case the domain name in the request is ignored. A domain that collides with the portal's reserved base domain, or otherwise fails validation, is rejected without changing the current mapping. This is a mutating, idempotent call. On success the previous domain also stops answering, and any CSP configuration referencing it is updated to the new one.
|
|
1003
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/save-dns-settings/
|
|
1004
|
+
# @param [Hash] opts the optional parameters
|
|
1005
|
+
# @option opts [DnsSettingsRequestDto] :dns_settings_request_dto
|
|
1006
|
+
# @return [StringWrapper]
|
|
1007
|
+
def save_dns_settings(opts = {})
|
|
1008
|
+
data, _status_code, _headers = save_dns_settings_with_http_info(opts)
|
|
1009
|
+
data
|
|
1010
|
+
end
|
|
1011
|
+
|
|
1012
|
+
# Save the DNS settings
|
|
1013
|
+
# Maps a custom domain name onto the current tenant, or clears the mapping, so the portal becomes reachable under the caller's own DNS name instead of only its default alias. Available only on a Standalone (self-hosted) installation; on SaaS the call is always refused. Requires Owner or DocSpaceAdmin (the EditPortalSettings permission). Disable the mapping by passing `enable=false`, in which case the domain name in the request is ignored. A domain that collides with the portal's reserved base domain, or otherwise fails validation, is rejected without changing the current mapping. This is a mutating, idempotent call. On success the previous domain also stops answering, and any CSP configuration referencing it is updated to the new one.
|
|
1014
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/save-dns-settings/
|
|
1015
|
+
# @param [Hash] opts the optional parameters
|
|
1016
|
+
# @option opts [DnsSettingsRequestDto] :dns_settings_request_dto
|
|
1017
|
+
# @return [Array<(StringWrapper, Integer, Hash)>] StringWrapper data, response status code and response headers
|
|
1018
|
+
def save_dns_settings_with_http_info(opts = {})
|
|
1019
|
+
if @api_client.config.debugging
|
|
1020
|
+
@api_client.config.logger.debug 'Calling API: Settings::CommonSettingsApi.save_dns_settings ...'
|
|
1021
|
+
end
|
|
1022
|
+
# resource path
|
|
1023
|
+
local_var_path = '/api/2.0/settings/dns'
|
|
1024
|
+
|
|
1025
|
+
# query parameters
|
|
1026
|
+
query_params = opts[:query_params] || {}
|
|
1027
|
+
|
|
1028
|
+
# header parameters
|
|
1029
|
+
header_params = opts[:header_params] || {}
|
|
1030
|
+
# HTTP header 'Accept' (if needed)
|
|
1031
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
1032
|
+
# HTTP header 'Content-Type'
|
|
1033
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
1034
|
+
if !content_type.nil?
|
|
1035
|
+
header_params['Content-Type'] = content_type
|
|
1036
|
+
end
|
|
1037
|
+
|
|
1038
|
+
# form parameters
|
|
1039
|
+
form_params = opts[:form_params] || {}
|
|
1040
|
+
|
|
1041
|
+
# http body (model)
|
|
1042
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'dns_settings_request_dto'])
|
|
1043
|
+
|
|
1044
|
+
# return_type
|
|
1045
|
+
return_type = opts[:debug_return_type] || 'StringWrapper'
|
|
1046
|
+
|
|
1047
|
+
# auth_names
|
|
1048
|
+
auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
|
|
1049
|
+
|
|
1050
|
+
new_options = opts.merge(
|
|
1051
|
+
:operation => :"Settings::CommonSettingsApi.save_dns_settings",
|
|
1052
|
+
:header_params => header_params,
|
|
1053
|
+
:query_params => query_params,
|
|
1054
|
+
:form_params => form_params,
|
|
1055
|
+
:body => post_body,
|
|
1056
|
+
:auth_names => auth_names,
|
|
1057
|
+
:return_type => return_type
|
|
1058
|
+
)
|
|
1059
|
+
|
|
1060
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
|
|
1061
|
+
if @api_client.config.debugging
|
|
1062
|
+
@api_client.config.logger.debug "API called: Settings::CommonSettingsApi#save_dns_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1063
|
+
end
|
|
1064
|
+
return data, status_code, headers
|
|
1065
|
+
end
|
|
1066
|
+
|
|
1067
|
+
# Save the mail domain settings
|
|
1068
|
+
# Overwrites the portal's trusted mail domain configuration, which controls which email domains are treated as already verified when a user is invited or self-registers. Requires Owner or DocSpaceAdmin (the EditPortalSettings permission). When the requested mode is a custom domain list, every domain is normalized to lowercase and checked against the expected hostname format; a domain that fails the check, or an empty custom list, causes the whole call to be rejected without saving anything. For the other modes the domain list in the request is ignored. The `inviteUsersAsVisitors` flag controls whether users who join through a trusted domain are added as full members or as visitors, and takes effect on the next join rather than retroactively. This is a mutating, idempotent call: repeating it with the same body leaves the portal in the same state. On success it returns a confirmation message, not the saved settings themselves; read them back from `GET api/2.0/settings`.
|
|
1069
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/save-mail-domain-settings/
|
|
1070
|
+
# @param [Hash] opts the optional parameters
|
|
1071
|
+
# @option opts [MailDomainSettingsRequestDto] :mail_domain_settings_request_dto
|
|
1072
|
+
# @return [StringWrapper]
|
|
1073
|
+
def save_mail_domain_settings(opts = {})
|
|
1074
|
+
data, _status_code, _headers = save_mail_domain_settings_with_http_info(opts)
|
|
1075
|
+
data
|
|
1076
|
+
end
|
|
1077
|
+
|
|
1078
|
+
# Save the mail domain settings
|
|
1079
|
+
# Overwrites the portal's trusted mail domain configuration, which controls which email domains are treated as already verified when a user is invited or self-registers. Requires Owner or DocSpaceAdmin (the EditPortalSettings permission). When the requested mode is a custom domain list, every domain is normalized to lowercase and checked against the expected hostname format; a domain that fails the check, or an empty custom list, causes the whole call to be rejected without saving anything. For the other modes the domain list in the request is ignored. The `inviteUsersAsVisitors` flag controls whether users who join through a trusted domain are added as full members or as visitors, and takes effect on the next join rather than retroactively. This is a mutating, idempotent call: repeating it with the same body leaves the portal in the same state. On success it returns a confirmation message, not the saved settings themselves; read them back from `GET api/2.0/settings`.
|
|
1080
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/save-mail-domain-settings/
|
|
1081
|
+
# @param [Hash] opts the optional parameters
|
|
1082
|
+
# @option opts [MailDomainSettingsRequestDto] :mail_domain_settings_request_dto
|
|
1083
|
+
# @return [Array<(StringWrapper, Integer, Hash)>] StringWrapper data, response status code and response headers
|
|
1084
|
+
def save_mail_domain_settings_with_http_info(opts = {})
|
|
1085
|
+
if @api_client.config.debugging
|
|
1086
|
+
@api_client.config.logger.debug 'Calling API: Settings::CommonSettingsApi.save_mail_domain_settings ...'
|
|
1087
|
+
end
|
|
1088
|
+
# resource path
|
|
1089
|
+
local_var_path = '/api/2.0/settings/maildomainsettings'
|
|
1090
|
+
|
|
1091
|
+
# query parameters
|
|
1092
|
+
query_params = opts[:query_params] || {}
|
|
1093
|
+
|
|
1094
|
+
# header parameters
|
|
1095
|
+
header_params = opts[:header_params] || {}
|
|
1096
|
+
# HTTP header 'Accept' (if needed)
|
|
1097
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
1098
|
+
# HTTP header 'Content-Type'
|
|
1099
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
1100
|
+
if !content_type.nil?
|
|
1101
|
+
header_params['Content-Type'] = content_type
|
|
1102
|
+
end
|
|
1103
|
+
|
|
1104
|
+
# form parameters
|
|
1105
|
+
form_params = opts[:form_params] || {}
|
|
1106
|
+
|
|
1107
|
+
# http body (model)
|
|
1108
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'mail_domain_settings_request_dto'])
|
|
1109
|
+
|
|
1110
|
+
# return_type
|
|
1111
|
+
return_type = opts[:debug_return_type] || 'StringWrapper'
|
|
1112
|
+
|
|
1113
|
+
# auth_names
|
|
1114
|
+
auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
|
|
1115
|
+
|
|
1116
|
+
new_options = opts.merge(
|
|
1117
|
+
:operation => :"Settings::CommonSettingsApi.save_mail_domain_settings",
|
|
1118
|
+
:header_params => header_params,
|
|
1119
|
+
:query_params => query_params,
|
|
1120
|
+
:form_params => form_params,
|
|
1121
|
+
:body => post_body,
|
|
1122
|
+
:auth_names => auth_names,
|
|
1123
|
+
:return_type => return_type
|
|
1124
|
+
)
|
|
1125
|
+
|
|
1126
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
1127
|
+
if @api_client.config.debugging
|
|
1128
|
+
@api_client.config.logger.debug "API called: Settings::CommonSettingsApi#save_mail_domain_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1129
|
+
end
|
|
1130
|
+
return data, status_code, headers
|
|
1131
|
+
end
|
|
1132
|
+
|
|
1133
|
+
# Save a color theme
|
|
1134
|
+
# Adds or updates a custom color theme, or changes which theme is selected, for the whole portal. Requires Owner or DocSpaceAdmin (the EditPortalSettings permission). Pass `theme` to create or edit one: an existing theme is matched and updated by its ID, a new one is appended, and an ID that collides with a built-in default theme is treated as a request to create a new custom theme instead of overwriting the default. Once the plan's custom-theme limit is reached, a new theme is silently not added rather than rejected with an error, so check the returned `themes` count against `limit` before assuming it was saved. Pass `selected` to switch the active theme; an ID that does not match any existing theme is ignored. This is a mutating call, not strictly idempotent once the limit has been reached. It returns the full updated theme configuration.
|
|
1135
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/save-portal-color-theme/
|
|
1136
|
+
# @param [Hash] opts the optional parameters
|
|
1137
|
+
# @option opts [CustomColorThemesSettingsRequestDto] :custom_color_themes_settings_request_dto
|
|
1138
|
+
# @return [CustomColorThemesSettingsWrapper]
|
|
1139
|
+
def save_portal_color_theme(opts = {})
|
|
1140
|
+
data, _status_code, _headers = save_portal_color_theme_with_http_info(opts)
|
|
1141
|
+
data
|
|
1142
|
+
end
|
|
1143
|
+
|
|
1144
|
+
# Save a color theme
|
|
1145
|
+
# Adds or updates a custom color theme, or changes which theme is selected, for the whole portal. Requires Owner or DocSpaceAdmin (the EditPortalSettings permission). Pass `theme` to create or edit one: an existing theme is matched and updated by its ID, a new one is appended, and an ID that collides with a built-in default theme is treated as a request to create a new custom theme instead of overwriting the default. Once the plan's custom-theme limit is reached, a new theme is silently not added rather than rejected with an error, so check the returned `themes` count against `limit` before assuming it was saved. Pass `selected` to switch the active theme; an ID that does not match any existing theme is ignored. This is a mutating call, not strictly idempotent once the limit has been reached. It returns the full updated theme configuration.
|
|
1146
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/save-portal-color-theme/
|
|
1147
|
+
# @param [Hash] opts the optional parameters
|
|
1148
|
+
# @option opts [CustomColorThemesSettingsRequestDto] :custom_color_themes_settings_request_dto
|
|
1149
|
+
# @return [Array<(CustomColorThemesSettingsWrapper, Integer, Hash)>] CustomColorThemesSettingsWrapper data, response status code and response headers
|
|
1150
|
+
def save_portal_color_theme_with_http_info(opts = {})
|
|
1151
|
+
if @api_client.config.debugging
|
|
1152
|
+
@api_client.config.logger.debug 'Calling API: Settings::CommonSettingsApi.save_portal_color_theme ...'
|
|
1153
|
+
end
|
|
1154
|
+
# resource path
|
|
1155
|
+
local_var_path = '/api/2.0/settings/colortheme'
|
|
1156
|
+
|
|
1157
|
+
# query parameters
|
|
1158
|
+
query_params = opts[:query_params] || {}
|
|
1159
|
+
|
|
1160
|
+
# header parameters
|
|
1161
|
+
header_params = opts[:header_params] || {}
|
|
1162
|
+
# HTTP header 'Accept' (if needed)
|
|
1163
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
1164
|
+
# HTTP header 'Content-Type'
|
|
1165
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
1166
|
+
if !content_type.nil?
|
|
1167
|
+
header_params['Content-Type'] = content_type
|
|
1168
|
+
end
|
|
1169
|
+
|
|
1170
|
+
# form parameters
|
|
1171
|
+
form_params = opts[:form_params] || {}
|
|
1172
|
+
|
|
1173
|
+
# http body (model)
|
|
1174
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'custom_color_themes_settings_request_dto'])
|
|
1175
|
+
|
|
1176
|
+
# return_type
|
|
1177
|
+
return_type = opts[:debug_return_type] || 'CustomColorThemesSettingsWrapper'
|
|
1178
|
+
|
|
1179
|
+
# auth_names
|
|
1180
|
+
auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
|
|
1181
|
+
|
|
1182
|
+
new_options = opts.merge(
|
|
1183
|
+
:operation => :"Settings::CommonSettingsApi.save_portal_color_theme",
|
|
1184
|
+
:header_params => header_params,
|
|
1185
|
+
:query_params => query_params,
|
|
1186
|
+
:form_params => form_params,
|
|
1187
|
+
:body => post_body,
|
|
1188
|
+
:auth_names => auth_names,
|
|
1189
|
+
:return_type => return_type
|
|
1190
|
+
)
|
|
1191
|
+
|
|
1192
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
|
|
1193
|
+
if @api_client.config.debugging
|
|
1194
|
+
@api_client.config.logger.debug "API called: Settings::CommonSettingsApi#save_portal_color_theme\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1195
|
+
end
|
|
1196
|
+
return data, status_code, headers
|
|
1197
|
+
end
|
|
1198
|
+
|
|
1199
|
+
# Set the AI access settings
|
|
1200
|
+
# Turns AI functionality (chat, agents, vectorization) on or off for the whole portal; AI is enabled by default. Requires Owner or DocSpaceAdmin (the EditPortalSettings permission); every other caller is refused. Disabling it immediately hides the AI Agents folder from root folder listings, makes AI status checks report disabled, and makes AI chat endpoints unreachable for every user on the tenant, not only the caller. This is a mutating, idempotent, portal-wide call, and the change is pushed to already-connected clients over the real-time notification hub rather than waiting for their next request. It returns the saved setting.
|
|
1201
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/set-tenant-ai-access-settings/
|
|
1202
|
+
# @param [Hash] opts the optional parameters
|
|
1203
|
+
# @option opts [TenantAiAccessSettingsRequestDto] :tenant_ai_access_settings_request_dto
|
|
1204
|
+
# @return [TenantAiAccessSettingsWrapper]
|
|
1205
|
+
def set_tenant_ai_access_settings(opts = {})
|
|
1206
|
+
data, _status_code, _headers = set_tenant_ai_access_settings_with_http_info(opts)
|
|
1207
|
+
data
|
|
1208
|
+
end
|
|
1209
|
+
|
|
1210
|
+
# Set the AI access settings
|
|
1211
|
+
# Turns AI functionality (chat, agents, vectorization) on or off for the whole portal; AI is enabled by default. Requires Owner or DocSpaceAdmin (the EditPortalSettings permission); every other caller is refused. Disabling it immediately hides the AI Agents folder from root folder listings, makes AI status checks report disabled, and makes AI chat endpoints unreachable for every user on the tenant, not only the caller. This is a mutating, idempotent, portal-wide call, and the change is pushed to already-connected clients over the real-time notification hub rather than waiting for their next request. It returns the saved setting.
|
|
1212
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/set-tenant-ai-access-settings/
|
|
1213
|
+
# @param [Hash] opts the optional parameters
|
|
1214
|
+
# @option opts [TenantAiAccessSettingsRequestDto] :tenant_ai_access_settings_request_dto
|
|
1215
|
+
# @return [Array<(TenantAiAccessSettingsWrapper, Integer, Hash)>] TenantAiAccessSettingsWrapper data, response status code and response headers
|
|
1216
|
+
def set_tenant_ai_access_settings_with_http_info(opts = {})
|
|
1217
|
+
if @api_client.config.debugging
|
|
1218
|
+
@api_client.config.logger.debug 'Calling API: Settings::CommonSettingsApi.set_tenant_ai_access_settings ...'
|
|
1219
|
+
end
|
|
1220
|
+
# resource path
|
|
1221
|
+
local_var_path = '/api/2.0/settings/ai-access'
|
|
1222
|
+
|
|
1223
|
+
# query parameters
|
|
1224
|
+
query_params = opts[:query_params] || {}
|
|
1225
|
+
|
|
1226
|
+
# header parameters
|
|
1227
|
+
header_params = opts[:header_params] || {}
|
|
1228
|
+
# HTTP header 'Accept' (if needed)
|
|
1229
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
1230
|
+
# HTTP header 'Content-Type'
|
|
1231
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
1232
|
+
if !content_type.nil?
|
|
1233
|
+
header_params['Content-Type'] = content_type
|
|
1234
|
+
end
|
|
1235
|
+
|
|
1236
|
+
# form parameters
|
|
1237
|
+
form_params = opts[:form_params] || {}
|
|
1238
|
+
|
|
1239
|
+
# http body (model)
|
|
1240
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'tenant_ai_access_settings_request_dto'])
|
|
1241
|
+
|
|
1242
|
+
# return_type
|
|
1243
|
+
return_type = opts[:debug_return_type] || 'TenantAiAccessSettingsWrapper'
|
|
1244
|
+
|
|
1245
|
+
# auth_names
|
|
1246
|
+
auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
|
|
1247
|
+
|
|
1248
|
+
new_options = opts.merge(
|
|
1249
|
+
:operation => :"Settings::CommonSettingsApi.set_tenant_ai_access_settings",
|
|
1250
|
+
:header_params => header_params,
|
|
1251
|
+
:query_params => query_params,
|
|
1252
|
+
:form_params => form_params,
|
|
1253
|
+
:body => post_body,
|
|
1254
|
+
:auth_names => auth_names,
|
|
1255
|
+
:return_type => return_type
|
|
1256
|
+
)
|
|
1257
|
+
|
|
1258
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
1259
|
+
if @api_client.config.debugging
|
|
1260
|
+
@api_client.config.logger.debug "API called: Settings::CommonSettingsApi#set_tenant_ai_access_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1261
|
+
end
|
|
1262
|
+
return data, status_code, headers
|
|
1263
|
+
end
|
|
1264
|
+
|
|
1265
|
+
# Update the email activation settings
|
|
1266
|
+
# Updates the current user's own preference for whether the email confirmation prompt is displayed on their account. Requires an authenticated session; every role may change its own setting, and the change never affects any other user. This is a mutating, idempotent call. It returns the settings exactly as submitted, without validating them against the account's actual email confirmation state, so `show` can be set to `true` even after the address is already confirmed.
|
|
1267
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/update-email-activation-settings/
|
|
1268
|
+
# @param [Hash] opts the optional parameters
|
|
1269
|
+
# @option opts [EmailActivationSettingsRequestDto] :email_activation_settings_request_dto
|
|
1270
|
+
# @return [EmailActivationSettingsWrapper]
|
|
1271
|
+
def update_email_activation_settings(opts = {})
|
|
1272
|
+
data, _status_code, _headers = update_email_activation_settings_with_http_info(opts)
|
|
1273
|
+
data
|
|
1274
|
+
end
|
|
1275
|
+
|
|
1276
|
+
# Update the email activation settings
|
|
1277
|
+
# Updates the current user's own preference for whether the email confirmation prompt is displayed on their account. Requires an authenticated session; every role may change its own setting, and the change never affects any other user. This is a mutating, idempotent call. It returns the settings exactly as submitted, without validating them against the account's actual email confirmation state, so `show` can be set to `true` even after the address is already confirmed.
|
|
1278
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/update-email-activation-settings/
|
|
1279
|
+
# @param [Hash] opts the optional parameters
|
|
1280
|
+
# @option opts [EmailActivationSettingsRequestDto] :email_activation_settings_request_dto
|
|
1281
|
+
# @return [Array<(EmailActivationSettingsWrapper, Integer, Hash)>] EmailActivationSettingsWrapper data, response status code and response headers
|
|
1282
|
+
def update_email_activation_settings_with_http_info(opts = {})
|
|
1283
|
+
if @api_client.config.debugging
|
|
1284
|
+
@api_client.config.logger.debug 'Calling API: Settings::CommonSettingsApi.update_email_activation_settings ...'
|
|
1285
|
+
end
|
|
1286
|
+
# resource path
|
|
1287
|
+
local_var_path = '/api/2.0/settings/emailactivation'
|
|
1288
|
+
|
|
1289
|
+
# query parameters
|
|
1290
|
+
query_params = opts[:query_params] || {}
|
|
1291
|
+
|
|
1292
|
+
# header parameters
|
|
1293
|
+
header_params = opts[:header_params] || {}
|
|
1294
|
+
# HTTP header 'Accept' (if needed)
|
|
1295
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
1296
|
+
# HTTP header 'Content-Type'
|
|
1297
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
1298
|
+
if !content_type.nil?
|
|
1299
|
+
header_params['Content-Type'] = content_type
|
|
1300
|
+
end
|
|
1301
|
+
|
|
1302
|
+
# form parameters
|
|
1303
|
+
form_params = opts[:form_params] || {}
|
|
1304
|
+
|
|
1305
|
+
# http body (model)
|
|
1306
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'email_activation_settings_request_dto'])
|
|
1307
|
+
|
|
1308
|
+
# return_type
|
|
1309
|
+
return_type = opts[:debug_return_type] || 'EmailActivationSettingsWrapper'
|
|
1310
|
+
|
|
1311
|
+
# auth_names
|
|
1312
|
+
auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
|
|
1313
|
+
|
|
1314
|
+
new_options = opts.merge(
|
|
1315
|
+
:operation => :"Settings::CommonSettingsApi.update_email_activation_settings",
|
|
1316
|
+
:header_params => header_params,
|
|
1317
|
+
:query_params => query_params,
|
|
1318
|
+
:form_params => form_params,
|
|
1319
|
+
:body => post_body,
|
|
1320
|
+
:auth_names => auth_names,
|
|
1321
|
+
:return_type => return_type
|
|
1322
|
+
)
|
|
1323
|
+
|
|
1324
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
|
|
1325
|
+
if @api_client.config.debugging
|
|
1326
|
+
@api_client.config.logger.debug "API called: Settings::CommonSettingsApi#update_email_activation_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1327
|
+
end
|
|
1328
|
+
return data, status_code, headers
|
|
1329
|
+
end
|
|
1330
|
+
|
|
1331
|
+
# Update the user invitation settings
|
|
1332
|
+
# Sets whether the portal allows inviting new members and new guests. Requires Owner or DocSpaceAdmin (the EditPortalSettings permission). Disabling member or guest invitations only blocks creating new invitations going forward; it does not revoke links already issued or remove members already invited. This is a mutating, idempotent, portal-wide call. It returns the saved setting; read the current value at any time, including anonymously, from `GET api/2.0/settings/invitationsettings`.
|
|
1333
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/update-invitation-settings/
|
|
1334
|
+
# @param [Hash] opts the optional parameters
|
|
1335
|
+
# @option opts [TenantUserInvitationSettingsRequestDto] :tenant_user_invitation_settings_request_dto
|
|
1336
|
+
# @return [TenantUserInvitationSettingsWrapper]
|
|
1337
|
+
def update_invitation_settings(opts = {})
|
|
1338
|
+
data, _status_code, _headers = update_invitation_settings_with_http_info(opts)
|
|
1339
|
+
data
|
|
1340
|
+
end
|
|
1341
|
+
|
|
1342
|
+
# Update the user invitation settings
|
|
1343
|
+
# Sets whether the portal allows inviting new members and new guests. Requires Owner or DocSpaceAdmin (the EditPortalSettings permission). Disabling member or guest invitations only blocks creating new invitations going forward; it does not revoke links already issued or remove members already invited. This is a mutating, idempotent, portal-wide call. It returns the saved setting; read the current value at any time, including anonymously, from `GET api/2.0/settings/invitationsettings`.
|
|
1344
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/update-invitation-settings/
|
|
1345
|
+
# @param [Hash] opts the optional parameters
|
|
1346
|
+
# @option opts [TenantUserInvitationSettingsRequestDto] :tenant_user_invitation_settings_request_dto
|
|
1347
|
+
# @return [Array<(TenantUserInvitationSettingsWrapper, Integer, Hash)>] TenantUserInvitationSettingsWrapper data, response status code and response headers
|
|
1348
|
+
def update_invitation_settings_with_http_info(opts = {})
|
|
1349
|
+
if @api_client.config.debugging
|
|
1350
|
+
@api_client.config.logger.debug 'Calling API: Settings::CommonSettingsApi.update_invitation_settings ...'
|
|
1351
|
+
end
|
|
1352
|
+
# resource path
|
|
1353
|
+
local_var_path = '/api/2.0/settings/invitationsettings'
|
|
1354
|
+
|
|
1355
|
+
# query parameters
|
|
1356
|
+
query_params = opts[:query_params] || {}
|
|
1357
|
+
|
|
1358
|
+
# header parameters
|
|
1359
|
+
header_params = opts[:header_params] || {}
|
|
1360
|
+
# HTTP header 'Accept' (if needed)
|
|
1361
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
1362
|
+
# HTTP header 'Content-Type'
|
|
1363
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
1364
|
+
if !content_type.nil?
|
|
1365
|
+
header_params['Content-Type'] = content_type
|
|
1366
|
+
end
|
|
1367
|
+
|
|
1368
|
+
# form parameters
|
|
1369
|
+
form_params = opts[:form_params] || {}
|
|
1370
|
+
|
|
1371
|
+
# http body (model)
|
|
1372
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'tenant_user_invitation_settings_request_dto'])
|
|
1373
|
+
|
|
1374
|
+
# return_type
|
|
1375
|
+
return_type = opts[:debug_return_type] || 'TenantUserInvitationSettingsWrapper'
|
|
1376
|
+
|
|
1377
|
+
# auth_names
|
|
1378
|
+
auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
|
|
1379
|
+
|
|
1380
|
+
new_options = opts.merge(
|
|
1381
|
+
:operation => :"Settings::CommonSettingsApi.update_invitation_settings",
|
|
1382
|
+
:header_params => header_params,
|
|
1383
|
+
:query_params => query_params,
|
|
1384
|
+
:form_params => form_params,
|
|
1385
|
+
:body => post_body,
|
|
1386
|
+
:auth_names => auth_names,
|
|
1387
|
+
:return_type => return_type
|
|
1388
|
+
)
|
|
1389
|
+
|
|
1390
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
|
|
1391
|
+
if @api_client.config.debugging
|
|
1392
|
+
@api_client.config.logger.debug "API called: Settings::CommonSettingsApi#update_invitation_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1393
|
+
end
|
|
1394
|
+
return data, status_code, headers
|
|
1395
|
+
end
|
|
1396
|
+
end
|
|
1397
|
+
end
|
|
1398
|
+
end
|