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,1112 @@
|
|
|
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 RebrandingApi
|
|
21
|
+
attr_accessor :api_client
|
|
22
|
+
|
|
23
|
+
def initialize(api_client = ApiClient.default)
|
|
24
|
+
@api_client = api_client
|
|
25
|
+
end
|
|
26
|
+
# Delete the additional white label settings
|
|
27
|
+
# Discards the resource flags stored for the installation and brings back the built-in set, so the sample documents, the Help Center link, the Feedback and Support link, the user forum, the video guides and the license agreements are offered as they are out of the box. Requires a DocSpace administrator and a server installation with unrestricted space access; on a SaaS portal the call is refused. Unlike `POST api/2.0/settings/rebranding/additional` it does not need a plan that includes customization, so an installation whose subscription no longer covers it can still be reset. The call is destructive for the stored flags, which have to be set again to come back, and it is idempotent. Instead of a flag it answers the set that is now in effect, so no follow-up read is needed. The reset is installation-wide and reaches every portal, and it leaves the visibility of the About page alone. The company details are reset separately by `DELETE api/2.0/settings/rebranding/company`.
|
|
28
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/delete-additional-white-label-settings/
|
|
29
|
+
# @param [Hash] opts the optional parameters
|
|
30
|
+
# @return [AdditionalResourcesWrapper]
|
|
31
|
+
def delete_additional_white_label_settings(opts = {})
|
|
32
|
+
data, _status_code, _headers = delete_additional_white_label_settings_with_http_info(opts)
|
|
33
|
+
data
|
|
34
|
+
end
|
|
35
|
+
|
|
36
|
+
# Delete the additional white label settings
|
|
37
|
+
# Discards the resource flags stored for the installation and brings back the built-in set, so the sample documents, the Help Center link, the Feedback and Support link, the user forum, the video guides and the license agreements are offered as they are out of the box. Requires a DocSpace administrator and a server installation with unrestricted space access; on a SaaS portal the call is refused. Unlike `POST api/2.0/settings/rebranding/additional` it does not need a plan that includes customization, so an installation whose subscription no longer covers it can still be reset. The call is destructive for the stored flags, which have to be set again to come back, and it is idempotent. Instead of a flag it answers the set that is now in effect, so no follow-up read is needed. The reset is installation-wide and reaches every portal, and it leaves the visibility of the About page alone. The company details are reset separately by `DELETE api/2.0/settings/rebranding/company`.
|
|
38
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/delete-additional-white-label-settings/
|
|
39
|
+
# @param [Hash] opts the optional parameters
|
|
40
|
+
# @return [Array<(AdditionalResourcesWrapper, Integer, Hash)>] AdditionalResourcesWrapper data, response status code and response headers
|
|
41
|
+
def delete_additional_white_label_settings_with_http_info(opts = {})
|
|
42
|
+
if @api_client.config.debugging
|
|
43
|
+
@api_client.config.logger.debug 'Calling API: Settings::RebrandingApi.delete_additional_white_label_settings ...'
|
|
44
|
+
end
|
|
45
|
+
# resource path
|
|
46
|
+
local_var_path = '/api/2.0/settings/rebranding/additional'
|
|
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] || 'AdditionalResourcesWrapper'
|
|
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::RebrandingApi.delete_additional_white_label_settings",
|
|
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(:DELETE, local_var_path, new_options)
|
|
79
|
+
if @api_client.config.debugging
|
|
80
|
+
@api_client.config.logger.debug "API called: Settings::RebrandingApi#delete_additional_white_label_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
81
|
+
end
|
|
82
|
+
return data, status_code, headers
|
|
83
|
+
end
|
|
84
|
+
|
|
85
|
+
# Delete the company white label settings
|
|
86
|
+
# Discards the company details stored for the installation and brings back the built-in ONLYOFFICE name, site, email, address and phone, so the About page and the notification letters print the original vendor again. Requires a DocSpace administrator and a server installation with unrestricted space access; on a SaaS portal the call is refused. Unlike `POST api/2.0/settings/rebranding/company` it does not need a plan that includes customization, so an installation whose subscription no longer covers it can still be reset. The call is destructive: the previous details are not kept anywhere and have to be entered again to come back. It is idempotent, and instead of a flag it answers the details that are now in effect, so no follow-up read is needed. The reset is installation-wide and reaches every portal. The help and support links are reset separately by `DELETE api/2.0/settings/rebranding/additional`, and the logos and the wordmark of a single portal by the restore operations under `api/2.0/settings/whitelabel`.
|
|
87
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/delete-company-white-label-settings/
|
|
88
|
+
# @param [Hash] opts the optional parameters
|
|
89
|
+
# @return [LicensorDetailsWrapper]
|
|
90
|
+
def delete_company_white_label_settings(opts = {})
|
|
91
|
+
data, _status_code, _headers = delete_company_white_label_settings_with_http_info(opts)
|
|
92
|
+
data
|
|
93
|
+
end
|
|
94
|
+
|
|
95
|
+
# Delete the company white label settings
|
|
96
|
+
# Discards the company details stored for the installation and brings back the built-in ONLYOFFICE name, site, email, address and phone, so the About page and the notification letters print the original vendor again. Requires a DocSpace administrator and a server installation with unrestricted space access; on a SaaS portal the call is refused. Unlike `POST api/2.0/settings/rebranding/company` it does not need a plan that includes customization, so an installation whose subscription no longer covers it can still be reset. The call is destructive: the previous details are not kept anywhere and have to be entered again to come back. It is idempotent, and instead of a flag it answers the details that are now in effect, so no follow-up read is needed. The reset is installation-wide and reaches every portal. The help and support links are reset separately by `DELETE api/2.0/settings/rebranding/additional`, and the logos and the wordmark of a single portal by the restore operations under `api/2.0/settings/whitelabel`.
|
|
97
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/delete-company-white-label-settings/
|
|
98
|
+
# @param [Hash] opts the optional parameters
|
|
99
|
+
# @return [Array<(LicensorDetailsWrapper, Integer, Hash)>] LicensorDetailsWrapper data, response status code and response headers
|
|
100
|
+
def delete_company_white_label_settings_with_http_info(opts = {})
|
|
101
|
+
if @api_client.config.debugging
|
|
102
|
+
@api_client.config.logger.debug 'Calling API: Settings::RebrandingApi.delete_company_white_label_settings ...'
|
|
103
|
+
end
|
|
104
|
+
# resource path
|
|
105
|
+
local_var_path = '/api/2.0/settings/rebranding/company'
|
|
106
|
+
|
|
107
|
+
# query parameters
|
|
108
|
+
query_params = opts[:query_params] || {}
|
|
109
|
+
|
|
110
|
+
# header parameters
|
|
111
|
+
header_params = opts[:header_params] || {}
|
|
112
|
+
# HTTP header 'Accept' (if needed)
|
|
113
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
114
|
+
|
|
115
|
+
# form parameters
|
|
116
|
+
form_params = opts[:form_params] || {}
|
|
117
|
+
|
|
118
|
+
# http body (model)
|
|
119
|
+
post_body = opts[:debug_body]
|
|
120
|
+
|
|
121
|
+
# return_type
|
|
122
|
+
return_type = opts[:debug_return_type] || 'LicensorDetailsWrapper'
|
|
123
|
+
|
|
124
|
+
# auth_names
|
|
125
|
+
auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
|
|
126
|
+
|
|
127
|
+
new_options = opts.merge(
|
|
128
|
+
:operation => :"Settings::RebrandingApi.delete_company_white_label_settings",
|
|
129
|
+
:header_params => header_params,
|
|
130
|
+
:query_params => query_params,
|
|
131
|
+
:form_params => form_params,
|
|
132
|
+
:body => post_body,
|
|
133
|
+
:auth_names => auth_names,
|
|
134
|
+
:return_type => return_type
|
|
135
|
+
)
|
|
136
|
+
|
|
137
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
|
|
138
|
+
if @api_client.config.debugging
|
|
139
|
+
@api_client.config.logger.debug "API called: Settings::RebrandingApi#delete_company_white_label_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
140
|
+
end
|
|
141
|
+
return data, status_code, headers
|
|
142
|
+
end
|
|
143
|
+
|
|
144
|
+
# Get the additional white label settings
|
|
145
|
+
# Returns which of the ONLYOFFICE help and community resources the interface may offer - the sample documents, the Help Center link, the Feedback and Support link, the user forum, the video guides and the license agreements - so a client can hide the entries that are switched off. Any authenticated user may call it; no administrator permission is required, and a portal whose payment has lapsed is served as well. The call is read-only and idempotent. Each flag is `true` when the entry may be shown and `false` when it must be hidden, and `isDefault` tells whether the whole set is still the built-in one. The flags are installation-wide, so every portal of a server installation reports the same ones. They say nothing about the caller's own permissions, and the addresses behind the entries are not part of the answer. Change the flags with `POST api/2.0/settings/rebranding/additional` and reset them with `DELETE api/2.0/settings/rebranding/additional`.
|
|
146
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-additional-white-label-settings/
|
|
147
|
+
# @param [Hash] opts the optional parameters
|
|
148
|
+
# @return [AdditionalWhiteLabelSettingsWrapper]
|
|
149
|
+
def get_additional_white_label_settings(opts = {})
|
|
150
|
+
data, _status_code, _headers = get_additional_white_label_settings_with_http_info(opts)
|
|
151
|
+
data
|
|
152
|
+
end
|
|
153
|
+
|
|
154
|
+
# Get the additional white label settings
|
|
155
|
+
# Returns which of the ONLYOFFICE help and community resources the interface may offer - the sample documents, the Help Center link, the Feedback and Support link, the user forum, the video guides and the license agreements - so a client can hide the entries that are switched off. Any authenticated user may call it; no administrator permission is required, and a portal whose payment has lapsed is served as well. The call is read-only and idempotent. Each flag is `true` when the entry may be shown and `false` when it must be hidden, and `isDefault` tells whether the whole set is still the built-in one. The flags are installation-wide, so every portal of a server installation reports the same ones. They say nothing about the caller's own permissions, and the addresses behind the entries are not part of the answer. Change the flags with `POST api/2.0/settings/rebranding/additional` and reset them with `DELETE api/2.0/settings/rebranding/additional`.
|
|
156
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-additional-white-label-settings/
|
|
157
|
+
# @param [Hash] opts the optional parameters
|
|
158
|
+
# @return [Array<(AdditionalWhiteLabelSettingsWrapper, Integer, Hash)>] AdditionalWhiteLabelSettingsWrapper data, response status code and response headers
|
|
159
|
+
def get_additional_white_label_settings_with_http_info(opts = {})
|
|
160
|
+
if @api_client.config.debugging
|
|
161
|
+
@api_client.config.logger.debug 'Calling API: Settings::RebrandingApi.get_additional_white_label_settings ...'
|
|
162
|
+
end
|
|
163
|
+
# resource path
|
|
164
|
+
local_var_path = '/api/2.0/settings/rebranding/additional'
|
|
165
|
+
|
|
166
|
+
# query parameters
|
|
167
|
+
query_params = opts[:query_params] || {}
|
|
168
|
+
|
|
169
|
+
# header parameters
|
|
170
|
+
header_params = opts[:header_params] || {}
|
|
171
|
+
# HTTP header 'Accept' (if needed)
|
|
172
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
173
|
+
|
|
174
|
+
# form parameters
|
|
175
|
+
form_params = opts[:form_params] || {}
|
|
176
|
+
|
|
177
|
+
# http body (model)
|
|
178
|
+
post_body = opts[:debug_body]
|
|
179
|
+
|
|
180
|
+
# return_type
|
|
181
|
+
return_type = opts[:debug_return_type] || 'AdditionalWhiteLabelSettingsWrapper'
|
|
182
|
+
|
|
183
|
+
# auth_names
|
|
184
|
+
auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
|
|
185
|
+
|
|
186
|
+
new_options = opts.merge(
|
|
187
|
+
:operation => :"Settings::RebrandingApi.get_additional_white_label_settings",
|
|
188
|
+
:header_params => header_params,
|
|
189
|
+
:query_params => query_params,
|
|
190
|
+
:form_params => form_params,
|
|
191
|
+
:body => post_body,
|
|
192
|
+
:auth_names => auth_names,
|
|
193
|
+
:return_type => return_type
|
|
194
|
+
)
|
|
195
|
+
|
|
196
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
197
|
+
if @api_client.config.debugging
|
|
198
|
+
@api_client.config.logger.debug "API called: Settings::RebrandingApi#get_additional_white_label_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
199
|
+
end
|
|
200
|
+
return data, status_code, headers
|
|
201
|
+
end
|
|
202
|
+
|
|
203
|
+
# Get the company white label settings
|
|
204
|
+
# Returns the company details that the About page and the notification letters print as the vendor, in the form the settings interface edits them. Any authenticated user may call it; no administrator permission is required, and a portal whose payment has lapsed is served as well. The call is read-only and idempotent. Alongside the stored fields the answer carries `isLicensor`, which tells whether these details belong to the vendor of the product itself, and `isDefault`, which tells whether they are still the built-in ONLYOFFICE ones. The values are installation-wide, so every portal of a server installation reports the same ones. The response is revalidatable: it carries `Last-Modified`, and sending that value back in `If-Modified-Since` yields an empty body while the details have not changed, which makes polling cheap. For the About page, where the built-in vendor has to be shown next to a reseller, use `GET api/2.0/settings/companywhitelabel` instead. Change the details with `POST api/2.0/settings/rebranding/company`.
|
|
205
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-company-white-label-settings/
|
|
206
|
+
# @param [Hash] opts the optional parameters
|
|
207
|
+
# @return [CompanyWhiteLabelSettingsWrapper]
|
|
208
|
+
def get_company_white_label_settings(opts = {})
|
|
209
|
+
data, _status_code, _headers = get_company_white_label_settings_with_http_info(opts)
|
|
210
|
+
data
|
|
211
|
+
end
|
|
212
|
+
|
|
213
|
+
# Get the company white label settings
|
|
214
|
+
# Returns the company details that the About page and the notification letters print as the vendor, in the form the settings interface edits them. Any authenticated user may call it; no administrator permission is required, and a portal whose payment has lapsed is served as well. The call is read-only and idempotent. Alongside the stored fields the answer carries `isLicensor`, which tells whether these details belong to the vendor of the product itself, and `isDefault`, which tells whether they are still the built-in ONLYOFFICE ones. The values are installation-wide, so every portal of a server installation reports the same ones. The response is revalidatable: it carries `Last-Modified`, and sending that value back in `If-Modified-Since` yields an empty body while the details have not changed, which makes polling cheap. For the About page, where the built-in vendor has to be shown next to a reseller, use `GET api/2.0/settings/companywhitelabel` instead. Change the details with `POST api/2.0/settings/rebranding/company`.
|
|
215
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-company-white-label-settings/
|
|
216
|
+
# @param [Hash] opts the optional parameters
|
|
217
|
+
# @return [Array<(CompanyWhiteLabelSettingsWrapper, Integer, Hash)>] CompanyWhiteLabelSettingsWrapper data, response status code and response headers
|
|
218
|
+
def get_company_white_label_settings_with_http_info(opts = {})
|
|
219
|
+
if @api_client.config.debugging
|
|
220
|
+
@api_client.config.logger.debug 'Calling API: Settings::RebrandingApi.get_company_white_label_settings ...'
|
|
221
|
+
end
|
|
222
|
+
# resource path
|
|
223
|
+
local_var_path = '/api/2.0/settings/rebranding/company'
|
|
224
|
+
|
|
225
|
+
# query parameters
|
|
226
|
+
query_params = opts[:query_params] || {}
|
|
227
|
+
|
|
228
|
+
# header parameters
|
|
229
|
+
header_params = opts[:header_params] || {}
|
|
230
|
+
# HTTP header 'Accept' (if needed)
|
|
231
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
232
|
+
|
|
233
|
+
# form parameters
|
|
234
|
+
form_params = opts[:form_params] || {}
|
|
235
|
+
|
|
236
|
+
# http body (model)
|
|
237
|
+
post_body = opts[:debug_body]
|
|
238
|
+
|
|
239
|
+
# return_type
|
|
240
|
+
return_type = opts[:debug_return_type] || 'CompanyWhiteLabelSettingsWrapper'
|
|
241
|
+
|
|
242
|
+
# auth_names
|
|
243
|
+
auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
|
|
244
|
+
|
|
245
|
+
new_options = opts.merge(
|
|
246
|
+
:operation => :"Settings::RebrandingApi.get_company_white_label_settings",
|
|
247
|
+
:header_params => header_params,
|
|
248
|
+
:query_params => query_params,
|
|
249
|
+
:form_params => form_params,
|
|
250
|
+
:body => post_body,
|
|
251
|
+
:auth_names => auth_names,
|
|
252
|
+
:return_type => return_type
|
|
253
|
+
)
|
|
254
|
+
|
|
255
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
256
|
+
if @api_client.config.debugging
|
|
257
|
+
@api_client.config.logger.debug "API called: Settings::RebrandingApi#get_company_white_label_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
258
|
+
end
|
|
259
|
+
return data, status_code, headers
|
|
260
|
+
end
|
|
261
|
+
|
|
262
|
+
# Check the white label availability
|
|
263
|
+
# Reports whether branding may be configured for the current portal at all, which is the check to make before offering the rebranding interface or calling any of the save operations under `api/2.0/settings/whitelabel`. Requires a DocSpace administrator. The call is read-only and idempotent. The answer is `true` only when both conditions hold: the branding section is not switched off in the installation configuration, and the portal's current plan includes customization. It comes back as `false` on a plan without customization, which is exactly the case in which `POST api/2.0/settings/whitelabel/logos/save`, `POST api/2.0/settings/whitelabel/logos/savefromfiles` and `POST api/2.0/settings/whitelabel/logotext/save` are refused as payment required. The restore operations do not depend on this flag and stay available, so a portal that loses branding can still be reset to the built-in logos and wordmark. The flag says nothing about the installation-wide default branding, which additionally needs a server installation with unrestricted space access, and nothing about the company details and help links under `api/2.0/settings/rebranding`.
|
|
264
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-enable-whitelabel/
|
|
265
|
+
# @param [Hash] opts the optional parameters
|
|
266
|
+
# @return [BooleanWrapper]
|
|
267
|
+
def get_enable_whitelabel(opts = {})
|
|
268
|
+
data, _status_code, _headers = get_enable_whitelabel_with_http_info(opts)
|
|
269
|
+
data
|
|
270
|
+
end
|
|
271
|
+
|
|
272
|
+
# Check the white label availability
|
|
273
|
+
# Reports whether branding may be configured for the current portal at all, which is the check to make before offering the rebranding interface or calling any of the save operations under `api/2.0/settings/whitelabel`. Requires a DocSpace administrator. The call is read-only and idempotent. The answer is `true` only when both conditions hold: the branding section is not switched off in the installation configuration, and the portal's current plan includes customization. It comes back as `false` on a plan without customization, which is exactly the case in which `POST api/2.0/settings/whitelabel/logos/save`, `POST api/2.0/settings/whitelabel/logos/savefromfiles` and `POST api/2.0/settings/whitelabel/logotext/save` are refused as payment required. The restore operations do not depend on this flag and stay available, so a portal that loses branding can still be reset to the built-in logos and wordmark. The flag says nothing about the installation-wide default branding, which additionally needs a server installation with unrestricted space access, and nothing about the company details and help links under `api/2.0/settings/rebranding`.
|
|
274
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-enable-whitelabel/
|
|
275
|
+
# @param [Hash] opts the optional parameters
|
|
276
|
+
# @return [Array<(BooleanWrapper, Integer, Hash)>] BooleanWrapper data, response status code and response headers
|
|
277
|
+
def get_enable_whitelabel_with_http_info(opts = {})
|
|
278
|
+
if @api_client.config.debugging
|
|
279
|
+
@api_client.config.logger.debug 'Calling API: Settings::RebrandingApi.get_enable_whitelabel ...'
|
|
280
|
+
end
|
|
281
|
+
# resource path
|
|
282
|
+
local_var_path = '/api/2.0/settings/enablewhitelabel'
|
|
283
|
+
|
|
284
|
+
# query parameters
|
|
285
|
+
query_params = opts[:query_params] || {}
|
|
286
|
+
|
|
287
|
+
# header parameters
|
|
288
|
+
header_params = opts[:header_params] || {}
|
|
289
|
+
# HTTP header 'Accept' (if needed)
|
|
290
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
291
|
+
|
|
292
|
+
# form parameters
|
|
293
|
+
form_params = opts[:form_params] || {}
|
|
294
|
+
|
|
295
|
+
# http body (model)
|
|
296
|
+
post_body = opts[:debug_body]
|
|
297
|
+
|
|
298
|
+
# return_type
|
|
299
|
+
return_type = opts[:debug_return_type] || 'BooleanWrapper'
|
|
300
|
+
|
|
301
|
+
# auth_names
|
|
302
|
+
auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
|
|
303
|
+
|
|
304
|
+
new_options = opts.merge(
|
|
305
|
+
:operation => :"Settings::RebrandingApi.get_enable_whitelabel",
|
|
306
|
+
:header_params => header_params,
|
|
307
|
+
:query_params => query_params,
|
|
308
|
+
:form_params => form_params,
|
|
309
|
+
:body => post_body,
|
|
310
|
+
:auth_names => auth_names,
|
|
311
|
+
:return_type => return_type
|
|
312
|
+
)
|
|
313
|
+
|
|
314
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
315
|
+
if @api_client.config.debugging
|
|
316
|
+
@api_client.config.logger.debug "API called: Settings::RebrandingApi#get_enable_whitelabel\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
317
|
+
end
|
|
318
|
+
return data, status_code, headers
|
|
319
|
+
end
|
|
320
|
+
|
|
321
|
+
# Check the default logo text
|
|
322
|
+
# Reports whether the current portal still uses the built-in wordmark or one that was stored for it, which is what an interface needs to decide whether a Restore action applies to the text. Requires a DocSpace administrator. The call is read-only and idempotent. The answer has the same shape as one entry of `GET api/2.0/settings/whitelabel/logos/isdefault`, with `name` fixed to `logotext` and `default` set to `true` while no text has been stored and to `false` once one has. Because `GET api/2.0/settings/whitelabel/logotext` falls back to `ONLYOFFICE` when nothing is stored, this operation is the only way to tell a portal that deliberately kept the built-in wordmark from one that saved the very same text. Pass `isDefault=true` to inspect the installation-wide default branding instead of this portal's. The flag turns back to `true` after `PUT api/2.0/settings/whitelabel/logotext/restore`, and to `false` after `POST api/2.0/settings/whitelabel/logotext/save`. Saving the built-in wordmark itself counts as clearing the setting, so the flag stays `true` in that case as well.
|
|
323
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-is-default-white-label-logo-text/
|
|
324
|
+
# @param [Hash] opts the optional parameters
|
|
325
|
+
# @option opts [Boolean] :is_dark Which theme the answer is filled in for: `true` fills the dark image only, `false` the light one only. Omitting it fills both, leaving the dark one empty for the slots that have no separate dark image.
|
|
326
|
+
# @option opts [Boolean] :is_default Whether the installation-wide default branding is addressed instead of this portal own. Writing the default branding is only allowed on a self-hosted installation; elsewhere it is refused with 403.
|
|
327
|
+
# @return [IsDefaultWhiteLabelLogosWrapper]
|
|
328
|
+
def get_is_default_white_label_logo_text(opts = {})
|
|
329
|
+
data, _status_code, _headers = get_is_default_white_label_logo_text_with_http_info(opts)
|
|
330
|
+
data
|
|
331
|
+
end
|
|
332
|
+
|
|
333
|
+
# Check the default logo text
|
|
334
|
+
# Reports whether the current portal still uses the built-in wordmark or one that was stored for it, which is what an interface needs to decide whether a Restore action applies to the text. Requires a DocSpace administrator. The call is read-only and idempotent. The answer has the same shape as one entry of `GET api/2.0/settings/whitelabel/logos/isdefault`, with `name` fixed to `logotext` and `default` set to `true` while no text has been stored and to `false` once one has. Because `GET api/2.0/settings/whitelabel/logotext` falls back to `ONLYOFFICE` when nothing is stored, this operation is the only way to tell a portal that deliberately kept the built-in wordmark from one that saved the very same text. Pass `isDefault=true` to inspect the installation-wide default branding instead of this portal's. The flag turns back to `true` after `PUT api/2.0/settings/whitelabel/logotext/restore`, and to `false` after `POST api/2.0/settings/whitelabel/logotext/save`. Saving the built-in wordmark itself counts as clearing the setting, so the flag stays `true` in that case as well.
|
|
335
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-is-default-white-label-logo-text/
|
|
336
|
+
# @param [Hash] opts the optional parameters
|
|
337
|
+
# @option opts [Boolean] :is_dark Which theme the answer is filled in for: `true` fills the dark image only, `false` the light one only. Omitting it fills both, leaving the dark one empty for the slots that have no separate dark image.
|
|
338
|
+
# @option opts [Boolean] :is_default Whether the installation-wide default branding is addressed instead of this portal own. Writing the default branding is only allowed on a self-hosted installation; elsewhere it is refused with 403.
|
|
339
|
+
# @return [Array<(IsDefaultWhiteLabelLogosWrapper, Integer, Hash)>] IsDefaultWhiteLabelLogosWrapper data, response status code and response headers
|
|
340
|
+
def get_is_default_white_label_logo_text_with_http_info(opts = {})
|
|
341
|
+
if @api_client.config.debugging
|
|
342
|
+
@api_client.config.logger.debug 'Calling API: Settings::RebrandingApi.get_is_default_white_label_logo_text ...'
|
|
343
|
+
end
|
|
344
|
+
# resource path
|
|
345
|
+
local_var_path = '/api/2.0/settings/whitelabel/logotext/isdefault'
|
|
346
|
+
|
|
347
|
+
# query parameters
|
|
348
|
+
query_params = opts[:query_params] || {}
|
|
349
|
+
query_params[:'isDark'] = opts[:'is_dark'] if !opts[:'is_dark'].nil?
|
|
350
|
+
query_params[:'isDefault'] = opts[:'is_default'] if !opts[:'is_default'].nil?
|
|
351
|
+
|
|
352
|
+
# header parameters
|
|
353
|
+
header_params = opts[:header_params] || {}
|
|
354
|
+
# HTTP header 'Accept' (if needed)
|
|
355
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
356
|
+
|
|
357
|
+
# form parameters
|
|
358
|
+
form_params = opts[:form_params] || {}
|
|
359
|
+
|
|
360
|
+
# http body (model)
|
|
361
|
+
post_body = opts[:debug_body]
|
|
362
|
+
|
|
363
|
+
# return_type
|
|
364
|
+
return_type = opts[:debug_return_type] || 'IsDefaultWhiteLabelLogosWrapper'
|
|
365
|
+
|
|
366
|
+
# auth_names
|
|
367
|
+
auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
|
|
368
|
+
|
|
369
|
+
new_options = opts.merge(
|
|
370
|
+
:operation => :"Settings::RebrandingApi.get_is_default_white_label_logo_text",
|
|
371
|
+
:header_params => header_params,
|
|
372
|
+
:query_params => query_params,
|
|
373
|
+
:form_params => form_params,
|
|
374
|
+
:body => post_body,
|
|
375
|
+
:auth_names => auth_names,
|
|
376
|
+
:return_type => return_type
|
|
377
|
+
)
|
|
378
|
+
|
|
379
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
380
|
+
if @api_client.config.debugging
|
|
381
|
+
@api_client.config.logger.debug "API called: Settings::RebrandingApi#get_is_default_white_label_logo_text\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
382
|
+
end
|
|
383
|
+
return data, status_code, headers
|
|
384
|
+
end
|
|
385
|
+
|
|
386
|
+
# Check the default white label logos
|
|
387
|
+
# Reports, slot by slot, whether the current portal still shows the built-in image or a logo that was uploaded for it, which is what an interface needs to decide where a Restore action makes sense. Requires a DocSpace administrator; the URLs themselves are public and come from `GET api/2.0/settings/whitelabel/logos`, which needs no authentication. The call is read-only and idempotent. Every logo slot is returned, including the notification logo that the public list leaves out, so the result has one entry more than that list. An entry gives the stable slot name in `name` and `default` set to `true` while the slot has never been written, and to `false` once an image has been stored for it, whether for the light or for the dark theme. A slot goes back to `true` after `PUT api/2.0/settings/whitelabel/logos/restore`. Pass `isDefault=true` to inspect the installation-wide default branding instead of this portal's. The logo text is reported separately by `GET api/2.0/settings/whitelabel/logotext/isdefault`.
|
|
388
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-is-default-white-label-logos/
|
|
389
|
+
# @param [Hash] opts the optional parameters
|
|
390
|
+
# @option opts [Boolean] :is_dark Which theme the answer is filled in for: `true` fills the dark image only, `false` the light one only. Omitting it fills both, leaving the dark one empty for the slots that have no separate dark image.
|
|
391
|
+
# @option opts [Boolean] :is_default Whether the installation-wide default branding is addressed instead of this portal own. Writing the default branding is only allowed on a self-hosted installation; elsewhere it is refused with 403.
|
|
392
|
+
# @return [IsDefaultWhiteLabelLogosArrayWrapper]
|
|
393
|
+
def get_is_default_white_label_logos(opts = {})
|
|
394
|
+
data, _status_code, _headers = get_is_default_white_label_logos_with_http_info(opts)
|
|
395
|
+
data
|
|
396
|
+
end
|
|
397
|
+
|
|
398
|
+
# Check the default white label logos
|
|
399
|
+
# Reports, slot by slot, whether the current portal still shows the built-in image or a logo that was uploaded for it, which is what an interface needs to decide where a Restore action makes sense. Requires a DocSpace administrator; the URLs themselves are public and come from `GET api/2.0/settings/whitelabel/logos`, which needs no authentication. The call is read-only and idempotent. Every logo slot is returned, including the notification logo that the public list leaves out, so the result has one entry more than that list. An entry gives the stable slot name in `name` and `default` set to `true` while the slot has never been written, and to `false` once an image has been stored for it, whether for the light or for the dark theme. A slot goes back to `true` after `PUT api/2.0/settings/whitelabel/logos/restore`. Pass `isDefault=true` to inspect the installation-wide default branding instead of this portal's. The logo text is reported separately by `GET api/2.0/settings/whitelabel/logotext/isdefault`.
|
|
400
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-is-default-white-label-logos/
|
|
401
|
+
# @param [Hash] opts the optional parameters
|
|
402
|
+
# @option opts [Boolean] :is_dark Which theme the answer is filled in for: `true` fills the dark image only, `false` the light one only. Omitting it fills both, leaving the dark one empty for the slots that have no separate dark image.
|
|
403
|
+
# @option opts [Boolean] :is_default Whether the installation-wide default branding is addressed instead of this portal own. Writing the default branding is only allowed on a self-hosted installation; elsewhere it is refused with 403.
|
|
404
|
+
# @return [Array<(IsDefaultWhiteLabelLogosArrayWrapper, Integer, Hash)>] IsDefaultWhiteLabelLogosArrayWrapper data, response status code and response headers
|
|
405
|
+
def get_is_default_white_label_logos_with_http_info(opts = {})
|
|
406
|
+
if @api_client.config.debugging
|
|
407
|
+
@api_client.config.logger.debug 'Calling API: Settings::RebrandingApi.get_is_default_white_label_logos ...'
|
|
408
|
+
end
|
|
409
|
+
# resource path
|
|
410
|
+
local_var_path = '/api/2.0/settings/whitelabel/logos/isdefault'
|
|
411
|
+
|
|
412
|
+
# query parameters
|
|
413
|
+
query_params = opts[:query_params] || {}
|
|
414
|
+
query_params[:'isDark'] = opts[:'is_dark'] if !opts[:'is_dark'].nil?
|
|
415
|
+
query_params[:'isDefault'] = opts[:'is_default'] if !opts[:'is_default'].nil?
|
|
416
|
+
|
|
417
|
+
# header parameters
|
|
418
|
+
header_params = opts[:header_params] || {}
|
|
419
|
+
# HTTP header 'Accept' (if needed)
|
|
420
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
421
|
+
|
|
422
|
+
# form parameters
|
|
423
|
+
form_params = opts[:form_params] || {}
|
|
424
|
+
|
|
425
|
+
# http body (model)
|
|
426
|
+
post_body = opts[:debug_body]
|
|
427
|
+
|
|
428
|
+
# return_type
|
|
429
|
+
return_type = opts[:debug_return_type] || 'IsDefaultWhiteLabelLogosArrayWrapper'
|
|
430
|
+
|
|
431
|
+
# auth_names
|
|
432
|
+
auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
|
|
433
|
+
|
|
434
|
+
new_options = opts.merge(
|
|
435
|
+
:operation => :"Settings::RebrandingApi.get_is_default_white_label_logos",
|
|
436
|
+
:header_params => header_params,
|
|
437
|
+
:query_params => query_params,
|
|
438
|
+
:form_params => form_params,
|
|
439
|
+
:body => post_body,
|
|
440
|
+
:auth_names => auth_names,
|
|
441
|
+
:return_type => return_type
|
|
442
|
+
)
|
|
443
|
+
|
|
444
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
445
|
+
if @api_client.config.debugging
|
|
446
|
+
@api_client.config.logger.debug "API called: Settings::RebrandingApi#get_is_default_white_label_logos\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
447
|
+
end
|
|
448
|
+
return data, status_code, headers
|
|
449
|
+
end
|
|
450
|
+
|
|
451
|
+
# Get the licensor data
|
|
452
|
+
# Returns the licensor details - company name, site, support email, postal address and phone - that the About page and the notification letters print as the vendor of the installation. Any authenticated user may call it, as these details are shown in the interface to everyone; no administrator permission is required. The call is read-only and idempotent. The list holds the details currently in effect as its first item; when they have been replaced by a reseller and the replacement is not itself marked as the licensor, the built-in ONLYOFFICE details are appended as a second item, so a caller can print both the reseller and the original vendor. A single-item list therefore means that the current details are the only ones to show. The values are installation-wide rather than per-portal, so every portal of a server installation reports the same ones. The same data in the form the settings interface edits is served by `GET api/2.0/settings/rebranding/company`, and it is written by `POST api/2.0/settings/rebranding/company`.
|
|
453
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-licensor-data/
|
|
454
|
+
# @param [Hash] opts the optional parameters
|
|
455
|
+
# @return [LicensorDetailsArrayWrapper]
|
|
456
|
+
def get_licensor_data(opts = {})
|
|
457
|
+
data, _status_code, _headers = get_licensor_data_with_http_info(opts)
|
|
458
|
+
data
|
|
459
|
+
end
|
|
460
|
+
|
|
461
|
+
# Get the licensor data
|
|
462
|
+
# Returns the licensor details - company name, site, support email, postal address and phone - that the About page and the notification letters print as the vendor of the installation. Any authenticated user may call it, as these details are shown in the interface to everyone; no administrator permission is required. The call is read-only and idempotent. The list holds the details currently in effect as its first item; when they have been replaced by a reseller and the replacement is not itself marked as the licensor, the built-in ONLYOFFICE details are appended as a second item, so a caller can print both the reseller and the original vendor. A single-item list therefore means that the current details are the only ones to show. The values are installation-wide rather than per-portal, so every portal of a server installation reports the same ones. The same data in the form the settings interface edits is served by `GET api/2.0/settings/rebranding/company`, and it is written by `POST api/2.0/settings/rebranding/company`.
|
|
463
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-licensor-data/
|
|
464
|
+
# @param [Hash] opts the optional parameters
|
|
465
|
+
# @return [Array<(LicensorDetailsArrayWrapper, Integer, Hash)>] LicensorDetailsArrayWrapper data, response status code and response headers
|
|
466
|
+
def get_licensor_data_with_http_info(opts = {})
|
|
467
|
+
if @api_client.config.debugging
|
|
468
|
+
@api_client.config.logger.debug 'Calling API: Settings::RebrandingApi.get_licensor_data ...'
|
|
469
|
+
end
|
|
470
|
+
# resource path
|
|
471
|
+
local_var_path = '/api/2.0/settings/companywhitelabel'
|
|
472
|
+
|
|
473
|
+
# query parameters
|
|
474
|
+
query_params = opts[:query_params] || {}
|
|
475
|
+
|
|
476
|
+
# header parameters
|
|
477
|
+
header_params = opts[:header_params] || {}
|
|
478
|
+
# HTTP header 'Accept' (if needed)
|
|
479
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
480
|
+
|
|
481
|
+
# form parameters
|
|
482
|
+
form_params = opts[:form_params] || {}
|
|
483
|
+
|
|
484
|
+
# http body (model)
|
|
485
|
+
post_body = opts[:debug_body]
|
|
486
|
+
|
|
487
|
+
# return_type
|
|
488
|
+
return_type = opts[:debug_return_type] || 'LicensorDetailsArrayWrapper'
|
|
489
|
+
|
|
490
|
+
# auth_names
|
|
491
|
+
auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
|
|
492
|
+
|
|
493
|
+
new_options = opts.merge(
|
|
494
|
+
:operation => :"Settings::RebrandingApi.get_licensor_data",
|
|
495
|
+
:header_params => header_params,
|
|
496
|
+
:query_params => query_params,
|
|
497
|
+
:form_params => form_params,
|
|
498
|
+
:body => post_body,
|
|
499
|
+
:auth_names => auth_names,
|
|
500
|
+
:return_type => return_type
|
|
501
|
+
)
|
|
502
|
+
|
|
503
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
504
|
+
if @api_client.config.debugging
|
|
505
|
+
@api_client.config.logger.debug "API called: Settings::RebrandingApi#get_licensor_data\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
506
|
+
end
|
|
507
|
+
return data, status_code, headers
|
|
508
|
+
end
|
|
509
|
+
|
|
510
|
+
# Get the white label logo text
|
|
511
|
+
# Returns the wordmark the current portal prints next to or instead of a logo image, as a bare string rather than an object. Requires a DocSpace administrator, because this is the settings view of the value; the branding a login page needs is served by `GET api/2.0/settings/whitelabel/logos`, which needs no authentication. The call is read-only and idempotent. When nothing has been stored for the portal, the built-in `ONLYOFFICE` is returned, so the answer is never empty and cannot be used to tell a custom text from the default one - `GET api/2.0/settings/whitelabel/logotext/isdefault` answers that question. Pass `isDefault=true` to read the installation-wide default wordmark instead of this portal's; without it the portal's own value is returned even when the installation carries a different default. Change the text with `POST api/2.0/settings/whitelabel/logotext/save` and clear it with `PUT api/2.0/settings/whitelabel/logotext/restore`. The value is stored as it was typed, at most 40 characters long, and is not translated for the caller's language, so the same wordmark is returned for every user of the portal.
|
|
512
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-white-label-logo-text/
|
|
513
|
+
# @param [Hash] opts the optional parameters
|
|
514
|
+
# @option opts [Boolean] :is_dark Which theme the answer is filled in for: `true` fills the dark image only, `false` the light one only. Omitting it fills both, leaving the dark one empty for the slots that have no separate dark image.
|
|
515
|
+
# @option opts [Boolean] :is_default Whether the installation-wide default branding is addressed instead of this portal own. Writing the default branding is only allowed on a self-hosted installation; elsewhere it is refused with 403.
|
|
516
|
+
# @return [StringWrapper]
|
|
517
|
+
def get_white_label_logo_text(opts = {})
|
|
518
|
+
data, _status_code, _headers = get_white_label_logo_text_with_http_info(opts)
|
|
519
|
+
data
|
|
520
|
+
end
|
|
521
|
+
|
|
522
|
+
# Get the white label logo text
|
|
523
|
+
# Returns the wordmark the current portal prints next to or instead of a logo image, as a bare string rather than an object. Requires a DocSpace administrator, because this is the settings view of the value; the branding a login page needs is served by `GET api/2.0/settings/whitelabel/logos`, which needs no authentication. The call is read-only and idempotent. When nothing has been stored for the portal, the built-in `ONLYOFFICE` is returned, so the answer is never empty and cannot be used to tell a custom text from the default one - `GET api/2.0/settings/whitelabel/logotext/isdefault` answers that question. Pass `isDefault=true` to read the installation-wide default wordmark instead of this portal's; without it the portal's own value is returned even when the installation carries a different default. Change the text with `POST api/2.0/settings/whitelabel/logotext/save` and clear it with `PUT api/2.0/settings/whitelabel/logotext/restore`. The value is stored as it was typed, at most 40 characters long, and is not translated for the caller's language, so the same wordmark is returned for every user of the portal.
|
|
524
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-white-label-logo-text/
|
|
525
|
+
# @param [Hash] opts the optional parameters
|
|
526
|
+
# @option opts [Boolean] :is_dark Which theme the answer is filled in for: `true` fills the dark image only, `false` the light one only. Omitting it fills both, leaving the dark one empty for the slots that have no separate dark image.
|
|
527
|
+
# @option opts [Boolean] :is_default Whether the installation-wide default branding is addressed instead of this portal own. Writing the default branding is only allowed on a self-hosted installation; elsewhere it is refused with 403.
|
|
528
|
+
# @return [Array<(StringWrapper, Integer, Hash)>] StringWrapper data, response status code and response headers
|
|
529
|
+
def get_white_label_logo_text_with_http_info(opts = {})
|
|
530
|
+
if @api_client.config.debugging
|
|
531
|
+
@api_client.config.logger.debug 'Calling API: Settings::RebrandingApi.get_white_label_logo_text ...'
|
|
532
|
+
end
|
|
533
|
+
# resource path
|
|
534
|
+
local_var_path = '/api/2.0/settings/whitelabel/logotext'
|
|
535
|
+
|
|
536
|
+
# query parameters
|
|
537
|
+
query_params = opts[:query_params] || {}
|
|
538
|
+
query_params[:'isDark'] = opts[:'is_dark'] if !opts[:'is_dark'].nil?
|
|
539
|
+
query_params[:'isDefault'] = opts[:'is_default'] if !opts[:'is_default'].nil?
|
|
540
|
+
|
|
541
|
+
# header parameters
|
|
542
|
+
header_params = opts[:header_params] || {}
|
|
543
|
+
# HTTP header 'Accept' (if needed)
|
|
544
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
545
|
+
|
|
546
|
+
# form parameters
|
|
547
|
+
form_params = opts[:form_params] || {}
|
|
548
|
+
|
|
549
|
+
# http body (model)
|
|
550
|
+
post_body = opts[:debug_body]
|
|
551
|
+
|
|
552
|
+
# return_type
|
|
553
|
+
return_type = opts[:debug_return_type] || 'StringWrapper'
|
|
554
|
+
|
|
555
|
+
# auth_names
|
|
556
|
+
auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
|
|
557
|
+
|
|
558
|
+
new_options = opts.merge(
|
|
559
|
+
:operation => :"Settings::RebrandingApi.get_white_label_logo_text",
|
|
560
|
+
:header_params => header_params,
|
|
561
|
+
:query_params => query_params,
|
|
562
|
+
:form_params => form_params,
|
|
563
|
+
:body => post_body,
|
|
564
|
+
:auth_names => auth_names,
|
|
565
|
+
:return_type => return_type
|
|
566
|
+
)
|
|
567
|
+
|
|
568
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
569
|
+
if @api_client.config.debugging
|
|
570
|
+
@api_client.config.logger.debug "API called: Settings::RebrandingApi#get_white_label_logo_text\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
571
|
+
end
|
|
572
|
+
return data, status_code, headers
|
|
573
|
+
end
|
|
574
|
+
|
|
575
|
+
# Get the white label logos
|
|
576
|
+
# Lists the branding logo slots of the current portal together with the image URLs to render, which is what a login page, an editor or a mail template needs before any user is known. No authentication is required, and the portal is resolved from the address the request is made to. The call is read-only and idempotent. Each item carries the slot as a number in `type`, its stable name in `name`, the size the image is fitted to in `size` (`width` and `height` in pixels), and the URLs in `path`. When `isDark` is passed, only the matching theme is filled in, `light` for `false` and `dark` for `true`; when it is omitted both are filled in and `dark` comes back empty for the slots that have no separate dark image. The notification slot is not part of this list, as it is derived from the login-page logo and used only in letters. Pass `isDefault=true` to read the installation-wide default logos instead of this portal's. To learn which slots are still untouched use `GET api/2.0/settings/whitelabel/logos/isdefault`.
|
|
577
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-white-label-logos/
|
|
578
|
+
# @param [Hash] opts the optional parameters
|
|
579
|
+
# @option opts [Boolean] :is_dark Which theme the answer is filled in for: `true` fills the dark image only, `false` the light one only. Omitting it fills both, leaving the dark one empty for the slots that have no separate dark image.
|
|
580
|
+
# @option opts [Boolean] :is_default Whether the installation-wide default branding is addressed instead of this portal own. Writing the default branding is only allowed on a self-hosted installation; elsewhere it is refused with 403.
|
|
581
|
+
# @return [WhiteLabelItemArrayWrapper]
|
|
582
|
+
def get_white_label_logos(opts = {})
|
|
583
|
+
data, _status_code, _headers = get_white_label_logos_with_http_info(opts)
|
|
584
|
+
data
|
|
585
|
+
end
|
|
586
|
+
|
|
587
|
+
# Get the white label logos
|
|
588
|
+
# Lists the branding logo slots of the current portal together with the image URLs to render, which is what a login page, an editor or a mail template needs before any user is known. No authentication is required, and the portal is resolved from the address the request is made to. The call is read-only and idempotent. Each item carries the slot as a number in `type`, its stable name in `name`, the size the image is fitted to in `size` (`width` and `height` in pixels), and the URLs in `path`. When `isDark` is passed, only the matching theme is filled in, `light` for `false` and `dark` for `true`; when it is omitted both are filled in and `dark` comes back empty for the slots that have no separate dark image. The notification slot is not part of this list, as it is derived from the login-page logo and used only in letters. Pass `isDefault=true` to read the installation-wide default logos instead of this portal's. To learn which slots are still untouched use `GET api/2.0/settings/whitelabel/logos/isdefault`.
|
|
589
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-white-label-logos/
|
|
590
|
+
# @param [Hash] opts the optional parameters
|
|
591
|
+
# @option opts [Boolean] :is_dark Which theme the answer is filled in for: `true` fills the dark image only, `false` the light one only. Omitting it fills both, leaving the dark one empty for the slots that have no separate dark image.
|
|
592
|
+
# @option opts [Boolean] :is_default Whether the installation-wide default branding is addressed instead of this portal own. Writing the default branding is only allowed on a self-hosted installation; elsewhere it is refused with 403.
|
|
593
|
+
# @return [Array<(WhiteLabelItemArrayWrapper, Integer, Hash)>] WhiteLabelItemArrayWrapper data, response status code and response headers
|
|
594
|
+
def get_white_label_logos_with_http_info(opts = {})
|
|
595
|
+
if @api_client.config.debugging
|
|
596
|
+
@api_client.config.logger.debug 'Calling API: Settings::RebrandingApi.get_white_label_logos ...'
|
|
597
|
+
end
|
|
598
|
+
# resource path
|
|
599
|
+
local_var_path = '/api/2.0/settings/whitelabel/logos'
|
|
600
|
+
|
|
601
|
+
# query parameters
|
|
602
|
+
query_params = opts[:query_params] || {}
|
|
603
|
+
query_params[:'isDark'] = opts[:'is_dark'] if !opts[:'is_dark'].nil?
|
|
604
|
+
query_params[:'isDefault'] = opts[:'is_default'] if !opts[:'is_default'].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] || 'WhiteLabelItemArrayWrapper'
|
|
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::RebrandingApi.get_white_label_logos",
|
|
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::RebrandingApi#get_white_label_logos\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
636
|
+
end
|
|
637
|
+
return data, status_code, headers
|
|
638
|
+
end
|
|
639
|
+
|
|
640
|
+
# Restore the white label logo text
|
|
641
|
+
# Clears the wordmark stored for the current portal, so the built-in `ONLYOFFICE` is printed again next to or instead of the logo images. Requires a DocSpace administrator. Unlike `POST api/2.0/settings/whitelabel/logotext/save` it does not need a plan that includes customization, so a portal whose subscription no longer covers customization can still be reset. The call is destructive for the stored text, which is not kept anywhere and has to be typed again to come back, and it is idempotent: `true` comes back both when a text was cleared and when there was none. Logo images are left untouched and have their own `PUT api/2.0/settings/whitelabel/logos/restore`. Pass `isDefault=true` to reset the installation-wide default wordmark instead of this portal's, which only a server installation allows. After the call `GET api/2.0/settings/whitelabel/logotext` reports `ONLYOFFICE` and `GET api/2.0/settings/whitelabel/logotext/isdefault` reports `default` as `true`. The wordmark is the only setting this operation touches, so the company details and the help links of the installation are left as they are.
|
|
642
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/restore-white-label-logo-text/
|
|
643
|
+
# @param [Hash] opts the optional parameters
|
|
644
|
+
# @option opts [Boolean] :is_dark Which theme the answer is filled in for: `true` fills the dark image only, `false` the light one only. Omitting it fills both, leaving the dark one empty for the slots that have no separate dark image.
|
|
645
|
+
# @option opts [Boolean] :is_default Whether the installation-wide default branding is addressed instead of this portal own. Writing the default branding is only allowed on a self-hosted installation; elsewhere it is refused with 403.
|
|
646
|
+
# @return [BooleanWrapper]
|
|
647
|
+
def restore_white_label_logo_text(opts = {})
|
|
648
|
+
data, _status_code, _headers = restore_white_label_logo_text_with_http_info(opts)
|
|
649
|
+
data
|
|
650
|
+
end
|
|
651
|
+
|
|
652
|
+
# Restore the white label logo text
|
|
653
|
+
# Clears the wordmark stored for the current portal, so the built-in `ONLYOFFICE` is printed again next to or instead of the logo images. Requires a DocSpace administrator. Unlike `POST api/2.0/settings/whitelabel/logotext/save` it does not need a plan that includes customization, so a portal whose subscription no longer covers customization can still be reset. The call is destructive for the stored text, which is not kept anywhere and has to be typed again to come back, and it is idempotent: `true` comes back both when a text was cleared and when there was none. Logo images are left untouched and have their own `PUT api/2.0/settings/whitelabel/logos/restore`. Pass `isDefault=true` to reset the installation-wide default wordmark instead of this portal's, which only a server installation allows. After the call `GET api/2.0/settings/whitelabel/logotext` reports `ONLYOFFICE` and `GET api/2.0/settings/whitelabel/logotext/isdefault` reports `default` as `true`. The wordmark is the only setting this operation touches, so the company details and the help links of the installation are left as they are.
|
|
654
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/restore-white-label-logo-text/
|
|
655
|
+
# @param [Hash] opts the optional parameters
|
|
656
|
+
# @option opts [Boolean] :is_dark Which theme the answer is filled in for: `true` fills the dark image only, `false` the light one only. Omitting it fills both, leaving the dark one empty for the slots that have no separate dark image.
|
|
657
|
+
# @option opts [Boolean] :is_default Whether the installation-wide default branding is addressed instead of this portal own. Writing the default branding is only allowed on a self-hosted installation; elsewhere it is refused with 403.
|
|
658
|
+
# @return [Array<(BooleanWrapper, Integer, Hash)>] BooleanWrapper data, response status code and response headers
|
|
659
|
+
def restore_white_label_logo_text_with_http_info(opts = {})
|
|
660
|
+
if @api_client.config.debugging
|
|
661
|
+
@api_client.config.logger.debug 'Calling API: Settings::RebrandingApi.restore_white_label_logo_text ...'
|
|
662
|
+
end
|
|
663
|
+
# resource path
|
|
664
|
+
local_var_path = '/api/2.0/settings/whitelabel/logotext/restore'
|
|
665
|
+
|
|
666
|
+
# query parameters
|
|
667
|
+
query_params = opts[:query_params] || {}
|
|
668
|
+
query_params[:'isDark'] = opts[:'is_dark'] if !opts[:'is_dark'].nil?
|
|
669
|
+
query_params[:'isDefault'] = opts[:'is_default'] if !opts[:'is_default'].nil?
|
|
670
|
+
|
|
671
|
+
# header parameters
|
|
672
|
+
header_params = opts[:header_params] || {}
|
|
673
|
+
# HTTP header 'Accept' (if needed)
|
|
674
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
675
|
+
|
|
676
|
+
# form parameters
|
|
677
|
+
form_params = opts[:form_params] || {}
|
|
678
|
+
|
|
679
|
+
# http body (model)
|
|
680
|
+
post_body = opts[:debug_body]
|
|
681
|
+
|
|
682
|
+
# return_type
|
|
683
|
+
return_type = opts[:debug_return_type] || 'BooleanWrapper'
|
|
684
|
+
|
|
685
|
+
# auth_names
|
|
686
|
+
auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
|
|
687
|
+
|
|
688
|
+
new_options = opts.merge(
|
|
689
|
+
:operation => :"Settings::RebrandingApi.restore_white_label_logo_text",
|
|
690
|
+
:header_params => header_params,
|
|
691
|
+
:query_params => query_params,
|
|
692
|
+
:form_params => form_params,
|
|
693
|
+
:body => post_body,
|
|
694
|
+
:auth_names => auth_names,
|
|
695
|
+
:return_type => return_type
|
|
696
|
+
)
|
|
697
|
+
|
|
698
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
|
|
699
|
+
if @api_client.config.debugging
|
|
700
|
+
@api_client.config.logger.debug "API called: Settings::RebrandingApi#restore_white_label_logo_text\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
701
|
+
end
|
|
702
|
+
return data, status_code, headers
|
|
703
|
+
end
|
|
704
|
+
|
|
705
|
+
# Restore the white label logos
|
|
706
|
+
# Drops every logo uploaded for the current portal and brings back the built-in images, so the portal looks unbranded again on the login page, in the left menu, in the editors and in letters. Requires a DocSpace administrator. Unlike the two save operations it does not need a plan that includes customization, so a portal whose subscription no longer covers it can still be reset. The call is destructive: the stored image files are deleted and cannot be recovered from the portal, only re-uploaded with `POST api/2.0/settings/whitelabel/logos/save`. It is idempotent and answers `true` both when logos were removed and when there was nothing to remove. All slots are reset together; there is no way to restore a single one. For this portal the picture kept for the older mail templates is reset along with the logos, while the logo text is left as it is and has its own `PUT api/2.0/settings/whitelabel/logotext/restore`. Pass `isDefault=true` to reset the installation-wide default branding instead, which only a server installation allows. Confirm the result with `GET api/2.0/settings/whitelabel/logos/isdefault`.
|
|
707
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/restore-white-label-logos/
|
|
708
|
+
# @param [Hash] opts the optional parameters
|
|
709
|
+
# @option opts [Boolean] :is_dark Which theme the answer is filled in for: `true` fills the dark image only, `false` the light one only. Omitting it fills both, leaving the dark one empty for the slots that have no separate dark image.
|
|
710
|
+
# @option opts [Boolean] :is_default Whether the installation-wide default branding is addressed instead of this portal own. Writing the default branding is only allowed on a self-hosted installation; elsewhere it is refused with 403.
|
|
711
|
+
# @return [BooleanWrapper]
|
|
712
|
+
def restore_white_label_logos(opts = {})
|
|
713
|
+
data, _status_code, _headers = restore_white_label_logos_with_http_info(opts)
|
|
714
|
+
data
|
|
715
|
+
end
|
|
716
|
+
|
|
717
|
+
# Restore the white label logos
|
|
718
|
+
# Drops every logo uploaded for the current portal and brings back the built-in images, so the portal looks unbranded again on the login page, in the left menu, in the editors and in letters. Requires a DocSpace administrator. Unlike the two save operations it does not need a plan that includes customization, so a portal whose subscription no longer covers it can still be reset. The call is destructive: the stored image files are deleted and cannot be recovered from the portal, only re-uploaded with `POST api/2.0/settings/whitelabel/logos/save`. It is idempotent and answers `true` both when logos were removed and when there was nothing to remove. All slots are reset together; there is no way to restore a single one. For this portal the picture kept for the older mail templates is reset along with the logos, while the logo text is left as it is and has its own `PUT api/2.0/settings/whitelabel/logotext/restore`. Pass `isDefault=true` to reset the installation-wide default branding instead, which only a server installation allows. Confirm the result with `GET api/2.0/settings/whitelabel/logos/isdefault`.
|
|
719
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/restore-white-label-logos/
|
|
720
|
+
# @param [Hash] opts the optional parameters
|
|
721
|
+
# @option opts [Boolean] :is_dark Which theme the answer is filled in for: `true` fills the dark image only, `false` the light one only. Omitting it fills both, leaving the dark one empty for the slots that have no separate dark image.
|
|
722
|
+
# @option opts [Boolean] :is_default Whether the installation-wide default branding is addressed instead of this portal own. Writing the default branding is only allowed on a self-hosted installation; elsewhere it is refused with 403.
|
|
723
|
+
# @return [Array<(BooleanWrapper, Integer, Hash)>] BooleanWrapper data, response status code and response headers
|
|
724
|
+
def restore_white_label_logos_with_http_info(opts = {})
|
|
725
|
+
if @api_client.config.debugging
|
|
726
|
+
@api_client.config.logger.debug 'Calling API: Settings::RebrandingApi.restore_white_label_logos ...'
|
|
727
|
+
end
|
|
728
|
+
# resource path
|
|
729
|
+
local_var_path = '/api/2.0/settings/whitelabel/logos/restore'
|
|
730
|
+
|
|
731
|
+
# query parameters
|
|
732
|
+
query_params = opts[:query_params] || {}
|
|
733
|
+
query_params[:'isDark'] = opts[:'is_dark'] if !opts[:'is_dark'].nil?
|
|
734
|
+
query_params[:'isDefault'] = opts[:'is_default'] if !opts[:'is_default'].nil?
|
|
735
|
+
|
|
736
|
+
# header parameters
|
|
737
|
+
header_params = opts[:header_params] || {}
|
|
738
|
+
# HTTP header 'Accept' (if needed)
|
|
739
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
740
|
+
|
|
741
|
+
# form parameters
|
|
742
|
+
form_params = opts[:form_params] || {}
|
|
743
|
+
|
|
744
|
+
# http body (model)
|
|
745
|
+
post_body = opts[:debug_body]
|
|
746
|
+
|
|
747
|
+
# return_type
|
|
748
|
+
return_type = opts[:debug_return_type] || 'BooleanWrapper'
|
|
749
|
+
|
|
750
|
+
# auth_names
|
|
751
|
+
auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
|
|
752
|
+
|
|
753
|
+
new_options = opts.merge(
|
|
754
|
+
:operation => :"Settings::RebrandingApi.restore_white_label_logos",
|
|
755
|
+
:header_params => header_params,
|
|
756
|
+
:query_params => query_params,
|
|
757
|
+
:form_params => form_params,
|
|
758
|
+
:body => post_body,
|
|
759
|
+
:auth_names => auth_names,
|
|
760
|
+
:return_type => return_type
|
|
761
|
+
)
|
|
762
|
+
|
|
763
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
|
|
764
|
+
if @api_client.config.debugging
|
|
765
|
+
@api_client.config.logger.debug "API called: Settings::RebrandingApi#restore_white_label_logos\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
766
|
+
end
|
|
767
|
+
return data, status_code, headers
|
|
768
|
+
end
|
|
769
|
+
|
|
770
|
+
# Save the additional white label settings
|
|
771
|
+
# Stores which of the ONLYOFFICE help and community resources the interface offers: the sample documents, the Help Center link, the Feedback and Support link, the user forum, the video guides and the license agreements. The whole set is replaced by the `settings` object of the request, so send every flag, not only the changed ones - a flag left out is stored as off. A request without that object is rejected as an invalid request. Requires a DocSpace administrator, a server installation with unrestricted space access and a plan that includes customization, which `GET api/2.0/settings/enablewhitelabel` reports; on a SaaS portal the call is refused. The flags are installation-wide, so the change reaches every portal of that installation. The call is mutating and idempotent, and answers `true`. Only the visibility of these entries is controlled here, not the addresses behind them. Read the result back with `GET api/2.0/settings/rebranding/additional` and undo it with `DELETE api/2.0/settings/rebranding/additional`.
|
|
772
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/save-additional-white-label-settings/
|
|
773
|
+
# @param [Hash] opts the optional parameters
|
|
774
|
+
# @option opts [AdditionalWhiteLabelSettingsRequestDto] :additional_white_label_settings_request_dto
|
|
775
|
+
# @return [BooleanWrapper]
|
|
776
|
+
def save_additional_white_label_settings(opts = {})
|
|
777
|
+
data, _status_code, _headers = save_additional_white_label_settings_with_http_info(opts)
|
|
778
|
+
data
|
|
779
|
+
end
|
|
780
|
+
|
|
781
|
+
# Save the additional white label settings
|
|
782
|
+
# Stores which of the ONLYOFFICE help and community resources the interface offers: the sample documents, the Help Center link, the Feedback and Support link, the user forum, the video guides and the license agreements. The whole set is replaced by the `settings` object of the request, so send every flag, not only the changed ones - a flag left out is stored as off. A request without that object is rejected as an invalid request. Requires a DocSpace administrator, a server installation with unrestricted space access and a plan that includes customization, which `GET api/2.0/settings/enablewhitelabel` reports; on a SaaS portal the call is refused. The flags are installation-wide, so the change reaches every portal of that installation. The call is mutating and idempotent, and answers `true`. Only the visibility of these entries is controlled here, not the addresses behind them. Read the result back with `GET api/2.0/settings/rebranding/additional` and undo it with `DELETE api/2.0/settings/rebranding/additional`.
|
|
783
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/save-additional-white-label-settings/
|
|
784
|
+
# @param [Hash] opts the optional parameters
|
|
785
|
+
# @option opts [AdditionalWhiteLabelSettingsRequestDto] :additional_white_label_settings_request_dto
|
|
786
|
+
# @return [Array<(BooleanWrapper, Integer, Hash)>] BooleanWrapper data, response status code and response headers
|
|
787
|
+
def save_additional_white_label_settings_with_http_info(opts = {})
|
|
788
|
+
if @api_client.config.debugging
|
|
789
|
+
@api_client.config.logger.debug 'Calling API: Settings::RebrandingApi.save_additional_white_label_settings ...'
|
|
790
|
+
end
|
|
791
|
+
# resource path
|
|
792
|
+
local_var_path = '/api/2.0/settings/rebranding/additional'
|
|
793
|
+
|
|
794
|
+
# query parameters
|
|
795
|
+
query_params = opts[:query_params] || {}
|
|
796
|
+
|
|
797
|
+
# header parameters
|
|
798
|
+
header_params = opts[:header_params] || {}
|
|
799
|
+
# HTTP header 'Accept' (if needed)
|
|
800
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
801
|
+
# HTTP header 'Content-Type'
|
|
802
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
803
|
+
if !content_type.nil?
|
|
804
|
+
header_params['Content-Type'] = content_type
|
|
805
|
+
end
|
|
806
|
+
|
|
807
|
+
# form parameters
|
|
808
|
+
form_params = opts[:form_params] || {}
|
|
809
|
+
|
|
810
|
+
# http body (model)
|
|
811
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'additional_white_label_settings_request_dto'])
|
|
812
|
+
|
|
813
|
+
# return_type
|
|
814
|
+
return_type = opts[:debug_return_type] || 'BooleanWrapper'
|
|
815
|
+
|
|
816
|
+
# auth_names
|
|
817
|
+
auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
|
|
818
|
+
|
|
819
|
+
new_options = opts.merge(
|
|
820
|
+
:operation => :"Settings::RebrandingApi.save_additional_white_label_settings",
|
|
821
|
+
:header_params => header_params,
|
|
822
|
+
:query_params => query_params,
|
|
823
|
+
:form_params => form_params,
|
|
824
|
+
:body => post_body,
|
|
825
|
+
:auth_names => auth_names,
|
|
826
|
+
:return_type => return_type
|
|
827
|
+
)
|
|
828
|
+
|
|
829
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
830
|
+
if @api_client.config.debugging
|
|
831
|
+
@api_client.config.logger.debug "API called: Settings::RebrandingApi#save_additional_white_label_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
832
|
+
end
|
|
833
|
+
return data, status_code, headers
|
|
834
|
+
end
|
|
835
|
+
|
|
836
|
+
# Save the company white label settings
|
|
837
|
+
# Stores the company details - name, site, support email, postal address and phone - that the About page and the notification letters print as the vendor. The whole set is replaced by the `settings` object of the request, so send every field, not only the changed ones; a request without that object, or with an email or a site that is not a valid value, is rejected as an invalid request. Requires a DocSpace administrator, a server installation with unrestricted space access and a plan that includes customization, which `GET api/2.0/settings/enablewhitelabel` reports; on a SaaS portal the call is refused. The values are installation-wide, so the change reaches every portal of that installation. Two fields are not taken from the request: the licensor flag is always stored as `false`, and hiding the About page is silently kept off unless the plan allows it. The call is mutating and idempotent, and answers `true`. Read the result back with `GET api/2.0/settings/rebranding/company` and undo it with `DELETE api/2.0/settings/rebranding/company`.
|
|
838
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/save-company-white-label-settings/
|
|
839
|
+
# @param [Hash] opts the optional parameters
|
|
840
|
+
# @option opts [CompanyWhiteLabelSettingsRequestDto] :company_white_label_settings_request_dto
|
|
841
|
+
# @return [BooleanWrapper]
|
|
842
|
+
def save_company_white_label_settings(opts = {})
|
|
843
|
+
data, _status_code, _headers = save_company_white_label_settings_with_http_info(opts)
|
|
844
|
+
data
|
|
845
|
+
end
|
|
846
|
+
|
|
847
|
+
# Save the company white label settings
|
|
848
|
+
# Stores the company details - name, site, support email, postal address and phone - that the About page and the notification letters print as the vendor. The whole set is replaced by the `settings` object of the request, so send every field, not only the changed ones; a request without that object, or with an email or a site that is not a valid value, is rejected as an invalid request. Requires a DocSpace administrator, a server installation with unrestricted space access and a plan that includes customization, which `GET api/2.0/settings/enablewhitelabel` reports; on a SaaS portal the call is refused. The values are installation-wide, so the change reaches every portal of that installation. Two fields are not taken from the request: the licensor flag is always stored as `false`, and hiding the About page is silently kept off unless the plan allows it. The call is mutating and idempotent, and answers `true`. Read the result back with `GET api/2.0/settings/rebranding/company` and undo it with `DELETE api/2.0/settings/rebranding/company`.
|
|
849
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/save-company-white-label-settings/
|
|
850
|
+
# @param [Hash] opts the optional parameters
|
|
851
|
+
# @option opts [CompanyWhiteLabelSettingsRequestDto] :company_white_label_settings_request_dto
|
|
852
|
+
# @return [Array<(BooleanWrapper, Integer, Hash)>] BooleanWrapper data, response status code and response headers
|
|
853
|
+
def save_company_white_label_settings_with_http_info(opts = {})
|
|
854
|
+
if @api_client.config.debugging
|
|
855
|
+
@api_client.config.logger.debug 'Calling API: Settings::RebrandingApi.save_company_white_label_settings ...'
|
|
856
|
+
end
|
|
857
|
+
# resource path
|
|
858
|
+
local_var_path = '/api/2.0/settings/rebranding/company'
|
|
859
|
+
|
|
860
|
+
# query parameters
|
|
861
|
+
query_params = opts[:query_params] || {}
|
|
862
|
+
|
|
863
|
+
# header parameters
|
|
864
|
+
header_params = opts[:header_params] || {}
|
|
865
|
+
# HTTP header 'Accept' (if needed)
|
|
866
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
867
|
+
# HTTP header 'Content-Type'
|
|
868
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
869
|
+
if !content_type.nil?
|
|
870
|
+
header_params['Content-Type'] = content_type
|
|
871
|
+
end
|
|
872
|
+
|
|
873
|
+
# form parameters
|
|
874
|
+
form_params = opts[:form_params] || {}
|
|
875
|
+
|
|
876
|
+
# http body (model)
|
|
877
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'company_white_label_settings_request_dto'])
|
|
878
|
+
|
|
879
|
+
# return_type
|
|
880
|
+
return_type = opts[:debug_return_type] || 'BooleanWrapper'
|
|
881
|
+
|
|
882
|
+
# auth_names
|
|
883
|
+
auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
|
|
884
|
+
|
|
885
|
+
new_options = opts.merge(
|
|
886
|
+
:operation => :"Settings::RebrandingApi.save_company_white_label_settings",
|
|
887
|
+
:header_params => header_params,
|
|
888
|
+
:query_params => query_params,
|
|
889
|
+
:form_params => form_params,
|
|
890
|
+
:body => post_body,
|
|
891
|
+
:auth_names => auth_names,
|
|
892
|
+
:return_type => return_type
|
|
893
|
+
)
|
|
894
|
+
|
|
895
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
896
|
+
if @api_client.config.debugging
|
|
897
|
+
@api_client.config.logger.debug "API called: Settings::RebrandingApi#save_company_white_label_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
898
|
+
end
|
|
899
|
+
return data, status_code, headers
|
|
900
|
+
end
|
|
901
|
+
|
|
902
|
+
# Save the white label logo text
|
|
903
|
+
# Sets the wordmark that the portal prints next to or instead of a logo image, on the login page, in the editors and in notification letters. Only `logoText` from the request body is used here, and it is limited to 40 characters; a longer value is rejected as an invalid request. Sending an empty or blank text, or exactly the built-in `ONLYOFFICE`, clears the setting instead of storing it, which has the same effect as `PUT api/2.0/settings/whitelabel/logotext/restore`. Requires a DocSpace administrator and a plan that includes customization, which `GET api/2.0/settings/enablewhitelabel` reports; otherwise the call is refused as payment required. The call is mutating and idempotent: the previous text is overwritten and `true` comes back. Logo images are not touched - they are saved by `POST api/2.0/settings/whitelabel/logos/save` - and the text is not rendered into them. Pass `isDefault=true` to write the installation-wide default wordmark instead of this portal's, which only a server installation allows. Read the stored value back with `GET api/2.0/settings/whitelabel/logotext`.
|
|
904
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/save-white-label-logo-text/
|
|
905
|
+
# @param [Hash] opts the optional parameters
|
|
906
|
+
# @option opts [Boolean] :is_dark Which theme the answer is filled in for: `true` fills the dark image only, `false` the light one only. Omitting it fills both, leaving the dark one empty for the slots that have no separate dark image.
|
|
907
|
+
# @option opts [Boolean] :is_default Whether the installation-wide default branding is addressed instead of this portal own. Writing the default branding is only allowed on a self-hosted installation; elsewhere it is refused with 403.
|
|
908
|
+
# @option opts [WhiteLabelRequestDto] :white_label_request_dto
|
|
909
|
+
# @return [BooleanWrapper]
|
|
910
|
+
def save_white_label_logo_text(opts = {})
|
|
911
|
+
data, _status_code, _headers = save_white_label_logo_text_with_http_info(opts)
|
|
912
|
+
data
|
|
913
|
+
end
|
|
914
|
+
|
|
915
|
+
# Save the white label logo text
|
|
916
|
+
# Sets the wordmark that the portal prints next to or instead of a logo image, on the login page, in the editors and in notification letters. Only `logoText` from the request body is used here, and it is limited to 40 characters; a longer value is rejected as an invalid request. Sending an empty or blank text, or exactly the built-in `ONLYOFFICE`, clears the setting instead of storing it, which has the same effect as `PUT api/2.0/settings/whitelabel/logotext/restore`. Requires a DocSpace administrator and a plan that includes customization, which `GET api/2.0/settings/enablewhitelabel` reports; otherwise the call is refused as payment required. The call is mutating and idempotent: the previous text is overwritten and `true` comes back. Logo images are not touched - they are saved by `POST api/2.0/settings/whitelabel/logos/save` - and the text is not rendered into them. Pass `isDefault=true` to write the installation-wide default wordmark instead of this portal's, which only a server installation allows. Read the stored value back with `GET api/2.0/settings/whitelabel/logotext`.
|
|
917
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/save-white-label-logo-text/
|
|
918
|
+
# @param [Hash] opts the optional parameters
|
|
919
|
+
# @option opts [Boolean] :is_dark Which theme the answer is filled in for: `true` fills the dark image only, `false` the light one only. Omitting it fills both, leaving the dark one empty for the slots that have no separate dark image.
|
|
920
|
+
# @option opts [Boolean] :is_default Whether the installation-wide default branding is addressed instead of this portal own. Writing the default branding is only allowed on a self-hosted installation; elsewhere it is refused with 403.
|
|
921
|
+
# @option opts [WhiteLabelRequestDto] :white_label_request_dto
|
|
922
|
+
# @return [Array<(BooleanWrapper, Integer, Hash)>] BooleanWrapper data, response status code and response headers
|
|
923
|
+
def save_white_label_logo_text_with_http_info(opts = {})
|
|
924
|
+
if @api_client.config.debugging
|
|
925
|
+
@api_client.config.logger.debug 'Calling API: Settings::RebrandingApi.save_white_label_logo_text ...'
|
|
926
|
+
end
|
|
927
|
+
# resource path
|
|
928
|
+
local_var_path = '/api/2.0/settings/whitelabel/logotext/save'
|
|
929
|
+
|
|
930
|
+
# query parameters
|
|
931
|
+
query_params = opts[:query_params] || {}
|
|
932
|
+
query_params[:'isDark'] = opts[:'is_dark'] if !opts[:'is_dark'].nil?
|
|
933
|
+
query_params[:'isDefault'] = opts[:'is_default'] if !opts[:'is_default'].nil?
|
|
934
|
+
|
|
935
|
+
# header parameters
|
|
936
|
+
header_params = opts[:header_params] || {}
|
|
937
|
+
# HTTP header 'Accept' (if needed)
|
|
938
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
939
|
+
# HTTP header 'Content-Type'
|
|
940
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
941
|
+
if !content_type.nil?
|
|
942
|
+
header_params['Content-Type'] = content_type
|
|
943
|
+
end
|
|
944
|
+
|
|
945
|
+
# form parameters
|
|
946
|
+
form_params = opts[:form_params] || {}
|
|
947
|
+
|
|
948
|
+
# http body (model)
|
|
949
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'white_label_request_dto'])
|
|
950
|
+
|
|
951
|
+
# return_type
|
|
952
|
+
return_type = opts[:debug_return_type] || 'BooleanWrapper'
|
|
953
|
+
|
|
954
|
+
# auth_names
|
|
955
|
+
auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
|
|
956
|
+
|
|
957
|
+
new_options = opts.merge(
|
|
958
|
+
:operation => :"Settings::RebrandingApi.save_white_label_logo_text",
|
|
959
|
+
:header_params => header_params,
|
|
960
|
+
:query_params => query_params,
|
|
961
|
+
:form_params => form_params,
|
|
962
|
+
:body => post_body,
|
|
963
|
+
:auth_names => auth_names,
|
|
964
|
+
:return_type => return_type
|
|
965
|
+
)
|
|
966
|
+
|
|
967
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
968
|
+
if @api_client.config.debugging
|
|
969
|
+
@api_client.config.logger.debug "API called: Settings::RebrandingApi#save_white_label_logo_text\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
970
|
+
end
|
|
971
|
+
return data, status_code, headers
|
|
972
|
+
end
|
|
973
|
+
|
|
974
|
+
# Save the white label logos
|
|
975
|
+
# Replaces the branding images of the current portal with the ones sent in the request, so that the logos on the login page, in the left menu, in the editors and in letters come from this portal. Every entry of `logo` names a logo slot in its `key` - the numeric type published by `GET api/2.0/settings/whitelabel/logos` - and carries the light-theme and the dark-theme image in `light` and `dark`. An image is either a `data:image/png;base64,...` payload (`png`, `jpg` and `svg` are accepted) or the name of a file already uploaded to the temporary store; a slot left out of the request keeps its image. The dark image is stored only for the slots that have a dark variant, that is `1`, `2`, `6`, `7` and `8`, and is ignored for the favicon and the editor logos; saving slot `2` also rebuilds the notification logo `8` from it. Requires a DocSpace administrator and a plan that includes customization, which `GET api/2.0/settings/enablewhitelabel` reports; otherwise the call is refused as payment required. It answers `true` and is undone by `PUT api/2.0/settings/whitelabel/logos/restore`. With `isDefault=true` it writes the installation-wide default branding instead, which only a server installation allows. Uploaded files go to `POST api/2.0/settings/whitelabel/logos/savefromfiles`.
|
|
976
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/save-white-label-settings/
|
|
977
|
+
# @param [Hash] opts the optional parameters
|
|
978
|
+
# @option opts [Boolean] :is_dark Which theme the answer is filled in for: `true` fills the dark image only, `false` the light one only. Omitting it fills both, leaving the dark one empty for the slots that have no separate dark image.
|
|
979
|
+
# @option opts [Boolean] :is_default Whether the installation-wide default branding is addressed instead of this portal own. Writing the default branding is only allowed on a self-hosted installation; elsewhere it is refused with 403.
|
|
980
|
+
# @option opts [WhiteLabelRequestDto] :white_label_request_dto
|
|
981
|
+
# @return [BooleanWrapper]
|
|
982
|
+
def save_white_label_settings(opts = {})
|
|
983
|
+
data, _status_code, _headers = save_white_label_settings_with_http_info(opts)
|
|
984
|
+
data
|
|
985
|
+
end
|
|
986
|
+
|
|
987
|
+
# Save the white label logos
|
|
988
|
+
# Replaces the branding images of the current portal with the ones sent in the request, so that the logos on the login page, in the left menu, in the editors and in letters come from this portal. Every entry of `logo` names a logo slot in its `key` - the numeric type published by `GET api/2.0/settings/whitelabel/logos` - and carries the light-theme and the dark-theme image in `light` and `dark`. An image is either a `data:image/png;base64,...` payload (`png`, `jpg` and `svg` are accepted) or the name of a file already uploaded to the temporary store; a slot left out of the request keeps its image. The dark image is stored only for the slots that have a dark variant, that is `1`, `2`, `6`, `7` and `8`, and is ignored for the favicon and the editor logos; saving slot `2` also rebuilds the notification logo `8` from it. Requires a DocSpace administrator and a plan that includes customization, which `GET api/2.0/settings/enablewhitelabel` reports; otherwise the call is refused as payment required. It answers `true` and is undone by `PUT api/2.0/settings/whitelabel/logos/restore`. With `isDefault=true` it writes the installation-wide default branding instead, which only a server installation allows. Uploaded files go to `POST api/2.0/settings/whitelabel/logos/savefromfiles`.
|
|
989
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/save-white-label-settings/
|
|
990
|
+
# @param [Hash] opts the optional parameters
|
|
991
|
+
# @option opts [Boolean] :is_dark Which theme the answer is filled in for: `true` fills the dark image only, `false` the light one only. Omitting it fills both, leaving the dark one empty for the slots that have no separate dark image.
|
|
992
|
+
# @option opts [Boolean] :is_default Whether the installation-wide default branding is addressed instead of this portal own. Writing the default branding is only allowed on a self-hosted installation; elsewhere it is refused with 403.
|
|
993
|
+
# @option opts [WhiteLabelRequestDto] :white_label_request_dto
|
|
994
|
+
# @return [Array<(BooleanWrapper, Integer, Hash)>] BooleanWrapper data, response status code and response headers
|
|
995
|
+
def save_white_label_settings_with_http_info(opts = {})
|
|
996
|
+
if @api_client.config.debugging
|
|
997
|
+
@api_client.config.logger.debug 'Calling API: Settings::RebrandingApi.save_white_label_settings ...'
|
|
998
|
+
end
|
|
999
|
+
# resource path
|
|
1000
|
+
local_var_path = '/api/2.0/settings/whitelabel/logos/save'
|
|
1001
|
+
|
|
1002
|
+
# query parameters
|
|
1003
|
+
query_params = opts[:query_params] || {}
|
|
1004
|
+
query_params[:'isDark'] = opts[:'is_dark'] if !opts[:'is_dark'].nil?
|
|
1005
|
+
query_params[:'isDefault'] = opts[:'is_default'] if !opts[:'is_default'].nil?
|
|
1006
|
+
|
|
1007
|
+
# header parameters
|
|
1008
|
+
header_params = opts[:header_params] || {}
|
|
1009
|
+
# HTTP header 'Accept' (if needed)
|
|
1010
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
1011
|
+
# HTTP header 'Content-Type'
|
|
1012
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
1013
|
+
if !content_type.nil?
|
|
1014
|
+
header_params['Content-Type'] = content_type
|
|
1015
|
+
end
|
|
1016
|
+
|
|
1017
|
+
# form parameters
|
|
1018
|
+
form_params = opts[:form_params] || {}
|
|
1019
|
+
|
|
1020
|
+
# http body (model)
|
|
1021
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'white_label_request_dto'])
|
|
1022
|
+
|
|
1023
|
+
# return_type
|
|
1024
|
+
return_type = opts[:debug_return_type] || 'BooleanWrapper'
|
|
1025
|
+
|
|
1026
|
+
# auth_names
|
|
1027
|
+
auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
|
|
1028
|
+
|
|
1029
|
+
new_options = opts.merge(
|
|
1030
|
+
:operation => :"Settings::RebrandingApi.save_white_label_settings",
|
|
1031
|
+
:header_params => header_params,
|
|
1032
|
+
:query_params => query_params,
|
|
1033
|
+
:form_params => form_params,
|
|
1034
|
+
:body => post_body,
|
|
1035
|
+
:auth_names => auth_names,
|
|
1036
|
+
:return_type => return_type
|
|
1037
|
+
)
|
|
1038
|
+
|
|
1039
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
1040
|
+
if @api_client.config.debugging
|
|
1041
|
+
@api_client.config.logger.debug "API called: Settings::RebrandingApi#save_white_label_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1042
|
+
end
|
|
1043
|
+
return data, status_code, headers
|
|
1044
|
+
end
|
|
1045
|
+
|
|
1046
|
+
# Save the logos from files
|
|
1047
|
+
# Replaces the branding images of the current portal with the files sent as `multipart/form-data`, which is the way to upload image files directly instead of embedding them as base64 in `POST api/2.0/settings/whitelabel/logos/save`. The form field names are not used: each file is routed by its own name, which has to start with the numeric logo slot published by `GET api/2.0/settings/whitelabel/logos` and end with the image extension, as in `2.png`; a name that also contains `dark`, as in `2.dark.png`, is stored as the dark-theme image of that slot. Slots that get no file keep the image they have, and a dark file is ignored for the favicon and the editor logos, which have no dark variant. A request that carries no file at all is rejected. Requires a DocSpace administrator and a plan that includes customization, which `GET api/2.0/settings/enablewhitelabel` reports; otherwise the call is refused as payment required. It answers `true`, overwrites in place and is undone by `PUT api/2.0/settings/whitelabel/logos/restore`. With `isDefault=true` it writes the installation-wide default branding, which only a server installation allows.
|
|
1048
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/save-white-label-settings-from-files/
|
|
1049
|
+
# @param [Hash] opts the optional parameters
|
|
1050
|
+
# @option opts [Boolean] :is_dark Which theme the answer is filled in for: `true` fills the dark image only, `false` the light one only. Omitting it fills both, leaving the dark one empty for the slots that have no separate dark image.
|
|
1051
|
+
# @option opts [Boolean] :is_default Whether the installation-wide default branding is addressed instead of this portal own. Writing the default branding is only allowed on a self-hosted installation; elsewhere it is refused with 403.
|
|
1052
|
+
# @return [BooleanWrapper]
|
|
1053
|
+
def save_white_label_settings_from_files(opts = {})
|
|
1054
|
+
data, _status_code, _headers = save_white_label_settings_from_files_with_http_info(opts)
|
|
1055
|
+
data
|
|
1056
|
+
end
|
|
1057
|
+
|
|
1058
|
+
# Save the logos from files
|
|
1059
|
+
# Replaces the branding images of the current portal with the files sent as `multipart/form-data`, which is the way to upload image files directly instead of embedding them as base64 in `POST api/2.0/settings/whitelabel/logos/save`. The form field names are not used: each file is routed by its own name, which has to start with the numeric logo slot published by `GET api/2.0/settings/whitelabel/logos` and end with the image extension, as in `2.png`; a name that also contains `dark`, as in `2.dark.png`, is stored as the dark-theme image of that slot. Slots that get no file keep the image they have, and a dark file is ignored for the favicon and the editor logos, which have no dark variant. A request that carries no file at all is rejected. Requires a DocSpace administrator and a plan that includes customization, which `GET api/2.0/settings/enablewhitelabel` reports; otherwise the call is refused as payment required. It answers `true`, overwrites in place and is undone by `PUT api/2.0/settings/whitelabel/logos/restore`. With `isDefault=true` it writes the installation-wide default branding, which only a server installation allows.
|
|
1060
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/save-white-label-settings-from-files/
|
|
1061
|
+
# @param [Hash] opts the optional parameters
|
|
1062
|
+
# @option opts [Boolean] :is_dark Which theme the answer is filled in for: `true` fills the dark image only, `false` the light one only. Omitting it fills both, leaving the dark one empty for the slots that have no separate dark image.
|
|
1063
|
+
# @option opts [Boolean] :is_default Whether the installation-wide default branding is addressed instead of this portal own. Writing the default branding is only allowed on a self-hosted installation; elsewhere it is refused with 403.
|
|
1064
|
+
# @return [Array<(BooleanWrapper, Integer, Hash)>] BooleanWrapper data, response status code and response headers
|
|
1065
|
+
def save_white_label_settings_from_files_with_http_info(opts = {})
|
|
1066
|
+
if @api_client.config.debugging
|
|
1067
|
+
@api_client.config.logger.debug 'Calling API: Settings::RebrandingApi.save_white_label_settings_from_files ...'
|
|
1068
|
+
end
|
|
1069
|
+
# resource path
|
|
1070
|
+
local_var_path = '/api/2.0/settings/whitelabel/logos/savefromfiles'
|
|
1071
|
+
|
|
1072
|
+
# query parameters
|
|
1073
|
+
query_params = opts[:query_params] || {}
|
|
1074
|
+
query_params[:'isDark'] = opts[:'is_dark'] if !opts[:'is_dark'].nil?
|
|
1075
|
+
query_params[:'isDefault'] = opts[:'is_default'] if !opts[:'is_default'].nil?
|
|
1076
|
+
|
|
1077
|
+
# header parameters
|
|
1078
|
+
header_params = opts[:header_params] || {}
|
|
1079
|
+
# HTTP header 'Accept' (if needed)
|
|
1080
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
1081
|
+
|
|
1082
|
+
# form parameters
|
|
1083
|
+
form_params = opts[:form_params] || {}
|
|
1084
|
+
|
|
1085
|
+
# http body (model)
|
|
1086
|
+
post_body = opts[:debug_body]
|
|
1087
|
+
|
|
1088
|
+
# return_type
|
|
1089
|
+
return_type = opts[:debug_return_type] || 'BooleanWrapper'
|
|
1090
|
+
|
|
1091
|
+
# auth_names
|
|
1092
|
+
auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
|
|
1093
|
+
|
|
1094
|
+
new_options = opts.merge(
|
|
1095
|
+
:operation => :"Settings::RebrandingApi.save_white_label_settings_from_files",
|
|
1096
|
+
:header_params => header_params,
|
|
1097
|
+
:query_params => query_params,
|
|
1098
|
+
:form_params => form_params,
|
|
1099
|
+
:body => post_body,
|
|
1100
|
+
:auth_names => auth_names,
|
|
1101
|
+
:return_type => return_type
|
|
1102
|
+
)
|
|
1103
|
+
|
|
1104
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
1105
|
+
if @api_client.config.debugging
|
|
1106
|
+
@api_client.config.logger.debug "API called: Settings::RebrandingApi#save_white_label_settings_from_files\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1107
|
+
end
|
|
1108
|
+
return data, status_code, headers
|
|
1109
|
+
end
|
|
1110
|
+
end
|
|
1111
|
+
end
|
|
1112
|
+
end
|